@metamask/snaps-utils 8.0.1 → 8.1.1

package/dist/snaps.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"snaps.mjs","sourceRoot":"","sources":["../src/snaps.ts"],"names":[],"mappings":";;;;;;AAQA,OAAO,EACL,KAAK,EACL,KAAK,EACL,YAAY,EACZ,OAAO,EACP,OAAO,EACP,MAAM,EACN,MAAM,EACN,KAAK,EACL,QAAQ,EACT,8BAA8B;AAE/B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,wBAAwB;AACjE,OAAO,EAAE,MAAM,EAAE,oBAAoB;AACrC,OAAO,gBAAe,mCAAmC;;AACzD,OAAO,mBAAkB,kCAAkC;;AAE3D,OAAO,EAAE,cAAc,EAAE,sBAAkB;AAC3C,OAAO,EAAE,aAAa,EAAE,uBAAmB;AAQ3C,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,oBAAgB;AAG9C,+EAA+E;AAC/E,0EAA0E;AAC1E,0EAA0E;AAC1E,4DAA4D;AAC5D,uCAAuC;AACvC,2EAA2E;AAC3E,8EAA8E;AAC9E,qDAAqD;AACrD,mIAAmI;AACnI,MAAM,CAAC,MAAM,mBAAmB,GAC9B,kHAAkH,CAAC;AAErH,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,uCAAyB,CAAA;IACzB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EALW,gBAAgB,KAAhB,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,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,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,MAAM,CAAC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAoB,CAAC,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,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;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAU,CAAC;AAEhF,iEAAiE;AACjE,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC;AAErE,MAAM,uBAAuB,GAAG,GAAG,CAAC;IAClC,QAAQ,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpC,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC;IACpC,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CACrC,gBAAgB,EAChB,eAAe,EACf,CAAC,KAAK,EAAE,EAAE;IACR,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO,gCAAgC,KAAK,IAAI,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,CACtB,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,EACxC,uBAAuB,CACxB,CAAC;IACF,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CACF,CAAC;AACF,MAAM,CAAC,MAAM,eAAe,GAAG,YAAY,CAAC;IAC1C,gBAAgB;IAChB,GAAG,CAAC;QACF,QAAQ,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC;QACrC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,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,kBAAkB,CAAC,UAAU,CAAC,CAAC;YACjC,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,MAAM,CAAC,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,KAAK,CAAC,MAAM,EAAE,CAAC;QACvB,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;KACtB,CAAC;CACH,CAAoC,CAAC;AAEtC,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAAC;IAC3C,gBAAgB;IAChB,GAAG,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;QACvB,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;KACtB,CAAC;CACH,CAAoC,CAAC;AAEtC,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,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;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc;IAC5C,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAc;IAChD,YAAY,CAAC,KAAK,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,OAAgB;IAC5C,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ;QAC3B,kEAAkE,CAAC,IAAI,CACrE,OAAO,CACR,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,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,cAAc,CAAC,OAAO,CACnD,IAAI,EAAE,CACR,CAAC,KACH,EAAE,CAAC,MAAM,CAAC,CACZ,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,8BAA8B,CAC5C,oBAA6B;IAE7B,MAAM,CACJ,QAAQ,CAAC,oBAAoB,CAAC,EAC9B,0CAA0C,CAC3C,CAAC;IAEF,MAAM,EAAE,WAAW,EAAE,oBAAoB,EAAE,GAAG,oBAAoB,CAAC;IAEnE,MAAM,CACJ,QAAQ,CAAC,oBAAoB,CAAC,EAC9B,wDAAwD,CACzD,CAAC;IAEF,MAAM,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC;IAEzC,MAAM,CACJ,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,MAAM,CACJ,QAAQ,CAAC,MAAM,CAAC;QACd,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO;QACtC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EACxB,iDAAiD,cAAc,CAAC,OAAO,UAAU,CAClF,CAAC;AACJ,CAAC","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/strings.cjs

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.indent = void 0;
+/**
+ * Indent a message by adding a number of spaces to the beginning of each line.
+ *
+ * @param message - The message to indent.
+ * @param spaces - The number of spaces to indent by. Defaults to 2.
+ * @returns The indented message.
+ */
+function indent(message, spaces = 2) {
+    return message.replace(/^/gmu, ' '.repeat(spaces));
+}
+exports.indent = indent;
+//# sourceMappingURL=strings.cjs.map

package/dist/strings.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings.cjs","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,SAAgB,MAAM,CAAC,OAAe,EAAE,MAAM,GAAG,CAAC;IAChD,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AACrD,CAAC;AAFD,wBAEC","sourcesContent":["/**\n * Indent a message by adding a number of spaces to the beginning of each line.\n *\n * @param message - The message to indent.\n * @param spaces - The number of spaces to indent by. Defaults to 2.\n * @returns The indented message.\n */\nexport function indent(message: string, spaces = 2) {\n  return message.replace(/^/gmu, ' '.repeat(spaces));\n}\n"]}

package/dist/strings.d.cts

@@ -0,0 +1,9 @@
+/**
+ * Indent a message by adding a number of spaces to the beginning of each line.
+ *
+ * @param message - The message to indent.
+ * @param spaces - The number of spaces to indent by. Defaults to 2.
+ * @returns The indented message.
+ */
+export declare function indent(message: string, spaces?: number): string;
+//# sourceMappingURL=strings.d.cts.map

package/dist/strings.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings.d.cts","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAI,UAEjD"}

package/dist/strings.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Indent a message by adding a number of spaces to the beginning of each line.
+ *
+ * @param message - The message to indent.
+ * @param spaces - The number of spaces to indent by. Defaults to 2.
+ * @returns The indented message.
+ */
+export declare function indent(message: string, spaces?: number): string;
+//# sourceMappingURL=strings.d.mts.map

