@as-integrations/h3 1.2.0 → 2.0.0

package/README.md

@@ -90,10 +90,8 @@ Then you can add a WebSocket handler to your `h3` app using the `defineGraphqlWe
 ```js
 import { createApp } from 'h3'
 import { ApolloServer } from '@apollo/server'
-import {
-  startServerAndCreateH3Handler,
-  defineGraphqlWebSocketHandler,
-} from '@as-integrations/h3'
+import { startServerAndCreateH3Handler } from '@as-integrations/h3'
+import { defineGraphqlWebSocketHandler } from '@as-integrations/h3/websocket'
 import { makeExecutableSchema } from '@graphql-tools/schema'
 
 // Define your schema and resolvers

package/dist/index.cjs

@@ -1,7 +1,71 @@
-module.exports = require("/home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3/node_modules/.pnpm/jiti@1.21.0/node_modules/jiti/lib/index.js")(null, {
-  "esmResolve": true,
-  "interopDefault": true,
-  "alias": {
-    "@as-integrations/h3": "/home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3"
+'use strict';
+
+const server = require('@apollo/server');
+const h3 = require('h3');
+
+function startServerAndCreateH3Handler(server, options) {
+  server.startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests();
+  const defaultContext = () => Promise.resolve({});
+  const contextFunction = options?.context ?? defaultContext;
+  return h3.eventHandler({
+    async handler(event) {
+      if (h3.isMethod(event, "OPTIONS")) {
+        return null;
+      }
+      try {
+        const graphqlRequest = await toGraphqlRequest(event);
+        const { body, headers, status } = await server.executeHTTPGraphQLRequest({
+          httpGraphQLRequest: graphqlRequest,
+          context: () => contextFunction({ event })
+        });
+        if (body.kind === "chunked") {
+          throw new Error("Incremental delivery not implemented");
+        }
+        h3.setHeaders(event, Object.fromEntries(headers));
+        event.res.statusCode = status || 200;
+        return body.string;
+      } catch (error) {
+        if (error instanceof SyntaxError) {
+          event.res.statusCode = 400;
+          return error.message;
+        } else {
+          throw error;
+        }
+      }
+    },
+    websocket: options?.websocket
+  });
+}
+async function toGraphqlRequest(event) {
+  return {
+    method: event.req.method || "POST",
+    headers: normalizeHeaders(h3.getHeaders(event)),
+    search: normalizeQueryString(event.req.url),
+    body: await normalizeBody(event)
+  };
+}
+function normalizeHeaders(headers) {
+  const headerMap = new server.HeaderMap();
+  for (const [key, value] of Object.entries(headers)) {
+    if (Array.isArray(value)) {
+      headerMap.set(key, value.join(","));
+    } else if (value) {
+      headerMap.set(key, value);
+    }
   }
-})("/home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3/src/index.ts")
+  return headerMap;
+}
+function normalizeQueryString(url) {
+  if (!url) {
+    return "";
+  }
+  return url.split("?")[1] || "";
+}
+async function normalizeBody(event) {
+  const PayloadMethods = ["PATCH", "POST", "PUT", "DELETE"];
+  if (h3.isMethod(event, PayloadMethods)) {
+    return await h3.readBody(event);
+  }
+}
+
+exports.startServerAndCreateH3Handler = startServerAndCreateH3Handler;

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+import { BaseContext, ContextFunction, ApolloServer } from '@apollo/server';
+import { Hooks } from 'crossws';
+import { H3Event, EventHandler } from 'h3';
+import { WithRequired } from '@apollo/utils.withrequired';
+
+interface H3ContextFunctionArgument {
+    event: H3Event;
+}
+interface H3HandlerOptions<TContext extends BaseContext> {
+    context?: ContextFunction<[H3ContextFunctionArgument], TContext>;
+    websocket?: Partial<Hooks>;
+}
+declare function startServerAndCreateH3Handler(server: ApolloServer<BaseContext>, options?: H3HandlerOptions<BaseContext>): EventHandler;
+declare function startServerAndCreateH3Handler<TContext extends BaseContext>(server: ApolloServer<TContext>, options: WithRequired<H3HandlerOptions<TContext>, 'context'>): EventHandler;
+
+export { type H3ContextFunctionArgument, type H3HandlerOptions, startServerAndCreateH3Handler };

package/dist/index.d.mts

@@ -0,0 +1,16 @@
+import { BaseContext, ContextFunction, ApolloServer } from '@apollo/server';
+import { Hooks } from 'crossws';
+import { H3Event, EventHandler } from 'h3';
+import { WithRequired } from '@apollo/utils.withrequired';
+
+interface H3ContextFunctionArgument {
+    event: H3Event;
+}
+interface H3HandlerOptions<TContext extends BaseContext> {
+    context?: ContextFunction<[H3ContextFunctionArgument], TContext>;
+    websocket?: Partial<Hooks>;
+}
+declare function startServerAndCreateH3Handler(server: ApolloServer<BaseContext>, options?: H3HandlerOptions<BaseContext>): EventHandler;
+declare function startServerAndCreateH3Handler<TContext extends BaseContext>(server: ApolloServer<TContext>, options: WithRequired<H3HandlerOptions<TContext>, 'context'>): EventHandler;
+
+export { type H3ContextFunctionArgument, type H3HandlerOptions, startServerAndCreateH3Handler };

package/dist/index.d.ts

@@ -1 +1,16 @@
-export * from "/home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3/src/index";
+import { BaseContext, ContextFunction, ApolloServer } from '@apollo/server';
+import { Hooks } from 'crossws';
+import { H3Event, EventHandler } from 'h3';
+import { WithRequired } from '@apollo/utils.withrequired';
+
+interface H3ContextFunctionArgument {
+    event: H3Event;
+}
+interface H3HandlerOptions<TContext extends BaseContext> {
+    context?: ContextFunction<[H3ContextFunctionArgument], TContext>;
+    websocket?: Partial<Hooks>;
+}
+declare function startServerAndCreateH3Handler(server: ApolloServer<BaseContext>, options?: H3HandlerOptions<BaseContext>): EventHandler;
+declare function startServerAndCreateH3Handler<TContext extends BaseContext>(server: ApolloServer<TContext>, options: WithRequired<H3HandlerOptions<TContext>, 'context'>): EventHandler;
+
+export { type H3ContextFunctionArgument, type H3HandlerOptions, startServerAndCreateH3Handler };

package/dist/index.mjs

@@ -1,14 +1,69 @@
-import jiti from "file:///home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3/node_modules/.pnpm/jiti@1.21.0/node_modules/jiti/lib/index.js";
+import { HeaderMap } from '@apollo/server';
+import { eventHandler, isMethod, setHeaders, getHeaders, readBody } from 'h3';
 
-/** @type {import("/home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3/src/index")} */
-const _module = jiti(null, {
-  "esmResolve": true,
-  "interopDefault": true,
-  "alias": {
-    "@as-integrations/h3": "/home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3"
+function startServerAndCreateH3Handler(server, options) {
+  server.startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests();
+  const defaultContext = () => Promise.resolve({});
+  const contextFunction = options?.context ?? defaultContext;
+  return eventHandler({
+    async handler(event) {
+      if (isMethod(event, "OPTIONS")) {
+        return null;
+      }
+      try {
+        const graphqlRequest = await toGraphqlRequest(event);
+        const { body, headers, status } = await server.executeHTTPGraphQLRequest({
+          httpGraphQLRequest: graphqlRequest,
+          context: () => contextFunction({ event })
+        });
+        if (body.kind === "chunked") {
+          throw new Error("Incremental delivery not implemented");
+        }
+        setHeaders(event, Object.fromEntries(headers));
+        event.res.statusCode = status || 200;
+        return body.string;
+      } catch (error) {
+        if (error instanceof SyntaxError) {
+          event.res.statusCode = 400;
+          return error.message;
+        } else {
+          throw error;
+        }
+      }
+    },
+    websocket: options?.websocket
+  });
+}
+async function toGraphqlRequest(event) {
+  return {
+    method: event.req.method || "POST",
+    headers: normalizeHeaders(getHeaders(event)),
+    search: normalizeQueryString(event.req.url),
+    body: await normalizeBody(event)
+  };
+}
+function normalizeHeaders(headers) {
+  const headerMap = new HeaderMap();
+  for (const [key, value] of Object.entries(headers)) {
+    if (Array.isArray(value)) {
+      headerMap.set(key, value.join(","));
+    } else if (value) {
+      headerMap.set(key, value);
+    }
   }
-})("/home/runner/work/apollo-server-integration-h3/apollo-server-integration-h3/src/index.ts");
+  return headerMap;
+}
+function normalizeQueryString(url) {
+  if (!url) {
+    return "";
+  }
+  return url.split("?")[1] || "";
+}
+async function normalizeBody(event) {
+  const PayloadMethods = ["PATCH", "POST", "PUT", "DELETE"];
+  if (isMethod(event, PayloadMethods)) {
+    return await readBody(event);
+  }
+}
 
-export const startServerAndCreateH3Handler = _module.startServerAndCreateH3Handler;
-export const defineGraphqlWebSocket = _module.defineGraphqlWebSocket;
-export const defineGraphqlWebSocketHandler = _module.defineGraphqlWebSocketHandler;
+export { startServerAndCreateH3Handler };

package/dist/websocket.cjs

@@ -0,0 +1,62 @@
+'use strict';
+
+const graphqlWs = require('graphql-ws');
+const h3 = require('h3');
+
+function defineGraphqlWebSocket(options) {
+  const server = graphqlWs.makeServer(options);
+  const peers = /* @__PURE__ */ new WeakMap();
+  return h3.defineWebSocket({
+    open(peer) {
+      const client = {
+        handleMessage: () => {
+          throw new Error("Message received before handler was registered");
+        },
+        closed: () => {
+          throw new Error("Closed before handler was registered");
+        }
+      };
+      client.closed = server.opened(
+        {
+          protocol: peer.request.headers?.get("Sec-WebSocket-Protocol") ?? "",
+          send: (message) => {
+            if (peers.has(peer)) {
+              peer.send(message);
+            }
+          },
+          close: (code, reason) => {
+            if (peers.has(peer)) {
+              peer.close(code, reason);
+            }
+          },
+          onMessage: (cb) => client.handleMessage = cb
+        },
+        { peer }
+      );
+      peers.set(peer, client);
+    },
+    message(peer, message) {
+      const client = peers.get(peer);
+      if (!client) throw new Error("Message received for a missing client");
+      return client.handleMessage(message.text());
+    },
+    close(peer, details) {
+      const client = peers.get(peer);
+      if (!client) throw new Error("Closing a missing client");
+      const upgradeProtocol = peer.request.headers?.get(
+        "Sec-WebSocket-Protocol"
+      );
+      if (details.code === graphqlWs.CloseCode.SubprotocolNotAcceptable && upgradeProtocol === graphqlWs.DEPRECATED_GRAPHQL_WS_PROTOCOL)
+        console.warn(
+          `Client provided the unsupported and deprecated subprotocol "${upgradeProtocol}" used by subscriptions-transport-ws.Please see https://www.apollographql.com/docs/apollo-server/data/subscriptions/#switching-from-subscriptions-transport-ws.`
+        );
+      return client.closed(details.code, details.reason);
+    }
+  });
+}
+async function defineGraphqlWebSocketHandler(options) {
+  return h3.defineWebSocketHandler(defineGraphqlWebSocket(options));
+}
+
+exports.defineGraphqlWebSocket = defineGraphqlWebSocket;
+exports.defineGraphqlWebSocketHandler = defineGraphqlWebSocketHandler;

package/dist/websocket.d.cts

@@ -0,0 +1,30 @@
+import { ConnectionInitMessage, ServerOptions } from 'graphql-ws';
+import { EventHandler, EventHandlerRequest } from 'h3';
+import { Peer, Hooks } from 'crossws';
+
+/**
+ * The extra that will be put in the `Context`.
+ *
+ * @category Server/h3
+ */
+interface Extra {
+    /**
+     * The underlying WebSocket peer.
+     */
+    readonly peer: Peer;
+}
+/**
+ * Create the WebSocket hooks to be used with [h3](https://h3.unjs.io/).
+ *
+ * Use this over {@link defineGraphqlWebSocketHandler} if you need more control over the WebSocket server or
+ * if you want to add custom hooks (e.g. for authentication or logging).
+ */
+declare function defineGraphqlWebSocket<P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'], E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>>(options: ServerOptions<P, Extra & Partial<E>>): Partial<Hooks>;
+/**
+ * Create a event handler to be used with [h3](https://h3.unjs.io/).
+ *
+ * @category Server/h3
+ */
+declare function defineGraphqlWebSocketHandler<P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'], E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>>(options: ServerOptions<P, Extra & Partial<E>>): Promise<EventHandler<EventHandlerRequest, never>>;
+
+export { type Extra, defineGraphqlWebSocket, defineGraphqlWebSocketHandler };

package/dist/websocket.d.mts

@@ -0,0 +1,30 @@
+import { ConnectionInitMessage, ServerOptions } from 'graphql-ws';
+import { EventHandler, EventHandlerRequest } from 'h3';
+import { Peer, Hooks } from 'crossws';
+
+/**
+ * The extra that will be put in the `Context`.
+ *
+ * @category Server/h3
+ */
+interface Extra {
+    /**
+     * The underlying WebSocket peer.
+     */
+    readonly peer: Peer;
+}
+/**
+ * Create the WebSocket hooks to be used with [h3](https://h3.unjs.io/).
+ *
+ * Use this over {@link defineGraphqlWebSocketHandler} if you need more control over the WebSocket server or
+ * if you want to add custom hooks (e.g. for authentication or logging).
+ */
+declare function defineGraphqlWebSocket<P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'], E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>>(options: ServerOptions<P, Extra & Partial<E>>): Partial<Hooks>;
+/**
+ * Create a event handler to be used with [h3](https://h3.unjs.io/).
+ *
+ * @category Server/h3
+ */
+declare function defineGraphqlWebSocketHandler<P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'], E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>>(options: ServerOptions<P, Extra & Partial<E>>): Promise<EventHandler<EventHandlerRequest, never>>;
+
+export { type Extra, defineGraphqlWebSocket, defineGraphqlWebSocketHandler };

package/dist/websocket.d.ts

@@ -0,0 +1,30 @@
+import { ConnectionInitMessage, ServerOptions } from 'graphql-ws';
+import { EventHandler, EventHandlerRequest } from 'h3';
+import { Peer, Hooks } from 'crossws';
+
+/**
+ * The extra that will be put in the `Context`.
+ *
+ * @category Server/h3
+ */
+interface Extra {
+    /**
+     * The underlying WebSocket peer.
+     */
+    readonly peer: Peer;
+}
+/**
+ * Create the WebSocket hooks to be used with [h3](https://h3.unjs.io/).
+ *
+ * Use this over {@link defineGraphqlWebSocketHandler} if you need more control over the WebSocket server or
+ * if you want to add custom hooks (e.g. for authentication or logging).
+ */
+declare function defineGraphqlWebSocket<P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'], E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>>(options: ServerOptions<P, Extra & Partial<E>>): Partial<Hooks>;
+/**
+ * Create a event handler to be used with [h3](https://h3.unjs.io/).
+ *
+ * @category Server/h3
+ */
+declare function defineGraphqlWebSocketHandler<P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'], E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>>(options: ServerOptions<P, Extra & Partial<E>>): Promise<EventHandler<EventHandlerRequest, never>>;
+
+export { type Extra, defineGraphqlWebSocket, defineGraphqlWebSocketHandler };

package/dist/websocket.mjs

@@ -0,0 +1,59 @@
+import { makeServer, CloseCode, DEPRECATED_GRAPHQL_WS_PROTOCOL } from 'graphql-ws';
+import { defineWebSocket, defineWebSocketHandler } from 'h3';
+
+function defineGraphqlWebSocket(options) {
+  const server = makeServer(options);
+  const peers = /* @__PURE__ */ new WeakMap();
+  return defineWebSocket({
+    open(peer) {
+      const client = {
+        handleMessage: () => {
+          throw new Error("Message received before handler was registered");
+        },
+        closed: () => {
+          throw new Error("Closed before handler was registered");
+        }
+      };
+      client.closed = server.opened(
+        {
+          protocol: peer.request.headers?.get("Sec-WebSocket-Protocol") ?? "",
+          send: (message) => {
+            if (peers.has(peer)) {
+              peer.send(message);
+            }
+          },
+          close: (code, reason) => {
+            if (peers.has(peer)) {
+              peer.close(code, reason);
+            }
+          },
+          onMessage: (cb) => client.handleMessage = cb
+        },
+        { peer }
+      );
+      peers.set(peer, client);
+    },
+    message(peer, message) {
+      const client = peers.get(peer);
+      if (!client) throw new Error("Message received for a missing client");
+      return client.handleMessage(message.text());
+    },
+    close(peer, details) {
+      const client = peers.get(peer);
+      if (!client) throw new Error("Closing a missing client");
+      const upgradeProtocol = peer.request.headers?.get(
+        "Sec-WebSocket-Protocol"
+      );
+      if (details.code === CloseCode.SubprotocolNotAcceptable && upgradeProtocol === DEPRECATED_GRAPHQL_WS_PROTOCOL)
+        console.warn(
+          `Client provided the unsupported and deprecated subprotocol "${upgradeProtocol}" used by subscriptions-transport-ws.Please see https://www.apollographql.com/docs/apollo-server/data/subscriptions/#switching-from-subscriptions-transport-ws.`
+        );
+      return client.closed(details.code, details.reason);
+    }
+  });
+}
+async function defineGraphqlWebSocketHandler(options) {
+  return defineWebSocketHandler(defineGraphqlWebSocket(options));
+}
+
+export { defineGraphqlWebSocket, defineGraphqlWebSocketHandler };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@as-integrations/h3",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "An Apollo Server integration for use with h3 or Nuxt",
   "repository": "github:apollo-server-integrations/apollo-server-integration-h3",
   "license": "MIT",
@@ -11,6 +11,11 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
+    },
+    "./websocket": {
+      "types": "./dist/websocket.d.ts",
+      "import": "./dist/websocket.mjs",
+      "require": "./dist/websocket.cjs"
     }
   },
   "main": "./dist/index.cjs",
