@as-integrations/h3 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 - UnJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# Apollo Server integration for h3 and nuxt
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions][github-actions-src]][github-actions-href]
+[![Codecov][codecov-src]][codecov-href]
+
+This package allows you to easily integrate [Apollo Server](https://www.apollographql.com/docs/apollo-server/) with your [h3](https://github.com/unjs/h3) or [nuxt](v3.nuxtjs.org) application.
+
+## Installation
+
+```sh
+# npm
+npm install @apollo/server graphql @as-integrations/h3
+
+# yarn
+yarn install @apollo/server graphql @as-integrations/h3
+
+# pnpm
+pnpm install @apollo/server graphql @as-integrations/h3
+```
+
+## Usage with Nuxt v3
+
+Create a [Server API Route](https://v3.nuxtjs.org/guide/directory-structure/server#api-routes) that configures an instance of Apollo Server as described in the [documentation](https://www.apollographql.com/docs/apollo-server/getting-started#step-6-create-an-instance-of-apolloserver) and then exports it as the event handler:
+
+```js
+import { ApolloServer } from '@apollo/server'
+import { startServerAndCreateH3Handler } from '@as-integrations/h3'
+
+const apollo = new ApolloServer({
+  // Specify server options here
+})
+
+export default startServerAndCreateH3Handler(apollo, {
+  // Optional: Specify context
+  context: (event) => {...}
+})
+```
+
+## Usage with h3
+
+Create and configure an instance of Apollo Server as described in the [documentation](https://www.apollographql.com/docs/apollo-server/getting-started#step-6-create-an-instance-of-apolloserver) and then register it as a route handler in your `h3` application.
+
+```js
+import { createApp } from 'h3'
+import { ApolloServer } from '@apollo/server'
+import { startServerAndCreateH3Handler } from '@as-integrations/h3'
+
+const apollo = new ApolloServer({
+  // Specify server options here
+})
+
+const app = createApp()
+app.use(
+  '/api',
+  startServerAndCreateH3Handler(apollo, {
+    // Optional: Specify context
+    context: (event) => {...}
+  })
+)
+
+createServer(toNodeListener(app)).listen(process.env.PORT || 3000)
+```
+
+## 💻 Development
+
+- Clone this repository
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10).
+- Install dependencies using `pnpm install`.
+- Run tests using `pnpm test` and integration tests via `pnpm test:integration`.
+
+## License
+
+Made with 💛
+
+Published under [MIT License](./LICENSE).
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@as-integrations/h3?style=flat-square
+[npm-version-href]: https://npmjs.com/package/@as-integrations/h3
+[npm-downloads-src]: https://img.shields.io/npm/dm/@as-integrations/h3?style=flat-square
+[npm-downloads-href]: https://npmjs.com/package/@as-integrations/h3
+[github-actions-src]: https://img.shields.io/github/workflow/status/apollo-server-integrations/apollo-server-integration-h3/ci/main?style=flat-square
+[github-actions-href]: https://github.com/apollo-server-integrations/apollo-server-integration-h3/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/gh/apollo-server-integrations/apollo-server-integration-h3/main?style=flat-square
+[codecov-href]: https://codecov.io/gh/apollo-server-integrations/apollo-server-integration-h3

package/dist/index.cjs

@@ -0,0 +1,75 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const h3 = require('h3');
+
+function startServerAndCreateH3Handler(server, options) {
+  server.startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests();
+  const defaultContext = () => Promise.resolve({});
+  const contextFunction = options?.context ?? defaultContext;
+  return h3.eventHandler(async (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;
+      }
+    }
+  });
+}
+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 = /* @__PURE__ */ new Map();
+  for (const [key, value] of Object.entries(headers)) {
+    if (Array.isArray(value)) {
+      headerMap.set(key, value.join(","));
+    } else if (value) {
+      headerMap.set(key, value);
+    }
+  }
+  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)) {
+    const body = await h3.readRawBody(event);
+    const content = typeof body === "string" ? body : body.toString();
+    if (h3.getRequestHeader(event, "content-type") === "application/json") {
+      return JSON.parse(content);
+    } else {
+      return content;
+    }
+  }
+}
+
+exports.startServerAndCreateH3Handler = startServerAndCreateH3Handler;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { BaseContext, ContextFunction, ApolloServer } from '@apollo/server';
+import { H3Event, EventHandler } from 'h3';
+
+declare type WithRequired<T, K extends keyof T> = T & Required<Pick<T, K>>;
+interface H3ContextFunctionArgument {
+    event: H3Event;
+}
+interface H3HandlerOptions<TContext extends BaseContext> {
+    context?: ContextFunction<[H3ContextFunctionArgument], TContext>;
+}
+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 { H3ContextFunctionArgument, H3HandlerOptions, startServerAndCreateH3Handler };

package/dist/index.mjs

@@ -0,0 +1,71 @@
+import { eventHandler, isMethod, setHeaders, getHeaders, readRawBody, getRequestHeader } from 'h3';
+
+function startServerAndCreateH3Handler(server, options) {
+  server.startInBackgroundHandlingStartupErrorsByLoggingAndFailingAllRequests();
+  const defaultContext = () => Promise.resolve({});
+  const contextFunction = options?.context ?? defaultContext;
+  return eventHandler(async (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;
+      }
+    }
+  });
+}
+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 = /* @__PURE__ */ new Map();
+  for (const [key, value] of Object.entries(headers)) {
+    if (Array.isArray(value)) {
+      headerMap.set(key, value.join(","));
+    } else if (value) {
+      headerMap.set(key, value);
+    }
+  }
+  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)) {
+    const body = await readRawBody(event);
+    const content = typeof body === "string" ? body : body.toString();
+    if (getRequestHeader(event, "content-type") === "application/json") {
+      return JSON.parse(content);
+    } else {
+      return content;
+    }
+  }
+}
+
+export { startServerAndCreateH3Handler };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@as-integrations/h3",
+  "version": "1.0.0",
+  "description": "An Apollo Server integration for use with h3 or Nuxt",
+  "repository": "apollo-server-integrations/apollo-server-integration-h3",
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@apollo/server": "^4.0.0",
+    "h3": "^0.7.21"
+  },
+  "devDependencies": {
+    "@apollo/server": "^4.0.0",
+    "@apollo/server-integration-testsuite": "^4.0.0",
+    "@apollo/utils.withrequired": "^1.0.0",
+    "@jest/globals": "^29.2.0",
+    "@nuxtjs/eslint-config-typescript": "^11.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/parser": "^5.40.0",
+    "@vitest/coverage-c8": "^0.24.1",
+    "eslint": "^8.25.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-unused-imports": "^2.0.0",
+    "graphql": "^16.6.0",
+    "h3": "^0.7.21",
+    "jest": "^29.2.0",
+    "prettier": "^2.7.1",
+    "standard-version": "^9.5.0",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.8.4",
+    "unbuild": "^0.8.11",
+    "vitest": "^0.24.1"
+  },
+  "packageManager": "pnpm@7.13.4",
+  "scripts": {
+    "build": "unbuild",
+    "test": "vitest dev",
+    "test:integration": "jest",
+    "lint": "pnpm lint:eslint && pnpm lint:prettier",
+    "lint:eslint": "eslint --ext .ts,.js,.vue,.graphql --ignore-path .gitignore --report-unused-disable-directives .",
+    "lint:prettier": "prettier --check --ignore-path .gitignore .",
+    "release": "pnpm test && standard-version && git push --follow-tags && pnpm publish"
+  }
+}