@depup/typesense 3.0.3-depup.0

package/lib/Typesense/Errors/ImportError.d.ts

@@ -0,0 +1,15 @@
+import TypesenseError from "./TypesenseError";
+import type { DocumentImportParameters, ImportResponse } from "../Documents";
+import { ReadStream } from "node:fs";
+interface ImportErrorPayload {
+    documentsInJSONLFormat: string | ReadStream;
+    options: DocumentImportParameters;
+    failedItems: ImportResponse[];
+    successCount: number;
+}
+export default class ImportError extends TypesenseError {
+    payload: ImportErrorPayload;
+    importResults: ImportResponse[];
+    constructor(message: string, importResults: ImportResponse[], payload: ImportErrorPayload);
+}
+export {};

package/lib/Typesense/Errors/ImportError.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var ImportError = /** @class */ (function (_super) {
+    tslib_1.__extends(ImportError, _super);
+    function ImportError(message, importResults, payload) {
+        var _this = _super.call(this, message) || this;
+        _this.importResults = importResults;
+        _this.payload = payload;
+        return _this;
+    }
+    return ImportError;
+}(TypesenseError_1.default));
+exports.default = ImportError;
+//# sourceMappingURL=ImportError.js.map

package/lib/Typesense/Errors/ImportError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImportError.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/ImportError.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAW9C;IAAyC,uCAAc;IAGrD,qBACE,OAAe,EACf,aAA+B,EAC/B,OAA2B;QAE3B,YAAA,MAAK,YAAC,OAAO,CAAC,SAAC;QACf,KAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,KAAI,CAAC,OAAO,GAAG,OAAO,CAAC;;IACzB,CAAC;IACH,kBAAC;AAAD,CAAC,AAZD,CAAyC,wBAAc,GAYtD"}

package/lib/Typesense/Errors/MissingConfigurationError.d.ts

@@ -0,0 +1,3 @@
+import TypesenseError from "./TypesenseError";
+export default class MissingConfigurationError extends TypesenseError {
+}

package/lib/Typesense/Errors/MissingConfigurationError.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var MissingConfigurationError = /** @class */ (function (_super) {
+    tslib_1.__extends(MissingConfigurationError, _super);
+    function MissingConfigurationError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return MissingConfigurationError;
+}(TypesenseError_1.default));
+exports.default = MissingConfigurationError;
+//# sourceMappingURL=MissingConfigurationError.js.map

package/lib/Typesense/Errors/MissingConfigurationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MissingConfigurationError.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/MissingConfigurationError.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAAuD,qDAAc;IAArE;;IAAuE,CAAC;IAAD,gCAAC;AAAD,CAAC,AAAxE,CAAuD,wBAAc,GAAG"}

package/lib/Typesense/Errors/ObjectAlreadyExists.d.ts

@@ -0,0 +1,3 @@
+import TypesenseError from "./TypesenseError";
+export default class ObjectAlreadyExists extends TypesenseError {
+}

package/lib/Typesense/Errors/ObjectAlreadyExists.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var ObjectAlreadyExists = /** @class */ (function (_super) {
+    tslib_1.__extends(ObjectAlreadyExists, _super);
+    function ObjectAlreadyExists() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return ObjectAlreadyExists;
+}(TypesenseError_1.default));
+exports.default = ObjectAlreadyExists;
+//# sourceMappingURL=ObjectAlreadyExists.js.map

package/lib/Typesense/Errors/ObjectAlreadyExists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectAlreadyExists.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/ObjectAlreadyExists.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAAiD,+CAAc;IAA/D;;IAAiE,CAAC;IAAD,0BAAC;AAAD,CAAC,AAAlE,CAAiD,wBAAc,GAAG"}

package/lib/Typesense/Errors/ObjectNotFound.d.ts

@@ -0,0 +1,3 @@
+import TypesenseError from "./TypesenseError";
+export default class ObjectNotFound extends TypesenseError {
+}

package/lib/Typesense/Errors/ObjectNotFound.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var ObjectNotFound = /** @class */ (function (_super) {
+    tslib_1.__extends(ObjectNotFound, _super);
+    function ObjectNotFound() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return ObjectNotFound;
+}(TypesenseError_1.default));
+exports.default = ObjectNotFound;
+//# sourceMappingURL=ObjectNotFound.js.map

