.github/workflows/ci.yml

@@ -2,6 +2,11 @@ name: CI
 
 on:
   push:
+    branches:
+     - main
+     - master
+     - next
+     - 'v*'
     paths-ignore:
       - 'docs/**'
       - '*.md'

.gitignore

@@ -139,6 +139,7 @@ dist
 .clinic
 
 # lock files
+bun.lockb
 package-lock.json
 pnpm-lock.yaml
 yarn.lock

README.md

@@ -23,9 +23,9 @@ Example using a callback:
 ```js
 const fp = require('fastify-plugin')
 
-module.exports = fp(function (fastify, opts, next) {
+module.exports = fp(function (fastify, opts, done) {
   // your plugin code
-  next()
+  done()
 })
 ```
 
@@ -48,9 +48,9 @@ If you need to set a bare-minimum version of Fastify for your plugin, just add t
 ```js
 const fp = require('fastify-plugin')
 
-module.exports = fp(function (fastify, opts, next) {
+module.exports = fp(function (fastify, opts, done) {
   // your plugin code
-  next()
+  done()
 }, { fastify: '4.x' })
 ```
 
@@ -64,9 +64,9 @@ Fastify uses this option to validate the dependency graph, allowing it to ensure
 ```js
 const fp = require('fastify-plugin')
 
-function plugin (fastify, opts, next) {
+function plugin (fastify, opts, done) {
   // your plugin code
-  next()
+  done()
 }
 
 module.exports = fp(plugin, {
@@ -81,9 +81,9 @@ You can also check if the `plugins` and `decorators` that your plugin intend to
 ```js
 const fp = require('fastify-plugin')
 
