@fgv/ts-utils 4.4.0 → 4.5.0-0

package/lib/packlets/collections/validatingCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatingCollector.js","sourceRoot":"","sources":["../../../src/packlets/collections/validatingCollector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAKhD,2CAAwC;AACxC,6DAA0D;AA0C1D;;;;GAIG;AACH,MAAa,mBAGX,SAAQ,qBAAgB;IASxB;;;;OAIG;IACH,YAAmB,MAAoD;;QACrE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,uCAAkB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QAC7F,KAAK,MAAM,IAAI,IAAI,MAAA,MAAM,CAAC,KAAK,mCAAI,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,yBAAyB,CAGrC,MAAoD;QACpD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/CD,kDA+CC","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 } from '../base';\nimport { CollectibleKey, ICollectible } from './collectible';\nimport { IReadOnlyCollectorValidator } from './collectorValidator';\nimport { IReadOnlyValidatingResultMap } from './validatingResultMap';\nimport { KeyValueConverters } from './keyValueConverters';\nimport { Collector } from './collector';\nimport { CollectorValidator } from './collectorValidator';\n\n/**\n * A read-only interface exposing non-mutating methods of a\n * {@link Collections.ValidatingCollector | ValidatingCollector}.\n * @public\n */\n\nexport interface IReadOnlyValidatingCollector<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> extends IReadOnlyValidatingResultMap<CollectibleKey<TITEM>, TITEM> {\n  /**\n   * {@inheritdoc Collections.ValidatingCollector.validating}\n   */\n  readonly validating: IReadOnlyCollectorValidator<TITEM>;\n\n  /**\n   * {@inheritdoc Collections.IReadOnlyValidatingCollector.getAt}\n   */\n  readonly getAt: (index: number) => Result<TITEM>;\n}\n\n/**\n * Parameters for constructing a {@link Collections.ValidatingCollector | ValidatingCollector}.\n * @public\n */\nexport interface IValidatingCollectorConstructorParams<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> {\n  /**\n   * {@inheritdoc Collections.ICollectorValidatorCreateParams.converters}\n   */\n  converters: KeyValueConverters<CollectibleKey<TITEM>, TITEM>;\n\n  /**\n   * {@inheritdoc Collections.ICollectorConstructorParams.items}\n   */\n  items?: unknown[];\n}\n\n/**\n * A {@link Collections.Collector | Collector} with a {@link Collections.CollectorValidator | CollectorValidator}\n * property that enables validated use of the underlying map with weakly-typed keys and values.\n * @public\n */\nexport class ValidatingCollector<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>\n> extends Collector<TITEM> {\n  /**\n   * A {@link Collections.CollectorValidator | CollectorValidator} which validates keys and values\n   * before inserting them into this collector.\n   */\n  public readonly validating: CollectorValidator<TITEM>;\n\n  protected readonly _converters: KeyValueConverters<CollectibleKey<TITEM>, TITEM>;\n\n  /**\n   * Constructs a new {@link Collections.ValidatingCollector | ValidatingConvertingCollector}\n   * from the supplied {@link Collections.IValidatingCollectorConstructorParams | parameters}.\n   * @param params - Required parameters for constructing the collector.\n   */\n  public constructor(params: IValidatingCollectorConstructorParams<TITEM>) {\n    super();\n    this._converters = params.converters;\n    this.validating = new CollectorValidator({ collector: this, converters: params.converters });\n    for (const item of params.items ?? []) {\n      this.validating.getOrAdd(item).orThrow();\n    }\n  }\n\n  /**\n   * Creates a new {@link Collections.ValidatingCollector | ValidatingCollector} instance from\n   * the supplied {@link Collections.IValidatingCollectorConstructorParams | parameters}.\n   * @param params - Required parameters for constructing the collector.\n   * @returns {@link Success} with the new collector if successful, {@link Failure} otherwise.\n   */\n  public static createValidatingCollector<\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    TITEM extends ICollectible<any, any>\n  >(params: IValidatingCollectorConstructorParams<TITEM>): Result<ValidatingCollector<TITEM>> {\n    return captureResult(() => new ValidatingCollector(params));\n  }\n\n  /**\n   * Gets a read-only version of this collector as a\n   * {@link Collections.IReadOnlyValidatingResultMap | read-only map}.\n   * @returns\n   */\n  public toReadOnly(): IReadOnlyValidatingCollector<TITEM> {\n    return this;\n  }\n}\n"]}

package/lib/packlets/collections/validatingConvertingCollector.d.ts

