@breadstone-infrastructure/utilities 0.0.12-beta.0

package/IO/TemporaryFile.js

@@ -0,0 +1,77 @@
+"use strict";
+// #region Imports
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemporaryFile = void 0;
+const fse = __importStar(require("fs-extra"));
+const Path_1 = require("./Path");
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
+// #endregion
+/**
+ * The `TemporaryFile` class.
+ * A temporary file class. Delete when disposing.
+ *
+ * @public
+ */
+class TemporaryFile {
+    // #region Fields
+    _path;
+    // #endregion
+    // #region Ctor
+    /**
+     * Constructs a new instance of the `TemporaryFile` class.
+     *
+     * @public
+     */
+    constructor() {
+        const tmpDir = (0, node_os_1.tmpdir)();
+        this._path = Path_1.Path.combine(fse.mkdtempSync(`${tmpDir}${node_path_1.sep}`), Path_1.Path.getRandomFileName(true));
+    }
+    // #endregion
+    // #region Properties
+    /**
+     * Gets the path to the temporary file.
+     *
+     * @public
+     */
+    get path() {
+        return this._path;
+    }
+    // #endregion
+    // #region Methods
+    /**
+     * Disposes of the temporary file by deleting it if it exists.
+     *
+     * @public
+     */
+    dispose() {
+        if (fse.existsSync(this._path)) {
+            fse.removeSync(this._path);
+        }
+    }
+}
+exports.TemporaryFile = TemporaryFile;
+//# sourceMappingURL=TemporaryFile.js.map

package/IO/TemporaryFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemporaryFile.js","sourceRoot":"","sources":["../../src/IO/TemporaryFile.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;AAElB,8CAAgC;AAChC,iCAA8B;AAC9B,qCAAiC;AACjC,yCAAgC;AAEhC,aAAa;AAEb;;;;;GAKG;AACH,MAAa,aAAa;IAEtB,iBAAiB;IAEA,KAAK,CAAS;IAE/B,aAAa;IAEb,eAAe;IAEf;;;;OAIG;IACH;QACI,MAAM,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,WAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,MAAM,GAAG,eAAG,EAAE,CAAC,EAAE,WAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;IAChG,CAAC;IAED,aAAa;IAEb,qBAAqB;IAErB;;;;OAIG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,aAAa;IAEb,kBAAkB;IAElB;;;;OAIG;IACI,OAAO;QACV,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;IACL,CAAC;CAIJ;AAlDD,sCAkDC"}

package/IO/Writer/Interfaces/IFileWriter.d.ts

@@ -0,0 +1,31 @@
+import type * as fs from 'fs';
+/**
+ * Interface for a file writer.
+ *
+ * @public
+ */
+export interface IFileWriter {
+    /**
+     * Writes text to the file without a newline character.
+     *
+     * @param message - The text to write.
+     */
+    write(message: string): void;
+    /**
+     * Writes text to the file including a newline character.
+     *
+     * @param message - The text to write.
+     */
+    writeLine(message: string): void;
+    /**
+     * Disposes the writer and releases internal resources.
+     */
+    dispose(): void;
+    /**
+     * Provides a writable stream for advanced use cases.
+     *
+     * @returns A writable stream or `null` if the writer is not available.
+     */
+    getWritableStream(): fs.WriteStream | null;
+}
+//# sourceMappingURL=IFileWriter.d.ts.map

package/IO/Writer/Interfaces/IFileWriter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileWriter.d.ts","sourceRoot":"","sources":["../../../../src/IO/Writer/Interfaces/IFileWriter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,EAAE,MAAM,IAAI,CAAC;AAI9B;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAExB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;OAIG;IACH,iBAAiB,IAAI,EAAE,CAAC,WAAW,GAAG,IAAI,CAAC;CAE9C"}

package/IO/Writer/Interfaces/IFileWriter.js

@@ -0,0 +1,4 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFileWriter.js.map

package/IO/Writer/Interfaces/IFileWriter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileWriter.js","sourceRoot":"","sources":["../../../../src/IO/Writer/Interfaces/IFileWriter.ts"],"names":[],"mappings":";AAAA,kBAAkB"}

package/IO/Writer/TextFileWriter.d.ts

