@metamask/snaps-cli 1.0.2 → 2.0.0

package/dist/cjs/webpack/plugins.js

@@ -0,0 +1,340 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    SnapsStatsPlugin: function() {
+        return SnapsStatsPlugin;
+    },
+    SnapsWatchPlugin: function() {
+        return SnapsWatchPlugin;
+    },
+    SnapsBuiltInResolver: function() {
+        return SnapsBuiltInResolver;
+    },
+    SnapsBundleWarningsPlugin: function() {
+        return SnapsBundleWarningsPlugin;
+    }
+});
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _chalk = require("chalk");
+const _module = require("module");
+const _eval = require("../commands/eval");
+const _utils1 = require("../utils");
+const _utils2 = require("./utils");
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) {
+        return descriptor.get.call(receiver);
+    }
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) {
+        descriptor.set.call(receiver, value);
+    } else {
+        if (!descriptor.writable) {
+            throw new TypeError("attempted to set read only private field");
+        }
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to " + action + " private field on non-instance");
+    }
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
+function _class_private_method_get(receiver, privateSet, fn) {
+    if (!privateSet.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return fn;
+}
+function _class_private_method_init(obj, privateSet) {
+    _check_private_redeclaration(obj, privateSet);
+    privateSet.add(obj);
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+var _spinner = /*#__PURE__*/ new WeakMap(), /**
+   * Get the error message for the given stats error.
+   *
+   * @param statsError - The stats error.
+   * @returns The error message.
+   */ _getStatsErrorMessage = /*#__PURE__*/ new WeakSet();
+class SnapsStatsPlugin {
+    /**
+   * Apply the plugin to the Webpack compiler.
+   *
+   * @param compiler - The Webpack compiler.
+   */ apply(compiler) {
+        compiler.hooks.afterDone.tap(this.constructor.name, (stats)=>{
+            if (!stats) {
+                return;
+            }
+            const { modules, time, errors } = stats.toJson();
+            (0, _utils.assert)(modules, 'Modules must be defined in stats.');
+            (0, _utils.assert)(time, 'Time must be defined in stats.');
+            if (errors?.length) {
+                const formattedErrors = errors.map(_class_private_method_get(this, _getStatsErrorMessage, getStatsErrorMessage).bind(this)).join('\n\n');
+                (0, _utils1.error)(`Compiled ${modules.length} ${(0, _utils2.pluralize)(modules.length, 'file')} in ${time}ms with ${errors.length} ${(0, _utils2.pluralize)(errors.length, 'error')}.\n\n${formattedErrors}\n`, _class_private_field_get(this, _spinner));
+                _class_private_field_get(this, _spinner)?.stop();
+                process.exitCode = 1;
+                return;
+            }
+            (0, _utils1.info)(`Compiled ${modules.length} ${(0, _utils2.pluralize)(modules.length, 'file')} in ${time}ms.`, _class_private_field_get(this, _spinner));
+            if (compiler.watchMode) {
+                // The spinner may be restarted by the watch plugin, outside of the
+                // `executeSteps` flow, so we stop it here just in case.
+                _class_private_field_get(this, _spinner)?.succeed('Done!');
+            }
+        });
+    }
+    constructor(options = {
+        verbose: false
+    }, spinner){
+        _class_private_method_init(this, _getStatsErrorMessage);
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner, {
+            writable: true,
+            value: void 0
+        });
+        this.options = options;
+        _class_private_field_set(this, _spinner, spinner);
+    }
+}
+function getStatsErrorMessage(statsError) {
+    const baseMessage = this.options.verbose ? (0, _utils1.getErrorMessage)(statsError) : statsError.message;
+    const [first, ...rest] = baseMessage.split('\n');
+    return [
+        (0, _snapsutils.indent)((0, _chalk.red)(`• ${first}`), 2),
+        ...rest.map((message)=>(0, _snapsutils.indent)((0, _chalk.red)(message), 4)),
+        statsError.details && (0, _snapsutils.indent)((0, _chalk.dim)(statsError.details), 4)
+    ].filter(Boolean).join('\n');
+}
+var _spinner1 = /*#__PURE__*/ new WeakMap(), _safeEvaluate = /*#__PURE__*/ new WeakSet();
+class SnapsWatchPlugin {
+    /**
+   * Apply the plugin to the Webpack compiler.
+   *
+   * @param compiler - The Webpack compiler.
+   */ apply(compiler) {
+        compiler.hooks.invalid.tap(this.constructor.name, (file)=>{
+            _class_private_field_get(this, _spinner1)?.start();
+            (0, _utils1.info)(`Changes detected in ${(0, _chalk.yellow)(file)}, recompiling.`, _class_private_field_get(this, _spinner1));
+        });
+        compiler.hooks.afterEmit.tapPromise(this.constructor.name, async ({ fileDependencies })=>{
+            this.options.files?.forEach(fileDependencies.add.bind(fileDependencies));
+            if (this.options.bundle && this.options.evaluate) {
+                await _class_private_method_get(this, _safeEvaluate, safeEvaluate).call(this, this.options.bundle);
+            }
+        });
+    }
+    constructor(options, spinner){
+        /**
+   * Safely evaluate the bundle at the given path. If an error occurs, it will
+   * be logged to the console, rather than throwing an error.
+   *
+   * This function should never throw an error.
+   *
+   * @param bundlePath - The path to the bundle.
+   */ _class_private_method_init(this, _safeEvaluate);
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner1, {
+            writable: true,
+            value: void 0
+        });
+        this.options = options;
+        _class_private_field_set(this, _spinner1, spinner);
+    }
+}
+async function safeEvaluate(bundlePath) {
+    try {
+        await (0, _eval.evaluate)(bundlePath);
+        (0, _utils1.info)(`Snap bundle evaluated successfully.`, _class_private_field_get(this, _spinner1));
+    } catch (evaluateError) {
+        (0, _utils1.error)(evaluateError.message, _class_private_field_get(this, _spinner1));
+    }
+}
+var _source = /*#__PURE__*/ new WeakMap(), _spinner2 = /*#__PURE__*/ new WeakMap();
+class SnapsBuiltInResolver {
+    /**
+   * Apply the plugin to the Webpack resolver.
+   *
+   * @param resolver - The Webpack resolver.
+   */ apply(resolver) {
+        resolver.getHook(_class_private_field_get(this, _source)).tapAsync(this.constructor.name, ({ module: isModule, request }, _, callback)=>{
+            if (!isModule || !request) {
+                return callback();
+            }
+            const baseRequest = request.split('/')[0];
+            if ((0, _module.isBuiltin)(baseRequest) && !this.options.ignore?.includes(baseRequest)) {
+                const fallback = resolver.options.fallback.find(({ name })=>name === baseRequest);
+                if (fallback && !fallback.alias) {
+                    this.unresolvedModules.add(baseRequest);
+                }
+            }
+            return callback();
+        });
+    }
+    constructor(options = {
+        ignore: []
+    }, spinner){
+        /**
+   * The built-in modules that have been imported, but not resolved.
+   */ _define_property(this, "unresolvedModules", new Set());
+        /**
+   * The name of the resolver hook to tap into.
+   */ _class_private_field_init(this, _source, {
+            writable: true,
+            value: 'described-resolve'
+        });
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner2, {
+            writable: true,
+            value: void 0
+        });
+        this.options = options;
+        _class_private_field_set(this, _spinner2, spinner);
+    }
+}
+var _spinner3 = /*#__PURE__*/ new WeakMap(), /**
+   * Check if a built-in module is used, but not provided by Webpack's
+   * `fallback` configuration.
+   *
+   * @param compiler - The Webpack compiler.
+   */ _checkBuiltIns = /*#__PURE__*/ new WeakSet(), /**
+   * Check if the given instance is a `ProvidePlugin`. This is not guaranteed to
+   * be accurate, but it's good enough for our purposes. If we were to use
+   * `instanceof` instead, it might not work if multiple versions of Webpack are
+   * installed.
+   *
+   * @param instance - The instance to check.
+   * @returns Whether the instance is a `ProvidePlugin`, i.e., whether it's an
+   * object with the name `ProvidePlugin` and a `definitions` property.
+   */ _isProvidePlugin = /*#__PURE__*/ new WeakSet(), /**
+   * Check if the `Buffer` global is used, but not provided by Webpack's
+   * `DefinePlugin`.
+   *
+   * @param compiler - The Webpack compiler.
+   */ _checkBuffer = /*#__PURE__*/ new WeakSet();
+class SnapsBundleWarningsPlugin {
+    /**
+   * Apply the plugin to the Webpack compiler.
+   *
+   * @param compiler - The Webpack compiler.
+   */ apply(compiler) {
+        if (this.options.builtIns) {
+            _class_private_method_get(this, _checkBuiltIns, checkBuiltIns).call(this, compiler);
+        }
+        if (this.options.buffer) {
+            _class_private_method_get(this, _checkBuffer, checkBuffer).call(this, compiler);
+        }
+    }
+    constructor(options = {
+        buffer: true,
+        builtIns: true
+    }, spinner){
+        _class_private_method_init(this, _checkBuiltIns);
+        _class_private_method_init(this, _isProvidePlugin);
+        _class_private_method_init(this, _checkBuffer);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner3, {
+            writable: true,
+            value: void 0
+        });
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        this.options = options;
+        _class_private_field_set(this, _spinner3, spinner);
+    }
+}
+function checkBuiltIns(compiler) {
+    compiler.hooks.afterCompile.tap(this.constructor.name, ()=>{
+        if (!this.options.builtInResolver) {
+            return;
+        }
+        const { unresolvedModules } = this.options.builtInResolver;
+        if (unresolvedModules.size === 0) {
+            return;
+        }
+        const formattedModules = new Array(...unresolvedModules).map((name)=>(0, _snapsutils.indent)(`• ${name}`, 2)).join('\n');
+        (0, _utils1.warn)(`The snap attempted to use one or more Node.js builtins, but no browser fallback has been provided.\n` + `The MetaMask Snaps CLI does not support Node.js builtins by default. If you want to use this module, you must set ${(0, _chalk.yellow)(`polyfills`)} to ${(0, _chalk.yellow)(`true`)} or an object with the builtins to polyfill as the key and ${(0, _chalk.yellow)(`true`)} as the value.\n` + `To disable this warning, set ${(0, _chalk.yellow)('`stats.builtIns`')} to ${(0, _chalk.yellow)('`false`')} in your snap config file, or add the module to the ${(0, _chalk.yellow)('`stats.builtIns.ignore`')} array.\n\n${formattedModules}\n`, _class_private_field_get(this, _spinner3));
+    });
+}
+function isProvidePlugin(instance) {
+    return (0, _utils.isObject)(instance) && instance.constructor.name === 'ProvidePlugin' && (0, _utils.hasProperty)(instance, 'definitions');
+}
+function checkBuffer(compiler) {
+    const plugin = compiler.options.plugins?.find((instance)=>_class_private_method_get(this, _isProvidePlugin, isProvidePlugin).call(this, instance));
+    // If the `ProvidePlugin` is configured to provide `Buffer`, then we don't
+    // need to warn the user.
+    if (plugin) {
+        const { definitions } = plugin;
+        if (definitions.Buffer) {
+            return;
+        }
+    }
+    compiler.hooks.compilation.tap(this.constructor.name, (compilation)=>{
+        compilation.hooks.afterProcessAssets.tap(this.constructor.name, (assets)=>{
+            // Check if assets use `Buffer`.
+            const bufferAssets = Object.entries(assets).filter(([name])=>name.endsWith('.js')).filter(([, asset])=>asset.source().includes('Buffer'));
+            if (bufferAssets.length === 0) {
+                return;
+            }
+            (0, _utils1.warn)(`The snap attempted to use the Node.js Buffer global, which is not supported in the MetaMask Snaps CLI by default.\n` + `To use the Buffer global, you must polyfill Buffer by setting ${(0, _chalk.yellow)(`buffer`)} to ${(0, _chalk.yellow)(`true`)} in the ${(0, _chalk.yellow)(`polyfills`)} config object in your snap config.\n` + `To disable this warning, set ${(0, _chalk.yellow)('`stats.buffer`')} to ${(0, _chalk.yellow)('`false`')} in your snap config file.`, _class_private_field_get(this, _spinner3));
+        });
+    });
+}
+
+//# sourceMappingURL=plugins.js.map

