@metamask/snaps-utils 0.38.0-flask.1 → 1.0.0

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,239 +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;
-    },
-    getWritableManifest: function() {
-        return getWritableManifest;
-    },
-    validateNpmSnapManifest: function() {
-        return validateNpmSnapManifest;
-    }
-});
-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 _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,
-    initialPermissions: 7,
-    manifestVersion: 8
-};
-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 snapFiles = {
-        manifest: manifestFile,
-        packageJson: packageFile,
-        sourceCode: await getSnapSourceCode(basePath, unvalidatedManifest, sourceCode),
-        svgIcon: await getSnapIcon(basePath, unvalidatedManifest)
-    };
-    let manifest;
-    try {
-        ({ manifest } = (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 = fixManifest(manifest ? {
-                    ...partiallyValidatedFiles,
-                    manifest
-                } : partiallyValidatedFiles, currentError);
-                try {
-                    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 (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
-    };
-}
-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 = (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: ${error.message}`);
-    }
-}
-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: ${error.message}`);
-    }
-}
-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;
-}
-function validateNpmSnapManifest({ manifest, packageJson, sourceCode, svgIcon }) {
-    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);
-    }
-    (0, _snaps.validateSnapShasum)({
-        manifest,
-        sourceCode,
-        svgIcon
-    }, `"${_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 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 { 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  initialPermissions: 7,\n  manifestVersion: 8,\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 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  };\n\n  let manifest: VirtualFile<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 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 (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 function fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): 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 = 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(`Failed to read snap bundle file: ${error.message}`);\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: ${error.message}`);\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 */\nexport function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n  svgIcon,\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  validateSnapShasum(\n    { manifest, sourceCode, svgIcon },\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n}\n"],"names":["checkManifest","fixManifest","getSnapSourceCode","getSnapIcon","getWritableManifest","validateNpmSnapManifest","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialPermissions","manifestVersion","basePath","writeManifest","sourceCode","writeFileFn","fs","writeFile","warnings","errors","updated","manifestPath","pathUtils","join","NpmSnapFileNames","Manifest","manifestFile","readJsonFile","unvalidatedManifest","result","packageFile","PackageJson","snapFiles","manifest","packageJson","svgIcon","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","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","iconPath","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository","deepEqual","validateSnapShasum"],"mappings":";;;;;;;;;;;IAiEsBA,aAAa;eAAbA;;IA6INC,WAAW;eAAXA;;IA8CMC,iBAAiB;eAAjBA;;IA0CAC,WAAW;eAAXA;;IAiCNC,mBAAmB;eAAnBA;;IA8BAC,uBAAuB;eAAvBA;;;uBApWwC;sEAClC;oBACS;6DACT;2BAEI;qBACG;qBACG;uBAKzB;uBAEuD;6BACjB;;;;;;AAG7C,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,iBAAiB;AACnB;AAqCO,eAAed,cACpBe,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,YAAkC;QACtCC,UAAUP;QACVQ,aAAaJ;QACbhB,YAAY,MAAMf,kBAChBa,UACAgB,qBACAd;QAEFqB,SAAS,MAAMnC,YAAYY,UAAUgB;IACvC;IAEA,IAAIK;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAGG,IAAAA,oBAAe,EAACJ,UAAS;IAC3C,EAAE,OAAOK,OAAO;QACd,IAAIA,iBAAiBC,uCAAgC,EAAE;YACrDnB,OAAOoB,IAAI,CAACF,MAAMG,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BT;YAEhC,IAAIU,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;gBACvEhB,WAAWnC,YACTmC,WACI;oBAAE,GAAGQ,uBAAuB;oBAAER;gBAAS,IACvCQ,yBACJE;gBAGF,IAAI;oBACFzC,wBAAwB;wBAAE,GAAGuC,uBAAuB;wBAAER;oBAAS;oBAE/DS,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;oBAEArB,OAAOoB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEApB,UAAU;QACZ,OAAO;YACL,MAAMiB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1Ce,IAAAA,aAAM,EAACnB;IAEP,MAAMoB,oBAAoBpB,SAASJ,MAAM;IAEzC,qCAAqC;IACrC,MAAMyB,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBP,MAAM,GAAG,GAAG;QACvC9B,SAASqB,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/C,eAAe;QACjB,IAAI;YACF,MAAMgD,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnC9D,oBAAoBoD,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAIjC,WAAWyC,gBAAgBnC,aAAasC,KAAK,EAAE;gBACjD,MAAMjD,YACJO,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACC,QAAQ,GAClDoC;YAEJ;QACF,EAAE,OAAOxB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAMG,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEP,UAAUoB;QAAmBjC;QAASF;QAAUC;IAAO;AAClE;AAWO,SAASrB,YACdkC,SAAoB,EACpBK,KAAuC;IAEvC,MAAM,EAAEJ,QAAQ,EAAEC,WAAW,EAAE,GAAGF;IAClC,MAAMiC,aAAahC,SAASiC,KAAK;IACjC,MAAMC,eAAeF,WAAWpC,MAAM;IAEtC,OAAQQ,MAAM+B,MAAM;QAClB,KAAKrB,kCAA2B,CAACsB,YAAY;YAC3CF,aAAa1D,MAAM,CAAC6D,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAGtC,YAAYL,MAAM,CAAC4C,IAAI;YACtE;QAEF,KAAK1B,kCAA2B,CAAC2B,eAAe;YAC9CP,aAAa9D,OAAO,GAAG6B,YAAYL,MAAM,CAACxB,OAAO;YACjD;QAEF,KAAK0C,kCAA2B,CAAC4B,kBAAkB;YACjDR,aAAa3D,UAAU,GAAG0B,YAAYL,MAAM,CAACrB,UAAU,GACnDoE,IAAAA,oBAAS,EAAC1C,YAAYL,MAAM,CAACrB,UAAU,IACvCqE;YACJ;QAEF,KAAK9B,kCAA2B,CAAC+B,cAAc;YAC7CX,aAAa1D,MAAM,CAACsE,MAAM,GAAGC,IAAAA,sBAAe,EAAChD;YAC7C;QAEF,wBAAwB,GACxB;YACEiD,IAAAA,uBAAgB,EAAC5C,MAAM+B,MAAM;IACjC;IAEAH,WAAWpC,MAAM,GAAGsC;IACpBF,WAAWD,KAAK,GAAGF,KAAKC,SAAS,CAACI;IAClC,OAAOF;AACT;AAWO,eAAelE,kBACpBa,QAAgB,EAChBqB,QAAc,EACdnB,UAAmB;IAEnB,IAAI,CAACoE,IAAAA,oBAAa,EAACjD,WAAW;QAC5B,OAAO4C;IACT;IAEA,MAAMM,iBAAiB,AAAClD,SAAmCxB,MAAM,EAAE6D,UAC/DC,KAAKa;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAON;IACT;IAEA,IAAI/D,YAAY;QACd,OAAO,IAAIuE,wBAAW,CAAC;YACrBC,MAAMhE,aAAS,CAACC,IAAI,CAACX,UAAUuE;YAC/BnB,OAAOlD;QACT;IACF;IAEA,IAAI;QACF,MAAMyE,cAAc,MAAMC,IAAAA,4BAAe,EACvClE,aAAS,CAACC,IAAI,CAACX,UAAUuE,iBACzB;QAEF,OAAOI;IACT,EAAE,OAAOlD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,iCAAiC,EAAEd,MAAMG,OAAO,CAAC,CAAC;IACrE;AACF;AAUO,eAAexC,YACpBY,QAAgB,EAChBqB,QAAc;IAEd,IAAI,CAACiD,IAAAA,oBAAa,EAACjD,WAAW;QAC5B,OAAO4C;IACT;IAEA,MAAMY,WAAW,AAACxD,SAAmCxB,MAAM,EAAE6D,UAAUC,KACnEkB;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOZ;IACT;IAEA,IAAI;QACF,MAAMU,cAAc,MAAMC,IAAAA,4BAAe,EACvClE,aAAS,CAACC,IAAI,CAACX,UAAU6E,WACzB;QAEF,OAAOF;IACT,EAAE,OAAOlD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAEd,MAAMG,OAAO,CAAC,CAAC;IACnE;AACF;AASO,SAASvC,oBAAoBgC,QAAsB;IACxD,MAAM,EAAEzB,UAAU,EAAE,GAAGkF,WAAW,GAAGzD;IAErC,MAAMa,OAAOD,OAAOC,IAAI,CACtBtC,aAAa;QAAE,GAAGkF,SAAS;QAAElF;IAAW,IAAIkF;IAG9C,MAAMC,mBAAmB7C,KACtB8C,IAAI,CAAC,CAACC,GAAGC,IAAM3F,mBAAmB,CAAC0F,EAAE,GAAG1F,mBAAmB,CAAC2F,EAAE,EAC9DpC,MAAM,CACL,CAAC7B,QAAQ4B,MAAS,CAAA;YAChB,GAAG5B,MAAM;YACT,CAAC4B,IAAI,EAAExB,QAAQ,CAACwB,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAOkC;AACT;AAYO,SAASzF,wBAAwB,EACtC+B,QAAQ,EACRC,WAAW,EACXpB,UAAU,EACVqB,OAAO,EACG;IACV,MAAM4D,kBAAkB7D,YAAYL,MAAM,CAAC4C,IAAI;IAC/C,MAAMuB,qBAAqB9D,YAAYL,MAAM,CAACxB,OAAO;IACrD,MAAM4F,wBAAwB/D,YAAYL,MAAM,CAACrB,UAAU;IAE3D,MAAM0F,sBAAsBjE,SAASJ,MAAM,CAACpB,MAAM,CAAC6D,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAM2B,yBAAyBlE,SAASJ,MAAM,CAACxB,OAAO;IACtD,MAAM+F,qBAAqBnE,SAASJ,MAAM,CAACrB,UAAU;IAErD,IAAIuF,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI5D,uCAAgC,CACxC,CAAC,CAAC,EAAEd,uBAAgB,CAACC,QAAQ,CAAC,qBAAqB,EAAEyE,oBAAoB,uBAAuB,EAAE1E,uBAAgB,CAACO,WAAW,CAAC,iBAAiB,EAAEgE,gBAAgB,GAAG,CAAC,EACtKhD,kCAA2B,CAACsB,YAAY;IAE5C;IAEA,IAAI2B,uBAAuBG,wBAAwB;QACjD,MAAM,IAAI7D,uCAAgC,CACxC,CAAC,CAAC,EAAEd,uBAAgB,CAACC,QAAQ,CAAC,wBAAwB,EAAE0E,uBAAuB,uBAAuB,EAAE3E,uBAAgB,CAACO,WAAW,CAAC,oBAAoB,EAAEiE,mBAAmB,GAAG,CAAC,EAClLjD,kCAA2B,CAAC2B,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDuB,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACC,IAAAA,sBAAS,EAACJ,uBAAuBG,qBAClC;QACA,MAAM,IAAI9D,uCAAgC,CACxC,CAAC,CAAC,EAAEd,uBAAgB,CAACC,QAAQ,CAAC,yCAAyC,EAAED,uBAAgB,CAACO,WAAW,CAAC,qBAAqB,CAAC,EAC5HgB,kCAA2B,CAAC4B,kBAAkB;IAElD;IAEA2B,IAAAA,yBAAkB,EAChB;QAAErE;QAAUnB;QAAYqB;IAAQ,GAChC,CAAC,CAAC,EAAEX,uBAAgB,CAACC,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}

