type-fest 3.13.1 → 4.1.0

package/index.d.ts

@@ -16,13 +16,8 @@ export type {MergeExclusive} from './source/merge-exclusive';
 export type {RequireAtLeastOne} from './source/require-at-least-one';
 export type {RequireExactlyOne} from './source/require-exactly-one';
 export type {RequireAllOrNone} from './source/require-all-or-none';
-export type {
-	OmitIndexSignature,
-	/**
-	@deprecated Renamed to {@link OmitIndexSignature}.
-	*/
-	OmitIndexSignature as RemoveIndexSignature,
-} from './source/omit-index-signature';
+export type {RequireOneOrNone} from './source/require-one-or-none';
+export type {OmitIndexSignature} from './source/omit-index-signature';
 export type {PickIndexSignature} from './source/pick-index-signature';
 export type {PartialDeep, PartialDeepOptions} from './source/partial-deep';
 export type {RequiredDeep} from './source/required-deep';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "type-fest",
-	"version": "3.13.1",
+	"version": "4.1.0",
 	"description": "A collection of essential TypeScript types",
 	"license": "(MIT OR CC0-1.0)",
 	"repository": "sindresorhus/type-fest",
@@ -12,7 +12,7 @@
 	},
 	"types": "./index.d.ts",
 	"engines": {
-		"node": ">=14.16"
+		"node": ">=16"
 	},
 	"scripts": {
 		"test": "xo && tsd && tsc && node script/test/source-files-extension.js"
@@ -38,7 +38,7 @@
 		"expect-type": "^0.15.0",
 		"tsd": "^0.28.1",
 		"typescript": "^5.0.4",
-		"xo": "^0.54.2"
+		"xo": "^0.55.0"
 	},
 	"xo": {
 		"rules": {

package/readme.md

@@ -37,6 +37,18 @@
 					<sup>Add Single Sign-On (and more) in minutes instead of months.</sup>
 				</div>
 			</a>
+			<br>
+			<br>
+			<br>
+			<a href="https://transloadit.com?utm_source=sindresorhus&utm_medium=referral&utm_campaign=sponsorship&utm_content=type-fest">
+				<picture>
+					<source width="350" media="(prefers-color-scheme: dark)" srcset="https://sindresorhus.com/assets/thanks/transloadit-logo-dark.svg">
+					<source width="350" media="(prefers-color-scheme: light)" srcset="https://sindresorhus.com/assets/thanks/transloadit-logo.svg">
+					<img width="350" src="https://sindresorhus.com/assets/thanks/transloadit-logo.svg" alt="Transloadit logo">
+				</picture>
+			</a>
+			<br>
+			<br>
 		</p>
 	</div>
 	<br>
@@ -64,7 +76,7 @@ PR welcome for additional commonly needed types and docs improvements. Read the
 npm install type-fest
 ```
 
-*Requires TypeScript >=4.7*
+*Requires TypeScript >=5.1*
 
 ## Usage
 
@@ -108,6 +120,7 @@ Click the type names for complete docs.
 - [`RequireAtLeastOne`](source/require-at-least-one.d.ts) - Create a type that requires at least one of the given keys.
 - [`RequireExactlyOne`](source/require-exactly-one.d.ts) - Create a type that requires exactly a single key of the given keys and disallows more.
 - [`RequireAllOrNone`](source/require-all-or-none.d.ts) - Create a type that requires all of the given keys or none of the given keys.
+- [`RequireOneOrNone`](source/require-one-or-none.d.ts) - Create a type that requires exactly a single key of the given keys and disallows more, or none of the given keys.
 - [`RequiredDeep`](source/required-deep.d.ts) - Create a deeply required version of another type. Use [`Required<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype) if you only need one level deep.
 - [`OmitIndexSignature`](source/omit-index-signature.d.ts) - Omit any index signatures from the given object type, leaving only explicitly defined properties.
 - [`PickIndexSignature`](source/pick-index-signature.d.ts) - Pick only index signatures from the given object type, leaving out all explicitly defined properties.

package/source/internal.d.ts

@@ -251,3 +251,8 @@ export type IsNotFalse<T extends boolean> = [T] extends [false] ? false : true;
 Returns a boolean for whether the given type is `null`.
 */
 export type IsNull<T> = [T] extends [null] ? true : false;
+
+/**
+Disallows any of the given keys.
+*/
+export type RequireNone<KeysType extends PropertyKey> = Partial<Record<KeysType, never>>;

package/source/jsonify.d.ts

@@ -1,16 +1,26 @@
 import type {JsonPrimitive, JsonValue} from './basic';
 import type {EmptyObject} from './empty-object';
 import type {UndefinedToOptional} from './internal';
+import type {IsAny} from './is-any';
+import type {IsNever} from './is-never';
 import type {NegativeInfinity, PositiveInfinity} from './numeric';
 import type {TypedArray} from './typed-array';
-import type {IsAny} from './is-any';
 
 // Note: The return value has to be `any` and not `unknown` so it can match `void`.
 type NotJsonable = ((...arguments_: any[]) => any) | undefined | symbol;
 
-type JsonifyTuple<T extends [unknown, ...unknown[]]> = {
-	[Key in keyof T]: T[Key] extends NotJsonable ? null : Jsonify<T[Key]>;
-};
+type FilterNonNever<T extends unknown[]> = T extends [infer F, ...infer R]
+	? IsNever<F> extends true
+		? FilterNonNever<R>
+		: [F, ...FilterNonNever<R>]
+	: IsNever<T[number]> extends true
+		? []
+		: T;
+
+// Handles tuples and arrays
+type JsonifyList<T extends unknown[]> = T extends [infer F, ...infer R]
+	? FilterNonNever<[Jsonify<F>, ...JsonifyList<R>]>
+	: Array<Jsonify<T[number]>>;
 
 type FilterJsonableKeys<T extends object> = {
 	[Key in keyof T]: T[Key] extends NotJsonable ? never : Key;
@@ -107,7 +117,7 @@ export type Jsonify<T> = IsAny<T> extends true
 										: T extends []
 											? []
 											: T extends [unknown, ...unknown[]]
-												? JsonifyTuple<T>
+												? JsonifyList<T>
 												: T extends ReadonlyArray<infer U>
 													? Array<U extends NotJsonable ? null : Jsonify<U>>
 													: T extends object

package/source/last-array-element.d.ts

@@ -18,11 +18,11 @@ typeof lastOf(array);
 @category Array
 @category Template literal
 */
-export type LastArrayElement<ValueType extends readonly unknown[]> =
-	ValueType extends readonly [infer ElementType]
-		? ElementType
-		: ValueType extends readonly [infer _, ...infer Tail]
-			? LastArrayElement<Tail>
-			: ValueType extends ReadonlyArray<infer ElementType>
-				? ElementType
+export type LastArrayElement<Elements extends readonly unknown[]>
+		= number extends Elements['length']
+			? Elements extends ReadonlyArray<infer Element>
+				? Element
+				: never
+			: Elements extends readonly [...any, infer Target]
+				? Target
 				: never;

package/source/package-json.d.ts

@@ -505,7 +505,7 @@ declare namespace PackageJson {
 		Engines that this package runs on.
 		*/
 		engines?: {
-			[EngineName in 'npm' | 'node' | string]?: string; // eslint-disable-line @typescript-eslint/no-redundant-type-constituents
+			[EngineName in 'npm' | 'node' | string]?: string;
 		};
 
 		/**

package/source/require-all-or-none.d.ts

@@ -1,3 +1,10 @@
+import type {RequireNone} from './internal';
+
+/**
+Requires all of the keys in the given object.
+*/
+type RequireAll<ObjectType, KeysType extends keyof ObjectType> = Required<Pick<ObjectType, KeysType>>;
+
 /**
 Create a type that requires all of the given keys or none of the given keys. The remaining keys are kept as is.
 
@@ -30,7 +37,6 @@ const responder2: RequireAllOrNone<Responder, 'text' | 'json'> = {
 @category Object
 */
 export type RequireAllOrNone<ObjectType, KeysType extends keyof ObjectType = never> = (
-	| Required<Pick<ObjectType, KeysType>> // Require all of the given keys.
-	| Partial<Record<KeysType, never>> // Require none of the given keys.
-) &
-Omit<ObjectType, KeysType>; // The rest of the keys.
+	| RequireAll<ObjectType, KeysType>
+	| RequireNone<KeysType>
+) & Omit<ObjectType, KeysType>; // The rest of the keys.

package/source/require-one-or-none.d.ts

@@ -0,0 +1,37 @@
+import type {RequireExactlyOne} from './require-exactly-one';
+import type {RequireNone} from './internal';
+
+/**
+Create a type that requires exactly one of the given keys and disallows more, or none of the given keys. The remaining keys are kept as is.
+
+@example
+```
+import type {RequireOneOrNone} from 'type-fest';
+
+type Responder = RequireOneOrNone<{
+	text: () => string;
+	json: () => string;
+	secure: boolean;
+}, 'text' | 'json'>;
+
+const responder1: Responder = {
+	secure: true
+};
+
+const responder2: Responder = {
+	text: () => '{"message": "hi"}',
+	secure: true
+};
+
+const responder3: Responder = {
+	json: () => '{"message": "ok"}',
+	secure: true
+};
+```
+
+@category Object
+*/
+export type RequireOneOrNone<ObjectType, KeysType extends keyof ObjectType = keyof ObjectType> = (
+	| RequireExactlyOne<ObjectType, KeysType>
+	| RequireNone<KeysType>
+) & Omit<ObjectType, KeysType>; // Ignore unspecified keys.