@fgv/ts-json-base 5.0.1-8 → 5.0.1

package/dist/index.browser.js

@@ -0,0 +1,31 @@
+/*
+ * 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.
+ */
+import * as Converters from './packlets/converters';
+// eslint-disable-next-line @rushstack/packlets/mechanics
+import * as FileTree from './packlets/file-tree/index.browser';
+import * as JsonCompatible from './packlets/json-compatible';
+// eslint-disable-next-line @rushstack/packlets/mechanics
+import * as JsonFile from './packlets/json-file/index.browser';
+import * as Validators from './packlets/validators';
+export * from './packlets/json';
+export { Converters, FileTree, JsonCompatible, JsonFile, Validators };
+//# sourceMappingURL=index.browser.js.map

package/dist/index.js

@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+import * as Converters from './packlets/converters';
+import * as FileTree from './packlets/file-tree';
+import * as JsonCompatible from './packlets/json-compatible';
+import * as JsonFile from './packlets/json-file';
+import * as Validators from './packlets/validators';
+export * from './packlets/json';
+export { Converters, FileTree, JsonCompatible, JsonFile, Validators };
+//# sourceMappingURL=index.js.map

package/dist/packlets/converters/converters.js

@@ -0,0 +1,187 @@
+/*
+ * 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.
+ */
+import { Conversion, Converters as BaseConverters, StringConverter, fail, succeed } from '@fgv/ts-utils';
+import { isJsonArray, isJsonObject } from '../json';
+/**
+ * An converter which converts a supplied `unknown` value to a valid {@link JsonPrimitive | JsonPrimitive}.
+ * @public
+ */
+export const jsonPrimitive = new Conversion.BaseConverter((from, __self, ctx) => {
+    if (from === null) {
+        return succeed(null);
+    }
+    switch (typeof from) {
+        case 'boolean':
+        case 'string':
+            return succeed(from);
+        case 'number':
+            if (!Number.isNaN(from)) {
+                return succeed(from);
+            }
+            break;
+    }
+    return fail(`"${String(from)}": invalid JSON primitive.`);
+});
+/**
+ * An copying converter which converts a supplied `unknown` value into
+ * a valid {@link JsonObject | JsonObject}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Converters.IJsonConverterContext | context} at runtime.
+ *
+ * Guaranteed to return a new object.
+ * @public
+ */
+export const jsonObject = new Conversion.BaseConverter((from, __self, ctx) => {
+    if (!isJsonObject(from)) {
+        return fail('invalid JSON object.');
+    }
+    const obj = {};
+    const errors = [];
+    for (const [name, value] of Object.entries(from)) {
+        if (value === undefined && (ctx === null || ctx === void 0 ? void 0 : ctx.ignoreUndefinedProperties) === true) {
+            // optionally ignore undefined values
+            continue;
+        }
+        jsonValue
+            .convert(value, ctx)
+            .onSuccess((v) => {
+            obj[name] = v;
+            return succeed(v);
+        })
+            .onFailure((m) => {
+            errors.push(`${name}: ${m}`);
+            return fail(m);
+        });
+    }
+    if (errors.length > 0) {
+        return fail(`invalid JSON object:\n${errors.join('\n')}`);
+    }
+    return succeed(obj);
+});
+/**
+ * An copying converter which converts a supplied `unknown` value to
+ * a valid {@link JsonArray | JsonArray}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Converters.IJsonConverterContext | context} at runtime.
+ *
+ * Guaranteed to return a new array.
+ * @public
+ */
+export const jsonArray = new Conversion.BaseConverter((from, __self, ctx) => {
+    if (!isJsonArray(from)) {
+        return fail('not an array');
+    }
+    const arr = [];
+    const errors = [];
+    for (let i = 0; i < from.length; i++) {
+        const value = from[i];
+        if (value === undefined && (ctx === null || ctx === void 0 ? void 0 : ctx.ignoreUndefinedProperties) === true) {
+            // convert undefined to 'null' for parity with JSON.stringify
+            arr.push(null);
+            continue;
+        }
+        jsonValue
+            .convert(value, ctx)
+            .onSuccess((v) => {
+            arr.push(v);
+            return succeed(v);
+        })
+            .onFailure((m) => {
+            errors.push(`${i}: ${m}`);
+            return fail(m);
+        });
+    }
+    if (errors.length > 0) {
+        return fail(`array contains non-json elements:\n${errors.join('\n')}`);
+    }
+    return succeed(arr);
+});
+/**
+ * An copying converter which converts a supplied `unknown` value to a
+ * valid {@link JsonValue | JsonValue}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Converters.IJsonConverterContext | context} at runtime.
+ * @public
+ */
+export const jsonValue = new Conversion.BaseConverter((from, __self, ctx) => {
+    if (isJsonArray(from)) {
+        return jsonArray.convert(from, ctx);
+    }
+    else if (isJsonObject(from)) {
+        return jsonObject.convert(from, ctx);
+    }
+    return jsonPrimitive.convert(from, ctx);
+});
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `string`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * @public
+ */
+export const string = new StringConverter();
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `number`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+export const number = new Conversion.BaseConverter((from) => BaseConverters.number.convert(from));
+/**
+ * A {@link Converter | Converter} which converts `unknown` to a `boolean`.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+export const boolean = new Conversion.BaseConverter((from) => BaseConverters.boolean.convert(from));
+/**
+ * Helper to create a converter for a literal value.
+ * Accepts {@link Converters.IJsonConverterContext | IJsonConverterContext} but ignores it.
+ * Mirrors the behavior of `@fgv/ts-utils`.
+ * @public
+ */
+export function literal(value) {
+    return BaseConverters.literal(value);
+}
+/**
+ * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of
+ * supplied enumerated values. Anything else fails.
+ *
+ * @remarks
+ * This JSON variant accepts an {@link Converters.IJsonConverterContext | IJsonConverterContext} OR
+ * a `ReadonlyArray<T>` as its conversion context. If the context is an array, it is used to override the
+ * allowed values for that conversion; otherwise, the original `values` supplied at creation time are used.
+ *
+ * @param values - Array of allowed values.
+ * @param message - Optional custom failure message.
+ * @returns A new {@link Converter | Converter} returning `<T>`.
+ * @public
+ */
+export function enumeratedValue(values, message) {
+    return new Conversion.BaseConverter((from, __self, context) => {
+        const effectiveValues = Array.isArray(context) ? context : values;
+        const index = effectiveValues.indexOf(from);
+        if (index >= 0) {
+            return succeed(effectiveValues[index]);
+        }
+        return fail(message !== null && message !== void 0 ? message : `Invalid enumerated value ${JSON.stringify(from)}`);
+    });
+}
+//# sourceMappingURL=converters.js.map

