@metamask/snaps-cli 0.3.1 → 0.6.1

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

@@ -1,6 +1,18 @@
+import type { SnapManifest } from '@metamask/snap-controllers';
 import { YargsArgs } from '../../types/yargs';
 /**
- * Validates a Snap package.json file.
- * Exits with success message or gathers all errors before throwing at the end.
+ * Validates a snap.manifest.json file. Attempts to fix the manifest and write
+ * the fixed version to disk if `writeManifest` is true. Throws if validation
+ * fails.
+ *
+ * @param argv - The Yargs `argv` object.
  */
-export declare function manifest(argv: YargsArgs): Promise<void>;
+export declare function manifestHandler({ writeManifest, }: YargsArgs): Promise<void>;
+/**
+ * Sorts the given manifest in our preferred sort order and removes the
+ * `repository` field if it is falsy (it may be `null`).
+ *
+ * @param manifest - The manifest to sort and modify.
+ * @returns The disk-ready manifest.
+ */
+export declare function getWritableManifest(manifest: SnapManifest): SnapManifest;

package/dist/cmds/manifest/manifestHandler.js

@@ -1,172 +1,111 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.manifest = void 0;
+exports.getWritableManifest = exports.manifestHandler = void 0;
 const fs_1 = require("fs");
-const path_1 = __importDefault(require("path"));
-const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
-const is_url_1 = __importDefault(require("is-url"));
-const rfdc_1 = __importDefault(require("rfdc"));
-const utils_1 = require("../../utils");
-const deepClone = rfdc_1.default({ proto: false, circles: false });
-const LOCALHOST_START = 'http://localhost';
+const utils_1 = require("@metamask/snap-controllers/dist/snaps/utils");
+const utils_2 = require("../../utils");
+const errorPrefix = 'Manifest Error: ';
+const ManifestSortOrder = {
+    version: 1,
+    proposedName: 2,
+    description: 2,
+    repository: 3,
+    source: 4,
+    initialPermissions: 5,
+    manifestVersion: 6,
+};
 /**
- * Validates a Snap package.json file.
- * Exits with success message or gathers all errors before throwing at the end.
+ * Validates a snap.manifest.json file. Attempts to fix the manifest and write
+ * the fixed version to disk if `writeManifest` is true. Throws if validation
+ * fails.
+ *
+ * @param argv - The Yargs `argv` object.
  */
