@or-sdk/lookup 1.1.0-beta.1830.0

package/dist/esm/error-parser/parse-axios-error.js

@@ -0,0 +1,34 @@
+import { OrNetworkError } from './OrNetworkError';
+const MESSAGES = {
+    401: 'We are not able to authenticate you',
+    500: 'Internal server error',
+};
+export function parseAxiosError(e) {
+    if (e.response) {
+        const data = e.response.data;
+        const status = e.response.status;
+        const generalMessage = MESSAGES[status] || e.message;
+        const message = normalizeMessage(data.message || data.error) || generalMessage;
+        if (status < 500) {
+            return new OrNetworkError({
+                message,
+                status,
+            });
+        }
+        return new OrNetworkError({
+            message: generalMessage,
+            status,
+            description: message,
+        });
+    }
+    return new Error(e.message);
+}
+function normalizeMessage(message) {
+    if (typeof message === 'string') {
+        return message;
+    }
+    if (Array.isArray(message)) {
+        return message.join('. ');
+    }
+}
+//# sourceMappingURL=parse-axios-error.js.map

package/dist/esm/error-parser/parse-axios-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-axios-error.js","sourceRoot":"","sources":["../../../src/error-parser/parse-axios-error.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,QAAQ,GAA2B;IACvC,GAAG,EAAE,qCAAqC;IAC1C,GAAG,EAAE,uBAAuB;CAC7B,CAAC;AAEF,MAAM,UAAU,eAAe,CAAC,CAAa;IAC3C,IAAI,CAAC,CAAC,QAAQ,EAAE;QACd,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,IAA+B,CAAC;QACxD,MAAM,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QACjC,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;QACrD,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC;QAE/E,IAAI,MAAM,GAAG,GAAG,EAAE;YAChB,OAAO,IAAI,cAAc,CAAC;gBACxB,OAAO;gBACP,MAAM;aACP,CAAC,CAAC;SACJ;QACD,OAAO,IAAI,cAAc,CAAC;YACxB,OAAO,EAAE,cAAc;YACvB,MAAM;YACN,WAAW,EAAE,OAAO;SACrB,CAAC,CAAC;KACJ;IAED,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACxC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO,OAAO,CAAC;KAChB;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC1B,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC3B;AACH,CAAC"}

package/dist/esm/error-parser/processors.js

@@ -0,0 +1,16 @@
+import { parseAxiosError as deprecatedParseAxiosError } from '@or-sdk/base';
+import axios from 'axios';
+import { parseAxiosError } from './parse-axios-error';
+const DEPRECATED_AXIOS = {
+    guard: axios.isAxiosError,
+    convertError: deprecatedParseAxiosError,
+};
+const AXIOS = {
+    guard: axios.isAxiosError,
+    convertError: parseAxiosError,
+};
+export const processors = {
+    AXIOS,
+    DEPRECATED_AXIOS,
+};
+//# sourceMappingURL=processors.js.map

package/dist/esm/error-parser/processors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processors.js","sourceRoot":"","sources":["../../../src/error-parser/processors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,IAAI,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAC5E,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,MAAM,gBAAgB,GAA+B;IACnD,KAAK,EAAE,KAAK,CAAC,YAAY;IACzB,YAAY,EAAE,yBAAoD;CACnE,CAAC;AAEF,MAAM,KAAK,GAA+B;IACxC,KAAK,EAAE,KAAK,CAAC,YAAY;IACzB,YAAY,EAAE,eAAe;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,KAAK;IACL,gBAAgB;CACjB,CAAC"}

package/dist/esm/error-parser/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/error-parser/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/error-parser/types.ts"],"names":[],"mappings":""}

package/dist/esm/guards.js

@@ -0,0 +1,5 @@
+import { OrNetworkError } from './error-parser';
+export function isOrNetworkError(err) {
+    return err instanceof OrNetworkError;
+}
+//# sourceMappingURL=guards.js.map

package/dist/esm/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,UAAU,gBAAgB,CAAC,GAAY;IAC3C,OAAO,GAAG,YAAY,cAAc,CAAC;AACvC,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+export { Lookup as Lookup } from './Lookup';
+export * from './types';
+export * from './constants';
+export * from './guards';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC5C,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC"}

