@gusto/embedded-react-sdk 0.48.3 → 0.50.0

package/dist/components/Contractor/PaymentMethod/shared/useContractorBankAccountForm/useContractorBankAccountForm.js

@@ -0,0 +1,109 @@
+import { useMemo as N } from "react";
+import { useForm as E } from "react-hook-form";
+import { zodResolver as P } from "@hookform/resolvers/zod";
+import { useContractorPaymentMethodGetBankAccounts as V } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorPaymentMethodGetBankAccounts";
+import { useContractorPaymentMethodsCreateBankAccountMutation as H } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorPaymentMethodsCreateBankAccount";
+import { createContractorBankAccountSchema as L, ACCOUNT_TYPES as g } from "./useContractorBankAccountFormSchema.js";
+import { AccountTypeField as O, AccountNumberField as R, RoutingNumberField as U, NameField as x } from "./fields.js";
+import { useDeriveFieldsMetadata as G } from "../../../../../partner-hook-utils/form/useDeriveFieldsMetadata.js";
+import { useHookFormInternals as I } from "../../../../../partner-hook-utils/form/useHookFormInternals.js";
+import { createGetFormSubmissionValues as q } from "../../../../../partner-hook-utils/form/getFormSubmissionValues.js";
+import { withOptions as z } from "../../../../../partner-hook-utils/form/withOptions.js";
+import { composeErrorHandler as K } from "../../../../../partner-hook-utils/composeErrorHandler.js";
+import { useBaseSubmit as Q } from "../../../../Base/useBaseSubmit.js";
+import { SDKInternalError as Y } from "../../../../../types/sdkError.js";
+function at({
+  contractorId: m,
+  optionalFieldsToRequire: i,
+  defaultValues: o,
+  validationMode: A = "onSubmit",
+  shouldFocusError: k = !0
+}) {
+  const u = V({
+    contractorUuid: m
+  }), t = u.data?.contractorBankAccountList?.[0] ?? void 0, r = t?.hiddenAccountNumber ?? void 0, [s, y] = N(
+    () => L({
+      optionalFieldsToRequire: i,
+      existingAccountNumberMask: r
+    }),
+    [i, r]
+  ), d = N(
+    () => ({
+      name: o?.name ?? t?.name ?? "",
+      routingNumber: o?.routingNumber ?? t?.routingNumber ?? "",
+      accountNumber: o?.accountNumber ?? r ?? "",
+      accountType: o?.accountType ?? t?.accountType ?? "Checking"
+    }),
+    [o, t, r]
+  ), n = E({
+    resolver: P(s),
+    mode: A,
+    shouldFocusError: k,
+    defaultValues: d,
+    values: d,
+    resetOptions: { keepDirtyValues: !0 }
+  }), b = H(), B = b.isPending, {
+    baseSubmitHandler: F,
+    error: h,
+    setError: C
+  } = Q("ContractorBankAccountForm"), p = K([u], {
+    submitError: h,
+    setSubmitError: C
+  }), S = g.map((e) => ({ value: e, label: e })), c = G(y, n.control), T = {
+    name: c.name,
+    routingNumber: c.routingNumber,
+    accountNumber: c.accountNumber,
+    accountType: z(c.accountType, S, [
+      ...g
+    ])
+  }, M = async () => {
+    let e;
+    return await new Promise((f) => {
+      n.handleSubmit(
+        async (v) => {
+          await F(v, async (a) => {
+            const l = await b.mutateAsync({
+              request: {
+                contractorUuid: m,
+                contractorBankAccountCreateRequestBody: {
+                  name: a.name,
+                  routingNumber: a.routingNumber,
+                  accountNumber: a.accountNumber,
+                  accountType: a.accountType
+                }
+              }
+            });
+            if (!l.contractorBankAccount)
+              throw new Y("Bank account creation failed");
+            e = { mode: "create", data: l.contractorBankAccount };
+          }), f();
+        },
+        () => {
+          f();
+        }
+      )();
+    }), e;
+  }, w = I(n);
+  return u.isLoading ? { isLoading: !0, errorHandling: p } : {
+    isLoading: !1,
+    data: { bankAccount: t },
+    status: { isPending: B, mode: "create" },
+    actions: { onSubmit: M },
+    errorHandling: p,
+    form: {
+      Fields: {
+        Name: x,
+        RoutingNumber: U,
+        AccountNumber: R,
+        AccountType: O
+      },
+      fieldsMetadata: T,
+      hookFormInternals: w,
+      getFormSubmissionValues: q(n, s)
+    }
+  };
+}
+export {
+  at as useContractorBankAccountForm
+};
+//# sourceMappingURL=useContractorBankAccountForm.js.map

