kuzzle 2.21.1 → 2.22.0

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

@@ -1,5 +1,5 @@
 import { EmbeddedSDK } from "../shared/sdk/embeddedSdk";
-import { EventDefinition, JSONObject } from "../../../index";
+import { BackendSubscription, 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;
@@ -121,6 +121,7 @@ export declare class Backend {
      * Standard errors
      */
     errors: BackendErrors;
+    subscription: BackendSubscription;
     /**
      * @deprecated
      *

package/lib/core/backend/backend.js

@@ -51,7 +51,8 @@ const fs_1 = __importDefault(require("fs"));
 const kuzzle_1 = __importDefault(require("../../kuzzle"));
 const embeddedSdk_1 = require("../shared/sdk/embeddedSdk");
 const kerror = __importStar(require("../../kerror"));
-const index_1 = require("./index");
+const index_1 = require("../../../index");
+const index_2 = require("./index");
 const assertionError = kerror.wrap("plugin", "assert");
 const runtimeError = kerror.wrap("plugin", "runtime");
 let _app = null;
@@ -139,18 +140,19 @@ class Backend {
             // Silent if no version can be found
         }
         global.app = this;
-        this.pipe = new index_1.BackendPipe(this);
-        this.hook = new index_1.BackendHook(this);
-        this.config = new index_1.BackendConfig(this);
-        this.vault = new index_1.BackendVault(this);
-        this.controller = new index_1.BackendController(this);
-        this.plugin = new index_1.BackendPlugin(this);
-        this.storage = new index_1.BackendStorage(this);
-        this.import = new index_1.BackendImport(this);
-        this.log = new index_1.InternalLogger(this);
-        this.cluster = new index_1.BackendCluster();
-        this.openApi = new index_1.BackendOpenApi(this);
-        this.errors = new index_1.BackendErrors(this);
+        this.pipe = new index_2.BackendPipe(this);
+        this.hook = new index_2.BackendHook(this);
+        this.config = new index_2.BackendConfig(this);
+        this.vault = new index_2.BackendVault(this);
+        this.controller = new index_2.BackendController(this);
+        this.plugin = new index_2.BackendPlugin(this);
+        this.storage = new index_2.BackendStorage(this);
+        this.import = new index_2.BackendImport(this);
+        this.log = new index_2.InternalLogger(this);
+        this.cluster = new index_2.BackendCluster();
+        this.openApi = new index_2.BackendOpenApi(this);
+        this.errors = new index_2.BackendErrors(this);
+        this.subscription = new index_1.BackendSubscription(this);
         this.kerror = kerror;
         try {
             this.commit = this._readCommit();

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

@@ -0,0 +1,25 @@
+import { JSONObject } from "kuzzle-sdk";
+import { Connection } from "../../api/request";
+import { ApplicationManager } from "./index";
+export declare class BackendSubscription extends ApplicationManager {
+    /**
+     * Registers a new realtime subscription on the specified connection
+     *
+     * @param connection Connection to register the subscription on
+     * @param index Index name
+     * @param collection Collection name
+     * @param filters Subscription filters
+     * @param options.volatile Volatile data
+     * @param options.scope Subscription scope
+     * @param options.users Option for users notifications
+     */
+    add(connection: Connection, index: string, collection: string, filters: JSONObject, { volatile, scope, users, }?: {
+        volatile?: JSONObject;
+        scope?: "in" | "out" | "all" | "none";
+        users?: "in" | "out" | "all" | "none";
+    }): Promise<{
+        roomId: string;
+        channel: string;
+    }>;
+    remove(connection: Connection, roomId: string): Promise<void>;
+}

package/lib/core/backend/backendSubscription.js

@@ -0,0 +1,90 @@
+"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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackendSubscription = void 0;
+const request_1 = require("../../api/request");
+const kerror = __importStar(require("../../kerror"));
+const index_1 = require("./index");
+const runtimeError = kerror.wrap("plugin", "runtime");
+class BackendSubscription extends index_1.ApplicationManager {
+    /**
+     * Registers a new realtime subscription on the specified connection
+     *
+     * @param connection Connection to register the subscription on
+     * @param index Index name
+     * @param collection Collection name
+     * @param filters Subscription filters
+     * @param options.volatile Volatile data
+     * @param options.scope Subscription scope
+     * @param options.users Option for users notifications
+     */
+    async add(connection, index, collection, filters, { volatile, scope, users, } = {}) {
+        if (!this._application.started) {
+            throw runtimeError.get("unavailable_before_start", "subscriptions.add");
+        }
+        const subscriptionRequest = new request_1.KuzzleRequest({
+            action: "subscribe",
+            body: filters,
+            collection,
+            controller: "realtime",
+            index,
+            scope,
+            users,
+        }, {
+            connectionId: connection.id,
+            volatile,
+        });
+        const { channel, roomId } = await global.kuzzle.ask("core:realtime:subscribe", subscriptionRequest);
+        return { channel, roomId };
+    }
+    async remove(connection, roomId) {
+        if (!this._application.started) {
+            throw runtimeError.get("unavailable_before_start", "subscriptions.remove");
+        }
+        await global.kuzzle.ask("core:realtime:unsubscribe", connection.id, roomId);
+    }
+}
+exports.BackendSubscription = BackendSubscription;
+//# sourceMappingURL=backendSubscription.js.map

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

@@ -12,3 +12,4 @@ export * from "./backendVault";
 export * from "./backendOpenApi";
 export * from "./internalLogger";
 export * from "./backendErrors";
+export * from "./backendSubscription";

package/lib/core/backend/index.js

@@ -28,4 +28,5 @@ __exportStar(require("./backendVault"), exports);
 __exportStar(require("./backendOpenApi"), exports);
 __exportStar(require("./internalLogger"), exports);
 __exportStar(require("./backendErrors"), exports);
+__exportStar(require("./backendSubscription"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.21.1",
+  "version": "2.22.0",
   "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": {