@bitbeater/node-utils 2.0.0

package/README.md

@@ -0,0 +1,19 @@
+# node-utils
+
+simple, lightweight, dependenciesless, nodejs generic helper library
+
+## Installation
+
+npm
+
+```bash
+npm i @bitbeater/node-utils
+```
+
+deno
+
+```bash
+deno install npm:@bitbeater/node-utils
+```
+
+[Documentation](https://bitbeater.github.io/node-utils/index.html)

package/dist/fs/dirs.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Directory for storing app data during development.
+ * This ensures that isn't required special permissions to write to the directory and it's isolated from system directories. */
+export declare function getOsAppInstallDir(): string;
+/**
+ * Architecture-independent (shared) data.
+ * e.g. C:\ProgramData\ on win32 or /usr/share on Linux.
+ */
+export declare function getOsSharedDataDir(): string;
+/**
+ * OS-specific system wide dir for app configurations.
+ */
+export declare function getOsSysConfDir(): string;
+/**
+ * USER-specific dir for app configurations.
+ */
+export declare function getOsUsrConfDir(): string;
+/**
+ * Returns the home directory of the current OS user.
+ * e.g. C:\Users\<user> on win32 or /home/<user> on Linux.
+ */
+export declare function getOsUserHomeDir(): string;
+export declare function getOsUserBinDir(): string;
+export declare function getOsDeskotpDir(): string;
+//# sourceMappingURL=dirs.d.ts.map

package/dist/fs/dirs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dirs.d.ts","sourceRoot":"","sources":["../../src/fs/dirs.ts"],"names":[],"mappings":"AAEA;;+HAE+H;AAC/H,wBAAgB,kBAAkB,IAAI,MAAM,CAW3C;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,CAW3C;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAWxC;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAUxC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,CAUzC;AAED,wBAAgB,eAAe,IAAI,MAAM,CAWxC;AAED,wBAAgB,eAAe,IAAI,MAAM,CAExC"}

package/dist/fs/dirs.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOsAppInstallDir = getOsAppInstallDir;
+exports.getOsSharedDataDir = getOsSharedDataDir;
+exports.getOsSysConfDir = getOsSysConfDir;
+exports.getOsUsrConfDir = getOsUsrConfDir;
+exports.getOsUserHomeDir = getOsUserHomeDir;
+exports.getOsUserBinDir = getOsUserBinDir;
+exports.getOsDeskotpDir = getOsDeskotpDir;
+const path_1 = require("path");
+/**
+ * Directory for storing app data during development.
+ * This ensures that isn't required special permissions to write to the directory and it's isolated from system directories. */
+function getOsAppInstallDir() {
+    switch (process.platform) {
+        case 'linux':
+            return '/opt';
+        case 'darwin':
+            return '/Applications';
+        case 'win32':
+            return 'C:\\Program Files';
+        default:
+            throw new Error(`Unsupported OS: ${process.platform}`);
+    }
+}
+/**
+ * Architecture-independent (shared) data.
+ * e.g. C:\ProgramData\ on win32 or /usr/share on Linux.
+ */
+function getOsSharedDataDir() {
+    switch (process.platform) {
+        case 'linux':
+            return (0, path_1.resolve)('/usr', 'share');
+        case 'darwin':
+            return '~/Library/Application Support';
+        case 'win32':
+            return process.env.APPDATA;
+        default:
+            throw new Error(`Unsupported OS: ${process.platform}`);
+    }
+}
+/**
+ * OS-specific system wide dir for app configurations.
+ */
+function getOsSysConfDir() {
+    switch (process.platform) {
+        case 'linux':
+            return (0, path_1.resolve)('/etc');
+        case 'darwin':
+            return (0, path_1.resolve)('/Library/Application Support');
+        case 'win32':
+            return process.env.APPDATA;
+        default:
+            throw new Error(`Unsupported OS: ${process.platform}`);
+    }
+}
+/**
+ * USER-specific dir for app configurations.
+ */
+function getOsUsrConfDir() {
+    switch (process.platform) {
+        case 'linux':
+        case 'darwin':
+            return (0, path_1.resolve)(getOsUserHomeDir(), '.config');
+        case 'win32':
+            return process.env.LOCALAPPDATA;
+        default:
+            throw new Error(`Unsupported OS: ${process.platform}`);
+    }
+}
+/**
+ * Returns the home directory of the current OS user.
+ * e.g. C:\Users\<user> on win32 or /home/<user> on Linux.
+ */
+function getOsUserHomeDir() {
+    switch (process.platform) {
+        case 'linux':
+        case 'darwin':
+            return process.env.HOME;
+        case 'win32':
+            return process.env.USERPROFILE;
+        default:
+            throw new Error(`Unsupported OS: ${process.platform}`);
+    }
+}
+function getOsUserBinDir() {
+    switch (process.platform) {
+        case 'linux':
+            return (0, path_1.resolve)(getOsUserHomeDir(), '.local', 'bin');
+        case 'darwin':
+            return (0, path_1.resolve)(getOsUserHomeDir(), 'bin');
+        case 'win32':
+            return getOsAppInstallDir();
+        default:
+            throw new Error(`Unsupported OS: ${process.platform}`);
+    }
+}
+function getOsDeskotpDir() {
+    return (0, path_1.resolve)(getOsUserHomeDir(), 'Desktop');
+}
+//# sourceMappingURL=dirs.js.map

package/dist/fs/dirs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dirs.js","sourceRoot":"","sources":["../../src/fs/dirs.ts"],"names":[],"mappings":";;AAKA,gDAWC;AAMD,gDAWC;AAKD,0CAWC;AAKD,0CAUC;AAMD,4CAUC;AAED,0CAWC;AAED,0CAEC;AAjGD,+BAA+B;AAE/B;;+HAE+H;AAC/H,SAAgB,kBAAkB;IAC9B,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,OAAO;YACR,OAAO,MAAM,CAAC;QAClB,KAAK,QAAQ;YACT,OAAO,eAAe,CAAC;QAC3B,KAAK,OAAO;YACR,OAAO,mBAAmB,CAAC;QAC/B;YACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB;IAC9B,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,OAAO;YACR,OAAO,IAAA,cAAO,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACpC,KAAK,QAAQ;YACT,OAAO,+BAA+B,CAAC;QAC3C,KAAK,OAAO;YACR,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QAC/B;YACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe;IAC3B,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,OAAO;YACR,OAAO,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC;QAC3B,KAAK,QAAQ;YACT,OAAO,IAAA,cAAO,EAAC,8BAA8B,CAAC,CAAC;QACnD,KAAK,OAAO;YACR,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QAC/B;YACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe;IAC3B,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ;YACT,OAAO,IAAA,cAAO,EAAC,gBAAgB,EAAE,EAAE,SAAS,CAAC,CAAC;QAClD,KAAK,OAAO;YACR,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;QACpC;YACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB;IAC5B,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ;YACT,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;QAC5B,KAAK,OAAO;YACR,OAAO,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;QACnC;YACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAED,SAAgB,eAAe;IAC3B,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,OAAO;YACR,OAAO,IAAA,cAAO,EAAC,gBAAgB,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QACxD,KAAK,QAAQ;YACT,OAAO,IAAA,cAAO,EAAC,gBAAgB,EAAE,EAAE,KAAK,CAAC,CAAC;QAC9C,KAAK,OAAO;YACR,OAAO,kBAAkB,EAAE,CAAC;QAChC;YACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/D,CAAC;AACL,CAAC;AAED,SAAgB,eAAe;IAC3B,OAAO,IAAA,cAAO,EAAC,gBAAgB,EAAE,EAAE,SAAS,CAAC,CAAC;AAClD,CAAC"}

package/dist/fs/files.d.ts

@@ -0,0 +1,192 @@
+import { Abortable } from 'events';
+import { Mode, ObjectEncodingOptions, OpenMode, PathLike, WriteFileOptions } from 'fs';
+import { FileHandle, FlagAndOpenMode } from 'fs/promises';
+import { Stream } from 'stream';
+import { ZlibOptions } from 'zlib';
+import { Reviver, Replacer } from '@bitbeater/ecma-utils/revivers';
+/** *
+ * If `data` is a plain object, it must have an own (not inherited) `toString`function property.
+ *
+ * The `mode` option only affects the newly created file. See {@link open} for more details.
+ *
+ * For detailed information, see the documentation of the asynchronous version of
+ * this API: {@link writeFile}.
+ * @param file filename or file descriptor
+ */
+export declare function writeSync(file: PathLike, data?: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): void;
+/**
+ * Writes the given object as JSON to the specified file path synchronously.
+ * @param path - The file path where the JSON should be written.
+ * @param object - The object to be written as JSON.
+ */
+export declare function writeJsonSync(path: string, object: any): void;
+/**
+ * Reads and parses a JSON file synchronously.
+ *
+ * @template T - The type of the parsed JSON object.
+ * @param {string} path - The path to the JSON file.
+ * @param {reviver.Reviver<any>} [reviver] - Optional reviver function for JSON.parse.
+ * @returns {T} - The parsed JSON object.
+ */
+export declare function readJsonSync<T>(path: string, reviver?: Reviver<any>): T;
+/**
+ * Inserts the specified data between the given placeholders in the file synchronously.
+ * If the file does not exist, it creates the file and inserts the data.
+ *
+ * @param filePath - The path of the file.
+ * @param data - The data to be inserted between the placeholders.
+ * @param beginPlaceHolder - The beginning placeholder.
+ * @param endPlaceHolder - The ending placeholder.
+ */
+export declare function insertBetweenPlacweHoldersSync(filePath: string, data: string, beginPlaceHolder: string, endPlaceHolder: string): void;
+/**
+ * Reads a file and returns an array of string lines.
+ *
+ * @param path - The path to the file.
+ * @param lineSeparator - The regular expression used to split the file into lines. Defaults to /[\n|\r]/.
+ * @returns An array of lines from the file, or null if the file cannot be read.
+ */
+export declare function fileLinesSync(path: string, lineSeparator?: RegExp): string[];
+/**
+ * Writes the given data to a file in GZip format synchronously.
+ *
+ * @param filePath - The path to the file.
+ * @param data - The data to be written to the file. It can be a string or a Buffer.
+ * @param writeFileOptions - The options for writing the file (optional).
+ * @param zLibOptions - The options for compressing the data using zlib (optional).
+ */
+export declare function writeGZipSync(filePath: string, data: string | Buffer, writeFileOptions?: WriteFileOptions, zLibOptions?: ZlibOptions): void;
+/**
+ * Reads a gzipped file synchronously and returns the uncompressed data as a Buffer.
+ *
+ * @param path - The path to the gzipped file.
+ * @param readFileOptions - The options to pass to the `readFileSync` function.
+ * @param zlibOptions - The options to pass to the `unzipSync` function.
+ * @returns The uncompressed data as a Buffer.
+ */
+export declare function readGZipSync(path: string, readFileOptions?: {
+    encoding?: null;
+    flag?: string;
+}, zlibOptions?: ZlibOptions): Buffer;
+/**
+ * Serializes an object to JSON and writes it to a file synchronously.
+ * @param filePath - The path of the file to write.
+ * @param object - The object to serialize and write to the file.
+ */
+export declare function serealizeObjectSync(filePath: string, object: any): void;
+/**
+ * Deserializes an object from a file synchronously.
+ *
+ * @param filePath - The path to the file.
+ * @returns The deserialized object.
+ */
+export declare function deserealizeObjectSync(filePath: string): any;
+/**
+ * Synchronous [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html). Returns `undefined`.
+ * @return `undefined` upon success.
+ * @see {@link unlinkSync}
+ */
+export declare function removeSync(path: PathLike): void;
+/**
+ * check if file exists
+ *
+ *
+ * @param path file path
+ * @returns true if exists false otherwise
+ *
+ * @see{@link stat}
+ */
+export declare const exists: (path: PathLike) => Promise<boolean>;
+/**
+ * add to file, if the file or folder does not exist it will be recursively created
+ * @param path
+ * @param data
+ * @param options
+ * @returns
+ */
+export declare function append(path: PathLike | FileHandle, data: string | Uint8Array, options?: (ObjectEncodingOptions & FlagAndOpenMode) | BufferEncoding | null): Promise<void>;
+/**
+ * write to file, if the folder does not exist it will be recursively created
+ *
+ * @param file filename or `FileHandle`
+ * @param data
+ * @param options
+ * @return Fulfills with `undefined` upon success.
+ *
+ *
+ * @see{@link exists}
+ * @see{@link mkdir}
+ * @see{@link writeFile}
+ */
+export declare function write(file: PathLike | FileHandle, data?: string | NodeJS.ArrayBufferView | Iterable<string | NodeJS.ArrayBufferView> | AsyncIterable<string | NodeJS.ArrayBufferView> | Stream, options?: (ObjectEncodingOptions & {
+    mode?: Mode | undefined;
+    flag?: OpenMode | undefined;
+} & Abortable) | BufferEncoding | null): Promise<void>;
+/**
+ * Asynchronously reads the entire contents of a file that contains a valid JSON string, and converts the content into an object.
+ *
+ * @param file filename or `FileHandle`
+ * @param options
+ * @param reviver A function that transforms the results. This function is called for each member of the object.
+ * If a member contains nested objects, the nested objects are transformed before the parent object is.
+ *
+ * @see{@link readFile}
+ * @see{@link JSON.parse}
+ */
+export declare function readJson<T>(file: PathLike | FileHandle, options?: ({
+    encoding?: null | undefined;
+    flag?: OpenMode | undefined;
+} & Abortable) | null, reviver?: Reviver<any>): Promise<T>;
+/**
+ * Converts a JavaScript value to a JavaScript Object Notation (JSON) string, and asynchronously writes data to a file, replacing the file if it already exists.
+ *
+ * @param file filename or `FileHandle`
+ * @param obj A JavaScript value, usually an object or array, to be converted.
+ * @param replacer A function that transforms the results.
+ * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+ * @returns
+ * @see {@link JSON.stringify}
+ * @see {@link write}
+ */
+export declare function writeJson(file: PathLike | FileHandle, obj: any, options?: (ObjectEncodingOptions & {
+    mode?: Mode | undefined;
+    flag?: OpenMode | undefined;
+} & Abortable) | BufferEncoding | null, replacer?: Replacer<any>, space?: string | number): Promise<void>;
+/**
+ * If `path` refers to a symbolic link, then the link is removed without affecting
+ * the file or directory to which that link refers. If the `path` refers to a file
+ * path that is not a symbolic link, the file is deleted. See the POSIX [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html) documentation for more detail.
+ * @return Fulfills with `undefined` upon success.
+ * @see {@link unlink}
+ */
+export declare function remove(path: PathLike): Promise<void>;
+/**
+ * Writes data to a file and creates the necessary directory structure if it doesn't exist.
+ *
+ * @param path - The path to the file.
+ * @param data - The data to write to the file.
+ * @param options - The options for writing the file.
+ */
+export declare function writeFileAndDir(path: string, data?: Uint8Array | string, options?: WriteFileOptions): void;
+export declare function copyFileRecursive(origPath: string, destPath: string): void;
+/**
+ * remove sync, without throwing NotFound error if it doesn't exist
+ * @param path
+ * @param options
+ */
+export declare function silentRemove(path: string | URL, options?: FileSystemRemoveOptions): void;
+/**
+ * Calculates the SHA256 hash of a file.
+ *
+ * @param filePath - The path to the file.
+ * @returns The SHA256 hash of the file as a hexadecimal string.
+ */
+export declare function sha256(filePath: string): string;
+/**
+ * Tails a file and calls the callback with new data when the file is appended.
+ * @param filePath
+ * @param cb
+ * @returns
+ */
+export declare function tail(filePath: string, cb: (chunk: Uint8Array) => void): import("fs").FSWatcher;
+//# sourceMappingURL=files.d.ts.map

package/dist/fs/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/fs/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAKN,IAAI,EACJ,qBAAqB,EACrB,QAAQ,EAER,QAAQ,EAOR,gBAAgB,EAEhB,MAAM,IAAI,CAAC;AACZ,OAAO,EAAc,UAAU,EAAE,eAAe,EAA4C,MAAM,aAAa,CAAC;AAEhH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,OAAO,EAAuB,WAAW,EAAE,MAAM,MAAM,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAInE;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,gBAAgB,QAI3G;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,QAEtD;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAOvE;AAED;;;;;;;;GAQG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,QAY9H;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,SAAY,GAAG,MAAM,EAAE,CAQ/E;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,WAAW,CAAC,EAAE,WAAW,QAKzB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC3B,IAAI,EAAE,MAAM,EACZ,eAAe,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,EACpD,WAAW,CAAC,EAAE,WAAW,GACvB,MAAM,CAGR;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,QAEhE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,OAErD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAM/C;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,QAAQ,KAAG,OAAO,CAAC,OAAO,CAMnD,CAAC;AAEL;;;;;;GAMG;AACH,wBAAgB,MAAM,CACrB,IAAI,EAAE,QAAQ,GAAG,UAAU,EAC3B,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE,CAAC,qBAAqB,GAAG,eAAe,CAAC,GAAG,cAAc,GAAG,IAAI,GACzE,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CACpB,IAAI,EAAE,QAAQ,GAAG,UAAU,EAC3B,IAAI,CAAC,EACF,MAAM,GACN,MAAM,CAAC,eAAe,GACtB,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,GACzC,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,eAAe,CAAC,GAC9C,MAAM,EACT,OAAO,CAAC,EACL,CAAC,qBAAqB,GAAG;IAC1B,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC5B,GAAG,SAAS,CAAC,GACZ,cAAc,GACd,IAAI,GACL,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACzB,IAAI,EAAE,QAAQ,GAAG,UAAU,EAC3B,OAAO,CAAC,EACL,CAAC;IACF,QAAQ,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC5B,GAAG,SAAS,CAAC,GACZ,IAAI,EACP,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,GACpB,OAAO,CAAC,CAAC,CAAC,CAEZ;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACxB,IAAI,EAAE,QAAQ,GAAG,UAAU,EAC3B,GAAG,EAAE,GAAG,EACR,OAAO,CAAC,EACL,CAAC,qBAAqB,GAAG;IAC1B,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC5B,GAAG,SAAS,CAAC,GACZ,cAAc,GACd,IAAI,EACP,QAAQ,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,EACxB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GACrB,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpD;AAID;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,QASnG;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,QASnE;AAKD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,uBAAuB,QAOjF;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAO/C;AAGD;;;;;GAKG;AAEH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,0BAwBrE"}

package/dist/fs/files.js

@@ -0,0 +1,330 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exists = void 0;
+exports.writeSync = writeSync;
+exports.writeJsonSync = writeJsonSync;
+exports.readJsonSync = readJsonSync;
+exports.insertBetweenPlacweHoldersSync = insertBetweenPlacweHoldersSync;
+exports.fileLinesSync = fileLinesSync;
+exports.writeGZipSync = writeGZipSync;
+exports.readGZipSync = readGZipSync;
+exports.serealizeObjectSync = serealizeObjectSync;
+exports.deserealizeObjectSync = deserealizeObjectSync;
+exports.removeSync = removeSync;
+exports.append = append;
+exports.write = write;
+exports.readJson = readJson;
+exports.writeJson = writeJson;
+exports.remove = remove;
+exports.writeFileAndDir = writeFileAndDir;
+exports.copyFileRecursive = copyFileRecursive;
+exports.silentRemove = silentRemove;
+exports.sha256 = sha256;
+exports.tail = tail;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const crypto_1 = require("crypto");
+const zlib_1 = require("zlib");
+const promises_2 = require("@bitbeater/ecma-utils/promises");
+// import { promises, reviver } from 'iggs-utils';
+/** *
+ * If `data` is a plain object, it must have an own (not inherited) `toString`function property.
+ *
+ * The `mode` option only affects the newly created file. See {@link open} for more details.
+ *
+ * For detailed information, see the documentation of the asynchronous version of
+ * this API: {@link writeFile}.
+ * @param file filename or file descriptor
+ */
+function writeSync(file, data, options) {
+    const dirPath = (0, path_1.dirname)(file.toString());
+    if (!(0, fs_1.existsSync)(dirPath))
+        (0, fs_1.mkdirSync)((0, path_1.dirname)(dirPath));
+    (0, fs_1.writeFileSync)(file, data || '');
+}
+/**
+ * Writes the given object as JSON to the specified file path synchronously.
+ * @param path - The file path where the JSON should be written.
+ * @param object - The object to be written as JSON.
+ */
+function writeJsonSync(path, object) {
+    (0, fs_1.writeFileSync)(path, JSON.stringify(object));
+}
+/**
+ * Reads and parses a JSON file synchronously.
+ *
+ * @template T - The type of the parsed JSON object.
+ * @param {string} path - The path to the JSON file.
+ * @param {reviver.Reviver<any>} [reviver] - Optional reviver function for JSON.parse.
+ * @returns {T} - The parsed JSON object.
+ */
+function readJsonSync(path, reviver) {
+    const data = (0, fs_1.readFileSync)(path);
+    if (!data)
+        return;
+    const retVal = JSON.parse(data.toString(), reviver);
+    return retVal;
+}
+/**
+ * Inserts the specified data between the given placeholders in the file synchronously.
+ * If the file does not exist, it creates the file and inserts the data.
+ *
+ * @param filePath - The path of the file.
+ * @param data - The data to be inserted between the placeholders.
+ * @param beginPlaceHolder - The beginning placeholder.
+ * @param endPlaceHolder - The ending placeholder.
+ */
+function insertBetweenPlacweHoldersSync(filePath, data, beginPlaceHolder, endPlaceHolder) {
+    const writeData = (0, fs_1.readFileSync)(filePath, 'utf-8');
+    if (!(0, fs_1.existsSync)(filePath)) {
+        (0, fs_1.writeFileSync)(filePath, writeData);
+    }
+    const fileContent = (0, fs_1.readFileSync)(filePath).toString();
+    const top = fileContent?.split?.(beginPlaceHolder)?.[0];
+    const bottom = fileContent?.split?.(endPlaceHolder).reverse?.()?.[0];
+    (0, fs_1.writeFileSync)(filePath, `${top}\n\r${beginPlaceHolder}\n\r${data}\n\r${endPlaceHolder}\n\r${bottom}`);
+}
+/**
+ * Reads a file and returns an array of string lines.
+ *
+ * @param path - The path to the file.
+ * @param lineSeparator - The regular expression used to split the file into lines. Defaults to /[\n|\r]/.
+ * @returns An array of lines from the file, or null if the file cannot be read.
+ */
+function fileLinesSync(path, lineSeparator = /[\n|\r]/) {
+    try {
+        const data = (0, fs_1.readFileSync)(path)?.toString();
+        if (!data)
+            return null;
+        return data.split(lineSeparator);
+    }
+    catch (error) {
+        console.error(error);
+    }
+}
+/**
+ * Writes the given data to a file in GZip format synchronously.
+ *
+ * @param filePath - The path to the file.
+ * @param data - The data to be written to the file. It can be a string or a Buffer.
+ * @param writeFileOptions - The options for writing the file (optional).
+ * @param zLibOptions - The options for compressing the data using zlib (optional).
+ */
+function writeGZipSync(filePath, data, writeFileOptions, zLibOptions) {
+    const buffer = data instanceof Buffer ? data : Buffer.from(data);
+    const zippBuffer = (0, zlib_1.gzipSync)(buffer, zLibOptions);
+    (0, fs_1.writeFileSync)(filePath, zippBuffer, writeFileOptions);
+}
+/**
+ * Reads a gzipped file synchronously and returns the uncompressed data as a Buffer.
+ *
+ * @param path - The path to the gzipped file.
+ * @param readFileOptions - The options to pass to the `readFileSync` function.
+ * @param zlibOptions - The options to pass to the `unzipSync` function.
+ * @returns The uncompressed data as a Buffer.
+ */
+function readGZipSync(path, readFileOptions, zlibOptions) {
+    const data = (0, fs_1.readFileSync)(path, readFileOptions);
+    return (0, zlib_1.unzipSync)(data, zlibOptions);
+}
+/**
+ * Serializes an object to JSON and writes it to a file synchronously.
+ * @param filePath - The path of the file to write.
+ * @param object - The object to serialize and write to the file.
+ */
+function serealizeObjectSync(filePath, object) {
+    writeGZipSync(filePath, JSON.stringify(object));
+}
+/**
+ * Deserializes an object from a file synchronously.
+ *
+ * @param filePath - The path to the file.
+ * @returns The deserialized object.
+ */
+function deserealizeObjectSync(filePath) {
+    return JSON.parse(readGZipSync(filePath).toString());
+}
+/**
+ * Synchronous [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html). Returns `undefined`.
+ * @return `undefined` upon success.
+ * @see {@link unlinkSync}
+ */
+function removeSync(path) {
+    try {
+        (0, fs_1.unlinkSync)(path);
+    }
+    catch (e) {
+        if (e?.code !== 'ENOENT')
+            throw e;
+    }
+}
+/**
+ * check if file exists
+ *
+ *
+ * @param path file path
+ * @returns true if exists false otherwise
+ *
+ * @see{@link stat}
+ */
+const exists = (path) => (0, promises_1.stat)(path)
+    .then(() => true)
+    .catch(e => {
+    if (e?.code === 'ENOENT')
+        return false;
+    throw e;
+});
+exports.exists = exists;
+/**
+ * add to file, if the file or folder does not exist it will be recursively created
+ * @param path
+ * @param data
+ * @param options
+ * @returns
+ */
+function append(path, data, options) {
+    return (0, promises_1.appendFile)(path, data, options).catch(error => {
+        if (error.code === 'ENOENT')
+            return (0, promises_1.mkdir)((0, path_1.dirname)(path.toString()), { recursive: true }).then(() => append(path, data, options));
+        return error;
+    });
+}
+/**
+ * write to file, if the folder does not exist it will be recursively created
+ *
+ * @param file filename or `FileHandle`
+ * @param data
+ * @param options
+ * @return Fulfills with `undefined` upon success.
+ *
+ *
+ * @see{@link exists}
+ * @see{@link mkdir}
+ * @see{@link writeFile}
+ */
+function write(file, data, options) {
+    const dirPath = (0, path_1.dirname)(file.toString());
+    return (0, exports.exists)(dirPath).then(exist => {
+        const _opt = typeof options === 'string' ? { encoding: options } : options;
+        let promise = (0, promises_2.of)();
+        if (!exist)
+            promise = (0, promises_1.mkdir)(dirPath, { ..._opt, recursive: true });
+        return promise.then(() => (0, promises_1.writeFile)(file, data || '', options));
+    });
+}
+/**
+ * Asynchronously reads the entire contents of a file that contains a valid JSON string, and converts the content into an object.
+ *
+ * @param file filename or `FileHandle`
+ * @param options
+ * @param reviver A function that transforms the results. This function is called for each member of the object.
+ * If a member contains nested objects, the nested objects are transformed before the parent object is.
+ *
+ * @see{@link readFile}
+ * @see{@link JSON.parse}
+ */
+function readJson(file, options, reviver) {
+    return (0, promises_1.readFile)(file, options).then(fileContent => JSON.parse(fileContent.toString(), reviver));
+}
+/**
+ * Converts a JavaScript value to a JavaScript Object Notation (JSON) string, and asynchronously writes data to a file, replacing the file if it already exists.
+ *
+ * @param file filename or `FileHandle`
+ * @param obj A JavaScript value, usually an object or array, to be converted.
+ * @param replacer A function that transforms the results.
+ * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+ * @returns
+ * @see {@link JSON.stringify}
+ * @see {@link write}
+ */
+function writeJson(file, obj, options, replacer, space) {
+    const data = JSON.stringify(obj, replacer, space);
+    return write(file, data, options);
+}
+/**
+ * If `path` refers to a symbolic link, then the link is removed without affecting
+ * the file or directory to which that link refers. If the `path` refers to a file
+ * path that is not a symbolic link, the file is deleted. See the POSIX [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html) documentation for more detail.
+ * @return Fulfills with `undefined` upon success.
+ * @see {@link unlink}
+ */
+function remove(path) {
+    return (0, promises_1.unlink)(path).catch(e => (e.code === 'ENOENT' ? undefined : e));
+}
+/**
+ * Writes data to a file and creates the necessary directory structure if it doesn't exist.
+ *
+ * @param path - The path to the file.
+ * @param data - The data to write to the file.
+ * @param options - The options for writing the file.
+ */
+function writeFileAndDir(path, data, options) {
+    const parentDir = (0, path_1.resolve)(path, '..');
+    if (!(0, fs_1.existsSync)(parentDir)) {
+        (0, fs_1.mkdirSync)(parentDir, { recursive: true });
+    }
+    data = typeof data === 'string' ? new TextEncoder().encode(data) : data;
+    (0, fs_1.writeFileSync)(path, data, options);
+}
+function copyFileRecursive(origPath, destPath) {
+    const destParentDir = (0, path_1.resolve)(destPath, '..');
+    if (!(0, fs_1.existsSync)(destParentDir)) {
+        (0, fs_1.mkdirSync)(destParentDir, { recursive: true });
+    }
+    (0, fs_1.copyFileSync)(origPath, destPath);
+}
+/**
+ * remove sync, without throwing NotFound error if it doesn't exist
+ * @param path
+ * @param options
+ */
+function silentRemove(path, options) {
+    try {
+        (0, fs_1.rmSync)(path, options);
+    }
+    catch (error) {
+        if ((error.code !== 'ENOENT'))
+            throw error;
+    }
+}
+/**
+ * Calculates the SHA256 hash of a file.
+ *
+ * @param filePath - The path to the file.
+ * @returns The SHA256 hash of the file as a hexadecimal string.
+ */
+function sha256(filePath) {
+    const hash = (0, crypto_1.createHash)('sha256');
+    const input = (0, fs_1.readFileSync)(filePath);
+    hash.update(input);
+    return hash.digest('hex');
+}
+/**
+ * Tails a file and calls the callback with new data when the file is appended.
+ * @param filePath
+ * @param cb
+ * @returns
+ */
+function tail(filePath, cb) {
+    let previousFileSize = (0, fs_1.statSync)(filePath).size;
+    let previousCheckTime = 0;
+    return (0, fs_1.watch)(filePath, () => {
+        if (previousCheckTime === Date.now())
+            return;
+        previousCheckTime = Date.now();
+        const fileSize = (0, fs_1.statSync)(filePath).size;
+        if (fileSize === 0)
+            return;
+        const tailSize = fileSize - previousFileSize;
+        previousFileSize = fileSize;
+        if (tailSize <= 0)
+            return;
+        const buffer = new Uint8Array(tailSize);
+        const fd = (0, fs_1.openSync)(filePath, 'r');
+        (0, fs_1.readSync)(fd, buffer, 0, tailSize, fileSize - tailSize);
+        (0, fs_1.closeSync)(fd);
+        cb(buffer);
+    });
+}
+//# sourceMappingURL=files.js.map