@gusto/embedded-react-sdk 0.46.2 → 0.47.0

package/dist/shared/constants.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Event keys emitted by employee-related components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of an employee component (e.g. `EmployeeOnboarding`,
+ * `EmployeeProfile`) and compare against the value of an entry on this object.
+ *
+ * @public
+ */
 export declare const employeeEvents: {
     readonly EMPLOYEE_CREATE: "employee/create";
     readonly EMPLOYEE_CREATED: "employee/created";
@@ -7,11 +17,13 @@ export declare const employeeEvents: {
     readonly EMPLOYEE_DISMISS: "employee/dismiss";
     readonly EMPLOYEE_ONBOARDING_DONE: "employee/onboarding/done";
     readonly EMPLOYEE_PROFILE_DONE: "employee/profile/done";
-    readonly EMPLOYEE_HOME_ADDRESS: "employee/addresses/home";
-    readonly EMPLOYEE_HOME_ADDRESS_UPDATE: "employee/addresses/home/update";
     readonly EMPLOYEE_HOME_ADDRESS_CREATED: "employee/addresses/home/created";
     readonly EMPLOYEE_HOME_ADDRESS_UPDATED: "employee/addresses/home/updated";
-    readonly EMPLOYEE_HOME_ADDRESS_DELETED: "employee/addresses/home/deleted";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_EDIT_REQUESTED: "employee/management/homeAddress/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_EDIT_CANCELLED: "employee/management/homeAddress/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_CREATED: "employee/management/homeAddress/created";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_UPDATED: "employee/management/homeAddress/updated";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_DELETED: "employee/management/homeAddress/deleted";
     readonly EMPLOYEE_WORK_ADDRESS: "employee/addresses/work";
     readonly EMPLOYEE_WORK_ADDRESS_UPDATE: "employee/addresses/work/update";
     readonly EMPLOYEE_WORK_ADDRESS_CREATED: "employee/addresses/work/created";
@@ -48,9 +60,12 @@ export declare const employeeEvents: {
     readonly EMPLOYEE_FEDERAL_TAXES_EDIT: "employee/federalTaxes/edit";
     readonly EMPLOYEE_FEDERAL_TAXES_UPDATED: "employee/federalTaxes/updated";
     readonly EMPLOYEE_FEDERAL_TAXES_DONE: "employee/federalTaxes/done";
-    readonly EMPLOYEE_STATE_TAXES_EDIT: "employee/stateTaxes/edit";
     readonly EMPLOYEE_STATE_TAXES_UPDATED: "employee/stateTaxes/updated";
     readonly EMPLOYEE_STATE_TAXES_DONE: "employee/stateTaxes/done";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_EDIT_REQUESTED: "employee/management/stateTaxes/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_EDIT_CANCELLED: "employee/management/stateTaxes/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_UPDATED: "employee/management/stateTaxes/updated";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_ALERT_DISMISSED: "employee/management/stateTaxes/alertDismissed";
     readonly EMPLOYEE_TAXES_DONE: "employee/taxes/done";
     readonly EMPLOYEE_SPLIT_PAYCHECK: "employee/bankAccount/split";
     readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
@@ -70,7 +85,60 @@ export declare const employeeEvents: {
     readonly EMPLOYEE_REHIRE: "employee/rehire";
     readonly EMPLOYEE_DASHBOARD_TAB_CHANGE: "employee/dashboard/tabChange";
     readonly EMPLOYEE_RETURN_TO_LIST: "employee/returnToList";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_EDIT_REQUESTED: "employee/management/profile/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_UPDATED: "employee/management/profile/updated";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_EDIT_CANCELLED: "employee/management/profile/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_ALERT_DISMISSED: "employee/management/profile/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_EDIT_REQUESTED: "employee/management/workAddress/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_CREATED: "employee/management/workAddress/created";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_UPDATED: "employee/management/workAddress/updated";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_DELETED: "employee/management/workAddress/deleted";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_EDIT_CANCELLED: "employee/management/workAddress/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_ADD_REQUESTED: "employee/management/paymentMethod/card/addRequested";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_SPLIT_REQUESTED: "employee/management/paymentMethod/card/splitRequested";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_BANK_ACCOUNT_DELETED: "employee/management/paymentMethod/card/bankAccountDeleted";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_BANK_FORM_SUBMITTED: "employee/management/paymentMethod/bankForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_BANK_FORM_CANCELLED: "employee/management/paymentMethod/bankForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_SPLIT_FORM_SUBMITTED: "employee/management/paymentMethod/splitForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_SPLIT_FORM_CANCELLED: "employee/management/paymentMethod/splitForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_ALERT_DISMISSED: "employee/management/paymentMethod/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_PAYSTUBS_CARD_DOWNLOAD_REQUESTED: "employee/management/paystubs/card/downloadRequested";
+    readonly EMPLOYEE_MANAGEMENT_PAYSTUBS_CARD_DOWNLOADED: "employee/management/paystubs/card/downloaded";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_ADD_REQUESTED: "employee/management/deductions/card/addRequested";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_EDIT_REQUESTED: "employee/management/deductions/card/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_DELETED: "employee/management/deductions/card/deleted";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_CREATED: "employee/management/deductions/editForm/created";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_UPDATED: "employee/management/deductions/editForm/updated";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_CANCELLED: "employee/management/deductions/editForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_ALERT_DISMISSED: "employee/management/deductions/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_CARD_EDIT_REQUESTED: "employee/management/federalTaxes/card/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_EDIT_FORM_SUBMITTED: "employee/management/federalTaxes/editForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_EDIT_FORM_CANCELLED: "employee/management/federalTaxes/editForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_ALERT_DISMISSED: "employee/management/federalTaxes/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_DOCUMENTS_CARD_VIEW_REQUESTED: "employee/management/documents/card/viewRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_EDIT_REQUESTED: "employee/management/compensation/card/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_ADD_REQUESTED: "employee/management/compensation/card/addRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_ADD_ANOTHER_REQUESTED: "employee/management/compensation/card/addAnotherRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_JOB_DELETED: "employee/management/compensation/card/jobDeleted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_CHANGE_CANCELLED: "employee/management/compensation/card/changeCancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_EDIT_FORM_SUBMITTED: "employee/management/compensation/editForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_EDIT_FORM_CANCELLED: "employee/management/compensation/editForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_JOB_FORM_SUBMITTED: "employee/management/compensation/addJobForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_JOB_FORM_CANCELLED: "employee/management/compensation/addJobForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_ANOTHER_JOB_FORM_SUBMITTED: "employee/management/compensation/addAnotherJobForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_ANOTHER_JOB_FORM_CANCELLED: "employee/management/compensation/addAnotherJobForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ALERT_DISMISSED: "employee/management/compensation/alertDismissed";
 };
+/**
+ * Event keys emitted by company-related components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a company component (e.g. company onboarding, signatory,
+ * bank account, locations) and compare against the value of an entry on this object.
+ *
+ * @public
+ */
 export declare const companyEvents: {
     readonly COMPANY_INDUSTRY: "company/industry";
     readonly COMPANY_INDUSTRY_SELECTED: "company/industry/selected";
@@ -106,6 +174,16 @@ export declare const companyEvents: {
     readonly COMPANY_OVERVIEW_DONE: "company/overview/done";
     readonly COMPANY_OVERVIEW_CONTINUE: "company/overview/continue";
 };
+/**
+ * Event keys emitted by contractor-related components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a contractor component (e.g. contractor onboarding,
+ * profile, payment method) and compare against the value of an entry on this object.
+ *
+ * @public
+ */
 export declare const contractorEvents: {
     readonly CONTRACTOR_ADDRESS_UPDATED: "contractor/address/updated";
     readonly CONTRACTOR_ADDRESS_DONE: "contractor/address/done";
@@ -125,6 +203,16 @@ export declare const contractorEvents: {
     readonly CONTRACTOR_INVITE_CONTRACTOR: "contractor/invite/selfOnboarding";
     readonly CONTRACTOR_ONBOARDING_CONTINUE: "contractor/onboarding/continue";
 };
+/**
+ * Event keys emitted by contractor payment components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a contractor payment component and compare against the
+ * value of an entry on this object.
+ *
+ * @public
+ */
 export declare const contractorPaymentEvents: {
     readonly CONTRACTOR_PAYMENT_CREATE: "contractor/payments/create";
     readonly CONTRACTOR_PAYMENT_EDIT: "contractor/payments/edit";
@@ -139,6 +227,16 @@ export declare const contractorPaymentEvents: {
     readonly CONTRACTOR_PAYMENT_EXIT: "contractor/payments/exit";
     readonly CONTRACTOR_PAYMENT_RFI_RESPOND: "contractor/payments/rfi/respond";
 };
+/**
+ * Event keys emitted by employee termination components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a termination component and compare against the value of
+ * an entry on this object.
+ *
+ * @public
+ */
 export declare const terminationEvents: {
     readonly EMPLOYEE_TERMINATION_CREATED: "employee/termination/created";
     readonly EMPLOYEE_TERMINATION_UPDATED: "employee/termination/updated";
@@ -151,6 +249,16 @@ export declare const terminationEvents: {
     readonly EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL: "employee/termination/runOffCyclePayroll";
     readonly EMPLOYEE_TERMINATION_VIEW_SUMMARY: "employee/termination/viewSummary";
 };
+/**
+ * Event keys emitted by pay schedule components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a pay schedule component and compare against the value
+ * of an entry on this object.
+ *
+ * @public
+ */
 export declare const payScheduleEvents: {
     readonly PAY_SCHEDULE_CREATE: "paySchedule/create";
     readonly PAY_SCHEDULE_CREATED: "paySchedule/created";
@@ -160,6 +268,17 @@ export declare const payScheduleEvents: {
     readonly PAY_SCHEDULE_DELETED: "paySchedule/deleted";
     readonly PAY_SCHEDULE_DONE: "paySchedule/done";
 };
+/**
+ * Event keys emitted by run-payroll components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a payroll component (e.g. `PayrollFlow`, run-payroll,
+ * off-cycle payroll, gross-up) and compare against the value of an entry on
+ * this object.
+ *
+ * @public
+ */
 export declare const runPayrollEvents: {
     readonly RUN_PAYROLL_BACK: "runPayroll/back";
     readonly RUN_PAYROLL_CALCULATED: "runPayroll/calculated";
@@ -193,6 +312,16 @@ export declare const runPayrollEvents: {
     readonly RUN_PAYROLL_GROSS_UP_SELECTED: "runPayroll/grossUp/selected";
     readonly RUN_PAYROLL_GROSS_UP_CALCULATED: "runPayroll/grossUp/calculated";
 };
+/**
+ * Event keys emitted by payroll wire transfer components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a wire transfer component and compare against the value
+ * of an entry on this object.
+ *
+ * @public
+ */
 export declare const payrollWireEvents: {
     readonly PAYROLL_WIRE_START_TRANSFER: "payroll/wire/startTransfer";
     readonly PAYROLL_WIRE_INSTRUCTIONS_DONE: "payroll/wire/instructions/done";
@@ -201,18 +330,48 @@ export declare const payrollWireEvents: {
     readonly PAYROLL_WIRE_FORM_DONE: "payroll/wire/form/done";
     readonly PAYROLL_WIRE_FORM_CANCEL: "payroll/wire/form/cancel";
 };
+/**
+ * Event keys emitted by information request components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of an information request component and compare against
+ * the value of an entry on this object.
+ *
+ * @public
+ */
 export declare const informationRequestEvents: {
     readonly INFORMATION_REQUEST_RESPOND: "informationRequest/respond";
     readonly INFORMATION_REQUEST_FORM_SUBMIT: "informationRequest/form/submit";
     readonly INFORMATION_REQUEST_FORM_CANCEL: "informationRequest/form/cancel";
     readonly INFORMATION_REQUEST_FORM_DONE: "informationRequest/form/done";
 };
+/**
+ * Event keys emitted by recovery case components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a recovery case component and compare against the value
+ * of an entry on this object.
+ *
+ * @public
+ */
 export declare const recoveryCasesEvents: {
     readonly RECOVERY_CASE_RESOLVE: "recoveryCase/resolve";
     readonly RECOVERY_CASE_RESUBMIT: "recoveryCase/resubmit";
     readonly RECOVERY_CASE_RESUBMIT_CANCEL: "recoveryCase/resubmit/cancel";
     readonly RECOVERY_CASE_RESUBMIT_DONE: "recoveryCase/resubmit/done";
 };
+/**
+ * Event keys emitted by off-cycle payroll and transition components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of an off-cycle payroll or transition component and compare
+ * against the value of an entry on this object.
+ *
+ * @public
+ */
 export declare const offCycleEvents: {
     readonly OFF_CYCLE_CREATED: "offCycle/created";
     readonly DISMISSAL_PAY_PERIOD_SELECTED: "dismissal/payPeriod/selected";
@@ -220,6 +379,17 @@ export declare const offCycleEvents: {
     readonly RUN_TRANSITION_PAYROLL: "transition/runPayroll";
     readonly TRANSITION_PAYROLL_SKIPPED: "transition/payrollSkipped";
 };
+/**
+ * Event keys emitted by time-off policy components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a time-off component (e.g. policy creation, holiday
+ * scheduling, policy management) and compare against the value of an entry on
+ * this object.
+ *
+ * @public
+ */
 export declare const timeOffEvents: {
     readonly TIME_OFF_CREATE_POLICY: "timeOff/createPolicy";
     readonly TIME_OFF_VIEW_POLICY: "timeOff/viewPolicy";
@@ -249,6 +419,34 @@ export declare const timeOffEvents: {
     readonly TIME_OFF_HOLIDAY_SELECTION_EDIT_DONE: "timeOff/holidaySelection/editDone";
     readonly TIME_OFF_DELETE_POLICY_DONE: "timeOff/deletePolicy/done";
 };
+/**
+ * Catalog of every event key that an SDK component can emit through `onEvent`.
+ *
+ * @remarks
+ * Components surface user actions and lifecycle transitions to the integrating
+ * application through an `onEvent(type, data)` callback. The `type` argument is
+ * always one of the string values in this object. Use this map to compare
+ * against the incoming `type` rather than hard-coding strings.
+ *
+ * All domain-specific event groups are spread into this object alongside
+ * a few cross-cutting keys: `ERROR`, `CANCEL`, and `BREADCRUMB_NAVIGATE`.
+ *
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { componentEvents, EmployeeOnboarding } from '@gusto/embedded-react-sdk'
+ *
+ * <EmployeeOnboarding
+ *   companyId={companyId}
+ *   onEvent={(type, data) => {
+ *     if (type === componentEvents.EMPLOYEE_ONBOARDING_DONE) {
+ *       navigate('/employees')
+ *     }
+ *   }}
+ * />
+ * ```
+ */
 export declare const componentEvents: {
     readonly TIME_OFF_CREATE_POLICY: "timeOff/createPolicy";
     readonly TIME_OFF_VIEW_POLICY: "timeOff/viewPolicy";
@@ -414,11 +612,13 @@ export declare const componentEvents: {
     readonly EMPLOYEE_DISMISS: "employee/dismiss";
     readonly EMPLOYEE_ONBOARDING_DONE: "employee/onboarding/done";
     readonly EMPLOYEE_PROFILE_DONE: "employee/profile/done";
-    readonly EMPLOYEE_HOME_ADDRESS: "employee/addresses/home";
-    readonly EMPLOYEE_HOME_ADDRESS_UPDATE: "employee/addresses/home/update";
     readonly EMPLOYEE_HOME_ADDRESS_CREATED: "employee/addresses/home/created";
     readonly EMPLOYEE_HOME_ADDRESS_UPDATED: "employee/addresses/home/updated";
-    readonly EMPLOYEE_HOME_ADDRESS_DELETED: "employee/addresses/home/deleted";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_EDIT_REQUESTED: "employee/management/homeAddress/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_EDIT_CANCELLED: "employee/management/homeAddress/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_CREATED: "employee/management/homeAddress/created";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_UPDATED: "employee/management/homeAddress/updated";
+    readonly EMPLOYEE_MANAGEMENT_HOME_ADDRESS_DELETED: "employee/management/homeAddress/deleted";
     readonly EMPLOYEE_WORK_ADDRESS: "employee/addresses/work";
     readonly EMPLOYEE_WORK_ADDRESS_UPDATE: "employee/addresses/work/update";
     readonly EMPLOYEE_WORK_ADDRESS_CREATED: "employee/addresses/work/created";
@@ -455,9 +655,12 @@ export declare const componentEvents: {
     readonly EMPLOYEE_FEDERAL_TAXES_EDIT: "employee/federalTaxes/edit";
     readonly EMPLOYEE_FEDERAL_TAXES_UPDATED: "employee/federalTaxes/updated";
     readonly EMPLOYEE_FEDERAL_TAXES_DONE: "employee/federalTaxes/done";
-    readonly EMPLOYEE_STATE_TAXES_EDIT: "employee/stateTaxes/edit";
     readonly EMPLOYEE_STATE_TAXES_UPDATED: "employee/stateTaxes/updated";
     readonly EMPLOYEE_STATE_TAXES_DONE: "employee/stateTaxes/done";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_EDIT_REQUESTED: "employee/management/stateTaxes/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_EDIT_CANCELLED: "employee/management/stateTaxes/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_UPDATED: "employee/management/stateTaxes/updated";
+    readonly EMPLOYEE_MANAGEMENT_STATE_TAXES_ALERT_DISMISSED: "employee/management/stateTaxes/alertDismissed";
     readonly EMPLOYEE_TAXES_DONE: "employee/taxes/done";
     readonly EMPLOYEE_SPLIT_PAYCHECK: "employee/bankAccount/split";
     readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
@@ -477,12 +680,85 @@ export declare const componentEvents: {
     readonly EMPLOYEE_REHIRE: "employee/rehire";
     readonly EMPLOYEE_DASHBOARD_TAB_CHANGE: "employee/dashboard/tabChange";
     readonly EMPLOYEE_RETURN_TO_LIST: "employee/returnToList";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_EDIT_REQUESTED: "employee/management/profile/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_UPDATED: "employee/management/profile/updated";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_EDIT_CANCELLED: "employee/management/profile/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_PROFILE_ALERT_DISMISSED: "employee/management/profile/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_EDIT_REQUESTED: "employee/management/workAddress/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_CREATED: "employee/management/workAddress/created";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_UPDATED: "employee/management/workAddress/updated";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_DELETED: "employee/management/workAddress/deleted";
+    readonly EMPLOYEE_MANAGEMENT_WORK_ADDRESS_EDIT_CANCELLED: "employee/management/workAddress/editCancelled";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_ADD_REQUESTED: "employee/management/paymentMethod/card/addRequested";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_SPLIT_REQUESTED: "employee/management/paymentMethod/card/splitRequested";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_BANK_ACCOUNT_DELETED: "employee/management/paymentMethod/card/bankAccountDeleted";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_BANK_FORM_SUBMITTED: "employee/management/paymentMethod/bankForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_BANK_FORM_CANCELLED: "employee/management/paymentMethod/bankForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_SPLIT_FORM_SUBMITTED: "employee/management/paymentMethod/splitForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_SPLIT_FORM_CANCELLED: "employee/management/paymentMethod/splitForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_ALERT_DISMISSED: "employee/management/paymentMethod/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_PAYSTUBS_CARD_DOWNLOAD_REQUESTED: "employee/management/paystubs/card/downloadRequested";
+    readonly EMPLOYEE_MANAGEMENT_PAYSTUBS_CARD_DOWNLOADED: "employee/management/paystubs/card/downloaded";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_ADD_REQUESTED: "employee/management/deductions/card/addRequested";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_EDIT_REQUESTED: "employee/management/deductions/card/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_DELETED: "employee/management/deductions/card/deleted";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_CREATED: "employee/management/deductions/editForm/created";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_UPDATED: "employee/management/deductions/editForm/updated";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_CANCELLED: "employee/management/deductions/editForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_DEDUCTIONS_ALERT_DISMISSED: "employee/management/deductions/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_CARD_EDIT_REQUESTED: "employee/management/federalTaxes/card/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_EDIT_FORM_SUBMITTED: "employee/management/federalTaxes/editForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_EDIT_FORM_CANCELLED: "employee/management/federalTaxes/editForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_ALERT_DISMISSED: "employee/management/federalTaxes/alertDismissed";
+    readonly EMPLOYEE_MANAGEMENT_DOCUMENTS_CARD_VIEW_REQUESTED: "employee/management/documents/card/viewRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_EDIT_REQUESTED: "employee/management/compensation/card/editRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_ADD_REQUESTED: "employee/management/compensation/card/addRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_ADD_ANOTHER_REQUESTED: "employee/management/compensation/card/addAnotherRequested";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_JOB_DELETED: "employee/management/compensation/card/jobDeleted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_CHANGE_CANCELLED: "employee/management/compensation/card/changeCancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_EDIT_FORM_SUBMITTED: "employee/management/compensation/editForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_EDIT_FORM_CANCELLED: "employee/management/compensation/editForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_JOB_FORM_SUBMITTED: "employee/management/compensation/addJobForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_JOB_FORM_CANCELLED: "employee/management/compensation/addJobForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_ANOTHER_JOB_FORM_SUBMITTED: "employee/management/compensation/addAnotherJobForm/submitted";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_ANOTHER_JOB_FORM_CANCELLED: "employee/management/compensation/addAnotherJobForm/cancelled";
+    readonly EMPLOYEE_MANAGEMENT_COMPENSATION_ALERT_DISMISSED: "employee/management/compensation/alertDismissed";
     readonly ROBOT_MACHINE_DONE: "done";
     readonly ERROR: "ERROR";
     readonly CANCEL: "CANCEL";
     readonly BREADCRUMB_NAVIGATE: "breadcrumb/navigate";
 };
+/**
+ * Union of every event string value defined in {@link componentEvents}.
+ *
+ * @remarks
+ * This is the type of the first argument passed to a component's `onEvent`
+ * handler. Use it when typing your own handler so TypeScript can narrow against
+ * the specific event keys you care about.
+ *
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { componentEvents, type EventType } from '@gusto/embedded-react-sdk'
+ *
+ * const handleEvent = (type: EventType, data: unknown) => {
+ *   if (type === componentEvents.EMPLOYEE_CREATED) {
+ *     // ...
+ *   }
+ * }
+ * ```
+ */
 export type EventType = (typeof componentEvents)[keyof typeof componentEvents];
+/**
+ * Map of employee onboarding status values returned by the Gusto API.
+ *
+ * @remarks
+ * Use these keys to compare against the `onboardingStatus` field on an employee
+ * record. The values mirror the strings returned by the API.
+ *
+ * @public
+ */
 export declare const EmployeeOnboardingStatus: {
     readonly ADMIN_ONBOARDING_INCOMPLETE: "admin_onboarding_incomplete";
     readonly SELF_ONBOARDING_PENDING_INVITE: "self_onboarding_pending_invite";
@@ -493,7 +769,26 @@ export declare const EmployeeOnboardingStatus: {
     readonly SELF_ONBOARDING_AWAITING_ADMIN_REVIEW: "self_onboarding_awaiting_admin_review";
     readonly ONBOARDING_COMPLETED: "onboarding_completed";
 };
+/**
+ * Set of {@link EmployeeOnboardingStatus} values that indicate the employee is
+ * completing self-onboarding.
+ *
+ * @remarks
+ * Use this set to check whether an employee is currently in a self-onboarding
+ * flow (invited, started, or overdue) versus an admin-driven onboarding flow.
+ *
+ * @public
+ */
 export declare const EmployeeSelfOnboardingStatuses: Set<"self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue">;
+/**
+ * Map of contractor onboarding status values returned by the Gusto API.
+ *
+ * @remarks
+ * Use these keys to compare against the `onboardingStatus` field on a contractor
+ * record. The values mirror the strings returned by the API.
+ *
+ * @public
+ */
 export declare const ContractorOnboardingStatus: {
     readonly ADMIN_ONBOARDING_INCOMPLETE: "admin_onboarding_incomplete";
     readonly ADMIN_ONBOARDING_REVIEW: "admin_onboarding_review";
@@ -503,8 +798,23 @@ export declare const ContractorOnboardingStatus: {
     readonly SELF_ONBOARDING_REVIEW: "self_onboarding_review";
     readonly ONBOARDING_COMPLETED: "onboarding_completed";
 };
+/**
+ * Set of {@link ContractorOnboardingStatus} values that indicate the contractor
+ * is completing self-onboarding.
+ *
+ * @remarks
+ * Use this set to check whether a contractor is currently in a self-onboarding
+ * flow (not invited, invited, started, or under review) versus an admin-driven
+ * onboarding flow.
+ *
+ * @public
+ */
 export declare const ContractorSelfOnboardingStatuses: Set<"self_onboarding_invited" | "self_onboarding_not_invited" | "self_onboarding_started" | "self_onboarding_review">;
-/**Map of API response flsa statuses */
+/**
+ * Map of API response FLSA statuses.
+ *
+ * @internal
+ */
 export declare const FlsaStatus: {
     readonly EXEMPT: "Exempt";
     readonly SALARIED_NONEXEMPT: "Salaried Nonexempt";
@@ -513,6 +823,7 @@ export declare const FlsaStatus: {
     readonly COMMISSION_ONLY_EXEMPT: "Commission Only Exempt";
     readonly COMMISSION_ONLY_NONEXEMPT: "Commission Only Nonexempt";
 };
+/** @internal */
 export declare const compensationTypeLabels: {
     readonly REIMBURSEMENT_NAME: "reimbursement";
     readonly REGULAR_HOURS_NAME: "regular hours";
@@ -522,17 +833,24 @@ export declare const compensationTypeLabels: {
     readonly CASH_TIPS: "cash tips";
     readonly MINIMUM_WAGE_ADJUSTMENT: "minimum wage adjustment";
 };
+/**
+ * FLSA overtime salary threshold in USD. Mirrors the value in zenpayroll at
+ * config/initializers/constants/pay_period_constants.rb.
+ *
+ * @internal
+ */
 export declare const FLSA_OVERTIME_SALARY_LIMIT = 35568;
-export declare const HOURS_PER_PAY_PERIOD_DAILY = 5.69863;
+/** @internal */
 export declare const HOURS_PER_PAY_PERIOD_WEEKLY = 40;
-export declare const HOURS_PER_PAY_PERIOD_BIWEEKLY = 80;
-export declare const HOURS_PER_PAY_PERIOD_SEMIMONTHLY = 86.666667;
+/** @internal */
 export declare const HOURS_PER_PAY_PERIOD_MONTHLY = 173.333333;
-export declare const HOURS_PER_PAY_PERIOD_QUARTERLY = 520;
-export declare const HOURS_PER_PAY_PERIOD_SEMIANNUALLY = 1040;
+/** @internal */
 export declare const HOURS_PER_PAY_PERIOD_ANNUALLY = 2080;
+/** @internal */
 export declare const I9_FORM_NAME = "US_I-9";
+/** @internal */
 export declare const STATES_ABBR: readonly ["AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY"];
+/** @internal */
 export declare const SIGNATORY_TITLES: {
     readonly OWNER: "owner";
     readonly PRESIDENT: "president";
@@ -542,6 +860,7 @@ export declare const SIGNATORY_TITLES: {
     readonly PARTNER: "partner";
     readonly MEMBER: "member";
 };
+/** @internal */
 export declare const PAY_PERIODS: {
     readonly HOUR: "Hour";
     readonly WEEK: "Week";
@@ -549,44 +868,58 @@ export declare const PAY_PERIODS: {
     readonly YEAR: "Year";
     readonly PAYCHECK: "Paycheck";
 };
+/** @internal */
 export declare const BREAKPOINTS: {
     readonly BASE: "base";
     readonly SMALL: "small";
     readonly MEDIUM: "medium";
     readonly LARGE: "large";
 };
+/** @internal */
 export declare const BREAKPOINTS_VALUES: {
     readonly base: "0rem";
     readonly small: "40rem";
     readonly medium: "48rem";
     readonly large: "64rem";
 };
+/** @internal */
 export declare const PAYMENT_METHODS: {
     readonly check: "Check";
     readonly directDeposit: "Direct Deposit";
 };
+/** @internal */
 export declare const SPLIT_BY: {
     readonly percentage: "Percentage";
     readonly amount: "Amount";
 };
+/** @internal */
 export declare const CONTRACTOR_TYPE: {
     readonly BUSINESS: "Business";
     readonly INDIVIDUAL: "Individual";
 };
+/** @internal */
 export declare const COMPENSATION_NAME_REGULAR_HOURS = "Regular Hours";
+/** @internal */
 export declare const COMPENSATION_NAME_OVERTIME = "Overtime";
+/** @internal */
 export declare const COMPENSATION_NAME_DOUBLE_OVERTIME = "Double overtime";
+/** @internal */
 export declare const HOURS_COMPENSATION_NAMES: string[];
+/** @internal */
 export declare const COMPENSATION_NAME_BONUS = "Bonus";
+/** @internal */
 export declare const COMPENSATION_NAME_PAYCHECK_TIPS = "Paycheck Tips";
+/** @internal */
 export declare const COMPENSATION_NAME_CORRECTION_PAYMENT = "Correction Payment";
+/** @internal */
 export declare const COMPENSATION_NAME_COMMISSION = "Commission";
+/** @internal */
 export declare const COMPENSATION_NAME_CASH_TIPS = "Cash Tips";
+/** @internal */
 export declare const COMPENSATION_NAME_REIMBURSEMENT = "Reimbursement";
-export declare const FIXED_COMPENSATION_NAMES: string[];
-export declare const OWNERS_DRAW = "Owner's Draw";
-export declare const MIN_WAGE_ADJUST = "Minimum Wage Adjustment";
+/** @internal */
 export declare const EXCLUDED_ADDITIONAL_EARNINGS: string[];
+/** @internal */
 export declare const PAYROLL_PROCESSING_STATUS: {
     readonly calculating: "calculating";
     readonly calculate_success: "calculate_success";
@@ -594,5 +927,7 @@ export declare const PAYROLL_PROCESSING_STATUS: {
     readonly submit_success: "submit_success";
     readonly processing_failed: "processing_failed";
 };
+/** @internal */
 export declare const PAYROLL_RESOLVABLE_SUBMISSION_BLOCKER_TYPES: string[];
+/** @internal */
 export declare const TIP_CREDITS_UNSUPPORTED_STATES: string[];