ConditionalPickDeep: Supports interface (#776)

sindresorhus · Dec 4, 2023 · ebb7a59 · ebb7a59
1 parent 61a5325
commit ebb7a59
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 2 deletions.
diff --git a/source/conditional-pick-deep.d.ts b/source/conditional-pick-deep.d.ts
@@ -3,6 +3,7 @@ import type {ConditionalExcept} from './conditional-except';
 import type {ConditionalSimplifyDeep} from './conditional-simplify';
 import type {UnknownRecord} from './unknown-record';
 import type {EmptyObject} from './empty-object';
+import type {IsPlainObject} from './internal';
 
 /**
 Used to mark properties that should be excluded.
@@ -97,7 +98,7 @@ export type ConditionalPickDeep<
 > = ConditionalSimplifyDeep<ConditionalExcept<{
 	[Key in keyof Type]: AssertCondition<Type[Key], Condition, Options> extends true
 		? Type[Key]
-		: Type[Key] extends UnknownRecord
+		: IsPlainObject<Type[Key]> extends true
 			? ConditionalPickDeep<Type[Key], Condition, Options>
 			: typeof conditionalPickDeepSymbol;
 }, (typeof conditionalPickDeepSymbol | undefined) | EmptyObject>, never, UnknownRecord>;
diff --git a/source/internal.d.ts b/source/internal.d.ts
@@ -3,6 +3,7 @@ import type {Simplify} from './simplify';
 import type {Trim} from './trim';
 import type {IsAny} from './is-any';
 import type {UnknownRecord} from './unknown-record';
+import type {UnknownArray} from './unknown-array';
 
 // TODO: Remove for v5.
 export type {UnknownRecord} from './unknown-record';
@@ -76,6 +77,16 @@ Matches non-recursive types.
 */
 export type NonRecursiveType = BuiltIns | Function | (new (...args: any[]) => unknown);
 
+/**
+Returns a boolean for whether the given type is a plain key-value object.
+*/
+export type IsPlainObject<T> =
+	T extends NonRecursiveType | UnknownArray | ReadonlyMap<unknown, unknown> | ReadonlySet<unknown>
+		? false
+		: T extends object
+			? true
+			: false;
+
 export type UpperCaseCharacters = 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z';
 
 export type StringDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';

diff --git a/test-d/conditional-pick-deep.ts b/test-d/conditional-pick-deep.ts
@@ -5,15 +5,22 @@ declare class ClassA {
 	public a: string;
 }
 
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+interface InterfaceA {
+	a: number;
+}
+
 type Example = {
 	optional?: boolean;
 	literal: 'foo';
 	string: string;
 	map: Map<string, string>;
 	set: Set<string>;
 	date: Date;
+	number: 1;
 	array: string[];
 	tuples: ['foo', 'bar'];
+	interface: InterfaceA;
 	instanceA: ClassA;
 	ClassA: typeof ClassA;
 	function: (...args: string[]) => string;
@@ -31,6 +38,9 @@ declare const stringPick: ConditionalPickDeep<Example, string>;
 expectType<{
 	literal: 'foo';
 	string: string;
+	instanceA: {
+		a: string;
+	};
 	object: {
 		string: string;
 		subObject: {
@@ -42,6 +52,9 @@ expectType<{
 declare const stringEqualityPick: ConditionalPickDeep<Example, string, {condition: 'equality'}>;
 expectType<{
 	string: string;
+	instanceA: {
+		a: string;
+	};
 	object: {
 		string: string;
 		subObject: {
@@ -54,6 +67,9 @@ declare const stringPickOptional: ConditionalPickDeep<Example, string | undefine
 expectType<{
 	literal: 'foo';
 	string: string;
+	instanceA: {
+		a: string;
+	};
 	object: {
 		string: string;
 		subObject: {
@@ -70,13 +86,19 @@ declare const booleanPick: ConditionalPickDeep<Example, boolean | undefined>;
 expectType<{optional?: boolean | undefined}>(booleanPick);
 
 declare const numberPick: ConditionalPickDeep<Example, number>;
-expectType<{}>(numberPick);
+expectType<{number: 1; interface: {a: number}}>(numberPick);
+
+declare const emptyPick: ConditionalPickDeep<Example, 'abcdefg'>;
+expectType<{}>(emptyPick);
 
 declare const stringOrBooleanPick: ConditionalPickDeep<Example, string | boolean>;
 expectType<{
 	literal: 'foo';
 	string: string;
 	stringOrBoolean: string | boolean;
+	instanceA: {
+		a: string;
+	};
 	object: {
 		string: string;
 		subObject: {
@@ -111,3 +133,6 @@ expectType<{map: Map<string, string>}>(mapPick);
 
 declare const setPick: ConditionalPickDeep<Example, Set<string>>;
 expectType<{set: Set<string>}>(setPick);
+
+declare const interfaceTest: ConditionalPickDeep<Example, InterfaceA>;
+expectType<{interface: InterfaceA}>(interfaceTest);