kuzzle-sdk 7.10.7 → 7.11.0-beta.1

package/dist/kuzzle.js.LICENSE.txt

@@ -1 +1 @@
-/*! Kuzzle Javascript SDK version 7.10.7 */
+/*! Kuzzle Javascript SDK version 7.11.0-beta.1 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "7.10.7",
+  "version": "7.11.0-beta.1",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "repository": {
@@ -38,21 +38,30 @@
   "license": "Apache-2.0",
   "dependencies": {
     "min-req-promise": "^1.0.1",
-    "ws": "^8.8.1"
+    "ws": "^8.13.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.13",
-    "@babel/preset-env": "^7.18.10",
-    "@types/node": "^18.7.14",
-    "babel-loader": "^8.2.5",
+    "@commitlint/cli": "^17.6.7",
+    "@commitlint/config-conventional": "^17.6.7",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^10.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/release-notes-generator": "^11.0.4",
+    "@babel/core": "^7.21.4",
+    "@babel/preset-env": "^7.21.4",
+    "@types/node": "^18.15.11",
+    "babel-loader": "^8.3.0",
     "buffer": "^6.0.3",
     "codecov": "^3.8.3",
     "cucumber": "^6.0.5",
+    "semantic-release-config-kuzzle": "^1.0.0",
+    "semantic-release-slack-bot": "^4.0.2",
+    "cz-conventional-changelog": "^3.3.0",
     "eslint-plugin-kuzzle": "^0.0.6",
     "https-browserify": "^1.0.0",
     "lodash": "^4.17.21",
     "lolex": "^6.0.0",
-    "mocha": "10.0.0",
+    "mocha": "10.2.0",
     "mock-require": "^3.0.3",
     "nyc": "^15.1.0",
     "proxyquire": "^2.1.3",
@@ -60,13 +69,13 @@
     "rewire": "^6.0.0",
     "should": "13.2.3",
     "should-sinon": "0.0.6",
-    "sinon": "^14.0.0",
+    "sinon": "^14.0.2",
     "stream-http": "^3.2.0",
     "ts-morph": "^15.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.2",
+    "typescript": "^4.9.5",
     "url": "^0.11.0",
-    "webpack": "^5.74.0",
+    "webpack": "^5.79.0",
     "webpack-cli": "^4.10.0"
   },
   "engines": {

package/src/controllers/Auth.d.ts

@@ -320,7 +320,7 @@ export interface ArgsAuthControllerCreateApiKey extends ArgsDefault {
     expiresIn?: number;
     refresh?: "wait_for" | "false";
 }
-export declare type ArgsAuthControllerCheckRights = ArgsDefault;
+export type ArgsAuthControllerCheckRights = ArgsDefault;
 export interface ArgsAuthControllerDeleteApiKey extends ArgsDefault {
     refresh?: "wait_for" | "false";
 }
@@ -329,17 +329,17 @@ export interface ArgsAuthControllerSearchApiKeys extends ArgsDefault {
     size?: number;
     lang?: string;
 }
-export declare type ArgsAuthControllerCheckToken = ArgsDefault;
-export declare type ArgsAuthControllerCreateMyCredentials = ArgsDefault;
-export declare type ArgsAuthControllerCredentialsExist = ArgsDefault;
-export declare type ArgsAuthControllerDeleteMyCredentials = ArgsDefault;
-export declare type ArgsAuthControllerGetCurrentUser = ArgsDefault;
-export declare type ArgsAuthControllerGetMyCredentials = ArgsDefault;
-export declare type ArgsAuthControllerGetMyRights = ArgsDefault;
-export declare type ArgsAuthControllerGetStrategies = ArgsDefault;
-export declare type ArgsAuthControllerUpdateMyCredentials = ArgsDefault;
-export declare type ArgsAuthControllerUpdateSelf = ArgsDefault;
-export declare type ArgsAuthControllerValidateMyCredentials = ArgsDefault;
+export type ArgsAuthControllerCheckToken = ArgsDefault;
+export type ArgsAuthControllerCreateMyCredentials = ArgsDefault;
+export type ArgsAuthControllerCredentialsExist = ArgsDefault;
+export type ArgsAuthControllerDeleteMyCredentials = ArgsDefault;
+export type ArgsAuthControllerGetCurrentUser = ArgsDefault;
+export type ArgsAuthControllerGetMyCredentials = ArgsDefault;
+export type ArgsAuthControllerGetMyRights = ArgsDefault;
+export type ArgsAuthControllerGetStrategies = ArgsDefault;
+export type ArgsAuthControllerUpdateMyCredentials = ArgsDefault;
+export type ArgsAuthControllerUpdateSelf = ArgsDefault;
+export type ArgsAuthControllerValidateMyCredentials = ArgsDefault;
 export interface ArgsAuthControllerRefreshToken extends ArgsDefault {
     expiresIn?: number | string;
 }

package/src/controllers/Bulk.d.ts

@@ -167,7 +167,7 @@ export declare class BulkController extends BaseController {
 export interface ArgsBulkControllerDeleteByQuery extends ArgsDefault {
     refresh?: "wait_for" | "false";
 }
-export declare type ArgsBulkControllerImport = ArgsDefault;
+export type ArgsBulkControllerImport = ArgsDefault;
 export interface ArgsBulkControllerUpdateByQuery extends ArgsDefault {
     refresh?: "wait_for" | "false";
 }

package/src/controllers/Collection.d.ts

@@ -225,14 +225,14 @@ export declare class CollectionController extends BaseController {
      */
     delete(index: string, collection: string, options?: ArgsCollectionControllerDelete): Promise<void>;
 }
