@fgv/ts-json-base 5.1.0-3 → 5.1.0-31

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

@@ -105,6 +105,7 @@ declare namespace Converters {
     export {
         literal,
         enumeratedValue,
+        stringifiedJson,
         jsonConverter,
         IJsonConverterContext,
         jsonPrimitive,
@@ -345,7 +346,9 @@ declare class FileItem<TCT extends string = string> implements IMutableFileTreeF
      */
     static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<FileItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
+     * Indicates whether this file can be saved.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     getIsMutable(): DetailedResult<boolean, SaveDetail>;
     /**
@@ -366,15 +369,20 @@ declare class FileItem<TCT extends string = string> implements IMutableFileTreeF
      */
     setContentType(contentType: TCT | undefined): void;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
+     * Sets the contents of the file from a JSON value.
+     * @param json - The JSON value to serialize and save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setContents(json: JsonValue): Result<JsonValue>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
+     * Sets the raw contents of the file.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setRawContents(contents: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.delete}
+     * Deletes this file from its backing store.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     delete(): Result<boolean>;
     /**
@@ -542,55 +550,86 @@ declare class FsFileTreeAccessors<TCT extends string = string> implements IMutab
      */
     constructor(params?: IFileTreeInitParams<TCT>);
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param itemPath - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(itemPath: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param itemPath - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(itemPath: string, suffix?: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath: string): Result<FileTreeItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(filePath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param filePath - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(filePath: string, provided?: string): Result<TCT | undefined>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param dirPath - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(dirPath: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path: string, contents: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param dirPath - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(dirPath: string): Result<boolean>;
 }
@@ -1011,56 +1050,87 @@ declare class InMemoryTreeAccessors<TCT extends string = string> implements IMut
      */
     static create<TCT extends string = string>(files: IInMemoryFile<TCT>[], params?: IFileTreeInitParams<TCT>): Result<InMemoryTreeAccessors<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
+     * Resolves paths to an absolute path.
+     * @param paths - Paths to resolve.
+     * @returns The resolved absolute path.
      */
     resolveAbsolutePath(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getExtension}
+     * Gets the extension of a path.
+     * @param path - Path to get the extension of.
+     * @returns The extension of the path.
      */
     getExtension(path: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getBaseName}
+     * Gets the base name of a path.
+     * @param path - Path to get the base name of.
+     * @param suffix - Optional suffix to remove from the base name.
+     * @returns The base name of the path.
      */
     getBaseName(path: string, suffix?: string): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.joinPaths}
+     * Joins paths together.
+     * @param paths - Paths to join.
+     * @returns The joined paths.
      */
     joinPaths(...paths: string[]): string;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
+     * Gets an item from the file tree.
+     * @param itemPath - Path of the item to get.
+     * @returns The item if it exists.
      */
     getItem(itemPath: string): Result<FileTreeItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
+     * Gets the contents of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @returns The contents of the file.
      */
     getFileContents(path: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getFileContentType}
+     * Gets the content type of a file in the file tree.
+     * @param path - Absolute path of the file.
+     * @param provided - Optional supplied content type.
+     * @returns The content type of the file.
      */
     getFileContentType(path: string, provided?: string): Result<TCT | undefined>;
     /**
-     * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
+     * Gets the children of a directory in the file tree.
+     * @param path - Path of the directory.
+     * @returns The children of the directory.
      */
     getChildren(path: string): Result<ReadonlyArray<FileTreeItem<TCT>>>;
     private _addMutableFile;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.createDirectory}
+     * Creates a directory at the given path, including any missing parent directories.
+     * @param dirPath - The path of the directory to create.
+     * @returns `Success` with the absolute path if created, or `Failure` with an error message.
      */
     createDirectory(dirPath: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.fileIsMutable}
+     * Checks if a file at the given path can be saved.
+     * @param path - The path to check.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteFile}
+     * Deletes a file at the given path.
+     * @param path - The path of the file to delete.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     deleteFile(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.deleteDirectory}
+     * Deletes a directory at the given path.
+     * The directory must be empty or the operation will fail.
+     * @param path - The path of the directory to delete.
+     * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.
      */
     deleteDirectory(path: string): Result<boolean>;
     /**
-     * {@inheritDoc FileTree.IMutableFileTreeAccessors.saveFileContents}
+     * Saves the contents to a file at the given path.
+     * @param path - The path of the file to save.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     saveFileContents(path: string, contents: string): Result<string>;
 }
@@ -1750,6 +1820,34 @@ declare const string: StringConverter<string, IJsonConverterContext>;
  */
 declare const string_2: Validation.Classes.StringValidator<string, IJsonValidatorContext>;
 
+/**
+ * Creates a converter that accepts a string, parses it as JSON, and optionally
+ * applies the supplied inner converter or validator to the parsed value.
+ *
+ * @remarks
+ * Unlike {@link Converters.jsonConverter}, the inner step is optional. When omitted, the
+ * converter resolves to the parsed `JsonValue` (object, array, or primitive).
+ * Both `Converter<T>` and `Validator<T>` are accepted because both expose
+ * `convert(unknown): Result<T>`.
+ *
+ * @param inner - Optional `Converter<T>` or `Validator<T>` applied to the
+ * parsed JSON value.
+ * @returns Converter that parses a JSON string into `T` (or `JsonValue` when
+ * no inner step is supplied).
+ * @public
+ */
+declare function stringifiedJson(): Converter<JsonValue>;
+
+/**
+ * Creates a converter that accepts a string, parses it as JSON, and applies
+ * the supplied inner converter or validator to the parsed value.
+ *
+ * @param inner - `Converter<T>` or `Validator<T>` applied to the parsed JSON.
+ * @returns Converter that parses a JSON string into `T`.
+ * @public
+ */
+declare function stringifiedJson<T>(inner: Converter<T> | Validator<T>): Converter<T>;
+
 /**
  * A validator which validates a supplied `unknown` value to a valid {@link JsonCompatibleType | JsonCompatible} value.
  * @public

package/dist/tsdoc-metadata.json

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

package/lib/index.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAE7D,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}

package/lib/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAS3C,gCAAU;AARnB,yDAAyD;AACzD,6EAA+D;AAO1C,4BAAQ;AAN7B,2EAA6D;AAM9B,wCAAc;AAL7C,yDAAyD;AACzD,6EAA+D;AAIhB,4BAAQ;AAHvD,kEAAoD;AAGK,gCAAU;AADnE,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as FileTree from './packlets/file-tree/index.browser';\nimport * as JsonCompatible from './packlets/json-compatible';\n// eslint-disable-next-line @rushstack/packlets/mechanics\nimport * as JsonFile from './packlets/json-file/index.browser';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, Validators };\n"]}

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAO3C,gCAAU;AANnB,+DAAiD;AAM5B,4BAAQ;AAL7B,2EAA6D;AAK9B,wCAAc;AAJ7C,+DAAiD;AAIF,4BAAQ;AAHvD,kEAAoD;AAGK,gCAAU;AADnE,kDAAgC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as Converters from './packlets/converters';\nimport * as FileTree from './packlets/file-tree';\nimport * as JsonCompatible from './packlets/json-compatible';\nimport * as JsonFile from './packlets/json-file';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, FileTree, JsonCompatible, JsonFile, Validators };\n"]}

package/lib/packlets/converters/converters.d.ts

@@ -1,4 +1,4 @@
-import { Converter, StringConverter } from '@fgv/ts-utils';
+import { Converter, StringConverter, Validator } from '@fgv/ts-utils';
 import { JsonArray, JsonObject, JsonPrimitive, JsonValue } from '../json';
 /**
  * Conversion context for JSON converters.
@@ -82,6 +82,32 @@ export declare function literal<T>(value: T): Converter<T, IJsonConverterContext
  * @public
  */
 export declare function enumeratedValue<T>(values: ReadonlyArray<T>, message?: string): Converter<T, IJsonConverterContext | ReadonlyArray<T>>;
+/**
+ * Creates a converter that accepts a string, parses it as JSON, and optionally
+ * applies the supplied inner converter or validator to the parsed value.
+ *
+ * @remarks
+ * Unlike {@link Converters.jsonConverter}, the inner step is optional. When omitted, the
+ * converter resolves to the parsed `JsonValue` (object, array, or primitive).
+ * Both `Converter<T>` and `Validator<T>` are accepted because both expose
+ * `convert(unknown): Result<T>`.
+ *
+ * @param inner - Optional `Converter<T>` or `Validator<T>` applied to the
+ * parsed JSON value.
+ * @returns Converter that parses a JSON string into `T` (or `JsonValue` when
+ * no inner step is supplied).
+ * @public
+ */
+export declare function stringifiedJson(): Converter<JsonValue>;
+/**
+ * Creates a converter that accepts a string, parses it as JSON, and applies
+ * the supplied inner converter or validator to the parsed value.
+ *
+ * @param inner - `Converter<T>` or `Validator<T>` applied to the parsed JSON.
+ * @returns Converter that parses a JSON string into `T`.
+ * @public
+ */
+export declare function stringifiedJson<T>(inner: Converter<T> | Validator<T>): Converter<T>;
 /**
  * Creates a converter that parses JSON string content and then applies the supplied converter.
  * @param converter - Converter to apply to the parsed JSON

package/lib/packlets/converters/converters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"converters.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":"AAsBA,OAAO,EAEL,SAAS,EAGT,eAAe,EACf,SAAS,EAIV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAA6B,MAAM,SAAS,CAAC;AAIrG;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,qBAAqB,CAqBzE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,qBAAqB,CAgCnE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,qBAAqB,CAkCjE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,qBAAqB,CAgBjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,qBAAqB,CAG/D,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,qBAAqB,CAGa,CAAC;AAE1E;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,qBAAqB,CAGa,CAAC;AAE5E;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAExE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC/B,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,EACxB,OAAO,CAAC,EAAE,MAAM,GACf,SAAS,CAAC,CAAC,EAAE,qBAAqB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAexD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;AACxD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAarF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAkBtE"}

package/lib/packlets/converters/converters.js

@@ -24,6 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.boolean = exports.number = exports.string = exports.jsonValue = exports.jsonArray = exports.jsonObject = exports.jsonPrimitive = void 0;
 exports.literal = literal;
 exports.enumeratedValue = enumeratedValue;
+exports.stringifiedJson = stringifiedJson;
 exports.jsonConverter = jsonConverter;
 const ts_utils_1 = require("@fgv/ts-utils");
 const json_1 = require("../json");
@@ -190,6 +191,17 @@ function enumeratedValue(values, message) {
         return (0, ts_utils_1.fail)(message !== null && message !== void 0 ? message : `Invalid enumerated value ${JSON.stringify(from)}`);
     });
 }
+function stringifiedJson(inner) {
+    const step = inner !== null && inner !== void 0 ? inner : exports.jsonValue;
+    return new ts_utils_1.Conversion.BaseConverter((from) => {
+        if (typeof from !== 'string') {
+            return (0, ts_utils_1.fail)('stringifiedJson: input must be a string.');
+        }
+        return (0, ts_utils_1.captureResult)(() => JSON.parse(from))
+            .withErrorFormat((msg) => `stringifiedJson: failed to parse JSON: ${msg}`)
+            .onSuccess((parsed) => step.convert(parsed));
+    });
+}
 /**
  * Creates a converter that parses JSON string content and then applies the supplied converter.
  * @param converter - Converter to apply to the parsed JSON

package/lib/packlets/converters/converters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"converters.js","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AA2MH,0BAEC;AAgBD,0CAkBC;AA4BD,0CAUC;AAQD,sCAkBC;AA7SD,4CAUuB;AACvB,kCAAqG;AAYrG;;;GAGG;AACU,QAAA,aAAa,GAAoD,IAAI,qBAAU,CAAC,aAAa,CACxG,CACE,IAAa,EACb,MAAuD,EACvD,GAA2B,EACJ,EAAE;IACzB,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,QAAQ,OAAO,IAAI,EAAE,CAAC;QACpB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,KAAK,QAAQ;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,MAAM;IACV,CAAC;IACD,OAAO,IAAA,eAAI,EAAC,IAAI,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;AAC5D,CAAC,CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,UAAU,GAAiD,IAAI,qBAAU,CAAC,aAAa,CAClG,CACE,IAAa,EACb,MAAoD,EACpD,GAA2B,EACP,EAAE;IACtB,IAAI,CAAC,IAAA,mBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAA,eAAI,EAAC,sBAAsB,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,yBAAyB,MAAK,IAAI,EAAE,CAAC;YACnE,qCAAqC;YACrC,SAAS;QACX,CAAC;QACD,iBAAS;aACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,SAAS,CAAC,CAAC,CAAY,EAAE,EAAE;YAC1B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACd,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,IAAA,eAAI,EAAC,yBAAyB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,SAAS,GAAgD,IAAI,qBAAU,CAAC,aAAa,CAChG,CACE,IAAa,EACb,MAAmD,EACnD,GAA2B,EACR,EAAE;IACrB,IAAI,CAAC,IAAA,kBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,IAAA,eAAI,EAAC,cAAc,CAAC,CAAC;IAC9B,CAAC;IACD,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,KAAK,KAAK,SAAS,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,yBAAyB,MAAK,IAAI,EAAE,CAAC;YACnE,6DAA6D;YAC7D,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACf,SAAS;QACX,CAAC;QACD,iBAAS;aACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACZ,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,OAAO,IAAA,eAAI,EAAC,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,IAAA,eAAI,EAAC,sCAAsC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CACF,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,SAAS,GAAgD,IAAI,qBAAU,CAAC,aAAa,CAIhG,CACE,IAAa,EACb,MAAmD,EACnD,GAA2B,EACR,EAAE;IACrB,IAAI,IAAA,kBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,iBAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACtC,CAAC;SAAM,IAAI,IAAA,mBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO,kBAAU,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,qBAAa,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC1C,CAAC,CACF,CAAC;AAEF;;;;GAIG;AACU,QAAA,MAAM,GAAmD,IAAI,0BAAe,EAGtF,CAAC;AAEJ;;;;;GAKG;AACU,QAAA,MAAM,GAA6C,IAAI,qBAAU,CAAC,aAAa,CAG1F,CAAC,IAAa,EAAkB,EAAE,CAAC,qBAAc,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAE1E;;;;;GAKG;AACU,QAAA,OAAO,GAA8C,IAAI,qBAAU,CAAC,aAAa,CAG5F,CAAC,IAAa,EAAmB,EAAE,CAAC,qBAAc,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAE5E;;;;;GAKG;AACH,SAAgB,OAAO,CAAI,KAAQ;IACjC,OAAO,qBAAc,CAAC,OAAO,CAA2B,KAAK,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,eAAe,CAC7B,MAAwB,EACxB,OAAgB;IAEhB,OAAO,IAAI,qBAAU,CAAC,aAAa,CACjC,CACE,IAAa,EACb,MAA8D,EAC9D,OAAkD,EACvC,EAAE;QACb,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,OAA4B,CAAC,CAAC,CAAC,MAAM,CAAC;QACxF,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,IAAS,CAAC,CAAC;QACjD,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,OAAO,IAAA,kBAAO,EAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAA,eAAI,EAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,4BAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC,CACF,CAAC;AACJ,CAAC;AA4BD,SAAgB,eAAe,CAAI,KAAmC;IACpE,MAAM,IAAI,GAAsD,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,iBAAS,CAAC;IACnF,OAAO,IAAI,qBAAU,CAAC,aAAa,CAAgB,CAAC,IAAa,EAAyB,EAAE;QAC1F,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,0CAA0C,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,IAAA,wBAAa,EAAU,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAClD,eAAe,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,0CAA0C,GAAG,EAAE,CAAC;aACzE,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAI,SAAuB;IACtD,OAAO,IAAI,qBAAU,CAAC,aAAa,CAAI,CAAC,IAAa,EAAa,EAAE;QAClE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,wBAAwB,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,WAAW,GAAG,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1D,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;YAC5B,OAAO,IAAA,eAAI,EAAC,yBAAyB,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC;QACjC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClD,OAAO,IAAA,eAAI,EAAC,sDAAsD,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport {\n  Conversion,\n  Converter,\n  Converters as BaseConverters,\n  Result,\n  StringConverter,\n  Validator,\n  captureResult,\n  fail,\n  succeed\n} from '@fgv/ts-utils';\nimport { JsonArray, JsonObject, JsonPrimitive, JsonValue, isJsonArray, isJsonObject } from '../json';\n\n/* eslint-disable @typescript-eslint/no-use-before-define */\n\n/**\n * Conversion context for JSON converters.\n * @public\n */\nexport interface IJsonConverterContext {\n  ignoreUndefinedProperties?: boolean;\n}\n\n/**\n * An converter which converts a supplied `unknown` value to a valid {@link JsonPrimitive | JsonPrimitive}.\n * @public\n */\nexport const jsonPrimitive: Converter<JsonPrimitive, IJsonConverterContext> = new Conversion.BaseConverter(\n  (\n    from: unknown,\n    __self: Converter<JsonPrimitive, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonPrimitive> => {\n    if (from === null) {\n      return succeed(null);\n    }\n    switch (typeof from) {\n      case 'boolean':\n      case 'string':\n        return succeed(from);\n      case 'number':\n        if (!Number.isNaN(from)) {\n          return succeed(from);\n        }\n        break;\n    }\n    return fail(`\"${String(from)}\": invalid JSON primitive.`);\n  }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value into\n * a valid {@link JsonObject | JsonObject}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * `IJsonConverterContext` at runtime.\n *\n * Guaranteed to return a new object.\n * @public\n */\nexport const jsonObject: Converter<JsonObject, IJsonConverterContext> = new Conversion.BaseConverter(\n  (\n    from: unknown,\n    __self: Converter<JsonObject, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonObject> => {\n    if (!isJsonObject(from)) {\n      return fail('invalid JSON object.');\n    }\n    const obj: JsonObject = {};\n    const errors: string[] = [];\n    for (const [name, value] of Object.entries(from)) {\n      if (value === undefined && ctx?.ignoreUndefinedProperties === true) {\n        // optionally ignore undefined values\n        continue;\n      }\n      jsonValue\n        .convert(value, ctx)\n        .onSuccess((v: JsonValue) => {\n          obj[name] = v;\n          return succeed(v);\n        })\n        .onFailure((m) => {\n          errors.push(`${name}: ${m}`);\n          return fail(m);\n        });\n    }\n    if (errors.length > 0) {\n      return fail(`invalid JSON object:\\n${errors.join('\\n')}`);\n    }\n    return succeed(obj);\n  }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value to\n * a valid {@link JsonArray | JsonArray}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * `IJsonConverterContext` at runtime.\n *\n * Guaranteed to return a new array.\n * @public\n */\nexport const jsonArray: Converter<JsonArray, IJsonConverterContext> = new Conversion.BaseConverter(\n  (\n    from: unknown,\n    __self: Converter<JsonArray, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonArray> => {\n    if (!isJsonArray(from)) {\n      return fail('not an array');\n    }\n    const arr: JsonValue[] = [];\n    const errors: string[] = [];\n    for (let i = 0; i < from.length; i++) {\n      const value = from[i];\n      if (value === undefined && ctx?.ignoreUndefinedProperties === true) {\n        // convert undefined to 'null' for parity with JSON.stringify\n        arr.push(null);\n        continue;\n      }\n      jsonValue\n        .convert(value, ctx)\n        .onSuccess((v) => {\n          arr.push(v);\n          return succeed(v);\n        })\n        .onFailure((m) => {\n          errors.push(`${i}: ${m}`);\n          return fail(m);\n        });\n    }\n    if (errors.length > 0) {\n      return fail(`array contains non-json elements:\\n${errors.join('\\n')}`);\n    }\n    return succeed(arr);\n  }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value to a\n * valid {@link JsonValue | JsonValue}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * `IJsonConverterContext` at runtime.\n * @public\n */\nexport const jsonValue: Converter<JsonValue, IJsonConverterContext> = new Conversion.BaseConverter<\n  JsonValue,\n  IJsonConverterContext\n>(\n  (\n    from: unknown,\n    __self: Converter<JsonValue, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonValue> => {\n    if (isJsonArray(from)) {\n      return jsonArray.convert(from, ctx);\n    } else if (isJsonObject(from)) {\n      return jsonObject.convert(from, ctx);\n    }\n    return jsonPrimitive.convert(from, ctx);\n  }\n);\n\n/**\n * A `StringConverter` which converts `unknown` to a `string`.\n * Accepts `IJsonConverterContext` but ignores it.\n * @public\n */\nexport const string: StringConverter<string, IJsonConverterContext> = new StringConverter<\n  string,\n  IJsonConverterContext\n>();\n\n/**\n * A `Converter` which converts `unknown` to a `number`.\n * Accepts `IJsonConverterContext` but ignores it.\n * Mirrors the behavior of `@fgv/ts-utils`.\n * @public\n */\nexport const number: Converter<number, IJsonConverterContext> = new Conversion.BaseConverter<\n  number,\n  IJsonConverterContext\n>((from: unknown): Result<number> => BaseConverters.number.convert(from));\n\n/**\n * A `Converter` which converts `unknown` to a `boolean`.\n * Accepts `IJsonConverterContext` but ignores it.\n * Mirrors the behavior of `@fgv/ts-utils`.\n * @public\n */\nexport const boolean: Converter<boolean, IJsonConverterContext> = new Conversion.BaseConverter<\n  boolean,\n  IJsonConverterContext\n>((from: unknown): Result<boolean> => BaseConverters.boolean.convert(from));\n\n/**\n * Helper to create a converter for a literal value.\n * Accepts `IJsonConverterContext` but ignores it.\n * Mirrors the behavior of `@fgv/ts-utils`.\n * @public\n */\nexport function literal<T>(value: T): Converter<T, IJsonConverterContext> {\n  return BaseConverters.literal<T, IJsonConverterContext>(value);\n}\n\n/**\n * Helper function to create a `Converter` which converts `unknown` to one of a set of\n * supplied enumerated values. Anything else fails.\n *\n * @remarks\n * This JSON variant accepts an `IJsonConverterContext` OR\n * a `ReadonlyArray<T>` as its conversion context. If the context is an array, it is used to override the\n * allowed values for that conversion; otherwise, the original `values` supplied at creation time are used.\n *\n * @param values - Array of allowed values.\n * @param message - Optional custom failure message.\n * @returns A new `Converter` returning `<T>`.\n * @public\n */\nexport function enumeratedValue<T>(\n  values: ReadonlyArray<T>,\n  message?: string\n): Converter<T, IJsonConverterContext | ReadonlyArray<T>> {\n  return new Conversion.BaseConverter<T, IJsonConverterContext | ReadonlyArray<T>>(\n    (\n      from: unknown,\n      __self: Converter<T, IJsonConverterContext | ReadonlyArray<T>>,\n      context?: IJsonConverterContext | ReadonlyArray<T>\n    ): Result<T> => {\n      const effectiveValues = Array.isArray(context) ? (context as ReadonlyArray<T>) : values;\n      const index = effectiveValues.indexOf(from as T);\n      if (index >= 0) {\n        return succeed(effectiveValues[index]);\n      }\n      return fail(message ?? `Invalid enumerated value ${JSON.stringify(from)}`);\n    }\n  );\n}\n\n/**\n * Creates a converter that accepts a string, parses it as JSON, and optionally\n * applies the supplied inner converter or validator to the parsed value.\n *\n * @remarks\n * Unlike {@link Converters.jsonConverter}, the inner step is optional. When omitted, the\n * converter resolves to the parsed `JsonValue` (object, array, or primitive).\n * Both `Converter<T>` and `Validator<T>` are accepted because both expose\n * `convert(unknown): Result<T>`.\n *\n * @param inner - Optional `Converter<T>` or `Validator<T>` applied to the\n * parsed JSON value.\n * @returns Converter that parses a JSON string into `T` (or `JsonValue` when\n * no inner step is supplied).\n * @public\n */\nexport function stringifiedJson(): Converter<JsonValue>;\n/**\n * Creates a converter that accepts a string, parses it as JSON, and applies\n * the supplied inner converter or validator to the parsed value.\n *\n * @param inner - `Converter<T>` or `Validator<T>` applied to the parsed JSON.\n * @returns Converter that parses a JSON string into `T`.\n * @public\n */\nexport function stringifiedJson<T>(inner: Converter<T> | Validator<T>): Converter<T>;\nexport function stringifiedJson<T>(inner?: Converter<T> | Validator<T>): Converter<T | JsonValue> {\n  const step: { convert(from: unknown): Result<T | JsonValue> } = inner ?? jsonValue;\n  return new Conversion.BaseConverter<T | JsonValue>((from: unknown): Result<T | JsonValue> => {\n    if (typeof from !== 'string') {\n      return fail('stringifiedJson: input must be a string.');\n    }\n    return captureResult<unknown>(() => JSON.parse(from))\n      .withErrorFormat((msg) => `stringifiedJson: failed to parse JSON: ${msg}`)\n      .onSuccess((parsed) => step.convert(parsed));\n  });\n}\n\n/**\n * Creates a converter that parses JSON string content and then applies the supplied converter.\n * @param converter - Converter to apply to the parsed JSON\n * @returns Converter that parses JSON then validates\n * @public\n */\nexport function jsonConverter<T>(converter: Converter<T>): Converter<T> {\n  return new Conversion.BaseConverter<T>((from: unknown): Result<T> => {\n    if (typeof from !== 'string') {\n      return fail('Input must be a string');\n    }\n\n    const parseResult = captureResult(() => JSON.parse(from));\n    if (parseResult.isFailure()) {\n      return fail(`Failed to parse JSON: ${parseResult.message}`);\n    }\n\n    const parsed = parseResult.value;\n    if (typeof parsed !== 'object' || parsed === null) {\n      return fail('Failed to parse JSON: JSON content must be an object');\n    }\n\n    return converter.convert(parsed);\n  });\n}\n"]}

package/lib/packlets/converters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/index.ts"],"names":[],"mappings":"AAsBA,cAAc,cAAc,CAAC"}

package/lib/packlets/converters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/converters/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,+CAA6B","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nexport * from './converters';\n"]}

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

@@ -0,0 +1 @@
+{"version":3,"file":"directoryItem.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/directoryItem.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAgC,MAAM,eAAe,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,6BAA6B,EAC7B,wBAAwB,EAGzB,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,qBAAa,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,YAAW,6BAA6B,CAAC,GAAG,CAAC;IACnG;;OAEG;IACH,SAAgB,IAAI,EAAE,WAAW,CAAe;IAEhD;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC;IAKhE;;;;;;;OAOG;WACW,MAAM,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC9C,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAC3B,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAI7B;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IAI9D;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAmB7F;;OAEG;IACI,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC;IAWrF;;OAEG;IACI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC;IAoBhF;;OAEG;IACI,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC;IAShC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;CAyBzB"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"directoryItem.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/directoryItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAqE;AACrE,2DAQ6B;AAE7B;;;GAGG;AACH,MAAa,aAAa;IAWxB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAQD;;;;;;OAMG;IACH,YAAsB,IAAY,EAAE,GAA4B;QA9BhE;;WAEG;QACa,SAAI,GAAgB,WAAW,CAAC;QA4B9C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAClB,IAAY,EACZ,GAA4B;QAE5B,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,aAAa,CAAM,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,IAAY,EAAE,QAAgB;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACxD,OAAO,GAAG,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAC7D,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YACvC,2FAA2F;YAC3F,IAAI,CAAC,IAAA,qCAAiB,EAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAA,eAAI,EAAC,GAAG,QAAQ,mCAAmC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACzE,CAAC;YACD,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,IAAY;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,IAAY,EAAE,OAA6B;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACzB,OAAO,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YACnC,CAAC;YACD,kBAAkB;YAClB,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;YAC1C,CAAC;YACD,OAAO,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACK,gBAAgB,CAAC,OAAe;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,mEAAmE;QACnE,IAAI,CAAC,IAAA,sCAAkB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,GAAG,OAAO,0BAA0B,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;YACrD,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC1B,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;oBAClD,6EAA6E;oBAC7E,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;wBACvB,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;oBACzD,6EAA6E;oBAC7E,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;wBACvB,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAhKD,sCAgKC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result, captureResult, fail, succeed } from '@fgv/ts-utils';\nimport {\n  FileTreeItem,\n  IDeleteChildOptions,\n  IFileTreeAccessors,\n  IMutableFileTreeDirectoryItem,\n  IMutableFileTreeFileItem,\n  isMutableAccessors,\n  isMutableFileItem\n} from './fileTreeAccessors';\n\n/**\n * Class representing a directory in a file tree.\n * @public\n */\nexport class DirectoryItem<TCT extends string = string> implements IMutableFileTreeDirectoryItem<TCT> {\n  /**\n   * {@inheritDoc FileTree.IFileTreeDirectoryItem.\"type\"}\n   */\n  public readonly type: 'directory' = 'directory';\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeDirectoryItem.absolutePath}\n   */\n  public readonly absolutePath: string;\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeDirectoryItem.name}\n   */\n  public get name(): string {\n    return this._hal.getBaseName(this.absolutePath);\n  }\n\n  /**\n   * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n   * @public\n   */\n  protected readonly _hal: IFileTreeAccessors<TCT>;\n\n  /**\n   * Protected constructor for derived classes.\n   * @param path - Relative path of the directory.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   * @public\n   */\n  protected constructor(path: string, hal: IFileTreeAccessors<TCT>) {\n    this._hal = hal;\n    this.absolutePath = hal.resolveAbsolutePath(path);\n  }\n\n  /**\n   * Creates a new DirectoryItem instance.\n   * @param path - Relative path of the directory.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   * @returns `Success` with the new {@link FileTree.DirectoryItem | DirectoryItem} instance if successful,\n   * or `Failure` with an error message otherwise.\n   */\n  public static create<TCT extends string = string>(\n    path: string,\n    hal: IFileTreeAccessors<TCT>\n  ): Result<DirectoryItem<TCT>> {\n    return captureResult(() => new DirectoryItem<TCT>(path, hal));\n  }\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeDirectoryItem.getChildren}\n   */\n  public getChildren(): Result<ReadonlyArray<FileTreeItem<TCT>>> {\n    return this._hal.getChildren(this.absolutePath);\n  }\n\n  /**\n   * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.createChildFile}\n   */\n  public createChildFile(name: string, contents: string): Result<IMutableFileTreeFileItem<TCT>> {\n    const hal = this._hal;\n    if (!isMutableAccessors(hal)) {\n      /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n      return fail(`${this.absolutePath}: mutation not supported`);\n    }\n\n    const filePath = hal.joinPaths(this.absolutePath, name);\n    return hal.saveFileContents(filePath, contents).onSuccess(() =>\n      hal.getItem(filePath).onSuccess((item) => {\n        /* c8 ignore next 3 - defensive: verifies accessor returned correct item type after save */\n        if (!isMutableFileItem(item)) {\n          return fail(`${filePath}: expected mutable file but got ${item.type}`);\n        }\n        return succeed(item);\n      })\n    );\n  }\n\n  /**\n   * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.createChildDirectory}\n   */\n  public createChildDirectory(name: string): Result<IMutableFileTreeDirectoryItem<TCT>> {\n    const hal = this._hal;\n    if (!isMutableAccessors(hal)) {\n      /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n      return fail(`${this.absolutePath}: mutation not supported`);\n    }\n\n    const dirPath = hal.joinPaths(this.absolutePath, name);\n    return hal.createDirectory(dirPath).onSuccess(() => DirectoryItem.create(dirPath, hal));\n  }\n\n  /**\n   * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.deleteChild}\n   */\n  public deleteChild(name: string, options?: IDeleteChildOptions): Result<boolean> {\n    const hal = this._hal;\n    if (!isMutableAccessors(hal)) {\n      /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n      return fail(`${this.absolutePath}: mutation not supported`);\n    }\n\n    const childPath = hal.joinPaths(this.absolutePath, name);\n    return hal.getItem(childPath).onSuccess((item) => {\n      if (item.type === 'file') {\n        return hal.deleteFile(childPath);\n      }\n      // Directory child\n      if (options?.recursive) {\n        return this._deleteRecursive(childPath);\n      }\n      return hal.deleteDirectory(childPath);\n    });\n  }\n\n  /**\n   * {@inheritDoc FileTree.IMutableFileTreeDirectoryItem.delete}\n   */\n  public delete(): Result<boolean> {\n    const hal = this._hal;\n    if (!isMutableAccessors(hal)) {\n      /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n      return fail(`${this.absolutePath}: mutation not supported`);\n    }\n    return hal.deleteDirectory(this.absolutePath);\n  }\n\n  /**\n   * Recursively deletes all children of a directory and then the directory itself.\n   * @param dirPath - The absolute path of the directory to delete.\n   * @returns `Success` with `true` if the directory was deleted, or `Failure` with an error message.\n   * @internal\n   */\n  private _deleteRecursive(dirPath: string): Result<boolean> {\n    const hal = this._hal;\n    /* c8 ignore next 3 - defensive: caller already verified mutable */\n    if (!isMutableAccessors(hal)) {\n      return fail(`${dirPath}: mutation not supported`);\n    }\n    return hal.getChildren(dirPath).onSuccess((children) => {\n      for (const child of children) {\n        if (child.type === 'file') {\n          const result = hal.deleteFile(child.absolutePath);\n          /* c8 ignore next 3 - defensive: error propagation during recursive delete */\n          if (result.isFailure()) {\n            return result;\n          }\n        } else {\n          const result = this._deleteRecursive(child.absolutePath);\n          /* c8 ignore next 3 - defensive: error propagation during recursive delete */\n          if (result.isFailure()) {\n            return result;\n          }\n        }\n      }\n      return hal.deleteDirectory(dirPath);\n    });\n  }\n}\n"]}

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

@@ -58,7 +58,9 @@ export declare class FileItem<TCT extends string = string> implements IMutableFi
      */
     static create<TCT extends string = string>(path: string, hal: IFileTreeAccessors<TCT>): Result<FileItem<TCT>>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
+     * Indicates whether this file can be saved.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     getIsMutable(): DetailedResult<boolean, SaveDetail>;
     /**
@@ -79,15 +81,20 @@ export declare class FileItem<TCT extends string = string> implements IMutableFi
      */
     setContentType(contentType: TCT | undefined): void;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
+     * Sets the contents of the file from a JSON value.
+     * @param json - The JSON value to serialize and save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setContents(json: JsonValue): Result<JsonValue>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
+     * Sets the raw contents of the file.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setRawContents(contents: string): Result<string>;
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.delete}
+     * Deletes this file from its backing store.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     delete(): Result<boolean>;
     /**

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

@@ -0,0 +1 @@
+{"version":3,"file":"fileItem.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileItem.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,cAAc,EAAwB,MAAM,EAAoB,MAAM,eAAe,CAAC;AAC9G,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EAExB,UAAU,EACX,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,qBAAa,QAAQ,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,YAAW,wBAAwB,CAAC,GAAG,CAAC;IACzF;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAU;IAEtC;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,GAAG,GAAG,SAAS,CAExC;IAED;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAkB;IAEtC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC;IAMhE;;;;;;OAMG;WACW,MAAM,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC9C,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAC3B,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAIxB;;;;OAIG;IACI,YAAY,IAAI,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC;IAQ1D;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC;IACvC;;OAEG;IACI,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAaxE;;OAEG;IACI,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC;IAIvC;;;OAGG;IACI,cAAc,CAAC,WAAW,EAAE,GAAG,GAAG,SAAS,GAAG,IAAI;IAIzD;;;;OAIG;IACI,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;IAMtD;;;;OAIG;IACI,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAQvD;;;OAGG;IACI,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC;IAQhC;;;;;;;;OAQG;WACW,uBAAuB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC/D,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,GAChB,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;IAI1B;;;;;;;;OAQG;WACW,wBAAwB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAChE,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,GAAG,GACb,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;CAG3B"}

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

@@ -80,7 +80,9 @@ class FileItem {
         return (0, ts_utils_1.captureResult)(() => new FileItem(path, hal));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.getIsMutable}
+     * Indicates whether this file can be saved.
+     * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,
+     * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.
      */
     getIsMutable() {
         if ((0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {
@@ -114,13 +116,17 @@ class FileItem {
         this._contentType = contentType;
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setContents}
+     * Sets the contents of the file from a JSON value.
+     * @param json - The JSON value to serialize and save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setContents(json) {
         return (0, ts_utils_1.captureResult)(() => JSON.stringify(json, null, 2)).onSuccess((contents) => this.setRawContents(contents).onSuccess(() => ts_utils_1.Success.with(json)));
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.setRawContents}
+     * Sets the raw contents of the file.
+     * @param contents - The string contents to save.
+     * @returns `Success` if the file was saved, or `Failure` with an error message.
      */
     setRawContents(contents) {
         if ((0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {
@@ -130,7 +136,8 @@ class FileItem {
         return (0, ts_utils_1.fail)(`${this.absolutePath}: mutation not supported`);
     }
     /**
-     * {@inheritDoc FileTree.IFileTreeFileItem.delete}
+     * Deletes this file from its backing store.
+     * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.
      */
     delete() {
         if (!(0, fileTreeAccessors_1.isMutableAccessors)(this._hal)) {

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

@@ -0,0 +1 @@
+{"version":3,"file":"fileItem.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAA8G;AAG9G,2DAK6B;AAE7B;;;GAGG;AACH,MAAa,QAAQ;IAWnB;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAcD;;;;;;OAMG;IACH,YAAsB,IAAY,EAAE,GAA4B;QAzDhE;;WAEG;QACa,SAAI,GAAW,MAAM,CAAC;QAuDpC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,SAAS,EAAE,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAClB,IAAY,EACZ,GAA4B;QAE5B,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,YAAY;QACjB,IAAI,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACpD,CAAC;QACD,mGAAmG;QACnG,OAAO,IAAA,yBAAc,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,EAAE,eAAe,CAAC,CAAC;IACzF,CAAC;IAUM,WAAW,CAAI,SAAuC;QAC3D,OAAO,IAAI,CAAC,IAAI;aACb,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC;aAClC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;aACzF,SAAS,CAAgB,CAAC,MAAM,EAAE,EAAE;YACnC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAA,kBAAO,EAAC,MAAmB,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,WAA4B;QAChD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,IAAe;QAChC,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/E,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,kBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,QAAgB;QACpC,IAAI,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACjE,CAAC;QACD,mGAAmG;QACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,IAAI,CAAC,IAAA,sCAAkB,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,mGAAmG;YACnG,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,CAAC,YAAY,0BAA0B,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,uBAAuB,CACnC,QAAgB,EAChB,QAAiB;QAEjB,OAAO,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,wBAAwB,CACpC,QAAgB,EAChB,QAAc;QAEd,OAAO,IAAA,kBAAO,EAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;CACF;AAjMD,4BAiMC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { captureResult, DetailedResult, fail, failWithDetail, Result, succeed, Success } from '@fgv/ts-utils';\nimport { Converter, Validator } from '@fgv/ts-utils';\nimport { JsonValue } from '../json';\nimport {\n  IFileTreeAccessors,\n  IMutableFileTreeFileItem,\n  isMutableAccessors,\n  SaveDetail\n} from './fileTreeAccessors';\n\n/**\n * Class representing a file in a file tree.\n * @public\n */\nexport class FileItem<TCT extends string = string> implements IMutableFileTreeFileItem<TCT> {\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.\"type\"}\n   */\n  public readonly type: 'file' = 'file';\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.absolutePath}\n   */\n  public readonly absolutePath: string;\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.name}\n   */\n  public get name(): string {\n    return this._hal.getBaseName(this.absolutePath);\n  }\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.baseName}\n   */\n  public get baseName(): string {\n    return this._hal.getBaseName(this.absolutePath, this.extension);\n  }\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.extension}\n   */\n  public get extension(): string {\n    return this._hal.getExtension(this.absolutePath);\n  }\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.contentType}\n   */\n  public get contentType(): TCT | undefined {\n    return this._contentType;\n  }\n\n  /**\n   * Mutable content type of the file.\n   * @public\n   */\n  private _contentType: TCT | undefined;\n\n  /**\n   * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n   * @public\n   */\n  protected readonly _hal: IFileTreeAccessors<TCT>;\n\n  /**\n   * Protected constructor for derived classes.\n   * @param path - Relative path of the file.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   * @public\n   */\n  protected constructor(path: string, hal: IFileTreeAccessors<TCT>) {\n    this._hal = hal;\n    this.absolutePath = hal.resolveAbsolutePath(path);\n    this._contentType = hal.getFileContentType(this.absolutePath).orDefault();\n  }\n\n  /**\n   * Creates a new {@link FileTree.FileItem} instance.\n   * @param path - Relative path of the file.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   * @public\n   */\n  public static create<TCT extends string = string>(\n    path: string,\n    hal: IFileTreeAccessors<TCT>\n  ): Result<FileItem<TCT>> {\n    return captureResult(() => new FileItem(path, hal));\n  }\n\n  /**\n   * Indicates whether this file can be saved.\n   * @returns `DetailedSuccess` with {@link FileTree.SaveCapability} if the file can be saved,\n   * or `DetailedFailure` with {@link FileTree.SaveFailureReason} if it cannot.\n   */\n  public getIsMutable(): DetailedResult<boolean, SaveDetail> {\n    if (isMutableAccessors(this._hal)) {\n      return this._hal.fileIsMutable(this.absolutePath);\n    }\n    /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n    return failWithDetail(`${this.absolutePath}: mutation not supported`, 'not-supported');\n  }\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.getContents}\n   */\n  public getContents(): Result<JsonValue>;\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.getContents}\n   */\n  public getContents<T>(converter: Validator<T> | Converter<T>): Result<T>;\n  public getContents<T>(converter?: Validator<T> | Converter<T>): Result<T | JsonValue> {\n    return this._hal\n      .getFileContents(this.absolutePath)\n      .onSuccess((body) => captureResult(() => JSON.parse(body)).onFailure(() => succeed(body)))\n      .onSuccess<T | JsonValue>((parsed) => {\n        if (converter !== undefined) {\n          return converter.convert(parsed);\n        }\n        return succeed(parsed as JsonValue);\n      });\n  }\n\n  /**\n   * {@inheritDoc FileTree.IFileTreeFileItem.getRawContents}\n   */\n  public getRawContents(): Result<string> {\n    return this._hal.getFileContents(this.absolutePath);\n  }\n\n  /**\n   * Sets the content type of the file.\n   * @param contentType - The content type of the file.\n   */\n  public setContentType(contentType: TCT | undefined): void {\n    this._contentType = contentType;\n  }\n\n  /**\n   * Sets the contents of the file from a JSON value.\n   * @param json - The JSON value to serialize and save.\n   * @returns `Success` if the file was saved, or `Failure` with an error message.\n   */\n  public setContents(json: JsonValue): Result<JsonValue> {\n    return captureResult(() => JSON.stringify(json, null, 2)).onSuccess((contents) =>\n      this.setRawContents(contents).onSuccess(() => Success.with(json))\n    );\n  }\n\n  /**\n   * Sets the raw contents of the file.\n   * @param contents - The string contents to save.\n   * @returns `Success` if the file was saved, or `Failure` with an error message.\n   */\n  public setRawContents(contents: string): Result<string> {\n    if (isMutableAccessors(this._hal)) {\n      return this._hal.saveFileContents(this.absolutePath, contents);\n    }\n    /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n    return fail(`${this.absolutePath}: mutation not supported`);\n  }\n\n  /**\n   * Deletes this file from its backing store.\n   * @returns `Success` with `true` if the file was deleted, or `Failure` with an error message.\n   */\n  public delete(): Result<boolean> {\n    if (!isMutableAccessors(this._hal)) {\n      /* c8 ignore next 2 - defensive: all current accessor implementations support mutation interface */\n      return fail(`${this.absolutePath}: mutation not supported`);\n    }\n    return this._hal.deleteFile(this.absolutePath);\n  }\n\n  /**\n   * Default function to infer the content type of a file.\n   * @param filePath - The path of the file.\n   * @param provided - Optional supplied content type.\n   * @returns `Success` with the content type of the file if successful, or\n   * `Failure` with an error message otherwise.\n   * @remarks This default implementation always returns `Success` with `undefined`.\n   * @public\n   */\n  public static defaultInferContentType<TCT extends string = string>(\n    filePath: string,\n    provided?: string\n  ): Result<TCT | undefined> {\n    return succeed(undefined);\n  }\n\n  /**\n   * Default function to accept the content type of a file.\n   * @param filePath - The path of the file.\n   * @param provided - Optional supplied content type.\n   * @returns `Success` with the content type of the file if successful, or\n   * `Failure` with an error message otherwise.\n   * @remarks This default implementation always returns `Success` with `undefined`.\n   * @public\n   */\n  public static defaultAcceptContentType<TCT extends string = string>(\n    filePath: string,\n    provided?: TCT\n  ): Result<TCT | undefined> {\n    return succeed(provided);\n  }\n}\n"]}

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

@@ -0,0 +1 @@
+{"version":3,"file":"fileTree.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTree.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,MAAM,EAAiB,MAAM,eAAe,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,qBAAa,QAAQ,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC/C;;;OAGG;IACI,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEpC;;;;;OAKG;IACH,SAAS,aAAa,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC;IAIlD;;;;;OAKG;WACW,MAAM,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAItG;;;;;OAKG;IACI,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAK3D;;;;;OAKG;IACI,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAShE;;;;;OAKG;IACI,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;CAQhF"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"fileTree.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTree.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAAqE;AAQrE;;;GAGG;AACH,MAAa,QAAQ;IAOnB;;;;;OAKG;IACH,YAAsB,GAA4B;QAChD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAA8B,GAA4B;QAC5E,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,QAAgB;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACzB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAA,eAAI,EAAC,GAAG,QAAQ,cAAc,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,aAAqB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAC9B,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAA,eAAI,EAAC,GAAG,aAAa,mBAAmB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnED,4BAmEC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { captureResult, Result, fail, succeed } from '@fgv/ts-utils';\nimport {\n  FileTreeItem,\n  IFileTreeAccessors,\n  IFileTreeDirectoryItem,\n  IFileTreeFileItem\n} from './fileTreeAccessors';\n\n/**\n * Represents a file tree.\n * @public\n */\nexport class FileTree<TCT extends string = string> {\n  /**\n   * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n   * @public\n   */\n  public hal: IFileTreeAccessors<TCT>;\n\n  /**\n   * Protected constructor for derived classes.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   * @public\n   */\n  protected constructor(hal: IFileTreeAccessors<TCT>) {\n    this.hal = hal;\n  }\n\n  /**\n   * Creates a new {@link FileTree} instance with the supplied\n   * accessors.\n   * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for\n   * file system operations.\n   */\n  public static create<TCT extends string = string>(hal: IFileTreeAccessors<TCT>): Result<FileTree<TCT>> {\n    return captureResult(() => new FileTree(hal));\n  }\n\n  /**\n   * Gets an item from the tree.\n   * @param itemPath - The path to the item.\n   * @returns `Success` with the item if successful,\n   * or `Failure` with an error message otherwise.\n   */\n  public getItem(itemPath: string): Result<FileTreeItem<TCT>> {\n    const absolutePath = this.hal.resolveAbsolutePath(itemPath);\n    return this.hal.getItem(absolutePath);\n  }\n\n  /**\n   * Gets a file item from the tree.\n   * @param filePath - The path to the file.\n   * @returns `Success` with the {@link FileTree.IFileTreeFileItem | file item}\n   * if successful, or `Failure` with an error message otherwise.\n   */\n  public getFile(filePath: string): Result<IFileTreeFileItem<TCT>> {\n    return this.getItem(filePath).onSuccess((item) => {\n      if (item.type === 'file') {\n        return succeed(item);\n      }\n      return fail(`${filePath}: not a file`);\n    });\n  }\n\n  /**\n   * Gets a directory item from the tree.\n   * @param directoryPath - The path to the directory.\n   * @returns `Success` with the {@link FileTree.IFileTreeDirectoryItem | directory item}\n   * if successful, or `Failure` with an error message otherwise.\n   */\n  public getDirectory(directoryPath: string): Result<IFileTreeDirectoryItem<TCT>> {\n    return this.getItem(directoryPath).onSuccess((item) => {\n      if (item.type === 'directory') {\n        return succeed(item);\n      }\n      return fail(`${directoryPath}: not a directory`);\n    });\n  }\n}\n"]}

package/lib/packlets/file-tree/fileTreeAccessors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileTreeAccessors.d.ts","sourceRoot":"","sources":["../../../src/packlets/file-tree/fileTreeAccessors.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,WAAW,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GACzB,eAAe,GACf,WAAW,GACX,aAAa,GACb,eAAe,GACf,mBAAmB,CAAC;AAExB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IAAI,CAC5D,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,KACd,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;AAE7B;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAE3C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAMD;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC5D;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,GAAG,GAAG,SAAS,CAAC;IAEtC;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAElE;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,iBAAiB,CAAC,GAAG,CAAC;IACnG;;;;OAIG;IACH,YAAY,IAAI,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEpD;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAEhD;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjD;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;CAC3B;AAMD;;;GAGG;AACH,MAAM,WAAW,sBAAsB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IACjE;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACzD;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CACxE,SAAQ,sBAAsB,CAAC,GAAG,CAAC;IACnC;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC;IAEvF;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAE1E;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;CAC3B;AAMD;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;AAE7G;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IACvD,wBAAwB,CAAC,GAAG,CAAC,GAC7B,6BAA6B,CAAC,GAAG,CAAC,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IACvD,iBAAiB,CAAC,GAAG,CAAC,GACtB,wBAAwB,CAAC,GAAG,CAAC,CAAC;AAElC;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,IAC5D,sBAAsB,CAAC,GAAG,CAAC,GAC3B,6BAA6B,CAAC,GAAG,CAAC,CAAC;AAMvC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC7D;;;;OAIG;IACH,mBAAmB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEhD;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnD;;;;OAIG;IACH,SAAS,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IAEjD;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IAE7E;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrE;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,kBAAkB,CAAC,GAAG,CAAC;IACrG;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAEjE;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAE1C;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CACvE,SAAQ,yBAAyB,CAAC,GAAG,CAAC;IACtC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpC;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAEnB;;;OAGG;IACH,aAAa,IAAI,MAAM,EAAE,CAAC;CAC3B;AAMD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC5D,SAAS,EAAE,kBAAkB,CAAC,GAAG,CAAC,GACjC,SAAS,IAAI,yBAAyB,CAAC,GAAG,CAAC,CAS7C;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC/D,SAAS,EAAE,kBAAkB,CAAC,GAAG,CAAC,GACjC,SAAS,IAAI,4BAA4B,CAAC,GAAG,CAAC,CAShD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3D,IAAI,EAAE,mBAAmB,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,GACjD,IAAI,IAAI,wBAAwB,CAAC,GAAG,CAAC,CASvC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAChE,IAAI,EAAE,wBAAwB,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,GACtD,IAAI,IAAI,6BAA6B,CAAC,GAAG,CAAC,CAS5C"}