@visulima/fs 4.0.4 → 4.0.5

package/dist/utils.d.ts

@@ -1,19 +1,6 @@
-export { J as JSONError } from './packem_shared/json-error-ZPgZIXcg.js';
-import { JsonValue } from 'type-fest';
-import { m as CodeFrameOptions, J as JsonReviver } from './packem_shared/types-T308NKwz.js';
-export { toPath } from '@visulima/path/utils';
-import 'node:fs';
-import 'yaml';
-
-declare const assertValidFileContents: (contents: any) => void;
-
-declare const assertValidFileOrDirectoryPath: (fileOrDirectoryPath: any) => void;
-
-declare function parseJson<T = JsonValue>(string: string, filename?: string, options?: CodeFrameOptions): T;
-declare function parseJson<T = JsonValue>(string: string, reviver: JsonReviver, fileName?: string, options?: CodeFrameOptions): T;
-
-declare const stripJsonComments: (jsonString: string, { whitespace }?: {
-    whitespace?: boolean | undefined;
-}) => string;
-
-export { assertValidFileContents, assertValidFileOrDirectoryPath, parseJson, stripJsonComments };
+export { default as JSONError } from "./error/json-error.d.ts";
+export { default as assertValidFileContents } from "./utils/assert-valid-file-contents.d.ts";
+export { default as assertValidFileOrDirectoryPath } from "./utils/assert-valid-file-or-directory-path.d.ts";
+export { default as parseJson } from "./utils/parse-json.d.ts";
+export { default as stripJsonComments } from "./utils/strip-json-comments.d.ts";
+export { toPath } from "@visulima/path/utils";

package/dist/utils.js

@@ -2,5 +2,5 @@ export { default as JSONError } from './packem_shared/JSONError-BkHRnInH.js';
 export { default as assertValidFileContents } from './packem_shared/assertValidFileContents-BmcLtsGd.js';
 export { default as assertValidFileOrDirectoryPath } from './packem_shared/assertValidFileOrDirectoryPath-8HANmVjk.js';
 export { default as parseJson } from './packem_shared/parseJson-CqUuRguZ.js';
-export { default as stripJsonComments } from './packem_shared/stripJsonComments-vo4k0mpF.js';
+export { default as stripJsonComments } from './packem_shared/stripJsonComments-21XWVDwP.js';
 export { toPath } from '@visulima/path/utils';

package/dist/write/utils/to-uint-8-array.d.ts

@@ -0,0 +1,2 @@
+declare const toUint8Array: (contents: any) => Uint8Array;
+export default toUint8Array;

package/dist/write/write-file-sync.d.ts

@@ -0,0 +1,30 @@
+import type { WriteFileOptions } from "../types.d.ts";
+/**
+ * Synchronously writes data to a file, replacing the file if it already exists.
+ * This function includes safeguards like writing to a temporary file first and then renaming, and handling permissions.
+ * @param path The path to the file to write. Can be a file URL or a string path.
+ * @param content The data to write. Can be a string, Buffer, ArrayBuffer, or ArrayBufferView.
+ * @param options Optional configuration for writing the file. See {@link WriteFileOptions}.
+ * @returns void
+ * @example
+ * ```javascript
+ * import { writeFileSync } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * const writeMyFileSync = () => {
+ *   try {
+ *     writeFileSync(join("/tmp", "my-new-file-sync.txt"), "Hello World Synchronously!");
+ *     console.log("File written successfully (sync).");
+ *
+ *     writeFileSync(join("/tmp", "another-file-sync.txt"), "Some other sync content", { encoding: 'utf16le', mode: 0o600 });
+ *     console.log("Another file written with specific options (sync).");
+ *   } catch (error) {
+ *     console.error("Failed to write file (sync):", error);
+ *   }
+ * };
+ *
+ * writeMyFileSync();
+ * ```
+ */
+declare const writeFileSync: (path: URL | string, content: ArrayBuffer | ArrayBufferView | string, options?: WriteFileOptions) => void;
+export default writeFileSync;

package/dist/write/write-file.d.ts

