@metamask/snaps-utils 8.0.1 → 8.1.0

package/dist/eval.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"eval.mjs","sourceRoot":"","sources":["../src/eval.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,wBAAwB;AACzC,OAAO,EAAE,IAAI,EAAE,sBAAsB;AACrC,OAAO,EAAE,IAAI,EAAE,aAAa;AAE5B,OAAO,EAAE,gBAAgB,EAAE,iBAAa;AAOxC,MAAM,OAAO,aAAc,SAAQ,KAAK;IAGtC,YAAY,OAAe,EAAE,MAAkB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,UAAkB;IACjD,MAAM,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAEnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE;YACpE,oEAAoE;YACpE,qDAAqD;YACrD,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAErD,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;YACxC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;YACxC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAgB,EAAE,EAAE;YACrC,MAAM,MAAM,GAAG;gBACb,MAAM;gBACN,MAAM;aACP,CAAC;YAEF,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;gBACnB,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;YAED,OAAO,MAAM,CACX,IAAI,aAAa,CACf,2CAA2C,QAAQ,GAAG,EACtD,MAAM,CACP,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { assert } from '@metamask/utils';\nimport { fork } from 'child_process';\nimport { join } from 'path';\n\nimport { validateFilePath } from './fs';\n\nexport type EvalOutput = {\n  stdout: string;\n  stderr: string;\n};\n\nexport class SnapEvalError extends Error {\n  readonly output: EvalOutput;\n\n  constructor(message: string, output: EvalOutput) {\n    super(message);\n\n    this.name = 'SnapEvalError';\n    this.output = output;\n  }\n}\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<EvalOutput> {\n  await validateFilePath(bundlePath);\n\n  return new Promise((resolve, reject) => {\n    const worker = fork(join(__dirname, 'eval-worker.cjs'), [bundlePath], {\n      // To avoid printing the output of the worker to the console, we set\n      // `stdio` to `pipe` and handle the output ourselves.\n      stdio: 'pipe',\n    });\n\n    let stdout = '';\n    let stderr = '';\n\n    assert(worker.stdout, '`stdout` should be defined.');\n    assert(worker.stderr, '`stderr` should be defined.');\n\n    worker.stdout.on('data', (data: Buffer) => {\n      stdout += data.toString();\n    });\n\n    worker.stderr.on('data', (data: Buffer) => {\n      stderr += data.toString();\n    });\n\n    worker.on('exit', (exitCode: number) => {\n      const output = {\n        stdout,\n        stderr,\n      };\n\n      if (exitCode === 0) {\n        return resolve(output);\n      }\n\n      return reject(\n        new SnapEvalError(\n          `Process exited with non-zero exit code: ${exitCode}.`,\n          output,\n        ),\n      );\n    });\n  });\n}\n"]}

package/dist/fs.cjs