package/lib/Typesense/Errors/ObjectNotFound.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectNotFound.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/ObjectNotFound.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAA4C,0CAAc;IAA1D;;IAA4D,CAAC;IAAD,qBAAC;AAAD,CAAC,AAA7D,CAA4C,wBAAc,GAAG"}

package/lib/Typesense/Errors/ObjectUnprocessable.d.ts

@@ -0,0 +1,3 @@
+import TypesenseError from "./TypesenseError";
+export default class ObjectUnprocessable extends TypesenseError {
+}

package/lib/Typesense/Errors/ObjectUnprocessable.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var ObjectUnprocessable = /** @class */ (function (_super) {
+    tslib_1.__extends(ObjectUnprocessable, _super);
+    function ObjectUnprocessable() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return ObjectUnprocessable;
+}(TypesenseError_1.default));
+exports.default = ObjectUnprocessable;
+//# sourceMappingURL=ObjectUnprocessable.js.map

package/lib/Typesense/Errors/ObjectUnprocessable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectUnprocessable.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/ObjectUnprocessable.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAAiD,+CAAc;IAA/D;;IAAiE,CAAC;IAAD,0BAAC;AAAD,CAAC,AAAlE,CAAiD,wBAAc,GAAG"}

package/lib/Typesense/Errors/RequestMalformed.d.ts

@@ -0,0 +1,3 @@
+import TypesenseError from "./TypesenseError";
+export default class RequestMalformed extends TypesenseError {
+}

package/lib/Typesense/Errors/RequestMalformed.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var RequestMalformed = /** @class */ (function (_super) {
+    tslib_1.__extends(RequestMalformed, _super);
+    function RequestMalformed() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return RequestMalformed;
+}(TypesenseError_1.default));
+exports.default = RequestMalformed;
+//# sourceMappingURL=RequestMalformed.js.map

package/lib/Typesense/Errors/RequestMalformed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestMalformed.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/RequestMalformed.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAA8C,4CAAc;IAA5D;;IAA8D,CAAC;IAAD,uBAAC;AAAD,CAAC,AAA/D,CAA8C,wBAAc,GAAG"}

package/lib/Typesense/Errors/RequestUnauthorized.d.ts

@@ -0,0 +1,3 @@
+import TypesenseError from "./TypesenseError";
+export default class RequestUnauthorized extends TypesenseError {
+}

package/lib/Typesense/Errors/RequestUnauthorized.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var RequestUnauthorized = /** @class */ (function (_super) {
+    tslib_1.__extends(RequestUnauthorized, _super);
+    function RequestUnauthorized() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return RequestUnauthorized;
+}(TypesenseError_1.default));
+exports.default = RequestUnauthorized;
+//# sourceMappingURL=RequestUnauthorized.js.map

package/lib/Typesense/Errors/RequestUnauthorized.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestUnauthorized.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/RequestUnauthorized.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAAiD,+CAAc;IAA/D;;IAAiE,CAAC;IAAD,0BAAC;AAAD,CAAC,AAAlE,CAAiD,wBAAc,GAAG"}

package/lib/Typesense/Errors/ServerError.d.ts

@@ -0,0 +1,3 @@
+import TypesenseError from "./TypesenseError";
+export default class ServerError extends TypesenseError {
+}

package/lib/Typesense/Errors/ServerError.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+var ServerError = /** @class */ (function (_super) {
+    tslib_1.__extends(ServerError, _super);
+    function ServerError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return ServerError;
+}(TypesenseError_1.default));
+exports.default = ServerError;
+//# sourceMappingURL=ServerError.js.map

package/lib/Typesense/Errors/ServerError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerError.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/ServerError.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAAyC,uCAAc;IAAvD;;IAAyD,CAAC;IAAD,kBAAC;AAAD,CAAC,AAA1D,CAAyC,wBAAc,GAAG"}

package/lib/Typesense/Errors/TypesenseError.d.ts

@@ -0,0 +1,5 @@
+export default class TypesenseError extends Error {
+    httpStatus?: number;
+    httpBody?: string;
+    constructor(message?: string, httpBody?: string, httpStatus?: number);
+}

