fastify 5.5.0 → 5.6.0

package/docs/Reference/Routes.md

@@ -636,8 +636,7 @@ has a version set, and will prefer a versioned route to a non-versioned route
 for the same path. Advanced version ranges and pre-releases currently are not
 supported.
 
-*Be aware that using this feature will cause a degradation of the overall
-performances of the router.*
+> **Note:** using this feature can degrade the router’s performance.
 
 ```js
 fastify.route({

package/docs/Reference/TypeScript.md

@@ -147,7 +147,7 @@ route-level `request` object.
      reply.code(200).send('uh-oh');
      // it even works for wildcards
      reply.code(404).send({ error: 'Not found' });
-     return `logged in!`
+     return { success: true }
    })
    ```
 
@@ -173,7 +173,7 @@ route-level `request` object.
    }, async (request, reply) => {
      const customerHeader = request.headers['h-Custom']
      // do something with request data
-     return `logged in!`
+     return { success: true }
    })
    ```
 7. Build and run and query with the `username` query string option set to

package/fastify.d.ts

@@ -89,6 +89,22 @@ declare namespace fastify {
 
   type TrustProxyFunction = (address: string, hop: number) => boolean
 
+  export type FastifyRouterOptions<RawServer extends RawServerBase> = {
+    allowUnsafeRegex?: boolean,
+    buildPrettyMeta?: (route: { [k: string]: unknown, store: { [k: string]: unknown } }) => object,
+    caseSensitive?: boolean,
+    constraints?: {
+      [name: string]: ConstraintStrategy<FindMyWayVersion<RawServer>, unknown>,
+    },
+    defaultRoute?: (req: FastifyRequest, res: FastifyReply) => void,
+    ignoreDuplicateSlashes?: boolean,
+    ignoreTrailingSlash?: boolean,
+    maxParamLength?: number,
+    onBadUrl?: (path: string, req: FastifyRequest, res: FastifyReply) => void,
+    querystringParser?: (str: string) => { [key: string]: unknown },
+    useSemicolonDelimiter?: boolean,
+  }
+
   /**
    * Options for a fastify server instance. Utilizes conditional logic on the generic server parameter to enforce certain https and http2
    */
@@ -159,6 +175,7 @@ declare namespace fastify {
     clientErrorHandler?: (error: ConnectionError, socket: Socket) => void,
     childLoggerFactory?: FastifyChildLoggerFactory,
     allowErrorHandlerOverride?: boolean
+    routerOptions?: FastifyRouterOptions<RawServer>,
   }
 
   /**

package/fastify.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const VERSION = '5.5.0'
+const VERSION = '5.6.0'
 
 const Avvio = require('avvio')
 const http = require('node:http')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify",
-  "version": "5.5.0",
+  "version": "5.6.0",
   "description": "Fast and low overhead web framework, for Node.js",
   "main": "fastify.js",
   "type": "commonjs",

package/test/types/instance.test-d.ts

@@ -15,6 +15,8 @@ import { FastifyRequest } from '../../types/request'
 import { FastifySchemaControllerOptions, FastifySchemaCompiler, FastifySerializerCompiler } from '../../types/schema'
 import { AddressInfo } from 'node:net'
 import { Bindings, ChildLoggerOptions } from '../../types/logger'
+import { ConstraintStrategy } from 'find-my-way'
+import { FindMyWayVersion } from '../../types/instance'
 
 const server = fastify()
 
@@ -309,7 +311,22 @@ type InitialConfig = Readonly<{
   requestIdHeader?: string | false,
   requestIdLogLabel?: string,
   http2SessionTimeout?: number,
-  useSemicolonDelimiter?: boolean
+  useSemicolonDelimiter?: boolean,
+  routerOptions?: {
+    allowUnsafeRegex?: boolean,
+    buildPrettyMeta?: (route: { [k: string]: unknown, store: { [k: string]: unknown } }) => object,
+    caseSensitive?: boolean,
+    constraints?: {
+      [name: string]: ConstraintStrategy<FindMyWayVersion<RawServerDefault>, unknown>
+    }
+    defaultRoute?: (req: FastifyRequest, res: FastifyReply) => void,
+    ignoreDuplicateSlashes?: boolean,
+    ignoreTrailingSlash?: boolean,
+    maxParamLength?: number,
+    onBadUrl?: (path: string, req: FastifyRequest, res: FastifyReply) => void,
+    querystringParser?: (str: string) => { [key: string]: unknown },
+    useSemicolonDelimiter?: boolean,
+  }
 }>
 
 expectType<InitialConfig>(fastify().initialConfig)

package/types/instance.d.ts

@@ -23,6 +23,7 @@ import {
   SafePromiseLike
 } from './type-provider'
 import { ContextConfigDefault, HTTPMethods, RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerBase, RawServerDefault } from './utils'
+import { FastifyRouterOptions } from '../fastify'
 
 export interface PrintRoutesOptions {
   method?: HTTPMethods;
@@ -603,5 +604,6 @@ export interface FastifyInstance<
     requestIdLogLabel?: string,
     http2SessionTimeout?: number,
     useSemicolonDelimiter?: boolean,
+    routerOptions?: FastifyRouterOptions<RawServer>
   }>
 }

package/types/logger.d.ts

@@ -7,20 +7,24 @@ import { FastifySchema } from './schema'
 import { FastifyTypeProvider, FastifyTypeProviderDefault } from './type-provider'
 import { ContextConfigDefault, RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerBase, RawServerDefault } from './utils'
 
-import pino from 'pino'
+import type {
+  BaseLogger,
+  LogFn as FastifyLogFn,
+  LevelWithSilent as LogLevel,
+  Bindings,
+  ChildLoggerOptions,
+  LoggerOptions as PinoLoggerOptions
+} from 'pino'
 
-/**
- * Standard Fastify logging function
- */
-export type FastifyLogFn = pino.LogFn
-
-export type LogLevel = pino.LevelWithSilent
-
-export type Bindings = pino.Bindings
-
-export type ChildLoggerOptions = pino.ChildLoggerOptions
+export type {
+  FastifyLogFn,
+  LogLevel,
+  Bindings,
+  ChildLoggerOptions,
+  PinoLoggerOptions
+}
 
-export interface FastifyBaseLogger extends pino.BaseLogger {
+export interface FastifyBaseLogger extends Pick<BaseLogger, 'level' | 'info' | 'error' | 'debug' | 'fatal' | 'warn' | 'trace' | 'silent'> {
   child(bindings: Bindings, options?: ChildLoggerOptions): FastifyBaseLogger
 }
 
@@ -34,8 +38,6 @@ export interface FastifyLoggerStreamDestination {
   write(msg: string): void;
 }
 
-export type PinoLoggerOptions = pino.LoggerOptions
-
 // TODO: once node 18 is EOL, this type can be replaced with plain FastifyReply.
 /**
  * Specialized reply type used for the `res` log serializer, since only `statusCode` is passed in certain cases.

package/.vscode/settings.json

@@ -1,22 +0,0 @@
-{
-  "workbench.colorCustomizations": {
-    "[GitHub Dark]": {
-      "tab.activeBackground": "#0d0d0d",
-      "tab.activeBorder": "#ffff00"
-    },
-    "activityBar.background": "#FBE7B2",
-    "activityBar.foreground": "#52358C",
-    "activityBar.inactiveForeground": "#616161",
-    "activityBar.activeBorder": "#04184d",
-    "activityBar.activeBackground": "#C3B48B",
-    "activityBar.border": "#C3B48B",
-    "titleBar.activeBackground": "#D2BE88",
-    "titleBar.activeForeground": "#52358C",
-    "titleBar.inactiveBackground": "#bdb59c",
-    "titleBar.inactiveForeground": "#616161",
-    "titleBar.border": "#C3B48B",
-    "statusBar.background": "#E9DBB7",
-    "statusBar.foreground": "#52358C",
-    "statusBar.border": "#C3B48B"
-  }
-}