@metamask/snaps-utils 8.0.1 → 8.1.1

package/dist/localization.d.cts

@@ -0,0 +1,146 @@
+import type { Infer } from "@metamask/superstruct";
+import type { SnapManifest } from "./manifest/index.cjs";
+import type { VirtualFile } from "./virtual-file/index.cjs";
+export declare const LOCALIZABLE_FIELDS: readonly ["description", "proposedName"];
+export declare const LocalizationFileStruct: import("@metamask/superstruct").Struct<{
+    messages: Record<string, {
+        message: string;
+        description?: string | undefined;
+    }>;
+    locale: string;
+}, {
+    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[]): {
+    messages: Record<string, {
+        message: string;
+        description?: string | undefined;
+    }>;
+    locale: string;
+} | 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[]): {
+    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;
+    };
+    description: string;
+    version: import("@metamask/utils").SemVerVersion;
+    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;
+//# sourceMappingURL=localization.d.cts.map

package/dist/localization.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localization.d.cts","sourceRoot":"","sources":["../src/localization.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAWnD,OAAO,KAAK,EAAE,YAAY,EAAE,6BAAmB;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,iCAAuB;AAElD,eAAO,MAAM,kBAAkB,0CAA2C,CAAC;AAE3E,eAAO,MAAM,sBAAsB;;;;;;;;;;;;EASjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC3C,iBAAiB,EAAE,WAAW,EAAE,GAC/B,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAsBjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,gBAAgB,EAAE;;;;;;cAatC;AAED,eAAO,MAAM,iBAAiB,QAAuC,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,SAAS,UAsB1E;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,gBAAgB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWtC;AAED;;;;;;GAMG;AACH,wBAAgB,iCAAiC,CAC/C,YAAY,EAAE,YAAY,EAC1B,iBAAiB,EAAE,gBAAgB,EAAE,QAkBtC"}

package/dist/localization.d.mts

@@ -0,0 +1,146 @@
+import type { Infer } from "@metamask/superstruct";
+import type { SnapManifest } from "./manifest/index.mjs";
+import type { VirtualFile } from "./virtual-file/index.mjs";
+export declare const LOCALIZABLE_FIELDS: readonly ["description", "proposedName"];
+export declare const LocalizationFileStruct: import("@metamask/superstruct").Struct<{
+    messages: Record<string, {
+        message: string;
+        description?: string | undefined;
+    }>;
+    locale: string;
+}, {
+    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[]): {
+    messages: Record<string, {
+        message: string;
+        description?: string | undefined;
+    }>;
+    locale: string;
+} | 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[]): {
+    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;
+    };
+    description: string;
+    version: import("@metamask/utils").SemVerVersion;
+    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;
+//# sourceMappingURL=localization.d.mts.map

package/dist/localization.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localization.d.mts","sourceRoot":"","sources":["../src/localization.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAWnD,OAAO,KAAK,EAAE,YAAY,EAAE,6BAAmB;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,iCAAuB;AAElD,eAAO,MAAM,kBAAkB,0CAA2C,CAAC;AAE3E,eAAO,MAAM,sBAAsB;;;;;;;;;;;;EASjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC3C,iBAAiB,EAAE,WAAW,EAAE,GAC/B,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAsBjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,gBAAgB,EAAE;;;;;;cAatC;AAED,eAAO,MAAM,iBAAiB,QAAuC,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,SAAS,UAsB1E;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,gBAAgB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWtC;AAED;;;;;;GAMG;AACH,wBAAgB,iCAAiC,CAC/C,YAAY,EAAE,YAAY,EAC1B,iBAAiB,EAAE,gBAAgB,EAAE,QAkBtC"}

package/dist/localization.mjs