@@ -0,0 +1,159 @@
+"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 json_1 = require("./json.cjs");
+const node_1 = require("./virtual-file/node.cjs");
+/**
+ * Checks whether the given path string resolves to an existing directory, and
+ * optionally creates the directory if it doesn't exist.
+ *
+ * @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) {
+    try {
+        const stats = await fs_1.promises.stat(pathString);
+        return stats.isDirectory();
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            if (!createDir) {
+                return false;
+            }
+            await fs_1.promises.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) {
+    try {
+        const stats = await fs_1.promises.stat(pathString);
+        return stats.isFile();
+    }
+    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) {
+    if (!pathString.endsWith('.json')) {
+        throw new Error('The specified file must be a ".json" file.');
+    }
+    let file;
+    try {
+        file = await (0, node_1.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 = (0, json_1.parseJson)(file.toString());
+    return file;
+}
+exports.readJsonFile = readJsonFile;
+/**
+ * Gets the complete out file path from an output file name and parent
+ * directory path.
+ *
+ * @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');
+}
+exports.getOutfilePath = getOutfilePath;
+/**
+ * Ensures that the outfile name is just a `.js` file name.
+ * Throws on validation failure.
+ *
+ * @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) {
+        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) {
+    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.
+ *
+ * @param dirPath - The directory path to validate.
+ * @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) {
+    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.
+ *
+ * @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);
+    try {
+        await fn(filePath);
+    }
+    finally {
+        if (await isFile(filePath)) {
+            await fs_1.promises.unlink(filePath);
+        }
+    }
+}
+exports.useTemporaryFile = useTemporaryFile;
+//# sourceMappingURL=fs.cjs.map

package/dist/fs.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.cjs","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":";;;;;;AACA,2BAAoC;AACpC,4CAAoB;AACpB,gDAA6B;AAE7B,qCAAmC;AAEnC,kDAAsD;AAEtD;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAnBD,kCAmBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAPD,wBAOC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAChC,UAAkB;IAElB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,IAAI,CAAC;IACT,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,IAAA,sBAAe,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,mBAAmB,UAAU,wCAAwC,CACtE,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;IACD,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzC,OAAO,IAAyB,CAAC;AACnC,CAAC;AArBD,oCAqBC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,MAAc,EAAE,WAAmB;IAChE,OAAO,cAAS,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,WAAW,CAAC,CAAC;AAC5D,CAAC;AAFD,wCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,QAAQ,KAAK,KAAK;QAClB,cAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,QAAQ,EACzC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,sBAAsB,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,oCAAoC,CACjE,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,SAAkB;IAElB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,+CAA+C,CAC3E,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,0CAWC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,gBAAgB,CACpC,QAAgB,EAChB,YAAoB,EACpB,EAAsC;IAEtC,MAAM,QAAQ,GAAG,cAAS,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC;IACvD,MAAM,aAAE,CAAC,KAAK,CAAC,cAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,MAAM,aAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC3C,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC;YAAS,CAAC;QACT,IAAI,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,MAAM,aAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;AACH,CAAC;AAfD,4CAeC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { promises as fs } from 'fs';\nimport os from 'os';\nimport pathUtils from 'path';\n\nimport { parseJson } from './json';\nimport type { VirtualFile } from './virtual-file';\nimport { readVirtualFile } from './virtual-file/node';\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"]}

package/dist/fs.d.cts

@@ -0,0 +1,70 @@
+import type { Json } from "@metamask/utils";
+import type { VirtualFile } from "./virtual-file/index.cjs";
+/**
+ * Checks whether the given path string resolves to an existing directory, and
+ * optionally creates the directory if it doesn't exist.
+ *
+ * @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.
+ */
+export declare function isDirectory(pathString: string, createDir: boolean): Promise<boolean>;
+/**
+ * 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.
+ */
+export declare function isFile(pathString: string): Promise<boolean>;
+/**
+ * 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.
+ */
+export declare function readJsonFile<Type extends Json = Json>(pathString: string): Promise<VirtualFile<Type>>;
+/**
+ * Gets the complete out file path from an output file name and parent
+ * directory path.
+ *
+ * @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.
+ */
+export declare function getOutfilePath(outDir: string, outFileName: string): string;
+/**
+ * Ensures that the outfile name is just a `.js` file name.
+ * Throws on validation failure.
+ *
+ * @param filename - The file name to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the file name is invalid.
+ */
+export declare function validateOutfileName(filename: string): boolean;
+/**
+ * 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.
+ */
+export declare function validateFilePath(filePath: string): Promise<boolean>;
+/**
+ * Validates a directory path. Throws on validation failure.
+ *
+ * @param dirPath - The directory path to validate.
+ * @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.
+ */
+export declare function validateDirPath(dirPath: string, createDir: boolean): Promise<boolean>;
+/**
+ * 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.
+ *
+ * @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.
+ */
+export declare function useTemporaryFile(fileName: string, fileContents: string, fn: (path: string) => Promise<unknown>): Promise<void>;
+//# sourceMappingURL=fs.d.cts.map

package/dist/fs.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.cts","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAM5C,OAAO,KAAK,EAAE,WAAW,EAAE,iCAAuB;AAGlD;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAC/B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,OAAO,CAAC,CAgBlB;AAED;;;;;GAKG;AACH,wBAAsB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAOjE;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,IAAI,SAAS,IAAI,GAAG,IAAI,EACzD,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAmB5B;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAE1E;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAS7D;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAQzE;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,OAAO,CAAC,CAQlB;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC,CAWf"}

