@fgv/ts-utils 4.2.2 → 4.4.0

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

@@ -0,0 +1,194 @@
+import { DetailedResult, Result } from '../base';
+import { ICollectible, CollectibleFactoryCallback, CollectibleFactory } from './collectible';
+import { KeyValueEntry } from './common';
+import { IReadOnlyResultMap, ResultMapForEachCb, ResultMapResultDetail } from './readonlyResultMap';
+/**
+ * Additional success or failure details for mutating {@link ICollector | Collector} calls.
+ * @public
+ */
+export type CollectorResultDetail = ResultMapResultDetail | 'invalid-index';
+/**
+ * A read-only interface exposing non-mutating methods of a {@link Collections.ICollector | Collector}.
+ * @public
+ */
+export interface IReadOnlyCollector<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>> extends IReadOnlyResultMap<TKEY, TITEM> {
+    /**
+     * Gets the item at a specified index.
+     * @param index - The index of the item to retrieve.
+     * @returns Returns {@link Success | Success} with the item if it exists, or {@link Failure | Failure} with an error if the index is out of range.
+     */
+    getAt(index: number): Result<TITEM>;
+}
+/**
+ * Collects {@link Collections.ICollectible | ICollectible} items. Items in a collector are created by key and are assigned an index at the
+ * time of addition.  Items are immutable once added.
+ * @public
+ */
+export interface ICollector<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM> extends IReadOnlyCollector<TKEY, TINDEX, TITEM> {
+    /**
+     * Adds an item to the collector using the default {@link Collections.CollectibleFactory | factory}
+     * at a specified key, failing if an item with that key already exists.
+     * @param key - The key of the item to add.
+     * @param item - The source representation of the item to be added.
+     * @returns Returns {@link Success | Success} with the item if it is added, or {@link Failure | Failure} with
+     * an error if the item cannot be created and indexed.
+     * @public
+     */
+    add(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;
+    add(key: TKEY, callback: CollectibleFactoryCallback<TKEY, TINDEX>): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * Adds an item to the collector using the default {@link Collections.CollectibleFactory | factory}
+     * at a specified key, failing if an item with that key already exists.
+     * @param item - The item to add.
+     * @returns Returns {@link Success | Success} with the item if it is added, or {@link Failure | Failure} with an
+     * error if the item cannot be created and indexed.
+     */
+    addItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * Gets an item by key if it exists, or creates a new item and adds it using the default {@link Collections.CollectibleFactory | factory} if not.
+     * @param key - The key of the item to retrieve.
+     * @param item - The source representation of the item to be added if it does not exist.
+     * @returns Returns {@link Success | Success} with the item if it exists or could be created, or {@link Failure | Failure} with an error if the
+     * item cannot be created and indexed.
+     */
+    getOrAdd(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * Gets an item by key if it exists, or creates a new item and adds it using the specified {@link Collections.CollectibleFactoryCallback | factory callback} if not.
+     * @param key - The key of the item to retrieve.
+     * @param callback - The factory callback to create the item if it does not exist.
+     * @returns Returns {@link Success | Success} with the item if it exists, or {@link Failure | Failure} with an error if the item is not found.
+     */
+    getOrAdd(key: TKEY, callback: CollectibleFactoryCallback<TKEY, TINDEX>): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * Gets an existing item with a key matching that of a supplied item, or adds the supplied
+     * item to the collector if no item with that key exists.
+     * @param item - The item to retrieve or add.
+     * @returns Returns {@link Success | Success} with the item stored in the collector
+     * or {@link Failure | Failure} with an error if the item cannot be created and indexed.
+     */
+    getOrAddItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * Gets a {@link IReadOnlyResultMap | read-only map} which can access the items in the collector.
+     */
+    toReadOnly(): IReadOnlyCollector<TKEY, TINDEX, TITEM>;
+}
+/**
+ * A simple {@link ICollector | ICollector} with non-branded `string` key and `number` index, and no transformation of source items.
+ * @public
+ */
+export type ISimpleCollector<TITEM extends ICollectible<string, number>> = ICollector<string, number, TITEM, TITEM>;
+/**
+ * A {@link ICollector | Collector} with non-branded `string` key and `number` index, and transformation of source items.
+ * @public
+ */
+export type IConvertingCollector<TITEM extends ICollectible<string, number>, TSRC> = ICollector<string, number, TITEM, TSRC>;
+/**
+ * Parameters for constructing a {@link ICollector | Collector}.
+ * @public
+ */
+export interface ICollectorConstructorParams<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM> {
+    /**
+     * The default {@link Collections.CollectibleFactory | factory} to create items.
+     */
+    factory: CollectibleFactory<TKEY, TINDEX, TITEM, TSRC>;
+    /**
+     * An optional array of entries to add to the collector.
+     */
+    entries?: KeyValueEntry<TKEY, TSRC>[];
+}
+/**
+ * A {@link ICollector | Collector} that collects {@link Collections.ICollectible | ICollectible} items. Items in a collector are created by key and are assigned an index at the
+ * time of addition.  Items are immutable once added.  Keys and indexes might be branded types, and source items might be transformed on addition.
+ * @public
+ */
+export declare class Collector<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM> implements ICollector<TKEY, TINDEX, TITEM, TSRC> {
+    private _byKey;
+    private _byIndex;
+    private _factory;
+    /**
+     * {@inheritdoc IReadOnlyResultMap.inner}
+     */
+    get inner(): ReadonlyMap<TKEY, TITEM>;
+    /**
+     * Constructor for derived classes.
+     * @param params - Parameters for constructing the collector.
+     */
+    protected constructor(params: ICollectorConstructorParams<TKEY, TINDEX, TITEM, TSRC>);
+    /**
+     * {@inheritdoc IReadOnlyResultMap.size}
+     */
+    get size(): number;
+    /**
+     * {@inheritdoc IReadOnlyResultMap.keys}
+     */
+    keys(): IterableIterator<TKEY>;
+    /**
+     * {@inheritdoc IReadOnlyResultMap.values}
+     */
+    values(): IterableIterator<TITEM>;
+    /**
+     * {@inheritdoc IReadOnlyResultMap.entries}
+     */
+    entries(): IterableIterator<[TKEY, TITEM]>;
+    /**
+     * {@inheritdoc IReadOnlyResultMap.forEach}
+     */
+    forEach(callback: ResultMapForEachCb<TKEY, TITEM>, arg?: unknown): void;
+    /**
+     * {@inheritdoc IReadOnlyResultMap.get}
+     */
+    get(key: TKEY): DetailedResult<TITEM, ResultMapResultDetail>;
+    /**
+     * {@inheritdoc Collections.IReadOnlyCollector.getAt}
+     */
+    getAt(index: number): Result<TITEM>;
+    /**
+     * {@inheritdoc ICollector.(add:1)}
+     */
+    add(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc ICollector.(add:2)}
+     */
+    add(key: TKEY, cb: CollectibleFactoryCallback<TKEY, TINDEX, TITEM>): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc ICollector.addItem}
+     */
+    addItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc ICollector.(getOrAdd:1)}
+     */
+    getOrAdd(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc ICollector.(getOrAdd:2)}
+     */
+    getOrAdd(key: TKEY, cb: CollectibleFactoryCallback<TKEY, TINDEX, TITEM>): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc ICollector.getOrAddItem}
+     */
+    getOrAddItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc IReadOnlyResultMap.has}
+     */
+    has(key: TKEY): boolean;
+    /**
+     * {@inheritdoc ICollector.toReadOnly}
+     */
+    toReadOnly(): IReadOnlyCollector<TKEY, TINDEX, TITEM>;
+    /**
+     * Gets an iterator over the map entries.
+     * @returns An iterator over the map entries.
+     */
+    [Symbol.iterator](): IterableIterator<KeyValueEntry<TKEY, TITEM>>;
+    /**
+     * A simple factory method for derived classes which directly store the supplied
+     * object.
+     * @param key - The key of the item to create.
+     * @param index - The index of the item to create.
+     * @param item - The source item to create.
+     * @returns `Success` with the created item and a detail of 'success', or
+     * `Failure` with an error message and appropriate detail.
+     */
+    protected static _simpleFactory<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>>(key: TKEY, index: number, item: TITEM): Result<TITEM>;
+    protected _isFactoryCB(item: TSRC | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>): item is CollectibleFactoryCallback<TKEY, TINDEX, TITEM>;
+}
+//# sourceMappingURL=collector.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collector.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/collector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAoD,MAAM,SAAS,CAAC;AACnG,OAAO,EAAE,YAAY,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAC7F,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAEpG;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,eAAe,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CACjC,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,CACrE,SAAQ,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC;IACvC;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU,CACzB,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,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;IAC/C;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IACzE,GAAG,CACD,GAAG,EAAE,IAAI,EACT,QAAQ,EAAE,0BAA0B,CAAC,IAAI,EAAE,MAAM,CAAC,GACjD,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAEnE;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,QAAQ,CACN,GAAG,EAAE,IAAI,EACT,QAAQ,EAAE,0BAA0B,CAAC,IAAI,EAAE,MAAM,CAAC,GACjD,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAEhD;;;;;;OAMG;IACH,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAExE;;OAEG;IACH,UAAU,IAAI,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,UAAU,CACnF,MAAM,EACN,MAAM,EACN,KAAK,EACL,KAAK,CACN,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,KAAK,SAAS,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,IAAI,UAAU,CAC7F,MAAM,EACN,MAAM,EACN,KAAK,EACL,IAAI,CACL,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAC1C,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;IACvD;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;CACvC;AAED;;;;GAIG;AACH,qBAAa,SAAS,CACpB,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,YAAW,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IAEhD,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,QAAQ,CAAgD;IAEhE;;OAEG;IACH,IAAW,KAAK,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAE3C;IAED;;;OAGG;IACH,SAAS,aAAa,MAAM,EAAE,2BAA2B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IASpF;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACI,IAAI,IAAI,gBAAgB,CAAC,IAAI,CAAC;IAIrC;;OAEG;IACI,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIxC;;OAEG;IACI,OAAO,IAAI,gBAAgB,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAIjD;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,GAAG,IAAI;IAM9E;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAQnE;;OAEG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;IAO1C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAC/E;;OAEG;IACI,GAAG,CACR,GAAG,EAAE,IAAI,EACT,EAAE,EAAE,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,GAClD,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAW/C;;OAEG;IACI,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAOzE;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IACpF;;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;IAkC/C;;OAEG;IACI,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAa9E;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO;IAI9B;;OAEG;IACI,UAAU,IAAI,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;IAI5D;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAIxE;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,CAAC,cAAc,CAC7B,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,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAIvD,SAAS,CAAC,YAAY,CACpB,IAAI,EAAE,IAAI,GAAG,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,GAC3D,IAAI,IAAI,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;CAG3D"}

