kuzzle 2.19.3 → 2.19.4

package/lib/api/request/kuzzleRequest.js

@@ -51,7 +51,6 @@ const safeObject_1 = require("../../util/safeObject");
 const lodash_1 = require("lodash");
 const moment_1 = __importDefault(require("moment"));
 const uuid = __importStar(require("uuid"));
-const nanoid_1 = require("nanoid");
 const requestInput_1 = require("./requestInput");
 const requestResponse_1 = require("./requestResponse");
 const requestContext_1 = require("./requestContext");
@@ -80,7 +79,7 @@ const _deprecations = "deprecations\u200b";
  */
 class KuzzleRequest {
     constructor(data, options) {
-        this[_internalId] = (0, nanoid_1.nanoid)();
+        this[_internalId] = uuid.v4();
         this[_status] = 102;
         this[_input] = new requestInput_1.RequestInput(data);
         this[_context] = new requestContext_1.RequestContext(options);
@@ -93,7 +92,7 @@ class KuzzleRequest {
         this[_input].headers = this[_context].connection.misc.headers;
         this.id = data.requestId
             ? assert.assertString("requestId", data.requestId)
-            : (0, nanoid_1.nanoid)();
+            : uuid.v4();
         this[_timestamp] = data.timestamp || Date.now();
         // handling provided options
         if (options !== undefined && options !== null) {

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

@@ -1,5 +1,5 @@
 import { EmbeddedSDK } from "../shared/sdk/embeddedSdk";
-import { JSONObject } from "../../../index";
+import { EventDefinition, JSONObject } from "../../../index";
 import { BackendCluster, BackendConfig, BackendController, BackendHook, BackendImport, BackendPipe, BackendPlugin, BackendStorage, BackendVault, BackendOpenApi, InternalLogger, BackendErrors } from "./index";
 export declare class Backend {
     private _kuzzle;
@@ -149,7 +149,7 @@ export declare class Backend {
      *
      * @returns {Promise<any>}
      */
-    trigger(event: string, ...payload: any[]): Promise<any>;
+    trigger<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], ...payload: TEventDefinition["args"]): Promise<TEventDefinition["args"][0]>;
     /**
      * Register a method that will be executed only once on any given environment.
      * If this method throws, the app won't start.

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

@@ -1,5 +1,4 @@
-import { JSONObject } from "../../../index";
-import { EventHandler } from "../../types";
+import { EventDefinition, ClusterEventHandler } from "../../../index";
 export declare class BackendCluster {
     /**
      * Broadcasts an event to listeners across all registered Kuzzle nodes
@@ -8,34 +7,34 @@ export declare class BackendCluster {
      * @param  {JSONObject}    payload
      * @return {Promise<void>}
      */
-    broadcast(event: string, payload: JSONObject): Promise<void>;
+    broadcast<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], payload: TEventDefinition["args"][0]): Promise<void>;
     /**
      * Registers a listener to the provided event name.
      *
      * @param  {string}        event
-     * @param  {EventHandler}      listener
+     * @param  {ClusterEventHandler}      listener
      * @return {Promise<void>}       [description]
      */
-    on(event: string, listener: EventHandler): Promise<void>;
+    on<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], listener: ClusterEventHandler<TEventDefinition>): Promise<void>;
     /**
      * Registers a listener to the provided event name. This listener can be
      * invoked only once, after which it will be removed from the listeners list.
      *
      * @param  {string}        event
-     * @param  {EventHandler}      listener
+     * @param  {ClusterEventHandler}      listener
      * @return {Promise<void>}
      */
-    once(event: string, listener: EventHandler): Promise<void>;
+    once<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], listener: ClusterEventHandler<TEventDefinition>): Promise<void>;
     /**
      * Removes a listener from an event.
      * If multiple instances of the same listener are registered, only the first
      * one is removed.
      *
      * @param  {string}        event
-     * @param  {EventHandler}      listener
+     * @param  {ClusterEventHandler}      listener
      * @return {Promise<void>}
      */