package/dist/packlets/converters/index.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2020 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.
+ */
+export * from './converters';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,67 @@
+/*
+ * 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.
+ */
+import { captureResult } from '@fgv/ts-utils';
+/**
+ * Class representing a directory in a file tree.
+ * @public
+ */
+export 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 captureResult(() => new DirectoryItem(path, hal));
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}
+     */
+    getChildren() {
+        return this._hal.getChildren(this.absolutePath);
+    }
+}
+//# sourceMappingURL=directoryItem.js.map

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

@@ -0,0 +1,126 @@
+/*
+ * 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.
+ */
+import { captureResult, succeed } from '@fgv/ts-utils';
+/**
+ * Class representing a file in a file tree.
+ * @public
+ */
+export 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 captureResult(() => new FileItem(path, hal));
+    }
+    getContents(converter) {
+        return this._hal
+            .getFileContents(this.absolutePath)
+            .onSuccess((body) => captureResult(() => JSON.parse(body)).onFailure(() => succeed(body)))
+            .onSuccess((parsed) => {
+            if (converter !== undefined) {
+                return converter.convert(parsed);
+            }
+            return 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 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 succeed(provided);
+    }
+}
+//# sourceMappingURL=fileItem.js.map

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

@@ -0,0 +1,85 @@
+/*
+ * 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.
+ */
+import { captureResult, fail, succeed } from '@fgv/ts-utils';
+/**
+ * Represents a file tree.
+ * @public
+ */
+export 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 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 succeed(item);
+            }
+            return 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 succeed(item);
+            }
+            return fail(`${directoryPath}: not a directory`);
+        });
+    }
+}
+//# sourceMappingURL=fileTree.js.map

package/dist/packlets/file-tree/fileTreeAccessors.js

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+export {};
+//# sourceMappingURL=fileTreeAccessors.js.map

package/dist/packlets/file-tree/fileTreeHelpers.inMemory.js

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ */
+import { FileTree } from './fileTree';
+import { InMemoryTreeAccessors } from './in-memory';
+export function inMemory(files, params) {
+    params = typeof params === 'string' ? { prefix: params } : params;
+    return InMemoryTreeAccessors.create(files, params).onSuccess((hal) => FileTree.create(hal));
+}
+//# sourceMappingURL=fileTreeHelpers.inMemory.js.map

package/dist/packlets/file-tree/fileTreeHelpers.js

@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+import { captureResult } from '@fgv/ts-utils';
+import { FileTree } from './fileTree';
+import { FsFileTreeAccessors } from './fsTree';
+export function forFilesystem(params) {
+    params = typeof params === 'string' ? { prefix: params } : params;
+    return captureResult(() => new FsFileTreeAccessors(params)).onSuccess((hal) => FileTree.create(hal));
+}
+//# sourceMappingURL=fileTreeHelpers.js.map