@gusto/embedded-react-sdk 0.46.3 → 0.47.0

package/dist/partner-hook-utils/form/getFieldWithOptions.d.ts

@@ -1,2 +1,13 @@
 import { FieldMetadataWithOptions, FieldsMetadata } from '../types';
+/**
+ * Narrows a {@link FieldsMetadata} entry to {@link FieldMetadataWithOptions} when
+ * the field carries an `options` list.
+ *
+ * @typeParam TEntry - Shape of the underlying records that produced the options.
+ * @param metadata - Map of field metadata indexed by form-field name.
+ * @param name - Name of the field to look up.
+ * @returns The field's metadata typed as {@link FieldMetadataWithOptions}, or
+ *   `undefined` when the field is absent or has no `options` list.
+ * @internal
+ */
 export declare function getFieldWithOptions<TEntry = unknown>(metadata: FieldsMetadata, name: string): FieldMetadataWithOptions<TEntry> | undefined;

package/dist/partner-hook-utils/form/getFieldWithOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"getFieldWithOptions.js","sources":["../../../src/partner-hook-utils/form/getFieldWithOptions.ts"],"sourcesContent":["import type { FieldMetadataWithOptions, FieldsMetadata } from '../types'\n\nexport function getFieldWithOptions<TEntry = unknown>(\n  metadata: FieldsMetadata,\n  name: string,\n): FieldMetadataWithOptions<TEntry> | undefined {\n  const field = metadata[name]\n  if (field && 'options' in field) return field as FieldMetadataWithOptions<TEntry>\n  return undefined\n}\n"],"names":["getFieldWithOptions","metadata","name","field"],"mappings":"AAEO,SAASA,EACdC,GACAC,GAC8C;AAC9C,QAAMC,IAAQF,EAASC,CAAI;AAC3B,MAAIC,KAAS,aAAaA,EAAO,QAAOA;AAE1C;"}
+{"version":3,"file":"getFieldWithOptions.js","sources":["../../../src/partner-hook-utils/form/getFieldWithOptions.ts"],"sourcesContent":["import type { FieldMetadataWithOptions, FieldsMetadata } from '../types'\n\n/**\n * Narrows a {@link FieldsMetadata} entry to {@link FieldMetadataWithOptions} when\n * the field carries an `options` list.\n *\n * @typeParam TEntry - Shape of the underlying records that produced the options.\n * @param metadata - Map of field metadata indexed by form-field name.\n * @param name - Name of the field to look up.\n * @returns The field's metadata typed as {@link FieldMetadataWithOptions}, or\n *   `undefined` when the field is absent or has no `options` list.\n * @internal\n */\nexport function getFieldWithOptions<TEntry = unknown>(\n  metadata: FieldsMetadata,\n  name: string,\n): FieldMetadataWithOptions<TEntry> | undefined {\n  const field = metadata[name]\n  if (field && 'options' in field) return field as FieldMetadataWithOptions<TEntry>\n  return undefined\n}\n"],"names":["getFieldWithOptions","metadata","name","field"],"mappings":"AAaO,SAASA,EACdC,GACAC,GAC8C;AAC9C,QAAMC,IAAQF,EAASC,CAAI;AAC3B,MAAIC,KAAS,aAAaA,EAAO,QAAOA;AAE1C;"}

package/dist/partner-hook-utils/form/getFormSubmissionValues.d.ts

@@ -10,9 +10,18 @@ import { ZodTypeAny } from 'zod';
  * (e.g. required fields are empty, cross-field rules fail). This is safe to call
  * at any time — it never throws.
  *
- * **Side effects:** None. `getValues()` is a synchronous read from react-hook-form's
+ * @remarks
+ * Side effects: none. `getValues()` is a synchronous read from react-hook-form's
  * internal store — it does not trigger re-renders, mutate form state, or update
  * validation errors. `safeParse()` is a pure validation/transform that creates
  * a new object without mutating the input.
+ *
+ * @typeParam TFormData - Shape of the raw form values managed by react-hook-form.
+ * @typeParam TFormOutputs - Shape of the parsed/transformed values produced by the Zod schema.
+ * @param formMethods - `useForm` return value the getter reads values from.
+ * @param schema - Zod schema applied to validate and transform the current values.
+ * @returns A zero-arg function returning the parsed values, or `undefined` when
+ *   the current form state fails validation.
+ * @internal
  */
 export declare function createGetFormSubmissionValues<TFormData extends FieldValues, TFormOutputs>(formMethods: UseFormReturn<TFormData, unknown, TFormOutputs>, schema: ZodTypeAny): () => TFormOutputs | undefined;

package/dist/partner-hook-utils/form/getFormSubmissionValues.js.map

@@ -1 +1 @@
-{"version":3,"file":"getFormSubmissionValues.js","sources":["../../../src/partner-hook-utils/form/getFormSubmissionValues.ts"],"sourcesContent":["import type { FieldValues, UseFormReturn } from 'react-hook-form'\nimport type { ZodTypeAny } from 'zod'\n\n/**\n * Creates a typed getter that returns the current form values parsed through\n * the Zod schema. The result matches what `handleSubmit` would provide to its\n * valid callback — all preprocessing transforms (e.g. string→boolean coercion)\n * are applied.\n *\n * Returns `undefined` when the current form state does not satisfy the schema\n * (e.g. required fields are empty, cross-field rules fail). This is safe to call\n * at any time — it never throws.\n *\n * **Side effects:** None. `getValues()` is a synchronous read from react-hook-form's\n * internal store — it does not trigger re-renders, mutate form state, or update\n * validation errors. `safeParse()` is a pure validation/transform that creates\n * a new object without mutating the input.\n */\nexport function createGetFormSubmissionValues<TFormData extends FieldValues, TFormOutputs>(\n  formMethods: UseFormReturn<TFormData, unknown, TFormOutputs>,\n  schema: ZodTypeAny,\n): () => TFormOutputs | undefined {\n  return () => {\n    const result = schema.safeParse(formMethods.getValues())\n    return result.success ? (result.data as TFormOutputs) : undefined\n  }\n}\n"],"names":["createGetFormSubmissionValues","formMethods","schema","result"],"mappings":"AAkBO,SAASA,EACdC,GACAC,GACgC;AAChC,SAAO,MAAM;AACX,UAAMC,IAASD,EAAO,UAAUD,EAAY,WAAW;AACvD,WAAOE,EAAO,UAAWA,EAAO,OAAwB;AAAA,EAC1D;AACF;"}
+{"version":3,"file":"getFormSubmissionValues.js","sources":["../../../src/partner-hook-utils/form/getFormSubmissionValues.ts"],"sourcesContent":["import type { FieldValues, UseFormReturn } from 'react-hook-form'\nimport type { ZodTypeAny } from 'zod'\n\n/**\n * Creates a typed getter that returns the current form values parsed through\n * the Zod schema. The result matches what `handleSubmit` would provide to its\n * valid callback — all preprocessing transforms (e.g. string→boolean coercion)\n * are applied.\n *\n * Returns `undefined` when the current form state does not satisfy the schema\n * (e.g. required fields are empty, cross-field rules fail). This is safe to call\n * at any time — it never throws.\n *\n * @remarks\n * Side effects: none. `getValues()` is a synchronous read from react-hook-form's\n * internal store — it does not trigger re-renders, mutate form state, or update\n * validation errors. `safeParse()` is a pure validation/transform that creates\n * a new object without mutating the input.\n *\n * @typeParam TFormData - Shape of the raw form values managed by react-hook-form.\n * @typeParam TFormOutputs - Shape of the parsed/transformed values produced by the Zod schema.\n * @param formMethods - `useForm` return value the getter reads values from.\n * @param schema - Zod schema applied to validate and transform the current values.\n * @returns A zero-arg function returning the parsed values, or `undefined` when\n *   the current form state fails validation.\n * @internal\n */\nexport function createGetFormSubmissionValues<TFormData extends FieldValues, TFormOutputs>(\n  formMethods: UseFormReturn<TFormData, unknown, TFormOutputs>,\n  schema: ZodTypeAny,\n): () => TFormOutputs | undefined {\n  return () => {\n    const result = schema.safeParse(formMethods.getValues())\n    return result.success ? (result.data as TFormOutputs) : undefined\n  }\n}\n"],"names":["createGetFormSubmissionValues","formMethods","schema","result"],"mappings":"AA2BO,SAASA,EACdC,GACAC,GACgC;AAChC,SAAO,MAAM;AACX,UAAMC,IAASD,EAAO,UAAUD,EAAY,WAAW;AACvD,WAAOE,EAAO,UAAWA,EAAO,OAAwB;AAAA,EAC1D;AACF;"}