package/dist/cjs/webpack/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/webpack/plugins.ts"],"sourcesContent":["import { indent } from '@metamask/snaps-utils';\nimport { assert, hasProperty, isObject } from '@metamask/utils';\nimport { dim, red, yellow } from 'chalk';\nimport { isBuiltin } from 'module';\nimport type { Ora } from 'ora';\nimport type {\n  Compiler,\n  ProvidePlugin,\n  ResolvePluginInstance,\n  Resolver,\n  StatsError,\n  WebpackPluginInstance,\n} from 'webpack';\n\nimport { evaluate } from '../commands/eval';\nimport { error, getErrorMessage, info, warn } from '../utils';\nimport { pluralize } from './utils';\n\nexport type SnapsStatsPluginOptions = {\n  /**\n   * Whether to log the verbose stats.\n   */\n  verbose?: boolean;\n};\n\n/**\n * A plugin that logs the stats after compilation. This is useful for logging\n * the number of files compiled, and the time taken to compile them.\n */\nexport class SnapsStatsPlugin implements WebpackPluginInstance {\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsStatsPluginOptions;\n\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  constructor(\n    options: SnapsStatsPluginOptions = {\n      verbose: false,\n    },\n    spinner?: Ora,\n  ) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack compiler.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  apply(compiler: Compiler) {\n    compiler.hooks.afterDone.tap(this.constructor.name, (stats) => {\n      if (!stats) {\n        return;\n      }\n\n      const { modules, time, errors } = stats.toJson();\n\n      assert(modules, 'Modules must be defined in stats.');\n      assert(time, 'Time must be defined in stats.');\n\n      if (errors?.length) {\n        const formattedErrors = errors\n          .map(this.#getStatsErrorMessage.bind(this))\n          .join('\\n\\n');\n\n        error(\n          `Compiled ${modules.length} ${pluralize(\n            modules.length,\n            'file',\n          )} in ${time}ms with ${errors.length} ${pluralize(\n            errors.length,\n            'error',\n          )}.\\n\\n${formattedErrors}\\n`,\n          this.#spinner,\n        );\n\n        this.#spinner?.stop();\n\n        process.exitCode = 1;\n        return;\n      }\n\n      info(\n        `Compiled ${modules.length} ${pluralize(\n          modules.length,\n          'file',\n        )} in ${time}ms.`,\n        this.#spinner,\n      );\n\n      if (compiler.watchMode) {\n        // The spinner may be restarted by the watch plugin, outside of the\n        // `executeSteps` flow, so we stop it here just in case.\n        this.#spinner?.succeed('Done!');\n      }\n    });\n  }\n\n  /**\n   * Get the error message for the given stats error.\n   *\n   * @param statsError - The stats error.\n   * @returns The error message.\n   */\n  #getStatsErrorMessage(statsError: StatsError) {\n    const baseMessage = this.options.verbose\n      ? getErrorMessage(statsError)\n      : statsError.message;\n\n    const [first, ...rest] = baseMessage.split('\\n');\n\n    return [\n      indent(red(`• ${first}`), 2),\n      ...rest.map((message) => indent(red(message), 4)),\n      statsError.details && indent(dim(statsError.details), 4),\n    ]\n      .filter(Boolean)\n      .join('\\n');\n  }\n}\n\n/**\n * The options for the {@link SnapsWatchPlugin}.\n */\nexport type SnapsWatchPluginOptions = {\n  /**\n   * The bundle path. This is the file that will be evaluated, if the `evaluate`\n   * option is set.\n   */\n  bundle?: string;\n\n  /**\n   * Whether to evaluate the bundle. This only applies if the `bundle` option is\n   * set.\n   */\n  evaluate?: boolean;\n\n  /**\n   * The extra files to watch.\n   */\n  files?: string[];\n};\n\n/**\n * A plugin that adds extra files to watch. This is useful for watching files\n * that are not imported by the entry point, such as the `snap.manifest.json`\n * file.\n */\nexport class SnapsWatchPlugin implements WebpackPluginInstance {\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsWatchPluginOptions;\n\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  constructor(options: SnapsWatchPluginOptions, spinner?: Ora) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack compiler.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  apply(compiler: Compiler) {\n    compiler.hooks.invalid.tap(this.constructor.name, (file) => {\n      this.#spinner?.start();\n      info(`Changes detected in ${yellow(file)}, recompiling.`, this.#spinner);\n    });\n\n    compiler.hooks.afterEmit.tapPromise(\n      this.constructor.name,\n      async ({ fileDependencies }) => {\n        this.options.files?.forEach(\n          fileDependencies.add.bind(fileDependencies),\n        );\n\n        if (this.options.bundle && this.options.evaluate) {\n          await this.#safeEvaluate(this.options.bundle);\n        }\n      },\n    );\n  }\n\n  /**\n   * Safely evaluate the bundle at the given path. If an error occurs, it will\n   * be logged to the console, rather than throwing an error.\n   *\n   * This function should never throw an error.\n   *\n   * @param bundlePath - The path to the bundle.\n   */\n  async #safeEvaluate(bundlePath: string) {\n    try {\n      await evaluate(bundlePath);\n      info(`Snap bundle evaluated successfully.`, this.#spinner);\n    } catch (evaluateError) {\n      error(evaluateError.message, this.#spinner);\n    }\n  }\n}\n\n/**\n * The options for the {@link SnapsBuiltInResolver}.\n */\nexport type SnapsBuiltInResolverOptions = {\n  /**\n   * The built-in modules to ignore.\n   */\n  ignore?: string[];\n};\n\n/**\n * A plugin that logs a message when a built-in module is not resolved. The\n * MetaMask Snaps CLI does not support built-in modules by default, and this\n * plugin is used to warn the user when they try to import a built-in module,\n * when no fallback is configured.\n */\nexport class SnapsBuiltInResolver implements ResolvePluginInstance {\n  /**\n   * The built-in modules that have been imported, but not resolved.\n   */\n  readonly unresolvedModules = new Set<string>();\n\n  /**\n   * The name of the resolver hook to tap into.\n   */\n  readonly #source = 'described-resolve';\n\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsBuiltInResolverOptions;\n\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  constructor(\n    options: SnapsBuiltInResolverOptions = {\n      ignore: [],\n    },\n    spinner?: Ora,\n  ) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack resolver.\n   *\n   * @param resolver - The Webpack resolver.\n   */\n  apply(resolver: Resolver) {\n    resolver\n      .getHook(this.#source)\n      .tapAsync(\n        this.constructor.name,\n        ({ module: isModule, request }, _, callback) => {\n          if (!isModule || !request) {\n            return callback();\n          }\n\n          const baseRequest = request.split('/')[0];\n          if (\n            isBuiltin(baseRequest) &&\n            !this.options.ignore?.includes(baseRequest)\n          ) {\n            const fallback = resolver.options.fallback.find(\n              ({ name }) => name === baseRequest,\n            );\n\n            if (fallback && !fallback.alias) {\n              this.unresolvedModules.add(baseRequest);\n            }\n          }\n\n          return callback();\n        },\n      );\n  }\n}\n\n/**\n * The options for the {@link SnapsBundleWarningsPlugin}.\n */\nexport type SnapsBundleWarningsPluginOptions = {\n  /**\n   * The {@link SnapsBuiltInResolver} instance to use for detecting built-in\n   * modules.\n   */\n  builtInResolver?: SnapsBuiltInResolver | false;\n\n  /**\n   * Whether to show warnings if built-in modules are used, but not provided by\n   * Webpack's `fallback` configuration.\n   */\n  builtIns?: boolean;\n\n  /**\n   * Whether to show warnings if the `Buffer` global is used, but not provided\n   * by Webpack's `DefinePlugin`.\n   */\n  buffer?: boolean;\n};\n\n/**\n * A plugin that logs a message when:\n *\n * - A built-in module is not resolved. The MetaMask Snaps CLI does not support\n * built-in modules by default, and this plugin is used to warn the user when\n * they try to import a built-in module, when no fallback is configured.\n * - A snap uses the `Buffer` global. The MetaMask Snaps CLI does not support\n * the `Buffer` global by default, and this plugin is used to warn the user when\n * they try to use the `Buffer` global.\n *\n * We use both a resolver and a plugin, because the resolver is used to detect\n * when a built-in module is imported, and the plugin is used to log a single\n * message when the compilation is complete. We can't do everything in a single\n * plugin, because the resolver doesn't have access to the compilation, and the\n * plugin doesn't have access to the resolver.\n */\n\nexport class SnapsBundleWarningsPlugin implements WebpackPluginInstance {\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsBundleWarningsPluginOptions;\n\n  constructor(\n    options: SnapsBundleWarningsPluginOptions = {\n      buffer: true,\n      builtIns: true,\n    },\n    spinner?: Ora,\n  ) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack compiler.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  apply(compiler: Compiler) {\n    if (this.options.builtIns) {\n      this.#checkBuiltIns(compiler);\n    }\n\n    if (this.options.buffer) {\n      this.#checkBuffer(compiler);\n    }\n  }\n\n  /**\n   * Check if a built-in module is used, but not provided by Webpack's\n   * `fallback` configuration.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  #checkBuiltIns(compiler: Compiler) {\n    compiler.hooks.afterCompile.tap(this.constructor.name, () => {\n      if (!this.options.builtInResolver) {\n        return;\n      }\n\n      const { unresolvedModules } = this.options.builtInResolver;\n      if (unresolvedModules.size === 0) {\n        return;\n      }\n\n      const formattedModules = new Array(...unresolvedModules)\n        .map((name) => indent(`• ${name}`, 2))\n        .join('\\n');\n\n      warn(\n        `The snap attempted to use one or more Node.js builtins, but no browser fallback has been provided.\\n` +\n          `The MetaMask Snaps CLI does not support Node.js builtins by default. If you want to use this module, you must set ${yellow(\n            `polyfills`,\n          )} to ${yellow(\n            `true`,\n          )} or an object with the builtins to polyfill as the key and ${yellow(\n            `true`,\n          )} as the value.\\n` +\n          `To disable this warning, set ${yellow(\n            '`stats.builtIns`',\n          )} to ${yellow(\n            '`false`',\n          )} in your snap config file, or add the module to the ${yellow(\n            '`stats.builtIns.ignore`',\n          )} array.\\n\\n${formattedModules}\\n`,\n        this.#spinner,\n      );\n    });\n  }\n\n  /**\n   * Check if the given instance is a `ProvidePlugin`. This is not guaranteed to\n   * be accurate, but it's good enough for our purposes. If we were to use\n   * `instanceof` instead, it might not work if multiple versions of Webpack are\n   * installed.\n   *\n   * @param instance - The instance to check.\n   * @returns Whether the instance is a `ProvidePlugin`, i.e., whether it's an\n   * object with the name `ProvidePlugin` and a `definitions` property.\n   */\n  #isProvidePlugin(instance: unknown): instance is ProvidePlugin {\n    return (\n      isObject(instance) &&\n      instance.constructor.name === 'ProvidePlugin' &&\n      hasProperty(instance, 'definitions')\n    );\n  }\n\n  /**\n   * Check if the `Buffer` global is used, but not provided by Webpack's\n   * `DefinePlugin`.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  #checkBuffer(compiler: Compiler) {\n    const plugin = compiler.options.plugins?.find((instance) =>\n      this.#isProvidePlugin(instance),\n    ) as ProvidePlugin | undefined;\n\n    // If the `ProvidePlugin` is configured to provide `Buffer`, then we don't\n    // need to warn the user.\n    if (plugin) {\n      const { definitions } = plugin;\n      if (definitions.Buffer) {\n        return;\n      }\n    }\n\n    compiler.hooks.compilation.tap(this.constructor.name, (compilation) => {\n      compilation.hooks.afterProcessAssets.tap(\n        this.constructor.name,\n        (assets) => {\n          // Check if assets use `Buffer`.\n          const bufferAssets = Object.entries(assets)\n            .filter(([name]) => name.endsWith('.js'))\n            .filter(([, asset]) => asset.source().includes('Buffer'));\n\n          if (bufferAssets.length === 0) {\n            return;\n          }\n\n          warn(\n            `The snap attempted to use the Node.js Buffer global, which is not supported in the MetaMask Snaps CLI by default.\\n` +\n              `To use the Buffer global, you must polyfill Buffer by setting ${yellow(\n                `buffer`,\n              )} to ${yellow(`true`)} in the ${yellow(\n                `polyfills`,\n              )} config object in your snap config.\\n` +\n              `To disable this warning, set ${yellow(\n                '`stats.buffer`',\n              )} to ${yellow('`false`')} in your snap config file.`,\n            this.#spinner,\n          );\n        },\n      );\n    });\n  }\n}\n"],"names":["SnapsStatsPlugin","SnapsWatchPlugin","SnapsBuiltInResolver","SnapsBundleWarningsPlugin","apply","compiler","hooks","afterDone","tap","constructor","name","stats","modules","time","errors","toJson","assert","length","formattedErrors","map","getStatsErrorMessage","bind","join","error","pluralize","spinner","stop","process","exitCode","info","watchMode","succeed","options","verbose","statsError","baseMessage","getErrorMessage","message","first","rest","split","indent","red","details","dim","filter","Boolean","invalid","file","start","yellow","afterEmit","tapPromise","fileDependencies","files","forEach","add","bundle","evaluate","safeEvaluate","bundlePath","evaluateError","resolver","getHook","source","tapAsync","module","isModule","request","_","callback","baseRequest","isBuiltin","ignore","includes","fallback","find","alias","unresolvedModules","Set","builtIns","checkBuiltIns","buffer","checkBuffer","afterCompile","builtInResolver","size","formattedModules","Array","warn","instance","isObject","hasProperty","plugin","plugins","isProvidePlugin","definitions","Buffer","compilation","afterProcessAssets","assets","bufferAssets","Object","entries","endsWith","asset"],"mappings":";;;;;;;;;;;IA6BaA,gBAAgB;eAAhBA;;IA6HAC,gBAAgB;eAAhBA;;IA2EAC,oBAAoB;eAApBA;;IA0GAC,yBAAyB;eAAzBA;;;4BA/UU;uBACuB;uBACb;wBACP;sBAWD;wBAC0B;wBACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsBf,wCAkET;;;;;GAKC,GACD;AAjFK,MAAMH;IAqBX;;;;GAIC,GACDI,MAAMC,QAAkB,EAAE;QACxBA,SAASC,KAAK,CAACC,SAAS,CAACC,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE,CAACC;YACnD,IAAI,CAACA,OAAO;gBACV;YACF;YAEA,MAAM,EAAEC,OAAO,EAAEC,IAAI,EAAEC,MAAM,EAAE,GAAGH,MAAMI,MAAM;YAE9CC,IAAAA,aAAM,EAACJ,SAAS;YAChBI,IAAAA,aAAM,EAACH,MAAM;YAEb,IAAIC,QAAQG,QAAQ;gBAClB,MAAMC,kBAAkBJ,OACrBK,GAAG,CAAC,0BAAA,IAAI,EAAEC,uBAAAA,sBAAqBC,IAAI,CAAC,IAAI,GACxCC,IAAI,CAAC;gBAERC,IAAAA,aAAK,EACH,CAAC,SAAS,EAAEX,QAAQK,MAAM,CAAC,CAAC,EAAEO,IAAAA,iBAAS,EACrCZ,QAAQK,MAAM,EACd,QACA,IAAI,EAAEJ,KAAK,QAAQ,EAAEC,OAAOG,MAAM,CAAC,CAAC,EAAEO,IAAAA,iBAAS,EAC/CV,OAAOG,MAAM,EACb,SACA,KAAK,EAAEC,gBAAgB,EAAE,CAAC,2BAC5B,IAAI,EAAEO;yCAGR,IAAI,EAAEA,WAASC;gBAEfC,QAAQC,QAAQ,GAAG;gBACnB;YACF;YAEAC,IAAAA,YAAI,EACF,CAAC,SAAS,EAAEjB,QAAQK,MAAM,CAAC,CAAC,EAAEO,IAAAA,iBAAS,EACrCZ,QAAQK,MAAM,EACd,QACA,IAAI,EAAEJ,KAAK,GAAG,CAAC,2BACjB,IAAI,EAAEY;YAGR,IAAIpB,SAASyB,SAAS,EAAE;gBACtB,mEAAmE;gBACnE,wDAAwD;yCACxD,IAAI,EAAEL,WAASM,QAAQ;YACzB;QACF;IACF;IA9DAtB,YACEuB,UAAmC;QACjCC,SAAS;IACX,CAAC,EACDR,OAAa,CACb;QAiEF,iCAAA;QAhFA;;GAEC,GACD,uBAASO,WAAT,KAAA;QAEA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAQE,IAAI,CAACA,OAAO,GAAGA;uCACTP,UAAUA;IAClB;AA6EF;AAfE,SAAA,qBAAsBS,UAAsB;IAC1C,MAAMC,cAAc,IAAI,CAACH,OAAO,CAACC,OAAO,GACpCG,IAAAA,uBAAe,EAACF,cAChBA,WAAWG,OAAO;IAEtB,MAAM,CAACC,OAAO,GAAGC,KAAK,GAAGJ,YAAYK,KAAK,CAAC;IAE3C,OAAO;QACLC,IAAAA,kBAAM,EAACC,IAAAA,UAAG,EAAC,CAAC,EAAE,EAAEJ,MAAM,CAAC,GAAG;WACvBC,KAAKpB,GAAG,CAAC,CAACkB,UAAYI,IAAAA,kBAAM,EAACC,IAAAA,UAAG,EAACL,UAAU;QAC9CH,WAAWS,OAAO,IAAIF,IAAAA,kBAAM,EAACG,IAAAA,UAAG,EAACV,WAAWS,OAAO,GAAG;KACvD,CACEE,MAAM,CAACC,SACPxB,IAAI,CAAC;AACV;IAuCS,yCAwCH;AAjDD,MAAMrB;IAgBX;;;;GAIC,GACDG,MAAMC,QAAkB,EAAE;QACxBA,SAASC,KAAK,CAACyC,OAAO,CAACvC,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE,CAACsC;qCACjD,IAAI,EAAEvB,YAASwB;YACfpB,IAAAA,YAAI,EAAC,CAAC,oBAAoB,EAAEqB,IAAAA,aAAM,EAACF,MAAM,cAAc,CAAC,2BAAE,IAAI,EAAEvB;QAClE;QAEApB,SAASC,KAAK,CAAC6C,SAAS,CAACC,UAAU,CACjC,IAAI,CAAC3C,WAAW,CAACC,IAAI,EACrB,OAAO,EAAE2C,gBAAgB,EAAE;YACzB,IAAI,CAACrB,OAAO,CAACsB,KAAK,EAAEC,QAClBF,iBAAiBG,GAAG,CAACnC,IAAI,CAACgC;YAG5B,IAAI,IAAI,CAACrB,OAAO,CAACyB,MAAM,IAAI,IAAI,CAACzB,OAAO,CAAC0B,QAAQ,EAAE;gBAChD,MAAM,0BAAA,IAAI,EAAEC,eAAAA,mBAAN,IAAI,EAAe,IAAI,CAAC3B,OAAO,CAACyB,MAAM;YAC9C;QACF;IAEJ;IA5BAhD,YAAYuB,OAAgC,EAAEP,OAAa,CAAE;QA8B7D;;;;;;;GAOC,GACD,iCAAM;QAhDN;;GAEC,GACD,uBAASO,WAAT,KAAA;QAEA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAGE,IAAI,CAACA,OAAO,GAAGA;uCACTP,WAAUA;IAClB;AA2CF;AARE,eAAA,aAAoBmC,UAAkB;IACpC,IAAI;QACF,MAAMF,IAAAA,cAAQ,EAACE;QACf/B,IAAAA,YAAI,EAAC,CAAC,mCAAmC,CAAC,2BAAE,IAAI,EAAEJ;IACpD,EAAE,OAAOoC,eAAe;QACtBtC,IAAAA,aAAK,EAACsC,cAAcxB,OAAO,2BAAE,IAAI,EAAEZ;IACrC;AACF;IA4BS,uCAUA;AAnBJ,MAAMvB;IA+BX;;;;GAIC,GACDE,MAAM0D,QAAkB,EAAE;QACxBA,SACGC,OAAO,0BAAC,IAAI,EAAEC,UACdC,QAAQ,CACP,IAAI,CAACxD,WAAW,CAACC,IAAI,EACrB,CAAC,EAAEwD,QAAQC,QAAQ,EAAEC,OAAO,EAAE,EAAEC,GAAGC;YACjC,IAAI,CAACH,YAAY,CAACC,SAAS;gBACzB,OAAOE;YACT;YAEA,MAAMC,cAAcH,QAAQ5B,KAAK,CAAC,IAAI,CAAC,EAAE;YACzC,IACEgC,IAAAA,iBAAS,EAACD,gBACV,CAAC,IAAI,CAACvC,OAAO,CAACyC,MAAM,EAAEC,SAASH,cAC/B;gBACA,MAAMI,WAAWb,SAAS9B,OAAO,CAAC2C,QAAQ,CAACC,IAAI,CAC7C,CAAC,EAAElE,IAAI,EAAE,GAAKA,SAAS6D;gBAGzB,IAAII,YAAY,CAACA,SAASE,KAAK,EAAE;oBAC/B,IAAI,CAACC,iBAAiB,CAACtB,GAAG,CAACe;gBAC7B;YACF;YAEA,OAAOD;QACT;IAEN;IA1CA7D,YACEuB,UAAuC;QACrCyC,QAAQ,EAAE;IACZ,CAAC,EACDhD,OAAa,CACb;QAzBF;;GAEC,GACD,uBAASqD,qBAAoB,IAAIC;QAEjC;;GAEC,GACD,gCAAS;;mBAAU;;QAEnB;;GAEC,GACD,uBAAS/C,WAAT,KAAA;QAEA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAQE,IAAI,CAACA,OAAO,GAAGA;uCACTP,WAAUA;IAClB;AAmCF;IA8CW,yCAiCT;;;;;GAKC,GACD,8CAoCA;;;;;;;;;GASC,GACD,gDAQA;;;;;GAKC,GACD;AAvGK,MAAMtB;IAsBX;;;;GAIC,GACDC,MAAMC,QAAkB,EAAE;QACxB,IAAI,IAAI,CAAC2B,OAAO,CAACgD,QAAQ,EAAE;YACzB,0BAAA,IAAI,EAAEC,gBAAAA,oBAAN,IAAI,EAAgB5E;QACtB;QAEA,IAAI,IAAI,CAAC2B,OAAO,CAACkD,MAAM,EAAE;YACvB,0BAAA,IAAI,EAAEC,cAAAA,kBAAN,IAAI,EAAc9E;QACpB;IACF;IAxBAI,YACEuB,UAA4C;QAC1CkD,QAAQ;QACRF,UAAU;IACZ,CAAC,EACDvD,OAAa,CACb;QA0BF,iCAAA;QA8CA,iCAAA;QAcA,iCAAA;QAtGA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAEA;;GAEC,GACD,uBAASO,WAAT,KAAA;QASE,IAAI,CAACA,OAAO,GAAGA;uCACTP,WAAUA;IAClB;AA8HF;AAvGE,SAAA,cAAepB,QAAkB;IAC/BA,SAASC,KAAK,CAAC8E,YAAY,CAAC5E,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE;QACrD,IAAI,CAAC,IAAI,CAACsB,OAAO,CAACqD,eAAe,EAAE;YACjC;QACF;QAEA,MAAM,EAAEP,iBAAiB,EAAE,GAAG,IAAI,CAAC9C,OAAO,CAACqD,eAAe;QAC1D,IAAIP,kBAAkBQ,IAAI,KAAK,GAAG;YAChC;QACF;QAEA,MAAMC,mBAAmB,IAAIC,SAASV,mBACnC3D,GAAG,CAAC,CAACT,OAAS+B,IAAAA,kBAAM,EAAC,CAAC,EAAE,EAAE/B,KAAK,CAAC,EAAE,IAClCY,IAAI,CAAC;QAERmE,IAAAA,YAAI,EACF,CAAC,oGAAoG,CAAC,GACpG,CAAC,kHAAkH,EAAEvC,IAAAA,aAAM,EACzH,CAAC,SAAS,CAAC,EACX,IAAI,EAAEA,IAAAA,aAAM,EACZ,CAAC,IAAI,CAAC,EACN,2DAA2D,EAAEA,IAAAA,aAAM,EACnE,CAAC,IAAI,CAAC,EACN,gBAAgB,CAAC,GACnB,CAAC,6BAA6B,EAAEA,IAAAA,aAAM,EACpC,oBACA,IAAI,EAAEA,IAAAA,aAAM,EACZ,WACA,oDAAoD,EAAEA,IAAAA,aAAM,EAC5D,2BACA,WAAW,EAAEqC,iBAAiB,EAAE,CAAC,2BACrC,IAAI,EAAE9D;IAEV;AACF;AAYA,SAAA,gBAAiBiE,QAAiB;IAChC,OACEC,IAAAA,eAAQ,EAACD,aACTA,SAASjF,WAAW,CAACC,IAAI,KAAK,mBAC9BkF,IAAAA,kBAAW,EAACF,UAAU;AAE1B;AAQA,SAAA,YAAarF,QAAkB;IAC7B,MAAMwF,SAASxF,SAAS2B,OAAO,CAAC8D,OAAO,EAAElB,KAAK,CAACc,WAC7C,0BAAA,IAAI,EAAEK,kBAAAA,sBAAN,IAAI,EAAkBL;IAGxB,0EAA0E;IAC1E,yBAAyB;IACzB,IAAIG,QAAQ;QACV,MAAM,EAAEG,WAAW,EAAE,GAAGH;QACxB,IAAIG,YAAYC,MAAM,EAAE;YACtB;QACF;IACF;IAEA5F,SAASC,KAAK,CAAC4F,WAAW,CAAC1F,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE,CAACwF;QACrDA,YAAY5F,KAAK,CAAC6F,kBAAkB,CAAC3F,GAAG,CACtC,IAAI,CAACC,WAAW,CAACC,IAAI,EACrB,CAAC0F;YACC,gCAAgC;YAChC,MAAMC,eAAeC,OAAOC,OAAO,CAACH,QACjCvD,MAAM,CAAC,CAAC,CAACnC,KAAK,GAAKA,KAAK8F,QAAQ,CAAC,QACjC3D,MAAM,CAAC,CAAC,GAAG4D,MAAM,GAAKA,MAAMzC,MAAM,GAAGU,QAAQ,CAAC;YAEjD,IAAI2B,aAAapF,MAAM,KAAK,GAAG;gBAC7B;YACF;YAEAwE,IAAAA,YAAI,EACF,CAAC,mHAAmH,CAAC,GACnH,CAAC,8DAA8D,EAAEvC,IAAAA,aAAM,EACrE,CAAC,MAAM,CAAC,EACR,IAAI,EAAEA,IAAAA,aAAM,EAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAEA,IAAAA,aAAM,EACrC,CAAC,SAAS,CAAC,EACX,qCAAqC,CAAC,GACxC,CAAC,6BAA6B,EAAEA,IAAAA,aAAM,EACpC,kBACA,IAAI,EAAEA,IAAAA,aAAM,EAAC,WAAW,0BAA0B,CAAC,2BACvD,IAAI,EAAEzB;QAEV;IAEJ;AACF"}

package/dist/cjs/webpack/utils.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    BROWSERSLIST_FILE: function() {
+        return BROWSERSLIST_FILE;
+    },
+    WEBPACK_FALLBACKS: function() {
+        return WEBPACK_FALLBACKS;
+    },
+    getDefaultLoader: function() {
+        return getDefaultLoader;
+    },
+    getDevTool: function() {
+        return getDevTool;
+    },
+    getProgressHandler: function() {
+        return getProgressHandler;
+    },
+    getBrowserslistTargets: function() {
+        return getBrowserslistTargets;
+    },
+    pluralize: function() {
+        return pluralize;
+    },
+    getFallbacks: function() {
+        return getFallbacks;
+    }
+});
+const _chalk = require("chalk");
+const _fs = require("fs");
+const _module = require("module");
+const _path = require("path");
+const BROWSERSLIST_FILE = (0, _path.resolve)((0, _path.dirname)(// eslint-disable-next-line n/no-extraneous-require
+require.resolve('@metamask/snaps-cli/package.json')), '.browserslistrc');
+const 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')
+};
+async function getDefaultLoader({ legacy, sourceMap }) {
+    if (legacy) {
+        return {
+            /**
+       * 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.
+       */ loader: (0, _path.resolve)(__dirname, 'loaders', 'browserify'),
+            /**
+       * The options for the `browserify` loader. These can be overridden in the
+       * snap config.
+       */ options: 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: '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'
+                }
+            },
+            /**
+       * 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 CommonJS modules. MetaMask Snaps
+         * doesn't support ES modules yet, so this is necessary.
+         *
+         * @see https://swc.rs/docs/configuration/modules#commonjs
+         */ type: 'commonjs'
+            },
+            env: {
+                targets: targets.join(', ')
+            }
+        }
+    };
+}
+function getDevTool(sourceMap) {
+    if (sourceMap === 'inline') {
+        return 'inline-source-map';
+    }
+    if (sourceMap === true) {
+        return 'source-map';
+    }
+    return false;
+}
+function getProgressHandler(spinner, spinnerText) {
+    return (percentage)=>{
+        if (spinner && spinnerText) {
+            spinner.text = `${spinnerText} ${(0, _chalk.dim)(`(${Math.round(percentage * 100)}%)`)}`;
+        }
+    };
+}
+async function getBrowserslistTargets() {
+    const contents = await _fs.promises.readFile(BROWSERSLIST_FILE, 'utf8');
+    return contents.split('\n').map((line)=>line.trim()).filter((line)=>line && !line.startsWith('#'));
+}
+function pluralize(count, singular, plural = `${singular}s`) {
+    return count === 1 ? singular : plural;
+}
+function getFallbacks(polyfills) {
+    if (polyfills === true) {
+        return Object.fromEntries(_module.builtinModules.map((name)=>[
+                name,
+                WEBPACK_FALLBACKS[name] ?? false
+            ]));
+    }
+    if (polyfills === false) {
+        return Object.fromEntries(_module.builtinModules.map((name)=>[
+                name,
+                false
+            ]));
+    }
+    return Object.fromEntries(_module.builtinModules.map((name)=>[
+            name,
+            polyfills[name] ? WEBPACK_FALLBACKS[name] : false
+        ]));
+}
+
+//# sourceMappingURL=utils.js.map

