@metamask/snaps-utils 6.1.0 → 7.0.1

package/dist/cjs/localization.js

@@ -1,113 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    LOCALIZABLE_FIELDS: function() {
-        return LOCALIZABLE_FIELDS;
-    },
-    LocalizationFileStruct: function() {
-        return LocalizationFileStruct;
-    },
-    getValidatedLocalizationFiles: function() {
-        return getValidatedLocalizationFiles;
-    },
-    getLocalizationFile: function() {
-        return getLocalizationFile;
-    },
-    TRANSLATION_REGEX: function() {
-        return TRANSLATION_REGEX;
-    },
-    translate: function() {
-        return translate;
-    },
-    getLocalizedSnapManifest: function() {
-        return getLocalizedSnapManifest;
-    },
-    validateSnapManifestLocalizations: function() {
-        return validateSnapManifestLocalizations;
-    }
-});
-const _snapssdk = require("@metamask/snaps-sdk");
-const _superstruct = require("superstruct");
-const _json = require("./json");
-const LOCALIZABLE_FIELDS = [
-    'description',
-    'proposedName'
-];
-const LocalizationFileStruct = (0, _superstruct.object)({
-    locale: (0, _superstruct.string)(),
-    messages: (0, _superstruct.record)((0, _superstruct.string)(), (0, _superstruct.object)({
-        message: (0, _superstruct.string)(),
-        description: (0, _superstruct.optional)((0, _superstruct.string)())
-    }))
-});
-function getValidatedLocalizationFiles(localizationFiles) {
-    for (const file of localizationFiles){
-        try {
-            file.result = (0, _superstruct.create)((0, _json.parseJson)(file.toString()), LocalizationFileStruct);
-        } catch (error) {
-            if (error instanceof _superstruct.StructError) {
-                throw new Error(`Failed to validate localization file "${file.path}": ${error.message}.`);
-            }
-            if (error instanceof SyntaxError) {
-                throw new Error(`Failed to parse localization file "${file.path}" as JSON.`);
-            }
-            throw error;
-        }
-    }
-    return localizationFiles;
-}
-function getLocalizationFile(locale, localizationFiles) {
-    const file = localizationFiles.find((localizationFile)=>localizationFile.locale === locale);
-    if (!file) {
-        return localizationFiles.find((localizationFile)=>localizationFile.locale === 'en');
-    }
-    return file;
-}
-const TRANSLATION_REGEX = /\{\{\s?([a-zA-Z0-9-_\s]+)\s?\}\}/gu;
-function translate(value, file) {
-    const matches = value.matchAll(TRANSLATION_REGEX);
-    const array = Array.from(matches);
-    return array.reduce((result, [match, key])=>{
-        if (!file) {
-            throw new Error(`Failed to translate "${value}": No localization file found.`);
-        }
-        const translation = file.messages[key.trim()];
-        if (!translation) {
-            throw new Error(`Failed to translate "${value}": No translation found for "${key.trim()}" in "${file.locale}" file.`);
-        }
-        return result.replace(match, translation.message);
-    }, value);
-}
-function getLocalizedSnapManifest(snapManifest, locale, localizationFiles) {
-    const file = getLocalizationFile(locale, localizationFiles);
-    return LOCALIZABLE_FIELDS.reduce((manifest, field)=>{
-        const translation = translate(manifest[field], file);
-        return {
-            ...manifest,
-            [field]: translation
-        };
-    }, snapManifest);
-}
-function validateSnapManifestLocalizations(snapManifest, localizationFiles) {
-    try {
-        // `translate` throws if the manifest cannot be localized, so we just attempt
-        // to translate the manifest using all localization files.
-        localizationFiles.filter((file)=>file.locale !== 'en').forEach((file)=>{
-            getLocalizedSnapManifest(snapManifest, file.locale, localizationFiles);
-        });
-        // The manifest must be localizable in English.
-        getLocalizedSnapManifest(snapManifest, 'en', localizationFiles);
-    } catch (error) {
-        throw new Error(`Failed to localize Snap manifest: ${(0, _snapssdk.getErrorMessage)(error)}`);
-    }
-}
-
-//# sourceMappingURL=localization.js.map

