opencode-puter-auth 1.0.1 → 1.0.3

package/dist/ai-provider/puter-chat-settings.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Puter Chat Model Settings
+ *
+ * Configuration options for the Puter chat language model.
+ */
+/**
+ * Settings for the Puter chat model.
+ */
+export interface PuterChatSettings {
+    /**
+     * The Puter model ID to use.
+     * @example 'claude-opus-4-5', 'claude-sonnet-4-5', 'gpt-4o', 'gemini-2.5-pro'
+     */
+    modelId?: string;
+    /**
+     * Maximum number of tokens to generate.
+     */
+    maxTokens?: number;
+    /**
+     * Temperature for response generation.
+     * Higher values make output more random, lower values more deterministic.
+     * @default 0.7
+     */
+    temperature?: number;
+    /**
+     * Top-p (nucleus) sampling parameter.
+     */
+    topP?: number;
+    /**
+     * Top-k sampling parameter.
+     */
+    topK?: number;
+    /**
+     * Stop sequences that will halt generation.
+     */
+    stopSequences?: string[];
+    /**
+     * Whether to enable streaming responses.
+     * @default true
+     */
+    stream?: boolean;
+}
+/**
+ * Configuration for the Puter provider.
+ */
+export interface PuterProviderConfig {
+    /**
+     * The Puter authentication token.
+     * Can be obtained by authenticating with Puter.com.
+     */
+    authToken: string;
+    /**
+     * Base URL for the Puter API.
+     * @default 'https://api.puter.com'
+     */
+    baseURL?: string;
+    /**
+     * Request timeout in milliseconds.
+     * @default 120000
+     */
+    timeout?: number;
+    /**
+     * Custom headers to include in requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom fetch function for making HTTP requests.
+     * Useful for testing or custom networking.
+     */
+    fetch?: typeof globalThis.fetch;
+    /**
+     * Function to generate unique IDs.
+     * Used for tool call IDs and other identifiers.
+     */
+    generateId?: () => string;
+}
+/**
+ * Internal configuration passed to the chat model.
+ */
+export interface PuterChatConfig {
+    /**
+     * Provider identifier.
+     */
+    provider: string;
+    /**
+     * Base URL for API calls.
+     */
+    baseURL: string;
+    /**
+     * Request timeout in milliseconds.
+     */
+    timeout: number;
+    /**
+     * Function to get headers for requests.
+     */
+    headers: () => Record<string, string>;
+    /**
+     * Fetch function to use for requests.
+     */
+    fetch: typeof globalThis.fetch;
+    /**
+     * Function to generate unique IDs.
+     */
+    generateId: () => string;
+}
+//# sourceMappingURL=puter-chat-settings.d.ts.map

package/dist/ai-provider/puter-chat-settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"puter-chat-settings.d.ts","sourceRoot":"","sources":["../../src/ai-provider/puter-chat-settings.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,MAAM,CAAC;CAC1B"}

package/dist/ai-provider/puter-chat-settings.js

@@ -0,0 +1,7 @@
+/**
+ * Puter Chat Model Settings
+ *
+ * Configuration options for the Puter chat language model.
+ */
+export {};
+//# sourceMappingURL=puter-chat-settings.js.map

