@depup/typesense 3.0.3-depup.0

package/lib/Typesense/CurationSetItems.d.ts

@@ -0,0 +1,9 @@
+import ApiCall from "./ApiCall";
+import { CurationObjectSchema } from "./CurationSets";
+export default class CurationSetItems {
+    private name;
+    private apiCall;
+    constructor(name: string, apiCall: ApiCall);
+    retrieve(): Promise<CurationObjectSchema[]>;
+    private endpointPath;
+}

package/lib/Typesense/CurationSetItems.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var CurationSets_1 = tslib_1.__importDefault(require("./CurationSets"));
+var CurationSetItems = /** @class */ (function () {
+    function CurationSetItems(name, apiCall) {
+        this.name = name;
+        this.apiCall = apiCall;
+    }
+    CurationSetItems.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())];
+            });
+        });
+    };
+    CurationSetItems.prototype.endpointPath = function (operation) {
+        return "".concat(CurationSets_1.default.RESOURCEPATH, "/").concat(encodeURIComponent(this.name), "/items").concat(operation === undefined ? "" : "/" + encodeURIComponent(operation));
+    };
+    return CurationSetItems;
+}());
+exports.default = CurationSetItems;
+//# sourceMappingURL=CurationSetItems.js.map

package/lib/Typesense/CurationSetItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurationSetItems.js","sourceRoot":"","sources":["../../src/Typesense/CurationSetItems.ts"],"names":[],"mappings":";;;AACA,wEAAoE;AAEpE;IACE,0BAAoB,IAAY,EAAU,OAAgB;QAAtC,SAAI,GAAJ,IAAI,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAExD,mCAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAyB,IAAI,CAAC,YAAY,EAAE,CAAC,EAAC;;;KACtE;IAEO,uCAAY,GAApB,UAAqB,SAAkB;QACrC,OAAO,UAAG,sBAAY,CAAC,YAAY,cAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,mBAClE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAClE,CAAC;IACL,CAAC;IACH,uBAAC;AAAD,CAAC,AAZD,IAYC"}

package/lib/Typesense/CurationSets.d.ts

@@ -0,0 +1,56 @@
+import ApiCall from "./ApiCall";
+export type CurationRuleSchema = {
+    tags: string[];
+    query?: never;
+    match?: never;
+    filter_by?: never;
+} | {
+    query: string;
+    match: "exact" | "contains";
+    tags?: never;
+    filter_by?: never;
+} | {
+    filter_by: string;
+    tags?: never;
+    query?: never;
+    match?: never;
+};
+export interface CurationObjectSchema {
+    id: string;
+    rule: CurationRuleSchema;
+    includes?: {
+        id: string;
+        position: number;
+    }[];
+    excludes?: {
+        id: string;
+    }[];
+    filter_by?: string;
+    sort_by?: string;
+    replace_query?: string;
+    remove_matched_tokens?: boolean;
+    filter_curated_hits?: boolean;
+    stop_processing?: boolean;
+    effective_from_ts?: number;
+    effective_to_ts?: number;
+    metadata?: Record<string, unknown>;
+}
+export interface CurationSetUpsertSchema {
+    items: CurationObjectSchema[];
+}
+export interface CurationSetSchema extends CurationSetUpsertSchema {
+    name?: string;
+}
+export interface CurationSetsListEntrySchema {
+    name: string;
+    items: CurationObjectSchema[];
+}
+export interface CurationSetDeleteResponseSchema {
+    name: string;
+}
+export default class CurationSets {
+    private apiCall;
+    constructor(apiCall: ApiCall);
+    static readonly RESOURCEPATH = "/curation_sets";
+    retrieve(): Promise<CurationSetsListEntrySchema[]>;
+}

package/lib/Typesense/CurationSets.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var CurationSets = /** @class */ (function () {
+    function CurationSets(apiCall) {
+        this.apiCall = apiCall;
+    }
+    CurationSets.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(CurationSets.RESOURCEPATH)];
+            });
+        });
+    };
+    CurationSets.RESOURCEPATH = "/curation_sets";
+    return CurationSets;
+}());
+exports.default = CurationSets;
+//# sourceMappingURL=CurationSets.js.map