package/lib/Typesense/Errors/TypesenseError.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var TypesenseError = /** @class */ (function (_super) {
+    tslib_1.__extends(TypesenseError, _super);
+    // Source: https://stackoverflow.com/a/58417721/123545
+    function TypesenseError(message, httpBody, httpStatus) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, message) || this;
+        _this.name = _newTarget.name;
+        _this.httpBody = httpBody;
+        _this.httpStatus = httpStatus;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return TypesenseError;
+}(Error));
+exports.default = TypesenseError;
+//# sourceMappingURL=TypesenseError.js.map

package/lib/Typesense/Errors/TypesenseError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypesenseError.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/TypesenseError.ts"],"names":[],"mappings":";;;AAAA;IAA4C,0CAAK;IAI/C,sDAAsD;IACtD,wBAAY,OAAgB,EAAE,QAAiB,EAAE,UAAmB;;QAClE,YAAA,MAAK,YAAC,OAAO,CAAC,SAAC;QACf,KAAI,CAAC,IAAI,GAAG,WAAW,IAAI,CAAC;QAC5B,KAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,KAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAC;;IACpD,CAAC;IACH,qBAAC;AAAD,CAAC,AAZD,CAA4C,KAAK,GAYhD"}

package/lib/Typesense/Errors/index.d.ts

@@ -0,0 +1,11 @@
+import HTTPError from "./HTTPError";
+import MissingConfigurationError from "./MissingConfigurationError";
+import ObjectAlreadyExists from "./ObjectAlreadyExists";
+import ObjectNotFound from "./ObjectNotFound";
+import ObjectUnprocessable from "./ObjectUnprocessable";
+import RequestMalformed from "./RequestMalformed";
+import RequestUnauthorized from "./RequestUnauthorized";
+import ServerError from "./ServerError";
+import ImportError from "./ImportError";
+import TypesenseError from "./TypesenseError";
+export { HTTPError, MissingConfigurationError, ObjectAlreadyExists, ObjectNotFound, ObjectUnprocessable, RequestMalformed, RequestUnauthorized, ServerError, TypesenseError, ImportError, };

package/lib/Typesense/Errors/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportError = exports.TypesenseError = exports.ServerError = exports.RequestUnauthorized = exports.RequestMalformed = exports.ObjectUnprocessable = exports.ObjectNotFound = exports.ObjectAlreadyExists = exports.MissingConfigurationError = exports.HTTPError = void 0;
+var tslib_1 = require("tslib");
+var HTTPError_1 = tslib_1.__importDefault(require("./HTTPError"));
+exports.HTTPError = HTTPError_1.default;
+var MissingConfigurationError_1 = tslib_1.__importDefault(require("./MissingConfigurationError"));
+exports.MissingConfigurationError = MissingConfigurationError_1.default;
+var ObjectAlreadyExists_1 = tslib_1.__importDefault(require("./ObjectAlreadyExists"));
+exports.ObjectAlreadyExists = ObjectAlreadyExists_1.default;
+var ObjectNotFound_1 = tslib_1.__importDefault(require("./ObjectNotFound"));
+exports.ObjectNotFound = ObjectNotFound_1.default;
+var ObjectUnprocessable_1 = tslib_1.__importDefault(require("./ObjectUnprocessable"));
+exports.ObjectUnprocessable = ObjectUnprocessable_1.default;
+var RequestMalformed_1 = tslib_1.__importDefault(require("./RequestMalformed"));
+exports.RequestMalformed = RequestMalformed_1.default;
+var RequestUnauthorized_1 = tslib_1.__importDefault(require("./RequestUnauthorized"));
+exports.RequestUnauthorized = RequestUnauthorized_1.default;
+var ServerError_1 = tslib_1.__importDefault(require("./ServerError"));
+exports.ServerError = ServerError_1.default;
+var ImportError_1 = tslib_1.__importDefault(require("./ImportError"));
+exports.ImportError = ImportError_1.default;
+var TypesenseError_1 = tslib_1.__importDefault(require("./TypesenseError"));
+exports.TypesenseError = TypesenseError_1.default;
+//# sourceMappingURL=index.js.map