-export declare type ArgsCollectionControllerCreate = ArgsDefault;
-export declare type ArgsCollectionControllerDeleteSpecifications = ArgsDefault;
-export declare type ArgsCollectionControllerExists = ArgsDefault;
-export declare type ArgsCollectionControllerRefresh = ArgsDefault;
+export type ArgsCollectionControllerCreate = ArgsDefault;
+export type ArgsCollectionControllerDeleteSpecifications = ArgsDefault;
+export type ArgsCollectionControllerExists = ArgsDefault;
+export type ArgsCollectionControllerRefresh = ArgsDefault;
 export interface ArgsCollectionControllerGetMapping extends ArgsDefault {
     includeKuzzleMeta?: boolean;
 }
-export declare type ArgsCollectionControllerGetSpecifications = ArgsDefault;
+export type ArgsCollectionControllerGetSpecifications = ArgsDefault;
 export interface ArgsCollectionControllerList extends ArgsDefault {
     from?: number;
     size?: number;
@@ -242,9 +242,9 @@ export interface ArgsCollectionControllerSearchSpecifications extends ArgsDefaul
     size?: number;
     scroll?: string;
 }
-export declare type ArgsCollectionControllerTruncate = ArgsDefault;
-export declare type ArgsCollectionControllerUpdate = ArgsDefault;
-export declare type ArgsCollectionControllerUpdateMapping = ArgsDefault;
-export declare type ArgsCollectionControllerUpdateSpecifications = ArgsDefault;
-export declare type ArgsCollectionControllerValidateSpecifications = ArgsDefault;
-export declare type ArgsCollectionControllerDelete = ArgsDefault;
+export type ArgsCollectionControllerTruncate = ArgsDefault;
+export type ArgsCollectionControllerUpdate = ArgsDefault;
+export type ArgsCollectionControllerUpdateMapping = ArgsDefault;
+export type ArgsCollectionControllerUpdateSpecifications = ArgsDefault;
+export type ArgsCollectionControllerValidateSpecifications = ArgsDefault;
+export type ArgsCollectionControllerDelete = ArgsDefault;

package/src/controllers/Document.d.ts

@@ -413,7 +413,7 @@ export declare class DocumentController extends BaseController {
      */
     validate<TKDocumentContent extends KDocumentContentGeneric>(index: string, collection: string, content: TKDocumentContent, options?: ArgsDocumentControllerValidate): Promise<boolean>;
 }
