@metamask/snaps-utils 1.0.2 → 2.0.1

package/dist/{manifest → types/manifest}/manifest.d.ts

@@ -1,8 +1,8 @@
-import { Json } from '@metamask/utils';
+import type { Json } from '@metamask/utils';
 import { ProgrammaticallyFixableSnapError } from '../snaps';
-import { SnapFiles } from '../types';
+import type { SnapFiles } from '../types';
 import { VirtualFile } from '../virtual-file';
-import { SnapManifest } from './validation';
+import type { SnapManifest } from './validation';
 /**
  * The result from the `checkManifest` function.
  *
@@ -23,6 +23,7 @@ export declare type CheckManifestResult = {
     warnings: string[];
     errors: string[];
 };
+export declare type WriteFileFunction = (path: string, data: string) => Promise<void>;
 /**
  * Validates a snap.manifest.json file. Attempts to fix the manifest and write
  * the fixed version to disk if `writeManifest` is true. Throws if validation
@@ -31,10 +32,11 @@ export declare type CheckManifestResult = {
  * @param basePath - The path to the folder with the manifest files.
  * @param writeManifest - Whether to write the fixed manifest to disk.
  * @param sourceCode - The source code of the Snap.
+ * @param writeFileFn - The function to use to write the manifest to disk.
  * @returns Whether the manifest was updated, and an array of warnings that
  * were encountered during processing of the manifest files.
  */