-    off(event: string, listener: EventHandler): Promise<void>;
+    off<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], listener: ClusterEventHandler<TEventDefinition>): Promise<void>;
     /**
      * Removes all listeners from an event.
      *

package/lib/core/backend/backendCluster.js

@@ -36,7 +36,7 @@ class BackendCluster {
      * Registers a listener to the provided event name.
      *
      * @param  {string}        event
-     * @param  {EventHandler}      listener
+     * @param  {ClusterEventHandler}      listener
      * @return {Promise<void>}       [description]
      */
     async on(event, listener) {
@@ -47,7 +47,7 @@ class BackendCluster {
      * invoked only once, after which it will be removed from the listeners list.
      *
      * @param  {string}        event
-     * @param  {EventHandler}      listener
+     * @param  {ClusterEventHandler}      listener
      * @return {Promise<void>}
      */
     async once(event, listener) {
@@ -59,7 +59,7 @@ class BackendCluster {
      * one is removed.
      *
      * @param  {string}        event
-     * @param  {EventHandler}      listener
+     * @param  {ClusterEventHandler}      listener
      * @return {Promise<void>}
      */
     async off(event, listener) {

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

@@ -1,4 +1,4 @@
-import { EventHandler } from "../../types";
+import { HookEventHandler, EventDefinition } from "../../types";
 import { ApplicationManager } from "./index";
 export declare class BackendHook extends ApplicationManager {
     /**
@@ -8,5 +8,5 @@ export declare class BackendHook extends ApplicationManager {
      * @param handler - Function to execute when the event is triggered
      *
      */
-    register(event: string, handler: EventHandler): void;
+    register<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], handler: HookEventHandler<TEventDefinition>): void;
 }

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

@@ -1,4 +1,4 @@
-import { EventHandler } from "../../types";
+import { EventDefinition, PipeEventHandler } from "../../types";
 import { ApplicationManager } from "./index";
 export declare class BackendPipe extends ApplicationManager {
     /**
@@ -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/kuzzle/event/pipeRunner.js

@@ -37,7 +37,7 @@ const kerror = require("../../kerror").wrap("plugin", "runtime");
  * { instance: (pipeRunner instance), callback: (callback after pipes execution) }
  */
 /* eslint-disable no-invalid-this */
-function waterfallCallback(error, result) {
+function waterfallCallback(error, ...result) {
   this.instance.running--;
 
   if (!this.instance.buffer.isEmpty()) {
@@ -52,7 +52,7 @@ function waterfallCallback(error, result) {
 
     this.callback.call(this.callbackContext, cbError);
   } else {
-    this.callback.call(this.callbackContext, null, result);
+    this.callback.call(this.callbackContext, null, ...result);
   }
 }
 /* eslint-enable no-invalid-this */

package/lib/types/DebugModule.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import EventEmitter from "events";
 import Inspector from "inspector";
 export declare type DebugModuleOptions = {

package/lib/types/EventHandler.d.ts

@@ -1,4 +1,30 @@
 /**
- * Type for handler attached to Kuzzle events. Either hooks or pipes.
+ * Describe an event with it's name and the handler function arguments
  */
-export declare type EventHandler = (...payload: any) => any;
+export declare type EventDefinition = {
+    /**
+     * Name of the event
+     *
+     * @example
+     * "core:document:create:after"
+     */
+    name: string;
+    /**
+     * Arguments of the event
+     */
+    args: any[];
+};
+/**
+ * Handler for hook events
+ */
+export declare type HookEventHandler<TEventDefinition extends EventDefinition = EventDefinition> = (...args: TEventDefinition["args"]) => void;
+/**
+ * Handler for pipe event.
+ *
+ * It should return a promise resolving the first received argument.
+ */
+export declare type PipeEventHandler<TEventDefinition extends EventDefinition = EventDefinition> = (...args: TEventDefinition["args"]) => Promise<TEventDefinition["args"][0]>;
+/**
+ * Handler for cluster event.
+ */
+export declare type ClusterEventHandler<TEventDefinition extends EventDefinition = EventDefinition> = (...args: TEventDefinition["args"]) => any;

package/lib/types/Plugin.d.ts

@@ -2,7 +2,7 @@ import { PluginContext } from "../core/plugin/pluginContext";
 import { ControllerDefinition } from "./ControllerDefinition";
 import { PluginManifest } from "./PluginManifest";
 import { StrategyDefinition } from "./StrategyDefinition";
-import { EventHandler } from "./EventHandler";
+import { PipeEventHandler, HookEventHandler } from "./EventHandler";
 import { JSONObject } from "../../index";
 /**
  * Allows to define plugins controllers and actions
@@ -20,7 +20,7 @@ export declare type PluginHookDefinition = {
     /**
      * Event name or wildcard event.
      */
-    [event: string]: EventHandler | EventHandler[];
+    [event: string]: HookEventHandler | HookEventHandler[];
 };
 /**
  * Allows to define pipes on events
@@ -29,7 +29,7 @@ export declare type PluginPipeDefinition = {
     /**
      * Event name or wildcard event.
      */
-    [event: string]: EventHandler | EventHandler[];
+    [event: string]: PipeEventHandler | PipeEventHandler[];
 };
 /**
  * Plugins must implements this abstract class.

package/lib/types/events/EventGenericDocument.d.ts

@@ -0,0 +1,26 @@
+import { KuzzleRequest, KDocument, JSONObject } from "../../../";
+/**
+ * Events with documents only having the `_id`
+ */
+declare type EventGenericDocumentPartial<name extends string> = {
+    name: `generic:document:${name}`;
+    args: [Array<{
+        _id: string;
+    }>, KuzzleRequest];
+};
+export declare type EventGenericDocumentBeforeDelete = EventGenericDocumentPartial<"beforeDelete">;
+export declare type EventGenericDocumentAfterDelete = EventGenericDocumentPartial<"afterDelete">;
+export declare type EventGenericDocumentBeforeGet = EventGenericDocumentPartial<"beforeGet">;
+/**
+ * Events having entire documents
+ */
+declare type EventGenericDocument<name extends string, KDocumentContent> = {
+    name: `generic:document:${name}`;
+    args: [KDocument<KDocumentContent>[], KuzzleRequest];
+};
+export declare type EventGenericDocumentBeforeWrite<KDocumentContent = JSONObject> = EventGenericDocument<"beforeWrite", KDocumentContent>;
+export declare type EventGenericDocumentAfterWrite<KDocumentContent = JSONObject> = EventGenericDocument<"afterWrite", KDocumentContent>;
+export declare type EventGenericDocumentBeforeUpdate<KDocumentContent = JSONObject> = EventGenericDocument<"beforeUpdate", KDocumentContent>;
+export declare type EventGenericDocumentAfterUpdate<KDocumentContent = JSONObject> = EventGenericDocument<"afterUpdate", KDocumentContent>;
+export declare type EventGenericDocumentAfterGet<KDocumentContent = JSONObject> = EventGenericDocument<"afterGet", KDocumentContent>;
+export {};

package/lib/types/events/EventGenericDocument.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=EventGenericDocument.js.map

package/lib/types/index.d.ts

@@ -36,3 +36,4 @@ export * from "./config/DumpConfiguration";
 export * from "./OpenApiDefinition";
 export * from "./errors/ErrorDefinition";
 export * from "./errors/ErrorDomains";
+export * from "./events/EventGenericDocument";

package/lib/types/index.js

@@ -72,4 +72,5 @@ __exportStar(require("./config/DumpConfiguration"), exports);
 __exportStar(require("./OpenApiDefinition"), exports);
 __exportStar(require("./errors/ErrorDefinition"), exports);
 __exportStar(require("./errors/ErrorDomains"), exports);
+__exportStar(require("./events/EventGenericDocument"), exports);
 //# sourceMappingURL=index.js.map

package/lib/util/bufferedPassThrough.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import stream from "stream";
 declare type Encoding = BufferEncoding | "buffer";
 declare type ChunkData = Buffer | string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.19.3",
+  "version": "2.19.4",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": "bin/start-kuzzle-server",
   "scripts": {
@@ -44,46 +44,45 @@
     "@types/js-yaml": "^4.0.5",
     "aedes": "^0.46.3",
     "bluebird": "^3.7.2",
-    "cli-color": "^2.0.2",
+    "cli-color": "^2.0.3",
     "cookie": "^0.5.0",
     "debug": "^4.3.4",
-    "denque": "^2.0.1",
+    "denque": "^2.1.0",
     "didyoumean": "^1.2.2",
     "dumpme": "^1.0.3",
     "eventemitter3": "^4.0.7",
-    "inquirer": "^8.2.2",
-    "ioredis": "^5.0.4",
+    "inquirer": "^9.1.1",
+    "ioredis": "^5.2.3",
     "js-yaml": "^4.1.0",
     "json-stable-stringify": "^1.0.1",
     "json2yaml": "^1.1.0",
     "jsonwebtoken": "^8.5.1",
-    "koncorde": "^4.0.2",
+    "koncorde": "^4.0.3",
     "kuzzle-plugin-auth-passport-local": "^6.3.6",
     "kuzzle-plugin-logger": "^3.0.3",
-    "kuzzle-sdk": "^7.10.0",
+    "kuzzle-sdk": "^7.10.1",
     "kuzzle-vault": "^2.0.4",
     "lodash": "4.17.21",
     "long": "^5.2.0",
-    "moment": "^2.29.3",
+    "moment": "^2.29.4",
     "ms": "^2.1.3",
     "murmurhash-native": "^3.5.0",
-    "nanoid": "^3.3.3",
     "ndjson": "^2.0.0",
-    "node-segfault-handler": "^1.0.4",
-    "passport": "^0.5.2",
+    "node-segfault-handler": "^1.1.0",
+    "passport": "^0.6.0",
     "prettier": "^2.7.1",
-    "protobufjs": "~6.11.2",
+    "protobufjs": "~7.1.0",
     "rc": "1.2.8",
     "semver": "^7.3.7",
     "sorted-array": "^2.0.4",
     "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.0.0.tar.gz",
-    "uuid": "^8.3.2",
+    "uuid": "^9.0.0",
     "validator": "^13.7.0",
-    "winston": "^3.7.2",
-    "winston-elasticsearch": "0.16.1",
-    "winston-syslog": "^2.5.0",
+    "winston": "^3.8.1",
+    "winston-elasticsearch": "0.17.1",
+    "winston-syslog": "^2.6.0",
     "winston-transport": "^4.5.0",
-    "yargs": "^17.4.1",
+    "yargs": "^17.5.1",
     "zeromq": "^6.0.0-beta.6"
   },
   "repository": {
@@ -91,16 +90,16 @@
     "url": "git://github.com/kuzzleio/kuzzle.git"
   },
   "devDependencies": {
-    "@types/lodash": "^4.14.182",
-    "@typescript-eslint/eslint-plugin": "^5.20.0",
-    "@typescript-eslint/parser": "^5.20.0",
-    "async": "^3.2.3",
+    "@types/lodash": "^4.14.184",
+    "@typescript-eslint/eslint-plugin": "^5.36.2",
+    "@typescript-eslint/parser": "^5.36.2",
+    "async": "^3.2.4",
     "chokidar": "^3.5.3",
     "codecov": "^3.8.3",
     "cucumber": "^6.0.5",
     "ergol": "^1.0.2",
-    "eslint": "^8.13.0",
-    "eslint-plugin-kuzzle": "0.0.1",
+    "eslint": "^8.23.0",
+    "eslint-plugin-kuzzle": "0.0.5",
     "mocha": "^9.2.2",
     "mock-require": "^3.0.3",
     "mqtt": "^4.3.7",
@@ -112,9 +111,9 @@
     "should-sinon": "0.0.6",
     "sinon": "^13.0.2",
     "strip-json-comments": "https://github.com/sindresorhus/strip-json-comments/archive/refs/tags/v3.1.1.tar.gz",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.6.3",
-    "yaml": "^2.0.1"
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.2",
+    "yaml": "^2.1.1"
   },
   "engines": {
     "node": ">= 12.13.0"