@metamask/snaps-cli 7.0.0 → 7.2.0

package/dist/webpack/plugins.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"plugins.mjs","sourceRoot":"","sources":["../../src/webpack/plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;;;AAEhE,OAAO,EAAE,SAAS,EAAE,eAAe;;;AAWnC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,oBAAgB;AAChD,OAAO,EAAE,QAAQ,EAAE,mCAAyB;AAC5C,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,2BAAiB;AAS9D;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAW3B,YACE,UAAmC;QACjC,OAAO,EAAE,KAAK;KACf,EACD,OAAa;;QATf;;WAEG;QACM,4CAAe;QAQtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO;YACT,CAAC;YAED,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAE3D,MAAM,CAAC,OAAO,EAAE,mCAAmC,CAAC,CAAC;YACrD,MAAM,CAAC,IAAI,EAAE,gCAAgC,CAAC,CAAC;YAE/C,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;gBACnB,MAAM,eAAe,GAAG,MAAM;qBAC3B,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,uBAAA,IAAI,2EAAsB,MAA1B,IAAI,EAAuB,UAAU,CAAC,CAAC;qBAC3D,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhB,KAAK,CACH,YAAY,OAAO,CAAC,MAAM,IAAI,SAAS,CACrC,OAAO,CAAC,MAAM,EACd,MAAM,CACP,OAAO,IAAI,WAAW,MAAM,CAAC,MAAM,IAAI,SAAS,CAC/C,MAAM,CAAC,MAAM,EACb,OAAO,CACR,QAAQ,eAAe,IAAI,EAC5B,uBAAA,IAAI,iCAAS,CACd,CAAC;gBAEF,uBAAA,IAAI,iCAAS,EAAE,IAAI,EAAE,CAAC;gBAEtB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,IAAI,QAAQ,EAAE,MAAM,EAAE,CAAC;gBACrB,MAAM,iBAAiB,GAAG,QAAQ;qBAC/B,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CACpB,uBAAA,IAAI,2EAAsB,MAA1B,IAAI,EAAuB,YAAY,EAAE,MAAM,CAAC,CACjD;qBACA,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhB,IAAI,CACF,YAAY,OAAO,CAAC,MAAM,IAAI,SAAS,CACrC,OAAO,CAAC,MAAM,EACd,MAAM,CACP,OAAO,IAAI,WAAW,QAAQ,CAAC,MAAM,IAAI,SAAS,CACjD,QAAQ,CAAC,MAAM,EACf,SAAS,CACV,QAAQ,iBAAiB,IAAI,EAC9B,uBAAA,IAAI,iCAAS,CACd,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CACF,YAAY,OAAO,CAAC,MAAM,IAAI,SAAS,CACrC,OAAO,CAAC,MAAM,EACd,MAAM,CACP,OAAO,IAAI,KAAK,EACjB,uBAAA,IAAI,iCAAS,CACd,CAAC;YACJ,CAAC;YAED,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;gBACvB,mEAAmE;gBACnE,wDAAwD;gBACxD,uBAAA,IAAI,iCAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CAwBF;iLAfuB,UAAsB,EAAE,KAAK,GAAG,GAAG;IACvD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO;QACtC,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC;QAC7B,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAEvB,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEjD,OAAO;QACL,KAAK,CAAC,UAAU,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACrC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACvD,UAAU,CAAC,OAAO,IAAI,KAAK,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE;KACpE;SACE,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAyBH;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAW3B,YAAY,OAAgC,EAAE,OAAa;;QAL3D;;WAEG;QACM,4CAAe;QAGtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;YACzD,uBAAA,IAAI,iCAAS,EAAE,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,uBAAuB,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,uBAAA,IAAI,iCAAS,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CACjC,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,KAAK,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE;YAC7B,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CACzB,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAC5C,CAAC;YAEF,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACjD,MAAM,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CAkBF;;AAhBC;;;;;;;GAOG;AACH,KAAK,yCAAe,UAAkB;IACpC,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3B,IAAI,CAAC,qCAAqC,EAAE,uBAAA,IAAI,iCAAS,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,aAAa,EAAE,CAAC;QACvB,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,uBAAA,IAAI,iCAAS,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAuBH;;;;;GAKG;AACH,MAAM,OAAO,oBAAoB;IAgB/B,YACE,UAAuC;QACrC,MAAM,EAAE,EAAE;KACX;QAlBH;;WAEG;QACM,sBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;QAE/C;;WAEG;QACM,uCAAU,mBAAmB,EAAC;QAYrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,QAAQ;aACL,OAAO,CAAC,uBAAA,IAAI,oCAAQ,CAAC;aACrB,QAAQ,CACP,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE;YAC7C,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC1B,OAAO,QAAQ,EAAE,CAAC;YACpB,CAAC;YAED,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,IACE,SAAS,CAAC,WAAW,CAAC;gBACtB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,EAC3C,CAAC;gBACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAC7C,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,WAAW,CACnC,CAAC;gBAEF,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;oBAChC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YAED,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC,CACF,CAAC;IACN,CAAC;CACF;;AAyBD;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,OAAO,yBAAyB;IAMpC,YACE,UAA4C;QAC1C,MAAM,EAAE,IAAI;QACZ,QAAQ,EAAE,IAAI;KACf;;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC1B,uBAAA,IAAI,sFAAe,MAAnB,IAAI,EAAgB,QAAQ,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,uBAAA,IAAI,oFAAa,MAAjB,IAAI,EAAc,QAAQ,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;CA8GF;mJAtGgB,QAAkB;IAC/B,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE;QACrE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;YAClC,OAAO;QACT,CAAC;QAED,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;QAC3D,IAAI,iBAAiB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,KAAK,CAAC,GAAG,iBAAiB,CAAC;aACrD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;aAC1B,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,MAAM,YAAY,GAAG,IAAI,YAAY,CACnC,wNAAwN,IAAI,CAC1N,aAAa,CACd,OAAO,IAAI,CACV,QAAQ,CACT,8DAA8D,IAAI,CACjE,QAAQ,CACT,+CAA+C,IAAI,CAClD,kBAAkB,CACnB,OAAO,IAAI,CACV,SAAS,CACV,uDAAuD,IAAI,CAC1D,yBAAyB,CAC1B,SAAS,CACX,CAAC;QAEF,YAAY,CAAC,OAAO,GAAG,gBAAgB,CAAC;QACxC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,mGAYgB,QAAiB;IAChC,OAAO,CACL,QAAQ,CAAC,QAAQ,CAAC;QAClB,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe;QAC7C,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,CACrC,CAAC;AACJ,CAAC,2FAQY,QAAkB;IAC7B,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzD,uBAAA,IAAI,wFAAiB,MAArB,IAAI,EAAkB,QAAQ,CAAC,CACH,CAAC;IAE/B,0EAA0E;IAC1E,yBAAyB;IACzB,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE;QACpE,WAAW,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CACtC,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,CAAC,MAAM,EAAE,EAAE;YACT,gCAAgC;YAChC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;iBACxC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACxC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;YAE5D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,OAAO;YACT,CAAC;YAED,WAAW,CAAC,QAAQ,CAAC,IAAI,CACvB,IAAI,YAAY,CACd,mLAAmL,IAAI,CACrL,UAAU,CACX,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,CACnC,aAAa,CACd,oEAAoE,IAAI,CACvE,gBAAgB,CACjB,OAAO,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACpD,CACF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { assert, hasProperty, isObject } from '@metamask/utils';\nimport { bold, dim, red, yellow } from 'chalk';\nimport { isBuiltin } from 'module';\nimport type { Ora } from 'ora';\nimport type {\n  Compiler,\n  ProvidePlugin,\n  Resolver,\n  StatsError,\n  WebpackPluginInstance,\n} from 'webpack';\nimport { WebpackError } from 'webpack';\n\nimport { formatText, pluralize } from './utils';\nimport { evaluate } from '../commands/eval';\nimport { error, getErrorMessage, info, warn } 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, warnings } = 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((statsError) => this.#getStatsErrorMessage(statsError))\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      if (warnings?.length) {\n        const formattedWarnings = warnings\n          .map((statsWarning) =>\n            this.#getStatsErrorMessage(statsWarning, yellow),\n          )\n          .join('\\n\\n');\n\n        warn(\n          `Compiled ${modules.length} ${pluralize(\n            modules.length,\n            'file',\n          )} in ${time}ms with ${warnings.length} ${pluralize(\n            warnings.length,\n            'warning',\n          )}.\\n\\n${formattedWarnings}\\n`,\n          this.#spinner,\n        );\n      } else {\n        info(\n          `Compiled ${modules.length} ${pluralize(\n            modules.length,\n            'file',\n          )} in ${time}ms.`,\n          this.#spinner,\n        );\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   * @param color - The color to use for the error message.\n   * @returns The error message.\n   */\n  #getStatsErrorMessage(statsError: StatsError, color = red) {\n    const baseMessage = this.options.verbose\n      ? getErrorMessage(statsError)\n      : statsError.message;\n\n    const [first, ...rest] = baseMessage.split('\\n');\n\n    return [\n      color(formatText(`• ${first}`, 4, 2)),\n      ...rest.map((message) => formatText(color(message), 4)),\n      statsError.details && `\\n${formatText(dim(statsError.details), 6)}`,\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 Webpack resolve plugin.\n *\n * Copied from Webpack's own types, because the `ResolvePluginInstance` type is\n * a union, and can't be used as a type for a class.\n */\ntype ResolvePlugin = {\n  apply: (resolver: Resolver) => void;\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 ResolvePlugin {\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  constructor(\n    options: SnapsBuiltInResolverOptions = {\n      ignore: [],\n    },\n  ) {\n    this.options = options;\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 options for the plugin.\n   */\n  readonly options: SnapsBundleWarningsPluginOptions;\n\n  constructor(\n    options: SnapsBundleWarningsPluginOptions = {\n      buffer: true,\n      builtIns: true,\n    },\n  ) {\n    this.options = options;\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, (compilation) => {\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) => `• ${name}`)\n        .join('\\n');\n\n      const webpackError = new WebpackError(\n        `The snap attempted to use one or more Node.js builtins, but no browser fallback has been provided. The MetaMask Snaps CLI does not support Node.js builtins by default. If you want to use this module, you must set ${bold(\n          '`polyfills`',\n        )} to ${bold(\n          '`true`',\n        )} or an object with the builtins to polyfill as the key and ${bold(\n          '`true`',\n        )} as the value. To disable this warning, set ${bold(\n          '`stats.builtIns`',\n        )} to ${bold(\n          '`false`',\n        )} in your snap config file, or add the module to the ${bold(\n          '`stats.builtIns.ignore`',\n        )} array.`,\n      );\n\n      webpackError.details = formattedModules;\n      compilation.warnings.push(webpackError);\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          compilation.warnings.push(\n            new WebpackError(\n              `The snap attempted to use the Node.js Buffer global, which is not supported in the MetaMask Snaps CLI by default. To use the Buffer global, you must polyfill Buffer by setting ${bold(\n                '`buffer`',\n              )} to ${bold('`true`')} in the ${bold(\n                '`polyfills`',\n              )} config object in your snap config. To disable this warning, set ${bold(\n                '`stats.buffer`',\n              )} to ${bold('`false`')} in your snap config file.`,\n            ),\n          );\n        },\n      );\n    });\n  }\n}\n"]}
+{"version":3,"file":"plugins.mjs","sourceRoot":"","sources":["../../src/webpack/plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;;;AAEhE,OAAO,EAAE,SAAS,EAAE,eAAe;;;AAWnC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,oBAAgB;AAChD,OAAO,EAAE,QAAQ,EAAE,mCAAyB;AAC5C,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,2BAAiB;AAS9D;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAW3B,YACE,UAAmC;QACjC,OAAO,EAAE,KAAK;KACf,EACD,OAAa;;QATf;;WAEG;QACM,4CAAe;QAQtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO;YACT,CAAC;YAED,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAE3D,MAAM,CAAC,OAAO,EAAE,mCAAmC,CAAC,CAAC;YACrD,MAAM,CAAC,IAAI,EAAE,gCAAgC,CAAC,CAAC;YAE/C,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;gBACnB,MAAM,eAAe,GAAG,MAAM;qBAC3B,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,uBAAA,IAAI,2EAAsB,MAA1B,IAAI,EAAuB,UAAU,EAAE,GAAG,CAAC,CAAC;qBAChE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhB,KAAK,CACH,YAAY,OAAO,CAAC,MAAM,IAAI,SAAS,CACrC,OAAO,CAAC,MAAM,EACd,MAAM,CACP,OAAO,IAAI,WAAW,MAAM,CAAC,MAAM,IAAI,SAAS,CAC/C,MAAM,CAAC,MAAM,EACb,OAAO,CACR,QAAQ,eAAe,IAAI,EAC5B,uBAAA,IAAI,iCAAS,CACd,CAAC;gBAEF,uBAAA,IAAI,iCAAS,EAAE,IAAI,EAAE,CAAC;gBAEtB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,IAAI,QAAQ,EAAE,MAAM,EAAE,CAAC;gBACrB,MAAM,iBAAiB,GAAG,QAAQ;qBAC/B,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CACpB,uBAAA,IAAI,2EAAsB,MAA1B,IAAI,EAAuB,YAAY,EAAE,MAAM,CAAC,CACjD;qBACA,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhB,IAAI,CACF,YAAY,OAAO,CAAC,MAAM,IAAI,SAAS,CACrC,OAAO,CAAC,MAAM,EACd,MAAM,CACP,OAAO,IAAI,WAAW,QAAQ,CAAC,MAAM,IAAI,SAAS,CACjD,QAAQ,CAAC,MAAM,EACf,SAAS,CACV,QAAQ,iBAAiB,IAAI,EAC9B,uBAAA,IAAI,iCAAS,CACd,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CACF,YAAY,OAAO,CAAC,MAAM,IAAI,SAAS,CACrC,OAAO,CAAC,MAAM,EACd,MAAM,CACP,OAAO,IAAI,KAAK,EACjB,uBAAA,IAAI,iCAAS,CACd,CAAC;YACJ,CAAC;YAED,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;gBACvB,mEAAmE;gBACnE,wDAAwD;gBACxD,uBAAA,IAAI,iCAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CA2BF;iLAjBG,UAAsB,EACtB,KAAiC;IAEjC,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO;QACtC,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC;QAC7B,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAEvB,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEjD,OAAO;QACL,KAAK,CAAC,UAAU,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACrC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACvD,UAAU,CAAC,OAAO,IAAI,KAAK,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE;KACpE;SACE,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAyBH;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAW3B,YAAY,OAAgC,EAAE,OAAa;;QAL3D;;WAEG;QACM,4CAAe;QAGtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;YACzD,uBAAA,IAAI,iCAAS,EAAE,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,uBAAuB,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,uBAAA,IAAI,iCAAS,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CACjC,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,KAAK,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE;YAC7B,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CACzB,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAC5C,CAAC;YAEF,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACjD,MAAM,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CAkBF;;AAhBC;;;;;;;GAOG;AACH,KAAK,yCAAe,UAAkB;IACpC,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3B,IAAI,CAAC,qCAAqC,EAAE,uBAAA,IAAI,iCAAS,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,aAAa,EAAE,CAAC;QACvB,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,uBAAA,IAAI,iCAAS,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAuBH;;;;;GAKG;AACH,MAAM,OAAO,oBAAoB;IAgB/B,YACE,UAAuC;QACrC,MAAM,EAAE,EAAE;KACX;QAlBH;;WAEG;QACM,sBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;QAE/C;;WAEG;QACM,uCAAU,mBAAmB,EAAC;QAYrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,QAAQ;aACL,OAAO,CAAC,uBAAA,IAAI,oCAAQ,CAAC;aACrB,QAAQ,CACP,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE;YAC7C,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC1B,OAAO,QAAQ,EAAE,CAAC;YACpB,CAAC;YAED,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,IACE,SAAS,CAAC,WAAW,CAAC;gBACtB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,EAC3C,CAAC;gBACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAC7C,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,WAAW,CACnC,CAAC;gBAEF,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;oBAChC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YAED,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC,CACF,CAAC;IACN,CAAC;CACF;;AAyBD;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,OAAO,yBAAyB;IAMpC,YACE,UAA4C;QAC1C,MAAM,EAAE,IAAI;QACZ,QAAQ,EAAE,IAAI;KACf;;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAkB;QACtB,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC1B,uBAAA,IAAI,sFAAe,MAAnB,IAAI,EAAgB,QAAQ,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,uBAAA,IAAI,oFAAa,MAAjB,IAAI,EAAc,QAAQ,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;CA8GF;mJAtGgB,QAAkB;IAC/B,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE;QACrE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;YAClC,OAAO;QACT,CAAC;QAED,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;QAC3D,IAAI,iBAAiB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,KAAK,CAAC,GAAG,iBAAiB,CAAC;aACrD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;aAC1B,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,MAAM,YAAY,GAAG,IAAI,YAAY,CACnC,wNAAwN,IAAI,CAC1N,aAAa,CACd,OAAO,IAAI,CACV,QAAQ,CACT,8DAA8D,IAAI,CACjE,QAAQ,CACT,+CAA+C,IAAI,CAClD,kBAAkB,CACnB,OAAO,IAAI,CACV,SAAS,CACV,uDAAuD,IAAI,CAC1D,yBAAyB,CAC1B,SAAS,CACX,CAAC;QAEF,YAAY,CAAC,OAAO,GAAG,gBAAgB,CAAC;QACxC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,mGAYgB,QAAiB;IAChC,OAAO,CACL,QAAQ,CAAC,QAAQ,CAAC;QAClB,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe;QAC7C,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,CACrC,CAAC;AACJ,CAAC,2FAQY,QAAkB;IAC7B,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzD,uBAAA,IAAI,wFAAiB,MAArB,IAAI,EAAkB,QAAQ,CAAC,CACH,CAAC;IAE/B,0EAA0E;IAC1E,yBAAyB;IACzB,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE;QACpE,WAAW,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CACtC,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,CAAC,MAAM,EAAE,EAAE;YACT,gCAAgC;YAChC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;iBACxC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACxC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;YAE5D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,OAAO;YACT,CAAC;YAED,WAAW,CAAC,QAAQ,CAAC,IAAI,CACvB,IAAI,YAAY,CACd,mLAAmL,IAAI,CACrL,UAAU,CACX,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,CACnC,aAAa,CACd,oEAAoE,IAAI,CACvE,gBAAgB,CACjB,OAAO,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACpD,CACF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { assert, hasProperty, isObject } from '@metamask/utils';\nimport { bold, dim, red, yellow } from 'chalk';\nimport { isBuiltin } from 'module';\nimport type { Ora } from 'ora';\nimport type {\n  Compiler,\n  ProvidePlugin,\n  Resolver,\n  StatsError,\n  WebpackPluginInstance,\n} from 'webpack';\nimport { WebpackError } from 'webpack';\n\nimport { formatText, pluralize } from './utils';\nimport { evaluate } from '../commands/eval';\nimport { error, getErrorMessage, info, warn } 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, warnings } = 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((statsError) => this.#getStatsErrorMessage(statsError, red))\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      if (warnings?.length) {\n        const formattedWarnings = warnings\n          .map((statsWarning) =>\n            this.#getStatsErrorMessage(statsWarning, yellow),\n          )\n          .join('\\n\\n');\n\n        warn(\n          `Compiled ${modules.length} ${pluralize(\n            modules.length,\n            'file',\n          )} in ${time}ms with ${warnings.length} ${pluralize(\n            warnings.length,\n            'warning',\n          )}.\\n\\n${formattedWarnings}\\n`,\n          this.#spinner,\n        );\n      } else {\n        info(\n          `Compiled ${modules.length} ${pluralize(\n            modules.length,\n            'file',\n          )} in ${time}ms.`,\n          this.#spinner,\n        );\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   * @param color - The color to use for the error message.\n   * @returns The error message.\n   */\n  #getStatsErrorMessage(\n    statsError: StatsError,\n    color: typeof red | typeof yellow,\n  ) {\n    const baseMessage = this.options.verbose\n      ? getErrorMessage(statsError)\n      : statsError.message;\n\n    const [first, ...rest] = baseMessage.split('\\n');\n\n    return [\n      color(formatText(`• ${first}`, 4, 2)),\n      ...rest.map((message) => formatText(color(message), 4)),\n      statsError.details && `\\n${formatText(dim(statsError.details), 6)}`,\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 Webpack resolve plugin.\n *\n * Copied from Webpack's own types, because the `ResolvePluginInstance` type is\n * a union, and can't be used as a type for a class.\n */\ntype ResolvePlugin = {\n  apply: (resolver: Resolver) => void;\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 ResolvePlugin {\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  constructor(\n    options: SnapsBuiltInResolverOptions = {\n      ignore: [],\n    },\n  ) {\n    this.options = options;\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 options for the plugin.\n   */\n  readonly options: SnapsBundleWarningsPluginOptions;\n\n  constructor(\n    options: SnapsBundleWarningsPluginOptions = {\n      buffer: true,\n      builtIns: true,\n    },\n  ) {\n    this.options = options;\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, (compilation) => {\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) => `• ${name}`)\n        .join('\\n');\n\n      const webpackError = new WebpackError(\n        `The snap attempted to use one or more Node.js builtins, but no browser fallback has been provided. The MetaMask Snaps CLI does not support Node.js builtins by default. If you want to use this module, you must set ${bold(\n          '`polyfills`',\n        )} to ${bold(\n          '`true`',\n        )} or an object with the builtins to polyfill as the key and ${bold(\n          '`true`',\n        )} as the value. To disable this warning, set ${bold(\n          '`stats.builtIns`',\n        )} to ${bold(\n          '`false`',\n        )} in your snap config file, or add the module to the ${bold(\n          '`stats.builtIns.ignore`',\n        )} array.`,\n      );\n\n      webpackError.details = formattedModules;\n      compilation.warnings.push(webpackError);\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          compilation.warnings.push(\n            new WebpackError(\n              `The snap attempted to use the Node.js Buffer global, which is not supported in the MetaMask Snaps CLI by default. To use the Buffer global, you must polyfill Buffer by setting ${bold(\n                '`buffer`',\n              )} to ${bold('`true`')} in the ${bold(\n                '`polyfills`',\n              )} config object in your snap config. To disable this warning, set ${bold(\n                '`stats.buffer`',\n              )} to ${bold('`false`')} in your snap config file.`,\n            ),\n          );\n        },\n      );\n    });\n  }\n}\n"]}

