tests(typescript): run dedicated typescript types tests using tsd

Author: jankapunkt

.github/workflows/tests.yml

@@ -30,11 +30,29 @@ jobs:
           cache: npm
       - run: npm clean-install
       - run: npm run lint
+  types:
+    name: Typescript types check
+    needs: [lint]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          show-progress: false
+
+      - name: setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - run: npm clean-install
+      - run: npm run test:types
 
   unittest:
     name: unit tests
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [types]
     strategy:
       matrix:
         node: [16, 18, 20, 22]

index.d.ts

@@ -59,12 +59,7 @@ declare namespace OAuth2Server {
          * Instantiates Request using the supplied options.
          *
          */
-        constructor(options: {
-            headers: Record<string, string>,
-            method: string,
-            query: Record<string, string>,
-            body?: any
-        } & Record<string, any> | http.IncomingMessage);
+        constructor(options?: Record<string, any> | http.IncomingMessage);
 
         /**
          * Returns the specified HTTP header field. The match is case-insensitive.

index.test-d.ts

@@ -0,0 +1,27 @@
+import {expectType} from 'tsd';
+import express from 'express'
+import {OAuth2Server, Request, Response} from '.';
+import { Request as UndiciRequest } from 'undici';
+
+expectType<Request>(new Request());
+expectType<Request>(new Request({}));
+
+const req1 = new Request({ method: 'get', headers: { x: 'y'} });
+expectType<string>(req1.method);
+expectType<Record<string, string>>(req1.headers);
+
+// check for express request compatibility
+const expressReq = new express.Request({ method: 'get', query: { moo: 'foo' }, headers: { x: 'y'} });
+const req2 = new Request(expressReq);
+expectType<string>(req2.method);
+expectType<Record<string, string>>(req2.headers);
+expectType<Record<string, string>>(req2.query);
+
+// check for compatibility with fetch api Request
+// we use undici Request as a stand-in for fetch api Request
+// because we still support older versions of Node.js
+const undiciReq = new UndiciRequest('https://example.com', { method: 'get', headers: { x: 'y'} });
+const req3 = new Request(undiciReq);
+expectType<string>(req3.method);
+expectType<Record<string, string>>(req3.headers);
+expectType<Record<string, string>>(req3.query);