-export declare function checkManifest(basePath: string, writeManifest?: boolean, sourceCode?: string): Promise<CheckManifestResult>;
+export declare function checkManifest(basePath: string, writeManifest?: boolean, sourceCode?: string, writeFileFn?: WriteFileFunction): Promise<CheckManifestResult>;
 /**
  * Given the relevant Snap files (manifest, `package.json`, and bundle) and a
  * Snap manifest validation error, fixes the fault in the manifest that caused

package/dist/{manifest → types/manifest}/validation.d.ts

@@ -1,10 +1,10 @@
-import { Infer, Struct } from 'superstruct';
+import type { Infer, Struct } from 'superstruct';
 export declare const FORBIDDEN_COIN_TYPES: number[];
 export declare const Bip32PathStruct: Struct<string[], Struct<string, null>>;
-export declare const bip32entropy: <T extends {
+export declare const bip32entropy: <Type extends {
     path: string[];
     curve: string;
-}, S>(struct: Struct<T, S>) => Struct<T, S>;
+}, Schema>(struct: Struct<Type, Schema>) => Struct<Type, Schema>;
 export declare const Bip32EntropyStruct: Struct<{
     path: string[];
     curve: "ed25519" | "secp256k1";
@@ -29,8 +29,13 @@ export declare const SnapGetBip32EntropyPermissionsStruct: Struct<{
         secp256k1: "secp256k1";
     }>;
 }>>;
+export declare const SemVerRangeStruct: Struct<string, null>;
+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 PermissionsStruct: Struct<{
-    'endowment:long-running'?: {} | undefined;
     'endowment:network-access'?: {} | undefined;
     'endowment:webassembly'?: {} | undefined;
     'endowment:transaction-insight'?: {
@@ -51,9 +56,11 @@ export declare const PermissionsStruct: Struct<{
         dapps?: boolean | undefined;
         snaps?: boolean | undefined;
     } | undefined;
+    'endowment:name-lookup'?: string[] | undefined;
     snap_dialog?: {} | undefined;
     snap_confirm?: {} | undefined;
     snap_manageState?: {} | undefined;
+    snap_manageAccounts?: {} | undefined;
     snap_notify?: {} | undefined;
     snap_getBip32Entropy?: {
         path: string[];
@@ -67,18 +74,10 @@ export declare const PermissionsStruct: Struct<{
         coinType: number;
     }[] | undefined;
     snap_getEntropy?: {} | undefined;
-    'endowment:keyring'?: {
-        namespaces: Record<string, {
-            chains: {
-                name: string;
-                id: string;
-            }[];
-            methods?: string[] | undefined;
-            events?: string[] | undefined;
-        }>;
-    } | undefined;
+    wallet_snap?: Record<string, {
+        version?: string | undefined;
+    }> | undefined;
 }, {
-    'endowment:long-running': Struct<{} | undefined, {}>;
     'endowment:network-access': Struct<{} | undefined, {}>;
     'endowment:webassembly': Struct<{} | undefined, {}>;
     'endowment:transaction-insight': Struct<{
@@ -135,9 +134,11 @@ export declare const PermissionsStruct: Struct<{
         dapps: Struct<boolean | undefined, null>;
         snaps: Struct<boolean | undefined, null>;
     }>;
+    'endowment:name-lookup': Struct<string[] | undefined, Struct<string, null>>;
     snap_dialog: Struct<{} | undefined, {}>;
     snap_confirm: Struct<{} | undefined, {}>;
     snap_manageState: Struct<{} | undefined, {}>;
+    snap_manageAccounts: Struct<{} | undefined, {}>;
     snap_notify: Struct<{} | undefined, {}>;
     snap_getBip32Entropy: Struct<{
         path: string[];
@@ -173,25 +174,9 @@ export declare const PermissionsStruct: Struct<{
         coinType: Struct<number, null>;
     }>>;
     snap_getEntropy: Struct<{} | undefined, {}>;
-    'endowment:keyring': Struct<{
-        namespaces: Record<string, {
-            chains: {
-                name: string;
-                id: string;
-            }[];
-            methods?: string[] | undefined;
-            events?: string[] | undefined;
-        }>;
-    } | undefined, {
-        namespaces: Struct<Record<string, {
-            chains: {
-                name: string;
-                id: string;
-            }[];
-            methods?: string[] | undefined;
-            events?: string[] | undefined;
-        }>, null>;
-    }>;
+    wallet_snap: Struct<Record<string, {
+        version?: string | undefined;
+    }> | undefined, null>;
 }>;
 export declare type SnapPermissions = Infer<typeof PermissionsStruct>;
 export declare const SnapManifestStruct: Struct<{
@@ -201,16 +186,15 @@ export declare const SnapManifestStruct: Struct<{
     source: {
         location: {
             npm: {
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 filePath: string;
                 packageName: string;
-                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 iconPath?: string | undefined;
             };
         };
         shasum: string;
     };
     initialPermissions: {
-        'endowment:long-running'?: {} | undefined;
         'endowment:network-access'?: {} | undefined;
         'endowment:webassembly'?: {} | undefined;
         'endowment:transaction-insight'?: {
@@ -231,9 +215,11 @@ export declare const SnapManifestStruct: Struct<{
             dapps?: boolean | undefined;
             snaps?: boolean | undefined;
         } | undefined;
+        'endowment:name-lookup'?: string[] | undefined;
         snap_dialog?: {} | undefined;
         snap_confirm?: {} | undefined;
         snap_manageState?: {} | undefined;
+        snap_manageAccounts?: {} | undefined;
         snap_notify?: {} | undefined;
         snap_getBip32Entropy?: {
             path: string[];
@@ -247,22 +233,16 @@ export declare const SnapManifestStruct: Struct<{
             coinType: number;
         }[] | undefined;
         snap_getEntropy?: {} | undefined;
-        'endowment:keyring'?: {
-            namespaces: Record<string, {
-                chains: {
-                    name: string;
-                    id: string;
-                }[];
-                methods?: string[] | undefined;
-                events?: string[] | undefined;
-            }>;
-        } | undefined;
+        wallet_snap?: Record<string, {
+            version?: string | undefined;
+        }> | undefined;
     };
     manifestVersion: "0.1";
     repository?: {
         type: string;
         url: string;
     } | undefined;
+    $schema?: string | undefined;
 }, {
     version: Struct<import("@metamask/utils").SemVerVersion, null>;
     description: Struct<string, null>;
@@ -277,9 +257,9 @@ export declare const SnapManifestStruct: Struct<{
     source: Struct<{
         location: {
             npm: {
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 filePath: string;
                 packageName: string;
-                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 iconPath?: string | undefined;
             };
         };
@@ -288,16 +268,16 @@ export declare const SnapManifestStruct: Struct<{
         shasum: Struct<string, null>;
         location: Struct<{
             npm: {
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 filePath: string;
                 packageName: string;
-                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 iconPath?: string | undefined;
             };
         }, {
             npm: Struct<{
+                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 filePath: string;
                 packageName: string;
-                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
                 iconPath?: string | undefined;
             }, {
                 filePath: Struct<string, null>;
@@ -308,7 +288,6 @@ export declare const SnapManifestStruct: Struct<{
         }>;
     }>;
     initialPermissions: Struct<{
-        'endowment:long-running'?: {} | undefined;
         'endowment:network-access'?: {} | undefined;
         'endowment:webassembly'?: {} | undefined;
         'endowment:transaction-insight'?: {
@@ -329,9 +308,11 @@ export declare const SnapManifestStruct: Struct<{
             dapps?: boolean | undefined;
             snaps?: boolean | undefined;
         } | undefined;
+        'endowment:name-lookup'?: string[] | undefined;
         snap_dialog?: {} | undefined;
         snap_confirm?: {} | undefined;
         snap_manageState?: {} | undefined;
+        snap_manageAccounts?: {} | undefined;
         snap_notify?: {} | undefined;
         snap_getBip32Entropy?: {
             path: string[];
@@ -345,18 +326,10 @@ export declare const SnapManifestStruct: Struct<{
             coinType: number;
         }[] | undefined;
         snap_getEntropy?: {} | undefined;
-        'endowment:keyring'?: {
-            namespaces: Record<string, {
-                chains: {
-                    name: string;
-                    id: string;
-                }[];
-                methods?: string[] | undefined;
-                events?: string[] | undefined;
-            }>;
-        } | undefined;
+        wallet_snap?: Record<string, {
+            version?: string | undefined;
+        }> | undefined;
     }, {
-        'endowment:long-running': Struct<{} | undefined, {}>;
         'endowment:network-access': Struct<{} | undefined, {}>;
         'endowment:webassembly': Struct<{} | undefined, {}>;
         'endowment:transaction-insight': Struct<{
@@ -413,9 +386,11 @@ export declare const SnapManifestStruct: Struct<{
             dapps: Struct<boolean | undefined, null>;
             snaps: Struct<boolean | undefined, null>;
         }>;
+        'endowment:name-lookup': Struct<string[] | undefined, Struct<string, null>>;
         snap_dialog: Struct<{} | undefined, {}>;
         snap_confirm: Struct<{} | undefined, {}>;
         snap_manageState: Struct<{} | undefined, {}>;
+        snap_manageAccounts: Struct<{} | undefined, {}>;
         snap_notify: Struct<{} | undefined, {}>;
         snap_getBip32Entropy: Struct<{
             path: string[];
@@ -451,27 +426,12 @@ export declare const SnapManifestStruct: Struct<{
             coinType: Struct<number, null>;
         }>>;
         snap_getEntropy: Struct<{} | undefined, {}>;
-        'endowment:keyring': Struct<{
-            namespaces: Record<string, {
-                chains: {
-                    name: string;
-                    id: string;
-                }[];
-                methods?: string[] | undefined;
-                events?: string[] | undefined;
-            }>;
-        } | undefined, {
-            namespaces: Struct<Record<string, {
-                chains: {
-                    name: string;
-                    id: string;
-                }[];
-                methods?: string[] | undefined;
-                events?: string[] | undefined;
-            }>, null>;
-        }>;
+        wallet_snap: Struct<Record<string, {
+            version?: string | undefined;
+        }> | undefined, null>;
     }>;
     manifestVersion: Struct<"0.1", "0.1">;
+    $schema: Struct<string | undefined, null>;
 }>;
 export declare type SnapManifest = Infer<typeof SnapManifestStruct>;
 /**
@@ -491,7 +451,6 @@ export declare function assertIsSnapManifest(value: unknown): asserts value is S
 /**
  * Creates a {@link SnapManifest} object from JSON.
  *
- *
  * @param value - The value to check.
  * @throws If the value cannot be coerced to a {@link SnapManifest} object.
  * @returns The created {@link SnapManifest} object.

package/dist/types/namespace.d.ts

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

package/dist/{npm.d.ts → types/npm.d.ts}

@@ -1,6 +1,5 @@
-import { NpmSnapFileNames, SnapFiles, UnvalidatedSnapFiles } from './types';
-export declare const SVG_MAX_BYTE_SIZE = 100000;
-export declare const SVG_MAX_BYTE_SIZE_TEXT: string;
+import type { SnapFiles, UnvalidatedSnapFiles } from './types';
+import { NpmSnapFileNames } from './types';
 export declare const EXPECTED_SNAP_FILES: readonly ["manifest", "packageJson", "sourceCode"];
 export declare const SnapFileNameFromKey: {
     readonly manifest: NpmSnapFileNames.Manifest;

package/dist/{snaps.d.ts → types/snaps.d.ts}

@@ -1,10 +1,11 @@
-import { SubjectPermissions, PermissionConstraint } from '@metamask/permission-controller';
-import { BlockReason } from '@metamask/snaps-registry';
-import { Json, SemVerVersion, Opaque } from '@metamask/utils';
-import { SerializedEthereumRpcError } from 'eth-rpc-errors/dist/classes';
-import { Struct } from 'superstruct';
-import { SnapManifest, SnapPermissions } from './manifest/validation';
-import { SnapFiles, SnapId, SnapIdPrefixes, SnapsPermissionRequest, SnapValidationFailureReason } from './types';
+import type { SubjectPermissions, PermissionConstraint } from '@metamask/permission-controller';
+import type { BlockReason } from '@metamask/snaps-registry';
+import type { Json, SemVerVersion, Opaque } from '@metamask/utils';
+import type { SerializedEthereumRpcError } from 'eth-rpc-errors/dist/classes';
+import type { Struct } from 'superstruct';
+import type { SnapManifest, SnapPermissions } from './manifest/validation';
+import type { SnapFiles, SnapId, SnapsPermissionRequest } from './types';
+import { SnapIdPrefixes, SnapValidationFailureReason } from './types';
 export declare const PROPOSED_NAME_REGEX: RegExp;
 /**
  * wallet_enable / wallet_installSnaps permission typing.
@@ -28,7 +29,7 @@ export declare enum SnapStatusEvents {
     Update = "UPDATE"
 }
 export declare type StatusContext = {
-    snapId: string;
+    snapId: ValidatedSnapId;
 };
 export declare type StatusEvents = {
     type: SnapStatusEvents;
@@ -55,7 +56,7 @@ export declare type Snap = {
     /**
      * The ID of the Snap.
      */
