@sylphx/lens-pusher 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+/**
+* @sylphx/lens-pusher
+*
+* Pusher Channels integration for Lens real-time subscriptions.
+* For serverless deployments where WebSocket connections aren't persistent.
+*
+* Flow:
+* 1. Server uses HTTP adapter for requests
+* 2. Clients subscribe to Pusher channels directly (using pusher-js)
+* 3. Server publishes updates to Pusher (via pusher server SDK)
+*
+* @example
+* ```typescript
+* // Client-side (pusher-js)
+* import Pusher from 'pusher-js';
+* import { createPusherSubscription } from '@sylphx/lens-pusher';
+*
+* const pusher = new Pusher('your-key', { cluster: 'us2' });
+*
+* const unsubscribe = createPusherSubscription(pusher, 'entity:User:123', (data) => {
+*   console.log('User updated:', data);
+* });
+*
+* // Server-side (pusher)
+* import Pusher from 'pusher';
+* import { createPusherBroadcaster } from '@sylphx/lens-pusher';
+*
+* const pusher = new Pusher({
+*   appId: process.env.PUSHER_APP_ID,
+*   key: process.env.PUSHER_KEY,
+*   secret: process.env.PUSHER_SECRET,
+*   cluster: process.env.PUSHER_CLUSTER,
+* });
+*
+* const broadcast = createPusherBroadcaster(pusher);
+* await broadcast('entity:User:123', { id: '123', name: 'Updated' });
+* ```
+*/
+/**
+* Pusher transport configuration.
+*/
+interface PusherTransportOptions {
+	/** Pusher app ID */
+	appId: string;
+	/** Pusher key */
+	key: string;
+	/** Pusher secret */
+	secret: string;
+	/** Pusher cluster (e.g., 'us2', 'eu', 'ap1') */
+	cluster: string;
+	/** Use TLS (default: true) */
+	useTLS?: boolean;
+	/** Channel prefix (default: 'lens-') */
+	channelPrefix?: string;
+	/** Debug logging */
+	debug?: boolean;
+}
+/**
+* Pusher client interface (pusher-js).
+* Matches the pusher-js client API.
+*/
+interface PusherClientLike {
+	subscribe(channelName: string): {
+		bind(eventName: string, callback: (data: unknown) => void): void;
+		unbind(eventName: string, callback: (data: unknown) => void): void;
+	};
+	unsubscribe(channelName: string): void;
+}
+/**
+* Pusher server interface (pusher).
+* Matches the pusher server SDK API.
+*/
+interface PusherServerLike {
+	trigger(channel: string | string[], event: string, data: unknown): Promise<unknown>;
+}
+/**
+* Create a subscription to a Lens channel via Pusher (client-side).
+*
+* @param pusher - Pusher client instance (from pusher-js)
+* @param channel - Channel name (e.g., 'entity:User:123')
+* @param onMessage - Callback for incoming messages
+* @param channelPrefix - Channel prefix (default: 'lens-')
+* @returns Unsubscribe function
+*
+* @example
+* ```typescript
+* import Pusher from 'pusher-js';
+* import { createPusherSubscription } from '@sylphx/lens-pusher';
+*
+* const pusher = new Pusher('your-key', { cluster: 'us2' });
+*
+* const unsubscribe = createPusherSubscription(pusher, 'entity:User:123', (data) => {
+*   console.log('User updated:', data);
+* });
+* ```
+*/
+declare function createPusherSubscription(pusher: PusherClientLike, channel: string, onMessage: (data: unknown) => void, channelPrefix?: string): () => void;
+/**
+* Create a broadcaster for publishing Lens updates via Pusher (server-side).
+*
+* @param pusher - Pusher server instance (from pusher)
+* @param channelPrefix - Channel prefix (default: 'lens-')
+* @returns Broadcast function
+*
+* @example
+* ```typescript
+* import Pusher from 'pusher';
+* import { createPusherBroadcaster } from '@sylphx/lens-pusher';
+*
+* const pusher = new Pusher({
+*   appId: process.env.PUSHER_APP_ID,
+*   key: process.env.PUSHER_KEY,
+*   secret: process.env.PUSHER_SECRET,
+*   cluster: process.env.PUSHER_CLUSTER,
+* });
+*
+* const broadcast = createPusherBroadcaster(pusher);
+* await broadcast('entity:User:123', { id: '123', name: 'Updated' });
+* ```
+*/
+declare function createPusherBroadcaster(pusher: PusherServerLike, channelPrefix?: string): (channel: string, data: unknown) => Promise<void>;
+export { createPusherSubscription, createPusherBroadcaster, PusherTransportOptions, PusherServerLike, PusherClientLike as PusherLike, PusherClientLike };

