kuzzle 2.29.1 → 2.30.0-beta.1

package/index.d.ts

@@ -1,11 +1,15 @@
-export * from './lib/core/backend';
-export * from './lib/types';
-export * from './lib/core/plugin/pluginContext';
-export * from './lib/core/shared/sdk/embeddedSdk';
-export * from './lib/api/request';
-export * from './lib/kerror/errors';
-export * from './lib/util/mutex';
-export * from './lib/util/Inflector';
-export { NameGenerator } from './lib/util/name-generator';
-export * from 'kuzzle-sdk';
-export * from './lib/core/shared/KoncordeWrapper';
+export * from "./lib/core/backend";
+export * from "./lib/types";
+export * from "./lib/core/plugin/pluginContext";
+export * from "./lib/core/shared/sdk/embeddedSdk";
+export * from "./lib/api/request";
+export * from "./lib/kerror/errors";
+export * from "./lib/util/mutex";
+export * from "./lib/util/Inflector";
+export { NameGenerator } from "./lib/util/name-generator";
+export * from "kuzzle-sdk";
+export * from "./lib/core/shared/KoncordeWrapper";
+export * from "./lib/core/shared/ObjectRepository";
+export * from "./lib/core/shared/store";
+export * from "./lib/core/cache/cacheDbEnum";
+export * from "./lib/core/storage/storeScopeEnum";

package/index.js

@@ -27,4 +27,8 @@ var name_generator_1 = require("./lib/util/name-generator");
 Object.defineProperty(exports, "NameGenerator", { enumerable: true, get: function () { return name_generator_1.NameGenerator; } });
 __exportStar(require("kuzzle-sdk"), exports);
 __exportStar(require("./lib/core/shared/KoncordeWrapper"), exports);
+__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);
 //# sourceMappingURL=index.js.map

package/lib/core/cache/cacheDbEnum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Enum for the cache engine target (used by classes using either the
+ * internal or the public DB)
+ */
+export declare enum cacheDbEnum {
+    INTERNAL = "internal",
+    NONE = "none",
+    PUBLIC = "public"
+}

package/lib/core/cache/cacheDbEnum.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -18,23 +19,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-"use strict";
-
-/**
- * @typedef {string} cacheDbEnum
- */
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheDbEnum = void 0;
 /**
  * Enum for the cache engine target (used by classes using either the
  * internal or the public DB)
- * @readOnly
- * @enum {cacheDbEnum}
  */
-const cacheDbEnum = Object.freeze({
-  INTERNAL: "internal",
-  NONE: "none",
-  PUBLIC: "public",
-});
-
-module.exports = cacheDbEnum;
+var cacheDbEnum;
+(function (cacheDbEnum) {
+    cacheDbEnum["INTERNAL"] = "internal";
+    cacheDbEnum["NONE"] = "none";
+    cacheDbEnum["PUBLIC"] = "public";
+})(cacheDbEnum || (exports.cacheDbEnum = cacheDbEnum = {}));
+//# sourceMappingURL=cacheDbEnum.js.map

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

@@ -1,10 +1,10 @@
-import { Koncorde } from "../shared/KoncordeWrapper";
 import { Client } from "@elastic/elasticsearch";
 import { JSONObject } from "kuzzle-sdk";
-import { EmbeddedSDK } from "../shared/sdk/embeddedSdk";
+import { Koncorde } from "../shared/KoncordeWrapper";
+import { KuzzleRequest, RequestContext, RequestInput } from "../../../index";
 import { Mutex } from "../../util/mutex";
-import { RequestContext, RequestInput, KuzzleRequest } from "../../../index";
 import { BackendCluster } from "../backend";
