kuzzle 2.19.0 → 2.19.3

package/lib/api/openapi/OpenApiManager.d.ts

@@ -1,4 +1,4 @@
-import { OpenApiDefinition } from '../../types/OpenApiDefinition';
+import { OpenApiDefinition } from "../../types/OpenApiDefinition";
 export declare class OpenApiManager {
     kuzzleDefinition: OpenApiDefinition;
     applicationDefinition: OpenApiDefinition;

package/lib/api/openapi/OpenApiManager.js

@@ -32,38 +32,38 @@ class OpenApiManager {
     constructor(applicationDefinition, kuzzleRoutes, pluginsRoutes) {
         /* eslint-disable sort-keys */
         this.kuzzleDefinition = {
-            swagger: '2.0',
+            swagger: "2.0",
             info: {
-                title: 'Kuzzle API',
-                description: 'Kuzzle HTTP API definition',
+                title: "Kuzzle API",
+                description: "Kuzzle HTTP API definition",
                 contact: {
-                    name: 'Kuzzle team',
-                    url: 'https://kuzzle.io',
-                    email: 'support@kuzzle.io',
-                    discord: 'http://join.discord.kuzzle.io'
+                    name: "Kuzzle team",
+                    url: "https://kuzzle.io",
+                    email: "support@kuzzle.io",
+                    discord: "http://join.discord.kuzzle.io",
                 },
                 license: {
-                    name: 'Apache 2',
-                    url: 'http://opensource.org/licenses/apache2.0'
+                    name: "Apache 2",
+                    url: "http://opensource.org/licenses/apache2.0",
                 },
-                version: package_json_1.version
+                version: package_json_1.version,
             },
             externalDocs: {
-                description: 'Kuzzle API Documentation',
-                url: 'https://docs.kuzzle.io/core/2/api/'
+                description: "Kuzzle API Documentation",
+                url: "https://docs.kuzzle.io/core/2/api/",
             },
             servers: [
                 {
-                    url: 'https://{baseUrl}:{port}',
-                    description: 'Kuzzle Base Url',
+                    url: "https://{baseUrl}:{port}",
+                    description: "Kuzzle Base Url",
                     variables: {
-                        baseUrl: { default: 'localhost' },
-                        port: { default: 7512 }
+                        baseUrl: { default: "localhost" },
+                        port: { default: 7512 },
                     },
-                }
+                },
             ],
             tags: [],
-            schemes: ['https', 'http'],
+            schemes: ["https", "http"],
             paths: {},
             components: {
                 ...components_1.OpenApiPayloadsDefinitions,
@@ -83,8 +83,8 @@ class OpenApiManager {
                 security: {
                     ...components_1.OpenApiSecurityUpsertUserComponent,
                     ...components_1.OpenApiDocumentmCreateOrReplaceComponent,
-                }
-            }
+                },
+            },
         };
         this.applicationDefinition = applicationDefinition;
         (0, openApiGenerator_1.generateOpenApi)(kuzzleRoutes, this.kuzzleDefinition);
@@ -92,8 +92,8 @@ class OpenApiManager {
         this.registerAskEvents();
     }
     registerAskEvents() {
-        global.kuzzle.onAsk('core:api:openapi:kuzzle', () => this.kuzzleDefinition);
-        global.kuzzle.onAsk('core:api:openapi:app', () => this.applicationDefinition);
+        global.kuzzle.onAsk("core:api:openapi:kuzzle", () => this.kuzzleDefinition);
+        global.kuzzle.onAsk("core:api:openapi:app", () => this.applicationDefinition);
     }
 }
 exports.OpenApiManager = OpenApiManager;

package/lib/api/openapi/components/document/count.yaml

@@ -44,4 +44,4 @@ components:
               type: "object"
               properties:
                 count:
-                  type: "integer"
+                  type: "integer"

package/lib/api/openapi/components/document/create.yaml

@@ -21,7 +21,7 @@ DocumentCreate:
     200:
       description: "Creates a new document in the persistent data storage."
       schema:
-          $ref: "#/components/document/DocumentCreateResponse"
+        $ref: "#/components/document/DocumentCreateResponse"
 
 components:
   schemas:
@@ -43,4 +43,4 @@ components:
                 _version:
                   type: "integer"
                 _sources:
-                  type: "object"
+                  type: "object"

package/lib/api/openapi/components/document/delete.yaml

@@ -64,4 +64,4 @@ components:
               properties:
                 _id:
                   type: "string"
-                  description: "documentId"
+                  description: "documentId"

package/lib/api/openapi/components/document/deleteByQuery.yaml

