@metamask/snaps-utils 8.0.1 → 8.1.0

package/dist/types/icon.d.ts

@@ -1,19 +0,0 @@
-import type { VirtualFile } from './virtual-file';
-export declare const SVG_MAX_BYTE_SIZE = 100000;
-export declare const SVG_MAX_BYTE_SIZE_TEXT: string;
-/**
- * Assert that a virtual file containing a Snap icon is valid.
- *
- * @param icon - A virtual file containing a Snap icon.
- */
-export declare function assertIsSnapIcon(icon: VirtualFile): void;
-/**
- * Extract the dimensions of an image from an SVG string if possible.
- *
- * @param svg - An SVG string.
- * @returns The height and width of the SVG or null.
- */
-export declare function getSvgDimensions(svg: string): {
-    height: number;
-    width: number;
-} | null;

package/dist/types/iframe.d.ts

@@ -1,11 +0,0 @@
-/**
- * Creates the iframe to be used as the execution environment. This may run
- * forever if the iframe never loads, but the promise should be wrapped in
- * an initialization timeout in the SnapController.
- *
- * @param uri - The iframe URI.
- * @param id - The ID to assign to the iframe.
- * @param sandbox - Whether to enable the sandbox attribute.
- * @returns A promise that resolves to the contentWindow of the iframe.
- */
-export declare function createWindow(uri: string, id: string, sandbox?: boolean): Promise<Window>;

package/dist/types/iframe.test.browser.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/index.d.ts

@@ -1,32 +0,0 @@
-export * from './array';
-export * from './auxiliary-files';
-export * from './base64';
-export * from './bytes';
-export * from './caveats';
-export * from './checksum';
-export * from './constants';
-export * from './cronjob';
-export * from './deep-clone';
-export * from './default-endowments';
-export * from './derivation-paths';
-export * from './entropy';
-export * from './errors';
-export * from './handlers';
-export * from './handler-types';
-export * from './iframe';
-export * from './json';
-export * from './json-rpc';
-export * from './localization';
-export * from './logging';
-export * from './manifest';
-export * from './namespace';
-export * from './path';
-export * from './snaps';
-export * from './strings';
-export * from './structs';
-export * from './types';
-export * from './ui';
-export * from './validation';
-export * from './versions';
-export * from './virtual-file';
-export * from './promise';

package/dist/types/index.executionenv.d.ts

@@ -1,7 +0,0 @@
-export * from './errors';
-export * from './handlers';
-export * from './handler-types';
-export * from './iframe';
-export * from './logging';
-export * from './namespace';
-export * from './types';

package/dist/types/json-rpc.d.ts

@@ -1,55 +0,0 @@
-import { SubjectType } from '@metamask/permission-controller';
-import type { Infer } from '@metamask/superstruct';
-import type { AssertionErrorConstructor, Json, JsonRpcSuccess } from '@metamask/utils';
-export declare const RpcOriginsStruct: import("@metamask/superstruct").Struct<{
-    snaps?: boolean | undefined;
-    dapps?: boolean | undefined;
-    allowedOrigins?: string[] | undefined;
-}, {
-    dapps: import("@metamask/superstruct").Struct<boolean | undefined, null>;
-    snaps: import("@metamask/superstruct").Struct<boolean | undefined, null>;
-    allowedOrigins: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
-}>;
-export type RpcOrigins = Infer<typeof RpcOriginsStruct>;
-/**
- * Asserts that the given value is a valid {@link RpcOrigins} object.
- *
- * @param value - The value to assert.
- * @param ErrorWrapper - An optional error wrapper to use. Defaults to
- * {@link AssertionError}.
- * @throws If the value is not a valid {@link RpcOrigins} object.
- */
-export declare function assertIsRpcOrigins(value: unknown, ErrorWrapper?: AssertionErrorConstructor): asserts value is RpcOrigins;
-export declare const KeyringOriginsStruct: import("@metamask/superstruct").Struct<{
-    allowedOrigins?: string[] | undefined;
-}, {
-    allowedOrigins: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
-}>;
-export type KeyringOrigins = Infer<typeof KeyringOriginsStruct>;
-/**
- * Assert that the given value is a valid {@link KeyringOrigins} object.
- *
- * @param value - The value to assert.
- * @param ErrorWrapper - An optional error wrapper to use. Defaults to
- * {@link AssertionError}.
- * @throws If the value is not a valid {@link KeyringOrigins} object.
- */
-export declare function assertIsKeyringOrigins(value: unknown, ErrorWrapper?: AssertionErrorConstructor): asserts value is KeyringOrigins;
-/**
- * Check if the given origin is allowed by the given JSON-RPC origins object.
- *
- * @param origins - The JSON-RPC origins object.
- * @param subjectType - The type of the origin.
- * @param origin - The origin to check.
- * @returns Whether the origin is allowed.
- */
-export declare function isOriginAllowed(origins: RpcOrigins, subjectType: SubjectType, origin: string): boolean;
-/**
- * Assert that the given value is a successful JSON-RPC response. If the value
- * is not a success response, an error is thrown. If the value is an JSON-RPC
- * error, the error message is included in the thrown error.
- *
- * @param value - The value to check.
- * @throws If the value is not a JSON-RPC success response.
- */
-export declare function assertIsJsonRpcSuccess(value: unknown): asserts value is JsonRpcSuccess<Json>;

