Fix types compatibility with Fastify v4.25.0 (fastify#278)

Signed-off-by: Matteo Collina <[email protected]>
synapse · Dec 14, 2023 · 9e5e8f1 · 9e5e8f1
1 parent ba185e8
commit 9e5e8f1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 45 deletions.
diff --git a/package.json b/package.json
@@ -30,7 +30,8 @@
     "@fastify/type-provider-typebox": "^3.2.0",
     "@types/node": "^20.1.0",
     "@types/ws": "^8.2.2",
-    "fastify": "^4.16.0",
+    "fastify": "^4.25.0",
+    "fastify-tsconfig": "^2.0.0",
     "split2": "^4.1.0",
     "standard": "^17.0.0",
     "tap": "^16.0.0",

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -28,7 +28,7 @@ declare module 'fastify' {
   }
 
   interface FastifyInstance<RawServer, RawRequest, RawReply, Logger, TypeProvider> {
-    get: RouteShorthandMethod<RawServer, RawRequest, RawReply, TypeProvider>,
+    get: RouteShorthandMethod<RawServer, RawRequest, RawReply, TypeProvider, Logger>,
     websocketServer: WebSocket.Server,
   }
 
@@ -108,4 +108,4 @@ declare namespace fastifyWebsocket {
 }
 
 declare function fastifyWebsocket(...params: Parameters<FastifyWebsocket>): ReturnType<FastifyWebsocket>
-export = fastifyWebsocket
+export = fastifyWebsocket
diff --git a/types/index.test-d.ts b/types/index.test-d.ts
@@ -1,12 +1,11 @@
 import fastifyWebsocket, { WebsocketHandler, SocketStream, fastifyWebsocket as namedFastifyWebsocket, default as defaultFastifyWebsocket } from '..';
 import type { IncomingMessage } from "http";
-import fastify, { RouteOptions, FastifyRequest, FastifyInstance, FastifyReply, RequestGenericInterface, FastifyBaseLogger, RawServerDefault, FastifySchema, RawRequestDefaultExpression, RawServerBase, ContextConfigDefault, RawReplyDefaultExpression } from 'fastify';
-import { expectAssignable, expectType } from 'tsd';
+import fastify, { RouteOptions, FastifyRequest, FastifyInstance, FastifyReply, RequestGenericInterface, FastifyBaseLogger, RawServerDefault, FastifySchema, RawRequestDefaultExpression } from 'fastify';
+import { expectType } from 'tsd';
 import { Server } from 'ws';
 import { RouteGenericInterface } from 'fastify/types/route';
 import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox';
-import { Static, Type } from '@sinclair/typebox'
-import { ResolveFastifyRequestType } from 'fastify/types/type-provider';
+import { Type } from '@sinclair/typebox'
 
 const app: FastifyInstance = fastify();
 app.register(fastifyWebsocket);
@@ -126,12 +125,6 @@ const schema = {
     auth: Type.String()
   })
 };
-type SchemaType = {
-  params: Static<typeof schema.params>;
-  querystring: Static<typeof schema.querystring>;
-  body: Static<typeof schema.body>;
-  headers: Static<typeof schema.headers>;
-};
 
 const server = app.withTypeProvider<TypeBoxTypeProvider>();
 
@@ -154,37 +147,6 @@ server.route({
   },
 });
 
-// server.get('/websockets-type-inference',
-//   {
-//     websocket: true,
-//     schema
-//   },
-//   async function (connection, request) {
-//     expectType<FastifyInstance>(this);
-//     expectType<SocketStream>(connection);
-//     expectType<Server>(app.websocketServer);
-//     expectType<FastifyRequest<RequestGenericInterface, RawServerDefault, IncomingMessage, SchemaType, TypeBoxTypeProvider, unknown, FastifyBaseLogger>>(request);
-//     expectType<boolean>(request.ws);
-//     expectType<{ foo: string }>(request.params);
-//     expectType<{ bar: string }>(request.body);
-//     expectType<{ search: string }>(request.query);
-//     expectType<IncomingMessage['headers'] & { auth: string }>(request.headers);
-//   });
-
-// server.get('/not-websockets-type-inference',
-//   {
-//     websocket: false,
-//     schema
-//   },
-//   async (request, reply) => {
-//     expectType<FastifyRequest<RouteGenericInterface, RawServerDefault, IncomingMessage, SchemaType, TypeBoxTypeProvider, unknown, FastifyBaseLogger, ResolveFastifyRequestType<TypeBoxTypeProvider, FastifySchema, RouteGenericInterface>>>(request);
-//     expectType<FastifyReply<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, RouteGenericInterface, ContextConfigDefault, SchemaType, TypeBoxTypeProvider>>(reply);
-//     expectType<{ foo: string }>(request.params);
-//     expectType<{ bar: string }>(request.body);
-//     expectType<{ search: string }>(request.query);
-//     expectType<IncomingMessage['headers'] & { auth: string }>(request.headers);
-//   });
-
 server.get('/websockets-no-type-inference',
   { websocket: true },
   async function (connection, request) {
@@ -201,4 +163,4 @@ server.get('/websockets-no-type-inference',
 
   expectType<typeof fastifyWebsocket>(namedFastifyWebsocket);
   expectType<typeof fastifyWebsocket>(defaultFastifyWebsocket);
-
+