@@ -1,23 +1,120 @@
-import {
-  LOCALIZABLE_FIELDS,
-  LocalizationFileStruct,
-  TRANSLATION_REGEX,
-  getLocalizationFile,
-  getLocalizedSnapManifest,
-  getValidatedLocalizationFiles,
-  translate,
-  validateSnapManifestLocalizations
-} from "./chunk-CJK7DDV2.mjs";
-import "./chunk-UNNEBOL4.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  LOCALIZABLE_FIELDS,
-  LocalizationFileStruct,
-  TRANSLATION_REGEX,
-  getLocalizationFile,
-  getLocalizedSnapManifest,
-  getValidatedLocalizationFiles,
-  translate,
-  validateSnapManifestLocalizations
-};
+import { getErrorMessage } from "@metamask/snaps-sdk";
+import { create, object, optional, record, string, StructError } from "@metamask/superstruct";
+import { parseJson } from "./json.mjs";
+export const LOCALIZABLE_FIELDS = ['description', 'proposedName'];
+export const LocalizationFileStruct = object({
+    locale: string(),
+    messages: record(string(), object({
+        message: string(),
+        description: optional(string()),
+    })),
+});
+/**
+ * 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 function getValidatedLocalizationFiles(localizationFiles) {
+    for (const file of localizationFiles) {
+        try {
+            file.result = create(parseJson(file.toString()), LocalizationFileStruct);
+        }
+        catch (error) {
+            if (error instanceof StructError) {
+                throw new Error(`Failed to validate localization file "${file.path}": ${error.message}.`);
+            }
+            if (error instanceof SyntaxError) {
+                throw new Error(`Failed to parse localization file "${file.path}" as JSON.`);
+            }
+            throw error;
+        }
+    }
+    return localizationFiles;
+}
+/**
+ * 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 function getLocalizationFile(locale, localizationFiles) {
+    const file = localizationFiles.find((localizationFile) => localizationFile.locale === locale);
+    if (!file) {
+        return localizationFiles.find((localizationFile) => localizationFile.locale === 'en');
+    }
+    return file;
+}
+export const TRANSLATION_REGEX = /\{\{\s?([a-zA-Z0-9-_\s]+)\s?\}\}/gu;
+/**
+ * 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 function translate(value, file) {
+    const matches = value.matchAll(TRANSLATION_REGEX);
+    const array = Array.from(matches);
+    return array.reduce((result, [match, key]) => {
+        if (!file) {
+            throw new Error(`Failed to translate "${value}": No localization file found.`);
+        }
+        const translation = file.messages[key.trim()];
+        if (!translation) {
+            throw new Error(`Failed to translate "${value}": No translation found for "${key.trim()}" in "${file.locale}" file.`);
+        }
+        return result.replace(match, translation.message);
+    }, value);
+}
+/**
+ * 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 function getLocalizedSnapManifest(snapManifest, locale, localizationFiles) {
+    const file = getLocalizationFile(locale, localizationFiles);
+    return LOCALIZABLE_FIELDS.reduce((manifest, field) => {
+        const translation = translate(manifest[field], file);
+        return {
+            ...manifest,
+            [field]: translation,
+        };
+    }, snapManifest);
+}
+/**
+ * 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 function validateSnapManifestLocalizations(snapManifest, localizationFiles) {
+    try {
+        // `translate` throws if the manifest cannot be localized, so we just attempt
+        // to translate the manifest using all localization files.
+        localizationFiles
+            .filter((file) => file.locale !== 'en')
+            .forEach((file) => {
+            getLocalizedSnapManifest(snapManifest, file.locale, localizationFiles);
+        });
+        // The manifest must be localizable in English.
+        getLocalizedSnapManifest(snapManifest, 'en', localizationFiles);
+    }
+    catch (error) {
+        throw new Error(`Failed to localize Snap manifest: ${getErrorMessage(error)}`);
+    }
+}
 //# sourceMappingURL=localization.mjs.map

package/dist/localization.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"localization.mjs","sourceRoot":"","sources":["../src/localization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,4BAA4B;AAEtD,OAAO,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,WAAW,EACZ,8BAA8B;AAE/B,OAAO,EAAE,SAAS,EAAE,mBAAe;AAInC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,aAAa,EAAE,cAAc,CAAU,CAAC;AAE3E,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;IAC3C,MAAM,EAAE,MAAM,EAAE;IAChB,QAAQ,EAAE,MAAM,CACd,MAAM,EAAE,EACR,MAAM,CAAC;QACL,OAAO,EAAE,MAAM,EAAE;QACjB,WAAW,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;KAChC,CAAC,CACH;CACF,CAAC,CAAC;AAIH;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAC3C,iBAAgC;IAEhC,KAAK,MAAM,IAAI,IAAI,iBAAiB,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,sBAAsB,CAAC,CAAC;QAC3E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,yCAAyC,IAAI,CAAC,IAAI,MAAM,KAAK,CAAC,OAAO,GAAG,CACzE,CAAC;YACJ,CAAC;YAED,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,CAAC,IAAI,YAAY,CAC5D,CAAC;YACJ,CAAC;YAED,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,iBAAoD,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAc,EACd,iBAAqC;IAErC,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CACjC,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,KAAK,MAAM,CACzD,CAAC;IAEF,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,iBAAiB,CAAC,IAAI,CAC3B,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,KAAK,IAAI,CACvD,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,oCAAoC,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa,EAAE,IAAkC;IACzE,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAElC,OAAO,KAAK,CAAC,MAAM,CAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE;QACnD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACb,wBAAwB,KAAK,gCAAgC,CAC9D,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,wBAAwB,KAAK,gCAAgC,GAAG,CAAC,IAAI,EAAE,SACrE,IAAI,CAAC,MACP,SAAS,CACV,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC,EAAE,KAAK,CAAC,CAAC;AACZ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CACtC,YAA0B,EAC1B,MAAc,EACd,iBAAqC;IAErC,MAAM,IAAI,GAAG,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAE5D,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QACnD,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACrD,OAAO;YACL,GAAG,QAAQ;YACX,CAAC,KAAK,CAAC,EAAE,WAAW;SACrB,CAAC;IACJ,CAAC,EAAE,YAAY,CAAC,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iCAAiC,CAC/C,YAA0B,EAC1B,iBAAqC;IAErC,IAAI,CAAC;QACH,6EAA6E;QAC7E,0DAA0D;QAC1D,iBAAiB;aACd,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC;aACtC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,wBAAwB,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEL,+CAA+C;QAC/C,wBAAwB,CAAC,YAAY,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAClE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,qCAAqC,eAAe,CAAC,KAAK,CAAC,EAAE,CAC9D,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { getErrorMessage } from '@metamask/snaps-sdk';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  create,\n  object,\n  optional,\n  record,\n  string,\n  StructError,\n} from '@metamask/superstruct';\n\nimport { parseJson } from './json';\nimport type { SnapManifest } from './manifest';\nimport type { VirtualFile } from './virtual-file';\n\nexport const LOCALIZABLE_FIELDS = ['description', 'proposedName'] as const;\n\nexport const LocalizationFileStruct = object({\n  locale: string(),\n  messages: record(\n    string(),\n    object({\n      message: string(),\n      description: optional(string()),\n    }),\n  ),\n});\n\nexport type LocalizationFile = Infer<typeof LocalizationFileStruct>;\n\n/**\n * Validate a list of localization files.\n *\n * @param localizationFiles - The localization files to validate.\n * @returns The validated localization files.\n * @throws If any of the files are considered invalid.\n */\nexport function getValidatedLocalizationFiles(\n  localizationFiles: VirtualFile[],\n): VirtualFile<LocalizationFile>[] {\n  for (const file of localizationFiles) {\n    try {\n      file.result = create(parseJson(file.toString()), LocalizationFileStruct);\n    } catch (error) {\n      if (error instanceof StructError) {\n        throw new Error(\n          `Failed to validate localization file \"${file.path}\": ${error.message}.`,\n        );\n      }\n\n      if (error instanceof SyntaxError) {\n        throw new Error(\n          `Failed to parse localization file \"${file.path}\" as JSON.`,\n        );\n      }\n\n      throw error;\n    }\n  }\n\n  return localizationFiles as VirtualFile<LocalizationFile>[];\n}\n\n/**\n * Get the localization file for a given locale. If the locale is not found,\n * the English localization file will be returned.\n *\n * @param locale - The locale to use.\n * @param localizationFiles - The localization files to use.\n * @returns The localization file, or `undefined` if no localization file was\n * found.\n */\nexport function getLocalizationFile(\n  locale: string,\n  localizationFiles: LocalizationFile[],\n) {\n  const file = localizationFiles.find(\n    (localizationFile) => localizationFile.locale === locale,\n  );\n\n  if (!file) {\n    return localizationFiles.find(\n      (localizationFile) => localizationFile.locale === 'en',\n    );\n  }\n\n  return file;\n}\n\nexport const TRANSLATION_REGEX = /\\{\\{\\s?([a-zA-Z0-9-_\\s]+)\\s?\\}\\}/gu;\n\n/**\n * Translate a string using a localization file. This will replace all instances\n * of `{{key}}` with the localized version of `key`.\n *\n * @param value - The string to translate.\n * @param file - The localization file to use, or `undefined` if no localization\n * file was found.\n * @returns The translated string.\n * @throws If the string contains a key that is not present in the localization\n * file, or if no localization file was found.\n */\nexport function translate(value: string, file: LocalizationFile | undefined) {\n  const matches = value.matchAll(TRANSLATION_REGEX);\n  const array = Array.from(matches);\n\n  return array.reduce<string>((result, [match, key]) => {\n    if (!file) {\n      throw new Error(\n        `Failed to translate \"${value}\": No localization file found.`,\n      );\n    }\n\n    const translation = file.messages[key.trim()];\n    if (!translation) {\n      throw new Error(\n        `Failed to translate \"${value}\": No translation found for \"${key.trim()}\" in \"${\n          file.locale\n        }\" file.`,\n      );\n    }\n\n    return result.replace(match, translation.message);\n  }, value);\n}\n\n/**\n * Get the localized Snap manifest for a given locale. This will replace all\n * localized strings in the manifest with the localized version.\n *\n * @param snapManifest - The Snap manifest to localize.\n * @param locale - The locale to use.\n * @param localizationFiles - The localization files to use.\n * @returns The localized Snap manifest.\n */\nexport function getLocalizedSnapManifest(\n  snapManifest: SnapManifest,\n  locale: string,\n  localizationFiles: LocalizationFile[],\n) {\n  const file = getLocalizationFile(locale, localizationFiles);\n\n  return LOCALIZABLE_FIELDS.reduce((manifest, field) => {\n    const translation = translate(manifest[field], file);\n    return {\n      ...manifest,\n      [field]: translation,\n    };\n  }, snapManifest);\n}\n\n/**\n * Validate the localization files for a Snap manifest.\n *\n * @param snapManifest - The Snap manifest to validate.\n * @param localizationFiles - The localization files to validate.\n * @throws If the manifest cannot be localized.\n */\nexport function validateSnapManifestLocalizations(\n  snapManifest: SnapManifest,\n  localizationFiles: LocalizationFile[],\n) {\n  try {\n    // `translate` throws if the manifest cannot be localized, so we just attempt\n    // to translate the manifest using all localization files.\n    localizationFiles\n      .filter((file) => file.locale !== 'en')\n      .forEach((file) => {\n        getLocalizedSnapManifest(snapManifest, file.locale, localizationFiles);\n      });\n\n    // The manifest must be localizable in English.\n    getLocalizedSnapManifest(snapManifest, 'en', localizationFiles);\n  } catch (error) {\n    throw new Error(\n      `Failed to localize Snap manifest: ${getErrorMessage(error)}`,\n    );\n  }\n}\n"]}

package/dist/logging.cjs

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logWarning = exports.logError = exports.logInfo = exports.snapsLogger = void 0;
+const utils_1 = require("@metamask/utils");
+// The global logger used across the monorepo. Other projects should use this
+// to create a module logger.
+exports.snapsLogger = (0, utils_1.createProjectLogger)('snaps');
+/**
+ * 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.
+ */
+function logInfo(message, ...optionalParams) {
+    // eslint-disable-next-line no-console
+    console.log(message, ...optionalParams);
+}
+exports.logInfo = logInfo;
+/**
+ * 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.
+ */
+function logError(error, ...optionalParams) {
+    // eslint-disable-next-line no-console
+    console.error(error, ...optionalParams);
+}
+exports.logError = logError;
+/**
+ * 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.
+ */
+function logWarning(message, ...optionalParams) {
+    // eslint-disable-next-line no-console
+    console.warn(message, ...optionalParams);
+}
+exports.logWarning = logWarning;
+//# sourceMappingURL=logging.cjs.map

package/dist/logging.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.cjs","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,6EAA6E;AAC7E,6BAA6B;AAChB,QAAA,WAAW,GAAG,IAAA,2BAAmB,EAAC,OAAO,CAAC,CAAC;AAExD;;;;;;;;;;;GAWG;AACH,SAAgB,OAAO,CAAC,OAAe,EAAE,GAAG,cAAyB;IACnE,sCAAsC;IACtC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAC;AAC1C,CAAC;AAHD,0BAGC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,QAAQ,CAAC,KAAc,EAAE,GAAG,cAAyB;IACnE,sCAAsC;IACtC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,cAAc,CAAC,CAAC;AAC1C,CAAC;AAHD,4BAGC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,UAAU,CACxB,OAAe,EACf,GAAG,cAAyB;IAE5B,sCAAsC;IACtC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAC;AAC3C,CAAC;AAND,gCAMC","sourcesContent":["import { createProjectLogger } from '@metamask/utils';\n\n// The global logger used across the monorepo. Other projects should use this\n// to create a module logger.\nexport const snapsLogger = createProjectLogger('snaps');\n\n/**\n * Log a message. Currently, this is just a wrapper around `console.log`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param message - The message to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logInfo(message: string, ...optionalParams: unknown[]): void {\n  // eslint-disable-next-line no-console\n  console.log(message, ...optionalParams);\n}\n\n/**\n * Log an error. Currently, this is just a wrapper around `console.error`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * These logs should always be visible, without requiring the user to enable\n * verbose logging (like setting a `DEBUG` environment variable), as they are\n * important for debugging snaps.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param error - The error to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logError(error: unknown, ...optionalParams: unknown[]): void {\n  // eslint-disable-next-line no-console\n  console.error(error, ...optionalParams);\n}\n\n/**\n * Log a warning. Currently, this is just a wrapper around `console.warn`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * These logs should always be visible, without requiring the user to enable\n * verbose logging (like setting a `DEBUG` environment variable), as they are\n * important for debugging snaps.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param message - The message to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logWarning(\n  message: string,\n  ...optionalParams: unknown[]\n): void {\n  // eslint-disable-next-line no-console\n  console.warn(message, ...optionalParams);\n}\n"]}

package/dist/logging.d.cts

@@ -0,0 +1,50 @@
+/// <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;
+//# sourceMappingURL=logging.d.cts.map

package/dist/logging.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.cts","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";AAIA,eAAO,MAAM,WAAW,0BAA+B,CAAC;AAExD;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAG3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAG3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,MAAM,EACf,GAAG,cAAc,EAAE,OAAO,EAAE,GAC3B,IAAI,CAGN"}

package/dist/logging.d.mts

@@ -0,0 +1,50 @@
+/// <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;
+//# sourceMappingURL=logging.d.mts.map

package/dist/logging.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.mts","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";AAIA,eAAO,MAAM,WAAW,0BAA+B,CAAC;AAExD;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAG3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAG3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,MAAM,EACf,GAAG,cAAc,EAAE,OAAO,EAAE,GAC3B,IAAI,CAGN"}