kuzzle 2.15.2 → 2.16.0

package/lib/api/request/kuzzleRequest.d.ts

@@ -1,6 +1,5 @@
 import { JSONObject } from 'kuzzle-sdk';
 import { RequestInput } from './requestInput';
-import { RequestResponse } from './requestResponse';
 import { RequestContext } from './requestContext';
 import { KuzzleError } from '../../kerror/errors';
 import { Deprecation, User } from '../../types';
@@ -13,47 +12,46 @@ import { Deprecation, User } from '../../types';
  */
 export declare class KuzzleRequest {
     /**
-     * Request external ID (specified by "requestId" or random uuid)
+     * Deprecation warnings for the API action
      */
-    id: string;
-    constructor(data: any, options: any);
+    deprecations: Deprecation[] | undefined;
     /**
-     * Request internal ID
-     */
-    get internalId(): string;
+    * Request timestamp (in Epoch-Micro)
+    */
+    timestamp: number;
     /**
-     * Deprecation warnings for the API action
-     */
-    get deprecations(): Deprecation[] | void;
+    * Request HTTP status
+    */
+    status: any;
     /**
-     * Request timestamp (in Epoch-micro)
-     */
-    get timestamp(): number;
+    * Request input
+    */
+    input: RequestInput;
     /**
-     * Request HTTP status
-     */
-    get status(): number;
-    set status(i: number);
+   * Request context
+   */
+    context: RequestContext;
     /**
-     * Request input
-     */
-    get input(): RequestInput;
+    * Request error
+    */
+    error: KuzzleError;
     /**
-     * Request context
-     */
-    get context(): RequestContext;
+    * Request result
+    */
+    result: any;
     /**
-     * Request error
-     */
-    get error(): KuzzleError | null;
+    * Request response
+    */
+    response: any;
     /**
-     * Request result
-     */
-    get result(): any | null;
+    * Request internal ID
+    */
+    internalId: any;
     /**
-     * Request response
-     */
-    get response(): RequestResponse;
+    * Request external ID (specified by "requestId" or random uuid)
+    */
+    id: string;
+    constructor(data: any, options: any);
     /**
      * Adds an error to the request, and sets the request's status to the error one.
      */

package/lib/api/request/kuzzleRequest.js

@@ -53,17 +53,6 @@ const kerror_1 = __importDefault(require("../../kerror"));
 const assert = __importStar(require("../../util/assertType"));
 const safeObject_1 = require("../../util/safeObject");
 const assertionError = kerror_1.default.wrap('api', 'assert');
-// private properties
-// \u200b is a zero width space, used to masquerade console.log output
-const _internalId = 'internalId\u200b';
-const _status = 'status\u200b';
-const _input = 'input\u200b';
-const _error = 'error\u200b';
-const _result = 'result\u200b';
-const _context = 'context\u200b';
-const _timestamp = 'timestamp\u200b';
-const _response = 'response\u200b';
-const _deprecations = 'deprecations\u200b';
 /**
  * The `KuzzleRequest` class represents a request being processed by Kuzzle.
  *
@@ -73,21 +62,21 @@ const _deprecations = 'deprecations\u200b';
  */
 class KuzzleRequest {
     constructor(data, options) {
-        this[_internalId] = (0, nanoid_1.nanoid)();
-        this[_status] = 102;
-        this[_input] = new requestInput_1.RequestInput(data);
-        this[_context] = new requestContext_1.RequestContext(options);
-        this[_error] = null;
-        this[_result] = null;
-        this[_response] = null;
-        this[_deprecations] = undefined;
+        this.internalId = (0, nanoid_1.nanoid)();
+        this.status = 102;
+        this.input = new requestInput_1.RequestInput(data);
+        this.context = new requestContext_1.RequestContext(options);
+        this.error = null;
+        this.result = null;
+        this.response = new requestResponse_1.RequestResponse(this);
+        this.deprecations = undefined;
         // @deprecated - Backward compatibility with the RequestInput.headers
         // property
-        this[_input].headers = this[_context].connection.misc.headers;
+        this.input.headers = this.context.connection.misc.headers;
         this.id = data.requestId
             ? assert.assertString('requestId', data.requestId)
             : (0, nanoid_1.nanoid)();
-        this[_timestamp] = data.timestamp || Date.now();
+        this.timestamp = data.timestamp || Date.now();
         // handling provided options
         if (options !== undefined && options !== null) {
             if (typeof options !== 'object' || Array.isArray(options)) {
@@ -122,67 +111,6 @@ class KuzzleRequest {
                 this.status = options.status;
             }
         }
-        Object.seal(this);
-    }
-    /**
-     * Request internal ID
-     */
-    get internalId() {
-        return this[_internalId];
-    }
-    /**
-     * Deprecation warnings for the API action
-     */
-    get deprecations() {
-        return this[_deprecations];
-    }
-    /**
-     * Request timestamp (in Epoch-micro)
-     */
-    get timestamp() {
-        return this[_timestamp];
-    }
-    /**
-     * Request HTTP status
-     */
-    get status() {
-        return this[_status];
-    }
-    set status(i) {
-        this[_status] = assert.assertInteger('status', i);
-    }
-    /**
-     * Request input
-     */
-    get input() {
-        return this[_input];
-    }
-    /**
-     * Request context
-     */
-    get context() {
-        return this[_context];
-    }
-    /**
-     * Request error
-     */
-    get error() {
-        return this[_error];
-    }
-    /**
-     * Request result
-     */
-    get result() {
-        return this[_result];
-    }
-    /**
-     * Request response
-     */
-    get response() {
-        if (this[_response] === null) {
-            this[_response] = new requestResponse_1.RequestResponse(this);
-        }
-        return this[_response];
     }
     /**
      * Adds an error to the request, and sets the request's status to the error one.
@@ -191,14 +119,14 @@ class KuzzleRequest {
         if (!error || !(error instanceof Error)) {
             throw new errors_1.InternalError('Cannot set non-error object as a request\'s error');
         }
-        this[_error] = error instanceof errors_1.KuzzleError ? error : new errors_1.InternalError(error);
-        this.status = this[_error].status;
+        this.error = error instanceof errors_1.KuzzleError ? error : new errors_1.InternalError(error);
+        this.status = this.error.status;
     }
     /**
      * Sets the request error to null and status to 200
      */
     clearError() {
-        this[_error] = null;
+        this.error = null;
         this.status = 200;
     }
     /**
@@ -223,7 +151,7 @@ class KuzzleRequest {
         if (options.raw !== undefined) {
             this.response.raw = options.raw;
         }
-        this[_result] = result;
+        this.result = result;
     }
     /**
      * Add a deprecation for a used component, this can be action/controller/parameters...
@@ -240,7 +168,7 @@ class KuzzleRequest {
             version,
         };
         if (!this.deprecations) {
-            this[_deprecations] = [deprecation];
+            this.deprecations = [deprecation];
         }
         else {
             this.deprecations.push(deprecation);
@@ -254,27 +182,27 @@ class KuzzleRequest {
     serialize() {
         const serialized = {
             data: {
-                _id: this[_input].args._id,
-                action: this[_input].action,
-                body: this[_input].body,
-                collection: this[_input].args.collection,
-                controller: this[_input].controller,
-                index: this[_input].args.index,
-                jwt: this[_input].jwt,
+                _id: this.input.args._id,
+                action: this.input.action,
+                body: this.input.body,
+                collection: this.input.args.collection,
+                controller: this.input.controller,
+                index: this.input.args.index,
+                jwt: this.input.jwt,
                 requestId: this.id,
-                timestamp: this[_timestamp],
-                volatile: this[_input].volatile,
+                timestamp: this.timestamp,
+                volatile: this.input.volatile,
             },
             // @deprecated - duplicate of options.connection.misc.headers
-            headers: this[_input].headers,
+            headers: this.input.headers,
             options: {
-                error: this[_error],
-                result: this[_result],
-                status: this[_status],
+                error: this.error,
+                result: this.result,
+                status: this.status,
             },
         };
-        Object.assign(serialized.data, this[_input].args);
-        Object.assign(serialized.options, this[_context].toJSON());
+        Object.assign(serialized.data, this.input.args);
+        Object.assign(serialized.options, this.context.toJSON());
         return serialized;
     }
     /**

package/lib/api/request/requestContext.d.ts

@@ -24,26 +24,23 @@ export declare type ContextMisc = {
  * Information about the connection at the origin of the request.
  */
 export declare class Connection {
-    constructor(connection: any);
     /**
      * Unique identifier of the user connection
      */
-    set id(str: string);
-    get id(): string | null;
+    id: string;
     /**
      * Network protocol name
      */
-    set protocol(str: string);
-    get protocol(): string | null;
+    protocol: string;
     /**
      * Chain of IP addresses, starting from the client
      */
-    set ips(arr: string[]);
-    get ips(): string[];
+    ips: string[];
     /**
      * Additional informations about the connection
      */
-    get misc(): ContextMisc;
+    misc: ContextMisc;
+    constructor(connection: any);
     /**
      * Serializes the Connection object
      */
@@ -56,6 +53,18 @@ export declare class Connection {
  * and origin (connection, protocol).
  */
 export declare class RequestContext {
+    /**
+     * Connection that initiated the request
+     */
+    connection: Connection;
+    /**
+     * Authentication token
+     */
+    token: Token | null;
+    /**
+     * Associated user
+     */
+    user: User | null;
     constructor(options?: any);
     /**
      * Serializes the RequestContext object
@@ -72,18 +81,4 @@ export declare class RequestContext {
      */
     get protocol(): string | null;
     set protocol(str: string);
-    /**
-     * Connection that initiated the request
-     */
-    get connection(): Connection;
-    /**
-     * Authentication token
-     */
-    get token(): Token | null;
-    set token(obj: Token | null);
-    /**
-     * Associated user
-     */
-    get user(): User | null;
-    set user(obj: User | null);
 }

package/lib/api/request/requestContext.js

@@ -19,48 +19,29 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestContext = exports.Connection = void 0;
-const assert = __importStar(require("../../util/assertType"));
-// private properties
-// \u200b is a zero width space, used to masquerade console.log output
-const _token = 'token\u200b';
-const _user = 'user\u200b';
-const _connection = 'connection\u200b';
-// Connection class properties
-const _c_id = 'id\u200b';
-const _c_protocol = 'protocol\u200b';
-const _c_ips = 'ips\u200b';
-const _c_misc = 'misc\u200b';
 /**
  * Information about the connection at the origin of the request.
  */
 class Connection {
     constructor(connection) {
-        this[_c_id] = null;
-        this[_c_protocol] = null;
-        this[_c_ips] = [];
-        this[_c_misc] = {};
-        Object.seal(this);
+        /**
+         * Unique identifier of the user connection
+         */
+        this.id = null;
+        /**
+         * Network protocol name
+         */
+        this.protocol = null;
+        /**
+         * Chain of IP addresses, starting from the client
+         */
+        this.ips = [];
+        /**
+         * Additional informations about the connection
+         */
+        this.misc = {};
         if (typeof connection !== 'object' || connection === null) {
             return;
         }
@@ -73,48 +54,15 @@ class Connection {
             }
         }
     }
-    /**
-     * Unique identifier of the user connection
-     */
-    set id(str) {
-        this[_c_id] = assert.assertString('connection.id', str);
-    }
-    get id() {
-        return this[_c_id];
-    }
-    /**
-     * Network protocol name
-     */
-    set protocol(str) {
-        this[_c_protocol] = assert.assertString('connection.protocol', str);
-    }
-    get protocol() {
-        return this[_c_protocol];
-    }
-    /**
-     * Chain of IP addresses, starting from the client
-     */
-    set ips(arr) {
-        this[_c_ips] = assert.assertArray('connection.ips', arr, 'string');
-    }
-    get ips() {
-        return this[_c_ips];
-    }
-    /**
-     * Additional informations about the connection
-     */
-    get misc() {
-        return this[_c_misc];
-    }
     /**
      * Serializes the Connection object
      */
     toJSON() {
         return {
-            id: this[_c_id],
-            ips: this[_c_ips],
-            protocol: this[_c_protocol],
-            ...this[_c_misc]
+            id: this.id,
+            ips: this.ips,
+            protocol: this.protocol,
+            ...this.misc
         };
     }
 }
@@ -127,12 +75,23 @@ exports.Connection = Connection;
  */
 class RequestContext {
     constructor(options = {}) {
-        this[_token] = null;
-        this[_user] = null;
-        this[_connection] = new Connection(options.connection);
-        Object.seal(this);
-        this.token = options.token;
-        this.user = options.user;
+        /**
+         * Authentication token
+         */
+        this.token = null;
+        /**
+         * Associated user
+         */
+        this.user = null;
+        this.token = null;
+        this.user = null;
+        this.connection = new Connection(options.connection);
+        if (options.token) {
+            this.token = options.token;
+        }
+        if (options.user) {
+            this.user = options.user;
+        }
         // @deprecated - backward compatibility only
         if (options.connectionId) {
             this.connectionId = options.connectionId;
@@ -146,9 +105,9 @@ class RequestContext {
      */
     toJSON() {
         return {
-            connection: this[_connection].toJSON(),
-            token: this[_token],
-            user: this[_user],
+            connection: this.connection.toJSON(),
+            token: this.token,
+            user: this.user,
         };
     }
     /**
@@ -156,43 +115,19 @@ class RequestContext {
      * Internal connection ID
      */
     get connectionId() {
-        return this[_connection].id;
+        return this.connection.id;
     }
     set connectionId(str) {
-        this[_connection].id = assert.assertString('connectionId', str);
+        this.connection.id = str;
     }
     /**
      * @deprecated use connection.protocol instead
      */
     get protocol() {
-        return this[_connection].protocol;
+        return this.connection.protocol;
     }
     set protocol(str) {
-        this[_connection].protocol = assert.assertString('protocol', str);
-    }
-    /**
-     * Connection that initiated the request
-     */
-    get connection() {
-        return this[_connection];
-    }
-    /**
-     * Authentication token
-     */
-    get token() {
-        return this[_token];
-    }
-    set token(obj) {
-        this[_token] = assert.assertObject('token', obj);
-    }
-    /**
-     * Associated user
-     */
-    get user() {
-        return this[_user];
-    }
-    set user(obj) {
-        this[_user] = assert.assertObject('user', obj);
+        this.connection.protocol = str;
     }
 }
 exports.RequestContext = RequestContext;

package/lib/api/request/requestInput.d.ts

@@ -7,16 +7,19 @@ export declare class RequestResource {
     constructor(args: JSONObject);
     /**
      * Document ID
+     * @deprecated
      */
     get _id(): string | null;
     set _id(str: string);
     /**
      * Index name
+     * @deprecated
      */
     get index(): string | null;
     set index(str: string);
     /**
      * Collection name
+     * @deprecated
      */
     get collection(): string | null;
     set collection(str: string);
@@ -52,7 +55,7 @@ export declare class RequestInput {
     /**
      * Common arguments that identify Kuzzle resources.
      * (e.g: "_id", "index", "collection")
-     * @deprecated Use directly`request.input.args.<_id|index|collection>` instead
+     * @deprecated Use`request.getId()|getIndex()|getCollection()>` instead
      * @example
      * // original JSON request sent to Kuzzle
      * {
@@ -69,15 +72,6 @@ export declare class RequestInput {
      *  }
      */
     resource: RequestResource;
-    /**
-     * Builds a Kuzzle normalized request input object
-     *
-     * The 'data' object accepts a request content using the same
-     * format as the one used, for instance, for the Websocket protocol
-     *
-     * Any undefined option is set to null
-     */
-    constructor(data: any);
     /**
      * Authentication token.
      * @example
@@ -95,8 +89,7 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    get jwt(): string | null;
-    set jwt(str: string);
+    jwt: string | null;
     /**
      * API controller name.
      * @example
@@ -114,8 +107,7 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    get controller(): string | null;
-    set controller(str: string);
+    controller: string | null;
     /**
      * API action name.
      * @example
@@ -133,8 +125,7 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    get action(): string | null;
-    set action(str: string);
+    action: string | null;
     /**
      * Request body.
      * In Http it's the request body parsed.
@@ -153,13 +144,11 @@ export declare class RequestInput {
      *   body         <== that
      *  }
      */
-    get body(): JSONObject | null;
-    set body(obj: JSONObject);
+    body: JSONObject | null;
     /**
      * Request headers (Http only).
      */
-    get headers(): JSONObject | null;
-    set headers(obj: JSONObject);
+    headers: JSONObject | null;
     /**
      * Volatile object.
      * @example
@@ -177,6 +166,14 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    get volatile(): JSONObject | null;
-    set volatile(obj: JSONObject);
+    volatile: JSONObject | null;
+    /**
+     * Builds a Kuzzle normalized request input object
+     *
+     * The 'data' object accepts a request content using the same
+     * format as the one used, for instance, for the Websocket protocol
+     *
+     * Any undefined option is set to null
+     */
+    constructor(data: any);
 }