@@ -0,0 +1,30 @@
+import type { WriteFileOptions } from "../types.d.ts";
+/**
+ * Asynchronously writes data to a file, replacing the file if it already exists.
+ * This function includes safeguards like writing to a temporary file first and then renaming, and handling permissions.
+ * @param path The path to the file to write. Can be a file URL or a string path.
+ * @param content The data to write. Can be a string, Buffer, ArrayBuffer, or ArrayBufferView.
+ * @param options Optional configuration for writing the file. See {@link WriteFileOptions}.
+ * @returns A promise that resolves when the file has been written.
+ * @example
+ * ```javascript
+ * import { writeFile } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * const writeMyFile = async () => {
+ *   try {
+ *     await writeFile(join("/tmp", "my-new-file.txt"), "Hello World!");
+ *     console.log("File written successfully.");
+ *
+ *     await writeFile(join("/tmp", "another-file.txt"), "Some other content", { encoding: 'utf16le', mode: 0o600 });
+ *     console.log("Another file written with specific options.");
+ *   } catch (error) {
+ *     console.error("Failed to write file:", error);
+ *   }
+ * };
+ *
+ * writeMyFile();
+ * ```
+ */
+declare const writeFile: (path: URL | string, content: ArrayBuffer | ArrayBufferView | string, options?: WriteFileOptions) => Promise<void>;
+export default writeFile;

package/dist/write/write-json-sync.d.ts

@@ -0,0 +1,30 @@
+import type { WriteJsonOptions } from "../types.d.ts";
+/**
+ * Synchronously writes an object to a JSON file.
+ * Handles indentation detection, custom stringifiers, and gracefully manages existing files.
+ * @param path The path to the JSON file to write. Can be a file URL or a string path.
+ * @param data The data to serialize and write. Can be any JavaScript value that can be stringified by `JSON.stringify` or a custom stringifier.
+ * @param options Optional configuration for writing the JSON file. See {@link WriteJsonOptions}.
+ * @returns void
+ * @example
+ * ```javascript
+ * import { writeJsonSync } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * const writeMyJsonSync = () => {
+ *   try {
+ *     writeJsonSync(join("/tmp", "my-config-sync.json"), { setting: "enabled", value: 456 });
+ *     console.log("JSON file written successfully (sync).");
+ *
+ *     writeJsonSync(join("/tmp", "another-config-sync.json"), { user: "testSync", id: "def" }, { indent: 4, replacer: ["id"] });
+ *     console.log("Another JSON file written with specific options (sync, indent 4, only 'id' key).");
+ *   } catch (error) {
+ *     console.error("Failed to write JSON file (sync):", error);
+ *   }
+ * };
+ *
+ * writeMyJsonSync();
+ * ```
+ */
+declare const writeJsonSync: (path: URL | string, data: unknown, options?: WriteJsonOptions) => void;
+export default writeJsonSync;

package/dist/write/write-json.d.ts

@@ -0,0 +1,30 @@
+import type { WriteJsonOptions } from "../types.d.ts";
+/**
+ * Asynchronously writes an object to a JSON file.
+ * Handles indentation detection, custom stringifiers, and gracefully manages existing files.
+ * @param path The path to the JSON file to write. Can be a file URL or a string path.
+ * @param data The data to serialize and write. Can be any JavaScript value that can be stringified by `JSON.stringify` or a custom stringifier.
+ * @param options Optional configuration for writing the JSON file. See {@link WriteJsonOptions}.
+ * @returns A promise that resolves when the JSON file has been written.
+ * @example
+ * ```javascript
+ * import { writeJson } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * const writeMyJson = async () => {
+ *   try {
+ *     await writeJson(join("/tmp", "my-config.json"), { setting: "enabled", value: 123 });
+ *     console.log("JSON file written successfully.");
+ *
+ *     await writeJson(join("/tmp", "another-config.json"), { user: "test", id: "abc" }, { indent: 2, replacer: ["user"] });
+ *     console.log("Another JSON file written with specific options (indent 2, only 'user' key).");
+ *   } catch (error) {
+ *     console.error("Failed to write JSON file:", error);
+ *   }
+ * };
+ *
+ * writeMyJson();
+ * ```
+ */
+declare const writeJson: (path: URL | string, data: unknown, options?: WriteJsonOptions) => Promise<void>;
+export default writeJson;

package/dist/write/write-yaml-sync.d.ts