package/dist/strings.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings.d.mts","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAI,UAEjD"}

package/dist/strings.mjs

@@ -1,8 +1,11 @@
-import {
-  indent
-} from "./chunk-IV3FSWZ7.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  indent
-};
+/**
+ * Indent a message by adding a number of spaces to the beginning of each line.
+ *
+ * @param message - The message to indent.
+ * @param spaces - The number of spaces to indent by. Defaults to 2.
+ * @returns The indented message.
+ */
+export function indent(message, spaces = 2) {
+    return message.replace(/^/gmu, ' '.repeat(spaces));
+}
 //# sourceMappingURL=strings.mjs.map

package/dist/strings.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"strings.mjs","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,OAAe,EAAE,MAAM,GAAG,CAAC;IAChD,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AACrD,CAAC","sourcesContent":["/**\n * Indent a message by adding a number of spaces to the beginning of each line.\n *\n * @param message - The message to indent.\n * @param spaces - The number of spaces to indent by. Defaults to 2.\n * @returns The indented message.\n */\nexport function indent(message: string, spaces = 2) {\n  return message.replace(/^/gmu, ' '.repeat(spaces));\n}\n"]}

package/dist/structs.cjs

@@ -0,0 +1,316 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeStructs = exports.createUnion = exports.validateUnion = exports.getStructErrorMessage = exports.getStructFailureMessage = exports.getStructErrorPrefix = exports.getUnionStructNames = exports.getStructFromPath = exports.createFromStruct = exports.getError = exports.arrayToGenerator = exports.SnapsStructError = exports.named = void 0;
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const chalk_1 = require("chalk");
+const strings_1 = require("./strings.cjs");
+/**
+ * Colorize a value with a color function. This is useful for colorizing values
+ * in error messages. If colorization is disabled, the original value is
+ * returned.
+ *
+ * @param value - The value to colorize.
+ * @param colorFunction - The color function to use.
+ * @param enabled - Whether to colorize the value.
+ * @returns The colorized value, or the original value if colorization is
+ * disabled.
+ */
+function color(value, colorFunction, enabled) {
+    if (enabled) {
+        return colorFunction(value);
+    }
+    return value;
+}
+/**
+ * Define a struct, and also define the name of the struct as the given name.
+ *
+ * This is useful for improving the error messages returned by `superstruct`.
+ *
+ * @param name - The name of the struct.
+ * @param struct - The struct.
+ * @returns The struct.
+ */
+function named(name, struct) {
+    return new superstruct_1.Struct({
+        ...struct,
+        type: name,
+    });
+}
+exports.named = named;
+class SnapsStructError extends superstruct_1.StructError {
+    constructor(struct, prefix, suffix, failure, failures, colorize = true) {
+        super(failure, failures);
+        this.name = 'SnapsStructError';
+        this.message = `${prefix}.\n\n${getStructErrorMessage(struct, [...failures()], colorize)}${suffix ? `\n\n${suffix}` : ''}`;
+    }
+}
+exports.SnapsStructError = SnapsStructError;
+/**
+ * Converts an array to a generator function that yields the items in the
+ * array.
+ *
+ * @param array - The array.
+ * @returns A generator function.
+ * @yields The items in the array.
+ */
+function* arrayToGenerator(array) {
+    for (const item of array) {
+        yield item;
+    }
+}
+exports.arrayToGenerator = arrayToGenerator;
+/**
+ * Returns a `SnapsStructError` with the given prefix and suffix.
+ *
+ * @param options - The options.
+ * @param options.struct - The struct that caused the error.
+ * @param options.prefix - The prefix to add to the error message.
+ * @param options.suffix - The suffix to add to the error message. Defaults to
+ * an empty string.
+ * @param options.error - The `superstruct` error to wrap.
+ * @param options.colorize - Whether to colorize the value. Defaults to `true`.
+ * @returns The `SnapsStructError`.
+ */
+function getError({ struct, prefix, suffix = '', error, colorize, }) {
+    return new SnapsStructError(struct, prefix, suffix, error, () => arrayToGenerator(error.failures()), colorize);
+}
+exports.getError = getError;
+/**
+ * A wrapper of `superstruct`'s `create` function that throws a
+ * `SnapsStructError` instead of a `StructError`. This is useful for improving
+ * the error messages returned by `superstruct`.
+ *
+ * @param value - The value to validate.
+ * @param struct - The `superstruct` struct to validate the value against.
+ * @param prefix - The prefix to add to the error message.
+ * @param suffix - The suffix to add to the error message. Defaults to an empty
+ * string.
+ * @returns The validated value.
+ */
+function createFromStruct(value, struct, prefix, suffix = '') {
+    try {
+        return (0, superstruct_1.create)(value, struct);
+    }
+    catch (error) {
+        if (error instanceof superstruct_1.StructError) {
+            throw getError({ struct, prefix, suffix, error });
+        }
+        throw error;
+    }
+}
+exports.createFromStruct = createFromStruct;
+/**
+ * Get a struct from a failure path.
+ *
+ * @param struct - The struct.
+ * @param path - The failure path.
+ * @returns The struct at the failure path.
+ */
+function getStructFromPath(struct, path) {
+    return path.reduce((result, key) => {
+        if ((0, utils_1.isObject)(struct.schema) && struct.schema[key]) {
+            return struct.schema[key];
+        }
+        return result;
+    }, struct);
+}
+exports.getStructFromPath = getStructFromPath;
+/**
+ * Get the union struct names from a struct.
+ *
+ * @param struct - The struct.
+ * @param colorize - Whether to colorize the value. Defaults to `true`.
+ * @returns The union struct names, or `null` if the struct is not a union
+ * struct.
+ */
+function getUnionStructNames(struct, colorize = true) {
+    if (Array.isArray(struct.schema)) {
+        return struct.schema.map(({ type }) => color(type, chalk_1.green, colorize));
+    }
+    return null;
+}
+exports.getUnionStructNames = getUnionStructNames;
+/**
+ * Get an error prefix from a `superstruct` failure. This is useful for
+ * formatting the error message returned by `superstruct`.
+ *
+ * @param failure - The `superstruct` failure.
+ * @param colorize - Whether to colorize the value. Defaults to `true`.
+ * @returns The error prefix.
+ */
+function getStructErrorPrefix(failure, colorize = true) {
+    if (failure.type === 'never' || failure.path.length === 0) {
+        return '';
+    }
+    return `At path: ${color(failure.path.join('.'), chalk_1.bold, colorize)} — `;
+}
+exports.getStructErrorPrefix = getStructErrorPrefix;
+/**
+ * Get a string describing the failure. This is similar to the `message`
+ * property of `superstruct`'s `Failure` type, but formats the value in a more
+ * readable way.
+ *
+ * @param struct - The struct that caused the failure.
+ * @param failure - The `superstruct` failure.
+ * @param colorize - Whether to colorize the value. Defaults to `true`.
+ * @returns A string describing the failure.
+ */
+function getStructFailureMessage(struct, failure, colorize = true) {
+    const received = color(JSON.stringify(failure.value), chalk_1.red, colorize);
+    const prefix = getStructErrorPrefix(failure, colorize);
+    if (failure.type === 'union') {
+        const childStruct = getStructFromPath(struct, failure.path);
+        const unionNames = getUnionStructNames(childStruct, colorize);
+        if (unionNames) {
+            return `${prefix}Expected the value to be one of: ${unionNames.join(', ')}, but received: ${received}.`;
+        }
+        return `${prefix}${failure.message}.`;
+    }
+    if (failure.type === 'literal') {
+        // Superstruct's failure does not provide information about which literal
+        // value was expected, so we need to parse the message to get the literal.
+        const message = failure.message
+            .replace(/the literal `(.+)`,/u, `the value to be \`${color('$1', chalk_1.green, colorize)}\`,`)
+            .replace(/, but received: (.+)/u, `, but received: ${color('$1', chalk_1.red, colorize)}`);
+        return `${prefix}${message}.`;
+    }
+    if (failure.type === 'never') {
+        return `Unknown key: ${color(failure.path.join('.'), chalk_1.bold, colorize)}, received: ${received}.`;
+    }
+    if (failure.refinement === 'size') {
+        const message = failure.message
+            .replace(/length between `(\d+)` and `(\d+)`/u, `length between ${color('$1', chalk_1.green, colorize)} and ${color('$2', chalk_1.green, colorize)},`)
+            .replace(/length of `(\d+)`/u, `length of ${color('$1', chalk_1.red, colorize)}`)
+            .replace(/a array/u, 'an array');
+        return `${prefix}${message}.`;
+    }
+    // Refinements we built ourselves have nice error messages
+    if (failure.refinement !== undefined) {
+        return `${prefix}${failure.message}.`;
+    }
+    return `${prefix}Expected a value of type ${color(failure.type, chalk_1.green, colorize)}, but received: ${received}.`;
+}
+exports.getStructFailureMessage = getStructFailureMessage;
+/**
+ * Get a string describing the errors. This formats all the errors in a
+ * human-readable way.
+ *
+ * @param struct - The struct that caused the failures.
+ * @param failures - The `superstruct` failures.
+ * @param colorize - Whether to colorize the value. Defaults to `true`.
+ * @returns A string describing the errors.
+ */
+function getStructErrorMessage(struct, failures, colorize = true) {
+    const formattedFailures = failures.map((failure) => (0, strings_1.indent)(`• ${getStructFailureMessage(struct, failure, colorize)}`));
+    return formattedFailures.join('\n');
+}
+exports.getStructErrorMessage = getStructErrorMessage;
+/**
+ * Validate a union struct, and throw readable errors if the value does not
+ * satisfy the struct. This is useful for improving the error messages returned
+ * by `superstruct`.
+ *
+ * @param value - The value to validate.
+ * @param struct - The `superstruct` union struct to validate the value against.
+ * This struct must be a union of object structs, and must have at least one
+ * shared key to validate against.
+ * @param structKey - The key to validate against. This key must be present in
+ * all the object structs in the union struct, and is expected to be a literal
+ * value.
+ * @param coerce - Whether to coerce the value to satisfy the struct. Defaults
+ * to `false`.
+ * @returns The validated value.
+ * @throws If the value does not satisfy the struct.
+ * @example
+ * const struct = union([
+ *   object({ type: literal('a'), value: string() }),
+ *   object({ type: literal('b'), value: number() }),
+ *   object({ type: literal('c'), value: boolean() }),
+ *   // ...
+ * ]);
+ *
+ * // At path: type — Expected the value to be one of: "a", "b", "c", but received: "d".
+ * validateUnion({ type: 'd', value: 'foo' }, struct, 'type');
+ *
+ * // At path: value — Expected a value of type string, but received: 42.
+ * validateUnion({ type: 'a', value: 42 }, struct, 'value');
+ */
+function validateUnion(value, struct, structKey, coerce = false) {
+    (0, utils_1.assert)(struct.schema, 'Expected a struct with a schema. Make sure to use `union` from `@metamask/snaps-sdk`.');
+    (0, utils_1.assert)(struct.schema.length > 0, 'Expected a non-empty array of structs.');
+    const keyUnion = struct.schema.map((innerStruct) => innerStruct.schema[structKey]);
+    const key = (0, superstruct_1.type)({
+        [structKey]: (0, snaps_sdk_1.union)(keyUnion),
+    });
+    const [keyError] = (0, superstruct_1.validate)(value, key, { coerce });
+    if (keyError) {
+        throw new Error(getStructFailureMessage(key, keyError.failures()[0], false));
+    }
+    // At this point it's guaranteed that the value is an object, so we can safely
+    // cast it to a Record.
+    const objectValue = value;
+    const objectStructs = struct.schema.filter((innerStruct) => (0, superstruct_1.is)(objectValue[structKey], innerStruct.schema[structKey]));
+    (0, utils_1.assert)(objectStructs.length > 0, 'Expected a struct to match the value.');
+    // We need to validate the value against all the object structs that match the
+    // struct key, and return the first validated value.
+    const validationResults = objectStructs.map((objectStruct) => (0, superstruct_1.validate)(objectValue, objectStruct, { coerce }));
+    const validatedValue = validationResults.find(([error]) => !error);
+    if (validatedValue) {
+        return validatedValue[1];
+    }
+    (0, utils_1.assert)(validationResults[0][0], 'Expected at least one error.');
+    // If there is no validated value, we need to find the error with the least
+    // number of failures (with the assumption that it's the most specific error).
+    const validationError = validationResults.reduce((error, [innerError]) => {
+        (0, utils_1.assert)(innerError, 'Expected an error.');
+        if (innerError.failures().length < error.failures().length) {
+            return innerError;
+        }
+        return error;
+    }, validationResults[0][0]);
+    throw new Error(getStructFailureMessage(struct, validationError.failures()[0], false));
+}
+exports.validateUnion = validateUnion;
+/**
+ * Create a value with the coercion logic of a union struct, and throw readable
+ * errors if the value does not satisfy the struct. This is useful for improving
+ * the error messages returned by `superstruct`.
+ *
+ * @param value - The value to validate.
+ * @param struct - The `superstruct` union struct to validate the value against.
+ * This struct must be a union of object structs, and must have at least one
+ * shared key to validate against.
+ * @param structKey - The key to validate against. This key must be present in
+ * all the object structs in the union struct, and is expected to be a literal
+ * value.
+ * @returns The validated value.
+ * @throws If the value does not satisfy the struct.
+ * @see validateUnion
+ */
+function createUnion(value, struct, structKey) {
+    return validateUnion(value, struct, structKey, true);
+}
+exports.createUnion = createUnion;
+/**
+ * Merge multiple structs into one, using superstruct `assign`.
+ *
+ * Differently from plain `assign`, this function also copies over refinements from each struct.
+ *
+ * @param structs - The `superstruct` structs to merge.
+ * @returns The merged struct.
+ */
+function mergeStructs(...structs) {
+    const mergedStruct = superstruct_1.assign(...structs);
+    return new superstruct_1.Struct({
+        ...mergedStruct,
+        *refiner(value, ctx) {
+            for (const struct of structs) {
+                yield* struct.refiner(value, ctx);
+            }
+        },
+    });
+}
+exports.mergeStructs = mergeStructs;
+//# sourceMappingURL=structs.cjs.map

