kuzzle 2.31.0 → 2.32.0-elasticsearch-8.1

package/lib/kuzzle/index.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -18,7 +19,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-"use strict";
-
-module.exports = require("./kuzzle");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Kuzzle = void 0;
+const kuzzle_1 = require("./kuzzle");
+Object.defineProperty(exports, "Kuzzle", { enumerable: true, get: function () { return kuzzle_1.Kuzzle; } });
+exports.default = kuzzle_1.Kuzzle;
+//# sourceMappingURL=index.js.map

package/lib/kuzzle/kuzzle.d.ts

@@ -1,28 +1,40 @@
 /// <reference types="node" />
-import KuzzleEventEmitter from "./event/kuzzleEventEmitter";
-import { InstallationConfig, ImportConfig, SupportConfig, StartOptions } from "./../types/Kuzzle";
+import { Koncorde } from "koncorde";
+import Funnel from "../api/funnel";
+import PassportWrapper from "../core/auth/passportWrapper";
+import { TokenManager } from "../core/auth/tokenManager";
+import EntryPoint from "../core/network/entryPoint";
+import Router from "../core/network/router";
+import PluginsManager from "../core/plugin/pluginsManager";
+import Validation from "../core/validation";
 import { KuzzleConfiguration } from "../types/config/KuzzleConfiguration";
