wxt 0.18.15 → 0.19.0

package/dist/core/utils/globals.mjs

@@ -0,0 +1,53 @@
+export function getGlobals(config) {
+  return [
+    {
+      name: "MANIFEST_VERSION",
+      value: config.manifestVersion,
+      type: `2 | 3`
+    },
+    {
+      name: "BROWSER",
+      value: config.browser,
+      type: `string`
+    },
+    {
+      name: "CHROME",
+      value: config.browser === "chrome",
+      type: `boolean`
+    },
+    {
+      name: "FIREFOX",
+      value: config.browser === "firefox",
+      type: `boolean`
+    },
+    {
+      name: "SAFARI",
+      value: config.browser === "safari",
+      type: `boolean`
+    },
+    {
+      name: "EDGE",
+      value: config.browser === "edge",
+      type: `boolean`
+    },
+    {
+      name: "OPERA",
+      value: config.browser === "opera",
+      type: `boolean`
+    },
+    {
+      name: "COMMAND",
+      value: config.command,
+      type: `"build" | "serve"`
+    }
+  ];
+}
+export function getEntrypointGlobals(entrypointName) {
+  return [
+    {
+      name: "ENTRYPOINT",
+      value: entrypointName,
+      type: `string`
+    }
+  ];
+}

package/dist/core/utils/i18n.d.ts

@@ -0,0 +1,11 @@
+export interface Message {
+    name: string;
+    message: string;
+    description?: string;
+}
+/**
+ * Get a list of all messages and their metadata from JSON file contents.
+ *
+ * @param messagesJson The contents of a `_locales/en/messages.json` file.
+ */
+export declare function parseI18nMessages(messagesJson: object): Message[];

package/dist/core/utils/i18n.mjs

@@ -0,0 +1,35 @@
+const predefinedMessages = {
+  "@@extension_id": {
+    message: "<browser.runtime.id>",
+    description: "The extension or app ID; you might use this string to construct URLs for resources inside the extension. Even unlocalized extensions can use this message.\nNote: You can't use this message in a manifest file."
+  },
+  "@@ui_locale": {
+    message: "<browser.i18n.getUiLocale()>",
+    description: ""
+  },
+  "@@bidi_dir": {
+    message: "<ltr|rtl>",
+    description: 'The text direction for the current locale, either "ltr" for left-to-right languages such as English or "rtl" for right-to-left languages such as Japanese.'
+  },
+  "@@bidi_reversed_dir": {
+    message: "<rtl|ltr>",
+    description: `If the @@bidi_dir is "ltr", then this is "rtl"; otherwise, it's "ltr".`
+  },
+  "@@bidi_start_edge": {
+    message: "<left|right>",
+    description: `If the @@bidi_dir is "ltr", then this is "left"; otherwise, it's "right".`
+  },
+  "@@bidi_end_edge": {
+    message: "<right|left>",
+    description: `If the @@bidi_dir is "ltr", then this is "right"; otherwise, it's "left".`
+  }
+};
+export function parseI18nMessages(messagesJson) {
+  return Object.entries({
+    ...predefinedMessages,
+    ...messagesJson
+  }).map(([name, details]) => ({
+    name,
+    ...details
+  }));
+}

package/dist/core/utils/log/index.d.ts

@@ -0,0 +1,4 @@
+export * from './printBuildSummary';
+export * from './printFileList';
+export * from './printHeader';
+export * from './printTable';

package/dist/core/utils/log/index.mjs

@@ -0,0 +1,4 @@
+export * from "./printBuildSummary.mjs";
+export * from "./printFileList.mjs";
+export * from "./printHeader.mjs";
+export * from "./printTable.mjs";

package/dist/core/utils/log/printBuildSummary.d.ts

@@ -0,0 +1,2 @@
+import { BuildOutput } from '../../../types';
+export declare function printBuildSummary(log: (...args: any[]) => void, header: string, output: BuildOutput): Promise<void>;

package/dist/core/utils/log/printBuildSummary.mjs

@@ -0,0 +1,32 @@
+import { resolve } from "path";
+import { printFileList } from "./printFileList.mjs";
+import { wxt } from "../../wxt.mjs";
+export async function printBuildSummary(log, header, output) {
+  const chunks = [
+    ...output.steps.flatMap((step) => step.chunks),
+    ...output.publicAssets
+  ].sort((l, r) => {
+    const lWeight = getChunkSortWeight(l.fileName);
+    const rWeight = getChunkSortWeight(r.fileName);
+    const diff = lWeight - rWeight;
+    if (diff !== 0) return diff;
+    return l.fileName.localeCompare(r.fileName);
+  });
+  const files = chunks.map(
+    (chunk) => resolve(wxt.config.outDir, chunk.fileName)
+  );
+  await printFileList(log, header, wxt.config.outDir, files);
+}
+const DEFAULT_SORT_WEIGHT = 100;
+const CHUNK_SORT_WEIGHTS = {
+  "manifest.json": 0,
+  ".html": 1,
+  ".js.map": 2,
+  ".js": 2,
+  ".css": 3
+};
+function getChunkSortWeight(filename) {
+  return Object.entries(CHUNK_SORT_WEIGHTS).find(
+    ([key]) => filename.endsWith(key)
+  )?.[1] ?? DEFAULT_SORT_WEIGHT;
+}

package/dist/core/utils/log/printFileList.d.ts

@@ -0,0 +1 @@
+export declare function printFileList(log: (message: string) => void, header: string, baseDir: string, files: string[]): Promise<void>;

package/dist/core/utils/log/printFileList.mjs