package/dist/types/json.d.ts

@@ -1,22 +0,0 @@
-import type { Json } from '@metamask/utils';
-/**
- * Parse JSON safely.
- *
- * Does multiple kinds of validation and strips unwanted properties like
- * `__proto__` and `constructor`.
- *
- * @param json - A JSON string to be parsed.
- * @returns The parsed JSON object.
- * @template Type - The type of the JSON object. The type is not actually
- * checked, but it is used to infer the return type.
- */
-export declare function parseJson<Type extends Json = Json>(json: string): Type;
-/**
- * Get the size of a JSON blob without validating that is valid JSON.
- *
- * This may sometimes be preferred over `getJsonSize` for performance reasons.
- *
- * @param value - The JSON value to get the size of.
- * @returns The size of the JSON value in bytes.
- */
-export declare function getJsonSizeUnsafe(value: Json): number;

package/dist/types/localization.d.ts

@@ -1,145 +0,0 @@
-import type { Infer } from '@metamask/superstruct';
-import type { SnapManifest } from './manifest';
-import type { VirtualFile } from './virtual-file';
-export declare const LOCALIZABLE_FIELDS: readonly ["description", "proposedName"];
-export declare const LocalizationFileStruct: import("@metamask/superstruct").Struct<{
-    locale: string;
-    messages: Record<string, {
-        message: string;
-        description?: string | undefined;
-    }>;
-}, {
-    locale: import("@metamask/superstruct").Struct<string, null>;
-    messages: import("@metamask/superstruct").Struct<Record<string, {
-        message: string;
-        description?: string | undefined;
-    }>, null>;
-}>;
-export type LocalizationFile = Infer<typeof LocalizationFileStruct>;
-/**
- * Validate a list of localization files.
- *
- * @param localizationFiles - The localization files to validate.
- * @returns The validated localization files.
- * @throws If any of the files are considered invalid.
- */
-export declare function getValidatedLocalizationFiles(localizationFiles: VirtualFile[]): VirtualFile<LocalizationFile>[];
-/**
- * Get the localization file for a given locale. If the locale is not found,
- * the English localization file will be returned.
- *
- * @param locale - The locale to use.
- * @param localizationFiles - The localization files to use.
- * @returns The localization file, or `undefined` if no localization file was
- * found.
- */
-export declare function getLocalizationFile(locale: string, localizationFiles: LocalizationFile[]): {
-    locale: string;
-    messages: Record<string, {
-        message: string;
-        description?: string | undefined;
-    }>;
-} | undefined;
-export declare const TRANSLATION_REGEX: RegExp;
-/**
- * Translate a string using a localization file. This will replace all instances
- * of `{{key}}` with the localized version of `key`.
- *
- * @param value - The string to translate.
- * @param file - The localization file to use, or `undefined` if no localization
- * file was found.
- * @returns The translated string.
- * @throws If the string contains a key that is not present in the localization
- * file, or if no localization file was found.
- */
-export declare function translate(value: string, file: LocalizationFile | undefined): string;
-/**
- * Get the localized Snap manifest for a given locale. This will replace all
- * localized strings in the manifest with the localized version.
- *
- * @param snapManifest - The Snap manifest to localize.
- * @param locale - The locale to use.
- * @param localizationFiles - The localization files to use.
- * @returns The localized Snap manifest.
- */
-export declare function getLocalizedSnapManifest(snapManifest: SnapManifest, locale: string, localizationFiles: LocalizationFile[]): {
-    description: string;
-    version: import("@metamask/utils").SemVerVersion;
-    source: {
-        location: {
-            npm: {
-                registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
-                filePath: string;
-                packageName: string;
-                iconPath?: string | undefined;
-            };
-        };
-        shasum: string;
-        files?: string[] | undefined;
-        locales?: string[] | undefined;
-    };
-    proposedName: string;
-    initialPermissions: Partial<{
-        'endowment:cronjob': {
-            jobs: import("@metamask/snaps-sdk").Cronjob[];
-            maxRequestTime?: number | undefined;
-        };
-        'endowment:ethereum-provider': import("@metamask/snaps-sdk").EmptyObject;
-        'endowment:keyring': {
-            allowedOrigins?: string[] | undefined;
-            maxRequestTime?: number | undefined;
-        };
-        'endowment:lifecycle-hooks'?: {
-            maxRequestTime?: number | undefined;
-        } | undefined;
-        'endowment:name-lookup': {
-            chains?: `${string}:${string}`[] | undefined;
-            matchers?: import("@metamask/snaps-sdk").NameLookupMatchers | undefined;
-            maxRequestTime?: number | undefined;
-        };
-        'endowment:network-access': import("@metamask/snaps-sdk").EmptyObject;
-        'endowment:page-home'?: {
-            maxRequestTime?: number | undefined;
-        } | undefined;
-        'endowment:rpc': {
-            dapps?: boolean | undefined;
-            snaps?: boolean | undefined;
-            allowedOrigins?: string[] | undefined;
-            maxRequestTime?: number | undefined;
-        };
-        'endowment:signature-insight': {
-            allowSignatureOrigin?: boolean | undefined;
-            maxRequestTime?: number | undefined;
-        };
-        'endowment:transaction-insight': {
-            allowTransactionOrigin?: boolean | undefined;
-            maxRequestTime?: number | undefined;
-        };
-        'endowment:webassembly': import("@metamask/snaps-sdk").EmptyObject;
-        snap_dialog: import("@metamask/snaps-sdk").EmptyObject;
-        snap_getBip32Entropy: import("@metamask/snaps-sdk").Bip32Entropy[];
-        snap_getBip32PublicKey: import("@metamask/snaps-sdk").Bip32Entropy[];
-        snap_getBip44Entropy: import("@metamask/snaps-sdk").Bip44Entropy[];
-        snap_getEntropy: import("@metamask/snaps-sdk").EmptyObject;
-        snap_getLocale: import("@metamask/snaps-sdk").EmptyObject;
-        snap_manageAccounts: import("@metamask/snaps-sdk").EmptyObject;
-        snap_manageState: import("@metamask/snaps-sdk").EmptyObject;
-        snap_notify: import("@metamask/snaps-sdk").EmptyObject;
-        wallet_snap: Record<string, import("@metamask/snaps-sdk").RequestedSnap>;
-    }>;
-    manifestVersion: "0.1";
-    repository?: {
-        type: string;
-        url: string;
-    } | undefined;
-    initialConnections?: Record<string & URL, {}> | undefined;
-    $schema?: string | undefined;
-};
-/**
- * Validate the localization files for a Snap manifest.
- *
- * @param snapManifest - The Snap manifest to validate.
- * @param localizationFiles - The localization files to validate.
- * @throws If the manifest cannot be localized.
- */
-export declare function validateSnapManifestLocalizations(snapManifest: SnapManifest, localizationFiles: LocalizationFile[]): void;