package/dist/cjs/webpack/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/webpack/utils.ts"],"sourcesContent":["import { dim } from 'chalk';\nimport { promises as fs } from 'fs';\nimport { builtinModules } from 'module';\nimport type { Ora } from 'ora';\nimport { dirname, resolve } from 'path';\nimport type { Configuration } from 'webpack';\n\nimport type { ProcessedWebpackConfig } from '../config';\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    return {\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      loader: resolve(__dirname, 'loaders', 'browserify'),\n\n      /**\n       * The options for the `browserify` loader. These can be overridden in the\n       * snap config.\n       */\n      options: legacy,\n    };\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: '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\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 CommonJS modules. MetaMask Snaps\n         * doesn't support ES modules yet, so this is necessary.\n         *\n         * @see https://swc.rs/docs/configuration/modules#commonjs\n         */\n        type: 'commonjs',\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"],"names":["BROWSERSLIST_FILE","WEBPACK_FALLBACKS","getDefaultLoader","getDevTool","getProgressHandler","getBrowserslistTargets","pluralize","getFallbacks","resolve","dirname","require","assert","buffer","console","constants","crypto","domain","events","http","https","os","path","punycode","process","querystring","stream","_stream_duplex","_stream_passthrough","_stream_readable","_stream_transform","_stream_writable","string_decoder","sys","timers","tty","url","util","vm","zlib","legacy","sourceMap","loader","__dirname","options","targets","sync","sourceMaps","Boolean","jsc","parser","syntax","module","type","env","join","spinner","spinnerText","percentage","text","dim","Math","round","contents","fs","readFile","split","map","line","trim","filter","startsWith","count","singular","plural","polyfills","Object","fromEntries","builtinModules","name"],"mappings":";;;;;;;;;;;IASaA,iBAAiB;eAAjBA;;IAQAC,iBAAiB;eAAjBA;;IAmDSC,gBAAgB;eAAhBA;;IA+FNC,UAAU;eAAVA;;IAyBAC,kBAAkB;eAAlBA;;IAeMC,sBAAsB;eAAtBA;;IA4BNC,SAAS;eAATA;;IAeAC,YAAY;eAAZA;;;uBAtPI;oBACW;wBACA;sBAEE;AAK1B,MAAMP,oBAAoBQ,IAAAA,aAAO,EACtCC,IAAAA,aAAO,EACL,mDAAmD;AACnDC,QAAQF,OAAO,CAAC,sCAElB;AAGK,MAAMP,oBAAoB;IAC/BU,QAAQD,QAAQF,OAAO,CAAC;IACxBI,QAAQF,QAAQF,OAAO,CAAC;IACxBK,SAASH,QAAQF,OAAO,CAAC;IACzBM,WAAWJ,QAAQF,OAAO,CAAC;IAC3BO,QAAQL,QAAQF,OAAO,CAAC;IACxBQ,QAAQN,QAAQF,OAAO,CAAC;IACxBS,QAAQP,QAAQF,OAAO,CAAC;IACxBU,MAAMR,QAAQF,OAAO,CAAC;IACtBW,OAAOT,QAAQF,OAAO,CAAC;IACvBY,IAAIV,QAAQF,OAAO,CAAC;IACpBa,MAAMX,QAAQF,OAAO,CAAC;IACtBc,UAAUZ,QAAQF,OAAO,CAAC;IAC1Be,SAASb,QAAQF,OAAO,CAAC;IACzBgB,aAAad,QAAQF,OAAO,CAAC;IAC7BiB,QAAQf,QAAQF,OAAO,CAAC;IACxB,wDAAwD,GACxDkB,gBAAgBhB,QAAQF,OAAO,CAAC;IAChCmB,qBAAqBjB,QAAQF,OAAO,CAClC;IAEFoB,kBAAkBlB,QAAQF,OAAO,CAAC;IAClCqB,mBAAmBnB,QAAQF,OAAO,CAAC;IACnCsB,kBAAkBpB,QAAQF,OAAO,CAAC;IAClCuB,gBAAgBrB,QAAQF,OAAO,CAAC;IAChC,uDAAuD,GACvDwB,KAAKtB,QAAQF,OAAO,CAAC;IACrByB,QAAQvB,QAAQF,OAAO,CAAC;IACxB0B,KAAKxB,QAAQF,OAAO,CAAC;IACrB2B,KAAKzB,QAAQF,OAAO,CAAC;IACrB4B,MAAM1B,QAAQF,OAAO,CAAC;IACtB6B,IAAI3B,QAAQF,OAAO,CAAC;IACpB8B,MAAM5B,QAAQF,OAAO,CAAC;AACxB;AAkBO,eAAeN,iBAAiB,EACrCqC,MAAM,EACNC,SAAS,EACc;IACvB,IAAID,QAAQ;QACV,OAAO;YACL;;;;;OAKC,GACDE,QAAQjC,IAAAA,aAAO,EAACkC,WAAW,WAAW;YAEtC;;;OAGC,GACDC,SAASJ;QACX;IACF;IAEA,MAAMK,UAAU,MAAMvC;IACtB,OAAO;QACL;;;;KAIC,GACDoC,QAAQ;QAER;;;;;KAKC,GACDE,SAAS;YACPE,MAAM;YAEN;;;;;OAKC,GACDC,YAAYC,QAAQ5C,WAAWqC;YAE/BQ,KAAK;gBACHC,QAAQ;oBACN;;;;;;;WAOC,GACDC,QAAQ;gBACV;YACF;YAEA;;;;;OAKC,GACDC,QAAQ;gBACN;;;;;SAKC,GACDC,MAAM;YACR;YAEAC,KAAK;gBACHT,SAASA,QAAQU,IAAI,CAAC;YACxB;QACF;IACF;AACF;AAYO,SAASnD,WACdqC,SAA8C;IAE9C,IAAIA,cAAc,UAAU;QAC1B,OAAO;IACT;IAEA,IAAIA,cAAc,MAAM;QACtB,OAAO;IACT;IAEA,OAAO;AACT;AAaO,SAASpC,mBAAmBmD,OAAa,EAAEC,WAAoB;IACpE,OAAO,CAACC;QACN,IAAIF,WAAWC,aAAa;YAC1BD,QAAQG,IAAI,GAAG,CAAC,EAAEF,YAAY,CAAC,EAAEG,IAAAA,UAAG,EAClC,CAAC,CAAC,EAAEC,KAAKC,KAAK,CAACJ,aAAa,KAAK,EAAE,CAAC,EACpC,CAAC;QACL;IACF;AACF;AAOO,eAAepD;IACpB,MAAMyD,WAAW,MAAMC,YAAE,CAACC,QAAQ,CAAChE,mBAAmB;IACtD,OAAO8D,SACJG,KAAK,CAAC,MACNC,GAAG,CAAC,CAACC,OAASA,KAAKC,IAAI,IACvBC,MAAM,CAAC,CAACF,OAASA,QAAQ,CAACA,KAAKG,UAAU,CAAC;AAC/C;AAsBO,SAAShE,UACdiE,KAAa,EACbC,QAAgB,EAChBC,SAAS,CAAC,EAAED,SAAS,CAAC,CAAC;IAEvB,OAAOD,UAAU,IAAIC,WAAWC;AAClC;AASO,SAASlE,aAAamE,SAA8C;IAGzE,IAAIA,cAAc,MAAM;QACtB,OAAOC,OAAOC,WAAW,CACvBC,sBAAc,CAACX,GAAG,CAAC,CAACY,OAAS;gBAC3BA;gBACA7E,iBAAiB,CAAC6E,KAAuC,IAAI;aAC9D;IAEL;IAEA,IAAIJ,cAAc,OAAO;QACvB,OAAOC,OAAOC,WAAW,CAACC,sBAAc,CAACX,GAAG,CAAC,CAACY,OAAS;gBAACA;gBAAM;aAAM;IACtE;IAEA,OAAOH,OAAOC,WAAW,CACvBC,sBAAc,CAACX,GAAG,CAAC,CAACY,OAAS;YAC3BA;YACAJ,SAAS,CAACI,KAAkD,GACxD7E,iBAAiB,CAAC6E,KAAuC,GACzD;SACL;AAEL"}