package/dist/index.js

@@ -0,0 +1,20 @@
+// src/index.ts
+function createPusherSubscription(pusher, channel, onMessage, channelPrefix = "lens-") {
+  const pusherChannel = `${channelPrefix}${channel}`;
+  const subscription = pusher.subscribe(pusherChannel);
+  subscription.bind("update", onMessage);
+  return () => {
+    subscription.unbind("update", onMessage);
+    pusher.unsubscribe(pusherChannel);
+  };
+}
+function createPusherBroadcaster(pusher, channelPrefix = "lens-") {
+  return async (channel, data) => {
+    const pusherChannel = `${channelPrefix}${channel}`;
+    await pusher.trigger(pusherChannel, "update", data);
+  };
+}
+export {
+  createPusherSubscription,
+  createPusherBroadcaster
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+	"name": "@sylphx/lens-pusher",
+	"version": "1.0.0",
+	"description": "Pusher Channels integration for Lens real-time subscriptions",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
+	"scripts": {
+		"build": "bunup",
+		"typecheck": "tsc --noEmit",
+		"test": "echo 'no tests yet'",
+		"prepack": "[ -d dist ] || bun run build"
+	},
+	"files": [
+		"dist",
+		"src"
+	],
+	"keywords": [
+		"lens",
+		"pusher",
+		"realtime",
+		"serverless",
+		"websocket"
+	],
+	"author": "SylphxAI",
+	"license": "MIT",
+	"peerDependencies": {
+		"pusher": ">=5.0.0",
+		"pusher-js": ">=8.0.0"
+	},
+	"peerDependenciesMeta": {
+		"pusher": {
+			"optional": true
+		},
+		"pusher-js": {
+			"optional": true
+		}
+	},
+	"devDependencies": {
+		"pusher": "^5.2.0",
+		"pusher-js": "^8.4.0",
+		"typescript": "^5.9.3"
+	}
+}

package/src/index.ts

