import type { RequestInit, RequestInfo } from "./internal/builtin-types.js"; import type { PromiseOrValue, MergedRequestInit } from "./internal/types.js"; import * as Opts from "./internal/request-options.js"; import * as Errors from "./error.js"; import * as Uploads from "./uploads.js"; import * as API from "./resources/index.js"; import { APIPromise } from "./api-promise.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 { Project, ProjectCreateParams, ProjectListResponse, Projects } from "./resources/projects.js"; import { Task, TaskCreateParams, TaskListResponse, TaskUpdateParams, Tasks } from "./resources/tasks.js"; import { User, UserCreateParams, UserListResponse, Users } from "./resources/users.js"; type LogFn = (message: string, ...rest: unknown[]) => void; export type Logger = { error: LogFn; warn: LogFn; info: LogFn; debug: LogFn; }; export type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug'; export interface ClientOptions { /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['LIGHTSWITCH_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; /** * 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['LIGHTSWITCH_LOG']. */ logLevel?: LogLevel | undefined | null; /** * Set the logger. * * Defaults to globalThis.console. */ logger?: Logger | undefined | null; } type FinalizedRequestInit = RequestInit & { headers: Headers; }; /** * API Client for interfacing with the Lightswitch API. */ export declare class Lightswitch { #private; 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 Lightswitch API. * * @param {string} [opts.baseURL=process.env['LIGHTSWITCH_BASE_URL'] ?? https://lightswitch.gitbook.dev/api] - 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, ...opts }?: ClientOptions); protected defaultQuery(): Record | undefined; protected validateHeaders({ values, nulls }: NullableHeaders): void; /** * 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): string; private calculateContentLength; /** * 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(options: FinalRequestOptions, { retryCount }?: { retryCount?: number; }): { req: FinalizedRequestInit; url: string; timeout: number; }; private buildHeaders; private buildBody; static Lightswitch: typeof Lightswitch; static DEFAULT_TIMEOUT: number; static LightswitchError: typeof Errors.LightswitchError; 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; projects: API.Projects; tasks: API.Tasks; users: API.Users; } export declare namespace Lightswitch { export type RequestOptions = Opts.RequestOptions; export { Projects as Projects, type Project as Project, type ProjectListResponse as ProjectListResponse, type ProjectCreateParams as ProjectCreateParams, }; export { Tasks as Tasks, type Task as Task, type TaskListResponse as TaskListResponse, type TaskCreateParams as TaskCreateParams, type TaskUpdateParams as TaskUpdateParams, }; export { Users as Users, type User as User, type UserListResponse as UserListResponse, type UserCreateParams as UserCreateParams, }; } export {}; //# sourceMappingURL=client.d.ts.map