ESM CommonJS hybrid module support

.circleci/config.yml

@@ -12,7 +12,7 @@ workflows:
           # definitions for field extensions in older @types/graphql versions
           matrix:
             parameters:
-              graphql-version: ['~14.5', '~14.6', '~15.0']
+              graphql-version: ['~14.6', '~14.7', '~15.0']
       - test-and-build:
           # Leave graphql-version unspecified to respect the lockfile and also run tsc
           name: test-and-build-with-typecheck

fix-hybrid-module.sh

@@ -0,0 +1,11 @@
+cat >dist/cjs/package.json <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF
+
+cat >dist/esm/package.json <<!EOF
+{
+    "type": "module"
+}
+!EOF

fix-hybrid-module.test.cjs.sh

@@ -0,0 +1,5 @@
+cat >dist/test/cjs/package.json <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF

fix-hybrid-module.test.esm.sh

@@ -0,0 +1,5 @@
+cat >dist/test/esm/package.json <<!EOF
+{
+    "type": "module"
+}
+!EOF

package.json

@@ -9,12 +9,15 @@
     "lint": "eslint --ext .ts . && prettier --config .prettierrc 'src/**/*.ts' --check",
     "lint:fix": "eslint --ext .ts . --fix && prettier --config .prettierrc 'src/**/*.ts' --write",
     "clean": "rimraf dist/*",
-    "build": "npm run build:esm && npm run build:cjs",
+    "build": "npm run build:esm && npm run build:cjs && ./fix-hybrid-module.sh",
     "build:esm": "tsc -p ./tsconfig.esm.json",
-    "build:cjs": "tsc -p ./tsconfig.json",
-    "test": "npm run lint && npm run testonly",
-    "testonly": "mocha --check-leaks --exit --full-trace --require ts-node/register/transpile-only 'src/**/__tests__/**/*-test.{ts,tsx}'",
-    "dist": "npm run clean && tsc && npm run build",
+    "build:cjs": "tsc -p ./tsconfig.cjs.json",
+    "build:test:cjs": "tsc -p ./tsconfig.test.cjs.json && ./fix-hybrid-module.test.cjs.sh",
+    "build:test:esm": "tsc -p ./tsconfig.test.esm.json && ./fix-hybrid-module.test.esm.sh",
+    "test": "npm run lint && npm run build:test:cjs && npm run testonly:cjs && npm run build:test:esm && npm run testonly:esm",
+    "testonly:cjs": "mocha --check-leaks --exit --full-trace 'dist/test/cjs/**/__tests__/**/*-test.js'",
+    "testonly:esm": "mocha --check-leaks --exit --full-trace 'dist/test/esm/**/__tests__/**/*-test.js'",
+    "dist": "npm run clean && npm run build",
     "prepare": "npm run clean && npm run dist"
   },
   "directories": {
@@ -24,7 +27,7 @@
     "lodash.get": "^4.4.2"
   },
   "peerDependencies": {
-    "graphql": "^14.5.0 || ^15.0.0"
+    "graphql": "^14.6.0 || ^15.0.0"
   },
   "files": [
     "dist",
@@ -40,6 +43,12 @@
     "complexity",
     "analysis"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "author": "Ivo Meißner",
   "license": "MIT",
   "devDependencies": {
@@ -51,11 +60,10 @@
     "@typescript-eslint/parser": "^5.1.0",
     "chai": "^4.3.4",
     "eslint": "^8.0.1",
-    "graphql": "^14.5.0 || ^15.0.0",
+    "graphql": "14.6.0",
     "mocha": "^9.1.3",
     "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
-    "ts-node": "^10.3.0",
     "typescript": "^4.4.4"
   }
 }

src/QueryComplexity.ts