@@ -0,0 +1,42 @@
+import path from "node:path";
+import pc from "picocolors";
+import fs from "fs-extra";
+import { filesize } from "filesize";
+import { printTable } from "./printTable.mjs";
+export async function printFileList(log, header, baseDir, files) {
+  let totalSize = 0;
+  const fileRows = await Promise.all(
+    files.map(async (file, i) => {
+      const parts = [
+        path.relative(process.cwd(), baseDir) + path.sep,
+        path.relative(baseDir, file)
+      ];
+      const prefix = i === files.length - 1 ? "  \u2514\u2500" : "  \u251C\u2500";
+      const color = getChunkColor(file);
+      const stats = await fs.lstat(file);
+      totalSize += stats.size;
+      const size = String(filesize(stats.size));
+      return [
+        `${pc.gray(prefix)} ${pc.dim(parts[0])}${color(parts[1])}`,
+        pc.dim(size)
+      ];
+    })
+  );
+  fileRows.push([`${pc.cyan("\u03A3 Total size:")} ${String(filesize(totalSize))}`]);
+  printTable(log, header, fileRows);
+}
+const DEFAULT_COLOR = pc.blue;
+const CHUNK_COLORS = {
+  ".js.map": pc.gray,
+  ".cjs.map": pc.gray,
+  ".mjs.map": pc.gray,
+  ".html": pc.green,
+  ".css": pc.magenta,
+  ".js": pc.cyan,
+  ".cjs": pc.cyan,
+  ".mjs": pc.cyan,
+  ".zip": pc.yellow
+};
+function getChunkColor(filename) {
+  return Object.entries(CHUNK_COLORS).find(([key]) => filename.endsWith(key))?.[1] ?? DEFAULT_COLOR;
+}

package/dist/core/utils/log/printHeader.d.ts

@@ -0,0 +1 @@
+export declare function printHeader(): void;

package/dist/core/utils/log/printHeader.mjs

@@ -0,0 +1,7 @@
+import pc from "picocolors";
+import { version } from "../../../version.mjs";
+import { consola } from "consola";
+export function printHeader() {
+  console.log();
+  consola.log(`${pc.gray("WXT")} ${pc.gray(pc.bold(version))}`);
+}

package/dist/core/utils/log/printTable.d.ts

@@ -0,0 +1 @@
+export declare function printTable(log: (message: string) => void, header: string, rows: string[][], gap?: number): void;

package/dist/core/utils/log/printTable.mjs

@@ -0,0 +1,22 @@
+export function printTable(log, header, rows, gap = 2) {
+  if (rows.length === 0) return;
+  const columnWidths = rows.reduce(
+    (widths, row) => {
+      for (let i = 0; i < Math.max(widths.length, row.length); i++) {
+        widths[i] = Math.max(row[i]?.length ?? 0, widths[i] ?? 0);
+      }
+      return widths;
+    },
+    rows[0].map((column) => column.length)
+  );
+  let str = "";
+  rows.forEach((row, i) => {
+    row.forEach((col, j) => {
+      str += col.padEnd(columnWidths[j], " ");
+      if (j !== row.length - 1) str += "".padEnd(gap, " ");
+    });
+    if (i !== rows.length - 1) str += "\n";
+  });
+  log(`${header}
+${str}`);
+}

package/dist/core/utils/manifest.d.ts

@@ -0,0 +1,44 @@
+import type { Manifest } from 'wxt/browser';
+import { Entrypoint, BuildOutput, ContentScriptEntrypoint } from '../../types';
+/**
+ * Writes the manifest to the output directory and the build output.
+ */
+export declare function writeManifest(manifest: Manifest.WebExtensionManifest, output: BuildOutput): Promise<void>;
+/**
+ * Generates the manifest based on the config and entrypoints.
+ */
+export declare function generateManifest(entrypoints: Entrypoint[], buildOutput: Omit<BuildOutput, 'manifest'>): Promise<{
+    manifest: Manifest.WebExtensionManifest;
+    warnings: any[][];
+}>;
+/**
+ * Returns the bundle paths to CSS files associated with a list of content scripts, or undefined if
+ * there is no associated CSS.
+ */
+export declare function getContentScriptCssFiles(contentScripts: ContentScriptEntrypoint[], contentScriptCssMap: Record<string, string | undefined>): string[] | undefined;
+/**
+ * Content scripts configured with `cssInjectionMode: "ui"` need to add their CSS files to web
+ * accessible resources so they can be fetched as text and added to shadow roots that the UI is
+ * added to.
+ */
+export declare function getContentScriptCssWebAccessibleResources(contentScripts: ContentScriptEntrypoint[], contentScriptCssMap: Record<string, string | undefined>): any[];
+/**
+ * Based on the build output, return a Record of each content script's name to it CSS file if the
+ * script includes one.
+ */
+export declare function getContentScriptsCssMap(buildOutput: Omit<BuildOutput, 'manifest'>, scripts: ContentScriptEntrypoint[]): Record<string, string | undefined>;
+/**
+ * - "<all_urls>" &rarr; "<all_urls>"
+ * - "*://play.google.com/books/*" &rarr; "*://play.google.com/*"
+ */
+export declare function stripPathFromMatchPattern(pattern: string): string;
+/**
+ * Converts all MV3 web accessible resources to their MV2 forms. MV3 web accessible resources are
+ * generated in this file, and may be defined by the user in their manifest. In both cases, when
+ * targetting MV2, automatically convert their definitions down to the basic MV2 array.
+ */
+export declare function convertWebAccessibleResourcesToMv2(manifest: Manifest.WebExtensionManifest): void;
+/**
+ * Make sure all resources are in MV3 format. If not, add a wanring
+ */
+export declare function validateMv3WebAccessbileResources(manifest: Manifest.WebExtensionManifest): void;