-export declare type ArgsDocumentControllerCount = ArgsDefault;
+export type ArgsDocumentControllerCount = ArgsDefault;
 export interface ArgsDocumentControllerCreate extends ArgsDefault {
     refresh?: "wait_for" | "false";
     silent?: boolean;
@@ -509,4 +509,4 @@ export interface ArgsDocumentControllerUpsert<TKDocumentContent> extends ArgsDef
     retryOnConflict?: boolean;
     source?: boolean;
 }
-export declare type ArgsDocumentControllerValidate = ArgsDefault;
+export type ArgsDocumentControllerValidate = ArgsDefault;

package/src/controllers/Index.d.ts

@@ -69,9 +69,9 @@ export declare class IndexController extends BaseController {
      */
     stats(options?: ArgsIndexControllerStats): Promise<JSONObject>;
 }
-export declare type ArgsIndexControllerCreate = ArgsDefault;
-export declare type ArgsIndexControllerDelete = ArgsDefault;
-export declare type ArgsIndexControllerExists = ArgsDefault;
-export declare type ArgsIndexControllerList = ArgsDefault;
-export declare type ArgsIndexControllerMDelete = ArgsDefault;
-export declare type ArgsIndexControllerStats = ArgsDefault;
+export type ArgsIndexControllerCreate = ArgsDefault;
+export type ArgsIndexControllerDelete = ArgsDefault;
+export type ArgsIndexControllerExists = ArgsDefault;
+export type ArgsIndexControllerList = ArgsDefault;
+export type ArgsIndexControllerMDelete = ArgsDefault;
+export type ArgsIndexControllerStats = ArgsDefault;

package/src/controllers/Realtime.d.ts

@@ -120,7 +120,7 @@ export declare class RealtimeController extends BaseController {
      */
     private removeSubscriptions;
 }
-export declare type ArgsRealtimeControllerCount = ArgsDefault;
+export type ArgsRealtimeControllerCount = ArgsDefault;
 export interface ArgsRealtimeControllerPublish extends ArgsDefault {
     _id?: string;
 }
@@ -130,4 +130,4 @@ export interface ArgsRealtimeControllerSubscribe extends ArgsDefault {
     subscribeToSelf?: boolean;
     volatile?: JSONObject;
 }
-export declare type ArgsRealtimeControllerUnsubscribe = ArgsDefault;
+export type ArgsRealtimeControllerUnsubscribe = ArgsDefault;

package/src/controllers/Security.d.ts

@@ -99,7 +99,7 @@ export interface ArgsSecurityControllerCreateApiKey extends ArgsDefault {
     _id?: string;
     refresh?: "wait_for" | "false";
 }
-export declare type ArgsSecurityControllerCheckRights = ArgsDefault;
+export type ArgsSecurityControllerCheckRights = ArgsDefault;
 export interface ArgsSecurityControllerDeleteApiKey extends ArgsDefault {
     refresh?: "wait_for" | "false";
 }
@@ -108,55 +108,55 @@ export interface ArgsSecurityControllerSearchApiKeys extends ArgsDefault {
     size?: number;
     lang?: string;
 }
-export declare type ArgsSecurityControllerCreateCredentials = ArgsDefault;
+export type ArgsSecurityControllerCreateCredentials = ArgsDefault;
 export interface ArgsSecurityControllerCreateFirstAdmin extends ArgsDefault {
     reset?: boolean;
 }
-export declare type ArgsSecurityControllerCreateOrReplaceProfile = ArgsDefault;
+export type ArgsSecurityControllerCreateOrReplaceProfile = ArgsDefault;
 export interface ArgsSecurityControllerCreateOrReplaceRole extends ArgsDefault {
     force?: boolean;
 }
-export declare type ArgsSecurityControllerCreateProfile = ArgsDefault;
-export declare type ArgsSecurityControllerCreateRestrictedUser = ArgsDefault;
+export type ArgsSecurityControllerCreateProfile = ArgsDefault;
+export type ArgsSecurityControllerCreateRestrictedUser = ArgsDefault;
 export interface ArgsSecurityControllerCreateRole extends ArgsDefault {
     force?: boolean;
 }
