Merge pull request #127 from psiinon/fix/ts

Update to Node 20 and fix TS errors

Author: thc202

.github/workflows/ci.yaml

@@ -20,6 +20,8 @@ jobs:
 
       - name: Set Node.js environment
         uses: actions/setup-node@v4
+        with:
+          node-version: '20'
 
       - name: Install dependencies
         run: yarn install

package.json

@@ -62,7 +62,7 @@
     "@types/lodash": "^4.14.195",
     "@types/node": "^20.1.0",
     "@types/text-encoding": "^0.0.36",
-    "@types/webextension-polyfill": "^0.10.0",
+    "@types/webextension-polyfill": "^0.12.1",
     "@types/webpack": "^4.41.29",
     "@typescript-eslint/eslint-plugin": "^5.59.11",
     "@typescript-eslint/parser": "^5.59.11",

source/Background/index.ts

@@ -262,15 +262,19 @@ async function handleMessage(
 }
 
 async function onMessageHandler(
-  message: MessageEvent,
+  message: unknown,
   _sender: Runtime.MessageSender
 ): Promise<number | ZestScriptMessage> {
   let val: number | ZestScriptMessage = 2;
   const items = await Browser.storage.sync.get({
     zapurl: 'http://zap/',
     zapkey: 'not set',
   });
-  const msg = await handleMessage(message, items.zapurl, items.zapkey);
+  const msg = await handleMessage(
+    message as MessageEvent,
+    items.zapurl as string,
+    items.zapkey as string
+  );
   if (!(typeof msg === 'boolean')) {
     val = msg;
   }
@@ -286,7 +290,11 @@ function cookieChangeHandler(
       zapkey: 'not set',
     })
     .then((items) => {
-      reportCookies(changeInfo.cookie, items.zapurl, items.zapkey);
+      reportCookies(
+        changeInfo.cookie,
+        items.zapurl as string,
+        items.zapkey as string
+      );
     });
 }
 

source/ContentScript/index.ts

@@ -278,15 +278,23 @@ function injectScript(): Promise<boolean> {
 
 injectScript();
 
+/* eslint-disable  @typescript-eslint/no-explicit-any */
 Browser.runtime.onMessage.addListener(
-  (message: MessageEvent, _sender: Runtime.MessageSender) => {
+  (
+    message: any,
+    _sender: Runtime.MessageSender,
+    _sendResponse: (response?: any) => void
+  ) => {
     if (message.type === ZAP_START_RECORDING) {
       configureExtension();
       recorder.recordUserInteractions();
       recorder.initializationScript();
     } else if (message.type === ZAP_STOP_RECORDING) {
       recorder.stopRecordingUserInteractions();
     }
+
+    // Returning `true` keeps the message channel open for async responses
+    return true;
   }
 );
 

source/Options/index.tsx

@@ -54,14 +54,14 @@ function restoreOptions(): void {
     })
     .then((items) => {
       (document.getElementById(ZAP_URL) as HTMLInputElement).value =
-        items.zapurl;
+        items.zapurl as string;
       (document.getElementById(ZAP_KEY) as HTMLInputElement).value =
-        items.zapkey;
+        items.zapkey as string;
       (document.getElementById(ZAP_ENABLE) as HTMLInputElement).checked =
-        items.zapenable;
+        items.zapenable as boolean;
       (
         document.getElementById('window-close-input') as HTMLInputElement
-      ).checked = items.zapclosewindowhandle;
+      ).checked = items.zapclosewindowhandle as boolean;
     });
 }
 document.addEventListener('DOMContentLoaded', restoreOptions);

source/Popup/index.tsx

@@ -29,6 +29,7 @@ import {
   ZAP_START_RECORDING,
   ZAP_STOP_RECORDING,
 } from '../utils/constants';
+import {ZestScriptMessage} from '../types/zestScript/ZestScript';
 
 const STOP = i18n.t('stop');
 const START = i18n.t('start');
@@ -97,7 +98,7 @@ async function restoreState(): Promise<void> {
       } else {
         stoppedAnimation();
       }
-      scriptNameInput.value = items.zapscriptname;
+      scriptNameInput.value = items.zapscriptname as string;
       if (items.zapclosewindowhandle) {
         done?.classList.remove('invisible');
       } else {
@@ -189,7 +190,8 @@ async function handleSaveScript(): Promise<void> {
     await Browser.runtime.sendMessage({type: STOP_RECORDING});
   }
   Browser.runtime.sendMessage({type: SAVE_ZEST_SCRIPT}).then((items) => {
-    downloadZestScript(items.script, items.title);
+    const msg = items as ZestScriptMessage;
+    downloadZestScript(msg.script, msg.title);
   });
 }
 

source/types/zestScript/ZestScript.ts

@@ -92,7 +92,7 @@ class ZestScript {
   getZestScript(): Promise<ZestScriptMessage> {
     return new Promise((resolve) => {
       Browser.storage.sync.get({zapscriptname: this.title}).then((items) => {
-        this.title = items.zapscriptname;
+        this.title = items.zapscriptname as string;
         resolve({script: this.toJSON(), title: this.title});
       });
     });

yarn.lock

@@ -1885,10 +1885,10 @@
   dependencies:
     source-map "^0.6.1"
 
-"@types/webextension-polyfill@^0.10.0":
-  version "0.10.0"
-  resolved "https://registry.yarnpkg.com/@types/webextension-polyfill/-/webextension-polyfill-0.10.0.tgz#e87b5e2c101599779a584cdb043887ad73b37b0e"
-  integrity sha512-If4EcaHzYTqcbNMp/FdReVdRmLL/Te42ivnJII551bYjhX19bWem5m14FERCqdJA732OloGuxCRvLBvcMGsn4A==
+"@types/webextension-polyfill@^0.12.1":
+  version "0.12.1"
+  resolved "https://registry.yarnpkg.com/@types/webextension-polyfill/-/webextension-polyfill-0.12.1.tgz#8dae244fe094cbb541005362e8e22f16671f6054"
+  integrity sha512-xPTFWwQ8BxPevPF2IKsf4hpZNss4LxaOLZXypQH4E63BDLmcwX/RMGdI4tB4VO4Nb6xDBH3F/p4gz4wvof1o9w==
 
 "@types/webextension-polyfill@^0.8.2":
   version "0.8.3"