package/dist/partner-hook-utils/form/index.d.ts

@@ -6,12 +6,5 @@ export { FormFieldsMetadataProvider } from './FormFieldsMetadataProvider';
 export { SDKFormProvider } from './SDKFormProvider';
 export { useDeriveFieldsMetadata } from './useDeriveFieldsMetadata';
 export { useFieldErrorMessage } from './useFieldErrorMessage';
-export { resolveFieldError } from './resolveFieldError';
-export { useHookFieldResolution } from './useHookFieldResolution';
-export type { FormMode, RequiredFieldRule, RequiredFieldConfig, OptionalFieldsToRequire, FieldsMetadataConfig, BuildFormSchemaResult, } from './buildFormSchema';
-export { composeSubmitHandler, type ComposeSubmitHandlerResult } from './composeSubmitHandler';
-export { createGetFormSubmissionValues } from './getFormSubmissionValues';
-export { useHookFormInternals } from './useHookFormInternals';
-export { useFieldElementRegistry, type FieldElementRegistry, } from '../../components/Common/Fields/hooks/fieldElementRegistry';
-export { FieldElementRegistryProvider } from '../../components/Common/Fields/hooks/FieldElementRegistryProvider';
+export { composeSubmitHandler } from './composeSubmitHandler';
 export { TextInputHookField, type TextInputHookFieldProps, SelectHookField, type SelectHookFieldProps, CheckboxHookField, type CheckboxHookFieldProps, NumberInputHookField, type NumberInputHookFieldProps, DatePickerHookField, type DatePickerHookFieldProps, RadioGroupHookField, type RadioGroupHookFieldProps, type TextInputProps, type SelectProps, type SelectOption, type CheckboxProps, type NumberInputProps, type DatePickerProps, type RadioGroupProps, type RadioGroupOption, SwitchHookField, type SwitchHookFieldProps, type SwitchProps, } from './fields';

package/dist/partner-hook-utils/form/preprocessors.d.ts

@@ -1,3 +1,31 @@
+/**
+ * Builds a `z.preprocess` transform that replaces `null`, `undefined`, and `NaN`
+ * numeric input with the provided fallback before validation.
+ *
+ * @param fallback - Number substituted when the input is missing or `NaN`.
+ * @returns A preprocessor that returns `fallback` for empty/`NaN` input and
+ *   passes other values through as `number`.
+ * @internal
+ */
 export declare function coerceNaN(fallback: number): (val: unknown) => number;
+/**
+ * `z.preprocess` transform that normalizes date inputs to an ISO date string
+ * (`YYYY-MM-DD`) or `null`.
+ *
+ * @param val - Raw value from a date picker — a `Date`, ISO string, or empty.
+ * @returns The date portion of a `Date`'s ISO string, `null` for empty input,
+ *   or the value cast to `string` otherwise.
+ * @internal
+ */
 export declare function coerceToISODate(val: unknown): string | null;
+/**
+ * `z.preprocess` transform that converts the string values produced by radio
+ * groups (`'true'` / `'false'`) into booleans.
+ *
+ * @param val - Raw value from a form control — typically `'true'`, `'false'`,
+ *   `boolean`, or `undefined`.
+ * @returns `true` for the string `'true'`, `false` for any other string,
+ *   or the value passed through unchanged when not a string.
+ * @internal
+ */
 export declare function coerceStringBoolean(val: unknown): boolean | undefined;

package/dist/partner-hook-utils/form/preprocessors.js.map

@@ -1 +1 @@
-{"version":3,"file":"preprocessors.js","sources":["../../../src/partner-hook-utils/form/preprocessors.ts"],"sourcesContent":["export function coerceNaN(fallback: number) {\n  return (val: unknown): number => {\n    if (val === undefined || val === null) return fallback\n    if (typeof val === 'number' && Number.isNaN(val)) return fallback\n    return val as number\n  }\n}\n\nexport function coerceToISODate(val: unknown): string | null {\n  if (val instanceof Date) return val.toISOString().split('T')[0]!\n  if (val === null || val === '' || val === undefined) return null\n  return val as string\n}\n\nexport function coerceStringBoolean(val: unknown): boolean | undefined {\n  if (typeof val === 'string') return val === 'true'\n  return val as boolean | undefined\n}\n"],"names":["coerceNaN","fallback","val","coerceToISODate","coerceStringBoolean"],"mappings":"AAAO,SAASA,EAAUC,GAAkB;AAC1C,SAAO,CAACC,MACmBA,KAAQ,QAC7B,OAAOA,KAAQ,YAAY,OAAO,MAAMA,CAAG,IAAUD,IAClDC;AAEX;AAEO,SAASC,EAAgBD,GAA6B;AAC3D,SAAIA,aAAe,OAAaA,EAAI,cAAc,MAAM,GAAG,EAAE,CAAC,IAC1DA,MAAQ,QAAQA,MAAQ,MAAMA,MAAQ,SAAkB,OACrDA;AACT;AAEO,SAASE,EAAoBF,GAAmC;AACrE,SAAI,OAAOA,KAAQ,WAAiBA,MAAQ,SACrCA;AACT;"}
+{"version":3,"file":"preprocessors.js","sources":["../../../src/partner-hook-utils/form/preprocessors.ts"],"sourcesContent":["/**\n * Builds a `z.preprocess` transform that replaces `null`, `undefined`, and `NaN`\n * numeric input with the provided fallback before validation.\n *\n * @param fallback - Number substituted when the input is missing or `NaN`.\n * @returns A preprocessor that returns `fallback` for empty/`NaN` input and\n *   passes other values through as `number`.\n * @internal\n */\nexport function coerceNaN(fallback: number) {\n  return (val: unknown): number => {\n    if (val === undefined || val === null) return fallback\n    if (typeof val === 'number' && Number.isNaN(val)) return fallback\n    return val as number\n  }\n}\n\n/**\n * `z.preprocess` transform that normalizes date inputs to an ISO date string\n * (`YYYY-MM-DD`) or `null`.\n *\n * @param val - Raw value from a date picker — a `Date`, ISO string, or empty.\n * @returns The date portion of a `Date`'s ISO string, `null` for empty input,\n *   or the value cast to `string` otherwise.\n * @internal\n */\nexport function coerceToISODate(val: unknown): string | null {\n  if (val instanceof Date) return val.toISOString().split('T')[0]!\n  if (val === null || val === '' || val === undefined) return null\n  return val as string\n}\n\n/**\n * `z.preprocess` transform that converts the string values produced by radio\n * groups (`'true'` / `'false'`) into booleans.\n *\n * @param val - Raw value from a form control — typically `'true'`, `'false'`,\n *   `boolean`, or `undefined`.\n * @returns `true` for the string `'true'`, `false` for any other string,\n *   or the value passed through unchanged when not a string.\n * @internal\n */\nexport function coerceStringBoolean(val: unknown): boolean | undefined {\n  if (typeof val === 'string') return val === 'true'\n  return val as boolean | undefined\n}\n"],"names":["coerceNaN","fallback","val","coerceToISODate","coerceStringBoolean"],"mappings":"AASO,SAASA,EAAUC,GAAkB;AAC1C,SAAO,CAACC,MACmBA,KAAQ,QAC7B,OAAOA,KAAQ,YAAY,OAAO,MAAMA,CAAG,IAAUD,IAClDC;AAEX;AAWO,SAASC,EAAgBD,GAA6B;AAC3D,SAAIA,aAAe,OAAaA,EAAI,cAAc,MAAM,GAAG,EAAE,CAAC,IAC1DA,MAAQ,QAAQA,MAAQ,MAAMA,MAAQ,SAAkB,OACrDA;AACT;AAYO,SAASE,EAAoBF,GAAmC;AACrE,SAAI,OAAOA,KAAQ,WAAiBA,MAAQ,SACrCA;AACT;"}

