authhero 4.106.1 → 4.107.0

package/dist/authhero.d.ts

@@ -42387,17 +42387,31 @@ export declare const hookInsertSchema: z.ZodUnion<[
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
 		hook_id: z.ZodOptional<z.ZodString>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		url: string;
 		enabled: boolean;
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 		synchronous: boolean;
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
 	}, {
 		url: string;
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
@@ -42416,17 +42430,31 @@ export declare const hookInsertSchema: z.ZodUnion<[
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
 		hook_id: z.ZodOptional<z.ZodString>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		enabled: boolean;
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 		synchronous: boolean;
 		form_id: string;
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
 	}, {
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 		form_id: string;
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
@@ -42447,17 +42475,31 @@ export declare const hookInsertSchema: z.ZodUnion<[
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
 		hook_id: z.ZodOptional<z.ZodString>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		enabled: boolean;
 		trigger_id: "post-user-registration" | "post-user-login" | "post-user-update" | "credentials-exchange";
 		synchronous: boolean;
 		template_id: "ensure-username" | "set-preferred-username" | "account-linking";
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
 	}, {
 		trigger_id: "post-user-registration" | "post-user-login" | "post-user-update" | "credentials-exchange";
 		template_id: "ensure-username" | "set-preferred-username" | "account-linking";
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
@@ -42474,17 +42516,31 @@ export declare const hookInsertSchema: z.ZodUnion<[
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
 		hook_id: z.ZodOptional<z.ZodString>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		code_id: string;
 		enabled: boolean;
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 		synchronous: boolean;
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
 	}, {
 		code_id: string;
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 		hook_id?: string | undefined;
@@ -42509,6 +42565,18 @@ export declare const hookSchema: z.ZodUnion<[
 		enabled: z.ZodDefault<z.ZodBoolean>;
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		created_at: string;
 		updated_at: string;
@@ -42517,6 +42585,7 @@ export declare const hookSchema: z.ZodUnion<[
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 		synchronous: boolean;
 		hook_id: string;
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 	}, {
 		created_at: string;
@@ -42525,6 +42594,7 @@ export declare const hookSchema: z.ZodUnion<[
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 		hook_id: string;
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 	}>,
@@ -42544,6 +42614,18 @@ export declare const hookSchema: z.ZodUnion<[
 		enabled: z.ZodDefault<z.ZodBoolean>;
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		created_at: string;
 		updated_at: string;
@@ -42552,6 +42634,7 @@ export declare const hookSchema: z.ZodUnion<[
 		synchronous: boolean;
 		hook_id: string;
 		form_id: string;
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 	}, {
 		created_at: string;
@@ -42560,6 +42643,7 @@ export declare const hookSchema: z.ZodUnion<[
 		hook_id: string;
 		form_id: string;
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 	}>,
@@ -42581,6 +42665,18 @@ export declare const hookSchema: z.ZodUnion<[
 		enabled: z.ZodDefault<z.ZodBoolean>;
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		created_at: string;
 		updated_at: string;
@@ -42589,6 +42685,7 @@ export declare const hookSchema: z.ZodUnion<[
 		synchronous: boolean;
 		hook_id: string;
 		template_id: "ensure-username" | "set-preferred-username" | "account-linking";
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 	}, {
 		created_at: string;
@@ -42597,6 +42694,7 @@ export declare const hookSchema: z.ZodUnion<[
 		hook_id: string;
 		template_id: "ensure-username" | "set-preferred-username" | "account-linking";
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 	}>,
@@ -42614,6 +42712,18 @@ export declare const hookSchema: z.ZodUnion<[
 		enabled: z.ZodDefault<z.ZodBoolean>;
 		synchronous: z.ZodDefault<z.ZodBoolean>;
 		priority: z.ZodOptional<z.ZodNumber>;
+		/**
+		 * Free-form key/value bag for hook properties. Two well-known keys:
+		 *
+		 * - `inheritable: true` — when set on a hook on the control-plane tenant,
+		 *   the multi-tenancy sync surfaces this hook to sub-tenants (Phase 2).
+		 * - Template-specific options. Templates read their config here, e.g.
+		 *   `account-linking` reads `copy_user_metadata: true` to merge secondary
+		 *   user_metadata into the primary on link.
+		 *
+		 * Everything else is opaque to the runtime. Persisted as JSON.
+		 */
+		metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 	}, "strip", z.ZodTypeAny, {
 		created_at: string;
 		updated_at: string;
@@ -42622,6 +42732,7 @@ export declare const hookSchema: z.ZodUnion<[
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 		synchronous: boolean;
 		hook_id: string;
+		metadata?: Record<string, unknown> | undefined;
 		priority?: number | undefined;
 	}, {
 		created_at: string;
@@ -42630,6 +42741,7 @@ export declare const hookSchema: z.ZodUnion<[
 		trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 		hook_id: string;
 		enabled?: boolean | undefined;
+		metadata?: Record<string, unknown> | undefined;
 		synchronous?: boolean | undefined;
 		priority?: number | undefined;
 	}>
@@ -53288,6 +53400,18 @@ export interface AccountLinkingOptions {
 	 * @default true
 	 */
 	requireVerifiedEmail?: boolean;
+	/**
+	 * When the link is performed, merge the secondary user's `user_metadata`
+	 * into the primary's. Existing keys on the primary are NOT overwritten —
+	 * only keys absent from the primary are filled in from the secondary, so
+	 * the primary remains the source of truth for any conflicting values.
+	 *
+	 * `app_metadata` is intentionally never copied to avoid auto-merging into
+	 * the admin-only namespace.
+	 *
+	 * @default false
+	 */
+	copyUserMetadata?: boolean;
 }
 /**
  * Trigger-agnostic event handler used by all `account-linking` template
@@ -60884,6 +61008,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -60893,6 +61020,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					form_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -60902,6 +61032,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					template_id: "ensure-username" | "set-preferred-username" | "account-linking";
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -60911,6 +61044,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				})[] | {
 					length: number;
@@ -60924,6 +61060,9 @@ export declare function init(config: AuthHeroConfig): {
 						trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 						synchronous: boolean;
 						hook_id: string;
+						metadata?: {
+							[x: string]: import("hono/utils/types").JSONValue;
+						} | undefined;
 						priority?: number | undefined | undefined;
 					} | {
 						created_at: string;
@@ -60933,6 +61072,9 @@ export declare function init(config: AuthHeroConfig): {
 						synchronous: boolean;
 						hook_id: string;
 						form_id: string;
+						metadata?: {
+							[x: string]: import("hono/utils/types").JSONValue;
+						} | undefined;
 						priority?: number | undefined | undefined;
 					} | {
 						created_at: string;
@@ -60942,6 +61084,9 @@ export declare function init(config: AuthHeroConfig): {
 						synchronous: boolean;
 						hook_id: string;
 						template_id: "ensure-username" | "set-preferred-username" | "account-linking";
+						metadata?: {
+							[x: string]: import("hono/utils/types").JSONValue;
+						} | undefined;
 						priority?: number | undefined | undefined;
 					} | {
 						created_at: string;
@@ -60951,6 +61096,9 @@ export declare function init(config: AuthHeroConfig): {
 						trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 						synchronous: boolean;
 						hook_id: string;
+						metadata?: {
+							[x: string]: import("hono/utils/types").JSONValue;
+						} | undefined;
 						priority?: number | undefined | undefined;
 					})[];
 					total?: number | undefined;
@@ -60971,6 +61119,7 @@ export declare function init(config: AuthHeroConfig): {
 						url: string;
 						trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 						enabled?: boolean | undefined;
+						metadata?: Record<string, unknown> | undefined;
 						synchronous?: boolean | undefined;
 						priority?: number | undefined;
 						hook_id?: string | undefined;
@@ -60978,6 +61127,7 @@ export declare function init(config: AuthHeroConfig): {
 						trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 						form_id: string;
 						enabled?: boolean | undefined;
+						metadata?: Record<string, unknown> | undefined;
 						synchronous?: boolean | undefined;
 						priority?: number | undefined;
 						hook_id?: string | undefined;
@@ -60985,6 +61135,7 @@ export declare function init(config: AuthHeroConfig): {
 						trigger_id: "post-user-registration" | "post-user-login" | "post-user-update" | "credentials-exchange";
 						template_id: "ensure-username" | "set-preferred-username" | "account-linking";
 						enabled?: boolean | undefined;
+						metadata?: Record<string, unknown> | undefined;
 						synchronous?: boolean | undefined;
 						priority?: number | undefined;
 						hook_id?: string | undefined;
@@ -60992,6 +61143,7 @@ export declare function init(config: AuthHeroConfig): {
 						code_id: string;
 						trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 						enabled?: boolean | undefined;
+						metadata?: Record<string, unknown> | undefined;
 						synchronous?: boolean | undefined;
 						priority?: number | undefined;
 						hook_id?: string | undefined;
@@ -61005,6 +61157,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61014,6 +61169,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					form_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61023,6 +61181,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					template_id: "ensure-username" | "set-preferred-username" | "account-linking";
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61032,6 +61193,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				};
 				outputFormat: "json";
@@ -61075,6 +61239,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61084,6 +61251,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					form_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61093,6 +61263,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					template_id: "ensure-username" | "set-preferred-username" | "account-linking";
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61102,6 +61275,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				};
 				outputFormat: "json";
@@ -61141,6 +61317,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "post-user-update" | "validate-registration-username" | "pre-user-deletion" | "post-user-deletion";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61150,6 +61329,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					form_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61159,6 +61341,9 @@ export declare function init(config: AuthHeroConfig): {
 					synchronous: boolean;
 					hook_id: string;
 					template_id: "ensure-username" | "set-preferred-username" | "account-linking";
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				} | {
 					created_at: string;
@@ -61168,6 +61353,9 @@ export declare function init(config: AuthHeroConfig): {
 					trigger_id: "pre-user-registration" | "post-user-registration" | "post-user-login" | "credentials-exchange";
 					synchronous: boolean;
 					hook_id: string;
+					metadata?: {
+						[x: string]: import("hono/utils/types").JSONValue;
+					} | undefined;
 					priority?: number | undefined | undefined;
 				};
 				outputFormat: "json";