npm - @gusto/embedded-react-sdk - Versions diffs - 0.47.0 → 0.48.0 - Mend

@gusto/embedded-react-sdk 0.47.0 → 0.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (850) hide show

package/dist/components/Employee/Profile/shared/useWorkAddressForm/fields.d.ts CHANGED Viewed

@@ -3,8 +3,51 @@ import { WorkAddressErrorCodes } from './workAddressSchema';
 import { SelectHookFieldProps } from '../../../../../partner-hook-utils/form/fields/SelectHookField';
 import { DatePickerHookFieldProps } from '../../../../../partner-hook-utils/form/fields/DatePickerHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * The required-field error code produced by {@link useWorkAddressForm} fields that only emit `REQUIRED`.
+ *
+ * @remarks
+ * Used as the `validationMessages` key for the location and effective date fields.
+ * See `WorkAddressErrorCodes`.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof WorkAddressErrorCodes.REQUIRED;
+/**
+ * Props accepted by {@link useWorkAddressForm}'s `Fields.Location` component.
+ *
+ * @public
+ */
 export type LocationFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, Location>>;
+/**
+ * Select bound to the `locationUuid` field of {@link useWorkAddressForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Location`. Options are the
+ * company's active locations; the hook populates them from the locations
+ * query. Required.
+ *
+ * @param props - {@link LocationFieldProps} — accepts the standard hook field props plus `getOptionLabel` to format location display names.
+ * @returns The rendered select bound to `locationUuid`.
+ * @public
+ */
 export declare function LocationField(props: LocationFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useWorkAddressForm}'s `Fields.EffectiveDate` component.
+ *
+ * @public
+ */
 export type EffectiveDateFieldProps = HookFieldProps<DatePickerHookFieldProps<RequiredValidation>>;
+/**
+ * Date picker bound to the `effectiveDate` field of {@link useWorkAddressForm}.
+ *
+ * @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/useWorkAddressForm/fields.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/fields.tsx"],"sourcesContent":["import type { Location } from '@gusto/embedded-api-v-2025-11-15/models/components/location'\nimport type { WorkAddressErrorCodes } from './workAddressSchema'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport { SelectHookField, DatePickerHookField } from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof WorkAddressErrorCodes.REQUIRED\n\nexport type LocationFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, Location>>\n\nexport function LocationField(props: LocationFieldProps) {\n return <SelectHookField {...props} name=\"locationUuid\" />\n}\n\nexport type EffectiveDateFieldProps = HookFieldProps<DatePickerHookFieldProps<RequiredValidation>>\n\nexport function EffectiveDateField(props: EffectiveDateFieldProps) {\n return <DatePickerHookField {...props} name=\"effectiveDate\" />\n}\n"],"names":["LocationField","props","jsx","SelectHookField","EffectiveDateField","DatePickerHookField"],"mappings":";;;~~AAWO~~,SAASA,EAAcC,GAA2B;AACvD,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,gBAAe;AACzD;~~AAIO~~,SAASG,EAAmBH,GAAgC;AACjE,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,iBAAgB;AAC9D;"}
1	+ {"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/fields.tsx"],"sourcesContent":["import type { Location } from '@gusto/embedded-api-v-2025-11-15/models/components/location'\nimport type { WorkAddressErrorCodes } from './workAddressSchema'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport { SelectHookField, DatePickerHookField } 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 useWorkAddressForm} fields that only emit `REQUIRED`.\n \n @remarks\n * Used as the `validationMessages` key for the location and effective date fields.\n * See `WorkAddressErrorCodes`.\n \n @public\n /\nexport type RequiredValidation = typeof WorkAddressErrorCodes.REQUIRED\n\n/\n Props accepted by {@link useWorkAddressForm}'s `Fields.Location` component.\n \n @public\n /\nexport type LocationFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, Location>>\n\n/\n Select bound to the `locationUuid` field of {@link useWorkAddressForm}.\n \n @remarks\n * Available on the hook result as `form.Fields.Location`. Options are the\n * company's active locations; the hook populates them from the locations\n * query. Required.\n \n @param props - {@link LocationFieldProps} — accepts the standard hook field props plus `getOptionLabel` to format location display names.\n * @returns The rendered select bound to `locationUuid`.\n * @public\n /\nexport function LocationField(props: LocationFieldProps) {\n return <SelectHookField {...props} name=\"locationUuid\" />\n}\n\n/\n Props accepted by {@link useWorkAddressForm}'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 useWorkAddressForm}.\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":["LocationField","props","jsx","SelectHookField","EffectiveDateField","DatePickerHookField"],"mappings":";;;AAqCO,SAASA,EAAcC,GAA2B;AACvD,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,gBAAe;AACzD;AAqBO,SAASG,EAAmBH,GAAgC;AACjE,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,iBAAgB;AAC9D;"}

package/dist/components/Employee/Profile/shared/useWorkAddressForm/index.d.ts CHANGED Viewed

@@ -2,6 +2,7 @@ import "./types/i18next.d.ts"
 export { useWorkAddressForm } from './useWorkAddressForm';
 export { useCurrentWorkAddressForm } from './useCurrentWorkAddressForm';
 export type { UseCurrentWorkAddressFormProps } from './useCurrentWorkAddressForm';
-export type { WorkAddressSubmitCallbacks, WorkAddressSubmitOptions, WorkAddressOptionalFieldsToRequire, UseWorkAddressFormProps, UseWorkAddressFormResult, UseWorkAddressFormReady, WorkAddressFieldsMetadata, WorkAddressFormFields, } from './useWorkAddressForm';
+export type { WorkAddressSubmitCallbacks, WorkAddressSubmitOptions, WorkAddressOptionalFieldsToRequire, UseWorkAddressFormProps, UseWorkAddressFormResult, UseWorkAddressFormReady, WorkAddressFieldsMetadata, WorkAddressFormFields, WorkAddressFields, } from './useWorkAddressForm';
 export { createWorkAddressSchema, WorkAddressErrorCodes, type WorkAddressErrorCode, type WorkAddressFormData, type WorkAddressFormOutputs, type WorkAddressField, } from './workAddressSchema';
+export { LocationField, EffectiveDateField } from './fields';
 export type { RequiredValidation as WorkAddressRequiredValidation, LocationFieldProps, EffectiveDateFieldProps, } from './fields';

package/dist/components/Employee/Profile/shared/useWorkAddressForm/useCurrentWorkAddressForm.d.ts CHANGED Viewed

@@ -1,3 +1,45 @@
 import { UseWorkAddressFormProps, UseWorkAddressFormResult } from './useWorkAddressForm';
+/**
+ * Options for {@link useCurrentWorkAddressForm}.
+ *
+ * @remarks
+ * Same shape as {@link UseWorkAddressFormProps} minus `workAddressUuid` —
+ * the hook resolves the current work address itself.
+ *
+ * @public
+ */
 export type UseCurrentWorkAddressFormProps = Omit<UseWorkAddressFormProps, 'workAddressUuid'>;
+/**
+ * Convenience wrapper around {@link useWorkAddressForm} that auto-resolves the employee's current work address.
+ *
+ * @remarks
+ * Lists the employee's work addresses and selects the active one (or the
+ * first when none are active) as the row to edit. When the employee has no
+ * work address on file the hook operates in create mode. The returned shape
+ * is identical to {@link useWorkAddressForm}, so the same `Fields`,
+ * `actions.onSubmit`, and `errorHandling` apply.
+ *
+ * @param props - See {@link UseCurrentWorkAddressFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UseWorkAddressFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useCurrentWorkAddressForm } from '@gusto/embedded-react-sdk'
+ *
+ * function WorkAddressEditor({ employeeId, companyId }: { employeeId: string; companyId: string }) {
+ *   const workAddress = useCurrentWorkAddressForm({ employeeId, companyId })
+ *
+ *   if (workAddress.isLoading) return <div>Loading...</div>
+ *
+ *   const { Fields } = workAddress.form
+ *   return (
+ *     <form onSubmit={e => { e.preventDefault(); void workAddress.actions.onSubmit() }}>
+ *       <Fields.Location label="Work location" />
+ *       <button type="submit">Save</button>
+ *     </form>
+ *   )
+ * }
+ * ```
+ */
 export declare function useCurrentWorkAddressForm(props: UseCurrentWorkAddressFormProps): UseWorkAddressFormResult;