package/dist/cjs/localization.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/localization.ts"],"sourcesContent":["import { getErrorMessage } from '@metamask/snaps-sdk';\nimport type { Infer } from 'superstruct';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  string,\n  StructError,\n} from 'superstruct';\n\nimport { parseJson } from './json';\nimport type { SnapManifest } from './manifest';\nimport type { VirtualFile } from './virtual-file';\n\nexport const LOCALIZABLE_FIELDS = ['description', 'proposedName'] as const;\n\nexport const LocalizationFileStruct = object({\n  locale: string(),\n  messages: record(\n    string(),\n    object({\n      message: string(),\n      description: optional(string()),\n    }),\n  ),\n});\n\nexport type LocalizationFile = Infer<typeof LocalizationFileStruct>;\n\n/**\n * Validate a list of localization files.\n *\n * @param localizationFiles - The localization files to validate.\n * @returns The validated localization files.\n * @throws If any of the files are considered invalid.\n */\nexport function getValidatedLocalizationFiles(\n  localizationFiles: VirtualFile[],\n): VirtualFile<LocalizationFile>[] {\n  for (const file of localizationFiles) {\n    try {\n      file.result = create(parseJson(file.toString()), LocalizationFileStruct);\n    } catch (error) {\n      if (error instanceof StructError) {\n        throw new Error(\n          `Failed to validate localization file \"${file.path}\": ${error.message}.`,\n        );\n      }\n\n      if (error instanceof SyntaxError) {\n        throw new Error(\n          `Failed to parse localization file \"${file.path}\" as JSON.`,\n        );\n      }\n\n      throw error;\n    }\n  }\n\n  return localizationFiles as VirtualFile<LocalizationFile>[];\n}\n\n/**\n * Get the localization file for a given locale. If the locale is not found,\n * the English localization file will be returned.\n *\n * @param locale - The locale to use.\n * @param localizationFiles - The localization files to use.\n * @returns The localization file, or `undefined` if no localization file was\n * found.\n */\nexport function getLocalizationFile(\n  locale: string,\n  localizationFiles: LocalizationFile[],\n) {\n  const file = localizationFiles.find(\n    (localizationFile) => localizationFile.locale === locale,\n  );\n\n  if (!file) {\n    return localizationFiles.find(\n      (localizationFile) => localizationFile.locale === 'en',\n    );\n  }\n\n  return file;\n}\n\nexport const TRANSLATION_REGEX = /\\{\\{\\s?([a-zA-Z0-9-_\\s]+)\\s?\\}\\}/gu;\n\n/**\n * Translate a string using a localization file. This will replace all instances\n * of `{{key}}` with the localized version of `key`.\n *\n * @param value - The string to translate.\n * @param file - The localization file to use, or `undefined` if no localization\n * file was found.\n * @returns The translated string.\n * @throws If the string contains a key that is not present in the localization\n * file, or if no localization file was found.\n */\nexport function translate(value: string, file: LocalizationFile | undefined) {\n  const matches = value.matchAll(TRANSLATION_REGEX);\n  const array = Array.from(matches);\n\n  return array.reduce<string>((result, [match, key]) => {\n    if (!file) {\n      throw new Error(\n        `Failed to translate \"${value}\": No localization file found.`,\n      );\n    }\n\n    const translation = file.messages[key.trim()];\n    if (!translation) {\n      throw new Error(\n        `Failed to translate \"${value}\": No translation found for \"${key.trim()}\" in \"${\n          file.locale\n        }\" file.`,\n      );\n    }\n\n    return result.replace(match, translation.message);\n  }, value);\n}\n\n/**\n * Get the localized Snap manifest for a given locale. This will replace all\n * localized strings in the manifest with the localized version.\n *\n * @param snapManifest - The Snap manifest to localize.\n * @param locale - The locale to use.\n * @param localizationFiles - The localization files to use.\n * @returns The localized Snap manifest.\n */\nexport function getLocalizedSnapManifest(\n  snapManifest: SnapManifest,\n  locale: string,\n  localizationFiles: LocalizationFile[],\n) {\n  const file = getLocalizationFile(locale, localizationFiles);\n\n  return LOCALIZABLE_FIELDS.reduce((manifest, field) => {\n    const translation = translate(manifest[field], file);\n    return {\n      ...manifest,\n      [field]: translation,\n    };\n  }, snapManifest);\n}\n\n/**\n * Validate the localization files for a Snap manifest.\n *\n * @param snapManifest - The Snap manifest to validate.\n * @param localizationFiles - The localization files to validate.\n * @throws If the manifest cannot be localized.\n */\nexport function validateSnapManifestLocalizations(\n  snapManifest: SnapManifest,\n  localizationFiles: LocalizationFile[],\n) {\n  try {\n    // `translate` throws if the manifest cannot be localized, so we just attempt\n    // to translate the manifest using all localization files.\n    localizationFiles\n      .filter((file) => file.locale !== 'en')\n      .forEach((file) => {\n        getLocalizedSnapManifest(snapManifest, file.locale, localizationFiles);\n      });\n\n    // The manifest must be localizable in English.\n    getLocalizedSnapManifest(snapManifest, 'en', localizationFiles);\n  } catch (error) {\n    throw new Error(\n      `Failed to localize Snap manifest: ${getErrorMessage(error)}`,\n    );\n  }\n}\n"],"names":["LOCALIZABLE_FIELDS","LocalizationFileStruct","getValidatedLocalizationFiles","getLocalizationFile","TRANSLATION_REGEX","translate","getLocalizedSnapManifest","validateSnapManifestLocalizations","object","locale","string","messages","record","message","description","optional","localizationFiles","file","result","create","parseJson","toString","error","StructError","Error","path","SyntaxError","find","localizationFile","value","matches","matchAll","array","Array","from","reduce","match","key","translation","trim","replace","snapManifest","manifest","field","filter","forEach","getErrorMessage"],"mappings":";;;;;;;;;;;IAeaA,kBAAkB;eAAlBA;;IAEAC,sBAAsB;eAAtBA;;IAoBGC,6BAA6B;eAA7BA;;IAmCAC,mBAAmB;eAAnBA;;IAiBHC,iBAAiB;eAAjBA;;IAaGC,SAAS;eAATA;;IAiCAC,wBAAwB;eAAxBA;;IAuBAC,iCAAiC;eAAjCA;;;0BA9JgB;6BASzB;sBAEmB;AAInB,MAAMP,qBAAqB;IAAC;IAAe;CAAe;AAE1D,MAAMC,yBAAyBO,IAAAA,mBAAM,EAAC;IAC3CC,QAAQC,IAAAA,mBAAM;IACdC,UAAUC,IAAAA,mBAAM,EACdF,IAAAA,mBAAM,KACNF,IAAAA,mBAAM,EAAC;QACLK,SAASH,IAAAA,mBAAM;QACfI,aAAaC,IAAAA,qBAAQ,EAACL,IAAAA,mBAAM;IAC9B;AAEJ;AAWO,SAASR,8BACdc,iBAAgC;IAEhC,KAAK,MAAMC,QAAQD,kBAAmB;QACpC,IAAI;YACFC,KAAKC,MAAM,GAAGC,IAAAA,mBAAM,EAACC,IAAAA,eAAS,EAACH,KAAKI,QAAQ,KAAKpB;QACnD,EAAE,OAAOqB,OAAO;YACd,IAAIA,iBAAiBC,wBAAW,EAAE;gBAChC,MAAM,IAAIC,MACR,CAAC,sCAAsC,EAAEP,KAAKQ,IAAI,CAAC,GAAG,EAAEH,MAAMT,OAAO,CAAC,CAAC,CAAC;YAE5E;YAEA,IAAIS,iBAAiBI,aAAa;gBAChC,MAAM,IAAIF,MACR,CAAC,mCAAmC,EAAEP,KAAKQ,IAAI,CAAC,UAAU,CAAC;YAE/D;YAEA,MAAMH;QACR;IACF;IAEA,OAAON;AACT;AAWO,SAASb,oBACdM,MAAc,EACdO,iBAAqC;IAErC,MAAMC,OAAOD,kBAAkBW,IAAI,CACjC,CAACC,mBAAqBA,iBAAiBnB,MAAM,KAAKA;IAGpD,IAAI,CAACQ,MAAM;QACT,OAAOD,kBAAkBW,IAAI,CAC3B,CAACC,mBAAqBA,iBAAiBnB,MAAM,KAAK;IAEtD;IAEA,OAAOQ;AACT;AAEO,MAAMb,oBAAoB;AAa1B,SAASC,UAAUwB,KAAa,EAAEZ,IAAkC;IACzE,MAAMa,UAAUD,MAAME,QAAQ,CAAC3B;IAC/B,MAAM4B,QAAQC,MAAMC,IAAI,CAACJ;IAEzB,OAAOE,MAAMG,MAAM,CAAS,CAACjB,QAAQ,CAACkB,OAAOC,IAAI;QAC/C,IAAI,CAACpB,MAAM;YACT,MAAM,IAAIO,MACR,CAAC,qBAAqB,EAAEK,MAAM,8BAA8B,CAAC;QAEjE;QAEA,MAAMS,cAAcrB,KAAKN,QAAQ,CAAC0B,IAAIE,IAAI,GAAG;QAC7C,IAAI,CAACD,aAAa;YAChB,MAAM,IAAId,MACR,CAAC,qBAAqB,EAAEK,MAAM,6BAA6B,EAAEQ,IAAIE,IAAI,GAAG,MAAM,EAC5EtB,KAAKR,MAAM,CACZ,OAAO,CAAC;QAEb;QAEA,OAAOS,OAAOsB,OAAO,CAACJ,OAAOE,YAAYzB,OAAO;IAClD,GAAGgB;AACL;AAWO,SAASvB,yBACdmC,YAA0B,EAC1BhC,MAAc,EACdO,iBAAqC;IAErC,MAAMC,OAAOd,oBAAoBM,QAAQO;IAEzC,OAAOhB,mBAAmBmC,MAAM,CAAC,CAACO,UAAUC;QAC1C,MAAML,cAAcjC,UAAUqC,QAAQ,CAACC,MAAM,EAAE1B;QAC/C,OAAO;YACL,GAAGyB,QAAQ;YACX,CAACC,MAAM,EAAEL;QACX;IACF,GAAGG;AACL;AASO,SAASlC,kCACdkC,YAA0B,EAC1BzB,iBAAqC;IAErC,IAAI;QACF,6EAA6E;QAC7E,0DAA0D;QAC1DA,kBACG4B,MAAM,CAAC,CAAC3B,OAASA,KAAKR,MAAM,KAAK,MACjCoC,OAAO,CAAC,CAAC5B;YACRX,yBAAyBmC,cAAcxB,KAAKR,MAAM,EAAEO;QACtD;QAEF,+CAA+C;QAC/CV,yBAAyBmC,cAAc,MAAMzB;IAC/C,EAAE,OAAOM,OAAO;QACd,MAAM,IAAIE,MACR,CAAC,kCAAkC,EAAEsB,IAAAA,yBAAe,EAACxB,OAAO,CAAC;IAEjE;AACF"}

package/dist/cjs/logging.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    snapsLogger: function() {
-        return snapsLogger;
-    },
-    logInfo: function() {
-        return logInfo;
-    },
-    logError: function() {
-        return logError;
-    },
-    logWarning: function() {
-        return logWarning;
-    }
-});
-const _utils = require("@metamask/utils");
-const snapsLogger = (0, _utils.createProjectLogger)('snaps');
-function logInfo(message, ...optionalParams) {
-    // eslint-disable-next-line no-console
-    console.log(message, ...optionalParams);
-}
-function logError(error, ...optionalParams) {
-    // eslint-disable-next-line no-console
-    console.error(error, ...optionalParams);
-}
-function logWarning(message, ...optionalParams) {
-    // eslint-disable-next-line no-console
-    console.warn(message, ...optionalParams);
-}
-
-//# sourceMappingURL=logging.js.map

