feat: Add SetRequiredDeep type

sindresorhus · Nov 28, 2024 · d76a9ca · d76a9ca
1 parent 43f59e0
commit d76a9ca
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 79 deletions.
diff --git a/source/set-required-deep.d.ts b/source/set-required-deep.d.ts
@@ -1,6 +1,6 @@
-import type { NonRecursiveType } from "./internal";
-import type { Paths } from "./paths";
-import type { SimplifyDeep } from "./simplify-deep";
+import type {NonRecursiveType} from './internal';
+import type {Paths} from './paths';
+import type {SimplifyDeep} from './simplify-deep';
 
 /**
 Create a type that makes the given keys required. You can specify deeply nested key paths. The remaining keys are kept as is.
@@ -37,37 +37,36 @@ export type SetRequiredDeep<
 > = BaseType extends NonRecursiveType
 	? never
 	: SimplifyDeep<
-			BaseType extends Array<infer _>
-				? Array<
-						SetRequiredDeep<
-							NonNullable<BaseType[number]>,
-							KeyPaths extends `${number}.${infer Rest extends Paths<NonNullable<BaseType[number]>>}`
-								? Rest
-								: never
-						>
-					>
-				: Omit<BaseType, RootRequiredKeys<BaseType, KeyPaths>> &
-						Required<
-							Pick<
-								BaseType,
-								Extract<KeyPaths, RootRequiredKeys<BaseType, KeyPaths>>
-							>
-						> &
-						Partial<{
-							[K in RootRequiredKeys<
-								BaseType,
-								Exclude<KeyPaths, RootRequiredKeys<BaseType, KeyPaths>>
-							>]: SetRequiredDeep<
-								NonNullable<BaseType[K]>,
-								KeyPaths extends `${K}.${infer Rest extends Paths<NonNullable<BaseType[K]>>}`
-									? Rest
-									: never
-							>;
-						}>
-		>;
+	BaseType extends Array<infer _>
+		? Array<
+		SetRequiredDeep<
+		NonNullable<BaseType[number]>,
+		KeyPaths extends `${number}.${infer Rest extends Paths<NonNullable<BaseType[number]>>}`
+			? Rest
+			: never
+		>
+		>
+		: Omit<BaseType, RootRequiredKeys<BaseType, KeyPaths>> &
+		Required<
+		Pick<
+		BaseType,
+		Extract<KeyPaths, RootRequiredKeys<BaseType, KeyPaths>>
+		>
+		> & Partial<{
+			[K in RootRequiredKeys<
+			BaseType,
+			Exclude<KeyPaths, RootRequiredKeys<BaseType, KeyPaths>>
+			>]: SetRequiredDeep<
+			NonNullable<BaseType[K]>,
+			KeyPaths extends `${K}.${infer Rest extends Paths<NonNullable<BaseType[K]>>}`
+				? Rest
+				: never
+			>;
+		}>
+	>;
 
 // Extract the BaseType root keys from the KeyPaths
 type RootRequiredKeys<BaseType, KeyPaths extends Paths<BaseType>> = Extract<
-	keyof BaseType,
-	KeyPaths extends `${infer Root}.${string}` ? Root : KeyPaths
+keyof BaseType,
+KeyPaths extends `${infer Root}.${string}` ? Root : KeyPaths
 >;
diff --git a/test-d/set-required-deep.ts b/test-d/set-required-deep.ts
@@ -1,64 +1,38 @@
-import { expectType } from "tsd";
-import type { SetRequiredDeep } from "../index";
+import {expectType} from 'tsd';
+import type {SetRequiredDeep} from '../index';
 
 // Set nested key to required
-declare const variation1: SetRequiredDeep<
-	{ a?: number; b?: { c?: string } },
-	"b.c"
->;
-expectType<{ a?: number; b?: { c: string } }>(variation1);
+declare const variation1: SetRequiredDeep<{a?: number; b?: {c?: string}}, 'b.c'>;
+expectType<{a?: number; b?: {c: string}}>(variation1);
 
 // Set key to required but not nested keys if not specified
-declare const variation2: SetRequiredDeep<
-	{ a?: number; b?: { c?: string } },
-	"b"
->;
-expectType<{ a?: number; b: { c?: string } }>(variation2);
+declare const variation2: SetRequiredDeep<{a?: number; b?: {c?: string}}, 'b'>;
+expectType<{a?: number; b: {c?: string}}>(variation2);
 
 // Set root key to required
-declare const variation3: SetRequiredDeep<
-	{ a?: number; b?: { c?: string } },
-	"a"
->;
-expectType<{ a: number; b?: { c?: string } }>(variation3);
+declare const variation3: SetRequiredDeep<{a?: number; b?: {c?: string}}, 'a'>;
+expectType<{a: number; b?: {c?: string}}>(variation3);
 
 // Keeps required key as required
-declare const variation4: SetRequiredDeep<
-	{ a: number; b?: { c?: string } },
-	"a"
->;
-expectType<{ a: number; b?: { c?: string } }>(variation4);
+declare const variation4: SetRequiredDeep<{a: number; b?: {c?: string}}, 'a'>;
+expectType<{a: number; b?: {c?: string}}>(variation4);
 
 // Set key to required in a union.
-declare const variation5: SetRequiredDeep<
-	{ a?: "1"; b?: { c?: boolean } } | { a?: "2"; b?: { c?: boolean } },
-	"a"
->;
-expectType<{ a: "1"; b?: { c?: boolean } } | { a: "2"; b?: { c?: boolean } }>(
-	variation5,
-);
+declare const variation5: SetRequiredDeep<{a?: '1'; b?: {c?: boolean}} | {a?: '2'; b?: {c?: boolean}}, 'a'>;
+expectType<{a: '1'; b?: {c?: boolean}} | {a: '2'; b?: {c?: boolean}}>(variation5);
 
 // Set array key to required
-declare const variation6: SetRequiredDeep<{ a?: Array<{ b?: number }> }, "a">;
-expectType<{ a: Array<{ b?: number }> }>(variation6);
+declare const variation6: SetRequiredDeep<{a?: Array<{b?: number}>}, 'a'>;
+expectType<{a: Array<{b?: number}>}>(variation6);
 
 // Set key inside array to required
-declare const variation7: SetRequiredDeep<
-	{ a?: Array<{ b?: number }> },
-	`a.${number}.b`
->;
-expectType<{ a?: Array<{ b: number }> }>(variation7);
+declare const variation7: SetRequiredDeep<{a?: Array<{b?: number}>}, `a.${number}.b`>;
+expectType<{a?: Array<{b: number}>}>(variation7);
 
 // Set only specified keys inside array to required
-declare const variation8: SetRequiredDeep<
-	{ a?: Array<{ b?: number; c?: string }> },
-	`a.${number}.b`
->;
-expectType<{ a?: Array<{ b: number; c?: string }> }>(variation8);
+declare const variation8: SetRequiredDeep<{a?: Array<{b?: number; c?: string}>}, `a.${number}.b`>;
+expectType<{a?: Array<{b: number; c?: string}>}>(variation8);
 
 // Can set both root and nested keys to required
-declare const variation9: SetRequiredDeep<
-	{ a?: number; b?: { c?: string } },
-	"b" | "b.c"
->;
-expectType<{ a?: number; b: { c: string } }>(variation9);
+declare const variation9: SetRequiredDeep<{a?: number; b?: {c?: string}}, 'b' | 'b.c'>;
+expectType<{a?: number; b: {c: string}}>(variation9);