@metamask/snaps-utils 6.0.0 → 7.0.0

package/dist/esm/snaps.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/snaps.ts"],"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 { Json } from '@metamask/utils';\nimport { assert, isObject, assertStruct } from '@metamask/utils';\nimport { base64 } from '@scure/base';\nimport stableStringify from 'fast-json-stable-stringify';\nimport type { Struct } from 'superstruct';\nimport {\n  empty,\n  enums,\n  intersection,\n  literal,\n  pattern,\n  refine,\n  string,\n  union,\n  validate,\n} from 'superstruct';\nimport validateNPMPackage from 'validate-npm-package-name';\n\nimport { SnapCaveatType } from './caveats';\nimport { checksumFiles } from './checksum';\nimport type { LocalizationFile } from './localization';\nimport type { SnapManifest, SnapPermissions } from './manifest/validation';\nimport type { FetchedSnapFiles, SnapsPermissionRequest } from './types';\nimport { SnapIdPrefixes, SnapValidationFailureReason, 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 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\nexport type TruncatedSnapFields =\n  | 'id'\n  | 'initialPermissions'\n  | 'version'\n  | 'enabled'\n  | 'blocked';\n\n/**\n * An error indicating that a Snap validation failure is programmatically\n * fixable during development.\n */\nexport class ProgrammaticallyFixableSnapError extends Error {\n  reason: SnapValidationFailureReason;\n\n  constructor(message: string, reason: SnapValidationFailureReason) {\n    super(message);\n    this.reason = reason;\n  }\n}\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 ProgrammaticallyFixableSnapError(\n      errorMessage,\n      SnapValidationFailureReason.ShasumMismatch,\n    );\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"],"names":["assert","isObject","assertStruct","base64","stableStringify","empty","enums","intersection","literal","pattern","refine","string","union","validate","validateNPMPackage","SnapCaveatType","checksumFiles","SnapIdPrefixes","SnapValidationFailureReason","uri","PROPOSED_NAME_REGEX","SnapStatus","Installing","Updating","Running","Stopped","Crashed","SnapStatusEvents","Start","Stop","Crash","Update","ProgrammaticallyFixableSnapError","Error","constructor","message","reason","getChecksummableManifest","manifest","manifestCopy","clone","result","source","shasum","value","getSnapChecksum","files","sourceCode","svgIcon","auxiliaryFiles","localizationFiles","all","filter","file","undefined","encode","validateSnapShasum","errorMessage","ShasumMismatch","LOCALHOST_HOSTNAMES","BaseSnapIdStruct","LocalSnapIdSubUrlStruct","protocol","hostname","hash","search","LocalSnapIdStruct","startsWith","local","error","slice","length","NpmSnapIdStruct","npm","pathname","normalized","errors","validForNewPackages","warnings","HttpSnapIdStruct","SnapIdStruct","getSnapPrefix","snapId","prefix","Object","values","find","possiblePrefix","stripSnapPrefix","replace","assertIsValidSnapId","isCaipChainId","chainId","test","isSnapPermitted","permissions","Boolean","wallet_snap","caveats","caveat","type","SnapIds","verifyRequestedSnapPermissions","requestedPermissions","walletSnapPermission","Array","isArray"],"mappings":";;;;;;;;;;;;;AAQA,SAASA,MAAM,EAAEC,QAAQ,EAAEC,YAAY,QAAQ,kBAAkB;AACjE,SAASC,MAAM,QAAQ,cAAc;AACrC,OAAOC,qBAAqB,6BAA6B;AAEzD,SACEC,KAAK,EACLC,KAAK,EACLC,YAAY,EACZC,OAAO,EACPC,OAAO,EACPC,MAAM,EACNC,MAAM,EACNC,KAAK,EACLC,QAAQ,QACH,cAAc;AACrB,OAAOC,wBAAwB,4BAA4B;AAE3D,SAASC,cAAc,QAAQ,YAAY;AAC3C,SAASC,aAAa,QAAQ,aAAa;AAI3C,SAASC,cAAc,EAAEC,2BAA2B,EAAEC,GAAG,QAAQ,UAAU;AAG3E,+EAA+E;AAC/E,0EAA0E;AAC1E,0EAA0E;AAC1E,4DAA4D;AAC5D,uCAAuC;AACvC,2EAA2E;AAC3E,8EAA8E;AAC9E,qDAAqD;AACrD,mIAAmI;AACnI,OAAO,MAAMC,sBACX,mHAAmH;WAE9G;UAAKC,UAAU;IAAVA,WACVC,gBAAa;IADHD,WAEVE,cAAW;IAFDF,WAGVG,aAAU;IAHAH,WAIVI,aAAU;IAJAJ,WAKVK,aAAU;GALAL,eAAAA;WAQL;UAAKM,gBAAgB;IAAhBA,iBACVC,WAAQ;IADED,iBAEVE,UAAO;IAFGF,iBAGVG,WAAQ;IAHEH,iBAIVI,YAAS;GAJCJ,qBAAAA;AAkGZ;;;CAGC,GACD,OAAO,MAAMK,yCAAyCC;IAGpDC,YAAYC,OAAe,EAAEC,MAAmC,CAAE;QAChE,KAAK,CAACD;QAHRC,uBAAAA,UAAAA,KAAAA;QAIE,IAAI,CAACA,MAAM,GAAGA;IAChB;AACF;AAEA;;;;;CAKC,GACD,SAASC,yBACPC,QAAmC;IAEnC,MAAMC,eAAeD,SAASE,KAAK;IACnC,OAAOD,aAAaE,MAAM,CAACC,MAAM,CAACC,MAAM;IAExC,4EAA4E;IAC5E,6FAA6F;IAC7FJ,aAAaK,KAAK,GAAGxC,gBAAgBmC,aAAaE,MAAM;IACxD,OAAOF;AACT;AAEA;;;;;CAKC,GACD,OAAO,eAAeM,gBACpBC,KAAuB;IAEvB,MAAM,EAAER,QAAQ,EAAES,UAAU,EAAEC,OAAO,EAAEC,cAAc,EAAEC,iBAAiB,EAAE,GACxEJ;IAEF,MAAMK,MAAM;QACVd,yBAAyBC;QACzBS;QACAC;WACGC;WACAC;KACJ,CAACE,MAAM,CAAC,CAACC,OAASA,SAASC;IAE5B,OAAOnD,OAAOoD,MAAM,CAAC,MAAMvC,cAAcmC;AAC3C;AAEA;;;;;;CAMC,GACD,OAAO,eAAeK,mBACpBV,KAAuB,EACvBW,eAAe,wEAAwE;IAEvF,IAAIX,MAAMR,QAAQ,CAACG,MAAM,CAACC,MAAM,CAACC,MAAM,KAAM,MAAME,gBAAgBC,QAAS;QAC1E,MAAM,IAAId,iCACRyB,cACAvC,4BAA4BwC,cAAc;IAE9C;AACF;AAEA,OAAO,MAAMC,sBAAsB;IAAC;IAAa;IAAa;CAAQ,CAAU;AAEhF,iEAAiE;AACjE,OAAO,MAAMC,mBAAmBnD,QAAQE,UAAU,mBAAmB;AAErE,MAAMkD,0BAA0B1C,IAAI;IAClC2C,UAAUxD,MAAM;QAAC;QAAS;KAAS;IACnCyD,UAAUzD,MAAMqD;IAChBK,MAAM3D,MAAMM;IACZsD,QAAQ5D,MAAMM;AAChB;AAEA,OAAO,MAAMuD,oBAAoBxD,OAC/BkD,kBACA,iBACA,CAAChB;IACC,IAAI,CAACA,MAAMuB,UAAU,CAAClD,eAAemD,KAAK,GAAG;QAC3C,OAAO,CAAC,6BAA6B,EAAExB,MAAM,EAAE,CAAC;IAClD;IAEA,MAAM,CAACyB,MAAM,GAAGxD,SACd+B,MAAM0B,KAAK,CAACrD,eAAemD,KAAK,CAACG,MAAM,GACvCV;IAEF,OAAOQ,SAAS;AAClB,GACA;AACF,OAAO,MAAMG,kBAAkBjE,aAAa;IAC1CqD;IACAzC,IAAI;QACF2C,UAAUtD,QAAQS,eAAewD,GAAG;QACpCC,UAAUhE,OAAOC,UAAU,gBAAgB,UAAWiC,KAAK;YACzD,MAAM+B,aAAa/B,MAAMuB,UAAU,CAAC,OAAOvB,MAAM0B,KAAK,CAAC,KAAK1B;YAC5D,MAAM,EAAEgC,MAAM,EAAEC,mBAAmB,EAAEC,QAAQ,EAAE,GAC7ChE,mBAAmB6D;YACrB,IAAI,CAACE,qBAAqB;gBACxB,IAAID,WAAWtB,WAAW;oBACxBtD,OAAO8E,aAAaxB;oBACpB,OAAOwB;gBACT,OAAO;oBACL,OAAOF;gBACT;YACF;YACA,OAAO;QACT;QACAX,QAAQ5D,MAAMM;QACdqD,MAAM3D,MAAMM;IACd;CACD,EAAqC;AAEtC,OAAO,MAAMoE,mBAAmBxE,aAAa;IAC3CqD;IACAzC,IAAI;QACF2C,UAAUxD,MAAM;YAAC;YAAS;SAAS;QACnC2D,QAAQ5D,MAAMM;QACdqD,MAAM3D,MAAMM;IACd;CACD,EAAqC;AAEtC,OAAO,MAAMqE,eAAepE,MAAM;IAAC4D;IAAiBN;CAAkB,EAAE;AAExE;;;;;CAKC,GACD,OAAO,SAASe,cAAcC,MAAc;IAC1C,MAAMC,SAASC,OAAOC,MAAM,CAACpE,gBAAgBqE,IAAI,CAAC,CAACC,iBACjDL,OAAOf,UAAU,CAACoB;IAEpB,IAAIJ,WAAW7B,WAAW;QACxB,OAAO6B;IACT;IACA,MAAM,IAAIlD,MAAM,CAAC,gCAAgC,EAAEiD,OAAO,CAAC,CAAC;AAC9D;AAEA;;;;;CAKC,GACD,OAAO,SAASM,gBAAgBN,MAAc;IAC5C,OAAOA,OAAOO,OAAO,CAACR,cAAcC,SAAS;AAC/C;AAEA;;;;;CAKC,GACD,OAAO,SAASQ,oBAAoB9C,KAAc;IAChD1C,aAAa0C,OAAOoC,cAAc;AACpC;AAEA;;;;;CAKC,GACD,OAAO,SAASW,cAAcC,OAAgB;IAC5C,OACE,OAAOA,YAAY,YACnB,+EAAmEC,IAAI,CACrED;AAGN;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,gBACdC,WAAqD,EACrDb,MAAc;IAEd,OAAOc,QAEH,AACGD,CAAAA,aAAaE,aAAaC,SAASZ,KAClC,CAACa,SAAWA,OAAOC,IAAI,KAAKrF,eAAesF,OAAO,KAC/C,CAAC,CAAA,EACNzD,KAAK,EACN,CAACsC,OAAO;AAEf;AAEA;;;;;;CAMC,GACD,OAAO,SAASoB,+BACdC,oBAA6B;IAE7BvG,OACEC,SAASsG,uBACT;IAGF,MAAM,EAAEN,aAAaO,oBAAoB,EAAE,GAAGD;IAE9CvG,OACEC,SAASuG,uBACT;IAGF,MAAM,EAAEN,OAAO,EAAE,GAAGM;IAEpBxG,OACEyG,MAAMC,OAAO,CAACR,YAAYA,QAAQ3B,MAAM,KAAK,GAC7C;IAGF,MAAM,CAAC4B,OAAO,GAAGD;IAEjBlG,OACEC,SAASkG,WACPA,OAAOC,IAAI,KAAKrF,eAAesF,OAAO,IACtCpG,SAASkG,OAAOvD,KAAK,GACvB,CAAC,8CAA8C,EAAE7B,eAAesF,OAAO,CAAC,QAAQ,CAAC;AAErF"}

package/dist/esm/strings.js

@@ -1,11 +0,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.
- */ export function indent(message, spaces = 2) {
-    return message.replace(/^/gmu, ' '.repeat(spaces));
-}
-
-//# sourceMappingURL=strings.js.map

package/dist/esm/strings.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/strings.ts"],"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"],"names":["indent","message","spaces","replace","repeat"],"mappings":"AAAA;;;;;;CAMC,GACD,OAAO,SAASA,OAAOC,OAAe,EAAEC,SAAS,CAAC;IAChD,OAAOD,QAAQE,OAAO,CAAC,QAAQ,IAAIC,MAAM,CAACF;AAC5C"}

package/dist/esm/structs.js

@@ -1,295 +0,0 @@
-import { union } from '@metamask/snaps-sdk';
-import { assert, isObject } from '@metamask/utils';
-import { bold, green, red } from 'chalk';
-import { resolve } from 'path';
-import { is, validate, type as superstructType, Struct, StructError, create, string, coerce as superstructCoerce } from 'superstruct';
-import { indent } from './strings';
-/**
- * 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;
-}
-/**
- * A wrapper of `superstruct`'s `string` struct that coerces a value to a string
- * and resolves it relative to the current working directory. This is useful
- * for specifying file paths in a configuration file, as it allows the user to
- * use both relative and absolute paths.
- *
- * @returns The `superstruct` struct, which validates that the value is a
- * string, and resolves it relative to the current working directory.
- * @example
- * ```ts
- * const config = struct({
- *   file: file(),
- *   // ...
- * });
- *
- * const value = create({ file: 'path/to/file' }, config);
- * console.log(value.file); // /process/cwd/path/to/file
- * ```
- */ export function file() {
-    return superstructCoerce(string(), string(), (value)=>{
-        return resolve(process.cwd(), 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.
- */ export function named(name, struct) {
-    return new Struct({
-        ...struct,
-        type: name
-    });
-}
-export class SnapsStructError extends 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}` : ''}`;
-    }
-}
-/**
- * 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.
- */ export function* arrayToGenerator(array) {
-    for (const item of array){
-        yield item;
-    }
-}
-/**
- * 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`.
- */ export function getError({ struct, prefix, suffix = '', error, colorize }) {
-    return new SnapsStructError(struct, prefix, suffix, error, ()=>arrayToGenerator(error.failures()), colorize);
-}
-/**
- * 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.
- */ export function createFromStruct(value, struct, prefix, suffix = '') {
-    try {
-        return create(value, struct);
-    } catch (error) {
-        if (error instanceof StructError) {
-            throw getError({
-                struct,
-                prefix,
-                suffix,
-                error
-            });
-        }
-        throw error;
-    }
-}
-/**
- * Get a struct from a failure path.
- *
- * @param struct - The struct.
- * @param path - The failure path.
- * @returns The struct at the failure path.
- */ export function getStructFromPath(struct, path) {
-    return path.reduce((result, key)=>{
-        if (isObject(struct.schema) && struct.schema[key]) {
-            return struct.schema[key];
-        }
-        return result;
-    }, struct);
-}
-/**
- * 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.
- */ export function getUnionStructNames(struct, colorize = true) {
-    if (Array.isArray(struct.schema)) {
-        return struct.schema.map(({ type })=>color(type, green, colorize));
-    }
-    return null;
-}
-/**
- * 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.
- */ export function getStructErrorPrefix(failure, colorize = true) {
-    if (failure.type === 'never' || failure.path.length === 0) {
-        return '';
-    }
-    return `At path: ${color(failure.path.join('.'), bold, colorize)} — `;
-}
-/**
- * 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.
- */ export function getStructFailureMessage(struct, failure, colorize = true) {
-    const received = color(JSON.stringify(failure.value), 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', green, colorize)}\`,`).replace(/, but received: (.+)/u, `, but received: ${color('$1', red, colorize)}`);
-        return `${prefix}${message}.`;
-    }
-    if (failure.type === 'never') {
-        return `Unknown key: ${color(failure.path.join('.'), bold, colorize)}, received: ${received}.`;
-    }
-    if (failure.refinement === 'size') {
-        const message = failure.message.replace(/length between `(\d+)` and `(\d+)`/u, `length between ${color('$1', green, colorize)} and ${color('$2', green, colorize)},`).replace(/length of `(\d+)`/u, `length of ${color('$1', red, colorize)}`).replace(/a array/u, 'an array');
-        return `${prefix}${message}.`;
-    }
-    return `${prefix}Expected a value of type ${color(failure.type, green, colorize)}, but received: ${received}.`;
-}
-/**
- * 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.
- */ export function getStructErrorMessage(struct, failures, colorize = true) {
-    const formattedFailures = failures.map((failure)=>indent(`• ${getStructFailureMessage(struct, failure, colorize)}`));
-    return formattedFailures.join('\n');
-}
-/**
- * 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');
- */ export function validateUnion(value, struct, structKey, coerce = false) {
-    assert(struct.schema, 'Expected a struct with a schema. Make sure to use `union` from `@metamask/snaps-sdk`.');
-    assert(struct.schema.length > 0, 'Expected a non-empty array of structs.');
-    const keyUnion = struct.schema.map((innerStruct)=>innerStruct.schema[structKey]);
-    const key = superstructType({
-        [structKey]: union(keyUnion)
-    });
-    const [keyError] = 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)=>is(objectValue[structKey], innerStruct.schema[structKey]));
-    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)=>validate(objectValue, objectStruct, {
-            coerce
-        }));
-    const validatedValue = validationResults.find(([error])=>!error);
-    if (validatedValue) {
-        return validatedValue[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])=>{
-        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));
-}
-/**
- * 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
- */ export function createUnion(value, struct, structKey) {
-    return validateUnion(value, struct, structKey, true);
-}
-
-//# sourceMappingURL=structs.js.map