package/dist/partner-hook-utils/form/resolveFieldError.d.ts

@@ -1,4 +1,26 @@
 import { FieldErrors } from 'react-hook-form';
 import { ValidationMessages } from '../types';
 import { SDKError } from '../../types/sdkError';
+/**
+ * Resolves the display message for a single form field by combining
+ * client-side validation errors with field-scoped SDK errors.
+ *
+ * @remarks
+ * Client-side validation wins when the error code has a matching entry in
+ * `validationMessages`. Otherwise the first matching `fieldErrors` entry from
+ * `sdkErrors` is returned (field names are normalized so API-style keys like
+ * `home_address.street_1` match form-style keys like `homeAddress.street1`).
+ * Returns `undefined` when no error applies, so callers can fall back to the
+ * raw client-side error code if needed.
+ *
+ * @typeParam TErrorCode - Error codes the field is guaranteed to produce.
+ * @typeParam TOptionalErrorCode - Error codes that only apply in some configurations.
+ * @param fieldName - Form-field name (dot-notation supported for nested fields).
+ * @param formErrors - react-hook-form `formState.errors` for the form.
+ * @param sdkErrors - Normalized SDK errors aggregated by the hook.
+ * @param validationMessages - Map from error code to display string for
+ *   client-side validation failures.
+ * @returns The resolved display message, or `undefined` when no error matches.
+ * @internal
+ */
 export declare function resolveFieldError<TErrorCode extends string, TOptionalErrorCode extends string = never>(fieldName: string, formErrors: FieldErrors, sdkErrors: SDKError[], validationMessages?: ValidationMessages<TErrorCode, TOptionalErrorCode>): string | undefined;

package/dist/partner-hook-utils/form/resolveFieldError.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolveFieldError.js","sources":["../../../src/partner-hook-utils/form/resolveFieldError.ts"],"sourcesContent":["import type { FieldErrors } from 'react-hook-form'\nimport { get } from 'react-hook-form'\nimport type { ValidationMessages } from '../types'\nimport { normalizeErrorKeyForForm } from '@/helpers/formattedStrings'\nimport type { SDKError } from '@/types/sdkError'\n\nexport function resolveFieldError<\n  TErrorCode extends string,\n  TOptionalErrorCode extends string = never,\n>(\n  fieldName: string,\n  formErrors: FieldErrors,\n  sdkErrors: SDKError[],\n  validationMessages?: ValidationMessages<TErrorCode, TOptionalErrorCode>,\n): string | undefined {\n  const fieldError = get(formErrors, fieldName) as { message?: string } | undefined\n  const errorCode = fieldError?.message as TErrorCode | undefined\n  if (errorCode && validationMessages?.[errorCode]) {\n    return validationMessages[errorCode]\n  }\n\n  for (const sdkError of sdkErrors) {\n    const sdkFieldError = sdkError.fieldErrors.find(\n      fe => normalizeErrorKeyForForm(fe.field) === fieldName,\n    )\n    if (sdkFieldError?.message) return sdkFieldError.message\n  }\n\n  return undefined\n}\n"],"names":["resolveFieldError","fieldName","formErrors","sdkErrors","validationMessages","errorCode","get","sdkError","sdkFieldError","fe","normalizeErrorKeyForForm"],"mappings":";;AAMO,SAASA,EAIdC,GACAC,GACAC,GACAC,GACoB;AAEpB,QAAMC,IADaC,EAAIJ,GAAYD,CAAS,GACd;AAC9B,MAAII,KAAaD,IAAqBC,CAAS;AAC7C,WAAOD,EAAmBC,CAAS;AAGrC,aAAWE,KAAYJ,GAAW;AAChC,UAAMK,IAAgBD,EAAS,YAAY;AAAA,MACzC,CAAAE,MAAMC,EAAyBD,EAAG,KAAK,MAAMR;AAAA,IAAA;AAE/C,QAAIO,GAAe,QAAS,QAAOA,EAAc;AAAA,EACnD;AAGF;"}
+{"version":3,"file":"resolveFieldError.js","sources":["../../../src/partner-hook-utils/form/resolveFieldError.ts"],"sourcesContent":["import type { FieldErrors } from 'react-hook-form'\nimport { get } from 'react-hook-form'\nimport type { ValidationMessages } from '../types'\nimport { normalizeErrorKeyForForm } from '@/helpers/formattedStrings'\nimport type { SDKError } from '@/types/sdkError'\n\n/**\n * Resolves the display message for a single form field by combining\n * client-side validation errors with field-scoped SDK errors.\n *\n * @remarks\n * Client-side validation wins when the error code has a matching entry in\n * `validationMessages`. Otherwise the first matching `fieldErrors` entry from\n * `sdkErrors` is returned (field names are normalized so API-style keys like\n * `home_address.street_1` match form-style keys like `homeAddress.street1`).\n * Returns `undefined` when no error applies, so callers can fall back to the\n * raw client-side error code if needed.\n *\n * @typeParam TErrorCode - Error codes the field is guaranteed to produce.\n * @typeParam TOptionalErrorCode - Error codes that only apply in some configurations.\n * @param fieldName - Form-field name (dot-notation supported for nested fields).\n * @param formErrors - react-hook-form `formState.errors` for the form.\n * @param sdkErrors - Normalized SDK errors aggregated by the hook.\n * @param validationMessages - Map from error code to display string for\n *   client-side validation failures.\n * @returns The resolved display message, or `undefined` when no error matches.\n * @internal\n */\nexport function resolveFieldError<\n  TErrorCode extends string,\n  TOptionalErrorCode extends string = never,\n>(\n  fieldName: string,\n  formErrors: FieldErrors,\n  sdkErrors: SDKError[],\n  validationMessages?: ValidationMessages<TErrorCode, TOptionalErrorCode>,\n): string | undefined {\n  const fieldError = get(formErrors, fieldName) as { message?: string } | undefined\n  const errorCode = fieldError?.message as TErrorCode | undefined\n  if (errorCode && validationMessages?.[errorCode]) {\n    return validationMessages[errorCode]\n  }\n\n  for (const sdkError of sdkErrors) {\n    const sdkFieldError = sdkError.fieldErrors.find(\n      fe => normalizeErrorKeyForForm(fe.field) === fieldName,\n    )\n    if (sdkFieldError?.message) return sdkFieldError.message\n  }\n\n  return undefined\n}\n"],"names":["resolveFieldError","fieldName","formErrors","sdkErrors","validationMessages","errorCode","get","sdkError","sdkFieldError","fe","normalizeErrorKeyForForm"],"mappings":";;AA4BO,SAASA,EAIdC,GACAC,GACAC,GACAC,GACoB;AAEpB,QAAMC,IADaC,EAAIJ,GAAYD,CAAS,GACd;AAC9B,MAAII,KAAaD,IAAqBC,CAAS;AAC7C,WAAOD,EAAmBC,CAAS;AAGrC,aAAWE,KAAYJ,GAAW;AAChC,UAAMK,IAAgBD,EAAS,YAAY;AAAA,MACzC,CAAAE,MAAMC,EAAyBD,EAAG,KAAK,MAAMR;AAAA,IAAA;AAE/C,QAAIO,GAAe,QAAS,QAAOA,EAAc;AAAA,EACnD;AAGF;"}

