chore(types): migrate module resolution and module types (#2012)

* chore: Added a first iteration of TypeScript rules to migrate module resolution and module types.

* chore: Extended tsconfig/node20.

* chore: Attempted to resolve issues due to @tsconfig/node20 extension.

* chore: Removed a comment.

Author: SmashingQuasar

package-lock.json

@@ -131,6 +131,7 @@
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
     "@release-it/conventional-changelog": "^7.0.2",
+    "@tsconfig/node20": "^20.1.6",
     "@types/chai": "^4.3.20",
     "@types/node": "^20.17.16",
     "@types/sinon": "^17.0.3",

package.json

@@ -1,6 +1,6 @@
 import { Buffer } from 'buffer'
 import { Transform } from 'readable-stream'
-import { type StreamBuilder } from '../shared'
+import { type IStream, type StreamBuilder } from '../shared'
 import { type IClientOptions } from '../client'
 import type MqttClient from '../client'
 import { BufferedDuplex } from '../BufferedDuplex'
@@ -75,11 +75,13 @@ function bindEventHandler() {
 		} else {
 			const reader = new FileReader()
 			reader.addEventListener('load', () => {
-				let data = reader.result
+				if (reader.result instanceof ArrayBuffer) {
+					proxy.push(Buffer.from(reader.result))
 
-				if (data instanceof ArrayBuffer) data = Buffer.from(data)
-				else data = Buffer.from(data, 'utf8')
-				proxy.push(data)
+					return
+				}
+
+				proxy.push(Buffer.from(reader.result, 'utf-8'))
 			})
 			reader.readAsArrayBuffer(res.data)
 		}
@@ -95,7 +97,7 @@ function bindEventHandler() {
 	})
 }
 
-const buildStream: StreamBuilder = (client, opts) => {
+const buildStream: StreamBuilder = (client, opts): IStream => {
 	opts.hostname = opts.hostname || opts.host
 
 	if (!opts.hostname) {

src/lib/connect/ali.ts

@@ -1,4 +1,4 @@
-import tls, { type TLSSocket } from 'tls'
+import { type TLSSocket, connect as tlsConnect } from 'tls'
 import net from 'net'
 import _debug from 'debug'
 import { type StreamBuilder } from '../shared'
@@ -10,16 +10,18 @@ const debug = _debug('mqttjs:tls')
 function connect(opts: IClientOptions): TLSSocket {
 	const { host, port, socksProxy, ...rest } = opts
 
-	return tls.connect(
-		socksProxy
-			? {
-					...rest,
-					socket: openSocks(host, port, socksProxy, {
-						timeout: opts.socksTimeout,
-					}),
-				}
-			: opts,
-	)
+	if (socksProxy !== undefined) {
+		const socket = openSocks(host, port, socksProxy, {
+			timeout: opts.socksTimeout,
+		})
+
+		return tlsConnect({
+			...rest,
+			socket,
+		})
+	}
+
+	return tlsConnect(opts)
 }
 
 const buildStream: StreamBuilder = (client, opts) => {

src/lib/connect/tls.ts

@@ -1,8 +1,8 @@
 import { Buffer } from 'buffer'
 import Ws, { type ClientOptions } from 'ws'
 import _debug from 'debug'
-import { type DuplexOptions, Transform } from 'readable-stream'
-import { type StreamBuilder } from '../shared'
+import { Transform } from 'readable-stream'
+import { type IStream, type StreamBuilder } from '../shared'
 import isBrowser from '../is-browser'
 import { type IClientOptions } from '../client'
 import type MqttClient from '../client'
@@ -138,18 +138,16 @@ function createBrowserWebSocket(client: MqttClient, opts: IClientOptions) {
 	return socket
 }
 
-const streamBuilder: StreamBuilder = (client, opts) => {
+const streamBuilder: StreamBuilder = (client, opts): IStream => {
 	debug('streamBuilder')
 	const options = setDefaultOpts(opts)
 
 	options.hostname = options.hostname || options.host || 'localhost'
 
 	const url = buildUrl(options, client)
 	const socket = createWebSocket(client, url, options)
-	const webSocketStream = Ws.createWebSocketStream(
-		socket,
-		options.wsOptions as DuplexOptions,
-	)
+	// @ts-expect-error - This is a type confusion because of the overlap between browser oriented code and Node.js oriented code.
+	const webSocketStream = Ws.createWebSocketStream(socket, options.wsOptions)
 
 	webSocketStream['url'] = url
 	socket.on('close', () => {

src/lib/connect/ws.ts

@@ -1,5 +1,6 @@
 import type { Packet, ISubackPacket } from 'mqtt-packet'
-import type { Duplex } from 'stream'
+import type { Duplex as NativeDuplex } from 'node:stream'
+import type { Duplex } from 'readable-stream'
 import type MqttClient from './client'
 import type { IClientOptions } from './client'
 
@@ -9,7 +10,7 @@ export type GenericCallback<T> = (error?: Error, result?: T) => void
 
 export type VoidCallback = () => void
 
-export type IStream = Duplex & {
+export type IStream = (Duplex | NativeDuplex) & {
 	/** only set on browsers, it's a [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)  */
 	socket?: any
 }

src/lib/shared.ts

@@ -1,26 +1,29 @@
 {
+	"$schema": "https://json.schemastore.org/tsconfig",
+	"extends": "@tsconfig/node20/tsconfig.json",
 	"compilerOptions": {
-		"module": "commonjs",
 		"declaration": true,
+    	"lib": ["es2023", "DOM"],
 		"removeComments": true,
 		"emitDecoratorMetadata": true,
 		"experimentalDecorators": true,
 		"allowSyntheticDefaultImports": true,
-		"target": "es2017",
 		"sourceMap": true,
 		"outDir": "./build",
 		"baseUrl": "./",
 		"incremental": true,
-		"skipLibCheck": true,
 		"preserveSymlinks": true,
-		"esModuleInterop": true,
 		"resolveJsonModule": true,
-		"typeRoots": [
-			"node_modules/@types"
-		],
-		"types": [
-			"node",
-		],
+		"strict": false,
+		"strictBindCallApply": false,
+		"strictBuiltinIteratorReturn": false,
+		"strictFunctionTypes": false,
+		"strictNullChecks": false,
+		"strictPropertyInitialization": false,
+		"alwaysStrict": false,
+		"noImplicitAny": false,
+		"noImplicitThis": false,
+		"useUnknownInCatchVariables": false
 	},
 	"include": [
 		"src",