@augment-vir/common 28.2.4 → 29.1.0

package/dist/esm/augments/object/nested-keys.js

@@ -1,56 +0,0 @@
-import { isRunTimeType } from 'run-time-assertions';
-import { isLengthAtLeast } from '../tuple';
-import { isObject } from './object';
-import { typedHasProperty } from './typed-has-property';
-/** This mutates the {@link originalObject} input. */
-export function setValueWithNestedKeys(originalObject, nestedKeys, value) {
-    /**
-     * Lots of as any casts in here because these types are, under the hood, pretty complex. Since
-     * the inputs and outputs of this function are well typed, these internal as any casts do not
-     * affect the external API of this function.
-     */
-    const nestedKeysInput = nestedKeys;
-    const inputObject = originalObject;
-    if (isRunTimeType(inputObject, 'array')) {
-        inputObject.forEach((entry) => {
-            if (isObject(entry)) {
-                setValueWithNestedKeys(entry, nestedKeysInput, value);
-            }
-        });
-    }
-    else if (isLengthAtLeast(nestedKeysInput, 2)) {
-        /** If there are more keys to traverse into. */
-        const nextKey = nestedKeysInput[0];
-        if (!(nextKey in inputObject)) {
-            inputObject[nextKey] = {};
-        }
-        const nextParent = inputObject[nextKey];
-        setValueWithNestedKeys(nextParent, nestedKeysInput.slice(1), value);
-    }
-    else if (isLengthAtLeast(nestedKeysInput, 1)) {
-        inputObject[nestedKeysInput[0]] = value;
-    }
-}
-export function getValueFromNestedKeys(originalObject, nestedKeys) {
-    /**
-     * Lots of as any casts in here because these types are, under the hood, pretty complex. Since
-     * the inputs and outputs of this function are well typed, these internal as any casts do not
-     * affect the external API of this function.
-     */
-    const nestedKeysInput = nestedKeys;
-    const inputObject = originalObject;
-    if (isRunTimeType(inputObject, 'array')) {
-        return inputObject.map((entry) => getValueFromNestedKeys(entry, nestedKeys));
-    }
-    const keyToAccess = nestedKeysInput[0];
-    if (!typedHasProperty(inputObject, keyToAccess)) {
-        return undefined;
-    }
-    const currentValue = inputObject[keyToAccess];
-    if (nestedKeysInput.length > 1) {
-        return getValueFromNestedKeys(currentValue, nestedKeysInput.slice(1));
-    }
-    else {
-        return currentValue;
-    }
-}

package/dist/types/augments/object/nested-keys.d.ts

@@ -1,18 +0,0 @@
-import { ArrayElement } from '../type';
-import { TsRecurse, TsRecursionStart, TsRecursionTracker, TsTooMuchRecursion } from '../type-recursion';
-import { PropertyValueType } from './object';
-import { UnionToIntersection } from './old-union-to-intersection';
-export type NestedSequentialKeys<ObjectGeneric extends object, Depth extends TsRecursionTracker = TsRecursionStart> = Depth extends TsTooMuchRecursion ? ['Error: recursive object depth is too deep.'] : NonNullable<ObjectGeneric> extends ReadonlyArray<any> ? Extract<NonNullable<ObjectGeneric>[number], object> extends never ? [number] : NestedSequentialKeys<Extract<NonNullable<ObjectGeneric>[number], object>, TsRecurse<Depth>> : PropertyValueType<{
-    [Prop in keyof ObjectGeneric]: NonNullable<ObjectGeneric[Prop]> extends object ? Readonly<[
-        Prop,
-        ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>, TsRecurse<Depth>> | [])
-    ]> : Readonly<[Prop]>;
-}>;
-export type NestedKeys<ObjectGeneric extends object, Depth extends TsRecursionTracker = TsRecursionStart> = Depth extends TsTooMuchRecursion ? ['Error: recursive object depth is too deep.'] : ObjectGeneric extends ReadonlyArray<any> ? NestedKeys<ArrayElement<ObjectGeneric>, TsRecurse<Depth>> : UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>> extends object ? [
-    keyof ObjectGeneric,
-    ...(NestedKeys<UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>>, TsRecurse<Depth>> | [])
-] : [keyof ObjectGeneric];
-export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>, Depth extends TsRecursionTracker = TsRecursionStart> = ObjectGeneric extends ReadonlyArray<any> ? NestedValue<Extract<ObjectGeneric[number], object>, NestedKeysGeneric, TsRecurse<Depth>>[] : NestedKeysGeneric extends readonly [infer FirstEntry, ...infer FollowingEntries] ? FirstEntry extends keyof ObjectGeneric ? FollowingEntries extends never[] ? ObjectGeneric[FirstEntry] : ObjectGeneric[FirstEntry] extends object ? FollowingEntries extends NestedSequentialKeys<ObjectGeneric[FirstEntry]> ? NestedValue<ObjectGeneric[FirstEntry], FollowingEntries, TsRecurse<Depth>> : never : never : never : never;
-/** This mutates the {@link originalObject} input. */
-export declare function setValueWithNestedKeys<const ObjectGeneric extends object, const KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(originalObject: ObjectGeneric, nestedKeys: Readonly<KeysGeneric>, value: Readonly<NestedValue<ObjectGeneric, KeysGeneric>>): void;
-export declare function getValueFromNestedKeys<const ObjectGeneric extends object, const KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(originalObject: ObjectGeneric, nestedKeys: KeysGeneric): NestedValue<ObjectGeneric, KeysGeneric>;