package/dist/partner-hook-utils/form/useDeriveFieldsMetadata.d.ts

@@ -3,15 +3,25 @@ import { z } from 'zod';
 import { FieldMetadata } from '../types';
 import { FieldsMetadataConfig } from './buildFormSchema';
 /**
- * Resolves dynamic field metadata (e.g. `isRequired` driven by predicate
- * rules) by watching only the form fields that predicates actually read.
+ * Resolves dynamic per-field metadata (e.g. `isRequired` driven by predicate
+ * rules) by subscribing only to the form fields the predicates actually read.
  *
- * `buildFormSchema` auto-detects predicate dependencies via a recording
- * Proxy and exposes them as `predicateDeps`. This hook subscribes to only
- * those fields, so typing into unrelated inputs does not trigger re-renders
- * — preserving react-hook-form's per-field optimization.
+ * @remarks
+ * The companion schema builder records predicate dependencies via a recording
+ * Proxy and exposes them on the config as `predicateDeps`. This hook subscribes
+ * to only those fields, so typing into unrelated inputs does not trigger
+ * re-renders — preserving react-hook-form's per-field rendering optimization.
  *
  * When no predicates exist (`predicateDeps` is empty), the hook skips
- * `useWatch` entirely and returns static metadata.
+ * subscribing entirely and returns static metadata derived once per render.
+ *
+ * @typeParam T - Map of field name to Zod validator, mirroring the schema config.
+ * @typeParam TFormData - Shape of the form values managed by react-hook-form.
+ * @param metadataConfig - Metadata config produced alongside the form schema,
+ *   carrying both the resolver function and the predicate dependency list.
+ * @param control - react-hook-form `control` returned by `useForm`.
+ * @returns A map from field name to {@link FieldMetadata}, recomputed whenever
+ *   a watched dependency changes.
+ * @internal
  */
 export declare function useDeriveFieldsMetadata<T extends Record<string, z.ZodType>, TFormData extends FieldValues = FieldValues>(metadataConfig: FieldsMetadataConfig<T>, control: Control<TFormData>): Record<keyof T, FieldMetadata>;

package/dist/partner-hook-utils/form/useDeriveFieldsMetadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDeriveFieldsMetadata.js","sources":["../../../src/partner-hook-utils/form/useDeriveFieldsMetadata.ts"],"sourcesContent":["import { useMemo } from 'react'\nimport type { Control, FieldPath, FieldValues } from 'react-hook-form'\nimport { useWatch } from 'react-hook-form'\nimport type { z } from 'zod'\nimport type { FieldMetadata } from '../types'\nimport type { FieldsMetadataConfig } from './buildFormSchema'\n\n/**\n * Resolves dynamic field metadata (e.g. `isRequired` driven by predicate\n * rules) by watching only the form fields that predicates actually read.\n *\n * `buildFormSchema` auto-detects predicate dependencies via a recording\n * Proxy and exposes them as `predicateDeps`. This hook subscribes to only\n * those fields, so typing into unrelated inputs does not trigger re-renders\n * — preserving react-hook-form's per-field optimization.\n *\n * When no predicates exist (`predicateDeps` is empty), the hook skips\n * `useWatch` entirely and returns static metadata.\n */\nexport function useDeriveFieldsMetadata<\n  T extends Record<string, z.ZodType>,\n  TFormData extends FieldValues = FieldValues,\n>(\n  metadataConfig: FieldsMetadataConfig<T>,\n  control: Control<TFormData>,\n): Record<keyof T, FieldMetadata> {\n  const { predicateDeps } = metadataConfig\n  const hasDeps = predicateDeps.length > 0\n\n  const watchedValues = useWatch({\n    control,\n    name: hasDeps ? (predicateDeps as FieldPath<TFormData>[]) : ([] as never[]),\n    disabled: !hasDeps,\n  })\n\n  return useMemo(() => {\n    if (!hasDeps) {\n      return metadataConfig.getFieldsMetadata()\n    }\n\n    const data: Record<string, unknown> = {}\n    for (let i = 0; i < predicateDeps.length; i++) {\n      data[predicateDeps[i]!] = (watchedValues as unknown[])[i]\n    }\n    return metadataConfig.getFieldsMetadata(data)\n  }, [metadataConfig, hasDeps, predicateDeps, watchedValues])\n}\n"],"names":["useDeriveFieldsMetadata","metadataConfig","control","predicateDeps","hasDeps","watchedValues","useWatch","useMemo","data","i"],"mappings":";;AAmBO,SAASA,EAIdC,GACAC,GACgC;AAChC,QAAM,EAAE,eAAAC,MAAkBF,GACpBG,IAAUD,EAAc,SAAS,GAEjCE,IAAgBC,EAAS;AAAA,IAC7B,SAAAJ;AAAA,IACA,MAAME,IAAWD,IAA4C,CAAA;AAAA,IAC7D,UAAU,CAACC;AAAA,EAAA,CACZ;AAED,SAAOG,EAAQ,MAAM;AACnB,QAAI,CAACH;AACH,aAAOH,EAAe,kBAAA;AAGxB,UAAMO,IAAgC,CAAA;AACtC,aAASC,IAAI,GAAGA,IAAIN,EAAc,QAAQM;AACxC,MAAAD,EAAKL,EAAcM,CAAC,CAAE,IAAKJ,EAA4BI,CAAC;AAE1D,WAAOR,EAAe,kBAAkBO,CAAI;AAAA,EAC9C,GAAG,CAACP,GAAgBG,GAASD,GAAeE,CAAa,CAAC;AAC5D;"}
+{"version":3,"file":"useDeriveFieldsMetadata.js","sources":["../../../src/partner-hook-utils/form/useDeriveFieldsMetadata.ts"],"sourcesContent":["import { useMemo } from 'react'\nimport type { Control, FieldPath, FieldValues } from 'react-hook-form'\nimport { useWatch } from 'react-hook-form'\nimport type { z } from 'zod'\nimport type { FieldMetadata } from '../types'\nimport type { FieldsMetadataConfig } from './buildFormSchema'\n\n/**\n * Resolves dynamic per-field metadata (e.g. `isRequired` driven by predicate\n * rules) by subscribing only to the form fields the predicates actually read.\n *\n * @remarks\n * The companion schema builder records predicate dependencies via a recording\n * Proxy and exposes them on the config as `predicateDeps`. This hook subscribes\n * to only those fields, so typing into unrelated inputs does not trigger\n * re-renders — preserving react-hook-form's per-field rendering optimization.\n *\n * When no predicates exist (`predicateDeps` is empty), the hook skips\n * subscribing entirely and returns static metadata derived once per render.\n *\n * @typeParam T - Map of field name to Zod validator, mirroring the schema config.\n * @typeParam TFormData - Shape of the form values managed by react-hook-form.\n * @param metadataConfig - Metadata config produced alongside the form schema,\n *   carrying both the resolver function and the predicate dependency list.\n * @param control - react-hook-form `control` returned by `useForm`.\n * @returns A map from field name to {@link FieldMetadata}, recomputed whenever\n *   a watched dependency changes.\n * @internal\n */\nexport function useDeriveFieldsMetadata<\n  T extends Record<string, z.ZodType>,\n  TFormData extends FieldValues = FieldValues,\n>(\n  metadataConfig: FieldsMetadataConfig<T>,\n  control: Control<TFormData>,\n): Record<keyof T, FieldMetadata> {\n  const { predicateDeps } = metadataConfig\n  const hasDeps = predicateDeps.length > 0\n\n  const watchedValues = useWatch({\n    control,\n    name: hasDeps ? (predicateDeps as FieldPath<TFormData>[]) : ([] as never[]),\n    disabled: !hasDeps,\n  })\n\n  return useMemo(() => {\n    if (!hasDeps) {\n      return metadataConfig.getFieldsMetadata()\n    }\n\n    const data: Record<string, unknown> = {}\n    for (let i = 0; i < predicateDeps.length; i++) {\n      data[predicateDeps[i]!] = (watchedValues as unknown[])[i]\n    }\n    return metadataConfig.getFieldsMetadata(data)\n  }, [metadataConfig, hasDeps, predicateDeps, watchedValues])\n}\n"],"names":["useDeriveFieldsMetadata","metadataConfig","control","predicateDeps","hasDeps","watchedValues","useWatch","useMemo","data","i"],"mappings":";;AA6BO,SAASA,EAIdC,GACAC,GACgC;AAChC,QAAM,EAAE,eAAAC,MAAkBF,GACpBG,IAAUD,EAAc,SAAS,GAEjCE,IAAgBC,EAAS;AAAA,IAC7B,SAAAJ;AAAA,IACA,MAAME,IAAWD,IAA4C,CAAA;AAAA,IAC7D,UAAU,CAACC;AAAA,EAAA,CACZ;AAED,SAAOG,EAAQ,MAAM;AACnB,QAAI,CAACH;AACH,aAAOH,EAAe,kBAAA;AAGxB,UAAMO,IAAgC,CAAA;AACtC,aAASC,IAAI,GAAGA,IAAIN,EAAc,QAAQM;AACxC,MAAAD,EAAKL,EAAcM,CAAC,CAAE,IAAKJ,EAA4BI,CAAC;AAE1D,WAAOR,EAAe,kBAAkBO,CAAI;AAAA,EAC9C,GAAG,CAACP,GAAgBG,GAASD,GAAeE,CAAa,CAAC;AAC5D;"}