package/dist/esm/types.js

@@ -0,0 +1,8 @@
+export var DocumentStatus;
+(function (DocumentStatus) {
+    DocumentStatus["NEW"] = "NEW";
+    DocumentStatus["LOADING"] = "LOADING";
+    DocumentStatus["READY"] = "READY";
+    DocumentStatus["ERROR"] = "ERROR";
+})(DocumentStatus || (DocumentStatus = {}));
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAyOA,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,qCAAmB,CAAA;IACnB,iCAAe,CAAA;IACf,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB"}

package/dist/types/Lookup.d.ts

@@ -0,0 +1,27 @@
+import { Base, List } from '@or-sdk/base';
+import { LoadDocument, CreateCollection, Search, Ask, UpdateCollection, UpdateDocument, LookupConfig, Document, Collection, SearchResult, AskResults, Find, Property, CreatePassage, Passage, UpdatePassage, DeletedPassage, FindPassages } from './types';
+export declare class Lookup extends Base {
+    constructor(params: LookupConfig);
+    parseError(err: unknown): Error;
+    loadDocument(collectionId: string, params: LoadDocument): Promise<Document>;
+    createCollection(params: CreateCollection): Promise<Collection>;
+    createPassage<T extends Record<string, unknown>>(collectionId: string, passage: CreatePassage<T>): Promise<Passage<T>>;
+    createManyPassages<T extends Record<string, unknown>>(collectionId: string, passages: CreatePassage<T>[]): Promise<void>;
+    deleteCollection(collectionId: string): Promise<Collection>;
+    deletePassage(collectionId: string, passageId: string): Promise<DeletedPassage>;
+    search(collectionId: string, params: Search): Promise<SearchResult[]>;
+    ask(collectionId: string, params: Ask): Promise<AskResults>;
+    updateDocument(collectionId: string, documentId: string, params: UpdateDocument): Promise<Document>;
+    updatePassage<T extends Record<string, unknown>>(collectionId: string, passageId: string, params: UpdatePassage<T>): Promise<Passage<T>>;
+    updateCollection(collectionId: string, params: UpdateCollection): Promise<Collection>;
+    getDocument(collectionId: string, documentId: string): Promise<Document>;
+    getCollection(collectionId: string): Promise<Collection>;
+    getPassage<T extends Record<string, unknown>>(collectionId: string, passageId: string): Promise<Passage<T>>;
+    addProperty(collectionId: string, property: Property): Promise<void>;
+    listDocuments(collectionId: string, params?: Find): Promise<List<Document>>;
+    listCollections(params?: Find): Promise<List<Collection>>;
+    listPassages<T extends Record<string, unknown>>(collectionId: string, params?: FindPassages): Promise<List<Passage<T>>>;
+    listPassagesInDocument<T extends Record<string, unknown>>(collectionId: string, documentId: string, find?: FindPassages): Promise<List<Passage<T>>>;
+    deleteDocument(collectionId: string, documentId: string): Promise<Document>;
+}
+//# sourceMappingURL=Lookup.d.ts.map

package/dist/types/Lookup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Lookup.d.ts","sourceRoot":"","sources":["../../src/Lookup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAEpD,OAAO,EACL,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAC7D,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAChE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EACjE,cAAc,EAAE,YAAY,EAC7B,MAAM,SAAS,CAAC;AAKjB,qBAAa,MAAO,SAAQ,IAAI;gBAClB,MAAM,EAAE,YAAY;IAYhC,UAAU,CAAC,GAAG,EAAE,OAAO;IAIjB,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC;IAc3E,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAgB/D,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAehB,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,GAC3B,OAAO,CAAC,IAAI,CAAC;IAaV,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAe3D,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAe/E,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAgBrE,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC;IAiB3D,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgBnG,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnD,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GACvB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAiBhB,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAerF,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAaxE,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAcxD,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAmB3G,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAcpE,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,MAAM,GAAE,IAAS,GAChB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAepB,eAAe,CACnB,MAAM,GAAE,IAAS,GAChB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAgBtB,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClD,YAAY,EAAE,MAAM,EACpB,MAAM,GAAE,YAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAiBtB,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,YAAiB,GACtB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAgBtB,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQlF"}