package/lib/Typesense/Errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/index.ts"],"names":[],"mappings":";;;;AAAA,kEAAoC;AAYlC,oBAZK,mBAAS,CAYL;AAXX,kGAAoE;AAYlE,oCAZK,mCAAyB,CAYL;AAX3B,sFAAwD;AAYtD,8BAZK,6BAAmB,CAYL;AAXrB,4EAA8C;AAY5C,yBAZK,wBAAc,CAYL;AAXhB,sFAAwD;AAYtD,8BAZK,6BAAmB,CAYL;AAXrB,gFAAkD;AAYhD,2BAZK,0BAAgB,CAYL;AAXlB,sFAAwD;AAYtD,8BAZK,6BAAmB,CAYL;AAXrB,sEAAwC;AAYtC,sBAZK,qBAAW,CAYL;AAXb,sEAAwC;AAatC,sBAbK,qBAAW,CAaL;AAZb,4EAA8C;AAW5C,yBAXK,wBAAc,CAWL"}

package/lib/Typesense/Health.d.ts

@@ -0,0 +1,9 @@
+import ApiCall from "./ApiCall";
+export interface HealthResponse {
+    ok: boolean;
+}
+export default class Health {
+    private apiCall;
+    constructor(apiCall: ApiCall);
+    retrieve(): Promise<HealthResponse>;
+}

package/lib/Typesense/Health.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var RESOURCEPATH = "/health";
+var Health = /** @class */ (function () {
+    function Health(apiCall) {
+        this.apiCall = apiCall;
+    }
+    Health.prototype.retrieve = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.get(RESOURCEPATH)];
+            });
+        });
+    };
+    return Health;
+}());
+exports.default = Health;
+//# sourceMappingURL=Health.js.map

package/lib/Typesense/Health.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Health.js","sourceRoot":"","sources":["../../src/Typesense/Health.ts"],"names":[],"mappings":";;;AAEA,IAAM,YAAY,GAAG,SAAS,CAAC;AAM/B;IACE,gBAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAElC,yBAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAiB,YAAY,CAAC,EAAC;;;KACvD;IACH,aAAC;AAAD,CAAC,AAND,IAMC"}

package/lib/Typesense/Key.d.ts

@@ -0,0 +1,33 @@
+import ApiCall from "./ApiCall";
+export interface KeyCreateSchema {
+    actions: Actions[] | (string & {})[];
+    collections: string[];
+    description?: string;
+    value?: string;
+    value_prefix?: string;
+    expires_at?: number;
+    autodelete?: boolean;
+}
+type CRUDActions = "create" | "delete" | "get" | "list" | "*";
+type DocumentActionTypes = "search" | "get" | "create" | "upsert" | "update" | "delete" | "import" | "export" | "*";
+type CRUDFeatures = "collections" | "aliases" | "synonyms" | "overrides" | "stopwords" | "keys" | "analytics" | "analytics/rules";
+type FeatureActions = `${CRUDFeatures}:${CRUDActions}`;
+type DocumentActions = `documents:${DocumentActionTypes}`;
+type AnalyticsEventActions = "analytics/events:create";
+type MiscActions = `${`metrics.json` | `stats.json` | `debug`}.list` | "*";
+export type Actions = FeatureActions | DocumentActions | AnalyticsEventActions | MiscActions;
+export interface KeyDeleteSchema {
+    id: number;
+}
+export interface KeySchema extends KeyCreateSchema {
+    id: number;
+}
+export default class Key {
+    private id;
+    private apiCall;
+    constructor(id: number, apiCall: ApiCall);
+    retrieve(): Promise<KeySchema>;
+    delete(): Promise<KeyDeleteSchema>;
+    private endpointPath;
+}
+export {};

package/lib/Typesense/Key.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var Keys_1 = tslib_1.__importDefault(require("./Keys"));
+var Key = /** @class */ (function () {
+    function Key(id, apiCall) {
+        this.id = id;
+        this.apiCall = apiCall;
+    }
+    Key.prototype.retrieve = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.get(this.endpointPath())];
+            });
+        });
+    };
+    Key.prototype.delete = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.delete(this.endpointPath())];
+            });
+        });
+    };
+    Key.prototype.endpointPath = function () {
+        return "".concat(Keys_1.default.RESOURCEPATH, "/").concat(encodeURIComponent(this.id));
+    };
+    return Key;
+}());
+exports.default = Key;
+//# sourceMappingURL=Key.js.map

