@metamask/snaps-utils 3.2.0 → 3.3.0

package/dist/types/localization.d.ts

@@ -0,0 +1,143 @@
+import type { Infer } from '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("superstruct").Struct<{
+    locale: string;
+    messages: Record<string, {
+        message: string;
+        description?: string | undefined;
+    }>;
+}, {
+    locale: import("superstruct").Struct<string, null>;
+    messages: import("superstruct").Struct<Record<string, {
+        message: string;
+        description?: string | undefined;
+    }>, null>;
+}>;
+export declare 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;
+    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;
+    };
+    version: import("@metamask/utils").SemVerVersion;
+    proposedName: string;
+    initialPermissions: {
+        'endowment:network-access'?: {} | undefined;
+        'endowment:webassembly'?: {} | undefined;
+        'endowment:transaction-insight'?: {
+            allowTransactionOrigin?: boolean | undefined;
+        } | undefined;
+        'endowment:cronjob'?: {
+            jobs: {
+                request: {
+                    method: string;
+                    params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | undefined;
+                    id?: string | number | null | undefined;
+                    jsonrpc?: "2.0" | undefined;
+                };
+                expression: string;
+            }[];
+        } | undefined;
+        'endowment:rpc'?: {
+            dapps?: boolean | undefined;
+            snaps?: boolean | undefined;
+            allowedOrigins?: string[] | undefined;
+        } | undefined;
+        'endowment:name-lookup'?: string[] | undefined;
+        'endowment:keyring'?: {
+            allowedOrigins?: string[] | undefined;
+        } | undefined;
+        snap_dialog?: {} | undefined;
+        snap_confirm?: {} | undefined;
+        snap_manageState?: {} | undefined;
+        snap_manageAccounts?: {} | undefined;
+        snap_notify?: {} | undefined;
+        snap_getBip32Entropy?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip32PublicKey?: {
+            path: string[];
+            curve: "ed25519" | "secp256k1";
+        }[] | undefined;
+        snap_getBip44Entropy?: {
+            coinType: number;
+        }[] | undefined;
+        snap_getEntropy?: {} | undefined;
+        wallet_snap?: Record<string, {
+            version?: string | undefined;
+        }> | undefined;
+    };
+    manifestVersion: "0.1";
+    repository?: {
+        type: string;
+        url: string;
+    } | 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/manifest/manifest.d.ts

@@ -67,14 +67,22 @@ export declare function getSnapSourceCode(basePath: string, manifest: Json, sour
  */
 export declare function getSnapIcon(basePath: string, manifest: Json): Promise<VirtualFile | undefined>;
 /**
- * Given an unvalidated Snap manifest, attempts to extract the auxiliary files
- * and read them.
+ * Get an array of paths from an unvalidated Snap manifest.
  *
- * @param basePath - The path to the folder with the manifest files.
  * @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.
  * @returns A list of auxiliary files and their contents, if any.
  */
-export declare function getSnapAuxiliaryFiles(basePath: string, manifest: Json): Promise<VirtualFile[] | undefined>;
+export declare function getSnapFiles(basePath: string, paths: string[] | undefined): 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`).
@@ -84,7 +92,7 @@ export declare function getSnapAuxiliaryFiles(basePath: string, manifest: Json):
  */
 export declare function getWritableManifest(manifest: SnapManifest): SnapManifest;
 /**
- * Validates the fields of an npm Snap manifest that has already passed JSON
+ * Validates the fields of an NPM Snap manifest that has already passed JSON
  * Schema validation.
  *
  * @param snapFiles - The relevant snap files to validate.
@@ -93,5 +101,6 @@ export declare function getWritableManifest(manifest: SnapManifest): SnapManifes
  * @param snapFiles.sourceCode - The Snap's source code.
  * @param snapFiles.svgIcon - The Snap's optional icon.
  * @param snapFiles.auxiliaryFiles - Any auxiliary files required by the snap at runtime.
+ * @param snapFiles.localizationFiles - The Snap's localization files.
  */
-export declare function validateNpmSnapManifest({ manifest, packageJson, sourceCode, svgIcon, auxiliaryFiles, }: SnapFiles): void;
+export declare function validateNpmSnapManifest({ manifest, packageJson, sourceCode, svgIcon, auxiliaryFiles, localizationFiles, }: SnapFiles): void;

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

@@ -204,6 +204,7 @@ export declare const SnapManifestStruct: Struct<{
         };
         shasum: string;
         files?: string[] | undefined;
+        locales?: string[] | undefined;
     };
     version: import("@metamask/utils").SemVerVersion;
     proposedName: string;
@@ -282,6 +283,7 @@ export declare const SnapManifestStruct: Struct<{
         };
         shasum: string;
         files?: string[] | undefined;
+        locales?: string[] | undefined;
     }, {
         shasum: Struct<string, null>;
         location: Struct<{
@@ -305,6 +307,7 @@ export declare const SnapManifestStruct: Struct<{
             }>;
         }>;
         files: Struct<string[] | undefined, Struct<string, null>>;
+        locales: Struct<string[] | undefined, Struct<string, null>>;
     }>;
     initialPermissions: Struct<{
         'endowment:network-access'?: {} | undefined;

package/dist/types/snaps.d.ts

@@ -2,6 +2,7 @@ import type { SubjectPermissions, PermissionConstraint } from '@metamask/permiss
 import type { BlockReason } from '@metamask/snaps-registry';
 import type { Json, JsonRpcError, Opaque, SemVerVersion } from '@metamask/utils';
 import type { Struct } from 'superstruct';
+import type { LocalizationFile } from './localization';
 import type { SnapManifest, SnapPermissions } from './manifest/validation';
 import type { FetchedSnapFiles, SnapId, SnapsPermissionRequest } from './types';
 import { SnapIdPrefixes, SnapValidationFailureReason } from './types';
@@ -98,6 +99,10 @@ export declare type Snap = {
      * Static auxiliary files that can be loaded at runtime.
      */
     auxiliaryFiles?: SnapAuxilaryFile[];
+    /**
+     * Localization files which are used to translate the manifest.
+     */
+    localizationFiles?: LocalizationFile[];
 };
 export declare type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version' | 'enabled' | 'blocked';
 /**

package/dist/types/types.d.ts

@@ -2,6 +2,7 @@ import type { Json } from '@metamask/utils';
 import type { Infer, Struct } from 'superstruct';
 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 {
@@ -53,6 +54,7 @@ export declare type UnvalidatedSnapFiles = {
     sourceCode?: VirtualFile;
     svgIcon?: VirtualFile;
     auxiliaryFiles: VirtualFile[];
+    localizationFiles: VirtualFile[];
 };
 /**
  * An object for storing the contents of Snap files that have passed JSON
@@ -64,11 +66,12 @@ export declare type SnapFiles = {
     sourceCode: VirtualFile;
     svgIcon?: VirtualFile;
     auxiliaryFiles: VirtualFile[];
+    localizationFiles: VirtualFile<LocalizationFile>[];
 };
 /**
  * A subset of snap files extracted from a fetched snap.
  */
-export declare type FetchedSnapFiles = Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon' | 'auxiliaryFiles'>;
+export declare type FetchedSnapFiles = Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon' | 'auxiliaryFiles' | 'localizationFiles'>;
 /**
  * The possible prefixes for snap ids.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-utils",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"