@gusto/embedded-react-sdk 0.47.1 → 0.48.0

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

@@ -2,14 +2,94 @@ import { AccountType, BankFormErrorCodes } from './useBankFormSchema';
 import { TextInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/TextInputHookField';
 import { RadioGroupHookFieldProps } from '../../../../../partner-hook-utils/form/fields/RadioGroupHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * Validation error codes emitted by {@link useBankForm} fields that only emit `REQUIRED`.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof BankFormErrorCodes.REQUIRED;
+/**
+ * Validation error codes emitted by the `routingNumber` field of {@link useBankForm}.
+ *
+ * @public
+ */
 export type RoutingNumberValidation = (typeof BankFormErrorCodes)[keyof Pick<typeof BankFormErrorCodes, 'REQUIRED' | 'INVALID_ROUTING_NUMBER'>];
+/**
+ * Validation error codes emitted by the `accountNumber` field of {@link useBankForm}.
+ *
+ * @public
+ */
 export type AccountNumberValidation = (typeof BankFormErrorCodes)[keyof Pick<typeof BankFormErrorCodes, 'REQUIRED' | 'INVALID_ACCOUNT_NUMBER'>];
+/**
+ * Props accepted by {@link useBankForm}'s `Fields.Name` component.
+ *
+ * @public
+ */
 export type NameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `name` field of {@link useBankForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Name`. Captures the account
+ * nickname.
+ *
+ * @param props - See {@link NameFieldProps}.
+ * @returns The rendered text input bound to `name`.
+ * @public
+ */
 export declare function NameField(props: NameFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useBankForm}'s `Fields.RoutingNumber` component.
+ *
+ * @public
+ */
 export type RoutingNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RoutingNumberValidation>>;
+/**
+ * Text input bound to the `routingNumber` field of {@link useBankForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.RoutingNumber`. Validates the
+ * value against a 9-digit numeric pattern.
+ *
+ * @param props - See {@link RoutingNumberFieldProps}.
+ * @returns The rendered text input bound to `routingNumber`.
+ * @public
+ */
 export declare function RoutingNumberField(props: RoutingNumberFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useBankForm}'s `Fields.AccountNumber` component.
+ *
+ * @public
+ */
 export type AccountNumberFieldProps = HookFieldProps<TextInputHookFieldProps<AccountNumberValidation>>;
+/**
+ * Text input bound to the `accountNumber` field of {@link useBankForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.AccountNumber`. Validates the
+ * value against a 1–17 digit numeric pattern.
+ *
+ * @param props - See {@link AccountNumberFieldProps}.
+ * @returns The rendered text input bound to `accountNumber`.
+ * @public
+ */
 export declare function AccountNumberField(props: AccountNumberFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useBankForm}'s `Fields.AccountType` component.
+ *
+ * @public
+ */
 export type AccountTypeFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, AccountType>>;
+/**
+ * Radio group bound to the `accountType` field of {@link useBankForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.AccountType`. Options are
+ * `Checking` and `Savings`; defaults to `Checking` when no value is supplied.
+ * Supply `getOptionLabel` to translate the option labels.
+ *
+ * @param props - See {@link AccountTypeFieldProps}.
+ * @returns The rendered radio group bound to `accountType`.
+ * @public
+ */
 export declare function AccountTypeField(props: AccountTypeFieldProps): import("react").JSX.Element;

package/dist/components/Employee/PaymentMethod/shared/useBankForm/fields.js

@@ -1,6 +1,6 @@
 import { jsx as n } from "react/jsx-runtime";
-import { RadioGroupHookField as r } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
 import { TextInputHookField as o } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { RadioGroupHookField as r } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
 function m(e) {
   return /* @__PURE__ */ n(o, { ...e, name: "name" });
 }

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

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useBankForm/fields.tsx"],"sourcesContent":["import type { AccountType, BankFormErrorCodes } from './useBankFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport { TextInputHookField, RadioGroupHookField } from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof BankFormErrorCodes.REQUIRED\nexport type RoutingNumberValidation = (typeof BankFormErrorCodes)[keyof Pick<\n  typeof BankFormErrorCodes,\n  'REQUIRED' | 'INVALID_ROUTING_NUMBER'\n>]\nexport type AccountNumberValidation = (typeof BankFormErrorCodes)[keyof Pick<\n  typeof BankFormErrorCodes,\n  'REQUIRED' | 'INVALID_ACCOUNT_NUMBER'\n>]\n\nexport type NameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function NameField(props: NameFieldProps) {\n  return <TextInputHookField {...props} name=\"name\" />\n}\n\nexport type RoutingNumberFieldProps = HookFieldProps<\n  TextInputHookFieldProps<RoutingNumberValidation>\n>\n\nexport function RoutingNumberField(props: RoutingNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"routingNumber\" />\n}\n\nexport type AccountNumberFieldProps = HookFieldProps<\n  TextInputHookFieldProps<AccountNumberValidation>\n>\n\nexport function AccountNumberField(props: AccountNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"accountNumber\" />\n}\n\nexport type AccountTypeFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, AccountType>\n>\n\nexport function AccountTypeField(props: AccountTypeFieldProps) {\n  return <RadioGroupHookField {...props} name=\"accountType\" />\n}\n"],"names":["NameField","props","jsx","TextInputHookField","RoutingNumberField","AccountNumberField","AccountTypeField","RadioGroupHookField"],"mappings":";;;AAkBO,SAASA,EAAUC,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,QAAO;AACpD;AAMO,SAASG,EAAmBH,GAAgC;AACjE,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,iBAAgB;AAC7D;AAMO,SAASI,EAAmBJ,GAAgC;AACjE,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,iBAAgB;AAC7D;AAMO,SAASK,EAAiBL,GAA8B;AAC7D,SAAO,gBAAAC,EAACK,GAAA,EAAqB,GAAGN,GAAO,MAAK,eAAc;AAC5D;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useBankForm/fields.tsx"],"sourcesContent":["import type { AccountType, BankFormErrorCodes } from './useBankFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport { TextInputHookField, RadioGroupHookField } from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\n/**\n * Validation error codes emitted by {@link useBankForm} fields that only emit `REQUIRED`.\n *\n * @public\n */\nexport type RequiredValidation = typeof BankFormErrorCodes.REQUIRED\n\n/**\n * Validation error codes emitted by the `routingNumber` field of {@link useBankForm}.\n *\n * @public\n */\nexport type RoutingNumberValidation = (typeof BankFormErrorCodes)[keyof Pick<\n  typeof BankFormErrorCodes,\n  'REQUIRED' | 'INVALID_ROUTING_NUMBER'\n>]\n\n/**\n * Validation error codes emitted by the `accountNumber` field of {@link useBankForm}.\n *\n * @public\n */\nexport type AccountNumberValidation = (typeof BankFormErrorCodes)[keyof Pick<\n  typeof BankFormErrorCodes,\n  'REQUIRED' | 'INVALID_ACCOUNT_NUMBER'\n>]\n\n/**\n * Props accepted by {@link useBankForm}'s `Fields.Name` component.\n *\n * @public\n */\nexport type NameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `name` field of {@link useBankForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Name`. Captures the account\n * nickname.\n *\n * @param props - See {@link NameFieldProps}.\n * @returns The rendered text input bound to `name`.\n * @public\n */\nexport function NameField(props: NameFieldProps) {\n  return <TextInputHookField {...props} name=\"name\" />\n}\n\n/**\n * Props accepted by {@link useBankForm}'s `Fields.RoutingNumber` component.\n *\n * @public\n */\nexport type RoutingNumberFieldProps = HookFieldProps<\n  TextInputHookFieldProps<RoutingNumberValidation>\n>\n\n/**\n * Text input bound to the `routingNumber` field of {@link useBankForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.RoutingNumber`. Validates the\n * value against a 9-digit numeric pattern.\n *\n * @param props - See {@link RoutingNumberFieldProps}.\n * @returns The rendered text input bound to `routingNumber`.\n * @public\n */\nexport function RoutingNumberField(props: RoutingNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"routingNumber\" />\n}\n\n/**\n * Props accepted by {@link useBankForm}'s `Fields.AccountNumber` component.\n *\n * @public\n */\nexport type AccountNumberFieldProps = HookFieldProps<\n  TextInputHookFieldProps<AccountNumberValidation>\n>\n\n/**\n * Text input bound to the `accountNumber` field of {@link useBankForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.AccountNumber`. Validates the\n * value against a 1–17 digit numeric pattern.\n *\n * @param props - See {@link AccountNumberFieldProps}.\n * @returns The rendered text input bound to `accountNumber`.\n * @public\n */\nexport function AccountNumberField(props: AccountNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"accountNumber\" />\n}\n\n/**\n * Props accepted by {@link useBankForm}'s `Fields.AccountType` component.\n *\n * @public\n */\nexport type AccountTypeFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, AccountType>\n>\n\n/**\n * Radio group bound to the `accountType` field of {@link useBankForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.AccountType`. Options are\n * `Checking` and `Savings`; defaults to `Checking` when no value is supplied.\n * Supply `getOptionLabel` to translate the option labels.\n *\n * @param props - See {@link AccountTypeFieldProps}.\n * @returns The rendered radio group bound to `accountType`.\n * @public\n */\nexport function AccountTypeField(props: AccountTypeFieldProps) {\n  return <RadioGroupHookField {...props} name=\"accountType\" />\n}\n"],"names":["NameField","props","jsx","TextInputHookField","RoutingNumberField","AccountNumberField","AccountTypeField","RadioGroupHookField"],"mappings":";;;AAmDO,SAASA,EAAUC,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,QAAO;AACpD;AAsBO,SAASG,EAAmBH,GAAgC;AACjE,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,iBAAgB;AAC7D;AAsBO,SAASI,EAAmBJ,GAAgC;AACjE,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,iBAAgB;AAC7D;AAuBO,SAASK,EAAiBL,GAA8B;AAC7D,SAAO,gBAAAC,EAACK,GAAA,EAAqB,GAAGN,GAAO,MAAK,eAAc;AAC5D;"}

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

@@ -1,5 +1,5 @@
 import "./types/i18next.d.ts"
 export { useBankForm } from './useBankForm';
-export type { BankFormSubmitOptions, UseBankFormProps, UseBankFormResult, UseBankFormReady, BankFormFields, BankFormFieldsMetadata, BankFormFieldsType, } from './useBankForm';
+export type { BankFormSubmitOptions, UseBankFormProps, UseBankFormResult, UseBankFormReady, BankFormFields, BankFormFieldsMetadata, } from './useBankForm';
 export { ACCOUNT_TYPES, BankFormErrorCodes, createBankFormSchema, type AccountType, type BankFormErrorCode, type BankFormData, type BankFormField, type BankFormOptionalFieldsToRequire, type BankFormOutputs, } from './useBankFormSchema';
 export { NameField, RoutingNumberField, AccountNumberField, AccountTypeField, type NameFieldProps, type RoutingNumberFieldProps, type AccountNumberFieldProps, type AccountTypeFieldProps, type RequiredValidation as BankFormRequiredValidation, type RoutingNumberValidation, type AccountNumberValidation, } from './fields';

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

@@ -3,35 +3,118 @@ import { EmployeeBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/com
 import { BankFormData, BankFormOptionalFieldsToRequire } from './useBankFormSchema';
 import { AccountNumberField, AccountTypeField, NameField, RoutingNumberField } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Optional submit-time overrides for {@link useBankForm}'s `onSubmit`.
+ *
+ * @public
+ */
 export interface BankFormSubmitOptions {
     /** Override the `employeeId` configured at hook construction. Useful when the employee is created in the same submit chain. */
     employeeId?: string;
 }
+/**
+ * Props for {@link useBankForm}.
+ *
+ * @public
+ */
 export interface UseBankFormProps {
     /** Employee for whom to create the bank account. May be supplied later via `BankFormSubmitOptions.employeeId`. */
     employeeId?: string;
+    /** Override optional fields to be required. Reserved for future schema expansion — every field is required by default. */
     optionalFieldsToRequire?: BankFormOptionalFieldsToRequire;
+    /** Pre-fill form values. `accountType` defaults to `'Checking'` when not supplied. */
     defaultValues?: Partial<BankFormData>;
+    /** 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 useBankForm} on `form.Fields`.
+ *
+ * @public
+ */
 export interface BankFormFields {
+    /** Bound to `name` — see {@link NameField}. */
     Name: typeof NameField;
+    /** Bound to `routingNumber` — see {@link RoutingNumberField}. */
     RoutingNumber: typeof RoutingNumberField;
+    /** Bound to `accountNumber` — see {@link AccountNumberField}. */
     AccountNumber: typeof AccountNumberField;
+    /** Bound to `accountType` — see {@link AccountTypeField}. */
     AccountType: typeof AccountTypeField;
 }
+/**
+ * Ready-state return value of {@link useBankForm}.
+ *
+ * @public
+ */
 export interface UseBankFormReady extends BaseFormHookReady<FieldsMetadata, BankFormData, BankFormFields> {
+    /** No server-fetched data — the create form derives everything from user input. */
     data: Record<string, never>;
+    /** `isPending` reflects the in-flight create mutation; `mode` is always `'create'`. */
     status: {
         isPending: boolean;
         mode: 'create';
     };
+    /** Submit the form. Optional {@link BankFormSubmitOptions} can override the `employeeId` supplied to the hook. */
     actions: {
         onSubmit: (options?: BankFormSubmitOptions) => Promise<HookSubmitResult<EmployeeBankAccount> | undefined>;
     };
 }
+/**
+ * Headless React Hook Form hook for creating an employee bank account.
+ *
+ * @remarks
+ * Captures the account nickname, routing number, account number, and account
+ * type. Creating a bank account also updates the employee's payment method on
+ * the Gusto API. Returns the standard `HookLoadingResult | UseBankFormReady`
+ * discriminated union; in practice the hook transitions to the ready state
+ * immediately because it does not fetch any server data.
+ *
+ * @param props - See {@link UseBankFormProps}.
+ * @returns A loading-state result while the hook is initializing, or a {@link UseBankFormReady} ready to render.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useBankForm, SDKFormProvider } from '@gusto/embedded-react-sdk'
+ *
+ * function AddBankAccount({ employeeId }: { employeeId: string }) {
+ *   const bankForm = useBankForm({ employeeId })
+ *
+ *   if (bankForm.isLoading) return null
+ *   const { Fields } = bankForm.form
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={bankForm}>
+ *       <form
+ *         onSubmit={e => {
+ *           e.preventDefault()
+ *           void bankForm.actions.onSubmit()
+ *         }}
+ *       >
+ *         <Fields.Name label="Account nickname" />
+ *         <Fields.RoutingNumber label="Routing number" />
+ *         <Fields.AccountNumber label="Account number" />
+ *         <Fields.AccountType label="Account type" />
+ *         <button type="submit" disabled={bankForm.status.isPending}>Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function useBankForm({ employeeId, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseBankFormProps): HookLoadingResult | UseBankFormReady;
+/**
+ * Return type of {@link useBankForm} — a discriminated union on `isLoading`.
+ *
+ * @public
+ */
 export type UseBankFormResult = HookLoadingResult | UseBankFormReady;
+/**
+ * Per-field metadata exposed on `form.fieldsMetadata` for {@link useBankForm}.
+ *
+ * @public
+ */
 export type BankFormFieldsMetadata = UseBankFormReady['form']['fieldsMetadata'];
-export type BankFormFieldsType = UseBankFormReady['form']['Fields'];

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

@@ -1 +1 @@
-{"version":3,"file":"useBankForm.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useBankForm/useBankForm.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 { EmployeeBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/employeebankaccount'\nimport { useEmployeePaymentMethodCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodCreate'\nimport {\n  ACCOUNT_TYPES,\n  type AccountType,\n  createBankFormSchema,\n  type BankFormData,\n  type BankFormOptionalFieldsToRequire,\n  type BankFormOutputs,\n} from './useBankFormSchema'\nimport { AccountNumberField, AccountTypeField, NameField, RoutingNumberField } 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'\n\nexport interface BankFormSubmitOptions {\n  /** Override the `employeeId` configured at hook construction. Useful when the employee is created in the same submit chain. */\n  employeeId?: string\n}\n\nexport interface UseBankFormProps {\n  /** Employee for whom to create the bank account. May be supplied later via `BankFormSubmitOptions.employeeId`. */\n  employeeId?: string\n  optionalFieldsToRequire?: BankFormOptionalFieldsToRequire\n  defaultValues?: Partial<BankFormData>\n  validationMode?: UseFormProps['mode']\n  shouldFocusError?: boolean\n}\n\nexport interface BankFormFields {\n  Name: typeof NameField\n  RoutingNumber: typeof RoutingNumberField\n  AccountNumber: typeof AccountNumberField\n  AccountType: typeof AccountTypeField\n}\n\nexport interface UseBankFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  BankFormData,\n  BankFormFields\n> {\n  data: Record<string, never>\n  status: { isPending: boolean; mode: 'create' }\n  actions: {\n    onSubmit: (\n      options?: BankFormSubmitOptions,\n    ) => Promise<HookSubmitResult<EmployeeBankAccount> | undefined>\n  }\n}\n\nexport function useBankForm({\n  employeeId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseBankFormProps): HookLoadingResult | UseBankFormReady {\n  const [schema, metadataConfig] = useMemo(\n    () => createBankFormSchema({ optionalFieldsToRequire }),\n    [optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: BankFormData = useMemo(\n    () => ({\n      name: partnerDefaults?.name ?? '',\n      routingNumber: partnerDefaults?.routingNumber ?? '',\n      accountNumber: partnerDefaults?.accountNumber ?? '',\n      accountType: (partnerDefaults?.accountType ?? 'Checking') as AccountType,\n    }),\n    [partnerDefaults],\n  )\n\n  const formMethods = useForm<BankFormData, unknown, BankFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const createMutation = useEmployeePaymentMethodCreateMutation()\n  const isPending = createMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('BankForm')\n\n  const errorHandling = composeErrorHandler([], { submitError, setSubmitError })\n\n  const accountTypeOptions = ACCOUNT_TYPES.map(value => ({ value, label: value }))\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    name: baseMetadata.name,\n    routingNumber: baseMetadata.routingNumber,\n    accountNumber: baseMetadata.accountNumber,\n    accountType: withOptions<AccountType>(baseMetadata.accountType, accountTypeOptions, [\n      ...ACCOUNT_TYPES,\n    ]),\n  }\n\n  const onSubmit = async (\n    options?: BankFormSubmitOptions,\n  ): Promise<HookSubmitResult<EmployeeBankAccount> | undefined> => {\n    let submitResult: HookSubmitResult<EmployeeBankAccount> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: BankFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const resolvedEmployeeId = options?.employeeId ?? employeeId\n            if (!resolvedEmployeeId) {\n              throw new SDKInternalError(\n                'employeeId is required to submit a bank account. Pass it to useBankForm or via BankFormSubmitOptions.',\n              )\n            }\n\n            const response = await createMutation.mutateAsync({\n              request: {\n                employeeId: resolvedEmployeeId,\n                employeeBankAccountRequest: {\n                  name: payload.name,\n                  routingNumber: payload.routingNumber,\n                  accountNumber: payload.accountNumber,\n                  accountType: payload.accountType,\n                },\n              },\n            })\n\n            if (!response.employeeBankAccount) {\n              throw new SDKInternalError('Bank account creation failed')\n            }\n\n            submitResult = { mode: 'create' as const, data: response.employeeBankAccount }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  return {\n    isLoading: false as const,\n    data: {} as Record<string, never>,\n    status: { isPending, mode: 'create' as const },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Name: NameField,\n        RoutingNumber: RoutingNumberField,\n        AccountNumber: AccountNumberField,\n        AccountType: AccountTypeField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\nexport type UseBankFormResult = HookLoadingResult | UseBankFormReady\nexport type BankFormFieldsMetadata = UseBankFormReady['form']['fieldsMetadata']\nexport type BankFormFieldsType = UseBankFormReady['form']['Fields']\n"],"names":["useBankForm","employeeId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","schema","metadataConfig","useMemo","createBankFormSchema","resolvedDefaults","formMethods","useForm","zodResolver","createMutation","useEmployeePaymentMethodCreateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","accountTypeOptions","ACCOUNT_TYPES","value","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","options","submitResult","resolve","data","payload","resolvedEmployeeId","SDKInternalError","response","hookFormInternals","useHookFormInternals","NameField","RoutingNumberField","AccountNumberField","AccountTypeField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;AAgEO,SAASA,GAAY;AAAA,EAC1B,YAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAA2D;AACzD,QAAM,CAACC,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAAqB,EAAE,yBAAAP,GAAyB;AAAA,IACtD,CAACA,CAAuB;AAAA,EAAA,GAGpBQ,IAAiCF;AAAA,IACrC,OAAO;AAAA,MACL,MAAML,GAAiB,QAAQ;AAAA,MAC/B,eAAeA,GAAiB,iBAAiB;AAAA,MACjD,eAAeA,GAAiB,iBAAiB;AAAA,MACjD,aAAcA,GAAiB,eAAe;AAAA,IAAA;AAAA,IAEhD,CAACA,CAAe;AAAA,EAAA,GAGZQ,IAAcC,EAAgD;AAAA,IAClE,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMF;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeK;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAAiBC,EAAA,GACjBC,IAAYF,EAAe,WAE3B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,UAAU,GAEtBC,IAAgBC,EAAoB,CAAA,GAAI,EAAE,aAAAJ,GAAa,gBAAAC,GAAgB,GAEvEI,IAAqBC,EAAc,IAAI,CAAAC,OAAU,EAAE,OAAAA,GAAO,OAAOA,IAAQ,GAEzEC,IAAeC,EAAwBpB,GAAgBI,EAAY,OAAO,GAC1EiB,IAAiB;AAAA,IACrB,MAAMF,EAAa;AAAA,IACnB,eAAeA,EAAa;AAAA,IAC5B,eAAeA,EAAa;AAAA,IAC5B,aAAaG,EAAyBH,EAAa,aAAaH,GAAoB;AAAA,MAClF,GAAGC;AAAA,IAAA,CACJ;AAAA,EAAA,GAGGM,IAAW,OACfC,MAC+D;AAC/D,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKtB,EAAY;AAAA,QACf,OAAOuB,MAA0B;AAC/B,gBAAMjB,EAAkBiB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAqBL,GAAS,cAAc9B;AAClD,gBAAI,CAACmC;AACH,oBAAM,IAAIC;AAAA,gBACR;AAAA,cAAA;AAIJ,kBAAMC,IAAW,MAAMxB,EAAe,YAAY;AAAA,cAChD,SAAS;AAAA,gBACP,YAAYsB;AAAA,gBACZ,4BAA4B;AAAA,kBAC1B,MAAMD,EAAQ;AAAA,kBACd,eAAeA,EAAQ;AAAA,kBACvB,eAAeA,EAAQ;AAAA,kBACvB,aAAaA,EAAQ;AAAA,gBAAA;AAAA,cACvB;AAAA,YACF,CACD;AAED,gBAAI,CAACG,EAAS;AACZ,oBAAM,IAAID,EAAiB,8BAA8B;AAG3D,YAAAL,IAAe,EAAE,MAAM,UAAmB,MAAMM,EAAS,oBAAA;AAAA,UAC3D,CAAC,GACDL,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMO,IAAoBC,EAAqB7B,CAAW;AAE1D,SAAO;AAAA,IACL,WAAW;AAAA,IACX,MAAM,CAAA;AAAA,IACN,QAAQ,EAAE,WAAAK,GAAW,MAAM,SAAA;AAAA,IAC3B,SAAS,EAAE,UAAAc,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,MAAMoB;AAAA,QACN,eAAeC;AAAA,QACf,eAAeC;AAAA,QACf,aAAaC;AAAA,MAAA;AAAA,MAEf,gBAAAhB;AAAA,MACA,mBAAAW;AAAA,MACA,yBAAyBM,EAA8BlC,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}
+{"version":3,"file":"useBankForm.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useBankForm/useBankForm.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 { EmployeeBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/employeebankaccount'\nimport { useEmployeePaymentMethodCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeePaymentMethodCreate'\nimport {\n  ACCOUNT_TYPES,\n  type AccountType,\n  createBankFormSchema,\n  type BankFormData,\n  type BankFormOptionalFieldsToRequire,\n  type BankFormOutputs,\n} from './useBankFormSchema'\nimport { AccountNumberField, AccountTypeField, NameField, RoutingNumberField } 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'\n\n/**\n * Optional submit-time overrides for {@link useBankForm}'s `onSubmit`.\n *\n * @public\n */\nexport interface BankFormSubmitOptions {\n  /** Override the `employeeId` configured at hook construction. Useful when the employee is created in the same submit chain. */\n  employeeId?: string\n}\n\n/**\n * Props for {@link useBankForm}.\n *\n * @public\n */\nexport interface UseBankFormProps {\n  /** Employee for whom to create the bank account. May be supplied later via `BankFormSubmitOptions.employeeId`. */\n  employeeId?: string\n  /** Override optional fields to be required. Reserved for future schema expansion — every field is required by default. */\n  optionalFieldsToRequire?: BankFormOptionalFieldsToRequire\n  /** Pre-fill form values. `accountType` defaults to `'Checking'` when not supplied. */\n  defaultValues?: Partial<BankFormData>\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 useBankForm} on `form.Fields`.\n *\n * @public\n */\nexport interface BankFormFields {\n  /** Bound to `name` — see {@link NameField}. */\n  Name: typeof NameField\n  /** Bound to `routingNumber` — see {@link RoutingNumberField}. */\n  RoutingNumber: typeof RoutingNumberField\n  /** Bound to `accountNumber` — see {@link AccountNumberField}. */\n  AccountNumber: typeof AccountNumberField\n  /** Bound to `accountType` — see {@link AccountTypeField}. */\n  AccountType: typeof AccountTypeField\n}\n\n/**\n * Ready-state return value of {@link useBankForm}.\n *\n * @public\n */\nexport interface UseBankFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  BankFormData,\n  BankFormFields\n> {\n  /** No server-fetched data — the create form derives everything from user input. */\n  data: Record<string, never>\n  /** `isPending` reflects the in-flight create mutation; `mode` is always `'create'`. */\n  status: { isPending: boolean; mode: 'create' }\n  /** Submit the form. Optional {@link BankFormSubmitOptions} can override the `employeeId` supplied to the hook. */\n  actions: {\n    onSubmit: (\n      options?: BankFormSubmitOptions,\n    ) => Promise<HookSubmitResult<EmployeeBankAccount> | undefined>\n  }\n}\n\n/**\n * Headless React Hook Form hook for creating an employee bank account.\n *\n * @remarks\n * Captures the account nickname, routing number, account number, and account\n * type. Creating a bank account also updates the employee's payment method on\n * the Gusto API. Returns the standard `HookLoadingResult | UseBankFormReady`\n * discriminated union; in practice the hook transitions to the ready state\n * immediately because it does not fetch any server data.\n *\n * @param props - See {@link UseBankFormProps}.\n * @returns A loading-state result while the hook is initializing, or a {@link UseBankFormReady} ready to render.\n * @public\n *\n * @example\n * ```tsx\n * import { useBankForm, SDKFormProvider } from '@gusto/embedded-react-sdk'\n *\n * function AddBankAccount({ employeeId }: { employeeId: string }) {\n *   const bankForm = useBankForm({ employeeId })\n *\n *   if (bankForm.isLoading) return null\n *   const { Fields } = bankForm.form\n *\n *   return (\n *     <SDKFormProvider formHookResult={bankForm}>\n *       <form\n *         onSubmit={e => {\n *           e.preventDefault()\n *           void bankForm.actions.onSubmit()\n *         }}\n *       >\n *         <Fields.Name label=\"Account nickname\" />\n *         <Fields.RoutingNumber label=\"Routing number\" />\n *         <Fields.AccountNumber label=\"Account number\" />\n *         <Fields.AccountType label=\"Account type\" />\n *         <button type=\"submit\" disabled={bankForm.status.isPending}>Save</button>\n *       </form>\n *     </SDKFormProvider>\n *   )\n * }\n * ```\n */\nexport function useBankForm({\n  employeeId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseBankFormProps): HookLoadingResult | UseBankFormReady {\n  const [schema, metadataConfig] = useMemo(\n    () => createBankFormSchema({ optionalFieldsToRequire }),\n    [optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: BankFormData = useMemo(\n    () => ({\n      name: partnerDefaults?.name ?? '',\n      routingNumber: partnerDefaults?.routingNumber ?? '',\n      accountNumber: partnerDefaults?.accountNumber ?? '',\n      accountType: (partnerDefaults?.accountType ?? 'Checking') as AccountType,\n    }),\n    [partnerDefaults],\n  )\n\n  const formMethods = useForm<BankFormData, unknown, BankFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const createMutation = useEmployeePaymentMethodCreateMutation()\n  const isPending = createMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('BankForm')\n\n  const errorHandling = composeErrorHandler([], { submitError, setSubmitError })\n\n  const accountTypeOptions = ACCOUNT_TYPES.map(value => ({ value, label: value }))\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    name: baseMetadata.name,\n    routingNumber: baseMetadata.routingNumber,\n    accountNumber: baseMetadata.accountNumber,\n    accountType: withOptions<AccountType>(baseMetadata.accountType, accountTypeOptions, [\n      ...ACCOUNT_TYPES,\n    ]),\n  }\n\n  const onSubmit = async (\n    options?: BankFormSubmitOptions,\n  ): Promise<HookSubmitResult<EmployeeBankAccount> | undefined> => {\n    let submitResult: HookSubmitResult<EmployeeBankAccount> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: BankFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const resolvedEmployeeId = options?.employeeId ?? employeeId\n            if (!resolvedEmployeeId) {\n              throw new SDKInternalError(\n                'employeeId is required to submit a bank account. Pass it to useBankForm or via BankFormSubmitOptions.',\n              )\n            }\n\n            const response = await createMutation.mutateAsync({\n              request: {\n                employeeId: resolvedEmployeeId,\n                employeeBankAccountRequest: {\n                  name: payload.name,\n                  routingNumber: payload.routingNumber,\n                  accountNumber: payload.accountNumber,\n                  accountType: payload.accountType,\n                },\n              },\n            })\n\n            if (!response.employeeBankAccount) {\n              throw new SDKInternalError('Bank account creation failed')\n            }\n\n            submitResult = { mode: 'create' as const, data: response.employeeBankAccount }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  return {\n    isLoading: false as const,\n    data: {} as Record<string, never>,\n    status: { isPending, mode: 'create' as const },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Name: NameField,\n        RoutingNumber: RoutingNumberField,\n        AccountNumber: AccountNumberField,\n        AccountType: AccountTypeField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Return type of {@link useBankForm} — a discriminated union on `isLoading`.\n *\n * @public\n */\nexport type UseBankFormResult = HookLoadingResult | UseBankFormReady\n\n/**\n * Per-field metadata exposed on `form.fieldsMetadata` for {@link useBankForm}.\n *\n * @public\n */\nexport type BankFormFieldsMetadata = UseBankFormReady['form']['fieldsMetadata']\n"],"names":["useBankForm","employeeId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","schema","metadataConfig","useMemo","createBankFormSchema","resolvedDefaults","formMethods","useForm","zodResolver","createMutation","useEmployeePaymentMethodCreateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","accountTypeOptions","ACCOUNT_TYPES","value","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","options","submitResult","resolve","data","payload","resolvedEmployeeId","SDKInternalError","response","hookFormInternals","useHookFormInternals","NameField","RoutingNumberField","AccountNumberField","AccountTypeField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;AA0IO,SAASA,GAAY;AAAA,EAC1B,YAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAA2D;AACzD,QAAM,CAACC,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAAqB,EAAE,yBAAAP,GAAyB;AAAA,IACtD,CAACA,CAAuB;AAAA,EAAA,GAGpBQ,IAAiCF;AAAA,IACrC,OAAO;AAAA,MACL,MAAML,GAAiB,QAAQ;AAAA,MAC/B,eAAeA,GAAiB,iBAAiB;AAAA,MACjD,eAAeA,GAAiB,iBAAiB;AAAA,MACjD,aAAcA,GAAiB,eAAe;AAAA,IAAA;AAAA,IAEhD,CAACA,CAAe;AAAA,EAAA,GAGZQ,IAAcC,EAAgD;AAAA,IAClE,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMF;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeK;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAAiBC,EAAA,GACjBC,IAAYF,EAAe,WAE3B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,UAAU,GAEtBC,IAAgBC,EAAoB,CAAA,GAAI,EAAE,aAAAJ,GAAa,gBAAAC,GAAgB,GAEvEI,IAAqBC,EAAc,IAAI,CAAAC,OAAU,EAAE,OAAAA,GAAO,OAAOA,IAAQ,GAEzEC,IAAeC,EAAwBpB,GAAgBI,EAAY,OAAO,GAC1EiB,IAAiB;AAAA,IACrB,MAAMF,EAAa;AAAA,IACnB,eAAeA,EAAa;AAAA,IAC5B,eAAeA,EAAa;AAAA,IAC5B,aAAaG,EAAyBH,EAAa,aAAaH,GAAoB;AAAA,MAClF,GAAGC;AAAA,IAAA,CACJ;AAAA,EAAA,GAGGM,IAAW,OACfC,MAC+D;AAC/D,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKtB,EAAY;AAAA,QACf,OAAOuB,MAA0B;AAC/B,gBAAMjB,EAAkBiB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAqBL,GAAS,cAAc9B;AAClD,gBAAI,CAACmC;AACH,oBAAM,IAAIC;AAAA,gBACR;AAAA,cAAA;AAIJ,kBAAMC,IAAW,MAAMxB,EAAe,YAAY;AAAA,cAChD,SAAS;AAAA,gBACP,YAAYsB;AAAA,gBACZ,4BAA4B;AAAA,kBAC1B,MAAMD,EAAQ;AAAA,kBACd,eAAeA,EAAQ;AAAA,kBACvB,eAAeA,EAAQ;AAAA,kBACvB,aAAaA,EAAQ;AAAA,gBAAA;AAAA,cACvB;AAAA,YACF,CACD;AAED,gBAAI,CAACG,EAAS;AACZ,oBAAM,IAAID,EAAiB,8BAA8B;AAG3D,YAAAL,IAAe,EAAE,MAAM,UAAmB,MAAMM,EAAS,oBAAA;AAAA,UAC3D,CAAC,GACDL,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMO,IAAoBC,EAAqB7B,CAAW;AAE1D,SAAO;AAAA,IACL,WAAW;AAAA,IACX,MAAM,CAAA;AAAA,IACN,QAAQ,EAAE,WAAAK,GAAW,MAAM,SAAA;AAAA,IAC3B,SAAS,EAAE,UAAAc,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,MAAMoB;AAAA,QACN,eAAeC;AAAA,QACf,eAAeC;AAAA,QACf,aAAaC;AAAA,MAAA;AAAA,MAEf,gBAAAhB;AAAA,MACA,mBAAAW;AAAA,MACA,yBAAyBM,EAA8BlC,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Employee/PaymentMethod/shared/useBankForm/useBankFormSchema.d.ts

@@ -1,12 +1,34 @@
 import { z } from 'zod';
 import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes emitted by the bank account form schema. Map these
+ * codes to localized copy in `validationMessages` when composing the hook.
+ *
+ * @public
+ */
 export declare const BankFormErrorCodes: {
     readonly REQUIRED: "REQUIRED";
     readonly INVALID_ROUTING_NUMBER: "INVALID_ROUTING_NUMBER";
     readonly INVALID_ACCOUNT_NUMBER: "INVALID_ACCOUNT_NUMBER";
 };
+/**
+ * Union of validation error code strings emitted by the bank account form
+ * schema.
+ *
+ * @public
+ */
 export type BankFormErrorCode = (typeof BankFormErrorCodes)[keyof typeof BankFormErrorCodes];
+/**
+ * Supported bank account type values: checking and savings.
+ *
+ * @public
+ */
 export declare const ACCOUNT_TYPES: readonly ["Checking", "Savings"];
+/**
+ * Union of bank account type values that the form accepts.
+ *
+ * @public
+ */
 export type AccountType = (typeof ACCOUNT_TYPES)[number];
 declare const fieldValidators: {
     name: z.ZodString;
@@ -17,16 +39,39 @@ declare const fieldValidators: {
         Savings: "Savings";
     }>;
 };
+/**
+ * Field names accepted by the bank account form.
+ *
+ * @public
+ */
 export type BankFormField = keyof typeof fieldValidators;
+/**
+ * Shape of the values managed by the bank account form.
+ *
+ * @public
+ */
 export type BankFormData = {
     [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
 };
+/**
+ * Shape of the validated values produced by the bank account form on submit.
+ *
+ * @public
+ */
 export type BankFormOutputs = BankFormData;
 declare const requiredFieldsConfig: {};
+/**
+ * Keys of optional bank account fields that can be promoted to required via
+ * the hook's `optionalFieldsToRequire` option.
+ *
+ * @public
+ */
 export type BankFormOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+/** @internal */
 interface BankFormSchemaOptions {
     optionalFieldsToRequire?: BankFormOptionalFieldsToRequire;
 }
+/** @internal */
 export declare function createBankFormSchema(options?: BankFormSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
     name: z.ZodString;
     routingNumber: z.ZodString;

package/dist/components/Employee/PaymentMethod/shared/useBankForm/useBankFormSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"useBankFormSchema.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useBankForm/useBankFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type OptionalFieldsToRequire,\n  type RequiredFieldConfig,\n} from '@/partner-hook-utils/form/buildFormSchema'\n\nexport const BankFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n  INVALID_ROUTING_NUMBER: 'INVALID_ROUTING_NUMBER',\n  INVALID_ACCOUNT_NUMBER: 'INVALID_ACCOUNT_NUMBER',\n} as const\n\nexport type BankFormErrorCode = (typeof BankFormErrorCodes)[keyof typeof BankFormErrorCodes]\n\nconst ROUTING_NUMBER_REGEX = /^[0-9]{9}$/\nconst ACCOUNT_NUMBER_REGEX = /^[0-9]{1,17}$/\n\nexport const ACCOUNT_TYPES = ['Checking', 'Savings'] as const\nexport type AccountType = (typeof ACCOUNT_TYPES)[number]\n\nconst fieldValidators = {\n  name: z.string(),\n  routingNumber: z\n    .string()\n    .regex(ROUTING_NUMBER_REGEX, { message: BankFormErrorCodes.INVALID_ROUTING_NUMBER }),\n  accountNumber: z\n    .string()\n    .regex(ACCOUNT_NUMBER_REGEX, { message: BankFormErrorCodes.INVALID_ACCOUNT_NUMBER }),\n  accountType: z.enum(ACCOUNT_TYPES),\n}\n\nexport type BankFormField = keyof typeof fieldValidators\n\nexport type BankFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\nexport type BankFormOutputs = BankFormData\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\nexport type BankFormOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>\n\ninterface BankFormSchemaOptions {\n  optionalFieldsToRequire?: BankFormOptionalFieldsToRequire\n}\n\nexport function createBankFormSchema(options: BankFormSchemaOptions = {}) {\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: BankFormErrorCodes.REQUIRED,\n    mode: 'create',\n    optionalFieldsToRequire: options.optionalFieldsToRequire,\n  })\n}\n"],"names":["BankFormErrorCodes","ROUTING_NUMBER_REGEX","ACCOUNT_NUMBER_REGEX","ACCOUNT_TYPES","fieldValidators","z","requiredFieldsConfig","createBankFormSchema","options","buildFormSchema"],"mappings":";;AAOO,MAAMA,IAAqB;AAAA,EAChC,UAAU;AAAA,EACV,wBAAwB;AAAA,EACxB,wBAAwB;AAC1B,GAIMC,IAAuB,cACvBC,IAAuB,iBAEhBC,IAAgB,CAAC,YAAY,SAAS,GAG7CC,IAAkB;AAAA,EACtB,MAAMC,EAAE,OAAA;AAAA,EACR,eAAeA,EACZ,OAAA,EACA,MAAMJ,GAAsB,EAAE,SAASD,EAAmB,wBAAwB;AAAA,EACrF,eAAeK,EACZ,OAAA,EACA,MAAMH,GAAsB,EAAE,SAASF,EAAmB,wBAAwB;AAAA,EACrF,aAAaK,EAAE,KAAKF,CAAa;AACnC,GASMG,IAAuB,CAAA;AAQtB,SAASC,EAAqBC,IAAiC,IAAI;AACxE,SAAOC,EAAgBL,GAAiB;AAAA,IACtC,sBAAAE;AAAA,IACA,mBAAmBN,EAAmB;AAAA,IACtC,MAAM;AAAA,IACN,yBAAyBQ,EAAQ;AAAA,EAAA,CAClC;AACH;"}
+{"version":3,"file":"useBankFormSchema.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/useBankForm/useBankFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type OptionalFieldsToRequire,\n  type RequiredFieldConfig,\n} from '@/partner-hook-utils/form/buildFormSchema'\n\n/**\n * Validation error codes emitted by the bank account form schema. Map these\n * codes to localized copy in `validationMessages` when composing the hook.\n *\n * @public\n */\nexport const BankFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n  INVALID_ROUTING_NUMBER: 'INVALID_ROUTING_NUMBER',\n  INVALID_ACCOUNT_NUMBER: 'INVALID_ACCOUNT_NUMBER',\n} as const\n\n/**\n * Union of validation error code strings emitted by the bank account form\n * schema.\n *\n * @public\n */\nexport type BankFormErrorCode = (typeof BankFormErrorCodes)[keyof typeof BankFormErrorCodes]\n\nconst ROUTING_NUMBER_REGEX = /^[0-9]{9}$/\nconst ACCOUNT_NUMBER_REGEX = /^[0-9]{1,17}$/\n\n/**\n * Supported bank account type values: checking and savings.\n *\n * @public\n */\nexport const ACCOUNT_TYPES = ['Checking', 'Savings'] as const\n/**\n * Union of bank account type values that the form accepts.\n *\n * @public\n */\nexport type AccountType = (typeof ACCOUNT_TYPES)[number]\n\nconst fieldValidators = {\n  name: z.string(),\n  routingNumber: z\n    .string()\n    .regex(ROUTING_NUMBER_REGEX, { message: BankFormErrorCodes.INVALID_ROUTING_NUMBER }),\n  accountNumber: z\n    .string()\n    .regex(ACCOUNT_NUMBER_REGEX, { message: BankFormErrorCodes.INVALID_ACCOUNT_NUMBER }),\n  accountType: z.enum(ACCOUNT_TYPES),\n}\n\n/**\n * Field names accepted by the bank account form.\n *\n * @public\n */\nexport type BankFormField = keyof typeof fieldValidators\n\n/**\n * Shape of the values managed by the bank account form.\n *\n * @public\n */\nexport type BankFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n/**\n * Shape of the validated values produced by the bank account form on submit.\n *\n * @public\n */\nexport type BankFormOutputs = BankFormData\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Keys of optional bank account fields that can be promoted to required via\n * the hook's `optionalFieldsToRequire` option.\n *\n * @public\n */\nexport type BankFormOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>\n\n/** @internal */\ninterface BankFormSchemaOptions {\n  optionalFieldsToRequire?: BankFormOptionalFieldsToRequire\n}\n\n/** @internal */\nexport function createBankFormSchema(options: BankFormSchemaOptions = {}) {\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: BankFormErrorCodes.REQUIRED,\n    mode: 'create',\n    optionalFieldsToRequire: options.optionalFieldsToRequire,\n  })\n}\n"],"names":["BankFormErrorCodes","ROUTING_NUMBER_REGEX","ACCOUNT_NUMBER_REGEX","ACCOUNT_TYPES","fieldValidators","z","requiredFieldsConfig","createBankFormSchema","options","buildFormSchema"],"mappings":";;AAaO,MAAMA,IAAqB;AAAA,EAChC,UAAU;AAAA,EACV,wBAAwB;AAAA,EACxB,wBAAwB;AAC1B,GAUMC,IAAuB,cACvBC,IAAuB,iBAOhBC,IAAgB,CAAC,YAAY,SAAS,GAQ7CC,IAAkB;AAAA,EACtB,MAAMC,EAAE,OAAA;AAAA,EACR,eAAeA,EACZ,OAAA,EACA,MAAMJ,GAAsB,EAAE,SAASD,EAAmB,wBAAwB;AAAA,EACrF,eAAeK,EACZ,OAAA,EACA,MAAMH,GAAsB,EAAE,SAASF,EAAmB,wBAAwB;AAAA,EACrF,aAAaK,EAAE,KAAKF,CAAa;AACnC,GAwBMG,IAAuB,CAAA;AAgBtB,SAASC,EAAqBC,IAAiC,IAAI;AACxE,SAAOC,EAAgBL,GAAiB;AAAA,IACtC,sBAAAE;AAAA,IACA,mBAAmBN,EAAmB;AAAA,IACtC,MAAM;AAAA,IACN,yBAAyBQ,EAAQ;AAAA,EAAA,CAClC;AACH;"}

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

@@ -1,3 +1,4 @@
+/** @internal */
 export declare function useDeleteBankAccount(handleDelete: (uuid: string) => Promise<void>): {
     pendingDeleteAccount: {
         uuid: string;

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

@@ -1 +1 @@
-{"version":3,"file":"useDeleteBankAccount.js","sources":["../../../../../src/components/Employee/PaymentMethod/shared/useDeleteBankAccount.ts"],"sourcesContent":["import { useState } from 'react'\n\nexport function useDeleteBankAccount(handleDelete: (uuid: string) => Promise<void>) {\n  const [pendingDeleteAccount, setPendingDeleteAccount] = useState<{\n    uuid: string\n    hiddenAccountNumber: string | undefined\n  } | null>(null)\n  const [deletedAccountNumber, setDeletedAccountNumber] = useState<string | null>(null)\n\n  const handleConfirmDelete = async () => {\n    if (!pendingDeleteAccount) return\n    const { uuid, hiddenAccountNumber } = pendingDeleteAccount\n    setPendingDeleteAccount(null)\n    await handleDelete(uuid)\n    setDeletedAccountNumber(hiddenAccountNumber ?? '')\n  }\n\n  return {\n    pendingDeleteAccount,\n    setPendingDeleteAccount,\n    deletedAccountNumber,\n    setDeletedAccountNumber,\n    handleConfirmDelete,\n  }\n}\n"],"names":["useDeleteBankAccount","handleDelete","pendingDeleteAccount","setPendingDeleteAccount","useState","deletedAccountNumber","setDeletedAccountNumber","uuid","hiddenAccountNumber"],"mappings":";AAEO,SAASA,EAAqBC,GAA+C;AAClF,QAAM,CAACC,GAAsBC,CAAuB,IAAIC,EAG9C,IAAI,GACR,CAACC,GAAsBC,CAAuB,IAAIF,EAAwB,IAAI;AAUpF,SAAO;AAAA,IACL,sBAAAF;AAAA,IACA,yBAAAC;AAAA,IACA,sBAAAE;AAAA,IACA,yBAAAC;AAAA,IACA,qBAb0B,YAAY;AACtC,UAAI,CAACJ,EAAsB;AAC3B,YAAM,EAAE,MAAAK,GAAM,qBAAAC,EAAA,IAAwBN;AACtC,MAAAC,EAAwB,IAAI,GAC5B,MAAMF,EAAaM,CAAI,GACvBD,EAAwBE,KAAuB,EAAE;AAAA,IACnD;AAAA,EAOE;AAEJ;"}
+{"version":3,"file":"useDeleteBankAccount.js","sources":["../../../../../src/components/Employee/PaymentMethod/shared/useDeleteBankAccount.ts"],"sourcesContent":["import { useState } from 'react'\n\n/** @internal */\nexport function useDeleteBankAccount(handleDelete: (uuid: string) => Promise<void>) {\n  const [pendingDeleteAccount, setPendingDeleteAccount] = useState<{\n    uuid: string\n    hiddenAccountNumber: string | undefined\n  } | null>(null)\n  const [deletedAccountNumber, setDeletedAccountNumber] = useState<string | null>(null)\n\n  const handleConfirmDelete = async () => {\n    if (!pendingDeleteAccount) return\n    const { uuid, hiddenAccountNumber } = pendingDeleteAccount\n    setPendingDeleteAccount(null)\n    await handleDelete(uuid)\n    setDeletedAccountNumber(hiddenAccountNumber ?? '')\n  }\n\n  return {\n    pendingDeleteAccount,\n    setPendingDeleteAccount,\n    deletedAccountNumber,\n    setDeletedAccountNumber,\n    handleConfirmDelete,\n  }\n}\n"],"names":["useDeleteBankAccount","handleDelete","pendingDeleteAccount","setPendingDeleteAccount","useState","deletedAccountNumber","setDeletedAccountNumber","uuid","hiddenAccountNumber"],"mappings":";AAGO,SAASA,EAAqBC,GAA+C;AAClF,QAAM,CAACC,GAAsBC,CAAuB,IAAIC,EAG9C,IAAI,GACR,CAACC,GAAsBC,CAAuB,IAAIF,EAAwB,IAAI;AAUpF,SAAO;AAAA,IACL,sBAAAF;AAAA,IACA,yBAAAC;AAAA,IACA,sBAAAE;AAAA,IACA,yBAAAC;AAAA,IACA,qBAb0B,YAAY;AACtC,UAAI,CAACJ,EAAsB;AAC3B,YAAM,EAAE,MAAAK,GAAM,qBAAAC,EAAA,IAAwBN;AACtC,MAAAC,EAAwB,IAAI,GAC5B,MAAMF,EAAaM,CAAI,GACvBD,EAAwBE,KAAuB,EAAE;AAAA,IACnD;AAAA,EAOE;AAEJ;"}

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

@@ -1,6 +1,28 @@
 import { PaymentMethodFormErrorCodes, PaymentMethodType } from './usePaymentMethodFormSchema';
 import { RadioGroupHookFieldProps } from '../../../../../partner-hook-utils/form/fields/RadioGroupHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * Validation error codes emitted by {@link usePaymentMethodForm} fields that only emit `REQUIRED`.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof PaymentMethodFormErrorCodes.REQUIRED;
+/**
+ * Props accepted by {@link usePaymentMethodForm}'s `Fields.Type` component.
+ *
+ * @public
+ */
 export type TypeFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, PaymentMethodType>>;
+/**
+ * Radio group bound to the `type` field of {@link usePaymentMethodForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Type`. Options are
+ * `Direct Deposit` and `Check`; defaults to the employee's existing payment
+ * method type. Supply `getOptionLabel` to translate the option labels.
+ *
+ * @param props - See {@link TypeFieldProps}.
+ * @returns The rendered radio group bound to `type`.
+ * @public
+ */
 export declare function TypeField(props: TypeFieldProps): import("react").JSX.Element;

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

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodForm/fields.tsx"],"sourcesContent":["import type { PaymentMethodFormErrorCodes, PaymentMethodType } from './usePaymentMethodFormSchema'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport { RadioGroupHookField } from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof PaymentMethodFormErrorCodes.REQUIRED\n\nexport type TypeFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, PaymentMethodType>\n>\n\nexport function TypeField(props: TypeFieldProps) {\n  return <RadioGroupHookField {...props} name=\"type\" />\n}\n"],"names":["TypeField","props","jsx","RadioGroupHookField"],"mappings":";;AAWO,SAASA,EAAUC,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAqB,GAAGF,GAAO,MAAK,QAAO;AACrD;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/PaymentMethod/shared/usePaymentMethodForm/fields.tsx"],"sourcesContent":["import type { PaymentMethodFormErrorCodes, PaymentMethodType } from './usePaymentMethodFormSchema'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport { RadioGroupHookField } from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\n/**\n * Validation error codes emitted by {@link usePaymentMethodForm} fields that only emit `REQUIRED`.\n *\n * @public\n */\nexport type RequiredValidation = typeof PaymentMethodFormErrorCodes.REQUIRED\n\n/**\n * Props accepted by {@link usePaymentMethodForm}'s `Fields.Type` component.\n *\n * @public\n */\nexport type TypeFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, PaymentMethodType>\n>\n\n/**\n * Radio group bound to the `type` field of {@link usePaymentMethodForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Type`. Options are\n * `Direct Deposit` and `Check`; defaults to the employee's existing payment\n * method type. Supply `getOptionLabel` to translate the option labels.\n *\n * @param props - See {@link TypeFieldProps}.\n * @returns The rendered radio group bound to `type`.\n * @public\n */\nexport function TypeField(props: TypeFieldProps) {\n  return <RadioGroupHookField {...props} name=\"type\" />\n}\n"],"names":["TypeField","props","jsx","RadioGroupHookField"],"mappings":";;AAiCO,SAASA,EAAUC,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAqB,GAAGF,GAAO,MAAK,QAAO;AACrD;"}

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

@@ -1,5 +1,5 @@
 import "./types/i18next.d.ts"
 export { usePaymentMethodForm } from './usePaymentMethodForm';
-export type { UsePaymentMethodFormProps, UsePaymentMethodFormResult, UsePaymentMethodFormReady, PaymentMethodFormFields, PaymentMethodFormFieldsMetadata, PaymentMethodFormFieldsType, } from './usePaymentMethodForm';
+export type { UsePaymentMethodFormProps, UsePaymentMethodFormResult, UsePaymentMethodFormReady, PaymentMethodFormFields, PaymentMethodFormFieldsMetadata, } from './usePaymentMethodForm';
 export { PAYMENT_METHOD_TYPES, PaymentMethodFormErrorCodes, createPaymentMethodFormSchema, type PaymentMethodFormErrorCode, type PaymentMethodFormData, type PaymentMethodFormField, type PaymentMethodFormOptionalFieldsToRequire, type PaymentMethodFormOutputs, type PaymentMethodType, } from './usePaymentMethodFormSchema';
-export { TypeField, type TypeFieldProps, type RequiredValidation as PaymentMethodFormRequiredValidation, } from './fields';
+export { TypeField as PaymentMethodTypeField, type TypeFieldProps, type RequiredValidation as PaymentMethodFormRequiredValidation, } from './fields';

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'];