kuzzle 2.19.4 → 2.19.6

package/README.md

@@ -37,9 +37,9 @@ Learn how Kuzzle will accelerate your developments :point_right: https://docs.ku
 
 ## Kuzzle in production
 
-Kuzzle is production-proof, and can be [deployed anywhere](https://kuzzle.io/products/by-features/on-premises/). 
+Kuzzle is production-proof, and can be [deployed anywhere](https://kuzzle.io/products/by-features/on-premises/).
 
-With Kuzzle, it is possible to deploy applications that can serve tens of thousands of users with very good performances.  
+With Kuzzle, it is possible to deploy applications that can serve tens of thousands of users with very good performances.
 
 Check out our [support plans](https://kuzzle.io/pricing/).
 
@@ -51,7 +51,7 @@ The easiest way to start a Kuzzle application is to use [Kourou](https://github.
 npx kourou app:scaffold playground
 
  🚀 Kourou - Scaffolds a new Kuzzle application
- 
+
   ✔ Creating playground/ directory
   ✔ Creating and rendering application files
   ✔ Installing latest Kuzzle version via NPM and Docker (this can take some time)
@@ -78,7 +78,7 @@ const app = new Backend('playground');
 app.controller.register('greeting', {
   actions: {
     sayHello: {
-      handler: async request => `Hello, ${request.input.args.name}` 
+      handler: async request => `Hello, ${request.input.args.name}`
     }
   }
 });
@@ -110,13 +110,13 @@ Learn how to [Write an Application](https://docs.kuzzle.io/core/2/guides/getting
 
 ## Get trained by the creators of Kuzzle :zap:
 
-Train yourself and your teams to use Kuzzle to maximize its potential and accelerate the development of your projects.  
-Our teams will be able to meet your needs in terms of expertise and multi-technology support for IoT, mobile/web, backend/frontend, devops.  
+Train yourself and your teams to use Kuzzle to maximize its potential and accelerate the development of your projects.
+Our teams will be able to meet your needs in terms of expertise and multi-technology support for IoT, mobile/web, backend/frontend, devops.
 :point_right: [Get a quote](https://hubs.ly/H0jkfJ_0)
 
 ## Public Roadmap
 
-You can consult the public roadmap on Trello. Come and vote for the features you need!  
+You can consult the public roadmap on Trello. Come and vote for the features you need!
 :point_right: [Kuzzle Public Roadmap](https://trello.com/b/za9vOgRh/kuzzle-public-roadmap)
 
 ## Contributing to Kuzzle
@@ -149,3 +149,4 @@ npm run docker:install
 ```
 
 finally run the command `docker-compose up` to launch your kuzzle stack.
+

package/lib/core/shared/sdk/embeddedSdk.d.ts

@@ -1,5 +1,4 @@
-import { RealtimeController, Notification, JSONObject, ScopeOption, UserOption, Kuzzle, RequestPayload } from "kuzzle-sdk";
-import { ResponsePayload } from "../../../types";
+import { RealtimeController, Notification, JSONObject, ScopeOption, UserOption, Kuzzle, ResponsePayload, BaseRequest } from "kuzzle-sdk";
 interface EmbeddedRealtime extends RealtimeController {
     /**
      * Subscribes by providing a set of filters: messages, document changes
@@ -70,8 +69,8 @@ export declare class EmbeddedSDK extends Kuzzle {
      * @param request - API request (https://docs.kuzzle.io/core/2/guides/main-concepts/1-api#other-protocols)
      * @param options - Optional arguments
      */
-    query(request: RequestPayload, options?: {
+    query<TRequest extends BaseRequest, TResult>(request: TRequest, options?: {
         propagate?: boolean;
-    }): Promise<ResponsePayload>;
+    }): Promise<ResponsePayload<TResult>>;
 }
 export {};

package/lib/core/shared/sdk/embeddedSdk.js

@@ -112,6 +112,7 @@ class EmbeddedSDK extends kuzzle_sdk_1.Kuzzle {
         if ((0, safeObject_1.isPlainObject)(request) &&
             request.controller === "realtime" &&
             request.action === "subscribe") {
+            // @ts-expect-error
             request.propagate =
                 options.propagate === undefined || options.propagate === null
                     ? false

package/lib/types/EventHandler.d.ts

@@ -28,3 +28,7 @@ export declare type PipeEventHandler<TEventDefinition extends EventDefinition =
  * Handler for cluster event.
  */
 export declare type ClusterEventHandler<TEventDefinition extends EventDefinition = EventDefinition> = (...args: TEventDefinition["args"]) => any;
+/**
+ * @deprecated Use HookEventHandler, PipeEventHandler or ClusterEventHandler
+ */
+export declare type EventHandler = (...payload: any) => any;

package/lib/types/index.d.ts

@@ -2,7 +2,6 @@ export * from "./Plugin";
 export * from "./Controller";
 export * from "./ControllerDefinition";
 export * from "./ControllerRights";
-export * from "./ResponsePayload";
 export * from "./Deprecation";
 export * from "./EventHandler";
 export * from "./Policy";

package/lib/types/index.js

@@ -38,7 +38,6 @@ __exportStar(require("./Plugin"), exports);
 __exportStar(require("./Controller"), exports);
 __exportStar(require("./ControllerDefinition"), exports);
 __exportStar(require("./ControllerRights"), exports);
-__exportStar(require("./ResponsePayload"), exports);
 __exportStar(require("./Deprecation"), exports);
 __exportStar(require("./EventHandler"), exports);
 __exportStar(require("./Policy"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.19.4",
+  "version": "2.19.6",
   "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": {
@@ -41,7 +41,6 @@
   },
   "dependencies": {
     "@elastic/elasticsearch": "https://github.com/elastic/elasticsearch-js/archive/refs/tags/v7.13.0.tar.gz",
-    "@types/js-yaml": "^4.0.5",
     "aedes": "^0.46.3",
     "bluebird": "^3.7.2",
     "cli-color": "^2.0.3",
@@ -50,6 +49,7 @@
     "denque": "^2.1.0",
     "didyoumean": "^1.2.2",
     "dumpme": "^1.0.3",
+    "eslint-plugin-kuzzle": "^0.0.6",
     "eventemitter3": "^4.0.7",
     "inquirer": "^9.1.1",
     "ioredis": "^5.2.3",
@@ -60,7 +60,7 @@
     "koncorde": "^4.0.3",
     "kuzzle-plugin-auth-passport-local": "^6.3.6",
     "kuzzle-plugin-logger": "^3.0.3",
-    "kuzzle-sdk": "^7.10.1",
+    "kuzzle-sdk": "^7.10.3",
     "kuzzle-vault": "^2.0.4",
     "lodash": "4.17.21",
     "long": "^5.2.0",
@@ -70,13 +70,12 @@
     "ndjson": "^2.0.0",
     "node-segfault-handler": "^1.1.0",
     "passport": "^0.6.0",
-    "prettier": "^2.7.1",
     "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": "^9.0.0",
+    "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.0.0.tar.gz",
     "validator": "^13.7.0",
     "winston": "^3.8.1",
     "winston-elasticsearch": "0.17.1",
@@ -90,16 +89,13 @@
     "url": "git://github.com/kuzzleio/kuzzle.git"
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.5",
     "@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.23.0",
-    "eslint-plugin-kuzzle": "0.0.5",
     "mocha": "^9.2.2",
     "mock-require": "^3.0.3",
     "mqtt": "^4.3.7",

package/lib/types/RequestPayload.d.ts

@@ -1,45 +0,0 @@
-import { JSONObject } from "../../index";
-/**
- * Kuzzle API request payload
- *
- * @see https://docs.kuzzle.io/core/2/api/payloads/request
- */
-export declare type RequestPayload = {
-    /**
-     * API controller name
-     */
-    controller: string;
-    /**
-     * API action name
-     */
-    action: string;
-    /**
-     * Index name
-     */
-    index?: string;
-    /**
-     * Collection name
-     */
-    collection?: string;
-    /**
-     * Document unique identifier
-     */
-    _id?: string;
-    /**
-     * Authentication token
-     */
-    jwt?: string;
-    /**
-     * Volatile data
-     */
-    volatile?: JSONObject;
-    /**
-     * Request body
-     */
-    body?: JSONObject;
-    /**
-     * Request unique identifier
-     */
-    requestId?: string;
-    [key: string]: any;
-};

package/lib/types/RequestPayload.js

@@ -1,23 +0,0 @@
-"use strict";
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2022 Kuzzle
- * mailto: support AT kuzzle.io
- * website: http://kuzzle.io
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=RequestPayload.js.map

package/lib/types/ResponsePayload.d.ts

@@ -1,74 +0,0 @@
-import { JSONObject } from "../../index";
-export declare type ResponseErrorPayload = {
-    /**
-     * Error human readable identifier
-     */
-    id: string;
-    /**
-     * Error identifier
-     */
-    code: number;
-    /**
-     * Error message
-     */
-    message: string;
-    /**
-     * HTTP status error code
-     */
-    status: number;
-    /**
-     * Error stacktrace (only if global.NODE_ENV=development)
-     */
-    stack?: string;
-};
-/**
- * Kuzzle API response payload
- *
- * @see https://docs.kuzzle.io/core/2/api/payloads/response
- */
-export declare type ResponsePayload = {
-    /**
-     * API controller name
-     */
-    controller: string;
-    /**
-     * API action name
-     */
-    action: string;
-    /**
-     * Index name
-     */
-    index?: string;
-    /**
-     * Collection name
-     */
-    collection?: string;
-    /**
-     * Document unique identifier
-     */
-    _id?: string;
-    /**
-     * API error
-     */
-    error?: ResponseErrorPayload;
-    /**
-     * Request unique identifier
-     */
-    requestId: string;
-    /**
-     * API action result
-     */
-    result: any;
-    /**
-     * HTTP status code
-     */
-    status: number;
-    /**
-     * Volatile data
-     */
-    volatile?: JSONObject;
-    /**
-     * Room unique identifier
-     */
-    room?: string;
-};

package/lib/types/ResponsePayload.js

@@ -1,23 +0,0 @@
-"use strict";
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2022 Kuzzle
- * mailto: support AT kuzzle.io
- * website: http://kuzzle.io
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ResponsePayload.js.map