package/dist/components/Employee/Profile/shared/useWorkAddressForm/useCurrentWorkAddressForm.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"useCurrentWorkAddressForm.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/useCurrentWorkAddressForm.tsx"],"sourcesContent":["import { useEmployeeAddressesGetWorkAddresses } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesGetWorkAddresses'\nimport { useWorkAddressForm } from './useWorkAddressForm'\nimport type { UseWorkAddressFormProps, UseWorkAddressFormResult } from './useWorkAddressForm'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\n\nexport type UseCurrentWorkAddressFormProps = Omit<UseWorkAddressFormProps, 'workAddressUuid'>\n\nexport function useCurrentWorkAddressForm(\n props: UseCurrentWorkAddressFormProps,\n): UseWorkAddressFormResult {\n const { employeeId, ...rest } = props\n\n const listQuery = useEmployeeAddressesGetWorkAddresses({ employeeId }, { enabled: !!employeeId })\n\n const workAddresses = listQuery.data?.employeeWorkAddressesList\n const currentWorkAddress = workAddresses?.find(w => w.active) ?? workAddresses?.[0]\n\n const base = useWorkAddressForm({\n ...rest,\n employeeId,\n workAddressUuid: currentWorkAddress?.uuid,\n })\n\n const listInitiallyBlocking = listQuery.isLoading && !listQuery.data\n\n if (listInitiallyBlocking) {\n return {\n isLoading: true as const,\n errorHandling: composeErrorHandler([listQuery]),\n }\n }\n\n if (base.isLoading) {\n return {\n ...base,\n errorHandling: composeErrorHandler([listQuery, { errorHandling: base.errorHandling }]),\n }\n }\n\n return {\n ...base,\n errorHandling: composeErrorHandler([listQuery, { errorHandling: base.errorHandling }]),\n }\n}\n"],"names":["useCurrentWorkAddressForm","props","employeeId","rest","listQuery","useEmployeeAddressesGetWorkAddresses","workAddresses","currentWorkAddress","w","base","useWorkAddressForm","composeErrorHandler"],"mappings":";;;~~AAOO~~,SAASA,EACdC,GAC0B;AAC1B,QAAM,EAAE,YAAAC,GAAY,GAAGC,EAAA,IAASF,GAE1BG,IAAYC,EAAqC,EAAE,YAAAH,EAAA,GAAc,EAAE,SAAS,CAAC,CAACA,GAAY,GAE1FI,IAAgBF,EAAU,MAAM,2BAChCG,IAAqBD,GAAe,KAAK,CAAAE,MAAKA,EAAE,MAAM,KAAKF,IAAgB,CAAC,GAE5EG,IAAOC,EAAmB;AAAA,IAC9B,GAAGP;AAAA,IACH,YAAAD;AAAA,IACA,iBAAiBK,GAAoB;AAAA,EAAA,CACtC;AAID,SAF8BH,EAAU,aAAa,CAACA,EAAU,OAGvD;AAAA,IACL,WAAW;AAAA,IACX,eAAeO,EAAoB,CAACP,CAAS,CAAC;AAAA,EAAA,IAI9CK,EAAK,YACA;AAAA,IACL,GAAGA;AAAA,IACH,eAAeE,EAAoB,CAACP,GAAW,EAAE,eAAeK,EAAK,eAAe,CAAC;AAAA,EAAA,IAIlF;AAAA,IACL,GAAGA;AAAA,IACH,eAAeE,EAAoB,CAACP,GAAW,EAAE,eAAeK,EAAK,eAAe,CAAC;AAAA,EAAA;AAEzF;"}
1	+ {"version":3,"file":"useCurrentWorkAddressForm.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/useCurrentWorkAddressForm.tsx"],"sourcesContent":["import { useEmployeeAddressesGetWorkAddresses } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesGetWorkAddresses'\nimport { useWorkAddressForm } from './useWorkAddressForm'\nimport type { UseWorkAddressFormProps, UseWorkAddressFormResult } from './useWorkAddressForm'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\n\n/*\n Options for {@link useCurrentWorkAddressForm}.\n \n @remarks\n * Same shape as {@link UseWorkAddressFormProps} minus `workAddressUuid` —\n * the hook resolves the current work address itself.\n \n @public\n /\nexport type UseCurrentWorkAddressFormProps = Omit<UseWorkAddressFormProps, 'workAddressUuid'>\n\n/\n Convenience wrapper around {@link useWorkAddressForm} that auto-resolves the employee's current work address.\n \n @remarks\n * Lists the employee's work addresses and selects the active one (or the\n * first when none are active) as the row to edit. When the employee has no\n * work address on file the hook operates in create mode. The returned shape\n * is identical to {@link useWorkAddressForm}, so the same `Fields`,\n * `actions.onSubmit`, and `errorHandling` apply.\n \n @param props - See {@link UseCurrentWorkAddressFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UseWorkAddressFormReady} once ready.\n * @public\n \n @example\n * ```tsx\n * import { useCurrentWorkAddressForm } from '@gusto/embedded-react-sdk'\n \n function WorkAddressEditor({ employeeId, companyId }: { employeeId: string; companyId: string }) {\n * const workAddress = useCurrentWorkAddressForm({ employeeId, companyId })\n \n if (workAddress.isLoading) return <div>Loading...</div>\n \n const { Fields } = workAddress.form\n * return (\n * <form onSubmit={e => { e.preventDefault(); void workAddress.actions.onSubmit() }}>\n * <Fields.Location label=\"Work location\" />\n * <button type=\"submit\">Save</button>\n * </form>\n * )\n * }\n * ```\n */\nexport function useCurrentWorkAddressForm(\n props: UseCurrentWorkAddressFormProps,\n): UseWorkAddressFormResult {\n const { employeeId, ...rest } = props\n\n const listQuery = useEmployeeAddressesGetWorkAddresses({ employeeId }, { enabled: !!employeeId })\n\n const workAddresses = listQuery.data?.employeeWorkAddressesList\n const currentWorkAddress = workAddresses?.find(w => w.active) ?? workAddresses?.[0]\n\n const base = useWorkAddressForm({\n ...rest,\n employeeId,\n workAddressUuid: currentWorkAddress?.uuid,\n })\n\n const listInitiallyBlocking = listQuery.isLoading && !listQuery.data\n\n if (listInitiallyBlocking) {\n return {\n isLoading: true as const,\n errorHandling: composeErrorHandler([listQuery]),\n }\n }\n\n if (base.isLoading) {\n return {\n ...base,\n errorHandling: composeErrorHandler([listQuery, { errorHandling: base.errorHandling }]),\n }\n }\n\n return {\n ...base,\n errorHandling: composeErrorHandler([listQuery, { errorHandling: base.errorHandling }]),\n }\n}\n"],"names":["useCurrentWorkAddressForm","props","employeeId","rest","listQuery","useEmployeeAddressesGetWorkAddresses","workAddresses","currentWorkAddress","w","base","useWorkAddressForm","composeErrorHandler"],"mappings":";;;AAiDO,SAASA,EACdC,GAC0B;AAC1B,QAAM,EAAE,YAAAC,GAAY,GAAGC,EAAA,IAASF,GAE1BG,IAAYC,EAAqC,EAAE,YAAAH,EAAA,GAAc,EAAE,SAAS,CAAC,CAACA,GAAY,GAE1FI,IAAgBF,EAAU,MAAM,2BAChCG,IAAqBD,GAAe,KAAK,CAAAE,MAAKA,EAAE,MAAM,KAAKF,IAAgB,CAAC,GAE5EG,IAAOC,EAAmB;AAAA,IAC9B,GAAGP;AAAA,IACH,YAAAD;AAAA,IACA,iBAAiBK,GAAoB;AAAA,EAAA,CACtC;AAID,SAF8BH,EAAU,aAAa,CAACA,EAAU,OAGvD;AAAA,IACL,WAAW;AAAA,IACX,eAAeO,EAAoB,CAACP,CAAS,CAAC;AAAA,EAAA,IAI9CK,EAAK,YACA;AAAA,IACL,GAAGA;AAAA,IACH,eAAeE,EAAoB,CAACP,GAAW,EAAE,eAAeK,EAAK,eAAe,CAAC;AAAA,EAAA,IAIlF;AAAA,IACL,GAAGA;AAAA,IACH,eAAeE,EAAoB,CAACP,GAAW,EAAE,eAAeK,EAAK,eAAe,CAAC;AAAA,EAAA;AAEzF;"}

package/dist/components/Employee/Profile/shared/useWorkAddressForm/useWorkAddressForm.d.ts CHANGED Viewed

@@ -5,17 +5,46 @@ import { WorkAddressOptionalFieldsToRequire, WorkAddressFormData } from './workA
 import { LocationField, EffectiveDateField } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
 export type { WorkAddressOptionalFieldsToRequire } from './workAddressSchema';
+/**
+ * Optional callbacks passed to {@link UseWorkAddressFormReady.actions.onSubmit | onSubmit}.
+ *
+ * @remarks
+ * Only the callback matching the submit mode fires —
+ * `onWorkAddressCreated` on create, `onWorkAddressUpdated` on update.
+ *
+ * @public
+ */
 export interface WorkAddressSubmitCallbacks {
+    /** Fired after a new work address is successfully created. */
     onWorkAddressCreated?: (workAddress: EmployeeWorkAddress) => void;
+    /** Fired after an existing work address is successfully updated. */
     onWorkAddressUpdated?: (workAddress: EmployeeWorkAddress) => void;
 }
+/**
+ * Optional overrides passed to {@link UseWorkAddressFormReady.actions.onSubmit | onSubmit}.
+ *
+ * @public
+ */
 export interface WorkAddressSubmitOptions {
+    /** Override the employee identifier supplied to the hook (e.g. after creating a new employee in the same flow). */
     employeeId?: string;
+    /** Override the effective date submitted with the address. */
     effectiveDate?: string;
 }
