@gusto/embedded-react-sdk 0.47.1 → 0.48.0

package/dist/components/Employee/Profile/shared/useEmployeeDetailsForm/useEmployeeDetailsForm.d.ts

@@ -4,18 +4,52 @@ import { EmployeeDetailsOptionalFieldsToRequire, EmployeeDetailsFormData } from
 import { FirstNameField, MiddleInitialField, LastNameField, EmailField, DateOfBirthField, SsnField, SelfOnboardingField } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
 export type { EmployeeDetailsOptionalFieldsToRequire } from './employeeDetailsSchema';
+/**
+ * Optional callbacks passed to {@link UseEmployeeDetailsFormReady.actions.onSubmit | onSubmit}.
+ *
+ * @remarks
+ * Only the callback matching the submit mode fires —
+ * `onEmployeeCreated` on create, `onEmployeeUpdated` on update.
+ * `onOnboardingStatusUpdated` fires when toggling the self-onboarding
+ * switch changes the employee's onboarding status as part of an update.
+ *
+ * @public
+ */
 export interface EmployeeDetailsSubmitCallbacks {
+    /** Fired after a new employee is successfully created. */
     onEmployeeCreated?: (employee: Employee) => void;
+    /** Fired after an existing employee is successfully updated. */
     onEmployeeUpdated?: (employee: Employee) => void;
+    /** Fired when an update toggles self-onboarding and the employee's onboarding status changes. */
     onOnboardingStatusUpdated?: (status: unknown) => void;
 }
