types: improve typings (#202)

* types: improve typings

* Apply suggestions from code review

package.json

@@ -7,7 +7,7 @@
     "url": "git+https://github.com/fastify/fastify-auth.git"
   },
   "main": "auth.js",
-  "types": "auth.d.ts",
+  "types": "types/index.d.ts",
   "scripts": {
     "clean": "rimraf authdb",
     "lint": "standard",
@@ -46,9 +46,6 @@
     "fastify-plugin": "^4.0.0",
     "reusify": "^1.0.4"
   },
-  "tsd": {
-    "directory": "test"
-  },
   "publishConfig": {
     "access": "public"
   }

auth.d.ts → types/index.d.ts

@@ -1,39 +1,50 @@
-import { ContextConfigDefault, RouteGenericInterface, FastifyInstance, FastifyPluginCallback, FastifyReply, FastifyRequest, FastifySchema, preHandlerHookHandler } from 'fastify';
+import {
+  ContextConfigDefault,
+  RouteGenericInterface,
+  FastifyInstance,
+  FastifyPluginCallback,
+  FastifyReply,
+  FastifyRequest,
+  FastifySchema,
+  preHandlerHookHandler
+} from 'fastify';
 
 declare module 'fastify' {
   interface FastifyInstance<RawServer, RawRequest, RawReply, Logger, TypeProvider> {
     auth(
       functions: fastifyAuth.FastifyAuthFunction[] | (fastifyAuth.FastifyAuthFunction | fastifyAuth.FastifyAuthFunction[])[],
       options?: {
-        relation?: 'and' | 'or',
-        run?: 'all'
+        relation?: fastifyAuth.FastifyAuthRelation;
+        run?: 'all';
       }
-    ): preHandlerHookHandler<RawServer, RawRequest, RawReply, RouteGenericInterface, ContextConfigDefault, FastifySchema, TypeProvider>;
+    ): preHandlerHookHandler<RawServer, RawRequest, RawReply, RouteGenericInterface, ContextConfigDefault, FastifySchema, TypeProvider, Logger>;
   }
 }
 
 type FastifyAuth = FastifyPluginCallback<fastifyAuth.FastifyAuthPluginOptions>
 
 declare namespace fastifyAuth {
+  export type FastifyAuthRelation = 'and' | 'or'
+
   export type FastifyAuthFunction = (
     this: FastifyInstance,
     request: FastifyRequest,
     reply: FastifyReply,
     done: (error?: Error) => void
   ) => void;
-  
+
   /**
    * @link [`fastify-auth` options documentation](https://github.com/fastify/fastify-auth#options)
    */
   export interface FastifyAuthPluginOptions {
     /**
      * The default relation between the functions. It can be either `or` or `and`.
      *
-     * - Default value: `or`
+     * @default 'or'
      */
-     defaultRelation?: 'and' | 'or',
+    defaultRelation?: FastifyAuthRelation;
   }
-  
+
   export const fastifyAuth: FastifyAuth
   export { fastifyAuth as default }
 }

test/auth.test-d.ts → types/index.test-d.ts

@@ -1,5 +1,5 @@
 import fastify, { FastifyRequest, FastifyReply, preHandlerHookHandler, FastifyInstance } from 'fastify';
-import fastifyAuth from '../auth'
+import fastifyAuth from '..'
 import { expectType } from 'tsd';
 import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox'
 import { JsonSchemaToTsProvider } from '@fastify/type-provider-json-schema-to-ts'