@metamask/snaps-utils 3.3.0 → 4.0.1

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

@@ -1,4 +1,6 @@
+import type { InitialPermissions } from '@metamask/snaps-sdk';
 import type { Infer, Struct } from 'superstruct';
+import type { InferMatching } from '../structs';
 export declare const FORBIDDEN_COIN_TYPES: number[];
 export declare const Bip32PathStruct: Struct<string[], Struct<string, null>>;
 export declare const bip32entropy: <Type extends {
@@ -34,8 +36,27 @@ export declare const SnapIdsStruct: Struct<Record<string, {
     version?: string | undefined;
 }>, null>;
 export declare type SnapIds = Infer<typeof SnapIdsStruct>;
-export declare const ChainIdsStruct: Struct<string[], Struct<string, null>>;
+export declare const ChainIdsStruct: Struct<`${string}:${string}`[], Struct<`${string}:${string}`, null>>;
 export declare const PermissionsStruct: Struct<{
+    snap_dialog?: {} | undefined;
+    snap_getBip32Entropy?: {
+        path: string[];
+        curve: "ed25519" | "secp256k1";
+    }[] | undefined;
+    snap_getBip32PublicKey?: {
+        path: string[];
+        curve: "ed25519" | "secp256k1";
+    }[] | undefined;
+    snap_getBip44Entropy?: {
+        coinType: number;
+    }[] | undefined;
+    snap_getEntropy?: {} | 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'?: {
@@ -45,7 +66,7 @@ export declare const PermissionsStruct: Struct<{
         jobs: {
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
             };
@@ -57,30 +78,11 @@ export declare const PermissionsStruct: Struct<{
         snaps?: boolean | undefined;
         allowedOrigins?: string[] | undefined;
     } | undefined;
-    'endowment:name-lookup'?: string[] | undefined;
+    'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
     'endowment:keyring'?: {
         allowedOrigins?: string[] | undefined;
     } | undefined;
-    snap_dialog?: {} | undefined;
     snap_confirm?: {} | undefined;
-    snap_manageState?: {} | undefined;
-    snap_manageAccounts?: {} | undefined;
-    snap_notify?: {} | undefined;
-    snap_getBip32Entropy?: {
-        path: string[];
-        curve: "ed25519" | "secp256k1";
-    }[] | undefined;
-    snap_getBip32PublicKey?: {
-        path: string[];
-        curve: "ed25519" | "secp256k1";
-    }[] | undefined;
-    snap_getBip44Entropy?: {
-        coinType: number;
-    }[] | undefined;
-    snap_getEntropy?: {} | undefined;
-    wallet_snap?: Record<string, {
-        version?: string | undefined;
-    }> | undefined;
 }, {
     'endowment:network-access': Struct<{} | undefined, {}>;
     'endowment:webassembly': Struct<{} | undefined, {}>;
@@ -93,7 +95,7 @@ export declare const PermissionsStruct: Struct<{
         jobs: {
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
             };
@@ -103,7 +105,7 @@ export declare const PermissionsStruct: Struct<{
         jobs: Struct<{
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
             };
@@ -111,7 +113,7 @@ export declare const PermissionsStruct: Struct<{
         }[], Struct<{
             request: {
                 method: string;
-                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
             };
@@ -120,11 +122,11 @@ export declare const PermissionsStruct: Struct<{
             expression: Struct<string, null>;
             request: Struct<{
                 method: string;
-                params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                 id?: string | number | null | undefined;
                 jsonrpc?: "2.0" | undefined;
             }, {
-                params: Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+                params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
                 method: Struct<string, null>;
                 id: Struct<string | number | null | undefined, unknown>;
                 jsonrpc: Struct<"2.0" | undefined, unknown>;
@@ -140,7 +142,7 @@ export declare const PermissionsStruct: Struct<{
         snaps: Struct<boolean | undefined, null>;
         allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
     }>;
-    'endowment:name-lookup': Struct<string[] | undefined, Struct<string, null>>;
+    'endowment:name-lookup': Struct<`${string}:${string}`[] | undefined, Struct<`${string}:${string}`, null>>;
     'endowment:keyring': Struct<{
         allowedOrigins?: string[] | undefined;
     } | undefined, {
@@ -189,10 +191,11 @@ export declare const PermissionsStruct: Struct<{
         version?: string | undefined;
     }> | undefined, null>;
 }>;
-export declare type SnapPermissions = Infer<typeof PermissionsStruct>;
+export declare type SnapPermissions = InferMatching<typeof PermissionsStruct, InitialPermissions>;
 export declare const SnapAuxilaryFilesStruct: Struct<string[], Struct<string, null>>;
 export declare const SnapManifestStruct: Struct<{
     description: string;
+    version: import("@metamask/utils").SemVerVersion;
     source: {
         location: {
             npm: {
@@ -206,9 +209,27 @@ export declare const SnapManifestStruct: Struct<{
         files?: string[] | undefined;
         locales?: string[] | undefined;
     };
-    version: import("@metamask/utils").SemVerVersion;
     proposedName: string;
     initialPermissions: {
+        snap_dialog?: {} | undefined;
+        snap_getBip32Entropy?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip32PublicKey?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip44Entropy?: {
+            coinType: number;
+        }[] | undefined;
+        snap_getEntropy?: {} | 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'?: {
@@ -218,7 +239,7 @@ export declare const SnapManifestStruct: Struct<{
             jobs: {
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
                 };
@@ -230,30 +251,11 @@ export declare const SnapManifestStruct: Struct<{
             snaps?: boolean | undefined;
             allowedOrigins?: string[] | undefined;
         } | undefined;
-        'endowment:name-lookup'?: string[] | undefined;
+        'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
         'endowment:keyring'?: {
             allowedOrigins?: string[] | undefined;
         } | undefined;
-        snap_dialog?: {} | undefined;
         snap_confirm?: {} | undefined;
-        snap_manageState?: {} | undefined;
-        snap_manageAccounts?: {} | undefined;
-        snap_notify?: {} | undefined;
-        snap_getBip32Entropy?: {
-            path: string[];
-            curve: "ed25519" | "secp256k1";
-        }[] | undefined;
-        snap_getBip32PublicKey?: {
-            path: string[];
-            curve: "ed25519" | "secp256k1";
-        }[] | undefined;
-        snap_getBip44Entropy?: {
-            coinType: number;
-        }[] | undefined;
-        snap_getEntropy?: {} | undefined;
-        wallet_snap?: Record<string, {
-            version?: string | undefined;
-        }> | undefined;
     };
     manifestVersion: "0.1";
     repository?: {
@@ -310,6 +312,25 @@ export declare const SnapManifestStruct: Struct<{
         locales: Struct<string[] | undefined, Struct<string, null>>;
     }>;
     initialPermissions: Struct<{
+        snap_dialog?: {} | undefined;
+        snap_getBip32Entropy?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip32PublicKey?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip44Entropy?: {
+            coinType: number;
+        }[] | undefined;
+        snap_getEntropy?: {} | 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'?: {
@@ -319,7 +340,7 @@ export declare const SnapManifestStruct: Struct<{
             jobs: {
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
                 };
@@ -331,30 +352,11 @@ export declare const SnapManifestStruct: Struct<{
             snaps?: boolean | undefined;
             allowedOrigins?: string[] | undefined;
         } | undefined;
-        'endowment:name-lookup'?: string[] | undefined;
+        'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
         'endowment:keyring'?: {
             allowedOrigins?: string[] | undefined;
         } | undefined;
-        snap_dialog?: {} | undefined;
         snap_confirm?: {} | undefined;
-        snap_manageState?: {} | undefined;
-        snap_manageAccounts?: {} | undefined;
-        snap_notify?: {} | undefined;
-        snap_getBip32Entropy?: {
-            path: string[];
-            curve: "ed25519" | "secp256k1";
-        }[] | undefined;
-        snap_getBip32PublicKey?: {
-            path: string[];
-            curve: "ed25519" | "secp256k1";
-        }[] | undefined;
-        snap_getBip44Entropy?: {
-            coinType: number;
-        }[] | undefined;
-        snap_getEntropy?: {} | undefined;
-        wallet_snap?: Record<string, {
-            version?: string | undefined;
-        }> | undefined;
     }, {
         'endowment:network-access': Struct<{} | undefined, {}>;
         'endowment:webassembly': Struct<{} | undefined, {}>;
@@ -367,7 +369,7 @@ export declare const SnapManifestStruct: Struct<{
             jobs: {
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
                 };
@@ -377,7 +379,7 @@ export declare const SnapManifestStruct: Struct<{
             jobs: Struct<{
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
                 };
@@ -385,7 +387,7 @@ export declare const SnapManifestStruct: Struct<{
             }[], Struct<{
                 request: {
                     method: string;
-                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
                 };
@@ -394,11 +396,11 @@ export declare const SnapManifestStruct: Struct<{
                 expression: Struct<string, null>;
                 request: Struct<{
                     method: string;
-                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
                     id?: string | number | null | undefined;
                     jsonrpc?: "2.0" | undefined;
                 }, {
-                    params: Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined, null>;
+                    params: Struct<Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined, null>;
                     method: Struct<string, null>;
                     id: Struct<string | number | null | undefined, unknown>;
                     jsonrpc: Struct<"2.0" | undefined, unknown>;
@@ -414,7 +416,7 @@ export declare const SnapManifestStruct: Struct<{
             snaps: Struct<boolean | undefined, null>;
             allowedOrigins: Struct<string[] | undefined, Struct<string, null>>;
         }>;
-        'endowment:name-lookup': Struct<string[] | undefined, Struct<string, null>>;
+        'endowment:name-lookup': Struct<`${string}:${string}`[] | undefined, Struct<`${string}:${string}`, null>>;
         'endowment:keyring': Struct<{
             allowedOrigins?: string[] | undefined;
         } | undefined, {

package/dist/types/namespace.d.ts

@@ -1,4 +1,6 @@
+import type { AccountId, ChainId } from '@metamask/snaps-sdk';
 import type { Infer } from 'superstruct';
+import type { InferMatching } from './structs';
 export declare const CHAIN_ID_REGEX: RegExp;
 export declare const ACCOUNT_ID_REGEX: RegExp;
 export declare const ACCOUNT_ADDRESS_REGEX: RegExp;
@@ -33,14 +35,13 @@ export declare function parseAccountId(accountId: AccountId): {
  * of 40.
  */
 export declare const LimitedString: import("superstruct").Struct<string, null>;
+export declare const ChainIdStringStruct: import("superstruct").Struct<`${string}:${string}`, null>;
 /**
  * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
  */
-export declare const ChainIdStruct: import("superstruct").Struct<string, null>;
-export declare type ChainId = `${string}:${string}`;
-export declare type Caip2ChainId = Infer<typeof ChainIdStruct>;
+export declare const ChainIdStruct: import("superstruct").Struct<`${string}:${string}`, null>;
+export declare type Caip2ChainId = InferMatching<typeof ChainIdStruct, ChainId>;
 export declare const AccountIdStruct: import("superstruct").Struct<string, null>;
-export declare type AccountId = `${ChainId}:${string}`;
 export declare const AccountIdArrayStruct: import("superstruct").Struct<string[], import("superstruct").Struct<string, null>>;
 export declare const AccountAddressStruct: import("superstruct").Struct<string, null>;
 export declare type AccountAddress = Infer<typeof AccountAddressStruct>;
@@ -49,16 +50,16 @@ export declare type AccountAddress = Infer<typeof AccountAddressStruct>;
  */
 export declare const ChainStruct: import("superstruct").Struct<{
     name: string;
-    id: string;
+    id: `${string}:${string}`;
 }, {
-    id: import("superstruct").Struct<string, null>;
+    id: import("superstruct").Struct<`${string}:${string}`, null>;
     name: import("superstruct").Struct<string, null>;
 }>;
 export declare type Chain = Infer<typeof ChainStruct>;
 export declare const NamespaceStruct: import("superstruct").Struct<{
     chains: {
         name: string;
-        id: string;
+        id: `${string}:${string}`;
     }[];
     methods?: string[] | undefined;
     events?: string[] | undefined;
@@ -68,12 +69,12 @@ export declare const NamespaceStruct: import("superstruct").Struct<{
      */
     chains: import("superstruct").Struct<{
         name: string;
-        id: string;
+        id: `${string}:${string}`;
     }[], import("superstruct").Struct<{
         name: string;
-        id: string;
+        id: `${string}:${string}`;
     }, {
-        id: import("superstruct").Struct<string, null>;
+        id: import("superstruct").Struct<`${string}:${string}`, null>;
         name: import("superstruct").Struct<string, null>;
     }>>;
     /**

package/dist/types/npm.d.ts

@@ -16,4 +16,4 @@ export declare const SnapFileNameFromKey: {
  * @param errorPrefix - The prefix of the error message.
  * @returns A tuple of the Snap manifest object and the Snap source code.
  */
-export declare function validateNpmSnap(snapFiles: UnvalidatedSnapFiles, errorPrefix?: `${string}: `): SnapFiles;
+export declare function validateNpmSnap(snapFiles: UnvalidatedSnapFiles, errorPrefix?: `${string}: `): Promise<SnapFiles>;

package/dist/types/snaps.d.ts

@@ -1,20 +1,12 @@
 import type { SubjectPermissions, PermissionConstraint } from '@metamask/permission-controller';
 import type { BlockReason } from '@metamask/snaps-registry';
-import type { Json, JsonRpcError, Opaque, SemVerVersion } from '@metamask/utils';
+import type { SnapId, Snap as TruncatedSnap } from '@metamask/snaps-sdk';
 import type { Struct } from 'superstruct';
 import type { LocalizationFile } from './localization';
 import type { SnapManifest, SnapPermissions } from './manifest/validation';
-import type { FetchedSnapFiles, SnapId, SnapsPermissionRequest } from './types';
+import type { FetchedSnapFiles, SnapsPermissionRequest } from './types';
 import { SnapIdPrefixes, SnapValidationFailureReason } from './types';
 export declare const PROPOSED_NAME_REGEX: RegExp;
-/**
- * wallet_enable / wallet_installSnaps permission typing.
- *
- * @deprecated This type is confusing and not descriptive, people confused it with typing initialPermissions, remove when removing wallet_enable.
- */
-export declare type RequestedSnapPermissions = {
-    [permission: string]: Record<string, Json>;
-};
 export declare enum SnapStatus {
     Installing = "installing",
     Updating = "updating",
@@ -29,7 +21,7 @@ export declare enum SnapStatusEvents {
     Update = "UPDATE"
 }
 export declare type StatusContext = {
-    snapId: ValidatedSnapId;
+    snapId: SnapId;
 };
 export declare type StatusEvents = {
     type: SnapStatusEvents;
@@ -52,15 +44,7 @@ export declare type PersistedSnap = Snap;
 /**
  * A Snap as it exists in {@link SnapController} state.
  */
-export declare type Snap = {
-    /**
-     * Whether the Snap is enabled, which determines if it can be started.
-     */
-    enabled: boolean;
-    /**
-     * The ID of the Snap.
-     */
-    id: ValidatedSnapId;
+export declare type Snap = TruncatedSnap & {
     /**
      * The initial permissions of the Snap, which will be requested when it is
      * installed.
@@ -74,10 +58,6 @@ export declare type Snap = {
      * The Snap's manifest file.
      */
     manifest: SnapManifest;
-    /**
-     * Whether the Snap is blocked.
-     */
-    blocked: boolean;
     /**
      * Information detailing why the snap is blocked.
      */
@@ -86,10 +66,6 @@ export declare type Snap = {
      * The current status of the Snap, e.g. whether it's running or stopped.
      */
     status: Status;
-    /**
-     * The version of the Snap.
-     */
-    version: SemVerVersion;
     /**
      * The version history of the Snap.
      * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.
@@ -105,15 +81,6 @@ export declare type Snap = {
     localizationFiles?: LocalizationFile[];
 };
 export declare type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version' | 'enabled' | 'blocked';
-/**
- * A {@link Snap} object with the fields that are relevant to an external
- * caller.
- */
-export declare type TruncatedSnap = Pick<Snap, TruncatedSnapFields>;
-export declare type ProcessSnapResult = TruncatedSnap | {
-    error: JsonRpcError;
-};
-export declare type InstallSnapsResult = Record<SnapId, ProcessSnapResult>;
 /**
  * An error indicating that a Snap validation failure is programmatically
  * fixable during development.
@@ -128,7 +95,7 @@ export declare class ProgrammaticallyFixableSnapError extends Error {
  * @param files - All required Snap files to be included in the checksum.
  * @returns The Base64-encoded SHA-256 digest of the source code.
  */
-export declare function getSnapChecksum(files: FetchedSnapFiles): string;
+export declare function getSnapChecksum(files: FetchedSnapFiles): Promise<string>;
 /**
  * Checks whether the `source.shasum` property of a Snap manifest matches the
  * shasum of the snap.
@@ -136,15 +103,13 @@ export declare function getSnapChecksum(files: FetchedSnapFiles): string;
  * @param files - All required Snap files to be included in the checksum.
  * @param errorMessage - The error message to throw if validation fails.
  */
-export declare function validateSnapShasum(files: FetchedSnapFiles, errorMessage?: string): void;
+export declare function validateSnapShasum(files: FetchedSnapFiles, errorMessage?: string): Promise<void>;
 export declare const LOCALHOST_HOSTNAMES: readonly ["localhost", "127.0.0.1", "[::1]"];
 export declare const BaseSnapIdStruct: Struct<string, null>;
 export declare const LocalSnapIdStruct: Struct<string, null>;
 export declare const NpmSnapIdStruct: Struct<string, null>;
 export declare const HttpSnapIdStruct: Struct<string, null>;
 export declare const SnapIdStruct: Struct<string, null>;
-export declare type ValidatedSnapId = Opaque<string, typeof snapIdSymbol>;
-declare const snapIdSymbol: unique symbol;
 /**
  * Extracts the snap prefix from a snap ID.
  *
@@ -165,7 +130,7 @@ export declare function stripSnapPrefix(snapId: string): string;
  * @param value - The value to check.
  * @throws If the value is not a valid snap ID.
  */
-export declare function assertIsValidSnapId(value: unknown): asserts value is ValidatedSnapId;
+export declare function assertIsValidSnapId(value: unknown): asserts value is SnapId;
 /**
  * Typeguard to ensure a chainId follows the CAIP-2 standard.
  *
@@ -189,4 +154,4 @@ export declare function isSnapPermitted(permissions: SubjectPermissions<Permissi
  * @throws If the criteria is not met.
  */
 export declare function verifyRequestedSnapPermissions(requestedPermissions: unknown): asserts requestedPermissions is SnapsPermissionRequest;
-export {};
+export type { Snap as TruncatedSnap } from '@metamask/snaps-sdk';

package/dist/types/structs.d.ts

@@ -1,6 +1,29 @@
 import type { Failure, Infer } from 'superstruct';
 import { Struct, StructError } from 'superstruct';
 import type { AnyStruct, InferStructTuple } from 'superstruct/dist/utils';
+/**
+ * Infer a struct type, only if it matches the specified type. This is useful
+ * for defining types and structs that are related to each other in separate
+ * files.
+ *
+ * @example
+ * ```typescript
+ * // In file A
+ * export type GetFileArgs = {
+ *   path: string;
+ *   encoding?: EnumToUnion<AuxiliaryFileEncoding>;
+ * };
+ *
+ * // In file B
+ * export const GetFileArgsStruct = object(...);
+ *
+ * // If the type and struct are in the same file, this will return the type.
+ * // Otherwise, it will return `never`.
+ * export type GetFileArgs =
+ *   InferMatching<typeof GetFileArgsStruct, GetFileArgs>;
+ * ```
+ */
+export declare type InferMatching<StructType extends Struct<any, any>, Type> = StructType['TYPE'] extends Type ? Type : never;
 /**
  * A wrapper of `superstruct`'s `literal` struct that also defines the name of
  * the struct as the literal value.

package/dist/types/types.d.ts

@@ -79,7 +79,6 @@ export declare enum SnapIdPrefixes {
     npm = "npm:",
     local = "local:"
 }
-export declare type SnapId = string;
 /**
  * Snap validation failure reason codes that are programmatically fixable
  * if validation occurs during development.

package/dist/types/ui.d.ts

@@ -0,0 +1,20 @@
+import type { Component } from '@metamask/snaps-sdk';
+/**
+ * Searches for markdown links in a string and checks them against the phishing list.
+ *
+ * @param text - The text to verify.
+ * @param isOnPhishingList - The function that checks the link against the
+ * phishing list.
+ * @throws If the text contains a link that is not allowed.
+ */
+export declare function validateTextLinks(text: string, isOnPhishingList: (url: string) => boolean): void;
+/**
+ * Search for links in UI components and check that the URL they are trying to
+ * pass in is not in the phishing list.
+ *
+ * @param component - The custom UI component.
+ * @param isOnPhishingList - The function that checks the link against the
+ * phishing list.
+ * @throws If the component contains a link that is not allowed.
+ */
+export declare function validateComponentLinks(component: Component, isOnPhishingList: (url: string) => boolean): void;

package/dist/types/validation.d.ts

@@ -5,4 +5,4 @@ import type { FetchedSnapFiles } from './types';
  * @param files - All potentially included files in a fetched snap.
  * @throws If any of the files are considered invalid.
  */
-export declare function validateFetchedSnap(files: FetchedSnapFiles): void;
+export declare function validateFetchedSnap(files: FetchedSnapFiles): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-utils",
-  "version": "3.3.0",
+  "version": "4.0.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -72,7 +72,7 @@
     "@metamask/permission-controller": "^5.0.0",
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-registry": "^2.1.0",
-    "@metamask/snaps-ui": "^3.1.0",
+    "@metamask/snaps-sdk": "^1.1.0",
     "@metamask/utils": "^8.1.0",
     "@noble/hashes": "^1.3.1",
     "@scure/base": "^1.1.1",
@@ -91,7 +91,7 @@
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
     "@lavamoat/allow-scripts": "^2.5.1",
-    "@metamask/auto-changelog": "^3.3.0",
+    "@metamask/auto-changelog": "^3.4.3",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",