@augment-vir/common 6.2.0 → 6.3.0

package/dist/cjs/augments/nested-keys.d.ts

@@ -0,0 +1,12 @@
+import { UnionToIntersection } from 'type-fest';
+import { ObjectValueType } from './object';
+export type NestedSequentialKeys<ObjectGeneric extends object> = ObjectValueType<{
+    [Prop in keyof ObjectGeneric]: NonNullable<ObjectGeneric[Prop]> extends object ? [Prop, ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>> | [])] : [Prop];
+}>;
+export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>> extends object ? [
+    keyof ObjectGeneric,
+    ...(NestedKeys<UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>>> | [])
+] : [keyof ObjectGeneric];
+export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>> = 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 getValueFromNestedKeys<ObjectGeneric extends object, KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(inputObject: ObjectGeneric, nestedKeys: KeysGeneric): NestedValue<ObjectGeneric, KeysGeneric> | undefined;
+//# sourceMappingURL=nested-keys.d.ts.map

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getValueFromNestedKeys = void 0;
+const error_1 = require("./error");
+const object_1 = require("./object");
+function getValueFromNestedKeys(inputObject, 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 keyToAccess = nestedKeys[0];
+    try {
+        if (!(0, object_1.typedHasProperty)(inputObject, keyToAccess)) {
+            return undefined;
+        }
+        const currentValue = inputObject[keyToAccess];
+        if (nestedKeys.length > 1) {
+            return getValueFromNestedKeys(currentValue, nestedKeys.slice(1));
+        }
+        else {
+            return currentValue;
+        }
+    }
+    catch (error) {
+        console.error({ inputObject, nestedKeys });
+        throw new Error(`Failed to traverse into inputObject using key "${String(keyToAccess)}": ${(0, error_1.extractErrorMessage)(error)}`);
+    }
+}
+exports.getValueFromNestedKeys = getValueFromNestedKeys;

package/dist/cjs/augments/pick-deep.d.ts

@@ -0,0 +1,6 @@
+import { UnionToIntersection } from 'type-fest';
+import { NestedKeys } from './nested-keys';
+export type PickDeep<OriginalObjectGeneric extends object, DeepKeys extends NestedKeys<OriginalObjectGeneric>> = UnionToIntersection<DeepKeys extends [infer CurrentLevelPick, ...infer ExtraKeys] ? CurrentLevelPick extends PropertyKey ? CurrentLevelPick extends keyof OriginalObjectGeneric ? {
+    [CurrentProp in CurrentLevelPick]: OriginalObjectGeneric[CurrentProp] extends object ? ExtraKeys extends NestedKeys<OriginalObjectGeneric[CurrentProp]> ? PickDeep<OriginalObjectGeneric[CurrentProp], ExtraKeys> : {} : OriginalObjectGeneric[CurrentProp];
+} : never : never : DeepKeys extends [infer CurrentLevelPick] ? CurrentLevelPick extends keyof OriginalObjectGeneric ? Pick<OriginalObjectGeneric, CurrentLevelPick> : never : never>;
+//# sourceMappingURL=pick-deep.d.ts.map

package/dist/cjs/augments/pick-deep.js

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

package/dist/cjs/index.d.ts

@@ -7,7 +7,9 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/nested-keys';
 export * from './augments/object';
+export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/tuple';

package/dist/cjs/index.js

@@ -23,7 +23,9 @@ __exportStar(require("./augments/date"), exports);
 __exportStar(require("./augments/environment"), exports);
 __exportStar(require("./augments/error"), exports);
 __exportStar(require("./augments/function"), exports);
+__exportStar(require("./augments/nested-keys"), exports);
 __exportStar(require("./augments/object"), exports);
+__exportStar(require("./augments/pick-deep"), exports);
 __exportStar(require("./augments/promise"), exports);
 __exportStar(require("./augments/regexp"), exports);
 __exportStar(require("./augments/tuple"), exports);

package/dist/esm/augments/nested-keys.d.ts

@@ -0,0 +1,12 @@
+import { UnionToIntersection } from 'type-fest';
+import { ObjectValueType } from './object';
+export type NestedSequentialKeys<ObjectGeneric extends object> = ObjectValueType<{
+    [Prop in keyof ObjectGeneric]: NonNullable<ObjectGeneric[Prop]> extends object ? [Prop, ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>> | [])] : [Prop];
+}>;
+export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>> extends object ? [
+    keyof ObjectGeneric,
+    ...(NestedKeys<UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>>> | [])
+] : [keyof ObjectGeneric];
+export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>> = 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 getValueFromNestedKeys<ObjectGeneric extends object, KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(inputObject: ObjectGeneric, nestedKeys: KeysGeneric): NestedValue<ObjectGeneric, KeysGeneric> | undefined;
+//# sourceMappingURL=nested-keys.d.ts.map

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

