@mixedbread/sdk 0.1.0-alpha.10

package/index.d.ts

@@ -0,0 +1,169 @@
+import { type Agent } from "./_shims/index.js";
+import * as Core from "./core.js";
+import * as Errors from "./error.js";
+import * as Pagination from "./pagination.js";
+import { type LimitOffsetParams, LimitOffsetResponse } from "./pagination.js";
+import * as Uploads from "./uploads.js";
+import * as EmbeddingsAPI from "./resources/embeddings.js";
+import { Embedding, EmbeddingCreateParams, EmbeddingCreateResponse, Embeddings } from "./resources/embeddings.js";
+import * as API from "./resources/index.js";
+import * as TopLevelAPI from "./resources/top-level.js";
+import { EmbedParams, InfoResponse, RerankParams, RerankResponse } from "./resources/top-level.js";
+import { FileCreateParams, FileDeleteResponse, FileListParams, FileObject, FileObjectsLimitOffset, FileUpdateParams, Files } from "./resources/files.js";
+import { Extractions } from "./resources/extractions/extractions.js";
+import { Parsing } from "./resources/parsing/parsing.js";
+import { ExpiresAfter, FileCounts, ScoredVectorStoreChunk, VectorStore, VectorStoreChunkSearchOptions, VectorStoreCreateParams, VectorStoreDeleteResponse, VectorStoreFileSearchOptions, VectorStoreListParams, VectorStoreQuestionAnsweringParams, VectorStoreQuestionAnsweringResponse, VectorStoreSearchParams, VectorStoreSearchResponse, VectorStoreUpdateParams, VectorStores, VectorStoresLimitOffset } from "./resources/vector-stores/vector-stores.js";
+declare const environments: {
+    production: string;
+    local: string;
+};
+type Environment = keyof typeof environments;
+export interface ClientOptions {
+    /**
+     * Api key to authenticate with Mixedbread
+     */
+    apiKey?: string | undefined;
+    /**
+     * Specifies the environment to use for the API.
+     *
+     * Each environment maps to a different base URL:
+     * - `production` corresponds to `https://api.mixedbread.ai`
+     * - `local` corresponds to `http://127.0.0.1:8000`
+     */
+    environment?: Environment | undefined;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+     *
+     * Defaults to process.env['MIXEDBREAD_BASE_URL'].
+     */
+    baseURL?: string | null | undefined;
+    /**
+     * The maximum amount of time (in milliseconds) that the client should wait for a response
+     * from the server before timing out a single request.
+     *
+     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+     * much longer than this timeout before the promise succeeds or fails.
+     */
+    timeout?: number | undefined;
+    /**
+     * An HTTP agent used to manage HTTP(S) connections.
+     *
+     * If not provided, an agent will be constructed by default in the Node.js environment,
+     * otherwise no agent is used.
+     */
+    httpAgent?: Agent | undefined;
+    /**
+     * Specify a custom `fetch` function implementation.
+     *
+     * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+     * defined globally.
+     */
+    fetch?: Core.Fetch | undefined;
+    /**
+     * The maximum number of times that the client will retry a request in case of a
+     * temporary failure, like a network error or a 5XX error from the server.
+     *
+     * @default 2
+     */
+    maxRetries?: number | undefined;
+    /**
+     * Default headers to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * header to `undefined` or `null` in request options.
+     */
+    defaultHeaders?: Core.Headers | undefined;
+    /**
+     * Default query parameters to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * param to `undefined` in request options.
+     */
+    defaultQuery?: Core.DefaultQuery | undefined;
+}
+/**
+ * API Client for interfacing with the Mixedbread API.
+ */
+export declare class Mixedbread extends Core.APIClient {
+    apiKey: string;
+    private _options;
+    /**
+     * API Client for interfacing with the Mixedbread API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['MXBAI_API_KEY'] ?? undefined]
+     * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
+     * @param {string} [opts.baseURL=process.env['MIXEDBREAD_BASE_URL'] ?? https://api.mixedbread.ai] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
+    embeddings: API.Embeddings;
+    parsing: API.Parsing;
+    files: API.Files;
+    vectorStores: API.VectorStores;
+    extractions: API.Extractions;
+    /**
+     * Create embeddings for text or images using the specified model, encoding format,
+     * and normalization.
+     *
+     * Args: params: The parameters for creating embeddings.
+     *
+     * Returns: EmbeddingCreateResponse: The response containing the embeddings.
+     */
+    embed(body: TopLevelAPI.EmbedParams, options?: Core.RequestOptions): Core.APIPromise<EmbeddingsAPI.EmbeddingCreateResponse>;
+    /**
+     * Returns service information, including name and version.
+     *
+     * Returns: InfoResponse: A response containing the service name and version.
+     */
+    info(options?: Core.RequestOptions): Core.APIPromise<TopLevelAPI.InfoResponse>;
+    /**
+     * Rerank different kind of documents for a given query.
+     *
+     * Args: params: RerankingCreateParams: The parameters for reranking.
+     *
+     * Returns: RerankingCreateResponse: The reranked documents for the input query.
+     */
+    rerank(body: TopLevelAPI.RerankParams, options?: Core.RequestOptions): Core.APIPromise<TopLevelAPI.RerankResponse>;
+    protected defaultQuery(): Core.DefaultQuery | undefined;
+    protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
+    protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
+    static Mixedbread: typeof Mixedbread;
+    static DEFAULT_TIMEOUT: number;
+    static MixedbreadError: typeof Errors.MixedbreadError;
+    static APIError: typeof Errors.APIError;
+    static APIConnectionError: typeof Errors.APIConnectionError;
+    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
+    static APIUserAbortError: typeof Errors.APIUserAbortError;
+    static NotFoundError: typeof Errors.NotFoundError;
+    static ConflictError: typeof Errors.ConflictError;
+    static RateLimitError: typeof Errors.RateLimitError;
+    static BadRequestError: typeof Errors.BadRequestError;
+    static AuthenticationError: typeof Errors.AuthenticationError;
+    static InternalServerError: typeof Errors.InternalServerError;
+    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
+    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
+    static toFile: typeof Uploads.toFile;
+    static fileFromPath: typeof Uploads.fileFromPath;
+}
+export declare namespace Mixedbread {
+    export type RequestOptions = Core.RequestOptions;
+    export import LimitOffset = Pagination.LimitOffset;
+    export { type LimitOffsetParams as LimitOffsetParams, type LimitOffsetResponse as LimitOffsetResponse };
+    export { type InfoResponse as InfoResponse, type RerankResponse as RerankResponse, type EmbedParams as EmbedParams, type RerankParams as RerankParams, };
+    export { Embeddings as Embeddings, type Embedding as Embedding, type EmbeddingCreateResponse as EmbeddingCreateResponse, type EmbeddingCreateParams as EmbeddingCreateParams, };
+    export { Parsing as Parsing };
+    export { Files as Files, type FileObject as FileObject, type FileDeleteResponse as FileDeleteResponse, FileObjectsLimitOffset as FileObjectsLimitOffset, type FileCreateParams as FileCreateParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, };
+    export { VectorStores as VectorStores, type ExpiresAfter as ExpiresAfter, type FileCounts as FileCounts, type ScoredVectorStoreChunk as ScoredVectorStoreChunk, type VectorStore as VectorStore, type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions, type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions, type VectorStoreDeleteResponse as VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse as VectorStoreSearchResponse, VectorStoresLimitOffset as VectorStoresLimitOffset, type VectorStoreCreateParams as VectorStoreCreateParams, type VectorStoreUpdateParams as VectorStoreUpdateParams, type VectorStoreListParams as VectorStoreListParams, type VectorStoreQuestionAnsweringParams as VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams as VectorStoreSearchParams, };
+    export { Extractions as Extractions };
+    export type SearchFilter = API.SearchFilter;
+    export type SearchFilterCondition = API.SearchFilterCondition;
+}
+export { toFile, fileFromPath } from "./uploads.js";
+export { MixedbreadError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js";
+export default Mixedbread;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAC;AACxD,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EACX,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,KAAK,WAAW,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAChG,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,sBAAsB,EACtB,gBAAgB,EAChB,KAAK,EACN,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EACL,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,WAAW,EACX,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,qBAAqB,EACrB,kCAAkC,EAClC,oCAAoC,EACpC,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,uBAAuB,EACxB,MAAM,yCAAyC,CAAC;AAEjD,QAAA,MAAM,YAAY;;;CAGjB,CAAC;AACF,KAAK,WAAW,GAAG,MAAM,OAAO,YAAY,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,IAAI,CAAC,SAAS;IAC5C,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;OAYG;gBACS,EACV,OAA6C,EAC7C,MAAsC,EACtC,GAAG,IAAI,EACR,GAAE,aAAkB;IAiCrB,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;IACtD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;IACvC,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,WAAW,EAAE,GAAG,CAAC,WAAW,CAA6B;IAEzD;;;;;;;OAOG;IACH,KAAK,CACH,IAAI,EAAE,WAAW,CAAC,WAAW,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,uBAAuB,CAAC;IAIzD;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC;IAI9E;;;;;;OAMG;IACH,MAAM,CACJ,IAAI,EAAE,WAAW,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,cAAc,CAAC;cAI3B,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAO5D,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAI5E,MAAM,CAAC,UAAU,oBAAQ;IACzB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AASD,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IACnD,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAExG,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,sBAAsB,IAAI,sBAAsB,EAChD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,CAAC;IAEtC,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAC5C,MAAM,MAAM,qBAAqB,GAAG,GAAG,CAAC,qBAAqB,CAAC;CAC/D;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,eAAe,EACf,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,UAAU,CAAC"}

package/index.js

@@ -0,0 +1,175 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnprocessableEntityError = exports.PermissionDeniedError = exports.InternalServerError = exports.AuthenticationError = exports.BadRequestError = exports.RateLimitError = exports.ConflictError = exports.NotFoundError = exports.APIUserAbortError = exports.APIConnectionTimeoutError = exports.APIConnectionError = exports.APIError = exports.MixedbreadError = exports.fileFromPath = exports.toFile = exports.Mixedbread = void 0;
+const Core = __importStar(require("./core.js"));
+const Errors = __importStar(require("./error.js"));
+const Pagination = __importStar(require("./pagination.js"));
+const Uploads = __importStar(require("./uploads.js"));
+const embeddings_1 = require("./resources/embeddings.js");
+const API = __importStar(require("./resources/index.js"));
+const files_1 = require("./resources/files.js");
+const extractions_1 = require("./resources/extractions/extractions.js");
+const parsing_1 = require("./resources/parsing/parsing.js");
+const vector_stores_1 = require("./resources/vector-stores/vector-stores.js");
+const environments = {
+    production: 'https://api.mixedbread.ai',
+    local: 'http://127.0.0.1:8000',
+};
+/**
+ * API Client for interfacing with the Mixedbread API.
+ */
+class Mixedbread extends Core.APIClient {
+    /**
+     * API Client for interfacing with the Mixedbread API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['MXBAI_API_KEY'] ?? undefined]
+     * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
+     * @param {string} [opts.baseURL=process.env['MIXEDBREAD_BASE_URL'] ?? https://api.mixedbread.ai] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL = Core.readEnv('MIXEDBREAD_BASE_URL'), apiKey = Core.readEnv('MXBAI_API_KEY'), ...opts } = {}) {
+        if (apiKey === undefined) {
+            throw new Errors.MixedbreadError("The MXBAI_API_KEY environment variable is missing or empty; either provide it, or instantiate the Mixedbread client with an apiKey option, like new Mixedbread({ apiKey: 'My API Key' }).");
+        }
+        const options = {
+            apiKey,
+            ...opts,
+            baseURL,
+            environment: opts.environment ?? 'production',
+        };
+        if (baseURL && opts.environment) {
+            throw new Errors.MixedbreadError('Ambiguous URL; The `baseURL` option (or MIXEDBREAD_BASE_URL env var) and the `environment` option are given. If you want to use the environment you must pass baseURL: null');
+        }
+        super({
+            baseURL: options.baseURL || environments[options.environment || 'production'],
+            timeout: options.timeout ?? 60000 /* 1 minute */,
+            httpAgent: options.httpAgent,
+            maxRetries: options.maxRetries,
+            fetch: options.fetch,
+        });
+        this.embeddings = new API.Embeddings(this);
+        this.parsing = new API.Parsing(this);
+        this.files = new API.Files(this);
+        this.vectorStores = new API.VectorStores(this);
+        this.extractions = new API.Extractions(this);
+        this._options = options;
+        this.apiKey = apiKey;
+    }
+    /**
+     * Create embeddings for text or images using the specified model, encoding format,
+     * and normalization.
+     *
+     * Args: params: The parameters for creating embeddings.
+     *
+     * Returns: EmbeddingCreateResponse: The response containing the embeddings.
+     */
+    embed(body, options) {
+        return this.post('/v1/embeddings', { body, ...options });
+    }
+    /**
+     * Returns service information, including name and version.
+     *
+     * Returns: InfoResponse: A response containing the service name and version.
+     */
+    info(options) {
+        return this.get('/', options);
+    }
+    /**
+     * Rerank different kind of documents for a given query.
+     *
+     * Args: params: RerankingCreateParams: The parameters for reranking.
+     *
+     * Returns: RerankingCreateResponse: The reranked documents for the input query.
+     */
+    rerank(body, options) {
+        return this.post('/v1/reranking', { body, ...options });
+    }
+    defaultQuery() {
+        return this._options.defaultQuery;
+    }
+    defaultHeaders(opts) {
+        return {
+            ...super.defaultHeaders(opts),
+            ...this._options.defaultHeaders,
+        };
+    }
+    authHeaders(opts) {
+        return { Authorization: `Bearer ${this.apiKey}` };
+    }
+}
+exports.Mixedbread = Mixedbread;
+_a = Mixedbread;
+Mixedbread.Mixedbread = _a;
+Mixedbread.DEFAULT_TIMEOUT = 60000; // 1 minute
+Mixedbread.MixedbreadError = Errors.MixedbreadError;
+Mixedbread.APIError = Errors.APIError;
+Mixedbread.APIConnectionError = Errors.APIConnectionError;
+Mixedbread.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+Mixedbread.APIUserAbortError = Errors.APIUserAbortError;
+Mixedbread.NotFoundError = Errors.NotFoundError;
+Mixedbread.ConflictError = Errors.ConflictError;
+Mixedbread.RateLimitError = Errors.RateLimitError;
+Mixedbread.BadRequestError = Errors.BadRequestError;
+Mixedbread.AuthenticationError = Errors.AuthenticationError;
+Mixedbread.InternalServerError = Errors.InternalServerError;
+Mixedbread.PermissionDeniedError = Errors.PermissionDeniedError;
+Mixedbread.UnprocessableEntityError = Errors.UnprocessableEntityError;
+Mixedbread.toFile = Uploads.toFile;
+Mixedbread.fileFromPath = Uploads.fileFromPath;
+Mixedbread.Embeddings = embeddings_1.Embeddings;
+Mixedbread.Parsing = parsing_1.Parsing;
+Mixedbread.Files = files_1.Files;
+Mixedbread.FileObjectsLimitOffset = files_1.FileObjectsLimitOffset;
+Mixedbread.VectorStores = vector_stores_1.VectorStores;
+Mixedbread.VectorStoresLimitOffset = vector_stores_1.VectorStoresLimitOffset;
+Mixedbread.Extractions = extractions_1.Extractions;
+var uploads_1 = require("./uploads.js");
+Object.defineProperty(exports, "toFile", { enumerable: true, get: function () { return uploads_1.toFile; } });
+Object.defineProperty(exports, "fileFromPath", { enumerable: true, get: function () { return uploads_1.fileFromPath; } });
+var error_1 = require("./error.js");
+Object.defineProperty(exports, "MixedbreadError", { enumerable: true, get: function () { return error_1.MixedbreadError; } });
+Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return error_1.APIError; } });
+Object.defineProperty(exports, "APIConnectionError", { enumerable: true, get: function () { return error_1.APIConnectionError; } });
+Object.defineProperty(exports, "APIConnectionTimeoutError", { enumerable: true, get: function () { return error_1.APIConnectionTimeoutError; } });
+Object.defineProperty(exports, "APIUserAbortError", { enumerable: true, get: function () { return error_1.APIUserAbortError; } });
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return error_1.NotFoundError; } });
+Object.defineProperty(exports, "ConflictError", { enumerable: true, get: function () { return error_1.ConflictError; } });
+Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: function () { return error_1.RateLimitError; } });
+Object.defineProperty(exports, "BadRequestError", { enumerable: true, get: function () { return error_1.BadRequestError; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return error_1.AuthenticationError; } });
+Object.defineProperty(exports, "InternalServerError", { enumerable: true, get: function () { return error_1.InternalServerError; } });
+Object.defineProperty(exports, "PermissionDeniedError", { enumerable: true, get: function () { return error_1.PermissionDeniedError; } });
+Object.defineProperty(exports, "UnprocessableEntityError", { enumerable: true, get: function () { return error_1.UnprocessableEntityError; } });
+exports = module.exports = Mixedbread;
+exports.default = Mixedbread;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,gDAA+B;AAC/B,mDAAkC;AAClC,4DAA2C;AAE3C,sDAAqC;AAErC,0DAKgC;AAChC,0DAAyC;AAGzC,gDAQ2B;AAC3B,wEAAkE;AAClE,4DAAsD;AACtD,8EAiBiD;AAEjD,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,2BAA2B;IACvC,KAAK,EAAE,uBAAuB;CAC/B,CAAC;AA2EF;;GAEG;AACH,MAAa,UAAW,SAAQ,IAAI,CAAC,SAAS;IAK5C;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAC7C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EACtC,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,2LAA2L,CAC5L,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO;YACP,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,YAAY;SAC9C,CAAC;QAEF,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE;YAC/B,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,6KAA6K,CAC9K,CAAC;SACH;QAED,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,WAAW,IAAI,YAAY,CAAC;YAC7E,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,eAAU,GAAmB,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtD,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,gBAAW,GAAoB,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QATvD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAQD;;;;;;;OAOG;IACH,KAAK,CACH,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;;AAhHH,gCAqIC;;AAnBQ,qBAAU,GAAG,EAAI,CAAC;AAClB,0BAAe,GAAG,KAAK,CAAC,CAAC,WAAW;AAEpC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,mBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,6BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,oCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,4BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,yBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,gCAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,mCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,iBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,uBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,UAAU,CAAC,UAAU,GAAG,uBAAU,CAAC;AACnC,UAAU,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC7B,UAAU,CAAC,KAAK,GAAG,aAAK,CAAC;AACzB,UAAU,CAAC,sBAAsB,GAAG,8BAAsB,CAAC;AAC3D,UAAU,CAAC,YAAY,GAAG,4BAAY,CAAC;AACvC,UAAU,CAAC,uBAAuB,GAAG,uCAAuB,CAAC;AAC7D,UAAU,CAAC,WAAW,GAAG,yBAAW,CAAC;AA0DrC,wCAAiD;AAAxC,iGAAA,MAAM,OAAA;AAAE,uGAAA,YAAY,OAAA;AAC7B,oCAciB;AAbf,wGAAA,eAAe,OAAA;AACf,iGAAA,QAAQ,OAAA;AACR,2GAAA,kBAAkB,OAAA;AAClB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,sGAAA,aAAa,OAAA;AACb,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AACd,wGAAA,eAAe,OAAA;AACf,4GAAA,mBAAmB,OAAA;AACnB,4GAAA,mBAAmB,OAAA;AACnB,8GAAA,qBAAqB,OAAA;AACrB,iHAAA,wBAAwB,OAAA;AAG1B,kBAAe,UAAU,CAAC"}