package/dist/webpack/server.cjs

@@ -1,13 +1,32 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getServer = exports.getAllowedPaths = void 0;
 const node_1 = require("@metamask/snaps-utils/node");
-const http_1 = require("http");
+const express_1 = __importStar(require("express/index.js"));
 const path_1 = require("path");
-const serve_handler_1 = __importDefault(require("serve-handler"));
 /**
  * Get the relative path from one path to another.
  *
@@ -46,6 +65,22 @@ function getAllowedPaths(config, manifest) {
     ];
 }
 exports.getAllowedPaths = getAllowedPaths;
+/**
+ * Get whether the request path is allowed. This is used to check if the request
+ * path is in the list of allowed paths for the static server.
+ *
+ * @param request - The request object.
+ * @param config - The config object.
+ * @returns A promise that resolves to `true` if the path is allowed, or
+ * `false` if it is not.
+ */
+async function isAllowedPath(request, config) {
+    const manifestPath = (0, path_1.join)(config.server.root, node_1.NpmSnapFileNames.Manifest);
+    const { result } = await (0, node_1.readJsonFile)(manifestPath);
+    const allowedPaths = getAllowedPaths(config, result);
+    const path = request.path.slice(1);
+    return allowedPaths.some((allowedPath) => path === allowedPath);
+}
 /**
  * Get a static server for development purposes.
  *
@@ -54,61 +89,38 @@ exports.getAllowedPaths = getAllowedPaths;
  * difficult to customize.
  *
  * @param config - The config object.
+ * @param middleware - An array of middleware functions to run before serving
+ * the static files.
  * @returns An object with a `listen` method that returns a promise that
  * resolves when the server is listening.
  */