package/lib/Typesense/CurationSets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurationSets.js","sourceRoot":"","sources":["../../src/Typesense/CurationSets.ts"],"names":[],"mappings":";;;AAkDA;IACE,sBAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAGlC,+BAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,YAAY,CAAC,YAAY,CAC1B,EAAC;;;KACH;IANe,yBAAY,GAAG,gBAAgB,CAAC;IAOlD,mBAAC;CAAA,AATD,IASC;kBAToB,YAAY"}

package/lib/Typesense/Debug.d.ts

@@ -0,0 +1,10 @@
+import ApiCall from "./ApiCall";
+export interface DebugResponseSchema {
+    state: number;
+    version: string;
+}
+export default class Debug {
+    private apiCall;
+    constructor(apiCall: ApiCall);
+    retrieve(): Promise<DebugResponseSchema>;
+}

package/lib/Typesense/Debug.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var RESOURCEPATH = "/debug";
+var Debug = /** @class */ (function () {
+    function Debug(apiCall) {
+        this.apiCall = apiCall;
+    }
+    Debug.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 Debug;
+}());
+exports.default = Debug;
+//# sourceMappingURL=Debug.js.map

package/lib/Typesense/Debug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../src/Typesense/Debug.ts"],"names":[],"mappings":";;;AAEA,IAAM,YAAY,GAAG,QAAQ,CAAC;AAO9B;IACE,eAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAElC,wBAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAsB,YAAY,CAAC,EAAC;;;KAC5D;IACH,YAAC;AAAD,CAAC,AAND,IAMC"}

package/lib/Typesense/Document.d.ts

@@ -0,0 +1,12 @@
+import ApiCall from "./ApiCall";
+import { DeleteQuery, DocumentSchema, DocumentWriteParameters } from "./Documents";
+export declare class Document<T extends DocumentSchema = object> {
+    private collectionName;
+    private documentId;
+    private apiCall;
+    constructor(collectionName: string, documentId: string, apiCall: ApiCall);
+    retrieve(): Promise<T>;
+    delete(options?: DeleteQuery): Promise<T>;
+    update(partialDocument: Partial<T>, options?: DocumentWriteParameters): Promise<T>;
+    private endpointPath;
+}

package/lib/Typesense/Document.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Document = void 0;
+var tslib_1 = require("tslib");
+var Collections_1 = tslib_1.__importDefault(require("./Collections"));
+var Documents_1 = tslib_1.__importDefault(require("./Documents"));
+var Document = /** @class */ (function () {
+    function Document(collectionName, documentId, apiCall) {
+        this.collectionName = collectionName;
+        this.documentId = documentId;
+        this.apiCall = apiCall;
+    }
+    Document.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())];
+            });
+        });
+    };
+    Document.prototype.delete = function (options) {
+        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(), options)];
+            });
+        });
+    };
+    Document.prototype.update = function (partialDocument_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (partialDocument, options) {
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.patch(this.endpointPath(), partialDocument, options)];
+            });
+        });
+    };
+    Document.prototype.endpointPath = function () {
+        return "".concat(Collections_1.default.RESOURCEPATH, "/").concat(encodeURIComponent(this.collectionName)).concat(Documents_1.default.RESOURCEPATH, "/").concat(encodeURIComponent(this.documentId));
+    };
+    return Document;
+}());
+exports.Document = Document;
+//# sourceMappingURL=Document.js.map

package/lib/Typesense/Document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document.js","sourceRoot":"","sources":["../../src/Typesense/Document.ts"],"names":[],"mappings":";;;;AACA,sEAAwC;AACxC,kEAIqB;AAErB;IACE,kBACU,cAAsB,EACtB,UAAkB,EAClB,OAAgB;QAFhB,mBAAc,GAAd,cAAc,CAAQ;QACtB,eAAU,GAAV,UAAU,CAAQ;QAClB,YAAO,GAAP,OAAO,CAAS;IACvB,CAAC;IAEE,2BAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAI,IAAI,CAAC,YAAY,EAAE,CAAC,EAAC;;;KACjD;IAEK,yBAAM,GAAZ,UAAa,OAAqB;;;gBAChC,sBAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAI,IAAI,CAAC,YAAY,EAAE,EAAE,OAAO,CAAC,EAAC;;;KAC7D;IAEK,yBAAM,GAAZ;oEACE,eAA2B,EAC3B,OAAqC;YAArC,wBAAA,EAAA,YAAqC;;gBAErC,sBAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAI,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,EAAC;;;KAC7E;IAEO,+BAAY,GAApB;QACE,OAAO,UAAG,qBAAW,CAAC,YAAY,cAAI,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,SAAG,mBAAS,CAAC,YAAY,cAAI,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAE,CAAC;IAClJ,CAAC;IACH,eAAC;AAAD,CAAC,AAzBD,IAyBC;AAzBY,4BAAQ"}

