@depup/type-fest 5.4.4-depup.0

package/source/writable-deep.d.ts

@@ -0,0 +1,84 @@
+import type {BuiltIns, HasMultipleCallSignatures} from './internal/index.d.ts';
+
+/**
+Create a deeply mutable version of an `object`/`ReadonlyMap`/`ReadonlySet`/`ReadonlyArray` type. The inverse of `ReadonlyDeep<T>`. Use `Writable<T>` if you only need one level deep.
+
+This can be used to [store and mutate options within a class](https://github.com/sindresorhus/pageres/blob/4a5d05fca19a5fbd2f53842cbf3eb7b1b63bddd2/source/index.ts#L72), [edit `readonly` objects within tests](https://stackoverflow.com/questions/50703834), [construct a `readonly` object within a function](https://github.com/Microsoft/TypeScript/issues/24509), or to define a single model where the only thing that changes is whether or not some of the keys are writable.
+
+@example
+```
+import type {WritableDeep} from 'type-fest';
+
+type Foo = {
+	readonly a: number;
+	readonly b: readonly string[]; // To show that mutability is deeply affected.
+	readonly c: boolean;
+};
+
+const writableDeepFoo: WritableDeep<Foo> = {a: 1, b: ['2'], c: true};
+writableDeepFoo.a = 3;
+writableDeepFoo.b[0] = 'new value';
+writableDeepFoo.b = ['something'];
+```
+
+Note that types containing overloaded functions are not made deeply writable due to a [TypeScript limitation](https://github.com/microsoft/TypeScript/issues/29732).
+
+@see {@link Writable}
+@category Object
+@category Array
+@category Set
+@category Map
+*/
+export type WritableDeep<T> = T extends BuiltIns
+	? T
+	: T extends (...arguments_: any[]) => unknown
+		? {} extends _WritableObjectDeep<T>
+			? T
+			: HasMultipleCallSignatures<T> extends true
+				? T
+				: ((...arguments_: Parameters<T>) => ReturnType<T>) & _WritableObjectDeep<T>
+		: T extends ReadonlyMap<unknown, unknown>
+			? WritableMapDeep<T>
+			: T extends ReadonlySet<unknown>
+				? WritableSetDeep<T>
+				: T extends readonly unknown[]
+					? WritableArrayDeep<T>
+					: T extends object
+						? _WritableObjectDeep<T>
+						: unknown;
+
+/**
+Same as `WritableDeep`, but accepts only `Map`s as inputs. Internal helper for `WritableDeep`.
+*/
+type WritableMapDeep<MapType extends ReadonlyMap<unknown, unknown>> =
+	MapType extends ReadonlyMap<infer KeyType, infer ValueType>
+		? Map<WritableDeep<KeyType>, WritableDeep<ValueType>>
+		: MapType; // Should not heppen
+
+/**
+Same as `WritableDeep`, but accepts only `Set`s as inputs. Internal helper for `WritableDeep`.
+*/
+type WritableSetDeep<SetType extends ReadonlySet<unknown>> =
+	SetType extends ReadonlySet<infer ItemType>
+		? Set<WritableDeep<ItemType>>
+		: SetType; // Should not heppen
+
+/**
+Same as `WritableDeep`, but accepts only `object`s as inputs. Internal helper for `WritableDeep`.
+*/
+export type _WritableObjectDeep<ObjectType extends object> = {
+	-readonly [KeyType in keyof ObjectType]: WritableDeep<ObjectType[KeyType]>
+};
+
+/**
+Same as `WritableDeep`, but accepts only `Array`s as inputs. Internal helper for `WritableDeep`.
+*/
+type WritableArrayDeep<ArrayType extends readonly unknown[]> =
+	ArrayType extends readonly [] ? []
+		: ArrayType extends readonly [...infer U, infer V] ? [...WritableArrayDeep<U>, WritableDeep<V>]
+			: ArrayType extends readonly [infer U, ...infer V] ? [WritableDeep<U>, ...WritableArrayDeep<V>]
+				: ArrayType extends ReadonlyArray<infer U> ? Array<WritableDeep<U>>
+					: ArrayType extends Array<infer U> ? Array<WritableDeep<U>>
+						: ArrayType;
+
+export {};

package/source/writable-keys-of.d.ts

@@ -0,0 +1,34 @@
+import type {ReadonlyKeysOf} from './readonly-keys-of.d.ts';
+
+/**
+Extract all writable keys from the given type.
+
+This is useful when you want to create a new type that contains writable keys only.
+
+@example
+```
+import type {WritableKeysOf} from 'type-fest';
+
+type User = {
+	name: string;
+	surname: string;
+
+	readonly id: number;
+};
+
+type UpdateRequest<Entity extends object> = Pick<Entity, WritableKeysOf<Entity>>;
+
+const update1: UpdateRequest<User> = {
+	name: 'Alice',
+	surname: 'Acme',
+};
+```
+
+@category Utilities
+*/
+export type WritableKeysOf<Type extends object> =
+	Type extends unknown // For distributing `Type`
+		? Exclude<keyof Type, ReadonlyKeysOf<Type>>
+		: never; // Should never happen
+
+export {};

package/source/writable.d.ts