@@ -0,0 +1,56 @@
+import * as fs from 'fs';
+import type { IFileWriter } from './Interfaces/IFileWriter';
+/**
+ * Provides clean access to a simple output text file.
+ *
+ * @public
+ */
+export declare class TextFileWriter implements IFileWriter {
+    private readonly _fileName;
+    private readonly _encoding;
+    private _writer;
+    private _isDisposed;
+    /**
+     * Initializes a new instance that will write to the specified file path/name.
+     *
+     * @param fileName - The file path/name to write to.
+     * @param encoding - The file encoding.
+     */
+    constructor(fileName: string, encoding?: BufferEncoding);
+    /**
+     * Disposes the writer and releases internal resources.
+     */
+    dispose(): void;
+    /**
+     * Writes text to the file without a newline character.
+     *
+     * @param message - The text to write.
+     */
+    write(message: string): void;
+    /**
+     * Writes text to the file including a newline character.
+     *
+     * @param message - The text to write.
+     */
+    writeLine(message: string): void;
+    /**
+     * Provides a writable stream for advanced use cases.
+     *
+     * @returns A writable stream.
+     */
+    getWritableStream(): fs.WriteStream | null;
+    /**
+     * Ensures that the writer is initialized and ready for writing.
+     *
+     * @returns `true` if the writer is ready; otherwise, `false`.
+     */
+    private ensureWriter;
+    /**
+     * Provides a fallback mechanism for encoding with replacement fallbacks.
+     *
+     * @param encoding - The desired encoding.
+     * @returns The fallback-safe encoding.
+     */
+    private getEncodingWithFallback;
+}
+//# sourceMappingURL=TextFileWriter.d.ts.map

package/IO/Writer/TextFileWriter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextFileWriter.d.ts","sourceRoot":"","sources":["../../../src/IO/Writer/TextFileWriter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE5D;;;;GAIG;AACH,qBAAa,cAAe,YAAW,WAAW;IAI9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,OAAO,CAA+B;IAC9C,OAAO,CAAC,WAAW,CAAkB;IAMrC;;;;;OAKG;gBACgB,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,cAAwB;IASvE;;OAEG;IACI,OAAO,IAAI,IAAI;IAWtB;;;;OAIG;IACI,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMnC;;;;OAIG;IACI,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMvC;;;;OAIG;IACI,iBAAiB,IAAI,EAAE,CAAC,WAAW,GAAG,IAAI;IAIjD;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAiBpB;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;CAQlC"}

package/IO/Writer/TextFileWriter.js

@@ -0,0 +1,129 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextFileWriter = void 0;
+const fs = __importStar(require("fs"));
+/**
+ * Provides clean access to a simple output text file.
+ *
+ * @public
+ */
+class TextFileWriter {
+    // #region Fields
+    _fileName;
+    _encoding;
+    _writer = null;
+    _isDisposed = false;
+    // #endregion
+    // #region Ctor
+    /**
+     * Initializes a new instance that will write to the specified file path/name.
+     *
+     * @param fileName - The file path/name to write to.
+     * @param encoding - The file encoding.
+     */
+    constructor(fileName, encoding = 'utf-8') {
+        this._fileName = fileName;
+        this._encoding = this.getEncodingWithFallback(encoding);
+    }
+    // #endregion
+    // #region Methods
+    /**
+     * Disposes the writer and releases internal resources.
+     */
+    dispose() {
+        if (!this._isDisposed) {
+            if (this._writer) {
+                this._writer.end();
+                this._writer.close();
+                this._writer = null;
+            }
+            this._isDisposed = true;
+        }
+    }
+    /**
+     * Writes text to the file without a newline character.
+     *
+     * @param message - The text to write.
+     */
+    write(message) {
+        if (this.ensureWriter()) {
+            this._writer?.write(message, this._encoding);
+        }
+    }
+    /**
+     * Writes text to the file including a newline character.
+     *
+     * @param message - The text to write.
+     */
+    writeLine(message) {
+        if (this.ensureWriter()) {
+            this._writer?.write(`${message}\n`, this._encoding);
+        }
+    }
+    /**
+     * Provides a writable stream for advanced use cases.
+     *
+     * @returns A writable stream.
+     */
+    getWritableStream() {
+        return this.ensureWriter() ? this._writer : null;
+    }
+    /**
+     * Ensures that the writer is initialized and ready for writing.
+     *
+     * @returns `true` if the writer is ready; otherwise, `false`.
+     */
+    ensureWriter() {
+        if (!this._writer) {
+            if (this._fileName) {
+                try {
+                    this._writer = fs.createWriteStream(this._fileName, {
+                        encoding: this._encoding,
+                        flags: 'w',
+                        highWaterMark: 4096
+                    });
+                }
+                catch {
+                    this._writer = null;
+                }
+            }
+        }
+        return this._writer !== null;
+    }
+    /**
+     * Provides a fallback mechanism for encoding with replacement fallbacks.
+     *
+     * @param encoding - The desired encoding.
+     * @returns The fallback-safe encoding.
+     */
+    getEncodingWithFallback(encoding) {
+        // Node.js does not provide direct equivalents for EncoderFallback or DecoderFallback.
+        // The fallback behavior is implicit in Node.js for unsupported sequences (e.g., replacing with `�`).
+        return encoding;
+    }
+}
+exports.TextFileWriter = TextFileWriter;
+//# sourceMappingURL=TextFileWriter.js.map

