Add initial typings

Author: jonnydgreen

index.d.ts

@@ -0,0 +1,56 @@
+import { FastifyPluginAsync } from 'fastify'
+import { GraphQLResolveInfo } from 'graphql'
+import { MercuriusContext } from 'mercurius'
+import { Options, SchemaObject } from 'ajv'
+
+export interface MercuriusValidationHandlerMetadata {
+  /**
+   * The name of the associated GraphQL type.
+   */
+  type: string;
+  /**
+   * The name of the associated GraphQL field.
+   */
+  field: string;
+  /**
+   * The name of the associated GraphQL argument.
+   */
+  argument: string;
+}
+
+/**
+ * The validation function to run when an argument is selected by the GraphQL operation.
+ * Thrown errors will be caught and handled by `mercurius-validation`.
+ */
+export type MercuriusValidationHandler<TParent = any, TArgs = any, TContext = MercuriusContext> = (
+  metadata: MercuriusValidationHandlerMetadata,
+  value: any,
+  parent: TParent,
+  args: TArgs,
+  context: TContext,
+  info: GraphQLResolveInfo
+) => Promise<void>;
+
+export type MercuriusValidationArgument<TParent = any, TArgs = any, TContext = MercuriusContext> = |
+  SchemaObject |
+  MercuriusValidationHandler<TParent, TArgs, TContext>;
+
+export type MercuriusValidationField<TParent = any, TArgs = any, TContext = MercuriusContext> = Record<string, MercuriusValidationArgument<TParent, TArgs, TContext>> | SchemaObject
+
+export type MercuriusValidationType<TParent = any, TArgs = any, TContext = MercuriusContext> = Record<string, MercuriusValidationField<TParent, TArgs, TContext>> & {
+  __typeValidation?: SchemaObject
+}
+
+export type MercuriusValidationSchema<TParent = any, TArgs = any, TContext = MercuriusContext> = Record<string, MercuriusValidationType<TParent, TArgs, TContext>>
+
+export type MercuriusValidationMode = 'JSONSchema' | 'JTD'
+
+export interface MercuriusValidationOptions<TParent = any, TArgs = any, TContext = MercuriusContext> extends Options {
+  mode?: MercuriusValidationMode;
+  schema?: MercuriusValidationSchema<TParent, TArgs, TContext>;
+}
+
+/** Mercurius Validation is a plugin for `mercurius` that adds configurable validation support. */
+declare const mercuriusValidation: FastifyPluginAsync<MercuriusValidationOptions>
+
+export default mercuriusValidation

package.json

@@ -7,11 +7,11 @@
   "scripts": {
     "unit": "tap --100 test/*.js",
     "cov": "tap --coverage-report=html -J test/*.js",
-    "lint": "npm run lint:standard",
+    "lint": "npm run lint:standard && npm run lint:typescript",
     "lint:standard": "standard | snazzy",
     "lint:typescript": "standard --parser @typescript-eslint/parser --plugin @typescript-eslint/eslint-plugin index.d.ts test/types/*.ts | snazzy",
     "typescript": "tsd",
-    "test": "npm run lint && npm run unit"
+    "test": "npm run lint && npm run unit && npm run typescript"
   },
   "repository": {
     "type": "git",

test/types/index.test-d.ts

@@ -0,0 +1,155 @@
+import { expectType } from 'tsd'
+import fastify from 'fastify'
+import { GraphQLResolveInfo } from 'graphql'
+import { MercuriusContext } from 'mercurius'
+import mercuriusValidation, { MercuriusValidationHandler, MercuriusValidationHandlerMetadata, MercuriusValidationOptions } from '../..'
+
+const app = fastify()
+
+// Register without options
+app.register(mercuriusValidation)
+app.register(mercuriusValidation, {})
+
+// Register with AJV options
+app.register(mercuriusValidation, {
+  coerceTypes: false
+})
+
+// Use different modes
+app.register(mercuriusValidation, { mode: 'JTD' })
+app.register(mercuriusValidation, { mode: 'JSONSchema' })
+
+// JSON Schema
+app.register(mercuriusValidation, {
+  mode: 'JSONSchema',
+  schema: {
+    Filters: {
+      text: { minLength: 1 }
+    },
+    Query: {
+      message: {
+        id: {
+          minLength: 1
+        }
+      }
+    }
+  }
+})
+
+// JTD
+app.register(mercuriusValidation, {
+  mode: 'JTD',
+  schema: {
+    Filters: {
+      text: { enum: ['hello', 'there'] }
+    },
+    Query: {
+      message: {
+        id: {
+          type: 'uint8'
+        }
+      }
+    }
+  }
+})
+
+// Function
+app.register(mercuriusValidation, {
+  schema: {
+    Query: {
+      message: {
+        async id (metadata, value, parent, args, context, info) {
+          expectType<MercuriusValidationHandlerMetadata>(metadata)
+          expectType<any>(value)
+          expectType<any>(parent)
+          expectType<any>(args)
+          expectType<MercuriusContext>(context)
+          expectType<GraphQLResolveInfo>(info)
+        }
+      }
+    }
+  }
+})
+
+// Using options as object without generic
+interface CustomParent {
+  parent: Record<string, any>;
+}
+
+interface CustomArgs {
+  arg: Record<string, any>;
+}
+
+interface CustomContext extends MercuriusContext {
+  hello?: string;
+}
+
+const validationOptions: MercuriusValidationOptions = {
+  schema: {
+    Query: {
+      message: {
+        async id (
+          metadata,
+          value,
+          parent: CustomParent,
+          args: CustomArgs,
+          context: CustomContext,
+          info
+        ) {
+          expectType<MercuriusValidationHandlerMetadata>(metadata)
+          expectType<any>(value)
+          expectType<CustomParent>(parent)
+          expectType<CustomArgs>(args)
+          expectType<CustomContext>(context)
+          expectType<string | undefined>(context?.hello)
+          expectType<GraphQLResolveInfo>(info)
+        }
+      }
+    }
+  }
+}
+
+app.register(mercuriusValidation, validationOptions)
+
+// 3. Using options as object with generics
+const authOptionsWithGenerics: MercuriusValidationOptions<CustomParent, CustomArgs, CustomContext> = {
+  schema: {
+    Query: {
+      message: {
+        async id (metadata, value, parent, args, context, info) {
+          expectType<MercuriusValidationHandlerMetadata>(metadata)
+          expectType<any>(value)
+          expectType<CustomParent>(parent)
+          expectType<CustomArgs>(args)
+          expectType<CustomContext>(context)
+          expectType<string | undefined>(context?.hello)
+          expectType<GraphQLResolveInfo>(info)
+        }
+      }
+    }
+  }
+}
+
+app.register(mercuriusValidation, authOptionsWithGenerics)
+
+// 4. Creating functions using handler types
+const id: MercuriusValidationHandler<{}, {}, CustomContext> =
+  async (metadata, value, parent, args, context, info) => {
+    expectType<MercuriusValidationHandlerMetadata>(metadata)
+    expectType<any>(value)
+    expectType<{}>(parent)
+    expectType<{}>(args)
+    expectType<CustomContext>(context)
+    expectType<GraphQLResolveInfo>(info)
+    expectType<string | undefined>(context?.hello)
+  }
+
+app.register(mercuriusValidation, {
+  schema: {
+    Query: {
+      message: {
+        id
+      }
+    }
+  }
+})

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "commonjs",
+    "noEmit": true,
+    "strict": true,
+    "esModuleInterop": true
+  },
+  "exclude": ["node_modules"],
+  "files": ["./test/types/index.test-d.ts"]
+}