@whatwg-node/server 0.5.9-alpha-20230130162825-1e02017 → 0.5.9

package/README.md

@@ -1,8 +1,10 @@
 # WHATWG Node Generic Server Adapter
 
-`@whatwg-node/server` helps you to create a generic server implementation by using WHATWG Fetch API for Node.js, AWS Lambda, Cloudflare Workers, Deno, Express, Fastify, Koa, Next.js and Sveltekit.
+`@whatwg-node/server` helps you to create a generic server implementation by using WHATWG Fetch API
+for Node.js, AWS Lambda, Cloudflare Workers, Deno, Express, Fastify, Koa, Next.js and Sveltekit.
 
-Once you create an adapter with `createServerAdapter`, you don't need to install any other platform specific package since the generic adapter will handle it automatically.
+Once you create an adapter with `createServerAdapter`, you don't need to install any other platform
+specific package since the generic adapter will handle it automatically.
 
 ## How to start
 
@@ -26,8 +28,8 @@ You can use your server adapter with the following integrations:
 [Node.js](https://nodejs.org/api/http.html) is the most popular server side JavaScript runtime.
 
 ```ts
-import myServerAdapter from './myServerAdapter'
 import { createServer } from 'http'
+import myServerAdapter from './myServerAdapter'
 
 // You can create your Node server instance by using our adapter
 const nodeServer = createServer(myServerAdapter)
@@ -37,21 +39,71 @@ nodeServer.listen(4000)
 
 ### AWS Lambda
 
-AWS Lambda is a serverless computing platform that makes it easy to build applications that run on the AWS cloud. Our adaoter is platform agnostic so they can fit together easily. In order to reduce the boilerplate we prefer to use [Serverless Express from Vendia](https://github.com/vendia/serverless-express).
+AWS Lambda is a serverless computing platform that makes it easy to build applications that run on
+the AWS cloud. Our adaoter is platform agnostic so they can fit together easily. In order to reduce
+the boilerplate we prefer to use
+[Serverless Express from Vendia](https://github.com/vendia/serverless-express).
 
 ```ts
-import myServerAdapter from './myServerAdapter'
+import { APIGatewayEvent, APIGatewayProxyResult, Context } from 'aws-lambda'
 import type { Handler } from '@aws-cdk/aws-lambda'
-import { configure } from '@vendia/serverless-express'
+import myServerAdapter from './myServerAdapter'
 
-export const handler: Handler = configure({
-  app: myServerAdapter
-})
+interface ServerContext {
+  event: APIGatewayEvent
+  lambdaContext: Context
+}
+
+export async function handler(
+  event: APIGatewayEvent,
+  lambdaContext: Context
+): Promise<APIGatewayProxyResult> {
+  const url = new URL(event.path, 'http://localhost')
+  if (event.queryStringParameters != null) {
+    for (const name in event.queryStringParameters) {
+      const value = event.queryStringParameters[name]
+      if (value != null) {
+        url.searchParams.set(name, value)
+      }
+    }
+  }
+
+  const response = await myServerAdapter.fetch(
+    url,
+    {
+      // For v1.0 you should use event.httpMethod
+      method: event.requestContext.http.method,
+      headers: event.headers as HeadersInit,
+      body: event.body
+        ? Buffer.from(event.body, event.isBase64Encoded ? 'base64' : 'utf8')
+        : undefined
+    },
+    {
+      event,
+      lambdaContext
+    }
+  )
+
+  const responseHeaders: Record<string, string> = {}
+
+  response.headers.forEach((value, name) => {
+    responseHeaders[name] = value
+  })
+
+  return {
+    statusCode: response.status,
+    headers: responseHeaders,
+    body: await response.text(),
+    isBase64Encoded: false
+  }
+}
 ```
 
 ### Cloudflare Workers
 
-Cloudflare Workers provides a serverless execution environment that allows you to create entirely new applications or augment existing ones without configuring or maintaining infrastructure. It uses Fetch API already so we can use our adapter as an event listener like below;
+Cloudflare Workers provides a serverless execution environment that allows you to create entirely
+new applications or augment existing ones without configuring or maintaining infrastructure. It uses
+Fetch API already so we can use our adapter as an event listener like below;
 
 ```ts
 import myServerAdapter from './myServerAdapter'
@@ -65,18 +117,20 @@ self.addEventListener('fetch', myServerAdapter)
 You can use our adapter as a Deno request handler like below;
 
 ```ts
-import { serve } from 'https://deno.land/std@0.117.0/http/server.ts'
+import { serve } from 'https://deno.land/std@0.157.0/http/server.ts'
 import myServerAdapter from './myServerAdapter'
 
 serve(myServerAdapter, {
-  // Listen any port you want
-  addr: ':4000'
+  onListen({ hostname, port }) {
+    console.log(`Listening on http://${hostname}:${port}/graphql`)
+  }
 })
 ```
 
 ### Express
 
-[Express is the most popular web framework for Node.js.](https://expressjs.com/) It is a minimalist framework that provides a robust set of features to handle HTTP on Node.js applications.
+[Express is the most popular web framework for Node.js.](https://expressjs.com/) It is a minimalist
+framework that provides a robust set of features to handle HTTP on Node.js applications.
 
 You can easily integrate your adapter into your Express application with a few lines of code.
 
@@ -96,14 +150,15 @@ app.listen(4000, () => {
 
 ### Fastify
 
-[Fastify is one of the popular HTTP server frameworks for Node.js.](https://www.fastify.io/). You can use your adapter easily with Fastify.
+[Fastify is one of the popular HTTP server frameworks for Node.js.](https://www.fastify.io/). You
+can use your adapter easily with Fastify.
 
 So you can benefit from the powerful plugins of Fastify ecosystem.
 [See the ecosystem](https://www.fastify.io/docs/latest/Guides/Ecosystem/)
 
 ```ts