package/dist/components/Contractor/PaymentMethod/shared/useContractorBankAccountForm/useContractorBankAccountForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useContractorBankAccountForm.js","sources":["../../../../../../src/components/Contractor/PaymentMethod/shared/useContractorBankAccountForm/useContractorBankAccountForm.tsx"],"sourcesContent":["import type { ComponentType } from 'react'\nimport { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { ContractorBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/contractorbankaccount'\nimport { useContractorPaymentMethodGetBankAccounts } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorPaymentMethodGetBankAccounts'\nimport { useContractorPaymentMethodsCreateBankAccountMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorPaymentMethodsCreateBankAccount'\nimport {\n  ACCOUNT_TYPES,\n  createContractorBankAccountSchema,\n  type ContractorAccountType,\n  type ContractorBankAccountFormData,\n  type ContractorBankAccountFormOutputs,\n  type ContractorBankAccountOptionalFieldsToRequire,\n} from './useContractorBankAccountFormSchema'\nimport type {\n  AccountNumberFieldProps,\n  AccountTypeFieldProps,\n  NameFieldProps,\n  RoutingNumberFieldProps,\n} from './fields'\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 * Props for {@link useContractorBankAccountForm}.\n *\n * @public\n */\nexport interface UseContractorBankAccountFormProps {\n  /** Contractor for whom to create the bank account. */\n  contractorId: string\n  /** Override optional fields to be required. */\n  optionalFieldsToRequire?: ContractorBankAccountOptionalFieldsToRequire\n  /** Pre-fill form values. The contractor's existing bank account is used when no override is supplied. */\n  defaultValues?: Partial<ContractorBankAccountFormData>\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 useContractorBankAccountForm} on `form.Fields`.\n *\n * @public\n */\nexport interface ContractorBankAccountFormFields {\n  /** Bound to `name`. Captures the bank account nickname. */\n  Name: ComponentType<NameFieldProps>\n  /** Bound to `routingNumber`. Validated against a 9-digit numeric pattern. */\n  RoutingNumber: ComponentType<RoutingNumberFieldProps>\n  /**\n   * Bound to `accountNumber`. Pre-filled with the masked account number (e.g.\n   * \"XXXX1207\"), which is accepted unchanged to keep the existing account; a\n   * newly entered value is validated against the 1–17 digit numeric pattern.\n   */\n  AccountNumber: ComponentType<AccountNumberFieldProps>\n  /**\n   * Bound to `accountType`. Options are `Checking` and `Savings`; defaults to\n   * `Checking`. Supply `getOptionLabel` to translate the option labels.\n   */\n  AccountType: ComponentType<AccountTypeFieldProps>\n}\n\n/**\n * Ready-state return value of {@link useContractorBankAccountForm}.\n *\n * @public\n */\nexport interface UseContractorBankAccountFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  ContractorBankAccountFormData,\n  ContractorBankAccountFormFields\n> {\n  /** The contractor's current bank account, loaded from the API, if any. */\n  data: {\n    bankAccount: ContractorBankAccount | undefined\n  }\n  /** `isPending` reflects the in-flight create mutation; `mode` is always `'create'`. */\n  status: { isPending: boolean; mode: 'create' }\n  /** Submit the form. Returns the created bank account on success or `undefined` on validation/mutation failure. */\n  actions: {\n    onSubmit: () => Promise<HookSubmitResult<ContractorBankAccount> | undefined>\n  }\n}\n\n/**\n * Headless React Hook Form hook for creating a contractor's 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 contractor's payment method to\n * Direct Deposit on the Gusto API as a side-effect, so the Direct Deposit path\n * needs only this submit — no separate payment method update.\n *\n * When the contractor already has a bank account on file, the account number\n * field is pre-filled with the masked token the API returns (e.g. \"XXXX1207\").\n * The API requires `account_number` on every write and treats that exact masked\n * value as \"keep the existing account,\" so submitting it unchanged preserves the\n * account while still applying any name/routing/type edits; typing a real number\n * replaces it.\n *\n * @param props - See {@link UseContractorBankAccountFormProps}.\n * @returns A loading-state result while data loads, or a {@link UseContractorBankAccountFormReady} once ready.\n * @public\n *\n * @example\n * ```tsx\n * import { useContractorBankAccountForm, SDKFormProvider } from '@gusto/embedded-react-sdk'\n *\n * function AddBankAccount({ contractorId }: { contractorId: string }) {\n *   const bankForm = useContractorBankAccountForm({ contractorId })\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 useContractorBankAccountForm({\n  contractorId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseContractorBankAccountFormProps): HookLoadingResult | UseContractorBankAccountFormReady {\n  const bankAccountsQuery = useContractorPaymentMethodGetBankAccounts({\n    contractorUuid: contractorId,\n  })\n  const bankAccount = bankAccountsQuery.data?.contractorBankAccountList?.[0] ?? undefined\n\n  const existingAccountNumberMask = bankAccount?.hiddenAccountNumber ?? undefined\n\n  const [schema, metadataConfig] = useMemo(\n    () =>\n      createContractorBankAccountSchema({\n        optionalFieldsToRequire,\n        existingAccountNumberMask,\n      }),\n    [optionalFieldsToRequire, existingAccountNumberMask],\n  )\n\n  // The account number is seeded with the masked token the API returns (e.g.\n  // \"XXXX1207\"). The bank account API requires account_number on every write\n  // and treats that exact masked value as \"keep the existing account,\" so\n  // submitting it unchanged preserves the account; typing a new number replaces it.\n  const resolvedDefaults: ContractorBankAccountFormData = useMemo(\n    () => ({\n      name: partnerDefaults?.name ?? bankAccount?.name ?? '',\n      routingNumber: partnerDefaults?.routingNumber ?? bankAccount?.routingNumber ?? '',\n      accountNumber: partnerDefaults?.accountNumber ?? existingAccountNumberMask ?? '',\n      accountType: (partnerDefaults?.accountType ??\n        bankAccount?.accountType ??\n        'Checking') as ContractorAccountType,\n    }),\n    [partnerDefaults, bankAccount, existingAccountNumberMask],\n  )\n\n  const formMethods = useForm<\n    ContractorBankAccountFormData,\n    unknown,\n    ContractorBankAccountFormOutputs\n  >({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const createMutation = useContractorPaymentMethodsCreateBankAccountMutation()\n  const isPending = createMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('ContractorBankAccountForm')\n\n  const errorHandling = composeErrorHandler([bankAccountsQuery], {\n    submitError,\n    setSubmitError,\n  })\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<ContractorAccountType>(baseMetadata.accountType, accountTypeOptions, [\n      ...ACCOUNT_TYPES,\n    ]),\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<ContractorBankAccount> | undefined> => {\n    let submitResult: HookSubmitResult<ContractorBankAccount> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: ContractorBankAccountFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const response = await createMutation.mutateAsync({\n              request: {\n                contractorUuid: contractorId,\n                contractorBankAccountCreateRequestBody: {\n                  name: payload.name,\n                  routingNumber: payload.routingNumber,\n                  accountNumber: payload.accountNumber,\n                  accountType: payload.accountType,\n                },\n              },\n            })\n\n            if (!response.contractorBankAccount) {\n              throw new SDKInternalError('Bank account creation failed')\n            }\n\n            submitResult = { mode: 'create' as const, data: response.contractorBankAccount }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  if (bankAccountsQuery.isLoading) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: { bankAccount },\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 useContractorBankAccountForm} — a discriminated union on `isLoading`.\n *\n * @public\n */\nexport type UseContractorBankAccountFormResult =\n  HookLoadingResult | UseContractorBankAccountFormReady\n\n/**\n * Per-field metadata exposed on `form.fieldsMetadata` for {@link useContractorBankAccountForm}.\n *\n * @public\n */\nexport type ContractorBankAccountFieldsMetadata =\n  UseContractorBankAccountFormReady['form']['fieldsMetadata']\n"],"names":["useContractorBankAccountForm","contractorId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","bankAccountsQuery","useContractorPaymentMethodGetBankAccounts","bankAccount","existingAccountNumberMask","schema","metadataConfig","useMemo","createContractorBankAccountSchema","resolvedDefaults","formMethods","useForm","zodResolver","createMutation","useContractorPaymentMethodsCreateBankAccountMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","accountTypeOptions","ACCOUNT_TYPES","value","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","submitResult","resolve","data","payload","response","SDKInternalError","hookFormInternals","useHookFormInternals","NameField","RoutingNumberField","AccountNumberField","AccountTypeField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;AAqJO,SAASA,GAA6B;AAAA,EAC3C,cAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAA6F;AAC3F,QAAMC,IAAoBC,EAA0C;AAAA,IAClE,gBAAgBN;AAAA,EAAA,CACjB,GACKO,IAAcF,EAAkB,MAAM,4BAA4B,CAAC,KAAK,QAExEG,IAA4BD,GAAa,uBAAuB,QAEhE,CAACE,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MACEC,EAAkC;AAAA,MAChC,yBAAAX;AAAA,MACA,2BAAAO;AAAA,IAAA,CACD;AAAA,IACH,CAACP,GAAyBO,CAAyB;AAAA,EAAA,GAO/CK,IAAkDF;AAAA,IACtD,OAAO;AAAA,MACL,MAAMT,GAAiB,QAAQK,GAAa,QAAQ;AAAA,MACpD,eAAeL,GAAiB,iBAAiBK,GAAa,iBAAiB;AAAA,MAC/E,eAAeL,GAAiB,iBAAiBM,KAA6B;AAAA,MAC9E,aAAcN,GAAiB,eAC7BK,GAAa,eACb;AAAA,IAAA;AAAA,IAEJ,CAACL,GAAiBK,GAAaC,CAAyB;AAAA,EAAA,GAGpDM,IAAcC,EAIlB;AAAA,IACA,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMN;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeS;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,2BAA2B,GAEvCC,IAAgBC,EAAoB,CAACpB,CAAiB,GAAG;AAAA,IAC7D,aAAAgB;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKI,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,EAAmCH,EAAa,aAAaH,GAAoB;AAAA,MAC5F,GAAGC;AAAA,IAAA,CACJ;AAAA,EAAA,GAGGM,IAAW,YAA0E;AACzF,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKrB,EAAY;AAAA,QACf,OAAOsB,MAA2C;AAChD,gBAAMhB,EAAkBgB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAW,MAAMrB,EAAe,YAAY;AAAA,cAChD,SAAS;AAAA,gBACP,gBAAgBjB;AAAA,gBAChB,wCAAwC;AAAA,kBACtC,MAAMqC,EAAQ;AAAA,kBACd,eAAeA,EAAQ;AAAA,kBACvB,eAAeA,EAAQ;AAAA,kBACvB,aAAaA,EAAQ;AAAA,gBAAA;AAAA,cACvB;AAAA,YACF,CACD;AAED,gBAAI,CAACC,EAAS;AACZ,oBAAM,IAAIC,EAAiB,8BAA8B;AAG3D,YAAAL,IAAe,EAAE,MAAM,UAAmB,MAAMI,EAAS,sBAAA;AAAA,UAC3D,CAAC,GACDH,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMM,IAAoBC,EAAqB3B,CAAW;AAE1D,SAAIT,EAAkB,YACb,EAAE,WAAW,IAAe,eAAAmB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,aAAAjB,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,MAAMkB;AAAA,QACN,eAAeC;AAAA,QACf,eAAeC;AAAA,QACf,aAAaC;AAAA,MAAA;AAAA,MAEf,gBAAAd;AAAA,MACA,mBAAAS;AAAA,MACA,yBAAyBM,EAA8BhC,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Contractor/PaymentMethod/shared/useContractorBankAccountForm/useContractorBankAccountFormSchema.d.ts

@@ -0,0 +1,83 @@
+import { z } from 'zod';
+import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes emitted by the contractor bank account form schema.
+ * Map these codes to localized copy in `validationMessages` when composing the
+ * hook.
+ *
+ * @public
+ */
+export declare const ContractorBankAccountErrorCodes: {
+    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 contractor bank account
+ * form schema.
+ *
+ * @public
+ */
+export type ContractorBankAccountErrorCode = (typeof ContractorBankAccountErrorCodes)[keyof typeof ContractorBankAccountErrorCodes];
+/**
+ * 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 ContractorAccountType = (typeof ACCOUNT_TYPES)[number];
+/**
+ * Field names accepted by the contractor bank account form.
+ *
+ * @public
+ */
+export type ContractorBankAccountFormField = "name" | "routingNumber" | "accountNumber" | "accountType";
+/**
+ * Shape of the values managed by the contractor bank account form.
+ *
+ * @public
+ * @interface
+ */
+export type ContractorBankAccountFormData = { name: string; routingNumber: string; accountNumber: string; accountType: "Checking" | "Savings"; };
+/**
+ * Shape of the validated values produced by the contractor bank account form on
+ * submit.
+ *
+ * @public
+ */
+export type ContractorBankAccountFormOutputs = ContractorBankAccountFormData;
+/**
+ * Keys of optional contractor bank account fields that can be promoted to
+ * required via the hook's `optionalFieldsToRequire` option.
+ *
+ * @public
+ */
+export type ContractorBankAccountOptionalFieldsToRequire = { create?: never[] | undefined; update?: never[] | undefined; };
+/** @internal */
+interface ContractorBankAccountSchemaOptions {
+    optionalFieldsToRequire?: ContractorBankAccountOptionalFieldsToRequire;
+    /**
+     * The contractor's current masked account number (e.g. `"XXXX1207"`), if one
+     * is on file. The bank account API requires `account_number` on every write
+     * and treats this exact masked token as "keep the existing account number,"
+     * so the field is pre-filled with it and validation accepts it unchanged. Any
+     * other value must be a real 1–17 digit account number.
+     */
+    existingAccountNumberMask?: string;
+}
+/** @internal */
+export declare function createContractorBankAccountSchema(options?: ContractorBankAccountSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
+    accountNumber: z.ZodString;
+    name: z.ZodString;
+    routingNumber: z.ZodString;
+    accountType: z.ZodEnum<{
+        Checking: "Checking";
+        Savings: "Savings";
+    }>;
+}>;
+export {};

package/dist/components/Contractor/PaymentMethod/shared/useContractorBankAccountForm/useContractorBankAccountFormSchema.js

@@ -0,0 +1,42 @@
+import { z as e } from "zod";
+import { buildFormSchema as i } from "../../../../../partner-hook-utils/form/buildFormSchema.js";
+import { ACCOUNT_NUMBER_REGEX as N, ROUTING_NUMBER_REGEX as u } from "../../../../../helpers/validations.js";
+const r = {
+  REQUIRED: "REQUIRED",
+  INVALID_ROUTING_NUMBER: "INVALID_ROUTING_NUMBER",
+  INVALID_ACCOUNT_NUMBER: "INVALID_ACCOUNT_NUMBER"
+}, m = ["Checking", "Savings"], n = {
+  name: e.string(),
+  routingNumber: e.string().regex(u, {
+    message: r.INVALID_ROUTING_NUMBER
+  }),
+  accountNumber: e.string().regex(N, {
+    message: r.INVALID_ACCOUNT_NUMBER
+  }),
+  accountType: e.enum(m)
+}, E = {
+  name: "always",
+  routingNumber: "always",
+  accountNumber: "always",
+  accountType: "always"
+};
+function _(c = {}) {
+  const { optionalFieldsToRequire: a, existingAccountNumberMask: o } = c, s = o ? e.string().refine((t) => t === o || N.test(t), {
+    message: r.INVALID_ACCOUNT_NUMBER
+  }) : n.accountNumber;
+  return i(
+    { ...n, accountNumber: s },
+    {
+      requiredFieldsConfig: E,
+      requiredErrorCode: r.REQUIRED,
+      mode: "create",
+      optionalFieldsToRequire: a
+    }
+  );
+}
+export {
+  m as ACCOUNT_TYPES,
+  r as ContractorBankAccountErrorCodes,
+  _ as createContractorBankAccountSchema
+};
+//# sourceMappingURL=useContractorBankAccountFormSchema.js.map

package/dist/components/Contractor/PaymentMethod/shared/useContractorBankAccountForm/useContractorBankAccountFormSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useContractorBankAccountFormSchema.js","sources":["../../../../../../src/components/Contractor/PaymentMethod/shared/useContractorBankAccountForm/useContractorBankAccountFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type OptionalFieldsToRequire,\n  type RequiredFieldConfig,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { ACCOUNT_NUMBER_REGEX, ROUTING_NUMBER_REGEX } from '@/helpers/validations'\n\n/**\n * Validation error codes emitted by the contractor bank account form schema.\n * Map these codes to localized copy in `validationMessages` when composing the\n * hook.\n *\n * @public\n */\nexport const ContractorBankAccountErrorCodes = {\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 contractor bank account\n * form schema.\n *\n * @public\n */\nexport type ContractorBankAccountErrorCode =\n  (typeof ContractorBankAccountErrorCodes)[keyof typeof ContractorBankAccountErrorCodes]\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/**\n * Union of bank account type values that the form accepts.\n *\n * @public\n */\nexport type ContractorAccountType = (typeof ACCOUNT_TYPES)[number]\n\nconst fieldValidators = {\n  name: z.string(),\n  routingNumber: z.string().regex(ROUTING_NUMBER_REGEX, {\n    message: ContractorBankAccountErrorCodes.INVALID_ROUTING_NUMBER,\n  }),\n  accountNumber: z.string().regex(ACCOUNT_NUMBER_REGEX, {\n    message: ContractorBankAccountErrorCodes.INVALID_ACCOUNT_NUMBER,\n  }),\n  accountType: z.enum(ACCOUNT_TYPES),\n}\n\n/**\n * Field names accepted by the contractor bank account form.\n *\n * @public\n */\nexport type ContractorBankAccountFormField = keyof typeof fieldValidators\n\n/**\n * Shape of the values managed by the contractor bank account form.\n *\n * @public\n * @interface\n */\nexport type ContractorBankAccountFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\n/**\n * Shape of the validated values produced by the contractor bank account form on\n * submit.\n *\n * @public\n */\nexport type ContractorBankAccountFormOutputs = ContractorBankAccountFormData\n\nconst requiredFieldsConfig = {\n  name: 'always',\n  routingNumber: 'always',\n  accountNumber: 'always',\n  accountType: 'always',\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Keys of optional contractor bank account fields that can be promoted to\n * required via the hook's `optionalFieldsToRequire` option.\n *\n * @public\n */\nexport type ContractorBankAccountOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\n/** @internal */\ninterface ContractorBankAccountSchemaOptions {\n  optionalFieldsToRequire?: ContractorBankAccountOptionalFieldsToRequire\n  /**\n   * The contractor's current masked account number (e.g. `\"XXXX1207\"`), if one\n   * is on file. The bank account API requires `account_number` on every write\n   * and treats this exact masked token as \"keep the existing account number,\"\n   * so the field is pre-filled with it and validation accepts it unchanged. Any\n   * other value must be a real 1–17 digit account number.\n   */\n  existingAccountNumberMask?: string\n}\n\n/** @internal */\nexport function createContractorBankAccountSchema(\n  options: ContractorBankAccountSchemaOptions = {},\n) {\n  const { optionalFieldsToRequire, existingAccountNumberMask } = options\n\n  const accountNumber = existingAccountNumberMask\n    ? z\n        .string()\n        .refine(value => value === existingAccountNumberMask || ACCOUNT_NUMBER_REGEX.test(value), {\n          message: ContractorBankAccountErrorCodes.INVALID_ACCOUNT_NUMBER,\n        })\n    : fieldValidators.accountNumber\n\n  return buildFormSchema(\n    { ...fieldValidators, accountNumber },\n    {\n      requiredFieldsConfig,\n      requiredErrorCode: ContractorBankAccountErrorCodes.REQUIRED,\n      mode: 'create',\n      optionalFieldsToRequire,\n    },\n  )\n}\n"],"names":["ContractorBankAccountErrorCodes","ACCOUNT_TYPES","fieldValidators","z","ROUTING_NUMBER_REGEX","ACCOUNT_NUMBER_REGEX","requiredFieldsConfig","createContractorBankAccountSchema","options","optionalFieldsToRequire","existingAccountNumberMask","accountNumber","value","buildFormSchema"],"mappings":";;;AAeO,MAAMA,IAAkC;AAAA,EAC7C,UAAU;AAAA,EACV,wBAAwB;AAAA,EACxB,wBAAwB;AAC1B,GAgBaC,IAAgB,CAAC,YAAY,SAAS,GAS7CC,IAAkB;AAAA,EACtB,MAAMC,EAAE,OAAA;AAAA,EACR,eAAeA,EAAE,SAAS,MAAMC,GAAsB;AAAA,IACpD,SAASJ,EAAgC;AAAA,EAAA,CAC1C;AAAA,EACD,eAAeG,EAAE,SAAS,MAAME,GAAsB;AAAA,IACpD,SAASL,EAAgC;AAAA,EAAA,CAC1C;AAAA,EACD,aAAaG,EAAE,KAAKF,CAAa;AACnC,GA2BMK,IAAuB;AAAA,EAC3B,MAAM;AAAA,EACN,eAAe;AAAA,EACf,eAAe;AAAA,EACf,aAAa;AACf;AA0BO,SAASC,EACdC,IAA8C,IAC9C;AACA,QAAM,EAAE,yBAAAC,GAAyB,2BAAAC,EAAA,IAA8BF,GAEzDG,IAAgBD,IAClBP,EACG,OAAA,EACA,OAAO,CAAAS,MAASA,MAAUF,KAA6BL,EAAqB,KAAKO,CAAK,GAAG;AAAA,IACxF,SAASZ,EAAgC;AAAA,EAAA,CAC1C,IACHE,EAAgB;AAEpB,SAAOW;AAAA,IACL,EAAE,GAAGX,GAAiB,eAAAS,EAAA;AAAA,IACtB;AAAA,MACE,sBAAAL;AAAA,MACA,mBAAmBN,EAAgC;AAAA,MACnD,MAAM;AAAA,MACN,yBAAAS;AAAA,IAAA;AAAA,EACF;AAEJ;"}

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/contractorPaymentMethodSchema.d.ts

@@ -0,0 +1,58 @@
+import { z } from 'zod';
+/**
+ * Validation error codes emitted by the contractor payment method form schema.
+ * Map these codes to localized copy in `validationMessages` when composing the
+ * hook.
+ *
+ * @public
+ */
+export declare const ContractorPaymentMethodErrorCodes: {
+    readonly REQUIRED: "REQUIRED";
+};
+/**
+ * Union of validation error code strings emitted by the contractor payment
+ * method form schema.
+ *
+ * @public
+ */
+export type ContractorPaymentMethodErrorCode = (typeof ContractorPaymentMethodErrorCodes)[keyof typeof ContractorPaymentMethodErrorCodes];
+/**
+ * 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 ContractorPaymentMethodFormType = (typeof PAYMENT_METHOD_TYPES)[number];
+/**
+ * Field names accepted by the contractor payment method form.
+ *
+ * @public
+ */
+export type ContractorPaymentMethodFormField = "type";
+/**
+ * Shape of the values managed by the contractor payment method form.
+ *
+ * @public
+ * @interface
+ */
+export type ContractorPaymentMethodFormData = { type: "Check" | "Direct Deposit"; };
+/**
+ * Shape of the validated values produced by the contractor payment method form
+ * on submit.
+ *
+ * @public
+ */
+export type ContractorPaymentMethodFormOutputs = ContractorPaymentMethodFormData;
+/** @internal */
+export declare function createContractorPaymentMethodSchema(): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
+    type: z.ZodEnum<{
+        Check: "Check";
+        "Direct Deposit": "Direct Deposit";
+    }>;
+}>;
+export {};

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/contractorPaymentMethodSchema.js

@@ -0,0 +1,21 @@
+import { z as r } from "zod";
+import { buildFormSchema as e } from "../../../../../partner-hook-utils/form/buildFormSchema.js";
+import { PAYMENT_METHODS as o } from "../../../../../shared/constants.js";
+const t = {
+  REQUIRED: "REQUIRED"
+}, c = [o.directDeposit, o.check], d = {
+  type: r.enum(c)
+}, i = {};
+function a() {
+  return e(d, {
+    requiredFieldsConfig: i,
+    requiredErrorCode: t.REQUIRED,
+    mode: "update"
+  });
+}
+export {
+  t as ContractorPaymentMethodErrorCodes,
+  c as PAYMENT_METHOD_TYPES,
+  a as createContractorPaymentMethodSchema
+};
+//# sourceMappingURL=contractorPaymentMethodSchema.js.map

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/contractorPaymentMethodSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractorPaymentMethodSchema.js","sources":["../../../../../../src/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/contractorPaymentMethodSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\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 contractor payment method form schema.\n * Map these codes to localized copy in `validationMessages` when composing the\n * hook.\n *\n * @public\n */\nexport const ContractorPaymentMethodErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\n/**\n * Union of validation error code strings emitted by the contractor payment\n * method form schema.\n *\n * @public\n */\nexport type ContractorPaymentMethodErrorCode =\n  (typeof ContractorPaymentMethodErrorCodes)[keyof typeof ContractorPaymentMethodErrorCodes]\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 ContractorPaymentMethodFormType = (typeof PAYMENT_METHOD_TYPES)[number]\n\nconst fieldValidators = {\n  type: z.enum(PAYMENT_METHOD_TYPES),\n}\n\n/**\n * Field names accepted by the contractor payment method form.\n *\n * @public\n */\nexport type ContractorPaymentMethodFormField = keyof typeof fieldValidators\n\n/**\n * Shape of the values managed by the contractor payment method form.\n *\n * @public\n * @interface\n */\nexport type ContractorPaymentMethodFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\n/**\n * Shape of the validated values produced by the contractor payment method form\n * on submit.\n *\n * @public\n */\nexport type ContractorPaymentMethodFormOutputs = ContractorPaymentMethodFormData\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/** @internal */\nexport function createContractorPaymentMethodSchema() {\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: ContractorPaymentMethodErrorCodes.REQUIRED,\n    mode: 'update',\n  })\n}\n"],"names":["ContractorPaymentMethodErrorCodes","PAYMENT_METHOD_TYPES","PAYMENT_METHODS","fieldValidators","z","requiredFieldsConfig","createContractorPaymentMethodSchema","buildFormSchema"],"mappings":";;;AAcO,MAAMA,IAAoC;AAAA,EAC/C,UAAU;AACZ,GAgBaC,IAAuB,CAACC,EAAgB,eAAeA,EAAgB,KAAK,GASnFC,IAAkB;AAAA,EACtB,MAAMC,EAAE,KAAKH,CAAoB;AACnC,GA2BMI,IAAuB,CAAA;AAGtB,SAASC,IAAsC;AACpD,SAAOC,EAAgBJ,GAAiB;AAAA,IACtC,sBAAAE;AAAA,IACA,mBAAmBL,EAAkC;AAAA,IACrD,MAAM;AAAA,EAAA,CACP;AACH;"}

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/fields.d.ts