-export declare type ArgsSecurityControllerCreateUser = ArgsDefault;
-export declare type ArgsSecurityControllerDeleteCredentials = ArgsDefault;
-export declare type ArgsSecurityControllerDeleteProfile = ArgsDefault;
-export declare type ArgsSecurityControllerDeleteRole = ArgsDefault;
-export declare type ArgsSecurityControllerDeleteUser = ArgsDefault;
-export declare type ArgsSecurityControllerGetAllCredentialFields = ArgsDefault;
-export declare type ArgsSecurityControllerGetCredentialFields = ArgsDefault;
-export declare type ArgsSecurityControllerGetCredentials = ArgsDefault;
-export declare type ArgsSecurityControllerGetCredentialsById = ArgsDefault;
-export declare type ArgsSecurityControllerGetProfile = ArgsDefault;
-export declare type ArgsSecurityControllerGetProfileMapping = ArgsDefault;
-export declare type ArgsSecurityControllerGetProfileRights = ArgsDefault;
-export declare type ArgsSecurityControllerGetRole = ArgsDefault;
-export declare type ArgsSecurityControllerGetRoleMapping = ArgsDefault;
-export declare type ArgsSecurityControllerGetUser = ArgsDefault;
-export declare type ArgsSecurityControllerGetUserMapping = ArgsDefault;
-export declare type ArgsSecurityControllerGetUserRights = ArgsDefault;
-export declare type ArgsSecurityControllerGetUserStrategies = ArgsDefault;
-export declare type ArgsSecurityControllerHasCredentials = ArgsDefault;
-export declare type ArgsSecurityControllerMDeleteProfiles = ArgsDefault;
-export declare type ArgsSecurityControllerMDeleteRoles = ArgsDefault;
-export declare type ArgsSecurityControllerMDeleteUsers = ArgsDefault;
-export declare type ArgsSecurityControllerMGetProfiles = ArgsDefault;
-export declare type ArgsSecurityControllerMGetUsers = ArgsDefault;
-export declare type ArgsSecurityControllerMGetRoles = ArgsDefault;
-export declare type ArgsSecurityControllerReplaceUser = ArgsDefault;
-export declare type ArgsSecurityControllerSearchProfiles = ArgsDefault;
-export declare type ArgsSecurityControllerSearchRoles = ArgsDefault;
-export declare type ArgsSecurityControllerSearchUsers = ArgsDefault;
-export declare type ArgsSecurityControllerUpdateCredentials = ArgsDefault;
-export declare type ArgsSecurityControllerUpdateProfile = ArgsDefault;
-export declare type ArgsSecurityControllerUpdateProfileMapping = ArgsDefault;
+export type ArgsSecurityControllerCreateUser = ArgsDefault;
+export type ArgsSecurityControllerDeleteCredentials = ArgsDefault;
+export type ArgsSecurityControllerDeleteProfile = ArgsDefault;
+export type ArgsSecurityControllerDeleteRole = ArgsDefault;
+export type ArgsSecurityControllerDeleteUser = ArgsDefault;
+export type ArgsSecurityControllerGetAllCredentialFields = ArgsDefault;
+export type ArgsSecurityControllerGetCredentialFields = ArgsDefault;
+export type ArgsSecurityControllerGetCredentials = ArgsDefault;
+export type ArgsSecurityControllerGetCredentialsById = ArgsDefault;
+export type ArgsSecurityControllerGetProfile = ArgsDefault;
+export type ArgsSecurityControllerGetProfileMapping = ArgsDefault;
+export type ArgsSecurityControllerGetProfileRights = ArgsDefault;
+export type ArgsSecurityControllerGetRole = ArgsDefault;
+export type ArgsSecurityControllerGetRoleMapping = ArgsDefault;
+export type ArgsSecurityControllerGetUser = ArgsDefault;
+export type ArgsSecurityControllerGetUserMapping = ArgsDefault;
+export type ArgsSecurityControllerGetUserRights = ArgsDefault;
+export type ArgsSecurityControllerGetUserStrategies = ArgsDefault;
+export type ArgsSecurityControllerHasCredentials = ArgsDefault;
+export type ArgsSecurityControllerMDeleteProfiles = ArgsDefault;
+export type ArgsSecurityControllerMDeleteRoles = ArgsDefault;
+export type ArgsSecurityControllerMDeleteUsers = ArgsDefault;
+export type ArgsSecurityControllerMGetProfiles = ArgsDefault;
+export type ArgsSecurityControllerMGetUsers = ArgsDefault;
+export type ArgsSecurityControllerMGetRoles = ArgsDefault;
+export type ArgsSecurityControllerReplaceUser = ArgsDefault;
+export type ArgsSecurityControllerSearchProfiles = ArgsDefault;
+export type ArgsSecurityControllerSearchRoles = ArgsDefault;
+export type ArgsSecurityControllerSearchUsers = ArgsDefault;
+export type ArgsSecurityControllerUpdateCredentials = ArgsDefault;
+export type ArgsSecurityControllerUpdateProfile = ArgsDefault;
+export type ArgsSecurityControllerUpdateProfileMapping = ArgsDefault;
 export interface ArgsSecurityControllerUpdateRole extends ArgsDefault {
     force?: boolean;
 }
