ESM support for core and all plugins

.changeset/two-kiwis-accept.md

@@ -0,0 +1,25 @@
+---
+'@envelop/core': minor
+'@envelop/apollo-tracing': minor
+'@envelop/auth0': minor
+'@envelop/dataloader': minor
+'@envelop/depth-limit': minor
+'@envelop/disable-introspection': minor
+'@envelop/extended-validation': minor
+'@envelop/filter-operation-type': minor
+'@envelop/generic-auth': minor
+'@envelop/graphql-jit': minor
+'@envelop/graphql-middleware': minor
+'@envelop/graphql-modules': minor
+'@envelop/opentelemetry': minor
+'@envelop/parser-cache': minor
+'@envelop/persisted-operations': minor
+'@envelop/preload-assets': minor
+'@envelop/rate-limiter': minor
+'@envelop/sentry': minor
+'@envelop/validation-cache': minor
+'@envelop/testing': minor
+'@envelop/types': minor
+---
+
+ESM Support for all plugins and envelop core 

benchmark/k6.js

@@ -18,7 +18,7 @@ export const options = {
   thresholds: {
     no_errors: ['rate=1.0'],
     expected_result: ['rate=1.0'],
-    http_req_duration: ['p(95)<=12'],
+    http_req_duration: ['p(95)<=15'],
     graphql_execute: ['p(95)<=1'],
     graphql_context: ['p(95)<=1'],
     graphql_validate: ['p(95)<=1'],

examples/with-esm/README.md

@@ -0,0 +1,14 @@
+## Envelop with ESM 
+
+If you are using ESM in your project, you can consume Envelop's core and plugins using ESM.
+
+All bundles produced from this repo has `mjs` in addition to CommonJS.
+
+### Running this example
+
+To run this example:
+
+1. Make sure to install deps on the root of the repo.
+2. Run `yarn build`.
+3. Run `yarn dev` in this directory.
+

examples/with-esm/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@envelop-examples/with-esm",
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "tsup-node src/index.ts --format esm --watch src --onSuccess \"node dist/index.mjs\"",
+    "start": "tsup-node src/index.ts --format esm --onSuccess \"node dist/index.mjs\""
+  },
+  "dependencies": {
+    "@envelop/core": "*",
+    "@graphql-tools/schema": "7.1.5",
+    "fastify": "3.14.0",
+    "graphql-helix": "1.6.1"
+  },
+  "devDependencies": {
+    "@types/node": "15.12.2",
+    "tsup": "4.11.2",
+    "typescript": "4.3.2"
+  }
+}

examples/with-esm/src/index.ts

@@ -0,0 +1,68 @@
+/* eslint-disable no-console */
+import fastify from 'fastify';
+import { getGraphQLParameters, processRequest, renderGraphiQL, shouldRenderGraphiQL } from 'graphql-helix';
+import { envelop, useLogger, useSchema, useTiming } from '@envelop/core';
+import { makeExecutableSchema } from '@graphql-tools/schema';
+
+const schema = makeExecutableSchema({
+  typeDefs: /* GraphQL */ `
+    type Query {
+      hello: String!
+    }
+  `,
+  resolvers: {
+    Query: {
+      hello: () => 'World',
+    },
+  },
+});
+
+const getEnveloped = envelop({
+  plugins: [useSchema(schema), useLogger(), useTiming()],
+});
+const app = fastify();
+
+app.route({
+  method: ['GET', 'POST'],
+  url: '/graphql',
+  async handler(req, res) {
+    const { parse, validate, contextFactory, execute, schema } = getEnveloped({ req });
+    const request = {
+      body: req.body,
+      headers: req.headers,
+      method: req.method,
+      query: req.query,
+    };
+
+    if (shouldRenderGraphiQL(request)) {
+      res.type('text/html');
+      res.send(renderGraphiQL({}));
+    } else {
+      const { operationName, query, variables } = getGraphQLParameters(request);
+      const result = await processRequest({
+        operationName,
+        query,
+        variables,
+        request,
+        schema,
+        parse,
+        validate,
+        execute,
+        contextFactory,
+      });
+
+      if (result.type === 'RESPONSE') {
+        res.status(result.status);
+        res.send(result.payload);
+      } else {
+        // You can find a complete example with GraphQL Subscriptions and stream/defer here:
+        // https://github.com/contrawork/graphql-helix/blob/master/examples/fastify/server.ts
+        res.send({ errors: [{ message: 'Not Supported in this demo' }] });
+      }
+    }
+  },
+});
+
+app.listen(3000, () => {
+  console.log(`GraphQL server is running in http://127.0.0.1:3000/graphql.`);
+});

