@metamask/snaps-utils 8.0.1 → 8.1.0

package/dist/types/errors.d.ts

@@ -1,84 +0,0 @@
-import { JsonRpcError as RpcError } from '@metamask/rpc-errors';
-import type { DataWithOptionalCause } from '@metamask/rpc-errors';
-import type { SerializedSnapError, SnapError } from '@metamask/snaps-sdk';
-import type { Json, JsonRpcError } from '@metamask/utils';
-export declare const SNAP_ERROR_WRAPPER_CODE = -31001;
-export declare const SNAP_ERROR_WRAPPER_MESSAGE = "Wrapped Snap Error";
-export type SerializedSnapErrorWrapper = {
-    code: typeof SNAP_ERROR_WRAPPER_CODE;
-    message: typeof SNAP_ERROR_WRAPPER_MESSAGE;
-    data: {
-        cause: Json;
-    };
-};
-export declare class WrappedSnapError extends Error {
-    #private;
-    /**
-     * Create a new `WrappedSnapError`.
-     *
-     * @param error - The error to create the `WrappedSnapError` from.
-     */
-    constructor(error: unknown);
-    /**
-     * The error name.
-     *
-     * @returns The error name.
-     */
-    get name(): string;
-    /**
-     * The error message.
-     *
-     * @returns The error message.
-     */
-    get message(): string;
-    /**
-     * The error stack.
-     *
-     * @returns The error stack.
-     */
-    get stack(): string | undefined;
-    /**
-     * Convert the error to a JSON object.
-     *
-     * @returns The JSON object.
-     */
-    toJSON(): SerializedSnapErrorWrapper;
-    /**
-     * Serialize the error to a JSON object. This is called by
-     * `@metamask/rpc-errors` when serializing the error.
-     *
-     * @returns The JSON object.
-     */
-    serialize(): SerializedSnapErrorWrapper;
-}
-/**
- * Check if an object is a `SnapError`.
- *
- * @param error - The object to check.
- * @returns Whether the object is a `SnapError`.
- */
-export declare function isSnapError(error: unknown): error is SnapError;
-/**
- * Check if a JSON-RPC error is a `SnapError`.
- *
- * @param error - The object to check.
- * @returns Whether the object is a `SnapError`.
- */
-export declare function isSerializedSnapError(error: JsonRpcError): error is SerializedSnapError;
-/**
- * Check if a JSON-RPC error is a `WrappedSnapError`.
- *
- * @param error - The object to check.
- * @returns Whether the object is a `WrappedSnapError`.
- */
-export declare function isWrappedSnapError(error: unknown): error is SerializedSnapErrorWrapper;
-/**
- * Attempt to unwrap an unknown error to a `JsonRpcError`. This function will
- * try to get the error code, message, and data from the error, and return a
- * `JsonRpcError` with those properties.
- *
- * @param error - The error to unwrap.
- * @returns A tuple containing the unwrapped error and a boolean indicating
- * whether the error was handled.
- */
-export declare function unwrapError(error: unknown): [error: RpcError<DataWithOptionalCause>, isHandled: boolean];

package/dist/types/eval-worker.d.ts

@@ -1 +0,0 @@
-import 'ses/lockdown';

package/dist/types/eval.d.ts

@@ -1,16 +0,0 @@
-export type EvalOutput = {
-    stdout: string;
-    stderr: string;
-};
-export declare class SnapEvalError extends Error {
-    readonly output: EvalOutput;
-    constructor(message: string, output: EvalOutput);
-}
-/**
- * Spawn a new process to run the provided bundle in.
- *
- * @param bundlePath - The path to the bundle to run.
- * @returns `null` if the worker ran successfully.
- * @throws If the worker failed to run successfully.
- */
-export declare function evalBundle(bundlePath: string): Promise<EvalOutput>;

package/dist/types/fs.d.ts