package/dist/partner-hook-utils/form/useFieldErrorMessage.d.ts

@@ -1,2 +1,41 @@
 import { ValidationMessages } from '../types';
+/**
+ * Resolves the display string for a field's current error from either client-side validation or server-side `SDKError`s.
+ *
+ * @remarks
+ * Use inside a custom field component rendered under a form hook's
+ * provider to surface the same error message the built-in `Fields` would
+ * render. Looks up the field's error in this order:
+ *
+ * 1. The react-hook-form error for `fieldName`. If its message matches a
+ *    key in `validationMessages`, returns that mapped string.
+ * 2. Any matching field-level error attached to a server-side error
+ *    available on the form provider.
+ * 3. `undefined` when no error applies.
+ *
+ * Must be called from a component rendered inside the form hook's
+ * `FormProvider`.
+ *
+ * @typeParam TErrorCode - Error codes the field can produce; each key in `validationMessages` maps a code to its display string.
+ * @param fieldName - Name of the field as registered with react-hook-form.
+ * @param validationMessages - Map of validation error codes to display strings. When omitted, only server-side errors are returned.
+ * @returns The display message for the field's current error, or `undefined` when the field is valid.
+ * @internal
+ *
+ * @example
+ * ```tsx
+ * function StreetAddressField() {
+ *   const errorMessage = useFieldErrorMessage('street1', {
+ *     REQUIRED: 'Street address is required',
+ *   })
+ *   return (
+ *     <label>
+ *       Street
+ *       <input name="street1" aria-invalid={errorMessage ? true : undefined} />
+ *       {errorMessage ? <span role="alert">{errorMessage}</span> : null}
+ *     </label>
+ *   )
+ * }
+ * ```
+ */
 export declare function useFieldErrorMessage<TErrorCode extends string>(fieldName: string, validationMessages?: ValidationMessages<TErrorCode>): string | undefined;

package/dist/partner-hook-utils/form/useFieldErrorMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFieldErrorMessage.js","sources":["../../../src/partner-hook-utils/form/useFieldErrorMessage.ts"],"sourcesContent":["import { useFormContext, get } from 'react-hook-form'\nimport type { ValidationMessages } from '../types'\nimport { useFormFieldsMetadataContext } from './FormFieldsMetadataContext'\nimport { normalizeErrorKeyForForm } from '@/helpers/formattedStrings'\n\nexport function useFieldErrorMessage<TErrorCode extends string>(\n  fieldName: string,\n  validationMessages?: ValidationMessages<TErrorCode>,\n): string | undefined {\n  const {\n    formState: { errors },\n  } = useFormContext()\n  const context = useFormFieldsMetadataContext()\n  const sdkErrors = context?.errors ?? []\n\n  const fieldError = get(errors, fieldName) as { message?: string } | undefined\n  const errorCode = fieldError?.message as TErrorCode | undefined\n  if (errorCode && validationMessages?.[errorCode]) {\n    return validationMessages[errorCode]\n  }\n\n  for (const sdkError of sdkErrors) {\n    const sdkFieldError = sdkError.fieldErrors.find(\n      fe => normalizeErrorKeyForForm(fe.field) === fieldName,\n    )\n    if (sdkFieldError?.message) return sdkFieldError.message\n  }\n\n  return undefined\n}\n"],"names":["useFieldErrorMessage","fieldName","validationMessages","errors","useFormContext","sdkErrors","useFormFieldsMetadataContext","errorCode","get","sdkError","sdkFieldError","fe","normalizeErrorKeyForForm"],"mappings":";;;AAKO,SAASA,EACdC,GACAC,GACoB;AACpB,QAAM;AAAA,IACJ,WAAW,EAAE,QAAAC,EAAA;AAAA,EAAO,IAClBC,EAAA,GAEEC,IADUC,EAAA,GACW,UAAU,CAAA,GAG/BC,IADaC,EAAIL,GAAQF,CAAS,GACV;AAC9B,MAAIM,KAAaL,IAAqBK,CAAS;AAC7C,WAAOL,EAAmBK,CAAS;AAGrC,aAAWE,KAAYJ,GAAW;AAChC,UAAMK,IAAgBD,EAAS,YAAY;AAAA,MACzC,CAAAE,MAAMC,EAAyBD,EAAG,KAAK,MAAMV;AAAA,IAAA;AAE/C,QAAIS,GAAe,QAAS,QAAOA,EAAc;AAAA,EACnD;AAGF;"}
+{"version":3,"file":"useFieldErrorMessage.js","sources":["../../../src/partner-hook-utils/form/useFieldErrorMessage.ts"],"sourcesContent":["import { useFormContext, get } from 'react-hook-form'\nimport type { ValidationMessages } from '../types'\nimport { useFormFieldsMetadataContext } from './FormFieldsMetadataContext'\nimport { normalizeErrorKeyForForm } from '@/helpers/formattedStrings'\n\n/**\n * Resolves the display string for a field's current error from either client-side validation or server-side `SDKError`s.\n *\n * @remarks\n * Use inside a custom field component rendered under a form hook's\n * provider to surface the same error message the built-in `Fields` would\n * render. Looks up the field's error in this order:\n *\n * 1. The react-hook-form error for `fieldName`. If its message matches a\n *    key in `validationMessages`, returns that mapped string.\n * 2. Any matching field-level error attached to a server-side error\n *    available on the form provider.\n * 3. `undefined` when no error applies.\n *\n * Must be called from a component rendered inside the form hook's\n * `FormProvider`.\n *\n * @typeParam TErrorCode - Error codes the field can produce; each key in `validationMessages` maps a code to its display string.\n * @param fieldName - Name of the field as registered with react-hook-form.\n * @param validationMessages - Map of validation error codes to display strings. When omitted, only server-side errors are returned.\n * @returns The display message for the field's current error, or `undefined` when the field is valid.\n * @internal\n *\n * @example\n * ```tsx\n * function StreetAddressField() {\n *   const errorMessage = useFieldErrorMessage('street1', {\n *     REQUIRED: 'Street address is required',\n *   })\n *   return (\n *     <label>\n *       Street\n *       <input name=\"street1\" aria-invalid={errorMessage ? true : undefined} />\n *       {errorMessage ? <span role=\"alert\">{errorMessage}</span> : null}\n *     </label>\n *   )\n * }\n * ```\n */\nexport function useFieldErrorMessage<TErrorCode extends string>(\n  fieldName: string,\n  validationMessages?: ValidationMessages<TErrorCode>,\n): string | undefined {\n  const {\n    formState: { errors },\n  } = useFormContext()\n  const context = useFormFieldsMetadataContext()\n  const sdkErrors = context?.errors ?? []\n\n  const fieldError = get(errors, fieldName) as { message?: string } | undefined\n  const errorCode = fieldError?.message as TErrorCode | undefined\n  if (errorCode && validationMessages?.[errorCode]) {\n    return validationMessages[errorCode]\n  }\n\n  for (const sdkError of sdkErrors) {\n    const sdkFieldError = sdkError.fieldErrors.find(\n      fe => normalizeErrorKeyForForm(fe.field) === fieldName,\n    )\n    if (sdkFieldError?.message) return sdkFieldError.message\n  }\n\n  return undefined\n}\n"],"names":["useFieldErrorMessage","fieldName","validationMessages","errors","useFormContext","sdkErrors","useFormFieldsMetadataContext","errorCode","get","sdkError","sdkFieldError","fe","normalizeErrorKeyForForm"],"mappings":";;;AA4CO,SAASA,EACdC,GACAC,GACoB;AACpB,QAAM;AAAA,IACJ,WAAW,EAAE,QAAAC,EAAA;AAAA,EAAO,IAClBC,EAAA,GAEEC,IADUC,EAAA,GACW,UAAU,CAAA,GAG/BC,IADaC,EAAIL,GAAQF,CAAS,GACV;AAC9B,MAAIM,KAAaL,IAAqBK,CAAS;AAC7C,WAAOL,EAAmBK,CAAS;AAGrC,aAAWE,KAAYJ,GAAW;AAChC,UAAMK,IAAgBD,EAAS,YAAY;AAAA,MACzC,CAAAE,MAAMC,EAAyBD,EAAG,KAAK,MAAMV;AAAA,IAAA;AAE/C,QAAIS,GAAe,QAAS,QAAOA,EAAc;AAAA,EACnD;AAGF;"}

