@metamask/snaps-utils 8.0.1 → 8.1.1

package/dist/snaps.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"snaps.cjs","sourceRoot":"","sources":["../src/snaps.ts"],"names":[],"mappings":";;;;;;AAQA,uDAU+B;AAE/B,2CAAiE;AACjE,sCAAqC;AACrC,4FAAyD;AACzD,0FAA2D;AAE3D,2CAA2C;AAC3C,6CAA2C;AAQ3C,uCAA8C;AAG9C,+EAA+E;AAC/E,0EAA0E;AAC1E,0EAA0E;AAC1E,4DAA4D;AAC5D,uCAAuC;AACvC,2EAA2E;AAC3E,8EAA8E;AAC9E,qDAAqD;AACrD,mIAAmI;AACtH,QAAA,mBAAmB,GAC9B,kHAAkH,CAAC;AAErH,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,uCAAyB,CAAA;IACzB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,0BAAV,UAAU,QAMrB;AAED,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EALW,gBAAgB,gCAAhB,gBAAgB,QAK3B;AA2GD;;;;;GAKG;AACH,SAAS,wBAAwB,CAC/B,QAAmC;IAEnC,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,EAAsB,CAAC;IAC1D,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzC,4EAA4E;IAC5E,6FAA6F;IAC7F,YAAY,CAAC,KAAK,GAAG,IAAA,oCAAe,EAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,eAAe,CACnC,KAAuB;IAEvB,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,GACxE,KAAK,CAAC;IAER,MAAM,GAAG,GAAG;QACV,wBAAwB,CAAC,QAAQ,CAAC;QAClC,UAAU;QACV,OAAO;QACP,GAAG,cAAc;QACjB,GAAG,iBAAiB;KACrB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAEvC,OAAO,aAAM,CAAC,MAAM,CAAC,MAAM,IAAA,wBAAa,EAAC,GAAoB,CAAC,CAAC,CAAC;AAClE,CAAC;AAfD,0CAeC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CACtC,KAAuB,EACvB,YAAY,GAAG,wEAAwE;IAEvF,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAPD,gDAOC;AAEY,QAAA,mBAAmB,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAU,CAAC;AAEhF,iEAAiE;AACpD,QAAA,gBAAgB,GAAG,IAAA,qBAAO,EAAC,IAAA,oBAAM,GAAE,EAAE,iBAAiB,CAAC,CAAC;AAErE,MAAM,uBAAuB,GAAG,IAAA,WAAG,EAAC;IAClC,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpC,QAAQ,EAAE,IAAA,mBAAK,EAAC,2BAAmB,CAAC;IACpC,IAAI,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;IACrB,MAAM,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;CACxB,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EACrC,wBAAgB,EAChB,eAAe,EACf,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,sBAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO,gCAAgC,KAAK,IAAI,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,GAAG,IAAA,sBAAQ,EACtB,KAAK,CAAC,KAAK,CAAC,sBAAc,CAAC,KAAK,CAAC,MAAM,CAAC,EACxC,uBAAuB,CACxB,CAAC;IACF,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CACF,CAAC;AACW,QAAA,eAAe,GAAG,IAAA,0BAAY,EAAC;IAC1C,wBAAgB;IAChB,IAAA,WAAG,EAAC;QACF,QAAQ,EAAE,IAAA,qBAAO,EAAC,sBAAc,CAAC,GAAG,CAAC;QACrC,QAAQ,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,KAAK;YACzD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAClE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,GAC7C,IAAA,mCAAkB,EAAC,UAAU,CAAC,CAAC;YACjC,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,IAAA,cAAM,EAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;oBAC/B,KAAK,CAAC,CAAC,QAAQ,CAAC;gBAClB,CAAC;qBAAM,CAAC;oBACN,KAAK,CAAC,CAAC,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QACF,MAAM,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;QACvB,IAAI,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;KACtB,CAAC;CACH,CAAoC,CAAC;AAEzB,QAAA,gBAAgB,GAAG,IAAA,0BAAY,EAAC;IAC3C,wBAAgB;IAChB,IAAA,WAAG,EAAC;QACF,QAAQ,EAAE,IAAA,mBAAK,EAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;QACvB,IAAI,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;KACtB,CAAC;CACH,CAAoC,CAAC;AAEzB,QAAA,YAAY,GAAG,IAAA,mBAAK,EAAC,CAAC,uBAAe,EAAE,yBAAiB,CAAC,CAAC,CAAC;AAExE;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,MAAc;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAc,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE,CACnE,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAClC,CAAC;IACF,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,GAAG,CAAC,CAAC;AAChE,CAAC;AARD,sCAQC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,MAAc;IAC5C,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,KAAc;IAChD,IAAA,oBAAY,EAAC,KAAK,EAAE,oBAAY,EAAE,iBAAiB,CAAC,CAAC;AACvD,CAAC;AAFD,kDAEC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,OAAgB;IAC5C,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ;QAC3B,kEAAkE,CAAC,IAAI,CACrE,OAAO,CACR,CACF,CAAC;AACJ,CAAC;AAPD,sCAOC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,WAAqD,EACrD,MAAc;IAEd,OAAO,OAAO,CAGR,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,CACtC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,wBAAc,CAAC,OAAO,CACnD,IAAI,EAAE,CACR,CAAC,KACH,EAAE,CAAC,MAAM,CAAC,CACZ,CAAC;AACJ,CAAC;AAbD,0CAaC;AAED;;;;;;GAMG;AACH,SAAgB,8BAA8B,CAC5C,oBAA6B;IAE7B,IAAA,cAAM,EACJ,IAAA,gBAAQ,EAAC,oBAAoB,CAAC,EAC9B,0CAA0C,CAC3C,CAAC;IAEF,MAAM,EAAE,WAAW,EAAE,oBAAoB,EAAE,GAAG,oBAAoB,CAAC;IAEnE,IAAA,cAAM,EACJ,IAAA,gBAAQ,EAAC,oBAAoB,CAAC,EAC9B,wDAAwD,CACzD,CAAC;IAEF,MAAM,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC;IAEzC,IAAA,cAAM,EACJ,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAC9C,yEAAyE,CAC1E,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC;IAEzB,IAAA,cAAM,EACJ,IAAA,gBAAQ,EAAC,MAAM,CAAC;QACd,MAAM,CAAC,IAAI,KAAK,wBAAc,CAAC,OAAO;QACtC,IAAA,gBAAQ,EAAC,MAAM,CAAC,KAAK,CAAC,EACxB,iDAAiD,wBAAc,CAAC,OAAO,UAAU,CAClF,CAAC;AACJ,CAAC;AA9BD,wEA8BC","sourcesContent":["import type {\n  Caveat,\n  SubjectPermissions,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport type { BlockReason } from '@metamask/snaps-registry';\nimport type { SnapId, Snap as TruncatedSnap } from '@metamask/snaps-sdk';\nimport type { Struct } from '@metamask/superstruct';\nimport {\n  empty,\n  enums,\n  intersection,\n  literal,\n  pattern,\n  refine,\n  string,\n  union,\n  validate,\n} from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { assert, isObject, assertStruct } from '@metamask/utils';\nimport { base64 } from '@scure/base';\nimport stableStringify from 'fast-json-stable-stringify';\nimport validateNPMPackage from 'validate-npm-package-name';\n\nimport { SnapCaveatType } from './caveats';\nimport { checksumFiles } from './checksum';\nimport type { LocalizationFile } from './localization';\nimport type {\n  InitialConnections,\n  SnapManifest,\n  SnapPermissions,\n} from './manifest/validation';\nimport type { FetchedSnapFiles, SnapsPermissionRequest } from './types';\nimport { SnapIdPrefixes, uri } from './types';\nimport type { VirtualFile } from './virtual-file';\n\n// This RegEx matches valid npm package names (with some exceptions) and space-\n// separated alphanumerical words, optionally with dashes and underscores.\n// The RegEx consists of two parts. The first part matches space-separated\n// words. It is based on the following Stackoverflow answer:\n// https://stackoverflow.com/a/34974982\n// The second part, after the pipe operator, is the same RegEx used for the\n// `name` field of the official package.json JSON Schema, except that we allow\n// mixed-case letters. It was originally copied from:\n// https://github.com/SchemaStore/schemastore/blob/81a16897c1dabfd98c72242a5fd62eb080ff76d8/src/schemas/json/package.json#L132-L138\nexport const PROPOSED_NAME_REGEX =\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\nexport enum SnapStatus {\n  Installing = 'installing',\n  Updating = 'updating',\n  Running = 'running',\n  Stopped = 'stopped',\n  Crashed = 'crashed',\n}\n\nexport enum SnapStatusEvents {\n  Start = 'START',\n  Stop = 'STOP',\n  Crash = 'CRASH',\n  Update = 'UPDATE',\n}\n\nexport type StatusContext = { snapId: SnapId };\nexport type StatusEvents = { type: SnapStatusEvents };\nexport type StatusStates = {\n  value: SnapStatus;\n  context: StatusContext;\n};\nexport type Status = StatusStates['value'];\n\nexport type VersionHistory = {\n  origin: string;\n  version: string;\n  // Unix timestamp\n  date: number;\n};\n\nexport type SnapAuxilaryFile = {\n  path: string;\n  // Value here should be stored as base64\n  value: string;\n};\n\nexport type PersistedSnap = Snap;\n\n/**\n * A Snap as it exists in {@link SnapController} state.\n */\nexport type Snap = TruncatedSnap & {\n  /**\n   * The initial connections of the Snap, optional, requested on installation.\n   */\n  initialConnections?: InitialConnections;\n  /**\n   * The initial permissions of the Snap, which will be requested when it is\n   * installed.\n   */\n  initialPermissions: SnapPermissions;\n\n  /**\n   * The source code of the Snap.\n   */\n  sourceCode: string;\n\n  /**\n   * The Snap's manifest file.\n   */\n  manifest: SnapManifest;\n\n  /**\n   * Information detailing why the snap is blocked.\n   */\n  blockInformation?: BlockReason;\n\n  /**\n   * The current status of the Snap, e.g. whether it's running or stopped.\n   */\n  status: Status;\n\n  /**\n   * The version history of the Snap.\n   * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.\n   */\n  versionHistory: VersionHistory[];\n\n  /**\n   * Static auxiliary files that can be loaded at runtime.\n   */\n  auxiliaryFiles?: SnapAuxilaryFile[];\n\n  /**\n   * Localization files which are used to translate the manifest.\n   */\n  localizationFiles?: LocalizationFile[];\n\n  /**\n   * Flag to signal whether this snap was preinstalled or not.\n   *\n   * A lack of specifying this option will be deemed as not preinstalled.\n   */\n  preinstalled?: boolean;\n\n  /**\n   * Flag to signal whether this snap is removable or not.\n   *\n   * A lack of specifying this option will be deemed as removable.\n   */\n  removable?: boolean;\n\n  /**\n   * Flag to signal whether this snap should be hidden from the user or not.\n   */\n  hidden?: boolean;\n\n  /**\n   * Flag to signal whether this snap should hide the Snap branding like header or avatar in the UI or not.\n   */\n  hideSnapBranding?: boolean;\n};\n\nexport type TruncatedSnapFields =\n  | 'id'\n  | 'initialPermissions'\n  | 'version'\n  | 'enabled'\n  | 'blocked';\n\n/**\n * Gets a checksummable manifest by removing the shasum property and reserializing the JSON using a deterministic algorithm.\n *\n * @param manifest - The manifest itself.\n * @returns A virtual file containing the checksummable manifest.\n */\nfunction getChecksummableManifest(\n  manifest: VirtualFile<SnapManifest>,\n): VirtualFile {\n  const manifestCopy = manifest.clone() as VirtualFile<any>;\n  delete manifestCopy.result.source.shasum;\n\n  // We use fast-json-stable-stringify to deterministically serialize the JSON\n  // This is required before checksumming so we get reproducible checksums across platforms etc\n  manifestCopy.value = stableStringify(manifestCopy.result);\n  return manifestCopy;\n}\n\n/**\n * Calculates the Base64-encoded SHA-256 digest of all required Snap files.\n *\n * @param files - All required Snap files to be included in the checksum.\n * @returns The Base64-encoded SHA-256 digest of the source code.\n */\nexport async function getSnapChecksum(\n  files: FetchedSnapFiles,\n): Promise<string> {\n  const { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles } =\n    files;\n\n  const all = [\n    getChecksummableManifest(manifest),\n    sourceCode,\n    svgIcon,\n    ...auxiliaryFiles,\n    ...localizationFiles,\n  ].filter((file) => file !== undefined);\n\n  return base64.encode(await checksumFiles(all as VirtualFile[]));\n}\n\n/**\n * Checks whether the `source.shasum` property of a Snap manifest matches the\n * shasum of the snap.\n *\n * @param files - All required Snap files to be included in the checksum.\n * @param errorMessage - The error message to throw if validation fails.\n */\nexport async function validateSnapShasum(\n  files: FetchedSnapFiles,\n  errorMessage = 'Invalid Snap manifest: manifest shasum does not match computed shasum.',\n): Promise<void> {\n  if (files.manifest.result.source.shasum !== (await getSnapChecksum(files))) {\n    throw new Error(errorMessage);\n  }\n}\n\nexport const LOCALHOST_HOSTNAMES = ['localhost', '127.0.0.1', '[::1]'] as const;\n\n// Require snap ids to only consist of printable ASCII characters\nexport const BaseSnapIdStruct = pattern(string(), /^[\\x21-\\x7E]*$/u);\n\nconst LocalSnapIdSubUrlStruct = uri({\n  protocol: enums(['http:', 'https:']),\n  hostname: enums(LOCALHOST_HOSTNAMES),\n  hash: empty(string()),\n  search: empty(string()),\n});\n\nexport const LocalSnapIdStruct = refine(\n  BaseSnapIdStruct,\n  'local Snap Id',\n  (value) => {\n    if (!value.startsWith(SnapIdPrefixes.local)) {\n      return `Expected local snap ID, got \"${value}\".`;\n    }\n\n    const [error] = validate(\n      value.slice(SnapIdPrefixes.local.length),\n      LocalSnapIdSubUrlStruct,\n    );\n    return error ?? true;\n  },\n);\nexport const NpmSnapIdStruct = intersection([\n  BaseSnapIdStruct,\n  uri({\n    protocol: literal(SnapIdPrefixes.npm),\n    pathname: refine(string(), 'package name', function* (value) {\n      const normalized = value.startsWith('/') ? value.slice(1) : value;\n      const { errors, validForNewPackages, warnings } =\n        validateNPMPackage(normalized);\n      if (!validForNewPackages) {\n        if (errors === undefined) {\n          assert(warnings !== undefined);\n          yield* warnings;\n        } else {\n          yield* errors;\n        }\n      }\n      return true;\n    }),\n    search: empty(string()),\n    hash: empty(string()),\n  }),\n]) as unknown as Struct<string, null>;\n\nexport const HttpSnapIdStruct = intersection([\n  BaseSnapIdStruct,\n  uri({\n    protocol: enums(['http:', 'https:']),\n    search: empty(string()),\n    hash: empty(string()),\n  }),\n]) as unknown as Struct<string, null>;\n\nexport const SnapIdStruct = union([NpmSnapIdStruct, LocalSnapIdStruct]);\n\n/**\n * Extracts the snap prefix from a snap ID.\n *\n * @param snapId - The snap ID to extract the prefix from.\n * @returns The snap prefix from a snap id, e.g. `npm:`.\n */\nexport function getSnapPrefix(snapId: string): SnapIdPrefixes {\n  const prefix = Object.values(SnapIdPrefixes).find((possiblePrefix) =>\n    snapId.startsWith(possiblePrefix),\n  );\n  if (prefix !== undefined) {\n    return prefix;\n  }\n  throw new Error(`Invalid or no prefix found for \"${snapId}\"`);\n}\n\n/**\n * Strips snap prefix from a full snap ID.\n *\n * @param snapId - The snap ID to strip.\n * @returns The stripped snap ID.\n */\nexport function stripSnapPrefix(snapId: string): string {\n  return snapId.replace(getSnapPrefix(snapId), '');\n}\n\n/**\n * Assert that the given value is a valid snap ID.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid snap ID.\n */\nexport function assertIsValidSnapId(value: unknown): asserts value is SnapId {\n  assertStruct(value, SnapIdStruct, 'Invalid snap ID');\n}\n\n/**\n * Typeguard to ensure a chainId follows the CAIP-2 standard.\n *\n * @param chainId - The chainId being tested.\n * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.\n */\nexport function isCaipChainId(chainId: unknown): chainId is string {\n  return (\n    typeof chainId === 'string' &&\n    /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(\n      chainId,\n    )\n  );\n}\n\n/**\n * Utility function to check if an origin has permission (and caveat) for a particular snap.\n *\n * @param permissions - An origin's permissions object.\n * @param snapId - The id of the snap.\n * @returns A boolean based on if an origin has the specified snap.\n */\nexport function isSnapPermitted(\n  permissions: SubjectPermissions<PermissionConstraint>,\n  snapId: SnapId,\n) {\n  return Boolean(\n    (\n      (\n        (permissions?.wallet_snap?.caveats?.find(\n          (caveat) => caveat.type === SnapCaveatType.SnapIds,\n        ) ?? {}) as Caveat<string, Json>\n      ).value as Record<string, unknown>\n    )?.[snapId],\n  );\n}\n\n/**\n * Checks whether the passed in requestedPermissions is a valid\n * permission request for a `wallet_snap` permission.\n *\n * @param requestedPermissions - The requested permissions.\n * @throws If the criteria is not met.\n */\nexport function verifyRequestedSnapPermissions(\n  requestedPermissions: unknown,\n): asserts requestedPermissions is SnapsPermissionRequest {\n  assert(\n    isObject(requestedPermissions),\n    'Requested permissions must be an object.',\n  );\n\n  const { wallet_snap: walletSnapPermission } = requestedPermissions;\n\n  assert(\n    isObject(walletSnapPermission),\n    'wallet_snap is missing from the requested permissions.',\n  );\n\n  const { caveats } = walletSnapPermission;\n\n  assert(\n    Array.isArray(caveats) && caveats.length === 1,\n    'wallet_snap must have a caveat property with a single-item array value.',\n  );\n\n  const [caveat] = caveats;\n\n  assert(\n    isObject(caveat) &&\n      caveat.type === SnapCaveatType.SnapIds &&\n      isObject(caveat.value),\n    `The requested permissions do not have a valid ${SnapCaveatType.SnapIds} caveat.`,\n  );\n}\n\nexport type { Snap as TruncatedSnap } from '@metamask/snaps-sdk';\n"]}