@@ -0,0 +1,72 @@
+import type {Except} from './except.d.ts';
+import type {Simplify} from './simplify.d.ts';
+
+/**
+Create a writable version of the given array type.
+*/
+type WritableArray<ArrayType extends readonly unknown[]> =
+	ArrayType extends readonly [] ? []
+		: ArrayType extends readonly [...infer U, infer V] ? [...U, V]
+			: ArrayType extends readonly [infer U, ...infer V] ? [U, ...V]
+				: ArrayType extends ReadonlyArray<infer U> ? U[]
+					: ArrayType;
+
+/**
+Create a type that strips `readonly` from the given type. Inverse of `Readonly<T>`.
+
+The 2nd argument will be ignored if the input type is not an object.
+
+Note: This type can make readonly `Set` and `Map` writable. This behavior is different from `Readonly<T>` (as of TypeScript 5.2.2). See: https://github.com/microsoft/TypeScript/issues/29655
+
+This can be used to [store and mutate options within a class](https://github.com/sindresorhus/pageres/blob/4a5d05fca19a5fbd2f53842cbf3eb7b1b63bddd2/source/index.ts#L72), [edit `readonly` objects within tests](https://stackoverflow.com/questions/50703834), [construct a `readonly` object within a function](https://github.com/Microsoft/TypeScript/issues/24509), or to define a single model where the only thing that changes is whether or not some of the keys are writable.
+
+@example
+```
+import type {Writable} from 'type-fest';
+
+type Foo = {
+	readonly a: number;
+	readonly b: readonly string[]; // To show that only the mutability status of the properties, not their values, are affected.
+	readonly c: boolean;
+};
+
+const writableFoo: Writable<Foo> = {a: 1, b: ['2'], c: true};
+writableFoo.a = 3;
+// @ts-expect-error
+writableFoo.b[0] = 'new value'; // Will still fail as the value of property "b" is still a readonly type.
+writableFoo.b = ['something']; // Will work as the "b" property itself is no longer readonly.
+
+type SomeWritable = Writable<Foo, 'b' | 'c'>;
+// type SomeWritable = {
+// 	readonly a: number;
+// 	b: readonly string[]; // It's now writable. The type of the property remains unaffected.
+// 	c: boolean; // It's now writable.
+// }
+
+// Also supports array
+const readonlyArray: readonly number[] = [1, 2, 3];
+// @ts-expect-error
+readonlyArray.push(4); // Will fail as the array itself is readonly.
+const writableArray: Writable<typeof readonlyArray> = readonlyArray as Writable<typeof readonlyArray>;
+writableArray.push(4); // Will work as the array itself is now writable.
+```
+
+@category Object
+*/
+export type Writable<BaseType, Keys extends keyof BaseType = keyof BaseType> =
+BaseType extends ReadonlyMap<infer KeyType, infer ValueType>
+	? Map<KeyType, ValueType>
+	: BaseType extends ReadonlySet<infer ItemType>
+		? Set<ItemType>
+		: BaseType extends readonly unknown[]
+			// Handle array
+			? WritableArray<BaseType>
+			// Handle object
+			: Simplify<
+			// Pick just the keys that are not writable from the base type.
+				Except<BaseType, Keys> &
+			// Pick the keys that should be writable from the base type and make them writable by removing the `readonly` modifier from the key.
+				{-readonly [KeyType in keyof Pick<BaseType, Keys>]: Pick<BaseType, Keys>[KeyType]}
+			>;
+
+export {};

package/source/xor.d.ts

@@ -0,0 +1,83 @@
+import type {Not} from './internal/type.d.ts';
+import type {And} from './and.d.ts';
+import type {Or} from './or.d.ts';
+
+/**
+Returns a boolean for whether only one of two given types is true.
+
+Use-case: Constructing complex conditional types where one single condition must be satisfied.
+
+@example
+```
+import type {Xor} from 'type-fest';
+
+type TT = Xor<true, true>;
+//=> false
+
+type TF = Xor<true, false>;
+//=> true
+
+type FT = Xor<false, true>;
+//=> true
+
+type FF = Xor<false, false>;
+//=> false
+```
+
+Note: When `boolean` is passed as an argument, it is distributed into separate cases, and the final result is a union of those cases.
+For example, `Xor<false, boolean>` expands to `Xor<false, true> | Xor<false, false>`, which simplifies to `true | false` (i.e., `boolean`).
+
+@example
+```
+import type {Xor} from 'type-fest';
+
+type A = Xor<false, boolean>;
+//=> boolean
+
+type B = Xor<boolean, false>;
+//=> boolean
+
+type C = Xor<true, boolean>;
+//=> boolean
+
+type D = Xor<boolean, true>;
+//=> boolean
+
+type E = Xor<boolean, boolean>;
+//=> boolean
+```
+
+Note: If `never` is passed as an argument, it is treated as `false` and the result is computed accordingly.
+
+@example
+```
+import type {Xor} from 'type-fest';
+
+type A = Xor<true, never>;
+//=> true
+
+type B = Xor<never, true>;
+//=> true
+
+type C = Xor<false, never>;
+//=> false
+
+type D = Xor<never, false>;
+//=> false
+
+type E = Xor<boolean, never>;
+//=> boolean
+
+type F = Xor<never, boolean>;
+//=> boolean
+
+type G = Xor<never, never>;
+//=> false
+```
+
+@see {@link And}
+@see {@link Or}
+*/
+export type Xor<A extends boolean, B extends boolean> = And<Or<A, B>, Not<And<A, B>>>;
+
+export {};