examples/with-esm/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es2019",
+    "module": "esnext",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noEmit": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}

package.json

@@ -13,14 +13,15 @@
     "./examples/lambda-aws",
     "./examples/azure-functions",
     "./examples/google-cloud-functions",
-    "./examples/cloudflare-workers"
+    "./examples/cloudflare-workers",
+    "./examples/with-esm"
   ],
   "scripts": {
     "prepare": "husky install",
     "benchmark": "NODE_ENV=production ts-node --project tsconfig.benchmark.json benchmark/execute.case.ts",
     "postinstall": "patch-package",
     "lint": "eslint --config .eslintrc.json --ext .ts .",
-    "prebuild": "rimraf packages/*/dist",
+    "prebuild": "rimraf packages/*/dist packages/plugins/*/dist",
     "build": "tsc --project tsconfig.json && bob build",
     "test": "jest",
     "test:ci": "jest --coverage",
@@ -48,7 +49,7 @@
     "husky": "6.0.0",
     "lint-staged": "11.0.0",
     "@types/node": "15.6.1",
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "eslint-config-standard": "16.0.3",
     "eslint-plugin-import": "2.23.4",
     "eslint-plugin-node": "11.1.0",

packages/core/package.json

@@ -18,8 +18,18 @@
     "nodejs",
     "typescript"
   ],
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "typescript": {
     "definition": "dist/index.d.ts"
@@ -34,7 +44,7 @@
   "devDependencies": {
     "@graphql-tools/utils": "7.10.0",
     "@graphql-tools/schema": "7.1.5",
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "graphql": "15.5.0",
     "typescript": "4.3.2"
   },

packages/plugins/apollo-tracing/package.json

@@ -9,8 +9,18 @@
     "directory": "packages/plugins/apollo-tracing"
   },
   "sideEffects": false,
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "typescript": {
     "definition": "dist/index.d.ts"
@@ -24,7 +34,7 @@
   },
   "devDependencies": {
     "@graphql-tools/schema": "7.1.5",
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "graphql": "15.5.0",
     "typescript": "4.3.2"
   },

packages/plugins/auth0/package.json

@@ -9,8 +9,18 @@
     "url": "https://github.com/dotansimha/envelop.git",
     "directory": "packages/plugins/auth0"
   },
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "typescript": {
     "definition": "dist/index.d.ts"
@@ -25,7 +35,7 @@
   },
   "devDependencies": {
     "@types/jsonwebtoken": "8.5.1",
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "graphql": "15.5.0",
     "typescript": "4.3.2"
   },

packages/plugins/dataloader/package.json

@@ -9,8 +9,18 @@
     "url": "https://github.com/dotansimha/envelop.git",
     "directory": "packages/plugins/dataloader"
   },
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "typescript": {
     "definition": "dist/index.d.ts"
@@ -23,7 +33,7 @@
   "devDependencies": {
     "dataloader": "2.0.0",
     "reflect-metadata": "0.1.13",
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "graphql": "15.5.0",
     "typescript": "4.3.2"
   },

packages/plugins/depth-limit/package.json

@@ -9,8 +9,18 @@
     "url": "https://github.com/dotansimha/envelop.git",
     "directory": "packages/plugins/depth-limit"
   },
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "typescript": {
     "definition": "dist/index.d.ts"
@@ -24,7 +34,7 @@
   },
   "devDependencies": {
     "@types/graphql-depth-limit": "1.1.2",
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "graphql": "15.5.0",
     "typescript": "4.3.2"
   },

packages/plugins/disable-introspection/package.json

@@ -9,8 +9,18 @@
     "url": "https://github.com/dotansimha/envelop.git",
     "directory": "packages/plugins/disable-introspection"
   },
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "typescript": {
     "definition": "dist/index.d.ts"
@@ -21,7 +31,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "graphql": "15.5.0",
     "typescript": "4.3.2"
   },

packages/plugins/extended-validation/package.json

@@ -9,8 +9,18 @@
     "url": "https://github.com/dotansimha/envelop.git",
     "directory": "packages/plugins/extended-validation"
   },
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "typescript": {
     "definition": "dist/index.d.ts"
@@ -21,7 +31,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "bob-the-bundler": "1.2.1",
+    "bob-the-bundler": "1.4.1",
     "graphql": "15.5.0",
     "typescript": "4.3.2"
   },