-async function manifest(argv) {
-    let isInvalid = false;
-    let hasWarnings = false;
+async function manifestHandler({ writeManifest, }) {
+    var _a, _b, _c;
     let didUpdate = false;
-    const { dist, port, outfileName } = argv;
-    if (!dist) {
-        throw new Error(`Invalid params: must provide 'dist'`);
-    }
-    // read the package.json file
-    let pkg;
+    let hasWarnings = false;
+    const unvalidatedManifest = await readSnapJsonFile(utils_1.NpmSnapFileNames.Manifest);
+    const iconPath = unvalidatedManifest && typeof unvalidatedManifest === 'object'
+        ? (_c = (_b = (_a = unvalidatedManifest.source) === null || _a === void 0 ? void 0 : _a.location) === null || _b === void 0 ? void 0 : _b.npm) === null || _c === void 0 ? void 0 : _c.iconPath
+        : undefined;
+    const snapFiles = {
+        manifest: unvalidatedManifest,
+        packageJson: await readSnapJsonFile(utils_1.NpmSnapFileNames.PackageJson),
+        sourceCode: await getSnapSourceCode(unvalidatedManifest),
+        svgIcon: iconPath && (await fs_1.promises.readFile(iconPath, 'utf8')),
+    };
+    let manifest;
     try {
-        pkg = JSON.parse(await fs_1.promises.readFile('package.json', 'utf-8'));
-    }
-    catch (err) {
-        if (err.code === 'ENOENT') {
-            throw new Error(`Manifest error: Could not find package.json. Please ensure that ` +
-                `you are running the command in the project root directory.`);
-        }
-        throw new Error(`Could not parse package.json`);
-    }
-    if (!pkg || typeof pkg !== 'object') {
-        throw new Error(`Invalid parsed package.json: ${pkg}`);
+        ({ manifest } = utils_1.validateNpmSnap(snapFiles, errorPrefix));
     }
-    // attempt to set missing/erroneous properties if commanded
-    if (argv.populate) {
-        const old = pkg.web3Wallet ? deepClone(pkg.web3Wallet) : {};
-        if (!pkg.web3Wallet) {
-            pkg.web3Wallet = {};
-        }
-        const bundle = pkg.web3Wallet.bundle || {};
-        if (!pkg.web3Wallet.bundle) {
-            pkg.web3Wallet.bundle = bundle;
-        }
-        if (!pkg.web3Wallet.initialPermissions) {
-            pkg.web3Wallet.initialPermissions = {};
-        }
-        const { web3Wallet } = pkg;
-        const bundlePath = path_1.default.join(dist, outfileName || 'bundle.js');
-        if (bundle.local !== bundlePath) {
-            bundle.local = bundlePath;
-        }
-        if (port &&
-            (typeof bundle.url !== 'string' || bundle.url.startsWith(LOCALHOST_START))) {
-            bundle.url = `${LOCALHOST_START}:${port}/${bundlePath}`;
-        }
-        // sort web3Wallet object keys
-        Object.keys(web3Wallet)
-            .sort()
-            .forEach((_key) => {
-            const key = _key;
-            const property = web3Wallet[key];
-            if (property &&
-                typeof property === 'object' &&
-                !Array.isArray(property)) {
-                web3Wallet[key] = Object.keys(property)
-                    .sort()
-                    .reduce((sortedProperty, _innerKey) => {
-                    const innerKey = _innerKey;
-                    sortedProperty[innerKey] = property[innerKey];
-                    return sortedProperty;
-                }, {});
+    catch (error) {
+        if (writeManifest && error instanceof utils_1.ProgrammaticallyFixableSnapError) {
+            // If we get here, the files at least have the correct shape.
+            const partiallyValidatedFiles = snapFiles;
+            let isInvalid = true;
+            const maxAttempts = Object.keys(utils_1.SnapValidationFailureReason).length;
+            // Attempt to fix all fixable validation failure reasons. All such reasons
+            // are enumerated by the SnapValidationFailureReason enum, so we only
+            for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {
+                manifest = fixManifest(partiallyValidatedFiles, error);
+                try {
+                    utils_1.validateNpmSnapManifest(Object.assign(Object.assign({}, partiallyValidatedFiles), { manifest }), errorPrefix);
+                    isInvalid = false;
+                }
+                catch (nextValidationError) {
+                    /* istanbul ignore next: this should be impossible */
+                    if (!(nextValidationError instanceof utils_1.ProgrammaticallyFixableSnapError) ||
+                        (attempts === maxAttempts && !isInvalid)) {
+                        throw new Error(`Internal Error: Failed to fix manifest. This is a bug, please report it. Reason:\n${error.message}`);
+                    }
+                }
             }
-        });
-        if (!fast_deep_equal_1.default(old, web3Wallet)) {
             didUpdate = true;
         }
-    }
-    // check presence of required and recommended keys
-    const existing = Object.keys(pkg);
-    const required = ['name', 'version', 'description', 'main', 'web3Wallet'];
-    const recommended = ['repository'];
-    let missing = required.filter((key) => !existing.includes(key));
-    if (missing.length > 0) {
-        logManifestWarning(`Missing required package.json properties:\n${missing.reduce((acc, curr) => {
-            return `${acc}\t${curr}\n`;
-        }, '')}`);
-    }
-    missing = recommended.filter((key) => !existing.includes(key));
-    if (missing.length > 0) {
-        logManifestWarning(`Missing recommended package.json properties:\n${missing.reduce((acc, curr) => {
-            return `${acc}\t${curr}\n`;
-        }, '')}`);
-    }
-    // check web3Wallet properties
-    if (pkg.web3Wallet !== undefined) {
-        const { bundle, initialPermissions } = pkg.web3Wallet || {};
-        if (bundle === null || bundle === void 0 ? void 0 : bundle.local) {
-            if (!(await utils_1.isFile(bundle.local))) {
-                logManifestError(`'bundle.local' does not resolve to a file.`);
-            }
-        }
         else {
-            logManifestError(`Missing required 'web3Wallet' property 'bundle.local'.`);
-        }
-        if (bundle !== undefined) {
-            if (!bundle.url) {
-                logManifestError(`Missing required 'bundle.url' property.`);
-            }
-            else if (!is_url_1.default(bundle.url)) {
-                logManifestError(`'bundle.url' does not resolve to a URL.`);
-            }
-        }
-        if (Object.prototype.hasOwnProperty.call(pkg.web3Wallet, 'initialPermissions')) {
-            if (typeof initialPermissions !== 'object' ||
-                Array.isArray(initialPermissions)) {
-                logManifestError(`'web3Wallet' property 'initialPermissions' must be an object if present.`);
-            }
-            else if (Object.keys(initialPermissions).length > 0) {
-                Object.entries(initialPermissions).forEach(([permission, value]) => {
-                    if (typeof value !== 'object' || Array.isArray(value)) {
-                        logManifestError(`initial permission '${permission}' must be an object`);
-                    }
-                    else if (value !== null) {
-                        Object.keys(value).forEach((permissionKey) => {
-                            if (!utils_1.permRequestKeys.includes(permissionKey)) {
-                                logManifestError(`initial permission '${permission}' has unrecognized key '${permissionKey}'`);
-                            }
-                            if (permissionKey === 'parentCapability' &&
-                                permission !== permissionKey) {
-                                logManifestError(`initial permission '${permission}' has mismatched 'parentCapability' field '${value[permissionKey]}'`);
-                            }
-                        });
-                    }
-                });
-            }
+            throw error;
         }
     }
-    // validation complete, finish work and notify user
-    if (argv.populate) {
+    // TypeScript doesn't see that the 'manifest' variable must be of type
+    // SnapManifest at this point, so we cast it.
+    const validatedManifest = manifest;
+    // Check presence of recommended keys
+    const recommendedFields = ['repository'];
+    const missingRecommendedFields = recommendedFields.filter((key) => !validatedManifest[key]);
+    if (missingRecommendedFields.length > 0) {
+        logManifestWarning(`Missing recommended package.json properties:\n${missingRecommendedFields.reduce((allMissing, currentField) => {
+            return `${allMissing}\t${currentField}\n`;
+        }, '')}`);
+    }
+    // Validation complete, finish work and notify user.
+    if (writeManifest) {
         try {
-            await fs_1.promises.writeFile('package.json', `${JSON.stringify(pkg, null, 2)}\n`);
+            await fs_1.promises.writeFile(utils_1.NpmSnapFileNames.Manifest, `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\n`);
             if (didUpdate) {
-                console.log(`Manifest: Updated '${pkg.name}' package.json!`);
+                console.log(`Manifest: Updated snap.manifest.json`);
             }
         }
-        catch (err) {
-            throw new Error(`Could not write package.json`);
+        catch (error) {
+            throw new Error(`${errorPrefix}Failed to update snap.manifest.json: ${error.message}`);
         }
     }
-    if (isInvalid) {
-        throw new Error(`Manifest Error: package.json validation failed, please see above errors.`);
-    }
-    else if (hasWarnings) {
-        console.log(`Manifest Warning: Validation of '${pkg.name}' package.json completed with warnings. See above.`);
+    if (hasWarnings) {
+        console.log(`Manifest Warning: Validation of snap.manifest.json completed with warnings. See above.`);
     }
     else {
-        console.log(`Manifest Success: Validated '${pkg.name}' package.json!`);
-    }
-    function logManifestError(message) {
-        isInvalid = true;
-        console.error(`Manifest Error: ${message}`);
+        console.log(`Manifest Success: Validated snap.manifest.json!`);
     }
     function logManifestWarning(message) {
         if (!global.snaps.suppressWarnings) {
@@ -175,5 +114,99 @@ async function manifest(argv) {
         }
     }
 }
-exports.manifest = manifest;
+exports.manifestHandler = manifestHandler;
+/**
+ * Utility function for reading `package.json` or the Snap manifest file.
+ * These are assumed to be in the current working directory.
+ *
+ * @param snapJsonFileName - The name of the file to read.
+ * @returns The parsed JSON file.
+ */
+async function readSnapJsonFile(snapJsonFileName) {
+    try {
+        return await utils_2.readJsonFile(snapJsonFileName);
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            throw new Error(`${errorPrefix}Could not find '${snapJsonFileName}'. Please ensure that ` +
+                `you are running the command in the project root directory.`);
+        }
+        throw new Error(`${errorPrefix}${error.message}`);
+    }
+}
+/**
+ * Given an unvalidated Snap manifest, attempts to extract the location of the
+ * bundle source file location and read the file.
+ *
+ * @param manifest - The unvalidated Snap manifest file contents.
+ * @returns The contents of the bundle file, if any.
+ */
+async function getSnapSourceCode(manifest) {
+    var _a, _b, _c;
+    if (manifest && typeof manifest === 'object' && !Array.isArray(manifest)) {
+        /* istanbul ignore next: optional chaining */
+        const sourceFilePath = (_c = (_b = (_a = manifest.source) === null || _a === void 0 ? void 0 : _a.location) === null || _b === void 0 ? void 0 : _b.npm) === null || _c === void 0 ? void 0 : _c.filePath;
+        try {
+            return sourceFilePath
+                ? await fs_1.promises.readFile(sourceFilePath, 'utf8')
+                : undefined;
+        }
+        catch (error) {
+            throw new Error(`Manifest Error: Failed to read Snap bundle file: ${error.message}`);
+        }
+    }
+    return undefined;
+}
+/**
+ * Given the relevant Snap files (manifest, `package.json`, and bundle) and a
+ * Snap manifest validation error, fixes the fault in the manifest that caused
+ * the error.
+ *
+ * @param snapFiles - The contents of all Snap files.
+ * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.
+ * @returns A copy of the manifest file where the cause of the error is fixed.
+ */
+function fixManifest(snapFiles, error) {
+    const { manifest, packageJson, sourceCode } = snapFiles;
+    const manifestCopy = utils_2.deepClone(manifest);
+    switch (error.reason) {
+        case utils_1.SnapValidationFailureReason.NameMismatch:
+            manifestCopy.source.location.npm.packageName = packageJson.name;
+            break;
+        case utils_1.SnapValidationFailureReason.VersionMismatch:
+            manifestCopy.version = packageJson.version;
+            break;
+        case utils_1.SnapValidationFailureReason.RepositoryMismatch:
+            manifestCopy.repository = packageJson.repository
+                ? utils_2.deepClone(packageJson.repository)
+                : null;
+            break;
+        case utils_1.SnapValidationFailureReason.ShasumMismatch:
+            manifestCopy.source.shasum = utils_1.getSnapSourceShasum(sourceCode);
+            break;
+        /* istanbul ignore next */
+        default:
+            // eslint-disable-next-line no-case-declarations
+            const failureReason = error.reason;
+            throw new Error(`Unrecognized validation failure reason: '${failureReason}'`);
+    }
+    return manifestCopy;
+}
+/**
+ * Sorts the given manifest in our preferred sort order and removes the
+ * `repository` field if it is falsy (it may be `null`).
+ *
+ * @param manifest - The manifest to sort and modify.
+ * @returns The disk-ready manifest.
+ */
+function getWritableManifest(manifest) {
+    const { repository } = manifest, remaining = __rest(manifest, ["repository"]);
+    return Object.keys(repository ? Object.assign(Object.assign({}, remaining), { repository }) : remaining)
+        .sort((a, b) => ManifestSortOrder[a] - ManifestSortOrder[b])
+        .reduce((outManifest, key) => {
+        outManifest[key] = manifest[key];
+        return outManifest;
+    }, {});
+}
+exports.getWritableManifest = getWritableManifest;
 //# sourceMappingURL=manifestHandler.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"manifestHandler.js","sourceRoot":"","sources":["../../../src/cmds/manifest/manifestHandler.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAoC;AACpC,gDAA6B;AAC7B,sEAAqC;AACrC,oDAA2B;AAC3B,gDAAwB;AACxB,uCAAsD;AAOtD,MAAM,SAAS,GAAG,cAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AAEzD,MAAM,eAAe,GAAG,kBAAkB,CAAC;AAE3C;;;GAGG;AACI,KAAK,UAAU,QAAQ,CAAC,IAAe;IAC5C,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACzC,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KACxD;IAED,6BAA6B;IAC7B,IAAI,GAAwB,CAAC;IAC7B,IAAI;QACF,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;KAC9D;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;YACzB,MAAM,IAAI,KAAK,CACb,kEAAkE;gBAChE,4DAA4D,CAC/D,CAAC;SACH;QACD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAED,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QACnC,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,EAAE,CAAC,CAAC;KACxD;IAED,2DAA2D;IAC3D,IAAI,IAAI,CAAC,QAAQ,EAAE;QACjB,MAAM,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAE5D,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE;YACnB,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC;SACrB;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE;YAC1B,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC;SAChC;QAED,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,kBAAkB,EAAE;YACtC,GAAG,CAAC,UAAU,CAAC,kBAAkB,GAAG,EAAE,CAAC;SACxC;QAED,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;QAE3B,MAAM,UAAU,GAAG,cAAS,CAAC,IAAI,CAC/B,IAAI,EACH,WAAsB,IAAI,WAAW,CACvC,CAAC;QACF,IAAI,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE;YAC/B,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC;SAC3B;QAED,IACE,IAAI;YACJ,CAAC,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,EAC1E;YACA,MAAM,CAAC,GAAG,GAAG,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,EAAE,CAAC;SACzD;QAED,8BAA8B;QAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;aACpB,IAAI,EAAE;aACN,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,GAAG,GAAG,IAAoC,CAAC;YACjD,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAEjC,IACE,QAAQ;gBACR,OAAO,QAAQ,KAAK,QAAQ;gBAC5B,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EACxB;gBACA,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;qBACpC,IAAI,EAAE;qBACN,MAAM,CAAC,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE;oBACpC,MAAM,QAAQ,GACZ,SAAqD,CAAC;oBACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAE9C,OAAO,cAAc,CAAC;gBACxB,CAAC,EAAE,EAA6B,CAAC,CAAC;aACrC;QACH,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,yBAAM,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE;YAC5B,SAAS,GAAG,IAAI,CAAC;SAClB;KACF;IAED,kDAAkD;IAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1E,MAAM,WAAW,GAAG,CAAC,YAAY,CAAC,CAAC;IAEnC,IAAI,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACtB,kBAAkB,CAChB,8CAA8C,OAAO,CAAC,MAAM,CAC1D,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACZ,OAAO,GAAG,GAAG,KAAK,IAAI,IAAI,CAAC;QAC7B,CAAC,EACD,EAAE,CACH,EAAE,CACJ,CAAC;KACH;IAED,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACtB,kBAAkB,CAChB,iDAAiD,OAAO,CAAC,MAAM,CAC7D,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACZ,OAAO,GAAG,GAAG,KAAK,IAAI,IAAI,CAAC;QAC7B,CAAC,EACD,EAAE,CACH,EAAE,CACJ,CAAC;KACH;IAED,8BAA8B;IAC9B,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,EAAE;QAChC,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC;QAC5D,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,EAAE;YACjB,IAAI,CAAC,CAAC,MAAM,cAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACjC,gBAAgB,CAAC,4CAA4C,CAAC,CAAC;aAChE;SACF;aAAM;YACL,gBAAgB,CACd,wDAAwD,CACzD,CAAC;SACH;QAED,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBACf,gBAAgB,CAAC,yCAAyC,CAAC,CAAC;aAC7D;iBAAM,IAAI,CAAC,gBAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;gBAC7B,gBAAgB,CAAC,yCAAyC,CAAC,CAAC;aAC7D;SACF;QAED,IACE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,oBAAoB,CAAC,EAC1E;YACA,IACE,OAAO,kBAAkB,KAAK,QAAQ;gBACtC,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EACjC;gBACA,gBAAgB,CACd,0EAA0E,CAC3E,CAAC;aACH;iBAAM,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrD,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,EAAE;oBACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;wBACrD,gBAAgB,CACd,uBAAuB,UAAU,qBAAqB,CACvD,CAAC;qBACH;yBAAM,IAAI,KAAK,KAAK,IAAI,EAAE;wBACzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;4BAC3C,IAAI,CAAC,uBAAe,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;gCAC5C,gBAAgB,CACd,uBAAuB,UAAU,2BAA2B,aAAa,GAAG,CAC7E,CAAC;6BACH;4BAED,IACE,aAAa,KAAK,kBAAkB;gCACpC,UAAU,KAAK,aAAa,EAC5B;gCACA,gBAAgB,CACd,uBAAuB,UAAU,8CAC9B,KAAiC,CAAC,aAAa,CAClD,GAAG,CACJ,CAAC;6BACH;wBACH,CAAC,CAAC,CAAC;qBACJ;gBACH,CAAC,CAAC,CAAC;aACJ;SACF;KACF;IAED,mDAAmD;IAEnD,IAAI,IAAI,CAAC,QAAQ,EAAE;QACjB,IAAI;YACF,MAAM,aAAE,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;YACxE,IAAI,SAAS,EAAE;gBACb,OAAO,CAAC,GAAG,CAAC,sBAAsB,GAAG,CAAC,IAAI,iBAAiB,CAAC,CAAC;aAC9D;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;KACF;IAED,IAAI,SAAS,EAAE;QACb,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;KACH;SAAM,IAAI,WAAW,EAAE;QACtB,OAAO,CAAC,GAAG,CACT,oCAAoC,GAAG,CAAC,IAAI,oDAAoD,CACjG,CAAC;KACH;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,gCAAgC,GAAG,CAAC,IAAI,iBAAiB,CAAC,CAAC;KACxE;IAED,SAAS,gBAAgB,CAAC,OAAe;QACvC,SAAS,GAAG,IAAI,CAAC;QACjB,OAAO,CAAC,KAAK,CAAC,mBAAmB,OAAO,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,SAAS,kBAAkB,CAAC,OAAe;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAClC,WAAW,GAAG,IAAI,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;SAC9C;IACH,CAAC;AACH,CAAC;AA1ND,4BA0NC","sourcesContent":["import { promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport dequal from 'fast-deep-equal';\nimport isUrl from 'is-url';\nimport rfdc from 'rfdc';\nimport { isFile, permRequestKeys } from '../../utils';\nimport { YargsArgs } from '../../types/yargs';\nimport {\n  NodePackageManifest,\n  ManifestWalletProperty,\n} from '../../types/package';\n\nconst deepClone = rfdc({ proto: false, circles: false });\n\nconst LOCALHOST_START = 'http://localhost';\n\n/**\n * Validates a Snap package.json file.\n * Exits with success message or gathers all errors before throwing at the end.\n */\nexport async function manifest(argv: YargsArgs): Promise<void> {\n  let isInvalid = false;\n  let hasWarnings = false;\n  let didUpdate = false;\n\n  const { dist, port, outfileName } = argv;\n  if (!dist) {\n    throw new Error(`Invalid params: must provide 'dist'`);\n  }\n\n  // read the package.json file\n  let pkg: NodePackageManifest;\n  try {\n    pkg = JSON.parse(await fs.readFile('package.json', 'utf-8'));\n  } catch (err) {\n    if (err.code === 'ENOENT') {\n      throw new Error(\n        `Manifest error: Could not find package.json. Please ensure that ` +\n          `you are running the command in the project root directory.`,\n      );\n    }\n    throw new Error(`Could not parse package.json`);\n  }\n\n  if (!pkg || typeof pkg !== 'object') {\n    throw new Error(`Invalid parsed package.json: ${pkg}`);\n  }\n\n  // attempt to set missing/erroneous properties if commanded\n  if (argv.populate) {\n    const old = pkg.web3Wallet ? deepClone(pkg.web3Wallet) : {};\n\n    if (!pkg.web3Wallet) {\n      pkg.web3Wallet = {};\n    }\n\n    const bundle = pkg.web3Wallet.bundle || {};\n    if (!pkg.web3Wallet.bundle) {\n      pkg.web3Wallet.bundle = bundle;\n    }\n\n    if (!pkg.web3Wallet.initialPermissions) {\n      pkg.web3Wallet.initialPermissions = {};\n    }\n\n    const { web3Wallet } = pkg;\n\n    const bundlePath = pathUtils.join(\n      dist,\n      (outfileName as string) || 'bundle.js',\n    );\n    if (bundle.local !== bundlePath) {\n      bundle.local = bundlePath;\n    }\n\n    if (\n      port &&\n      (typeof bundle.url !== 'string' || bundle.url.startsWith(LOCALHOST_START))\n    ) {\n      bundle.url = `${LOCALHOST_START}:${port}/${bundlePath}`;\n    }\n\n    // sort web3Wallet object keys\n    Object.keys(web3Wallet)\n      .sort()\n      .forEach((_key) => {\n        const key = _key as keyof ManifestWalletProperty;\n        const property = web3Wallet[key];\n\n        if (\n          property &&\n          typeof property === 'object' &&\n          !Array.isArray(property)\n        ) {\n          web3Wallet[key] = Object.keys(property)\n            .sort()\n            .reduce((sortedProperty, _innerKey) => {\n              const innerKey =\n                _innerKey as keyof ManifestWalletProperty[typeof key];\n              sortedProperty[innerKey] = property[innerKey];\n\n              return sortedProperty;\n            }, {} as Record<string, unknown>);\n        }\n      });\n\n    if (!dequal(old, web3Wallet)) {\n      didUpdate = true;\n    }\n  }\n\n  // check presence of required and recommended keys\n  const existing = Object.keys(pkg);\n  const required = ['name', 'version', 'description', 'main', 'web3Wallet'];\n  const recommended = ['repository'];\n\n  let missing = required.filter((key) => !existing.includes(key));\n  if (missing.length > 0) {\n    logManifestWarning(\n      `Missing required package.json properties:\\n${missing.reduce(\n        (acc, curr) => {\n          return `${acc}\\t${curr}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  missing = recommended.filter((key) => !existing.includes(key));\n  if (missing.length > 0) {\n    logManifestWarning(\n      `Missing recommended package.json properties:\\n${missing.reduce(\n        (acc, curr) => {\n          return `${acc}\\t${curr}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  // check web3Wallet properties\n  if (pkg.web3Wallet !== undefined) {\n    const { bundle, initialPermissions } = pkg.web3Wallet || {};\n    if (bundle?.local) {\n      if (!(await isFile(bundle.local))) {\n        logManifestError(`'bundle.local' does not resolve to a file.`);\n      }\n    } else {\n      logManifestError(\n        `Missing required 'web3Wallet' property 'bundle.local'.`,\n      );\n    }\n\n    if (bundle !== undefined) {\n      if (!bundle.url) {\n        logManifestError(`Missing required 'bundle.url' property.`);\n      } else if (!isUrl(bundle.url)) {\n        logManifestError(`'bundle.url' does not resolve to a URL.`);\n      }\n    }\n\n    if (\n      Object.prototype.hasOwnProperty.call(pkg.web3Wallet, 'initialPermissions')\n    ) {\n      if (\n        typeof initialPermissions !== 'object' ||\n        Array.isArray(initialPermissions)\n      ) {\n        logManifestError(\n          `'web3Wallet' property 'initialPermissions' must be an object if present.`,\n        );\n      } else if (Object.keys(initialPermissions).length > 0) {\n        Object.entries(initialPermissions).forEach(([permission, value]) => {\n          if (typeof value !== 'object' || Array.isArray(value)) {\n            logManifestError(\n              `initial permission '${permission}' must be an object`,\n            );\n          } else if (value !== null) {\n            Object.keys(value).forEach((permissionKey) => {\n              if (!permRequestKeys.includes(permissionKey)) {\n                logManifestError(\n                  `initial permission '${permission}' has unrecognized key '${permissionKey}'`,\n                );\n              }\n\n              if (\n                permissionKey === 'parentCapability' &&\n                permission !== permissionKey\n              ) {\n                logManifestError(\n                  `initial permission '${permission}' has mismatched 'parentCapability' field '${\n                    (value as Record<string, unknown>)[permissionKey]\n                  }'`,\n                );\n              }\n            });\n          }\n        });\n      }\n    }\n  }\n\n  // validation complete, finish work and notify user\n\n  if (argv.populate) {\n    try {\n      await fs.writeFile('package.json', `${JSON.stringify(pkg, null, 2)}\\n`);\n      if (didUpdate) {\n        console.log(`Manifest: Updated '${pkg.name}' package.json!`);\n      }\n    } catch (err) {\n      throw new Error(`Could not write package.json`);\n    }\n  }\n\n  if (isInvalid) {\n    throw new Error(\n      `Manifest Error: package.json validation failed, please see above errors.`,\n    );\n  } else if (hasWarnings) {\n    console.log(\n      `Manifest Warning: Validation of '${pkg.name}' package.json completed with warnings. See above.`,\n    );\n  } else {\n    console.log(`Manifest Success: Validated '${pkg.name}' package.json!`);\n  }\n\n  function logManifestError(message: string) {\n    isInvalid = true;\n    console.error(`Manifest Error: ${message}`);\n  }\n\n  function logManifestWarning(message: string) {\n    if (!global.snaps.suppressWarnings) {\n      hasWarnings = true;\n      console.warn(`Manifest Warning: ${message}`);\n    }\n  }\n}\n"]}
+{"version":3,"file":"manifestHandler.js","sourceRoot":"","sources":["../../../src/cmds/manifest/manifestHandler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,2BAAoC;AAEpC,uEASqD;AACrD,uCAAsD;AAGtD,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAEvC,MAAM,iBAAiB,GAAuC;IAC5D,OAAO,EAAE,CAAC;IACV,YAAY,EAAE,CAAC;IACf,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,MAAM,EAAE,CAAC;IACT,kBAAkB,EAAE,CAAC;IACrB,eAAe,EAAE,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CAAC,EACpC,aAAa,GACH;;IACV,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,MAAM,mBAAmB,GAAG,MAAM,gBAAgB,CAAC,wBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE9E,MAAM,QAAQ,GACZ,mBAAmB,IAAI,OAAO,mBAAmB,KAAK,QAAQ;QAC5D,CAAC,CAAC,MAAA,MAAA,MAAC,mBAA6C,CAAC,MAAM,0CAAE,QAAQ,0CAAE,GAAG,0CAChE,QAAQ;QACd,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,SAAS,GAAyB;QACtC,QAAQ,EAAE,mBAAmB;QAC7B,WAAW,EAAE,MAAM,gBAAgB,CAAC,wBAAgB,CAAC,WAAW,CAAC;QACjE,UAAU,EAAE,MAAM,iBAAiB,CAAC,mBAAmB,CAAC;QACxD,OAAO,EAAE,QAAQ,IAAI,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;KAC3D,CAAC;IAEF,IAAI,QAAkC,CAAC;IACvC,IAAI;QACF,CAAC,EAAE,QAAQ,EAAE,GAAG,uBAAe,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;KAC1D;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,aAAa,IAAI,KAAK,YAAY,wCAAgC,EAAE;YACtE,6DAA6D;YAC7D,MAAM,uBAAuB,GAAG,SAAsB,CAAC;YAEvD,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,mCAA2B,CAAC,CAAC,MAAM,CAAC;YAEpE,0EAA0E;YAC1E,qEAAqE;YACrE,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,SAAS,IAAI,QAAQ,IAAI,WAAW,EAAE,QAAQ,EAAE,EAAE;gBACvE,QAAQ,GAAG,WAAW,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;gBAEvD,IAAI;oBACF,+BAAuB,iCAChB,uBAAuB,KAAE,QAAQ,KACtC,WAAW,CACZ,CAAC;oBAEF,SAAS,GAAG,KAAK,CAAC;iBACnB;gBAAC,OAAO,mBAAmB,EAAE;oBAC5B,qDAAqD;oBACrD,IACE,CAAC,CACC,mBAAmB,YAAY,wCAAgC,CAChE;wBACD,CAAC,QAAQ,KAAK,WAAW,IAAI,CAAC,SAAS,CAAC,EACxC;wBACA,MAAM,IAAI,KAAK,CACb,qFAAqF,KAAK,CAAC,OAAO,EAAE,CACrG,CAAC;qBACH;iBACF;aACF;YAED,SAAS,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,MAAM,KAAK,CAAC;SACb;KACF;IAED,sEAAsE;IACtE,6CAA6C;IAC7C,MAAM,iBAAiB,GAAG,QAAwB,CAAC;IAEnD,qCAAqC;IACrC,MAAM,iBAAiB,GAAG,CAAC,YAAY,CAAU,CAAC;IAElD,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,CACvD,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CACjC,CAAC;IAEF,IAAI,wBAAwB,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,kBAAkB,CAChB,iDAAiD,wBAAwB,CAAC,MAAM,CAC9E,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE;YAC3B,OAAO,GAAG,UAAU,KAAK,YAAY,IAAI,CAAC;QAC5C,CAAC,EACD,EAAE,CACH,EAAE,CACJ,CAAC;KACH;IAED,oDAAoD;IAEpD,IAAI,aAAa,EAAE;QACjB,IAAI;YACF,MAAM,aAAE,CAAC,SAAS,CAChB,wBAAgB,CAAC,QAAQ,EACzB,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CACvE,CAAC;YAEF,IAAI,SAAS,EAAE;gBACb,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;aACrD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CACb,GAAG,WAAW,wCAAwC,KAAK,CAAC,OAAO,EAAE,CACtE,CAAC;SACH;KACF;IAED,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,GAAG,CACT,wFAAwF,CACzF,CAAC;KACH;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;KAChE;IAED,SAAS,kBAAkB,CAAC,OAAe;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAClC,WAAW,GAAG,IAAI,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;SAC9C;IACH,CAAC;AACH,CAAC;AAxHD,0CAwHC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAC7B,gBAAkC;IAElC,IAAI;QACF,OAAO,MAAM,oBAAY,CAAC,gBAAgB,CAAC,CAAC;KAC7C;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,MAAM,IAAI,KAAK,CACb,GAAG,WAAW,mBAAmB,gBAAgB,wBAAwB;gBACvE,4DAA4D,CAC/D,CAAC;SACH;QACD,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACnD;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,iBAAiB,CAAC,QAAc;;IAC7C,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxE,6CAA6C;QAC7C,MAAM,cAAc,GAAG,MAAA,MAAA,MAAC,QAAkC,CAAC,MAAM,0CAAE,QAAQ,0CACvE,GAAG,0CAAE,QAAQ,CAAC;QAElB,IAAI;YACF,OAAO,cAAc;gBACnB,CAAC,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;gBAC3C,CAAC,CAAC,SAAS,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CACb,oDAAoD,KAAK,CAAC,OAAO,EAAE,CACpE,CAAC;SACH;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,WAAW,CAClB,SAAoB,EACpB,KAAuC;IAEvC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACxD,MAAM,YAAY,GAAG,iBAAS,CAAC,QAAQ,CAAC,CAAC;IAEzC,QAAQ,KAAK,CAAC,MAAM,EAAE;QACpB,KAAK,mCAA2B,CAAC,YAAY;YAC3C,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC;YAChE,MAAM;QAER,KAAK,mCAA2B,CAAC,eAAe;YAC9C,YAAY,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;YAC3C,MAAM;QAER,KAAK,mCAA2B,CAAC,kBAAkB;YACjD,YAAY,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU;gBAC9C,CAAC,CAAC,iBAAS,CAAC,WAAW,CAAC,UAAU,CAAC;gBACnC,CAAC,CAAC,IAAI,CAAC;YACT,MAAM;QAER,KAAK,mCAA2B,CAAC,cAAc;YAC7C,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,2BAAmB,CAAC,UAAU,CAAC,CAAC;YAC7D,MAAM;QAER,0BAA0B;QAC1B;YACE,gDAAgD;YAChD,MAAM,aAAa,GAAU,KAAK,CAAC,MAAM,CAAC;YAC1C,MAAM,IAAI,KAAK,CACb,4CAA4C,aAAa,GAAG,CAC7D,CAAC;KACL;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,QAAsB;IACxD,MAAM,EAAE,UAAU,KAAmB,QAAQ,EAAtB,SAAS,UAAK,QAAQ,EAAvC,cAA4B,CAAW,CAAC;IAC9C,OACE,MAAM,CAAC,IAAI,CACT,UAAU,CAAC,CAAC,iCAAM,SAAS,KAAE,UAAU,IAAG,CAAC,CAAC,SAAS,CAExD;SACE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;SAC3D,MAAM,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;QAC1B,WAAmB,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1C,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,EAAkB,CAAC,CAAC;AAC3B,CAAC;AAZD,kDAYC","sourcesContent":["import { promises as fs } from 'fs';\nimport type { Json, SnapManifest } from '@metamask/snap-controllers';\nimport {\n  NpmSnapFileNames,\n  UnvalidatedSnapFiles,\n  validateNpmSnap,\n  validateNpmSnapManifest,\n  getSnapSourceShasum,\n  ProgrammaticallyFixableSnapError,\n  SnapValidationFailureReason,\n  SnapFiles,\n} from '@metamask/snap-controllers/dist/snaps/utils';\nimport { deepClone, readJsonFile } from '../../utils';\nimport { YargsArgs } from '../../types/yargs';\n\nconst errorPrefix = 'Manifest Error: ';\n\nconst ManifestSortOrder: Record<keyof SnapManifest, number> = {\n  version: 1,\n  proposedName: 2,\n  description: 2,\n  repository: 3,\n  source: 4,\n  initialPermissions: 5,\n  manifestVersion: 6,\n};\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param argv - The Yargs `argv` object.\n */\nexport async function manifestHandler({\n  writeManifest,\n}: YargsArgs): Promise<void> {\n  let didUpdate = false;\n  let hasWarnings = false;\n\n  const unvalidatedManifest = await readSnapJsonFile(NpmSnapFileNames.Manifest);\n\n  const iconPath =\n    unvalidatedManifest && typeof unvalidatedManifest === 'object'\n      ? (unvalidatedManifest as Partial<SnapManifest>).source?.location?.npm\n          ?.iconPath\n      : undefined;\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: unvalidatedManifest,\n    packageJson: await readSnapJsonFile(NpmSnapFileNames.PackageJson),\n    sourceCode: await getSnapSourceCode(unvalidatedManifest),\n    svgIcon: iconPath && (await fs.readFile(iconPath, 'utf8')),\n  };\n\n  let manifest: SnapManifest | undefined;\n  try {\n    ({ manifest } = validateNpmSnap(snapFiles, errorPrefix));\n  } catch (error) {\n    if (writeManifest && error instanceof ProgrammaticallyFixableSnapError) {\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the SnapValidationFailureReason enum, so we only\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = fixManifest(partiallyValidatedFiles, error);\n\n        try {\n          validateNpmSnapManifest(\n            { ...partiallyValidatedFiles, manifest },\n            errorPrefix,\n          );\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal Error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n        }\n      }\n\n      didUpdate = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript doesn't see that the 'manifest' variable must be of type\n  // SnapManifest at this point, so we cast it.\n  const validatedManifest = manifest as SnapManifest;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    logManifestWarning(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  // Validation complete, finish work and notify user.\n\n  if (writeManifest) {\n    try {\n      await fs.writeFile(\n        NpmSnapFileNames.Manifest,\n        `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\\n`,\n      );\n\n      if (didUpdate) {\n        console.log(`Manifest: Updated snap.manifest.json`);\n      }\n    } catch (error) {\n      throw new Error(\n        `${errorPrefix}Failed to update snap.manifest.json: ${error.message}`,\n      );\n    }\n  }\n\n  if (hasWarnings) {\n    console.log(\n      `Manifest Warning: Validation of snap.manifest.json completed with warnings. See above.`,\n    );\n  } else {\n    console.log(`Manifest Success: Validated snap.manifest.json!`);\n  }\n\n  function logManifestWarning(message: string) {\n    if (!global.snaps.suppressWarnings) {\n      hasWarnings = true;\n      console.warn(`Manifest Warning: ${message}`);\n    }\n  }\n}\n\n/**\n * Utility function for reading `package.json` or the Snap manifest file.\n * These are assumed to be in the current working directory.\n *\n * @param snapJsonFileName - The name of the file to read.\n * @returns The parsed JSON file.\n */\nasync function readSnapJsonFile(\n  snapJsonFileName: NpmSnapFileNames,\n): Promise<Json> {\n  try {\n    return await readJsonFile(snapJsonFileName);\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      throw new Error(\n        `${errorPrefix}Could not find '${snapJsonFileName}'. Please ensure that ` +\n          `you are running the command in the project root directory.`,\n      );\n    }\n    throw new Error(`${errorPrefix}${error.message}`);\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the bundle file, if any.\n */\nasync function getSnapSourceCode(manifest: Json): Promise<string | undefined> {\n  if (manifest && typeof manifest === 'object' && !Array.isArray(manifest)) {\n    /* istanbul ignore next: optional chaining */\n    const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n      ?.npm?.filePath;\n\n    try {\n      return sourceFilePath\n        ? await fs.readFile(sourceFilePath, 'utf8')\n        : undefined;\n    } catch (error) {\n      throw new Error(\n        `Manifest Error: Failed to read Snap bundle file: ${error.message}`,\n      );\n    }\n  }\n  return undefined;\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nfunction fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): SnapManifest {\n  const { manifest, packageJson, sourceCode } = snapFiles;\n  const manifestCopy = deepClone(manifest);\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.repository\n        ? deepClone(packageJson.repository)\n        : null;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = getSnapSourceShasum(sourceCode);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      // eslint-disable-next-line no-case-declarations\n      const failureReason: never = error.reason;\n      throw new Error(\n        `Unrecognized validation failure reason: '${failureReason}'`,\n      );\n  }\n\n  return manifestCopy;\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n  return (\n    Object.keys(\n      repository ? { ...remaining, repository } : remaining,\n    ) as (keyof SnapManifest)[]\n  )\n    .sort((a, b) => ManifestSortOrder[a] - ManifestSortOrder[b])\n    .reduce((outManifest, key) => {\n      (outManifest as any)[key] = manifest[key];\n      return outManifest;\n    }, {} as SnapManifest);\n}\n"]}

package/dist/cmds/watch/watchHandler.js

@@ -35,6 +35,8 @@ async function watch(argv) {
             `**/${dist}/**`,
             `**/test/**`,
             `**/tests/**`,
+            `**/*.test.js`,
+            `**/*.test.ts`,
             /* istanbul ignore next */
             (str) => str !== '.' && str.startsWith('.'),
         ],

package/dist/cmds/watch/watchHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchHandler.js","sourceRoot":"","sources":["../../../src/cmds/watch/watchHandler.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAEhC,4CAAyC;AACzC,uCAMqB;AAErB;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,WAAW,EAAE;QACf,2BAAmB,CAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,wBAAgB,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,uBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,MAAM,OAAO,GACX,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7E,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,kBAAQ,CAAC,KAAK,CAAC,OAAO,EAAE;QACtC,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,oBAAoB;YACpB,MAAM,IAAI,KAAK;YACf,YAAY;YACZ,aAAa;YACb,0BAA0B;YAC1B,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;SACpD;KACF,CAAC,CAAC;IAEH,OAAO;SACJ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QAChB,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE;QAC1B,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC;QACnC,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAY,EAAE,EAAE;QAC7B,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;QACrC,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;SACpE,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;QAC1B,gBAAQ,CAAC,kBAAkB,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEL,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1B,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,kBAAkB,CAAC,CAAC;AACtD,CAAC;AA1CD,sBA0CC","sourcesContent":["import chokidar from 'chokidar';\nimport { YargsArgs } from '../../types/yargs';\nimport { bundle } from '../build/bundle';\nimport {\n  logError,\n  getOutfilePath,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\n\n/**\n * Watch a directory and its subdirectories for changes, and build when files\n * are added or changed.\n *\n * Ignores 'node_modules' and dotfiles.\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - arguments as an object generated by 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 watch(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  const rootDir =\n    src.indexOf('/') === -1 ? '.' : src.substring(0, src.lastIndexOf('/') + 1);\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n\n  const watcher = chokidar.watch(rootDir, {\n    ignoreInitial: true,\n    ignored: [\n      '**/node_modules/**',\n      `**/${dist}/**`,\n      `**/test/**`,\n      `**/tests/**`,\n      /* istanbul ignore next */\n      (str: string) => str !== '.' && str.startsWith('.'),\n    ],\n  });\n\n  watcher\n    .on('ready', () => {\n      bundle(src, outfilePath, argv);\n    })\n    .on('add', (path: string) => {\n      console.log(`File added: ${path}`);\n      bundle(src, outfilePath, argv);\n    })\n    .on('change', (path: string) => {\n      console.log(`File changed: ${path}`);\n      bundle(src, outfilePath, argv);\n    })\n    .on('unlink', (path: string) => console.log(`File removed: ${path}`))\n    .on('error', (err: Error) => {\n      logError(`Watcher error: ${err.message}`, err);\n    });\n\n  watcher.add(`${rootDir}`);\n  console.log(`Watching '${rootDir}' for changes...`);\n}\n"]}
+{"version":3,"file":"watchHandler.js","sourceRoot":"","sources":["../../../src/cmds/watch/watchHandler.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAEhC,4CAAyC;AACzC,uCAMqB;AAErB;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,WAAW,EAAE;QACf,2BAAmB,CAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,wBAAgB,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,uBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,MAAM,OAAO,GACX,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7E,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,kBAAQ,CAAC,KAAK,CAAC,OAAO,EAAE;QACtC,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,oBAAoB;YACpB,MAAM,IAAI,KAAK;YACf,YAAY;YACZ,aAAa;YACb,cAAc;YACd,cAAc;YACd,0BAA0B;YAC1B,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;SACpD;KACF,CAAC,CAAC;IAEH,OAAO;SACJ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QAChB,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE;QAC1B,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC;QACnC,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAY,EAAE,EAAE;QAC7B,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;QACrC,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;SACpE,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;QAC1B,gBAAQ,CAAC,kBAAkB,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEL,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1B,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,kBAAkB,CAAC,CAAC;AACtD,CAAC;AA5CD,sBA4CC","sourcesContent":["import chokidar from 'chokidar';\nimport { YargsArgs } from '../../types/yargs';\nimport { bundle } from '../build/bundle';\nimport {\n  logError,\n  getOutfilePath,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\n\n/**\n * Watch a directory and its subdirectories for changes, and build when files\n * are added or changed.\n *\n * Ignores 'node_modules' and dotfiles.\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - arguments as an object generated by 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 watch(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  const rootDir =\n    src.indexOf('/') === -1 ? '.' : src.substring(0, src.lastIndexOf('/') + 1);\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n\n  const watcher = chokidar.watch(rootDir, {\n    ignoreInitial: true,\n    ignored: [\n      '**/node_modules/**',\n      `**/${dist}/**`,\n      `**/test/**`,\n      `**/tests/**`,\n      `**/*.test.js`,\n      `**/*.test.ts`,\n      /* istanbul ignore next */\n      (str: string) => str !== '.' && str.startsWith('.'),\n    ],\n  });\n\n  watcher\n    .on('ready', () => {\n      bundle(src, outfilePath, argv);\n    })\n    .on('add', (path: string) => {\n      console.log(`File added: ${path}`);\n      bundle(src, outfilePath, argv);\n    })\n    .on('change', (path: string) => {\n      console.log(`File changed: ${path}`);\n      bundle(src, outfilePath, argv);\n    })\n    .on('unlink', (path: string) => console.log(`File removed: ${path}`))\n    .on('error', (err: Error) => {\n      logError(`Watcher error: ${err.message}`, err);\n    });\n\n  watcher.add(`${rootDir}`);\n  console.log(`Watching '${rootDir}' for changes...`);\n}\n"]}

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;AACA,+BAA4B;AAC5B,kDAA8B;AAE9B,MAAM,CAAC,KAAK,GAAG;IACb,aAAa,EAAE,KAAK;IACpB,gBAAgB,EAAE,KAAK;IACvB,UAAU,EAAE,KAAK;CAClB,CAAC;AAEF,SAAG,CAAC,OAAO,CAAC,IAAI,EAAE,cAAQ,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\nimport { cli } from './cli';\nimport commands from './cmds';\n\nglobal.snaps = {\n  verboseErrors: false,\n  suppressWarnings: false,\n  isWatching: false,\n};\n\ncli(process.argv, commands);\n"]}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;AAEA,+BAA4B;AAC5B,kDAA8B;AAE9B,MAAM,CAAC,KAAK,GAAG;IACb,aAAa,EAAE,KAAK;IACpB,gBAAgB,EAAE,KAAK;IACvB,UAAU,EAAE,KAAK;CAClB,CAAC;AAEF,SAAG,CAAC,OAAO,CAAC,IAAI,EAAE,cAAQ,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport { cli } from './cli';\nimport commands from './cmds';\n\nglobal.snaps = {\n  verboseErrors: false,\n  suppressWarnings: false,\n  isWatching: false,\n};\n\ncli(process.argv, commands);\n"]}

package/dist/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "../tsconfig.test.json"
+}

package/dist/utils/fs.d.ts

@@ -1,3 +1,4 @@
+import type { Json } from '@metamask/snap-controllers';
 /**
  * Checks whether the given path string resolves to an existing directory, and
  * optionally creates the directory if it doesn't exist.
@@ -10,7 +11,14 @@ export declare function isDirectory(pathString: string, createDir: boolean): Pro
 /**
  * Checks whether the given path string resolves to an existing file.
  *
- * @param {string} pathString - The path string to check
- * @returns {boolean} - Whether the given path is an existing file
+ * @param pathString - The path string to check
+ * @returns Whether the given path is an existing file
  */
 export declare function isFile(pathString: string): Promise<boolean>;
+/**
+ * Reads a `.json` file, parses its contents, and returns them.
+ *
+ * @param pathString - The path to the JSON file.
+ * @returns The parsed contents of the JSON file.
+ */
+export declare function readJsonFile(pathString: string): Promise<Json>;

package/dist/utils/fs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFile = exports.isDirectory = void 0;
+exports.readJsonFile = exports.isFile = exports.isDirectory = void 0;
 const fs_1 = require("fs");
 const misc_1 = require("./misc");
 /**
@@ -37,8 +37,8 @@ exports.isDirectory = isDirectory;
 /**
  * Checks whether the given path string resolves to an existing file.
  *
- * @param {string} pathString - The path string to check
- * @returns {boolean} - Whether the given path is an existing file
+ * @param pathString - The path string to check
+ * @returns Whether the given path is an existing file
  */
 async function isFile(pathString) {
     try {
@@ -50,4 +50,17 @@ async function isFile(pathString) {
     }
 }
 exports.isFile = isFile;
+/**
+ * Reads a `.json` file, parses its contents, and returns them.
+ *
+ * @param pathString - The path to the JSON file.
+ * @returns The parsed contents of the JSON file.
+ */
+async function readJsonFile(pathString) {
+    if (!pathString.endsWith('.json')) {
+        throw new Error('The specified file must be a ".json" file.');
+    }
+    return JSON.parse(await fs_1.promises.readFile(pathString, 'utf8'));
+}
+exports.readJsonFile = readJsonFile;
 //# sourceMappingURL=fs.js.map

package/dist/utils/fs.js.map

@@ -1 +1 @@
-{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../src/utils/fs.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AACpC,iCAAkC;AAElC;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,KAAK,CAAC;aACd;YAED,IAAI;gBACF,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC3B,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,UAAU,EAAE;gBACnB,eAAQ,CAAC,cAAc,UAAU,yBAAyB,EAAE,UAAU,CAAC,CAAC;gBACxE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;SACF;QACD,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAvBD,kCAuBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wBAOC","sourcesContent":["import { promises as fs } from 'fs';\nimport { logError } from './misc';\n\n/**\n * Checks whether the given path string resolves to an existing directory, and\n * optionally creates the directory if it doesn't exist.\n *\n * @param pathString - The path string to check\n * @param createDir - Whether to create the directory if it doesn't exist\n * @returns - Whether the given path is an existing directory\n */\nexport async function isDirectory(\n  pathString: string,\n  createDir: boolean,\n): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isDirectory();\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      if (!createDir) {\n        return false;\n      }\n\n      try {\n        await fs.mkdir(pathString);\n        return true;\n      } catch (mkdirError) {\n        logError(`Directory '${pathString}' could not be created.`, mkdirError);\n        process.exit(1);\n      }\n    }\n    return false;\n  }\n}\n\n/**\n * Checks whether the given path string resolves to an existing file.\n *\n * @param {string} pathString - The path string to check\n * @returns {boolean} - Whether the given path is an existing file\n */\nexport async function isFile(pathString: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isFile();\n  } catch (error) {\n    return false;\n  }\n}\n"]}
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../src/utils/fs.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AAEpC,iCAAkC;AAElC;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,KAAK,CAAC;aACd;YAED,IAAI;gBACF,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC3B,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,UAAU,EAAE;gBACnB,eAAQ,CAAC,cAAc,UAAU,yBAAyB,EAAE,UAAU,CAAC,CAAC;gBACxE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;SACF;QACD,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAvBD,kCAuBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wBAOC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,UAAkB;IACnD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3D,CAAC;AAND,oCAMC","sourcesContent":["import { promises as fs } from 'fs';\nimport type { Json } from '@metamask/snap-controllers';\nimport { logError } from './misc';\n\n/**\n * Checks whether the given path string resolves to an existing directory, and\n * optionally creates the directory if it doesn't exist.\n *\n * @param pathString - The path string to check\n * @param createDir - Whether to create the directory if it doesn't exist\n * @returns - Whether the given path is an existing directory\n */\nexport async function isDirectory(\n  pathString: string,\n  createDir: boolean,\n): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isDirectory();\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      if (!createDir) {\n        return false;\n      }\n\n      try {\n        await fs.mkdir(pathString);\n        return true;\n      } catch (mkdirError) {\n        logError(`Directory '${pathString}' could not be created.`, mkdirError);\n        process.exit(1);\n      }\n    }\n    return false;\n  }\n}\n\n/**\n * Checks whether the given path string resolves to an existing file.\n *\n * @param pathString - The path string to check\n * @returns Whether the given path is an existing file\n */\nexport async function isFile(pathString: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isFile();\n  } catch (error) {\n    return false;\n  }\n}\n\n/**\n * Reads a `.json` file, parses its contents, and returns them.\n *\n * @param pathString - The path to the JSON file.\n * @returns The parsed contents of the JSON file.\n */\nexport async function readJsonFile(pathString: string): Promise<Json> {\n  if (!pathString.endsWith('.json')) {\n    throw new Error('The specified file must be a \".json\" file.');\n  }\n\n  return JSON.parse(await fs.readFile(pathString, 'utf8'));\n}\n"]}

package/dist/utils/misc.d.ts

@@ -1,18 +1,19 @@
 import { Arguments } from 'yargs';
+export declare const deepClone: <T>(input: T) => T;
 export declare const permRequestKeys: string[];
-export declare const CONFIG_PATHS: string[];
+export declare const CONFIG_FILE = "snap.config.json";
 /**
  * Sets global variable snaps which tracks user settings:
  * watch mode activation, verbose errors messages, and whether to suppress warnings.
  *
- * @param {Argument} argv - arguments as an object generated by yargs
+ * @param argv - arguments as an object generated by yargs
  */
 export declare function setSnapGlobals(argv: Arguments): void;
 /**
  * Sanitizes inputs. Currently normalizes "./" paths to ".".
  * Yargs handles other path normalization as specified in builders.
  *
- * @param {Argument} argv - arguments as an object generated by yargs
+ * @param argv - arguments as an object generated by yargs
  */
 export declare function sanitizeInputs(argv: Arguments): void;
 /**