package/dist/types/__tests__/QnA.collections.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=QnA.collections.spec.d.ts.map

package/dist/types/__tests__/QnA.collections.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QnA.collections.spec.d.ts","sourceRoot":"","sources":["../../../src/__tests__/QnA.collections.spec.ts"],"names":[],"mappings":""}

package/dist/types/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const SERVICE_KEY = "lookup-api";
+//# sourceMappingURL=constants.d.ts.map

package/dist/types/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,eAAe,CAAC"}

package/dist/types/error-parser/OrNetworkError.d.ts

@@ -0,0 +1,14 @@
+type CtorOptions = {
+    message: string;
+    description?: string;
+    status?: number;
+};
+export declare class OrNetworkError extends Error {
+    private _status;
+    private _description;
+    constructor({ description, message, status }: CtorOptions);
+    get status(): number | undefined;
+    get description(): string | undefined;
+}
+export {};
+//# sourceMappingURL=OrNetworkError.d.ts.map

package/dist/types/error-parser/OrNetworkError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrNetworkError.d.ts","sourceRoot":"","sources":["../../../src/error-parser/OrNetworkError.ts"],"names":[],"mappings":"AAAA,KAAK,WAAW,GAAG;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,qBAAa,cAAe,SAAQ,KAAK;IACvC,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,YAAY,CAAqB;gBAC7B,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,WAAW;IAMzD,IAAI,MAAM,uBAET;IAED,IAAI,WAAW,uBAEd;CACF"}

package/dist/types/error-parser/index.d.ts

@@ -0,0 +1,5 @@
+import type { ErrorProcessor } from './types';
+export * from './OrNetworkError';
+export * from './processors';
+export declare function createErrorParser<E>(...processors: ErrorProcessor<E>[]): (error: unknown) => Error;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/error-parser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/error-parser/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAE7B,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,WACnC,OAAO,WAS1C"}

package/dist/types/error-parser/parse-axios-error.d.ts

@@ -0,0 +1,3 @@
+import type { AxiosError } from 'axios';
+export declare function parseAxiosError(e: AxiosError): Error;
+//# sourceMappingURL=parse-axios-error.d.ts.map

package/dist/types/error-parser/parse-axios-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-axios-error.d.ts","sourceRoot":"","sources":["../../../src/error-parser/parse-axios-error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AASxC,wBAAgB,eAAe,CAAC,CAAC,EAAE,UAAU,GAAG,KAAK,CAqBpD"}

package/dist/types/error-parser/processors.d.ts

@@ -0,0 +1,7 @@
+import type { AxiosError } from 'axios';
+import type { ErrorProcessor } from './types';
+export declare const processors: {
+    AXIOS: ErrorProcessor<AxiosError<any, any>>;
+    DEPRECATED_AXIOS: ErrorProcessor<AxiosError<any, any>>;
+};
+//# sourceMappingURL=processors.d.ts.map

package/dist/types/error-parser/processors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processors.d.ts","sourceRoot":"","sources":["../../../src/error-parser/processors.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAGxC,OAAO,KAAK,EAAe,cAAc,EAAE,MAAM,SAAS,CAAC;AAY3D,eAAO,MAAM,UAAU;;;CAGtB,CAAC"}

package/dist/types/error-parser/types.d.ts

