@ima/plugin-rest-client/dist/esm/Request.js

Generic REST API client plugin for the IMA application framework.

import clone from 'clone';
import { deepFreeze } from './utils';
/**
 * Typed representation of a REST API request.
 */ export default class Request {
    /**
   * Initializes the request representation using the provided data.
   *
   * @param {{
   *            parentEntity: *,
   *            resource: *,
   *            parameters: ?Object<string, (number|string)>,
   *            method: string,
   *            url: string,
   *            data: *,
   *            headers: Object<string, string>,
   *            options: {
   *                timeout: number=,
   *                ttl: number=,
   *                repeatRequest: number=,
   *                cache: boolean=,
   *                withCredentials: boolean=
   *            },
   *            serverConfiguration: ?Object<string, *>
   *        }} requestData The data representing this request. See the fields
   *        of this class for more information.
   */ constructor(requestData){
        /**
     * The parent entity within which the specified resource to manipulate.
     * Set to {@code null} if the request's target resource is a top-level
     * resource within the REST API.
     *
     * @type {*}
     */ this.parentEntity = requestData.parentEntity;
        /**
     * The identifier of the REST API resource to access using this
     * request.
     *
     * @type {*}
     */ this.resource = requestData.resource;
        /**
     * The request parameters that were used to generate the URL to which
     * the request will be made.
     *
     * The parameters do not contain the resource entity id, even if one
     * was provided.
     *
     * @type {?Object<string, (number|string|Array<(number|string)>)>}
     */ this.parameters = requestData.parameters && clone(requestData.parameters);
        if ($Debug) {
            deepFreeze(this.parameters);
        }
        /**
     * The HTTP method to use to make the request. The method is specified
     * in upper-case letters.
     *
     * @type {string}
     */ this.method = requestData.method;
        /**
     * The URL to which the request should be made.
     *
     * @type {string}
     */ this.url = requestData.url;
        /**
     * The data to send to the server as the request's body. The field is
     * {@code null} if the request should not carry any data in its body.
     *
     * @type {*}
     */ this.data = clone(requestData.data);
        if ($Debug) {
            if (this.data && typeof this.data === 'object') {
                deepFreeze(this.data);
            }
        }
        /**
     * The headers to send with the HTTP request to the server. These are
     * extracted from the request options into this separate field for
     * conveniency.
     *
     * @type {Object<string, string>}
     */ this.headers = Object.assign({}, requestData.headers);
        if ($Debug) {
            Object.freeze(this.headers);
        }
        /**
     * HTTP request options, without the request headers.
     *
     * @type {{
     *     timeout: number=,
     *     ttl: number=,
     *     repeatRequest: number=,
     *     cache: boolean=,
     *     withCredentials: boolean=
     * }}
     */ this.options = Object.assign({}, requestData.options);
        if ($Debug) {
            Object.freeze(this.options);
        }
        /**
     * The REST API client configuration provided by the server. The field
     * is set to {@code null} if no server-provided configuration is used.
     *
     * @type {?Object<string, *>}
     */ this.serverConfiguration = clone(requestData.serverConfiguration);
        if ($Debug) {
            deepFreeze(this.serverConfiguration);
        }
        if ($Debug) {
            Object.freeze(this);
        }
    }
}

//# sourceMappingURL=Request.js.map