package/dist/fs.d.mts

@@ -0,0 +1,70 @@
+import type { Json } from "@metamask/utils";
+import type { VirtualFile } from "./virtual-file/index.mjs";
+/**
+ * Checks whether the given path string resolves to an existing directory, and
+ * optionally creates the directory if it doesn't exist.
+ *
+ * @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.
+ */
+export declare function isDirectory(pathString: string, createDir: boolean): Promise<boolean>;
+/**
+ * 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.
+ */
+export declare function isFile(pathString: string): Promise<boolean>;
+/**
+ * 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.
+ */
+export declare function readJsonFile<Type extends Json = Json>(pathString: string): Promise<VirtualFile<Type>>;
+/**
+ * Gets the complete out file path from an output file name and parent
+ * directory path.
+ *
+ * @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.
+ */
+export declare function getOutfilePath(outDir: string, outFileName: string): string;
+/**
+ * Ensures that the outfile name is just a `.js` file name.
+ * Throws on validation failure.
+ *
+ * @param filename - The file name to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the file name is invalid.
+ */
+export declare function validateOutfileName(filename: string): boolean;
+/**
+ * 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.
+ */
+export declare function validateFilePath(filePath: string): Promise<boolean>;
+/**
+ * Validates a directory path. Throws on validation failure.
+ *
+ * @param dirPath - The directory path to validate.
+ * @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.
+ */
+export declare function validateDirPath(dirPath: string, createDir: boolean): Promise<boolean>;
+/**
+ * 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.
+ *
+ * @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.
+ */
+export declare function useTemporaryFile(fileName: string, fileContents: string, fn: (path: string) => Promise<unknown>): Promise<void>;
+//# sourceMappingURL=fs.d.mts.map

package/dist/fs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.mts","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAM5C,OAAO,KAAK,EAAE,WAAW,EAAE,iCAAuB;AAGlD;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAC/B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,OAAO,CAAC,CAgBlB;AAED;;;;;GAKG;AACH,wBAAsB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAOjE;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,IAAI,SAAS,IAAI,GAAG,IAAI,EACzD,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAmB5B;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAE1E;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAS7D;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAQzE;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,OAAO,CAAC,CAQlB;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC,CAWf"}

package/dist/fs.mjs

@@ -1,28 +1,145 @@
-import {
-  getOutfilePath,
-  isDirectory,
-  isFile,
-  readJsonFile,
-  useTemporaryFile,
-  validateDirPath,
-  validateFilePath,
-  validateOutfileName
-} from "./chunk-X3UZCGO5.mjs";
-import "./chunk-RAZ7XG4Z.mjs";
-import "./chunk-XZNJFDBF.mjs";
-import "./chunk-HYF7Q6VY.mjs";
-import "./chunk-UNNEBOL4.mjs";
-import "./chunk-DE22V5AO.mjs";
-import "./chunk-Z2JQNSVL.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  getOutfilePath,
-  isDirectory,
-  isFile,
-  readJsonFile,
-  useTemporaryFile,
-  validateDirPath,
-  validateFilePath,
-  validateOutfileName
-};
+import { promises as fs } from "fs";
+import os from "os";
+import pathUtils from "path";
+import { parseJson } from "./json.mjs";
+import { readVirtualFile } from "./virtual-file/node.mjs";
+/**
+ * Checks whether the given path string resolves to an existing directory, and
+ * optionally creates the directory if it doesn't exist.
+ *
+ * @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.
+ */
+export async function isDirectory(pathString, createDir) {
+    try {
+        const stats = await fs.stat(pathString);
+        return stats.isDirectory();
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            if (!createDir) {
+                return false;
+            }
+            await fs.mkdir(pathString, { recursive: true });
+            return true;
+        }
+        return false;
+    }
+}
+/**
+ * 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.
+ */
+export async function isFile(pathString) {
+    try {
+        const stats = await fs.stat(pathString);
+        return stats.isFile();
+    }
+    catch (error) {
+        return false;
+    }
+}
+/**
+ * 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.
+ */
+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 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 = parseJson(file.toString());
+    return file;
+}
+/**
+ * Gets the complete out file path from an output file name and parent
+ * directory path.
+ *
+ * @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.
+ */
+export function getOutfilePath(outDir, outFileName) {
+    return pathUtils.join(outDir, outFileName || 'bundle.js');
+}
+/**
+ * Ensures that the outfile name is just a `.js` file name.
+ * Throws on validation failure.
+ *
+ * @param filename - The file name to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the file name is invalid.
+ */
+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;
+}
+/**
+ * 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.
+ */
+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;
+}
+/**
+ * Validates a directory path. Throws on validation failure.
+ *
+ * @param dirPath - The directory path to validate.
+ * @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.
+ */
+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;
+}
+/**
+ * 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.
+ *
+ * @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.
+ */
+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 {
+        if (await isFile(filePath)) {
+            await fs.unlink(filePath);
+        }
+    }
+}
 //# sourceMappingURL=fs.mjs.map

