@donkeylabs/adapter-sveltekit 2.0.14 → 2.0.16

package/dist/client/index.d.ts

@@ -0,0 +1,231 @@
+/**
+ * Unified API client for @donkeylabs/adapter-sveltekit
+ *
+ * Auto-detects environment:
+ * - SSR: Direct service calls through locals (no HTTP)
+ * - Browser: HTTP calls to API routes
+ */
+export interface RequestOptions {
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+export interface ClientOptions {
+    /** Base URL for HTTP calls. Defaults to empty string (relative URLs). */
+    baseUrl?: string;
+    /** SvelteKit locals object for SSR direct calls. */
+    locals?: any;
+    /** Custom fetch function. In SSR, pass event.fetch to handle relative URLs. */
+    fetch?: typeof fetch;
+}
+export interface SSESubscription {
+    unsubscribe: () => void;
+}
+/**
+ * SSE options for connection configuration.
+ * Compatible with @donkeylabs/server/client SSEOptions.
+ */
+export interface SSEOptions {
+    /** Called when connection is established */
+    onConnect?: () => void;
+    /** Called when connection is lost */
+    onDisconnect?: () => void;
+    /** Called on connection error */
+    onError?: (error: Event) => void;
+    /** Auto-reconnect on disconnect (default: true) */
+    autoReconnect?: boolean;
+    /** Reconnect delay in ms (default: 3000) */
+    reconnectDelay?: number;
+}
+/**
+ * Options for SSE connection behavior.
+ */
+export interface SSEConnectionOptions {
+    /** Enable automatic reconnection on disconnect (default: true) */
+    autoReconnect?: boolean;
+    /** Delay in ms before attempting reconnect (default: 3000) */
+    reconnectDelay?: number;
+    /** Called when connection is established */
+    onConnect?: () => void;
+    /** Called when connection is lost */
+    onDisconnect?: () => void;
+}
+/**
+ * Type-safe SSE connection wrapper.
+ * Provides typed event handlers with automatic JSON parsing.
+ *
+ * @example
+ * ```ts
+ * // With auto-reconnect (default)
+ * const connection = api.notifications.subscribe({ userId: "123" });
+ *
+ * // Disable auto-reconnect for manual control
+ * const connection = api.notifications.subscribe({ userId: "123" }, {
+ *   autoReconnect: false
+ * });
+ *
+ * // Custom reconnect delay
+ * const connection = api.notifications.subscribe({ userId: "123" }, {
+ *   reconnectDelay: 5000 // 5 seconds
+ * });
+ *
+ * // Typed event handler - returns unsubscribe function
+ * const unsubscribe = connection.on("notification", (data) => {
+ *   console.log(data.message); // Fully typed!
+ * });
+ *
+ * // Later: unsubscribe from this specific handler
+ * unsubscribe();
+ *
+ * // Close entire connection
+ * connection.close();
+ * ```
+ */
+export declare class SSEConnection<TEvents extends Record<string, any> = Record<string, any>> {
+    private eventSource;
+    private handlers;
+    private url;
+    private options;
+    private reconnectTimeout;
+    private closed;
+    constructor(url: string, options?: SSEConnectionOptions);
+    private createEventSource;
+    private scheduleReconnect;
+    private dispatchEvent;
+    /**
+     * Register a typed event handler.
+     * @returns Unsubscribe function to remove this specific handler
+     */
+    on<K extends keyof TEvents>(event: K & string, handler: (data: TEvents[K]) => void): () => void;
+    /**
+     * Register a typed event handler that fires only once.
+     * @returns Unsubscribe function to remove this specific handler
+     */
+    once<K extends keyof TEvents>(event: K & string, handler: (data: TEvents[K]) => void): () => void;
+    /**
+     * Remove all handlers for an event.
+     */
+    off<K extends keyof TEvents>(event: K & string): void;
+    /**
+     * Register error handler.
+     * Note: With autoReconnect enabled, errors trigger automatic reconnection.
+     */
+    onError(handler: (event: Event) => void): () => void;
+    /**
+     * Register open handler (connection established)
+     */
+    onOpen(handler: (event: Event) => void): () => void;
+    /**
+     * Get connection state
+     */
+    get readyState(): number;
+    /**
+     * Check if connected
+     */
+    get connected(): boolean;
+    /**
+     * Check if reconnecting
+     */
+    get reconnecting(): boolean;
+    /**
+     * Close the SSE connection and stop reconnection attempts
+     */
+    close(): void;
+}
+/**
+ * Base class for unified API clients.
+ * Extend this class with your generated route methods.
+ */
+export declare class UnifiedApiClientBase {
+    protected baseUrl: string;
+    protected locals?: any;
+    protected isSSR: boolean;
+    protected customFetch?: typeof fetch;
+    constructor(options?: ClientOptions);
+    /**
+     * Make a request to an API route.
+     * Automatically uses direct calls in SSR (when locals.handleRoute is available), HTTP otherwise.
+     */
+    protected request<TInput, TOutput>(route: string, input: TInput, options?: RequestOptions): Promise<TOutput>;
+    /**
+     * HTTP call to API endpoint (browser or SSR with event.fetch).
+     */
+    private httpCall;
+    /**
+     * Make a raw request (for non-JSON endpoints like streaming).
+     * Returns the raw Response object without processing.
+     */
+    protected rawRequest(route: string, init?: RequestInit): Promise<Response>;
+    /**
+     * Make a stream request (validated input, Response output).
+     * For streaming, binary data, or custom content-type responses.
+     *
+     * By default uses POST with JSON body. For browser compatibility
+     * (video src, image src, download links), use streamUrl() instead.
+     */
+    protected streamRequest<TInput>(route: string, input: TInput, options?: RequestOptions): Promise<Response>;
+    /**
+     * Get the URL for a stream endpoint (for browser src attributes).
+     * Returns a URL with query params that can be used in:
+     * - <video src={url}>
+     * - <img src={url}>
+     * - <a href={url} download>
+     * - window.open(url)
+     */
+    protected streamUrl<TInput>(route: string, input?: TInput): string;
+    /**
+     * Fetch a stream via GET with query params.
+     * Alternative to streamRequest() for cases where GET is preferred.
+     */
+    protected streamGet<TInput>(route: string, input?: TInput, options?: RequestOptions): Promise<Response>;
+    /**
+     * Connect to an SSE endpoint.
+     * Returns a typed SSEConnection for handling server-sent events.
+     */
+    protected sseConnect<TInput, TEvents extends Record<string, any> = Record<string, any>>(route: string, input?: TInput, options?: SSEConnectionOptions): SSEConnection<TEvents>;
+    /**
+     * Connect to a specific SSE route endpoint.
+     * Alias for sseConnect() - provides compatibility with @donkeylabs/server generated clients.
+     * @returns SSE connection with typed event handlers
+     */
+    protected connectToSSERoute<TEvents extends Record<string, any>>(route: string, input?: Record<string, any>, options?: Omit<SSEOptions, "endpoint" | "channels">): SSEConnection<TEvents>;
+    /**
+     * Make a formData request (file uploads with validated fields).
+     */
+    protected formDataRequest<TFields, TOutput>(route: string, fields: TFields, files: File[], options?: RequestOptions): Promise<TOutput>;
+    /**
+     * Make an HTML request (returns HTML string).
+     */
+    protected htmlRequest<TInput>(route: string, input?: TInput, options?: RequestOptions): Promise<string>;
+    /**
+     * SSE (Server-Sent Events) subscription.
+     * Only works in the browser.
+     */
+    sse: {
+        /**
+         * Subscribe to SSE channels.
+         * Returns a function to unsubscribe.
+         *
+         * @example
+         * const unsub = api.sse.subscribe(["notifications"], (event, data) => {
+         *   console.log(event, data);
+         * });
+         * // Later: unsub();
+         */
+        subscribe: (channels: string[], callback: (event: string, data: any) => void, options?: {
+            reconnect?: boolean;
+        }) => (() => void);
+    };
+}
+/**
+ * Create an API client instance.
+ * Call with locals and fetch in SSR, without in browser.
+ *
+ * @example
+ * // +page.server.ts (SSR)
+ * const api = createApiClient({ locals, fetch });
+ *
+ * // +page.svelte (browser)
+ * const api = createApiClient();
+ */
+export declare function createApiClient<T extends UnifiedApiClientBase>(ClientClass: new (options?: ClientOptions) => T, options?: ClientOptions): T;
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,+EAA+E;IAC/E,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,qCAAqC;IACrC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,iCAAiC;IACjC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,mDAAmD;IACnD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,4CAA4C;IAC5C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,kEAAkE;IAClE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,qCAAqC;IACrC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,aAAa,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAClF,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,QAAQ,CAA+C;IAC/D,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,gBAAgB,CAA8C;IACtE,OAAO,CAAC,MAAM,CAAS;gBAEX,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB;IAU3D,OAAO,CAAC,iBAAiB;IA2BzB,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,aAAa;IAgBrB;;;OAGG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,OAAO,EACxB,KAAK,EAAE,CAAC,GAAG,MAAM,EACjB,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,GAClC,MAAM,IAAI;IAuBb;;;OAGG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,OAAO,EAC1B,KAAK,EAAE,CAAC,GAAG,MAAM,EACjB,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,GAClC,MAAM,IAAI;IASb;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI;IAIrD;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM,IAAI;IAiBpD;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM,IAAI;IAanD;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;OAEG;IACH,KAAK,IAAI,IAAI;CAUd;AAED;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC;IACvB,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,WAAW,CAAC,EAAE,OAAO,KAAK,CAAC;gBAEzB,OAAO,CAAC,EAAE,aAAa;IAOnC;;;OAGG;cACa,OAAO,CAAC,MAAM,EAAE,OAAO,EACrC,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IASnB;;OAEG;YACW,QAAQ;IA0BtB;;;OAGG;cACa,UAAU,CACxB,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,QAAQ,CAAC;IAUpB;;;;;;OAMG;cACa,aAAa,CAAC,MAAM,EAClC,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC;IAmBpB;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM;IAclE;;;OAGG;cACa,SAAS,CAAC,MAAM,EAC9B,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC;IAWpB;;;OAGG;IACH,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACpF,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,oBAAoB,GAC7B,aAAa,CAAC,OAAO,CAAC;IAezB;;;;OAIG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7D,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAAC,GAClD,aAAa,CAAC,OAAO,CAAC;IAWzB;;OAEG;cACa,eAAe,CAAC,OAAO,EAAE,OAAO,EAC9C,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IAiCnB;;OAEG;cACa,WAAW,CAAC,MAAM,EAChC,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IA6BlB;;;OAGG;IACH,GAAG;QACD;;;;;;;;;WASG;8BAES,MAAM,EAAE,YACR,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,YAClC;YAAE,SAAS,CAAC,EAAE,OAAO,CAAA;SAAE,KAChC,CAAC,MAAM,IAAI,CAAC;MA+Df;CACH;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,oBAAoB,EAC5D,WAAW,EAAE,KAAK,OAAO,CAAC,EAAE,aAAa,KAAK,CAAC,EAC/C,OAAO,CAAC,EAAE,aAAa,GACtB,CAAC,CAEH"}