kuzzle 2.56.0 → 2.57.0-beta.2

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

@@ -1,7 +1,9 @@
 import _ from "lodash";
-import { Client, RequestParams } from "sdk-es7";
-import { TypeMapping } from "sdk-es7/api/types";
-import { InfoResult, JSONObject, KRequestBody, KRequestParams } from "../../../types/storage/7/Elasticsearch";
+import type { RequestParams } from "sdk-es7";
+import { Client } from "sdk-es7";
+import type { TypeMapping } from "sdk-es7/api/types";
+import type { AliasToTargets, CatAliasRecord, InfoResult, JSONObject, KImportError, KImportResult, KMExecuteResult, KRequestBody, KRequestParams } from "../../../types/storage/7/Elasticsearch";
+import type { ValidatedTarget } from "../../../types/Target";
 import { storeScopeEnum } from "../../../core/storage/storeScopeEnum";
 import { QueryTranslator } from "../commons/queryTranslator";
 import ESWrapper from "./esWrapper";
@@ -12,6 +14,10 @@ import ESWrapper from "./esWrapper";
  * @constructor
  */
 export declare class ES7 {
+    /**
+     * Built by `init()`, and read nowhere before it — the `null` the constructor
+     * used to write was never observed. See TD-62.
+     */
     _client: Client;
     _scope: storeScopeEnum;
     _indexPrefix: string;
@@ -40,7 +46,7 @@ export declare class ES7 {
      * @param {Object} filters - Set of valid Koncorde filters
      * @returns {Object} Equivalent Elasticsearch query
      */
-    translateKoncordeFilters(filters: any): any;
+    translateKoncordeFilters(filters: JSONObject): any;
     /**
      * Returns some basic information about this service
      * @override
@@ -54,7 +60,11 @@ export declare class ES7 {
      * @returns {Promise.<Object>}
      */
     stats(): Promise<{
-        indexes: unknown[];
+        indexes: {
+            collections: JSONObject[];
+            name: string;
+            size: number;
+        }[];
         size: number;
     }>;
     /**
@@ -78,7 +88,7 @@ export declare class ES7 {
             collection: any;
             highlight: any;
             index: any;
-            inner_hits: {};
+            inner_hits: JSONObject | undefined;
         }[];
         remaining: any;
         scrollId: any;
@@ -113,20 +123,26 @@ export declare class ES7 {
             collection: any;
             highlight: any;
             index: any;
-            inner_hits: {};
+            inner_hits: JSONObject | undefined;
         }[];
         remaining: any;
         scrollId: any;
         suggest: any;
         total: any;
     }>;
+    /**
+     * The comma-separated alias list a multi-target search is run against.
+     *
+     * @param targets - targets already through `assertTargetsAreValid`
+     */
+    _targetsToIndexes(targets: ValidatedTarget[]): string;
     /**
      * Generate a map that associate an alias to a pair of index and collection
      *
      * @param {*} targets
      * @returns
      */
-    _mapTargetsToAlias(targets: any): {};
+    _mapTargetsToAlias(targets: ValidatedTarget[]): AliasToTargets;
     _formatSearchResult(body: any, searchInfo?: any): Promise<{
         aggregations: any;
         hits: {
@@ -136,7 +152,7 @@ export declare class ES7 {
             collection: any;
             highlight: any;
             index: any;
-            inner_hits: {};
+            inner_hits: JSONObject | undefined;
         }[];
         remaining: any;
         scrollId: any;
@@ -152,7 +168,7 @@ export declare class ES7 {
      *
      * @returns {Promise.<{ _id, _version, _source }>}
      */
-    get(index: any, collection: any, id: any): Promise<any>;
+    get(index: string, collection: string, id: string): Promise<any>;
     /**
      * Returns the list of documents matching the ids given in the body param
      * NB: Due to internal Kuzzle mechanism, can only be called on a single
@@ -166,12 +182,11 @@ export declare class ES7 {
      */
     mGet(index: string, collection: string, ids: string[]): Promise<{
         errors: any[];
-        item: any[];
-        items?: undefined;
-    } | {
-        errors: any[];
-        items: any[];
-        item?: undefined;
+        items: {
+            _id: any;
+            _source: any;
+            _version: any;
+        }[];
     }>;
     /**
      * Counts how many documents match the filter given in body
@@ -197,7 +212,7 @@ export declare class ES7 {
     create(index: string, collection: string, content: JSONObject, { id, refresh, userId, injectKuzzleMeta, }?: {
         id?: string;
         refresh?: boolean | "wait_for";
-        userId?: string;
+        userId?: string | null;
         injectKuzzleMeta?: boolean;
     }): Promise<{
         _id: any;
@@ -215,13 +230,13 @@ export declare class ES7 {
      *
      * @returns {Promise.<Object>} { _id, _version, _source, created }
      */
-    createOrReplace(index: any, collection: any, id: any, content: any, { refresh, userId, injectKuzzleMeta, }?: {
+    createOrReplace(index: string, collection: string, id: string, content: JSONObject, { refresh, userId, injectKuzzleMeta, }?: {
         refresh?: boolean | "wait_for";
-        userId?: string;
+        userId?: string | null;
         injectKuzzleMeta?: boolean;
     }): Promise<{
         _id: any;
-        _source: any;
+        _source: JSONObject;
         _version: any;
         created: boolean;
     }>;
@@ -238,7 +253,7 @@ export declare class ES7 {
      */
     update(index: string, collection: string, id: string, content: JSONObject, { refresh, userId, retryOnConflict, injectKuzzleMeta, }?: {
         refresh?: boolean | "wait_for";
-        userId?: string;
+        userId?: string | null;
         retryOnConflict?: number;
         injectKuzzleMeta?: boolean;
     }): Promise<{
@@ -261,7 +276,7 @@ export declare class ES7 {
     upsert(index: string, collection: string, id: string, content: JSONObject, { defaultValues, refresh, userId, retryOnConflict, injectKuzzleMeta, }?: {
         defaultValues?: JSONObject;
         refresh?: boolean | "wait_for";
-        userId?: string;
+        userId?: string | null;
         retryOnConflict?: number;
         injectKuzzleMeta?: boolean;
     }): Promise<{
@@ -283,7 +298,7 @@ export declare class ES7 {
      */
     replace(index: string, collection: string, id: string, content: JSONObject, { refresh, userId, injectKuzzleMeta, }?: {
         refresh?: boolean | "wait_for";
-        userId?: string;
+        userId?: string | null;
         injectKuzzleMeta?: boolean;
     }): Promise<{
         _id: string;
@@ -302,7 +317,7 @@ export declare class ES7 {
      */
     delete(index: string, collection: string, id: string, { refresh, }?: {
         refresh?: boolean | "wait_for";
-    }): Promise<any>;
+    }): Promise<null>;
     /**
      * Deletes all documents matching the provided filters.
      * If fetch=false, the max documents write limit is not applied.
@@ -325,7 +340,7 @@ export declare class ES7 {
         fetch?: boolean;
     }): Promise<{
         deleted: any;
-        documents: any[];
+        documents: any;
         failures: any;
         total: any;
     }>;
@@ -342,7 +357,7 @@ export declare class ES7 {
      */
     deleteFields(index: string, collection: string, id: string, fields: string, { refresh, userId, }?: {
         refresh?: boolean | "wait_for";
-        userId?: string;
+        userId?: string | null;
     }): Promise<{
         _id: string;
         _source: any;
@@ -362,10 +377,10 @@ export declare class ES7 {
     updateByQuery(index: string, collection: string, query: JSONObject, changes: JSONObject, { refresh, size, userId, }?: {
         refresh?: boolean | "wait_for";
         size?: number;
-        userId?: string;
+        userId?: string | null;
     }): Promise<{
-        errors: any;
-        successes: any;
+        errors: JSONObject[];
+        successes: JSONObject[];
     }>;
     /**
      * Updates all documents matching the provided filters
@@ -411,7 +426,7 @@ export declare class ES7 {
      *
      * @returns {Promise}
      */
-    createIndex(index: string): Promise<any>;
+    createIndex(index: string): Promise<null>;
     /**
      * Creates an empty collection.
      * Mappings and settings will be applied if supplied.
@@ -425,7 +440,7 @@ export declare class ES7 {
     createCollection(index: string, collection: string, { mappings, settings, }?: {
         mappings?: TypeMapping;
         settings?: Record<string, any>;
-    }): Promise<any>;
+    }): Promise<null>;
     /**
      * Retrieves settings definition for index/type
      *
@@ -464,14 +479,14 @@ export declare class ES7 {
         mappings?: TypeMapping;
         reindexCollection?: boolean;
         settings?: Record<string, any>;
-    }): Promise<any>;
+    }): Promise<null>;
     /**
      * Given index settings we return a new version of index settings
      * only with allowed settings that can be set (during update or create index).
      * @param indexSettings the index settings
      * @returns {{index: *}} a new index settings with only allowed settings.
      */
-    getAllowedIndexSettings(indexSettings: any): {
+    getAllowedIndexSettings(indexSettings: JSONObject): {
         index: _.Omit<any, "version" | "creation_date" | "provided_name" | "uuid">;
     };
     /**
@@ -505,7 +520,7 @@ export declare class ES7 {
      *
      * @returns {Promise}
      */
-    updateSettings(index: any, collection: any, settings?: {}): Promise<any>;
+    updateSettings(index: string, collection: string, settings?: JSONObject): Promise<null>;
     /**
      * Empties the content of a collection. Keep the existing mapping and settings.
      *
@@ -514,7 +529,7 @@ export declare class ES7 {
      *
      * @returns {Promise}
      */
-    truncateCollection(index: string, collection: string): Promise<any>;
+    truncateCollection(index: string, collection: string): Promise<null>;
     /**
      * Runs several action and document
      *
@@ -528,11 +543,16 @@ export declare class ES7 {
     import(index: string, collection: string, documents: JSONObject[], { refresh, timeout, userId, }?: {
         refresh?: boolean | "wait_for";
         timeout?: string;
-        userId?: string;
-    }): Promise<{
-        errors: any[];
-        items: any[];
-    }>;
+        userId?: string | null;
+    }): Promise<KImportResult>;
+    /**
+     * The error entry `import` reports for one rejected bulk row.
+     *
+     * @param action - the bulk action Elasticsearch echoed back
+     * @param item - that action's answer
+     * @param payload - the action's payload, absent for a delete
+     */
+    _importError(action: string, item: JSONObject, payload: JSONObject | undefined): KImportError;
     /**
      * Retrieves the complete list of existing collections in the current index
      *
@@ -541,9 +561,9 @@ export declare class ES7 {
      *
      * @returns {Promise.<Array>} Collection names
      */
-    listCollections(index: any, { includeHidden }?: {
-        includeHidden?: boolean;
-    }): Promise<any>;
+    listCollections(index: string, { includeHidden }?: {
+        includeHidden?: boolean | undefined;
+    }): Promise<string[]>;
     /**
      * Retrieves the complete list of indexes
      *
@@ -555,13 +575,18 @@ export declare class ES7 {
      *
      * @returns {Object.<String, String[]>} Object<index, collections>
      */
-    getSchema(): Promise<{}>;
+    getSchema(): Promise<Record<string, string[]>>;
     /**
      * Retrieves the complete list of aliases
      *
      * @returns {Promise.<Object[]>} [ { alias, index, collection, indice } ]
      */
-    listAliases(): Promise<any[]>;
+    listAliases(): Promise<{
+        alias: string;
+        collection: string;
+        index: string;
+        indice: string;
+    }[]>;
     /**
      * Deletes a collection
      *
@@ -570,7 +595,7 @@ export declare class ES7 {
      *
      * @returns {Promise}
      */
-    deleteCollection(index: string, collection: string): Promise<void>;
+    deleteCollection(index: string, collection: string): Promise<null>;
     /**
      * Deletes multiple indexes
      *
@@ -578,7 +603,7 @@ export declare class ES7 {
      *
      * @returns {Promise.<String[]>}
      */
-    deleteIndexes(indexes?: string[]): Promise<any[]>;
+    deleteIndexes(indexes?: string[]): Promise<unknown[]>;
     /**
      * Deletes an index
      *
@@ -586,7 +611,7 @@ export declare class ES7 {
      *
      * @returns {Promise}
      */
-    deleteIndex(index: string): Promise<void>;
+    deleteIndex(index: string): Promise<null>;
     /**
      * Forces a refresh on the collection.
      *
@@ -623,13 +648,8 @@ export declare class ES7 {
      * @returns {Promise.<{ items: Array<{ _id, _source, _version }>, errors }>}
      */
     mExists(index: string, collection: string, ids: string[]): Promise<{
-        errors: any[];
-        item: any[];
-        items?: undefined;
-    } | {
         errors: any[];
         items: any[];
-        item?: undefined;
     }>;
     /**
      * Returns true if the index exists
@@ -655,7 +675,7 @@ export declare class ES7 {
      *
      * @returns {Promise.<boolean>}
      */
-    _hasHiddenCollection(index: any): Promise<any>;
+    _hasHiddenCollection(index: string): Promise<boolean>;
     /**
      * Creates multiple documents at once.
      * If a content has no id, one is automatically generated and assigned to it.
@@ -671,8 +691,8 @@ export declare class ES7 {
     mCreate(index: string, collection: string, documents: JSON[], { refresh, timeout, userId, }?: {
         refresh?: boolean | "wait_for";
         timeout?: string;
-        userId?: string;
-    }): Promise<any>;
+        userId?: string | null;
+    }): Promise<KMExecuteResult>;
     /**
      * Creates or replaces multiple documents at once.
      *
@@ -683,7 +703,7 @@ export declare class ES7 {
      *
      * @returns {Promise.<{ items, errors }>
      */
-    mCreateOrReplace(index: string, collection: string, documents: JSONObject[], { refresh, timeout, userId, injectKuzzleMeta, limits, source, }?: KRequestParams): Promise<any>;
+    mCreateOrReplace(index: string, collection: string, documents: JSONObject[], { refresh, timeout, userId, injectKuzzleMeta, limits, source, }?: KRequestParams): Promise<KMExecuteResult>;
     /**
      * Updates multiple documents with one request
      * Replacements are rejected if targeted documents do not exist
@@ -697,11 +717,11 @@ export declare class ES7 {
      * @returns {Promise.<Object>} { items, errors }
      */
     mUpdate(index: string, collection: string, documents: JSONObject[], { refresh, retryOnConflict, timeout, userId, }?: {
-        refresh?: any;
+        refresh?: boolean | "wait_for";
         retryOnConflict?: number;
-        timeout?: any;
-        userId?: any;
-    }): Promise<any>;
+        timeout?: string;
+        userId?: string | null;
+    }): Promise<KMExecuteResult>;
     /**
      * Creates or replaces multiple documents at once.
      *
@@ -716,8 +736,8 @@ export declare class ES7 {
         refresh?: boolean | "wait_for";
         retryOnConflict?: number;
         timeout?: string;
-        userId?: string;
-    }): Promise<any>;
+        userId?: string | null;
+    }): Promise<KMExecuteResult>;
     /**
      * Replaces multiple documents at once.
      * Replacements are rejected if targeted documents do not exist
@@ -733,8 +753,8 @@ export declare class ES7 {
     mReplace(index: string, collection: string, documents: JSONObject[], { refresh, timeout, userId, }?: {
         refresh?: boolean | "wait_for";
         timeout?: string;
-        userId?: string;
-    }): Promise<any>;
+        userId?: string | null;
+    }): Promise<KMExecuteResult>;
     /**
      * Deletes multiple documents with one request
      *
@@ -749,8 +769,16 @@ export declare class ES7 {
         refresh?: boolean | "wait_for";
         timeout?: number;
     }): Promise<{
-        documents: any[];
-        errors: any[];
+        documents: any;
+        errors: ({
+            _id: undefined;
+            reason: string;
+            status: number;
+        } | {
+            _id: string;
+            reason: string;
+            status: number;
+        })[];
     }>;
     /**
      * Executes an ES request prepared by mcreate, mupdate, mreplace, mdelete or mwriteDocuments
@@ -765,9 +793,16 @@ export declare class ES7 {
      * @returns {Promise.<Object[]>} results
      */
     _mExecute(esRequest: RequestParams.Bulk, documents: JSONObject[], partialErrors?: JSONObject[], { limits, source }?: {
-        limits?: boolean;
-        source?: boolean;
-    }): Promise<any>;
+        limits?: boolean | undefined;
+        source?: boolean | undefined;
+    }): Promise<KMExecuteResult>;
+    /**
+     * The partial-error entry `_mExecute` reports for one rejected bulk row.
+     *
+     * A 404 answers no reason of its own, and reports the document by id and
+     * body rather than whole, which is what the m* callers read back.
+     */
+    _mExecuteRejection(result: JSONObject, document: JSONObject): JSONObject;
     /**
      * Extracts, injects metadata and validates documents contained
      * in a Request
@@ -781,13 +816,13 @@ export declare class ES7 {
      * @returns {Object} { rejected, extractedDocuments, documentsToGet }
      */
     _extractMDocuments(documents: JSONObject[], metadata: JSONObject, { prepareMGet, requireId, prepareMUpsert }?: {
-        prepareMGet?: boolean;
-        requireId?: boolean;
-        prepareMUpsert?: boolean;
+        prepareMGet?: boolean | undefined;
+        requireId?: boolean | undefined;
+        prepareMUpsert?: boolean | undefined;
     }): {
-        documentsToGet: any[];
-        extractedDocuments: any[];
-        rejected: any[];
+        documentsToGet: JSONObject[];
+        extractedDocuments: JSONObject[];
+        rejected: JSONObject[];
     };
     private _hasExceededLimit;
     private _processExtract;
@@ -797,7 +832,7 @@ export declare class ES7 {
      * @param {Object} mapping
      * @throws
      */
-    _checkMappings(mapping: JSONObject, path?: any[], check?: boolean): void;
+    _checkMappings(mapping: JSONObject, path?: string[], check?: boolean): void;
     /**
      * Given index + collection, returns the associated alias name.
      * Prefer this function to `_getIndice` and `_getAvailableIndice` whenever it is possible.
@@ -807,11 +842,11 @@ export declare class ES7 {
      *
      * @returns {String} Alias name (eg: '@&nepali.liia')
      */
-    _getAlias(index: any, collection: any): string;
+    _getAlias(index: string, collection?: string): string;
     /**
      * Given an alias name, returns the associated index name.
      */
-    _checkIfAliasExists(aliasName: any): Promise<boolean>;
+    _checkIfAliasExists(aliasName: string): Promise<boolean>;
     /**
      * Given index + collection, returns the associated indice name.
      * Use this function if ES does not accept aliases in the request. Otherwise use `_getAlias`.
@@ -849,7 +884,15 @@ export declare class ES7 {
      * @returns {String} Alias name (eg: '@&nepali.liia')
      * @throws If there is not exactly one alias associated that is prefixed with @
      */
-    _getAliasFromIndice(indice: string): Promise<string[]>;
+    /**
+     * `cat.aliases` answers untyped rows whose `alias` and `index` the client
+     * declares as optional. Defaulting them once here is what lets every caller
+     * index into an alias without repeating the check — and an empty alias fails
+     * the index-prefix test every caller applies, which is what a row without one
+     * used to throw on.
+     */
+    _catAliases(name?: string): Promise<CatAliasRecord[]>;
+    _getAliasFromIndice(indice: string): Promise<[string, ...string[]]>;
     /**
      * Check for each indice whether it has an alias or not.
      * When the latter is missing, create one based on the indice name.
@@ -864,7 +907,7 @@ export declare class ES7 {
      * @param {String} index
      * @param {String} collection
      */
-    _assertValidIndexAndCollection(index: any, collection?: any): void;
+    _assertValidIndexAndCollection(index: string, collection?: string | null): void;
     /**
      * Given an alias, extract the associated index.
      *
@@ -872,7 +915,7 @@ export declare class ES7 {
      *
      * @returns {String} Index name
      */
-    _extractIndex(alias: any): any;
+    _extractIndex(alias: string): string;
     /**
      * Given an alias, extract the associated collection.
      *
@@ -880,7 +923,7 @@ export declare class ES7 {
      *
      * @returns {String} Collection name
      */
-    _extractCollection(alias: any): any;
+    _extractCollection(alias: string): string;
     /**
      * Given aliases, extract indexes and collections.
      *
@@ -890,15 +933,15 @@ export declare class ES7 {
      * @returns {Object.<String, String[]>} Indexes as key and an array of their collections as value
      */
     _extractSchema(aliases: string[], { includeHidden }?: {
-        includeHidden?: boolean;
-    }): {};
+        includeHidden?: boolean | undefined;
+    }): Record<string, string[]>;
     /**
      * Creates the hidden collection on the provided index if it does not already
      * exists
      *
      * @param {String} index Index name
      */
-    _createHiddenCollection(index: any): Promise<void>;
+    _createHiddenCollection(index: string): Promise<void>;
     /**
      * We need to always wait for a minimal number of shards to be available
      * before answering to the client. This is to avoid Elasticsearch node
@@ -924,7 +967,7 @@ export declare class ES7 {
      *
      * @param {Object} searchBody - ES search body (with query, aggregations, sort, etc)
      */
-    _sanitizeSearchBody(searchBody: any): any;
+    _sanitizeSearchBody(searchBody?: JSONObject): JSONObject;
     /**
      * Throw if a script is used in the query.
      *
@@ -932,19 +975,19 @@ export declare class ES7 {
      *
      * @param {Object} object
      */
-    _scriptCheck(object: any): void;
+    _scriptCheck(object: JSONObject): void;
     /**
      * Checks if a collection name is valid
      * @param  {string}  name
      * @returns {Boolean}
      */
-    isCollectionNameValid(name: any): boolean;
+    isCollectionNameValid(name: string): boolean;
     /**
      * Checks if a collection name is valid
      * @param  {string}  name
      * @returns {Boolean}
      */
-    isIndexNameValid(name: any): boolean;
+    isIndexNameValid(name: string): boolean;
     /**
      * Clears an allocated scroll
      * @param  {[type]} id [description]
@@ -959,17 +1002,17 @@ export declare class ES7 {
      *
      * @returns {Number} milliseconds
      */
-    _loadMsConfig(key: any): number;
+    _loadMsConfig(key: string): number;
     /**
      * Returns true if one of the mappings dynamic property changes value from
      * false to true
      */
-    _dynamicChanges(previousMappings: any, newMappings: any): boolean;
+    _dynamicChanges(previousMappings: JSONObject, newMappings: JSONObject): boolean;
     waitForElasticsearch(): Promise<void>;
     /**
      * Checks if the dynamic properties are correct
      */
-    _checkDynamicProperty(mappings: any): void;
+    _checkDynamicProperty(mappings: JSONObject): void;
     _setLastActionToKuzzleMeta(esRequest: JSONObject, alias: string, kuzzleMeta: JSONObject): void;
     _setLastActionToKuzzleMetaUpdate(item: JSONObject, kuzzleMeta: JSONObject): void;
     _getRandomNumber(number: number): number;