kuzzle 2.59.0 → 2.60.0-beta.2

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

@@ -3,6 +3,7 @@ import type { estypes } from "sdk-es8";
 import { Client } from "sdk-es8";
 import type { AliasToTargets, CatAliasRecord, InfoResult, JSONObject, KImportError, KImportResult, KMExecuteResult, KRequestBody, KRequestParams, KStats, KUpdateResponse } from "../../../types/storage/8/Elasticsearch";
 import { storeScopeEnum } from "../../../core/storage/storeScopeEnum";
+import type { StorageEngineElasticsearch } from "../../../types/config/storageEngine/StorageEngineElasticsearchConfiguration";
 import type { ValidatedTarget } from "../../../types/Target";
 import { QueryTranslator } from "../commons/queryTranslator";
 import ESWrapper from "./esWrapper";
@@ -21,16 +22,16 @@ export declare class ES8 {
     _scope: storeScopeEnum;
     _indexPrefix: string;
     _esWrapper: ESWrapper;
-    _esVersion: any;
+    _esVersion: estypes.ElasticsearchVersionInfo | null;
     _translator: QueryTranslator;
     searchBodyKeys: string[];
     scriptKeys: string[];
     scriptAllowedArgs: string[];
     maxScrollDuration: number;
     scrollTTL: number;
-    _config: any;
+    _config: StorageEngineElasticsearch;
     private readonly logger;
-    constructor(config: any, scope?: storeScopeEnum);
+    constructor(config: StorageEngineElasticsearch, scope?: storeScopeEnum);
     get scope(): storeScopeEnum;
     /**
      * Initializes the elasticsearch client
@@ -72,20 +73,22 @@ export declare class ES8 {
     scroll(scrollId: string, { scrollTTL }?: {
         scrollTTL?: string;
     }): Promise<{
-        aggregations: any;
+        aggregations: Record<string, estypes.AggregationsAggregate> | undefined;
         hits: {
             _id: string | undefined;
             _score: number | null | undefined;
             _source: unknown;
-            collection: any;
+            collection: string | undefined;
             highlight: Record<string, string[]> | undefined;
-            index: any;
-            inner_hits: JSONObject | undefined;
+            index: string | undefined;
+            inner_hits: {
+                [k: string]: unknown[];
+            } | undefined;
         }[];
         remaining: number | undefined;
-        scrollId: any;
-        suggest: any;
-        total: any;
+        scrollId: string | undefined;
+        suggest: Record<string, estypes.SearchSuggest<unknown>[]> | undefined;
+        total: number;
     }>;
     /**
      * Searches documents from elasticsearch with a query
@@ -101,26 +104,28 @@ export declare class ES8 {
         index?: string;
         collection?: string;
         searchBody?: JSONObject;
-        targets?: any[];
+        targets?: ValidatedTarget[];
     }, { from, size, scroll, }?: {
         from?: number;
         size?: number;
         scroll?: string;
     }): Promise<{
-        aggregations: any;
+        aggregations: Record<string, estypes.AggregationsAggregate> | undefined;
         hits: {
             _id: string | undefined;
             _score: number | null | undefined;
             _source: unknown;
-            collection: any;
+            collection: string | undefined;
             highlight: Record<string, string[]> | undefined;
-            index: any;
-            inner_hits: JSONObject | undefined;
+            index: string | undefined;
+            inner_hits: {
+                [k: string]: unknown[];
+            } | undefined;
         }[];
         remaining: number | undefined;
-        scrollId: any;
-        suggest: any;
-        total: any;
+        scrollId: string | undefined;
+        suggest: Record<string, estypes.SearchSuggest<unknown>[]> | undefined;
+        total: number;
     }>;
     /**
      * The comma-separated alias list a multi-target search is run against.
@@ -135,21 +140,27 @@ export declare class ES8 {
      * @returns
      */
     _mapTargetsToAlias(targets: ValidatedTarget[]): AliasToTargets;
-    _formatSearchResult(body: any, remaining?: number, searchInfo?: any): Promise<{
-        aggregations: any;
+    _formatSearchResult(body: estypes.SearchResponse, remaining?: number, searchInfo?: {
+        collection?: string;
+        index?: string;
+        targets?: ValidatedTarget[];
+    }): Promise<{
+        aggregations: Record<string, estypes.AggregationsAggregate> | undefined;
         hits: {
             _id: string | undefined;
             _score: number | null | undefined;
             _source: unknown;
-            collection: any;
+            collection: string | undefined;
             highlight: Record<string, string[]> | undefined;
-            index: any;
-            inner_hits: JSONObject | undefined;
+            index: string | undefined;
+            inner_hits: {
+                [k: string]: unknown[];
+            } | undefined;
         }[];
         remaining: number | undefined;
-        scrollId: any;
-        suggest: any;
-        total: any;
+        scrollId: string | undefined;
+        suggest: Record<string, estypes.SearchSuggest<unknown>[]> | undefined;
+        total: number;
     }>;
     /**
      * Gets the document with given ID
@@ -346,7 +357,7 @@ export declare class ES8 {
      *
      * @returns {Promise.<{ _id, _version, _source }>}
      */
-    deleteFields(index: string, collection: string, id: string, fields: string, { refresh, userId, }?: {
+    deleteFields(index: string, collection: string, id: string, fields: string[], { refresh, userId, }?: {
         refresh?: boolean | "wait_for";
         userId?: string | null;
     }): Promise<{
@@ -401,10 +412,10 @@ export declare class ES8 {
      *
      * @returns {Promise.<any[]>} Array of results returned by the callback
      */
-    mExecute(index: string, collection: string, query: JSONObject, callback: any, { size, scrollTTl, }?: {
+    mExecute(index: string, collection: string, query: JSONObject, callback: (hits: estypes.SearchHit[]) => unknown, { size, scrollTTl, }?: {
         size?: number;
         scrollTTl?: string;
-    }): Promise<any>;
+    }): Promise<unknown[]>;
     /**
      * Creates a new index.
      *
@@ -430,7 +441,7 @@ export declare class ES8 {
      */
     createCollection(index: string, collection: string, { mappings, settings, }?: {
         mappings?: estypes.MappingTypeMapping;
-        settings?: Record<string, any>;
+        settings?: estypes.IndicesIndexSettings;
     }): Promise<null>;
     /**
      * Retrieves settings definition for index/type
@@ -469,7 +480,7 @@ export declare class ES8 {
     updateCollection(index: string, collection: string, { mappings, reindexCollection, settings, }?: {
         mappings?: estypes.MappingTypeMapping;
         reindexCollection?: boolean;
-        settings?: Record<string, any>;
+        settings?: estypes.IndicesIndexSettings;
     }): Promise<null>;
     /**
      * Given index settings we return a new version of index settings
@@ -477,8 +488,8 @@ export declare class ES8 {
      * @param indexSettings the index settings
      * @returns {{index: *}} a new index settings with only allowed settings.
      */
-    getAllowedIndexSettings(indexSettings: JSONObject): {
-        index: _.Omit<any, "version" | "creation_date" | "provided_name" | "uuid">;
+    getAllowedIndexSettings(indexSettings: estypes.IndicesIndexSettings | undefined): {
+        index: _.Omit<estypes.IndicesIndexSettings, "version" | "creation_date" | "provided_name" | "uuid">;
     };
     /**
      * Sends an empty UpdateByQuery request to update the search index
@@ -594,7 +605,7 @@ export declare class ES8 {
      *
      * @returns {Promise.<String[]>}
      */
-    deleteIndexes(indexes?: string[]): Promise<unknown[]>;
+    deleteIndexes(indexes?: string[]): Promise<string[]>;
     /**
      * Deletes an index
      *
@@ -677,7 +688,7 @@ export declare class ES8 {
      *
      * @returns {Promise.<Object>} { items, errors }
      */
-    mCreate(index: string, collection: string, documents: JSON[], { refresh, timeout, userId, }?: {
+    mCreate(index: string, collection: string, documents: JSONObject[], { refresh, timeout, userId, }?: {
         refresh?: boolean | "wait_for";
         timeout?: string;
         userId?: string | null;
@@ -850,7 +861,7 @@ export declare class ES8 {
      * @return {Promise<*>} the settings of the indice.
      * @private
      */
-    _getSettings(esRequest: estypes.IndicesGetSettingsRequest): Promise<any>;
+    _getSettings(esRequest: estypes.IndicesGetSettingsRequest): Promise<estypes.IndicesIndexSettings | undefined>;
     /**
      * Given index + collection, returns an available indice name.
      * Use this function when creating the associated indice. Otherwise use `_getAlias`.

package/dist/lib/service/storage/8/elasticsearch.js

@@ -35,13 +35,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -57,7 +67,7 @@ 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 distributedLock_1 = require("../../../util/distributedLock");
 const name_generator_1 = require("../../../util/name-generator");
 const requestAssertions_1 = require("../../../util/requestAssertions");
 const safeObject_1 = require("../../../util/safeObject");
@@ -73,6 +83,12 @@ const ROOT_MAPPING_PROPERTIES = [
 const CHILD_MAPPING_PROPERTIES = ["type"];
 // Used for collection emulation
 const HIDDEN_COLLECTION = "_kuzzle_keep";
+// The hidden collection locks wait for as long as it takes, as the `Mutex`
+// they replace did: they guard a collection creation, which must not fail
+// only because another request on the same index got there first. The lock
+// is refreshed while held, so a live holder is never overtaken; a crashed
+// one leaves it for at most `ttl` (30 s).
+const HIDDEN_COLLECTION_LOCK = { retryAttempts: Number.POSITIVE_INFINITY };
 const ALIAS_PREFIX = "@"; // @todo next major release: Add ALIAS_PREFIX in FORBIDDEN_CHARS
 const PRIVATE_PREFIX = "%";
 const PUBLIC_PREFIX = "&";
@@ -192,7 +208,7 @@ class ES8 {
     async info() {
         const result = {
             type: "elasticsearch",
-            version: this._esVersion,
+            version: this._esVersion?.number ?? "",
         };
         try {
             const info = await this._client.info();
@@ -223,7 +239,6 @@ class ES8 {
         const indexes = {};
         let size = 0;
         for (const [indice, indiceInfo] of Object.entries(stats.indices ?? {})) {
-            const infos = indiceInfo;
             // Ignore non-Kuzzle indices, and the ones Kuzzle must leave alone
             if ((!indice.startsWith(PRIVATE_PREFIX) &&
                 !indice.startsWith(PUBLIC_PREFIX)) ||
@@ -243,13 +258,15 @@ class ES8 {
                 name: indexName,
                 size: 0,
             }));
+            // Both are there: the request asks for the `docs` and `store` metrics.
+            const sizeInBytes = indiceInfo.total?.store?.size_in_bytes ?? 0;
             indexStats.collections.push({
-                documentCount: infos.total.docs.count,
+                documentCount: indiceInfo.total?.docs?.count ?? 0,
                 name: collectionName,
-                size: infos.total.store.size_in_bytes,
+                size: sizeInBytes,
             });
-            indexStats.size += infos.total.store.size_in_bytes;
-            size += infos.total.store.size_in_bytes;
+            indexStats.size += sizeInBytes;
+            size += sizeInBytes;
         }
         return {
             indexes: Object.values(indexes),
@@ -456,11 +473,11 @@ class ES8 {
             if (!innerHits) {
                 return undefined;
             }
-            const formattedInnerHits = {};
-            for (const [name, innerHit] of Object.entries(innerHits)) {
-                formattedInnerHits[name] = await bluebird_1.default.map(innerHit.hits.hits, formatHit);
-            }
-            return formattedInnerHits;
+            const formatted = await Promise.all(Object.entries(innerHits).map(async ([name, innerHit]) => [
+                name,
+                await bluebird_1.default.map(innerHit.hits.hits, formatHit),
+            ]));
+            return Object.fromEntries(formatted);
         }
         const hits = await bluebird_1.default.map(body.hits.hits, async (hit) => ({
             inner_hits: await formatInnerHits(hit.inner_hits),
@@ -472,7 +489,7 @@ class ES8 {
             remaining,
             scrollId: body._scroll_id,
             suggest: body.suggest,
-            total: body.hits.total.value,
+            total: this._getHitsTotalValue(body.hits),
         };
     }
     /**
@@ -1139,19 +1156,6 @@ class ES8 {
         if (collection === HIDDEN_COLLECTION) {
             throw kerror.get("services", "storage", "collection_reserved", HIDDEN_COLLECTION);
         }
-        const mutex = new mutex_1.Mutex(`hiddenCollection/create/${index}`);
-        try {
-            await mutex.lock();
-            if (await this._hasHiddenCollection(index)) {
-                await this.deleteCollection(index, HIDDEN_COLLECTION);
-            }
-        }
-        catch (error) {
-            throw this._esWrapper.formatESError(error);
-        }
-        finally {
-            await mutex.unlock();
-        }
         const esRequest = {
             aliases: {
                 [this._getAlias(index, collection)]: {},
@@ -1190,6 +1194,19 @@ class ES8 {
             }
             throw this._esWrapper.formatESError(error);
         }
+        // Only once the real collection exists: dropping the placeholder first
+        // would leave the index with no indice at all if the creation failed.
+        // Lock and ES errors alike reach the caller through `formatESError`
+        try {
+            await (0, distributedLock_1.withLock)(`hiddenCollection/create/${index}`, async () => {
+                if (await this._hasHiddenCollection(index)) {
+                    await this.deleteCollection(index, HIDDEN_COLLECTION);
+                }
+            }, HIDDEN_COLLECTION_LOCK);
+        }
+        catch (error) {
+            throw this._esWrapper.formatESError(error);
+        }
         return null;
     }
     /**
@@ -1302,7 +1319,7 @@ class ES8 {
      */
     getAllowedIndexSettings(indexSettings) {
         return {
-            index: lodash_1.default.omit(indexSettings.index, [
+            index: lodash_1.default.omit(indexSettings?.index, [
                 "creation_date",
                 "provided_name",
                 "uuid",
@@ -1651,7 +1668,11 @@ class ES8 {
                     name: alias,
                 });
             }
-            await this._createHiddenCollection(index);
+            // `createCollection` drops the placeholder through here: recreating it
+            // would undo that.
+            if (collection !== HIDDEN_COLLECTION) {
+                await this._createHiddenCollection(index);
+            }
         }
         catch (e) {
             throw this._esWrapper.formatESError(e);
@@ -2666,31 +2687,28 @@ class ES8 {
      * @param {String} index Index name
      */
     async _createHiddenCollection(index) {
-        const mutex = new mutex_1.Mutex(`hiddenCollection/${index}`);
         try {
-            await mutex.lock();
-            if (await this._hasHiddenCollection(index)) {
-                return;
-            }
-            const esRequest = {
-                aliases: {
-                    [this._getAlias(index, HIDDEN_COLLECTION)]: {},
-                },
-                index: await this._getAvailableIndice(index, HIDDEN_COLLECTION),
-                settings: {
-                    number_of_replicas: this._config.defaultSettings.number_of_replicas,
-                    number_of_shards: this._config.defaultSettings.number_of_shards,
-                },
-                wait_for_active_shards: await this._getWaitForActiveShards(),
-            };
-            await this._client.indices.create(esRequest);
+            await (0, distributedLock_1.withLock)(`hiddenCollection/${index}`, async () => {
+                if (await this._hasHiddenCollection(index)) {
+                    return;
+                }
+                const esRequest = {
+                    aliases: {
+                        [this._getAlias(index, HIDDEN_COLLECTION)]: {},
+                    },
+                    index: await this._getAvailableIndice(index, HIDDEN_COLLECTION),
+                    settings: {
+                        number_of_replicas: this._config.defaultSettings.number_of_replicas,
+                        number_of_shards: this._config.defaultSettings.number_of_shards,
+                    },
+                    wait_for_active_shards: await this._getWaitForActiveShards(),
+                };
+                await this._client.indices.create(esRequest);
+            }, HIDDEN_COLLECTION_LOCK);
         }
         catch (e) {
             throw this._esWrapper.formatESError(e);
         }
-        finally {
-            await mutex.unlock();
-        }
     }
     /**
      * We need to always wait for a minimal number of shards to be available

package/dist/lib/service/storage/Elasticsearch.d.ts

@@ -1,10 +1,16 @@
+import { Client as ClientES7 } from "sdk-es7";
+import { Client as ClientES8 } from "sdk-es8";
+import { ES7 } from "./7/elasticsearch";
+import { ES8 } from "./8/elasticsearch";
 import Service from "../service";
 import { storeScopeEnum } from "../../core/storage/storeScopeEnum";
-export declare class Elasticsearch extends Service {
-    client: any;
+import type { JSONObject } from "../../types/JSONObject";
+import type { StorageEngineElasticsearch } from "../../types/config/storageEngine/StorageEngineElasticsearchConfiguration";
+export declare class Elasticsearch extends Service<StorageEngineElasticsearch> {
+    client: ES7 | ES8;
     private readonly logger;
-    constructor(config: any, scope?: storeScopeEnum);
-    static buildClient(config: any, version?: "7" | "8"): any;
+    constructor(config: StorageEngineElasticsearch, scope?: storeScopeEnum);
+    static buildClient(config: JSONObject, version?: "7" | "8"): ClientES7 | ClientES8;
     _initSequence(): Promise<void>;
     init(): Promise<void>;
 }

package/dist/lib/types/HttpStream.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { Readable } from "stream";
 export type HttpStreamProperties = {
     totalBytes?: number;

package/dist/lib/types/Plugin.js

@@ -35,13 +35,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Plugin = void 0;
 const kerror = __importStar(require("../kerror"));

package/dist/lib/types/config/SecurityConfiguration.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { JSONObject } from "../JSONObject";
 import type { RoleDefinition, ProfileDefinition } from "../index";
 export type SecurityConfiguration = {

package/dist/lib/types/config/storageEngine/StorageEngineElasticsearchConfiguration.d.ts

@@ -40,6 +40,11 @@ export type StorageEngineElasticsearch = {
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/7.4/dynamic-mapping.html
      */
     commonMapping: {
+        /**
+         * Collection metadata applied to a new collection whose mappings carry
+         * none of their own. Not in the defaults.
+         */
+        _meta?: Record<string, unknown>;
         /**
          * @default "false"
          */

package/dist/lib/types/controllers/GetCurrentUserResponse.d.ts

@@ -0,0 +1,5 @@
+import type { User } from "../../model/security/user";
+import type { Serialized } from "../core/auth/Serialized";
+export type GetCurrentUserResponse = Serialized<User> & {
+    strategies: any;
+};

package/dist/lib/types/controllers/GetCurrentUserResponse.js

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

package/dist/lib/types/controllers/ResetSecurityResult.d.ts

@@ -0,0 +1,5 @@
+export type ResetSecurityResult = {
+    deletedUsers?: (event: string, ...args: any[]) => Promise<any>;
+    deletedProfiles?: (event: string, ...args: any[]) => Promise<any>;
+    deletedRoles?: (event: string, ...args: any[]) => Promise<any>;
+};

package/dist/lib/types/controllers/ResetSecurityResult.js

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

package/dist/lib/types/controllers/adminController.type.d.ts

@@ -1,5 +1,7 @@
-export type ResetSecurityResult = {
-    deletedUsers?: (event: string, ...args: any[]) => Promise<any>;
-    deletedProfiles?: (event: string, ...args: any[]) => Promise<any>;
-    deletedRoles?: (event: string, ...args: any[]) => Promise<any>;
-};
+/**
+ * @deprecated Moved to `./ResetSecurityResult` when `lib/types/` settled on
+ * PascalCase file names (TD-08). Kept so that deep imports of the published
+ * `dist/lib/...` path keep compiling; removed in v3
+ * (docs/v3-breaking-changes.md).
+ */
+export type { ResetSecurityResult } from "./ResetSecurityResult";

package/dist/lib/types/controllers/authController.type.d.ts

@@ -1,5 +1,7 @@
-import type { User } from "../../model/security/user";
-import type { Serialized } from "../core/auth/formatProcessing.type";
-export type GetCurrentUserResponse = Serialized<User> & {
-    strategies: any;
-};
+/**
+ * @deprecated Moved to `./GetCurrentUserResponse` when `lib/types/` settled on
+ * PascalCase file names (TD-08). Kept so that deep imports of the published
+ * `dist/lib/...` path keep compiling; removed in v3
+ * (docs/v3-breaking-changes.md).
+ */
+export type { GetCurrentUserResponse } from "./GetCurrentUserResponse";

package/dist/lib/types/core/auth/Serialized.d.ts

@@ -0,0 +1,14 @@
+import type { JSONObject } from "../../JSONObject";
+/**
+ * What `formatProcessing` can serialize: anything carrying an id. The id is
+ * nullable because the security models are — they carry `null` until they have
+ * been stored (ADR-0001, TD-62) — and `Serialized` echoes back whichever it
+ * has rather than widening it for everyone.
+ */
+export type Serializable = {
+    _id: string | null;
+};
+export type Serialized<T extends Serializable> = {
+    _id: T["_id"];
+    _source: JSONObject;
+};

package/dist/lib/types/core/auth/Serialized.js

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

package/dist/lib/types/core/auth/formatProcessing.type.d.ts

@@ -1,13 +1,7 @@
 /**
- * What `formatProcessing` can serialize: anything carrying an id. The id is
- * nullable because the security models are — they carry `null` until they have
- * been stored (ADR-0001, TD-62) — and `Serialized` echoes back whichever it
- * has rather than widening it for everyone.
+ * @deprecated Moved to `./Serialized` when `lib/types/` settled on PascalCase
+ * file names (TD-08). Kept so that deep imports of the published
+ * `dist/lib/...` path keep compiling; removed in v3
+ * (docs/v3-breaking-changes.md).
  */
-export type Serializable = {
-    _id: string | null;
-};
-export type Serialized<T extends Serializable> = {
-    _id: T["_id"];
-    _source: Record<string, any>;
-};
+export type { Serializable, Serialized } from "./Serialized";

package/dist/lib/types/events/EventProtocol.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { JSONObject } from "../JSONObject";
 import type { PipeEventHandler } from "../../../index";
 import type { ClientConnection } from "../ClientConnection";

package/dist/lib/types/index.d.ts

@@ -9,6 +9,7 @@ export * from "./Global";
 export * from "./HttpMessage";
 export * from "./HttpStream";
 export * from "./JSONObject";
+export * from "./Kuzzle";
 export * from "./KuzzleDocument";
 export * from "./OpenApiDefinition";
 export * from "./PasswordPolicy";

package/dist/lib/types/index.js

@@ -45,6 +45,7 @@ __exportStar(require("./Global"), exports);
 __exportStar(require("./HttpMessage"), exports);
 __exportStar(require("./HttpStream"), exports);
 __exportStar(require("./JSONObject"), exports);
+__exportStar(require("./Kuzzle"), exports);
 __exportStar(require("./KuzzleDocument"), exports);
 __exportStar(require("./OpenApiDefinition"), exports);
 __exportStar(require("./PasswordPolicy"), exports);