@flightdev/realtime 0.0.2

package/dist/frameworks/vue.js

@@ -0,0 +1,55 @@
+import { ref, onUnmounted } from 'vue';
+
+// src/frameworks/vue.ts
+function useRealtime(realtime) {
+  const state = ref(realtime.state);
+  const error = ref(null);
+  const unsubState = realtime.onStateChange((s) => {
+    state.value = s;
+  });
+  const unsubError = realtime.onError((e) => {
+    error.value = e;
+  });
+  onUnmounted(() => {
+    unsubState();
+    unsubError();
+  });
+  async function connect() {
+    try {
+      await realtime.connect();
+      error.value = null;
+    } catch (err) {
+      error.value = err;
+      throw err;
+    }
+  }
+  function disconnect() {
+    realtime.disconnect();
+  }
+  return { state, connect, disconnect, error };
+}
+function useChannel(realtime, channelName, options = {}) {
+  const { maxMessages = 100, event } = options;
+  const messages = ref([]);
+  const channel = realtime.channel(channelName);
+  const handleMessage = (msg) => {
+    messages.value = [...messages.value, msg].slice(-maxMessages);
+  };
+  const unsubscribe = event ? channel.on(event, handleMessage) : channel.subscribe(handleMessage);
+  onUnmounted(() => {
+    unsubscribe();
+    channel.leave();
+  });
+  function send(data, eventType = "message") {
+    channel.send(data, eventType);
+  }
+  function clear() {
+    messages.value = [];
+  }
+  return { messages, send, clear };
+}
+var vue_default = { useRealtime, useChannel };
+
+export { vue_default as default, useChannel, useRealtime };
+//# sourceMappingURL=vue.js.map
+//# sourceMappingURL=vue.js.map

