@metamask/snaps-utils 0.38.0-flask.1 → 1.0.0

package/dist/esm/types.js

@@ -1,80 +0,0 @@
-import { assertStruct, VersionStruct } from '@metamask/utils';
-import { instance, is, object, optional, pattern, refine, size, string, type, union, assert as assertSuperstruct } from 'superstruct';
-import { HandlerType } from './handlers';
-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 = {}));
-/* eslint-enable @typescript-eslint/naming-convention */ export const SNAP_EXPORT_NAMES = Object.values(HandlerType);
-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 } from './handlers';\nimport { HandlerType } from './handlers';\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};\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};\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\nexport type SnapId = string;\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\nexport const SNAP_EXPORT_NAMES = Object.values(HandlerType);\n\nexport type SnapRpcHookArgs = {\n  origin: string;\n  handler: HandlerType;\n  request: Record<string, unknown>;\n};\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","HandlerType","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","SNAP_EXPORT_NAMES","Object","values","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;AAIrB,SAASC,WAAW,QAAQ,aAAa;WAIlC;UAAKC,gBAAgB;IAAhBA,iBACVC,iBAAc;IADJD,iBAEVE,cAAW;GAFDF,qBAAAA;AAKZ,OAAO,MAAMG,aAAaV,KACxBF,QACEG,UACA,gEAEF,GACA,KACA;AAEF,2EAA2E;AAC3E,sBAAsB;AACtB,OAAO,MAAMU,2BAA2BT,KAAK;IAC3CU,SAASnB;IACToB,MAAMH;IACNI,MAAMjB,SAASG,KAAKC,UAAU,GAAGc;IACjCC,YAAYnB,SACVD,OAAO;QACLM,MAAMF,KAAKC,UAAU,GAAGc;QACxBE,KAAKjB,KAAKC,UAAU,GAAGc;IACzB;AAEJ,GAAG;AAKH;;;;;CAKC,GACD,OAAO,SAASG,qBACdC,KAAc;IAEd,OAAOxB,GAAGwB,OAAOR;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASS,2BACdD,KAAc;IAEd3B,aACE2B,OACAR,0BACA,CAAC,CAAC,EAAEJ,iBAAiBC,WAAW,CAAC,YAAY,CAAC;AAElD;WA2BO;UAAKa,cAAc;IAAdA,eACVC,SAAM;IADID,eAEVE,WAAQ;GAFEF,mBAAAA;WAYL;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;AAIZ,sDAAsD,GAEtD,OAAO,MAAMG,oBAAoBC,OAAOC,MAAM,CAAC5B,aAAa;AA0B5D,OAAO,MAAM6B,MAAM,CAACC,OAAwB,CAAC,CAAC,GAC5CrC,OAAOI,MAAM;QAACF;QAAUP,SAAS2C;KAAK,GAAG,OAAO,CAAClB;QAC/C,IAAI;YACF,MAAMF,MAAM,IAAIoB,IAAIlB;YAEpB,MAAMmB,YAAYpC,KAAKkC;YACvB/B,kBAAkBY,KAAKqB;YACvB,OAAO;QACT,EAAE,OAAM;YACN,OAAO,CAAC,mBAAmB,EAAEnB,MAAMoB,QAAQ,GAAG,EAAE,CAAC;QACnD;IACF,GAAG;AAEL;;;;;;CAMC,GACD,OAAO,SAASC,WACdvB,GAAY,EACZmB,OAAwB,CAAC,CAAC;IAE1B,OAAOzC,GAAGsB,KAAKkB,IAAIC;AACrB;AAEA,+CAA+C;AAC/C,OAAO,MAAMK,6BAA6B,cAAc"}

package/dist/esm/validation.js

