@metamask/snaps-cli 0.16.0 → 0.17.0

package/dist/cmds/eval/workerEval.js

@@ -4,26 +4,31 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.workerEval = void 0;
-const worker_threads_1 = require("worker_threads");
+const child_process_1 = require("child_process");
 const path_1 = __importDefault(require("path"));
+/**
+ * Spawn a new worker thread to run the provided bundle in.
+ *
+ * @param bundlePath - The path to the bundle to run.
+ * @returns `null` if the worker ran successfully.
+ * @throws If the worker failed to run successfully.
+ */
 function workerEval(bundlePath) {
     return new Promise((resolve) => {
-        new worker_threads_1.Worker(getEvalWorkerPath())
-            .on('exit', (exitCode) => {
+        (0, child_process_1.fork)(getEvalWorkerPath(), [bundlePath]).on('exit', (exitCode) => {
             if (exitCode === 0) {
                 resolve(null);
             }
             else {
                 throw new Error(`Worker exited abnormally! Code: ${exitCode}`);
             }
-        })
-            .postMessage({
-            snapFilePath: bundlePath,
         });
     });
 }
 exports.workerEval = workerEval;
 /**
+ * Get the path to the eval worker file.
+ *
  * @returns The path to the eval worker file.
  */
 function getEvalWorkerPath() {

package/dist/cmds/eval/workerEval.js.map

@@ -1 +1 @@
-{"version":3,"file":"workerEval.js","sourceRoot":"","sources":["../../../src/cmds/eval/workerEval.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAwC;AACxC,gDAA6B;AAE7B,SAAgB,UAAU,CAAC,UAAkB;IAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,uBAAM,CAAC,iBAAiB,EAAE,CAAC;aAC5B,EAAE,CAAC,MAAM,EAAE,CAAC,QAAgB,EAAE,EAAE;YAC/B,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;aAChE;QACH,CAAC,CAAC;aACD,WAAW,CAAC;YACX,YAAY,EAAE,UAAU;SACzB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,gCAcC;AAED;;GAEG;AACH,SAAS,iBAAiB;IACxB,OAAO,cAAS,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { Worker } from 'worker_threads';\nimport pathUtils from 'path';\n\nexport function workerEval(bundlePath: string): Promise<null> {\n  return new Promise((resolve) => {\n    new Worker(getEvalWorkerPath())\n      .on('exit', (exitCode: number) => {\n        if (exitCode === 0) {\n          resolve(null);\n        } else {\n          throw new Error(`Worker exited abnormally! Code: ${exitCode}`);\n        }\n      })\n      .postMessage({\n        snapFilePath: bundlePath,\n      });\n  });\n}\n\n/**\n * @returns The path to the eval worker file.\n */\nfunction getEvalWorkerPath(): string {\n  return pathUtils.join(__dirname, 'eval-worker.js');\n}\n"]}
+{"version":3,"file":"workerEval.js","sourceRoot":"","sources":["../../../src/cmds/eval/workerEval.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAqC;AACrC,gDAA6B;AAE7B;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,UAAkB;IAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAA,oBAAI,EAAC,iBAAiB,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAgB,EAAE,EAAE;YACtE,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;aAChE;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAVD,gCAUC;AAED;;;;GAIG;AACH,SAAS,iBAAiB;IACxB,OAAO,cAAS,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { fork } from 'child_process';\nimport pathUtils from 'path';\n\n/**\n * Spawn a new worker thread to run the provided bundle in.\n *\n * @param bundlePath - The path to the bundle to run.\n * @returns `null` if the worker ran successfully.\n * @throws If the worker failed to run successfully.\n */\nexport function workerEval(bundlePath: string): Promise<null> {\n  return new Promise((resolve) => {\n    fork(getEvalWorkerPath(), [bundlePath]).on('exit', (exitCode: number) => {\n      if (exitCode === 0) {\n        resolve(null);\n      } else {\n        throw new Error(`Worker exited abnormally! Code: ${exitCode}`);\n      }\n    });\n  });\n}\n\n/**\n * Get the path to the eval worker file.\n *\n * @returns The path to the eval worker file.\n */\nfunction getEvalWorkerPath(): string {\n  return pathUtils.join(__dirname, 'eval-worker.js');\n}\n"]}

package/dist/cmds/init/index.js

@@ -5,6 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 const builders_1 = __importDefault(require("../../builders"));
 const buildHandler_1 = require("../build/buildHandler");
 const initHandler_1 = require("./initHandler");
+const initUtils_1 = require("./initUtils");
+/**
+ * The main entrypoint for the init command. This calls the init handler to
+ * initialize the snap package, builds the snap, and then updates the manifest
+ * with the shasum of the built snap.
+ *
+ * @param argv - The Yargs arguments object.
+ */
 async function init(argv) {
     console.log();
     const newArgs = await (0, initHandler_1.initHandler)(argv);
@@ -24,7 +32,11 @@ module.exports = {
             .option('src', builders_1.default.src)
             .option('dist', builders_1.default.dist)
             .option('port', builders_1.default.port)
-            .option('outfileName', builders_1.default.outfileName);
+            .option('outfileName', builders_1.default.outfileName)
+            .option('template', builders_1.default.template)
+            .middleware(((yargsArgv) => {
+            (0, initUtils_1.correctDefaultArgs)(yargsArgv);
+        }), true);
     },
     handler: (argv) => init(argv),
 };

package/dist/cmds/init/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/init/index.ts"],"names":[],"mappings":";;;;AACA,8DAAsC;AAEtC,wDAA8C;AAC9C,+CAAkE;AAelE,KAAK,UAAU,IAAI,CAAC,IAAe;IACjC,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,MAAM,OAAO,GAAG,MAAM,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC;IAExC,MAAM,IAAA,oBAAK,EAAC;QACV,GAAG,OAAO;QACV,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IAEH,MAAM,IAAA,kCAAoB,GAAE,CAAC;IAE7B,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AACxD,CAAC;AA1BD,iBAAS;IACP,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC;IACtB,IAAI,EAAE,yBAAyB;IAC/B,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI;aACD,MAAM,CAAC,KAAK,EAAE,kBAAQ,CAAC,GAAG,CAAC;aAC3B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,aAAa,EAAE,kBAAQ,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;CACzC,CAAC","sourcesContent":["import yargs from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { build } from '../build/buildHandler';\nimport { initHandler, updateManifestShasum } from './initHandler';\n\nexport = {\n  command: ['init', 'i'],\n  desc: 'Initialize Snap package',\n  builder: (yarg: yargs.Argv) => {\n    yarg\n      .option('src', builders.src)\n      .option('dist', builders.dist)\n      .option('port', builders.port)\n      .option('outfileName', builders.outfileName);\n  },\n  handler: (argv: YargsArgs) => init(argv),\n};\n\nasync function init(argv: YargsArgs): Promise<void> {\n  console.log();\n  const newArgs = await initHandler(argv);\n\n  await build({\n    ...newArgs,\n    manifest: false,\n    eval: true,\n  });\n\n  await updateManifestShasum();\n\n  console.log('\\nSnap project successfully initiated!');\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/init/index.ts"],"names":[],"mappings":";;;;AACA,8DAAsC;AAEtC,wDAA8C;AAC9C,+CAAkE;AAClE,2CAAiD;AAsBjD;;;;;;GAMG;AACH,KAAK,UAAU,IAAI,CAAC,IAAe;IACjC,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,MAAM,OAAO,GAAG,MAAM,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC;IAExC,MAAM,IAAA,oBAAK,EAAC;QACV,GAAG,OAAO;QACV,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IAEH,MAAM,IAAA,kCAAoB,GAAE,CAAC;IAE7B,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AACxD,CAAC;AAxCD,iBAAS;IACP,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC;IACtB,IAAI,EAAE,yBAAyB;IAC/B,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI;aACD,MAAM,CAAC,KAAK,EAAE,kBAAQ,CAAC,GAAG,CAAC;aAC3B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,aAAa,EAAE,kBAAQ,CAAC,WAAW,CAAC;aAC3C,MAAM,CAAC,UAAU,EAAE,kBAAQ,CAAC,QAAQ,CAAC;aACrC,UAAU,CACT,CAAC,CAAC,SAAoB,EAAE,EAAE;YACxB,IAAA,8BAAkB,EAAC,SAAS,CAAC,CAAC;QAChC,CAAC,CAAQ,EACT,IAAI,CACL,CAAC;IACN,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;CACzC,CAAC","sourcesContent":["import yargs, { Arguments } from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { build } from '../build/buildHandler';\nimport { initHandler, updateManifestShasum } from './initHandler';\nimport { correctDefaultArgs } from './initUtils';\n\nexport = {\n  command: ['init', 'i'],\n  desc: 'Initialize Snap package',\n  builder: (yarg: yargs.Argv) => {\n    yarg\n      .option('src', builders.src)\n      .option('dist', builders.dist)\n      .option('port', builders.port)\n      .option('outfileName', builders.outfileName)\n      .option('template', builders.template)\n      .middleware(\n        ((yargsArgv: Arguments) => {\n          correctDefaultArgs(yargsArgv);\n        }) as any,\n        true,\n      );\n  },\n  handler: (argv: YargsArgs) => init(argv),\n};\n\n/**\n * The main entrypoint for the init command. This calls the init handler to\n * initialize the snap package, builds the snap, and then updates the manifest\n * with the shasum of the built snap.\n *\n * @param argv - The Yargs arguments object.\n */\nasync function init(argv: YargsArgs): Promise<void> {\n  console.log();\n  const newArgs = await initHandler(argv);\n\n  await build({\n    ...newArgs,\n    manifest: false,\n    eval: true,\n  });\n\n  await updateManifestShasum();\n\n  console.log('\\nSnap project successfully initiated!');\n}\n"]}

package/dist/cmds/init/init-template.json

@@ -1,4 +1,8 @@
 {
     "html": "<!doctype html>\n<html>\n  <head>\n    <title>Hello, Snaps!</title>\n    <link rel=\"icon\" type=\"image/svg\" href=\"./images/icon.svg\"/>\n  </head>\n\n  <body>\n    <h1>Hello, Snaps!</h1>\n    <details>\n      <summary>Instructions</summary>\n      <ul>\n        <li>First, click \"Connect\". Then, try out the other buttons!</li>\n        <li>Please note that:</li>\n        <ul>\n          <li>\n            The <code>snap.manifest.json</code> and <code>package.json</code> must be located in the server root directory..\n          </li>\n          <li>\n            The Snap bundle must be hosted at the location specified by the <code>location</code> field of <code>snap.manifest.json</code>.\n          </li>\n        </ul>\n      </ul>\n    </details>\n    <br/>\n\n    <button class=\"connect\">Connect</button>\n    <button class=\"sendHello\">Send Hello</button>\n  </body>\n\n  <script>\n    const snapId = `local:${window.location.href}`;\n\n    const connectButton = document.querySelector('button.connect')\n    const sendButton = document.querySelector('button.sendHello')\n\n    connectButton.addEventListener('click', connect)\n    sendButton.addEventListener('click', send)\n\n    // here we get permissions to interact with and install the snap\n    async function connect () {\n      await ethereum.request({\n        method: 'wallet_enable',\n        params: [{\n          wallet_snap: { [snapId]: {} },\n        }]\n      })\n    }\n\n    // here we call the snap's \"hello\" method\n    async function send () {\n      try {\n        const response = await ethereum.request({\n          method: 'wallet_invokeSnap',\n          params: [snapId, {\n            method: 'hello'\n          }]\n        })\n      } catch (err) {\n        console.error(err)\n        alert('Problem happened: ' + err.message || err)\n      }\n    }\n  </script>\n</html>\n",
-    "source": "module.exports.onRpcRequest = async ({ origin, request }) => {\n  switch (request.method) {\n    case 'hello':\n      return wallet.request({\n        method: 'snap_confirm',\n        params: [\n          {\n            prompt: `Hello, ${origin}!`,\n            description:\n              'This custom confirmation is just for display purposes.',\n            textAreaContent:\n              'But you can edit the snap source code to make it do something, if you want to!',\n          },\n        ],\n      });\n    default:\n      throw new Error('Method not found.');\n  }\n};\n"
+    "source": "module.exports.onRpcRequest = async ({ origin, request }) => {\n  switch (request.method) {\n    case 'hello':\n      return wallet.request({\n        method: 'snap_confirm',\n        params: [\n          {\n            prompt: `Hello, ${origin}!`,\n            description:\n              'This custom confirmation is just for display purposes.',\n            textAreaContent:\n              'But you can edit the snap source code to make it do something, if you want to!',\n          },\n        ],\n      });\n    default:\n      throw new Error('Method not found.');\n  }\n};\n",
+    "typescriptHtml": "<!doctype html>\n<html>\n  </head>\n    <title>Hello, Snaps!</title>\n    <link rel=\"icon\" type=\"image/svg\" href=\"./images/icon.svg\"/>\n  </head>\n\n  <body>\n    <h1>Hello, Snaps!</h1>\n    <details>\n      <summary>Instructions</summary>\n      <ul>\n        <li>First, click \"Connect\". Then, try out the other buttons!</li>\n        <li>Please note that:</li>\n        <ul>\n          <li>\n            The <code>snap.manifest.json</code> and <code>package.json</code> must be located in the server root directory...\n          </li>\n          <li>\n            The Snap bundle must be hosted at the location specified by the <code>location</code> field of <code>snap.manifest.json</code>.\n          </li>\n        </ul>\n      </ul>\n    </details>\n    <br/>\n\n    <button class=\"connect\">Connect</button>\n    <button class=\"sendHello\">Send Hello</button>\n  </body>\n\n  <script>\n    const snapId = `local:${window.location.href}`;\n\n    const connectButton = document.querySelector('button.connect')\n    const sendButton = document.querySelector('button.sendHello')\n\n    connectButton.addEventListener('click', connect)\n    sendButton.addEventListener('click', send)\n\n    // here we get permissions to interact with and install the snap\n    async function connect () {\n      await ethereum.request({\n        method: 'wallet_enable',\n        params: [{\n          wallet_snap: { [snapId]: {} },\n        }]\n      })\n    }\n\n    // here we call the snap's \"hello\" method\n    async function send () {\n      try {\n        await ethereum.request({\n          method: 'wallet_invokeSnap',\n          params: [snapId, {\n            method: 'hello'\n          }]\n        })\n      } catch (err) {\n        console.error(err)\n        alert('Problem happened: ' + err.message || err)\n      }\n    }\n  </script>\n</html>\n",
+    "typescriptSource": "import { OnRpcRequestHandler } from '@metamask/snap-types';\n\nexport const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {\n  switch (request.method) {\n    case 'hello':\n      return wallet.request({\n        method: 'snap_confirm',\n        params: [\n          {\n            prompt: `Hello, ${origin}!`,\n            description:\n              'This custom confirmation is just for display purposes.',\n            textAreaContent:\n              'But you can edit the snap source code to make it do something, if you want to!',\n          },\n        ],\n      });\n    default:\n      throw new Error('Method not found.');\n  }\n};\n",
+    "typescriptConfig": "{\n  \"extends\": \"../../../../tsconfig.packages.json\",\n  \"compilerOptions\": {\n    \"typeRoots\": [\"../../../../node_modules/@types\"]\n  },\n  \"files\": [\"../../../types/global.d.ts\"],\n  \"include\": [\"src\"]\n}\n",
+    "icon": "<svg width=\"24\" height=\"25\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M17.037 0H6.975C2.605 0 0 2.617 0 6.987v10.05c0 4.37 2.605 6.975 6.975 6.975h10.05c4.37 0 6.975-2.605 6.975-6.976V6.988C24.012 2.617 21.407 0 17.037 0ZM11.49 17.757c0 .36-.18.684-.492.876a.975.975 0 0 1-.54.156 1.11 1.11 0 0 1-.469-.108l-4.202-2.1a1.811 1.811 0 0 1-.985-1.61v-3.973c0-.36.18-.685.493-.877a1.04 1.04 0 0 1 1.008-.048l4.202 2.101a1.8 1.8 0 0 1 .997 1.609v3.974h-.012Zm-.252-6.423L6.723 8.896a1.045 1.045 0 0 1-.528-.924c0-.384.204-.744.528-.924l4.515-2.438a1.631 1.631 0 0 1 1.524 0l4.515 2.438c.324.18.528.528.528.924s-.204.744-.528.924l-4.515 2.438c-.24.132-.504.192-.768.192a1.54 1.54 0 0 1-.756-.192Zm7.972 3.638c0 .684-.385 1.308-.997 1.608l-4.202 2.101c-.144.072-.3.108-.468.108a.975.975 0 0 1-.54-.156 1.017 1.017 0 0 1-.493-.876v-3.974c0-.684.384-1.309.997-1.609l4.202-2.101a1.04 1.04 0 0 1 1.008.048c.313.192.493.516.493.877v3.974Z\" fill=\"#24272A\"/></svg>"
 }

package/dist/cmds/init/initHandler.d.ts

@@ -1,4 +1,14 @@
 import { YargsArgs } from '../../types/yargs';
+/**
+ * Creates a new snap package, based on one of the provided templates. This
+ * creates all the necessary files, like `package.json`, `snap.config.js`, etc.
+ * to start developing a snap.
+ *
+ * @param argv - The Yargs arguments object.
+ * @returns The Yargs arguments augmented with the new `dist`, `outfileName` and
+ * `src` properties.
+ * @throws If initialization of the snap package failed.
+ */
 export declare function initHandler(argv: YargsArgs): Promise<{
     [x: string]: unknown;
     sourceMaps: boolean;
@@ -9,6 +19,7 @@ export declare function initHandler(argv: YargsArgs): Promise<{
     src: string;
     eval: boolean;
     outfileName: string;
+    serve: boolean;
     _?: (string | number)[] | undefined;
     $0?: string | undefined;
 }>;

package/dist/cmds/init/initHandler.js

@@ -12,9 +12,19 @@ const utils_1 = require("../../utils");
 const manifestHandler_1 = require("../manifest/manifestHandler");
 const init_template_json_1 = __importDefault(require("./init-template.json"));
 const initUtils_1 = require("./initUtils");
+/**
+ * Creates a new snap package, based on one of the provided templates. This
+ * creates all the necessary files, like `package.json`, `snap.config.js`, etc.
+ * to start developing a snap.
+ *
+ * @param argv - The Yargs arguments object.
+ * @returns The Yargs arguments augmented with the new `dist`, `outfileName` and
+ * `src` properties.
+ * @throws If initialization of the snap package failed.
+ */
 async function initHandler(argv) {
     console.log(`MetaMask Snaps: Initialize\n`);
-    const packageJson = await (0, initUtils_1.asyncPackageInit)();
+    const packageJson = await (0, initUtils_1.asyncPackageInit)(argv);
     await (0, initUtils_1.prepareWorkingDirectory)();
     console.log(`\nInit: Building '${snap_controllers_1.NpmSnapFileNames.Manifest}'...\n`);
     const [snapManifest, _newArgs] = await (0, initUtils_1.buildSnapManifest)(argv, packageJson);
@@ -24,6 +34,7 @@ async function initHandler(argv) {
         sorted[key] = _newArgs[key];
         return sorted;
     }, {});
+    const isTypeScript = (0, initUtils_1.isTemplateTypescript)(argv.template);
     try {
         await fs_1.promises.writeFile(snap_controllers_1.NpmSnapFileNames.Manifest, `${JSON.stringify(snapManifest, null, 2)}\n`);
     }
@@ -38,7 +49,7 @@ async function initHandler(argv) {
         if (path_1.default.basename(src) !== src) {
             await (0, mkdirp_1.default)(path_1.default.dirname(src));
         }
-        await fs_1.promises.writeFile(src, init_template_json_1.default.source);
+        await fs_1.promises.writeFile(src, isTypeScript ? init_template_json_1.default.typescriptSource : init_template_json_1.default.source);
         console.log(`Init: Created '${src}'.`);
     }
     catch (err) {
@@ -47,13 +58,24 @@ async function initHandler(argv) {
     }
     // Write index.html
     try {
-        await fs_1.promises.writeFile('index.html', init_template_json_1.default.html);
+        await fs_1.promises.writeFile('index.html', isTypeScript ? init_template_json_1.default.typescriptHtml : init_template_json_1.default.html);
         console.log(`Init: Created 'index.html'.`);
     }
     catch (err) {
         (0, utils_1.logError)(`Init Error: Failed to write 'index.html'.`, err);
         throw err;
     }
+    // Write tsconfig.json
+    if (isTypeScript) {
+        try {
+            await fs_1.promises.writeFile('tsconfig.json', init_template_json_1.default.typescriptConfig);
+            console.log(`Init: Created 'tsconfig.json'.`);
+        }
+        catch (err) {
+            (0, utils_1.logError)(`Init Error: Failed to write 'tsconfig.json'.`, err);
+            throw err;
+        }
+    }
     // Write config file
     try {
         const defaultConfig = {
@@ -68,6 +90,19 @@ async function initHandler(argv) {
         (0, utils_1.logError)(`Init Error: Failed to write '${utils_1.CONFIG_FILE}'.`, err);
         throw err;
     }
+    // Write icon
+    const iconPath = 'images/icon.svg';
+    try {
+        if (path_1.default.basename(iconPath) !== iconPath) {
+            await (0, mkdirp_1.default)(path_1.default.dirname(iconPath));
+        }
+        await fs_1.promises.writeFile(iconPath, init_template_json_1.default.icon);
+        console.log(`Init: Created '${iconPath}'.`);
+    }
+    catch (err) {
+        (0, utils_1.logError)(`Init Error: Failed to write '${iconPath}'.`, err);
+        throw err;
+    }
     (0, utils_1.closePrompt)();
     return { ...argv, ...newArgs };
 }

package/dist/cmds/init/initHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"initHandler.js","sourceRoot":"","sources":["../../../src/cmds/init/initHandler.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAoC;AACpC,gDAA6B;AAC7B,iEAIoC;AACpC,oDAA4B;AAE5B,uCAMqB;AACrB,iEAAkE;AAClE,8EAA4C;AAC5C,2CAIqB;AAEd,KAAK,UAAU,WAAW,CAAC,IAAe;IAC/C,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;IAE5C,MAAM,WAAW,GAAG,MAAM,IAAA,4BAAgB,GAAE,CAAC;IAE7C,MAAM,IAAA,mCAAuB,GAAE,CAAC;IAEhC,OAAO,CAAC,GAAG,CAAC,qBAAqB,mCAAgB,CAAC,QAAQ,QAAQ,CAAC,CAAC;IAEpE,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,MAAM,IAAA,6BAAiB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SAClC,IAAI,EAAE;SACN,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACtB,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAA4B,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAe,CAAC,CAAC;IAEtB,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAChB,mCAAgB,CAAC,QAAQ,EACzB,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAC7C,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EACN,gCAAgC,mCAAgB,CAAC,QAAQ,IAAI,EAC7D,GAAG,CACJ,CAAC;QACF,MAAM,GAAG,CAAC;KACX;IAED,OAAO,CAAC,GAAG,CAAC,oBAAoB,mCAAgB,CAAC,QAAQ,IAAI,CAAC,CAAC;IAE/D,4BAA4B;IAC5B,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,IAAI;QACF,IAAI,cAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;YACnC,MAAM,IAAA,gBAAM,EAAC,cAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACtC;QAED,MAAM,aAAE,CAAC,SAAS,CAAC,GAAG,EAAE,4BAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;KACxC;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC;KACX;IAED,mBAAmB;IACnB,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAAC,YAAY,EAAE,4BAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;KAC5C;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,2CAA2C,EAAE,GAAG,CAAC,CAAC;QAC3D,MAAM,GAAG,CAAC;KACX;IAED,oBAAoB;IACpB,IAAI;QACF,MAAM,aAAa,GAAe;YAChC,UAAU,EAAE,OAAO;SACpB,CAAC;QACF,MAAM,iBAAiB,GAAG,oBAAoB,IAAI,CAAC,SAAS,CAC1D,aAAa,EACb,IAAI,EACJ,CAAC,CACF;KACA,CAAC;QACF,MAAM,aAAE,CAAC,SAAS,CAAC,mBAAW,EAAE,iBAAiB,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,mBAAW,eAAe,CAAC,CAAC;KACzD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,mBAAW,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/D,MAAM,GAAG,CAAC;KACX;IAED,IAAA,mBAAW,GAAE,CAAC;IACd,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC;AACjC,CAAC;AA5ED,kCA4EC;AAED;;;GAGG;AACI,KAAK,UAAU,oBAAoB;IACxC,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAA,oBAAY,EAClC,mCAAgB,CAAC,QAAQ,CAC1B,CAAiB,CAAC;IAEnB,MAAM,cAAc,GAAG,MAAM,aAAE,CAAC,QAAQ,CACtC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EACrC,MAAM,CACP,CAAC;IAEF,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,IAAA,sCAAmB,EAAC,cAAc,CAAC,CAAC;IAC7D,MAAM,aAAE,CAAC,SAAS,CAChB,mCAAgB,CAAC,QAAQ,EACzB,IAAI,CAAC,SAAS,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CACvD,CAAC;AACJ,CAAC;AAfD,oDAeC","sourcesContent":["import { promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport {\n  getSnapSourceShasum,\n  NpmSnapFileNames,\n  SnapManifest,\n} from '@metamask/snap-controllers';\nimport mkdirp from 'mkdirp';\nimport { YargsArgs } from '../../types/yargs';\nimport {\n  closePrompt,\n  CONFIG_FILE,\n  logError,\n  readJsonFile,\n  SnapConfig,\n} from '../../utils';\nimport { getWritableManifest } from '../manifest/manifestHandler';\nimport template from './init-template.json';\nimport {\n  asyncPackageInit,\n  buildSnapManifest,\n  prepareWorkingDirectory,\n} from './initUtils';\n\nexport async function initHandler(argv: YargsArgs) {\n  console.log(`MetaMask Snaps: Initialize\\n`);\n\n  const packageJson = await asyncPackageInit();\n\n  await prepareWorkingDirectory();\n\n  console.log(`\\nInit: Building '${NpmSnapFileNames.Manifest}'...\\n`);\n\n  const [snapManifest, _newArgs] = await buildSnapManifest(argv, packageJson);\n\n  const newArgs = Object.keys(_newArgs)\n    .sort()\n    .reduce((sorted, key) => {\n      sorted[key] = _newArgs[key as keyof typeof _newArgs];\n      return sorted;\n    }, {} as YargsArgs);\n\n  try {\n    await fs.writeFile(\n      NpmSnapFileNames.Manifest,\n      `${JSON.stringify(snapManifest, null, 2)}\\n`,\n    );\n  } catch (err) {\n    logError(\n      `Init Error: Failed to write '${NpmSnapFileNames.Manifest}'.`,\n      err,\n    );\n    throw err;\n  }\n\n  console.log(`\\nInit: Created '${NpmSnapFileNames.Manifest}'.`);\n\n  // Write main .js entry file\n  const { src } = newArgs;\n  try {\n    if (pathUtils.basename(src) !== src) {\n      await mkdirp(pathUtils.dirname(src));\n    }\n\n    await fs.writeFile(src, template.source);\n    console.log(`Init: Created '${src}'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${src}'.`, err);\n    throw err;\n  }\n\n  // Write index.html\n  try {\n    await fs.writeFile('index.html', template.html);\n    console.log(`Init: Created 'index.html'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write 'index.html'.`, err);\n    throw err;\n  }\n\n  // Write config file\n  try {\n    const defaultConfig: SnapConfig = {\n      cliOptions: newArgs,\n    };\n    const defaultConfigFile = `module.exports = ${JSON.stringify(\n      defaultConfig,\n      null,\n      2,\n    )}\n    `;\n    await fs.writeFile(CONFIG_FILE, defaultConfigFile);\n    console.log(`Init: Wrote '${CONFIG_FILE}' config file`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${CONFIG_FILE}'.`, err);\n    throw err;\n  }\n\n  closePrompt();\n  return { ...argv, ...newArgs };\n}\n\n/**\n * This updates the Snap shasum value of the manifest after building the Snap\n * during the init command.\n */\nexport async function updateManifestShasum() {\n  const manifest = (await readJsonFile(\n    NpmSnapFileNames.Manifest,\n  )) as SnapManifest;\n\n  const bundleContents = await fs.readFile(\n    manifest.source.location.npm.filePath,\n    'utf8',\n  );\n\n  manifest.source.shasum = getSnapSourceShasum(bundleContents);\n  await fs.writeFile(\n    NpmSnapFileNames.Manifest,\n    JSON.stringify(getWritableManifest(manifest), null, 2),\n  );\n}\n"]}
+{"version":3,"file":"initHandler.js","sourceRoot":"","sources":["../../../src/cmds/init/initHandler.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAoC;AACpC,gDAA6B;AAC7B,iEAIoC;AACpC,oDAA4B;AAE5B,uCAMqB;AACrB,iEAAkE;AAElE,8EAA4C;AAC5C,2CAKqB;AAErB;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAAC,IAAe;IAC/C,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;IAE5C,MAAM,WAAW,GAAG,MAAM,IAAA,4BAAgB,EAAC,IAAI,CAAC,CAAC;IAEjD,MAAM,IAAA,mCAAuB,GAAE,CAAC;IAEhC,OAAO,CAAC,GAAG,CAAC,qBAAqB,mCAAgB,CAAC,QAAQ,QAAQ,CAAC,CAAC;IAEpE,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,MAAM,IAAA,6BAAiB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAE5E,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SAClC,IAAI,EAAE;SACN,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACtB,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAA4B,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAe,CAAC,CAAC;IAEtB,MAAM,YAAY,GAAG,IAAA,gCAAoB,EAAC,IAAI,CAAC,QAAwB,CAAC,CAAC;IACzE,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAChB,mCAAgB,CAAC,QAAQ,EACzB,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAC7C,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EACN,gCAAgC,mCAAgB,CAAC,QAAQ,IAAI,EAC7D,GAAG,CACJ,CAAC;QACF,MAAM,GAAG,CAAC;KACX;IAED,OAAO,CAAC,GAAG,CAAC,oBAAoB,mCAAgB,CAAC,QAAQ,IAAI,CAAC,CAAC;IAE/D,4BAA4B;IAC5B,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAExB,IAAI;QACF,IAAI,cAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;YACnC,MAAM,IAAA,gBAAM,EAAC,cAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACtC;QAED,MAAM,aAAE,CAAC,SAAS,CAChB,GAAG,EACH,YAAY,CAAC,CAAC,CAAC,4BAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,4BAAQ,CAAC,MAAM,CAC3D,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;KACxC;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC;KACX;IAED,mBAAmB;IACnB,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAChB,YAAY,EACZ,YAAY,CAAC,CAAC,CAAC,4BAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,4BAAQ,CAAC,IAAI,CACvD,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;KAC5C;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,2CAA2C,EAAE,GAAG,CAAC,CAAC;QAC3D,MAAM,GAAG,CAAC;KACX;IAED,sBAAsB;IACtB,IAAI,YAAY,EAAE;QAChB,IAAI;YACF,MAAM,aAAE,CAAC,SAAS,CAAC,eAAe,EAAE,4BAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC/D,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;SAC/C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAA,gBAAQ,EAAC,8CAA8C,EAAE,GAAG,CAAC,CAAC;YAC9D,MAAM,GAAG,CAAC;SACX;KACF;IAED,oBAAoB;IACpB,IAAI;QACF,MAAM,aAAa,GAAe;YAChC,UAAU,EAAE,OAAO;SACpB,CAAC;QACF,MAAM,iBAAiB,GAAG,oBAAoB,IAAI,CAAC,SAAS,CAC1D,aAAa,EACb,IAAI,EACJ,CAAC,CACF;KACA,CAAC;QACF,MAAM,aAAE,CAAC,SAAS,CAAC,mBAAW,EAAE,iBAAiB,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,mBAAW,eAAe,CAAC,CAAC;KACzD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,mBAAW,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/D,MAAM,GAAG,CAAC;KACX;IAED,aAAa;IACb,MAAM,QAAQ,GAAG,iBAAiB,CAAC;IACnC,IAAI;QACF,IAAI,cAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,QAAQ,EAAE;YAC7C,MAAM,IAAA,gBAAM,EAAC,cAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,aAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,4BAAQ,CAAC,IAAI,CAAC,CAAC;QAE5C,OAAO,CAAC,GAAG,CAAC,kBAAkB,QAAQ,IAAI,CAAC,CAAC;KAC7C;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,gCAAgC,QAAQ,IAAI,EAAE,GAAG,CAAC,CAAC;QAC5D,MAAM,GAAG,CAAC;KACX;IAED,IAAA,mBAAW,GAAE,CAAC;IACd,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC;AACjC,CAAC;AA/GD,kCA+GC;AAED;;;GAGG;AACI,KAAK,UAAU,oBAAoB;IACxC,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAA,oBAAY,EAClC,mCAAgB,CAAC,QAAQ,CAC1B,CAAiB,CAAC;IAEnB,MAAM,cAAc,GAAG,MAAM,aAAE,CAAC,QAAQ,CACtC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EACrC,MAAM,CACP,CAAC;IAEF,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,IAAA,sCAAmB,EAAC,cAAc,CAAC,CAAC;IAC7D,MAAM,aAAE,CAAC,SAAS,CAChB,mCAAgB,CAAC,QAAQ,EACzB,IAAI,CAAC,SAAS,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CACvD,CAAC;AACJ,CAAC;AAfD,oDAeC","sourcesContent":["import { promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport {\n  getSnapSourceShasum,\n  NpmSnapFileNames,\n  SnapManifest,\n} from '@metamask/snap-controllers';\nimport mkdirp from 'mkdirp';\nimport { YargsArgs } from '../../types/yargs';\nimport {\n  closePrompt,\n  CONFIG_FILE,\n  logError,\n  readJsonFile,\n  SnapConfig,\n} from '../../utils';\nimport { getWritableManifest } from '../manifest/manifestHandler';\nimport { TemplateType } from '../../builders';\nimport template from './init-template.json';\nimport {\n  asyncPackageInit,\n  buildSnapManifest,\n  isTemplateTypescript,\n  prepareWorkingDirectory,\n} from './initUtils';\n\n/**\n * Creates a new snap package, based on one of the provided templates. This\n * creates all the necessary files, like `package.json`, `snap.config.js`, etc.\n * to start developing a snap.\n *\n * @param argv - The Yargs arguments object.\n * @returns The Yargs arguments augmented with the new `dist`, `outfileName` and\n * `src` properties.\n * @throws If initialization of the snap package failed.\n */\nexport async function initHandler(argv: YargsArgs) {\n  console.log(`MetaMask Snaps: Initialize\\n`);\n\n  const packageJson = await asyncPackageInit(argv);\n\n  await prepareWorkingDirectory();\n\n  console.log(`\\nInit: Building '${NpmSnapFileNames.Manifest}'...\\n`);\n\n  const [snapManifest, _newArgs] = await buildSnapManifest(argv, packageJson);\n\n  const newArgs = Object.keys(_newArgs)\n    .sort()\n    .reduce((sorted, key) => {\n      sorted[key] = _newArgs[key as keyof typeof _newArgs];\n      return sorted;\n    }, {} as YargsArgs);\n\n  const isTypeScript = isTemplateTypescript(argv.template as TemplateType);\n  try {\n    await fs.writeFile(\n      NpmSnapFileNames.Manifest,\n      `${JSON.stringify(snapManifest, null, 2)}\\n`,\n    );\n  } catch (err) {\n    logError(\n      `Init Error: Failed to write '${NpmSnapFileNames.Manifest}'.`,\n      err,\n    );\n    throw err;\n  }\n\n  console.log(`\\nInit: Created '${NpmSnapFileNames.Manifest}'.`);\n\n  // Write main .js entry file\n  const { src } = newArgs;\n\n  try {\n    if (pathUtils.basename(src) !== src) {\n      await mkdirp(pathUtils.dirname(src));\n    }\n\n    await fs.writeFile(\n      src,\n      isTypeScript ? template.typescriptSource : template.source,\n    );\n\n    console.log(`Init: Created '${src}'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${src}'.`, err);\n    throw err;\n  }\n\n  // Write index.html\n  try {\n    await fs.writeFile(\n      'index.html',\n      isTypeScript ? template.typescriptHtml : template.html,\n    );\n\n    console.log(`Init: Created 'index.html'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write 'index.html'.`, err);\n    throw err;\n  }\n\n  // Write tsconfig.json\n  if (isTypeScript) {\n    try {\n      await fs.writeFile('tsconfig.json', template.typescriptConfig);\n      console.log(`Init: Created 'tsconfig.json'.`);\n    } catch (err) {\n      logError(`Init Error: Failed to write 'tsconfig.json'.`, err);\n      throw err;\n    }\n  }\n\n  // Write config file\n  try {\n    const defaultConfig: SnapConfig = {\n      cliOptions: newArgs,\n    };\n    const defaultConfigFile = `module.exports = ${JSON.stringify(\n      defaultConfig,\n      null,\n      2,\n    )}\n    `;\n    await fs.writeFile(CONFIG_FILE, defaultConfigFile);\n    console.log(`Init: Wrote '${CONFIG_FILE}' config file`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${CONFIG_FILE}'.`, err);\n    throw err;\n  }\n\n  // Write icon\n  const iconPath = 'images/icon.svg';\n  try {\n    if (pathUtils.basename(iconPath) !== iconPath) {\n      await mkdirp(pathUtils.dirname(iconPath));\n    }\n    await fs.writeFile(iconPath, template.icon);\n\n    console.log(`Init: Created '${iconPath}'.`);\n  } catch (err) {\n    logError(`Init Error: Failed to write '${iconPath}'.`, err);\n    throw err;\n  }\n\n  closePrompt();\n  return { ...argv, ...newArgs };\n}\n\n/**\n * This updates the Snap shasum value of the manifest after building the Snap\n * during the init command.\n */\nexport async function updateManifestShasum() {\n  const manifest = (await readJsonFile(\n    NpmSnapFileNames.Manifest,\n  )) as SnapManifest;\n\n  const bundleContents = await fs.readFile(\n    manifest.source.location.npm.filePath,\n    'utf8',\n  );\n\n  manifest.source.shasum = getSnapSourceShasum(bundleContents);\n  await fs.writeFile(\n    NpmSnapFileNames.Manifest,\n    JSON.stringify(getWritableManifest(manifest), null, 2),\n  );\n}\n"]}

package/dist/cmds/init/initUtils.d.ts

@@ -1,21 +1,23 @@
 import { NpmSnapPackageJson, SnapManifest } from '@metamask/snap-controllers/dist/snaps';
+import { Arguments } from 'yargs';
 import { YargsArgs } from '../../types/yargs';
+import { TemplateType } from '../../builders';
 /**
  * Initializes a `package.json` file for a Snap project. Will attempt to read
  * and parse the existing file if it already exists, otherwise will intialize
  * a brand new one.
  *
+ * @param argv - Yargs arguments object.
  * @returns The contents of the `package.json` file.
  */
-export declare function asyncPackageInit(): Promise<Readonly<NpmSnapPackageJson>>;
+export declare function asyncPackageInit(argv: YargsArgs): Promise<Readonly<NpmSnapPackageJson>>;
 /**
  * Interactively constructs a Snap manifest file by prompting the user.
  *
  * @param argv - The `yargs` `argv` object.
  * @param packageJson - The `package.json` object.
- * @param shasum - The shasum of the Snap source file.
- * @returns A tuple of the resulting Snap manifest object and a new `argv` object
- * with properties to match the manifest.
+ * @returns A tuple of the resulting Snap manifest object and a new `argv`
+ * object with properties to match the manifest.
  */
 export declare function buildSnapManifest(argv: YargsArgs, packageJson: NpmSnapPackageJson): Promise<[SnapManifest, {
     dist: string;
@@ -27,3 +29,18 @@ export declare function buildSnapManifest(argv: YargsArgs, packageJson: NpmSnapP
  * by the initialization process, and asks the user whether to continue if so.
  */
 export declare function prepareWorkingDirectory(): Promise<void>;
+/**
+ * In case when TypeScript version is used, default source file
+ * will be updated if previous was not correct.
+ *
+ * @param yargsArgv - The Yargs arguments object.
+ * @returns Modified Yargs arguments object.
+ */
+export declare function correctDefaultArgs(yargsArgv: Arguments): Arguments;
+/**
+ * Check if template argument is TemplateType.TypeScript.
+ *
+ * @param templateType - TemplateType value of the template argument passed from CLI.
+ * @returns True or false.
+ */
+export declare function isTemplateTypescript(templateType: TemplateType): boolean;

package/dist/cmds/init/initUtils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareWorkingDirectory = exports.buildSnapManifest = exports.asyncPackageInit = void 0;
+exports.isTemplateTypescript = exports.correctDefaultArgs = exports.prepareWorkingDirectory = exports.buildSnapManifest = exports.asyncPackageInit = void 0;
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const snaps_1 = require("@metamask/snap-controllers/dist/snaps");
@@ -11,6 +11,7 @@ const init_package_json_1 = __importDefault(require("init-package-json"));
 const mkdirp_1 = __importDefault(require("mkdirp"));
 const slash_1 = __importDefault(require("slash"));
 const utils_1 = require("../../utils");
+const builders_1 = require("../../builders");
 /**
  * This is a placeholder shasum that will be replaced at the end of the init command.
  */
@@ -21,9 +22,10 @@ const NPM_PUBLIC_REGISTRY_URL = 'https://registry.npmjs.org';
  * and parse the existing file if it already exists, otherwise will intialize
  * a brand new one.
  *
+ * @param argv - Yargs arguments object.
  * @returns The contents of the `package.json` file.
  */
-async function asyncPackageInit() {
+async function asyncPackageInit(argv) {
     if ((0, fs_1.existsSync)(snaps_1.NpmSnapFileNames.PackageJson)) {
         console.log(`Init: Attempting to use existing '${snaps_1.NpmSnapFileNames.PackageJson}'...`);
         try {
@@ -44,7 +46,9 @@ async function asyncPackageInit() {
     }
     // Run 'npm init'
     return new Promise((resolve, reject) => {
-        (0, init_package_json_1.default)(process.cwd(), '', {}, (err, data) => {
+        (0, init_package_json_1.default)(process.cwd(), '', {
+            'init.main': argv.src,
+        }, (err, data) => {
             if (err) {
                 reject(err);
             }
@@ -57,10 +61,22 @@ async function asyncPackageInit() {
 exports.asyncPackageInit = asyncPackageInit;
 const YES = 'yes';
 const YES_VALUES = new Set([YES, 'y']);
+/**
+ * Checks if user input provided over a prompt is "yes", i.e., if the value is
+ * truthy and in the {@link YES_VALUES} set.
+ *
+ * @param userInput - The user input to check.
+ * @returns `true` if the user input is "yes", `false` otherwise.
+ */
 function isYes(userInput) {
     return userInput && YES_VALUES.has(userInput.toLowerCase());
 }
 const DEFAULT_PERMISSION_KEY = 'snap_confirm';
+/**
+ * Get the default permissions to write to the snap manifest.
+ *
+ * @returns An object containing the default permissions.
+ */
 const getDefaultPermissions = () => {
     return { [DEFAULT_PERMISSION_KEY]: {} };
 };
@@ -69,9 +85,8 @@ const getDefaultPermissions = () => {
  *
  * @param argv - The `yargs` `argv` object.
  * @param packageJson - The `package.json` object.
- * @param shasum - The shasum of the Snap source file.
- * @returns A tuple of the resulting Snap manifest object and a new `argv` object
- * with properties to match the manifest.
+ * @returns A tuple of the resulting Snap manifest object and a new `argv`
+ * object with properties to match the manifest.
  */
 async function buildSnapManifest(argv, packageJson) {
     const { outfileName } = argv;
@@ -176,6 +191,13 @@ async function buildSnapManifest(argv, packageJson) {
         }
     }
     return endSnapManifest();
+    /**
+     * Get the final snap manifest object and return it, along with the dist and
+     * file names.
+     *
+     * @returns A tuple of the resulting snap manifest object and an object
+     * containing the dist and file names.
+     */
     function endSnapManifest() {
         const manifest = {
             version: packageJson.version,
@@ -191,7 +213,7 @@ async function buildSnapManifest(argv, packageJson) {
                         filePath: (0, slash_1.default)(path_1.default.join(dist, outfileName)),
                         packageName: packageJson.name,
                         registry: NPM_PUBLIC_REGISTRY_URL,
-                        iconPath: 'icon.svg',
+                        iconPath: 'images/icon.svg',
                     },
                 },
             },
@@ -241,4 +263,30 @@ async function prepareWorkingDirectory() {
     }
 }
 exports.prepareWorkingDirectory = prepareWorkingDirectory;
+/**
+ * In case when TypeScript version is used, default source file
+ * will be updated if previous was not correct.
+ *
+ * @param yargsArgv - The Yargs arguments object.
+ * @returns Modified Yargs arguments object.
+ */
+function correctDefaultArgs(yargsArgv) {
+    if (yargsArgv.template === builders_1.TemplateType.TypeScript &&
+        yargsArgv.src === 'src/index.js') {
+        yargsArgv.src = 'src/index.ts';
+        yargsArgv.s = 'src/index.ts';
+    }
+    return yargsArgv;
+}
+exports.correctDefaultArgs = correctDefaultArgs;
+/**
+ * Check if template argument is TemplateType.TypeScript.
+ *
+ * @param templateType - TemplateType value of the template argument passed from CLI.
+ * @returns True or false.
+ */
+function isTemplateTypescript(templateType) {
+    return templateType === builders_1.TemplateType.TypeScript;
+}
+exports.isTemplateTypescript = isTemplateTypescript;
 //# sourceMappingURL=initUtils.js.map

package/dist/cmds/init/initUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"initUtils.js","sourceRoot":"","sources":["../../../src/cmds/init/initUtils.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAgD;AAChD,gDAA6B;AAC7B,iEAM+C;AAC/C,0EAAgD;AAChD,oDAA4B;AAC5B,kDAA0B;AAE1B,uCAQqB;AAErB;;GAEG;AACH,MAAM,kBAAkB,GAAG,8CAA8C,CAAC;AAE1E,MAAM,uBAAuB,GAAG,4BAA4B,CAAC;AAE7D;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB;IAGpC,IAAI,IAAA,eAAU,EAAC,wBAAgB,CAAC,WAAW,CAAC,EAAE;QAC5C,OAAO,CAAC,GAAG,CACT,qCAAqC,wBAAgB,CAAC,WAAW,MAAM,CACxE,CAAC;QAEF,IAAI;YACF,MAAM,WAAW,GAAG,MAAM,IAAA,oBAAY,EAAC,wBAAgB,CAAC,WAAW,CAAC,CAAC;YACrE,IAAA,4BAAoB,EAAC,wBAAgB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAEhE,OAAO,CAAC,GAAG,CACT,8BAA8B,wBAAgB,CAAC,WAAW,IAAI,CAC/D,CAAC;YACF,OAAO,WAAiC,CAAC;SAC1C;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,gBAAQ,EACN,gCAAgC,wBAAgB,CAAC,WAAW,sEAAsE,EAClI,KAAK,CACN,CAAC;YACF,MAAM,KAAK,CAAC;SACb;KACF;IAED,qDAAqD;IACrD,IAAI,IAAA,eAAU,EAAC,WAAW,CAAC,EAAE;QAC3B,IAAA,gBAAQ,EACN,gDAAgD,wBAAgB,CAAC,WAAW,0CAA0C,CACvH,CAAC;QACF,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,iBAAiB;IACjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAA,2BAAe,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACnD,IAAI,GAAG,EAAE;gBACP,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;iBAAM;gBACL,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AA3CD,4CA2CC;AAED,MAAM,GAAG,GAAG,KAAK,CAAC;AAClB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAEvC,SAAS,KAAK,CAAC,SAA6B;IAC1C,OAAO,SAAS,IAAI,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAC9C,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACjC,OAAO,EAAE,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC;AAC1C,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAe,EACf,WAA+B;IAE/B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAC7B,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACpB,IAAI,kBAAkB,GAA4B,qBAAqB,EAAE,CAAC;IAC1E,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;IAEtD,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,OAAO,YAAY,QAAQ,CAAC;KAC3C;IAED,IAAI;QACF,MAAM,SAAS,GAAG,MAAM,IAAA,cAAM,EAAC;YAC7B,QAAQ,EAAE,mCAAmC;YAC7C,YAAY,EAAE,GAAG;YACjB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE;YACpB,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;YACvC,IAAI;gBACF,MAAM,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;aACpB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAA,gBAAQ,EACN,+CAA+C,IAAI,6BAA6B,mBAAW,QAAQ,CACpG,CAAC;gBACF,MAAM,GAAG,CAAC;aACX;YACD,OAAO,eAAe,EAAE,CAAC;SAC1B;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,eAAe,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5C,MAAM,GAAG,CAAC;KACX;IAED,IAAI,mBAAmB,GAAG,IAAI,CAAC;IAC/B,OAAO,mBAAmB,EAAE;QAC1B,kDAAkD;QAClD,YAAY,GAAG,MAAM,IAAA,cAAM,EAAC;YAC1B,QAAQ,EAAE,qBAAqB;YAC/B,YAAY,EAAE,YAAY;SAC3B,CAAC,CAAC;QAEH,IACE,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,YAAY,CAAC,MAAM,IAAI,GAAG;YAC1B,2BAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,EACtC;YACA,mBAAmB,GAAG,KAAK,CAAC;SAC7B;aAAM;YACL,IAAA,gBAAQ,EACN,6LAA6L,CAC9L,CAAC;SACH;KACF;IAED,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAC9B,OAAO,kBAAkB,EAAE;QACzB,kDAAkD;QAClD,WAAW,GAAG,MAAM,IAAA,cAAM,EAAC;YACzB,QAAQ,EAAE,cAAc;YACxB,YAAY,EAAE,WAAW;SAC1B,CAAC,CAAC;QAEH,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,MAAM,IAAI,GAAG,EAAE;YACzD,kBAAkB,GAAG,KAAK,CAAC;SAC5B;aAAM;YACL,IAAA,gBAAQ,EACN,kFAAkF,CACnF,CAAC;SACH;KACF;IAED,IAAI,WAAW,GAAG,IAAI,CAAC;IACvB,OAAO,WAAW,EAAE;QAClB,kDAAkD;QAClD,IAAI,GAAG,MAAM,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3E,IAAI;YACF,IAAI,GAAG,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC;YAC5B,MAAM,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;YACnB,WAAW,GAAG,KAAK,CAAC;SACrB;QAAC,OAAO,SAAS,EAAE;YAClB,IAAA,gBAAQ,EACN,+BAA+B,IAAI,iDAAiD,EACpF,SAAS,CACV,CAAC;SACH;KACF;IAED,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAC9B,OAAO,kBAAkB,EAAE;QACzB,MAAM,gBAAgB,GAAG,MAAM,IAAA,cAAM,EAAC;YACpC,mDAAmD;YACnD,QAAQ,EAAE,yDAAyD;SACpE,CAAC,CAAC;QAEH,IACE,CAAC,gBAAgB;YACjB,gBAAgB,CAAC,IAAI,EAAE,KAAK,sBAAsB,EAClD;YACA,MAAM;SACP;QAED,IAAI;YACF,kBAAkB,GAAG,gBAAgB;iBAClC,KAAK,CAAC,GAAG,CAAC;iBACV,MAAM,CAAC,CAAC,cAAc,EAAE,UAAU,EAAE,EAAE;gBACrC,IACE,OAAO,UAAU,KAAK,QAAQ;oBAC9B,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,EACjC;oBACA,cAAc,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;iBACjC;qBAAM;oBACL,MAAM,IAAI,KAAK,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAC;iBACtD;gBACD,OAAO,cAAc,CAAC;YACxB,CAAC,EAAE,EAA6B,CAAC,CAAC;YAEpC,kBAAkB,GAAG,KAAK,CAAC;SAC5B;QAAC,OAAO,GAAG,EAAE;YACZ,IAAA,gBAAQ,EACN,wBAAwB,gBAAgB,+IAA+I,EACvL,GAAG,CACJ,CAAC;SACH;KACF;IAED,OAAO,eAAe,EAAE,CAAC;IAEzB,SAAS,eAAe;QAQtB,MAAM,QAAQ,GAAG;YACf,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,WAAW;YACX,YAAY;YACZ,UAAU,EAAE,WAAW,CAAC,UAAU;gBAChC,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,UAAU,CAAC;gBACnC,CAAC,CAAC,IAAI;YACR,MAAM,EAAE;gBACN,MAAM,EAAE,kBAAkB;gBAC1B,QAAQ,EAAE;oBACR,GAAG,EAAE;wBACH,QAAQ,EAAE,IAAA,eAAK,EAAC,cAAS,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;wBAClD,WAAW,EAAE,WAAW,CAAC,IAAI;wBAC7B,QAAQ,EAAE,uBAAuB;wBACjC,QAAQ,EAAE,UAAU;qBACZ;iBACX;aACF;YACD,kBAAkB;YAClB,eAAe,EAAE,KAAc;SAChC,CAAC;QAEF,IAAI;YACF,IAAA,4BAAoB,EAAC,wBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;SAC3D;QAAC,OAAO,KAAK,EAAE;YACd,0BAA0B;YAC1B,MAAM,IAAI,KAAK,CACb,wGAAwG,KAAK,CAAC,OAAO,EAAE,CACxH,CAAC;SACH;QAED,OAAO;YACL,QAAQ;YACR,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,CAAC,IAAI,IAAI,cAAc,EAAE;SAC/D,CAAC;IACJ,CAAC;AACH,CAAC;AA/KD,8CA+KC;AAED,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC;IAC9B,KAAK;IACL,YAAY;IACZ,mBAAW;IACX,MAAM;IACN,wBAAgB,CAAC,QAAQ;CAC1B,CAAC,CAAC;AAEH;;;GAGG;AACI,KAAK,UAAU,uBAAuB;IAC3C,MAAM,aAAa,GAAG,CAAC,MAAM,aAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACtE,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CACrC,CAAC;IAEF,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC5B,IAAA,kBAAU,EACR,0EAA0E,aAAa,CAAC,MAAM,CAC5F,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE;YACvB,OAAO,GAAG,OAAO,KAAK,WAAW,IAAI,CAAC;QACxC,CAAC,EACD,EAAE,CACH,EAAE,CACJ,CAAC;QAEF,MAAM,aAAa,GAAG,MAAM,IAAA,cAAM,EAAC;YACjC,QAAQ,EAAE,WAAW;YACrB,YAAY,EAAE,GAAG;SAClB,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,aAAa,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;QAE7D,IAAI,CAAC,cAAc,EAAE;YACnB,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC7C;KACF;AACH,CAAC;AA1BD,0DA0BC","sourcesContent":["import { existsSync, promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport {\n  NpmSnapFileNames,\n  NpmSnapPackageJson,\n  PROPOSED_NAME_REGEX,\n  SnapManifest,\n  validateSnapJsonFile,\n} from '@metamask/snap-controllers/dist/snaps';\nimport initPackageJson from 'init-package-json';\nimport mkdirp from 'mkdirp';\nimport slash from 'slash';\nimport { YargsArgs } from '../../types/yargs';\nimport {\n  CONFIG_FILE,\n  deepClone,\n  logError,\n  logWarning,\n  prompt,\n  readJsonFile,\n  trimPathString,\n} from '../../utils';\n\n/**\n * This is a placeholder shasum that will be replaced at the end of the init command.\n */\nconst PLACEHOLDER_SHASUM = '2QqUxo5joo4kKKr7yiCjdYsZOZcIFBnIBEdwU9Yx7+M=';\n\nconst NPM_PUBLIC_REGISTRY_URL = 'https://registry.npmjs.org';\n\n/**\n * Initializes a `package.json` file for a Snap project. Will attempt to read\n * and parse the existing file if it already exists, otherwise will intialize\n * a brand new one.\n *\n * @returns The contents of the `package.json` file.\n */\nexport async function asyncPackageInit(): Promise<\n  Readonly<NpmSnapPackageJson>\n> {\n  if (existsSync(NpmSnapFileNames.PackageJson)) {\n    console.log(\n      `Init: Attempting to use existing '${NpmSnapFileNames.PackageJson}'...`,\n    );\n\n    try {\n      const packageJson = await readJsonFile(NpmSnapFileNames.PackageJson);\n      validateSnapJsonFile(NpmSnapFileNames.PackageJson, packageJson);\n\n      console.log(\n        `Init: Successfully parsed '${NpmSnapFileNames.PackageJson}'!`,\n      );\n      return packageJson as NpmSnapPackageJson;\n    } catch (error) {\n      logError(\n        `Init Error: Could not parse '${NpmSnapFileNames.PackageJson}'. Please verify that the file is correctly formatted and try again.`,\n        error,\n      );\n      throw error;\n    }\n  }\n\n  // Exit if yarn.lock is found, or we'll be in trouble\n  if (existsSync('yarn.lock')) {\n    logError(\n      `Init Error: Found a 'yarn.lock' file but no '${NpmSnapFileNames.PackageJson}'. Please run 'yarn init' and try again.`,\n    );\n    throw new Error('Already existing yarn.lock file found');\n  }\n\n  // Run 'npm init'\n  return new Promise((resolve, reject) => {\n    initPackageJson(process.cwd(), '', {}, (err, data) => {\n      if (err) {\n        reject(err);\n      } else {\n        resolve(data);\n      }\n    });\n  });\n}\n\nconst YES = 'yes';\nconst YES_VALUES = new Set([YES, 'y']);\n\nfunction isYes(userInput: string | undefined) {\n  return userInput && YES_VALUES.has(userInput.toLowerCase());\n}\n\nconst DEFAULT_PERMISSION_KEY = 'snap_confirm';\nconst getDefaultPermissions = () => {\n  return { [DEFAULT_PERMISSION_KEY]: {} };\n};\n\n/**\n * Interactively constructs a Snap manifest file by prompting the user.\n *\n * @param argv - The `yargs` `argv` object.\n * @param packageJson - The `package.json` object.\n * @param shasum - The shasum of the Snap source file.\n * @returns A tuple of the resulting Snap manifest object and a new `argv` object\n * with properties to match the manifest.\n */\nexport async function buildSnapManifest(\n  argv: YargsArgs,\n  packageJson: NpmSnapPackageJson,\n): Promise<[SnapManifest, { dist: string; outfileName: string; src: string }]> {\n  const { outfileName } = argv;\n  let { dist } = argv;\n  let initialPermissions: Record<string, unknown> = getDefaultPermissions();\n  let { description, name: proposedName } = packageJson;\n\n  if (!description) {\n    description = `The ${proposedName} Snap.`;\n  }\n\n  try {\n    const userInput = await prompt({\n      question: `Use default Snap manifest values?`,\n      defaultValue: YES,\n      shouldClose: false,\n    });\n\n    if (isYes(userInput)) {\n      console.log('Using default values...');\n      try {\n        await mkdirp(dist);\n      } catch (err) {\n        logError(\n          `Init Error: Could not write default 'dist' '${dist}'. Maybe check your local ${CONFIG_FILE} file?`,\n        );\n        throw err;\n      }\n      return endSnapManifest();\n    }\n  } catch (err) {\n    logError(`Init Error: ${err.message}`, err);\n    throw err;\n  }\n\n  let invalidProposedName = true;\n  while (invalidProposedName) {\n    // eslint-disable-next-line require-atomic-updates\n    proposedName = await prompt({\n      question: `Proposed Snap name:`,\n      defaultValue: proposedName,\n    });\n\n    if (\n      proposedName.length > 0 &&\n      proposedName.length <= 214 &&\n      PROPOSED_NAME_REGEX.test(proposedName)\n    ) {\n      invalidProposedName = false;\n    } else {\n      logError(\n        `The proposed name must adhere to npm package naming conventions, except that capital letters are allowed. For details, see: https://docs.npmjs.com/cli/v6/configuring-npm/package-json#name`,\n      );\n    }\n  }\n\n  let invalidDescription = true;\n  while (invalidDescription) {\n    // eslint-disable-next-line require-atomic-updates\n    description = await prompt({\n      question: `Description:`,\n      defaultValue: description,\n    });\n\n    if (description.length === 0 || description.length <= 280) {\n      invalidDescription = false;\n    } else {\n      logError(\n        `The description must be a non-empty string less than or equal to 280 characters.`,\n      );\n    }\n  }\n\n  let invalidDist = true;\n  while (invalidDist) {\n    // eslint-disable-next-line require-atomic-updates\n    dist = await prompt({ question: `Output directory:`, defaultValue: dist });\n    try {\n      dist = trimPathString(dist);\n      await mkdirp(dist);\n      invalidDist = false;\n    } catch (distError) {\n      logError(\n        `Unable to create directory '${dist}'. Ensure that the path is valid and try again.`,\n        distError,\n      );\n    }\n  }\n\n  let invalidPermissions = true;\n  while (invalidPermissions) {\n    const inputPermissions = await prompt({\n      // We add the parenthetical default value ourselves\n      question: `Initial permissions: [perm1 perm2 ...] ([snap_confirm])`,\n    });\n\n    if (\n      !inputPermissions ||\n      inputPermissions.trim() === DEFAULT_PERMISSION_KEY\n    ) {\n      break;\n    }\n\n    try {\n      initialPermissions = inputPermissions\n        .split(' ')\n        .reduce((allPermissions, permission) => {\n          if (\n            typeof permission === 'string' &&\n            permission.match(/^[\\w\\d_:]+$/iu)\n          ) {\n            allPermissions[permission] = {};\n          } else {\n            throw new Error(`Invalid permission: ${permission}`);\n          }\n          return allPermissions;\n        }, {} as Record<string, unknown>);\n\n      invalidPermissions = false;\n    } catch (err) {\n      logError(\n        `Invalid permissions '${inputPermissions}'.\\nThe permissions must be specified as a space-separated list of strings with only characters, digits, underscores ('_'), and colons (':').`,\n        err,\n      );\n    }\n  }\n\n  return endSnapManifest();\n\n  function endSnapManifest(): [\n    SnapManifest,\n    {\n      dist: string;\n      outfileName: string;\n      src: string;\n    },\n  ] {\n    const manifest = {\n      version: packageJson.version,\n      description,\n      proposedName,\n      repository: packageJson.repository\n        ? deepClone(packageJson.repository)\n        : null,\n      source: {\n        shasum: PLACEHOLDER_SHASUM,\n        location: {\n          npm: {\n            filePath: slash(pathUtils.join(dist, outfileName)),\n            packageName: packageJson.name,\n            registry: NPM_PUBLIC_REGISTRY_URL,\n            iconPath: 'icon.svg',\n          } as const,\n        },\n      },\n      initialPermissions,\n      manifestVersion: '0.1' as const,\n    };\n\n    try {\n      validateSnapJsonFile(NpmSnapFileNames.Manifest, manifest);\n    } catch (error) {\n      /* istanbul ignore next */\n      throw new Error(\n        `Internal Error: Validation of constructed manifest failed. This is a bug, please report it. Reason:\\n${error.message}`,\n      );\n    }\n\n    return [\n      manifest,\n      { dist, outfileName, src: packageJson.main || 'src/index.js' },\n    ];\n  }\n}\n\nconst INIT_FILE_NAMES = new Set([\n  'src',\n  'index.html',\n  CONFIG_FILE,\n  'dist',\n  NpmSnapFileNames.Manifest,\n]);\n\n/**\n * Checks whether any files in the current working directory will be overwritten\n * by the initialization process, and asks the user whether to continue if so.\n */\nexport async function prepareWorkingDirectory(): Promise<void> {\n  const existingFiles = (await fs.readdir(process.cwd())).filter((item) =>\n    INIT_FILE_NAMES.has(item.toString()),\n  );\n\n  if (existingFiles.length > 0) {\n    logWarning(\n      `\\nInit Warning: Existing files and/or directories may be overwritten:\\n${existingFiles.reduce(\n        (message, currentFile) => {\n          return `${message}\\t${currentFile}\\n`;\n        },\n        '',\n      )}`,\n    );\n\n    const continueInput = await prompt({\n      question: `Continue?`,\n      defaultValue: YES,\n    });\n    const shouldContinue = continueInput && isYes(continueInput);\n\n    if (!shouldContinue) {\n      console.log(`Init: Exiting...`);\n      throw new Error('User refused to continue');\n    }\n  }\n}\n"]}
+{"version":3,"file":"initUtils.js","sourceRoot":"","sources":["../../../src/cmds/init/initUtils.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAgD;AAChD,gDAA6B;AAC7B,iEAM+C;AAC/C,0EAAgD;AAChD,oDAA4B;AAC5B,kDAA0B;AAG1B,uCAQqB;AACrB,6CAA8C;AAE9C;;GAEG;AACH,MAAM,kBAAkB,GAAG,8CAA8C,CAAC;AAE1E,MAAM,uBAAuB,GAAG,4BAA4B,CAAC;AAE7D;;;;;;;GAOG;AACI,KAAK,UAAU,gBAAgB,CACpC,IAAe;IAEf,IAAI,IAAA,eAAU,EAAC,wBAAgB,CAAC,WAAW,CAAC,EAAE;QAC5C,OAAO,CAAC,GAAG,CACT,qCAAqC,wBAAgB,CAAC,WAAW,MAAM,CACxE,CAAC;QAEF,IAAI;YACF,MAAM,WAAW,GAAG,MAAM,IAAA,oBAAY,EAAC,wBAAgB,CAAC,WAAW,CAAC,CAAC;YACrE,IAAA,4BAAoB,EAAC,wBAAgB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAEhE,OAAO,CAAC,GAAG,CACT,8BAA8B,wBAAgB,CAAC,WAAW,IAAI,CAC/D,CAAC;YACF,OAAO,WAAiC,CAAC;SAC1C;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,gBAAQ,EACN,gCAAgC,wBAAgB,CAAC,WAAW,sEAAsE,EAClI,KAAK,CACN,CAAC;YACF,MAAM,KAAK,CAAC;SACb;KACF;IAED,qDAAqD;IACrD,IAAI,IAAA,eAAU,EAAC,WAAW,CAAC,EAAE;QAC3B,IAAA,gBAAQ,EACN,gDAAgD,wBAAgB,CAAC,WAAW,0CAA0C,CACvH,CAAC;QACF,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,iBAAiB;IACjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAA,2BAAe,EACb,OAAO,CAAC,GAAG,EAAE,EACb,EAAE,EACF;YACE,WAAW,EAAE,IAAI,CAAC,GAAG;SACtB,EACD,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACZ,IAAI,GAAG,EAAE;gBACP,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;iBAAM;gBACL,OAAO,CAAC,IAAI,CAAC,CAAC;aACf;QACH,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAlDD,4CAkDC;AAED,MAAM,GAAG,GAAG,KAAK,CAAC;AAClB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAEvC;;;;;;GAMG;AACH,SAAS,KAAK,CAAC,SAA6B;IAC1C,OAAO,SAAS,IAAI,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAE9C;;;;GAIG;AACH,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACjC,OAAO,EAAE,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC;AAC1C,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAe,EACf,WAA+B;IAE/B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAC7B,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACpB,IAAI,kBAAkB,GAA4B,qBAAqB,EAAE,CAAC;IAC1E,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;IAEtD,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,OAAO,YAAY,QAAQ,CAAC;KAC3C;IAED,IAAI;QACF,MAAM,SAAS,GAAG,MAAM,IAAA,cAAM,EAAC;YAC7B,QAAQ,EAAE,mCAAmC;YAC7C,YAAY,EAAE,GAAG;YACjB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE;YACpB,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;YACvC,IAAI;gBACF,MAAM,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;aACpB;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAA,gBAAQ,EACN,+CAA+C,IAAI,6BAA6B,mBAAW,QAAQ,CACpG,CAAC;gBACF,MAAM,GAAG,CAAC;aACX;YACD,OAAO,eAAe,EAAE,CAAC;SAC1B;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,eAAe,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5C,MAAM,GAAG,CAAC;KACX;IAED,IAAI,mBAAmB,GAAG,IAAI,CAAC;IAC/B,OAAO,mBAAmB,EAAE;QAC1B,kDAAkD;QAClD,YAAY,GAAG,MAAM,IAAA,cAAM,EAAC;YAC1B,QAAQ,EAAE,qBAAqB;YAC/B,YAAY,EAAE,YAAY;SAC3B,CAAC,CAAC;QAEH,IACE,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,YAAY,CAAC,MAAM,IAAI,GAAG;YAC1B,2BAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,EACtC;YACA,mBAAmB,GAAG,KAAK,CAAC;SAC7B;aAAM;YACL,IAAA,gBAAQ,EACN,6LAA6L,CAC9L,CAAC;SACH;KACF;IAED,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAC9B,OAAO,kBAAkB,EAAE;QACzB,kDAAkD;QAClD,WAAW,GAAG,MAAM,IAAA,cAAM,EAAC;YACzB,QAAQ,EAAE,cAAc;YACxB,YAAY,EAAE,WAAW;SAC1B,CAAC,CAAC;QAEH,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,MAAM,IAAI,GAAG,EAAE;YACzD,kBAAkB,GAAG,KAAK,CAAC;SAC5B;aAAM;YACL,IAAA,gBAAQ,EACN,kFAAkF,CACnF,CAAC;SACH;KACF;IAED,IAAI,WAAW,GAAG,IAAI,CAAC;IACvB,OAAO,WAAW,EAAE;QAClB,kDAAkD;QAClD,IAAI,GAAG,MAAM,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3E,IAAI;YACF,IAAI,GAAG,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC;YAC5B,MAAM,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;YACnB,WAAW,GAAG,KAAK,CAAC;SACrB;QAAC,OAAO,SAAS,EAAE;YAClB,IAAA,gBAAQ,EACN,+BAA+B,IAAI,iDAAiD,EACpF,SAAS,CACV,CAAC;SACH;KACF;IAED,IAAI,kBAAkB,GAAG,IAAI,CAAC;IAC9B,OAAO,kBAAkB,EAAE;QACzB,MAAM,gBAAgB,GAAG,MAAM,IAAA,cAAM,EAAC;YACpC,mDAAmD;YACnD,QAAQ,EAAE,yDAAyD;SACpE,CAAC,CAAC;QAEH,IACE,CAAC,gBAAgB;YACjB,gBAAgB,CAAC,IAAI,EAAE,KAAK,sBAAsB,EAClD;YACA,MAAM;SACP;QAED,IAAI;YACF,kBAAkB,GAAG,gBAAgB;iBAClC,KAAK,CAAC,GAAG,CAAC;iBACV,MAAM,CAAC,CAAC,cAAc,EAAE,UAAU,EAAE,EAAE;gBACrC,IACE,OAAO,UAAU,KAAK,QAAQ;oBAC9B,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,EACjC;oBACA,cAAc,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;iBACjC;qBAAM;oBACL,MAAM,IAAI,KAAK,CAAC,uBAAuB,UAAU,EAAE,CAAC,CAAC;iBACtD;gBACD,OAAO,cAAc,CAAC;YACxB,CAAC,EAAE,EAA6B,CAAC,CAAC;YAEpC,kBAAkB,GAAG,KAAK,CAAC;SAC5B;QAAC,OAAO,GAAG,EAAE;YACZ,IAAA,gBAAQ,EACN,wBAAwB,gBAAgB,+IAA+I,EACvL,GAAG,CACJ,CAAC;SACH;KACF;IAED,OAAO,eAAe,EAAE,CAAC;IAEzB;;;;;;OAMG;IACH,SAAS,eAAe;QAQtB,MAAM,QAAQ,GAAG;YACf,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,WAAW;YACX,YAAY;YACZ,UAAU,EAAE,WAAW,CAAC,UAAU;gBAChC,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,UAAU,CAAC;gBACnC,CAAC,CAAC,IAAI;YACR,MAAM,EAAE;gBACN,MAAM,EAAE,kBAAkB;gBAC1B,QAAQ,EAAE;oBACR,GAAG,EAAE;wBACH,QAAQ,EAAE,IAAA,eAAK,EAAC,cAAS,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;wBAClD,WAAW,EAAE,WAAW,CAAC,IAAI;wBAC7B,QAAQ,EAAE,uBAAuB;wBACjC,QAAQ,EAAE,iBAAiB;qBACnB;iBACX;aACF;YACD,kBAAkB;YAClB,eAAe,EAAE,KAAc;SAChC,CAAC;QAEF,IAAI;YACF,IAAA,4BAAoB,EAAC,wBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;SAC3D;QAAC,OAAO,KAAK,EAAE;YACd,0BAA0B;YAC1B,MAAM,IAAI,KAAK,CACb,wGAAwG,KAAK,CAAC,OAAO,EAAE,CACxH,CAAC;SACH;QAED,OAAO;YACL,QAAQ;YACR,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,CAAC,IAAI,IAAI,cAAc,EAAE;SAC/D,CAAC;IACJ,CAAC;AACH,CAAC;AAtLD,8CAsLC;AAED,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC;IAC9B,KAAK;IACL,YAAY;IACZ,mBAAW;IACX,MAAM;IACN,wBAAgB,CAAC,QAAQ;CAC1B,CAAC,CAAC;AAEH;;;GAGG;AACI,KAAK,UAAU,uBAAuB;IAC3C,MAAM,aAAa,GAAG,CAAC,MAAM,aAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACtE,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CACrC,CAAC;IAEF,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC5B,IAAA,kBAAU,EACR,0EAA0E,aAAa,CAAC,MAAM,CAC5F,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE;YACvB,OAAO,GAAG,OAAO,KAAK,WAAW,IAAI,CAAC;QACxC,CAAC,EACD,EAAE,CACH,EAAE,CACJ,CAAC;QAEF,MAAM,aAAa,GAAG,MAAM,IAAA,cAAM,EAAC;YACjC,QAAQ,EAAE,WAAW;YACrB,YAAY,EAAE,GAAG;SAClB,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,aAAa,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;QAE7D,IAAI,CAAC,cAAc,EAAE;YACnB,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC7C;KACF;AACH,CAAC;AA1BD,0DA0BC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,SAAoB;IACrD,IACE,SAAS,CAAC,QAAQ,KAAK,uBAAY,CAAC,UAAU;QAC9C,SAAS,CAAC,GAAG,KAAK,cAAc,EAChC;QACA,SAAS,CAAC,GAAG,GAAG,cAAc,CAAC;QAC/B,SAAS,CAAC,CAAC,GAAG,cAAc,CAAC;KAC9B;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAVD,gDAUC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,YAA0B;IAC7D,OAAO,YAAY,KAAK,uBAAY,CAAC,UAAU,CAAC;AAClD,CAAC;AAFD,oDAEC","sourcesContent":["import { existsSync, promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport {\n  NpmSnapFileNames,\n  NpmSnapPackageJson,\n  PROPOSED_NAME_REGEX,\n  SnapManifest,\n  validateSnapJsonFile,\n} from '@metamask/snap-controllers/dist/snaps';\nimport initPackageJson from 'init-package-json';\nimport mkdirp from 'mkdirp';\nimport slash from 'slash';\nimport { Arguments } from 'yargs';\nimport { YargsArgs } from '../../types/yargs';\nimport {\n  CONFIG_FILE,\n  deepClone,\n  logError,\n  logWarning,\n  prompt,\n  readJsonFile,\n  trimPathString,\n} from '../../utils';\nimport { TemplateType } from '../../builders';\n\n/**\n * This is a placeholder shasum that will be replaced at the end of the init command.\n */\nconst PLACEHOLDER_SHASUM = '2QqUxo5joo4kKKr7yiCjdYsZOZcIFBnIBEdwU9Yx7+M=';\n\nconst NPM_PUBLIC_REGISTRY_URL = 'https://registry.npmjs.org';\n\n/**\n * Initializes a `package.json` file for a Snap project. Will attempt to read\n * and parse the existing file if it already exists, otherwise will intialize\n * a brand new one.\n *\n * @param argv - Yargs arguments object.\n * @returns The contents of the `package.json` file.\n */\nexport async function asyncPackageInit(\n  argv: YargsArgs,\n): Promise<Readonly<NpmSnapPackageJson>> {\n  if (existsSync(NpmSnapFileNames.PackageJson)) {\n    console.log(\n      `Init: Attempting to use existing '${NpmSnapFileNames.PackageJson}'...`,\n    );\n\n    try {\n      const packageJson = await readJsonFile(NpmSnapFileNames.PackageJson);\n      validateSnapJsonFile(NpmSnapFileNames.PackageJson, packageJson);\n\n      console.log(\n        `Init: Successfully parsed '${NpmSnapFileNames.PackageJson}'!`,\n      );\n      return packageJson as NpmSnapPackageJson;\n    } catch (error) {\n      logError(\n        `Init Error: Could not parse '${NpmSnapFileNames.PackageJson}'. Please verify that the file is correctly formatted and try again.`,\n        error,\n      );\n      throw error;\n    }\n  }\n\n  // Exit if yarn.lock is found, or we'll be in trouble\n  if (existsSync('yarn.lock')) {\n    logError(\n      `Init Error: Found a 'yarn.lock' file but no '${NpmSnapFileNames.PackageJson}'. Please run 'yarn init' and try again.`,\n    );\n    throw new Error('Already existing yarn.lock file found');\n  }\n\n  // Run 'npm init'\n  return new Promise((resolve, reject) => {\n    initPackageJson(\n      process.cwd(),\n      '',\n      {\n        'init.main': argv.src,\n      },\n      (err, data) => {\n        if (err) {\n          reject(err);\n        } else {\n          resolve(data);\n        }\n      },\n    );\n  });\n}\n\nconst YES = 'yes';\nconst YES_VALUES = new Set([YES, 'y']);\n\n/**\n * Checks if user input provided over a prompt is \"yes\", i.e., if the value is\n * truthy and in the {@link YES_VALUES} set.\n *\n * @param userInput - The user input to check.\n * @returns `true` if the user input is \"yes\", `false` otherwise.\n */\nfunction isYes(userInput: string | undefined) {\n  return userInput && YES_VALUES.has(userInput.toLowerCase());\n}\n\nconst DEFAULT_PERMISSION_KEY = 'snap_confirm';\n\n/**\n * Get the default permissions to write to the snap manifest.\n *\n * @returns An object containing the default permissions.\n */\nconst getDefaultPermissions = () => {\n  return { [DEFAULT_PERMISSION_KEY]: {} };\n};\n\n/**\n * Interactively constructs a Snap manifest file by prompting the user.\n *\n * @param argv - The `yargs` `argv` object.\n * @param packageJson - The `package.json` object.\n * @returns A tuple of the resulting Snap manifest object and a new `argv`\n * object with properties to match the manifest.\n */\nexport async function buildSnapManifest(\n  argv: YargsArgs,\n  packageJson: NpmSnapPackageJson,\n): Promise<[SnapManifest, { dist: string; outfileName: string; src: string }]> {\n  const { outfileName } = argv;\n  let { dist } = argv;\n  let initialPermissions: Record<string, unknown> = getDefaultPermissions();\n  let { description, name: proposedName } = packageJson;\n\n  if (!description) {\n    description = `The ${proposedName} Snap.`;\n  }\n\n  try {\n    const userInput = await prompt({\n      question: `Use default Snap manifest values?`,\n      defaultValue: YES,\n      shouldClose: false,\n    });\n\n    if (isYes(userInput)) {\n      console.log('Using default values...');\n      try {\n        await mkdirp(dist);\n      } catch (err) {\n        logError(\n          `Init Error: Could not write default 'dist' '${dist}'. Maybe check your local ${CONFIG_FILE} file?`,\n        );\n        throw err;\n      }\n      return endSnapManifest();\n    }\n  } catch (err) {\n    logError(`Init Error: ${err.message}`, err);\n    throw err;\n  }\n\n  let invalidProposedName = true;\n  while (invalidProposedName) {\n    // eslint-disable-next-line require-atomic-updates\n    proposedName = await prompt({\n      question: `Proposed Snap name:`,\n      defaultValue: proposedName,\n    });\n\n    if (\n      proposedName.length > 0 &&\n      proposedName.length <= 214 &&\n      PROPOSED_NAME_REGEX.test(proposedName)\n    ) {\n      invalidProposedName = false;\n    } else {\n      logError(\n        `The proposed name must adhere to npm package naming conventions, except that capital letters are allowed. For details, see: https://docs.npmjs.com/cli/v6/configuring-npm/package-json#name`,\n      );\n    }\n  }\n\n  let invalidDescription = true;\n  while (invalidDescription) {\n    // eslint-disable-next-line require-atomic-updates\n    description = await prompt({\n      question: `Description:`,\n      defaultValue: description,\n    });\n\n    if (description.length === 0 || description.length <= 280) {\n      invalidDescription = false;\n    } else {\n      logError(\n        `The description must be a non-empty string less than or equal to 280 characters.`,\n      );\n    }\n  }\n\n  let invalidDist = true;\n  while (invalidDist) {\n    // eslint-disable-next-line require-atomic-updates\n    dist = await prompt({ question: `Output directory:`, defaultValue: dist });\n    try {\n      dist = trimPathString(dist);\n      await mkdirp(dist);\n      invalidDist = false;\n    } catch (distError) {\n      logError(\n        `Unable to create directory '${dist}'. Ensure that the path is valid and try again.`,\n        distError,\n      );\n    }\n  }\n\n  let invalidPermissions = true;\n  while (invalidPermissions) {\n    const inputPermissions = await prompt({\n      // We add the parenthetical default value ourselves\n      question: `Initial permissions: [perm1 perm2 ...] ([snap_confirm])`,\n    });\n\n    if (\n      !inputPermissions ||\n      inputPermissions.trim() === DEFAULT_PERMISSION_KEY\n    ) {\n      break;\n    }\n\n    try {\n      initialPermissions = inputPermissions\n        .split(' ')\n        .reduce((allPermissions, permission) => {\n          if (\n            typeof permission === 'string' &&\n            permission.match(/^[\\w\\d_:]+$/iu)\n          ) {\n            allPermissions[permission] = {};\n          } else {\n            throw new Error(`Invalid permission: ${permission}`);\n          }\n          return allPermissions;\n        }, {} as Record<string, unknown>);\n\n      invalidPermissions = false;\n    } catch (err) {\n      logError(\n        `Invalid permissions '${inputPermissions}'.\\nThe permissions must be specified as a space-separated list of strings with only characters, digits, underscores ('_'), and colons (':').`,\n        err,\n      );\n    }\n  }\n\n  return endSnapManifest();\n\n  /**\n   * Get the final snap manifest object and return it, along with the dist and\n   * file names.\n   *\n   * @returns A tuple of the resulting snap manifest object and an object\n   * containing the dist and file names.\n   */\n  function endSnapManifest(): [\n    SnapManifest,\n    {\n      dist: string;\n      outfileName: string;\n      src: string;\n    },\n  ] {\n    const manifest = {\n      version: packageJson.version,\n      description,\n      proposedName,\n      repository: packageJson.repository\n        ? deepClone(packageJson.repository)\n        : null,\n      source: {\n        shasum: PLACEHOLDER_SHASUM,\n        location: {\n          npm: {\n            filePath: slash(pathUtils.join(dist, outfileName)),\n            packageName: packageJson.name,\n            registry: NPM_PUBLIC_REGISTRY_URL,\n            iconPath: 'images/icon.svg',\n          } as const,\n        },\n      },\n      initialPermissions,\n      manifestVersion: '0.1' as const,\n    };\n\n    try {\n      validateSnapJsonFile(NpmSnapFileNames.Manifest, manifest);\n    } catch (error) {\n      /* istanbul ignore next */\n      throw new Error(\n        `Internal Error: Validation of constructed manifest failed. This is a bug, please report it. Reason:\\n${error.message}`,\n      );\n    }\n\n    return [\n      manifest,\n      { dist, outfileName, src: packageJson.main || 'src/index.js' },\n    ];\n  }\n}\n\nconst INIT_FILE_NAMES = new Set([\n  'src',\n  'index.html',\n  CONFIG_FILE,\n  'dist',\n  NpmSnapFileNames.Manifest,\n]);\n\n/**\n * Checks whether any files in the current working directory will be overwritten\n * by the initialization process, and asks the user whether to continue if so.\n */\nexport async function prepareWorkingDirectory(): Promise<void> {\n  const existingFiles = (await fs.readdir(process.cwd())).filter((item) =>\n    INIT_FILE_NAMES.has(item.toString()),\n  );\n\n  if (existingFiles.length > 0) {\n    logWarning(\n      `\\nInit Warning: Existing files and/or directories may be overwritten:\\n${existingFiles.reduce(\n        (message, currentFile) => {\n          return `${message}\\t${currentFile}\\n`;\n        },\n        '',\n      )}`,\n    );\n\n    const continueInput = await prompt({\n      question: `Continue?`,\n      defaultValue: YES,\n    });\n    const shouldContinue = continueInput && isYes(continueInput);\n\n    if (!shouldContinue) {\n      console.log(`Init: Exiting...`);\n      throw new Error('User refused to continue');\n    }\n  }\n}\n\n/**\n * In case when TypeScript version is used, default source file\n * will be updated if previous was not correct.\n *\n * @param yargsArgv - The Yargs arguments object.\n * @returns Modified Yargs arguments object.\n */\nexport function correctDefaultArgs(yargsArgv: Arguments): Arguments {\n  if (\n    yargsArgv.template === TemplateType.TypeScript &&\n    yargsArgv.src === 'src/index.js'\n  ) {\n    yargsArgv.src = 'src/index.ts';\n    yargsArgv.s = 'src/index.ts';\n  }\n\n  return yargsArgv;\n}\n\n/**\n * Check if template argument is TemplateType.TypeScript.\n *\n * @param templateType - TemplateType value of the template argument passed from CLI.\n * @returns True or false.\n */\nexport function isTemplateTypescript(templateType: TemplateType): boolean {\n  return templateType === TemplateType.TypeScript;\n}\n"]}

package/dist/cmds/manifest/manifestHandler.d.ts

@@ -6,6 +6,7 @@ import { YargsArgs } from '../../types/yargs';
  * fails.
  *
  * @param argv - The Yargs `argv` object.
+ * @param argv.writeManifest - Whether to write the fixed manifest to disk.
  */
 export declare function manifestHandler({ writeManifest, }: YargsArgs): Promise<void>;
 /**

package/dist/cmds/manifest/manifestHandler.js

@@ -20,6 +20,7 @@ const ManifestSortOrder = {
  * fails.
  *
  * @param argv - The Yargs `argv` object.
+ * @param argv.writeManifest - Whether to write the fixed manifest to disk.
  */
 async function manifestHandler({ writeManifest, }) {
     let didUpdate = false;
@@ -96,6 +97,11 @@ async function manifestHandler({ writeManifest, }) {
     else {
         console.log(`Manifest Success: Validated snap.manifest.json!`);
     }
+    /**
+     * Logs a manifest warning, if `suppressWarnings` is not enabled.
+     *
+     * @param message - The message to log.
+     */
     function logManifestWarning(message) {
         if (!global.snaps.suppressWarnings) {
             hasWarnings = true;

package/dist/cmds/manifest/manifestHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifestHandler.js","sourceRoot":"","sources":["../../../src/cmds/manifest/manifestHandler.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AAEpC,uEASqD;AACrD,uCAAsD;AAGtD,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAEvC,MAAM,iBAAiB,GAAuC;IAC5D,OAAO,EAAE,CAAC;IACV,YAAY,EAAE,CAAC;IACf,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,MAAM,EAAE,CAAC;IACT,kBAAkB,EAAE,CAAC;IACrB,eAAe,EAAE,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CAAC,EACpC,aAAa,GACH;IACV,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,MAAM,mBAAmB,GAAG,MAAM,gBAAgB,CAAC,wBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE9E,MAAM,QAAQ,GACZ,mBAAmB,IAAI,OAAO,mBAAmB,KAAK,QAAQ;QAC5D,CAAC,CAAE,mBAA6C,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG;YAClE,EAAE,QAAQ;QACd,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,SAAS,GAAyB;QACtC,QAAQ,EAAE,mBAAmB;QAC7B,WAAW,EAAE,MAAM,gBAAgB,CAAC,wBAAgB,CAAC,WAAW,CAAC;QACjE,UAAU,EAAE,MAAM,iBAAiB,CAAC,mBAAmB,CAAC;QACxD,OAAO,EAAE,QAAQ,IAAI,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;KAC3D,CAAC;IAEF,IAAI,QAAkC,CAAC;IACvC,IAAI;QACF,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAA,uBAAe,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;KAC1D;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,aAAa,IAAI,KAAK,YAAY,wCAAgC,EAAE;YACtE,6DAA6D;YAC7D,MAAM,uBAAuB,GAAG,SAAsB,CAAC;YAEvD,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,mCAA2B,CAAC,CAAC,MAAM,CAAC;YAEpE,0EAA0E;YAC1E,qEAAqE;YACrE,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,SAAS,IAAI,QAAQ,IAAI,WAAW,EAAE,QAAQ,EAAE,EAAE;gBACvE,QAAQ,GAAG,WAAW,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;gBAEvD,IAAI;oBACF,IAAA,+BAAuB,EACrB,EAAE,GAAG,uBAAuB,EAAE,QAAQ,EAAE,EACxC,WAAW,CACZ,CAAC;oBAEF,SAAS,GAAG,KAAK,CAAC;iBACnB;gBAAC,OAAO,mBAAmB,EAAE;oBAC5B,qDAAqD;oBACrD,IACE,CAAC,CACC,mBAAmB,YAAY,wCAAgC,CAChE;wBACD,CAAC,QAAQ,KAAK,WAAW,IAAI,CAAC,SAAS,CAAC,EACxC;wBACA,MAAM,IAAI,KAAK,CACb,qFAAqF,KAAK,CAAC,OAAO,EAAE,CACrG,CAAC;qBACH;iBACF;aACF;YAED,SAAS,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,MAAM,KAAK,CAAC;SACb;KACF;IAED,sEAAsE;IACtE,6CAA6C;IAC7C,MAAM,iBAAiB,GAAG,QAAwB,CAAC;IAEnD,qCAAqC;IACrC,MAAM,iBAAiB,GAAG,CAAC,YAAY,CAAU,CAAC;IAElD,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,CACvD,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CACjC,CAAC;IAEF,IAAI,wBAAwB,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,kBAAkB,CAChB,iDAAiD,wBAAwB,CAAC,MAAM,CAC9E,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE;YAC3B,OAAO,GAAG,UAAU,KAAK,YAAY,IAAI,CAAC;QAC5C,CAAC,EACD,EAAE,CACH,EAAE,CACJ,CAAC;KACH;IAED,oDAAoD;IAEpD,IAAI,aAAa,EAAE;QACjB,IAAI;YACF,MAAM,aAAE,CAAC,SAAS,CAChB,wBAAgB,CAAC,QAAQ,EACzB,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CACvE,CAAC;YAEF,IAAI,SAAS,EAAE;gBACb,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;aACrD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CACb,GAAG,WAAW,wCAAwC,KAAK,CAAC,OAAO,EAAE,CACtE,CAAC;SACH;KACF;IAED,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,GAAG,CACT,wFAAwF,CACzF,CAAC;KACH;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;KAChE;IAED,SAAS,kBAAkB,CAAC,OAAe;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAClC,WAAW,GAAG,IAAI,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;SAC9C;IACH,CAAC;AACH,CAAC;AAxHD,0CAwHC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAC7B,gBAAkC;IAElC,IAAI;QACF,OAAO,MAAM,IAAA,oBAAY,EAAC,gBAAgB,CAAC,CAAC;KAC7C;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,MAAM,IAAI,KAAK,CACb,GAAG,WAAW,mBAAmB,gBAAgB,wBAAwB;gBACvE,4DAA4D,CAC/D,CAAC;SACH;QACD,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACnD;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,iBAAiB,CAAC,QAAc;IAC7C,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxE,6CAA6C;QAC7C,MAAM,cAAc,GAAI,QAAkC,CAAC,MAAM,EAAE,QAAQ;YACzE,EAAE,GAAG,EAAE,QAAQ,CAAC;QAElB,IAAI;YACF,OAAO,cAAc;gBACnB,CAAC,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;gBAC3C,CAAC,CAAC,SAAS,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CACb,oDAAoD,KAAK,CAAC,OAAO,EAAE,CACpE,CAAC;SACH;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,WAAW,CAClB,SAAoB,EACpB,KAAuC;IAEvC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACxD,MAAM,YAAY,GAAG,IAAA,iBAAS,EAAC,QAAQ,CAAC,CAAC;IAEzC,QAAQ,KAAK,CAAC,MAAM,EAAE;QACpB,KAAK,mCAA2B,CAAC,YAAY;YAC3C,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC;YAChE,MAAM;QAER,KAAK,mCAA2B,CAAC,eAAe;YAC9C,YAAY,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;YAC3C,MAAM;QAER,KAAK,mCAA2B,CAAC,kBAAkB;YACjD,YAAY,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU;gBAC9C,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,UAAU,CAAC;gBACnC,CAAC,CAAC,IAAI,CAAC;YACT,MAAM;QAER,KAAK,mCAA2B,CAAC,cAAc;YAC7C,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,IAAA,2BAAmB,EAAC,UAAU,CAAC,CAAC;YAC7D,MAAM;QAER,0BAA0B;QAC1B;YACE,gDAAgD;YAChD,MAAM,aAAa,GAAU,KAAK,CAAC,MAAM,CAAC;YAC1C,MAAM,IAAI,KAAK,CACb,4CAA4C,aAAa,GAAG,CAC7D,CAAC;KACL;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,QAAsB;IACxD,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,EAAE,GAAG,QAAQ,CAAC;IAC9C,OACE,MAAM,CAAC,IAAI,CACT,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAExD;SACE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;SAC3D,MAAM,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;QAC1B,WAAmB,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1C,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,EAAkB,CAAC,CAAC;AAC3B,CAAC;AAZD,kDAYC","sourcesContent":["import { promises as fs } from 'fs';\nimport type { Json, SnapManifest } from '@metamask/snap-controllers';\nimport {\n  NpmSnapFileNames,\n  UnvalidatedSnapFiles,\n  validateNpmSnap,\n  validateNpmSnapManifest,\n  getSnapSourceShasum,\n  ProgrammaticallyFixableSnapError,\n  SnapValidationFailureReason,\n  SnapFiles,\n} from '@metamask/snap-controllers/dist/snaps/utils';\nimport { deepClone, readJsonFile } from '../../utils';\nimport { YargsArgs } from '../../types/yargs';\n\nconst errorPrefix = 'Manifest Error: ';\n\nconst ManifestSortOrder: Record<keyof SnapManifest, number> = {\n  version: 1,\n  proposedName: 2,\n  description: 2,\n  repository: 3,\n  source: 4,\n  initialPermissions: 5,\n  manifestVersion: 6,\n};\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param argv - The Yargs `argv` object.\n */\nexport async function manifestHandler({\n  writeManifest,\n}: YargsArgs): Promise<void> {\n  let didUpdate = false;\n  let hasWarnings = false;\n\n  const unvalidatedManifest = await readSnapJsonFile(NpmSnapFileNames.Manifest);\n\n  const iconPath =\n    unvalidatedManifest && typeof unvalidatedManifest === 'object'\n      ? (unvalidatedManifest as Partial<SnapManifest>).source?.location?.npm\n          ?.iconPath\n      : undefined;\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: unvalidatedManifest,\n    packageJson: await readSnapJsonFile(NpmSnapFileNames.PackageJson),\n    sourceCode: await getSnapSourceCode(unvalidatedManifest),\n    svgIcon: iconPath && (await fs.readFile(iconPath, 'utf8')),\n  };\n\n  let manifest: SnapManifest | undefined;\n  try {\n    ({ manifest } = validateNpmSnap(snapFiles, errorPrefix));\n  } catch (error) {\n    if (writeManifest && error instanceof ProgrammaticallyFixableSnapError) {\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the SnapValidationFailureReason enum, so we only\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = fixManifest(partiallyValidatedFiles, error);\n\n        try {\n          validateNpmSnapManifest(\n            { ...partiallyValidatedFiles, manifest },\n            errorPrefix,\n          );\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal Error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n        }\n      }\n\n      didUpdate = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript doesn't see that the 'manifest' variable must be of type\n  // SnapManifest at this point, so we cast it.\n  const validatedManifest = manifest as SnapManifest;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    logManifestWarning(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  // Validation complete, finish work and notify user.\n\n  if (writeManifest) {\n    try {\n      await fs.writeFile(\n        NpmSnapFileNames.Manifest,\n        `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\\n`,\n      );\n\n      if (didUpdate) {\n        console.log(`Manifest: Updated snap.manifest.json`);\n      }\n    } catch (error) {\n      throw new Error(\n        `${errorPrefix}Failed to update snap.manifest.json: ${error.message}`,\n      );\n    }\n  }\n\n  if (hasWarnings) {\n    console.log(\n      `Manifest Warning: Validation of snap.manifest.json completed with warnings. See above.`,\n    );\n  } else {\n    console.log(`Manifest Success: Validated snap.manifest.json!`);\n  }\n\n  function logManifestWarning(message: string) {\n    if (!global.snaps.suppressWarnings) {\n      hasWarnings = true;\n      console.warn(`Manifest Warning: ${message}`);\n    }\n  }\n}\n\n/**\n * Utility function for reading `package.json` or the Snap manifest file.\n * These are assumed to be in the current working directory.\n *\n * @param snapJsonFileName - The name of the file to read.\n * @returns The parsed JSON file.\n */\nasync function readSnapJsonFile(\n  snapJsonFileName: NpmSnapFileNames,\n): Promise<Json> {\n  try {\n    return await readJsonFile(snapJsonFileName);\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      throw new Error(\n        `${errorPrefix}Could not find '${snapJsonFileName}'. Please ensure that ` +\n          `you are running the command in the project root directory.`,\n      );\n    }\n    throw new Error(`${errorPrefix}${error.message}`);\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the bundle file, if any.\n */\nasync function getSnapSourceCode(manifest: Json): Promise<string | undefined> {\n  if (manifest && typeof manifest === 'object' && !Array.isArray(manifest)) {\n    /* istanbul ignore next: optional chaining */\n    const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n      ?.npm?.filePath;\n\n    try {\n      return sourceFilePath\n        ? await fs.readFile(sourceFilePath, 'utf8')\n        : undefined;\n    } catch (error) {\n      throw new Error(\n        `Manifest Error: Failed to read Snap bundle file: ${error.message}`,\n      );\n    }\n  }\n  return undefined;\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nfunction fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): SnapManifest {\n  const { manifest, packageJson, sourceCode } = snapFiles;\n  const manifestCopy = deepClone(manifest);\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.repository\n        ? deepClone(packageJson.repository)\n        : null;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = getSnapSourceShasum(sourceCode);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      // eslint-disable-next-line no-case-declarations\n      const failureReason: never = error.reason;\n      throw new Error(\n        `Unrecognized validation failure reason: '${failureReason}'`,\n      );\n  }\n\n  return manifestCopy;\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n  return (\n    Object.keys(\n      repository ? { ...remaining, repository } : remaining,\n    ) as (keyof SnapManifest)[]\n  )\n    .sort((a, b) => ManifestSortOrder[a] - ManifestSortOrder[b])\n    .reduce((outManifest, key) => {\n      (outManifest as any)[key] = manifest[key];\n      return outManifest;\n    }, {} as SnapManifest);\n}\n"]}
+{"version":3,"file":"manifestHandler.js","sourceRoot":"","sources":["../../../src/cmds/manifest/manifestHandler.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AAEpC,uEASqD;AACrD,uCAAsD;AAGtD,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAEvC,MAAM,iBAAiB,GAAuC;IAC5D,OAAO,EAAE,CAAC;IACV,YAAY,EAAE,CAAC;IACf,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,MAAM,EAAE,CAAC;IACT,kBAAkB,EAAE,CAAC;IACrB,eAAe,EAAE,CAAC;CACnB,CAAC;AAEF;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CAAC,EACpC,aAAa,GACH;IACV,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,MAAM,mBAAmB,GAAG,MAAM,gBAAgB,CAAC,wBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE9E,MAAM,QAAQ,GACZ,mBAAmB,IAAI,OAAO,mBAAmB,KAAK,QAAQ;QAC5D,CAAC,CAAE,mBAA6C,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG;YAClE,EAAE,QAAQ;QACd,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,SAAS,GAAyB;QACtC,QAAQ,EAAE,mBAAmB;QAC7B,WAAW,EAAE,MAAM,gBAAgB,CAAC,wBAAgB,CAAC,WAAW,CAAC;QACjE,UAAU,EAAE,MAAM,iBAAiB,CAAC,mBAAmB,CAAC;QACxD,OAAO,EAAE,QAAQ,IAAI,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;KAC3D,CAAC;IAEF,IAAI,QAAkC,CAAC;IACvC,IAAI;QACF,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAA,uBAAe,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;KAC1D;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,aAAa,IAAI,KAAK,YAAY,wCAAgC,EAAE;YACtE,6DAA6D;YAC7D,MAAM,uBAAuB,GAAG,SAAsB,CAAC;YAEvD,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,mCAA2B,CAAC,CAAC,MAAM,CAAC;YAEpE,0EAA0E;YAC1E,qEAAqE;YACrE,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,SAAS,IAAI,QAAQ,IAAI,WAAW,EAAE,QAAQ,EAAE,EAAE;gBACvE,QAAQ,GAAG,WAAW,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;gBAEvD,IAAI;oBACF,IAAA,+BAAuB,EACrB,EAAE,GAAG,uBAAuB,EAAE,QAAQ,EAAE,EACxC,WAAW,CACZ,CAAC;oBAEF,SAAS,GAAG,KAAK,CAAC;iBACnB;gBAAC,OAAO,mBAAmB,EAAE;oBAC5B,qDAAqD;oBACrD,IACE,CAAC,CACC,mBAAmB,YAAY,wCAAgC,CAChE;wBACD,CAAC,QAAQ,KAAK,WAAW,IAAI,CAAC,SAAS,CAAC,EACxC;wBACA,MAAM,IAAI,KAAK,CACb,qFAAqF,KAAK,CAAC,OAAO,EAAE,CACrG,CAAC;qBACH;iBACF;aACF;YAED,SAAS,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,MAAM,KAAK,CAAC;SACb;KACF;IAED,sEAAsE;IACtE,6CAA6C;IAC7C,MAAM,iBAAiB,GAAG,QAAwB,CAAC;IAEnD,qCAAqC;IACrC,MAAM,iBAAiB,GAAG,CAAC,YAAY,CAAU,CAAC;IAElD,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,CACvD,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CACjC,CAAC;IAEF,IAAI,wBAAwB,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,kBAAkB,CAChB,iDAAiD,wBAAwB,CAAC,MAAM,CAC9E,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE;YAC3B,OAAO,GAAG,UAAU,KAAK,YAAY,IAAI,CAAC;QAC5C,CAAC,EACD,EAAE,CACH,EAAE,CACJ,CAAC;KACH;IAED,oDAAoD;IAEpD,IAAI,aAAa,EAAE;QACjB,IAAI;YACF,MAAM,aAAE,CAAC,SAAS,CAChB,wBAAgB,CAAC,QAAQ,EACzB,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CACvE,CAAC;YAEF,IAAI,SAAS,EAAE;gBACb,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;aACrD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CACb,GAAG,WAAW,wCAAwC,KAAK,CAAC,OAAO,EAAE,CACtE,CAAC;SACH;KACF;IAED,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,GAAG,CACT,wFAAwF,CACzF,CAAC;KACH;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;KAChE;IAED;;;;OAIG;IACH,SAAS,kBAAkB,CAAC,OAAe;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAClC,WAAW,GAAG,IAAI,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;SAC9C;IACH,CAAC;AACH,CAAC;AA7HD,0CA6HC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAC7B,gBAAkC;IAElC,IAAI;QACF,OAAO,MAAM,IAAA,oBAAY,EAAC,gBAAgB,CAAC,CAAC;KAC7C;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,MAAM,IAAI,KAAK,CACb,GAAG,WAAW,mBAAmB,gBAAgB,wBAAwB;gBACvE,4DAA4D,CAC/D,CAAC;SACH;QACD,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACnD;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,iBAAiB,CAAC,QAAc;IAC7C,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxE,6CAA6C;QAC7C,MAAM,cAAc,GAAI,QAAkC,CAAC,MAAM,EAAE,QAAQ;YACzE,EAAE,GAAG,EAAE,QAAQ,CAAC;QAElB,IAAI;YACF,OAAO,cAAc;gBACnB,CAAC,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;gBAC3C,CAAC,CAAC,SAAS,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CACb,oDAAoD,KAAK,CAAC,OAAO,EAAE,CACpE,CAAC;SACH;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,WAAW,CAClB,SAAoB,EACpB,KAAuC;IAEvC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACxD,MAAM,YAAY,GAAG,IAAA,iBAAS,EAAC,QAAQ,CAAC,CAAC;IAEzC,QAAQ,KAAK,CAAC,MAAM,EAAE;QACpB,KAAK,mCAA2B,CAAC,YAAY;YAC3C,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC;YAChE,MAAM;QAER,KAAK,mCAA2B,CAAC,eAAe;YAC9C,YAAY,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;YAC3C,MAAM;QAER,KAAK,mCAA2B,CAAC,kBAAkB;YACjD,YAAY,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU;gBAC9C,CAAC,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,UAAU,CAAC;gBACnC,CAAC,CAAC,IAAI,CAAC;YACT,MAAM;QAER,KAAK,mCAA2B,CAAC,cAAc;YAC7C,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,IAAA,2BAAmB,EAAC,UAAU,CAAC,CAAC;YAC7D,MAAM;QAER,0BAA0B;QAC1B;YACE,gDAAgD;YAChD,MAAM,aAAa,GAAU,KAAK,CAAC,MAAM,CAAC;YAC1C,MAAM,IAAI,KAAK,CACb,4CAA4C,aAAa,GAAG,CAC7D,CAAC;KACL;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,QAAsB;IACxD,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,EAAE,GAAG,QAAQ,CAAC;IAC9C,OACE,MAAM,CAAC,IAAI,CACT,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAExD;SACE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;SAC3D,MAAM,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;QAC1B,WAAmB,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1C,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,EAAkB,CAAC,CAAC;AAC3B,CAAC;AAZD,kDAYC","sourcesContent":["import { promises as fs } from 'fs';\nimport type { Json, SnapManifest } from '@metamask/snap-controllers';\nimport {\n  NpmSnapFileNames,\n  UnvalidatedSnapFiles,\n  validateNpmSnap,\n  validateNpmSnapManifest,\n  getSnapSourceShasum,\n  ProgrammaticallyFixableSnapError,\n  SnapValidationFailureReason,\n  SnapFiles,\n} from '@metamask/snap-controllers/dist/snaps/utils';\nimport { deepClone, readJsonFile } from '../../utils';\nimport { YargsArgs } from '../../types/yargs';\n\nconst errorPrefix = 'Manifest Error: ';\n\nconst ManifestSortOrder: Record<keyof SnapManifest, number> = {\n  version: 1,\n  proposedName: 2,\n  description: 2,\n  repository: 3,\n  source: 4,\n  initialPermissions: 5,\n  manifestVersion: 6,\n};\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param argv - The Yargs `argv` object.\n * @param argv.writeManifest - Whether to write the fixed manifest to disk.\n */\nexport async function manifestHandler({\n  writeManifest,\n}: YargsArgs): Promise<void> {\n  let didUpdate = false;\n  let hasWarnings = false;\n\n  const unvalidatedManifest = await readSnapJsonFile(NpmSnapFileNames.Manifest);\n\n  const iconPath =\n    unvalidatedManifest && typeof unvalidatedManifest === 'object'\n      ? (unvalidatedManifest as Partial<SnapManifest>).source?.location?.npm\n          ?.iconPath\n      : undefined;\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: unvalidatedManifest,\n    packageJson: await readSnapJsonFile(NpmSnapFileNames.PackageJson),\n    sourceCode: await getSnapSourceCode(unvalidatedManifest),\n    svgIcon: iconPath && (await fs.readFile(iconPath, 'utf8')),\n  };\n\n  let manifest: SnapManifest | undefined;\n  try {\n    ({ manifest } = validateNpmSnap(snapFiles, errorPrefix));\n  } catch (error) {\n    if (writeManifest && error instanceof ProgrammaticallyFixableSnapError) {\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the SnapValidationFailureReason enum, so we only\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = fixManifest(partiallyValidatedFiles, error);\n\n        try {\n          validateNpmSnapManifest(\n            { ...partiallyValidatedFiles, manifest },\n            errorPrefix,\n          );\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal Error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n        }\n      }\n\n      didUpdate = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript doesn't see that the 'manifest' variable must be of type\n  // SnapManifest at this point, so we cast it.\n  const validatedManifest = manifest as SnapManifest;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    logManifestWarning(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  // Validation complete, finish work and notify user.\n\n  if (writeManifest) {\n    try {\n      await fs.writeFile(\n        NpmSnapFileNames.Manifest,\n        `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\\n`,\n      );\n\n      if (didUpdate) {\n        console.log(`Manifest: Updated snap.manifest.json`);\n      }\n    } catch (error) {\n      throw new Error(\n        `${errorPrefix}Failed to update snap.manifest.json: ${error.message}`,\n      );\n    }\n  }\n\n  if (hasWarnings) {\n    console.log(\n      `Manifest Warning: Validation of snap.manifest.json completed with warnings. See above.`,\n    );\n  } else {\n    console.log(`Manifest Success: Validated snap.manifest.json!`);\n  }\n\n  /**\n   * Logs a manifest warning, if `suppressWarnings` is not enabled.\n   *\n   * @param message - The message to log.\n   */\n  function logManifestWarning(message: string) {\n    if (!global.snaps.suppressWarnings) {\n      hasWarnings = true;\n      console.warn(`Manifest Warning: ${message}`);\n    }\n  }\n}\n\n/**\n * Utility function for reading `package.json` or the Snap manifest file.\n * These are assumed to be in the current working directory.\n *\n * @param snapJsonFileName - The name of the file to read.\n * @returns The parsed JSON file.\n */\nasync function readSnapJsonFile(\n  snapJsonFileName: NpmSnapFileNames,\n): Promise<Json> {\n  try {\n    return await readJsonFile(snapJsonFileName);\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      throw new Error(\n        `${errorPrefix}Could not find '${snapJsonFileName}'. Please ensure that ` +\n          `you are running the command in the project root directory.`,\n      );\n    }\n    throw new Error(`${errorPrefix}${error.message}`);\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the bundle file, if any.\n */\nasync function getSnapSourceCode(manifest: Json): Promise<string | undefined> {\n  if (manifest && typeof manifest === 'object' && !Array.isArray(manifest)) {\n    /* istanbul ignore next: optional chaining */\n    const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n      ?.npm?.filePath;\n\n    try {\n      return sourceFilePath\n        ? await fs.readFile(sourceFilePath, 'utf8')\n        : undefined;\n    } catch (error) {\n      throw new Error(\n        `Manifest Error: Failed to read Snap bundle file: ${error.message}`,\n      );\n    }\n  }\n  return undefined;\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nfunction fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): SnapManifest {\n  const { manifest, packageJson, sourceCode } = snapFiles;\n  const manifestCopy = deepClone(manifest);\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.repository\n        ? deepClone(packageJson.repository)\n        : null;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = getSnapSourceShasum(sourceCode);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      // eslint-disable-next-line no-case-declarations\n      const failureReason: never = error.reason;\n      throw new Error(\n        `Unrecognized validation failure reason: '${failureReason}'`,\n      );\n  }\n\n  return manifestCopy;\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n  return (\n    Object.keys(\n      repository ? { ...remaining, repository } : remaining,\n    ) as (keyof SnapManifest)[]\n  )\n    .sort((a, b) => ManifestSortOrder[a] - ManifestSortOrder[b])\n    .reduce((outManifest, key) => {\n      (outManifest as any)[key] = manifest[key];\n      return outManifest;\n    }, {} as SnapManifest);\n}\n"]}