@augment-vir/common 29.0.0 → 29.1.1

package/dist/cjs/augments/object/selection-set.js

@@ -1,2 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.selectFrom = selectFrom;
+exports.selectCollapsedFrom = selectCollapsedFrom;
+const run_time_assertions_1 = require("run-time-assertions");
+const tuple_1 = require("../tuple");
+const filter_object_1 = require("./filter-object");
+const map_object_1 = require("./map-object");
+function shouldPreserve(input) {
+    return (0, run_time_assertions_1.isPrimitive)(input) || input instanceof RegExp;
+}
+function selectFrom(originalObject, selectionSet) {
+    if (Array.isArray(originalObject)) {
+        return originalObject.map((originalEntry) => selectFrom(originalEntry, selectionSet));
+    }
+    const keysToRemove = [];
+    return (0, filter_object_1.omitObjectKeys)((0, map_object_1.mapObjectValues)(originalObject, (key, value) => {
+        const selection = selectionSet[key];
+        if (selection === true) {
+            return value;
+        }
+        else if (!selection) {
+            keysToRemove.push(key);
+            return undefined;
+        }
+        else {
+            return selectFrom(value, selection);
+        }
+    }), keysToRemove);
+}
+function selectCollapsedFrom(originalObject, selectionSet, collapse) {
+    const selected = selectFrom(originalObject, selectionSet);
+    return collapseObject(selected);
+}
+function collapseObject(input) {
+    if (shouldPreserve(input)) {
+        return input;
+    }
+    const keys = Object.keys(input);
+    if (Array.isArray(input)) {
+        return input.map((innerInput) => collapseObject(innerInput));
+    }
+    else if ((0, tuple_1.isLengthAtLeast)(keys, 2)) {
+        return input;
+    }
+    else if ((0, tuple_1.isLengthAtLeast)(keys, 1)) {
+        return collapseObject(input[keys[0]]);
+    }
+    else {
+        return input;
+    }
+}

package/dist/esm/augments/object/selection-set.js

@@ -1 +1,48 @@
-export {};
+import { isPrimitive } from 'run-time-assertions';
+import { isLengthAtLeast } from '../tuple';
+import { omitObjectKeys } from './filter-object';
+import { mapObjectValues } from './map-object';
+function shouldPreserve(input) {
+    return isPrimitive(input) || input instanceof RegExp;
+}
+export function selectFrom(originalObject, selectionSet) {
+    if (Array.isArray(originalObject)) {
+        return originalObject.map((originalEntry) => selectFrom(originalEntry, selectionSet));
+    }
+    const keysToRemove = [];
+    return omitObjectKeys(mapObjectValues(originalObject, (key, value) => {
+        const selection = selectionSet[key];
+        if (selection === true) {
+            return value;
+        }
+        else if (!selection) {
+            keysToRemove.push(key);
+            return undefined;
+        }
+        else {
+            return selectFrom(value, selection);
+        }
+    }), keysToRemove);
+}
+export function selectCollapsedFrom(originalObject, selectionSet, collapse) {
+    const selected = selectFrom(originalObject, selectionSet);
+    return collapseObject(selected);
+}
+function collapseObject(input) {
+    if (shouldPreserve(input)) {
+        return input;
+    }
+    const keys = Object.keys(input);
+    if (Array.isArray(input)) {
+        return input.map((innerInput) => collapseObject(innerInput));
+    }
+    else if (isLengthAtLeast(keys, 2)) {
+        return input;
+    }
+    else if (isLengthAtLeast(keys, 1)) {
+        return collapseObject(input[keys[0]]);
+    }
+    else {
+        return input;
+    }
+}

package/dist/types/augments/object/selection-set.d.ts

@@ -1,4 +1,4 @@
-import { IsNever, Primitive } from 'type-fest';
+import { IsAny, IsNever, Primitive } from 'type-fest';
 import { TsRecurse, TsRecursionStart, TsRecursionTracker, TsTooMuchRecursion } from '../type-recursion';
 import { UnionToIntersection } from '../union';
 import { AnyObject } from './any-object';