package/dist/snaps.d.cts

@@ -0,0 +1,174 @@
+import type { SubjectPermissions, PermissionConstraint } from "@metamask/permission-controller";
+import type { BlockReason } from "@metamask/snaps-registry";
+import type { SnapId, Snap as TruncatedSnap } from "@metamask/snaps-sdk";
+import type { Struct } from "@metamask/superstruct";
+import type { LocalizationFile } from "./localization.cjs";
+import type { InitialConnections, SnapManifest, SnapPermissions } from "./manifest/validation.cjs";
+import type { FetchedSnapFiles, SnapsPermissionRequest } from "./types.cjs";
+import { SnapIdPrefixes } from "./types.cjs";
+export declare const PROPOSED_NAME_REGEX: RegExp;
+export declare enum SnapStatus {
+    Installing = "installing",
+    Updating = "updating",
+    Running = "running",
+    Stopped = "stopped",
+    Crashed = "crashed"
+}
+export declare enum SnapStatusEvents {
+    Start = "START",
+    Stop = "STOP",
+    Crash = "CRASH",
+    Update = "UPDATE"
+}
+export type StatusContext = {
+    snapId: SnapId;
+};
+export type StatusEvents = {
+    type: SnapStatusEvents;
+};
+export type StatusStates = {
+    value: SnapStatus;
+    context: StatusContext;
+};
+export type Status = StatusStates['value'];
+export type VersionHistory = {
+    origin: string;
+    version: string;
+    date: number;
+};
+export type SnapAuxilaryFile = {
+    path: string;
+    value: string;
+};
+export type PersistedSnap = Snap;
+/**
+ * A Snap as it exists in {@link SnapController} state.
+ */
+export type Snap = TruncatedSnap & {
+    /**
+     * The initial connections of the Snap, optional, requested on installation.
+     */
+    initialConnections?: InitialConnections;
+    /**
+     * The initial permissions of the Snap, which will be requested when it is
+     * installed.
+     */
+    initialPermissions: SnapPermissions;
+    /**
+     * The source code of the Snap.
+     */
+    sourceCode: string;
+    /**
+     * The Snap's manifest file.
+     */
+    manifest: SnapManifest;
+    /**
+     * Information detailing why the snap is blocked.
+     */
+    blockInformation?: BlockReason;
+    /**
+     * The current status of the Snap, e.g. whether it's running or stopped.
+     */
+    status: Status;
+    /**
+     * The version history of the Snap.
+     * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.
+     */
+    versionHistory: VersionHistory[];
+    /**
+     * Static auxiliary files that can be loaded at runtime.
+     */
+    auxiliaryFiles?: SnapAuxilaryFile[];
+    /**
+     * Localization files which are used to translate the manifest.
+     */
+    localizationFiles?: LocalizationFile[];
+    /**
+     * Flag to signal whether this snap was preinstalled or not.
+     *
+     * A lack of specifying this option will be deemed as not preinstalled.
+     */
+    preinstalled?: boolean;
+    /**
+     * Flag to signal whether this snap is removable or not.
+     *
+     * A lack of specifying this option will be deemed as removable.
+     */
+    removable?: boolean;
+    /**
+     * Flag to signal whether this snap should be hidden from the user or not.
+     */
+    hidden?: boolean;
+    /**
+     * Flag to signal whether this snap should hide the Snap branding like header or avatar in the UI or not.
+     */
+    hideSnapBranding?: boolean;
+};
+export type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version' | 'enabled' | 'blocked';
+/**
+ * Calculates the Base64-encoded SHA-256 digest of all required Snap files.
+ *
+ * @param files - All required Snap files to be included in the checksum.
+ * @returns The Base64-encoded SHA-256 digest of the source code.
+ */
+export declare function getSnapChecksum(files: FetchedSnapFiles): Promise<string>;
+/**
+ * Checks whether the `source.shasum` property of a Snap manifest matches the
+ * shasum of the snap.
+ *
+ * @param files - All required Snap files to be included in the checksum.
+ * @param errorMessage - The error message to throw if validation fails.
+ */
+export declare function validateSnapShasum(files: FetchedSnapFiles, errorMessage?: string): Promise<void>;
+export declare const LOCALHOST_HOSTNAMES: readonly ["localhost", "127.0.0.1", "[::1]"];
+export declare const BaseSnapIdStruct: Struct<string, null>;
+export declare const LocalSnapIdStruct: Struct<string, null>;
+export declare const NpmSnapIdStruct: Struct<string, null>;
+export declare const HttpSnapIdStruct: Struct<string, null>;
+export declare const SnapIdStruct: Struct<string, null>;
+/**
+ * Extracts the snap prefix from a snap ID.
+ *
+ * @param snapId - The snap ID to extract the prefix from.
+ * @returns The snap prefix from a snap id, e.g. `npm:`.
+ */
+export declare function getSnapPrefix(snapId: string): SnapIdPrefixes;
+/**
+ * Strips snap prefix from a full snap ID.
+ *
+ * @param snapId - The snap ID to strip.
+ * @returns The stripped snap ID.
+ */
+export declare function stripSnapPrefix(snapId: string): string;
+/**
+ * Assert that the given value is a valid snap ID.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a valid snap ID.
+ */
+export declare function assertIsValidSnapId(value: unknown): asserts value is SnapId;
+/**
+ * Typeguard to ensure a chainId follows the CAIP-2 standard.
+ *
+ * @param chainId - The chainId being tested.
+ * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.
+ */
+export declare function isCaipChainId(chainId: unknown): chainId is string;
+/**
+ * Utility function to check if an origin has permission (and caveat) for a particular snap.
+ *
+ * @param permissions - An origin's permissions object.
+ * @param snapId - The id of the snap.
+ * @returns A boolean based on if an origin has the specified snap.
+ */
+export declare function isSnapPermitted(permissions: SubjectPermissions<PermissionConstraint>, snapId: SnapId): boolean;
+/**
+ * Checks whether the passed in requestedPermissions is a valid
+ * permission request for a `wallet_snap` permission.
+ *
+ * @param requestedPermissions - The requested permissions.
+ * @throws If the criteria is not met.
+ */
+export declare function verifyRequestedSnapPermissions(requestedPermissions: unknown): asserts requestedPermissions is SnapsPermissionRequest;
+export type { Snap as TruncatedSnap } from "@metamask/snaps-sdk";
+//# sourceMappingURL=snaps.d.cts.map