@@ -0,0 +1,4 @@
+import type { WriteYamlOptions, YamlReplacer } from "../types.d.ts";
+declare function writeYamlSync(path: URL | string, data: any, options?: WriteYamlOptions): void;
+declare function writeYamlSync(path: URL | string, data: any, replacer?: YamlReplacer, options?: WriteYamlOptions | number | string): void;
+export default writeYamlSync;

package/dist/write/write-yaml.d.ts

@@ -0,0 +1,4 @@
+import type { WriteYamlOptions, YamlReplacer } from "../types.d.ts";
+declare function writeYaml(path: URL | string, data: any, options?: WriteYamlOptions): Promise<void>;
+declare function writeYaml(path: URL | string, data: any, replacer?: YamlReplacer, options?: WriteYamlOptions | number | string): Promise<void>;
+export default writeYaml;

package/dist/yaml.d.ts

@@ -1,17 +1,5 @@
-import { r as ReadYamlOptions, Y as YamlReviver, s as WriteYamlOptions, t as YamlReplacer } from './packem_shared/types-T308NKwz.js';
-import 'node:fs';
-import 'yaml';
-
-declare function readYaml<R = Record<string, unknown>>(path: URL | string, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): Promise<R>;
-declare function readYaml<R = Record<string, unknown>>(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): Promise<R>;
-
-declare function readYamlSync<R = Record<string, unknown>>(path: URL | string, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): R;
-declare function readYamlSync<R = Record<string, unknown>>(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): R;
-
-declare function writeYaml(path: URL | string, data: any, options?: WriteYamlOptions): Promise<void>;
-declare function writeYaml(path: URL | string, data: any, replacer?: YamlReplacer, options?: WriteYamlOptions | number | string): Promise<void>;
-
-declare function writeYamlSync(path: URL | string, data: any, options?: WriteYamlOptions): void;
-declare function writeYamlSync(path: URL | string, data: any, replacer?: YamlReplacer, options?: WriteYamlOptions | number | string): void;
-
-export { YamlReplacer, readYaml, readYamlSync, writeYaml, writeYamlSync };
+export { default as readYaml } from "./read/read-yaml.d.ts";
+export { default as readYamlSync } from "./read/read-yaml-sync.d.ts";
+export type { YamlReplacer } from "./types.d.ts";
+export { default as writeYaml } from "./write/write-yaml.d.ts";
+export { default as writeYamlSync } from "./write/write-yaml-sync.d.ts";

package/dist/yaml.js