+import fastify, { FastifyReply, FastifyRequest } from 'fastify'
 import myServerAdapter from './myServerAdapter'
-import fastify, { FastifyRequest, FastifyReply } from 'fastify'
 
 // This is the fastify instance you have created
 const app = fastify({ logger: true })
@@ -127,7 +182,8 @@ app.route({
 
     reply.status(response.status)
 
-    reply.send(response.body)
+    // Fastify doesn't accept `null` as a response body
+    reply.send(response.body || undefined)
 
     return reply
   }
@@ -138,7 +194,9 @@ app.listen(4000)
 
 ### Koa
 
-[Koa is another Node.js server framework designed by the team behind Express, which aims to be a smaller, more expressive.](https://koajs.com/) You can add your adapter to your Koa application with a few lines of code then [benefit middlewares written for Koa.](https://github.com/koajs/koa/wiki)
+[Koa is another Node.js server framework designed by the team behind Express, which aims to be a smaller, more expressive.](https://koajs.com/)
+You can add your adapter to your Koa application with a few lines of code then
+[benefit middlewares written for Koa.](https://github.com/koajs/koa/wiki)
 
 ```ts
 import Koa from 'koa'
@@ -167,13 +225,14 @@ app.listen(4000, () => {
 
 ### Next.js
 
-[Next.js](https://nextjs.org/) is a web framework that allows you to build websites very quickly and our new server adapter can be integrated with Next.js easily as an API Route.
+[Next.js](https://nextjs.org/) is a web framework that allows you to build websites very quickly and
+our new server adapter can be integrated with Next.js easily as an API Route.
 
 ```ts
 // pages/api/myEndpoint.ts
 // Next.js API route support: https://nextjs.org/docs/api-routes/introduction
-import myServerAdapter from './myServerAdapter'
 import type { NextApiRequest, NextApiResponse } from 'next'
+import myServerAdapter from './myServerAdapter'
 
 export const config = {
   api: {
@@ -187,7 +246,8 @@ export default myServerAdapter
 
 ### SvelteKit
 
-[SvelteKit](https://kit.svelte.dev/) is the fastest way to build svelte apps. It is very simple, and let you build frontend & backend in a single place
+[SvelteKit](https://kit.svelte.dev/) is the fastest way to build svelte apps. It is very simple, and
+let you build frontend & backend in a single place
 
 ```ts
 import myServerAdapter from './myServerAdapter'
@@ -197,8 +257,8 @@ export { myServerAdapter as get, myServerAdapter as post }
 
 ### Bun
 
-[Bun](https://bun.sh/) is a modern JavaScript runtime like Node or Deno, and it supports Fetch API as a first class citizen.
-So the configuration is really simple like any other JS runtime;
+[Bun](https://bun.sh/) is a modern JavaScript runtime like Node or Deno, and it supports Fetch API
+as a first class citizen. So the configuration is really simple like any other JS runtime;
 
 ```ts
 import myServerAdapter from './myServerAdapter'
@@ -212,9 +272,11 @@ console.info(`Server is running on ${server.hostname}`)
 
 ## File Uploads / Multipart Requests
 
-Multipart requests are a type of HTTP request that allows you to send blobs together with regular text data which has a mime-type `multipart/form-data`.
+Multipart requests are a type of HTTP request that allows you to send blobs together with regular
+text data which has a mime-type `multipart/form-data`.
 
-For example, if you send a multipart request from a browser with `FormData`, you can get the same `FormData` object in your request handler.
+For example, if you send a multipart request from a browser with `FormData`, you can get the same
+`FormData` object in your request handler.
 
 ```ts
 import { createServerAdapter } from '@whatwg-node/server'
@@ -238,15 +300,21 @@ const myServerAdapter = createServerAdapter(async request => {
 })
 ```
 
-You can learn more about [File API](https://developer.mozilla.org/en-US/docs/Web/API/File) on MDN documentation.
+You can learn more about [File API](https://developer.mozilla.org/en-US/docs/Web/API/File) on MDN
+documentation.
 
 ## Routing and Middlewares
 
-We'd recommend to use `@whatwg-node/router` to handle routing and middleware approach. It uses `@whatwg-node/server` under the hood.
+We'd recommend to use `@whatwg-node/router` to handle routing and middleware approach. It uses
+`@whatwg-node/server` under the hood.
+
+> Learn more about `@whatwg-node/router` [here](../router)
 
 ### Basic Routing
 
 ```ts
+// Then use it in any environment
+import { createServer } from 'http'
 import { createRouter, Router } from '@whatwg-node/router'
 
 const router = createRouter()
@@ -266,15 +334,14 @@ router.get('/google', () => Response.redirect('http://www.google.com'))
 // 404 for everything else
 router.all('*', () => new Response('Not Found.', { status: 404 }))
 
-// Then use it in any environment
-import { createServer } from 'http'
 const httpServer = createServer(router)
 httpServer.listen(4000)
 ```
 
 ### Middlewares to handle CORS, cookies and more
 
-This package also provides some utilities for your platform agnostic server implementation. The following example shows how to get the cookies as an object from the request.
+This package also provides some utilities for your platform agnostic server implementation. The
+following example shows how to get the cookies as an object from the request.
 
 ```ts
 import { withCookies } from '@whatwg-node/server'

package/index.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 const fetch = require('@whatwg-node/fetch');
 
 function isAsyncIterable(body) {
-    return body != null && typeof body === 'object' && typeof body[Symbol.asyncIterator] === 'function';
+    return (body != null && typeof body === 'object' && typeof body[Symbol.asyncIterator] === 'function');
 }
 function getPort(nodeRequest) {
     var _a, _b, _c, _d, _e;
@@ -128,7 +128,11 @@ function isNodeRequest(request) {
 }
 function isServerResponse(stream) {
     // Check all used functions are defined
-    return (stream != null && stream.setHeader != null && stream.end != null && stream.once != null && stream.write != null);
+    return (stream != null &&
+        stream.setHeader != null &&
+        stream.end != null &&
+        stream.once != null &&
+        stream.write != null);
 }
 function isReadableStream(stream) {
     return stream != null && stream.getReader != null;
@@ -203,7 +207,9 @@ function createServerAdapter(serverAdapterBaseObject,
  * WHATWG Fetch spec compliant `Request` constructor.
  */
 RequestCtor = fetch.Request) {
-    const handleRequest = typeof serverAdapterBaseObject === 'function' ? serverAdapterBaseObject : serverAdapterBaseObject.handle;
+    const handleRequest = typeof serverAdapterBaseObject === 'function'
+        ? serverAdapterBaseObject
+        : serverAdapterBaseObject.handle;
     function handleNodeRequest(nodeRequest, ...ctx) {
         const serverContext = ctx.length > 1 ? completeAssign({}, ...ctx) : ctx[0];
         const request = normalizeNodeRequest(nodeRequest, RequestCtor);
@@ -372,7 +378,9 @@ function getCORSHeadersByRequestAndOptions(request, corsOptions) {
         return headers;
     }
     // If defined origins have '*' or undefined by any means, we should allow all origins
-    if (corsOptions.origin == null || corsOptions.origin.length === 0 || corsOptions.origin.includes('*')) {
+    if (corsOptions.origin == null ||
+        corsOptions.origin.length === 0 ||
+        corsOptions.origin.includes('*')) {
         const currentOrigin = request.headers.get('origin');
         // If origin is available in the headers, use it
         if (currentOrigin != null) {

package/index.mjs

@@ -2,7 +2,7 @@ import { Request, Response } from '@whatwg-node/fetch';
 export { Response } from '@whatwg-node/fetch';
 
 function isAsyncIterable(body) {
-    return body != null && typeof body === 'object' && typeof body[Symbol.asyncIterator] === 'function';
+    return (body != null && typeof body === 'object' && typeof body[Symbol.asyncIterator] === 'function');
 }
 function getPort(nodeRequest) {
     var _a, _b, _c, _d, _e;
@@ -125,7 +125,11 @@ function isNodeRequest(request) {
 }
 function isServerResponse(stream) {
     // Check all used functions are defined
-    return (stream != null && stream.setHeader != null && stream.end != null && stream.once != null && stream.write != null);
+    return (stream != null &&
+        stream.setHeader != null &&
+        stream.end != null &&
+        stream.once != null &&
+        stream.write != null);
 }
 function isReadableStream(stream) {
     return stream != null && stream.getReader != null;
@@ -200,7 +204,9 @@ function createServerAdapter(serverAdapterBaseObject,
  * WHATWG Fetch spec compliant `Request` constructor.
  */
 RequestCtor = Request) {
-    const handleRequest = typeof serverAdapterBaseObject === 'function' ? serverAdapterBaseObject : serverAdapterBaseObject.handle;
+    const handleRequest = typeof serverAdapterBaseObject === 'function'
+        ? serverAdapterBaseObject
+        : serverAdapterBaseObject.handle;
     function handleNodeRequest(nodeRequest, ...ctx) {
         const serverContext = ctx.length > 1 ? completeAssign({}, ...ctx) : ctx[0];
         const request = normalizeNodeRequest(nodeRequest, RequestCtor);
@@ -369,7 +375,9 @@ function getCORSHeadersByRequestAndOptions(request, corsOptions) {
         return headers;
     }
     // If defined origins have '*' or undefined by any means, we should allow all origins
-    if (corsOptions.origin == null || corsOptions.origin.length === 0 || corsOptions.origin.includes('*')) {
+    if (corsOptions.origin == null ||
+        corsOptions.origin.length === 0 ||
+        corsOptions.origin.includes('*')) {
         const currentOrigin = request.headers.get('origin');
         // If origin is available in the headers, use it
         if (currentOrigin != null) {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@whatwg-node/server",
-  "version": "0.5.9-alpha-20230130162825-1e02017",
+  "version": "0.5.9",
   "description": "Fetch API compliant HTTP Server adapter",
   "sideEffects": false,
   "dependencies": {
-    "@whatwg-node/fetch": "0.6.3-alpha-20230130162825-1e02017",
+    "@whatwg-node/fetch": "0.6.3",
     "tslib": "^2.3.1"
   },
   "repository": {