kuzzle 2.19.2 → 2.19.5

package/lib/core/backend/backendImport.js

@@ -47,8 +47,8 @@ exports.BackendImport = void 0;
 const kerror = __importStar(require("../../kerror"));
 const index_1 = require("./index");
 const safeObject_1 = require("../../../lib/util/safeObject");
-const assertionError = kerror.wrap('validation', 'assert');
-const runtimeError = kerror.wrap('plugin', 'runtime');
+const assertionError = kerror.wrap("validation", "assert");
+const runtimeError = kerror.wrap("plugin", "runtime");
 class BackendImport extends index_1.ApplicationManager {
     /**
      * Import mappings.
@@ -68,18 +68,17 @@ class BackendImport extends index_1.ApplicationManager {
      */
     mappings(mappings) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'import');
+            throw runtimeError.get("already_started", "import");
         }
         else if (!(0, safeObject_1.isPlainObject)(mappings)) {
-            throw assertionError.get('invalid_type', 'mappings', 'object');
+            throw assertionError.get("invalid_type", "mappings", "object");
         }
         for (const index of Object.keys(mappings)) {
             if (!(0, safeObject_1.isPlainObject)(mappings[index])) {
-                throw assertionError.get('invalid_type', `mappings.${index}`, 'object');
+                throw assertionError.get("invalid_type", `mappings.${index}`, "object");
             }
             // If some collections have already been defined, only their last mappings will be retained
-            this._application._import.mappings[index] =
-                Object.assign({}, this._application._import.mappings[index], mappings[index]);
+            this._application._import.mappings[index] = Object.assign({}, this._application._import.mappings[index], mappings[index]);
         }
     }
     /**
@@ -96,14 +95,13 @@ class BackendImport extends index_1.ApplicationManager {
      */
     profiles(profiles) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'import');
+            throw runtimeError.get("already_started", "import");
         }
         else if (!(0, safeObject_1.isPlainObject)(profiles)) {
-            throw assertionError.get('invalid_type', 'profiles', 'object');
+            throw assertionError.get("invalid_type", "profiles", "object");
         }
         // If some profiles have already been defined, only their last definition will be retained
-        this._application._import.profiles =
-            Object.assign({}, this._application._import.profiles, profiles);
+        this._application._import.profiles = Object.assign({}, this._application._import.profiles, profiles);
     }
     /**
      * Import roles
@@ -119,14 +117,13 @@ class BackendImport extends index_1.ApplicationManager {
      */
     roles(roles) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'import');
+            throw runtimeError.get("already_started", "import");
         }
         else if (!(0, safeObject_1.isPlainObject)(roles)) {
-            throw assertionError.get('invalid_type', 'roles', 'object');
+            throw assertionError.get("invalid_type", "roles", "object");
         }
         // If some roles have already been defined, only their last definition will be retained
-        this._application._import.roles =
-            Object.assign({}, this._application._import.roles, roles);
+        this._application._import.roles = Object.assign({}, this._application._import.roles, roles);
     }
     /**
      * Import user mappings.
@@ -144,10 +141,10 @@ class BackendImport extends index_1.ApplicationManager {
      */
     userMappings(mappings) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'import');
+            throw runtimeError.get("already_started", "import");
         }
         else if (!(0, safeObject_1.isPlainObject)(mappings)) {
-            throw assertionError.get('invalid_type', 'mappings', 'object');
+            throw assertionError.get("invalid_type", "mappings", "object");
         }
         this._application._import.userMappings = mappings;
     }
@@ -165,20 +162,23 @@ class BackendImport extends index_1.ApplicationManager {
      */
     users(users, options = {}) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'import');
