@metamask/snaps-cli 6.3.1 → 6.3.3

package/dist/webpack/server.mjs

@@ -1,10 +1,143 @@
-import {
-  getAllowedPaths,
-  getServer
-} from "../chunk-SYRWT2KT.mjs";
-import "../chunk-R77RJHC5.mjs";
-export {
-  getAllowedPaths,
-  getServer
-};
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import { logError, NpmSnapFileNames, readJsonFile } from "@metamask/snaps-utils/node";
+import { createServer } from "http";
+import { join, relative, resolve as resolvePath, sep, posix } from "path";
+import $serveMiddleware from "serve-handler";
+const serveMiddleware = $importDefault($serveMiddleware);
+/**
+ * Get the relative path from one path to another.
+ *
+ * Note: This is a modified version of `path.relative` that uses Posix
+ * separators for URL-compatibility.
+ *
+ * @param from - The path to start from.
+ * @param to - The path to end at.
+ * @returns The relative path.
+ */
+function getRelativePath(from, to) {
+    return relative(from, to).split(sep).join(posix.sep);
+}
+/**
+ * Get the allowed paths for the static server. This includes the output file,
+ * the manifest file, and any auxiliary/localization files.
+ *
+ * @param config - The config object.
+ * @param manifest - The Snap manifest object.
+ * @returns An array of allowed paths.
+ */
+export function getAllowedPaths(config, manifest) {
+    const auxiliaryFiles = manifest.source.files?.map((file) => getRelativePath(config.server.root, resolvePath(config.server.root, file))) ?? [];
+    const localizationFiles = manifest.source.locales?.map((localization) => getRelativePath(config.server.root, resolvePath(config.server.root, localization))) ?? [];
+    const otherFiles = manifest.source.location.npm.iconPath
+        ? [
+            getRelativePath(config.server.root, resolvePath(config.server.root, manifest.source.location.npm.iconPath)),
+        ]
+        : [];
+    return [
+        getRelativePath(config.server.root, resolvePath(config.server.root, config.output.path, config.output.filename)),
+        getRelativePath(config.server.root, resolvePath(config.server.root, NpmSnapFileNames.Manifest)),
+        ...auxiliaryFiles,
+        ...localizationFiles,
+        ...otherFiles,
+    ];
+}
+/**
+ * Get a static server for development purposes.
+ *
+ * Note: We're intentionally not using `webpack-dev-server` here because it
+ * adds a lot of extra stuff to the output that we don't need, and it's
+ * difficult to customize.
+ *
+ * @param config - The config object.
+ * @returns An object with a `listen` method that returns a promise that
+ * resolves when the server is listening.
+ */
+export function getServer(config) {
+    /**
+     * Get the response for a request. This is extracted into a function so that
+     * we can easily catch errors and send a 500 response.
+     *
+     * @param request - The request.
+     * @param response - The response.
+     * @returns A promise that resolves when the response is sent.
+     */
+    async function getResponse(request, response) {
+        const manifestPath = join(config.server.root, NpmSnapFileNames.Manifest);
+        const { result } = await readJsonFile(manifestPath);
+        const allowedPaths = getAllowedPaths(config, result);
+        const path = request.url?.slice(1);
+        const allowed = allowedPaths.some((allowedPath) => path === allowedPath);
+        if (!allowed) {
+            response.statusCode = 404;
+            response.end();
+            return;
+        }
+        await serveMiddleware(request, response, {
+            public: config.server.root,
+            directoryListing: false,
+            headers: [
+                {
+                    source: '**/*',
+                    headers: [
+                        {
+                            key: 'Cache-Control',
+                            value: 'no-cache',
+                        },
+                        {
+                            key: 'Access-Control-Allow-Origin',
+                            value: '*',
+                        },
+                    ],
+                },
+            ],
+        });
+    }
+    const server = createServer((request, response) => {
+        getResponse(request, response).catch(
+        /* istanbul ignore next */
+        (error) => {
+            logError(error);
+            response.statusCode = 500;
+            response.end();
+        });
+    });
+    /**
+     * Start the server on the port specified in the config.
+     *
+     * @param port - The port to listen on.
+     * @returns A promise that resolves when the server is listening. The promise
+     * resolves to an object with the port and the server instance. Note that if
+     * the `config.server.port` is `0`, the OS will choose a random port for us,
+     * so we need to get the port from the server after it starts.
+     */
+    const listen = async (port = config.server.port) => {
+        return new Promise((resolve, reject) => {
+            try {
+                server.listen(port, () => {
+                    const close = async () => {
+                        await new Promise((resolveClose, rejectClose) => {
+                            server.close((closeError) => {
+                                if (closeError) {
+                                    return rejectClose(closeError);
+                                }
+                                return resolveClose();
+                            });
+                        });
+                    };
+                    const address = server.address();
+                    resolve({ port: address.port, server, close });
+                });
+            }
+            catch (listenError) {
+                reject(listenError);
+            }
+        });
+    };
+    return { listen };
+}
 //# sourceMappingURL=server.mjs.map

