@metamask/snaps-utils 4.0.0 → 5.0.0

package/dist/esm/manifest/manifest.js.map

@@ -1 +1 @@
-{"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 { 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 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    auxiliaryFiles: (await getSnapFiles(basePath, auxiliaryFilePaths)) ?? [],\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 (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 * @returns A list of auxiliary files and their contents, if any.\n */\nexport async function getSnapFiles(\n  basePath: string,\n  paths: string[] | undefined,\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), 'utf8'),\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":["getErrorMessage","assertExhaustive","assert","isPlainObject","deepEqual","promises","fs","pathUtils","deepClone","readJsonFile","validateNpmSnap","getSnapChecksum","ProgrammaticallyFixableSnapError","validateSnapShasum","NpmSnapFileNames","SnapValidationFailureReason","readVirtualFile","VirtualFile","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialPermissions","manifestVersion","checkManifest","basePath","writeManifest","sourceCode","writeFileFn","writeFile","warnings","errors","updated","manifestPath","join","Manifest","manifestFile","unvalidatedManifest","result","packageFile","PackageJson","auxiliaryFilePaths","getSnapFilePaths","manifest","files","localizationFilePaths","locales","snapFiles","packageJson","getSnapSourceCode","svgIcon","getSnapIcon","auxiliaryFiles","getSnapFiles","localizationFiles","error","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","length","attempts","fixManifest","validateNpmSnapManifest","nextValidationError","Error","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","getWritableManifest","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","undefined","ShasumMismatch","shasum","sourceFilePath","filePath","path","virtualFile","iconPath","selector","snapManifest","paths","Array","isArray","Promise","all","map","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository"],"mappings":"AAAA,SAASA,eAAe,QAAQ,sBAAsB;AAEtD,SAASC,gBAAgB,EAAEC,MAAM,EAAEC,aAAa,QAAQ,kBAAkB;AAC1E,OAAOC,eAAe,kBAAkB;AACxC,SAASC,YAAYC,EAAE,QAAQ,KAAK;AACpC,OAAOC,eAAe,OAAO;AAE7B,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,YAAY,QAAQ,QAAQ;AACrC,SAASC,eAAe,QAAQ,SAAS;AACzC,SACEC,eAAe,EACfC,gCAAgC,EAChCC,kBAAkB,QACb,WAAW;AAElB,SAASC,gBAAgB,EAAEC,2BAA2B,QAAQ,WAAW;AACzE,SAASC,eAAe,EAAEC,WAAW,QAAQ,kBAAkB;AAG/D,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,iBAAiB;AACnB;AAyBA;;;;;;;;;;;CAWC,GACD,OAAO,eAAeC,cACpBC,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiCzB,GAAG0B,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAe7B,UAAU8B,IAAI,CAACT,UAAUd,iBAAiBwB,QAAQ;IACvE,MAAMC,eAAe,MAAM9B,aAAa2B;IACxC,MAAMI,sBAAsBD,aAAaE,MAAM;IAE/C,MAAMC,cAAc,MAAMjC,aACxBF,UAAU8B,IAAI,CAACT,UAAUd,iBAAiB6B,WAAW;IAGvD,MAAMC,qBAAqBC,iBACzBL,qBACA,CAACM,WAAaA,UAAUtB,QAAQuB;IAGlC,MAAMC,wBAAwBH,iBAC5BL,qBACA,CAACM,WAAaA,UAAUtB,QAAQyB;IAGlC,MAAMC,YAAkC;QACtCJ,UAAUP;QACVY,aAAaT;QACbZ,YAAY,MAAMsB,kBAChBxB,UACAY,qBACAV;QAEFuB,SAAS,MAAMC,YAAY1B,UAAUY;QACrCe,gBAAgB,AAAC,MAAMC,aAAa5B,UAAUgB,uBAAwB,EAAE;QACxEa,mBACE,AAAC,MAAMD,aAAa5B,UAAUoB,0BAA2B,EAAE;IAC/D;IAEA,IAAIF;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAG,MAAMpC,gBAAgBwC,UAAS;IACjD,EAAE,OAAOQ,OAAO;QACd,IAAIA,iBAAiB9C,kCAAkC;YACrDsB,OAAOyB,IAAI,CAACD,MAAME,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BX;YAEhC,IAAIY,YAAY;YAChB,IAAIC,eAAeL;YACnB,MAAMM,cAAcC,OAAOC,IAAI,CAACnD,6BAA6BoD,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGN,aAAaM,YAAYJ,aAAaI,WAAY;gBACvEtB,WAAW,MAAMuB,YACfvB,WACI;oBAAE,GAAGe,uBAAuB;oBAAEf;gBAAS,IACvCe,yBACJE;gBAGF,IAAI;oBACF,MAAMO,wBAAwB;wBAC5B,GAAGT,uBAAuB;wBAC1Bf;oBACF;oBAEAgB,YAAY;gBACd,EAAE,OAAOS,qBAAqB;oBAC5BR,eAAeQ;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+B3D,gCAA+B,KAE/DwD,aAAaJ,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIU,MACR,CAAC,kFAAkF,EAAEd,MAAME,OAAO,CAAC,CAAC;oBAExG;oBAEA1B,OAAOyB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEAzB,UAAU;QACZ,OAAO;YACL,MAAMuB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1CxD,OAAO4C;IAEP,MAAM2B,oBAAoB3B,SAASL,MAAM;IAEzC,qCAAqC;IACrC,MAAMiC,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBR,MAAM,GAAG,GAAG;QACvClC,SAAS0B,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,IAAInD,eAAe;QACjB,IAAI;YACF,MAAMoD,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCC,oBAAoBX,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAItC,WAAW8C,gBAAgB1C,aAAa8C,KAAK,EAAE;gBACjD,MAAMtD,YACJxB,UAAU8B,IAAI,CAACT,UAAUd,iBAAiBwB,QAAQ,GAClD2C;YAEJ;QACF,EAAE,OAAOvB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAME,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEd,UAAU2B;QAAmBtC;QAASF;QAAUC;IAAO;AAClE;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAemC,YACpBnB,SAAoB,EACpBQ,KAAuC;IAEvC,MAAM,EAAEZ,QAAQ,EAAEK,WAAW,EAAE,GAAGD;IAClC,MAAMoC,aAAaxC,SAASyC,KAAK;IACjC,MAAMC,eAAeF,WAAW7C,MAAM;IAEtC,OAAQiB,MAAM+B,MAAM;QAClB,KAAK1E,4BAA4B2E,YAAY;YAC3CF,aAAahE,MAAM,CAACmE,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAG1C,YAAYV,MAAM,CAACqD,IAAI;YACtE;QAEF,KAAK/E,4BAA4BgF,eAAe;YAC9CP,aAAapE,OAAO,GAAG+B,YAAYV,MAAM,CAACrB,OAAO;YACjD;QAEF,KAAKL,4BAA4BiF,kBAAkB;YACjDR,aAAajE,UAAU,GAAG4B,YAAYV,MAAM,CAAClB,UAAU,GACnDf,UAAU2C,YAAYV,MAAM,CAAClB,UAAU,IACvC0E;YACJ;QAEF,KAAKlF,4BAA4BmF,cAAc;YAC7CV,aAAahE,MAAM,CAAC2E,MAAM,GAAG,MAAMxF,gBAAgBuC;YACnD;QAEF,wBAAwB,GACxB;YACEjD,iBAAiByD,MAAM+B,MAAM;IACjC;IAEAH,WAAW7C,MAAM,GAAG+C;IACpBF,WAAWD,KAAK,GAAGH,KAAKC,SAAS,CAACK;IAClC,OAAOF;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAelC,kBACpBxB,QAAgB,EAChBkB,QAAc,EACdhB,UAAmB;IAEnB,IAAI,CAAC3B,cAAc2C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMG,iBAAiB,AAACtD,SAAmCtB,MAAM,EAAEmE,UAC/DC,KAAKS;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAOH;IACT;IAEA,IAAInE,YAAY;QACd,OAAO,IAAIb,YAAY;YACrBqF,MAAM/F,UAAU8B,IAAI,CAACT,UAAUwE;YAC/Bf,OAAOvD;QACT;IACF;IAEA,IAAI;QACF,MAAMyE,cAAc,MAAMvF,gBACxBT,UAAU8B,IAAI,CAACT,UAAUwE,iBACzB;QAEF,OAAOG;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MACR,CAAC,iCAAiC,EAAExE,gBAAgB0D,OAAO,CAAC;IAEhE;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeJ,YACpB1B,QAAgB,EAChBkB,QAAc;IAEd,IAAI,CAAC3C,cAAc2C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMO,WAAW,AAAC1D,SAAmCtB,MAAM,EAAEmE,UAAUC,KACnEY;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOP;IACT;IAEA,IAAI;QACF,MAAMM,cAAc,MAAMvF,gBACxBT,UAAU8B,IAAI,CAACT,UAAU4E,WACzB;QAEF,OAAOD;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAExE,gBAAgB0D,OAAO,CAAC;IAC5E;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASb,iBACdC,QAAc,EACd2D,QAAmE;IAEnE,IAAI,CAACtG,cAAc2C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMS,eAAe5D;IACrB,MAAM6D,QAAQF,SAASC;IAEvB,IAAI,CAACE,MAAMC,OAAO,CAACF,QAAQ;QACzB,OAAOV;IACT;IAEA,OAAOU;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,eAAenD,aACpB5B,QAAgB,EAChB+E,KAA2B;IAE3B,IAAI,CAACA,OAAO;QACV,OAAOV;IACT;IAEA,IAAI;QACF,OAAO,MAAMa,QAAQC,GAAG,CACtBJ,MAAMK,GAAG,CAAC,OAAOX,WACfrF,gBAAgBT,UAAU8B,IAAI,CAACT,UAAUyE,WAAW;IAG1D,EAAE,OAAO3C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,2BAA2B,EAAExE,gBAAgB0D,OAAO,CAAC;IACxE;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAAS0B,oBAAoBtC,QAAsB;IACxD,MAAM,EAAEvB,UAAU,EAAE,GAAG0F,WAAW,GAAGnE;IAErC,MAAMoB,OAAOD,OAAOC,IAAI,CACtB3C,aAAa;QAAE,GAAG0F,SAAS;QAAE1F;IAAW,IAAI0F;IAG9C,MAAMC,mBAAmBhD,KACtBiD,IAAI,CAAC,CAACC,GAAGC,IAAMnG,mBAAmB,CAACkG,EAAE,GAAGlG,mBAAmB,CAACmG,EAAE,EAC9DvC,MAAM,CACL,CAACrC,QAAQoC,MAAS,CAAA;YAChB,GAAGpC,MAAM;YACT,CAACoC,IAAI,EAAE/B,QAAQ,CAAC+B,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAOqC;AACT;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,eAAe5C,wBAAwB,EAC5CxB,QAAQ,EACRK,WAAW,EACXrB,UAAU,EACVuB,OAAO,EACPE,cAAc,EACdE,iBAAiB,EACP;IACV,MAAM6D,kBAAkBnE,YAAYV,MAAM,CAACqD,IAAI;IAC/C,MAAMyB,qBAAqBpE,YAAYV,MAAM,CAACrB,OAAO;IACrD,MAAMoG,wBAAwBrE,YAAYV,MAAM,CAAClB,UAAU;IAE3D,MAAMkG,sBAAsB3E,SAASL,MAAM,CAACjB,MAAM,CAACmE,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAM6B,yBAAyB5E,SAASL,MAAM,CAACrB,OAAO;IACtD,MAAMuG,qBAAqB7E,SAASL,MAAM,CAAClB,UAAU;IAErD,IAAI+F,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI7G,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,qBAAqB,EAAEmF,oBAAoB,uBAAuB,EAAE3G,iBAAiB6B,WAAW,CAAC,iBAAiB,EAAE2E,gBAAgB,GAAG,CAAC,EACtKvG,4BAA4B2E,YAAY;IAE5C;IAEA,IAAI6B,uBAAuBG,wBAAwB;QACjD,MAAM,IAAI9G,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,wBAAwB,EAAEoF,uBAAuB,uBAAuB,EAAE5G,iBAAiB6B,WAAW,CAAC,oBAAoB,EAAE4E,mBAAmB,GAAG,CAAC,EAClLxG,4BAA4BgF,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDyB,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACvH,UAAUoH,uBAAuBG,qBAClC;QACA,MAAM,IAAI/G,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,yCAAyC,EAAExB,iBAAiB6B,WAAW,CAAC,qBAAqB,CAAC,EAC5H5B,4BAA4BiF,kBAAkB;IAElD;IAEA,MAAMnF,mBACJ;QAAEiC;QAAUhB;QAAYuB;QAASE;QAAgBE;IAAkB,GACnE,CAAC,CAAC,EAAE3C,iBAAiBwB,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}
+{"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 { 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 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 (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":["getErrorMessage","assertExhaustive","assert","isPlainObject","deepEqual","promises","fs","pathUtils","deepClone","readJsonFile","validateNpmSnap","getSnapChecksum","ProgrammaticallyFixableSnapError","validateSnapShasum","NpmSnapFileNames","SnapValidationFailureReason","readVirtualFile","VirtualFile","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialPermissions","manifestVersion","checkManifest","basePath","writeManifest","sourceCode","writeFileFn","writeFile","warnings","errors","updated","manifestPath","join","Manifest","manifestFile","unvalidatedManifest","result","packageFile","PackageJson","auxiliaryFilePaths","getSnapFilePaths","manifest","files","localizationFilePaths","locales","snapFiles","packageJson","getSnapSourceCode","svgIcon","getSnapIcon","auxiliaryFiles","getSnapFiles","localizationFiles","error","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","length","attempts","fixManifest","validateNpmSnapManifest","nextValidationError","Error","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","getWritableManifest","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","undefined","ShasumMismatch","shasum","sourceFilePath","filePath","path","virtualFile","iconPath","selector","snapManifest","paths","Array","isArray","encoding","Promise","all","map","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository"],"mappings":"AAAA,SAASA,eAAe,QAAQ,sBAAsB;AAEtD,SAASC,gBAAgB,EAAEC,MAAM,EAAEC,aAAa,QAAQ,kBAAkB;AAC1E,OAAOC,eAAe,kBAAkB;AACxC,SAASC,YAAYC,EAAE,QAAQ,KAAK;AACpC,OAAOC,eAAe,OAAO;AAE7B,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,YAAY,QAAQ,QAAQ;AACrC,SAASC,eAAe,QAAQ,SAAS;AACzC,SACEC,eAAe,EACfC,gCAAgC,EAChCC,kBAAkB,QACb,WAAW;AAElB,SAASC,gBAAgB,EAAEC,2BAA2B,QAAQ,WAAW;AACzE,SAASC,eAAe,EAAEC,WAAW,QAAQ,kBAAkB;AAG/D,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,iBAAiB;AACnB;AAyBA;;;;;;;;;;;CAWC,GACD,OAAO,eAAeC,cACpBC,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiCzB,GAAG0B,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAe7B,UAAU8B,IAAI,CAACT,UAAUd,iBAAiBwB,QAAQ;IACvE,MAAMC,eAAe,MAAM9B,aAAa2B;IACxC,MAAMI,sBAAsBD,aAAaE,MAAM;IAE/C,MAAMC,cAAc,MAAMjC,aACxBF,UAAU8B,IAAI,CAACT,UAAUd,iBAAiB6B,WAAW;IAGvD,MAAMC,qBAAqBC,iBACzBL,qBACA,CAACM,WAAaA,UAAUtB,QAAQuB;IAGlC,MAAMC,wBAAwBH,iBAC5BL,qBACA,CAACM,WAAaA,UAAUtB,QAAQyB;IAGlC,MAAMC,YAAkC;QACtCJ,UAAUP;QACVY,aAAaT;QACbZ,YAAY,MAAMsB,kBAChBxB,UACAY,qBACAV;QAEFuB,SAAS,MAAMC,YAAY1B,UAAUY;QACrC,6EAA6E;QAC7Ee,gBACE,AAAC,MAAMC,aAAa5B,UAAUgB,oBAAoB,SAAU,EAAE;QAChEa,mBACE,AAAC,MAAMD,aAAa5B,UAAUoB,0BAA2B,EAAE;IAC/D;IAEA,IAAIF;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAG,MAAMpC,gBAAgBwC,UAAS;IACjD,EAAE,OAAOQ,OAAO;QACd,IAAIA,iBAAiB9C,kCAAkC;YACrDsB,OAAOyB,IAAI,CAACD,MAAME,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BX;YAEhC,IAAIY,YAAY;YAChB,IAAIC,eAAeL;YACnB,MAAMM,cAAcC,OAAOC,IAAI,CAACnD,6BAA6BoD,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGN,aAAaM,YAAYJ,aAAaI,WAAY;gBACvEtB,WAAW,MAAMuB,YACfvB,WACI;oBAAE,GAAGe,uBAAuB;oBAAEf;gBAAS,IACvCe,yBACJE;gBAGF,IAAI;oBACF,MAAMO,wBAAwB;wBAC5B,GAAGT,uBAAuB;wBAC1Bf;oBACF;oBAEAgB,YAAY;gBACd,EAAE,OAAOS,qBAAqB;oBAC5BR,eAAeQ;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+B3D,gCAA+B,KAE/DwD,aAAaJ,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIU,MACR,CAAC,kFAAkF,EAAEd,MAAME,OAAO,CAAC,CAAC;oBAExG;oBAEA1B,OAAOyB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEAzB,UAAU;QACZ,OAAO;YACL,MAAMuB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1CxD,OAAO4C;IAEP,MAAM2B,oBAAoB3B,SAASL,MAAM;IAEzC,qCAAqC;IACrC,MAAMiC,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBR,MAAM,GAAG,GAAG;QACvClC,SAAS0B,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,IAAInD,eAAe;QACjB,IAAI;YACF,MAAMoD,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCC,oBAAoBX,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAItC,WAAW8C,gBAAgB1C,aAAa8C,KAAK,EAAE;gBACjD,MAAMtD,YACJxB,UAAU8B,IAAI,CAACT,UAAUd,iBAAiBwB,QAAQ,GAClD2C;YAEJ;QACF,EAAE,OAAOvB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAME,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEd,UAAU2B;QAAmBtC;QAASF;QAAUC;IAAO;AAClE;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAemC,YACpBnB,SAAoB,EACpBQ,KAAuC;IAEvC,MAAM,EAAEZ,QAAQ,EAAEK,WAAW,EAAE,GAAGD;IAClC,MAAMoC,aAAaxC,SAASyC,KAAK;IACjC,MAAMC,eAAeF,WAAW7C,MAAM;IAEtC,OAAQiB,MAAM+B,MAAM;QAClB,KAAK1E,4BAA4B2E,YAAY;YAC3CF,aAAahE,MAAM,CAACmE,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAG1C,YAAYV,MAAM,CAACqD,IAAI;YACtE;QAEF,KAAK/E,4BAA4BgF,eAAe;YAC9CP,aAAapE,OAAO,GAAG+B,YAAYV,MAAM,CAACrB,OAAO;YACjD;QAEF,KAAKL,4BAA4BiF,kBAAkB;YACjDR,aAAajE,UAAU,GAAG4B,YAAYV,MAAM,CAAClB,UAAU,GACnDf,UAAU2C,YAAYV,MAAM,CAAClB,UAAU,IACvC0E;YACJ;QAEF,KAAKlF,4BAA4BmF,cAAc;YAC7CV,aAAahE,MAAM,CAAC2E,MAAM,GAAG,MAAMxF,gBAAgBuC;YACnD;QAEF,wBAAwB,GACxB;YACEjD,iBAAiByD,MAAM+B,MAAM;IACjC;IAEAH,WAAW7C,MAAM,GAAG+C;IACpBF,WAAWD,KAAK,GAAGH,KAAKC,SAAS,CAACK;IAClC,OAAOF;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAelC,kBACpBxB,QAAgB,EAChBkB,QAAc,EACdhB,UAAmB;IAEnB,IAAI,CAAC3B,cAAc2C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMG,iBAAiB,AAACtD,SAAmCtB,MAAM,EAAEmE,UAC/DC,KAAKS;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAOH;IACT;IAEA,IAAInE,YAAY;QACd,OAAO,IAAIb,YAAY;YACrBqF,MAAM/F,UAAU8B,IAAI,CAACT,UAAUwE;YAC/Bf,OAAOvD;QACT;IACF;IAEA,IAAI;QACF,MAAMyE,cAAc,MAAMvF,gBACxBT,UAAU8B,IAAI,CAACT,UAAUwE,iBACzB;QAEF,OAAOG;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MACR,CAAC,iCAAiC,EAAExE,gBAAgB0D,OAAO,CAAC;IAEhE;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeJ,YACpB1B,QAAgB,EAChBkB,QAAc;IAEd,IAAI,CAAC3C,cAAc2C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMO,WAAW,AAAC1D,SAAmCtB,MAAM,EAAEmE,UAAUC,KACnEY;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOP;IACT;IAEA,IAAI;QACF,MAAMM,cAAc,MAAMvF,gBACxBT,UAAU8B,IAAI,CAACT,UAAU4E,WACzB;QAEF,OAAOD;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAExE,gBAAgB0D,OAAO,CAAC;IAC5E;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASb,iBACdC,QAAc,EACd2D,QAAmE;IAEnE,IAAI,CAACtG,cAAc2C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMS,eAAe5D;IACrB,MAAM6D,QAAQF,SAASC;IAEvB,IAAI,CAACE,MAAMC,OAAO,CAACF,QAAQ;QACzB,OAAOV;IACT;IAEA,OAAOU;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAenD,aACpB5B,QAAgB,EAChB+E,KAA2B,EAC3BG,WAAkC,MAAM;IAExC,IAAI,CAACH,OAAO;QACV,OAAOV;IACT;IAEA,IAAI;QACF,OAAO,MAAMc,QAAQC,GAAG,CACtBL,MAAMM,GAAG,CAAC,OAAOZ,WACfrF,gBAAgBT,UAAU8B,IAAI,CAACT,UAAUyE,WAAWS;IAG1D,EAAE,OAAOpD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,2BAA2B,EAAExE,gBAAgB0D,OAAO,CAAC;IACxE;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAAS0B,oBAAoBtC,QAAsB;IACxD,MAAM,EAAEvB,UAAU,EAAE,GAAG2F,WAAW,GAAGpE;IAErC,MAAMoB,OAAOD,OAAOC,IAAI,CACtB3C,aAAa;QAAE,GAAG2F,SAAS;QAAE3F;IAAW,IAAI2F;IAG9C,MAAMC,mBAAmBjD,KACtBkD,IAAI,CAAC,CAACC,GAAGC,IAAMpG,mBAAmB,CAACmG,EAAE,GAAGnG,mBAAmB,CAACoG,EAAE,EAC9DxC,MAAM,CACL,CAACrC,QAAQoC,MAAS,CAAA;YAChB,GAAGpC,MAAM;YACT,CAACoC,IAAI,EAAE/B,QAAQ,CAAC+B,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAOsC;AACT;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,eAAe7C,wBAAwB,EAC5CxB,QAAQ,EACRK,WAAW,EACXrB,UAAU,EACVuB,OAAO,EACPE,cAAc,EACdE,iBAAiB,EACP;IACV,MAAM8D,kBAAkBpE,YAAYV,MAAM,CAACqD,IAAI;IAC/C,MAAM0B,qBAAqBrE,YAAYV,MAAM,CAACrB,OAAO;IACrD,MAAMqG,wBAAwBtE,YAAYV,MAAM,CAAClB,UAAU;IAE3D,MAAMmG,sBAAsB5E,SAASL,MAAM,CAACjB,MAAM,CAACmE,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAM8B,yBAAyB7E,SAASL,MAAM,CAACrB,OAAO;IACtD,MAAMwG,qBAAqB9E,SAASL,MAAM,CAAClB,UAAU;IAErD,IAAIgG,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI9G,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,qBAAqB,EAAEoF,oBAAoB,uBAAuB,EAAE5G,iBAAiB6B,WAAW,CAAC,iBAAiB,EAAE4E,gBAAgB,GAAG,CAAC,EACtKxG,4BAA4B2E,YAAY;IAE5C;IAEA,IAAI8B,uBAAuBG,wBAAwB;QACjD,MAAM,IAAI/G,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,wBAAwB,EAAEqF,uBAAuB,uBAAuB,EAAE7G,iBAAiB6B,WAAW,CAAC,oBAAoB,EAAE6E,mBAAmB,GAAG,CAAC,EAClLzG,4BAA4BgF,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvD0B,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACxH,UAAUqH,uBAAuBG,qBAClC;QACA,MAAM,IAAIhH,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,yCAAyC,EAAExB,iBAAiB6B,WAAW,CAAC,qBAAqB,CAAC,EAC5H5B,4BAA4BiF,kBAAkB;IAElD;IAEA,MAAMnF,mBACJ;QAAEiC;QAAUhB;QAAYuB;QAASE;QAAgBE;IAAkB,GACnE,CAAC,CAAC,EAAE3C,iBAAiBwB,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}

package/dist/esm/structs.js

@@ -1,55 +1,8 @@
 import { isObject } from '@metamask/utils';
 import { bold, green, red } from 'chalk';
 import { resolve } from 'path';
-import { Struct, StructError, define, literal as superstructLiteral, union as superstructUnion, create, string, coerce } from 'superstruct';
+import { Struct, StructError, create, string, coerce } from 'superstruct';
 import { indent } from './strings';
-/**
- * A wrapper of `superstruct`'s `literal` struct that also defines the name of
- * the struct as the literal value.
- *
- * This is useful for improving the error messages returned by `superstruct`.
- * For example, instead of returning an error like:
- *
- * ```
- * Expected the value to satisfy a union of `literal | literal`, but received: \"baz\"
- * ```
- *
- * This struct will return an error like:
- *
- * ```
- * Expected the value to satisfy a union of `"foo" | "bar"`, but received: \"baz\"
- * ```
- *
- * @param value - The literal value.
- * @returns The `superstruct` struct, which validates that the value is equal
- * to the literal value.
- */ export function literal(value) {
-    return define(JSON.stringify(value), superstructLiteral(value).validator);
-}
-/**
- * A wrapper of `superstruct`'s `union` struct that also defines the schema as
- * the union of the schemas of the structs.
- *
- * This is useful for improving the error messages returned by `superstruct`.
- *
- * @param structs - The structs to union.
- * @param structs."0" - The first struct.
- * @param structs."1" - The remaining structs.
- * @returns The `superstruct` struct, which validates that the value satisfies
- * one of the structs.
- */ export function union([head, ...tail]) {
-    const struct = superstructUnion([
-        head,
-        ...tail
-    ]);
-    return new Struct({
-        ...struct,
-        schema: [
-            head,
-            ...tail
-        ]
-    });
-}
 /**
  * A wrapper of `superstruct`'s `string` struct that coerces a value to a string
  * and resolves it relative to the current working directory. This is useful

package/dist/esm/structs.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/structs.ts"],"sourcesContent":["import { isObject } from '@metamask/utils';\nimport { bold, green, red } from 'chalk';\nimport { resolve } from 'path';\nimport type { Failure, Infer } from 'superstruct';\nimport {\n  Struct,\n  StructError,\n  define,\n  literal as superstructLiteral,\n  union as superstructUnion,\n  create,\n  string,\n  coerce,\n} from 'superstruct';\nimport type { AnyStruct, InferStructTuple } from 'superstruct/dist/utils';\n\nimport { indent } from './strings';\n\n/**\n * Infer a struct type, only if it matches the specified type. This is useful\n * for defining types and structs that are related to each other in separate\n * files.\n *\n * @example\n * ```typescript\n * // In file A\n * export type GetFileArgs = {\n *   path: string;\n *   encoding?: EnumToUnion<AuxiliaryFileEncoding>;\n * };\n *\n * // In file B\n * export const GetFileArgsStruct = object(...);\n *\n * // If the type and struct are in the same file, this will return the type.\n * // Otherwise, it will return `never`.\n * export type GetFileArgs =\n *   InferMatching<typeof GetFileArgsStruct, GetFileArgs>;\n * ```\n */\nexport type InferMatching<\n  StructType extends Struct<any, any>,\n  Type,\n> = StructType['TYPE'] extends Type ? Type : never;\n\n/**\n * A wrapper of `superstruct`'s `literal` struct that also defines the name of\n * the struct as the literal value.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n * For example, instead of returning an error like:\n *\n * ```\n * Expected the value to satisfy a union of `literal | literal`, but received: \\\"baz\\\"\n * ```\n *\n * This struct will return an error like:\n *\n * ```\n * Expected the value to satisfy a union of `\"foo\" | \"bar\"`, but received: \\\"baz\\\"\n * ```\n *\n * @param value - The literal value.\n * @returns The `superstruct` struct, which validates that the value is equal\n * to the literal value.\n */\nexport function literal<Type extends string | number | boolean>(value: Type) {\n  return define<Type>(\n    JSON.stringify(value),\n    superstructLiteral(value).validator,\n  );\n}\n\n/**\n * A wrapper of `superstruct`'s `union` struct that also defines the schema as\n * the union of the schemas of the structs.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n *\n * @param structs - The structs to union.\n * @param structs.\"0\" - The first struct.\n * @param structs.\"1\" - The remaining structs.\n * @returns The `superstruct` struct, which validates that the value satisfies\n * one of the structs.\n */\nexport function union<Head extends AnyStruct, Tail extends AnyStruct[]>([\n  head,\n  ...tail\n]: [head: Head, ...tail: Tail]): Struct<\n  Infer<Head> | InferStructTuple<Tail>[number],\n  [head: Head, ...tail: Tail]\n> {\n  const struct = superstructUnion([head, ...tail]);\n\n  return new Struct({\n    ...struct,\n    schema: [head, ...tail],\n  });\n}\n\n/**\n * A wrapper of `superstruct`'s `string` struct that coerces a value to a string\n * and resolves it relative to the current working directory. This is useful\n * for specifying file paths in a configuration file, as it allows the user to\n * use both relative and absolute paths.\n *\n * @returns The `superstruct` struct, which validates that the value is a\n * string, and resolves it relative to the current working directory.\n * @example\n * ```ts\n * const config = struct({\n *   file: file(),\n *   // ...\n * });\n *\n * const value = create({ file: 'path/to/file' }, config);\n * console.log(value.file); // /process/cwd/path/to/file\n * ```\n */\nexport function file() {\n  return coerce(string(), string(), (value) => {\n    return resolve(process.cwd(), value);\n  });\n}\n\n/**\n * Define a struct, and also define the name of the struct as the given name.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n *\n * @param name - The name of the struct.\n * @param struct - The struct.\n * @returns The struct.\n */\nexport function named<Type, Schema>(\n  name: string,\n  struct: Struct<Type, Schema>,\n) {\n  return new Struct({\n    ...struct,\n    type: name,\n  });\n}\n\nexport class SnapsStructError<Type, Schema> extends StructError {\n  constructor(\n    struct: Struct<Type, Schema>,\n    prefix: string,\n    suffix: string,\n    failure: StructError,\n    failures: () => Generator<Failure>,\n  ) {\n    super(failure, failures);\n\n    this.name = 'SnapsStructError';\n    this.message = `${prefix}.\\n\\n${getStructErrorMessage(struct, [\n      ...failures(),\n    ])}${suffix ? `\\n\\n${suffix}` : ''}`;\n  }\n}\n\ntype GetErrorOptions<Type, Schema> = {\n  struct: Struct<Type, Schema>;\n  prefix: string;\n  suffix?: string;\n  error: StructError;\n};\n\n/**\n * Converts an array to a generator function that yields the items in the\n * array.\n *\n * @param array - The array.\n * @returns A generator function.\n * @yields The items in the array.\n */\nexport function* arrayToGenerator<Type>(\n  array: Type[],\n): Generator<Type, void, undefined> {\n  for (const item of array) {\n    yield item;\n  }\n}\n\n/**\n * Returns a `SnapsStructError` with the given prefix and suffix.\n *\n * @param options - The options.\n * @param options.struct - The struct that caused the error.\n * @param options.prefix - The prefix to add to the error message.\n * @param options.suffix - The suffix to add to the error message. Defaults to\n * an empty string.\n * @param options.error - The `superstruct` error to wrap.\n * @returns The `SnapsStructError`.\n */\nexport function getError<Type, Schema>({\n  struct,\n  prefix,\n  suffix = '',\n  error,\n}: GetErrorOptions<Type, Schema>) {\n  return new SnapsStructError(struct, prefix, suffix, error, () =>\n    arrayToGenerator(error.failures()),\n  );\n}\n\n/**\n * A wrapper of `superstruct`'s `create` function that throws a\n * `SnapsStructError` instead of a `StructError`. This is useful for improving\n * the error messages returned by `superstruct`.\n *\n * @param value - The value to validate.\n * @param struct - The `superstruct` struct to validate the value against.\n * @param prefix - The prefix to add to the error message.\n * @param suffix - The suffix to add to the error message. Defaults to an empty\n * string.\n * @returns The validated value.\n */\nexport function createFromStruct<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  prefix: string,\n  suffix = '',\n) {\n  try {\n    return create(value, struct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw getError({ struct, prefix, suffix, error });\n    }\n\n    throw error;\n  }\n}\n\n/**\n * Get a struct from a failure path.\n *\n * @param struct - The struct.\n * @param path - The failure path.\n * @returns The struct at the failure path.\n */\nexport function getStructFromPath<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  path: string[],\n) {\n  return path.reduce<AnyStruct>((result, key) => {\n    if (isObject(struct.schema) && struct.schema[key]) {\n      return struct.schema[key] as AnyStruct;\n    }\n\n    return result;\n  }, struct);\n}\n\n/**\n * Get the union struct names from a struct.\n *\n * @param struct - The struct.\n * @returns The union struct names, or `null` if the struct is not a union\n * struct.\n */\nexport function getUnionStructNames<Type, Schema>(\n  struct: Struct<Type, Schema>,\n) {\n  if (Array.isArray(struct.schema)) {\n    return struct.schema.map(({ type }) => green(type));\n  }\n\n  return null;\n}\n\n/**\n * Get a error prefix from a `superstruct` failure. This is useful for\n * formatting the error message returned by `superstruct`.\n *\n * @param failure - The `superstruct` failure.\n * @returns The error prefix.\n */\nexport function getStructErrorPrefix(failure: Failure) {\n  if (failure.type === 'never' || failure.path.length === 0) {\n    return '';\n  }\n\n  return `At path: ${bold(failure.path.join('.'))} — `;\n}\n\n/**\n * Get a string describing the failure. This is similar to the `message`\n * property of `superstruct`'s `Failure` type, but formats the value in a more\n * readable way.\n *\n * @param struct - The struct that caused the failure.\n * @param failure - The `superstruct` failure.\n * @returns A string describing the failure.\n */\nexport function getStructFailureMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failure: Failure,\n) {\n  const received = red(JSON.stringify(failure.value));\n  const prefix = getStructErrorPrefix(failure);\n\n  if (failure.type === 'union') {\n    const childStruct = getStructFromPath(struct, failure.path);\n    const unionNames = getUnionStructNames(childStruct);\n\n    if (unionNames) {\n      return `${prefix}Expected the value to be one of: ${unionNames.join(\n        ', ',\n      )}, but received: ${received}.`;\n    }\n\n    return `${prefix}${failure.message}.`;\n  }\n\n  if (failure.type === 'literal') {\n    // Superstruct's failure does not provide information about which literal\n    // value was expected, so we need to parse the message to get the literal.\n    const message = failure.message\n      .replace(/the literal `(.+)`,/u, `the value to be \\`${green('$1')}\\`,`)\n      .replace(/, but received: (.+)/u, `, but received: ${red('$1')}`);\n\n    return `${prefix}${message}.`;\n  }\n\n  if (failure.type === 'never') {\n    return `Unknown key: ${bold(\n      failure.path.join('.'),\n    )}, received: ${received}.`;\n  }\n\n  return `${prefix}Expected a value of type ${green(\n    failure.type,\n  )}, but received: ${received}.`;\n}\n\n/**\n * Get a string describing the errors. This formats all the errors in a\n * human-readable way.\n *\n * @param struct - The struct that caused the failures.\n * @param failures - The `superstruct` failures.\n * @returns A string describing the errors.\n */\nexport function getStructErrorMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failures: Failure[],\n) {\n  const formattedFailures = failures.map((failure) =>\n    indent(`• ${getStructFailureMessage(struct, failure)}`),\n  );\n\n  return formattedFailures.join('\\n');\n}\n"],"names":["isObject","bold","green","red","resolve","Struct","StructError","define","literal","superstructLiteral","union","superstructUnion","create","string","coerce","indent","value","JSON","stringify","validator","head","tail","struct","schema","file","process","cwd","named","name","type","SnapsStructError","constructor","prefix","suffix","failure","failures","message","getStructErrorMessage","arrayToGenerator","array","item","getError","error","createFromStruct","getStructFromPath","path","reduce","result","key","getUnionStructNames","Array","isArray","map","getStructErrorPrefix","length","join","getStructFailureMessage","received","childStruct","unionNames","replace","formattedFailures"],"mappings":"AAAA,SAASA,QAAQ,QAAQ,kBAAkB;AAC3C,SAASC,IAAI,EAAEC,KAAK,EAAEC,GAAG,QAAQ,QAAQ;AACzC,SAASC,OAAO,QAAQ,OAAO;AAE/B,SACEC,MAAM,EACNC,WAAW,EACXC,MAAM,EACNC,WAAWC,kBAAkB,EAC7BC,SAASC,gBAAgB,EACzBC,MAAM,EACNC,MAAM,EACNC,MAAM,QACD,cAAc;AAGrB,SAASC,MAAM,QAAQ,YAAY;AA6BnC;;;;;;;;;;;;;;;;;;;;CAoBC,GACD,OAAO,SAASP,QAAgDQ,KAAW;IACzE,OAAOT,OACLU,KAAKC,SAAS,CAACF,QACfP,mBAAmBO,OAAOG,SAAS;AAEvC;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAAST,MAAwD,CACtEU,MACA,GAAGC,KACyB;IAI5B,MAAMC,SAASX,iBAAiB;QAACS;WAASC;KAAK;IAE/C,OAAO,IAAIhB,OAAO;QAChB,GAAGiB,MAAM;QACTC,QAAQ;YAACH;eAASC;SAAK;IACzB;AACF;AAEA;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASG;IACd,OAAOV,OAAOD,UAAUA,UAAU,CAACG;QACjC,OAAOZ,QAAQqB,QAAQC,GAAG,IAAIV;IAChC;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASW,MACdC,IAAY,EACZN,MAA4B;IAE5B,OAAO,IAAIjB,OAAO;QAChB,GAAGiB,MAAM;QACTO,MAAMD;IACR;AACF;AAEA,OAAO,MAAME,yBAAuCxB;IAClDyB,YACET,MAA4B,EAC5BU,MAAc,EACdC,MAAc,EACdC,OAAoB,EACpBC,QAAkC,CAClC;QACA,KAAK,CAACD,SAASC;QAEf,IAAI,CAACP,IAAI,GAAG;QACZ,IAAI,CAACQ,OAAO,GAAG,CAAC,EAAEJ,OAAO,KAAK,EAAEK,sBAAsBf,QAAQ;eACzDa;SACJ,EAAE,EAAEF,SAAS,CAAC,IAAI,EAAEA,OAAO,CAAC,GAAG,GAAG,CAAC;IACtC;AACF;AASA;;;;;;;CAOC,GACD,OAAO,UAAUK,iBACfC,KAAa;IAEb,KAAK,MAAMC,QAAQD,MAAO;QACxB,MAAMC;IACR;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,SAAuB,EACrCnB,MAAM,EACNU,MAAM,EACNC,SAAS,EAAE,EACXS,KAAK,EACyB;IAC9B,OAAO,IAAIZ,iBAAiBR,QAAQU,QAAQC,QAAQS,OAAO,IACzDJ,iBAAiBI,MAAMP,QAAQ;AAEnC;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASQ,iBACd3B,KAAc,EACdM,MAA4B,EAC5BU,MAAc,EACdC,SAAS,EAAE;IAEX,IAAI;QACF,OAAOrB,OAAOI,OAAOM;IACvB,EAAE,OAAOoB,OAAO;QACd,IAAIA,iBAAiBpC,aAAa;YAChC,MAAMmC,SAAS;gBAAEnB;gBAAQU;gBAAQC;gBAAQS;YAAM;QACjD;QAEA,MAAMA;IACR;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,kBACdtB,MAA4B,EAC5BuB,IAAc;IAEd,OAAOA,KAAKC,MAAM,CAAY,CAACC,QAAQC;QACrC,IAAIhD,SAASsB,OAAOC,MAAM,KAAKD,OAAOC,MAAM,CAACyB,IAAI,EAAE;YACjD,OAAO1B,OAAOC,MAAM,CAACyB,IAAI;QAC3B;QAEA,OAAOD;IACT,GAAGzB;AACL;AAEA;;;;;;CAMC,GACD,OAAO,SAAS2B,oBACd3B,MAA4B;IAE5B,IAAI4B,MAAMC,OAAO,CAAC7B,OAAOC,MAAM,GAAG;QAChC,OAAOD,OAAOC,MAAM,CAAC6B,GAAG,CAAC,CAAC,EAAEvB,IAAI,EAAE,GAAK3B,MAAM2B;IAC/C;IAEA,OAAO;AACT;AAEA;;;;;;CAMC,GACD,OAAO,SAASwB,qBAAqBnB,OAAgB;IACnD,IAAIA,QAAQL,IAAI,KAAK,WAAWK,QAAQW,IAAI,CAACS,MAAM,KAAK,GAAG;QACzD,OAAO;IACT;IAEA,OAAO,CAAC,SAAS,EAAErD,KAAKiC,QAAQW,IAAI,CAACU,IAAI,CAAC,MAAM,GAAG,CAAC;AACtD;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASC,wBACdlC,MAA4B,EAC5BY,OAAgB;IAEhB,MAAMuB,WAAWtD,IAAIc,KAAKC,SAAS,CAACgB,QAAQlB,KAAK;IACjD,MAAMgB,SAASqB,qBAAqBnB;IAEpC,IAAIA,QAAQL,IAAI,KAAK,SAAS;QAC5B,MAAM6B,cAAcd,kBAAkBtB,QAAQY,QAAQW,IAAI;QAC1D,MAAMc,aAAaV,oBAAoBS;QAEvC,IAAIC,YAAY;YACd,OAAO,CAAC,EAAE3B,OAAO,iCAAiC,EAAE2B,WAAWJ,IAAI,CACjE,MACA,gBAAgB,EAAEE,SAAS,CAAC,CAAC;QACjC;QAEA,OAAO,CAAC,EAAEzB,OAAO,EAAEE,QAAQE,OAAO,CAAC,CAAC,CAAC;IACvC;IAEA,IAAIF,QAAQL,IAAI,KAAK,WAAW;QAC9B,yEAAyE;QACzE,0EAA0E;QAC1E,MAAMO,UAAUF,QAAQE,OAAO,CAC5BwB,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,EAAE1D,MAAM,MAAM,GAAG,CAAC,EACrE0D,OAAO,CAAC,yBAAyB,CAAC,gBAAgB,EAAEzD,IAAI,MAAM,CAAC;QAElE,OAAO,CAAC,EAAE6B,OAAO,EAAEI,QAAQ,CAAC,CAAC;IAC/B;IAEA,IAAIF,QAAQL,IAAI,KAAK,SAAS;QAC5B,OAAO,CAAC,aAAa,EAAE5B,KACrBiC,QAAQW,IAAI,CAACU,IAAI,CAAC,MAClB,YAAY,EAAEE,SAAS,CAAC,CAAC;IAC7B;IAEA,OAAO,CAAC,EAAEzB,OAAO,yBAAyB,EAAE9B,MAC1CgC,QAAQL,IAAI,EACZ,gBAAgB,EAAE4B,SAAS,CAAC,CAAC;AACjC;AAEA;;;;;;;CAOC,GACD,OAAO,SAASpB,sBACdf,MAA4B,EAC5Ba,QAAmB;IAEnB,MAAM0B,oBAAoB1B,SAASiB,GAAG,CAAC,CAAClB,UACtCnB,OAAO,CAAC,EAAE,EAAEyC,wBAAwBlC,QAAQY,SAAS,CAAC;IAGxD,OAAO2B,kBAAkBN,IAAI,CAAC;AAChC"}
+{"version":3,"sources":["../../src/structs.ts"],"sourcesContent":["import { isObject } from '@metamask/utils';\nimport { bold, green, red } from 'chalk';\nimport { resolve } from 'path';\nimport type { Failure } from 'superstruct';\nimport { Struct, StructError, create, string, coerce } from 'superstruct';\nimport type { AnyStruct } from 'superstruct/dist/utils';\n\nimport { indent } from './strings';\n\n/**\n * Infer a struct type, only if it matches the specified type. This is useful\n * for defining types and structs that are related to each other in separate\n * files.\n *\n * @example\n * ```typescript\n * // In file A\n * export type GetFileArgs = {\n *   path: string;\n *   encoding?: EnumToUnion<AuxiliaryFileEncoding>;\n * };\n *\n * // In file B\n * export const GetFileArgsStruct = object(...);\n *\n * // If the type and struct are in the same file, this will return the type.\n * // Otherwise, it will return `never`.\n * export type GetFileArgs =\n *   InferMatching<typeof GetFileArgsStruct, GetFileArgs>;\n * ```\n */\nexport type InferMatching<\n  StructType extends Struct<any, any>,\n  Type,\n> = StructType['TYPE'] extends Type ? Type : never;\n\n/**\n * A wrapper of `superstruct`'s `string` struct that coerces a value to a string\n * and resolves it relative to the current working directory. This is useful\n * for specifying file paths in a configuration file, as it allows the user to\n * use both relative and absolute paths.\n *\n * @returns The `superstruct` struct, which validates that the value is a\n * string, and resolves it relative to the current working directory.\n * @example\n * ```ts\n * const config = struct({\n *   file: file(),\n *   // ...\n * });\n *\n * const value = create({ file: 'path/to/file' }, config);\n * console.log(value.file); // /process/cwd/path/to/file\n * ```\n */\nexport function file() {\n  return coerce(string(), string(), (value) => {\n    return resolve(process.cwd(), value);\n  });\n}\n\n/**\n * Define a struct, and also define the name of the struct as the given name.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n *\n * @param name - The name of the struct.\n * @param struct - The struct.\n * @returns The struct.\n */\nexport function named<Type, Schema>(\n  name: string,\n  struct: Struct<Type, Schema>,\n) {\n  return new Struct({\n    ...struct,\n    type: name,\n  });\n}\n\nexport class SnapsStructError<Type, Schema> extends StructError {\n  constructor(\n    struct: Struct<Type, Schema>,\n    prefix: string,\n    suffix: string,\n    failure: StructError,\n    failures: () => Generator<Failure>,\n  ) {\n    super(failure, failures);\n\n    this.name = 'SnapsStructError';\n    this.message = `${prefix}.\\n\\n${getStructErrorMessage(struct, [\n      ...failures(),\n    ])}${suffix ? `\\n\\n${suffix}` : ''}`;\n  }\n}\n\ntype GetErrorOptions<Type, Schema> = {\n  struct: Struct<Type, Schema>;\n  prefix: string;\n  suffix?: string;\n  error: StructError;\n};\n\n/**\n * Converts an array to a generator function that yields the items in the\n * array.\n *\n * @param array - The array.\n * @returns A generator function.\n * @yields The items in the array.\n */\nexport function* arrayToGenerator<Type>(\n  array: Type[],\n): Generator<Type, void, undefined> {\n  for (const item of array) {\n    yield item;\n  }\n}\n\n/**\n * Returns a `SnapsStructError` with the given prefix and suffix.\n *\n * @param options - The options.\n * @param options.struct - The struct that caused the error.\n * @param options.prefix - The prefix to add to the error message.\n * @param options.suffix - The suffix to add to the error message. Defaults to\n * an empty string.\n * @param options.error - The `superstruct` error to wrap.\n * @returns The `SnapsStructError`.\n */\nexport function getError<Type, Schema>({\n  struct,\n  prefix,\n  suffix = '',\n  error,\n}: GetErrorOptions<Type, Schema>) {\n  return new SnapsStructError(struct, prefix, suffix, error, () =>\n    arrayToGenerator(error.failures()),\n  );\n}\n\n/**\n * A wrapper of `superstruct`'s `create` function that throws a\n * `SnapsStructError` instead of a `StructError`. This is useful for improving\n * the error messages returned by `superstruct`.\n *\n * @param value - The value to validate.\n * @param struct - The `superstruct` struct to validate the value against.\n * @param prefix - The prefix to add to the error message.\n * @param suffix - The suffix to add to the error message. Defaults to an empty\n * string.\n * @returns The validated value.\n */\nexport function createFromStruct<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  prefix: string,\n  suffix = '',\n) {\n  try {\n    return create(value, struct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw getError({ struct, prefix, suffix, error });\n    }\n\n    throw error;\n  }\n}\n\n/**\n * Get a struct from a failure path.\n *\n * @param struct - The struct.\n * @param path - The failure path.\n * @returns The struct at the failure path.\n */\nexport function getStructFromPath<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  path: string[],\n) {\n  return path.reduce<AnyStruct>((result, key) => {\n    if (isObject(struct.schema) && struct.schema[key]) {\n      return struct.schema[key] as AnyStruct;\n    }\n\n    return result;\n  }, struct);\n}\n\n/**\n * Get the union struct names from a struct.\n *\n * @param struct - The struct.\n * @returns The union struct names, or `null` if the struct is not a union\n * struct.\n */\nexport function getUnionStructNames<Type, Schema>(\n  struct: Struct<Type, Schema>,\n) {\n  if (Array.isArray(struct.schema)) {\n    return struct.schema.map(({ type }) => green(type));\n  }\n\n  return null;\n}\n\n/**\n * Get a error prefix from a `superstruct` failure. This is useful for\n * formatting the error message returned by `superstruct`.\n *\n * @param failure - The `superstruct` failure.\n * @returns The error prefix.\n */\nexport function getStructErrorPrefix(failure: Failure) {\n  if (failure.type === 'never' || failure.path.length === 0) {\n    return '';\n  }\n\n  return `At path: ${bold(failure.path.join('.'))} — `;\n}\n\n/**\n * Get a string describing the failure. This is similar to the `message`\n * property of `superstruct`'s `Failure` type, but formats the value in a more\n * readable way.\n *\n * @param struct - The struct that caused the failure.\n * @param failure - The `superstruct` failure.\n * @returns A string describing the failure.\n */\nexport function getStructFailureMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failure: Failure,\n) {\n  const received = red(JSON.stringify(failure.value));\n  const prefix = getStructErrorPrefix(failure);\n\n  if (failure.type === 'union') {\n    const childStruct = getStructFromPath(struct, failure.path);\n    const unionNames = getUnionStructNames(childStruct);\n\n    if (unionNames) {\n      return `${prefix}Expected the value to be one of: ${unionNames.join(\n        ', ',\n      )}, but received: ${received}.`;\n    }\n\n    return `${prefix}${failure.message}.`;\n  }\n\n  if (failure.type === 'literal') {\n    // Superstruct's failure does not provide information about which literal\n    // value was expected, so we need to parse the message to get the literal.\n    const message = failure.message\n      .replace(/the literal `(.+)`,/u, `the value to be \\`${green('$1')}\\`,`)\n      .replace(/, but received: (.+)/u, `, but received: ${red('$1')}`);\n\n    return `${prefix}${message}.`;\n  }\n\n  if (failure.type === 'never') {\n    return `Unknown key: ${bold(\n      failure.path.join('.'),\n    )}, received: ${received}.`;\n  }\n\n  return `${prefix}Expected a value of type ${green(\n    failure.type,\n  )}, but received: ${received}.`;\n}\n\n/**\n * Get a string describing the errors. This formats all the errors in a\n * human-readable way.\n *\n * @param struct - The struct that caused the failures.\n * @param failures - The `superstruct` failures.\n * @returns A string describing the errors.\n */\nexport function getStructErrorMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failures: Failure[],\n) {\n  const formattedFailures = failures.map((failure) =>\n    indent(`• ${getStructFailureMessage(struct, failure)}`),\n  );\n\n  return formattedFailures.join('\\n');\n}\n"],"names":["isObject","bold","green","red","resolve","Struct","StructError","create","string","coerce","indent","file","value","process","cwd","named","name","struct","type","SnapsStructError","constructor","prefix","suffix","failure","failures","message","getStructErrorMessage","arrayToGenerator","array","item","getError","error","createFromStruct","getStructFromPath","path","reduce","result","key","schema","getUnionStructNames","Array","isArray","map","getStructErrorPrefix","length","join","getStructFailureMessage","received","JSON","stringify","childStruct","unionNames","replace","formattedFailures"],"mappings":"AAAA,SAASA,QAAQ,QAAQ,kBAAkB;AAC3C,SAASC,IAAI,EAAEC,KAAK,EAAEC,GAAG,QAAQ,QAAQ;AACzC,SAASC,OAAO,QAAQ,OAAO;AAE/B,SAASC,MAAM,EAAEC,WAAW,EAAEC,MAAM,EAAEC,MAAM,EAAEC,MAAM,QAAQ,cAAc;AAG1E,SAASC,MAAM,QAAQ,YAAY;AA6BnC;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASC;IACd,OAAOF,OAAOD,UAAUA,UAAU,CAACI;QACjC,OAAOR,QAAQS,QAAQC,GAAG,IAAIF;IAChC;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASG,MACdC,IAAY,EACZC,MAA4B;IAE5B,OAAO,IAAIZ,OAAO;QAChB,GAAGY,MAAM;QACTC,MAAMF;IACR;AACF;AAEA,OAAO,MAAMG,yBAAuCb;IAClDc,YACEH,MAA4B,EAC5BI,MAAc,EACdC,MAAc,EACdC,OAAoB,EACpBC,QAAkC,CAClC;QACA,KAAK,CAACD,SAASC;QAEf,IAAI,CAACR,IAAI,GAAG;QACZ,IAAI,CAACS,OAAO,GAAG,CAAC,EAAEJ,OAAO,KAAK,EAAEK,sBAAsBT,QAAQ;eACzDO;SACJ,EAAE,EAAEF,SAAS,CAAC,IAAI,EAAEA,OAAO,CAAC,GAAG,GAAG,CAAC;IACtC;AACF;AASA;;;;;;;CAOC,GACD,OAAO,UAAUK,iBACfC,KAAa;IAEb,KAAK,MAAMC,QAAQD,MAAO;QACxB,MAAMC;IACR;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,SAAuB,EACrCb,MAAM,EACNI,MAAM,EACNC,SAAS,EAAE,EACXS,KAAK,EACyB;IAC9B,OAAO,IAAIZ,iBAAiBF,QAAQI,QAAQC,QAAQS,OAAO,IACzDJ,iBAAiBI,MAAMP,QAAQ;AAEnC;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASQ,iBACdpB,KAAc,EACdK,MAA4B,EAC5BI,MAAc,EACdC,SAAS,EAAE;IAEX,IAAI;QACF,OAAOf,OAAOK,OAAOK;IACvB,EAAE,OAAOc,OAAO;QACd,IAAIA,iBAAiBzB,aAAa;YAChC,MAAMwB,SAAS;gBAAEb;gBAAQI;gBAAQC;gBAAQS;YAAM;QACjD;QAEA,MAAMA;IACR;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,kBACdhB,MAA4B,EAC5BiB,IAAc;IAEd,OAAOA,KAAKC,MAAM,CAAY,CAACC,QAAQC;QACrC,IAAIrC,SAASiB,OAAOqB,MAAM,KAAKrB,OAAOqB,MAAM,CAACD,IAAI,EAAE;YACjD,OAAOpB,OAAOqB,MAAM,CAACD,IAAI;QAC3B;QAEA,OAAOD;IACT,GAAGnB;AACL;AAEA;;;;;;CAMC,GACD,OAAO,SAASsB,oBACdtB,MAA4B;IAE5B,IAAIuB,MAAMC,OAAO,CAACxB,OAAOqB,MAAM,GAAG;QAChC,OAAOrB,OAAOqB,MAAM,CAACI,GAAG,CAAC,CAAC,EAAExB,IAAI,EAAE,GAAKhB,MAAMgB;IAC/C;IAEA,OAAO;AACT;AAEA;;;;;;CAMC,GACD,OAAO,SAASyB,qBAAqBpB,OAAgB;IACnD,IAAIA,QAAQL,IAAI,KAAK,WAAWK,QAAQW,IAAI,CAACU,MAAM,KAAK,GAAG;QACzD,OAAO;IACT;IAEA,OAAO,CAAC,SAAS,EAAE3C,KAAKsB,QAAQW,IAAI,CAACW,IAAI,CAAC,MAAM,GAAG,CAAC;AACtD;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASC,wBACd7B,MAA4B,EAC5BM,OAAgB;IAEhB,MAAMwB,WAAW5C,IAAI6C,KAAKC,SAAS,CAAC1B,QAAQX,KAAK;IACjD,MAAMS,SAASsB,qBAAqBpB;IAEpC,IAAIA,QAAQL,IAAI,KAAK,SAAS;QAC5B,MAAMgC,cAAcjB,kBAAkBhB,QAAQM,QAAQW,IAAI;QAC1D,MAAMiB,aAAaZ,oBAAoBW;QAEvC,IAAIC,YAAY;YACd,OAAO,CAAC,EAAE9B,OAAO,iCAAiC,EAAE8B,WAAWN,IAAI,CACjE,MACA,gBAAgB,EAAEE,SAAS,CAAC,CAAC;QACjC;QAEA,OAAO,CAAC,EAAE1B,OAAO,EAAEE,QAAQE,OAAO,CAAC,CAAC,CAAC;IACvC;IAEA,IAAIF,QAAQL,IAAI,KAAK,WAAW;QAC9B,yEAAyE;QACzE,0EAA0E;QAC1E,MAAMO,UAAUF,QAAQE,OAAO,CAC5B2B,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,EAAElD,MAAM,MAAM,GAAG,CAAC,EACrEkD,OAAO,CAAC,yBAAyB,CAAC,gBAAgB,EAAEjD,IAAI,MAAM,CAAC;QAElE,OAAO,CAAC,EAAEkB,OAAO,EAAEI,QAAQ,CAAC,CAAC;IAC/B;IAEA,IAAIF,QAAQL,IAAI,KAAK,SAAS;QAC5B,OAAO,CAAC,aAAa,EAAEjB,KACrBsB,QAAQW,IAAI,CAACW,IAAI,CAAC,MAClB,YAAY,EAAEE,SAAS,CAAC,CAAC;IAC7B;IAEA,OAAO,CAAC,EAAE1B,OAAO,yBAAyB,EAAEnB,MAC1CqB,QAAQL,IAAI,EACZ,gBAAgB,EAAE6B,SAAS,CAAC,CAAC;AACjC;AAEA;;;;;;;CAOC,GACD,OAAO,SAASrB,sBACdT,MAA4B,EAC5BO,QAAmB;IAEnB,MAAM6B,oBAAoB7B,SAASkB,GAAG,CAAC,CAACnB,UACtCb,OAAO,CAAC,EAAE,EAAEoC,wBAAwB7B,QAAQM,SAAS,CAAC;IAGxD,OAAO8B,kBAAkBR,IAAI,CAAC;AAChC"}

package/dist/esm/ui.js

@@ -1,30 +1,32 @@
 import { NodeType } from '@metamask/snaps-sdk';
-import { assert, AssertionError, hasProperty } from '@metamask/utils';
-const LINK_REGEX = RegExp("(?<protocol>[a-z]+:\\/?\\/?)(?<host>\\S+?(?:\\.[a-z]+)+)", "giu");
+import { assert, AssertionError } from '@metamask/utils';
+const MARKDOWN_LINK_REGEX = RegExp("\\[(?<name>[^\\]]*)\\]\\((?<url>[^)]+)\\)", "giu");
 const ALLOWED_PROTOCOLS = [
     'https:',
     'mailto:'
 ];
 /**
- * Search for links in a sting and check them against the phishing list.
+ * Searches for markdown links in a string and checks them against the phishing list.
  *
  * @param text - The text to verify.
  * @param isOnPhishingList - The function that checks the link against the
  * phishing list.
  * @throws If the text contains a link that is not allowed.
  */ export function validateTextLinks(text, isOnPhishingList) {
-    const links = text.match(LINK_REGEX);
-    if (links) {
-        links.forEach((link)=>{
-            try {
-                const url = new URL(link);
-                assert(ALLOWED_PROTOCOLS.includes(url.protocol), `Protocol must be one of: ${ALLOWED_PROTOCOLS.join(', ')}.`);
-                const hostname = url.protocol === 'mailto:' ? url.pathname.split('@')[1] : url.hostname;
-                assert(!isOnPhishingList(hostname), 'The specified URL is not allowed.');
-            } catch (error) {
-                throw new Error(`Invalid URL: ${error instanceof AssertionError ? error.message : 'Unable to parse URL.'}`);
-            }
-        });
+    const matches = String.prototype.matchAll.call(text, MARKDOWN_LINK_REGEX);
+    for (const { groups } of matches){
+        const link = groups?.url;
+        /* This case should never happen with the regex but the TS type allows for undefined */ /* istanbul ignore next */ if (!link) {
+            continue;
+        }
+        try {
+            const url = new URL(link);
+            assert(ALLOWED_PROTOCOLS.includes(url.protocol), `Protocol must be one of: ${ALLOWED_PROTOCOLS.join(', ')}.`);
+            const hostname = url.protocol === 'mailto:' ? url.pathname.split('@')[1] : url.hostname;
+            assert(!isOnPhishingList(hostname), 'The specified URL is not allowed.');
+        } catch (error) {
+            throw new Error(`Invalid URL: ${error instanceof AssertionError ? error.message : 'Unable to parse URL.'}`);
+        }
     }
 }
 /**
@@ -40,7 +42,7 @@ const ALLOWED_PROTOCOLS = [
     if (type === NodeType.Panel) {
         component.children.forEach((node)=>validateComponentLinks(node, isOnPhishingList));
     }
-    if (hasProperty(component, 'value') && typeof component.value === 'string') {
+    if (type === NodeType.Text) {
         validateTextLinks(component.value, isOnPhishingList);
     }
 }

package/dist/esm/ui.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/ui.ts"],"sourcesContent":["import type { Component } from '@metamask/snaps-sdk';\nimport { NodeType } from '@metamask/snaps-sdk';\nimport { assert, AssertionError, hasProperty } from '@metamask/utils';\n\nconst LINK_REGEX = /(?<protocol>[a-z]+:\\/?\\/?)(?<host>\\S+?(?:\\.[a-z]+)+)/giu;\nconst ALLOWED_PROTOCOLS = ['https:', 'mailto:'];\n\n/**\n * Search for links in a sting and check them against the phishing list.\n *\n * @param text - The text to verify.\n * @param isOnPhishingList - The function that checks the link against the\n * phishing list.\n * @throws If the text contains a link that is not allowed.\n */\nexport function validateTextLinks(\n  text: string,\n  isOnPhishingList: (url: string) => boolean,\n) {\n  const links = text.match(LINK_REGEX);\n  if (links) {\n    links.forEach((link) => {\n      try {\n        const url = new URL(link);\n        assert(\n          ALLOWED_PROTOCOLS.includes(url.protocol),\n          `Protocol must be one of: ${ALLOWED_PROTOCOLS.join(', ')}.`,\n        );\n\n        const hostname =\n          url.protocol === 'mailto:'\n            ? url.pathname.split('@')[1]\n            : url.hostname;\n\n        assert(\n          !isOnPhishingList(hostname),\n          'The specified URL is not allowed.',\n        );\n      } catch (error) {\n        throw new Error(\n          `Invalid URL: ${\n            error instanceof AssertionError\n              ? error.message\n              : 'Unable to parse URL.'\n          }`,\n        );\n      }\n    });\n  }\n}\n\n/**\n * Search for links in UI components and check that the URL they are trying to\n * pass in is not in the phishing list.\n *\n * @param component - The custom UI component.\n * @param isOnPhishingList - The function that checks the link against the\n * phishing list.\n * @throws If the component contains a link that is not allowed.\n */\nexport function validateComponentLinks(\n  component: Component,\n  isOnPhishingList: (url: string) => boolean,\n) {\n  const { type } = component;\n  if (type === NodeType.Panel) {\n    component.children.forEach((node) =>\n      validateComponentLinks(node, isOnPhishingList),\n    );\n  }\n\n  if (hasProperty(component, 'value') && typeof component.value === 'string') {\n    validateTextLinks(component.value, isOnPhishingList);\n  }\n}\n"],"names":["NodeType","assert","AssertionError","hasProperty","LINK_REGEX","ALLOWED_PROTOCOLS","validateTextLinks","text","isOnPhishingList","links","match","forEach","link","url","URL","includes","protocol","join","hostname","pathname","split","error","Error","message","validateComponentLinks","component","type","Panel","children","node","value"],"mappings":"AACA,SAASA,QAAQ,QAAQ,sBAAsB;AAC/C,SAASC,MAAM,EAAEC,cAAc,EAAEC,WAAW,QAAQ,kBAAkB;AAEtE,MAAMC,aAAa;AACnB,MAAMC,oBAAoB;IAAC;IAAU;CAAU;AAE/C;;;;;;;CAOC,GACD,OAAO,SAASC,kBACdC,IAAY,EACZC,gBAA0C;IAE1C,MAAMC,QAAQF,KAAKG,KAAK,CAACN;IACzB,IAAIK,OAAO;QACTA,MAAME,OAAO,CAAC,CAACC;YACb,IAAI;gBACF,MAAMC,MAAM,IAAIC,IAAIF;gBACpBX,OACEI,kBAAkBU,QAAQ,CAACF,IAAIG,QAAQ,GACvC,CAAC,yBAAyB,EAAEX,kBAAkBY,IAAI,CAAC,MAAM,CAAC,CAAC;gBAG7D,MAAMC,WACJL,IAAIG,QAAQ,KAAK,YACbH,IAAIM,QAAQ,CAACC,KAAK,CAAC,IAAI,CAAC,EAAE,GAC1BP,IAAIK,QAAQ;gBAElBjB,OACE,CAACO,iBAAiBU,WAClB;YAEJ,EAAE,OAAOG,OAAO;gBACd,MAAM,IAAIC,MACR,CAAC,aAAa,EACZD,iBAAiBnB,iBACbmB,MAAME,OAAO,GACb,uBACL,CAAC;YAEN;QACF;IACF;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASC,uBACdC,SAAoB,EACpBjB,gBAA0C;IAE1C,MAAM,EAAEkB,IAAI,EAAE,GAAGD;IACjB,IAAIC,SAAS1B,SAAS2B,KAAK,EAAE;QAC3BF,UAAUG,QAAQ,CAACjB,OAAO,CAAC,CAACkB,OAC1BL,uBAAuBK,MAAMrB;IAEjC;IAEA,IAAIL,YAAYsB,WAAW,YAAY,OAAOA,UAAUK,KAAK,KAAK,UAAU;QAC1ExB,kBAAkBmB,UAAUK,KAAK,EAAEtB;IACrC;AACF"}
+{"version":3,"sources":["../../src/ui.ts"],"sourcesContent":["import type { Component } from '@metamask/snaps-sdk';\nimport { NodeType } from '@metamask/snaps-sdk';\nimport { assert, AssertionError } from '@metamask/utils';\n\nconst MARKDOWN_LINK_REGEX = /\\[(?<name>[^\\]]*)\\]\\((?<url>[^)]+)\\)/giu;\n\nconst ALLOWED_PROTOCOLS = ['https:', 'mailto:'];\n\n/**\n * Searches for markdown links in a string and checks them against the phishing list.\n *\n * @param text - The text to verify.\n * @param isOnPhishingList - The function that checks the link against the\n * phishing list.\n * @throws If the text contains a link that is not allowed.\n */\nexport function validateTextLinks(\n  text: string,\n  isOnPhishingList: (url: string) => boolean,\n) {\n  const matches = String.prototype.matchAll.call(text, MARKDOWN_LINK_REGEX);\n\n  for (const { groups } of matches) {\n    const link = groups?.url;\n\n    /* This case should never happen with the regex but the TS type allows for undefined */\n    /* istanbul ignore next */\n    if (!link) {\n      continue;\n    }\n\n    try {\n      const url = new URL(link);\n      assert(\n        ALLOWED_PROTOCOLS.includes(url.protocol),\n        `Protocol must be one of: ${ALLOWED_PROTOCOLS.join(', ')}.`,\n      );\n\n      const hostname =\n        url.protocol === 'mailto:' ? url.pathname.split('@')[1] : url.hostname;\n\n      assert(!isOnPhishingList(hostname), 'The specified URL is not allowed.');\n    } catch (error) {\n      throw new Error(\n        `Invalid URL: ${\n          error instanceof AssertionError\n            ? error.message\n            : 'Unable to parse URL.'\n        }`,\n      );\n    }\n  }\n}\n\n/**\n * Search for links in UI components and check that the URL they are trying to\n * pass in is not in the phishing list.\n *\n * @param component - The custom UI component.\n * @param isOnPhishingList - The function that checks the link against the\n * phishing list.\n * @throws If the component contains a link that is not allowed.\n */\nexport function validateComponentLinks(\n  component: Component,\n  isOnPhishingList: (url: string) => boolean,\n) {\n  const { type } = component;\n  if (type === NodeType.Panel) {\n    component.children.forEach((node) =>\n      validateComponentLinks(node, isOnPhishingList),\n    );\n  }\n\n  if (type === NodeType.Text) {\n    validateTextLinks(component.value, isOnPhishingList);\n  }\n}\n"],"names":["NodeType","assert","AssertionError","MARKDOWN_LINK_REGEX","ALLOWED_PROTOCOLS","validateTextLinks","text","isOnPhishingList","matches","String","prototype","matchAll","call","groups","link","url","URL","includes","protocol","join","hostname","pathname","split","error","Error","message","validateComponentLinks","component","type","Panel","children","forEach","node","Text","value"],"mappings":"AACA,SAASA,QAAQ,QAAQ,sBAAsB;AAC/C,SAASC,MAAM,EAAEC,cAAc,QAAQ,kBAAkB;AAEzD,MAAMC,sBAAsB;AAE5B,MAAMC,oBAAoB;IAAC;IAAU;CAAU;AAE/C;;;;;;;CAOC,GACD,OAAO,SAASC,kBACdC,IAAY,EACZC,gBAA0C;IAE1C,MAAMC,UAAUC,OAAOC,SAAS,CAACC,QAAQ,CAACC,IAAI,CAACN,MAAMH;IAErD,KAAK,MAAM,EAAEU,MAAM,EAAE,IAAIL,QAAS;QAChC,MAAMM,OAAOD,QAAQE;QAErB,qFAAqF,GACrF,wBAAwB,GACxB,IAAI,CAACD,MAAM;YACT;QACF;QAEA,IAAI;YACF,MAAMC,MAAM,IAAIC,IAAIF;YACpBb,OACEG,kBAAkBa,QAAQ,CAACF,IAAIG,QAAQ,GACvC,CAAC,yBAAyB,EAAEd,kBAAkBe,IAAI,CAAC,MAAM,CAAC,CAAC;YAG7D,MAAMC,WACJL,IAAIG,QAAQ,KAAK,YAAYH,IAAIM,QAAQ,CAACC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAGP,IAAIK,QAAQ;YAExEnB,OAAO,CAACM,iBAAiBa,WAAW;QACtC,EAAE,OAAOG,OAAO;YACd,MAAM,IAAIC,MACR,CAAC,aAAa,EACZD,iBAAiBrB,iBACbqB,MAAME,OAAO,GACb,uBACL,CAAC;QAEN;IACF;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASC,uBACdC,SAAoB,EACpBpB,gBAA0C;IAE1C,MAAM,EAAEqB,IAAI,EAAE,GAAGD;IACjB,IAAIC,SAAS5B,SAAS6B,KAAK,EAAE;QAC3BF,UAAUG,QAAQ,CAACC,OAAO,CAAC,CAACC,OAC1BN,uBAAuBM,MAAMzB;IAEjC;IAEA,IAAIqB,SAAS5B,SAASiC,IAAI,EAAE;QAC1B5B,kBAAkBsB,UAAUO,KAAK,EAAE3B;IACrC;AACF"}

package/dist/types/cronjob.d.ts

@@ -1,14 +1,14 @@
 import type { Infer } from 'superstruct';
 export declare const CronjobRpcRequestStruct: import("superstruct").Struct<{
     method: string;
-    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
     id?: string | number | null | undefined;
     jsonrpc?: "2.0" | undefined;
+    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
 }, {
-    params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+    jsonrpc: import("superstruct").Struct<"2.0" | undefined, "2.0">;
+    id: import("superstruct").Struct<string | number | null | undefined, null>;
     method: import("superstruct").Struct<string, null>;
-    id: import("superstruct").Struct<string | number | null | undefined, unknown>;
-    jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
+    params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
 }>;
 export declare type CronjobRpcRequest = Infer<typeof CronjobRpcRequestStruct>;
 export declare const CronExpressionStruct: import("superstruct").Struct<string, null>;
@@ -23,23 +23,23 @@ export declare function parseCronExpression(expression: string | object): import
 export declare const CronjobSpecificationStruct: import("superstruct").Struct<{
     request: {
         method: string;
-        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
         id?: string | number | null | undefined;
         jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
     };
     expression: string;
 }, {
     expression: import("superstruct").Struct<string, null>;
     request: import("superstruct").Struct<{
         method: string;
-        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
         id?: string | number | null | undefined;
         jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
     }, {
-        params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+        jsonrpc: import("superstruct").Struct<"2.0" | undefined, "2.0">;
+        id: import("superstruct").Struct<string | number | null | undefined, null>;
         method: import("superstruct").Struct<string, null>;
-        id: import("superstruct").Struct<string | number | null | undefined, unknown>;
-        jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
+        params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
     }>;
 }>;
 export declare type CronjobSpecification = Infer<typeof CronjobSpecificationStruct>;
@@ -53,31 +53,31 @@ export declare function isCronjobSpecification(value: unknown): boolean;
 export declare const CronjobSpecificationArrayStruct: import("superstruct").Struct<{
     request: {
         method: string;
-        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
         id?: string | number | null | undefined;
         jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
     };
     expression: string;
 }[], import("superstruct").Struct<{
     request: {
         method: string;
-        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
         id?: string | number | null | undefined;
         jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
     };
     expression: string;
 }, {
     expression: import("superstruct").Struct<string, null>;
     request: import("superstruct").Struct<{
         method: string;
-        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
         id?: string | number | null | undefined;
         jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
     }, {
-        params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+        jsonrpc: import("superstruct").Struct<"2.0" | undefined, "2.0">;
+        id: import("superstruct").Struct<string | number | null | undefined, null>;
         method: import("superstruct").Struct<string, null>;
-        id: import("superstruct").Struct<string | number | null | undefined, unknown>;
-        jsonrpc: import("superstruct").Struct<"2.0" | undefined, unknown>;
+        params: import("superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
     }>;
 }>>;
 /**

package/dist/types/handlers.d.ts

@@ -68,6 +68,24 @@ export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
     };
     severity?: SeverityLevel | undefined;
 } | null, {
@@ -89,6 +107,24 @@ export declare const OnTransactionResponseStruct: import("superstruct").Struct<{
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
     }, null>;
     severity: import("superstruct").Struct<SeverityLevel | undefined, SeverityLevel>;
 }>;
@@ -111,6 +147,24 @@ export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
     };
 }, {
     content: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
@@ -131,6 +185,24 @@ export declare const OnHomePageResponseStruct: import("superstruct").Struct<{
         value: string;
         type: import("@metamask/snaps-sdk").NodeType.Text;
         markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
     }, null>;
 }>;
 /**

package/dist/types/index.browser.d.ts

@@ -6,7 +6,6 @@ export * from './cronjob';
 export * from './deep-clone';
 export * from './default-endowments';
 export * from './entropy';
-export * from './enum';
 export * from './errors';
 export * from './handlers';
 export * from './handler-types';

package/dist/types/index.d.ts

@@ -6,7 +6,6 @@ export * from './checksum';
 export * from './deep-clone';
 export * from './default-endowments';
 export * from './entropy';
-export * from './enum';
 export * from './eval';
 export * from './errors';
 export * from './fs';

package/dist/types/localization.d.ts

@@ -108,9 +108,9 @@ export declare function getLocalizedSnapManifest(snapManifest: SnapManifest, loc
             jobs: {
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 };
                 expression: string;
             }[];

package/dist/types/manifest/manifest.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import type { Json } from '@metamask/utils';
 import { ProgrammaticallyFixableSnapError } from '../snaps';
 import type { SnapFiles } from '../types';
@@ -80,9 +81,10 @@ export declare function getSnapFilePaths(manifest: Json, selector: (manifest: Pa
  *
  * @param basePath - The path to the folder with the manifest files.
  * @param paths - The paths to the files.
+ * @param encoding - An optional encoding to pass down to readVirtualFile.
  * @returns A list of auxiliary files and their contents, if any.
  */
-export declare function getSnapFiles(basePath: string, paths: string[] | undefined): Promise<VirtualFile[] | undefined>;
+export declare function getSnapFiles(basePath: string, paths: string[] | undefined, encoding?: BufferEncoding | null): Promise<VirtualFile[] | undefined>;
 /**
  * Sorts the given manifest in our preferred sort order and removes the
  * `repository` field if it is falsy (it may be `null`).