package/IO/Writer/TextFileWriter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextFileWriter.js","sourceRoot":"","sources":["../../../src/IO/Writer/TextFileWriter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AAGzB;;;;GAIG;AACH,MAAa,cAAc;IAEvB,iBAAiB;IAEA,SAAS,CAAS;IAClB,SAAS,CAAiB;IACnC,OAAO,GAA0B,IAAI,CAAC;IACtC,WAAW,GAAY,KAAK,CAAC;IAErC,aAAa;IAEb,eAAe;IAEf;;;;;OAKG;IACH,YAAmB,QAAgB,EAAE,WAA2B,OAAO;QACnE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,aAAa;IAEb,kBAAkB;IAElB;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACpB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;gBACnB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACxB,CAAC;YACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC5B,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAe;QACxB,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,OAAe;QAC5B,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,OAAO,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACxD,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,iBAAiB;QACpB,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACK,YAAY;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,IAAI,CAAC;oBACD,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,EAAE;wBAChD,QAAQ,EAAE,IAAI,CAAC,SAAS;wBACxB,KAAK,EAAE,GAAG;wBACV,aAAa,EAAE,IAAI;qBACtB,CAAC,CAAC;gBACP,CAAC;gBAAC,MAAM,CAAC;oBACL,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACK,uBAAuB,CAAC,QAAwB;QACpD,sFAAsF;QACtF,qGAAqG;QACrG,OAAO,QAAQ,CAAC;IACpB,CAAC;CAIJ;AA7GD,wCA6GC"}

package/IO/vNext/FileCache.d.ts

@@ -0,0 +1,46 @@
+import type { IFileCache, IFileCacheOptions } from './Interfaces/IFileCache.js';
+/**
+ * Implementation of the local file cache.
+ */
+export declare class FileCache implements IFileCache {
+    private readonly _options;
+    /**
+     * Initializes a new instance of the FileCache class.
+     *
+     * @public
+     * @param options - The options for the cache.
+     */
+    constructor(options: IFileCacheOptions);
+    /**
+     * Checks if a directory is cached.
+     * @param dirPath - The directory to check.
+     * @returns A promise resolving to `true` if the directory is cached, otherwise `false`.
+     */
+    isDirectoryCached(dirPath: string): Promise<boolean>;
+    /**
+     * Checks if a file is cached.
+     * If not and caching is enabled, the file will be cached.
+     * @param file - The file to check.
+     * @returns A promise resolving to `true` if the file is cached, otherwise `false`.
+     */
+    isFileCached(file: string): Promise<boolean>;
+    /**
+     * Gets the token of a file.
+     * The token is used to identify the file in the cache.
+     * @param file - The file for which to generate a token.
+     * @returns The token of the file.
+     */
+    getFileToken(file: string): string;
+    /**
+     * Deletes a file from the cache.
+     * @param token - The token of the file to delete.
+     */
+    deleteFile(token: string): void;
+    /**
+     * Writes data to the cache directory as a hashed file.
+     * @param data - The data to write.
+     * @returns `true` if the file already exists in the cache, otherwise `false`.
+     */
+    private writeToFile;
+}
+//# sourceMappingURL=FileCache.d.ts.map

