@blokjs/trigger-websocket 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,113 @@
+/**
+ * @blok/trigger-websocket
+ *
+ * WebSocket trigger for Blok workflows.
+ * Handle real-time bidirectional communication.
+ *
+ * Features:
+ * - Connection management (connect, disconnect, reconnect)
+ * - Room/channel support for broadcasting
+ * - Message routing to workflows
+ * - Heartbeat/ping-pong for connection health
+ * - Authentication middleware
+ * - Binary message support
+ *
+ * @example
+ * ```typescript
+ * import { WebSocketTrigger } from "@blok/trigger-websocket";
+ * import { WebSocketServer } from "ws";
+ *
+ * class MyWebSocketTrigger extends WebSocketTrigger {
+ *   protected nodes = myNodes;
+ *   protected workflows = myWorkflows;
+ * }
+ *
+ * const trigger = new MyWebSocketTrigger();
+ * await trigger.listen();
+ *
+ * // Create WebSocket server
+ * const wss = new WebSocketServer({ port: 8080 });
+ *
+ * wss.on("connection", async (ws, req) => {
+ *   const headers = req.headers as Record<string, string>;
+ *   const client = await trigger.handleConnection(
+ *     {
+ *       send: (data) => ws.send(data),
+ *       close: (code, reason) => ws.close(code, reason),
+ *       ping: () => ws.ping(),
+ *     },
+ *     req,
+ *     headers
+ *   );
+ *
+ *   if (!client) return;
+ *
+ *   ws.on("message", async (data, isBinary) => {
+ *     await trigger.handleMessage(client.id, data, isBinary);
+ *   });
+ *
+ *   ws.on("close", (code, reason) => {
+ *     trigger.handleClose(client.id, code, reason.toString());
+ *   });
+ *
+ *   ws.on("error", (error) => {
+ *     trigger.handleError(client.id, error);
+ *   });
+ *
+ *   ws.on("ping", () => trigger.handlePing(client.id));
+ *   ws.on("pong", () => trigger.handlePong(client.id));
+ * });
+ * ```
+ *
+ * Workflow Definition:
+ * ```typescript
+ * Workflow({ name: "chat-message", version: "1.0.0" })
+ *   .addTrigger("websocket", {
+ *     events: ["message", "chat.*"],
+ *     rooms: ["general", "support"],
+ *   })
+ *   .addStep({ ... });
+ * ```
+ *
+ * Authentication:
+ * ```typescript
+ * trigger.setAuthHandler(async (request, headers) => {
+ *   const token = headers["authorization"]?.replace("Bearer ", "");
+ *   if (!token) {
+ *     return { authenticated: false, error: "No token provided" };
+ *   }
+ *
+ *   const user = await verifyToken(token);
+ *   if (!user) {
+ *     return { authenticated: false, error: "Invalid token" };
+ *   }
+ *
+ *   return {
+ *     authenticated: true,
+ *     clientId: user.id,
+ *     metadata: { userId: user.id, role: user.role },
+ *   };
+ * });
+ * ```
+ *
+ * Room Management:
+ * ```typescript
+ * // Join a room
+ * await trigger.joinRoom(clientId, "room-name");
+ *
+ * // Leave a room
+ * await trigger.leaveRoom(clientId, "room-name");
+ *
+ * // Broadcast to room
+ * trigger.broadcastToRoom("room-name", "event", { message: "Hello!" });
+ *
+ * // Send to specific client
+ * trigger.sendToClient(clientId, "event", { message: "Private message" });
+ *
+ * // Broadcast to all
+ * trigger.broadcastToAll("event", { message: "System message" });
+ * ```
+ */
+export { WebSocketTrigger, type WebSocketMessage, type WebSocketMessageType, type WebSocketState, type WebSocketClient, type WebSocketRoom, type WebSocketEventType, type WebSocketEvent, type AuthResult, type AuthHandler, } from "./WebSocketTrigger";
+export type { WebSocketTriggerOpts } from "@blok/helper";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6GG;AAGH,OAAO,EACN,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,WAAW,GAChB,MAAM,oBAAoB,CAAC;AAG5B,YAAY,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,117 @@
+"use strict";
+/**
+ * @blok/trigger-websocket
+ *
+ * WebSocket trigger for Blok workflows.
+ * Handle real-time bidirectional communication.
+ *
+ * Features:
+ * - Connection management (connect, disconnect, reconnect)
+ * - Room/channel support for broadcasting
+ * - Message routing to workflows
+ * - Heartbeat/ping-pong for connection health
+ * - Authentication middleware
+ * - Binary message support
+ *
+ * @example
+ * ```typescript
+ * import { WebSocketTrigger } from "@blok/trigger-websocket";
+ * import { WebSocketServer } from "ws";
+ *
+ * class MyWebSocketTrigger extends WebSocketTrigger {
+ *   protected nodes = myNodes;
+ *   protected workflows = myWorkflows;
+ * }
+ *
+ * const trigger = new MyWebSocketTrigger();
+ * await trigger.listen();
+ *
+ * // Create WebSocket server
+ * const wss = new WebSocketServer({ port: 8080 });
+ *
+ * wss.on("connection", async (ws, req) => {
+ *   const headers = req.headers as Record<string, string>;
+ *   const client = await trigger.handleConnection(
+ *     {
+ *       send: (data) => ws.send(data),
+ *       close: (code, reason) => ws.close(code, reason),
+ *       ping: () => ws.ping(),
+ *     },
+ *     req,
+ *     headers
+ *   );
+ *
+ *   if (!client) return;
+ *
+ *   ws.on("message", async (data, isBinary) => {
+ *     await trigger.handleMessage(client.id, data, isBinary);
+ *   });
+ *
+ *   ws.on("close", (code, reason) => {
+ *     trigger.handleClose(client.id, code, reason.toString());
+ *   });
+ *
+ *   ws.on("error", (error) => {
+ *     trigger.handleError(client.id, error);
+ *   });
+ *
+ *   ws.on("ping", () => trigger.handlePing(client.id));
+ *   ws.on("pong", () => trigger.handlePong(client.id));
+ * });
+ * ```
+ *
+ * Workflow Definition:
+ * ```typescript
+ * Workflow({ name: "chat-message", version: "1.0.0" })
+ *   .addTrigger("websocket", {
+ *     events: ["message", "chat.*"],
+ *     rooms: ["general", "support"],
+ *   })
+ *   .addStep({ ... });
+ * ```
+ *
+ * Authentication:
+ * ```typescript
+ * trigger.setAuthHandler(async (request, headers) => {
+ *   const token = headers["authorization"]?.replace("Bearer ", "");
+ *   if (!token) {
+ *     return { authenticated: false, error: "No token provided" };
+ *   }
+ *
+ *   const user = await verifyToken(token);
+ *   if (!user) {
+ *     return { authenticated: false, error: "Invalid token" };
+ *   }
+ *
+ *   return {
+ *     authenticated: true,
+ *     clientId: user.id,
+ *     metadata: { userId: user.id, role: user.role },
+ *   };
+ * });
+ * ```
+ *
+ * Room Management:
+ * ```typescript
+ * // Join a room
+ * await trigger.joinRoom(clientId, "room-name");
+ *
+ * // Leave a room
+ * await trigger.leaveRoom(clientId, "room-name");
+ *
+ * // Broadcast to room
+ * trigger.broadcastToRoom("room-name", "event", { message: "Hello!" });
+ *
+ * // Send to specific client
+ * trigger.sendToClient(clientId, "event", { message: "Private message" });
+ *
+ * // Broadcast to all
+ * trigger.broadcastToAll("event", { message: "System message" });
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketTrigger = void 0;
+// Core exports
+var WebSocketTrigger_1 = require("./WebSocketTrigger");
+Object.defineProperty(exports, "WebSocketTrigger", { enumerable: true, get: function () { return WebSocketTrigger_1.WebSocketTrigger; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6GG;;;AAEH,eAAe;AACf,uDAW4B;AAV3B,oHAAA,gBAAgB,OAAA"}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@blokjs/trigger-websocket",
+	"version": "0.2.0",
+	"description": "WebSocket trigger for Blok workflows - real-time bidirectional communication",
+	"type": "module",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"scripts": {
+		"build": "rm -rf dist && bun run tsc",
+		"build:dev": "tsc --watch",
+		"test": "vitest run",
+		"test:dev": "vitest"
+	},
+	"author": "Deskree Technologies Inc.",
+	"license": "Apache-2.0",
+	"dependencies": {
+		"@blokjs/helper": "workspace:*",
+		"@blokjs/runner": "workspace:*",
+		"@blokjs/shared": "workspace:*",
+		"@opentelemetry/api": "^1.9.0",
+		"uuid": "^11.1.0"
+	},
+	"peerDependencies": {
+		"ws": "^8.19.0"
+	},
+	"peerDependenciesMeta": {
+		"ws": {
+			"optional": true
+		}
+	},
+	"devDependencies": {
+		"@types/node": "^22.15.21",
+		"@types/uuid": "^11.0.0",
+		"@types/ws": "^8.18.1",
+		"typescript": "^5.8.3",
+		"vitest": "^4.0.18",
+		"ws": "^8.19.0"
+	},
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	}
+}