-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 = (0, path_1.join)(config.server.root, node_1.NpmSnapFileNames.Manifest);
-        const { result } = await (0, node_1.readJsonFile)(manifestPath);
-        const allowedPaths = getAllowedPaths(config, result);
-        const pathname = request.url &&
-            request.headers.host &&
-            new URL(request.url, `http://${request.headers.host}`).pathname;
-        const path = pathname?.slice(1);
-        const allowed = allowedPaths.some((allowedPath) => path === allowedPath);
-        if (!allowed) {
-            response.statusCode = 404;
-            response.end();
-            return;
-        }
-        await (0, serve_handler_1.default)(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 = (0, http_1.createServer)((request, response) => {
-        getResponse(request, response).catch(
-        /* istanbul ignore next */
-        (error) => {
-            (0, node_1.logError)(error);
-            response.statusCode = 500;
+function getServer(config, middleware = []) {
+    const app = (0, express_1.default)();
+    // Run "middleware" functions before serving the static files.
+    middleware.forEach((fn) => fn(app));
+    // Check for allowed paths in the request URL.
+    app.use((request, response, next) => {
+        isAllowedPath(request, config)
+            .then((allowed) => {
+            if (allowed) {
+                // eslint-disable-next-line promise/no-callback-in-promise
+                next();
+                return;
+            }
+            response.status(404);
             response.end();
-        });
+        })
+            // eslint-disable-next-line promise/no-callback-in-promise
+            .catch(next);
     });
+    // Serve the static files.
+    app.use((0, express_1.static)(config.server.root, {
+        dotfiles: 'deny',
+        setHeaders: (res) => {
+            res.setHeader('Cache-Control', 'no-cache');
+            res.setHeader('Access-Control-Allow-Origin', '*');
+        },
+    }));
     /**
      * Start the server on the port specified in the config.
      *
@@ -120,25 +132,24 @@ function getServer(config) {
      */
     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();
-                            });
+            // eslint-disable-next-line consistent-return
+            const server = app.listen(port, (error) => {
+                if (error) {
+                    return reject(error);
+                }
+                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);
-            }
+                    });
+                };
+                const address = server.address();
+                resolve({ port: address.port, server, close });
+            });
         });
     };
     return { listen };