package/dist/snaps.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snaps.d.cts","sourceRoot":"","sources":["../src/snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAClB,oBAAoB,EACrB,wCAAwC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,iCAAiC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,IAAI,aAAa,EAAE,4BAA4B;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,8BAA8B;AAoBpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAAuB;AACvD,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACZ,eAAe,EAChB,kCAA8B;AAC/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,oBAAgB;AACxE,OAAO,EAAE,cAAc,EAAO,oBAAgB;AAY9C,eAAO,MAAM,mBAAmB,QACoF,CAAC;AAErH,oBAAY,UAAU;IACpB,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAED,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,aAAa,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAC/C,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,gBAAgB,CAAA;CAAE,CAAC;AACtD,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,UAAU,CAAC;IAClB,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAE3C,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,aAAa,GAAG;IACjC;;OAEG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;;OAGG;IACH,kBAAkB,EAAE,eAAe,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,WAAW,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEvC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B,IAAI,GACJ,oBAAoB,GACpB,SAAS,GACT,SAAS,GACT,SAAS,CAAC;AAoBd;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,gBAAgB,GACtB,OAAO,CAAC,MAAM,CAAC,CAajB;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,gBAAgB,EACvB,YAAY,SAA2E,GACtF,OAAO,CAAC,IAAI,CAAC,CAIf;AAED,eAAO,MAAM,mBAAmB,8CAA+C,CAAC;AAGhF,eAAO,MAAM,gBAAgB,sBAAuC,CAAC;AASrE,eAAO,MAAM,iBAAiB,sBAc7B,CAAC;AACF,eAAO,MAAM,eAAe,sBAqBS,CAAC;AAEtC,eAAO,MAAM,gBAAgB,sBAOQ,CAAC;AAEtC,eAAO,MAAM,YAAY,sBAA8C,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAQ5D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,MAAM,CAOjE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,WAAW,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,EACrD,MAAM,EAAE,MAAM,WAWf;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,oBAAoB,EAAE,OAAO,GAC5B,OAAO,CAAC,oBAAoB,IAAI,sBAAsB,CA4BxD;AAED,YAAY,EAAE,IAAI,IAAI,aAAa,EAAE,4BAA4B"}