package/dist/webpack/server.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"server.mjs","sourceRoot":"","sources":["../../src/webpack/server.ts"],"names":[],"mappings":";;;;;;AACA,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACb,mCAAmC;AAEpC,OAAO,EAAE,YAAY,EAAE,aAAa;AAEpC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,IAAI,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,aAAa;AAC1E,OAAO,gBAAe,sBAAsB;;AAI5C;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,EAAU;IAC/C,OAAO,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAuB,EACvB,QAAsB;IAEtB,MAAM,cAAc,GAClB,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,eAAe,CACb,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CACtC,CACF,IAAI,EAAE,CAAC;IAEV,MAAM,iBAAiB,GACrB,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAC5C,eAAe,CACb,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAC9C,CACF,IAAI,EAAE,CAAC;IAEV,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ;QACtD,CAAC,CAAC;YACE,eAAe,CACb,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,WAAW,CACT,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CACtC,CACF;SACF;QACH,CAAC,CAAC,EAAE,CAAC;IAEP,OAAO;QACL,eAAe,CACb,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,WAAW,CACT,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,MAAM,CAAC,MAAM,CAAC,QAAQ,CACvB,CACF;QACD,eAAe,CACb,MAAM,CAAC,MAAM,CAAC,IAAI,EAClB,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAC3D;QACD,GAAG,cAAc;QACjB,GAAG,iBAAiB;QACpB,GAAG,UAAU;KACd,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,MAAuB;IAC/C;;;;;;;OAOG;IACH,KAAK,UAAU,WAAW,CACxB,OAAwB,EACxB,QAAwB;QAExB,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACzE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,YAAY,CAAe,YAAY,CAAC,CAAC;QAClE,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAErD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;QAEzE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;YAC1B,QAAQ,CAAC,GAAG,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QAED,MAAM,eAAe,CAAC,OAAO,EAAE,QAAQ,EAAE;YACvC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI;YAC1B,gBAAgB,EAAE,KAAK;YACvB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACP;4BACE,GAAG,EAAE,eAAe;4BACpB,KAAK,EAAE,UAAU;yBAClB;wBACD;4BACE,GAAG,EAAE,6BAA6B;4BAClC,KAAK,EAAE,GAAG;yBACX;qBACF;iBACF;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;QAChD,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,KAAK;QAClC,0BAA0B;QAC1B,CAAC,KAAK,EAAE,EAAE;YACR,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;YAC1B,QAAQ,CAAC,GAAG,EAAE,CAAC;QACjB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACH,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;QACjD,OAAO,IAAI,OAAO,CAIf,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrB,IAAI,CAAC;gBACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;oBACvB,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE;wBACvB,MAAM,IAAI,OAAO,CAAO,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;4BACpD,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE;gCAC1B,IAAI,UAAU,EAAE,CAAC;oCACf,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;gCACjC,CAAC;gCAED,OAAO,YAAY,EAAE,CAAC;4BACxB,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC;oBAEF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAiB,CAAC;oBAChD,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,WAAW,EAAE,CAAC;gBACrB,MAAM,CAAC,WAAW,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC","sourcesContent":["import type { SnapManifest } from '@metamask/snaps-utils';\nimport {\n  logError,\n  NpmSnapFileNames,\n  readJsonFile,\n} from '@metamask/snaps-utils/node';\nimport type { IncomingMessage, Server, ServerResponse } from 'http';\nimport { createServer } from 'http';\nimport type { AddressInfo } from 'net';\nimport { join, relative, resolve as resolvePath, sep, posix } from 'path';\nimport serveMiddleware from 'serve-handler';\n\nimport type { ProcessedConfig } from '../config';\n\n/**\n * Get the relative path from one path to another.\n *\n * Note: This is a modified version of `path.relative` that uses Posix\n * separators for URL-compatibility.\n *\n * @param from - The path to start from.\n * @param to - The path to end at.\n * @returns The relative path.\n */\nfunction getRelativePath(from: string, to: string) {\n  return relative(from, to).split(sep).join(posix.sep);\n}\n\n/**\n * Get the allowed paths for the static server. This includes the output file,\n * the manifest file, and any auxiliary/localization files.\n *\n * @param config - The config object.\n * @param manifest - The Snap manifest object.\n * @returns An array of allowed paths.\n */\nexport function getAllowedPaths(\n  config: ProcessedConfig,\n  manifest: SnapManifest,\n) {\n  const auxiliaryFiles =\n    manifest.source.files?.map((file) =>\n      getRelativePath(\n        config.server.root,\n        resolvePath(config.server.root, file),\n      ),\n    ) ?? [];\n\n  const localizationFiles =\n    manifest.source.locales?.map((localization) =>\n      getRelativePath(\n        config.server.root,\n        resolvePath(config.server.root, localization),\n      ),\n    ) ?? [];\n\n  const otherFiles = manifest.source.location.npm.iconPath\n    ? [\n        getRelativePath(\n          config.server.root,\n          resolvePath(\n            config.server.root,\n            manifest.source.location.npm.iconPath,\n          ),\n        ),\n      ]\n    : [];\n\n  return [\n    getRelativePath(\n      config.server.root,\n      resolvePath(\n        config.server.root,\n        config.output.path,\n        config.output.filename,\n      ),\n    ),\n    getRelativePath(\n      config.server.root,\n      resolvePath(config.server.root, NpmSnapFileNames.Manifest),\n    ),\n    ...auxiliaryFiles,\n    ...localizationFiles,\n    ...otherFiles,\n  ];\n}\n\n/**\n * Get a static server for development purposes.\n *\n * Note: We're intentionally not using `webpack-dev-server` here because it\n * adds a lot of extra stuff to the output that we don't need, and it's\n * difficult to customize.\n *\n * @param config - The config object.\n * @returns An object with a `listen` method that returns a promise that\n * resolves when the server is listening.\n */\nexport function getServer(config: ProcessedConfig) {\n  /**\n   * Get the response for a request. This is extracted into a function so that\n   * we can easily catch errors and send a 500 response.\n   *\n   * @param request - The request.\n   * @param response - The response.\n   * @returns A promise that resolves when the response is sent.\n   */\n  async function getResponse(\n    request: IncomingMessage,\n    response: ServerResponse,\n  ) {\n    const manifestPath = join(config.server.root, NpmSnapFileNames.Manifest);\n    const { result } = await readJsonFile<SnapManifest>(manifestPath);\n    const allowedPaths = getAllowedPaths(config, result);\n\n    const path = request.url?.slice(1);\n    const allowed = allowedPaths.some((allowedPath) => path === allowedPath);\n\n    if (!allowed) {\n      response.statusCode = 404;\n      response.end();\n      return;\n    }\n\n    await serveMiddleware(request, response, {\n      public: config.server.root,\n      directoryListing: false,\n      headers: [\n        {\n          source: '**/*',\n          headers: [\n            {\n              key: 'Cache-Control',\n              value: 'no-cache',\n            },\n            {\n              key: 'Access-Control-Allow-Origin',\n              value: '*',\n            },\n          ],\n        },\n      ],\n    });\n  }\n\n  const server = createServer((request, response) => {\n    getResponse(request, response).catch(\n      /* istanbul ignore next */\n      (error) => {\n        logError(error);\n        response.statusCode = 500;\n        response.end();\n      },\n    );\n  });\n\n  /**\n   * Start the server on the port specified in the config.\n   *\n   * @param port - The port to listen on.\n   * @returns A promise that resolves when the server is listening. The promise\n   * resolves to an object with the port and the server instance. Note that if\n   * the `config.server.port` is `0`, the OS will choose a random port for us,\n   * so we need to get the port from the server after it starts.\n   */\n  const listen = async (port = config.server.port) => {\n    return new Promise<{\n      port: number;\n      server: Server;\n      close: () => Promise<void>;\n    }>((resolve, reject) => {\n      try {\n        server.listen(port, () => {\n          const close = async () => {\n            await new Promise<void>((resolveClose, rejectClose) => {\n              server.close((closeError) => {\n                if (closeError) {\n                  return rejectClose(closeError);\n                }\n\n                return resolveClose();\n              });\n            });\n          };\n\n          const address = server.address() as AddressInfo;\n          resolve({ port: address.port, server, close });\n        });\n      } catch (listenError) {\n        reject(listenError);\n      }\n    });\n  };\n\n  return { listen };\n}\n"]}

