@metamask/snaps-utils 0.34.0-flask.1 → 0.35.0-flask.1

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/manifest/manifest.ts"],"sourcesContent":["import { Json, 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 {\n  NpmSnapFileNames,\n  SnapFiles,\n  SnapValidationFailureReason,\n  UnvalidatedSnapFiles,\n} from '../types';\nimport { readVirtualFile, VirtualFile } from '../virtual-file';\nimport { 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\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param writeManifest - Whether to write the fixed manifest to disk.\n * @param sourceCode - The source code of the Snap.\n * @returns Whether the manifest was updated, and an array of warnings that\n * were encountered during processing of the manifest files.\n */\nexport async function checkManifest(\n  basePath: string,\n  writeManifest = true,\n  sourceCode?: string,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const manifestPath = pathUtils.join(basePath, NpmSnapFileNames.Manifest);\n  const manifestFile = await readJsonFile(manifestPath);\n  const unvalidatedManifest = manifestFile.result;\n\n  const packageFile = await readJsonFile(\n    pathUtils.join(basePath, NpmSnapFileNames.PackageJson),\n  );\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: manifestFile,\n    packageJson: packageFile,\n    sourceCode: await getSnapSourceCode(\n      basePath,\n      unvalidatedManifest,\n      sourceCode,\n    ),\n    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),\n  };\n\n  let manifest: VirtualFile<SnapManifest> | undefined;\n  try {\n    ({ manifest } = validateNpmSnap(snapFiles));\n  } catch (error) {\n    if (error instanceof ProgrammaticallyFixableSnapError) {\n      errors.push(error.message);\n\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      let currentError = error;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the `SnapValidationFailureReason` enum, so we only\n      // attempt to fix the manifest the same amount of times as there are\n      // reasons in the enum.\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = fixManifest(\n          manifest\n            ? { ...partiallyValidatedFiles, manifest }\n            : partiallyValidatedFiles,\n          currentError,\n        );\n\n        try {\n          validateNpmSnapManifest({ ...partiallyValidatedFiles, manifest });\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          currentError = nextValidationError;\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n\n          errors.push(currentError.message);\n        }\n      }\n\n      updated = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript assumes `manifest` can still be undefined, that is not the case.\n  // But we assert to keep TypeScript happy.\n  assert(manifest);\n\n  const validatedManifest = manifest.result;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    warnings.push(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  if (writeManifest) {\n    try {\n      const newManifest = `${JSON.stringify(\n        getWritableManifest(validatedManifest),\n        null,\n        2,\n      )}\\n`;\n\n      if (updated || newManifest !== manifestFile.value) {\n        await fs.writeFile(\n          pathUtils.join(basePath, NpmSnapFileNames.Manifest),\n          newManifest,\n        );\n      }\n    } catch (error) {\n      // Note: This error isn't pushed to the errors array, because it's not an\n      // error in the manifest itself.\n      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);\n    }\n  }\n\n  return { manifest: validatedManifest, updated, warnings, errors };\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nexport function fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): VirtualFile<SnapManifest> {\n  const { manifest, packageJson } = snapFiles;\n  const clonedFile = manifest.clone();\n  const manifestCopy = clonedFile.result;\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.result.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.result.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.result.repository\n        ? deepClone(packageJson.result.repository)\n        : undefined;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = getSnapChecksum(snapFiles);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      assertExhaustive(error.reason);\n  }\n\n  clonedFile.result = manifestCopy;\n  clonedFile.value = JSON.stringify(manifestCopy);\n  return clonedFile;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param sourceCode - Override source code for plugins.\n * @returns The contents of the bundle file, if any.\n */\nexport async function getSnapSourceCode(\n  basePath: string,\n  manifest: Json,\n  sourceCode?: string,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n    ?.npm?.filePath;\n\n  if (!sourceFilePath) {\n    return undefined;\n  }\n\n  if (sourceCode) {\n    return new VirtualFile({\n      path: pathUtils.join(basePath, sourceFilePath),\n      value: sourceCode,\n    });\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, sourceFilePath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read Snap bundle file: ${error.message}`);\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * icon and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the icon, if any.\n */\nexport async function getSnapIcon(\n  basePath: string,\n  manifest: Json,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const iconPath = (manifest as Partial<SnapManifest>).source?.location?.npm\n    ?.iconPath;\n\n  if (!iconPath) {\n    return undefined;\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, iconPath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read Snap icon file: ${error.message}`);\n  }\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n\n  const keys = Object.keys(\n    repository ? { ...remaining, repository } : remaining,\n  ) as (keyof SnapManifest)[];\n\n  const writableManifest = keys\n    .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])\n    .reduce<Partial<SnapManifest>>(\n      (result, key) => ({\n        ...result,\n        [key]: manifest[key],\n      }),\n      {},\n    );\n\n  return writableManifest as SnapManifest;\n}\n\n/**\n * Validates the fields of an npm Snap manifest that has already passed JSON\n * Schema validation.\n *\n * @param snapFiles - The relevant snap files to validate.\n * @param snapFiles.manifest - The npm Snap manifest to validate.\n * @param snapFiles.packageJson - The npm Snap's `package.json`.\n * @param snapFiles.sourceCode - The Snap's source code.\n * @param snapFiles.svgIcon - The Snap's optional icon.\n */\nexport function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n  svgIcon,\n}: SnapFiles) {\n  const packageJsonName = packageJson.result.name;\n  const packageJsonVersion = packageJson.result.version;\n  const packageJsonRepository = packageJson.result.repository;\n\n  const manifestPackageName = manifest.result.source.location.npm.packageName;\n  const manifestPackageVersion = manifest.result.version;\n  const manifestRepository = manifest.result.repository;\n\n  if (packageJsonName !== manifestPackageName) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package name (\"${manifestPackageName}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"name\" field (\"${packageJsonName}\").`,\n      SnapValidationFailureReason.NameMismatch,\n    );\n  }\n\n  if (packageJsonVersion !== manifestPackageVersion) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package version (\"${manifestPackageVersion}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"version\" field (\"${packageJsonVersion}\").`,\n      SnapValidationFailureReason.VersionMismatch,\n    );\n  }\n\n  if (\n    // The repository may be `undefined` in package.json but can only be defined\n    // or `null` in the Snap manifest due to TS@<4.4 issues.\n    (packageJsonRepository || manifestRepository) &&\n    !deepEqual(packageJsonRepository, manifestRepository)\n  ) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" \"repository\" field does not match the \"${NpmSnapFileNames.PackageJson}\" \"repository\" field.`,\n      SnapValidationFailureReason.RepositoryMismatch,\n    );\n  }\n\n  validateSnapShasum(\n    { manifest, sourceCode, svgIcon },\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n}\n"],"names":["checkManifest","fixManifest","getSnapSourceCode","getSnapIcon","getWritableManifest","validateNpmSnapManifest","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialPermissions","manifestVersion","basePath","writeManifest","sourceCode","warnings","errors","updated","manifestPath","pathUtils","join","NpmSnapFileNames","Manifest","manifestFile","readJsonFile","unvalidatedManifest","result","packageFile","PackageJson","snapFiles","manifest","packageJson","svgIcon","validateNpmSnap","error","ProgrammaticallyFixableSnapError","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","SnapValidationFailureReason","length","attempts","nextValidationError","Error","assert","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","value","fs","writeFile","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","deepClone","undefined","ShasumMismatch","shasum","getSnapChecksum","assertExhaustive","isPlainObject","sourceFilePath","filePath","VirtualFile","path","virtualFile","readVirtualFile","iconPath","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository","deepEqual","validateSnapShasum"],"mappings":";;;;;;;;;;;IAiEsBA,aAAa;eAAbA;;IA4INC,WAAW;eAAXA;;IA8CMC,iBAAiB;eAAjBA;;IA0CAC,WAAW;eAAXA;;IAiCNC,mBAAmB;eAAnBA;;IA8BAC,uBAAuB;eAAvBA;;;uBApW8C;sEACxC;oBACS;6DACT;2BAEI;qBACG;qBACG;uBAKzB;uBAMA;6BACsC;;;;;;AAG7C,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,iBAAiB;AACnB;AAkCO,eAAed,cACpBe,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB;IAEnB,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAeC,aAAS,CAACC,IAAI,CAACR,UAAUS,uBAAgB,CAACC,QAAQ;IACvE,MAAMC,eAAe,MAAMC,IAAAA,iBAAY,EAACN;IACxC,MAAMO,sBAAsBF,aAAaG,MAAM;IAE/C,MAAMC,cAAc,MAAMH,IAAAA,iBAAY,EACpCL,aAAS,CAACC,IAAI,CAACR,UAAUS,uBAAgB,CAACO,WAAW;IAGvD,MAAMC,YAAkC;QACtCC,UAAUP;QACVQ,aAAaJ;QACbb,YAAY,MAAMf,kBAChBa,UACAa,qBACAX;QAEFkB,SAAS,MAAMhC,YAAYY,UAAUa;IACvC;IAEA,IAAIK;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAGG,IAAAA,oBAAe,EAACJ,UAAS;IAC3C,EAAE,OAAOK,OAAO;QACd,IAAIA,iBAAiBC,uCAAgC,EAAE;YACrDnB,OAAOoB,IAAI,CAACF,MAAMG,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BT;YAEhC,IAAIU,YAAY;YAChB,IAAIC,eAAeN;YACnB,MAAMO,cAAcC,OAAOC,IAAI,CAACC,kCAA2B,EAAEC,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGP,aAAaO,YAAYL,aAAaK,WAAY;gBACvEhB,WAAWhC,YACTgC,WACI;oBAAE,GAAGQ,uBAAuB;oBAAER;gBAAS,IACvCQ,yBACJE;gBAGF,IAAI;oBACFtC,wBAAwB;wBAAE,GAAGoC,uBAAuB;wBAAER;oBAAS;oBAE/DS,YAAY;gBACd,EAAE,OAAOQ,qBAAqB;oBAC5BP,eAAeO;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+BZ,uCAAgC,AAAD,KAE/DW,aAAaL,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIS,MACR,CAAC,kFAAkF,EAAEd,MAAMG,OAAO,CAAC,CAAC;oBAExG;oBAEArB,OAAOoB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEApB,UAAU;QACZ,OAAO;YACL,MAAMiB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1Ce,IAAAA,aAAM,EAACnB;IAEP,MAAMoB,oBAAoBpB,SAASJ,MAAM;IAEzC,qCAAqC;IACrC,MAAMyB,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBP,MAAM,GAAG,GAAG;QACvC9B,SAASqB,IAAI,CACX,CAAC,8CAA8C,EAAEgB,yBAAyBG,MAAM,CAC9E,CAACC,YAAYC;YACX,OAAO,CAAC,EAAED,WAAW,EAAE,EAAEC,aAAa,EAAE,CAAC;QAC3C,GACA,IACA,CAAC;IAEP;IAEA,IAAI5C,eAAe;QACjB,IAAI;YACF,MAAM6C,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnC3D,oBAAoBiD,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAIjC,WAAWyC,gBAAgBnC,aAAasC,KAAK,EAAE;gBACjD,MAAMC,YAAE,CAACC,SAAS,CAChB5C,aAAS,CAACC,IAAI,CAACR,UAAUS,uBAAgB,CAACC,QAAQ,GAClDoC;YAEJ;QACF,EAAE,OAAOxB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAMG,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEP,UAAUoB;QAAmBjC;QAASF;QAAUC;IAAO;AAClE;AAWO,SAASlB,YACd+B,SAAoB,EACpBK,KAAuC;IAEvC,MAAM,EAAEJ,QAAQ,EAAEC,WAAW,EAAE,GAAGF;IAClC,MAAMmC,aAAalC,SAASmC,KAAK;IACjC,MAAMC,eAAeF,WAAWtC,MAAM;IAEtC,OAAQQ,MAAMiC,MAAM;QAClB,KAAKvB,kCAA2B,CAACwB,YAAY;YAC3CF,aAAazD,MAAM,CAAC4D,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAGxC,YAAYL,MAAM,CAAC8C,IAAI;YACtE;QAEF,KAAK5B,kCAA2B,CAAC6B,eAAe;YAC9CP,aAAa7D,OAAO,GAAG0B,YAAYL,MAAM,CAACrB,OAAO;YACjD;QAEF,KAAKuC,kCAA2B,CAAC8B,kBAAkB;YACjDR,aAAa1D,UAAU,GAAGuB,YAAYL,MAAM,CAAClB,UAAU,GACnDmE,IAAAA,oBAAS,EAAC5C,YAAYL,MAAM,CAAClB,UAAU,IACvCoE;YACJ;QAEF,KAAKhC,kCAA2B,CAACiC,cAAc;YAC7CX,aAAazD,MAAM,CAACqE,MAAM,GAAGC,IAAAA,sBAAe,EAAClD;YAC7C;QAEF,wBAAwB,GACxB;YACEmD,IAAAA,uBAAgB,EAAC9C,MAAMiC,MAAM;IACjC;IAEAH,WAAWtC,MAAM,GAAGwC;IACpBF,WAAWH,KAAK,GAAGF,KAAKC,SAAS,CAACM;IAClC,OAAOF;AACT;AAWO,eAAejE,kBACpBa,QAAgB,EAChBkB,QAAc,EACdhB,UAAmB;IAEnB,IAAI,CAACmE,IAAAA,oBAAa,EAACnD,WAAW;QAC5B,OAAO8C;IACT;IAEA,MAAMM,iBAAiB,AAACpD,SAAmCrB,MAAM,EAAE4D,UAC/DC,KAAKa;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAON;IACT;IAEA,IAAI9D,YAAY;QACd,OAAO,IAAIsE,wBAAW,CAAC;YACrBC,MAAMlE,aAAS,CAACC,IAAI,CAACR,UAAUsE;YAC/BrB,OAAO/C;QACT;IACF;IAEA,IAAI;QACF,MAAMwE,cAAc,MAAMC,IAAAA,4BAAe,EACvCpE,aAAS,CAACC,IAAI,CAACR,UAAUsE,iBACzB;QAEF,OAAOI;IACT,EAAE,OAAOpD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,iCAAiC,EAAEd,MAAMG,OAAO,CAAC,CAAC;IACrE;AACF;AAUO,eAAerC,YACpBY,QAAgB,EAChBkB,QAAc;IAEd,IAAI,CAACmD,IAAAA,oBAAa,EAACnD,WAAW;QAC5B,OAAO8C;IACT;IAEA,MAAMY,WAAW,AAAC1D,SAAmCrB,MAAM,EAAE4D,UAAUC,KACnEkB;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOZ;IACT;IAEA,IAAI;QACF,MAAMU,cAAc,MAAMC,IAAAA,4BAAe,EACvCpE,aAAS,CAACC,IAAI,CAACR,UAAU4E,WACzB;QAEF,OAAOF;IACT,EAAE,OAAOpD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAEd,MAAMG,OAAO,CAAC,CAAC;IACnE;AACF;AASO,SAASpC,oBAAoB6B,QAAsB;IACxD,MAAM,EAAEtB,UAAU,EAAE,GAAGiF,WAAW,GAAG3D;IAErC,MAAMa,OAAOD,OAAOC,IAAI,CACtBnC,aAAa;QAAE,GAAGiF,SAAS;QAAEjF;IAAW,IAAIiF;IAG9C,MAAMC,mBAAmB/C,KACtBgD,IAAI,CAAC,CAACC,GAAGC,IAAM1F,mBAAmB,CAACyF,EAAE,GAAGzF,mBAAmB,CAAC0F,EAAE,EAC9DtC,MAAM,CACL,CAAC7B,QAAQ4B,MAAS,CAAA;YAChB,GAAG5B,MAAM;YACT,CAAC4B,IAAI,EAAExB,QAAQ,CAACwB,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAOoC;AACT;AAYO,SAASxF,wBAAwB,EACtC4B,QAAQ,EACRC,WAAW,EACXjB,UAAU,EACVkB,OAAO,EACG;IACV,MAAM8D,kBAAkB/D,YAAYL,MAAM,CAAC8C,IAAI;IAC/C,MAAMuB,qBAAqBhE,YAAYL,MAAM,CAACrB,OAAO;IACrD,MAAM2F,wBAAwBjE,YAAYL,MAAM,CAAClB,UAAU;IAE3D,MAAMyF,sBAAsBnE,SAASJ,MAAM,CAACjB,MAAM,CAAC4D,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAM2B,yBAAyBpE,SAASJ,MAAM,CAACrB,OAAO;IACtD,MAAM8F,qBAAqBrE,SAASJ,MAAM,CAAClB,UAAU;IAErD,IAAIsF,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI9D,uCAAgC,CACxC,CAAC,CAAC,EAAEd,uBAAgB,CAACC,QAAQ,CAAC,qBAAqB,EAAE2E,oBAAoB,uBAAuB,EAAE5E,uBAAgB,CAACO,WAAW,CAAC,iBAAiB,EAAEkE,gBAAgB,GAAG,CAAC,EACtKlD,kCAA2B,CAACwB,YAAY;IAE5C;IAEA,IAAI2B,uBAAuBG,wBAAwB;QACjD,MAAM,IAAI/D,uCAAgC,CACxC,CAAC,CAAC,EAAEd,uBAAgB,CAACC,QAAQ,CAAC,wBAAwB,EAAE4E,uBAAuB,uBAAuB,EAAE7E,uBAAgB,CAACO,WAAW,CAAC,oBAAoB,EAAEmE,mBAAmB,GAAG,CAAC,EAClLnD,kCAA2B,CAAC6B,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDuB,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACC,IAAAA,sBAAS,EAACJ,uBAAuBG,qBAClC;QACA,MAAM,IAAIhE,uCAAgC,CACxC,CAAC,CAAC,EAAEd,uBAAgB,CAACC,QAAQ,CAAC,yCAAyC,EAAED,uBAAgB,CAACO,WAAW,CAAC,qBAAqB,CAAC,EAC5HgB,kCAA2B,CAAC8B,kBAAkB;IAElD;IAEA2B,IAAAA,yBAAkB,EAChB;QAAEvE;QAAUhB;QAAYkB;IAAQ,GAChC,CAAC,CAAC,EAAEX,uBAAgB,CAACC,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}

package/dist/cjs/manifest/validation.js

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

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

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

package/dist/cjs/mock.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    ALL_APIS: function() {
+        return ALL_APIS;
+    },
+    isConstructor: function() {
+        return isConstructor;
+    },
+    generateMockEndowments: function() {
+        return generateMockEndowments;
+    }
+});
+const _crypto = /*#__PURE__*/ _interop_require_default(require("crypto"));
+const _events = /*#__PURE__*/ _interop_require_default(require("events"));
+const _defaultendowments = require("./default-endowments");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const NETWORK_APIS = [
+    'fetch',
+    'Request',
+    'Headers',
+    'Response'
+];
+const ALL_APIS = [
+    ..._defaultendowments.DEFAULT_ENDOWMENTS,
+    ...NETWORK_APIS,
+    'WebAssembly'
+];
+/**
+ * Get a mock snap API, that always returns `true` for requests.
+ *
+ * @returns A mocked snap provider.
+ */ function getMockSnapGlobal() {
+    // eslint-disable-next-line @typescript-eslint/require-await
+    return {
+        request: async ()=>true
+    };
+}
+/**
+ * Get a mock Ethereum provider, that always returns `true` for requests.
+ *
+ * @returns A mocked ethereum provider.
+ */ function getMockEthereumProvider() {
+    const mockProvider = new _events.default();
+    // eslint-disable-next-line @typescript-eslint/require-await
+    mockProvider.request = async ()=>true;
+    return mockProvider;
+}
+const isConstructor = (value)=>Boolean(typeof value?.prototype?.constructor?.name === 'string');
+/**
+ * A function that always returns `true`.
+ *
+ * @returns `true`.
+ */ const mockFunction = ()=>true;
+class MockClass {
+}
+const handler = {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    construct (Target, args) {
+        return new Proxy(new Target(...args), handler);
+    },
+    get (_target, _prop) {
+        return mockFunction;
+    }
+};
+/**
+ * Generate a mock class for a given value. The value is wrapped in a Proxy, and
+ * all methods are replaced with a mock function.
+ *
+ * @param value - The value to mock.
+ * @returns A mock class.
+ */ const generateMockClass = (value)=>{
+    return new Proxy(value, handler);
+};
+// Things not currently auto-mocked because of NodeJS, by adding them here we
+// have types for them and can use that to generate mocks if needed.
+const mockWindow = {
+    crypto: _crypto.default,
+    SubtleCrypto: MockClass
+};
+/**
+ * Generate a mock endowment for a certain class or function on the `globalThis`
+ * object.
+ *
+ * @param key - The key to generate the mock endowment for.
+ * @returns A mocked class or function. If the key is part of the default
+ * endowments, the original value is returned.
+ */ const generateMockEndowment = (key)=>{
+    const globalValue = globalThis[key];
+    // Default exposed APIs don't need to be mocked
+    if (globalValue && _defaultendowments.DEFAULT_ENDOWMENTS.includes(key)) {
+        return globalValue;
+    }
+    // Fall back to mockWindow for certain APIs not exposed in global in Node.JS
+    const globalOrMocked = globalValue ?? mockWindow[key];
+    const type = typeof globalOrMocked;
+    const isFunction = type === 'function';
+    if (isFunction && isConstructor(globalOrMocked)) {
+        return generateMockClass(globalOrMocked);
+    } else if (isFunction || !globalOrMocked) {
+        // Fall back to function mock for now
+        return mockFunction;
+    }
+    return globalOrMocked;
+};
+const generateMockEndowments = ()=>{
+    return ALL_APIS.reduce((acc, cur)=>({
+            ...acc,
+            [cur]: generateMockEndowment(cur)
+        }), {
+        snap: getMockSnapGlobal(),
+        ethereum: getMockEthereumProvider()
+    });
+};
+
+//# sourceMappingURL=mock.js.map

package/dist/cjs/mock.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/mock.ts"],"sourcesContent":["import crypto from 'crypto';\nimport EventEmitter from 'events';\n\nimport { DEFAULT_ENDOWMENTS } from './default-endowments';\n\nconst NETWORK_APIS = ['fetch', 'Request', 'Headers', 'Response'];\n\nexport const ALL_APIS: string[] = [\n  ...DEFAULT_ENDOWMENTS,\n  ...NETWORK_APIS,\n  'WebAssembly',\n];\n\ntype MockSnapGlobal = {\n  request: () => Promise<any>;\n};\n\ntype MockEthereumProvider = EventEmitter & {\n  request: () => Promise<any>;\n};\n\n/**\n * Get a mock snap API, that always returns `true` for requests.\n *\n * @returns A mocked snap provider.\n */\nfunction getMockSnapGlobal(): MockSnapGlobal {\n  // eslint-disable-next-line @typescript-eslint/require-await\n  return { request: async () => true };\n}\n\n/**\n * Get a mock Ethereum provider, that always returns `true` for requests.\n *\n * @returns A mocked ethereum provider.\n */\nfunction getMockEthereumProvider(): MockEthereumProvider {\n  const mockProvider = new EventEmitter() as Partial<MockEthereumProvider>;\n  // eslint-disable-next-line @typescript-eslint/require-await\n  mockProvider.request = async () => true;\n  return mockProvider as MockEthereumProvider;\n}\n\n/**\n * Check if a value is a constructor.\n *\n * @param value - The value to check.\n * @returns `true` if the value is a constructor, or `false` otherwise.\n */\nexport const isConstructor = (value: any) =>\n  Boolean(typeof value?.prototype?.constructor?.name === 'string');\n\n/**\n * A function that always returns `true`.\n *\n * @returns `true`.\n */\nconst mockFunction = () => true;\nclass MockClass {}\n\nconst handler = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  construct(Target: any, args: any[]): any {\n    return new Proxy(new Target(...args), handler);\n  },\n  get(_target: any, _prop: any) {\n    return mockFunction;\n  },\n};\n\n/**\n * Generate a mock class for a given value. The value is wrapped in a Proxy, and\n * all methods are replaced with a mock function.\n *\n * @param value - The value to mock.\n * @returns A mock class.\n */\nconst generateMockClass = (value: any) => {\n  return new Proxy(value, handler);\n};\n\n// Things not currently auto-mocked because of NodeJS, by adding them here we\n// have types for them and can use that to generate mocks if needed.\nconst mockWindow: Record<string, unknown> = {\n  crypto,\n  SubtleCrypto: MockClass,\n};\n\n/**\n * Generate a mock endowment for a certain class or function on the `globalThis`\n * object.\n *\n * @param key - The key to generate the mock endowment for.\n * @returns A mocked class or function. If the key is part of the default\n * endowments, the original value is returned.\n */\nconst generateMockEndowment = (key: string) => {\n  const globalValue = (globalThis as any)[key];\n\n  // Default exposed APIs don't need to be mocked\n  if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {\n    return globalValue;\n  }\n\n  // Fall back to mockWindow for certain APIs not exposed in global in Node.JS\n  const globalOrMocked = globalValue ?? mockWindow[key];\n\n  const type = typeof globalOrMocked;\n  const isFunction = type === 'function';\n  if (isFunction && isConstructor(globalOrMocked)) {\n    return generateMockClass(globalOrMocked);\n  } else if (isFunction || !globalOrMocked) {\n    // Fall back to function mock for now\n    return mockFunction;\n  }\n  return globalOrMocked;\n};\n\n/**\n * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.\n *\n * @returns A map of endowments.\n */\nexport const generateMockEndowments = () => {\n  return ALL_APIS.reduce<Record<string, any>>(\n    (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),\n    { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() },\n  );\n};\n"],"names":["ALL_APIS","isConstructor","generateMockEndowments","NETWORK_APIS","DEFAULT_ENDOWMENTS","getMockSnapGlobal","request","getMockEthereumProvider","mockProvider","EventEmitter","value","Boolean","prototype","constructor","name","mockFunction","MockClass","handler","construct","Target","args","Proxy","get","_target","_prop","generateMockClass","mockWindow","crypto","SubtleCrypto","generateMockEndowment","key","globalValue","globalThis","includes","globalOrMocked","type","isFunction","reduce","acc","cur","snap","ethereum"],"mappings":";;;;;;;;;;;IAOaA,QAAQ;eAARA;;IA0CAC,aAAa;eAAbA;;IA0EAC,sBAAsB;eAAtBA;;;+DA3HM;+DACM;mCAEU;;;;;;AAEnC,MAAMC,eAAe;IAAC;IAAS;IAAW;IAAW;CAAW;AAEzD,MAAMH,WAAqB;OAC7BI,qCAAkB;OAClBD;IACH;CACD;AAUD;;;;CAIC,GACD,SAASE;IACP,4DAA4D;IAC5D,OAAO;QAAEC,SAAS,UAAY;IAAK;AACrC;AAEA;;;;CAIC,GACD,SAASC;IACP,MAAMC,eAAe,IAAIC,eAAY;IACrC,4DAA4D;IAC5DD,aAAaF,OAAO,GAAG,UAAY;IACnC,OAAOE;AACT;AAQO,MAAMP,gBAAgB,CAACS,QAC5BC,QAAQ,OAAOD,OAAOE,WAAWC,aAAaC,SAAS;AAEzD;;;;CAIC,GACD,MAAMC,eAAe,IAAM;AAC3B,MAAMC;AAAW;AAEjB,MAAMC,UAAU;IACd,gEAAgE;IAChEC,WAAUC,MAAW,EAAEC,IAAW;QAChC,OAAO,IAAIC,MAAM,IAAIF,UAAUC,OAAOH;IACxC;IACAK,KAAIC,OAAY,EAAEC,KAAU;QAC1B,OAAOT;IACT;AACF;AAEA;;;;;;CAMC,GACD,MAAMU,oBAAoB,CAACf;IACzB,OAAO,IAAIW,MAAMX,OAAOO;AAC1B;AAEA,6EAA6E;AAC7E,oEAAoE;AACpE,MAAMS,aAAsC;IAC1CC,QAAAA,eAAM;IACNC,cAAcZ;AAChB;AAEA;;;;;;;CAOC,GACD,MAAMa,wBAAwB,CAACC;IAC7B,MAAMC,cAAc,AAACC,UAAkB,CAACF,IAAI;IAE5C,+CAA+C;IAC/C,IAAIC,eAAe3B,qCAAkB,CAAC6B,QAAQ,CAACH,MAAM;QACnD,OAAOC;IACT;IAEA,4EAA4E;IAC5E,MAAMG,iBAAiBH,eAAeL,UAAU,CAACI,IAAI;IAErD,MAAMK,OAAO,OAAOD;IACpB,MAAME,aAAaD,SAAS;IAC5B,IAAIC,cAAcnC,cAAciC,iBAAiB;QAC/C,OAAOT,kBAAkBS;IAC3B,OAAO,IAAIE,cAAc,CAACF,gBAAgB;QACxC,qCAAqC;QACrC,OAAOnB;IACT;IACA,OAAOmB;AACT;AAOO,MAAMhC,yBAAyB;IACpC,OAAOF,SAASqC,MAAM,CACpB,CAACC,KAAKC,MAAS,CAAA;YAAE,GAAGD,GAAG;YAAE,CAACC,IAAI,EAAEV,sBAAsBU;QAAK,CAAA,GAC3D;QAAEC,MAAMnC;QAAqBoC,UAAUlC;IAA0B;AAErE"}

package/dist/cjs/namespace.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    CHAIN_ID_REGEX: function() {
+        return CHAIN_ID_REGEX;
+    },
+    ACCOUNT_ID_REGEX: function() {
+        return ACCOUNT_ID_REGEX;
+    },
+    parseChainId: function() {
+        return parseChainId;
+    },
+    parseAccountId: function() {
+        return parseAccountId;
+    },
+    LimitedString: function() {
+        return LimitedString;
+    },
+    ChainIdStruct: function() {
+        return ChainIdStruct;
+    },
+    AccountIdStruct: function() {
+        return AccountIdStruct;
+    },
+    AccountIdArrayStruct: function() {
+        return AccountIdArrayStruct;
+    },
+    ChainStruct: function() {
+        return ChainStruct;
+    },
+    NamespaceStruct: function() {
+        return NamespaceStruct;
+    },
+    NamespaceIdStruct: function() {
+        return NamespaceIdStruct;
+    },
+    isNamespaceId: function() {
+        return isNamespaceId;
+    },
+    isChainId: function() {
+        return isChainId;
+    },
+    isAccountId: function() {
+        return isAccountId;
+    },
+    isAccountIdArray: function() {
+        return isAccountIdArray;
+    },
+    isNamespace: function() {
+        return isNamespace;
+    }
+});
+const _superstruct = require("superstruct");
+const CHAIN_ID_REGEX = RegExp("^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$", "u");
+const ACCOUNT_ID_REGEX = RegExp("^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$", "u");
+function parseChainId(chainId) {
+    const match = CHAIN_ID_REGEX.exec(chainId);
+    if (!match?.groups) {
+        throw new Error('Invalid chain ID.');
+    }
+    return {
+        namespace: match.groups.namespace,
+        reference: match.groups.reference
+    };
+}
+function parseAccountId(accountId) {
+    const match = ACCOUNT_ID_REGEX.exec(accountId);
+    if (!match?.groups) {
+        throw new Error('Invalid account ID.');
+    }
+    return {
+        address: match.groups.accountAddress,
+        chainId: match.groups.chainId,
+        chain: {
+            namespace: match.groups.namespace,
+            reference: match.groups.reference
+        }
+    };
+}
+const LimitedString = (0, _superstruct.size)((0, _superstruct.string)(), 1, 40);
+const ChainIdStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), CHAIN_ID_REGEX);
+const AccountIdStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), ACCOUNT_ID_REGEX);
+const AccountIdArrayStruct = (0, _superstruct.array)(AccountIdStruct);
+const ChainStruct = (0, _superstruct.object)({
+    id: ChainIdStruct,
+    name: LimitedString
+});
+const NamespaceStruct = (0, _superstruct.object)({
+    /**
+   * A list of supported chains in the namespace.
+   */ chains: (0, _superstruct.array)(ChainStruct),
+    /**
+   * A list of supported RPC methods on the namespace, that a DApp can call.
+   */ methods: (0, _superstruct.optional)((0, _superstruct.array)(LimitedString)),
+    /**
+   * A list of supported RPC events on the namespace, that a DApp can listen to.
+   */ events: (0, _superstruct.optional)((0, _superstruct.array)(LimitedString))
+});
+const NamespaceIdStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), /^[-a-z0-9]{3,8}$/u);
+function isNamespaceId(value) {
+    return (0, _superstruct.is)(value, NamespaceIdStruct);
+}
+function isChainId(value) {
+    return (0, _superstruct.is)(value, ChainIdStruct);
+}
+function isAccountId(value) {
+    return (0, _superstruct.is)(value, AccountIdStruct);
+}
+function isAccountIdArray(value) {
+    return (0, _superstruct.is)(value, AccountIdArrayStruct);
+}
+function isNamespace(value) {
+    return (0, _superstruct.is)(value, NamespaceStruct);
+}
+
+//# sourceMappingURL=namespace.js.map