package/index.mjs

@@ -0,0 +1,132 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var _a;
+import * as Core from "./core.mjs";
+import * as Errors from "./error.mjs";
+import * as Pagination from "./pagination.mjs";
+import * as Uploads from "./uploads.mjs";
+import { Embeddings, } from "./resources/embeddings.mjs";
+import * as API from "./resources/index.mjs";
+import { FileObjectsLimitOffset, Files, } from "./resources/files.mjs";
+import { Extractions } from "./resources/extractions/extractions.mjs";
+import { Parsing } from "./resources/parsing/parsing.mjs";
+import { VectorStores, VectorStoresLimitOffset, } from "./resources/vector-stores/vector-stores.mjs";
+const environments = {
+    production: 'https://api.mixedbread.ai',
+    local: 'http://127.0.0.1:8000',
+};
+/**
+ * API Client for interfacing with the Mixedbread API.
+ */
+export class Mixedbread extends Core.APIClient {
+    /**
+     * API Client for interfacing with the Mixedbread API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['MXBAI_API_KEY'] ?? undefined]
+     * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
+     * @param {string} [opts.baseURL=process.env['MIXEDBREAD_BASE_URL'] ?? https://api.mixedbread.ai] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL = Core.readEnv('MIXEDBREAD_BASE_URL'), apiKey = Core.readEnv('MXBAI_API_KEY'), ...opts } = {}) {
+        if (apiKey === undefined) {
+            throw new Errors.MixedbreadError("The MXBAI_API_KEY environment variable is missing or empty; either provide it, or instantiate the Mixedbread client with an apiKey option, like new Mixedbread({ apiKey: 'My API Key' }).");
+        }
+        const options = {
+            apiKey,
+            ...opts,
+            baseURL,
+            environment: opts.environment ?? 'production',
+        };
+        if (baseURL && opts.environment) {
+            throw new Errors.MixedbreadError('Ambiguous URL; The `baseURL` option (or MIXEDBREAD_BASE_URL env var) and the `environment` option are given. If you want to use the environment you must pass baseURL: null');
+        }
+        super({
+            baseURL: options.baseURL || environments[options.environment || 'production'],
+            timeout: options.timeout ?? 60000 /* 1 minute */,
+            httpAgent: options.httpAgent,
+            maxRetries: options.maxRetries,
+            fetch: options.fetch,
+        });
+        this.embeddings = new API.Embeddings(this);
+        this.parsing = new API.Parsing(this);
+        this.files = new API.Files(this);
+        this.vectorStores = new API.VectorStores(this);
+        this.extractions = new API.Extractions(this);
+        this._options = options;
+        this.apiKey = apiKey;
+    }
+    /**
+     * Create embeddings for text or images using the specified model, encoding format,
+     * and normalization.
+     *
+     * Args: params: The parameters for creating embeddings.
+     *
+     * Returns: EmbeddingCreateResponse: The response containing the embeddings.
+     */
+    embed(body, options) {
+        return this.post('/v1/embeddings', { body, ...options });
+    }
+    /**
+     * Returns service information, including name and version.
+     *
+     * Returns: InfoResponse: A response containing the service name and version.
+     */
+    info(options) {
+        return this.get('/', options);
+    }
+    /**
+     * Rerank different kind of documents for a given query.
+     *
+     * Args: params: RerankingCreateParams: The parameters for reranking.
+     *
+     * Returns: RerankingCreateResponse: The reranked documents for the input query.
+     */
+    rerank(body, options) {
+        return this.post('/v1/reranking', { body, ...options });
+    }
+    defaultQuery() {
+        return this._options.defaultQuery;
+    }
+    defaultHeaders(opts) {
+        return {
+            ...super.defaultHeaders(opts),
+            ...this._options.defaultHeaders,
+        };
+    }
+    authHeaders(opts) {
+        return { Authorization: `Bearer ${this.apiKey}` };
+    }
+}
+_a = Mixedbread;
+Mixedbread.Mixedbread = _a;
+Mixedbread.DEFAULT_TIMEOUT = 60000; // 1 minute
+Mixedbread.MixedbreadError = Errors.MixedbreadError;
+Mixedbread.APIError = Errors.APIError;
+Mixedbread.APIConnectionError = Errors.APIConnectionError;
+Mixedbread.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+Mixedbread.APIUserAbortError = Errors.APIUserAbortError;
+Mixedbread.NotFoundError = Errors.NotFoundError;
+Mixedbread.ConflictError = Errors.ConflictError;
+Mixedbread.RateLimitError = Errors.RateLimitError;
+Mixedbread.BadRequestError = Errors.BadRequestError;
+Mixedbread.AuthenticationError = Errors.AuthenticationError;
+Mixedbread.InternalServerError = Errors.InternalServerError;
+Mixedbread.PermissionDeniedError = Errors.PermissionDeniedError;
+Mixedbread.UnprocessableEntityError = Errors.UnprocessableEntityError;
+Mixedbread.toFile = Uploads.toFile;
+Mixedbread.fileFromPath = Uploads.fileFromPath;
+Mixedbread.Embeddings = Embeddings;
+Mixedbread.Parsing = Parsing;
+Mixedbread.Files = Files;
+Mixedbread.FileObjectsLimitOffset = FileObjectsLimitOffset;
+Mixedbread.VectorStores = VectorStores;
+Mixedbread.VectorStoresLimitOffset = VectorStoresLimitOffset;
+Mixedbread.Extractions = Extractions;
+export { toFile, fileFromPath } from "./uploads.mjs";
+export { MixedbreadError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.mjs";
+export default Mixedbread;
+//# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,KAAK,IAAI;OACT,KAAK,MAAM;OACX,KAAK,UAAU;OAEf,KAAK,OAAO;OAEZ,EAIL,UAAU,GACX;OACM,KAAK,GAAG;OAGR,EAKL,sBAAsB,EAEtB,KAAK,GACN;OACM,EAAE,WAAW,EAAE;OACf,EAAE,OAAO,EAAE;OACX,EAeL,YAAY,EACZ,uBAAuB,GACxB;AAED,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,2BAA2B;IACvC,KAAK,EAAE,uBAAuB;CAC/B,CAAC;AA2EF;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,IAAI,CAAC,SAAS;IAK5C;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAC7C,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EACtC,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,2LAA2L,CAC5L,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO;YACP,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,YAAY;SAC9C,CAAC;QAEF,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE;YAC/B,MAAM,IAAI,MAAM,CAAC,eAAe,CAC9B,6KAA6K,CAC9K,CAAC;SACH;QAED,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,WAAW,IAAI,YAAY,CAAC;YAC7E,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,eAAU,GAAmB,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtD,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,iBAAY,GAAqB,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5D,gBAAW,GAAoB,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QATvD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAQD;;;;;;;OAOG;IACH,KAAK,CACH,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;;;AAEM,qBAAU,GAAG,EAAI,CAAC;AAClB,0BAAe,GAAG,KAAK,CAAC,CAAC,WAAW;AAEpC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,mBAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,6BAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,oCAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,4BAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,wBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,yBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,0BAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,8BAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,gCAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,mCAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAE3D,iBAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,uBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;AACnC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;AAC7B,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;AACzB,UAAU,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;AAC3D,UAAU,CAAC,YAAY,GAAG,YAAY,CAAC;AACvC,UAAU,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAC7D,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC;OA0D9B,EAAE,MAAM,EAAE,YAAY,EAAE;OACxB,EACL,eAAe,EACf,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB;AAED,eAAe,UAAU,CAAC"}

package/lib/polling.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Utilities for polling operations
+ */
+type ConditionFunction<T> = (result: T) => boolean;
+type IntervalFunction<T> = (result: T) => number;
+type ErrorHandlerFunction = (error: Error) => number | null;
+type RetryCallback<T> = (result: T, attempt: number) => void;
+/**
+ * Configuration options for the poll function.
+ */
+export interface PollOptions<T> {
+    /** Async function that performs the operation to be polled */
+    fn: () => Promise<T>;
+    /** Function that evaluates if the polling should continue */
+    condition: ConditionFunction<T>;
+    /** Maximum number of polling attempts (undefined for infinite) */
+    maxAttempts?: number;
+    /** Maximum total time to poll in seconds (undefined for infinite) */
+    timeoutSeconds?: number;
+    /** Time between polls in seconds, or function that returns interval */
+    intervalSeconds?: number | IntervalFunction<T>;
+    /** Optional callback for each retry attempt */
+    onRetry?: RetryCallback<T>;
+    /** Optional callback for handling exceptions during polling */
+    errorHandler?: ErrorHandlerFunction;
+}
+/**
+ * Asynchronously polls an operation until a condition is met or timeout/max attempts are reached.
+ *
+ * @param options - Configuration options for polling
+ * @returns The result of the operation once condition is met
+ * @throws Error if maxAttempts is reached
+ * @throws Error if timeoutSeconds is reached
+ *
+ * @example
+ * ```typescript
+ * const result = await poll({
+ *   fn: () => fetchData(),
+ *   condition: (result) => result.status === 'completed',
+ *   maxAttempts: 5,
+ *   timeoutSeconds: 60,
+ *   intervalSeconds: 2
+ * });
+ * ```
+ */
+export declare function poll<T>(options: PollOptions<T>): Promise<T>;
+export {};
+//# sourceMappingURL=polling.d.ts.map

package/lib/polling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling.d.ts","sourceRoot":"","sources":["../src/lib/polling.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,KAAK,iBAAiB,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC;AACnD,KAAK,gBAAgB,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,MAAM,CAAC;AACjD,KAAK,oBAAoB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,GAAG,IAAI,CAAC;AAC5D,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;AAK7D;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,8DAA8D;IAC9D,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;IACrB,6DAA6D;IAC7D,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAChC,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,eAAe,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC/C,+CAA+C;IAC/C,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC3B,+DAA+D;IAC/D,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CA+DjE"}

package/lib/polling.js

@@ -0,0 +1,75 @@
+"use strict";
+/**
+ * Utilities for polling operations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.poll = void 0;
+/**
+ * Asynchronously polls an operation until a condition is met or timeout/max attempts are reached.
+ *
+ * @param options - Configuration options for polling
+ * @returns The result of the operation once condition is met
+ * @throws Error if maxAttempts is reached
+ * @throws Error if timeoutSeconds is reached
+ *
+ * @example
+ * ```typescript
+ * const result = await poll({
+ *   fn: () => fetchData(),
+ *   condition: (result) => result.status === 'completed',
+ *   maxAttempts: 5,
+ *   timeoutSeconds: 60,
+ *   intervalSeconds: 2
+ * });
+ * ```
+ */
+async function poll(options) {
+    const { fn, condition, maxAttempts, timeoutSeconds, intervalSeconds = 1.0, onRetry, errorHandler, } = options;
+    const startTime = new Date();
+    let attempt = 0;
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        attempt += 1;
+        try {
+            const result = await fn();
+            if (condition(result)) {
+                return result;
+            }
+            if (onRetry) {
+                onRetry(result, attempt);
+            }
+            let waitTime;
+            if (typeof intervalSeconds === 'function') {
+                waitTime = intervalSeconds(result);
+            }
+            else {
+                waitTime = intervalSeconds;
+            }
+            // Check timeout and attempts before sleeping
+            if (maxAttempts && attempt >= maxAttempts) {
+                throw new Error(`Maximum attempts (${maxAttempts}) reached`);
+            }
+            if (timeoutSeconds) {
+                const elapsed = (new Date().getTime() - startTime.getTime()) / 1000;
+                if (elapsed >= timeoutSeconds) {
+                    throw new Error(`Timeout (${timeoutSeconds}s) reached`);
+                }
+            }
+            // Sleep asynchronously
+            await new Promise((resolve) => setTimeout(resolve, waitTime * 1000));
+        }
+        catch (e) {
+            if (errorHandler && e instanceof Error) {
+                const sleepTime = errorHandler(e);
+                if (sleepTime !== null) {
+                    // Sleep and continue
+                    await new Promise((resolve) => setTimeout(resolve, sleepTime * 1000));
+                    continue;
+                }
+            }
+            throw e;
+        }
+    }
+}
+exports.poll = poll;
+//# sourceMappingURL=polling.js.map