package/dist/fs.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"fs.mjs","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,WAAW;AACpC,OAAO,EAAE,WAAW;AACpB,OAAO,SAAS,aAAa;AAE7B,OAAO,EAAE,SAAS,EAAE,mBAAe;AAEnC,OAAO,EAAE,eAAe,EAAE,gCAA4B;AAEtD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,UAAkB;IAElB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,IAAI,CAAC;IACT,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,mBAAmB,UAAU,wCAAwC,CACtE,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;IACD,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzC,OAAO,IAAyB,CAAC;AACnC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,WAAmB;IAChE,OAAO,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,WAAW,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAgB;IAClD,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,QAAQ,KAAK,KAAK;QAClB,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,QAAQ,EACzC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,sBAAsB,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,oCAAoC,CACjE,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,SAAkB;IAElB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,+CAA+C,CAC3E,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,QAAgB,EAChB,YAAoB,EACpB,EAAsC;IAEtC,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC;IACvD,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC3C,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC;YAAS,CAAC;QACT,IAAI,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { promises as fs } from 'fs';\nimport os from 'os';\nimport pathUtils from 'path';\n\nimport { parseJson } from './json';\nimport type { VirtualFile } from './virtual-file';\nimport { readVirtualFile } from './virtual-file/node';\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"]}

package/dist/handler-types.cjs

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SNAP_EXPORT_NAMES = exports.HandlerType = void 0;
+var HandlerType;
+(function (HandlerType) {
+    HandlerType["OnRpcRequest"] = "onRpcRequest";
+    HandlerType["OnSignature"] = "onSignature";
+    HandlerType["OnTransaction"] = "onTransaction";
+    HandlerType["OnCronjob"] = "onCronjob";
+    HandlerType["OnInstall"] = "onInstall";
+    HandlerType["OnUpdate"] = "onUpdate";
+    HandlerType["OnNameLookup"] = "onNameLookup";
+    HandlerType["OnKeyringRequest"] = "onKeyringRequest";
+    HandlerType["OnHomePage"] = "onHomePage";
+    HandlerType["OnUserInput"] = "onUserInput";
+})(HandlerType || (exports.HandlerType = HandlerType = {}));
+exports.SNAP_EXPORT_NAMES = Object.values(HandlerType);
+//# sourceMappingURL=handler-types.cjs.map

