@effect-gql/node 0.1.0

package/dist/serve.js

@@ -0,0 +1,176 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serve = void 0;
+const effect_1 = require("effect");
+const platform_1 = require("@effect/platform");
+const platform_node_1 = require("@effect/platform-node");
+const node_http_1 = require("node:http");
+const http_utils_1 = require("./http-utils");
+/**
+ * Start a Node.js HTTP server with the given router.
+ *
+ * This is the main entry point for running a GraphQL server on Node.js.
+ * It handles all the Effect runtime setup and server lifecycle.
+ *
+ * @param router - The HttpRouter to serve (typically from makeGraphQLRouter or toRouter)
+ * @param layer - Layer providing the router's service dependencies
+ * @param options - Server configuration options
+ *
+ * @example
+ * ```typescript
+ * import { makeGraphQLRouter } from "@effect-gql/core"
+ * import { serve } from "@effect-gql/node"
+ *
+ * const schema = GraphQLSchemaBuilder.empty
+ *   .query("hello", { type: S.String, resolve: () => Effect.succeed("world") })
+ *   .buildSchema()
+ *
+ * const router = makeGraphQLRouter(schema, Layer.empty, { graphiql: true })
+ *
+ * // Without subscriptions
+ * serve(router, serviceLayer, {
+ *   port: 4000,
+ *   onStart: (url) => console.log(`Server running at ${url}`)
+ * })
+ *
+ * // With subscriptions
+ * serve(router, serviceLayer, {
+ *   port: 4000,
+ *   subscriptions: { schema },
+ *   onStart: (url) => console.log(`Server running at ${url}`)
+ * })
+ * ```
+ */
+const serve = (router, layer, options = {}) => {
+    const { port = 4000, host = "0.0.0.0", onStart, subscriptions } = options;
+    if (subscriptions) {
+        // With WebSocket subscriptions - we need to manage the HTTP server ourselves
+        serveWithSubscriptions(router, layer, port, host, subscriptions, onStart);
+    }
+    else {
+        // Without subscriptions - use the standard Effect approach
+        const app = router.pipe(effect_1.Effect.catchAllCause((cause) => effect_1.Effect.die(cause)), platform_1.HttpServer.serve());
+        const serverLayer = platform_node_1.NodeHttpServer.layer(() => (0, node_http_1.createServer)(), { port });
+        const fullLayer = effect_1.Layer.merge(serverLayer, layer);
+        if (onStart) {
+            onStart(`http://${host === "0.0.0.0" ? "localhost" : host}:${port}`);
+        }
+        platform_node_1.NodeRuntime.runMain(effect_1.Layer.launch(effect_1.Layer.provide(app, fullLayer)));
+    }
+};
+exports.serve = serve;
+/**
+ * Internal implementation for serving with WebSocket subscriptions.
+ * Uses a custom HTTP server setup to enable WebSocket upgrade handling.
+ */
+function serveWithSubscriptions(router, layer, port, host, subscriptions, onStart) {
+    // Dynamically import ws module to keep it optional
+    const importWs = effect_1.Effect.tryPromise({
+        try: () => Promise.resolve().then(() => __importStar(require("./ws"))),
+        catch: (error) => error,
+    });
+    effect_1.Effect.runPromise(importWs.pipe(effect_1.Effect.catchAll((error) => effect_1.Effect.logError("Failed to load WebSocket support", error).pipe(effect_1.Effect.andThen(effect_1.Effect.logError("Make sure 'ws' package is installed: npm install ws")), effect_1.Effect.andThen(effect_1.Effect.sync(() => process.exit(1))), effect_1.Effect.andThen(effect_1.Effect.fail(error)))))).then(({ createGraphQLWSServer }) => {
+        // Create the web handler from the Effect router
+        const { handler } = platform_1.HttpApp.toWebHandlerLayer(router, layer);
+        // Create the HTTP server
+        const httpServer = (0, node_http_1.createServer)(async (req, res) => {
+            try {
+                // Collect request body
+                const chunks = [];
+                for await (const chunk of req) {
+                    chunks.push(chunk);
+                }
+                const body = Buffer.concat(chunks).toString();
+                // Convert Node.js request to web standard Request
+                // Use URL constructor for safe URL parsing (avoids injection via req.url)
+                const baseUrl = `http://${host === "0.0.0.0" ? "localhost" : host}:${port}`;
+                const url = new URL(req.url || "/", baseUrl).href;
+                const headers = (0, http_utils_1.toWebHeaders)(req.headers);
+                const webRequest = new Request(url, {
+                    method: req.method,
+                    headers,
+                    body: ["GET", "HEAD"].includes(req.method) ? undefined : body,
+                });
+                // Process through Effect handler
+                const webResponse = await handler(webRequest);
+                // Write response
+                res.statusCode = webResponse.status;
+                webResponse.headers.forEach((value, key) => {
+                    res.setHeader(key, value);
+                });
+                const responseBody = await webResponse.text();
+                res.end(responseBody);
+            }
+            catch (error) {
+                res.statusCode = 500;
+                res.end(JSON.stringify({ error: String(error) }));
+            }
+        });
+        // Create WebSocket server for subscriptions
+        const { handleUpgrade, close: closeWS } = createGraphQLWSServer(subscriptions.schema, layer, {
+            path: subscriptions.path,
+            complexity: subscriptions.complexity,
+            fieldComplexities: subscriptions.fieldComplexities,
+            onConnect: subscriptions.onConnect,
+            onDisconnect: subscriptions.onDisconnect,
+            onSubscribe: subscriptions.onSubscribe,
+            onComplete: subscriptions.onComplete,
+            onError: subscriptions.onError,
+        });
+        // Attach WebSocket upgrade handler
+        httpServer.on("upgrade", (request, socket, head) => {
+            handleUpgrade(request, socket, head);
+        });
+        // Handle shutdown
+        process.on("SIGINT", async () => {
+            await closeWS();
+            httpServer.close();
+            process.exit(0);
+        });
+        process.on("SIGTERM", async () => {
+            await closeWS();
+            httpServer.close();
+            process.exit(0);
+        });
+        // Start listening
+        httpServer.listen(port, host, () => {
+            if (onStart) {
+                onStart(`http://${host === "0.0.0.0" ? "localhost" : host}:${port}`);
+            }
+        });
+    });
+}
+//# sourceMappingURL=serve.js.map