@@ -87,4 +87,4 @@ components:
                 ids:
                   type: "array"
                   items:
-                    type: "string"
+                    type: "string"

package/lib/api/openapi/components/document/exists.yaml

@@ -32,4 +32,4 @@ components:
         - type: "object"
           properties:
             result:
-              type: "boolean"
+              type: "boolean"

package/lib/api/openapi/components/document/get.yaml

@@ -22,7 +22,7 @@ DocumentGet:
     200:
       description: "Gets a document."
       schema:
-          $ref: "#/components/document/DocumentGetResponse"
+        $ref: "#/components/document/DocumentGetResponse"
 
 components:
   schemas:
@@ -65,4 +65,4 @@ components:
                         updater:
                           type:
                             - integer
-                            - null
+                            - null

package/lib/api/openapi/components/document/index.js

@@ -4,62 +4,62 @@ exports.OpenApiDocumentmCreateOrReplaceComponent = exports.OpenApiDocumentmCreat
 const readYamlFile_1 = require("../../../../util/readYamlFile");
 // reading the description of the Count action in the controller document.
 // The yaml objects are then stored in the variables below
-const countObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/count.yaml');
+const countObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/count.yaml");
 exports.OpenApiDocumentCount = countObject.DocumentCount;
 exports.OpenApiDocumentCountComponent = countObject.components.schemas;
 // reading the description of the Create action in the controller document.
 // The yaml objects are then stored in the variables below
-const createObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/create.yaml');
+const createObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/create.yaml");
 exports.OpenApiDocumentCreate = createObject.DocumentCreate;
 exports.OpenApiDocumentCreateComponent = createObject.components.schemas;
 // reading the description of the CreateOrReplace action in the controller document.
 // The yaml objects are then stored in the variables below
-const createOrReplaceObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/createOrReplace.yaml');
+const createOrReplaceObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/createOrReplace.yaml");
 exports.OpenApiDocumentCreateOrReplace = createOrReplaceObject.DocumentCreateOrReplace;
 exports.OpenApiDocumentCreateOrReplaceComponent = createOrReplaceObject.components.schemas;
 // reading the description of the Get action in the controller document.
 // The yaml objects are then stored in the variables below
-const getObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/get.yaml');
+const getObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/get.yaml");
 exports.OpenApiDocumentGet = getObject.DocumentGet;
 exports.OpenApiDocumentGetComponent = getObject.components.schemas;
 // reading the description of the Replace action in the controller document.
 // The yaml objects are then stored in the variables below
-const replaceObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/replace.yaml');
+const replaceObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/replace.yaml");
 exports.OpenApiDocumentReplace = replaceObject.DocumentReplace;
 exports.OpenApiDocumentReplaceComponent = replaceObject.components.schemas;
 // reading the description of the Exists action in the controller document.
 // The yaml objects are then stored in the variables below
-const existsObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/exists.yaml');
+const existsObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/exists.yaml");
 exports.OpenApiDocumentExists = existsObject.DocumentExists;
 exports.OpenApiDocumentExistsComponent = existsObject.components.schemas;
 // reading the description of the Update action in the controller document.
 // The yaml objects are then stored in the variables below
-const updateObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/update.yaml');
+const updateObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/update.yaml");
 exports.OpenApiDocumentUpdate = updateObject.DocumentUpdate;
 exports.OpenApiDocumentUpdateComponent = updateObject.components.schemas;
 // reading the description of the Scroll action in the controller document.
 // The yaml objects are then stored in the variables below
-const scrollObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/scroll.yaml');
+const scrollObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/scroll.yaml");
 exports.OpenApiDocumentScroll = scrollObject.DocumentScroll;
 exports.OpenApiDocumentScrollComponent = scrollObject.components.schemas;
 // reading the description of the Delete action in the controller document.
 // The yaml objects are then stored in the variables below
-const deleteObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/delete.yaml');
+const deleteObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/delete.yaml");
 exports.OpenApiDocumentDelete = deleteObject.DocumentDelete;
 exports.OpenApiDocumentDeleteComponent = deleteObject.components.schemas;
 // reading the description of the DeleteByQuery action in the controller document.
 // The yaml objects are then stored in the variables below
-const deleteByQueryObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/deleteByQuery.yaml');
+const deleteByQueryObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/deleteByQuery.yaml");
 exports.OpenApiDocumentDeleteByQuery = deleteByQueryObject.DocumentDeleteByQuery;
 exports.OpenApiDocumentDeleteByQueryComponent = deleteByQueryObject.components.schemas;
 // reading the description of the Validate action in the controller document.
 // The yaml objects are then stored in the variables below