@@ -0,0 +1,26 @@
+import { extractErrorMessage } from './error';
+import { typedHasProperty } from './object';
+export function getValueFromNestedKeys(inputObject, 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 keyToAccess = nestedKeys[0];
+    try {
+        if (!typedHasProperty(inputObject, keyToAccess)) {
+            return undefined;
+        }
+        const currentValue = inputObject[keyToAccess];
+        if (nestedKeys.length > 1) {
+            return getValueFromNestedKeys(currentValue, nestedKeys.slice(1));
+        }
+        else {
+            return currentValue;
+        }
+    }
+    catch (error) {
+        console.error({ inputObject, nestedKeys });
+        throw new Error(`Failed to traverse into inputObject using key "${String(keyToAccess)}": ${extractErrorMessage(error)}`);
+    }
+}

package/dist/esm/augments/pick-deep.d.ts

@@ -0,0 +1,6 @@
+import { UnionToIntersection } from 'type-fest';
+import { NestedKeys } from './nested-keys';
+export type PickDeep<OriginalObjectGeneric extends object, DeepKeys extends NestedKeys<OriginalObjectGeneric>> = UnionToIntersection<DeepKeys extends [infer CurrentLevelPick, ...infer ExtraKeys] ? CurrentLevelPick extends PropertyKey ? CurrentLevelPick extends keyof OriginalObjectGeneric ? {
+    [CurrentProp in CurrentLevelPick]: OriginalObjectGeneric[CurrentProp] extends object ? ExtraKeys extends NestedKeys<OriginalObjectGeneric[CurrentProp]> ? PickDeep<OriginalObjectGeneric[CurrentProp], ExtraKeys> : {} : OriginalObjectGeneric[CurrentProp];
+} : never : never : DeepKeys extends [infer CurrentLevelPick] ? CurrentLevelPick extends keyof OriginalObjectGeneric ? Pick<OriginalObjectGeneric, CurrentLevelPick> : never : never>;
+//# sourceMappingURL=pick-deep.d.ts.map

package/dist/esm/augments/pick-deep.js

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

package/dist/esm/index.d.ts

@@ -7,7 +7,9 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/nested-keys';
 export * from './augments/object';
+export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/tuple';

package/dist/esm/index.js

@@ -7,7 +7,9 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/nested-keys';
 export * from './augments/object';
+export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/tuple';

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

@@ -0,0 +1,12 @@
+import { UnionToIntersection } from 'type-fest';
+import { ObjectValueType } from './object';
+export type NestedSequentialKeys<ObjectGeneric extends object> = ObjectValueType<{
+    [Prop in keyof ObjectGeneric]: NonNullable<ObjectGeneric[Prop]> extends object ? [Prop, ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>> | [])] : [Prop];
+}>;
+export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>> extends object ? [
+    keyof ObjectGeneric,
+    ...(NestedKeys<UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>>> | [])
+] : [keyof ObjectGeneric];
+export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>> = 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 getValueFromNestedKeys<ObjectGeneric extends object, KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(inputObject: ObjectGeneric, nestedKeys: KeysGeneric): NestedValue<ObjectGeneric, KeysGeneric> | undefined;
+//# sourceMappingURL=nested-keys.d.ts.map

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

@@ -0,0 +1,6 @@
+import { UnionToIntersection } from 'type-fest';
+import { NestedKeys } from './nested-keys';
+export type PickDeep<OriginalObjectGeneric extends object, DeepKeys extends NestedKeys<OriginalObjectGeneric>> = UnionToIntersection<DeepKeys extends [infer CurrentLevelPick, ...infer ExtraKeys] ? CurrentLevelPick extends PropertyKey ? CurrentLevelPick extends keyof OriginalObjectGeneric ? {
+    [CurrentProp in CurrentLevelPick]: OriginalObjectGeneric[CurrentProp] extends object ? ExtraKeys extends NestedKeys<OriginalObjectGeneric[CurrentProp]> ? PickDeep<OriginalObjectGeneric[CurrentProp], ExtraKeys> : {} : OriginalObjectGeneric[CurrentProp];
+} : never : never : DeepKeys extends [infer CurrentLevelPick] ? CurrentLevelPick extends keyof OriginalObjectGeneric ? Pick<OriginalObjectGeneric, CurrentLevelPick> : never : never>;
+//# sourceMappingURL=pick-deep.d.ts.map

package/dist/types/index.d.ts

@@ -7,7 +7,9 @@ export * from './augments/date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
+export * from './augments/nested-keys';
 export * from './augments/object';
+export * from './augments/pick-deep';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/tuple';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "6.2.0",
+    "version": "6.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -19,10 +19,11 @@
     "types": "dist/types/index.d.ts",
     "scripts": {
         "compile": "tsc --project tsconfig.json && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
-        "test": "echo \"use common-test to run tests\" && exit 0"
+        "test": "echo \"use common-test to run tests\" && exit 0",
+        "test:coverage": "npm test"
     },
     "dependencies": {
-        "type-fest": "^3.4.0"
+        "type-fest": "^3.5.0"
     },
     "devDependencies": {
         "typescript": "^4.9.4"