@augment-vir/common 28.1.0 → 28.2.0

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

@@ -4,6 +4,7 @@ exports.getValueFromNestedKeys = exports.setValueWithNestedKeys = void 0;
 const run_time_assertions_1 = require("run-time-assertions");
 const object_1 = require("./object");
 const typed_has_property_1 = require("./typed-has-property");
+/** This mutates the {@link originalObject} input. */
 function setValueWithNestedKeys(originalObject, nestedKeys, value) {
     /**
      * Lots of as any casts in here because these types are, under the hood, pretty complex. Since

package/dist/cjs/augments/promise/wait.js

@@ -22,7 +22,7 @@ exports.defaultWaitUntilDefinedOptions = {
         milliseconds: 100,
     },
     timeout: {
-        milliseconds: 10000,
+        milliseconds: 10_000,
     },
 };
 /**

package/dist/cjs/augments/type-recursion.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/index.js

@@ -55,4 +55,5 @@ __exportStar(require("./augments/time"), exports);
 __exportStar(require("./augments/truncate-number"), exports);
 __exportStar(require("./augments/tuple"), exports);
 __exportStar(require("./augments/type"), exports);
+__exportStar(require("./augments/type-recursion"), exports);
 __exportStar(require("./augments/wrap-in-try"), exports);

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

@@ -1,6 +1,7 @@
 import { isRunTimeType } from 'run-time-assertions';
 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

package/dist/esm/augments/promise/wait.js

@@ -17,7 +17,7 @@ export const defaultWaitUntilDefinedOptions = {
         milliseconds: 100,
     },
     timeout: {
-        milliseconds: 10000,
+        milliseconds: 10_000,
     },
 };
 /**

package/dist/esm/augments/type-recursion.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.js

@@ -39,4 +39,5 @@ export * from './augments/time';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';
+export * from './augments/type-recursion';
 export * from './augments/wrap-in-try';

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

@@ -1,16 +1,18 @@
 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> = NonNullable<ObjectGeneric> extends ReadonlyArray<any> ? Extract<NonNullable<ObjectGeneric>[number], object> extends never ? [number] : NestedSequentialKeys<Extract<NonNullable<ObjectGeneric>[number], object>> : PropertyValueType<{
+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]>> | [])
+        ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>, TsRecurse<Depth>> | [])
     ]> : Readonly<[Prop]>;
 }>;
-export type NestedKeys<ObjectGeneric extends object> = ObjectGeneric extends ReadonlyArray<any> ? NestedKeys<ArrayElement<ObjectGeneric>> : UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>> extends object ? [
+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>>> | [])
+    ...(NestedKeys<UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>>, TsRecurse<Depth>> | [])
 ] : [keyof ObjectGeneric];
 export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>> = ObjectGeneric extends ReadonlyArray<any> ? NestedValue<Extract<ObjectGeneric[number], object>, NestedKeysGeneric>[] : 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> : never : never : never : never;
-export declare function setValueWithNestedKeys<const ObjectGeneric extends object, const KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(originalObject: ObjectGeneric, nestedKeys: KeysGeneric, value: NestedValue<ObjectGeneric, KeysGeneric>): void;
+/** 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>;

package/dist/types/augments/object/pick-deep.d.ts

@@ -1,19 +1,20 @@
 import { OptionalKeysOf, RequiredKeysOf } from 'type-fest';
 import { AnyFunction } from '../function';
 import { ArrayElement } from '../type';
+import { TsRecurse, TsRecursionStart, TsRecursionTracker } from '../type-recursion';
 import { AnyObject } from './any-object';
 import { NestedKeys } from './nested-keys';
-export type InnerPickDeep<OriginalObject extends AnyObject, DeepKeys extends any[]> = DeepKeys extends [infer CurrentLevelPick, ...infer RemainingKeys] ? Extract<CurrentLevelPick, keyof OriginalObject> extends never ? OriginalObject : {
-    [CurrentProp in Extract<CurrentLevelPick, RequiredKeysOf<OriginalObject>>]: InnerPickDeepValue<OriginalObject, CurrentProp, RemainingKeys>;
+export type InnerPickDeep<OriginalObject extends AnyObject, DeepKeys extends any[], Depth extends TsRecursionTracker> = DeepKeys extends [infer CurrentLevelPick, ...infer RemainingKeys] ? Extract<CurrentLevelPick, keyof OriginalObject> extends never ? OriginalObject : {
+    [CurrentProp in Extract<CurrentLevelPick, RequiredKeysOf<OriginalObject>>]: InnerPickDeepValue<OriginalObject, CurrentProp, RemainingKeys, Depth>;
 } & {
-    [CurrentProp in Extract<CurrentLevelPick, OptionalKeysOf<OriginalObject>>]?: InnerPickDeepValue<OriginalObject, CurrentProp, RemainingKeys>;
+    [CurrentProp in Extract<CurrentLevelPick, OptionalKeysOf<OriginalObject>>]?: InnerPickDeepValue<OriginalObject, CurrentProp, RemainingKeys, Depth>;
 } : DeepKeys extends [] ? OriginalObject : DeepKeys extends [infer CurrentLevelPick] ? CurrentLevelPick extends keyof OriginalObject ? Pick<OriginalObject, CurrentLevelPick> : never : never;
-type InnerPickDeepValue<OriginalObject, CurrentProp extends keyof OriginalObject, RemainingKeys extends any[]> = AnyFunction extends Extract<OriginalObject[CurrentProp], AnyFunction> ? OriginalObject[CurrentProp] | Exclude<OriginalObject[CurrentProp], AnyFunction> : Array<any> extends Extract<OriginalObject[CurrentProp], Array<any>> ? Array<InnerPickDeep<ArrayElement<Extract<OriginalObject[CurrentProp], Array<any>>>, RemainingKeys>> | Exclude<OriginalObject[CurrentProp], Array<any>> : ReadonlyArray<any> extends Extract<OriginalObject[CurrentProp], ReadonlyArray<any>> ? ReadonlyArray<InnerPickDeep<ArrayElement<Extract<OriginalObject[CurrentProp], ReadonlyArray<any>>>, RemainingKeys>> | Exclude<OriginalObject[CurrentProp], ReadonlyArray<any>> : Extract<OriginalObject[CurrentProp], Record<any, any>> extends never ? OriginalObject[CurrentProp] : InnerPickDeep<Extract<OriginalObject[CurrentProp], Record<any, any>>, RemainingKeys> | Exclude<OriginalObject[CurrentProp], Record<any, any>>;
+type InnerPickDeepValue<OriginalObject, CurrentProp extends keyof OriginalObject, RemainingKeys extends any[], Depth extends TsRecursionTracker> = AnyFunction extends Extract<OriginalObject[CurrentProp], AnyFunction> ? OriginalObject[CurrentProp] | Exclude<OriginalObject[CurrentProp], AnyFunction> : Array<any> extends Extract<OriginalObject[CurrentProp], Array<any>> ? Array<InnerPickDeep<ArrayElement<Extract<OriginalObject[CurrentProp], Array<any>>>, RemainingKeys, TsRecurse<Depth>>> | Exclude<OriginalObject[CurrentProp], Array<any>> : ReadonlyArray<any> extends Extract<OriginalObject[CurrentProp], ReadonlyArray<any>> ? ReadonlyArray<InnerPickDeep<ArrayElement<Extract<OriginalObject[CurrentProp], ReadonlyArray<any>>>, RemainingKeys, TsRecurse<Depth>>> | Exclude<OriginalObject[CurrentProp], ReadonlyArray<any>> : Extract<OriginalObject[CurrentProp], Record<any, any>> extends never ? OriginalObject[CurrentProp] : InnerPickDeep<Extract<OriginalObject[CurrentProp], Record<any, any>>, RemainingKeys, TsRecurse<Depth>> | Exclude<OriginalObject[CurrentProp], Record<any, any>>;
 /**
  * Pick nested keys with more strict type parameter requirements. However, these stricter type
  * parameter requirements often lead to "excessively deep" TS compiler errors.
  */
-export type PickDeepStrict<OriginalObject extends object, DeepKeys extends NestedKeys<OriginalObject>> = InnerPickDeep<OriginalObject, DeepKeys>;
+export type PickDeepStrict<OriginalObject extends object, DeepKeys extends NestedKeys<OriginalObject>> = InnerPickDeep<OriginalObject, DeepKeys, TsRecursionStart>;
 /** Pick nested keys. */
-export type PickDeep<OriginalObject extends object, DeepKeys extends PropertyKey[]> = InnerPickDeep<OriginalObject, DeepKeys>;
+export type PickDeep<OriginalObject extends object, DeepKeys extends PropertyKey[]> = InnerPickDeep<OriginalObject, DeepKeys, TsRecursionStart>;
 export {};

package/dist/types/augments/type-recursion.d.ts

@@ -0,0 +1,161 @@
+type TsRecursionArray = [
+    1,
+    2,
+    3,
+    4,
+    5,
+    6,
+    7,
+    8,
+    9,
+    10,
+    11,
+    12,
+    13,
+    14,
+    15,
+    16,
+    17,
+    18,
+    19,
+    20,
+    21,
+    22,
+    23,
+    24,
+    25,
+    26,
+    27,
+    28,
+    29,
+    30,
+    31,
+    32,
+    33,
+    34,
+    35,
+    36,
+    37,
+    38,
+    39,
+    40,
+    41,
+    42,
+    43,
+    44,
+    45,
+    46,
+    47,
+    48,
+    49,
+    50,
+    51,
+    52,
+    53,
+    54,
+    55,
+    56,
+    57,
+    58,
+    59,
+    60,
+    61,
+    62,
+    63,
+    64,
+    65,
+    66,
+    67,
+    68,
+    69,
+    70,
+    71,
+    72,
+    73,
+    74,
+    75,
+    76,
+    77,
+    78,
+    79,
+    80,
+    81,
+    82,
+    83,
+    84,
+    85,
+    86,
+    87,
+    88,
+    89,
+    90,
+    91,
+    92,
+    93,
+    94,
+    95,
+    96,
+    97,
+    98,
+    99,
+    100,
+    101,
+    102,
+    103,
+    104,
+    105,
+    106,
+    107,
+    108,
+    109,
+    110,
+    111,
+    112,
+    113,
+    114,
+    115,
+    116,
+    117,
+    118,
+    119,
+    120,
+    121,
+    122,
+    123,
+    124,
+    125,
+    126,
+    127,
+    128,
+    129,
+    130,
+    131,
+    132,
+    133,
+    134,
+    135,
+    136,
+    137,
+    138,
+    139,
+    140,
+    141,
+    142,
+    143,
+    144,
+    145,
+    146,
+    147,
+    148,
+    149,
+    150
+];
+export type TsRecursionTracker = keyof TsRecursionArray;
+/**
+ * Through experimentation on Typescript version 5.4.5, this is the maximum recursion depth we can
+ * go to before TypeScript will block recursive types.
+ */
+export type TsTooMuchRecursion = 91;
+export type TsRecursionStart = 0;
+export type TsRecurse<CurrentRecursion extends TsRecursionTracker> = TsRecursionArray[CurrentRecursion] extends TsRecursionTracker ? TsRecursionArray[CurrentRecursion] : TsTooMuchRecursion;
+export {};

package/dist/types/index.d.ts

@@ -39,4 +39,5 @@ export * from './augments/time';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';
+export * from './augments/type-recursion';
 export * from './augments/wrap-in-try';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "28.1.0",
+    "version": "28.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,12 +24,12 @@
         "test:types": "tsc --noEmit"
     },
     "dependencies": {
-        "browser-or-node": "^2.1.1",
-        "run-time-assertions": "^1.0.0",
-        "type-fest": "^4.12.0"
+        "browser-or-node": "^3.0.0",
+        "run-time-assertions": "^1.5.1",
+        "type-fest": "^4.20.1"
     },
     "devDependencies": {
-        "typescript": "5.3.3"
+        "typescript": "5.4.5"
     },
     "publishConfig": {
         "access": "public"