package/dist/serve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.js","sourceRoot":"","sources":["../src/serve.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAsC;AACtC,+CAAkE;AAClE,yDAAmE;AACnE,yCAAwC;AAGxC,6CAA2C;AAoC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACI,MAAM,KAAK,GAAG,CACnB,MAAmC,EACnC,KAAyB,EACzB,UAA2B,EAAE,EACvB,EAAE;IACR,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,OAAO,CAAA;IAEzE,IAAI,aAAa,EAAE,CAAC;QAClB,6EAA6E;QAC7E,sBAAsB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;IAC3E,CAAC;SAAM,CAAC;QACN,2DAA2D;QAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CACrB,eAAM,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAClD,qBAAU,CAAC,KAAK,EAAE,CACnB,CAAA;QAED,MAAM,WAAW,GAAG,8BAAc,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAA,wBAAY,GAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;QACxE,MAAM,SAAS,GAAG,cAAK,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAEjD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,UAAU,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAA;QACtE,CAAC;QAED,2BAAW,CAAC,OAAO,CAAC,cAAK,CAAC,MAAM,CAAC,cAAK,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IAClE,CAAC;AACH,CAAC,CAAA;AA1BY,QAAA,KAAK,SA0BjB;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAC7B,MAAmC,EACnC,KAAyB,EACzB,IAAY,EACZ,IAAY,EACZ,aAAqC,EACrC,OAA+B;IAE/B,mDAAmD;IACnD,MAAM,QAAQ,GAAG,eAAM,CAAC,UAAU,CAAC;QACjC,GAAG,EAAE,GAAG,EAAE,mDAAQ,MAAM,GAAC;QACzB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAc;KACjC,CAAC,CAAA;IAEF,eAAM,CAAC,UAAU,CACf,QAAQ,CAAC,IAAI,CACX,eAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,eAAM,CAAC,QAAQ,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC,IAAI,CAC7D,eAAM,CAAC,OAAO,CAAC,eAAM,CAAC,QAAQ,CAAC,qDAAqD,CAAC,CAAC,EACtF,eAAM,CAAC,OAAO,CAAC,eAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAClD,eAAM,CAAC,OAAO,CAAC,eAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CACnC,CACF,CACF,CACF,CAAC,IAAI,CAAC,CAAC,EAAE,qBAAqB,EAAE,EAAE,EAAE;QACnC,gDAAgD;QAChD,MAAM,EAAE,OAAO,EAAE,GAAG,kBAAO,CAAC,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QAE5D,yBAAyB;QACzB,MAAM,UAAU,GAAG,IAAA,wBAAY,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;YACjD,IAAI,CAAC;gBACH,uBAAuB;gBACvB,MAAM,MAAM,GAAa,EAAE,CAAA;gBAC3B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC,CAAA;gBAC9B,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAA;gBAE7C,kDAAkD;gBAClD,0EAA0E;gBAC1E,MAAM,OAAO,GAAG,UAAU,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAA;gBAC3E,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAA;gBACjD,MAAM,OAAO,GAAG,IAAA,yBAAY,EAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBAEzC,MAAM,UAAU,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE;oBAClC,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,OAAO;oBACP,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;iBAC/D,CAAC,CAAA;gBAEF,iCAAiC;gBACjC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAA;gBAE7C,iBAAiB;gBACjB,GAAG,CAAC,UAAU,GAAG,WAAW,CAAC,MAAM,CAAA;gBACnC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACzC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;gBAC3B,CAAC,CAAC,CAAA;gBACF,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;gBAC7C,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;YACvB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,GAAG,CAAC,UAAU,GAAG,GAAG,CAAA;gBACpB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;YACnD,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,4CAA4C;QAC5C,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAC7D,aAAa,CAAC,MAAM,EACpB,KAAuB,EACvB;YACE,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,UAAU,EAAE,aAAa,CAAC,UAAU;YACpC,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;YAClD,SAAS,EAAE,aAAa,CAAC,SAAS;YAClC,YAAY,EAAE,aAAa,CAAC,YAAY;YACxC,WAAW,EAAE,aAAa,CAAC,WAAW;YACtC,UAAU,EAAE,aAAa,CAAC,UAAU;YACpC,OAAO,EAAE,aAAa,CAAC,OAAO;SAC/B,CACF,CAAA;QAED,mCAAmC;QACnC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YACjD,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QACtC,CAAC,CAAC,CAAA;QAEF,kBAAkB;QAClB,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,OAAO,EAAE,CAAA;YACf,UAAU,CAAC,KAAK,EAAE,CAAA;YAClB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;QAEF,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YAC/B,MAAM,OAAO,EAAE,CAAA;YACf,UAAU,CAAC,KAAK,EAAE,CAAA;YAClB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;QAEF,kBAAkB;QAClB,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE;YACjC,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,UAAU,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAA;YACtE,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/sse.d.ts

