@gusto/embedded-react-sdk 0.7.0 → 0.8.1

package/dist/index.d.ts

@@ -1,1516 +1,5 @@
-import { Actions } from './Actions';
-import { CustomTypeOptions } from 'i18next';
-import { default as default_2 } from 'react';
-import { FallbackProps } from 'react-error-boundary';
-import { FederalForm } from './FederalForm';
-import { FederalHead } from './FederalHead';
-import { FlsaStatusType } from '@gusto/embedded-api/models/components/flsastatustype';
-import { Form } from './Form';
-import { Head } from './Head';
-import { HTMLAttributes } from 'react';
-import { Job } from '@gusto/embedded-api/models/components/job';
-import { JSX } from 'react';
-import { JSX as JSX_2 } from 'react/jsx-runtime';
-import { List } from './List';
-import { ManageSignatories } from './ManageSignatories';
-import { PayScheduleCreateUpdate } from '@gusto/embedded-api/models/components/payschedulecreateupdate';
-import { Preview } from './Preview';
-import { QueryClient } from '@tanstack/react-query';
-import { ReactNode } from 'react';
-import { Signatory } from '@gusto/embedded-api/models/components/signatory';
-import * as v from 'valibot';
-import { WorkAddress } from './WorkAddress';
-
-declare interface APIConfig {
-    baseUrl: string;
-    headers?: Record<string, string | number>;
-}
-
-declare function AssignSignatory(props: AssignSignatoryProps & BaseComponentInterface): JSX_2.Element;
-
-declare namespace AssignSignatory {
-    var Head: () => JSX_2.Element;
-    var Selection: () => JSX_2.Element;
-    var Form: () => JSX_2.Element;
-}
-
-declare type AssignSignatoryDefaultValues = RequireAtLeastOne<{
-    create?: CreateSignatoryDefaultValues;
-    invite?: InviteSignatoryDefaultValues;
-}>;
-
-declare interface AssignSignatoryProps extends CommonComponentInterface {
-    companyId: string;
-    signatoryId?: string;
-    defaultValues?: AssignSignatoryDefaultValues;
-}
-
-declare interface BaseComponentInterface {
-    FallbackComponent?: (props: FallbackProps) => JSX.Element;
-    LoaderComponent?: () => JSX.Element;
-    onEvent: OnEventType<EventType, unknown>;
-    children?: ReactNode;
-}
-
-declare interface CommonComponentInterface {
-    children?: ReactNode;
-    className?: string;
-    defaultValues?: unknown;
-}
-
-export declare namespace Company {
-    export {
-        Industry,
-        AssignSignatory,
-        DocumentList,
-        SignatureForm,
-        DocumentSignerFlow,
-        OnboardingSummary,
-        LocationsFlow,
-        PaySchedule,
-        FederalTaxes
-    }
-}
-
-declare function Compensation(props: CompensationProps & BaseComponentInterface): JSX_2.Element;
-
-declare namespace Compensation {
-    var Head: () => JSX_2.Element;
-    var List: () => JSX_2.Element | undefined;
-    var Actions: () => JSX_2.Element;
-    var Edit: () => JSX_2.Element | undefined;
-}
-
-declare type CompensationDefaultValues = RequireAtLeastOne<{
-    rate?: Job['rate'];
-    title?: Job['title'];
-    paymentUnit?: (typeof PAY_PERIODS)[keyof typeof PAY_PERIODS];
-    flsaStatus?: FlsaStatusType;
-}>;
-
-declare interface CompensationProps extends CommonComponentInterface {
-    employeeId: string;
-    startDate: string;
-    defaultValues?: CompensationDefaultValues;
-}
-
-export declare const componentEvents: {
-    readonly PAY_SCHEDULE_CREATE: "paySchedule/create";
-    readonly PAY_SCHEDULE_CREATED: "paySchedule/created";
-    readonly PAY_SCHEDULE_UPDATE: "paySchedule/update";
-    readonly PAY_SCHEDULE_UPDATED: "paySchedule/updated";
-    readonly PAY_SCHEDULE_DELETE: "paySchedule/delete";
-    readonly PAY_SCHEDULE_DELETED: "paySchedule/deleted";
-    readonly COMPANY_INDUSTRY: "company/industry";
-    readonly COMPANY_INDUSTRY_SELECTED: "company/industry/selected";
-    readonly COMPANY_FEDERAL_TAXES_UPDATED: "company/federalTaxes/updated";
-    readonly COMPANY_FEDERAL_TAXES_DONE: "company/federalTaxes/done";
-    readonly COMPANY_SIGNATORY_CREATED: "company/signatory/created";
-    readonly COMPANY_SIGNATORY_INVITED: "company/signatory/invited";
-    readonly COMPANY_SIGNATORY_UPDATED: "company/signatory/updated";
-    readonly COMPANY_CREATE_SIGNATORY_DONE: "company/signatory/createSignatory/done";
-    readonly COMPANY_INVITE_SIGNATORY_DONE: "company/signatory/inviteSignatory/done";
-    readonly COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED: "company/signatory/assignSignatory/modeUpdated";
-    readonly COMPANY_ASSIGN_SIGNATORY_DONE: "company/signatory/assignSignatory/done";
-    readonly COMPANY_FORM_EDIT_SIGNATORY: "company/forms/editSignatory";
-    readonly COMPANY_FORMS_DONE: "company/forms/done";
-    readonly COMPANY_VIEW_FORM_TO_SIGN: "company/forms/view";
-    readonly COMPANY_SIGN_FORM: "company/forms/sign/signForm";
-    readonly COMPANY_SIGN_FORM_DONE: "company/forms/sign/done";
-    readonly COMPANY_SIGN_FORM_BACK: "company/forms/sign/back";
-    readonly COMPANY_LOCATION_CREATE: "company/location/add";
-    readonly COMPANY_LOCATION_CREATED: "company/location/add/done";
-    readonly COMPANY_LOCATION_EDIT: "company/location/edit";
-    readonly COMPANY_LOCATION_UPDATED: "company/location/edit/done";
-    readonly COMPANY_LOCATION_DONE: "company/location/done";
-    readonly EMPLOYEE_CREATE: "employee/create";
-    readonly EMPLOYEE_CREATED: "employee/created";
-    readonly EMPLOYEE_UPDATE: "employee/update";
-    readonly EMPLOYEE_UPDATED: "employee/updated";
-    readonly EMPLOYEE_DELETED: "employee/deleted";
-    readonly EMPLOYEE_PROFILE_DONE: "employee/profile/done";
-    readonly EMPLOYEE_HOME_ADDRESS: "employee/addresses/home";
-    readonly EMPLOYEE_HOME_ADDRESS_CREATED: "employee/addresses/home/created";
-    readonly EMPLOYEE_HOME_ADDRESS_UPDATED: "employee/addresses/home/updated";
-    readonly EMPLOYEE_WORK_ADDRESS: "employee/addresses/work";
-    readonly EMPLOYEE_WORK_ADDRESS_CREATED: "employee/addresses/work/created";
-    readonly EMPLOYEE_WORK_ADDRESS_UPDATED: "employee/addresses/work/updated";
-    readonly EMPLOYEE_DEDUCTION_ADD: "employee/deductions/add";
-    readonly EMPLOYEE_DEDUCTION_CREATED: "employee/deductions/created";
-    readonly EMPLOYEE_DEDUCTION_UPDATED: "employee/deductions/updated";
-    readonly EMPLOYEE_DEDUCTION_DELETED: "employee/deductions/deleted";
-    readonly EMPLOYEE_DEDUCTION_DONE: "employee/deductions/done";
-    readonly EMPLOYEE_COMPENSATION_CREATE: "employee/compensations/create";
-    readonly EMPLOYEE_COMPENSATION_CREATED: "employee/compensations/created";
-    readonly EMPLOYEE_COMPENSATION_UPDATED: "employee/compensations/updated";
-    readonly EMPLOYEE_COMPENSATION_DONE: "employee/compensations/done";
-    readonly EMPLOYEE_PAYMENT_METHOD_UPDATED: "employee/paymentMethod/updated";
-    readonly EMPLOYEE_PAYMENT_METHOD_DONE: "employee/paymentMethod/done";
-    readonly EMPLOYEE_SPLIT_PAYMENT: "employee/paymentMethod/split";
-    readonly EMPLOYEE_BANK_ACCOUNT_CREATE: "employee/bankAccount/create";
-    readonly EMPLOYEE_BANK_ACCOUNT_CREATED: "employee/bankAccount/created";
-    readonly EMPLOYEE_BANK_ACCOUNT_DELETED: "employee/bankAccount/deleted";
-    readonly EMPLOYEE_FEDERAL_TAXES_VIEW: "employee/federalTaxes/view";
-    readonly EMPLOYEE_FEDERAL_TAXES_UPDATED: "employee/federalTaxes/updated";
-    readonly EMPLOYEE_STATE_TAXES_UPDATED: "employee/stateTaxes/updated";
-    readonly EMPLOYEE_TAXES_DONE: "employee/taxes/done";
-    readonly EMPLOYEE_SPLIT_PAYCHECK: "employee/bankAccount/split";
-    readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
-    readonly EMPLOYEE_JOB_UPDATED: "employee/job/updated";
-    readonly EMPLOYEE_JOB_DELETED: "employee/job/deleted";
-    readonly EMPLOYEE_SUMMARY_VIEW: "employee/summary";
-    readonly EMPLOYEES_LIST: "company/employees";
-    readonly EMPLOYEE_SELF_ONBOARDING_START: "employee/selfOnboarding/start";
-    readonly EMPLOYEE_VIEW_FORM_TO_SIGN: "employee/forms/view";
-    readonly EMPLOYEE_SIGN_FORM: "employee/forms/sign";
-    readonly EMPLOYEE_FORMS_DONE: "employee/forms/done";
-    readonly EMPLOYEE_ONBOARDING_STATUS_UPDATED: "employee/onboardingStatus/updated";
-    readonly ROBOT_MACHINE_DONE: "done";
-    readonly ERROR: "ERROR";
-    readonly CANCEL: "CANCEL";
-};
-
-declare type CreateSignatoryDefaultValues = RequireAtLeastOne<Pick<Signatory, 'firstName' | 'lastName' | 'email' | 'title' | 'phone' | 'birthday'> & Pick<NonNullable<Signatory['homeAddress']>, 'street1' | 'street2' | 'city' | 'state' | 'zip'> & {
-    ssn?: string;
-}>;
-
-declare function Deductions(props: DeductionsProps & BaseComponentInterface): JSX_2.Element;
-
-declare interface DeductionsProps extends CommonComponentInterface {
-    employeeId: string;
-}
-
-declare type DeepPartial<T> = {
-    [P in keyof T]?: T[P] extends (infer U)[]
-    ? DeepPartial<U>[]
-    : T[P] extends object
-    ? DeepPartial<T[P]>
-    : T[P]
-}
-
-declare type Dictionary = Record<string, Partial<{
-    [K in keyof Resources]: DeepPartial<Resources[K]>;
-}>>;
-
-declare function DocumentList({ companyId, signatoryId, className, children, ...props }: DocumentListProps & BaseComponentInterface): JSX_2.Element;
-
-declare namespace DocumentList {
-    var Head: Head;
-    var ManageSignatories: ManageSignatories;
-    var List: List;
-    var Actions: Actions;
-}
-
-declare interface DocumentListProps extends CommonComponentInterface {
-    companyId: string;
-    signatoryId?: string;
-}
-
-declare const DocumentSignerFlow: ({ companyId, signatoryId, onEvent, }: DocumentSignerFlowProps) => JSX_2.Element;
-
-declare const DocumentSignerFlow_2: ({ employeeId, onEvent }: DocumentSignerFlowProps_2) => JSX_2.Element;
-
-declare interface DocumentSignerFlowProps extends BaseComponentInterface {
-    companyId: string;
-    signatoryId?: string;
-}
-
-declare interface DocumentSignerFlowProps_2 extends BaseComponentInterface {
-    employeeId: string;
-}
-
-export declare namespace Employee {
-    export {
-        EmployeeList,
-        Deductions,
-        OnboardingSummary_2 as OnboardingSummary,
-        Profile,
-        Compensation,
-        Taxes,
-        PaymentMethod,
-        Landing,
-        DocumentSignerFlow_2 as DocumentSignerFlow
-    }
-}
-
-declare function EmployeeList(props: EmployeeListProps & BaseComponentInterface): JSX_2.Element;
-
-declare namespace EmployeeList {
-    var Head: () => JSX_2.Element;
-    var List: () => JSX_2.Element;
-}
-
-declare interface EmployeeListProps extends CommonComponentInterface {
-    companyId: string;
-}
-
-declare type EmployeeOnboardingDefaultValues = RequireAtLeastOne<{
-    profile?: ProfileDefaultValues;
-    compensation?: CompensationDefaultValues;
-}>;
-
-export declare const EmployeeOnboardingFlow: ({ companyId, onEvent, defaultValues, isSelfOnboardingEnabled, }: EmployeeOnboardingFlowProps) => JSX_2.Element;
-
-declare interface EmployeeOnboardingFlowProps extends BaseComponentInterface {
-    companyId: string;
-    defaultValues?: RequireAtLeastOne<EmployeeOnboardingDefaultValues>;
-    isSelfOnboardingEnabled?: boolean;
-}
-
-export declare const EmployeeSelfOnboardingFlow: ({ companyId, employeeId, onEvent, }: EmployeeSelfOnboardingFlowProps) => JSX_2.Element;
-
-declare interface EmployeeSelfOnboardingFlowProps extends BaseComponentInterface {
-    companyId: string;
-    employeeId: string;
-}
-
-declare type EventType = (typeof componentEvents)[keyof typeof componentEvents];
-
-declare function FederalTaxes(props: FederalTaxesProps & BaseComponentInterface): JSX_2.Element;
-
-declare type FederalTaxesDefaultValues = RequireAtLeastOne<{
-    taxPayerType?: FederalTaxFormInputs['taxPayerType'];
-    filingForm?: FederalTaxFormInputs['filingForm'];
-    legalName?: FederalTaxFormInputs['legalName'];
-}>;
-
-declare interface FederalTaxesProps extends CommonComponentInterface {
-    companyId: string;
-    children?: ReactNode;
-    className?: string;
-    defaultValues?: FederalTaxesDefaultValues;
-}
-
-declare type FederalTaxFormInputs = v.InferInput<typeof FederalTaxFormSchema>;
-
-declare const FederalTaxFormSchema: v.ObjectSchema<{
-    readonly federalEin: v.OptionalSchema<v.StringSchema<undefined>, never>;
-    readonly taxPayerType: v.OptionalSchema<v.UnionSchema<v.LiteralSchema<"C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit", undefined>[], undefined>, never>;
-    readonly filingForm: v.OptionalSchema<v.UnionSchema<v.LiteralSchema<"941" | "944", undefined>[], undefined>, never>;
-    readonly legalName: v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>;
-}, undefined>;
-
-export declare namespace Flows {
-    export {
-        EmployeeOnboardingFlow,
-        EmployeeSelfOnboardingFlow
-    }
-}
-
-declare interface GTheme {
-    rootFS: string
-    colors: GThemeColors
-    focus: GThemeFocus
-    shadow: GThemeShadow
-    spacing: GThemeSpacing
-    radius: GThemeRadius
-    transitionDuration: GThemeTransitionDuration
-    typography: GThemeTypography
-    input: GThemeInput
-    button: GThemeButton
-    radio: GThemeRadio
-    checkbox: GThemeCheckbox
-    table: GThemeTable
-    calendarDisplay: GThemeCalendarDisplay
-    card: GThemeCard
-    link: GThemeLink
-    badge: GThemeBadge
-    optionalLabel: string //This is a string pulled from translations to indicate (optional) on form elements
-}
-
-declare interface GThemeBadge {
-    success: {
-        color: string
-        backgroundColor: string
-        borderColor: string
-    }
-    fontSize: string
-    fontWeight: number
-    borderWidth: string
-    borderRadius: string
-    paddingX: string
-    paddingY: string
-}
-
-declare interface GThemeButton {
-    fontSize: string
-    fontWeight: number
-    borderWidth: string
-    borderRadius: string
-    textStyle: 'uppercase' | 'none' | 'capitalize' | 'lowercase'
-    paddingX: string
-    paddingY: string
-    shadow: string
-    primary: GThemeButtonVariant
-    secondary: GThemeButtonVariant
-    tertiary: GThemeButtonVariant
-}
-
-declare type GThemeButtonVariant = {
-    color: ThemeColor
-    bg: ThemeColor
-    borderColor: ThemeColor
-    hoverBg: ThemeColor
-    hoverColor: ThemeColor
-    disabledBg: ThemeColor
-    focusColor: ThemeColor
-}
-
-declare interface GThemeCalendarDisplay {
-    primaryHighlight: string
-    warningHighlight: string
-    lightFont: string
-    darkFont: string
-    borderColor: string
-}
-
-declare interface GThemeCard {
-    borderColor: string
-    dividerColor: string
-    headerTextColor: string
-    contentTextColor: string
-    columnTitleColor: string
-    columnTitleFontSize: string
-}
-
-declare interface GThemeCheckbox {
-    borderColor: ThemeColor
-    borderWidth: string
-    selectedColor: ThemeColor
-    checkmarkColor: ThemeColor
-    radius: GThemeRadius
-    transitionDuration: GThemeTransitionDuration
-    hover: {
-        uncheckedBackground: ThemeColor
-        uncheckedBorderColor: ThemeColor
-        checkedBackground: ThemeColor
-        checkedBorderColor: ThemeColor
-    }
-    disabled: {
-        borderColor: ThemeColor
-        background: ThemeColor
-        checkmarkColor: ThemeColor
-    }
-}
-
-declare interface GThemeColors {
-    gray: {
-        100: ThemeColor
-        200: ThemeColor
-        300: ThemeColor
-        400: ThemeColor
-        500: ThemeColor
-        600: ThemeColor
-        700: ThemeColor
-        800: ThemeColor
-        900: ThemeColor
-        1000: ThemeColor
-    }
-    error: {
-        100: ThemeColor
-        500: ThemeColor
-        800: ThemeColor
-    }
-    warning: {
-        100: ThemeColor
-        500: ThemeColor
-        700: ThemeColor
-        800: ThemeColor
-    }
-    success: {
-        100: ThemeColor
-        400: ThemeColor
-        500: ThemeColor
-        800: ThemeColor
-    }
-    orange: {
-        800: ThemeColor
-    }
-}
-
-declare interface GThemeFocus {
-    color: ThemeColor
-    borderWidth: string
-}
-
-declare interface GThemeInput {
-    fontSize: string
-    textColor: ThemeColor
-    borderColor: ThemeColor
-    borderWidth: string
-    background: string
-    paddingX: string
-    paddingY: string
-    height: string
-    labelFontSize: string
-    labelColor: ThemeColor
-    labelFontWeight: number
-    disabled: {
-        color: ThemeColor
-        border: ThemeColor
-        bg: ThemeColor
-    }
-    hovered: {
-        borderColor: ThemeColor
-    }
-    placeholderColor: ThemeColor
-    descriptionColor: ThemeColor
-    disabledColor: ThemeColor
-}
-
-declare interface GThemeLink {
-    color: ThemeColor
-    decoration: string
-    hoverColor: ThemeColor
-    hoverDecoration: string
-    pressedColor: string
-}
-
-declare interface GThemeRadio {
-    borderColor: ThemeColor
-    hoveredBorderColor: ThemeColor
-    pressedBorderColor: ThemeColor
-    selectedBorderColor: ThemeColor
-    disabledBorderColor: ThemeColor
-    disabledBackground: ThemeColor
-    disabledDotColor: ThemeColor
-    disabledLabelColor: ThemeColor
-    labelColor: ThemeColor
-    focusRingColor: ThemeColor
-    errorBorderColor: ThemeColor
-    errorLabelColor: ThemeColor
-    borderWidth: string
-    transitionDuration: GThemeTransitionDuration
-}
-
-declare type GThemeRadius = string
-
-declare interface GThemeShadow {
-    100: string
-    200: string
-}
-
-declare interface GThemeSpacing {
-    4: string
-    8: string
-    12: string
-    16: string
-    20: string
-    24: string
-    28: string
-    32: string
-    36: string
-    40: string
-}
-
-declare interface GThemeTable {
-    paddingX: string
-    paddingY: string
-    fontSize: string
-    headerColor: string
-    headerBg: string
-    columnWeight: number
-    borderColor: string
-    background: string
-    highlightBg: string
-    highlightFg: string
-    textColor: string
-}
-
-declare type GThemeTransitionDuration = string
-
-declare interface GThemeTypography {
-    font: string
-    textColor: ThemeColor
-    datePickerErrorTextColor: ThemeColor
-    defaultLineHeight: string
-    fontSize: {
-        small: string
-        regular: string
-        medium: string
-    }
-    fontWeight: {
-        regular: number
-        medium: number
-    }
-    disabledTextColor: ThemeColor
-    headings: {
-        1: string
-        2: string
-        3: string
-        4: string
-        5: string
-        6: string
-    }
-}
-
-declare interface GustoApiProps {
-    config: APIConfig;
-    dictionary?: Dictionary;
-    lng?: string;
-    locale?: string;
-    currency?: string;
-    theme?: DeepPartial<GTheme>;
-    children?: default_2.ReactNode;
-    queryClient?: QueryClient;
-}
-
-export declare const GustoApiProvider: default_2.FC<GustoApiProps>;
-
-declare type HEX = `#${string}`
-
-declare type HSL = `hsl(${string})`
-
-declare type HSLA = `hsla(${string})`
-
-declare function Industry<T>(props: IndustryProps<T>): JSX_2.Element;
-
-declare namespace Industry {
-    var Actions: () => JSX_2.Element;
-    var Edit: () => JSX_2.Element;
-    var Head: () => JSX_2.Element;
-}
-
-declare type IndustryProps<T> = Pick<BaseComponentInterface, 'onEvent'> & Partial<Pick<HTMLAttributes<T>, 'children' | 'className'>> & {
-    companyId: string;
-};
-
-declare type InviteSignatoryDefaultValues = RequireAtLeastOne<Pick<Signatory, 'firstName' | 'lastName' | 'email' | 'title'> & {
-    confirmEmail: string;
-}>;
-
-declare function Landing(props: SummaryProps_2 & BaseComponentInterface): JSX_2.Element;
-
-declare function LocationsFlow({ companyId, onEvent }: LocationsProps): JSX_2.Element;
-
-declare interface LocationsProps extends BaseComponentInterface {
-    companyId: string;
-}
-
-declare function OnboardingSummary(): JSX_2.Element;
-
-declare function OnboardingSummary_2(props: SummaryProps & BaseComponentInterface): JSX_2.Element;
-
-declare type OnEventType<K, T> = (type: K, data?: T) => void;
-
-declare const PAY_PERIODS: {
-    readonly HOUR: "Hour";
-    readonly WEEK: "Week";
-    readonly MONTH: "Month";
-    readonly YEAR: "Year";
-    readonly PAYCHECK: "Paycheck";
-};
-
-declare function PaymentMethod(props: PaymentMethodProps & BaseComponentInterface): JSX_2.Element;
-
-declare interface PaymentMethodProps extends CommonComponentInterface {
-    employeeId: string;
-    defaultValues?: never;
-}
-
-declare const PaySchedule: {
-    ({ companyId, defaultValues, ...props }: PayScheduleProps & BaseComponentInterface): JSX_2.Element;
-    Head: () => JSX_2.Element;
-    List: () => JSX_2.Element | null;
-    Edit: () => JSX_2.Element | null;
-    Actions: () => JSX_2.Element;
-};
-
-declare type PayScheduleDefaultValues = RequireAtLeastOne<Partial<Pick<PayScheduleCreateUpdate, 'anchorPayDate' | 'anchorEndOfPayPeriod' | 'day1' | 'day2' | 'customName' | 'frequency'>>>;
-
-declare interface PayScheduleProps extends CommonComponentInterface {
-    companyId: string;
-    defaultValues?: PayScheduleDefaultValues;
-}
-
-declare function Profile(props: ProfileProps & BaseComponentInterface): JSX_2.Element;
-
-declare namespace Profile {
-    var Head: () => JSX_2.Element;
-    var Actions: () => JSX_2.Element;
-    var AdminPersonalDetails: () => JSX_2.Element | null;
-    var SelfPersonalDetails: () => JSX_2.Element | null;
-    var HomeAddress: () => JSX_2.Element | null;
-    var WorkAddress: WorkAddress;
-}
-
-declare type ProfileDefaultValues = RequireAtLeastOne<{
-    employee?: RequireAtLeastOne<{
-        firstName?: string;
-        middleInitial?: string;
-        lastName?: string;
-        email?: string;
-        dateOfBirth?: string;
-    }>;
-    homeAddress?: RequireAtLeastOne<{
-        street1?: string;
-        street2?: string;
-        city?: string;
-        state?: string;
-        zip?: string;
-    }>;
-}>;
-
-declare interface ProfileProps extends CommonComponentInterface {
-    employeeId?: string;
-    companyId: string;
-    defaultValues?: ProfileDefaultValues;
-    isAdmin?: boolean;
-    isSelfOnboardingEnabled?: boolean;
-}
-
-declare type RequireAtLeastOne<T> = {
-    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>
-}[keyof T]
-
-declare type Resources = CustomTypeOptions['resources'];
-
-declare type RGB = `rgb(${string})`
-
-declare type RGBA = `rgba(${string})`
-
-declare function SignatureForm({ formId, companyId, children, className, ...props }: SignatureFormProps & BaseComponentInterface): JSX_2.Element;
-
-declare namespace SignatureForm {
-    var Head: Head;
-    var Preview: Preview;
-    var Form: Form;
-    var Actions: Actions;
-}
-
-declare interface SignatureFormProps {
-    formId: string;
-    companyId: string;
-    children?: ReactNode;
-    className?: string;
-}
-
-declare interface SummaryProps extends CommonComponentInterface {
-    employeeId: string;
-    isAdmin?: boolean;
-}
-
-declare interface SummaryProps_2 extends CommonComponentInterface {
-    employeeId: string;
-    companyId: string;
-}
-
-declare function Taxes(props: TaxesProps & BaseComponentInterface): JSX_2.Element;
-
-declare namespace Taxes {
-    var FederalHead: FederalHead;
-    var FederalForm: FederalForm;
-    var StateForm: () => JSX_2.Element[];
-    var Actions: () => JSX_2.Element;
-}
-
-declare interface TaxesProps extends CommonComponentInterface {
-    employeeId: string;
-    isAdmin?: boolean;
-}
-
-declare type ThemeColor = RGB | RGBA | HEX | HSL | HSLA | VAR | 'transparent'
-
-declare type VAR = `var(${string})`
-
-export { }
-
-
-
-declare module 'i18next' {
-    export interface CompanyAddBank{
-"title":string;
-"intro":string;
-"entry_selection_question":string;
-"manual_entry":string;
-"plaid_entry":string;
-"routing_number_label":string;
-"account_number_label":string;
-"account_type_label":string;
-"account_type_checking":string;
-"account_type_savings":string;
-"submit":string;
-};
-export interface CompanyAddresses{
-"title":string;
-"description":string;
-"mailingLabel":string;
-"filingLabel":string;
-"editCta":string;
-"addCta":string;
-"continueCta":string;
-};
-export interface CompanyAssignSignatory{
-"title":string;
-"description":string;
-"signingOptions":{
-"label":string;
-"selfSign":string;
-"appointOther":string;
-}
-"signatoryDetails":{
-"title":string;
-"description":string;
-"firstName":string;
-"lastName":string;
-"email":string;
-"phone":string;
-"ssn":string;
-"birthday":string;
-"titleSelect":{
-"label":string;
-}
-}
-"address":{
-"title":string;
-"description":string;
-"street1":string;
-"street2":string;
-"city":string;
-"state":string;
-"statePlaceholder":string;
-"zip":string;
-}
-"inviteSignatory":{
-"title":string;
-"description":string;
-"signatoryEmail":string;
-"confirmEmail":string;
-"firstName":string;
-"lastName":string;
-}
-"buttons":{
-"signDocuments":string;
-"inviteSignatory":string;
-}
-"validations":{
-"dob":string;
-"email":string;
-"emailMismatch":string;
-"firstName":string;
-"lastName":string;
-"phone":string;
-"title":string;
-"address":{
-"street1":string;
-"city":string;
-"state":string;
-"zip":string;
-}
-}
-};
-export interface CompanyDocumentList{
-"documentListTitle":string;
-"documentListLabel":string;
-"formColumnLabel":string;
-"actionColumnLabel":string;
-"selfSignatoryTitle":string;
-"otherSignatoryTitle":string;
-"selfSignatorySubtext":string;
-"otherSignatorySubtext":string;
-"noSignatorySubtext":string;
-"changeSignatoryCta":string;
-"assignSignatoryCta":string;
-"signDocumentCta":string;
-"signDocumentComplete":string;
-"notSigned":string;
-"documentListError":string;
-"emptyTableTitle":string;
-"continueCta":string;
-};
-export interface CompanyFederalTaxes{
-"pageTitle":string;
-"entity_type_and_legal_name_intro":string;
-"federal_ein_label":string;
-"federal_ein_description":string;
-"taxpayer_type_label":string;
-"taxpayer_type_description":string;
-"federal_filing_form_label":string;
-"federal_filing_form_description":string;
-"legal_entity_name_label":string;
-"legal_entity_name_description":string;
-"legal_entity_name_error":string;
-"taxPayerType":{
-"C-Corporation":string;
-"S-Corporation":string;
-"Sole proprietor":string;
-"LLC":string;
-"LLP":string;
-"Limited partnership":string;
-"Co-ownership":string;
-"Association":string;
-"Trusteeship":string;
-"General partnership":string;
-"Joint venture":string;
-"Non-Profit":string;
-}
-"filingForm":{
-"941":string;
-"944":string;
-}
-"continueCta":string;
-};
-export interface CompanyIndustry{
-"title":string;
-"description":string;
-"label":string;
-"placeholder":string;
-"submitCta":string;
-};
-export interface CompanyLocations{
-"locationsListTitle":string;
-"locationsListDescription":string;
-"locationListLabel":string;
-"locationListCol1":string;
-"locationListCol2":string;
-"filingAddress":string;
-"mailingAddress":string;
-"hamburgerTitle":string;
-"editCta":string;
-"emptyTableTitle":string;
-"emptyTableDescription":string;
-"addLocationCta":string;
-"addFirstLicationCta":string;
-"locationFormTitle":string;
-"locationFormDescription":string;
-"street1Label":string;
-"street2Label":string;
-"cityLabel":string;
-"stateLabel":string;
-"statePlaceholder":string;
-"zipLabel":string;
-"phoneNumberLabel":string;
-"addressTypeLabel":string;
-"mailingAddressLabel":string;
-"mailingAddressDescription":string;
-"filingAddressLabel":string;
-"filingAddressDescription":string;
-"saveCta":string;
-"cancelCta":string;
-"continueCta":string;
-"validations":{
-"street1":string;
-"city":string;
-"state":string;
-"zip":string;
-"phone":string;
-}
-};
-export interface CompanyPaySchedule{
-"listDescription":string;
-"listDescription2":string;
-"addAnotherPayScheduleCta":string;
-"saveAndContinueCta":string;
-"pleaseVerify":string;
-"payScheduleList":{
-"name":string;
-"actions":string;
-"active":string;
-"inactive":string;
-"edit":string;
-}
-"headings":{
-"addPaySchedule":string;
-"editPaySchedule":string;
-"pageTitle":string;
-}
-"labels":{
-"payfrequency":string;
-"frequency":string;
-"deadline":string;
-"frequencyOptions":string;
-"firstPayDate":string;
-"firstPayPeriodEndDate":string;
-"firstPayDayOfTheMonth":string;
-"lastPayDayOfTheMonth":string;
-"preview":string;
-"legend":string;
-}
-"loading":string;
-"descriptions":{
-"frequencyOptionsDescription":string;
-"anchorPayDateDescription":string;
-"anchorEndOfPayPeriodDescription":string;
-}
-"payPreview":{
-"payPeriod":string;
-"payday":string;
-"payrollDeadline":string;
-}
-"actions":{
-"cancel":string;
-"save":string;
-}
-"frequencies":{
-"everyWeek":string;
-"everyOtherWeek":string;
-"twicePerMonth":string;
-"monthly":string;
-}
-"frequencyOptions":{
-"15thAndLast":string;
-"custom":string;
-}
-};
-export interface CompanySignatureForm{
-"signatureFormTitle":string;
-"downloadInstructions":string;
-"viewDocumentCta":string;
-"signatureLabel":string;
-"signatureDescription":string;
-"signatureError":string;
-"confirmationGroupLabel":string;
-"confirmationLabel":string;
-"confirmationError":string;
-"backCta":string;
-"submitCta":string;
-"downloadPrompt":string;
-};
-export interface EmployeeBankAccount{
-"accountNumberLabel":string;
-"accountTypeChecking":string;
-"accountTypeLabel":string;
-"accountTypeSavings":string;
-"accountTypeSelect":string;
-"cancelCta":string;
-"checkImageAlt":string;
-"description":string;
-"nameLabel":string;
-"routingNumberLabel":string;
-"routingNumberDescription":string;
-"submitCta":string;
-"title":string;
-"validations":{
-"accountType":string;
-}
-};
-export interface EmployeeCompensation{
-"addAnotherJobCta":string;
-"adjustForMinimumWage":string;
-"adjustForMinimumWageDescription":string;
-"minimumWageLabel":string;
-"minimumWageDescription":string;
-"allCompensations":{
-"actionColumn":string;
-"amountColumn":string;
-"deleteCta":string;
-"editCta":string;
-"jobColumn":string;
-"perColumn":string;
-"tableLabel":string;
-"typeColumn":string;
-}
-"amount":string;
-"backCta":string;
-"cancelCta":string;
-"cancelNewJobCta":string;
-"classificationCTA":string;
-"employeeClassification":string;
-"flsaStatusLabels":{
-"Commission Only Exempt":string;
-"Commission Only Nonexempt":string;
-"Exempt":string;
-"Nonexempt":string;
-"Owner":string;
-"Salaried Nonexempt":string;
-}
-"hamburgerTitle":string;
-"jobTitle":string;
-"paymentUnitDescription":string;
-"paymentUnitLabel":string;
-"paymentUnitOptions":{
-"Hour":string;
-"Month":string;
-"Paycheck":string;
-"Week":string;
-"Year":string;
-}
-"saveNewJobCta":string;
-"submitCta":string;
-"title":string;
-"editTitle":string;
-"addTitle":string;
-"validations":{
-"classificationChangeNotification":string;
-"exemptThreshold":string;
-"paymentUnit":string;
-"rate":string;
-"title":string;
-"minimumWage":string;
-}
-};
-export interface EmployeeDeductions{
-"pageTitle":string;
-"includeDeductionsFormLabel":string;
-"includeDeductionsDescription":string;
-"includeDeductionsYes":string;
-"includeDeductionsNo":string;
-"continueCta":string;
-"addDeductionTitle":string;
-"editDeductionTitle":string;
-"addDeuctionDescription":string;
-"descriptionLabel":string;
-"frequencyLabel":string;
-"frequencyRecurringOption":string;
-"frequencyOneTimeOption":string;
-"deductionsTableLabel":string;
-"deductionTypeLabel":string;
-"deductionTypePercentageOption":string;
-"deductionTypeFixedAmountOption":string;
-"deductionAmountLabel":string;
-"annualMaxLabel":string;
-"courtOrderedLabel":string;
-"nameColumn":string;
-"frequencyColumn":string;
-"withheldColumn":string;
-"actionsColumn":string;
-"recurringText":string;
-"recurringAmount":string;
-"nonRecurringText":string;
-"emptyListMessage":string;
-"hamburgerTitle":string;
-"editCta":string;
-"deleteCta":string;
-"addDeductionCta":string;
-"cancelCta":string;
-"validations":{
-"description":string;
-"amount":string;
-}
-};
-export interface EmployeeDocumentSigner{
-"documentListTitle":string;
-"documentListLabel":string;
-"formColumnLabel":string;
-"actionColumnLabel":string;
-"continueCta":string;
-"signDocumentCta":string;
-"signDocumentComplete":string;
-"notSigned":string;
-"documentListError":string;
-"emptyTableTitle":string;
-"signatureFormTitle":string;
-"downloadPrompt":string;
-"signatureFieldLabel":string;
-"signatureFieldDescription":string;
-"signatureFieldError":string;
-"confirmationGroupLabel":string;
-"confirmSignatureCheckboxLabel":string;
-"confirmSignatureError":string;
-"backCta":string;
-"signFormCta":string;
-"viewDocumentCta":string;
-"downloadAndReviewInstructions":string;
-};
-export interface EmployeeEmployeeList{
-"actionLabel":string;
-"addEmployeeCTA":string;
-"addAnotherCta":string;
-"addressesCta":string;
-"deductionsCta":string;
-"deleteCta":string;
-"editCta":string;
-"cancelSelfOnboardingCta":string;
-"reviewCta":string;
-"employeeListLabel":string;
-"emptyTableDescription":string;
-"emptyTableTitle":string;
-"federalTaxesCta":string;
-"hamburgerTitle":string;
-"nameLabel":string;
-"statusLabel":string;
-"title":string;
-};
-export interface EmployeeHomeAddress{
-"formTitle":string;
-"desc":string;
-"street1":string;
-"street2":string;
-"city":string;
-"state":string;
-"statePlaceholder":string;
-"zip":string;
-"courtesyWithholdingLabel":string;
-"courtesyWhithholdingDescription":string;
-"learnMoreCta":string;
-"withholdingTitle":string;
-"withholdingNote":string;
-"editAddress":string;
-"cancel":string;
-"submit":string;
-"validations":{
-"street1":string;
-"city":string;
-"state":string;
-"zip":string;
-}
-};
-export interface EmployeeLanding{
-"landingSubtitle":string;
-"landingDescription":string;
-"stepsSubtitle":string;
-"steps":{
-"personalInfo":string;
-"taxInfo":string;
-"bankInfo":string;
-}
-"getStartedCta":string;
-"getStartedDescription":string;
-};
-export interface EmployeeOnboardingSummary{
-"subTitle":string;
-"description":string;
-"onboardedAdminSubtitle":string;
-"onboardedAdminDescription":string;
-"onboardedSelfSubtitle":string;
-"onboardedSelfDescription":string;
-"returnToEmployeeListCta":string;
-"addAnotherCta":string;
-"newHireReportCta":string;
-"missingRequirementsSubtitle":string;
-"missingRequirementsDescription":string;
-"steps":{
-"personal_details":string;
-"compensation_details":string;
-"add_work_address":string;
-"add_home_address":string;
-"federal_tax_setup":string;
-"state_tax_setup":string;
-"direct_deposit_setup":string;
-"employee_form_signing":string;
-"file_new_hire_report":string;
-"admin_review":string;
-}
-"stepsDescriptions":{
-"personal_details":string;
-"compensation_details":string;
-"add_work_address":string;
-"add_home_address":string;
-"federal_tax_setup":string;
-"state_tax_setup":string;
-"direct_deposit_setup":string;
-"employee_form_signing":string;
-"file_new_hire_report":string;
-"admin_review":string;
-}
-};
-export interface EmployeePaySchedules{
-"pageTitle":string;
-"saveAndContinueCta":string;
-"pleaseVerify":string;
-"labels":{
-"frequency":string;
-"firstPayDate":string;
-"deadline":string;
-}
-};
-export interface EmployeePaymentMethod{
-"accountNumberLabel":string;
-"accountTypeColumn":string;
-"accountTypeLabel":string;
-"accountTypeChecking":string;
-"accountTypeSavings":string;
-"allocationColumn":string;
-"actionColumn":string;
-"addAnotherCta":string;
-"addBankAccountCTA":string;
-"bankAccountsListLabel":string;
-"cancelCta":string;
-"saveCta":string;
-"cancelAddCta":string;
-"checkDescription":string;
-"checkLabel":string;
-"deleteBankAccountCTA":string;
-"directDepositDescription":string;
-"directDepositLabel":string;
-"hamburgerTitle":string;
-"nameLabel":string;
-"nicknameColumn":string;
-"paymentFieldsetLegend":string;
-"routingNumberColumn":string;
-"routingNumberLabel":string;
-"routingNumberDescription":string;
-"splitCta":string;
-"submitCta":string;
-"title":string;
-"amountLabel":string;
-"splitDescription":string;
-"draggableListLabel":string;
-"percentageLabel":string;
-"splitAmountLabel":string;
-"splitByLabel":string;
-"priorityLabel":string;
-"remainderLabel":string;
-"splitTitle":string;
-"priority_one":string;
-"priority_two":string;
-"priority_few":string;
-"priority_other":string;
-"validations":{
-"percentageError":string;
-"amountError":string;
-"accountName":string;
-"routingNumber":string;
-"accountNumber":string;
-}
-};
-export interface EmployeeProfile{
-"cancelCta":string;
-"description":string;
-"dobLabel":string;
-"email":string;
-"emailDescription":string;
-"firstName":string;
-"formTitle":string;
-"lastName":string;
-"middleInitial":string;
-"preferredFirstName":string;
-"selfOnboardingLabel":string;
-"ssnLabel":string;
-"ssnMask":string;
-"startDateDescription":string;
-"startDateLabel":string;
-"submitCta":string;
-"title":string;
-"validations":{
-"email":string;
-"firstName":string;
-"lastName":string;
-"startDate":string;
-"startDateOutOfRange":string;
-}
-"workAddress":string;
-"workAddressDescription":string;
-"workAddressPlaceholder":string;
-"workAddressSectionTitle":string;
-"workAddressSectionDescription":string;
-};
-export interface EmployeeSplitPaycheck{
-"amountLabel":string;
-"bankDescription":string;
-"description":string;
-"percentageLabel":string;
-"splitAmountLabel":string;
-"splitByLabel":string;
-"priorityLabel":string;
-"title":string;
-"remainderLabel":string;
-"priority_one":string;
-"priority_two":string;
-"priority_few":string;
-"priority_other":string;
-"validations":{
-"percentageError":string;
-"priorityError":string;
-"amountError":string;
-}
-"cancelCta":string;
-"submitCta":string;
-};
-export interface EmployeeStateTaxes{
-"title":string;
-"filingStatusLabel":string;
-"cancelCta":string;
-"submitCta":string;
-};
-export interface EmployeeTaxes{
-"cancelCta":string;
-"deductions":string;
-"dependentsTotalIfApplicable":string;
-"extraWithholding":string;
-"federalFilingStatus1c":string;
-"federalFillingStatusPlaceholder":string;
-"federalTaxesTitle":string;
-"filingStatusExemptFromWithholding":string;
-"filingStatusHeadOfHousehold":string;
-"filingStatusMarried":string;
-"filingStatusSingle":string;
-"includesSpouseExplanation":string;
-"irs_calculator":string;
-"irsCalculatorOrW4Line":string;
-"multipleJobs2c":string;
-"otherIncome":string;
-"selectWithholdingDescription":string;
-"stateTaxesTitle":string;
-"submitCta":string;
-"twoJobYesLabel":string;
-"twoJobNoLabel":string;
-"validations":{
-"federalFilingStatus":string;
-"federalTwoJobs":string;
-}
-};
-export interface PayrollPayrollHistoryList{
-"period":string;
-"payrollType":string;
-"payrollCancellable":string;
-"checkDate":string;
-"payrollTotal":string;
-};
-export interface PayrollPayrollSchedule{
-"pageTitle":string;
-"helpOne":string;
-"helpTwo":string;
-"helpThree":string;
-"payFrequency":string;
-"payFrequency.weekly":string;
-"payFrequency.biweekly":string;
-"payFrequency.semimonthly":string;
-"payFrequency.semimonthly_custom":string;
-"payFrequency.monthly":string;
-"day_1.label":string;
-"day_2.label":string;
-"anchor_pay_date.label":string;
-"deadline_to_run_payroll.label":string;
-"anchor_end_of_pay_period.label":string;
-"anchor_end_of_pay_period.help":string;
-};
-export interface common{
-"status":{
-"loading":string;
-"requiredField":string;
-"errorEncountered":string;
-}
-"optionalLabel":string;
-"errors":{
-"errorHeading":string;
-"globalReactError":string;
-"resetGlobalError":string;
-"unknownError":string;
-"missingParamsOrContext":string;
-"unhandledEvent":string;
-"unknownEventType":string;
-}
-"icons":{
-"selectArrow":string;
-"calendarArrow":string;
-"nextMonth":string;
-"previousMonth":string;
-"magnifyingGlass":string;
-"paginationFirst":string;
-"paginationPrev":string;
-"paginationNext":string;
-"paginationLast":string;
-}
-"flows":{
-"employeeOnboarding":{
-"employeeListTitle":string;
-"profileTitle":string;
-"compensationTitle":string;
-"taxesTitle":string;
-"paymentMethodTitle":string;
-"deductionsTitle":string;
-"summaryTitle":string;
-}
-"employeeSelfOnboarding":{
-"profileTitle":string;
-"documentSignerTitle":string;
-}
-}
-"labels":{
-"draggableLabel":string;
-"draggablePosition":string;
-"paginationControllCountLabel":string;
-}
-"onboardingStatus":{
-"undefined":string;
-"onboarding_completed":string;
-"admin_onboarding_incomplete":string;
-"self_onboarding_pending_invite":string;
-"self_onboarding_invited":string;
-"self_onboarding_invited_started":string;
-"self_onboarding_invited_overdue":string;
-"self_onboarding_completed_by_employee":string;
-"self_onboarding_awaiting_admin_review":string;
-}
-"inputs":{
-"ssn":{
-"placeholder":string;
-}
-"ein":{
-"placeholder":string;
-}
-}
-"validations":{
-"accountName":string;
-"routingNumber":string;
-"accountNumber":string;
-"ssn":string;
-"location":string;
-"dob":string;
-}
-"statesHash":{
-"AL":string;
-"AK":string;
-"AZ":string;
-"AR":string;
-"CA":string;
-"CO":string;
-"CT":string;
-"DE":string;
-"FL":string;
-"GA":string;
-"HI":string;
-"ID":string;
-"IL":string;
-"IN":string;
-"IA":string;
-"KS":string;
-"KY":string;
-"LA":string;
-"ME":string;
-"MD":string;
-"MA":string;
-"MI":string;
-"MN":string;
-"MS":string;
-"MO":string;
-"MT":string;
-"NE":string;
-"NV":string;
-"NH":string;
-"NJ":string;
-"NM":string;
-"NY":string;
-"NC":string;
-"ND":string;
-"OH":string;
-"OK":string;
-"OR":string;
-"PA":string;
-"RI":string;
-"SC":string;
-"SD":string;
-"TN":string;
-"TX":string;
-"UT":string;
-"VT":string;
-"VA":string;
-"WA":string;
-"WV":string;
-"WI":string;
-"WY":string;
-}
-"table":{
-"selectRowHeader":string;
-"actionsColumnHeader":string;
-}
-"card":{
-"selectRowLabel":string;
-}
-"signatoryTitles":{
-"owner":string;
-"president":string;
-"vice_president":string;
-"treasurer":string;
-"corporate_officer":string;
-"partner":string;
-"member":string;
-}
-};
-
-    interface CustomTypeOptions {
-        defaultNS: 'common';
-        resources: { 'Company.AddBank': CompanyAddBank, 'Company.Addresses': CompanyAddresses, 'Company.AssignSignatory': CompanyAssignSignatory, 'Company.DocumentList': CompanyDocumentList, 'Company.FederalTaxes': CompanyFederalTaxes, 'Company.Industry': CompanyIndustry, 'Company.Locations': CompanyLocations, 'Company.PaySchedule': CompanyPaySchedule, 'Company.SignatureForm': CompanySignatureForm, 'Employee.BankAccount': EmployeeBankAccount, 'Employee.Compensation': EmployeeCompensation, 'Employee.Deductions': EmployeeDeductions, 'Employee.DocumentSigner': EmployeeDocumentSigner, 'Employee.EmployeeList': EmployeeEmployeeList, 'Employee.HomeAddress': EmployeeHomeAddress, 'Employee.Landing': EmployeeLanding, 'Employee.OnboardingSummary': EmployeeOnboardingSummary, 'Employee.PaySchedules': EmployeePaySchedules, 'Employee.PaymentMethod': EmployeePaymentMethod, 'Employee.Profile': EmployeeProfile, 'Employee.SplitPaycheck': EmployeeSplitPaycheck, 'Employee.StateTaxes': EmployeeStateTaxes, 'Employee.Taxes': EmployeeTaxes, 'Payroll.PayrollHistoryList': PayrollPayrollHistoryList, 'Payroll.PayrollSchedule': PayrollPayrollSchedule, 'common': common,  }
-    };
-}
+export * from './components';
+export * from './contexts';
+export { componentEvents } from './shared/constants';
+export { EmployeeOnboardingFlow } from './components/Flow/EmployeeOnboardingFlow';
+export { EmployeeSelfOnboardingFlow } from './components/Flow/EmployeeSelfOnboardingFlow/EmployeeSelfOnboardingFlow';