kuzzle 2.31.0 → 2.32.0-beta.1

package/index.d.ts

@@ -13,3 +13,4 @@ export * from "./lib/core/shared/ObjectRepository";
 export * from "./lib/core/shared/store";
 export * from "./lib/core/cache/cacheDbEnum";
 export * from "./lib/core/storage/storeScopeEnum";
+export * from "./lib/service/storage/commons/queryTranslator";

package/index.js

@@ -31,4 +31,5 @@ __exportStar(require("./lib/core/shared/ObjectRepository"), exports);
 __exportStar(require("./lib/core/shared/store"), exports);
 __exportStar(require("./lib/core/cache/cacheDbEnum"), exports);
 __exportStar(require("./lib/core/storage/storeScopeEnum"), exports);
+__exportStar(require("./lib/service/storage/commons/queryTranslator"), exports);
 //# sourceMappingURL=index.js.map

package/lib/api/controllers/authController.d.ts

@@ -1,3 +1,4 @@
+import Bluebird from "bluebird";
 import { KuzzleRequest } from "../request";
 import { NativeController } from "./baseController";
 export declare class AuthController extends NativeController {
@@ -78,7 +79,7 @@ export declare class AuthController extends NativeController {
      * @param {KuzzleRequest} request
      * @returns {Promise<Object>}
      */
-    getCurrentUser(request: any): any;
+    getCurrentUser(request: any): Bluebird<any>;
     /**
      * Returns the rights of the user identified by the given jwt token
      *
@@ -115,7 +116,7 @@ export declare class AuthController extends NativeController {
      *
      * @returns {Promise.<string[]>}
      */
-    getStrategies(): any;
+    getStrategies(): Bluebird<any>;
     /**
      * @param {KuzzleRequest} request
      * @returns {Promise.<Object>}

package/lib/api/funnel.js

@@ -754,7 +754,8 @@ class Funnel {
   async executePluginRequest(request) {
     try {
       if (request.input.triggerEvents) {
-        return await this.processRequest(request);
+        const response = await this.processRequest(request);
+        return { ...response.result };
       }
       return await doAction(this.getController(request), request);
     } catch (e) {

package/lib/config/default.config.js

@@ -275,6 +275,7 @@ const defaultConfig = {
             bootstrapLockTimeout: 60000,
         },
         storageEngine: {
+            majorVersion: "7",
             aliases: ["storageEngine"],
             backend: "elasticsearch",
             client: {

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

@@ -1,19 +1,17 @@
-import { Client } from "@elastic/elasticsearch";
-import { ApplicationManager, Backend } from "./index";
+import { ApplicationManager } from "./index";
 export declare class BackendStorage extends ApplicationManager {
     private _client;
     private _Client;
-    constructor(application: Backend);
     /**
      * Storage client constructor.
      * (Currently Elasticsearch)
      *
      * @param clientConfig Overload configuration for the underlaying storage client
      */
-    get StorageClient(): new (clientConfig?: any) => Client;
+    get StorageClient(): new (clientConfig?: any) => any;
     /**
      * Access to the underlaying storage engine client.
      * (Currently Elasticsearch)
      */
-    get storageClient(): Client;
+    get storageClient(): any;
 }

package/lib/core/backend/backendStorage.js

@@ -19,16 +19,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BackendStorage = void 0;
-const elasticsearch_1 = __importDefault(require("../../service/storage/elasticsearch"));
+const Elasticsearch_1 = require("../../service/storage/Elasticsearch");
 const index_1 = require("./index");
 class BackendStorage extends index_1.ApplicationManager {
-    constructor(application) {
-        super(application);
+    constructor() {
+        super(...arguments);
         this._client = null;
         this._Client = null;
     }
@@ -39,13 +36,13 @@ class BackendStorage extends index_1.ApplicationManager {
      * @param clientConfig Overload configuration for the underlaying storage client
      */
     get StorageClient() {
+        const kuzzle = this._kuzzle;
         if (!this._Client) {
-            const kuzzle = this._kuzzle;
             this._Client = function ESClient(clientConfig = {}) {
-                return elasticsearch_1.default.buildClient({
+                return Elasticsearch_1.Elasticsearch.buildClient({
                     ...kuzzle.config.services.storageEngine.client,
                     ...clientConfig,
-                });
+                }, kuzzle.config.services.storageEngine.majorVersion);
             };
         }
         return this._Client;
@@ -55,8 +52,9 @@ class BackendStorage extends index_1.ApplicationManager {
      * (Currently Elasticsearch)
      */
     get storageClient() {
+        const kuzzle = this._kuzzle;
         if (!this._client) {
-            this._client = elasticsearch_1.default.buildClient(this._kuzzle.config.services.storageEngine.client);
+            this._client = Elasticsearch_1.Elasticsearch.buildClient(kuzzle.config.services.storageEngine.client, kuzzle.config.services.storageEngine.majorVersion);
         }
         return this._client;
     }

package/lib/core/plugin/pluginContext.d.ts

@@ -1,6 +1,5 @@
-import { Client } from "@elastic/elasticsearch";
-import { JSONObject } from "kuzzle-sdk";
 import { Koncorde } from "../shared/KoncordeWrapper";
+import { JSONObject } from "kuzzle-sdk";
 import { KuzzleRequest, RequestContext, RequestInput } from "../../../index";
 import { Mutex } from "../../util/mutex";
 import { BackendCluster } from "../backend";
@@ -122,7 +121,7 @@ export declare class PluginContext {
         /**
          * Constructor for Elasticsearch SDK Client
          */
-        ESClient: typeof Client;
+        ESClient: new () => any;
     };
     /**
      * @deprecated import directly: `import { BadRequestError, ... } from 'kuzzle'`

package/lib/core/plugin/pluginContext.js

@@ -52,7 +52,7 @@ const KoncordeWrapper_1 = require("../shared/KoncordeWrapper");
 const index_1 = require("../../../index");
 const kerror = __importStar(require("../../kerror"));
 const errors_1 = require("../../kerror/errors");
-const elasticsearch_1 = __importDefault(require("../../service/storage/elasticsearch"));
+const Elasticsearch_1 = require("../../service/storage/Elasticsearch");
 const mutex_1 = require("../../util/mutex");
 const promback_1 = __importDefault(require("../../util/promback"));
 const safeObject_1 = require("../../util/safeObject");
@@ -111,9 +111,8 @@ class PluginContext {
                 update: (...args) => pluginRepository.update(...args),
             };
         }
-        // eslint-disable-next-line no-inner-declarations
         function PluginContextESClient() {
-            return elasticsearch_1.default.buildClient(global.kuzzle.config.services.storageEngine.client);
+            return Elasticsearch_1.Elasticsearch.buildClient(global.kuzzle.config.services.storageEngine.client);
         }
         this.constructors = {
             BaseValidationType: require("../validation/baseType"),
@@ -252,7 +251,10 @@ function instantiateRequest(request, data, options = {}) {
             target.input.jwt = _request.input.jwt;
         }
         if (_data) {
-            target.input.volatile = Object.assign({}, _request.input.volatile, _data.volatile);
+            target.input.volatile = {
+                ..._request.input.volatile,
+                ..._data.volatile,
+            };
         }
         else {
             target.input.volatile = _request.input.volatile;

package/lib/core/security/tokenRepository.d.ts

@@ -69,5 +69,5 @@ export declare class TokenRepository extends ObjectRepository<Token> {
      *
      * So we need to override the TTL auto-refresh function to disable it
      */
-    refreshCacheTTL(): void;
+    refreshCacheTTL(): Promise<void>;
 }

package/lib/core/security/tokenRepository.js

@@ -374,7 +374,7 @@ class TokenRepository extends ObjectRepository_1.ObjectRepository {
      *
      * So we need to override the TTL auto-refresh function to disable it
      */
-    refreshCacheTTL() {
+    async refreshCacheTTL() {
         // This comment is here to please Sonarqube. It requires a comment
         // explaining why a function is empty, but there is no sense
         // duplicating what has been just said in the JSDoc.

package/lib/core/shared/ObjectRepository.d.ts

@@ -117,7 +117,7 @@ export declare class ObjectRepository<TObject extends {
     refreshCacheTTL(object: JSONObject, options?: {
         key?: string;
         ttl?: number;
-    }): any;
+    }): Promise<any>;
     /**
      * @param object
      * @param options.key - if provided, stores the object to the given key instead of the default one (<collection>/<id>)

package/lib/core/storage/clientAdapter.js

@@ -21,7 +21,7 @@
 
 "use strict";
 
-const Elasticsearch = require("../../service/storage/elasticsearch");
+const { Elasticsearch } = require("../../service/storage/Elasticsearch");
 const { IndexCache } = require("./indexCache");
 const { isPlainObject } = require("../../util/safeObject");
 const kerror = require("../../kerror");
@@ -38,16 +38,17 @@ class ClientAdapter {
    * @param {storeScopeEnum} scope
    */
   constructor(scope) {
-    this.client = new Elasticsearch(
+    this.es = new Elasticsearch(
       global.kuzzle.config.services.storageEngine,
       scope,
     );
+    this.client = this.es.client;
     this.scope = scope;
     this.cache = new IndexCache();
   }
 
   async init() {
-    await this.client.init();
+    await this.es.init();
     await this.populateCache();
 
     this.registerCollectionEvents();
@@ -202,6 +203,7 @@ class ClientAdapter {
      * @return {Promise}
      * @throws
      */
+
     global.kuzzle.onAsk(
       `core:storage:${this.scope}:collection:create`,
       (index, collection, opts, creationOptions) =>
@@ -454,7 +456,7 @@ class ClientAdapter {
      * @param {string} collection
      * @param {Object} query
      * @param {Object} [opts] -- see Elasticsearch "deleteByQuery" options
-     * @returns {Promise.<{ documents, total, deleted, failures: [ _shardId, reason ] }>}
+     * @returns {Promise.<{ documents, total, deleted, failures: [ id, reason ] }>}
      */
     global.kuzzle.onAsk(
       `core:storage:${this.scope}:document:deleteByQuery`,

package/lib/core/storage/storageEngine.js

@@ -21,8 +21,6 @@
 
 "use strict";
 
-const Bluebird = require("bluebird");
-
 const kerror = require("../../kerror").wrap("services", "storage");
 const ClientAdapter = require("./clientAdapter");
 const { storeScopeEnum } = require("./storeScopeEnum");
@@ -42,11 +40,12 @@ class StorageEngine {
    * @returns {Promise}
    */
   async init() {
-    await Bluebird.all([this.public.init(), this.private.init()]);
+    await Promise.all([this.public.init(), this.private.init()]);
 
-    const privateIndexes = await this.private.cache.listIndexes();
+    const privateIndexes = this.private.cache.listIndexes();
+    const publicIndexes = this.public.cache.listIndexes();
 
-    for (const publicIndex of await this.public.cache.listIndexes()) {
+    for (const publicIndex of publicIndexes) {
       if (privateIndexes.includes(publicIndex)) {
         throw kerror.get("index_already_exists", "public", publicIndex);
       }

package/lib/kerror/index.js

@@ -169,7 +169,7 @@ function rawGetFrom(domains, source, domain, subdomain, error, ...placeholders)
     const derivedError = rawGet(domains, domain, subdomain, error, ...placeholders);
     // If a stacktrace is present, we need to modify the first line because it
     // still contains the original error message
-    if (derivedError.stack && derivedError.stack.length && source.stack) {
+    if (derivedError?.stack?.length && source?.stack) {
         const stackArray = source.stack.split("\n");
         stackArray.shift();
         derivedError.stack = [

package/lib/kuzzle/event/KuzzleEventEmitter.d.ts

@@ -0,0 +1,70 @@
+import EventEmitter from "eventemitter3";
+import { AskEventDefinition, AskEventHandler, CallEventHandler, EventDefinition, HookEventHandler, PipeEventHandler } from "../../types/EventHandler";
+declare class KuzzleEventEmitter extends EventEmitter {
+    private coreAnswerers;
+    private coreSyncedAnswerers;
+    private corePipes;
+    private pipeRunner;
+    private pluginPipes;
+    private pluginPipeDefinitions;
+    private superEmit;
+    constructor(maxConcurrentPipes: number, pipesBufferSize: number);
+    /**
+     * Registers a core method on a pipe
+     * Note: core methods cannot listen to wildcarded events, only exact matching
+     * works here.
+     */
+    onPipe<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], fn: PipeEventHandler<TEventDefinition>): void;
+    /**
+     * Registers a core 'ask' event answerer
+     * There can only be 0 or 1 answerer per ask event.
+     */
+    onAsk<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], fn: AskEventHandler<TAskEventDefinition>): void;
+    /**
+     * Registers a core 'callback' answerer
+     * There can only be 0 or 1 answerer per callback event.
+     */
+    onCall<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], fn: CallEventHandler<TAskEventDefinition>): void;
+    /**
+     * Emits an event and all its wildcarded versions
+     *
+     * @warning Critical section of code
+     */
+    emit(event: string | symbol, ...args: any[]): boolean;
+    /**
+     * Emits a pipe event, which triggers the following, in that order:
+     * 1. Plugin pipes are invoked one after another (waterfall). Each plugin must
+     *    resolve the pipe (with a callback or a promise) with a similar payload
+     *    than the one received
+     * 2. Core pipes are invoked in parallel. They are awaited for (promises-only)
+     *    but their responses are neither evaluated nor used
+     * 3. Hooks are invoked in parallel. They are not awaited.
+     *
+     * Accepts a callback argument (to be used by pipes invoked before the funnel
+     * overload-protection mechanism). If a callback is provided, this method
+     * doesn't return a promise.
+     *
+     * @warning Critical section of code
+     */
+    pipe<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], ...payload: TEventDefinition["args"]): Promise<TEventDefinition["args"][0]> | null;
+    /**
+     * Emits an "ask" event to get information about the provided payload
+     */
+    ask<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], ...args: [payload?: TAskEventDefinition["payload"], ...rest: any]): Promise<TAskEventDefinition["result"]>;
+    /**
+     * Calls a callback to get information about the provided payload
+     */
+    call<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], ...args: [payload?: TAskEventDefinition["payload"], ...rest: any]): TAskEventDefinition["result"];
+    /**
+     * Registers a plugin hook.
+     * Catch any error in the handler and emit the hook:onError event.
+     */
+    registerPluginHook<TEventDefinition extends EventDefinition = EventDefinition>(pluginName: string, event: TEventDefinition["name"], fn: HookEventHandler<TEventDefinition>): void;
+    registerPluginPipe<TEventDefinition extends EventDefinition = EventDefinition>(event: TEventDefinition["name"], handler: PipeEventHandler<TEventDefinition>): string;
+    unregisterPluginPipe(pipeId: string): void;
+    /**
+     * Checks if an ask event has an answerer
+     */
+    hasAskAnswerer(event: string): boolean;
+}
+export default KuzzleEventEmitter;