fix: apollo-server-errors import for typescript projects using apol…

…lo4 (#243)

fixes #156

.github/workflows/build.yaml

@@ -32,6 +32,7 @@ jobs:
             ${{ runner.OS }}-node-
             ${{ runner.OS }}-
       - run: npm ci
+      - run: npm run test-typescript
       - run: npm test
       - name: Coveralls Parallel
         uses: coverallsapp/github-action@master

apollo4.js

@@ -3,9 +3,9 @@ const {
   buildSchema,
   GraphQLError
 } = require('graphql')
-const { validateQuery } = require('./index')
 const { constraintDirectiveTypeDefs } = require('./lib/type-defs')
 const { gql } = require('graphql-tag')
+const { validateQuery } = require('./lib/validate-query')
 
 let currentSchema
 

index.js

@@ -1,15 +1,13 @@
 const {
   GraphQLNonNull,
   GraphQLList,
-  TypeInfo,
-  ValidationContext,
-  visit,
-  visitWithTypeInfo,
   separateOperations,
   GraphQLError,
   getDirectiveValues
 } = require('graphql')
 const QueryValidationVisitor = require('./lib/query-validation-visitor.js')
+const { validateQuery } = require('./lib/validate-query')
+
 const { getDirective, mapSchema, MapperKind } = require('@graphql-tools/utils')
 const { getConstraintTypeObject, getScalarType } = require('./lib/type-utils')
 const { constraintDirectiveTypeDefs, constraintDirectiveTypeDefsObj } = require('./lib/type-defs')
@@ -173,28 +171,6 @@ function constraintDirectiveDocumentation (options) {
     })
 }
 
