@metamask/snaps-utils 8.0.0 → 8.1.0

package/dist/structs.mjs

@@ -1,33 +1,301 @@
-import {
-  SnapsStructError,
-  arrayToGenerator,
-  createFromStruct,
-  createUnion,
-  getError,
-  getStructErrorMessage,
-  getStructErrorPrefix,
-  getStructFailureMessage,
-  getStructFromPath,
-  getUnionStructNames,
-  mergeStructs,
-  named,
-  validateUnion
-} from "./chunk-3N27GIUS.mjs";
-import "./chunk-IV3FSWZ7.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  SnapsStructError,
-  arrayToGenerator,
-  createFromStruct,
-  createUnion,
-  getError,
-  getStructErrorMessage,
-  getStructErrorPrefix,
-  getStructFailureMessage,
-  getStructFromPath,
-  getUnionStructNames,
-  mergeStructs,
-  named,
-  validateUnion
-};
+import { union } from "@metamask/snaps-sdk";
+import { assign, is, validate, type as superstructType, Struct, StructError, create } from "@metamask/superstruct";
+import { assert, isObject } from "@metamask/utils";
+import $chalk from "chalk";
+const { bold, green, red } = $chalk;
+import { indent } from "./strings.mjs";
+/**
+ * Colorize a value with a color function. This is useful for colorizing values
+ * in error messages. If colorization is disabled, the original value is
+ * returned.
+ *
+ * @param value - The value to colorize.
+ * @param colorFunction - The color function to use.
+ * @param enabled - Whether to colorize the value.
+ * @returns The colorized value, or the original value if colorization is
+ * disabled.
+ */
+function color(value, colorFunction, enabled) {
+    if (enabled) {
+        return colorFunction(value);
+    }
+    return value;
+}
+/**
+ * Define a struct, and also define the name of the struct as the given name.
+ *
+ * This is useful for improving the error messages returned by `superstruct`.
+ *
+ * @param name - The name of the struct.
+ * @param struct - The struct.
+ * @returns The struct.
+ */
+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}.`;
+    }
+    // Refinements we built ourselves have nice error messages
+    if (failure.refinement !== undefined) {
+        return `${prefix}${failure.message}.`;
+    }
+    return `${prefix}Expected a value of type ${color(failure.type, 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);
+}
+/**
+ * Merge multiple structs into one, using superstruct `assign`.
+ *
+ * Differently from plain `assign`, this function also copies over refinements from each struct.
+ *
+ * @param structs - The `superstruct` structs to merge.
+ * @returns The merged struct.
+ */
+export function mergeStructs(...structs) {
+    const mergedStruct = assign(...structs);
+    return new Struct({
+        ...mergedStruct,
+        *refiner(value, ctx) {
+            for (const struct of structs) {
+                yield* struct.refiner(value, ctx);
+            }
+        },
+    });
+}
 //# sourceMappingURL=structs.mjs.map

package/dist/structs.mjs.map

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

