@fgv/ts-json-base 5.0.0-9 → 5.0.1-0

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.8"
+      "packageVersion": "7.52.12"
     }
   ]
 }

package/eslint.config.js

@@ -0,0 +1,16 @@
+// ESLint 9 flat config
+const nodeProfile = require('@rushstack/eslint-config/flat/profile/node');
+const packletsPlugin = require('@rushstack/eslint-config/flat/mixins/packlets');
+const tsdocPlugin = require('@rushstack/eslint-config/flat/mixins/tsdoc');
+
+module.exports = [
+  ...nodeProfile,
+  packletsPlugin,
+  ...tsdocPlugin,
+  {
+    // Override specific rules if needed
+    rules: {
+      '@rushstack/packlets/mechanics': 'warn'
+    }
+  }
+];

package/lib/index.browser.d.ts

@@ -0,0 +1,7 @@
+import * as Converters from './packlets/converters';
+import * as FileTree from './packlets/file-tree/index.browser';
+import * as JsonFile from './packlets/json-file/index.browser';
+import * as Validators from './packlets/validators';
+export * from './packlets/json';
+export { Converters, FileTree, JsonFile, Validators };
+//# sourceMappingURL=index.browser.d.ts.map

package/lib/index.browser.js

@@ -0,0 +1,72 @@
+"use strict";
+/*
+ * Copyright (c) 2023 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validators = exports.JsonFile = exports.FileTree = exports.Converters = void 0;
+const Converters = __importStar(require("./packlets/converters"));
+exports.Converters = Converters;
+// eslint-disable-next-line @rushstack/packlets/mechanics
+const FileTree = __importStar(require("./packlets/file-tree/index.browser"));
+exports.FileTree = FileTree;
+// eslint-disable-next-line @rushstack/packlets/mechanics
+const JsonFile = __importStar(require("./packlets/json-file/index.browser"));
+exports.JsonFile = JsonFile;
+const Validators = __importStar(require("./packlets/validators"));
+exports.Validators = Validators;
+__exportStar(require("./packlets/json"), exports);
+//# sourceMappingURL=index.browser.js.map

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import * as Converters from './packlets/converters';
+import * as FileTree from './packlets/file-tree';
 import * as JsonFile from './packlets/json-file';
 import * as Validators from './packlets/validators';
 export * from './packlets/json';
-export { Converters, JsonFile, Validators };
+export { Converters, FileTree, JsonFile, Validators };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -57,9 +57,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Validators = exports.JsonFile = exports.Converters = void 0;
+exports.Validators = exports.JsonFile = exports.FileTree = exports.Converters = void 0;
 const Converters = __importStar(require("./packlets/converters"));
 exports.Converters = Converters;
+const FileTree = __importStar(require("./packlets/file-tree"));
+exports.FileTree = FileTree;
 const JsonFile = __importStar(require("./packlets/json-file"));
 exports.JsonFile = JsonFile;
 const Validators = __importStar(require("./packlets/validators"));

package/lib/packlets/file-tree/directoryItem.d.ts

@@ -0,0 +1,47 @@
+import { Result } from '@fgv/ts-utils';
+import { FileTreeItem, IFileTreeAccessors, IFileTreeDirectoryItem } from './fileTreeAccessors';
+/**
+ * Class representing a directory in a file tree.
+ * @public
+ */
+export declare class DirectoryItem<TCT extends string = string> implements IFileTreeDirectoryItem<TCT> {
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem."type"}
+     */
+    readonly type: 'directory';
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.absolutePath}
+     */
+    readonly absolutePath: string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.name}
+     */
+    get name(): string;
+    /**
+     * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.
+     * @public
+     */
+    protected readonly _hal: IFileTreeAccessors<TCT>;
+    /**
+     * Protected constructor for derived classes.
+     * @param path - Relative path of the directory.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    protected constructor(path: string, hal: IFileTreeAccessors<TCT>);
+    /**
+     * Creates a new DirectoryItem instance.
+     * @param path - Relative path of the directory.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @returns `Success` with the new {@link FileTree.DirectoryItem | DirectoryItem} instance if successful,
+     * or `Failure` with an error message otherwise.
+     */
+    static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<DirectoryItem<TCT>>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}
+     */
+    getChildren(): Result<ReadonlyArray<FileTreeItem<TCT>>>;
+}
+//# sourceMappingURL=directoryItem.d.ts.map

package/lib/packlets/file-tree/directoryItem.js

@@ -0,0 +1,71 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DirectoryItem = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * Class representing a directory in a file tree.
+ * @public
+ */
+class DirectoryItem {
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.name}
+     */
+    get name() {
+        return this._hal.getBaseName(this.absolutePath);
+    }
+    /**
+     * Protected constructor for derived classes.
+     * @param path - Relative path of the directory.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    constructor(path, hal) {
+        /**
+         * {@inheritdoc FileTree.IFileTreeDirectoryItem."type"}
+         */
+        this.type = 'directory';
+        this._hal = hal;
+        this.absolutePath = hal.resolveAbsolutePath(path);
+    }
+    /**
+     * Creates a new DirectoryItem instance.
+     * @param path - Relative path of the directory.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @returns `Success` with the new {@link FileTree.DirectoryItem | DirectoryItem} instance if successful,
+     * or `Failure` with an error message otherwise.
+     */
+    static create(path, hal) {
+        return (0, ts_utils_1.captureResult)(() => new DirectoryItem(path, hal));
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}
+     */
+    getChildren() {
+        return this._hal.getChildren(this.absolutePath);
+    }
+}
+exports.DirectoryItem = DirectoryItem;
+//# sourceMappingURL=directoryItem.js.map