package/dist/webpack/utils.cjs

@@ -0,0 +1,359 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImageSVG = exports.formatText = exports.getEnvironmentVariables = exports.getFallbacks = exports.pluralize = exports.getBrowserslistTargets = exports.getProgressHandler = exports.getDevTool = exports.getDefaultLoader = exports.WEBPACK_FALLBACKS = exports.BROWSERSLIST_FILE = void 0;
+const utils_1 = require("@metamask/utils");
+const chalk_1 = require("chalk");
+const fs_1 = require("fs");
+const module_1 = require("module");
+const path_1 = require("path");
+const strip_ansi_1 = __importDefault(require("strip-ansi/index.js"));
+const loaders_1 = require("./loaders/index.cjs");
+exports.BROWSERSLIST_FILE = (0, path_1.resolve)((0, path_1.dirname)(
+// eslint-disable-next-line n/no-extraneous-require
+require.resolve('@metamask/snaps-cli/package.json')), '.browserslistrc');
+exports.WEBPACK_FALLBACKS = {
+    assert: require.resolve('assert/'),
+    buffer: require.resolve('buffer/'),
+    console: require.resolve('console-browserify'),
+    constants: require.resolve('constants-browserify'),
+    crypto: require.resolve('crypto-browserify'),
+    domain: require.resolve('domain-browser'),
+    events: require.resolve('events/'),
+    http: require.resolve('stream-http'),
+    https: require.resolve('https-browserify'),
+    os: require.resolve('os-browserify/browser'),
+    path: require.resolve('path-browserify'),
+    punycode: require.resolve('punycode/'),
+    process: require.resolve('process/browser'),
+    querystring: require.resolve('querystring-es3'),
+    stream: require.resolve('stream-browserify'),
+    /* eslint-disable @typescript-eslint/naming-convention  */
+    _stream_duplex: require.resolve('readable-stream/lib/_stream_duplex'),
+    _stream_passthrough: require.resolve('readable-stream/lib/_stream_passthrough'),
+    _stream_readable: require.resolve('readable-stream/lib/_stream_readable'),
+    _stream_transform: require.resolve('readable-stream/lib/_stream_transform'),
+    _stream_writable: require.resolve('readable-stream/lib/_stream_writable'),
+    string_decoder: require.resolve('string_decoder/'),
+    /* eslint-enable @typescript-eslint/naming-convention  */
+    sys: require.resolve('util/'),
+    timers: require.resolve('timers-browserify'),
+    tty: require.resolve('tty-browserify'),
+    url: require.resolve('url/'),
+    util: require.resolve('util/'),
+    vm: require.resolve('vm-browserify'),
+    zlib: require.resolve('browserify-zlib'),
+};
+/**
+ * Get the default loader for JavaScript and TypeScript files, based on the
+ * config object.
+ *
+ * - If the `legacy` option is set, we use the custom `browserify` loader. This
+ * uses the legacy Browserify config to transpile the code.
+ * - Otherwise, we use the `swc-loader`. This is a Webpack loader that uses the
+ * `SWC` compiler, which is a much faster alternative to Babel and TypeScript's
+ * own compiler.
+ *
+ * @param config - The processed snap Webpack config.
+ * @param config.legacy - The legacy config object, if any.
+ * @param config.sourceMap - Whether to generate source maps.
+ * @see https://swc.rs/docs/usage/swc-loader
+ * @returns The default loader.
+ */
+async function getDefaultLoader({ legacy, sourceMap, }) {
+    if (legacy) {
+        /**
+         * If the snap uses the legacy config, we use the custom `browserify`
+         * loader. This uses the legacy Browserify config to transpile the code.
+         * This is necessary for backwards compatibility with the
+         * `bundlerCustomizer` function.
+         */
+        return (0, loaders_1.getFunctionLoader)(loaders_1.browserify, legacy);
+    }
+    const targets = await getBrowserslistTargets();
+    return {
+        /**
+         * We use the `swc-loader` to transpile TypeScript and JavaScript files.
+         * This is a Webpack loader that uses the `SWC` compiler, which is a much
+         * faster alternative to Babel and TypeScript's own compiler.
+         */
+        loader: require.resolve('swc-loader'),
+        /**
+         * The options for the `swc-loader`. These can be overridden in the
+         * `.swcrc` file.
+         *
+         * @see https://swc.rs/docs/configuration/swcrc
+         */
+        options: {
+            sync: false,
+            /**
+             * This tells SWC to generate source maps. We set it to the
+             * `sourceMap` value from the config object.
+             *
+             * This must be enabled if source maps are enabled in the config.
+             */
+            sourceMaps: Boolean(getDevTool(sourceMap)),
+            jsc: {
+                parser: {
+                    /**
+                     * This tells the parser to parse TypeScript files. If you
+                     * don't need to support TypeScript, you can set this to
+                     * `ecmascript` instead, but there's no harm in leaving it
+                     * as `typescript`.
+                     *
+                     * @see https://swc.rs/docs/configuration/compilation#jscparser
+                     */
+                    syntax: 'typescript',
+                    /**
+                     * This tells the parser to transpile JSX.
+                     *
+                     * @see https://swc.rs/docs/configuration/compilation#jscparser
+                     * @see https://swc.rs/docs/configuration/compilation#jscparserjsx
+                     */
+                    tsx: true,
+                },
+                transform: {
+                    react: {
+                        /**
+                         * This tells SWC to use the JSX runtime, instead of the
+                         * `createElement` function.
+                         *
+                         * @see https://swc.rs/docs/configuration/compilation#jsctransformreact
+                         */
+                        runtime: 'automatic',
+                        /**
+                         * This tells SWC to import the JSX runtime from the
+                         * `@metamask/snaps-sdk` package, instead of the default React
+                         * package.
+                         *
+                         * @see https://swc.rs/docs/configuration/compilation#jsctransformreact
+                         */
+                        importSource: '@metamask/snaps-sdk',
+                        /**
+                         * This tells SWC to use `Object.assign` and `Object.create` for
+                         * JSX spread attributes, instead of the default behavior.
+                         *
+                         * @see https://swc.rs/docs/configuration/compilation#jsctransformreact
+                         */
+                        useBuiltins: true,
+                    },
+                },
+            },
+            /**
+             * The module configuration. This tells SWC how to output the
+             * transpiled code.
+             *
+             * @see https://swc.rs/docs/configuration/modules
+             */
+            module: {
+                /**
+                 * This tells SWC to output ES6 modules. This will allow Webpack to
+                 * optimize the output code better. Snaps don't support ES6 however, so
+                 * the output code will be transpiled to CommonJS by Webpack later in
+                 * the build process.
+                 *
+                 * @see https://swc.rs/docs/configuration/modules#es6
+                 */
+                type: 'es6',
+            },
+            env: {
+                targets: targets.join(', '),
+            },
+        },
+    };
+}
+exports.getDefaultLoader = getDefaultLoader;
+/**
+ * Get the Webpack devtool configuration based on the given snap config.
+ *
+ * - If `sourceMap` is `inline`, return `inline-source-map`.
+ * - If `sourceMap` is `true`, return `source-map`.
+ * - Otherwise, return `false`.
+ *
+ * @param sourceMap - The `sourceMap` value from the snap config.
+ * @returns The Webpack devtool configuration.
+ */
+function getDevTool(sourceMap) {
+    if (sourceMap === 'inline') {
+        return 'inline-source-map';
+    }
+    if (sourceMap === true) {
+        return 'source-map';
+    }
+    return false;
+}
+exports.getDevTool = getDevTool;
+/**
+ * Get a function that can be used as handler function for Webpack's
+ * `ProgressPlugin`.
+ *
+ * @param spinner - The spinner to update.
+ * @param spinnerText - The initial spinner text. This will be prepended to the
+ * percentage.
+ * @returns A function that can be used as handler function for Webpack's
+ * `ProgressPlugin`.
+ */
+// Note: This is extracted for testing purposes.
+function getProgressHandler(spinner, spinnerText) {
+    return (percentage) => {
+        if (spinner && spinnerText) {
+            spinner.text = `${spinnerText} ${(0, chalk_1.dim)(`(${Math.round(percentage * 100)}%)`)}`;
+        }
+    };
+}
+exports.getProgressHandler = getProgressHandler;
+/**
+ * Get the targets from the `.browserslistrc` file.
+ *
+ * @returns The browser targets as an array of strings.
+ */
+async function getBrowserslistTargets() {
+    const contents = await fs_1.promises.readFile(exports.BROWSERSLIST_FILE, 'utf8');
+    return contents
+        .split('\n')
+        .map((line) => line.trim())
+        .filter((line) => line && !line.startsWith('#'));
+}
+exports.getBrowserslistTargets = getBrowserslistTargets;
+/**
+ * Get a singular or plural string based on the given count. This is useful for
+ * generating messages like "1 error" or "2 errors". By default, the plural
+ * string is the singular string with an "s" appended to it.
+ *
+ * This assumes that the text is in English, and likely won't work for some
+ * other languages.
+ *
+ * @param count - The count.
+ * @param singular - The singular string.
+ * @param plural - The plural string.
+ * @returns The singular or plural string.
+ * @example
+ * ```typescript
+ * pluralize(1, 'error'); // => 'error'
+ * pluralize(2, 'error'); // => 'errors'
+ * pluralize(1, 'error', 'problem'); // => 'error'
+ * pluralize(2, 'error', 'problems'); // => 'problems'
+ * ```
+ */
+function pluralize(count, singular, plural = `${singular}s`) {
+    return count === 1 ? singular : plural;
+}
+exports.pluralize = pluralize;
+/**
+ * Get an object that can be used as fallback config for Webpack's
+ * `fallback` config.
+ *
+ * @param polyfills - The polyfill object from the snap config.
+ * @returns The webpack fallback config.
+ */
+function getFallbacks(polyfills) {
+    if (polyfills === true) {
+        return Object.fromEntries(module_1.builtinModules.map((name) => [
+            name,
+            exports.WEBPACK_FALLBACKS[name] ?? false,
+        ]));
+    }
+    if (polyfills === false) {
+        return Object.fromEntries(module_1.builtinModules.map((name) => [name, false]));
+    }
+    return Object.fromEntries(module_1.builtinModules.map((name) => [
+        name,
+        polyfills[name]
+            ? exports.WEBPACK_FALLBACKS[name]
+            : false,
+    ]));
+}
+exports.getFallbacks = getFallbacks;
+/**
+ * Get an object that can be used as environment variables for Webpack's
+ * `DefinePlugin`.
+ *
+ * @param environment - The environment object from the Snap config.
+ * @param defaults - The default environment variables.
+ * @returns The Webpack environment variables.
+ */
+function getEnvironmentVariables(environment, defaults = {
+    NODE_DEBUG: 'false',
+    NODE_ENV: 'production',
+    DEBUG: 'false',
+}) {
+    return Object.fromEntries(Object.entries({
+        ...defaults,
+        ...environment,
+    }).map(([key, value]) => [`process.env.${key}`, JSON.stringify(value)]));
+}
+exports.getEnvironmentVariables = getEnvironmentVariables;
+/**
+ * Format the given line to fit within the terminal width.
+ *
+ * @param line - The line to format.
+ * @param indent - The indentation to use.
+ * @param initialIndent - The initial indentation to use, i.e., the indentation
+ * for the first line.
+ * @returns The formatted line.
+ */
+function formatLine(line, indent, initialIndent) {
+    const terminalWidth = process.stdout.columns;
+    if (!terminalWidth) {
+        return `${' '.repeat(initialIndent)}${line}`;
+    }
+    return line.split(' ').reduce(({ formattedText, currentLineLength }, word, index) => {
+        // `chalk` adds ANSI escape codes to the text, which are not visible
+        // characters. We need to strip them to get the visible length of the
+        // text.
+        const visibleWord = (0, strip_ansi_1.default)(word);
+        // Determine if a space should be added before the word.
+        const spaceBeforeWord = index > 0 ? ' ' : '';
+        const wordLengthWithSpace = visibleWord.length + spaceBeforeWord.length;
+        // If the word would exceed the terminal width, start a new line.
+        if (currentLineLength + wordLengthWithSpace > terminalWidth) {
+            return {
+                formattedText: `${formattedText}\n${' '.repeat(indent)}${word}`,
+                currentLineLength: indent + visibleWord.length,
+            };
+        }
+        // Otherwise, add the word to the current line.
+        return {
+            formattedText: formattedText + spaceBeforeWord + word,
+            currentLineLength: currentLineLength + wordLengthWithSpace,
+        };
+    }, {
+        formattedText: ' '.repeat(initialIndent),
+        currentLineLength: initialIndent,
+    }).formattedText;
+}
+/**
+ * Format the given text to fit within the terminal width.
+ *
+ * @param text - The text to format.
+ * @param indent - The indentation to use.
+ * @param initialIndent - The initial indentation to use, i.e., the indentation
+ * for the first line.
+ * @returns The formatted text.
+ */
+function formatText(text, indent, initialIndent = indent) {
+    const lines = text.split('\n');
+    // Apply formatting to each line separately and then join them.
+    return lines
+        .map((line, index) => {
+        const lineIndent = index === 0 ? initialIndent : indent;
+        return formatLine(line, indent, lineIndent);
+    })
+        .join('\n');
+}
+exports.formatText = formatText;
+/**
+ * Get an SVG from the given bytes and mime type.
+ *
+ * @param mimeType - The mime type of the image.
+ * @param bytes - The image bytes.
+ * @returns The SVG.
+ */
+function getImageSVG(mimeType, bytes) {
+    const dataUrl = `data:${mimeType};base64,${(0, utils_1.bytesToBase64)(bytes)}`;
+    return `<svg xmlns="http://www.w3.org/2000/svg"><image href="${dataUrl}" /></svg>`;
+}
+exports.getImageSVG = getImageSVG;
+//# sourceMappingURL=utils.cjs.map