package/dist/partner-hook-utils/form/useHookFieldResolution.d.ts

@@ -8,9 +8,9 @@ interface HookFieldResolution {
     fieldElementRegistry: FieldElementRegistry | undefined;
 }
 /**
- * Resolves all data a HookField needs from either a `formHookResult` prop or
- * the standard context providers (FormProvider + FormFieldsMetadataProvider).
+ * Resolves all data a HookField needs from either a `formHookResult` prop or the standard context providers (FormProvider + FormFieldsMetadataProvider).
  *
+ * @remarks
  * When `formHookResult` is provided, metadata/errors/control/registry are read
  * from the prop — no context providers required. When absent, falls back to
  * the existing context-based path.
@@ -24,6 +24,14 @@ interface HookFieldResolution {
  * self-publish the registry via `withFieldElementRegistry`. In the
  * `SDKFormProvider` path the wrap is a no-op (no registry on the prop) and the
  * outer provider's registry remains in scope.
+ *
+ * @typeParam TErrorCode - Required error codes the field can produce.
+ * @typeParam TOptionalErrorCode - Optional error codes that only apply in some configurations.
+ * @param name - Form-field name to resolve metadata, errors, and control for.
+ * @param formHookResult - Form hook result passed via the `formHookResult` prop, or `undefined` to read from context.
+ * @param validationMessages - Map of error codes to display strings, forwarded to error resolution.
+ * @returns The metadata entry, RHF `control`, resolved error message, and field element registry for this field.
+ * @internal
  */
 export declare function useHookFieldResolution<TErrorCode extends string, TOptionalErrorCode extends string = never>(name: string, formHookResult: FormHookResult | undefined, validationMessages?: ValidationMessages<TErrorCode, TOptionalErrorCode>): HookFieldResolution;
 export {};

package/dist/partner-hook-utils/form/useHookFieldResolution.js.map

