Add web option to profile switching keybinds (#933)

* Add web option to profile switching keybinds

* Fix spacing

* Refactor

* Fix comment on update

* Make linter happy

---------

Signed-off-by: Kuuuube <61125188+Kuuuube@users.noreply.github.com>

7 files changed, 65 insertions, 29 deletions

diff --git a/ext/data/schemas/options-schema.json b/ext/data/schemas/options-schema.json
index 1bbdf183..91e01ace 100644
--- a/ext/data/schemas/options-schema.json
+++ b/ext/data/schemas/options-schema.json
@@ -1169,8 +1169,8 @@
                                             {"action": "nextEntry",         "argument": "1", "key": "ArrowDown", "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
                                             {"action": "historyBackward",   "argument": "",  "key": "KeyB",      "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
                                             {"action": "historyForward",    "argument": "",  "key": "KeyF",      "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
-                                            {"action": "profilePrevious",   "argument": "",  "key": "Minus",     "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
-                                            {"action": "profileNext",       "argument": "",  "key": "Equal",     "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
+                                            {"action": "profilePrevious",   "argument": "",  "key": "Minus",     "modifiers": ["alt"],  "scopes": ["popup", "search", "web"], "enabled": true},
+                                            {"action": "profileNext",       "argument": "",  "key": "Equal",     "modifiers": ["alt"],  "scopes": ["popup", "search", "web"], "enabled": true},
                                             {"action": "addNoteKanji",      "argument": "",  "key": "KeyK",      "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
                                             {"action": "addNoteTermKanji",  "argument": "",  "key": "KeyE",      "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
                                             {"action": "addNoteTermKana",   "argument": "",  "key": "KeyR",      "modifiers": ["alt"],  "scopes": ["popup", "search"], "enabled": true},
diff --git a/ext/js/app/frontend.js b/ext/js/app/frontend.js
index bdb8cfc5..71b8d6ef 100644
--- a/ext/js/app/frontend.js
+++ b/ext/js/app/frontend.js
@@ -20,6 +20,7 @@ import {createApiMap, invokeApiMapHandler} from '../core/api-map.js';
 import {EventListenerCollection} from '../core/event-listener-collection.js';
 import {log} from '../core/log.js';
 import {promiseAnimationFrame} from '../core/promise-animation-frame.js';
+import {setProfile} from '../data/profiles-util.js';
 import {addFullscreenChangeEventListener, getFullscreenElement} from '../dom/document-util.js';
 import {TextSourceElement} from '../dom/text-source-element.js';
 import {TextSourceGenerator} from '../dom/text-source-generator.js';
@@ -122,6 +123,8 @@ export class Frontend {
             ['scanSelectedText', this._onActionScanSelectedText.bind(this)],
             ['scanTextAtSelection', this._onActionScanTextAtSelection.bind(this)],
             ['scanTextAtCaret',  this._onActionScanTextAtCaret.bind(this)],
+            ['profilePrevious',   async () => { await setProfile(-1, this._application); }],
+            ['profileNext',       async () => { await setProfile(1, this._application); }],
         ]);
         /* eslint-enable @stylistic/no-multi-spaces */
     }
diff --git a/ext/js/data/options-util.js b/ext/js/data/options-util.js
index c6bdf025..64b2e3bc 100644
--- a/ext/js/data/options-util.js
+++ b/ext/js/data/options-util.js
@@ -547,6 +547,7 @@ export class OptionsUtil {
             this._updateVersion37,
             this._updateVersion38,
             this._updateVersion39,
+            this._updateVersion40,
         ];
         /* eslint-enable @typescript-eslint/unbound-method */
         if (typeof targetVersion === 'number' && targetVersion < result.length) {
@@ -1325,6 +1326,20 @@ export class OptionsUtil {
     }
 
     /**
+     *  - Added support for web hotkey scope to profilePrevious and profileNext
+     *  @type {import('options-util').UpdateFunction}
+     */
+    async _updateVersion40(options) {
+        for (const profile of options.profiles) {
+            for (const hotkey of profile.options.inputs.hotkeys) {
+                if (hotkey.action === 'profilePrevious' || hotkey.action === 'profileNext') {
+                    hotkey.scopes = ['popup', 'search', 'web'];
+                }
+            }
+        }
+    }
+
+    /**
      * @param {string} url
      * @returns {Promise<chrome.tabs.Tab>}
      */
diff --git a/ext/js/data/profiles-util.js b/ext/js/data/profiles-util.js
new file mode 100644
index 00000000..b2868d2d
--- /dev/null
+++ b/ext/js/data/profiles-util.js
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2024  Yomitan Authors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @param {number} direction
+ * @param {import('../application.js').Application} application
+ */
+export async function setProfile(direction, application) {
+    const optionsFull = await application.api.optionsGetFull();
+
+    const profileCount = optionsFull.profiles.length;
+    const newProfile = (optionsFull.profileCurrent + direction + profileCount) % profileCount;
+
+    /** @type {import('settings-modifications').ScopedModificationSet} */
+    const modification = {
+        action: 'set',
+        path: 'profileCurrent',
+        value: newProfile,
+        scope: 'global',
+        optionsContext: null,
+    };
+    await application.api.modifySettings([modification], 'search');
+}
diff --git a/ext/js/display/display.js b/ext/js/display/display.js
index 82d84979..e9fdfd9f 100644
--- a/ext/js/display/display.js
+++ b/ext/js/display/display.js
@@ -26,6 +26,7 @@ import {ExtensionError} from '../core/extension-error.js';
 import {log} from '../core/log.js';
 import {toError} from '../core/to-error.js';
 import {clone, deepEqual, promiseTimeout} from '../core/utilities.js';
+import {setProfile} from '../data/profiles-util.js';
 import {PopupMenu} from '../dom/popup-menu.js';
 import {querySelectorNotNull} from '../dom/query-selector.js';
 import {ScrollElement} from '../dom/scroll-element.js';
@@ -200,8 +201,8 @@ export class Display extends EventDispatcher {
             ['firstEntry',        () => { this._focusEntry(0, 0, true); }],
             ['historyBackward',   () => { this._sourceTermView(); }],
             ['historyForward',    () => { this._nextTermView(); }],
-            ['profilePrevious',   async () => { await this._setProfile(-1); }],
-            ['profileNext',       async () => { await this._setProfile(1); }],
+            ['profilePrevious',   async () => { await setProfile(-1, this._application); }],
+            ['profileNext',       async () => { await setProfile(1, this._application); }],
             ['copyHostSelection', () => this._copyHostSelection()],
             ['nextEntryDifferentDictionary',     () => { this._focusEntryWithDifferentDictionary(1, true); }],
             ['previousEntryDifferentDictionary', () => { this._focusEntryWithDifferentDictionary(-1, true); }],
@@ -2029,26 +2030,6 @@ export class Display extends EventDispatcher {
         this._focusEntry(this._index + count * sign, 0, true);
     }
 
-    /**
-     * @param {number} direction
-     */
-    async _setProfile(direction) {
-        const optionsFull = await this.application.api.optionsGetFull();
-
-        const profileCount = optionsFull.profiles.length;
-        const newProfile = (optionsFull.profileCurrent + direction + profileCount) % profileCount;
-
-        /** @type {import('settings-modifications').ScopedModificationSet} */
-        const modification = {
-            action: 'set',
-            path: 'profileCurrent',
-            value: newProfile,
-            scope: 'global',
-            optionsContext: null,
-        };
-        await this.application.api.modifySettings([modification], 'search');
-    }
-
     /** */
     _closeAllPopupMenus() {
         for (const popupMenu of PopupMenu.openMenus) {
diff --git a/ext/js/pages/settings/keyboard-shortcuts-controller.js b/ext/js/pages/settings/keyboard-shortcuts-controller.js
index fd8bd471..89335082 100644
--- a/ext/js/pages/settings/keyboard-shortcuts-controller.js
+++ b/ext/js/pages/settings/keyboard-shortcuts-controller.js
@@ -59,8 +59,8 @@ export class KeyboardShortcutController {
             ['previousEntryDifferentDictionary', {scopes: new Set(['popup', 'search'])}],
             ['historyBackward',                  {scopes: new Set(['popup', 'search'])}],
             ['historyForward',                   {scopes: new Set(['popup', 'search'])}],
-            ['profilePrevious',                  {scopes: new Set(['popup', 'search'])}],
-            ['profileNext',                      {scopes: new Set(['popup', 'search'])}],
+            ['profilePrevious',                  {scopes: new Set(['popup', 'search', 'web'])}],
+            ['profileNext',                      {scopes: new Set(['popup', 'search', 'web'])}],
             ['addNoteKanji',                     {scopes: new Set(['popup', 'search'])}],
             ['addNoteTermKanji',                 {scopes: new Set(['popup', 'search'])}],
             ['addNoteTermKana',                  {scopes: new Set(['popup', 'search'])}],
diff --git a/test/options-util.test.js b/test/options-util.test.js
index 54bae173..d1fc3515 100644
--- a/test/options-util.test.js
+++ b/test/options-util.test.js
@@ -493,8 +493,8 @@ function createProfileOptionsUpdatedTestData1() {
                 {action: 'playAudio',         argument: '',  key: 'KeyP',      modifiers: ['alt'],  scopes: ['popup', 'search'], enabled: true},
                 {action: 'viewNotes',         argument: '',  key: 'KeyV',      modifiers: ['alt'],  scopes: ['popup', 'search'], enabled: true},
                 {action: 'copyHostSelection', argument: '',  key: 'KeyC',      modifiers: ['ctrl'], scopes: ['popup'], enabled: true},
-                {action: 'profilePrevious',   argument: '',  key: 'Minus',     modifiers: ['alt'],  scopes: ['popup', 'search'], enabled: true},
-                {action: 'profileNext',       argument: '',  key: 'Equal',     modifiers: ['alt'],  scopes: ['popup', 'search'], enabled: true},
+                {action: 'profilePrevious',   argument: '',  key: 'Minus',     modifiers: ['alt'],  scopes: ['popup', 'search', 'web'], enabled: true},
+                {action: 'profileNext',       argument: '',  key: 'Equal',     modifiers: ['alt'],  scopes: ['popup', 'search', 'web'], enabled: true},
             ],
             /* eslint-enable @stylistic/no-multi-spaces */
         },
@@ -606,7 +606,7 @@ function createOptionsUpdatedTestData1() {
             },
         ],
         profileCurrent: 0,
-        version: 39,
+        version: 40,
         global: {
             database: {
                 prefixWildcardsSupported: false,