webextension-messages 1.0.0

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "webextension-messages",
+  "version": "1.0.0",
+  "description": "Package simplifying the exchange of messages between the background and tabs",
+  "license": "MIT",
+  "author": "Igor Morozov",
+  "main": "webextension-messages.js",
+  "devDependencies": {
+    "webextension-polyfill": "0.12.0"
+  }
+}

package/webextension-messages.js

@@ -0,0 +1,91 @@
+const browser = require("webextension-polyfill");
+
+const DESTROY_ACTION = `WEBEXTENSION_MESSAGES_DESTROY`;
+const RESULT_PROMISES = {};
+const ACTIONS = {};
+
+browser.runtime.onMessage.addListener((message) => {
+  if (message.action === DESTROY_ACTION) {
+    destroy(message.payload);
+  }
+});
+
+export default function (actions, messagesId = generateId()) {
+  const messages = Object.fromEntries(
+    Object.entries(actions).map(([action]) => [
+      action,
+      (payload) => sendMessageForAnswer(action, payload),
+    ]),
+  );
+
+  ACTIONS[messagesId] = (message) => onMessage(message, actions);
+
+  browser.runtime.onMessage.addListener(ACTIONS[messagesId]);
+
+  return {
+    ...messages,
+    destroy: () => destroy(messagesId, true),
+  };
+}
+
+async function onMessage(message, actions = {}) {
+  if (RESULT_PROMISES[message.resultId]) {
+    RESULT_PROMISES[message.resultId](message.payload);
+    delete RESULT_PROMISES[message.resultId];
+    return;
+  }
+
+  if (actions[message.action]) {
+    const payload = await actions[message.action](message.payload);
+    sendMessage(message.action, payload, message.resultId);
+  }
+}
+
+function sendMessageForAnswer(action, payload) {
+  const { resultId, promise } = createResultPromise();
+  sendMessage(action, payload, resultId);
+  return promise;
+}
+
+function sendMessage(action, payload, resultId) {
+  const message = { action, payload, resultId };
+
+  if (isBackgroundScript()) {
+    getCurrentTab().then((tab) => browser.tabs.sendMessage(tab[0].id, message));
+  } else {
+    browser.runtime.sendMessage(message);
+  }
+}
+
+function createResultPromise() {
+  const resultId = generateId();
+
+  return {
+    promise: new Promise((res) => (RESULT_PROMISES[resultId] = res)),
+    resultId,
+  };
+}
+
+function isBackgroundScript() {
+  return (
+    window.location.protocol === "chrome-extension:" ||
+    window.location.protocol === "moz-extension:"
+  );
+}
+
+function generateId() {
+  return `${Date.now()}-${Math.random()}`;
+}
+
+function getCurrentTab() {
+  return browser.tabs.query({ active: true, currentWindow: true });
+}
+
+function destroy(messagesId, sendToReceiver) {
+  browser.runtime.onMessage.removeListener(ACTIONS[messagesId]);
+  delete ACTIONS[messagesId];
+
+  if (sendToReceiver) {
+    sendMessage(DESTROY_ACTION, messagesId);
+  }
+}