package/lib/Typesense/Documents.d.ts

@@ -0,0 +1,196 @@
+import type { ReadStream } from "fs";
+import ApiCall from "./ApiCall";
+import Configuration from "./Configuration";
+import { SearchOnlyDocuments } from "./SearchOnlyDocuments";
+import { SearchParams, SearchResponseRequestParams, WriteableDocuments } from "./Types";
+export type DeleteQuery = {
+    truncate?: true;
+} | {
+    truncate?: never;
+    filter_by?: string;
+    batch_size?: number;
+    ignore_not_found?: boolean;
+    return_doc?: boolean;
+    return_id?: boolean;
+};
+export interface DeleteResponse<T extends DocumentSchema = DocumentSchema> {
+    num_deleted: number;
+    documents?: T[];
+    ids?: string[];
+}
+interface ImportResponseSuccess<T extends DocumentSchema = DocumentSchema> {
+    success: true;
+    error?: never;
+    document?: T;
+    id?: string;
+    code?: never;
+}
+export interface ImportResponseFail<T extends DocumentSchema = DocumentSchema> {
+    success: false;
+    error: string;
+    document?: T;
+    id?: string;
+    code: number;
+}
+export type ImportResponse<T extends DocumentSchema = DocumentSchema> = ImportResponseSuccess<T> | ImportResponseFail<T>;
+export type DocumentSchema = Record<string, any>;
+export interface SearchParamsWithPreset<T extends DocumentSchema, Infix extends string> extends Partial<SearchParams<T, Infix>> {
+    preset: string;
+}
+type SearchResponseHighlightObject = {
+    matched_tokens?: string[];
+    snippet?: string;
+    value?: string;
+};
+export type SearchResponseHighlight<T> = T extends string | number ? SearchResponseHighlightObject : {
+    [TAttribute in keyof T]?: SearchResponseHighlight<T[TAttribute]>;
+};
+export interface SearchResponseHit<T extends DocumentSchema> {
+    curated?: true;
+    highlights?: [
+        {
+            field: keyof T;
+            snippet?: string;
+            value?: string;
+            snippets?: string[];
+            indices?: number[];
+            matched_tokens: string[][] | string[];
+        }
+    ];
+    highlight: SearchResponseHighlight<T>;
+    document: T;
+    text_match: number;
+    text_match_info?: {
+        best_field_score: `${number}`;
+        best_field_weight: number;
+        fields_matched: number;
+        score: `${number}`;
+        tokens_matched: number;
+    };
+    geo_distance_meters?: {
+        location: number;
+    };
+}
+export interface SearchResponseFacetCountSchema<T extends DocumentSchema> {
+    counts: {
+        count: number;
+        highlighted: string;
+        value: string;
+        parent?: Record<string, string | number | boolean>;
+    }[];
+    field_name: keyof T;
+    sampled: boolean;
+    stats: {
+        avg?: number;
+        max?: number;
+        min?: number;
+        sum?: number;
+        total_values?: number;
+    };
+}
+interface LLMResponse {
+    content: string;
+    extraction_method: string;
+    model: string;
+}
+export interface SearchResponse<T extends DocumentSchema> {
+    facet_counts?: SearchResponseFacetCountSchema<T>[];
+    found: number;
+    found_docs?: number;
+    out_of: number;
+    page: number;
+    request_params: SearchResponseRequestParams;
+    search_time_ms: number;
+    search_cutoff?: boolean;
+    hits?: SearchResponseHit<T>[];
+    grouped_hits?: {
+        group_key: string[];
+        hits: SearchResponseHit<T>[];
+        found?: number;
+    }[];
+    parsed_nl_query?: {
+        parse_time_ms: number;
+        generated_params: SearchParams<T>;
+        augmented_params: SearchParams<T>;
+        llm_response?: LLMResponse;
+    };
+    conversation?: {
+        answer: string;
+        conversation_history: {
+            conversation: object[];
+            id: string;
+            last_updated: number;
+            ttl: number;
+        };
+        conversation_id: string;
+        query: string;
+    };
+    error?: string;
+    code?: number;
+    metadata?: JsonRecord;
+}
+type JSONPrimitive = string | number | boolean | null;
+type JsonRecord = {
+    [key: string]: JSONPrimitive | JSONPrimitive[] | JsonRecord;
+};
+export interface DocumentWriteParameters {
+    dirty_values?: "coerce_or_reject" | "coerce_or_drop" | "drop" | "reject";
+    action?: "create" | "update" | "upsert" | "emplace";
+}
+export interface UpdateByFilterParameters {
+    filter_by?: string;
+}
+export interface UpdateByFilterResponse {
+    num_updated: number;
+}
+export interface DocumentImportParameters extends DocumentWriteParameters {
+    batch_size?: number;
+    remote_embedding_batch_size?: number;
+    remote_embedding_timeout_ms?: number;
+    remote_embedding_num_tries?: number;
+    return_doc?: boolean;
+    return_id?: boolean;
+    throwOnFail?: boolean;
+}
+export interface DocumentsExportParameters {
+    filter_by?: string;
+    include_fields?: string;
+    exclude_fields?: string;
+}
+export interface SearchOptions {
+    cacheSearchResultsForSeconds?: number;
+    abortSignal?: AbortSignal | null;
+}
+export default class Documents<T extends DocumentSchema = object> extends SearchOnlyDocuments<T> implements WriteableDocuments<T> {
+    constructor(collectionName: string, apiCall: ApiCall, configuration: Configuration);
+    create(document: T, options?: DocumentWriteParameters): Promise<T>;
+    upsert(document: T, options?: DocumentWriteParameters): Promise<T>;
+    update(document: T, options: UpdateByFilterParameters): Promise<UpdateByFilterResponse>;
+    update(document: T, options: DocumentWriteParameters): Promise<T>;
+    delete(query?: DeleteQuery): Promise<DeleteResponse<T>>;
+    createMany(documents: T[], options?: DocumentImportParameters): Promise<ImportResponse<T>[]>;
+    /**
+     * Import a set of documents in a batch.
+     * @param {string|Array} documents - Can be a JSONL string of documents or an array of document objects.
+     * @param options
+     * @return {string|Array} Returns a JSONL string if the input was a JSONL string, otherwise it returns an array of results.
+     */
+    import(documents: string, options?: DocumentImportParameters): Promise<string>;
+    import(documents: T[], options?: DocumentImportParameters): Promise<ImportResponse<T>[]>;
+    /**
+     * Imports documents from a NodeJS readable stream of JSONL.
+     */
+    importStream(readableStream: ReadStream, options?: DocumentImportParameters): Promise<ImportResponse<T>[]>;
+    /**
+     * Returns a JSONL string for all the documents in this collection
+     */
+    export(options?: DocumentsExportParameters): Promise<string>;
+    /**
+     * Returns a NodeJS readable stream of JSONL for all the documents in this collection.
+     */
+    exportStream(options?: DocumentsExportParameters): Promise<ReadStream>;
+}
+/**
+ * @deprecated Import from './Types' instead
+ */
+export type { SearchParams, WriteableDocuments, SearchableDocuments, DropTokensMode, OperationMode, UnionArrayKeys, UnionArraySearchParams, ArraybleParams, ExtractBaseTypes, SearchResponseRequestParams, } from "./Types";

