fix(*): TypeScript 5.x compatibility (#253)

package.json

@@ -21,8 +21,6 @@
 		"format": "prettier --write \"{src,tests}/**/*.ts\"",
 		"docs": "typedoc-json-parser",
 		"test": "vitest run",
-		"test:watch": "vitest",
-		"update": "yarn upgrade-interactive",
 		"build": "tsup",
 		"clean": "node scripts/clean.mjs",
 		"typecheck": "tsc -p tsconfig.eslint.json",
@@ -32,6 +30,10 @@
 		"prepack": "yarn build && pinst --disable",
 		"postpack": "pinst --enable"
 	},
+	"dependencies": {
+		"fast-deep-equal": "^3.1.3",
+		"lodash": "^4.17.21"
+	},
 	"devDependencies": {
 		"@commitlint/cli": "^17.5.1",
 		"@commitlint/config-conventional": "^17.4.4",
@@ -61,7 +63,7 @@
 		"tsup": "^6.7.0",
 		"typedoc": "^0.23.28",
 		"typedoc-json-parser": "^7.2.0",
-		"typescript": "^4.9.5",
+		"typescript": "^5.0.3",
 		"vite": "^4.2.1",
 		"vitest": "^0.29.8"
 	},
@@ -119,9 +121,5 @@
 		"ansi-regex": "^5.0.1",
 		"minimist": "^1.2.8"
 	},
-	"packageManager": "yarn@3.5.0",
-	"dependencies": {
-		"fast-deep-equal": "^3.1.3",
-		"lodash": "^4.17.21"
-	}
+	"packageManager": "yarn@3.5.0"
 }

src/constraints/ArrayConstraints.ts

@@ -2,7 +2,7 @@ import { ExpectedConstraintError } from '../lib/errors/ExpectedConstraintError';
 import { Result } from '../lib/Result';
 import type { IConstraint } from './base/IConstraint';
 import { isUnique } from './util/isUnique';