-const validateObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/validate.yaml');
+const validateObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/validate.yaml");
 exports.OpenApiDocumentValidate = validateObject.DocumentValidate;
 exports.OpenApiDocumentValidateComponent = validateObject.components.schemas;
 // reading the description of the mCreateOrReplace action in the controller document.
 // The yaml objects are then stored in the variables below
-const mCreateOrReplaceObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/mCreateOrReplace.yaml');
+const mCreateOrReplaceObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/mCreateOrReplace.yaml");
 exports.OpenApiDocumentmCreateOrReplace = mCreateOrReplaceObject.DocumentmCreateOrReplace;
 exports.OpenApiDocumentmCreateOrReplaceComponent = mCreateOrReplaceObject.components.schemas;
 //# sourceMappingURL=index.js.map

package/lib/api/openapi/components/document/replace.yaml

@@ -63,4 +63,4 @@ components:
                   type: "integer"
                 _sources:
                   type: "object"
-                  description: "new document content"
+                  description: "new document content"

package/lib/api/openapi/components/document/scroll.yaml

@@ -46,4 +46,4 @@ components:
                         type: "integer"
                       _source:
                         type: "object"
-                        description: "document content"
+                        description: "document content"

package/lib/api/openapi/components/document/validate.yaml

@@ -39,4 +39,4 @@ components:
               type: "object"
               properties:
                 valid:
-                  type: "boolean"
+                  type: "boolean"

package/lib/api/openapi/components/index.d.ts

@@ -1,3 +1,3 @@
-export * from './document';
-export * from './security';
+export * from "./document";
+export * from "./security";
 export declare const OpenApiPayloadsDefinitions: any;

package/lib/api/openapi/components/index.js

@@ -19,5 +19,5 @@ const readYamlFile_1 = require("../../../util/readYamlFile");
 __exportStar(require("./document"), exports);
 __exportStar(require("./security"), exports);
 // Document definitions (reusable object for KuzzleRequest and KuzzleResponse)
-exports.OpenApiPayloadsDefinitions = (0, readYamlFile_1.readYamlFile)(__dirname + '/payloads.yaml').definitions;
+exports.OpenApiPayloadsDefinitions = (0, readYamlFile_1.readYamlFile)(__dirname + "/payloads.yaml").definitions;
 //# sourceMappingURL=index.js.map

package/lib/api/openapi/components/security/index.js

@@ -4,7 +4,7 @@ exports.OpenApiSecurityUpsertUserComponent = exports.OpenApiSecurityUpsertUser =
 const readYamlFile_1 = require("../../../../util/readYamlFile");
 // reading the description of the UpsertUser action in the controller security.
 // The yaml objects are then stored in the variables below
-const upsertUserObject = (0, readYamlFile_1.readYamlFile)(__dirname + '/upsertUser.yaml');
+const upsertUserObject = (0, readYamlFile_1.readYamlFile)(__dirname + "/upsertUser.yaml");
 exports.OpenApiSecurityUpsertUser = upsertUserObject.SecurityUpsertUser;
 exports.OpenApiSecurityUpsertUserComponent = upsertUserObject.components.schemas;
 //# sourceMappingURL=index.js.map

package/lib/api/openapi/components/security/upsertUser.yaml

@@ -31,7 +31,7 @@ SecurityUpsertUser:
       description: "Updates or creates a user."
       schema:
         $ref: "#/components/security/SecurityUpsertUserResponse"
-      
+
 components:
   schemas:
     SecurityUpsertUserRequest:
@@ -53,7 +53,6 @@ components:
                   type: "integer"
                 _source:
                   type: "object"
-                  description: " (optional) actualized user content. This property appears only if the \"source\" option is set to true"
+                  description: ' (optional) actualized user content. This property appears only if the "source" option is set to true'
                 created:
                   type: "boolean"
-

package/lib/api/openapi/index.d.ts

@@ -1 +1 @@
-export * from './OpenApiManager';
+export * from "./OpenApiManager";

