feat: support TypeScript up to version 5.2 (#82)

* feat: support TypeScript up to version 5.2

BREAKING CHANGE: Support for TypeScript 5.0 and lower has been dropped.

Author: pavadeli

.eslintrc.js

@@ -7,18 +7,15 @@ const config = {
         project: ['./tsconfig.lib.json', './tsconfig.test.json'],
     },
     plugins: ['@typescript-eslint', 'import'],
-    extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/recommended',
-        'plugin:@typescript-eslint/recommended-requiring-type-checking',
-        'prettier',
-    ],
+    extends: ['eslint:recommended', 'plugin:@typescript-eslint/strict-type-checked', 'prettier'],
     rules: {
         'no-fallthrough': 'off', // checked by TS compiler
         'object-shorthand': ['error', 'always'],
         'sort-imports': ['error', { ignoreDeclarationSort: true }],
         '@typescript-eslint/no-explicit-any': 'off',
         '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-invalid-void-type': 'off',
+        '@typescript-eslint/no-throw-literal': 'off',
         'import/extensions': ['error', 'ignorePackages'],
     },
     overrides: [

etc/types.api.md

@@ -64,7 +64,7 @@ export abstract class BaseTypeImpl<ResultType, TypeConfig = unknown> implements
     protected createAutoCastAllType(): this;
     protected createResult(input: unknown, result: unknown, validatorResult: ValidationResult): Result<ResultType>;
     readonly enumerableLiteralDomain?: Iterable<LiteralValue>;
-    extendWith<E>(factory: (type: this) => E): this & E;
+    extendWith<const E>(factory: (type: this) => E): this & E;
     get is(): TypeguardFor<ResultType>;
     literal(input: DeepUnbranded<ResultType>): ResultType;
     maybeStringify(value: ResultType): string | undefined;
@@ -75,9 +75,9 @@ export abstract class BaseTypeImpl<ResultType, TypeConfig = unknown> implements
     protected typeParser?(input: unknown, options: ValidationOptions): Result<unknown>;
     protected abstract typeValidator(input: unknown, options: ValidationOptions): Result<ResultType>;
     validate(input: unknown, options?: ValidationOptions): Result<ResultType>;
-    withBrand<BrandName extends string>(name: BrandName): Type<Branded<ResultType, BrandName>, TypeConfig>;
-    withConfig<BrandName extends string>(name: BrandName, newConfig: TypeConfig): Type<Branded<ResultType, BrandName>, TypeConfig>;
-    withConstraint<BrandName extends string>(name: BrandName, constraint: Validator<ResultType>): Type<Branded<ResultType, BrandName>, TypeConfig>;
+    withBrand<const BrandName extends string>(name: BrandName): Type<Branded<ResultType, BrandName>, TypeConfig>;
+    withConfig<const BrandName extends string>(name: BrandName, newConfig: TypeConfig): Type<Branded<ResultType, BrandName>, TypeConfig>;
+    withConstraint<const BrandName extends string>(name: BrandName, constraint: Validator<ResultType>): Type<Branded<ResultType, BrandName>, TypeConfig>;
     withName(name: string): this;
     withParser(...args: [newConstructor: (i: unknown) => unknown] | [name: string, newConstructor: (i: unknown) => unknown] | [options: ParserOptions, newConstructor: (i: unknown) => unknown]): this;
     withValidation(validation: Validator<ResultType>): this;
@@ -230,7 +230,7 @@ export interface LengthChecksConfig {
 export type LengthViolation = 'minLength' | 'maxLength';
 
 // @public (undocumented)
-export function literal<T extends LiteralValue>(value: T): TypeImpl<LiteralType<T>>;
+export function literal<const T extends LiteralValue>(value: T): TypeImpl<LiteralType<T>>;
 
 // @public
 export class LiteralType<ResultType extends LiteralValue> extends BaseTypeImpl<ResultType> {
@@ -345,7 +345,7 @@ export function partial<Props extends Properties>(...args: [props: Props] | [nam
 export type PartialType<Props extends Properties> = TypeImpl<InterfaceType<Props, Partial<TypeOfProperties<Writable<Props>>>>>;
 
 // @public (undocumented)
-export function pattern<BrandName extends string>(name: BrandName, regExp: RegExp, customMessage?: StringTypeConfig['customMessage']): Type<Branded<string, BrandName>, StringTypeConfig>;
+export function pattern<const BrandName extends string>(name: BrandName, regExp: RegExp, customMessage?: StringTypeConfig['customMessage']): Type<Branded<string, BrandName>, StringTypeConfig>;
 
 // @public
 export type PossibleDiscriminator = {
@@ -370,7 +370,7 @@ export function printPath(path: ReadonlyArray<PropertyKey>): string;
 export function printValue(input: unknown, budget?: number, visited?: Set<unknown>): string;
 
 // @public
-export type Properties = Record<string, Type<unknown>>;
+export type Properties = Record<string, Type<any>>;
 
 // @public
 export type PropertiesInfo<Props extends Properties = Properties> = {
@@ -494,7 +494,7 @@ Extract<Input, ResultType>
 // @public
 export type TypeImpl<Impl extends BaseTypeImpl<any, any>> = Impl & {
     new (input: unknown): TypeOf<Impl>;
-    (input: unknown): TypeOf<Impl>;
+    (this: void, input: unknown): TypeOf<Impl>;
 };
 
 // @public
@@ -640,7 +640,7 @@ export const voidType: TypeImpl<LiteralType<void>>;
 
 // @public (undocumented)
 export type WithBrands<T, BrandNames extends string> = T & {
-    [brands]: {
+    readonly [brands]: {
         [P in BrandNames]: true;
     };
 };

jest.config.js

@@ -13,7 +13,7 @@ const config = {
     coverageThreshold: {
         global: {
             statements: -3,
-            branches: -16,
+            branches: -15,
             functions: -1,
             lines: 100,
         },

markdown/types.basetypeimpl.extendwith.md

@@ -9,7 +9,7 @@ Extend the Type with additional static methods and properties.
 **Signature:**
 
 ```typescript
-extendWith<E>(factory: (type: this) => E): this & E;
+extendWith<const E>(factory: (type: this) => E): this & E;
 ```
 
 ## Parameters

markdown/types.basetypeimpl.withbrand.md

@@ -9,7 +9,7 @@ Create a new instance of this Type with the given name.
 **Signature:**
 
 ```typescript
-withBrand<BrandName extends string>(name: BrandName): Type<Branded<ResultType, BrandName>, TypeConfig>;
+withBrand<const BrandName extends string>(name: BrandName): Type<Branded<ResultType, BrandName>, TypeConfig>;
 ```
 
 ## Parameters

markdown/types.basetypeimpl.withconfig.md

@@ -9,7 +9,7 @@ Create a new instance of this Type with the additional type-specific config, suc
 **Signature:**
 
 ```typescript
-withConfig<BrandName extends string>(name: BrandName, newConfig: TypeConfig): Type<Branded<ResultType, BrandName>, TypeConfig>;
+withConfig<const BrandName extends string>(name: BrandName, newConfig: TypeConfig): Type<Branded<ResultType, BrandName>, TypeConfig>;
 ```
 
 ## Parameters

markdown/types.basetypeimpl.withconstraint.md

@@ -9,7 +9,7 @@ Create a new type use the given constraint function to restrict the current type
 **Signature:**
 
 ```typescript
-withConstraint<BrandName extends string>(name: BrandName, constraint: Validator<ResultType>): Type<Branded<ResultType, BrandName>, TypeConfig>;
+withConstraint<const BrandName extends string>(name: BrandName, constraint: Validator<ResultType>): Type<Branded<ResultType, BrandName>, TypeConfig>;
 ```
 
 ## Parameters

markdown/types.literal.md

@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-export declare function literal<T extends LiteralValue>(value: T): TypeImpl<LiteralType<T>>;
+export declare function literal<const T extends LiteralValue>(value: T): TypeImpl<LiteralType<T>>;
 ```
 
 ## Parameters

markdown/types.pattern.md

@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-export declare function pattern<BrandName extends string>(
+export declare function pattern<const BrandName extends string>(
     name: BrandName,
     regExp: RegExp,
     customMessage?: StringTypeConfig['customMessage'],

markdown/types.properties.md

@@ -9,7 +9,7 @@ The properties of an object type.
 **Signature:**
 
 ```typescript
-export type Properties = Record<string, Type<unknown>>;
+export type Properties = Record<string, Type<any>>;
 ```
 
 **References:** [Type](./types.type.md)