@fgv/ts-utils 4.2.1 → 4.3.0

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

@@ -0,0 +1,67 @@
+import { DetailedResult, Result } from '../base';
+import { CollectibleFactory, CollectibleFactoryCallback, ICollectible } from './collectible';
+import { Collector } from './collector';
+import { CollectorConverter } from './collectorConverter';
+import { KeyValueEntry } from './common';
+import { IReadOnlyConvertingResultMap } from './convertingResultMap';
+import { KeyValueConverters } from './keyValueConverters';
+import { ResultMapResultDetail } from './readonlyResultMap';
+/**
+ * Parameters for constructing a {@link Collections.ConvertingCollector | ConvertingCollector}.
+ * @public
+ */
+export interface IConvertingCollectorConstructorParams<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM> {
+    /**
+     * {@inheritdoc Collections.ICollectorConstructorParams.factory}
+     */
+    factory: CollectibleFactory<TKEY, TINDEX, TITEM, TSRC>;
+    /**
+     * {@inheritdoc Collections.ICollectorConverterCreateParams.converters}
+     */
+    converters: KeyValueConverters<TKEY, TSRC>;
+    /**
+     * {@inheritdoc Collections.ICollectorConstructorParams.entries}
+     */
+    entries?: KeyValueEntry<TKEY, TSRC>[];
+}
+/**
+ * A {@link Collections.Collector | Collector} with a {@link Collections.CollectorConverter | CollectorConverter}
+ * property that enables validated use of the underlying map with weakly-typed keys and values.
+ * @public
+ */
+export declare class ConvertingCollector<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM> extends Collector<TKEY, TINDEX, TITEM, TSRC> {
+    /**
+     * A {@link Collections.CollectorConverter | CollectorConverter} which validates keys and values
+     * before inserting them into this collector.
+     */
+    readonly converting: CollectorConverter<TKEY, TINDEX, TITEM, TSRC>;
+    protected readonly _converters: KeyValueConverters<TKEY, TSRC>;
+    /**
+     * Constructs a new {@link Collections.ConvertingCollector | ConvertingCollector}
+     * from the supplied {@link Collections.IConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     */
+    constructor(params: IConvertingCollectorConstructorParams<TKEY, TINDEX, TITEM, TSRC>);
+    /**
+     * Creates a new {@link Collections.ConvertingCollector | ConvertingCollector} instance from
+     * the supplied {@link Collections.IConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     * @returns {@link Success} with the new collector if successful, {@link Failure} otherwise.
+     */
+    static createConvertingCollector<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM>(params: IConvertingCollectorConstructorParams<TKEY, TINDEX, TITEM, TSRC>): Result<ConvertingCollector<TKEY, TINDEX, TITEM, TSRC>>;
+    /**
+     * {@inheritdoc Collections.Collector.(getOrAdd:1)}
+     */
+    getOrAdd(key: TKEY, item: TSRC): DetailedResult<TITEM, ResultMapResultDetail>;
+    /**
+     * {@inheritdoc Collections.Collector.(getOrAdd:2)}
+     */
+    getOrAdd(key: TKEY, cb: CollectibleFactoryCallback<TKEY, TINDEX, TITEM>): DetailedResult<TITEM, ResultMapResultDetail>;
+    /**
+     * Gets a read-only version of this collector as a
+     * {@link Collections.IReadOnlyConvertingResultMap | read-only map}.
+     * @returns
+     */
+    toReadOnly(): IReadOnlyConvertingResultMap<TKEY, TITEM>;
+}
+//# sourceMappingURL=convertingCollector.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"convertingCollector.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/convertingCollector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,cAAc,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7F,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,qCAAqC,CACpD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,KAAK,SAAS,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EACrE,IAAI,GAAG,KAAK;IAEZ;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAEvD;;OAEG;IACH,UAAU,EAAE,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;CACvC;AAED;;;;GAIG;AACH,qBAAa,mBAAmB,CAC9B,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,KAAK,SAAS,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EACrE,IAAI,GAAG,KAAK,CACZ,SAAQ,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IAC5C;;;OAGG;IACH,SAAgB,UAAU,EAAE,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAE1E,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE/D;;;;OAIG;gBACgB,MAAM,EAAE,qCAAqC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IAS3F;;;;;OAKG;WACW,yBAAyB,CACrC,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,KAAK,SAAS,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EACrE,IAAI,GAAG,KAAK,EAEZ,MAAM,EAAE,qCAAqC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,GACvE,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAIzD;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAEpF;;OAEG;IACI,QAAQ,CACb,GAAG,EAAE,IAAI,EACT,EAAE,EAAE,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,GAClD,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAe/C;;;;OAIG;IACI,UAAU,IAAI,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC;CAG/D"}