package/dist/types/logging.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="debug" />
-export declare const snapsLogger: import("debug").Debugger;
-/**
- * Log a message. Currently, this is just a wrapper around `console.log`, but
- * the implementation may change in the future. These logs will be included in
- * production builds, so they should be used sparingly, and not contain any
- * sensitive information.
- *
- * This function makes it easy to swap out the logging implementation in all
- * files at once.
- *
- * @param message - The message to log.
- * @param optionalParams - Additional parameters to pass to the logging.
- */
-export declare function logInfo(message: string, ...optionalParams: unknown[]): void;
-/**
- * Log an error. Currently, this is just a wrapper around `console.error`, but
- * the implementation may change in the future. These logs will be included in
- * production builds, so they should be used sparingly, and not contain any
- * sensitive information.
- *
- * These logs should always be visible, without requiring the user to enable
- * verbose logging (like setting a `DEBUG` environment variable), as they are
- * important for debugging snaps.
- *
- * This function makes it easy to swap out the logging implementation in all
- * files at once.
- *
- * @param error - The error to log.
- * @param optionalParams - Additional parameters to pass to the logging.
- */
-export declare function logError(error: unknown, ...optionalParams: unknown[]): void;
-/**
- * Log a warning. Currently, this is just a wrapper around `console.warn`, but
- * the implementation may change in the future. These logs will be included in
- * production builds, so they should be used sparingly, and not contain any
- * sensitive information.
- *
- * These logs should always be visible, without requiring the user to enable
- * verbose logging (like setting a `DEBUG` environment variable), as they are
- * important for debugging snaps.
- *
- * This function makes it easy to swap out the logging implementation in all
- * files at once.
- *
- * @param message - The message to log.
- * @param optionalParams - Additional parameters to pass to the logging.
- */
-export declare function logWarning(message: string, ...optionalParams: unknown[]): void;

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

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

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

