@metamask/snaps-utils 5.1.2 → 6.0.0

package/dist/esm/structs.js

@@ -1,8 +1,25 @@
-import { isObject } from '@metamask/utils';
+import { union } from '@metamask/snaps-sdk';
+import { assert, isObject } from '@metamask/utils';
 import { bold, green, red } from 'chalk';
 import { resolve } from 'path';
-import { Struct, StructError, create, string, coerce } from 'superstruct';
+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
@@ -22,7 +39,7 @@ import { indent } from './strings';
  * console.log(value.file); // /process/cwd/path/to/file
  * ```
  */ export function file() {
-    return coerce(string(), string(), (value)=>{
+    return superstructCoerce(string(), string(), (value)=>{
         return resolve(process.cwd(), value);
     });
 }
@@ -41,12 +58,12 @@ import { indent } from './strings';
     });
 }
 export class SnapsStructError extends StructError {
-    constructor(struct, prefix, suffix, failure, failures){
+    constructor(struct, prefix, suffix, failure, failures, colorize = true){
         super(failure, failures);
         this.name = 'SnapsStructError';
         this.message = `${prefix}.\n\n${getStructErrorMessage(struct, [
             ...failures()
-        ])}${suffix ? `\n\n${suffix}` : ''}`;
+        ], colorize)}${suffix ? `\n\n${suffix}` : ''}`;
     }
 }
 /**
@@ -70,9 +87,10 @@ export class SnapsStructError extends StructError {
  * @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 }) {
-    return new SnapsStructError(struct, prefix, suffix, error, ()=>arrayToGenerator(error.failures()));
+ */ 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
@@ -118,25 +136,27 @@ export class SnapsStructError extends StructError {
  * 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) {
+ */ export function getUnionStructNames(struct, colorize = true) {
     if (Array.isArray(struct.schema)) {
-        return struct.schema.map(({ type })=>green(type));
+        return struct.schema.map(({ type })=>color(type, green, colorize));
     }
     return null;
 }
 /**
- * Get a error prefix from a `superstruct` failure. This is useful for
+ * 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) {
+ */ export function getStructErrorPrefix(failure, colorize = true) {
     if (failure.type === 'never' || failure.path.length === 0) {
         return '';
     }
-    return `At path: ${bold(failure.path.join('.'))} — `;
+    return `At path: ${color(failure.path.join('.'), bold, colorize)} — `;
 }
 /**
  * Get a string describing the failure. This is similar to the `message`
@@ -145,13 +165,14 @@ export class SnapsStructError extends StructError {
  *
  * @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) {
-    const received = red(JSON.stringify(failure.value));
-    const prefix = getStructErrorPrefix(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);
+        const unionNames = getUnionStructNames(childStruct, colorize);
         if (unionNames) {
             return `${prefix}Expected the value to be one of: ${unionNames.join(', ')}, but received: ${received}.`;
         }
@@ -160,13 +181,17 @@ export class SnapsStructError extends StructError {
     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 \`${green('$1')}\`,`).replace(/, but received: (.+)/u, `, but received: ${red('$1')}`);
+        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: ${bold(failure.path.join('.'))}, received: ${received}.`;
+        return `Unknown key: ${color(failure.path.join('.'), bold, colorize)}, received: ${received}.`;
     }
-    return `${prefix}Expected a value of type ${green(failure.type)}, but 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
@@ -174,10 +199,97 @@ export class SnapsStructError extends StructError {
  *
  * @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) {
-    const formattedFailures = failures.map((failure)=>indent(`• ${getStructFailureMessage(struct, failure)}`));
+ */ 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 +1 @@
-{"version":3,"sources":["../../src/structs.ts"],"sourcesContent":["import { isObject } from '@metamask/utils';\nimport { bold, green, red } from 'chalk';\nimport { resolve } from 'path';\nimport type { Failure } from 'superstruct';\nimport { Struct, StructError, create, string, coerce } 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 * 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 coerce(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  ) {\n    super(failure, failures);\n\n    this.name = 'SnapsStructError';\n    this.message = `${prefix}.\\n\\n${getStructErrorMessage(struct, [\n      ...failures(),\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};\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 * @returns The `SnapsStructError`.\n */\nexport function getError<Type, Schema>({\n  struct,\n  prefix,\n  suffix = '',\n  error,\n}: GetErrorOptions<Type, Schema>) {\n  return new SnapsStructError(struct, prefix, suffix, error, () =>\n    arrayToGenerator(error.failures()),\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 * @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) {\n  if (Array.isArray(struct.schema)) {\n    return struct.schema.map(({ type }) => green(type));\n  }\n\n  return null;\n}\n\n/**\n * Get a 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 * @returns The error prefix.\n */\nexport function getStructErrorPrefix(failure: Failure) {\n  if (failure.type === 'never' || failure.path.length === 0) {\n    return '';\n  }\n\n  return `At path: ${bold(failure.path.join('.'))} — `;\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 * @returns A string describing the failure.\n */\nexport function getStructFailureMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failure: Failure,\n) {\n  const received = red(JSON.stringify(failure.value));\n  const prefix = getStructErrorPrefix(failure);\n\n  if (failure.type === 'union') {\n    const childStruct = getStructFromPath(struct, failure.path);\n    const unionNames = getUnionStructNames(childStruct);\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(/the literal `(.+)`,/u, `the value to be \\`${green('$1')}\\`,`)\n      .replace(/, but received: (.+)/u, `, but received: ${red('$1')}`);\n\n    return `${prefix}${message}.`;\n  }\n\n  if (failure.type === 'never') {\n    return `Unknown key: ${bold(\n      failure.path.join('.'),\n    )}, received: ${received}.`;\n  }\n\n  return `${prefix}Expected a value of type ${green(\n    failure.type,\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 * @returns A string describing the errors.\n */\nexport function getStructErrorMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failures: Failure[],\n) {\n  const formattedFailures = failures.map((failure) =>\n    indent(`• ${getStructFailureMessage(struct, failure)}`),\n  );\n\n  return formattedFailures.join('\\n');\n}\n"],"names":["isObject","bold","green","red","resolve","Struct","StructError","create","string","coerce","indent","file","value","process","cwd","named","name","struct","type","SnapsStructError","constructor","prefix","suffix","failure","failures","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","formattedFailures"],"mappings":"AAAA,SAASA,QAAQ,QAAQ,kBAAkB;AAC3C,SAASC,IAAI,EAAEC,KAAK,EAAEC,GAAG,QAAQ,QAAQ;AACzC,SAASC,OAAO,QAAQ,OAAO;AAE/B,SAASC,MAAM,EAAEC,WAAW,EAAEC,MAAM,EAAEC,MAAM,EAAEC,MAAM,QAAQ,cAAc;AAG1E,SAASC,MAAM,QAAQ,YAAY;AA6BnC;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASC;IACd,OAAOF,OAAOD,UAAUA,UAAU,CAACI;QACjC,OAAOR,QAAQS,QAAQC,GAAG,IAAIF;IAChC;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASG,MACdC,IAAY,EACZC,MAA4B;IAE5B,OAAO,IAAIZ,OAAO;QAChB,GAAGY,MAAM;QACTC,MAAMF;IACR;AACF;AAEA,OAAO,MAAMG,yBAAuCb;IAClDc,YACEH,MAA4B,EAC5BI,MAAc,EACdC,MAAc,EACdC,OAAoB,EACpBC,QAAkC,CAClC;QACA,KAAK,CAACD,SAASC;QAEf,IAAI,CAACR,IAAI,GAAG;QACZ,IAAI,CAACS,OAAO,GAAG,CAAC,EAAEJ,OAAO,KAAK,EAAEK,sBAAsBT,QAAQ;eACzDO;SACJ,EAAE,EAAEF,SAAS,CAAC,IAAI,EAAEA,OAAO,CAAC,GAAG,GAAG,CAAC;IACtC;AACF;AASA;;;;;;;CAOC,GACD,OAAO,UAAUK,iBACfC,KAAa;IAEb,KAAK,MAAMC,QAAQD,MAAO;QACxB,MAAMC;IACR;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,SAAuB,EACrCb,MAAM,EACNI,MAAM,EACNC,SAAS,EAAE,EACXS,KAAK,EACyB;IAC9B,OAAO,IAAIZ,iBAAiBF,QAAQI,QAAQC,QAAQS,OAAO,IACzDJ,iBAAiBI,MAAMP,QAAQ;AAEnC;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASQ,iBACdpB,KAAc,EACdK,MAA4B,EAC5BI,MAAc,EACdC,SAAS,EAAE;IAEX,IAAI;QACF,OAAOf,OAAOK,OAAOK;IACvB,EAAE,OAAOc,OAAO;QACd,IAAIA,iBAAiBzB,aAAa;YAChC,MAAMwB,SAAS;gBAAEb;gBAAQI;gBAAQC;gBAAQS;YAAM;QACjD;QAEA,MAAMA;IACR;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,kBACdhB,MAA4B,EAC5BiB,IAAc;IAEd,OAAOA,KAAKC,MAAM,CAAY,CAACC,QAAQC;QACrC,IAAIrC,SAASiB,OAAOqB,MAAM,KAAKrB,OAAOqB,MAAM,CAACD,IAAI,EAAE;YACjD,OAAOpB,OAAOqB,MAAM,CAACD,IAAI;QAC3B;QAEA,OAAOD;IACT,GAAGnB;AACL;AAEA;;;;;;CAMC,GACD,OAAO,SAASsB,oBACdtB,MAA4B;IAE5B,IAAIuB,MAAMC,OAAO,CAACxB,OAAOqB,MAAM,GAAG;QAChC,OAAOrB,OAAOqB,MAAM,CAACI,GAAG,CAAC,CAAC,EAAExB,IAAI,EAAE,GAAKhB,MAAMgB;IAC/C;IAEA,OAAO;AACT;AAEA;;;;;;CAMC,GACD,OAAO,SAASyB,qBAAqBpB,OAAgB;IACnD,IAAIA,QAAQL,IAAI,KAAK,WAAWK,QAAQW,IAAI,CAACU,MAAM,KAAK,GAAG;QACzD,OAAO;IACT;IAEA,OAAO,CAAC,SAAS,EAAE3C,KAAKsB,QAAQW,IAAI,CAACW,IAAI,CAAC,MAAM,GAAG,CAAC;AACtD;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASC,wBACd7B,MAA4B,EAC5BM,OAAgB;IAEhB,MAAMwB,WAAW5C,IAAI6C,KAAKC,SAAS,CAAC1B,QAAQX,KAAK;IACjD,MAAMS,SAASsB,qBAAqBpB;IAEpC,IAAIA,QAAQL,IAAI,KAAK,SAAS;QAC5B,MAAMgC,cAAcjB,kBAAkBhB,QAAQM,QAAQW,IAAI;QAC1D,MAAMiB,aAAaZ,oBAAoBW;QAEvC,IAAIC,YAAY;YACd,OAAO,CAAC,EAAE9B,OAAO,iCAAiC,EAAE8B,WAAWN,IAAI,CACjE,MACA,gBAAgB,EAAEE,SAAS,CAAC,CAAC;QACjC;QAEA,OAAO,CAAC,EAAE1B,OAAO,EAAEE,QAAQE,OAAO,CAAC,CAAC,CAAC;IACvC;IAEA,IAAIF,QAAQL,IAAI,KAAK,WAAW;QAC9B,yEAAyE;QACzE,0EAA0E;QAC1E,MAAMO,UAAUF,QAAQE,OAAO,CAC5B2B,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,EAAElD,MAAM,MAAM,GAAG,CAAC,EACrEkD,OAAO,CAAC,yBAAyB,CAAC,gBAAgB,EAAEjD,IAAI,MAAM,CAAC;QAElE,OAAO,CAAC,EAAEkB,OAAO,EAAEI,QAAQ,CAAC,CAAC;IAC/B;IAEA,IAAIF,QAAQL,IAAI,KAAK,SAAS;QAC5B,OAAO,CAAC,aAAa,EAAEjB,KACrBsB,QAAQW,IAAI,CAACW,IAAI,CAAC,MAClB,YAAY,EAAEE,SAAS,CAAC,CAAC;IAC7B;IAEA,OAAO,CAAC,EAAE1B,OAAO,yBAAyB,EAAEnB,MAC1CqB,QAAQL,IAAI,EACZ,gBAAgB,EAAE6B,SAAS,CAAC,CAAC;AACjC;AAEA;;;;;;;CAOC,GACD,OAAO,SAASrB,sBACdT,MAA4B,EAC5BO,QAAmB;IAEnB,MAAM6B,oBAAoB7B,SAASkB,GAAG,CAAC,CAACnB,UACtCb,OAAO,CAAC,EAAE,EAAEoC,wBAAwB7B,QAAQM,SAAS,CAAC;IAGxD,OAAO8B,kBAAkBR,IAAI,CAAC;AAChC"}
+{"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/types/caveats.d.ts

@@ -15,6 +15,10 @@ export declare enum SnapCaveatType {
      * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.
      */
     TransactionOrigin = "transactionOrigin",
+    /**
+     * Caveat specifying access to the signature origin, used by `endowment:signature-insight`.
+     */
+    SignatureOrigin = "signatureOrigin",
     /**
      * The origins that a Snap can receive JSON-RPC messages from.
      */
@@ -30,5 +34,13 @@ export declare enum SnapCaveatType {
     /**
      * Caveat specifying the CAIP-2 chain IDs that a snap can service, currently limited to `endowment:name-lookup`.
      */
-    ChainIds = "chainIds"
+    ChainIds = "chainIds",
+    /**
+     * Caveat specifying the input that a name lookup snap can service, currently limited to `endowment:name-lookup`.
+     */
+    LookupMatchers = "lookupMatchers",
+    /**
+     * Caveat specifying the max request time for a handler endowment.
+     */
+    MaxRequestTime = "maxRequestTime"
 }

package/dist/types/handler-types.d.ts

@@ -1,12 +1,14 @@
 export declare enum HandlerType {
     OnRpcRequest = "onRpcRequest",
+    OnSignature = "onSignature",
     OnTransaction = "onTransaction",
     OnCronjob = "onCronjob",
     OnInstall = "onInstall",
     OnUpdate = "onUpdate",
     OnNameLookup = "onNameLookup",
     OnKeyringRequest = "onKeyringRequest",
-    OnHomePage = "onHomePage"
+    OnHomePage = "onHomePage",
+    OnUserInput = "onUserInput"
 }
 export declare type SnapHandler = {
     /**