+import { EmbeddedSDK } from "../shared/sdk/embeddedSdk";
 export interface Repository {
     create(document: JSONObject, options: any): Promise<any>;
     createOrReplace(document: JSONObject, options: any): Promise<any>;

package/lib/core/plugin/pluginContext.js

@@ -49,18 +49,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluginContext = void 0;
 const bluebird_1 = __importDefault(require("bluebird"));
 const KoncordeWrapper_1 = require("../shared/KoncordeWrapper");
-const embeddedSdk_1 = require("../shared/sdk/embeddedSdk");
-const pluginRepository_1 = __importDefault(require("./pluginRepository"));
-const store_1 = __importDefault(require("../shared/store"));
-const elasticsearch_1 = __importDefault(require("../../service/storage/elasticsearch"));
-const safeObject_1 = require("../../util/safeObject");
-const promback_1 = __importDefault(require("../../util/promback"));
-const mutex_1 = require("../../util/mutex");
+const index_1 = require("../../../index");
 const kerror = __importStar(require("../../kerror"));
-const storeScopeEnum_1 = __importDefault(require("../storage/storeScopeEnum"));
 const errors_1 = require("../../kerror/errors");
-const index_1 = require("../../../index");
+const elasticsearch_1 = __importDefault(require("../../service/storage/elasticsearch"));
+const mutex_1 = require("../../util/mutex");
+const promback_1 = __importDefault(require("../../util/promback"));
+const safeObject_1 = require("../../util/safeObject");
 const backend_1 = require("../backend");
+const embeddedSdk_1 = require("../shared/sdk/embeddedSdk");
+const store_1 = require("../shared/store");
+const storeScopeEnum_1 = require("../storage/storeScopeEnum");
+const pluginRepository_1 = __importDefault(require("./pluginRepository"));
 const contextError = kerror.wrap("plugin", "context");
 class PluginContext {
     constructor(pluginName) {
@@ -92,7 +92,7 @@ class PluginContext {
         // uppercase are forbidden by ES
         const pluginIndex = `plugin-${pluginName}`.toLowerCase();
         /* context.constructors =============================================== */
-        const pluginStore = new store_1.default(pluginIndex, storeScopeEnum_1.default.PRIVATE);
+        const pluginStore = new store_1.Store(pluginIndex, storeScopeEnum_1.storeScopeEnum.PRIVATE);
         // eslint-disable-next-line no-inner-declarations
         function PluginContextRepository(collection, ObjectConstructor = null) {
             if (!collection) {

package/lib/core/plugin/pluginRepository.js

@@ -24,10 +24,10 @@
 const { merge } = require("lodash");
 
 const { NotFoundError } = require("../../kerror/errors");
-const { Repository } = require("../shared/repository");
-const cacheDbEnum = require("../cache/cacheDbEnum");
+const { ObjectRepository } = require("../shared/ObjectRepository");
+const { cacheDbEnum } = require("../cache/cacheDbEnum");
 
-class PluginRepository extends Repository {
+class PluginRepository extends ObjectRepository {
   constructor(store, collection) {
     super({ cache: cacheDbEnum.NONE, store });
 

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

@@ -1,7 +1,7 @@
 /// <reference types="lodash" />
-import { Profile } from "../../model/security/profile";
-import { Repository } from "../shared/repository";
 import { JSONObject } from "kuzzle-sdk";
+import { Profile } from "../../model/security/profile";
+import { ObjectRepository } from "../shared/ObjectRepository";
 /** @internal */
 type CreateOrReplaceOptions = {
     method?: string;
@@ -25,9 +25,9 @@ type UpdateOptions = {
 };
 /**
  * @class ProfileRepository
- * @extends Repository
+ * @extends ObjectRepository
  */
-export declare class ProfileRepository extends Repository<Profile> {
+export declare class ProfileRepository extends ObjectRepository<Profile> {
     private module;
     private profiles;
     /**

package/lib/core/security/profileRepository.js

@@ -47,23 +47,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProfileRepository = void 0;
-const lodash_1 = require("lodash");
 const bluebird_1 = __importDefault(require("bluebird"));
-const profile_1 = require("../../model/security/profile");
-const repository_1 = require("../shared/repository");
+const lodash_1 = require("lodash");
 const kerror = __importStar(require("../../kerror"));
-const cacheDbEnum_1 = __importDefault(require("../cache/cacheDbEnum"));
+const profile_1 = require("../../model/security/profile");
+const cacheDbEnum_1 = require("../cache/cacheDbEnum");
+const ObjectRepository_1 = require("../shared/ObjectRepository");
 /**
  * @class ProfileRepository
- * @extends Repository
+ * @extends ObjectRepository
  */
-class ProfileRepository extends repository_1.Repository {
+class ProfileRepository extends ObjectRepository_1.ObjectRepository {
     /**
      * @constructor
      */
     constructor(securityModule) {
         super({
-            cache: cacheDbEnum_1.default.NONE,
+            cache: cacheDbEnum_1.cacheDbEnum.NONE,
             store: global.kuzzle.internalIndex,
         });
         this.module = securityModule;

package/lib/core/security/roleRepository.js

@@ -25,18 +25,18 @@ const Bluebird = require("bluebird");
 
 const kuzzleStateEnum = require("../../kuzzle/kuzzleStateEnum");
 const { Role } = require("../../model/security/role");
-const { Repository } = require("../shared/repository");
+const { ObjectRepository } = require("../shared/ObjectRepository");
 const kerror = require("../../kerror");
 const didYouMean = require("../../util/didYouMean");
-const cacheDbEnum = require("../cache/cacheDbEnum");
+const { cacheDbEnum } = require("../cache/cacheDbEnum");
 
 const roleRightsError = kerror.wrap("security", "role");
 
 /**
  * @class RoleRepository
- * @extends Repository
+ * @extends ObjectRepository
  */
-class RoleRepository extends Repository {
+class RoleRepository extends ObjectRepository {
   /**
    * @constructor
    * @param {SecurityModule} securityModule

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

@@ -1,8 +1,8 @@
 import { JSONObject } from "kuzzle-sdk";
 import { Token } from "../../model/security/token";
-import { Repository } from "../shared/repository";
 import { User } from "../../model/security/user";
-export declare class TokenRepository extends Repository<Token> {
+import { ObjectRepository } from "../shared/ObjectRepository";
+export declare class TokenRepository extends ObjectRepository<Token> {
     private tokenGracePeriod;
     private anonymousToken;
     constructor(opts?: JSONObject);

package/lib/core/security/tokenRepository.js

@@ -47,20 +47,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TokenRepository = void 0;
-const lodash_1 = __importDefault(require("lodash"));
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const lodash_1 = __importDefault(require("lodash"));
 const ms_1 = __importDefault(require("ms"));
-const apiKey_1 = __importDefault(require("../../model/storage/apiKey"));
+const kerror = __importStar(require("../../kerror"));
 const errors_1 = require("../../kerror/errors");
 const token_1 = require("../../model/security/token");
-const kerror = __importStar(require("../../kerror"));
+const apiKey_1 = __importDefault(require("../../model/storage/apiKey"));
 const debug_1 = __importDefault(require("../../util/debug"));
 const mutex_1 = require("../../util/mutex");
-const repository_1 = require("../shared/repository");
+const ObjectRepository_1 = require("../shared/ObjectRepository");
 const securityError = kerror.wrap("security", "token");
 const debug = (0, debug_1.default)("kuzzle:bootstrap:tokens");
 const BOOTSTRAP_DONE_KEY = "token/bootstrap";
-class TokenRepository extends repository_1.Repository {
+class TokenRepository extends ObjectRepository_1.ObjectRepository {
     constructor(opts = {}) {
         super();
         this.collection = "token";

package/lib/core/security/userRepository.js

@@ -23,16 +23,16 @@
 
 const { Request } = require("../../api/request");
 const debug = require("../../util/debug")("kuzzle:core:security:users");
-const { Repository } = require("../shared/repository");
+const { ObjectRepository } = require("../shared/ObjectRepository");
 const kerror = require("../../kerror");
 const { User } = require("../../model/security/user");
 const ApiKey = require("../../model/storage/apiKey");
 
 /**
  * @class UserRepository
- * @extends Repository
+ * @extends ObjectRepository
  */
-class UserRepository extends Repository {
+class UserRepository extends ObjectRepository {
   /**
    * @param {SecurityModule} securityModule
    * @constructor

package/lib/core/shared/{repository.d.ts → ObjectRepository.d.ts}

@@ -1,5 +1,6 @@
 import { JSONObject } from "kuzzle-sdk";
-export declare class Repository<TObject extends {
+import { cacheDbEnum } from "../cache/cacheDbEnum";
+export declare class ObjectRepository<TObject extends {
     _id: string;
 }> {
     protected ttl: number;
@@ -7,9 +8,9 @@ export declare class Repository<TObject extends {
     protected collection: string;
     protected ObjectConstructor: any;
     protected store: any;
-    protected cacheDb: any;
+    protected cacheDb: cacheDbEnum;
     constructor({ cache, store }?: {
-        cache?: any;
+        cache?: cacheDbEnum;
         store?: any;
     });
     loadOneFromDatabase(id: string): Promise<TObject>;

package/lib/core/shared/{repository.js → ObjectRepository.js}

@@ -42,15 +42,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Repository = void 0;
-const cacheDbEnum_1 = __importDefault(require("../cache/cacheDbEnum"));
+exports.ObjectRepository = void 0;
 const kerror = __importStar(require("../../kerror"));
-class Repository {
-    constructor({ cache = cacheDbEnum_1.default.INTERNAL, store = null } = {}) {
+const cacheDbEnum_1 = require("../cache/cacheDbEnum");
+class ObjectRepository {
+    constructor({ cache = cacheDbEnum_1.cacheDbEnum.INTERNAL, store = null } = {}) {
         this.ttl = global.kuzzle.config.repositories.common.cacheTTL;
         this.collection = null;
         this.ObjectConstructor = null;
@@ -133,7 +130,7 @@ class Repository {
             if (response === null) {
                 return null;
             }
-            return await this.fromDTO(Object.assign({}, JSON.parse(response)));
+            return await this.fromDTO({ ...JSON.parse(response) });
         }
         catch (err) {
             throw kerror.get("services", "cache", "read_failed", err.message);
@@ -156,7 +153,7 @@ class Repository {
      * @param options.key - Optional cache key
      */
     async load(id, options = {}) {
-        if (this.cacheDb === cacheDbEnum_1.default.NONE) {
+        if (this.cacheDb === cacheDbEnum_1.cacheDbEnum.NONE) {
             return this.loadOneFromDatabase(id);
         }
         const object = await this.loadFromCache(id, options);
@@ -195,7 +192,7 @@ class Repository {
      */
     async delete(object, options = {}) {
         const promises = [];
-        if (this.cacheDb !== cacheDbEnum_1.default.NONE) {
+        if (this.cacheDb !== cacheDbEnum_1.cacheDbEnum.NONE) {
             promises.push(this.deleteFromCache(object._id, options));
         }
         if (this.store) {
@@ -219,7 +216,7 @@ class Repository {
     async persistToCache(object, options = {}) {
         const key = options.key || this.getCacheKey(object._id);
         const value = JSON.stringify(this.serializeToCache(object));
-        const ttl = options.ttl !== undefined ? options.ttl : this.ttl;
+        const ttl = options.ttl ?? this.ttl;
         await global.kuzzle.ask(`core:cache:${this.cacheDb}:store`, key, value, {
             ttl,
         });
@@ -305,7 +302,7 @@ class Repository {
      * @returns {object}
      */
     toDTO(o) {
-        return Object.assign({}, o);
+        return { ...o };
     }
     /**
      * Recursively delete all objects in repository with a scroll
@@ -397,5 +394,5 @@ class Repository {
         return result;
     }
 }
-exports.Repository = Repository;
-//# sourceMappingURL=repository.js.map
+exports.ObjectRepository = ObjectRepository;
+//# sourceMappingURL=ObjectRepository.js.map

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

@@ -0,0 +1,51 @@
+import { StoreCollectionsDefinition } from "../../types";
+import { storeScopeEnum } from "../storage/storeScopeEnum";
+/**
+ * Wrapper around the document store.
+ * Once instantiated, this class can only access the index passed in the
+ * constructor
+ */
+export declare class Store {
+    count: (...args: any[]) => Promise<any>;
+    create: (...args: any[]) => Promise<any>;
+    createCollection: (...args: any[]) => Promise<any>;
+    createOrReplace: (...args: any[]) => Promise<any>;
+    delete: (...args: any[]) => Promise<any>;
+    deleteByQuery: (...args: any[]) => Promise<any>;
+    deleteCollection: (...args: any[]) => Promise<any>;
+    deleteFields: (...args: any[]) => Promise<any>;
+    deleteIndex: (...args: any[]) => Promise<any>;
+    exists: (...args: any[]) => Promise<any>;
+    get: (...args: any[]) => Promise<any>;
+    getMapping: (...args: any[]) => Promise<any>;
+    getSettings: (...args: any[]) => Promise<any>;
+    mExecute: (...args: any[]) => Promise<any>;
+    mGet: (...args: any[]) => Promise<any>;
+    multiSearch: (...args: any[]) => Promise<any>;
+    refreshCollection: (...args: any[]) => Promise<any>;
+    replace: (...args: any[]) => Promise<any>;
+    search: (...args: any[]) => Promise<any>;
+    scroll: (...args: any[]) => Promise<any>;
+    truncateCollection: (...args: any[]) => Promise<any>;
+    update: (...args: any[]) => Promise<any>;
+    updateByQuery: (...args: any[]) => Promise<any>;
+    updateCollection: (...args: any[]) => Promise<any>;
+    updateMapping: (...args: any[]) => Promise<any>;
+    protected index: string;
+    protected scope: storeScopeEnum;
+    constructor(index: string, scope: storeScopeEnum);
+    /**
+     * Initialize the index, and creates provided collections
+     */
+    init(collections?: StoreCollectionsDefinition): Promise<void>;
+    /**
+     * Creates collections with the provided mappings
+     *
+     * @param {Object} collections - collections with mappings
+     *
+     * @returns {Promise}
+     */
+    createCollections(collections: StoreCollectionsDefinition, { indexCacheOnly }?: {
+        indexCacheOnly?: boolean;
+    }): Promise<any>;
+}

package/lib/core/shared/store.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -18,209 +19,150 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-"use strict";
-
-const { Mutex } = require("../../util/mutex");
-const { promiseAllN } = require("../../util/async");
-const kerror = require("../../kerror");
-const { getESIndexDynamicSettings } = require("../../util/esRequest");
-
+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.Store = void 0;
+const kerror = __importStar(require("../../kerror"));
+const async_1 = require("../../util/async");
+const esRequest_1 = require("../../util/esRequest");
+const mutex_1 = require("../../util/mutex");
 /**
  * Wrapper around the document store.
  * Once instantiated, this class can only access the index passed in the
  * constructor
  */
 class Store {
-  /**
-   * @param {Kuzzle} kuzzle
-   * @param {String} index
-   * @param {storeScopeEnum} scope
-   */
-  constructor(index, scope) {
-    this.index = index;
-    this.scope = scope;
-
-    const methodsMapping = {
-      count: `core:storage:${scope}:document:count`,
-      create: `core:storage:${scope}:document:create`,
-      createCollection: `core:storage:${scope}:collection:create`,
-      createOrReplace: `core:storage:${scope}:document:createOrReplace`,
-      delete: `core:storage:${scope}:document:delete`,
-      deleteByQuery: `core:storage:${scope}:document:deleteByQuery`,
-      deleteCollection: `core:storage:${scope}:collection:delete`,
-      deleteFields: `core:storage:${scope}:document:deleteFields`,
-      deleteIndex: `core:storage:${scope}:index:delete`,
-      exists: `core:storage:${scope}:document:exist`,
-      get: `core:storage:${scope}:document:get`,
-      getMapping: `core:storage:${scope}:mappings:get`,
-      getSettings: `core:storage:${scope}:collection:settings:get`,
-      mExecute: `core:storage:${scope}:document:mExecute`,
-      mGet: `core:storage:${scope}:document:mGet`,
-      refreshCollection: `core:storage:${scope}:collection:refresh`,
-      replace: `core:storage:${scope}:document:replace`,
-      search: `core:storage:${scope}:document:search`,
-      truncateCollection: `core:storage:${scope}:collection:truncate`,
-      update: `core:storage:${scope}:document:update`,
-      updateByQuery: `core:storage:${scope}:document:updateByQuery`,
-      updateCollection: `core:storage:${scope}:collection:update`,
-      updateMapping: `core:storage:${scope}:mappings:update`,
-    };
-
-    for (const [method, event] of Object.entries(methodsMapping)) {
-      this[method] = (...args) => global.kuzzle.ask(event, this.index, ...args);
+    constructor(index, scope) {
+        this.index = index;
+        this.scope = scope;
+        const methodsMapping = {
+            count: `core:storage:${scope}:document:count`,
+            create: `core:storage:${scope}:document:create`,
+            createCollection: `core:storage:${scope}:collection:create`,
+            createOrReplace: `core:storage:${scope}:document:createOrReplace`,
+            delete: `core:storage:${scope}:document:delete`,
+            deleteByQuery: `core:storage:${scope}:document:deleteByQuery`,
+            deleteCollection: `core:storage:${scope}:collection:delete`,
+            deleteFields: `core:storage:${scope}:document:deleteFields`,
+            deleteIndex: `core:storage:${scope}:index:delete`,
+            exists: `core:storage:${scope}:document:exist`,
+            get: `core:storage:${scope}:document:get`,
+            getMapping: `core:storage:${scope}:mappings:get`,
+            getSettings: `core:storage:${scope}:collection:settings:get`,
+            mExecute: `core:storage:${scope}:document:mExecute`,
+            mGet: `core:storage:${scope}:document:mGet`,
+            refreshCollection: `core:storage:${scope}:collection:refresh`,
+            replace: `core:storage:${scope}:document:replace`,
+            search: `core:storage:${scope}:document:search`,
+            truncateCollection: `core:storage:${scope}:collection:truncate`,
+            update: `core:storage:${scope}:document:update`,
+            updateByQuery: `core:storage:${scope}:document:updateByQuery`,
+            updateCollection: `core:storage:${scope}:collection:update`,
+            updateMapping: `core:storage:${scope}:mappings:update`,
+        };
+        for (const [method, event] of Object.entries(methodsMapping)) {
+            this[method] = (...args) => global.kuzzle.ask(event, this.index, ...args);
+        }
+        // the scroll and multiSearch method are special: they doesn't need an index parameter
+        // we keep them for ease of use
+        this.scroll = (scrollId, opts) => global.kuzzle.ask(`core:storage:${scope}:document:scroll`, scrollId, opts);
+        this.multiSearch = (targets, searchBody, opts) => global.kuzzle.ask(`core:storage:${scope}:document:multiSearch`, targets, searchBody, opts);
     }
-
-    // the scroll and multiSearch method are special: they doesn't need an index parameter
-    // we keep them for ease of use
-    this.scroll = (scrollId, opts) =>
-      global.kuzzle.ask(
-        `core:storage:${scope}:document:scroll`,
-        scrollId,
-        opts,
-      );
-
-    this.multiSearch = (targets, searchBody, opts) =>
-      global.kuzzle.ask(
-        `core:storage:${scope}:document:multiSearch`,
-        targets,
-        searchBody,
-        opts,
-      );
-  }
-
-  /**
-   * Initialize the index, and creates provided collections
-   *
-   * @param {Object} collections - List of collections with mappings to create
-   *
-   * @returns {Promise}
-   */
-  async init(collections = {}) {
-    const creatingMutex = new Mutex(`Store.init(${this.index})`, {
-      timeout: 0,
-      ttl: 30000,
-    });
-
-    if (await creatingMutex.lock()) {
-      try {
-        await this.createCollections(collections, {
-          indexCacheOnly: false,
+    /**
+     * Initialize the index, and creates provided collections
+     */
+    async init(collections = {}) {
+        const creatingMutex = new mutex_1.Mutex(`Store.init(${this.index})`, {
+            timeout: 0,
+            ttl: 30000,
         });
-      } finally {
-        await creatingMutex.unlock();
-      }
-    } else {
-      await creatingMutex.wait({ timeout: -1 });
-
-      await this.createCollections(collections, {
-        indexCacheOnly: true,
-      });
-    }
-  }
-
-  /**
-   * Creates collections with the provided mappings
-   *
-   * @param {Object} collections - collections with mappings
-   *
-   * @returns {Promise}
-   */
-  createCollections(collections, { indexCacheOnly = false } = {}) {
-    return promiseAllN(
-      Object.entries(collections).map(([collection, config]) => async () => {
-        // @deprecated
-        if (!(config.mappings !== undefined && config.settings !== undefined)) {
-          // @deprecated
-          return global.kuzzle.ask(
-            `core:storage:${this.scope}:collection:create`,
-            this.index,
-            collection,
-            { mappings: config },
-            { indexCacheOnly },
-          );
+        if (await creatingMutex.lock()) {
+            try {
+                await this.createCollections(collections, {
+                    indexCacheOnly: false,
+                });
+            }
+            finally {
+                await creatingMutex.unlock();
+            }
         }
-
-        // @deprecated
-        const isConfigDeprecated =
-          config.settings.number_of_shards === undefined &&
-          config.settings.number_of_replicas === undefined;
-
-        if (indexCacheOnly) {
-          return global.kuzzle.ask(
-            `core:storage:${this.scope}:collection:create`,
-            this.index,
-            collection,
-            // @deprecated
-            isConfigDeprecated ? { mappings: config.mappings } : config,
-            { indexCacheOnly },
-          );
+        else {
+            await creatingMutex.wait({ timeout: -1 });
+            await this.createCollections(collections, {
+                indexCacheOnly: true,
+            });
         }
-
-        const exist = await global.kuzzle.ask(
-          `core:storage:${this.scope}:collection:exist`,
-          this.index,
-          collection,
-        );
-
-        if (exist) {
-          // @deprecated
-          const dynamicSettings = isConfigDeprecated
-            ? null
-            : getESIndexDynamicSettings(config.settings);
-
-          const existingSettings = await global.kuzzle.ask(
-            `core:storage:${this.scope}:collection:settings:get`,
-            this.index,
-            collection,
-          );
-
-          if (
-            !isConfigDeprecated &&
-            parseInt(existingSettings.number_of_shards) !==
-              config.settings.number_of_shards
-          ) {
-            if (global.NODE_ENV === "development") {
-              throw kerror.get(
-                "storage",
-                "wrong_collection_number_of_shards",
-                collection,
-                this.index,
-                this.scope,
-                "number_of_shards",
-                config.settings.number_of_shards,
-                existingSettings.number_of_shards,
-              );
+    }
+    /**
+     * Creates collections with the provided mappings
+     *
+     * @param {Object} collections - collections with mappings
+     *
+     * @returns {Promise}
+     */
+    createCollections(collections, { indexCacheOnly = false } = {}) {
+        return (0, async_1.promiseAllN)(Object.entries(collections).map(([collection, config]) => async () => {
+            // @deprecated
+            if (!(config.mappings !== undefined && config.settings !== undefined)) {
+                // @deprecated
+                return global.kuzzle.ask(`core:storage:${this.scope}:collection:create`, this.index, collection, { mappings: config }, { indexCacheOnly });
             }
-            global.kuzzle.log.warn(
-              `Attempt to recreate an existing collection ${collection} of index ${this.index} of scope ${this.scope} with non matching static setting : number_of_shards at ${config.settings.number_of_shards} while existing one is at ${existingSettings.number_of_shards}`,
-            );
-          }
-
-          return global.kuzzle.ask(
-            `core:storage:${this.scope}:collection:create`,
-            this.index,
-            collection,
             // @deprecated
-            isConfigDeprecated
-              ? { mappings: config.mappings }
-              : { mappings: config.mappings, settings: dynamicSettings },
-            { indexCacheOnly: true },
-          );
-        }
-
-        return global.kuzzle.ask(
-          `core:storage:${this.scope}:collection:create`,
-          this.index,
-          collection,
-          // @deprecated
-          isConfigDeprecated ? { mappings: config.mappings } : config,
-          { indexCacheOnly },
-        );
-      }),
-      10,
-    );
-  }
+            const isConfigDeprecated = config.settings.number_of_shards === undefined &&
+                config.settings.number_of_replicas === undefined;
+            if (indexCacheOnly) {
+                return global.kuzzle.ask(`core:storage:${this.scope}:collection:create`, this.index, collection, 
+                // @deprecated
+                isConfigDeprecated ? { mappings: config.mappings } : config, { indexCacheOnly });
+            }
+            const exist = await global.kuzzle.ask(`core:storage:${this.scope}:collection:exist`, this.index, collection);
+            if (exist) {
+                // @deprecated
+                const dynamicSettings = isConfigDeprecated
+                    ? null
+                    : (0, esRequest_1.getESIndexDynamicSettings)(config.settings);
+                const existingSettings = await global.kuzzle.ask(`core:storage:${this.scope}:collection:settings:get`, this.index, collection);
+                if (!isConfigDeprecated &&
+                    parseInt(existingSettings.number_of_shards) !==
+                        config.settings.number_of_shards) {
+                    if (global.NODE_ENV === "development") {
+                        throw kerror.get("storage", "wrong_collection_number_of_shards", collection, this.index, this.scope, "number_of_shards", config.settings.number_of_shards, existingSettings.number_of_shards);
+                    }
+                    global.kuzzle.log.warn(`Attempt to recreate an existing collection ${collection} of index ${this.index} of scope ${this.scope} with non matching static setting : number_of_shards at ${config.settings.number_of_shards} while existing one is at ${existingSettings.number_of_shards}`);
+                }
+                return global.kuzzle.ask(`core:storage:${this.scope}:collection:create`, this.index, collection, 
+                // @deprecated
+                isConfigDeprecated
+                    ? { mappings: config.mappings }
+                    : { mappings: config.mappings, settings: dynamicSettings }, { indexCacheOnly: true });
+            }
+            return global.kuzzle.ask(`core:storage:${this.scope}:collection:create`, this.index, collection, 
+            // @deprecated
+            isConfigDeprecated ? { mappings: config.mappings } : config, { indexCacheOnly });
+        }), 10);
+    }
 }
-
-module.exports = Store;
+exports.Store = Store;
+//# sourceMappingURL=store.js.map

package/lib/core/storage/storageEngine.js

@@ -25,15 +25,15 @@ const Bluebird = require("bluebird");
 
 const kerror = require("../../kerror").wrap("services", "storage");
 const ClientAdapter = require("./clientAdapter");
-const scopeEnum = require("./storeScopeEnum");
+const { storeScopeEnum } = require("./storeScopeEnum");
 
 class StorageEngine {
   constructor() {
     // Storage client for public indexes only
-    this.public = new ClientAdapter(scopeEnum.PUBLIC);
+    this.public = new ClientAdapter(storeScopeEnum.PUBLIC);
 
     // Storage client for private indexes only
-    this.private = new ClientAdapter(scopeEnum.PRIVATE);
+    this.private = new ClientAdapter(storeScopeEnum.PRIVATE);
   }
 
   /**

package/lib/core/storage/storeScopeEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Enum for the storage target (used by classes using either private or
+ * public indexes)
+ */
+export declare enum storeScopeEnum {
+    PRIVATE = "private",
+    PUBLIC = "public"
+}

package/lib/core/storage/storeScopeEnum.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -18,22 +19,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-"use strict";
-
-/**
- * @typedef {string} storeScopeEnum
- */
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storeScopeEnum = void 0;
 /**
  * Enum for the storage target (used by classes using either private or
  * public indexes)
- * @readOnly
- * @enum {storeScopeEnum}
  */
-const storeScopeEnum = Object.freeze({
-  PRIVATE: "private",
-  PUBLIC: "public",
-});
-
-module.exports = storeScopeEnum;
+var storeScopeEnum;
+(function (storeScopeEnum) {
+    storeScopeEnum["PRIVATE"] = "private";
+    storeScopeEnum["PUBLIC"] = "public";
+})(storeScopeEnum || (exports.storeScopeEnum = storeScopeEnum = {}));
+//# sourceMappingURL=storeScopeEnum.js.map

package/lib/kuzzle/internalIndexHandler.js

@@ -26,9 +26,9 @@ const crypto = require("crypto");
 const Bluebird = require("bluebird");
 
 const debug = require("../util/debug")("kuzzle:bootstrap:internalIndex");
-const Store = require("../core/shared/store");
+const { Store } = require("../core/shared/store");
 const { Mutex } = require("../util/mutex");
-const scopeEnum = require("../core/storage/storeScopeEnum");
+const { storeScopeEnum } = require("../core/storage/storeScopeEnum");
 const kerror = require("../kerror");
 
 const securitiesBootstrap = {
@@ -81,7 +81,7 @@ class InternalIndexHandler extends Store {
   constructor() {
     super(
       global.kuzzle.config.services.storageEngine.internalIndex.name,
-      scopeEnum.PRIVATE,
+      storeScopeEnum.PRIVATE,
     );
 
     this.timeout =

package/lib/service/storage/elasticsearch.d.ts

@@ -1,11 +1,11 @@
 import _ from "lodash";
 import { RequestParams, Client as StorageClient } from "@elastic/elasticsearch";
-import { KRequestBody, JSONObject, KRequestParams } from "../../types/storage/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 ESWrapper from "./esWrapper";
 import QueryTranslator from "./queryTranslator";
-import Service from "../service";
-import scopeEnum from "../../core/storage/storeScopeEnum";
 /**
  * @param {Kuzzle} kuzzle kuzzle instance
  * @param {Object} config Service configuration
@@ -14,7 +14,7 @@ import scopeEnum from "../../core/storage/storeScopeEnum";
  */
 export default class ElasticSearch extends Service {
     _client: StorageClient;
-    _scope: scopeEnum;
+    _scope: storeScopeEnum;
     _indexPrefix: string;
     _esWrapper: ESWrapper;
     _esVersion: any;
@@ -31,8 +31,8 @@ export default class ElasticSearch extends Service {
      * @returns {Object}
      */
     static buildClient(config: any): StorageClient;
-    constructor(config: any, scope?: any);
-    get scope(): scopeEnum;
+    constructor(config: any, scope?: storeScopeEnum);
+    get scope(): storeScopeEnum;
     /**
      * Initializes the elasticsearch client
      *

package/lib/service/storage/elasticsearch.js

@@ -49,21 +49,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = __importDefault(require("lodash"));
 const elasticsearch_1 = require("@elastic/elasticsearch");
 const assert_1 = __importDefault(require("assert"));
-const ms_1 = __importDefault(require("ms"));
 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 esWrapper_1 = __importDefault(require("./esWrapper"));
-const queryTranslator_1 = __importDefault(require("./queryTranslator"));
-const didYouMean_1 = __importDefault(require("../../util/didYouMean"));
-const service_1 = __importDefault(require("../service"));
+const storeScopeEnum_1 = require("../../core/storage/storeScopeEnum");
 const kerror = __importStar(require("../../kerror"));
-const requestAssertions_1 = require("../../util/requestAssertions");
-const safeObject_1 = require("../../util/safeObject");
-const storeScopeEnum_1 = __importDefault(require("../../core/storage/storeScopeEnum"));
+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 esWrapper_1 = __importDefault(require("./esWrapper"));
+const queryTranslator_1 = __importDefault(require("./queryTranslator"));
 (0, debug_1.default)("kuzzle:services:elasticsearch");
 const SCROLL_CACHE_PREFIX = "_docscroll_";
 const ROOT_MAPPING_PROPERTIES = [
@@ -117,11 +117,11 @@ class ElasticSearch extends service_1.default {
         };
         return new elasticsearch_1.Client({ defer, ...config });
     }
-    constructor(config, scope = storeScopeEnum_1.default.PUBLIC) {
+    constructor(config, scope = storeScopeEnum_1.storeScopeEnum.PUBLIC) {
         super("elasticsearch", config);
         this._scope = scope;
         this._indexPrefix =
-            scope === storeScopeEnum_1.default.PRIVATE ? PRIVATE_PREFIX : PUBLIC_PREFIX;
+            scope === storeScopeEnum_1.storeScopeEnum.PRIVATE ? PRIVATE_PREFIX : PUBLIC_PREFIX;
         this._client = null;
         this._esWrapper = null;
         this._esVersion = null;

package/lib/types/index.d.ts

@@ -1,39 +1,37 @@
-export * from "./Plugin";
 export * from "./Controller";
 export * from "./ControllerDefinition";
 export * from "./ControllerRights";
 export * from "./Deprecation";
 export * from "./EventHandler";
-export * from "./Policy";
-export * from "./PolicyRestrictions";
-export * from "./User";
-export * from "./Token";
-export * from "./Target";
 export * from "./Global";
 export * from "./HttpStream";
+export * from "./KuzzleDocument";
+export * from "./OpenApiDefinition";
 export * from "./PasswordPolicy";
+export * from "./Plugin";
+export * from "./Policy";
+export * from "./PolicyRestrictions";
+export * from "./ProfileDefinition";
+export * from "./RoleDefinition";
+export * from "./Target";
+export * from "./Token";
+export * from "./User";
+export * from "./config/DumpConfiguration";
+export * from "./config/HttpConfiguration";
 export * from "./config/KuzzleConfiguration";
+export * from "./config/LimitsConfiguration";
+export * from "./config/PluginsConfiguration";
+export * from "./config/SecurityConfiguration";
 export * from "./config/ServerConfiguration";
 export * from "./config/ServicesConfiguration";
-export * from "./config/SecurityConfiguration";
-export * from "./config/HttpConfiguration";
-export * from "./config/PluginsConfiguration";
-export * from "./RoleDefinition";
-export * from "./ProfileDefinition";
-export * from "./Plugin";
-export * from "./config/LimitsConfiguration";
-export * from "./RoleDefinition";
-export * from "./ProfileDefinition";
-export * from "./realtime/RealtimeScope";
-export * from "./realtime/RealtimeUsers";
-export * from "./realtime/RoomList";
-export * from "./KuzzleDocument";
-export * from "./config/publicCache/PublicCacheRedisConfiguration";
 export * from "./config/internalCache/InternalCacheRedisConfiguration";
+export * from "./config/publicCache/PublicCacheRedisConfiguration";
 export * from "./config/storageEngine/StorageEngineElasticsearchConfiguration";
-export * from "./config/DumpConfiguration";
-export * from "./OpenApiDefinition";
 export * from "./errors/ErrorDefinition";
 export * from "./errors/ErrorDomains";
 export * from "./events/EventGenericDocument";
 export * from "./events/EventProtocol";
+export * from "./realtime/RealtimeScope";
+export * from "./realtime/RealtimeUsers";
+export * from "./realtime/RoomList";
+export * from "./shared/StoreCollectionsDefinition";

package/lib/types/index.js

@@ -34,43 +34,41 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Plugin"), exports);
 __exportStar(require("./Controller"), exports);
 __exportStar(require("./ControllerDefinition"), exports);
 __exportStar(require("./ControllerRights"), exports);
 __exportStar(require("./Deprecation"), exports);
 __exportStar(require("./EventHandler"), exports);
-__exportStar(require("./Policy"), exports);
-__exportStar(require("./PolicyRestrictions"), exports);
-__exportStar(require("./User"), exports);
-__exportStar(require("./Token"), exports);
-__exportStar(require("./Target"), exports);
 __exportStar(require("./Global"), exports);
 __exportStar(require("./HttpStream"), exports);
+__exportStar(require("./KuzzleDocument"), exports);
+__exportStar(require("./OpenApiDefinition"), exports);
 __exportStar(require("./PasswordPolicy"), exports);
+__exportStar(require("./Plugin"), exports);
+__exportStar(require("./Policy"), exports);
+__exportStar(require("./PolicyRestrictions"), exports);
+__exportStar(require("./ProfileDefinition"), exports);
+__exportStar(require("./RoleDefinition"), exports);
+__exportStar(require("./Target"), exports);
+__exportStar(require("./Token"), exports);
+__exportStar(require("./User"), exports);
+__exportStar(require("./config/DumpConfiguration"), exports);
+__exportStar(require("./config/HttpConfiguration"), exports);
 __exportStar(require("./config/KuzzleConfiguration"), exports);
+__exportStar(require("./config/LimitsConfiguration"), exports);
+__exportStar(require("./config/PluginsConfiguration"), exports);
+__exportStar(require("./config/SecurityConfiguration"), exports);
 __exportStar(require("./config/ServerConfiguration"), exports);
 __exportStar(require("./config/ServicesConfiguration"), exports);
-__exportStar(require("./config/SecurityConfiguration"), exports);
-__exportStar(require("./config/HttpConfiguration"), exports);
-__exportStar(require("./config/PluginsConfiguration"), exports);
-__exportStar(require("./RoleDefinition"), exports);
-__exportStar(require("./ProfileDefinition"), exports);
-__exportStar(require("./Plugin"), exports);
-__exportStar(require("./config/LimitsConfiguration"), exports);
-__exportStar(require("./RoleDefinition"), exports);
-__exportStar(require("./ProfileDefinition"), exports);
-__exportStar(require("./realtime/RealtimeScope"), exports);
-__exportStar(require("./realtime/RealtimeUsers"), exports);
-__exportStar(require("./realtime/RoomList"), exports);
-__exportStar(require("./KuzzleDocument"), exports);
-__exportStar(require("./config/publicCache/PublicCacheRedisConfiguration"), exports);
 __exportStar(require("./config/internalCache/InternalCacheRedisConfiguration"), exports);
+__exportStar(require("./config/publicCache/PublicCacheRedisConfiguration"), exports);
 __exportStar(require("./config/storageEngine/StorageEngineElasticsearchConfiguration"), exports);
-__exportStar(require("./config/DumpConfiguration"), exports);
-__exportStar(require("./OpenApiDefinition"), exports);
 __exportStar(require("./errors/ErrorDefinition"), exports);
 __exportStar(require("./errors/ErrorDomains"), exports);
 __exportStar(require("./events/EventGenericDocument"), exports);
 __exportStar(require("./events/EventProtocol"), exports);
+__exportStar(require("./realtime/RealtimeScope"), exports);
+__exportStar(require("./realtime/RealtimeUsers"), exports);
+__exportStar(require("./realtime/RoomList"), exports);
+__exportStar(require("./shared/StoreCollectionsDefinition"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/shared/StoreCollectionsDefinition.d.ts

@@ -0,0 +1,12 @@
+import { JSONObject } from "../../../index";
+export interface StoreCollectionDefinition {
+    /**
+     * Collection mappings
+     */
+    mappings: JSONObject;
+    /**
+     * Collection settings
+     */
+    settings?: JSONObject;
+}
+export type StoreCollectionsDefinition = Record<string, StoreCollectionDefinition>;

package/lib/types/shared/StoreCollectionsDefinition.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.29.1",
+  "version": "2.30.0-beta.1",
   "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": {
@@ -21,9 +21,7 @@
     "test:functional:legacy": "npm run test:functional:legacy:http && npm run test:functional:legacy:websocket && npm run test:functional:legacy:mqtt",
     "test:functional:websocket": "KUZZLE_PROTOCOL=websocket cucumber-js --profile websocket",
     "test:functional": "npm run test:functional:http && npm run test:functional:websocket && npm run test:functional:jest",
-    "test:lint:js": "eslint ./lib ./test ./bin ./features ./plugins/available/functional-test-plugin",
-    "test:lint:ts": "eslint ./lib --ext .ts --config .eslintc-ts.json",
-    "test:lint": "npm run test:lint:js && npm run test:lint:ts",
+    "test:lint": "eslint ./lib ./test ./bin ./features ./plugins/available/functional-test-plugin",
     "test:unit": "DEBUG= npx --node-arg=--trace-warnings mocha --exit",
     "test": "npm run clean && npm run --silent test:lint && npm run build && npm run test:unit:coverage && npm run test:functional"
   },