@gusto/embedded-react-sdk 0.48.2 → 0.49.0

package/dist/components/Company/PaySchedule/shared/usePayScheduleForm/usePayScheduleForm.d.ts

@@ -5,39 +5,173 @@ import { PayScheduleOptionalFieldsToRequire, PayScheduleFormData } from './paySc
 import { CustomNameField, FrequencyField, CustomTwicePerMonthField, AnchorPayDateField, AnchorEndOfPayPeriodField, Day1Field, Day2Field } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
 export type { PayScheduleOptionalFieldsToRequire } from './payScheduleSchema';
+/**
+ * Configuration options for {@link usePayScheduleForm}.
+ *
+ * @remarks
+ * Presence or absence of `payScheduleId` selects between update and create mode.
+ *
+ * @public
+ */
 export interface UsePayScheduleFormProps {
+    /** UUID of the company that owns the pay schedule. */
     companyId: string;
+    /**
+     * When set, loads that pay schedule and updates it on submit. When omitted,
+     * the form is in create mode and creates a new schedule on submit.
+     */
     payScheduleId?: string;
+    /** Override fields that are optional on a given mode to be required. See `PayScheduleOptionalFieldsToRequire`. */
     optionalFieldsToRequire?: PayScheduleOptionalFieldsToRequire;
+    /** Pre-fill form values. Server data takes precedence on update. */
     defaultValues?: Partial<PayScheduleFormData>;
+    /** 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` so submit-time focus is coordinated across multiple forms. Defaults to `true`. */
     shouldFocusError?: boolean;
 }
+/**
+ * Pre-bound field components exposed on `usePayScheduleForm().form.Fields`.
+ *
+ * @remarks
+ * `CustomTwicePerMonth`, `Day1`, and `Day2` are conditionally `undefined` based
+ * on the selected frequency and twice-per-month strategy — always null-check them
+ * before rendering.
+ *
+ * @public
+ */
 export interface PayScheduleFields {
+    /** Display name text input. Always available. */
     CustomName: typeof CustomNameField;
+    /** Frequency selector. Always available. */
     Frequency: typeof FrequencyField;
+    /** Twice-per-month strategy radio group. Only available when frequency is `'Twice per month'`. */
     CustomTwicePerMonth: typeof CustomTwicePerMonthField | undefined;
+    /** First pay date picker. Always available. */
     AnchorPayDate: typeof AnchorPayDateField;
+    /** First pay period end date picker. Always available. */
     AnchorEndOfPayPeriod: typeof AnchorEndOfPayPeriodField;
+    /** First-pay-day-of-month number input. Available when frequency is `'Monthly'`, or `'Twice per month'` with `'custom'` strategy. */
     Day1: typeof Day1Field | undefined;
+    /** Last-pay-day-of-month number input. Available when frequency is `'Twice per month'` with `'custom'` strategy. */
     Day2: typeof Day2Field | undefined;
 }
+/**
+ * Ready-state shape returned by {@link usePayScheduleForm} once data has loaded.
+ *
+ * @remarks
+ * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with the
+ * pay-schedule-specific `data`, `status`, `actions`, and `form.Fields` shape.
+ *
+ * @public
+ */
 export interface UsePayScheduleFormReady extends BaseFormHookReady<FieldsMetadata, PayScheduleFormData, PayScheduleFields> {
+    /** Static entity data resolved from the API. */
     data: {
+        /** The pay schedule loaded for update; `null` in create mode. */
         paySchedule: PayScheduleShow | null;
+        /** Upcoming pay periods previewed from current form values; `null` until the anchor date fields are complete. */
         payPeriodPreview: PaySchedulePreviewPayPeriod[] | null;
+        /** `true` while the pay period preview request is in flight. */
         payPreviewLoading: boolean;
+        /** Business days the company needs to process payroll, derived from payment configs; `null` if unavailable. */
         paymentSpeedDays: number | null;
     };
+    /** Reactive status flags. */
     status: {
+        /** `true` while the create or update mutation is in flight. */
         isPending: boolean;
+        /** Whether the form is creating a new schedule or updating an existing one. */
         mode: 'create' | 'update';
     };
+    /** Available actions. */
     actions: {
+        /** Validates the form and dispatches the create or update mutation. Returns the saved schedule, or `undefined` if validation failed. */
         onSubmit: () => Promise<HookSubmitResult<PayScheduleShow> | undefined>;
     };
 }
+/**
+ * Form hook for creating or updating a company pay schedule.
+ *
+ * @remarks
+ * When `payScheduleId` is supplied the hook loads that schedule and issues an
+ * update on submit; when omitted it operates in create mode. While both anchor
+ * date fields are filled in, the hook fetches a live pay period calendar
+ * preview exposed on `data.payPeriodPreview`. `data.paymentSpeedDays` reflects
+ * the company's payment configuration and is useful for surfacing UI hints
+ * about how far ahead the first pay date must be.
+ *
+ * @param props - See {@link UsePayScheduleFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UsePayScheduleFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import {
+ *   usePayScheduleForm,
+ *   SDKFormProvider,
+ *   type UsePayScheduleFormReady,
+ * } from '@gusto/embedded-react-sdk'
+ *
+ * function PaySchedulePage({ companyId }: { companyId: string }) {
+ *   const paySchedule = usePayScheduleForm({ companyId })
+ *
+ *   if (paySchedule.isLoading) return <div>Loading...</div>
+ *
+ *   return <PayScheduleFormReady paySchedule={paySchedule} />
+ * }
+ *
+ * function PayScheduleFormReady({ paySchedule }: { paySchedule: UsePayScheduleFormReady }) {
+ *   const { Fields } = paySchedule.form
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={paySchedule}>
+ *       <form
+ *         onSubmit={e => {
+ *           e.preventDefault()
+ *           void paySchedule.actions.onSubmit()
+ *         }}
+ *       >
+ *         <Fields.CustomName label="Name" validationMessages={{ REQUIRED: 'Name is required' }} />
+ *         <Fields.Frequency label="Frequency" validationMessages={{ REQUIRED: 'Frequency is required' }} />
+ *         {Fields.CustomTwicePerMonth && <Fields.CustomTwicePerMonth label="Frequency Options" />}
+ *         <Fields.AnchorPayDate label="First pay date" validationMessages={{ REQUIRED: 'Required' }} />
+ *         <Fields.AnchorEndOfPayPeriod label="First pay period end" validationMessages={{ REQUIRED: 'Required' }} />
+ *         {Fields.Day1 && (
+ *           <Fields.Day1
+ *             label="First pay day of the month"
+ *             validationMessages={{ REQUIRED: 'Required', DAY_RANGE: 'Must be 1–31' }}
+ *           />
+ *         )}
+ *         {Fields.Day2 && (
+ *           <Fields.Day2
+ *             label="Last pay day of the month"
+ *             validationMessages={{ REQUIRED: 'Required', DAY_RANGE: 'Must be 1–31' }}
+ *           />
+ *         )}
+ *         <button type="submit" disabled={paySchedule.status.isPending}>Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function usePayScheduleForm({ companyId, payScheduleId, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UsePayScheduleFormProps): HookLoadingResult | UsePayScheduleFormReady;
+/**
+ * Discriminated union returned by {@link usePayScheduleForm}.
+ *
+ * @public
+ */
 export type UsePayScheduleFormResult = HookLoadingResult | UsePayScheduleFormReady;
+/**
+ * Type of `form.fieldsMetadata` returned by {@link usePayScheduleForm}.
+ *
+ * @public
+ */
 export type PayScheduleFieldsMetadata = UsePayScheduleFormReady['form']['fieldsMetadata'];
+/**
+ * Type of `form.Fields` returned by {@link usePayScheduleForm}.
+ *
+ * @public
+ */
 export type PayScheduleFormFields = UsePayScheduleFormReady['form']['Fields'];

