kuzzle 2.16.2 → 2.16.6

package/lib/api/request/requestContext.js

@@ -19,29 +19,48 @@
  * 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) {
-        /**
-         * 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 = {};
+        this[_c_id] = null;
+        this[_c_protocol] = null;
+        this[_c_ips] = [];
+        this[_c_misc] = {};
+        Object.seal(this);
         if (typeof connection !== 'object' || connection === null) {
             return;
         }
@@ -54,15 +73,48 @@ 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.id,
-            ips: this.ips,
-            protocol: this.protocol,
-            ...this.misc
+            id: this[_c_id],
+            ips: this[_c_ips],
+            protocol: this[_c_protocol],
+            ...this[_c_misc]
         };
     }
 }
@@ -75,23 +127,12 @@ exports.Connection = Connection;
  */
 class RequestContext {
     constructor(options = {}) {
-        /**
-         * 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;
-        }
+        this[_token] = null;
+        this[_user] = null;
+        this[_connection] = new Connection(options.connection);
+        Object.seal(this);
+        this.token = options.token;
+        this.user = options.user;
         // @deprecated - backward compatibility only
         if (options.connectionId) {
             this.connectionId = options.connectionId;
@@ -105,9 +146,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],
         };
     }
     /**
@@ -115,19 +156,43 @@ class RequestContext {
      * Internal connection ID
      */
     get connectionId() {
-        return this.connection.id;
+        return this[_connection].id;
     }
     set connectionId(str) {
-        this.connection.id = str;
+        this[_connection].id = assert.assertString('connectionId', str);
     }
     /**
      * @deprecated use connection.protocol instead
      */
     get protocol() {
-        return this.connection.protocol;
+        return this[_connection].protocol;
     }
     set protocol(str) {
-        this.connection.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);
     }
 }
 exports.RequestContext = RequestContext;

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

@@ -7,19 +7,16 @@ 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);
@@ -55,7 +52,7 @@ export declare class RequestInput {
     /**
      * Common arguments that identify Kuzzle resources.
      * (e.g: "_id", "index", "collection")
-     * @deprecated Use`request.getId()|getIndex()|getCollection()>` instead
+     * @deprecated Use directly`request.input.args.<_id|index|collection>` instead
      * @example
      * // original JSON request sent to Kuzzle
      * {
@@ -72,6 +69,15 @@ 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
@@ -89,7 +95,8 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    jwt: string | null;
+    get jwt(): string | null;
+    set jwt(str: string);
     /**
      * API controller name.
      * @example
@@ -107,7 +114,8 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    controller: string | null;
+    get controller(): string | null;
+    set controller(str: string);
     /**
      * API action name.
      * @example
@@ -125,7 +133,8 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    action: string | null;
+    get action(): string | null;
+    set action(str: string);
     /**
      * Request body.
      * In Http it's the request body parsed.
@@ -144,11 +153,15 @@ export declare class RequestInput {
      *   body         <== that
      *  }
      */
-    body: JSONObject | null;
+    get body(): JSONObject | null;
+    set body(obj: JSONObject);
     /**
      * Request headers (Http only).
+     *
+     * @deprecated Use RequestContext.connection.misc.headers instead
      */
-    headers: JSONObject | null;
+    get headers(): JSONObject | null;
+    set headers(obj: JSONObject);
     /**
      * Volatile object.
      * @example
@@ -166,14 +179,6 @@ export declare class RequestInput {
      *   body
      *  }
      */
-    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);
+    get volatile(): JSONObject | null;
+    set volatile(obj: JSONObject);
 }

package/lib/api/request/requestInput.js

@@ -19,13 +19,37 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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.RequestInput = exports.RequestResource = void 0;
 const internalError_1 = require("../../kerror/errors/internalError");
