@metamask/snaps-utils 8.0.1 → 8.1.0

package/dist/types/snaps.d.ts

@@ -1,169 +0,0 @@
-import type { SubjectPermissions, PermissionConstraint } from '@metamask/permission-controller';
-import type { BlockReason } from '@metamask/snaps-registry';
-import type { SnapId, Snap as TruncatedSnap } from '@metamask/snaps-sdk';
-import type { Struct } from '@metamask/superstruct';
-import type { LocalizationFile } from './localization';
-import type { InitialConnections, SnapManifest, SnapPermissions } from './manifest/validation';
-import type { FetchedSnapFiles, SnapsPermissionRequest } from './types';
-import { SnapIdPrefixes } from './types';
-export declare const PROPOSED_NAME_REGEX: RegExp;
-export declare enum SnapStatus {
-    Installing = "installing",
-    Updating = "updating",
-    Running = "running",
-    Stopped = "stopped",
-    Crashed = "crashed"
-}
-export declare enum SnapStatusEvents {
-    Start = "START",
-    Stop = "STOP",
-    Crash = "CRASH",
-    Update = "UPDATE"
-}
-export type StatusContext = {
-    snapId: SnapId;
-};
-export type StatusEvents = {
-    type: SnapStatusEvents;
-};
-export type StatusStates = {
-    value: SnapStatus;
-    context: StatusContext;
-};
-export type Status = StatusStates['value'];
-export type VersionHistory = {
-    origin: string;
-    version: string;
-    date: number;
-};
-export type SnapAuxilaryFile = {
-    path: string;
-    value: string;
-};
-export type PersistedSnap = Snap;
-/**
- * A Snap as it exists in {@link SnapController} state.
- */
-export type Snap = TruncatedSnap & {
-    /**
-     * The initial connections of the Snap, optional, requested on installation.
-     */
-    initialConnections?: InitialConnections;
-    /**
-     * The initial permissions of the Snap, which will be requested when it is
-     * installed.
-     */
-    initialPermissions: SnapPermissions;
-    /**
-     * The source code of the Snap.
-     */
-    sourceCode: string;
-    /**
-     * The Snap's manifest file.
-     */
-    manifest: SnapManifest;
-    /**
-     * Information detailing why the snap is blocked.
-     */
-    blockInformation?: BlockReason;
-    /**
-     * The current status of the Snap, e.g. whether it's running or stopped.
-     */
-    status: Status;
-    /**
-     * 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.
-     */
-    versionHistory: VersionHistory[];
-    /**
-     * Static auxiliary files that can be loaded at runtime.
-     */
-    auxiliaryFiles?: SnapAuxilaryFile[];
-    /**
-     * 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;
-    /**
-     * Flag to signal whether this snap should be hidden from the user or not.
-     */
-    hidden?: boolean;
-};
-export type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version' | 'enabled' | 'blocked';
-/**
- * Calculates the Base64-encoded SHA-256 digest of all required Snap files.
- *
- * @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): Promise<string>;
-/**
- * Checks whether the `source.shasum` property of a Snap manifest matches the
- * shasum of the snap.
- *
- * @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): 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>;
-/**
- * Extracts the snap prefix from a snap ID.
- *
- * @param snapId - The snap ID to extract the prefix from.
- * @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.
- *
- * @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 SnapId;
-/**
- * Typeguard to ensure a chainId follows the CAIP-2 standard.
- *
- * @param chainId - The chainId being tested.
- * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.
- */
-export declare function isCaipChainId(chainId: unknown): chainId is string;
-/**
- * Utility function to check if an origin has permission (and caveat) for a particular snap.
- *
- * @param permissions - An origin's permissions object.
- * @param snapId - The id of the snap.
- * @returns A boolean based on if an origin has the specified snap.
- */
-export declare function isSnapPermitted(permissions: SubjectPermissions<PermissionConstraint>, snapId: SnapId): boolean;
-/**
- * Checks whether the passed in requestedPermissions is a valid
- * permission request for a `wallet_snap` permission.
- *
- * @param requestedPermissions - The requested permissions.
- * @throws If the criteria is not met.
- */
-export declare function verifyRequestedSnapPermissions(requestedPermissions: unknown): asserts requestedPermissions is SnapsPermissionRequest;
-export type { Snap as TruncatedSnap } from '@metamask/snaps-sdk';

package/dist/types/strings.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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

