@metamask/snaps-cli 0.15.0 → 0.18.0

package/dist/cmds/eval/mock.js

@@ -9,14 +9,29 @@ const crypto_1 = __importDefault(require("crypto"));
 const snap_controllers_1 = require("@metamask/snap-controllers");
 const NETWORK_APIS = ['fetch', 'WebSocket'];
 exports.ALL_APIS = [...snap_controllers_1.DEFAULT_ENDOWMENTS, ...NETWORK_APIS];
+/**
+ * Get a mock snap provider, that always returns `true` for requests.
+ *
+ * @returns A mocked snap provider.
+ */
 function getMockSnapProvider() {
     const mockProvider = new events_1.default();
-    mockProvider.registerRpcMessageHandler = () => true;
     mockProvider.request = async () => true;
     return mockProvider;
 }
-const isConstructor = (value) => Boolean(typeof value?.prototype?.constructor?.name === 'string');
+/**
+ * Check if a value is a constructor.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a constructor, or `false` otherwise.
+ */
+const isConstructor = (value) => { var _a, _b; return Boolean(typeof ((_b = (_a = value === null || value === void 0 ? void 0 : value.prototype) === null || _a === void 0 ? void 0 : _a.constructor) === null || _b === void 0 ? void 0 : _b.name) === 'string'); };
 exports.isConstructor = isConstructor;
+/**
+ * A function that always returns `true`.
+ *
+ * @returns `true`.
+ */
 const mockFunction = () => true;
 class MockClass {
 }
@@ -28,6 +43,13 @@ const handler = {
         return mockFunction;
     },
 };
+/**
+ * Generate a mock class for a given value. The value is wrapped in a Proxy, and
+ * all methods are replaced with a mock function.
+ *
+ * @param value - The value to mock.
+ * @returns A mock class.
+ */
 const generateMockClass = (value) => {
     return new Proxy(value, handler);
 };
@@ -37,6 +59,14 @@ const mockWindow = {
     crypto: crypto_1.default,
     SubtleCrypto: MockClass,
 };
