refactor(types): migrate from tsd to tstyche (#243)

Author: Tony133

package.json

@@ -15,7 +15,7 @@
   "scripts": {
     "test": "npm run test:unit && npm run test:typescript",
     "test:unit": "c8 --100 node --test",
-    "test:typescript": "tsd",
+    "test:typescript": "tstyche",
     "lint": "eslint",
     "lint:fix": "eslint --fix"
   },
@@ -29,7 +29,7 @@
     "fastify": "^5.0.0",
     "neostandard": "^0.13.0",
     "superagent": "^10.0.0",
-    "tsd": "^0.33.0"
+    "tstyche": "^7.0.0"
   },
   "homepage": "http://github.com/fastify/fastify-request-context",
   "funding": [
@@ -71,4 +71,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

tsconfig.json

@@ -1,14 +1,14 @@
 {
   "compilerOptions": {
     "outDir": "dist",
-    "module": "commonjs",
+    "rootDir": ".",
+    "module": "node16",
     "target": "es2022",
     "sourceMap": true,
     "declaration": true,
     "declarationMap": false,
-    "types": ["node"],
     "strict": true,
-    "moduleResolution": "node",
+    "moduleResolution": "node16",
     "noUnusedLocals": false,
     "noUnusedParameters": false,
     "noFallthroughCasesInSwitch": true,
@@ -20,7 +20,9 @@
     "allowSyntheticDefaultImports": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
-    "exactOptionalPropertyTypes": true
+    "exactOptionalPropertyTypes": true,
+    "types": ["node"]
   },
+  "include": ["types/**/*", "index.d.ts"],
   "exclude": ["node_modules", "test", "dist"]
 }

types/index.test-d.ts

@@ -0,0 +1,88 @@
+import {
+  requestContext,
+  asyncLocalStorage,
+  fastifyRequestContext,
+  FastifyRequestContextOptions,
+  RequestContext,
+  RequestContextDataFactory,
+} from '..'
+import { expect } from 'tstyche'
+import { fastify, FastifyBaseLogger, FastifyInstance, RouteHandlerMethod, FastifyRequest } from 'fastify'
+import { AsyncLocalStorage } from 'node:async_hooks'
+
+const app: FastifyInstance = fastify()
+app.register(fastifyRequestContext)
+
+declare module '..' {
+  interface RequestContextData {
+    a?: string
+    log?: FastifyBaseLogger
+  }
+}
+
+expect<FastifyRequestContextOptions>().type.toBeAssignableFrom({})
+
+expect<FastifyRequestContextOptions>().type.toBeAssignableFrom({
+  defaultStoreValues: { a: 'dummy' },
+})
+
+expect<FastifyRequestContextOptions>().type.toBeAssignableFrom({
+  hook: 'preValidation' as const,
+  defaultStoreValues: { a: 'dummy' },
+})
+
+expect<FastifyRequestContextOptions>().type.toBeAssignableFrom({
+  defaultStoreValues: () => ({
+    a: 'dummy',
+  }),
+})
+
+expect<FastifyRequestContextOptions>().type.not.toBeAssignableFrom({
+  defaultStoreValues: { bar: 'dummy' },
+})
+
+expect<FastifyRequestContextOptions>().type.not.toBeAssignableFrom({
+  defaultStoreValues: { log: 'dummy' },
+})
+
+expect<RequestContextDataFactory>().type.toBeAssignableFrom(() => ({
+  a: 'dummy',
+}))
+
+expect<FastifyRequestContextOptions>().type.toBeAssignableFrom({
+  defaultStoreValues: (req: FastifyRequest) => ({
+    log: req.log.child({ childLog: true }),
+  }),
+})
+
+expect<RequestContextDataFactory>().type.toBeAssignableFrom((req: FastifyRequest) => ({
+  log: req.log.child({ childLog: true }),
+}))
+
+expect<RequestContextDataFactory>().type.not.toBeAssignableFrom(() => ({ bar: 'dummy' }))
+
+expect<RequestContextDataFactory>().type.not.toBeAssignableFrom(() => ({ log: 'dummy' }))
+
+expect(app.requestContext).type.toBe<RequestContext>()
+expect(requestContext).type.toBe<RequestContext>()
+expect(asyncLocalStorage).type.toBe<AsyncLocalStorage<RequestContext>>()
+
+const getHandler: RouteHandlerMethod = function (request, _reply) {
+  expect(request.requestContext).type.toBe<RequestContext>()
+}
+expect(getHandler).type.toBe<RouteHandlerMethod>()
+
+expect(requestContext.get('a')).type.toBe<string | undefined>()
+expect(requestContext.get('log')).type.toBe<FastifyBaseLogger | undefined>()
+
+// @ts-expect-error: Argument of type '"bar"' is not assignable
+requestContext.get('bar')
+
+requestContext.set('a', undefined)
+
+// @ts-expect-error: Argument of type 'number' is not assignable
+requestContext.set('a', 123)
+
+expect<FastifyRequestContextOptions>().type.not.toBeAssignableFrom({
+  defaultStoreValues: { a: undefined },
+})