wxt 0.5.5 → 0.5.6

package/dist/virtual-modules/content-script-entrypoint.js

@@ -17,10 +17,127 @@ var logger = {
   error: (...args) => print(console.error, ...args)
 };
 
+// src/client/browser.ts
+import originalBrowser from "webextension-polyfill";
+var browser = originalBrowser;
+
+// src/client/utils/ContentScriptContext.ts
+var ContentScriptContext = class _ContentScriptContext extends AbortController {
+  constructor(contentScriptName) {
+    super();
+    this.contentScriptName = contentScriptName;
+    if (this.#isTopFrame) {
+      this.#stopOldScripts();
+    }
+    this.setTimeout(() => {
+      this.#listenForNewerScripts();
+    });
+  }
+  static SCRIPT_STARTED_MESSAGE_TYPE = "wxt:content-script-started";
+  #isTopFrame = window.self === window.top;
+  get isInvalid() {
+    if (browser.runtime.id == null) {
+      this.notifyInvalidated();
+    }
+    return this.signal.aborted;
+  }
+  get isValid() {
+    return !this.isInvalid;
+  }
+  /**
+   * Add a listener that is called when the content script's context is invalidated.
+   *
+   * @returns A function to remove the listener.
+   *
+   * @example
+   * browser.runtime.onMessage.addListener(cb);
+   * const removeInvalidatedListener = ctx.onInvalidated(() => {
+   *   browser.runtime.onMessage.removeListener(cb);
+   * })
+   * // ...
+   * removeInvalidatedListener();
+   */
+  onInvalidated(cb) {
+    this.signal.addEventListener("abort", cb);
+    return () => this.signal.removeEventListener("abort", cb);
+  }
+  /**
+   * Wrapper around `window.setInterval` that automatically clears the interval when invalidated.
+   */
+  setInterval(handler, timeout) {
+    const id = setInterval(() => {
+      if (this.isValid)
+        handler();
+    }, timeout);
+    this.onInvalidated(() => clearInterval(id));
+    return id;
+  }
+  /**
+   * Wrapper around `window.setTimeout` that automatically clears the interval when invalidated.
+   */
+  setTimeout(handler, timeout) {
+    const id = setTimeout(() => {
+      if (this.isValid)
+        handler();
+    }, timeout);
+    this.onInvalidated(() => clearTimeout(id));
+    return id;
+  }
+  /**
+   * Wrapper around `window.requestAnimationFrame` that automatically cancels the request when
+   * invalidated.
+   */
+  requestAnimationFrame(callback) {
+    const id = requestAnimationFrame((...args) => {
+      if (this.isValid)
+        callback(...args);
+    });
+    this.onInvalidated(() => cancelAnimationFrame(id));
+    return id;
+  }
+  /**
+   * Wrapper around `window.requestIdleCallback` that automatically cancels the request when
+   * invalidated.
+   */
+  requestIdleCallback(callback, options) {
+    const id = requestIdleCallback((...args) => {
+      if (!this.signal.aborted)
+        callback(...args);
+    }, options);
+    this.onInvalidated(() => cancelIdleCallback(id));
+    return id;
+  }
+  /**
+   * Abort the abort controller and execute all `onInvalidated` listeners.
+   */
+  notifyInvalidated() {
+    this.abort("Content script context invalidated");
+    logger.debug(
+      `Content script "${this.contentScriptName}" context invalidated`
+    );
+  }
+  #stopOldScripts() {
+    window.postMessage({
+      event: _ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE,
+      contentScriptName: this.contentScriptName
+    });
+  }
+  #listenForNewerScripts() {
+    const cb = (event) => {
+      if (event.data?.type === _ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE && event.data?.contentScriptName === this.contentScriptName) {
+        this.notifyInvalidated();
+      }
+    };
+    addEventListener("message", cb);
+    this.onInvalidated(() => removeEventListener("message", cb));
+  }
+};
+
 // src/client/virtual-modules/content-script-entrypoint.ts
 (async () => {
   try {
-    await definition.main();
+    const ctx = new ContentScriptContext(__ENTRYPOINT__);
+    await definition.main(ctx);
   } catch (err) {
     logger.error("The content script crashed on startup!", err);
   }

package/dist/virtual-modules/content-script-entrypoint.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/client/virtual-modules/content-script-entrypoint.ts","../../src/client/utils/logger.ts"],"sourcesContent":["import definition from 'virtual:user-content-script';\nimport { logger } from '../utils/logger';\n\n(async () => {\n  try {\n    await definition.main();\n  } catch (err) {\n    logger.error('The content script crashed on startup!', err);\n  }\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"],"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,OAAO,IAAI,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;;;CDdC,YAAY;AACX,MAAI;AACF,UAAM,WAAW,KAAK;AAAA,EACxB,SAAS,KAAK;AACZ,WAAO,MAAM,0CAA0C,GAAG;AAAA,EAC5D;AACF,GAAG;","names":[]}
+{"version":3,"sources":["../../src/client/virtual-modules/content-script-entrypoint.ts","../../src/client/utils/logger.ts","../../src/client/browser.ts","../../src/client/utils/ContentScriptContext.ts"],"sourcesContent":["import definition from 'virtual:user-content-script';\nimport { logger } from '../utils/logger';\nimport { ContentScriptContext } from '../utils/ContentScriptContext';\n\n(async () => {\n  try {\n    const ctx = new ContentScriptContext(__ENTRYPOINT__);\n\n    await definition.main(ctx);\n  } catch (err) {\n    logger.error('The content script crashed on startup!', err);\n  }\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 originalBrowser, { Browser, Runtime, I18n } from 'webextension-polyfill';\n\nexport interface AugmentedBrowser extends Browser {\n  runtime: WxtRuntime;\n  i18n: WxtI18n;\n}\n\nexport interface WxtRuntime extends Runtime.Static {\n  // Overriden per-project\n}\n\nexport interface WxtI18n extends I18n.Static {\n  // Overriden per-project\n}\n\nexport const browser: AugmentedBrowser = originalBrowser;\n","import { browser } from '../browser';\nimport { logger } from './logger';\n\n/**\n * Extends [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).\n * Used to detect and stop content script code when the script is invalidated.\n *\n * It also provides several utilities like `ctx.setTimeout` and `ctx.setInterval` that should be used in\n * content scripts instead of `window.setTimeout` or `window.setInterval`.\n */\nexport class ContentScriptContext extends AbortController {\n  static SCRIPT_STARTED_MESSAGE_TYPE = 'wxt:content-script-started';\n\n  #isTopFrame = window.self === window.top;\n\n  constructor(private readonly contentScriptName: string) {\n    super();\n\n    if (this.#isTopFrame) {\n      this.#stopOldScripts();\n    }\n    this.setTimeout(() => {\n      // Run on next tick so the listener it adds isn't triggered by stopOldScript\n      this.#listenForNewerScripts();\n    });\n  }\n\n  get isInvalid(): boolean {\n    if (browser.runtime.id == null) {\n      this.notifyInvalidated(); // Sets `signal.aborted` to true\n    }\n    return this.signal.aborted;\n  }\n\n  get isValid(): boolean {\n    return !this.isInvalid;\n  }\n\n  /**\n   * Add a listener that is called when the content script's context is invalidated.\n   *\n   * @returns A function to remove the listener.\n   *\n   * @example\n   * browser.runtime.onMessage.addListener(cb);\n   * const removeInvalidatedListener = ctx.onInvalidated(() => {\n   *   browser.runtime.onMessage.removeListener(cb);\n   * })\n   * // ...\n   * removeInvalidatedListener();\n   */\n  onInvalidated(cb: () => void): () => void {\n    this.signal.addEventListener('abort', cb);\n    return () => this.signal.removeEventListener('abort', cb);\n  }\n\n  /**\n   * Wrapper around `window.setInterval` that automatically clears the interval when invalidated.\n   */\n  setInterval(handler: () => void, timeout?: number): number {\n    const id = setInterval(() => {\n      if (this.isValid) handler();\n    }, timeout) as unknown as number;\n    this.onInvalidated(() => clearInterval(id));\n    return id;\n  }\n\n  /**\n   * Wrapper around `window.setTimeout` that automatically clears the interval when invalidated.\n   */\n  setTimeout(handler: () => void, timeout?: number): number {\n    const id = setTimeout(() => {\n      if (this.isValid) handler();\n    }, timeout) as unknown as number;\n    this.onInvalidated(() => clearTimeout(id));\n    return id;\n  }\n\n  /**\n   * Wrapper around `window.requestAnimationFrame` that automatically cancels the request when\n   * invalidated.\n   */\n  requestAnimationFrame(callback: FrameRequestCallback): number {\n    const id = requestAnimationFrame((...args) => {\n      if (this.isValid) callback(...args);\n    });\n\n    this.onInvalidated(() => cancelAnimationFrame(id));\n    return id;\n  }\n\n  /**\n   * Wrapper around `window.requestIdleCallback` that automatically cancels the request when\n   * invalidated.\n   */\n  requestIdleCallback(\n    callback: IdleRequestCallback,\n    options?: IdleRequestOptions,\n  ): number {\n    const id = requestIdleCallback((...args) => {\n      if (!this.signal.aborted) callback(...args);\n    }, options);\n\n    this.onInvalidated(() => cancelIdleCallback(id));\n    return id;\n  }\n\n  /**\n   * Abort the abort controller and execute all `onInvalidated` listeners.\n   */\n  notifyInvalidated() {\n    this.abort('Content script context invalidated');\n    logger.debug(\n      `Content script \"${this.contentScriptName}\" context invalidated`,\n    );\n  }\n\n  #stopOldScripts() {\n    // Use postMessage so it get's sent to all the frames of the page.\n    window.postMessage({\n      event: ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE,\n      contentScriptName: this.contentScriptName,\n    });\n  }\n\n  #listenForNewerScripts() {\n    const cb = (event: MessageEvent) => {\n      if (\n        event.data?.type === ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE &&\n        event.data?.contentScriptName === this.contentScriptName\n      ) {\n        this.notifyInvalidated();\n      }\n    };\n\n    addEventListener('message', cb);\n    this.onInvalidated(() => removeEventListener('message', cb));\n  }\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,OAAO,IAAI,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;;;ACjBA,OAAO,qBAAiD;AAejD,IAAM,UAA4B;;;ACLlC,IAAM,uBAAN,MAAM,8BAA6B,gBAAgB;AAAA,EAKxD,YAA6B,mBAA2B;AACtD,UAAM;AADqB;AAG3B,QAAI,KAAK,aAAa;AACpB,WAAK,gBAAgB;AAAA,IACvB;AACA,SAAK,WAAW,MAAM;AAEpB,WAAK,uBAAuB;AAAA,IAC9B,CAAC;AAAA,EACH;AAAA,EAdA,OAAO,8BAA8B;AAAA,EAErC,cAAc,OAAO,SAAS,OAAO;AAAA,EAcrC,IAAI,YAAqB;AACvB,QAAI,QAAQ,QAAQ,MAAM,MAAM;AAC9B,WAAK,kBAAkB;AAAA,IACzB;AACA,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,UAAmB;AACrB,WAAO,CAAC,KAAK;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,cAAc,IAA4B;AACxC,SAAK,OAAO,iBAAiB,SAAS,EAAE;AACxC,WAAO,MAAM,KAAK,OAAO,oBAAoB,SAAS,EAAE;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA,EAKA,YAAY,SAAqB,SAA0B;AACzD,UAAM,KAAK,YAAY,MAAM;AAC3B,UAAI,KAAK;AAAS,gBAAQ;AAAA,IAC5B,GAAG,OAAO;AACV,SAAK,cAAc,MAAM,cAAc,EAAE,CAAC;AAC1C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,SAAqB,SAA0B;AACxD,UAAM,KAAK,WAAW,MAAM;AAC1B,UAAI,KAAK;AAAS,gBAAQ;AAAA,IAC5B,GAAG,OAAO;AACV,SAAK,cAAc,MAAM,aAAa,EAAE,CAAC;AACzC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,sBAAsB,UAAwC;AAC5D,UAAM,KAAK,sBAAsB,IAAI,SAAS;AAC5C,UAAI,KAAK;AAAS,iBAAS,GAAG,IAAI;AAAA,IACpC,CAAC;AAED,SAAK,cAAc,MAAM,qBAAqB,EAAE,CAAC;AACjD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,oBACE,UACA,SACQ;AACR,UAAM,KAAK,oBAAoB,IAAI,SAAS;AAC1C,UAAI,CAAC,KAAK,OAAO;AAAS,iBAAS,GAAG,IAAI;AAAA,IAC5C,GAAG,OAAO;AAEV,SAAK,cAAc,MAAM,mBAAmB,EAAE,CAAC;AAC/C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,oBAAoB;AAClB,SAAK,MAAM,oCAAoC;AAC/C,WAAO;AAAA,MACL,mBAAmB,KAAK,iBAAiB;AAAA,IAC3C;AAAA,EACF;AAAA,EAEA,kBAAkB;AAEhB,WAAO,YAAY;AAAA,MACjB,OAAO,sBAAqB;AAAA,MAC5B,mBAAmB,KAAK;AAAA,IAC1B,CAAC;AAAA,EACH;AAAA,EAEA,yBAAyB;AACvB,UAAM,KAAK,CAAC,UAAwB;AAClC,UACE,MAAM,MAAM,SAAS,sBAAqB,+BAC1C,MAAM,MAAM,sBAAsB,KAAK,mBACvC;AACA,aAAK,kBAAkB;AAAA,MACzB;AAAA,IACF;AAEA,qBAAiB,WAAW,EAAE;AAC9B,SAAK,cAAc,MAAM,oBAAoB,WAAW,EAAE,CAAC;AAAA,EAC7D;AACF;;;CHtIC,YAAY;AACX,MAAI;AACF,UAAM,MAAM,IAAI,qBAAqB,cAAc;AAEnD,UAAM,WAAW,KAAK,GAAG;AAAA,EAC3B,SAAS,KAAK;AACZ,WAAO,MAAM,0CAA0C,GAAG;AAAA,EAC5D;AACF,GAAG;","names":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "description": "Next gen framework for developing web extensions",
   "engines": {
     "node": ">=18.16.0",