@@ -8,11 +8,11 @@ import { PropertyValueType } from './object';
 export type SelectionTypesToPreserve = Primitive | RegExp;
 /** A generic selection set without specific keys. */
 export type GenericSelectionSet = {
-    [Key in PropertyKey]: boolean | GenericSelectionSet;
+    [Key in PropertyKey]: boolean | GenericSelectionSet | unknown;
 };
 /** Masks an object value with the given {@link SelectionSet}. */
 export type PickSelection<Full extends Readonly<AnyObject>, Selection extends GenericSelectionSet, Depth extends TsRecursionTracker = TsRecursionStart> = Depth extends TsTooMuchRecursion ? ['Error: recursive object depth is too deep.'] : Full extends ReadonlyArray<infer Element extends any> ? (PickSelection<Extract<Element, AnyObject>, Selection, TsRecurse<Depth>> | Exclude<Element, AnyObject>)[] : {
-    [Key in keyof Selection as Selection[Key] extends false ? never : Key extends keyof Full ? Key : never]: (Selection[Key] extends GenericSelectionSet ? PickSelection<NonNullable<Extract<Full[Key], AnyObject>>, Selection[Key], TsRecurse<Depth>> : Full[Key]) | Exclude<Full[Key], AnyObject>;
+    -readonly [Key in keyof Selection as Selection[Key] extends false ? never : Key extends keyof Full ? Key : never]: (Selection[Key] extends GenericSelectionSet ? PickSelection<NonNullable<Extract<Full[Key], AnyObject>>, Selection[Key], TsRecurse<Depth>> : Full[Key]) | Exclude<Full[Key], AnyObject>;
 };
 /**
  * Collapses a selected value to the first part of the selection that contains more than 1 key or
@@ -20,6 +20,8 @@ export type PickSelection<Full extends Readonly<AnyObject>, Selection extends Ge
  */
 export type FirstSelectedValue<Full extends Readonly<AnyObject>, Selection extends GenericSelectionSet, Depth extends TsRecursionTracker = TsRecursionStart> = Depth extends TsTooMuchRecursion ? 'Error: recursive object depth is too deep.' : KeyCount<PickSelection<Full, Selection, Depth>> extends 1 ? Selection[keyof PickSelection<Full, Selection, Depth>] extends GenericSelectionSet ? FirstSelectedValue<Full[keyof PickSelection<Full, Selection, Depth>], Selection[keyof PickSelection<Full, Selection, Depth>], TsRecurse<Depth>> : PropertyValueType<PickSelection<Full, Selection, Depth>> : PickSelection<Full, Selection, Depth>;
 /** Defines a selection set for the given object. */
-export type SelectionSet<Full extends Readonly<AnyObject>, Depth extends TsRecursionTracker = TsRecursionStart> = Depth extends TsTooMuchRecursion ? ['Error: recursive object depth is too deep.'] : Full extends ReadonlyArray<infer FullChild extends AnyObject> ? SelectionSet<FullChild, TsRecurse<Depth>> : Partial<{
+export type SelectionSet<Full extends Readonly<AnyObject>, Depth extends TsRecursionTracker = TsRecursionStart> = IsAny<Full> extends true ? any : Depth extends TsTooMuchRecursion ? ['Error: recursive object depth is too deep.'] : Full extends ReadonlyArray<infer FullChild extends AnyObject> ? SelectionSet<FullChild, TsRecurse<Depth>> : Partial<{
     [Key in keyof Full]: IsNever<Exclude<Full[Key], SelectionTypesToPreserve>> extends true ? boolean : boolean | UnionToIntersection<SelectionSet<Full[Key], TsRecurse<Depth>>>;
 }>;
+export declare function selectFrom<Full extends AnyObject, const Selection extends SelectionSet<NoInfer<Full>>>(originalObject: Readonly<Full>, selectionSet: Readonly<Selection>): PickSelection<Full, Selection>;
+export declare function selectCollapsedFrom<Full extends AnyObject, const Selection extends SelectionSet<NoInfer<Full>>, const Collapse extends boolean | undefined>(originalObject: Readonly<Full>, selectionSet: Readonly<Selection>, collapse?: Collapse): FirstSelectedValue<Full, Selection>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "29.0.0",
+    "version": "29.1.1",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"