@augment-vir/common 31.67.1 → 31.68.1

package/dist/augments/json/copy-through-json.d.ts

@@ -1,11 +1,9 @@
-import { type JsonCompatibleValue, type PartialWithUndefined } from '@augment-vir/core';
+import { type JsonCompatibleValue } from '@augment-vir/core';
 import { type IsUnknown, type Jsonify, type Writable } from 'type-fest';
 /**
  * Deeply copy an object through JSON. This is the fastest deep copy, but the input must already be
  * JSON serializable otherwise the copy will not match the original.
  *
- * Note that this will truncate inputs if they are not safe to serialize.
- *
  * @category JSON : Common
  * @category Copy
  * @category Package : @augment-vir/common
@@ -34,6 +32,13 @@ import { type IsUnknown, type Jsonify, type Writable } from 'type-fest';
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function copyThroughJson<const T>(input: T, { enableUnsafeCopyAll, }?: Readonly<PartialWithUndefined<{
-    enableUnsafeCopyAll: boolean;
-}>> | undefined): IsUnknown<T> extends true ? JsonCompatibleValue : Writable<Jsonify<T>>;
+export declare function copyThroughJson<const T>(input: T): IsUnknown<T> extends true ? JsonCompatibleValue : Writable<Jsonify<T>>;
+/**
+ * Same as {@link copyThroughJson} but this uses safe serialization from {@link safeJsonStringify}.
+ *
+ * @category JSON : Common
+ * @category Copy
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function safeCopyThroughJson<const T>(input: T): IsUnknown<T> extends true ? JsonCompatibleValue : Writable<Jsonify<T>>;

package/dist/augments/json/copy-through-json.js

@@ -1,10 +1,9 @@
+import { ensureErrorAndPrependMessage } from '@augment-vir/core';
 import { safeJsonStringify } from './safe-json-stringify.js';
 /**
  * Deeply copy an object through JSON. This is the fastest deep copy, but the input must already be
  * JSON serializable otherwise the copy will not match the original.
  *
- * Note that this will truncate inputs if they are not safe to serialize.
- *
  * @category JSON : Common
  * @category Copy
  * @category Package : @augment-vir/common
@@ -33,14 +32,31 @@ import { safeJsonStringify } from './safe-json-stringify.js';
  *
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export function copyThroughJson(input, { enableUnsafeCopyAll, } = {}) {
+export function copyThroughJson(input) {
+    try {
+        return JSON.parse(JSON.stringify(input));
+        /* node:coverage ignore next 4 */
+    }
+    catch (error) {
+        console.error(`Failed to JSON copy for:`, input);
+        throw ensureErrorAndPrependMessage(error, 'Failed JSON copy');
+    }
+}
+/**
+ * Same as {@link copyThroughJson} but this uses safe serialization from {@link safeJsonStringify}.
+ *
+ * @category JSON : Common
+ * @category Copy
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function safeCopyThroughJson(input) {
     try {
-        const stringified = enableUnsafeCopyAll ? JSON.stringify(input) : safeJsonStringify(input);
-        return JSON.parse(stringified);
+        return JSON.parse(safeJsonStringify(input));
         /* node:coverage ignore next 4 */
     }
     catch (error) {
-        console.error(`Failed to JSON copy for`, input);
-        throw error;
+        console.error(`Failed to JSON copy for:`, input);
+        throw ensureErrorAndPrependMessage(error, 'Failed JSON copy');
     }
 }

package/dist/augments/number/truncate-number.js