package/lib/Typesense/Key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Key.js","sourceRoot":"","sources":["../../src/Typesense/Key.ts"],"names":[],"mappings":";;;AACA,wDAA0B;AAsD1B;IACE,aACU,EAAU,EACV,OAAgB;QADhB,OAAE,GAAF,EAAE,CAAQ;QACV,YAAO,GAAP,OAAO,CAAS;IACvB,CAAC;IAEE,sBAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAY,IAAI,CAAC,YAAY,EAAE,CAAC,EAAC;;;KACzD;IAEK,oBAAM,GAAZ;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAkB,IAAI,CAAC,YAAY,EAAE,CAAC,EAAC;;;KAClE;IAEO,0BAAY,GAApB;QACE,OAAO,UAAG,cAAI,CAAC,YAAY,cAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAE,CAAC;IAC/D,CAAC;IACH,UAAC;AAAD,CAAC,AAjBD,IAiBC"}

package/lib/Typesense/Keys.d.ts

@@ -0,0 +1,19 @@
+import ApiCall from "./ApiCall";
+import { KeyCreateSchema, KeySchema } from "./Key";
+import type { DocumentSchema, SearchParams } from "./Documents";
+export interface KeysRetrieveSchema {
+    keys: KeySchema[];
+}
+export interface GenerateScopedSearchKeyParams<T extends DocumentSchema, Infix extends string> extends Partial<SearchParams<T, Infix>> {
+    expires_at?: number;
+    cache_ttl?: number;
+    limit_multi_searches?: number;
+}
+export default class Keys {
+    private apiCall;
+    constructor(apiCall: ApiCall);
+    create(params: KeyCreateSchema): Promise<KeySchema>;
+    retrieve(): Promise<KeysRetrieveSchema>;
+    generateScopedSearchKey<T extends DocumentSchema, const Infix extends string>(searchKey: string, parameters: GenerateScopedSearchKeyParams<T, Infix>): string;
+    static get RESOURCEPATH(): string;
+}