package/lib/packlets/file-tree/fileItem.d.ts

@@ -0,0 +1,97 @@
+import { Result } from '@fgv/ts-utils';
+import { Converter, Validator } from '@fgv/ts-utils';
+import { JsonValue } from '../json';
+import { IFileTreeAccessors, IFileTreeFileItem } from './fileTreeAccessors';
+/**
+ * Class representing a file in a file tree.
+ * @public
+ */
+export declare class FileItem<TCT extends string = string> implements IFileTreeFileItem<TCT> {
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem."type"}
+     */
+    readonly type: 'file';
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.absolutePath}
+     */
+    readonly absolutePath: string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.name}
+     */
+    get name(): string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.baseName}
+     */
+    get baseName(): string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.extension}
+     */
+    get extension(): string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.contentType}
+     */
+    get contentType(): TCT | undefined;
+    /**
+     * Mutable content type of the file.
+     * @public
+     */
+    private _contentType;
+    /**
+     * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.
+     * @public
+     */
+    protected readonly _hal: IFileTreeAccessors<TCT>;
+    /**
+     * Protected constructor for derived classes.
+     * @param path - Relative path of the file.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    protected constructor(path: string, hal: IFileTreeAccessors<TCT>);
+    /**
+     * Creates a new {@link FileTree.FileItem} instance.
+     * @param path - Relative path of the file.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<FileItem<TCT>>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:1)}
+     */
+    getContents(): Result<JsonValue>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:2)}
+     */
+    getContents<T>(converter: Validator<T> | Converter<T>): Result<T>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.getRawContents}
+     */
+    getRawContents(): Result<string>;
+    /**
+     * Sets the content type of the file.
+     * @param contentType - The content type of the file.
+     */
+    setContentType(contentType: TCT | undefined): void;
+    /**
+     * Default function to infer the content type of a file.
+     * @param filePath - The path of the file.
+     * @returns `Success` with the content type of the file if successful, or
+     * `Failure` with an error message otherwise.
+     * @remarks This default implementation always returns `Success` with `undefined`.
+     * @public
+     */
+    static defaultInferContentType<TCT extends string = string>(__filePath: string, __provided?: string): Result<TCT | undefined>;
+    /**
+     * Default function to accept the content type of a file.
+     * @param filePath - The path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns `Success` with the content type of the file if successful, or
+     * `Failure` with an error message otherwise.
+     * @remarks This default implementation always returns `Success` with `undefined`.
+     * @public
+     */
+    static defaultAcceptContentType<TCT extends string = string>(__filePath: string, provided?: TCT): Result<TCT | undefined>;
+}
+//# sourceMappingURL=fileItem.d.ts.map

package/lib/packlets/file-tree/fileItem.js

@@ -0,0 +1,130 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileItem = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * Class representing a file in a file tree.
+ * @public
+ */
+class FileItem {
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.name}
+     */
+    get name() {
+        return this._hal.getBaseName(this.absolutePath);
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.baseName}
+     */
+    get baseName() {
+        return this._hal.getBaseName(this.absolutePath, this.extension);
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.extension}
+     */
+    get extension() {
+        return this._hal.getExtension(this.absolutePath);
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.contentType}
+     */
+    get contentType() {
+        return this._contentType;
+    }
+    /**
+     * Protected constructor for derived classes.
+     * @param path - Relative path of the file.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    constructor(path, hal) {
+        /**
+         * {@inheritdoc FileTree.IFileTreeFileItem."type"}
+         */
+        this.type = 'file';
+        this._hal = hal;
+        this.absolutePath = hal.resolveAbsolutePath(path);
+        this._contentType = hal.getFileContentType(this.absolutePath).orDefault();
+    }
+    /**
+     * Creates a new {@link FileTree.FileItem} instance.
+     * @param path - Relative path of the file.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    static create(path, hal) {
+        return (0, ts_utils_1.captureResult)(() => new FileItem(path, hal));
+    }
+    getContents(converter) {
+        return this._hal
+            .getFileContents(this.absolutePath)
+            .onSuccess((body) => (0, ts_utils_1.captureResult)(() => JSON.parse(body)).onFailure(() => (0, ts_utils_1.succeed)(body)))
+            .onSuccess((parsed) => {
+            if (converter !== undefined) {
+                return converter.convert(parsed);
+            }
+            return (0, ts_utils_1.succeed)(parsed);
+        });
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.getRawContents}
+     */
+    getRawContents() {
+        return this._hal.getFileContents(this.absolutePath);
+    }
+    /**
+     * Sets the content type of the file.
+     * @param contentType - The content type of the file.
+     */
+    setContentType(contentType) {
+        this._contentType = contentType;
+    }
+    /**
+     * Default function to infer the content type of a file.
+     * @param filePath - The path of the file.
+     * @returns `Success` with the content type of the file if successful, or
+     * `Failure` with an error message otherwise.
+     * @remarks This default implementation always returns `Success` with `undefined`.
+     * @public
+     */
+    static defaultInferContentType(__filePath, __provided) {
+        return (0, ts_utils_1.succeed)(undefined);
+    }
+    /**
+     * Default function to accept the content type of a file.
+     * @param filePath - The path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns `Success` with the content type of the file if successful, or
+     * `Failure` with an error message otherwise.
+     * @remarks This default implementation always returns `Success` with `undefined`.
+     * @public
+     */
+    static defaultAcceptContentType(__filePath, provided) {
+        return (0, ts_utils_1.succeed)(provided);
+    }
+}
+exports.FileItem = FileItem;
+//# sourceMappingURL=fileItem.js.map