package/dist/ai-provider/puter-chat-settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"puter-chat-settings.js","sourceRoot":"","sources":["../../src/ai-provider/puter-chat-settings.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/ai-provider/puter-provider.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Puter AI SDK Provider
+ *
+ * Factory function for creating Puter language models compatible with the AI SDK.
+ * This enables Puter.com's FREE AI models to work as a proper provider in OpenCode.
+ */
+import type { ProviderV3 } from '@ai-sdk/provider';
+import { PuterChatLanguageModel } from './puter-chat-language-model.js';
+import type { PuterChatSettings, PuterProviderConfig } from './puter-chat-settings.js';
+/**
+ * Puter provider interface extending ProviderV3.
+ */
+export interface PuterProvider extends ProviderV3 {
+    /**
+     * Create a Puter chat language model.
+     * @param modelId - The model ID (e.g., 'claude-opus-4-5', 'gpt-4o')
+     * @param settings - Optional model settings
+     */
+    (modelId: string, settings?: PuterChatSettings): PuterChatLanguageModel;
+    /**
+     * Create a Puter chat language model.
+     * @param modelId - The model ID (e.g., 'claude-opus-4-5', 'gpt-4o')
+     * @param settings - Optional model settings
+     */
+    languageModel(modelId: string, settings?: PuterChatSettings): PuterChatLanguageModel;
+    /**
+     * Create a Puter chat language model (alias for languageModel).
+     * @param modelId - The model ID
+     * @param settings - Optional model settings
+     */
+    chat(modelId: string, settings?: PuterChatSettings): PuterChatLanguageModel;
+}
+/**
+ * Create a Puter provider instance.
+ *
+ * @param options - Provider configuration options
+ * @returns A Puter provider instance
+ *
+ * @example
+ * ```typescript
+ * import { createPuter } from 'opencode-puter-auth';
+ *
+ * const puter = createPuter({
+ *   authToken: 'your-puter-auth-token',
+ * });
+ *
+ * const model = puter('claude-opus-4-5');
+ * ```
+ */
+export declare function createPuter(options: PuterProviderConfig): PuterProvider;
+/**
+ * Default Puter provider (lazy-loaded).
+ *
+ * This is a proxy that lazily creates the provider when first accessed.
+ * It requires the PUTER_AUTH_TOKEN environment variable to be set.
+ */
+export declare const puter: PuterProvider;
+//# sourceMappingURL=puter-provider.d.ts.map

package/dist/ai-provider/puter-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"puter-provider.d.ts","sourceRoot":"","sources":["../../src/ai-provider/puter-provider.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAmB,MAAM,0BAA0B,CAAC;AAExG;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C;;;;OAIG;IACH,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,iBAAiB,GAAG,sBAAsB,CAAC;IAExE;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,iBAAiB,GAAG,sBAAsB,CAAC;IAErF;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,iBAAiB,GAAG,sBAAsB,CAAC;CAC7E;AAYD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,mBAAmB,GAAG,aAAa,CAiFvE;AAkCD;;;;;GAKG;AACH,eAAO,MAAM,KAAK,EAAE,aAsBnB,CAAC"}

package/dist/ai-provider/puter-provider.js

@@ -0,0 +1,149 @@
+/**
+ * Puter AI SDK Provider
+ *
+ * Factory function for creating Puter language models compatible with the AI SDK.
+ * This enables Puter.com's FREE AI models to work as a proper provider in OpenCode.
+ */
+import { generateId, withoutTrailingSlash } from '@ai-sdk/provider-utils';
+import { PuterChatLanguageModel } from './puter-chat-language-model.js';
+/**
+ * Default Puter API base URL.
+ */
+const DEFAULT_BASE_URL = 'https://api.puter.com';
+/**
+ * Default request timeout in milliseconds.
+ */
+const DEFAULT_TIMEOUT = 120000;
+/**
+ * Create a Puter provider instance.
+ *
+ * @param options - Provider configuration options
+ * @returns A Puter provider instance
+ *
+ * @example
+ * ```typescript
+ * import { createPuter } from 'opencode-puter-auth';
+ *
+ * const puter = createPuter({
+ *   authToken: 'your-puter-auth-token',
+ * });
+ *
+ * const model = puter('claude-opus-4-5');
+ * ```
+ */
+export function createPuter(options) {
+    const baseURL = withoutTrailingSlash(options.baseURL) ?? DEFAULT_BASE_URL;
+    const timeout = options.timeout ?? DEFAULT_TIMEOUT;
+    const fetchFn = options.fetch ?? globalThis.fetch;
+    const generateIdFn = options.generateId ?? generateId;
+    /**
+     * Get headers for API requests.
+     */
+    const getHeaders = () => {
+        const headers = {
+            'Content-Type': 'application/json',
+        };
+        // Add auth token if provided
+        if (options.authToken) {
+            headers['Authorization'] = `Bearer ${options.authToken}`;
+        }
+        // Add custom headers
+        if (options.headers) {
+            Object.assign(headers, options.headers);
+        }
+        return headers;
+    };
+    /**
+     * Create a chat language model configuration.
+     */
+    const createChatConfig = () => ({
+        provider: 'puter',
+        baseURL,
+        timeout,
+        headers: getHeaders,
+        fetch: fetchFn,
+        generateId: generateIdFn,
+    });
+    /**
+     * Create a chat language model.
+     */
+    const createChatModel = (modelId, settings = {}) => {
+        return new PuterChatLanguageModel(modelId, settings, createChatConfig());
+    };
+    /**
+     * Provider function that can be called directly or via methods.
+     */
+    const provider = function (modelId, settings) {
+        if (new.target) {
+            throw new Error('The Puter provider function cannot be called with the new keyword.');
+        }
+        return createChatModel(modelId, settings);
+    };
+    // Add methods to the provider function
+    provider.languageModel = createChatModel;
+    provider.chat = createChatModel;
+    // ProviderV3 specification version
+    provider.specificationVersion = 'v3';
+    // Puter only supports chat models, throw for unsupported types
+    provider.embeddingModel = () => {
+        throw new Error('Puter does not support embedding models');
+    };
+    provider.imageModel = () => {
+        throw new Error('Puter does not support image models');
+    };
+    return provider;
+}
+/**
+ * Lazy-loaded default Puter provider instance.
+ *
+ * This provider is only instantiated when actually used, avoiding errors
+ * when the PUTER_AUTH_TOKEN environment variable is not set at import time.
+ *
+ * Note: Requires the PUTER_AUTH_TOKEN environment variable to be set when used.
+ *
+ * @example
+ * ```typescript
+ * import { puter } from 'opencode-puter-auth';
+ *
+ * // Requires PUTER_AUTH_TOKEN environment variable
+ * const model = puter('claude-opus-4-5');
+ * ```
+ */
+let _puterInstance = null;
+function getPuterInstance() {
+    if (!_puterInstance) {
+        const authToken = process.env.PUTER_AUTH_TOKEN;
+        if (!authToken) {
+            throw new Error('PUTER_AUTH_TOKEN environment variable is required for the default puter provider. ' +
+                'Either set the environment variable or use createPuter() with an explicit authToken.');
+        }
+        _puterInstance = createPuter({ authToken });
+    }
+    return _puterInstance;
+}
+/**
+ * Default Puter provider (lazy-loaded).
+ *
+ * This is a proxy that lazily creates the provider when first accessed.
+ * It requires the PUTER_AUTH_TOKEN environment variable to be set.
+ */
+export const puter = new Proxy(function () { }, {
+    apply(_target, _thisArg, args) {
+        return getPuterInstance()(...args);
+    },
+    get(_target, prop) {
+        if (prop === 'languageModel' || prop === 'chat') {
+            return (...args) => getPuterInstance()[prop](...args);
+        }
+        if (prop === 'specificationVersion') {
+            return 'v3';
+        }
+        if (prop === 'embeddingModel' || prop === 'imageModel') {
+            return () => {
+                throw new Error(`Puter does not support ${String(prop).replace('Model', '')} models`);
+            };
+        }
+        return getPuterInstance()[prop];
+    },
+});
+//# sourceMappingURL=puter-provider.js.map

package/dist/ai-provider/puter-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"puter-provider.js","sourceRoot":"","sources":["../../src/ai-provider/puter-provider.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AA6BxE;;GAEG;AACH,MAAM,gBAAgB,GAAG,uBAAuB,CAAC;AAEjD;;GAEG;AACH,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,WAAW,CAAC,OAA4B;IACtD,MAAM,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,gBAAgB,CAAC;IAC1E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,eAAe,CAAC;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IAClD,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,IAAI,UAAU,CAAC;IAEtD;;OAEG;IACH,MAAM,UAAU,GAAG,GAA2B,EAAE;QAC9C,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QAEF,6BAA6B;QAC7B,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,OAAO,CAAC,SAAS,EAAE,CAAC;QAC3D,CAAC;QAED,qBAAqB;QACrB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,GAAG,GAAoB,EAAE,CAAC,CAAC;QAC/C,QAAQ,EAAE,OAAO;QACjB,OAAO;QACP,OAAO;QACP,OAAO,EAAE,UAAU;QACnB,KAAK,EAAE,OAAO;QACd,UAAU,EAAE,YAAY;KACzB,CAAC,CAAC;IAEH;;OAEG;IACH,MAAM,eAAe,GAAG,CACtB,OAAe,EACf,WAA8B,EAAE,EACR,EAAE;QAC1B,OAAO,IAAI,sBAAsB,CAAC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC3E,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,QAAQ,GAAG,UACf,OAAe,EACf,QAA4B;QAE5B,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;QACJ,CAAC;QACD,OAAO,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC,CAAC;IAEF,uCAAuC;IACvC,QAAQ,CAAC,aAAa,GAAG,eAAe,CAAC;IACzC,QAAQ,CAAC,IAAI,GAAG,eAAe,CAAC;IAEhC,mCAAmC;IAClC,QAAgB,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAE9C,+DAA+D;IAC9D,QAAgB,CAAC,cAAc,GAAG,GAAG,EAAE;QACtC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC,CAAC;IAED,QAAgB,CAAC,UAAU,GAAG,GAAG,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC,CAAC;IAEF,OAAO,QAAyB,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,IAAI,cAAc,GAAyB,IAAI,CAAC;AAEhD,SAAS,gBAAgB;IACvB,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,oFAAoF;gBACpF,sFAAsF,CACvF,CAAC;QACJ,CAAC;QACD,cAAc,GAAG,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAkB,IAAI,KAAK,CAC3C,cAAY,CAA6B,EACzC;IACE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAkC;QACzD,OAAO,gBAAgB,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IACrC,CAAC;IACD,GAAG,CAAC,OAAO,EAAE,IAAI;QACf,IAAI,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAChD,OAAO,CAAC,GAAG,IAAkC,EAAE,EAAE,CAC/C,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,IAAI,KAAK,sBAAsB,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,IAAI,KAAK,gBAAgB,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YACvD,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;YACxF,CAAC,CAAC;QACJ,CAAC;QACD,OAAQ,gBAAgB,EAAU,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;CACF,CACF,CAAC"}

package/dist/client.d.ts

@@ -1,12 +1,14 @@
 /**
  * Puter API Client
  *
- * Handles all communication with Puter.com's AI API
+ * Handles all communication with Puter.com's AI API.
+ * Includes automatic retry with exponential backoff for transient failures.
  */
 import type { PuterChatMessage, PuterChatOptions, PuterChatResponse, PuterChatStreamChunk, PuterModelInfo, PuterConfig } from './types.js';
 export declare class PuterClient {
     private authToken;
     private config;
+    private debug;
     constructor(authToken: string, config?: Partial<PuterConfig>);
     /**
      * Get the API base URL
@@ -16,20 +18,66 @@ export declare class PuterClient {
      * Get the request timeout
      */
     private get timeout();
+    /**
+     * Get retry options from config
+     */
+    private get retryOptions();
     /**
      * Update the auth token
      */
     setAuthToken(token: string): void;
     /**
      * Send a chat completion request (non-streaming)
+     *
+     * Automatically retries on transient failures (rate limits, server errors)
+     * using exponential backoff with jitter.
+     *
+     * @param messages - Array of chat messages
+     * @param options - Chat options (model, temperature, etc.)
+     * @returns Chat response with assistant message
+     * @throws Error if request fails after all retries
+     *
+     * @example
+     * ```ts
+     * const response = await client.chat([
+     *   { role: 'user', content: 'Hello!' }
+     * ], { model: 'claude-opus-4-5' });
+     * console.log(response.message.content);
+     * ```
      */
     chat(messages: PuterChatMessage[], options?: PuterChatOptions): Promise<PuterChatResponse>;
     /**
      * Send a streaming chat completion request
+     *
+     * Returns an async generator that yields chunks as they arrive.
+     * The initial connection is retried on transient failures.
+     *
+     * @param messages - Array of chat messages
+     * @param options - Chat options (model, temperature, etc.)
+     * @yields Chat stream chunks with text, reasoning, or tool calls
+     *
+     * @example
+     * ```ts
+     * for await (const chunk of client.chatStream([
+     *   { role: 'user', content: 'Tell me a story' }
+     * ])) {
+     *   if (chunk.text) process.stdout.write(chunk.text);
+     * }
+     * ```
      */
     chatStream(messages: PuterChatMessage[], options?: PuterChatOptions): AsyncGenerator<PuterChatStreamChunk>;
     /**
-     * List available models
+     * List available models from Puter API
+     *
+     * Falls back to a default model list if the API is unavailable.
+     *
+     * @returns Array of available model information
+     *
+     * @example
+     * ```ts
+     * const models = await client.listModels();
+     * models.forEach(m => console.log(`${m.id}: ${m.name}`));
+     * ```
      */
     listModels(): Promise<PuterModelInfo[]>;
     /**
@@ -38,10 +86,30 @@ export declare class PuterClient {
     private getDefaultModels;
     /**
      * Make a generic API request to the drivers endpoint
+     *
+     * Includes automatic retry with exponential backoff for transient failures.
+     *
+     * @param method - API method to call
+     * @param args - Arguments to pass to the method
+     * @returns API response
+     * @throws Error if request fails after all retries
      */
     private makeRequest;
     /**
-     * Test the connection and auth token
+     * Test the connection and auth token validity
+     *
+     * Makes a minimal API call to verify the token works.
+     *
+     * @returns true if connection is successful, false otherwise
+     *
+     * @example
+     * ```ts
+     * if (await client.testConnection()) {
+     *   console.log('Connected to Puter!');
+     * } else {
+     *   console.log('Connection failed');
+     * }
+     * ```
      */
     testConnection(): Promise<boolean>;
 }

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,WAAW,EACZ,MAAM,YAAY,CAAC;AAKpB,qBAAa,WAAW;IACtB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAuB;gBAEzB,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,WAAW,CAAM;IAKhE;;OAEG;IACH,OAAO,KAAK,MAAM,GAEjB;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAElB;IAED;;OAEG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIxC;;OAEG;IACU,IAAI,CACf,QAAQ,EAAE,gBAAgB,EAAE,EAC5B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAa7B;;OAEG;IACW,UAAU,CACtB,QAAQ,EAAE,gBAAgB,EAAE,EAC5B,OAAO,GAAE,gBAAqB,GAC7B,cAAc,CAAC,oBAAoB,CAAC;IA+EvC;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAqBpD;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoBxB;;OAEG;YACW,WAAW;IAmCzB;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;CAWhD"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,WAAW,EACZ,MAAM,YAAY,CAAC;AAQpB,qBAAa,WAAW;IACtB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,KAAK,CAAU;gBAEX,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,WAAW,CAAM;IAMhE;;OAEG;IACH,OAAO,KAAK,MAAM,GAEjB;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAElB;IAED;;OAEG;IACH,OAAO,KAAK,YAAY,GAUvB;IAED;;OAEG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIxC;;;;;;;;;;;;;;;;;;OAkBG;IACU,IAAI,CACf,QAAQ,EAAE,gBAAgB,EAAE,EAC5B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAa7B;;;;;;;;;;;;;;;;;;OAkBG;IACW,UAAU,CACtB,QAAQ,EAAE,gBAAgB,EAAE,EAC5B,OAAO,GAAE,gBAAqB,GAC7B,cAAc,CAAC,oBAAoB,CAAC;IAoFvC;;;;;;;;;;;;OAYG;IACU,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IA0BpD;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoBxB;;;;;;;;;OASG;YACW,WAAW;IAqCzB;;;;;;;;;;;;;;;OAeG;IACU,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;CAWhD"}