@pooflabs/core 0.0.21 → 0.0.22

package/dist/client/subscription-v2.d.ts

@@ -0,0 +1,47 @@
+/**
+ * WebSocket v2 Subscription Manager
+ *
+ * This module implements multiplexed subscriptions over a single WebSocket connection.
+ * It maintains the same external API as v1 but uses the new v2 protocol internally.
+ */
+import { SubscriptionOptions } from '../types';
+/**
+ * Subscribe to data at a path using WebSocket v2.
+ * Returns an unsubscribe function.
+ */
+export declare function subscribeV2(path: string, subscriptionOptions: SubscriptionOptions): Promise<() => Promise<void>>;
+/**
+ * Close all v2 subscriptions.
+ */
+export declare function closeAllSubscriptionsV2(): Promise<void>;
+/**
+ * Clear the v2 cache.
+ */
+export declare function clearCacheV2(path?: string): void;
+/**
+ * Get cached data for a path (v2).
+ */
+export declare function getCachedDataV2(path: string, prompt?: string): any | null;
+/**
+ * Reconnect all v2 WebSocket connections with fresh authentication.
+ * Call this when the user's auth state changes (login/logout).
+ *
+ * This will:
+ * 1. Close existing connections
+ * 2. Re-establish with new auth token
+ * 3. Re-subscribe to all active paths
+ *
+ * Note: Existing subscriptions will receive new initial data after reconnection.
+ */
+export declare function reconnectWithNewAuthV2(): Promise<void>;
+/**
+ * Force close and reconnect all connections.
+ * This is more aggressive than reconnectWithNewAuthV2() and ensures
+ * a complete teardown and rebuild of connections.
+ */
+export declare function forceReconnectV2(): Promise<void>;
+declare global {
+    interface Window {
+        CUSTOM_TAROBASE_APP_ID_HEADER?: string;
+    }
+}

package/dist/client/subscription.d.ts

@@ -1,8 +1,62 @@
+/**
+ * WebSocket Subscription Module
+ *
+ * This module provides real-time data subscriptions using WebSocket v2 protocol
+ * with multiplexed connections (one connection per client, multiple subscriptions).
+ *
+ * The external API remains unchanged - just use subscribe(path, options) as before.
+ */
 import { SubscriptionOptions } from '../types';
+/**
+ * Subscribe to real-time updates for a path.
+ *
+ * @param path - The path to subscribe to (e.g., 'users/123' or 'posts')
+ * @param subscriptionOptions - Options including onData and onError callbacks
+ * @returns A function to unsubscribe
+ *
+ * @example
+ * ```typescript
+ * const unsubscribe = await subscribe('users/123', {
+ *   onData: (data) => console.log('User updated:', data),
+ *   onError: (error) => console.error('Subscription error:', error),
+ * });
+ *
+ * // Later, to unsubscribe:
+ * await unsubscribe();
+ * ```
+ */
 export declare function subscribe(path: string, subscriptionOptions: SubscriptionOptions): Promise<() => Promise<void>>;
+/**
+ * Close all active subscriptions.
+ * Call this when cleaning up (e.g., on logout or component unmount).
+ */
 export declare function closeAllSubscriptions(): Promise<void>;
+/**
+ * Clear the subscription cache.
+ *
+ * @param path - Optional path to clear. If not provided, clears all cached data.
+ */
 export declare function clearCache(path?: string): void;
+/**
+ * Get cached data for a path without making a network request.
+ *
+ * @param path - The path to get cached data for
+ * @param prompt - Optional prompt that was used for the subscription
+ * @returns The cached data, or null if not cached or expired
+ */
 export declare function getCachedData(path: string, prompt?: string): any | null;
+/**
+ * Reconnect all WebSocket connections with fresh authentication.
+ * Call this when the user's auth state changes (login/logout).
+ *
+ * This will:
+ * 1. Close existing connections
+ * 2. Re-establish with new auth token
+ * 3. Re-subscribe to all active paths
+ *
+ * Existing subscriptions will receive new initial data after reconnection.
+ */
+export declare function reconnectWithNewAuth(): Promise<void>;
 declare global {
     interface Window {
         CUSTOM_TAROBASE_APP_ID_HEADER?: string;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { init } from './client/config';
 export { getConfig, ClientConfig } from './client/config';
 export { get, set, setMany, setFile, getFiles, runQuery, runQueryMany, runExpression, runExpressionMany, signMessage, signTransaction, signAndSubmitTransaction, SetOptions, RunExpressionOptions, RunExpressionResult } from './client/operations';
-export { subscribe } from './client/subscription';
+export { subscribe, closeAllSubscriptions, clearCache, getCachedData, reconnectWithNewAuth } from './client/subscription';
 export * from './types';
 export { getIdToken } from './utils/utils';
 export { WebSessionManager } from './utils/web-session-manager';