package/lib/packlets/collections/collector.js

@@ -0,0 +1,189 @@
+"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.Collector = void 0;
+const base_1 = require("../base");
+/**
+ * A {@link ICollector | Collector} that collects {@link Collections.ICollectible | ICollectible} items. Items in a collector are created by key and are assigned an index at the
+ * time of addition.  Items are immutable once added.  Keys and indexes might be branded types, and source items might be transformed on addition.
+ * @public
+ */
+class Collector {
+    /**
+     * {@inheritdoc IReadOnlyResultMap.inner}
+     */
+    get inner() {
+        return this._byKey;
+    }
+    /**
+     * Constructor for derived classes.
+     * @param params - Parameters for constructing the collector.
+     */
+    constructor(params) {
+        var _a;
+        this._byKey = new Map();
+        this._byIndex = [];
+        this._factory = params.factory;
+        (_a = params.entries) === null || _a === void 0 ? void 0 : _a.forEach((entry) => {
+            this.getOrAdd(entry[0], entry[1]);
+        });
+    }
+    /**
+     * {@inheritdoc IReadOnlyResultMap.size}
+     */
+    get size() {
+        return this._byKey.size;
+    }
+    /**
+     * {@inheritdoc IReadOnlyResultMap.keys}
+     */
+    keys() {
+        return this._byKey.keys();
+    }
+    /**
+     * {@inheritdoc IReadOnlyResultMap.values}
+     */
+    values() {
+        return this._byKey.values();
+    }
+    /**
+     * {@inheritdoc IReadOnlyResultMap.entries}
+     */
+    entries() {
+        return this._byKey.entries();
+    }
+    /**
+     * {@inheritdoc IReadOnlyResultMap.forEach}
+     */
+    forEach(callback, arg) {
+        for (const [key, value] of this._byKey.entries()) {
+            callback(value, key, this, arg);
+        }
+    }
+    /**
+     * {@inheritdoc IReadOnlyResultMap.get}
+     */
+    get(key) {
+        const item = this._byKey.get(key);
+        if (item === undefined) {
+            return (0, base_1.failWithDetail)(`${key}: not found.`, 'not-found');
+        }
+        return (0, base_1.succeedWithDetail)(item, 'success');
+    }
+    /**
+     * {@inheritdoc Collections.IReadOnlyCollector.getAt}
+     */
+    getAt(index) {
+        if (index < 0 || index >= this._byIndex.length) {
+            return (0, base_1.fail)(`${index}: out of range.`);
+        }
+        return (0, base_1.succeed)(this._byIndex[index]);
+    }
+    add(key, itemOrCb) {
+        if (this._byKey.has(key)) {
+            return (0, base_1.failWithDetail)(`${key}: already exists.`, 'exists');
+        }
+        return this.getOrAdd(key, itemOrCb);
+    }
+    /**
+     * {@inheritdoc ICollector.addItem}
+     */
+    addItem(item) {
+        if (this._byKey.has(item.key)) {
+            return (0, base_1.failWithDetail)(`${item.key}: already exists.`, 'exists');
+        }
+        return this.getOrAddItem(item);
+    }
+    getOrAdd(key, itemOrCb) {
+        if (this._byKey.has(key)) {
+            return (0, base_1.succeedWithDetail)(this._byKey.get(key), 'exists');
+        }
+        const build = this._isFactoryCB(itemOrCb)
+            ? itemOrCb(key, this._byIndex.length)
+            : this._factory(key, this._byIndex.length, itemOrCb);
+        if (build.isFailure()) {
+            return (0, base_1.failWithDetail)(build.message, 'invalid-value');
+        }
+        const newItem = build.value;
+        if (newItem.key !== key) {
+            return (0, base_1.failWithDetail)(`$[key}: key mismatch in created item - ${newItem.key} !== ${key}`, 'invalid-key');
+        }
+        if (newItem.index !== this._byIndex.length) {
+            return (0, base_1.failWithDetail)(`$[key}: index mismatch in created item - ${newItem.index} !== ${this._byIndex.length}`, 'invalid-index');
+        }
+        this._byKey.set(key, newItem);
+        this._byIndex.push(newItem);
+        return (0, base_1.succeedWithDetail)(newItem, 'added');
+    }
+    /**
+     * {@inheritdoc ICollector.getOrAddItem}
+     */
+    getOrAddItem(item) {
+        if (this._byKey.has(item.key)) {
+            return (0, base_1.succeedWithDetail)(this._byKey.get(item.key), 'exists');
+        }
+        const { message } = item.setIndex(this._byIndex.length);
+        if (message !== undefined) {
+            return (0, base_1.failWithDetail)(message, 'invalid-index');
+        }
+        this._byKey.set(item.key, item);
+        this._byIndex.push(item);
+        return (0, base_1.succeedWithDetail)(item, 'added');
+    }
+    /**
+     * {@inheritdoc IReadOnlyResultMap.has}
+     */
+    has(key) {
+        return this._byKey.has(key);
+    }
+    /**
+     * {@inheritdoc ICollector.toReadOnly}
+     */
+    toReadOnly() {
+        return this;
+    }
+    /**
+     * Gets an iterator over the map entries.
+     * @returns An iterator over the map entries.
+     */
+    [Symbol.iterator]() {
+        return this._byKey[Symbol.iterator]();
+    }
+    /**
+     * A simple factory method for derived classes which directly store the supplied
+     * object.
+     * @param key - The key of the item to create.
+     * @param index - The index of the item to create.
+     * @param item - The source item to create.
+     * @returns `Success` with the created item and a detail of 'success', or
+     * `Failure` with an error message and appropriate detail.
+     */
+    static _simpleFactory(key, index, item) {
+        return item.setIndex(index).onSuccess(() => (0, base_1.succeed)(item));
+    }
+    _isFactoryCB(item) {
+        return typeof item === 'function';
+    }
+}
+exports.Collector = Collector;
+//# sourceMappingURL=collector.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collector.js","sourceRoot":"","sources":["../../../src/packlets/collections/collector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAmG;AA4InG;;;;GAIG;AACH,MAAa,SAAS;IAWpB;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,YAAsB,MAA8D;;QAClF,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC;QAC/B,MAAA,MAAM,CAAC,OAAO,0CAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAAyC,EAAE,GAAa;QACrE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAS;QAClB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,IAAA,qBAAc,EAA+B,GAAG,GAAG,cAAc,EAAE,WAAW,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,IAAA,wBAAiB,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAa;QACxB,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,IAAA,WAAI,EAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;IAaM,GAAG,CACR,GAAS,EACT,QAAgE;QAEhE,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO,IAAA,qBAAc,EAAC,GAAG,GAAG,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAgB,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,IAAW;QACxB,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAA,qBAAc,EAAC,GAAG,IAAI,CAAC,GAAG,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAcM,QAAQ,CACb,GAAS,EACT,QAAgE;QAEhE,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO,IAAA,wBAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,EAAE,QAAQ,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;YACvC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACvD,IAAI,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC;YACtB,OAAO,IAAA,qBAAc,EAA+B,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QACtF,CAAC;QACD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC;QAE5B,IAAI,OAAO,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YACxB,OAAO,IAAA,qBAAc,EACnB,0CAA0C,OAAO,CAAC,GAAG,QAAQ,GAAG,EAAE,EAClE,aAAa,CACd,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC3C,OAAO,IAAA,qBAAc,EACnB,4CAA4C,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EACvF,eAAe,CAChB,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,IAAA,wBAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,IAAW;QAC7B,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAA,wBAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAE,EAAE,QAAQ,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,IAAA,qBAAc,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAA,wBAAiB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAS;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,cAAc,CAI7B,GAAS,EAAE,KAAa,EAAE,IAAW;QACrC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAES,YAAY,CACpB,IAA4D;QAE5D,OAAO,OAAO,IAAI,KAAK,UAAU,CAAC;IACpC,CAAC;CACF;AAhOD,8BAgOC","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 { DetailedResult, Result, fail, failWithDetail, succeed, succeedWithDetail } from '../base';\nimport { ICollectible, CollectibleFactoryCallback, CollectibleFactory } from './collectible';\nimport { KeyValueEntry } from './common';\nimport { IReadOnlyResultMap, ResultMapForEachCb, ResultMapResultDetail } from './readonlyResultMap';\n\n/**\n * Additional success or failure details for mutating {@link ICollector | Collector} calls.\n * @public\n */\nexport type CollectorResultDetail = ResultMapResultDetail | 'invalid-index';\n\n/**\n * A read-only interface exposing non-mutating methods of a {@link Collections.ICollector | Collector}.\n * @public\n */\nexport interface IReadOnlyCollector<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>\n> extends IReadOnlyResultMap<TKEY, TITEM> {\n  /**\n   * Gets the item at a specified index.\n   * @param index - The index of the item to retrieve.\n   * @returns Returns {@link Success | Success} with the item if it exists, or {@link Failure | Failure} with an error if the index is out of range.\n   */\n  getAt(index: number): Result<TITEM>;\n}\n\n/**\n * Collects {@link Collections.ICollectible | ICollectible} items. Items in a collector are created by key and are assigned an index at the\n * time of addition.  Items are immutable once added.\n * @public\n */\nexport interface ICollector<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>,\n  TSRC = TITEM\n> extends IReadOnlyCollector<TKEY, TINDEX, TITEM> {\n  /**\n   * Adds an item to the collector using the default {@link Collections.CollectibleFactory | factory}\n   * at a specified key, failing if an item with that key already exists.\n   * @param key - The key of the item to add.\n   * @param item - The source representation of the item to be added.\n   * @returns Returns {@link Success | Success} with the item if it is added, or {@link Failure | Failure} with\n   * an error if the item cannot be created and indexed.\n   * @public\n   */\n  add(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;\n  add(\n    key: TKEY,\n    callback: CollectibleFactoryCallback<TKEY, TINDEX>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * Adds an item to the collector using the default {@link Collections.CollectibleFactory | factory}\n   * at a specified key, failing if an item with that key already exists.\n   * @param item - The item to add.\n   * @returns Returns {@link Success | Success} with the item if it is added, or {@link Failure | Failure} with an\n   * error if the item cannot be created and indexed.\n   */\n  addItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * Gets an item by key if it exists, or creates a new item and adds it using the default {@link Collections.CollectibleFactory | factory} if not.\n   * @param key - The key of the item to retrieve.\n   * @param item - The source representation of the item to be added if it does not exist.\n   * @returns Returns {@link Success | Success} with the item if it exists or could be created, or {@link Failure | Failure} with an error if the\n   * item cannot be created and indexed.\n   */\n  getOrAdd(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * Gets an item by key if it exists, or creates a new item and adds it using the specified {@link Collections.CollectibleFactoryCallback | factory callback} if not.\n   * @param key - The key of the item to retrieve.\n   * @param callback - The factory callback to create the item if it does not exist.\n   * @returns Returns {@link Success | Success} with the item if it exists, or {@link Failure | Failure} with an error if the item is not found.\n   */\n  getOrAdd(\n    key: TKEY,\n    callback: CollectibleFactoryCallback<TKEY, TINDEX>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * Gets an existing item with a key matching that of a supplied item, or adds the supplied\n   * item to the collector if no item with that key exists.\n   * @param item - The item to retrieve or add.\n   * @returns Returns {@link Success | Success} with the item stored in the collector\n   * or {@link Failure | Failure} with an error if the item cannot be created and indexed.\n   */\n  getOrAddItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * Gets a {@link IReadOnlyResultMap | read-only map} which can access the items in the collector.\n   */\n  toReadOnly(): IReadOnlyCollector<TKEY, TINDEX, TITEM>;\n}\n\n/**\n * A simple {@link ICollector | ICollector} with non-branded `string` key and `number` index, and no transformation of source items.\n * @public\n */\nexport type ISimpleCollector<TITEM extends ICollectible<string, number>> = ICollector<\n  string,\n  number,\n  TITEM,\n  TITEM\n>;\n\n/**\n * A {@link ICollector | Collector} with non-branded `string` key and `number` index, and transformation of source items.\n * @public\n */\nexport type IConvertingCollector<TITEM extends ICollectible<string, number>, TSRC> = ICollector<\n  string,\n  number,\n  TITEM,\n  TSRC\n>;\n\n/**\n * Parameters for constructing a {@link ICollector | Collector}.\n * @public\n */\nexport interface ICollectorConstructorParams<\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   * The default {@link Collections.CollectibleFactory | factory} to create items.\n   */\n  factory: CollectibleFactory<TKEY, TINDEX, TITEM, TSRC>;\n  /**\n   * An optional array of entries to add to the collector.\n   */\n  entries?: KeyValueEntry<TKEY, TSRC>[];\n}\n\n/**\n * A {@link ICollector | Collector} that collects {@link Collections.ICollectible | ICollectible} items. Items in a collector are created by key and are assigned an index at the\n * time of addition.  Items are immutable once added.  Keys and indexes might be branded types, and source items might be transformed on addition.\n * @public\n */\nexport class Collector<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>,\n  TSRC = TITEM\n> implements ICollector<TKEY, TINDEX, TITEM, TSRC>\n{\n  private _byKey: Map<TKEY, TITEM>;\n  private _byIndex: TITEM[];\n  private _factory: CollectibleFactory<TKEY, TINDEX, TITEM, TSRC>;\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.inner}\n   */\n  public get inner(): ReadonlyMap<TKEY, TITEM> {\n    return this._byKey;\n  }\n\n  /**\n   * Constructor for derived classes.\n   * @param params - Parameters for constructing the collector.\n   */\n  protected constructor(params: ICollectorConstructorParams<TKEY, TINDEX, TITEM, TSRC>) {\n    this._byKey = new Map<TKEY, TITEM>();\n    this._byIndex = [];\n    this._factory = params.factory;\n    params.entries?.forEach((entry) => {\n      this.getOrAdd(entry[0], entry[1]);\n    });\n  }\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.size}\n   */\n  public get size(): number {\n    return this._byKey.size;\n  }\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.keys}\n   */\n  public keys(): IterableIterator<TKEY> {\n    return this._byKey.keys();\n  }\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.values}\n   */\n  public values(): IterableIterator<TITEM> {\n    return this._byKey.values();\n  }\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.entries}\n   */\n  public entries(): IterableIterator<[TKEY, TITEM]> {\n    return this._byKey.entries();\n  }\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.forEach}\n   */\n  public forEach(callback: ResultMapForEachCb<TKEY, TITEM>, arg?: unknown): void {\n    for (const [key, value] of this._byKey.entries()) {\n      callback(value, key, this, arg);\n    }\n  }\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.get}\n   */\n  public get(key: TKEY): DetailedResult<TITEM, ResultMapResultDetail> {\n    const item = this._byKey.get(key);\n    if (item === undefined) {\n      return failWithDetail<TITEM, ResultMapResultDetail>(`${key}: not found.`, 'not-found');\n    }\n    return succeedWithDetail(item, 'success');\n  }\n\n  /**\n   * {@inheritdoc Collections.IReadOnlyCollector.getAt}\n   */\n  public getAt(index: number): Result<TITEM> {\n    if (index < 0 || index >= this._byIndex.length) {\n      return fail(`${index}: out of range.`);\n    }\n    return succeed(this._byIndex[index]);\n  }\n\n  /**\n   * {@inheritdoc ICollector.(add:1)}\n   */\n  public add(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;\n  /**\n   * {@inheritdoc ICollector.(add:2)}\n   */\n  public add(\n    key: TKEY,\n    cb: CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n  public add(\n    key: TKEY,\n    itemOrCb: TSRC | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail> {\n    if (this._byKey.has(key)) {\n      return failWithDetail(`${key}: already exists.`, 'exists');\n    }\n    return this.getOrAdd(key, itemOrCb as TSRC);\n  }\n\n  /**\n   * {@inheritdoc ICollector.addItem}\n   */\n  public addItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail> {\n    if (this._byKey.has(item.key)) {\n      return failWithDetail(`${item.key}: already exists.`, 'exists');\n    }\n    return this.getOrAddItem(item);\n  }\n\n  /**\n   * {@inheritdoc ICollector.(getOrAdd:1)}\n   */\n  public getOrAdd(key: TKEY, item: TSRC): DetailedResult<TITEM, CollectorResultDetail>;\n  /**\n   * {@inheritdoc ICollector.(getOrAdd:2)}\n   */\n  public getOrAdd(\n    key: TKEY,\n    cb: CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n\n  public getOrAdd(\n    key: TKEY,\n    itemOrCb: TSRC | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail> {\n    if (this._byKey.has(key)) {\n      return succeedWithDetail(this._byKey.get(key)!, 'exists');\n    }\n    const build = this._isFactoryCB(itemOrCb)\n      ? itemOrCb(key, this._byIndex.length)\n      : this._factory(key, this._byIndex.length, itemOrCb);\n    if (build.isFailure()) {\n      return failWithDetail<TITEM, CollectorResultDetail>(build.message, 'invalid-value');\n    }\n    const newItem = build.value;\n\n    if (newItem.key !== key) {\n      return failWithDetail(\n        `$[key}: key mismatch in created item - ${newItem.key} !== ${key}`,\n        'invalid-key'\n      );\n    }\n    if (newItem.index !== this._byIndex.length) {\n      return failWithDetail(\n        `$[key}: index mismatch in created item - ${newItem.index} !== ${this._byIndex.length}`,\n        'invalid-index'\n      );\n    }\n    this._byKey.set(key, newItem);\n    this._byIndex.push(newItem);\n    return succeedWithDetail(newItem, 'added');\n  }\n\n  /**\n   * {@inheritdoc ICollector.getOrAddItem}\n   */\n  public getOrAddItem(item: TITEM): DetailedResult<TITEM, CollectorResultDetail> {\n    if (this._byKey.has(item.key)) {\n      return succeedWithDetail(this._byKey.get(item.key)!, 'exists');\n    }\n    const { message } = item.setIndex(this._byIndex.length);\n    if (message !== undefined) {\n      return failWithDetail(message, 'invalid-index');\n    }\n    this._byKey.set(item.key, item);\n    this._byIndex.push(item);\n    return succeedWithDetail(item, 'added');\n  }\n\n  /**\n   * {@inheritdoc IReadOnlyResultMap.has}\n   */\n  public has(key: TKEY): boolean {\n    return this._byKey.has(key);\n  }\n\n  /**\n   * {@inheritdoc ICollector.toReadOnly}\n   */\n  public toReadOnly(): IReadOnlyCollector<TKEY, TINDEX, TITEM> {\n    return this;\n  }\n\n  /**\n   * Gets an iterator over the map entries.\n   * @returns An iterator over the map entries.\n   */\n  public [Symbol.iterator](): IterableIterator<KeyValueEntry<TKEY, TITEM>> {\n    return this._byKey[Symbol.iterator]();\n  }\n\n  /**\n   * A simple factory method for derived classes which directly store the supplied\n   * object.\n   * @param key - The key of the item to create.\n   * @param index - The index of the item to create.\n   * @param item - The source item to create.\n   * @returns `Success` with the created item and a detail of 'success', or\n   * `Failure` with an error message and appropriate detail.\n   */\n  protected static _simpleFactory<\n    TKEY extends string = string,\n    TINDEX extends number = number,\n    TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>\n  >(key: TKEY, index: number, item: TITEM): Result<TITEM> {\n    return item.setIndex(index).onSuccess(() => succeed(item));\n  }\n\n  protected _isFactoryCB(\n    item: TSRC | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): item is CollectibleFactoryCallback<TKEY, TINDEX, TITEM> {\n    return typeof item === 'function';\n  }\n}\n"]}

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