package/dist/cjs/manifest/validation.js

@@ -1,183 +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, {
-    FORBIDDEN_COIN_TYPES: function() {
-        return FORBIDDEN_COIN_TYPES;
-    },
-    Bip32PathStruct: function() {
-        return Bip32PathStruct;
-    },
-    bip32entropy: function() {
-        return bip32entropy;
-    },
-    Bip32EntropyStruct: function() {
-        return Bip32EntropyStruct;
-    },
-    SnapGetBip32EntropyPermissionsStruct: function() {
-        return SnapGetBip32EntropyPermissionsStruct;
-    },
-    SemVerRangeStruct: function() {
-        return SemVerRangeStruct;
-    },
-    SnapIdsStruct: function() {
-        return SnapIdsStruct;
-    },
-    PermissionsStruct: function() {
-        return PermissionsStruct;
-    },
-    SnapManifestStruct: function() {
-        return SnapManifestStruct;
-    },
-    isSnapManifest: function() {
-        return isSnapManifest;
-    },
-    assertIsSnapManifest: function() {
-        return assertIsSnapManifest;
-    },
-    createSnapManifest: function() {
-        return createSnapManifest;
-    }
-});
-const _keytree = require("@metamask/key-tree");
-const _utils = require("@metamask/utils");
-const _superstruct = require("superstruct");
-const _array = require("../array");
-const _cronjob = require("../cronjob");
-const _entropy = require("../entropy");
-const _jsonrpc = require("../json-rpc");
-const _snaps = require("../snaps");
-const _types = require("../types");
-// BIP-43 purposes that cannot be used for entropy derivation. These are in the
-// string form, ending with `'`.
-const FORBIDDEN_PURPOSES = [
-    _entropy.SIP_6_MAGIC_VALUE,
-    _entropy.STATE_ENCRYPTION_MAGIC_VALUE
-];
-const FORBIDDEN_COIN_TYPES = [
-    60
-];
-const FORBIDDEN_PATHS = FORBIDDEN_COIN_TYPES.map((coinType)=>[
-        'm',
-        "44'",
-        `${coinType}'`
-    ]);
-const Bip32PathStruct = (0, _superstruct.refine)((0, _superstruct.array)((0, _superstruct.string)()), 'BIP-32 path', (path)=>{
-    if (path.length === 0) {
-        return 'Path must be a non-empty BIP-32 derivation path array';
-    }
-    if (path[0] !== 'm') {
-        return 'Path must start with "m".';
-    }
-    if (path.length < 3) {
-        return 'Paths must have a length of at least three.';
-    }
-    if (path.slice(1).some((part)=>!(0, _keytree.isValidBIP32PathSegment)(part))) {
-        return 'Path must be a valid BIP-32 derivation path array.';
-    }
-    if (FORBIDDEN_PURPOSES.includes(path[1])) {
-        return `The purpose "${path[1]}" is not allowed for entropy derivation.`;
-    }
-    if (FORBIDDEN_PATHS.some((forbiddenPath)=>(0, _array.isEqual)(path.slice(0, forbiddenPath.length), forbiddenPath))) {
-        return `The path "${path.join('/')}" is not allowed for entropy derivation.`;
-    }
-    return true;
-});
-const bip32entropy = (struct)=>(0, _superstruct.refine)(struct, 'BIP-32 entropy', (value)=>{
-        if (value.curve === 'ed25519' && value.path.slice(1).some((part)=>!part.endsWith("'"))) {
-            return 'Ed25519 does not support unhardened paths.';
-        }
-        return true;
-    });
-const Bip32EntropyStruct = bip32entropy((0, _superstruct.type)({
-    path: Bip32PathStruct,
-    curve: (0, _superstruct.enums)([
-        'ed25519',
-        'secp256k1'
-    ])
-}));
-const SnapGetBip32EntropyPermissionsStruct = (0, _superstruct.size)((0, _superstruct.array)(Bip32EntropyStruct), 1, Infinity);
-const SemVerRangeStruct = (0, _superstruct.refine)((0, _superstruct.string)(), 'SemVer range', (value)=>{
-    if ((0, _utils.isValidSemVerRange)(value)) {
-        return true;
-    }
-    return 'Expected a valid SemVer range.';
-});
-const SnapIdsStruct = (0, _superstruct.refine)((0, _superstruct.record)(_snaps.SnapIdStruct, (0, _superstruct.object)({
-    version: (0, _superstruct.optional)(SemVerRangeStruct)
-})), 'SnapIds', (value)=>{
-    if (Object.keys(value).length === 0) {
-        return false;
-    }
-    return true;
-});
-const PermissionsStruct = (0, _superstruct.type)({
-    'endowment:long-running': (0, _superstruct.optional)((0, _superstruct.object)({})),
-    'endowment:network-access': (0, _superstruct.optional)((0, _superstruct.object)({})),
-    'endowment:webassembly': (0, _superstruct.optional)((0, _superstruct.object)({})),
-    'endowment:transaction-insight': (0, _superstruct.optional)((0, _superstruct.object)({
-        allowTransactionOrigin: (0, _superstruct.optional)((0, _superstruct.boolean)())
-    })),
-    'endowment:cronjob': (0, _superstruct.optional)((0, _superstruct.object)({
-        jobs: _cronjob.CronjobSpecificationArrayStruct
-    })),
-    'endowment:rpc': (0, _superstruct.optional)(_jsonrpc.RpcOriginsStruct),
-    snap_dialog: (0, _superstruct.optional)((0, _superstruct.object)({})),
-    // TODO: Remove
-    snap_confirm: (0, _superstruct.optional)((0, _superstruct.object)({})),
-    snap_manageState: (0, _superstruct.optional)((0, _superstruct.object)({})),
-    snap_manageAccounts: (0, _superstruct.optional)((0, _superstruct.object)({})),
-    snap_notify: (0, _superstruct.optional)((0, _superstruct.object)({})),
-    snap_getBip32Entropy: (0, _superstruct.optional)(SnapGetBip32EntropyPermissionsStruct),
-    snap_getBip32PublicKey: (0, _superstruct.optional)(SnapGetBip32EntropyPermissionsStruct),
-    snap_getBip44Entropy: (0, _superstruct.optional)((0, _superstruct.size)((0, _superstruct.array)((0, _superstruct.object)({
-        coinType: (0, _superstruct.size)((0, _superstruct.integer)(), 0, 2 ** 32 - 1)
-    })), 1, Infinity)),
-    snap_getEntropy: (0, _superstruct.optional)((0, _superstruct.object)({})),
-    wallet_snap: (0, _superstruct.optional)(SnapIdsStruct)
-});
-const SnapManifestStruct = (0, _superstruct.object)({
-    version: _utils.VersionStruct,
-    description: (0, _superstruct.size)((0, _superstruct.string)(), 1, 280),
-    proposedName: (0, _superstruct.size)((0, _superstruct.pattern)((0, _superstruct.string)(), /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u), 1, 214),
-    repository: (0, _superstruct.optional)((0, _superstruct.object)({
-        type: (0, _superstruct.size)((0, _superstruct.string)(), 1, Infinity),
-        url: (0, _superstruct.size)((0, _superstruct.string)(), 1, Infinity)
-    })),
-    source: (0, _superstruct.object)({
-        shasum: _utils.ChecksumStruct,
-        location: (0, _superstruct.object)({
-            npm: (0, _superstruct.object)({
-                filePath: (0, _superstruct.size)((0, _superstruct.string)(), 1, Infinity),
-                iconPath: (0, _superstruct.optional)((0, _superstruct.size)((0, _superstruct.string)(), 1, Infinity)),
-                packageName: _types.NameStruct,
-                registry: (0, _superstruct.union)([
-                    (0, _superstruct.literal)('https://registry.npmjs.org'),
-                    (0, _superstruct.literal)('https://registry.npmjs.org/')
-                ])
-            })
-        })
-    }),
-    initialPermissions: PermissionsStruct,
-    manifestVersion: (0, _superstruct.literal)('0.1'),
-    $schema: (0, _superstruct.optional)((0, _superstruct.string)())
-});
-function isSnapManifest(value) {
-    return (0, _superstruct.is)(value, SnapManifestStruct);
-}
-function assertIsSnapManifest(value) {
-    (0, _utils.assertStruct)(value, SnapManifestStruct, `"${_types.NpmSnapFileNames.Manifest}" is invalid`);
-}
-function createSnapManifest(value) {
-    // TODO: Add a utility to prefix these errors similar to assertStruct
-    return (0, _superstruct.create)(value, SnapManifestStruct);
-}
-
-//# sourceMappingURL=validation.js.map

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/manifest/validation.ts"],"sourcesContent":["import { isValidBIP32PathSegment } from '@metamask/key-tree';\nimport {\n  assertStruct,\n  ChecksumStruct,\n  VersionStruct,\n  isValidSemVerRange,\n} from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  array,\n  boolean,\n  create,\n  enums,\n  integer,\n  is,\n  literal,\n  object,\n  optional,\n  pattern,\n  refine,\n  record,\n  size,\n  string,\n  type,\n  union,\n} from 'superstruct';\n\nimport { isEqual } from '../array';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from '../entropy';\nimport { RpcOriginsStruct } from '../json-rpc';\nimport { SnapIdStruct } from '../snaps';\nimport { NameStruct, NpmSnapFileNames } from '../types';\n\n// BIP-43 purposes that cannot be used for entropy derivation. These are in the\n// string form, ending with `'`.\nconst FORBIDDEN_PURPOSES: string[] = [\n  SIP_6_MAGIC_VALUE,\n  STATE_ENCRYPTION_MAGIC_VALUE,\n];\n\nexport const FORBIDDEN_COIN_TYPES: number[] = [60];\nconst FORBIDDEN_PATHS: string[][] = FORBIDDEN_COIN_TYPES.map((coinType) => [\n  'm',\n  \"44'\",\n  `${coinType}'`,\n]);\n\nexport const Bip32PathStruct = refine(\n  array(string()),\n  'BIP-32 path',\n  (path: string[]) => {\n    if (path.length === 0) {\n      return 'Path must be a non-empty BIP-32 derivation path array';\n    }\n\n    if (path[0] !== 'm') {\n      return 'Path must start with \"m\".';\n    }\n\n    if (path.length < 3) {\n      return 'Paths must have a length of at least three.';\n    }\n\n    if (path.slice(1).some((part) => !isValidBIP32PathSegment(part))) {\n      return 'Path must be a valid BIP-32 derivation path array.';\n    }\n\n    if (FORBIDDEN_PURPOSES.includes(path[1])) {\n      return `The purpose \"${path[1]}\" is not allowed for entropy derivation.`;\n    }\n\n    if (\n      FORBIDDEN_PATHS.some((forbiddenPath) =>\n        isEqual(path.slice(0, forbiddenPath.length), forbiddenPath),\n      )\n    ) {\n      return `The path \"${path.join(\n        '/',\n      )}\" is not allowed for entropy derivation.`;\n    }\n\n    return true;\n  },\n);\n\nexport const bip32entropy = <\n  Type extends { path: string[]; curve: string },\n  Schema,\n>(\n  struct: Struct<Type, Schema>,\n) =>\n  refine(struct, 'BIP-32 entropy', (value) => {\n    if (\n      value.curve === 'ed25519' &&\n      value.path.slice(1).some((part) => !part.endsWith(\"'\"))\n    ) {\n      return 'Ed25519 does not support unhardened paths.';\n    }\n\n    return true;\n  });\n\n// Used outside @metamask/snap-utils\nexport const Bip32EntropyStruct = bip32entropy(\n  type({\n    path: Bip32PathStruct,\n    curve: enums(['ed25519', 'secp256k1']),\n  }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const SnapGetBip32EntropyPermissionsStruct = size(\n  array(Bip32EntropyStruct),\n  1,\n  Infinity,\n);\n\nexport const SemVerRangeStruct = refine(string(), 'SemVer range', (value) => {\n  if (isValidSemVerRange(value)) {\n    return true;\n  }\n  return 'Expected a valid SemVer range.';\n});\n\nexport const SnapIdsStruct = refine(\n  record(SnapIdStruct, object({ version: optional(SemVerRangeStruct) })),\n  'SnapIds',\n  (value) => {\n    if (Object.keys(value).length === 0) {\n      return false;\n    }\n\n    return true;\n  },\n);\n\nexport type SnapIds = Infer<typeof SnapIdsStruct>;\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const PermissionsStruct = type({\n  'endowment:long-running': optional(object({})),\n  'endowment:network-access': optional(object({})),\n  'endowment:webassembly': optional(object({})),\n  'endowment:transaction-insight': optional(\n    object({\n      allowTransactionOrigin: optional(boolean()),\n    }),\n  ),\n  'endowment:cronjob': optional(\n    object({ jobs: CronjobSpecificationArrayStruct }),\n  ),\n  'endowment:rpc': optional(RpcOriginsStruct),\n  snap_dialog: optional(object({})),\n  // TODO: Remove\n  snap_confirm: optional(object({})),\n  snap_manageState: optional(object({})),\n  snap_manageAccounts: optional(object({})),\n  snap_notify: optional(object({})),\n  snap_getBip32Entropy: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip32PublicKey: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip44Entropy: optional(\n    size(\n      array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })),\n      1,\n      Infinity,\n    ),\n  ),\n  snap_getEntropy: optional(object({})),\n  wallet_snap: optional(SnapIdsStruct),\n});\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport type SnapPermissions = Infer<typeof PermissionsStruct>;\n\nexport const SnapManifestStruct = object({\n  version: VersionStruct,\n  description: size(string(), 1, 280),\n  proposedName: size(\n    pattern(\n      string(),\n      /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u,\n    ),\n    1,\n    214,\n  ),\n  repository: optional(\n    object({\n      type: size(string(), 1, Infinity),\n      url: size(string(), 1, Infinity),\n    }),\n  ),\n  source: object({\n    shasum: ChecksumStruct,\n    location: object({\n      npm: object({\n        filePath: size(string(), 1, Infinity),\n        iconPath: optional(size(string(), 1, Infinity)),\n        packageName: NameStruct,\n        registry: union([\n          literal('https://registry.npmjs.org'),\n          literal('https://registry.npmjs.org/'),\n        ]),\n      }),\n    }),\n  }),\n  initialPermissions: PermissionsStruct,\n  manifestVersion: literal('0.1'),\n  $schema: optional(string()), // enables JSON-Schema linting in VSC and other IDEs\n});\n\nexport type SnapManifest = Infer<typeof SnapManifestStruct>;\n\n/**\n * Check if the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link SnapManifest} object.\n */\nexport function isSnapManifest(value: unknown): value is SnapManifest {\n  return is(value, SnapManifestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link SnapManifest} object.\n */\nexport function assertIsSnapManifest(\n  value: unknown,\n): asserts value is SnapManifest {\n  assertStruct(\n    value,\n    SnapManifestStruct,\n    `\"${NpmSnapFileNames.Manifest}\" is invalid`,\n  );\n}\n\n/**\n * Creates a {@link SnapManifest} object from JSON.\n *\n * @param value - The value to check.\n * @throws If the value cannot be coerced to a {@link SnapManifest} object.\n * @returns The created {@link SnapManifest} object.\n */\nexport function createSnapManifest(value: unknown): SnapManifest {\n  // TODO: Add a utility to prefix these errors similar to assertStruct\n  return create(value, SnapManifestStruct);\n}\n"],"names":["FORBIDDEN_COIN_TYPES","Bip32PathStruct","bip32entropy","Bip32EntropyStruct","SnapGetBip32EntropyPermissionsStruct","SemVerRangeStruct","SnapIdsStruct","PermissionsStruct","SnapManifestStruct","isSnapManifest","assertIsSnapManifest","createSnapManifest","FORBIDDEN_PURPOSES","SIP_6_MAGIC_VALUE","STATE_ENCRYPTION_MAGIC_VALUE","FORBIDDEN_PATHS","map","coinType","refine","array","string","path","length","slice","some","part","isValidBIP32PathSegment","includes","forbiddenPath","isEqual","join","struct","value","curve","endsWith","type","enums","size","Infinity","isValidSemVerRange","record","SnapIdStruct","object","version","optional","Object","keys","allowTransactionOrigin","boolean","jobs","CronjobSpecificationArrayStruct","RpcOriginsStruct","snap_dialog","snap_confirm","snap_manageState","snap_manageAccounts","snap_notify","snap_getBip32Entropy","snap_getBip32PublicKey","snap_getBip44Entropy","integer","snap_getEntropy","wallet_snap","VersionStruct","description","proposedName","pattern","repository","url","source","shasum","ChecksumStruct","location","npm","filePath","iconPath","packageName","NameStruct","registry","union","literal","initialPermissions","manifestVersion","$schema","is","assertStruct","NpmSnapFileNames","Manifest","create"],"mappings":";;;;;;;;;;;IAyCaA,oBAAoB;eAApBA;;IAOAC,eAAe;eAAfA;;IAsCAC,YAAY;eAAZA;;IAkBAC,kBAAkB;eAAlBA;;IASAC,oCAAoC;eAApCA;;IAMAC,iBAAiB;eAAjBA;;IAOAC,aAAa;eAAbA;;IAeAC,iBAAiB;eAAjBA;;IAmCAC,kBAAkB;eAAlBA;;IA4CGC,cAAc;eAAdA;;IAUAC,oBAAoB;eAApBA;;IAiBAC,kBAAkB;eAAlBA;;;yBAvPwB;uBAMjC;6BAmBA;uBAEiB;yBACwB;yBACgB;yBAC/B;uBACJ;uBACgB;AAE7C,+EAA+E;AAC/E,gCAAgC;AAChC,MAAMC,qBAA+B;IACnCC,0BAAiB;IACjBC,qCAA4B;CAC7B;AAEM,MAAMd,uBAAiC;IAAC;CAAG;AAClD,MAAMe,kBAA8Bf,qBAAqBgB,GAAG,CAAC,CAACC,WAAa;QACzE;QACA;QACA,CAAC,EAAEA,SAAS,CAAC,CAAC;KACf;AAEM,MAAMhB,kBAAkBiB,IAAAA,mBAAM,EACnCC,IAAAA,kBAAK,EAACC,IAAAA,mBAAM,MACZ,eACA,CAACC;IACC,IAAIA,KAAKC,MAAM,KAAK,GAAG;QACrB,OAAO;IACT;IAEA,IAAID,IAAI,CAAC,EAAE,KAAK,KAAK;QACnB,OAAO;IACT;IAEA,IAAIA,KAAKC,MAAM,GAAG,GAAG;QACnB,OAAO;IACT;IAEA,IAAID,KAAKE,KAAK,CAAC,GAAGC,IAAI,CAAC,CAACC,OAAS,CAACC,IAAAA,gCAAuB,EAACD,QAAQ;QAChE,OAAO;IACT;IAEA,IAAIb,mBAAmBe,QAAQ,CAACN,IAAI,CAAC,EAAE,GAAG;QACxC,OAAO,CAAC,aAAa,EAAEA,IAAI,CAAC,EAAE,CAAC,wCAAwC,CAAC;IAC1E;IAEA,IACEN,gBAAgBS,IAAI,CAAC,CAACI,gBACpBC,IAAAA,cAAO,EAACR,KAAKE,KAAK,CAAC,GAAGK,cAAcN,MAAM,GAAGM,iBAE/C;QACA,OAAO,CAAC,UAAU,EAAEP,KAAKS,IAAI,CAC3B,KACA,wCAAwC,CAAC;IAC7C;IAEA,OAAO;AACT;AAGK,MAAM5B,eAAe,CAI1B6B,SAEAb,IAAAA,mBAAM,EAACa,QAAQ,kBAAkB,CAACC;QAChC,IACEA,MAAMC,KAAK,KAAK,aAChBD,MAAMX,IAAI,CAACE,KAAK,CAAC,GAAGC,IAAI,CAAC,CAACC,OAAS,CAACA,KAAKS,QAAQ,CAAC,OAClD;YACA,OAAO;QACT;QAEA,OAAO;IACT;AAGK,MAAM/B,qBAAqBD,aAChCiC,IAAAA,iBAAI,EAAC;IACHd,MAAMpB;IACNgC,OAAOG,IAAAA,kBAAK,EAAC;QAAC;QAAW;KAAY;AACvC;AAKK,MAAMhC,uCAAuCiC,IAAAA,iBAAI,EACtDlB,IAAAA,kBAAK,EAAChB,qBACN,GACAmC;AAGK,MAAMjC,oBAAoBa,IAAAA,mBAAM,EAACE,IAAAA,mBAAM,KAAI,gBAAgB,CAACY;IACjE,IAAIO,IAAAA,yBAAkB,EAACP,QAAQ;QAC7B,OAAO;IACT;IACA,OAAO;AACT;AAEO,MAAM1B,gBAAgBY,IAAAA,mBAAM,EACjCsB,IAAAA,mBAAM,EAACC,mBAAY,EAAEC,IAAAA,mBAAM,EAAC;IAAEC,SAASC,IAAAA,qBAAQ,EAACvC;AAAmB,KACnE,WACA,CAAC2B;IACC,IAAIa,OAAOC,IAAI,CAACd,OAAOV,MAAM,KAAK,GAAG;QACnC,OAAO;IACT;IAEA,OAAO;AACT;AAMK,MAAMf,oBAAoB4B,IAAAA,iBAAI,EAAC;IACpC,0BAA0BS,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IAC3C,4BAA4BE,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IAC7C,yBAAyBE,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IAC1C,iCAAiCE,IAAAA,qBAAQ,EACvCF,IAAAA,mBAAM,EAAC;QACLK,wBAAwBH,IAAAA,qBAAQ,EAACI,IAAAA,oBAAO;IAC1C;IAEF,qBAAqBJ,IAAAA,qBAAQ,EAC3BF,IAAAA,mBAAM,EAAC;QAAEO,MAAMC,wCAA+B;IAAC;IAEjD,iBAAiBN,IAAAA,qBAAQ,EAACO,yBAAgB;IAC1CC,aAAaR,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IAC9B,eAAe;IACfW,cAAcT,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IAC/BY,kBAAkBV,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IACnCa,qBAAqBX,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IACtCc,aAAaZ,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IAC9Be,sBAAsBb,IAAAA,qBAAQ,EAACxC;IAC/BsD,wBAAwBd,IAAAA,qBAAQ,EAACxC;IACjCuD,sBAAsBf,IAAAA,qBAAQ,EAC5BP,IAAAA,iBAAI,EACFlB,IAAAA,kBAAK,EAACuB,IAAAA,mBAAM,EAAC;QAAEzB,UAAUoB,IAAAA,iBAAI,EAACuB,IAAAA,oBAAO,KAAI,GAAG,KAAK,KAAK;IAAG,KACzD,GACAtB;IAGJuB,iBAAiBjB,IAAAA,qBAAQ,EAACF,IAAAA,mBAAM,EAAC,CAAC;IAClCoB,aAAalB,IAAAA,qBAAQ,EAACtC;AACxB;AAKO,MAAME,qBAAqBkC,IAAAA,mBAAM,EAAC;IACvCC,SAASoB,oBAAa;IACtBC,aAAa3B,IAAAA,iBAAI,EAACjB,IAAAA,mBAAM,KAAI,GAAG;IAC/B6C,cAAc5B,IAAAA,iBAAI,EAChB6B,IAAAA,oBAAO,EACL9C,IAAAA,mBAAM,KACN,qHAEF,GACA;IAEF+C,YAAYvB,IAAAA,qBAAQ,EAClBF,IAAAA,mBAAM,EAAC;QACLP,MAAME,IAAAA,iBAAI,EAACjB,IAAAA,mBAAM,KAAI,GAAGkB;QACxB8B,KAAK/B,IAAAA,iBAAI,EAACjB,IAAAA,mBAAM,KAAI,GAAGkB;IACzB;IAEF+B,QAAQ3B,IAAAA,mBAAM,EAAC;QACb4B,QAAQC,qBAAc;QACtBC,UAAU9B,IAAAA,mBAAM,EAAC;YACf+B,KAAK/B,IAAAA,mBAAM,EAAC;gBACVgC,UAAUrC,IAAAA,iBAAI,EAACjB,IAAAA,mBAAM,KAAI,GAAGkB;gBAC5BqC,UAAU/B,IAAAA,qBAAQ,EAACP,IAAAA,iBAAI,EAACjB,IAAAA,mBAAM,KAAI,GAAGkB;gBACrCsC,aAAaC,iBAAU;gBACvBC,UAAUC,IAAAA,kBAAK,EAAC;oBACdC,IAAAA,oBAAO,EAAC;oBACRA,IAAAA,oBAAO,EAAC;iBACT;YACH;QACF;IACF;IACAC,oBAAoB1E;IACpB2E,iBAAiBF,IAAAA,oBAAO,EAAC;IACzBG,SAASvC,IAAAA,qBAAQ,EAACxB,IAAAA,mBAAM;AAC1B;AAUO,SAASX,eAAeuB,KAAc;IAC3C,OAAOoD,IAAAA,eAAE,EAACpD,OAAOxB;AACnB;AAQO,SAASE,qBACdsB,KAAc;IAEdqD,IAAAA,mBAAY,EACVrD,OACAxB,oBACA,CAAC,CAAC,EAAE8E,uBAAgB,CAACC,QAAQ,CAAC,YAAY,CAAC;AAE/C;AASO,SAAS5E,mBAAmBqB,KAAc;IAC/C,qEAAqE;IACrE,OAAOwD,IAAAA,mBAAM,EAACxD,OAAOxB;AACvB"}