@@ -1 +1 @@
-{"version":3,"file":"useHookFieldResolution.js","sources":["../../../src/partner-hook-utils/form/useHookFieldResolution.ts"],"sourcesContent":["import type { Control } from 'react-hook-form'\nimport { useFormState } from 'react-hook-form'\nimport type { FieldsMetadata, ValidationMessages, FormHookResult } from '../types'\nimport { useFormFieldsMetadataContext } from './FormFieldsMetadataContext'\nimport { resolveFieldError } from './resolveFieldError'\nimport type { FieldElementRegistry } from '@/components/Common/Fields/hooks/fieldElementRegistry'\n\ninterface HookFieldResolution {\n  metadata: FieldsMetadata\n  control: Control | undefined\n  errorMessage: string | undefined\n  fieldElementRegistry: FieldElementRegistry | undefined\n}\n\n/**\n * Resolves all data a HookField needs from either a `formHookResult` prop or\n * the standard context providers (FormProvider + FormFieldsMetadataProvider).\n *\n * When `formHookResult` is provided, metadata/errors/control/registry are read\n * from the prop — no context providers required. When absent, falls back to\n * the existing context-based path.\n *\n * Uses `useFormState` to establish a proper RHF subscription for error updates.\n * When `control` is provided (prop path), useFormState subscribes directly via\n * the control object. When absent (context path), it falls back to useFormContext\n * internally. The `name` parameter scopes the subscription to this field.\n *\n * `fieldElementRegistry` is forwarded so HookFields in the prop-based path can\n * self-publish the registry via `withFieldElementRegistry`. In the\n * `SDKFormProvider` path the wrap is a no-op (no registry on the prop) and the\n * outer provider's registry remains in scope.\n */\nexport function useHookFieldResolution<\n  TErrorCode extends string,\n  TOptionalErrorCode extends string = never,\n>(\n  name: string,\n  formHookResult: FormHookResult | undefined,\n  validationMessages?: ValidationMessages<TErrorCode, TOptionalErrorCode>,\n): HookFieldResolution {\n  const metadataContext = useFormFieldsMetadataContext()\n\n  const metadata = formHookResult?.form.fieldsMetadata ?? metadataContext?.metadata ?? {}\n\n  const control = formHookResult?.form.hookFormInternals.formMethods.control as Control | undefined\n\n  const { errors: formErrors } = useFormState({ control, name })\n\n  const sdkErrors = formHookResult\n    ? formHookResult.errorHandling.errors\n    : (metadataContext?.errors ?? [])\n\n  const errorMessage = resolveFieldError(name, formErrors, sdkErrors, validationMessages)\n\n  const fieldElementRegistry = formHookResult?.form.hookFormInternals._fieldElementRegistry\n\n  return { metadata, control, errorMessage, fieldElementRegistry }\n}\n"],"names":["useHookFieldResolution","name","formHookResult","validationMessages","metadataContext","useFormFieldsMetadataContext","metadata","control","formErrors","useFormState","sdkErrors","errorMessage","resolveFieldError","fieldElementRegistry"],"mappings":";;;AAgCO,SAASA,EAIdC,GACAC,GACAC,GACqB;AACrB,QAAMC,IAAkBC,EAAA,GAElBC,IAAWJ,GAAgB,KAAK,kBAAkBE,GAAiB,YAAY,CAAA,GAE/EG,IAAUL,GAAgB,KAAK,kBAAkB,YAAY,SAE7D,EAAE,QAAQM,EAAA,IAAeC,EAAa,EAAE,SAAAF,GAAS,MAAAN,GAAM,GAEvDS,IAAYR,IACdA,EAAe,cAAc,SAC5BE,GAAiB,UAAU,CAAA,GAE1BO,IAAeC,EAAkBX,GAAMO,GAAYE,GAAWP,CAAkB,GAEhFU,IAAuBX,GAAgB,KAAK,kBAAkB;AAEpE,SAAO,EAAE,UAAAI,GAAU,SAAAC,GAAS,cAAAI,GAAc,sBAAAE,EAAA;AAC5C;"}
+{"version":3,"file":"useHookFieldResolution.js","sources":["../../../src/partner-hook-utils/form/useHookFieldResolution.ts"],"sourcesContent":["import type { Control } from 'react-hook-form'\nimport { useFormState } from 'react-hook-form'\nimport type { FieldsMetadata, ValidationMessages, FormHookResult } from '../types'\nimport { useFormFieldsMetadataContext } from './FormFieldsMetadataContext'\nimport { resolveFieldError } from './resolveFieldError'\nimport type { FieldElementRegistry } from '@/components/Common/Fields/hooks/fieldElementRegistry'\n\ninterface HookFieldResolution {\n  metadata: FieldsMetadata\n  control: Control | undefined\n  errorMessage: string | undefined\n  fieldElementRegistry: FieldElementRegistry | undefined\n}\n\n/**\n * Resolves all data a HookField needs from either a `formHookResult` prop or the standard context providers (FormProvider + FormFieldsMetadataProvider).\n *\n * @remarks\n * When `formHookResult` is provided, metadata/errors/control/registry are read\n * from the prop — no context providers required. When absent, falls back to\n * the existing context-based path.\n *\n * Uses `useFormState` to establish a proper RHF subscription for error updates.\n * When `control` is provided (prop path), useFormState subscribes directly via\n * the control object. When absent (context path), it falls back to useFormContext\n * internally. The `name` parameter scopes the subscription to this field.\n *\n * `fieldElementRegistry` is forwarded so HookFields in the prop-based path can\n * self-publish the registry via `withFieldElementRegistry`. In the\n * `SDKFormProvider` path the wrap is a no-op (no registry on the prop) and the\n * outer provider's registry remains in scope.\n *\n * @typeParam TErrorCode - Required error codes the field can produce.\n * @typeParam TOptionalErrorCode - Optional error codes that only apply in some configurations.\n * @param name - Form-field name to resolve metadata, errors, and control for.\n * @param formHookResult - Form hook result passed via the `formHookResult` prop, or `undefined` to read from context.\n * @param validationMessages - Map of error codes to display strings, forwarded to error resolution.\n * @returns The metadata entry, RHF `control`, resolved error message, and field element registry for this field.\n * @internal\n */\nexport function useHookFieldResolution<\n  TErrorCode extends string,\n  TOptionalErrorCode extends string = never,\n>(\n  name: string,\n  formHookResult: FormHookResult | undefined,\n  validationMessages?: ValidationMessages<TErrorCode, TOptionalErrorCode>,\n): HookFieldResolution {\n  const metadataContext = useFormFieldsMetadataContext()\n\n  const metadata = formHookResult?.form.fieldsMetadata ?? metadataContext?.metadata ?? {}\n\n  const control = formHookResult?.form.hookFormInternals.formMethods.control as Control | undefined\n\n  const { errors: formErrors } = useFormState({ control, name })\n\n  const sdkErrors = formHookResult\n    ? formHookResult.errorHandling.errors\n    : (metadataContext?.errors ?? [])\n\n  const errorMessage = resolveFieldError(name, formErrors, sdkErrors, validationMessages)\n\n  const fieldElementRegistry = formHookResult?.form.hookFormInternals._fieldElementRegistry\n\n  return { metadata, control, errorMessage, fieldElementRegistry }\n}\n"],"names":["useHookFieldResolution","name","formHookResult","validationMessages","metadataContext","useFormFieldsMetadataContext","metadata","control","formErrors","useFormState","sdkErrors","errorMessage","resolveFieldError","fieldElementRegistry"],"mappings":";;;AAwCO,SAASA,EAIdC,GACAC,GACAC,GACqB;AACrB,QAAMC,IAAkBC,EAAA,GAElBC,IAAWJ,GAAgB,KAAK,kBAAkBE,GAAiB,YAAY,CAAA,GAE/EG,IAAUL,GAAgB,KAAK,kBAAkB,YAAY,SAE7D,EAAE,QAAQM,EAAA,IAAeC,EAAa,EAAE,SAAAF,GAAS,MAAAN,GAAM,GAEvDS,IAAYR,IACdA,EAAe,cAAc,SAC5BE,GAAiB,UAAU,CAAA,GAE1BO,IAAeC,EAAkBX,GAAMO,GAAYE,GAAWP,CAAkB,GAEhFU,IAAuBX,GAAgB,KAAK,kBAAkB;AAEpE,SAAO,EAAE,UAAAI,GAAU,SAAAC,GAAS,cAAAI,GAAc,sBAAAE,EAAA;AAC5C;"}

package/dist/partner-hook-utils/form/useHookFormInternals.d.ts

@@ -1,10 +1,12 @@
 import { FieldValues, UseFormReturn } from 'react-hook-form';
 import { HookFormInternals } from '../types';
 /**
- * Builds the `hookFormInternals` object every SDK form hook returns. Creates a
- * per-form `FieldElementRegistry` (populated by `useField` via context) so
- * `composeSubmitHandler` can resolve the visually first invalid field across
- * multiple composed forms.
+ * Builds the `hookFormInternals` object every SDK form hook returns.
+ *
+ * @remarks
+ * Creates a per-form `FieldElementRegistry` (populated by `useField` via
+ * context) so `composeSubmitHandler` can resolve the visually first invalid
+ * field across multiple composed forms.
  *
  * Call once per `useForm()` inside each form hook and spread/return directly:
  *
@@ -18,5 +20,10 @@ import { HookFormInternals } from '../types';
  *   },
  * }
  * ```
+ *
+ * @typeParam TFormData - Shape of the form values managed by react-hook-form.
+ * @param formMethods - Return value from a `useForm<TFormData>()` call inside the hook.
+ * @returns The `hookFormInternals` object exposing `formMethods` and the per-form `FieldElementRegistry`.
+ * @internal
  */
 export declare function useHookFormInternals<TFormData extends FieldValues>(formMethods: UseFormReturn<TFormData>): HookFormInternals<TFormData>;

package/dist/partner-hook-utils/form/useHookFormInternals.js.map