-function validateQuery (schema, query, variables, operationName, pluginOptions = {}) {
-  const typeInfo = new TypeInfo(schema)
-
-  const errors = []
-  const context = new ValidationContext(
-    schema,
-    query,
-    typeInfo,
-    (error) => errors.push(error)
-  )
-
-  const visitor = new QueryValidationVisitor(context, {
-    variables,
-    operationName,
-    pluginOptions
-  })
-
-  visit(query, visitWithTypeInfo(typeInfo, visitor))
-
-  return errors
-}
-
 function createApolloQueryValidationPlugin ({ schema }, options = {}) {
   return {
     async requestDidStart () {

lib/error.js

@@ -1,4 +1,6 @@
 module.exports = class ConstraintDirectiveError extends Error {
+  ;
+
   constructor (fieldName, message, context) {
     super(message)
     this.name = this.constructor.name
@@ -7,5 +9,6 @@ module.exports = class ConstraintDirectiveError extends Error {
     this.code = 'ERR_GRAPHQL_CONSTRAINT_VALIDATION'
     this.fieldName = fieldName
     this.context = context
+    this.originalError = undefined
   }
 }

lib/type-utils.js

@@ -48,7 +48,7 @@ function getScalarType (fieldConfig) {
   } else if (isNonNullType(fieldConfig) && isScalarType(fieldConfig.ofType)) {
     return { scalarType: fieldConfig.ofType, scalarNotNull: true }
   } else if (isNonNullType(fieldConfig)) {
-    return { ...getScalarType(fieldConfig.ofType.ofType), list: true, listNotNull: true }
+    return { ...getScalarType(fieldConfig.ofType), list: true, listNotNull: true }
   } else {
     throw new Error(`Not a valid scalar type: ${fieldConfig.toString()}`)
   }

lib/validate-query.js

@@ -0,0 +1,31 @@
+const {
+  TypeInfo,
+  ValidationContext,
+  visit,
+  visitWithTypeInfo
+} = require('graphql')
+const QueryValidationVisitor = require('./query-validation-visitor.js')
+
+function validateQuery (schema, query, variables, operationName, pluginOptions = {}) {
+  const typeInfo = new TypeInfo(schema)
+
+  const errors = []
+  const context = new ValidationContext(
+    schema,
+    query,
+    typeInfo,
+    (error) => errors.push(error)
+  )
+
+  const visitor = new QueryValidationVisitor(context, {
+    variables,
+    operationName,
+    pluginOptions
+  })
+
+  visit(query, visitWithTypeInfo(typeInfo, visitor))
+
+  return errors
+}
+
+module.exports = { validateQuery }

package.json

@@ -11,6 +11,7 @@
     "test-apollo-plugin": "standard && nyc --reporter=html --reporter=text --reporter=lcov mocha test/**/testsuite-apollo-plugin.js",
     "test-apollo4-plugin": "standard && nyc --reporter=html --reporter=text --reporter=lcov mocha test/**/testsuite-apollo4-plugin.js",
     "test-envelop-plugin": "standard && nyc --reporter=html --reporter=text --reporter=lcov mocha test/**/testsuite-envelop-plugin.js",
+    "test-typescript": "tsc --project tsconfig.apollo4.json && tsc --project tsconfig.apollo.json",
     "test-validation-rule-express-graphql": "standard && nyc --reporter=html --reporter=text --reporter=lcov mocha test/**/testsuite-validation-rule-express-graphql.js"
   },
   "author": "James Mortemore ([email protected])",
@@ -34,16 +35,17 @@
     "constraint"
   ],
   "devDependencies": {
-    "apollo-server-express": "3.13.0",
     "@apollo/server": "4.9.5",
+    "@graphql-yoga/node": "2.13.13",
+    "apollo-server-express": "3.13.0",
     "coveralls": "3.1.1",
     "express": "4.21.0",
     "graphql": "16.6.0",
     "mocha": "10.7.3",
     "nyc": "15.1.0",
     "standard": "16.0.4",
     "supertest": "6.3.4",
-    "@graphql-yoga/node": "2.13.13"
+    "typescript": "^5.5.3"
   },
   "dependencies": {
     "@graphql-tools/schema": "^9.0.0",

test/typescript/apollo.ts

@@ -0,0 +1 @@
+import { constraintDirective, constraintDirectiveTypeDefs } from 'graphql-constraint-directive';

test/typescript/apollo4.ts

@@ -0,0 +1,3 @@
+import { constraintDirectiveTypeDefs, createApollo4QueryValidationPlugin } from 'graphql-constraint-directive/apollo4';
+
+export { constraintDirectiveTypeDefs, createApollo4QueryValidationPlugin };

test/typescript/error.ts

@@ -0,0 +1,3 @@
+const errorFn: () => string = {
+
+}

tsconfig.apollo.json

@@ -0,0 +1,32 @@
+{
+    "compileOnSave": false,
+    "compilerOptions": {
+        "baseUrl": ".",
+        "rootDir": ".",
+        "declaration": false,
+        "moduleResolution": "node",
+        "noEmit": true,
+        "importHelpers": true,
+        "target": "es2015",
+        "module": "esnext",
+        "lib": [
+            "es2020",
+        ],
+        "checkJs": true,
+        "skipLibCheck": true,
+        "skipDefaultLibCheck": true,
+        "paths": {
+            "graphql-constraint-directive": [
+                "index.js",
+                "index.d.ts",
+            ]
+        }
+    },
+    "include": [
+        "./test/typescript/apollo.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "tmp"
+    ]
+}

tsconfig.apollo4.json

@@ -0,0 +1,35 @@
+{
+    "compileOnSave": false,
+    "compilerOptions": {
+        "baseUrl": ".",
+        "rootDir": ".",
+        "declaration": false,
+        "moduleResolution": "node",
+        "noEmit": true,
+        "importHelpers": true,
+        "target": "es2015",
+        "module": "esnext",
+        "lib": [
+            "es2020",
+        ],
+        "checkJs": true,
+        "skipLibCheck": true,
+        "skipDefaultLibCheck": true,
+        "paths": {
+            "graphql-constraint-directive/apollo4": [
+                "apollo4.js",
+                "apollo4.d.ts",
+            ],
+            "apollo-server-errors": [
+                "./test/typescript/error.ts"
+            ]
+        }
+    },
+    "include": [
+        "./test/typescript/apollo4.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "tmp"
+    ]
+}