effect-cf 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # effect-cf
 
+## 0.3.0
+
+### Minor Changes
+
+- [#10](https://github.com/danieljvdm/effect-cf/pull/10) [`a0e3f43`](https://github.com/danieljvdm/effect-cf/commit/a0e3f436df695b8ea3908fbb7813efea099ccd13) Thanks [@danieljvdm](https://github.com/danieljvdm)! - Type Durable Object websocket lifecycle handlers with `DurableWebSocket` instead of raw `WebSocket`, so handlers can use the Effect-native durable socket API without manually wrapping Cloudflare sockets.
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -144,7 +144,7 @@ Durable Object application sockets should use the hibernation-compatible state A
 
 ```ts
 import { Effect, Schema as S } from "effect";
-import { DurableObjectState, DurableObjectWebSocket, Worker } from "effect-cf";
+import { DurableObject, DurableObjectState, DurableObjectWebSocket, Worker } from "effect-cf";
 
 const ConnectionAttachment = S.Struct({
   id: S.String,
@@ -173,6 +173,17 @@ export const fetch = Effect.gen(function* () {
 
 `DurableWebSocket` keeps the native socket available as `socket.raw`, while `send`, `close`, `serializeAttachment`, and `deserializeAttachment` return typed `Effect` failures. Use `state.getWebSockets(tag)` to retrieve wrapped sockets for broadcast and rehydration.
 
+`DurableObject.make` lifecycle handlers receive wrapped sockets automatically:
+
+```ts
+export const RoomLive = DurableObject.make(layer, {
+  webSocketMessage: (socket, message) =>
+    Effect.gen(function* () {
+      yield* socket.send(message);
+    }),
+});
+```
+
 Schema-backed attachments can rehydrate hibernated sockets:
 
 ```ts

package/dist/index.d.mts

@@ -468,11 +468,11 @@ interface DurableWebSocketHandlers<R = never, E = unknown> {
   readonly close?: (socket: DurableWebSocket, code: number, reason: string, wasClean: boolean) => Effect.Effect<void, E, R>;
   readonly error?: (socket: DurableWebSocket, error: unknown) => Effect.Effect<void, E, R>;
 }
-/** Adapts wrapped websocket lifecycle handlers to `DurableObject.make` raw callbacks. */
+/** Maps compact websocket lifecycle handler names to `DurableObject.make` options. */
 declare const handlers: <R = never, E = unknown>(options: DurableWebSocketHandlers<R, E>) => {
-  webSocketMessage: ((socket: WebSocket, message: string | ArrayBuffer) => Effect.Effect<void, E, R>) | undefined;
-  webSocketClose: ((socket: WebSocket, code: number, reason: string, wasClean: boolean) => Effect.Effect<void, E, R>) | undefined;
-  webSocketError: ((socket: WebSocket, error: unknown) => Effect.Effect<void, E, R>) | undefined;
+  webSocketMessage: ((socket: DurableWebSocket, message: string | ArrayBuffer) => Effect.Effect<void, E, R>) | undefined;
+  webSocketClose: ((socket: DurableWebSocket, code: number, reason: string, wasClean: boolean) => Effect.Effect<void, E, R>) | undefined;
+  webSocketError: ((socket: DurableWebSocket, error: unknown) => Effect.Effect<void, E, R>) | undefined;
 };
 declare namespace DurableObjectState_d_exports {
   export { DurableObjectState, DurableObjectStateService, fromDurableObjectState };
@@ -1457,9 +1457,9 @@ interface DurableObjectOptions<ROut, Rpc extends DurableObjectRpc<ROut>> {
    */
   readonly alarms?: Effect.Effect<unknown, unknown, HandlerContext<ROut>>;
   readonly alarm?: (alarmInfo?: globalThis.AlarmInvocationInfo) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
-  readonly webSocketMessage?: (socket: WebSocket, message: string | ArrayBuffer) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
-  readonly webSocketClose?: (socket: WebSocket, code: number, reason: string, wasClean: boolean) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
-  readonly webSocketError?: (socket: WebSocket, error: unknown) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
+  readonly webSocketMessage?: (socket: DurableWebSocket, message: string | ArrayBuffer) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
+  readonly webSocketClose?: (socket: DurableWebSocket, code: number, reason: string, wasClean: boolean) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
+  readonly webSocketError?: (socket: DurableWebSocket, error: unknown) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
 }
 /**
  * Cloudflare `DurableObject` constructor produced by {@link make}.

package/dist/index.mjs

@@ -923,11 +923,11 @@ const attachment = (schema) => {
 		schema
 	};
 };
-/** Adapts wrapped websocket lifecycle handlers to `DurableObject.make` raw callbacks. */
+/** Maps compact websocket lifecycle handler names to `DurableObject.make` options. */
 const handlers = (options) => ({
-	webSocketMessage: options.message === void 0 ? void 0 : (socket, message) => options.message?.(fromWebSocket(socket), message) ?? Effect.void,
-	webSocketClose: options.close === void 0 ? void 0 : (socket, code, reason, wasClean) => options.close?.(fromWebSocket(socket), code, reason, wasClean) ?? Effect.void,
-	webSocketError: options.error === void 0 ? void 0 : (socket, error) => options.error?.(fromWebSocket(socket), error) ?? Effect.void
+	webSocketMessage: options.message,
+	webSocketClose: options.close,
+	webSocketError: options.error
 });
 //#endregion
 //#region src/DurableObjectState.ts
@@ -1230,13 +1230,13 @@ const make$4 = (layer, options = {}) => {
 			if (rawAlarm !== void 0) return this[RunSymbol](rawAlarm);
 		}
 		webSocketMessage(socket, message) {
-			if (options.webSocketMessage !== void 0) return this[RunSymbol](options.webSocketMessage(socket, message));
+			if (options.webSocketMessage !== void 0) return this[RunSymbol](options.webSocketMessage(fromWebSocket(socket), message));
 		}
 		webSocketClose(socket, code, reason, wasClean) {
-			if (options.webSocketClose !== void 0) return this[RunSymbol](options.webSocketClose(socket, code, reason, wasClean));
+			if (options.webSocketClose !== void 0) return this[RunSymbol](options.webSocketClose(fromWebSocket(socket), code, reason, wasClean));
 		}
 		webSocketError(socket, error) {
-			if (options.webSocketError !== void 0) return this[RunSymbol](options.webSocketError(socket, error));
+			if (options.webSocketError !== void 0) return this[RunSymbol](options.webSocketError(fromWebSocket(socket), error));
 		}
 	}
 	defineEntrypointRpcMethods("Durable Object", EffectDurableObject.prototype, options.rpc, reservedMethodNames, (self, effect) => self[RunSymbol](effect));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "effect-cf",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Effect-native primitives for Cloudflare Workers and bindings.",
   "license": "MIT",
   "repository": {

package/src/DurableObject.ts

@@ -4,6 +4,7 @@ import { Effect, Layer, ManagedRuntime, type Scope } from "effect";
 import { NativeRequest } from "./Worker";
 import { WorkerEnvironment, type WorkerEnv } from "./Environment";
 import { DurableObjectState, fromDurableObjectState } from "./DurableObjectState";
+import { fromWebSocket, type DurableWebSocket } from "./DurableObjectWebSocket";
 import * as DurableObjectDefinition from "./DurableObjectDefinition";
 import * as Entrypoint from "./internal/Entrypoint";
 
@@ -84,17 +85,17 @@ export interface DurableObjectOptions<ROut, Rpc extends DurableObjectRpc<ROut>>
     alarmInfo?: globalThis.AlarmInvocationInfo,
   ) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
   readonly webSocketMessage?: (
-    socket: WebSocket,
+    socket: DurableWebSocket,
     message: string | ArrayBuffer,
   ) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
   readonly webSocketClose?: (
-    socket: WebSocket,
+    socket: DurableWebSocket,
     code: number,
     reason: string,
     wasClean: boolean,
   ) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
   readonly webSocketError?: (
-    socket: WebSocket,
+    socket: DurableWebSocket,
     error: unknown,
   ) => Effect.Effect<void, unknown, HandlerContext<ROut>>;
 }