package/lib/Typesense/Keys.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var crypto_1 = require("crypto");
+var Utils_1 = require("./Utils");
+var RESOURCEPATH = "/keys";
+var Keys = /** @class */ (function () {
+    function Keys(apiCall) {
+        this.apiCall = apiCall;
+        this.apiCall = apiCall;
+    }
+    Keys.prototype.create = function (params) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.post(Keys.RESOURCEPATH, params)];
+            });
+        });
+    };
+    Keys.prototype.retrieve = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.get(RESOURCEPATH)];
+            });
+        });
+    };
+    Keys.prototype.generateScopedSearchKey = function (searchKey, parameters) {
+        // Note: only a key generated with the `documents:search` action will be
+        // accepted by the server, when used with the search endpoint.
+        var normalizedParams = (0, Utils_1.normalizeArrayableParams)(parameters);
+        var paramsJSON = JSON.stringify(normalizedParams);
+        var digest = Buffer.from((0, crypto_1.createHmac)("sha256", searchKey).update(paramsJSON).digest("base64"));
+        var keyPrefix = searchKey.substr(0, 4);
+        var rawScopedKey = "".concat(digest).concat(keyPrefix).concat(paramsJSON);
+        return Buffer.from(rawScopedKey).toString("base64");
+    };
+    Object.defineProperty(Keys, "RESOURCEPATH", {
+        get: function () {
+            return RESOURCEPATH;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return Keys;
+}());
+exports.default = Keys;
+//# sourceMappingURL=Keys.js.map

package/lib/Typesense/Keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Keys.js","sourceRoot":"","sources":["../../src/Typesense/Keys.ts"],"names":[],"mappings":";;;AAAA,iCAAoC;AAIpC,iCAAmD;AAEnD,IAAM,YAAY,GAAG,OAAO,CAAC;AAe7B;IACE,cAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;QAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEK,qBAAM,GAAZ,UAAa,MAAuB;;;gBAClC,sBAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAY,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,EAAC;;;KAChE;IAEK,uBAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAqB,YAAY,CAAC,EAAC;;;KAC3D;IAED,sCAAuB,GAAvB,UACE,SAAiB,EACjB,UAAmD;QAEnD,wEAAwE;QACxE,8DAA8D;QAC9D,IAAM,gBAAgB,GAAG,IAAA,gCAAwB,EAI/C,UAAU,CAAC,CAAC;QACd,IAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACpD,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CACxB,IAAA,mBAAU,EAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CACpE,CAAC;QACF,IAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACzC,IAAM,YAAY,GAAG,UAAG,MAAM,SAAG,SAAS,SAAG,UAAU,CAAE,CAAC;QAE1D,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,sBAAW,oBAAY;aAAvB;YACE,OAAO,YAAY,CAAC;QACtB,CAAC;;;OAAA;IACH,WAAC;AAAD,CAAC,AArCD,IAqCC"}

package/lib/Typesense/Metrics.d.ts

@@ -0,0 +1,25 @@
+import ApiCall from "./ApiCall";
+export interface MetricsResponse {
+    [key: `system_cpu${number}_active_percentage`]: string;
+    system_cpu_active_percentage: string;
+    system_disk_total_bytes: string;
+    system_disk_used_bytes: string;
+    system_memory_total_bytes: string;
+    system_memory_total_swap_bytes?: string;
+    system_memory_used_bytes: string;
+    system_memory_used_swap_bytes?: string;
+    system_network_received_bytes: string;
+    system_network_sent_bytes: string;
+    typesense_memory_active_bytes: string;
+    typesense_memory_allocated_bytes: string;
+    typesense_memory_fragmentation_ratio: string;
+    typesense_memory_mapped_bytes: string;
+    typesense_memory_metadata_bytes: string;
+    typesense_memory_resident_bytes: string;
+    typesense_memory_retained_bytes: string;
+}
+export default class Metrics {
+    private apiCall;
+    constructor(apiCall: ApiCall);
+    retrieve(): Promise<MetricsResponse>;
+}

package/lib/Typesense/Metrics.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var RESOURCEPATH = "/metrics.json";
+var Metrics = /** @class */ (function () {
+    function Metrics(apiCall) {
+        this.apiCall = apiCall;
+    }
+    Metrics.prototype.retrieve = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.get(RESOURCEPATH)];
+            });
+        });
+    };
+    return Metrics;
+}());
+exports.default = Metrics;
+//# sourceMappingURL=Metrics.js.map

package/lib/Typesense/Metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../src/Typesense/Metrics.ts"],"names":[],"mappings":";;;AAEA,IAAM,YAAY,GAAG,eAAe,CAAC;AAsBrC;IACE,iBAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAElC,0BAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,EAAC;;;KACvC;IACH,cAAC;AAAD,CAAC,AAND,IAMC"}

package/lib/Typesense/MultiSearch.d.ts

@@ -0,0 +1,25 @@
+import type ApiCall from "./ApiCall";
+import type Configuration from "./Configuration";
+import type { DocumentSchema, SearchOptions, SearchResponse } from "./Documents";
+import type { MultiSearchRequestsWithUnionSchema, MultiSearchUnionParameters, MultiSearchResultsParameters, UnionSearchResponse, MultiSearchRequestsWithoutUnionSchema } from "./Types";
+import { Logger } from "loglevel";
+export default class MultiSearch {
+    private apiCall;
+    private configuration;
+    private useTextContentType;
+    private requestWithCache;
+    readonly logger: Logger;
+    constructor(apiCall: ApiCall, configuration: Configuration, useTextContentType?: boolean);
+    clearCache(): void;
+    perform<const T extends DocumentSchema[] = [], const Infix extends string = string>(searchRequests: MultiSearchRequestsWithUnionSchema<T[number], Infix>, commonParams?: MultiSearchUnionParameters<T[number], Infix>, options?: SearchOptions): Promise<UnionSearchResponse<T[number]>>;
+    perform<const T extends DocumentSchema[] = [], const Infix extends string = string>(searchRequests: MultiSearchRequestsWithoutUnionSchema<T[number], Infix>, commonParams?: MultiSearchResultsParameters<T, Infix>, options?: SearchOptions): Promise<{
+        results: {
+            [Index in keyof T]: SearchResponse<T[Index]>;
+        } & {
+            length: T["length"];
+        };
+    }>;
+    private isStreamingRequest;
+    private hasAnySearchObjectPagination;
+}
+export type { MultiSearchRequestsSchema, MultiSearchRequestsWithUnionSchema, MultiSearchResponse, MultiSearchUnionParameters, MultiSearchResultsParameters, UnionSearchResponse, MultiSearchRequestsWithoutUnionSchema, } from "./Types";