package/IO/vNext/FileCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileCache.d.ts","sourceRoot":"","sources":["../../../src/IO/vNext/FileCache.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAOhF;;GAEG;AACH,qBAAa,SAAU,YAAW,UAAU;IAIxC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAM7C;;;;;OAKG;gBACgB,OAAO,EAAE,iBAAiB;IAY7C;;;;OAIG;IACU,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAWjE;;;;;OAKG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASzD;;;;;OAKG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAKzC;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOtC;;;;OAIG;IACH,OAAO,CAAC,WAAW;CAYtB"}

package/IO/vNext/FileCache.js

@@ -0,0 +1,94 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileCache = void 0;
+const File_js_1 = require("../File.js");
+const Path_js_1 = require("../Path.js");
+const String_js_1 = require("../../System/String.js");
+// #endregion
+/**
+ * Implementation of the local file cache.
+ */
+class FileCache {
+    // #region Fields
+    _options;
+    // #endregion
+    // #region Ctor
+    /**
+     * Initializes a new instance of the FileCache class.
+     *
+     * @public
+     * @param options - The options for the cache.
+     */
+    constructor(options) {
+        if (!options.dirPath) {
+            throw new Error('The cache directory must be specified.');
+        }
+        this._options = options;
+    }
+    // #endregion
+    // #region Methods
+    /**
+     * Checks if a directory is cached.
+     * @param dirPath - The directory to check.
+     * @returns A promise resolving to `true` if the directory is cached, otherwise `false`.
+     */
+    async isDirectoryCached(dirPath) {
+        if (!this._options.enabled) {
+            return false;
+        }
+        const files = File_js_1.File.glob(dirPath);
+        const fileContents = await Promise.all(files.map((x) => File_js_1.File.readAllBytes(x)));
+        const aggregatedData = Buffer.concat(fileContents);
+        return this.writeToFile(aggregatedData.toString());
+    }
+    /**
+     * Checks if a file is cached.
+     * If not and caching is enabled, the file will be cached.
+     * @param file - The file to check.
+     * @returns A promise resolving to `true` if the file is cached, otherwise `false`.
+     */
+    async isFileCached(file) {
+        if (!this._options.enabled) {
+            return Promise.resolve(false);
+        }
+        const fileContent = File_js_1.File.readAllText(file);
+        return Promise.resolve(this.writeToFile(fileContent));
+    }
+    /**
+     * Gets the token of a file.
+     * The token is used to identify the file in the cache.
+     * @param file - The file for which to generate a token.
+     * @returns The token of the file.
+     */
+    getFileToken(file) {
+        const data = File_js_1.File.readAllText(file);
+        return String_js_1.StringExtensions.md5(data);
+    }
+    /**
+     * Deletes a file from the cache.
+     * @param token - The token of the file to delete.
+     */
+    deleteFile(token) {
+        const cacheFile = Path_js_1.Path.combine(this._options.dirPath, token);
+        if (File_js_1.File.exists(cacheFile)) {
+            File_js_1.File.delete(cacheFile);
+        }
+    }
+    /**
+     * Writes data to the cache directory as a hashed file.
+     * @param data - The data to write.
+     * @returns `true` if the file already exists in the cache, otherwise `false`.
+     */
+    writeToFile(data) {
+        const hash = String_js_1.StringExtensions.md5(data);
+        const cacheFile = Path_js_1.Path.combine(this._options.dirPath, hash);
+        if (File_js_1.File.exists(cacheFile)) {
+            return true;
+        }
+        File_js_1.File.writeAllText(cacheFile, '');
+        return false;
+    }
+}
+exports.FileCache = FileCache;
+//# sourceMappingURL=FileCache.js.map