+            throw runtimeError.get("already_started", "import");
         }
         else if (!(0, safeObject_1.isPlainObject)(users)) {
-            throw assertionError.get('invalid_type', 'users', 'object');
+            throw assertionError.get("invalid_type", "users", "object");
         }
         else if (options.onExistingUsers) {
-            if (!(options.onExistingUsers === 'overwrite' || options.onExistingUsers === 'skip')) {
-                throw assertionError.get('invalid_type', 'onExistingUsers', ['overwrite', 'skip']);
+            if (!(options.onExistingUsers === "overwrite" ||
+                options.onExistingUsers === "skip")) {
+                throw assertionError.get("invalid_type", "onExistingUsers", [
+                    "overwrite",
+                    "skip",
+                ]);
             }
             this._application._import.onExistingUsers = options.onExistingUsers;
         }
         // If some users have already been defined (before startup), only their last definition will be retained
-        this._application._import.users =
-            Object.assign({}, this._application._import.users, users);
+        this._application._import.users = Object.assign({}, this._application._import.users, users);
     }
 }
 exports.BackendImport = BackendImport;

package/lib/core/backend/backendOpenApi.d.ts

@@ -1,5 +1,5 @@
-import { ApplicationManager, Backend } from './index';
-import { OpenApiDefinition } from '../../types';
+import { ApplicationManager, Backend } from "./index";
+import { OpenApiDefinition } from "../../types";
 export declare class BackendOpenApi extends ApplicationManager {
     /**
      * Application Open API definition

package/lib/core/backend/backendOpenApi.js

@@ -27,40 +27,40 @@ class BackendOpenApi extends index_1.ApplicationManager {
         super(application);
         /* eslint-disable sort-keys */
         this.definition = {
-            openapi: '3.0.0',
+            openapi: "3.0.0",
             info: {
                 title: `${application.name} API`,
                 description: `${application.name} 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: application.version
+                version: application.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}',
+                    url: "https://{baseUrl}:{port}",
                     description: `${application.name} Base Url`,
                     variables: {
-                        baseUrl: { default: 'localhost' },
+                        baseUrl: { default: "localhost" },
                         port: { default: 7512 },
-                    }
-                }
+                    },
+                },
             ],
             tags: [],
-            schemes: ['https', 'http'],
+            schemes: ["https", "http"],
             paths: {},
-            components: {}
+            components: {},
         };
         /* eslint-enable sort-keys */
     }

package/lib/core/backend/backendPipe.d.ts

@@ -1,5 +1,5 @@
-import { EventHandler } from '../../types';
-import { ApplicationManager } from './index';
+import { EventDefinition, PipeEventHandler } from "../../types";
+import { ApplicationManager } from "./index";
 export declare class BackendPipe extends ApplicationManager {
     /**
      * Registers a new pipe on an event
@@ -7,6 +7,6 @@ export declare class BackendPipe extends ApplicationManager {
      * @param event - Event name
      * @param handler - Function to execute when the event is triggered
      */
-    register(event: string, handler: EventHandler, options?: any): string | void;
+    register<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], handler: PipeEventHandler<TEventDefinition>, options?: any): string | void;
     unregister(pipeId: string): void;
 }

package/lib/core/backend/backendPipe.js

@@ -46,8 +46,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BackendPipe = void 0;
 const kerror = __importStar(require("../../kerror"));
 const index_1 = require("./index");
-const assertionError = kerror.wrap('plugin', 'assert');
-const runtimeError = kerror.wrap('plugin', 'runtime');
+const assertionError = kerror.wrap("plugin", "assert");
+const runtimeError = kerror.wrap("plugin", "runtime");
 class BackendPipe extends index_1.ApplicationManager {
     /**
      * Registers a new pipe on an event
@@ -57,10 +57,10 @@ class BackendPipe extends index_1.ApplicationManager {
      */
     register(event, handler, options = {}) {
         if (this._application.started && options.dynamic !== true) {
-            throw runtimeError.get('already_started', 'pipe.register');
+            throw runtimeError.get("already_started", "pipe.register");
         }
-        if (typeof handler !== 'function') {
-            throw assertionError.get('invalid_pipe', event);
+        if (typeof handler !== "function") {
+            throw assertionError.get("invalid_pipe", event);
         }
         if (this._application.started) {
             return global.kuzzle.pluginsManager.registerPipe(global.kuzzle.pluginsManager.application, event, handler);
@@ -72,7 +72,7 @@ class BackendPipe extends index_1.ApplicationManager {
     }
     unregister(pipeId) {
         if (!this._application.started) {
-            throw runtimeError.get('unavailable_before_start', 'pipe.unregister');
+            throw runtimeError.get("unavailable_before_start", "pipe.unregister");
         }
         global.kuzzle.pluginsManager.unregisterPipe(pipeId);
     }

package/lib/core/backend/backendPlugin.d.ts

@@ -1,6 +1,6 @@
-import { JSONObject } from '../../../index';
-import { Plugin } from '../../types';
-import { ApplicationManager } from './index';
+import { JSONObject } from "../../../index";
+import { Plugin } from "../../types";
+import { ApplicationManager } from "./index";
 export declare class BackendPlugin extends ApplicationManager {
     /**
      * Uses a plugin in this application.
@@ -24,7 +24,7 @@ export declare class BackendPlugin extends ApplicationManager {
      *
      * @param name Plugin name
      */
-    get(name: string): Plugin;
+    get<TPlugin extends Plugin>(name: string): TPlugin;
     /**
      * Lists loaded plugins
      */

package/lib/core/backend/backendPlugin.js

@@ -51,8 +51,8 @@ const inflector_1 = require("../../util/inflector");
 const kerror = __importStar(require("../../kerror"));
 const index_1 = require("./index");
 const didYouMean_1 = __importDefault(require("../../util/didYouMean"));
-const assertionError = kerror.wrap('plugin', 'assert');
-const runtimeError = kerror.wrap('plugin', 'runtime');
+const assertionError = kerror.wrap("plugin", "assert");
+const runtimeError = kerror.wrap("plugin", "runtime");
 class BackendPlugin extends index_1.ApplicationManager {
     /**
      * Uses a plugin in this application.
@@ -68,24 +68,24 @@ class BackendPlugin extends index_1.ApplicationManager {
      */
     use(plugin, options = {}) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'plugin');
+            throw runtimeError.get("already_started", "plugin");
         }
         // Avoid plain objects
-        if ((typeof plugin.constructor !== 'function'
-            || plugin.constructor.name === 'Object')
-            && !options.name) {
-            throw assertionError.get('no_name_provided');
+        if ((typeof plugin.constructor !== "function" ||
+            plugin.constructor.name === "Object") &&
+            !options.name) {
+            throw assertionError.get("no_name_provided");
         }
-        const name = options.name
-            || inflector_1.Inflector.kebabCase(plugin.constructor.name.replace('Plugin', ''));
+        const name = options.name ||
+            inflector_1.Inflector.kebabCase(plugin.constructor.name.replace("Plugin", ""));
         if (!this._application.PluginObject.checkName(name)) {
-            throw assertionError.get('invalid_plugin_name', name);
+            throw assertionError.get("invalid_plugin_name", name);
         }
         if (this._application._plugins[name]) {
-            throw assertionError.get('name_already_exists', name);
+            throw assertionError.get("name_already_exists", name);
         }
-        if (typeof plugin.init !== 'function') {
-            throw assertionError.get('init_not_found', name);
+        if (typeof plugin.init !== "function") {
+            throw assertionError.get("init_not_found", name);
         }
         this._application._plugins[name] = { options, plugin };
     }
@@ -96,7 +96,7 @@ class BackendPlugin extends index_1.ApplicationManager {
      */
     get(name) {
         if (!this._application._plugins[name]) {
-            throw assertionError.get('plugin_not_found', name, (0, didYouMean_1.default)(name, this.list()));
+            throw assertionError.get("plugin_not_found", name, (0, didYouMean_1.default)(name, this.list()));
         }
         return this._application._plugins[name].plugin;
     }

package/lib/core/backend/backendStorage.d.ts

@@ -1,5 +1,5 @@
-import { Client } from '@elastic/elasticsearch';
-import { ApplicationManager, Backend } from './index';
+import { Client } from "@elastic/elasticsearch";
+import { ApplicationManager, Backend } from "./index";
 export declare class BackendStorage extends ApplicationManager {
     private _client;
     private _Client;

package/lib/core/backend/backendStorage.js

@@ -56,8 +56,7 @@ class BackendStorage extends index_1.ApplicationManager {
      */
     get storageClient() {
         if (!this._client) {
-            this._client = elasticsearch_1.default
-                .buildClient(this._kuzzle.config.services.storageEngine.client);
+            this._client = elasticsearch_1.default.buildClient(this._kuzzle.config.services.storageEngine.client);
         }
         return this._client;
     }

package/lib/core/backend/backendVault.d.ts

@@ -1,5 +1,5 @@
-import { JSONObject } from '../../../index';
-import { ApplicationManager } from './index';
+import { JSONObject } from "../../../index";
+import { ApplicationManager } from "./index";
 export declare class BackendVault extends ApplicationManager {
     private decrypted;
     private _secrets;

package/lib/core/backend/backendVault.js

@@ -50,7 +50,7 @@ exports.BackendVault = void 0;
 const vault_1 = __importDefault(require("../../kuzzle/vault"));
 const kerror = __importStar(require("../../kerror"));
 const index_1 = require("./index");
-const runtimeError = kerror.wrap('plugin', 'runtime');
+const runtimeError = kerror.wrap("plugin", "runtime");
 class BackendVault extends index_1.ApplicationManager {
     constructor() {
         super(...arguments);
@@ -61,7 +61,7 @@ class BackendVault extends index_1.ApplicationManager {
      */
     set key(key) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'vault');
+            throw runtimeError.get("already_started", "vault");
         }
         this._application._vaultKey = key;
     }
@@ -70,7 +70,7 @@ class BackendVault extends index_1.ApplicationManager {
      */
     set file(file) {
         if (this._application.started) {
-            throw runtimeError.get('already_started', 'vault');
+            throw runtimeError.get("already_started", "vault");
         }
         this._application._secretsFile = file;
     }

package/lib/core/backend/index.d.ts

@@ -1,14 +1,14 @@
-export * from './applicationManager';
-export * from './backend';
-export * from './backendCluster';
-export * from './backendConfig';
-export * from './backendController';
-export * from './backendHook';
-export * from './backendImport';
-export * from './backendPipe';
-export * from './backendPlugin';
-export * from './backendStorage';
-export * from './backendVault';
-export * from './backendOpenApi';
-export * from './internalLogger';
-export * from './backendErrors';
+export * from "./applicationManager";
+export * from "./backend";
+export * from "./backendCluster";
+export * from "./backendConfig";
+export * from "./backendController";
+export * from "./backendHook";
+export * from "./backendImport";
+export * from "./backendPipe";
+export * from "./backendPlugin";
+export * from "./backendStorage";
+export * from "./backendVault";
+export * from "./backendOpenApi";
+export * from "./internalLogger";
+export * from "./backendErrors";

package/lib/core/backend/internalLogger.d.ts

@@ -1,4 +1,4 @@
-import { ApplicationManager } from './index';
+import { ApplicationManager } from "./index";
 export declare class InternalLogger extends ApplicationManager {
     /**
      * Logs an debug message

package/lib/core/backend/internalLogger.js

@@ -31,31 +31,31 @@ class InternalLogger extends index_1.ApplicationManager {
      * Logs an debug message
      */
     debug(message) {
-        this._log('debug', message);
+        this._log("debug", message);
     }
     /**
      * Logs an info message
      */
     info(message) {
-        this._log('info', message);
+        this._log("info", message);
     }
     /**
      * Logs a warn message
      */
     warn(message) {
-        this._log('warn', message);
+        this._log("warn", message);
     }
     /**
      * Logs an error message
      */
     error(message) {
-        this._log('error', message);
+        this._log("error", message);
     }
     /**
      * Logs a verbose message
      */
     verbose(message) {
-        this._log('verbose', message);
+        this._log("verbose", message);
     }
     _log(level, message) {
         if (!this._application.started) {

package/lib/core/cache/cacheDbEnum.js

@@ -19,7 +19,7 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
 /**
  * @typedef {string} cacheDbEnum
@@ -32,9 +32,9 @@
  * @enum {cacheDbEnum}
  */
 const cacheDbEnum = Object.freeze({
-  INTERNAL: 'internal',
-  NONE: 'none',
-  PUBLIC: 'public',
+  INTERNAL: "internal",
+  NONE: "none",
+  PUBLIC: "public",
 });
 
 module.exports = cacheDbEnum;