grafserv 0.0.1-alpha.13 → 0.0.1-alpha.15

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # grafserv
 
+## 0.0.1-alpha.15
+
+### Patch Changes
+
+- [#422](https://github.com/benjie/postgraphile-private/pull/422)
+  [`9f87a26b1`](https://github.com/benjie/postgraphile-private/commit/9f87a26b10e5539aa88cfd9909e265513e941fd5)
+  Thanks [@benjie](https://github.com/benjie)! - Comments enabled in released
+  packages
+
+- Updated dependencies
+  [[`ea003ca3a`](https://github.com/benjie/postgraphile-private/commit/ea003ca3a8f68fb87dca603582e47981ed033996),
+  [`57d88b5fa`](https://github.com/benjie/postgraphile-private/commit/57d88b5fa3ed296210c1fcb223452213fd57985b),
+  [`a22830b2f`](https://github.com/benjie/postgraphile-private/commit/a22830b2f293b50a244ac18e1601d7579b450c7d),
+  [`9f87a26b1`](https://github.com/benjie/postgraphile-private/commit/9f87a26b10e5539aa88cfd9909e265513e941fd5)]:
+  - grafast@0.0.1-alpha.15
+  - graphile-config@0.0.1-alpha.7
+  - ruru@2.0.0-alpha.11
+
+## 0.0.1-alpha.14
+
+### Patch Changes
+
+- Updated dependencies
+  [[`d99d666fb`](https://github.com/benjie/postgraphile-private/commit/d99d666fb234eb02dd196610995fa480c596242a)]:
+  - grafast@0.0.1-alpha.14
+
 ## 0.0.1-alpha.13
 
 ### Patch Changes

package/README.md

@@ -31,255 +31,9 @@ And please give some love to our featured sponsors 🤩:
 </tr><tr>
 <td align="center"><a href=""><img src="https://graphile.org/images/sponsors/chadf.png" width="90" height="90" alt="Chad Furman" /><br />Chad Furman</a> *</td>
 <td align="center"><a href="https://stellate.co/"><img src="https://graphile.org/images/sponsors/Stellate.png" width="90" height="90" alt="Stellate" /><br />Stellate</a> *</td>
+<td align="center"><a href="https://www.accenture.com/"><img src="https://graphile.org/images/sponsors/accenture.svg" width="90" height="90" alt="Accenture" /><br />Accenture</a> *</td>
 </tr></table>
 
 <em>\* Sponsors the entire Graphile suite</em>
 
 <!-- SPONSORS_END -->
-
-## Usage
-
-Grafserv supports many different servers, and because each server is different
-each has their own entrypoint, e.g. `grafserv/node` for the Node.js HTTP server
-or `grafserv/express/v4` for Express v4. Generally you import the `grafserv`
-function from the relevant entrypoint for your server of choice and then create
-an instance:
-
-```js
-const serv = grafserv({ schema, preset });
-```
-
-`grafserv` is passed the GraphQL schema to use (if it's available, otherwise
-passing either null or a promise is also acceptable) and a `graphql-config`
-preset - i.e. your configuration.
-
-Calling `grafserv` will return an instance; this instance will have a number of
-helpers on it, including helpers specific to integrating it with your framework
-of choice. For servers that operate on a middleware basis this is typically
-`serv.addTo(app)` (which allows registering multiple route handlers), though
-different servers may have different APIs, such as `serv.createGraphQLHandler()`
-for Lambda and Next.js.
-
-Note: There is little value in Grafserv reimplementing every non-GraphQL concern
-your server may have, so instead it leans on the ecosystem of your chosen server
-to handle things like compression, rate limits, sessions, cookies, etc. For
-example, to compress your responses you'd need to use a module like
-[`compression`](https://expressjs.com/en/resources/middleware/compression.html)
-for Express, [`koa-compress`](https://www.npmjs.com/package/koa-compress) for
-Koa, or [`@fastify/compress`](https://www.npmjs.com/package/@fastify/compress)
-for Fastify.
-
-### serv.release()
-
-Releases any resources created by the instance; no further requests should be
-handled (though currently active requests will be allowed to complete).
-
-// TODO: consider terminating subscriptions or other long-lived things.
-
-### serv.onRelease(cb)
-
-Adds `cb` to the list of callbacks to be called when the server is released;
-useful for releasing resources you created only for the server. Callbacks will
-be called in reverse order that they were added.
-
-### serv.setSchema(newSchema)
-
-Replaces the schema to use for future requests (currently active requests are
-unaffected) - this is primarily used for "watch" mode.
-
-### serv.setPreset(newPreset)
-
-Replaces the config to use for future requests (currently active requests are
-unaffected) - this is primarily used for "watch" mode. Note that certain
-configuration changes might not be reflected by certain servers until a restart.
-
-### serv.getSchema()
-
-Returns either the GraphQL schema that is currently in use, or a promise to the
-same.
-
-### serv.getPreset()
-
-Returns the resolved `graphile-config` preset that is currently in use.
-
-## Servers
-
-### Node HTTP server
-
-```js
-import { createServer } from "node:http";
-import { grafserv } from "grafserv/node";
-import preset from "./graphile.config.mjs";
-import schema from "./schema.mjs";
-
-// Create a Node HTTP server
-const server = createServer();
-server.on("error", (e) => {
-  console.error(e);
-});
-
-// Create a Grafserv instance
-const serv = grafserv({ schema, preset });
-
-// Mount the request handler into a new HTTP server, and register websockets if
-// desired
-serv.addTo(server).catch((e) => {
-  console.error(e);
-  process.exit(1);
-});
-
-// Start the Node server
-server.listen(preset.grafserv?.port ?? 5678);
-```
-
-### Express V4
-
-```js
-import { createServer } from "node:http";
-import express from "express";
-import { grafserv } from "grafserv/express/v4";
-import preset from "./graphile.config.mjs";
-import schema from "./schema.mjs";
-
-// Create an express app
-const app = express();
-// (Add any Express middleware you want here.)
-
-// Create a Node HTTP server, mounting Express into it
-const server = createServer(app);
-server.on("error", (e) => {
-  console.error(e);
-});
-
-// Create a Grafserv instance
-const serv = grafserv({ schema, preset });
-
-// Add the Grafserv instance's route handlers to the Express app, and register
-// websockets if desired
-serv.addTo(app, server).catch((e) => {
-  console.error(e);
-  process.exit(1);
-});
-
-// Start the Express server
-server.listen(preset.grafserv?.port ?? 5678);
-```
-
-### Koa V2
-
-```js
-import { createServer } from "node:http";
-import Koa from "koa";
-import { grafserv } from "grafserv/koa/v2";
-import preset from "./graphile.config.mjs";
-import schema from "./schema.mjs";
-
-// Create a Koa app
-const app = new Koa();
-// (Add any Koa middleware you want here.)
-
-// Create a Node HTTP server, mounting Koa into it
-const server = createServer(app);
-server.on("error", (e) => {
-  console.error(e);
-});
-
-// Create a Grafserv instance
-const serv = grafserv({ schema, preset });
-
-// Add the Grafserv instance's route handlers to the Koa app, and register
-// websockets if desired
-serv.addTo(app, server).catch((e) => {
-  console.error(e);
-  process.exit(1);
-});
-
-// Start the Koa server
-server.listen(preset.grafserv?.port ?? 5678);
-```
-
-### Fastify V4
-
-```js
-import Fastify from "fastify";
-// import websocket from '@fastify/websocket'
-import { grafserv } from "grafserv/fastify/v4";
-import preset from "./graphile.config.mjs";
-import schema from "./schema.mjs";
-
-// Create a Fastify app
-const app = Fastify({
-  logger: true,
-});
-// (Add any Fastify middleware you want here.)
-// await app.register(websocket);
-
-// Create a Grafserv instance
-const serv = grafserv({ schema, preset });
-
-// Add the Grafserv instance's route handlers to the Fastify app
-serv.addTo(app).catch((e) => {
-  console.error(e);
-  process.exit(1);
-});
-
-// Start the Fastify server
-app.listen({ port: preset.grafserv?.port ?? 5678 }, (err, address) => {
-  if (err) throw err;
-  console.log(`Server is now listening on ${address}`);
-});
-```
-
-### Next.js API route
-
-**TODO: actually implement this!**
-
-Grafserv handles a number of API routes, so you should define one for each of
-the things you care about. It's critical that you ensure that the paths line up
-with those used in the Graphile config, otherwise the assets will not correctly
-be served/referenced, this may cause issues when communicating between [Ruru][]
-and GraphQL.
-
-```js
-// utils/grafserv.mjs
-import { grafserv } from "grafserv/next/v13";
-import preset from "./graphile.config.mjs";
-import schema from "./schema.mjs";
-
-// Create a shared Grafserv instance
-export const serv = grafserv({ schema, preset });
-```
-
-```js
-// pages/api/graphql.mjs
-import { serv } from "../../utils/grafserv.mjs";
-
-// Create and export the `/graphql` route handler
-const handler = serv.createGraphQLHandler();
-export default handler;
-```
-
-```js
-// pages/api/ruru.mjs
-import { serv } from "../../utils/grafserv.mjs";
-
-// Create and export the `/ruru` route handler
-const handler = serv.createRuruHandler();
-export default handler;
-```
-
-### Lambda
-
-**TODO: actually implement this!**
-
-```js
-import { grafserv } from "grafserv/lambda";
-import preset from "./graphile.config.mjs";
-import schema from "./schema.mjs";
-
-// Create a Grafserv instance
-const serv = grafserv({ schema, preset });
-
-// Export a lambda handler for GraphQL
-export const handler = serv.createGraphQLHandler();
-```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grafserv",
-  "version": "0.0.1-alpha.13",
+  "version": "0.0.1-alpha.15",
   "description": "A highly optimized server for GraphQL, powered by Grafast",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -68,17 +68,17 @@
     "@graphile/lru": "^5.0.0-alpha.2",
     "debug": "^4.1.1",
     "eventemitter3": "^4.0.7",
-    "graphile-config": "^0.0.1-alpha.6",
+    "graphile-config": "^0.0.1-alpha.7",
     "graphql-ws": "^5.11.3",
-    "ruru": "^2.0.0-alpha.10",
+    "ruru": "^2.0.0-alpha.11",
     "tslib": "^2.5.0"
   },
   "engines": {
     "node": ">=16.10"
   },
   "peerDependencies": {
-    "grafast": "^0.0.1-alpha.13",
-    "graphile-config": "^0.0.1-alpha.6",
+    "grafast": "^0.0.1-alpha.15",
+    "graphile-config": "^0.0.1-alpha.7",
     "graphql": "^16.1.0-experimental-stream-defer.6",
     "ws": "^8.12.1"
   },
@@ -94,7 +94,7 @@
     "@whatwg-node/fetch": "^0.8.1",
     "express": "^4.18.2",
     "fastify": "^4.12.0",
-    "grafast": "^0.0.1-alpha.13",
+    "grafast": "^0.0.1-alpha.15",
     "graphql-http": "^1.16.0",
     "jest": "^28.1.3",
     "jest-serializer-graphql-schema": "^5.0.0-alpha.2",