orange-orm 5.2.3-beta2 → 5.2.4

package/docs/changelog.md

@@ -1,4 +1,8 @@
 ## Changelog
+__5.2.4__  
+Meta parameter in validator is optional  
+__5.2.3__  
+Pass table and column and other metadata to custom validate function [#165](https://github.com/alfateam/orange-orm/issues/165)  
 __5.2.2__  
 Bugfix: jsonOf<T>() exists in type definitions but is missing at runtime [#166](https://github.com/alfateam/orange-orm/issues/166)  
 __5.2.1__  

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "orange-orm",
-    "version": "5.2.3-beta2",
+    "version": "5.2.4",
     "publishConfig": {
         "access": "public"
     },

package/src/index.d.ts

@@ -100,7 +100,7 @@ declare namespace r {
         date(): DateColumnDef;
     }
     export interface DateColumnDef {
-        validate(validator: (value?: Date | string, meta: ValidationMeta) => void): DateColumnDef;
+        validate(validator: (value?: Date | string, meta?: ValidationMeta) => void): DateColumnDef;
         notNull(): DateColumnNotNullDef;
         JSONSchema(schema: object, options?: Options): DateColumnDef;
         serializable(value: boolean): DateColumnDef;
@@ -110,7 +110,7 @@ declare namespace r {
     }
 
     export interface DateColumnNotNullDef {
-        validate(validator: (value: Date | string, meta: ValidationMeta) => void): DateColumnNotNullDef;
+        validate(validator: (value: Date | string, meta?: ValidationMeta) => void): DateColumnNotNullDef;
         JSONSchema(schema: object, options?: Options): DateColumnNotNullDef;
         serializable(value: boolean): DateColumnNotNullDef;
         as(dbName: string): DateColumnNotNullDef;
@@ -119,7 +119,7 @@ declare namespace r {
     }
 
     export interface BinaryColumnDef {
-        validate(validator: (value?: Buffer | string, meta: ValidationMeta) => void): BinaryColumnDef;
+        validate(validator: (value?: Buffer | string, meta?: ValidationMeta) => void): BinaryColumnDef;
         notNull(): BinaryColumnNotNullDef;
         JSONSchema(schema: object, options?: Options): BinaryColumnDef;
         serializable(value: boolean): BinaryColumnDef;
@@ -129,7 +129,7 @@ declare namespace r {
     }
 
     export interface BinaryColumnNotNullDef {
-        validate(validator: (value: Buffer | string, meta: ValidationMeta) => void): BinaryColumnNotNullDef;
+        validate(validator: (value: Buffer | string, meta?: ValidationMeta) => void): BinaryColumnNotNullDef;
         JSONSchema(schema: object, options?: Options): BinaryColumnNotNullDef;
         serializable(value: boolean): BinaryColumnNotNullDef;
         as(dbName: string): BinaryColumnNotNullDef;
@@ -138,7 +138,7 @@ declare namespace r {
     }
 
     export interface ColumnOf<T> {
-        validate(validator: (value?: T, meta: ValidationMeta) => void): ColumnOf<T>;
+        validate(validator: (value?: T, meta?: ValidationMeta) => void): ColumnOf<T>;
         notNull(): ColumnNotNullOf<T>;
         JSONSchema(schema: object, options?: Options): ColumnOf<T>;
         serializable(value: boolean): ColumnOf<T>;
@@ -148,7 +148,7 @@ declare namespace r {
     }
 
     export interface ColumnNotNullOf<T> {
-        validate(validator: (value: T, meta: ValidationMeta) => void): ColumnNotNullOf<T>;
+        validate(validator: (value: T, meta?: ValidationMeta) => void): ColumnNotNullOf<T>;
         notNull(): ColumnNotNullOf<T>;
         JSONSchema(schema: object, options?: Options): ColumnNotNullOf<T>;
         serializable(value: boolean): ColumnNotNullOf<T>;

package/src/map.d.ts

@@ -643,11 +643,6 @@ interface ValidationMeta {
 	isInsert: boolean;
 }
 
-type OptionalOnNullable<M, T> = M extends NotNull ? T : T | null | undefined;
-type ValidateMethod<TValue, TReturn> = {
-	validate(validator: (value: TValue, meta: ValidationMeta) => void): TReturn;
-};
-
 interface ColumnType<M> {
 	string(): StringColumnTypeDef<M & StringColumnSymbol>;
 	uuid(): UuidColumnTypeDef<M & UuidColumnSymbol>;
@@ -662,15 +657,94 @@ interface ColumnType<M> {
 	jsonOf<T>(helper: T): JSONColumnTypeDef<M & JSONColumnSymbol & JsonOf<T>>;
 }
 
-type UuidValidator<M> = ValidateMethod<OptionalOnNullable<M, string>, UuidColumnTypeDef<M>>;
-type StringValidator<M> = ValidateMethod<OptionalOnNullable<M, string>, StringColumnTypeDef<M>>;
-type NumericValidator<M> = ValidateMethod<OptionalOnNullable<M, number>, NumericColumnTypeDef<M>>;
-type BigIntValidator<M> = ValidateMethod<OptionalOnNullable<M, bigint>, BigIntColumnTypeDef<M>>;
-type BinaryValidator<M> = ValidateMethod<OptionalOnNullable<M, string>, BinaryColumnTypeDef<M>>;
-type BooleanValidator<M> = ValidateMethod<OptionalOnNullable<M, boolean>, BooleanColumnTypeDef<M>>;
-type JSONValidator<M> = ValidateMethod<OptionalOnNullable<M, ToJsonType<M>>, JSONColumnTypeDef<M>>;
-type DateValidator<M> = ValidateMethod<OptionalOnNullable<M, string | Date>, DateColumnTypeDef<M>>;
-type DateWithTimeZoneValidator<M> = ValidateMethod<OptionalOnNullable<M, string | Date>, DateWithTimeZoneColumnTypeDef<M>>;
+type UuidValidator<M> = M extends NotNull
+	? {
+		validate(validator: (value: string, meta?: ValidationMeta) => void): UuidColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: string | null, meta?: ValidationMeta) => void
+		): UuidColumnTypeDef<M>;
+	};
+type StringValidator<M> = M extends NotNull
+	? {
+		validate(validator: (value: string, meta?: ValidationMeta) => void): StringColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: string | null, meta?: ValidationMeta) => void
+		): StringColumnTypeDef<M>;
+	};
+type NumericValidator<M> = M extends NotNull
+	? {
+		validate(validator: (value: number, meta?: ValidationMeta) => void): NumericColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: number | null, meta?: ValidationMeta) => void
+		): NumericColumnTypeDef<M>;
+	};
+type BigIntValidator<M> = M extends NotNull
+	? {
+		validate(validator: (value: bigint, meta?: ValidationMeta) => void): BigIntColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: bigint | null, meta?: ValidationMeta) => void
+		): BigIntColumnTypeDef<M>;
+	};
+type BinaryValidator<M> = M extends NotNull
+	? {
+		validate(validator: (value: string, meta?: ValidationMeta) => void): BinaryColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: string | null, meta?: ValidationMeta) => void
+		): BinaryColumnTypeDef<M>;
+	};
+type BooleanValidator<M> = M extends NotNull
+	? {
+		validate(validator: (value: boolean, meta?: ValidationMeta) => void): BooleanColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: boolean | null, meta?: ValidationMeta) => void
+		): BooleanColumnTypeDef<M>;
+	};
+type JSONValidator<M> = M extends NotNull
+	? {
+		validate(
+			validator: (value: ToJsonType<M>, meta?: ValidationMeta) => void
+		): JSONColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: ToJsonType<M> | null, meta?: ValidationMeta) => void
+		): JSONColumnTypeDef<M>;
+	};
+type DateValidator<M> = M extends NotNull
+	? {
+		validate(
+			validator: (value: string | Date, meta?: ValidationMeta) => void
+		): DateColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: string | Date | null, meta?: ValidationMeta) => void
+		): DateColumnTypeDef<M>;
+	};
+
+type DateWithTimeZoneValidator<M> = M extends NotNull
+	? {
+		validate(
+			validator: (value: string | Date, meta?: ValidationMeta) => void
+		): DateWithTimeZoneColumnTypeDef<M>;
+	}
+	: {
+		validate(
+			validator: (value?: string | Date | null, meta?: ValidationMeta) => void
+		): DateWithTimeZoneColumnTypeDef<M>;
+	};
 
 type StringColumnTypeDef<M> = StringValidator<M> & {
 	enum<const V extends readonly string[]>(values: V): StringColumnTypeDef<M & EnumOf<V[number]>> & EnumOf<V[number]>;
@@ -789,7 +863,7 @@ type DateColumnTypeDef<M> = DateValidator<M> & {
 } & ColumnTypeOf<DateColumnType<M>> &
 	M;
 
-type DateWithTimeZoneColumnTypeDef<M> = DateWithTimeZoneValidator<M> & {
+type DateWithTimeZoneColumnTypeDef<M> = DateValidator<M> & {
 	enum<const V extends Record<string, string | Date>>(values: V): DateWithTimeZoneColumnTypeDef<M & EnumOf<V[keyof V]>> & EnumOf<V[keyof V]>;
 	enum<TEnum>(values: Record<string, TEnum>): DateWithTimeZoneColumnTypeDef<M & EnumOf<TEnum>> & EnumOf<TEnum>;
 	enum<E extends string | Date>(values: readonly E[]): DateWithTimeZoneColumnTypeDef<M & EnumOf<E>> & EnumOf<E>;