@@ -0,0 +1,86 @@
+import { DetailedResult } from '../base';
+import { IReadOnlyResultMap, ResultMapResultDetail } from './readonlyResultMap';
+import { ResultMapValueFactory } from './resultMap';
+import { KeyValueConverters } from './keyValueConverters';
+import { CollectibleFactoryCallback, ICollectible } from './collectible';
+import { CollectorResultDetail, ICollector } from './collector';
+import { IReadOnlyResultMapConverter } from './resultMapConverter';
+/**
+ * A read-only interface exposing non-mutating methods of a
+ * {@link Collections.CollectorConverter | CollectorConverter}.
+ * @public
+ */
+export interface IReadOnlyCollectorConverter<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY> = ICollectible<TKEY, TINDEX>> extends IReadOnlyResultMapConverter<TKEY, TITEM> {
+    /**
+     * {@inheritdoc Collections.CollectorConverter.map}
+     */
+    readonly map: IReadOnlyResultMap<TKEY, TITEM>;
+    /**
+     * {@inheritdoc Collections.Collector.get}
+     */
+    get(key: string): DetailedResult<TITEM, ResultMapResultDetail>;
+    /**
+     * {@inheritdoc Collections.Collector.has}
+     */
+    has(key: string): boolean;
+}
+/**
+ * Parameters for constructing a {@link Collections.CollectorConverter | CollectorConverter}.
+ * @public
+ */
+export interface ICollectorConverterCreateParams<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM> {
+    collector: ICollector<TKEY, TINDEX, TITEM, TSRC>;
+    converters: KeyValueConverters<TKEY, TSRC>;
+}
+/**
+ * A {@link Collections.Collector | Collector} wrapper which validates weakly-typed keys
+ * and values before calling the wrapped collector.
+ * @public
+ */
+export declare class CollectorConverter<TKEY extends string = string, TINDEX extends number = number, TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>, TSRC = TITEM> implements IReadOnlyResultMapConverter<TKEY, TITEM> {
+    readonly converters: KeyValueConverters<TKEY, TSRC>;
+    get map(): IReadOnlyResultMap<TKEY, TITEM>;
+    protected _collector: ICollector<TKEY, TINDEX, TITEM, TSRC>;
+    /**
+     * Constructs a new {@link Collections.CollectorConverter | CollectorConverter}.
+     * @param params - Required parameters for constructing the collector converter.
+     */
+    constructor(params: ICollectorConverterCreateParams<TKEY, TINDEX, TITEM, TSRC>);
+    /**
+     * {@inheritdoc Collections.Collector.(add:1)}
+     */
+    add(key: string, value: unknown): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc Collections.Collector.(add:2)}
+     */
+    add(key: string, factory: ResultMapValueFactory<TKEY, TITEM>): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc Collections.Collector.get}
+     */
+    get(key: string): DetailedResult<TITEM, ResultMapResultDetail>;
+    /**
+     * {@inheritdoc Collections.Collector.(getOrAdd:1)}
+     */
+    getOrAdd(key: string, value: unknown): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc Collections.Collector.(getOrAdd:2)}
+     */
+    getOrAdd(key: string, factory: ResultMapValueFactory<TKEY, TITEM>): DetailedResult<TITEM, CollectorResultDetail>;
+    /**
+     * {@inheritdoc Collections.Collector.has}
+     */
+    has(key: string): boolean;
+    /**
+     * {@inheritdoc Collections.Collector.toReadOnly}
+     */
+    toReadOnly(): IReadOnlyCollectorConverter<TKEY, TINDEX, TITEM>;
+    /**
+     * Determines if a value is a {@link Collections.CollectibleFactoryCallback | CollectibleFactoryCallback}.
+     * @param value - The value to check.
+     * @returns `true` if the value is a {@link Collections.CollectibleFactoryCallback | CollectibleFactoryCallback},
+     * `false` otherwise.
+     * @public
+     */
+    protected _isCollectibleFactoryCallback(value: unknown | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>): value is CollectibleFactoryCallback<TKEY, TINDEX, TITEM>;
+}
+//# sourceMappingURL=collectorConverter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collectorConverter.d.ts","sourceRoot":"","sources":["../../../src/packlets/collections/collectorConverter.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,cAAc,EAAkB,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAC;AAEnE;;;;GAIG;AACH,MAAM,WAAW,2BAA2B,CAC1C,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,KAAK,SAAS,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAC7D,SAAQ,2BAA2B,CAAC,IAAI,EAAE,KAAK,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAE9C;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAE/D;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B,CAC9C,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,SAAS,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACjD,UAAU,EAAE,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;CAC5C;AAED;;;;GAIG;AACH,qBAAa,kBAAkB,CAC7B,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,YAAW,2BAA2B,CAAC,IAAI,EAAE,KAAK,CAAC;IAEnD,SAAgB,UAAU,EAAE,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE3D,IAAW,GAAG,IAAI,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAEhD;IAED,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAE5D;;;OAGG;gBACgB,MAAM,EAAE,+BAA+B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC;IAKrF;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAErF;;OAEG;IACI,GAAG,CACR,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,GAC1C,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAW/C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAMrE;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAE1F;;OAEG;IACI,QAAQ,CACb,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,GAC1C,cAAc,CAAC,KAAK,EAAE,qBAAqB,CAAC;IAsB/C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;OAEG;IACI,UAAU,IAAI,2BAA2B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;IAIrE;;;;;;OAMG;IACH,SAAS,CAAC,6BAA6B,CACrC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,GAC/D,KAAK,IAAI,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;CAG5D"}

