@chillicream/nitro-express-middleware 19.0.0-insider.1

package/LICENSE

@@ -0,0 +1,95 @@
+Copyright (c) ChilliCream, Inc.
+
+Source code in this repository is covered by the ChilliCream License 1.0 license as designated by a licensing file in a subdirectory or file header. The default throughout the repository is a license under the ChilliCream License 1.0, unless a file header or a licensing file in a subdirectory specifies another license.
+
+---
+
+# ChilliCream License 1.0
+
+URL: https://chillicream.com/licensing/chillicream-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+_As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim._
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,312 @@
+# Nitro Express Middleware
+
+_Express middleware for Nitro GraphQL IDE_
+
+## Description
+
+This middleware allows to setup _Nitro GraphQL IDE_ for your GraphQL server.
+
+You can use a **cdn** hosted version of the app or a **self** hosted version using the ad hoc package.
+
+## Installation
+
+Install this package and the required `peerDependencies` in your project:
+
+```sh
+npm install @chillicream/nitro-express-middleware --save-dev
+# or
+yarn add @chillicream/nitro-express-middleware --dev
+# or
+pnpm add @chillicream/nitro-express-middleware --save-dev
+```
+
+**Note**: `@chillicream/nitro-embedded` is optional and only needed if you prefer to **self** host the app.
+
+## Usage
+
+Add the middleware to your app.
+
+```javascript
+import express from "express";
+import nitroMiddleware from "@chillicream/nitro-express-middleware";
+
+// ...
+
+const app = express();
+
+app.use(
+  "/graphql",
+
+  // for `cdn` hosted version
+  nitroMiddleware({ mode: "cdn" })
+
+  // for `embedded` version
+  // nitroMiddleware({ mode: "embedded" }),
+
+  // place here your graphql middleware and others
+);
+
+app.listen(3000, () => {
+  console.log(`GraphQL on http://localhost:3000/graphql`);
+});
+```
+
+### Extended configuration
+
+- To pin a specific version instead of using "latest":
+
+  ```javascript
+  nitroMiddleware({
+    mode: "cdn",
+    target: { version: "3.0.0" },
+  });
+  ```
+
+- To use your own infrastructure:
+
+  ```javascript
+  nitroMiddleware({
+    mode: "cdn",
+    target: "https://mycompany.com/nitro",
+  });
+  ```
+
+### Custom options
+
+- To pass `options` supported by _Nitro GraphQL IDE_:
+
+  ```javascript
+  nitroMiddleware({
+    mode: "cdn",
+    options: {
+      title: "nitro",
+    },
+  });
+  ```
+
+## Recipes
+
+<details id="graphql-http">
+<summary><a href="#graphql-http"><sub><sup>🔗</sup></sub></a> With <a href="https://github.com/enisdenjo/graphql-http">graphql-http</a></summary>
+<hr>
+
+```javascript
+import express from "express";
+import { createHandler } from "graphql-http";
+import { GraphQLObjectType, GraphQLSchema, GraphQLString } from "graphql";
+
+import nitroMiddleware from "@chillicream/nitro-express-middleware";
+
+const schema = new GraphQLSchema({
+  query: new GraphQLObjectType({
+    name: "Query",
+    fields: {
+      greeting: {
+        type: GraphQLString,
+        resolve(_parent, _args) {
+          return "Hello, World!";
+        },
+      },
+    },
+  }),
+});
+
+const app = express();
+
+const handler = createHandler({ schema });
+
+app.use(
+  "/graphql",
+
+  // for `cdn` hosted version
+  nitroMiddleware({ mode: "cdn" }),
+
+  // for `embedded` version
+  // nitroMiddleware({ mode: "embedded" }),
+
+  async (req, res) => {
+    try {
+      const [body, init] = await handler({
+        url: req.url,
+        method: req.method,
+        headers: req.headers,
+        body: () =>
+          new Promise((resolve) => {
+            let body = "";
+            req.on("data", (chunk) => (body += chunk));
+            req.on("end", () => resolve(body));
+          }),
+        raw: req,
+      });
+      res.writeHead(init.status, init.statusText, init.headers).end(body);
+    } catch (err) {
+      res.writeHead(500).end(err.message);
+    }
+  }
+);
+
+app.listen(3000, () => {
+  console.log(`GraphQL on http://localhost:3000/graphql`);
+});
+```
+
+<hr>
+</details>
+
+<details id="graphql-yoga">
+<summary><a href="#graphql-yoga"><sub><sup>🔗</sup></sub></a> With <a href="https://the-guild.dev/graphql/yoga-server">graphql-yoga</a></summary>
+<hr>
+
+```javascript
+import express from "express";
+import { createYoga, createSchema } from "graphql-yoga";
+
+import nitroMiddleware from "@chillicream/nitro-express-middleware";
+
+const graphQLServer = createYoga({
+  schema: createSchema({
+    typeDefs: /* GraphQL */ `
+      type Query {
+        greeting: String
+      }
+    `,
+    resolvers: {
+      Query: {
+        greeting: () => "Hello, World!",
+      },
+    },
+  }),
+  logging: false,
+});
+
+const app = express();
+
+app.use(
+  "/graphql",
+
+  // for `cdn` hosted version
+  nitroMiddleware({ mode: "cdn" }),
+
+  // for `embedded` version
+  // nitroMiddleware({ mode: "embedded" }),
+
+  graphQLServer
+);
+
+app.listen(3000, () => {
+  console.log(`GraphQL on http://localhost:3000/graphql`);
+});
+```
+
+<hr>
+</details>
+
+<details id="express-graphql">
+<summary><a href="#express-graphql"><sub><sup>🔗</sup></sub></a> With <a href="https://github.com/graphql/express-graphql">express-graphql</a></summary>
+<hr>
+
+```javascript
+import express from "express";
+import { graphqlHTTP } from "express-graphql";
+import { GraphQLObjectType, GraphQLSchema, GraphQLString } from "graphql";
+
+import nitroMiddleware from "@chillicream/nitro-express-middleware";
+
+const schema = new GraphQLSchema({
+  query: new GraphQLObjectType({
+    name: "Query",
+    fields: {
+      greeting: {
+        type: GraphQLString,
+        resolve(_parent, _args) {
+          return "Hello, World!";
+        },
+      },
+    },
+  }),
+});
+
+const app = express();
+
+app.use(
+  "/graphql",
+
+  // for `cdn` hosted version
+  nitroMiddleware({ mode: "cdn" }),
+
+  // for `embedded` version
+  // nitroMiddleware({ mode: "embedded" }),
+
+  graphqlHTTP({
+    schema,
+    graphiql: false,
+  })
+);
+
+app.listen(3000, () => {
+  console.log(`GraphQL on http://localhost:3000/graphql`);
+});
+```
+
+<hr>
+</details>
+
+<details id="apollo-server">
+<summary><a href="#apollo-server"><sub><sup>🔗</sup></sub></a> With <a href="https://www.apollographql.com/docs/apollo-server/">apollo-server-</a></summary>
+<hr>
+
+```javascript
+import { ApolloServer } from "@apollo/server";
+import { expressMiddleware } from "@apollo/server/express4";
+import { ApolloServerPluginDrainHttpServer } from "@apollo/server/plugin/drainHttpServer";
+import express from "express";
+import http from "http";
+import cors from "cors";
+import bodyParser from "body-parser";
+
+import nitroMiddleware from "@chillicream/nitro-express-middleware";
+
+const typeDefs = `#graphql
+  type Query {
+    greeting: String
+  }
+`;
+
+const resolvers = {
+  Query: {
+    greeting: () => "Hello, World!",
+  },
+};
+
+const app = express();
+const httpServer = http.createServer(app);
+const server = new ApolloServer({
+  typeDefs,
+  resolvers,
+  plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
+});
+await server.start();
+
+app.use(
+  "/graphql",
+
+  // for `cdn` hosted version
+  nitroMiddleware({ mode: "cdn" }),
+
+  // for `embedded` version
+  // nitroMiddleware({ mode: "embedded" }),
+
+  cors(),
+  bodyParser.json(),
+  expressMiddleware(server, {
+    context: async ({ req }) => ({ token: req.headers.token }),
+  })
+);
+
+httpServer.listen({ port: 3000 }, () => {
+  console.log(`GraphQL on http://localhost:3000/graphql`);
+});
+```
+
+<hr>
+</details>

package/index.cjs

@@ -0,0 +1,119 @@
+/*!
+* @license ChilliCream License 1.0
+*
+* Copyright (c) ChilliCream, Inc.
+*
+* This source code is licensed under the ChilliCream License 1.0 found in the
+* LICENSE file in the root directory of this source tree.
+*/
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var express = require('express');
+var httpProxyMiddleware = require('http-proxy-middleware');
+var module$1 = require('node:module');
+var path = require('node:path');
+
+const Defaults = {
+    CDN_URL: "https://cdn.chillicream.com/web",
+    VERSION: "latest",
+    EMBEDDED_ID: "@chillicream/nitro-embedded",
+    CONFIG: {
+        mode: "cdn",
+    },
+    OPTIONS: {
+        useBrowserUrlAsEndpoint: true,
+    },
+};
+const Paths = {
+    ROOT: "/",
+    INDEX: "/index.html",
+    CONFIG: "/nitro-config.json",
+};
+function resolveUrl(target) {
+    return typeof target === "string"
+        ? target
+        : `${target?.baseUrl || Defaults.CDN_URL}/${target?.version || Defaults.VERSION}`;
+}
+function resolvePath(target) {
+    const require$1 = module$1.createRequire(require('url').pathToFileURL(__filename).toString());
+    return path.dirname(require$1.resolve(target || Defaults.EMBEDDED_ID));
+}
+function resolveOptions(options) {
+    return Object.assign({}, Defaults.OPTIONS, options);
+}
+
+function combineMiddlewares(...middlewares) {
+    return middlewares.reduce((a, b) => (req, res, next) => {
+        a(req, res, (err) => {
+            if (err) {
+                next(err);
+            }
+            else {
+                b(req, res, next);
+            }
+        });
+    });
+}
+function createRootMiddleware() {
+    return function rootMiddleware(req, res, next) {
+        if (req.method === "GET" || req.method === "HEAD") {
+            if (req.path === Paths.ROOT && req.accepts("html")) {
+                const path = req.originalUrl.replace(/\?.*/, "");
+                if (!path.endsWith("/")) {
+                    const query = req.originalUrl.slice(path.length);
+                    return res.redirect(301, path + "/" + query);
+                }
+            }
+        }
+        next();
+    };
+}
+function createConfigMiddleware(options) {
+    return function configMiddleware(req, res, next) {
+        if (req.method === "GET" || req.method === "HEAD") {
+            if (req.path === Paths.CONFIG && req.accepts("json")) {
+                if (req.method === "GET") {
+                    return res.json(resolveOptions(options));
+                }
+                else {
+                    return res.json();
+                }
+            }
+        }
+        next();
+    };
+}
+function cdnMiddleware(target, options) {
+    return combineMiddlewares(createRootMiddleware(), createConfigMiddleware(options), httpProxyMiddleware.createProxyMiddleware((pathname, req) => {
+        return (pathname !== req.baseUrl &&
+            (req.method === "GET" || req.method === "HEAD"));
+    }, {
+        target,
+        pathRewrite(path, req) {
+            return path.replace(req.baseUrl, "");
+        },
+        followRedirects: true,
+        changeOrigin: true,
+        logLevel: "silent",
+    }));
+}
+function selfMiddleware(target, options) {
+    return combineMiddlewares(createRootMiddleware(), createConfigMiddleware(options), express.static(target, {
+        redirect: true,
+        fallthrough: true,
+    }));
+}
+function nitroMiddleware({ mode, target, options, }) {
+    return mode === "cdn"
+        ? cdnMiddleware(resolveUrl(target), options)
+        : selfMiddleware(resolvePath(target), options);
+}
+
+exports.cdnMiddleware = cdnMiddleware;
+exports.combineMiddlewares = combineMiddlewares;
+exports.createConfigMiddleware = createConfigMiddleware;
+exports.createRootMiddleware = createRootMiddleware;
+exports.default = nitroMiddleware;
+exports.selfMiddleware = selfMiddleware;

package/index.d.cts

@@ -0,0 +1,40 @@
+/// <reference types="express" />
+interface HttpHeaderDictionary {
+    readonly [key: string]: string | string[];
+}
+type SubscriptionProtocol = "auto" | "graphql-transport-ws" | "graphql-ws" | "graphql-sse";
+interface Options {
+    readonly title?: string;
+    readonly disableTelemetry?: boolean;
+    readonly gaTrackingId?: string;
+    readonly useBrowserUrlAsEndpoint: boolean;
+    readonly includeCookies?: boolean;
+    readonly useGet?: boolean;
+    readonly subscriptionProtocol?: SubscriptionProtocol;
+    readonly sdlEndpoint?: string;
+    readonly endpoint?: string;
+    readonly httpHeaders?: HttpHeaderDictionary;
+    readonly graphQLDocument?: string;
+    readonly variables?: Record<string, any>;
+}
+type Config = {
+    readonly mode: "cdn";
+    /** Endpoint **url** for the `cdn` hosted version. */
+    readonly target?: {
+        baseUrl: string;
+        version?: string;
+    } | string;
+    readonly options?: Options;
+} | {
+    readonly mode: "embedded";
+    /** Package **id** or **path** for the `embedded` version. */
+    readonly target?: string;
+    readonly options?: Options;
+};
+declare function combineMiddlewares(...middlewares: Handler[]): Handler;
+declare function createRootMiddleware(): Handler;
+declare function createConfigMiddleware(options?: Options): Handler;
+declare function cdnMiddleware(target: string, options?: Options): Handler;
+declare function selfMiddleware(target: string, options?: Options): Handler;
+declare function nitroMiddleware({ mode, target, options, }: Config): Handler;
+export { combineMiddlewares, createRootMiddleware, createConfigMiddleware, cdnMiddleware, selfMiddleware, nitroMiddleware as default };

package/index.d.mts

@@ -0,0 +1,40 @@
+/// <reference types="express" />
+interface HttpHeaderDictionary {
+    readonly [key: string]: string | string[];
+}
+type SubscriptionProtocol = "auto" | "graphql-transport-ws" | "graphql-ws" | "graphql-sse";
+interface Options {
+    readonly title?: string;
+    readonly disableTelemetry?: boolean;
+    readonly gaTrackingId?: string;
+    readonly useBrowserUrlAsEndpoint: boolean;
+    readonly includeCookies?: boolean;
+    readonly useGet?: boolean;
+    readonly subscriptionProtocol?: SubscriptionProtocol;
+    readonly sdlEndpoint?: string;
+    readonly endpoint?: string;
+    readonly httpHeaders?: HttpHeaderDictionary;
+    readonly graphQLDocument?: string;
+    readonly variables?: Record<string, any>;
+}
+type Config = {
+    readonly mode: "cdn";
+    /** Endpoint **url** for the `cdn` hosted version. */
+    readonly target?: {
+        baseUrl: string;
+        version?: string;
+    } | string;
+    readonly options?: Options;
+} | {
+    readonly mode: "embedded";
+    /** Package **id** or **path** for the `embedded` version. */
+    readonly target?: string;
+    readonly options?: Options;
+};
+declare function combineMiddlewares(...middlewares: Handler[]): Handler;
+declare function createRootMiddleware(): Handler;
+declare function createConfigMiddleware(options?: Options): Handler;
+declare function cdnMiddleware(target: string, options?: Options): Handler;
+declare function selfMiddleware(target: string, options?: Options): Handler;
+declare function nitroMiddleware({ mode, target, options, }: Config): Handler;
+export { combineMiddlewares, createRootMiddleware, createConfigMiddleware, cdnMiddleware, selfMiddleware, nitroMiddleware as default };

package/index.mjs

@@ -0,0 +1,110 @@
+/*!
+* @license ChilliCream License 1.0
+*
+* Copyright (c) ChilliCream, Inc.
+*
+* This source code is licensed under the ChilliCream License 1.0 found in the
+* LICENSE file in the root directory of this source tree.
+*/
+import express from 'express';
+import { createProxyMiddleware } from 'http-proxy-middleware';
+import module from 'node:module';
+import path from 'node:path';
+
+const Defaults = {
+    CDN_URL: "https://cdn.chillicream.com/web",
+    VERSION: "latest",
+    EMBEDDED_ID: "@chillicream/nitro-embedded",
+    CONFIG: {
+        mode: "cdn",
+    },
+    OPTIONS: {
+        useBrowserUrlAsEndpoint: true,
+    },
+};
+const Paths = {
+    ROOT: "/",
+    INDEX: "/index.html",
+    CONFIG: "/nitro-config.json",
+};
+function resolveUrl(target) {
+    return typeof target === "string"
+        ? target
+        : `${target?.baseUrl || Defaults.CDN_URL}/${target?.version || Defaults.VERSION}`;
+}
+function resolvePath(target) {
+    const require = module.createRequire(import.meta.url);
+    return path.dirname(require.resolve(target || Defaults.EMBEDDED_ID));
+}
+function resolveOptions(options) {
+    return Object.assign({}, Defaults.OPTIONS, options);
+}
+
+function combineMiddlewares(...middlewares) {
+    return middlewares.reduce((a, b) => (req, res, next) => {
+        a(req, res, (err) => {
+            if (err) {
+                next(err);
+            }
+            else {
+                b(req, res, next);
+            }
+        });
+    });
+}
+function createRootMiddleware() {
+    return function rootMiddleware(req, res, next) {
+        if (req.method === "GET" || req.method === "HEAD") {
+            if (req.path === Paths.ROOT && req.accepts("html")) {
+                const path = req.originalUrl.replace(/\?.*/, "");
+                if (!path.endsWith("/")) {
+                    const query = req.originalUrl.slice(path.length);
+                    return res.redirect(301, path + "/" + query);
+                }
+            }
+        }
+        next();
+    };
+}
+function createConfigMiddleware(options) {
+    return function configMiddleware(req, res, next) {
+        if (req.method === "GET" || req.method === "HEAD") {
+            if (req.path === Paths.CONFIG && req.accepts("json")) {
+                if (req.method === "GET") {
+                    return res.json(resolveOptions(options));
+                }
+                else {
+                    return res.json();
+                }
+            }
+        }
+        next();
+    };
+}
+function cdnMiddleware(target, options) {
+    return combineMiddlewares(createRootMiddleware(), createConfigMiddleware(options), createProxyMiddleware((pathname, req) => {
+        return (pathname !== req.baseUrl &&
+            (req.method === "GET" || req.method === "HEAD"));
+    }, {
+        target,
+        pathRewrite(path, req) {
+            return path.replace(req.baseUrl, "");
+        },
+        followRedirects: true,
+        changeOrigin: true,
+        logLevel: "silent",
+    }));
+}
+function selfMiddleware(target, options) {
+    return combineMiddlewares(createRootMiddleware(), createConfigMiddleware(options), express.static(target, {
+        redirect: true,
+        fallthrough: true,
+    }));
+}
+function nitroMiddleware({ mode, target, options, }) {
+    return mode === "cdn"
+        ? cdnMiddleware(resolveUrl(target), options)
+        : selfMiddleware(resolvePath(target), options);
+}
+
+export { cdnMiddleware, combineMiddlewares, createConfigMiddleware, createRootMiddleware, nitroMiddleware as default, selfMiddleware };

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@chillicream/nitro-express-middleware",
+  "version": "19.0.0-insider.1",
+  "description": "Express middleware for Nitro GraphQL IDE",
+  "homepage": "https://chillicream.com",
+  "repository": "github:ChilliCream/graphql-platform",
+  "keywords": [
+    "apollo",
+    "apollo-server",
+    "banana",
+    "bananacakepop",
+    "bcp",
+    "express",
+    "express-graphql",
+    "graphql",
+    "graphql-http",
+    "graphql-ide",
+    "graphql-yoga",
+    "middleware",
+    "editor",
+    "ide"
+  ],
+  "author": {
+    "name": "ChilliCream",
+    "url": "https://chillicream.com",
+    "email": "info@chillicream.com"
+  },
+  "license": "SEE LICENSE FILE",
+  "engines": {
+    "node": ">=12"
+  },
+  "type": "module",
+  "types": "index.d.mts",
+  "module": "index.mjs",
+  "main": "index.cjs",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.mts",
+        "default": "./index.mjs"
+      },
+      "require": {
+        "types": "./index.d.cts",
+        "default": "./index.cjs"
+      },
+      "default": {
+        "types": "./index.d.mts",
+        "default": "./index.mjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@chillicream/nitro-embedded": "*",
+    "express": "*",
+    "http-proxy-middleware": "*"
+  },
+  "peerDependenciesMeta": {
+    "@chillicream/nitro-embedded": {
+      "optional": true
+    },
+    "http-proxy-middleware": {
+      "optional": true
+    }
+  },
+  "stableVersion": "0.0.0"
+}