@@ -0,0 +1,59 @@
+import { Result } from '../base';
+import { CollectibleFactory, CollectibleKey, ICollectible } from './collectible';
+import { ConvertingCollector } from './convertingCollector';
+import { ConvertingCollectorValidator } from './convertingCollectorValidator';
+import { KeyValueEntry } from './common';
+import { KeyValueConverters } from './keyValueConverters';
+import { IReadOnlyValidatingCollector } from './validatingCollector';
+/**
+ * Parameters for constructing a {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector}.
+ * @public
+ */
+export interface IValidatingConvertingCollectorConstructorParams<TITEM extends ICollectible<any, any>, TSRC = TITEM> {
+    /**
+     * {@inheritdoc Collections.IConvertingCollectorConstructorParams.factory}
+     */
+    factory: CollectibleFactory<TITEM, TSRC>;
+    /**
+     * {@inheritdoc Collections.IConvertingCollectorValidatorCreateParams.converters}
+     */
+    converters: KeyValueConverters<CollectibleKey<TITEM>, TSRC>;
+    /**
+     * {@inheritdoc Collections.IConvertingCollectorConstructorParams.entries}
+     */
+    entries?: KeyValueEntry<CollectibleKey<TITEM>, TSRC>[];
+}
+/**
+ * A {@link Collections.ConvertingCollector | ConvertingCollector} with a
+ * {@link Collections.ConvertingCollectorValidator | ConvertingCollectorValidator}
+ * property that enables validated use of the underlying map with weakly-typed keys and values.
+ * @public
+ */
+export declare class ValidatingConvertingCollector<TITEM extends ICollectible<any, any>, TSRC = TITEM> extends ConvertingCollector<TITEM, TSRC> {
+    /**
+     * A {@link Collections.ConvertingCollectorValidator | ConvertingCollectorValidator} which validates keys and values
+     * before inserting them into this collector.
+     */
+    readonly validating: ConvertingCollectorValidator<TITEM, TSRC>;
+    protected readonly _converters: KeyValueConverters<CollectibleKey<TITEM>, TSRC>;
+    /**
+     * Constructs a new {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector}
+     * from the supplied {@link Collections.IValidatingConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     */
+    constructor(params: IValidatingConvertingCollectorConstructorParams<TITEM, TSRC>);
+    /**
+     * Creates a new {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector} instance from
+     * the supplied {@link Collections.IValidatingConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     * @returns {@link Success} with the new collector if successful, {@link Failure} otherwise.
+     */
+    static createValidatingCollector<TITEM extends ICollectible<any, any>, TSRC = TITEM>(params: IValidatingConvertingCollectorConstructorParams<TITEM, TSRC>): Result<ValidatingConvertingCollector<TITEM, TSRC>>;
+    /**
+     * Gets a read-only version of this collector as a
+     * {@link Collections.IReadOnlyValidatingResultMap | read-only map}.
+     * @returns
+     */
+    toReadOnly(): IReadOnlyValidatingCollector<TITEM>;
+}
+//# sourceMappingURL=validatingConvertingCollector.d.ts.map

package/lib/packlets/collections/validatingConvertingCollector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatingConvertingCollector.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/validatingConvertingCollector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,MAAM,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAErE;;;GAGG;AACH,MAAM,WAAW,+CAA+C,CAE9D,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACpC,IAAI,GAAG,KAAK;IAEZ;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,kBAAkB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAE5D;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;CACxD;AAED;;;;;GAKG;AACH,qBAAa,6BAA6B,CAExC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACpC,IAAI,GAAG,KAAK,CACZ,SAAQ,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC;IACxC;;;OAGG;IACH,SAAgB,UAAU,EAAE,4BAA4B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAEtE,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAEhF;;;;OAIG;gBACgB,MAAM,EAAE,+CAA+C,CAAC,KAAK,EAAE,IAAI,CAAC;IASvF;;;;;OAKG;WACW,yBAAyB,CAErC,KAAK,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EACpC,IAAI,GAAG,KAAK,EAEZ,MAAM,EAAE,+CAA+C,CAAC,KAAK,EAAE,IAAI,CAAC,GACnE,MAAM,CAAC,6BAA6B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAIrD;;;;OAIG;IACI,UAAU,IAAI,4BAA4B,CAAC,KAAK,CAAC;CAGzD"}

package/lib/packlets/collections/validatingConvertingCollector.js