@@ -1,180 +0,0 @@
-import type { AnyStruct, Assign, Failure, ObjectSchema, ObjectType } from '@metamask/superstruct';
-import { Struct, StructError } from '@metamask/superstruct';
-/**
- * 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 type InferMatching<StructType extends Struct<any, any>, Type> = StructType['TYPE'] extends Type ? Type : never;
-/**
- * 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>, colorize?: boolean);
-}
-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
- * 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.
- * @param options.colorize - Whether to colorize the value. Defaults to `true`.
- * @returns The `SnapsStructError`.
- */
-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
- * 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.
- * @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>, colorize?: boolean): string[] | 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 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
- * 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 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[], 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 declare function mergeStructs<ObjectA extends ObjectSchema, ObjectB extends ObjectSchema>(A: Struct<ObjectType<ObjectA>, ObjectA>, B: Struct<ObjectType<ObjectB>, ObjectB>): Struct<ObjectType<Assign<ObjectA, ObjectB>>, Assign<ObjectA, ObjectB>>;
-export declare function mergeStructs<ObjectA extends ObjectSchema, ObjectB extends ObjectSchema, ObjectC extends ObjectSchema>(A: Struct<ObjectType<ObjectA>, ObjectA>, B: Struct<ObjectType<ObjectB>, ObjectB>, C: Struct<ObjectType<ObjectC>, ObjectC>): Struct<ObjectType<Assign<Assign<ObjectA, ObjectB>, ObjectC>>, Assign<Assign<ObjectA, ObjectB>, ObjectC>>;
-export declare function mergeStructs<ObjectA extends ObjectSchema, ObjectB extends ObjectSchema, ObjectC extends ObjectSchema, ObjectD extends ObjectSchema>(A: Struct<ObjectType<ObjectA>, ObjectA>, B: Struct<ObjectType<ObjectB>, ObjectB>, C: Struct<ObjectType<ObjectC>, ObjectC>, D: Struct<ObjectType<ObjectD>, ObjectD>): Struct<ObjectType<Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>>, Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>>;
-export declare function mergeStructs<ObjectA extends ObjectSchema, ObjectB extends ObjectSchema, ObjectC extends ObjectSchema, ObjectD extends ObjectSchema, ObjectE extends ObjectSchema>(A: Struct<ObjectType<ObjectA>, ObjectA>, B: Struct<ObjectType<ObjectB>, ObjectB>, C: Struct<ObjectType<ObjectC>, ObjectC>, D: Struct<ObjectType<ObjectD>, ObjectD>, E: Struct<ObjectType<ObjectE>, ObjectE>): Struct<ObjectType<Assign<Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>, ObjectE>>, Assign<Assign<Assign<Assign<ObjectA, ObjectB>, ObjectC>, ObjectD>, ObjectE>>;
-export {};

package/dist/types/svg.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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;

package/dist/types/types.d.ts

@@ -1,103 +0,0 @@
-import type { Infer, Struct } from '@metamask/superstruct';
-import type { Json } from '@metamask/utils';
-import type { SnapCaveatType } from './caveats';
-import type { SnapFunctionExports, SnapRpcHookArgs } from './handlers';
-import type { LocalizationFile } from './localization';
-import type { SnapManifest } from './manifest';
-import type { VirtualFile } from './virtual-file';
-export declare enum NpmSnapFileNames {
-    PackageJson = "package.json",
-    Manifest = "snap.manifest.json"
-}
-export declare const NameStruct: Struct<string, null>;
-export declare const NpmSnapPackageJsonStruct: Struct<{
-    name: string;
-    version: import("@metamask/utils").SemVerVersion;
-    main?: string | undefined;
-    repository?: {
-        type: string;
-        url: string;
-    } | undefined;
-}, {
-    version: Struct<import("@metamask/utils").SemVerVersion, null>;
-    name: Struct<string, null>;
-    main: Struct<string | undefined, null>;
-    repository: Struct<{
-        type: string;
-        url: string;
-    } | undefined, {
-        type: Struct<string, null>;
-        url: Struct<string, null>;
-    }>;
-}>;
-export type NpmSnapPackageJson = Infer<typeof NpmSnapPackageJsonStruct> & Record<string, any>;
-/**
- * An object for storing parsed but unvalidated Snap file contents.
- */
-export type UnvalidatedSnapFiles = {
-    manifest?: VirtualFile<Json>;
-    packageJson?: VirtualFile<Json>;
-    sourceCode?: VirtualFile;
-    svgIcon?: VirtualFile;
-    auxiliaryFiles: VirtualFile[];
-    localizationFiles: VirtualFile[];
-};
-/**
- * An object for storing the contents of Snap files that have passed JSON
- * Schema validation, or are non-empty if they are strings.
- */
-export type SnapFiles = {
-    manifest: VirtualFile<SnapManifest>;
-    packageJson: VirtualFile<NpmSnapPackageJson>;
-    sourceCode: VirtualFile;
-    svgIcon?: VirtualFile;
-    auxiliaryFiles: VirtualFile[];
-    localizationFiles: VirtualFile<LocalizationFile>[];
-};
-/**
- * A subset of snap files extracted from a fetched snap.
- */
-export type FetchedSnapFiles = Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon' | 'auxiliaryFiles' | 'localizationFiles'>;
-/**
- * The possible prefixes for snap ids.
- */
-export declare enum SnapIdPrefixes {
-    npm = "npm:",
-    local = "local:"
-}
-export declare enum SNAP_STREAM_NAMES {
-    JSON_RPC = "jsonRpc",
-    COMMAND = "command"
-}
-export type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;
-type ObjectParameters<Type extends Record<string, (...args: any[]) => unknown>> = Parameters<Type[keyof Type]>;
-export type SnapExportsParameters = ObjectParameters<SnapFunctionExports>;
-type UriOptions<Type extends string> = {
-    protocol?: Struct<Type>;
-    hash?: Struct<Type>;
-    port?: Struct<Type>;
-    hostname?: Struct<Type>;
-    pathname?: Struct<Type>;
-    search?: Struct<Type>;
-};
-export declare const uri: (opts?: UriOptions<any>) => Struct<string | URL, null>;
-/**
- * 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.
- */
-export declare function isValidUrl(url: unknown, opts?: UriOptions<any>): url is string | URL;
-export declare const WALLET_SNAP_PERMISSION_KEY = "wallet_snap";
-export type SnapsPermissionRequest = {
-    [WALLET_SNAP_PERMISSION_KEY]: {
-        caveats: [
-            {
-                type: SnapCaveatType.SnapIds;
-                value: Record<string, Json>;
-            }
-        ];
-    };
-};
-export {};