package/dist/components/Company/PaySchedule/shared/usePayScheduleForm/usePayScheduleForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePayScheduleForm.js","sources":["../../../../../../src/components/Company/PaySchedule/shared/usePayScheduleForm/usePayScheduleForm.tsx"],"sourcesContent":["import { useEffect, useMemo } from 'react'\nimport { useForm, useWatch } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { PayScheduleShow } from '@gusto/embedded-api-v-2025-11-15/models/components/payscheduleshow'\nimport type { PaySchedulePreviewPayPeriod } from '@gusto/embedded-api-v-2025-11-15/models/components/payschedulepreviewpayperiod'\nimport { usePaySchedulesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesGet'\nimport { usePaySchedulesGetPreview } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesGetPreview'\nimport { usePaySchedulesCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesCreate'\nimport { usePaySchedulesUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesUpdate'\nimport { usePaymentConfigsGet } from '@gusto/embedded-api-v-2025-11-15/react-query/paymentConfigsGet'\nimport { RFCDate } from '@gusto/embedded-api-v-2025-11-15/types/rfcdate'\nimport {\n  createPayScheduleSchema,\n  type PayScheduleOptionalFieldsToRequire,\n  type PayScheduleFormData,\n  type PayScheduleFormOutputs,\n  type PayScheduleFrequency,\n} from './payScheduleSchema'\nimport {\n  CustomNameField,\n  FrequencyField,\n  CustomTwicePerMonthField,\n  AnchorPayDateField,\n  AnchorEndOfPayPeriodField,\n  Day1Field,\n  Day2Field,\n} 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 { parsePaymentSpeedDays } from '@/hooks/useCompanyPaymentSpeed'\nimport { formatDateToStringDate } from '@/helpers/dateFormatting'\n\nexport type { PayScheduleOptionalFieldsToRequire } from './payScheduleSchema'\n\nexport interface UsePayScheduleFormProps {\n  companyId: string\n  payScheduleId?: string\n  optionalFieldsToRequire?: PayScheduleOptionalFieldsToRequire\n  defaultValues?: Partial<PayScheduleFormData>\n  validationMode?: UseFormProps['mode']\n  shouldFocusError?: boolean\n}\n\nexport interface PayScheduleFields {\n  CustomName: typeof CustomNameField\n  Frequency: typeof FrequencyField\n  CustomTwicePerMonth: typeof CustomTwicePerMonthField | undefined\n  AnchorPayDate: typeof AnchorPayDateField\n  AnchorEndOfPayPeriod: typeof AnchorEndOfPayPeriodField\n  Day1: typeof Day1Field | undefined\n  Day2: typeof Day2Field | undefined\n}\n\nexport interface UsePayScheduleFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  PayScheduleFormData,\n  PayScheduleFields\n> {\n  data: {\n    paySchedule: PayScheduleShow | null\n    payPeriodPreview: PaySchedulePreviewPayPeriod[] | null\n    payPreviewLoading: boolean\n    paymentSpeedDays: number | null\n  }\n  status: { isPending: boolean; mode: 'create' | 'update' }\n  actions: {\n    onSubmit: () => Promise<HookSubmitResult<PayScheduleShow> | undefined>\n  }\n}\n\nconst FREQUENCY_OPTIONS: Array<{ value: PayScheduleFrequency; label: string }> = [\n  { value: 'Every week', label: 'Every week' },\n  { value: 'Every other week', label: 'Every other week' },\n  { value: 'Twice per month', label: 'Twice per month' },\n  { value: 'Monthly', label: 'Monthly' },\n]\n\nconst FREQUENCY_ENTRIES: PayScheduleFrequency[] = FREQUENCY_OPTIONS.map(o => o.value)\n\nconst TWICE_PER_MONTH_OPTIONS = [\n  { value: '1st15th', label: '15th and Last day of the month' },\n  { value: 'custom', label: 'Custom' },\n]\n\nconst TWICE_PER_MONTH_ENTRIES = TWICE_PER_MONTH_OPTIONS.map(o => o.value)\n\nfunction formatWatchedDate(value: unknown): string {\n  if (value instanceof Date) return formatDateToStringDate(value) || ''\n  if (typeof value === 'string' && value) return value\n  return ''\n}\n\nfunction deriveCustomTwicePerMonth(\n  frequency: string | undefined,\n  day1: number | undefined,\n  day2: number | undefined,\n): string {\n  if (frequency !== 'Twice per month') return ''\n  if (day1 === 15 && day2 === 31) return '1st15th'\n  return 'custom'\n}\n\nexport function usePayScheduleForm({\n  companyId,\n  payScheduleId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UsePayScheduleFormProps): HookLoadingResult | UsePayScheduleFormReady {\n  const payScheduleQuery = usePaySchedulesGet(\n    { companyId, payScheduleId: payScheduleId ?? '' },\n    { enabled: !!payScheduleId },\n  )\n\n  const paymentConfigsQuery = usePaymentConfigsGet({ companyUuid: companyId })\n\n  const currentPaySchedule = payScheduleQuery.data?.payScheduleShow ?? null\n  const paymentSpeed = paymentConfigsQuery.data?.paymentConfigs?.paymentSpeed\n  const paymentSpeedDays = parsePaymentSpeedDays(paymentSpeed)\n\n  const isCreateMode = !currentPaySchedule\n  const mode = isCreateMode ? 'create' : 'update'\n\n  const [schema, metadataConfig] = useMemo(\n    () => createPayScheduleSchema({ mode, optionalFieldsToRequire }),\n    [mode, optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: PayScheduleFormData = {\n    customName: currentPaySchedule?.customName ?? partnerDefaults?.customName ?? '',\n    frequency: (currentPaySchedule?.frequency ??\n      partnerDefaults?.frequency ??\n      'Every week') as PayScheduleFrequency,\n    customTwicePerMonth: deriveCustomTwicePerMonth(\n      currentPaySchedule?.frequency ?? partnerDefaults?.frequency,\n      currentPaySchedule?.day1 ?? partnerDefaults?.day1 ?? undefined,\n      currentPaySchedule?.day2 ?? partnerDefaults?.day2 ?? undefined,\n    ),\n    anchorPayDate:\n      currentPaySchedule?.anchorPayDate?.toString() ?? partnerDefaults?.anchorPayDate ?? null,\n    anchorEndOfPayPeriod:\n      currentPaySchedule?.anchorEndOfPayPeriod?.toString() ??\n      partnerDefaults?.anchorEndOfPayPeriod ??\n      null,\n    day1: currentPaySchedule?.day1 ?? partnerDefaults?.day1 ?? NaN,\n    day2: currentPaySchedule?.day2 ?? partnerDefaults?.day2 ?? NaN,\n  }\n\n  const formMethods = useForm<PayScheduleFormData, unknown, PayScheduleFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const watchedFrequency = useWatch({ control: formMethods.control, name: 'frequency' })\n  const watchedCustomTwicePerMonth = useWatch({\n    control: formMethods.control,\n    name: 'customTwicePerMonth',\n  })\n  const watchedAnchorPayDate = useWatch({ control: formMethods.control, name: 'anchorPayDate' })\n  const watchedAnchorEndOfPayPeriod = useWatch({\n    control: formMethods.control,\n    name: 'anchorEndOfPayPeriod',\n  })\n  const watchedDay1 = useWatch({ control: formMethods.control, name: 'day1' })\n  const watchedDay2 = useWatch({ control: formMethods.control, name: 'day2' })\n\n  useEffect(() => {\n    if (watchedFrequency === 'Twice per month' && watchedCustomTwicePerMonth === '1st15th') {\n      formMethods.setValue('day1', 15)\n      formMethods.setValue('day2', 31)\n    }\n  }, [watchedFrequency, watchedCustomTwicePerMonth, formMethods.setValue])\n\n  const formattedAnchorPayDate = formatWatchedDate(watchedAnchorPayDate)\n  const formattedAnchorEndOfPayPeriod = formatWatchedDate(watchedAnchorEndOfPayPeriod)\n\n  const previewEnabled = Boolean(formattedAnchorPayDate && formattedAnchorEndOfPayPeriod)\n\n  const previewQuery = usePaySchedulesGetPreview(\n    {\n      companyId,\n      frequency: watchedFrequency,\n      ...(formattedAnchorPayDate && { anchorPayDate: new RFCDate(formattedAnchorPayDate) }),\n      ...(formattedAnchorEndOfPayPeriod && {\n        anchorEndOfPayPeriod: new RFCDate(formattedAnchorEndOfPayPeriod),\n      }),\n      day1: watchedDay1 || undefined,\n      day2: watchedDay2 || undefined,\n    } as Parameters<typeof usePaySchedulesGetPreview>[0],\n    { enabled: previewEnabled },\n  )\n\n  const payPeriodPreview: PaySchedulePreviewPayPeriod[] | undefined =\n    previewQuery.data?.paySchedulePreview?.payPeriods\n  const payPreviewLoading = previewQuery.isLoading && previewEnabled\n\n  const createPayScheduleMutation = usePaySchedulesCreateMutation()\n  const updatePayScheduleMutation = usePaySchedulesUpdateMutation()\n\n  const isPending = createPayScheduleMutation.isPending || updatePayScheduleMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('PayScheduleForm')\n\n  const queries = payScheduleId ? [payScheduleQuery, paymentConfigsQuery] : [paymentConfigsQuery]\n  const errorHandling = composeErrorHandler(queries, { submitError, setSubmitError })\n\n  const showCustomTwicePerMonth = watchedFrequency === 'Twice per month'\n  const showDay1 =\n    watchedFrequency === 'Monthly' ||\n    (watchedFrequency === 'Twice per month' && watchedCustomTwicePerMonth === 'custom')\n  const showDay2 = watchedFrequency === 'Twice per month' && watchedCustomTwicePerMonth === 'custom'\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    customName: baseMetadata.customName,\n    frequency: withOptions<PayScheduleFrequency>(\n      baseMetadata.frequency,\n      FREQUENCY_OPTIONS,\n      FREQUENCY_ENTRIES,\n    ),\n    customTwicePerMonth: withOptions<string>(\n      baseMetadata.customTwicePerMonth,\n      TWICE_PER_MONTH_OPTIONS,\n      TWICE_PER_MONTH_ENTRIES,\n    ),\n    anchorPayDate: baseMetadata.anchorPayDate,\n    anchorEndOfPayPeriod: baseMetadata.anchorEndOfPayPeriod,\n    day1: baseMetadata.day1,\n    day2: baseMetadata.day2,\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<PayScheduleShow> | undefined> => {\n    let submitResult: HookSubmitResult<PayScheduleShow> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: PayScheduleFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const anchorPayDate = payload.anchorPayDate ?? ''\n            const anchorEndOfPayPeriod = payload.anchorEndOfPayPeriod ?? ''\n\n            if (isCreateMode) {\n              const result = await createPayScheduleMutation.mutateAsync({\n                request: {\n                  companyId,\n                  payScheduleCreateRequest: {\n                    frequency: payload.frequency,\n                    anchorPayDate: new RFCDate(anchorPayDate),\n                    anchorEndOfPayPeriod: new RFCDate(anchorEndOfPayPeriod),\n                    customName: payload.customName,\n                    day1: payload.day1 || undefined,\n                    day2: payload.day2 || undefined,\n                  },\n                },\n              })\n\n              submitResult = { mode: 'create', data: result.payScheduleShow! }\n            } else {\n              const result = await updatePayScheduleMutation.mutateAsync({\n                request: {\n                  payScheduleId: currentPaySchedule.uuid,\n                  companyId,\n                  payScheduleUpdateRequest: {\n                    frequency: payload.frequency,\n                    anchorPayDate: new RFCDate(anchorPayDate),\n                    anchorEndOfPayPeriod: new RFCDate(anchorEndOfPayPeriod),\n                    customName: payload.customName,\n                    day1: payload.day1 || undefined,\n                    day2: payload.day2 || undefined,\n                    version: currentPaySchedule.version!,\n                  },\n                },\n              })\n\n              submitResult = { mode: 'update', data: result.payScheduleShow! }\n            }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  const isDataLoading =\n    paymentConfigsQuery.isLoading || (payScheduleId ? payScheduleQuery.isLoading : false)\n\n  if (isDataLoading) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: {\n      paySchedule: currentPaySchedule,\n      payPeriodPreview: payPeriodPreview ?? null,\n      payPreviewLoading,\n      paymentSpeedDays,\n    },\n    status: {\n      isPending,\n      mode: isCreateMode ? ('create' as const) : ('update' as const),\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        CustomName: CustomNameField,\n        Frequency: FrequencyField,\n        CustomTwicePerMonth: showCustomTwicePerMonth ? CustomTwicePerMonthField : undefined,\n        AnchorPayDate: AnchorPayDateField,\n        AnchorEndOfPayPeriod: AnchorEndOfPayPeriodField,\n        Day1: showDay1 ? Day1Field : undefined,\n        Day2: showDay2 ? Day2Field : undefined,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\nexport type UsePayScheduleFormResult = HookLoadingResult | UsePayScheduleFormReady\nexport type PayScheduleFieldsMetadata = UsePayScheduleFormReady['form']['fieldsMetadata']\nexport type PayScheduleFormFields = UsePayScheduleFormReady['form']['Fields']\n"],"names":["FREQUENCY_OPTIONS","FREQUENCY_ENTRIES","o","TWICE_PER_MONTH_OPTIONS","TWICE_PER_MONTH_ENTRIES","formatWatchedDate","value","formatDateToStringDate","deriveCustomTwicePerMonth","frequency","day1","day2","usePayScheduleForm","companyId","payScheduleId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","payScheduleQuery","usePaySchedulesGet","paymentConfigsQuery","usePaymentConfigsGet","currentPaySchedule","paymentSpeed","paymentSpeedDays","parsePaymentSpeedDays","isCreateMode","mode","schema","metadataConfig","useMemo","createPayScheduleSchema","resolvedDefaults","formMethods","useForm","zodResolver","watchedFrequency","useWatch","watchedCustomTwicePerMonth","watchedAnchorPayDate","watchedAnchorEndOfPayPeriod","watchedDay1","watchedDay2","useEffect","formattedAnchorPayDate","formattedAnchorEndOfPayPeriod","previewEnabled","previewQuery","usePaySchedulesGetPreview","RFCDate","payPeriodPreview","payPreviewLoading","createPayScheduleMutation","usePaySchedulesCreateMutation","updatePayScheduleMutation","usePaySchedulesUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","showCustomTwicePerMonth","showDay1","showDay2","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","submitResult","resolve","data","payload","anchorPayDate","anchorEndOfPayPeriod","hookFormInternals","useHookFormInternals","CustomNameField","FrequencyField","CustomTwicePerMonthField","AnchorPayDateField","AnchorEndOfPayPeriodField","Day1Field","Day2Field","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;;;AAiFA,MAAMA,IAA2E;AAAA,EAC/E,EAAE,OAAO,cAAc,OAAO,aAAA;AAAA,EAC9B,EAAE,OAAO,oBAAoB,OAAO,mBAAA;AAAA,EACpC,EAAE,OAAO,mBAAmB,OAAO,kBAAA;AAAA,EACnC,EAAE,OAAO,WAAW,OAAO,UAAA;AAC7B,GAEMC,KAA4CD,EAAkB,IAAI,CAAAE,MAAKA,EAAE,KAAK,GAE9EC,IAA0B;AAAA,EAC9B,EAAE,OAAO,WAAW,OAAO,iCAAA;AAAA,EAC3B,EAAE,OAAO,UAAU,OAAO,SAAA;AAC5B,GAEMC,KAA0BD,EAAwB,IAAI,CAAAD,MAAKA,EAAE,KAAK;AAExE,SAASG,EAAkBC,GAAwB;AACjD,SAAIA,aAAiB,OAAaC,GAAuBD,CAAK,KAAK,KAC/D,OAAOA,KAAU,YAAYA,IAAcA,IACxC;AACT;AAEA,SAASE,GACPC,GACAC,GACAC,GACQ;AACR,SAAIF,MAAc,oBAA0B,KACxCC,MAAS,MAAMC,MAAS,KAAW,YAChC;AACT;AAEO,SAASC,GAAmB;AAAA,EACjC,WAAAC;AAAA,EACA,eAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAyE;AACvE,QAAMC,IAAmBC;AAAA,IACvB,EAAE,WAAAP,GAAW,eAAeC,KAAiB,GAAA;AAAA,IAC7C,EAAE,SAAS,CAAC,CAACA,EAAA;AAAA,EAAc,GAGvBO,IAAsBC,GAAqB,EAAE,aAAaT,GAAW,GAErEU,IAAqBJ,EAAiB,MAAM,mBAAmB,MAC/DK,IAAeH,EAAoB,MAAM,gBAAgB,cACzDI,IAAmBC,GAAsBF,CAAY,GAErDG,IAAe,CAACJ,GAChBK,IAAOD,IAAe,WAAW,UAEjC,CAACE,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,GAAwB,EAAE,MAAAJ,GAAM,yBAAAb,GAAyB;AAAA,IAC/D,CAACa,GAAMb,CAAuB;AAAA,EAAA,GAG1BkB,IAAwC;AAAA,IAC5C,YAAYV,GAAoB,cAAcP,GAAiB,cAAc;AAAA,IAC7E,WAAYO,GAAoB,aAC9BP,GAAiB,aACjB;AAAA,IACF,qBAAqBR;AAAA,MACnBe,GAAoB,aAAaP,GAAiB;AAAA,MAClDO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,MACrDO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,IAAA;AAAA,IAEvD,eACEO,GAAoB,eAAe,SAAA,KAAcP,GAAiB,iBAAiB;AAAA,IACrF,sBACEO,GAAoB,sBAAsB,SAAA,KAC1CP,GAAiB,wBACjB;AAAA,IACF,MAAMO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,IAC3D,MAAMO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,EAAA,GAGvDkB,IAAcC,GAA8D;AAAA,IAChF,UAAUC,GAAYP,CAAM;AAAA,IAC5B,MAAMZ;AAAA,IACN,kBAAAC;AAAA,IACA,eAAee;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAAmBC,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,aAAa,GAC/EK,IAA6BD,EAAS;AAAA,IAC1C,SAASJ,EAAY;AAAA,IACrB,MAAM;AAAA,EAAA,CACP,GACKM,IAAuBF,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,iBAAiB,GACvFO,IAA8BH,EAAS;AAAA,IAC3C,SAASJ,EAAY;AAAA,IACrB,MAAM;AAAA,EAAA,CACP,GACKQ,IAAcJ,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,QAAQ,GACrES,IAAcL,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,QAAQ;AAE3E,EAAAU,GAAU,MAAM;AACd,IAAIP,MAAqB,qBAAqBE,MAA+B,cAC3EL,EAAY,SAAS,QAAQ,EAAE,GAC/BA,EAAY,SAAS,QAAQ,EAAE;AAAA,EAEnC,GAAG,CAACG,GAAkBE,GAA4BL,EAAY,QAAQ,CAAC;AAEvE,QAAMW,IAAyBxC,EAAkBmC,CAAoB,GAC/DM,IAAgCzC,EAAkBoC,CAA2B,GAE7EM,IAAiB,GAAQF,KAA0BC,IAEnDE,IAAeC;AAAA,IACnB;AAAA,MACE,WAAApC;AAAA,MACA,WAAWwB;AAAA,MACX,GAAIQ,KAA0B,EAAE,eAAe,IAAIK,EAAQL,CAAsB,EAAA;AAAA,MACjF,GAAIC,KAAiC;AAAA,QACnC,sBAAsB,IAAII,EAAQJ,CAA6B;AAAA,MAAA;AAAA,MAEjE,MAAMJ,KAAe;AAAA,MACrB,MAAMC,KAAe;AAAA,IAAA;AAAA,IAEvB,EAAE,SAASI,EAAA;AAAA,EAAe,GAGtBI,IACJH,EAAa,MAAM,oBAAoB,YACnCI,IAAoBJ,EAAa,aAAaD,GAE9CM,IAA4BC,GAAA,GAC5BC,IAA4BC,GAAA,GAE5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,iBAAiB,GAG7BC,IAAgBC,GADNjD,IAAgB,CAACK,GAAkBE,CAAmB,IAAI,CAACA,CAAmB,GAC3C,EAAE,aAAAsC,GAAa,gBAAAC,GAAgB,GAE5EI,IAA0B3B,MAAqB,mBAC/C4B,IACJ5B,MAAqB,aACpBA,MAAqB,qBAAqBE,MAA+B,UACtE2B,IAAW7B,MAAqB,qBAAqBE,MAA+B,UAEpF4B,IAAeC,GAAwBtC,GAAgBI,EAAY,OAAO,GAC1EmC,IAAiB;AAAA,IACrB,YAAYF,EAAa;AAAA,IACzB,WAAWG;AAAA,MACTH,EAAa;AAAA,MACbnE;AAAA,MACAC;AAAA,IAAA;AAAA,IAEF,qBAAqBqE;AAAA,MACnBH,EAAa;AAAA,MACbhE;AAAA,MACAC;AAAA,IAAA;AAAA,IAEF,eAAe+D,EAAa;AAAA,IAC5B,sBAAsBA,EAAa;AAAA,IACnC,MAAMA,EAAa;AAAA,IACnB,MAAMA,EAAa;AAAA,EAAA,GAGfI,IAAW,YAAoE;AACnF,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKvC,EAAY;AAAA,QACf,OAAOwC,OAAiC;AACtC,gBAAMhB,EAAkBgB,IAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAgBD,EAAQ,iBAAiB,IACzCE,IAAuBF,EAAQ,wBAAwB;AAE7D,YAAIhD,IAeF6C,IAAe,EAAE,MAAM,UAAU,OAdlB,MAAMnB,EAA0B,YAAY;AAAA,cACzD,SAAS;AAAA,gBACP,WAAAxC;AAAA,gBACA,0BAA0B;AAAA,kBACxB,WAAW8D,EAAQ;AAAA,kBACnB,eAAe,IAAIzB,EAAQ0B,CAAa;AAAA,kBACxC,sBAAsB,IAAI1B,EAAQ2B,CAAoB;AAAA,kBACtD,YAAYF,EAAQ;AAAA,kBACpB,MAAMA,EAAQ,QAAQ;AAAA,kBACtB,MAAMA,EAAQ,QAAQ;AAAA,gBAAA;AAAA,cACxB;AAAA,YACF,CACD,GAE6C,gBAAA,IAkB9CH,IAAe,EAAE,MAAM,UAAU,OAhBlB,MAAMjB,EAA0B,YAAY;AAAA,cACzD,SAAS;AAAA,gBACP,eAAehC,EAAmB;AAAA,gBAClC,WAAAV;AAAA,gBACA,0BAA0B;AAAA,kBACxB,WAAW8D,EAAQ;AAAA,kBACnB,eAAe,IAAIzB,EAAQ0B,CAAa;AAAA,kBACxC,sBAAsB,IAAI1B,EAAQ2B,CAAoB;AAAA,kBACtD,YAAYF,EAAQ;AAAA,kBACpB,MAAMA,EAAQ,QAAQ;AAAA,kBACtB,MAAMA,EAAQ,QAAQ;AAAA,kBACtB,SAASpD,EAAmB;AAAA,gBAAA;AAAA,cAC9B;AAAA,YACF,CACD,GAE6C,gBAAA;AAAA,UAElD,CAAC,GACDkD,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMM,IAAoBC,GAAqB7C,CAAW;AAK1D,SAFEb,EAAoB,cAAcP,IAAgBK,EAAiB,YAAY,MAGxE,EAAE,WAAW,IAAe,eAAA2C,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,aAAavC;AAAA,MACb,kBAAkB4B,KAAoB;AAAA,MACtC,mBAAAC;AAAA,MACA,kBAAA3B;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACN,WAAAgC;AAAA,MACA,MAAM9B,IAAgB,WAAsB;AAAA,IAAA;AAAA,IAE9C,SAAS,EAAE,UAAA4C,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,YAAYkB;AAAA,QACZ,WAAWC;AAAA,QACX,qBAAqBjB,IAA0BkB,KAA2B;AAAA,QAC1E,eAAeC;AAAA,QACf,sBAAsBC;AAAA,QACtB,MAAMnB,IAAWoB,KAAY;AAAA,QAC7B,MAAMnB,IAAWoB,KAAY;AAAA,MAAA;AAAA,MAE/B,gBAAAjB;AAAA,MACA,mBAAAS;AAAA,MACA,yBAAyBS,GAA8BrD,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}
+{"version":3,"file":"usePayScheduleForm.js","sources":["../../../../../../src/components/Company/PaySchedule/shared/usePayScheduleForm/usePayScheduleForm.tsx"],"sourcesContent":["import { useEffect, useMemo } from 'react'\nimport { useForm, useWatch } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { PayScheduleShow } from '@gusto/embedded-api-v-2025-11-15/models/components/payscheduleshow'\nimport type { PaySchedulePreviewPayPeriod } from '@gusto/embedded-api-v-2025-11-15/models/components/payschedulepreviewpayperiod'\nimport { usePaySchedulesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesGet'\nimport { usePaySchedulesGetPreview } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesGetPreview'\nimport { usePaySchedulesCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesCreate'\nimport { usePaySchedulesUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/paySchedulesUpdate'\nimport { usePaymentConfigsGet } from '@gusto/embedded-api-v-2025-11-15/react-query/paymentConfigsGet'\nimport { RFCDate } from '@gusto/embedded-api-v-2025-11-15/types/rfcdate'\nimport {\n  createPayScheduleSchema,\n  type PayScheduleOptionalFieldsToRequire,\n  type PayScheduleFormData,\n  type PayScheduleFormOutputs,\n  type PayScheduleFrequency,\n} from './payScheduleSchema'\nimport {\n  CustomNameField,\n  FrequencyField,\n  CustomTwicePerMonthField,\n  AnchorPayDateField,\n  AnchorEndOfPayPeriodField,\n  Day1Field,\n  Day2Field,\n} 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 { parsePaymentSpeedDays } from '@/hooks/useCompanyPaymentSpeed'\nimport { formatDateToStringDate } from '@/helpers/dateFormatting'\n\nexport type { PayScheduleOptionalFieldsToRequire } from './payScheduleSchema'\n\n/**\n * Configuration options for {@link usePayScheduleForm}.\n *\n * @remarks\n * Presence or absence of `payScheduleId` selects between update and create mode.\n *\n * @public\n */\nexport interface UsePayScheduleFormProps {\n  /** UUID of the company that owns the pay schedule. */\n  companyId: string\n  /**\n   * When set, loads that pay schedule and updates it on submit. When omitted,\n   * the form is in create mode and creates a new schedule on submit.\n   */\n  payScheduleId?: string\n  /** Override fields that are optional on a given mode to be required. See `PayScheduleOptionalFieldsToRequire`. */\n  optionalFieldsToRequire?: PayScheduleOptionalFieldsToRequire\n  /** Pre-fill form values. Server data takes precedence on update. */\n  defaultValues?: Partial<PayScheduleFormData>\n  /** 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` so submit-time focus is coordinated across multiple forms. Defaults to `true`. */\n  shouldFocusError?: boolean\n}\n\n/**\n * Pre-bound field components exposed on `usePayScheduleForm().form.Fields`.\n *\n * @remarks\n * `CustomTwicePerMonth`, `Day1`, and `Day2` are conditionally `undefined` based\n * on the selected frequency and twice-per-month strategy — always null-check them\n * before rendering.\n *\n * @public\n */\nexport interface PayScheduleFields {\n  /** Display name text input. Always available. */\n  CustomName: typeof CustomNameField\n  /** Frequency selector. Always available. */\n  Frequency: typeof FrequencyField\n  /** Twice-per-month strategy radio group. Only available when frequency is `'Twice per month'`. */\n  CustomTwicePerMonth: typeof CustomTwicePerMonthField | undefined\n  /** First pay date picker. Always available. */\n  AnchorPayDate: typeof AnchorPayDateField\n  /** First pay period end date picker. Always available. */\n  AnchorEndOfPayPeriod: typeof AnchorEndOfPayPeriodField\n  /** First-pay-day-of-month number input. Available when frequency is `'Monthly'`, or `'Twice per month'` with `'custom'` strategy. */\n  Day1: typeof Day1Field | undefined\n  /** Last-pay-day-of-month number input. Available when frequency is `'Twice per month'` with `'custom'` strategy. */\n  Day2: typeof Day2Field | undefined\n}\n\n/**\n * Ready-state shape returned by {@link usePayScheduleForm} once data has loaded.\n *\n * @remarks\n * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with the\n * pay-schedule-specific `data`, `status`, `actions`, and `form.Fields` shape.\n *\n * @public\n */\nexport interface UsePayScheduleFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  PayScheduleFormData,\n  PayScheduleFields\n> {\n  /** Static entity data resolved from the API. */\n  data: {\n    /** The pay schedule loaded for update; `null` in create mode. */\n    paySchedule: PayScheduleShow | null\n    /** Upcoming pay periods previewed from current form values; `null` until the anchor date fields are complete. */\n    payPeriodPreview: PaySchedulePreviewPayPeriod[] | null\n    /** `true` while the pay period preview request is in flight. */\n    payPreviewLoading: boolean\n    /** Business days the company needs to process payroll, derived from payment configs; `null` if unavailable. */\n    paymentSpeedDays: number | null\n  }\n  /** Reactive status flags. */\n  status: {\n    /** `true` while the create or update mutation is in flight. */\n    isPending: boolean\n    /** Whether the form is creating a new schedule or updating an existing one. */\n    mode: 'create' | 'update'\n  }\n  /** Available actions. */\n  actions: {\n    /** Validates the form and dispatches the create or update mutation. Returns the saved schedule, or `undefined` if validation failed. */\n    onSubmit: () => Promise<HookSubmitResult<PayScheduleShow> | undefined>\n  }\n}\n\nconst FREQUENCY_OPTIONS: Array<{ value: PayScheduleFrequency; label: string }> = [\n  { value: 'Every week', label: 'Every week' },\n  { value: 'Every other week', label: 'Every other week' },\n  { value: 'Twice per month', label: 'Twice per month' },\n  { value: 'Monthly', label: 'Monthly' },\n]\n\nconst FREQUENCY_ENTRIES: PayScheduleFrequency[] = FREQUENCY_OPTIONS.map(o => o.value)\n\nconst TWICE_PER_MONTH_OPTIONS = [\n  { value: '1st15th', label: '15th and Last day of the month' },\n  { value: 'custom', label: 'Custom' },\n]\n\nconst TWICE_PER_MONTH_ENTRIES = TWICE_PER_MONTH_OPTIONS.map(o => o.value)\n\nfunction formatWatchedDate(value: unknown): string {\n  if (value instanceof Date) return formatDateToStringDate(value) || ''\n  if (typeof value === 'string' && value) return value\n  return ''\n}\n\nfunction deriveCustomTwicePerMonth(\n  frequency: string | undefined,\n  day1: number | undefined,\n  day2: number | undefined,\n): string {\n  if (frequency !== 'Twice per month') return ''\n  if (day1 === 15 && day2 === 31) return '1st15th'\n  return 'custom'\n}\n\n/**\n * Form hook for creating or updating a company pay schedule.\n *\n * @remarks\n * When `payScheduleId` is supplied the hook loads that schedule and issues an\n * update on submit; when omitted it operates in create mode. While both anchor\n * date fields are filled in, the hook fetches a live pay period calendar\n * preview exposed on `data.payPeriodPreview`. `data.paymentSpeedDays` reflects\n * the company's payment configuration and is useful for surfacing UI hints\n * about how far ahead the first pay date must be.\n *\n * @param props - See {@link UsePayScheduleFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UsePayScheduleFormReady} once ready.\n * @public\n *\n * @example\n * ```tsx\n * import {\n *   usePayScheduleForm,\n *   SDKFormProvider,\n *   type UsePayScheduleFormReady,\n * } from '@gusto/embedded-react-sdk'\n *\n * function PaySchedulePage({ companyId }: { companyId: string }) {\n *   const paySchedule = usePayScheduleForm({ companyId })\n *\n *   if (paySchedule.isLoading) return <div>Loading...</div>\n *\n *   return <PayScheduleFormReady paySchedule={paySchedule} />\n * }\n *\n * function PayScheduleFormReady({ paySchedule }: { paySchedule: UsePayScheduleFormReady }) {\n *   const { Fields } = paySchedule.form\n *\n *   return (\n *     <SDKFormProvider formHookResult={paySchedule}>\n *       <form\n *         onSubmit={e => {\n *           e.preventDefault()\n *           void paySchedule.actions.onSubmit()\n *         }}\n *       >\n *         <Fields.CustomName label=\"Name\" validationMessages={{ REQUIRED: 'Name is required' }} />\n *         <Fields.Frequency label=\"Frequency\" validationMessages={{ REQUIRED: 'Frequency is required' }} />\n *         {Fields.CustomTwicePerMonth && <Fields.CustomTwicePerMonth label=\"Frequency Options\" />}\n *         <Fields.AnchorPayDate label=\"First pay date\" validationMessages={{ REQUIRED: 'Required' }} />\n *         <Fields.AnchorEndOfPayPeriod label=\"First pay period end\" validationMessages={{ REQUIRED: 'Required' }} />\n *         {Fields.Day1 && (\n *           <Fields.Day1\n *             label=\"First pay day of the month\"\n *             validationMessages={{ REQUIRED: 'Required', DAY_RANGE: 'Must be 1–31' }}\n *           />\n *         )}\n *         {Fields.Day2 && (\n *           <Fields.Day2\n *             label=\"Last pay day of the month\"\n *             validationMessages={{ REQUIRED: 'Required', DAY_RANGE: 'Must be 1–31' }}\n *           />\n *         )}\n *         <button type=\"submit\" disabled={paySchedule.status.isPending}>Save</button>\n *       </form>\n *     </SDKFormProvider>\n *   )\n * }\n * ```\n */\nexport function usePayScheduleForm({\n  companyId,\n  payScheduleId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UsePayScheduleFormProps): HookLoadingResult | UsePayScheduleFormReady {\n  const payScheduleQuery = usePaySchedulesGet(\n    { companyId, payScheduleId: payScheduleId ?? '' },\n    { enabled: !!payScheduleId },\n  )\n\n  const paymentConfigsQuery = usePaymentConfigsGet({ companyUuid: companyId })\n\n  const currentPaySchedule = payScheduleQuery.data?.payScheduleShow ?? null\n  const paymentSpeed = paymentConfigsQuery.data?.paymentConfigs?.paymentSpeed\n  const paymentSpeedDays = parsePaymentSpeedDays(paymentSpeed)\n\n  const isCreateMode = !currentPaySchedule\n  const mode = isCreateMode ? 'create' : 'update'\n\n  const [schema, metadataConfig] = useMemo(\n    () => createPayScheduleSchema({ mode, optionalFieldsToRequire }),\n    [mode, optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: PayScheduleFormData = {\n    customName: currentPaySchedule?.customName ?? partnerDefaults?.customName ?? '',\n    frequency: (currentPaySchedule?.frequency ??\n      partnerDefaults?.frequency ??\n      'Every week') as PayScheduleFrequency,\n    customTwicePerMonth: deriveCustomTwicePerMonth(\n      currentPaySchedule?.frequency ?? partnerDefaults?.frequency,\n      currentPaySchedule?.day1 ?? partnerDefaults?.day1 ?? undefined,\n      currentPaySchedule?.day2 ?? partnerDefaults?.day2 ?? undefined,\n    ),\n    anchorPayDate:\n      currentPaySchedule?.anchorPayDate?.toString() ?? partnerDefaults?.anchorPayDate ?? null,\n    anchorEndOfPayPeriod:\n      currentPaySchedule?.anchorEndOfPayPeriod?.toString() ??\n      partnerDefaults?.anchorEndOfPayPeriod ??\n      null,\n    day1: currentPaySchedule?.day1 ?? partnerDefaults?.day1 ?? NaN,\n    day2: currentPaySchedule?.day2 ?? partnerDefaults?.day2 ?? NaN,\n  }\n\n  const formMethods = useForm<PayScheduleFormData, unknown, PayScheduleFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const watchedFrequency = useWatch({ control: formMethods.control, name: 'frequency' })\n  const watchedCustomTwicePerMonth = useWatch({\n    control: formMethods.control,\n    name: 'customTwicePerMonth',\n  })\n  const watchedAnchorPayDate = useWatch({ control: formMethods.control, name: 'anchorPayDate' })\n  const watchedAnchorEndOfPayPeriod = useWatch({\n    control: formMethods.control,\n    name: 'anchorEndOfPayPeriod',\n  })\n  const watchedDay1 = useWatch({ control: formMethods.control, name: 'day1' })\n  const watchedDay2 = useWatch({ control: formMethods.control, name: 'day2' })\n\n  useEffect(() => {\n    if (watchedFrequency === 'Twice per month' && watchedCustomTwicePerMonth === '1st15th') {\n      formMethods.setValue('day1', 15)\n      formMethods.setValue('day2', 31)\n    }\n  }, [watchedFrequency, watchedCustomTwicePerMonth, formMethods.setValue])\n\n  const formattedAnchorPayDate = formatWatchedDate(watchedAnchorPayDate)\n  const formattedAnchorEndOfPayPeriod = formatWatchedDate(watchedAnchorEndOfPayPeriod)\n\n  const previewEnabled = Boolean(formattedAnchorPayDate && formattedAnchorEndOfPayPeriod)\n\n  const previewQuery = usePaySchedulesGetPreview(\n    {\n      companyId,\n      frequency: watchedFrequency,\n      ...(formattedAnchorPayDate && { anchorPayDate: new RFCDate(formattedAnchorPayDate) }),\n      ...(formattedAnchorEndOfPayPeriod && {\n        anchorEndOfPayPeriod: new RFCDate(formattedAnchorEndOfPayPeriod),\n      }),\n      day1: watchedDay1 || undefined,\n      day2: watchedDay2 || undefined,\n    } as Parameters<typeof usePaySchedulesGetPreview>[0],\n    { enabled: previewEnabled },\n  )\n\n  const payPeriodPreview: PaySchedulePreviewPayPeriod[] | undefined =\n    previewQuery.data?.paySchedulePreview?.payPeriods\n  const payPreviewLoading = previewQuery.isLoading && previewEnabled\n\n  const createPayScheduleMutation = usePaySchedulesCreateMutation()\n  const updatePayScheduleMutation = usePaySchedulesUpdateMutation()\n\n  const isPending = createPayScheduleMutation.isPending || updatePayScheduleMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('PayScheduleForm')\n\n  const queries = payScheduleId ? [payScheduleQuery, paymentConfigsQuery] : [paymentConfigsQuery]\n  const errorHandling = composeErrorHandler(queries, { submitError, setSubmitError })\n\n  const showCustomTwicePerMonth = watchedFrequency === 'Twice per month'\n  const showDay1 =\n    watchedFrequency === 'Monthly' ||\n    (watchedFrequency === 'Twice per month' && watchedCustomTwicePerMonth === 'custom')\n  const showDay2 = watchedFrequency === 'Twice per month' && watchedCustomTwicePerMonth === 'custom'\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    customName: baseMetadata.customName,\n    frequency: withOptions<PayScheduleFrequency>(\n      baseMetadata.frequency,\n      FREQUENCY_OPTIONS,\n      FREQUENCY_ENTRIES,\n    ),\n    customTwicePerMonth: withOptions<string>(\n      baseMetadata.customTwicePerMonth,\n      TWICE_PER_MONTH_OPTIONS,\n      TWICE_PER_MONTH_ENTRIES,\n    ),\n    anchorPayDate: baseMetadata.anchorPayDate,\n    anchorEndOfPayPeriod: baseMetadata.anchorEndOfPayPeriod,\n    day1: baseMetadata.day1,\n    day2: baseMetadata.day2,\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<PayScheduleShow> | undefined> => {\n    let submitResult: HookSubmitResult<PayScheduleShow> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: PayScheduleFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const anchorPayDate = payload.anchorPayDate ?? ''\n            const anchorEndOfPayPeriod = payload.anchorEndOfPayPeriod ?? ''\n\n            if (isCreateMode) {\n              const result = await createPayScheduleMutation.mutateAsync({\n                request: {\n                  companyId,\n                  payScheduleCreateRequest: {\n                    frequency: payload.frequency,\n                    anchorPayDate: new RFCDate(anchorPayDate),\n                    anchorEndOfPayPeriod: new RFCDate(anchorEndOfPayPeriod),\n                    customName: payload.customName,\n                    day1: payload.day1 || undefined,\n                    day2: payload.day2 || undefined,\n                  },\n                },\n              })\n\n              submitResult = { mode: 'create', data: result.payScheduleShow! }\n            } else {\n              const result = await updatePayScheduleMutation.mutateAsync({\n                request: {\n                  payScheduleId: currentPaySchedule.uuid,\n                  companyId,\n                  payScheduleUpdateRequest: {\n                    frequency: payload.frequency,\n                    anchorPayDate: new RFCDate(anchorPayDate),\n                    anchorEndOfPayPeriod: new RFCDate(anchorEndOfPayPeriod),\n                    customName: payload.customName,\n                    day1: payload.day1 || undefined,\n                    day2: payload.day2 || undefined,\n                    version: currentPaySchedule.version!,\n                  },\n                },\n              })\n\n              submitResult = { mode: 'update', data: result.payScheduleShow! }\n            }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  const isDataLoading =\n    paymentConfigsQuery.isLoading || (payScheduleId ? payScheduleQuery.isLoading : false)\n\n  if (isDataLoading) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: {\n      paySchedule: currentPaySchedule,\n      payPeriodPreview: payPeriodPreview ?? null,\n      payPreviewLoading,\n      paymentSpeedDays,\n    },\n    status: {\n      isPending,\n      mode: isCreateMode ? ('create' as const) : ('update' as const),\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        CustomName: CustomNameField,\n        Frequency: FrequencyField,\n        CustomTwicePerMonth: showCustomTwicePerMonth ? CustomTwicePerMonthField : undefined,\n        AnchorPayDate: AnchorPayDateField,\n        AnchorEndOfPayPeriod: AnchorEndOfPayPeriodField,\n        Day1: showDay1 ? Day1Field : undefined,\n        Day2: showDay2 ? Day2Field : undefined,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Discriminated union returned by {@link usePayScheduleForm}.\n *\n * @public\n */\nexport type UsePayScheduleFormResult = HookLoadingResult | UsePayScheduleFormReady\n/**\n * Type of `form.fieldsMetadata` returned by {@link usePayScheduleForm}.\n *\n * @public\n */\nexport type PayScheduleFieldsMetadata = UsePayScheduleFormReady['form']['fieldsMetadata']\n/**\n * Type of `form.Fields` returned by {@link usePayScheduleForm}.\n *\n * @public\n */\nexport type PayScheduleFormFields = UsePayScheduleFormReady['form']['Fields']\n"],"names":["FREQUENCY_OPTIONS","FREQUENCY_ENTRIES","o","TWICE_PER_MONTH_OPTIONS","TWICE_PER_MONTH_ENTRIES","formatWatchedDate","value","formatDateToStringDate","deriveCustomTwicePerMonth","frequency","day1","day2","usePayScheduleForm","companyId","payScheduleId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","payScheduleQuery","usePaySchedulesGet","paymentConfigsQuery","usePaymentConfigsGet","currentPaySchedule","paymentSpeed","paymentSpeedDays","parsePaymentSpeedDays","isCreateMode","mode","schema","metadataConfig","useMemo","createPayScheduleSchema","resolvedDefaults","formMethods","useForm","zodResolver","watchedFrequency","useWatch","watchedCustomTwicePerMonth","watchedAnchorPayDate","watchedAnchorEndOfPayPeriod","watchedDay1","watchedDay2","useEffect","formattedAnchorPayDate","formattedAnchorEndOfPayPeriod","previewEnabled","previewQuery","usePaySchedulesGetPreview","RFCDate","payPeriodPreview","payPreviewLoading","createPayScheduleMutation","usePaySchedulesCreateMutation","updatePayScheduleMutation","usePaySchedulesUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","showCustomTwicePerMonth","showDay1","showDay2","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","submitResult","resolve","data","payload","anchorPayDate","anchorEndOfPayPeriod","hookFormInternals","useHookFormInternals","CustomNameField","FrequencyField","CustomTwicePerMonthField","AnchorPayDateField","AnchorEndOfPayPeriodField","Day1Field","Day2Field","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;;;AAyIA,MAAMA,IAA2E;AAAA,EAC/E,EAAE,OAAO,cAAc,OAAO,aAAA;AAAA,EAC9B,EAAE,OAAO,oBAAoB,OAAO,mBAAA;AAAA,EACpC,EAAE,OAAO,mBAAmB,OAAO,kBAAA;AAAA,EACnC,EAAE,OAAO,WAAW,OAAO,UAAA;AAC7B,GAEMC,KAA4CD,EAAkB,IAAI,CAAAE,MAAKA,EAAE,KAAK,GAE9EC,IAA0B;AAAA,EAC9B,EAAE,OAAO,WAAW,OAAO,iCAAA;AAAA,EAC3B,EAAE,OAAO,UAAU,OAAO,SAAA;AAC5B,GAEMC,KAA0BD,EAAwB,IAAI,CAAAD,MAAKA,EAAE,KAAK;AAExE,SAASG,EAAkBC,GAAwB;AACjD,SAAIA,aAAiB,OAAaC,GAAuBD,CAAK,KAAK,KAC/D,OAAOA,KAAU,YAAYA,IAAcA,IACxC;AACT;AAEA,SAASE,GACPC,GACAC,GACAC,GACQ;AACR,SAAIF,MAAc,oBAA0B,KACxCC,MAAS,MAAMC,MAAS,KAAW,YAChC;AACT;AAoEO,SAASC,GAAmB;AAAA,EACjC,WAAAC;AAAA,EACA,eAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAyE;AACvE,QAAMC,IAAmBC;AAAA,IACvB,EAAE,WAAAP,GAAW,eAAeC,KAAiB,GAAA;AAAA,IAC7C,EAAE,SAAS,CAAC,CAACA,EAAA;AAAA,EAAc,GAGvBO,IAAsBC,GAAqB,EAAE,aAAaT,GAAW,GAErEU,IAAqBJ,EAAiB,MAAM,mBAAmB,MAC/DK,IAAeH,EAAoB,MAAM,gBAAgB,cACzDI,IAAmBC,GAAsBF,CAAY,GAErDG,IAAe,CAACJ,GAChBK,IAAOD,IAAe,WAAW,UAEjC,CAACE,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,GAAwB,EAAE,MAAAJ,GAAM,yBAAAb,GAAyB;AAAA,IAC/D,CAACa,GAAMb,CAAuB;AAAA,EAAA,GAG1BkB,IAAwC;AAAA,IAC5C,YAAYV,GAAoB,cAAcP,GAAiB,cAAc;AAAA,IAC7E,WAAYO,GAAoB,aAC9BP,GAAiB,aACjB;AAAA,IACF,qBAAqBR;AAAA,MACnBe,GAAoB,aAAaP,GAAiB;AAAA,MAClDO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,MACrDO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,IAAA;AAAA,IAEvD,eACEO,GAAoB,eAAe,SAAA,KAAcP,GAAiB,iBAAiB;AAAA,IACrF,sBACEO,GAAoB,sBAAsB,SAAA,KAC1CP,GAAiB,wBACjB;AAAA,IACF,MAAMO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,IAC3D,MAAMO,GAAoB,QAAQP,GAAiB,QAAQ;AAAA,EAAA,GAGvDkB,IAAcC,GAA8D;AAAA,IAChF,UAAUC,GAAYP,CAAM;AAAA,IAC5B,MAAMZ;AAAA,IACN,kBAAAC;AAAA,IACA,eAAee;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAAmBC,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,aAAa,GAC/EK,IAA6BD,EAAS;AAAA,IAC1C,SAASJ,EAAY;AAAA,IACrB,MAAM;AAAA,EAAA,CACP,GACKM,IAAuBF,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,iBAAiB,GACvFO,IAA8BH,EAAS;AAAA,IAC3C,SAASJ,EAAY;AAAA,IACrB,MAAM;AAAA,EAAA,CACP,GACKQ,IAAcJ,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,QAAQ,GACrES,IAAcL,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,QAAQ;AAE3E,EAAAU,GAAU,MAAM;AACd,IAAIP,MAAqB,qBAAqBE,MAA+B,cAC3EL,EAAY,SAAS,QAAQ,EAAE,GAC/BA,EAAY,SAAS,QAAQ,EAAE;AAAA,EAEnC,GAAG,CAACG,GAAkBE,GAA4BL,EAAY,QAAQ,CAAC;AAEvE,QAAMW,IAAyBxC,EAAkBmC,CAAoB,GAC/DM,IAAgCzC,EAAkBoC,CAA2B,GAE7EM,IAAiB,GAAQF,KAA0BC,IAEnDE,IAAeC;AAAA,IACnB;AAAA,MACE,WAAApC;AAAA,MACA,WAAWwB;AAAA,MACX,GAAIQ,KAA0B,EAAE,eAAe,IAAIK,EAAQL,CAAsB,EAAA;AAAA,MACjF,GAAIC,KAAiC;AAAA,QACnC,sBAAsB,IAAII,EAAQJ,CAA6B;AAAA,MAAA;AAAA,MAEjE,MAAMJ,KAAe;AAAA,MACrB,MAAMC,KAAe;AAAA,IAAA;AAAA,IAEvB,EAAE,SAASI,EAAA;AAAA,EAAe,GAGtBI,IACJH,EAAa,MAAM,oBAAoB,YACnCI,IAAoBJ,EAAa,aAAaD,GAE9CM,IAA4BC,GAAA,GAC5BC,IAA4BC,GAAA,GAE5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,iBAAiB,GAG7BC,IAAgBC,GADNjD,IAAgB,CAACK,GAAkBE,CAAmB,IAAI,CAACA,CAAmB,GAC3C,EAAE,aAAAsC,GAAa,gBAAAC,GAAgB,GAE5EI,IAA0B3B,MAAqB,mBAC/C4B,IACJ5B,MAAqB,aACpBA,MAAqB,qBAAqBE,MAA+B,UACtE2B,IAAW7B,MAAqB,qBAAqBE,MAA+B,UAEpF4B,IAAeC,GAAwBtC,GAAgBI,EAAY,OAAO,GAC1EmC,IAAiB;AAAA,IACrB,YAAYF,EAAa;AAAA,IACzB,WAAWG;AAAA,MACTH,EAAa;AAAA,MACbnE;AAAA,MACAC;AAAA,IAAA;AAAA,IAEF,qBAAqBqE;AAAA,MACnBH,EAAa;AAAA,MACbhE;AAAA,MACAC;AAAA,IAAA;AAAA,IAEF,eAAe+D,EAAa;AAAA,IAC5B,sBAAsBA,EAAa;AAAA,IACnC,MAAMA,EAAa;AAAA,IACnB,MAAMA,EAAa;AAAA,EAAA,GAGfI,IAAW,YAAoE;AACnF,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKvC,EAAY;AAAA,QACf,OAAOwC,OAAiC;AACtC,gBAAMhB,EAAkBgB,IAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAgBD,EAAQ,iBAAiB,IACzCE,IAAuBF,EAAQ,wBAAwB;AAE7D,YAAIhD,IAeF6C,IAAe,EAAE,MAAM,UAAU,OAdlB,MAAMnB,EAA0B,YAAY;AAAA,cACzD,SAAS;AAAA,gBACP,WAAAxC;AAAA,gBACA,0BAA0B;AAAA,kBACxB,WAAW8D,EAAQ;AAAA,kBACnB,eAAe,IAAIzB,EAAQ0B,CAAa;AAAA,kBACxC,sBAAsB,IAAI1B,EAAQ2B,CAAoB;AAAA,kBACtD,YAAYF,EAAQ;AAAA,kBACpB,MAAMA,EAAQ,QAAQ;AAAA,kBACtB,MAAMA,EAAQ,QAAQ;AAAA,gBAAA;AAAA,cACxB;AAAA,YACF,CACD,GAE6C,gBAAA,IAkB9CH,IAAe,EAAE,MAAM,UAAU,OAhBlB,MAAMjB,EAA0B,YAAY;AAAA,cACzD,SAAS;AAAA,gBACP,eAAehC,EAAmB;AAAA,gBAClC,WAAAV;AAAA,gBACA,0BAA0B;AAAA,kBACxB,WAAW8D,EAAQ;AAAA,kBACnB,eAAe,IAAIzB,EAAQ0B,CAAa;AAAA,kBACxC,sBAAsB,IAAI1B,EAAQ2B,CAAoB;AAAA,kBACtD,YAAYF,EAAQ;AAAA,kBACpB,MAAMA,EAAQ,QAAQ;AAAA,kBACtB,MAAMA,EAAQ,QAAQ;AAAA,kBACtB,SAASpD,EAAmB;AAAA,gBAAA;AAAA,cAC9B;AAAA,YACF,CACD,GAE6C,gBAAA;AAAA,UAElD,CAAC,GACDkD,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMM,IAAoBC,GAAqB7C,CAAW;AAK1D,SAFEb,EAAoB,cAAcP,IAAgBK,EAAiB,YAAY,MAGxE,EAAE,WAAW,IAAe,eAAA2C,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,aAAavC;AAAA,MACb,kBAAkB4B,KAAoB;AAAA,MACtC,mBAAAC;AAAA,MACA,kBAAA3B;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACN,WAAAgC;AAAA,MACA,MAAM9B,IAAgB,WAAsB;AAAA,IAAA;AAAA,IAE9C,SAAS,EAAE,UAAA4C,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,YAAYkB;AAAA,QACZ,WAAWC;AAAA,QACX,qBAAqBjB,IAA0BkB,KAA2B;AAAA,QAC1E,eAAeC;AAAA,QACf,sBAAsBC;AAAA,QACtB,MAAMnB,IAAWoB,KAAY;AAAA,QAC7B,MAAMnB,IAAWoB,KAAY;AAAA,MAAA;AAAA,MAE/B,gBAAAjB;AAAA,MACA,mBAAAS;AAAA,MACA,yBAAyBS,GAA8BrD,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Company/StateTaxes/StateTaxes.d.ts

@@ -1,5 +1,31 @@
 import { BaseComponentInterface } from '../../Base';
+/**
+ * Props for the {@link StateTaxes} flow.
+ *
+ * @public
+ */
 export interface StateTaxesProps extends BaseComponentInterface<'Company.StateTaxes'> {
+    /** UUID of the company whose state taxes are being managed. */
     companyId: string;
 }
+/**
+ * Orchestrated flow for managing a company's state tax setup.
+ *
+ * @remarks
+ * Switches internally between a list of states with tax requirements and a per-state edit form.
+ * For finer-grained control over navigation, use the standalone {@link StateTaxesList} and
+ * {@link StateTaxesForm} building blocks directly.
+ *
+ * @events
+ * | Event | Description | Data |
+ * | ----- | ----------- | ---- |
+ * | `company/stateTaxes/edit` | A state row was selected for editing | `{ state: string }` |
+ * | `company/stateTaxes/updated` | State tax requirements were saved | — |
+ * | `company/stateTaxes/done` | The list view was completed | — |
+ * | `CANCEL` | Editing was cancelled and the form was closed | — |
+ *
+ * @param props - {@link StateTaxesProps}
+ * @returns The rendered state taxes flow.
+ * @public
+ */
 export declare function StateTaxes({ companyId, onEvent, dictionary }: StateTaxesProps): import("react").JSX.Element;

package/dist/components/Company/StateTaxes/StateTaxes.js.map

@@ -1 +1 @@
-{"version":3,"file":"StateTaxes.js","sources":["../../../../src/components/Company/StateTaxes/StateTaxes.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { stateTaxesStateMachine } from './stateTaxesStateMachine'\nimport type { StateTaxesContextInterface } from './StateTaxesComponents'\nimport { StateTaxesListContextual } from './StateTaxesComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport { useComponentDictionary } from '@/i18n/I18n'\n\nexport interface StateTaxesProps extends BaseComponentInterface<'Company.StateTaxes'> {\n  companyId: string\n}\n\nexport function StateTaxes({ companyId, onEvent, dictionary }: StateTaxesProps) {\n  useComponentDictionary('Company.StateTaxes', dictionary)\n  const manageStateTaxes = useMemo(\n    () =>\n      createMachine(\n        'viewStateTaxes',\n        stateTaxesStateMachine,\n        (initialContext: StateTaxesContextInterface) => ({\n          ...initialContext,\n          component: StateTaxesListContextual,\n          companyId,\n        }),\n      ),\n    [companyId],\n  )\n  return <Flow machine={manageStateTaxes} onEvent={onEvent} />\n}\n"],"names":["StateTaxes","companyId","onEvent","dictionary","useComponentDictionary","manageStateTaxes","useMemo","createMachine","stateTaxesStateMachine","initialContext","StateTaxesListContextual","jsx","Flow"],"mappings":";;;;;;;AAaO,SAASA,EAAW,EAAE,WAAAC,GAAW,SAAAC,GAAS,YAAAC,KAA+B;AAC9E,EAAAC,EAAuB,sBAAsBD,CAAU;AACvD,QAAME,IAAmBC;AAAA,IACvB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAgD;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAT;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACA,CAAS;AAAA,EAAA;AAEZ,SAAO,gBAAAU,EAACC,GAAA,EAAK,SAASP,GAAkB,SAAAH,EAAA,CAAkB;AAC5D;"}
+{"version":3,"file":"StateTaxes.js","sources":["../../../../src/components/Company/StateTaxes/StateTaxes.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { stateTaxesStateMachine } from './stateTaxesStateMachine'\nimport type { StateTaxesContextInterface } from './StateTaxesComponents'\nimport { StateTaxesListContextual } from './StateTaxesComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport { useComponentDictionary } from '@/i18n/I18n'\n\n/**\n * Props for the {@link StateTaxes} flow.\n *\n * @public\n */\nexport interface StateTaxesProps extends BaseComponentInterface<'Company.StateTaxes'> {\n  /** UUID of the company whose state taxes are being managed. */\n  companyId: string\n}\n\n/**\n * Orchestrated flow for managing a company's state tax setup.\n *\n * @remarks\n * Switches internally between a list of states with tax requirements and a per-state edit form.\n * For finer-grained control over navigation, use the standalone {@link StateTaxesList} and\n * {@link StateTaxesForm} building blocks directly.\n *\n * @events\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `company/stateTaxes/edit` | A state row was selected for editing | `{ state: string }` |\n * | `company/stateTaxes/updated` | State tax requirements were saved | — |\n * | `company/stateTaxes/done` | The list view was completed | — |\n * | `CANCEL` | Editing was cancelled and the form was closed | — |\n *\n * @param props - {@link StateTaxesProps}\n * @returns The rendered state taxes flow.\n * @public\n */\nexport function StateTaxes({ companyId, onEvent, dictionary }: StateTaxesProps) {\n  useComponentDictionary('Company.StateTaxes', dictionary)\n  const manageStateTaxes = useMemo(\n    () =>\n      createMachine(\n        'viewStateTaxes',\n        stateTaxesStateMachine,\n        (initialContext: StateTaxesContextInterface) => ({\n          ...initialContext,\n          component: StateTaxesListContextual,\n          companyId,\n        }),\n      ),\n    [companyId],\n  )\n  return <Flow machine={manageStateTaxes} onEvent={onEvent} />\n}\n"],"names":["StateTaxes","companyId","onEvent","dictionary","useComponentDictionary","manageStateTaxes","useMemo","createMachine","stateTaxesStateMachine","initialContext","StateTaxesListContextual","jsx","Flow"],"mappings":";;;;;;;AAuCO,SAASA,EAAW,EAAE,WAAAC,GAAW,SAAAC,GAAS,YAAAC,KAA+B;AAC9E,EAAAC,EAAuB,sBAAsBD,CAAU;AACvD,QAAME,IAAmBC;AAAA,IACvB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAgD;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAT;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACA,CAAS;AAAA,EAAA;AAEZ,SAAO,gBAAAU,EAACC,GAAA,EAAK,SAASP,GAAkB,SAAAH,EAAA,CAAkB;AAC5D;"}

package/dist/components/Company/StateTaxes/StateTaxesComponents.d.ts

@@ -1,8 +1,14 @@
 import { FlowContextInterface } from '../../Flow/useFlow';
+/** @internal */
 export interface StateTaxesContextInterface extends FlowContextInterface {
+    /** UUID of the company whose state taxes are being managed. */
     companyId: string;
+    /** Two-letter state code currently being edited, when in the form view. */
     state?: string;
+    /** Current step component rendered by the flow machine. */
     component: React.ComponentType | null;
 }
+/** @internal */
 export declare function StateTaxesListContextual(): import("react").JSX.Element;
+/** @internal */
 export declare function StateTaxesFormContextual(): import("react").JSX.Element;

package/dist/components/Company/StateTaxes/StateTaxesComponents.js.map

@@ -1 +1 @@
-{"version":3,"file":"StateTaxesComponents.js","sources":["../../../../src/components/Company/StateTaxes/StateTaxesComponents.tsx"],"sourcesContent":["import { StateTaxesList } from './StateTaxesList/StateTaxesList'\nimport { StateTaxesForm } from './StateTaxesForm/StateTaxesForm'\nimport { useFlow, type FlowContextInterface } from '@/components/Flow/useFlow'\nimport { ensureRequired } from '@/helpers/ensureRequired'\n\nexport interface StateTaxesContextInterface extends FlowContextInterface {\n  companyId: string\n  state?: string\n  component: React.ComponentType | null\n}\n\nexport function StateTaxesListContextual() {\n  const { companyId, onEvent } = useFlow<StateTaxesContextInterface>()\n  return <StateTaxesList onEvent={onEvent} companyId={ensureRequired(companyId)} />\n}\n\nexport function StateTaxesFormContextual() {\n  const { companyId, state, onEvent } = useFlow<StateTaxesContextInterface>()\n  return (\n    <StateTaxesForm\n      companyId={ensureRequired(companyId)}\n      state={ensureRequired(state)}\n      onEvent={onEvent}\n    />\n  )\n}\n"],"names":["StateTaxesListContextual","companyId","onEvent","useFlow","StateTaxesList","ensureRequired","StateTaxesFormContextual","state","jsx","StateTaxesForm"],"mappings":";;;;;AAWO,SAASA,IAA2B;AACzC,QAAM,EAAE,WAAAC,GAAW,SAAAC,EAAA,IAAYC,EAAA;AAC/B,2BAAQC,GAAA,EAAe,SAAAF,GAAkB,WAAWG,EAAeJ,CAAS,GAAG;AACjF;AAEO,SAASK,IAA2B;AACzC,QAAM,EAAE,WAAAL,GAAW,OAAAM,GAAO,SAAAL,EAAA,IAAYC,EAAA;AACtC,SACE,gBAAAK;AAAA,IAACC;AAAA,IAAA;AAAA,MACC,WAAWJ,EAAeJ,CAAS;AAAA,MACnC,OAAOI,EAAeE,CAAK;AAAA,MAC3B,SAAAL;AAAA,IAAA;AAAA,EAAA;AAGN;"}
+{"version":3,"file":"StateTaxesComponents.js","sources":["../../../../src/components/Company/StateTaxes/StateTaxesComponents.tsx"],"sourcesContent":["import { StateTaxesList } from './StateTaxesList/StateTaxesList'\nimport { StateTaxesForm } from './StateTaxesForm/StateTaxesForm'\nimport { useFlow, type FlowContextInterface } from '@/components/Flow/useFlow'\nimport { ensureRequired } from '@/helpers/ensureRequired'\n\n/** @internal */\nexport interface StateTaxesContextInterface extends FlowContextInterface {\n  /** UUID of the company whose state taxes are being managed. */\n  companyId: string\n  /** Two-letter state code currently being edited, when in the form view. */\n  state?: string\n  /** Current step component rendered by the flow machine. */\n  component: React.ComponentType | null\n}\n\n/** @internal */\nexport function StateTaxesListContextual() {\n  const { companyId, onEvent } = useFlow<StateTaxesContextInterface>()\n  return <StateTaxesList onEvent={onEvent} companyId={ensureRequired(companyId)} />\n}\n\n/** @internal */\nexport function StateTaxesFormContextual() {\n  const { companyId, state, onEvent } = useFlow<StateTaxesContextInterface>()\n  return (\n    <StateTaxesForm\n      companyId={ensureRequired(companyId)}\n      state={ensureRequired(state)}\n      onEvent={onEvent}\n    />\n  )\n}\n"],"names":["StateTaxesListContextual","companyId","onEvent","useFlow","StateTaxesList","ensureRequired","StateTaxesFormContextual","state","jsx","StateTaxesForm"],"mappings":";;;;;AAgBO,SAASA,IAA2B;AACzC,QAAM,EAAE,WAAAC,GAAW,SAAAC,EAAA,IAAYC,EAAA;AAC/B,2BAAQC,GAAA,EAAe,SAAAF,GAAkB,WAAWG,EAAeJ,CAAS,GAAG;AACjF;AAGO,SAASK,IAA2B;AACzC,QAAM,EAAE,WAAAL,GAAW,OAAAM,GAAO,SAAAL,EAAA,IAAYC,EAAA;AACtC,SACE,gBAAAK;AAAA,IAACC;AAAA,IAAA;AAAA,MACC,WAAWJ,EAAeJ,CAAS;AAAA,MACnC,OAAOI,EAAeE,CAAK;AAAA,MAC3B,SAAAL;AAAA,IAAA;AAAA,EAAA;AAGN;"}

package/dist/components/Company/StateTaxes/StateTaxesForm/Actions.d.ts

@@ -1 +1,2 @@
+/** @internal */
 export declare function Actions(): import("react").JSX.Element;

package/dist/components/Company/StateTaxes/StateTaxesForm/Actions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Actions.js","sources":["../../../../../src/components/Company/StateTaxes/StateTaxesForm/Actions.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { useStateTaxesForm } from './context'\nimport { ActionsLayout } from '@/components/Common'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\nexport function Actions() {\n  const { t } = useTranslation('Company.StateTaxes', { keyPrefix: 'form' })\n  const { handleCancel, isPending } = useStateTaxesForm()\n  const Components = useComponentContext()\n\n  return (\n    <ActionsLayout>\n      <Components.Button variant=\"secondary\" onClick={handleCancel}>\n        {t('cancelCta')}\n      </Components.Button>\n      <Components.Button variant=\"primary\" type=\"submit\" isDisabled={isPending}>\n        {t('saveCta')}\n      </Components.Button>\n    </ActionsLayout>\n  )\n}\n"],"names":["Actions","useTranslation","handleCancel","isPending","useStateTaxesForm","Components","useComponentContext","ActionsLayout","jsx"],"mappings":";;;;;;AAKO,SAASA,IAAU;AACxB,QAAM,EAAE,MAAMC,EAAe,sBAAsB,EAAE,WAAW,QAAQ,GAClE,EAAE,cAAAC,GAAc,WAAAC,EAAA,IAAcC,EAAA,GAC9BC,IAAaC,EAAA;AAEnB,2BACGC,GAAA,EACC,UAAA;AAAA,IAAA,gBAAAC,EAACH,EAAW,QAAX,EAAkB,SAAQ,aAAY,SAASH,GAC7C,UAAA,EAAE,WAAW,EAAA,CAChB;AAAA,IACA,gBAAAM,EAACH,EAAW,QAAX,EAAkB,SAAQ,WAAU,MAAK,UAAS,YAAYF,GAC5D,UAAA,EAAE,SAAS,EAAA,CACd;AAAA,EAAA,GACF;AAEJ;"}
+{"version":3,"file":"Actions.js","sources":["../../../../../src/components/Company/StateTaxes/StateTaxesForm/Actions.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { useStateTaxesForm } from './context'\nimport { ActionsLayout } from '@/components/Common'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\n/** @internal */\nexport function Actions() {\n  const { t } = useTranslation('Company.StateTaxes', { keyPrefix: 'form' })\n  const { handleCancel, isPending } = useStateTaxesForm()\n  const Components = useComponentContext()\n\n  return (\n    <ActionsLayout>\n      <Components.Button variant=\"secondary\" onClick={handleCancel}>\n        {t('cancelCta')}\n      </Components.Button>\n      <Components.Button variant=\"primary\" type=\"submit\" isDisabled={isPending}>\n        {t('saveCta')}\n      </Components.Button>\n    </ActionsLayout>\n  )\n}\n"],"names":["Actions","useTranslation","handleCancel","isPending","useStateTaxesForm","Components","useComponentContext","ActionsLayout","jsx"],"mappings":";;;;;;AAMO,SAASA,IAAU;AACxB,QAAM,EAAE,MAAMC,EAAe,sBAAsB,EAAE,WAAW,QAAQ,GAClE,EAAE,cAAAC,GAAc,WAAAC,EAAA,IAAcC,EAAA,GAC9BC,IAAaC,EAAA;AAEnB,2BACGC,GAAA,EACC,UAAA;AAAA,IAAA,gBAAAC,EAACH,EAAW,QAAX,EAAkB,SAAQ,aAAY,SAASH,GAC7C,UAAA,EAAE,WAAW,EAAA,CAChB;AAAA,IACA,gBAAAM,EAACH,EAAW,QAAX,EAAkB,SAAQ,WAAU,MAAK,UAAS,YAAYF,GAC5D,UAAA,EAAE,SAAS,EAAA,CACd;AAAA,EAAA,GACF;AAEJ;"}

package/dist/components/Company/StateTaxes/StateTaxesForm/Form.d.ts

@@ -1,4 +1,2 @@
-import { z } from 'zod';
-export declare const StateFormSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-export type StateFormInputs = z.infer<typeof StateFormSchema>;
+/** @internal */
 export declare function Form(): import("react").JSX.Element[] | undefined;

package/dist/components/Company/StateTaxes/StateTaxesForm/Form.js

@@ -1,35 +1,37 @@
-import { jsxs as a, Fragment as d, jsx as o } from "react/jsx-runtime";
-import { z as t } from "zod";
-import { useTranslation as u } from "react-i18next";
-import { useStateTaxesForm as x } from "./context.js";
-import { toRhfKey as l } from "./rhfKey.js";
-import { QuestionInput as y } from "../../../Common/TaxInputs/TaxInputs.js";
-import { useLocaleDateFormatter as T } from "../../../../contexts/LocaleProvider/useLocale.js";
-import { useComponentContext as h } from "../../../../contexts/ComponentAdapter/useComponentContext.js";
-t.record(t.string(), t.record(t.string(), t.unknown()));
-function D() {
-  const { t: s } = u("Company.StateTaxes", { keyPrefix: "form" }), i = T(), { stateTaxRequirements: p } = x(), r = h();
-  return p.requirementSets?.map(
-    ({ requirements: f, label: c, effectiveFrom: n, key: m }) => /* @__PURE__ */ a(d, { children: [
-      /* @__PURE__ */ a("div", { children: [
-        /* @__PURE__ */ o(r.Heading, { as: "h3", children: c }),
-        n && /* @__PURE__ */ o(r.Text, { size: "sm", children: s("effectiveFromLabel", { date: i.format(new Date(n)) }) })
+import { jsxs as m, Fragment as u, jsx as o } from "react/jsx-runtime";
+import { useTranslation as d } from "react-i18next";
+import { useFormContext as x, useWatch as h } from "react-hook-form";
+import { useStateTaxesForm as T } from "./context.js";
+import { toRhfKey as F } from "./rhfKey.js";
+import { isRequirementApplicable as y } from "./applicableIf.js";
+import { QuestionInput as C } from "../../../Common/TaxInputs/TaxInputs.js";
+import { useLocaleDateFormatter as b } from "../../../../contexts/LocaleProvider/useLocale.js";
+import { useComponentContext as R } from "../../../../contexts/ComponentAdapter/useComponentContext.js";
+function z() {
+  const { t: n } = d("Company.StateTaxes", { keyPrefix: "form" }), s = b(), { stateTaxRequirements: i } = T(), r = R(), { control: p } = x(), f = h({ control: p });
+  return i.requirementSets?.map(
+    ({ requirements: c, label: l, effectiveFrom: a, key: e }) => /* @__PURE__ */ m(u, { children: [
+      /* @__PURE__ */ m("div", { children: [
+        /* @__PURE__ */ o(r.Heading, { as: "h3", children: l }),
+        a && /* @__PURE__ */ o(r.Text, { size: "sm", children: n("effectiveFromLabel", { date: s.format(new Date(a)) }) })
       ] }),
-      f?.map((e) => /* @__PURE__ */ o(
-        y,
-        {
-          requirement: {
-            ...e,
-            key: `${m}.${l(e.key)}`
+      c?.flatMap((t) => t.editable === !1 ? [] : !e || !y(t, e, f) ? [] : [
+        /* @__PURE__ */ o(
+          C,
+          {
+            requirement: {
+              ...t,
+              key: `${e}.${F(t.key)}`
+            },
+            questionType: t.metadata?.type ?? "Text"
           },
-          questionType: e.metadata?.type ?? "Text"
-        },
-        e.key
-      ))
-    ] }, m)
+          t.key
+        )
+      ])
+    ] }, e)
   );
 }
 export {
-  D as Form
+  z as Form
 };
 //# sourceMappingURL=Form.js.map

package/dist/components/Company/StateTaxes/StateTaxesForm/Form.js.map

@@ -1 +1 @@
-{"version":3,"file":"Form.js","sources":["../../../../../src/components/Company/StateTaxes/StateTaxesForm/Form.tsx"],"sourcesContent":["import { z } from 'zod'\nimport { useTranslation } from 'react-i18next'\nimport { Fragment } from 'react/jsx-runtime'\nimport { useStateTaxesForm } from './context'\nimport { toRhfKey } from './rhfKey'\nimport { QuestionInput } from '@/components/Common/TaxInputs/TaxInputs'\nimport { useLocaleDateFormatter } from '@/contexts/LocaleProvider/useLocale'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\nexport const StateFormSchema = z.record(z.string(), z.record(z.string(), z.unknown()))\n\nexport type StateFormInputs = z.infer<typeof StateFormSchema>\n\nexport function Form() {\n  const { t } = useTranslation('Company.StateTaxes', { keyPrefix: 'form' })\n  const dateFormatter = useLocaleDateFormatter()\n  const { stateTaxRequirements } = useStateTaxesForm()\n  const Components = useComponentContext()\n\n  return stateTaxRequirements.requirementSets?.map(\n    ({ requirements, label, effectiveFrom, key }) => (\n      <Fragment key={key}>\n        <div>\n          <Components.Heading as=\"h3\">{label}</Components.Heading>\n          {effectiveFrom && (\n            <Components.Text size=\"sm\">\n              {t('effectiveFromLabel', { date: dateFormatter.format(new Date(effectiveFrom)) })}\n            </Components.Text>\n          )}\n        </div>\n        {requirements?.map(requirement => {\n          return (\n            <QuestionInput\n              requirement={{\n                ...requirement,\n                key: `${key}.${toRhfKey(requirement.key as string)}`,\n              }}\n              questionType={requirement.metadata?.type ?? 'Text'}\n              key={requirement.key}\n            />\n          )\n        })}\n      </Fragment>\n    ),\n  )\n}\n"],"names":["z","Form","t","useTranslation","dateFormatter","useLocaleDateFormatter","stateTaxRequirements","useStateTaxesForm","Components","useComponentContext","requirements","label","effectiveFrom","key","Fragment","jsxs","jsx","requirement","QuestionInput","toRhfKey"],"mappings":";;;;;;;;AAS+BA,EAAE,OAAOA,EAAE,UAAUA,EAAE,OAAOA,EAAE,OAAA,GAAUA,EAAE,QAAA,CAAS,CAAC;AAI9E,SAASC,IAAO;AACrB,QAAM,EAAE,GAAAC,MAAMC,EAAe,sBAAsB,EAAE,WAAW,QAAQ,GAClEC,IAAgBC,EAAA,GAChB,EAAE,sBAAAC,EAAA,IAAyBC,EAAA,GAC3BC,IAAaC,EAAA;AAEnB,SAAOH,EAAqB,iBAAiB;AAAA,IAC3C,CAAC,EAAE,cAAAI,GAAc,OAAAC,GAAO,eAAAC,GAAe,KAAAC,EAAA,wBACpCC,GAAA,EACC,UAAA;AAAA,MAAA,gBAAAC,EAAC,OAAA,EACC,UAAA;AAAA,QAAA,gBAAAC,EAACR,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAG,GAAM;AAAA,QAClCC,KACC,gBAAAI,EAACR,EAAW,MAAX,EAAgB,MAAK,MACnB,UAAAN,EAAE,sBAAsB,EAAE,MAAME,EAAc,OAAO,IAAI,KAAKQ,CAAa,CAAC,EAAA,CAAG,EAAA,CAClF;AAAA,MAAA,GAEJ;AAAA,MACCF,GAAc,IAAI,CAAAO,MAEf,gBAAAD;AAAA,QAACE;AAAA,QAAA;AAAA,UACC,aAAa;AAAA,YACX,GAAGD;AAAA,YACH,KAAK,GAAGJ,CAAG,IAAIM,EAASF,EAAY,GAAa,CAAC;AAAA,UAAA;AAAA,UAEpD,cAAcA,EAAY,UAAU,QAAQ;AAAA,QAAA;AAAA,QACvCA,EAAY;AAAA,MAAA,CAGtB;AAAA,IAAA,EAAA,GApBYJ,CAqBf;AAAA,EAAA;AAGN;"}
+{"version":3,"file":"Form.js","sources":["../../../../../src/components/Company/StateTaxes/StateTaxesForm/Form.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { Fragment } from 'react/jsx-runtime'\nimport { useFormContext, useWatch } from 'react-hook-form'\nimport { useStateTaxesForm } from './context'\nimport { toRhfKey } from './rhfKey'\nimport { isRequirementApplicable, type StateTaxesFormValues } from './applicableIf'\nimport { QuestionInput } from '@/components/Common/TaxInputs/TaxInputs'\nimport { useLocaleDateFormatter } from '@/contexts/LocaleProvider/useLocale'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\n/** @internal */\nexport function Form() {\n  const { t } = useTranslation('Company.StateTaxes', { keyPrefix: 'form' })\n  const dateFormatter = useLocaleDateFormatter()\n  const { stateTaxRequirements } = useStateTaxesForm()\n  const Components = useComponentContext()\n  const { control } = useFormContext()\n  const watchedValues = useWatch({ control }) as StateTaxesFormValues\n\n  return stateTaxRequirements.requirementSets?.map(\n    ({ requirements, label, effectiveFrom, key }) => (\n      <Fragment key={key}>\n        <div>\n          <Components.Heading as=\"h3\">{label}</Components.Heading>\n          {effectiveFrom && (\n            <Components.Text size=\"sm\">\n              {t('effectiveFromLabel', { date: dateFormatter.format(new Date(effectiveFrom)) })}\n            </Components.Text>\n          )}\n        </div>\n        {requirements?.flatMap(requirement => {\n          if (requirement.editable === false) return []\n          if (!key || !isRequirementApplicable(requirement, key, watchedValues)) return []\n          return [\n            <QuestionInput\n              requirement={{\n                ...requirement,\n                key: `${key}.${toRhfKey(requirement.key as string)}`,\n              }}\n              questionType={requirement.metadata?.type ?? 'Text'}\n              key={requirement.key}\n            />,\n          ]\n        })}\n      </Fragment>\n    ),\n  )\n}\n"],"names":["Form","t","useTranslation","dateFormatter","useLocaleDateFormatter","stateTaxRequirements","useStateTaxesForm","Components","useComponentContext","control","useFormContext","watchedValues","useWatch","requirements","label","effectiveFrom","key","Fragment","jsxs","jsx","requirement","isRequirementApplicable","QuestionInput","toRhfKey"],"mappings":";;;;;;;;;AAWO,SAASA,IAAO;AACrB,QAAM,EAAE,GAAAC,MAAMC,EAAe,sBAAsB,EAAE,WAAW,QAAQ,GAClEC,IAAgBC,EAAA,GAChB,EAAE,sBAAAC,EAAA,IAAyBC,EAAA,GAC3BC,IAAaC,EAAA,GACb,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAgBC,EAAS,EAAE,SAAAH,GAAS;AAE1C,SAAOJ,EAAqB,iBAAiB;AAAA,IAC3C,CAAC,EAAE,cAAAQ,GAAc,OAAAC,GAAO,eAAAC,GAAe,KAAAC,EAAA,wBACpCC,GAAA,EACC,UAAA;AAAA,MAAA,gBAAAC,EAAC,OAAA,EACC,UAAA;AAAA,QAAA,gBAAAC,EAACZ,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAO,GAAM;AAAA,QAClCC,KACC,gBAAAI,EAACZ,EAAW,MAAX,EAAgB,MAAK,MACnB,UAAAN,EAAE,sBAAsB,EAAE,MAAME,EAAc,OAAO,IAAI,KAAKY,CAAa,CAAC,EAAA,CAAG,EAAA,CAClF;AAAA,MAAA,GAEJ;AAAA,MACCF,GAAc,QAAQ,CAAAO,MACjBA,EAAY,aAAa,KAAc,CAAA,IACvC,CAACJ,KAAO,CAACK,EAAwBD,GAAaJ,GAAKL,CAAa,IAAU,CAAA,IACvE;AAAA,QACL,gBAAAQ;AAAA,UAACG;AAAA,UAAA;AAAA,YACC,aAAa;AAAA,cACX,GAAGF;AAAA,cACH,KAAK,GAAGJ,CAAG,IAAIO,EAASH,EAAY,GAAa,CAAC;AAAA,YAAA;AAAA,YAEpD,cAAcA,EAAY,UAAU,QAAQ;AAAA,UAAA;AAAA,UACvCA,EAAY;AAAA,QAAA;AAAA,MACnB,CAEH;AAAA,IAAA,EAAA,GAtBYJ,CAuBf;AAAA,EAAA;AAGN;"}

package/dist/components/Company/StateTaxes/StateTaxesForm/Head.d.ts

@@ -1 +1,2 @@
+/** @internal */
 export declare function Head(): import("react").JSX.Element;

package/dist/components/Company/StateTaxes/StateTaxesForm/Head.js.map

@@ -1 +1 @@
-{"version":3,"file":"Head.js","sources":["../../../../../src/components/Company/StateTaxes/StateTaxesForm/Head.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { useStateTaxesForm } from './context'\nimport type { STATES_ABBR } from '@/shared/constants'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\nexport function Head() {\n  const { t } = useTranslation('Company.StateTaxes', { keyPrefix: 'form' })\n  const { t: statesHash } = useTranslation('common', { keyPrefix: 'statesHash' })\n  const Components = useComponentContext()\n\n  const { state } = useStateTaxesForm()\n\n  return (\n    <header>\n      <Components.Heading as=\"h2\">\n        {t('title', { state: statesHash(state as (typeof STATES_ABBR)[number]) })}\n      </Components.Heading>\n    </header>\n  )\n}\n"],"names":["Head","t","useTranslation","statesHash","Components","useComponentContext","state","useStateTaxesForm","jsx"],"mappings":";;;;AAKO,SAASA,IAAO;AACrB,QAAM,EAAE,GAAAC,MAAMC,EAAe,sBAAsB,EAAE,WAAW,QAAQ,GAClE,EAAE,GAAGC,MAAeD,EAAe,UAAU,EAAE,WAAW,cAAc,GACxEE,IAAaC,EAAA,GAEb,EAAE,OAAAC,EAAA,IAAUC,EAAA;AAElB,2BACG,UAAA,EACC,UAAA,gBAAAC,EAACJ,EAAW,SAAX,EAAmB,IAAG,MACpB,UAAAH,EAAE,SAAS,EAAE,OAAOE,EAAWG,CAAqC,EAAA,CAAG,GAC1E,GACF;AAEJ;"}
+{"version":3,"file":"Head.js","sources":["../../../../../src/components/Company/StateTaxes/StateTaxesForm/Head.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { useStateTaxesForm } from './context'\nimport type { STATES_ABBR } from '@/shared/constants'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\n/** @internal */\nexport function Head() {\n  const { t } = useTranslation('Company.StateTaxes', { keyPrefix: 'form' })\n  const { t: statesHash } = useTranslation('common', { keyPrefix: 'statesHash' })\n  const Components = useComponentContext()\n\n  const { state } = useStateTaxesForm()\n\n  return (\n    <header>\n      <Components.Heading as=\"h2\">\n        {t('title', { state: statesHash(state as (typeof STATES_ABBR)[number]) })}\n      </Components.Heading>\n    </header>\n  )\n}\n"],"names":["Head","t","useTranslation","statesHash","Components","useComponentContext","state","useStateTaxesForm","jsx"],"mappings":";;;;AAMO,SAASA,IAAO;AACrB,QAAM,EAAE,GAAAC,MAAMC,EAAe,sBAAsB,EAAE,WAAW,QAAQ,GAClE,EAAE,GAAGC,MAAeD,EAAe,UAAU,EAAE,WAAW,cAAc,GACxEE,IAAaC,EAAA,GAEb,EAAE,OAAAC,EAAA,IAAUC,EAAA;AAElB,2BACG,UAAA,EACC,UAAA,gBAAAC,EAACJ,EAAW,SAAX,EAAmB,IAAG,MACpB,UAAAH,EAAE,SAAS,EAAE,OAAOE,EAAWG,CAAqC,EAAA,CAAG,GAC1E,GACF;AAEJ;"}

package/dist/components/Company/StateTaxes/StateTaxesForm/StateTaxesForm.d.ts

@@ -1,7 +1,45 @@
-import { BaseComponentInterface, CommonComponentInterface } from '../../../Base/Base';
-interface StateTaxesFormProps extends CommonComponentInterface {
+import { BaseComponentInterface } from '../../../Base/Base';
+/**
+ * Props for {@link StateTaxesForm}.
+ *
+ * @public
+ */
+export interface StateTaxesFormProps extends BaseComponentInterface<'Company.StateTaxes'> {
+    /** The associated company identifier. */
     companyId: string;
+    /** Two-letter code of the state whose tax requirements are edited. */
     state: string;
 }
-export declare function StateTaxesForm(props: StateTaxesFormProps & BaseComponentInterface): import("react").JSX.Element;
-export {};
+/**
+ * Standalone form for editing a company's state tax requirements for a single state.
+ *
+ * @remarks
+ * Lower-level building block used by {@link StateTaxes} for its edit view. Use directly when
+ * you need full control over navigation between the list and edit views.
+ *
+ * @events
+ * | Event | Description | Data |
+ * | ----- | ----------- | ---- |
+ * | `company/stateTaxes/updated` | State tax requirements were saved successfully | Response from the update state tax requirements API |
+ * | `CANCEL` | The user cancelled editing | — |
+ *
+ * @param props - {@link StateTaxesFormProps}
+ * @returns The rendered state taxes edit form.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { CompanyOnboarding } from '@gusto/embedded-react-sdk'
+ *
+ * function MyComponent() {
+ *   return (
+ *     <CompanyOnboarding.StateTaxesForm
+ *       companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365"
+ *       state="CA"
+ *       onEvent={() => {}}
+ *     />
+ *   )
+ * }
+ * ```
+ */
+export declare function StateTaxesForm(props: StateTaxesFormProps): import("react").JSX.Element;