Add type for hook functions

Author: icebob

index.d.ts

@@ -69,6 +69,18 @@ declare module "@moleculer/database" {
 
 	export type EntityChangedEventType = "broadcast" | "emit" | null;
 
+	// Hook function type for field lifecycle hooks
+	export type HookCustomFunctionArgument<TValue = any, TEntity = any> = {
+		ctx: Context<any, any>;
+		value: TValue;
+		params: any;
+		field: BaseFieldDefinition;
+		id?: any;
+		operation: "create" | "update" | "replace" | "remove";
+		entity?: TEntity;
+		root?: any;
+	};
+
 	export interface PopulateDefinition {
 		/** Service name for populating */
 		service?: string;
@@ -121,7 +133,7 @@ declare module "@moleculer/database" {
 		/** Transformation function when getting value */
 		get?: (value: any, entity: any, field: BaseFieldDefinition, ctx: Context<any, any>) => any;
 		/** Transformation function when setting value */
-		set?: (value: any, entity: any, field: BaseFieldDefinition, ctx: Context<any, any>) => any;
+		set?: (args: HookCustomFunctionArgument) => any;
 		/** Custom validation function */
 		validate?:
 			| string
@@ -132,33 +144,13 @@ declare module "@moleculer/database" {
 					ctx: Context<any, any>
 			  ) => Promise<boolean | string>);
 		/** Lifecycle hook: called when entity is created */
-		onCreate?: (
-			value: any,
-			entity: any,
-			field: BaseFieldDefinition,
-			ctx: Context<any, any>
-		) => any;
+		onCreate?: (args: HookCustomFunctionArgument) => any | any;
 		/** Lifecycle hook: called when entity is updated */
-		onUpdate?: (
-			value: any,
-			entity: any,
-			field: BaseFieldDefinition,
-			ctx: Context<any, any>
-		) => any;
+		onUpdate?: (args: HookCustomFunctionArgument) => any | any;
 		/** Lifecycle hook: called when entity is replaced */
-		onReplace?: (
-			value: any,
-			entity: any,
-			field: BaseFieldDefinition,
-			ctx: Context<any, any>
-		) => any;
+		onReplace?: (args: HookCustomFunctionArgument) => any | any;
 		/** Lifecycle hook: called when entity is removed (enables soft delete) */
-		onRemove?: (
-			value: any,
-			entity: any,
-			field: BaseFieldDefinition,
-			ctx: Context<any, any>
-		) => any;
+		onRemove?: (args: HookCustomFunctionArgument) => any | any;
 	}
 
 	export interface StringFieldDefinition extends BaseFieldDefinition {

src/validation.js

@@ -406,24 +406,6 @@ module.exports = function (mixinOpts) {
 					// Virtual field
 					if (field.virtual) return;
 
-					// Custom formatter (can be async)
-					// Syntax: `set: (value, entity, field, ctx) => value.toUpperCase()`
-					if (field.set) {
-						value = await this._callCustomFunction(field.set, [
-							{
-								ctx,
-								value,
-								params,
-								field,
-								id: opts.id,
-								operation: type,
-								entity: oldEntity,
-								root: opts.root || params
-							}
-						]);
-						return setValue(field, value);
-					}
-
 					const customArgs = [
 						{
 							ctx,
@@ -437,6 +419,13 @@ module.exports = function (mixinOpts) {
 						}
 					];
 
+					// Custom formatter (can be async)
+					// Syntax: `set: (value, entity, field, ctx) => value.toUpperCase()`
+					if (field.set) {
+						value = await this._callCustomFunction(field.set, customArgs);
+						return setValue(field, value);
+					}
+
 					// Handlers
 					if (!opts.skipOnHooks) {
 						if (type == "create" && field.onCreate) {

test/typescript/index.ts

@@ -43,7 +43,8 @@ import {
 	generateFieldValidatorSchema,
 	DatabaseServiceSettings,
 	DatabaseMethods,
-	DatabaseLocalVariables
+	DatabaseLocalVariables,
+	HookCustomFunctionArgument
 } from "@moleculer/database";
 
 // =============================================================================
@@ -155,12 +156,12 @@ const customField: CustomFieldDefinition = {
 // Test field definitions with lifecycle hooks
 const fieldWithHooks: FieldDefinition = {
 	type: "string",
-	onCreate: (value: any, entity: any, field: FieldDefinition, ctx: Context) => value || "default",
-	onUpdate: (value: any, entity: any, field: FieldDefinition, ctx: Context) => value,
-	onReplace: (value: any, entity: any, field: FieldDefinition, ctx: Context) => value,
-	onRemove: (value: any, entity: any, field: FieldDefinition, ctx: Context) => null,
+	onCreate: ({ value }) => value || "default",
+	onUpdate: ({ value }) => value,
+	onReplace: ({ value }) => value,
+	onRemove: () => null,
 	get: (value: any, entity: any, field: FieldDefinition, ctx: Context) => value,
-	set: (value: any, entity: any, field: FieldDefinition, ctx: Context) => value,
+	set: ({ value }) => value,
 	validate: async (value: any, entity: any, field: FieldDefinition, ctx: Context) => {
 		return typeof value === "string" && value.length > 0;
 	}
@@ -850,7 +851,7 @@ const multiTenantServiceSchema: ServiceSchema<
 			tenantId: {
 				type: "string",
 				required: true,
-				set: (value: any, entity: any, field: FieldDefinition, ctx: Context) => {
+				set: ({ value, ctx }) => {
 					return (ctx.meta as any)?.tenantId || value;
 				}
 			}
@@ -896,7 +897,7 @@ const complexFields: Fields = {
 		trim: true,
 		lowercase: true,
 		alphanum: false,
-		set: (value: any) => value?.toString().toLowerCase().replace(/\s+/g, "-")
+		set: ({ value }) => value?.toString().toLowerCase().replace(/\s+/g, "-")
 	},
 
 	// Number field with validation
@@ -975,18 +976,18 @@ const complexFields: Fields = {
 	auditInfo: {
 		type: "object",
 		readonly: true,
-		onCreate: (value: any, entity: any, field: FieldDefinition, ctx: Context) => ({
+		onCreate: ({ ctx }: HookCustomFunctionArgument) => ({
 			createdBy: (ctx.meta as any)?.user?.id,
 			createdAt: Date.now(),
 			version: 1
 		}),
-		onUpdate: (value: any, entity: any, field: FieldDefinition, ctx: Context) => ({
+		onUpdate: ({ value, ctx }: HookCustomFunctionArgument) => ({
 			...value,
 			updatedBy: (ctx.meta as any)?.user?.id,
 			updatedAt: Date.now(),
 			version: (value.version || 0) + 1
 		}),
-		onRemove: (value: any, entity: any, field: FieldDefinition, ctx: Context) => ({
+		onRemove: ({ value, ctx }: HookCustomFunctionArgument) => ({
 			...value,
 			deletedBy: (ctx.meta as any)?.user?.id,
 			deletedAt: Date.now()