package/lib/packlets/collections/collectorConverter.js

@@ -0,0 +1,98 @@
+"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.CollectorConverter = void 0;
+const base_1 = require("../base");
+/**
+ * A {@link Collections.Collector | Collector} wrapper which validates weakly-typed keys
+ * and values before calling the wrapped collector.
+ * @public
+ */
+class CollectorConverter {
+    get map() {
+        return this._collector.toReadOnly();
+    }
+    /**
+     * Constructs a new {@link Collections.CollectorConverter | CollectorConverter}.
+     * @param params - Required parameters for constructing the collector converter.
+     */
+    constructor(params) {
+        this._collector = params.collector;
+        this.converters = params.converters;
+    }
+    add(key, valueOrFactory) {
+        if (this.has(key)) {
+            return (0, base_1.failWithDetail)(`${key}: already exists`, 'exists');
+        }
+        return this.getOrAdd(key, valueOrFactory);
+    }
+    /**
+     * {@inheritdoc Collections.Collector.get}
+     */
+    get(key) {
+        return this.converters.convertKey(key).onSuccess((k) => {
+            return this._collector.get(k);
+        });
+    }
+    getOrAdd(key, valueOrFactory) {
+        if (!this._isCollectibleFactoryCallback(valueOrFactory)) {
+            const converted = this.converters.convertEntry([key, valueOrFactory]);
+            if (converted.isFailure()) {
+                return (0, base_1.failWithDetail)(converted.message, converted.detail);
+            }
+            const [vk, vs] = converted.value;
+            return this._collector.getOrAdd(vk, vs);
+        }
+        else {
+            const converted = this.converters.convertKey(key);
+            if (converted.isFailure()) {
+                return (0, base_1.failWithDetail)(converted.message, converted.detail);
+            }
+            return this._collector.getOrAdd(converted.value, valueOrFactory);
+        }
+    }
+    /**
+     * {@inheritdoc Collections.Collector.has}
+     */
+    has(key) {
+        return this._collector.has(key);
+    }
+    /**
+     * {@inheritdoc Collections.Collector.toReadOnly}
+     */
+    toReadOnly() {
+        return this;
+    }
+    /**
+     * Determines if a value is a {@link Collections.CollectibleFactoryCallback | CollectibleFactoryCallback}.
+     * @param value - The value to check.
+     * @returns `true` if the value is a {@link Collections.CollectibleFactoryCallback | CollectibleFactoryCallback},
+     * `false` otherwise.
+     * @public
+     */
+    _isCollectibleFactoryCallback(value) {
+        return typeof value === 'function';
+    }
+}
+exports.CollectorConverter = CollectorConverter;
+//# sourceMappingURL=collectorConverter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collectorConverter.js","sourceRoot":"","sources":["../../../src/packlets/collections/collectorConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAyD;AAgDzD;;;;GAIG;AACH,MAAa,kBAAkB;IAS7B,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAID;;;OAGG;IACH,YAAmB,MAAkE;QACnF,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACtC,CAAC;IAcM,GAAG,CACR,GAAW,EACX,cAA4D;QAE5D,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,OAAO,IAAA,qBAAc,EAAC,GAAG,GAAG,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACrD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC;IAeM,QAAQ,CACb,GAAW,EACX,cAAyE;QAEzE,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,cAAc,CAAC,EAAE,CAAC;YACxD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC;YACtE,IAAI,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC1B,OAAO,IAAA,qBAAc,EAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YAC7D,CAAC;YACD,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC;YACjC,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAClD,IAAI,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC1B,OAAO,IAAA,qBAAc,EAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAW,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACO,6BAA6B,CACrC,KAAgE;QAEhE,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;IACrC,CAAC;CACF;AAlHD,gDAkHC","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 { DetailedResult, failWithDetail } from '../base';\nimport { IReadOnlyResultMap, ResultMapResultDetail } from './readonlyResultMap';\nimport { ResultMapValueFactory } from './resultMap';\nimport { KeyValueConverters } from './keyValueConverters';\nimport { CollectibleFactoryCallback, ICollectible } from './collectible';\nimport { CollectorResultDetail, ICollector } from './collector';\nimport { IReadOnlyResultMapConverter } from './resultMapConverter';\n\n/**\n * A read-only interface exposing non-mutating methods of a\n * {@link Collections.CollectorConverter | CollectorConverter}.\n * @public\n */\nexport interface IReadOnlyCollectorConverter<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY> = ICollectible<TKEY, TINDEX>\n> extends IReadOnlyResultMapConverter<TKEY, TITEM> {\n  /**\n   * {@inheritdoc Collections.CollectorConverter.map}\n   */\n  readonly map: IReadOnlyResultMap<TKEY, TITEM>;\n\n  /**\n   * {@inheritdoc Collections.Collector.get}\n   */\n  get(key: string): DetailedResult<TITEM, ResultMapResultDetail>;\n\n  /**\n   * {@inheritdoc Collections.Collector.has}\n   */\n  has(key: string): boolean;\n}\n\n/**\n * Parameters for constructing a {@link Collections.CollectorConverter | CollectorConverter}.\n * @public\n */\nexport interface ICollectorConverterCreateParams<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>,\n  TSRC = TITEM\n> {\n  collector: ICollector<TKEY, TINDEX, TITEM, TSRC>;\n  converters: KeyValueConverters<TKEY, TSRC>;\n}\n\n/**\n * A {@link Collections.Collector | Collector} wrapper which validates weakly-typed keys\n * and values before calling the wrapped collector.\n * @public\n */\nexport class CollectorConverter<\n  TKEY extends string = string,\n  TINDEX extends number = number,\n  TITEM extends ICollectible<TKEY, TINDEX> = ICollectible<TKEY, TINDEX>,\n  TSRC = TITEM\n> implements IReadOnlyResultMapConverter<TKEY, TITEM>\n{\n  public readonly converters: KeyValueConverters<TKEY, TSRC>;\n\n  public get map(): IReadOnlyResultMap<TKEY, TITEM> {\n    return this._collector.toReadOnly();\n  }\n\n  protected _collector: ICollector<TKEY, TINDEX, TITEM, TSRC>;\n\n  /**\n   * Constructs a new {@link Collections.CollectorConverter | CollectorConverter}.\n   * @param params - Required parameters for constructing the collector converter.\n   */\n  public constructor(params: ICollectorConverterCreateParams<TKEY, TINDEX, TITEM, TSRC>) {\n    this._collector = params.collector;\n    this.converters = params.converters;\n  }\n\n  /**\n   * {@inheritdoc Collections.Collector.(add:1)}\n   */\n  public add(key: string, value: unknown): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * {@inheritdoc Collections.Collector.(add:2)}\n   */\n  public add(\n    key: string,\n    factory: ResultMapValueFactory<TKEY, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n  public add(\n    key: string,\n    valueOrFactory: unknown | ResultMapValueFactory<TKEY, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail> {\n    if (this.has(key)) {\n      return failWithDetail(`${key}: already exists`, 'exists');\n    }\n    return this.getOrAdd(key, valueOrFactory);\n  }\n\n  /**\n   * {@inheritdoc Collections.Collector.get}\n   */\n  public get(key: string): DetailedResult<TITEM, ResultMapResultDetail> {\n    return this.converters.convertKey(key).onSuccess((k) => {\n      return this._collector.get(k);\n    });\n  }\n\n  /**\n   * {@inheritdoc Collections.Collector.(getOrAdd:1)}\n   */\n  public getOrAdd(key: string, value: unknown): DetailedResult<TITEM, CollectorResultDetail>;\n\n  /**\n   * {@inheritdoc Collections.Collector.(getOrAdd:2)}\n   */\n  public getOrAdd(\n    key: string,\n    factory: ResultMapValueFactory<TKEY, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail>;\n\n  public getOrAdd(\n    key: string,\n    valueOrFactory: unknown | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): DetailedResult<TITEM, CollectorResultDetail> {\n    if (!this._isCollectibleFactoryCallback(valueOrFactory)) {\n      const converted = this.converters.convertEntry([key, valueOrFactory]);\n      if (converted.isFailure()) {\n        return failWithDetail(converted.message, converted.detail);\n      }\n      const [vk, vs] = converted.value;\n      return this._collector.getOrAdd(vk, vs);\n    } else {\n      const converted = this.converters.convertKey(key);\n      if (converted.isFailure()) {\n        return failWithDetail(converted.message, converted.detail);\n      }\n      return this._collector.getOrAdd(converted.value, valueOrFactory);\n    }\n  }\n\n  /**\n   * {@inheritdoc Collections.Collector.has}\n   */\n  public has(key: string): boolean {\n    return this._collector.has(key as TKEY);\n  }\n\n  /**\n   * {@inheritdoc Collections.Collector.toReadOnly}\n   */\n  public toReadOnly(): IReadOnlyCollectorConverter<TKEY, TINDEX, TITEM> {\n    return this;\n  }\n\n  /**\n   * Determines if a value is a {@link Collections.CollectibleFactoryCallback | CollectibleFactoryCallback}.\n   * @param value - The value to check.\n   * @returns `true` if the value is a {@link Collections.CollectibleFactoryCallback | CollectibleFactoryCallback},\n   * `false` otherwise.\n   * @public\n   */\n  protected _isCollectibleFactoryCallback(\n    value: unknown | CollectibleFactoryCallback<TKEY, TINDEX, TITEM>\n  ): value is CollectibleFactoryCallback<TKEY, TINDEX, TITEM> {\n    return typeof value === 'function';\n  }\n}\n"]}