orange-orm 5.2.2 → 5.2.3-beta2

package/README.md

@@ -2058,6 +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 a metadata object with <code>table</code>, <code>column</code>, <code>property</code>, and <code>isInsert</code>.</p>
 
 <sub>📄 map.ts</sub>
 ```ts
@@ -2075,9 +2076,9 @@ let petSchema = {
     }
 };
 
-function validateName(value?: string) {
+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');
+    throw new Error(`Length cannot exceed 10 characters in ${meta.table}.${meta.column}`);
 }
 
 const map = orange.map(x => ({
@@ -2110,9 +2111,9 @@ let petSchema = {
     }
 };
 
-function validateName(value) {
+function validateName(value, meta) {
   if (value && value.length > 10)
-    throw new Error('Length cannot exceed 10 characters');
+    throw new Error(`Length cannot exceed 10 characters in ${meta.table}.${meta.column}`);
 }
 
 const map = orange.map(x => ({

package/SKILL.md

@@ -6,6 +6,10 @@
 > Supports: PostgreSQL, SQLite, MySQL, MS SQL, Oracle, SAP ASE, PGlite, Cloudflare D1.
 > Works in the browser via Express/Hono adapters.
 
+## Repository maintenance note
+
+- Treat `dist/index.mjs` and `dist/index.browser.mjs` as generated build output from the build command, not as source files to review or edit directly unless the task explicitly targets build artifacts.
+
 ---
 
 ## Table of Contents

package/dist/index.browser.mjs

@@ -6391,8 +6391,8 @@ function requireColumn () {
 
 		c.notNullExceptInsert = function() {
 			column._notNullExceptInsert = true;
-			function validate(value, _row, isInsert) {
-				if (isInsert)
+			function validate(value, meta) {
+				if (meta.isInsert)
 					return;
 				if (value === undefined || value === null)
 					throw new Error(`Column ${column.alias} cannot be null or undefined`);
@@ -6406,12 +6406,12 @@ function requireColumn () {
 			if (previousValue)
 				column.validate = nestedValidate;
 			else
-				column.validate = value;
+				column.validate = invokeValidate;
 
 			function nestedValidate() {
 				try {
 					previousValue.apply(null, arguments);
-					value.apply(null, arguments);
+					invokeValidate.apply(null, arguments);
 				}
 				catch (e) {
 					const error = new Error(e.message || e);
@@ -6420,6 +6420,10 @@ function requireColumn () {
 					throw error;
 				}
 			}
+
+			function invokeValidate(inputValue, meta) {
+				value(inputValue, meta);
+			}
 			return c;
 		};
 
@@ -8609,7 +8613,7 @@ function requireNewDecodeDbRow () {
 					value = purify(value);
 					this._dbRow[key] = value;
 					if (column.validate)
-						column.validate(value, this._dbRow);
+						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)
@@ -8765,7 +8769,7 @@ function requireNewDecodeDbRow () {
 				if (row[key] !== undefined && !isInsert)
 					row[key] = columns[i].decode(context, row[key]);
 				if (shouldValidate && columns[i].validate)
-					columns[i].validate(row[key], row, isInsert);
+					columns[i].validate(row[key], { table: table._dbName, column: columns[i]._dbName, property: columns[i].alias, isInsert });
 			}
 			let target = new Row(context, row);
 			const p = new Proxy(target, {

package/dist/index.mjs

@@ -6392,8 +6392,8 @@ function requireColumn () {
 
 		c.notNullExceptInsert = function() {
 			column._notNullExceptInsert = true;
-			function validate(value, _row, isInsert) {
-				if (isInsert)
+			function validate(value, meta) {
+				if (meta.isInsert)
 					return;
 				if (value === undefined || value === null)
 					throw new Error(`Column ${column.alias} cannot be null or undefined`);
@@ -6407,12 +6407,12 @@ function requireColumn () {
 			if (previousValue)
 				column.validate = nestedValidate;
 			else
-				column.validate = value;
+				column.validate = invokeValidate;
 
 			function nestedValidate() {
 				try {
 					previousValue.apply(null, arguments);
-					value.apply(null, arguments);
+					invokeValidate.apply(null, arguments);
 				}
 				catch (e) {
 					const error = new Error(e.message || e);
@@ -6421,6 +6421,10 @@ function requireColumn () {
 					throw error;
 				}
 			}
+
+			function invokeValidate(inputValue, meta) {
+				value(inputValue, meta);
+			}
 			return c;
 		};
 
@@ -8610,7 +8614,7 @@ function requireNewDecodeDbRow () {
 					value = purify(value);
 					this._dbRow[key] = value;
 					if (column.validate)
-						column.validate(value, this._dbRow);
+						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)
@@ -8766,7 +8770,7 @@ function requireNewDecodeDbRow () {
 				if (row[key] !== undefined && !isInsert)
 					row[key] = columns[i].decode(context, row[key]);
 				if (shouldValidate && columns[i].validate)
-					columns[i].validate(row[key], row, isInsert);
+					columns[i].validate(row[key], { table: table._dbName, column: columns[i]._dbName, property: columns[i].alias, isInsert });
 			}
 			let target = new Row(context, row);
 			const p = new Proxy(target, {

package/package.json

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

package/src/index.d.ts

@@ -10,6 +10,12 @@ import type { Filter as MapFilter, RawFilter as MapRawFilter, Pool as MapPool, P
 declare function r(config: r.Config): unknown;
 
 declare namespace r {
+    export interface ValidationMeta {
+        table: string;
+        column: string;
+        property: string;
+        isInsert: boolean;
+    }
 
     function table(name: string): Table;
     function close(): Promise<void>;
@@ -94,7 +100,7 @@ declare namespace r {
         date(): DateColumnDef;
     }
     export interface DateColumnDef {
-        validate(validator: (value?: Date | string, row?: object) => void): DateColumnDef;
+        validate(validator: (value?: Date | string, meta: ValidationMeta) => void): DateColumnDef;
         notNull(): DateColumnNotNullDef;
         JSONSchema(schema: object, options?: Options): DateColumnDef;
         serializable(value: boolean): DateColumnDef;
@@ -104,7 +110,7 @@ declare namespace r {
     }
 
     export interface DateColumnNotNullDef {
-        validate(validator: (value: Date | string, row?: object) => 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;
@@ -113,7 +119,7 @@ declare namespace r {
     }
 
     export interface BinaryColumnDef {
-        validate(validator: (value?: Buffer | string, row?: object) => void): BinaryColumnDef;
+        validate(validator: (value?: Buffer | string, meta: ValidationMeta) => void): BinaryColumnDef;
         notNull(): BinaryColumnNotNullDef;
         JSONSchema(schema: object, options?: Options): BinaryColumnDef;
         serializable(value: boolean): BinaryColumnDef;
@@ -123,7 +129,7 @@ declare namespace r {
     }
 
     export interface BinaryColumnNotNullDef {
-        validate(validator: (value: Buffer | string, row?: object) => 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;
@@ -132,7 +138,7 @@ declare namespace r {
     }
 
     export interface ColumnOf<T> {
-        validate(validator: (value?: T, row?: object) => 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>;
@@ -142,7 +148,7 @@ declare namespace r {
     }
 
     export interface ColumnNotNullOf<T> {
-        validate(validator: (value: T, row?: object) => 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

@@ -636,6 +636,18 @@ type JsonOf<T> = {
 	type: T;
 };
 
+interface ValidationMeta {
+	table: string;
+	column: string;
+	property: string;
+	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>;
@@ -650,94 +662,15 @@ interface ColumnType<M> {
 	jsonOf<T>(helper: T): JSONColumnTypeDef<M & JSONColumnSymbol & JsonOf<T>>;
 }
 
-type UuidValidator<M> = M extends NotNull
-	? {
-		validate(validator: (value: string) => void): UuidColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: string | null) => void
-		): UuidColumnTypeDef<M>;
-	};
-type StringValidator<M> = M extends NotNull
-	? {
-		validate(validator: (value: string) => void): StringColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: string | null) => void
-		): StringColumnTypeDef<M>;
-	};
-type NumericValidator<M> = M extends NotNull
-	? {
-		validate(validator: (value: number) => void): NumericColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: number | null) => void
-		): NumericColumnTypeDef<M>;
-	};
-type BigIntValidator<M> = M extends NotNull
-	? {
-		validate(validator: (value: bigint) => void): BigIntColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: bigint | null) => void
-		): BigIntColumnTypeDef<M>;
-	};
-type BinaryValidator<M> = M extends NotNull
-	? {
-		validate(validator: (value: string) => void): BinaryColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: string | null) => void
-		): BinaryColumnTypeDef<M>;
-	};
-type BooleanValidator<M> = M extends NotNull
-	? {
-		validate(validator: (value: boolean) => void): BooleanColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: boolean | null) => void
-		): BooleanColumnTypeDef<M>;
-	};
-type JSONValidator<M> = M extends NotNull
-	? {
-		validate(
-			validator: (value: ToJsonType<M>) => void
-		): JSONColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: ToJsonType<M> | null) => void
-		): JSONColumnTypeDef<M>;
-	};
-type DateValidator<M> = M extends NotNull
-	? {
-		validate(
-			validator: (value: string | Date) => void
-		): DateColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: string | Date | null) => void
-		): DateColumnTypeDef<M>;
-	};
-
-type DateWithTimeZoneValidator<M> = M extends NotNull
-	? {
-		validate(
-			validator: (value: string | Date) => void
-		): DateWithTimeZoneColumnTypeDef<M>;
-	}
-	: {
-		validate(
-			validator: (value?: string | Date | null) => void
-		): DateWithTimeZoneColumnTypeDef<M>;
-	};
+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 StringColumnTypeDef<M> = StringValidator<M> & {
 	enum<const V extends readonly string[]>(values: V): StringColumnTypeDef<M & EnumOf<V[number]>> & EnumOf<V[number]>;
@@ -856,7 +789,7 @@ type DateColumnTypeDef<M> = DateValidator<M> & {
 } & ColumnTypeOf<DateColumnType<M>> &
 	M;
 
-type DateWithTimeZoneColumnTypeDef<M> = DateValidator<M> & {
+type DateWithTimeZoneColumnTypeDef<M> = DateWithTimeZoneValidator<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>;

package/src/table/column.js

@@ -134,8 +134,8 @@ function defineColumn(column, table) {
 
 	c.notNullExceptInsert = function() {
 		column._notNullExceptInsert = true;
-		function validate(value, _row, isInsert) {
-			if (isInsert)
+		function validate(value, meta) {
+			if (meta.isInsert)
 				return;
 			if (value === undefined || value === null)
 				throw new Error(`Column ${column.alias} cannot be null or undefined`);
@@ -149,12 +149,12 @@ function defineColumn(column, table) {
 		if (previousValue)
 			column.validate = nestedValidate;
 		else
-			column.validate = value;
+			column.validate = invokeValidate;
 
 		function nestedValidate() {
 			try {
 				previousValue.apply(null, arguments);
-				value.apply(null, arguments);
+				invokeValidate.apply(null, arguments);
 			}
 			catch (e) {
 				const error = new Error(e.message || e);
@@ -163,6 +163,10 @@ function defineColumn(column, table) {
 				throw error;
 			}
 		}
+
+		function invokeValidate(inputValue, meta) {
+			value(inputValue, meta);
+		}
 		return c;
 	};
 

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, this._dbRow);
+					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)
@@ -204,7 +204,7 @@ function newDecodeDbRow(table, dbRow, filteredAliases, shouldValidate, isInsert)
 			if (row[key] !== undefined && !isInsert)
 				row[key] = columns[i].decode(context, row[key]);
 			if (shouldValidate && columns[i].validate)
-				columns[i].validate(row[key], row, isInsert);
+				columns[i].validate(row[key], { table: table._dbName, column: columns[i]._dbName, property: columns[i].alias, isInsert });
 		}
 		let target = new Row(context, row);
 		const p = new Proxy(target, {