-import { Comparator, equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual } from './util/operators';
+import { equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual, type Comparator } from './util/operators';
 
 export type ArrayConstraintName = `s.array(T).${
 	| 'unique'

src/constraints/BigIntConstraints.ts

@@ -1,7 +1,7 @@
 import { ExpectedConstraintError } from '../lib/errors/ExpectedConstraintError';
 import { Result } from '../lib/Result';
 import type { IConstraint } from './base/IConstraint';
-import { Comparator, equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual } from './util/operators';
+import { equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual, type Comparator } from './util/operators';
 
 export type BigIntConstraintName = `s.bigint.${
 	| 'lessThan'

src/constraints/DateConstraints.ts

@@ -1,7 +1,7 @@
 import { ExpectedConstraintError } from '../lib/errors/ExpectedConstraintError';
 import { Result } from '../lib/Result';
 import type { IConstraint } from './base/IConstraint';
-import { Comparator, equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual } from './util/operators';
+import { equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual, type Comparator } from './util/operators';
 
 export type DateConstraintName = `s.date.${
 	| 'lessThan'

src/constraints/NumberConstraints.ts

@@ -1,7 +1,7 @@
 import { ExpectedConstraintError } from '../lib/errors/ExpectedConstraintError';
 import { Result } from '../lib/Result';
 import type { IConstraint } from './base/IConstraint';
-import { Comparator, equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual } from './util/operators';
+import { equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual, type Comparator } from './util/operators';
 
 export type NumberConstraintName = `s.number.${
 	| 'lessThan'

src/constraints/StringConstraints.ts

@@ -3,7 +3,7 @@ import { Result } from '../lib/Result';
 import type { IConstraint } from './base/IConstraint';
 import { validateEmail } from './util/emailValidator';
 import { isIP, isIPv4, isIPv6 } from './util/net';
-import { Comparator, equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual } from './util/operators';
+import { equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual, type Comparator } from './util/operators';
 import { validatePhoneNumber } from './util/phoneValidator';
 import { createUrlValidators } from './util/urlValidators';
 

src/constraints/TypedArrayLengthConstraints.ts

@@ -1,7 +1,7 @@
 import { ExpectedConstraintError } from '../lib/errors/ExpectedConstraintError';
 import { Result } from '../lib/Result';
 import type { IConstraint } from './base/IConstraint';
-import { Comparator, equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual } from './util/operators';
+import { equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual, type Comparator } from './util/operators';
 import type { TypedArray } from './util/typedArray';
 
 export type TypedArrayConstraintName = `s.typedArray(T).${'byteLength' | 'length'}${

src/constraints/util/urlValidators.ts

@@ -1,5 +1,5 @@
 import { MultiplePossibilitiesConstraintError } from '../../lib/errors/MultiplePossibilitiesConstraintError';
-import { combinedErrorFn, ErrorFn } from './common/combinedResultFn';
+import { combinedErrorFn, type ErrorFn } from './common/combinedResultFn';
 
 export type StringProtocol = `${string}:`;
 

src/index.ts

@@ -2,6 +2,7 @@ import { Shapes } from './lib/Shapes';
 
 export const s = new Shapes();
 
+export * from './lib/Result';
 export * from './lib/configs';
 export * from './lib/errors/BaseError';
 export * from './lib/errors/CombinedError';
@@ -13,5 +14,4 @@ export * from './lib/errors/MultiplePossibilitiesConstraintError';
 export * from './lib/errors/UnknownEnumValueError';
 export * from './lib/errors/UnknownPropertyError';
 export * from './lib/errors/ValidationError';
-export * from './lib/Result';
 export * from './type-exports';

src/lib/Shapes.ts

@@ -21,7 +21,7 @@ import {
 	UnionValidator
 } from '../validators/imports';
 import { LazyValidator } from '../validators/LazyValidator';
-import { NativeEnumLike, NativeEnumValidator } from '../validators/NativeEnumValidator';
+import { NativeEnumValidator, type NativeEnumLike } from '../validators/NativeEnumValidator';
 import { TypedArrayValidator } from '../validators/TypedArrayValidator';
 import type { Constructor, MappedObjectValidator } from './util-types';
 

src/validators/LazyValidator.ts

@@ -1,6 +1,6 @@
 import type { Result } from '../lib/Result';
 import type { IConstraint, Unwrap } from '../type-exports';
-import { BaseValidator, ValidatorError } from './imports';
+import { BaseValidator, type ValidatorError } from './imports';
 
 export class LazyValidator<T extends BaseValidator<unknown>, R = Unwrap<T>> extends BaseValidator<R> {
 	private readonly validator: (value: unknown) => T;

src/validators/ObjectValidator.ts

@@ -278,7 +278,7 @@ export class ObjectValidator<T extends object, I = UndefinedToOptional<T>> exten
 	}
 }
 
-export const enum ObjectValidatorStrategy {
+export enum ObjectValidatorStrategy {
 	Ignore,
 	Strict,
 	Passthrough

src/validators/StringValidator.ts

@@ -13,7 +13,7 @@ import {
 	stringRegex,
 	stringUrl,
 	stringUuid,
-	StringUuidOptions,
+	type StringUuidOptions,
 	type UrlOptions
 } from '../constraints/StringConstraints';
 import { ValidationError } from '../lib/errors/ValidationError';

src/validators/TypedArrayValidator.ts

@@ -20,7 +20,7 @@ import {
 	typedArrayLengthRangeInclusive
 } from '../constraints/TypedArrayLengthConstraints';
 import { aOrAn } from '../constraints/util/common/vowels';
-import { TypedArray, TypedArrayName, TypedArrays } from '../constraints/util/typedArray';
+import { TypedArrays, type TypedArray, type TypedArrayName } from '../constraints/util/typedArray';
 import { ValidationError } from '../lib/errors/ValidationError';
 import { Result } from '../lib/Result';
 import { BaseValidator } from './imports';

tests/lib/configs.test.ts

@@ -1,4 +1,4 @@
-import { BaseValidator, s, setGlobalValidationEnabled } from '../../src';
+import { s, setGlobalValidationEnabled, type BaseValidator } from '../../src';
 
 describe('Validation enabled and disabled configurations', () => {
 	const stringPredicate = s.string.lengthGreaterThan(5);

tests/validators/array.test.ts

@@ -1,4 +1,4 @@
-import { ArrayValidator, CombinedPropertyError, ExpectedConstraintError, s, ValidationError } from '../../src';
+import { CombinedPropertyError, ExpectedConstraintError, ValidationError, s, type ArrayValidator } from '../../src';
 import { expectClonedValidator, expectError } from '../common/macros/comparators';
 
 describe('ArrayValidator', () => {

tests/validators/lazy.test.ts

@@ -1,4 +1,4 @@
-import { CombinedPropertyError, ExpectedConstraintError, MissingPropertyError, s, SchemaOf, ValidationError } from '../../src';
+import { CombinedPropertyError, ExpectedConstraintError, MissingPropertyError, ValidationError, s, type SchemaOf } from '../../src';
 import { expectError } from '../common/macros/comparators';
 
 describe('LazyValidator', () => {

tsconfig.base.json

@@ -3,6 +3,7 @@
 	"compilerOptions": {
 		"target": "ES2020",
 		"useDefineForClassFields": false,
-		"emitDecoratorMetadata": false
+		"emitDecoratorMetadata": false,
+		"ignoreDeprecations": "5.0" // To be removed when @sapphire/ts-config is updated to TS 5.x
 	}
 }