+/**
+ * Generate a mock endowment for a certain class or function on the `globalThis`
+ * object.
+ *
+ * @param key - The key to generate the mock endowment for.
+ * @returns A mocked class or function. If the key is part of the default
+ * endowments, the original value is returned.
+ */
 const generateMockEndowment = (key) => {
     const globalValue = globalThis[key];
     // Default exposed APIs don't need to be mocked
@@ -44,7 +74,7 @@ const generateMockEndowment = (key) => {
         return globalValue;
     }
     // Fall back to mockWindow for certain APIs not exposed in global in Node.JS
-    const globalOrMocked = globalValue ?? mockWindow[key];
+    const globalOrMocked = globalValue !== null && globalValue !== void 0 ? globalValue : mockWindow[key];
     const type = typeof globalOrMocked;
     const isFunction = type === 'function';
     if (isFunction && (0, exports.isConstructor)(globalOrMocked)) {
@@ -56,8 +86,13 @@ const generateMockEndowment = (key) => {
     }
     return globalOrMocked;
 };
+/**
+ * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
+ *
+ * @returns A map of endowments.
+ */
 const generateMockEndowments = () => {
-    return exports.ALL_APIS.reduce((acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }), { wallet: getMockSnapProvider() });
+    return exports.ALL_APIS.reduce((acc, cur) => (Object.assign(Object.assign({}, acc), { [cur]: generateMockEndowment(cur) })), { wallet: getMockSnapProvider() });
 };
 exports.generateMockEndowments = generateMockEndowments;
 //# sourceMappingURL=mock.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"mock.js","sourceRoot":"","sources":["../../../src/cmds/eval/mock.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAkC;AAClC,oDAA4B;AAC5B,iEAAgE;AAEhE,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAE/B,QAAA,QAAQ,GAAa,CAAC,GAAG,qCAAkB,EAAE,GAAG,YAAY,CAAC,CAAC;AAO3E,SAAS,mBAAmB;IAC1B,MAAM,YAAY,GAAG,IAAI,gBAAY,EAA+B,CAAC;IACrE,YAAY,CAAC,yBAAyB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;IACpD,YAAY,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;IACxC,OAAO,YAAgC,CAAC;AAC1C,CAAC;AAEM,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,CAC1C,OAAO,CAAC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC;AADtD,QAAA,aAAa,iBACyC;AAEnE,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAChC,MAAM,SAAS;CAAG;AAElB,MAAM,OAAO,GAAG;IACd,SAAS,CAAC,MAAW,EAAE,IAAW;QAChC,OAAO,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,OAAY,EAAE,KAAU;QAC1B,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAU,EAAE,EAAE;IACvC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,8IAA8I;AAC9I,MAAM,UAAU,GAAG;IACjB,SAAS,EAAE,SAAS;IACpB,MAAM,EAAN,gBAAM;IACN,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IAC5C,MAAM,WAAW,GAAI,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE7C,+CAA+C;IAC/C,IAAI,WAAW,IAAI,qCAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACnD,OAAO,WAAW,CAAC;KACpB;IAED,4EAA4E;IAC5E,MAAM,cAAc,GAAG,WAAW,IAAK,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE/D,MAAM,IAAI,GAAG,OAAO,cAAc,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,KAAK,UAAU,CAAC;IACvC,IAAI,UAAU,IAAI,IAAA,qBAAa,EAAC,cAAc,CAAC,EAAE;QAC/C,OAAO,iBAAiB,CAAC,cAAc,CAAC,CAAC;KAC1C;SAAM,IAAI,UAAU,IAAI,CAAC,cAAc,EAAE;QACxC,qCAAqC;QACrC,OAAO,YAAY,CAAC;KACrB;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEK,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,OAAO,gBAAQ,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAC7D,EAAE,MAAM,EAAE,mBAAmB,EAAE,EAAE,CAClC,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC","sourcesContent":["import EventEmitter from 'events';\nimport crypto from 'crypto';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snap-controllers';\n\nconst NETWORK_APIS = ['fetch', 'WebSocket'];\n\nexport const ALL_APIS: string[] = [...DEFAULT_ENDOWMENTS, ...NETWORK_APIS];\n\ntype MockSnapProvider = EventEmitter & {\n  registerRpcMessageHandler: () => any;\n  request: () => Promise<any>;\n};\n\nfunction getMockSnapProvider(): MockSnapProvider {\n  const mockProvider = new EventEmitter() as Partial<MockSnapProvider>;\n  mockProvider.registerRpcMessageHandler = () => true;\n  mockProvider.request = async () => true;\n  return mockProvider as MockSnapProvider;\n}\n\nexport const isConstructor = (value: any) =>\n  Boolean(typeof value?.prototype?.constructor?.name === 'string');\n\nconst mockFunction = () => true;\nclass MockClass {}\n\nconst handler = {\n  construct(Target: any, args: any[]): any {\n    return new Proxy(new Target(...args), handler);\n  },\n  get(_target: any, _prop: any) {\n    return mockFunction;\n  },\n};\n\nconst generateMockClass = (value: any) => {\n  return new Proxy(value, handler);\n};\n\n// Things not currently auto-mocked because of NodeJS, by adding them here we have types for them and can use that to generate mocks if needed\nconst mockWindow = {\n  WebSocket: MockClass,\n  crypto,\n  SubtleCrypto: MockClass,\n};\n\nconst generateMockEndowment = (key: string) => {\n  const globalValue = (globalThis as any)[key];\n\n  // Default exposed APIs don't need to be mocked\n  if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {\n    return globalValue;\n  }\n\n  // Fall back to mockWindow for certain APIs not exposed in global in Node.JS\n  const globalOrMocked = globalValue ?? (mockWindow as any)[key];\n\n  const type = typeof globalOrMocked;\n  const isFunction = type === 'function';\n  if (isFunction && isConstructor(globalOrMocked)) {\n    return generateMockClass(globalOrMocked);\n  } else if (isFunction || !globalOrMocked) {\n    // Fall back to function mock for now\n    return mockFunction;\n  }\n  return globalOrMocked;\n};\n\nexport const generateMockEndowments = () => {\n  return ALL_APIS.reduce<Record<string, any>>(\n    (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),\n    { wallet: getMockSnapProvider() },\n  );\n};\n"]}