package/IO/vNext/FileCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileCache.js","sourceRoot":"","sources":["../../../src/IO/vNext/FileCache.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;AAGlB,wCAAkC;AAClC,wCAAkC;AAClC,sDAA0D;AAE1D,aAAa;AAEb;;GAEG;AACH,MAAa,SAAS;IAElB,iBAAiB;IAEA,QAAQ,CAAoB;IAE7C,aAAa;IAEb,eAAe;IAEf;;;;;OAKG;IACH,YAAmB,OAA0B;QACzC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAED,aAAa;IAEb,kBAAkB;IAElB;;;;OAIG;IACI,KAAK,CAAC,iBAAiB,CAAC,OAAe;QAC1C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,KAAK,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY;QAClC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC;QAED,MAAM,WAAW,GAAG,cAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,IAAY;QAC5B,MAAM,IAAI,GAAG,cAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO,4BAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,KAAa;QAC3B,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC7D,IAAI,cAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,cAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,IAAY;QAC5B,MAAM,IAAI,GAAG,4BAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC5D,IAAI,cAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,cAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC;IACjB,CAAC;CAIJ;AAlGD,8BAkGC"}

package/IO/vNext/FileSystem.d.ts

@@ -0,0 +1,107 @@
+import type { JSONObject } from '../Json.js';
+import type { IResxEntry } from '../Resx.js';
+import type { IFileSystem } from './Interfaces/IFileSystem.js';
+/**
+ * Implementation of the IFileSystem interface.
+ *
+ * @public
+ */
+export declare class FileSystem implements IFileSystem {
+    /**
+     * Constructs a new instance of the `FileSystem` class.
+     *
+     * @public
+     */
+    constructor();
+    /**
+     * Finds files matching a glob pattern.
+     *
+     * @public
+     * @param pattern - The glob pattern to search for.
+     * @returns An array of file paths matching the pattern.
+     */
+    glob(pattern: string | Array<string>): Array<string>;
+    /**
+     * Reads all text from a file.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @returns The content of the file as a string.
+     */
+    readAllText(filePath: string): string;
+    /**
+     * Writes text to a file, creating directories if necessary.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @param content - The content to write to the file.
+     */
+    writeAllText(filePath: string, content: string): void;
+    /**
+     * Reads all entries from a .resx file.
+     *
+     * @public
+     * @param filePath - The path to the .resx file.
+     * @returns An array of key-value-comment objects from the .resx file.
+     */
+    readAllResx(filePath: string): Array<IResxEntry>;
+    /**
+     * Reads all JSON from a file.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @returns The JSON content of the file.
+     */
+    readAllJson(filePath: string): JSONObject;
+    /**
+     * Gets the file name without its extension.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @returns The file name without extension.
+     */
+    getFileNameWithoutExtension(filePath: string): string;
+    /**
+     * Gets the file name from a file path.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @returns The file name.
+     */
+    getFileName(filePath: string): string;
+    /**
+     * Extracts the locale from a file name.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @param defaultLocale - The default locale to return if no locale is found.
+     * @returns The locale extracted from the file name.
+     */
+    getLocale(filePath: string, defaultLocale?: string): string;
+    /**
+     * Checks if a file exists.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @returns `true` if the file exists, or `false` otherwise
+     */
+    exists(filePath: string): boolean;
+    /**
+     * Checks if a file is cached.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @returns A promise resolving to whether the file is cached.
+     */
+    isFileOrDirectory(inputPath: string): 'file' | 'directory' | 'unknown';
+    /**
+     * Changes the extension of a file path.
+     *
+     * @public
+     * @param filePath - The file path to change.
+     * @param extension - The new extension to use.
+     * @returns The file path with the new extension.
+     */
+    changeExtension(filePath: string, extension: string): string;
+}
+//# sourceMappingURL=FileSystem.d.ts.map

package/IO/vNext/FileSystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../../../src/IO/vNext/FileSystem.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAI/D;;;;GAIG;AACH,qBAAa,UAAW,YAAW,WAAW;IAI1C;;;;OAIG;;IAQH;;;;;;OAMG;IACI,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;IAI3D;;;;;;OAMG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;;;OAMG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAI5D;;;;;;OAMG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC;IAIvD;;;;;;OAMG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IAIhD;;;;;;OAMG;IACI,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5D;;;;;;OAMG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;;;;OAOG;IACI,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,GAAE,MAAa,GAAG,MAAM;IAIxE;;;;;;OAMG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;;;OAMG;IACI,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,SAAS;IAgB7E;;;;;;;OAOG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;CAMtE"}