@@ -0,0 +1,68 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidatingConvertingCollector = void 0;
+const base_1 = require("../base");
+const convertingCollector_1 = require("./convertingCollector");
+const convertingCollectorValidator_1 = require("./convertingCollectorValidator");
+/**
+ * A {@link Collections.ConvertingCollector | ConvertingCollector} with a
+ * {@link Collections.ConvertingCollectorValidator | ConvertingCollectorValidator}
+ * property that enables validated use of the underlying map with weakly-typed keys and values.
+ * @public
+ */
+class ValidatingConvertingCollector extends convertingCollector_1.ConvertingCollector {
+    /**
+     * Constructs a new {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector}
+     * from the supplied {@link Collections.IValidatingConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     */
+    constructor(params) {
+        var _a;
+        super({ factory: params.factory });
+        this._converters = params.converters;
+        this.validating = new convertingCollectorValidator_1.ConvertingCollectorValidator({ collector: this, converters: params.converters });
+        for (const entry of (_a = params.entries) !== null && _a !== void 0 ? _a : []) {
+            this.getOrAdd(entry[0], entry[1]).orThrow();
+        }
+    }
+    /**
+     * Creates a new {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector} instance from
+     * the supplied {@link Collections.IValidatingConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     * @returns {@link Success} with the new collector if successful, {@link Failure} otherwise.
+     */
+    static createValidatingCollector(params) {
+        return (0, base_1.captureResult)(() => new ValidatingConvertingCollector(params));
+    }
+    /**
+     * Gets a read-only version of this collector as a
+     * {@link Collections.IReadOnlyValidatingResultMap | read-only map}.
+     * @returns
+     */
+    toReadOnly() {
+        return this;
+    }
+}
+exports.ValidatingConvertingCollector = ValidatingConvertingCollector;
+//# sourceMappingURL=validatingConvertingCollector.js.map

package/lib/packlets/collections/validatingConvertingCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatingConvertingCollector.js","sourceRoot":"","sources":["../../../src/packlets/collections/validatingConvertingCollector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAEhD,+DAA4D;AAC5D,iFAA8E;AA8B9E;;;;;GAKG;AACH,MAAa,6BAIX,SAAQ,yCAAgC;IASxC;;;;OAIG;IACH,YAAmB,MAAoE;;QACrF,KAAK,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,2DAA4B,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QACvG,KAAK,MAAM,KAAK,IAAI,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,EAAE,CAAC;YACzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,yBAAyB,CAKrC,MAAoE;QAEpE,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,6BAA6B,CAAC,MAAM,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAnDD,sEAmDC","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 } from '../base';\nimport { CollectibleFactory, CollectibleKey, ICollectible } from './collectible';\nimport { ConvertingCollector } from './convertingCollector';\nimport { ConvertingCollectorValidator } from './convertingCollectorValidator';\nimport { KeyValueEntry } from './common';\nimport { KeyValueConverters } from './keyValueConverters';\nimport { IReadOnlyValidatingCollector } from './validatingCollector';\n\n/**\n * Parameters for constructing a {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector}.\n * @public\n */\nexport interface IValidatingConvertingCollectorConstructorParams<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>,\n  TSRC = TITEM\n> {\n  /**\n   * {@inheritdoc Collections.IConvertingCollectorConstructorParams.factory}\n   */\n  factory: CollectibleFactory<TITEM, TSRC>;\n\n  /**\n   * {@inheritdoc Collections.IConvertingCollectorValidatorCreateParams.converters}\n   */\n  converters: KeyValueConverters<CollectibleKey<TITEM>, TSRC>;\n\n  /**\n   * {@inheritdoc Collections.IConvertingCollectorConstructorParams.entries}\n   */\n  entries?: KeyValueEntry<CollectibleKey<TITEM>, TSRC>[];\n}\n\n/**\n * A {@link Collections.ConvertingCollector | ConvertingCollector} with a\n * {@link Collections.ConvertingCollectorValidator | ConvertingCollectorValidator}\n * property that enables validated use of the underlying map with weakly-typed keys and values.\n * @public\n */\nexport class ValidatingConvertingCollector<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  TITEM extends ICollectible<any, any>,\n  TSRC = TITEM\n> extends ConvertingCollector<TITEM, TSRC> {\n  /**\n   * A {@link Collections.ConvertingCollectorValidator | ConvertingCollectorValidator} which validates keys and values\n   * before inserting them into this collector.\n   */\n  public readonly validating: ConvertingCollectorValidator<TITEM, TSRC>;\n\n  protected readonly _converters: KeyValueConverters<CollectibleKey<TITEM>, TSRC>;\n\n  /**\n   * Constructs a new {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector}\n   * from the supplied {@link Collections.IValidatingConvertingCollectorConstructorParams | parameters}.\n   * @param params - Required parameters for constructing the collector.\n   */\n  public constructor(params: IValidatingConvertingCollectorConstructorParams<TITEM, TSRC>) {\n    super({ factory: params.factory });\n    this._converters = params.converters;\n    this.validating = new ConvertingCollectorValidator({ collector: this, converters: params.converters });\n    for (const entry of params.entries ?? []) {\n      this.getOrAdd(entry[0], entry[1]).orThrow();\n    }\n  }\n\n  /**\n   * Creates a new {@link Collections.ValidatingConvertingCollector | ValidatingConvertingCollector} instance from\n   * the supplied {@link Collections.IValidatingConvertingCollectorConstructorParams | parameters}.\n   * @param params - Required parameters for constructing the collector.\n   * @returns {@link Success} with the new collector if successful, {@link Failure} otherwise.\n   */\n  public static createValidatingCollector<\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    TITEM extends ICollectible<any, any>,\n    TSRC = TITEM\n  >(\n    params: IValidatingConvertingCollectorConstructorParams<TITEM, TSRC>\n  ): Result<ValidatingConvertingCollector<TITEM, TSRC>> {\n    return captureResult(() => new ValidatingConvertingCollector(params));\n  }\n\n  /**\n   * Gets a read-only version of this collector as a\n   * {@link Collections.IReadOnlyValidatingResultMap | read-only map}.\n   * @returns\n   */\n  public toReadOnly(): IReadOnlyValidatingCollector<TITEM> {\n    return this;\n  }\n}\n"]}

