type-fest 3.1.0 → 3.2.0

package/index.d.ts

@@ -50,6 +50,7 @@ export type {SetReturnType} from './source/set-return-type';
 export type {Asyncify} from './source/asyncify';
 export type {Simplify} from './source/simplify';
 export type {Jsonify} from './source/jsonify';
+export type {Jsonifiable} from './source/jsonifiable';
 export type {Schema} from './source/schema';
 export type {LiteralToPrimitive} from './source/literal-to-primitive';
 export type {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "type-fest",
-	"version": "3.1.0",
+	"version": "3.2.0",
 	"description": "A collection of essential TypeScript types",
 	"license": "(MIT OR CC0-1.0)",
 	"repository": "sindresorhus/type-fest",
@@ -35,10 +35,10 @@
 	],
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "~0.7.0",
-		"expect-type": "^0.14.2",
+		"expect-type": "^0.15.0",
 		"tsd": "^0.24.1",
-		"typescript": "^4.8.3",
-		"xo": "^0.52.2"
+		"typescript": "^4.8.4",
+		"xo": "^0.52.4"
 	},
 	"xo": {
 		"rules": {

package/readme.md

@@ -187,6 +187,7 @@ Click the type names for complete docs.
 ### JSON
 
 - [`Jsonify`](source/jsonify.d.ts) - Transform a type to one that is assignable to the `JsonValue` type.
+- [`Jsonifiable`](source/jsonifiable.d.ts) - Matches a value that can be losslessly converted to JSON.
 - [`JsonPrimitive`](source/basic.d.ts) - Matches a JSON primitive.
 - [`JsonObject`](source/basic.d.ts) - Matches a JSON object.
 - [`JsonArray`](source/basic.d.ts) - Matches a JSON array.
@@ -213,7 +214,7 @@ Click the type names for complete docs.
 - [`MultidimensionalArray`](source/multidimensional-array.d.ts) - Create a type that represents a multidimensional array of the given type and dimensions.
 - [`MultidimensionalReadonlyArray`](source/multidimensional-readonly-array.d.ts) - Create a type that represents a multidimensional readonly array of the given type and dimensions.
 - [`ReadonlyTuple`](source/readonly-tuple.d.ts) - Create a type that represents a read-only tuple of the given type and length.
-- [`TupleToUnion`](source/tuple-to-union.d.ts) - Convert a tuple into a union type of its elements.
+- [`TupleToUnion`](source/tuple-to-union.d.ts) - Convert a tuple/array into a union type of its elements.
 
 ### Numeric
 

package/source/camel-case.d.ts

@@ -1,39 +1,42 @@
-import type {WordSeparators} from '../source/internal';
-import type {Split} from './split';
+import type {SplitWords} from './split-words';
 
 /**
-Step by step takes the first item in an array literal, formats it and adds it to a string literal, and then recursively appends the remainder.
+CamelCase options.
 
-Only to be used by `CamelCaseStringArray<>`.
-
-@see CamelCaseStringArray
+@see {@link CamelCase}
 */
-type InnerCamelCaseStringArray<Parts extends readonly any[], PreviousPart> =
-	Parts extends [`${infer FirstPart}`, ...infer RemainingParts]
-		? FirstPart extends undefined
-			? ''
-			: FirstPart extends ''
-				? InnerCamelCaseStringArray<RemainingParts, PreviousPart>
-				: `${PreviousPart extends '' ? FirstPart : Capitalize<FirstPart>}${InnerCamelCaseStringArray<RemainingParts, FirstPart>}`
-		: '';
-
-/**
-Starts fusing the output of `Split<>`, an array literal of strings, into a camel-cased string literal.
+export type CamelCaseOptions = {
+	/**
+	Whether to preserved consecutive uppercase letter.
 
-It's separate from `InnerCamelCaseStringArray<>` to keep a clean API outwards to the rest of the code.
+	@default true
+	*/
+	preserveConsecutiveUppercase?: boolean;
+};
 
-@see Split
+/**
+Convert an array of words to camel-case.
 */
-type CamelCaseStringArray<Parts extends readonly string[]> =
-	Parts extends [`${infer FirstPart}`, ...infer RemainingParts]
-		? Uncapitalize<`${FirstPart}${InnerCamelCaseStringArray<RemainingParts, FirstPart>}`>
-		: never;
+type CamelCaseFromArray<
+	Words extends string[],
+	Options extends CamelCaseOptions,
+	OutputString extends string = '',
+> = Words extends [
+	infer FirstWord extends string,
+	...infer RemainingWords extends string[],
+]
+	? Options['preserveConsecutiveUppercase'] extends true
+		? `${Capitalize<FirstWord>}${CamelCaseFromArray<RemainingWords, Options>}`
+		: `${Capitalize<Lowercase<FirstWord>>}${CamelCaseFromArray<RemainingWords, Options>}`
+	: OutputString;
 
 /**
 Convert a string literal to camel-case.
 
 This can be useful when, for example, converting some kebab-cased command-line flags or a snake-cased database result.
 
+By default, consecutive uppercase letter are preserved. See {@link CamelCaseOptions.preserveConsecutiveUppercase preserveConsecutiveUppercase} option to change this behaviour.
+
 @example
 ```
 import type {CamelCase} from 'type-fest';
@@ -70,4 +73,6 @@ const dbResult: CamelCasedProperties<RawOptions> = {
 @category Change case
 @category Template literal
 */
-export type CamelCase<K> = K extends string ? CamelCaseStringArray<Split<K extends Uppercase<K> ? Lowercase<K> : K, WordSeparators>> : K;
+export type CamelCase<Type, Options extends CamelCaseOptions = {preserveConsecutiveUppercase: true}> = Type extends string
+	? Uncapitalize<CamelCaseFromArray<SplitWords<Type extends Uppercase<Type> ? Lowercase<Type> : Type>, Options>>
+	: Type;

package/source/camel-cased-properties-deep.d.ts

@@ -1,4 +1,4 @@
-import type {CamelCase} from './camel-case';
+import type {CamelCase, CamelCaseOptions} from './camel-case';
 
 /**
 Convert object properties to camel case recursively.
@@ -44,11 +44,11 @@ const result: CamelCasedPropertiesDeep<UserWithFriends> = {
 @category Template literal
 @category Object
 */
-export type CamelCasedPropertiesDeep<Value> = Value extends Function
+export type CamelCasedPropertiesDeep<Value, Options extends CamelCaseOptions = {preserveConsecutiveUppercase: true}> = Value extends Function
 	? Value
 	: Value extends Array<infer U>
-		? Array<CamelCasedPropertiesDeep<U>>
+		? Array<CamelCasedPropertiesDeep<U, Options>>
 		: Value extends Set<infer U>
-			? Set<CamelCasedPropertiesDeep<U>> : {
-				[K in keyof Value as CamelCase<K>]: CamelCasedPropertiesDeep<Value[K]>;
+			? Set<CamelCasedPropertiesDeep<U, Options>> : {
+				[K in keyof Value as CamelCase<K, Options>]: CamelCasedPropertiesDeep<Value[K], Options>;
 			};

package/source/camel-cased-properties.d.ts

@@ -1,4 +1,4 @@
-import type {CamelCase} from './camel-case';
+import type {CamelCase, CamelCaseOptions} from './camel-case';
 
 /**
 Convert object properties to camel case but not recursively.
@@ -27,10 +27,10 @@ const result: CamelCasedProperties<User> = {
 @category Template literal
 @category Object
 */
-export type CamelCasedProperties<Value> = Value extends Function
+export type CamelCasedProperties<Value, Options extends CamelCaseOptions = {preserveConsecutiveUppercase: true}> = Value extends Function
 	? Value
 	: Value extends Array<infer U>
 		? Value
 		: {
-			[K in keyof Value as CamelCase<K>]: Value[K];
+			[K in keyof Value as CamelCase<K, Options>]: Value[K];
 		};

package/source/delimiter-case.d.ts

@@ -1,9 +1,9 @@
 import type {UpperCaseCharacters, WordSeparators} from '../source/internal';
 
-// Transforms a string that is fully uppercase into a fully lowercase version. Needed to add support for SCREMAING_SNAKE_CASE, see https://github.com/sindresorhus/type-fest/issues/385
+// Transforms a string that is fully uppercase into a fully lowercase version. Needed to add support for SCREAMING_SNAKE_CASE, see https://github.com/sindresorhus/type-fest/issues/385
 type UpperCaseToLowerCase<T extends string> = T extends Uppercase<T> ? Lowercase<T> : T;
 
-// This implemntation does not supports SCREMAING_SNAKE_CASE, it used internaly by `SplitIncludingDelimiters`.
+// This implementation does not support SCREAMING_SNAKE_CASE, it is used internally by `SplitIncludingDelimiters`.
 type SplitIncludingDelimiters_<Source extends string, Delimiter extends string> =
 	Source extends '' ? [] :
 		Source extends `${infer FirstPart}${Delimiter}${infer SecondPart}` ?

package/source/enforce-optional.d.ts

@@ -19,7 +19,7 @@ Enforce optional keys (by adding the `?` operator) for keys that have a union wi
 
 @example
 ```
-import type {Merge} from 'type-fest';
+import type {EnforceOptional} from 'type-fest';
 
 type Foo = {
 	a: string;

package/source/fixed-length-array.d.ts

@@ -6,7 +6,7 @@ type ArrayLengthMutationKeys = 'splice' | 'push' | 'pop' | 'shift' | 'unshift';
 /**
 Create a type that represents an array of the given type and length. The array's length and the `Array` prototype methods that manipulate its length are excluded in the resulting type.
 
-Please participate in [this issue](https://github.com/microsoft/TypeScript/issues/26223) if you want to have a similiar type built into TypeScript.
+Please participate in [this issue](https://github.com/microsoft/TypeScript/issues/26223) if you want to have a similar type built into TypeScript.
 
 Use-cases:
 - Declaring fixed-length tuples or arrays with a large number of items.

package/source/internal.d.ts

@@ -93,3 +93,18 @@ export type FirstArrayElement<TArray extends UnknownArrayOrTuple> = TArray exten
 Extracts the type of an array or tuple minus the first element.
 */
 export type ArrayTail<TArray extends UnknownArrayOrTuple> = TArray extends readonly [unknown, ...infer TTail] ? TTail : [];
+
+/**
+Returns a boolean for whether the string is lowercased.
+*/
+export type IsLowerCase<T extends string> = T extends Lowercase<T> ? true : false;
+
+/**
+Returns a boolean for whether the string is uppercased.
+*/
+export type IsUpperCase<T extends string> = T extends Uppercase<T> ? true : false;
+
+/**
+Returns a boolean for whether the string is numeric.
+*/
+export type IsNumeric<T extends string> = T extends `${number}` ? true : false;

package/source/jsonifiable.d.ts

@@ -0,0 +1,37 @@
+import type {JsonPrimitive, JsonValue} from './basic';
+
+type JsonifiableObject = {[Key in string]?: Jsonifiable} | {toJSON: () => Jsonifiable};
+type JsonifiableArray = readonly Jsonifiable[];
+
+/**
+Matches a value that can be losslessly converted to JSON.
+
+Can be used to type values that you expect to pass to `JSON.stringify`.
+
+`undefined` is allowed in object fields (for example, `{a?: number}`) as a special case even though `JSON.stringify({a: undefined})` is `{}` because it makes this class more widely useful and checking for undefined-but-present values is likely an anti-pattern.
+
+@example
+```
+import type {Jsonifiable} from 'type-fest';
+
+// @ts-expect-error
+const error: Jsonifiable = {
+    map: new Map([['a', 1]]),
+};
+
+JSON.stringify(error);
+//=> {"map": {}}
+
+const good: Jsonifiable = {
+    number: 3,
+    date: new Date(),
+    missing: undefined,
+}
+
+JSON.stringify(good);
+//=> {"number": 3, "date": "2022-10-17T22:22:35.920Z"}
+```
+
+@category JSON
+*/
+export type Jsonifiable = JsonPrimitive | JsonifiableObject | JsonifiableArray;

package/source/jsonify.d.ts

@@ -1,4 +1,5 @@
 import type {JsonPrimitive, JsonValue} from './basic';
+import type {EmptyObject} from './empty-object';
 import type {Merge} from './merge';
 import type {NegativeInfinity, PositiveInfinity} from './numeric';
 import type {TypedArray} from './typed-array';
@@ -95,12 +96,12 @@ export type Jsonify<T> =
 				// Any object with toJSON is special case
 					? T extends {toJSON(): infer J} ? (() => J) extends (() => JsonValue) // Is J assignable to JsonValue?
 						? J // Then T is Jsonable and its Jsonable value is J
-						: never // Not Jsonable because its toJSON() method does not return JsonValue
+						: Jsonify<J> // Maybe if we look a level deeper we'll find a JsonValue
 					// Instanced primitives are objects
 						: T extends Number ? number
 							: T extends String ? string
 								: T extends Boolean ? boolean
-									: T extends Map<any, any> | Set<any> ? {}
+									: T extends Map<any, any> | Set<any> ? EmptyObject
 										: T extends TypedArray ? Record<string, number>
 											: T extends any[]
 												? {[I in keyof T]: T[I] extends NotJsonable ? null : Jsonify<T[I]>}

package/source/merge-deep.d.ts

@@ -13,7 +13,7 @@ import type {
 } from './internal';
 
 /**
-Deeply smplifies an object excluding iterables and functions. Used internally to improve the UX and accept both interfaces and type aliases as inputs.
+Deeply simplifies an object excluding iterables and functions. Used internally to improve the UX and accept both interfaces and type aliases as inputs.
 */
 type SimplifyDeep<Type> = ConditionalSimplifyDeep<Type, Function | Iterable<unknown>, object>;
 
@@ -200,7 +200,7 @@ Merge mode for array/tuple elements.
 type ArrayMergeMode = 'spread' | 'replace';
 
 /**
-Test if it sould spread top-level arrays.
+Test if it should spread top-level arrays.
 */
 type ShouldSpread<Options extends MergeDeepInternalOptions> = Options['spreadTopLevelArrays'] extends false
 	? Options['arrayMergeMode'] extends 'spread' ? true : false

package/source/observable-like.d.ts

@@ -8,7 +8,7 @@ declare global {
 /**
 @remarks
 The TC39 observable proposal defines a `closed` property, but some implementations (such as xstream) do not as of 10/08/2021.
-As well, some guideance on making an `Observable` do not include `closed` propery.
+As well, some guidance on making an `Observable` to not include `closed` property.
 @see https://github.com/tc39/proposal-observable/blob/master/src/Observable.js#L129-L130
 @see https://github.com/staltz/xstream/blob/6c22580c1d84d69773ee4b0905df44ad464955b3/src/index.ts#L79-L85
 @see https://github.com/benlesh/symbol-observable#making-an-object-observable

package/source/package-json.d.ts

@@ -240,7 +240,7 @@ declare namespace PackageJson {
 	Import map entries of a module, optionally with conditions.
 	*/
 	export type Imports = { // eslint-disable-line @typescript-eslint/consistent-indexed-object-style
-		[key: string]: string | {[key in ExportCondition]: Exports};
+		[key: `#${string}`]: string | {[key in ExportCondition]: Exports};
 	};
 
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions

package/source/schema.d.ts

@@ -29,7 +29,6 @@ const userMaskSettings: UserMask = {
 		firstname: 'show',
 		lastname: 'mask',
 	},
-	phoneNumbers: 'mask',
 	created: 'show',
 	active: 'show',
 	passwordHash: 'hide',

package/source/split-words.d.ts

@@ -0,0 +1,57 @@
+import type {IsLowerCase, IsNumeric, IsUpperCase, WordSeparators} from './internal';
+
+type SkipEmptyWord<Word extends string> = Word extends '' ? [] : [Word];
+
+type RemoveLastCharacter<Sentence extends string, Character extends string> = Sentence extends `${infer LeftSide}${Character}`
+	? SkipEmptyWord<LeftSide>
+	: never;
+
+/**
+Split a string (almost) like Lodash's `_.words()` function.
+
+- Split on each word that begins with a capital letter.
+- Split on each {@link WordSeparators}.
+- Split on numeric sequence.
+
+@example
+```
+type Words0 = SplitWords<'helloWorld'>; // ['hello', 'World']
+type Words1 = SplitWords<'helloWORLD'>; // ['hello', 'WORLD']
+type Words2 = SplitWords<'hello-world'>; // ['hello', 'world']
+type Words3 = SplitWords<'--hello the_world'>; // ['hello', 'the', 'world']
+type Words4 = SplitWords<'lifeIs42'>; // ['life', 'Is', '42']
+```
+
+@internal
+@category Change case
+@category Template literal
+*/
+export type SplitWords<
+	Sentence extends string,
+	LastCharacter extends string = '',
+	CurrentWord extends string = '',
+> = Sentence extends `${infer FirstCharacter}${infer RemainingCharacters}`
+	? FirstCharacter extends WordSeparators
+		// Skip word separator
+		? [...SkipEmptyWord<CurrentWord>, ...SplitWords<RemainingCharacters, LastCharacter>]
+		: LastCharacter extends ''
+			// Fist char of word
+			? SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>
+			// Case change: non-numeric to numeric, push word
+			: [false, true] extends [IsNumeric<LastCharacter>, IsNumeric<FirstCharacter>]
+				? [...SkipEmptyWord<CurrentWord>, ...SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>]
+				// Case change: numeric to non-numeric, push word
+				: [true, false] extends [IsNumeric<LastCharacter>, IsNumeric<FirstCharacter>]
+					? [...SkipEmptyWord<CurrentWord>, ...SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>]
+					// No case change: concat word
+					: [true, true] extends [IsNumeric<LastCharacter>, IsNumeric<FirstCharacter>]
+						? SplitWords<RemainingCharacters, FirstCharacter, `${CurrentWord}${FirstCharacter}`>
+					// Case change: lower to upper, push word
+						: [true, true] extends [IsLowerCase<LastCharacter>, IsUpperCase<FirstCharacter>]
+							? [...SkipEmptyWord<CurrentWord>, ...SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>]
+						// Case change: upper to lower, brings back the last character, push word
+							: [true, true] extends [IsUpperCase<LastCharacter>, IsLowerCase<FirstCharacter>]
+								? [...RemoveLastCharacter<CurrentWord, LastCharacter>, ...SplitWords<RemainingCharacters, FirstCharacter, `${LastCharacter}${FirstCharacter}`>]
+							// No case change: concat word
+								: SplitWords<RemainingCharacters, FirstCharacter, `${CurrentWord}${FirstCharacter}`>
+	: [...SkipEmptyWord<CurrentWord>];

package/source/tuple-to-union.d.ts

@@ -1,5 +1,5 @@
 /**
-Convert a tuple into a union type of its elements.
+Convert a tuple/array into a union type of its elements.
 
 This can be useful when you have a fixed set of allowed values and want a type defining only the allowed values, but do not want to repeat yourself.
 
@@ -48,4 +48,4 @@ type NumberBool = typeof numberBool[number];
 
 @category Array
 */
-export type TupleToUnion<ArrayType> = ArrayType extends readonly [infer Head, ...(infer Rest)] ? Head | TupleToUnion<Rest> : never;
+export type TupleToUnion<ArrayType> = ArrayType extends readonly unknown[] ? ArrayType[number] : never;