@metamask/snaps-cli 0.16.0 → 0.17.0

package/README.md

@@ -34,6 +34,8 @@ Options:
 Examples:
   mm-snap init                              Initialize a snap project in the
                                             current directory
+  mm-snap init --template javascript        Initialize a snap JavaScript project
+                                            in the current directory
   mm-snap build -s src/index.js -d out      Build 'src/index.js' as
                                             './out/bundle.js'
   mm-snap build -s src/index.js -d out -n   Build 'src/index.js' as

package/dist/builders.d.ts

@@ -16,11 +16,17 @@ export declare type SnapsCliBuilders = {
     readonly depsToTranspile: Readonly<Options>;
     readonly verboseErrors: Readonly<Options>;
     readonly writeManifest: Readonly<Options>;
+    readonly serve: Readonly<Options>;
+    readonly template: Readonly<Options>;
 };
 export declare enum TranspilationModes {
     localAndDeps = "localAndDeps",
     localOnly = "localOnly",
     none = "none"
 }
+export declare enum TemplateType {
+    TypeScript = "typescript",
+    JavaScript = "javascript"
+}
 declare const builders: SnapsCliBuilders;
 export default builders;

package/dist/builders.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranspilationModes = void 0;
+exports.TemplateType = exports.TranspilationModes = void 0;
 var TranspilationModes;
 (function (TranspilationModes) {
     TranspilationModes["localAndDeps"] = "localAndDeps";
     TranspilationModes["localOnly"] = "localOnly";
     TranspilationModes["none"] = "none";
 })(TranspilationModes = exports.TranspilationModes || (exports.TranspilationModes = {}));
