import type { RequestInit, RequestInfo } from "./internal/builtin-types.js"; import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js"; export type { Logger, LogLevel } from "./internal/utils/log.js"; import * as Opts from "./internal/request-options.js"; import * as Errors from "./core/error.js"; import * as Uploads from "./core/uploads.js"; import * as API from "./resources/index.js"; import * as TopLevelAPI from "./resources/top-level.js"; import { AddParams, AddResponse, ProfileParams, ProfileResponse } from "./resources/top-level.js"; import { APIPromise } from "./core/api-promise.js"; import { ConnectionCreateParams, ConnectionCreateResponse, ConnectionDeleteByIDResponse, ConnectionDeleteByProviderParams, ConnectionDeleteByProviderResponse, ConnectionGetByIDResponse, ConnectionGetByTagsParams, ConnectionGetByTagsResponse, ConnectionImportParams, ConnectionImportResponse, ConnectionListDocumentsParams, ConnectionListDocumentsResponse, ConnectionListParams, ConnectionListResponse, Connections } from "./resources/connections.js"; import { DocumentAddParams, DocumentAddResponse, DocumentGetResponse, DocumentListParams, DocumentListResponse, DocumentUpdateParams, DocumentUpdateResponse, DocumentUploadFileParams, DocumentUploadFileResponse, Documents } from "./resources/documents.js"; import { Memories, MemoryAddParams, MemoryAddResponse, MemoryGetResponse, MemoryListParams, MemoryListResponse, MemoryUpdateParams, MemoryUpdateResponse, MemoryUploadFileParams, MemoryUploadFileResponse } from "./resources/memories.js"; import { Search, SearchDocumentsParams, SearchDocumentsResponse, SearchExecuteParams, SearchExecuteResponse, SearchMemoriesParams, SearchMemoriesResponse } from "./resources/search.js"; import { SettingGetResponse, SettingUpdateParams, SettingUpdateResponse, Settings } from "./resources/settings.js"; import { type Fetch } from "./internal/builtin-types.js"; import { HeadersLike, NullableHeaders } from "./internal/headers.js"; import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js"; import { type LogLevel, type Logger } from "./internal/utils/log.js"; export interface ClientOptions { /** * Defaults to process.env['SUPERMEMORY_API_KEY']. */ apiKey?: string | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['SUPERMEMORY_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. * * @unit milliseconds */ timeout?: number | undefined; /** * Additional `RequestInit` options to be passed to `fetch` calls. * Properties will be overridden by per-request `fetchOptions`. */ fetchOptions?: MergedRequestInit | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we expect that `fetch` is defined globally. */ fetch?: 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 `null` in request options. */ defaultHeaders?: HeadersLike | 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?: Record | undefined; /** * Set the log level. * * Defaults to process.env['SUPERMEMORY_LOG'] or 'warn' if it isn't set. */ logLevel?: LogLevel | undefined; /** * Set the logger. * * Defaults to globalThis.console. */ logger?: Logger | undefined; } /** * API Client for interfacing with the Supermemory API. */ export declare class Supermemory { #private; apiKey: string; baseURL: string; maxRetries: number; timeout: number; logger: Logger | undefined; logLevel: LogLevel | undefined; fetchOptions: MergedRequestInit | undefined; private fetch; protected idempotencyHeader?: string; private _options; /** * API Client for interfacing with the Supermemory API. * * @param {string | undefined} [opts.apiKey=process.env['SUPERMEMORY_API_KEY'] ?? undefined] * @param {string} [opts.baseURL=process.env['SUPERMEMORY_BASE_URL'] ?? https://api.supermemory.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 {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls. * @param {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 {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Record} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, apiKey, ...opts }?: ClientOptions); /** * Create a new client instance re-using the same options given to the current client with optional overriding. */ withOptions(options: Partial): this; /** * Add a document with any content type (text, url, file, etc.) and metadata */ add(body: TopLevelAPI.AddParams, options?: RequestOptions): APIPromise; /** * Get user profile with optional search results */ profile(body: TopLevelAPI.ProfileParams, options?: RequestOptions): APIPromise; protected defaultQuery(): Record | undefined; protected validateHeaders({ values, nulls }: NullableHeaders): void; protected authHeaders(opts: FinalRequestOptions): Promise; /** * Basic re-implementation of `qs.stringify` for primitive types. */ protected stringifyQuery(query: Record): string; private getUserAgent; protected defaultIdempotencyKey(): string; protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError; buildURL(path: string, query: Record | null | undefined, defaultBaseURL?: string | undefined): string; /** * Used as a callback for mutating the given `FinalRequestOptions` object. */ protected prepareOptions(options: FinalRequestOptions): Promise; /** * Used as a callback for mutating the given `RequestInit` object. * * This is useful for cases where you want to add certain headers based off of * the request properties, e.g. `method` or `url`. */ protected prepareRequest(request: RequestInit, { url, options }: { url: string; options: FinalRequestOptions; }): Promise; get(path: string, opts?: PromiseOrValue): APIPromise; post(path: string, opts?: PromiseOrValue): APIPromise; patch(path: string, opts?: PromiseOrValue): APIPromise; put(path: string, opts?: PromiseOrValue): APIPromise; delete(path: string, opts?: PromiseOrValue): APIPromise; private methodRequest; request(options: PromiseOrValue, remainingRetries?: number | null): APIPromise; private makeRequest; fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise; private shouldRetry; private retryRequest; private calculateDefaultRetryTimeoutMillis; buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: { retryCount?: number; }): Promise<{ req: FinalizedRequestInit; url: string; timeout: number; }>; private buildHeaders; private buildBody; static Supermemory: typeof Supermemory; static DEFAULT_TIMEOUT: number; static SupermemoryError: typeof Errors.SupermemoryError; 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; memories: API.Memories; documents: API.Documents; search: API.Search; settings: API.Settings; connections: API.Connections; } export declare namespace Supermemory { export type RequestOptions = Opts.RequestOptions; export { type AddResponse as AddResponse, type ProfileResponse as ProfileResponse, type AddParams as AddParams, type ProfileParams as ProfileParams, }; export { Memories as Memories, type MemoryUpdateResponse as MemoryUpdateResponse, type MemoryListResponse as MemoryListResponse, type MemoryAddResponse as MemoryAddResponse, type MemoryGetResponse as MemoryGetResponse, type MemoryUploadFileResponse as MemoryUploadFileResponse, type MemoryUpdateParams as MemoryUpdateParams, type MemoryListParams as MemoryListParams, type MemoryAddParams as MemoryAddParams, type MemoryUploadFileParams as MemoryUploadFileParams, }; export { Documents as Documents, type DocumentUpdateResponse as DocumentUpdateResponse, type DocumentListResponse as DocumentListResponse, type DocumentAddResponse as DocumentAddResponse, type DocumentGetResponse as DocumentGetResponse, type DocumentUploadFileResponse as DocumentUploadFileResponse, type DocumentUpdateParams as DocumentUpdateParams, type DocumentListParams as DocumentListParams, type DocumentAddParams as DocumentAddParams, type DocumentUploadFileParams as DocumentUploadFileParams, }; export { Search as Search, type SearchDocumentsResponse as SearchDocumentsResponse, type SearchExecuteResponse as SearchExecuteResponse, type SearchMemoriesResponse as SearchMemoriesResponse, type SearchDocumentsParams as SearchDocumentsParams, type SearchExecuteParams as SearchExecuteParams, type SearchMemoriesParams as SearchMemoriesParams, }; export { Settings as Settings, type SettingUpdateResponse as SettingUpdateResponse, type SettingGetResponse as SettingGetResponse, type SettingUpdateParams as SettingUpdateParams, }; export { Connections as Connections, type ConnectionCreateResponse as ConnectionCreateResponse, type ConnectionListResponse as ConnectionListResponse, type ConnectionDeleteByIDResponse as ConnectionDeleteByIDResponse, type ConnectionDeleteByProviderResponse as ConnectionDeleteByProviderResponse, type ConnectionGetByIDResponse as ConnectionGetByIDResponse, type ConnectionGetByTagsResponse as ConnectionGetByTagsResponse, type ConnectionImportResponse as ConnectionImportResponse, type ConnectionListDocumentsResponse as ConnectionListDocumentsResponse, type ConnectionCreateParams as ConnectionCreateParams, type ConnectionListParams as ConnectionListParams, type ConnectionDeleteByProviderParams as ConnectionDeleteByProviderParams, type ConnectionGetByTagsParams as ConnectionGetByTagsParams, type ConnectionImportParams as ConnectionImportParams, type ConnectionListDocumentsParams as ConnectionListDocumentsParams, }; } //# sourceMappingURL=client.d.ts.map