@@ -8,7 +8,7 @@ import {
   getArgumentValues,
   getDirectiveValues,
   getVariableValues,
-} from 'graphql/execution/values';
+} from 'graphql/execution/values.js';
 
 import {
   ValidationContext,
@@ -168,7 +168,8 @@ export default class QueryComplexity {
     // with default values defined in the operation
     this.variableValues = getVariableValues(
       this.context.getSchema(),
-      operation.variableDefinitions ?? [],
+      // We have to create a new array here because input argument is not readonly in graphql ~14.6.0
+      operation.variableDefinitions ? [...operation.variableDefinitions] : [],
       this.options.variables ?? {}
     ).coerced;
 

src/__tests__/QueryComplexity-test.ts

@@ -13,19 +13,19 @@ import {
 
 import { expect } from 'chai';
 
-import schema from './fixtures/schema';
+import schema from './fixtures/schema.js';
 
 import ComplexityVisitor, {
   getComplexity,
   ComplexityEstimator,
-} from '../QueryComplexity';
+} from '../QueryComplexity.js';
 import defaultExport, {
   createComplexityRule,
   simpleEstimator,
   directiveEstimator,
   fieldExtensionsEstimator,
-} from '../index';
-import { CompatibleValidationContext } from './fixtures/CompatibleValidationContext';
+} from '../index.js';
+import { CompatibleValidationContext } from './fixtures/CompatibleValidationContext.js';
 
 describe('QueryComplexity analysis', () => {
   const typeInfo = new TypeInfo(schema);

src/__tests__/fixtures/CompatibleValidationContext.ts

@@ -1,6 +1,10 @@
-import { GraphQLError, TypeInfo, ValidationContext } from 'graphql';
-import { GraphQLSchema } from 'graphql/type/schema';
-import { DocumentNode } from 'graphql/language/ast';
+import {
+  GraphQLError,
+  TypeInfo,
+  ValidationContext,
+  GraphQLSchema,
+  DocumentNode,
+} from 'graphql';
 
 /**
  * This class is used to test that validation errors are raised correctly

src/__tests__/fixtures/schema.ts

@@ -14,7 +14,7 @@ import {
   GraphQLInterfaceType,
 } from 'graphql';
 
-import { ComplexityEstimatorArgs } from '../../QueryComplexity';
+import { ComplexityEstimatorArgs } from '../../QueryComplexity.js';
 
 const Item: GraphQLObjectType = new GraphQLObjectType({
   name: 'Item',

src/createComplexityRule.ts

@@ -0,0 +1,11 @@
+import { ValidationContext } from 'graphql';
+import QueryComplexity from './QueryComplexity.js';
+import { QueryComplexityOptions } from './QueryComplexity.js';
+
+export function createComplexityRule(
+  options: QueryComplexityOptions
+): (context: ValidationContext) => QueryComplexity {
+  return (context: ValidationContext): QueryComplexity => {
+    return new QueryComplexity(context, options);
+  };
+}

src/estimators/directive/__tests__/directiveEstimator-test.ts

@@ -11,15 +11,17 @@ import {
   visit,
   visitWithTypeInfo,
   buildSchema,
+  GraphQLString,
+  GraphQLObjectType,
 } from 'graphql';
 
 import { expect } from 'chai';
 
-import schema from './fixtures/schema';
+import schema from './fixtures/schema.js';
 
-import ComplexityVisitor from '../../../QueryComplexity';
-import directiveEstimator, { createComplexityDirective } from '../index';
-import { CompatibleValidationContext } from '../../../__tests__/fixtures/CompatibleValidationContext';
+import ComplexityVisitor from '../../../QueryComplexity.js';
+import directiveEstimator, { createComplexityDirective } from '../index.js';
+import { CompatibleValidationContext } from '../../../__tests__/fixtures/CompatibleValidationContext.js';
 
 describe('directiveEstimator analysis', () => {
   const typeInfo = new TypeInfo(schema);
@@ -234,6 +236,14 @@ describe('directiveEstimator analysis', () => {
     const complexityDirective = createComplexityDirective();
     const codeFirstSchema = new GraphQLSchema({
       directives: [complexityDirective],
+      query: new GraphQLObjectType({
+        name: 'Query',
+        fields: {
+          dummy: {
+            type: GraphQLString,
+          },
+        },
+      }),
     });
 
     // rebuilding code first schema
@@ -255,6 +265,14 @@ describe('directiveEstimator analysis', () => {
     const complexityDirective = createComplexityDirective({ name: 'cost' });
     const codeFirstSchema = new GraphQLSchema({
       directives: [complexityDirective],
+      query: new GraphQLObjectType({
+        name: 'Query',
+        fields: {
+          dummy: {
+            type: GraphQLString,
+          },
+        },
+      }),
     });
 
     // rebuilding code first schema

src/estimators/directive/index.ts

@@ -1,16 +1,16 @@
 import {
   ComplexityEstimator,
   ComplexityEstimatorArgs,
-} from '../../QueryComplexity';
+} from '../../QueryComplexity.js';
 import {
   getDirectiveValues,
   GraphQLInt,
   GraphQLList,
   GraphQLNonNull,
   GraphQLString,
+  GraphQLDirective,
+  DirectiveLocation,
 } from 'graphql';
-import { GraphQLDirective } from 'graphql/type/directives';
-import { DirectiveLocation } from 'graphql/language/directiveLocation';
 import get from 'lodash.get';
 
 export type ComplexityDirectiveOptions = {

src/estimators/fieldExtensions/__tests__/fieldExtensionsEstimator-test.ts

@@ -6,12 +6,12 @@ import { parse, TypeInfo, visit, visitWithTypeInfo } from 'graphql';
 
 import { expect } from 'chai';
 
-import schema from './fixtures/schema';
+import schema from './fixtures/schema.js';
 
-import ComplexityVisitor from '../../../QueryComplexity';
-import simpleEstimator from '../../simple';
-import fieldExtensionsEstimator from '../index';
-import { CompatibleValidationContext } from '../../../__tests__/fixtures/CompatibleValidationContext';
+import ComplexityVisitor from '../../../QueryComplexity.js';
+import simpleEstimator from '../../simple/index.js';
+import fieldExtensionsEstimator from '../index.js';
+import { CompatibleValidationContext } from '../../../__tests__/fixtures/CompatibleValidationContext.js';
 
 describe('fieldExtensions estimator', () => {
   const typeInfo = new TypeInfo(schema);

src/estimators/fieldExtensions/__tests__/fixtures/schema.ts

@@ -15,7 +15,7 @@ import {
   GraphQLInterfaceType,
 } from 'graphql';
 
-import { ComplexityEstimatorArgs } from '../../../../QueryComplexity';
+import { ComplexityEstimatorArgs } from '../../../../QueryComplexity.js';
 
 const Item: GraphQLObjectType = new GraphQLObjectType({
   name: 'Item',

src/estimators/fieldExtensions/index.ts

@@ -1,7 +1,7 @@
 import {
   ComplexityEstimator,
   ComplexityEstimatorArgs,
-} from '../../QueryComplexity';
+} from '../../QueryComplexity.js';
 
 export default function (): ComplexityEstimator {
   return (args: ComplexityEstimatorArgs): number | void => {

src/estimators/index.ts

@@ -1,7 +1,7 @@
-export { default as simpleEstimator } from './simple';
+export { default as simpleEstimator } from './simple/index.js';
 export {
   default as directiveEstimator,
   ComplexityDirectiveOptions,
   createComplexityDirective,
-} from './directive';
-export { default as fieldExtensionsEstimator } from './fieldExtensions';
+} from './directive/index.js';
+export { default as fieldExtensionsEstimator } from './fieldExtensions/index.js';

src/estimators/simple/__tests__/simpleEstimator-test.ts

@@ -6,11 +6,11 @@ import { parse, TypeInfo, visit, visitWithTypeInfo } from 'graphql';
 
 import { expect } from 'chai';
 
-import schema from './fixtures/schema';
-import simpleEstimator from '../index';
+import schema from './fixtures/schema.js';
+import simpleEstimator from '../index.js';
 
-import ComplexityVisitor from '../../../QueryComplexity';
-import { CompatibleValidationContext } from '../../../__tests__/fixtures/CompatibleValidationContext';
+import ComplexityVisitor from '../../../QueryComplexity.js';
+import { CompatibleValidationContext } from '../../../__tests__/fixtures/CompatibleValidationContext.js';
 
 describe('simple estimator', () => {
   const typeInfo = new TypeInfo(schema);

src/estimators/simple/index.ts

@@ -1,7 +1,7 @@
 import {
   ComplexityEstimator,
   ComplexityEstimatorArgs,
-} from '../../QueryComplexity';
+} from '../../QueryComplexity.js';
 
 export default function (options?: {
   defaultComplexity?: number;

src/index.ts

@@ -1,21 +1,10 @@
 /**
  * Created by Ivo Meißner on 28.07.17.
- *
- * @flow
  */
-import { ValidationContext } from 'graphql';
-import QueryComplexity from './QueryComplexity';
-import { QueryComplexityOptions } from './QueryComplexity';
 
-export * from './estimators';
-export * from './QueryComplexity';
-
-export function createComplexityRule(
-  options: QueryComplexityOptions
-): (context: ValidationContext) => QueryComplexity {
-  return (context: ValidationContext): QueryComplexity => {
-    return new QueryComplexity(context, options);
-  };
-}
+export * from './estimators/index.js';
+export * from './QueryComplexity.js';
+import { createComplexityRule as createComplexityRuleFn } from './createComplexityRule.js';
 
+export const createComplexityRule = createComplexityRuleFn;
 export default createComplexityRule;

tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "sourceMap": false
+  },
+  "exclude": ["**/__tests__/**"]
+}

tsconfig.esm.json

@@ -1,8 +1,10 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
+    "sourceMap": false,
     "target": "ES2015",
     "module": "ES2015",
     "outDir": "dist/esm"
-  }
+  },
+  "exclude": ["**/__tests__/**"]
 }

tsconfig.json

@@ -12,7 +12,7 @@
     "paths": {
       "*": ["node_modules/*", "src/types/*"]
     },
-    "lib": ["es2015", "es2018", "esnext.asynciterable", "dom"]
+    "lib": ["esnext", "esnext.asynciterable"]
   },
   "include": ["src/**/*"]
 }

tsconfig.test.cjs.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.cjs.json",
+  "compilerOptions": {
+    "outDir": "dist/test/cjs",
+    "sourceMap": true
+  },
+  "exclude": []
+}

tsconfig.test.esm.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.esm.json",
+  "compilerOptions": {
+    "outDir": "dist/test/esm",
+    "sourceMap": true
+  },
+  "exclude": []
+}