package/lib/Typesense/Documents.js

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var Errors_1 = require("./Errors");
+var SearchOnlyDocuments_1 = require("./SearchOnlyDocuments");
+var isNodeJSEnvironment = typeof process !== "undefined" &&
+    process.versions != null &&
+    process.versions.node != null;
+var Documents = /** @class */ (function (_super) {
+    tslib_1.__extends(Documents, _super);
+    function Documents(collectionName, apiCall, configuration) {
+        return _super.call(this, collectionName, apiCall, configuration) || this;
+    }
+    Documents.prototype.create = function (document_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (document, options) {
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                if (!document)
+                    throw new Error("No document provided");
+                return [2 /*return*/, this.apiCall.post(this.endpointPath(), document, options)];
+            });
+        });
+    };
+    Documents.prototype.upsert = function (document_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (document, options) {
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                if (!document)
+                    throw new Error("No document provided");
+                return [2 /*return*/, this.apiCall.post(this.endpointPath(), document, Object.assign({}, options, { action: "upsert" }))];
+            });
+        });
+    };
+    Documents.prototype.update = function (document_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (document, options) {
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                if (!document)
+                    throw new Error("No document provided");
+                if (options["filter_by"] != null) {
+                    return [2 /*return*/, this.apiCall.patch(this.endpointPath(), document, Object.assign({}, options))];
+                }
+                else {
+                    return [2 /*return*/, this.apiCall.post(this.endpointPath(), document, Object.assign({}, options, { action: "update" }))];
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    Documents.prototype.delete = function () {
+        return tslib_1.__awaiter(this, arguments, void 0, function (query) {
+            if (query === void 0) { query = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.delete(this.endpointPath(), query)];
+            });
+        });
+    };
+    Documents.prototype.createMany = function (documents_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (documents, options) {
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                this.configuration.logger.warn("createMany is deprecated and will be removed in a future version. Use import instead, which now takes both an array of documents or a JSONL string of documents");
+                return [2 /*return*/, this.import(documents, options)];
+            });
+        });
+    };
+    Documents.prototype.import = function (documents_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (documents, options) {
+            var finalOptions, documentsInJSONLFormat, resultsInJSONLFormat, resultsInJSONFormat, failedItems;
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        finalOptions = tslib_1.__assign({ throwOnFail: true }, options);
+                        if (Array.isArray(documents)) {
+                            if (documents.length === 0) {
+                                throw new Errors_1.RequestMalformed("No documents provided");
+                            }
+                            try {
+                                documentsInJSONLFormat = documents
+                                    .map(function (document) { return JSON.stringify(document); })
+                                    .join("\n");
+                            }
+                            catch (error) {
+                                // if rangeerror, throw custom error message
+                                if (error instanceof RangeError &&
+                                    error.message.includes("Too many properties to enumerate")) {
+                                    throw new Error("".concat(error, "\n          It looks like you have reached a Node.js limit that restricts the number of keys in an Object: https://stackoverflow.com/questions/9282869/are-there-limits-to-the-number-of-properties-in-a-javascript-object\n\n         Please try reducing the number of keys in your document, or using CURL to import your data.\n          "));
+                                }
+                                // else, throw the non-range error anyways
+                                throw new Error(error);
+                            }
+                        }
+                        else {
+                            documentsInJSONLFormat = documents;
+                            if (isEmptyString(documentsInJSONLFormat)) {
+                                throw new Errors_1.RequestMalformed("No documents provided");
+                            }
+                        }
+                        return [4 /*yield*/, this.apiCall.performRequest("post", this.endpointPath("import"), {
+                                queryParameters: finalOptions,
+                                bodyParameters: documentsInJSONLFormat,
+                                additionalHeaders: { "Content-Type": "text/plain" },
+                                skipConnectionTimeout: true, // We never want to client-side-timeout on an import and retry, since imports are syncronous and we want to let them take as long as it takes to complete fully
+                                enableKeepAlive: isNodeJSEnvironment ? true : false, // This is to prevent ECONNRESET socket hang up errors. Reference: https://github.com/axios/axios/issues/2936#issuecomment-779439991
+                            })];
+                    case 1:
+                        resultsInJSONLFormat = _a.sent();
+                        if (Array.isArray(documents)) {
+                            resultsInJSONFormat = resultsInJSONLFormat
+                                .split("\n")
+                                .map(function (r) { return JSON.parse(r); });
+                            failedItems = resultsInJSONFormat.filter(function (r) { return r.success === false; });
+                            if (failedItems.length > 0 && finalOptions.throwOnFail) {
+                                throw new Errors_1.ImportError("".concat(resultsInJSONFormat.length - failedItems.length, " documents imported successfully, ").concat(failedItems.length, " documents failed during import. Use `error.importResults` from the raised exception to get a detailed error reason for each document."), resultsInJSONFormat, {
+                                    documentsInJSONLFormat: documentsInJSONLFormat,
+                                    options: finalOptions,
+                                    failedItems: failedItems,
+                                    successCount: resultsInJSONFormat.length - failedItems.length,
+                                });
+                            }
+                            else {
+                                return [2 /*return*/, resultsInJSONFormat];
+                            }
+                        }
+                        else {
+                            return [2 /*return*/, resultsInJSONLFormat];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Imports documents from a NodeJS readable stream of JSONL.
+     */
+    Documents.prototype.importStream = function (readableStream_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (readableStream, options) {
+            var finalOptions, resultsInJSONLFormat, resultsInJSONFormat, failedItems;
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        finalOptions = tslib_1.__assign({ throwOnFail: true }, options);
+                        return [4 /*yield*/, this.apiCall.performRequest("post", this.endpointPath("import"), {
+                                queryParameters: finalOptions,
+                                bodyParameters: readableStream,
+                                additionalHeaders: { "Content-Type": "text/plain" },
+                                skipConnectionTimeout: true, // We never want to client-side-timeout on an import and retry, since imports are syncronous and we want to let them take as long as it takes to complete fully
+                                enableKeepAlive: isNodeJSEnvironment ? true : false, // This is to prevent ECONNRESET socket hang up errors. Reference: https://github.com/axios/axios/issues/2936#issuecomment-779439991
+                            })];
+                    case 1:
+                        resultsInJSONLFormat = _a.sent();
+                        resultsInJSONFormat = resultsInJSONLFormat
+                            .split("\n")
+                            .map(function (r) { return JSON.parse(r); });
+                        failedItems = resultsInJSONFormat.filter(function (r) { return r.success === false; });
+                        if (failedItems.length > 0 && finalOptions.throwOnFail) {
+                            throw new Errors_1.ImportError("".concat(resultsInJSONFormat.length - failedItems.length, " documents imported successfully, ").concat(failedItems.length, " documents failed during import. Use `error.importResults` from the raised exception to get a detailed error reason for each document."), resultsInJSONFormat, {
+                                documentsInJSONLFormat: readableStream,
+                                options: finalOptions,
+                                failedItems: failedItems,
+                                successCount: resultsInJSONFormat.length - failedItems.length,
+                            });
+                        }
+                        else {
+                            return [2 /*return*/, resultsInJSONFormat];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Returns a JSONL string for all the documents in this collection
+     */
+    Documents.prototype.export = function () {
+        return tslib_1.__awaiter(this, arguments, void 0, function (options) {
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.get(this.endpointPath("export"), options)];
+            });
+        });
+    };
+    /**
+     * Returns a NodeJS readable stream of JSONL for all the documents in this collection.
+     */
+    Documents.prototype.exportStream = function () {
+        return tslib_1.__awaiter(this, arguments, void 0, function (options) {
+            if (options === void 0) { options = {}; }
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.apiCall.get(this.endpointPath("export"), options, {
+                        responseType: "stream",
+                    })];
+            });
+        });
+    };
+    return Documents;
+}(SearchOnlyDocuments_1.SearchOnlyDocuments));
+exports.default = Documents;
+function isEmptyString(str) {
+    return str == null || str === "" || str.length === 0;
+}
+//# sourceMappingURL=Documents.js.map

