@metamask/snaps-utils 0.34.0-flask.1 → 0.35.0-flask.1

package/dist/esm/deep-clone.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/deep-clone.ts"],"sourcesContent":["import rfdc from 'rfdc';\n\nexport const deepClone = rfdc({ proto: false, circles: false });\n"],"names":["rfdc","deepClone","proto","circles"],"mappings":"AAAA,OAAOA,UAAU,OAAO;AAExB,OAAO,MAAMC,YAAYD,KAAK;IAAEE,OAAO;IAAOC,SAAS;AAAM,GAAG"}

package/dist/{default-endowments.js → esm/default-endowments.js}

@@ -1,10 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_ENDOWMENTS = void 0;
 /**
  * Global JavaScript APIs exposed by default to all snaps.
- */
-exports.DEFAULT_ENDOWMENTS = Object.freeze([
+ */ export const DEFAULT_ENDOWMENTS = Object.freeze([
     'atob',
     'btoa',
     'BigInt',
@@ -37,6 +33,7 @@ exports.DEFAULT_ENDOWMENTS = Object.freeze([
     // https://github.com/MetaMask/snaps-monorepo/issues/662
     // https://github.com/MetaMask/snaps-monorepo/discussions/678
     'AbortController',
-    'AbortSignal',
+    'AbortSignal'
 ]);
+
 //# sourceMappingURL=default-endowments.js.map

package/dist/esm/default-endowments.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/default-endowments.ts"],"sourcesContent":["/**\n * Global JavaScript APIs exposed by default to all snaps.\n */\nexport const DEFAULT_ENDOWMENTS: readonly string[] = Object.freeze([\n  'atob',\n  'btoa',\n  'BigInt',\n  'console',\n  'crypto',\n  'Date',\n  'Math',\n  'setTimeout',\n  'clearTimeout',\n  'SubtleCrypto',\n  'TextDecoder',\n  'TextEncoder',\n  'URL',\n  'setInterval',\n  'clearInterval',\n  'Int8Array',\n  'Uint8Array',\n  'Uint8ClampedArray',\n  'Int16Array',\n  'Uint16Array',\n  'Int32Array',\n  'Uint32Array',\n  'Float32Array',\n  'Float64Array',\n  'BigInt64Array',\n  'BigUint64Array',\n  'DataView',\n  'ArrayBuffer',\n  // Used by fetch, but also as API for some packages that don't do network connections\n  // https://github.com/MetaMask/snaps-monorepo/issues/662\n  // https://github.com/MetaMask/snaps-monorepo/discussions/678\n  'AbortController',\n  'AbortSignal',\n]);\n"],"names":["DEFAULT_ENDOWMENTS","Object","freeze"],"mappings":"AAAA;;CAEC,GACD,OAAO,MAAMA,qBAAwCC,OAAOC,MAAM,CAAC;IACjE;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA,qFAAqF;IACrF,wDAAwD;IACxD,6DAA6D;IAC7D;IACA;CACD,EAAE"}

package/dist/esm/entropy.js

@@ -0,0 +1,6 @@
+// 0xd36e6170 - 0x80000000
+export const SIP_6_MAGIC_VALUE = `1399742832'`;
+// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`
+export const STATE_ENCRYPTION_MAGIC_VALUE = `572232532'`;
+
+//# sourceMappingURL=entropy.js.map

package/dist/esm/entropy.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/entropy.ts"],"sourcesContent":["// 0xd36e6170 - 0x80000000\nexport const SIP_6_MAGIC_VALUE = `1399742832'` as `${number}'`;\n\n// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`\nexport const STATE_ENCRYPTION_MAGIC_VALUE = `572232532'` as `${number}'`;\n\nexport type MagicValue =\n  | typeof SIP_6_MAGIC_VALUE\n  | typeof STATE_ENCRYPTION_MAGIC_VALUE;\n"],"names":["SIP_6_MAGIC_VALUE","STATE_ENCRYPTION_MAGIC_VALUE"],"mappings":"AAAA,0BAA0B;AAC1B,OAAO,MAAMA,oBAAoB,CAAC,WAAW,CAAC,CAAiB;AAE/D,uEAAuE;AACvE,OAAO,MAAMC,+BAA+B,CAAC,UAAU,CAAC,CAAiB"}

package/dist/esm/enum.js

@@ -0,0 +1,12 @@
+import { literal } from 'superstruct';
+/**
+ * Superstruct struct for validating an enum value. This allows using both the
+ * enum string values and the enum itself as values.
+ *
+ * @param constant - The enum to validate against.
+ * @returns The superstruct struct.
+ */ export function enumValue(constant) {
+    return literal(constant);
+}
+
+//# sourceMappingURL=enum.js.map

package/dist/esm/enum.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/enum.ts"],"sourcesContent":["import { literal, Struct } from 'superstruct';\n\n/**\n * Get the enum values as union type. This allows using both the enum string\n * values and the enum itself as values.\n *\n * Note: This only works for string enums.\n *\n * @example\n * ```typescript\n * enum Foo {\n *   Bar = 'bar',\n *   Baz = 'baz',\n * }\n *\n * type FooValue = EnumToUnion<Foo>;\n * // FooValue is 'bar' | 'baz'\n *\n * const foo: FooValue = Foo.Bar; // Works\n * const foo: FooValue = 'bar'; // Also works\n * ```\n */\nexport type EnumToUnion<Type extends string> = `${Type}`;\n\n/**\n * Superstruct struct for validating an enum value. This allows using both the\n * enum string values and the enum itself as values.\n *\n * @param constant - The enum to validate against.\n * @returns The superstruct struct.\n */\nexport function enumValue<Type extends string>(\n  constant: Type,\n): Struct<EnumToUnion<Type>, EnumToUnion<Type>> {\n  return literal(constant as EnumToUnion<Type>);\n}\n"],"names":["literal","enumValue","constant"],"mappings":"AAAA,SAASA,OAAO,QAAgB,cAAc;AAwB9C;;;;;;CAMC,GACD,OAAO,SAASC,UACdC,QAAc;IAEd,OAAOF,QAAQE;AACjB"}

package/dist/esm/eval-worker.js

@@ -0,0 +1,47 @@
+// eslint-disable-next-line import/no-unassigned-import
+import 'ses/lockdown';
+import { readFileSync } from 'fs';
+import { generateMockEndowments } from './mock';
+import { SNAP_EXPORT_NAMES } from './types';
+lockdown({
+    consoleTaming: 'unsafe',
+    errorTaming: 'unsafe',
+    mathTaming: 'unsafe',
+    dateTaming: 'unsafe',
+    overrideTaming: 'severe',
+    // We disable domain taming, because it does not work in certain cases when
+    // running tests. This is unlikely to be a problem in production, because
+    // Node.js domains are deprecated.
+    domainTaming: 'unsafe'
+});
+/**
+ * Get mock endowments that don't do anything. This is useful for running the
+ * eval, for snaps that try to communicate with the extension on initialisation,
+ * for example.
+ *
+ * @returns The mock endowments.
+ */ function getMockEndowments() {
+    const endowments = generateMockEndowments();
+    return {
+        ...endowments,
+        window: endowments,
+        self: endowments
+    };
+}
+const snapFilePath = process.argv[2];
+const snapModule = {
+    exports: {}
+};
+new Compartment({
+    ...getMockEndowments(),
+    module: snapModule,
+    exports: snapModule.exports
+}).evaluate(readFileSync(snapFilePath, 'utf8'));
+const invalidExports = Object.keys(snapModule.exports).filter((snapExport)=>!SNAP_EXPORT_NAMES.includes(snapExport));
+if (invalidExports.length > 0) {
+    // eslint-disable-next-line no-console
+    console.warn(`Invalid snap exports detected:\n${invalidExports.join('\n')}`);
+}
+setTimeout(()=>process.exit(0), 1000); // Hack to ensure worker exits
+
+//# sourceMappingURL=eval-worker.js.map

package/dist/esm/eval-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/eval-worker.ts"],"sourcesContent":["// eslint-disable-next-line import/no-unassigned-import\nimport 'ses/lockdown';\n\nimport { readFileSync } from 'fs';\n\nimport { generateMockEndowments } from './mock';\nimport { HandlerType, SNAP_EXPORT_NAMES } from './types';\n\ndeclare let lockdown: any, Compartment: any;\n\nlockdown({\n  consoleTaming: 'unsafe',\n  errorTaming: 'unsafe',\n  mathTaming: 'unsafe',\n  dateTaming: 'unsafe',\n  overrideTaming: 'severe',\n\n  // We disable domain taming, because it does not work in certain cases when\n  // running tests. This is unlikely to be a problem in production, because\n  // Node.js domains are deprecated.\n  domainTaming: 'unsafe',\n});\n\n/**\n * Get mock endowments that don't do anything. This is useful for running the\n * eval, for snaps that try to communicate with the extension on initialisation,\n * for example.\n *\n * @returns The mock endowments.\n */\nfunction getMockEndowments() {\n  const endowments = generateMockEndowments();\n  return {\n    ...endowments,\n    window: endowments,\n    self: endowments,\n  };\n}\n\nconst snapFilePath = process.argv[2];\n\nconst snapModule: { exports?: any } = { exports: {} };\n\nnew Compartment({\n  ...getMockEndowments(),\n  module: snapModule,\n  exports: snapModule.exports,\n}).evaluate(readFileSync(snapFilePath, 'utf8'));\n\nconst invalidExports = Object.keys(snapModule.exports).filter(\n  (snapExport) => !SNAP_EXPORT_NAMES.includes(snapExport as HandlerType),\n);\n\nif (invalidExports.length > 0) {\n  // eslint-disable-next-line no-console\n  console.warn(`Invalid snap exports detected:\\n${invalidExports.join('\\n')}`);\n}\n\nsetTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits\n"],"names":["readFileSync","generateMockEndowments","SNAP_EXPORT_NAMES","lockdown","consoleTaming","errorTaming","mathTaming","dateTaming","overrideTaming","domainTaming","getMockEndowments","endowments","window","self","snapFilePath","process","argv","snapModule","exports","Compartment","module","evaluate","invalidExports","Object","keys","filter","snapExport","includes","length","console","warn","join","setTimeout","exit"],"mappings":"AAAA,uDAAuD;AACvD,OAAO,eAAe;AAEtB,SAASA,YAAY,QAAQ,KAAK;AAElC,SAASC,sBAAsB,QAAQ,SAAS;AAChD,SAAsBC,iBAAiB,QAAQ,UAAU;AAIzDC,SAAS;IACPC,eAAe;IACfC,aAAa;IACbC,YAAY;IACZC,YAAY;IACZC,gBAAgB;IAEhB,2EAA2E;IAC3E,yEAAyE;IACzE,kCAAkC;IAClCC,cAAc;AAChB;AAEA;;;;;;CAMC,GACD,SAASC;IACP,MAAMC,aAAaV;IACnB,OAAO;QACL,GAAGU,UAAU;QACbC,QAAQD;QACRE,MAAMF;IACR;AACF;AAEA,MAAMG,eAAeC,QAAQC,IAAI,CAAC,EAAE;AAEpC,MAAMC,aAAgC;IAAEC,SAAS,CAAC;AAAE;AAEpD,IAAIC,YAAY;IACd,GAAGT,mBAAmB;IACtBU,QAAQH;IACRC,SAASD,WAAWC,OAAO;AAC7B,GAAGG,QAAQ,CAACrB,aAAac,cAAc;AAEvC,MAAMQ,iBAAiBC,OAAOC,IAAI,CAACP,WAAWC,OAAO,EAAEO,MAAM,CAC3D,CAACC,aAAe,CAACxB,kBAAkByB,QAAQ,CAACD;AAG9C,IAAIJ,eAAeM,MAAM,GAAG,GAAG;IAC7B,sCAAsC;IACtCC,QAAQC,IAAI,CAAC,CAAC,gCAAgC,EAAER,eAAeS,IAAI,CAAC,MAAM,CAAC;AAC7E;AAEAC,WAAW,IAAMjB,QAAQkB,IAAI,CAAC,IAAI,OAAO,8BAA8B"}

package/dist/esm/eval.js

@@ -0,0 +1,25 @@
+import { fork } from 'child_process';
+import { join } from 'path';
+import { validateFilePath } from './fs';
+/**
+ * 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 async function evalBundle(bundlePath) {
+    await validateFilePath(bundlePath);
+    return new Promise((resolve, reject)=>{
+        const worker = fork(join(__dirname, 'eval-worker.js'), [
+            bundlePath
+        ]);
+        worker.on('exit', (exitCode)=>{
+            if (exitCode === 0) {
+                return resolve(null);
+            }
+            return reject(new Error(`Process exited with non-zero exit code: ${exitCode}`));
+        });
+    });
+}
+
+//# sourceMappingURL=eval.js.map

package/dist/esm/eval.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/eval.ts"],"sourcesContent":["import { fork } from 'child_process';\nimport { join } from 'path';\n\nimport { validateFilePath } from './fs';\n\n/**\n * Spawn a new process to run the provided bundle in.\n *\n * @param bundlePath - The path to the bundle to run.\n * @returns `null` if the worker ran successfully.\n * @throws If the worker failed to run successfully.\n */\nexport async function evalBundle(bundlePath: string): Promise<null> {\n  await validateFilePath(bundlePath);\n\n  return new Promise((resolve, reject) => {\n    const worker = fork(join(__dirname, 'eval-worker.js'), [bundlePath]);\n\n    worker.on('exit', (exitCode: number) => {\n      if (exitCode === 0) {\n        return resolve(null);\n      }\n\n      return reject(\n        new Error(`Process exited with non-zero exit code: ${exitCode}`),\n      );\n    });\n  });\n}\n"],"names":["fork","join","validateFilePath","evalBundle","bundlePath","Promise","resolve","reject","worker","__dirname","on","exitCode","Error"],"mappings":"AAAA,SAASA,IAAI,QAAQ,gBAAgB;AACrC,SAASC,IAAI,QAAQ,OAAO;AAE5B,SAASC,gBAAgB,QAAQ,OAAO;AAExC;;;;;;CAMC,GACD,OAAO,eAAeC,WAAWC,UAAkB;IACjD,MAAMF,iBAAiBE;IAEvB,OAAO,IAAIC,QAAQ,CAACC,SAASC;QAC3B,MAAMC,SAASR,KAAKC,KAAKQ,WAAW,mBAAmB;YAACL;SAAW;QAEnEI,OAAOE,EAAE,CAAC,QAAQ,CAACC;YACjB,IAAIA,aAAa,GAAG;gBAClB,OAAOL,QAAQ;YACjB;YAEA,OAAOC,OACL,IAAIK,MAAM,CAAC,wCAAwC,EAAED,SAAS,CAAC;QAEnE;IACF;AACF"}

package/dist/{fs.js → esm/fs.js}

@@ -1,13 +1,8 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useTemporaryFile = exports.validateDirPath = exports.validateFilePath = exports.validateOutfileName = exports.getOutfilePath = exports.readJsonFile = exports.isFile = exports.isDirectory = void 0;
-const fs_1 = require("fs");
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const virtual_file_1 = require("./virtual-file");
+import { promises as fs } from 'fs';
+import os from 'os';
+import pathUtils from 'path';
+import { parseJson } from './json';
+import { readVirtualFile } from './virtual-file';
 /**
  * Checks whether the given path string resolves to an existing directory, and
  * optionally creates the directory if it doesn't exist.
@@ -15,64 +10,57 @@ const virtual_file_1 = require("./virtual-file");
  * @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.
- */
-async function isDirectory(pathString, createDir) {
+ */ export async function isDirectory(pathString, createDir) {
     try {
-        const stats = await fs_1.promises.stat(pathString);
+        const stats = await fs.stat(pathString);
         return stats.isDirectory();
-    }
-    catch (error) {
+    } catch (error) {
         if (error.code === 'ENOENT') {
             if (!createDir) {
                 return false;
             }
-            await fs_1.promises.mkdir(pathString, { recursive: true });
+            await fs.mkdir(pathString, {
+                recursive: true
+            });
             return true;
         }
         return false;
     }
 }
-exports.isDirectory = isDirectory;
 /**
  * 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.
- */
-async function isFile(pathString) {
+ */ export async function isFile(pathString) {
     try {
-        const stats = await fs_1.promises.stat(pathString);
+        const stats = await fs.stat(pathString);
         return stats.isFile();
-    }
-    catch (error) {
+    } catch (error) {
         return false;
     }
 }
-exports.isFile = isFile;
 /**
  * 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.
- */
-async function readJsonFile(pathString) {
+ */ export async function readJsonFile(pathString) {
     if (!pathString.endsWith('.json')) {
         throw new Error('The specified file must be a ".json" file.');
     }
     let file;
     try {
-        file = await (0, virtual_file_1.readVirtualFile)(pathString, 'utf8');
-    }
-    catch (error) {
+        file = await readVirtualFile(pathString, 'utf8');
+    } catch (error) {
         if (error.code === 'ENOENT') {
             throw new Error(`Could not find '${pathString}'. Please ensure that the file exists.`);
         }
         throw error;
     }
-    file.result = JSON.parse(file.toString());
+    file.result = parseJson(file.toString());
     return file;
 }
-exports.readJsonFile = readJsonFile;
 /**
  * Gets the complete out file path from an output file name and parent
  * directory path.
@@ -80,11 +68,9 @@ exports.readJsonFile = readJsonFile;
  * @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.
- */
-function getOutfilePath(outDir, outFileName) {
-    return path_1.default.join(outDir, outFileName || 'bundle.js');
+ */ export function getOutfilePath(outDir, outFileName) {
+    return pathUtils.join(outDir, outFileName || 'bundle.js');
 }
-exports.getOutfilePath = getOutfilePath;
 /**
  * Ensures that the outfile name is just a `.js` file name.
  * Throws on validation failure.
@@ -92,31 +78,25 @@ exports.getOutfilePath = getOutfilePath;
  * @param filename - The file name to validate.
  * @returns `true` if validation succeeded.
  * @throws If the file name is invalid.
- */
-function validateOutfileName(filename) {
-    if (!filename.endsWith('.js') ||
-        filename === '.js' ||
-        path_1.default.basename(filename) !== filename) {
+ */ export function validateOutfileName(filename) {
+    if (!filename.endsWith('.js') || filename === '.js' || pathUtils.basename(filename) !== filename) {
         throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);
     }
     return true;
 }
-exports.validateOutfileName = validateOutfileName;
 /**
  * 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.
- */
-async function validateFilePath(filePath) {
+ */ export async function validateFilePath(filePath) {
     const exists = await isFile(filePath);
     if (!exists) {
         throw new Error(`Invalid params: '${filePath}' is not a file or does not exist.`);
     }
     return true;
 }
-exports.validateFilePath = validateFilePath;
 /**
  * Validates a directory path. Throws on validation failure.
  *
@@ -124,15 +104,13 @@ exports.validateFilePath = validateFilePath;
  * @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.
- */
-async function validateDirPath(dirPath, createDir) {
+ */ export async function validateDirPath(dirPath, createDir) {
     const exists = await isDirectory(dirPath, createDir);
     if (!exists) {
         throw new Error(`Invalid params: '${dirPath}' is not a directory or could not be created.`);
     }
     return true;
 }
-exports.validateDirPath = validateDirPath;
 /**
  * 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.
@@ -140,19 +118,19 @@ exports.validateDirPath = validateDirPath;
  * @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.
- */
-async function useTemporaryFile(fileName, fileContents, fn) {
-    const filePath = path_1.default.join(os_1.default.tmpdir(), fileName);
-    await fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
-    await fs_1.promises.writeFile(filePath, fileContents);
+ */ export async function useTemporaryFile(fileName, fileContents, fn) {
+    const filePath = pathUtils.join(os.tmpdir(), fileName);
+    await fs.mkdir(pathUtils.dirname(filePath), {
+        recursive: true
+    });
+    await fs.writeFile(filePath, fileContents);
     try {
         await fn(filePath);
-    }
-    finally {
+    } finally{
         if (await isFile(filePath)) {
-            await fs_1.promises.unlink(filePath);
+            await fs.unlink(filePath);
         }
     }
 }
-exports.useTemporaryFile = useTemporaryFile;
+
 //# sourceMappingURL=fs.js.map

package/dist/esm/fs.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/fs.ts"],"sourcesContent":["import { Json } from '@metamask/utils';\nimport { promises as fs } from 'fs';\nimport os from 'os';\nimport pathUtils from 'path';\n\nimport { parseJson } from './json';\nimport { readVirtualFile, VirtualFile } from './virtual-file';\n\n/**\n * Checks whether the given path string resolves to an existing directory, and\n * optionally creates the directory if it doesn't exist.\n *\n * @param pathString - The path string to check.\n * @param createDir - Whether to create the directory if it doesn't exist.\n * @returns Whether the given path is an existing directory.\n */\nexport async function isDirectory(\n  pathString: string,\n  createDir: boolean,\n): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isDirectory();\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      if (!createDir) {\n        return false;\n      }\n\n      await fs.mkdir(pathString, { recursive: true });\n      return true;\n    }\n\n    return false;\n  }\n}\n\n/**\n * Checks whether the given path string resolves to an existing file.\n *\n * @param pathString - The path string to check.\n * @returns Whether the given path is an existing file.\n */\nexport async function isFile(pathString: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isFile();\n  } catch (error) {\n    return false;\n  }\n}\n\n/**\n * Reads a `.json` file, parses its contents, and returns them.\n *\n * @param pathString - The path to the JSON file.\n * @returns The parsed contents of the JSON file.\n */\nexport async function readJsonFile<Type extends Json = Json>(\n  pathString: string,\n): Promise<VirtualFile<Type>> {\n  if (!pathString.endsWith('.json')) {\n    throw new Error('The specified file must be a \".json\" file.');\n  }\n\n  let file;\n  try {\n    file = await readVirtualFile(pathString, 'utf8');\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      throw new Error(\n        `Could not find '${pathString}'. Please ensure that the file exists.`,\n      );\n    }\n\n    throw error;\n  }\n  file.result = parseJson(file.toString());\n  return file as VirtualFile<Type>;\n}\n\n/**\n * Gets the complete out file path from an output file name and parent\n * directory path.\n *\n * @param outDir - The path to the out file's parent directory.\n * @param outFileName - The out file's name.\n * @returns The complete path to the out file.\n */\nexport function getOutfilePath(outDir: string, outFileName: string): string {\n  return pathUtils.join(outDir, outFileName || 'bundle.js');\n}\n\n/**\n * Ensures that the outfile name is just a `.js` file name.\n * Throws on validation failure.\n *\n * @param filename - The file name to validate.\n * @returns `true` if validation succeeded.\n * @throws If the file name is invalid.\n */\nexport function validateOutfileName(filename: string): boolean {\n  if (\n    !filename.endsWith('.js') ||\n    filename === '.js' ||\n    pathUtils.basename(filename) !== filename\n  ) {\n    throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);\n  }\n  return true;\n}\n\n/**\n * Validates a file path. Throws on validation failure.\n *\n * @param filePath - The file path to validate.\n * @returns `true` if validation succeeded.\n * @throws If the path does not resolve to a file.\n */\nexport async function validateFilePath(filePath: string): Promise<boolean> {\n  const exists = await isFile(filePath);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${filePath}' is not a file or does not exist.`,\n    );\n  }\n  return true;\n}\n\n/**\n * Validates a directory path. Throws on validation failure.\n *\n * @param dirPath - The directory path to validate.\n * @param createDir - Whether to create the directory if it doesn't exist.\n * @returns `true` if validation succeeded or the directory was created.\n * @throws If the directory does not exist or could not be created.\n */\nexport async function validateDirPath(\n  dirPath: string,\n  createDir: boolean,\n): Promise<boolean> {\n  const exists = await isDirectory(dirPath, createDir);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${dirPath}' is not a directory or could not be created.`,\n    );\n  }\n  return true;\n}\n\n/**\n * Creates a temporary file with a given name and content, writes it to disk and calls the provided function.\n * This function handles deletion of the temporary file after usage.\n *\n * @param fileName - The name of the temporary file.\n * @param fileContents - The content of the temporary file.\n * @param fn - The callback function to call when the temporary file has been created.\n */\nexport async function useTemporaryFile(\n  fileName: string,\n  fileContents: string,\n  fn: (path: string) => Promise<unknown>,\n): Promise<void> {\n  const filePath = pathUtils.join(os.tmpdir(), fileName);\n  await fs.mkdir(pathUtils.dirname(filePath), { recursive: true });\n  await fs.writeFile(filePath, fileContents);\n  try {\n    await fn(filePath);\n  } finally {\n    if (await isFile(filePath)) {\n      await fs.unlink(filePath);\n    }\n  }\n}\n"],"names":["promises","fs","os","pathUtils","parseJson","readVirtualFile","isDirectory","pathString","createDir","stats","stat","error","code","mkdir","recursive","isFile","readJsonFile","endsWith","Error","file","result","toString","getOutfilePath","outDir","outFileName","join","validateOutfileName","filename","basename","validateFilePath","filePath","exists","validateDirPath","dirPath","useTemporaryFile","fileName","fileContents","fn","tmpdir","dirname","writeFile","unlink"],"mappings":"AACA,SAASA,YAAYC,EAAE,QAAQ,KAAK;AACpC,OAAOC,QAAQ,KAAK;AACpB,OAAOC,eAAe,OAAO;AAE7B,SAASC,SAAS,QAAQ,SAAS;AACnC,SAASC,eAAe,QAAqB,iBAAiB;AAE9D;;;;;;;CAOC,GACD,OAAO,eAAeC,YACpBC,UAAkB,EAClBC,SAAkB;IAElB,IAAI;QACF,MAAMC,QAAQ,MAAMR,GAAGS,IAAI,CAACH;QAC5B,OAAOE,MAAMH,WAAW;IAC1B,EAAE,OAAOK,OAAO;QACd,IAAIA,MAAMC,IAAI,KAAK,UAAU;YAC3B,IAAI,CAACJ,WAAW;gBACd,OAAO;YACT;YAEA,MAAMP,GAAGY,KAAK,CAACN,YAAY;gBAAEO,WAAW;YAAK;YAC7C,OAAO;QACT;QAEA,OAAO;IACT;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeC,OAAOR,UAAkB;IAC7C,IAAI;QACF,MAAME,QAAQ,MAAMR,GAAGS,IAAI,CAACH;QAC5B,OAAOE,MAAMM,MAAM;IACrB,EAAE,OAAOJ,OAAO;QACd,OAAO;IACT;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeK,aACpBT,UAAkB;IAElB,IAAI,CAACA,WAAWU,QAAQ,CAAC,UAAU;QACjC,MAAM,IAAIC,MAAM;IAClB;IAEA,IAAIC;IACJ,IAAI;QACFA,OAAO,MAAMd,gBAAgBE,YAAY;IAC3C,EAAE,OAAOI,OAAO;QACd,IAAIA,MAAMC,IAAI,KAAK,UAAU;YAC3B,MAAM,IAAIM,MACR,CAAC,gBAAgB,EAAEX,WAAW,sCAAsC,CAAC;QAEzE;QAEA,MAAMI;IACR;IACAQ,KAAKC,MAAM,GAAGhB,UAAUe,KAAKE,QAAQ;IACrC,OAAOF;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,SAASG,eAAeC,MAAc,EAAEC,WAAmB;IAChE,OAAOrB,UAAUsB,IAAI,CAACF,QAAQC,eAAe;AAC/C;AAEA;;;;;;;CAOC,GACD,OAAO,SAASE,oBAAoBC,QAAgB;IAClD,IACE,CAACA,SAASV,QAAQ,CAAC,UACnBU,aAAa,SACbxB,UAAUyB,QAAQ,CAACD,cAAcA,UACjC;QACA,MAAM,IAAIT,MAAM,CAAC,sBAAsB,EAAES,SAAS,oBAAoB,CAAC;IACzE;IACA,OAAO;AACT;AAEA;;;;;;CAMC,GACD,OAAO,eAAeE,iBAAiBC,QAAgB;IACrD,MAAMC,SAAS,MAAMhB,OAAOe;IAC5B,IAAI,CAACC,QAAQ;QACX,MAAM,IAAIb,MACR,CAAC,iBAAiB,EAAEY,SAAS,kCAAkC,CAAC;IAEpE;IACA,OAAO;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeE,gBACpBC,OAAe,EACfzB,SAAkB;IAElB,MAAMuB,SAAS,MAAMzB,YAAY2B,SAASzB;IAC1C,IAAI,CAACuB,QAAQ;QACX,MAAM,IAAIb,MACR,CAAC,iBAAiB,EAAEe,QAAQ,6CAA6C,CAAC;IAE9E;IACA,OAAO;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeC,iBACpBC,QAAgB,EAChBC,YAAoB,EACpBC,EAAsC;IAEtC,MAAMP,WAAW3B,UAAUsB,IAAI,CAACvB,GAAGoC,MAAM,IAAIH;IAC7C,MAAMlC,GAAGY,KAAK,CAACV,UAAUoC,OAAO,CAACT,WAAW;QAAEhB,WAAW;IAAK;IAC9D,MAAMb,GAAGuC,SAAS,CAACV,UAAUM;IAC7B,IAAI;QACF,MAAMC,GAAGP;IACX,SAAU;QACR,IAAI,MAAMf,OAAOe,WAAW;YAC1B,MAAM7B,GAAGwC,MAAM,CAACX;QAClB;IACF;AACF"}

package/dist/esm/handlers.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=handlers.js.map

package/dist/esm/handlers.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/handlers.ts"],"sourcesContent":["import { Component } from '@metamask/snaps-ui';\nimport { Json, JsonRpcRequest } from '@metamask/utils';\n\n/**\n * The `onRpcRequest` handler. This is called whenever a JSON-RPC request is\n * made to the snap.\n *\n * @param args - The request arguments.\n * @param args.origin - The origin of the request. This can be the ID of another\n * snap, or the URL of a dapp.\n * @param args.request - The JSON-RPC request sent to the snap.\n * @returns The JSON-RPC response. This must be a JSON-serializable value.\n */\nexport type OnRpcRequestHandler<\n  Params extends Json[] | Record<string, Json> | undefined =\n    | Json[]\n    | Record<string, Json>\n    | undefined,\n> = (args: {\n  origin: string;\n  request: JsonRpcRequest<Params>;\n}) => Promise<unknown>;\n\n/**\n * The response from a snap's `onTransaction` handler.\n *\n * @property content - A custom UI component, that will be shown in MetaMask. Can be created using `@metamask/snaps-ui`.\n *\n * If the snap has no insights about the transaction, this should be `null`.\n */\nexport type OnTransactionResponse = {\n  content: Component | null;\n};\n\n/**\n * The `onTransaction` handler. This is called whenever a transaction is\n * submitted to the snap. It can return insights about the transaction, which\n * will be displayed to the user.\n *\n * @param args - The request arguments.\n * @param args.transaction - The transaction object.\n * @param args.chainId - The CAIP-2 chain ID of the network the transaction is\n * being submitted to.\n * @param args.transactionOrigin - The origin of the transaction. This is the\n * URL of the dapp that submitted the transaction.\n * @returns Insights about the transaction. See {@link OnTransactionResponse}.\n */\n// TODO: Improve type.\nexport type OnTransactionHandler = (args: {\n  transaction: { [key: string]: Json };\n  chainId: string;\n  transactionOrigin?: string;\n}) => Promise<OnTransactionResponse>;\n\n/**\n * The `onCronjob` handler. This is called on a regular interval, as defined by\n * the snap's manifest.\n *\n * @param args - The request arguments.\n * @param args.request - The JSON-RPC request sent to the snap.\n */\nexport type OnCronjobHandler<\n  Params extends Json[] | Record<string, Json> | undefined =\n    | Json[]\n    | Record<string, Json>\n    | undefined,\n> = (args: { request: JsonRpcRequest<Params> }) => Promise<unknown>;\n\n/**\n * All the function-based handlers that a snap can implement.\n */\nexport type SnapFunctionExports = {\n  onRpcRequest?: OnRpcRequestHandler;\n  onTransaction?: OnTransactionHandler;\n  onCronjob?: OnCronjobHandler;\n};\n\n/**\n * All handlers that a snap can implement.\n */\nexport type SnapExports = SnapFunctionExports;\n"],"names":[],"mappings":"AAAA,WAgF8C"}

package/dist/esm/icon.js

@@ -0,0 +1,11 @@
+import { assert } from '@metamask/utils';
+import isSvg from 'is-svg';
+export const SVG_MAX_BYTE_SIZE = 100000;
+export const SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(SVG_MAX_BYTE_SIZE / 1000)}kb`;
+export const assertIsSnapIcon = (icon)=>{
+    assert(icon.path.endsWith('.svg'), 'Expected snap icon to end in ".svg".');
+    assert(Buffer.byteLength(icon.value, 'utf8') <= SVG_MAX_BYTE_SIZE, `The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`);
+    assert(isSvg(icon.toString()), 'Snap icon must be a valid SVG.');
+};
+
+//# sourceMappingURL=icon.js.map

package/dist/esm/icon.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/icon.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\nimport isSvg from 'is-svg';\n\nimport { VirtualFile } from './virtual-file';\n\nexport const SVG_MAX_BYTE_SIZE = 100_000;\nexport const SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(\n  SVG_MAX_BYTE_SIZE / 1000,\n)}kb`;\n\nexport const assertIsSnapIcon = (icon: VirtualFile) => {\n  assert(icon.path.endsWith('.svg'), 'Expected snap icon to end in \".svg\".');\n\n  assert(\n    Buffer.byteLength(icon.value, 'utf8') <= SVG_MAX_BYTE_SIZE,\n    `The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`,\n  );\n\n  assert(isSvg(icon.toString()), 'Snap icon must be a valid SVG.');\n};\n"],"names":["assert","isSvg","SVG_MAX_BYTE_SIZE","SVG_MAX_BYTE_SIZE_TEXT","Math","floor","assertIsSnapIcon","icon","path","endsWith","Buffer","byteLength","value","toString"],"mappings":"AAAA,SAASA,MAAM,QAAQ,kBAAkB;AACzC,OAAOC,WAAW,SAAS;AAI3B,OAAO,MAAMC,oBAAoB,OAAQ;AACzC,OAAO,MAAMC,yBAAyB,CAAC,EAAEC,KAAKC,KAAK,CACjDH,oBAAoB,MACpB,EAAE,CAAC,CAAC;AAEN,OAAO,MAAMI,mBAAmB,CAACC;IAC/BP,OAAOO,KAAKC,IAAI,CAACC,QAAQ,CAAC,SAAS;IAEnCT,OACEU,OAAOC,UAAU,CAACJ,KAAKK,KAAK,EAAE,WAAWV,mBACzC,CAAC,mDAAmD,EAAEC,uBAAuB,CAAC,CAAC;IAGjFH,OAAOC,MAAMM,KAAKM,QAAQ,KAAK;AACjC,EAAE"}

package/dist/esm/iframe.js

@@ -0,0 +1,49 @@
+/**
+ * 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 async function createWindow(uri, id, sandbox = true) {
+    return await new Promise((resolve, reject)=>{
+        const iframe = document.createElement('iframe');
+        // The order of operations appears to matter for everything except this
+        // attribute. We may as well set it here.
+        iframe.setAttribute('id', id);
+        iframe.setAttribute('data-testid', 'snaps-iframe');
+        if (sandbox) {
+            // For the sandbox property to have any effect it needs to be set before the iframe is appended.
+            // We apply this property as a principle of least authority (POLA)
+            // measure.
+            // Ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox
+            iframe.setAttribute('sandbox', 'allow-scripts');
+        }
+        // In the past, we've had problems that appear to be symptomatic of the
+        // iframe firing the `load` event before its scripts are actually loaded,
+        // which has prevented snaps from executing properly. Therefore, we set
+        // the `src` attribute and append the iframe to the DOM before attaching
+        // the `load` listener.
+        //
+        // `load` should only fire when "all dependent resources" have been
+        // loaded, which includes scripts.
+        //
+        // MDN article for `load` event: https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event
+        // Re: `load` firing twice: https://stackoverflow.com/questions/10781880/dynamically-created-iframe-triggers-onload-event-twice/15880489#15880489
+        iframe.setAttribute('src', uri);
+        document.body.appendChild(iframe);
+        iframe.addEventListener('load', ()=>{
+            if (iframe.contentWindow) {
+                resolve(iframe.contentWindow);
+            } else {
+                // We don't know of a case when this would happen, but better to fail
+                // fast if it does.
+                reject(new Error(`iframe.contentWindow not present on load for job "${id}".`));
+            }
+        });
+    });
+}
+
+//# sourceMappingURL=iframe.js.map

package/dist/esm/iframe.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/iframe.ts"],"sourcesContent":["/**\n * Creates the iframe to be used as the execution environment. This may run\n * forever if the iframe never loads, but the promise should be wrapped in\n * an initialization timeout in the SnapController.\n *\n * @param uri - The iframe URI.\n * @param id - The ID to assign to the iframe.\n * @param sandbox - Whether to enable the sandbox attribute.\n * @returns A promise that resolves to the contentWindow of the iframe.\n */\nexport async function createWindow(\n  uri: string,\n  id: string,\n  sandbox = true,\n): Promise<Window> {\n  return await new Promise((resolve, reject) => {\n    const iframe = document.createElement('iframe');\n    // The order of operations appears to matter for everything except this\n    // attribute. We may as well set it here.\n    iframe.setAttribute('id', id);\n    iframe.setAttribute('data-testid', 'snaps-iframe');\n\n    if (sandbox) {\n      // For the sandbox property to have any effect it needs to be set before the iframe is appended.\n      // We apply this property as a principle of least authority (POLA)\n      // measure.\n      // Ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox\n      iframe.setAttribute('sandbox', 'allow-scripts');\n    }\n\n    // In the past, we've had problems that appear to be symptomatic of the\n    // iframe firing the `load` event before its scripts are actually loaded,\n    // which has prevented snaps from executing properly. Therefore, we set\n    // the `src` attribute and append the iframe to the DOM before attaching\n    // the `load` listener.\n    //\n    // `load` should only fire when \"all dependent resources\" have been\n    // loaded, which includes scripts.\n    //\n    // MDN article for `load` event: https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event\n    // Re: `load` firing twice: https://stackoverflow.com/questions/10781880/dynamically-created-iframe-triggers-onload-event-twice/15880489#15880489\n    iframe.setAttribute('src', uri);\n    document.body.appendChild(iframe);\n\n    iframe.addEventListener('load', () => {\n      if (iframe.contentWindow) {\n        resolve(iframe.contentWindow);\n      } else {\n        // We don't know of a case when this would happen, but better to fail\n        // fast if it does.\n        reject(\n          new Error(\n            `iframe.contentWindow not present on load for job \"${id}\".`,\n          ),\n        );\n      }\n    });\n  });\n}\n"],"names":["createWindow","uri","id","sandbox","Promise","resolve","reject","iframe","document","createElement","setAttribute","body","appendChild","addEventListener","contentWindow","Error"],"mappings":"AAAA;;;;;;;;;CASC,GACD,OAAO,eAAeA,aACpBC,GAAW,EACXC,EAAU,EACVC,UAAU,IAAI;IAEd,OAAO,MAAM,IAAIC,QAAQ,CAACC,SAASC;QACjC,MAAMC,SAASC,SAASC,aAAa,CAAC;QACtC,uEAAuE;QACvE,yCAAyC;QACzCF,OAAOG,YAAY,CAAC,MAAMR;QAC1BK,OAAOG,YAAY,CAAC,eAAe;QAEnC,IAAIP,SAAS;YACX,gGAAgG;YAChG,kEAAkE;YAClE,WAAW;YACX,qFAAqF;YACrFI,OAAOG,YAAY,CAAC,WAAW;QACjC;QAEA,uEAAuE;QACvE,yEAAyE;QACzE,uEAAuE;QACvE,wEAAwE;QACxE,uBAAuB;QACvB,EAAE;QACF,mEAAmE;QACnE,kCAAkC;QAClC,EAAE;QACF,mGAAmG;QACnG,iJAAiJ;QACjJH,OAAOG,YAAY,CAAC,OAAOT;QAC3BO,SAASG,IAAI,CAACC,WAAW,CAACL;QAE1BA,OAAOM,gBAAgB,CAAC,QAAQ;YAC9B,IAAIN,OAAOO,aAAa,EAAE;gBACxBT,QAAQE,OAAOO,aAAa;YAC9B,OAAO;gBACL,qEAAqE;gBACrE,mBAAmB;gBACnBR,OACE,IAAIS,MACF,CAAC,kDAAkD,EAAEb,GAAG,EAAE,CAAC;YAGjE;QACF;IACF;AACF"}

package/dist/esm/index.browser.js

@@ -0,0 +1,23 @@
+export * from './array';
+export * from './caveats';
+export * from './checksum';
+export * from './cronjob';
+export * from './deep-clone';
+export * from './default-endowments';
+export * from './entropy';
+export * from './enum';
+export * from './handlers';
+export * from './iframe';
+export * from './json';
+export * from './json-rpc';
+export * from './logging';
+export * from './manifest/index.browser';
+export * from './namespace';
+export * from './path';
+export * from './snaps';
+export * from './types';
+export * from './validation';
+export * from './versions';
+export * from './virtual-file/index.browser';
+
+//# sourceMappingURL=index.browser.js.map

package/dist/esm/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.browser.ts"],"sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './checksum';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './enum';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest/index.browser';\nexport * from './namespace';\nexport * from './path';\nexport * from './snaps';\nexport * from './types';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file/index.browser';\n"],"names":[],"mappings":"AAAA,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,eAAe;AAC7B,cAAc,uBAAuB;AACrC,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,2BAA2B;AACzC,cAAc,cAAc;AAC5B,cAAc,SAAS;AACvB,cAAc,UAAU;AACxB,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,aAAa;AAC3B,cAAc,+BAA+B"}

package/dist/esm/index.executionenv.js

@@ -0,0 +1,7 @@
+// Special entrypoint for execution environments for bundle sizing reasons
+export * from './handlers';
+export * from './logging';
+export * from './namespace';
+export * from './types';
+
+//# sourceMappingURL=index.executionenv.js.map

package/dist/esm/index.executionenv.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.executionenv.ts"],"sourcesContent":["// Special entrypoint for execution environments for bundle sizing reasons\nexport * from './handlers';\nexport * from './logging';\nexport * from './namespace';\nexport * from './types';\n"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,cAAc;AAC5B,cAAc,UAAU"}

package/dist/esm/index.js

@@ -0,0 +1,28 @@
+export * from './array';
+export * from './caveats';
+export * from './cronjob';
+export * from './checksum';
+export * from './deep-clone';
+export * from './default-endowments';
+export * from './entropy';
+export * from './enum';
+export * from './eval';
+export * from './fs';
+export * from './handlers';
+export * from './iframe';
+export * from './json';
+export * from './json-rpc';
+export * from './logging';
+export * from './manifest';
+export * from './mock';
+export * from './namespace';
+export * from './npm';
+export * from './path';
+export * from './post-process';
+export * from './snaps';
+export * from './types';
+export * from './validation';
+export * from './versions';
+export * from './virtual-file';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './cronjob';\nexport * from './checksum';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './enum';\nexport * from './eval';\nexport * from './fs';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest';\nexport * from './mock';\nexport * from './namespace';\nexport * from './npm';\nexport * from './path';\nexport * from './post-process';\nexport * from './snaps';\nexport * from './types';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file';\n"],"names":[],"mappings":"AAAA,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,cAAc,uBAAuB;AACrC,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,SAAS;AACvB,cAAc,OAAO;AACrB,cAAc,aAAa;AAC3B,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,SAAS;AACvB,cAAc,cAAc;AAC5B,cAAc,QAAQ;AACtB,cAAc,SAAS;AACvB,cAAc,iBAAiB;AAC/B,cAAc,UAAU;AACxB,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,aAAa;AAC3B,cAAc,iBAAiB"}

package/dist/esm/json-rpc.js

@@ -0,0 +1,39 @@
+import { isJsonRpcFailure, isJsonRpcSuccess, assertStruct } from '@metamask/utils';
+import { boolean, object, optional, refine } from 'superstruct';
+export const RpcOriginsStruct = refine(object({
+    dapps: optional(boolean()),
+    snaps: optional(boolean())
+}), 'RPC origins', (value)=>{
+    if (!Object.values(value).some(Boolean)) {
+        throw new Error('Must specify at least one JSON-RPC origin');
+    }
+    return true;
+});
+/**
+ * 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 function assertIsRpcOrigins(value, // eslint-disable-next-line @typescript-eslint/naming-convention
+ErrorWrapper) {
+    assertStruct(value, RpcOriginsStruct, 'Invalid JSON-RPC origins', ErrorWrapper);
+}
+/**
+ * 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 function assertIsJsonRpcSuccess(value) {
+    if (!isJsonRpcSuccess(value)) {
+        if (isJsonRpcFailure(value)) {
+            throw new Error(`JSON-RPC request failed: ${value.error.message}`);
+        }
+        throw new Error('Invalid JSON-RPC response.');
+    }
+}
+
+//# sourceMappingURL=json-rpc.js.map

package/dist/esm/json-rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/json-rpc.ts"],"sourcesContent":["import {\n  isJsonRpcFailure,\n  isJsonRpcSuccess,\n  Json,\n  JsonRpcSuccess,\n  AssertionErrorConstructor,\n  assertStruct,\n} from '@metamask/utils';\nimport { boolean, Infer, object, optional, refine } from 'superstruct';\n\nexport const RpcOriginsStruct = refine(\n  object({\n    dapps: optional(boolean()),\n    snaps: optional(boolean()),\n  }),\n  'RPC origins',\n  (value) => {\n    if (!Object.values(value).some(Boolean)) {\n      throw new Error('Must specify at least one JSON-RPC origin');\n    }\n\n    return true;\n  },\n);\n\nexport type RpcOrigins = Infer<typeof RpcOriginsStruct>;\n\n/**\n * Asserts that the given value is a valid {@link RpcOrigins} object.\n *\n * @param value - The value to assert.\n * @param ErrorWrapper - An optional error wrapper to use. Defaults to\n * {@link AssertionError}.\n * @throws If the value is not a valid {@link RpcOrigins} object.\n */\nexport function assertIsRpcOrigins(\n  value: unknown,\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is RpcOrigins {\n  assertStruct(\n    value,\n    RpcOriginsStruct,\n    'Invalid JSON-RPC origins',\n    ErrorWrapper,\n  );\n}\n\n/**\n * Assert that the given value is a successful JSON-RPC response. If the value\n * is not a success response, an error is thrown. If the value is an JSON-RPC\n * error, the error message is included in the thrown error.\n *\n * @param value - The value to check.\n * @throws If the value is not a JSON-RPC success response.\n */\nexport function assertIsJsonRpcSuccess(\n  value: unknown,\n): asserts value is JsonRpcSuccess<Json> {\n  if (!isJsonRpcSuccess(value)) {\n    if (isJsonRpcFailure(value)) {\n      throw new Error(`JSON-RPC request failed: ${value.error.message}`);\n    }\n\n    throw new Error('Invalid JSON-RPC response.');\n  }\n}\n"],"names":["isJsonRpcFailure","isJsonRpcSuccess","assertStruct","boolean","object","optional","refine","RpcOriginsStruct","dapps","snaps","value","Object","values","some","Boolean","Error","assertIsRpcOrigins","ErrorWrapper","assertIsJsonRpcSuccess","error","message"],"mappings":"AAAA,SACEA,gBAAgB,EAChBC,gBAAgB,EAIhBC,YAAY,QACP,kBAAkB;AACzB,SAASC,OAAO,EAASC,MAAM,EAAEC,QAAQ,EAAEC,MAAM,QAAQ,cAAc;AAEvE,OAAO,MAAMC,mBAAmBD,OAC9BF,OAAO;IACLI,OAAOH,SAASF;IAChBM,OAAOJ,SAASF;AAClB,IACA,eACA,CAACO;IACC,IAAI,CAACC,OAAOC,MAAM,CAACF,OAAOG,IAAI,CAACC,UAAU;QACvC,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;AACT,GACA;AAIF;;;;;;;CAOC,GACD,OAAO,SAASC,mBACdN,KAAc,EACd,gEAAgE;AAChEO,YAAwC;IAExCf,aACEQ,OACAH,kBACA,4BACAU;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,uBACdR,KAAc;IAEd,IAAI,CAACT,iBAAiBS,QAAQ;QAC5B,IAAIV,iBAAiBU,QAAQ;YAC3B,MAAM,IAAIK,MAAM,CAAC,yBAAyB,EAAEL,MAAMS,KAAK,CAACC,OAAO,CAAC,CAAC;QACnE;QAEA,MAAM,IAAIL,MAAM;IAClB;AACF"}

package/dist/esm/json.js

@@ -0,0 +1,17 @@
+import { getSafeJson } from '@metamask/utils';
+// TODO: Upstream this to @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 function parseJson(json) {
+    return getSafeJson(JSON.parse(json));
+}
+
+//# sourceMappingURL=json.js.map

package/dist/esm/json.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/json.ts"],"sourcesContent":["import { getSafeJson, Json } from '@metamask/utils';\n\n// TODO: Upstream this to @metamask/utils\n\n/**\n * Parse JSON safely.\n *\n * Does multiple kinds of validation and strips unwanted properties like\n * `__proto__` and `constructor`.\n *\n * @param json - A JSON string to be parsed.\n * @returns The parsed JSON object.\n * @template Type - The type of the JSON object. The type is not actually\n * checked, but it is used to infer the return type.\n */\nexport function parseJson<Type extends Json = Json>(json: string) {\n  return getSafeJson<Type>(JSON.parse(json));\n}\n"],"names":["getSafeJson","parseJson","json","JSON","parse"],"mappings":"AAAA,SAASA,WAAW,QAAc,kBAAkB;AAEpD,yCAAyC;AAEzC;;;;;;;;;;CAUC,GACD,OAAO,SAASC,UAAoCC,IAAY;IAC9D,OAAOF,YAAkBG,KAAKC,KAAK,CAACF;AACtC"}