chore!: convert project to typescript (#1641)

.eslintignore

@@ -2,4 +2,6 @@
 /examples/
 /doc/
 /dist/
-/test/typescript/
+/build/
+
+*.js

.eslintrc.js

@@ -1,14 +1,23 @@
 module.exports = {
+	parser: '@typescript-eslint/parser',
+	plugins: ['@typescript-eslint/eslint-plugin'],
 	env: {
 		browser: true,
 		commonjs: true,
 		es2021: true,
 		node: true,
 		mocha: true,
 	},
-	extends: ['airbnb-base', 'plugin:prettier/recommended'],
+	extends: [
+		'airbnb-base',
+		'airbnb-typescript/base',
+		'plugin:prettier/recommended',
+		'plugin:@typescript-eslint/recommended'
+	],
 	parserOptions: {
-		ecmaVersion: 'latest',
+		project: 'tsconfig.json',
+		sourceType: 'module',
+		tsconfigRootDir: __dirname
 	},
 	rules: {
 		'global-require': 'off',
@@ -29,5 +38,14 @@ module.exports = {
 		'no-continue': 'off',
 		'prefer-destructuring': 'off',
 		'no-use-before-define': 'off',
-	},
+		// Typescript rules
+		'@typescript-eslint/interface-name-prefix': 'off',
+		'@typescript-eslint/explicit-function-return-type': 'off',
+		'@typescript-eslint/explicit-module-boundary-types': 'off',
+		'@typescript-eslint/no-explicit-any': 'off',
+		'@typescript-eslint/no-unused-vars': 'off',
+		'@typescript-eslint/naming-convention': 'off',
+		'@typescript-eslint/dot-notation': 'off',
+		'@typescript-eslint/no-use-before-define': 'off',
+	}
 }

.github/workflows/mqttjs-test.yml

@@ -43,18 +43,12 @@ jobs:
         CI: true
         DEBUG: "${{ runner.debug == '1' && 'mqttjs:*' || '' }}"
 
-    - name: Test Typescript
-      run: npm run test:typescript
-      env:
-        CI: true
-        DEBUG: "${{ runner.debug == '1' && 'mqttjs:*' || '' }}"
-
     - name: Test Browser
       if: matrix.node-version == '20.x'
       # only run on latest node version, no reason to run on all
       timeout-minutes: 2
       run: |
-        npm run browser-build
+        npm run build:browser
         npm run unit-test:browser
   
 

.gitignore

@@ -20,3 +20,5 @@ test/typescript/*.map
 .vscode/
 .npmrc
 
+/build/
+

.mocharc.js

@@ -0,0 +1,10 @@
+// --check-leaks
+// --timeout 10000
+// --exit
+
+module.exports = {
+    checkLeaks: true,
+    exit: true,
+    timeout: 10000,
+};
+

README.md

@@ -44,7 +44,11 @@ There is work being done on the next generation of MQTT.js (vNext). We invite th
 
 ## Important notes for existing users
 
-**v5.0.0** (**BETA** 06/2023) removes support for all end of life node versions (v12 and v14), and now supports node v18 and v20.
+**v5.0.0** (**BETA** 06/2023)
+
+- Removes support for all end of life node versions (v12 and v14), and now supports node v18 and v20.
+- Completely rewritten in Typescript 🚀.
+- When creating `MqttClient` instance `new` is now required
 
 **v4.0.0** (Released 04/2020) removes support for all end of life node versions, and now supports node v12 and v14. It also adds improvements to
 debug logging, along with some feature additions.
@@ -389,7 +393,7 @@ The arguments are:
   - `customHandleAcks`: MQTT 5 feature of custom handling puback and pubrec packets. Its callback:
 
     ```js
-      customHandleAcks: function(topic, message, packet, done) {/*some logic wit colling done(error, reasonCode)*/}
+      customHandleAcks: function(topic, message, packet, done) {/*some logic with calling done(error, reasonCode)*/}
     ```
 
   - `autoUseTopicAlias`: enabling automatic Topic Alias using functionality