@@ -0,0 +1,86 @@
+import { Layer } from "effect";
+import type { IncomingMessage, ServerResponse } from "node:http";
+import { GraphQLSchema } from "graphql";
+import { type GraphQLSSEOptions } from "@effect-gql/core";
+/**
+ * Options for Node.js SSE handler
+ */
+export interface NodeSSEOptions<R> extends GraphQLSSEOptions<R> {
+    /**
+     * Path for SSE connections.
+     * @default "/graphql/stream"
+     */
+    readonly path?: string;
+}
+/**
+ * Create an SSE handler for Node.js HTTP server.
+ *
+ * This function creates a handler that can process SSE subscription requests.
+ * It handles:
+ * - Parsing the GraphQL subscription request from the HTTP body
+ * - Setting up the SSE connection with proper headers
+ * - Streaming subscription events to the client
+ * - Detecting client disconnection and cleaning up
+ *
+ * @param schema - The GraphQL schema with subscription definitions
+ * @param layer - Effect layer providing services required by resolvers
+ * @param options - Optional lifecycle hooks and configuration
+ * @returns A request handler function
+ *
+ * @example
+ * ```typescript
+ * import { createServer } from "node:http"
+ * import { createSSEHandler } from "@effect-gql/node"
+ *
+ * const sseHandler = createSSEHandler(schema, serviceLayer, {
+ *   path: "/graphql/stream",
+ *   onConnect: (request, headers) => Effect.gen(function* () {
+ *     const user = yield* AuthService.validateToken(headers.get("authorization"))
+ *     return { user }
+ *   }),
+ * })
+ *
+ * const server = createServer((req, res) => {
+ *   const url = new URL(req.url, `http://${req.headers.host}`)
+ *   if (url.pathname === "/graphql/stream" && req.method === "POST") {
+ *     sseHandler(req, res)
+ *   } else {
+ *     // Handle other requests...
+ *   }
+ * })
+ *
+ * server.listen(4000)
+ * ```
+ */
+export declare const createSSEHandler: <R>(schema: GraphQLSchema, layer: Layer.Layer<R>, options?: NodeSSEOptions<R>) => ((req: IncomingMessage, res: ServerResponse) => Promise<void>);
+/**
+ * Create SSE middleware that can be used with the serve() function.
+ *
+ * This returns an object that can be used to integrate SSE subscriptions
+ * with the HTTP server when using the custom subscription mode.
+ *
+ * @param schema - The GraphQL schema with subscription definitions
+ * @param layer - Effect layer providing services required by resolvers
+ * @param options - Optional lifecycle hooks and configuration
+ *
+ * @example
+ * ```typescript
+ * // In serve.ts with custom HTTP server setup
+ * const sseServer = createSSEServer(schema, layer, { path: "/graphql/stream" })
+ *
+ * httpServer.on("request", (req, res) => {
+ *   if (sseServer.shouldHandle(req)) {
+ *     sseServer.handle(req, res)
+ *   }
+ * })
+ * ```
+ */
+export declare const createSSEServer: <R>(schema: GraphQLSchema, layer: Layer.Layer<R>, options?: NodeSSEOptions<R>) => {
+    /** Path this SSE server handles */
+    readonly path: string;
+    /** Check if a request should be handled by this SSE server */
+    shouldHandle: (req: IncomingMessage) => boolean;
+    /** Handle an SSE request */
+    handle: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+};
+//# sourceMappingURL=sse.d.ts.map

