Make @types/supertest dependency optional

Author: davidje13

README.md

@@ -15,15 +15,15 @@ npm install --save-dev superwstest
 You can also optionally install supertest for access to `.get`, `.post`, etc.:
 
 ```bash
-npm install --save-dev superwstest supertest
+npm install --save-dev superwstest supertest @types/supertest
 ```
 
 ## Usage
 
 ### Example server implementation
 
 ```javascript
-import http from 'http';
+import http from 'node:http';
 import WebSocket from 'ws';
 
 const server = http.createServer();
@@ -744,7 +744,7 @@ this reason supertest has become optional and not included by default
 To restore the ability to use `.get`, `.post`, etc. simply run:
 
 ```shell
-npm install --save-dev supertest
+npm install --save-dev supertest @types/supertest
 ```
 
 The presence of this package will detected automatically and the supertest

index.d.ts

@@ -1,8 +1,13 @@
 declare module 'superwstest' {
-  import type { Server } from 'net';
-  import type { ClientRequestArgs, IncomingMessage } from 'http';
+  import type { Server } from 'node:net';
+  import type { ClientRequestArgs, IncomingMessage } from 'node:http';
   import type { WebSocket, ClientOptions, WebSocketServer } from 'ws';
-  import type { SuperTest, Test } from 'supertest';
+
+  // import SuperTest type if available, else fall-back to SuperTest = {}
+  // @ts-ignore
+  import type { SuperTest as MaybeSuperTest } from 'supertest';
+  type IfKnown<T, Fallback> = 0 extends 1 & T ? Fallback : T;
+  type SuperTest = IfKnown<MaybeSuperTest, {}>;
 
   type JsonObject = { [member: string]: JsonValue };
   interface JsonArray extends Array<JsonValue> {}
@@ -120,7 +125,7 @@ declare module 'superwstest' {
     expectConnectionError(expectedCode?: number | string | null | undefined): Promise<WebSocket>;
   }
 
-  export interface SuperWSTest extends SuperTest<Test> {
+  export interface SuperWSTest extends SuperTest {
     ws(path: string, options?: ClientOptions | ClientRequestArgs | undefined): WSChain;
     ws(
       path: string,

package.json

@@ -35,21 +35,24 @@
   },
   "homepage": "https://github.com/davidje13/superwstest#readme",
   "dependencies": {
-    "@types/supertest": "*",
     "@types/ws": "7.x || 8.x",
     "ws": "7.x || 8.x"
   },
   "peerDependencies": {
+    "@types/supertest": "*",
     "supertest": "*"
   },
   "peerDependenciesMeta": {
+    "@types/supertest": {
+      "optional": true
+    },
     "supertest": {
       "optional": true
     }
   },
   "devDependencies": {
     "lean-test": "2.x",
-    "prettier": "3.6.2",
+    "prettier": "3.8.3",
     "rollup": "4.x"
   }
 }

test/package-no-supertest/.npmrc

@@ -0,0 +1,2 @@
+package-lock=false
+ignore-scripts=true

test/package-no-supertest/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "superwstest-without-supertest-package-test",
+  "private": true,
+  "scripts": {
+    "test": "tsc"
+  },
+  "devDependencies": {
+    "@types/node": "24.x",
+    "superwstest": "file:superwstest.tgz",
+    "typescript": "6.0.x"
+  }
+}

test/package-no-supertest/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "types": ["node"],
+
+    "strict": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+
+    "lib": ["es2022"],
+    "target": "es2022",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "noEmit": true
+  },
+  "typeAcquisition": {
+    "enable": false
+  },
+  "include": ["typescript.ts"]
+}

test/package-no-supertest/typescript.ts

@@ -0,0 +1,12 @@
+import request from 'superwstest';
+
+// this file just checks types; the code is not executed
+
+request('hello')
+  .ws('foo')
+  .send('hi')
+  .exec((ws) => ws.ping('blah'))
+  .close();
+
+// @ts-expect-error
+request('hello').get('/hi');

test/package/package.json

@@ -2,11 +2,13 @@
   "name": "superwstest-package-test",
   "private": true,
   "scripts": {
-    "test": "node commonjs.js && node es6modules.mjs && tsc typescript.ts --noEmit"
+    "test": "node commonjs.js && node es6modules.mjs && tsc"
   },
   "devDependencies": {
+    "@types/node": "24.x",
+    "@types/supertest": "7.x",
     "superwstest": "file:superwstest.tgz",
     "supertest": "7.x",
-    "typescript": "5.8.x"
+    "typescript": "6.0.x"
   }
 }

test/package/tsconfig.json

@@ -1,8 +1,30 @@
 {
   "compilerOptions": {
+    "types": ["node"],
+
     "strict": true,
-    "noImplicitAny": true
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+
+    "lib": ["es2022"],
+    "target": "es2022",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "noEmit": true
   },
-  "include": ["**/*"],
-  "exclude": ["node_modules"]
+  "typeAcquisition": {
+    "enable": false
+  },
+  "include": ["typescript.ts"]
 }

test/package/typescript.ts

@@ -1,6 +1,6 @@
-import request from 'superwstest';
 import { createServer as httpCreateServer } from 'node:http';
 import { createServer as httpsCreateServer } from 'node:https';
+import request from 'superwstest';
 import { WebSocketServer } from 'ws';
 
 // this file just checks types; the code is not executed
@@ -11,6 +11,8 @@ request('hello')
   .exec((ws) => ws.ping('blah'))
   .close();
 
+request('hello').get('/hi');
+
 request(httpCreateServer()).ws('foo');
 request(httpsCreateServer()).ws('foo');
 request(new WebSocketServer({ port: 0 })).ws('foo');
@@ -41,3 +43,6 @@ request('hello').ws(1);
 
 // @ts-expect-error
 scopedRequest('hello').ws(1);
+
+// @ts-expect-error
+request('hello').get(0);