@@ -1 +1 @@
-{"version":3,"file":"useHookFormInternals.js","sources":["../../../src/partner-hook-utils/form/useHookFormInternals.ts"],"sourcesContent":["import type { FieldValues, UseFormReturn } from 'react-hook-form'\nimport type { HookFormInternals } from '../types'\nimport { useFieldElementRegistry } from '@/components/Common/Fields/hooks/fieldElementRegistry'\n\n/**\n * Builds the `hookFormInternals` object every SDK form hook returns. Creates a\n * per-form `FieldElementRegistry` (populated by `useField` via context) so\n * `composeSubmitHandler` can resolve the visually first invalid field across\n * multiple composed forms.\n *\n * Call once per `useForm()` inside each form hook and spread/return directly:\n *\n * ```ts\n * const formMethods = useForm<MyForm>({ ... })\n * return {\n *   ...\n *   form: {\n *     ...,\n *     hookFormInternals: useHookFormInternals(formMethods),\n *   },\n * }\n * ```\n */\nexport function useHookFormInternals<TFormData extends FieldValues>(\n  formMethods: UseFormReturn<TFormData>,\n): HookFormInternals<TFormData> {\n  const fieldElementRegistry = useFieldElementRegistry()\n  return {\n    formMethods,\n    _fieldElementRegistry: fieldElementRegistry,\n  }\n}\n"],"names":["useHookFormInternals","formMethods","fieldElementRegistry","useFieldElementRegistry"],"mappings":";AAuBO,SAASA,EACdC,GAC8B;AAC9B,QAAMC,IAAuBC,EAAA;AAC7B,SAAO;AAAA,IACL,aAAAF;AAAA,IACA,uBAAuBC;AAAA,EAAA;AAE3B;"}
+{"version":3,"file":"useHookFormInternals.js","sources":["../../../src/partner-hook-utils/form/useHookFormInternals.ts"],"sourcesContent":["import type { FieldValues, UseFormReturn } from 'react-hook-form'\nimport type { HookFormInternals } from '../types'\nimport { useFieldElementRegistry } from '@/components/Common/Fields/hooks/fieldElementRegistry'\n\n/**\n * Builds the `hookFormInternals` object every SDK form hook returns.\n *\n * @remarks\n * Creates a per-form `FieldElementRegistry` (populated by `useField` via\n * context) so `composeSubmitHandler` can resolve the visually first invalid\n * field across multiple composed forms.\n *\n * Call once per `useForm()` inside each form hook and spread/return directly:\n *\n * ```ts\n * const formMethods = useForm<MyForm>({ ... })\n * return {\n *   ...\n *   form: {\n *     ...,\n *     hookFormInternals: useHookFormInternals(formMethods),\n *   },\n * }\n * ```\n *\n * @typeParam TFormData - Shape of the form values managed by react-hook-form.\n * @param formMethods - Return value from a `useForm<TFormData>()` call inside the hook.\n * @returns The `hookFormInternals` object exposing `formMethods` and the per-form `FieldElementRegistry`.\n * @internal\n */\nexport function useHookFormInternals<TFormData extends FieldValues>(\n  formMethods: UseFormReturn<TFormData>,\n): HookFormInternals<TFormData> {\n  const fieldElementRegistry = useFieldElementRegistry()\n  return {\n    formMethods,\n    _fieldElementRegistry: fieldElementRegistry,\n  }\n}\n"],"names":["useHookFormInternals","formMethods","fieldElementRegistry","useFieldElementRegistry"],"mappings":";AA8BO,SAASA,EACdC,GAC8B;AAC9B,QAAMC,IAAuBC,EAAA;AAC7B,SAAO;AAAA,IACL,aAAAF;AAAA,IACA,uBAAuBC;AAAA,EAAA;AAE3B;"}

package/dist/partner-hook-utils/form/withOptions.d.ts

@@ -1,4 +1,29 @@
 import { FieldMetadata, FieldMetadataWithOptions } from '../types';
+/**
+ * Extends a {@link FieldMetadata} entry with the option list used to render a select-like field.
+ *
+ * @remarks
+ * Use when building the `fieldsMetadata` returned by a custom form hook to
+ * attach `label`/`value` pairs (and optionally the raw underlying records) to
+ * a field's metadata entry. Hook field components for select-like inputs read
+ * `options` and, when present, `entries` off the resulting
+ * {@link FieldMetadataWithOptions}.
+ *
+ * @typeParam TEntry - Shape of the underlying records that produced `options`.
+ * @param base - The existing field metadata entry to extend.
+ * @param options - Display options as `label`/`value` pairs to render in the field.
+ * @param entries - Optional raw records the options were derived from, exposed alongside `options` for callers that need additional attributes.
+ * @returns A {@link FieldMetadataWithOptions} carrying the original metadata plus `options` and, when supplied, `entries`.
+ * @internal
+ *
+ * @example
+ * ```ts
+ * const typeOptions = PAYMENT_METHOD_TYPES.map(value => ({ value, label: value }))
+ * const fieldsMetadata = {
+ *   type: withOptions(baseMetadata.type, typeOptions, [...PAYMENT_METHOD_TYPES]),
+ * }
+ * ```
+ */
 export declare function withOptions<TEntry = unknown>(base: FieldMetadata, options: Array<{
     label: string;
     value: string;

package/dist/partner-hook-utils/form/withOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"withOptions.js","sources":["../../../src/partner-hook-utils/form/withOptions.ts"],"sourcesContent":["import type { FieldMetadata, FieldMetadataWithOptions } from '../types'\n\nexport function withOptions<TEntry = unknown>(\n  base: FieldMetadata,\n  options: Array<{ label: string; value: string }>,\n  entries?: readonly TEntry[],\n): FieldMetadataWithOptions<TEntry> {\n  if (entries !== undefined) {\n    return { ...base, options, entries }\n  }\n  return { ...base, options }\n}\n"],"names":["withOptions","base","options","entries"],"mappings":"AAEO,SAASA,EACdC,GACAC,GACAC,GACkC;AAClC,SAAIA,MAAY,SACP,EAAE,GAAGF,GAAM,SAAAC,GAAS,SAAAC,EAAA,IAEtB,EAAE,GAAGF,GAAM,SAAAC,EAAA;AACpB;"}
+{"version":3,"file":"withOptions.js","sources":["../../../src/partner-hook-utils/form/withOptions.ts"],"sourcesContent":["import type { FieldMetadata, FieldMetadataWithOptions } from '../types'\n\n/**\n * Extends a {@link FieldMetadata} entry with the option list used to render a select-like field.\n *\n * @remarks\n * Use when building the `fieldsMetadata` returned by a custom form hook to\n * attach `label`/`value` pairs (and optionally the raw underlying records) to\n * a field's metadata entry. Hook field components for select-like inputs read\n * `options` and, when present, `entries` off the resulting\n * {@link FieldMetadataWithOptions}.\n *\n * @typeParam TEntry - Shape of the underlying records that produced `options`.\n * @param base - The existing field metadata entry to extend.\n * @param options - Display options as `label`/`value` pairs to render in the field.\n * @param entries - Optional raw records the options were derived from, exposed alongside `options` for callers that need additional attributes.\n * @returns A {@link FieldMetadataWithOptions} carrying the original metadata plus `options` and, when supplied, `entries`.\n * @internal\n *\n * @example\n * ```ts\n * const typeOptions = PAYMENT_METHOD_TYPES.map(value => ({ value, label: value }))\n * const fieldsMetadata = {\n *   type: withOptions(baseMetadata.type, typeOptions, [...PAYMENT_METHOD_TYPES]),\n * }\n * ```\n */\nexport function withOptions<TEntry = unknown>(\n  base: FieldMetadata,\n  options: Array<{ label: string; value: string }>,\n  entries?: readonly TEntry[],\n): FieldMetadataWithOptions<TEntry> {\n  if (entries !== undefined) {\n    return { ...base, options, entries }\n  }\n  return { ...base, options }\n}\n"],"names":["withOptions","base","options","entries"],"mappings":"AA2BO,SAASA,EACdC,GACAC,GACAC,GACkC;AAClC,SAAIA,MAAY,SACP,EAAE,GAAGF,GAAM,SAAAC,GAAS,SAAAC,EAAA,IAEtB,EAAE,GAAGF,GAAM,SAAAC,EAAA;AACpB;"}