-type UseEmployeeDetailsFormSharedProps = {
+/**
+ * Shared options merged into both branches of {@link UseEmployeeDetailsFormProps}.
+ *
+ * @public
+ */
+export type UseEmployeeDetailsFormSharedProps = {
+    /** Whether to expose the self-onboarding toggle as `form.Fields.SelfOnboarding`. Defaults to `true`. */
     withSelfOnboardingField?: boolean;
+    /** Fields that are optional by default but should be promoted to required for this form instance. */
     optionalFieldsToRequire?: EmployeeDetailsOptionalFieldsToRequire;
+    /** Initial values applied before any employee data loads. */
     defaultValues?: Partial<EmployeeDetailsFormData>;
+    /** When validation runs. Forwarded to react-hook-form's `mode`. Defaults to `'onSubmit'`. */
     validationMode?: UseFormProps['mode'];
+    /** Whether react-hook-form should focus the first error on validation failure. Defaults to `true`. */
     shouldFocusError?: boolean;
 };
+/**
+ * Options for {@link useEmployeeDetailsForm}.
+ *
+ * @remarks
+ * Discriminated by mode: in create mode supply `companyId` and omit
+ * `employeeId`; in update mode supply `employeeId` (and optionally
+ * `companyId`).
+ *
+ * @public
+ */
 export type UseEmployeeDetailsFormProps = (UseEmployeeDetailsFormSharedProps & {
     companyId: string;
     employeeId?: never;
@@ -23,28 +57,133 @@ export type UseEmployeeDetailsFormProps = (UseEmployeeDetailsFormSharedProps & {
     employeeId: string;
     companyId?: string;
 });
+/**
+ * The Field components exposed by {@link useEmployeeDetailsForm} as `form.Fields`.
+ *
+ * @remarks
+ * Each entry is a component bound to a specific form field — see
+ * {@link FirstNameField}, {@link MiddleInitialField}, {@link LastNameField},
+ * {@link EmailField}, {@link DateOfBirthField}, {@link SsnField}, and
+ * {@link SelfOnboardingField}. `SelfOnboarding` may be `undefined` when
+ * the field is not toggleable.
+ *
+ * @public
+ */
 export interface EmployeeDetailsFields {
+    /** Text input bound to `firstName`. See {@link FirstNameField}. */
     FirstName: typeof FirstNameField;
+    /** Text input bound to `middleInitial`. See {@link MiddleInitialField}. */
     MiddleInitial: typeof MiddleInitialField;
+    /** Text input bound to `lastName`. See {@link LastNameField}. */
     LastName: typeof LastNameField;
+    /** Text input bound to `email`. See {@link EmailField}. */
     Email: typeof EmailField;
+    /** Date picker bound to `dateOfBirth`. See {@link DateOfBirthField}. */
     DateOfBirth: typeof DateOfBirthField;
+    /** Text input bound to `ssn`. See {@link SsnField}. */
     Ssn: typeof SsnField;
+    /** Switch bound to `selfOnboarding`, or `undefined` when the field is not toggleable. See {@link SelfOnboardingField}. */
     SelfOnboarding: typeof SelfOnboardingField | undefined;
 }
+/**
+ * The ready-state result returned by {@link useEmployeeDetailsForm} once data has loaded.
+ *
+ * @remarks
+ * Provides the form's `data` snapshot, pending `status`, submit `actions`,
+ * error handling, and the `form.Fields` map.
+ *
+ * @public
+ */
 export interface UseEmployeeDetailsFormReady extends BaseFormHookReady<FieldsMetadata, EmployeeDetailsFormData, EmployeeDetailsFields> {
+    /** The loaded employee data, or `null` in create mode. */
     data: {
+        /** The employee being edited, or `null` in create mode. */
         employee: Employee | null;
     };
+    /** Submit status and form mode. */
     status: {
+        /** `true` while the create, update, or onboarding-status mutation is in flight. */
         isPending: boolean;
+        /** `'create'` when no `employeeId` was supplied, `'update'` otherwise. */
         mode: 'create' | 'update';
     };
+    /** Submit and related actions. */
     actions: {
+        /** Validates the form and submits the changes. Returns the created or updated employee, or `undefined` when validation fails. */
         onSubmit: (callbacks?: EmployeeDetailsSubmitCallbacks) => Promise<HookSubmitResult<Employee> | undefined>;
     };
 }
+/**
+ * Headless hook for creating or updating an employee's profile details — name, email, SSN, date of birth, and self-onboarding preference.
+ *
+ * @remarks
+ * Returns a discriminated union: a loading variant while the underlying
+ * employee fetch resolves, and a ready variant exposing the form's data,
+ * pending status, submit action, error handling, and bound `Fields`.
+ * Self-onboarding is only toggleable when the employee's onboarding status
+ * allows it; otherwise `form.Fields.SelfOnboarding` is `undefined`.
+ *
+ * @param input - See {@link UseEmployeeDetailsFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UseEmployeeDetailsFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import {
+ *   useEmployeeDetailsForm,
+ *   SDKFormProvider,
+ *   type UseEmployeeDetailsFormReady,
+ * } from '@gusto/embedded-react-sdk'
+ *
+ * function EmployeeDetailsPage({ companyId, employeeId }: { companyId: string; employeeId?: string }) {
+ *   const employeeDetails = useEmployeeDetailsForm({ companyId, employeeId })
+ *
+ *   if (employeeDetails.isLoading) return <div>Loading...</div>
+ *
+ *   return <EmployeeDetailsReady employeeDetails={employeeDetails} />
+ * }
+ *
+ * function EmployeeDetailsReady({ employeeDetails }: { employeeDetails: UseEmployeeDetailsFormReady }) {
+ *   const { Fields } = employeeDetails.form
+ *
+ *   const handleSubmit = async () => {
+ *     await employeeDetails.actions.onSubmit({
+ *       onEmployeeCreated: emp => console.log('Created:', emp.uuid),
+ *       onEmployeeUpdated: emp => console.log('Updated:', emp.uuid),
+ *     })
+ *   }
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={employeeDetails}>
+ *       <form onSubmit={e => { e.preventDefault(); void handleSubmit() }}>
+ *         <Fields.FirstName label="First name" />
+ *         <Fields.LastName label="Last name" />
+ *         <Fields.Email label="Personal email" />
+ *         <Fields.DateOfBirth label="Date of birth" />
+ *         <Fields.Ssn label="Social Security number" />
+ *         <button type="submit" disabled={employeeDetails.status.isPending}>Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function useEmployeeDetailsForm({ companyId, employeeId, withSelfOnboardingField, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseEmployeeDetailsFormProps): HookLoadingResult | UseEmployeeDetailsFormReady;
+/**
+ * Return type of {@link useEmployeeDetailsForm}.
+ *
+ * @public
+ */
 export type UseEmployeeDetailsFormResult = HookLoadingResult | UseEmployeeDetailsFormReady;
+/**
+ * Shape of `form.fieldsMetadata` returned by {@link useEmployeeDetailsForm}.
+ *
+ * @public
+ */
 export type EmployeeDetailsFieldsMetadata = UseEmployeeDetailsFormReady['form']['fieldsMetadata'];
+/**
+ * Shape of `form.Fields` returned by {@link useEmployeeDetailsForm}.
+ *
+ * @public
+ */
 export type EmployeeDetailsFormFields = UseEmployeeDetailsFormReady['form']['Fields'];

package/dist/components/Employee/Profile/shared/useEmployeeDetailsForm/useEmployeeDetailsForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useEmployeeDetailsForm.js","sources":["../../../../../../src/components/Employee/Profile/shared/useEmployeeDetailsForm/useEmployeeDetailsForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { Employee } from '@gusto/embedded-api-v-2025-11-15/models/components/employee'\nimport { useEmployeesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { useEmployeesCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesCreate'\nimport { useEmployeesUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesUpdate'\nimport { useEmployeesUpdateOnboardingStatusMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesUpdateOnboardingStatus'\nimport { RFCDate } from '@gusto/embedded-api-v-2025-11-15/types/rfcdate'\nimport {\n  createEmployeeDetailsSchema,\n  type EmployeeDetailsOptionalFieldsToRequire,\n  type EmployeeDetailsFormData,\n  type EmployeeDetailsFormOutputs,\n} from './employeeDetailsSchema'\nimport {\n  FirstNameField,\n  MiddleInitialField,\n  LastNameField,\n  EmailField,\n  DateOfBirthField,\n  SsnField,\n  SelfOnboardingField,\n} from './fields'\nimport { normalizeToISOString } from '@/helpers/dateFormatting'\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 { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { EmployeeOnboardingStatus } from '@/shared/constants'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\nimport { removeNonDigits } from '@/helpers/formattedStrings'\n\nexport type { EmployeeDetailsOptionalFieldsToRequire } from './employeeDetailsSchema'\n\nexport interface EmployeeDetailsSubmitCallbacks {\n  onEmployeeCreated?: (employee: Employee) => void\n  onEmployeeUpdated?: (employee: Employee) => void\n  onOnboardingStatusUpdated?: (status: unknown) => void\n}\n\ntype UseEmployeeDetailsFormSharedProps = {\n  withSelfOnboardingField?: boolean\n  optionalFieldsToRequire?: EmployeeDetailsOptionalFieldsToRequire\n  defaultValues?: Partial<EmployeeDetailsFormData>\n  validationMode?: UseFormProps['mode']\n  shouldFocusError?: boolean\n}\n\nexport type UseEmployeeDetailsFormProps =\n  | (UseEmployeeDetailsFormSharedProps & { companyId: string; employeeId?: never })\n  | (UseEmployeeDetailsFormSharedProps & { employeeId: string; companyId?: string })\n\nexport interface EmployeeDetailsFields {\n  FirstName: typeof FirstNameField\n  MiddleInitial: typeof MiddleInitialField\n  LastName: typeof LastNameField\n  Email: typeof EmailField\n  DateOfBirth: typeof DateOfBirthField\n  Ssn: typeof SsnField\n  SelfOnboarding: typeof SelfOnboardingField | undefined\n}\n\nexport interface UseEmployeeDetailsFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  EmployeeDetailsFormData,\n  EmployeeDetailsFields\n> {\n  data: {\n    employee: Employee | null\n  }\n  status: { isPending: boolean; mode: 'create' | 'update' }\n  actions: {\n    onSubmit: (\n      callbacks?: EmployeeDetailsSubmitCallbacks,\n    ) => Promise<HookSubmitResult<Employee> | undefined>\n  }\n}\n\nconst isCurrentlySelfOnboarding = (employee?: Employee) => {\n  if (!employee?.onboardingStatus) return false\n  const selfOnboardingStatuses: string[] = [\n    EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_INVITED,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_INVITED_STARTED,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_INVITED_OVERDUE,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_COMPLETED_BY_EMPLOYEE,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_AWAITING_ADMIN_REVIEW,\n  ]\n  return selfOnboardingStatuses.includes(employee.onboardingStatus)\n}\n\nconst canToggleSelfOnboarding = (employee?: Employee) => {\n  if (!employee) return true\n  return (\n    employee.onboardingStatus === EmployeeOnboardingStatus.ADMIN_ONBOARDING_INCOMPLETE ||\n    employee.onboardingStatus === EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE\n  )\n}\n\nexport function useEmployeeDetailsForm({\n  companyId,\n  employeeId,\n  withSelfOnboardingField = true,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseEmployeeDetailsFormProps): HookLoadingResult | UseEmployeeDetailsFormReady {\n  const employeeQuery = useEmployeesGet({ employeeId: employeeId ?? '' }, { enabled: !!employeeId })\n\n  const employee = employeeQuery.data?.employee\n\n  const isCreateMode = !employeeId\n  const isSelfOnboardingToggleable = canToggleSelfOnboarding(employee)\n\n  const mode = isCreateMode ? 'create' : 'update'\n\n  const [schema, metadataConfig] = useMemo(\n    () => createEmployeeDetailsSchema({ mode, optionalFieldsToRequire, hasSsn: employee?.hasSsn }),\n    [mode, optionalFieldsToRequire, employee?.hasSsn],\n  )\n\n  const resolvedDefaults: EmployeeDetailsFormData = {\n    firstName: employee?.firstName ?? partnerDefaults?.firstName ?? '',\n    middleInitial: employee?.middleInitial ?? partnerDefaults?.middleInitial ?? '',\n    lastName: employee?.lastName ?? partnerDefaults?.lastName ?? '',\n    email: employee?.email ?? partnerDefaults?.email ?? '',\n    dateOfBirth: employee?.dateOfBirth ?? normalizeToISOString(partnerDefaults?.dateOfBirth),\n    ssn: partnerDefaults?.ssn ?? '',\n    selfOnboarding: partnerDefaults?.selfOnboarding ?? isCurrentlySelfOnboarding(employee),\n  }\n\n  const formMethods = useForm<EmployeeDetailsFormData, unknown, EmployeeDetailsFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const createEmployeeMutation = useEmployeesCreateMutation()\n  const updateEmployeeMutation = useEmployeesUpdateMutation()\n  const updateOnboardingStatusMutation = useEmployeesUpdateOnboardingStatusMutation()\n\n  const isPending =\n    createEmployeeMutation.isPending ||\n    updateEmployeeMutation.isPending ||\n    updateOnboardingStatusMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('EmployeeDetailsForm')\n\n  const queries = employeeId ? [employeeQuery] : []\n  const errorHandling = composeErrorHandler(queries, { submitError, setSubmitError })\n\n  const fieldsMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n\n  const onSubmit = async (\n    callbacks?: EmployeeDetailsSubmitCallbacks,\n  ): Promise<HookSubmitResult<Employee> | undefined> => {\n    let submitResult: HookSubmitResult<Employee> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: EmployeeDetailsFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const { selfOnboarding, dateOfBirth, ssn, ...body } = payload\n\n            const cleanedSsn = ssn ? removeNonDigits(ssn) : undefined\n            const hasSsnInput = cleanedSsn && cleanedSsn.length > 0\n\n            let updatedEmployee: Employee\n\n            if (isCreateMode) {\n              if (!companyId) {\n                throw new SDKInternalError('companyId is required to create an employee')\n              }\n              const result = await createEmployeeMutation.mutateAsync({\n                request: {\n                  companyId,\n                  requestBody: {\n                    ...body,\n                    selfOnboarding,\n                    dateOfBirth: dateOfBirth ? new RFCDate(new Date(dateOfBirth)) : undefined,\n                    ssn: hasSsnInput ? cleanedSsn : undefined,\n                  },\n                },\n              })\n\n              if (!result.employee) {\n                throw new SDKInternalError('Employee creation failed')\n              }\n\n              updatedEmployee = result.employee\n              callbacks?.onEmployeeCreated?.(updatedEmployee)\n            } else {\n              if (!employee) {\n                throw new SDKInternalError('Employee data is not available')\n              }\n\n              if (isSelfOnboardingToggleable) {\n                const currentIsSelfOnboarding =\n                  employee.onboardingStatus ===\n                  EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE\n\n                if (selfOnboarding !== currentIsSelfOnboarding) {\n                  const { employeeOnboardingStatus } =\n                    await updateOnboardingStatusMutation.mutateAsync({\n                      request: {\n                        employeeId: employee.uuid,\n                        requestBody: {\n                          onboardingStatus: selfOnboarding\n                            ? EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE\n                            : EmployeeOnboardingStatus.ADMIN_ONBOARDING_INCOMPLETE,\n                        },\n                      },\n                    })\n\n                  callbacks?.onOnboardingStatusUpdated?.(employeeOnboardingStatus)\n                }\n              }\n\n              const result = await updateEmployeeMutation.mutateAsync({\n                request: {\n                  employeeId: employee.uuid,\n                  requestBody: {\n                    version: employee.version as string,\n                    ...body,\n                    dateOfBirth: dateOfBirth || undefined,\n                    ssn: hasSsnInput ? cleanedSsn : undefined,\n                  },\n                },\n              })\n\n              if (!result.employee) {\n                throw new SDKInternalError('Employee update failed')\n              }\n\n              updatedEmployee = result.employee\n              callbacks?.onEmployeeUpdated?.(updatedEmployee)\n            }\n\n            submitResult = {\n              mode: isCreateMode ? 'create' : 'update',\n              data: updatedEmployee,\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 = employeeId ? employeeQuery.isLoading : false\n\n  if (isDataLoading || (employeeId && !employee)) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: {\n      employee: employee ?? null,\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        FirstName: FirstNameField,\n        MiddleInitial: MiddleInitialField,\n        LastName: LastNameField,\n        Email: EmailField,\n        DateOfBirth: DateOfBirthField,\n        Ssn: SsnField,\n        SelfOnboarding:\n          withSelfOnboardingField && isSelfOnboardingToggleable ? SelfOnboardingField : undefined,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\nexport type UseEmployeeDetailsFormResult = HookLoadingResult | UseEmployeeDetailsFormReady\nexport type EmployeeDetailsFieldsMetadata = UseEmployeeDetailsFormReady['form']['fieldsMetadata']\nexport type EmployeeDetailsFormFields = UseEmployeeDetailsFormReady['form']['Fields']\n"],"names":["isCurrentlySelfOnboarding","employee","EmployeeOnboardingStatus","canToggleSelfOnboarding","useEmployeeDetailsForm","companyId","employeeId","withSelfOnboardingField","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","employeeQuery","useEmployeesGet","isCreateMode","isSelfOnboardingToggleable","mode","schema","metadataConfig","useMemo","createEmployeeDetailsSchema","resolvedDefaults","normalizeToISOString","formMethods","useForm","zodResolver","createEmployeeMutation","useEmployeesCreateMutation","updateEmployeeMutation","useEmployeesUpdateMutation","updateOnboardingStatusMutation","useEmployeesUpdateOnboardingStatusMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","fieldsMetadata","useDeriveFieldsMetadata","onSubmit","callbacks","submitResult","resolve","data","payload","selfOnboarding","dateOfBirth","ssn","body","cleanedSsn","removeNonDigits","hasSsnInput","updatedEmployee","SDKInternalError","result","RFCDate","currentIsSelfOnboarding","employeeOnboardingStatus","hookFormInternals","useHookFormInternals","FirstNameField","MiddleInitialField","LastNameField","EmailField","DateOfBirthField","SsnField","SelfOnboardingField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;;;AAuFA,MAAMA,KAA4B,CAACC,MAC5BA,GAAU,mBAC0B;AAAA,EACvCC,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EAEG,SAASD,EAAS,gBAAgB,IATxB,IAYpCE,KAA0B,CAACF,MAC1BA,IAEHA,EAAS,qBAAqBC,EAAyB,+BACvDD,EAAS,qBAAqBC,EAAyB,iCAHnC;AAOjB,SAASE,GAAuB;AAAA,EACrC,WAAAC;AAAA,EACA,YAAAC;AAAA,EACA,yBAAAC,IAA0B;AAAA,EAC1B,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAiF;AAC/E,QAAMC,IAAgBC,EAAgB,EAAE,YAAYP,KAAc,GAAA,GAAM,EAAE,SAAS,CAAC,CAACA,GAAY,GAE3FL,IAAWW,EAAc,MAAM,UAE/BE,IAAe,CAACR,GAChBS,IAA6BZ,GAAwBF,CAAQ,GAE7De,IAAOF,IAAe,WAAW,UAEjC,CAACG,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAA4B,EAAE,MAAAJ,GAAM,yBAAAR,GAAyB,QAAQP,GAAU,QAAQ;AAAA,IAC7F,CAACe,GAAMR,GAAyBP,GAAU,MAAM;AAAA,EAAA,GAG5CoB,IAA4C;AAAA,IAChD,WAAWpB,GAAU,aAAaQ,GAAiB,aAAa;AAAA,IAChE,eAAeR,GAAU,iBAAiBQ,GAAiB,iBAAiB;AAAA,IAC5E,UAAUR,GAAU,YAAYQ,GAAiB,YAAY;AAAA,IAC7D,OAAOR,GAAU,SAASQ,GAAiB,SAAS;AAAA,IACpD,aAAaR,GAAU,eAAeqB,GAAqBb,GAAiB,WAAW;AAAA,IACvF,KAAKA,GAAiB,OAAO;AAAA,IAC7B,gBAAgBA,GAAiB,kBAAkBT,GAA0BC,CAAQ;AAAA,EAAA,GAGjFsB,IAAcC,EAAsE;AAAA,IACxF,UAAUC,EAAYR,CAAM;AAAA,IAC5B,MAAMP;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeU;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKK,IAAyBC,EAAA,GACzBC,IAAyBC,EAAA,GACzBC,IAAiCC,EAAA,GAEjCC,IACJN,EAAuB,aACvBE,EAAuB,aACvBE,EAA+B,WAE3B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,qBAAqB,GAGjCC,IAAgBC,GADNhC,IAAa,CAACM,CAAa,IAAI,CAAA,GACI,EAAE,aAAAsB,GAAa,gBAAAC,GAAgB,GAE5EI,IAAiBC,GAAwBtB,GAAgBK,EAAY,OAAO,GAE5EkB,IAAW,OACfC,MACoD;AACpD,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKrB,EAAY;AAAA,QACf,OAAOsB,MAAqC;AAC1C,gBAAMZ,EAAkBY,GAAM,OAAMC,MAAW;AAC7C,kBAAM,EAAE,gBAAAC,GAAgB,aAAAC,GAAa,KAAAC,GAAK,GAAGC,MAASJ,GAEhDK,IAAaF,IAAMG,GAAgBH,CAAG,IAAI,QAC1CI,IAAcF,KAAcA,EAAW,SAAS;AAEtD,gBAAIG;AAEJ,gBAAIxC,GAAc;AAChB,kBAAI,CAACT;AACH,sBAAM,IAAIkD,EAAiB,6CAA6C;AAE1E,oBAAMC,IAAS,MAAM9B,EAAuB,YAAY;AAAA,gBACtD,SAAS;AAAA,kBACP,WAAArB;AAAA,kBACA,aAAa;AAAA,oBACX,GAAG6C;AAAA,oBACH,gBAAAH;AAAA,oBACA,aAAaC,IAAc,IAAIS,EAAQ,IAAI,KAAKT,CAAW,CAAC,IAAI;AAAA,oBAChE,KAAKK,IAAcF,IAAa;AAAA,kBAAA;AAAA,gBAClC;AAAA,cACF,CACD;AAED,kBAAI,CAACK,EAAO;AACV,sBAAM,IAAID,EAAiB,0BAA0B;AAGvD,cAAAD,IAAkBE,EAAO,UACzBd,GAAW,oBAAoBY,CAAe;AAAA,YAChD,OAAO;AACL,kBAAI,CAACrD;AACH,sBAAM,IAAIsD,EAAiB,gCAAgC;AAG7D,kBAAIxC,GAA4B;AAC9B,sBAAM2C,IACJzD,EAAS,qBACTC,EAAyB;AAE3B,oBAAI6C,MAAmBW,GAAyB;AAC9C,wBAAM,EAAE,0BAAAC,EAAA,IACN,MAAM7B,EAA+B,YAAY;AAAA,oBAC/C,SAAS;AAAA,sBACP,YAAY7B,EAAS;AAAA,sBACrB,aAAa;AAAA,wBACX,kBAAkB8C,IACd7C,EAAyB,iCACzBA,EAAyB;AAAA,sBAAA;AAAA,oBAC/B;AAAA,kBACF,CACD;AAEH,kBAAAwC,GAAW,4BAA4BiB,CAAwB;AAAA,gBACjE;AAAA,cACF;AAEA,oBAAMH,IAAS,MAAM5B,EAAuB,YAAY;AAAA,gBACtD,SAAS;AAAA,kBACP,YAAY3B,EAAS;AAAA,kBACrB,aAAa;AAAA,oBACX,SAASA,EAAS;AAAA,oBAClB,GAAGiD;AAAA,oBACH,aAAaF,KAAe;AAAA,oBAC5B,KAAKK,IAAcF,IAAa;AAAA,kBAAA;AAAA,gBAClC;AAAA,cACF,CACD;AAED,kBAAI,CAACK,EAAO;AACV,sBAAM,IAAID,EAAiB,wBAAwB;AAGrD,cAAAD,IAAkBE,EAAO,UACzBd,GAAW,oBAAoBY,CAAe;AAAA,YAChD;AAEA,YAAAX,IAAe;AAAA,cACb,MAAM7B,IAAe,WAAW;AAAA,cAChC,MAAMwC;AAAA,YAAA;AAAA,UAEV,CAAC,GACDV,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMiB,IAAoBC,GAAqBtC,CAAW;AAI1D,UAFsBjB,IAAaM,EAAc,YAAY,OAEvCN,KAAc,CAACL,IAC5B,EAAE,WAAW,IAAe,eAAAoC,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,UAAUpC,KAAY;AAAA,IAAA;AAAA,IAExB,QAAQ;AAAA,MACN,WAAA+B;AAAA,MACA,MAAMlB,IAAgB,WAAsB;AAAA,IAAA;AAAA,IAE9C,SAAS,EAAE,UAAA2B,EAAA;AAAA,IACX,eAAAJ;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,WAAWyB;AAAA,QACX,eAAeC;AAAA,QACf,UAAUC;AAAA,QACV,OAAOC;AAAA,QACP,aAAaC;AAAA,QACb,KAAKC;AAAA,QACL,gBACE5D,KAA2BQ,IAA6BqD,IAAsB;AAAA,MAAA;AAAA,MAElF,gBAAA7B;AAAA,MACA,mBAAAqB;AAAA,MACA,yBAAyBS,GAA8B9C,GAAaN,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}
+{"version":3,"file":"useEmployeeDetailsForm.js","sources":["../../../../../../src/components/Employee/Profile/shared/useEmployeeDetailsForm/useEmployeeDetailsForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { Employee } from '@gusto/embedded-api-v-2025-11-15/models/components/employee'\nimport { useEmployeesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { useEmployeesCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesCreate'\nimport { useEmployeesUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesUpdate'\nimport { useEmployeesUpdateOnboardingStatusMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesUpdateOnboardingStatus'\nimport { RFCDate } from '@gusto/embedded-api-v-2025-11-15/types/rfcdate'\nimport {\n  createEmployeeDetailsSchema,\n  type EmployeeDetailsOptionalFieldsToRequire,\n  type EmployeeDetailsFormData,\n  type EmployeeDetailsFormOutputs,\n} from './employeeDetailsSchema'\nimport {\n  FirstNameField,\n  MiddleInitialField,\n  LastNameField,\n  EmailField,\n  DateOfBirthField,\n  SsnField,\n  SelfOnboardingField,\n} from './fields'\nimport { normalizeToISOString } from '@/helpers/dateFormatting'\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 { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { EmployeeOnboardingStatus } from '@/shared/constants'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\nimport { removeNonDigits } from '@/helpers/formattedStrings'\n\nexport type { EmployeeDetailsOptionalFieldsToRequire } from './employeeDetailsSchema'\n\n/**\n * Optional callbacks passed to {@link UseEmployeeDetailsFormReady.actions.onSubmit | onSubmit}.\n *\n * @remarks\n * Only the callback matching the submit mode fires —\n * `onEmployeeCreated` on create, `onEmployeeUpdated` on update.\n * `onOnboardingStatusUpdated` fires when toggling the self-onboarding\n * switch changes the employee's onboarding status as part of an update.\n *\n * @public\n */\nexport interface EmployeeDetailsSubmitCallbacks {\n  /** Fired after a new employee is successfully created. */\n  onEmployeeCreated?: (employee: Employee) => void\n  /** Fired after an existing employee is successfully updated. */\n  onEmployeeUpdated?: (employee: Employee) => void\n  /** Fired when an update toggles self-onboarding and the employee's onboarding status changes. */\n  onOnboardingStatusUpdated?: (status: unknown) => void\n}\n\n/**\n * Shared options merged into both branches of {@link UseEmployeeDetailsFormProps}.\n *\n * @public\n */\nexport type UseEmployeeDetailsFormSharedProps = {\n  /** Whether to expose the self-onboarding toggle as `form.Fields.SelfOnboarding`. Defaults to `true`. */\n  withSelfOnboardingField?: boolean\n  /** Fields that are optional by default but should be promoted to required for this form instance. */\n  optionalFieldsToRequire?: EmployeeDetailsOptionalFieldsToRequire\n  /** Initial values applied before any employee data loads. */\n  defaultValues?: Partial<EmployeeDetailsFormData>\n  /** When validation runs. Forwarded to react-hook-form's `mode`. Defaults to `'onSubmit'`. */\n  validationMode?: UseFormProps['mode']\n  /** Whether react-hook-form should focus the first error on validation failure. Defaults to `true`. */\n  shouldFocusError?: boolean\n}\n\n/**\n * Options for {@link useEmployeeDetailsForm}.\n *\n * @remarks\n * Discriminated by mode: in create mode supply `companyId` and omit\n * `employeeId`; in update mode supply `employeeId` (and optionally\n * `companyId`).\n *\n * @public\n */\nexport type UseEmployeeDetailsFormProps =\n  | (UseEmployeeDetailsFormSharedProps & { companyId: string; employeeId?: never })\n  | (UseEmployeeDetailsFormSharedProps & { employeeId: string; companyId?: string })\n\n/**\n * The Field components exposed by {@link useEmployeeDetailsForm} as `form.Fields`.\n *\n * @remarks\n * Each entry is a component bound to a specific form field — see\n * {@link FirstNameField}, {@link MiddleInitialField}, {@link LastNameField},\n * {@link EmailField}, {@link DateOfBirthField}, {@link SsnField}, and\n * {@link SelfOnboardingField}. `SelfOnboarding` may be `undefined` when\n * the field is not toggleable.\n *\n * @public\n */\nexport interface EmployeeDetailsFields {\n  /** Text input bound to `firstName`. See {@link FirstNameField}. */\n  FirstName: typeof FirstNameField\n  /** Text input bound to `middleInitial`. See {@link MiddleInitialField}. */\n  MiddleInitial: typeof MiddleInitialField\n  /** Text input bound to `lastName`. See {@link LastNameField}. */\n  LastName: typeof LastNameField\n  /** Text input bound to `email`. See {@link EmailField}. */\n  Email: typeof EmailField\n  /** Date picker bound to `dateOfBirth`. See {@link DateOfBirthField}. */\n  DateOfBirth: typeof DateOfBirthField\n  /** Text input bound to `ssn`. See {@link SsnField}. */\n  Ssn: typeof SsnField\n  /** Switch bound to `selfOnboarding`, or `undefined` when the field is not toggleable. See {@link SelfOnboardingField}. */\n  SelfOnboarding: typeof SelfOnboardingField | undefined\n}\n\n/**\n * The ready-state result returned by {@link useEmployeeDetailsForm} once data has loaded.\n *\n * @remarks\n * Provides the form's `data` snapshot, pending `status`, submit `actions`,\n * error handling, and the `form.Fields` map.\n *\n * @public\n */\nexport interface UseEmployeeDetailsFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  EmployeeDetailsFormData,\n  EmployeeDetailsFields\n> {\n  /** The loaded employee data, or `null` in create mode. */\n  data: {\n    /** The employee being edited, or `null` in create mode. */\n    employee: Employee | null\n  }\n  /** Submit status and form mode. */\n  status: {\n    /** `true` while the create, update, or onboarding-status mutation is in flight. */\n    isPending: boolean\n    /** `'create'` when no `employeeId` was supplied, `'update'` otherwise. */\n    mode: 'create' | 'update'\n  }\n  /** Submit and related actions. */\n  actions: {\n    /** Validates the form and submits the changes. Returns the created or updated employee, or `undefined` when validation fails. */\n    onSubmit: (\n      callbacks?: EmployeeDetailsSubmitCallbacks,\n    ) => Promise<HookSubmitResult<Employee> | undefined>\n  }\n}\n\nconst isCurrentlySelfOnboarding = (employee?: Employee) => {\n  if (!employee?.onboardingStatus) return false\n  const selfOnboardingStatuses: string[] = [\n    EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_INVITED,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_INVITED_STARTED,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_INVITED_OVERDUE,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_COMPLETED_BY_EMPLOYEE,\n    EmployeeOnboardingStatus.SELF_ONBOARDING_AWAITING_ADMIN_REVIEW,\n  ]\n  return selfOnboardingStatuses.includes(employee.onboardingStatus)\n}\n\nconst canToggleSelfOnboarding = (employee?: Employee) => {\n  if (!employee) return true\n  return (\n    employee.onboardingStatus === EmployeeOnboardingStatus.ADMIN_ONBOARDING_INCOMPLETE ||\n    employee.onboardingStatus === EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE\n  )\n}\n\n/**\n * Headless hook for creating or updating an employee's profile details — name, email, SSN, date of birth, and self-onboarding preference.\n *\n * @remarks\n * Returns a discriminated union: a loading variant while the underlying\n * employee fetch resolves, and a ready variant exposing the form's data,\n * pending status, submit action, error handling, and bound `Fields`.\n * Self-onboarding is only toggleable when the employee's onboarding status\n * allows it; otherwise `form.Fields.SelfOnboarding` is `undefined`.\n *\n * @param input - See {@link UseEmployeeDetailsFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UseEmployeeDetailsFormReady} once ready.\n * @public\n *\n * @example\n * ```tsx\n * import {\n *   useEmployeeDetailsForm,\n *   SDKFormProvider,\n *   type UseEmployeeDetailsFormReady,\n * } from '@gusto/embedded-react-sdk'\n *\n * function EmployeeDetailsPage({ companyId, employeeId }: { companyId: string; employeeId?: string }) {\n *   const employeeDetails = useEmployeeDetailsForm({ companyId, employeeId })\n *\n *   if (employeeDetails.isLoading) return <div>Loading...</div>\n *\n *   return <EmployeeDetailsReady employeeDetails={employeeDetails} />\n * }\n *\n * function EmployeeDetailsReady({ employeeDetails }: { employeeDetails: UseEmployeeDetailsFormReady }) {\n *   const { Fields } = employeeDetails.form\n *\n *   const handleSubmit = async () => {\n *     await employeeDetails.actions.onSubmit({\n *       onEmployeeCreated: emp => console.log('Created:', emp.uuid),\n *       onEmployeeUpdated: emp => console.log('Updated:', emp.uuid),\n *     })\n *   }\n *\n *   return (\n *     <SDKFormProvider formHookResult={employeeDetails}>\n *       <form onSubmit={e => { e.preventDefault(); void handleSubmit() }}>\n *         <Fields.FirstName label=\"First name\" />\n *         <Fields.LastName label=\"Last name\" />\n *         <Fields.Email label=\"Personal email\" />\n *         <Fields.DateOfBirth label=\"Date of birth\" />\n *         <Fields.Ssn label=\"Social Security number\" />\n *         <button type=\"submit\" disabled={employeeDetails.status.isPending}>Save</button>\n *       </form>\n *     </SDKFormProvider>\n *   )\n * }\n * ```\n */\nexport function useEmployeeDetailsForm({\n  companyId,\n  employeeId,\n  withSelfOnboardingField = true,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseEmployeeDetailsFormProps): HookLoadingResult | UseEmployeeDetailsFormReady {\n  const employeeQuery = useEmployeesGet({ employeeId: employeeId ?? '' }, { enabled: !!employeeId })\n\n  const employee = employeeQuery.data?.employee\n\n  const isCreateMode = !employeeId\n  const isSelfOnboardingToggleable = canToggleSelfOnboarding(employee)\n\n  const mode = isCreateMode ? 'create' : 'update'\n\n  const [schema, metadataConfig] = useMemo(\n    () => createEmployeeDetailsSchema({ mode, optionalFieldsToRequire, hasSsn: employee?.hasSsn }),\n    [mode, optionalFieldsToRequire, employee?.hasSsn],\n  )\n\n  const resolvedDefaults: EmployeeDetailsFormData = {\n    firstName: employee?.firstName ?? partnerDefaults?.firstName ?? '',\n    middleInitial: employee?.middleInitial ?? partnerDefaults?.middleInitial ?? '',\n    lastName: employee?.lastName ?? partnerDefaults?.lastName ?? '',\n    email: employee?.email ?? partnerDefaults?.email ?? '',\n    dateOfBirth: employee?.dateOfBirth ?? normalizeToISOString(partnerDefaults?.dateOfBirth),\n    ssn: partnerDefaults?.ssn ?? '',\n    selfOnboarding: partnerDefaults?.selfOnboarding ?? isCurrentlySelfOnboarding(employee),\n  }\n\n  const formMethods = useForm<EmployeeDetailsFormData, unknown, EmployeeDetailsFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const createEmployeeMutation = useEmployeesCreateMutation()\n  const updateEmployeeMutation = useEmployeesUpdateMutation()\n  const updateOnboardingStatusMutation = useEmployeesUpdateOnboardingStatusMutation()\n\n  const isPending =\n    createEmployeeMutation.isPending ||\n    updateEmployeeMutation.isPending ||\n    updateOnboardingStatusMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('EmployeeDetailsForm')\n\n  const queries = employeeId ? [employeeQuery] : []\n  const errorHandling = composeErrorHandler(queries, { submitError, setSubmitError })\n\n  const fieldsMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n\n  const onSubmit = async (\n    callbacks?: EmployeeDetailsSubmitCallbacks,\n  ): Promise<HookSubmitResult<Employee> | undefined> => {\n    let submitResult: HookSubmitResult<Employee> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: EmployeeDetailsFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const { selfOnboarding, dateOfBirth, ssn, ...body } = payload\n\n            const cleanedSsn = ssn ? removeNonDigits(ssn) : undefined\n            const hasSsnInput = cleanedSsn && cleanedSsn.length > 0\n\n            let updatedEmployee: Employee\n\n            if (isCreateMode) {\n              if (!companyId) {\n                throw new SDKInternalError('companyId is required to create an employee')\n              }\n              const result = await createEmployeeMutation.mutateAsync({\n                request: {\n                  companyId,\n                  requestBody: {\n                    ...body,\n                    selfOnboarding,\n                    dateOfBirth: dateOfBirth ? new RFCDate(new Date(dateOfBirth)) : undefined,\n                    ssn: hasSsnInput ? cleanedSsn : undefined,\n                  },\n                },\n              })\n\n              if (!result.employee) {\n                throw new SDKInternalError('Employee creation failed')\n              }\n\n              updatedEmployee = result.employee\n              callbacks?.onEmployeeCreated?.(updatedEmployee)\n            } else {\n              if (!employee) {\n                throw new SDKInternalError('Employee data is not available')\n              }\n\n              if (isSelfOnboardingToggleable) {\n                const currentIsSelfOnboarding =\n                  employee.onboardingStatus ===\n                  EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE\n\n                if (selfOnboarding !== currentIsSelfOnboarding) {\n                  const { employeeOnboardingStatus } =\n                    await updateOnboardingStatusMutation.mutateAsync({\n                      request: {\n                        employeeId: employee.uuid,\n                        requestBody: {\n                          onboardingStatus: selfOnboarding\n                            ? EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE\n                            : EmployeeOnboardingStatus.ADMIN_ONBOARDING_INCOMPLETE,\n                        },\n                      },\n                    })\n\n                  callbacks?.onOnboardingStatusUpdated?.(employeeOnboardingStatus)\n                }\n              }\n\n              const result = await updateEmployeeMutation.mutateAsync({\n                request: {\n                  employeeId: employee.uuid,\n                  requestBody: {\n                    version: employee.version as string,\n                    ...body,\n                    dateOfBirth: dateOfBirth || undefined,\n                    ssn: hasSsnInput ? cleanedSsn : undefined,\n                  },\n                },\n              })\n\n              if (!result.employee) {\n                throw new SDKInternalError('Employee update failed')\n              }\n\n              updatedEmployee = result.employee\n              callbacks?.onEmployeeUpdated?.(updatedEmployee)\n            }\n\n            submitResult = {\n              mode: isCreateMode ? 'create' : 'update',\n              data: updatedEmployee,\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 = employeeId ? employeeQuery.isLoading : false\n\n  if (isDataLoading || (employeeId && !employee)) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: {\n      employee: employee ?? null,\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        FirstName: FirstNameField,\n        MiddleInitial: MiddleInitialField,\n        LastName: LastNameField,\n        Email: EmailField,\n        DateOfBirth: DateOfBirthField,\n        Ssn: SsnField,\n        SelfOnboarding:\n          withSelfOnboardingField && isSelfOnboardingToggleable ? SelfOnboardingField : undefined,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Return type of {@link useEmployeeDetailsForm}.\n *\n * @public\n */\nexport type UseEmployeeDetailsFormResult = HookLoadingResult | UseEmployeeDetailsFormReady\n\n/**\n * Shape of `form.fieldsMetadata` returned by {@link useEmployeeDetailsForm}.\n *\n * @public\n */\nexport type EmployeeDetailsFieldsMetadata = UseEmployeeDetailsFormReady['form']['fieldsMetadata']\n\n/**\n * Shape of `form.Fields` returned by {@link useEmployeeDetailsForm}.\n *\n * @public\n */\nexport type EmployeeDetailsFormFields = UseEmployeeDetailsFormReady['form']['Fields']\n"],"names":["isCurrentlySelfOnboarding","employee","EmployeeOnboardingStatus","canToggleSelfOnboarding","useEmployeeDetailsForm","companyId","employeeId","withSelfOnboardingField","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","employeeQuery","useEmployeesGet","isCreateMode","isSelfOnboardingToggleable","mode","schema","metadataConfig","useMemo","createEmployeeDetailsSchema","resolvedDefaults","normalizeToISOString","formMethods","useForm","zodResolver","createEmployeeMutation","useEmployeesCreateMutation","updateEmployeeMutation","useEmployeesUpdateMutation","updateOnboardingStatusMutation","useEmployeesUpdateOnboardingStatusMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","fieldsMetadata","useDeriveFieldsMetadata","onSubmit","callbacks","submitResult","resolve","data","payload","selfOnboarding","dateOfBirth","ssn","body","cleanedSsn","removeNonDigits","hasSsnInput","updatedEmployee","SDKInternalError","result","RFCDate","currentIsSelfOnboarding","employeeOnboardingStatus","hookFormInternals","useHookFormInternals","FirstNameField","MiddleInitialField","LastNameField","EmailField","DateOfBirthField","SsnField","SelfOnboardingField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;;;AA+JA,MAAMA,KAA4B,CAACC,MAC5BA,GAAU,mBAC0B;AAAA,EACvCC,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EAEG,SAASD,EAAS,gBAAgB,IATxB,IAYpCE,KAA0B,CAACF,MAC1BA,IAEHA,EAAS,qBAAqBC,EAAyB,+BACvDD,EAAS,qBAAqBC,EAAyB,iCAHnC;AA8DjB,SAASE,GAAuB;AAAA,EACrC,WAAAC;AAAA,EACA,YAAAC;AAAA,EACA,yBAAAC,IAA0B;AAAA,EAC1B,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAiF;AAC/E,QAAMC,IAAgBC,EAAgB,EAAE,YAAYP,KAAc,GAAA,GAAM,EAAE,SAAS,CAAC,CAACA,GAAY,GAE3FL,IAAWW,EAAc,MAAM,UAE/BE,IAAe,CAACR,GAChBS,IAA6BZ,GAAwBF,CAAQ,GAE7De,IAAOF,IAAe,WAAW,UAEjC,CAACG,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAA4B,EAAE,MAAAJ,GAAM,yBAAAR,GAAyB,QAAQP,GAAU,QAAQ;AAAA,IAC7F,CAACe,GAAMR,GAAyBP,GAAU,MAAM;AAAA,EAAA,GAG5CoB,IAA4C;AAAA,IAChD,WAAWpB,GAAU,aAAaQ,GAAiB,aAAa;AAAA,IAChE,eAAeR,GAAU,iBAAiBQ,GAAiB,iBAAiB;AAAA,IAC5E,UAAUR,GAAU,YAAYQ,GAAiB,YAAY;AAAA,IAC7D,OAAOR,GAAU,SAASQ,GAAiB,SAAS;AAAA,IACpD,aAAaR,GAAU,eAAeqB,GAAqBb,GAAiB,WAAW;AAAA,IACvF,KAAKA,GAAiB,OAAO;AAAA,IAC7B,gBAAgBA,GAAiB,kBAAkBT,GAA0BC,CAAQ;AAAA,EAAA,GAGjFsB,IAAcC,EAAsE;AAAA,IACxF,UAAUC,EAAYR,CAAM;AAAA,IAC5B,MAAMP;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeU;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKK,IAAyBC,EAAA,GACzBC,IAAyBC,EAAA,GACzBC,IAAiCC,EAAA,GAEjCC,IACJN,EAAuB,aACvBE,EAAuB,aACvBE,EAA+B,WAE3B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,qBAAqB,GAGjCC,IAAgBC,GADNhC,IAAa,CAACM,CAAa,IAAI,CAAA,GACI,EAAE,aAAAsB,GAAa,gBAAAC,GAAgB,GAE5EI,IAAiBC,GAAwBtB,GAAgBK,EAAY,OAAO,GAE5EkB,IAAW,OACfC,MACoD;AACpD,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKrB,EAAY;AAAA,QACf,OAAOsB,MAAqC;AAC1C,gBAAMZ,EAAkBY,GAAM,OAAMC,MAAW;AAC7C,kBAAM,EAAE,gBAAAC,GAAgB,aAAAC,GAAa,KAAAC,GAAK,GAAGC,MAASJ,GAEhDK,IAAaF,IAAMG,GAAgBH,CAAG,IAAI,QAC1CI,IAAcF,KAAcA,EAAW,SAAS;AAEtD,gBAAIG;AAEJ,gBAAIxC,GAAc;AAChB,kBAAI,CAACT;AACH,sBAAM,IAAIkD,EAAiB,6CAA6C;AAE1E,oBAAMC,IAAS,MAAM9B,EAAuB,YAAY;AAAA,gBACtD,SAAS;AAAA,kBACP,WAAArB;AAAA,kBACA,aAAa;AAAA,oBACX,GAAG6C;AAAA,oBACH,gBAAAH;AAAA,oBACA,aAAaC,IAAc,IAAIS,EAAQ,IAAI,KAAKT,CAAW,CAAC,IAAI;AAAA,oBAChE,KAAKK,IAAcF,IAAa;AAAA,kBAAA;AAAA,gBAClC;AAAA,cACF,CACD;AAED,kBAAI,CAACK,EAAO;AACV,sBAAM,IAAID,EAAiB,0BAA0B;AAGvD,cAAAD,IAAkBE,EAAO,UACzBd,GAAW,oBAAoBY,CAAe;AAAA,YAChD,OAAO;AACL,kBAAI,CAACrD;AACH,sBAAM,IAAIsD,EAAiB,gCAAgC;AAG7D,kBAAIxC,GAA4B;AAC9B,sBAAM2C,IACJzD,EAAS,qBACTC,EAAyB;AAE3B,oBAAI6C,MAAmBW,GAAyB;AAC9C,wBAAM,EAAE,0BAAAC,EAAA,IACN,MAAM7B,EAA+B,YAAY;AAAA,oBAC/C,SAAS;AAAA,sBACP,YAAY7B,EAAS;AAAA,sBACrB,aAAa;AAAA,wBACX,kBAAkB8C,IACd7C,EAAyB,iCACzBA,EAAyB;AAAA,sBAAA;AAAA,oBAC/B;AAAA,kBACF,CACD;AAEH,kBAAAwC,GAAW,4BAA4BiB,CAAwB;AAAA,gBACjE;AAAA,cACF;AAEA,oBAAMH,IAAS,MAAM5B,EAAuB,YAAY;AAAA,gBACtD,SAAS;AAAA,kBACP,YAAY3B,EAAS;AAAA,kBACrB,aAAa;AAAA,oBACX,SAASA,EAAS;AAAA,oBAClB,GAAGiD;AAAA,oBACH,aAAaF,KAAe;AAAA,oBAC5B,KAAKK,IAAcF,IAAa;AAAA,kBAAA;AAAA,gBAClC;AAAA,cACF,CACD;AAED,kBAAI,CAACK,EAAO;AACV,sBAAM,IAAID,EAAiB,wBAAwB;AAGrD,cAAAD,IAAkBE,EAAO,UACzBd,GAAW,oBAAoBY,CAAe;AAAA,YAChD;AAEA,YAAAX,IAAe;AAAA,cACb,MAAM7B,IAAe,WAAW;AAAA,cAChC,MAAMwC;AAAA,YAAA;AAAA,UAEV,CAAC,GACDV,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMiB,IAAoBC,GAAqBtC,CAAW;AAI1D,UAFsBjB,IAAaM,EAAc,YAAY,OAEvCN,KAAc,CAACL,IAC5B,EAAE,WAAW,IAAe,eAAAoC,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,UAAUpC,KAAY;AAAA,IAAA;AAAA,IAExB,QAAQ;AAAA,MACN,WAAA+B;AAAA,MACA,MAAMlB,IAAgB,WAAsB;AAAA,IAAA;AAAA,IAE9C,SAAS,EAAE,UAAA2B,EAAA;AAAA,IACX,eAAAJ;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,WAAWyB;AAAA,QACX,eAAeC;AAAA,QACf,UAAUC;AAAA,QACV,OAAOC;AAAA,QACP,aAAaC;AAAA,QACb,KAAKC;AAAA,QACL,gBACE5D,KAA2BQ,IAA6BqD,IAAsB;AAAA,MAAA;AAAA,MAElF,gBAAA7B;AAAA,MACA,mBAAAqB;AAAA,MACA,yBAAyBS,GAA8B9C,GAAaN,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Employee/Profile/shared/useEmployeeProfileSummary/index.d.ts

@@ -1,3 +1,2 @@
 import "./types/i18next.d.ts"
 export { useEmployeeProfileSummary } from './useEmployeeProfileSummary';
-export type { UseEmployeeProfileSummaryParams, UseEmployeeProfileSummaryReady, UseEmployeeProfileSummaryResult, } from './useEmployeeProfileSummary';

package/dist/components/Employee/Profile/shared/useEmployeeProfileSummary/useEmployeeProfileSummary.d.ts

@@ -1,18 +1,51 @@
 import { Employee } from '@gusto/embedded-api-v-2025-11-15/models/components/employee';
 import { BaseHookReady, HookLoadingResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Options for {@link useEmployeeProfileSummary}.
+ *
+ * @public
+ */
 export interface UseEmployeeProfileSummaryParams {
+    /** The associated employee identifier. */
     employeeId: string;
 }
-export type UseEmployeeProfileSummaryReady = BaseHookReady<{
+type UseEmployeeProfileSummaryReady = BaseHookReady<{
     employee: Employee;
 }, {
     isFetching: boolean;
     isPending: boolean;
 }>;
+/**
+ * Return type of {@link useEmployeeProfileSummary}.
+ *
+ * @public
+ */
 export type UseEmployeeProfileSummaryResult = HookLoadingResult | UseEmployeeProfileSummaryReady;
 /**
- * Read-only data hook for the Profile management card. Wraps `useEmployeesGet`
- * without `?include=all_compensations` so the basic-details surface fetches
- * only the fields it displays. Mutations live in `useEmployeeDetailsForm`.
+ * Read-only data hook for the basic-details Profile card.
+ *
+ * @remarks
+ * Fetches a single employee record scoped to the fields the
+ * basic-details surface displays. Pair with {@link useEmployeeDetailsForm}
+ * to render an edit form against the same record.
+ *
+ * @param input - See {@link UseEmployeeProfileSummaryParams}.
+ * @returns A {@link HookLoadingResult} while loading, or the ready result with the loaded employee once available.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useEmployeeProfileSummary } from '@gusto/embedded-react-sdk'
+ *
+ * function ProfileSummary({ employeeId }: { employeeId: string }) {
+ *   const summary = useEmployeeProfileSummary({ employeeId })
+ *
+ *   if (summary.isLoading) return <div>Loading...</div>
+ *
+ *   const { employee } = summary.data
+ *   return <h2>{employee.firstName} {employee.lastName}</h2>
+ * }
+ * ```
  */
 export declare function useEmployeeProfileSummary({ employeeId, }: UseEmployeeProfileSummaryParams): UseEmployeeProfileSummaryResult;
+export {};

package/dist/components/Employee/Profile/shared/useEmployeeProfileSummary/useEmployeeProfileSummary.js.map

@@ -1 +1 @@
-{"version":3,"file":"useEmployeeProfileSummary.js","sources":["../../../../../../src/components/Employee/Profile/shared/useEmployeeProfileSummary/useEmployeeProfileSummary.tsx"],"sourcesContent":["import { useEmployeesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport type { Employee } from '@gusto/embedded-api-v-2025-11-15/models/components/employee'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type { BaseHookReady, HookLoadingResult } from '@/partner-hook-utils/types'\n\nexport interface UseEmployeeProfileSummaryParams {\n  employeeId: string\n}\n\nexport type UseEmployeeProfileSummaryReady = BaseHookReady<\n  { employee: Employee },\n  { isFetching: boolean; isPending: boolean }\n>\n\nexport type UseEmployeeProfileSummaryResult = HookLoadingResult | UseEmployeeProfileSummaryReady\n\n/**\n * Read-only data hook for the Profile management card. Wraps `useEmployeesGet`\n * without `?include=all_compensations` so the basic-details surface fetches\n * only the fields it displays. Mutations live in `useEmployeeDetailsForm`.\n */\nexport function useEmployeeProfileSummary({\n  employeeId,\n}: UseEmployeeProfileSummaryParams): UseEmployeeProfileSummaryResult {\n  const employeeQuery = useEmployeesGet({ employeeId }, { staleTime: Infinity })\n\n  const errorHandling = composeErrorHandler([employeeQuery])\n\n  const employee = employeeQuery.data?.employee\n\n  if (employeeQuery.isLoading || !employee) {\n    return { isLoading: true, errorHandling }\n  }\n\n  return {\n    isLoading: false,\n    data: { employee },\n    status: {\n      isFetching: employeeQuery.isFetching,\n      isPending: false,\n    },\n    errorHandling,\n  }\n}\n"],"names":["useEmployeeProfileSummary","employeeId","employeeQuery","useEmployeesGet","errorHandling","composeErrorHandler","employee"],"mappings":";;AAqBO,SAASA,EAA0B;AAAA,EACxC,YAAAC;AACF,GAAqE;AACnE,QAAMC,IAAgBC,EAAgB,EAAE,YAAAF,EAAA,GAAc,EAAE,WAAW,OAAU,GAEvEG,IAAgBC,EAAoB,CAACH,CAAa,CAAC,GAEnDI,IAAWJ,EAAc,MAAM;AAErC,SAAIA,EAAc,aAAa,CAACI,IACvB,EAAE,WAAW,IAAM,eAAAF,EAAA,IAGrB;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,UAAAE,EAAA;AAAA,IACR,QAAQ;AAAA,MACN,YAAYJ,EAAc;AAAA,MAC1B,WAAW;AAAA,IAAA;AAAA,IAEb,eAAAE;AAAA,EAAA;AAEJ;"}
+{"version":3,"file":"useEmployeeProfileSummary.js","sources":["../../../../../../src/components/Employee/Profile/shared/useEmployeeProfileSummary/useEmployeeProfileSummary.tsx"],"sourcesContent":["import { useEmployeesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport type { Employee } from '@gusto/embedded-api-v-2025-11-15/models/components/employee'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type { BaseHookReady, HookLoadingResult } from '@/partner-hook-utils/types'\n\n/**\n * Options for {@link useEmployeeProfileSummary}.\n *\n * @public\n */\nexport interface UseEmployeeProfileSummaryParams {\n  /** The associated employee identifier. */\n  employeeId: string\n}\n\ntype UseEmployeeProfileSummaryReady = BaseHookReady<\n  { employee: Employee },\n  { isFetching: boolean; isPending: boolean }\n>\n\n/**\n * Return type of {@link useEmployeeProfileSummary}.\n *\n * @public\n */\nexport type UseEmployeeProfileSummaryResult = HookLoadingResult | UseEmployeeProfileSummaryReady\n\n/**\n * Read-only data hook for the basic-details Profile card.\n *\n * @remarks\n * Fetches a single employee record scoped to the fields the\n * basic-details surface displays. Pair with {@link useEmployeeDetailsForm}\n * to render an edit form against the same record.\n *\n * @param input - See {@link UseEmployeeProfileSummaryParams}.\n * @returns A {@link HookLoadingResult} while loading, or the ready result with the loaded employee once available.\n * @public\n *\n * @example\n * ```tsx\n * import { useEmployeeProfileSummary } from '@gusto/embedded-react-sdk'\n *\n * function ProfileSummary({ employeeId }: { employeeId: string }) {\n *   const summary = useEmployeeProfileSummary({ employeeId })\n *\n *   if (summary.isLoading) return <div>Loading...</div>\n *\n *   const { employee } = summary.data\n *   return <h2>{employee.firstName} {employee.lastName}</h2>\n * }\n * ```\n */\nexport function useEmployeeProfileSummary({\n  employeeId,\n}: UseEmployeeProfileSummaryParams): UseEmployeeProfileSummaryResult {\n  const employeeQuery = useEmployeesGet({ employeeId }, { staleTime: Infinity })\n\n  const errorHandling = composeErrorHandler([employeeQuery])\n\n  const employee = employeeQuery.data?.employee\n\n  if (employeeQuery.isLoading || !employee) {\n    return { isLoading: true, errorHandling }\n  }\n\n  return {\n    isLoading: false,\n    data: { employee },\n    status: {\n      isFetching: employeeQuery.isFetching,\n      isPending: false,\n    },\n    errorHandling,\n  }\n}\n"],"names":["useEmployeeProfileSummary","employeeId","employeeQuery","useEmployeesGet","errorHandling","composeErrorHandler","employee"],"mappings":";;AAqDO,SAASA,EAA0B;AAAA,EACxC,YAAAC;AACF,GAAqE;AACnE,QAAMC,IAAgBC,EAAgB,EAAE,YAAAF,EAAA,GAAc,EAAE,WAAW,OAAU,GAEvEG,IAAgBC,EAAoB,CAACH,CAAa,CAAC,GAEnDI,IAAWJ,EAAc,MAAM;AAErC,SAAIA,EAAc,aAAa,CAACI,IACvB,EAAE,WAAW,IAAM,eAAAF,EAAA,IAGrB;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,UAAAE,EAAA;AAAA,IACR,QAAQ;AAAA,MACN,YAAYJ,EAAc;AAAA,MAC1B,WAAW;AAAA,IAAA;AAAA,IAEb,eAAAE;AAAA,EAAA;AAEJ;"}

package/dist/components/Employee/Profile/shared/useHomeAddressForm/fields.d.ts

@@ -4,19 +4,149 @@ import { SelectHookFieldProps } from '../../../../../partner-hook-utils/form/fie
 import { CheckboxHookFieldProps } from '../../../../../partner-hook-utils/form/fields/CheckboxHookField';
 import { DatePickerHookFieldProps } from '../../../../../partner-hook-utils/form/fields/DatePickerHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * The required-field error code produced by {@link useHomeAddressForm} fields that only emit `REQUIRED`.
+ *
+ * @remarks
+ * Used as the `validationMessages` key for the street, city, state, courtesy
+ * withholding, and effective date fields. See {@link HomeAddressErrorCodes}.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof HomeAddressErrorCodes.REQUIRED;
+/**
+ * Validation error codes emitted by the `zip` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Use these as keys in `validationMessages` on `Fields.Zip`. See
+ * {@link HomeAddressErrorCodes}.
+ *
+ * @public
+ */
 export type ZipValidation = (typeof HomeAddressErrorCodes)['REQUIRED' | 'INVALID_ZIP'];
+/**
+ * Props accepted by {@link useHomeAddressForm}'s `Fields.Street1` component.
+ *
+ * @public
+ */
 export type Street1FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `street1` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Street1`. Required.
+ *
+ * @param props - {@link Street1FieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `street1`.
+ * @public
+ */
 export declare function Street1Field(props: Street1FieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useHomeAddressForm}'s `Fields.Street2` component.
+ *
+ * @public
+ */
 export type Street2FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `street2` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Street2`. Optional.
+ *
+ * @param props - {@link Street2FieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `street2`.
+ * @public
+ */
 export declare function Street2Field(props: Street2FieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useHomeAddressForm}'s `Fields.City` component.
+ *
+ * @public
+ */
 export type CityFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `city` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.City`. Required.
+ *
+ * @param props - {@link CityFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `city`.
+ * @public
+ */
 export declare function CityField(props: CityFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useHomeAddressForm}'s `Fields.State` component.
+ *
+ * @public
+ */
 export type StateFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, string>>;
+/**
+ * Select bound to the `state` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.State`. Options are the
+ * standard two-letter US state abbreviations. Required.
+ *
+ * @param props - {@link StateFieldProps} — accepts the standard hook field props plus `getOptionLabel` to localize state names.
+ * @returns The rendered select bound to `state`.
+ * @public
+ */
 export declare function StateField(props: StateFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useHomeAddressForm}'s `Fields.Zip` component.
+ *
+ * @public
+ */
 export type ZipFieldProps = HookFieldProps<TextInputHookFieldProps<ZipValidation>>;
+/**
+ * Text input bound to the `zip` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Zip`. Required; also
+ * validates ZIP code format and emits `INVALID_ZIP` when the value does
+ * not match.
+ *
+ * @param props - {@link ZipFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `zip`.
+ * @public
+ */
 export declare function ZipField(props: ZipFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useHomeAddressForm}'s `Fields.CourtesyWithholding` component.
+ *
+ * @public
+ */
 export type CourtesyWithholdingFieldProps = HookFieldProps<CheckboxHookFieldProps<RequiredValidation>>;
+/**
+ * Checkbox bound to the `courtesyWithholding` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.CourtesyWithholding`. When
+ * checked, the employer agrees to withhold the employee's home-state taxes
+ * as a courtesy even when the work and home states differ.
+ *
+ * @param props - {@link CourtesyWithholdingFieldProps} — accepts the standard hook field props (label, description, FieldComponent override).
+ * @returns The rendered checkbox bound to `courtesyWithholding`.
+ * @public
+ */
 export declare function CourtesyWithholdingField(props: CourtesyWithholdingFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useHomeAddressForm}'s `Fields.EffectiveDate` component.
+ *
+ * @public
+ */
 export type EffectiveDateFieldProps = HookFieldProps<DatePickerHookFieldProps<RequiredValidation>>;
+/**
+ * Date picker bound to the `effectiveDate` field of {@link useHomeAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.EffectiveDate` when
+ * `withEffectiveDateField` is `true`; `undefined` otherwise. Always
+ * null-check before rendering.
+ *
+ * @param props - {@link EffectiveDateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered date picker bound to `effectiveDate`.
+ * @public
+ */
 export declare function EffectiveDateField(props: EffectiveDateFieldProps): import("react").JSX.Element;

package/dist/components/Employee/Profile/shared/useHomeAddressForm/fields.js

@@ -1,7 +1,7 @@
 import { jsx as t } from "react/jsx-runtime";
-import { DatePickerHookField as r } from "../../../../../partner-hook-utils/form/fields/DatePickerHookField.js";
-import { CheckboxHookField as n } from "../../../../../partner-hook-utils/form/fields/CheckboxHookField.js";
 import { TextInputHookField as i } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { CheckboxHookField as r } from "../../../../../partner-hook-utils/form/fields/CheckboxHookField.js";
+import { DatePickerHookField as n } from "../../../../../partner-hook-utils/form/fields/DatePickerHookField.js";
 import { SelectHookField as o } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
 function d(e) {
   return /* @__PURE__ */ t(i, { ...e, name: "street1" });
@@ -19,10 +19,10 @@ function k(e) {
   return /* @__PURE__ */ t(i, { ...e, name: "zip" });
 }
 function s(e) {
-  return /* @__PURE__ */ t(n, { ...e, name: "courtesyWithholding" });
+  return /* @__PURE__ */ t(r, { ...e, name: "courtesyWithholding" });
 }
 function h(e) {
-  return /* @__PURE__ */ t(r, { ...e, name: "effectiveDate" });
+  return /* @__PURE__ */ t(n, { ...e, name: "effectiveDate" });
 }
 export {
   F as CityField,

package/dist/components/Employee/Profile/shared/useHomeAddressForm/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Profile/shared/useHomeAddressForm/fields.tsx"],"sourcesContent":["import type { HomeAddressErrorCodes } from './homeAddressSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport {\n  TextInputHookField,\n  SelectHookField,\n  CheckboxHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof HomeAddressErrorCodes.REQUIRED\nexport type ZipValidation = (typeof HomeAddressErrorCodes)['REQUIRED' | 'INVALID_ZIP']\n\nexport type Street1FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function Street1Field(props: Street1FieldProps) {\n  return <TextInputHookField {...props} name=\"street1\" />\n}\n\nexport type Street2FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function Street2Field(props: Street2FieldProps) {\n  return <TextInputHookField {...props} name=\"street2\" />\n}\n\nexport type CityFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function CityField(props: CityFieldProps) {\n  return <TextInputHookField {...props} name=\"city\" />\n}\n\nexport type StateFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, string>>\n\nexport function StateField(props: StateFieldProps) {\n  return <SelectHookField {...props} name=\"state\" />\n}\n\nexport type ZipFieldProps = HookFieldProps<TextInputHookFieldProps<ZipValidation>>\n\nexport function ZipField(props: ZipFieldProps) {\n  return <TextInputHookField {...props} name=\"zip\" />\n}\n\nexport type CourtesyWithholdingFieldProps = HookFieldProps<\n  CheckboxHookFieldProps<RequiredValidation>\n>\n\nexport function CourtesyWithholdingField(props: CourtesyWithholdingFieldProps) {\n  return <CheckboxHookField {...props} name=\"courtesyWithholding\" />\n}\n\nexport type EffectiveDateFieldProps = HookFieldProps<DatePickerHookFieldProps<RequiredValidation>>\n\nexport function EffectiveDateField(props: EffectiveDateFieldProps) {\n  return <DatePickerHookField {...props} name=\"effectiveDate\" />\n}\n"],"names":["Street1Field","props","jsx","TextInputHookField","Street2Field","CityField","StateField","SelectHookField","ZipField","CourtesyWithholdingField","CheckboxHookField","EffectiveDateField","DatePickerHookField"],"mappings":";;;;;AAkBO,SAASA,EAAaC,GAA0B;AACrD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,WAAU;AACvD;AAIO,SAASG,EAAaH,GAA0B;AACrD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,WAAU;AACvD;AAIO,SAASI,EAAUJ,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,QAAO;AACpD;AAIO,SAASK,EAAWL,GAAwB;AACjD,SAAO,gBAAAC,EAACK,GAAA,EAAiB,GAAGN,GAAO,MAAK,SAAQ;AAClD;AAIO,SAASO,EAASP,GAAsB;AAC7C,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,OAAM;AACnD;AAMO,SAASQ,EAAyBR,GAAsC;AAC7E,SAAO,gBAAAC,EAACQ,GAAA,EAAmB,GAAGT,GAAO,MAAK,uBAAsB;AAClE;AAIO,SAASU,EAAmBV,GAAgC;AACjE,SAAO,gBAAAC,EAACU,GAAA,EAAqB,GAAGX,GAAO,MAAK,iBAAgB;AAC9D;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Profile/shared/useHomeAddressForm/fields.tsx"],"sourcesContent":["import type { HomeAddressErrorCodes } from './homeAddressSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport {\n  TextInputHookField,\n  SelectHookField,\n  CheckboxHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\n/**\n * The required-field error code produced by {@link useHomeAddressForm} fields that only emit `REQUIRED`.\n *\n * @remarks\n * Used as the `validationMessages` key for the street, city, state, courtesy\n * withholding, and effective date fields. See {@link HomeAddressErrorCodes}.\n *\n * @public\n */\nexport type RequiredValidation = typeof HomeAddressErrorCodes.REQUIRED\n\n/**\n * Validation error codes emitted by the `zip` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.Zip`. See\n * {@link HomeAddressErrorCodes}.\n *\n * @public\n */\nexport type ZipValidation = (typeof HomeAddressErrorCodes)['REQUIRED' | 'INVALID_ZIP']\n\n/**\n * Props accepted by {@link useHomeAddressForm}'s `Fields.Street1` component.\n *\n * @public\n */\nexport type Street1FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `street1` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Street1`. Required.\n *\n * @param props - {@link Street1FieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `street1`.\n * @public\n */\nexport function Street1Field(props: Street1FieldProps) {\n  return <TextInputHookField {...props} name=\"street1\" />\n}\n\n/**\n * Props accepted by {@link useHomeAddressForm}'s `Fields.Street2` component.\n *\n * @public\n */\nexport type Street2FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `street2` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Street2`. Optional.\n *\n * @param props - {@link Street2FieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `street2`.\n * @public\n */\nexport function Street2Field(props: Street2FieldProps) {\n  return <TextInputHookField {...props} name=\"street2\" />\n}\n\n/**\n * Props accepted by {@link useHomeAddressForm}'s `Fields.City` component.\n *\n * @public\n */\nexport type CityFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `city` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.City`. Required.\n *\n * @param props - {@link CityFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `city`.\n * @public\n */\nexport function CityField(props: CityFieldProps) {\n  return <TextInputHookField {...props} name=\"city\" />\n}\n\n/**\n * Props accepted by {@link useHomeAddressForm}'s `Fields.State` component.\n *\n * @public\n */\nexport type StateFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, string>>\n\n/**\n * Select bound to the `state` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.State`. Options are the\n * standard two-letter US state abbreviations. Required.\n *\n * @param props - {@link StateFieldProps} — accepts the standard hook field props plus `getOptionLabel` to localize state names.\n * @returns The rendered select bound to `state`.\n * @public\n */\nexport function StateField(props: StateFieldProps) {\n  return <SelectHookField {...props} name=\"state\" />\n}\n\n/**\n * Props accepted by {@link useHomeAddressForm}'s `Fields.Zip` component.\n *\n * @public\n */\nexport type ZipFieldProps = HookFieldProps<TextInputHookFieldProps<ZipValidation>>\n\n/**\n * Text input bound to the `zip` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Zip`. Required; also\n * validates ZIP code format and emits `INVALID_ZIP` when the value does\n * not match.\n *\n * @param props - {@link ZipFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `zip`.\n * @public\n */\nexport function ZipField(props: ZipFieldProps) {\n  return <TextInputHookField {...props} name=\"zip\" />\n}\n\n/**\n * Props accepted by {@link useHomeAddressForm}'s `Fields.CourtesyWithholding` component.\n *\n * @public\n */\nexport type CourtesyWithholdingFieldProps = HookFieldProps<\n  CheckboxHookFieldProps<RequiredValidation>\n>\n\n/**\n * Checkbox bound to the `courtesyWithholding` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.CourtesyWithholding`. When\n * checked, the employer agrees to withhold the employee's home-state taxes\n * as a courtesy even when the work and home states differ.\n *\n * @param props - {@link CourtesyWithholdingFieldProps} — accepts the standard hook field props (label, description, FieldComponent override).\n * @returns The rendered checkbox bound to `courtesyWithholding`.\n * @public\n */\nexport function CourtesyWithholdingField(props: CourtesyWithholdingFieldProps) {\n  return <CheckboxHookField {...props} name=\"courtesyWithholding\" />\n}\n\n/**\n * Props accepted by {@link useHomeAddressForm}'s `Fields.EffectiveDate` component.\n *\n * @public\n */\nexport type EffectiveDateFieldProps = HookFieldProps<DatePickerHookFieldProps<RequiredValidation>>\n\n/**\n * Date picker bound to the `effectiveDate` field of {@link useHomeAddressForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.EffectiveDate` when\n * `withEffectiveDateField` is `true`; `undefined` otherwise. Always\n * null-check before rendering.\n *\n * @param props - {@link EffectiveDateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered date picker bound to `effectiveDate`.\n * @public\n */\nexport function EffectiveDateField(props: EffectiveDateFieldProps) {\n  return <DatePickerHookField {...props} name=\"effectiveDate\" />\n}\n"],"names":["Street1Field","props","jsx","TextInputHookField","Street2Field","CityField","StateField","SelectHookField","ZipField","CourtesyWithholdingField","CheckboxHookField","EffectiveDateField","DatePickerHookField"],"mappings":";;;;;AAoDO,SAASA,EAAaC,GAA0B;AACrD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,WAAU;AACvD;AAmBO,SAASG,EAAaH,GAA0B;AACrD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,WAAU;AACvD;AAmBO,SAASI,EAAUJ,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,QAAO;AACpD;AAoBO,SAASK,EAAWL,GAAwB;AACjD,SAAO,gBAAAC,EAACK,GAAA,EAAiB,GAAGN,GAAO,MAAK,SAAQ;AAClD;AAqBO,SAASO,EAASP,GAAsB;AAC7C,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,OAAM;AACnD;AAuBO,SAASQ,EAAyBR,GAAsC;AAC7E,SAAO,gBAAAC,EAACQ,GAAA,EAAmB,GAAGT,GAAO,MAAK,uBAAsB;AAClE;AAqBO,SAASU,EAAmBV,GAAgC;AACjE,SAAO,gBAAAC,EAACU,GAAA,EAAqB,GAAGX,GAAO,MAAK,iBAAgB;AAC9D;"}

package/dist/components/Employee/Profile/shared/useHomeAddressForm/homeAddressSchema.d.ts

@@ -1,9 +1,21 @@
 import { z } from 'zod';
 import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes emitted by the home address form schema. Map these
+ * codes to localized copy in `validationMessages` when composing the hook.
+ *
+ * @public
+ */
 export declare const HomeAddressErrorCodes: {
     readonly REQUIRED: "REQUIRED";
     readonly INVALID_ZIP: "INVALID_ZIP";
 };
+/**
+ * Union of validation error code strings emitted by the home address form
+ * schema.
+ *
+ * @public
+ */
 export type HomeAddressErrorCode = (typeof HomeAddressErrorCodes)[keyof typeof HomeAddressErrorCodes];
 declare const fieldValidators: {
     street1: z.ZodString;
@@ -14,20 +26,43 @@ declare const fieldValidators: {
     courtesyWithholding: z.ZodBoolean;
     effectiveDate: z.ZodISODate;
 };
+/**
+ * Field names accepted by the home address form.
+ *
+ * @public
+ */
 export type HomeAddressField = keyof typeof fieldValidators;
+/**
+ * Shape of the values managed by the home address form.
+ *
+ * @public
+ */
 export type HomeAddressFormData = {
     [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
 };
+/**
+ * Shape of the validated values produced by the home address form on submit.
+ *
+ * @public
+ */
 export type HomeAddressFormOutputs = HomeAddressFormData;
 declare const requiredFieldsConfig: {
     street2: "never";
 };
+/**
+ * Keys of optional home address fields that can be promoted to required via
+ * the hook's `optionalFieldsToRequire` option.
+ *
+ * @public
+ */
 export type HomeAddressOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+/** @internal */
 interface HomeAddressSchemaOptions {
     mode?: 'create' | 'update';
     optionalFieldsToRequire?: HomeAddressOptionalFieldsToRequire;
     withEffectiveDateField?: boolean;
 }
+/** @internal */
 export declare function createHomeAddressSchema(options?: HomeAddressSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
     street1: z.ZodString;
     street2: z.ZodString;