@nirvana-labs/nirvana 0.9.1 → 0.10.0

package/client.d.ts

@@ -0,0 +1,189 @@
+                              
+import type { RequestInit, RequestInfo } from "./internal/builtin-types.js";
+import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js";
+import { type Logger, type LogLevel } from "./internal/utils/log.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 { APIPromise } from "./core/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 { APIKeys } from "./resources/api-keys.js";
+import { Operations } from "./resources/operations.js";
+import { UserResource } from "./resources/user.js";
+import { Compute } from "./resources/compute/compute.js";
+import { Networking } from "./resources/networking/networking.js";
+export interface ClientOptions {
+    /**
+     * Defaults to process.env['NIRVANA_LABS_API_KEY'].
+     */
+    apiKey?: string | undefined;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+     *
+     * Defaults to process.env['NIRVANA_LABS_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<string, string | undefined> | undefined;
+    /**
+     * Set the log level.
+     *
+     * Defaults to process.env['NIRVANA_LABS_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 Nirvana Labs API.
+ */
+export declare class NirvanaLabs {
+    #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 Nirvana Labs API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['NIRVANA_LABS_API_KEY'] ?? undefined]
+     * @param {string} [opts.baseURL=process.env['NIRVANA_LABS_BASE_URL'] ?? https://api.nirvanalabs.io/] - 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<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
+    protected defaultQuery(): Record<string, string | undefined> | undefined;
+    protected validateHeaders({ values, nulls }: NullableHeaders): void;
+    protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined;
+    /**
+     * Basic re-implementation of `qs.stringify` for primitive types.
+     */
+    protected stringifyQuery(query: Record<string, unknown>): string;
+    private getUserAgent;
+    protected defaultIdempotencyKey(): string;
+    protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
+    buildURL(path: string, query: Record<string, unknown> | null | undefined): string;
+    /**
+     * Used as a callback for mutating the given `FinalRequestOptions` object.
+     */
+    protected prepareOptions(options: FinalRequestOptions): Promise<void>;
+    /**
+     * 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<void>;
+    get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    private methodRequest;
+    request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
+    private makeRequest;
+    fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
+    private shouldRetry;
+    private retryRequest;
+    private calculateDefaultRetryTimeoutMillis;
+    buildRequest(options: FinalRequestOptions, { retryCount }?: {
+        retryCount?: number;
+    }): {
+        req: FinalizedRequestInit;
+        url: string;
+        timeout: number;
+    };
+    private buildHeaders;
+    private buildBody;
+    static NirvanaLabs: typeof NirvanaLabs;
+    static DEFAULT_TIMEOUT: number;
+    static NirvanaLabsError: typeof Errors.NirvanaLabsError;
+    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;
+    user: API.UserResource;
+    apiKeys: API.APIKeys;
+    operations: API.Operations;
+    compute: API.Compute;
+    networking: API.Networking;
+}
+export declare namespace NirvanaLabs {
+    export type RequestOptions = Opts.RequestOptions;
+    export { UserResource as UserResource };
+    export { APIKeys as APIKeys };
+    export { Operations as Operations };
+    export { Compute as Compute };
+    export { Networking as Networking };
+    export type RegionName = API.RegionName;
+    export type ResourceStatus = API.ResourceStatus;
+}
+//# sourceMappingURL=client.d.ts.map

package/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":";OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;OAI5E,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAiB;YACxC,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAET,KAAK,MAAM;OACX,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OACvC,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE;OAIhB,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;AAErB,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,WAAW;;IACtB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAA0C,EAC1C,MAAwC,EACxC,GAAG,IAAI,EACR,GAAE,aAAkB;IAiCrB,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAIxE,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;IAI5D,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,GAAG,SAAS;IAI7E;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAiBhE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM;IAkBjF;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA2JnB,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;IA8BpB,OAAO,CAAC,WAAW;YAuBL,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAe1C,YAAY,CACV,OAAO,EAAE,mBAAmB,EAC5B,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IAwB9D,OAAO,CAAC,YAAY;IAqCpB,OAAO,CAAC,SAAS;IAqCjB,MAAM,CAAC,WAAW,qBAAQ;IAC1B,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,gBAAgB,iCAA2B;IAClD,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;IAE/B,IAAI,EAAE,GAAG,CAAC,YAAY,CAA8B;IACpD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;IACtD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;CACvD;AAMD,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EAAE,YAAY,IAAI,YAAY,EAAE,CAAC;IAExC,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,UAAU,IAAI,UAAU,EAAE,CAAC;IAEpC,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,UAAU,IAAI,UAAU,EAAE,CAAC;IAEpC,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IACxC,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;CACjD"}