-    id: SnapId;
+    id: ValidatedSnapId;
     /**
      * The initial permissions of the Snap, which will be requested when it is
      * installed.
@@ -139,6 +140,13 @@ declare const snapIdSymbol: unique symbol;
  * @returns The snap prefix from a snap id, e.g. `npm:`.
  */
 export declare function getSnapPrefix(snapId: string): SnapIdPrefixes;
+/**
+ * Strips snap prefix from a full snap ID.
+ *
+ * @param snapId - The snap ID to strip.
+ * @returns The stripped snap ID.
+ */
+export declare function stripSnapPrefix(snapId: string): string;
 /**
  * Assert that the given value is a valid snap ID.
  *

package/dist/types/strings.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Indent a message by adding a number of spaces to the beginning of each line.
+ *
+ * @param message - The message to indent.
+ * @param spaces - The number of spaces to indent by. Defaults to 2.
+ * @returns The indented message.
+ */
+export declare function indent(message: string, spaces?: number): string;

package/dist/types/structs.d.ts

@@ -0,0 +1,158 @@
+import type { Failure, Infer } from 'superstruct';
+import { Struct, StructError } from 'superstruct';
+import type { AnyStruct, InferStructTuple } from 'superstruct/dist/utils';
+/**
+ * A wrapper of `superstruct`'s `literal` struct that also defines the name of
+ * the struct as the literal value.
+ *
+ * This is useful for improving the error messages returned by `superstruct`.
+ * For example, instead of returning an error like:
+ *
+ * ```
+ * Expected the value to satisfy a union of `literal | literal`, but received: \"baz\"
+ * ```
+ *
+ * This struct will return an error like:
+ *
+ * ```
+ * Expected the value to satisfy a union of `"foo" | "bar"`, but received: \"baz\"
+ * ```
+ *
+ * @param value - The literal value.
+ * @returns The `superstruct` struct, which validates that the value is equal
+ * to the literal value.
+ */
+export declare function literal<Type extends string | number | boolean>(value: Type): Struct<Type, null>;
+/**
+ * A wrapper of `superstruct`'s `union` struct that also defines the schema as
+ * the union of the schemas of the structs.
+ *
+ * This is useful for improving the error messages returned by `superstruct`.
+ *
+ * @param structs - The structs to union.
+ * @param structs."0" - The first struct.
+ * @param structs."1" - The remaining structs.
+ * @returns The `superstruct` struct, which validates that the value satisfies
+ * one of the structs.
+ */
+export declare function union<Head extends AnyStruct, Tail extends AnyStruct[]>([head, ...tail]: [head: Head, ...tail: Tail]): Struct<Infer<Head> | InferStructTuple<Tail>[number], [
+    head: Head,
+    ...tail: Tail
+]>;
+/**
+ * A wrapper of `superstruct`'s `string` struct that coerces a value to a string
+ * and resolves it relative to the current working directory. This is useful
+ * for specifying file paths in a configuration file, as it allows the user to
+ * use both relative and absolute paths.
+ *
+ * @returns The `superstruct` struct, which validates that the value is a
+ * string, and resolves it relative to the current working directory.
+ * @example
+ * ```ts
+ * const config = struct({
+ *   file: file(),
+ *   // ...
+ * });
+ *
+ * const value = create({ file: 'path/to/file' }, config);
+ * console.log(value.file); // /process/cwd/path/to/file
+ * ```
+ */
+export declare function file(): Struct<string, null>;
+/**
+ * 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 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>);
+}
+declare type GetErrorOptions<Type, Schema> = {
+    struct: Struct<Type, Schema>;
+    prefix: string;
+    suffix?: string;
+    error: StructError;
+};
+/**
+ * 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 declare function arrayToGenerator<Type>(array: Type[]): Generator<Type, void, undefined>;
+/**
+ * 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.
+ * @returns The `SnapsStructError`.
+ */
+export declare function getError<Type, Schema>({ struct, prefix, suffix, error, }: 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
+ * 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 declare function createFromStruct<Type, Schema>(value: unknown, struct: Struct<Type, Schema>, prefix: string, suffix?: string): Type;
+/**
+ * Get a struct from a failure path.
+ *
+ * @param struct - The struct.
+ * @param path - The failure path.
+ * @returns The struct at the failure path.
+ */
+export declare function getStructFromPath<Type, Schema>(struct: Struct<Type, Schema>, path: string[]): AnyStruct;
+/**
+ * Get the union struct names from a struct.
+ *
+ * @param struct - The struct.
+ * @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;
+/**
+ * Get a error prefix from a `superstruct` failure. This is useful for
+ * formatting the error message returned by `superstruct`.
+ *
+ * @param failure - The `superstruct` failure.
+ * @returns The error prefix.
+ */
+export declare function getStructErrorPrefix(failure: Failure): 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
+ * readable way.
+ *
+ * @param struct - The struct that caused the failure.
+ * @param failure - The `superstruct` failure.
+ * @returns A string describing the failure.
+ */
+export declare function getStructFailureMessage<Type, Schema>(struct: Struct<Type, Schema>, failure: Failure): 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.
+ * @returns A string describing the errors.
+ */
+export declare function getStructErrorMessage<Type, Schema>(struct: Struct<Type, Schema>, failures: Failure[]): string;
+export {};