package/lib/Typesense/Documents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Documents.js","sourceRoot":"","sources":["../../src/Typesense/Documents.ts"],"names":[],"mappings":";;;AAGA,mCAAyD;AACzD,6DAA4D;AAmM5D,IAAM,mBAAmB,GACvB,OAAO,OAAO,KAAK,WAAW;IAC9B,OAAO,CAAC,QAAQ,IAAI,IAAI;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC;AAEhC;IACU,qCAAsB;IAG9B,mBACE,cAAsB,EACtB,OAAgB,EAChB,aAA4B;QAE5B,OAAA,MAAK,YAAC,cAAc,EAAE,OAAO,EAAE,aAAa,CAAC,SAAC;IAChD,CAAC;IAEK,0BAAM,GAAZ;oEAAa,QAAW,EAAE,OAAqC;YAArC,wBAAA,EAAA,YAAqC;;gBAC7D,IAAI,CAAC,QAAQ;oBAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;gBACvD,sBAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAI,IAAI,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAC;;;KACrE;IAEK,0BAAM,GAAZ;oEAAa,QAAW,EAAE,OAAqC;YAArC,wBAAA,EAAA,YAAqC;;gBAC7D,IAAI,CAAC,QAAQ;oBAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;gBACvD,sBAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAI,CAAC,YAAY,EAAE,EACnB,QAAQ,EACR,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CACjD,EAAC;;;KACH;IAOK,0BAAM,GAAZ;oEACE,QAAW,EACX,OAAgE;YAAhE,wBAAA,EAAA,YAAgE;;gBAEhE,IAAI,CAAC,QAAQ;oBAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;gBAEvD,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;oBACjC,sBAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CACvB,IAAI,CAAC,YAAY,EAAE,EACnB,QAAQ,EACR,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAC3B,EAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,sBAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAI,CAAC,YAAY,EAAE,EACnB,QAAQ,EACR,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CACjD,EAAC;gBACJ,CAAC;;;;KACF;IAEK,0BAAM,GAAZ;oEACE,KAAsC;YAAtC,sBAAA,EAAA,QAAqB,EAAiB;;gBAEtC,sBAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAoB,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,EAAC;;;KAC3E;IAEK,8BAAU,GAAhB;oEAAiB,SAAc,EAAE,OAAsC;YAAtC,wBAAA,EAAA,YAAsC;;gBACrE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAC5B,iKAAiK,CAClK,CAAC;gBACF,sBAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,EAAC;;;KACxC;IAgBK,0BAAM,GAAZ;oEACE,SAAuB,EACvB,OAAsC;;YAAtC,wBAAA,EAAA,YAAsC;;;;wBAGhC,YAAY,sBAAK,WAAW,EAAE,IAAI,IAAK,OAAO,CAAE,CAAC;wBAEvD,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;4BAC7B,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gCAC3B,MAAM,IAAI,yBAAgB,CAAC,uBAAuB,CAAC,CAAC;4BACtD,CAAC;4BACD,IAAI,CAAC;gCACH,sBAAsB,GAAG,SAAS;qCAC/B,GAAG,CAAC,UAAC,QAAQ,IAAK,OAAA,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAxB,CAAwB,CAAC;qCAC3C,IAAI,CAAC,IAAI,CAAC,CAAC;4BAChB,CAAC;4BAAC,OAAO,KAAU,EAAE,CAAC;gCACpB,4CAA4C;gCAC5C,IACE,KAAK,YAAY,UAAU;oCAC3B,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CAAC,EAC1D,CAAC;oCACD,MAAM,IAAI,KAAK,CAAC,UAAG,KAAK,mVAIvB,CAAC,CAAC;gCACL,CAAC;gCAED,0CAA0C;gCAC1C,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;4BACzB,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,sBAAsB,GAAG,SAAS,CAAC;4BACnC,IAAI,aAAa,CAAC,sBAAsB,CAAC,EAAE,CAAC;gCAC1C,MAAM,IAAI,yBAAgB,CAAC,uBAAuB,CAAC,CAAC;4BACtD,CAAC;wBACH,CAAC;wBAE4B,qBAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAC5D,MAAM,EACN,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAC3B;gCACE,eAAe,EAAE,YAAY;gCAC7B,cAAc,EAAE,sBAAsB;gCACtC,iBAAiB,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE;gCACnD,qBAAqB,EAAE,IAAI,EAAE,+JAA+J;gCAC5L,eAAe,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,oIAAoI;6BAC1L,CACF,EAAA;;wBAVK,oBAAoB,GAAG,SAU5B;wBAED,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;4BACvB,mBAAmB,GAAG,oBAAoB;iCAC7C,KAAK,CAAC,IAAI,CAAC;iCACX,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAb,CAAa,CAAwB,CAAC;4BAC9C,WAAW,GAAG,mBAAmB,CAAC,MAAM,CAC5C,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,OAAO,KAAK,KAAK,EAAnB,CAAmB,CAC3B,CAAC;4BACF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC;gCACvD,MAAM,IAAI,oBAAW,CACnB,UACE,mBAAmB,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,+CAE/C,WAAW,CAAC,MAAM,2IACsH,EAC1I,mBAAmB,EACnB;oCACE,sBAAsB,wBAAA;oCACtB,OAAO,EAAE,YAAY;oCACrB,WAAW,aAAA;oCACX,YAAY,EAAE,mBAAmB,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM;iCAC9D,CACF,CAAC;4BACJ,CAAC;iCAAM,CAAC;gCACN,sBAAO,mBAAmB,EAAC;4BAC7B,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,sBAAO,oBAA8B,EAAC;wBACxC,CAAC;;;;;KACF;IACD;;OAEG;IACG,gCAAY,GAAlB;oEACE,cAA0B,EAC1B,OAAsC;;YAAtC,wBAAA,EAAA,YAAsC;;;;wBAEhC,YAAY,sBAAK,WAAW,EAAE,IAAI,IAAK,OAAO,CAAE,CAAC;wBAE1B,qBAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAC5D,MAAM,EACN,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAC3B;gCACE,eAAe,EAAE,YAAY;gCAC7B,cAAc,EAAE,cAAc;gCAC9B,iBAAiB,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE;gCACnD,qBAAqB,EAAE,IAAI,EAAE,+JAA+J;gCAC5L,eAAe,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,oIAAoI;6BAC1L,CACF,EAAA;;wBAVK,oBAAoB,GAAG,SAU5B;wBAEK,mBAAmB,GAAG,oBAAoB;6BAC7C,KAAK,CAAC,IAAI,CAAC;6BACX,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAb,CAAa,CAAwB,CAAC;wBAC9C,WAAW,GAAG,mBAAmB,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,OAAO,KAAK,KAAK,EAAnB,CAAmB,CAAC,CAAC;wBAC3E,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC;4BACvD,MAAM,IAAI,oBAAW,CACnB,UACE,mBAAmB,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,+CAE/C,WAAW,CAAC,MAAM,2IACsH,EAC1I,mBAAmB,EACnB;gCACE,sBAAsB,EAAE,cAAc;gCACtC,OAAO,EAAE,YAAY;gCACrB,WAAW,aAAA;gCACX,YAAY,EAAE,mBAAmB,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM;6BAC9D,CACF,CAAC;wBACJ,CAAC;6BAAM,CAAC;4BACN,sBAAO,mBAAmB,EAAC;wBAC7B,CAAC;;;;;KACF;IAED;;OAEG;IACG,0BAAM,GAAZ;oEAAa,OAAuC;YAAvC,wBAAA,EAAA,YAAuC;;gBAClD,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAS,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAC;;;KACvE;IAED;;OAEG;IACG,gCAAY,GAAlB;oEACE,OAAuC;YAAvC,wBAAA,EAAA,YAAuC;;gBAEvC,sBAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAa,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE;wBACxE,YAAY,EAAE,QAAQ;qBACvB,CAAC,EAAC;;;KACJ;IACH,gBAAC;AAAD,CAAC,AA5ND,CACU,yCAAmB,GA2N5B;;AAED,SAAS,aAAa,CAAC,GAA8B;IACnD,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,KAAK,EAAE,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;AACvD,CAAC"}

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

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

package/lib/Typesense/Errors/HTTPError.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 HTTPError = /** @class */ (function (_super) {
+    tslib_1.__extends(HTTPError, _super);
+    function HTTPError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return HTTPError;
+}(TypesenseError_1.default));
+exports.default = HTTPError;
+//# sourceMappingURL=HTTPError.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HTTPError.js","sourceRoot":"","sources":["../../../src/Typesense/Errors/HTTPError.ts"],"names":[],"mappings":";;;AAAA,4EAA8C;AAE9C;IAAuC,qCAAc;IAArD;;IAAuD,CAAC;IAAD,gBAAC;AAAD,CAAC,AAAxD,CAAuC,wBAAc,GAAG"}