@metamask-previews/node-utils 0.0.0-preview-a583980c5 → 0.0.0-preview-7baa62aa9

package/CHANGELOG.md

@@ -7,4 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `FileSandbox` type and `createSandbox`, `directoryExists`, `ensureDirectoryStructureExists`, `fileExists`, `forceRemove`, `readFile`, `readJsonFile`, `writeFile`, and `writeJsonFile` functions, moved from `@metamask/utils` ([#10926](https://github.com/MetaMask/core/pull/10926))
+
 [Unreleased]: https://github.com/MetaMask/core/

package/dist/file-system.d.ts

@@ -0,0 +1,133 @@
+import type { Json } from '@metamask/type-utils';
+/**
+ * Information about the file sandbox provided to tests that need temporary
+ * access to the filesystem.
+ */
+export type FileSandbox = {
+    directoryPath: string;
+    withinSandbox: (test: (args: {
+        directoryPath: string;
+    }) => Promise<void>) => Promise<void>;
+};
+/**
+ * Read the file at the given path, assuming its content is encoded as UTF-8.
+ *
+ * @param filePath - The path to the file.
+ * @returns The content of the file.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function readFile(filePath: string): Promise<string>;
+/**
+ * Write content to the file at the given path, creating the directory structure
+ * for the file automatically if necessary.
+ *
+ * @param filePath - The path to the file.
+ * @param content - The new content of the file.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export declare function writeFile(filePath: string, content: string): Promise<void>;
+/**
+ * Read the assumed JSON file at the given path, attempts to parse it, and
+ * get the resulting object. Supports a custom parser (in case you want to
+ * use the [JSON5](https://www.npmjs.com/package/json5) package instead).
+ *
+ * @param filePath - The path segments pointing to the JSON file. Will be passed
+ * to path.join().
+ * @param options - Options to this function.
+ * @param options.parser - The parser object to use. Defaults to `JSON`.
+ * @param options.parser.parse - A function that parses JSON data.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if reading fails in any way, or if the
+ * parsed value is not a plain object.
+ */
+export declare function readJsonFile<Value extends Json>(filePath: string, { parser, }?: {
+    parser?: {
+        parse: (text: Parameters<typeof JSON.parse>[0]) => ReturnType<typeof JSON.parse>;
+    };
+}): Promise<Value>;
+/**
+ * Attempt to write the given JSON-like value to the file at the given path,
+ * creating the directory structure for the file automatically if necessary.
+ * Adds a newline to the end of the file. Supports a custom parser (in case you
+ * want to use the [JSON5](https://www.npmjs.com/package/json5) package
+ * instead).
+ *
+ * @param filePath - The path to write the JSON file to, including the file
+ * itself.
+ * @param jsonValue - The JSON-like value to write to the file. Make sure that
+ * JSON.stringify can handle it.
+ * @param options - The options to this function.
+ * @param options.prettify - Whether to format the JSON as it is turned into a
+ * string such that it is broken up into separate lines (using 2 spaces as
+ * indentation).
+ * @param options.stringifier - The stringifier to use. Defaults to `JSON`.
+ * @param options.stringifier.stringify - A function that stringifies JSON.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export declare function writeJsonFile(filePath: string, jsonValue: Json, { stringifier, prettify, }?: {
+    stringifier?: {
+        stringify: typeof JSON.stringify;
+    };
+    prettify?: boolean;
+}): Promise<void>;
+/**
+ * Test the given path to determine whether it represents a file.
+ *
+ * @param filePath - The path to a (supposed) file on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function fileExists(filePath: string): Promise<boolean>;
+/**
+ * Test the given path to determine whether it represents a directory.
+ *
+ * @param directoryPath - The path to a (supposed) directory on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function directoryExists(directoryPath: string): Promise<boolean>;
+/**
+ * Create the given directory along with any directories leading up to the
+ * directory, or do nothing if the directory already exists.
+ *
+ * @param directoryPath - The path to the desired directory.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function ensureDirectoryStructureExists(directoryPath: string): Promise<void>;
+/**
+ * Remove the given file or directory if it exists, or do nothing if it does
+ * not.
+ *
+ * @param entryPath - The path to the file or directory.
+ * @throws An error with a stack trace if removal fails in any way.
+ */
+export declare function forceRemove(entryPath: string): Promise<void>;
+/**
+ * Construct a sandbox object which can be used in tests that need temporary
+ * access to the filesystem.
+ *
+ * @param projectName - The name of the project.
+ * @returns The sandbox object. This contains a `withinSandbox` function which
+ * can be used in tests (see example).
+ * @example
+ * ```typescript
+ * const { withinSandbox } = createSandbox('utils');
+ *
+ * // ... later ...
+ *
+ * it('does something with the filesystem', async () => {
+ *   await withinSandbox(async ({ directoryPath }) => {
+ *     await fs.writeFile(
+ *       path.join(directoryPath, 'some-file'),
+ *       'some content',
+ *       'utf8'
+ *     );
+ *   })
+ * });
+ * ```
+ */
+export declare function createSandbox(projectName: string): FileSandbox;
+//# sourceMappingURL=file-system.d.ts.map

package/dist/file-system.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system.d.ts","sourceRoot":"","sources":["../src/file-system.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAMjD;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,CACb,IAAI,EAAE,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,KACrD,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAMhE;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAOf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,YAAY,CAAC,KAAK,SAAS,IAAI,EACnD,QAAQ,EAAE,MAAM,EAChB,EACE,MAAa,GACd,GAAE;IACD,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,CACL,IAAI,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KACnC,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;KACpC,CAAC;CACE,GACL,OAAO,CAAC,KAAK,CAAC,CAWhB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,EACf,EACE,WAAkB,EAClB,QAAgB,GACjB,GAAE;IACD,WAAW,CAAC,EAAE;QACZ,SAAS,EAAE,OAAO,IAAI,CAAC,SAAS,CAAC;KAClC,CAAC;IACF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACf,GACL,OAAO,CAAC,IAAI,CAAC,CAWf;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAWnE;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAc7E;AAED;;;;;;GAMG;AACH,wBAAsB,8BAA8B,CAClD,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC,CASf;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASlE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAqB9D"}

package/dist/file-system.js

@@ -0,0 +1,213 @@
+// This file is intended to be used only in a Node.js context.
+/* eslint-disable import-x/no-nodejs-modules */
+import { isErrorWithCode, wrapError } from '@metamask/error-utils';
+import fs from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+import { v4 as uuidV4 } from 'uuid';
+/**
+ * Read the file at the given path, assuming its content is encoded as UTF-8.
+ *
+ * @param filePath - The path to the file.
+ * @returns The content of the file.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function readFile(filePath) {
+    try {
+        return await fs.readFile(filePath, 'utf8');
+    }
+    catch (error) {
+        throw wrapError(error, `Could not read file '${filePath}'`);
+    }
+}
+/**
+ * Write content to the file at the given path, creating the directory structure
+ * for the file automatically if necessary.
+ *
+ * @param filePath - The path to the file.
+ * @param content - The new content of the file.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export async function writeFile(filePath, content) {
+    try {
+        await fs.mkdir(path.dirname(filePath), { recursive: true });
+        await fs.writeFile(filePath, content);
+    }
+    catch (error) {
+        throw wrapError(error, `Could not write file '${filePath}'`);
+    }
+}
+/**
+ * Read the assumed JSON file at the given path, attempts to parse it, and
+ * get the resulting object. Supports a custom parser (in case you want to
+ * use the [JSON5](https://www.npmjs.com/package/json5) package instead).
+ *
+ * @param filePath - The path segments pointing to the JSON file. Will be passed
+ * to path.join().
+ * @param options - Options to this function.
+ * @param options.parser - The parser object to use. Defaults to `JSON`.
+ * @param options.parser.parse - A function that parses JSON data.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if reading fails in any way, or if the
+ * parsed value is not a plain object.
+ */
+export async function readJsonFile(filePath, { parser = JSON, } = {}) {
+    try {
+        const content = await fs.readFile(filePath, 'utf8');
+        // Intentionally returning `any`. We expect validation to be done by the
+        // caller.
+        // oxlint-disable-next-line typescript/no-unsafe-return
+        return parser.parse(content);
+    }
+    catch (error) {
+        throw wrapError(error, `Could not read JSON file '${filePath}'`);
+    }
+}
+/**
+ * Attempt to write the given JSON-like value to the file at the given path,
+ * creating the directory structure for the file automatically if necessary.
+ * Adds a newline to the end of the file. Supports a custom parser (in case you
+ * want to use the [JSON5](https://www.npmjs.com/package/json5) package
+ * instead).
+ *
+ * @param filePath - The path to write the JSON file to, including the file
+ * itself.
+ * @param jsonValue - The JSON-like value to write to the file. Make sure that
+ * JSON.stringify can handle it.
+ * @param options - The options to this function.
+ * @param options.prettify - Whether to format the JSON as it is turned into a
+ * string such that it is broken up into separate lines (using 2 spaces as
+ * indentation).
+ * @param options.stringifier - The stringifier to use. Defaults to `JSON`.
+ * @param options.stringifier.stringify - A function that stringifies JSON.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export async function writeJsonFile(filePath, jsonValue, { stringifier = JSON, prettify = false, } = {}) {
+    try {
+        await fs.mkdir(path.dirname(filePath), { recursive: true });
+        const json = prettify
+            ? stringifier.stringify(jsonValue, null, '  ')
+            : stringifier.stringify(jsonValue);
+        await fs.writeFile(filePath, json);
+    }
+    catch (error) {
+        throw wrapError(error, `Could not write JSON file '${filePath}'`);
+    }
+}
+/**
+ * Test the given path to determine whether it represents a file.
+ *
+ * @param filePath - The path to a (supposed) file on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function fileExists(filePath) {
+    try {
+        const stats = await fs.stat(filePath);
+        return stats.isFile();
+    }
+    catch (error) {
+        if (isErrorWithCode(error) && error.code === 'ENOENT') {
+            return false;
+        }
+        throw wrapError(error, `Could not determine if file exists '${filePath}'`);
+    }
+}
+/**
+ * Test the given path to determine whether it represents a directory.
+ *
+ * @param directoryPath - The path to a (supposed) directory on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function directoryExists(directoryPath) {
+    try {
+        const stats = await fs.stat(directoryPath);
+        return stats.isDirectory();
+    }
+    catch (error) {
+        if (isErrorWithCode(error) && error.code === 'ENOENT') {
+            return false;
+        }
+        throw wrapError(error, `Could not determine if directory exists '${directoryPath}'`);
+    }
+}
+/**
+ * Create the given directory along with any directories leading up to the
+ * directory, or do nothing if the directory already exists.
+ *
+ * @param directoryPath - The path to the desired directory.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function ensureDirectoryStructureExists(directoryPath) {
+    try {
+        await fs.mkdir(directoryPath, { recursive: true });
+    }
+    catch (error) {
+        throw wrapError(error, `Could not create directory structure '${directoryPath}'`);
+    }
+}
+/**
+ * Remove the given file or directory if it exists, or do nothing if it does
+ * not.
+ *
+ * @param entryPath - The path to the file or directory.
+ * @throws An error with a stack trace if removal fails in any way.
+ */
+export async function forceRemove(entryPath) {
+    try {
+        await fs.rm(entryPath, {
+            recursive: true,
+            force: true,
+        });
+    }
+    catch (error) {
+        throw wrapError(error, `Could not remove file or directory '${entryPath}'`);
+    }
+}
+/**
+ * Construct a sandbox object which can be used in tests that need temporary
+ * access to the filesystem.
+ *
+ * @param projectName - The name of the project.
+ * @returns The sandbox object. This contains a `withinSandbox` function which
+ * can be used in tests (see example).
+ * @example
+ * ```typescript
+ * const { withinSandbox } = createSandbox('utils');
+ *
+ * // ... later ...
+ *
+ * it('does something with the filesystem', async () => {
+ *   await withinSandbox(async ({ directoryPath }) => {
+ *     await fs.writeFile(
+ *       path.join(directoryPath, 'some-file'),
+ *       'some content',
+ *       'utf8'
+ *     );
+ *   })
+ * });
+ * ```
+ */
+export function createSandbox(projectName) {
+    const directoryPath = path.join(os.tmpdir(), projectName, uuidV4());
+    return {
+        directoryPath,
+        async withinSandbox(test) {
+            if (await directoryExists(directoryPath)) {
+                throw new Error(`${directoryPath} already exists. Cannot continue.`);
+            }
+            await ensureDirectoryStructureExists(directoryPath);
+            try {
+                await test({ directoryPath });
+            }
+            finally {
+                await forceRemove(directoryPath);
+            }
+        },
+    };
+}
+//# sourceMappingURL=file-system.js.map

package/dist/file-system.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system.js","sourceRoot":"","sources":["../src/file-system.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,+CAA+C;AAE/C,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAapC;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,QAAgB;IAC7C,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,KAAK,EAAE,wBAAwB,QAAQ,GAAG,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,QAAgB,EAChB,OAAe;IAEf,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5D,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,KAAK,EAAE,yBAAyB,QAAQ,GAAG,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,EACE,MAAM,GAAG,IAAI,GACd,GAMG,EAAE;IAEN,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAEpD,wEAAwE;QACxE,UAAU;QACV,uDAAuD;QACvD,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,KAAK,EAAE,6BAA6B,QAAQ,GAAG,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,QAAgB,EAChB,SAAe,EACf,EACE,WAAW,GAAG,IAAI,EAClB,QAAQ,GAAG,KAAK,GACjB,GAKG,EAAE;IAEN,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,QAAQ;YACnB,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC;YAC9C,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAErC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,KAAK,EAAE,8BAA8B,QAAQ,GAAG,CAAC,CAAC;IACpE,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,QAAgB;IAC/C,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,SAAS,CAAC,KAAK,EAAE,uCAAuC,QAAQ,GAAG,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,aAAqB;IACzD,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3C,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,SAAS,CACb,KAAK,EACL,4CAA4C,aAAa,GAAG,CAC7D,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,aAAqB;IAErB,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CACb,KAAK,EACL,yCAAyC,aAAa,GAAG,CAC1D,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,SAAiB;IACjD,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE;YACrB,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAS,CAAC,KAAK,EAAE,uCAAuC,SAAS,GAAG,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,aAAa,CAAC,WAAmB;IAC/C,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;IAEpE,OAAO;QACL,aAAa;QACb,KAAK,CAAC,aAAa,CACjB,IAAwD;YAExD,IAAI,MAAM,eAAe,CAAC,aAAa,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,GAAG,aAAa,mCAAmC,CAAC,CAAC;YACvE,CAAC;YAED,MAAM,8BAA8B,CAAC,aAAa,CAAC,CAAC;YAEpD,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;YAChC,CAAC;oBAAS,CAAC;gBACT,MAAM,WAAW,CAAC,aAAa,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// This file is intended to be used only in a Node.js context.\n/* eslint-disable import-x/no-nodejs-modules */\n\nimport { isErrorWithCode, wrapError } from '@metamask/error-utils';\nimport type { Json } from '@metamask/type-utils';\nimport fs from 'node:fs/promises';\nimport os from 'node:os';\nimport path from 'node:path';\nimport { v4 as uuidV4 } from 'uuid';\n\n/**\n * Information about the file sandbox provided to tests that need temporary\n * access to the filesystem.\n */\nexport type FileSandbox = {\n  directoryPath: string;\n  withinSandbox: (\n    test: (args: { directoryPath: string }) => Promise<void>,\n  ) => Promise<void>;\n};\n\n/**\n * Read the file at the given path, assuming its content is encoded as UTF-8.\n *\n * @param filePath - The path to the file.\n * @returns The content of the file.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function readFile(filePath: string): Promise<string> {\n  try {\n    return await fs.readFile(filePath, 'utf8');\n  } catch (error) {\n    throw wrapError(error, `Could not read file '${filePath}'`);\n  }\n}\n\n/**\n * Write content to the file at the given path, creating the directory structure\n * for the file automatically if necessary.\n *\n * @param filePath - The path to the file.\n * @param content - The new content of the file.\n * @throws An error with a stack trace if writing fails in any way.\n */\nexport async function writeFile(\n  filePath: string,\n  content: string,\n): Promise<void> {\n  try {\n    await fs.mkdir(path.dirname(filePath), { recursive: true });\n    await fs.writeFile(filePath, content);\n  } catch (error) {\n    throw wrapError(error, `Could not write file '${filePath}'`);\n  }\n}\n\n/**\n * Read the assumed JSON file at the given path, attempts to parse it, and\n * get the resulting object. Supports a custom parser (in case you want to\n * use the [JSON5](https://www.npmjs.com/package/json5) package instead).\n *\n * @param filePath - The path segments pointing to the JSON file. Will be passed\n * to path.join().\n * @param options - Options to this function.\n * @param options.parser - The parser object to use. Defaults to `JSON`.\n * @param options.parser.parse - A function that parses JSON data.\n * @returns The object corresponding to the parsed JSON file, typed against the\n * struct.\n * @throws An error with a stack trace if reading fails in any way, or if the\n * parsed value is not a plain object.\n */\nexport async function readJsonFile<Value extends Json>(\n  filePath: string,\n  {\n    parser = JSON,\n  }: {\n    parser?: {\n      parse: (\n        text: Parameters<typeof JSON.parse>[0],\n      ) => ReturnType<typeof JSON.parse>;\n    };\n  } = {},\n): Promise<Value> {\n  try {\n    const content = await fs.readFile(filePath, 'utf8');\n\n    // Intentionally returning `any`. We expect validation to be done by the\n    // caller.\n    // oxlint-disable-next-line typescript/no-unsafe-return\n    return parser.parse(content);\n  } catch (error) {\n    throw wrapError(error, `Could not read JSON file '${filePath}'`);\n  }\n}\n\n/**\n * Attempt to write the given JSON-like value to the file at the given path,\n * creating the directory structure for the file automatically if necessary.\n * Adds a newline to the end of the file. Supports a custom parser (in case you\n * want to use the [JSON5](https://www.npmjs.com/package/json5) package\n * instead).\n *\n * @param filePath - The path to write the JSON file to, including the file\n * itself.\n * @param jsonValue - The JSON-like value to write to the file. Make sure that\n * JSON.stringify can handle it.\n * @param options - The options to this function.\n * @param options.prettify - Whether to format the JSON as it is turned into a\n * string such that it is broken up into separate lines (using 2 spaces as\n * indentation).\n * @param options.stringifier - The stringifier to use. Defaults to `JSON`.\n * @param options.stringifier.stringify - A function that stringifies JSON.\n * @returns The object corresponding to the parsed JSON file, typed against the\n * struct.\n * @throws An error with a stack trace if writing fails in any way.\n */\nexport async function writeJsonFile(\n  filePath: string,\n  jsonValue: Json,\n  {\n    stringifier = JSON,\n    prettify = false,\n  }: {\n    stringifier?: {\n      stringify: typeof JSON.stringify;\n    };\n    prettify?: boolean;\n  } = {},\n): Promise<void> {\n  try {\n    await fs.mkdir(path.dirname(filePath), { recursive: true });\n    const json = prettify\n      ? stringifier.stringify(jsonValue, null, '  ')\n      : stringifier.stringify(jsonValue);\n\n    await fs.writeFile(filePath, json);\n  } catch (error) {\n    throw wrapError(error, `Could not write JSON file '${filePath}'`);\n  }\n}\n\n/**\n * Test the given path to determine whether it represents a file.\n *\n * @param filePath - The path to a (supposed) file on the filesystem.\n * @returns A promise for true if the file exists or false otherwise.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function fileExists(filePath: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(filePath);\n    return stats.isFile();\n  } catch (error) {\n    if (isErrorWithCode(error) && error.code === 'ENOENT') {\n      return false;\n    }\n\n    throw wrapError(error, `Could not determine if file exists '${filePath}'`);\n  }\n}\n\n/**\n * Test the given path to determine whether it represents a directory.\n *\n * @param directoryPath - The path to a (supposed) directory on the filesystem.\n * @returns A promise for true if the file exists or false otherwise.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function directoryExists(directoryPath: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(directoryPath);\n    return stats.isDirectory();\n  } catch (error) {\n    if (isErrorWithCode(error) && error.code === 'ENOENT') {\n      return false;\n    }\n\n    throw wrapError(\n      error,\n      `Could not determine if directory exists '${directoryPath}'`,\n    );\n  }\n}\n\n/**\n * Create the given directory along with any directories leading up to the\n * directory, or do nothing if the directory already exists.\n *\n * @param directoryPath - The path to the desired directory.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function ensureDirectoryStructureExists(\n  directoryPath: string,\n): Promise<void> {\n  try {\n    await fs.mkdir(directoryPath, { recursive: true });\n  } catch (error) {\n    throw wrapError(\n      error,\n      `Could not create directory structure '${directoryPath}'`,\n    );\n  }\n}\n\n/**\n * Remove the given file or directory if it exists, or do nothing if it does\n * not.\n *\n * @param entryPath - The path to the file or directory.\n * @throws An error with a stack trace if removal fails in any way.\n */\nexport async function forceRemove(entryPath: string): Promise<void> {\n  try {\n    await fs.rm(entryPath, {\n      recursive: true,\n      force: true,\n    });\n  } catch (error) {\n    throw wrapError(error, `Could not remove file or directory '${entryPath}'`);\n  }\n}\n\n/**\n * Construct a sandbox object which can be used in tests that need temporary\n * access to the filesystem.\n *\n * @param projectName - The name of the project.\n * @returns The sandbox object. This contains a `withinSandbox` function which\n * can be used in tests (see example).\n * @example\n * ```typescript\n * const { withinSandbox } = createSandbox('utils');\n *\n * // ... later ...\n *\n * it('does something with the filesystem', async () => {\n *   await withinSandbox(async ({ directoryPath }) => {\n *     await fs.writeFile(\n *       path.join(directoryPath, 'some-file'),\n *       'some content',\n *       'utf8'\n *     );\n *   })\n * });\n * ```\n */\nexport function createSandbox(projectName: string): FileSandbox {\n  const directoryPath = path.join(os.tmpdir(), projectName, uuidV4());\n\n  return {\n    directoryPath,\n    async withinSandbox(\n      test: (args: { directoryPath: string }) => Promise<void>,\n    ): Promise<void> {\n      if (await directoryExists(directoryPath)) {\n        throw new Error(`${directoryPath} already exists. Cannot continue.`);\n      }\n\n      await ensureDirectoryStructureExists(directoryPath);\n\n      try {\n        await test({ directoryPath });\n      } finally {\n        await forceRemove(directoryPath);\n      }\n    },\n  };\n}\n"]}

package/dist/index.d.ts

@@ -1,8 +1,3 @@
-/**
- * Example function that returns a greeting for the given name.
- *
- * @param name - The name to greet.
- * @returns The greeting.
- */
-export default function greeter(name: string): string;
+export type { FileSandbox } from './file-system.js';
+export { createSandbox, directoryExists, ensureDirectoryStructureExists, fileExists, forceRemove, readFile, readJsonFile, writeFile, writeJsonFile, } from './file-system.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEpD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EACL,aAAa,EACb,eAAe,EACf,8BAA8B,EAC9B,UAAU,EACV,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,aAAa,GACd,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,10 +1,2 @@
-/**
- * Example function that returns a greeting for the given name.
- *
- * @param name - The name to greet.
- * @returns The greeting.
- */
-export default function greeter(name) {
-    return `Hello, ${name}!`;
-}
+export { createSandbox, directoryExists, ensureDirectoryStructureExists, fileExists, forceRemove, readFile, readJsonFile, writeFile, writeJsonFile, } from './file-system.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,IAAY;IAC1C,OAAO,UAAU,IAAI,GAAG,CAAC;AAC3B,CAAC","sourcesContent":["/**\n * Example function that returns a greeting for the given name.\n *\n * @param name - The name to greet.\n * @returns The greeting.\n */\nexport default function greeter(name: string): string {\n  return `Hello, ${name}!`;\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,eAAe,EACf,8BAA8B,EAC9B,UAAU,EACV,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,aAAa,GACd,MAAM,kBAAkB,CAAC","sourcesContent":["export type { FileSandbox } from './file-system.js';\nexport {\n  createSandbox,\n  directoryExists,\n  ensureDirectoryStructureExists,\n  fileExists,\n  forceRemove,\n  readFile,\n  readJsonFile,\n  writeFile,\n  writeJsonFile,\n} from './file-system.js';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/node-utils",
-  "version": "0.0.0-preview-a583980c5",
+  "version": "0.0.0-preview-7baa62aa9",
   "description": "Utilities for Node.js environments, such as filesystem access and test sandboxing",
   "keywords": [
     "Ethereum",
@@ -49,6 +49,11 @@
     "test:verbose": "vitest --reporter=verbose",
     "test:watch": "vitest --watch"
   },
+  "dependencies": {
+    "@metamask/error-utils": "^0.0.0",
+    "@metamask/type-utils": "^0.0.0",
+    "uuid": "^11.1.1"
+  },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.2.1",
     "@typescript/native": "npm:typescript@^7.0.2",