package/dist/sse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.d.ts","sourceRoot":"","sources":["../src/sse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,EAAoB,MAAM,QAAQ,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACvC,OAAO,EAIL,KAAK,iBAAiB,EAGvB,MAAM,kBAAkB,CAAA;AAGzB;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAC7D;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAChC,QAAQ,aAAa,EACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EACrB,UAAU,cAAc,CAAC,CAAC,CAAC,KAC1B,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAyG/D,CAAA;AAcD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,EAC/B,QAAQ,aAAa,EACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EACrB,UAAU,cAAc,CAAC,CAAC,CAAC,KAC1B;IACD,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,8DAA8D;IAC9D,YAAY,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAA;IAC/C,4BAA4B;IAC5B,MAAM,EAAE,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAcrE,CAAA"}

package/dist/sse.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSSEServer = exports.createSSEHandler = void 0;
+const effect_1 = require("effect");
+const core_1 = require("@effect-gql/core");
+const http_utils_1 = require("./http-utils");
+/**
+ * Create an SSE handler for Node.js HTTP server.
+ *
+ * This function creates a handler that can process SSE subscription requests.
+ * It handles:
+ * - Parsing the GraphQL subscription request from the HTTP body
+ * - Setting up the SSE connection with proper headers
+ * - Streaming subscription events to the client
+ * - Detecting client disconnection and cleaning up
+ *
+ * @param schema - The GraphQL schema with subscription definitions
+ * @param layer - Effect layer providing services required by resolvers
+ * @param options - Optional lifecycle hooks and configuration
+ * @returns A request handler function
+ *
+ * @example
+ * ```typescript
+ * import { createServer } from "node:http"
+ * import { createSSEHandler } from "@effect-gql/node"
+ *
+ * const sseHandler = createSSEHandler(schema, serviceLayer, {
+ *   path: "/graphql/stream",
+ *   onConnect: (request, headers) => Effect.gen(function* () {
+ *     const user = yield* AuthService.validateToken(headers.get("authorization"))
+ *     return { user }
+ *   }),
+ * })
+ *
+ * const server = createServer((req, res) => {
+ *   const url = new URL(req.url, `http://${req.headers.host}`)
+ *   if (url.pathname === "/graphql/stream" && req.method === "POST") {
+ *     sseHandler(req, res)
+ *   } else {
+ *     // Handle other requests...
+ *   }
+ * })
+ *
+ * server.listen(4000)
+ * ```
+ */
+const createSSEHandler = (schema, layer, options) => {
+    const sseHandler = (0, core_1.makeGraphQLSSEHandler)(schema, layer, options);
+    return async (req, res) => {
+        // Check Accept header for SSE support
+        const accept = req.headers.accept ?? "";
+        if (!accept.includes("text/event-stream") && !accept.includes("*/*")) {
+            res.statusCode = 406;
+            res.end(JSON.stringify({
+                errors: [{ message: "Client must accept text/event-stream" }],
+            }));
+            return;
+        }
+        // Read the request body
+        let body;
+        try {
+            body = await readBody(req);
+        }
+        catch {
+            res.statusCode = 400;
+            res.end(JSON.stringify({
+                errors: [{ message: "Failed to read request body" }],
+            }));
+            return;
+        }
+        // Parse the GraphQL request
+        let request;
+        try {
+            const parsed = JSON.parse(body);
+            if (typeof parsed.query !== "string") {
+                throw new Error("Missing query");
+            }
+            request = {
+                query: parsed.query,
+                variables: parsed.variables,
+                operationName: parsed.operationName,
+                extensions: parsed.extensions,
+            };
+        }
+        catch {
+            res.statusCode = 400;
+            res.end(JSON.stringify({
+                errors: [{ message: "Invalid GraphQL request body" }],
+            }));
+            return;
+        }
+        // Convert Node.js headers to web Headers
+        const headers = (0, http_utils_1.toWebHeaders)(req.headers);
+        // Set SSE headers
+        res.writeHead(200, core_1.SSE_HEADERS);
+        // Get the event stream
+        const eventStream = sseHandler(request, headers);
+        // Create the streaming effect
+        const streamEffect = effect_1.Effect.gen(function* () {
+            // Track client disconnection
+            const clientDisconnected = yield* effect_1.Deferred.make();
+            req.on("close", () => {
+                effect_1.Effect.runPromise(effect_1.Deferred.succeed(clientDisconnected, undefined)).catch(() => { });
+            });
+            req.on("error", (error) => {
+                effect_1.Effect.runPromise(effect_1.Deferred.fail(clientDisconnected, new core_1.SSEError({ cause: error }))).catch(() => { });
+            });
+            // Stream events to the client
+            const runStream = effect_1.Stream.runForEach(eventStream, (event) => effect_1.Effect.async((resume) => {
+                const message = (0, core_1.formatSSEMessage)(event);
+                res.write(message, (error) => {
+                    if (error) {
+                        resume(effect_1.Effect.fail(new core_1.SSEError({ cause: error })));
+                    }
+                    else {
+                        resume(effect_1.Effect.succeed(undefined));
+                    }
+                });
+            }));
+            // Race between stream completion and client disconnection
+            yield* effect_1.Effect.race(runStream.pipe(effect_1.Effect.catchAll((error) => effect_1.Effect.logWarning("SSE stream error", error))), effect_1.Deferred.await(clientDisconnected));
+        });
+        await effect_1.Effect.runPromise(streamEffect.pipe(effect_1.Effect.ensuring(effect_1.Effect.sync(() => res.end())), effect_1.Effect.catchAll(() => effect_1.Effect.void)));
+    };
+};
+exports.createSSEHandler = createSSEHandler;
+/**
+ * Read the request body as a string.
+ */
+function readBody(req) {
+    return new Promise((resolve, reject) => {
+        const chunks = [];
+        req.on("data", (chunk) => chunks.push(chunk));
+        req.on("end", () => resolve(Buffer.concat(chunks).toString()));
+        req.on("error", reject);
+    });
+}
+/**
+ * Create SSE middleware that can be used with the serve() function.
+ *
+ * This returns an object that can be used to integrate SSE subscriptions
+ * with the HTTP server when using the custom subscription mode.
+ *
+ * @param schema - The GraphQL schema with subscription definitions
+ * @param layer - Effect layer providing services required by resolvers
+ * @param options - Optional lifecycle hooks and configuration
+ *
+ * @example
+ * ```typescript
+ * // In serve.ts with custom HTTP server setup
+ * const sseServer = createSSEServer(schema, layer, { path: "/graphql/stream" })
+ *
+ * httpServer.on("request", (req, res) => {
+ *   if (sseServer.shouldHandle(req)) {
+ *     sseServer.handle(req, res)
+ *   }
+ * })
+ * ```
+ */
+const createSSEServer = (schema, layer, options) => {
+    const path = options?.path ?? "/graphql/stream";
+    const handler = (0, exports.createSSEHandler)(schema, layer, options);
+    return {
+        path,
+        shouldHandle: (req) => {
+            if (req.method !== "POST")
+                return false;
+            const url = new URL(req.url ?? "/", `http://${req.headers.host ?? "localhost"}`);
+            return url.pathname === path;
+        },
+        handle: handler,
+    };
+};
+exports.createSSEServer = createSSEServer;
+//# sourceMappingURL=sse.js.map