@@ -0,0 +1,20 @@
+import { ContractorPaymentMethodFormType } from './contractorPaymentMethodSchema';
+import { RadioGroupHookFieldProps } from '../../../../../partner-hook-utils/form/fields/RadioGroupHookField';
+import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * Props accepted by {@link useContractorPaymentMethodForm}'s `Fields.Type` component.
+ *
+ * @public
+ */
+export type TypeFieldProps = HookFieldProps<RadioGroupHookFieldProps<never, ContractorPaymentMethodFormType>>;
+/**
+ * Radio group bound to the `type` field of {@link useContractorPaymentMethodForm}.
+ *
+ * @remarks
+ * Surfaced to partners as `form.Fields.Type`; see {@link ContractorPaymentMethodFormFields}.
+ *
+ * @param props - See {@link TypeFieldProps}.
+ * @returns The rendered radio group bound to `type`.
+ * @internal
+ */
+export declare function TypeField(props: TypeFieldProps): import("react").JSX.Element;

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/fields.js

@@ -0,0 +1,9 @@
+import { jsx as r } from "react/jsx-runtime";
+import { RadioGroupHookField as e } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
+function t(o) {
+  return /* @__PURE__ */ r(e, { ...o, name: "type" });
+}
+export {
+  t as TypeField
+};
+//# sourceMappingURL=fields.js.map

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/fields.tsx"],"sourcesContent":["import type { ContractorPaymentMethodFormType } from './contractorPaymentMethodSchema'\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 * Props accepted by {@link useContractorPaymentMethodForm}'s `Fields.Type` component.\n *\n * @public\n */\nexport type TypeFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<never, ContractorPaymentMethodFormType>\n>\n\n/**\n * Radio group bound to the `type` field of {@link useContractorPaymentMethodForm}.\n *\n * @remarks\n * Surfaced to partners as `form.Fields.Type`; see {@link ContractorPaymentMethodFormFields}.\n *\n * @param props - See {@link TypeFieldProps}.\n * @returns The rendered radio group bound to `type`.\n * @internal\n */\nexport function TypeField(props: TypeFieldProps) {\n  return <RadioGroupHookField {...props} name=\"type\" />\n}\n"],"names":["TypeField","props","jsx","RadioGroupHookField"],"mappings":";;AAwBO,SAASA,EAAUC,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAqB,GAAGF,GAAO,MAAK,QAAO;AACrD;"}

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/index.d.ts

