2dai-sdk 1.4.0

package/dist/client.d.ts

@@ -0,0 +1,222 @@
+/**
+ * 2DAI SDK Client
+ * Official TypeScript/JavaScript client for 2DAI API
+ */
+import { ClientOptions, ImageGenerationOptions, VideoGenerationOptions, TextGenerationOptions, ImageGenerationResult, VideoGenerationResult, TextGenerationResult, UpscaleOptions, UpscaleResult, APIKeySettings, RateLimitInfo, WsRequestData, WsResponseData, WsImageRequest, WsImg2ImgRequest, WsVideoRequest, WsLlmRequest, WsUpscaleRequest, WsImageResponse, WsVideoResponse, WsLlmResponse, WsUpscaleResponse } from './types';
+/**
+ * Main 2DAI SDK Client
+ */
+export declare class TwoDAIClient {
+    private apiKey;
+    private baseUrl;
+    private timeout;
+    private debug;
+    private axios;
+    private ws;
+    private wsPingInterval;
+    private wsReconnectAttempts;
+    private wsPendingRequests;
+    private wsShouldReconnect;
+    private wsAuthenticated;
+    private wsConnecting;
+    private wsClosingIntentionally;
+    private wsOptions;
+    /**
+     * Create a new 2DAI SDK client
+     *
+     * @param options Client configuration options
+     */
+    constructor(options: ClientOptions);
+    /**
+     * Log debug messages
+     */
+    private log;
+    /**
+     * Generate an image from a text prompt
+     */
+    generateImage(options: ImageGenerationOptions): Promise<ImageGenerationResult>;
+    /**
+     * Edit an existing image (img2img)
+     * Supports optional width/height for resizing the output image
+     * Note: The API does not support strength parameter - it uses fixed settings
+     */
+    editImage(imageId: string, options: Omit<ImageGenerationOptions, 'format' | 'style'>): Promise<ImageGenerationResult>;
+    /**
+     * AI upscale an image (img2ximg)
+     * Uses AI to generate prompt automatically - no user prompt needed
+     *
+     * @param imageId Source image ID from CDN
+     * @param options Upscale options (factor: 2-4, default: 2)
+     */
+    upscaleImage(imageId: string, options?: UpscaleOptions): Promise<UpscaleResult>;
+    /**
+     * Generate a video from an image
+     */
+    generateVideo(options: VideoGenerationOptions): Promise<VideoGenerationResult>;
+    /**
+     * Generate text using LLM
+     */
+    generateText(options: TextGenerationOptions): Promise<TextGenerationResult>;
+    /**
+     * Get API key settings
+     */
+    getSettings(): Promise<APIKeySettings>;
+    /**
+     * Update API key watermark
+     */
+    updateWatermark(watermarkCdnId: string | undefined): Promise<boolean>;
+    /**
+     * Check rate limits for all operations
+     */
+    checkLimits(): Promise<RateLimitInfo[]>;
+    /**
+     * Get health status of the API
+     */
+    health(): Promise<{
+        status: string;
+        timestamp: string;
+    }>;
+    /**
+     * Connect to WebSocket server with auto-reconnect support
+     */
+    wsConnect(): Promise<void>;
+    /**
+     * Authenticate with the WebSocket server
+     */
+    private wsAuthenticate;
+    /**
+     * Handle incoming WebSocket messages
+     */
+    private wsHandleMessage;
+    /**
+     * Handle generation result
+     */
+    private wsHandleResult;
+    /**
+     * Handle error response
+     */
+    private wsHandleError;
+    /**
+     * Start ping interval to keep connection alive
+     */
+    private wsStartPing;
+    /**
+     * Stop ping interval
+     */
+    private wsStopPing;
+    /**
+     * Handle WebSocket close
+     */
+    private wsHandleClose;
+    /**
+     * Reconnect with exponential backoff
+     */
+    private wsReconnectWithBackoff;
+    /**
+     * Retry pending requests after reconnection
+     */
+    private wsRetryPending;
+    /**
+     * Reject all pending requests
+     */
+    private wsRejectPending;
+    /**
+     * Low-level WebSocket send. Prefer helper methods: wsGenerateImage, wsGenerateVideo, wsGenerateLlm, wsUpscaleImage
+     * @internal
+     */
+    wsSend(type: 'generate_image', data: WsImageRequest | WsImg2ImgRequest, timeout?: number): Promise<WsImageResponse>;
+    wsSend(type: 'generate_video', data: WsVideoRequest, timeout?: number): Promise<WsVideoResponse>;
+    wsSend(type: 'generate_llm', data: WsLlmRequest, timeout?: number): Promise<WsLlmResponse>;
+    wsSend(type: 'generate_upscale', data: WsUpscaleRequest, timeout?: number): Promise<WsUpscaleResponse>;
+    wsSend(type: string, data: WsRequestData, timeout?: number): Promise<WsResponseData>;
+    /**
+     * Generate an image via WebSocket (text2img or img2img)
+     *
+     * @example Text-to-Image
+     * ```typescript
+     * const result = await client.wsGenerateImage({
+     *   prompt: 'A sunset over mountains',
+     *   style: 'realistic',
+     *   format: 'landscape'
+     * });
+     * console.log(result.result.imageId);
+     * ```
+     *
+     * @example Image-to-Image (edit)
+     * ```typescript
+     * const result = await client.wsGenerateImage({
+     *   imageId: 'existing-image-id',
+     *   prompt: 'add dramatic lighting'
+     * });
+     * ```
+     */
+    wsGenerateImage(data: WsImageRequest | WsImg2ImgRequest, timeout?: number): Promise<WsImageResponse>;
+    /**
+     * Generate a video from an image via WebSocket
+     *
+     * @example
+     * ```typescript
+     * const result = await client.wsGenerateVideo({
+     *   imageId: 'source-image-id',
+     *   duration: 5,
+     *   fps: 16
+     * });
+     * console.log(result.result.videoId);
+     * ```
+     */
+    wsGenerateVideo(data: WsVideoRequest, timeout?: number): Promise<WsVideoResponse>;
+    /**
+     * Generate text via LLM over WebSocket
+     *
+     * @example Basic
+     * ```typescript
+     * const result = await client.wsGenerateLlm({
+     *   prompt: 'Explain TypeScript'
+     * });
+     * console.log(result.result.text);
+     * ```
+     *
+     * @example With system prompt and JSON output
+     * ```typescript
+     * const result = await client.wsGenerateLlm({
+     *   prompt: 'List 3 programming languages',
+     *   system: 'You are a helpful assistant',
+     *   jsonFormat: true,
+     *   jsonTemplate: { languages: 'array' }
+     * });
+     * console.log(result.result.json);
+     * ```
+     */
+    wsGenerateLlm(data: WsLlmRequest, timeout?: number): Promise<WsLlmResponse>;
+    /**
+     * AI upscale an image via WebSocket (img2ximg)
+     * Uses AI to generate prompt automatically - no user prompt needed
+     *
+     * @example
+     * ```typescript
+     * const result = await client.wsUpscaleImage({
+     *   imageId: 'source-image-id',
+     *   factor: 2
+     * });
+     * console.log(result.result.imageId, result.result.width, result.result.height);
+     * ```
+     */
+    wsUpscaleImage(data: WsUpscaleRequest, timeout?: number): Promise<WsUpscaleResponse>;
+    /**
+     * Check if WebSocket is connected
+     */
+    wsIsConnected(): boolean;
+    /**
+     * Close WebSocket connection and cleanup
+     */
+    close(): Promise<void>;
+}
+/**
+ * Create a new 2DAI SDK client
+ *
+ * @param apiKey Your 2DAI API key
+ * @param options Optional client configuration
+ */
+export declare function createClient(apiKey: string, options?: Partial<ClientOptions>): TwoDAIClient;
+export default TwoDAIClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACL,aAAa,EACb,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,aAAa,EACb,cAAc,EACd,aAAa,EAEb,aAAa,EACb,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,aAAa,EACb,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAgBjB;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,KAAK,CAAgB;IAG7B,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,iBAAiB,CAAuC;IAChE,OAAO,CAAC,iBAAiB,CAAQ;IACjC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,sBAAsB,CAAS;IACvC,OAAO,CAAC,SAAS,CAKf;IAEF;;;;OAIG;gBACS,OAAO,EAAE,aAAa;IA+ClC;;OAEG;IACH,OAAO,CAAC,GAAG;IAMX;;OAEG;IACG,aAAa,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA2BpF;;;;OAIG;IACG,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,sBAAsB,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAiC3H;;;;;;OAMG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;IA2BzF;;OAEG;IACG,aAAa,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BpF;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA4CjF;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,cAAc,CAAC;IAW5C;;OAEG;IACG,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAa3E;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAW7C;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAe9D;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAgDhC;;OAEG;IACH,OAAO,CAAC,cAAc;IAStB;;OAEG;IACH,OAAO,CAAC,eAAe;IAyCvB;;OAEG;IACH,OAAO,CAAC,cAAc;IAStB;;OAEG;IACH,OAAO,CAAC,aAAa;IASrB;;OAEG;IACH,OAAO,CAAC,WAAW;IAWnB;;OAEG;IACH,OAAO,CAAC,UAAU;IAOlB;;OAEG;YACW,aAAa;IAgB3B;;OAEG;YACW,sBAAsB;IAmBpC;;OAEG;IACH,OAAO,CAAC,cAAc;IAStB;;OAEG;IACH,OAAO,CAAC,eAAe;IAOvB;;;OAGG;IACG,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,cAAc,GAAG,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IACnH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAChG,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAC1F,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IACtG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAoC1F;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAI1G;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIvF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIjF;;;;;;;;;;;;OAYG;IACG,cAAc,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI1F;;OAEG;IACH,aAAa,IAAI,OAAO;IAIxB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAmB7B;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,YAAY,CAK3F;AAED,eAAe,YAAY,CAAC"}