package/dist/sse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.js","sourceRoot":"","sources":["../src/sse.ts"],"names":[],"mappings":";;;AAAA,mCAAwD;AAGxD,2CAOyB;AACzB,6CAA2C;AAa3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACI,MAAM,gBAAgB,GAAG,CAC9B,MAAqB,EACrB,KAAqB,EACrB,OAA2B,EACqC,EAAE;IAClE,MAAM,UAAU,GAAG,IAAA,4BAAqB,EAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAEhE,OAAO,KAAK,EAAE,GAAoB,EAAE,GAAmB,EAAiB,EAAE;QACxE,sCAAsC;QACtC,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAA;QACvC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACrE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAA;YACpB,GAAG,CAAC,GAAG,CACL,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,sCAAsC,EAAE,CAAC;aAC9D,CAAC,CACH,CAAA;YACD,OAAM;QACR,CAAC;QAED,wBAAwB;QACxB,IAAI,IAAY,CAAA;QAChB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,UAAU,GAAG,GAAG,CAAA;YACpB,GAAG,CAAC,GAAG,CACL,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;aACrD,CAAC,CACH,CAAA;YACD,OAAM;QACR,CAAC;QAED,4BAA4B;QAC5B,IAAI,OAA+B,CAAA;QACnC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC/B,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;YAClC,CAAC;YACD,OAAO,GAAG;gBACR,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B,CAAA;QACH,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,UAAU,GAAG,GAAG,CAAA;YACpB,GAAG,CAAC,GAAG,CACL,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;aACtD,CAAC,CACH,CAAA;YACD,OAAM;QACR,CAAC;QAED,yCAAyC;QACzC,MAAM,OAAO,GAAG,IAAA,yBAAY,EAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAEzC,kBAAkB;QAClB,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,kBAAW,CAAC,CAAA;QAE/B,uBAAuB;QACvB,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAEhD,8BAA8B;QAC9B,MAAM,YAAY,GAAG,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACvC,6BAA6B;YAC7B,MAAM,kBAAkB,GAAG,KAAK,CAAC,CAAC,iBAAQ,CAAC,IAAI,EAAkB,CAAA;YAEjE,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACnB,eAAM,CAAC,UAAU,CAAC,iBAAQ,CAAC,OAAO,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;YACpF,CAAC,CAAC,CAAA;YAEF,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxB,eAAM,CAAC,UAAU,CAAC,iBAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,eAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CACxF,GAAG,EAAE,GAAE,CAAC,CACT,CAAA;YACH,CAAC,CAAC,CAAA;YAEF,8BAA8B;YAC9B,MAAM,SAAS,GAAG,eAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE,CACzD,eAAM,CAAC,KAAK,CAAiB,CAAC,MAAM,EAAE,EAAE;gBACtC,MAAM,OAAO,GAAG,IAAA,uBAAgB,EAAC,KAAK,CAAC,CAAA;gBACvC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC3B,IAAI,KAAK,EAAE,CAAC;wBACV,MAAM,CAAC,eAAM,CAAC,IAAI,CAAC,IAAI,eAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;oBACrD,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,eAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;oBACnC,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CACH,CAAA;YAED,0DAA0D;YAC1D,KAAK,CAAC,CAAC,eAAM,CAAC,IAAI,CAChB,SAAS,CAAC,IAAI,CAAC,eAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,CAAC,EACxF,iBAAQ,CAAC,KAAK,CAAC,kBAAkB,CAAC,CACnC,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,eAAM,CAAC,UAAU,CACrB,YAAY,CAAC,IAAI,CACf,eAAM,CAAC,QAAQ,CAAC,eAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAC7C,eAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,eAAM,CAAC,IAAI,CAAC,CACnC,CACF,CAAA;IACH,CAAC,CAAA;AACH,CAAC,CAAA;AA7GY,QAAA,gBAAgB,oBA6G5B;AAED;;GAEG;AACH,SAAS,QAAQ,CAAC,GAAoB;IACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QACrD,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QAC9D,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,MAAM,eAAe,GAAG,CAC7B,MAAqB,EACrB,KAAqB,EACrB,OAA2B,EAQ3B,EAAE;IACF,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,iBAAiB,CAAA;IAC/C,MAAM,OAAO,GAAG,IAAA,wBAAgB,EAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAExD,OAAO;QACL,IAAI;QACJ,YAAY,EAAE,CAAC,GAAoB,EAAE,EAAE;YACrC,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO,KAAK,CAAA;YACvC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,UAAU,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC,CAAA;YAChF,OAAO,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAA;QAC9B,CAAC;QACD,MAAM,EAAE,OAAO;KAChB,CAAA;AACH,CAAC,CAAA;AAxBY,QAAA,eAAe,mBAwB3B"}