+{"version":3,"file":"mock.js","sourceRoot":"","sources":["../../../src/cmds/eval/mock.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAkC;AAClC,oDAA4B;AAC5B,iEAAgE;AAEhE,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAE/B,QAAA,QAAQ,GAAa,CAAC,GAAG,qCAAkB,EAAE,GAAG,YAAY,CAAC,CAAC;AAM3E;;;;GAIG;AACH,SAAS,mBAAmB;IAC1B,MAAM,YAAY,GAAG,IAAI,gBAAY,EAA+B,CAAC;IACrE,YAAY,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;IACxC,OAAO,YAAgC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,eAC1C,OAAA,OAAO,CAAC,OAAO,CAAA,MAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,0CAAE,WAAW,0CAAE,IAAI,CAAA,KAAK,QAAQ,CAAC,CAAA,EAAA,CAAC;AADtD,QAAA,aAAa,iBACyC;AAEnE;;;;GAIG;AACH,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAChC,MAAM,SAAS;CAAG;AAElB,MAAM,OAAO,GAAG;IACd,SAAS,CAAC,MAAW,EAAE,IAAW;QAChC,OAAO,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,OAAY,EAAE,KAAU;QAC1B,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAU,EAAE,EAAE;IACvC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,8IAA8I;AAC9I,MAAM,UAAU,GAAG;IACjB,SAAS,EAAE,SAAS;IACpB,MAAM,EAAN,gBAAM;IACN,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IAC5C,MAAM,WAAW,GAAI,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE7C,+CAA+C;IAC/C,IAAI,WAAW,IAAI,qCAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACnD,OAAO,WAAW,CAAC;KACpB;IAED,4EAA4E;IAC5E,MAAM,cAAc,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAK,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE/D,MAAM,IAAI,GAAG,OAAO,cAAc,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,KAAK,UAAU,CAAC;IACvC,IAAI,UAAU,IAAI,IAAA,qBAAa,EAAC,cAAc,CAAC,EAAE;QAC/C,OAAO,iBAAiB,CAAC,cAAc,CAAC,CAAC;KAC1C;SAAM,IAAI,UAAU,IAAI,CAAC,cAAc,EAAE;QACxC,qCAAqC;QACrC,OAAO,YAAY,CAAC;KACrB;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,OAAO,gBAAQ,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,IAAG,EAC7D,EAAE,MAAM,EAAE,mBAAmB,EAAE,EAAE,CAClC,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC","sourcesContent":["import EventEmitter from 'events';\nimport crypto from 'crypto';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snap-controllers';\n\nconst NETWORK_APIS = ['fetch', 'WebSocket'];\n\nexport const ALL_APIS: string[] = [...DEFAULT_ENDOWMENTS, ...NETWORK_APIS];\n\ntype MockSnapProvider = EventEmitter & {\n  request: () => Promise<any>;\n};\n\n/**\n * Get a mock snap provider, that always returns `true` for requests.\n *\n * @returns A mocked snap provider.\n */\nfunction getMockSnapProvider(): MockSnapProvider {\n  const mockProvider = new EventEmitter() as Partial<MockSnapProvider>;\n  mockProvider.request = async () => true;\n  return mockProvider as MockSnapProvider;\n}\n\n/**\n * Check if a value is a constructor.\n *\n * @param value - The value to check.\n * @returns `true` if the value is a constructor, or `false` otherwise.\n */\nexport const isConstructor = (value: any) =>\n  Boolean(typeof value?.prototype?.constructor?.name === 'string');\n\n/**\n * A function that always returns `true`.\n *\n * @returns `true`.\n */\nconst mockFunction = () => true;\nclass MockClass {}\n\nconst handler = {\n  construct(Target: any, args: any[]): any {\n    return new Proxy(new Target(...args), handler);\n  },\n  get(_target: any, _prop: any) {\n    return mockFunction;\n  },\n};\n\n/**\n * Generate a mock class for a given value. The value is wrapped in a Proxy, and\n * all methods are replaced with a mock function.\n *\n * @param value - The value to mock.\n * @returns A mock class.\n */\nconst generateMockClass = (value: any) => {\n  return new Proxy(value, handler);\n};\n\n// Things not currently auto-mocked because of NodeJS, by adding them here we have types for them and can use that to generate mocks if needed\nconst mockWindow = {\n  WebSocket: MockClass,\n  crypto,\n  SubtleCrypto: MockClass,\n};\n\n/**\n * Generate a mock endowment for a certain class or function on the `globalThis`\n * object.\n *\n * @param key - The key to generate the mock endowment for.\n * @returns A mocked class or function. If the key is part of the default\n * endowments, the original value is returned.\n */\nconst generateMockEndowment = (key: string) => {\n  const globalValue = (globalThis as any)[key];\n\n  // Default exposed APIs don't need to be mocked\n  if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {\n    return globalValue;\n  }\n\n  // Fall back to mockWindow for certain APIs not exposed in global in Node.JS\n  const globalOrMocked = globalValue ?? (mockWindow as any)[key];\n\n  const type = typeof globalOrMocked;\n  const isFunction = type === 'function';\n  if (isFunction && isConstructor(globalOrMocked)) {\n    return generateMockClass(globalOrMocked);\n  } else if (isFunction || !globalOrMocked) {\n    // Fall back to function mock for now\n    return mockFunction;\n  }\n  return globalOrMocked;\n};\n\n/**\n * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.\n *\n * @returns A map of endowments.\n */\nexport const generateMockEndowments = () => {\n  return ALL_APIS.reduce<Record<string, any>>(\n    (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),\n    { wallet: getMockSnapProvider() },\n  );\n};\n"]}

package/dist/cmds/eval/workerEval.d.ts

@@ -1 +1,8 @@
+/**
+ * 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.
+ */
 export declare function workerEval(bundlePath: string): Promise<null>;

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,14 +5,18 @@ 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);
-    await (0, buildHandler_1.build)({
-        ...newArgs,
-        manifest: false,
-        eval: true,
-    });
+    await (0, buildHandler_1.build)(Object.assign(Object.assign({}, newArgs), { manifest: false, eval: true }));
     await (0, initHandler_1.updateManifestShasum)();
     console.log('\nSnap project successfully initiated!');
 }
@@ -24,7 +28,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,kCACN,OAAO,KACV,QAAQ,EAAE,KAAK,EACf,IAAI,EAAE,IAAI,IACV,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": "wallet.registerRpcMessageHandler(async (originString, requestObject) => {\n  switch (requestObject.method) {\n    case 'hello':\n      return wallet.request({\n        method: 'snap_confirm',\n        params: [\n          {\n            prompt: `Hello, ${originString}!`,\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\": [\"./node_modules/@metamask/snap-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,8 +90,21 @@ 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 };
+    return Object.assign(Object.assign({}, argv), newArgs);
 }
 exports.initHandler = initHandler;
 /**

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,uCAAY,IAAI,GAAK,OAAO,EAAG;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