Server communication abstraction

Members

private _csrfToken :string

Kom.js, line 23

User session CSRF token to use in POST request

private _headers :Array.<array>

Kom.js, line 26

Array of HTTP headers to be used in HTTP calls

Methods

async, private, static _checkValidity()

Kom.js, line 77

Check the Kom instance validity to ensure its properties validity.

private, static _createRequestHeaders() → {Array.<array>}

Kom.js, line 61

Fills Kom _headers private member array, to use in HTTP requests later on. This method is required to be called on construction.

Returns:

Array.<array> -

• The headers array, length 3, to be used in HTTP requests

private, static _getCsrfCookie() → {string}

Kom.js, line 37

Extract CSRF token value from client cookies and returns it as a string. Returns an empty string by default. This method is required to be called on construction.

Returns:

string -

• The CSRF token string

private, static _getErrorCodeFromHTTPStatus(code) → {string}

Kom.js, line 99

This method is called whenever a server request didn't went well. In case a request (from any type) fails, its HTTP status code have to be handle in the method, so it returns an error code can be handled in the user interface (with notification, console or else).

Parameters:

Name	Type	Description
code	number	The HTTP status code to handle, in supported ones from HttpStatusCode enumeration

Returns:

string -

The HTTP status as an error code

async, private, static _resolveAs(type, response) → {Promise}

Kom.js, line 121

Generic tool method used by private methods on fetch responses to format output in the provided format. It must be either `json`, `text` or `raw`.

Parameters:

Name	Type	Description
type	String	The type of resolution, can be json, text or raw
response	Object	The fetch response object

Returns:

Promise -

The request Promise, format response as an object on resolve, as error code string on reject

async, private, static _resolveAsJSON(response) → {Promise}

Kom.js, line 156

Tool method used by public methods on fetch responses to format output data as JSON to be read in JavaScript code as objects.

Parameters:

Name	Type	Description
response	Object	The fetch response object

Returns:

Promise -

The request Promise, format response as an object on resolve, as error code string on reject

async, private, static _resolveAsRaw(response) → {Promise}

Kom.js, line 184

Tool method used by XmlHTTPRequests to format server response as raw binary data.

Parameters:

Name	Type	Description
response	Object	The XmlHTTPRequest response status object

Returns:

Promise -

The request Promise, doesn't format response on resolve, send error code string on reject

async, private, static _resolveAsText(response) → {Promise}

Kom.js, line 170

Tool method used by public methods on fetch responses to format output data as text to be read in JavaScript code as string (mostly to parse HTML templates).

Parameters:

Name	Type	Description
response	Object	The fetch response object

Returns:

Promise -

The request Promise, format response as a string on resolve, as error code string on reject

async, static get(url) → {Promise}

Kom.js, line 202

GET HTTP request using the fetch API.
resolve returns the response as an Object.
reject returns an error key as a String. It is meant to perform API call to access database through the user interface.

Parameters:

Name	Type	Description
url	String	The GET url to fetch data from, in supported back URLs

Returns:

Promise -

The request Promise

async, static getRaw(url) → {Promise}

Kom.js, line 242

GET HTTP request using an XMLHttpRequest, with an override mime type hack to pass bytes through unprocessed.
resolve returns the response as raw binary data.
reject returns an error code as a String.

Parameters:

Name	Type	Description
url	String	The url to fetch raw data from

Returns:

Promise -

The request Promise

async, static getText(url) → {Promise}

Kom.js, line 227

GET HTTP request using the fetch API.
resolve returns the response as a String.
reject returns an error key as a String. It is meant to perform API call to get HTML templates as string to be parsed as documents/documents fragments.

Parameters:

Name	Type	Description
url	String	The GET url to fetch data from, in supported back URLs

Returns:

Promise -

The request Promise

async, static post(url, data) → {Promise}

Kom.js, line 272

POST HTTP request using the fetch API.
Beware that the given options object match the url expectations.
resolve returns the response as an Object.
reject returns an error key as a String.

Parameters:

Name	Type	Description
url	String	The POST url to fetch data from
data	Object	The JSON object that contains POST parameters

Returns:

Promise -

The request Promise

async, static postRaw(url, data) → {Promise}

Kom.js, line 315

POST HTTP request using the fetch API.
Beware that the given options object match the url expectations.
resolve, with an override mime type hack to pass bytes through unprocessed.
resolve returns the response as raw binary data.
reject returns an error code as a String.

Parameters:

Name	Type	Description
url	String	The url to fetch raw data from
data	Object	The JSON object that contains POST parameters

Returns:

Promise -

The request Promise

async, static postText(url, data) → {Promise}

Kom.js, line 299

POST HTTP request using the fetch API.
Beware that the given options object match the url expectations.
resolve returns the response as a String.
reject returns an error key as a String.

Parameters:

Name	Type	Description
url	String	The POST url to fetch data from
data	Object	The JSON object that contains POST parameters

Returns:

Promise -

The request Promise