-export declare type ArgsSecurityControllerUpdateRoleMapping = ArgsDefault;
-export declare type ArgsSecurityControllerUpdateUser = ArgsDefault;
-export declare type ArgsSecurityControllerUpdateUserMapping = ArgsDefault;
-export declare type ArgsSecurityControllerValidateCredentials = ArgsDefault;
+export type ArgsSecurityControllerUpdateRoleMapping = ArgsDefault;
+export type ArgsSecurityControllerUpdateUser = ArgsDefault;
+export type ArgsSecurityControllerUpdateUserMapping = ArgsDefault;
+export type ArgsSecurityControllerValidateCredentials = ArgsDefault;

package/src/controllers/Server.d.ts

@@ -68,10 +68,10 @@ export declare class ServerController extends BaseController {
      */
     now(options: ArgsServerControllerNow): Promise<any>;
 }
-export declare type ArgsServerControllerAdminExists = ArgsDefault;
-export declare type ArgsServerControllerGetAllStats = ArgsDefault;
-export declare type ArgsServerControllerGetConfig = ArgsDefault;
-export declare type ArgsServerControllerGetLastStats = ArgsDefault;
-export declare type ArgsServerControllerGetStats = ArgsDefault;
-export declare type ArgsServerControllerInfo = ArgsDefault;
-export declare type ArgsServerControllerNow = ArgsDefault;
+export type ArgsServerControllerAdminExists = ArgsDefault;
+export type ArgsServerControllerGetAllStats = ArgsDefault;
+export type ArgsServerControllerGetConfig = ArgsDefault;
+export type ArgsServerControllerGetLastStats = ArgsDefault;
+export type ArgsServerControllerGetStats = ArgsDefault;
+export type ArgsServerControllerInfo = ArgsDefault;
+export type ArgsServerControllerNow = ArgsDefault;

package/src/core/KuzzleEventEmitter.d.ts

@@ -1,10 +1,10 @@
-declare type ListenerFunction = (...args: unknown[]) => unknown;
-export declare type PublicKuzzleEvents = "callbackError" | "connected" | "discarded" | "disconnected" | "loginAttempt" | "logoutAttempt" | "networkError" | "offlineQueuePush" | "offlineQueuePop" | "queryError" | "reAuthenticated" | "reconnected" | "reconnectionError" | "tokenExpired";
-declare type PrivateKuzzleEvents = "connect" | "reconnect" | "disconnect" | "offlineQueuePush" | "websocketRenewalStart" | "websocketRenewalDone";
+type ListenerFunction = (...args: unknown[]) => unknown;
+export type PublicKuzzleEvents = "callbackError" | "connected" | "discarded" | "disconnected" | "loginAttempt" | "logoutAttempt" | "networkError" | "offlineQueuePush" | "offlineQueuePop" | "queryError" | "reAuthenticated" | "reconnected" | "reconnectionError" | "tokenExpired";
+type PrivateKuzzleEvents = "connect" | "reconnect" | "disconnect" | "offlineQueuePush" | "websocketRenewalStart" | "websocketRenewalDone";
 /**
  * For internal use only
  */
