Save Summary Type & Target Language (#46)

* Save Summary Type & Target Language

This implements saving of the summary type and target language choices so they can be used for the next summarization (including via shortcut).

It effectively closes the request at https://kagifeedback.org/d/2321-chrome-extension-summarizer-extension-always-uses-summary-instead-of-key-moments

It also updates the expected `node` and `npm` versions for development (current LTS) and the `nodemon` development dependency, to resolve a security vulnerability without having to use `package.json:overrides`.

* Simplify watch command for Firefox too

.nvmrc

@@ -1 +1 @@
-v18.16.1
+v20.9.0

chrome/manifest.json

@@ -1,7 +1,7 @@
 {
   "manifest_version": 3,
   "name": "Kagi Search for Chrome",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "A simple extension for setting Kagi as a default search engine, and automatically logging in to Kagi in incognito browsing windows",
   "background": {
     "service_worker": "src/background.js",

firefox/manifest.json

@@ -1,7 +1,7 @@
 {
   "manifest_version": 3,
   "name": "Kagi Search for Firefox",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "A simple helper extension for setting Kagi as a default search engine, and automatically logging in to Kagi in incognito browsing windows.",
   "background": {
     "page": "src/background_page.html"

nodemon.json

@@ -0,0 +1,5 @@
+{
+  "verbose": false,
+  "ignore": [".git", "built/**", "node_modules/**/node_modules"],
+  "ext": "js,json,css,html"
+}

package.json

@@ -5,8 +5,8 @@
   "main": "build.js",
   "private": true,
   "scripts": {
-    "watch-firefox": "nodemon --ext js,json,css,html build.js firefox watch",
-    "watch-chrome": "nodemon --ext js,json,css,html build.js chrome watch",
+    "watch-firefox": "nodemon build.js firefox watch",
+    "watch-chrome": "nodemon build.js chrome watch",
     "build": "npm run build-firefox && npm run build-chrome",
     "build-firefox": "node build.js firefox",
     "build-chrome": "node build.js chrome",
@@ -26,14 +26,11 @@
   "homepage": "https://github.com/kagisearch/browser_extensions#readme",
   "devDependencies": {
     "adm-zip": "0.5.10",
-    "nodemon": "2.0.22",
+    "nodemon": "3.0.1",
     "rome": "12.1.3"
   },
   "engines": {
-    "node": "18.x",
-    "npm": "9.x"
-  },
-  "overrides": {
-    "semver": "7.5.2"
+    "node": "20.x",
+    "npm": "10.x"
   }
 }

shared/src/background.js

@@ -8,6 +8,8 @@ let sessionToken = undefined;
 let syncSessionFromExisting = true;
 let sessionApiToken = undefined;
 let sessionApiEngine = undefined;
+let sessionSummaryType = undefined;
+let sessionTargetLanguage = undefined;
 let IS_CHROME = true;
 
 // Very hacky, but currently works flawlessly
@@ -16,14 +18,20 @@ if (typeof browser.runtime.getBrowserInfo === 'function') {
 }
 
 async function saveToken(
-  { token, api_token, api_engine, sync } = {},
+  { token, api_token, api_engine, sync, summary_type, target_language } = {},
   isManual = false,
 ) {
   sessionToken = typeof token !== 'undefined' ? token : sessionToken;
   sessionApiToken =
     typeof api_token !== 'undefined' ? api_token : sessionApiToken;
   sessionApiEngine =
     typeof api_engine !== 'undefined' ? api_engine : sessionApiEngine;
+  sessionSummaryType =
+    typeof summary_type !== 'undefined' ? summary_type : sessionSummaryType;
+  sessionTargetLanguage =
+    typeof target_language !== 'undefined'
+      ? target_language
+      : sessionTargetLanguage;
 
   let shouldSync = sync || !isManual;
   if (typeof sessionToken === 'undefined' || sessionToken.trim().length === 0) {
@@ -38,6 +46,8 @@ async function saveToken(
     sync_existing: shouldSync,
     api_token: sessionApiToken,
     api_engine: sessionApiEngine,
+    summary_type: sessionSummaryType,
+    target_language: sessionTargetLanguage,
   });
 
   await updateRules();
@@ -48,6 +58,8 @@ async function saveToken(
     token: sessionToken,
     api_token: sessionApiToken,
     api_engine: sessionApiEngine,
+    summary_type: sessionSummaryType,
+    target_language: sessionTargetLanguage,
   });
 }
 
@@ -168,12 +180,21 @@ browser.commands?.onCommand.addListener(async (command) => {
 });
 
 async function loadStorageData() {
-  const { token, sync_existing, api_token, api_engine } = await fetchSettings();
+  const {
+    token,
+    sync_existing,
+    api_token,
+    api_engine,
+    summary_type,
+    target_language,
+  } = await fetchSettings();
 
   sessionToken = token;
   syncSessionFromExisting = sync_existing;
   sessionApiToken = api_token;
   sessionApiEngine = api_engine;
+  sessionSummaryType = summary_type;
+  sessionTargetLanguage = target_language;
 }
 
 loadStorageData();

shared/src/lib/utils.js

@@ -102,6 +102,10 @@ export async function fetchSettings() {
   const syncObject = await browser.storage.local.get('sync_existing');
   const apiObject = await browser.storage.local.get('api_token');
   const apiEngineObject = await browser.storage.local.get('api_engine');
+  const summaryTypeObject = await browser.storage.local.get('summary_type');
+  const targetLanguageObject = await browser.storage.local.get(
+    'target_language',
+  );
 
   return {
     token: sessionObject?.session_token,
@@ -111,6 +115,8 @@ export async function fetchSettings() {
         : true,
     api_token: apiObject?.api_token,
     api_engine: apiEngineObject?.api_engine,
+    summary_type: summaryTypeObject?.summary_type,
+    target_language: targetLanguageObject?.target_language,
   };
 }
 

shared/src/popup.js

@@ -206,13 +206,19 @@ async function setup() {
 
     const api_engine = apiEngineSelect.value;
 
+    const summary_type = summaryTypeSelect.value;
+
+    const target_language = targetLanguageSelect.value;
+
     saveTokenButton.innerText = 'Saving...';
 
     await browser.runtime.sendMessage({
       type: 'save_token',
       token,
       api_token,
       api_engine,
+      summary_type,
+      target_language,
     });
   });
 
@@ -284,7 +290,18 @@ async function setup() {
       type: 'popup',
     });
 
-    window.close();
+    // Save new summary_type preferences
+    await browser.runtime.sendMessage({
+      type: 'save_token',
+      token: searchParams.token,
+      api_token: searchParams.api_token,
+      api_engine: searchParams.api_engine,
+      summary_type: searchParams.summary_type,
+      target_language: searchParams.target_language,
+    });
+
+    // Give the browser time to save the info before closing the window (when await isn't respected)
+    setTimeout(() => window.close(), 100);
   }
 
   summarizePageButton.addEventListener('click', handleSummarizePageButtonClick);
@@ -332,6 +349,8 @@ async function setup() {
     api_token,
     sync_existing,
     api_engine,
+    summary_type,
+    target_language,
   } = {}) {
     if (token) {
       tokenInput.value = token;
@@ -370,6 +389,14 @@ async function setup() {
         apiEngineSelect.value = api_engine;
       }
 
+      if (summary_type) {
+        summaryTypeSelect.value = summary_type;
+      }
+
+      if (target_language) {
+        targetLanguageSelect.value = target_language;
+      }
+
       const hasIncognitoAccess =
         await browser.extension.isAllowedIncognitoAccess();
 

shared/src/summarize_result.js

@@ -107,7 +107,8 @@ async function setup() {
       popupUrl.searchParams.set('url', tab.url);
       window.history.replaceState(null, '', popupUrl.toString());
 
-      const { token, api_token, api_engine } = await fetchSettings();
+      const { token, api_token, api_engine, summary_type, target_language } =
+        await fetchSettings();
 
       if (token) {
         searchParams.set('token', token);
@@ -118,6 +119,12 @@ async function setup() {
       if (api_engine) {
         searchParams.set('api_engine', api_engine);
       }
+      if (summary_type) {
+        searchParams.set('summary_type', summary_type);
+      }
+      if (target_language) {
+        searchParams.set('target_language', target_language);
+      }
     }
 
     loadingElement.style.display = '';