-const assertType_1 = __importDefault(require("../../util/assertType"));
+const assert = __importStar(require("../../util/assertType"));
+// private properties
+// \u200b is a zero width space, used to masquerade console.log output
+const _jwt = 'jwt\u200b';
+const _volatile = 'volatile\u200b';
+const _body = 'body\u200b';
+const _headers = 'headers\u200b';
+const _controller = 'controller\u200b';
+const _action = 'action\u200b';
 // any property not listed here will be copied into
 // RequestInput.args
 const resourceProperties = new Set([
@@ -44,7 +68,6 @@ class RequestResource {
     }
     /**
      * Document ID
-     * @deprecated
      */
     get _id() {
         return this.args._id;
@@ -54,7 +77,6 @@ class RequestResource {
     }
     /**
      * Index name
-     * @deprecated
      */
     get index() {
         return this.args.index;
@@ -64,7 +86,6 @@ class RequestResource {
     }
     /**
      * Collection name
-     * @deprecated
      */
     get collection() {
         return this.args.collection;
@@ -93,109 +114,14 @@ class RequestInput {
      * Any undefined option is set to null
      */
     constructor(data) {
-        /**
-         * Authentication token.
-         * @example
-         * // original JSON request sent to Kuzzle
-         * {
-         *   controller
-         *   action,
-         *   _id,
-         *   index,
-         *   collection,
-         *   jwt,        <== that
-         *   refresh,
-         *   foobar,
-         *   volatile,
-         *   body
-         *  }
-         */
-        this.jwt = null;
-        /**
-         * API controller name.
-         * @example
-         * // original JSON request sent to Kuzzle
-         * {
-         *   controller  <== that
-         *   action,
-         *   _id,
-         *   index,
-         *   collection,
-         *   jwt,
-         *   refresh,
-         *   foobar,
-         *   volatile,
-         *   body
-         *  }
-         */
-        this.controller = null;
-        /**
-         * API action name.
-         * @example
-         * // original JSON request sent to Kuzzle
-         * {
-         *   controller
-         *   action,      <== that
-         *   _id,
-         *   index,
-         *   collection,
-         *   jwt,
-         *   refresh,
-         *   foobar,
-         *   volatile,
-         *   body
-         *  }
-         */
-        this.action = null;
-        /**
-         * Request body.
-         * In Http it's the request body parsed.
-         * @example
-         * // original JSON request sent to Kuzzle
-         * {
-         *   controller
-         *   action,
-         *   _id,
-         *   index,
-         *   collection,
-         *   jwt,
-         *   refresh,
-         *   foobar,
-         *   volatile,
-         *   body         <== that
-         *  }
-         */
-        this.body = {};
-        /**
-         * Request headers (Http only).
-         */
-        this.headers = null;
-        /**
-         * Volatile object.
-         * @example
-         * // original JSON request sent to Kuzzle
-         * {
-         *   controller
-         *   action,
-         *   _id,
-         *   index,
-         *   collection,
-         *   jwt,
-         *   refresh,
-         *   foobar,
-         *   volatile,    <== that
-         *   body
-         *  }
-         */
-        this.volatile = null;
         if (!data || typeof data !== 'object' || Array.isArray(data)) {
             throw new internalError_1.InternalError('Input request data must be a non-null object');
         }
-        this.jwt = null;
-        this.volatile = null;
-        this.body = null;
-        this.controller = null;
-        this.action = null;
+        this[_jwt] = null;
+        this[_volatile] = null;
+        this[_body] = null;
+        this[_controller] = null;
+        this[_action] = null;
         // default value to null for former "resources" to avoid breaking
         this.args = {};
         this.resource = new RequestResource(this.args);
@@ -205,17 +131,151 @@ class RequestInput {
                 this.args[k] = data[k];
             }
         }
-        if (data.jwt) {
-            this.jwt = data.jwt;
-        }
-        if (data.volatile) {
-            this.volatile = data.volatile;
+        // @deprecated - RequestContext.connection.misc.headers should be used instead
+        // initialize `_headers` property after the population of `this.args` attribute
+        // `this.headers` can contain protocol specific headers and should be
+        // set after the Request construction
+        // `args.headers` can be an attribute coming from data itself.
+        this[_headers] = null;
+        Object.seal(this);
+        this.jwt = data.jwt;
+        this.volatile = data.volatile;
+        this.body = data.body;
+        this.controller = data.controller;
+        this.action = data.action;
+    }
+    /**
+     * Authentication token.
+     * @example
+     * // original JSON request sent to Kuzzle
+     * {
+     *   controller
+     *   action,
+     *   _id,
+     *   index,
+     *   collection,
+     *   jwt,        <== that
+     *   refresh,
+     *   foobar,
+     *   volatile,
+     *   body
+     *  }
+     */
+    get jwt() {
+        return this[_jwt];
+    }
+    set jwt(str) {
+        this[_jwt] = assert.assertString('jwt', str);
+    }
+    /**
+     * API controller name.
+     * @example
+     * // original JSON request sent to Kuzzle
+     * {
+     *   controller  <== that
+     *   action,
+     *   _id,
+     *   index,
+     *   collection,
+     *   jwt,
+     *   refresh,
+     *   foobar,
+     *   volatile,
+     *   body
+     *  }
+     */
+    get controller() {
+        return this[_controller];
+    }
+    set controller(str) {
+        // can only be set once
+        if (!this[_controller]) {
+            this[_controller] = assert.assertString('controller', str);
         }
-        if (data.body) {
-            this.body = data.body;
+    }
+    /**
+     * API action name.
+     * @example
+     * // original JSON request sent to Kuzzle
+     * {
+     *   controller
+     *   action,      <== that
+     *   _id,
+     *   index,
+     *   collection,
+     *   jwt,
+     *   refresh,
+     *   foobar,
+     *   volatile,
+     *   body
+     *  }
+     */
+    get action() {
+        return this[_action];
+    }
+    set action(str) {
+        // can only be set once
+        if (!this[_action]) {
+            this[_action] = assert.assertString('action', str);
         }
-        this.controller = assertType_1.default.assertString('controller', data.controller);
-        this.action = assertType_1.default.assertString('controller', data.action);
+    }
+    /**
+     * Request body.
+     * In Http it's the request body parsed.
+     * @example
+     * // original JSON request sent to Kuzzle
+     * {
+     *   controller
+     *   action,
+     *   _id,
+     *   index,
+     *   collection,
+     *   jwt,
+     *   refresh,
+     *   foobar,
+     *   volatile,
+     *   body         <== that
+     *  }
+     */
+    get body() {
+        return this[_body];
+    }
+    set body(obj) {
+        this[_body] = assert.assertObject('body', obj);
+    }
+    /**
+     * Request headers (Http only).
+     *
+     * @deprecated Use RequestContext.connection.misc.headers instead
+     */
+    get headers() {
+        return this[_headers];
+    }
+    set headers(obj) {
+        this[_headers] = assert.assertObject('headers', obj);
+    }
+    /**
+     * Volatile object.
+     * @example
+     * // original JSON request sent to Kuzzle
+     * {
+     *   controller
+     *   action,
+     *   _id,
+     *   index,
+     *   collection,
+     *   jwt,
+     *   refresh,
+     *   foobar,
+     *   volatile,    <== that
+     *   body
+     *  }
+     */
+    get volatile() {
+        return this[_volatile];
+    }
+    set volatile(obj) {
+        this[_volatile] = assert.assertObject('volatile', obj);
     }
 }
 exports.RequestInput = RequestInput;