[patch] preserve optional properties in SelectFrom

electrovir · Dec 10, 2024 · bf4fd7d · bf4fd7d
1 parent d0d5e51
commit bf4fd7d
Show file tree

Hide file tree

Showing 13 changed files with 125 additions and 70 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/mono-repo-root",
-    "version": "31.1.0",
+    "version": "31.1.1",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {

diff --git a/packages/assert/package.json b/packages/assert/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/assert",
-    "version": "31.1.0",
+    "version": "31.1.1",
     "description": "A collection of assertions for test and production code alike.",
     "keywords": [
         "augment",
@@ -41,7 +41,7 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/core": "^31.1.0",
+        "@augment-vir/core": "^31.1.1",
         "@date-vir/duration": "^7.0.1",
         "deep-eql": "^5.0.2",
         "expect-type": "^1.1.0",

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.1.0",
+    "version": "31.1.1",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -39,8 +39,8 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.1.0",
-        "@augment-vir/core": "^31.1.0",
+        "@augment-vir/assert": "^31.1.1",
+        "@augment-vir/core": "^31.1.1",
         "@date-vir/duration": "^7.0.1",
         "ansi-styles": "^6.2.1",
         "json5": "^2.2.3",

diff --git a/packages/common/src/augments/selection-set/select-collapsed.ts b/packages/common/src/augments/selection-set/select-collapsed.ts
@@ -62,7 +62,7 @@ export function selectCollapsedFrom<
     return collapseObject(selected, selectionSet) as PickCollapsedSelection<Full, Selection>;
 }
 
-function collapseObject(input: Readonly<AnyObject>, selectionSet: unknown): AnyObject {
+function collapseObject(input: any, selectionSet: unknown): AnyObject {
     if (shouldPreserveInSelectionSet(input)) {
         return input;
     }

diff --git a/packages/common/src/augments/selection-set/select-from.test.ts b/packages/common/src/augments/selection-set/select-from.test.ts
@@ -4,6 +4,42 @@ import {selectFrom} from './select-from.js';
 import {SelectFrom} from './selection-set.js';
 
 describe(selectFrom.name, () => {
+    it('preserves nested optional properties', () => {
+        type ExampleWithOptional = {
+            a: string;
+            b?: number;
+            c: {
+                d?: RegExp;
+                e?: {
+                    f?: Set<string>;
+                };
+            };
+        };
+
+        assert
+            .tsType<
+                SelectFrom<
+                    ExampleWithOptional,
+                    {
+                        b: true;
+                        c: {
+                            d: true;
+                            e: true;
+                        };
+                    }
+                >
+            >()
+            .slowEquals<{
+                b?: number;
+                c: {
+                    d?: RegExp;
+                    e?: {
+                        f?: Set<string>;
+                    };
+                };
+            }>();
+    });
+
     it('has proper types', () => {
         selectFrom(
             {

diff --git a/packages/common/src/augments/selection-set/selection-set.test.ts b/packages/common/src/augments/selection-set/selection-set.test.ts
@@ -67,7 +67,7 @@ describe('PickSelection', () => {
                 >
             >()
             .equals<{
-                top:
+                top?:
                     | undefined
                     | {
                           mid: {low: string[]};

diff --git a/packages/common/src/augments/selection-set/selection-set.ts b/packages/common/src/augments/selection-set/selection-set.ts
@@ -1,10 +1,16 @@
-import type {AnyObject} from '@augment-vir/core';
-import {IsAny, IsNever, Primitive, UnionToIntersection} from 'type-fest';
+import {type AnyObject, type RequiredKeysOf} from '@augment-vir/core';
 import {
-    TsRecurse,
-    TsRecursionStart,
-    TsRecursionTracker,
-    TsTooMuchRecursion,
+    type IsAny,
+    type IsNever,
+    type OptionalKeysOf,
+    type Primitive,
+    type UnionToIntersection,
+} from 'type-fest';
+import {
+    type TsRecurse,
+    type TsRecursionStart,
+    type TsRecursionTracker,
+    type TsTooMuchRecursion,
 } from '../type/type-recursion.js';
 
 /** All types that won't be recursed into when defining a {@link SelectionSet}. */
@@ -21,6 +27,16 @@ export type GenericSelectionSet = {
     [Key in PropertyKey]: unknown;
 };
 
+type MakeKeysOptional<Full extends AnyObject, T extends AnyObject> =
+    IsNever<Extract<OptionalKeysOf<Full>, keyof T>> extends true
+        ? /** No optional keys. */
+          {[Key in keyof T]: T[Key]}
+        : IsNever<Extract<RequiredKeysOf<Full>, keyof T>> extends true
+          ? /** Only optional keys. */ {[Key in keyof T]?: T[Key]}
+          : /** Optional and required keys. */ {
+                [Key in Extract<RequiredKeysOf<Full>, keyof T>]: T[Key];
+            } & {[Key in Extract<OptionalKeysOf<Full>, keyof T>]?: T[Key]};
+
 /**
  * Performs a SQL-like nested selection on an object, extracting the selected values. This produces
  * the output type for `selectFrom`.
@@ -40,21 +56,24 @@ export type SelectFrom<
             | SelectFrom<Extract<Element, AnyObject>, Selection, TsRecurse<Depth>>
             | Exclude<Element, AnyObject>
         )[]
-      : {
-            -readonly [Key in keyof Selection as Selection[Key] extends false
-                ? never
-                : Key extends keyof Full
-                  ? Key
-                  : never]:
-                | (Selection[Key] extends GenericSelectionSet
-                      ? SelectFrom<
-                            NonNullable<Extract<Full[Key], AnyObject>>,
-                            Selection[Key],
-                            TsRecurse<Depth>
-                        >
-                      : Full[Key])
-                | Exclude<Full[Key], AnyObject>;
-        };
+      : MakeKeysOptional<
+            Full,
+            {
+                -readonly [Key in keyof Selection as Selection[Key] extends false
+                    ? never
+                    : Key extends keyof Full
+                      ? Key
+                      : never]:
+                    | (Selection[Key] extends GenericSelectionSet
+                          ? SelectFrom<
+                                NonNullable<Extract<Full[Key], AnyObject>>,
+                                Selection[Key],
+                                TsRecurse<Depth>
+                            >
+                          : Full[Key])
+                    | Exclude<Full[Key], AnyObject>;
+            }
+        >;
 
 /**
  * Defines a selection set for a given object type. This is used in {@link SelectFrom}.

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/core",
-    "version": "31.1.0",
+    "version": "31.1.1",
     "description": "Core augment-vir augments. Use @augment-vir/common instead.",
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {

diff --git a/packages/node/package.json b/packages/node/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/node",
-    "version": "31.1.0",
+    "version": "31.1.1",
     "description": "A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.",
     "keywords": [
         "augment",
@@ -37,16 +37,16 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.1.0",
-        "@augment-vir/common": "^31.1.0",
+        "@augment-vir/assert": "^31.1.1",
+        "@augment-vir/common": "^31.1.1",
         "@date-vir/duration": "^7.0.1",
         "ansi-styles": "^6.2.1",
         "terminate": "^2.8.0",
         "type-fest": "^4.29.0",
         "typed-event-target": "^4.0.2"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.1.0",
+        "@augment-vir/test": "^31.1.1",
         "@prisma/client": "^5.22.0",
         "@types/node": "^22.10.0",
         "@web/dev-server-esbuild": "^1.0.3",

diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/scripts",
-    "version": "31.1.0",
+    "version": "31.1.1",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {
@@ -24,15 +24,15 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.1.0",
-        "@augment-vir/common": "^31.1.0",
-        "@augment-vir/node": "^31.1.0",
+        "@augment-vir/assert": "^31.1.1",
+        "@augment-vir/common": "^31.1.1",
+        "@augment-vir/node": "^31.1.1",
         "@virmator/docs": "^13.10.3",
         "jsdom": "^25.0.1",
         "typedoc": "^0.27.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.1.0",
+        "@augment-vir/test": "^31.1.1",
         "@types/jsdom": "^21.1.7",
         "@types/node": "^22.10.0"
     },
-Original file line number
+Diff line change
@@ Expand Up / @@ -67,7 +67,7 @@ describe('PickSelection', () => { @@
                     >
                 >()
                 .equals<{
-                    top:
+                    top?:
                         | undefined
                         | {
                               mid: {low: string[]};
@@ Expand Down @@