package/dist/esm/structs.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/structs.ts"],"sourcesContent":["import { union } from '@metamask/snaps-sdk';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport { assert, isObject } from '@metamask/utils';\nimport { bold, green, red } from 'chalk';\nimport { resolve } from 'path';\nimport type { Failure } from 'superstruct';\nimport {\n  is,\n  validate,\n  type as superstructType,\n  Struct,\n  StructError,\n  create,\n  string,\n  coerce as superstructCoerce,\n} from 'superstruct';\nimport type { AnyStruct } from 'superstruct/dist/utils';\n\nimport { indent } from './strings';\n\n/**\n * Infer a struct type, only if it matches the specified type. This is useful\n * for defining types and structs that are related to each other in separate\n * files.\n *\n * @example\n * ```typescript\n * // In file A\n * export type GetFileArgs = {\n *   path: string;\n *   encoding?: EnumToUnion<AuxiliaryFileEncoding>;\n * };\n *\n * // In file B\n * export const GetFileArgsStruct = object(...);\n *\n * // If the type and struct are in the same file, this will return the type.\n * // Otherwise, it will return `never`.\n * export type GetFileArgs =\n *   InferMatching<typeof GetFileArgsStruct, GetFileArgs>;\n * ```\n */\nexport type InferMatching<\n  StructType extends Struct<any, any>,\n  Type,\n> = StructType['TYPE'] extends Type ? Type : never;\n\n/**\n * 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 * A wrapper of `superstruct`'s `string` struct that coerces a value to a string\n * and resolves it relative to the current working directory. This is useful\n * for specifying file paths in a configuration file, as it allows the user to\n * use both relative and absolute paths.\n *\n * @returns The `superstruct` struct, which validates that the value is a\n * string, and resolves it relative to the current working directory.\n * @example\n * ```ts\n * const config = struct({\n *   file: file(),\n *   // ...\n * });\n *\n * const value = create({ file: 'path/to/file' }, config);\n * console.log(value.file); // /process/cwd/path/to/file\n * ```\n */\nexport function file() {\n  return superstructCoerce(string(), string(), (value) => {\n    return resolve(process.cwd(), value);\n  });\n}\n\n/**\n * Define a struct, and also define the name of the struct as the given name.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n *\n * @param name - The name of the struct.\n * @param struct - The struct.\n * @returns The struct.\n */\nexport function named<Type, Schema>(\n  name: string,\n  struct: Struct<Type, Schema>,\n) {\n  return new Struct({\n    ...struct,\n    type: name,\n  });\n}\n\nexport class SnapsStructError<Type, Schema> extends StructError {\n  constructor(\n    struct: Struct<Type, Schema>,\n    prefix: string,\n    suffix: string,\n    failure: StructError,\n    failures: () => Generator<Failure>,\n    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  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"],"names":["union","assert","isObject","bold","green","red","resolve","is","validate","type","superstructType","Struct","StructError","create","string","coerce","superstructCoerce","indent","color","value","colorFunction","enabled","file","process","cwd","named","name","struct","SnapsStructError","constructor","prefix","suffix","failure","failures","colorize","message","getStructErrorMessage","arrayToGenerator","array","item","getError","error","createFromStruct","getStructFromPath","path","reduce","result","key","schema","getUnionStructNames","Array","isArray","map","getStructErrorPrefix","length","join","getStructFailureMessage","received","JSON","stringify","childStruct","unionNames","replace","refinement","formattedFailures","validateUnion","structKey","keyUnion","innerStruct","keyError","Error","objectValue","objectStructs","filter","validationResults","objectStruct","validatedValue","find","validationError","innerError","createUnion"],"mappings":"AAAA,SAASA,KAAK,QAAQ,sBAAsB;AAE5C,SAASC,MAAM,EAAEC,QAAQ,QAAQ,kBAAkB;AACnD,SAASC,IAAI,EAAEC,KAAK,EAAEC,GAAG,QAAQ,QAAQ;AACzC,SAASC,OAAO,QAAQ,OAAO;AAE/B,SACEC,EAAE,EACFC,QAAQ,EACRC,QAAQC,eAAJ,EACJC,MAAM,EACNC,WAAW,EACXC,MAAM,EACNC,MAAM,EACNC,UAAUC,iBAAiB,QACtB,cAAc;AAGrB,SAASC,MAAM,QAAQ,YAAY;AA6BnC;;;;;;;;;;CAUC,GACD,SAASC,MACPC,KAAa,EACbC,aAAwC,EACxCC,OAAgB;IAEhB,IAAIA,SAAS;QACX,OAAOD,cAAcD;IACvB;IAEA,OAAOA;AACT;AAEA;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASG;IACd,OAAON,kBAAkBF,UAAUA,UAAU,CAACK;QAC5C,OAAOb,QAAQiB,QAAQC,GAAG,IAAIL;IAChC;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASM,MACdC,IAAY,EACZC,MAA4B;IAE5B,OAAO,IAAIhB,OAAO;QAChB,GAAGgB,MAAM;QACTlB,MAAMiB;IACR;AACF;AAEA,OAAO,MAAME,yBAAuChB;IAClDiB,YACEF,MAA4B,EAC5BG,MAAc,EACdC,MAAc,EACdC,OAAoB,EACpBC,QAAkC,EAClCC,WAAW,IAAI,CACf;QACA,KAAK,CAACF,SAASC;QAEf,IAAI,CAACP,IAAI,GAAG;QACZ,IAAI,CAACS,OAAO,GAAG,CAAC,EAAEL,OAAO,KAAK,EAAEM,sBAC9BT,QACA;eAAIM;SAAW,EACfC,UACA,EAAEH,SAAS,CAAC,IAAI,EAAEA,OAAO,CAAC,GAAG,GAAG,CAAC;IACrC;AACF;AAUA;;;;;;;CAOC,GACD,OAAO,UAAUM,iBACfC,KAAa;IAEb,KAAK,MAAMC,QAAQD,MAAO;QACxB,MAAMC;IACR;AACF;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASC,SAAuB,EACrCb,MAAM,EACNG,MAAM,EACNC,SAAS,EAAE,EACXU,KAAK,EACLP,QAAQ,EACsB;IAC9B,OAAO,IAAIN,iBACTD,QACAG,QACAC,QACAU,OACA,IAAMJ,iBAAiBI,MAAMR,QAAQ,KACrCC;AAEJ;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASQ,iBACdvB,KAAc,EACdQ,MAA4B,EAC5BG,MAAc,EACdC,SAAS,EAAE;IAEX,IAAI;QACF,OAAOlB,OAAOM,OAAOQ;IACvB,EAAE,OAAOc,OAAO;QACd,IAAIA,iBAAiB7B,aAAa;YAChC,MAAM4B,SAAS;gBAAEb;gBAAQG;gBAAQC;gBAAQU;YAAM;QACjD;QAEA,MAAMA;IACR;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,kBACdhB,MAA4B,EAC5BiB,IAAc;IAEd,OAAOA,KAAKC,MAAM,CAAY,CAACC,QAAQC;QACrC,IAAI7C,SAASyB,OAAOqB,MAAM,KAAKrB,OAAOqB,MAAM,CAACD,IAAI,EAAE;YACjD,OAAOpB,OAAOqB,MAAM,CAACD,IAAI;QAC3B;QAEA,OAAOD;IACT,GAAGnB;AACL;AAEA;;;;;;;CAOC,GACD,OAAO,SAASsB,oBACdtB,MAA4B,EAC5BO,WAAW,IAAI;IAEf,IAAIgB,MAAMC,OAAO,CAACxB,OAAOqB,MAAM,GAAG;QAChC,OAAOrB,OAAOqB,MAAM,CAACI,GAAG,CAAC,CAAC,EAAE3C,IAAI,EAAE,GAAKS,MAAMT,MAAML,OAAO8B;IAC5D;IAEA,OAAO;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,SAASmB,qBAAqBrB,OAAgB,EAAEE,WAAW,IAAI;IACpE,IAAIF,QAAQvB,IAAI,KAAK,WAAWuB,QAAQY,IAAI,CAACU,MAAM,KAAK,GAAG;QACzD,OAAO;IACT;IAEA,OAAO,CAAC,SAAS,EAAEpC,MAAMc,QAAQY,IAAI,CAACW,IAAI,CAAC,MAAMpD,MAAM+B,UAAU,GAAG,CAAC;AACvE;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASsB,wBACd7B,MAA4B,EAC5BK,OAAgB,EAChBE,WAAW,IAAI;IAEf,MAAMuB,WAAWvC,MAAMwC,KAAKC,SAAS,CAAC3B,QAAQb,KAAK,GAAGd,KAAK6B;IAC3D,MAAMJ,SAASuB,qBAAqBrB,SAASE;IAE7C,IAAIF,QAAQvB,IAAI,KAAK,SAAS;QAC5B,MAAMmD,cAAcjB,kBAAkBhB,QAAQK,QAAQY,IAAI;QAC1D,MAAMiB,aAAaZ,oBAAoBW,aAAa1B;QAEpD,IAAI2B,YAAY;YACd,OAAO,CAAC,EAAE/B,OAAO,iCAAiC,EAAE+B,WAAWN,IAAI,CACjE,MACA,gBAAgB,EAAEE,SAAS,CAAC,CAAC;QACjC;QAEA,OAAO,CAAC,EAAE3B,OAAO,EAAEE,QAAQG,OAAO,CAAC,CAAC,CAAC;IACvC;IAEA,IAAIH,QAAQvB,IAAI,KAAK,WAAW;QAC9B,yEAAyE;QACzE,0EAA0E;QAC1E,MAAM0B,UAAUH,QAAQG,OAAO,CAC5B2B,OAAO,CACN,wBACA,CAAC,kBAAkB,EAAE5C,MAAM,MAAMd,OAAO8B,UAAU,GAAG,CAAC,EAEvD4B,OAAO,CACN,yBACA,CAAC,gBAAgB,EAAE5C,MAAM,MAAMb,KAAK6B,UAAU,CAAC;QAGnD,OAAO,CAAC,EAAEJ,OAAO,EAAEK,QAAQ,CAAC,CAAC;IAC/B;IAEA,IAAIH,QAAQvB,IAAI,KAAK,SAAS;QAC5B,OAAO,CAAC,aAAa,EAAES,MACrBc,QAAQY,IAAI,CAACW,IAAI,CAAC,MAClBpD,MACA+B,UACA,YAAY,EAAEuB,SAAS,CAAC,CAAC;IAC7B;IAEA,IAAIzB,QAAQ+B,UAAU,KAAK,QAAQ;QACjC,MAAM5B,UAAUH,QAAQG,OAAO,CAC5B2B,OAAO,CACN,uCACA,CAAC,eAAe,EAAE5C,MAAM,MAAMd,OAAO8B,UAAU,KAAK,EAAEhB,MACpD,MACAd,OACA8B,UACA,CAAC,CAAC,EAEL4B,OAAO,CAAC,sBAAsB,CAAC,UAAU,EAAE5C,MAAM,MAAMb,KAAK6B,UAAU,CAAC,EACvE4B,OAAO,CAAC,YAAY;QAEvB,OAAO,CAAC,EAAEhC,OAAO,EAAEK,QAAQ,CAAC,CAAC;IAC/B;IAEA,OAAO,CAAC,EAAEL,OAAO,yBAAyB,EAAEZ,MAC1Cc,QAAQvB,IAAI,EACZL,OACA8B,UACA,gBAAgB,EAAEuB,SAAS,CAAC,CAAC;AACjC;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASrB,sBACdT,MAA4B,EAC5BM,QAAmB,EACnBC,WAAW,IAAI;IAEf,MAAM8B,oBAAoB/B,SAASmB,GAAG,CAAC,CAACpB,UACtCf,OAAO,CAAC,EAAE,EAAEuC,wBAAwB7B,QAAQK,SAASE,UAAU,CAAC;IAGlE,OAAO8B,kBAAkBT,IAAI,CAAC;AAChC;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6BC,GACD,OAAO,SAASU,cACd9C,KAAc,EACdQ,MAA4B,EAC5BuC,SAAqB,EACrBnD,SAAS,KAAK;IAEdd,OACE0B,OAAOqB,MAAM,EACb;IAEF/C,OAAO0B,OAAOqB,MAAM,CAACM,MAAM,GAAG,GAAG;IAEjC,MAAMa,WAAWxC,OAAOqB,MAAM,CAACI,GAAG,CAChC,CAACgB,cAAgBA,YAAYpB,MAAM,CAACkB,UAAU;IAMhD,MAAMnB,MAAMrC,gBAAgB;QAC1B,CAACwD,UAAU,EAAElE,MAAMmE;IACrB;IAEA,MAAM,CAACE,SAAS,GAAG7D,SAASW,OAAO4B,KAAK;QAAEhC;IAAO;IACjD,IAAIsD,UAAU;QACZ,MAAM,IAAIC,MACRd,wBAAwBT,KAAKsB,SAASpC,QAAQ,EAAE,CAAC,EAAE,EAAE;IAEzD;IAEA,8EAA8E;IAC9E,uBAAuB;IACvB,MAAMsC,cAAcpD;IACpB,MAAMqD,gBAAgB7C,OAAOqB,MAAM,CAACyB,MAAM,CAAC,CAACL,cAC1C7D,GAAGgE,WAAW,CAACL,UAAU,EAAEE,YAAYpB,MAAM,CAACkB,UAAU;IAG1DjE,OAAOuE,cAAclB,MAAM,GAAG,GAAG;IAEjC,8EAA8E;IAC9E,oDAAoD;IACpD,MAAMoB,oBAAoBF,cAAcpB,GAAG,CAAC,CAACuB,eAC3CnE,SAAS+D,aAAaI,cAAc;YAAE5D;QAAO;IAG/C,MAAM6D,iBAAiBF,kBAAkBG,IAAI,CAAC,CAAC,CAACpC,MAAM,GAAK,CAACA;IAC5D,IAAImC,gBAAgB;QAClB,OAAOA,cAAc,CAAC,EAAE;IAC1B;IAEA3E,OAAOyE,iBAAiB,CAAC,EAAE,CAAC,EAAE,EAAE;IAEhC,2EAA2E;IAC3E,8EAA8E;IAC9E,MAAMI,kBAAkBJ,kBAAkB7B,MAAM,CAAC,CAACJ,OAAO,CAACsC,WAAW;QACnE9E,OAAO8E,YAAY;QACnB,IAAIA,WAAW9C,QAAQ,GAAGqB,MAAM,GAAGb,MAAMR,QAAQ,GAAGqB,MAAM,EAAE;YAC1D,OAAOyB;QACT;QAEA,OAAOtC;IACT,GAAGiC,iBAAiB,CAAC,EAAE,CAAC,EAAE;IAE1B,MAAM,IAAIJ,MACRd,wBAAwB7B,QAAQmD,gBAAgB7C,QAAQ,EAAE,CAAC,EAAE,EAAE;AAEnE;AAEA;;;;;;;;;;;;;;;CAeC,GACD,OAAO,SAAS+C,YACd7D,KAAc,EACdQ,MAA4B,EAC5BuC,SAAqB;IAErB,OAAOD,cAAc9C,OAAOQ,QAAQuC,WAAW;AACjD"}

package/dist/esm/types.js

@@ -1,78 +0,0 @@
-import { assertStruct, VersionStruct } from '@metamask/utils';
-import { instance, is, object, optional, pattern, refine, size, string, type, union, assert as assertSuperstruct } from 'superstruct';
-export var NpmSnapFileNames;
-(function(NpmSnapFileNames) {
-    NpmSnapFileNames["PackageJson"] = 'package.json';
-    NpmSnapFileNames["Manifest"] = 'snap.manifest.json';
-})(NpmSnapFileNames || (NpmSnapFileNames = {}));
-export const NameStruct = size(pattern(string(), /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/u), 1, 214);
-// Note we use `type` instead of `object` here, because the latter does not
-// allow unknown keys.
-export const NpmSnapPackageJsonStruct = type({
-    version: VersionStruct,
-    name: NameStruct,
-    main: optional(size(string(), 1, Infinity)),
-    repository: optional(object({
-        type: size(string(), 1, Infinity),
-        url: size(string(), 1, Infinity)
-    }))
-});
-/**
- * Check if the given value is a valid {@link NpmSnapPackageJson} object.
- *
- * @param value - The value to check.
- * @returns Whether the value is a valid {@link NpmSnapPackageJson} object.
- */ export function isNpmSnapPackageJson(value) {
-    return is(value, NpmSnapPackageJsonStruct);
-}
-/**
- * Asserts that the given value is a valid {@link NpmSnapPackageJson} object.
- *
- * @param value - The value to check.
- * @throws If the value is not a valid {@link NpmSnapPackageJson} object.
- */ export function assertIsNpmSnapPackageJson(value) {
-    assertStruct(value, NpmSnapPackageJsonStruct, `"${NpmSnapFileNames.PackageJson}" is invalid`);
-}
-export var SnapIdPrefixes;
-(function(SnapIdPrefixes) {
-    SnapIdPrefixes["npm"] = 'npm:';
-    SnapIdPrefixes["local"] = 'local:';
-})(SnapIdPrefixes || (SnapIdPrefixes = {}));
-export var SnapValidationFailureReason;
-(function(SnapValidationFailureReason) {
-    SnapValidationFailureReason["NameMismatch"] = '"name" field mismatch';
-    SnapValidationFailureReason["VersionMismatch"] = '"version" field mismatch';
-    SnapValidationFailureReason["RepositoryMismatch"] = '"repository" field mismatch';
-    SnapValidationFailureReason["ShasumMismatch"] = '"shasum" field mismatch';
-})(SnapValidationFailureReason || (SnapValidationFailureReason = {}));
-export var SNAP_STREAM_NAMES;
-(function(SNAP_STREAM_NAMES) {
-    SNAP_STREAM_NAMES["JSON_RPC"] = 'jsonRpc';
-    SNAP_STREAM_NAMES["COMMAND"] = 'command';
-})(SNAP_STREAM_NAMES || (SNAP_STREAM_NAMES = {}));
-export const uri = (opts = {})=>refine(union([
-        string(),
-        instance(URL)
-    ]), 'uri', (value)=>{
-        try {
-            const url = new URL(value);
-            const UrlStruct = type(opts);
-            assertSuperstruct(url, UrlStruct);
-            return true;
-        } catch  {
-            return `Expected URL, got "${value.toString()}".`;
-        }
-    });
-/**
- * Returns whether a given value is a valid URL.
- *
- * @param url - The value to check.
- * @param opts - Optional constraints for url checking.
- * @returns Whether `url` is valid URL or not.
- */ export function isValidUrl(url, opts = {}) {
-    return is(url, uri(opts));
-}
-// redefining here to avoid circular dependency
-export const WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';
-
-//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assertStruct, VersionStruct } from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  instance,\n  is,\n  object,\n  optional,\n  pattern,\n  refine,\n  size,\n  string,\n  type,\n  union,\n  assert as assertSuperstruct,\n} from 'superstruct';\n\nimport type { SnapCaveatType } from './caveats';\nimport type { SnapFunctionExports, SnapRpcHookArgs } from './handlers';\nimport type { LocalizationFile } from './localization';\nimport type { SnapManifest } from './manifest';\nimport type { VirtualFile } from './virtual-file';\n\nexport enum NpmSnapFileNames {\n  PackageJson = 'package.json',\n  Manifest = 'snap.manifest.json',\n}\n\nexport const NameStruct = size(\n  pattern(\n    string(),\n    /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\\/)?[a-z0-9-~][a-z0-9-._~]*$/u,\n  ),\n  1,\n  214,\n);\n\n// Note we use `type` instead of `object` here, because the latter does not\n// allow unknown keys.\nexport const NpmSnapPackageJsonStruct = type({\n  version: VersionStruct,\n  name: NameStruct,\n  main: optional(size(string(), 1, Infinity)),\n  repository: optional(\n    object({\n      type: size(string(), 1, Infinity),\n      url: size(string(), 1, Infinity),\n    }),\n  ),\n});\n\nexport type NpmSnapPackageJson = Infer<typeof NpmSnapPackageJsonStruct> &\n  Record<string, any>;\n\n/**\n * Check if the given value is a valid {@link NpmSnapPackageJson} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link NpmSnapPackageJson} object.\n */\nexport function isNpmSnapPackageJson(\n  value: unknown,\n): value is NpmSnapPackageJson {\n  return is(value, NpmSnapPackageJsonStruct);\n}\n\n/**\n * Asserts that the given value is a valid {@link NpmSnapPackageJson} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link NpmSnapPackageJson} object.\n */\nexport function assertIsNpmSnapPackageJson(\n  value: unknown,\n): asserts value is NpmSnapPackageJson {\n  assertStruct(\n    value,\n    NpmSnapPackageJsonStruct,\n    `\"${NpmSnapFileNames.PackageJson}\" is invalid`,\n  );\n}\n\n/**\n * An object for storing parsed but unvalidated Snap file contents.\n */\nexport type UnvalidatedSnapFiles = {\n  manifest?: VirtualFile<Json>;\n  packageJson?: VirtualFile<Json>;\n  sourceCode?: VirtualFile;\n  svgIcon?: VirtualFile;\n  auxiliaryFiles: VirtualFile[];\n  localizationFiles: VirtualFile[];\n};\n\n/**\n * An object for storing the contents of Snap files that have passed JSON\n * Schema validation, or are non-empty if they are strings.\n */\nexport type SnapFiles = {\n  manifest: VirtualFile<SnapManifest>;\n  packageJson: VirtualFile<NpmSnapPackageJson>;\n  sourceCode: VirtualFile;\n  svgIcon?: VirtualFile;\n  auxiliaryFiles: VirtualFile[];\n  localizationFiles: VirtualFile<LocalizationFile>[];\n};\n\n/**\n * A subset of snap files extracted from a fetched snap.\n */\nexport type FetchedSnapFiles = Pick<\n  SnapFiles,\n  'manifest' | 'sourceCode' | 'svgIcon' | 'auxiliaryFiles' | 'localizationFiles'\n>;\n\n/**\n * The possible prefixes for snap ids.\n */\n/* eslint-disable @typescript-eslint/naming-convention */\nexport enum SnapIdPrefixes {\n  npm = 'npm:',\n  local = 'local:',\n}\n/* eslint-enable @typescript-eslint/naming-convention */\n\n/**\n * Snap validation failure reason codes that are programmatically fixable\n * if validation occurs during development.\n */\nexport enum SnapValidationFailureReason {\n  NameMismatch = '\"name\" field mismatch',\n  VersionMismatch = '\"version\" field mismatch',\n  RepositoryMismatch = '\"repository\" field mismatch',\n  ShasumMismatch = '\"shasum\" field mismatch',\n}\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport enum SNAP_STREAM_NAMES {\n  JSON_RPC = 'jsonRpc',\n  COMMAND = 'command',\n}\n/* eslint-enable @typescript-eslint/naming-convention */\n\n// The snap is the callee\nexport type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;\n\ntype ObjectParameters<\n  Type extends Record<string, (...args: any[]) => unknown>,\n> = Parameters<Type[keyof Type]>;\n\nexport type SnapExportsParameters = ObjectParameters<SnapFunctionExports>;\n\ntype UriOptions<Type extends string> = {\n  protocol?: Struct<Type>;\n  hash?: Struct<Type>;\n  port?: Struct<Type>;\n  hostname?: Struct<Type>;\n  pathname?: Struct<Type>;\n  search?: Struct<Type>;\n};\n\nexport const uri = (opts: UriOptions<any> = {}) =>\n  refine(union([string(), instance(URL)]), 'uri', (value) => {\n    try {\n      const url = new URL(value);\n\n      const UrlStruct = type(opts);\n      assertSuperstruct(url, UrlStruct);\n      return true;\n    } catch {\n      return `Expected URL, got \"${value.toString()}\".`;\n    }\n  });\n\n/**\n * Returns whether a given value is a valid URL.\n *\n * @param url - The value to check.\n * @param opts - Optional constraints for url checking.\n * @returns Whether `url` is valid URL or not.\n */\nexport function isValidUrl(\n  url: unknown,\n  opts: UriOptions<any> = {},\n): url is string | URL {\n  return is(url, uri(opts));\n}\n\n// redefining here to avoid circular dependency\nexport const WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';\n\nexport type SnapsPermissionRequest = {\n  [WALLET_SNAP_PERMISSION_KEY]: {\n    caveats: [\n      {\n        type: SnapCaveatType.SnapIds;\n        value: Record<string, Json>;\n      },\n    ];\n  };\n};\n"],"names":["assertStruct","VersionStruct","instance","is","object","optional","pattern","refine","size","string","type","union","assert","assertSuperstruct","NpmSnapFileNames","PackageJson","Manifest","NameStruct","NpmSnapPackageJsonStruct","version","name","main","Infinity","repository","url","isNpmSnapPackageJson","value","assertIsNpmSnapPackageJson","SnapIdPrefixes","npm","local","SnapValidationFailureReason","NameMismatch","VersionMismatch","RepositoryMismatch","ShasumMismatch","SNAP_STREAM_NAMES","JSON_RPC","COMMAND","uri","opts","URL","UrlStruct","toString","isValidUrl","WALLET_SNAP_PERMISSION_KEY"],"mappings":"AACA,SAASA,YAAY,EAAEC,aAAa,QAAQ,kBAAkB;AAE9D,SACEC,QAAQ,EACRC,EAAE,EACFC,MAAM,EACNC,QAAQ,EACRC,OAAO,EACPC,MAAM,EACNC,IAAI,EACJC,MAAM,EACNC,IAAI,EACJC,KAAK,EACLC,UAAUC,iBAAiB,QACtB,cAAc;WAQd;UAAKC,gBAAgB;IAAhBA,iBACVC,iBAAc;IADJD,iBAEVE,cAAW;GAFDF,qBAAAA;AAKZ,OAAO,MAAMG,aAAaT,KACxBF,QACEG,UACA,gEAEF,GACA,KACA;AAEF,2EAA2E;AAC3E,sBAAsB;AACtB,OAAO,MAAMS,2BAA2BR,KAAK;IAC3CS,SAASlB;IACTmB,MAAMH;IACNI,MAAMhB,SAASG,KAAKC,UAAU,GAAGa;IACjCC,YAAYlB,SACVD,OAAO;QACLM,MAAMF,KAAKC,UAAU,GAAGa;QACxBE,KAAKhB,KAAKC,UAAU,GAAGa;IACzB;AAEJ,GAAG;AAKH;;;;;CAKC,GACD,OAAO,SAASG,qBACdC,KAAc;IAEd,OAAOvB,GAAGuB,OAAOR;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASS,2BACdD,KAAc;IAEd1B,aACE0B,OACAR,0BACA,CAAC,CAAC,EAAEJ,iBAAiBC,WAAW,CAAC,YAAY,CAAC;AAElD;WAuCO;UAAKa,cAAc;IAAdA,eACVC,SAAM;IADID,eAEVE,WAAQ;GAFEF,mBAAAA;WAUL;UAAKG,2BAA2B;IAA3BA,4BACVC,kBAAe;IADLD,4BAEVE,qBAAkB;IAFRF,4BAGVG,wBAAqB;IAHXH,4BAIVI,oBAAiB;GAJPJ,gCAAAA;WAQL;UAAKK,iBAAiB;IAAjBA,kBACVC,cAAW;IADDD,kBAEVE,aAAU;GAFAF,sBAAAA;AAwBZ,OAAO,MAAMG,MAAM,CAACC,OAAwB,CAAC,CAAC,GAC5CjC,OAAOI,MAAM;QAACF;QAAUP,SAASuC;KAAK,GAAG,OAAO,CAACf;QAC/C,IAAI;YACF,MAAMF,MAAM,IAAIiB,IAAIf;YAEpB,MAAMgB,YAAYhC,KAAK8B;YACvB3B,kBAAkBW,KAAKkB;YACvB,OAAO;QACT,EAAE,OAAM;YACN,OAAO,CAAC,mBAAmB,EAAEhB,MAAMiB,QAAQ,GAAG,EAAE,CAAC;QACnD;IACF,GAAG;AAEL;;;;;;CAMC,GACD,OAAO,SAASC,WACdpB,GAAY,EACZgB,OAAwB,CAAC,CAAC;IAE1B,OAAOrC,GAAGqB,KAAKe,IAAIC;AACrB;AAEA,+CAA+C;AAC/C,OAAO,MAAMK,6BAA6B,cAAc"}

package/dist/esm/ui.js

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

package/dist/esm/ui.js.map

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

package/dist/esm/validation.js

@@ -1,19 +0,0 @@
-import { assertIsSnapIcon } from './icon';
-import { validateSnapManifestLocalizations } from './localization';
-import { assertIsSnapManifest } from './manifest/validation';
-import { validateSnapShasum } from './snaps';
-/**
- * Validates the files contained in a fetched snap.
- *
- * @param files - All potentially included files in a fetched snap.
- * @throws If any of the files are considered invalid.
- */ export async function validateFetchedSnap(files) {
-    assertIsSnapManifest(files.manifest.result);
-    await validateSnapShasum(files);
-    validateSnapManifestLocalizations(files.manifest.result, files.localizationFiles.map((file)=>file.result));
-    if (files.svgIcon) {
-        assertIsSnapIcon(files.svgIcon);
-    }
-}
-
-//# sourceMappingURL=validation.js.map

package/dist/esm/validation.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/validation.ts"],"sourcesContent":["import { assertIsSnapIcon } from './icon';\nimport { validateSnapManifestLocalizations } from './localization';\nimport { assertIsSnapManifest } from './manifest/validation';\nimport { validateSnapShasum } from './snaps';\nimport type { FetchedSnapFiles } from './types';\n\n/**\n * Validates the files contained in a fetched snap.\n *\n * @param files - All potentially included files in a fetched snap.\n * @throws If any of the files are considered invalid.\n */\nexport async function validateFetchedSnap(\n  files: FetchedSnapFiles,\n): Promise<void> {\n  assertIsSnapManifest(files.manifest.result);\n  await validateSnapShasum(files);\n  validateSnapManifestLocalizations(\n    files.manifest.result,\n    files.localizationFiles.map((file) => file.result),\n  );\n\n  if (files.svgIcon) {\n    assertIsSnapIcon(files.svgIcon);\n  }\n}\n"],"names":["assertIsSnapIcon","validateSnapManifestLocalizations","assertIsSnapManifest","validateSnapShasum","validateFetchedSnap","files","manifest","result","localizationFiles","map","file","svgIcon"],"mappings":"AAAA,SAASA,gBAAgB,QAAQ,SAAS;AAC1C,SAASC,iCAAiC,QAAQ,iBAAiB;AACnE,SAASC,oBAAoB,QAAQ,wBAAwB;AAC7D,SAASC,kBAAkB,QAAQ,UAAU;AAG7C;;;;;CAKC,GACD,OAAO,eAAeC,oBACpBC,KAAuB;IAEvBH,qBAAqBG,MAAMC,QAAQ,CAACC,MAAM;IAC1C,MAAMJ,mBAAmBE;IACzBJ,kCACEI,MAAMC,QAAQ,CAACC,MAAM,EACrBF,MAAMG,iBAAiB,CAACC,GAAG,CAAC,CAACC,OAASA,KAAKH,MAAM;IAGnD,IAAIF,MAAMM,OAAO,EAAE;QACjBX,iBAAiBK,MAAMM,OAAO;IAChC;AACF"}

package/dist/esm/versions.js

@@ -1,41 +0,0 @@
-import { VersionRangeStruct } from '@metamask/utils';
-import { maxSatisfying as maxSatisfyingSemver } from 'semver';
-import { validate } from 'superstruct';
-export const DEFAULT_REQUESTED_SNAP_VERSION = '*';
-/**
- * Return the highest version in the list that satisfies the range, or `null` if
- * none of them do. For the satisfaction check, pre-release versions will only
- * be checked if no satisfactory non-prerelease version is found first.
- *
- * @param versions - The list of version to check.
- * @param versionRange - The SemVer version range to check against.
- * @returns The highest version in the list that satisfies the range,
- * or `null` if none of them do.
- */ export function getTargetVersion(versions, versionRange) {
-    const maxSatisfyingNonPreRelease = maxSatisfyingSemver(versions, versionRange);
-    // By default don't use pre-release versions
-    if (maxSatisfyingNonPreRelease) {
-        return maxSatisfyingNonPreRelease;
-    }
-    // If no satisfying release version is found by default, try pre-release versions
-    return maxSatisfyingSemver(versions, versionRange, {
-        includePrerelease: true
-    });
-}
-/**
- * Parse a version received by some subject attempting to access a snap.
- *
- * @param version - The received version value.
- * @returns `*` if the version is `undefined` or `latest", otherwise returns
- * the specified version.
- */ export function resolveVersionRange(version) {
-    if (version === undefined || version === 'latest') {
-        return [
-            undefined,
-            DEFAULT_REQUESTED_SNAP_VERSION
-        ];
-    }
-    return validate(version, VersionRangeStruct);
-}
-
-//# sourceMappingURL=versions.js.map