@thewhateverapp/platform 0.7.24 → 0.8.0

package/dist/realtime/types.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Realtime WebSocket Pub/Sub Types
+ *
+ * Provides type definitions for the realtime messaging system
+ * powered by Cloudflare Durable Objects.
+ */
+/**
+ * Message types for WebSocket communication
+ */
+export type RealtimeMessageType = 'subscribe' | 'unsubscribe' | 'publish' | 'ping' | 'pong' | 'data' | 'error' | 'connected' | 'subscribed' | 'unsubscribed';
+/**
+ * Base message structure for realtime communication
+ */
+export interface RealtimeMessage {
+    type: RealtimeMessageType;
+    channel?: string;
+    channels?: string[];
+    data?: unknown;
+    timestamp?: number;
+    message?: string;
+}
+/**
+ * Options for publishing messages
+ */
+export interface PublishOptions {
+    /**
+     * Whether to wait for confirmation
+     * @default false
+     */
+    waitForConfirm?: boolean;
+}
+/**
+ * Result of a publish operation
+ */
+export interface PublishResult {
+    success: boolean;
+    channel: string;
+    recipients: number;
+}
+/**
+ * Environment bindings required for Realtime
+ */
+export interface RealtimeEnv {
+    /**
+     * Durable Object namespace binding for RealtimeChannel
+     */
+    REALTIME?: DurableObjectNamespace;
+    /**
+     * App ID for channel isolation
+     */
+    APP_ID?: string;
+}
+/**
+ * Server-side Realtime Provider interface
+ *
+ * Used in API routes to publish messages to connected clients.
+ *
+ * @example
+ * ```typescript
+ * import { getRealtime } from '@thewhateverapp/platform';
+ *
+ * export async function POST(req: Request) {
+ *   const realtime = await getRealtime();
+ *
+ *   // Publish to a channel
+ *   await realtime.publish('counter', { count: 42 });
+ *
+ *   return new Response('OK');
+ * }
+ * ```
+ */
+export interface RealtimeProvider {
+    /**
+     * Publish a message to a channel
+     *
+     * All connected clients subscribed to this channel will receive the message.
+     *
+     * @param channel - Channel name to publish to
+     * @param data - Data to send (will be JSON serialized)
+     * @param options - Optional publish options
+     * @returns Result with recipient count
+     */
+    publish(channel: string, data: unknown, options?: PublishOptions): Promise<PublishResult>;
+    /**
+     * Get statistics about connected clients
+     *
+     * @returns Stats including total connections and per-channel counts
+     */
+    getStats(): Promise<RealtimeStats>;
+    /**
+     * Check if the realtime service is healthy
+     *
+     * @returns True if the service is responding
+     */
+    isHealthy(): Promise<boolean>;
+}
+/**
+ * Statistics about realtime connections
+ */
+export interface RealtimeStats {
+    totalConnections: number;
+    channels: Record<string, number>;
+}
+/**
+ * Options for creating a realtime connection (client-side)
+ */
+export interface RealtimeConnectionOptions {
+    /**
+     * Channels to subscribe to immediately on connect
+     */
+    channels?: string[];
+    /**
+     * Auto-reconnect on disconnect
+     * @default true
+     */
+    autoReconnect?: boolean;
+    /**
+     * Reconnect delay in milliseconds
+     * @default 1000
+     */
+    reconnectDelay?: number;
+    /**
+     * Maximum reconnect attempts (0 = unlimited)
+     * @default 10
+     */
+    maxReconnectAttempts?: number;
+    /**
+     * Ping interval in milliseconds (0 = disabled)
+     * @default 30000
+     */
+    pingInterval?: number;
+}
+/**
+ * Connection state for client-side realtime
+ */
+export type RealtimeConnectionState = 'connecting' | 'connected' | 'disconnected' | 'reconnecting';
+/**
+ * Client-side realtime connection interface
+ */
+export interface RealtimeConnection {
+    /**
+     * Current connection state
+     */
+    readonly state: RealtimeConnectionState;
+    /**
+     * Currently subscribed channels
+     */
+    readonly channels: readonly string[];
+    /**
+     * Subscribe to a channel
+     */
+    subscribe(channel: string): void;
+    /**
+     * Unsubscribe from a channel
+     */
+    unsubscribe(channel: string): void;
+    /**
+     * Publish a message (client-to-server-to-all)
+     */
+    publish(channel: string, data: unknown): void;
+    /**
+     * Add a message listener for a channel
+     */
+    on(channel: string, callback: (data: unknown) => void): () => void;
+    /**
+     * Add a listener for all messages
+     */
+    onAny(callback: (channel: string, data: unknown) => void): () => void;
+    /**
+     * Add a connection state listener
+     */
+    onStateChange(callback: (state: RealtimeConnectionState) => void): () => void;
+    /**
+     * Disconnect and cleanup
+     */
+    disconnect(): void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/realtime/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/realtime/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,WAAW,GACX,aAAa,GACb,SAAS,GACT,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,WAAW,GACX,YAAY,GACZ,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1F;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAEnC;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,cAAc,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAEnE;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAEtE;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,uBAAuB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAE9E;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;CACpB"}

package/dist/realtime/types.js

@@ -0,0 +1,8 @@
+/**
+ * Realtime WebSocket Pub/Sub Types
+ *
+ * Provides type definitions for the realtime messaging system
+ * powered by Cloudflare Durable Objects.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/realtime/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/realtime/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thewhateverapp/platform",
-  "version": "0.7.24",
+  "version": "0.8.0",
   "description": "Universal SDK for The Whatever App platform services",
   "type": "module",
   "main": "./dist/index.js",
@@ -50,15 +50,20 @@
   "homepage": "https://thewhatever.app",
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20250402.0",
+    "@types/react": "^18.0.0",
     "typescript": "^5.7.3"
   },
   "peerDependencies": {
     "@cloudflare/workers-types": "^4.0.0",
-    "@opennextjs/cloudflare": "^1.0.0"
+    "@opennextjs/cloudflare": "^1.0.0",
+    "react": "^18.0.0"
   },
   "peerDependenciesMeta": {
     "@opennextjs/cloudflare": {
       "optional": true
+    },
+    "react": {
+      "optional": true
     }
   }
 }