package/lib/packlets/file-tree/fileTree.d.ts

@@ -0,0 +1,49 @@
+import { Result } from '@fgv/ts-utils';
+import { FileTreeItem, IFileTreeAccessors, IFileTreeDirectoryItem, IFileTreeFileItem } from './fileTreeAccessors';
+/**
+ * Represents a file tree.
+ * @public
+ */
+export declare class FileTree<TCT extends string = string> {
+    /**
+     * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.
+     * @public
+     */
+    hal: IFileTreeAccessors<TCT>;
+    /**
+     * Protected constructor for derived classes.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    protected constructor(hal: IFileTreeAccessors<TCT>);
+    /**
+     * Creates a new {@link FileTree} instance with the supplied
+     * accessors.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     */
+    static create<TCT extends string = string>(hal: IFileTreeAccessors<TCT>): Result<FileTree<TCT>>;
+    /**
+     * Gets an item from the tree.
+     * @param itemPath - The path to the item.
+     * @returns `Success` with the item if successful,
+     * or `Failure` with an error message otherwise.
+     */
+    getItem(itemPath: string): Result<FileTreeItem<TCT>>;
+    /**
+     * Gets a file item from the tree.
+     * @param filePath - The path to the file.
+     * @returns `Success` with the {@link FileTree.IFileTreeFileItem | file item}
+     * if successful, or `Failure` with an error message otherwise.
+     */
+    getFile(filePath: string): Result<IFileTreeFileItem<TCT>>;
+    /**
+     * Gets a directory item from the tree.
+     * @param directoryPath - The path to the directory.
+     * @returns `Success` with the {@link FileTree.IFileTreeDirectoryItem | directory item}
+     * if successful, or `Failure` with an error message otherwise.
+     */
+    getDirectory(directoryPath: string): Result<IFileTreeDirectoryItem<TCT>>;
+}
+//# sourceMappingURL=fileTree.d.ts.map

package/lib/packlets/file-tree/fileTree.js

@@ -0,0 +1,89 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileTree = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * Represents a file tree.
+ * @public
+ */
+class FileTree {
+    /**
+     * Protected constructor for derived classes.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    constructor(hal) {
+        this.hal = hal;
+    }
+    /**
+     * Creates a new {@link FileTree} instance with the supplied
+     * accessors.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     */
+    static create(hal) {
+        return (0, ts_utils_1.captureResult)(() => new FileTree(hal));
+    }
+    /**
+     * Gets an item from the tree.
+     * @param itemPath - The path to the item.
+     * @returns `Success` with the item if successful,
+     * or `Failure` with an error message otherwise.
+     */
+    getItem(itemPath) {
+        const absolutePath = this.hal.resolveAbsolutePath(itemPath);
+        return this.hal.getItem(absolutePath);
+    }
+    /**
+     * Gets a file item from the tree.
+     * @param filePath - The path to the file.
+     * @returns `Success` with the {@link FileTree.IFileTreeFileItem | file item}
+     * if successful, or `Failure` with an error message otherwise.
+     */
+    getFile(filePath) {
+        return this.getItem(filePath).onSuccess((item) => {
+            if (item.type === 'file') {
+                return (0, ts_utils_1.succeed)(item);
+            }
+            return (0, ts_utils_1.fail)(`${filePath}: not a file`);
+        });
+    }
+    /**
+     * Gets a directory item from the tree.
+     * @param directoryPath - The path to the directory.
+     * @returns `Success` with the {@link FileTree.IFileTreeDirectoryItem | directory item}
+     * if successful, or `Failure` with an error message otherwise.
+     */
+    getDirectory(directoryPath) {
+        return this.getItem(directoryPath).onSuccess((item) => {
+            if (item.type === 'directory') {
+                return (0, ts_utils_1.succeed)(item);
+            }
+            return (0, ts_utils_1.fail)(`${directoryPath}: not a directory`);
+        });
+    }
+}
+exports.FileTree = FileTree;
+//# sourceMappingURL=fileTree.js.map