package/dist/webpack/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../src/webpack/utils.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAgD;AAChD,iCAA4B;AAC5B,2BAAoC;AACpC,mCAAwC;AAExC,+BAAwC;AACxC,qEAAmC;AAInC,iDAA0D;AAE7C,QAAA,iBAAiB,GAAG,IAAA,cAAO,EACtC,IAAA,cAAO;AACL,mDAAmD;AACnD,OAAO,CAAC,OAAO,CAAC,kCAAkC,CAAC,CACpD,EACD,iBAAiB,CAClB,CAAC;AAEW,QAAA,iBAAiB,GAAG;IAC/B,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;IAClC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC;IAC9C,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC;IAClD,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAC5C,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;IACzC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;IAClC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;IACpC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC;IAC1C,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC;IAC5C,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;IACxC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IACtC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAC3C,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAC/C,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAC5C,0DAA0D;IAC1D,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,oCAAoC,CAAC;IACrE,mBAAmB,EAAE,OAAO,CAAC,OAAO,CAClC,yCAAyC,CAC1C;IACD,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,sCAAsC,CAAC;IACzE,iBAAiB,EAAE,OAAO,CAAC,OAAO,CAAC,uCAAuC,CAAC;IAC3E,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,sCAAsC,CAAC;IACzE,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAClD,yDAAyD;IACzD,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAC5C,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;IACtC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;IACpC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;CACzC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,gBAAgB,CAAC,EACrC,MAAM,EACN,SAAS,GACc;IACvB,IAAI,MAAM,EAAE,CAAC;QACX;;;;;WAKG;QACH,OAAO,IAAA,2BAAiB,EAAC,oBAAU,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,sBAAsB,EAAE,CAAC;IAC/C,OAAO;QACL;;;;WAIG;QACH,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC;QAErC;;;;;WAKG;QACH,OAAO,EAAE;YACP,IAAI,EAAE,KAAK;YAEX;;;;;eAKG;YACH,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAE1C,GAAG,EAAE;gBACH,MAAM,EAAE;oBACN;;;;;;;uBAOG;oBACH,MAAM,EAAE,YAAY;oBAEpB;;;;;uBAKG;oBACH,GAAG,EAAE,IAAI;iBACV;gBAED,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL;;;;;2BAKG;wBACH,OAAO,EAAE,WAAW;wBAEpB;;;;;;2BAMG;wBACH,YAAY,EAAE,qBAAqB;wBAEnC;;;;;2BAKG;wBACH,WAAW,EAAE,IAAI;qBAClB;iBACF;aACF;YAED;;;;;eAKG;YACH,MAAM,EAAE;gBACN;;;;;;;mBAOG;gBACH,IAAI,EAAE,KAAK;aACZ;YAED,GAAG,EAAE;gBACH,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;aAC5B;SACF;KACF,CAAC;AACJ,CAAC;AAlHD,4CAkHC;AAED;;;;;;;;;GASG;AACH,SAAgB,UAAU,CACxB,SAA8C;IAE9C,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAZD,gCAYC;AAED;;;;;;;;;GASG;AACH,gDAAgD;AAChD,SAAgB,kBAAkB,CAAC,OAAa,EAAE,WAAoB;IACpE,OAAO,CAAC,UAAkB,EAAE,EAAE;QAC5B,IAAI,OAAO,IAAI,WAAW,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,GAAG,GAAG,WAAW,IAAI,IAAA,WAAG,EAClC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,IAAI,CACrC,EAAE,CAAC;QACN,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AARD,gDAQC;AAED;;;;GAIG;AACI,KAAK,UAAU,sBAAsB;IAC1C,MAAM,QAAQ,GAAG,MAAM,aAAE,CAAC,QAAQ,CAAC,yBAAiB,EAAE,MAAM,CAAC,CAAC;IAC9D,OAAO,QAAQ;SACZ,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACrD,CAAC;AAND,wDAMC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,SAAS,CACvB,KAAa,EACb,QAAgB,EAChB,MAAM,GAAG,GAAG,QAAQ,GAAG;IAEvB,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;AACzC,CAAC;AAND,8BAMC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,SAA8C;IAGzE,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC,WAAW,CACvB,uBAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC3B,IAAI;YACJ,yBAAiB,CAAC,IAAsC,CAAC,IAAI,KAAK;SACnE,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC,WAAW,CAAC,uBAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC,WAAW,CACvB,uBAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC3B,IAAI;QACJ,SAAS,CAAC,IAAiD,CAAC;YAC1D,CAAC,CAAC,yBAAiB,CAAC,IAAsC,CAAC;YAC3D,CAAC,CAAC,KAAK;KACV,CAAC,CACH,CAAC;AACJ,CAAC;AAxBD,oCAwBC;AAED;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CACrC,WAAoC,EACpC,QAAQ,GAAG;IACT,UAAU,EAAE,OAAO;IACnB,QAAQ,EAAE,YAAY;IACtB,KAAK,EAAE,OAAO;CACf;IAED,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC;QACb,GAAG,QAAQ;QACX,GAAG,WAAW;KACf,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,eAAe,GAAG,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CACxE,CAAC;AACJ,CAAC;AAdD,0DAcC;AAED;;;;;;;;GAQG;AACH,SAAS,UAAU,CAAC,IAAY,EAAE,MAAc,EAAE,aAAqB;IACrE,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7C,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,EAAE,CAAC;IAC/C,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAC3B,CAAC,EAAE,aAAa,EAAE,iBAAiB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QACpD,oEAAoE;QACpE,qEAAqE;QACrE,QAAQ;QACR,MAAM,WAAW,GAAG,IAAA,oBAAS,EAAC,IAAI,CAAC,CAAC;QAEpC,wDAAwD;QACxD,MAAM,eAAe,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,MAAM,mBAAmB,GAAG,WAAW,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;QAExE,iEAAiE;QACjE,IAAI,iBAAiB,GAAG,mBAAmB,GAAG,aAAa,EAAE,CAAC;YAC5D,OAAO;gBACL,aAAa,EAAE,GAAG,aAAa,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE;gBAC/D,iBAAiB,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM;aAC/C,CAAC;QACJ,CAAC;QAED,+CAA+C;QAC/C,OAAO;YACL,aAAa,EAAE,aAAa,GAAG,eAAe,GAAG,IAAI;YACrD,iBAAiB,EAAE,iBAAiB,GAAG,mBAAmB;SAC3D,CAAC;IACJ,CAAC,EACD;QACE,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;QACxC,iBAAiB,EAAE,aAAa;KACjC,CACF,CAAC,aAAa,CAAC;AAClB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CACxB,IAAY,EACZ,MAAc,EACd,aAAa,GAAG,MAAM;IAEtB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE/B,+DAA+D;IAC/D,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACnB,MAAM,UAAU,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;QACxD,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAdD,gCAcC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,QAAgB,EAAE,KAAiB;IAC7D,MAAM,OAAO,GAAG,QAAQ,QAAQ,WAAW,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;IAClE,OAAO,wDAAwD,OAAO,YAAY,CAAC;AACrF,CAAC;AAHD,kCAGC","sourcesContent":["import { bytesToBase64 } from '@metamask/utils';\nimport { dim } from 'chalk';\nimport { promises as fs } from 'fs';\nimport { builtinModules } from 'module';\nimport type { Ora } from 'ora';\nimport { dirname, resolve } from 'path';\nimport stripAnsi from 'strip-ansi';\nimport type { Configuration } from 'webpack';\n\nimport type { ProcessedWebpackConfig } from '../config';\nimport { browserify, getFunctionLoader } from './loaders';\n\nexport const BROWSERSLIST_FILE = resolve(\n  dirname(\n    // eslint-disable-next-line n/no-extraneous-require\n    require.resolve('@metamask/snaps-cli/package.json'),\n  ),\n  '.browserslistrc',\n);\n\nexport const WEBPACK_FALLBACKS = {\n  assert: require.resolve('assert/'),\n  buffer: require.resolve('buffer/'),\n  console: require.resolve('console-browserify'),\n  constants: require.resolve('constants-browserify'),\n  crypto: require.resolve('crypto-browserify'),\n  domain: require.resolve('domain-browser'),\n  events: require.resolve('events/'),\n  http: require.resolve('stream-http'),\n  https: require.resolve('https-browserify'),\n  os: require.resolve('os-browserify/browser'),\n  path: require.resolve('path-browserify'),\n  punycode: require.resolve('punycode/'),\n  process: require.resolve('process/browser'),\n  querystring: require.resolve('querystring-es3'),\n  stream: require.resolve('stream-browserify'),\n  /* eslint-disable @typescript-eslint/naming-convention  */\n  _stream_duplex: require.resolve('readable-stream/lib/_stream_duplex'),\n  _stream_passthrough: require.resolve(\n    'readable-stream/lib/_stream_passthrough',\n  ),\n  _stream_readable: require.resolve('readable-stream/lib/_stream_readable'),\n  _stream_transform: require.resolve('readable-stream/lib/_stream_transform'),\n  _stream_writable: require.resolve('readable-stream/lib/_stream_writable'),\n  string_decoder: require.resolve('string_decoder/'),\n  /* eslint-enable @typescript-eslint/naming-convention  */\n  sys: require.resolve('util/'),\n  timers: require.resolve('timers-browserify'),\n  tty: require.resolve('tty-browserify'),\n  url: require.resolve('url/'),\n  util: require.resolve('util/'),\n  vm: require.resolve('vm-browserify'),\n  zlib: require.resolve('browserify-zlib'),\n};\n\n/**\n * Get the default loader for JavaScript and TypeScript files, based on the\n * config object.\n *\n * - If the `legacy` option is set, we use the custom `browserify` loader. This\n * uses the legacy Browserify config to transpile the code.\n * - Otherwise, we use the `swc-loader`. This is a Webpack loader that uses the\n * `SWC` compiler, which is a much faster alternative to Babel and TypeScript's\n * own compiler.\n *\n * @param config - The processed snap Webpack config.\n * @param config.legacy - The legacy config object, if any.\n * @param config.sourceMap - Whether to generate source maps.\n * @see https://swc.rs/docs/usage/swc-loader\n * @returns The default loader.\n */\nexport async function getDefaultLoader({\n  legacy,\n  sourceMap,\n}: ProcessedWebpackConfig) {\n  if (legacy) {\n    /**\n     * If the snap uses the legacy config, we use the custom `browserify`\n     * loader. This uses the legacy Browserify config to transpile the code.\n     * This is necessary for backwards compatibility with the\n     * `bundlerCustomizer` function.\n     */\n    return getFunctionLoader(browserify, legacy);\n  }\n\n  const targets = await getBrowserslistTargets();\n  return {\n    /**\n     * We use the `swc-loader` to transpile TypeScript and JavaScript files.\n     * This is a Webpack loader that uses the `SWC` compiler, which is a much\n     * faster alternative to Babel and TypeScript's own compiler.\n     */\n    loader: require.resolve('swc-loader'),\n\n    /**\n     * The options for the `swc-loader`. These can be overridden in the\n     * `.swcrc` file.\n     *\n     * @see https://swc.rs/docs/configuration/swcrc\n     */\n    options: {\n      sync: false,\n\n      /**\n       * This tells SWC to generate source maps. We set it to the\n       * `sourceMap` value from the config object.\n       *\n       * This must be enabled if source maps are enabled in the config.\n       */\n      sourceMaps: Boolean(getDevTool(sourceMap)),\n\n      jsc: {\n        parser: {\n          /**\n           * This tells the parser to parse TypeScript files. If you\n           * don't need to support TypeScript, you can set this to\n           * `ecmascript` instead, but there's no harm in leaving it\n           * as `typescript`.\n           *\n           * @see https://swc.rs/docs/configuration/compilation#jscparser\n           */\n          syntax: 'typescript',\n\n          /**\n           * This tells the parser to transpile JSX.\n           *\n           * @see https://swc.rs/docs/configuration/compilation#jscparser\n           * @see https://swc.rs/docs/configuration/compilation#jscparserjsx\n           */\n          tsx: true,\n        },\n\n        transform: {\n          react: {\n            /**\n             * This tells SWC to use the JSX runtime, instead of the\n             * `createElement` function.\n             *\n             * @see https://swc.rs/docs/configuration/compilation#jsctransformreact\n             */\n            runtime: 'automatic',\n\n            /**\n             * This tells SWC to import the JSX runtime from the\n             * `@metamask/snaps-sdk` package, instead of the default React\n             * package.\n             *\n             * @see https://swc.rs/docs/configuration/compilation#jsctransformreact\n             */\n            importSource: '@metamask/snaps-sdk',\n\n            /**\n             * This tells SWC to use `Object.assign` and `Object.create` for\n             * JSX spread attributes, instead of the default behavior.\n             *\n             * @see https://swc.rs/docs/configuration/compilation#jsctransformreact\n             */\n            useBuiltins: true,\n          },\n        },\n      },\n\n      /**\n       * The module configuration. This tells SWC how to output the\n       * transpiled code.\n       *\n       * @see https://swc.rs/docs/configuration/modules\n       */\n      module: {\n        /**\n         * This tells SWC to output ES6 modules. This will allow Webpack to\n         * optimize the output code better. Snaps don't support ES6 however, so\n         * the output code will be transpiled to CommonJS by Webpack later in\n         * the build process.\n         *\n         * @see https://swc.rs/docs/configuration/modules#es6\n         */\n        type: 'es6',\n      },\n\n      env: {\n        targets: targets.join(', '),\n      },\n    },\n  };\n}\n\n/**\n * Get the Webpack devtool configuration based on the given snap config.\n *\n * - If `sourceMap` is `inline`, return `inline-source-map`.\n * - If `sourceMap` is `true`, return `source-map`.\n * - Otherwise, return `false`.\n *\n * @param sourceMap - The `sourceMap` value from the snap config.\n * @returns The Webpack devtool configuration.\n */\nexport function getDevTool(\n  sourceMap: ProcessedWebpackConfig['sourceMap'],\n): Configuration['devtool'] {\n  if (sourceMap === 'inline') {\n    return 'inline-source-map';\n  }\n\n  if (sourceMap === true) {\n    return 'source-map';\n  }\n\n  return false;\n}\n\n/**\n * Get a function that can be used as handler function for Webpack's\n * `ProgressPlugin`.\n *\n * @param spinner - The spinner to update.\n * @param spinnerText - The initial spinner text. This will be prepended to the\n * percentage.\n * @returns A function that can be used as handler function for Webpack's\n * `ProgressPlugin`.\n */\n// Note: This is extracted for testing purposes.\nexport function getProgressHandler(spinner?: Ora, spinnerText?: string) {\n  return (percentage: number) => {\n    if (spinner && spinnerText) {\n      spinner.text = `${spinnerText} ${dim(\n        `(${Math.round(percentage * 100)}%)`,\n      )}`;\n    }\n  };\n}\n\n/**\n * Get the targets from the `.browserslistrc` file.\n *\n * @returns The browser targets as an array of strings.\n */\nexport async function getBrowserslistTargets() {\n  const contents = await fs.readFile(BROWSERSLIST_FILE, 'utf8');\n  return contents\n    .split('\\n')\n    .map((line) => line.trim())\n    .filter((line) => line && !line.startsWith('#'));\n}\n\n/**\n * Get a singular or plural string based on the given count. This is useful for\n * generating messages like \"1 error\" or \"2 errors\". By default, the plural\n * string is the singular string with an \"s\" appended to it.\n *\n * This assumes that the text is in English, and likely won't work for some\n * other languages.\n *\n * @param count - The count.\n * @param singular - The singular string.\n * @param plural - The plural string.\n * @returns The singular or plural string.\n * @example\n * ```typescript\n * pluralize(1, 'error'); // => 'error'\n * pluralize(2, 'error'); // => 'errors'\n * pluralize(1, 'error', 'problem'); // => 'error'\n * pluralize(2, 'error', 'problems'); // => 'problems'\n * ```\n */\nexport function pluralize(\n  count: number,\n  singular: string,\n  plural = `${singular}s`,\n) {\n  return count === 1 ? singular : plural;\n}\n\n/**\n * Get an object that can be used as fallback config for Webpack's\n * `fallback` config.\n *\n * @param polyfills - The polyfill object from the snap config.\n * @returns The webpack fallback config.\n */\nexport function getFallbacks(polyfills: ProcessedWebpackConfig['polyfills']): {\n  [index: string]: string | false;\n} {\n  if (polyfills === true) {\n    return Object.fromEntries(\n      builtinModules.map((name) => [\n        name,\n        WEBPACK_FALLBACKS[name as keyof typeof WEBPACK_FALLBACKS] ?? false,\n      ]),\n    );\n  }\n\n  if (polyfills === false) {\n    return Object.fromEntries(builtinModules.map((name) => [name, false]));\n  }\n\n  return Object.fromEntries(\n    builtinModules.map((name) => [\n      name,\n      polyfills[name as keyof ProcessedWebpackConfig['polyfills']]\n        ? WEBPACK_FALLBACKS[name as keyof typeof WEBPACK_FALLBACKS]\n        : false,\n    ]),\n  );\n}\n\n/**\n * Get an object that can be used as environment variables for Webpack's\n * `DefinePlugin`.\n *\n * @param environment - The environment object from the Snap config.\n * @param defaults - The default environment variables.\n * @returns The Webpack environment variables.\n */\nexport function getEnvironmentVariables(\n  environment: Record<string, unknown>,\n  defaults = {\n    NODE_DEBUG: 'false',\n    NODE_ENV: 'production',\n    DEBUG: 'false',\n  },\n) {\n  return Object.fromEntries(\n    Object.entries({\n      ...defaults,\n      ...environment,\n    }).map(([key, value]) => [`process.env.${key}`, JSON.stringify(value)]),\n  );\n}\n\n/**\n * Format the given line to fit within the terminal width.\n *\n * @param line - The line to format.\n * @param indent - The indentation to use.\n * @param initialIndent - The initial indentation to use, i.e., the indentation\n * for the first line.\n * @returns The formatted line.\n */\nfunction formatLine(line: string, indent: number, initialIndent: number) {\n  const terminalWidth = process.stdout.columns;\n  if (!terminalWidth) {\n    return `${' '.repeat(initialIndent)}${line}`;\n  }\n\n  return line.split(' ').reduce(\n    ({ formattedText, currentLineLength }, word, index) => {\n      // `chalk` adds ANSI escape codes to the text, which are not visible\n      // characters. We need to strip them to get the visible length of the\n      // text.\n      const visibleWord = stripAnsi(word);\n\n      // Determine if a space should be added before the word.\n      const spaceBeforeWord = index > 0 ? ' ' : '';\n      const wordLengthWithSpace = visibleWord.length + spaceBeforeWord.length;\n\n      // If the word would exceed the terminal width, start a new line.\n      if (currentLineLength + wordLengthWithSpace > terminalWidth) {\n        return {\n          formattedText: `${formattedText}\\n${' '.repeat(indent)}${word}`,\n          currentLineLength: indent + visibleWord.length,\n        };\n      }\n\n      // Otherwise, add the word to the current line.\n      return {\n        formattedText: formattedText + spaceBeforeWord + word,\n        currentLineLength: currentLineLength + wordLengthWithSpace,\n      };\n    },\n    {\n      formattedText: ' '.repeat(initialIndent),\n      currentLineLength: initialIndent,\n    },\n  ).formattedText;\n}\n\n/**\n * Format the given text to fit within the terminal width.\n *\n * @param text - The text to format.\n * @param indent - The indentation to use.\n * @param initialIndent - The initial indentation to use, i.e., the indentation\n * for the first line.\n * @returns The formatted text.\n */\nexport function formatText(\n  text: string,\n  indent: number,\n  initialIndent = indent,\n) {\n  const lines = text.split('\\n');\n\n  // Apply formatting to each line separately and then join them.\n  return lines\n    .map((line, index) => {\n      const lineIndent = index === 0 ? initialIndent : indent;\n      return formatLine(line, indent, lineIndent);\n    })\n    .join('\\n');\n}\n\n/**\n * Get an SVG from the given bytes and mime type.\n *\n * @param mimeType - The mime type of the image.\n * @param bytes - The image bytes.\n * @returns The SVG.\n */\nexport function getImageSVG(mimeType: string, bytes: Uint8Array) {\n  const dataUrl = `data:${mimeType};base64,${bytesToBase64(bytes)}`;\n  return `<svg xmlns=\"http://www.w3.org/2000/svg\"><image href=\"${dataUrl}\" /></svg>`;\n}\n"]}

package/dist/{types/webpack/utils.d.ts → webpack/utils.d.cts}

@@ -1,7 +1,7 @@
 /// <reference types="browserify" />
-import type { Ora } from 'ora';
-import type { Configuration } from 'webpack';
-import type { ProcessedWebpackConfig } from '../config';
+import type { Ora } from "ora/index.js";
+import type { Configuration } from "webpack";
+import type { ProcessedWebpackConfig } from "../config.cjs";
 export declare const BROWSERSLIST_FILE: string;
 export declare const WEBPACK_FALLBACKS: {
     assert: string;
@@ -53,23 +53,23 @@ export declare function getDefaultLoader({ legacy, sourceMap, }: ProcessedWebpac
     loader: string;
     options: {
         fn: import("webpack").LoaderDefinitionFunction<{
-            transpilationMode: import("../builders").TranspilationModes.LocalAndDeps;
+            transpilationMode: import("../builders.cjs").TranspilationModes.LocalAndDeps;
             depsToTranspile: string[];
             writeManifest: boolean;
             bundlerCustomizer?: ((bundler: import("browserify").BrowserifyObject) => void) | undefined;
         } | {
-            transpilationMode: import("../builders").TranspilationModes.LocalOnly | import("../builders").TranspilationModes.None;
+            transpilationMode: import("../builders.cjs").TranspilationModes.LocalOnly | import("../builders.cjs").TranspilationModes.None;
             depsToTranspile: unknown[];
             writeManifest: boolean;
             bundlerCustomizer?: ((bundler: import("browserify").BrowserifyObject) => void) | undefined;
         }, {}>;
     } & ({
-        transpilationMode: import("../builders").TranspilationModes.LocalAndDeps;
+        transpilationMode: import("../builders.cjs").TranspilationModes.LocalAndDeps;
         depsToTranspile: string[];
         writeManifest: boolean;
         bundlerCustomizer?: ((bundler: import("browserify").BrowserifyObject) => void) | undefined;
     } | {
-        transpilationMode: import("../builders").TranspilationModes.LocalOnly | import("../builders").TranspilationModes.None;
+        transpilationMode: import("../builders.cjs").TranspilationModes.LocalOnly | import("../builders.cjs").TranspilationModes.None;
         depsToTranspile: unknown[];
         writeManifest: boolean;
         bundlerCustomizer?: ((bundler: import("browserify").BrowserifyObject) => void) | undefined;
@@ -256,3 +256,4 @@ export declare function formatText(text: string, indent: number, initialIndent?:
  * @returns The SVG.
  */
 export declare function getImageSVG(mimeType: string, bytes: Uint8Array): string;
+//# sourceMappingURL=utils.d.cts.map

package/dist/webpack/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../src/webpack/utils.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,qBAAY;AAG/B,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB;AAE7C,OAAO,KAAK,EAAE,sBAAsB,EAAE,sBAAkB;AAGxD,eAAO,MAAM,iBAAiB,QAM7B,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiC7B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,MAAM,EACN,SAAS,GACV,EAAE,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;IAarB;;;;OAIG;;IAGH;;;;;OAKG;;;QAID;;;;;WAKG;;;;gBAKC;;;;;;;mBAOG;;gBAGH;;;;;mBAKG;;;;;oBAMD;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;uBAKG;;;;;QAMT;;;;;WAKG;;YAED;;;;;;;eAOG;;;;;;;GASV;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACxB,SAAS,EAAE,sBAAsB,CAAC,WAAW,CAAC,GAC7C,aAAa,CAAC,SAAS,CAAC,CAU1B;AAED;;;;;;;;;GASG;AAEH,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM,gBAChD,MAAM,UAO3B;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,sBAM3C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,MAAM,SAAiB,UAGxB;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,sBAAsB,CAAC,WAAW,CAAC,GAAG;IAC5E,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;CACjC,CAsBA;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,QAAQ;;;;CAIP;;EAQF;AAiDD;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,aAAa,SAAS,UAWvB;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,UAG9D"}