@metamask/snaps-utils 0.24.0

package/dist/manifest/manifest.js

@@ -0,0 +1,237 @@
+"use strict";
+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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateNpmSnapManifest = exports.getWritableManifest = exports.getSnapSourceCode = exports.fixManifest = exports.checkManifest = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
+const deep_clone_1 = require("../deep-clone");
+const fs_2 = require("../fs");
+const npm_1 = require("../npm");
+const snaps_1 = require("../snaps");
+const types_1 = require("../types");
+const MANIFEST_SORT_ORDER = {
+    version: 1,
+    description: 2,
+    proposedName: 3,
+    repository: 4,
+    source: 5,
+    initialPermissions: 6,
+    manifestVersion: 7,
+};
+/**
+ * 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 basePath - The path to the folder with the manifest files.
+ * @param writeManifest - Whether to write the fixed manifest to disk.
+ * @param sourceCode - The source code of the Snap.
+ * @returns Whether the manifest was updated, and an array of warnings that
+ * were encountered during processing of the manifest files.
+ */
+async function checkManifest(basePath, writeManifest = true, sourceCode) {
+    var _a, _b, _c;
+    const warnings = [];
+    const errors = [];
+    let updated = false;
+    const unvalidatedManifest = await (0, fs_2.readSnapJsonFile)(basePath, types_1.NpmSnapFileNames.Manifest);
+    const iconPath = unvalidatedManifest && typeof unvalidatedManifest === 'object'
+        ? /* istanbul ignore next */
+            (_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
+        : /* istanbul ignore next */
+            undefined;
+    const snapFiles = {
+        manifest: unvalidatedManifest,
+        packageJson: await (0, fs_2.readSnapJsonFile)(basePath, types_1.NpmSnapFileNames.PackageJson),
+        sourceCode: sourceCode !== null && sourceCode !== void 0 ? sourceCode : (await getSnapSourceCode(basePath, unvalidatedManifest)),
+        svgIcon: iconPath &&
+            (await fs_1.promises.readFile(path_1.default.join(basePath, iconPath), 'utf8')),
+    };
+    let manifest;
+    try {
+        ({ manifest } = (0, npm_1.validateNpmSnap)(snapFiles));
+    }
+    catch (error) {
+        if (error instanceof snaps_1.ProgrammaticallyFixableSnapError) {
+            errors.push(error.message);
+            // If we get here, the files at least have the correct shape.
+            const partiallyValidatedFiles = snapFiles;
+            let isInvalid = true;
+            let currentError = error;
+            const maxAttempts = Object.keys(types_1.SnapValidationFailureReason).length;
+            // Attempt to fix all fixable validation failure reasons. All such reasons
+            // are enumerated by the `SnapValidationFailureReason` enum, so we only
+            // attempt to fix the manifest the same amount of times as there are
+            // reasons in the enum.
+            for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {
+                manifest = fixManifest(manifest
+                    ? Object.assign(Object.assign({}, partiallyValidatedFiles), { manifest }) : partiallyValidatedFiles, currentError);
+                try {
+                    validateNpmSnapManifest(Object.assign(Object.assign({}, partiallyValidatedFiles), { manifest }));
+                    isInvalid = false;
+                }
+                catch (nextValidationError) {
+                    currentError = nextValidationError;
+                    /* istanbul ignore next: this should be impossible */
+                    if (!(nextValidationError instanceof snaps_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}`);
+                    }
+                    errors.push(currentError.message);
+                }
+            }
+            updated = true;
+        }
+        else {
+            throw error;
+        }
+    }
+    // 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) {
+        warnings.push(`Missing recommended package.json properties:\n${missingRecommendedFields.reduce((allMissing, currentField) => {
+            return `${allMissing}\t${currentField}\n`;
+        }, '')}`);
+    }
+    if (writeManifest) {
+        try {
+            await fs_1.promises.writeFile(path_1.default.join(basePath, types_1.NpmSnapFileNames.Manifest), `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\n`);
+        }
+        catch (error) {
+            // Note: This error isn't pushed to the errors array, because it's not an
+            // error in the manifest itself.
+            throw new Error(`Failed to update snap.manifest.json: ${error.message}`);
+        }
+    }
+    return { manifest: validatedManifest, updated, warnings, errors };
+}
+exports.checkManifest = checkManifest;
+/**
+ * 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 = (0, deep_clone_1.deepClone)(manifest);
+    switch (error.reason) {
+        case types_1.SnapValidationFailureReason.NameMismatch:
+            manifestCopy.source.location.npm.packageName = packageJson.name;
+            break;
+        case types_1.SnapValidationFailureReason.VersionMismatch:
+            manifestCopy.version = packageJson.version;
+            break;
+        case types_1.SnapValidationFailureReason.RepositoryMismatch:
+            manifestCopy.repository = packageJson.repository
+                ? (0, deep_clone_1.deepClone)(packageJson.repository)
+                : undefined;
+            break;
+        case types_1.SnapValidationFailureReason.ShasumMismatch:
+            manifestCopy.source.shasum = (0, snaps_1.getSnapSourceShasum)(sourceCode);
+            break;
+        /* istanbul ignore next */
+        default: {
+            const failureReason = error.reason;
+            throw new Error(`Unrecognized validation failure reason: '${failureReason}'`);
+        }
+    }
+    return manifestCopy;
+}
+exports.fixManifest = fixManifest;
+/**
+ * Given an unvalidated Snap manifest, attempts to extract the location of the
+ * bundle source file location and read the file.
+ *
+ * @param basePath - The path to the folder with the manifest files.
+ * @param manifest - The unvalidated Snap manifest file contents.
+ * @returns The contents of the bundle file, if any.
+ */
+async function getSnapSourceCode(basePath, manifest) {
+    var _a, _b, _c;
+    if (manifest && typeof manifest === 'object' && !Array.isArray(manifest)) {
+        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(path_1.default.join(basePath, sourceFilePath), 'utf8')
+                : undefined;
+        }
+        catch (error) {
+            throw new Error(`Failed to read Snap bundle file: ${error.message}`);
+        }
+    }
+    return undefined;
+}
+exports.getSnapSourceCode = getSnapSourceCode;
+/**
+ * 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"]);
+    const keys = Object.keys(repository ? Object.assign(Object.assign({}, remaining), { repository }) : remaining);
+    return keys
+        .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])
+        .reduce((result, key) => (Object.assign(Object.assign({}, result), { [key]: manifest[key] })), {});
+}
+exports.getWritableManifest = getWritableManifest;
+/**
+ * Validates the fields of an npm Snap manifest that has already passed JSON
+ * Schema validation.
+ *
+ * @param snapFiles - The relevant snap files to validate.
+ * @param snapFiles.manifest - The npm Snap manifest to validate.
+ * @param snapFiles.packageJson - The npm Snap's `package.json`.
+ * @param snapFiles.sourceCode - The Snap's source code.
+ * @returns A tuple containing the validated snap manifest, snap source code,
+ * and `package.json`.
+ */
+function validateNpmSnapManifest({ manifest, packageJson, sourceCode, }) {
+    const packageJsonName = packageJson.name;
+    const packageJsonVersion = packageJson.version;
+    const packageJsonRepository = packageJson.repository;
+    const manifestPackageName = manifest.source.location.npm.packageName;
+    const manifestPackageVersion = manifest.version;
+    const manifestRepository = manifest.repository;
+    if (packageJsonName !== manifestPackageName) {
+        throw new snaps_1.ProgrammaticallyFixableSnapError(`"${types_1.NpmSnapFileNames.Manifest}" npm package name ("${manifestPackageName}") does not match the "${types_1.NpmSnapFileNames.PackageJson}" "name" field ("${packageJsonName}").`, types_1.SnapValidationFailureReason.NameMismatch);
+    }
+    if (packageJsonVersion !== manifestPackageVersion) {
+        throw new snaps_1.ProgrammaticallyFixableSnapError(`"${types_1.NpmSnapFileNames.Manifest}" npm package version ("${manifestPackageVersion}") does not match the "${types_1.NpmSnapFileNames.PackageJson}" "version" field ("${packageJsonVersion}").`, types_1.SnapValidationFailureReason.VersionMismatch);
+    }
+    if (
+    // The repository may be `undefined` in package.json but can only be defined
+    // or `null` in the Snap manifest due to TS@<4.4 issues.
+    (packageJsonRepository || manifestRepository) &&
+        !(0, fast_deep_equal_1.default)(packageJsonRepository, manifestRepository)) {
+        throw new snaps_1.ProgrammaticallyFixableSnapError(`"${types_1.NpmSnapFileNames.Manifest}" "repository" field does not match the "${types_1.NpmSnapFileNames.PackageJson}" "repository" field.`, types_1.SnapValidationFailureReason.RepositoryMismatch);
+    }
+    (0, snaps_1.validateSnapShasum)(manifest, sourceCode, `"${types_1.NpmSnapFileNames.Manifest}" "shasum" field does not match computed shasum.`);
+    return [manifest, sourceCode, packageJson];
+}
+exports.validateNpmSnapManifest = validateNpmSnapManifest;
+//# sourceMappingURL=manifest.js.map

package/dist/manifest/manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../src/manifest/manifest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2BAAoC;AACpC,gDAA6B;AAG7B,sEAAwC;AACxC,8CAA0C;AAC1C,8BAAyC;AACzC,gCAAyC;AACzC,oCAIkB;AAClB,oCAMkB;AAGlB,MAAM,mBAAmB,GAAuC;IAC9D,OAAO,EAAE,CAAC;IACV,WAAW,EAAE,CAAC;IACd,YAAY,EAAE,CAAC;IACf,UAAU,EAAE,CAAC;IACb,MAAM,EAAE,CAAC;IACT,kBAAkB,EAAE,CAAC;IACrB,eAAe,EAAE,CAAC;CACnB,CAAC;AAuBF;;;;;;;;;;GAUG;AACI,KAAK,UAAU,aAAa,CACjC,QAAgB,EAChB,aAAa,GAAG,IAAI,EACpB,UAAmB;;IAEnB,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,OAAO,GAAG,KAAK,CAAC;IAEpB,MAAM,mBAAmB,GAAG,MAAM,IAAA,qBAAgB,EAChD,QAAQ,EACR,wBAAgB,CAAC,QAAQ,CAC1B,CAAC;IAEF,MAAM,QAAQ,GACZ,mBAAmB,IAAI,OAAO,mBAAmB,KAAK,QAAQ;QAC5D,CAAC,CAAC,0BAA0B;YAC1B,MAAA,MAAA,MAAC,mBAA6C,CAAC,MAAM,0CAAE,QAAQ,0CAAE,GAAG,0CAChE,QAAQ;QACd,CAAC,CAAC,0BAA0B;YAC1B,SAAS,CAAC;IAEhB,MAAM,SAAS,GAAyB;QACtC,QAAQ,EAAE,mBAAmB;QAC7B,WAAW,EAAE,MAAM,IAAA,qBAAgB,EAAC,QAAQ,EAAE,wBAAgB,CAAC,WAAW,CAAC;QAC3E,UAAU,EACR,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,CAAC,MAAM,iBAAiB,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACxE,OAAO,EACL,QAAQ;YACR,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,cAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;KAClE,CAAC;IAEF,IAAI,QAAkC,CAAC;IACvC,IAAI;QACF,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAA,qBAAe,EAAC,SAAS,CAAC,CAAC,CAAC;KAC7C;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,YAAY,wCAAgC,EAAE;YACrD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE3B,6DAA6D;YAC7D,MAAM,uBAAuB,GAAG,SAAsB,CAAC;YAEvD,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,IAAI,YAAY,GAAG,KAAK,CAAC;YACzB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,mCAA2B,CAAC,CAAC,MAAM,CAAC;YAEpE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,SAAS,IAAI,QAAQ,IAAI,WAAW,EAAE,QAAQ,EAAE,EAAE;gBACvE,QAAQ,GAAG,WAAW,CACpB,QAAQ;oBACN,CAAC,iCAAM,uBAAuB,KAAE,QAAQ,IACxC,CAAC,CAAC,uBAAuB,EAC3B,YAAY,CACb,CAAC;gBAEF,IAAI;oBACF,uBAAuB,iCAAM,uBAAuB,KAAE,QAAQ,IAAG,CAAC;oBAElE,SAAS,GAAG,KAAK,CAAC;iBACnB;gBAAC,OAAO,mBAAmB,EAAE;oBAC5B,YAAY,GAAG,mBAAmB,CAAC;oBACnC,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;oBAED,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;iBACnC;aACF;YAED,OAAO,GAAG,IAAI,CAAC;SAChB;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,QAAQ,CAAC,IAAI,CACX,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,IAAI,aAAa,EAAE;QACjB,IAAI;YACF,MAAM,aAAE,CAAC,SAAS,CAChB,cAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,wBAAgB,CAAC,QAAQ,CAAC,EACnD,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CACvE,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAI,KAAK,CAAC,wCAAwC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1E;KACF;IAED,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AACpE,CAAC;AA3HD,sCA2HC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CACzB,SAAoB,EACpB,KAAuC;IAEvC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACxD,MAAM,YAAY,GAAG,IAAA,sBAAS,EAAC,QAAQ,CAAC,CAAC;IAEzC,QAAQ,KAAK,CAAC,MAAM,EAAE;QACpB,KAAK,mCAA2B,CAAC,YAAY;YAC3C,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC;YAChE,MAAM;QAER,KAAK,mCAA2B,CAAC,eAAe;YAC9C,YAAY,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;YAC3C,MAAM;QAER,KAAK,mCAA2B,CAAC,kBAAkB;YACjD,YAAY,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU;gBAC9C,CAAC,CAAC,IAAA,sBAAS,EAAC,WAAW,CAAC,UAAU,CAAC;gBACnC,CAAC,CAAC,SAAS,CAAC;YACd,MAAM;QAER,KAAK,mCAA2B,CAAC,cAAc;YAC7C,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,IAAA,2BAAmB,EAAC,UAAU,CAAC,CAAC;YAC7D,MAAM;QAER,0BAA0B;QAC1B,OAAO,CAAC,CAAC;YACP,MAAM,aAAa,GAAU,KAAK,CAAC,MAAM,CAAC;YAC1C,MAAM,IAAI,KAAK,CACb,4CAA4C,aAAa,GAAG,CAC7D,CAAC;SACH;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AApCD,kCAoCC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,iBAAiB,CACrC,QAAgB,EAChB,QAAc;;IAEd,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxE,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,cAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC;gBACrE,CAAC,CAAC,SAAS,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;SACtE;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAlBD,8CAkBC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,QAAsB;IACxD,MAAM,EAAE,UAAU,KAAmB,QAAQ,EAAtB,SAAS,UAAK,QAAQ,EAAvC,cAA4B,CAAW,CAAC;IAE9C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CACtB,UAAU,CAAC,CAAC,iCAAM,SAAS,KAAE,UAAU,IAAG,CAAC,CAAC,SAAS,CAC5B,CAAC;IAE5B,OAAO,IAAI;SACR,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;SAC/D,MAAM,CACL,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,IACpB,EACF,EAAkB,CACnB,CAAC;AACN,CAAC;AAhBD,kDAgBC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,uBAAuB,CAAC,EACtC,QAAQ,EACR,WAAW,EACX,UAAU,GACA;IACV,MAAM,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC;IACzC,MAAM,kBAAkB,GAAG,WAAW,CAAC,OAAO,CAAC;IAC/C,MAAM,qBAAqB,GAAG,WAAW,CAAC,UAAU,CAAC;IAErD,MAAM,mBAAmB,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;IACrE,MAAM,sBAAsB,GAAG,QAAQ,CAAC,OAAO,CAAC;IAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC;IAE/C,IAAI,eAAe,KAAK,mBAAmB,EAAE;QAC3C,MAAM,IAAI,wCAAgC,CACxC,IAAI,wBAAgB,CAAC,QAAQ,wBAAwB,mBAAmB,0BAA0B,wBAAgB,CAAC,WAAW,oBAAoB,eAAe,KAAK,EACtK,mCAA2B,CAAC,YAAY,CACzC,CAAC;KACH;IAED,IAAI,kBAAkB,KAAK,sBAAsB,EAAE;QACjD,MAAM,IAAI,wCAAgC,CACxC,IAAI,wBAAgB,CAAC,QAAQ,2BAA2B,sBAAsB,0BAA0B,wBAAgB,CAAC,WAAW,uBAAuB,kBAAkB,KAAK,EAClL,mCAA2B,CAAC,eAAe,CAC5C,CAAC;KACH;IAED;IACE,4EAA4E;IAC5E,wDAAwD;IACxD,CAAC,qBAAqB,IAAI,kBAAkB,CAAC;QAC7C,CAAC,IAAA,yBAAS,EAAC,qBAAqB,EAAE,kBAAkB,CAAC,EACrD;QACA,MAAM,IAAI,wCAAgC,CACxC,IAAI,wBAAgB,CAAC,QAAQ,4CAA4C,wBAAgB,CAAC,WAAW,uBAAuB,EAC5H,mCAA2B,CAAC,kBAAkB,CAC/C,CAAC;KACH;IAED,IAAA,0BAAkB,EAChB,QAAQ,EACR,UAAU,EACV,IAAI,wBAAgB,CAAC,QAAQ,kDAAkD,CAChF,CAAC;IACF,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;AAC7C,CAAC;AA7CD,0DA6CC","sourcesContent":["import { promises as fs } from 'fs';\nimport pathUtils from 'path';\n\nimport { Json } from '@metamask/utils';\nimport deepEqual from 'fast-deep-equal';\nimport { deepClone } from '../deep-clone';\nimport { readSnapJsonFile } from '../fs';\nimport { validateNpmSnap } from '../npm';\nimport {\n  getSnapSourceShasum,\n  ProgrammaticallyFixableSnapError,\n  validateSnapShasum,\n} from '../snaps';\nimport {\n  NpmSnapFileNames,\n  NpmSnapPackageJson,\n  SnapFiles,\n  SnapValidationFailureReason,\n  UnvalidatedSnapFiles,\n} from '../types';\nimport { SnapManifest } from './validation';\n\nconst MANIFEST_SORT_ORDER: Record<keyof SnapManifest, number> = {\n  version: 1,\n  description: 2,\n  proposedName: 3,\n  repository: 4,\n  source: 5,\n  initialPermissions: 6,\n  manifestVersion: 7,\n};\n\n/**\n * The result from the `checkManifest` function.\n *\n * @property manifest - The fixed manifest object.\n * @property updated - Whether the manifest was updated.\n * @property warnings - An array of warnings that were encountered during\n * processing of the manifest files. These warnings are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n * @property errors - An array of errors that were encountered during\n * processing of the manifest files. These errors are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n */\nexport type CheckManifestResult = {\n  manifest: SnapManifest;\n  updated?: boolean;\n  warnings: string[];\n  errors: string[];\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 basePath - The path to the folder with the manifest files.\n * @param writeManifest - Whether to write the fixed manifest to disk.\n * @param sourceCode - The source code of the Snap.\n * @returns Whether the manifest was updated, and an array of warnings that\n * were encountered during processing of the manifest files.\n */\nexport async function checkManifest(\n  basePath: string,\n  writeManifest = true,\n  sourceCode?: string,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const unvalidatedManifest = await readSnapJsonFile(\n    basePath,\n    NpmSnapFileNames.Manifest,\n  );\n\n  const iconPath =\n    unvalidatedManifest && typeof unvalidatedManifest === 'object'\n      ? /* istanbul ignore next */\n        (unvalidatedManifest as Partial<SnapManifest>).source?.location?.npm\n          ?.iconPath\n      : /* istanbul ignore next */\n        undefined;\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: unvalidatedManifest,\n    packageJson: await readSnapJsonFile(basePath, NpmSnapFileNames.PackageJson),\n    sourceCode:\n      sourceCode ?? (await getSnapSourceCode(basePath, unvalidatedManifest)),\n    svgIcon:\n      iconPath &&\n      (await fs.readFile(pathUtils.join(basePath, iconPath), 'utf8')),\n  };\n\n  let manifest: SnapManifest | undefined;\n  try {\n    ({ manifest } = validateNpmSnap(snapFiles));\n  } catch (error) {\n    if (error instanceof ProgrammaticallyFixableSnapError) {\n      errors.push(error.message);\n\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      let currentError = error;\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      // attempt to fix the manifest the same amount of times as there are\n      // reasons in the enum.\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = fixManifest(\n          manifest\n            ? { ...partiallyValidatedFiles, manifest }\n            : partiallyValidatedFiles,\n          currentError,\n        );\n\n        try {\n          validateNpmSnapManifest({ ...partiallyValidatedFiles, manifest });\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          currentError = 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          errors.push(currentError.message);\n        }\n      }\n\n      updated = 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    warnings.push(\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  if (writeManifest) {\n    try {\n      await fs.writeFile(\n        pathUtils.join(basePath, NpmSnapFileNames.Manifest),\n        `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\\n`,\n      );\n    } catch (error) {\n      // Note: This error isn't pushed to the errors array, because it's not an\n      // error in the manifest itself.\n      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);\n    }\n  }\n\n  return { manifest: validatedManifest, updated, warnings, errors };\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 */\nexport function 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        : undefined;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = getSnapSourceShasum(sourceCode);\n      break;\n\n    /* istanbul ignore next */\n    default: {\n      const failureReason: never = error.reason;\n      throw new Error(\n        `Unrecognized validation failure reason: '${failureReason}'`,\n      );\n    }\n  }\n\n  return manifestCopy;\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 basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the bundle file, if any.\n */\nexport async function getSnapSourceCode(\n  basePath: string,\n  manifest: Json,\n): Promise<string | undefined> {\n  if (manifest && typeof manifest === 'object' && !Array.isArray(manifest)) {\n    const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n      ?.npm?.filePath;\n\n    try {\n      return sourceFilePath\n        ? await fs.readFile(pathUtils.join(basePath, sourceFilePath), 'utf8')\n        : undefined;\n    } catch (error) {\n      throw new Error(`Failed to read Snap bundle file: ${error.message}`);\n    }\n  }\n\n  return undefined;\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\n  const keys = Object.keys(\n    repository ? { ...remaining, repository } : remaining,\n  ) as (keyof SnapManifest)[];\n\n  return keys\n    .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])\n    .reduce(\n      (result, key) => ({\n        ...result,\n        [key]: manifest[key],\n      }),\n      {} as SnapManifest,\n    );\n}\n\n/**\n * Validates the fields of an npm Snap manifest that has already passed JSON\n * Schema validation.\n *\n * @param snapFiles - The relevant snap files to validate.\n * @param snapFiles.manifest - The npm Snap manifest to validate.\n * @param snapFiles.packageJson - The npm Snap's `package.json`.\n * @param snapFiles.sourceCode - The Snap's source code.\n * @returns A tuple containing the validated snap manifest, snap source code,\n * and `package.json`.\n */\nexport function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n}: SnapFiles): [SnapManifest, string, NpmSnapPackageJson] {\n  const packageJsonName = packageJson.name;\n  const packageJsonVersion = packageJson.version;\n  const packageJsonRepository = packageJson.repository;\n\n  const manifestPackageName = manifest.source.location.npm.packageName;\n  const manifestPackageVersion = manifest.version;\n  const manifestRepository = manifest.repository;\n\n  if (packageJsonName !== manifestPackageName) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package name (\"${manifestPackageName}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"name\" field (\"${packageJsonName}\").`,\n      SnapValidationFailureReason.NameMismatch,\n    );\n  }\n\n  if (packageJsonVersion !== manifestPackageVersion) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package version (\"${manifestPackageVersion}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"version\" field (\"${packageJsonVersion}\").`,\n      SnapValidationFailureReason.VersionMismatch,\n    );\n  }\n\n  if (\n    // The repository may be `undefined` in package.json but can only be defined\n    // or `null` in the Snap manifest due to TS@<4.4 issues.\n    (packageJsonRepository || manifestRepository) &&\n    !deepEqual(packageJsonRepository, manifestRepository)\n  ) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" \"repository\" field does not match the \"${NpmSnapFileNames.PackageJson}\" \"repository\" field.`,\n      SnapValidationFailureReason.RepositoryMismatch,\n    );\n  }\n\n  validateSnapShasum(\n    manifest,\n    sourceCode,\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n  return [manifest, sourceCode, packageJson];\n}\n"]}