package/dist/frameworks/vue.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/frameworks/vue.ts"],"names":[],"mappings":";;;AAcO,SAAS,YAAY,QAAA,EAA8C;AACtE,EAAA,MAAM,KAAA,GAAQ,GAAA,CAAqB,QAAA,CAAS,KAAK,CAAA;AACjD,EAAA,MAAM,KAAA,GAAQ,IAAkB,IAAI,CAAA;AAEpC,EAAA,MAAM,UAAA,GAAa,QAAA,CAAS,aAAA,CAAc,CAAC,CAAA,KAAM;AAAE,IAAA,KAAA,CAAM,KAAA,GAAQ,CAAA;AAAA,EAAG,CAAC,CAAA;AACrE,EAAA,MAAM,UAAA,GAAa,QAAA,CAAS,OAAA,CAAQ,CAAC,CAAA,KAAM;AAAE,IAAA,KAAA,CAAM,KAAA,GAAQ,CAAA;AAAA,EAAG,CAAC,CAAA;AAE/D,EAAA,WAAA,CAAY,MAAM;AACd,IAAA,UAAA,EAAW;AACX,IAAA,UAAA,EAAW;AAAA,EACf,CAAC,CAAA;AAED,EAAA,eAAe,OAAA,GAAU;AACrB,IAAA,IAAI;AACA,MAAA,MAAM,SAAS,OAAA,EAAQ;AACvB,MAAA,KAAA,CAAM,KAAA,GAAQ,IAAA;AAAA,IAClB,SAAS,GAAA,EAAK;AACV,MAAA,KAAA,CAAM,KAAA,GAAQ,GAAA;AACd,MAAA,MAAM,GAAA;AAAA,IACV;AAAA,EACJ;AAEA,EAAA,SAAS,UAAA,GAAa;AAClB,IAAA,QAAA,CAAS,UAAA,EAAW;AAAA,EACxB;AAEA,EAAA,OAAO,EAAE,KAAA,EAAO,OAAA,EAAS,UAAA,EAAY,KAAA,EAAM;AAC/C;AAQO,SAAS,UAAA,CACZ,QAAA,EACA,WAAA,EACA,OAAA,GAAoD,EAAC,EAClC;AACnB,EAAA,MAAM,EAAE,WAAA,GAAc,GAAA,EAAK,KAAA,EAAM,GAAI,OAAA;AACrC,EAAA,MAAM,QAAA,GAAW,GAAA,CAA0B,EAAE,CAAA;AAC7C,EAAA,MAAM,OAAA,GAAU,QAAA,CAAS,OAAA,CAAW,WAAW,CAAA;AAE/C,EAAA,MAAM,aAAA,GAAgB,CAAC,GAAA,KAA4B;AAC/C,IAAA,QAAA,CAAS,KAAA,GAAQ,CAAC,GAAG,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAA,CAAM,CAAC,WAAW,CAAA;AAAA,EAChE,CAAA;AAEA,EAAA,MAAM,WAAA,GAAc,QACd,OAAA,CAAQ,EAAA,CAAG,OAAO,aAAa,CAAA,GAC/B,OAAA,CAAQ,SAAA,CAAU,aAAa,CAAA;AAErC,EAAA,WAAA,CAAY,MAAM;AACd,IAAA,WAAA,EAAY;AACZ,IAAA,OAAA,CAAQ,KAAA,EAAM;AAAA,EAClB,CAAC,CAAA;AAED,EAAA,SAAS,IAAA,CAAK,IAAA,EAAS,SAAA,GAAY,SAAA,EAAW;AAC1C,IAAA,OAAA,CAAQ,IAAA,CAAK,MAAM,SAAS,CAAA;AAAA,EAChC;AAEA,EAAA,SAAS,KAAA,GAAQ;AACb,IAAA,QAAA,CAAS,QAAQ,EAAC;AAAA,EACtB;AAEA,EAAA,OAAO,EAAE,QAAA,EAAU,IAAA,EAAM,KAAA,EAAM;AACnC;AAEA,IAAO,WAAA,GAAQ,EAAE,WAAA,EAAa,UAAA","file":"vue.js","sourcesContent":["/**\r\n * Vue Composables for @flightdev/realtime\r\n */\r\n\r\nimport { ref, onUnmounted, type Ref } from 'vue';\r\nimport type { RealtimeService, RealtimeMessage, ConnectionState } from '../index.js';\r\n\r\nexport interface UseRealtimeReturn {\r\n    state: Ref<ConnectionState>;\r\n    connect: () => Promise<void>;\r\n    disconnect: () => void;\r\n    error: Ref<Error | null>;\r\n}\r\n\r\nexport function useRealtime(realtime: RealtimeService): UseRealtimeReturn {\r\n    const state = ref<ConnectionState>(realtime.state);\r\n    const error = ref<Error | null>(null);\r\n\r\n    const unsubState = realtime.onStateChange((s) => { state.value = s; });\r\n    const unsubError = realtime.onError((e) => { error.value = e; });\r\n\r\n    onUnmounted(() => {\r\n        unsubState();\r\n        unsubError();\r\n    });\r\n\r\n    async function connect() {\r\n        try {\r\n            await realtime.connect();\r\n            error.value = null;\r\n        } catch (err) {\r\n            error.value = err as Error;\r\n            throw err;\r\n        }\r\n    }\r\n\r\n    function disconnect() {\r\n        realtime.disconnect();\r\n    }\r\n\r\n    return { state, connect, disconnect, error };\r\n}\r\n\r\nexport interface UseChannelReturn<T> {\r\n    messages: Ref<RealtimeMessage<T>[]>;\r\n    send: (data: T, event?: string) => void;\r\n    clear: () => void;\r\n}\r\n\r\nexport function useChannel<T = unknown>(\r\n    realtime: RealtimeService,\r\n    channelName: string,\r\n    options: { maxMessages?: number; event?: string } = {}\r\n): UseChannelReturn<T> {\r\n    const { maxMessages = 100, event } = options;\r\n    const messages = ref<RealtimeMessage<T>[]>([]) as Ref<RealtimeMessage<T>[]>;\r\n    const channel = realtime.channel<T>(channelName);\r\n\r\n    const handleMessage = (msg: RealtimeMessage<T>) => {\r\n        messages.value = [...messages.value, msg].slice(-maxMessages);\r\n    };\r\n\r\n    const unsubscribe = event\r\n        ? channel.on(event, handleMessage)\r\n        : channel.subscribe(handleMessage);\r\n\r\n    onUnmounted(() => {\r\n        unsubscribe();\r\n        channel.leave();\r\n    });\r\n\r\n    function send(data: T, eventType = 'message') {\r\n        channel.send(data, eventType);\r\n    }\r\n\r\n    function clear() {\r\n        messages.value = [];\r\n    }\r\n\r\n    return { messages, send, clear };\r\n}\r\n\r\nexport default { useRealtime, useChannel };\r\n"]}