@@ -1,17 +0,0 @@
-import { assertIsSnapIcon } from './icon';
-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 function validateFetchedSnap(files) {
-    assertIsSnapManifest(files.manifest.result);
-    validateSnapShasum(files);
-    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 { assertIsSnapManifest } from './manifest/validation';\nimport { validateSnapShasum } from './snaps';\nimport type { SnapFiles } 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 function validateFetchedSnap(\n  files: Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon'>,\n): void {\n  assertIsSnapManifest(files.manifest.result);\n  validateSnapShasum(files);\n\n  if (files.svgIcon) {\n    assertIsSnapIcon(files.svgIcon);\n  }\n}\n"],"names":["assertIsSnapIcon","assertIsSnapManifest","validateSnapShasum","validateFetchedSnap","files","manifest","result","svgIcon"],"mappings":"AAAA,SAASA,gBAAgB,QAAQ,SAAS;AAC1C,SAASC,oBAAoB,QAAQ,wBAAwB;AAC7D,SAASC,kBAAkB,QAAQ,UAAU;AAG7C;;;;;CAKC,GACD,OAAO,SAASC,oBACdC,KAA6D;IAE7DH,qBAAqBG,MAAMC,QAAQ,CAACC,MAAM;IAC1CJ,mBAAmBE;IAEnB,IAAIA,MAAMG,OAAO,EAAE;QACjBP,iBAAiBI,MAAMG,OAAO;IAChC;AACF"}

package/dist/esm/versions.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/versions.ts"],"sourcesContent":["import type { Json, SemVerVersion, SemVerRange } from '@metamask/utils';\nimport { VersionRangeStruct } from '@metamask/utils';\nimport { maxSatisfying as maxSatisfyingSemver } from 'semver';\nimport { validate } from 'superstruct';\n\nexport const DEFAULT_REQUESTED_SNAP_VERSION = '*' as SemVerRange;\n\n/**\n * Return the highest version in the list that satisfies the range, or `null` if\n * none of them do. For the satisfaction check, pre-release versions will only\n * be checked if no satisfactory non-prerelease version is found first.\n *\n * @param versions - The list of version to check.\n * @param versionRange - The SemVer version range to check against.\n * @returns The highest version in the list that satisfies the range,\n * or `null` if none of them do.\n */\nexport function getTargetVersion(\n  versions: SemVerVersion[],\n  versionRange: SemVerRange,\n): SemVerVersion | null {\n  const maxSatisfyingNonPreRelease = maxSatisfyingSemver(\n    versions,\n    versionRange,\n  );\n\n  // By default don't use pre-release versions\n  if (maxSatisfyingNonPreRelease) {\n    return maxSatisfyingNonPreRelease;\n  }\n\n  // If no satisfying release version is found by default, try pre-release versions\n  return maxSatisfyingSemver(versions, versionRange, {\n    includePrerelease: true,\n  });\n}\n\n/**\n * Parse a version received by some subject attempting to access a snap.\n *\n * @param version - The received version value.\n * @returns `*` if the version is `undefined` or `latest\", otherwise returns\n * the specified version.\n */\nexport function resolveVersionRange(\n  version?: Json,\n): [error: undefined, range: SemVerRange] | [error: Error, range: undefined] {\n  if (version === undefined || version === 'latest') {\n    return [undefined, DEFAULT_REQUESTED_SNAP_VERSION];\n  }\n  return validate(version, VersionRangeStruct);\n}\n"],"names":["VersionRangeStruct","maxSatisfying","maxSatisfyingSemver","validate","DEFAULT_REQUESTED_SNAP_VERSION","getTargetVersion","versions","versionRange","maxSatisfyingNonPreRelease","includePrerelease","resolveVersionRange","version","undefined"],"mappings":"AACA,SAASA,kBAAkB,QAAQ,kBAAkB;AACrD,SAASC,iBAAiBC,mBAAmB,QAAQ,SAAS;AAC9D,SAASC,QAAQ,QAAQ,cAAc;AAEvC,OAAO,MAAMC,iCAAiC,IAAmB;AAEjE;;;;;;;;;CASC,GACD,OAAO,SAASC,iBACdC,QAAyB,EACzBC,YAAyB;IAEzB,MAAMC,6BAA6BN,oBACjCI,UACAC;IAGF,4CAA4C;IAC5C,IAAIC,4BAA4B;QAC9B,OAAOA;IACT;IAEA,iFAAiF;IACjF,OAAON,oBAAoBI,UAAUC,cAAc;QACjDE,mBAAmB;IACrB;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,oBACdC,OAAc;IAEd,IAAIA,YAAYC,aAAaD,YAAY,UAAU;QACjD,OAAO;YAACC;YAAWR;SAA+B;IACpD;IACA,OAAOD,SAASQ,SAASX;AAC3B"}

package/dist/esm/virtual-file/VirtualFile.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/virtual-file/VirtualFile.ts"],"sourcesContent":["// TODO(ritave): Move into separate package @metamask/vfile / @metamask/utils + @metamask/to-vfile when passes code review\n// TODO(ritave): Streaming vfile contents similar to vinyl maybe?\n// TODO(ritave): Move fixing manifest in cli and bundler plugins to write messages to vfile\n//               similar to unified instead of throwing \"ProgrammaticallyFixableErrors\".\n//\n// Using https://github.com/vfile/vfile would be helpful, but they only support ESM and we need to support CommonJS.\n// https://github.com/gulpjs/vinyl is also good, but they normalize paths, which we can't do, because\n// we're calculating checksums based on original path.\nimport { assert } from '@metamask/utils';\n\nimport { deepClone } from '../deep-clone';\n\n/**\n * This map registers the type of the {@link VirtualFile.data} key of a {@link VirtualFile}.\n *\n * This type can be augmented to register custom `data` types.\n *\n * @example\n * declare module '@metamask/snaps-utils' {\n *   interface DataMap {\n *     // `file.data.name` is typed as `string`\n *     name: string\n *   }\n * }\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-interface\nexport interface DataMap {}\n\nexport type Value = string | Uint8Array;\nexport type Compatible<Result = unknown> =\n  | string\n  | Uint8Array\n  | Options<Result>;\nexport type Data = Record<string, unknown> & Partial<DataMap>;\nexport type Options<Result = unknown> = {\n  value: Value;\n  path?: string;\n  data?: Data;\n  result?: Result;\n};\n\nexport class VirtualFile<Result = unknown> {\n  constructor(value?: Compatible<Result>) {\n    let options: Options | undefined;\n    if (typeof value === 'string' || value instanceof Uint8Array) {\n      options = { value };\n    } else {\n      options = value;\n    }\n\n    this.value = options?.value ?? '';\n    // This situations happens when there's no .result used,\n    // we expect the file to have default generic in that situation:\n    // VirtualFile<unknown> which will handle undefined properly\n    //\n    // While not 100% type safe, it'll be way less frustrating to work with.\n    // The alternative would be to have VirtualFile.result be Result | undefined\n    // and that would result in needing to branch out and check in all situations.\n    //\n    // In short, optimizing for most common use case.\n    this.result = options?.result ?? (undefined as any);\n    this.data = options?.data ?? {};\n    this.path = options?.path ?? '/';\n  }\n\n  value: Value;\n\n  result: Result;\n\n  data: Data;\n\n  path: string;\n\n  toString(encoding?: string) {\n    if (typeof this.value === 'string') {\n      assert(encoding === undefined, 'Tried to encode string.');\n      return this.value;\n    }\n    const decoder = new TextDecoder(encoding);\n    return decoder.decode(this.value);\n  }\n\n  clone() {\n    const vfile = new VirtualFile<Result>();\n    if (typeof this.value === 'string') {\n      vfile.value = this.value;\n    } else {\n      // deep-clone doesn't clone Buffer properly, even if it's a sub-class of Uint8Array\n      vfile.value = this.value.slice(0);\n    }\n    vfile.result = deepClone(this.result);\n    vfile.data = deepClone(this.data);\n    vfile.path = this.path;\n    return vfile;\n  }\n}\n"],"names":["assert","deepClone","VirtualFile","toString","encoding","value","undefined","decoder","TextDecoder","decode","clone","vfile","slice","result","data","path","constructor","options","Uint8Array"],"mappings":"AAAA,0HAA0H;AAC1H,iEAAiE;AACjE,2FAA2F;AAC3F,wFAAwF;AACxF,EAAE;AACF,oHAAoH;AACpH,qGAAqG;AACrG,sDAAsD;;;;;;;;;;;;;;AACtD,SAASA,MAAM,QAAQ,kBAAkB;AAEzC,SAASC,SAAS,QAAQ,gBAAgB;AA+B1C,OAAO,MAAMC;IAgCXC,SAASC,QAAiB,EAAE;QAC1B,IAAI,OAAO,IAAI,CAACC,KAAK,KAAK,UAAU;YAClCL,OAAOI,aAAaE,WAAW;YAC/B,OAAO,IAAI,CAACD,KAAK;QACnB;QACA,MAAME,UAAU,IAAIC,YAAYJ;QAChC,OAAOG,QAAQE,MAAM,CAAC,IAAI,CAACJ,KAAK;IAClC;IAEAK,QAAQ;QACN,MAAMC,QAAQ,IAAIT;QAClB,IAAI,OAAO,IAAI,CAACG,KAAK,KAAK,UAAU;YAClCM,MAAMN,KAAK,GAAG,IAAI,CAACA,KAAK;QAC1B,OAAO;YACL,mFAAmF;YACnFM,MAAMN,KAAK,GAAG,IAAI,CAACA,KAAK,CAACO,KAAK,CAAC;QACjC;QACAD,MAAME,MAAM,GAAGZ,UAAU,IAAI,CAACY,MAAM;QACpCF,MAAMG,IAAI,GAAGb,UAAU,IAAI,CAACa,IAAI;QAChCH,MAAMI,IAAI,GAAG,IAAI,CAACA,IAAI;QACtB,OAAOJ;IACT;IApDAK,YAAYX,KAA0B,CAAE;QAuBxCA,uBAAAA,SAAAA,KAAAA;QAEAQ,uBAAAA,UAAAA,KAAAA;QAEAC,uBAAAA,QAAAA,KAAAA;QAEAC,uBAAAA,QAAAA,KAAAA;QA5BE,IAAIE;QACJ,IAAI,OAAOZ,UAAU,YAAYA,iBAAiBa,YAAY;YAC5DD,UAAU;gBAAEZ;YAAM;QACpB,OAAO;YACLY,UAAUZ;QACZ;QAEA,IAAI,CAACA,KAAK,GAAGY,SAASZ,SAAS;QAC/B,wDAAwD;QACxD,gEAAgE;QAChE,4DAA4D;QAC5D,EAAE;QACF,wEAAwE;QACxE,4EAA4E;QAC5E,8EAA8E;QAC9E,EAAE;QACF,iDAAiD;QACjD,IAAI,CAACQ,MAAM,GAAGI,SAASJ,UAAWP;QAClC,IAAI,CAACQ,IAAI,GAAGG,SAASH,QAAQ,CAAC;QAC9B,IAAI,CAACC,IAAI,GAAGE,SAASF,QAAQ;IAC/B;AAgCF"}

package/dist/esm/virtual-file/index.browser.js

@@ -1,3 +0,0 @@
-export * from './VirtualFile';
-
-//# sourceMappingURL=index.browser.js.map

package/dist/esm/virtual-file/index.browser.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/virtual-file/index.browser.ts"],"sourcesContent":["export * from './VirtualFile';\n"],"names":[],"mappings":"AAAA,cAAc,gBAAgB"}

package/dist/esm/virtual-file/index.js

@@ -1,4 +0,0 @@
-export * from './toVirtualFile';
-export * from './VirtualFile';
-
-//# sourceMappingURL=index.js.map

package/dist/esm/virtual-file/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/virtual-file/index.ts"],"sourcesContent":["export * from './toVirtualFile';\nexport * from './VirtualFile';\n"],"names":[],"mappings":"AAAA,cAAc,kBAAkB;AAChC,cAAc,gBAAgB"}

package/dist/esm/virtual-file/toVirtualFile.js

@@ -1,26 +0,0 @@
-import { promises as fsPromises } from 'fs';
-import { VirtualFile } from './VirtualFile';
-/**
- * Reads a file from filesystem and creates a vfile.
- *
- * @param path - Filesystem path to load the contents from.
- * @param encoding - Optional encoding to pass down to fs.readFile.
- * @returns Promise returning VFile with loaded file contents.
- */ export async function readVirtualFile(path, encoding = null) {
-    return new VirtualFile({
-        path,
-        value: await fsPromises.readFile(path, {
-            encoding
-        })
-    });
-}
-/**
- * Writes vfile to filesystem.
- *
- * @param vfile - The vfile to write.
- * @param options - Options to pass down to fs.writeFile.
- */ export async function writeVirtualFile(vfile, options) {
-    return fsPromises.writeFile(vfile.path, vfile.value, options);
-}
-
-//# sourceMappingURL=toVirtualFile.js.map

package/dist/esm/virtual-file/toVirtualFile.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/virtual-file/toVirtualFile.ts"],"sourcesContent":["import { promises as fsPromises } from 'fs';\n\nimport { VirtualFile } from './VirtualFile';\n\n/**\n * Reads a file from filesystem and creates a vfile.\n *\n * @param path - Filesystem path to load the contents from.\n * @param encoding - Optional encoding to pass down to fs.readFile.\n * @returns Promise returning VFile with loaded file contents.\n */\nexport async function readVirtualFile(\n  path: string,\n  encoding: BufferEncoding | null = null,\n) {\n  return new VirtualFile({\n    path,\n    value: await fsPromises.readFile(path, { encoding }),\n  });\n}\n\ntype WriteVFileOptions = Exclude<\n  Parameters<typeof fsPromises['writeFile']>[2],\n  undefined\n>;\n\n/**\n * Writes vfile to filesystem.\n *\n * @param vfile - The vfile to write.\n * @param options - Options to pass down to fs.writeFile.\n */\nexport async function writeVirtualFile(\n  vfile: VirtualFile,\n  options?: WriteVFileOptions,\n) {\n  return fsPromises.writeFile(vfile.path, vfile.value, options);\n}\n"],"names":["promises","fsPromises","VirtualFile","readVirtualFile","path","encoding","value","readFile","writeVirtualFile","vfile","options","writeFile"],"mappings":"AAAA,SAASA,YAAYC,UAAU,QAAQ,KAAK;AAE5C,SAASC,WAAW,QAAQ,gBAAgB;AAE5C;;;;;;CAMC,GACD,OAAO,eAAeC,gBACpBC,IAAY,EACZC,WAAkC,IAAI;IAEtC,OAAO,IAAIH,YAAY;QACrBE;QACAE,OAAO,MAAML,WAAWM,QAAQ,CAACH,MAAM;YAAEC;QAAS;IACpD;AACF;AAOA;;;;;CAKC,GACD,OAAO,eAAeG,iBACpBC,KAAkB,EAClBC,OAA2B;IAE3B,OAAOT,WAAWU,SAAS,CAACF,MAAML,IAAI,EAAEK,MAAMH,KAAK,EAAEI;AACvD"}

package/dist/types/enum.d.ts

@@ -1,30 +0,0 @@
-import type { Struct } from 'superstruct';
-/**
- * Get the enum values as union type. This allows using both the enum string
- * values and the enum itself as values.
- *
- * Note: This only works for string enums.
- *
- * @example
- * ```typescript
- * enum Foo {
- *   Bar = 'bar',
- *   Baz = 'baz',
- * }
- *
- * type FooValue = EnumToUnion<Foo>;
- * // FooValue is 'bar' | 'baz'
- *
- * const foo: FooValue = Foo.Bar; // Works
- * const foo: FooValue = 'bar'; // Also works
- * ```
- */
-export declare type EnumToUnion<Type extends string> = `${Type}`;
-/**
- * Superstruct struct for validating an enum value. This allows using both the
- * enum string values and the enum itself as values.
- *
- * @param constant - The enum to validate against.
- * @returns The superstruct struct.
- */
-export declare function enumValue<Type extends string>(constant: Type): Struct<EnumToUnion<Type>, null>;

package/dist/types/errors.d.ts

@@ -1,10 +0,0 @@
-/**
- * Get the error message from an unknown error type.
- *
- * - If the error is an object with a `message` property, return the message.
- * - Otherwise, return the error converted to a string.
- *
- * @param error - The error to get the message from.
- * @returns The error message.
- */
-export declare function getErrorMessage(error: unknown): string;

package/dist/types/handlers.d.ts

@@ -1,144 +0,0 @@
-import type { Component } from '@metamask/snaps-ui';
-import type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';
-export declare enum HandlerType {
-    OnRpcRequest = "onRpcRequest",
-    OnTransaction = "onTransaction",
-    OnCronjob = "onCronjob",
-    OnInstall = "onInstall",
-    OnUpdate = "onUpdate"
-}
-declare type SnapHandler = {
-    /**
-     * The type of handler.
-     */
-    type: HandlerType;
-    /**
-     * Whether the handler is required, i.e., whether the request will fail if the
-     * handler is called, but the snap does not export it.
-     *
-     * This is primarily used for the lifecycle handlers, which are optional.
-     */
-    required: boolean;
-    /**
-     * Validate the given snap export. This should return a type guard for the
-     * handler type.
-     *
-     * @param snapExport - The export to validate.
-     * @returns Whether the export is valid.
-     */
-    validator: (snapExport: unknown) => boolean;
-};
-export declare const SNAP_EXPORTS: {
-    readonly onRpcRequest: {
-        readonly type: HandlerType.OnRpcRequest;
-        readonly required: true;
-        readonly validator: (snapExport: unknown) => snapExport is OnRpcRequestHandler<Record<string, Json> | Json[] | undefined>;
-    };
-    readonly onTransaction: {
-        readonly type: HandlerType.OnTransaction;
-        readonly required: true;
-        readonly validator: (snapExport: unknown) => snapExport is OnTransactionHandler;
-    };
-    readonly onCronjob: {
-        readonly type: HandlerType.OnCronjob;
-        readonly required: true;
-        readonly validator: (snapExport: unknown) => snapExport is OnCronjobHandler<Record<string, Json> | Json[] | undefined>;
-    };
-    readonly onInstall: {
-        readonly type: HandlerType.OnInstall;
-        readonly required: false;
-        readonly validator: (snapExport: unknown) => snapExport is LifecycleEventHandler;
-    };
-    readonly onUpdate: {
-        readonly type: HandlerType.OnUpdate;
-        readonly required: false;
-        readonly validator: (snapExport: unknown) => snapExport is LifecycleEventHandler;
-    };
-};
-/**
- * The `onRpcRequest` handler. This is called whenever a JSON-RPC request is
- * made to the snap.
- *
- * @param args - The request arguments.
- * @param args.origin - The origin of the request. This can be the ID of another
- * snap, or the URL of a dapp.
- * @param args.request - The JSON-RPC request sent to the snap.
- * @returns The JSON-RPC response. This must be a JSON-serializable value.
- */
-export declare type OnRpcRequestHandler<Params extends JsonRpcParams = JsonRpcParams> = (args: {
-    origin: string;
-    request: JsonRpcRequest<Params>;
-}) => Promise<unknown>;
-/**
- * The response from a snap's `onTransaction` handler.
- *
- * @property content - A custom UI component, that will be shown in MetaMask. Can be created using `@metamask/snaps-ui`.
- *
- * If the snap has no insights about the transaction, this should be `null`.
- */
-export declare type OnTransactionResponse = {
-    content: Component | null;
-};
-/**
- * The `onTransaction` handler. This is called whenever a transaction is
- * submitted to the snap. It can return insights about the transaction, which
- * will be displayed to the user.
- *
- * @param args - The request arguments.
- * @param args.transaction - The transaction object.
- * @param args.chainId - The CAIP-2 chain ID of the network the transaction is
- * being submitted to.
- * @param args.transactionOrigin - The origin of the transaction. This is the
- * URL of the dapp that submitted the transaction.
- * @returns Insights about the transaction. See {@link OnTransactionResponse}.
- */
-export declare type OnTransactionHandler = (args: {
-    transaction: {
-        [key: string]: Json;
-    };
-    chainId: string;
-    transactionOrigin?: string;
-}) => Promise<OnTransactionResponse>;
-/**
- * The `onCronjob` handler. This is called on a regular interval, as defined by
- * the snap's manifest.
- *
- * @param args - The request arguments.
- * @param args.request - The JSON-RPC request sent to the snap.
- */
-export declare type OnCronjobHandler<Params extends JsonRpcParams = JsonRpcParams> = (args: {
-    request: JsonRpcRequest<Params>;
-}) => Promise<unknown>;
-/**
- * A handler that can be used for the lifecycle hooks.
- */
-export declare type LifecycleEventHandler = (args: {
-    request: JsonRpcRequest;
-}) => Promise<unknown>;
-/**
- * The `onInstall` handler. This is called after the snap is installed.
- *
- * This type is an alias for {@link LifecycleEventHandler}.
- */
-export declare type OnInstallHandler = LifecycleEventHandler;
-/**
- * The `onUpdate` handler. This is called after the snap is updated.
- *
- * This type is an alias for {@link LifecycleEventHandler}.
- */
-export declare type OnUpdateHandler = LifecycleEventHandler;
-/**
- * Utility type for getting the handler function type from a handler type.
- */
-export declare type HandlerFunction<Type extends SnapHandler> = Type['validator'] extends (snapExport: unknown) => snapExport is infer Handler ? Handler : never;
-/**
- * All the function-based handlers that a snap can implement.
- */
-export declare type SnapFunctionExports = {
-    [Key in keyof typeof SNAP_EXPORTS]?: HandlerFunction<typeof SNAP_EXPORTS[Key]>;
-};
-/**
- * All handlers that a snap can implement.
- */
-export declare type SnapExports = SnapFunctionExports;
-export {};

package/dist/types/icon.d.ts

@@ -1,4 +0,0 @@
-import type { VirtualFile } from './virtual-file';
-export declare const SVG_MAX_BYTE_SIZE = 100000;
-export declare const SVG_MAX_BYTE_SIZE_TEXT: string;
-export declare const assertIsSnapIcon: (icon: VirtualFile) => void;

package/dist/types/json.d.ts

@@ -1,13 +0,0 @@
-import type { Json } from '@metamask/utils';
-/**
- * Parse JSON safely.
- *
- * Does multiple kinds of validation and strips unwanted properties like
- * `__proto__` and `constructor`.
- *
- * @param json - A JSON string to be parsed.
- * @returns The parsed JSON object.
- * @template Type - The type of the JSON object. The type is not actually
- * checked, but it is used to infer the return type.
- */
-export declare function parseJson<Type extends Json = Json>(json: string): Type;

package/dist/types/namespace.d.ts

@@ -1,124 +0,0 @@
-import type { Infer } from 'superstruct';
-export declare const CHAIN_ID_REGEX: RegExp;
-export declare const ACCOUNT_ID_REGEX: RegExp;
-/**
- * Parse a chain ID string to an object containing the namespace and reference.
- * This validates the chain ID before parsing it.
- *
- * @param chainId - The chain ID to validate and parse.
- * @returns The parsed chain ID.
- */
-export declare function parseChainId(chainId: ChainId): {
-    namespace: NamespaceId;
-    reference: string;
-};
-/**
- * Parse an account ID to an object containing the chain, chain ID and address.
- * This validates the account ID before parsing it.
- *
- * @param accountId - The account ID to validate and parse.
- * @returns The parsed account ID.
- */
-export declare function parseAccountId(accountId: AccountId): {
-    chain: {
-        namespace: NamespaceId;
-        reference: string;
-    };
-    chainId: ChainId;
-    address: string;
-};
-/**
- * A helper struct for a string with a minimum length of 1 and a maximum length
- * of 40.
- */
-export declare const LimitedString: import("superstruct").Struct<string, null>;
-/**
- * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
- */
-export declare const ChainIdStruct: import("superstruct").Struct<string, null>;
-export declare type ChainId = `${string}:${string}`;
-export declare const AccountIdStruct: import("superstruct").Struct<string, null>;
-export declare type AccountId = `${ChainId}:${string}`;
-export declare const AccountIdArrayStruct: import("superstruct").Struct<string[], import("superstruct").Struct<string, null>>;
-/**
- * A chain descriptor.
- */
-export declare const ChainStruct: import("superstruct").Struct<{
-    name: string;
-    id: string;
-}, {
-    id: import("superstruct").Struct<string, null>;
-    name: import("superstruct").Struct<string, null>;
-}>;
-export declare type Chain = Infer<typeof ChainStruct>;
-export declare const NamespaceStruct: import("superstruct").Struct<{
-    chains: {
-        name: string;
-        id: string;
-    }[];
-    methods?: string[] | undefined;
-    events?: string[] | undefined;
-}, {
-    /**
-     * A list of supported chains in the namespace.
-     */
-    chains: import("superstruct").Struct<{
-        name: string;
-        id: string;
-    }[], import("superstruct").Struct<{
-        name: string;
-        id: string;
-    }, {
-        id: import("superstruct").Struct<string, null>;
-        name: import("superstruct").Struct<string, null>;
-    }>>;
-    /**
-     * A list of supported RPC methods on the namespace, that a DApp can call.
-     */
-    methods: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-    /**
-     * A list of supported RPC events on the namespace, that a DApp can listen to.
-     */
-    events: import("superstruct").Struct<string[] | undefined, import("superstruct").Struct<string, null>>;
-}>;
-export declare type Namespace = Infer<typeof NamespaceStruct>;
-/**
- * A CAIP-2 namespace, i.e., the first part of a chain ID.
- */
-export declare const NamespaceIdStruct: import("superstruct").Struct<string, null>;
-export declare type NamespaceId = Infer<typeof NamespaceIdStruct>;
-/**
- * Check if the given value is a CAIP-2 namespace ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-2 namespace ID.
- */
-export declare function isNamespaceId(value: unknown): value is NamespaceId;
-/**
- * Check if the given value is a CAIP-2 chain ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-2 chain ID.
- */
-export declare function isChainId(value: unknown): value is ChainId;
-/**
- * Check if the given value is a CAIP-10 account ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-10 account ID.
- */
-export declare function isAccountId(value: unknown): value is AccountId;
-/**
- * Check if the given value is an array of CAIP-10 account IDs.
- *
- * @param value - The value to check.
- * @returns Whether the value is an array of CAIP-10 account IDs.
- */
-export declare function isAccountIdArray(value: unknown): value is AccountId[];
-/**
- * Check if a value is a {@link Namespace}.
- *
- * @param value - The value to validate.
- * @returns True if the value is a valid {@link Namespace}.
- */
-export declare function isNamespace(value: unknown): value is Namespace;

package/dist/types/strings.d.ts

@@ -1,8 +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 declare function indent(message: string, spaces?: number): string;