wxt 0.0.2 → 0.1.1-alpha1

package/dist/virtual-modules/background-entrypoint.js

@@ -45,7 +45,7 @@ function setupWebSocket(onMessage) {
 }
 
 // src/client/virtual-modules/background-entrypoint.ts
-import browser2 from "webextension-polyfill";
+import browser3 from "webextension-polyfill";
 
 // src/client/utils/keepServiceWorkerAlive.ts
 import browser from "webextension-polyfill";
@@ -55,14 +55,62 @@ function keepServiceWorkerAlive() {
   }, 5e3);
 }
 
+// src/client/utils/reloadContentScript.ts
+import browser2 from "webextension-polyfill";
+import { MatchPattern } from "@webext-core/match-patterns";
+function reloadContentScript(contentScript) {
+  const manifest = browser2.runtime.getManifest();
+  if (manifest.manifest_version == 2) {
+    void reloadContentScriptMv2(contentScript);
+  } else {
+    void reloadContentScriptMv3(contentScript);
+  }
+}
+async function reloadContentScriptMv3(contentScript) {
+  const id = `wxt:${contentScript.js[0]}`;
+  logger.log("Reloading content script:", contentScript);
+  const registered = await browser2.scripting.getRegisteredContentScripts();
+  logger.debug("Existing scripts:", registered);
+  const existing = registered.find((cs) => cs.id === id);
+  if (existing) {
+    logger.debug("Updating content script", existing);
+    await browser2.scripting.updateContentScripts([{ ...contentScript, id }]);
+  } else {
+    logger.debug("Registering new content script...");
+    await browser2.scripting.registerContentScripts([{ ...contentScript, id }]);
+  }
+  const allTabs = await browser2.tabs.query({});
+  const matchPatterns = contentScript.matches.map(
+    (match) => new MatchPattern(match)
+  );
+  const matchingTabs = allTabs.filter((tab) => {
+    const url = tab.url;
+    if (!url)
+      return false;
+    return !!matchPatterns.find((pattern) => pattern.includes(url));
+  });
+  await Promise.all(matchingTabs.map((tab) => browser2.tabs.reload(tab.id)));
+}
+async function reloadContentScriptMv2(contentScript) {
+  throw Error("TODO: reloadContentScriptMv2");
+}
+
 // src/client/virtual-modules/background-entrypoint.ts
 if (__COMMAND__ === "serve") {
   try {
-    setupWebSocket((message) => {
+    const ws = setupWebSocket((message) => {
       if (message.event === "wxt:reload-extension")
-        browser2.runtime.reload();
+        browser3.runtime.reload();
+      if (message.event === "wxt:reload-content-script" && message.data != null)
+        reloadContentScript(message.data);
     });
-    keepServiceWorkerAlive();
+    if (__MANIFEST_VERSION__ === 3) {
+      ws.addEventListener("open", () => {
+        const msg = { type: "custom", event: "wxt:background-initialized" };
+        ws.send(JSON.stringify(msg));
+      });
+      keepServiceWorkerAlive();
+    }
   } catch (err) {
     logger.error("Failed to setup web socket connection with dev server", err);
   }

package/dist/virtual-modules/background-entrypoint.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/client/virtual-modules/background-entrypoint.ts","../../src/client/utils/logger.ts","../../src/client/utils/setupWebSocket.ts","../../src/client/utils/keepServiceWorkerAlive.ts"],"sourcesContent":["import definition from 'virtual:user-background';\nimport { setupWebSocket } from '../utils/setupWebSocket';\nimport { logger } from '../utils/logger';\nimport browser from 'webextension-polyfill';\nimport { keepServiceWorkerAlive } from '../utils/keepServiceWorkerAlive';\n\nif (__COMMAND__ === 'serve') {\n  try {\n    setupWebSocket((message) => {\n      if (message.event === 'wxt:reload-extension') browser.runtime.reload();\n    });\n\n    // Web Socket will disconnect if the service worker is killed\n    keepServiceWorkerAlive();\n  } catch (err) {\n    logger.error('Failed to setup web socket connection with dev server', err);\n  }\n}\n\ntry {\n  const res = definition.main();\n  // @ts-expect-error: res shouldn't be a promise, but we're checking it anyways\n  if (res instanceof Promise) {\n    console.warn(\n      \"The background's main() function return a promise, but it must be synchonous\",\n    );\n  }\n} catch (err) {\n  logger.error('The background script crashed on startup!');\n  throw err;\n}\n","function print(method: (...args: any[]) => void, ...args: any[]) {\n  if (typeof args[0] === 'string') {\n    const message = args.shift();\n    method(`[wxt] ${message}`, ...args);\n  } else {\n    method('[wxt]', ...args);\n  }\n}\n\n/**\n * Wrapper around `console` with a \"[wxt]\" prefix\n */\nexport const logger = {\n  debug: (...args: any[]) => print(console.debug, ...args),\n  log: (...args: any[]) => print(console.log, ...args),\n  warn: (...args: any[]) => print(console.warn, ...args),\n  error: (...args: any[]) => print(console.error, ...args),\n};\n","import { logger } from './logger';\n\ninterface WebSocketMessage {\n  type: string;\n  event: string;\n  data?: any;\n}\n\n/**\n * Connect to the websocket and listen for messages.\n *\n * @param onMessage Optional callback that is called when a message is recieved and we've verified\n *                  it's structure is what we expect.\n */\nexport function setupWebSocket(\n  onMessage?: (message: WebSocketMessage) => void,\n) {\n  const serverUrl = `${__DEV_SERVER_PROTOCOL__}//${__DEV_SERVER_HOSTNAME__}:${__DEV_SERVER_PORT__}`;\n  logger.debug('Connecting to dev server @', serverUrl);\n  const ws = new WebSocket(serverUrl, 'vite-hmr');\n\n  ws.addEventListener('open', () => {\n    logger.debug('Connected to dev server');\n  });\n  ws.addEventListener('close', () => {\n    logger.debug('Disconnected from dev server');\n  });\n  ws.addEventListener('error', (event) => {\n    logger.error('Failed to connect to dev server', event);\n  });\n\n  ws.addEventListener('message', (e) => {\n    try {\n      const message = JSON.parse(e.data) as WebSocketMessage;\n      if (message.type === 'custom' && message.event?.startsWith?.('wxt:')) {\n        onMessage?.(message);\n      }\n    } catch (err) {\n      logger.error('Failed to handle message', err);\n    }\n  });\n\n  return ws;\n}\n","import browser from 'webextension-polyfill';\n\n/**\n * https://developer.chrome.com/blog/longer-esw-lifetimes/\n */\nexport function keepServiceWorkerAlive() {\n  setInterval(async () => {\n    // Calling an async browser API resets the service worker's timeout\n    await browser.runtime.getPlatformInfo();\n  }, 5e3);\n}\n"],"mappings":";AAAA,OAAO,gBAAgB;;;ACAvB,SAAS,MAAM,WAAqC,MAAa;AAC/D,MAAI,OAAO,KAAK,CAAC,MAAM,UAAU;AAC/B,UAAM,UAAU,KAAK,MAAM;AAC3B,WAAO,SAAS,WAAW,GAAG,IAAI;AAAA,EACpC,OAAO;AACL,WAAO,SAAS,GAAG,IAAI;AAAA,EACzB;AACF;AAKO,IAAM,SAAS;AAAA,EACpB,OAAO,IAAI,SAAgB,MAAM,QAAQ,OAAO,GAAG,IAAI;AAAA,EACvD,KAAK,IAAI,SAAgB,MAAM,QAAQ,KAAK,GAAG,IAAI;AAAA,EACnD,MAAM,IAAI,SAAgB,MAAM,QAAQ,MAAM,GAAG,IAAI;AAAA,EACrD,OAAO,IAAI,SAAgB,MAAM,QAAQ,OAAO,GAAG,IAAI;AACzD;;;ACHO,SAAS,eACd,WACA;AACA,QAAM,YAAY,GAAG,4BAA4B,2BAA2B;AAC5E,SAAO,MAAM,8BAA8B,SAAS;AACpD,QAAM,KAAK,IAAI,UAAU,WAAW,UAAU;AAE9C,KAAG,iBAAiB,QAAQ,MAAM;AAChC,WAAO,MAAM,yBAAyB;AAAA,EACxC,CAAC;AACD,KAAG,iBAAiB,SAAS,MAAM;AACjC,WAAO,MAAM,8BAA8B;AAAA,EAC7C,CAAC;AACD,KAAG,iBAAiB,SAAS,CAAC,UAAU;AACtC,WAAO,MAAM,mCAAmC,KAAK;AAAA,EACvD,CAAC;AAED,KAAG,iBAAiB,WAAW,CAAC,MAAM;AACpC,QAAI;AACF,YAAM,UAAU,KAAK,MAAM,EAAE,IAAI;AACjC,UAAI,QAAQ,SAAS,YAAY,QAAQ,OAAO,aAAa,MAAM,GAAG;AACpE,oBAAY,OAAO;AAAA,MACrB;AAAA,IACF,SAAS,KAAP;AACA,aAAO,MAAM,4BAA4B,GAAG;AAAA,IAC9C;AAAA,EACF,CAAC;AAED,SAAO;AACT;;;AFxCA,OAAOA,cAAa;;;AGHpB,OAAO,aAAa;AAKb,SAAS,yBAAyB;AACvC,cAAY,YAAY;AAEtB,UAAM,QAAQ,QAAQ,gBAAgB;AAAA,EACxC,GAAG,GAAG;AACR;;;AHJA,IAAI,gBAAgB,SAAS;AAC3B,MAAI;AACF,mBAAe,CAAC,YAAY;AAC1B,UAAI,QAAQ,UAAU;AAAwB,QAAAC,SAAQ,QAAQ,OAAO;AAAA,IACvE,CAAC;AAGD,2BAAuB;AAAA,EACzB,SAAS,KAAP;AACA,WAAO,MAAM,yDAAyD,GAAG;AAAA,EAC3E;AACF;AAEA,IAAI;AACF,QAAM,MAAM,WAAW,KAAK;AAE5B,MAAI,eAAe,SAAS;AAC1B,YAAQ;AAAA,MACN;AAAA,IACF;AAAA,EACF;AACF,SAAS,KAAP;AACA,SAAO,MAAM,2CAA2C;AACxD,QAAM;AACR;","names":["browser","browser"]}
+{"version":3,"sources":["../../src/client/virtual-modules/background-entrypoint.ts","../../src/client/utils/logger.ts","../../src/client/utils/setupWebSocket.ts","../../src/client/utils/keepServiceWorkerAlive.ts","../../src/client/utils/reloadContentScript.ts"],"sourcesContent":["import definition from 'virtual:user-background';\nimport { setupWebSocket } from '../utils/setupWebSocket';\nimport { logger } from '../utils/logger';\nimport browser from 'webextension-polyfill';\nimport { keepServiceWorkerAlive } from '../utils/keepServiceWorkerAlive';\nimport { reloadContentScript } from '../utils/reloadContentScript';\n\nif (__COMMAND__ === 'serve') {\n  try {\n    const ws = setupWebSocket((message) => {\n      if (message.event === 'wxt:reload-extension') browser.runtime.reload();\n      if (message.event === 'wxt:reload-content-script' && message.data != null)\n        reloadContentScript(message.data);\n    });\n\n    if (__MANIFEST_VERSION__ === 3) {\n      // Tell the server the background script is loaded and ready to go\n      ws.addEventListener('open', () => {\n        const msg = { type: 'custom', event: 'wxt:background-initialized' };\n        ws.send(JSON.stringify(msg));\n      });\n\n      // Web Socket will disconnect if the service worker is killed\n      keepServiceWorkerAlive();\n    }\n  } catch (err) {\n    logger.error('Failed to setup web socket connection with dev server', err);\n  }\n}\n\ntry {\n  const res = definition.main();\n  // @ts-expect-error: res shouldn't be a promise, but we're checking it anyways\n  if (res instanceof Promise) {\n    console.warn(\n      \"The background's main() function return a promise, but it must be synchonous\",\n    );\n  }\n} catch (err) {\n  logger.error('The background script crashed on startup!');\n  throw err;\n}\n","function print(method: (...args: any[]) => void, ...args: any[]) {\n  if (typeof args[0] === 'string') {\n    const message = args.shift();\n    method(`[wxt] ${message}`, ...args);\n  } else {\n    method('[wxt]', ...args);\n  }\n}\n\n/**\n * Wrapper around `console` with a \"[wxt]\" prefix\n */\nexport const logger = {\n  debug: (...args: any[]) => print(console.debug, ...args),\n  log: (...args: any[]) => print(console.log, ...args),\n  warn: (...args: any[]) => print(console.warn, ...args),\n  error: (...args: any[]) => print(console.error, ...args),\n};\n","import { logger } from './logger';\n\ninterface WebSocketMessage {\n  type: string;\n  event: string;\n  data?: any;\n}\n\n/**\n * Connect to the websocket and listen for messages.\n *\n * @param onMessage Optional callback that is called when a message is recieved and we've verified\n *                  it's structure is what we expect.\n */\nexport function setupWebSocket(\n  onMessage?: (message: WebSocketMessage) => void,\n) {\n  const serverUrl = `${__DEV_SERVER_PROTOCOL__}//${__DEV_SERVER_HOSTNAME__}:${__DEV_SERVER_PORT__}`;\n  logger.debug('Connecting to dev server @', serverUrl);\n  const ws = new WebSocket(serverUrl, 'vite-hmr');\n\n  ws.addEventListener('open', () => {\n    logger.debug('Connected to dev server');\n  });\n  ws.addEventListener('close', () => {\n    logger.debug('Disconnected from dev server');\n  });\n  ws.addEventListener('error', (event) => {\n    logger.error('Failed to connect to dev server', event);\n  });\n\n  ws.addEventListener('message', (e) => {\n    try {\n      const message = JSON.parse(e.data) as WebSocketMessage;\n      if (message.type === 'custom' && message.event?.startsWith?.('wxt:')) {\n        onMessage?.(message);\n      }\n    } catch (err) {\n      logger.error('Failed to handle message', err);\n    }\n  });\n\n  return ws;\n}\n","import browser from 'webextension-polyfill';\n\n/**\n * https://developer.chrome.com/blog/longer-esw-lifetimes/\n */\nexport function keepServiceWorkerAlive() {\n  setInterval(async () => {\n    // Calling an async browser API resets the service worker's timeout\n    await browser.runtime.getPlatformInfo();\n  }, 5e3);\n}\n","import browser, { Manifest } from 'webextension-polyfill';\nimport { logger } from './logger';\nimport { MatchPattern } from '@webext-core/match-patterns';\n\nexport function reloadContentScript(contentScript: Manifest.ContentScript) {\n  const manifest = browser.runtime.getManifest();\n  if (manifest.manifest_version == 2) {\n    void reloadContentScriptMv2(contentScript);\n  } else {\n    void reloadContentScriptMv3(contentScript);\n  }\n}\n\nexport async function reloadContentScriptMv3(\n  contentScript: Manifest.ContentScript,\n) {\n  const id = `wxt:${contentScript.js![0]}`;\n  logger.log('Reloading content script:', contentScript);\n  const registered = await browser.scripting.getRegisteredContentScripts();\n  logger.debug('Existing scripts:', registered);\n\n  const existing = registered.find((cs) => cs.id === id);\n\n  if (existing) {\n    logger.debug('Updating content script', existing);\n    await browser.scripting.updateContentScripts([{ ...contentScript, id }]);\n  } else {\n    logger.debug('Registering new content script...');\n    await browser.scripting.registerContentScripts([{ ...contentScript, id }]);\n  }\n\n  const allTabs = await browser.tabs.query({});\n  const matchPatterns = contentScript.matches.map(\n    (match) => new MatchPattern(match),\n  );\n  const matchingTabs = allTabs.filter((tab) => {\n    const url = tab.url;\n    if (!url) return false;\n    return !!matchPatterns.find((pattern) => pattern.includes(url));\n  });\n  await Promise.all(matchingTabs.map((tab) => browser.tabs.reload(tab.id)));\n}\n\nexport async function reloadContentScriptMv2(\n  contentScript: Manifest.ContentScript,\n) {\n  throw Error('TODO: reloadContentScriptMv2');\n}\n"],"mappings":";AAAA,OAAO,gBAAgB;;;ACAvB,SAAS,MAAM,WAAqC,MAAa;AAC/D,MAAI,OAAO,KAAK,CAAC,MAAM,UAAU;AAC/B,UAAM,UAAU,KAAK,MAAM;AAC3B,WAAO,SAAS,WAAW,GAAG,IAAI;AAAA,EACpC,OAAO;AACL,WAAO,SAAS,GAAG,IAAI;AAAA,EACzB;AACF;AAKO,IAAM,SAAS;AAAA,EACpB,OAAO,IAAI,SAAgB,MAAM,QAAQ,OAAO,GAAG,IAAI;AAAA,EACvD,KAAK,IAAI,SAAgB,MAAM,QAAQ,KAAK,GAAG,IAAI;AAAA,EACnD,MAAM,IAAI,SAAgB,MAAM,QAAQ,MAAM,GAAG,IAAI;AAAA,EACrD,OAAO,IAAI,SAAgB,MAAM,QAAQ,OAAO,GAAG,IAAI;AACzD;;;ACHO,SAAS,eACd,WACA;AACA,QAAM,YAAY,GAAG,4BAA4B,2BAA2B;AAC5E,SAAO,MAAM,8BAA8B,SAAS;AACpD,QAAM,KAAK,IAAI,UAAU,WAAW,UAAU;AAE9C,KAAG,iBAAiB,QAAQ,MAAM;AAChC,WAAO,MAAM,yBAAyB;AAAA,EACxC,CAAC;AACD,KAAG,iBAAiB,SAAS,MAAM;AACjC,WAAO,MAAM,8BAA8B;AAAA,EAC7C,CAAC;AACD,KAAG,iBAAiB,SAAS,CAAC,UAAU;AACtC,WAAO,MAAM,mCAAmC,KAAK;AAAA,EACvD,CAAC;AAED,KAAG,iBAAiB,WAAW,CAAC,MAAM;AACpC,QAAI;AACF,YAAM,UAAU,KAAK,MAAM,EAAE,IAAI;AACjC,UAAI,QAAQ,SAAS,YAAY,QAAQ,OAAO,aAAa,MAAM,GAAG;AACpE,oBAAY,OAAO;AAAA,MACrB;AAAA,IACF,SAAS,KAAP;AACA,aAAO,MAAM,4BAA4B,GAAG;AAAA,IAC9C;AAAA,EACF,CAAC;AAED,SAAO;AACT;;;AFxCA,OAAOA,cAAa;;;AGHpB,OAAO,aAAa;AAKb,SAAS,yBAAyB;AACvC,cAAY,YAAY;AAEtB,UAAM,QAAQ,QAAQ,gBAAgB;AAAA,EACxC,GAAG,GAAG;AACR;;;ACVA,OAAOC,cAA2B;AAElC,SAAS,oBAAoB;AAEtB,SAAS,oBAAoB,eAAuC;AACzE,QAAM,WAAWC,SAAQ,QAAQ,YAAY;AAC7C,MAAI,SAAS,oBAAoB,GAAG;AAClC,SAAK,uBAAuB,aAAa;AAAA,EAC3C,OAAO;AACL,SAAK,uBAAuB,aAAa;AAAA,EAC3C;AACF;AAEA,eAAsB,uBACpB,eACA;AACA,QAAM,KAAK,OAAO,cAAc,GAAI,CAAC;AACrC,SAAO,IAAI,6BAA6B,aAAa;AACrD,QAAM,aAAa,MAAMA,SAAQ,UAAU,4BAA4B;AACvE,SAAO,MAAM,qBAAqB,UAAU;AAE5C,QAAM,WAAW,WAAW,KAAK,CAAC,OAAO,GAAG,OAAO,EAAE;AAErD,MAAI,UAAU;AACZ,WAAO,MAAM,2BAA2B,QAAQ;AAChD,UAAMA,SAAQ,UAAU,qBAAqB,CAAC,EAAE,GAAG,eAAe,GAAG,CAAC,CAAC;AAAA,EACzE,OAAO;AACL,WAAO,MAAM,mCAAmC;AAChD,UAAMA,SAAQ,UAAU,uBAAuB,CAAC,EAAE,GAAG,eAAe,GAAG,CAAC,CAAC;AAAA,EAC3E;AAEA,QAAM,UAAU,MAAMA,SAAQ,KAAK,MAAM,CAAC,CAAC;AAC3C,QAAM,gBAAgB,cAAc,QAAQ;AAAA,IAC1C,CAAC,UAAU,IAAI,aAAa,KAAK;AAAA,EACnC;AACA,QAAM,eAAe,QAAQ,OAAO,CAAC,QAAQ;AAC3C,UAAM,MAAM,IAAI;AAChB,QAAI,CAAC;AAAK,aAAO;AACjB,WAAO,CAAC,CAAC,cAAc,KAAK,CAAC,YAAY,QAAQ,SAAS,GAAG,CAAC;AAAA,EAChE,CAAC;AACD,QAAM,QAAQ,IAAI,aAAa,IAAI,CAAC,QAAQA,SAAQ,KAAK,OAAO,IAAI,EAAE,CAAC,CAAC;AAC1E;AAEA,eAAsB,uBACpB,eACA;AACA,QAAM,MAAM,8BAA8B;AAC5C;;;AJxCA,IAAI,gBAAgB,SAAS;AAC3B,MAAI;AACF,UAAM,KAAK,eAAe,CAAC,YAAY;AACrC,UAAI,QAAQ,UAAU;AAAwB,QAAAC,SAAQ,QAAQ,OAAO;AACrE,UAAI,QAAQ,UAAU,+BAA+B,QAAQ,QAAQ;AACnE,4BAAoB,QAAQ,IAAI;AAAA,IACpC,CAAC;AAED,QAAI,yBAAyB,GAAG;AAE9B,SAAG,iBAAiB,QAAQ,MAAM;AAChC,cAAM,MAAM,EAAE,MAAM,UAAU,OAAO,6BAA6B;AAClE,WAAG,KAAK,KAAK,UAAU,GAAG,CAAC;AAAA,MAC7B,CAAC;AAGD,6BAAuB;AAAA,IACzB;AAAA,EACF,SAAS,KAAP;AACA,WAAO,MAAM,yDAAyD,GAAG;AAAA,EAC3E;AACF;AAEA,IAAI;AACF,QAAM,MAAM,WAAW,KAAK;AAE5B,MAAI,eAAe,SAAS;AAC1B,YAAQ;AAAA,MACN;AAAA,IACF;AAAA,EACF;AACF,SAAS,KAAP;AACA,SAAO,MAAM,2CAA2C;AACxD,QAAM;AACR;","names":["browser","browser","browser","browser"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.1-alpha1",
   "description": "Next gen framework for developing web extensions",
   "repository": {
     "type": "git",
@@ -41,6 +41,7 @@
     }
   },
   "dependencies": {
+    "@webext-core/match-patterns": "^1.0.1",
     "async-mutex": "^0.4.0",
     "c12": "^1.4.2",
     "cac": "^6.7.14",
@@ -75,7 +76,7 @@
     "tsup": "^7.0.0",
     "tsx": "^3.12.7",
     "typescript": "^5.1.3",
-    "vitest": "^0.32.2",
+    "vitest": "^0.32.4",
     "webextension-polyfill": "^0.10.0"
   },
   "peerDependencies": {