@jaypie/fabric 0.2.0 → 0.2.2

package/dist/esm/websocket/fabricWebSocket.d.ts

@@ -0,0 +1,120 @@
+import type { BroadcastResult, SendResult, WebSocketContext, WebSocketEvent, WebSocketResponse } from "@jaypie/lambda";
+import type { InputFieldDefinition, Message, Service, ServiceContext, ServiceFunction } from "../types.js";
+/** Callback called when handler completes successfully */
+export type OnCompleteCallback = (response: unknown) => void | Promise<void>;
+/** Callback called for recoverable errors (via context.onError) */
+export type OnErrorCallback = (error: unknown) => void | Promise<void>;
+/** Callback called for fatal errors (thrown or via context.onFatal) */
+export type OnFatalCallback = (error: unknown) => void | Promise<void>;
+/** Callback for receiving messages from service during execution */
+export type OnMessageCallback = (message: Message) => void | Promise<void>;
+/** Callback for $connect event */
+export type OnConnectCallback = (context: WebSocketContext) => void | Promise<void>;
+/** Callback for $disconnect event */
+export type OnDisconnectCallback = (context: WebSocketContext) => void | Promise<void>;
+type LifecycleFunction = (...args: unknown[]) => void | Promise<void>;
+type ValidatorFunction = (...args: unknown[]) => unknown | Promise<unknown>;
+/**
+ * Extended service context for WebSocket handlers
+ */
+export interface WebSocketServiceContext extends ServiceContext {
+    /** Broadcast data to multiple connections */
+    broadcast: (connectionIds: string[], data: unknown) => Promise<BroadcastResult>;
+    /** The WebSocket connection ID */
+    connectionId: string;
+    /** The WebSocket API domain name */
+    domainName: string;
+    /** Query string parameters from $connect */
+    queryStringParameters: Record<string, string> | null;
+    /** The route key (e.g., "$connect", "$disconnect", "$default", or custom) */
+    routeKey: string;
+    /** Send data to the current connection */
+    send: (data: unknown) => Promise<SendResult>;
+    /** The WebSocket API stage */
+    stage: string;
+}
+/**
+ * Options for fabricWebSocket
+ */
+export interface FabricWebSocketOptions {
+    /** Chaos testing mode */
+    chaos?: string;
+    /** Override the service name for logging (defaults to service.alias) */
+    name?: string;
+    /** Callback for $connect events */
+    onConnect?: OnConnectCallback;
+    /** Callback called when handler completes successfully */
+    onComplete?: OnCompleteCallback;
+    /** Callback for $disconnect events */
+    onDisconnect?: OnDisconnectCallback;
+    /** Callback for recoverable errors (via context.onError) */
+    onError?: OnErrorCallback;
+    /** Callback for fatal errors (thrown or via context.onFatal) */
+    onFatal?: OnFatalCallback;
+    /** Callback for receiving messages from service during execution */
+    onMessage?: OnMessageCallback;
+    /** AWS secrets to load into process.env */
+    secrets?: string[];
+    /** Functions to run before handler */
+    setup?: LifecycleFunction[];
+    /** Functions to run after handler (always runs) */
+    teardown?: LifecycleFunction[];
+    /** Re-throw errors instead of returning error response */
+    throw?: boolean;
+    /** Return 503 Unavailable immediately */
+    unavailable?: boolean;
+    /** Validation functions to run before handler */
+    validate?: ValidatorFunction[];
+}
+/**
+ * Configuration for fabricWebSocket
+ */
+export interface FabricWebSocketConfig extends FabricWebSocketOptions {
+    /** Service alias (used as name for logging if `name` not provided) */
+    alias?: string;
+    /** Service description */
+    description?: string;
+    /** Input field definitions */
+    input?: Record<string, InputFieldDefinition>;
+    /** The service - either a pre-instantiated Service or an inline function */
+    service: Service | ServiceFunction<Record<string, unknown>, unknown>;
+}
+/**
+ * The returned WebSocket Lambda handler function
+ */
+export type FabricWebSocketResult = (event: WebSocketEvent, context?: {
+    awsRequestId?: string;
+    [key: string]: unknown;
+}, ...args: unknown[]) => Promise<WebSocketResponse>;
+/**
+ * Fabric a WebSocket Lambda handler that wraps a service.
+ *
+ * This function creates a WebSocket-compatible Lambda handler that:
+ * - Parses the WebSocket body as service input
+ * - Provides WebSocket context (connectionId, send, broadcast) to the service
+ * - Handles $connect and $disconnect events with optional callbacks
+ * - Integrates with websocketHandler for lifecycle management
+ *
+ * @example
+ * ```typescript
+ * import { fabricWebSocket } from "@jaypie/fabric/websocket";
+ * import { myService } from "./services";
+ *
+ * // Direct service style
+ * export const handler = fabricWebSocket(myService);
+ *
+ * // Config object style with lifecycle hooks
+ * export const handler2 = fabricWebSocket({
+ *   service: myService,
+ *   secrets: ["MONGODB_URI"],
+ *   onConnect: async (context) => {
+ *     await storeConnection(context.connectionId);
+ *   },
+ *   onDisconnect: async (context) => {
+ *     await removeConnection(context.connectionId);
+ *   },
+ * });
+ * ```
+ */
+export declare function fabricWebSocket(serviceOrConfig: FabricWebSocketConfig | Service | ServiceFunction<Record<string, unknown>, unknown>, options?: FabricWebSocketOptions): FabricWebSocketResult;
+export {};

package/dist/esm/websocket/index.d.ts

@@ -0,0 +1,2 @@
+export { fabricWebSocket } from "./fabricWebSocket.js";
+export type { FabricWebSocketConfig, FabricWebSocketOptions, FabricWebSocketResult, OnCompleteCallback, OnConnectCallback, OnDisconnectCallback, OnErrorCallback, OnFatalCallback, OnMessageCallback, WebSocketServiceContext, } from "./fabricWebSocket.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaypie/fabric",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Jaypie modeling framework with type conversion, service handlers, and adapters",
   "repository": {
     "type": "git",
@@ -50,6 +50,11 @@
       "types": "./dist/esm/data/index.d.ts",
       "import": "./dist/esm/data/index.js",
       "require": "./dist/cjs/data/index.cjs"
+    },
+    "./websocket": {
+      "types": "./dist/esm/websocket/index.d.ts",
+      "import": "./dist/esm/websocket/index.js",
+      "require": "./dist/cjs/websocket/index.cjs"
     }
   },
   "main": "./dist/cjs/index.cjs",