ts-data-forge 9.0.0 → 10.0.0

package/dist/collections/imap-mapped.mjs

@@ -42,352 +42,265 @@ import '../number/enum/uint8.mjs';
 import '../number/num.mjs';
 import '../number/refined-number-utils.mjs';
 
-/** Provides utility functions for IMapMapped. */
 var IMapMapped;
-(function (IMapMapped) {
-    /**
-     * Creates a new IMapMapped instance with custom key transformation functions.
-     *
-     * This factory function creates an immutable map that can use complex objects
-     * as keys by providing bidirectional transformation functions. The `toKey`
-     * function converts your custom key type to a primitive type that can be
-     * efficiently stored, while `fromKey` reconstructs the original key type for
-     * iteration and access.
-     *
-     * **Performance:** O(n) where n is the number of entries in the iterable.
-     *
-     * @template K The type of the custom keys.
-     * @template V The type of the values.
-     * @template KM The type of the mapped primitive keys.
-     * @example
-     *
-     * ```ts
-     * type Point = Readonly<{ x: number; y: number }>;
-     *
-     * const toKey = (p: Point) => JSON.stringify(p);
-     *
-     * // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-     * const fromKey = (key: string) => JSON.parse(key) as Point;
-     *
-     * const map = IMapMapped.create<Point, string, string>(
-     *   [
-     *     [{ x: 0, y: 0 }, 'origin'],
-     *     [{ x: 1, y: 0 }, 'right'],
-     *   ],
-     *   toKey,
-     *   fromKey,
-     * );
-     *
-     * assert.isTrue(map.size === 2);
-     *
-     * assert.deepStrictEqual(map.get({ x: 0, y: 0 }), Optional.some('origin'));
-     * ```
-     *
-     * @param iterable An iterable of key-value pairs using the custom key type.
-     * @param toKey A function that converts a custom key `K` to a primitive key
-     *   `KM`. This function must be deterministic and produce unique values for
-     *   unique keys.
-     * @param fromKey A function that converts a primitive key `KM` back to the
-     *   custom key `K`. This should be the inverse of `toKey`.
-     * @returns A new IMapMapped instance containing all entries from the
-     *   iterable.
-     */
-    IMapMapped.create = (iterable, toKey, fromKey) => new IMapMappedClass(iterable, toKey, fromKey);
-    /**
-     * Checks if two IMapMapped instances are structurally equal.
-     *
-     * Two IMapMapped instances are considered equal if they have the same size
-     * and contain exactly the same key-value pairs. The comparison is performed
-     * on the underlying mapped keys and values, so the transformation functions
-     * themselves don't need to be identical. Values are compared using
-     * JavaScript's `===` operator.
-     *
-     * **Performance:** O(n) where n is the size of the smaller map.
-     *
-     * @template K The type of the custom keys.
-     * @template V The type of the values.
-     * @template KM The type of the mapped primitive keys.
-     * @example
-     *
-     * ```ts
-     * type Point = Readonly<{ x: number; y: number }>;
-     *
-     * const toKey = (p: Point) => JSON.stringify(p);
-     *
-     * // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-     * const fromKey = (key: string) => JSON.parse(key) as Point;
-     *
-     * const first = IMapMapped.create<Point, string, string>(
-     *   [
-     *     [{ x: 0, y: 0 }, 'origin'],
-     *     [{ x: 1, y: 0 }, 'right'],
-     *   ],
-     *   toKey,
-     *   fromKey,
-     * );
-     *
-     * const second = IMapMapped.create<Point, string, string>(
-     *   [
-     *     [{ x: 1, y: 0 }, 'right'],
-     *     [{ x: 0, y: 0 }, 'origin'],
-     *   ],
-     *   toKey,
-     *   fromKey,
-     * );
-     *
-     * const third = IMapMapped.create<Point, string, string>(
-     *   [[{ x: 0, y: 0 }, 'different']],
-     *   toKey,
-     *   fromKey,
-     * );
-     *
-     * assert.isTrue(IMapMapped.equal(first, second));
-     *
-     * assert.isFalse(IMapMapped.equal(first, third));
-     * ```
-     *
-     * @param a The first IMapMapped instance to compare.
-     * @param b The second IMapMapped instance to compare.
-     * @returns `true` if the maps contain exactly the same key-value pairs,
-     *   `false` otherwise.
-     */
-    IMapMapped.equal = (a, b) => a.size === b.size &&
-        a.every((v, k) => pipe(b.get(k)).map((bv) => isSome(bv) && bv.value === v).value);
+((IMapMapped2) => {
+  IMapMapped2.create = (iterable, toKey, fromKey) => new IMapMappedClass(iterable, toKey, fromKey);
+  IMapMapped2.equal = (a, b) => a.size === b.size && a.every(
+    (v, k) => pipe(b.get(k)).map((bv) => isSome(bv) && bv.value === v).value
+  );
 })(IMapMapped || (IMapMapped = {}));
-/**
- * Internal class implementation for IMapMapped providing immutable map
- * operations with key transformation.
- *
- * This class implements the IMapMapped interface by maintaining a JavaScript
- * Map with primitive keys internally while exposing an API that works with
- * custom key types. The transformation between custom and primitive keys is
- * handled transparently through the provided `toKey` and `fromKey` functions.
- *
- * **Implementation Details:**
- *
- * - Uses ReadonlyMap<KM, V> internally where KM is the primitive key type
- * - Stores transformation functions for bidirectional key conversion
- * - Implements copy-on-write semantics for efficiency
- * - Provides optional debug messaging for development
- *
- * @template K The type of the custom keys.
- * @template V The type of the values.
- * @template KM The type of the mapped primitive keys.
- * @implements IMapMapped
- * @implements Iterable
- * @internal This class should not be used directly. Use IMapMapped.create() instead.
- */
 class IMapMappedClass {
-    #map;
-    #toKey;
-    #fromKey;
-    #showNotFoundMessage;
-    /**
-     * Constructs an IMapMappedClass instance with custom key transformation.
-     *
-     * @param iterable An iterable of key-value pairs using the custom key type K.
-     * @param toKey A function that converts a custom key K to a primitive key KM.
-     *   Must be deterministic and produce unique values for unique keys.
-     * @param fromKey A function that converts a primitive key KM back to the
-     *   custom key K. Should be the inverse of the toKey function.
-     * @param showNotFoundMessage Whether to log warning messages when operations
-     *   are performed on non-existent keys. Useful for debugging. Defaults to
-     *   false for production use.
-     * @internal Use IMapMapped.create() instead of calling this constructor directly.
-     */
-    constructor(iterable, toKey, fromKey, showNotFoundMessage = false) {
-        this.#map = new Map(Array.from(iterable, ([k, v]) => [toKey(k), v]));
-        this.#toKey = toKey;
-        this.#fromKey = fromKey;
-        this.#showNotFoundMessage = showNotFoundMessage;
+  #map;
+  #toKey;
+  #fromKey;
+  #showNotFoundMessage;
+  /**
+   * Constructs an IMapMappedClass instance with custom key transformation.
+   *
+   * @param iterable An iterable of key-value pairs using the custom key type K.
+   * @param toKey A function that converts a custom key K to a primitive key KM.
+   *   Must be deterministic and produce unique values for unique keys.
+   * @param fromKey A function that converts a primitive key KM back to the
+   *   custom key K. Should be the inverse of the toKey function.
+   * @param showNotFoundMessage Whether to log warning messages when operations
+   *   are performed on non-existent keys. Useful for debugging. Defaults to
+   *   false for production use.
+   * @internal Use IMapMapped.create() instead of calling this constructor directly.
+   */
+  constructor(iterable, toKey, fromKey, showNotFoundMessage = false) {
+    this.#map = new Map(Array.from(iterable, ([k, v]) => [toKey(k), v]));
+    this.#toKey = toKey;
+    this.#fromKey = fromKey;
+    this.#showNotFoundMessage = showNotFoundMessage;
+  }
+  /** @inheritdoc */
+  get size() {
+    return asUint32(this.#map.size);
+  }
+  /** @inheritdoc */
+  has(key) {
+    return this.#map.has(this.#toKey(key));
+  }
+  /** @inheritdoc */
+  get(key) {
+    if (!this.has(key)) return none;
+    return some(this.#map.get(this.#toKey(key)));
+  }
+  /** @inheritdoc */
+  every(predicate) {
+    for (const [k, v] of this.entries()) {
+      if (!predicate(v, k)) return false;
     }
-    /** @inheritdoc */
-    get size() {
-        return asUint32(this.#map.size);
+    return true;
+  }
+  /** @inheritdoc */
+  some(predicate) {
+    for (const [k, v] of this.entries()) {
+      if (predicate(v, k)) return true;
     }
-    /** @inheritdoc */
-    has(key) {
-        // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-        return this.#map.has(this.#toKey(key));
+    return false;
+  }
+  /** @inheritdoc */
+  delete(key) {
+    if (!this.has(key)) {
+      if (this.#showNotFoundMessage) {
+        console.warn(
+          `IMapMapped.delete: key not found: ${String(this.#toKey(key))}`
+        );
+      }
+      return this;
     }
-    /** @inheritdoc */
-    get(key) {
-        if (!this.has(key))
-            return none;
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, total-functions/no-unsafe-type-assertion
-        return some(this.#map.get(this.#toKey(key)));
+    const keyMapped = this.#toKey(key);
+    return IMapMapped.create(
+      Array.from(this.#map).filter(([km]) => !Object.is(km, keyMapped)).map(([km, v]) => tp(this.#fromKey(km), v)),
+      this.#toKey,
+      this.#fromKey
+    );
+  }
+  /** @inheritdoc */
+  set(key, value) {
+    const curr = this.get(key);
+    if (isSome(curr) && value === curr.value) return this;
+    const keyMapped = this.#toKey(key);
+    if (!this.has(key)) {
+      return IMapMapped.create(
+        [...this.#map, tp(keyMapped, value)].map(
+          ([km, v]) => tp(this.#fromKey(km), v)
+        ),
+        this.#toKey,
+        this.#fromKey
+      );
     }
-    /** @inheritdoc */
-    every(predicate) {
-        for (const [k, v] of this.entries()) {
-            if (!predicate(v, k))
-                return false;
-        }
-        return true;
-    }
-    /** @inheritdoc */
-    some(predicate) {
-        for (const [k, v] of this.entries()) {
-            if (predicate(v, k))
-                return true;
-        }
-        return false;
+    return IMapMapped.create(
+      Array.from(
+        this.#map,
+        ([km, v]) => tp(this.#fromKey(km), Object.is(km, keyMapped) ? value : v)
+      ),
+      this.#toKey,
+      this.#fromKey
+    );
+  }
+  /** @inheritdoc */
+  update(key, updater) {
+    const curr = this.get(key);
+    if (isNone(curr)) {
+      if (this.#showNotFoundMessage) {
+        console.warn(
+          `IMapMapped.update: key not found: ${String(this.#toKey(key))}`
+        );
+      }
+      return this;
     }
-    /** @inheritdoc */
-    delete(key) {
-        if (!this.has(key)) {
+    const keyMapped = this.#toKey(key);
+    return IMapMapped.create(
+      Array.from(
+        this.#map,
+        ([km, v]) => tp(
+          this.#fromKey(km),
+          Object.is(km, keyMapped) ? updater(curr.value) : v
+        )
+      ),
+      this.#toKey,
+      this.#fromKey
+    );
+  }
+  /** @inheritdoc */
+  withMutations(actions) {
+    const mut_result = new Map(this.#map);
+    const updateFn = (action) => {
+      const key = this.#toKey(action.key);
+      switch (action.type) {
+        case "delete":
+          mut_result.delete(key);
+          break;
+        case "set":
+          mut_result.set(key, action.value);
+          break;
+        case "update": {
+          const curr = mut_result.get(key);
+          if (!mut_result.has(key) || curr === void 0) {
             if (this.#showNotFoundMessage) {
-                console.warn(`IMapMapped.delete: key not found: ${String(this.#toKey(key))}`);
+              console.warn(
+                `IMapMapped.withMutations::update: key not found: ${String(key)}`
+              );
             }
-            return this;
+            break;
+          }
+          mut_result.set(key, action.updater(curr));
+          break;
         }
-        const keyMapped = this.#toKey(key);
-        return IMapMapped.create(Array.from(this.#map)
-            .filter(([km]) => !Object.is(km, keyMapped))
-            .map(([km, v]) => tp(this.#fromKey(km), v)), this.#toKey, this.#fromKey);
-    }
-    /** @inheritdoc */
-    set(key, value) {
-        const curr = this.get(key);
-        if (isSome(curr) && value === curr.value)
-            return this;
-        const keyMapped = this.#toKey(key);
-        if (!this.has(key)) {
-            return IMapMapped.create([...this.#map, tp(keyMapped, value)].map(([km, v]) => tp(this.#fromKey(km), v)), this.#toKey, this.#fromKey);
-        }
-        return IMapMapped.create(Array.from(this.#map, ([km, v]) => tp(this.#fromKey(km), Object.is(km, keyMapped) ? value : v)), this.#toKey, this.#fromKey);
-    }
-    /** @inheritdoc */
-    update(key, updater) {
-        const curr = this.get(key);
-        if (isNone(curr)) {
-            if (this.#showNotFoundMessage) {
-                console.warn(`IMapMapped.update: key not found: ${String(this.#toKey(key))}`);
-            }
-            return this;
-        }
-        const keyMapped = this.#toKey(key);
-        return IMapMapped.create(Array.from(this.#map, ([km, v]) => tp(this.#fromKey(km), Object.is(km, keyMapped) ? updater(curr.value) : v)), this.#toKey, this.#fromKey);
-    }
-    /** @inheritdoc */
-    withMutations(actions) {
-        const mut_result = new Map(this.#map);
-        const updateFn = (action) => {
-            const key = this.#toKey(action.key);
-            switch (action.type) {
-                case 'delete':
-                    mut_result.delete(key);
-                    break;
-                case 'set':
-                    mut_result.set(key, action.value);
-                    break;
-                case 'update': {
-                    const curr = mut_result.get(key);
-                    if (!mut_result.has(key) || curr === undefined) {
-                        if (this.#showNotFoundMessage) {
-                            console.warn(`IMapMapped.withMutations::update: key not found: ${String(key)}`);
-                        }
-                        break;
-                    }
-                    mut_result.set(key, action.updater(curr));
-                    break;
-                }
-            }
-        };
-        for (const action of actions) {
-            updateFn(action);
-        }
-        return IMapMapped.create(Array.from(mut_result, ([k, v]) => [this.#fromKey(k), v]), this.#toKey, this.#fromKey);
-    }
-    /** @inheritdoc */
-    map(mapFn) {
-        return IMapMapped.create(this.toArray().map(([k, v]) => tp(k, mapFn(v, k))), this.#toKey, this.#fromKey);
-    }
-    /** @inheritdoc */
-    mapKeys(mapFn) {
-        return IMapMapped.create(this.toArray().map(([k, v]) => tp(mapFn(k), v)), this.#toKey, this.#fromKey);
-    }
-    /** @inheritdoc */
-    mapEntries(mapFn) {
-        return IMapMapped.create(this.toArray().map(mapFn), this.#toKey, this.#fromKey);
-    }
-    /** @inheritdoc */
-    forEach(callbackfn) {
-        for (const [km, value] of this.#map) {
-            callbackfn(value, this.#fromKey(km));
-        }
-    }
-    /**
-     * @example
-     *
-     * ```ts
-     * type Point = Readonly<{ x: number; y: number }>;
-     *
-     * const toKey = (p: Point) => JSON.stringify(p);
-     *
-     * // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-     * const fromKey = (key: string) => JSON.parse(key) as Point;
-     *
-     * const map = IMapMapped.create<Point, string, string>(
-     *   [
-     *     [{ x: 0, y: 0 }, 'origin'],
-     *     [{ x: 1, y: 0 }, 'right'],
-     *   ],
-     *   toKey,
-     *   fromKey,
-     * );
-     *
-     * const collected = Array.from(map);
-     *
-     * assert.deepStrictEqual(collected, [
-     *   [{ x: 0, y: 0 }, 'origin'],
-     *   [{ x: 1, y: 0 }, 'right'],
-     * ]);
-     * ```
-     *
-     * @inheritdoc
-     */
-    *[Symbol.iterator]() {
-        for (const e of this.entries()) {
-            yield e;
-        }
-    }
-    /** @inheritdoc */
-    *keys() {
-        for (const km of this.#map.keys()) {
-            yield this.#fromKey(km);
-        }
-    }
-    /** @inheritdoc */
-    values() {
-        return this.#map.values();
-    }
-    /** @inheritdoc */
-    *entries() {
-        for (const [km, v] of this.#map) {
-            yield [this.#fromKey(km), v];
-        }
-    }
-    /** @inheritdoc */
-    toKeysArray() {
-        return Array.from(this.keys());
+      }
+    };
+    for (const action of actions) {
+      updateFn(action);
     }
-    /** @inheritdoc */
-    toValuesArray() {
-        return Array.from(this.values());
+    return IMapMapped.create(
+      Array.from(mut_result, ([k, v]) => [this.#fromKey(k), v]),
+      this.#toKey,
+      this.#fromKey
+    );
+  }
+  /** @inheritdoc */
+  map(mapFn) {
+    return IMapMapped.create(
+      this.toArray().map(([k, v]) => tp(k, mapFn(v, k))),
+      this.#toKey,
+      this.#fromKey
+    );
+  }
+  /** @inheritdoc */
+  mapKeys(mapFn) {
+    return IMapMapped.create(
+      this.toArray().map(([k, v]) => tp(mapFn(k), v)),
+      this.#toKey,
+      this.#fromKey
+    );
+  }
+  /** @inheritdoc */
+  mapEntries(mapFn) {
+    return IMapMapped.create(
+      this.toArray().map(mapFn),
+      this.#toKey,
+      this.#fromKey
+    );
+  }
+  /** @inheritdoc */
+  forEach(callbackfn) {
+    for (const [km, value] of this.#map) {
+      callbackfn(value, this.#fromKey(km));
     }
-    /** @inheritdoc */
-    toEntriesArray() {
-        return Array.from(this.entries());
+  }
+  /**
+   * @example
+   *
+   * ```ts
+   * type Point = Readonly<{ x: number; y: number }>;
+   *
+   * const toKey = (p: Point) => JSON.stringify(p);
+   *
+   * // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+   * const fromKey = (key: string) => JSON.parse(key) as Point;
+   *
+   * const map = IMapMapped.create<Point, string, string>(
+   *   [
+   *     [{ x: 0, y: 0 }, 'origin'],
+   *     [{ x: 1, y: 0 }, 'right'],
+   *   ],
+   *   toKey,
+   *   fromKey,
+   * );
+   *
+   * const collected = Array.from(map);
+   *
+   * assert.deepStrictEqual(collected, [
+   *   [{ x: 0, y: 0 }, 'origin'],
+   *   [{ x: 1, y: 0 }, 'right'],
+   * ]);
+   * ```
+   *
+   * @inheritdoc
+   */
+  *[Symbol.iterator]() {
+    for (const e of this.entries()) {
+      yield e;
     }
-    /** @inheritdoc */
-    toArray() {
-        return Array.from(this.entries());
+  }
+  /** @inheritdoc */
+  *keys() {
+    for (const km of this.#map.keys()) {
+      yield this.#fromKey(km);
     }
-    /** @inheritdoc */
-    toRawMap() {
-        return this.#map;
+  }
+  /** @inheritdoc */
+  values() {
+    return this.#map.values();
+  }
+  /** @inheritdoc */
+  *entries() {
+    for (const [km, v] of this.#map) {
+      yield [this.#fromKey(km), v];
     }
+  }
+  /** @inheritdoc */
+  toKeysArray() {
+    return Array.from(this.keys());
+  }
+  /** @inheritdoc */
+  toValuesArray() {
+    return Array.from(this.values());
+  }
+  /** @inheritdoc */
+  toEntriesArray() {
+    return Array.from(this.entries());
+  }
+  /** @inheritdoc */
+  toArray() {
+    return Array.from(this.entries());
+  }
+  /** @inheritdoc */
+  toRawMap() {
+    return this.#map;
+  }
 }
 
 export { IMapMapped };