package/dist/handler-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler-types.cjs","sourceRoot":"","sources":["../src/handler-types.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAWX;AAXD,WAAY,WAAW;IACrB,4CAA6B,CAAA;IAC7B,0CAA2B,CAAA;IAC3B,8CAA+B,CAAA;IAC/B,sCAAuB,CAAA;IACvB,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,4CAA6B,CAAA;IAC7B,oDAAqC,CAAA;IACrC,wCAAyB,CAAA;IACzB,0CAA2B,CAAA;AAC7B,CAAC,EAXW,WAAW,2BAAX,WAAW,QAWtB;AA0BY,QAAA,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC","sourcesContent":["export enum HandlerType {\n  OnRpcRequest = 'onRpcRequest',\n  OnSignature = 'onSignature',\n  OnTransaction = 'onTransaction',\n  OnCronjob = 'onCronjob',\n  OnInstall = 'onInstall',\n  OnUpdate = 'onUpdate',\n  OnNameLookup = 'onNameLookup',\n  OnKeyringRequest = 'onKeyringRequest',\n  OnHomePage = 'onHomePage',\n  OnUserInput = 'onUserInput',\n}\n\nexport type SnapHandler = {\n  /**\n   * The type of handler.\n   */\n  type: HandlerType;\n\n  /**\n   * Whether the handler is required, i.e., whether the request will fail if the\n   * handler is called, but the snap does not export it.\n   *\n   * This is primarily used for the lifecycle handlers, which are optional.\n   */\n  required: boolean;\n\n  /**\n   * Validate the given snap export. This should return a type guard for the\n   * handler type.\n   *\n   * @param snapExport - The export to validate.\n   * @returns Whether the export is valid.\n   */\n  validator: (snapExport: unknown) => boolean;\n};\n\nexport const SNAP_EXPORT_NAMES = Object.values(HandlerType);\n"]}

package/dist/handler-types.d.cts

@@ -0,0 +1,35 @@
+export declare enum HandlerType {
+    OnRpcRequest = "onRpcRequest",
+    OnSignature = "onSignature",
+    OnTransaction = "onTransaction",
+    OnCronjob = "onCronjob",
+    OnInstall = "onInstall",
+    OnUpdate = "onUpdate",
+    OnNameLookup = "onNameLookup",
+    OnKeyringRequest = "onKeyringRequest",
+    OnHomePage = "onHomePage",
+    OnUserInput = "onUserInput"
+}
+export type SnapHandler = {
+    /**
+     * The type of handler.
+     */
+    type: HandlerType;
+    /**
+     * Whether the handler is required, i.e., whether the request will fail if the
+     * handler is called, but the snap does not export it.
+     *
+     * This is primarily used for the lifecycle handlers, which are optional.
+     */
+    required: boolean;
+    /**
+     * Validate the given snap export. This should return a type guard for the
+     * handler type.
+     *
+     * @param snapExport - The export to validate.
+     * @returns Whether the export is valid.
+     */
+    validator: (snapExport: unknown) => boolean;
+};
+export declare const SNAP_EXPORT_NAMES: HandlerType[];
+//# sourceMappingURL=handler-types.d.cts.map

package/dist/handler-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler-types.d.cts","sourceRoot":"","sources":["../src/handler-types.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW;IACrB,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;IACrC,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC5B;AAED,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,OAAO,CAAC;CAC7C,CAAC;AAEF,eAAO,MAAM,iBAAiB,eAA6B,CAAC"}

package/dist/handler-types.d.mts

@@ -0,0 +1,35 @@
+export declare enum HandlerType {
+    OnRpcRequest = "onRpcRequest",
+    OnSignature = "onSignature",
+    OnTransaction = "onTransaction",
+    OnCronjob = "onCronjob",
+    OnInstall = "onInstall",
+    OnUpdate = "onUpdate",
+    OnNameLookup = "onNameLookup",
+    OnKeyringRequest = "onKeyringRequest",
+    OnHomePage = "onHomePage",
+    OnUserInput = "onUserInput"
+}
+export type SnapHandler = {
+    /**
+     * The type of handler.
+     */
+    type: HandlerType;
+    /**
+     * Whether the handler is required, i.e., whether the request will fail if the
+     * handler is called, but the snap does not export it.
+     *
+     * This is primarily used for the lifecycle handlers, which are optional.
+     */
+    required: boolean;
+    /**
+     * Validate the given snap export. This should return a type guard for the
+     * handler type.
+     *
+     * @param snapExport - The export to validate.
+     * @returns Whether the export is valid.
+     */
+    validator: (snapExport: unknown) => boolean;
+};
+export declare const SNAP_EXPORT_NAMES: HandlerType[];
+//# sourceMappingURL=handler-types.d.mts.map

package/dist/handler-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler-types.d.mts","sourceRoot":"","sources":["../src/handler-types.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW;IACrB,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;IACrC,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC5B;AAED,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,OAAO,CAAC;CAC7C,CAAC;AAEF,eAAO,MAAM,iBAAiB,eAA6B,CAAC"}