package/lib/packlets/collections/{convertingResultMap.d.ts → validatingResultMap.d.ts}

@@ -3,51 +3,51 @@ import { KeyValueEntry } from './common';
 import { KeyValueConverters } from './keyValueConverters';
 import { IReadOnlyResultMap } from './readonlyResultMap';
 import { ResultMap } from './resultMap';
-import { IReadOnlyResultMapConverter, ResultMapConverter } from './resultMapConverter';
+import { IReadOnlyResultMapValidator, ResultMapValidator } from './resultMapValidator';
 /**
- * A read-only interface exposing non-mutating methods of a {@link Collections.ConvertingResultMap | ConvertingResultMap}.
+ * A read-only interface exposing non-mutating methods of a {@link Collections.ValidatingResultMap | ValidatingResultMap}.
  * @public
  */
-export interface IReadOnlyConvertingResultMap<TK extends string = string, TV = unknown> extends IReadOnlyResultMap<TK, TV> {
+export interface IReadOnlyValidatingResultMap<TK extends string = string, TV = unknown> extends IReadOnlyResultMap<TK, TV> {
     /**
-     * {@inheritdoc Collections.ConvertingResultMap.converting}
+     * {@inheritdoc Collections.ValidatingResultMap.validating}
      */
-    readonly converting: IReadOnlyResultMapConverter<TK, TV>;
+    readonly validating: IReadOnlyResultMapValidator<TK, TV>;
 }
 /**
  * Parameters for constructing a {@link Collections.ResultMap | ResultMap}.
  * @public
  */
-export interface IConvertingResultMapConstructorParams<TK extends string = string, TV = unknown> {
+export interface IValidatingResultMapConstructorParams<TK extends string = string, TV = unknown> {
     entries?: Iterable<KeyValueEntry<string, unknown>>;
     converters: KeyValueConverters<TK, TV>;
 }
 /**
- * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapConverter | validator}
+ * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapValidator | validator}
  * property that enables validated use of the underlying map with weakly-typed keys and values.
  * @public
  */
-export declare class ConvertingResultMap<TK extends string = string, TV = unknown> extends ResultMap<TK, TV> implements IReadOnlyConvertingResultMap<TK, TV> {
+export declare class ValidatingResultMap<TK extends string = string, TV = unknown> extends ResultMap<TK, TV> implements IReadOnlyValidatingResultMap<TK, TV> {
     /**
-     * A {@link Collections.ResultMapConverter | ResultMapConverter} which validates keys and values
+     * A {@link Collections.ResultMapValidator | ResultMapValidator} which validates keys and values
      * before inserting them into this collection.
      */
-    readonly converting: ResultMapConverter<TK, TV>;
+    readonly validating: ResultMapValidator<TK, TV>;
     /**
-     * Constructs a new {@link Collections.ConvertingResultMap | ConvertingResultMap}.
+     * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.
      * @param params - Required parameters for constructing the map.
      */
-    constructor(params: IConvertingResultMapConstructorParams<TK, TV>);
+    constructor(params: IValidatingResultMapConstructorParams<TK, TV>);
     /**
-     * Creates a new {@link Collections.ConvertingResultMap | ConvertingResultMap} instance.
+     * Creates a new {@link Collections.ValidatingResultMap | ValidatingResultMap} instance.
      * @param params - Required parameters for constructing the map.
      * @returns `Success` with the new map if successful, `Failure` otherwise.
      * @public
      */
-    static createConvertingResultMap<TK extends string = string, TV = unknown>(params: IConvertingResultMapConstructorParams<TK, TV>): Result<ConvertingResultMap<TK, TV>>;
+    static createValidatingResultMap<TK extends string = string, TV = unknown>(params: IValidatingResultMapConstructorParams<TK, TV>): Result<ValidatingResultMap<TK, TV>>;
     /**
      * Gets a read-only version of this map.
      */
-    toReadOnly(): IReadOnlyConvertingResultMap<TK, TV>;
+    toReadOnly(): IReadOnlyValidatingResultMap<TK, TV>;
 }
-//# sourceMappingURL=convertingResultMap.d.ts.map
+//# sourceMappingURL=validatingResultMap.d.ts.map

package/lib/packlets/collections/{convertingResultMap.d.ts.map → validatingResultMap.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"convertingResultMap.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/convertingResultMap.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,MAAM,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CACpF,SAAQ,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,2BAA2B,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAqC,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IAC7F,OAAO,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,mBAAmB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CACvE,SAAQ,SAAS,CAAC,EAAE,EAAE,EAAE,CACxB,YAAW,4BAA4B,CAAC,EAAE,EAAE,EAAE,CAAC;IAE/C;;;OAGG;IACH,SAAgB,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAEvD;;;OAGG;gBACgB,MAAM,EAAE,qCAAqC,CAAC,EAAE,EAAE,EAAE,CAAC;IAMxE;;;;;OAKG;WACW,yBAAyB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,EAC9E,MAAM,EAAE,qCAAqC,CAAC,EAAE,EAAE,EAAE,CAAC,GACpD,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAItC;;OAEG;IACI,UAAU,IAAI,4BAA4B,CAAC,EAAE,EAAE,EAAE,CAAC;CAG1D"}
+{"version":3,"file":"validatingResultMap.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/validatingResultMap.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,MAAM,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CACpF,SAAQ,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,2BAA2B,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAqC,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IAC7F,OAAO,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,mBAAmB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,CACvE,SAAQ,SAAS,CAAC,EAAE,EAAE,EAAE,CACxB,YAAW,4BAA4B,CAAC,EAAE,EAAE,EAAE,CAAC;IAE/C;;;OAGG;IACH,SAAgB,UAAU,EAAE,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAEvD;;;OAGG;gBACgB,MAAM,EAAE,qCAAqC,CAAC,EAAE,EAAE,EAAE,CAAC;IAMxE;;;;;OAKG;WACW,yBAAyB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO,EAC9E,MAAM,EAAE,qCAAqC,CAAC,EAAE,EAAE,EAAE,CAAC,GACpD,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAItC;;OAEG;IACI,UAAU,IAAI,4BAA4B,CAAC,EAAE,EAAE,EAAE,CAAC;CAG1D"}

package/lib/packlets/collections/{convertingResultMap.js → validatingResultMap.js}

@@ -21,34 +21,34 @@
  * SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConvertingResultMap = void 0;
+exports.ValidatingResultMap = void 0;
 const base_1 = require("../base");
 const resultMap_1 = require("./resultMap");
-const resultMapConverter_1 = require("./resultMapConverter");
+const resultMapValidator_1 = require("./resultMapValidator");
 /**
- * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapConverter | validator}
+ * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapValidator | validator}
  * property that enables validated use of the underlying map with weakly-typed keys and values.
  * @public
  */
-class ConvertingResultMap extends resultMap_1.ResultMap {
+class ValidatingResultMap extends resultMap_1.ResultMap {
     /**
-     * Constructs a new {@link Collections.ConvertingResultMap | ConvertingResultMap}.
+     * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.
      * @param params - Required parameters for constructing the map.
      */
     constructor(params) {
         var _a;
         const entries = params.converters.convertEntries([...((_a = params.entries) !== null && _a !== void 0 ? _a : [])]).orThrow();
         super({ entries });
-        this.converting = new resultMapConverter_1.ResultMapConverter({ map: this, converters: params.converters });
+        this.validating = new resultMapValidator_1.ResultMapValidator({ map: this, converters: params.converters });
     }
     /**
-     * Creates a new {@link Collections.ConvertingResultMap | ConvertingResultMap} instance.
+     * Creates a new {@link Collections.ValidatingResultMap | ValidatingResultMap} instance.
      * @param params - Required parameters for constructing the map.
      * @returns `Success` with the new map if successful, `Failure` otherwise.
      * @public
      */
-    static createConvertingResultMap(params) {
-        return (0, base_1.captureResult)(() => new ConvertingResultMap(params));
+    static createValidatingResultMap(params) {
+        return (0, base_1.captureResult)(() => new ValidatingResultMap(params));
     }
     /**
      * Gets a read-only version of this map.
@@ -57,5 +57,5 @@ class ConvertingResultMap extends resultMap_1.ResultMap {
         return this;
     }
 }
-exports.ConvertingResultMap = ConvertingResultMap;
-//# sourceMappingURL=convertingResultMap.js.map
+exports.ValidatingResultMap = ValidatingResultMap;
+//# sourceMappingURL=validatingResultMap.js.map

package/lib/packlets/collections/{convertingResultMap.js.map → validatingResultMap.js.map}

@@ -1 +1 @@
-{"version":3,"file":"convertingResultMap.js","sourceRoot":"","sources":["../../../src/packlets/collections/convertingResultMap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAIhD,2CAAwC;AACxC,6DAAuF;AAuBvF;;;;GAIG;AACH,MAAa,mBACX,SAAQ,qBAAiB;IASzB;;;OAGG;IACH,YAAmB,MAAqD;;QACtE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACxF,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAI,uCAAkB,CAAS,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,yBAAyB,CACrC,MAAqD;QAErD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtCD,kDAsCC","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 } from '../base';\nimport { KeyValueEntry } from './common';\nimport { KeyValueConverters } from './keyValueConverters';\nimport { IReadOnlyResultMap } from './readonlyResultMap';\nimport { ResultMap } from './resultMap';\nimport { IReadOnlyResultMapConverter, ResultMapConverter } from './resultMapConverter';\n\n/**\n * A read-only interface exposing non-mutating methods of a {@link Collections.ConvertingResultMap | ConvertingResultMap}.\n * @public\n */\nexport interface IReadOnlyConvertingResultMap<TK extends string = string, TV = unknown>\n  extends IReadOnlyResultMap<TK, TV> {\n  /**\n   * {@inheritdoc Collections.ConvertingResultMap.converting}\n   */\n  readonly converting: IReadOnlyResultMapConverter<TK, TV>;\n}\n\n/**\n * Parameters for constructing a {@link Collections.ResultMap | ResultMap}.\n * @public\n */\nexport interface IConvertingResultMapConstructorParams<TK extends string = string, TV = unknown> {\n  entries?: Iterable<KeyValueEntry<string, unknown>>;\n  converters: KeyValueConverters<TK, TV>;\n}\n\n/**\n * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapConverter | validator}\n * property that enables validated use of the underlying map with weakly-typed keys and values.\n * @public\n */\nexport class ConvertingResultMap<TK extends string = string, TV = unknown>\n  extends ResultMap<TK, TV>\n  implements IReadOnlyConvertingResultMap<TK, TV>\n{\n  /**\n   * A {@link Collections.ResultMapConverter | ResultMapConverter} which validates keys and values\n   * before inserting them into this collection.\n   */\n  public readonly converting: ResultMapConverter<TK, TV>;\n\n  /**\n   * Constructs a new {@link Collections.ConvertingResultMap | ConvertingResultMap}.\n   * @param params - Required parameters for constructing the map.\n   */\n  public constructor(params: IConvertingResultMapConstructorParams<TK, TV>) {\n    const entries = params.converters.convertEntries([...(params.entries ?? [])]).orThrow();\n    super({ entries });\n    this.converting = new ResultMapConverter<TK, TV>({ map: this, converters: params.converters });\n  }\n\n  /**\n   * Creates a new {@link Collections.ConvertingResultMap | ConvertingResultMap} instance.\n   * @param params - Required parameters for constructing the map.\n   * @returns `Success` with the new map if successful, `Failure` otherwise.\n   * @public\n   */\n  public static createConvertingResultMap<TK extends string = string, TV = unknown>(\n    params: IConvertingResultMapConstructorParams<TK, TV>\n  ): Result<ConvertingResultMap<TK, TV>> {\n    return captureResult(() => new ConvertingResultMap(params));\n  }\n\n  /**\n   * Gets a read-only version of this map.\n   */\n  public toReadOnly(): IReadOnlyConvertingResultMap<TK, TV> {\n    return this;\n  }\n}\n"]}
+{"version":3,"file":"validatingResultMap.js","sourceRoot":"","sources":["../../../src/packlets/collections/validatingResultMap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAIhD,2CAAwC;AACxC,6DAAuF;AAuBvF;;;;GAIG;AACH,MAAa,mBACX,SAAQ,qBAAiB;IASzB;;;OAGG;IACH,YAAmB,MAAqD;;QACtE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACxF,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAI,uCAAkB,CAAS,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,yBAAyB,CACrC,MAAqD;QAErD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtCD,kDAsCC","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 } from '../base';\nimport { KeyValueEntry } from './common';\nimport { KeyValueConverters } from './keyValueConverters';\nimport { IReadOnlyResultMap } from './readonlyResultMap';\nimport { ResultMap } from './resultMap';\nimport { IReadOnlyResultMapValidator, ResultMapValidator } from './resultMapValidator';\n\n/**\n * A read-only interface exposing non-mutating methods of a {@link Collections.ValidatingResultMap | ValidatingResultMap}.\n * @public\n */\nexport interface IReadOnlyValidatingResultMap<TK extends string = string, TV = unknown>\n  extends IReadOnlyResultMap<TK, TV> {\n  /**\n   * {@inheritdoc Collections.ValidatingResultMap.validating}\n   */\n  readonly validating: IReadOnlyResultMapValidator<TK, TV>;\n}\n\n/**\n * Parameters for constructing a {@link Collections.ResultMap | ResultMap}.\n * @public\n */\nexport interface IValidatingResultMapConstructorParams<TK extends string = string, TV = unknown> {\n  entries?: Iterable<KeyValueEntry<string, unknown>>;\n  converters: KeyValueConverters<TK, TV>;\n}\n\n/**\n * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapValidator | validator}\n * property that enables validated use of the underlying map with weakly-typed keys and values.\n * @public\n */\nexport class ValidatingResultMap<TK extends string = string, TV = unknown>\n  extends ResultMap<TK, TV>\n  implements IReadOnlyValidatingResultMap<TK, TV>\n{\n  /**\n   * A {@link Collections.ResultMapValidator | ResultMapValidator} which validates keys and values\n   * before inserting them into this collection.\n   */\n  public readonly validating: ResultMapValidator<TK, TV>;\n\n  /**\n   * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.\n   * @param params - Required parameters for constructing the map.\n   */\n  public constructor(params: IValidatingResultMapConstructorParams<TK, TV>) {\n    const entries = params.converters.convertEntries([...(params.entries ?? [])]).orThrow();\n    super({ entries });\n    this.validating = new ResultMapValidator<TK, TV>({ map: this, converters: params.converters });\n  }\n\n  /**\n   * Creates a new {@link Collections.ValidatingResultMap | ValidatingResultMap} instance.\n   * @param params - Required parameters for constructing the map.\n   * @returns `Success` with the new map if successful, `Failure` otherwise.\n   * @public\n   */\n  public static createValidatingResultMap<TK extends string = string, TV = unknown>(\n    params: IValidatingResultMapConstructorParams<TK, TV>\n  ): Result<ValidatingResultMap<TK, TV>> {\n    return captureResult(() => new ValidatingResultMap(params));\n  }\n\n  /**\n   * Gets a read-only version of this map.\n   */\n  public toReadOnly(): IReadOnlyValidatingResultMap<TK, TV> {\n    return this;\n  }\n}\n"]}

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

@@ -0,0 +1,47 @@
+import { Result } from '../base';
+import { FileTreeItem, IFileTreeAccessors, IFileTreeDirectoryItem } from './fileTreeAccessors';
+/**
+ * Class representing a directory in a file tree.
+ * @public
+ */
+export declare class DirectoryItem implements IFileTreeDirectoryItem {
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem."type"}
+     */
+    readonly type: 'directory';
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.absolutePath}
+     */
+    readonly absolutePath: string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.name}
+     */
+    get name(): string;
+    /**
+     * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.
+     * @public
+     */
+    protected readonly _hal: IFileTreeAccessors;
+    /**
+     * Protected constructor for derived classes.
+     * @param path - Relative path of the directory.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    protected constructor(path: string, hal: IFileTreeAccessors);
+    /**
+     * 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 A {@link Result | result} containing the new DirectoryItem instance if successful,
+     * or a failure if an error occurs.
+     */
+    static create(path: string, hal: IFileTreeAccessors): Result<DirectoryItem>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}
+     */
+    getChildren(): Result<ReadonlyArray<FileTreeItem>>;
+}
+//# sourceMappingURL=directoryItem.d.ts.map

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,EAAiB,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE/F;;;GAGG;AACH,qBAAa,aAAc,YAAW,sBAAsB;IAC1D;;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;IAE5C;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB;IAK3D;;;;;;;OAOG;WACW,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,GAAG,MAAM,CAAC,aAAa,CAAC;IAIlF;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;CAG1D"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"directoryItem.js","sourceRoot":"","sources":["../../../src/packlets/file-tree/directoryItem.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAGhD;;;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,GAAuB;QA9B3D;;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,CAAC,IAAY,EAAE,GAAuB;QACxD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;CACF;AAtDD,sCAsDC","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 } from '../base';\nimport { FileTreeItem, IFileTreeAccessors, IFileTreeDirectoryItem } from './fileTreeAccessors';\n\n/**\n * Class representing a directory in a file tree.\n * @public\n */\nexport class DirectoryItem implements IFileTreeDirectoryItem {\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;\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) {\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 A {@link Result | result} containing the new DirectoryItem instance if successful,\n   * or a failure if an error occurs.\n   */\n  public static create(path: string, hal: IFileTreeAccessors): Result<DirectoryItem> {\n    return captureResult(() => new DirectoryItem(path, hal));\n  }\n\n  /**\n   * {@inheritdoc FileTree.IFileTreeDirectoryItem.getChildren}\n   */\n  public getChildren(): Result<ReadonlyArray<FileTreeItem>> {\n    return this._hal.getChildren(this.absolutePath);\n  }\n}\n"]}

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

@@ -0,0 +1,64 @@
+import { Result } from '../base';
+import { Converter } from '../conversion';
+import { Validator } from '../validation';
+import { IFileTreeAccessors, IFileTreeFileItem } from './fileTreeAccessors';
+/**
+ * Class representing a file in a file tree.
+ * @public
+ */
+export declare class FileItem implements IFileTreeFileItem {
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem."type"}
+     */
+    readonly type: 'file';
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.absolutePath}
+     */
+    readonly absolutePath: string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.name}
+     */
+    get name(): string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.baseName}
+     */
+    get baseName(): string;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.extension}
+     */
+    get extension(): string;
+    /**
+     * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.
+     * @public
+     */
+    protected readonly _hal: IFileTreeAccessors;
+    /**
+     * Protected constructor for derived classes.
+     * @param path - Relative path of the file.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    protected constructor(path: string, hal: IFileTreeAccessors);
+    /**
+     * Creates a new {@link FileTree.FileItem | 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: string, hal: IFileTreeAccessors): Result<FileItem>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:1)}
+     */
+    getContents(): Result<unknown>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:2)}
+     */
+    getContents<T>(converter: Validator<T> | Converter<T>): Result<T>;
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.getRawContents}
+     */
+    getRawContents(): Result<string>;
+}
+//# sourceMappingURL=fileItem.d.ts.map

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,MAAM,EAAW,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE5E;;;GAGG;AACH,qBAAa,QAAS,YAAW,iBAAiB;IAChD;;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;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAE5C;;;;;;OAMG;IACH,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB;IAK3D;;;;;;OAMG;WACW,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,GAAG,MAAM,CAAC,QAAQ,CAAC;IAI7E;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,OAAO,CAAC;IACrC;;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;CAGxC"}

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