package/dist/svg.cjs

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSvg = exports.parseSvg = void 0;
+const utils_1 = require("@metamask/utils");
+const fast_xml_parser_1 = require("fast-xml-parser");
+/**
+ * Parse and validate a string as an SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns The SVG, its attributes and children in an object format.
+ */
+function parseSvg(svg) {
+    try {
+        const trimmed = svg.trim();
+        (0, utils_1.assert)(trimmed.length > 0);
+        const parser = new fast_xml_parser_1.XMLParser({
+            ignoreAttributes: false,
+            parseAttributeValue: true,
+        });
+        const parsed = parser.parse(trimmed, true);
+        (0, utils_1.assert)((0, utils_1.hasProperty)(parsed, 'svg'));
+        // Empty SVGs are not returned as objects
+        if (!(0, utils_1.isObject)(parsed.svg)) {
+            return {};
+        }
+        return parsed.svg;
+    }
+    catch {
+        throw new Error('Snap icon must be a valid SVG.');
+    }
+}
+exports.parseSvg = parseSvg;
+/**
+ * Validate that a string is a valid SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns True if the SVG is valid otherwise false.
+ */
+function isSvg(svg) {
+    try {
+        parseSvg(svg);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+exports.isSvg = isSvg;
+//# sourceMappingURL=svg.cjs.map

package/dist/svg.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg.cjs","sourceRoot":"","sources":["../src/svg.ts"],"names":[],"mappings":";;;AAAA,2CAAgE;AAChE,qDAA4C;AAE5C;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,GAAW;IAClC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QAE3B,IAAA,cAAM,EAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE3B,MAAM,MAAM,GAAG,IAAI,2BAAS,CAAC;YAC3B,gBAAgB,EAAE,KAAK;YACvB,mBAAmB,EAAE,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAE3C,IAAA,cAAM,EAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;QAEnC,yCAAyC;QACzC,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,MAAM,CAAC,GAAG,CAAC;IACpB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;AACH,CAAC;AAvBD,4BAuBC;AAED;;;;;GAKG;AACH,SAAgB,KAAK,CAAC,GAAW;IAC/B,IAAI,CAAC;QACH,QAAQ,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAPD,sBAOC","sourcesContent":["import { assert, hasProperty, isObject } from '@metamask/utils';\nimport { XMLParser } from 'fast-xml-parser';\n\n/**\n * Parse and validate a string as an SVG.\n *\n * @param svg - An SVG string.\n * @returns The SVG, its attributes and children in an object format.\n */\nexport function parseSvg(svg: string) {\n  try {\n    const trimmed = svg.trim();\n\n    assert(trimmed.length > 0);\n\n    const parser = new XMLParser({\n      ignoreAttributes: false,\n      parseAttributeValue: true,\n    });\n    const parsed = parser.parse(trimmed, true);\n\n    assert(hasProperty(parsed, 'svg'));\n\n    // Empty SVGs are not returned as objects\n    if (!isObject(parsed.svg)) {\n      return {};\n    }\n\n    return parsed.svg;\n  } catch {\n    throw new Error('Snap icon must be a valid SVG.');\n  }\n}\n\n/**\n * Validate that a string is a valid SVG.\n *\n * @param svg - An SVG string.\n * @returns True if the SVG is valid otherwise false.\n */\nexport function isSvg(svg: string) {\n  try {\n    parseSvg(svg);\n    return true;\n  } catch {\n    return false;\n  }\n}\n"]}

package/dist/svg.d.cts

@@ -0,0 +1,15 @@
+/**
+ * Parse and validate a string as an SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns The SVG, its attributes and children in an object format.
+ */
+export declare function parseSvg(svg: string): any;
+/**
+ * Validate that a string is a valid SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns True if the SVG is valid otherwise false.
+ */
+export declare function isSvg(svg: string): boolean;
+//# sourceMappingURL=svg.d.cts.map

package/dist/svg.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg.d.cts","sourceRoot":"","sources":["../src/svg.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,OAuBnC;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,WAOhC"}

package/dist/svg.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Parse and validate a string as an SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns The SVG, its attributes and children in an object format.
+ */
+export declare function parseSvg(svg: string): any;
+/**
+ * Validate that a string is a valid SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns True if the SVG is valid otherwise false.
+ */
+export declare function isSvg(svg: string): boolean;
+//# sourceMappingURL=svg.d.mts.map

package/dist/svg.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg.d.mts","sourceRoot":"","sources":["../src/svg.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,OAuBnC;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,WAOhC"}

package/dist/svg.mjs

@@ -1,10 +1,44 @@
-import {
-  isSvg,
-  parseSvg
-} from "./chunk-EVHDXNOC.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  isSvg,
-  parseSvg
-};
+import { assert, hasProperty, isObject } from "@metamask/utils";
+import { XMLParser } from "fast-xml-parser";
+/**
+ * Parse and validate a string as an SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns The SVG, its attributes and children in an object format.
+ */
+export function parseSvg(svg) {
+    try {
+        const trimmed = svg.trim();
+        assert(trimmed.length > 0);
+        const parser = new XMLParser({
+            ignoreAttributes: false,
+            parseAttributeValue: true,
+        });
+        const parsed = parser.parse(trimmed, true);
+        assert(hasProperty(parsed, 'svg'));
+        // Empty SVGs are not returned as objects
+        if (!isObject(parsed.svg)) {
+            return {};
+        }
+        return parsed.svg;
+    }
+    catch {
+        throw new Error('Snap icon must be a valid SVG.');
+    }
+}
+/**
+ * Validate that a string is a valid SVG.
+ *
+ * @param svg - An SVG string.
+ * @returns True if the SVG is valid otherwise false.
+ */
+export function isSvg(svg) {
+    try {
+        parseSvg(svg);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
 //# sourceMappingURL=svg.mjs.map

package/dist/svg.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"svg.mjs","sourceRoot":"","sources":["../src/svg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;AAChE,OAAO,EAAE,SAAS,EAAE,wBAAwB;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QAE3B,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE3B,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;YAC3B,gBAAgB,EAAE,KAAK;YACvB,mBAAmB,EAAE,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAE3C,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;QAEnC,yCAAyC;QACzC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,MAAM,CAAC,GAAG,CAAC;IACpB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAC,GAAW;IAC/B,IAAI,CAAC;QACH,QAAQ,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC","sourcesContent":["import { assert, hasProperty, isObject } from '@metamask/utils';\nimport { XMLParser } from 'fast-xml-parser';\n\n/**\n * Parse and validate a string as an SVG.\n *\n * @param svg - An SVG string.\n * @returns The SVG, its attributes and children in an object format.\n */\nexport function parseSvg(svg: string) {\n  try {\n    const trimmed = svg.trim();\n\n    assert(trimmed.length > 0);\n\n    const parser = new XMLParser({\n      ignoreAttributes: false,\n      parseAttributeValue: true,\n    });\n    const parsed = parser.parse(trimmed, true);\n\n    assert(hasProperty(parsed, 'svg'));\n\n    // Empty SVGs are not returned as objects\n    if (!isObject(parsed.svg)) {\n      return {};\n    }\n\n    return parsed.svg;\n  } catch {\n    throw new Error('Snap icon must be a valid SVG.');\n  }\n}\n\n/**\n * Validate that a string is a valid SVG.\n *\n * @param svg - An SVG string.\n * @returns True if the SVG is valid otherwise false.\n */\nexport function isSvg(svg: string) {\n  try {\n    parseSvg(svg);\n    return true;\n  } catch {\n    return false;\n  }\n}\n"]}

package/dist/types.cjs

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WALLET_SNAP_PERMISSION_KEY = exports.isValidUrl = exports.uri = exports.SNAP_STREAM_NAMES = exports.SnapIdPrefixes = exports.NpmSnapPackageJsonStruct = exports.NameStruct = exports.NpmSnapFileNames = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+var NpmSnapFileNames;
+(function (NpmSnapFileNames) {
+    NpmSnapFileNames["PackageJson"] = "package.json";
+    NpmSnapFileNames["Manifest"] = "snap.manifest.json";
+})(NpmSnapFileNames || (exports.NpmSnapFileNames = NpmSnapFileNames = {}));
+exports.NameStruct = (0, superstruct_1.size)((0, superstruct_1.pattern)((0, superstruct_1.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.
+exports.NpmSnapPackageJsonStruct = (0, superstruct_1.type)({
+    version: utils_1.VersionStruct,
+    name: exports.NameStruct,
+    main: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity)),
+    repository: (0, superstruct_1.optional)((0, superstruct_1.object)({
+        type: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
+        url: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
+    })),
+});
+/**
+ * The possible prefixes for snap ids.
+ */
+/* eslint-disable @typescript-eslint/naming-convention */
+var SnapIdPrefixes;
+(function (SnapIdPrefixes) {
+    SnapIdPrefixes["npm"] = "npm:";
+    SnapIdPrefixes["local"] = "local:";
+})(SnapIdPrefixes || (exports.SnapIdPrefixes = SnapIdPrefixes = {}));
+/* eslint-enable @typescript-eslint/naming-convention */
+/* eslint-disable @typescript-eslint/naming-convention */
+var SNAP_STREAM_NAMES;
+(function (SNAP_STREAM_NAMES) {
+    SNAP_STREAM_NAMES["JSON_RPC"] = "jsonRpc";
+    SNAP_STREAM_NAMES["COMMAND"] = "command";
+})(SNAP_STREAM_NAMES || (exports.SNAP_STREAM_NAMES = SNAP_STREAM_NAMES = {}));
+const uri = (opts = {}) => (0, superstruct_1.refine)((0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.instance)(URL)]), 'uri', (value) => {
+    try {
+        const url = new URL(value);
+        const UrlStruct = (0, superstruct_1.type)(opts);
+        (0, superstruct_1.assert)(url, UrlStruct);
+        return true;
+    }
+    catch {
+        return `Expected URL, got "${value.toString()}".`;
+    }
+});
+exports.uri = uri;
+/**
+ * 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.
+ */
+function isValidUrl(url, opts = {}) {
+    return (0, superstruct_1.is)(url, (0, exports.uri)(opts));
+}
+exports.isValidUrl = isValidUrl;
+// redefining here to avoid circular dependency
+exports.WALLET_SNAP_PERMISSION_KEY = 'wallet_snap';
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,uDAY+B;AAG/B,2CAAgD;AAQhD,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,gDAA4B,CAAA;IAC5B,mDAA+B,CAAA;AACjC,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAEY,QAAA,UAAU,GAAG,IAAA,kBAAI,EAC5B,IAAA,qBAAO,EACL,IAAA,oBAAM,GAAE,EACR,6DAA6D,CAC9D,EACD,CAAC,EACD,GAAG,CACJ,CAAC;AAEF,2EAA2E;AAC3E,sBAAsB;AACT,QAAA,wBAAwB,GAAG,IAAA,kBAAI,EAAC;IAC3C,OAAO,EAAE,qBAAa;IACtB,IAAI,EAAE,kBAAU;IAChB,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3C,UAAU,EAAE,IAAA,sBAAQ,EAClB,IAAA,oBAAM,EAAC;QACL,IAAI,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;QACjC,GAAG,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;KACjC,CAAC,CACH;CACF,CAAC,CAAC;AAsCH;;GAEG;AACH,yDAAyD;AACzD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,8BAAY,CAAA;IACZ,kCAAgB,CAAA;AAClB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AACD,wDAAwD;AAExD,yDAAyD;AACzD,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,yCAAoB,CAAA;IACpB,wCAAmB,CAAA;AACrB,CAAC,EAHW,iBAAiB,iCAAjB,iBAAiB,QAG5B;AAqBM,MAAM,GAAG,GAAG,CAAC,OAAwB,EAAE,EAAE,EAAE,CAChD,IAAA,oBAAM,EAAC,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,sBAAQ,EAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;IACxD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3B,MAAM,SAAS,GAAG,IAAA,kBAAI,EAAC,IAAI,CAAC,CAAC;QAC7B,IAAA,oBAAiB,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,sBAAsB,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;IACpD,CAAC;AACH,CAAC,CAAC,CAAC;AAXQ,QAAA,GAAG,OAWX;AAEL;;;;;;GAMG;AACH,SAAgB,UAAU,CACxB,GAAY,EACZ,OAAwB,EAAE;IAE1B,OAAO,IAAA,gBAAE,EAAC,GAAG,EAAE,IAAA,WAAG,EAAC,IAAI,CAAC,CAAC,CAAC;AAC5B,CAAC;AALD,gCAKC;AAED,+CAA+C;AAClC,QAAA,0BAA0B,GAAG,aAAa,CAAC","sourcesContent":["import {\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 '@metamask/superstruct';\nimport type { Infer, Struct } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { VersionStruct } from '@metamask/utils';\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 * 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/* 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"]}