@gusto/embedded-react-sdk 0.47.1 → 0.48.1

package/dist/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodForm.d.ts

@@ -3,29 +3,112 @@ import { EmployeePaymentMethod } from '@gusto/embedded-api-v-2025-11-15/models/c
 import { PaymentMethodFormData, PaymentMethodFormOptionalFieldsToRequire } from './usePaymentMethodFormSchema';
 import { TypeField } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Props for {@link usePaymentMethodForm}.
+ *
+ * @public
+ */
 export interface UsePaymentMethodFormProps {
+    /** Employee whose payment method is being edited. */
     employeeId: string;
+    /** Override optional fields to be required. Reserved for future schema expansion — `type` is always required and always has a default. */
     optionalFieldsToRequire?: PaymentMethodFormOptionalFieldsToRequire;
+    /** Pre-fill form values. Server data (the current payment method) is used when no override is supplied. */
     defaultValues?: Partial<PaymentMethodFormData>;
+    /** When validation runs. Passed through to react-hook-form. Defaults to `'onSubmit'`. */
     validationMode?: UseFormProps['mode'];
+    /** Auto-focus the first invalid field on submit. Set to `false` when using `composeSubmitHandler`. Defaults to `true`. */
     shouldFocusError?: boolean;
 }
+/**
+ * Field components exposed by {@link usePaymentMethodForm} on `form.Fields`.
+ *
+ * @public
+ */
 export interface PaymentMethodFormFields {
+    /** Bound to `type` — see {@link TypeField}. */
     Type: typeof TypeField;
 }
+/**
+ * Ready-state return value of {@link usePaymentMethodForm}.
+ *
+ * @public
+ */
 export interface UsePaymentMethodFormReady extends BaseFormHookReady<FieldsMetadata, PaymentMethodFormData, PaymentMethodFormFields> {
+    /** The employee's current payment method, loaded from the API. */
     data: {
         paymentMethod: EmployeePaymentMethod;
     };
+    /** `isPending` reflects the in-flight update mutation; `mode` is always `'update'`. */
     status: {
         isPending: boolean;
         mode: 'update';
     };
+    /** Submit the form. Returns the updated payment method on success or `undefined` on validation/mutation failure. */
     actions: {
         onSubmit: () => Promise<HookSubmitResult<EmployeePaymentMethod> | undefined>;
     };
 }
+/**
+ * Headless React Hook Form hook for updating an employee's payment method.
+ *
+ * @remarks
+ * Switches between Direct Deposit and Check. Always operates in update mode —
+ * every employee has a payment method, defaulting to Check. Switching to Check
+ * sends a minimal request body; switching to or staying on Direct Deposit
+ * preserves the existing splits and version so split allocations are not lost
+ * when only the type changes.
+ *
+ * @param props - See {@link UsePaymentMethodFormProps}.
+ * @returns A loading-state result while the current payment method is loading, or a {@link UsePaymentMethodFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import {
+ *   usePaymentMethodForm,
+ *   SDKFormProvider,
+ *   PAYMENT_METHODS,
+ *   type PaymentMethodType,
+ * } from '@gusto/embedded-react-sdk'
+ *
+ * function PaymentMethodScreen({ employeeId }: { employeeId: string }) {
+ *   const paymentMethodForm = usePaymentMethodForm({ employeeId })
+ *
+ *   if (paymentMethodForm.isLoading) return null
+ *   const { Fields } = paymentMethodForm.form
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={paymentMethodForm}>
+ *       <form
+ *         onSubmit={e => {
+ *           e.preventDefault()
+ *           void paymentMethodForm.actions.onSubmit()
+ *         }}
+ *       >
+ *         <Fields.Type
+ *           label="Select payment method"
+ *           getOptionLabel={(value: PaymentMethodType) =>
+ *             value === PAYMENT_METHODS.directDeposit ? 'Direct Deposit' : 'Check'
+ *           }
+ *         />
+ *         <button type="submit" disabled={paymentMethodForm.status.isPending}>Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function usePaymentMethodForm({ employeeId, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UsePaymentMethodFormProps): HookLoadingResult | UsePaymentMethodFormReady;
+/**
+ * Return type of {@link usePaymentMethodForm} — a discriminated union on `isLoading`.
+ *
+ * @public
+ */
 export type UsePaymentMethodFormResult = HookLoadingResult | UsePaymentMethodFormReady;
+/**
+ * Per-field metadata exposed on `form.fieldsMetadata` for {@link usePaymentMethodForm}.
+ *
+ * @public
+ */
 export type PaymentMethodFormFieldsMetadata = UsePaymentMethodFormReady['form']['fieldsMetadata'];
-export type PaymentMethodFormFieldsType = UsePaymentMethodFormReady['form']['Fields'];