@@ -1,98 +0,0 @@
-/// <reference types="node" />
-import type { Json } from '@metamask/utils';
-import type { SnapFiles } from '../types';
-import { VirtualFile } from '../virtual-file/node';
-import type { SnapManifest } from './validation';
-import type { ValidatorResults } from './validator';
-import type { ValidatorMeta, ValidatorReport } from './validator-types';
-export type CheckManifestReport = Omit<ValidatorReport, 'fix'> & {
-    wasFixed?: boolean;
-};
-/**
- * The result from the `checkManifest` function.
- *
- * @property manifest - The fixed manifest object.
- * @property updated - Whether the manifest was written and updated.
- */
-export type CheckManifestResult = {
-    files?: SnapFiles;
-    updated: boolean;
-    reports: CheckManifestReport[];
-};
-export 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
- * fails.
- *
- * @param basePath - The path to the folder with the manifest files.
- * @param options - Additional options for the function.
- * @param options.sourceCode - The source code of the Snap.
- * @param options.writeFileFn - The function to use to write the manifest to disk.
- * @param options.updateAndWriteManifest - Whether to auto-magically try to fix errors and then 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, { updateAndWriteManifest, sourceCode, writeFileFn, }?: {
-    updateAndWriteManifest?: boolean;
-    sourceCode?: string;
-    writeFileFn?: WriteFileFunction;
-}): Promise<CheckManifestResult>;
-/**
- * Run the algorithm for automatically fixing errors in manifest.
- *
- * The algorithm updates the manifest by fixing all fixable problems,
- * and then run validation again to check if the new manifest is now correct.
- * If not correct, the algorithm will use the manifest from previous iteration
- * and try again `MAX_ATTEMPTS` times to update it before bailing and
- * resulting in failure.
- *
- * @param results - Results of the initial run of validation.
- * @param rules - Optional list of rules to run the fixes with.
- */
-export declare function runFixes(results: ValidatorResults, rules?: ValidatorMeta[]): Promise<CheckManifestResult>;
-/**
- * Given an unvalidated Snap manifest, attempts to extract the location of the
- * bundle source file location and read the file.
- *
- * @param basePath - The path to the folder with the manifest files.
- * @param manifest - The unvalidated Snap manifest file contents.
- * @param sourceCode - Override source code for plugins.
- * @returns The contents of the bundle file, if any.
- */
-export declare function getSnapSourceCode(basePath: string, manifest: Json, sourceCode?: string): Promise<VirtualFile | undefined>;
-/**
- * Given an unvalidated Snap manifest, attempts to extract the location of the
- * icon and read the file.
- *
- * @param basePath - The path to the folder with the manifest files.
- * @param manifest - The unvalidated Snap manifest file contents.
- * @returns The contents of the icon, if any.
- */
-export declare function getSnapIcon(basePath: string, manifest: Json): Promise<VirtualFile | undefined>;
-/**
- * Get an array of paths from an unvalidated Snap manifest.
- *
- * @param manifest - The unvalidated Snap manifest file contents.
- * @param selector - A function that returns the paths to the files.
- * @returns The paths to the files, if any.
- */
-export declare function getSnapFilePaths(manifest: Json, selector: (manifest: Partial<SnapManifest>) => string[] | undefined): string[] | undefined;
-/**
- * Given an unvalidated Snap manifest, attempts to extract the files with the
- * given paths and read them.
- *
- * @param basePath - The path to the folder with the manifest files.
- * @param paths - The paths to the files.
- * @param encoding - An optional encoding to pass down to readVirtualFile.
- * @returns A list of auxiliary files and their contents, if any.
- */
-export declare function getSnapFiles(basePath: string, paths: string[] | undefined, encoding?: BufferEncoding | null): Promise<VirtualFile[] | undefined>;
-/**
- * Sorts the given manifest in our preferred sort order and removes the
- * `repository` field if it is falsy (it may be `null`).
- *
- * @param manifest - The manifest to sort and modify.
- * @returns The disk-ready manifest.
- */
-export declare function getWritableManifest(manifest: SnapManifest): SnapManifest;

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

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