package/dist/index.d.ts

@@ -0,0 +1,168 @@
+/**
+ * @flightdev/realtime - Agnostic Real-time Communication
+ *
+ * Flight provides real-time primitives, you choose the transport.
+ *
+ * @example
+ * ```typescript
+ * import { createRealtime } from '@flightdev/realtime';
+ * import { websocket } from '@flightdev/realtime/websocket';
+ *
+ * const realtime = createRealtime(websocket({ port: 3001 }));
+ *
+ * // Create a channel
+ * const chat = realtime.channel('chat');
+ *
+ * // Broadcast a message
+ * chat.broadcast({ message: 'Hello!' });
+ *
+ * // Subscribe to messages
+ * chat.subscribe((message) => console.log(message));
+ * ```
+ */
+/** Real-time message payload */
+interface RealtimeMessage<T = unknown> {
+    /** Unique message ID */
+    id: string;
+    /** Channel name */
+    channel: string;
+    /** Event type */
+    event: string;
+    /** Message payload */
+    data: T;
+    /** Timestamp */
+    timestamp: number;
+    /** Sender ID (optional) */
+    senderId?: string;
+}
+/** Connection state */
+type ConnectionState = 'connecting' | 'connected' | 'disconnected' | 'reconnecting';
+/** Subscription callback */
+type SubscriptionCallback<T = unknown> = (message: RealtimeMessage<T>) => void;
+/** Unsubscribe function */
+type Unsubscribe = () => void;
+/** Channel options */
+interface ChannelOptions {
+    /** Require authentication */
+    auth?: boolean;
+    /** Private channel (single user) */
+    private?: boolean;
+    /** Presence tracking */
+    presence?: boolean;
+}
+/** Presence info */
+interface PresenceInfo<T = unknown> {
+    /** User ID */
+    userId: string;
+    /** User info */
+    info: T;
+    /** Joined at timestamp */
+    joinedAt: number;
+}
+/** Real-time channel */
+interface RealtimeChannel<T = unknown> {
+    /** Channel name */
+    readonly name: string;
+    /** Subscribe to all messages on this channel */
+    subscribe(callback: SubscriptionCallback<T>): Unsubscribe;
+    /** Subscribe to a specific event */
+    on(event: string, callback: SubscriptionCallback<T>): Unsubscribe;
+    /** Broadcast a message to all subscribers */
+    broadcast(data: T, event?: string): void;
+    /** Send a message (alias for broadcast) */
+    send(data: T, event?: string): void;
+    /** Leave the channel */
+    leave(): void;
+    /** Get presence information (if enabled) */
+    getPresence?(): Promise<PresenceInfo[]>;
+    /** Track user presence */
+    trackPresence?(info: unknown): void;
+}
+/**
+ * Real-time Adapter Interface
+ *
+ * Implement this to create a custom transport.
+ * Flight provides WebSocket and SSE adapters.
+ */
+interface RealtimeAdapter {
+    /** Adapter name */
+    readonly name: string;
+    /** Current connection state */
+    readonly state: ConnectionState;
+    /** Connect to the server */
+    connect(): Promise<void>;
+    /** Disconnect from the server */
+    disconnect(): void;
+    /** Join a channel */
+    channel<T = unknown>(name: string, options?: ChannelOptions): RealtimeChannel<T>;
+    /** Subscribe to connection state changes */
+    onStateChange(callback: (state: ConnectionState) => void): Unsubscribe;
+    /** Subscribe to errors */
+    onError(callback: (error: Error) => void): Unsubscribe;
+    /** Send a raw message */
+    send(channel: string, event: string, data: unknown): void;
+    /** Handle incoming message (for server-side) */
+    handleMessage?(handler: (message: RealtimeMessage) => void): void;
+}
+/** Adapter factory type */
+type RealtimeAdapterFactory<TConfig = unknown> = (config?: TConfig) => RealtimeAdapter;
+/** Real-time service options */
+interface RealtimeServiceOptions {
+    /** Auto-connect on creation */
+    autoConnect?: boolean;
+    /** Reconnect on disconnect */
+    reconnect?: boolean;
+    /** Maximum reconnect attempts */
+    maxReconnectAttempts?: number;
+    /** Reconnect delay in ms */
+    reconnectDelay?: number;
+}
+/** Real-time service */
+interface RealtimeService {
+    /** The underlying adapter */
+    readonly adapter: RealtimeAdapter;
+    /** Current connection state */
+    readonly state: ConnectionState;
+    /** Connect to the server */
+    connect(): Promise<void>;
+    /** Disconnect from the server */
+    disconnect(): void;
+    /** Get or create a channel */
+    channel<T = unknown>(name: string, options?: ChannelOptions): RealtimeChannel<T>;
+    /** Subscribe to connection state changes */
+    onStateChange(callback: (state: ConnectionState) => void): Unsubscribe;
+    /** Subscribe to errors */
+    onError(callback: (error: Error) => void): Unsubscribe;
+}
+/**
+ * Create a real-time service
+ *
+ * @example
+ * ```typescript
+ * import { createRealtime } from '@flightdev/realtime';
+ * import { websocket } from '@flightdev/realtime/websocket';
+ *
+ * const realtime = createRealtime(websocket({ port: 3001 }));
+ *
+ * await realtime.connect();
+ *
+ * const chat = realtime.channel('chat');
+ * chat.on('message', (msg) => console.log(msg));
+ * chat.send({ text: 'Hello!' }, 'message');
+ * ```
+ */
+declare function createRealtime(adapter: RealtimeAdapter, options?: RealtimeServiceOptions): RealtimeService;
+/**
+ * Create a message object
+ */
+declare function createMessage<T>(channel: string, event: string, data: T, senderId?: string): RealtimeMessage<T>;
+/**
+ * Parse a message from JSON string
+ */
+declare function parseMessage(json: string): RealtimeMessage | null;
+/**
+ * Serialize a message to JSON string
+ */
+declare function serializeMessage(message: RealtimeMessage): string;
+
+export { type ChannelOptions, type ConnectionState, type PresenceInfo, type RealtimeAdapter, type RealtimeAdapterFactory, type RealtimeChannel, type RealtimeMessage, type RealtimeService, type RealtimeServiceOptions, type SubscriptionCallback, type Unsubscribe, createMessage, createRealtime, parseMessage, serializeMessage };

package/dist/index.js

@@ -0,0 +1,3 @@
+export { createMessage, createRealtime, parseMessage, serializeMessage } from './chunk-D6OMTDYP.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@flightdev/realtime",
+  "version": "0.0.2",
+  "description": "Agnostic real-time communication for Flight Framework. Choose your transport: WebSocket, SSE, Pusher, or custom.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./websocket": {
+      "types": "./dist/adapters/websocket.d.ts",
+      "import": "./dist/adapters/websocket.js"
+    },
+    "./sse": {
+      "types": "./dist/adapters/sse.d.ts",
+      "import": "./dist/adapters/sse.js"
+    },
+    "./react": {
+      "types": "./dist/frameworks/react.d.ts",
+      "import": "./dist/frameworks/react.js"
+    },
+    "./vue": {
+      "types": "./dist/frameworks/vue.d.ts",
+      "import": "./dist/frameworks/vue.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "vue": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^2.0.0"
+  },
+  "keywords": [
+    "flight",
+    "realtime",
+    "websocket",
+    "sse",
+    "pubsub"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}