package/lib/packlets/collections/convertingCollector.js

@@ -0,0 +1,77 @@
+"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.ConvertingCollector = void 0;
+const base_1 = require("../base");
+const collector_1 = require("./collector");
+const collectorConverter_1 = require("./collectorConverter");
+/**
+ * A {@link Collections.Collector | Collector} with a {@link Collections.CollectorConverter | CollectorConverter}
+ * property that enables validated use of the underlying map with weakly-typed keys and values.
+ * @public
+ */
+class ConvertingCollector extends collector_1.Collector {
+    /**
+     * Constructs a new {@link Collections.ConvertingCollector | ConvertingCollector}
+     * from the supplied {@link Collections.IConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     */
+    constructor(params) {
+        var _a;
+        super({ factory: params.factory });
+        this._converters = params.converters;
+        this.converting = new collectorConverter_1.CollectorConverter({ 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.ConvertingCollector | ConvertingCollector} instance from
+     * the supplied {@link Collections.IConvertingCollectorConstructorParams | parameters}.
+     * @param params - Required parameters for constructing the collector.
+     * @returns {@link Success} with the new collector if successful, {@link Failure} otherwise.
+     */
+    static createConvertingCollector(params) {
+        return (0, base_1.captureResult)(() => new ConvertingCollector(params));
+    }
+    getOrAdd(key, itemOrCb) {
+        if (this._isFactoryCB(itemOrCb)) {
+            return this.converting.converters.convertKey(key).onSuccess((k) => {
+                return super.getOrAdd(k, itemOrCb);
+            });
+        }
+        return this.converting.converters.convertEntry([key, itemOrCb]).onSuccess(([k, v]) => {
+            return super.getOrAdd(k, v);
+        });
+    }
+    /**
+     * Gets a read-only version of this collector as a
+     * {@link Collections.IReadOnlyConvertingResultMap | read-only map}.
+     * @returns
+     */
+    toReadOnly() {
+        return this;
+    }
+}
+exports.ConvertingCollector = ConvertingCollector;
+//# sourceMappingURL=convertingCollector.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"convertingCollector.js","sourceRoot":"","sources":["../../../src/packlets/collections/convertingCollector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgE;AAEhE,2CAAwC;AACxC,6DAA0D;AAgC1D;;;;GAIG;AACH,MAAa,mBAKX,SAAQ,qBAAoC;IAS5C;;;;OAIG;IACH,YAAmB,MAAwE;;QACzF,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,uCAAkB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QAC7F,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,CAMrC,MAAwE;QAExE,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAcM,QAAQ,CACb,GAAS,EACT,QAAgE;QAEhE,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;gBAChE,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;YACnF,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/ED,kDA+EC","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, Result } from '../base';\nimport { CollectibleFactory, CollectibleFactoryCallback, ICollectible } from './collectible';\nimport { Collector } from './collector';\nimport { CollectorConverter } from './collectorConverter';\nimport { KeyValueEntry } from './common';\nimport { IReadOnlyConvertingResultMap } from './convertingResultMap';\nimport { KeyValueConverters } from './keyValueConverters';\nimport { ResultMapResultDetail } from './readonlyResultMap';\n\n/**\n * Parameters for constructing a {@link Collections.ConvertingCollector | ConvertingCollector}.\n * @public\n */\nexport interface IConvertingCollectorConstructorParams<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>,\n  TSRC = TITEM\n> {\n  /**\n   * {@inheritdoc Collections.ICollectorConstructorParams.factory}\n   */\n  factory: CollectibleFactory<TKEY, TINDEX, TITEM, TSRC>;\n\n  /**\n   * {@inheritdoc Collections.ICollectorConverterCreateParams.converters}\n   */\n  converters: KeyValueConverters<TKEY, TSRC>;\n\n  /**\n   * {@inheritdoc Collections.ICollectorConstructorParams.entries}\n   */\n  entries?: KeyValueEntry<TKEY, TSRC>[];\n}\n\n/**\n * A {@link Collections.Collector | Collector} with a {@link Collections.CollectorConverter | CollectorConverter}\n * property that enables validated use of the underlying map with weakly-typed keys and values.\n * @public\n */\nexport class ConvertingCollector<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>,\n  TSRC = TITEM\n> extends Collector<TKEY, TINDEX, TITEM, TSRC> {\n  /**\n   * A {@link Collections.CollectorConverter | CollectorConverter} which validates keys and values\n   * before inserting them into this collector.\n   */\n  public readonly converting: CollectorConverter<TKEY, TINDEX, TITEM, TSRC>;\n\n  protected readonly _converters: KeyValueConverters<TKEY, TSRC>;\n\n  /**\n   * Constructs a new {@link Collections.ConvertingCollector | ConvertingCollector}\n   * from the supplied {@link Collections.IConvertingCollectorConstructorParams | parameters}.\n   * @param params - Required parameters for constructing the collector.\n   */\n  public constructor(params: IConvertingCollectorConstructorParams<TKEY, TINDEX, TITEM, TSRC>) {\n    super({ factory: params.factory });\n    this._converters = params.converters;\n    this.converting = new CollectorConverter({ 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.ConvertingCollector | ConvertingCollector} instance from\n   * the supplied {@link Collections.IConvertingCollectorConstructorParams | 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 createConvertingCollector<\n    TKEY extends string = string,\n    TINDEX extends number = number,\n    TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>,\n    TSRC = TITEM\n  >(\n    params: IConvertingCollectorConstructorParams<TKEY, TINDEX, TITEM, TSRC>\n  ): Result<ConvertingCollector<TKEY, TINDEX, TITEM, TSRC>> {\n    return captureResult(() => new ConvertingCollector(params));\n  }\n\n  /**\n   * {@inheritdoc Collections.Collector.(getOrAdd:1)}\n   */\n  public getOrAdd(key: TKEY, item: TSRC): DetailedResult<TITEM, ResultMapResultDetail>;\n\n  /**\n   * {@inheritdoc Collections.Collector.(getOrAdd:2)}\n   */\n  public getOrAdd(\n    key: TKEY,\n    cb: CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): DetailedResult<TITEM, ResultMapResultDetail>;\n  public getOrAdd(\n    key: TKEY,\n    itemOrCb: TSRC | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): DetailedResult<TITEM, ResultMapResultDetail> {\n    if (this._isFactoryCB(itemOrCb)) {\n      return this.converting.converters.convertKey(key).onSuccess((k) => {\n        return super.getOrAdd(k, itemOrCb);\n      });\n    }\n    return this.converting.converters.convertEntry([key, itemOrCb]).onSuccess(([k, v]) => {\n      return super.getOrAdd(k, v);\n    });\n  }\n\n  /**\n   * Gets a read-only version of this collector as a\n   * {@link Collections.IReadOnlyConvertingResultMap | read-only map}.\n   * @returns\n   */\n  public toReadOnly(): IReadOnlyConvertingResultMap<TKEY, TITEM> {\n    return this;\n  }\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"convertingResultMap.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/convertingResultMap.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAiB,cAAc,EAAkB,MAAM,EAAW,MAAM,SAAS,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;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,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMzE;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAC9E;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,qBAAqB,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAqB3G;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAMzE;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAM5E;;OAEG;IACI,UAAU,IAAI,4BAA4B,CAAC,EAAE,EAAE,EAAE,CAAC;CAG1D"}

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

@@ -21,54 +21,54 @@
  * SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidatingResultMap = void 0;
+exports.ConvertingResultMap = void 0;
 const base_1 = require("../base");
 const resultMap_1 = require("./resultMap");
-const resultMapValidator_1 = require("./resultMapValidator");
+const resultMapConverter_1 = require("./resultMapConverter");
 /**
- * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapValidator | validator}
+ * A {@link Collections.ResultMap | ResultMap} with a {@link Collections.ResultMapConverter | validator}
  * property that enables validated use of the underlying map with weakly-typed keys and values.
  * @public
  */
-class ValidatingResultMap extends resultMap_1.ResultMap {
+class ConvertingResultMap extends resultMap_1.ResultMap {
     /**
-     * Constructs a new {@link Collections.ValidatingResultMap | ValidatingResultMap}.
+     * Constructs a new {@link Collections.ConvertingResultMap | ConvertingResultMap}.
      * @param params - Required parameters for constructing the map.
      */
     constructor(params) {
         var _a;
-        const entries = params.validators.validateEntries([...((_a = params.entries) !== null && _a !== void 0 ? _a : [])]).orThrow();
+        const entries = params.converters.convertEntries([...((_a = params.entries) !== null && _a !== void 0 ? _a : [])]).orThrow();
         super({ entries });
-        this.validate = new resultMapValidator_1.ResultMapValidator({ map: this, validators: params.validators });
+        this.converting = new resultMapConverter_1.ResultMapConverter({ map: this, converters: params.converters });
     }
     /**
-     * Creates a new {@link Collections.ValidatingResultMap | ValidatingResultMap} instance.
+     * Creates a new {@link Collections.ConvertingResultMap | ConvertingResultMap} instance.
      * @param params - Required parameters for constructing the map.
      * @returns `Success` with the new map if successful, `Failure` otherwise.
      * @public
      */
-    static createValidating(params) {
-        return (0, base_1.captureResult)(() => new ValidatingResultMap(params));
+    static createConvertingResultMap(params) {
+        return (0, base_1.captureResult)(() => new ConvertingResultMap(params));
     }
     /**
      * {@inheritdoc Collections.ResultMap.add}
      */
     add(key, value) {
-        return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {
+        return this.converting.converters.convertEntry([key, value]).onSuccess((entry) => {
             return super.add(entry[0], entry[1]);
         });
     }
     getOrAdd(key, valueOrFactory) {
         if (!this._isResultMapValueFactory(valueOrFactory)) {
-            return this.validate.validators.validateEntry([key, valueOrFactory]).onSuccess((entry) => {
+            return this.converting.converters.convertEntry([key, valueOrFactory]).onSuccess((entry) => {
                 return super.getOrAdd(entry[0], entry[1]);
             });
         }
         else {
             return super.get(key).onFailure(() => {
                 const value = valueOrFactory(key)
-                    .onSuccess((value) => this.validate.validators.validateEntry([key, value]))
-                    .onSuccess(([key, value]) => (0, base_1.succeed)(value));
+                    .onSuccess((value) => this.converting.converters.convertEntry([key, value]))
+                    .onSuccess(([__key, value]) => (0, base_1.succeed)(value));
                 return value.success
                     ? super.add(key, value.value)
                     : (0, base_1.failWithDetail)(value.message, 'invalid-value');
@@ -79,7 +79,7 @@ class ValidatingResultMap extends resultMap_1.ResultMap {
      * {@inheritdoc Collections.ResultMap.set}
      */
     set(key, value) {
-        return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {
+        return this.converting.converters.convertEntry([key, value]).onSuccess((entry) => {
             return super.set(entry[0], entry[1]);
         });
     }
@@ -87,7 +87,7 @@ class ValidatingResultMap extends resultMap_1.ResultMap {
      * {@inheritdoc Collections.ResultMap.update}
      */
     update(key, value) {
-        return this.validate.validators.validateEntry([key, value]).onSuccess((entry) => {
+        return this.converting.converters.convertEntry([key, value]).onSuccess((entry) => {
             return super.update(entry[0], entry[1]);
         });
     }
@@ -98,5 +98,5 @@ class ValidatingResultMap extends resultMap_1.ResultMap {
         return this;
     }
 }
-exports.ValidatingResultMap = ValidatingResultMap;
-//# sourceMappingURL=validatingResultMap.js.map
+exports.ConvertingResultMap = ConvertingResultMap;
+//# sourceMappingURL=convertingResultMap.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"convertingResultMap.js","sourceRoot":"","sources":["../../../src/packlets/collections/convertingResultMap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAyF;AAGzF,2CAA+D;AAC/D,6DAAuF;AAwBvF;;;;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,GAAG,CAAC,GAAO,EAAE,KAAS;QAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/E,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAUM,QAAQ,CACb,GAAO,EACP,cAAkD;QAElD,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBACxF,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE;gBACnC,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC;qBAC9B,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;qBAC3E,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC,CAAC;gBACjD,OAAO,KAAK,CAAC,OAAO;oBAClB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC;oBAC7B,CAAC,CAAC,IAAA,qBAAc,EAA4B,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAO,EAAE,KAAS;QAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/E,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAO,EAAE,KAAS;QAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/E,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7FD,kDA6FC","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, failWithDetail, Result, succeed } from '../base';\nimport { KeyValueEntry } from './common';\nimport { IReadOnlyResultMap, ResultMapResultDetail } from './readonlyResultMap';\nimport { ResultMap, ResultMapValueFactory } from './resultMap';\nimport { IReadOnlyResultMapConverter, ResultMapConverter } from './resultMapConverter';\nimport { KeyValueConverters } from './keyValueConverters';\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   * {@inheritdoc Collections.ResultMap.add}\n   */\n  public add(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail> {\n    return this.converting.converters.convertEntry([key, value]).onSuccess((entry) => {\n      return super.add(entry[0], entry[1]);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.(getOrAdd:1)}\n   */\n  public getOrAdd(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail>;\n  /**\n   * {@inheritdoc Collections.ResultMap.(getOrAdd:2)}\n   */\n  public getOrAdd(key: TK, factory: ResultMapValueFactory<TK, TV>): DetailedResult<TV, ResultMapResultDetail>;\n  public getOrAdd(\n    key: TK,\n    valueOrFactory: TV | ResultMapValueFactory<TK, TV>\n  ): DetailedResult<TV, ResultMapResultDetail> {\n    if (!this._isResultMapValueFactory(valueOrFactory)) {\n      return this.converting.converters.convertEntry([key, valueOrFactory]).onSuccess((entry) => {\n        return super.getOrAdd(entry[0], entry[1]);\n      });\n    } else {\n      return super.get(key).onFailure(() => {\n        const value = valueOrFactory(key)\n          .onSuccess((value) => this.converting.converters.convertEntry([key, value]))\n          .onSuccess(([__key, value]) => succeed(value));\n        return value.success\n          ? super.add(key, value.value)\n          : failWithDetail<TV, ResultMapResultDetail>(value.message, 'invalid-value');\n      });\n    }\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.set}\n   */\n  public set(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail> {\n    return this.converting.converters.convertEntry([key, value]).onSuccess((entry) => {\n      return super.set(entry[0], entry[1]);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.ResultMap.update}\n   */\n  public update(key: TK, value: TV): DetailedResult<TV, ResultMapResultDetail> {\n    return this.converting.converters.convertEntry([key, value]).onSuccess((entry) => {\n      return super.update(entry[0], entry[1]);\n    });\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"]}

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

@@ -1,8 +1,14 @@
 import * as Utils from './utils';
+export * from './collectible';
+export * from './collector';
+export * from './collectorConverter';
+export * from './collectors';
+export * from './convertingCollector';
 export * from './common';
+export * from './keyValueConverters';
 export * from './readonlyResultMap';
 export * from './resultMap';
-export * from './resultMapValidator';
-export * from './validatingResultMap';
+export * from './resultMapConverter';
+export * from './convertingResultMap';
 export { Utils };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/lib/packlets/collections/index.js

@@ -60,9 +60,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Utils = void 0;
 const Utils = __importStar(require("./utils"));
 exports.Utils = Utils;
+__exportStar(require("./collectible"), exports);
+__exportStar(require("./collector"), exports);
+__exportStar(require("./collectorConverter"), exports);
+__exportStar(require("./collectors"), exports);
+__exportStar(require("./convertingCollector"), exports);
 __exportStar(require("./common"), exports);
+__exportStar(require("./keyValueConverters"), exports);
 __exportStar(require("./readonlyResultMap"), exports);
 __exportStar(require("./resultMap"), exports);
-__exportStar(require("./resultMapValidator"), exports);
-__exportStar(require("./validatingResultMap"), exports);
+__exportStar(require("./resultMapConverter"), exports);
+__exportStar(require("./convertingResultMap"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/collections/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,+CAAiC;AAOxB,sBAAK;AALd,2CAAyB;AACzB,sDAAoC;AACpC,8CAA4B;AAC5B,uDAAqC;AACrC,wDAAsC","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 * as Utils from './utils';\n\nexport * from './common';\nexport * from './readonlyResultMap';\nexport * from './resultMap';\nexport * from './resultMapValidator';\nexport * from './validatingResultMap';\nexport { Utils };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/collections/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,+CAAiC;AAcxB,sBAAK;AAZd,gDAA8B;AAC9B,8CAA4B;AAC5B,uDAAqC;AACrC,+CAA6B;AAC7B,wDAAsC;AACtC,2CAAyB;AACzB,uDAAqC;AACrC,sDAAoC;AACpC,8CAA4B;AAC5B,uDAAqC;AACrC,wDAAsC","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 * as Utils from './utils';\n\nexport * from './collectible';\nexport * from './collector';\nexport * from './collectorConverter';\nexport * from './collectors';\nexport * from './convertingCollector';\nexport * from './common';\nexport * from './keyValueConverters';\nexport * from './readonlyResultMap';\nexport * from './resultMap';\nexport * from './resultMapConverter';\nexport * from './convertingResultMap';\n\nexport { Utils };\n"]}

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

@@ -0,0 +1,90 @@
+import { DetailedResult, Result } from '../base';
+import { Converter, ConverterFunc } from '../conversion';
+import { Validator } from '../validation';
+import { KeyValueEntry } from './common';
+import { ResultMapResultDetail } from './readonlyResultMap';
+/**
+ * Parameters for constructing a {@link Collections.KeyValueConverters | KeyValueConverters} instance.
+ * @public
+ */
+export interface IKeyValueConverterConstructorParams<TK extends string = string, TV = unknown> {
+    /**
+     * Required key {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}.
+     */
+    key: Validator<TK, unknown> | Converter<TK, unknown> | ConverterFunc<TK, unknown>;
+    /**
+     * Required value {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}.
+     */
+    value: Validator<TV, unknown> | Converter<TV, unknown> | ConverterFunc<TV, unknown>;
+    /**
+     * Optional entry {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}.
+     * If no entry validator is provided, an entry is considered valid if both key and
+     * value are valid.
+     */
+    entry?: Validator<KeyValueEntry<TK, TV>, unknown> | Converter<KeyValueEntry<TK, TV>, unknown> | ConverterFunc<KeyValueEntry<TK, TV>, unknown>;
+}
+/**
+ * Helper class for converting strongly-typed keys, values, or entries
+ * from unknown values.
+ * @public
+ */
+export declare class KeyValueConverters<TK extends string = string, TV = unknown> {
+    /**
+     * Required key {@link Validator | validator} or {@link Converter | converter}.
+     */
+    readonly key: Validator<TK, unknown> | Converter<TK, unknown>;
+    /**
+     * Required value {@link Validator | validator} or {@link Converter | converter}.
+     */
+    readonly value: Validator<TV, unknown> | Converter<TV, unknown>;
+    /**
+     * Optional entry {@link Validator | validator} or {@link Converter | converter}.
+     * If no entry validator is provided, an entry is considered valid if both key and
+     * value are valid.
+     */
+    readonly entry?: Validator<KeyValueEntry<TK, TV>, unknown> | Converter<KeyValueEntry<TK, TV>, unknown>;
+    /**
+     * Constructs a new key-value validator.
+     * @param key - Required key {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}.
+     * @param value - Required value {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}.
+     * @param entry - Optional entry {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}..  If no entry validator is provided,
+     * an entry is considered valid if both key and value are valid.
+     */
+    constructor({ key, value, entry }: IKeyValueConverterConstructorParams<TK, TV>);
+    /**
+     * Converts a supplied unknown to a valid key value of type `<TK>`.
+     * @param key - The unknown to be converted.
+     * @returns `Success` with the converted key value and 'success' detail if the key is valid,
+     * or `Failure` with an error message and 'invalid-key' detail if the key is invalid.
+     */
+    convertKey(key: unknown): DetailedResult<TK, ResultMapResultDetail>;
+    /**
+     * Converts a supplied unknown to a valid value of type `<TV>`.
+     * @param key - The unknown to be converted.
+     * @returns `Success` with the converted value and 'success' detail if the value is valid,
+     * or `Failure` with an error message and 'invalid-value' detail if the value is invalid.
+     */
+    convertValue(key: unknown): DetailedResult<TV, ResultMapResultDetail>;
+    /**
+     * Converts a supplied unknown to a valid entry of type `[<TK>, <TV>]`.
+     * @param entry - The unknown to be converted.
+     * @returns `Success` with the converted entry and 'success' detail if the entry
+     * is valid, or `Failure` with an error message and 'invalid-key' or 'invalid-value' detail if
+     * the entry is invalid
+     */
+    convertEntry(entry: unknown): DetailedResult<KeyValueEntry<TK, TV>, ResultMapResultDetail>;
+    /**
+     * Converts a supplied iterable of unknowns to valid key-value pairs.
+     * @param entries - The iterable of unknowns to be converted.
+     * @returns `Success` with an array of converted key-value pairs if all entries are valid,
+     * or `Failure` with an error message if any entry is invalid.
+     */
+    convertEntries(entries: Iterable<unknown>): Result<KeyValueEntry<TK, TV>[]>;
+}
+//# sourceMappingURL=keyValueConverters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"keyValueConverters.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/keyValueConverters.ts"],"names":[],"mappings":"AAsBA,OAAO,EACL,cAAc,EAGd,MAAM,EAGP,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAc,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,mCAAmC,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IAC3F;;;OAGG;IACH,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAElF;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAEpF;;;;;OAKG;IACH,KAAK,CAAC,EACF,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GACzC,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GACzC,aAAa,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,qBAAa,kBAAkB,CAAC,EAAE,SAAS,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,OAAO;IACtE;;OAEG;IACH,SAAgB,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE;;OAEG;IACH,SAAgB,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAEvE;;;;OAIG;IACH,SAAgB,KAAK,CAAC,EAClB,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,GACzC,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAE9C;;;;;;;;;OASG;gBACgB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,mCAAmC,CAAC,EAAE,EAAE,EAAE,CAAC;IAMrF;;;;;OAKG;IACI,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAI1E;;;;;OAKG;IACI,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,qBAAqB,CAAC;IAI5E;;;;;;OAMG;IACI,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC;IAkBjG;;;;;OAKG;IACI,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;CAanF"}

package/lib/packlets/collections/keyValueConverters.js

@@ -0,0 +1,111 @@
+"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.KeyValueConverters = void 0;
+const base_1 = require("../base");
+const conversion_1 = require("../conversion");
+/**
+ * Helper class for converting strongly-typed keys, values, or entries
+ * from unknown values.
+ * @public
+ */
+class KeyValueConverters {
+    /**
+     * Constructs a new key-value validator.
+     * @param key - Required key {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}.
+     * @param value - Required value {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}.
+     * @param entry - Optional entry {@link Validator | validator}, {@link Converter | converter},
+     * or {@link Conversion.ConverterFunc | converter function}..  If no entry validator is provided,
+     * an entry is considered valid if both key and value are valid.
+     */
+    constructor({ key, value, entry }) {
+        this.key = typeof key === 'function' ? conversion_1.Converters.generic(key) : key;
+        this.value = typeof value === 'function' ? conversion_1.Converters.generic(value) : value;
+        this.entry = entry ? (typeof entry === 'function' ? conversion_1.Converters.generic(entry) : entry) : undefined;
+    }
+    /**
+     * Converts a supplied unknown to a valid key value of type `<TK>`.
+     * @param key - The unknown to be converted.
+     * @returns `Success` with the converted key value and 'success' detail if the key is valid,
+     * or `Failure` with an error message and 'invalid-key' detail if the key is invalid.
+     */
+    convertKey(key) {
+        return this.key.convert(key).withFailureDetail('invalid-key');
+    }
+    /**
+     * Converts a supplied unknown to a valid value of type `<TV>`.
+     * @param key - The unknown to be converted.
+     * @returns `Success` with the converted value and 'success' detail if the value is valid,
+     * or `Failure` with an error message and 'invalid-value' detail if the value is invalid.
+     */
+    convertValue(key) {
+        return this.value.convert(key).withFailureDetail('invalid-value');
+    }
+    /**
+     * Converts a supplied unknown to a valid entry of type `[<TK>, <TV>]`.
+     * @param entry - The unknown to be converted.
+     * @returns `Success` with the converted entry and 'success' detail if the entry
+     * is valid, or `Failure` with an error message and 'invalid-key' or 'invalid-value' detail if
+     * the entry is invalid
+     */
+    convertEntry(entry) {
+        if (this.entry) {
+            return this.entry.convert(entry).withFailureDetail('invalid-value');
+        }
+        if (Array.isArray(entry) && entry.length === 2) {
+            const errors = new base_1.MessageAggregator();
+            const key = this.convertKey(entry[0]).aggregateError(errors).orDefault();
+            const value = this.convertValue(entry[1]).aggregateError(errors).orDefault();
+            if (key && value) {
+                return (0, base_1.succeedWithDetail)([key, value], 'success');
+            }
+            const detail = key ? 'invalid-value' : 'invalid-key';
+            return (0, base_1.failWithDetail)(`invalid entry: ${errors.toString()}`, detail);
+        }
+        /* c8 ignore next 2 */
+        return (0, base_1.failWithDetail)(`malformed entry: "${JSON.stringify(entry)}"`, 'invalid-value');
+    }
+    /**
+     * Converts a supplied iterable of unknowns to valid key-value pairs.
+     * @param entries - The iterable of unknowns to be converted.
+     * @returns `Success` with an array of converted key-value pairs if all entries are valid,
+     * or `Failure` with an error message if any entry is invalid.
+     */
+    convertEntries(entries) {
+        const errors = new base_1.MessageAggregator();
+        const converted = [];
+        for (const element of entries) {
+            this.convertEntry(element)
+                .onSuccess((e) => {
+                converted.push(e);
+                return (0, base_1.succeedWithDetail)(e, 'success');
+            })
+                .aggregateError(errors);
+        }
+        return errors.returnOrReport((0, base_1.succeed)(converted));
+    }
+}
+exports.KeyValueConverters = KeyValueConverters;
+//# sourceMappingURL=keyValueConverters.js.map