package/lib/Typesense/MultiSearch.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var RequestWithCache_1 = tslib_1.__importDefault(require("./RequestWithCache"));
+var Utils_1 = require("./Utils");
+var RESOURCEPATH = "/multi_search";
+var MultiSearch = /** @class */ (function () {
+    function MultiSearch(apiCall, configuration, useTextContentType) {
+        if (useTextContentType === void 0) { useTextContentType = false; }
+        this.apiCall = apiCall;
+        this.configuration = configuration;
+        this.useTextContentType = useTextContentType;
+        this.requestWithCache = new RequestWithCache_1.default();
+        this.logger = this.apiCall.logger;
+    }
+    MultiSearch.prototype.clearCache = function () {
+        this.requestWithCache.clearCache();
+    };
+    MultiSearch.prototype.perform = function (searchRequests, commonParams, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var params, cacheSearchResultsForSeconds, normalizedSearchRequests, streamConfig, paramsWithoutStream, normalizedQueryParams;
+            var _a;
+            return tslib_1.__generator(this, function (_b) {
+                params = commonParams ? tslib_1.__assign({}, commonParams) : {};
+                cacheSearchResultsForSeconds = (_a = options === null || options === void 0 ? void 0 : options.cacheSearchResultsForSeconds) !== null && _a !== void 0 ? _a : this.configuration.cacheSearchResultsForSeconds;
+                if (this.configuration.useServerSideSearchCache === true) {
+                    params.use_cache = true;
+                }
+                if (searchRequests.union === true && this.hasAnySearchObjectPagination(searchRequests)) {
+                    this.logger.warn("Individual `searches` pagination parameters are ignored when `union: true` is set. Use a top-level pagination parameter instead. See https://typesense.org/docs/29.0/api/federated-multi-search.html#union-search");
+                }
+                normalizedSearchRequests = {
+                    union: searchRequests.union,
+                    searches: searchRequests.searches.map((Utils_1.normalizeArrayableParams)),
+                };
+                streamConfig = params.streamConfig, paramsWithoutStream = tslib_1.__rest(params, ["streamConfig"]);
+                normalizedQueryParams = (0, Utils_1.normalizeArrayableParams)(paramsWithoutStream);
+                return [2 /*return*/, this.requestWithCache.perform(this.apiCall, "post", {
+                        path: RESOURCEPATH,
+                        body: normalizedSearchRequests,
+                        queryParams: normalizedQueryParams,
+                        headers: this.useTextContentType
+                            ? { "content-type": "text/plain" }
+                            : {},
+                        streamConfig: streamConfig,
+                        abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal,
+                        isStreamingRequest: this.isStreamingRequest(params),
+                    }, cacheSearchResultsForSeconds !== undefined
+                        ? { cacheResponseForSeconds: cacheSearchResultsForSeconds }
+                        : undefined)];
+            });
+        });
+    };
+    MultiSearch.prototype.isStreamingRequest = function (commonParams) {
+        return commonParams.streamConfig !== undefined;
+    };
+    MultiSearch.prototype.hasAnySearchObjectPagination = function (searchRequests) {
+        return searchRequests.searches.some(function (search) { return search.page !== undefined || search.per_page !== undefined || search.offset !== undefined || search.limit !== undefined || search.limit_hits !== undefined; });
+    };
+    return MultiSearch;
+}());
+exports.default = MultiSearch;
+//# sourceMappingURL=MultiSearch.js.map

