@metamask/snaps-jest 4.0.1 → 5.0.0

package/dist/types/internals/network.d.ts

@@ -1,87 +0,0 @@
-import type { Page, HTTPRequest } from 'puppeteer';
-import type { Infer, Struct } from 'superstruct';
-import type { DeepPartial } from '../types';
-export declare type Unmock = () => Promise<void>;
-export declare type Mock = {
-    /**
-     * A function that can be used to unmock the URL.
-     */
-    unmock: Unmock;
-};
-/**
- * A function that can return `true` if the given request should be mocked, or
- * false if not.
- *
- * @param request - The request to check.
- * @returns Whether to mock the request.
- */
-export declare type ConditionFunction = (request: HTTPRequest) => boolean;
-export declare const MockOptionsStruct: Struct<{
-    response: {
-        headers: Record<string, unknown>;
-        status: number;
-        body: string;
-        contentType: string;
-    };
-    url: string | RegExp;
-    partial?: boolean | undefined;
-} | {
-    response: {
-        headers: Record<string, unknown>;
-        status: number;
-        body: string;
-        contentType: string;
-    };
-    condition: ConditionFunction;
-}, null>;
-/**
- * The options for the network mocking.
- *
- * @property url - The URL to mock. If a string is provided, the URL will be
- * matched exactly. If a RegExp is provided, the URL will be matched against it.
- * This option is incompatible with the `condition` option.
- * @property partial - If enabled, the request will be mocked if the URL starts
- * with the given URL. This option is ignored if a RegExp is provided to the
- * `url` option. This option is incompatible with the `condition` option.
- * @property condition - A function which gets the {@link HTTPRequest} as
- * parameter and returns a boolean to indicate whether the response should be
- * mocked or not. This option is incompatible with the `url` and `partial`
- * options.
- * @property response - The response to send for the request.
- * @property response.status - The status code to send for the response.
- * Defaults to `200`.
- * @property response.headers - The headers to send for the response. Defaults
- * to headers that enable CORS.
- * @property response.contentType - The content type to send for the response.
- * Defaults to `text/plain`.
- */
-export declare type MockOptions = Infer<typeof MockOptionsStruct>;
-/**
- * Enable network mocking for the given page, and all its sub-frames.
- *
- * @param page - The page to enable network mocking on.
- * @param options - The options for the network mocking.
- * @returns A {@link Mock} object, with an `unmock` function.
- */
-export declare function mock(page: Page, options: DeepPartial<MockOptions>): Promise<Mock>;
-declare const MockJsonRpcOptionsStruct: Struct<{
-    result: import("@metamask/utils").Json;
-    method: string;
-}, {
-    method: Struct<string, null>;
-    result: Struct<import("@metamask/utils").Json, unknown>;
-}>;
-export declare type MockJsonRpcOptions = Infer<typeof MockJsonRpcOptionsStruct>;
-/**
- * Mock an Ethereum JSON-RPC request. This intercepts all requests to the
- * Ethereum provider, and returns the `result` instead.
- *
- * @param page - The page to enable network JSON-RPC mocking on.
- * @param options - The options for the JSON-RPC mock.
- * @param options.method - The JSON-RPC method to mock. Any other methods will be
- * forwarded to the provider.
- * @param options.result - The JSON response to return.
- * @returns A {@link Mock} object, with an `unmock` function.
- */
-export declare function mockJsonRpc(page: Page, { method, result }: MockJsonRpcOptions): Promise<Mock>;
-export {};

package/dist/types/internals/types.d.ts

@@ -1,18 +0,0 @@
-import type { NotificationType, EnumToUnion } from '@metamask/snaps-sdk';
-import type { ApplicationState, Dispatch } from '@metamask/snaps-simulator';
-declare global {
-    interface Window {
-        __SIMULATOR_API__: {
-            dispatch: Dispatch;
-            subscribe: (listener: () => void) => () => void;
-            getState: () => ApplicationState;
-            getRequestId: () => string;
-            getNotifications: (requestId: string) => {
-                id: string;
-                message: string;
-                type: EnumToUnion<NotificationType>;
-            }[];
-        };
-    }
-}
-export {};

package/dist/types/internals/wait-for.d.ts

@@ -1,38 +0,0 @@
-import type { HandlerType } from '@metamask/snaps-utils';
-import type { Page } from 'puppeteer';
-export declare type WaitForOptions = {
-    /**
-     * The timeout in milliseconds.
-     */
-    timeout?: number;
-    /**
-     * The error message to throw if the condition is not met.
-     */
-    message?: string;
-};
-/**
- * Wait for a condition to be true. This is a wrapper around
- * `pptr-testing-library`'s `waitFor` function, with the addition of a custom
- * error message.
- *
- * @param fn - The condition to wait for.
- * @param options - The options.
- * @param options.timeout - The timeout in milliseconds.
- * @param options.message - The error message to throw if the condition is not
- * met.
- * @returns A promise that resolves when the condition is met. The promise
- * resolves to the return value of the condition function.
- */
-export declare function waitFor<Result>(fn: () => Promise<Result>, { timeout, message }?: WaitForOptions): Promise<Result & ({} | null)>;
-/**
- * Wait for a JSON-RPC response.
- *
- * @param page - The page to wait for the response on.
- * @param type - The type of response to wait for.
- * @returns The JSON-RPC response.
- */
-export declare function waitForResponse(page: Page, type: HandlerType.OnTransaction | HandlerType.OnRpcRequest | HandlerType.OnCronjob): Promise<{
-    result: import("@metamask/utils").Json;
-} | {
-    error: import("@metamask/utils").Json;
-}>;