package/lib/polling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling.js","sourceRoot":"","sources":["../src/lib/polling.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA8BH;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,IAAI,CAAI,OAAuB;IACnD,MAAM,EACJ,EAAE,EACF,SAAS,EACT,WAAW,EACX,cAAc,EACd,eAAe,GAAG,GAAG,EACrB,OAAO,EACP,YAAY,GACb,GAAG,OAAO,CAAC;IAEZ,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,IAAI,OAAO,GAAG,CAAC,CAAC;IAEhB,iDAAiD;IACjD,OAAO,IAAI,EAAE;QACX,OAAO,IAAI,CAAC,CAAC;QAEb,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;YAE1B,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE;gBACrB,OAAO,MAAM,CAAC;aACf;YAED,IAAI,OAAO,EAAE;gBACX,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aAC1B;YAED,IAAI,QAAgB,CAAC;YAErB,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;gBACzC,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;aACpC;iBAAM;gBACL,QAAQ,GAAG,eAAe,CAAC;aAC5B;YAED,6CAA6C;YAC7C,IAAI,WAAW,IAAI,OAAO,IAAI,WAAW,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,qBAAqB,WAAW,WAAW,CAAC,CAAC;aAC9D;YAED,IAAI,cAAc,EAAE;gBAClB,MAAM,OAAO,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;gBACpE,IAAI,OAAO,IAAI,cAAc,EAAE;oBAC7B,MAAM,IAAI,KAAK,CAAC,YAAY,cAAc,YAAY,CAAC,CAAC;iBACzD;aACF;YAED,uBAAuB;YACvB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC;SACtE;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,YAAY,IAAI,CAAC,YAAY,KAAK,EAAE;gBACtC,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;gBAClC,IAAI,SAAS,KAAK,IAAI,EAAE;oBACtB,qBAAqB;oBACrB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;oBACtE,SAAS;iBACV;aACF;YACD,MAAM,CAAC,CAAC;SACT;KACF;AACH,CAAC;AA/DD,oBA+DC"}