@@ -0,0 +1,6 @@
+export type ErrorParser<T> = (error: T) => Error;
+export type ErrorProcessor<E = unknown> = {
+    guard: (error: unknown) => error is E;
+    convertError: (error: E) => Error;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/error-parser/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/error-parser/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,CAAC;AAEjD,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI;IACxC,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;IACtC,YAAY,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,CAAC;CACnC,CAAC"}

package/dist/types/guards.d.ts

@@ -0,0 +1,3 @@
+import { OrNetworkError } from './error-parser';
+export declare function isOrNetworkError(err: unknown): err is OrNetworkError;
+//# sourceMappingURL=guards.d.ts.map

package/dist/types/guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAEpE"}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export { Lookup as Lookup } from './Lookup';
+export * from './types';
+export * from './constants';
+export * from './guards';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC5C,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC"}

package/dist/types/types.d.ts

@@ -0,0 +1,146 @@
+import { OrderOptions, PaginationOptions, Token } from '@or-sdk/base';
+export type { OrNetworkError } from './error-parser';
+export type SearchMode = 'vector' | 'bm25';
+export type LookupConfig = {
+    token: Token;
+    discoveryUrl?: string;
+    accountId?: string;
+    serviceUrl?: string;
+};
+export type LoadDocument = {
+    name: string;
+    url?: string;
+    description?: string;
+    defaultProperties: Record<string, unknown>;
+};
+export type Property = {
+    name: string;
+    dataType: string;
+    description?: string;
+};
+export type CreateCollection = UpdateCollection & {
+    name: string;
+    properties?: Property[];
+};
+export type Search = {
+    query: string;
+    limit?: number;
+    where?: Record<string, unknown>;
+    select?: string[];
+    maxDistance?: number;
+};
+export type MessageRole = 'user' | 'assistant';
+export type AskMode = 'conversation' | 'ask';
+export type CompletionRequestMessage = {
+    role: MessageRole;
+    content: string;
+};
+export type Ask = {
+    question: string;
+    messages?: CompletionRequestMessage[];
+    limit?: number;
+    where?: Record<string, unknown>;
+    select?: string[];
+    mode?: AskMode;
+    answerInstruction?: string | null;
+    questionInstruction?: string | null;
+    temperature?: number;
+    maxTokens?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
+    maxDistance?: number;
+};
+export declare enum DocumentStatus {
+    NEW = "NEW",
+    LOADING = "LOADING",
+    READY = "READY",
+    ERROR = "ERROR"
+}
+export type Document = {
+    id: string;
+    collection: string;
+    name: string;
+    description: string;
+    status: DocumentStatus | string;
+    createdAt: string;
+    updatedAt: string;
+    countPassages?: number;
+    sourceUrl?: string;
+};
+export type Collection = {
+    id: string;
+    accountId: string;
+    name: string;
+    description?: string;
+    imageUrl?: string;
+    answerInstruction?: string | null;
+    questionInstruction?: string | null;
+    greetingInstruction?: string | null;
+    properties?: Property[];
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    temperature?: number;
+    maxTokens?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
+    maxDistance?: number;
+    modelName?: string;
+    countPassages?: number;
+};
+export type SearchResult = {
+    id: string;
+    distance: string;
+    content: string;
+    sourceUrl: string;
+    loaderMetadata: Record<string, unknown>;
+    document: {
+        id: string;
+        name: string;
+    };
+};
+export type AskResults = {
+    result: CompletionRequestMessage;
+    searchResult: SearchResult;
+};
+export type UpdateDocument = {
+    description?: string;
+    status?: DocumentStatus | string;
+};
+export type UpdateCollection = {
+    description?: string;
+    imageUrl?: string;
+    answerInstruction?: string;
+    questionInstruction?: string;
+    greetingInstruction?: string;
+    temperature?: number;
+    maxTokens?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
+    maxDistance?: number;
+    modelName?: string;
+};
+export type Find = Partial<PaginationOptions> & Partial<OrderOptions> & {
+    query?: string;
+    mode?: SearchMode;
+};
+export type FindPassages = Find & {
+    where?: Record<string, unknown>;
+};
+export type CreatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
+    content: string;
+    documentId: string;
+    loaderMetadata?: Record<string, unknown>;
+} & T;
+export type Passage<T extends Record<string, unknown> = Record<string, unknown>> = {
+    id: string;
+    content: string;
+    createdAt: string;
+    updatedAt: string;
+} & T;
+export type UpdatePassage<T extends Record<string, unknown> = Record<string, unknown>> = {
+    content: string;
+} & T;
+export type DeletedPassage = {
+    id: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAEtE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG;IAIzB,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAIzB,IAAI,EAAE,MAAM,CAAC;IAKb,GAAG,CAAC,EAAE,MAAM,CAAC;IAKb,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IAIrB,IAAI,EAAE,MAAM,CAAC;IAKb,QAAQ,EAAE,MAAM,CAAC;IAKjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG;IAMhD,IAAI,EAAE,MAAM,CAAC;IAMb,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;CACzB,CAAC;AAKF,MAAM,MAAM,MAAM,GAAG;IAInB,KAAK,EAAE,MAAM,CAAC;IAKd,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKhC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAOlB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC;AAC/C,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG,KAAK,CAAC;AAK7C,MAAM,MAAM,wBAAwB,GAAG;IAIrC,IAAI,EAAE,WAAW,CAAC;IAKlB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAKF,MAAM,MAAM,GAAG,GAAG;IAIhB,QAAQ,EAAE,MAAM,CAAC;IAMjB,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAOtC,KAAK,CAAC,EAAE,MAAM,CAAC;IAMf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAMhC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAOlB,IAAI,CAAC,EAAE,OAAO,CAAC;IAOf,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAOlC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAOpC,WAAW,CAAC,EAAE,MAAM,CAAC;IAOrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAOnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAO1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAKF,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAKD,MAAM,MAAM,QAAQ,GAAG;IAIrB,EAAE,EAAE,MAAM,CAAC;IAKX,UAAU,EAAE,MAAM,CAAC;IAKnB,IAAI,EAAE,MAAM,CAAC;IAKb,WAAW,EAAE,MAAM,CAAC;IAKpB,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC;IAKhC,SAAS,EAAE,MAAM,CAAC;IAKlB,SAAS,EAAE,MAAM,CAAC;IAKlB,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAKF,MAAM,MAAM,UAAU,GAAG;IAIvB,EAAE,EAAE,MAAM,CAAC;IAKX,SAAS,EAAE,MAAM,CAAC;IAOlB,IAAI,EAAE,MAAM,CAAC;IAMb,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMlC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMpC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAMpC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IAKxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAKzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAMzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAMnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAIzB,EAAE,EAAE,MAAM,CAAC;IAKX,QAAQ,EAAE,MAAM,CAAC;IAKjB,OAAO,EAAE,MAAM,CAAC;IAKhB,SAAS,EAAE,MAAM,CAAC;IAKlB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKxC,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAKF,MAAM,MAAM,UAAU,GAAG;IAIvB,MAAM,EAAE,wBAAwB,CAAC;IAKjC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAMF,MAAM,MAAM,cAAc,GAAG;IAI3B,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;CAClC,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG;IAK7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAM3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAM7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAM7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAMnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAOzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAKF,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG;IAItE,KAAK,CAAC,EAAE,MAAM,CAAC;IAKf,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG;IAIhC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAKF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAIvF,OAAO,EAAE,MAAM,CAAC;IAKhB,UAAU,EAAE,MAAM,CAAC;IAKnB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C,GAAG,CAAC,CAAC;AAKN,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAIjF,EAAE,EAAE,MAAM,CAAC;IAKX,OAAO,EAAE,MAAM,CAAC;IAKhB,SAAS,EAAE,MAAM,CAAC;IAKlB,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,CAAC,CAAC;AAMN,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAIvF,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,CAAC,CAAC;AAKN,MAAM,MAAM,cAAc,GAAG;IAI3B,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@or-sdk/lookup",
+  "version": "1.1.0-beta.1830.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs",
+    "build:cjs": "tsc --project tsconfig.json",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:types": "tsc --project tsconfig.types.json",
+    "build:watch": "concurrently -r --hide 1,2 \"pnpm build:watch:cjs\" \"pnpm build:watch:esm\" \"pnpm build:watch:types\"",
+    "build:watch:cjs": "tsc --project tsconfig.json -w",
+    "build:watch:esm": "tsc --project tsconfig.esm.json -w",
+    "build:watch:types": "tsc --project tsconfig.types.json -w",
+    "coverage": "vitest run --coverage",
+    "clean": "rm -rf ./dist",
+    "dev": "pnpm build:watch:esm",
+    "test": "vitest",
+    "test:watch": "vitest --watch"
+  },
+  "dependencies": {
+    "@or-sdk/base": "^0.29.0",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.176",
+    "@vitest/coverage-c8": "^0.31.1",
+    "concurrently": "^6.4.0",
+    "msw": "^1.2.1",
+    "typescript": "^4.4.4",
+    "vitest": "^0.31.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}