@@ -1,69 +0,0 @@
-import type { Json } from '@metamask/utils';
-import type { VirtualFile } from './virtual-file';
-/**
- * Checks whether the given path string resolves to an existing directory, and
- * optionally creates the directory if it doesn't exist.
- *
- * @param pathString - The path string to check.
- * @param createDir - Whether to create the directory if it doesn't exist.
- * @returns Whether the given path is an existing directory.
- */
-export declare function isDirectory(pathString: string, createDir: boolean): Promise<boolean>;
-/**
- * Checks whether the given path string resolves to an existing file.
- *
- * @param pathString - The path string to check.
- * @returns Whether the given path is an existing file.
- */
-export declare function isFile(pathString: string): Promise<boolean>;
-/**
- * Reads a `.json` file, parses its contents, and returns them.
- *
- * @param pathString - The path to the JSON file.
- * @returns The parsed contents of the JSON file.
- */
-export declare function readJsonFile<Type extends Json = Json>(pathString: string): Promise<VirtualFile<Type>>;
-/**
- * Gets the complete out file path from an output file name and parent
- * directory path.
- *
- * @param outDir - The path to the out file's parent directory.
- * @param outFileName - The out file's name.
- * @returns The complete path to the out file.
- */
-export declare function getOutfilePath(outDir: string, outFileName: string): string;
-/**
- * Ensures that the outfile name is just a `.js` file name.
- * Throws on validation failure.
- *
- * @param filename - The file name to validate.
- * @returns `true` if validation succeeded.
- * @throws If the file name is invalid.
- */
-export declare function validateOutfileName(filename: string): boolean;
-/**
- * Validates a file path. Throws on validation failure.
- *
- * @param filePath - The file path to validate.
- * @returns `true` if validation succeeded.
- * @throws If the path does not resolve to a file.
- */
-export declare function validateFilePath(filePath: string): Promise<boolean>;
-/**
- * Validates a directory path. Throws on validation failure.
- *
- * @param dirPath - The directory path to validate.
- * @param createDir - Whether to create the directory if it doesn't exist.
- * @returns `true` if validation succeeded or the directory was created.
- * @throws If the directory does not exist or could not be created.
- */
-export declare function validateDirPath(dirPath: string, createDir: boolean): Promise<boolean>;
-/**
- * Creates a temporary file with a given name and content, writes it to disk and calls the provided function.
- * This function handles deletion of the temporary file after usage.
- *
- * @param fileName - The name of the temporary file.
- * @param fileContents - The content of the temporary file.
- * @param fn - The callback function to call when the temporary file has been created.
- */
-export declare function useTemporaryFile(fileName: string, fileContents: string, fn: (path: string) => Promise<unknown>): Promise<void>;

package/dist/types/handler-types.d.ts

@@ -1,34 +0,0 @@
-export declare enum HandlerType {
-    OnRpcRequest = "onRpcRequest",
-    OnSignature = "onSignature",
-    OnTransaction = "onTransaction",
-    OnCronjob = "onCronjob",
-    OnInstall = "onInstall",
-    OnUpdate = "onUpdate",
-    OnNameLookup = "onNameLookup",
-    OnKeyringRequest = "onKeyringRequest",
-    OnHomePage = "onHomePage",
-    OnUserInput = "onUserInput"
-}
-export type SnapHandler = {
-    /**
-     * The type of handler.
-     */
-    type: HandlerType;
-    /**
-     * Whether the handler is required, i.e., whether the request will fail if the
-     * handler is called, but the snap does not export it.
-     *
-     * This is primarily used for the lifecycle handlers, which are optional.
-     */
-    required: boolean;
-    /**
-     * Validate the given snap export. This should return a type guard for the
-     * handler type.
-     *
-     * @param snapExport - The export to validate.
-     * @returns Whether the export is valid.
-     */
-    validator: (snapExport: unknown) => boolean;
-};
-export declare const SNAP_EXPORT_NAMES: HandlerType[];