fastify 3.19.1 → 3.20.2

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

@@ -1,7 +1,7 @@
 import { expectType, expectError } from 'tsd'
 import fastify, { FastifyLogFn, LogLevel, FastifyLoggerInstance, FastifyError, FastifyRequest, FastifyReply } from '../../fastify'
 import { Server, IncomingMessage, ServerResponse } from 'http'
-import * as pino from 'pino'
+import pino from 'pino'
 import * as fs from 'fs'
 
 expectType<FastifyLoggerInstance>(fastify().log)
@@ -75,6 +75,19 @@ ServerResponse
 
 expectType<FastifyLoggerInstance>(serverWithLogOptions.log)
 
+const serverWithFileOption = fastify<
+Server,
+IncomingMessage,
+ServerResponse
+>({
+  logger: {
+    level: 'info',
+    file: '/path/to/file'
+  }
+})
+
+expectType<FastifyLoggerInstance>(serverWithFileOption.log)
+
 const serverAutoInferringTypes = fastify({
   logger: {
     level: 'info'
@@ -92,6 +105,15 @@ const serverWithAutoInferredPino = fastify({
 
 expectType<pino.Logger>(serverWithAutoInferredPino.log)
 
+const serverAutoInferredFileOption = fastify({
+  logger: {
+    level: 'info',
+    file: '/path/to/file'
+  }
+})
+
+expectType<FastifyLoggerInstance>(serverAutoInferredFileOption.log)
+
 const serverAutoInferredPinoPrettyBooleanOption = fastify({
   logger: {
     prettyPrint: true

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

@@ -3,6 +3,7 @@ import fastify, { RouteHandlerMethod, RouteHandler, RawRequestDefaultExpression,
 import { RawServerDefault, RawReplyDefaultExpression, ContextConfigDefault } from '../../types/utils'
 import { FastifyLoggerInstance } from '../../types/logger'
 import { RouteGenericInterface } from '../../types/route'
+import { FastifyInstance } from '../../types/instance'
 
 const getHandler: RouteHandlerMethod = function (_request, reply) {
   expectType<RawReplyDefaultExpression>(reply.raw)
@@ -29,6 +30,7 @@ const getHandler: RouteHandlerMethod = function (_request, reply) {
   expectType<(fn: (payload: any) => string) => FastifyReply>(reply.serializer)
   expectType<(payload: any) => string>(reply.serialize)
   expectType<(fulfilled: () => void, rejected: (err: Error) => void) => void>(reply.then)
+  expectType<FastifyInstance>(reply.server)
 }
 
 interface ReplyPayload {

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

@@ -4,6 +4,7 @@ import { RawServerDefault, RequestParamsDefault, RequestHeadersDefault, RequestQ
 import { FastifyLoggerInstance } from '../../types/logger'
 import { FastifyRequest } from '../../types/request'
 import { FastifyReply } from '../../types/reply'
+import { FastifyInstance } from '../../types/instance'
 
 interface RequestBody {
   content: string;
@@ -55,6 +56,7 @@ const getHandler: RouteHandler = function (request, _reply) {
   expectType<FastifyLoggerInstance>(request.log)
   expectType<RawRequestDefaultExpression['socket']>(request.socket)
   expectType<Error & { validation: any; validationContext: string } | undefined>(request.validationError)
+  expectType<FastifyInstance>(request.server)
 }
 
 const postHandler: Handler = function (request) {
@@ -66,6 +68,7 @@ const postHandler: Handler = function (request) {
   expectType<string>(request.query.from)
   expectType<number>(request.params.id)
   expectType<string>(request.headers['x-foobar'])
+  expectType<FastifyInstance>(request.server)
 }
 
 function putHandler (request: CustomRequest, reply: FastifyReply) {
@@ -77,6 +80,7 @@ function putHandler (request: CustomRequest, reply: FastifyReply) {
   expectType<string>(request.query.from)
   expectType<number>(request.params.id)
   expectType<string>(request.headers['x-foobar'])
+  expectType<FastifyInstance>(request.server)
 }
 
 const server = fastify()

package/types/content-type-parser.d.ts

@@ -60,3 +60,7 @@ export type ProtoAction = 'error' | 'remove' | 'ignore'
 export type ConstructorAction = 'error' | 'remove' | 'ignore'
 
 export type getDefaultJsonParser = (onProtoPoisoning: ProtoAction, onConstructorPoisoning: ConstructorAction) => FastifyBodyParser<string>
+
+export type removeContentTypeParser = (contentType: string | RegExp | (string | RegExp)[]) => void
+
+export type removeAllContentTypeParsers = () => void

package/types/instance.d.ts

@@ -8,7 +8,13 @@ import { onRequestHookHandler, preParsingHookHandler, onSendHookHandler, preVali
 import { FastifyRequest } from './request'
 import { FastifyReply } from './reply'
 import { FastifyError } from 'fastify-error'
-import { AddContentTypeParser, hasContentTypeParser, getDefaultJsonParser, ProtoAction, ConstructorAction, FastifyBodyParser } from './content-type-parser'
+import { AddContentTypeParser, hasContentTypeParser, getDefaultJsonParser, ProtoAction, ConstructorAction, FastifyBodyParser, removeContentTypeParser, removeAllContentTypeParsers } from './content-type-parser'
+
+export interface PrintRoutesOptions {
+  includeMeta?: boolean | (string | symbol)[]
+  commonPrefix?: boolean
+  includeHooks?: boolean
+}
 
 /**
  * Fastify server instance. Returned by the core `fastify()` method.
@@ -34,10 +40,27 @@ export interface FastifyInstance<
   close(): FastifyInstance<RawServer, RawRequest, RawReply, Logger> & PromiseLike<undefined>;
   close(closeListener: () => void): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
 
-  // should be able to define something useful with the decorator getter/setter pattern using Generics to enfore the users function returns what they expect it to
-  decorate(property: string | symbol, value: any, dependencies?: string[]): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
-  decorateRequest(property: string | symbol, value: any, dependencies?: string[]): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
-  decorateReply(property: string | symbol, value: any, dependencies?: string[]): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
+  // should be able to define something useful with the decorator getter/setter pattern using Generics to enforce the users function returns what they expect it to
+  decorate<T>(property: string | symbol,
+    value: T extends (...args: any[]) => any
+      ? (this: FastifyInstance<RawServer, RawRequest, RawReply, Logger>, ...args: Parameters<T>) => ReturnType<T>
+      : T,
+    dependencies?: string[]
+  ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
+
+  decorateRequest<T>(property: string | symbol,
+    value: T extends (...args: any[]) => any
+      ? (this: FastifyRequest, ...args: Parameters<T>) => ReturnType<T>
+      : T,
+    dependencies?: string[]
+  ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
+
+  decorateReply<T>(property: string | symbol,
+    value: T extends (...args: any[]) => any
+      ? (this: FastifyReply, ...args: Parameters<T>) => ReturnType<T>
+      : T,
+    dependencies?: string[]
+  ): FastifyInstance<RawServer, RawRequest, RawReply, Logger>;
 
   hasDecorator(decorator: string | symbol): boolean;
   hasRequestDecorator(decorator: string | symbol): boolean;
@@ -360,6 +383,14 @@ export interface FastifyInstance<
    */
   addContentTypeParser: AddContentTypeParser<RawServer, RawRequest>;
   hasContentTypeParser: hasContentTypeParser;
+  /**
+   * Remove an existing content type parser
+   */
+  removeContentTypeParser: removeContentTypeParser
+  /**
+   * Remove all content type parsers, including the default ones
+   */
+  removeAllContentTypeParsers: removeAllContentTypeParsers
   /**
    * Fastify default JSON parser
    */
@@ -372,7 +403,7 @@ export interface FastifyInstance<
   /**
    * Prints the representation of the internal radix tree used by the router
    */
-  printRoutes(): string;
+  printRoutes(opts?: PrintRoutesOptions): string;
 
   /**
    * Prints the representation of the plugin tree used by avvio, the plugin registration system

package/types/logger.d.ts

@@ -145,6 +145,7 @@ export interface FastifyLoggerOptions<
     };
   };
   level?: string;
+  file?: string;
   genReqId?: (req: RawRequest) => string;
   prettyPrint?: boolean | PrettyOptions;
   stream?: FastifyLoggerStreamDestination;

package/types/reply.d.ts

@@ -3,6 +3,7 @@ import { FastifyContext } from './context'
 import { FastifyLoggerInstance } from './logger'
 import { FastifyRequest } from './request'
 import { RouteGenericInterface } from './route'
+import { FastifyInstance } from './instance'
 
 export interface ReplyGenericInterface {
   Reply?: ReplyDefault;
@@ -23,6 +24,7 @@ export interface FastifyReply<
   context: FastifyContext<ContextConfig>;
   log: FastifyLoggerInstance;
   request: FastifyRequest<RouteGeneric, RawServer, RawRequest>;
+  server: FastifyInstance;
   code(statusCode: number): FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>;
   status(statusCode: number): FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>;
   statusCode: number;

package/types/request.d.ts

@@ -1,6 +1,7 @@
 import { FastifyLoggerInstance } from './logger'
 import { RawServerBase, RawServerDefault, RawRequestDefaultExpression, RequestBodyDefault, RequestQuerystringDefault, RequestParamsDefault, RequestHeadersDefault } from './utils'
 import { RouteGenericInterface } from './route'
+import { FastifyInstance } from './instance'
 
 export interface RequestGenericInterface {
   Body?: RequestBodyDefault;
@@ -23,6 +24,7 @@ export interface FastifyRequest<
   raw: RawRequest;
   query: RouteGeneric['Querystring'];
   log: FastifyLoggerInstance;
+  server: FastifyInstance;
   body: RouteGeneric['Body'];
 
   /** in order for this to be used the user should ensure they have set the attachValidation option. */