@@ -0,0 +1,152 @@
+/**
+ * @sylphx/lens-pusher
+ *
+ * Pusher Channels integration for Lens real-time subscriptions.
+ * For serverless deployments where WebSocket connections aren't persistent.
+ *
+ * Flow:
+ * 1. Server uses HTTP adapter for requests
+ * 2. Clients subscribe to Pusher channels directly (using pusher-js)
+ * 3. Server publishes updates to Pusher (via pusher server SDK)
+ *
+ * @example
+ * ```typescript
+ * // Client-side (pusher-js)
+ * import Pusher from 'pusher-js';
+ * import { createPusherSubscription } from '@sylphx/lens-pusher';
+ *
+ * const pusher = new Pusher('your-key', { cluster: 'us2' });
+ *
+ * const unsubscribe = createPusherSubscription(pusher, 'entity:User:123', (data) => {
+ *   console.log('User updated:', data);
+ * });
+ *
+ * // Server-side (pusher)
+ * import Pusher from 'pusher';
+ * import { createPusherBroadcaster } from '@sylphx/lens-pusher';
+ *
+ * const pusher = new Pusher({
+ *   appId: process.env.PUSHER_APP_ID,
+ *   key: process.env.PUSHER_KEY,
+ *   secret: process.env.PUSHER_SECRET,
+ *   cluster: process.env.PUSHER_CLUSTER,
+ * });
+ *
+ * const broadcast = createPusherBroadcaster(pusher);
+ * await broadcast('entity:User:123', { id: '123', name: 'Updated' });
+ * ```
+ */
+
+/**
+ * Pusher transport configuration.
+ */
+export interface PusherTransportOptions {
+	/** Pusher app ID */
+	appId: string;
+	/** Pusher key */
+	key: string;
+	/** Pusher secret */
+	secret: string;
+	/** Pusher cluster (e.g., 'us2', 'eu', 'ap1') */
+	cluster: string;
+	/** Use TLS (default: true) */
+	useTLS?: boolean;
+	/** Channel prefix (default: 'lens-') */
+	channelPrefix?: string;
+	/** Debug logging */
+	debug?: boolean;
+}
+
+/**
+ * Pusher client interface (pusher-js).
+ * Matches the pusher-js client API.
+ */
+export interface PusherClientLike {
+	subscribe(channelName: string): {
+		bind(eventName: string, callback: (data: unknown) => void): void;
+		unbind(eventName: string, callback: (data: unknown) => void): void;
+	};
+	unsubscribe(channelName: string): void;
+}
+
+/**
+ * Pusher server interface (pusher).
+ * Matches the pusher server SDK API.
+ */
+export interface PusherServerLike {
+	trigger(channel: string | string[], event: string, data: unknown): Promise<unknown>;
+}
+
+/**
+ * Create a subscription to a Lens channel via Pusher (client-side).
+ *
+ * @param pusher - Pusher client instance (from pusher-js)
+ * @param channel - Channel name (e.g., 'entity:User:123')
+ * @param onMessage - Callback for incoming messages
+ * @param channelPrefix - Channel prefix (default: 'lens-')
+ * @returns Unsubscribe function
+ *
+ * @example
+ * ```typescript
+ * import Pusher from 'pusher-js';
+ * import { createPusherSubscription } from '@sylphx/lens-pusher';
+ *
+ * const pusher = new Pusher('your-key', { cluster: 'us2' });
+ *
+ * const unsubscribe = createPusherSubscription(pusher, 'entity:User:123', (data) => {
+ *   console.log('User updated:', data);
+ * });
+ * ```
+ */
+export function createPusherSubscription(
+	pusher: PusherClientLike,
+	channel: string,
+	onMessage: (data: unknown) => void,
+	channelPrefix = "lens-",
+): () => void {
+	const pusherChannel = `${channelPrefix}${channel}`;
+	const subscription = pusher.subscribe(pusherChannel);
+
+	subscription.bind("update", onMessage);
+
+	return () => {
+		subscription.unbind("update", onMessage);
+		pusher.unsubscribe(pusherChannel);
+	};
+}
+
+/**
+ * Create a broadcaster for publishing Lens updates via Pusher (server-side).
+ *
+ * @param pusher - Pusher server instance (from pusher)
+ * @param channelPrefix - Channel prefix (default: 'lens-')
+ * @returns Broadcast function
+ *
+ * @example
+ * ```typescript
+ * import Pusher from 'pusher';
+ * import { createPusherBroadcaster } from '@sylphx/lens-pusher';
+ *
+ * const pusher = new Pusher({
+ *   appId: process.env.PUSHER_APP_ID,
+ *   key: process.env.PUSHER_KEY,
+ *   secret: process.env.PUSHER_SECRET,
+ *   cluster: process.env.PUSHER_CLUSTER,
+ * });
+ *
+ * const broadcast = createPusherBroadcaster(pusher);
+ * await broadcast('entity:User:123', { id: '123', name: 'Updated' });
+ * ```
+ */
+export function createPusherBroadcaster(
+	pusher: PusherServerLike,
+	channelPrefix = "lens-",
+): (channel: string, data: unknown) => Promise<void> {
+	return async (channel: string, data: unknown) => {
+		const pusherChannel = `${channelPrefix}${channel}`;
+		await pusher.trigger(pusherChannel, "update", data);
+	};
+}
+
+// Legacy export for backwards compatibility
+export type { PusherClientLike as PusherLike };