package/dist/snaps.d.mts

@@ -0,0 +1,174 @@
+import type { SubjectPermissions, PermissionConstraint } from "@metamask/permission-controller";
+import type { BlockReason } from "@metamask/snaps-registry";
+import type { SnapId, Snap as TruncatedSnap } from "@metamask/snaps-sdk";
+import type { Struct } from "@metamask/superstruct";
+import type { LocalizationFile } from "./localization.mjs";
+import type { InitialConnections, SnapManifest, SnapPermissions } from "./manifest/validation.mjs";
+import type { FetchedSnapFiles, SnapsPermissionRequest } from "./types.mjs";
+import { SnapIdPrefixes } from "./types.mjs";
+export declare const PROPOSED_NAME_REGEX: RegExp;
+export declare enum SnapStatus {
+    Installing = "installing",
+    Updating = "updating",
+    Running = "running",
+    Stopped = "stopped",
+    Crashed = "crashed"
+}
+export declare enum SnapStatusEvents {
+    Start = "START",
+    Stop = "STOP",
+    Crash = "CRASH",
+    Update = "UPDATE"
+}
+export type StatusContext = {
+    snapId: SnapId;
+};
+export type StatusEvents = {
+    type: SnapStatusEvents;
+};
+export type StatusStates = {
+    value: SnapStatus;
+    context: StatusContext;
+};
+export type Status = StatusStates['value'];
+export type VersionHistory = {
+    origin: string;
+    version: string;
+    date: number;
+};
+export type SnapAuxilaryFile = {
+    path: string;
+    value: string;
+};
+export type PersistedSnap = Snap;
+/**
+ * A Snap as it exists in {@link SnapController} state.
+ */
+export type Snap = TruncatedSnap & {
+    /**
+     * The initial connections of the Snap, optional, requested on installation.
+     */
+    initialConnections?: InitialConnections;
+    /**
+     * The initial permissions of the Snap, which will be requested when it is
+     * installed.
+     */
+    initialPermissions: SnapPermissions;
+    /**
+     * The source code of the Snap.
+     */
+    sourceCode: string;
+    /**
+     * The Snap's manifest file.
+     */
+    manifest: SnapManifest;
+    /**
+     * Information detailing why the snap is blocked.
+     */
+    blockInformation?: BlockReason;
+    /**
+     * The current status of the Snap, e.g. whether it's running or stopped.
+     */
+    status: Status;
+    /**
+     * The version history of the Snap.
+     * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.
+     */
+    versionHistory: VersionHistory[];
+    /**
+     * Static auxiliary files that can be loaded at runtime.
+     */
+    auxiliaryFiles?: SnapAuxilaryFile[];
+    /**
+     * Localization files which are used to translate the manifest.
+     */
+    localizationFiles?: LocalizationFile[];
+    /**
+     * Flag to signal whether this snap was preinstalled or not.
+     *
+     * A lack of specifying this option will be deemed as not preinstalled.
+     */
+    preinstalled?: boolean;
+    /**
+     * Flag to signal whether this snap is removable or not.
+     *
+     * A lack of specifying this option will be deemed as removable.
+     */
+    removable?: boolean;
+    /**
+     * Flag to signal whether this snap should be hidden from the user or not.
+     */
+    hidden?: boolean;
+    /**
+     * Flag to signal whether this snap should hide the Snap branding like header or avatar in the UI or not.
+     */
+    hideSnapBranding?: boolean;
+};
+export type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version' | 'enabled' | 'blocked';
+/**
+ * Calculates the Base64-encoded SHA-256 digest of all required Snap files.
+ *
+ * @param files - All required Snap files to be included in the checksum.
+ * @returns The Base64-encoded SHA-256 digest of the source code.
+ */
+export declare function getSnapChecksum(files: FetchedSnapFiles): Promise<string>;
+/**
+ * Checks whether the `source.shasum` property of a Snap manifest matches the
+ * shasum of the snap.
+ *
+ * @param files - All required Snap files to be included in the checksum.
+ * @param errorMessage - The error message to throw if validation fails.
+ */
+export declare function validateSnapShasum(files: FetchedSnapFiles, errorMessage?: string): Promise<void>;
+export declare const LOCALHOST_HOSTNAMES: readonly ["localhost", "127.0.0.1", "[::1]"];
+export declare const BaseSnapIdStruct: Struct<string, null>;
+export declare const LocalSnapIdStruct: Struct<string, null>;
+export declare const NpmSnapIdStruct: Struct<string, null>;
+export declare const HttpSnapIdStruct: Struct<string, null>;
+export declare const SnapIdStruct: Struct<string, null>;
+/**
+ * Extracts the snap prefix from a snap ID.
+ *
+ * @param snapId - The snap ID to extract the prefix from.
+ * @returns The snap prefix from a snap id, e.g. `npm:`.
+ */
+export declare function getSnapPrefix(snapId: string): SnapIdPrefixes;
+/**
+ * Strips snap prefix from a full snap ID.
+ *
+ * @param snapId - The snap ID to strip.
+ * @returns The stripped snap ID.
+ */
+export declare function stripSnapPrefix(snapId: string): string;
+/**
+ * Assert that the given value is a valid snap ID.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a valid snap ID.
+ */
+export declare function assertIsValidSnapId(value: unknown): asserts value is SnapId;
+/**
+ * Typeguard to ensure a chainId follows the CAIP-2 standard.
+ *
+ * @param chainId - The chainId being tested.
+ * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.
+ */
+export declare function isCaipChainId(chainId: unknown): chainId is string;
+/**
+ * Utility function to check if an origin has permission (and caveat) for a particular snap.
+ *
+ * @param permissions - An origin's permissions object.
+ * @param snapId - The id of the snap.
+ * @returns A boolean based on if an origin has the specified snap.
+ */
+export declare function isSnapPermitted(permissions: SubjectPermissions<PermissionConstraint>, snapId: SnapId): boolean;
+/**
+ * Checks whether the passed in requestedPermissions is a valid
+ * permission request for a `wallet_snap` permission.
+ *
+ * @param requestedPermissions - The requested permissions.
+ * @throws If the criteria is not met.
+ */
+export declare function verifyRequestedSnapPermissions(requestedPermissions: unknown): asserts requestedPermissions is SnapsPermissionRequest;
+export type { Snap as TruncatedSnap } from "@metamask/snaps-sdk";
+//# sourceMappingURL=snaps.d.mts.map