@@ -23,44 +28,47 @@
     "@apollo/server": "^4.1.1",
     "h3": "^1.11.0",
     "graphql": "^16.0.0",
-    "graphql-ws": "^5.0.0",
-    "crossws": "^0.2.4"
+    "graphql-ws": "^5.0.0 || ^6.0.0",
+    "crossws": "^0.3.0"
   },
   "peerDependenciesMeta": {
     "graphql-ws": {
       "optional": true
     }
   },
+  "dependencies": {
+    "@apollo/utils.withrequired": "^3.0.0"
+  },
   "devDependencies": {
-    "@apollo/server": "^4.10.4",
-    "@apollo/server-integration-testsuite": "^4.10.4",
-    "@apollo/utils.withrequired": "^3.0.0",
-    "@graphql-tools/schema": "^10.0.3",
-    "@jest/globals": "^29.7.0",
-    "@typescript-eslint/parser": "^7.16.0",
-    "crossws": "^0.2.4",
-    "@vitest/coverage-v8": "^2.0.1",
-    "eslint": "^9.6.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-unjs": "^0.3.2",
-    "eslint-plugin-unused-imports": "^4.0.0",
-    "graphql": "^16.9.0",
-    "graphql-subscriptions": "^2.0.0",
-    "graphql-ws": "^5.15.0",
-    "h3": "^1.12.0",
-    "jest": "^29.7.0",
-    "listhen": "^1.7.2",
-    "prettier": "^3.3.2",
-    "standard-version": "^9.5.0",
-    "ts-jest": "^29.2.0",
-    "typescript": "^5.5.3",
-    "unbuild": "^2.0.0",
-    "vitest": "^2.0.1"
+    "@apollo/server": "4.11.3",
+    "@apollo/server-integration-testsuite": "4.11.3",
+    "@graphql-tools/schema": "10.0.21",
+    "@jest/globals": "29.7.0",
+    "@typescript-eslint/parser": "8.26.0",
+    "crossws": "0.3.4",
+    "@vitest/coverage-v8": "3.0.7",
+    "eslint": "9.21.0",
+    "eslint-config-prettier": "10.0.2",
+    "eslint-config-unjs": "0.4.2",
+    "eslint-plugin-unused-imports": "4.1.4",
+    "graphql": "16.10.0",
+    "graphql-subscriptions": "3.0.0",
+    "graphql-ws": "6.0.4",
+    "h3": "1.15.1",
+    "jest": "29.7.0",
+    "listhen": "1.9.0",
+    "prettier": "3.5.3",
+    "commit-and-tag-version": "12.5.0",
+    "ts-jest": "29.2.6",
+    "typescript": "5.8.2",
+    "unbuild": "3.5.0",
+    "vitest": "3.0.7"
   },
   "engines": {
-    "node": "^16.10.0 || >=18.0.0"
+    "node": "23.9.0"
   },
   "scripts": {
+    "dev:prepare": "unbuild --stub",
     "build": "unbuild",
     "test": "vitest dev",
     "test:integration": "jest",