-function plugin (fastify, opts, next) {
+function plugin (fastify, opts, done) {
   // your plugin code
-  next()
+  done()
 }
 
 module.exports = fp(plugin, {
@@ -103,10 +103,10 @@ This allows you to set the plugin's name and validate its dependencies without m
 ```js
 const fp = require('fastify-plugin')
 
-function plugin (fastify, opts, next) {
+function plugin (fastify, opts, done) {
   // the decorator is not accessible outside this plugin
   fastify.decorate('util', function() {})
-  next()
+  done()
 }
 
 module.exports = fp(plugin, {
@@ -132,13 +132,13 @@ The type definition would have to be updated to leverage this.
 It is common for developers to inline their plugin with fastify-plugin such as:
 
 ```js
-fp((fastify, opts, next) => { next() })
+fp((fastify, opts, done) => { done() })
 fp(async (fastify, opts) => { return })
 ```
 
 TypeScript can sometimes infer the types of the arguments for these functions. Plugins in fastify are recommended to be typed using either `FastifyPluginCallback` or `FastifyPluginAsync`. These two definitions only differ in two ways:
 
-1. The third argument `next` (the callback part)
+1. The third argument `done` (the callback part)
 2. The return type `FastifyPluginCallback` or `FastifyPluginAsync`
 
 At this time, TypeScript inference is not smart enough to differentiate by definition argument length alone.
@@ -149,14 +149,14 @@ Thus, if you are a TypeScript developer please use on the following patterns ins
 // Callback
 
 // Assign type directly
-const pluginCallback: FastifyPluginCallback = (fastify, options, next) => { }
+const pluginCallback: FastifyPluginCallback = (fastify, options, done) => { }
 fp(pluginCallback)
 
 // or define your own function declaration that satisfies the existing definitions
-const pluginCallbackWithTypes = (fastify: FastifyInstance, options: FastifyPluginOptions, next: (error?: FastifyError) => void): void => { }
+const pluginCallbackWithTypes = (fastify: FastifyInstance, options: FastifyPluginOptions, done: (error?: FastifyError) => void): void => { }
 fp(pluginCallbackWithTypes)
 // or inline
-fp((fastify: FastifyInstance, options: FastifyPluginOptions, next: (error?: FastifyError) => void): void => { })
+fp((fastify: FastifyInstance, options: FastifyPluginOptions, done: (error?: FastifyError) => void): void => { })
 
 // Async
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-plugin",
-  "version": "4.5.0",
+  "version": "4.5.1",
   "description": "Plugin helper for Fastify",
   "main": "plugin.js",
   "types": "types/plugin.d.ts",
@@ -26,12 +26,12 @@
   },
   "homepage": "https://github.com/fastify/fastify-plugin#readme",
   "devDependencies": {
-    "@fastify/type-provider-typebox": "^2.3.0",
-    "@types/node": "^18.0.0",
+    "@fastify/type-provider-typebox": "^3.0.0",
+    "@types/node": "^20.1.0",
     "fastify": "^4.0.1",
     "proxyquire": "^2.1.3",
     "standard": "^17.0.0",
     "tap": "^16.0.1",
-    "tsd": "^0.25.0"
+    "tsd": "^0.28.0"
   }
 }

types/example-async.test-d.ts

@@ -0,0 +1,19 @@
+import { FastifyPluginAsync } from "fastify";
+
+type FastifyExampleAsync = FastifyPluginAsync<fastifyExampleAsync.FastifyExampleAsyncOptions>;
+
+declare namespace fastifyExampleAsync {
+
+  export interface FastifyExampleAsyncOptions {
+    foo?: 'bar'
+  }
+
+  export interface FastifyExampleAsyncPluginOptions extends FastifyExampleAsyncOptions {
+  }
+  export const fastifyExampleAsync: FastifyExampleAsync
+  export { fastifyExampleAsync as default }
+}
+
+declare function fastifyExampleAsync(...params: Parameters<FastifyExampleAsync>): ReturnType<FastifyExampleAsync>
+
+export default fastifyExampleAsync

types/example-callback.test-d.ts

@@ -0,0 +1,19 @@
+import { FastifyPluginCallback } from "fastify";
+
+type FastifyExampleCallback = FastifyPluginCallback<fastifyExampleCallback.FastifyExampleCallbackOptions>;
+
+declare namespace fastifyExampleCallback {
+
+  export interface FastifyExampleCallbackOptions {
+    foo?: 'bar'
+  }
+
+  export interface FastifyExampleCallbackPluginOptions extends FastifyExampleCallbackOptions {
+  }
+  export const fastifyExampleCallback: FastifyExampleCallback
+  export { fastifyExampleCallback as default }
+}
+
+declare function fastifyExampleCallback(...params: Parameters<FastifyExampleCallback>): ReturnType<FastifyExampleCallback>
+
+export default fastifyExampleCallback

types/plugin.d.ts

@@ -8,7 +8,9 @@ import {
   RawServerDefault,
   FastifyTypeProvider,
   FastifyTypeProviderDefault,
+  FastifyBaseLogger,
 } from 'fastify'
+import { IncomingMessage, Server, ServerResponse } from 'http'
 
 type FastifyPlugin = typeof fastifyPlugin
 
@@ -45,40 +47,16 @@ declare namespace fastifyPlugin {
  * @param fn Fastify plugin function
  * @param options Optional plugin options
  */
- declare function fastifyPlugin<
- Options extends FastifyPluginOptions,
- RawServer extends RawServerBase = RawServerDefault,
- TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault
->(
- fn: FastifyPluginAsync<Options, RawServer, TypeProvider>,
- options?: fastifyPlugin.PluginMetadata
-): FastifyPluginAsync<Options, RawServer, TypeProvider>;
-
-declare function fastifyPlugin<
- Options extends FastifyPluginOptions,
- RawServer extends RawServerBase = RawServerDefault,
- TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault
->(
- fn: FastifyPluginAsync<Options, RawServer, TypeProvider>,
- options?: string
-): FastifyPluginAsync<Options, RawServer, TypeProvider>;
-
-declare function fastifyPlugin<
- Options extends FastifyPluginOptions,
- RawServer extends RawServerBase = RawServerDefault,
- TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault
->(
- fn: FastifyPluginCallback<Options, RawServer, TypeProvider>,
- options?: fastifyPlugin.PluginMetadata
-): FastifyPluginCallback<Options, RawServer, TypeProvider>;
 
 declare function fastifyPlugin<
- Options extends FastifyPluginOptions,
- RawServer extends RawServerBase = RawServerDefault,
- TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault
+  Options extends FastifyPluginOptions = Record<never, never>,
+  RawServer extends RawServerBase = RawServerDefault,
+  TypeProvider extends FastifyTypeProvider = FastifyTypeProviderDefault,
+  Logger extends FastifyBaseLogger = FastifyBaseLogger,
+  Fn extends FastifyPluginCallback<Options, RawServer, TypeProvider, Logger> | FastifyPluginAsync<Options, RawServer, TypeProvider, Logger> = FastifyPluginCallback<Options, RawServer, TypeProvider, Logger>
 >(
- fn: FastifyPluginCallback<Options>,
- options?: string
-): FastifyPluginCallback<Options>;
+  fn: Fn extends unknown ? Fn extends (...args: any) => Promise<any> ? FastifyPluginAsync<Options, RawServer, TypeProvider, Logger> : FastifyPluginCallback<Options, RawServer, TypeProvider, Logger> : Fn,
+  options?: fastifyPlugin.PluginMetadata | string
+): Fn;
 
 export = fastifyPlugin