@@ -1,4 +1,4 @@
-export { default as readYaml } from './packem_shared/readYaml-BQXTlR2p.js';
-export { default as readYamlSync } from './packem_shared/readYamlSync-BBBQ5ujx.js';
-export { default as writeYaml } from './packem_shared/writeYaml-n4xzYN9a.js';
-export { default as writeYamlSync } from './packem_shared/writeYamlSync-DnOEnP10.js';
+export { default as readYaml } from './packem_shared/readYaml-Bu1nsexB.js';
+export { default as readYamlSync } from './packem_shared/readYamlSync-Di88aMME.js';
+export { default as writeYaml } from './packem_shared/writeYaml-BMY0kOPf.js';
+export { default as writeYamlSync } from './packem_shared/writeYamlSync-DqPu8cCd.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/fs",
-  "version": "4.0.4",
+  "version": "4.0.5",
   "description": "Human friendly file system utilities for Node.js",
   "keywords": [
     "anolilab",
@@ -113,8 +113,7 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "@visulima/path": "2.0.3",
-    "type-fest": "^5.2.0"
+    "@visulima/path": "2.0.4"
   },
   "peerDependencies": {
     "yaml": "^2.7.1"

package/dist/packem_shared/json-error-ZPgZIXcg.d.ts

@@ -1,11 +0,0 @@
-declare class JSONError extends Error {
-    #private;
-    fileName: string | undefined;
-    codeFrame: string | undefined;
-    readonly name = "JSONError";
-    constructor(message: string);
-    get message(): string;
-    set message(message: string);
-}
-
-export { JSONError as J };

package/dist/packem_shared/types-T308NKwz.d.ts

@@ -1,90 +0,0 @@
-import { PathLike, Dirent } from 'node:fs';
-import { DocumentOptions, ParseOptions, SchemaOptions, ToJSOptions, CreateNodeOptions, ToStringOptions } from 'yaml';
-
-declare const F_OK = 0;
-declare const R_OK = 4;
-declare const W_OK = 2;
-declare const X_OK = 1;
-declare const FIND_UP_STOP: unique symbol;
-
-type ColorizeMethod = (value: string) => string;
-interface WalkOptions {
-    extensions?: string[];
-    followSymlinks?: boolean;
-    includeDirs?: boolean;
-    includeFiles?: boolean;
-    includeSymlinks?: boolean;
-    match?: (RegExp | string)[];
-    maxDepth?: number;
-    skip?: (RegExp | string)[];
-}
-interface WalkEntry extends Pick<Dirent, "isDirectory" | "isFile" | "isSymbolicLink" | "name"> {
-    path: string;
-}
-type ReadFileEncoding = "ascii" | "base64" | "base64url" | "hex" | "latin1" | "ucs-2" | "ucs2" | "utf-8" | "utf-16le" | "utf8" | "utf16le";
-type ReadFileOptions<C> = {
-    buffer?: boolean;
-    compression?: C;
-    encoding?: ReadFileEncoding | undefined;
-    flag?: number | string | undefined;
-};
-type ContentType<O = undefined> = O extends {
-    buffer: true;
-} ? Buffer : string;
-type JsonReviver = Parameters<(typeof JSON)["parse"]>["1"];
-type CodeFrameLocation = {
-    column?: number;
-    line: number;
-};
-type CodeFrameOptions = {
-    color?: {
-        gutter?: ColorizeMethod;
-        marker?: ColorizeMethod;
-        message?: ColorizeMethod;
-    };
-};
-type ReadJsonOptions = CodeFrameOptions & {
-    beforeParse?: (source: string) => string;
-};
-type WriteFileOptions = {
-    chown?: {
-        gid: number;
-        uid: number;
-    };
-    encoding?: BufferEncoding | null | undefined;
-    flag?: string | undefined;
-    mode?: number;
-    overwrite?: boolean;
-    recursive?: boolean;
-};
-type JsonReplacer = (number | string)[] | ((this: unknown, key: string, value: unknown) => unknown) | null;
-type YamlReplacer = JsonReplacer;
-type WriteJsonOptions = WriteFileOptions & {
-    detectIndent?: boolean;
-    indent?: number | string | undefined;
-    replacer?: JsonReplacer;
-    stringify?: (data: unknown, replacer: JsonReplacer, space: number | string | undefined) => string;
-};
-type FindUpOptions = {
-    allowSymlinks?: boolean;
-    cwd?: URL | string;
-    stopAt?: URL | string;
-    type?: "directory" | "file";
-};
-type FindUpNameFnResult = PathLike | Promise<PathLike | typeof FIND_UP_STOP> | typeof FIND_UP_STOP | undefined;
-type FindUpName = string[] | string | ((directory: string) => FindUpNameFnResult);
-type FindUpNameSyncFnResult = PathLike | typeof FIND_UP_STOP | undefined;
-type FindUpNameSync = string[] | string | ((directory: string) => FindUpNameSyncFnResult);
-type RetryOptions = {
-    maxRetries?: number | undefined;
-    retryDelay?: number | undefined;
-};
-type ReadYamlOptions<C> = DocumentOptions & ParseOptions & ReadFileOptions<C> & SchemaOptions & ToJSOptions;
-type YamlReviver = (key: unknown, value: unknown) => unknown;
-type WriteYamlOptions = CreateNodeOptions & DocumentOptions & ParseOptions & SchemaOptions & ToStringOptions & WriteFileOptions & {
-    replacer?: YamlReplacer;
-    space?: number | string;
-};
-
-export { X_OK as X, F_OK as h, FIND_UP_STOP as i, R_OK as j, W_OK as k };
-export type { ContentType as C, FindUpName as F, JsonReviver as J, ReadFileOptions as R, WalkOptions as W, YamlReviver as Y, FindUpOptions as a, FindUpNameSync as b, WalkEntry as c, ReadJsonOptions as d, RetryOptions as e, WriteFileOptions as f, WriteJsonOptions as g, CodeFrameLocation as l, CodeFrameOptions as m, FindUpNameFnResult as n, FindUpNameSyncFnResult as o, JsonReplacer as p, ReadFileEncoding as q, ReadYamlOptions as r, WriteYamlOptions as s, YamlReplacer as t };