@@ -0,0 +1,93 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileItem = void 0;
+const base_1 = require("../base");
+/**
+ * Class representing a file in a file tree.
+ * @public
+ */
+class FileItem {
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.name}
+     */
+    get name() {
+        return this._hal.getBaseName(this.absolutePath);
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.baseName}
+     */
+    get baseName() {
+        return this._hal.getBaseName(this.absolutePath, this.extension);
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.extension}
+     */
+    get extension() {
+        return this._hal.getExtension(this.absolutePath);
+    }
+    /**
+     * 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);
+    }
+    /**
+     * Creates a new {@link FileTree.FileItem | FileItem} instance.
+     * @param path - Relative path of the file.
+     * @param hal - The {@link FileTree.IFileTreeAccessors | accessors} to use for
+     * file system operations.
+     * @public
+     */
+    static create(path, hal) {
+        return (0, base_1.captureResult)(() => new FileItem(path, hal));
+    }
+    getContents(converter) {
+        return this._hal
+            .getFileContents(this.absolutePath)
+            .onSuccess((body) => (0, base_1.captureResult)(() => JSON.parse(body)).onFailure(() => (0, base_1.succeed)(body)))
+            .onSuccess((parsed) => {
+            if (converter !== undefined) {
+                return converter.convert(parsed);
+            }
+            return (0, base_1.succeed)(parsed);
+        });
+    }
+    /**
+     * {@inheritdoc FileTree.IFileTreeFileItem.getRawContents}
+     */
+    getRawContents() {
+        return this._hal.getFileContents(this.absolutePath);
+    }
+}
+exports.FileItem = FileItem;
+//# sourceMappingURL=fileItem.js.map

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,kCAAyD;AAKzD;;;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;IAQD;;;;;;OAMG;IACH,YAAsB,IAAY,EAAE,GAAuB;QA5C3D;;WAEG;QACa,SAAI,GAAW,MAAM,CAAC;QA0CpC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,GAAuB;QACxD,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACtD,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,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC;aACzF,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;YACpB,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtD,CAAC;CACF;AAvFD,4BAuFC","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, succeed } from '../base';\nimport { Converter } from '../conversion';\nimport { Validator } from '../validation';\nimport { IFileTreeAccessors, IFileTreeFileItem } from './fileTreeAccessors';\n\n/**\n * Class representing a file in a file tree.\n * @public\n */\nexport class FileItem implements IFileTreeFileItem {\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   * The {@link FileTree.IFileTreeAccessors | accessors} to use for file system operations.\n   * @public\n   */\n  protected readonly _hal: IFileTreeAccessors;\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) {\n    this._hal = hal;\n    this.absolutePath = hal.resolveAbsolutePath(path);\n  }\n\n  /**\n   * Creates a new {@link FileTree.FileItem | 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(path: string, hal: IFileTreeAccessors): Result<FileItem> {\n    return captureResult(() => new FileItem(path, hal));\n  }\n\n  /**\n   * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:1)}\n   */\n  public getContents(): Result<unknown>;\n  /**\n   * {@inheritdoc FileTree.IFileTreeFileItem.(getContents:2)}\n   */\n  public getContents<T>(converter: Validator<T> | Converter<T>): Result<T>;\n  public getContents<T>(converter?: Validator<T> | Converter<T>): Result<T | unknown> {\n    return this._hal\n      .getFileContents(this.absolutePath)\n      .onSuccess((body) => captureResult(() => JSON.parse(body)).onFailure(() => succeed(body)))\n      .onSuccess((parsed) => {\n        if (converter !== undefined) {\n          return converter.convert(parsed);\n        }\n        return succeed(parsed);\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"]}