+var TemplateType;
+(function (TemplateType) {
+    TemplateType["TypeScript"] = "typescript";
+    TemplateType["JavaScript"] = "javascript";
+})(TemplateType = exports.TemplateType || (exports.TemplateType = {}));
 const builders = {
     bundle: {
         alias: 'b',
@@ -124,6 +129,20 @@ const builders = {
         demandOption: false,
         default: true,
     },
+    serve: {
+        describe: 'Serve Snap file(s) locally for testing',
+        type: 'boolean',
+        demandOption: false,
+        default: true,
+    },
+    template: {
+        alias: 't',
+        describe: 'Specify which template to use (TypeScript or JavaScript)',
+        type: 'string',
+        demandOption: false,
+        default: TemplateType.TypeScript,
+        choices: Object.values(TemplateType),
+    },
 };
 exports.default = builders;
 //# sourceMappingURL=builders.js.map

package/dist/builders.js.map

@@ -1 +1 @@
-{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;;AAqBA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,MAAM,QAAQ,GAAqB;IACjC,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,gBAAgB;KAC1B;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM;KAChB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,CAAC,GAAY,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC;aACzC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF;IAED,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,WAAW;KACrB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,GAAG;KACb;IAED,UAAU,EAAE;QACV,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,cAAc;KACxB;IAED,aAAa,EAAE;QACb,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,uDAAuD;QACjE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,8BAA8B;QACxC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,iHAAiH;QACnH,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,kBAAkB,CAAC,SAAS;QACrC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;KAC3C;IAED,qBAAqB,EAAE;QACrB,IAAI,EAAE,SAAS;QACf,QAAQ,EACN,mFAAmF;QACrF,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;KACd;IAED,eAAe,EAAE;QACf,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,yCAAyC;QACnD,YAAY,EAAE,KAAK;KACpB;IAED,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,yBAAyB;QACnC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,aAAa,EAAE;QACb,QAAQ,EAAE,kDAAkD;QAC5D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;CACF,CAAC;AAEF,kBAAe,QAAQ,CAAC","sourcesContent":["import { Options } from 'yargs';\n\nexport type SnapsCliBuilders = {\n  readonly bundle: Readonly<Options>;\n  readonly dist: Readonly<Options>;\n  readonly eval: Readonly<Options>;\n  readonly manifest: Readonly<Options>;\n  readonly outfileName: Readonly<Options>;\n  readonly port: Readonly<Options>;\n  readonly root: Readonly<Options>;\n  readonly sourceMaps: Readonly<Options>;\n  readonly src: Readonly<Options>;\n  readonly stripComments: Readonly<Options>;\n  readonly suppressWarnings: Readonly<Options>;\n  readonly transpilationMode: Readonly<Options>;\n  readonly transformHtmlComments: Readonly<Options>;\n  readonly depsToTranspile: Readonly<Options>;\n  readonly verboseErrors: Readonly<Options>;\n  readonly writeManifest: Readonly<Options>;\n};\n\nexport enum TranspilationModes {\n  localAndDeps = 'localAndDeps',\n  localOnly = 'localOnly',\n  none = 'none',\n}\n\nconst builders: SnapsCliBuilders = {\n  bundle: {\n    alias: 'b',\n    describe: 'Snap bundle file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist/bundle.js',\n  },\n\n  dist: {\n    alias: 'd',\n    describe: 'Output directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist',\n  },\n\n  eval: {\n    alias: 'e',\n    describe: 'Attempt to evaluate Snap bundle in SES',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  manifest: {\n    alias: 'm',\n    describe: 'Validate snap.manifest.json',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    demandOption: true,\n    default: 8081,\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: ${arg}`);\n      }\n      return port;\n    },\n  },\n\n  outfileName: {\n    alias: 'n',\n    describe: 'Output file name',\n    type: 'string',\n    demandOption: false,\n    default: 'bundle.js',\n  },\n\n  root: {\n    alias: 'r',\n    describe: 'Server root directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: '.',\n  },\n\n  sourceMaps: {\n    describe: 'Whether builds include sourcemaps',\n    type: 'boolean',\n    demandOption: false,\n    default: false,\n  },\n\n  src: {\n    alias: 's',\n    describe: 'Source file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'src/index.js',\n  },\n\n  stripComments: {\n    alias: 'strip',\n    describe: 'Whether to remove code comments from the build output',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  suppressWarnings: {\n    type: 'boolean',\n    describe: 'Whether to suppress warnings',\n    demandOption: false,\n    default: false,\n  },\n\n  transpilationMode: {\n    type: 'string',\n    describe:\n      'Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing.',\n    demandOption: false,\n    default: TranspilationModes.localOnly,\n    choices: Object.values(TranspilationModes),\n  },\n\n  transformHtmlComments: {\n    type: 'boolean',\n    describe:\n      'Whether to break up HTML comment tokens wherever they appear in your source code.',\n    demandOption: true,\n    default: true,\n  },\n\n  depsToTranspile: {\n    type: 'array',\n    describe: 'Transpile only the listed dependencies.',\n    demandOption: false,\n  },\n\n  verboseErrors: {\n    type: 'boolean',\n    describe: 'Display original errors',\n    demandOption: false,\n    default: true,\n  },\n\n  writeManifest: {\n    describe: 'Make necessary changes to the Snap manifest file',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n};\n\nexport default builders;\n"]}
+{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;;AAuBA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;AAC3B,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB;AAED,MAAM,QAAQ,GAAqB;IACjC,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,gBAAgB;KAC1B;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM;KAChB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,CAAC,GAAY,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC;aACzC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF;IAED,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,WAAW;KACrB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,GAAG;KACb;IAED,UAAU,EAAE;QACV,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,cAAc;KACxB;IAED,aAAa,EAAE;QACb,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,uDAAuD;QACjE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,8BAA8B;QACxC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,iHAAiH;QACnH,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,kBAAkB,CAAC,SAAS;QACrC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;KAC3C;IAED,qBAAqB,EAAE;QACrB,IAAI,EAAE,SAAS;QACf,QAAQ,EACN,mFAAmF;QACrF,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;KACd;IAED,eAAe,EAAE;QACf,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,yCAAyC;QACnD,YAAY,EAAE,KAAK;KACpB;IAED,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,yBAAyB;QACnC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,aAAa,EAAE;QACb,QAAQ,EAAE,kDAAkD;QAC5D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,KAAK,EAAE;QACL,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,0DAA0D;QACpE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,YAAY,CAAC,UAAU;QAChC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;KACrC;CACF,CAAC;AAEF,kBAAe,QAAQ,CAAC","sourcesContent":["import { Options } from 'yargs';\n\nexport type SnapsCliBuilders = {\n  readonly bundle: Readonly<Options>;\n  readonly dist: Readonly<Options>;\n  readonly eval: Readonly<Options>;\n  readonly manifest: Readonly<Options>;\n  readonly outfileName: Readonly<Options>;\n  readonly port: Readonly<Options>;\n  readonly root: Readonly<Options>;\n  readonly sourceMaps: Readonly<Options>;\n  readonly src: Readonly<Options>;\n  readonly stripComments: Readonly<Options>;\n  readonly suppressWarnings: Readonly<Options>;\n  readonly transpilationMode: Readonly<Options>;\n  readonly transformHtmlComments: Readonly<Options>;\n  readonly depsToTranspile: Readonly<Options>;\n  readonly verboseErrors: Readonly<Options>;\n  readonly writeManifest: Readonly<Options>;\n  readonly serve: Readonly<Options>;\n  readonly template: Readonly<Options>;\n};\n\nexport enum TranspilationModes {\n  localAndDeps = 'localAndDeps',\n  localOnly = 'localOnly',\n  none = 'none',\n}\n\nexport enum TemplateType {\n  TypeScript = 'typescript',\n  JavaScript = 'javascript',\n}\n\nconst builders: SnapsCliBuilders = {\n  bundle: {\n    alias: 'b',\n    describe: 'Snap bundle file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist/bundle.js',\n  },\n\n  dist: {\n    alias: 'd',\n    describe: 'Output directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist',\n  },\n\n  eval: {\n    alias: 'e',\n    describe: 'Attempt to evaluate Snap bundle in SES',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  manifest: {\n    alias: 'm',\n    describe: 'Validate snap.manifest.json',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    demandOption: true,\n    default: 8081,\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: ${arg}`);\n      }\n      return port;\n    },\n  },\n\n  outfileName: {\n    alias: 'n',\n    describe: 'Output file name',\n    type: 'string',\n    demandOption: false,\n    default: 'bundle.js',\n  },\n\n  root: {\n    alias: 'r',\n    describe: 'Server root directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: '.',\n  },\n\n  sourceMaps: {\n    describe: 'Whether builds include sourcemaps',\n    type: 'boolean',\n    demandOption: false,\n    default: false,\n  },\n\n  src: {\n    alias: 's',\n    describe: 'Source file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'src/index.js',\n  },\n\n  stripComments: {\n    alias: 'strip',\n    describe: 'Whether to remove code comments from the build output',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  suppressWarnings: {\n    type: 'boolean',\n    describe: 'Whether to suppress warnings',\n    demandOption: false,\n    default: false,\n  },\n\n  transpilationMode: {\n    type: 'string',\n    describe:\n      'Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing.',\n    demandOption: false,\n    default: TranspilationModes.localOnly,\n    choices: Object.values(TranspilationModes),\n  },\n\n  transformHtmlComments: {\n    type: 'boolean',\n    describe:\n      'Whether to break up HTML comment tokens wherever they appear in your source code.',\n    demandOption: true,\n    default: true,\n  },\n\n  depsToTranspile: {\n    type: 'array',\n    describe: 'Transpile only the listed dependencies.',\n    demandOption: false,\n  },\n\n  verboseErrors: {\n    type: 'boolean',\n    describe: 'Display original errors',\n    demandOption: false,\n    default: true,\n  },\n\n  writeManifest: {\n    describe: 'Make necessary changes to the Snap manifest file',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  serve: {\n    describe: 'Serve Snap file(s) locally for testing',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  template: {\n    alias: 't',\n    describe: 'Specify which template to use (TypeScript or JavaScript)',\n    type: 'string',\n    demandOption: false,\n    default: TemplateType.TypeScript,\n    choices: Object.values(TemplateType),\n  },\n};\n\nexport default builders;\n"]}

package/dist/cli.d.ts

@@ -1 +1,8 @@
+/**
+ * The main CLI entry point function. This processes the command line args, and
+ * runs the appropriate function.
+ *
+ * @param argv - The raw command line arguments, i.e., `process.argv`.
+ * @param commands - The list of commands to use.
+ */
 export declare function cli(argv: string[], commands: any): void;

package/dist/cli.js

@@ -7,6 +7,13 @@ exports.cli = void 0;
 const yargs_1 = __importDefault(require("yargs"));
 const builders_1 = __importDefault(require("./builders"));
 const utils_1 = require("./utils");
+/**
+ * The main CLI entry point function. This processes the command line args, and
+ * runs the appropriate function.
+ *
+ * @param argv - The raw command line arguments, i.e., `process.argv`.
+ * @param commands - The list of commands to use.
+ */
 function cli(argv, commands) {
     const rawArgv = argv.slice(2);
     // eslint-disable-next-line @typescript-eslint/no-unused-expressions
@@ -14,6 +21,7 @@ function cli(argv, commands) {
         .scriptName('mm-snap')
         .usage('Usage: $0 <command> [options]')
         .example('$0 init', `\tInitialize a snap project in the current directory`)
+        .example('$0 init --template javascript', `\tInitialize a snap JavaScript project in the current directory`)
         .example('$0 build -s src/index.js -d out', `\tBuild 'src/index.js' as './out/bundle.js'`)
         .example('$0 build -s src/index.js -d out -n snap.js', `\tBuild 'src/index.js' as './out/snap.js'`)
         .example('$0 serve -r out', `\tServe files in './out' on port 8080`)

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyC;AAEzC,0DAAkC;AAClC,mCAMiB;AAEjB,SAAgB,GAAG,CAAC,IAAc,EAAE,QAAa;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,oEAAoE;IACpE,IAAA,eAAK,EAAC,OAAO,CAAC;SACX,UAAU,CAAC,SAAS,CAAC;SACrB,KAAK,CAAC,+BAA+B,CAAC;SAEtC,OAAO,CAAC,SAAS,EAAE,sDAAsD,CAAC;SAC1E,OAAO,CACN,iCAAiC,EACjC,6CAA6C,CAC9C;SACA,OAAO,CACN,4CAA4C,EAC5C,2CAA2C,CAC5C;SACA,OAAO,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;SACnE,OAAO,CAAC,yBAAyB,EAAE,uCAAuC,CAAC;SAC3E,OAAO,CACN,iCAAiC,EACjC,gGAAgG,CACjG;SAEA,OAAO,CAAC,QAAQ,CAAC;SAEjB,MAAM,CAAC,eAAe,EAAE,kBAAQ,CAAC,aAAa,CAAC;SAE/C,MAAM,CAAC,kBAAkB,EAAE,kBAAQ,CAAC,gBAAgB,CAAC;SAErD,MAAM,EAAE;QAET,gEAAgE;QAChE,+EAA+E;QAC/E,0FAA0F;SACzF,UAAU,CACT,CAAC,CAAC,SAAoB,EAAE,aAA+B,EAAE,EAAE;QACzD,IAAA,mBAAW,EAAC,IAAA,kBAAU,GAAE,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAC;QAC1B,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC,CAAQ,EACT,IAAI,CACL;SAEA,IAAI,CAAC,CAAC,GAAW,EAAE,GAAU,EAAE,MAAM,EAAE,EAAE;QACxC,IAAA,gBAAQ,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC;SAED,aAAa,CAAC,CAAC,EAAE,wCAAwC,CAAC;SAE1D,IAAI,EAAE;SACN,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC;AAC7B,CAAC;AApDD,kBAoDC","sourcesContent":["import yargs, { Arguments } from 'yargs';\nimport yargsType from 'yargs/yargs';\nimport builders from './builders';\nimport {\n  applyConfig,\n  loadConfig,\n  sanitizeInputs,\n  setSnapGlobals,\n  logError,\n} from './utils';\n\nexport function cli(argv: string[], commands: any): void {\n  const rawArgv = argv.slice(2);\n  // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n  yargs(rawArgv)\n    .scriptName('mm-snap')\n    .usage('Usage: $0 <command> [options]')\n\n    .example('$0 init', `\\tInitialize a snap project in the current directory`)\n    .example(\n      '$0 build -s src/index.js -d out',\n      `\\tBuild 'src/index.js' as './out/bundle.js'`,\n    )\n    .example(\n      '$0 build -s src/index.js -d out -n snap.js',\n      `\\tBuild 'src/index.js' as './out/snap.js'`,\n    )\n    .example('$0 serve -r out', `\\tServe files in './out' on port 8080`)\n    .example('$0 serve -r out -p 9000', `\\tServe files in './out' on port 9000`)\n    .example(\n      '$0 watch -s src/index.js -d out',\n      `\\tRebuild './out/bundle.js' on changes to files in 'src/index.js' parent and child directories`,\n    )\n\n    .command(commands)\n\n    .option('verboseErrors', builders.verboseErrors)\n\n    .option('suppressWarnings', builders.suppressWarnings)\n\n    .strict()\n\n    // Typecast: The @types/yargs type for .middleware is incorrect.\n    // yargs middleware functions receive the yargs instance as a second parameter.\n    // ref: https://yargs.js.org/docs/#api-reference-middlewarecallbacks-applybeforevalidation\n    .middleware(\n      ((yargsArgv: Arguments, yargsInstance: typeof yargsType) => {\n        applyConfig(loadConfig(), rawArgv, yargsArgv, yargsInstance);\n        setSnapGlobals(yargsArgv);\n        sanitizeInputs(yargsArgv);\n      }) as any,\n      true,\n    )\n\n    .fail((msg: string, err: Error, _yargs) => {\n      logError(msg, err);\n      process.exitCode = 1;\n    })\n\n    .demandCommand(1, 'You must specify at least one command.')\n\n    .help()\n    .alias('help', 'h').argv;\n}\n"]}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyC;AAEzC,0DAAkC;AAClC,mCAMiB;AAEjB;;;;;;GAMG;AACH,SAAgB,GAAG,CAAC,IAAc,EAAE,QAAa;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,oEAAoE;IACpE,IAAA,eAAK,EAAC,OAAO,CAAC;SACX,UAAU,CAAC,SAAS,CAAC;SACrB,KAAK,CAAC,+BAA+B,CAAC;SAEtC,OAAO,CAAC,SAAS,EAAE,sDAAsD,CAAC;SAC1E,OAAO,CACN,+BAA+B,EAC/B,iEAAiE,CAClE;SACA,OAAO,CACN,iCAAiC,EACjC,6CAA6C,CAC9C;SACA,OAAO,CACN,4CAA4C,EAC5C,2CAA2C,CAC5C;SACA,OAAO,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;SACnE,OAAO,CAAC,yBAAyB,EAAE,uCAAuC,CAAC;SAC3E,OAAO,CACN,iCAAiC,EACjC,gGAAgG,CACjG;SAEA,OAAO,CAAC,QAAQ,CAAC;SAEjB,MAAM,CAAC,eAAe,EAAE,kBAAQ,CAAC,aAAa,CAAC;SAE/C,MAAM,CAAC,kBAAkB,EAAE,kBAAQ,CAAC,gBAAgB,CAAC;SAErD,MAAM,EAAE;QAET,gEAAgE;QAChE,+EAA+E;QAC/E,0FAA0F;SACzF,UAAU,CACT,CAAC,CAAC,SAAoB,EAAE,aAA+B,EAAE,EAAE;QACzD,IAAA,mBAAW,EAAC,IAAA,kBAAU,GAAE,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAC;QAC1B,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC,CAAQ,EACT,IAAI,CACL;SAEA,IAAI,CAAC,CAAC,GAAW,EAAE,GAAU,EAAE,MAAM,EAAE,EAAE;QACxC,IAAA,gBAAQ,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC;SAED,aAAa,CAAC,CAAC,EAAE,wCAAwC,CAAC;SAE1D,IAAI,EAAE;SACN,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC;AAC7B,CAAC;AAxDD,kBAwDC","sourcesContent":["import yargs, { Arguments } from 'yargs';\nimport yargsType from 'yargs/yargs';\nimport builders from './builders';\nimport {\n  applyConfig,\n  loadConfig,\n  sanitizeInputs,\n  setSnapGlobals,\n  logError,\n} from './utils';\n\n/**\n * The main CLI entry point function. This processes the command line args, and\n * runs the appropriate function.\n *\n * @param argv - The raw command line arguments, i.e., `process.argv`.\n * @param commands - The list of commands to use.\n */\nexport function cli(argv: string[], commands: any): void {\n  const rawArgv = argv.slice(2);\n  // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n  yargs(rawArgv)\n    .scriptName('mm-snap')\n    .usage('Usage: $0 <command> [options]')\n\n    .example('$0 init', `\\tInitialize a snap project in the current directory`)\n    .example(\n      '$0 init --template javascript',\n      `\\tInitialize a snap JavaScript project in the current directory`,\n    )\n    .example(\n      '$0 build -s src/index.js -d out',\n      `\\tBuild 'src/index.js' as './out/bundle.js'`,\n    )\n    .example(\n      '$0 build -s src/index.js -d out -n snap.js',\n      `\\tBuild 'src/index.js' as './out/snap.js'`,\n    )\n    .example('$0 serve -r out', `\\tServe files in './out' on port 8080`)\n    .example('$0 serve -r out -p 9000', `\\tServe files in './out' on port 9000`)\n    .example(\n      '$0 watch -s src/index.js -d out',\n      `\\tRebuild './out/bundle.js' on changes to files in 'src/index.js' parent and child directories`,\n    )\n\n    .command(commands)\n\n    .option('verboseErrors', builders.verboseErrors)\n\n    .option('suppressWarnings', builders.suppressWarnings)\n\n    .strict()\n\n    // Typecast: The @types/yargs type for .middleware is incorrect.\n    // yargs middleware functions receive the yargs instance as a second parameter.\n    // ref: https://yargs.js.org/docs/#api-reference-middlewarecallbacks-applybeforevalidation\n    .middleware(\n      ((yargsArgv: Arguments, yargsInstance: typeof yargsType) => {\n        applyConfig(loadConfig(), rawArgv, yargsArgv, yargsInstance);\n        setSnapGlobals(yargsArgv);\n        sanitizeInputs(yargsArgv);\n      }) as any,\n      true,\n    )\n\n    .fail((msg: string, err: Error, _yargs) => {\n      logError(msg, err);\n      process.exitCode = 1;\n    })\n\n    .demandCommand(1, 'You must specify at least one command.')\n\n    .help()\n    .alias('help', 'h').argv;\n}\n"]}

package/dist/cmds/build/buildHandler.d.ts

@@ -5,9 +5,9 @@ import { YargsArgs } from '../../types/yargs';
  *
  * Creates destination directory if it doesn't exist.
  *
- * @param argv - argv from Yargs
- * @param argv.src - The source file path
- * @param argv.dist - The output directory path
- * @param argv.outfileName - The output file name
+ * @param argv - Argv from Yargs.
+ * @param argv.src - The source file path.
+ * @param argv.dist - The output directory path.
+ * @param argv.outfileName - The output file name.
  */
 export declare function build(argv: YargsArgs): Promise<void>;

package/dist/cmds/build/buildHandler.js

@@ -11,10 +11,10 @@ const bundle_1 = require("./bundle");
  *
  * Creates destination directory if it doesn't exist.
  *
- * @param argv - argv from Yargs
- * @param argv.src - The source file path
- * @param argv.dist - The output directory path
- * @param argv.outfileName - The output file name
+ * @param argv - Argv from Yargs.
+ * @param argv.src - The source file path.
+ * @param argv.dist - The output directory path.
+ * @param argv.outfileName - The output file name.
  */
 async function build(argv) {
     const { src, dist, outfileName } = argv;

package/dist/cmds/build/buildHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildHandler.js","sourceRoot":"","sources":["../../../src/cmds/build/buildHandler.ts"],"names":[],"mappings":";;;AACA,uCAMqB;AACrB,qDAA+C;AAC/C,iEAA8D;AAC9D,qCAAkC;AAElC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,WAAW,EAAE;QACf,IAAA,2BAAmB,EAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,IAAA,wBAAgB,EAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,IAAA,uBAAe,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAElC,MAAM,WAAW,GAAG,IAAA,sBAAc,EAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,MAAM,IAAA,eAAM,EACzB,GAAG,EACH,WAAW,EACX,IAAI,EACJ,IAAA,kBAAU,GAAE,CAAC,iBAAiB,CAC/B,CAAC;IACF,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE;QACvB,MAAM,IAAA,sBAAQ,EAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;KAClD;IAED,IAAI,IAAI,CAAC,QAAQ,EAAE;QACjB,MAAM,IAAA,iCAAe,EAAC,IAAI,CAAC,CAAC;KAC7B;AACH,CAAC;AAtBD,sBAsBC","sourcesContent":["import { YargsArgs } from '../../types/yargs';\nimport {\n  getOutfilePath,\n  loadConfig,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\nimport { snapEval } from '../eval/evalHandler';\nimport { manifestHandler } from '../manifest/manifestHandler';\nimport { bundle } from './bundle';\n\n/**\n * Builds all files in the given source directory to the given destination\n * directory.\n *\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - argv from Yargs\n * @param argv.src - The source file path\n * @param argv.dist - The output directory path\n * @param argv.outfileName - The output file name\n */\nexport async function build(argv: YargsArgs): Promise<void> {\n  const { src, dist, outfileName } = argv;\n  if (outfileName) {\n    validateOutfileName(outfileName as string);\n  }\n  await validateFilePath(src);\n  await validateDirPath(dist, true);\n\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n  const result = await bundle(\n    src,\n    outfilePath,\n    argv,\n    loadConfig().bundlerCustomizer,\n  );\n  if (result && argv.eval) {\n    await snapEval({ ...argv, bundle: outfilePath });\n  }\n\n  if (argv.manifest) {\n    await manifestHandler(argv);\n  }\n}\n"]}
+{"version":3,"file":"buildHandler.js","sourceRoot":"","sources":["../../../src/cmds/build/buildHandler.ts"],"names":[],"mappings":";;;AACA,uCAMqB;AACrB,qDAA+C;AAC/C,iEAA8D;AAC9D,qCAAkC;AAElC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,WAAW,EAAE;QACf,IAAA,2BAAmB,EAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,IAAA,wBAAgB,EAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,IAAA,uBAAe,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAElC,MAAM,WAAW,GAAG,IAAA,sBAAc,EAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,MAAM,IAAA,eAAM,EACzB,GAAG,EACH,WAAW,EACX,IAAI,EACJ,IAAA,kBAAU,GAAE,CAAC,iBAAiB,CAC/B,CAAC;IACF,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE;QACvB,MAAM,IAAA,sBAAQ,EAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;KAClD;IAED,IAAI,IAAI,CAAC,QAAQ,EAAE;QACjB,MAAM,IAAA,iCAAe,EAAC,IAAI,CAAC,CAAC;KAC7B;AACH,CAAC;AAtBD,sBAsBC","sourcesContent":["import { YargsArgs } from '../../types/yargs';\nimport {\n  getOutfilePath,\n  loadConfig,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\nimport { snapEval } from '../eval/evalHandler';\nimport { manifestHandler } from '../manifest/manifestHandler';\nimport { bundle } from './bundle';\n\n/**\n * Builds all files in the given source directory to the given destination\n * directory.\n *\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - Argv from Yargs.\n * @param argv.src - The source file path.\n * @param argv.dist - The output directory path.\n * @param argv.outfileName - The output file name.\n */\nexport async function build(argv: YargsArgs): Promise<void> {\n  const { src, dist, outfileName } = argv;\n  if (outfileName) {\n    validateOutfileName(outfileName as string);\n  }\n  await validateFilePath(src);\n  await validateDirPath(dist, true);\n\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n  const result = await bundle(\n    src,\n    outfilePath,\n    argv,\n    loadConfig().bundlerCustomizer,\n  );\n  if (result && argv.eval) {\n    await snapEval({ ...argv, bundle: outfilePath });\n  }\n\n  if (argv.manifest) {\n    await manifestHandler(argv);\n  }\n}\n"]}

package/dist/cmds/build/bundle.d.ts

@@ -6,10 +6,11 @@ import { YargsArgs } from '../../types/yargs';
  *
  * @param src - The source file path.
  * @param dest - The destination file path.
- * @param argv - arguments as an object generated by yargs.
+ * @param argv - Arguments as an object generated by `yargs`.
  * @param argv.sourceMaps - Whether to output sourcemaps.
  * @param argv.stripComments - Whether to remove comments from code.
  * @param argv.transpilationMode - The Babel transpilation mode.
- * @param bundlerTransform
+ * @param bundlerTransform - An optional function which can be used to transform
+ * the Browserify instance, e.g., adding a custom transform or plugin.
  */
 export declare function bundle(src: string, dest: string, argv: YargsArgs, bundlerTransform?: (bundler: BrowserifyObject) => void): Promise<boolean>;

package/dist/cmds/build/bundle.js

@@ -16,11 +16,12 @@ const utils_1 = require("./utils");
  *
  * @param src - The source file path.
  * @param dest - The destination file path.
- * @param argv - arguments as an object generated by yargs.
+ * @param argv - Arguments as an object generated by `yargs`.
  * @param argv.sourceMaps - Whether to output sourcemaps.
  * @param argv.stripComments - Whether to remove comments from code.
  * @param argv.transpilationMode - The Babel transpilation mode.
- * @param bundlerTransform
+ * @param bundlerTransform - An optional function which can be used to transform
+ * the Browserify instance, e.g., adding a custom transform or plugin.
  */
 function bundle(src, dest, argv, bundlerTransform) {
     const { sourceMaps: debug, transpilationMode } = argv;

package/dist/cmds/build/bundle.js.map

@@ -1 +1 @@
-{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../../../src/cmds/build/bundle.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA0D;AAC1D,gGAAuD;AACvD,6CAAoD;AAEpD,mCAA+D;AAE/D,+EAA+E;AAC/E,mEAAmE;AACnE,mHAAmH;AAEnH;;;;;;;;;;GAUG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,IAAY,EACZ,IAAe,EACf,gBAAsD;IAEtD,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACtD,MAAM,eAAe,GAAG,IAAA,2BAAmB,EAAC,IAAW,CAAC,CAAC;IACzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACtC,MAAM,OAAO,GAAG,IAAA,oBAAU,EAAC,GAAG,EAAE;YAC9B,KAAK;YACL,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YAC1B,wEAAwE;YACxE,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;QAEH,IAAI,iBAAiB,KAAK,6BAAkB,CAAC,IAAI,EAAE;YACjD,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBACrC,MAAM,EAAE,iBAAiB,KAAK,6BAAkB,CAAC,YAAY;gBAC7D,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;gBAC1B,OAAO,EAAE;oBACP,OAAO,CAAC,0BAA0B,CAAC;oBACnC;wBACE,OAAO,CAAC,mBAAmB,CAAC;wBAC5B;4BACE,OAAO,EAAE;gCACP,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,CAAC;6BAC5C;yBACF;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,OAAO,CAAC,iCAAiC,CAAC;oBAC1C,OAAO,CAAC,yCAAyC,CAAC;oBAClD,OAAO,CAAC,2CAA2C,CAAC;oBACpD,OAAO,CAAC,0CAA0C,CAAC;oBACnD,OAAO,CAAC,oDAAoD,CAAC;iBAC9D;gBACD,GAAI,eAAuB;aAC5B,CAAC,CAAC;SACJ;QAED,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC;QAE5B,OAAO,CAAC,MAAM,CAAC,iCAAM,EAAE;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;SAClD,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,CACZ,KAAK,EAAE,WAAW,EAAE,YAAoB,EAAE,EAAE,CAC1C,MAAM,IAAA,uBAAe,EAAC;YACpB,WAAW;YACX,YAAY;YACZ,GAAG;YACH,IAAI;YACJ,OAAO;SACR,CAAC,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AA5DD,wBA4DC","sourcesContent":["import browserify, { BrowserifyObject } from 'browserify';\nimport plugin from '@metamask/snaps-browserify-plugin';\nimport { TranspilationModes } from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { processDependencies, writeBundleFile } from './utils';\n\n// We need to statically import all Browserify transforms and all Babel presets\n// and plugins, and calling `require` is the sanest way to do that.\n/* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */\n\n/**\n * Builds a Snap bundle JS file from its JavaScript source.\n *\n * @param src - The source file path.\n * @param dest - The destination file path.\n * @param argv - arguments as an object generated by yargs.\n * @param argv.sourceMaps - Whether to output sourcemaps.\n * @param argv.stripComments - Whether to remove comments from code.\n * @param argv.transpilationMode - The Babel transpilation mode.\n * @param bundlerTransform\n */\nexport function bundle(\n  src: string,\n  dest: string,\n  argv: YargsArgs,\n  bundlerTransform?: (bundler: BrowserifyObject) => void,\n): Promise<boolean> {\n  const { sourceMaps: debug, transpilationMode } = argv;\n  const babelifyOptions = processDependencies(argv as any);\n  return new Promise((resolve, _reject) => {\n    const bundler = browserify(src, {\n      debug,\n      extensions: ['.js', '.ts'],\n      // Standalone is required to properly support Snaps using module.exports\n      standalone: '<snap>',\n    });\n\n    if (transpilationMode !== TranspilationModes.none) {\n      bundler.transform(require('babelify'), {\n        global: transpilationMode === TranspilationModes.localAndDeps,\n        extensions: ['.js', '.ts'],\n        presets: [\n          require('@babel/preset-typescript'),\n          [\n            require('@babel/preset-env'),\n            {\n              targets: {\n                browsers: ['chrome >= 66', 'firefox >= 68'],\n              },\n            },\n          ],\n        ],\n        plugins: [\n          require('@babel/plugin-transform-runtime'),\n          require('@babel/plugin-proposal-class-properties'),\n          require('@babel/plugin-proposal-object-rest-spread'),\n          require('@babel/plugin-proposal-optional-chaining'),\n          require('@babel/plugin-proposal-nullish-coalescing-operator'),\n        ],\n        ...(babelifyOptions as any),\n      });\n    }\n\n    bundlerTransform?.(bundler);\n\n    bundler.plugin(plugin, {\n      stripComments: argv.stripComments,\n      transformHtmlComments: argv.transformHtmlComments,\n    });\n\n    bundler.bundle(\n      async (bundleError, bundleBuffer: Buffer) =>\n        await writeBundleFile({\n          bundleError,\n          bundleBuffer,\n          src,\n          dest,\n          resolve,\n        }),\n    );\n  });\n}\n"]}
+{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../../../src/cmds/build/bundle.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA0D;AAC1D,gGAAuD;AACvD,6CAAoD;AAEpD,mCAA+D;AAE/D,+EAA+E;AAC/E,mEAAmE;AACnE,mHAAmH;AAEnH;;;;;;;;;;;GAWG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,IAAY,EACZ,IAAe,EACf,gBAAsD;IAEtD,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACtD,MAAM,eAAe,GAAG,IAAA,2BAAmB,EAAC,IAAW,CAAC,CAAC;IACzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACtC,MAAM,OAAO,GAAG,IAAA,oBAAU,EAAC,GAAG,EAAE;YAC9B,KAAK;YACL,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YAC1B,wEAAwE;YACxE,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;QAEH,IAAI,iBAAiB,KAAK,6BAAkB,CAAC,IAAI,EAAE;YACjD,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBACrC,MAAM,EAAE,iBAAiB,KAAK,6BAAkB,CAAC,YAAY;gBAC7D,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;gBAC1B,OAAO,EAAE;oBACP,OAAO,CAAC,0BAA0B,CAAC;oBACnC;wBACE,OAAO,CAAC,mBAAmB,CAAC;wBAC5B;4BACE,OAAO,EAAE;gCACP,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,CAAC;6BAC5C;yBACF;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,OAAO,CAAC,iCAAiC,CAAC;oBAC1C,OAAO,CAAC,yCAAyC,CAAC;oBAClD,OAAO,CAAC,2CAA2C,CAAC;oBACpD,OAAO,CAAC,0CAA0C,CAAC;oBACnD,OAAO,CAAC,oDAAoD,CAAC;iBAC9D;gBACD,GAAI,eAAuB;aAC5B,CAAC,CAAC;SACJ;QAED,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC;QAE5B,OAAO,CAAC,MAAM,CAAC,iCAAM,EAAE;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;SAClD,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,CACZ,KAAK,EAAE,WAAW,EAAE,YAAoB,EAAE,EAAE,CAC1C,MAAM,IAAA,uBAAe,EAAC;YACpB,WAAW;YACX,YAAY;YACZ,GAAG;YACH,IAAI;YACJ,OAAO;SACR,CAAC,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AA5DD,wBA4DC","sourcesContent":["import browserify, { BrowserifyObject } from 'browserify';\nimport plugin from '@metamask/snaps-browserify-plugin';\nimport { TranspilationModes } from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { processDependencies, writeBundleFile } from './utils';\n\n// We need to statically import all Browserify transforms and all Babel presets\n// and plugins, and calling `require` is the sanest way to do that.\n/* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */\n\n/**\n * Builds a Snap bundle JS file from its JavaScript source.\n *\n * @param src - The source file path.\n * @param dest - The destination file path.\n * @param argv - Arguments as an object generated by `yargs`.\n * @param argv.sourceMaps - Whether to output sourcemaps.\n * @param argv.stripComments - Whether to remove comments from code.\n * @param argv.transpilationMode - The Babel transpilation mode.\n * @param bundlerTransform - An optional function which can be used to transform\n * the Browserify instance, e.g., adding a custom transform or plugin.\n */\nexport function bundle(\n  src: string,\n  dest: string,\n  argv: YargsArgs,\n  bundlerTransform?: (bundler: BrowserifyObject) => void,\n): Promise<boolean> {\n  const { sourceMaps: debug, transpilationMode } = argv;\n  const babelifyOptions = processDependencies(argv as any);\n  return new Promise((resolve, _reject) => {\n    const bundler = browserify(src, {\n      debug,\n      extensions: ['.js', '.ts'],\n      // Standalone is required to properly support Snaps using module.exports\n      standalone: '<snap>',\n    });\n\n    if (transpilationMode !== TranspilationModes.none) {\n      bundler.transform(require('babelify'), {\n        global: transpilationMode === TranspilationModes.localAndDeps,\n        extensions: ['.js', '.ts'],\n        presets: [\n          require('@babel/preset-typescript'),\n          [\n            require('@babel/preset-env'),\n            {\n              targets: {\n                browsers: ['chrome >= 66', 'firefox >= 68'],\n              },\n            },\n          ],\n        ],\n        plugins: [\n          require('@babel/plugin-transform-runtime'),\n          require('@babel/plugin-proposal-class-properties'),\n          require('@babel/plugin-proposal-object-rest-spread'),\n          require('@babel/plugin-proposal-optional-chaining'),\n          require('@babel/plugin-proposal-nullish-coalescing-operator'),\n        ],\n        ...(babelifyOptions as any),\n      });\n    }\n\n    bundlerTransform?.(bundler);\n\n    bundler.plugin(plugin, {\n      stripComments: argv.stripComments,\n      transformHtmlComments: argv.transformHtmlComments,\n    });\n\n    bundler.bundle(\n      async (bundleError, bundleBuffer: Buffer) =>\n        await writeBundleFile({\n          bundleError,\n          bundleBuffer,\n          src,\n          dest,\n          resolve,\n        }),\n    );\n  });\n}\n"]}

package/dist/cmds/build/utils.d.ts

@@ -23,21 +23,34 @@ declare type WriteBundleFileArgs = {
  */
 export declare function writeBundleFile({ bundleError, bundleBuffer, src, dest, resolve, }: WriteBundleFileArgs): Promise<void>;
 /**
- * Processes dependencies and updates argv with an options object
- * @param argv
+ * Processes dependencies and updates `argv` with an options object.
+ *
+ * @param argv - The Yargs arguments object.
+ * @returns An object with options that can be passed to Babelify.
  */
 export declare function processDependencies(argv: YargsArgs): Record<string, any>;
 /**
- * Processes a string of space delimited dependencies into one regex string
- * @param dependencies
- * @returns a regexp string
+ * Processes a string of space delimited dependencies into one RegExp string.
+ *
+ * @param dependencies - An array of dependencies to add to the RegExp.
+ * @returns A RegExp object.
  */
 export declare function getDependencyRegExp(dependencies: string[]): RegExp | null;
 /**
- * Helper function remove any leading and trailing slashes from dependency list
- * @param dependencies
- * @returns an array of sanitized paths
+ * Helper function remove any leading and trailing slashes from dependency list.
+ *
+ * @param dependencies - An array of dependencies to sanitize.
+ * @returns An array of sanitized paths.
  */
 export declare function sanitizeDependencyPaths(dependencies: string[]): string[];
+/**
+ * Check the Yargs argv object, to see if the provided options are valid. The
+ * options are invalid if both `depsToTranspile` are provided, and
+ * `transpilationMode` is not set to `localAndDeps`.
+ *
+ * @param argv - The Yargs arguments object.
+ * @throws If the `depsToTranspile` is set, and `transpilationMode` is not set
+ * to `localAndDeps`.
+ */
 export declare function processInvalidTranspilation(argv: YargsArgs): void;
 export {};

package/dist/cmds/build/utils.js

@@ -33,8 +33,10 @@ async function writeBundleFile({ bundleError, bundleBuffer, src, dest, resolve,
 }
 exports.writeBundleFile = writeBundleFile;
 /**
- * Processes dependencies and updates argv with an options object
- * @param argv
+ * Processes dependencies and updates `argv` with an options object.
+ *
+ * @param argv - The Yargs arguments object.
+ * @returns An object with options that can be passed to Babelify.
  */
 function processDependencies(argv) {
     const { depsToTranspile, transpilationMode } = argv;
@@ -49,9 +51,10 @@ function processDependencies(argv) {
 }
 exports.processDependencies = processDependencies;
 /**
- * Processes a string of space delimited dependencies into one regex string
- * @param dependencies
- * @returns a regexp string
+ * Processes a string of space delimited dependencies into one RegExp string.
+ *
+ * @param dependencies - An array of dependencies to add to the RegExp.
+ * @returns A RegExp object.
  */
 function getDependencyRegExp(dependencies) {
     let regexp = null;
@@ -66,9 +69,10 @@ function getDependencyRegExp(dependencies) {
 }
 exports.getDependencyRegExp = getDependencyRegExp;
 /**
- * Helper function remove any leading and trailing slashes from dependency list
- * @param dependencies
- * @returns an array of sanitized paths
+ * Helper function remove any leading and trailing slashes from dependency list.
+ *
+ * @param dependencies - An array of dependencies to sanitize.
+ * @returns An array of sanitized paths.
  */
 function sanitizeDependencyPaths(dependencies) {
     return dependencies.map((dependency) => {
@@ -76,6 +80,15 @@ function sanitizeDependencyPaths(dependencies) {
     });
 }
 exports.sanitizeDependencyPaths = sanitizeDependencyPaths;
+/**
+ * Check the Yargs argv object, to see if the provided options are valid. The
+ * options are invalid if both `depsToTranspile` are provided, and
+ * `transpilationMode` is not set to `localAndDeps`.
+ *
+ * @param argv - The Yargs arguments object.
+ * @throws If the `depsToTranspile` is set, and `transpilationMode` is not set
+ * to `localAndDeps`.
+ */
 function processInvalidTranspilation(argv) {
     if (argv.depsToTranspile &&
         argv.transpilationMode !== builders_1.TranspilationModes.localAndDeps) {

package/dist/cmds/build/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/cmds/build/utils.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AACpC,2CAA8C;AAE9C,6CAAoD;AAUpD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,eAAe,CAAC,EACpC,WAAW,EACX,YAAY,EACZ,GAAG,EACH,IAAI,EACJ,OAAO,GACa;IACpB,IAAI,WAAW,EAAE;QACf,MAAM,IAAA,iBAAU,EAAC,cAAc,EAAE,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;KACpE;IAED,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,iBAAiB,IAAI,IAAI,CAAC,CAAC;QAC7D,OAAO,CAAC,IAAI,CAAC,CAAC;KACf;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,iBAAU,EAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;KAC9D;AACH,CAAC;AAlBD,0CAkBC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,IAAe;IACjD,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACpD,MAAM,eAAe,GAAwB,EAAE,CAAC;IAChD,IAAI,iBAAiB,KAAK,6BAAkB,CAAC,YAAY,EAAE;QACzD,MAAM,SAAS,GAAG,mBAAmB,CAAC,eAA2B,CAAC,CAAC;QACnE,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,eAAe,CAAC,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC;SACtC;KACF;IACD,OAAO,eAAe,CAAC;AACzB,CAAC;AAVD,kDAUC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,YAAsB;IACxD,IAAI,MAAM,GAAkB,IAAI,CAAC;IACjC,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QACvE,OAAO,MAAM,CAAC;KACf;IACD,MAAM,KAAK,GAAa,uBAAuB,CAAC,YAAY,CAAC,CAAC;IAC9D,MAAM,GAAG,oBAAoB,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;IAC7C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IAChD,MAAM,IAAI,IAAI,CAAC;IACf,OAAO,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7B,CAAC;AAVD,kDAUC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,YAAsB;IAC5D,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QACrC,OAAO,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,0DAIC;AAED,SAAgB,2BAA2B,CAAC,IAAe;IACzD,IACE,IAAI,CAAC,eAAe;QACpB,IAAI,CAAC,iBAAiB,KAAK,6BAAkB,CAAC,YAAY,EAC1D;QACA,MAAM,IAAI,KAAK,CACb,2FAA2F,CAC5F,CAAC;KACH;AACH,CAAC;AATD,kEASC","sourcesContent":["import { promises as fs } from 'fs';\nimport { writeError } from '../../utils/misc';\nimport { YargsArgs } from '../../types/yargs';\nimport { TranspilationModes } from '../../builders';\n\ntype WriteBundleFileArgs = {\n  bundleError: Error;\n  bundleBuffer: Buffer;\n  src: string;\n  dest: string;\n  resolve: (value: boolean) => void;\n};\n\n/**\n * Performs postprocessing on the bundle contents and writes them to disk.\n * Intended to be used in the callback passed to the Browserify `.bundle()`\n * call.\n *\n * @param options - Options bag.\n * @param options.bundleError - Any error received from Browserify.\n * @param options.bundleBuffer - The {@link Buffer} with the bundle contents\n * from Browserify.\n * @param options.src - The source file path.\n * @param options.dest - The destination file path.\n * @param options.resolve - A {@link Promise} resolution function, so that we\n * can use promises and `async`/`await` even though Browserify uses callbacks.\n */\nexport async function writeBundleFile({\n  bundleError,\n  bundleBuffer,\n  src,\n  dest,\n  resolve,\n}: WriteBundleFileArgs) {\n  if (bundleError) {\n    await writeError('Build error:', bundleError.message, bundleError);\n  }\n\n  try {\n    await fs.writeFile(dest, bundleBuffer?.toString());\n    console.log(`Build success: '${src}' bundled as '${dest}'!`);\n    resolve(true);\n  } catch (error) {\n    await writeError('Write error:', error.message, error, dest);\n  }\n}\n\n/**\n * Processes dependencies and updates argv with an options object\n * @param argv\n */\nexport function processDependencies(argv: YargsArgs) {\n  const { depsToTranspile, transpilationMode } = argv;\n  const babelifyOptions: Record<string, any> = {};\n  if (transpilationMode === TranspilationModes.localAndDeps) {\n    const regexpStr = getDependencyRegExp(depsToTranspile as string[]);\n    if (regexpStr !== null) {\n      babelifyOptions.ignore = [regexpStr];\n    }\n  }\n  return babelifyOptions;\n}\n\n/**\n * Processes a string of space delimited dependencies into one regex string\n * @param dependencies\n * @returns a regexp string\n */\nexport function getDependencyRegExp(dependencies: string[]): RegExp | null {\n  let regexp: string | null = null;\n  if (!dependencies || dependencies.includes('.') || !dependencies.length) {\n    return regexp;\n  }\n  const paths: string[] = sanitizeDependencyPaths(dependencies);\n  regexp = `/node_modules/(?!${paths.shift()}`;\n  paths.forEach((path) => (regexp += `|${path}`));\n  regexp += '/)';\n  return RegExp(regexp, 'u');\n}\n\n/**\n * Helper function remove any leading and trailing slashes from dependency list\n * @param dependencies\n * @returns an array of sanitized paths\n */\nexport function sanitizeDependencyPaths(dependencies: string[]): string[] {\n  return dependencies.map((dependency) => {\n    return dependency.replace(/^[/\\\\]+/u, '').replace(/[/\\\\]+$/u, '');\n  });\n}\n\nexport function processInvalidTranspilation(argv: YargsArgs) {\n  if (\n    argv.depsToTranspile &&\n    argv.transpilationMode !== TranspilationModes.localAndDeps\n  ) {\n    throw new Error(\n      '\"depsToTranspile\" can only be specified if \"transpilationMode\" is set to \"localAndDeps\" .',\n    );\n  }\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/cmds/build/utils.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AACpC,2CAA8C;AAE9C,6CAAoD;AAUpD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,eAAe,CAAC,EACpC,WAAW,EACX,YAAY,EACZ,GAAG,EACH,IAAI,EACJ,OAAO,GACa;IACpB,IAAI,WAAW,EAAE;QACf,MAAM,IAAA,iBAAU,EAAC,cAAc,EAAE,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;KACpE;IAED,IAAI;QACF,MAAM,aAAE,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,mBAAmB,GAAG,iBAAiB,IAAI,IAAI,CAAC,CAAC;QAC7D,OAAO,CAAC,IAAI,CAAC,CAAC;KACf;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,iBAAU,EAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;KAC9D;AACH,CAAC;AAlBD,0CAkBC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,IAAe;IACjD,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACpD,MAAM,eAAe,GAAwB,EAAE,CAAC;IAChD,IAAI,iBAAiB,KAAK,6BAAkB,CAAC,YAAY,EAAE;QACzD,MAAM,SAAS,GAAG,mBAAmB,CAAC,eAA2B,CAAC,CAAC;QACnE,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,eAAe,CAAC,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC;SACtC;KACF;IACD,OAAO,eAAe,CAAC;AACzB,CAAC;AAVD,kDAUC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,YAAsB;IACxD,IAAI,MAAM,GAAkB,IAAI,CAAC;IACjC,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QACvE,OAAO,MAAM,CAAC;KACf;IACD,MAAM,KAAK,GAAa,uBAAuB,CAAC,YAAY,CAAC,CAAC;IAC9D,MAAM,GAAG,oBAAoB,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;IAC7C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IAChD,MAAM,IAAI,IAAI,CAAC;IACf,OAAO,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7B,CAAC;AAVD,kDAUC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,YAAsB;IAC5D,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QACrC,OAAO,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,0DAIC;AAED;;;;;;;;GAQG;AACH,SAAgB,2BAA2B,CAAC,IAAe;IACzD,IACE,IAAI,CAAC,eAAe;QACpB,IAAI,CAAC,iBAAiB,KAAK,6BAAkB,CAAC,YAAY,EAC1D;QACA,MAAM,IAAI,KAAK,CACb,2FAA2F,CAC5F,CAAC;KACH;AACH,CAAC;AATD,kEASC","sourcesContent":["import { promises as fs } from 'fs';\nimport { writeError } from '../../utils/misc';\nimport { YargsArgs } from '../../types/yargs';\nimport { TranspilationModes } from '../../builders';\n\ntype WriteBundleFileArgs = {\n  bundleError: Error;\n  bundleBuffer: Buffer;\n  src: string;\n  dest: string;\n  resolve: (value: boolean) => void;\n};\n\n/**\n * Performs postprocessing on the bundle contents and writes them to disk.\n * Intended to be used in the callback passed to the Browserify `.bundle()`\n * call.\n *\n * @param options - Options bag.\n * @param options.bundleError - Any error received from Browserify.\n * @param options.bundleBuffer - The {@link Buffer} with the bundle contents\n * from Browserify.\n * @param options.src - The source file path.\n * @param options.dest - The destination file path.\n * @param options.resolve - A {@link Promise} resolution function, so that we\n * can use promises and `async`/`await` even though Browserify uses callbacks.\n */\nexport async function writeBundleFile({\n  bundleError,\n  bundleBuffer,\n  src,\n  dest,\n  resolve,\n}: WriteBundleFileArgs) {\n  if (bundleError) {\n    await writeError('Build error:', bundleError.message, bundleError);\n  }\n\n  try {\n    await fs.writeFile(dest, bundleBuffer?.toString());\n    console.log(`Build success: '${src}' bundled as '${dest}'!`);\n    resolve(true);\n  } catch (error) {\n    await writeError('Write error:', error.message, error, dest);\n  }\n}\n\n/**\n * Processes dependencies and updates `argv` with an options object.\n *\n * @param argv - The Yargs arguments object.\n * @returns An object with options that can be passed to Babelify.\n */\nexport function processDependencies(argv: YargsArgs) {\n  const { depsToTranspile, transpilationMode } = argv;\n  const babelifyOptions: Record<string, any> = {};\n  if (transpilationMode === TranspilationModes.localAndDeps) {\n    const regexpStr = getDependencyRegExp(depsToTranspile as string[]);\n    if (regexpStr !== null) {\n      babelifyOptions.ignore = [regexpStr];\n    }\n  }\n  return babelifyOptions;\n}\n\n/**\n * Processes a string of space delimited dependencies into one RegExp string.\n *\n * @param dependencies - An array of dependencies to add to the RegExp.\n * @returns A RegExp object.\n */\nexport function getDependencyRegExp(dependencies: string[]): RegExp | null {\n  let regexp: string | null = null;\n  if (!dependencies || dependencies.includes('.') || !dependencies.length) {\n    return regexp;\n  }\n  const paths: string[] = sanitizeDependencyPaths(dependencies);\n  regexp = `/node_modules/(?!${paths.shift()}`;\n  paths.forEach((path) => (regexp += `|${path}`));\n  regexp += '/)';\n  return RegExp(regexp, 'u');\n}\n\n/**\n * Helper function remove any leading and trailing slashes from dependency list.\n *\n * @param dependencies - An array of dependencies to sanitize.\n * @returns An array of sanitized paths.\n */\nexport function sanitizeDependencyPaths(dependencies: string[]): string[] {\n  return dependencies.map((dependency) => {\n    return dependency.replace(/^[/\\\\]+/u, '').replace(/[/\\\\]+$/u, '');\n  });\n}\n\n/**\n * Check the Yargs argv object, to see if the provided options are valid. The\n * options are invalid if both `depsToTranspile` are provided, and\n * `transpilationMode` is not set to `localAndDeps`.\n *\n * @param argv - The Yargs arguments object.\n * @throws If the `depsToTranspile` is set, and `transpilationMode` is not set\n * to `localAndDeps`.\n */\nexport function processInvalidTranspilation(argv: YargsArgs) {\n  if (\n    argv.depsToTranspile &&\n    argv.transpilationMode !== TranspilationModes.localAndDeps\n  ) {\n    throw new Error(\n      '\"depsToTranspile\" can only be specified if \"transpilationMode\" is set to \"localAndDeps\" .',\n    );\n  }\n}\n"]}

package/dist/cmds/eval/eval-worker.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 // eslint-disable-next-line import/no-unassigned-import
 require("ses/lockdown");
-const worker_threads_1 = require("worker_threads");
 const mock_1 = require("./mock");
 lockdown({
     consoleTaming: 'unsafe',
@@ -12,21 +11,13 @@ lockdown({
     dateTaming: 'unsafe',
     overrideTaming: 'severe',
 });
-if (worker_threads_1.parentPort !== null) {
-    worker_threads_1.parentPort.on('message', (message) => {
-        const { snapFilePath } = message;
-        const snapModule = { exports: {} };
-        new Compartment({
-            ...getMockEndowments(),
-            module: snapModule,
-            exports: snapModule.exports,
-        }).evaluate((0, fs_1.readFileSync)(snapFilePath, 'utf8'));
-        if (!snapModule.exports?.onRpcRequest) {
-            console.warn("The Snap doesn't have onRpcRequest export defined");
-        }
-        setTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits
-    });
-}
+/**
+ * Get mock endowments that don't do anything. This is useful for running the
+ * eval, for snaps that try to communicate with the extension on initialisation,
+ * for example.
+ *
+ * @returns The mock endowments.
+ */
 function getMockEndowments() {
     const endowments = (0, mock_1.generateMockEndowments)();
     return {
@@ -35,4 +26,15 @@ function getMockEndowments() {
         self: endowments,
     };
 }
+const snapFilePath = process.argv[2];
+const snapModule = { exports: {} };
+new Compartment({
+    ...getMockEndowments(),
+    module: snapModule,
+    exports: snapModule.exports,
+}).evaluate((0, fs_1.readFileSync)(snapFilePath, 'utf8'));
+if (!snapModule.exports?.onRpcRequest) {
+    console.warn(`The Snap doesn't have an "onRpcRequest" export defined.`);
+}
+setTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits
 //# sourceMappingURL=eval-worker.js.map

package/dist/cmds/eval/eval-worker.js.map

@@ -1 +1 @@
-{"version":3,"file":"eval-worker.js","sourceRoot":"","sources":["../../../src/cmds/eval/eval-worker.ts"],"names":[],"mappings":";;AAAA,2BAAkC;AAClC,uDAAuD;AACvD,wBAAsB;AACtB,mDAA4C;AAC5C,iCAAgD;AAIhD,QAAQ,CAAC;IACP,aAAa,EAAE,QAAQ;IACvB,WAAW,EAAE,QAAQ;IACrB,UAAU,EAAE,QAAQ;IACpB,UAAU,EAAE,QAAQ;IACpB,cAAc,EAAE,QAAQ;CACzB,CAAC,CAAC;AAEH,IAAI,2BAAU,KAAK,IAAI,EAAE;IACvB,2BAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAiC,EAAE,EAAE;QAC7D,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QAEjC,MAAM,UAAU,GAAsB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAEtD,IAAI,WAAW,CAAC;YACd,GAAG,iBAAiB,EAAE;YACtB,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,UAAU,CAAC,OAAO;SAC5B,CAAC,CAAC,QAAQ,CAAC,IAAA,iBAAY,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;QAEhD,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE;YACrC,OAAO,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;SACnE;QAED,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAA8B;IACzE,CAAC,CAAC,CAAC;CACJ;AAED,SAAS,iBAAiB;IACxB,MAAM,UAAU,GAAG,IAAA,6BAAsB,GAAE,CAAC;IAC5C,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,UAAU;QAClB,IAAI,EAAE,UAAU;KACjB,CAAC;AACJ,CAAC","sourcesContent":["import { readFileSync } from 'fs';\n// eslint-disable-next-line import/no-unassigned-import\nimport 'ses/lockdown';\nimport { parentPort } from 'worker_threads';\nimport { generateMockEndowments } from './mock';\n\ndeclare let lockdown: any, Compartment: any;\n\nlockdown({\n  consoleTaming: 'unsafe',\n  errorTaming: 'unsafe',\n  mathTaming: 'unsafe',\n  dateTaming: 'unsafe',\n  overrideTaming: 'severe',\n});\n\nif (parentPort !== null) {\n  parentPort.on('message', (message: { snapFilePath: string }) => {\n    const { snapFilePath } = message;\n\n    const snapModule: { exports?: any } = { exports: {} };\n\n    new Compartment({\n      ...getMockEndowments(),\n      module: snapModule,\n      exports: snapModule.exports,\n    }).evaluate(readFileSync(snapFilePath, 'utf8'));\n\n    if (!snapModule.exports?.onRpcRequest) {\n      console.warn(\"The Snap doesn't have onRpcRequest export defined\");\n    }\n\n    setTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits\n  });\n}\n\nfunction getMockEndowments() {\n  const endowments = generateMockEndowments();\n  return {\n    ...endowments,\n    window: endowments,\n    self: endowments,\n  };\n}\n"]}
+{"version":3,"file":"eval-worker.js","sourceRoot":"","sources":["../../../src/cmds/eval/eval-worker.ts"],"names":[],"mappings":";;AAAA,2BAAkC;AAClC,uDAAuD;AACvD,wBAAsB;AACtB,iCAAgD;AAIhD,QAAQ,CAAC;IACP,aAAa,EAAE,QAAQ;IACvB,WAAW,EAAE,QAAQ;IACrB,UAAU,EAAE,QAAQ;IACpB,UAAU,EAAE,QAAQ;IACpB,cAAc,EAAE,QAAQ;CACzB,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,SAAS,iBAAiB;IACxB,MAAM,UAAU,GAAG,IAAA,6BAAsB,GAAE,CAAC;IAC5C,OAAO;QACL,GAAG,UAAU;QACb,MAAM,EAAE,UAAU;QAClB,IAAI,EAAE,UAAU;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAErC,MAAM,UAAU,GAAsB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAEtD,IAAI,WAAW,CAAC;IACd,GAAG,iBAAiB,EAAE;IACtB,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,UAAU,CAAC,OAAO;CAC5B,CAAC,CAAC,QAAQ,CAAC,IAAA,iBAAY,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;AAEhD,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE;IACrC,OAAO,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;CACzE;AAED,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAA8B","sourcesContent":["import { readFileSync } from 'fs';\n// eslint-disable-next-line import/no-unassigned-import\nimport 'ses/lockdown';\nimport { generateMockEndowments } from './mock';\n\ndeclare let lockdown: any, Compartment: any;\n\nlockdown({\n  consoleTaming: 'unsafe',\n  errorTaming: 'unsafe',\n  mathTaming: 'unsafe',\n  dateTaming: 'unsafe',\n  overrideTaming: 'severe',\n});\n\n/**\n * Get mock endowments that don't do anything. This is useful for running the\n * eval, for snaps that try to communicate with the extension on initialisation,\n * for example.\n *\n * @returns The mock endowments.\n */\nfunction getMockEndowments() {\n  const endowments = generateMockEndowments();\n  return {\n    ...endowments,\n    window: endowments,\n    self: endowments,\n  };\n}\n\nconst snapFilePath = process.argv[2];\n\nconst snapModule: { exports?: any } = { exports: {} };\n\nnew Compartment({\n  ...getMockEndowments(),\n  module: snapModule,\n  exports: snapModule.exports,\n}).evaluate(readFileSync(snapFilePath, 'utf8'));\n\nif (!snapModule.exports?.onRpcRequest) {\n  console.warn(`The Snap doesn't have an \"onRpcRequest\" export defined.`);\n}\n\nsetTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits\n"]}

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

@@ -1,2 +1,9 @@
 import { YargsArgs } from '../../types/yargs';
+/**
+ * Runs the snap in a worker, to ensure SES compatibility.
+ *
+ * @param argv - The Yargs arguments object.
+ * @returns A promise that resolves once the eval has finished.
+ * @throws If the eval failed.
+ */
 export declare function snapEval(argv: YargsArgs): Promise<void>;

package/dist/cmds/eval/evalHandler.js

@@ -3,6 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.snapEval = void 0;
 const utils_1 = require("../../utils");
 const workerEval_1 = require("./workerEval");
+/**
+ * Runs the snap in a worker, to ensure SES compatibility.
+ *
+ * @param argv - The Yargs arguments object.
+ * @returns A promise that resolves once the eval has finished.
+ * @throws If the eval failed.
+ */
 async function snapEval(argv) {
     const { bundle: bundlePath } = argv;
     await (0, utils_1.validateFilePath)(bundlePath);

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

@@ -1 +1 @@
-{"version":3,"file":"evalHandler.js","sourceRoot":"","sources":["../../../src/cmds/eval/evalHandler.ts"],"names":[],"mappings":";;;AACA,uCAAyD;AACzD,6CAA0C;AAEnC,KAAK,UAAU,QAAQ,CAAC,IAAe;IAC5C,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACpC,MAAM,IAAA,wBAAgB,EAAC,UAAoB,CAAC,CAAC;IAC7C,IAAI;QACF,MAAM,IAAA,uBAAU,EAAC,UAAoB,CAAC,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,4BAA4B,UAAU,WAAW,CAAC,CAAC;KAChE;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,0BAA0B,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAVD,4BAUC","sourcesContent":["import { YargsArgs } from '../../types/yargs';\nimport { logError, validateFilePath } from '../../utils';\nimport { workerEval } from './workerEval';\n\nexport async function snapEval(argv: YargsArgs): Promise<void> {\n  const { bundle: bundlePath } = argv;\n  await validateFilePath(bundlePath as string);\n  try {\n    await workerEval(bundlePath as string);\n    console.log(`Eval Success: evaluated '${bundlePath}' in SES!`);\n  } catch (err) {\n    logError(`Snap evaluation error: ${err.message}`, err);\n    throw err;\n  }\n}\n"]}
+{"version":3,"file":"evalHandler.js","sourceRoot":"","sources":["../../../src/cmds/eval/evalHandler.ts"],"names":[],"mappings":";;;AACA,uCAAyD;AACzD,6CAA0C;AAE1C;;;;;;GAMG;AACI,KAAK,UAAU,QAAQ,CAAC,IAAe;IAC5C,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACpC,MAAM,IAAA,wBAAgB,EAAC,UAAoB,CAAC,CAAC;IAC7C,IAAI;QACF,MAAM,IAAA,uBAAU,EAAC,UAAoB,CAAC,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,4BAA4B,UAAU,WAAW,CAAC,CAAC;KAChE;IAAC,OAAO,GAAG,EAAE;QACZ,IAAA,gBAAQ,EAAC,0BAA0B,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;QACvD,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAVD,4BAUC","sourcesContent":["import { YargsArgs } from '../../types/yargs';\nimport { logError, validateFilePath } from '../../utils';\nimport { workerEval } from './workerEval';\n\n/**\n * Runs the snap in a worker, to ensure SES compatibility.\n *\n * @param argv - The Yargs arguments object.\n * @returns A promise that resolves once the eval has finished.\n * @throws If the eval failed.\n */\nexport async function snapEval(argv: YargsArgs): Promise<void> {\n  const { bundle: bundlePath } = argv;\n  await validateFilePath(bundlePath as string);\n  try {\n    await workerEval(bundlePath as string);\n    console.log(`Eval Success: evaluated '${bundlePath}' in SES!`);\n  } catch (err) {\n    logError(`Snap evaluation error: ${err.message}`, err);\n    throw err;\n  }\n}\n"]}

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

@@ -1,3 +1,14 @@
 export declare const ALL_APIS: 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.
+ */
 export declare const isConstructor: (value: any) => boolean;
+/**
+ * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
+ *
+ * @returns A map of endowments.
+ */
 export declare const generateMockEndowments: () => Record<string, any>;

package/dist/cmds/eval/mock.js

@@ -9,13 +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.request = async () => true;
     return mockProvider;
 }
+/**
+ * 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) => Boolean(typeof value?.prototype?.constructor?.name === 'string');
 exports.isConstructor = isConstructor;
+/**
+ * A function that always returns `true`.
+ *
+ * @returns `true`.
+ */
 const mockFunction = () => true;
 class MockClass {
 }
@@ -27,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);
 };
@@ -36,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
@@ -55,6 +86,11 @@ 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() });
 };

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,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.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,CAC1C,OAAO,CAAC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,QAAQ,CAAC,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,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;AAEF;;;;GAIG;AACI,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  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>;