fastify 3.5.0 → 3.8.0

package/types/route.d.ts

@@ -9,49 +9,6 @@ import { FastifyError } from 'fastify-error'
 
 export interface RouteGenericInterface extends RequestGenericInterface, ReplyGenericInterface {}
 
-/**
- * Fastify Router Shorthand method type that is similar to the Express/Restify approach
- */
-export interface RouteShorthandMethod<
-  RawServer extends RawServerBase = RawServerDefault,
-  RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
-  RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
-> {
-  <RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault>(
-    path: string,
-    opts: RouteShorthandOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
-    handler: RouteHandlerMethod<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
-  ): FastifyInstance<RawServer, RawRequest, RawReply>;
-}
-
-/**
- * Fastify Router Shorthand method type that is similar to the Express/Restify approach
- */
-export interface RouteShorthandMethod<
-  RawServer extends RawServerBase = RawServerDefault,
-  RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
-  RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
-> {
-  <RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault>(
-    path: string,
-    handler: RouteHandlerMethod<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
-  ): FastifyInstance<RawServer, RawRequest, RawReply>;
-}
-
-/**
- * Fastify Router Shorthand method type that is similar to the Express/Restify approach
- */
-export interface RouteShorthandMethod<
-  RawServer extends RawServerBase = RawServerDefault,
-  RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
-  RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
-> {
-  <RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault>(
-    path: string,
-    opts: RouteShorthandOptionsWithHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
-  ): FastifyInstance<RawServer, RawRequest, RawReply>;
-}
-
 /**
  * Route shorthand options for the various shorthand methods
  */
@@ -70,7 +27,7 @@ export interface RouteShorthandOptions<
   logLevel?: LogLevel;
   config?: ContextConfig;
   version?: string;
-  prefixTrailingSlash?: boolean;
+  prefixTrailingSlash?: 'slash'|'no-slash'|'both';
   errorHandler?: (this: FastifyInstance, error: FastifyError, request: FastifyRequest, reply: FastifyReply) => void;
   // TODO: Change to actual type.
   schemaErrorFormatter?: (errors: FastifySchemaValidationError[], dataVar: string) => Error;
@@ -88,19 +45,19 @@ export interface RouteShorthandOptions<
 }
 
 /**
- * Fastify route method options.
+ * Route handler method declaration.
  */
-export interface RouteOptions<
+export type RouteHandlerMethod<
   RawServer extends RawServerBase = RawServerDefault,
   RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
   RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
   RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
   ContextConfig = ContextConfigDefault
-> extends RouteShorthandOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig> {
-  method: HTTPMethods | HTTPMethods[];
-  url: string;
-  handler: RouteHandlerMethod<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>;
-}
+> = (
+  this: FastifyInstance<RawServer, RawRequest, RawReply>,
+  request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
+  reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
+) => void | Promise<RouteGeneric['Reply'] | void>
 
 /**
  * Shorthand options including the handler function property
@@ -116,19 +73,42 @@ export interface RouteShorthandOptionsWithHandler<
 }
 
 /**
- * Route handler method declaration.
+ * Fastify Router Shorthand method type that is similar to the Express/Restify approach
  */
-export type RouteHandlerMethod<
+export interface RouteShorthandMethod<
+  RawServer extends RawServerBase = RawServerDefault,
+  RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
+  RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
+> {
+  <RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault>(
+    path: string,
+    opts: RouteShorthandOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>,
+    handler: RouteHandlerMethod<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
+  ): FastifyInstance<RawServer, RawRequest, RawReply>;
+  <RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault>(
+    path: string,
+    handler: RouteHandlerMethod<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
+  ): FastifyInstance<RawServer, RawRequest, RawReply>;
+  <RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault>(
+    path: string,
+    opts: RouteShorthandOptionsWithHandler<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
+  ): FastifyInstance<RawServer, RawRequest, RawReply>;
+}
+
+/**
+ * Fastify route method options.
+ */
+export interface RouteOptions<
   RawServer extends RawServerBase = RawServerDefault,
   RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
   RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>,
   RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
   ContextConfig = ContextConfigDefault
-> = (
-  this: FastifyInstance<RawServer, RawRequest, RawReply>,
-  request: FastifyRequest<RouteGeneric, RawServer, RawRequest>,
-  reply: FastifyReply<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>
-) => void | Promise<RouteGeneric['Reply'] | void>
+> extends RouteShorthandOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig> {
+  method: HTTPMethods | HTTPMethods[];
+  url: string;
+  handler: RouteHandlerMethod<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig>;
+}
 
 export type RouteHandler<
   RouteGeneric extends RouteGenericInterface = RouteGenericInterface,

package/types/schema.d.ts

@@ -20,15 +20,15 @@ export interface FastifyRouteSchemaDef {
   httpStatus?: string;
 }
 
-export interface FastifyValidationResult {
-  errors?: FastifySchemaValidationError[] | null;
-}
-
 export interface FastifySchemaValidationError {
   message?: string;
   dataPath: string;
 }
 
+export interface FastifyValidationResult {
+  errors?: FastifySchemaValidationError[] | null;
+}
+
 /**
  * Compiler for FastifySchema Type
  */

package/types/serverFactory.d.ts

@@ -3,17 +3,17 @@ import * as http from 'http'
 import * as https from 'https'
 import * as http2 from 'http2'
 
-export interface FastifyServerFactory<
-  RawServer extends RawServerBase = RawServerDefault
-> {
-  (handler: FastifyServerFactoryHandler<RawServer>, opts: object): RawServer;
-}
-
 export type FastifyServerFactoryHandler<
   RawServer extends RawServerBase = RawServerDefault,
   RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>,
   RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>
 > =
-  RawServer extends http.Server | https.Server ?
-    (request: http.IncomingMessage & RawRequest, response: http.ServerResponse & RawReply) => void :
-    (request: http2.Http2ServerRequest & RawRequest, response: http2.Http2ServerResponse & RawReply) => void
+RawServer extends http.Server | https.Server ?
+  (request: http.IncomingMessage & RawRequest, response: http.ServerResponse & RawReply) => void :
+  (request: http2.Http2ServerRequest & RawRequest, response: http2.Http2ServerResponse & RawReply) => void
+
+export interface FastifyServerFactory<
+  RawServer extends RawServerBase = RawServerDefault
+> {
+  (handler: FastifyServerFactoryHandler<RawServer>, opts: Record<string, unknown>): RawServer;
+}