+/**
+ * Configuration options for {@link useWorkAddressForm}.
+ *
+ * @remarks
+ * Presence or absence of `workAddressUuid` selects the API verb — see the
+ * `workAddressUuid` field description. `companyId` is required to fetch
+ * the location list; pass it when it is known.
+ *
+ * @public
+ */
 export interface UseWorkAddressFormProps {
     /** Company UUID for locations; omit or leave unset while resolving from the employee record. */
     companyId?: string;
+    /** UUID of the employee whose work address is being created or edited. */
     employeeId: string;
     /**
      * When set, loads that work address via GET `/v1/work_addresses/{work_address_uuid}` and updates it (PUT).
@@ -27,31 +56,87 @@ export interface UseWorkAddressFormProps {
      * instead of issuing a GET — useful when the parent already has the row from a list query.
      */
     initialAddress?: EmployeeWorkAddress;
+    /** When `true`, renders `Fields.EffectiveDate`; otherwise it is `undefined`. Defaults to `true`. */
     withEffectiveDateField?: boolean;
+    /** Override fields that are optional on a given mode to be required. See `WorkAddressOptionalFieldsToRequire`. */
     optionalFieldsToRequire?: WorkAddressOptionalFieldsToRequire;
+    /** Pre-fill form values. Server data takes precedence on update. */
     defaultValues?: Partial<WorkAddressFormData>;
+    /** 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 `useWorkAddressForm().form.Fields`.
+ *
+ * @remarks
+ * `EffectiveDate` is `undefined` when `withEffectiveDateField` is `false`.
+ * Always null-check it before rendering.
+ *
+ * @public
+ */
 export interface WorkAddressFields {
+    /** Location selector. Always available. */
     Location: typeof LocationField;
+    /** Effective-date picker. Only available when `withEffectiveDateField` is `true`. */
     EffectiveDate: typeof EffectiveDateField | undefined;
 }
+/**
+ * Ready-state shape returned by {@link useWorkAddressForm} once data has loaded.
+ *
+ * @remarks
+ * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with
+ * the work-address-specific `data`, `status`, `actions`, and `form.Fields` shape.
+ *
+ * @public
+ */
 export interface UseWorkAddressFormReady extends BaseFormHookReady<FieldsMetadata, WorkAddressFormData, WorkAddressFields> {
+    /** Static entity data resolved from the API. */
     data: {
         /** The address row loaded for update; `null` in create mode. */
         workAddress: EmployeeWorkAddress | null;
+        /** Company locations available for selection; `undefined` until the locations query resolves. */
         companyLocations: Location[] | undefined;
     };
+    /** Reactive status flags. */
     status: {
         isPending: boolean;
         mode: 'create' | 'update';
     };
+    /** Available actions. */
     actions: {
         onSubmit: (callbacks?: WorkAddressSubmitCallbacks, options?: WorkAddressSubmitOptions) => Promise<HookSubmitResult<EmployeeWorkAddress> | undefined>;
     };
 }
+/**
+ * Form hook for creating or editing an employee's work address.
+ *
+ * @remarks
+ * When `workAddressUuid` is supplied the hook loads that address and issues a PUT on submit;
+ * when omitted it operates in create mode and issues a POST. The hook requires `companyId`
+ * to fetch the company's location list — it stays in loading state until `companyId` is known.
+ *
+ * @param props - See {@link UseWorkAddressFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UseWorkAddressFormReady} once ready.
+ * @public
+ */
 export declare function useWorkAddressForm({ companyId, employeeId, workAddressUuid, initialAddress, withEffectiveDateField, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseWorkAddressFormProps): HookLoadingResult | UseWorkAddressFormReady;
+/**
+ * Discriminated union returned by {@link useWorkAddressForm}.
+ *
+ * @public
+ */
 export type UseWorkAddressFormResult = HookLoadingResult | UseWorkAddressFormReady;
+/**
+ * Type of `form.fieldsMetadata` returned by {@link useWorkAddressForm}.
+ *
+ * @public
+ */
 export type WorkAddressFieldsMetadata = UseWorkAddressFormReady['form']['fieldsMetadata'];
+/**
+ * Type of `form.Fields` returned by {@link useWorkAddressForm}.
+ *
+ * @public
+ */
 export type WorkAddressFormFields = UseWorkAddressFormReady['form']['Fields'];

package/dist/components/Employee/Profile/shared/useWorkAddressForm/useWorkAddressForm.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"useWorkAddressForm.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/useWorkAddressForm.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 { Location } from '@gusto/embedded-api-v-2025-11-15/models/components/location'\nimport type { EmployeeWorkAddress } from '@gusto/embedded-api-v-2025-11-15/models/components/employeeworkaddress'\nimport { useLocationsGet } from '@gusto/embedded-api-v-2025-11-15/react-query/locationsGet'\nimport { useEmployeeAddressesRetrieveWorkAddress } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesRetrieveWorkAddress'\nimport { useEmployeeAddressesCreateWorkAddressMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesCreateWorkAddress'\nimport { useEmployeeAddressesUpdateWorkAddressMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesUpdateWorkAddress'\nimport { RFCDate } from '@gusto/embedded-api-v-2025-11-15/types/rfcdate'\nimport {\n createWorkAddressSchema,\n type WorkAddressOptionalFieldsToRequire,\n type WorkAddressFormData,\n type WorkAddressFormOutputs,\n} from './workAddressSchema'\nimport { LocationField, EffectiveDateField } from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { withOptions } from '@/partner-hook-utils/form/withOptions'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n BaseFormHookReady,\n FieldsMetadata,\n HookLoadingResult,\n HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\nimport { addressInline } from '@/helpers/formattedStrings'\n\nexport type { WorkAddressOptionalFieldsToRequire } from './workAddressSchema'\n\nexport interface WorkAddressSubmitCallbacks {\n onWorkAddressCreated?: (workAddress: EmployeeWorkAddress) => void\n onWorkAddressUpdated?: (workAddress: EmployeeWorkAddress) => void\n}\n\nexport interface WorkAddressSubmitOptions {\n employeeId?: string\n effectiveDate?: string\n}\n\nexport interface UseWorkAddressFormProps {\n /** Company UUID for locations; omit or leave unset while resolving from the employee record. /\n companyId?: string\n employeeId: string\n /\n When set, loads that work address via GET `/v1/work_addresses/{work_address_uuid}` and updates it (PUT).\n * When omitted, the form is in create mode (POST).\n /\n workAddressUuid?: string\n /\n Pre-loaded address matching `workAddressUuid`. When supplied, the form uses it directly\n * instead of issuing a GET — useful when the parent already has the row from a list query.\n /\n initialAddress?: EmployeeWorkAddress\n withEffectiveDateField?: boolean\n optionalFieldsToRequire?: WorkAddressOptionalFieldsToRequire\n defaultValues?: Partial<WorkAddressFormData>\n validationMode?: UseFormProps['mode']\n shouldFocusError?: boolean\n}\n\nexport interface WorkAddressFields {\n Location: typeof LocationField\n EffectiveDate: typeof EffectiveDateField \| undefined\n}\n\nexport interface UseWorkAddressFormReady extends BaseFormHookReady<\n FieldsMetadata,\n WorkAddressFormData,\n WorkAddressFields\n> {\n data: {\n /* The address row loaded for update; `null` in create mode. */\n workAddress: EmployeeWorkAddress \| null\n companyLocations: Location[] \| undefined\n }\n status: { isPending: boolean; mode: 'create' \| 'update' }\n actions: {\n onSubmit: (\n callbacks?: WorkAddressSubmitCallbacks,\n options?: WorkAddressSubmitOptions,\n ) => Promise<HookSubmitResult<EmployeeWorkAddress> \| undefined>\n }\n}\n\nexport function useWorkAddressForm({\n companyId,\n employeeId,\n workAddressUuid,\n initialAddress,\n withEffectiveDateField = true,\n optionalFieldsToRequire,\n defaultValues: partnerDefaults,\n validationMode = 'onSubmit',\n shouldFocusError = true,\n}: UseWorkAddressFormProps): HookLoadingResult \| UseWorkAddressFormReady {\n const locationsQuery = useLocationsGet({ companyId: companyId ?? '' }, { enabled: !!companyId })\n\n const hasInitialAddressMatch = !!workAddressUuid && initialAddress?.uuid === workAddressUuid\n\n const retrieveWorkAddressQuery = useEmployeeAddressesRetrieveWorkAddress(\n { workAddressUuid: workAddressUuid ?? '' },\n { enabled: !!workAddressUuid && !hasInitialAddressMatch },\n )\n\n const companyLocations = locationsQuery.data?.companyLocationsList\n\n const isCreateMode = !workAddressUuid\n\n const fetchedWorkAddress = workAddressUuid\n ? hasInitialAddressMatch\n ? initialAddress\n : retrieveWorkAddressQuery.data?.employeeWorkAddress\n : undefined\n\n const schemaMode = isCreateMode ? 'create' : 'update'\n\n const [schema, metadataConfig] = useMemo(\n () =>\n createWorkAddressSchema({\n mode: schemaMode,\n optionalFieldsToRequire,\n withEffectiveDateField,\n }),\n [schemaMode, optionalFieldsToRequire, withEffectiveDateField],\n )\n\n const resolvedDefaults: WorkAddressFormData = useMemo(\n () => ({\n locationUuid: fetchedWorkAddress?.locationUuid ?? partnerDefaults?.locationUuid ?? '',\n effectiveDate: fetchedWorkAddress?.effectiveDate ?? partnerDefaults?.effectiveDate ?? '',\n }),\n [fetchedWorkAddress, partnerDefaults],\n )\n\n const formMethods = useForm<WorkAddressFormData, unknown, WorkAddressFormOutputs>({\n resolver: zodResolver(schema),\n mode: validationMode,\n shouldFocusError,\n defaultValues: resolvedDefaults,\n values: resolvedDefaults,\n resetOptions: { keepDirtyValues: true },\n })\n\n const createWorkAddressMutation = useEmployeeAddressesCreateWorkAddressMutation()\n const updateWorkAddressMutation = useEmployeeAddressesUpdateWorkAddressMutation()\n\n const isPending = createWorkAddressMutation.isPending \|\| updateWorkAddressMutation.isPending\n\n const {\n baseSubmitHandler,\n error: submitError,\n setError: setSubmitError,\n } = useBaseSubmit('WorkAddressForm')\n\n const queriesForErrors = [locationsQuery, ...(workAddressUuid ? [retrieveWorkAddressQuery] : [])]\n const errorHandling = composeErrorHandler(queriesForErrors, { submitError, setSubmitError })\n\n const locationOptions = (companyLocations ?? []).map(location => ({\n value: location.uuid,\n label: addressInline(location),\n }))\n\n const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n const fieldsMetadata = {\n locationUuid: withOptions<Location>(\n baseMetadata.locationUuid,\n locationOptions,\n companyLocations ?? [],\n ),\n effectiveDate: baseMetadata.effectiveDate,\n }\n\n const onSubmit = async (\n callbacks?: WorkAddressSubmitCallbacks,\n options?: WorkAddressSubmitOptions,\n ): Promise<HookSubmitResult<EmployeeWorkAddress> \| undefined> => {\n let submitResult: HookSubmitResult<EmployeeWorkAddress> \| undefined\n\n await new Promise<void>(resolve => {\n void formMethods.handleSubmit(\n async (data: WorkAddressFormOutputs) => {\n await baseSubmitHandler(data, async payload => {\n const resolvedEmployeeId = options?.employeeId ?? employeeId\n\n if (!resolvedEmployeeId) {\n throw new SDKInternalError('employeeId is required to submit work address')\n }\n\n const resolvedEffectiveDate =\n withEffectiveDateField && payload.effectiveDate\n ? payload.effectiveDate\n : options?.effectiveDate\n\n const effectiveDateParam = resolvedEffectiveDate\n ? new RFCDate(new Date(resolvedEffectiveDate))\n : undefined\n\n let updatedWorkAddress: EmployeeWorkAddress\n\n if (isCreateMode) {\n const result = await createWorkAddressMutation.mutateAsync({\n request: {\n employeeId: resolvedEmployeeId,\n requestBody: {\n locationUuid: payload.locationUuid,\n effectiveDate: effectiveDateParam,\n },\n },\n })\n\n if (!result.employeeWorkAddress) {\n throw new SDKInternalError('Work address creation failed')\n }\n\n updatedWorkAddress = result.employeeWorkAddress\n callbacks?.onWorkAddressCreated?.(updatedWorkAddress)\n } else {\n if (!fetchedWorkAddress \|\| !workAddressUuid) {\n throw new SDKInternalError(\n 'Cannot update work address: no matching address on file',\n )\n }\n\n const result = await updateWorkAddressMutation.mutateAsync({\n request: {\n workAddressUuid: fetchedWorkAddress.uuid,\n requestBody: {\n version: fetchedWorkAddress.version,\n locationUuid: payload.locationUuid,\n effectiveDate: effectiveDateParam,\n },\n },\n })\n\n if (!result.employeeWorkAddress) {\n throw new SDKInternalError('Work address update failed')\n }\n\n updatedWorkAddress = result.employeeWorkAddress\n callbacks?.onWorkAddressUpdated?.(updatedWorkAddress)\n }\n\n submitResult = {\n mode: isCreateMode ? 'create' : 'update',\n data: updatedWorkAddress,\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 (!!companyId && locationsQuery.isLoading) \|\|\n (!!workAddressUuid && retrieveWorkAddressQuery.isLoading)\n\n if (!companyId \|\| isDataLoading \|\| !companyLocations) {\n return { isLoading: true as const, errorHandling }\n }\n\n if (workAddressUuid && !fetchedWorkAddress) {\n return { isLoading: true as const, errorHandling }\n }\n\n return {\n isLoading: false as const,\n data: {\n workAddress: fetchedWorkAddress ?? null,\n companyLocations,\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 Location: LocationField,\n EffectiveDate: withEffectiveDateField ? EffectiveDateField : undefined,\n },\n fieldsMetadata,\n hookFormInternals,\n getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n },\n }\n}\n\nexport type UseWorkAddressFormResult = HookLoadingResult \| UseWorkAddressFormReady\nexport type WorkAddressFieldsMetadata = UseWorkAddressFormReady['form']['fieldsMetadata']\nexport type WorkAddressFormFields = UseWorkAddressFormReady['form']['Fields']\n"],"names":["useWorkAddressForm","companyId","employeeId","workAddressUuid","initialAddress","withEffectiveDateField","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","locationsQuery","useLocationsGet","hasInitialAddressMatch","retrieveWorkAddressQuery","useEmployeeAddressesRetrieveWorkAddress","companyLocations","isCreateMode","fetchedWorkAddress","schemaMode","schema","metadataConfig","useMemo","createWorkAddressSchema","resolvedDefaults","formMethods","useForm","zodResolver","createWorkAddressMutation","useEmployeeAddressesCreateWorkAddressMutation","updateWorkAddressMutation","useEmployeeAddressesUpdateWorkAddressMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","queriesForErrors","errorHandling","composeErrorHandler","locationOptions","location","addressInline","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","callbacks","options","submitResult","resolve","data","payload","resolvedEmployeeId","SDKInternalError","resolvedEffectiveDate","effectiveDateParam","RFCDate","updatedWorkAddress","result","hookFormInternals","useHookFormInternals","isDataLoading","LocationField","EffectiveDateField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;;AA0FO,SAASA,GAAmB;AAAA,EACjC,WAAAC;AAAA,EACA,YAAAC;AAAA,EACA,iBAAAC;AAAA,EACA,gBAAAC;AAAA,EACA,wBAAAC,IAAyB;AAAA,EACzB,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAyE;AACvE,QAAMC,IAAiBC,EAAgB,EAAE,WAAWV,KAAa,GAAA,GAAM,EAAE,SAAS,CAAC,CAACA,GAAW,GAEzFW,IAAyB,CAAC,CAACT,KAAmBC,GAAgB,SAASD,GAEvEU,IAA2BC;AAAA,IAC/B,EAAE,iBAAiBX,KAAmB,GAAA;AAAA,IACtC,EAAE,SAAS,CAAC,CAACA,KAAmB,CAACS,EAAA;AAAA,EAAuB,GAGpDG,IAAmBL,EAAe,MAAM,sBAExCM,IAAe,CAACb,GAEhBc,IAAqBd,IACvBS,IACER,IACAS,EAAyB,MAAM,sBACjC,QAEEK,IAAaF,IAAe,WAAW,UAEvC,CAACG,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MACEC,GAAwB;AAAA,MACtB,MAAMJ;AAAA,MACN,yBAAAZ;AAAA,MACA,wBAAAD;AAAA,IAAA,CACD;AAAA,IACH,CAACa,GAAYZ,GAAyBD,CAAsB;AAAA,EAAA,GAGxDkB,IAAwCF;AAAA,IAC5C,OAAO;AAAA,MACL,cAAcJ,GAAoB,gBAAgBV,GAAiB,gBAAgB;AAAA,MACnF,eAAeU,GAAoB,iBAAiBV,GAAiB,iBAAiB;AAAA,IAAA;AAAA,IAExF,CAACU,GAAoBV,CAAe;AAAA,EAAA,GAGhCiB,IAAcC,EAA8D;AAAA,IAChF,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMX;AAAA,IACN,kBAAAC;AAAA,IACA,eAAec;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAA4BC,EAAA,GAC5BC,IAA4BC,EAAA,GAE5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,iBAAiB,GAE7BC,IAAmB,CAAC1B,GAAgB,GAAIP,IAAkB,CAACU,CAAwB,IAAI,EAAG,GAC1FwB,IAAgBC,GAAoBF,GAAkB,EAAE,aAAAH,GAAa,gBAAAC,GAAgB,GAErFK,KAAmBxB,KAAoB,CAAA,GAAI,IAAI,CAAAyB,OAAa;AAAA,IAChE,OAAOA,EAAS;AAAA,IAChB,OAAOC,GAAcD,CAAQ;AAAA,EAAA,EAC7B,GAEIE,IAAeC,GAAwBvB,GAAgBI,EAAY,OAAO,GAC1EoB,IAAiB;AAAA,IACrB,cAAcC;AAAA,MACZH,EAAa;AAAA,MACbH;AAAA,MACAxB,KAAoB,CAAA;AAAA,IAAC;AAAA,IAEvB,eAAe2B,EAAa;AAAA,EAAA,GAGxBI,IAAW,OACfC,GACAC,MAC+D;AAC/D,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAK1B,EAAY;AAAA,QACf,OAAO2B,MAAiC;AACtC,gBAAMnB,EAAkBmB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAqBL,GAAS,cAAc9C;AAElD,gBAAI,CAACmD;AACH,oBAAM,IAAIC,EAAiB,+CAA+C;AAG5E,kBAAMC,IACJlD,KAA0B+C,EAAQ,gBAC9BA,EAAQ,gBACRJ,GAAS,eAETQ,IAAqBD,IACvB,IAAIE,EAAQ,IAAI,KAAKF,CAAqB,CAAC,IAC3C;AAEJ,gBAAIG;AAEJ,gBAAI1C,GAAc;AAChB,oBAAM2C,IAAS,MAAMhC,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,YAAY0B;AAAA,kBACZ,aAAa;AAAA,oBACX,cAAcD,EAAQ;AAAA,oBACtB,eAAeI;AAAA,kBAAA;AAAA,gBACjB;AAAA,cACF,CACD;AAED,kBAAI,CAACG,EAAO;AACV,sBAAM,IAAIL,EAAiB,8BAA8B;AAG3D,cAAAI,IAAqBC,EAAO,qBAC5BZ,GAAW,uBAAuBW,CAAkB;AAAA,YACtD,OAAO;AACL,kBAAI,CAACzC,KAAsB,CAACd;AAC1B,sBAAM,IAAImD;AAAA,kBACR;AAAA,gBAAA;AAIJ,oBAAMK,IAAS,MAAM9B,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,iBAAiBZ,EAAmB;AAAA,kBACpC,aAAa;AAAA,oBACX,SAASA,EAAmB;AAAA,oBAC5B,cAAcmC,EAAQ;AAAA,oBACtB,eAAeI;AAAA,kBAAA;AAAA,gBACjB;AAAA,cACF,CACD;AAED,kBAAI,CAACG,EAAO;AACV,sBAAM,IAAIL,EAAiB,4BAA4B;AAGzD,cAAAI,IAAqBC,EAAO,qBAC5BZ,GAAW,uBAAuBW,CAAkB;AAAA,YACtD;AAEA,YAAAT,IAAe;AAAA,cACb,MAAMjC,IAAe,WAAW;AAAA,cAChC,MAAM0C;AAAA,YAAA;AAAA,UAEV,CAAC,GACDR,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMW,IAAoBC,GAAqBrC,CAAW,GAEpDsC,IACH,CAAC,CAAC7D,KAAaS,EAAe,aAC9B,CAAC,CAACP,KAAmBU,EAAyB;AAEjD,SAAI,CAACZ,KAAa6D,KAAiB,CAAC/C,IAC3B,EAAE,WAAW,IAAe,eAAAsB,EAAA,IAGjClC,KAAmB,CAACc,IACf,EAAE,WAAW,IAAe,eAAAoB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,aAAapB,KAAsB;AAAA,MACnC,kBAAAF;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACN,WAAAgB;AAAA,MACA,MAAMf,IAAgB,WAAsB;AAAA,IAAA;AAAA,IAE9C,SAAS,EAAE,UAAA8B,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,UAAU0B;AAAA,QACV,eAAe1D,IAAyB2D,KAAqB;AAAA,MAAA;AAAA,MAE/D,gBAAApB;AAAA,MACA,mBAAAgB;AAAA,MACA,yBAAyBK,GAA8BzC,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}
1	+ {"version":3,"file":"useWorkAddressForm.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/useWorkAddressForm.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 { Location } from '@gusto/embedded-api-v-2025-11-15/models/components/location'\nimport type { EmployeeWorkAddress } from '@gusto/embedded-api-v-2025-11-15/models/components/employeeworkaddress'\nimport { useLocationsGet } from '@gusto/embedded-api-v-2025-11-15/react-query/locationsGet'\nimport { useEmployeeAddressesRetrieveWorkAddress } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesRetrieveWorkAddress'\nimport { useEmployeeAddressesCreateWorkAddressMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesCreateWorkAddress'\nimport { useEmployeeAddressesUpdateWorkAddressMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesUpdateWorkAddress'\nimport { RFCDate } from '@gusto/embedded-api-v-2025-11-15/types/rfcdate'\nimport {\n createWorkAddressSchema,\n type WorkAddressOptionalFieldsToRequire,\n type WorkAddressFormData,\n type WorkAddressFormOutputs,\n} from './workAddressSchema'\nimport { LocationField, EffectiveDateField } from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { withOptions } from '@/partner-hook-utils/form/withOptions'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n BaseFormHookReady,\n FieldsMetadata,\n HookLoadingResult,\n HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\nimport { addressInline } from '@/helpers/formattedStrings'\n\nexport type { WorkAddressOptionalFieldsToRequire } from './workAddressSchema'\n\n/*\n Optional callbacks passed to {@link UseWorkAddressFormReady.actions.onSubmit \| onSubmit}.\n \n @remarks\n * Only the callback matching the submit mode fires —\n * `onWorkAddressCreated` on create, `onWorkAddressUpdated` on update.\n \n @public\n /\nexport interface WorkAddressSubmitCallbacks {\n /* Fired after a new work address is successfully created. /\n onWorkAddressCreated?: (workAddress: EmployeeWorkAddress) => void\n /* Fired after an existing work address is successfully updated. /\n onWorkAddressUpdated?: (workAddress: EmployeeWorkAddress) => void\n}\n\n/\n Optional overrides passed to {@link UseWorkAddressFormReady.actions.onSubmit \| onSubmit}.\n \n @public\n /\nexport interface WorkAddressSubmitOptions {\n /* Override the employee identifier supplied to the hook (e.g. after creating a new employee in the same flow). /\n employeeId?: string\n /* Override the effective date submitted with the address. /\n effectiveDate?: string\n}\n\n/\n Configuration options for {@link useWorkAddressForm}.\n \n @remarks\n * Presence or absence of `workAddressUuid` selects the API verb — see the\n * `workAddressUuid` field description. `companyId` is required to fetch\n * the location list; pass it when it is known.\n \n @public\n /\nexport interface UseWorkAddressFormProps {\n /* Company UUID for locations; omit or leave unset while resolving from the employee record. /\n companyId?: string\n /* UUID of the employee whose work address is being created or edited. /\n employeeId: string\n /\n When set, loads that work address via GET `/v1/work_addresses/{work_address_uuid}` and updates it (PUT).\n * When omitted, the form is in create mode (POST).\n /\n workAddressUuid?: string\n /\n Pre-loaded address matching `workAddressUuid`. When supplied, the form uses it directly\n * instead of issuing a GET — useful when the parent already has the row from a list query.\n /\n initialAddress?: EmployeeWorkAddress\n /* When `true`, renders `Fields.EffectiveDate`; otherwise it is `undefined`. Defaults to `true`. /\n withEffectiveDateField?: boolean\n /* Override fields that are optional on a given mode to be required. See `WorkAddressOptionalFieldsToRequire`. /\n optionalFieldsToRequire?: WorkAddressOptionalFieldsToRequire\n /* Pre-fill form values. Server data takes precedence on update. /\n defaultValues?: Partial<WorkAddressFormData>\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 `useWorkAddressForm().form.Fields`.\n \n @remarks\n * `EffectiveDate` is `undefined` when `withEffectiveDateField` is `false`.\n * Always null-check it before rendering.\n \n @public\n /\nexport interface WorkAddressFields {\n /* Location selector. Always available. /\n Location: typeof LocationField\n /* Effective-date picker. Only available when `withEffectiveDateField` is `true`. /\n EffectiveDate: typeof EffectiveDateField \| undefined\n}\n\n/\n Ready-state shape returned by {@link useWorkAddressForm} once data has loaded.\n \n @remarks\n * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with\n * the work-address-specific `data`, `status`, `actions`, and `form.Fields` shape.\n \n @public\n /\nexport interface UseWorkAddressFormReady extends BaseFormHookReady<\n FieldsMetadata,\n WorkAddressFormData,\n WorkAddressFields\n> {\n /* Static entity data resolved from the API. /\n data: {\n /* The address row loaded for update; `null` in create mode. /\n workAddress: EmployeeWorkAddress \| null\n /* Company locations available for selection; `undefined` until the locations query resolves. /\n companyLocations: Location[] \| undefined\n }\n /* Reactive status flags. /\n status: { isPending: boolean; mode: 'create' \| 'update' }\n /* Available actions. /\n actions: {\n onSubmit: (\n callbacks?: WorkAddressSubmitCallbacks,\n options?: WorkAddressSubmitOptions,\n ) => Promise<HookSubmitResult<EmployeeWorkAddress> \| undefined>\n }\n}\n\n/\n Form hook for creating or editing an employee's work address.\n \n @remarks\n * When `workAddressUuid` is supplied the hook loads that address and issues a PUT on submit;\n * when omitted it operates in create mode and issues a POST. The hook requires `companyId`\n * to fetch the company's location list — it stays in loading state until `companyId` is known.\n \n @param props - See {@link UseWorkAddressFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UseWorkAddressFormReady} once ready.\n * @public\n /\nexport function useWorkAddressForm({\n companyId,\n employeeId,\n workAddressUuid,\n initialAddress,\n withEffectiveDateField = true,\n optionalFieldsToRequire,\n defaultValues: partnerDefaults,\n validationMode = 'onSubmit',\n shouldFocusError = true,\n}: UseWorkAddressFormProps): HookLoadingResult \| UseWorkAddressFormReady {\n const locationsQuery = useLocationsGet({ companyId: companyId ?? '' }, { enabled: !!companyId })\n\n const hasInitialAddressMatch = !!workAddressUuid && initialAddress?.uuid === workAddressUuid\n\n const retrieveWorkAddressQuery = useEmployeeAddressesRetrieveWorkAddress(\n { workAddressUuid: workAddressUuid ?? '' },\n { enabled: !!workAddressUuid && !hasInitialAddressMatch },\n )\n\n const companyLocations = locationsQuery.data?.companyLocationsList\n\n const isCreateMode = !workAddressUuid\n\n const fetchedWorkAddress = workAddressUuid\n ? hasInitialAddressMatch\n ? initialAddress\n : retrieveWorkAddressQuery.data?.employeeWorkAddress\n : undefined\n\n const schemaMode = isCreateMode ? 'create' : 'update'\n\n const [schema, metadataConfig] = useMemo(\n () =>\n createWorkAddressSchema({\n mode: schemaMode,\n optionalFieldsToRequire,\n withEffectiveDateField,\n }),\n [schemaMode, optionalFieldsToRequire, withEffectiveDateField],\n )\n\n const resolvedDefaults: WorkAddressFormData = useMemo(\n () => ({\n locationUuid: fetchedWorkAddress?.locationUuid ?? partnerDefaults?.locationUuid ?? '',\n effectiveDate: fetchedWorkAddress?.effectiveDate ?? partnerDefaults?.effectiveDate ?? '',\n }),\n [fetchedWorkAddress, partnerDefaults],\n )\n\n const formMethods = useForm<WorkAddressFormData, unknown, WorkAddressFormOutputs>({\n resolver: zodResolver(schema),\n mode: validationMode,\n shouldFocusError,\n defaultValues: resolvedDefaults,\n values: resolvedDefaults,\n resetOptions: { keepDirtyValues: true },\n })\n\n const createWorkAddressMutation = useEmployeeAddressesCreateWorkAddressMutation()\n const updateWorkAddressMutation = useEmployeeAddressesUpdateWorkAddressMutation()\n\n const isPending = createWorkAddressMutation.isPending \|\| updateWorkAddressMutation.isPending\n\n const {\n baseSubmitHandler,\n error: submitError,\n setError: setSubmitError,\n } = useBaseSubmit('WorkAddressForm')\n\n const queriesForErrors = [locationsQuery, ...(workAddressUuid ? [retrieveWorkAddressQuery] : [])]\n const errorHandling = composeErrorHandler(queriesForErrors, { submitError, setSubmitError })\n\n const locationOptions = (companyLocations ?? []).map(location => ({\n value: location.uuid,\n label: addressInline(location),\n }))\n\n const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n const fieldsMetadata = {\n locationUuid: withOptions<Location>(\n baseMetadata.locationUuid,\n locationOptions,\n companyLocations ?? [],\n ),\n effectiveDate: baseMetadata.effectiveDate,\n }\n\n const onSubmit = async (\n callbacks?: WorkAddressSubmitCallbacks,\n options?: WorkAddressSubmitOptions,\n ): Promise<HookSubmitResult<EmployeeWorkAddress> \| undefined> => {\n let submitResult: HookSubmitResult<EmployeeWorkAddress> \| undefined\n\n await new Promise<void>(resolve => {\n void formMethods.handleSubmit(\n async (data: WorkAddressFormOutputs) => {\n await baseSubmitHandler(data, async payload => {\n const resolvedEmployeeId = options?.employeeId ?? employeeId\n\n if (!resolvedEmployeeId) {\n throw new SDKInternalError('employeeId is required to submit work address')\n }\n\n const resolvedEffectiveDate =\n withEffectiveDateField && payload.effectiveDate\n ? payload.effectiveDate\n : options?.effectiveDate\n\n const effectiveDateParam = resolvedEffectiveDate\n ? new RFCDate(new Date(resolvedEffectiveDate))\n : undefined\n\n let updatedWorkAddress: EmployeeWorkAddress\n\n if (isCreateMode) {\n const result = await createWorkAddressMutation.mutateAsync({\n request: {\n employeeId: resolvedEmployeeId,\n requestBody: {\n locationUuid: payload.locationUuid,\n effectiveDate: effectiveDateParam,\n },\n },\n })\n\n if (!result.employeeWorkAddress) {\n throw new SDKInternalError('Work address creation failed')\n }\n\n updatedWorkAddress = result.employeeWorkAddress\n callbacks?.onWorkAddressCreated?.(updatedWorkAddress)\n } else {\n if (!fetchedWorkAddress \|\| !workAddressUuid) {\n throw new SDKInternalError(\n 'Cannot update work address: no matching address on file',\n )\n }\n\n const result = await updateWorkAddressMutation.mutateAsync({\n request: {\n workAddressUuid: fetchedWorkAddress.uuid,\n requestBody: {\n version: fetchedWorkAddress.version,\n locationUuid: payload.locationUuid,\n effectiveDate: effectiveDateParam,\n },\n },\n })\n\n if (!result.employeeWorkAddress) {\n throw new SDKInternalError('Work address update failed')\n }\n\n updatedWorkAddress = result.employeeWorkAddress\n callbacks?.onWorkAddressUpdated?.(updatedWorkAddress)\n }\n\n submitResult = {\n mode: isCreateMode ? 'create' : 'update',\n data: updatedWorkAddress,\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 (!!companyId && locationsQuery.isLoading) \|\|\n (!!workAddressUuid && retrieveWorkAddressQuery.isLoading)\n\n if (!companyId \|\| isDataLoading \|\| !companyLocations) {\n return { isLoading: true as const, errorHandling }\n }\n\n if (workAddressUuid && !fetchedWorkAddress) {\n return { isLoading: true as const, errorHandling }\n }\n\n return {\n isLoading: false as const,\n data: {\n workAddress: fetchedWorkAddress ?? null,\n companyLocations,\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 Location: LocationField,\n EffectiveDate: withEffectiveDateField ? EffectiveDateField : undefined,\n },\n fieldsMetadata,\n hookFormInternals,\n getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n },\n }\n}\n\n/\n Discriminated union returned by {@link useWorkAddressForm}.\n \n @public\n /\nexport type UseWorkAddressFormResult = HookLoadingResult \| UseWorkAddressFormReady\n/\n Type of `form.fieldsMetadata` returned by {@link useWorkAddressForm}.\n \n @public\n /\nexport type WorkAddressFieldsMetadata = UseWorkAddressFormReady['form']['fieldsMetadata']\n/\n Type of `form.Fields` returned by {@link useWorkAddressForm}.\n \n @public\n */\nexport type WorkAddressFormFields = UseWorkAddressFormReady['form']['Fields']\n"],"names":["useWorkAddressForm","companyId","employeeId","workAddressUuid","initialAddress","withEffectiveDateField","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","locationsQuery","useLocationsGet","hasInitialAddressMatch","retrieveWorkAddressQuery","useEmployeeAddressesRetrieveWorkAddress","companyLocations","isCreateMode","fetchedWorkAddress","schemaMode","schema","metadataConfig","useMemo","createWorkAddressSchema","resolvedDefaults","formMethods","useForm","zodResolver","createWorkAddressMutation","useEmployeeAddressesCreateWorkAddressMutation","updateWorkAddressMutation","useEmployeeAddressesUpdateWorkAddressMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","queriesForErrors","errorHandling","composeErrorHandler","locationOptions","location","addressInline","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","callbacks","options","submitResult","resolve","data","payload","resolvedEmployeeId","SDKInternalError","resolvedEffectiveDate","effectiveDateParam","RFCDate","updatedWorkAddress","result","hookFormInternals","useHookFormInternals","isDataLoading","LocationField","EffectiveDateField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;;AAgKO,SAASA,GAAmB;AAAA,EACjC,WAAAC;AAAA,EACA,YAAAC;AAAA,EACA,iBAAAC;AAAA,EACA,gBAAAC;AAAA,EACA,wBAAAC,IAAyB;AAAA,EACzB,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAyE;AACvE,QAAMC,IAAiBC,EAAgB,EAAE,WAAWV,KAAa,GAAA,GAAM,EAAE,SAAS,CAAC,CAACA,GAAW,GAEzFW,IAAyB,CAAC,CAACT,KAAmBC,GAAgB,SAASD,GAEvEU,IAA2BC;AAAA,IAC/B,EAAE,iBAAiBX,KAAmB,GAAA;AAAA,IACtC,EAAE,SAAS,CAAC,CAACA,KAAmB,CAACS,EAAA;AAAA,EAAuB,GAGpDG,IAAmBL,EAAe,MAAM,sBAExCM,IAAe,CAACb,GAEhBc,IAAqBd,IACvBS,IACER,IACAS,EAAyB,MAAM,sBACjC,QAEEK,IAAaF,IAAe,WAAW,UAEvC,CAACG,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MACEC,GAAwB;AAAA,MACtB,MAAMJ;AAAA,MACN,yBAAAZ;AAAA,MACA,wBAAAD;AAAA,IAAA,CACD;AAAA,IACH,CAACa,GAAYZ,GAAyBD,CAAsB;AAAA,EAAA,GAGxDkB,IAAwCF;AAAA,IAC5C,OAAO;AAAA,MACL,cAAcJ,GAAoB,gBAAgBV,GAAiB,gBAAgB;AAAA,MACnF,eAAeU,GAAoB,iBAAiBV,GAAiB,iBAAiB;AAAA,IAAA;AAAA,IAExF,CAACU,GAAoBV,CAAe;AAAA,EAAA,GAGhCiB,IAAcC,EAA8D;AAAA,IAChF,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMX;AAAA,IACN,kBAAAC;AAAA,IACA,eAAec;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAA4BC,EAAA,GAC5BC,IAA4BC,EAAA,GAE5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,iBAAiB,GAE7BC,IAAmB,CAAC1B,GAAgB,GAAIP,IAAkB,CAACU,CAAwB,IAAI,EAAG,GAC1FwB,IAAgBC,GAAoBF,GAAkB,EAAE,aAAAH,GAAa,gBAAAC,GAAgB,GAErFK,KAAmBxB,KAAoB,CAAA,GAAI,IAAI,CAAAyB,OAAa;AAAA,IAChE,OAAOA,EAAS;AAAA,IAChB,OAAOC,GAAcD,CAAQ;AAAA,EAAA,EAC7B,GAEIE,IAAeC,GAAwBvB,GAAgBI,EAAY,OAAO,GAC1EoB,IAAiB;AAAA,IACrB,cAAcC;AAAA,MACZH,EAAa;AAAA,MACbH;AAAA,MACAxB,KAAoB,CAAA;AAAA,IAAC;AAAA,IAEvB,eAAe2B,EAAa;AAAA,EAAA,GAGxBI,IAAW,OACfC,GACAC,MAC+D;AAC/D,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAK1B,EAAY;AAAA,QACf,OAAO2B,MAAiC;AACtC,gBAAMnB,EAAkBmB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAqBL,GAAS,cAAc9C;AAElD,gBAAI,CAACmD;AACH,oBAAM,IAAIC,EAAiB,+CAA+C;AAG5E,kBAAMC,IACJlD,KAA0B+C,EAAQ,gBAC9BA,EAAQ,gBACRJ,GAAS,eAETQ,IAAqBD,IACvB,IAAIE,EAAQ,IAAI,KAAKF,CAAqB,CAAC,IAC3C;AAEJ,gBAAIG;AAEJ,gBAAI1C,GAAc;AAChB,oBAAM2C,IAAS,MAAMhC,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,YAAY0B;AAAA,kBACZ,aAAa;AAAA,oBACX,cAAcD,EAAQ;AAAA,oBACtB,eAAeI;AAAA,kBAAA;AAAA,gBACjB;AAAA,cACF,CACD;AAED,kBAAI,CAACG,EAAO;AACV,sBAAM,IAAIL,EAAiB,8BAA8B;AAG3D,cAAAI,IAAqBC,EAAO,qBAC5BZ,GAAW,uBAAuBW,CAAkB;AAAA,YACtD,OAAO;AACL,kBAAI,CAACzC,KAAsB,CAACd;AAC1B,sBAAM,IAAImD;AAAA,kBACR;AAAA,gBAAA;AAIJ,oBAAMK,IAAS,MAAM9B,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,iBAAiBZ,EAAmB;AAAA,kBACpC,aAAa;AAAA,oBACX,SAASA,EAAmB;AAAA,oBAC5B,cAAcmC,EAAQ;AAAA,oBACtB,eAAeI;AAAA,kBAAA;AAAA,gBACjB;AAAA,cACF,CACD;AAED,kBAAI,CAACG,EAAO;AACV,sBAAM,IAAIL,EAAiB,4BAA4B;AAGzD,cAAAI,IAAqBC,EAAO,qBAC5BZ,GAAW,uBAAuBW,CAAkB;AAAA,YACtD;AAEA,YAAAT,IAAe;AAAA,cACb,MAAMjC,IAAe,WAAW;AAAA,cAChC,MAAM0C;AAAA,YAAA;AAAA,UAEV,CAAC,GACDR,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMW,IAAoBC,GAAqBrC,CAAW,GAEpDsC,IACH,CAAC,CAAC7D,KAAaS,EAAe,aAC9B,CAAC,CAACP,KAAmBU,EAAyB;AAEjD,SAAI,CAACZ,KAAa6D,KAAiB,CAAC/C,IAC3B,EAAE,WAAW,IAAe,eAAAsB,EAAA,IAGjClC,KAAmB,CAACc,IACf,EAAE,WAAW,IAAe,eAAAoB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,aAAapB,KAAsB;AAAA,MACnC,kBAAAF;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACN,WAAAgB;AAAA,MACA,MAAMf,IAAgB,WAAsB;AAAA,IAAA;AAAA,IAE9C,SAAS,EAAE,UAAA8B,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,UAAU0B;AAAA,QACV,eAAe1D,IAAyB2D,KAAqB;AAAA,MAAA;AAAA,MAE/D,gBAAApB;AAAA,MACA,mBAAAgB;AAAA,MACA,yBAAyBK,GAA8BzC,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Employee/Profile/shared/useWorkAddressForm/workAddressSchema.d.ts CHANGED Viewed

@@ -1,25 +1,60 @@
 import { z } from 'zod';
 import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes emitted by the work address form schema. Map these
+ * codes to localized copy in `validationMessages` when composing the hook.
+ *
+ * @public
+ */
 export declare const WorkAddressErrorCodes: {
     readonly REQUIRED: "REQUIRED";
 };
+/**
+ * Union of validation error code strings emitted by the work address form
+ * schema.
+ *
+ * @public
+ */
 export type WorkAddressErrorCode = (typeof WorkAddressErrorCodes)[keyof typeof WorkAddressErrorCodes];
 declare const fieldValidators: {
     locationUuid: z.ZodString;
     effectiveDate: z.ZodISODate;
 };
+/**
+ * Field names accepted by the work address form.
+ *
+ * @public
+ */
 export type WorkAddressField = keyof typeof fieldValidators;
+/**
+ * Shape of the values managed by the work address form.
+ *
+ * @public
+ */
 export type WorkAddressFormData = {
     [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
 };
+/**
+ * Shape of the validated values produced by the work address form on submit.
+ *
+ * @public
+ */
 export type WorkAddressFormOutputs = WorkAddressFormData;
 declare const requiredFieldsConfig: {};
+/**
+ * Keys of optional work address fields that can be promoted to required via
+ * the hook's `optionalFieldsToRequire` option.
+ *
+ * @public
+ */
 export type WorkAddressOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+/** @internal */
 interface WorkAddressSchemaOptions {
     mode?: 'create' | 'update';
     optionalFieldsToRequire?: WorkAddressOptionalFieldsToRequire;
     withEffectiveDateField?: boolean;
 }
+/** @internal */
 export declare function createWorkAddressSchema(options?: WorkAddressSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
     locationUuid: z.ZodString;
     effectiveDate: z.ZodISODate;

package/dist/components/Employee/Profile/shared/useWorkAddressForm/workAddressSchema.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"workAddressSchema.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/workAddressSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n buildFormSchema,\n type RequiredFieldConfig,\n type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\nexport const WorkAddressErrorCodes = {\n REQUIRED: 'REQUIRED',\n} as const\n\nexport type WorkAddressErrorCode =\n (typeof WorkAddressErrorCodes)[keyof typeof WorkAddressErrorCodes]\n\n// ── Field validators ───────────────────────────────────────────────────\n\nconst fieldValidators = {\n locationUuid: z.string().min(1, { message: WorkAddressErrorCodes.REQUIRED }),\n effectiveDate: z.iso.date({ error: () => WorkAddressErrorCodes.REQUIRED }),\n}\n\nexport type WorkAddressField = keyof typeof fieldValidators\n\nexport type WorkAddressFormData = {\n [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\nexport type WorkAddressFormOutputs = WorkAddressFormData\n\n// ── Required fields config ─────────────────────────────────────────────\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n// ── Schema factory ─────────────────────────────────────────────────────\n\nexport type WorkAddressOptionalFieldsToRequire = OptionalFieldsToRequire<\n typeof requiredFieldsConfig\n>\n\ninterface WorkAddressSchemaOptions {\n mode?: 'create' \| 'update'\n optionalFieldsToRequire?: WorkAddressOptionalFieldsToRequire\n withEffectiveDateField?: boolean\n}\n\nexport function createWorkAddressSchema(options: WorkAddressSchemaOptions = {}) {\n const { mode = 'create', optionalFieldsToRequire, withEffectiveDateField = true } = options\n\n return buildFormSchema(fieldValidators, {\n requiredFieldsConfig,\n requiredErrorCode: WorkAddressErrorCodes.REQUIRED,\n mode,\n optionalFieldsToRequire,\n excludeFields: withEffectiveDateField ? [] : ['effectiveDate'],\n })\n}\n"],"names":["WorkAddressErrorCodes","fieldValidators","z","requiredFieldsConfig","createWorkAddressSchema","options","mode","optionalFieldsToRequire","withEffectiveDateField","buildFormSchema"],"mappings":";;~~AASO~~,MAAMA,IAAwB;AAAA,EACnC,UAAU;AACZ,~~GAOMC~~,IAAkB;AAAA,EACtB,cAAcC,EAAE,OAAA,EAAS,IAAI,GAAG,EAAE,SAASF,EAAsB,UAAU;AAAA,EAC3E,eAAeE,EAAE,IAAI,KAAK,EAAE,OAAO,MAAMF,EAAsB,SAAA,CAAU;AAC3E,~~GAWMG~~,IAAuB,CAAA;~~AActB~~,SAASC,EAAwBC,IAAoC,IAAI;AAC9E,QAAM,EAAE,MAAAC,IAAO,UAAU,yBAAAC,GAAyB,wBAAAC,IAAyB,OAASH;AAEpF,SAAOI,EAAgBR,GAAiB;AAAA,IACtC,sBAAAE;AAAA,IACA,mBAAmBH,EAAsB;AAAA,IACzC,MAAAM;AAAA,IACA,yBAAAC;AAAA,IACA,eAAeC,IAAyB,CAAA,IAAK,CAAC,eAAe;AAAA,EAAA,CAC9D;AACH;"}
1	+ {"version":3,"file":"workAddressSchema.js","sources":["../../../../../../src/components/Employee/Profile/shared/useWorkAddressForm/workAddressSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n buildFormSchema,\n type RequiredFieldConfig,\n type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\n/*\n Validation error codes emitted by the work address form schema. Map these\n * codes to localized copy in `validationMessages` when composing the hook.\n \n @public\n /\nexport const WorkAddressErrorCodes = {\n REQUIRED: 'REQUIRED',\n} as const\n\n/\n Union of validation error code strings emitted by the work address form\n * schema.\n \n @public\n /\nexport type WorkAddressErrorCode =\n (typeof WorkAddressErrorCodes)[keyof typeof WorkAddressErrorCodes]\n\n// ── Field validators ───────────────────────────────────────────────────\n\nconst fieldValidators = {\n locationUuid: z.string().min(1, { message: WorkAddressErrorCodes.REQUIRED }),\n effectiveDate: z.iso.date({ error: () => WorkAddressErrorCodes.REQUIRED }),\n}\n\n/\n Field names accepted by the work address form.\n \n @public\n /\nexport type WorkAddressField = keyof typeof fieldValidators\n\n/\n Shape of the values managed by the work address form.\n \n @public\n /\nexport type WorkAddressFormData = {\n [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n/\n Shape of the validated values produced by the work address form on submit.\n \n @public\n /\nexport type WorkAddressFormOutputs = WorkAddressFormData\n\n// ── Required fields config ─────────────────────────────────────────────\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n// ── Schema factory ─────────────────────────────────────────────────────\n\n/\n Keys of optional work address fields that can be promoted to required via\n * the hook's `optionalFieldsToRequire` option.\n \n @public\n /\nexport type WorkAddressOptionalFieldsToRequire = OptionalFieldsToRequire<\n typeof requiredFieldsConfig\n>\n\n/* @internal /\ninterface WorkAddressSchemaOptions {\n mode?: 'create' \| 'update'\n optionalFieldsToRequire?: WorkAddressOptionalFieldsToRequire\n withEffectiveDateField?: boolean\n}\n\n/* @internal */\nexport function createWorkAddressSchema(options: WorkAddressSchemaOptions = {}) {\n const { mode = 'create', optionalFieldsToRequire, withEffectiveDateField = true } = options\n\n return buildFormSchema(fieldValidators, {\n requiredFieldsConfig,\n requiredErrorCode: WorkAddressErrorCodes.REQUIRED,\n mode,\n optionalFieldsToRequire,\n excludeFields: withEffectiveDateField ? [] : ['effectiveDate'],\n })\n}\n"],"names":["WorkAddressErrorCodes","fieldValidators","z","requiredFieldsConfig","createWorkAddressSchema","options","mode","optionalFieldsToRequire","withEffectiveDateField","buildFormSchema"],"mappings":";;AAeO,MAAMA,IAAwB;AAAA,EACnC,UAAU;AACZ,GAaMC,IAAkB;AAAA,EACtB,cAAcC,EAAE,OAAA,EAAS,IAAI,GAAG,EAAE,SAASF,EAAsB,UAAU;AAAA,EAC3E,eAAeE,EAAE,IAAI,KAAK,EAAE,OAAO,MAAMF,EAAsB,SAAA,CAAU;AAC3E,GA0BMG,IAAuB,CAAA;AAsBtB,SAASC,EAAwBC,IAAoC,IAAI;AAC9E,QAAM,EAAE,MAAAC,IAAO,UAAU,yBAAAC,GAAyB,wBAAAC,IAAyB,OAASH;AAEpF,SAAOI,EAAgBR,GAAiB;AAAA,IACtC,sBAAAE;AAAA,IACA,mBAAmBH,EAAsB;AAAA,IACzC,MAAAM;AAAA,IACA,yBAAAC;AAAA,IACA,eAAeC,IAAyB,CAAA,IAAK,CAAC,eAAe;AAAA,EAAA,CAC9D;AACH;"}

package/dist/components/Employee/SelfOnboardingFlow/SelfOnboardingComponents.d.ts CHANGED Viewed

@@ -1,21 +1,37 @@
 import { PaymentMethodBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/paymentmethodbankaccount';
 import { FlowContextInterface } from '../../Flow/useFlow';
 import { BaseComponentInterface } from '../../Base';
+/**
+ * Props for {@link SelfOnboardingFlow}.
+ *
+ * @public
+ */
 export interface SelfOnboardingFlowProps extends BaseComponentInterface {
+    /** The associated company identifier. */
     companyId: string;
+    /** The associated employee identifier. */
     employeeId: string;
+    /** When true, the Document Signer step checks if the employee has I-9 enabled and routes to the Employment Eligibility and I-9 signature form steps. Defaults to `false`. */
     withEmployeeI9?: boolean;
 }
+/** @internal */
 export interface SelfOnboardingContextInterface extends FlowContextInterface {
     companyId: string;
     employeeId: string;
     withEmployeeI9?: boolean;
     paymentMethod?: PaymentMethodBankAccount;
 }
+/** @internal */
 export declare function Landing(): import("react").JSX.Element;
+/** @internal */
 export declare function Profile(): import("react").JSX.Element;
+/** @internal */
 export declare function FederalTaxes(): import("react").JSX.Element;
+/** @internal */
 export declare function StateTaxes(): import("react").JSX.Element;
+/** @internal */
 export declare function PaymentMethod(): import("react").JSX.Element;
+/** @internal */
 export declare function OnboardingSummary(): import("react").JSX.Element;
+/** @internal */
 export declare function DocumentSigner(): import("react").JSX.Element;

package/dist/components/Employee/SelfOnboardingFlow/SelfOnboardingComponents.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SelfOnboardingComponents.js","sources":["../../../../src/components/Employee/SelfOnboardingFlow/SelfOnboardingComponents.tsx"],"sourcesContent":["import type { PaymentMethodBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/paymentmethodbankaccount'\nimport { ensureRequired } from '@/helpers/ensureRequired'\nimport type { FlowContextInterface } from '@/components/Flow/useFlow'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport { Landing as LandingComponent } from '@/components/Employee/Landing'\nimport { Profile as ProfileComponent } from '@/components/Employee/Profile/onboarding/Profile'\nimport { FederalTaxes as FederalTaxesComponent } from '@/components/Employee/FederalTaxes/onboarding/FederalTaxes'\nimport { StateTaxes as StateTaxesComponent } from '@/components/Employee/StateTaxes/onboarding'\nimport { PaymentMethod as PaymentMethodComponent } from '@/components/Employee/PaymentMethod'\nimport { OnboardingSummary as OnboardingSummaryComponent } from '@/components/Employee/OnboardingSummary'\nimport { DocumentSigner as DocumentSignerComponent } from '@/components/Employee/Documents/onboarding/DocumentSigner'\n\nexport interface SelfOnboardingFlowProps extends BaseComponentInterface {\n companyId: string\n employeeId: string\n withEmployeeI9?: boolean\n}\nexport interface SelfOnboardingContextInterface extends FlowContextInterface {\n companyId: string\n employeeId: string\n withEmployeeI9?: boolean\n paymentMethod?: PaymentMethodBankAccount\n}\n\nexport function Landing() {\n const { companyId, employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <LandingComponent\n companyId={ensureRequired(companyId)}\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n />\n )\n}\n\nexport function Profile() {\n const { companyId, employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <ProfileComponent\n companyId={ensureRequired(companyId)}\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n isAdmin={false}\n />\n )\n}\n\nexport function FederalTaxes() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return <FederalTaxesComponent employeeId={ensureRequired(employeeId)} onEvent={onEvent} />\n}\n\nexport function StateTaxes() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <StateTaxesComponent\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n isAdmin={false}\n />\n )\n}\n\nexport function PaymentMethod() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return <PaymentMethodComponent employeeId={ensureRequired(employeeId)} onEvent={onEvent} />\n}\n\nexport function OnboardingSummary() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <OnboardingSummaryComponent\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n isAdmin={false}\n />\n )\n}\n\nexport function DocumentSigner() {\n const { employeeId, withEmployeeI9 = false, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <DocumentSignerComponent\n employeeId={ensureRequired(employeeId)}\n withEmployeeI9={withEmployeeI9}\n onEvent={onEvent}\n />\n )\n}\n"],"names":["Landing","companyId","employeeId","onEvent","useFlow","jsx","LandingComponent","ensureRequired","Profile","ProfileComponent","FederalTaxes","FederalTaxesComponent","StateTaxes","StateTaxesComponent","PaymentMethod","PaymentMethodComponent","OnboardingSummary","OnboardingSummaryComponent","DocumentSigner","withEmployeeI9","DocumentSignerComponent"],"mappings":";;;;;;;;;;~~AAyBO~~,SAASA,IAAU;AACxB,QAAM,EAAE,WAAAC,GAAW,YAAAC,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAC3C,SACE,gBAAAC;AAAA,IAACC;AAAAA,IAAA;AAAA,MACC,WAAWC,EAAeN,CAAS;AAAA,MACnC,YAAYM,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;~~AAEO~~,SAASK,IAAU;AACxB,QAAM,EAAE,WAAAP,GAAW,YAAAC,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAC3C,SACE,gBAAAC;AAAA,IAACI;AAAAA,IAAA;AAAA,MACC,WAAWF,EAAeN,CAAS;AAAA,MACnC,YAAYM,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,MACA,SAAS;AAAA,IAAA;AAAA,EAAA;AAGf;~~AAEO~~,SAASO,IAAe;AAC7B,QAAM,EAAE,YAAAR,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQO,GAAA,EAAsB,YAAYJ,EAAeL,CAAU,GAAG,SAAAC,GAAkB;AAC1F;~~AAEO~~,SAASS,IAAa;AAC3B,QAAM,EAAE,YAAAV,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,SACE,gBAAAC;AAAA,IAACQ;AAAAA,IAAA;AAAA,MACC,YAAYN,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,MACA,SAAS;AAAA,IAAA;AAAA,EAAA;AAGf;~~AAEO~~,SAASW,IAAgB;AAC9B,QAAM,EAAE,YAAAZ,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQW,GAAA,EAAuB,YAAYR,EAAeL,CAAU,GAAG,SAAAC,GAAkB;AAC3F;~~AAEO~~,SAASa,IAAoB;AAClC,QAAM,EAAE,YAAAd,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,SACE,gBAAAC;AAAA,IAACY;AAAAA,IAAA;AAAA,MACC,YAAYV,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,MACA,SAAS;AAAA,IAAA;AAAA,EAAA;AAGf;~~AAEO~~,SAASe,IAAiB;AAC/B,QAAM,EAAE,YAAAhB,GAAY,gBAAAiB,IAAiB,IAAO,SAAAhB,EAAA,IAAYC,EAAA;AACxD,SACE,gBAAAC;AAAA,IAACe;AAAAA,IAAA;AAAA,MACC,YAAYb,EAAeL,CAAU;AAAA,MACrC,gBAAAiB;AAAA,MACA,SAAAhB;AAAA,IAAA;AAAA,EAAA;AAGN;"}
1	+ {"version":3,"file":"SelfOnboardingComponents.js","sources":["../../../../src/components/Employee/SelfOnboardingFlow/SelfOnboardingComponents.tsx"],"sourcesContent":["import type { PaymentMethodBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/paymentmethodbankaccount'\nimport { ensureRequired } from '@/helpers/ensureRequired'\nimport type { FlowContextInterface } from '@/components/Flow/useFlow'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport { Landing as LandingComponent } from '@/components/Employee/Landing'\nimport { Profile as ProfileComponent } from '@/components/Employee/Profile/onboarding/Profile'\nimport { FederalTaxes as FederalTaxesComponent } from '@/components/Employee/FederalTaxes/onboarding/FederalTaxes'\nimport { StateTaxes as StateTaxesComponent } from '@/components/Employee/StateTaxes/onboarding'\nimport { PaymentMethod as PaymentMethodComponent } from '@/components/Employee/PaymentMethod'\nimport { OnboardingSummary as OnboardingSummaryComponent } from '@/components/Employee/OnboardingSummary'\nimport { DocumentSigner as DocumentSignerComponent } from '@/components/Employee/Documents/onboarding/DocumentSigner'\n\n/*\n Props for {@link SelfOnboardingFlow}.\n \n @public\n /\nexport interface SelfOnboardingFlowProps extends BaseComponentInterface {\n /* The associated company identifier. /\n companyId: string\n /* The associated employee identifier. /\n employeeId: string\n /* When true, the Document Signer step checks if the employee has I-9 enabled and routes to the Employment Eligibility and I-9 signature form steps. Defaults to `false`. /\n withEmployeeI9?: boolean\n}\n\n/* @internal /\nexport interface SelfOnboardingContextInterface extends FlowContextInterface {\n companyId: string\n employeeId: string\n withEmployeeI9?: boolean\n paymentMethod?: PaymentMethodBankAccount\n}\n\n/* @internal /\nexport function Landing() {\n const { companyId, employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <LandingComponent\n companyId={ensureRequired(companyId)}\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n />\n )\n}\n\n/* @internal /\nexport function Profile() {\n const { companyId, employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <ProfileComponent\n companyId={ensureRequired(companyId)}\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n isAdmin={false}\n />\n )\n}\n\n/* @internal /\nexport function FederalTaxes() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return <FederalTaxesComponent employeeId={ensureRequired(employeeId)} onEvent={onEvent} />\n}\n\n/* @internal /\nexport function StateTaxes() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <StateTaxesComponent\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n isAdmin={false}\n />\n )\n}\n\n/* @internal /\nexport function PaymentMethod() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return <PaymentMethodComponent employeeId={ensureRequired(employeeId)} onEvent={onEvent} />\n}\n\n/* @internal /\nexport function OnboardingSummary() {\n const { employeeId, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <OnboardingSummaryComponent\n employeeId={ensureRequired(employeeId)}\n onEvent={onEvent}\n isAdmin={false}\n />\n )\n}\n\n/* @internal */\nexport function DocumentSigner() {\n const { employeeId, withEmployeeI9 = false, onEvent } = useFlow<SelfOnboardingContextInterface>()\n return (\n <DocumentSignerComponent\n employeeId={ensureRequired(employeeId)}\n withEmployeeI9={withEmployeeI9}\n onEvent={onEvent}\n />\n )\n}\n"],"names":["Landing","companyId","employeeId","onEvent","useFlow","jsx","LandingComponent","ensureRequired","Profile","ProfileComponent","FederalTaxes","FederalTaxesComponent","StateTaxes","StateTaxesComponent","PaymentMethod","PaymentMethodComponent","OnboardingSummary","OnboardingSummaryComponent","DocumentSigner","withEmployeeI9","DocumentSignerComponent"],"mappings":";;;;;;;;;;AAoCO,SAASA,IAAU;AACxB,QAAM,EAAE,WAAAC,GAAW,YAAAC,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAC3C,SACE,gBAAAC;AAAA,IAACC;AAAAA,IAAA;AAAA,MACC,WAAWC,EAAeN,CAAS;AAAA,MACnC,YAAYM,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;AAGO,SAASK,IAAU;AACxB,QAAM,EAAE,WAAAP,GAAW,YAAAC,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAC3C,SACE,gBAAAC;AAAA,IAACI;AAAAA,IAAA;AAAA,MACC,WAAWF,EAAeN,CAAS;AAAA,MACnC,YAAYM,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,MACA,SAAS;AAAA,IAAA;AAAA,EAAA;AAGf;AAGO,SAASO,IAAe;AAC7B,QAAM,EAAE,YAAAR,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQO,GAAA,EAAsB,YAAYJ,EAAeL,CAAU,GAAG,SAAAC,GAAkB;AAC1F;AAGO,SAASS,IAAa;AAC3B,QAAM,EAAE,YAAAV,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,SACE,gBAAAC;AAAA,IAACQ;AAAAA,IAAA;AAAA,MACC,YAAYN,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,MACA,SAAS;AAAA,IAAA;AAAA,EAAA;AAGf;AAGO,SAASW,IAAgB;AAC9B,QAAM,EAAE,YAAAZ,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQW,GAAA,EAAuB,YAAYR,EAAeL,CAAU,GAAG,SAAAC,GAAkB;AAC3F;AAGO,SAASa,IAAoB;AAClC,QAAM,EAAE,YAAAd,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,SACE,gBAAAC;AAAA,IAACY;AAAAA,IAAA;AAAA,MACC,YAAYV,EAAeL,CAAU;AAAA,MACrC,SAAAC;AAAA,MACA,SAAS;AAAA,IAAA;AAAA,EAAA;AAGf;AAGO,SAASe,IAAiB;AAC/B,QAAM,EAAE,YAAAhB,GAAY,gBAAAiB,IAAiB,IAAO,SAAAhB,EAAA,IAAYC,EAAA;AACxD,SACE,gBAAAC;AAAA,IAACe;AAAAA,IAAA;AAAA,MACC,YAAYb,EAAeL,CAAU;AAAA,MACrC,gBAAAiB;AAAA,MACA,SAAAhB;AAAA,IAAA;AAAA,EAAA;AAGN;"}

package/dist/components/Employee/SelfOnboardingFlow/SelfOnboardingFlow.d.ts CHANGED Viewed

@@ -1,2 +1,33 @@
 import { SelfOnboardingFlowProps } from './SelfOnboardingComponents';
+/**
+ * Employee-driven onboarding workflow — landing, profile, taxes, payment method, and document signing.
+ *
+ * @remarks
+ * Hands the employee responsibility for submitting their own profile, tax, payment, and document-signing information. Drives a multi-step flow keyed to the employee being self-onboarded; when `withEmployeeI9` is enabled, the Document Signer step checks whether the employee has I-9 enabled and, if so, routes them through the employment-eligibility form before presenting the I-9 form alongside other required documents.
+ *
+ * Each step is also exported as a standalone block — see {@link Landing}, {@link Profile}, {@link FederalTaxes}, {@link StateTaxes}, {@link PaymentMethod}, {@link DocumentSigner}, {@link EmploymentEligibility}, and {@link OnboardingSummary} — for composing a custom workflow when this orchestration is the wrong fit.
+ *
+ * The flow forwards every event emitted by its sub-components to `onEvent`; see the events table on each sub-component for the full set of events and payloads observable from this flow.
+ *
+ * @param props - See {@link SelfOnboardingFlowProps}.
+ * @returns The multi-step self-onboarding flow.
+ * @public
+ * @group Flow Components
+ *
+ * @example
+ * ```tsx
+ * import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'
+ *
+ * function MyApp() {
+ *   return (
+ *     <EmployeeOnboarding.SelfOnboardingFlow
+ *       companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365"
+ *       employeeId="4b3f930f-82cd-48a8-b797-798686e12e5e"
+ *       withEmployeeI9
+ *       onEvent={() => {}}
+ *     />
+ *   )
+ * }
+ * ```
+ */
 export declare const SelfOnboardingFlow: ({ companyId, employeeId, withEmployeeI9, onEvent, }: SelfOnboardingFlowProps) => import("react").JSX.Element;

package/dist/components/Employee/SelfOnboardingFlow/SelfOnboardingFlow.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SelfOnboardingFlow.js","sources":["../../../../src/components/Employee/SelfOnboardingFlow/SelfOnboardingFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport type {\n SelfOnboardingContextInterface,\n SelfOnboardingFlowProps,\n} from './SelfOnboardingComponents'\nimport { Landing } from './SelfOnboardingComponents'\nimport { employeeSelfOnboardingMachine } from './selfOnboardingMachine'\nimport { Flow } from '@/components/Flow/Flow'\n\nexport const SelfOnboardingFlow = ({\n companyId,\n employeeId,\n withEmployeeI9 = false,\n onEvent,\n}: SelfOnboardingFlowProps) => {\n const manageEmployees = useMemo(\n () =>\n createMachine(\n 'index',\n employeeSelfOnboardingMachine,\n (initialContext: SelfOnboardingContextInterface) => ({\n ...initialContext,\n component: Landing,\n companyId,\n employeeId,\n withEmployeeI9,\n }),\n ),\n [companyId, employeeId, withEmployeeI9],\n )\n return <Flow machine={manageEmployees} onEvent={onEvent} />\n}\n"],"names":["SelfOnboardingFlow","companyId","employeeId","withEmployeeI9","onEvent","manageEmployees","useMemo","createMachine","employeeSelfOnboardingMachine","initialContext","Landing","jsx","Flow"],"mappings":";;;;;;~~AAUO~~,MAAMA,IAAqB,CAAC;AAAA,EACjC,WAAAC;AAAA,EACA,YAAAC;AAAA,EACA,gBAAAC,IAAiB;AAAA,EACjB,SAAAC;AACF,MAA+B;AAC7B,QAAMC,IAAkBC;AAAA,IACtB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAoD;AAAA,QACnD,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAT;AAAA,QACA,YAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACF,GAAWC,GAAYC,CAAc;AAAA,EAAA;AAExC,SAAO,gBAAAQ,EAACC,GAAA,EAAK,SAASP,GAAiB,SAAAD,EAAA,CAAkB;AAC3D;"}
1	+ {"version":3,"file":"SelfOnboardingFlow.js","sources":["../../../../src/components/Employee/SelfOnboardingFlow/SelfOnboardingFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport type {\n SelfOnboardingContextInterface,\n SelfOnboardingFlowProps,\n} from './SelfOnboardingComponents'\nimport { Landing } from './SelfOnboardingComponents'\nimport { employeeSelfOnboardingMachine } from './selfOnboardingMachine'\nimport { Flow } from '@/components/Flow/Flow'\n\n/*\n Employee-driven onboarding workflow — landing, profile, taxes, payment method, and document signing.\n \n @remarks\n * Hands the employee responsibility for submitting their own profile, tax, payment, and document-signing information. Drives a multi-step flow keyed to the employee being self-onboarded; when `withEmployeeI9` is enabled, the Document Signer step checks whether the employee has I-9 enabled and, if so, routes them through the employment-eligibility form before presenting the I-9 form alongside other required documents.\n \n Each step is also exported as a standalone block — see {@link Landing}, {@link Profile}, {@link FederalTaxes}, {@link StateTaxes}, {@link PaymentMethod}, {@link DocumentSigner}, {@link EmploymentEligibility}, and {@link OnboardingSummary} — for composing a custom workflow when this orchestration is the wrong fit.\n \n The flow forwards every event emitted by its sub-components to `onEvent`; see the events table on each sub-component for the full set of events and payloads observable from this flow.\n \n @param props - See {@link SelfOnboardingFlowProps}.\n * @returns The multi-step self-onboarding flow.\n * @public\n * @group Flow Components\n \n @example\n * ```tsx\n * import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'\n \n function MyApp() {\n * return (\n * <EmployeeOnboarding.SelfOnboardingFlow\n * companyId=\"a007e1ab-3595-43c2-ab4b-af7a5af2e365\"\n * employeeId=\"4b3f930f-82cd-48a8-b797-798686e12e5e\"\n * withEmployeeI9\n * onEvent={() => {}}\n * />\n * )\n * }\n * ```\n */\nexport const SelfOnboardingFlow = ({\n companyId,\n employeeId,\n withEmployeeI9 = false,\n onEvent,\n}: SelfOnboardingFlowProps) => {\n const manageEmployees = useMemo(\n () =>\n createMachine(\n 'index',\n employeeSelfOnboardingMachine,\n (initialContext: SelfOnboardingContextInterface) => ({\n ...initialContext,\n component: Landing,\n companyId,\n employeeId,\n withEmployeeI9,\n }),\n ),\n [companyId, employeeId, withEmployeeI9],\n )\n return <Flow machine={manageEmployees} onEvent={onEvent} />\n}\n"],"names":["SelfOnboardingFlow","companyId","employeeId","withEmployeeI9","onEvent","manageEmployees","useMemo","createMachine","employeeSelfOnboardingMachine","initialContext","Landing","jsx","Flow"],"mappings":";;;;;;AAyCO,MAAMA,IAAqB,CAAC;AAAA,EACjC,WAAAC;AAAA,EACA,YAAAC;AAAA,EACA,gBAAAC,IAAiB;AAAA,EACjB,SAAAC;AACF,MAA+B;AAC7B,QAAMC,IAAkBC;AAAA,IACtB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAoD;AAAA,QACnD,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAT;AAAA,QACA,YAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACF,GAAWC,GAAYC,CAAc;AAAA,EAAA;AAExC,SAAO,gBAAAQ,EAACC,GAAA,EAAK,SAASP,GAAiB,SAAAD,EAAA,CAAkB;AAC3D;"}

package/dist/components/Employee/SelfOnboardingFlow/selfOnboardingMachine.d.ts CHANGED Viewed

@@ -1,3 +1,4 @@
+/** @internal */
 export declare const employeeSelfOnboardingMachine: {
     index: import('robot3').MachineState<any>;
     employeeProfile: import('robot3').MachineState<any>;

package/dist/components/Employee/SelfOnboardingFlow/selfOnboardingMachine.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"selfOnboardingMachine.js","sources":["../../../../src/components/Employee/SelfOnboardingFlow/selfOnboardingMachine.ts"],"sourcesContent":["import { transition, reduce, state } from 'robot3'\nimport type { SelfOnboardingContextInterface } from './SelfOnboardingComponents'\nimport {\n Profile,\n FederalTaxes,\n StateTaxes,\n PaymentMethod,\n OnboardingSummary,\n DocumentSigner,\n} from './SelfOnboardingComponents'\nimport { componentEvents } from '@/shared/constants'\nimport type { MachineTransition } from '@/types/Helpers'\n\nexport const employeeSelfOnboardingMachine = {\n index: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_SELF_ONBOARDING_START,\n 'employeeProfile',\n reduce(\n (ctx: SelfOnboardingContextInterface): SelfOnboardingContextInterface => ({\n ...ctx,\n component: Profile,\n }),\n ),\n ),\n ),\n employeeProfile: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_PROFILE_DONE,\n 'employeeFederalTaxes',\n reduce(\n (ctx: SelfOnboardingContextInterface): SelfOnboardingContextInterface => ({\n ...ctx,\n component: FederalTaxes,\n }),\n ),\n ),\n ),\n employeeFederalTaxes: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_FEDERAL_TAXES_DONE,\n 'employeeStateTaxes',\n reduce(\n (ctx: SelfOnboardingContextInterface): SelfOnboardingContextInterface => ({\n ...ctx,\n component: StateTaxes,\n }),\n ),\n ),\n ),\n employeeStateTaxes: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_STATE_TAXES_DONE,\n 'employeePaymentMethod',\n reduce((ctx: SelfOnboardingContextInterface) => ({\n ...ctx,\n component: PaymentMethod,\n })),\n ),\n ),\n employeePaymentMethod: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_PAYMENT_METHOD_DONE,\n 'employeeDocumentSigner',\n reduce((ctx: SelfOnboardingContextInterface) => ({\n ...ctx,\n component: DocumentSigner,\n })),\n ),\n ),\n employeeDocumentSigner: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_FORMS_DONE,\n 'index',\n reduce((ctx: SelfOnboardingContextInterface) => ({\n ...ctx,\n component: OnboardingSummary,\n })),\n ),\n ),\n}\n"],"names":["employeeSelfOnboardingMachine","state","transition","componentEvents","reduce","ctx","Profile","FederalTaxes","StateTaxes","PaymentMethod","DocumentSigner","OnboardingSummary"],"mappings":";;;~~AAaO~~,MAAMA,IAAgC;AAAA,EAC3C,OAAOC;AAAA,IACLC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CAACC,OAAyE;AAAA,UACxE,GAAGA;AAAA,UACH,WAAWC;AAAA,QAAA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEF,iBAAiBL;AAAA,IACfC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CAACC,OAAyE;AAAA,UACxE,GAAGA;AAAA,UACH,WAAWE;AAAA,QAAA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEF,sBAAsBN;AAAA,IACpBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CAACC,OAAyE;AAAA,UACxE,GAAGA;AAAA,UACH,WAAWG;AAAA,QAAA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEF,oBAAoBP;AAAA,IAClBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAO,CAACC,OAAyC;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWI;AAAA,MAAA,EACX;AAAA,IAAA;AAAA,EACJ;AAAA,EAEF,uBAAuBR;AAAA,IACrBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAO,CAACC,OAAyC;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWK;AAAA,MAAA,EACX;AAAA,IAAA;AAAA,EACJ;AAAA,EAEF,wBAAwBT;AAAA,IACtBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAO,CAACC,OAAyC;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWM;AAAA,MAAA,EACX;AAAA,IAAA;AAAA,EACJ;AAEJ;"}
1	+ {"version":3,"file":"selfOnboardingMachine.js","sources":["../../../../src/components/Employee/SelfOnboardingFlow/selfOnboardingMachine.ts"],"sourcesContent":["import { transition, reduce, state } from 'robot3'\nimport type { SelfOnboardingContextInterface } from './SelfOnboardingComponents'\nimport {\n Profile,\n FederalTaxes,\n StateTaxes,\n PaymentMethod,\n OnboardingSummary,\n DocumentSigner,\n} from './SelfOnboardingComponents'\nimport { componentEvents } from '@/shared/constants'\nimport type { MachineTransition } from '@/types/Helpers'\n\n/** @internal */\nexport const employeeSelfOnboardingMachine = {\n index: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_SELF_ONBOARDING_START,\n 'employeeProfile',\n reduce(\n (ctx: SelfOnboardingContextInterface): SelfOnboardingContextInterface => ({\n ...ctx,\n component: Profile,\n }),\n ),\n ),\n ),\n employeeProfile: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_PROFILE_DONE,\n 'employeeFederalTaxes',\n reduce(\n (ctx: SelfOnboardingContextInterface): SelfOnboardingContextInterface => ({\n ...ctx,\n component: FederalTaxes,\n }),\n ),\n ),\n ),\n employeeFederalTaxes: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_FEDERAL_TAXES_DONE,\n 'employeeStateTaxes',\n reduce(\n (ctx: SelfOnboardingContextInterface): SelfOnboardingContextInterface => ({\n ...ctx,\n component: StateTaxes,\n }),\n ),\n ),\n ),\n employeeStateTaxes: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_STATE_TAXES_DONE,\n 'employeePaymentMethod',\n reduce((ctx: SelfOnboardingContextInterface) => ({\n ...ctx,\n component: PaymentMethod,\n })),\n ),\n ),\n employeePaymentMethod: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_PAYMENT_METHOD_DONE,\n 'employeeDocumentSigner',\n reduce((ctx: SelfOnboardingContextInterface) => ({\n ...ctx,\n component: DocumentSigner,\n })),\n ),\n ),\n employeeDocumentSigner: state<MachineTransition>(\n transition(\n componentEvents.EMPLOYEE_FORMS_DONE,\n 'index',\n reduce((ctx: SelfOnboardingContextInterface) => ({\n ...ctx,\n component: OnboardingSummary,\n })),\n ),\n ),\n}\n"],"names":["employeeSelfOnboardingMachine","state","transition","componentEvents","reduce","ctx","Profile","FederalTaxes","StateTaxes","PaymentMethod","DocumentSigner","OnboardingSummary"],"mappings":";;;AAcO,MAAMA,IAAgC;AAAA,EAC3C,OAAOC;AAAA,IACLC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CAACC,OAAyE;AAAA,UACxE,GAAGA;AAAA,UACH,WAAWC;AAAA,QAAA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEF,iBAAiBL;AAAA,IACfC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CAACC,OAAyE;AAAA,UACxE,GAAGA;AAAA,UACH,WAAWE;AAAA,QAAA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEF,sBAAsBN;AAAA,IACpBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CAACC,OAAyE;AAAA,UACxE,GAAGA;AAAA,UACH,WAAWG;AAAA,QAAA;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEF,oBAAoBP;AAAA,IAClBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAO,CAACC,OAAyC;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWI;AAAA,MAAA,EACX;AAAA,IAAA;AAAA,EACJ;AAAA,EAEF,uBAAuBR;AAAA,IACrBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAO,CAACC,OAAyC;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWK;AAAA,MAAA,EACX;AAAA,IAAA;AAAA,EACJ;AAAA,EAEF,wBAAwBT;AAAA,IACtBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAO,CAACC,OAAyC;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWM;AAAA,MAAA,EACX;AAAA,IAAA;AAAA,EACJ;AAEJ;"}

package/dist/components/Employee/StateTaxes/index.d.ts CHANGED Viewed

@@ -1,3 +1,3 @@
 import "./types/i18next.d.ts"
-export { StateTaxes, StateTaxesCard, StateTaxesEditForm, type StateTaxesProps, type StateTaxesCardProps, type StateTaxesEditFormProps, } from './management';
+export { StateTaxes } from './management';
 export * from './shared';