package/dist/snaps.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snaps.d.mts","sourceRoot":"","sources":["../src/snaps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAClB,oBAAoB,EACrB,wCAAwC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,iCAAiC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,IAAI,aAAa,EAAE,4BAA4B;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,8BAA8B;AAoBpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAAuB;AACvD,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACZ,eAAe,EAChB,kCAA8B;AAC/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,oBAAgB;AACxE,OAAO,EAAE,cAAc,EAAO,oBAAgB;AAY9C,eAAO,MAAM,mBAAmB,QACoF,CAAC;AAErH,oBAAY,UAAU;IACpB,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAED,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,aAAa,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAC/C,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,gBAAgB,CAAA;CAAE,CAAC;AACtD,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,UAAU,CAAC;IAClB,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAE3C,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,aAAa,GAAG;IACjC;;OAEG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;;OAGG;IACH,kBAAkB,EAAE,eAAe,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,WAAW,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEvC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B,IAAI,GACJ,oBAAoB,GACpB,SAAS,GACT,SAAS,GACT,SAAS,CAAC;AAoBd;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,KAAK,EAAE,gBAAgB,GACtB,OAAO,CAAC,MAAM,CAAC,CAajB;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,gBAAgB,EACvB,YAAY,SAA2E,GACtF,OAAO,CAAC,IAAI,CAAC,CAIf;AAED,eAAO,MAAM,mBAAmB,8CAA+C,CAAC;AAGhF,eAAO,MAAM,gBAAgB,sBAAuC,CAAC;AASrE,eAAO,MAAM,iBAAiB,sBAc7B,CAAC;AACF,eAAO,MAAM,eAAe,sBAqBS,CAAC;AAEtC,eAAO,MAAM,gBAAgB,sBAOQ,CAAC;AAEtC,eAAO,MAAM,YAAY,sBAA8C,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAQ5D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,MAAM,CAOjE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,WAAW,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,EACrD,MAAM,EAAE,MAAM,WAWf;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,oBAAoB,EAAE,OAAO,GAC5B,OAAO,CAAC,oBAAoB,IAAI,sBAAsB,CA4BxD;AAED,YAAY,EAAE,IAAI,IAAI,aAAa,EAAE,4BAA4B"}

