orange-orm 5.2.3-beta → 5.2.3

package/README.md

@@ -2058,7 +2058,7 @@ export default map;
 
 <details><summary><strong>Validation</strong></summary>
 <p>In the previous sections you have already seen the <strong><i>notNull()</i></strong> validator being used on some columns. This will not only generate correct typescript mapping, but also throw an error if value is set to null or undefined. However, sometimes we do not want the notNull-validator to be run on inserts. Typically, when we have an autoincremental key or server generated uuid, it does not make sense to check for null on insert. This is where <strong><i>notNullExceptInsert()</strong></i> comes to rescue. You can also create your own custom validator as shown below. The last kind of validator, is the <a href="https://ajv.js.org/json-schema.html">ajv JSON schema validator</a>. This can be used on json columns as well as any other column type.</p>
-<p>Custom validators receive <code>value</code> and an optional metadata object with <code>table</code>, <code>column</code>, <code>property</code>, and <code>isInsert</code>.</p>
+<p>Custom validators receive <code>value</code> and a metadata object with <code>table</code>, <code>column</code>, <code>property</code>, and <code>isInsert</code>.</p>
 
 <sub>📄 map.ts</sub>
 ```ts
@@ -2076,9 +2076,9 @@ let petSchema = {
     }
 };
 
-function validateName(value?: string, meta?: { table?: string; column?: string; property?: string; isInsert?: boolean }) {
+function validateName(value?: string, meta: { table: string; column: string; property: string; isInsert: boolean }) {
   if (value && value.length > 10)
-    throw new Error(`Length cannot exceed 10 characters in ${meta?.table}.${meta?.column}`);
+    throw new Error(`Length cannot exceed 10 characters in ${meta.table}.${meta.column}`);
 }
 
 const map = orange.map(x => ({
@@ -2113,7 +2113,7 @@ let petSchema = {
 
 function validateName(value, meta) {
   if (value && value.length > 10)
-    throw new Error(`Length cannot exceed 10 characters in ${meta?.table}.${meta?.column}`);
+    throw new Error(`Length cannot exceed 10 characters in ${meta.table}.${meta.column}`);
 }
 
 const map = orange.map(x => ({

package/dist/index.browser.mjs

@@ -6392,7 +6392,7 @@ function requireColumn () {
 		c.notNullExceptInsert = function() {
 			column._notNullExceptInsert = true;
 			function validate(value, meta) {
-				if (meta?.isInsert)
+				if (meta.isInsert)
 					return;
 				if (value === undefined || value === null)
 					throw new Error(`Column ${column.alias} cannot be null or undefined`);
@@ -8613,7 +8613,7 @@ function requireNewDecodeDbRow () {
 					value = purify(value);
 					this._dbRow[key] = value;
 					if (column.validate)
-						column.validate(value, { table: table._dbName, column: column._dbName, property: column.alias });
+						column.validate(value, { table: table._dbName, column: column._dbName, property: column.alias, isInsert: false });
 					updateField(this._context, table, column, this);
 					let emit = this._emitColumnChanged[name];
 					if (emit)

package/dist/index.mjs

@@ -6393,7 +6393,7 @@ function requireColumn () {
 		c.notNullExceptInsert = function() {
 			column._notNullExceptInsert = true;
 			function validate(value, meta) {
-				if (meta?.isInsert)
+				if (meta.isInsert)
 					return;
 				if (value === undefined || value === null)
 					throw new Error(`Column ${column.alias} cannot be null or undefined`);
@@ -8614,7 +8614,7 @@ function requireNewDecodeDbRow () {
 					value = purify(value);
 					this._dbRow[key] = value;
 					if (column.validate)
-						column.validate(value, { table: table._dbName, column: column._dbName, property: column.alias });
+						column.validate(value, { table: table._dbName, column: column._dbName, property: column.alias, isInsert: false });
 					updateField(this._context, table, column, this);
 					let emit = this._emitColumnChanged[name];
 					if (emit)

package/docs/changelog.md

@@ -1,4 +1,6 @@
 ## Changelog
+__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-beta",
+    "version": "5.2.3",
     "publishConfig": {
         "access": "public"
     },

package/src/index.d.ts

@@ -11,10 +11,10 @@ declare function r(config: r.Config): unknown;
 
 declare namespace r {
     export interface ValidationMeta {
-        table?: string;
-        column?: string;
-        property?: string;
-        isInsert?: boolean;
+        table: string;
+        column: string;
+        property: string;
+        isInsert: boolean;
     }
 
     function table(name: string): Table;
@@ -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

@@ -637,10 +637,10 @@ type JsonOf<T> = {
 };
 
 interface ValidationMeta {
-	table?: string;
-	column?: string;
-	property?: string;
-	isInsert?: boolean;
+	table: string;
+	column: string;
+	property: string;
+	isInsert: boolean;
 }
 
 interface ColumnType<M> {
@@ -659,90 +659,90 @@ interface ColumnType<M> {
 
 type UuidValidator<M> = M extends NotNull
 	? {
-		validate(validator: (value: string, meta?: ValidationMeta) => void): UuidColumnTypeDef<M>;
+		validate(validator: (value: string, meta: ValidationMeta) => void): UuidColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: string | null, meta?: ValidationMeta) => void
+			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, meta: ValidationMeta) => void): StringColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: string | null, meta?: ValidationMeta) => void
+			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, meta: ValidationMeta) => void): NumericColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: number | null, meta?: ValidationMeta) => void
+			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, meta: ValidationMeta) => void): BigIntColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: bigint | null, meta?: ValidationMeta) => void
+			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, meta: ValidationMeta) => void): BinaryColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: string | null, meta?: ValidationMeta) => void
+			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, meta: ValidationMeta) => void): BooleanColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: boolean | null, meta?: ValidationMeta) => void
+			validator: (value?: boolean | null, meta: ValidationMeta) => void
 		): BooleanColumnTypeDef<M>;
 	};
 type JSONValidator<M> = M extends NotNull
 	? {
 		validate(
-			validator: (value: ToJsonType<M>, meta?: ValidationMeta) => void
+			validator: (value: ToJsonType<M>, meta: ValidationMeta) => void
 		): JSONColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: ToJsonType<M> | null, meta?: ValidationMeta) => void
+			validator: (value?: ToJsonType<M> | null, meta: ValidationMeta) => void
 		): JSONColumnTypeDef<M>;
 	};
 type DateValidator<M> = M extends NotNull
 	? {
 		validate(
-			validator: (value: string | Date, meta?: ValidationMeta) => void
+			validator: (value: string | Date, meta: ValidationMeta) => void
 		): DateColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: string | Date | null, meta?: ValidationMeta) => void
+			validator: (value?: string | Date | null, meta: ValidationMeta) => void
 		): DateColumnTypeDef<M>;
 	};
 
 type DateWithTimeZoneValidator<M> = M extends NotNull
 	? {
 		validate(
-			validator: (value: string | Date, meta?: ValidationMeta) => void
+			validator: (value: string | Date, meta: ValidationMeta) => void
 		): DateWithTimeZoneColumnTypeDef<M>;
 	}
 	: {
 		validate(
-			validator: (value?: string | Date | null, meta?: ValidationMeta) => void
+			validator: (value?: string | Date | null, meta: ValidationMeta) => void
 		): DateWithTimeZoneColumnTypeDef<M>;
 	};
 

package/src/table/column.js

@@ -135,7 +135,7 @@ function defineColumn(column, table) {
 	c.notNullExceptInsert = function() {
 		column._notNullExceptInsert = true;
 		function validate(value, meta) {
-			if (meta?.isInsert)
+			if (meta.isInsert)
 				return;
 			if (value === undefined || value === null)
 				throw new Error(`Column ${column.alias} cannot be null or undefined`);

package/src/table/resultToRows/newDecodeDbRow.js

@@ -48,7 +48,7 @@ function newDecodeDbRow(table, dbRow, filteredAliases, shouldValidate, isInsert)
 				value = purify(value);
 				this._dbRow[key] = value;
 				if (column.validate)
-					column.validate(value, { table: table._dbName, column: column._dbName, property: column.alias });
+					column.validate(value, { table: table._dbName, column: column._dbName, property: column.alias, isInsert: false });
 				updateField(this._context, table, column, this);
 				let emit = this._emitColumnChanged[name];
 				if (emit)