summaryrefslogtreecommitdiff
path: root/ext/js/extension/web-extension.js
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2024-01-20 23:13:17 -0500
committerGitHub <noreply@github.com>2024-01-21 04:13:17 +0000
commit6ba1ffe74558dd174e3308d48885fb068fa37d55 (patch)
tree5519bbf972096e0e3370171d2b62a26d6164d671 /ext/js/extension/web-extension.js
parentebdde1ee612a262256ad0384131e53bc29b1e10f (diff)
WebExtension class (#551)
* Add WebExtension class * Use WebExtension class * Use WebExtension instance for all runtime message sending * Use getUrl * Add a sendMessage variant which ignores the response and error
Diffstat (limited to 'ext/js/extension/web-extension.js')
-rw-r--r--ext/js/extension/web-extension.js107
1 files changed, 107 insertions, 0 deletions
diff --git a/ext/js/extension/web-extension.js b/ext/js/extension/web-extension.js
new file mode 100644
index 00000000..95a61339
--- /dev/null
+++ b/ext/js/extension/web-extension.js
@@ -0,0 +1,107 @@
+/*
+ * 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/>.
+ */
+
+import {EventDispatcher} from '../core/event-dispatcher.js';
+import {toError} from '../core/to-error.js';
+
+/**
+ * @augments EventDispatcher<import('web-extension').Events>
+ */
+export class WebExtension extends EventDispatcher {
+ constructor() {
+ super();
+ /** @type {boolean} */
+ this._unloaded = false;
+ }
+
+ /** @type {boolean} */
+ get unloaded() {
+ return this._unloaded;
+ }
+
+ /**
+ * @param {string} path
+ * @returns {string}
+ */
+ getUrl(path) {
+ return chrome.runtime.getURL(path);
+ }
+
+ /**
+ * @param {unknown} message
+ * @param {(response: unknown) => void} responseCallback
+ * @throws {Error}
+ */
+ sendMessage(message, responseCallback) {
+ try {
+ chrome.runtime.sendMessage(message, responseCallback);
+ } catch (error) {
+ this.triggerUnloaded();
+ throw toError(error);
+ }
+ }
+
+ /**
+ * @param {unknown} message
+ * @returns {Promise<unknown>}
+ */
+ sendMessagePromise(message) {
+ return new Promise((resolve, reject) => {
+ try {
+ this.sendMessage(message, (response) => {
+ const error = this.getLastError();
+ if (error !== null) {
+ reject(error);
+ } else {
+ resolve(response);
+ }
+ });
+ } catch (error) {
+ reject(error);
+ }
+ });
+ }
+
+ /**
+ * @param {unknown} message
+ */
+ sendMessageIgnoreResponse(message) {
+ this.sendMessage(message, () => {
+ // Clear the last error
+ this.getLastError();
+ });
+ }
+
+ /**
+ * @returns {?Error}
+ */
+ getLastError() {
+ const {lastError} = chrome.runtime;
+ if (typeof lastError !== 'undefined') {
+ const {message} = lastError;
+ return new Error(typeof message === 'string' ? message : 'An unknown web extension error occured');
+ }
+ return null;
+ }
+
+ /** */
+ triggerUnloaded() {
+ if (this._unloaded) { return; }
+ this._unloaded = true;
+ this.trigger('unloaded', {});
+ }
+}