package/lib/Typesense/MultiSearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiSearch.js","sourceRoot":"","sources":["../../src/Typesense/MultiSearch.ts"],"names":[],"mappings":";;;AAEA,gFAAkD;AAQlD,iCAAmD;AAYnD,IAAM,YAAY,GAAG,eAAe,CAAC;AAErC;IAIE,qBACU,OAAgB,EAChB,aAA4B,EAC5B,kBAAmC;QAAnC,mCAAA,EAAA,0BAAmC;QAFnC,YAAO,GAAP,OAAO,CAAS;QAChB,kBAAa,GAAb,aAAa,CAAe;QAC5B,uBAAkB,GAAlB,kBAAkB,CAAiB;QAE3C,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,EAAE,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IACpC,CAAC;IAED,gCAAU,GAAV;QACE,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC;IAwBK,6BAAO,GAAb,UAIE,cAA2D,EAC3D,YAE0C,EAC1C,OAAuB;;;;;gBAEjB,MAAM,GAAG,YAAY,CAAC,CAAC,sBAAM,YAAY,EAAG,CAAC,CAAC,EAAE,CAAC;gBACjD,4BAA4B,GAChC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,4BAA4B,mCACrC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC;gBAElD,IAAI,IAAI,CAAC,aAAa,CAAC,wBAAwB,KAAK,IAAI,EAAE,CAAC;oBACzD,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;gBAC1B,CAAC;gBAED,IAAI,cAAc,CAAC,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,4BAA4B,CAAC,cAAc,CAAC,EAAE,CAAC;oBACvF,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,mNAAmN,CACpN,CAAC;gBACJ,CAAC;gBAEK,wBAAwB,GAE1B;oBACF,KAAK,EAAE,cAAc,CAAC,KAAK;oBAC3B,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,GAAG,CACnC,CAAA,gCAIC,CAAA,CACF;iBACF,CAAC;gBAEM,YAAY,GAA6B,MAAM,aAAnC,EAAK,mBAAmB,kBAAK,MAAM,EAAjD,gBAAwC,CAAF,CAAY;gBAClD,qBAAqB,GAAG,IAAA,gCAAwB,EACpD,mBAAqD,CACtD,CAAC;gBAEF,sBAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAClC,IAAI,CAAC,OAAO,EACZ,MAAM,EACN;wBACE,IAAI,EAAE,YAAY;wBAClB,IAAI,EAAE,wBAAwB;wBAC9B,WAAW,EAAE,qBAAqB;wBAClC,OAAO,EAAE,IAAI,CAAC,kBAAkB;4BAC9B,CAAC,CAAC,EAAE,cAAc,EAAE,YAAY,EAAE;4BAClC,CAAC,CAAC,EAAE;wBACN,YAAY,cAAA;wBACZ,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;wBACjC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC;qBACpD,EACD,4BAA4B,KAAK,SAAS;wBACxC,CAAC,CAAC,EAAE,uBAAuB,EAAE,4BAA4B,EAAE;wBAC3D,CAAC,CAAC,SAAS,CACd,EAAC;;;KACH;IAEO,wCAAkB,GAA1B,UAA2B,YAAwC;QACjE,OAAO,YAAY,CAAC,YAAY,KAAK,SAAS,CAAC;IACjD,CAAC;IAEO,kDAA4B,GAApC,UAAqC,cAAiE;QACpG,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAA,MAAM,IAAI,OAAA,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAA1J,CAA0J,CAAC,CAAC;IAC5M,CAAC;IACH,kBAAC;AAAD,CAAC,AA7GD,IA6GC"}

package/lib/Typesense/NLSearchModel.d.ts

@@ -0,0 +1,16 @@
+import ApiCall from "./ApiCall";
+import type { NLSearchModelBase, NLSearchModelSchema } from "./NLSearchModels";
+type NLSearchModelUpdateSchema = NLSearchModelBase;
+export interface NLSearchModelDeleteSchema {
+    id: string;
+}
+export default class NLSearchModel {
+    private id;
+    private apiCall;
+    constructor(id: string, apiCall: ApiCall);
+    retrieve(): Promise<NLSearchModelSchema>;
+    update(schema: NLSearchModelUpdateSchema): Promise<NLSearchModelSchema>;
+    delete(): Promise<NLSearchModelDeleteSchema>;
+    private endpointPath;
+}
+export {};