package/dist/cjs/logging.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/logging.ts"],"sourcesContent":["import { createProjectLogger } from '@metamask/utils';\n\n// The global logger used across the monorepo. Other projects should use this\n// to create a module logger.\nexport const snapsLogger = createProjectLogger('snaps');\n\n/**\n * Log a message. Currently, this is just a wrapper around `console.log`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param message - The message to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logInfo(message: string, ...optionalParams: unknown[]): void {\n  // eslint-disable-next-line no-console\n  console.log(message, ...optionalParams);\n}\n\n/**\n * Log an error. Currently, this is just a wrapper around `console.error`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * These logs should always be visible, without requiring the user to enable\n * verbose logging (like setting a `DEBUG` environment variable), as they are\n * important for debugging snaps.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param error - The error to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logError(error: unknown, ...optionalParams: unknown[]): void {\n  // eslint-disable-next-line no-console\n  console.error(error, ...optionalParams);\n}\n\n/**\n * Log a warning. Currently, this is just a wrapper around `console.warn`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * These logs should always be visible, without requiring the user to enable\n * verbose logging (like setting a `DEBUG` environment variable), as they are\n * important for debugging snaps.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param message - The message to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logWarning(\n  message: string,\n  ...optionalParams: unknown[]\n): void {\n  // eslint-disable-next-line no-console\n  console.warn(message, ...optionalParams);\n}\n"],"names":["snapsLogger","logInfo","logError","logWarning","createProjectLogger","message","optionalParams","console","log","error","warn"],"mappings":";;;;;;;;;;;IAIaA,WAAW;eAAXA;;IAcGC,OAAO;eAAPA;;IAqBAC,QAAQ;eAARA;;IAqBAC,UAAU;eAAVA;;;uBA5DoB;AAI7B,MAAMH,cAAcI,IAAAA,0BAAmB,EAAC;AAcxC,SAASH,QAAQI,OAAe,EAAE,GAAGC,cAAyB;IACnE,sCAAsC;IACtCC,QAAQC,GAAG,CAACH,YAAYC;AAC1B;AAkBO,SAASJ,SAASO,KAAc,EAAE,GAAGH,cAAyB;IACnE,sCAAsC;IACtCC,QAAQE,KAAK,CAACA,UAAUH;AAC1B;AAkBO,SAASH,WACdE,OAAe,EACf,GAAGC,cAAyB;IAE5B,sCAAsC;IACtCC,QAAQG,IAAI,CAACL,YAAYC;AAC3B"}

package/dist/cjs/manifest/index.browser.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./validation"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}
-
-//# sourceMappingURL=index.browser.js.map

package/dist/cjs/manifest/index.browser.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/manifest/index.browser.ts"],"sourcesContent":["export * from './validation';\n"],"names":[],"mappings":";;;;qBAAc"}