package/dist/webpack/server.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"server.cjs","sourceRoot":"","sources":["../../src/webpack/server.ts"],"names":[],"mappings":";;;;;;AACA,qDAIoC;AAEpC,+BAAoC;AAEpC,+BAA0E;AAC1E,kEAA4C;AAI5C;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,EAAU;IAC/C,OAAO,IAAA,eAAQ,EAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAG,CAAC,CAAC,IAAI,CAAC,YAAK,CAAC,GAAG,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,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,IAAA,cAAW,EAAC,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,IAAA,cAAW,EAAC,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,IAAA,cAAW,EACT,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,IAAA,cAAW,EACT,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,IAAA,cAAW,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,uBAAgB,CAAC,QAAQ,CAAC,CAC3D;QACD,GAAG,cAAc;QACjB,GAAG,iBAAiB;QACpB,GAAG,UAAU;KACd,CAAC;AACJ,CAAC;AAjDD,0CAiDC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,SAAS,CAAC,MAAuB;IAC/C;;;;;;;OAOG;IACH,KAAK,UAAU,WAAW,CACxB,OAAwB,EACxB,QAAwB;QAExB,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,uBAAgB,CAAC,QAAQ,CAAC,CAAC;QACzE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,mBAAY,EAAe,YAAY,CAAC,CAAC;QAClE,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAErD,MAAM,QAAQ,GACZ,OAAO,CAAC,GAAG;YACX,OAAO,CAAC,OAAO,CAAC,IAAI;YACpB,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC;QAClE,MAAM,IAAI,GAAG,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,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,IAAA,uBAAe,EAAC,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,IAAA,mBAAY,EAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;QAChD,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,KAAK;QAClC,0BAA0B;QAC1B,CAAC,KAAK,EAAE,EAAE;YACR,IAAA,eAAQ,EAAC,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;AArGD,8BAqGC","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 pathname =\n      request.url &&\n      request.headers.host &&\n      new URL(request.url, `http://${request.headers.host}`).pathname;\n    const path = pathname?.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"]}
+{"version":3,"file":"server.cjs","sourceRoot":"","sources":["../../src/webpack/server.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,qDAA4E;AAE5E,4DAA2D;AAG3D,+BAA0E;AAI1E;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,EAAU;IAC/C,OAAO,IAAA,eAAQ,EAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAG,CAAC,CAAC,IAAI,CAAC,YAAK,CAAC,GAAG,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,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,IAAA,cAAW,EAAC,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,IAAA,cAAW,EAAC,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,IAAA,cAAW,EACT,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,IAAA,cAAW,EACT,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,IAAA,cAAW,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,uBAAgB,CAAC,QAAQ,CAAC,CAC3D;QACD,GAAG,cAAc;QACjB,GAAG,iBAAiB;QACpB,GAAG,UAAU;KACd,CAAC;AACJ,CAAC;AAjDD,0CAiDC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,aAAa,CAAC,OAAgB,EAAE,MAAuB;IACpE,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,uBAAgB,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,mBAAY,EAAe,YAAY,CAAC,CAAC;IAClE,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;AAClE,CAAC;AAID;;;;;;;;;;;;GAYG;AACH,SAAgB,SAAS,CACvB,MAAuB,EACvB,aAA2B,EAAE;IAE7B,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;IAEtB,8DAA8D;IAC9D,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpC,8CAA8C;IAC9C,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;QAClC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC;aAC3B,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YAChB,IAAI,OAAO,EAAE,CAAC;gBACZ,0DAA0D;gBAC1D,IAAI,EAAE,CAAC;gBACP,OAAO;YACT,CAAC;YAED,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,QAAQ,CAAC,GAAG,EAAE,CAAC;QACjB,CAAC,CAAC;YACF,0DAA0D;aACzD,KAAK,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,0BAA0B;IAC1B,GAAG,CAAC,GAAG,CACL,IAAA,gBAAa,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;QAChC,QAAQ,EAAE,MAAM;QAChB,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YAClB,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;YAC3C,GAAG,CAAC,SAAS,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC;KACF,CAAC,CACH,CAAC;IAEF;;;;;;;;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,6CAA6C;YAC7C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxC,IAAI,KAAK,EAAE,CAAC;oBACV,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;gBAED,MAAM,KAAK,GAAG,KAAK,IAAI,EAAE;oBACvB,MAAM,IAAI,OAAO,CAAO,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;wBACpD,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE;4BAC1B,IAAI,UAAU,EAAE,CAAC;gCACf,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;4BACjC,CAAC;4BAED,OAAO,YAAY,EAAE,CAAC;wBACxB,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;gBAEF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAiB,CAAC;gBAChD,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC;AA7ED,8BA6EC","sourcesContent":["import type { SnapManifest } from '@metamask/snaps-utils';\nimport { NpmSnapFileNames, readJsonFile } from '@metamask/snaps-utils/node';\nimport type { Express, Request } from 'express';\nimport express, { static as expressStatic } from 'express';\nimport type { Server } from 'http';\nimport type { AddressInfo } from 'net';\nimport { join, relative, resolve as resolvePath, sep, posix } from 'path';\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 whether the request path is allowed. This is used to check if the request\n * path is in the list of allowed paths for the static server.\n *\n * @param request - The request object.\n * @param config - The config object.\n * @returns A promise that resolves to `true` if the path is allowed, or\n * `false` if it is not.\n */\nasync function isAllowedPath(request: Request, config: ProcessedConfig) {\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.path.slice(1);\n  return allowedPaths.some((allowedPath) => path === allowedPath);\n}\n\ntype Middleware = (app: Express) => void;\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 * @param middleware - An array of middleware functions to run before serving\n * the static files.\n * @returns An object with a `listen` method that returns a promise that\n * resolves when the server is listening.\n */\nexport function getServer(\n  config: ProcessedConfig,\n  middleware: Middleware[] = [],\n) {\n  const app = express();\n\n  // Run \"middleware\" functions before serving the static files.\n  middleware.forEach((fn) => fn(app));\n\n  // Check for allowed paths in the request URL.\n  app.use((request, response, next) => {\n    isAllowedPath(request, config)\n      .then((allowed) => {\n        if (allowed) {\n          // eslint-disable-next-line promise/no-callback-in-promise\n          next();\n          return;\n        }\n\n        response.status(404);\n        response.end();\n      })\n      // eslint-disable-next-line promise/no-callback-in-promise\n      .catch(next);\n  });\n\n  // Serve the static files.\n  app.use(\n    expressStatic(config.server.root, {\n      dotfiles: 'deny',\n      setHeaders: (res) => {\n        res.setHeader('Cache-Control', 'no-cache');\n        res.setHeader('Access-Control-Allow-Origin', '*');\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      // eslint-disable-next-line consistent-return\n      const server = app.listen(port, (error) => {\n        if (error) {\n          return reject(error);\n        }\n\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    });\n  };\n\n  return { listen };\n}\n"]}

package/dist/webpack/server.d.cts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import type { SnapManifest } from "@metamask/snaps-utils";
+import type { Express } from "express/index.js";
 import type { Server } from "http";
 import type { ProcessedConfig } from "../config.cjs";
 /**
@@ -11,6 +12,7 @@ import type { ProcessedConfig } from "../config.cjs";
  * @returns An array of allowed paths.
  */
 export declare function getAllowedPaths(config: ProcessedConfig, manifest: SnapManifest): string[];
+type Middleware = (app: Express) => void;
 /**
  * Get a static server for development purposes.
  *
@@ -19,14 +21,17 @@ export declare function getAllowedPaths(config: ProcessedConfig, manifest: SnapM
  * difficult to customize.
  *
  * @param config - The config object.
+ * @param middleware - An array of middleware functions to run before serving
+ * the static files.
  * @returns An object with a `listen` method that returns a promise that
  * resolves when the server is listening.
  */
-export declare function getServer(config: ProcessedConfig): {
+export declare function getServer(config: ProcessedConfig, middleware?: Middleware[]): {
     listen: (port?: number) => Promise<{
         port: number;
         server: Server;
         close: () => Promise<void>;
     }>;
 };
+export {};
 //# sourceMappingURL=server.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"server.d.cts","sourceRoot":"","sources":["../../src/webpack/server.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAM1D,OAAO,KAAK,EAAmB,MAAM,EAAkB,aAAa;AAMpE,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AAgBjD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,eAAe,EACvB,QAAQ,EAAE,YAAY,YA+CvB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,eAAe;;cAyErC,MAAM;gBACJ,MAAM;eACP,MAAM,QAAQ,IAAI,CAAC;;EA0B/B"}
+{"version":3,"file":"server.d.cts","sourceRoot":"","sources":["../../src/webpack/server.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAE1D,OAAO,KAAK,EAAE,OAAO,EAAW,yBAAgB;AAEhD,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa;AAInC,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AAgBjD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,eAAe,EACvB,QAAQ,EAAE,YAAY,YA+CvB;AAoBD,KAAK,UAAU,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;AAEzC;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,eAAe,EACvB,UAAU,GAAE,UAAU,EAAO;;cA8CnB,MAAM;gBACJ,MAAM;eACP,MAAM,QAAQ,IAAI,CAAC;;EA2B/B"}

package/dist/webpack/server.d.mts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import type { SnapManifest } from "@metamask/snaps-utils";
+import type { Express } from "express/index.js";
 import type { Server } from "http";
 import type { ProcessedConfig } from "../config.mjs";
 /**
@@ -11,6 +12,7 @@ import type { ProcessedConfig } from "../config.mjs";
  * @returns An array of allowed paths.
  */
 export declare function getAllowedPaths(config: ProcessedConfig, manifest: SnapManifest): string[];
+type Middleware = (app: Express) => void;
 /**
  * Get a static server for development purposes.
  *
@@ -19,14 +21,17 @@ export declare function getAllowedPaths(config: ProcessedConfig, manifest: SnapM
  * difficult to customize.
  *
  * @param config - The config object.
+ * @param middleware - An array of middleware functions to run before serving
+ * the static files.
  * @returns An object with a `listen` method that returns a promise that
  * resolves when the server is listening.
  */
-export declare function getServer(config: ProcessedConfig): {
+export declare function getServer(config: ProcessedConfig, middleware?: Middleware[]): {
     listen: (port?: number) => Promise<{
         port: number;
         server: Server;
         close: () => Promise<void>;
     }>;
 };
+export {};
 //# sourceMappingURL=server.d.mts.map

package/dist/webpack/server.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.mts","sourceRoot":"","sources":["../../src/webpack/server.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAM1D,OAAO,KAAK,EAAmB,MAAM,EAAkB,aAAa;AAMpE,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AAgBjD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,eAAe,EACvB,QAAQ,EAAE,YAAY,YA+CvB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,eAAe;;cAyErC,MAAM;gBACJ,MAAM;eACP,MAAM,QAAQ,IAAI,CAAC;;EA0B/B"}
+{"version":3,"file":"server.d.mts","sourceRoot":"","sources":["../../src/webpack/server.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,8BAA8B;AAE1D,OAAO,KAAK,EAAE,OAAO,EAAW,yBAAgB;AAEhD,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa;AAInC,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAkB;AAgBjD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,eAAe,EACvB,QAAQ,EAAE,YAAY,YA+CvB;AAoBD,KAAK,UAAU,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;AAEzC;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,eAAe,EACvB,UAAU,GAAE,UAAU,EAAO;;cA8CnB,MAAM;gBACJ,MAAM;eACP,MAAM,QAAQ,IAAI,CAAC;;EA2B/B"}

package/dist/webpack/server.mjs

@@ -4,11 +4,10 @@ function $importDefault(module) {
     }
     return module;
 }
-import { logError, NpmSnapFileNames, readJsonFile } from "@metamask/snaps-utils/node";
-import { createServer } from "http";
+import { NpmSnapFileNames, readJsonFile } from "@metamask/snaps-utils/node";
+import $express, { static as expressStatic } from "express/index.js";
+const express = $importDefault($express);
 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.
  *
@@ -46,6 +45,22 @@ export function getAllowedPaths(config, manifest) {
         ...otherFiles,
     ];
 }
+/**
+ * Get whether the request path is allowed. This is used to check if the request
+ * path is in the list of allowed paths for the static server.
+ *
+ * @param request - The request object.
+ * @param config - The config object.
+ * @returns A promise that resolves to `true` if the path is allowed, or
+ * `false` if it is not.
+ */
+async function isAllowedPath(request, config) {
+    const manifestPath = join(config.server.root, NpmSnapFileNames.Manifest);
+    const { result } = await readJsonFile(manifestPath);
+    const allowedPaths = getAllowedPaths(config, result);
+    const path = request.path.slice(1);
+    return allowedPaths.some((allowedPath) => path === allowedPath);
+}
 /**
  * Get a static server for development purposes.
  *
@@ -54,61 +69,38 @@ export function getAllowedPaths(config, manifest) {
  * difficult to customize.
  *
  * @param config - The config object.
+ * @param middleware - An array of middleware functions to run before serving
+ * the static files.
  * @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 pathname = request.url &&
-            request.headers.host &&
-            new URL(request.url, `http://${request.headers.host}`).pathname;
-        const path = pathname?.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;
+export function getServer(config, middleware = []) {
+    const app = express();
+    // Run "middleware" functions before serving the static files.
+    middleware.forEach((fn) => fn(app));
+    // Check for allowed paths in the request URL.
+    app.use((request, response, next) => {
+        isAllowedPath(request, config)
+            .then((allowed) => {
+            if (allowed) {
+                // eslint-disable-next-line promise/no-callback-in-promise
+                next();
+                return;
+            }
+            response.status(404);
             response.end();
-        });
+        })
+            // eslint-disable-next-line promise/no-callback-in-promise
+            .catch(next);
     });
+    // Serve the static files.
+    app.use(expressStatic(config.server.root, {
+        dotfiles: 'deny',
+        setHeaders: (res) => {
+            res.setHeader('Cache-Control', 'no-cache');
+            res.setHeader('Access-Control-Allow-Origin', '*');
+        },
+    }));
     /**
      * Start the server on the port specified in the config.
      *
@@ -120,25 +112,24 @@ export function getServer(config) {
      */
     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();
-                            });
+            // eslint-disable-next-line consistent-return
+            const server = app.listen(port, (error) => {
+                if (error) {
+                    return reject(error);
+                }
+                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);
-            }
+                    });
+                };
+                const address = server.address();
+                resolve({ port: address.port, server, close });
+            });
         });
     };
     return { listen };