package/dist/types/ui.d.ts

@@ -1,84 +0,0 @@
-import type { Component } from '@metamask/snaps-sdk';
-import type { JSXElement, LinkElement, Nestable, SnapNode, StandardFormattingElement } from '@metamask/snaps-sdk/jsx';
-/**
- * Get all text children from a markdown string.
- *
- * @param value - The markdown string.
- * @returns The text children.
- */
-export declare function getTextChildren(value: string): (string | StandardFormattingElement | LinkElement)[];
-/**
- * Get a JSX element from a legacy UI component. This supports all legacy UI
- * components, and maps them to their JSX equivalents where possible.
- *
- * This function validates the text size of the component, but does not validate
- * the total size. The total size of the component should be validated before
- * calling this function.
- *
- * @param legacyComponent - The legacy UI component.
- * @returns The JSX element.
- */
-export declare function getJsxElementFromComponent(legacyComponent: Component): JSXElement;
-/**
- * Search 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;
-/**
- * Walk a JSX tree and validate each {@link LinkElement} node against the
- * phishing list.
- *
- * @param node - The JSX node to walk.
- * @param isOnPhishingList - The function that checks the link against the
- * phishing list.
- */
-export declare function validateJsxLinks(node: JSXElement, isOnPhishingList: (url: string) => boolean): void;
-/**
- * Calculate the total length of all text in the component.
- *
- * @param component - A custom UI component.
- * @returns The total length of all text components in the component.
- */
-export declare function getTotalTextLength(component: Component): number;
-/**
- * Check if a JSX element has children.
- *
- * @param element - A JSX element.
- * @returns `true` if the element has children, `false` otherwise.
- */
-export declare function hasChildren<Element extends JSXElement>(element: Element): element is Element & {
-    props: {
-        children: Nestable<JSXElement | string>;
-    };
-};
-/**
- * Get the children of a JSX element as an array. If the element has only one
- * child, the child is returned as an array.
- *
- * @param element - A JSX element.
- * @returns The children of the element.
- */
-export declare function getJsxChildren(element: JSXElement): (JSXElement | string)[];
-/**
- * Walk a JSX tree and call a callback on each node.
- *
- * @param node - The JSX node to walk.
- * @param callback - The callback to call on each node.
- * @param depth - The current depth in the JSX tree for a walk.
- * @returns The result of the callback, if any.
- */
-export declare function walkJsx<Value>(node: JSXElement | JSXElement[], callback: (node: JSXElement, depth: number) => Value | undefined, depth?: number): Value | undefined;
-/**
- * Serialise a JSX node to a string.
- *
- * @param node - The JSX node.
- * @param indentation - The indentation level. Defaults to `0`. This should not
- * be set by the caller, as it is used for recursion.
- * @returns The serialised JSX node.
- */
-export declare function serialiseJsx(node: SnapNode, indentation?: number): string;

package/dist/types/validation.d.ts