@@ -158,9 +158,9 @@ export function truncateNumber(originalValue, { customSuffixes = defaultTruncati
     // handle edge cases
     if (isNaN(inputNumber) || inputNumber === Infinity) {
         return String(inputNumber);
+        // handle too big or too small edge cases
     }
-    // handle too big or too small edge cases
-    if (requiresScientificNotation(inputNumber)) {
+    else if (requiresScientificNotation(inputNumber)) {
         return truncateScientificNotation({
             input: inputNumber,
             maxLength,

package/dist/augments/object/constructor-instance-map.d.ts

@@ -0,0 +1,36 @@
+import { type AnyObject } from '@augment-vir/core';
+import { type AbstractConstructor, type Constructor } from 'type-fest';
+/**
+ * Map all ancestor constructors of an object to a set of objects.
+ *
+ * @category Internal
+ */
+export declare class ConstructorInstanceMap {
+    /**
+     * The top most constructor to allow in the map. If this constructor is ever reached, the
+     * recursive mapping stops.
+     */
+    protected readonly topMostConstructor?: Function | undefined;
+    /** A map of constructors to their added instances. */
+    readonly map: Map<Function, Set<AnyObject>>;
+    readonly isDestroyed: boolean;
+    constructor(
+    /**
+     * The top most constructor to allow in the map. If this constructor is ever reached, the
+     * recursive mapping stops.
+     */
+    topMostConstructor?: Function | undefined);
+    /**
+     * Add a new instance, mapping each of its ancestor constructors to it inside
+     * {@link ConstructorInstanceMap.map}.
+     */
+    add(instance: AnyObject): void;
+    /** Gets all added instances of the given constructor. */
+    getInstances<T>(constructor: AbstractConstructor<T> | Constructor<T>): Set<T>;
+    /** Remove an instance, removing it from all mappings inside {@link ConstructorInstanceMap.map}. */
+    remove(instance: AnyObject): void;
+    /** Recursively map all ancestor prototypes to the given instance. */
+    protected traverseConstructors(instance: AnyObject, prototype: any, operation: 'add' | 'remove'): void;
+    /** Clean up the internal map. */
+    destroy(): void;
+}

package/dist/augments/object/constructor-instance-map.js

@@ -0,0 +1,77 @@
+/* eslint-disable @typescript-eslint/no-unsafe-function-type */
+import { makeWritable } from '../type/writable.js';
+import { getOrSetFromMap } from './get-or-set.js';
+/**
+ * Map all ancestor constructors of an object to a set of objects.
+ *
+ * @category Internal
+ */
+export class ConstructorInstanceMap {
+    topMostConstructor;
+    /** A map of constructors to their added instances. */
+    map = new Map();
+    isDestroyed = false;
+    constructor(
+    /**
+     * The top most constructor to allow in the map. If this constructor is ever reached, the
+     * recursive mapping stops.
+     */
+    topMostConstructor) {
+        this.topMostConstructor = topMostConstructor;
+    }
+    /**
+     * Add a new instance, mapping each of its ancestor constructors to it inside
+     * {@link ConstructorInstanceMap.map}.
+     */
+    add(instance) {
+        if (this.isDestroyed) {
+            throw new Error('Cannot operate on destroyed ConstructorMap.');
+        }
+        this.traverseConstructors(instance, Object.getPrototypeOf(instance), 'add');
+    }
+    /** Gets all added instances of the given constructor. */
+    getInstances(constructor) {
+        if (this.isDestroyed) {
+            throw new Error('Cannot operate on destroyed ConstructorMap.');
+        }
+        return getOrSetFromMap(this.map, constructor, () => new Set());
+    }
+    /** Remove an instance, removing it from all mappings inside {@link ConstructorInstanceMap.map}. */
+    remove(instance) {
+        if (this.isDestroyed) {
+            throw new Error('Cannot operate on destroyed ConstructorMap.');
+        }
+        this.traverseConstructors(instance, Object.getPrototypeOf(instance), 'remove');
+    }
+    /** Recursively map all ancestor prototypes to the given instance. */
+    traverseConstructors(instance, prototype, operation) {
+        const constructor = prototype.constructor;
+        if (!constructor ||
+            constructor === Function ||
+            constructor === Object ||
+            constructor === this.topMostConstructor) {
+            /** Stop recursing into constructors. */
+            return;
+        }
+        if (operation === 'add') {
+            const set = getOrSetFromMap(this.map, constructor, () => new Set());
+            set.add(instance);
+        }
+        else {
+            const set = this.map.get(constructor);
+            if (set) {
+                set.delete(instance);
+            }
+        }
+        this.traverseConstructors(instance, Object.getPrototypeOf(prototype), operation);
+    }
+    /** Clean up the internal map. */
+    destroy() {
+        if (this.isDestroyed) {
+            return;
+        }
+        makeWritable(this).isDestroyed = true;
+        this.map.clear();
+        delete this.map;
+    }
+}

package/dist/augments/object/merge-deep.js

@@ -14,7 +14,7 @@ export function mergeDeep(...inputs) {
         // nothing to merge if no inputs
         return {};
     }
-    if (inputs.length === 1) {
+    else if (inputs.length === 1) {
         // nothing to merge if only one input
         return inputs[0];
     }

package/dist/index.d.ts

@@ -45,6 +45,7 @@ export * from './augments/number/round.js';
 export * from './augments/number/scientific.js';
 export * from './augments/number/truncate-number.js';
 export * from './augments/number/wrap-number.js';
+export * from './augments/object/constructor-instance-map.js';
 export * from './augments/object/deep-copy.js';
 export * from './augments/object/deep-value.js';
 export * from './augments/object/diff.js';

package/dist/index.js

@@ -45,6 +45,7 @@ export * from './augments/number/round.js';
 export * from './augments/number/scientific.js';
 export * from './augments/number/truncate-number.js';
 export * from './augments/number/wrap-number.js';
+export * from './augments/object/constructor-instance-map.js';
 export * from './augments/object/deep-copy.js';
 export * from './augments/object/deep-value.js';
 export * from './augments/object/diff.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.67.1",
+    "version": "31.68.1",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -40,14 +40,14 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.67.1",
-        "@augment-vir/core": "^31.67.1",
+        "@augment-vir/assert": "^31.68.1",
+        "@augment-vir/core": "^31.68.1",
         "@date-vir/duration": "^8.2.0",
         "ansi-styles": "^6.2.3",
         "deepcopy-esm": "^2.1.1",
         "json5": "^2.2.3",
         "type-fest": "^5.4.4",
-        "typed-event-target": "^4.1.0"
+        "typed-event-target": "^4.3.0"
     },
     "devDependencies": {
         "@web/dev-server-esbuild": "^1.0.5",