fix: set-* types with index signatures

sindresorhus · Dec 19, 2024 · ab827f9 · ab827f9
1 parent 669ade8
commit ab827f9
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 3 deletions.
diff --git a/source/set-optional.d.ts b/source/set-optional.d.ts
@@ -1,4 +1,6 @@
+import type {DistributedPick} from './distributed-pick';
 import type {Except} from './except';
+import type {KeysOfUnion} from './keys-of-union';
 import type {Simplify} from './simplify';
 
 /**
@@ -32,6 +34,6 @@ export type SetOptional<BaseType, Keys extends keyof BaseType> =
 		// Pick just the keys that are readonly from the base type.
 		Except<BaseType, Keys> &
 		// Pick the keys that should be mutable from the base type and make them mutable.
-		Partial<Except<BaseType, Exclude<keyof BaseType, Keys>>>
+		Partial<DistributedPick<BaseType, Keys & KeysOfUnion<BaseType>>>
 		>
 		: never;
diff --git a/source/set-readonly.d.ts b/source/set-readonly.d.ts
@@ -1,4 +1,6 @@
+import type {DistributedPick} from './distributed-pick';
 import type {Except} from './except';
+import type {KeysOfUnion} from './keys-of-union';
 import type {Simplify} from './simplify';
 
 /**
@@ -33,6 +35,6 @@ export type SetReadonly<BaseType, Keys extends keyof BaseType> =
 	BaseType extends unknown
 		? Simplify<
 		Except<BaseType, Keys> &
-		Readonly<Except<BaseType, Exclude<keyof BaseType, Keys>>>
+		Readonly<DistributedPick<BaseType, Keys & KeysOfUnion<BaseType>>>
 		>
 		: never;
diff --git a/source/set-required.d.ts b/source/set-required.d.ts
@@ -1,4 +1,6 @@
+import type {DistributedPick} from './distributed-pick';
 import type {Except} from './except';
+import type {KeysOfUnion} from './keys-of-union';
 import type {Simplify} from './simplify';
 
 /**
@@ -35,6 +37,6 @@ export type SetRequired<BaseType, Keys extends keyof BaseType> =
 		// Pick just the keys that are optional from the base type.
 		Except<BaseType, Keys> &
 		// Pick the keys that should be required from the base type and make them required.
-		Required<Except<BaseType, Exclude<keyof BaseType, Keys>>>
+		Required<DistributedPick<BaseType, Keys & KeysOfUnion<BaseType>>>
 		>
 		: never;
diff --git a/test-d/set-optional.ts b/test-d/set-optional.ts
@@ -32,3 +32,7 @@ expectType<{readonly a?: number; b?: string; c?: boolean}>(variation7);
 // Does nothing, if `Keys` is `never`.
 declare const variation8: SetOptional<{a?: number; readonly b?: string; readonly c: boolean}, never>;
 expectType<{a?: number; readonly b?: string; readonly c: boolean}>(variation8);
+
+// Works with index signatures
+declare const variation9: SetOptional<{[x: string]: number; 'a': 1; 'b'?: 2}, 'a' | 'b'>;
+expectType<{[x: string]: number; a?: 1; b?: 2}>(variation9);
diff --git a/test-d/set-readonly.ts b/test-d/set-readonly.ts
@@ -32,3 +32,7 @@ expectType<{readonly a?: number; readonly b: string; readonly c: boolean}>(varia
 // Does nothing, if `Keys` is `never`.
 declare const variation8: SetReadonly<{a: number; readonly b: string; readonly c: boolean}, never>;
 expectType<{a: number; readonly b: string; readonly c: boolean}>(variation8);
+
+// Works with index signatures
+declare const variation9: SetReadonly<{[x: string]: number; 'a': 1; readonly 'b': 2}, 'a' | 'b'>;
+expectType<{[x: string]: number; readonly a: 1; readonly b: 2}>(variation9);
diff --git a/test-d/set-required.ts b/test-d/set-required.ts
@@ -36,3 +36,7 @@ expectType<{readonly a: number; b: string; c: boolean}>(variation8);
 // Does nothing, if `Keys` is `never`.
 declare const variation9: SetRequired<{a?: number; readonly b?: string; readonly c: boolean}, never>;
 expectType<{a?: number; readonly b?: string; readonly c: boolean}>(variation9);
+
+// Works with index signatures
+declare const variation10: SetRequired<{[x: string]: number; 'a': 1; 'b'?: 2}, 'a' | 'b'>;
+expectType<{[x: string]: number; a: 1; b: 2}>(variation10);