@@ -172,7 +173,7 @@ export const make = <
 
     webSocketMessage(socket: WebSocket, message: string | ArrayBuffer): Promise<void> | void {
       if (options.webSocketMessage !== undefined) {
-        return this[RunSymbol](options.webSocketMessage(socket, message));
+        return this[RunSymbol](options.webSocketMessage(fromWebSocket(socket), message));
       }
     }
 
@@ -183,13 +184,15 @@ export const make = <
       wasClean: boolean,
     ): Promise<void> | void {
       if (options.webSocketClose !== undefined) {
-        return this[RunSymbol](options.webSocketClose(socket, code, reason, wasClean));
+        return this[RunSymbol](
+          options.webSocketClose(fromWebSocket(socket), code, reason, wasClean),
+        );
       }
     }
 
     webSocketError(socket: WebSocket, error: unknown): Promise<void> | void {
       if (options.webSocketError !== undefined) {
-        return this[RunSymbol](options.webSocketError(socket, error));
+        return this[RunSymbol](options.webSocketError(fromWebSocket(socket), error));
       }
     }
   }

package/src/DurableObjectWebSocket.ts

@@ -251,21 +251,9 @@ export interface DurableWebSocketHandlers<R = never, E = unknown> {
   readonly error?: (socket: DurableWebSocket, error: unknown) => Effect.Effect<void, E, R>;
 }
 
-/** Adapts wrapped websocket lifecycle handlers to `DurableObject.make` raw callbacks. */
+/** Maps compact websocket lifecycle handler names to `DurableObject.make` options. */
 export const handlers = <R = never, E = unknown>(options: DurableWebSocketHandlers<R, E>) => ({
-  webSocketMessage:
-    options.message === undefined
-      ? undefined
-      : (socket: WebSocket, message: string | ArrayBuffer) =>
-          options.message?.(fromWebSocket(socket), message) ?? Effect.void,
-  webSocketClose:
-    options.close === undefined
-      ? undefined
-      : (socket: WebSocket, code: number, reason: string, wasClean: boolean) =>
-          options.close?.(fromWebSocket(socket), code, reason, wasClean) ?? Effect.void,
-  webSocketError:
-    options.error === undefined
-      ? undefined
-      : (socket: WebSocket, error: unknown) =>
-          options.error?.(fromWebSocket(socket), error) ?? Effect.void,
+  webSocketMessage: options.message,
+  webSocketClose: options.close,
+  webSocketError: options.error,
 });