@@ -1,8 +0,0 @@
-import type { FetchedSnapFiles } from './types';
-/**
- * Validates the files contained in a fetched snap.
- *
- * @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): Promise<void>;

package/dist/types/versions.d.ts

@@ -1,21 +0,0 @@
-import type { Json, SemVerVersion, SemVerRange } from '@metamask/utils';
-export declare const DEFAULT_REQUESTED_SNAP_VERSION: SemVerRange;
-/**
- * Return the highest version in the list that satisfies the range, or `null` if
- * none of them do. For the satisfaction check, pre-release versions will only
- * be checked if no satisfactory non-prerelease version is found first.
- *
- * @param versions - The list of version to check.
- * @param versionRange - The SemVer version range to check against.
- * @returns The highest version in the list that satisfies the range,
- * or `null` if none of them do.
- */
-export declare function getTargetVersion(versions: SemVerVersion[], versionRange: SemVerRange): SemVerVersion | null;
-/**
- * Parse a version received by some subject attempting to access a snap.
- *
- * @param version - The received version value.
- * @returns `*` if the version is `undefined` or `latest", otherwise returns
- * the specified version.
- */
-export declare function resolveVersionRange(version?: Json): [error: undefined, range: SemVerRange] | [error: Error, range: undefined];

package/dist/types/virtual-file/VirtualFile.d.ts

@@ -1,34 +0,0 @@
-/**
- * This map registers the type of the {@link VirtualFile.data} key of a {@link VirtualFile}.
- *
- * This type can be augmented to register custom `data` types.
- *
- * @example
- * declare module '@metamask/snaps-utils' {
- *   interface DataMap {
- *     // `file.data.name` is typed as `string`
- *     name: string
- *   }
- * }
- */
-export interface DataMap {
-}
-export type Value = string | Uint8Array;
-export type Compatible<Result = unknown> = string | Uint8Array | Options<Result>;
-export type Data = Record<string, unknown> & Partial<DataMap>;
-export type Options<Result = unknown> = {
-    value: Value;
-    path?: string;
-    data?: Data;
-    result?: Result;
-};
-export declare class VirtualFile<Result = unknown> {
-    constructor(value?: Compatible<Result>);
-    value: Value;
-    result: Result;
-    data: Data;
-    path: string;
-    get size(): number;
-    toString(encoding?: string): string;
-    clone(): VirtualFile<Result>;
-}

package/dist/types/virtual-file/index.d.ts

@@ -1 +0,0 @@
-export * from './VirtualFile';

package/dist/types/virtual-file/node.d.ts

@@ -1,2 +0,0 @@
-export * from '.';
-export * from './toVirtualFile';

package/dist/types/virtual-file/toVirtualFile.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { promises as fsPromises } from 'fs';
-import { VirtualFile } from './VirtualFile';
-/**
- * Reads a file from filesystem and creates a vfile.
- *
- * @param path - Filesystem path to load the contents from.
- * @param encoding - Optional encoding to pass down to fs.readFile.
- * @returns Promise returning VFile with loaded file contents.
- */
-export declare function readVirtualFile(path: string, encoding?: BufferEncoding | null): Promise<VirtualFile<unknown>>;
-type WriteVFileOptions = Exclude<Parameters<(typeof fsPromises)['writeFile']>[2], undefined>;
-/**
- * Writes vfile to filesystem.
- *
- * @param vfile - The vfile to write.
- * @param options - Options to pass down to fs.writeFile.
- */
-export declare function writeVirtualFile(vfile: VirtualFile, options?: WriteVFileOptions): Promise<void>;
-export {};

package/dist/types.js

@@ -1,22 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-
-
-
-
-
-
-
-var _chunkMWAZGSROjs = require('./chunk-MWAZGSRO.js');
-require('./chunk-S3BWTUTZ.js');
-
-
-
-
-
-
-
-
-
-exports.NameStruct = _chunkMWAZGSROjs.NameStruct; exports.NpmSnapFileNames = _chunkMWAZGSROjs.NpmSnapFileNames; exports.NpmSnapPackageJsonStruct = _chunkMWAZGSROjs.NpmSnapPackageJsonStruct; exports.SNAP_STREAM_NAMES = _chunkMWAZGSROjs.SNAP_STREAM_NAMES; exports.SnapIdPrefixes = _chunkMWAZGSROjs.SnapIdPrefixes; exports.WALLET_SNAP_PERMISSION_KEY = _chunkMWAZGSROjs.WALLET_SNAP_PERMISSION_KEY; exports.isValidUrl = _chunkMWAZGSROjs.isValidUrl; exports.uri = _chunkMWAZGSROjs.uri;
-//# sourceMappingURL=types.js.map