package/dist/structs.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"structs.cjs","sourceRoot":"","sources":["../src/structs.ts"],"names":[],"mappings":";;;AAAA,mDAA4C;AAQ5C,uDAQ+B;AAE/B,2CAAmD;AACnD,iCAAyC;AAEzC,2CAAmC;AA6BnC;;;;;;;;;;GAUG;AACH,SAAS,KAAK,CACZ,KAAa,EACb,aAAwC,EACxC,OAAgB;IAEhB,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,KAAK,CACnB,IAAY,EACZ,MAA4B;IAE5B,OAAO,IAAI,oBAAM,CAAC;QAChB,GAAG,MAAM;QACT,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;AACL,CAAC;AARD,sBAQC;AAED,MAAa,gBAA+B,SAAQ,yBAAW;IAC7D,YACE,MAA4B,EAC5B,MAAc,EACd,MAAc,EACd,OAAoB,EACpB,QAAkC,EAClC,QAAQ,GAAG,IAAI;QAEf,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEzB,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,GAAG,MAAM,QAAQ,qBAAqB,CACnD,MAAM,EACN,CAAC,GAAG,QAAQ,EAAE,CAAC,EACf,QAAQ,CACT,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACtC,CAAC;CACF;AAlBD,4CAkBC;AAUD;;;;;;;GAOG;AACH,QAAe,CAAC,CAAC,gBAAgB,CAC/B,KAAa;IAEb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,CAAC;IACb,CAAC;AACH,CAAC;AAND,4CAMC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,QAAQ,CAAe,EACrC,MAAM,EACN,MAAM,EACN,MAAM,GAAG,EAAE,EACX,KAAK,EACL,QAAQ,GACsB;IAC9B,OAAO,IAAI,gBAAgB,CACzB,MAAM,EACN,MAAM,EACN,MAAM,EACN,KAAK,EACL,GAAG,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,EACxC,QAAQ,CACT,CAAC;AACJ,CAAC;AAfD,4BAeC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAC9B,KAAc,EACd,MAA4B,EAC5B,MAAc,EACd,MAAM,GAAG,EAAE;IAEX,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAfD,4CAeC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,MAA4B,EAC5B,IAAc;IAEd,OAAO,IAAI,CAAC,MAAM,CAAY,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QAC5C,IAAI,IAAA,gBAAQ,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAClD,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAc,CAAC;QACzC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,MAAM,CAAC,CAAC;AACb,CAAC;AAXD,8CAWC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,MAA4B,EAC5B,QAAQ,GAAG,IAAI;IAEf,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,aAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAAC,OAAgB,EAAE,QAAQ,GAAG,IAAI;IACpE,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,YAAY,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,YAAI,EAAE,QAAQ,CAAC,KAAK,CAAC;AACxE,CAAC;AAND,oDAMC;AAED;;;;;;;;;GASG;AACH,SAAgB,uBAAuB,CACrC,MAA4B,EAC5B,OAAgB,EAChB,QAAQ,GAAG,IAAI;IAEf,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,WAAG,EAAE,QAAQ,CAAC,CAAC;IACrE,MAAM,MAAM,GAAG,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEvD,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC7B,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,UAAU,GAAG,mBAAmB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAE9D,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,GAAG,MAAM,oCAAoC,UAAU,CAAC,IAAI,CACjE,IAAI,CACL,mBAAmB,QAAQ,GAAG,CAAC;QAClC,CAAC;QAED,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,CAAC;IACxC,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,yEAAyE;QACzE,0EAA0E;QAC1E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO;aAC5B,OAAO,CACN,sBAAsB,EACtB,qBAAqB,KAAK,CAAC,IAAI,EAAE,aAAK,EAAE,QAAQ,CAAC,KAAK,CACvD;aACA,OAAO,CACN,uBAAuB,EACvB,mBAAmB,KAAK,CAAC,IAAI,EAAE,WAAG,EAAE,QAAQ,CAAC,EAAE,CAChD,CAAC;QAEJ,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC;IAChC,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC7B,OAAO,gBAAgB,KAAK,CAC1B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EACtB,YAAI,EACJ,QAAQ,CACT,eAAe,QAAQ,GAAG,CAAC;IAC9B,CAAC;IAED,IAAI,OAAO,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO;aAC5B,OAAO,CACN,qCAAqC,EACrC,kBAAkB,KAAK,CAAC,IAAI,EAAE,aAAK,EAAE,QAAQ,CAAC,QAAQ,KAAK,CACzD,IAAI,EACJ,aAAK,EACL,QAAQ,CACT,GAAG,CACL;aACA,OAAO,CAAC,oBAAoB,EAAE,aAAa,KAAK,CAAC,IAAI,EAAE,WAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;aACxE,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEnC,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC;IAChC,CAAC;IAED,0DAA0D;IAC1D,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACrC,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,CAAC;IACxC,CAAC;IAED,OAAO,GAAG,MAAM,4BAA4B,KAAK,CAC/C,OAAO,CAAC,IAAI,EACZ,aAAK,EACL,QAAQ,CACT,mBAAmB,QAAQ,GAAG,CAAC;AAClC,CAAC;AAvED,0DAuEC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,MAA4B,EAC5B,QAAmB,EACnB,QAAQ,GAAG,IAAI;IAEf,MAAM,iBAAiB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,IAAA,gBAAM,EAAC,KAAK,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC,CAClE,CAAC;IAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC;AAVD,sDAUC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,aAAa,CAC3B,KAAc,EACd,MAA4B,EAC5B,SAAqB,EACrB,MAAM,GAAG,KAAK;IAEd,IAAA,cAAM,EACJ,MAAM,CAAC,MAAM,EACb,uFAAuF,CACxF,CAAC;IACF,IAAA,cAAM,EAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,wCAAwC,CAAC,CAAC;IAE3E,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAChC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAItB,CAAC;IAE3B,MAAM,GAAG,GAAG,IAAA,kBAAe,EAAC;QAC1B,CAAC,SAAS,CAAC,EAAE,IAAA,iBAAK,EAAC,QAAQ,CAAC;KAC7B,CAAC,CAAC;IAEH,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAA,sBAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACpD,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,uBAAuB,CAAC,GAAG,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAC5D,CAAC;IACJ,CAAC;IAED,8EAA8E;IAC9E,uBAAuB;IACvB,MAAM,WAAW,GAAG,KAAqC,CAAC;IAC1D,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CACzD,IAAA,gBAAE,EAAC,WAAW,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAC1D,CAAC;IAEF,IAAA,cAAM,EAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,uCAAuC,CAAC,CAAC;IAE1E,8EAA8E;IAC9E,oDAAoD;IACpD,MAAM,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAC3D,IAAA,sBAAQ,EAAC,WAAW,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAChD,CAAC;IAEF,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACnE,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,IAAA,cAAM,EAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,8BAA8B,CAAC,CAAC;IAEhE,2EAA2E;IAC3E,8EAA8E;IAC9E,MAAM,eAAe,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE;QACvE,IAAA,cAAM,EAAC,UAAU,EAAE,oBAAoB,CAAC,CAAC;QACzC,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC3D,OAAO,UAAU,CAAC;QACpB,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5B,MAAM,IAAI,KAAK,CACb,uBAAuB,CAAC,MAAM,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CACtE,CAAC;AACJ,CAAC;AAlED,sCAkEC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,WAAW,CACzB,KAAc,EACd,MAA4B,EAC5B,SAAqB;IAErB,OAAO,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACvD,CAAC;AAND,kCAMC;AAuDD;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,GAAG,OAAsB;IACpD,MAAM,YAAY,GAAI,oBAAgD,CACpE,GAAG,OAAO,CACX,CAAC;IACF,OAAO,IAAI,oBAAM,CAAC;QAChB,GAAG,YAAY;QACf,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG;YACjB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAZD,oCAYC","sourcesContent":["import { union } from '@metamask/snaps-sdk';\nimport type {\n  AnyStruct,\n  Assign,\n  Failure,\n  ObjectSchema,\n  ObjectType,\n} from '@metamask/superstruct';\nimport {\n  assign,\n  is,\n  validate,\n  type as superstructType,\n  Struct,\n  StructError,\n  create,\n} from '@metamask/superstruct';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { assert, isObject } from '@metamask/utils';\nimport { bold, green, red } from 'chalk';\n\nimport { indent } from './strings';\n\n/**\n * Infer a struct type, only if it matches the specified type. This is useful\n * for defining types and structs that are related to each other in separate\n * files.\n *\n * @example\n * ```typescript\n * // In file A\n * export type GetFileArgs = {\n *   path: string;\n *   encoding?: EnumToUnion<AuxiliaryFileEncoding>;\n * };\n *\n * // In file B\n * export const GetFileArgsStruct = object(...);\n *\n * // If the type and struct are in the same file, this will return the type.\n * // Otherwise, it will return `never`.\n * export type GetFileArgs =\n *   InferMatching<typeof GetFileArgsStruct, GetFileArgs>;\n * ```\n */\nexport type InferMatching<\n  StructType extends Struct<any, any>,\n  Type,\n> = StructType['TYPE'] extends Type ? Type : never;\n\n/**\n * Colorize a value with a color function. This is useful for colorizing values\n * in error messages. If colorization is disabled, the original value is\n * returned.\n *\n * @param value - The value to colorize.\n * @param colorFunction - The color function to use.\n * @param enabled - Whether to colorize the value.\n * @returns The colorized value, or the original value if colorization is\n * disabled.\n */\nfunction color(\n  value: string,\n  colorFunction: (value: string) => string,\n  enabled: boolean,\n) {\n  if (enabled) {\n    return colorFunction(value);\n  }\n\n  return value;\n}\n\n/**\n * Define a struct, and also define the name of the struct as the given name.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n *\n * @param name - The name of the struct.\n * @param struct - The struct.\n * @returns The struct.\n */\nexport function named<Type, Schema>(\n  name: string,\n  struct: Struct<Type, Schema>,\n) {\n  return new Struct({\n    ...struct,\n    type: name,\n  });\n}\n\nexport class SnapsStructError<Type, Schema> extends StructError {\n  constructor(\n    struct: Struct<Type, Schema>,\n    prefix: string,\n    suffix: string,\n    failure: StructError,\n    failures: () => Generator<Failure>,\n    colorize = true,\n  ) {\n    super(failure, failures);\n\n    this.name = 'SnapsStructError';\n    this.message = `${prefix}.\\n\\n${getStructErrorMessage(\n      struct,\n      [...failures()],\n      colorize,\n    )}${suffix ? `\\n\\n${suffix}` : ''}`;\n  }\n}\n\ntype GetErrorOptions<Type, Schema> = {\n  struct: Struct<Type, Schema>;\n  prefix: string;\n  suffix?: string;\n  error: StructError;\n  colorize?: boolean;\n};\n\n/**\n * Converts an array to a generator function that yields the items in the\n * array.\n *\n * @param array - The array.\n * @returns A generator function.\n * @yields The items in the array.\n */\nexport function* arrayToGenerator<Type>(\n  array: Type[],\n): Generator<Type, void, undefined> {\n  for (const item of array) {\n    yield item;\n  }\n}\n\n/**\n * Returns a `SnapsStructError` with the given prefix and suffix.\n *\n * @param options - The options.\n * @param options.struct - The struct that caused the error.\n * @param options.prefix - The prefix to add to the error message.\n * @param options.suffix - The suffix to add to the error message. Defaults to\n * an empty string.\n * @param options.error - The `superstruct` error to wrap.\n * @param options.colorize - Whether to colorize the value. Defaults to `true`.\n * @returns The `SnapsStructError`.\n */\nexport function getError<Type, Schema>({\n  struct,\n  prefix,\n  suffix = '',\n  error,\n  colorize,\n}: GetErrorOptions<Type, Schema>) {\n  return new SnapsStructError(\n    struct,\n    prefix,\n    suffix,\n    error,\n    () => arrayToGenerator(error.failures()),\n    colorize,\n  );\n}\n\n/**\n * A wrapper of `superstruct`'s `create` function that throws a\n * `SnapsStructError` instead of a `StructError`. This is useful for improving\n * the error messages returned by `superstruct`.\n *\n * @param value - The value to validate.\n * @param struct - The `superstruct` struct to validate the value against.\n * @param prefix - The prefix to add to the error message.\n * @param suffix - The suffix to add to the error message. Defaults to an empty\n * string.\n * @returns The validated value.\n */\nexport function createFromStruct<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  prefix: string,\n  suffix = '',\n) {\n  try {\n    return create(value, struct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw getError({ struct, prefix, suffix, error });\n    }\n\n    throw error;\n  }\n}\n\n/**\n * Get a struct from a failure path.\n *\n * @param struct - The struct.\n * @param path - The failure path.\n * @returns The struct at the failure path.\n */\nexport function getStructFromPath<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  path: string[],\n) {\n  return path.reduce<AnyStruct>((result, key) => {\n    if (isObject(struct.schema) && struct.schema[key]) {\n      return struct.schema[key] as AnyStruct;\n    }\n\n    return result;\n  }, struct);\n}\n\n/**\n * Get the union struct names from a struct.\n *\n * @param struct - The struct.\n * @param colorize - Whether to colorize the value. Defaults to `true`.\n * @returns The union struct names, or `null` if the struct is not a union\n * struct.\n */\nexport function getUnionStructNames<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  colorize = true,\n) {\n  if (Array.isArray(struct.schema)) {\n    return struct.schema.map(({ type }) => color(type, green, colorize));\n  }\n\n  return null;\n}\n\n/**\n * Get an error prefix from a `superstruct` failure. This is useful for\n * formatting the error message returned by `superstruct`.\n *\n * @param failure - The `superstruct` failure.\n * @param colorize - Whether to colorize the value. Defaults to `true`.\n * @returns The error prefix.\n */\nexport function getStructErrorPrefix(failure: Failure, colorize = true) {\n  if (failure.type === 'never' || failure.path.length === 0) {\n    return '';\n  }\n\n  return `At path: ${color(failure.path.join('.'), bold, colorize)} — `;\n}\n\n/**\n * Get a string describing the failure. This is similar to the `message`\n * property of `superstruct`'s `Failure` type, but formats the value in a more\n * readable way.\n *\n * @param struct - The struct that caused the failure.\n * @param failure - The `superstruct` failure.\n * @param colorize - Whether to colorize the value. Defaults to `true`.\n * @returns A string describing the failure.\n */\nexport function getStructFailureMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failure: Failure,\n  colorize = true,\n) {\n  const received = color(JSON.stringify(failure.value), red, colorize);\n  const prefix = getStructErrorPrefix(failure, colorize);\n\n  if (failure.type === 'union') {\n    const childStruct = getStructFromPath(struct, failure.path);\n    const unionNames = getUnionStructNames(childStruct, colorize);\n\n    if (unionNames) {\n      return `${prefix}Expected the value to be one of: ${unionNames.join(\n        ', ',\n      )}, but received: ${received}.`;\n    }\n\n    return `${prefix}${failure.message}.`;\n  }\n\n  if (failure.type === 'literal') {\n    // Superstruct's failure does not provide information about which literal\n    // value was expected, so we need to parse the message to get the literal.\n    const message = failure.message\n      .replace(\n        /the literal `(.+)`,/u,\n        `the value to be \\`${color('$1', green, colorize)}\\`,`,\n      )\n      .replace(\n        /, but received: (.+)/u,\n        `, but received: ${color('$1', red, colorize)}`,\n      );\n\n    return `${prefix}${message}.`;\n  }\n\n  if (failure.type === 'never') {\n    return `Unknown key: ${color(\n      failure.path.join('.'),\n      bold,\n      colorize,\n    )}, received: ${received}.`;\n  }\n\n  if (failure.refinement === 'size') {\n    const message = failure.message\n      .replace(\n        /length between `(\\d+)` and `(\\d+)`/u,\n        `length between ${color('$1', green, colorize)} and ${color(\n          '$2',\n          green,\n          colorize,\n        )},`,\n      )\n      .replace(/length of `(\\d+)`/u, `length of ${color('$1', red, colorize)}`)\n      .replace(/a array/u, 'an array');\n\n    return `${prefix}${message}.`;\n  }\n\n  // Refinements we built ourselves have nice error messages\n  if (failure.refinement !== undefined) {\n    return `${prefix}${failure.message}.`;\n  }\n\n  return `${prefix}Expected a value of type ${color(\n    failure.type,\n    green,\n    colorize,\n  )}, but received: ${received}.`;\n}\n\n/**\n * Get a string describing the errors. This formats all the errors in a\n * human-readable way.\n *\n * @param struct - The struct that caused the failures.\n * @param failures - The `superstruct` failures.\n * @param colorize - Whether to colorize the value. Defaults to `true`.\n * @returns A string describing the errors.\n */\nexport function getStructErrorMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failures: Failure[],\n  colorize = true,\n) {\n  const formattedFailures = failures.map((failure) =>\n    indent(`• ${getStructFailureMessage(struct, failure, colorize)}`),\n  );\n\n  return formattedFailures.join('\\n');\n}\n\n/**\n * Validate a union struct, and throw readable errors if the value does not\n * satisfy the struct. This is useful for improving the error messages returned\n * by `superstruct`.\n *\n * @param value - The value to validate.\n * @param struct - The `superstruct` union struct to validate the value against.\n * This struct must be a union of object structs, and must have at least one\n * shared key to validate against.\n * @param structKey - The key to validate against. This key must be present in\n * all the object structs in the union struct, and is expected to be a literal\n * value.\n * @param coerce - Whether to coerce the value to satisfy the struct. Defaults\n * to `false`.\n * @returns The validated value.\n * @throws If the value does not satisfy the struct.\n * @example\n * const struct = union([\n *   object({ type: literal('a'), value: string() }),\n *   object({ type: literal('b'), value: number() }),\n *   object({ type: literal('c'), value: boolean() }),\n *   // ...\n * ]);\n *\n * // At path: type — Expected the value to be one of: \"a\", \"b\", \"c\", but received: \"d\".\n * validateUnion({ type: 'd', value: 'foo' }, struct, 'type');\n *\n * // At path: value — Expected a value of type string, but received: 42.\n * validateUnion({ type: 'a', value: 42 }, struct, 'value');\n */\nexport function validateUnion<Type, Schema extends readonly Struct<any, any>[]>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  structKey: keyof Type,\n  coerce = false,\n) {\n  assert(\n    struct.schema,\n    'Expected a struct with a schema. Make sure to use `union` from `@metamask/snaps-sdk`.',\n  );\n  assert(struct.schema.length > 0, 'Expected a non-empty array of structs.');\n\n  const keyUnion = struct.schema.map(\n    (innerStruct) => innerStruct.schema[structKey],\n    // This is guaranteed to be a non-empty array by the assertion above. We\n    // need to cast it since `superstruct` requires a non-empty array of structs\n    // for the `union` struct.\n  ) as NonEmptyArray<Struct>;\n\n  const key = superstructType({\n    [structKey]: union(keyUnion),\n  });\n\n  const [keyError] = validate(value, key, { coerce });\n  if (keyError) {\n    throw new Error(\n      getStructFailureMessage(key, keyError.failures()[0], false),\n    );\n  }\n\n  // At this point it's guaranteed that the value is an object, so we can safely\n  // cast it to a Record.\n  const objectValue = value as Record<PropertyKey, unknown>;\n  const objectStructs = struct.schema.filter((innerStruct) =>\n    is(objectValue[structKey], innerStruct.schema[structKey]),\n  );\n\n  assert(objectStructs.length > 0, 'Expected a struct to match the value.');\n\n  // We need to validate the value against all the object structs that match the\n  // struct key, and return the first validated value.\n  const validationResults = objectStructs.map((objectStruct) =>\n    validate(objectValue, objectStruct, { coerce }),\n  );\n\n  const validatedValue = validationResults.find(([error]) => !error);\n  if (validatedValue) {\n    return validatedValue[1];\n  }\n\n  assert(validationResults[0][0], 'Expected at least one error.');\n\n  // If there is no validated value, we need to find the error with the least\n  // number of failures (with the assumption that it's the most specific error).\n  const validationError = validationResults.reduce((error, [innerError]) => {\n    assert(innerError, 'Expected an error.');\n    if (innerError.failures().length < error.failures().length) {\n      return innerError;\n    }\n\n    return error;\n  }, validationResults[0][0]);\n\n  throw new Error(\n    getStructFailureMessage(struct, validationError.failures()[0], false),\n  );\n}\n\n/**\n * Create a value with the coercion logic of a union struct, and throw readable\n * errors if the value does not satisfy the struct. This is useful for improving\n * the error messages returned by `superstruct`.\n *\n * @param value - The value to validate.\n * @param struct - The `superstruct` union struct to validate the value against.\n * This struct must be a union of object structs, and must have at least one\n * shared key to validate against.\n * @param structKey - The key to validate against. This key must be present in\n * all the object structs in the union struct, and is expected to be a literal\n * value.\n * @returns The validated value.\n * @throws If the value does not satisfy the struct.\n * @see validateUnion\n */\nexport function createUnion<Type, Schema extends readonly Struct<any, any>[]>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  structKey: keyof Type,\n) {\n  return validateUnion(value, struct, structKey, true);\n}\n\n// These types are copied from Superstruct, to mirror `assign`.\nexport function mergeStructs<\n  ObjectA extends ObjectSchema,\n  ObjectB extends ObjectSchema,\n>(\n  A: Struct<ObjectType<ObjectA>, ObjectA>,\n  B: Struct<ObjectType<ObjectB>, ObjectB>,\n): Struct<ObjectType<Assign<ObjectA, ObjectB>>, Assign<ObjectA, ObjectB>>;\nexport function mergeStructs<\n  ObjectA extends ObjectSchema,\n  ObjectB extends ObjectSchema,\n  ObjectC extends ObjectSchema,\n>(\n  A: Struct<ObjectType<ObjectA>, ObjectA>,\n  B: Struct<ObjectType<ObjectB>, ObjectB>,\n  C: Struct<ObjectType<ObjectC>, ObjectC>,\n): Struct<\n  ObjectType<Assign<Assign<ObjectA, ObjectB>, ObjectC>>,\n  Assign<Assign<ObjectA, ObjectB>, ObjectC>\n>;\nexport function mergeStructs<\n  ObjectA extends ObjectSchema,\n  ObjectB extends ObjectSchema,\n  ObjectC extends ObjectSchema,\n  ObjectD extends ObjectSchema,\n>(\n  A: Struct<ObjectType<ObjectA>, ObjectA>,\n  B: Struct<ObjectType<ObjectB>, ObjectB>,\n  C: Struct<ObjectType<ObjectC>, ObjectC>,\n  D: Struct<ObjectType<ObjectD>, ObjectD>,\n): Struct<\n  ObjectType<Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>>,\n  Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>\n>;\nexport function mergeStructs<\n  ObjectA extends ObjectSchema,\n  ObjectB extends ObjectSchema,\n  ObjectC extends ObjectSchema,\n  ObjectD extends ObjectSchema,\n  ObjectE extends ObjectSchema,\n>(\n  A: Struct<ObjectType<ObjectA>, ObjectA>,\n  B: Struct<ObjectType<ObjectB>, ObjectB>,\n  C: Struct<ObjectType<ObjectC>, ObjectC>,\n  D: Struct<ObjectType<ObjectD>, ObjectD>,\n  E: Struct<ObjectType<ObjectE>, ObjectE>,\n): Struct<\n  ObjectType<\n    Assign<Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>, ObjectE>\n  >,\n  Assign<Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>, ObjectE>\n>;\n\n/**\n * Merge multiple structs into one, using superstruct `assign`.\n *\n * Differently from plain `assign`, this function also copies over refinements from each struct.\n *\n * @param structs - The `superstruct` structs to merge.\n * @returns The merged struct.\n */\nexport function mergeStructs(...structs: Struct<any>[]): Struct<any> {\n  const mergedStruct = (assign as (...structs: Struct<any>[]) => Struct)(\n    ...structs,\n  );\n  return new Struct({\n    ...mergedStruct,\n    *refiner(value, ctx) {\n      for (const struct of structs) {\n        yield* struct.refiner(value, ctx);\n      }\n    },\n  });\n}\n"]}