package/dist/ws.d.ts

@@ -0,0 +1,97 @@
+import { Layer } from "effect";
+import type { IncomingMessage, Server } from "node:http";
+import type { Duplex } from "node:stream";
+import { WebSocket, WebSocketServer } from "ws";
+import { GraphQLSchema } from "graphql";
+import { type EffectWebSocket, type GraphQLWSOptions } from "@effect-gql/core";
+/**
+ * Options for Node.js WebSocket server
+ */
+export interface NodeWSOptions<R> extends GraphQLWSOptions<R> {
+    /**
+     * Path for WebSocket connections.
+     * @default "/graphql"
+     */
+    readonly path?: string;
+}
+/**
+ * Convert a Node.js WebSocket (from 'ws' library) to an EffectWebSocket.
+ *
+ * This creates an Effect-based wrapper around the ws WebSocket instance,
+ * providing a Stream for incoming messages and Effect-based send/close operations.
+ *
+ * @param ws - The WebSocket instance from the 'ws' library
+ * @returns An EffectWebSocket that can be used with makeGraphQLWSHandler
+ *
+ * @example
+ * ```typescript
+ * wss.on("connection", (ws, req) => {
+ *   const effectSocket = toEffectWebSocket(ws)
+ *   Effect.runPromise(handler(effectSocket))
+ * })
+ * ```
+ */
+export declare const toEffectWebSocket: (ws: WebSocket) => EffectWebSocket;
+/**
+ * Create a WebSocket server that handles GraphQL subscriptions.
+ *
+ * This function creates a WebSocketServer and returns utilities for
+ * integrating it with an HTTP server via the upgrade event.
+ *
+ * @param schema - The GraphQL schema with subscription definitions
+ * @param layer - Effect layer providing services required by resolvers
+ * @param options - Optional configuration and lifecycle hooks
+ * @returns Object containing the WebSocketServer and handlers
+ *
+ * @example
+ * ```typescript
+ * const httpServer = createServer(requestHandler)
+ * const { wss, handleUpgrade } = createGraphQLWSServer(schema, serviceLayer)
+ *
+ * httpServer.on("upgrade", (request, socket, head) => {
+ *   if (request.url === "/graphql") {
+ *     handleUpgrade(request, socket, head)
+ *   }
+ * })
+ *
+ * httpServer.listen(4000)
+ * ```
+ */
+export declare const createGraphQLWSServer: <R>(schema: GraphQLSchema, layer: Layer.Layer<R>, options?: NodeWSOptions<R>) => {
+    /** The underlying WebSocketServer instance */
+    wss: WebSocketServer;
+    /** Handle HTTP upgrade requests */
+    handleUpgrade: (request: IncomingMessage, socket: Duplex, head: Buffer) => void;
+    /** Close the WebSocket server */
+    close: () => Promise<void>;
+};
+/**
+ * Attach WebSocket subscription support to an existing HTTP server.
+ *
+ * This is a convenience function that creates a GraphQL WebSocket server
+ * and attaches it to an HTTP server's upgrade event.
+ *
+ * @param server - The HTTP server to attach to
+ * @param schema - The GraphQL schema with subscription definitions
+ * @param layer - Effect layer providing services required by resolvers
+ * @param options - Optional configuration and lifecycle hooks
+ * @returns Cleanup function to close the WebSocket server
+ *
+ * @example
+ * ```typescript
+ * const httpServer = createServer(requestHandler)
+ *
+ * const cleanup = attachWebSocketToServer(httpServer, schema, serviceLayer, {
+ *   path: "/graphql",
+ * })
+ *
+ * httpServer.listen(4000)
+ *
+ * // Later, to cleanup:
+ * await cleanup()
+ * ```
+ */
+export declare const attachWebSocketToServer: <R>(server: Server, schema: GraphQLSchema, layer: Layer.Layer<R>, options?: NodeWSOptions<R>) => {
+    close: () => Promise<void>;
+};
+//# sourceMappingURL=ws.d.ts.map

package/dist/ws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws.d.ts","sourceRoot":"","sources":["../src/ws.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,IAAI,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AACvC,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACtB,MAAM,kBAAkB,CAAA;AAEzB;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAC3D;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB,GAAI,IAAI,SAAS,KAAG,eAA8C,CAAA;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,EACrC,QAAQ,aAAa,EACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EACrB,UAAU,aAAa,CAAC,CAAC,CAAC,KACzB;IACD,8CAA8C;IAC9C,GAAG,EAAE,eAAe,CAAA;IACpB,mCAAmC;IACnC,aAAa,EAAE,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/E,iCAAiC;IACjC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAgE3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,uBAAuB,GAAI,CAAC,EACvC,QAAQ,MAAM,EACd,QAAQ,aAAa,EACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EACrB,UAAU,aAAa,CAAC,CAAC,CAAC,KACzB;IAAE,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAQ9B,CAAA"}