@metamask/snaps-utils 5.1.2 → 6.0.0

package/dist/types/manifest/validation.d.ts

@@ -37,6 +37,23 @@ export declare const SnapIdsStruct: Struct<Record<string, {
 }>, null>;
 export declare type SnapIds = Infer<typeof SnapIdsStruct>;
 export declare const ChainIdsStruct: Struct<`${string}:${string}`[], Struct<`${string}:${string}`, null>>;
+export declare const LookupMatchersStruct: Struct<{
+    tlds: string[];
+} | {
+    schemes: string[];
+} | {
+    tlds: string[];
+    schemes: string[];
+}, null>;
+export declare const MINIMUM_REQUEST_TIMEOUT: number;
+export declare const MAXIMUM_REQUEST_TIMEOUT: number;
+export declare const MaxRequestTimeStruct: Struct<number, null>;
+export declare const HandlerCaveatsStruct: Struct<{
+    maxRequestTime?: number | undefined;
+}, {
+    maxRequestTime: Struct<number | undefined, null>;
+}>;
+export declare type HandlerCaveats = Infer<typeof HandlerCaveatsStruct>;
 export declare const PermissionsStruct: Struct<{
     snap_dialog?: {} | undefined;
     snap_getBip32Entropy?: {
@@ -51,17 +68,13 @@ export declare const PermissionsStruct: Struct<{
         coinType: number;
     }[] | undefined;
     snap_getEntropy?: {} | undefined;
+    snap_getLocale?: {} | undefined;
     snap_manageAccounts?: {} | undefined;
     snap_manageState?: {} | undefined;
     snap_notify?: {} | undefined;
     wallet_snap?: Record<string, {
         version?: string | undefined;
     }> | undefined;
-    'endowment:network-access'?: {} | undefined;
-    'endowment:webassembly'?: {} | undefined;
-    'endowment:transaction-insight'?: {
-        allowTransactionOrigin?: boolean | undefined;
-    } | undefined;
     'endowment:cronjob'?: {
         jobs: {
             request: {
@@ -72,25 +85,47 @@ export declare const PermissionsStruct: Struct<{
             };
             expression: string;
         }[];
+        maxRequestTime?: number | undefined;
+    } | undefined;
+    'endowment:ethereum-provider'?: {} | undefined;
+    'endowment:keyring'?: {
+        allowedOrigins?: string[] | undefined;
+        maxRequestTime?: number | undefined;
+    } | undefined;
+    'endowment:lifecycle-hooks'?: {
+        maxRequestTime?: number | undefined;
+    } | undefined;
+    'endowment:name-lookup'?: {
+        chains?: `${string}:${string}`[] | undefined;
+        maxRequestTime?: number | undefined;
+        matchers?: {
+            tlds: string[];
+        } | {
+            schemes: string[];
+        } | {
+            tlds: string[];
+            schemes: string[];
+        } | undefined;
+    } | undefined;
+    'endowment:network-access'?: {} | undefined;
+    'endowment:page-home'?: {
+        maxRequestTime?: number | undefined;
     } | undefined;
     'endowment:rpc'?: {
         dapps?: boolean | undefined;
         snaps?: boolean | undefined;
         allowedOrigins?: string[] | undefined;
     } | undefined;
-    'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
-    'endowment:keyring'?: {
-        allowedOrigins?: string[] | undefined;
+    'endowment:signature-insight'?: {
+        maxRequestTime?: number | undefined;
+        allowSignatureOrigin?: boolean | undefined;
     } | undefined;
-    snap_confirm?: {} | undefined;
-}, {
-    'endowment:network-access': Struct<{} | undefined, {}>;
-    'endowment:webassembly': Struct<{} | undefined, {}>;
-    'endowment:transaction-insight': Struct<{
+    'endowment:transaction-insight'?: {
+        maxRequestTime?: number | undefined;
         allowTransactionOrigin?: boolean | undefined;
-    } | undefined, {
-        allowTransactionOrigin: Struct<boolean | undefined, null>;
-    }>;
+    } | undefined;
+    'endowment:webassembly'?: {} | undefined;
+}, {
     'endowment:cronjob': Struct<{
         jobs: {
             request: {
@@ -101,6 +136,7 @@ export declare const PermissionsStruct: Struct<{
             };
             expression: string;
         }[];
+        maxRequestTime?: number | undefined;
     } | undefined, {
         jobs: Struct<{
             request: {
@@ -132,6 +168,49 @@ export declare const PermissionsStruct: Struct<{
                 params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
             }>;
         }>>;
+        maxRequestTime: Struct<number | undefined, null>;
+    }>;
+    'endowment:ethereum-provider': Struct<{} | undefined, {}>;
+    'endowment:keyring': Struct<{
+        allowedOrigins?: string[] | undefined;
+        maxRequestTime?: number | undefined;
+    } | undefined, {
+        allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
+        maxRequestTime: Struct<number | undefined, null>;
+    }>;
+    'endowment:lifecycle-hooks': Struct<{
+        maxRequestTime?: number | undefined;
+    } | undefined, {
+        maxRequestTime: Struct<number | undefined, null>;
+    }>;
+    'endowment:name-lookup': Struct<{
+        chains?: `${string}:${string}`[] | undefined;
+        maxRequestTime?: number | undefined;
+        matchers?: {
+            tlds: string[];
+        } | {
+            schemes: string[];
+        } | {
+            tlds: string[];
+            schemes: string[];
+        } | undefined;
+    } | undefined, {
+        chains: Struct<`${string}:${string}`[] | undefined, Struct<`${string}:${string}`, null>>;
+        matchers: Struct<{
+            tlds: string[];
+        } | {
+            schemes: string[];
+        } | {
+            tlds: string[];
+            schemes: string[];
+        } | undefined, null>;
+        maxRequestTime: Struct<number | undefined, null>;
+    }>;
+    'endowment:network-access': Struct<{} | undefined, {}>;
+    'endowment:page-home': Struct<{
+        maxRequestTime?: number | undefined;
+    } | undefined, {
+        maxRequestTime: Struct<number | undefined, null>;
     }>;
     'endowment:rpc': Struct<{
         dapps?: boolean | undefined;
@@ -142,14 +221,22 @@ export declare const PermissionsStruct: Struct<{
         snaps: Struct<boolean | undefined, null>;
         allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
     }>;
-    'endowment:name-lookup': Struct<`${string}:${string}`[] | undefined, Struct<`${string}:${string}`, null>>;
-    'endowment:keyring': Struct<{
-        allowedOrigins?: string[] | undefined;
+    'endowment:signature-insight': Struct<{
+        maxRequestTime?: number | undefined;
+        allowSignatureOrigin?: boolean | undefined;
     } | undefined, {
-        allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
+        allowSignatureOrigin: Struct<boolean | undefined, null>;
+        maxRequestTime: Struct<number | undefined, null>;
     }>;
+    'endowment:transaction-insight': Struct<{
+        maxRequestTime?: number | undefined;
+        allowTransactionOrigin?: boolean | undefined;
+    } | undefined, {
+        allowTransactionOrigin: Struct<boolean | undefined, null>;
+        maxRequestTime: Struct<number | undefined, null>;
+    }>;
+    'endowment:webassembly': Struct<{} | undefined, {}>;
     snap_dialog: Struct<{} | undefined, {}>;
-    snap_confirm: Struct<{} | undefined, {}>;
     snap_manageState: Struct<{} | undefined, {}>;
     snap_manageAccounts: Struct<{} | undefined, {}>;
     snap_notify: Struct<{} | undefined, {}>;
@@ -187,12 +274,15 @@ export declare const PermissionsStruct: Struct<{
         coinType: Struct<number, null>;
     }>>;
     snap_getEntropy: Struct<{} | undefined, {}>;
+    snap_getLocale: Struct<{} | undefined, {}>;
     wallet_snap: Struct<Record<string, {
         version?: string | undefined;
     }> | undefined, null>;
 }>;
 export declare type SnapPermissions = InferMatching<typeof PermissionsStruct, InitialPermissions>;
 export declare const SnapAuxilaryFilesStruct: Struct<string[], Struct<string, null>>;
+export declare const InitialConnectionsStruct: Struct<Record<string & URL, {}>, null>;
+export declare type InitialConnections = Infer<typeof InitialConnectionsStruct>;
 export declare const SnapManifestStruct: Struct<{
     description: string;
     version: import("@metamask/utils").SemVerVersion;
@@ -224,17 +314,13 @@ export declare const SnapManifestStruct: Struct<{
             coinType: number;
         }[] | undefined;
         snap_getEntropy?: {} | undefined;
+        snap_getLocale?: {} | undefined;
         snap_manageAccounts?: {} | undefined;
         snap_manageState?: {} | undefined;
         snap_notify?: {} | undefined;
         wallet_snap?: Record<string, {
             version?: string | undefined;
         }> | undefined;
-        'endowment:network-access'?: {} | undefined;
-        'endowment:webassembly'?: {} | undefined;
-        'endowment:transaction-insight'?: {
-            allowTransactionOrigin?: boolean | undefined;
-        } | undefined;
         'endowment:cronjob'?: {
             jobs: {
                 request: {
@@ -245,23 +331,53 @@ export declare const SnapManifestStruct: Struct<{
                 };
                 expression: string;
             }[];
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:ethereum-provider'?: {} | undefined;
+        'endowment:keyring'?: {
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:lifecycle-hooks'?: {
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:name-lookup'?: {
+            chains?: `${string}:${string}`[] | undefined;
+            maxRequestTime?: number | undefined;
+            matchers?: {
+                tlds: string[];
+            } | {
+                schemes: string[];
+            } | {
+                tlds: string[];
+                schemes: string[];
+            } | undefined;
+        } | undefined;
+        'endowment:network-access'?: {} | undefined;
+        'endowment:page-home'?: {
+            maxRequestTime?: number | undefined;
         } | undefined;
         'endowment:rpc'?: {
             dapps?: boolean | undefined;
             snaps?: boolean | undefined;
             allowedOrigins?: string[] | undefined;
         } | undefined;
-        'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
-        'endowment:keyring'?: {
-            allowedOrigins?: string[] | undefined;
+        'endowment:signature-insight'?: {
+            maxRequestTime?: number | undefined;
+            allowSignatureOrigin?: boolean | undefined;
         } | undefined;
-        snap_confirm?: {} | undefined;
+        'endowment:transaction-insight'?: {
+            maxRequestTime?: number | undefined;
+            allowTransactionOrigin?: boolean | undefined;
+        } | undefined;
+        'endowment:webassembly'?: {} | undefined;
     };
     manifestVersion: "0.1";
     repository?: {
         type: string;
         url: string;
     } | undefined;
+    initialConnections?: Record<string & URL, {}> | undefined;
     $schema?: string | undefined;
 }, {
     version: Struct<import("@metamask/utils").SemVerVersion, null>;
@@ -311,6 +427,7 @@ export declare const SnapManifestStruct: Struct<{
         files: Struct<string[] | undefined, Struct<string, null>>;
         locales: Struct<string[] | undefined, Struct<string, null>>;
     }>;
+    initialConnections: Struct<Record<string & URL, {}> | undefined, null>;
     initialPermissions: Struct<{
         snap_dialog?: {} | undefined;
         snap_getBip32Entropy?: {
@@ -325,17 +442,13 @@ export declare const SnapManifestStruct: Struct<{
             coinType: number;
         }[] | undefined;
         snap_getEntropy?: {} | undefined;
+        snap_getLocale?: {} | undefined;
         snap_manageAccounts?: {} | undefined;
         snap_manageState?: {} | undefined;
         snap_notify?: {} | undefined;
         wallet_snap?: Record<string, {
             version?: string | undefined;
         }> | undefined;
-        'endowment:network-access'?: {} | undefined;
-        'endowment:webassembly'?: {} | undefined;
-        'endowment:transaction-insight'?: {
-            allowTransactionOrigin?: boolean | undefined;
-        } | undefined;
         'endowment:cronjob'?: {
             jobs: {
                 request: {
@@ -346,25 +459,47 @@ export declare const SnapManifestStruct: Struct<{
                 };
                 expression: string;
             }[];
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:ethereum-provider'?: {} | undefined;
+        'endowment:keyring'?: {
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:lifecycle-hooks'?: {
+            maxRequestTime?: number | undefined;
+        } | undefined;
+        'endowment:name-lookup'?: {
+            chains?: `${string}:${string}`[] | undefined;
+            maxRequestTime?: number | undefined;
+            matchers?: {
+                tlds: string[];
+            } | {
+                schemes: string[];
+            } | {
+                tlds: string[];
+                schemes: string[];
+            } | undefined;
+        } | undefined;
+        'endowment:network-access'?: {} | undefined;
+        'endowment:page-home'?: {
+            maxRequestTime?: number | undefined;
         } | undefined;
         'endowment:rpc'?: {
             dapps?: boolean | undefined;
             snaps?: boolean | undefined;
             allowedOrigins?: string[] | undefined;
         } | undefined;
-        'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
-        'endowment:keyring'?: {
-            allowedOrigins?: string[] | undefined;
+        'endowment:signature-insight'?: {
+            maxRequestTime?: number | undefined;
+            allowSignatureOrigin?: boolean | undefined;
         } | undefined;
-        snap_confirm?: {} | undefined;
-    }, {
-        'endowment:network-access': Struct<{} | undefined, {}>;
-        'endowment:webassembly': Struct<{} | undefined, {}>;
-        'endowment:transaction-insight': Struct<{
+        'endowment:transaction-insight'?: {
+            maxRequestTime?: number | undefined;
             allowTransactionOrigin?: boolean | undefined;
-        } | undefined, {
-            allowTransactionOrigin: Struct<boolean | undefined, null>;
-        }>;
+        } | undefined;
+        'endowment:webassembly'?: {} | undefined;
+    }, {
         'endowment:cronjob': Struct<{
             jobs: {
                 request: {
@@ -375,6 +510,7 @@ export declare const SnapManifestStruct: Struct<{
                 };
                 expression: string;
             }[];
+            maxRequestTime?: number | undefined;
         } | undefined, {
             jobs: Struct<{
                 request: {
@@ -406,6 +542,49 @@ export declare const SnapManifestStruct: Struct<{
                     params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
                 }>;
             }>>;
+            maxRequestTime: Struct<number | undefined, null>;
+        }>;
+        'endowment:ethereum-provider': Struct<{} | undefined, {}>;
+        'endowment:keyring': Struct<{
+            allowedOrigins?: string[] | undefined;
+            maxRequestTime?: number | undefined;
+        } | undefined, {
+            allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
+            maxRequestTime: Struct<number | undefined, null>;
+        }>;
+        'endowment:lifecycle-hooks': Struct<{
+            maxRequestTime?: number | undefined;
+        } | undefined, {
+            maxRequestTime: Struct<number | undefined, null>;
+        }>;
+        'endowment:name-lookup': Struct<{
+            chains?: `${string}:${string}`[] | undefined;
+            maxRequestTime?: number | undefined;
+            matchers?: {
+                tlds: string[];
+            } | {
+                schemes: string[];
+            } | {
+                tlds: string[];
+                schemes: string[];
+            } | undefined;
+        } | undefined, {
+            chains: Struct<`${string}:${string}`[] | undefined, Struct<`${string}:${string}`, null>>;
+            matchers: Struct<{
+                tlds: string[];
+            } | {
+                schemes: string[];
+            } | {
+                tlds: string[];
+                schemes: string[];
+            } | undefined, null>;
+            maxRequestTime: Struct<number | undefined, null>;
+        }>;
+        'endowment:network-access': Struct<{} | undefined, {}>;
+        'endowment:page-home': Struct<{
+            maxRequestTime?: number | undefined;
+        } | undefined, {
+            maxRequestTime: Struct<number | undefined, null>;
         }>;
         'endowment:rpc': Struct<{
             dapps?: boolean | undefined;
@@ -416,14 +595,22 @@ export declare const SnapManifestStruct: Struct<{
             snaps: Struct<boolean | undefined, null>;
             allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
         }>;
-        'endowment:name-lookup': Struct<`${string}:${string}`[] | undefined, Struct<`${string}:${string}`, null>>;
-        'endowment:keyring': Struct<{
-            allowedOrigins?: string[] | undefined;
+        'endowment:signature-insight': Struct<{
+            maxRequestTime?: number | undefined;
+            allowSignatureOrigin?: boolean | undefined;
         } | undefined, {
-            allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
+            allowSignatureOrigin: Struct<boolean | undefined, null>;
+            maxRequestTime: Struct<number | undefined, null>;
         }>;
+        'endowment:transaction-insight': Struct<{
+            maxRequestTime?: number | undefined;
+            allowTransactionOrigin?: boolean | undefined;
+        } | undefined, {
+            allowTransactionOrigin: Struct<boolean | undefined, null>;
+            maxRequestTime: Struct<number | undefined, null>;
+        }>;
+        'endowment:webassembly': Struct<{} | undefined, {}>;
         snap_dialog: Struct<{} | undefined, {}>;
-        snap_confirm: Struct<{} | undefined, {}>;
         snap_manageState: Struct<{} | undefined, {}>;
         snap_manageAccounts: Struct<{} | undefined, {}>;
         snap_notify: Struct<{} | undefined, {}>;
@@ -461,6 +648,7 @@ export declare const SnapManifestStruct: Struct<{
             coinType: Struct<number, null>;
         }>>;
         snap_getEntropy: Struct<{} | undefined, {}>;
+        snap_getLocale: Struct<{} | undefined, {}>;
         wallet_snap: Struct<Record<string, {
             version?: string | undefined;
         }> | undefined, null>;

package/dist/types/snaps.d.ts

@@ -79,6 +79,18 @@ export declare type Snap = TruncatedSnap & {
      * Localization files which are used to translate the manifest.
      */
     localizationFiles?: LocalizationFile[];
+    /**
+     * Flag to signal whether this snap was preinstalled or not.
+     *
+     * A lack of specifying this option will be deemed as not preinstalled.
+     */
+    preinstalled?: boolean;
+    /**
+     * Flag to signal whether this snap is removable or not.
+     *
+     * A lack of specifying this option will be deemed as removable.
+     */
+    removable?: boolean;
 };
 export declare type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version' | 'enabled' | 'blocked';
 /**

package/dist/types/structs.d.ts

@@ -55,13 +55,14 @@ export declare function file(): Struct<string, null>;
  */
 export declare function named<Type, Schema>(name: string, struct: Struct<Type, Schema>): Struct<Type, Schema>;
 export declare class SnapsStructError<Type, Schema> extends StructError {
-    constructor(struct: Struct<Type, Schema>, prefix: string, suffix: string, failure: StructError, failures: () => Generator<Failure>);
+    constructor(struct: Struct<Type, Schema>, prefix: string, suffix: string, failure: StructError, failures: () => Generator<Failure>, colorize?: boolean);
 }
 declare type GetErrorOptions<Type, Schema> = {
     struct: Struct<Type, Schema>;
     prefix: string;
     suffix?: string;
     error: StructError;
+    colorize?: boolean;
 };
 /**
  * Converts an array to a generator function that yields the items in the
@@ -81,9 +82,10 @@ export declare function arrayToGenerator<Type>(array: Type[]): Generator<Type, v
  * @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 declare function getError<Type, Schema>({ struct, prefix, suffix, error, }: GetErrorOptions<Type, Schema>): SnapsStructError<Type, Schema>;
+export declare function getError<Type, Schema>({ struct, prefix, suffix, error, colorize, }: GetErrorOptions<Type, Schema>): SnapsStructError<Type, Schema>;
 /**
  * A wrapper of `superstruct`'s `create` function that throws a
  * `SnapsStructError` instead of a `StructError`. This is useful for improving
@@ -109,18 +111,20 @@ export declare function getStructFromPath<Type, Schema>(struct: Struct<Type, Sch
  * 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 declare function getUnionStructNames<Type, Schema>(struct: Struct<Type, Schema>): string[] | null;
+export declare function getUnionStructNames<Type, Schema>(struct: Struct<Type, Schema>, colorize?: boolean): string[] | 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 declare function getStructErrorPrefix(failure: Failure): string;
+export declare function getStructErrorPrefix(failure: Failure, colorize?: boolean): string;
 /**
  * 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
@@ -128,16 +132,66 @@ export declare function getStructErrorPrefix(failure: Failure): string;
  *
  * @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 declare function getStructFailureMessage<Type, Schema>(struct: Struct<Type, Schema>, failure: Failure): string;
+export declare function getStructFailureMessage<Type, Schema>(struct: Struct<Type, Schema>, failure: Failure, colorize?: boolean): string;
 /**
  * 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 declare function getStructErrorMessage<Type, Schema>(struct: Struct<Type, Schema>, failures: Failure[]): string;
+export declare function getStructErrorMessage<Type, Schema>(struct: Struct<Type, Schema>, failures: Failure[], colorize?: boolean): string;
+/**
+ * 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 declare function validateUnion<Type, Schema extends readonly Struct<any, any>[]>(value: unknown, struct: Struct<Type, Schema>, structKey: keyof Type, coerce?: boolean): any;
+/**
+ * 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 declare function createUnion<Type, Schema extends readonly Struct<any, any>[]>(value: unknown, struct: Struct<Type, Schema>, structKey: keyof Type): any;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-utils",
-  "version": "5.1.2",
+  "version": "6.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -67,14 +67,14 @@
   "dependencies": {
     "@babel/core": "^7.23.2",
     "@babel/types": "^7.23.0",
-    "@metamask/base-controller": "^4.0.0",
+    "@metamask/base-controller": "^4.1.0",
     "@metamask/key-tree": "^9.0.0",
-    "@metamask/permission-controller": "^7.1.0",
+    "@metamask/permission-controller": "^8.0.0",
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/slip44": "^3.1.0",
     "@metamask/snaps-registry": "^3.0.0",
-    "@metamask/snaps-sdk": "^1.3.2",
-    "@metamask/utils": "^8.2.1",
+    "@metamask/snaps-sdk": "^2.0.0",
+    "@metamask/utils": "^8.3.0",
     "@noble/hashes": "^1.3.1",
     "@scure/base": "^1.1.1",
     "chalk": "^4.1.2",
@@ -84,20 +84,20 @@
     "is-svg": "^4.4.0",
     "rfdc": "^1.3.0",
     "semver": "^7.5.4",
-    "ses": "^0.18.8",
+    "ses": "^1.1.0",
     "superstruct": "^1.0.3",
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@lavamoat/allow-scripts": "^2.5.1",
+    "@lavamoat/allow-scripts": "^3.0.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
     "@metamask/eslint-config-typescript": "^12.1.0",
-    "@metamask/post-message-stream": "^7.0.0",
+    "@metamask/post-message-stream": "^8.0.0",
     "@swc/cli": "^0.1.62",
     "@swc/core": "1.3.78",
     "@swc/jest": "^0.2.26",