kuzzle 2.19.2 → 2.19.3

package/lib/api/request/kuzzleRequest.js

@@ -59,18 +59,18 @@ const errors_1 = require("../../kerror/errors");
 const kerror = __importStar(require("../../kerror"));
 const types_1 = require("../../types");
 const assert = __importStar(require("../../util/assertType"));
-const assertionError = kerror.wrap('api', 'assert');
+const assertionError = kerror.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';
+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.
  *
@@ -92,13 +92,13 @@ class KuzzleRequest {
         // property
         this[_input].headers = this[_context].connection.misc.headers;
         this.id = data.requestId
-            ? assert.assertString('requestId', data.requestId)
+            ? assert.assertString("requestId", data.requestId)
             : (0, nanoid_1.nanoid)();
         this[_timestamp] = data.timestamp || Date.now();
         // handling provided options
         if (options !== undefined && options !== null) {
-            if (typeof options !== 'object' || Array.isArray(options)) {
-                throw new errors_1.InternalError('Request options must be an object');
+            if (typeof options !== "object" || Array.isArray(options)) {
+                throw new errors_1.InternalError("Request options must be an object");
             }
             /*
              * Beware of the order of setXxx methods: if there is an
@@ -119,7 +119,7 @@ class KuzzleRequest {
                 }
                 else {
                     const error = new errors_1.KuzzleError(options.error.message, options.error.status || 500);
-                    for (const prop of Object.keys(options.error).filter(key => key !== 'message' && key !== 'status')) {
+                    for (const prop of Object.keys(options.error).filter((key) => key !== "message" && key !== "status")) {
                         error[prop] = options.error[prop];
                     }
                     this.setError(error);
@@ -156,7 +156,7 @@ class KuzzleRequest {
         return this[_status];
     }
     set status(i) {
-        this[_status] = assert.assertInteger('status', i);
+        this[_status] = assert.assertInteger("status", i);
     }
     /**
      * Request input
@@ -196,9 +196,10 @@ class KuzzleRequest {
      */
     setError(error) {
         if (!error || !(error instanceof Error)) {
-            throw new errors_1.InternalError('Cannot set non-error object as a request\'s 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[_error] =
+            error instanceof errors_1.KuzzleError ? error : new errors_1.InternalError(error);
         this.status = this[_error].status;
     }
     /**
@@ -221,15 +222,16 @@ class KuzzleRequest {
      */
     setResult(result, options = {}) {
         if (result instanceof Error) {
-            throw new errors_1.InternalError('cannot set an error as a request\'s response');
+            throw new errors_1.InternalError("cannot set an error as a request's response");
         }
-        if (this.context.connection.protocol !== 'http' && result instanceof types_1.HttpStream) {
-            throw kerror.get('api', 'assert', 'forbidden_stream');
+        if (this.context.connection.protocol !== "http" &&
+            result instanceof types_1.HttpStream) {
+            throw kerror.get("api", "assert", "forbidden_stream");
         }
         this.status = options.status || 200;
         if (options.headers) {
             this.response.configure({
-                headers: options.headers
+                headers: options.headers,
             });
         }
         if (options.raw !== undefined) {
@@ -244,7 +246,7 @@ class KuzzleRequest {
      * @param message message displayed in the warning
      */
     addDeprecation(version, message) {
-        if (global.NODE_ENV !== 'development') {
+        if (global.NODE_ENV !== "development") {
             return;
         }
         const deprecation = {
@@ -329,9 +331,9 @@ class KuzzleRequest {
      * It can only be 'elasticsearch' or 'koncorde'
      */
     getLangParam() {
-        const lang = this.getString('lang', 'elasticsearch');
-        if (lang !== 'elasticsearch' && lang !== 'koncorde') {
-            throw kerror.get('api', 'assert', 'invalid_argument', 'lang', '"elasticsearch" or "koncorde"');
+        const lang = this.getString("lang", "elasticsearch");
+        if (lang !== "elasticsearch" && lang !== "koncorde") {
+            throw kerror.get("api", "assert", "invalid_argument", "lang", '"elasticsearch" or "koncorde"');
         }
         return lang;
     }
@@ -367,7 +369,7 @@ class KuzzleRequest {
             if (def !== undefined) {
                 return def;
             }
-            throw assertionError.get('body_required');
+            throw assertionError.get("body_required");
         }
         return this._getNumber(body, name, `body.${name}`, def);
     }
@@ -389,7 +391,7 @@ class KuzzleRequest {
             if (def !== undefined) {
                 return def;
             }
-            throw assertionError.get('body_required');
+            throw assertionError.get("body_required");
         }
         return this._getInteger(body, name, `body.${name}`, def);
     }
@@ -411,7 +413,7 @@ class KuzzleRequest {
             if (def !== undefined) {
                 return def;
             }
-            throw assertionError.get('body_required');
+            throw assertionError.get("body_required");
         }
         return this._getString(body, name, `body.${name}`, def);
     }
@@ -433,7 +435,7 @@ class KuzzleRequest {
             if (def !== undefined) {
                 return def;
             }
-            throw assertionError.get('body_required');
+            throw assertionError.get("body_required");
         }
         return this._getArray(body, name, `body.${name}`, def);
     }
@@ -455,7 +457,7 @@ class KuzzleRequest {
             if (def !== undefined) {
                 return def;
             }
-            throw assertionError.get('body_required');
+            throw assertionError.get("body_required");
         }
         return this._getObject(body, name, `body.${name}`, def);
     }
@@ -543,17 +545,17 @@ class KuzzleRequest {
     getArrayLegacy(name, def = undefined) {
         const value = (0, lodash_1.get)(this.input.args, name, def);
         if (value === undefined) {
-            throw assertionError.get('missing_argument', name);
+            throw assertionError.get("missing_argument", name);
         }
         if (Array.isArray(value)) {
             return value;
         }
-        if (typeof value !== 'string') {
-            throw assertionError.get('invalid_type', name, 'array');
+        if (typeof value !== "string") {
+            throw assertionError.get("invalid_type", name, "array");
         }
         // If we are using the HTTP protocol and we have a string instead of an Array
         // we try to parse it as JSON
-        if (this.context.connection.protocol === 'http') {
+        if (this.context.connection.protocol === "http") {
             try {
                 const parsedValue = JSON.parse(value);
                 if (Array.isArray(parsedValue)) {
@@ -564,7 +566,7 @@ class KuzzleRequest {
                 // Do nothing, let the code continue
             }
         }
-        return value.split(',');
+        return value.split(",");
     }
     /**
      * Gets a parameter from a request arguments and checks that it is an object
@@ -596,13 +598,13 @@ class KuzzleRequest {
     getDate(name, format) {
         const args = this.input.args;
         if (args[name] === undefined) {
-            throw assertionError.get('missing_argument', name);
+            throw assertionError.get("missing_argument", name);
         }
         if (format && !(0, moment_1.default)(args[name], format, true).isValid()) {
-            throw assertionError.get('invalid_type', name, 'date');
+            throw assertionError.get("invalid_type", name, "date");
         }
         if (!(0, moment_1.default)(args[name], moment_1.default.ISO_8601).isValid()) {
-            throw assertionError.get('invalid_type', name, 'date');
+            throw assertionError.get("invalid_type", name, "date");
         }
         return this.getString(name);
     }
@@ -617,10 +619,10 @@ class KuzzleRequest {
     getTimestamp(name) {
         const args = this.input.args;
         if (args[name] === undefined) {
-            throw assertionError.get('missing_argument', name);
+            throw assertionError.get("missing_argument", name);
         }
         if ((0, moment_1.default)(args[name], true).isValid() === false) {
-            throw assertionError.get('invalid_type', name, 'date');
+            throw assertionError.get("invalid_type", name, "date");
         }
         return this.getInteger(name);
     }
@@ -629,7 +631,7 @@ class KuzzleRequest {
      */
     getIndex({ required = true } = {}) {
         const index = this.input.args.index;
-        this.checkRequired(index, 'index', required);
+        this.checkRequired(index, "index", required);
         return index ? String(index) : null;
     }
     /**
@@ -637,7 +639,7 @@ class KuzzleRequest {
      */
     getCollection({ required = true } = {}) {
         const collection = this.input.args.collection;
-        this.checkRequired(collection, 'collection', required);
+        this.checkRequired(collection, "collection", required);
         return collection ? String(collection) : null;
     }
     /**
@@ -645,10 +647,10 @@ class KuzzleRequest {
      */
     getIndexAndCollection() {
         if (!this.input.args.index) {
-            throw assertionError.get('missing_argument', 'index');
+            throw assertionError.get("missing_argument", "index");
         }
         if (!this.input.args.collection) {
-            throw assertionError.get('missing_argument', 'collection');
+            throw assertionError.get("missing_argument", "collection");
         }
         return {
             collection: this.input.args.collection,
@@ -668,7 +670,7 @@ class KuzzleRequest {
             if (def !== undefined) {
                 return def;
             }
-            throw assertionError.get('body_required');
+            throw assertionError.get("body_required");
         }
         return this.input.body;
     }
@@ -680,20 +682,20 @@ class KuzzleRequest {
      *    - `generator`: function used to generate an ID (default: 'uuid.v4')
      *
      */
-    getId(options = { generator: uuid.v4, ifMissing: 'error' }) {
+    getId(options = { generator: uuid.v4, ifMissing: "error" }) {
         const id = this.input.args._id;
         options.generator = options.generator || uuid.v4; // Default to uuid v4
         if (!id) {
-            if (options.ifMissing === 'generate') {
+            if (options.ifMissing === "generate") {
                 return options.generator();
             }
-            if (options.ifMissing === 'ignore') {
+            if (options.ifMissing === "ignore") {
                 return null;
             }
-            throw assertionError.get('missing_argument', '_id');
+            throw assertionError.get("missing_argument", "_id");
         }
-        if (typeof id !== 'string') {
-            throw assertionError.get('invalid_type', '_id', 'string');
+        if (typeof id !== "string") {
+            throw assertionError.get("invalid_type", "_id", "string");
         }
         return String(id);
     }
@@ -719,20 +721,20 @@ class KuzzleRequest {
      * Returns the search body query according to the http method
      */
     getSearchBody() {
-        if (this.context.connection.protocol !== 'http'
-            || this.context.connection.misc.verb !== 'GET') {
+        if (this.context.connection.protocol !== "http" ||
+            this.context.connection.misc.verb !== "GET") {
             return this.getBody({});
         }
-        return this.getObject('searchBody', {});
+        return this.getObject("searchBody", {});
     }
     /**
      * Returns the search params.
      */
     getSearchParams() {
-        const from = this.getInteger('from', 0);
-        const size = this.getInteger('size', 10);
+        const from = this.getInteger("from", 0);
+        const size = this.getInteger("size", 10);
         const scrollTTL = this.getScrollTTLParam();
-        const query = this.getBodyObject('query', {});
+        const query = this.getBodyObject("query", {});
         const searchBody = this.getSearchBody();
         return { from, query, scrollTTL, searchBody, size };
     }
@@ -741,24 +743,24 @@ class KuzzleRequest {
      */
     getScrollTTLParam() {
         const scrollTTLParam = this.input.args.scroll;
-        if (scrollTTLParam && typeof scrollTTLParam !== 'string') {
-            throw assertionError.get('invalid_type', 'scroll', 'string');
+        if (scrollTTLParam && typeof scrollTTLParam !== "string") {
+            throw assertionError.get("invalid_type", "scroll", "string");
         }
         return scrollTTLParam;
     }
     /**
      * Gets the refresh value.
      */
-    getRefresh(defaultValue = 'false') {
+    getRefresh(defaultValue = "false") {
         if (this.input.args.refresh === undefined) {
             return defaultValue;
         }
-        if (this.input.args.refresh === false
-            || this.input.args.refresh === 'false'
-            || this.input.args.refresh === null) {
-            return 'false';
+        if (this.input.args.refresh === false ||
+            this.input.args.refresh === "false" ||
+            this.input.args.refresh === null) {
+            return "false";
         }
-        return 'wait_for';
+        return "wait_for";
     }
     /**
      * Returns true if the current user have `admin` profile
@@ -768,7 +770,7 @@ class KuzzleRequest {
         if (!user) {
             return false;
         }
-        return user.profileIds.includes('admin');
+        return user.profileIds.includes("admin");
     }
     /**
      * Generic object getter: boolean value
@@ -784,15 +786,15 @@ class KuzzleRequest {
         // whatever its value.
         // If a user needs to unset the option, they need to remove it from the
         // querystring.
-        if (this.context.connection.protocol === 'http' && querystring) {
+        if (this.context.connection.protocol === "http" && querystring) {
             value = value !== undefined;
             (0, lodash_1.set)(obj, name, value);
         }
         else if (value === undefined || value === null) {
             value = false;
         }
-        else if (typeof value !== 'boolean') {
-            throw assertionError.get('invalid_type', errorName, 'boolean');
+        else if (typeof value !== "boolean") {
+            throw assertionError.get("invalid_type", errorName, "boolean");
         }
         else {
             value = Boolean(value);
@@ -810,11 +812,11 @@ class KuzzleRequest {
     _getNumber(obj, name, errorName, def = undefined) {
         let value = (0, lodash_1.get)(obj, name, def);
         if (value === undefined) {
-            throw assertionError.get('missing_argument', errorName);
+            throw assertionError.get("missing_argument", errorName);
         }
         value = Number.parseFloat(value);
         if (Number.isNaN(value)) {
-            throw assertionError.get('invalid_type', errorName, 'number');
+            throw assertionError.get("invalid_type", errorName, "number");
         }
         return value;
     }
@@ -829,11 +831,11 @@ class KuzzleRequest {
     _getInteger(obj, name, errorName, def = undefined) {
         let value = (0, lodash_1.get)(obj, name, def);
         if (value === undefined) {
-            throw assertionError.get('missing_argument', errorName);
+            throw assertionError.get("missing_argument", errorName);
         }
         value = Number.parseFloat(value);
         if (Number.isNaN(value) || !Number.isSafeInteger(value)) {
-            throw assertionError.get('invalid_type', errorName, 'integer');
+            throw assertionError.get("invalid_type", errorName, "integer");
         }
         return value;
     }
@@ -848,10 +850,10 @@ class KuzzleRequest {
     _getString(obj, name, errorName, def = undefined) {
         const value = (0, lodash_1.get)(obj, name, def);
         if (value === undefined) {
-            throw assertionError.get('missing_argument', errorName);
+            throw assertionError.get("missing_argument", errorName);
         }
-        if (typeof value !== 'string') {
-            throw assertionError.get('invalid_type', errorName, 'string');
+        if (typeof value !== "string") {
+            throw assertionError.get("invalid_type", errorName, "string");
         }
         return value;
     }
@@ -866,14 +868,14 @@ class KuzzleRequest {
     _getArray(obj, name, errorName, def = undefined, querystring = false) {
         const value = (0, lodash_1.get)(obj, name, def);
         if (value === undefined) {
-            throw assertionError.get('missing_argument', errorName);
+            throw assertionError.get("missing_argument", errorName);
         }
         if (!Array.isArray(value)) {
             // If we are using the HTTP protocol and we have a string instead of an Array
             // we try to parse it as JSON
-            if (this.context.connection.protocol === 'http'
-                && querystring
-                && typeof value === 'string') {
+            if (this.context.connection.protocol === "http" &&
+                querystring &&
+                typeof value === "string") {
                 try {
                     const parsedValue = JSON.parse(value);
                     if (Array.isArray(parsedValue)) {
@@ -887,7 +889,7 @@ class KuzzleRequest {
                     // Do nothing, let the error be thrown below
                 }
             }
-            throw assertionError.get('invalid_type', errorName, 'array');
+            throw assertionError.get("invalid_type", errorName, "array");
         }
         return value;
     }
@@ -903,14 +905,14 @@ class KuzzleRequest {
     _getObject(obj, name, errorName, def = undefined, querystring = false) {
         const value = (0, lodash_1.get)(obj, name, def);
         if (value === undefined) {
-            throw assertionError.get('missing_argument', errorName);
+            throw assertionError.get("missing_argument", errorName);
         }
         if (!(0, safeObject_1.isPlainObject)(value)) {
             // If we are using the HTTP protocol and we have a string instead of an Array
             // we try to parse it as JSON
-            if (this.context.connection.protocol === 'http'
-                && querystring
-                && typeof value === 'string') {
+            if (this.context.connection.protocol === "http" &&
+                querystring &&
+                typeof value === "string") {
                 try {
                     const parsedValue = JSON.parse(value);
                     if ((0, safeObject_1.isPlainObject)(parsedValue)) {
@@ -924,7 +926,7 @@ class KuzzleRequest {
                     // Do nothing, let the error be thrown below
                 }
             }
-            throw assertionError.get('invalid_type', errorName, 'object');
+            throw assertionError.get("invalid_type", errorName, "object");
         }
         return value;
     }
@@ -933,7 +935,7 @@ class KuzzleRequest {
      */
     checkRequired(arg, argName, required) {
         if (required && !arg) {
-            throw assertionError.get('missing_argument', argName);
+            throw assertionError.get("missing_argument", argName);
         }
     }
 }

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

@@ -1,5 +1,5 @@
-import { JSONObject } from 'kuzzle-sdk';
-import { User, Token } from '../../types';
+import { JSONObject } from "kuzzle-sdk";
+import { User, Token } from "../../types";
 export declare type ContextMisc = {
     /**
      * HTTP url

package/lib/api/request/requestContext.js

@@ -47,14 +47,14 @@ 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';
+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';
+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.
  */
@@ -65,11 +65,11 @@ class Connection {
         this[_c_ips] = [];
         this[_c_misc] = {};
         Object.seal(this);
-        if (typeof connection !== 'object' || connection === null) {
+        if (typeof connection !== "object" || connection === null) {
             return;
         }
         for (const prop of Object.keys(connection)) {
-            if (['id', 'protocol', 'ips'].includes(prop)) {
+            if (["id", "protocol", "ips"].includes(prop)) {
                 this[prop] = connection[prop];
             }
             else {
@@ -81,7 +81,7 @@ class Connection {
      * Unique identifier of the user connection
      */
     set id(str) {
-        this[_c_id] = assert.assertString('connection.id', str);
+        this[_c_id] = assert.assertString("connection.id", str);
     }
     get id() {
         return this[_c_id];
@@ -90,7 +90,7 @@ class Connection {
      * Network protocol name
      */
     set protocol(str) {
-        this[_c_protocol] = assert.assertString('connection.protocol', str);
+        this[_c_protocol] = assert.assertString("connection.protocol", str);
     }
     get protocol() {
         return this[_c_protocol];
@@ -99,7 +99,7 @@ class Connection {
      * Chain of IP addresses, starting from the client
      */
     set ips(arr) {
-        this[_c_ips] = assert.assertArray('connection.ips', arr, 'string');
+        this[_c_ips] = assert.assertArray("connection.ips", arr, "string");
     }
     get ips() {
         return this[_c_ips];
@@ -118,7 +118,7 @@ class Connection {
             id: this[_c_id],
             ips: this[_c_ips],
             protocol: this[_c_protocol],
-            ...this[_c_misc]
+            ...this[_c_misc],
         };
     }
 }
@@ -163,7 +163,7 @@ class RequestContext {
         return this[_connection].id;
     }
     set connectionId(str) {
-        this[_connection].id = assert.assertString('connectionId', str);
+        this[_connection].id = assert.assertString("connectionId", str);
     }
     /**
      * @deprecated use connection.protocol instead
@@ -172,7 +172,7 @@ class RequestContext {
         return this[_connection].protocol;
     }
     set protocol(str) {
-        this[_connection].protocol = assert.assertString('protocol', str);
+        this[_connection].protocol = assert.assertString("protocol", str);
     }
     /**
      * Connection that initiated the request
@@ -187,7 +187,7 @@ class RequestContext {
         return this[_token];
     }
     set token(obj) {
-        this[_token] = assert.assertObject('token', obj);
+        this[_token] = assert.assertObject("token", obj);
     }
     /**
      * Associated user
@@ -196,7 +196,7 @@ class RequestContext {
         return this[_user];
     }
     set user(obj) {
-        this[_user] = assert.assertObject('user', obj);
+        this[_user] = assert.assertObject("user", obj);
     }
 }
 exports.RequestContext = RequestContext;

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

@@ -1,4 +1,4 @@
-import { JSONObject } from 'kuzzle-sdk';
+import { JSONObject } from "kuzzle-sdk";
 /**
  * @deprecated
  */