package/dist/cjs/namespace.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/namespace.ts"],"sourcesContent":["import {\n  array,\n  Infer,\n  is,\n  object,\n  optional,\n  pattern,\n  size,\n  string,\n} from 'superstruct';\n\nexport const CHAIN_ID_REGEX =\n  /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u;\n\nexport const ACCOUNT_ID_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;\n\n/**\n * Parse a chain ID string to an object containing the namespace and reference.\n * This validates the chain ID before parsing it.\n *\n * @param chainId - The chain ID to validate and parse.\n * @returns The parsed chain ID.\n */\nexport function parseChainId(chainId: ChainId): {\n  namespace: NamespaceId;\n  reference: string;\n} {\n  const match = CHAIN_ID_REGEX.exec(chainId);\n  if (!match?.groups) {\n    throw new Error('Invalid chain ID.');\n  }\n\n  return {\n    namespace: match.groups.namespace,\n    reference: match.groups.reference,\n  };\n}\n\n/**\n * Parse an account ID to an object containing the chain, chain ID and address.\n * This validates the account ID before parsing it.\n *\n * @param accountId - The account ID to validate and parse.\n * @returns The parsed account ID.\n */\nexport function parseAccountId(accountId: AccountId): {\n  chain: { namespace: NamespaceId; reference: string };\n  chainId: ChainId;\n  address: string;\n} {\n  const match = ACCOUNT_ID_REGEX.exec(accountId);\n  if (!match?.groups) {\n    throw new Error('Invalid account ID.');\n  }\n\n  return {\n    address: match.groups.accountAddress,\n    chainId: match.groups.chainId as ChainId,\n    chain: {\n      namespace: match.groups.namespace,\n      reference: match.groups.reference,\n    },\n  };\n}\n\n/**\n * A helper struct for a string with a minimum length of 1 and a maximum length\n * of 40.\n */\nexport const LimitedString = size(string(), 1, 40);\n\n/**\n * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.\n */\nexport const ChainIdStruct = pattern(string(), CHAIN_ID_REGEX);\nexport type ChainId = `${string}:${string}`;\n\nexport const AccountIdStruct = pattern(string(), ACCOUNT_ID_REGEX);\nexport type AccountId = `${ChainId}:${string}`;\n\nexport const AccountIdArrayStruct = array(AccountIdStruct);\n\n/**\n * A chain descriptor.\n */\nexport const ChainStruct = object({\n  id: ChainIdStruct,\n  name: LimitedString,\n});\nexport type Chain = Infer<typeof ChainStruct>;\n\nexport const NamespaceStruct = object({\n  /**\n   * A list of supported chains in the namespace.\n   */\n  chains: array(ChainStruct),\n\n  /**\n   * A list of supported RPC methods on the namespace, that a DApp can call.\n   */\n  methods: optional(array(LimitedString)),\n\n  /**\n   * A list of supported RPC events on the namespace, that a DApp can listen to.\n   */\n  events: optional(array(LimitedString)),\n});\nexport type Namespace = Infer<typeof NamespaceStruct>;\n\n/**\n * A CAIP-2 namespace, i.e., the first part of a chain ID.\n */\nexport const NamespaceIdStruct = pattern(string(), /^[-a-z0-9]{3,8}$/u);\nexport type NamespaceId = Infer<typeof NamespaceIdStruct>;\n\n/**\n * Check if the given value is a CAIP-2 namespace ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 namespace ID.\n */\nexport function isNamespaceId(value: unknown): value is NamespaceId {\n  return is(value, NamespaceIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-2 chain ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 chain ID.\n */\nexport function isChainId(value: unknown): value is ChainId {\n  return is(value, ChainIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-10 account ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-10 account ID.\n */\nexport function isAccountId(value: unknown): value is AccountId {\n  return is(value, AccountIdStruct);\n}\n\n/**\n * Check if the given value is an array of CAIP-10 account IDs.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of CAIP-10 account IDs.\n */\nexport function isAccountIdArray(value: unknown): value is AccountId[] {\n  return is(value, AccountIdArrayStruct);\n}\n\n/**\n * Check if a value is a {@link Namespace}.\n *\n * @param value - The value to validate.\n * @returns True if the value is a valid {@link Namespace}.\n */\nexport function isNamespace(value: unknown): value is Namespace {\n  return is(value, NamespaceStruct);\n}\n"],"names":["CHAIN_ID_REGEX","ACCOUNT_ID_REGEX","parseChainId","parseAccountId","LimitedString","ChainIdStruct","AccountIdStruct","AccountIdArrayStruct","ChainStruct","NamespaceStruct","NamespaceIdStruct","isNamespaceId","isChainId","isAccountId","isAccountIdArray","isNamespace","chainId","match","exec","groups","Error","namespace","reference","accountId","address","accountAddress","chain","size","string","pattern","array","object","id","name","chains","methods","optional","events","value","is"],"mappings":";;;;;;;;;;;IAWaA,cAAc;eAAdA;;IAGAC,gBAAgB;eAAhBA;;IAUGC,YAAY;eAAZA;;IAsBAC,cAAc;eAAdA;;IAwBHC,aAAa;eAAbA;;IAKAC,aAAa;eAAbA;;IAGAC,eAAe;eAAfA;;IAGAC,oBAAoB;eAApBA;;IAKAC,WAAW;eAAXA;;IAMAC,eAAe;eAAfA;;IAqBAC,iBAAiB;eAAjBA;;IASGC,aAAa;eAAbA;;IAUAC,SAAS;eAATA;;IAUAC,WAAW;eAAXA;;IAUAC,gBAAgB;eAAhBA;;IAUAC,WAAW;eAAXA;;;6BAzJT;AAEA,MAAMf,iBACX;AAEK,MAAMC,mBACX;AASK,SAASC,aAAac,OAAgB;IAI3C,MAAMC,QAAQjB,eAAekB,IAAI,CAACF;IAClC,IAAI,CAACC,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLC,WAAWJ,MAAME,MAAM,CAACE,SAAS;QACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;IACnC;AACF;AASO,SAASnB,eAAeoB,SAAoB;IAKjD,MAAMN,QAAQhB,iBAAiBiB,IAAI,CAACK;IACpC,IAAI,CAACN,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLI,SAASP,MAAME,MAAM,CAACM,cAAc;QACpCT,SAASC,MAAME,MAAM,CAACH,OAAO;QAC7BU,OAAO;YACLL,WAAWJ,MAAME,MAAM,CAACE,SAAS;YACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;QACnC;IACF;AACF;AAMO,MAAMlB,gBAAgBuB,IAAAA,iBAAI,EAACC,IAAAA,mBAAM,KAAI,GAAG;AAKxC,MAAMvB,gBAAgBwB,IAAAA,oBAAO,EAACD,IAAAA,mBAAM,KAAI5B;AAGxC,MAAMM,kBAAkBuB,IAAAA,oBAAO,EAACD,IAAAA,mBAAM,KAAI3B;AAG1C,MAAMM,uBAAuBuB,IAAAA,kBAAK,EAACxB;AAKnC,MAAME,cAAcuB,IAAAA,mBAAM,EAAC;IAChCC,IAAI3B;IACJ4B,MAAM7B;AACR;AAGO,MAAMK,kBAAkBsB,IAAAA,mBAAM,EAAC;IACpC;;GAEC,GACDG,QAAQJ,IAAAA,kBAAK,EAACtB;IAEd;;GAEC,GACD2B,SAASC,IAAAA,qBAAQ,EAACN,IAAAA,kBAAK,EAAC1B;IAExB;;GAEC,GACDiC,QAAQD,IAAAA,qBAAQ,EAACN,IAAAA,kBAAK,EAAC1B;AACzB;AAMO,MAAMM,oBAAoBmB,IAAAA,oBAAO,EAACD,IAAAA,mBAAM,KAAI;AAS5C,SAASjB,cAAc2B,KAAc;IAC1C,OAAOC,IAAAA,eAAE,EAACD,OAAO5B;AACnB;AAQO,SAASE,UAAU0B,KAAc;IACtC,OAAOC,IAAAA,eAAE,EAACD,OAAOjC;AACnB;AAQO,SAASQ,YAAYyB,KAAc;IACxC,OAAOC,IAAAA,eAAE,EAACD,OAAOhC;AACnB;AAQO,SAASQ,iBAAiBwB,KAAc;IAC7C,OAAOC,IAAAA,eAAE,EAACD,OAAO/B;AACnB;AAQO,SAASQ,YAAYuB,KAAc;IACxC,OAAOC,IAAAA,eAAE,EAACD,OAAO7B;AACnB"}

package/dist/cjs/npm.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    EXPECTED_SNAP_FILES: function() {
+        return EXPECTED_SNAP_FILES;
+    },
+    SnapFileNameFromKey: function() {
+        return SnapFileNameFromKey;
+    },
+    validateNpmSnap: function() {
+        return validateNpmSnap;
+    }
+});
+const _icon = require("./icon");
+const _manifest = require("./manifest/manifest");
+const _validation = require("./manifest/validation");
+const _types = require("./types");
+const EXPECTED_SNAP_FILES = [
+    'manifest',
+    'packageJson',
+    'sourceCode'
+];
+const SnapFileNameFromKey = {
+    manifest: _types.NpmSnapFileNames.Manifest,
+    packageJson: _types.NpmSnapFileNames.PackageJson,
+    sourceCode: 'source code bundle'
+};
+function validateNpmSnap(snapFiles, errorPrefix) {
+    EXPECTED_SNAP_FILES.forEach((key)=>{
+        if (!snapFiles[key]) {
+            throw new Error(`${errorPrefix ?? ''}Missing file "${SnapFileNameFromKey[key]}".`);
+        }
+    });
+    // Typecast: We are assured that the required files exist if we get here.
+    const { manifest, packageJson, sourceCode, svgIcon } = snapFiles;
+    try {
+        (0, _validation.assertIsSnapManifest)(manifest.result);
+    } catch (error) {
+        throw new Error(`${errorPrefix ?? ''}${error.message}`);
+    }
+    const validatedManifest = manifest;
+    const { iconPath } = validatedManifest.result.source.location.npm;
+    if (iconPath && !svgIcon) {
+        throw new Error(`Missing file "${iconPath}".`);
+    }
+    try {
+        (0, _types.assertIsNpmSnapPackageJson)(packageJson.result);
+    } catch (error) {
+        throw new Error(`${errorPrefix ?? ''}${error.message}`);
+    }
+    const validatedPackageJson = packageJson;
+    (0, _manifest.validateNpmSnapManifest)({
+        manifest: validatedManifest,
+        packageJson: validatedPackageJson,
+        sourceCode,
+        svgIcon
+    });
+    if (svgIcon) {
+        try {
+            (0, _icon.assertIsSnapIcon)(svgIcon);
+        } catch (error) {
+            throw new Error(`${errorPrefix ?? ''}${error.message}`);
+        }
+    }
+    return {
+        manifest: validatedManifest,
+        packageJson: validatedPackageJson,
+        sourceCode,
+        svgIcon
+    };
+}
+
+//# sourceMappingURL=npm.js.map

package/dist/cjs/npm.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/npm.ts"],"sourcesContent":["import { assertIsSnapIcon } from './icon';\nimport { validateNpmSnapManifest } from './manifest/manifest';\nimport { assertIsSnapManifest } from './manifest/validation';\nimport {\n  assertIsNpmSnapPackageJson,\n  NpmSnapFileNames,\n  SnapFiles,\n  UnvalidatedSnapFiles,\n} from './types';\n\nexport const EXPECTED_SNAP_FILES = [\n  'manifest',\n  'packageJson',\n  'sourceCode',\n] as const;\n\nexport const SnapFileNameFromKey = {\n  manifest: NpmSnapFileNames.Manifest,\n  packageJson: NpmSnapFileNames.PackageJson,\n  sourceCode: 'source code bundle',\n} as const;\n\n// TODO: Refactor this to be more shared with other validation.\n\n/**\n * Validates the files extracted from an npm Snap package tarball by ensuring\n * that they're non-empty and that the Json files match their respective schemas\n * and the Snaps publishing specification.\n *\n * @param snapFiles - The object containing the expected Snap file contents,\n * if any.\n * @param errorPrefix - The prefix of the error message.\n * @returns A tuple of the Snap manifest object and the Snap source code.\n */\nexport function validateNpmSnap(\n  snapFiles: UnvalidatedSnapFiles,\n  errorPrefix?: `${string}: `,\n): SnapFiles {\n  EXPECTED_SNAP_FILES.forEach((key) => {\n    if (!snapFiles[key]) {\n      throw new Error(\n        `${errorPrefix ?? ''}Missing file \"${SnapFileNameFromKey[key]}\".`,\n      );\n    }\n  });\n\n  // Typecast: We are assured that the required files exist if we get here.\n  const { manifest, packageJson, sourceCode, svgIcon } = snapFiles as SnapFiles;\n  try {\n    assertIsSnapManifest(manifest.result);\n  } catch (error) {\n    throw new Error(`${errorPrefix ?? ''}${error.message}`);\n  }\n  const validatedManifest = manifest;\n\n  const { iconPath } = validatedManifest.result.source.location.npm;\n  if (iconPath && !svgIcon) {\n    throw new Error(`Missing file \"${iconPath}\".`);\n  }\n\n  try {\n    assertIsNpmSnapPackageJson(packageJson.result);\n  } catch (error) {\n    throw new Error(`${errorPrefix ?? ''}${error.message}`);\n  }\n  const validatedPackageJson = packageJson;\n\n  validateNpmSnapManifest({\n    manifest: validatedManifest,\n    packageJson: validatedPackageJson,\n    sourceCode,\n    svgIcon,\n  });\n\n  if (svgIcon) {\n    try {\n      assertIsSnapIcon(svgIcon);\n    } catch (error) {\n      throw new Error(`${errorPrefix ?? ''}${error.message}`);\n    }\n  }\n\n  return {\n    manifest: validatedManifest,\n    packageJson: validatedPackageJson,\n    sourceCode,\n    svgIcon,\n  };\n}\n"],"names":["EXPECTED_SNAP_FILES","SnapFileNameFromKey","validateNpmSnap","manifest","NpmSnapFileNames","Manifest","packageJson","PackageJson","sourceCode","snapFiles","errorPrefix","forEach","key","Error","svgIcon","assertIsSnapManifest","result","error","message","validatedManifest","iconPath","source","location","npm","assertIsNpmSnapPackageJson","validatedPackageJson","validateNpmSnapManifest","assertIsSnapIcon"],"mappings":";;;;;;;;;;;IAUaA,mBAAmB;eAAnBA;;IAMAC,mBAAmB;eAAnBA;;IAkBGC,eAAe;eAAfA;;;sBAlCiB;0BACO;4BACH;uBAM9B;AAEA,MAAMF,sBAAsB;IACjC;IACA;IACA;CACD;AAEM,MAAMC,sBAAsB;IACjCE,UAAUC,uBAAgB,CAACC,QAAQ;IACnCC,aAAaF,uBAAgB,CAACG,WAAW;IACzCC,YAAY;AACd;AAcO,SAASN,gBACdO,SAA+B,EAC/BC,WAA2B;IAE3BV,oBAAoBW,OAAO,CAAC,CAACC;QAC3B,IAAI,CAACH,SAAS,CAACG,IAAI,EAAE;YACnB,MAAM,IAAIC,MACR,CAAC,EAAEH,eAAe,GAAG,cAAc,EAAET,mBAAmB,CAACW,IAAI,CAAC,EAAE,CAAC;QAErE;IACF;IAEA,yEAAyE;IACzE,MAAM,EAAET,QAAQ,EAAEG,WAAW,EAAEE,UAAU,EAAEM,OAAO,EAAE,GAAGL;IACvD,IAAI;QACFM,IAAAA,gCAAoB,EAACZ,SAASa,MAAM;IACtC,EAAE,OAAOC,OAAO;QACd,MAAM,IAAIJ,MAAM,CAAC,EAAEH,eAAe,GAAG,EAAEO,MAAMC,OAAO,CAAC,CAAC;IACxD;IACA,MAAMC,oBAAoBhB;IAE1B,MAAM,EAAEiB,QAAQ,EAAE,GAAGD,kBAAkBH,MAAM,CAACK,MAAM,CAACC,QAAQ,CAACC,GAAG;IACjE,IAAIH,YAAY,CAACN,SAAS;QACxB,MAAM,IAAID,MAAM,CAAC,cAAc,EAAEO,SAAS,EAAE,CAAC;IAC/C;IAEA,IAAI;QACFI,IAAAA,iCAA0B,EAAClB,YAAYU,MAAM;IAC/C,EAAE,OAAOC,OAAO;QACd,MAAM,IAAIJ,MAAM,CAAC,EAAEH,eAAe,GAAG,EAAEO,MAAMC,OAAO,CAAC,CAAC;IACxD;IACA,MAAMO,uBAAuBnB;IAE7BoB,IAAAA,iCAAuB,EAAC;QACtBvB,UAAUgB;QACVb,aAAamB;QACbjB;QACAM;IACF;IAEA,IAAIA,SAAS;QACX,IAAI;YACFa,IAAAA,sBAAgB,EAACb;QACnB,EAAE,OAAOG,OAAO;YACd,MAAM,IAAIJ,MAAM,CAAC,EAAEH,eAAe,GAAG,EAAEO,MAAMC,OAAO,CAAC,CAAC;QACxD;IACF;IAEA,OAAO;QACLf,UAAUgB;QACVb,aAAamB;QACbjB;QACAM;IACF;AACF"}