-export declare type PrivateAndPublicSDKEvents = PublicKuzzleEvents | PrivateKuzzleEvents;
+export type PrivateAndPublicSDKEvents = PublicKuzzleEvents | PrivateKuzzleEvents;
 /**
  * @todo proper TS conversion
  */

package/src/core/Observer.d.ts

@@ -3,7 +3,7 @@ import { RealtimeDocument } from "./RealtimeDocument";
 import { JSONObject, KDocument, KDocumentContentGeneric } from "../types";
 import { RealtimeDocumentSearchResult } from "./searchResult/RealtimeDocument";
 import { ArgsDocumentControllerGet, ArgsDocumentControllerMGet, ArgsDocumentControllerSearch } from "../controllers/Document";
-export declare type ObserverOptions = {
+export type ObserverOptions = {
     /**
      * Refresh delay in ms when the SDK is using the HTTP protocol.
      *

package/src/core/Observer.js

@@ -10,15 +10,6 @@ const RealtimeDocument_2 = require("./searchResult/RealtimeDocument");
  * @internal
  */
 class ObservedDocuments extends Set {
-    constructor(index, collection) {
-        super();
-        /**
-         * Room ID for the realtime subscription on the collection of observed documents
-         */
-        this.roomId = null;
-        this.index = index;
-        this.collection = collection;
-    }
     /**
      * Gets documents IDs
      */
@@ -33,6 +24,15 @@ class ObservedDocuments extends Set {
             ids: { values: Array.from(this.values()) },
         };
     }
+    constructor(index, collection) {
+        super();
+        /**
+         * Room ID for the realtime subscription on the collection of observed documents
+         */
+        this.roomId = null;
+        this.index = index;
+        this.collection = collection;
+    }
 }
 /**
  * Provide an Uniform Resource Locator given an index, a collection and a document

package/src/core/batchWriter/BatchBuffer.d.ts

@@ -3,7 +3,7 @@ import { InstrumentablePromise } from "../InstrumentablePromise";
 /**
  * @internal
  */
-export declare type DocumentsBuffer = {
+export type DocumentsBuffer = {
     documents: Array<{
         _id: string;
         body: JSONObject;
@@ -18,7 +18,7 @@ export declare type DocumentsBuffer = {
  *
  * @internal
  */
-export declare type IndexBuffer = Map<string, Map<string, DocumentsBuffer>>;
+export type IndexBuffer = Map<string, Map<string, DocumentsBuffer>>;
 /**
  * @internal
  */

package/src/core/batchWriter/BatchWriter.js

@@ -16,22 +16,6 @@ const BatchBuffer_1 = require("./BatchBuffer");
  * @internal
  */
 class BatchWriter {
-    constructor(sdk, { interval = 10, maxWriteBufferSize = 200, maxReadBufferSize = 200 } = {}) {
-        // Buffers
-        this.buffers = {
-            create: new BatchBuffer_1.BatchBuffer(),
-            createOrReplace: new BatchBuffer_1.BatchBuffer(),
-            delete: new BatchBuffer_1.BatchBuffer(),
-            exists: new BatchBuffer_1.BatchBuffer(),
-            get: new BatchBuffer_1.BatchBuffer(),
-            replace: new BatchBuffer_1.BatchBuffer(),
-            update: new BatchBuffer_1.BatchBuffer(),
-        };
-        this.sdk = sdk;
-        this.interval = interval;
-        this.maxWriteBufferSize = maxWriteBufferSize;
-        this.maxReadBufferSize = maxReadBufferSize;
-    }
     get addCreate() {
         // @todo implements the send of buffer if approaching the limit
         return this.buffers.create.add.bind(this.buffers.create);
@@ -54,6 +38,22 @@ class BatchWriter {
     get addCreateOrReplace() {
         return this.buffers.createOrReplace.add.bind(this.buffers.createOrReplace);
     }
+    constructor(sdk, { interval = 10, maxWriteBufferSize = 200, maxReadBufferSize = 200 } = {}) {
+        // Buffers
+        this.buffers = {
+            create: new BatchBuffer_1.BatchBuffer(),
+            createOrReplace: new BatchBuffer_1.BatchBuffer(),
+            delete: new BatchBuffer_1.BatchBuffer(),
+            exists: new BatchBuffer_1.BatchBuffer(),
+            get: new BatchBuffer_1.BatchBuffer(),
+            replace: new BatchBuffer_1.BatchBuffer(),
+            update: new BatchBuffer_1.BatchBuffer(),
+        };
+        this.sdk = sdk;
+        this.interval = interval;
+        this.maxWriteBufferSize = maxWriteBufferSize;
+        this.maxReadBufferSize = maxReadBufferSize;
+    }
     /**
      * Execute API actions with documents stored in the buffers.
      */

package/src/protocols/abstract/Base.js

@@ -6,6 +6,9 @@ const uuidv4_1 = require("../../utils/uuidv4");
 const KuzzleEventEmitter_1 = require("../../core/KuzzleEventEmitter");
 const PendingRequest_1 = require("./PendingRequest");
 class KuzzleAbstractProtocol extends KuzzleEventEmitter_1.KuzzleEventEmitter {
+    get sslConnection() {
+        return this._ssl;
+    }
     constructor(host, options = {}, name = undefined) {
         super();
         this._pendingRequests = new Map();
@@ -38,9 +41,6 @@ class KuzzleAbstractProtocol extends KuzzleEventEmitter_1.KuzzleEventEmitter {
             }
         });
     }
-    get sslConnection() {
-        return this._ssl;
-    }
     /**
      * Kuzzle server host or IP.
      */

package/src/types/ApiKey.d.ts

@@ -3,7 +3,7 @@
  *
  * @see https://docs.kuzzle.io/core/2/guides/advanced/api-keys/
  */
-export declare type ApiKey = {
+export type ApiKey = {
     /**
      * ApiKey unique ID
      */

package/src/types/HttpRoutes.d.ts

@@ -17,7 +17,7 @@
  *   }
  * }
  */
-export declare type HttpRoutes = {
+export type HttpRoutes = {
     /**
      * Controller name
      */

package/src/types/JSONObject.d.ts

@@ -1,4 +1,4 @@
 /**
  * An interface representing an object with string key and any value
  */
-export declare type JSONObject = Record<PropertyKey, any>;
+export type JSONObject = Record<PropertyKey, any>;

package/src/types/KDocument.d.ts

@@ -56,4 +56,14 @@ export interface KHit<TKDocumentContent extends KDocumentContent> extends KDocum
      * Elasticsearch relevance score
      */
     _score: number;
+    /**
+     * Document index
+     * Present only in the case of a multi search
+     */
+    index?: string;
+    /**
+     * Document collection
+     * Present only in the case of a multi search
+     */
+    collection?: string;
 }

package/src/types/Mappings.d.ts

@@ -1,8 +1,8 @@
 import { JSONObject } from "./JSONObject";
-declare type PropertyObject = {
+type PropertyObject = {
     properties?: MappingsProperties;
 };
-declare type PropertyDynamic = {
+type PropertyDynamic = {
     /**
      * Dynamic mapping policy
      *
@@ -10,12 +10,12 @@ declare type PropertyDynamic = {
      */
     dynamic?: "true" | "false" | "strict";
 };
-declare type PropertyType = {
+type PropertyType = {
     [name: string]: {
         type?: string;
     } | PropertyObject | JSONObject;
 };
-export declare type MappingsProperties = PropertyObject | PropertyDynamic | PropertyType;
+export type MappingsProperties = PropertyObject | PropertyDynamic | PropertyType;
 /**
  * Collection mappings definition
  *
@@ -35,7 +35,7 @@ export declare type MappingsProperties = PropertyObject | PropertyDynamic | Prop
  * }
  * ```
  */
-export declare type CollectionMappings = {
+export type CollectionMappings = {
     /**
      * Collection metadata
      *

package/src/types/Notification.d.ts

@@ -3,7 +3,7 @@ import { KDocument, KDocumentContentGeneric } from ".";
 /**
  * Enum for notification types
  */
-export declare type NotificationType = "document" | "user" | "TokenExpired";
+export type NotificationType = "document" | "user" | "TokenExpired";
 export interface BaseNotification {
     /**
      * Notification type
@@ -92,4 +92,4 @@ export interface ServerNotification extends BaseNotification {
 /**
  * Real-time notifications sent by Kuzzle.
  */
-export declare type Notification = DocumentNotification | UserNotification | ServerNotification;
+export type Notification = DocumentNotification | UserNotification | ServerNotification;

package/src/types/ProfilePolicy.d.ts

@@ -15,7 +15,7 @@
  *
  * @see https://docs.kuzzle.io/core/2/guides/main-concepts/permissions/#policies
  */
-export declare type ProfilePolicy = {
+export type ProfilePolicy = {
     /**
      * Role unique ID used by this policy
      */

package/src/types/RoleRightsDefinition.d.ts

@@ -21,7 +21,7 @@
  *
  * @see https://docs.kuzzle.io/core/2/guides/main-concepts/permissions/#roles
  */
-export declare type RoleRightsDefinition = {
+export type RoleRightsDefinition = {
     /**
      * API controller name
      */

package/src/types/mRequests.d.ts

@@ -1,5 +1,5 @@
 import { KDocumentContentGeneric } from "./KDocument";
-export declare type mCreateRequest<TKDocumentContent extends KDocumentContentGeneric> = Array<{
+export type mCreateRequest<TKDocumentContent extends KDocumentContentGeneric> = Array<{
     /**
      * Document unique identifier
      */
@@ -9,7 +9,7 @@ export declare type mCreateRequest<TKDocumentContent extends KDocumentContentGen
      */
     body: Partial<TKDocumentContent>;
 }>;
-export declare type mCreateOrReplaceRequest<TKDocumentContent extends KDocumentContentGeneric> = Array<{
+export type mCreateOrReplaceRequest<TKDocumentContent extends KDocumentContentGeneric> = Array<{
     /**
      * Document unique identifier
      */
@@ -19,9 +19,9 @@ export declare type mCreateOrReplaceRequest<TKDocumentContent extends KDocumentC
      */
     body: Partial<TKDocumentContent>;
 }>;
-export declare type mReplaceRequest<TKDocumentContent extends KDocumentContentGeneric> = mCreateOrReplaceRequest<TKDocumentContent>;
-export declare type mUpdateRequest<TKDocumentContent extends KDocumentContentGeneric> = mCreateOrReplaceRequest<TKDocumentContent>;
-export declare type mUpsertRequest<TKDocumentContent extends KDocumentContentGeneric> = Array<{
+export type mReplaceRequest<TKDocumentContent extends KDocumentContentGeneric> = mCreateOrReplaceRequest<TKDocumentContent>;
+export type mUpdateRequest<TKDocumentContent extends KDocumentContentGeneric> = mCreateOrReplaceRequest<TKDocumentContent>;
+export type mUpsertRequest<TKDocumentContent extends KDocumentContentGeneric> = Array<{
     /**
      * Document unique identifier
      */
@@ -35,4 +35,4 @@ export declare type mUpsertRequest<TKDocumentContent extends KDocumentContentGen
      */
     default?: Partial<TKDocumentContent>;
 }>;
-export declare type mDeleteRequest = string[];
+export type mDeleteRequest = string[];