@@ -0,0 +1,5 @@
+import "./types/i18next.d.ts"
+export { useContractorPaymentMethodForm } from './useContractorPaymentMethodForm';
+export type { UseContractorPaymentMethodFormProps, UseContractorPaymentMethodFormResult, UseContractorPaymentMethodFormReady, ContractorPaymentMethodFormFields, ContractorPaymentMethodFieldsMetadata, } from './useContractorPaymentMethodForm';
+export { ContractorPaymentMethodErrorCodes, PAYMENT_METHOD_TYPES, createContractorPaymentMethodSchema, type ContractorPaymentMethodErrorCode, type ContractorPaymentMethodFormType, type ContractorPaymentMethodFormData, type ContractorPaymentMethodFormOutputs, type ContractorPaymentMethodFormField, } from './contractorPaymentMethodSchema';
+export { type TypeFieldProps } from './fields';

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/useContractorPaymentMethodForm.d.ts

@@ -0,0 +1,117 @@
+import { ComponentType } from 'react';
+import { UseFormProps } from 'react-hook-form';
+import { ContractorPaymentMethod } from '@gusto/embedded-api-v-2025-11-15/models/components/contractorpaymentmethod';
+import { ContractorPaymentMethodFormData } from './contractorPaymentMethodSchema';
+import { TypeFieldProps } from './fields';
+import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Props for {@link useContractorPaymentMethodForm}.
+ *
+ * @public
+ */
+export interface UseContractorPaymentMethodFormProps {
+    /** Contractor whose payment method is being edited. */
+    contractorId: string;
+    /** Pre-fill form values. Server data (the current payment method) is used when no override is supplied. */
+    defaultValues?: Partial<ContractorPaymentMethodFormData>;
+    /** 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 useContractorPaymentMethodForm} on `form.Fields`.
+ *
+ * @public
+ */
+export interface ContractorPaymentMethodFormFields {
+    /**
+     * Radio group bound to `type`. Selects whether the contractor is paid by
+     * Direct Deposit or Check. Supply `getOptionLabel` to translate the option
+     * labels.
+     */
+    Type: ComponentType<TypeFieldProps>;
+}
+/**
+ * Ready-state return value of {@link useContractorPaymentMethodForm}.
+ *
+ * @public
+ */
+export interface UseContractorPaymentMethodFormReady extends BaseFormHookReady<FieldsMetadata, ContractorPaymentMethodFormData, ContractorPaymentMethodFormFields> {
+    /** The contractor's current payment method, loaded from the API. */
+    data: {
+        paymentMethod: ContractorPaymentMethod;
+    };
+    /**
+     * `isPending` reflects the in-flight update mutation; `mode` is always
+     * `'update'`. `isDirectDeposit` reflects the currently selected type so a
+     * composing component can render bank fields and decide whether to submit the
+     * bank-account form.
+     */
+    status: {
+        isPending: boolean;
+        mode: 'update';
+        isDirectDeposit: boolean;
+    };
+    /** Submit the form. Returns the updated payment method on success or `undefined` on validation/mutation failure. */
+    actions: {
+        onSubmit: () => Promise<HookSubmitResult<ContractorPaymentMethod> | undefined>;
+    };
+}
+/**
+ * Headless React Hook Form hook for managing a contractor's payment method type.
+ *
+ * @remarks
+ * Owns only the payment method `type` selection (Direct Deposit or Check) and,
+ * on submit, updates the contractor's payment method via `PUT`. Always operates
+ * in update mode — every contractor has a payment method, defaulting to Check.
+ *
+ * The bank account itself is managed by the separate `useContractorBankAccountForm`
+ * hook. On the Direct Deposit path the bank-account `POST` updates the payment
+ * method as a server side-effect, so a composing component submits the bank form
+ * instead of this hook; this hook's `onSubmit` is used for the Check path.
+ * `status.isDirectDeposit` lets the component drive that branching.
+ *
+ * @param props - See {@link UseContractorPaymentMethodFormProps}.
+ * @returns A loading-state result while data loads, or a {@link UseContractorPaymentMethodFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useContractorPaymentMethodForm, SDKFormProvider } from '@gusto/embedded-react-sdk'
+ *
+ * function PaymentTypeScreen({ contractorId }: { contractorId: string }) {
+ *   const paymentMethod = useContractorPaymentMethodForm({ contractorId })
+ *
+ *   if (paymentMethod.isLoading) return null
+ *   const { Fields } = paymentMethod.form
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={paymentMethod}>
+ *       <form
+ *         onSubmit={e => {
+ *           e.preventDefault()
+ *           void paymentMethod.actions.onSubmit()
+ *         }}
+ *       >
+ *         <Fields.Type label="Select payment method" />
+ *         <button type="submit" disabled={paymentMethod.status.isPending}>Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
+export declare function useContractorPaymentMethodForm({ contractorId, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseContractorPaymentMethodFormProps): HookLoadingResult | UseContractorPaymentMethodFormReady;
+/**
+ * Return type of {@link useContractorPaymentMethodForm} — a discriminated union on `isLoading`.
+ *
+ * @public
+ */
+export type UseContractorPaymentMethodFormResult = HookLoadingResult | UseContractorPaymentMethodFormReady;
+/**
+ * Per-field metadata exposed on `form.fieldsMetadata` for {@link useContractorPaymentMethodForm}.
+ *
+ * @public
+ */
+export type ContractorPaymentMethodFieldsMetadata = UseContractorPaymentMethodFormReady['form']['fieldsMetadata'];

package/dist/components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm/useContractorPaymentMethodForm.js

@@ -0,0 +1,91 @@
+import { useMemo as l } from "react";
+import { useForm as k, useWatch as A } from "react-hook-form";
+import { zodResolver as L } from "@hookform/resolvers/zod";
+import { useContractorPaymentMethodGet as R } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorPaymentMethodGet";
+import { useContractorPaymentMethodUpdateMutation as U } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorPaymentMethodUpdate";
+import { createContractorPaymentMethodSchema as Y, PAYMENT_METHOD_TYPES as f } from "./contractorPaymentMethodSchema.js";
+import { TypeField as _ } from "./fields.js";
+import { useDeriveFieldsMetadata as q } from "../../../../../partner-hook-utils/form/useDeriveFieldsMetadata.js";
+import { useHookFormInternals as B } from "../../../../../partner-hook-utils/form/useHookFormInternals.js";
+import { createGetFormSubmissionValues as G } from "../../../../../partner-hook-utils/form/getFormSubmissionValues.js";
+import { withOptions as I } from "../../../../../partner-hook-utils/form/withOptions.js";
+import { composeErrorHandler as N } from "../../../../../partner-hook-utils/composeErrorHandler.js";
+import { useBaseSubmit as x } from "../../../../Base/useBaseSubmit.js";
+import { SDKInternalError as h } from "../../../../../types/sdkError.js";
+import { PAYMENT_METHODS as M } from "../../../../../shared/constants.js";
+function mt({
+  contractorId: a,
+  defaultValues: n,
+  validationMode: P = "onSubmit",
+  shouldFocusError: b = !0
+}) {
+  const r = R({ contractorUuid: a }), t = r.data?.contractorPaymentMethod, [s, S] = l(() => Y(), []), m = l(
+    () => ({
+      type: n?.type ?? t?.type ?? M.check
+    }),
+    [n, t]
+  ), e = k({
+    resolver: L(s),
+    mode: P,
+    shouldFocusError: b,
+    defaultValues: m,
+    values: m,
+    resetOptions: { keepDirtyValues: !0 }
+  }), w = A({ control: e.control, name: "type" }) === M.directDeposit, i = U(), E = i.isPending, {
+    baseSubmitHandler: F,
+    error: T,
+    setError: g
+  } = x("ContractorPaymentMethodForm"), d = N([r], {
+    submitError: T,
+    setSubmitError: g
+  }), D = f.map((o) => ({ value: o, label: o })), c = q(S, e.control), C = {
+    ...c,
+    type: I(c.type, D, [
+      ...f
+    ])
+  }, v = async () => {
+    if (!t)
+      throw new h("Cannot submit payment method form before data is loaded");
+    const o = t.version;
+    let u;
+    return await new Promise((p) => {
+      e.handleSubmit(
+        async (O) => {
+          await F(O, async (V) => {
+            const y = await i.mutateAsync({
+              request: {
+                contractorUuid: a,
+                requestBody: { type: V.type, version: o }
+              }
+            });
+            if (!y.contractorPaymentMethod)
+              throw new h("Payment method update failed");
+            u = { mode: "update", data: y.contractorPaymentMethod };
+          }), p();
+        },
+        () => {
+          p();
+        }
+      )();
+    }), u;
+  }, H = B(e);
+  return r.isLoading || !t ? { isLoading: !0, errorHandling: d } : {
+    isLoading: !1,
+    data: { paymentMethod: t },
+    status: { isPending: E, mode: "update", isDirectDeposit: w },
+    actions: { onSubmit: v },
+    errorHandling: d,
+    form: {
+      Fields: {
+        Type: _
+      },
+      fieldsMetadata: C,
+      hookFormInternals: H,
+      getFormSubmissionValues: G(e, s)
+    }
+  };
+}
+export {
+  mt as useContractorPaymentMethodForm
+};
+//# sourceMappingURL=useContractorPaymentMethodForm.js.map