package/lib/api/openapi/openApiGenerator.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from '../../../index';
+import { JSONObject } from "../../../index";
 /**
  * Generates JSON OpenApi object
  *

package/lib/api/openapi/openApiGenerator.js

@@ -38,7 +38,7 @@ function generateController(route, definition) {
         const capitalizedController = inflector_1.Inflector.pascalCase(route.controller);
         definition.tags.push({
             description: `${capitalizedController} Controller`,
-            name: route.controller
+            name: route.controller,
         });
     }
     if (route.openapi.tags === undefined) {
@@ -69,10 +69,10 @@ function generateParameters(route) {
         while (m !== null) {
             routeUrlMatch.lastIndex++;
             route.openapi.parameters.push({
-                in: 'path',
+                in: "path",
                 name: m[1],
                 required: true,
-                schema: { type: 'string' }
+                schema: { type: "string" },
             });
             m = routeUrlMatch.exec(route.path);
         }
@@ -87,9 +87,9 @@ function generateParameters(route) {
 function generateResponse(route) {
     if (route.openapi.responses === undefined) {
         route.openapi.responses = {
-            '200': {
-                description: 'OK'
-            }
+            "200": {
+                description: "OK",
+            },
         };
     }
 }
@@ -105,7 +105,7 @@ function generateOpenApi(routes, definition) {
             route.verb = route.verb.toLowerCase();
         }
         // Set :param notation to {param}
-        route.formattedPath = route.path.replace(routeUrlMatch, '{$1}');
+        route.formattedPath = route.path.replace(routeUrlMatch, "{$1}");
         if (definition.paths[route.formattedPath] === undefined) {
             definition.paths[route.formattedPath] = {};
         }

package/lib/api/rateLimiter.js

@@ -19,17 +19,17 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
 class RateLimiter {
-  constructor () {
+  constructor() {
     this.loginsPerSecond = global.kuzzle.config.limits.loginsPerSecond;
     this.frame = {};
     this.frameResetTimer = null;
   }
 
-  init () {
-    this.frameResetTimer = setInterval(() => ( this.frame = {} ), 1000);
+  init() {
+    this.frameResetTimer = setInterval(() => (this.frame = {}), 1000);
   }
 
   /**
@@ -42,36 +42,35 @@ class RateLimiter {
    * @param  {Request}  request
    * @returns {Boolean}
    */
-  async isAllowed (request) {
+  async isAllowed(request) {
     const { controller, action } = request.input;
     let count = 0;
     let limit = -1;
 
-    if (controller === 'auth' && action === 'login') {
+    if (controller === "auth" && action === "login") {
       const cid = request.context.connection.id;
 
       count = this.frame[cid] = (this.frame[cid] || 0) + 1;
       limit = this.loginsPerSecond;
-    }
-    else {
+    } else {
       const { _id, profileIds } = request.context.user;
 
       // By definition, auth:logout should be unrestricted
-      if (_id !== '-1' && controller === 'auth' && action === 'logout') {
+      if (_id !== "-1" && controller === "auth" && action === "logout") {
         return true;
       }
 
       const profiles = await global.kuzzle.ask(
-        'core:security:profile:mGet',
-        profileIds);
+        "core:security:profile:mGet",
+        profileIds
+      );
 
       for (let i = 0; i < profiles.length; i++) {
         const { rateLimit = 0 } = profiles[i];
 
         if (limit === 0 || rateLimit === 0) {
           limit = 0;
-        }
-        else {
+        } else {
           limit = Math.max(limit, rateLimit);
         }
       }

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

@@ -1,4 +1,4 @@
-export * from './kuzzleRequest';
-export * from './requestContext';
-export * from './requestInput';
-export * from './requestResponse';
+export * from "./kuzzleRequest";
+export * from "./requestContext";
+export * from "./requestInput";
+export * from "./requestResponse";

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

@@ -1,9 +1,9 @@
-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';
+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";
 /**
  * The `KuzzleRequest` class represents a request being processed by Kuzzle.
  *
@@ -140,7 +140,7 @@ export declare class KuzzleRequest {
      *
      * It can only be 'elasticsearch' or 'koncorde'
      */
-    getLangParam(): 'elasticsearch' | 'koncorde';
+    getLangParam(): "elasticsearch" | "koncorde";
     /**
      * Gets a parameter from a request body and checks that it is a boolean.
      * Contrary to other parameter types, an unset boolean does not trigger an
@@ -358,7 +358,7 @@ export declare class KuzzleRequest {
      *
      */
     getId(options?: {
-        ifMissing?: 'error' | 'generate' | 'ignore';
+        ifMissing?: "error" | "generate" | "ignore";
         generator?: () => string;
     }): string;
     /**
@@ -390,7 +390,7 @@ export declare class KuzzleRequest {
     /**
      * Gets the refresh value.
      */
-    getRefresh(defaultValue?: 'false' | 'wait_for'): 'false' | 'wait_for';
+    getRefresh(defaultValue?: "false" | "wait_for"): "false" | "wait_for";
     /**
      * Returns true if the current user have `admin` profile
      */