package/dist/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePaymentMethodForm.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { EmployeePaymentMethod } from '@gusto/embedded-api-v-2025-11-15/models/components/employeepaymentmethod'\nimport { useEmployeePaymentMethodGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodGet'\nimport { useEmployeePaymentMethodUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodUpdate'\nimport {\n  PAYMENT_METHOD_TYPES,\n  type PaymentMethodFormData,\n  type PaymentMethodFormOptionalFieldsToRequire,\n  type PaymentMethodFormOutputs,\n  type PaymentMethodType,\n  createPaymentMethodFormSchema,\n} from './usePaymentMethodFormSchema'\nimport { TypeField } from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { withOptions } from '@/partner-hook-utils/form/withOptions'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\nimport { PAYMENT_METHODS, SPLIT_BY } from '@/shared/constants'\n\nexport interface UsePaymentMethodFormProps {\n  employeeId: string\n  optionalFieldsToRequire?: PaymentMethodFormOptionalFieldsToRequire\n  defaultValues?: Partial<PaymentMethodFormData>\n  validationMode?: UseFormProps['mode']\n  shouldFocusError?: boolean\n}\n\nexport interface PaymentMethodFormFields {\n  Type: typeof TypeField\n}\n\nexport interface UsePaymentMethodFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  PaymentMethodFormData,\n  PaymentMethodFormFields\n> {\n  data: {\n    paymentMethod: EmployeePaymentMethod\n  }\n  status: { isPending: boolean; mode: 'update' }\n  actions: {\n    onSubmit: () => Promise<HookSubmitResult<EmployeePaymentMethod> | undefined>\n  }\n}\n\nexport function usePaymentMethodForm({\n  employeeId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UsePaymentMethodFormProps): HookLoadingResult | UsePaymentMethodFormReady {\n  const paymentMethodQuery = useEmployeePaymentMethodGet({ employeeId })\n  const paymentMethod = paymentMethodQuery.data?.employeePaymentMethod\n\n  const [schema, metadataConfig] = useMemo(\n    () => createPaymentMethodFormSchema({ optionalFieldsToRequire }),\n    [optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: PaymentMethodFormData = useMemo(\n    () => ({\n      type: (partnerDefaults?.type ??\n        paymentMethod?.type ??\n        PAYMENT_METHODS.directDeposit) as PaymentMethodType,\n    }),\n    [partnerDefaults, paymentMethod],\n  )\n\n  const formMethods = useForm<PaymentMethodFormData, unknown, PaymentMethodFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const updateMutation = useEmployeePaymentMethodUpdateMutation()\n  const isPending = updateMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('PaymentMethodForm')\n\n  const errorHandling = composeErrorHandler([paymentMethodQuery], {\n    submitError,\n    setSubmitError,\n  })\n\n  const typeOptions = PAYMENT_METHOD_TYPES.map(value => ({ value, label: value }))\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    type: withOptions<PaymentMethodType>(baseMetadata.type, typeOptions, [...PAYMENT_METHOD_TYPES]),\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<EmployeePaymentMethod> | undefined> => {\n    if (!paymentMethod) {\n      throw new SDKInternalError('Cannot submit payment method form before data is loaded')\n    }\n    const currentPaymentMethod = paymentMethod\n    let submitResult: HookSubmitResult<EmployeePaymentMethod> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: PaymentMethodFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const version = currentPaymentMethod.version as string\n            const body =\n              payload.type === PAYMENT_METHODS.check\n                ? { version }\n                : {\n                    ...currentPaymentMethod,\n                    version,\n                    splitBy: currentPaymentMethod.splitBy ?? SPLIT_BY.percentage,\n                    splits: currentPaymentMethod.splits ?? [],\n                  }\n\n            const response = await updateMutation.mutateAsync({\n              request: { employeeId, requestBody: { ...body, type: payload.type } },\n            })\n\n            if (!response.employeePaymentMethod) {\n              throw new SDKInternalError('Payment method update failed')\n            }\n\n            submitResult = { mode: 'update' as const, data: response.employeePaymentMethod }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  if (paymentMethodQuery.isLoading || !paymentMethod) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: { paymentMethod },\n    status: { isPending, mode: 'update' as const },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Type: TypeField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\nexport type UsePaymentMethodFormResult = HookLoadingResult | UsePaymentMethodFormReady\nexport type PaymentMethodFormFieldsMetadata = UsePaymentMethodFormReady['form']['fieldsMetadata']\nexport type PaymentMethodFormFieldsType = UsePaymentMethodFormReady['form']['Fields']\n"],"names":["usePaymentMethodForm","employeeId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","paymentMethodQuery","useEmployeePaymentMethodGet","paymentMethod","schema","metadataConfig","useMemo","createPaymentMethodFormSchema","resolvedDefaults","PAYMENT_METHODS","formMethods","useForm","zodResolver","updateMutation","useEmployeePaymentMethodUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","typeOptions","PAYMENT_METHOD_TYPES","value","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","SDKInternalError","currentPaymentMethod","submitResult","resolve","data","payload","version","body","SPLIT_BY","response","hookFormInternals","useHookFormInternals","TypeField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;AAyDO,SAASA,GAAqB;AAAA,EACnC,YAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAA6E;AAC3E,QAAMC,IAAqBC,EAA4B,EAAE,YAAAN,GAAY,GAC/DO,IAAgBF,EAAmB,MAAM,uBAEzC,CAACG,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAA8B,EAAE,yBAAAV,GAAyB;AAAA,IAC/D,CAACA,CAAuB;AAAA,EAAA,GAGpBW,IAA0CF;AAAA,IAC9C,OAAO;AAAA,MACL,MAAOR,GAAiB,QACtBK,GAAe,QACfM,EAAgB;AAAA,IAAA;AAAA,IAEpB,CAACX,GAAiBK,CAAa;AAAA,EAAA,GAG3BO,IAAcC,EAAkE;AAAA,IACpF,UAAUC,EAAYR,CAAM;AAAA,IAC5B,MAAML;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeQ;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKK,IAAiBC,EAAA,GACjBC,IAAYF,EAAe,WAE3B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,mBAAmB,GAE/BC,IAAgBC,EAAoB,CAACpB,CAAkB,GAAG;AAAA,IAC9D,aAAAgB;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKI,IAAcC,EAAqB,IAAI,CAAAC,OAAU,EAAE,OAAAA,GAAO,OAAOA,IAAQ,GAEzEC,IAAeC,EAAwBrB,GAAgBK,EAAY,OAAO,GAC1EiB,IAAiB;AAAA,IACrB,MAAMC,EAA+BH,EAAa,MAAMH,GAAa,CAAC,GAAGC,CAAoB,CAAC;AAAA,EAAA,GAG1FM,IAAW,YAA0E;AACzF,QAAI,CAAC1B;AACH,YAAM,IAAI2B,EAAiB,yDAAyD;AAEtF,UAAMC,IAAuB5B;AAC7B,QAAI6B;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKvB,EAAY;AAAA,QACf,OAAOwB,MAAmC;AACxC,gBAAMlB,EAAkBkB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAUL,EAAqB,SAC/BM,IACJF,EAAQ,SAAS1B,EAAgB,QAC7B,EAAE,SAAA2B,MACF;AAAA,cACE,GAAGL;AAAA,cACH,SAAAK;AAAA,cACA,SAASL,EAAqB,WAAWO,EAAS;AAAA,cAClD,QAAQP,EAAqB,UAAU,CAAA;AAAA,YAAC,GAG1CQ,IAAW,MAAM1B,EAAe,YAAY;AAAA,cAChD,SAAS,EAAE,YAAAjB,GAAY,aAAa,EAAE,GAAGyC,GAAM,MAAMF,EAAQ,KAAA,EAAK;AAAA,YAAE,CACrE;AAED,gBAAI,CAACI,EAAS;AACZ,oBAAM,IAAIT,EAAiB,8BAA8B;AAG3D,YAAAE,IAAe,EAAE,MAAM,UAAmB,MAAMO,EAAS,sBAAA;AAAA,UAC3D,CAAC,GACDN,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMQ,IAAoBC,EAAqB/B,CAAW;AAE1D,SAAIT,EAAmB,aAAa,CAACE,IAC5B,EAAE,WAAW,IAAe,eAAAiB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,eAAAjB,EAAA;AAAA,IACR,QAAQ,EAAE,WAAAY,GAAW,MAAM,SAAA;AAAA,IAC3B,SAAS,EAAE,UAAAc,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,MAAMsB;AAAA,MAAA;AAAA,MAER,gBAAAf;AAAA,MACA,mBAAAa;AAAA,MACA,yBAAyBG,EAA8BjC,GAAaN,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}
+{"version":3,"file":"usePaymentMethodForm.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { EmployeePaymentMethod } from '@gusto/embedded-api-v-2025-11-15/models/components/employeepaymentmethod'\nimport { useEmployeePaymentMethodGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodGet'\nimport { useEmployeePaymentMethodUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodUpdate'\nimport {\n  PAYMENT_METHOD_TYPES,\n  type PaymentMethodFormData,\n  type PaymentMethodFormOptionalFieldsToRequire,\n  type PaymentMethodFormOutputs,\n  type PaymentMethodType,\n  createPaymentMethodFormSchema,\n} from './usePaymentMethodFormSchema'\nimport { TypeField } from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { withOptions } from '@/partner-hook-utils/form/withOptions'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\nimport { PAYMENT_METHODS, SPLIT_BY } from '@/shared/constants'\n\n/**\n * Props for {@link usePaymentMethodForm}.\n *\n * @public\n */\nexport interface UsePaymentMethodFormProps {\n  /** Employee whose payment method is being edited. */\n  employeeId: string\n  /** Override optional fields to be required. Reserved for future schema expansion — `type` is always required and always has a default. */\n  optionalFieldsToRequire?: PaymentMethodFormOptionalFieldsToRequire\n  /** Pre-fill form values. Server data (the current payment method) is used when no override is supplied. */\n  defaultValues?: Partial<PaymentMethodFormData>\n  /** When validation runs. Passed through to react-hook-form. Defaults to `'onSubmit'`. */\n  validationMode?: UseFormProps['mode']\n  /** Auto-focus the first invalid field on submit. Set to `false` when using `composeSubmitHandler`. Defaults to `true`. */\n  shouldFocusError?: boolean\n}\n\n/**\n * Field components exposed by {@link usePaymentMethodForm} on `form.Fields`.\n *\n * @public\n */\nexport interface PaymentMethodFormFields {\n  /** Bound to `type` — see {@link TypeField}. */\n  Type: typeof TypeField\n}\n\n/**\n * Ready-state return value of {@link usePaymentMethodForm}.\n *\n * @public\n */\nexport interface UsePaymentMethodFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  PaymentMethodFormData,\n  PaymentMethodFormFields\n> {\n  /** The employee's current payment method, loaded from the API. */\n  data: {\n    paymentMethod: EmployeePaymentMethod\n  }\n  /** `isPending` reflects the in-flight update mutation; `mode` is always `'update'`. */\n  status: { isPending: boolean; mode: 'update' }\n  /** Submit the form. Returns the updated payment method on success or `undefined` on validation/mutation failure. */\n  actions: {\n    onSubmit: () => Promise<HookSubmitResult<EmployeePaymentMethod> | undefined>\n  }\n}\n\n/**\n * Headless React Hook Form hook for updating an employee's payment method.\n *\n * @remarks\n * Switches between Direct Deposit and Check. Always operates in update mode —\n * every employee has a payment method, defaulting to Check. Switching to Check\n * sends a minimal request body; switching to or staying on Direct Deposit\n * preserves the existing splits and version so split allocations are not lost\n * when only the type changes.\n *\n * @param props - See {@link UsePaymentMethodFormProps}.\n * @returns A loading-state result while the current payment method is loading, or a {@link UsePaymentMethodFormReady} once ready.\n * @public\n *\n * @example\n * ```tsx\n * import {\n *   usePaymentMethodForm,\n *   SDKFormProvider,\n *   PAYMENT_METHODS,\n *   type PaymentMethodType,\n * } from '@gusto/embedded-react-sdk'\n *\n * function PaymentMethodScreen({ employeeId }: { employeeId: string }) {\n *   const paymentMethodForm = usePaymentMethodForm({ employeeId })\n *\n *   if (paymentMethodForm.isLoading) return null\n *   const { Fields } = paymentMethodForm.form\n *\n *   return (\n *     <SDKFormProvider formHookResult={paymentMethodForm}>\n *       <form\n *         onSubmit={e => {\n *           e.preventDefault()\n *           void paymentMethodForm.actions.onSubmit()\n *         }}\n *       >\n *         <Fields.Type\n *           label=\"Select payment method\"\n *           getOptionLabel={(value: PaymentMethodType) =>\n *             value === PAYMENT_METHODS.directDeposit ? 'Direct Deposit' : 'Check'\n *           }\n *         />\n *         <button type=\"submit\" disabled={paymentMethodForm.status.isPending}>Save</button>\n *       </form>\n *     </SDKFormProvider>\n *   )\n * }\n * ```\n */\nexport function usePaymentMethodForm({\n  employeeId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UsePaymentMethodFormProps): HookLoadingResult | UsePaymentMethodFormReady {\n  const paymentMethodQuery = useEmployeePaymentMethodGet({ employeeId })\n  const paymentMethod = paymentMethodQuery.data?.employeePaymentMethod\n\n  const [schema, metadataConfig] = useMemo(\n    () => createPaymentMethodFormSchema({ optionalFieldsToRequire }),\n    [optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: PaymentMethodFormData = useMemo(\n    () => ({\n      type: (partnerDefaults?.type ??\n        paymentMethod?.type ??\n        PAYMENT_METHODS.directDeposit) as PaymentMethodType,\n    }),\n    [partnerDefaults, paymentMethod],\n  )\n\n  const formMethods = useForm<PaymentMethodFormData, unknown, PaymentMethodFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const updateMutation = useEmployeePaymentMethodUpdateMutation()\n  const isPending = updateMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('PaymentMethodForm')\n\n  const errorHandling = composeErrorHandler([paymentMethodQuery], {\n    submitError,\n    setSubmitError,\n  })\n\n  const typeOptions = PAYMENT_METHOD_TYPES.map(value => ({ value, label: value }))\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    type: withOptions<PaymentMethodType>(baseMetadata.type, typeOptions, [...PAYMENT_METHOD_TYPES]),\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<EmployeePaymentMethod> | undefined> => {\n    if (!paymentMethod) {\n      throw new SDKInternalError('Cannot submit payment method form before data is loaded')\n    }\n    const currentPaymentMethod = paymentMethod\n    let submitResult: HookSubmitResult<EmployeePaymentMethod> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: PaymentMethodFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const version = currentPaymentMethod.version as string\n            const body =\n              payload.type === PAYMENT_METHODS.check\n                ? { version }\n                : {\n                    ...currentPaymentMethod,\n                    version,\n                    splitBy: currentPaymentMethod.splitBy ?? SPLIT_BY.percentage,\n                    splits: currentPaymentMethod.splits ?? [],\n                  }\n\n            const response = await updateMutation.mutateAsync({\n              request: { employeeId, requestBody: { ...body, type: payload.type } },\n            })\n\n            if (!response.employeePaymentMethod) {\n              throw new SDKInternalError('Payment method update failed')\n            }\n\n            submitResult = { mode: 'update' as const, data: response.employeePaymentMethod }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  if (paymentMethodQuery.isLoading || !paymentMethod) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: { paymentMethod },\n    status: { isPending, mode: 'update' as const },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Type: TypeField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Return type of {@link usePaymentMethodForm} — a discriminated union on `isLoading`.\n *\n * @public\n */\nexport type UsePaymentMethodFormResult = HookLoadingResult | UsePaymentMethodFormReady\n\n/**\n * Per-field metadata exposed on `form.fieldsMetadata` for {@link usePaymentMethodForm}.\n *\n * @public\n */\nexport type PaymentMethodFormFieldsMetadata = UsePaymentMethodFormReady['form']['fieldsMetadata']\n"],"names":["usePaymentMethodForm","employeeId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","paymentMethodQuery","useEmployeePaymentMethodGet","paymentMethod","schema","metadataConfig","useMemo","createPaymentMethodFormSchema","resolvedDefaults","PAYMENT_METHODS","formMethods","useForm","zodResolver","updateMutation","useEmployeePaymentMethodUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","typeOptions","PAYMENT_METHOD_TYPES","value","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","SDKInternalError","currentPaymentMethod","submitResult","resolve","data","payload","version","body","SPLIT_BY","response","hookFormInternals","useHookFormInternals","TypeField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;AAmIO,SAASA,GAAqB;AAAA,EACnC,YAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAA6E;AAC3E,QAAMC,IAAqBC,EAA4B,EAAE,YAAAN,GAAY,GAC/DO,IAAgBF,EAAmB,MAAM,uBAEzC,CAACG,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAA8B,EAAE,yBAAAV,GAAyB;AAAA,IAC/D,CAACA,CAAuB;AAAA,EAAA,GAGpBW,IAA0CF;AAAA,IAC9C,OAAO;AAAA,MACL,MAAOR,GAAiB,QACtBK,GAAe,QACfM,EAAgB;AAAA,IAAA;AAAA,IAEpB,CAACX,GAAiBK,CAAa;AAAA,EAAA,GAG3BO,IAAcC,EAAkE;AAAA,IACpF,UAAUC,EAAYR,CAAM;AAAA,IAC5B,MAAML;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeQ;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKK,IAAiBC,EAAA,GACjBC,IAAYF,EAAe,WAE3B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,mBAAmB,GAE/BC,IAAgBC,EAAoB,CAACpB,CAAkB,GAAG;AAAA,IAC9D,aAAAgB;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKI,IAAcC,EAAqB,IAAI,CAAAC,OAAU,EAAE,OAAAA,GAAO,OAAOA,IAAQ,GAEzEC,IAAeC,EAAwBrB,GAAgBK,EAAY,OAAO,GAC1EiB,IAAiB;AAAA,IACrB,MAAMC,EAA+BH,EAAa,MAAMH,GAAa,CAAC,GAAGC,CAAoB,CAAC;AAAA,EAAA,GAG1FM,IAAW,YAA0E;AACzF,QAAI,CAAC1B;AACH,YAAM,IAAI2B,EAAiB,yDAAyD;AAEtF,UAAMC,IAAuB5B;AAC7B,QAAI6B;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKvB,EAAY;AAAA,QACf,OAAOwB,MAAmC;AACxC,gBAAMlB,EAAkBkB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAUL,EAAqB,SAC/BM,IACJF,EAAQ,SAAS1B,EAAgB,QAC7B,EAAE,SAAA2B,MACF;AAAA,cACE,GAAGL;AAAA,cACH,SAAAK;AAAA,cACA,SAASL,EAAqB,WAAWO,EAAS;AAAA,cAClD,QAAQP,EAAqB,UAAU,CAAA;AAAA,YAAC,GAG1CQ,IAAW,MAAM1B,EAAe,YAAY;AAAA,cAChD,SAAS,EAAE,YAAAjB,GAAY,aAAa,EAAE,GAAGyC,GAAM,MAAMF,EAAQ,KAAA,EAAK;AAAA,YAAE,CACrE;AAED,gBAAI,CAACI,EAAS;AACZ,oBAAM,IAAIT,EAAiB,8BAA8B;AAG3D,YAAAE,IAAe,EAAE,MAAM,UAAmB,MAAMO,EAAS,sBAAA;AAAA,UAC3D,CAAC,GACDN,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMQ,IAAoBC,EAAqB/B,CAAW;AAE1D,SAAIT,EAAmB,aAAa,CAACE,IAC5B,EAAE,WAAW,IAAe,eAAAiB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,eAAAjB,EAAA;AAAA,IACR,QAAQ,EAAE,WAAAY,GAAW,MAAM,SAAA;AAAA,IAC3B,SAAS,EAAE,UAAAc,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,MAAMsB;AAAA,MAAA;AAAA,MAER,gBAAAf;AAAA,MACA,mBAAAa;AAAA,MACA,yBAAyBG,EAA8BjC,GAAaN,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodFormSchema.d.ts

@@ -1,10 +1,32 @@
 import { z } from 'zod';
 import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes emitted by the payment method form schema. Map these
+ * codes to localized copy in `validationMessages` when composing the hook.
+ *
+ * @public
+ */
 export declare const PaymentMethodFormErrorCodes: {
     readonly REQUIRED: "REQUIRED";
 };
+/**
+ * Union of validation error code strings emitted by the payment method form
+ * schema.
+ *
+ * @public
+ */
 export type PaymentMethodFormErrorCode = (typeof PaymentMethodFormErrorCodes)[keyof typeof PaymentMethodFormErrorCodes];
+/**
+ * Supported payment method type values: direct deposit and check.
+ *
+ * @public
+ */
 export declare const PAYMENT_METHOD_TYPES: readonly ["Direct Deposit", "Check"];
+/**
+ * Union of payment method type values that the form accepts.
+ *
+ * @public
+ */
 export type PaymentMethodType = (typeof PAYMENT_METHOD_TYPES)[number];
 declare const fieldValidators: {
     type: z.ZodEnum<{
@@ -12,16 +34,39 @@ declare const fieldValidators: {
         "Direct Deposit": "Direct Deposit";
     }>;
 };
+/**
+ * Field names accepted by the payment method form.
+ *
+ * @public
+ */
 export type PaymentMethodFormField = keyof typeof fieldValidators;
+/**
+ * Shape of the values managed by the payment method form.
+ *
+ * @public
+ */
 export type PaymentMethodFormData = {
     [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
 };
+/**
+ * Shape of the validated values produced by the payment method form on submit.
+ *
+ * @public
+ */
 export type PaymentMethodFormOutputs = PaymentMethodFormData;
 declare const requiredFieldsConfig: {};
+/**
+ * Keys of optional payment method fields that can be promoted to required via
+ * the hook's `optionalFieldsToRequire` option.
+ *
+ * @public
+ */
 export type PaymentMethodFormOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+/** @internal */
 interface PaymentMethodFormSchemaOptions {
     optionalFieldsToRequire?: PaymentMethodFormOptionalFieldsToRequire;
 }
+/** @internal */
 export declare function createPaymentMethodFormSchema(options?: PaymentMethodFormSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
     type: z.ZodEnum<{
         Check: "Check";

package/dist/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodFormSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePaymentMethodFormSchema.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type OptionalFieldsToRequire,\n  type RequiredFieldConfig,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { PAYMENT_METHODS } from '@/shared/constants'\n\nexport const PaymentMethodFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\nexport type PaymentMethodFormErrorCode =\n  (typeof PaymentMethodFormErrorCodes)[keyof typeof PaymentMethodFormErrorCodes]\n\nexport const PAYMENT_METHOD_TYPES = [PAYMENT_METHODS.directDeposit, PAYMENT_METHODS.check] as const\n\nexport type PaymentMethodType = (typeof PAYMENT_METHOD_TYPES)[number]\n\nconst fieldValidators = {\n  type: z.enum(PAYMENT_METHOD_TYPES),\n}\n\nexport type PaymentMethodFormField = keyof typeof fieldValidators\n\nexport type PaymentMethodFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\nexport type PaymentMethodFormOutputs = PaymentMethodFormData\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\nexport type PaymentMethodFormOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\ninterface PaymentMethodFormSchemaOptions {\n  optionalFieldsToRequire?: PaymentMethodFormOptionalFieldsToRequire\n}\n\nexport function createPaymentMethodFormSchema(options: PaymentMethodFormSchemaOptions = {}) {\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: PaymentMethodFormErrorCodes.REQUIRED,\n    mode: 'update',\n    optionalFieldsToRequire: options.optionalFieldsToRequire,\n  })\n}\n"],"names":["PaymentMethodFormErrorCodes","PAYMENT_METHOD_TYPES","PAYMENT_METHODS","fieldValidators","z","requiredFieldsConfig","createPaymentMethodFormSchema","options","buildFormSchema"],"mappings":";;;AAQO,MAAMA,IAA8B;AAAA,EACzC,UAAU;AACZ,GAKaC,IAAuB,CAACC,EAAgB,eAAeA,EAAgB,KAAK,GAInFC,IAAkB;AAAA,EACtB,MAAMC,EAAE,KAAKH,CAAoB;AACnC,GASMI,IAAuB,CAAA;AAUtB,SAASC,EAA8BC,IAA0C,IAAI;AAC1F,SAAOC,EAAgBL,GAAiB;AAAA,IACtC,sBAAAE;AAAA,IACA,mBAAmBL,EAA4B;AAAA,IAC/C,MAAM;AAAA,IACN,yBAAyBO,EAAQ;AAAA,EAAA,CAClC;AACH;"}
+{"version":3,"file":"usePaymentMethodFormSchema.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodForm/usePaymentMethodFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type OptionalFieldsToRequire,\n  type RequiredFieldConfig,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { PAYMENT_METHODS } from '@/shared/constants'\n\n/**\n * Validation error codes emitted by the payment method form schema. Map these\n * codes to localized copy in `validationMessages` when composing the hook.\n *\n * @public\n */\nexport const PaymentMethodFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\n/**\n * Union of validation error code strings emitted by the payment method form\n * schema.\n *\n * @public\n */\nexport type PaymentMethodFormErrorCode =\n  (typeof PaymentMethodFormErrorCodes)[keyof typeof PaymentMethodFormErrorCodes]\n\n/**\n * Supported payment method type values: direct deposit and check.\n *\n * @public\n */\nexport const PAYMENT_METHOD_TYPES = [PAYMENT_METHODS.directDeposit, PAYMENT_METHODS.check] as const\n\n/**\n * Union of payment method type values that the form accepts.\n *\n * @public\n */\nexport type PaymentMethodType = (typeof PAYMENT_METHOD_TYPES)[number]\n\nconst fieldValidators = {\n  type: z.enum(PAYMENT_METHOD_TYPES),\n}\n\n/**\n * Field names accepted by the payment method form.\n *\n * @public\n */\nexport type PaymentMethodFormField = keyof typeof fieldValidators\n\n/**\n * Shape of the values managed by the payment method form.\n *\n * @public\n */\nexport type PaymentMethodFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n/**\n * Shape of the validated values produced by the payment method form on submit.\n *\n * @public\n */\nexport type PaymentMethodFormOutputs = PaymentMethodFormData\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Keys of optional payment method fields that can be promoted to required via\n * the hook's `optionalFieldsToRequire` option.\n *\n * @public\n */\nexport type PaymentMethodFormOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\n/** @internal */\ninterface PaymentMethodFormSchemaOptions {\n  optionalFieldsToRequire?: PaymentMethodFormOptionalFieldsToRequire\n}\n\n/** @internal */\nexport function createPaymentMethodFormSchema(options: PaymentMethodFormSchemaOptions = {}) {\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: PaymentMethodFormErrorCodes.REQUIRED,\n    mode: 'update',\n    optionalFieldsToRequire: options.optionalFieldsToRequire,\n  })\n}\n"],"names":["PaymentMethodFormErrorCodes","PAYMENT_METHOD_TYPES","PAYMENT_METHODS","fieldValidators","z","requiredFieldsConfig","createPaymentMethodFormSchema","options","buildFormSchema"],"mappings":";;;AAcO,MAAMA,IAA8B;AAAA,EACzC,UAAU;AACZ,GAgBaC,IAAuB,CAACC,EAAgB,eAAeA,EAAgB,KAAK,GASnFC,IAAkB;AAAA,EACtB,MAAMC,EAAE,KAAKH,CAAoB;AACnC,GAwBMI,IAAuB,CAAA;AAkBtB,SAASC,EAA8BC,IAA0C,IAAI;AAC1F,SAAOC,EAAgBL,GAAiB;AAAA,IACtC,sBAAAE;AAAA,IACA,mBAAmBL,EAA4B;AAAA,IAC/C,MAAM;AAAA,IACN,yBAAyBO,EAAQ;AAAA,EAAA,CAClC;AACH;"}

package/dist/components/Employee/PaymentMethod/shared/usePaymentMethodList.d.ts

@@ -1,9 +1,12 @@
 import { EmployeeBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/employeebankaccount';
 import { EmployeePaymentMethod } from '@gusto/embedded-api-v-2025-11-15/models/components/employeepaymentmethod';
 import { BaseHookReady, HookLoadingResult, HookSubmitResult } from '../../../../partner-hook-utils/types';
+/** @internal */
 export interface UsePaymentMethodListParams {
+    /** Employee whose payment method and bank accounts to load. */
     employeeId: string;
 }
+/** @internal */
 export interface UsePaymentMethodListReady extends BaseHookReady<{
     paymentMethod: EmployeePaymentMethod;
     bankAccounts: EmployeeBankAccount[];
@@ -12,9 +15,12 @@ export interface UsePaymentMethodListReady extends BaseHookReady<{
     isPending: boolean;
     deletePendingBankAccountUuid?: string;
 }> {
+    /** Delete a bank account by UUID. Returns the delete response on success or `undefined` on failure. */
     actions: {
         onDelete: (bankAccountUuid: string) => Promise<HookSubmitResult<unknown> | undefined>;
     };
 }
+/** @internal */
 export type UsePaymentMethodListResult = HookLoadingResult | UsePaymentMethodListReady;
+/** @internal */
 export declare function usePaymentMethodList({ employeeId, }: UsePaymentMethodListParams): UsePaymentMethodListResult;

package/dist/components/Employee/PaymentMethod/shared/usePaymentMethodList.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePaymentMethodList.js","sources":["../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodList.ts"],"sourcesContent":["import type { EmployeeBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/employeebankaccount'\nimport type { EmployeePaymentMethod } from '@gusto/embedded-api-v-2025-11-15/models/components/employeepaymentmethod'\nimport { useEmployeePaymentMethodDeleteBankAccountMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodDeleteBankAccount'\nimport { useEmployeePaymentMethodsGetBankAccounts } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodsGetBankAccounts'\nimport { useEmployeePaymentMethodGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodGet'\nimport { useEmployeePaymentMethodUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodUpdate'\nimport { useEffect, useRef } from 'react'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport type { BaseHookReady, HookLoadingResult, HookSubmitResult } from '@/partner-hook-utils/types'\nimport { SPLIT_BY } from '@/shared/constants'\n\nexport interface UsePaymentMethodListParams {\n  employeeId: string\n}\n\nexport interface UsePaymentMethodListReady extends BaseHookReady<\n  { paymentMethod: EmployeePaymentMethod; bankAccounts: EmployeeBankAccount[] },\n  { isFetching: boolean; isPending: boolean; deletePendingBankAccountUuid?: string }\n> {\n  actions: {\n    onDelete: (bankAccountUuid: string) => Promise<HookSubmitResult<unknown> | undefined>\n  }\n}\n\nexport type UsePaymentMethodListResult = HookLoadingResult | UsePaymentMethodListReady\n\nexport function usePaymentMethodList({\n  employeeId,\n}: UsePaymentMethodListParams): UsePaymentMethodListResult {\n  const paymentMethodQuery = useEmployeePaymentMethodGet({ employeeId })\n  const bankAccountsQuery = useEmployeePaymentMethodsGetBankAccounts({ employeeId })\n\n  const paymentMethod = paymentMethodQuery.data?.employeePaymentMethod\n  const bankAccounts = bankAccountsQuery.data?.employeeBankAccounts\n\n  const deleteBankAccountMutation = useEmployeePaymentMethodDeleteBankAccountMutation()\n  const { mutateAsync: mutatePaymentMethod } = useEmployeePaymentMethodUpdateMutation()\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('PaymentMethodList')\n\n  const normalizingRef = useRef(false)\n  // Normalise single-account direct deposit to 100% on mount, skipping if already normalized\n  // or if a normalization mutation is already in-flight (prevents version-conflict 409s).\n  useEffect(() => {\n    if (!paymentMethod) return\n    const firstSplit = paymentMethod.splits?.[0]\n    const alreadyNormalized =\n      firstSplit?.splitAmount === 100 && paymentMethod.splitBy === SPLIT_BY.percentage\n    if (\n      paymentMethod.splits?.length === 1 &&\n      paymentMethod.type === 'Direct Deposit' &&\n      !alreadyNormalized &&\n      !normalizingRef.current\n    ) {\n      normalizingRef.current = true\n      void (async () => {\n        try {\n          await mutatePaymentMethod({\n            request: {\n              employeeId,\n              requestBody: {\n                splitBy: SPLIT_BY.percentage,\n                splits: paymentMethod.splits!.map(split => ({\n                  ...split,\n                  splitAmount: 100,\n                  priority: 1,\n                })),\n                version: paymentMethod.version as string,\n                type: 'Direct Deposit',\n              },\n            },\n          })\n        } finally {\n          normalizingRef.current = false\n        }\n      })()\n    }\n  }, [employeeId, paymentMethod, mutatePaymentMethod])\n\n  const errorHandling = composeErrorHandler([paymentMethodQuery, bankAccountsQuery], {\n    submitError,\n    setSubmitError,\n  })\n\n  const onDelete = async (\n    bankAccountUuid: string,\n  ): Promise<HookSubmitResult<unknown> | undefined> => {\n    let submitResult: HookSubmitResult<unknown> | undefined\n    await baseSubmitHandler(bankAccountUuid, async uuid => {\n      const data = await deleteBankAccountMutation.mutateAsync({\n        request: { employeeId, bankAccountUuid: uuid },\n      })\n      submitResult = { mode: 'update', data }\n    })\n    return submitResult\n  }\n\n  const deletePendingBankAccountUuid = deleteBankAccountMutation.isPending\n    ? deleteBankAccountMutation.variables.request.bankAccountUuid\n    : undefined\n\n  if (\n    paymentMethodQuery.isLoading ||\n    bankAccountsQuery.isLoading ||\n    !paymentMethod ||\n    !bankAccounts\n  ) {\n    return { isLoading: true, errorHandling }\n  }\n\n  return {\n    isLoading: false,\n    data: { paymentMethod, bankAccounts },\n    status: {\n      isFetching: paymentMethodQuery.isFetching || bankAccountsQuery.isFetching,\n      isPending: deleteBankAccountMutation.isPending,\n      deletePendingBankAccountUuid,\n    },\n    actions: { onDelete },\n    errorHandling,\n  }\n}\n"],"names":["usePaymentMethodList","employeeId","paymentMethodQuery","useEmployeePaymentMethodGet","bankAccountsQuery","useEmployeePaymentMethodsGetBankAccounts","paymentMethod","bankAccounts","deleteBankAccountMutation","useEmployeePaymentMethodDeleteBankAccountMutation","mutatePaymentMethod","useEmployeePaymentMethodUpdateMutation","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","normalizingRef","useRef","useEffect","alreadyNormalized","SPLIT_BY","split","errorHandling","composeErrorHandler","onDelete","bankAccountUuid","submitResult","uuid","deletePendingBankAccountUuid"],"mappings":";;;;;;;;AA2BO,SAASA,EAAqB;AAAA,EACnC,YAAAC;AACF,GAA2D;AACzD,QAAMC,IAAqBC,EAA4B,EAAE,YAAAF,GAAY,GAC/DG,IAAoBC,EAAyC,EAAE,YAAAJ,GAAY,GAE3EK,IAAgBJ,EAAmB,MAAM,uBACzCK,IAAeH,EAAkB,MAAM,sBAEvCI,IAA4BC,EAAA,GAC5B,EAAE,aAAaC,EAAA,IAAwBC,EAAA,GAEvC;AAAA,IACJ,mBAAAC;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,mBAAmB,GAE/BC,IAAiBC,EAAO,EAAK;AAGnC,EAAAC,EAAU,MAAM;AACd,QAAI,CAACZ,EAAe;AAEpB,UAAMa,IADab,EAAc,SAAS,CAAC,GAE7B,gBAAgB,OAAOA,EAAc,YAAYc,EAAS;AACxE,IACEd,EAAc,QAAQ,WAAW,KACjCA,EAAc,SAAS,oBACvB,CAACa,KACD,CAACH,EAAe,YAEhBA,EAAe,UAAU,KACnB,YAAY;AAChB,UAAI;AACF,cAAMN,EAAoB;AAAA,UACxB,SAAS;AAAA,YACP,YAAAT;AAAA,YACA,aAAa;AAAA,cACX,SAASmB,EAAS;AAAA,cAClB,QAAQd,EAAc,OAAQ,IAAI,CAAAe,OAAU;AAAA,gBAC1C,GAAGA;AAAA,gBACH,aAAa;AAAA,gBACb,UAAU;AAAA,cAAA,EACV;AAAA,cACF,SAASf,EAAc;AAAA,cACvB,MAAM;AAAA,YAAA;AAAA,UACR;AAAA,QACF,CACD;AAAA,MACH,UAAA;AACE,QAAAU,EAAe,UAAU;AAAA,MAC3B;AAAA,IACF,GAAA;AAAA,EAEJ,GAAG,CAACf,GAAYK,GAAeI,CAAmB,CAAC;AAEnD,QAAMY,IAAgBC,EAAoB,CAACrB,GAAoBE,CAAiB,GAAG;AAAA,IACjF,aAAAS;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKU,IAAW,OACfC,MACmD;AACnD,QAAIC;AACJ,iBAAMd,EAAkBa,GAAiB,OAAME,MAAQ;AAIrD,MAAAD,IAAe,EAAE,MAAM,UAAU,MAHpB,MAAMlB,EAA0B,YAAY;AAAA,QACvD,SAAS,EAAE,YAAAP,GAAY,iBAAiB0B,EAAA;AAAA,MAAK,CAC9C,EACgC;AAAA,IACnC,CAAC,GACMD;AAAA,EACT,GAEME,IAA+BpB,EAA0B,YAC3DA,EAA0B,UAAU,QAAQ,kBAC5C;AAEJ,SACEN,EAAmB,aACnBE,EAAkB,aAClB,CAACE,KACD,CAACC,IAEM,EAAE,WAAW,IAAM,eAAAe,EAAA,IAGrB;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,eAAAhB,GAAe,cAAAC,EAAA;AAAA,IACvB,QAAQ;AAAA,MACN,YAAYL,EAAmB,cAAcE,EAAkB;AAAA,MAC/D,WAAWI,EAA0B;AAAA,MACrC,8BAAAoB;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAJ,EAAA;AAAA,IACX,eAAAF;AAAA,EAAA;AAEJ;"}
+{"version":3,"file":"usePaymentMethodList.js","sources":["../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodList.ts"],"sourcesContent":["import type { EmployeeBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/employeebankaccount'\nimport type { EmployeePaymentMethod } from '@gusto/embedded-api-v-2025-11-15/models/components/employeepaymentmethod'\nimport { useEmployeePaymentMethodDeleteBankAccountMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodDeleteBankAccount'\nimport { useEmployeePaymentMethodsGetBankAccounts } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodsGetBankAccounts'\nimport { useEmployeePaymentMethodGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodGet'\nimport { useEmployeePaymentMethodUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodUpdate'\nimport { useEffect, useRef } from 'react'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport type { BaseHookReady, HookLoadingResult, HookSubmitResult } from '@/partner-hook-utils/types'\nimport { SPLIT_BY } from '@/shared/constants'\n\n/** @internal */\nexport interface UsePaymentMethodListParams {\n  /** Employee whose payment method and bank accounts to load. */\n  employeeId: string\n}\n\n/** @internal */\nexport interface UsePaymentMethodListReady extends BaseHookReady<\n  { paymentMethod: EmployeePaymentMethod; bankAccounts: EmployeeBankAccount[] },\n  { isFetching: boolean; isPending: boolean; deletePendingBankAccountUuid?: string }\n> {\n  /** Delete a bank account by UUID. Returns the delete response on success or `undefined` on failure. */\n  actions: {\n    onDelete: (bankAccountUuid: string) => Promise<HookSubmitResult<unknown> | undefined>\n  }\n}\n\n/** @internal */\nexport type UsePaymentMethodListResult = HookLoadingResult | UsePaymentMethodListReady\n\n/** @internal */\nexport function usePaymentMethodList({\n  employeeId,\n}: UsePaymentMethodListParams): UsePaymentMethodListResult {\n  const paymentMethodQuery = useEmployeePaymentMethodGet({ employeeId })\n  const bankAccountsQuery = useEmployeePaymentMethodsGetBankAccounts({ employeeId })\n\n  const paymentMethod = paymentMethodQuery.data?.employeePaymentMethod\n  const bankAccounts = bankAccountsQuery.data?.employeeBankAccounts\n\n  const deleteBankAccountMutation = useEmployeePaymentMethodDeleteBankAccountMutation()\n  const { mutateAsync: mutatePaymentMethod } = useEmployeePaymentMethodUpdateMutation()\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('PaymentMethodList')\n\n  const normalizingRef = useRef(false)\n  // Normalise single-account direct deposit to 100% on mount, skipping if already normalized\n  // or if a normalization mutation is already in-flight (prevents version-conflict 409s).\n  useEffect(() => {\n    if (!paymentMethod) return\n    const firstSplit = paymentMethod.splits?.[0]\n    const alreadyNormalized =\n      firstSplit?.splitAmount === 100 && paymentMethod.splitBy === SPLIT_BY.percentage\n    if (\n      paymentMethod.splits?.length === 1 &&\n      paymentMethod.type === 'Direct Deposit' &&\n      !alreadyNormalized &&\n      !normalizingRef.current\n    ) {\n      normalizingRef.current = true\n      void (async () => {\n        try {\n          await mutatePaymentMethod({\n            request: {\n              employeeId,\n              requestBody: {\n                splitBy: SPLIT_BY.percentage,\n                splits: paymentMethod.splits!.map(split => ({\n                  ...split,\n                  splitAmount: 100,\n                  priority: 1,\n                })),\n                version: paymentMethod.version as string,\n                type: 'Direct Deposit',\n              },\n            },\n          })\n        } finally {\n          normalizingRef.current = false\n        }\n      })()\n    }\n  }, [employeeId, paymentMethod, mutatePaymentMethod])\n\n  const errorHandling = composeErrorHandler([paymentMethodQuery, bankAccountsQuery], {\n    submitError,\n    setSubmitError,\n  })\n\n  const onDelete = async (\n    bankAccountUuid: string,\n  ): Promise<HookSubmitResult<unknown> | undefined> => {\n    let submitResult: HookSubmitResult<unknown> | undefined\n    await baseSubmitHandler(bankAccountUuid, async uuid => {\n      const data = await deleteBankAccountMutation.mutateAsync({\n        request: { employeeId, bankAccountUuid: uuid },\n      })\n      submitResult = { mode: 'update', data }\n    })\n    return submitResult\n  }\n\n  const deletePendingBankAccountUuid = deleteBankAccountMutation.isPending\n    ? deleteBankAccountMutation.variables.request.bankAccountUuid\n    : undefined\n\n  if (\n    paymentMethodQuery.isLoading ||\n    bankAccountsQuery.isLoading ||\n    !paymentMethod ||\n    !bankAccounts\n  ) {\n    return { isLoading: true, errorHandling }\n  }\n\n  return {\n    isLoading: false,\n    data: { paymentMethod, bankAccounts },\n    status: {\n      isFetching: paymentMethodQuery.isFetching || bankAccountsQuery.isFetching,\n      isPending: deleteBankAccountMutation.isPending,\n      deletePendingBankAccountUuid,\n    },\n    actions: { onDelete },\n    errorHandling,\n  }\n}\n"],"names":["usePaymentMethodList","employeeId","paymentMethodQuery","useEmployeePaymentMethodGet","bankAccountsQuery","useEmployeePaymentMethodsGetBankAccounts","paymentMethod","bankAccounts","deleteBankAccountMutation","useEmployeePaymentMethodDeleteBankAccountMutation","mutatePaymentMethod","useEmployeePaymentMethodUpdateMutation","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","normalizingRef","useRef","useEffect","alreadyNormalized","SPLIT_BY","split","errorHandling","composeErrorHandler","onDelete","bankAccountUuid","submitResult","uuid","deletePendingBankAccountUuid"],"mappings":";;;;;;;;AAiCO,SAASA,EAAqB;AAAA,EACnC,YAAAC;AACF,GAA2D;AACzD,QAAMC,IAAqBC,EAA4B,EAAE,YAAAF,GAAY,GAC/DG,IAAoBC,EAAyC,EAAE,YAAAJ,GAAY,GAE3EK,IAAgBJ,EAAmB,MAAM,uBACzCK,IAAeH,EAAkB,MAAM,sBAEvCI,IAA4BC,EAAA,GAC5B,EAAE,aAAaC,EAAA,IAAwBC,EAAA,GAEvC;AAAA,IACJ,mBAAAC;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,mBAAmB,GAE/BC,IAAiBC,EAAO,EAAK;AAGnC,EAAAC,EAAU,MAAM;AACd,QAAI,CAACZ,EAAe;AAEpB,UAAMa,IADab,EAAc,SAAS,CAAC,GAE7B,gBAAgB,OAAOA,EAAc,YAAYc,EAAS;AACxE,IACEd,EAAc,QAAQ,WAAW,KACjCA,EAAc,SAAS,oBACvB,CAACa,KACD,CAACH,EAAe,YAEhBA,EAAe,UAAU,KACnB,YAAY;AAChB,UAAI;AACF,cAAMN,EAAoB;AAAA,UACxB,SAAS;AAAA,YACP,YAAAT;AAAA,YACA,aAAa;AAAA,cACX,SAASmB,EAAS;AAAA,cAClB,QAAQd,EAAc,OAAQ,IAAI,CAAAe,OAAU;AAAA,gBAC1C,GAAGA;AAAA,gBACH,aAAa;AAAA,gBACb,UAAU;AAAA,cAAA,EACV;AAAA,cACF,SAASf,EAAc;AAAA,cACvB,MAAM;AAAA,YAAA;AAAA,UACR;AAAA,QACF,CACD;AAAA,MACH,UAAA;AACE,QAAAU,EAAe,UAAU;AAAA,MAC3B;AAAA,IACF,GAAA;AAAA,EAEJ,GAAG,CAACf,GAAYK,GAAeI,CAAmB,CAAC;AAEnD,QAAMY,IAAgBC,EAAoB,CAACrB,GAAoBE,CAAiB,GAAG;AAAA,IACjF,aAAAS;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKU,IAAW,OACfC,MACmD;AACnD,QAAIC;AACJ,iBAAMd,EAAkBa,GAAiB,OAAME,MAAQ;AAIrD,MAAAD,IAAe,EAAE,MAAM,UAAU,MAHpB,MAAMlB,EAA0B,YAAY;AAAA,QACvD,SAAS,EAAE,YAAAP,GAAY,iBAAiB0B,EAAA;AAAA,MAAK,CAC9C,EACgC;AAAA,IACnC,CAAC,GACMD;AAAA,EACT,GAEME,IAA+BpB,EAA0B,YAC3DA,EAA0B,UAAU,QAAQ,kBAC5C;AAEJ,SACEN,EAAmB,aACnBE,EAAkB,aAClB,CAACE,KACD,CAACC,IAEM,EAAE,WAAW,IAAM,eAAAe,EAAA,IAGrB;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,eAAAhB,GAAe,cAAAC,EAAA;AAAA,IACvB,QAAQ;AAAA,MACN,YAAYL,EAAmB,cAAcE,EAAkB;AAAA,MAC/D,WAAWI,EAA0B;AAAA,MACrC,8BAAAoB;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAJ,EAAA;AAAA,IACX,eAAAF;AAAA,EAAA;AAEJ;"}

package/dist/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/fields.d.ts

@@ -1,6 +1,28 @@
 import { SplitPaymentsFormErrorCodes, SplitByValue } from './useSplitPaymentsFormSchema';
 import { RadioGroupHookFieldProps } from '../../../../../partner-hook-utils/form/fields/RadioGroupHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * Validation error codes emitted by {@link useSplitPaymentsForm} fields that only emit `REQUIRED`.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof SplitPaymentsFormErrorCodes.REQUIRED;
+/**
+ * Props accepted by {@link useSplitPaymentsForm}'s `Fields.SplitBy` component.
+ *
+ * @public
+ */
 export type SplitByFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, SplitByValue>>;
+/**
+ * Radio group bound to the `splitBy` field of {@link useSplitPaymentsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.SplitBy`. Options are
+ * `Percentage` and `Amount`; defaults to the employee's existing `splitBy` or
+ * `Percentage`. Toggling the value resets per-split amounts.
+ *
+ * @param props - See {@link SplitByFieldProps}.
+ * @returns The rendered radio group bound to `splitBy`.
+ * @public
+ */
 export declare function SplitByField(props: SplitByFieldProps): import("react").JSX.Element;

package/dist/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/fields.tsx"],"sourcesContent":["import type { SplitPaymentsFormErrorCodes, SplitByValue } from './useSplitPaymentsFormSchema'\nimport { RadioGroupHookField } from '@/partner-hook-utils/form/fields'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof SplitPaymentsFormErrorCodes.REQUIRED\n\nexport type SplitByFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, SplitByValue>\n>\n\nexport function SplitByField(props: SplitByFieldProps) {\n  return <RadioGroupHookField {...props} name=\"splitBy\" />\n}\n"],"names":["SplitByField","props","jsx","RadioGroupHookField"],"mappings":";;AAWO,SAASA,EAAaC,GAA0B;AACrD,SAAO,gBAAAC,EAACC,GAAA,EAAqB,GAAGF,GAAO,MAAK,WAAU;AACxD;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/fields.tsx"],"sourcesContent":["import type { SplitPaymentsFormErrorCodes, SplitByValue } from './useSplitPaymentsFormSchema'\nimport { RadioGroupHookField } from '@/partner-hook-utils/form/fields'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\n/**\n * Validation error codes emitted by {@link useSplitPaymentsForm} fields that only emit `REQUIRED`.\n *\n * @public\n */\nexport type RequiredValidation = typeof SplitPaymentsFormErrorCodes.REQUIRED\n\n/**\n * Props accepted by {@link useSplitPaymentsForm}'s `Fields.SplitBy` component.\n *\n * @public\n */\nexport type SplitByFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, SplitByValue>\n>\n\n/**\n * Radio group bound to the `splitBy` field of {@link useSplitPaymentsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.SplitBy`. Options are\n * `Percentage` and `Amount`; defaults to the employee's existing `splitBy` or\n * `Percentage`. Toggling the value resets per-split amounts.\n *\n * @param props - See {@link SplitByFieldProps}.\n * @returns The rendered radio group bound to `splitBy`.\n * @public\n */\nexport function SplitByField(props: SplitByFieldProps) {\n  return <RadioGroupHookField {...props} name=\"splitBy\" />\n}\n"],"names":["SplitByField","props","jsx","RadioGroupHookField"],"mappings":";;AAiCO,SAASA,EAAaC,GAA0B;AACrD,SAAO,gBAAAC,EAACC,GAAA,EAAqB,GAAGF,GAAO,MAAK,WAAU;AACxD;"}

package/dist/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/index.d.ts

@@ -1,6 +1,6 @@
 import "./types/i18next.d.ts"
 export { useSplitPaymentsForm } from './useSplitPaymentsForm';
-export type { UseSplitPaymentsFormProps, UseSplitPaymentsFormResult, UseSplitPaymentsFormReady, SplitPaymentsFormFields, SplitPaymentsFormFieldsMetadata, SplitPaymentsFormFieldsType, WorkingSplit, } from './useSplitPaymentsForm';
+export type { UseSplitPaymentsFormProps, UseSplitPaymentsFormResult, UseSplitPaymentsFormReady, SplitPaymentsFormFields, SplitPaymentsFormFieldsMetadata, WorkingSplit, } from './useSplitPaymentsForm';
 export { SPLIT_BY_VALUES, SplitPaymentsFormErrorCodes, createSplitPaymentsFormSchema, type SplitPaymentsFormErrorCode, type SplitPaymentsFormData, type SplitPaymentsFormField, type SplitPaymentsFormOptionalFieldsToRequire, type SplitPaymentsFormOutputs, type SplitByValue, } from './useSplitPaymentsFormSchema';
-export { SplitByField, type SplitByFieldProps, type RequiredValidation as SplitPaymentsFormRequiredValidation, } from './fields';
+export { type SplitByFieldProps, type RequiredValidation as SplitPaymentsFormRequiredValidation, } from './fields';
 export type { SplitFieldEntry, SplitFieldProps, SplitFieldValidation } from './splitFieldFactory';

package/dist/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/splitFieldFactory.d.ts

@@ -8,6 +8,8 @@ import { FormHookResult, ValidationMessages } from '../../../../../partner-hook-
  * (Amount mode, `value < 0`), `INVALID_PERCENTAGE` (Percentage mode, non-integer
  * or out of `0..100`). Supply translations for all three via `validationMessages`.
  * The sum-to-100 invariant is surfaced separately via `status.hasPercentageImbalance`.
+ *
+ * @public
  */
 export type SplitFieldValidation = typeof SplitPaymentsFormErrorCodes.REQUIRED | typeof SplitPaymentsFormErrorCodes.INVALID_AMOUNT | typeof SplitPaymentsFormErrorCodes.INVALID_PERCENTAGE;
 /**
@@ -16,21 +18,42 @@ export type SplitFieldValidation = typeof SplitPaymentsFormErrorCodes.REQUIRED |
  * formats values as currency in Amount mode and as a percentage in
  * Percentage mode. The remainder split is auto-disabled and treated as not
  * required by the hook; the rest are required.
+ *
+ * @public
  */
 export interface SplitFieldProps {
+    /** Label shown above the input. */
     label: string;
+    /** Optional descriptive text rendered below the label. */
     description?: ReactNode;
+    /** Pass-through of the parent form hook result for cross-field validation context. */
     formHookResult?: FormHookResult;
+    /** Override the default localized validation message(s). */
     validationMessages?: ValidationMessages<SplitFieldValidation>;
+    /** Forwarded to the underlying number input. */
     min?: NumberInputProps['min'];
+    /** Forwarded to the underlying number input. */
     max?: NumberInputProps['max'];
+    /** Forwarded to the underlying number input. */
     placeholder?: NumberInputProps['placeholder'];
+    /** Override the rendered number input component. */
     FieldComponent?: ComponentType<NumberInputProps>;
 }
+/**
+ * Single per-account entry surfaced on `form.Fields.splits`. Each entry
+ * carries identifying metadata for the underlying bank account plus the bound
+ * Field component for its split amount.
+ *
+ * @public
+ */
 export interface SplitFieldEntry {
+    /** Bank account uuid that this split targets. */
     uuid: string;
+    /** Display name of the bank account, when available. */
     name: string | null;
+    /** Last-four masking string for the bank account number, when available. */
     hiddenAccountNumber: string | null;
+    /** Bound Field component for this split's amount input. */
     Field: ComponentType<SplitFieldProps>;
 }
 interface BuildSplitFieldsInput {
@@ -43,6 +66,8 @@ interface BuildSplitFieldsInput {
  * memoizing on the stable set of split uuids so Field identity stays stable
  * across mode toggles and reorders — those changes are observed inside each
  * Field rather than baked into the closure.
+ *
+ * @internal
  */
 export declare function buildSplitFieldEntries(splits: BuildSplitFieldsInput[]): SplitFieldEntry[];
 export {};

package/dist/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/splitFieldFactory.js

@@ -1,7 +1,7 @@
 import { jsx as a } from "react/jsx-runtime";
 import { useWatch as f } from "react-hook-form";
-import { SPLIT_BY as s } from "../../../../../shared/constants.js";
-import { NumberInputHookField as F } from "../../../../../partner-hook-utils/form/fields/NumberInputHookField.js";
+import { NumberInputHookField as s } from "../../../../../partner-hook-utils/form/fields/NumberInputHookField.js";
+import { SPLIT_BY as F } from "../../../../../shared/constants.js";
 function B(t) {
   function n({
     label: r,
@@ -13,9 +13,9 @@ function B(t) {
     placeholder: c,
     FieldComponent: d
   }) {
-    const l = o?.form.hookFormInternals.formMethods.control, p = f({ control: l, name: "splitBy" }) === s.amount ? "currency" : "percent";
+    const l = o?.form.hookFormInternals.formMethods.control, p = f({ control: l, name: "splitBy" }) === F.amount ? "currency" : "percent";
     return /* @__PURE__ */ a(
-      F,
+      s,
       {
         name: `splitAmount.${t}`,
         formHookResult: o,

package/dist/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/splitFieldFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"splitFieldFactory.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/splitFieldFactory.tsx"],"sourcesContent":["import type { ComponentType, ReactNode } from 'react'\nimport { useWatch, type Control } from 'react-hook-form'\nimport type {\n  SplitPaymentsFormErrorCodes,\n  SplitPaymentsFormData,\n} from './useSplitPaymentsFormSchema'\nimport { NumberInputHookField } from '@/partner-hook-utils/form/fields'\nimport type { NumberInputProps } from '@/components/Common/UI/NumberInput/NumberInputTypes'\nimport type { FormHookResult, ValidationMessages } from '@/partner-hook-utils/types'\nimport { SPLIT_BY } from '@/shared/constants'\n\n/**\n * Validation codes a bound split-amount Field can emit at submit time:\n * `REQUIRED` (every non-remainder split must have a value), `INVALID_AMOUNT`\n * (Amount mode, `value < 0`), `INVALID_PERCENTAGE` (Percentage mode, non-integer\n * or out of `0..100`). Supply translations for all three via `validationMessages`.\n * The sum-to-100 invariant is surfaced separately via `status.hasPercentageImbalance`.\n */\nexport type SplitFieldValidation =\n  | typeof SplitPaymentsFormErrorCodes.REQUIRED\n  | typeof SplitPaymentsFormErrorCodes.INVALID_AMOUNT\n  | typeof SplitPaymentsFormErrorCodes.INVALID_PERCENTAGE\n\n/**\n * Props accepted by a bound split-amount Field exposed on\n * `form.Fields.splits[i].Field`. The Field is pre-bound to its split; it\n * formats values as currency in Amount mode and as a percentage in\n * Percentage mode. The remainder split is auto-disabled and treated as not\n * required by the hook; the rest are required.\n */\nexport interface SplitFieldProps {\n  label: string\n  description?: ReactNode\n  formHookResult?: FormHookResult\n  validationMessages?: ValidationMessages<SplitFieldValidation>\n  min?: NumberInputProps['min']\n  max?: NumberInputProps['max']\n  placeholder?: NumberInputProps['placeholder']\n  FieldComponent?: ComponentType<NumberInputProps>\n}\n\nexport interface SplitFieldEntry {\n  uuid: string\n  name: string | null\n  hiddenAccountNumber: string | null\n  Field: ComponentType<SplitFieldProps>\n}\n\ninterface BuildSplitFieldsInput {\n  uuid: string\n  name: string | null\n  hiddenAccountNumber: string | null\n}\n\nfunction createBoundSplitField(uuid: string): ComponentType<SplitFieldProps> {\n  function BoundSplitField({\n    label,\n    description,\n    formHookResult,\n    validationMessages,\n    min,\n    max,\n    placeholder,\n    FieldComponent,\n  }: SplitFieldProps) {\n    const externalControl = formHookResult?.form.hookFormInternals.formMethods.control as\n      | Control<SplitPaymentsFormData>\n      | undefined\n    const splitBy = useWatch({ control: externalControl, name: 'splitBy' })\n    const format: NumberInputProps['format'] = splitBy === SPLIT_BY.amount ? 'currency' : 'percent'\n\n    return (\n      <NumberInputHookField<SplitFieldValidation>\n        name={`splitAmount.${uuid}`}\n        formHookResult={formHookResult}\n        label={label}\n        description={description}\n        validationMessages={validationMessages}\n        format={format}\n        min={min}\n        max={max}\n        placeholder={placeholder}\n        FieldComponent={FieldComponent}\n      />\n    )\n  }\n  BoundSplitField.displayName = `SplitField(${uuid})`\n  return BoundSplitField\n}\n\n/**\n * Build the per-split bound Field components. The caller is responsible for\n * memoizing on the stable set of split uuids so Field identity stays stable\n * across mode toggles and reorders — those changes are observed inside each\n * Field rather than baked into the closure.\n */\nexport function buildSplitFieldEntries(splits: BuildSplitFieldsInput[]): SplitFieldEntry[] {\n  return splits.map(split => ({\n    uuid: split.uuid,\n    name: split.name,\n    hiddenAccountNumber: split.hiddenAccountNumber,\n    Field: createBoundSplitField(split.uuid),\n  }))\n}\n"],"names":["createBoundSplitField","uuid","BoundSplitField","label","description","formHookResult","validationMessages","min","max","placeholder","FieldComponent","externalControl","format","useWatch","SPLIT_BY","jsx","NumberInputHookField","buildSplitFieldEntries","splits","split"],"mappings":";;;;AAsDA,SAASA,EAAsBC,GAA8C;AAC3E,WAASC,EAAgB;AAAA,IACvB,OAAAC;AAAA,IACA,aAAAC;AAAA,IACA,gBAAAC;AAAA,IACA,oBAAAC;AAAA,IACA,KAAAC;AAAA,IACA,KAAAC;AAAA,IACA,aAAAC;AAAA,IACA,gBAAAC;AAAA,EAAA,GACkB;AAClB,UAAMC,IAAkBN,GAAgB,KAAK,kBAAkB,YAAY,SAIrEO,IADUC,EAAS,EAAE,SAASF,GAAiB,MAAM,WAAW,MACfG,EAAS,SAAS,aAAa;AAEtF,WACE,gBAAAC;AAAA,MAACC;AAAA,MAAA;AAAA,QACC,MAAM,eAAef,CAAI;AAAA,QACzB,gBAAAI;AAAA,QACA,OAAAF;AAAA,QACA,aAAAC;AAAA,QACA,oBAAAE;AAAA,QACA,QAAAM;AAAA,QACA,KAAAL;AAAA,QACA,KAAAC;AAAA,QACA,aAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IAAA;AAAA,EAGN;AACA,SAAAR,EAAgB,cAAc,cAAcD,CAAI,KACzCC;AACT;AAQO,SAASe,EAAuBC,GAAoD;AACzF,SAAOA,EAAO,IAAI,CAAAC,OAAU;AAAA,IAC1B,MAAMA,EAAM;AAAA,IACZ,MAAMA,EAAM;AAAA,IACZ,qBAAqBA,EAAM;AAAA,IAC3B,OAAOnB,EAAsBmB,EAAM,IAAI;AAAA,EAAA,EACvC;AACJ;"}
+{"version":3,"file":"splitFieldFactory.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useSplitPaymentsForm/splitFieldFactory.tsx"],"sourcesContent":["import type { ComponentType, ReactNode } from 'react'\nimport { useWatch, type Control } from 'react-hook-form'\nimport type {\n  SplitPaymentsFormErrorCodes,\n  SplitPaymentsFormData,\n} from './useSplitPaymentsFormSchema'\nimport { NumberInputHookField } from '@/partner-hook-utils/form/fields'\nimport type { NumberInputProps } from '@/components/Common/UI/NumberInput/NumberInputTypes'\nimport type { FormHookResult, ValidationMessages } from '@/partner-hook-utils/types'\nimport { SPLIT_BY } from '@/shared/constants'\n\n/**\n * Validation codes a bound split-amount Field can emit at submit time:\n * `REQUIRED` (every non-remainder split must have a value), `INVALID_AMOUNT`\n * (Amount mode, `value < 0`), `INVALID_PERCENTAGE` (Percentage mode, non-integer\n * or out of `0..100`). Supply translations for all three via `validationMessages`.\n * The sum-to-100 invariant is surfaced separately via `status.hasPercentageImbalance`.\n *\n * @public\n */\nexport type SplitFieldValidation =\n  | typeof SplitPaymentsFormErrorCodes.REQUIRED\n  | typeof SplitPaymentsFormErrorCodes.INVALID_AMOUNT\n  | typeof SplitPaymentsFormErrorCodes.INVALID_PERCENTAGE\n\n/**\n * Props accepted by a bound split-amount Field exposed on\n * `form.Fields.splits[i].Field`. The Field is pre-bound to its split; it\n * formats values as currency in Amount mode and as a percentage in\n * Percentage mode. The remainder split is auto-disabled and treated as not\n * required by the hook; the rest are required.\n *\n * @public\n */\nexport interface SplitFieldProps {\n  /** Label shown above the input. */\n  label: string\n  /** Optional descriptive text rendered below the label. */\n  description?: ReactNode\n  /** Pass-through of the parent form hook result for cross-field validation context. */\n  formHookResult?: FormHookResult\n  /** Override the default localized validation message(s). */\n  validationMessages?: ValidationMessages<SplitFieldValidation>\n  /** Forwarded to the underlying number input. */\n  min?: NumberInputProps['min']\n  /** Forwarded to the underlying number input. */\n  max?: NumberInputProps['max']\n  /** Forwarded to the underlying number input. */\n  placeholder?: NumberInputProps['placeholder']\n  /** Override the rendered number input component. */\n  FieldComponent?: ComponentType<NumberInputProps>\n}\n\n/**\n * Single per-account entry surfaced on `form.Fields.splits`. Each entry\n * carries identifying metadata for the underlying bank account plus the bound\n * Field component for its split amount.\n *\n * @public\n */\nexport interface SplitFieldEntry {\n  /** Bank account uuid that this split targets. */\n  uuid: string\n  /** Display name of the bank account, when available. */\n  name: string | null\n  /** Last-four masking string for the bank account number, when available. */\n  hiddenAccountNumber: string | null\n  /** Bound Field component for this split's amount input. */\n  Field: ComponentType<SplitFieldProps>\n}\n\ninterface BuildSplitFieldsInput {\n  uuid: string\n  name: string | null\n  hiddenAccountNumber: string | null\n}\n\nfunction createBoundSplitField(uuid: string): ComponentType<SplitFieldProps> {\n  function BoundSplitField({\n    label,\n    description,\n    formHookResult,\n    validationMessages,\n    min,\n    max,\n    placeholder,\n    FieldComponent,\n  }: SplitFieldProps) {\n    const externalControl = formHookResult?.form.hookFormInternals.formMethods.control as\n      | Control<SplitPaymentsFormData>\n      | undefined\n    const splitBy = useWatch({ control: externalControl, name: 'splitBy' })\n    const format: NumberInputProps['format'] = splitBy === SPLIT_BY.amount ? 'currency' : 'percent'\n\n    return (\n      <NumberInputHookField<SplitFieldValidation>\n        name={`splitAmount.${uuid}`}\n        formHookResult={formHookResult}\n        label={label}\n        description={description}\n        validationMessages={validationMessages}\n        format={format}\n        min={min}\n        max={max}\n        placeholder={placeholder}\n        FieldComponent={FieldComponent}\n      />\n    )\n  }\n  BoundSplitField.displayName = `SplitField(${uuid})`\n  return BoundSplitField\n}\n\n/**\n * Build the per-split bound Field components. The caller is responsible for\n * memoizing on the stable set of split uuids so Field identity stays stable\n * across mode toggles and reorders — those changes are observed inside each\n * Field rather than baked into the closure.\n *\n * @internal\n */\nexport function buildSplitFieldEntries(splits: BuildSplitFieldsInput[]): SplitFieldEntry[] {\n  return splits.map(split => ({\n    uuid: split.uuid,\n    name: split.name,\n    hiddenAccountNumber: split.hiddenAccountNumber,\n    Field: createBoundSplitField(split.uuid),\n  }))\n}\n"],"names":["createBoundSplitField","uuid","BoundSplitField","label","description","formHookResult","validationMessages","min","max","placeholder","FieldComponent","externalControl","format","useWatch","SPLIT_BY","jsx","NumberInputHookField","buildSplitFieldEntries","splits","split"],"mappings":";;;;AA6EA,SAASA,EAAsBC,GAA8C;AAC3E,WAASC,EAAgB;AAAA,IACvB,OAAAC;AAAA,IACA,aAAAC;AAAA,IACA,gBAAAC;AAAA,IACA,oBAAAC;AAAA,IACA,KAAAC;AAAA,IACA,KAAAC;AAAA,IACA,aAAAC;AAAA,IACA,gBAAAC;AAAA,EAAA,GACkB;AAClB,UAAMC,IAAkBN,GAAgB,KAAK,kBAAkB,YAAY,SAIrEO,IADUC,EAAS,EAAE,SAASF,GAAiB,MAAM,WAAW,MACfG,EAAS,SAAS,aAAa;AAEtF,WACE,gBAAAC;AAAA,MAACC;AAAA,MAAA;AAAA,QACC,MAAM,eAAef,CAAI;AAAA,QACzB,gBAAAI;AAAA,QACA,OAAAF;AAAA,QACA,aAAAC;AAAA,QACA,oBAAAE;AAAA,QACA,QAAAM;AAAA,QACA,KAAAL;AAAA,QACA,KAAAC;AAAA,QACA,aAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IAAA;AAAA,EAGN;AACA,SAAAR,EAAgB,cAAc,cAAcD,CAAI,KACzCC;AACT;AAUO,SAASe,EAAuBC,GAAoD;AACzF,SAAOA,EAAO,IAAI,CAAAC,OAAU;AAAA,IAC1B,MAAMA,EAAM;AAAA,IACZ,MAAMA,EAAM;AAAA,IACZ,qBAAqBA,EAAM;AAAA,IAC3B,OAAOnB,EAAsBmB,EAAM,IAAI;AAAA,EAAA,EACvC;AACJ;"}