Merge pull request #176 from fastify/generic-route-options

Generic route options

Author: airhorns

index.d.ts

@@ -5,10 +5,12 @@ import * as fastify from 'fastify';
 import * as WebSocket from 'ws';
 import { Duplex } from 'stream';
 import { FastifyReply } from 'fastify/types/reply';
+import { RouteGenericInterface } from 'fastify/types/route';
 
-interface WebsocketRouteOptions {
-  wsHandler?: WebsocketHandler
+interface WebsocketRouteOptions<RawServer extends RawServerBase = RawServerDefault, RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>, RequestGeneric extends RequestGenericInterface = RequestGenericInterface> {
+  wsHandler?: WebsocketHandler<RawServer, RawRequest, RequestGeneric>;
 }
+
 declare module 'fastify' {
   interface RouteShorthandOptions<
     RawServer extends RawServerBase = RawServerDefault
@@ -33,13 +35,12 @@ declare module 'fastify' {
     ): FastifyInstance<RawServer, RawRequest, RawReply>;
   }
 
-  interface RouteOptions extends WebsocketRouteOptions {}
+  interface RouteOptions<RawServer extends RawServerBase = RawServerDefault, RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>, RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>, RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault,SchemaCompiler = fastify.FastifySchema> extends WebsocketRouteOptions<RawServer, RawRequest, RouteGeneric> {}
 }
 
 declare const websocketPlugin: FastifyPluginCallback<WebsocketPluginOptions>;
 
-interface WebSocketServerOptions extends Omit<WebSocket.ServerOptions, 'path'> {}
-
+interface WebSocketServerOptions extends Omit<WebSocket.ServerOptions, "path"> {}
 
 export type WebsocketHandler<
   RawServer extends RawServerBase = RawServerDefault,
@@ -60,6 +61,6 @@ export interface WebsocketPluginOptions {
   options?: WebSocketServerOptions;
 }
 
-export interface RouteOptions extends fastify.RouteOptions, WebsocketRouteOptions {}
+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, SchemaCompiler = fastify.FastifySchema> extends fastify.RouteOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler>, WebsocketRouteOptions<RawServer, RawRequest, RouteGeneric> {}
 
 export default websocketPlugin;

test/types/index.test-d.ts

@@ -1,7 +1,9 @@
 import wsPlugin, { WebsocketHandler, SocketStream } from '../..';
+import type {IncomingMessage} from "http";
 import fastify, { RouteOptions, FastifyRequest, FastifyInstance, FastifyReply, RequestGenericInterface } from 'fastify';
 import { expectType } from 'tsd';
 import { Server } from 'ws';
+import { RouteGenericInterface } from 'fastify/types/route';
 
 const app: FastifyInstance = fastify();
 app.register(wsPlugin);
@@ -18,7 +20,7 @@ app.register(wsPlugin, {
 });
 app.register(wsPlugin, { options: { perMessageDeflate: true } });
 
-app.get('/websockets-via-inferrence', { websocket: true }, async function(connection, request) {
+app.get('/websockets-via-inferrence', { websocket: true }, async function (connection, request) {
   expectType<FastifyInstance>(this);
   expectType<SocketStream>(connection);
   expectType<Server>(app.websocketServer);
@@ -52,7 +54,7 @@ app.route({
   },
   wsHandler: (connection, request) => {
     expectType<SocketStream>(connection);
-    expectType<FastifyRequest<RequestGenericInterface>>(request);
+    expectType<FastifyRequest<RouteGenericInterface>>(request);
   },
 });
 
@@ -65,7 +67,37 @@ const augmentedRouteOptions: RouteOptions = {
   },
   wsHandler: (connection, request) => {
     expectType<SocketStream>(connection);
-    expectType<FastifyRequest<RequestGenericInterface>>(request)
+    expectType<FastifyRequest<RouteGenericInterface>>(request)
   },
 };
 app.route(augmentedRouteOptions);
+
+
+app.get<{ Params: { foo: string }, Body: { bar: string }, Querystring: { search: string }, Headers: { auth: string } }>('/shorthand-explicit-types', {
+  websocket: true
+}, async (connection, request) => {
+  expectType<SocketStream>(connection);
+  expectType<{ foo: string }>(request.params);
+  expectType<{ bar: string }>(request.body);
+  expectType<{ search: string }>(request.query);
+  expectType< IncomingMessage['headers'] & { auth: string }>(request.headers);
+});
+
+
+app.route<{ Params: { foo: string }, Body: { bar: string }, Querystring: { search: string }, Headers: { auth: string } }>({
+  method: 'GET',
+  url: '/longhand-explicit-types',
+  handler: (request, _reply) => {
+    expectType<{ foo: string }>(request.params);
+    expectType<{ bar: string }>(request.body);
+    expectType<{ search: string }>(request.query);
+    expectType<IncomingMessage['headers'] & {  auth: string }>(request.headers);
+  },
+  wsHandler: (connection, request) => {
+    expectType<SocketStream>(connection);
+    expectType<{ foo: string }>(request.params);
+    expectType<{ bar: string }>(request.body);
+    expectType<{ search: string }>(request.query);
+    expectType<IncomingMessage['headers'] & { auth: string }>(request.headers);
+  },
+});