package/dist/cjs/manifest/index.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./manifest"), exports);
-_export_star(require("./validation"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}
-
-//# sourceMappingURL=index.js.map

package/dist/cjs/manifest/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/manifest/index.ts"],"sourcesContent":["export * from './manifest';\nexport * from './validation';\n"],"names":[],"mappings":";;;;qBAAc;qBACA"}

package/dist/cjs/manifest/manifest.js

@@ -1,283 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    checkManifest: function() {
-        return checkManifest;
-    },
-    fixManifest: function() {
-        return fixManifest;
-    },
-    getSnapSourceCode: function() {
-        return getSnapSourceCode;
-    },
-    getSnapIcon: function() {
-        return getSnapIcon;
-    },
-    getSnapFilePaths: function() {
-        return getSnapFilePaths;
-    },
-    getSnapFiles: function() {
-        return getSnapFiles;
-    },
-    getWritableManifest: function() {
-        return getWritableManifest;
-    },
-    validateNpmSnapManifest: function() {
-        return validateNpmSnapManifest;
-    }
-});
-const _snapssdk = require("@metamask/snaps-sdk");
-const _utils = require("@metamask/utils");
-const _fastdeepequal = /*#__PURE__*/ _interop_require_default(require("fast-deep-equal"));
-const _fs = require("fs");
-const _path = /*#__PURE__*/ _interop_require_default(require("path"));
-const _deepclone = require("../deep-clone");
-const _fs1 = require("../fs");
-const _icon = require("../icon");
-const _npm = require("../npm");
-const _snaps = require("../snaps");
-const _types = require("../types");
-const _virtualfile = require("../virtual-file");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const MANIFEST_SORT_ORDER = {
-    $schema: 1,
-    version: 2,
-    description: 3,
-    proposedName: 4,
-    repository: 5,
-    source: 6,
-    initialConnections: 7,
-    initialPermissions: 8,
-    manifestVersion: 9
-};
-async function checkManifest(basePath, writeManifest = true, sourceCode, writeFileFn = _fs.promises.writeFile) {
-    const warnings = [];
-    const errors = [];
-    let updated = false;
-    const manifestPath = _path.default.join(basePath, _types.NpmSnapFileNames.Manifest);
-    const manifestFile = await (0, _fs1.readJsonFile)(manifestPath);
-    const unvalidatedManifest = manifestFile.result;
-    const packageFile = await (0, _fs1.readJsonFile)(_path.default.join(basePath, _types.NpmSnapFileNames.PackageJson));
-    const auxiliaryFilePaths = getSnapFilePaths(unvalidatedManifest, (manifest)=>manifest?.source?.files);
-    const localizationFilePaths = getSnapFilePaths(unvalidatedManifest, (manifest)=>manifest?.source?.locales);
-    const snapFiles = {
-        manifest: manifestFile,
-        packageJson: packageFile,
-        sourceCode: await getSnapSourceCode(basePath, unvalidatedManifest, sourceCode),
-        svgIcon: await getSnapIcon(basePath, unvalidatedManifest),
-        // Intentionally pass null as the encoding here since the files may be binary
-        auxiliaryFiles: await getSnapFiles(basePath, auxiliaryFilePaths, null) ?? [],
-        localizationFiles: await getSnapFiles(basePath, localizationFilePaths) ?? []
-    };
-    let manifest;
-    try {
-        ({ manifest } = await (0, _npm.validateNpmSnap)(snapFiles));
-    } catch (error) {
-        if (error instanceof _snaps.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.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 = await fixManifest(manifest ? {
-                    ...partiallyValidatedFiles,
-                    manifest
-                } : partiallyValidatedFiles, currentError);
-                try {
-                    await validateNpmSnapManifest({
-                        ...partiallyValidatedFiles,
-                        manifest
-                    });
-                    isInvalid = false;
-                } catch (nextValidationError) {
-                    currentError = nextValidationError;
-                    /* istanbul ignore next: this should be impossible */ if (!(nextValidationError instanceof _snaps.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 assumes `manifest` can still be undefined, that is not the case.
-    // But we assert to keep TypeScript happy.
-    (0, _utils.assert)(manifest);
-    const validatedManifest = manifest.result;
-    // 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 (!snapFiles.svgIcon) {
-        warnings.push('No icon found in the Snap manifest. It is recommended to include an icon for the Snap. See https://docs.metamask.io/snaps/how-to/design-a-snap/#guidelines-at-a-glance for more information.');
-    }
-    const iconDimensions = snapFiles.svgIcon && (0, _icon.getSvgDimensions)(snapFiles.svgIcon.toString());
-    if (iconDimensions && iconDimensions.height !== iconDimensions.width) {
-        warnings.push('The icon in the Snap manifest is not square. It is recommended to use a square icon for the Snap.');
-    }
-    if (writeManifest) {
-        try {
-            const newManifest = `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\n`;
-            if (updated || newManifest !== manifestFile.value) {
-                await writeFileFn(_path.default.join(basePath, _types.NpmSnapFileNames.Manifest), newManifest);
-            }
-        } 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
-    };
-}
-async function fixManifest(snapFiles, error) {
-    const { manifest, packageJson } = snapFiles;
-    const clonedFile = manifest.clone();
-    const manifestCopy = clonedFile.result;
-    switch(error.reason){
-        case _types.SnapValidationFailureReason.NameMismatch:
-            manifestCopy.source.location.npm.packageName = packageJson.result.name;
-            break;
-        case _types.SnapValidationFailureReason.VersionMismatch:
-            manifestCopy.version = packageJson.result.version;
-            break;
-        case _types.SnapValidationFailureReason.RepositoryMismatch:
-            manifestCopy.repository = packageJson.result.repository ? (0, _deepclone.deepClone)(packageJson.result.repository) : undefined;
-            break;
-        case _types.SnapValidationFailureReason.ShasumMismatch:
-            manifestCopy.source.shasum = await (0, _snaps.getSnapChecksum)(snapFiles);
-            break;
-        /* istanbul ignore next */ default:
-            (0, _utils.assertExhaustive)(error.reason);
-    }
-    clonedFile.result = manifestCopy;
-    clonedFile.value = JSON.stringify(manifestCopy);
-    return clonedFile;
-}
-async function getSnapSourceCode(basePath, manifest, sourceCode) {
-    if (!(0, _utils.isPlainObject)(manifest)) {
-        return undefined;
-    }
-    const sourceFilePath = manifest.source?.location?.npm?.filePath;
-    if (!sourceFilePath) {
-        return undefined;
-    }
-    if (sourceCode) {
-        return new _virtualfile.VirtualFile({
-            path: _path.default.join(basePath, sourceFilePath),
-            value: sourceCode
-        });
-    }
-    try {
-        const virtualFile = await (0, _virtualfile.readVirtualFile)(_path.default.join(basePath, sourceFilePath), 'utf8');
-        return virtualFile;
-    } catch (error) {
-        throw new Error(`Failed to read snap bundle file: ${(0, _snapssdk.getErrorMessage)(error)}`);
-    }
-}
-async function getSnapIcon(basePath, manifest) {
-    if (!(0, _utils.isPlainObject)(manifest)) {
-        return undefined;
-    }
-    const iconPath = manifest.source?.location?.npm?.iconPath;
-    if (!iconPath) {
-        return undefined;
-    }
-    try {
-        const virtualFile = await (0, _virtualfile.readVirtualFile)(_path.default.join(basePath, iconPath), 'utf8');
-        return virtualFile;
-    } catch (error) {
-        throw new Error(`Failed to read snap icon file: ${(0, _snapssdk.getErrorMessage)(error)}`);
-    }
-}
-function getSnapFilePaths(manifest, selector) {
-    if (!(0, _utils.isPlainObject)(manifest)) {
-        return undefined;
-    }
-    const snapManifest = manifest;
-    const paths = selector(snapManifest);
-    if (!Array.isArray(paths)) {
-        return undefined;
-    }
-    return paths;
-}
-async function getSnapFiles(basePath, paths, encoding = 'utf8') {
-    if (!paths) {
-        return undefined;
-    }
-    try {
-        return await Promise.all(paths.map(async (filePath)=>(0, _virtualfile.readVirtualFile)(_path.default.join(basePath, filePath), encoding)));
-    } catch (error) {
-        throw new Error(`Failed to read snap files: ${(0, _snapssdk.getErrorMessage)(error)}`);
-    }
-}
-function getWritableManifest(manifest) {
-    const { repository, ...remaining } = manifest;
-    const keys = Object.keys(repository ? {
-        ...remaining,
-        repository
-    } : remaining);
-    const writableManifest = keys.sort((a, b)=>MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b]).reduce((result, key)=>({
-            ...result,
-            [key]: manifest[key]
-        }), {});
-    return writableManifest;
-}
-async function validateNpmSnapManifest({ manifest, packageJson, sourceCode, svgIcon, auxiliaryFiles, localizationFiles }) {
-    const packageJsonName = packageJson.result.name;
-    const packageJsonVersion = packageJson.result.version;
-    const packageJsonRepository = packageJson.result.repository;
-    const manifestPackageName = manifest.result.source.location.npm.packageName;
-    const manifestPackageVersion = manifest.result.version;
-    const manifestRepository = manifest.result.repository;
-    if (packageJsonName !== manifestPackageName) {
-        throw new _snaps.ProgrammaticallyFixableSnapError(`"${_types.NpmSnapFileNames.Manifest}" npm package name ("${manifestPackageName}") does not match the "${_types.NpmSnapFileNames.PackageJson}" "name" field ("${packageJsonName}").`, _types.SnapValidationFailureReason.NameMismatch);
-    }
-    if (packageJsonVersion !== manifestPackageVersion) {
-        throw new _snaps.ProgrammaticallyFixableSnapError(`"${_types.NpmSnapFileNames.Manifest}" npm package version ("${manifestPackageVersion}") does not match the "${_types.NpmSnapFileNames.PackageJson}" "version" field ("${packageJsonVersion}").`, _types.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, _fastdeepequal.default)(packageJsonRepository, manifestRepository)) {
-        throw new _snaps.ProgrammaticallyFixableSnapError(`"${_types.NpmSnapFileNames.Manifest}" "repository" field does not match the "${_types.NpmSnapFileNames.PackageJson}" "repository" field.`, _types.SnapValidationFailureReason.RepositoryMismatch);
-    }
-    await (0, _snaps.validateSnapShasum)({
-        manifest,
-        sourceCode,
-        svgIcon,
-        auxiliaryFiles,
-        localizationFiles
-    }, `"${_types.NpmSnapFileNames.Manifest}" "shasum" field does not match computed shasum.`);
-}
-
-//# sourceMappingURL=manifest.js.map

package/dist/cjs/manifest/manifest.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/manifest/manifest.ts"],"sourcesContent":["import { getErrorMessage } from '@metamask/snaps-sdk';\nimport type { Json } from '@metamask/utils';\nimport { assertExhaustive, assert, isPlainObject } from '@metamask/utils';\nimport deepEqual from 'fast-deep-equal';\nimport { promises as fs } from 'fs';\nimport pathUtils from 'path';\n\nimport { deepClone } from '../deep-clone';\nimport { readJsonFile } from '../fs';\nimport { getSvgDimensions } from '../icon';\nimport { validateNpmSnap } from '../npm';\nimport {\n  getSnapChecksum,\n  ProgrammaticallyFixableSnapError,\n  validateSnapShasum,\n} from '../snaps';\nimport type { SnapFiles, UnvalidatedSnapFiles } from '../types';\nimport { NpmSnapFileNames, SnapValidationFailureReason } from '../types';\nimport { readVirtualFile, VirtualFile } from '../virtual-file';\nimport type { SnapManifest } from './validation';\n\nconst MANIFEST_SORT_ORDER: Record<keyof SnapManifest, number> = {\n  $schema: 1,\n  version: 2,\n  description: 3,\n  proposedName: 4,\n  repository: 5,\n  source: 6,\n  initialConnections: 7,\n  initialPermissions: 8,\n  manifestVersion: 9,\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\nexport type WriteFileFunction = (path: string, data: string) => Promise<void>;\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 * @param writeFileFn - The function to use to write the manifest to disk.\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  writeFileFn: WriteFileFunction = fs.writeFile,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const manifestPath = pathUtils.join(basePath, NpmSnapFileNames.Manifest);\n  const manifestFile = await readJsonFile(manifestPath);\n  const unvalidatedManifest = manifestFile.result;\n\n  const packageFile = await readJsonFile(\n    pathUtils.join(basePath, NpmSnapFileNames.PackageJson),\n  );\n\n  const auxiliaryFilePaths = getSnapFilePaths(\n    unvalidatedManifest,\n    (manifest) => manifest?.source?.files,\n  );\n\n  const localizationFilePaths = getSnapFilePaths(\n    unvalidatedManifest,\n    (manifest) => manifest?.source?.locales,\n  );\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: manifestFile,\n    packageJson: packageFile,\n    sourceCode: await getSnapSourceCode(\n      basePath,\n      unvalidatedManifest,\n      sourceCode,\n    ),\n    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),\n    // Intentionally pass null as the encoding here since the files may be binary\n    auxiliaryFiles:\n      (await getSnapFiles(basePath, auxiliaryFilePaths, null)) ?? [],\n    localizationFiles:\n      (await getSnapFiles(basePath, localizationFilePaths)) ?? [],\n  };\n\n  let manifest: VirtualFile<SnapManifest> | undefined;\n  try {\n    ({ manifest } = await 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 = await fixManifest(\n          manifest\n            ? { ...partiallyValidatedFiles, manifest }\n            : partiallyValidatedFiles,\n          currentError,\n        );\n\n        try {\n          await validateNpmSnapManifest({\n            ...partiallyValidatedFiles,\n            manifest,\n          });\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 assumes `manifest` can still be undefined, that is not the case.\n  // But we assert to keep TypeScript happy.\n  assert(manifest);\n\n  const validatedManifest = manifest.result;\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 (!snapFiles.svgIcon) {\n    warnings.push(\n      'No icon found in the Snap manifest. It is recommended to include an icon for the Snap. See https://docs.metamask.io/snaps/how-to/design-a-snap/#guidelines-at-a-glance for more information.',\n    );\n  }\n\n  const iconDimensions =\n    snapFiles.svgIcon && getSvgDimensions(snapFiles.svgIcon.toString());\n  if (iconDimensions && iconDimensions.height !== iconDimensions.width) {\n    warnings.push(\n      'The icon in the Snap manifest is not square. It is recommended to use a square icon for the Snap.',\n    );\n  }\n\n  if (writeManifest) {\n    try {\n      const newManifest = `${JSON.stringify(\n        getWritableManifest(validatedManifest),\n        null,\n        2,\n      )}\\n`;\n\n      if (updated || newManifest !== manifestFile.value) {\n        await writeFileFn(\n          pathUtils.join(basePath, NpmSnapFileNames.Manifest),\n          newManifest,\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 async function fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): Promise<VirtualFile<SnapManifest>> {\n  const { manifest, packageJson } = snapFiles;\n  const clonedFile = manifest.clone();\n  const manifestCopy = clonedFile.result;\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.result.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.result.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.result.repository\n        ? deepClone(packageJson.result.repository)\n        : undefined;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = await getSnapChecksum(snapFiles);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      assertExhaustive(error.reason);\n  }\n\n  clonedFile.result = manifestCopy;\n  clonedFile.value = JSON.stringify(manifestCopy);\n  return clonedFile;\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 * @param sourceCode - Override source code for plugins.\n * @returns The contents of the bundle file, if any.\n */\nexport async function getSnapSourceCode(\n  basePath: string,\n  manifest: Json,\n  sourceCode?: string,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n    ?.npm?.filePath;\n\n  if (!sourceFilePath) {\n    return undefined;\n  }\n\n  if (sourceCode) {\n    return new VirtualFile({\n      path: pathUtils.join(basePath, sourceFilePath),\n      value: sourceCode,\n    });\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, sourceFilePath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(\n      `Failed to read snap bundle file: ${getErrorMessage(error)}`,\n    );\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * icon 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 icon, if any.\n */\nexport async function getSnapIcon(\n  basePath: string,\n  manifest: Json,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const iconPath = (manifest as Partial<SnapManifest>).source?.location?.npm\n    ?.iconPath;\n\n  if (!iconPath) {\n    return undefined;\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, iconPath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read snap icon file: ${getErrorMessage(error)}`);\n  }\n}\n\n/**\n * Get an array of paths from an unvalidated Snap manifest.\n *\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param selector - A function that returns the paths to the files.\n * @returns The paths to the files, if any.\n */\nexport function getSnapFilePaths(\n  manifest: Json,\n  selector: (manifest: Partial<SnapManifest>) => string[] | undefined,\n) {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const snapManifest = manifest as Partial<SnapManifest>;\n  const paths = selector(snapManifest);\n\n  if (!Array.isArray(paths)) {\n    return undefined;\n  }\n\n  return paths;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the files with the\n * given paths and read them.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param paths - The paths to the files.\n * @param encoding - An optional encoding to pass down to readVirtualFile.\n * @returns A list of auxiliary files and their contents, if any.\n */\nexport async function getSnapFiles(\n  basePath: string,\n  paths: string[] | undefined,\n  encoding: BufferEncoding | null = 'utf8',\n): Promise<VirtualFile[] | undefined> {\n  if (!paths) {\n    return undefined;\n  }\n\n  try {\n    return await Promise.all(\n      paths.map(async (filePath) =>\n        readVirtualFile(pathUtils.join(basePath, filePath), encoding),\n      ),\n    );\n  } catch (error) {\n    throw new Error(`Failed to read snap files: ${getErrorMessage(error)}`);\n  }\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  const writableManifest = keys\n    .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])\n    .reduce<Partial<SnapManifest>>(\n      (result, key) => ({\n        ...result,\n        [key]: manifest[key],\n      }),\n      {},\n    );\n\n  return writableManifest as SnapManifest;\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 * @param snapFiles.svgIcon - The Snap's optional icon.\n * @param snapFiles.auxiliaryFiles - Any auxiliary files required by the snap at runtime.\n * @param snapFiles.localizationFiles - The Snap's localization files.\n */\nexport async function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n  svgIcon,\n  auxiliaryFiles,\n  localizationFiles,\n}: SnapFiles) {\n  const packageJsonName = packageJson.result.name;\n  const packageJsonVersion = packageJson.result.version;\n  const packageJsonRepository = packageJson.result.repository;\n\n  const manifestPackageName = manifest.result.source.location.npm.packageName;\n  const manifestPackageVersion = manifest.result.version;\n  const manifestRepository = manifest.result.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  await validateSnapShasum(\n    { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles },\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n}\n"],"names":["checkManifest","fixManifest","getSnapSourceCode","getSnapIcon","getSnapFilePaths","getSnapFiles","getWritableManifest","validateNpmSnapManifest","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialConnections","initialPermissions","manifestVersion","basePath","writeManifest","sourceCode","writeFileFn","fs","writeFile","warnings","errors","updated","manifestPath","pathUtils","join","NpmSnapFileNames","Manifest","manifestFile","readJsonFile","unvalidatedManifest","result","packageFile","PackageJson","auxiliaryFilePaths","manifest","files","localizationFilePaths","locales","snapFiles","packageJson","svgIcon","auxiliaryFiles","localizationFiles","validateNpmSnap","error","ProgrammaticallyFixableSnapError","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","SnapValidationFailureReason","length","attempts","nextValidationError","Error","assert","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","iconDimensions","getSvgDimensions","toString","height","width","newManifest","JSON","stringify","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","deepClone","undefined","ShasumMismatch","shasum","getSnapChecksum","assertExhaustive","isPlainObject","sourceFilePath","filePath","VirtualFile","path","virtualFile","readVirtualFile","getErrorMessage","iconPath","selector","snapManifest","paths","Array","isArray","encoding","Promise","all","map","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository","deepEqual","validateSnapShasum"],"mappings":";;;;;;;;;;;IAoEsBA,aAAa;eAAbA;;IA6KAC,WAAW;eAAXA;;IA8CAC,iBAAiB;eAAjBA;;IA4CAC,WAAW;eAAXA;;IAiCNC,gBAAgB;eAAhBA;;IA2BMC,YAAY;eAAZA;;IA2BNC,mBAAmB;eAAnBA;;IAgCMC,uBAAuB;eAAvBA;;;0BAlcU;uBAEwB;sEAClC;oBACS;6DACT;2BAEI;qBACG;sBACI;qBACD;uBAKzB;uBAEuD;6BACjB;;;;;;AAG7C,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,oBAAoB;IACpBC,iBAAiB;AACnB;AAqCO,eAAejB,cACpBkB,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiCC,YAAE,CAACC,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAeC,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACC,QAAQ;IACvE,MAAMC,eAAe,MAAMC,IAAAA,iBAAY,EAACN;IACxC,MAAMO,sBAAsBF,aAAaG,MAAM;IAE/C,MAAMC,cAAc,MAAMH,IAAAA,iBAAY,EACpCL,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACO,WAAW;IAGvD,MAAMC,qBAAqBlC,iBACzB8B,qBACA,CAACK,WAAaA,UAAUzB,QAAQ0B;IAGlC,MAAMC,wBAAwBrC,iBAC5B8B,qBACA,CAACK,WAAaA,UAAUzB,QAAQ4B;IAGlC,MAAMC,YAAkC;QACtCJ,UAAUP;QACVY,aAAaR;QACbhB,YAAY,MAAMlB,kBAChBgB,UACAgB,qBACAd;QAEFyB,SAAS,MAAM1C,YAAYe,UAAUgB;QACrC,6EAA6E;QAC7EY,gBACE,AAAC,MAAMzC,aAAaa,UAAUoB,oBAAoB,SAAU,EAAE;QAChES,mBACE,AAAC,MAAM1C,aAAaa,UAAUuB,0BAA2B,EAAE;IAC/D;IAEA,IAAIF;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAG,MAAMS,IAAAA,oBAAe,EAACL,UAAS;IACjD,EAAE,OAAOM,OAAO;QACd,IAAIA,iBAAiBC,uCAAgC,EAAE;YACrDzB,OAAO0B,IAAI,CAACF,MAAMG,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BV;YAEhC,IAAIW,YAAY;YAChB,IAAIC,eAAeN;YACnB,MAAMO,cAAcC,OAAOC,IAAI,CAACC,kCAA2B,EAAEC,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGP,aAAaO,YAAYL,aAAaK,WAAY;gBACvEtB,WAAW,MAAMtC,YACfsC,WACI;oBAAE,GAAGc,uBAAuB;oBAAEd;gBAAS,IACvCc,yBACJE;gBAGF,IAAI;oBACF,MAAMhD,wBAAwB;wBAC5B,GAAG8C,uBAAuB;wBAC1Bd;oBACF;oBAEAe,YAAY;gBACd,EAAE,OAAOQ,qBAAqB;oBAC5BP,eAAeO;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+BZ,uCAAgC,AAAD,KAE/DW,aAAaL,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIS,MACR,CAAC,kFAAkF,EAAEd,MAAMG,OAAO,CAAC,CAAC;oBAExG;oBAEA3B,OAAO0B,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEA1B,UAAU;QACZ,OAAO;YACL,MAAMuB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1Ce,IAAAA,aAAM,EAACzB;IAEP,MAAM0B,oBAAoB1B,SAASJ,MAAM;IAEzC,qCAAqC;IACrC,MAAM+B,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBP,MAAM,GAAG,GAAG;QACvCpC,SAAS2B,IAAI,CACX,CAAC,8CAA8C,EAAEgB,yBAAyBG,MAAM,CAC9E,CAACC,YAAYC;YACX,OAAO,CAAC,EAAED,WAAW,EAAE,EAAEC,aAAa,EAAE,CAAC;QAC3C,GACA,IACA,CAAC;IAEP;IAEA,IAAI,CAAC7B,UAAUE,OAAO,EAAE;QACtBrB,SAAS2B,IAAI,CACX;IAEJ;IAEA,MAAMsB,iBACJ9B,UAAUE,OAAO,IAAI6B,IAAAA,sBAAgB,EAAC/B,UAAUE,OAAO,CAAC8B,QAAQ;IAClE,IAAIF,kBAAkBA,eAAeG,MAAM,KAAKH,eAAeI,KAAK,EAAE;QACpErD,SAAS2B,IAAI,CACX;IAEJ;IAEA,IAAIhC,eAAe;QACjB,IAAI;YACF,MAAM2D,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnC1E,oBAAoB2D,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAIvC,WAAWoD,gBAAgB9C,aAAaiD,KAAK,EAAE;gBACjD,MAAM5D,YACJO,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACC,QAAQ,GAClD+C;YAEJ;QACF,EAAE,OAAO7B,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAMG,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEb,UAAU0B;QAAmBvC;QAASF;QAAUC;IAAO;AAClE;AAWO,eAAexB,YACpB0C,SAAoB,EACpBM,KAAuC;IAEvC,MAAM,EAAEV,QAAQ,EAAEK,WAAW,EAAE,GAAGD;IAClC,MAAMuC,aAAa3C,SAAS4C,KAAK;IACjC,MAAMC,eAAeF,WAAW/C,MAAM;IAEtC,OAAQc,MAAMoC,MAAM;QAClB,KAAK1B,kCAA2B,CAAC2B,YAAY;YAC3CF,aAAatE,MAAM,CAACyE,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAG7C,YAAYT,MAAM,CAACuD,IAAI;YACtE;QAEF,KAAK/B,kCAA2B,CAACgC,eAAe;YAC9CP,aAAa1E,OAAO,GAAGkC,YAAYT,MAAM,CAACzB,OAAO;YACjD;QAEF,KAAKiD,kCAA2B,CAACiC,kBAAkB;YACjDR,aAAavE,UAAU,GAAG+B,YAAYT,MAAM,CAACtB,UAAU,GACnDgF,IAAAA,oBAAS,EAACjD,YAAYT,MAAM,CAACtB,UAAU,IACvCiF;YACJ;QAEF,KAAKnC,kCAA2B,CAACoC,cAAc;YAC7CX,aAAatE,MAAM,CAACkF,MAAM,GAAG,MAAMC,IAAAA,sBAAe,EAACtD;YACnD;QAEF,wBAAwB,GACxB;YACEuD,IAAAA,uBAAgB,EAACjD,MAAMoC,MAAM;IACjC;IAEAH,WAAW/C,MAAM,GAAGiD;IACpBF,WAAWD,KAAK,GAAGF,KAAKC,SAAS,CAACI;IAClC,OAAOF;AACT;AAWO,eAAehF,kBACpBgB,QAAgB,EAChBqB,QAAc,EACdnB,UAAmB;IAEnB,IAAI,CAAC+E,IAAAA,oBAAa,EAAC5D,WAAW;QAC5B,OAAOuD;IACT;IAEA,MAAMM,iBAAiB,AAAC7D,SAAmCzB,MAAM,EAAEyE,UAC/DC,KAAKa;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAON;IACT;IAEA,IAAI1E,YAAY;QACd,OAAO,IAAIkF,wBAAW,CAAC;YACrBC,MAAM3E,aAAS,CAACC,IAAI,CAACX,UAAUkF;YAC/BnB,OAAO7D;QACT;IACF;IAEA,IAAI;QACF,MAAMoF,cAAc,MAAMC,IAAAA,4BAAe,EACvC7E,aAAS,CAACC,IAAI,CAACX,UAAUkF,iBACzB;QAEF,OAAOI;IACT,EAAE,OAAOvD,OAAO;QACd,MAAM,IAAIc,MACR,CAAC,iCAAiC,EAAE2C,IAAAA,yBAAe,EAACzD,OAAO,CAAC;IAEhE;AACF;AAUO,eAAe9C,YACpBe,QAAgB,EAChBqB,QAAc;IAEd,IAAI,CAAC4D,IAAAA,oBAAa,EAAC5D,WAAW;QAC5B,OAAOuD;IACT;IAEA,MAAMa,WAAW,AAACpE,SAAmCzB,MAAM,EAAEyE,UAAUC,KACnEmB;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOb;IACT;IAEA,IAAI;QACF,MAAMU,cAAc,MAAMC,IAAAA,4BAAe,EACvC7E,aAAS,CAACC,IAAI,CAACX,UAAUyF,WACzB;QAEF,OAAOH;IACT,EAAE,OAAOvD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAE2C,IAAAA,yBAAe,EAACzD,OAAO,CAAC;IAC5E;AACF;AASO,SAAS7C,iBACdmC,QAAc,EACdqE,QAAmE;IAEnE,IAAI,CAACT,IAAAA,oBAAa,EAAC5D,WAAW;QAC5B,OAAOuD;IACT;IAEA,MAAMe,eAAetE;IACrB,MAAMuE,QAAQF,SAASC;IAEvB,IAAI,CAACE,MAAMC,OAAO,CAACF,QAAQ;QACzB,OAAOhB;IACT;IAEA,OAAOgB;AACT;AAWO,eAAezG,aACpBa,QAAgB,EAChB4F,KAA2B,EAC3BG,WAAkC,MAAM;IAExC,IAAI,CAACH,OAAO;QACV,OAAOhB;IACT;IAEA,IAAI;QACF,OAAO,MAAMoB,QAAQC,GAAG,CACtBL,MAAMM,GAAG,CAAC,OAAOf,WACfI,IAAAA,4BAAe,EAAC7E,aAAS,CAACC,IAAI,CAACX,UAAUmF,WAAWY;IAG1D,EAAE,OAAOhE,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,2BAA2B,EAAE2C,IAAAA,yBAAe,EAACzD,OAAO,CAAC;IACxE;AACF;AASO,SAAS3C,oBAAoBiC,QAAsB;IACxD,MAAM,EAAE1B,UAAU,EAAE,GAAGwG,WAAW,GAAG9E;IAErC,MAAMmB,OAAOD,OAAOC,IAAI,CACtB7C,aAAa;QAAE,GAAGwG,SAAS;QAAExG;IAAW,IAAIwG;IAG9C,MAAMC,mBAAmB5D,KACtB6D,IAAI,CAAC,CAACC,GAAGC,IAAMjH,mBAAmB,CAACgH,EAAE,GAAGhH,mBAAmB,CAACiH,EAAE,EAC9DnD,MAAM,CACL,CAACnC,QAAQkC,MAAS,CAAA;YAChB,GAAGlC,MAAM;YACT,CAACkC,IAAI,EAAE9B,QAAQ,CAAC8B,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAOiD;AACT;AAcO,eAAe/G,wBAAwB,EAC5CgC,QAAQ,EACRK,WAAW,EACXxB,UAAU,EACVyB,OAAO,EACPC,cAAc,EACdC,iBAAiB,EACP;IACV,MAAM2E,kBAAkB9E,YAAYT,MAAM,CAACuD,IAAI;IAC/C,MAAMiC,qBAAqB/E,YAAYT,MAAM,CAACzB,OAAO;IACrD,MAAMkH,wBAAwBhF,YAAYT,MAAM,CAACtB,UAAU;IAE3D,MAAMgH,sBAAsBtF,SAASJ,MAAM,CAACrB,MAAM,CAACyE,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAMqC,yBAAyBvF,SAASJ,MAAM,CAACzB,OAAO;IACtD,MAAMqH,qBAAqBxF,SAASJ,MAAM,CAACtB,UAAU;IAErD,IAAI6G,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI3E,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,qBAAqB,EAAE8F,oBAAoB,uBAAuB,EAAE/F,uBAAgB,CAACO,WAAW,CAAC,iBAAiB,EAAEqF,gBAAgB,GAAG,CAAC,EACtK/D,kCAA2B,CAAC2B,YAAY;IAE5C;IAEA,IAAIqC,uBAAuBG,wBAAwB;QACjD,MAAM,IAAI5E,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,wBAAwB,EAAE+F,uBAAuB,uBAAuB,EAAEhG,uBAAgB,CAACO,WAAW,CAAC,oBAAoB,EAAEsF,mBAAmB,GAAG,CAAC,EAClLhE,kCAA2B,CAACgC,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDiC,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACC,IAAAA,sBAAS,EAACJ,uBAAuBG,qBAClC;QACA,MAAM,IAAI7E,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,yCAAyC,EAAED,uBAAgB,CAACO,WAAW,CAAC,qBAAqB,CAAC,EAC5HsB,kCAA2B,CAACiC,kBAAkB;IAElD;IAEA,MAAMqC,IAAAA,yBAAkB,EACtB;QAAE1F;QAAUnB;QAAYyB;QAASC;QAAgBC;IAAkB,GACnE,CAAC,CAAC,EAAEjB,uBAAgB,CAACC,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}