+import AsyncStore from "../util/asyncStore";
+import { ImportConfig, InstallationConfig, StartOptions, SupportConfig } from "./../types/Kuzzle";
+import KuzzleEventEmitter from "./event/KuzzleEventEmitter";
+import InternalIndexHandler from "./internalIndexHandler";
+import Logger from "./log";
+import vault from "./vault";
 export declare const BACKEND_IMPORT_KEY = "backend:init:import";
 declare class Kuzzle extends KuzzleEventEmitter {
-    private config;
+    config: KuzzleConfiguration;
     private _state;
-    private log;
+    log: Logger;
     private rootPath;
     /**
      * Internal index bootstrapper and accessor
      */
-    private internalIndex;
-    private pluginsManager;
-    private tokenManager;
-    private passport;
+    internalIndex: InternalIndexHandler;
+    pluginsManager: PluginsManager;
+    tokenManager: TokenManager;
+    passport: PassportWrapper;
     /**
      * The funnel dispatches messages to API controllers
      */
-    private funnel;
+    funnel: Funnel;
     /**
      * The router listens to client requests and pass them to the funnel
      */
-    private router;
+    router: Router;
     /**
      * Statistics core component
      */
@@ -30,11 +42,11 @@ declare class Kuzzle extends KuzzleEventEmitter {
     /**
      * Network entry point
      */
-    private entryPoint;
+    entryPoint: EntryPoint;
     /**
      * Validation core component
      */
-    private validation;
+    validation: Validation;
     /**
      * Dump generator
      */
@@ -42,11 +54,11 @@ declare class Kuzzle extends KuzzleEventEmitter {
     /**
      * Vault component (will be initialized after bootstrap)
      */
-    private vault;
+    vault: vault;
     /**
      * AsyncLocalStorage wrapper
      */
-    private asyncStore;
+    asyncStore: AsyncStore;
     /**
      * Kuzzle internal debugger
      */
@@ -60,8 +72,8 @@ declare class Kuzzle extends KuzzleEventEmitter {
      * List of differents imports types and their associated method
      */
     private importTypes;
-    private koncorde;
-    private secret;
+    koncorde: Koncorde;
+    secret: string;
     /**
      * Node unique ID amongst other cluster nodes
      */
@@ -96,9 +108,9 @@ declare class Kuzzle extends KuzzleEventEmitter {
      * @returns {Promise<void>}
      */
     install(installations: InstallationConfig[]): Promise<void>;
-    ask(...args: any[]): Promise<any>;
-    emit(...args: any[]): Promise<any>;
-    pipe(...args: any[]): Promise<any>;
+    ask(event: string, ...args: [payload?: any, ...rest: any]): Promise<any>;
+    emit(event: string, ...args: any[]): boolean;
+    pipe(event: string, ...args: any[]): Promise<any>;
     private importUserMappings;
     private importMappings;
     private importFixtures;
@@ -132,3 +144,4 @@ declare class Kuzzle extends KuzzleEventEmitter {
     dumpAndExit(suffix: any): Promise<void>;
 }
 export { Kuzzle };
+export default Kuzzle;

package/lib/kuzzle/kuzzle.js

@@ -48,39 +48,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Kuzzle = exports.BACKEND_IMPORT_KEY = void 0;
 const path_1 = __importDefault(require("path"));
-const murmurhash_native_1 = require("murmurhash-native");
+const bluebird_1 = __importDefault(require("bluebird"));
 const json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
 const koncorde_1 = require("koncorde");
-const bluebird_1 = __importDefault(require("bluebird"));
-const node_segfault_handler_1 = __importDefault(require("node-segfault-handler"));
 const lodash_1 = __importDefault(require("lodash"));
-const kuzzleStateEnum_1 = __importDefault(require("./kuzzleStateEnum"));
-const kuzzleEventEmitter_1 = __importDefault(require("./event/kuzzleEventEmitter"));
-const entryPoint_1 = __importDefault(require("../core/network/entryPoint"));
+const murmurhash_native_1 = require("murmurhash-native");
+const node_segfault_handler_1 = __importDefault(require("node-segfault-handler"));
+const package_json_1 = require("../../package.json");
 const funnel_1 = __importDefault(require("../api/funnel"));
+const openapi_1 = require("../api/openapi");
+const cluster_1 = __importDefault(require("../cluster"));
 const passportWrapper_1 = __importDefault(require("../core/auth/passportWrapper"));
-const pluginsManager_1 = __importDefault(require("../core/plugin/pluginsManager"));
+const tokenManager_1 = require("../core/auth/tokenManager");
+const cacheEngine_1 = __importDefault(require("../core/cache/cacheEngine"));
+const kuzzleDebugger_1 = require("../core/debug/kuzzleDebugger");
+const entryPoint_1 = __importDefault(require("../core/network/entryPoint"));
 const router_1 = __importDefault(require("../core/network/router"));
+const pluginsManager_1 = __importDefault(require("../core/plugin/pluginsManager"));
+const realtime_1 = __importDefault(require("../core/realtime"));
+const security_1 = __importDefault(require("../core/security"));
 const statistics_1 = __importDefault(require("../core/statistics"));
-const tokenManager_1 = require("../core/auth/tokenManager");
+const storageEngine_1 = __importDefault(require("../core/storage/storageEngine"));
 const validation_1 = __importDefault(require("../core/validation"));
-const log_1 = __importDefault(require("./log"));
-const vault_1 = __importDefault(require("./vault"));
-const dumpGenerator_1 = __importDefault(require("./dumpGenerator"));
+const kerror = __importStar(require("../kerror"));
 const asyncStore_1 = __importDefault(require("../util/asyncStore"));
+const crypto_1 = require("../util/crypto");
 const mutex_1 = require("../util/mutex");
-const kerror = __importStar(require("../kerror"));
-const internalIndexHandler_1 = __importDefault(require("./internalIndexHandler"));
-const cacheEngine_1 = __importDefault(require("../core/cache/cacheEngine"));
-const storageEngine_1 = __importDefault(require("../core/storage/storageEngine"));
-const security_1 = __importDefault(require("../core/security"));
-const realtime_1 = __importDefault(require("../core/realtime"));
-const cluster_1 = __importDefault(require("../cluster"));
-const package_json_1 = require("../../package.json");
 const name_generator_1 = require("../util/name-generator");
-const openapi_1 = require("../api/openapi");
-const crypto_1 = require("../util/crypto");
-const kuzzleDebugger_1 = require("../core/debug/kuzzleDebugger");
+const dumpGenerator_1 = __importDefault(require("./dumpGenerator"));
+const KuzzleEventEmitter_1 = __importDefault(require("./event/KuzzleEventEmitter"));
+const internalIndexHandler_1 = __importDefault(require("./internalIndexHandler"));
+const kuzzleStateEnum_1 = __importDefault(require("./kuzzleStateEnum"));
+const log_1 = __importDefault(require("./log"));
+const vault_1 = __importDefault(require("./vault"));
 exports.BACKEND_IMPORT_KEY = "backend:init:import";
 let _kuzzle = null;
 Reflect.defineProperty(global, "kuzzle", {
@@ -99,7 +99,7 @@ Reflect.defineProperty(global, "kuzzle", {
         _kuzzle = value;
     },
 });
-class Kuzzle extends kuzzleEventEmitter_1.default {
+class Kuzzle extends KuzzleEventEmitter_1.default {
     constructor(config) {
         super(config.plugins.common.maxConcurrentPipes, config.plugins.common.pipesBufferSize);
         this._state = kuzzleStateEnum_1.default.STARTING;
@@ -240,7 +240,7 @@ class Kuzzle extends kuzzleEventEmitter_1.default {
      * @returns {Promise<void>}
      */
     async install(installations) {
-        if (!installations || !installations.length) {
+        if (!installations?.length) {
             return;
         }
         const mutex = new mutex_1.Mutex("backend:installations");
@@ -269,16 +269,16 @@ class Kuzzle extends kuzzleEventEmitter_1.default {
         }
     }
     // For testing purpose
-    async ask(...args) {
-        return super.ask(...args);
+    async ask(event, ...args) {
+        return super.ask(event, ...args);
     }
     // For testing purpose
-    async emit(...args) {
-        return super.emit(...args);
+    emit(event, ...args) {
+        return super.emit(event, ...args);
     }
     // For testing purpose
-    async pipe(...args) {
-        return super.pipe(...args);
+    async pipe(event, ...args) {
+        return super.pipe(event, ...args);
     }
     async importUserMappings(config, status) {
         if (!status.firstCall) {
@@ -584,5 +584,5 @@ class Kuzzle extends kuzzleEventEmitter_1.default {
     }
 }
 exports.Kuzzle = Kuzzle;
-module.exports = Kuzzle;
+exports.default = Kuzzle;
 //# sourceMappingURL=kuzzle.js.map

package/lib/service/storage/{elasticsearch.d.ts → 7/elasticsearch.d.ts}

@@ -1,19 +1,18 @@
 import _ from "lodash";
-import { RequestParams, Client as StorageClient } from "@elastic/elasticsearch";
-import { JSONObject, KRequestBody, KRequestParams } from "../../types/storage/Elasticsearch";
-import { TypeMapping } from "@elastic/elasticsearch/api/types";
-import { storeScopeEnum } from "../../core/storage/storeScopeEnum";
-import Service from "../service";
+import { RequestParams, Client } from "sdk-es7";
+import { TypeMapping } from "sdk-es7/api/types";
+import { JSONObject, KRequestBody, KRequestParams } from "../../../types/storage/7/Elasticsearch";
 import ESWrapper from "./esWrapper";
-import QueryTranslator from "./queryTranslator";
+import QueryTranslator from "../commons/queryTranslator";
+import { storeScopeEnum } from "../../../core/storage/storeScopeEnum";
 /**
  * @param {Kuzzle} kuzzle kuzzle instance
  * @param {Object} config Service configuration
  * @param {storeScopeEnum} scope
  * @constructor
  */
-export default class ElasticSearch extends Service {
-    _client: StorageClient;
+export declare class ES7 {
+    _client: Client;
     _scope: storeScopeEnum;
     _indexPrefix: string;
     _esWrapper: ESWrapper;
@@ -25,12 +24,6 @@ export default class ElasticSearch extends Service {
     maxScrollDuration: number;
     scrollTTL: number;
     _config: any;
-    /**
-     * Returns a new elasticsearch client instance
-     *
-     * @returns {Object}
-     */
-    static buildClient(config: any): StorageClient;
     constructor(config: any, scope?: storeScopeEnum);
     get scope(): storeScopeEnum;
     /**
@@ -77,7 +70,15 @@ export default class ElasticSearch extends Service {
         scrollTTL?: string;
     }): Promise<{
         aggregations: any;
-        hits: any;
+        hits: {
+            _id: any;
+            _score: any;
+            _source: any;
+            collection: any;
+            highlight: any;
+            index: any;
+            inner_hits: {};
+        }[];
         remaining: any;
         scrollId: any;
         suggest: any;
@@ -104,7 +105,15 @@ export default class ElasticSearch extends Service {
         scroll?: string;
     }): Promise<{
         aggregations: any;
-        hits: any;
+        hits: {
+            _id: any;
+            _score: any;
+            _source: any;
+            collection: any;
+            highlight: any;
+            index: any;
+            inner_hits: {};
+        }[];
         remaining: any;
         scrollId: any;
         suggest: any;
@@ -119,7 +128,15 @@ export default class ElasticSearch extends Service {
     _mapTargetsToAlias(targets: any): {};
     _formatSearchResult(body: any, searchInfo?: any): Promise<{
         aggregations: any;
-        hits: any;
+        hits: {
+            _id: any;
+            _score: any;
+            _source: any;
+            collection: any;
+            highlight: any;
+            index: any;
+            inner_hits: {};
+        }[];
         remaining: any;
         scrollId: any;
         suggest: any;
@@ -187,7 +204,7 @@ export default class ElasticSearch extends Service {
         _version: any;
     }>;
     /**
-     * Creates a new document to ElasticSearch, or replace it if it already exist
+     * Creates a new document to Elasticsearch, or replace it if it already exist
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -253,7 +270,7 @@ export default class ElasticSearch extends Service {
         created: boolean;
     }>;
     /**
-     * Replaces a document to ElasticSearch
+     * Replaces a document to Elasticsearch
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -559,7 +576,7 @@ export default class ElasticSearch extends Service {
      *
      * @returns {Promise.<String[]>}
      */
-    deleteIndexes(indexes?: string[]): Promise<any>;
+    deleteIndexes(indexes?: string[]): Promise<any[]>;
     /**
      * Deletes an index
      *
@@ -830,7 +847,7 @@ export default class ElasticSearch extends Service {
      * @returns {String} Alias name (eg: '@&nepali.liia')
      * @throws If there is not exactly one alias associated that is prefixed with @
      */
-    _getAliasFromIndice(indice: any): Promise<string[]>;
+    _getAliasFromIndice(indice: string): Promise<string[]>;
     /**
      * Check for each indice whether it has an alias or not.
      * When the latter is missing, create one based on the indice name.
@@ -870,7 +887,7 @@ export default class ElasticSearch extends Service {
      *
      * @returns {Object.<String, String[]>} Indexes as key and an array of their collections as value
      */
-    _extractSchema(aliases: any, { includeHidden }?: {
+    _extractSchema(aliases: string[], { includeHidden }?: {
         includeHidden?: boolean;
     }): {};
     /**
@@ -953,4 +970,5 @@ export default class ElasticSearch extends Service {
     _checkDynamicProperty(mappings: any): void;
     _setLastActionToKuzzleMeta(esRequest: JSONObject, alias: string, kuzzleMeta: JSONObject): void;
     _setLastActionToKuzzleMetaUpdate(item: JSONObject, kuzzleMeta: JSONObject): void;
+    _getRandomNumber(number: number): number;
 }

package/lib/service/storage/{elasticsearch.js → 7/elasticsearch.js}

@@ -46,24 +46,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ES7 = void 0;
 const lodash_1 = __importDefault(require("lodash"));
-const elasticsearch_1 = require("@elastic/elasticsearch");
+const sdk_es7_1 = require("sdk-es7");
 const assert_1 = __importDefault(require("assert"));
 const bluebird_1 = __importDefault(require("bluebird"));
 const ms_1 = __importDefault(require("ms"));
 const semver_1 = __importDefault(require("semver"));
-const debug_1 = __importDefault(require("../../util/debug"));
-const storeScopeEnum_1 = require("../../core/storage/storeScopeEnum");
-const kerror = __importStar(require("../../kerror"));
-const didYouMean_1 = __importDefault(require("../../util/didYouMean"));
-const extractFields_1 = __importDefault(require("../../util/extractFields"));
-const mutex_1 = require("../../util/mutex");
-const name_generator_1 = require("../../util/name-generator");
-const requestAssertions_1 = require("../../util/requestAssertions");
-const safeObject_1 = require("../../util/safeObject");
-const service_1 = __importDefault(require("../service"));
+const debug_1 = __importDefault(require("../../../util/debug"));
 const esWrapper_1 = __importDefault(require("./esWrapper"));
-const queryTranslator_1 = __importDefault(require("./queryTranslator"));
+const queryTranslator_1 = __importDefault(require("../commons/queryTranslator"));
+const didYouMean_1 = __importDefault(require("../../../util/didYouMean"));
+const kerror = __importStar(require("../../../kerror"));
+const requestAssertions_1 = require("../../../util/requestAssertions");
+const safeObject_1 = require("../../../util/safeObject");
+const extractFields_1 = __importDefault(require("../../../util/extractFields"));
+const mutex_1 = require("../../../util/mutex");
+const name_generator_1 = require("../../../util/name-generator");
+const storeScopeEnum_1 = require("../../../core/storage/storeScopeEnum");
 (0, debug_1.default)("kuzzle:services:elasticsearch");
 const SCROLL_CACHE_PREFIX = "_docscroll_";
 const ROOT_MAPPING_PROPERTIES = [
@@ -97,28 +97,9 @@ let esState = esStateEnum.NONE;
  * @param {storeScopeEnum} scope
  * @constructor
  */
-class ElasticSearch extends service_1.default {
-    /**
-     * Returns a new elasticsearch client instance
-     *
-     * @returns {Object}
-     */
-    static buildClient(config) {
-        // Passed to Elasticsearch's client to make it use
-        // Bluebird instead of ES6 promises
-        const defer = function defer() {
-            let resolve;
-            let reject;
-            const promise = new bluebird_1.default((res, rej) => {
-                resolve = res;
-                reject = rej;
-            });
-            return { promise, reject, resolve };
-        };
-        return new elasticsearch_1.Client({ defer, ...config });
-    }
+class ES7 {
     constructor(config, scope = storeScopeEnum_1.storeScopeEnum.PUBLIC) {
-        super("elasticsearch", config);
+        this._config = config;
         this._scope = scope;
         this._indexPrefix =
             scope === storeScopeEnum_1.storeScopeEnum.PRIVATE ? PRIVATE_PREFIX : PUBLIC_PREFIX;
@@ -175,7 +156,7 @@ class ElasticSearch extends service_1.default {
                 'See the "services.storageEngine.commonMapping.dynamic" option in the kuzzlerc configuration file to change this value.',
             ].join("\n"));
         }
-        this._client = ElasticSearch.buildClient(this._config.client);
+        this._client = new sdk_es7_1.Client(this._config.client);
         await this.waitForElasticsearch();
         this._esWrapper = new esWrapper_1.default(this._client);
         const { body: { version }, } = await this._client.info();
@@ -619,7 +600,7 @@ class ElasticSearch extends service_1.default {
         }
     }
     /**
-     * Creates a new document to ElasticSearch, or replace it if it already exist
+     * Creates a new document to Elasticsearch, or replace it if it already exist
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -757,7 +738,7 @@ class ElasticSearch extends service_1.default {
         }
     }
     /**
-     * Replaces a document to ElasticSearch
+     * Replaces a document to Elasticsearch
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -2468,7 +2449,7 @@ class ElasticSearch extends service_1.default {
         let notAvailable;
         let suffix;
         do {
-            suffix = `.${(0, name_generator_1.randomNumber)(100000)}`;
+            suffix = `.${this._getRandomNumber(100000)}`;
             const overflow = Buffer.from(indice + suffix).length - 255;
             if (overflow > 0) {
                 const indiceBuffer = Buffer.from(indice);
@@ -2574,7 +2555,7 @@ class ElasticSearch extends service_1.default {
         const schema = {};
         for (const alias of aliases) {
             const [indexName, collectionName] = alias
-                .substr(INDEX_PREFIX_POSITION_IN_ALIAS + 1, alias.length)
+                .slice(INDEX_PREFIX_POSITION_IN_ALIAS + 1)
                 .split(NAME_SEPARATOR);
             if (alias[INDEX_PREFIX_POSITION_IN_ALIAS] === this._indexPrefix &&
                 (collectionName !== HIDDEN_COLLECTION || includeHidden)) {
@@ -2856,8 +2837,11 @@ class ElasticSearch extends service_1.default {
             }
         }
     }
+    _getRandomNumber(number) {
+        return (0, name_generator_1.randomNumber)(number);
+    }
 }
-exports.default = ElasticSearch;
+exports.ES7 = ES7;
 /**
  * Finds paths and values of mappings dynamic properties
  *
@@ -2942,7 +2926,4 @@ function _isObjectNameValid(name) {
     }
     return valid;
 }
-// TODO: Remove this function when we move to Jest
-// This is kept because we use an old ReRequire that use require() instead of import
-module.exports = ElasticSearch;
 //# sourceMappingURL=elasticsearch.js.map

package/lib/service/storage/{esWrapper.js → 7/esWrapper.js}

@@ -25,11 +25,13 @@
 
 const Bluebird = require("bluebird");
 const _ = require("lodash");
-const es = require("@elastic/elasticsearch");
+const es = require("sdk-es7");
 
-const { KuzzleError } = require("../../kerror/errors");
-const debug = require("../../util/debug")("kuzzle:services:storage:ESCommon");
-const kerror = require("../../kerror").wrap("services", "storage");
+const { KuzzleError } = require("../../../kerror/errors");
+const debug = require("../../../util/debug")(
+  "kuzzle:services:storage:ESCommon",
+);
+const kerror = require("../../../kerror").wrap("services", "storage");
 
 const errorMessagesMapping = [
   {