package/dist/snaps.mjs

@@ -1,46 +1,201 @@
-import {
-  BaseSnapIdStruct,
-  HttpSnapIdStruct,
-  LOCALHOST_HOSTNAMES,
-  LocalSnapIdStruct,
-  NpmSnapIdStruct,
-  PROPOSED_NAME_REGEX,
-  SnapIdStruct,
-  SnapStatus,
-  SnapStatusEvents,
-  assertIsValidSnapId,
-  getSnapChecksum,
-  getSnapPrefix,
-  isCaipChainId,
-  isSnapPermitted,
-  stripSnapPrefix,
-  validateSnapShasum,
-  verifyRequestedSnapPermissions
-} from "./chunk-NSVVZNSD.mjs";
-import "./chunk-N2JAYIUP.mjs";
-import "./chunk-7LG4D4XA.mjs";
-import "./chunk-XF2AZMWG.mjs";
-import "./chunk-3S4INAGA.mjs";
-import "./chunk-DE22V5AO.mjs";
-import "./chunk-Z2JQNSVL.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  BaseSnapIdStruct,
-  HttpSnapIdStruct,
-  LOCALHOST_HOSTNAMES,
-  LocalSnapIdStruct,
-  NpmSnapIdStruct,
-  PROPOSED_NAME_REGEX,
-  SnapIdStruct,
-  SnapStatus,
-  SnapStatusEvents,
-  assertIsValidSnapId,
-  getSnapChecksum,
-  getSnapPrefix,
-  isCaipChainId,
-  isSnapPermitted,
-  stripSnapPrefix,
-  validateSnapShasum,
-  verifyRequestedSnapPermissions
-};
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import { empty, enums, intersection, literal, pattern, refine, string, union, validate } from "@metamask/superstruct";
+import { assert, isObject, assertStruct } from "@metamask/utils";
+import { base64 } from "@scure/base";
+import $stableStringify from "fast-json-stable-stringify";
+const stableStringify = $importDefault($stableStringify);
+import $validateNPMPackage from "validate-npm-package-name";
+const validateNPMPackage = $importDefault($validateNPMPackage);
+import { SnapCaveatType } from "./caveats.mjs";
+import { checksumFiles } from "./checksum.mjs";
+import { SnapIdPrefixes, uri } from "./types.mjs";
+// This RegEx matches valid npm package names (with some exceptions) and space-
+// separated alphanumerical words, optionally with dashes and underscores.
+// The RegEx consists of two parts. The first part matches space-separated
+// words. It is based on the following Stackoverflow answer:
+// https://stackoverflow.com/a/34974982
+// The second part, after the pipe operator, is the same RegEx used for the
+// `name` field of the official package.json JSON Schema, except that we allow
+// mixed-case letters. It was originally copied from:
+// https://github.com/SchemaStore/schemastore/blob/81a16897c1dabfd98c72242a5fd62eb080ff76d8/src/schemas/json/package.json#L132-L138
+export const PROPOSED_NAME_REGEX = /^(?:[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;
+export var SnapStatus;
+(function (SnapStatus) {
+    SnapStatus["Installing"] = "installing";
+    SnapStatus["Updating"] = "updating";
+    SnapStatus["Running"] = "running";
+    SnapStatus["Stopped"] = "stopped";
+    SnapStatus["Crashed"] = "crashed";
+})(SnapStatus || (SnapStatus = {}));
+export var SnapStatusEvents;
+(function (SnapStatusEvents) {
+    SnapStatusEvents["Start"] = "START";
+    SnapStatusEvents["Stop"] = "STOP";
+    SnapStatusEvents["Crash"] = "CRASH";
+    SnapStatusEvents["Update"] = "UPDATE";
+})(SnapStatusEvents || (SnapStatusEvents = {}));
+/**
+ * Gets a checksummable manifest by removing the shasum property and reserializing the JSON using a deterministic algorithm.
+ *
+ * @param manifest - The manifest itself.
+ * @returns A virtual file containing the checksummable manifest.
+ */
+function getChecksummableManifest(manifest) {
+    const manifestCopy = manifest.clone();
+    delete manifestCopy.result.source.shasum;
+    // We use fast-json-stable-stringify to deterministically serialize the JSON
+    // This is required before checksumming so we get reproducible checksums across platforms etc
+    manifestCopy.value = stableStringify(manifestCopy.result);
+    return manifestCopy;
+}
+/**
+ * Calculates the Base64-encoded SHA-256 digest of all required Snap files.
+ *
+ * @param files - All required Snap files to be included in the checksum.
+ * @returns The Base64-encoded SHA-256 digest of the source code.
+ */
+export async function getSnapChecksum(files) {
+    const { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles } = files;
+    const all = [
+        getChecksummableManifest(manifest),
+        sourceCode,
+        svgIcon,
+        ...auxiliaryFiles,
+        ...localizationFiles,
+    ].filter((file) => file !== undefined);
+    return base64.encode(await checksumFiles(all));
+}
+/**
+ * Checks whether the `source.shasum` property of a Snap manifest matches the
+ * shasum of the snap.
+ *
+ * @param files - All required Snap files to be included in the checksum.
+ * @param errorMessage - The error message to throw if validation fails.
+ */
+export async function validateSnapShasum(files, errorMessage = 'Invalid Snap manifest: manifest shasum does not match computed shasum.') {
+    if (files.manifest.result.source.shasum !== (await getSnapChecksum(files))) {
+        throw new Error(errorMessage);
+    }
+}
+export const LOCALHOST_HOSTNAMES = ['localhost', '127.0.0.1', '[::1]'];
+// Require snap ids to only consist of printable ASCII characters
+export const BaseSnapIdStruct = pattern(string(), /^[\x21-\x7E]*$/u);
+const LocalSnapIdSubUrlStruct = uri({
+    protocol: enums(['http:', 'https:']),
+    hostname: enums(LOCALHOST_HOSTNAMES),
+    hash: empty(string()),
+    search: empty(string()),
+});
+export const LocalSnapIdStruct = refine(BaseSnapIdStruct, 'local Snap Id', (value) => {
+    if (!value.startsWith(SnapIdPrefixes.local)) {
+        return `Expected local snap ID, got "${value}".`;
+    }
+    const [error] = validate(value.slice(SnapIdPrefixes.local.length), LocalSnapIdSubUrlStruct);
+    return error ?? true;
+});
+export const NpmSnapIdStruct = intersection([
+    BaseSnapIdStruct,
+    uri({
+        protocol: literal(SnapIdPrefixes.npm),
+        pathname: refine(string(), 'package name', function* (value) {
+            const normalized = value.startsWith('/') ? value.slice(1) : value;
+            const { errors, validForNewPackages, warnings } = validateNPMPackage(normalized);
+            if (!validForNewPackages) {
+                if (errors === undefined) {
+                    assert(warnings !== undefined);
+                    yield* warnings;
+                }
+                else {
+                    yield* errors;
+                }
+            }
+            return true;
+        }),
+        search: empty(string()),
+        hash: empty(string()),
+    }),
+]);
+export const HttpSnapIdStruct = intersection([
+    BaseSnapIdStruct,
+    uri({
+        protocol: enums(['http:', 'https:']),
+        search: empty(string()),
+        hash: empty(string()),
+    }),
+]);
+export const SnapIdStruct = union([NpmSnapIdStruct, LocalSnapIdStruct]);
+/**
+ * Extracts the snap prefix from a snap ID.
+ *
+ * @param snapId - The snap ID to extract the prefix from.
+ * @returns The snap prefix from a snap id, e.g. `npm:`.
+ */
+export function getSnapPrefix(snapId) {
+    const prefix = Object.values(SnapIdPrefixes).find((possiblePrefix) => snapId.startsWith(possiblePrefix));
+    if (prefix !== undefined) {
+        return prefix;
+    }
+    throw new Error(`Invalid or no prefix found for "${snapId}"`);
+}
+/**
+ * Strips snap prefix from a full snap ID.
+ *
+ * @param snapId - The snap ID to strip.
+ * @returns The stripped snap ID.
+ */
+export function stripSnapPrefix(snapId) {
+    return snapId.replace(getSnapPrefix(snapId), '');
+}
+/**
+ * Assert that the given value is a valid snap ID.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a valid snap ID.
+ */
+export function assertIsValidSnapId(value) {
+    assertStruct(value, SnapIdStruct, 'Invalid snap ID');
+}
+/**
+ * Typeguard to ensure a chainId follows the CAIP-2 standard.
+ *
+ * @param chainId - The chainId being tested.
+ * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.
+ */
+export function isCaipChainId(chainId) {
+    return (typeof chainId === 'string' &&
+        /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(chainId));
+}
+/**
+ * Utility function to check if an origin has permission (and caveat) for a particular snap.
+ *
+ * @param permissions - An origin's permissions object.
+ * @param snapId - The id of the snap.
+ * @returns A boolean based on if an origin has the specified snap.
+ */
+export function isSnapPermitted(permissions, snapId) {
+    return Boolean((permissions?.wallet_snap?.caveats?.find((caveat) => caveat.type === SnapCaveatType.SnapIds) ?? {}).value?.[snapId]);
+}
+/**
+ * Checks whether the passed in requestedPermissions is a valid
+ * permission request for a `wallet_snap` permission.
+ *
+ * @param requestedPermissions - The requested permissions.
+ * @throws If the criteria is not met.
+ */
+export function verifyRequestedSnapPermissions(requestedPermissions) {
+    assert(isObject(requestedPermissions), 'Requested permissions must be an object.');
+    const { wallet_snap: walletSnapPermission } = requestedPermissions;
+    assert(isObject(walletSnapPermission), 'wallet_snap is missing from the requested permissions.');
+    const { caveats } = walletSnapPermission;
+    assert(Array.isArray(caveats) && caveats.length === 1, 'wallet_snap must have a caveat property with a single-item array value.');
+    const [caveat] = caveats;
+    assert(isObject(caveat) &&
+        caveat.type === SnapCaveatType.SnapIds &&
+        isObject(caveat.value), `The requested permissions do not have a valid ${SnapCaveatType.SnapIds} caveat.`);
+}
 //# sourceMappingURL=snaps.mjs.map