@remoteoss/remote-flows 1.55.0 → 1.56.0

package/dist/types-BnNeE0Fd.d.ts

@@ -1,946 +0,0 @@
-import { f as EmploymentCreationResponse, i as EmploymentResponse, S as SuccessResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, G as ConflictResponse, B as BadRequestResponse, F as ForbiddenResponse, N as NotFoundResponse, E as Employment$1, H as File, P as PreOnboardingRequirement, am as CreatePreOnboardingAcknowledgementResponse, a as UnauthorizedResponse, a6 as Company, an as ConvertCurrencyResponse, ao as ConvertCurrencyParams, ap as EmploymentCreateParams, aq as CreatePreOnboardingDocumentResponse, ar as PostV1OnboardingEmploymentsEmploymentIdPreOnboardingRequirementsRequirementSlugDocumentsData, as as EngagementAgreementDetailsFile, l as Signatory, m as ContractorContractDocumentStatus, at as UnifiedEmploymentUpsertBenefitOffersRequest, au as EmploymentFullParams, av as EmploymentEngagementAgreementDetailsParams, aw as CreateContractEligibilityParams } from './types.gen-ClcXnZQX.js';
-import * as react from 'react';
-import { OnboardingBack } from './flows/Onboarding/components/OnboardingBack.js';
-import { OnboardingInvite } from './flows/Onboarding/components/OnboardingInvite.js';
-import { N as NormalizedFieldError, S as SuccessResponse$1, E as ErrorResponse } from './mutations-CP-6Q1qD.js';
-import { OnboardingSubmit } from './flows/Onboarding/components/OnboardingSubmit.js';
-import { C as Components, J as JSFFields, N as NestedMeta, b as JSFFieldset } from './remoteFlows-XC0Ss0fy.js';
-import * as _tanstack_query_core from '@tanstack/query-core';
-import { ValidationResult } from '@remoteoss/remote-json-schema-form-kit';
-import { Step } from './flows/useStepState.js';
-import { FieldValues } from 'react-hook-form';
-import { JSONSchemaFormResultWithFieldsets, FlowOptions, JSONSchemaFormType, JSFModify } from './flows/types.js';
-import { SaveDraftButton } from './flows/Onboarding/components/SaveDraftButton.js';
-import * as _tanstack_react_query from '@tanstack/react-query';
-import { UseQueryResult } from '@tanstack/react-query';
-import { PreviewEmploymentAgreementStep } from './flows/Onboarding/components/PreviewEmploymentAgreementStep.js';
-
-type BasicInformationStepProps = {
-    onSubmit?: (payload: BasicInformationFormPayload) => void | Promise<void>;
-    onSuccess?: (data: EmploymentCreationResponse) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function BasicInformationStep({ onSubmit, onSuccess, onError, }: BasicInformationStepProps): react.JSX.Element;
-
-type ContractDetailsStepProps = {
-    onSubmit?: (payload: ContractDetailsFormPayload) => void | Promise<void>;
-    onSuccess?: (response: EmploymentResponse) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function ContractDetailsStep({ onSubmit, onError, onSuccess, }: ContractDetailsStepProps): react.JSX.Element;
-
-type BenefitsStepProps = {
-    /**
-     * Components to override the default field components used in the form.
-     */
-    components?: Components;
-    /**
-     * Callback function to be called when the benefits form is submitted.
-     * It can be used to perform any additional validation or processing before
-     * the onboarding moves to the last step.
-     * @param values
-     * @returns
-     */
-    onSubmit?: (values: BenefitsFormPayload) => void | Promise<void>;
-    /**
-     * Callback function to be called when the submitting benefits form fails.
-     * @param error
-     * @returns
-     */
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-    /**
-     * Callback function to be called when benefits form is successfully submitted.
-     * This function is called after the submitting benefits form is submitted.
-     * @param data
-     * @returns
-     */
-    onSuccess?: (data: SuccessResponse) => void | Promise<void>;
-};
-declare function BenefitsStep({ components, onSubmit, onError, onSuccess, }: BenefitsStepProps): react.JSX.Element;
-
-type StepKeys = 'select_country' | 'basic_information' | 'engagement_agreement_details' | 'contract_details' | 'benefits' | 'employment_agreement_preview' | 'review';
-type StepConfig = {
-    includeSelectCountry?: boolean;
-    includeEngagementAgreementDetails?: boolean;
-    useDynamicSteps?: boolean;
-    useEAPreview?: boolean;
-};
-declare function buildSteps(config?: StepConfig): {
-    steps: Record<string, Step<StepKeys>>;
-    stepsArray: {
-        name: StepKeys;
-        index: number;
-        label: string;
-        visible: boolean;
-    }[];
-};
-/**
- * Array of employment statuses that are allowed to proceed to the review step.
- * These statuses indicate that the employment is in a final state and the employment cannot be modified further.
- * @type {Employment['status'][]}
- * @constant
- */
-declare const reviewStepAllowedEmploymentStatus: Employment['status'][];
-declare const disabledInviteButtonEmploymentStatus: Employment['status'][];
-/**
- * Array of employment statuses that have already handled the reserve flow.
- * @type {Employment['status'][]}
- * @constant
- */
-declare const statusesWithReserveAlreadyHandled: Employment['status'][];
-declare const DEFAULT_VERSION = 1;
-/**
- * Checks if a country's contract details schema is served as jsfVersion 1
- *
- * @param countryCode - The country code to check
- */
-declare const usesJsfV1ContractDetails: (countryCode: string | null) => boolean;
-/**
- * Resolves the effective contract details schema version for a country
- *
- * @param options - The flow options containing version configurations
- * @param countryCode - The country code to resolve version for
- * @returns The effective jsonSchemaVersion configuration
- */
-declare const getContractDetailsSchemaVersion: (options: OnboardingFlowProps["options"], countryCode: string | null) => number | "latest";
-/**
- * Gets the basic information schema version from options
- * @param options - The flow options containing version configurations
- * @returns The jsonSchemaVersion for basic information or default
- */
-declare const getBasicInformationSchemaVersion: (options: OnboardingFlowProps["options"]) => number | "latest";
-/**
- * Gets the benefit offers schema version from options
- * @param options - The flow options containing version configurations
- * @returns The jsonSchemaVersion for benefit offers or undefined if not set
- */
-declare const getBenefitOffersSchemaVersion: (options: OnboardingFlowProps["options"]) => number | "latest";
-/**
- * Gets the engagement agreement details schema version from options
- * @param options - The flow options containing version configurations
- * @returns The jsonSchemaVersion for engagement agreement details or default
- */
-declare const getEngagementAgreementDetailsSchemaVersion: (options: OnboardingFlowProps["options"]) => number | "latest";
-
-type OnboardingHookProps = Omit<OnboardingFlowProps, 'render'>;
-declare const useOnboarding: ({ employmentId, companyId, countryCode, type, options, skipSteps, externalId, partnerExternalId, initialValues: onboardingInitialValues, }: OnboardingHookProps) => {
-    /**
-     * Employment id passed useful to be used between components
-     */
-    employmentId: string | undefined;
-    /**
-     * Onboarding flow options (feature flags)
-     */
-    options: {
-        features: ("split_salary_description" | "onboarding_reserves" | "dynamic_steps" | "ea_preview" | "pre_onboarding_requirements" | "daily_schedule")[] | undefined;
-    };
-    /**
-     * Credit risk status of the company, useful to know what to to show in the review step
-     * The possible values are:
-     * - not_started
-     * - ready
-     * - in_progress
-     * - referred
-     * - fail
-     * - deposit_required
-     * - no_deposit_required
-     */
-    creditRiskStatus: "not_started" | "ready" | "in_progress" | "referred" | "fail" | "deposit_required" | "no_deposit_required" | undefined;
-    /**
-     * Onboarding reserves status for the employment
-     * Returns 'deposit_required' if a deposit is required based on onboarding reserves policies
-     */
-    onboardingReservesStatus: "not_started" | "ready" | "in_progress" | "referred" | "fail" | "deposit_required" | "no_deposit_required" | undefined;
-    /**
-     * Current state of the form fields for the current step.
-     */
-    fieldValues: FieldValues;
-    /**
-     * Current step state containing the current step and total number of steps
-     */
-    stepState: {
-        currentStep: Step<StepKeys>;
-        totalSteps: number;
-        values: {
-            review: FieldValues;
-            benefits: FieldValues;
-            contract_details: FieldValues;
-            select_country: FieldValues;
-            basic_information: FieldValues;
-            engagement_agreement_details: FieldValues;
-            employment_agreement_preview: FieldValues;
-        } | null;
-    };
-    /**
-     * Array of form fields from the onboarding schema
-     */
-    fields: JSFFields;
-    /**
-     * Loading state indicating if the onboarding schema is being fetched
-     */
-    isLoading: boolean;
-    /**
-     * Loading state indicating if the onboarding mutation is in progress
-     */
-    isSubmitting: boolean;
-    /**
-     * Initial form values
-     */
-    initialValues: {
-        select_country: Record<string, unknown>;
-        basic_information: Record<string, unknown>;
-        engagement_agreement_details: Record<string, unknown>;
-        contract_details: Record<string, unknown>;
-        benefits: Record<string, unknown>;
-        employment_agreement_preview: {};
-    } | {
-        select_country: Record<string, unknown>;
-        basic_information: Record<string, unknown>;
-        contract_details: Record<string, unknown>;
-        benefits: Record<string, unknown>;
-        employment_agreement_preview: {};
-        engagement_agreement_details?: undefined;
-    };
-    /**
-     * Function to validate form values against the onboarding schema
-     * @param values - Form values to validate
-     * @returns Validation result or null if no schema is available
-     */
-    handleValidation: (values: FieldValues) => Promise<ValidationResult | null>;
-    /**
-     * Function to update the current form field values
-     * @param values - New form values to set
-     */
-    checkFieldUpdates: (values: FieldValues) => Promise<void>;
-    /**
-     * Function to parse form values before submission
-     * @param values - Form values to parse
-     * @returns Parsed form values
-     */
-    parseFormValues: (values: FieldValues) => Promise<Record<string, any>>;
-    /**
-     * Function to handle form submission
-     * @param values - Form values to submit
-     * @returns Promise resolving to the mutation result
-     */
-    onSubmit: (values: FieldValues) => Promise<{
-        data: {
-            countryCode: any;
-        };
-    } | SuccessResponse$1<({
-        data: EmploymentCreationResponse;
-        error: undefined;
-    } | {
-        data: undefined;
-        error: UnprocessableEntityResponse | TooManyRequestsResponse | ConflictResponse | BadRequestResponse | ForbiddenResponse;
-    }) & {
-        request: Request;
-        response: Response;
-    }> | ErrorResponse<Error> | SuccessResponse$1<({
-        data: EmploymentResponse;
-        error: undefined;
-    } | {
-        data: undefined;
-        error: UnprocessableEntityResponse | TooManyRequestsResponse | ConflictResponse | BadRequestResponse | ForbiddenResponse;
-    }) & {
-        request: Request;
-        response: Response;
-    }> | SuccessResponse$1<({
-        data: SuccessResponse;
-        error: undefined;
-    } | {
-        data: undefined;
-        error: NotFoundResponse | UnprocessableEntityResponse | TooManyRequestsResponse | ConflictResponse | BadRequestResponse | ForbiddenResponse;
-    }) & {
-        request: Request;
-        response: Response;
-    }> | undefined>;
-    /**
-     * Function to handle going back to the previous step
-     * @returns {void}
-     */
-    back: () => void;
-    /**
-     * Function to handle going to the next step
-     * @returns {void}
-     */
-    next: () => void;
-    /**
-     * Function to handle going to a specific step
-     * @param step The step to go to.
-     * @returns {void}
-     */
-    goTo: (step: StepKeys) => void;
-    /**
-     * Fields metadata for each step
-     */
-    meta: {
-        fields: {
-            select_country: NestedMeta;
-            basic_information: NestedMeta;
-            contract_details: NestedMeta;
-            benefits: NestedMeta;
-            engagement_agreement_details: NestedMeta;
-            employment_agreement_preview: NestedMeta;
-        };
-        fieldsets: JSFFieldset | null | undefined;
-        presentation: Record<string, unknown> | null | undefined;
-    };
-    /**
-     * Function to refetch the employment data
-     * @returns {void}
-     */
-    refetchEmployment: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<(Employment$1 & {
-        termination_date?: string | null;
-    }) | undefined, unknown>>;
-    /**
-     * Employment data
-     */
-    employment: (Employment$1 & {
-        termination_date?: string | null;
-    }) | undefined;
-    /**
-     * let's the user know that the employment cannot be edited, happens when employment.status is invited, created_awaiting_reserve or created_reserve_paid
-     * @returns {boolean}
-     */
-    isEmploymentReadOnly: boolean;
-    /**
-     * let's the user know if the company can invite employees
-     * @returns {boolean}
-     */
-    canInvite: boolean | undefined;
-    /**
-     * Steps array for dynamic step navigation
-     * When 'dynamic_steps' feature is enabled:
-     * - Returns all steps including hidden ones with their original indices
-     * - Consumers must filter by `visible` property
-     * When disabled (default):
-     * - Returns only visible steps with sequential indices
-     * - Maintains backwards compatibility with existing implementations
-     * @returns {Array<{name: string, visible: boolean, index: number, label: string}>}
-     */
-    steps: {
-        name: StepKeys;
-        index: number;
-        label: string;
-        visible: boolean;
-    }[];
-    /**
-     * Selected country for the onboarding
-     * @returns {name: string, code: string} | null
-     */
-    selectedCountry: {
-        code: string;
-        name: string | undefined;
-    } | null;
-    /**
-     * Employment agreement preview
-     */
-    employmentAgreementPreview: NoInfer<{
-        content: Blob | File;
-        name: string;
-    }> | undefined;
-};
-
-type SelectCountryStepProps = {
-    onSubmit?: (payload: SelectCountryFormPayload) => void | Promise<void>;
-    onSuccess?: (data: SelectCountrySuccess) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function SelectCountryStep({ onSubmit, onSuccess, onError, }: SelectCountryStepProps): react.JSX.Element;
-
-type ReviewStepProps = {
-    /**
-     * Render prop function for customizing the review step credit risk flow UI
-     *
-     * @param props - Object containing credit risk information
-     * @param props.creditRiskState - Current state of the credit risk flow
-     *   - 'referred': Company has been referred for manual review
-     *   - 'deposit_required': Deposit payment is required but not yet paid
-     *   - 'deposit_required_successful': Deposit payment has been successfully processed
-     *   - 'invite': Regular invite flow is available (no deposit required)
-     *   - 'invite_successful': Invitation has been successfully sent
-     *   - null: No specific credit risk state applies
-     *
-     * @param props.creditRiskStatus - Credit risk status from the backend
-     *   - 'not_started': Credit risk assessment has not been initiated
-     *   - 'ready': Ready for credit risk assessment
-     *   - 'in_progress': Credit risk assessment is in progress
-     *   - 'referred': Company has been referred for manual review
-     *   - 'fail': Credit risk assessment failed
-     *   - 'deposit_required': Company requires a deposit payment
-     *   - 'no_deposit_required': No deposit is required for this company
-     *   - undefined: Credit risk status not yet determined
-     * @returns React.ReactNode to render for the review step
-     */
-    render: (props: {
-        creditRiskState: CreditRiskState;
-        creditRiskStatus: CreditRiskStatus | undefined;
-    }) => React.ReactNode;
-};
-declare function ReviewStep({ render }: ReviewStepProps): react.ReactNode;
-
-type EngagementAgreementDetailsStepProps = {
-    /**
-     * The function is called when the form is submitted. It receives the form values as an argument.
-     */
-    onSubmit?: (payload: EngagementAgreementDetailsFormPayload) => void | Promise<void>;
-    /**
-     * The function is called when the form submission is successful.
-     */
-    onSuccess?: (data: SuccessResponse) => void | Promise<void>;
-    /**
-     * The function is called when an error occurs during form submission.
-     */
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function EngagementAgreementDetailsStep({ onSubmit, onSuccess, onError, }: EngagementAgreementDetailsStepProps): react.JSX.Element;
-
-declare const useCompany: (companyId: string) => UseQueryResult<NoInfer<Company | undefined>, Error>;
-declare const useBenefitOffers: (employmentId: string | undefined) => UseQueryResult<NoInfer<Record<string, {
-    value: string;
-}>>, Error>;
-declare const useEmploymentEngagementAgreementDetails: (employmentId: string | undefined, queryOptions?: {
-    enabled?: boolean;
-}) => UseQueryResult<NoInfer<{
-    allowances_details?: Array<string> | null;
-    available_pto?: number | null;
-    break_time_per_day?: number | null;
-    business_expenses?: string | null;
-    cba?: string | null;
-    cba_document?: Array<EngagementAgreementDetailsFile> | null;
-    covenants?: Array<string> | null;
-    has_allowances?: string | null;
-    has_bonus?: string | null;
-    has_business_expenses?: string | null;
-    has_business_presence?: string;
-    has_cba?: string | null;
-    has_commissions?: string | null;
-    has_covenants?: string | null;
-    has_illness_remuneration?: string | null;
-    has_overtime_compensation?: string | null;
-    has_pension_scheme?: string | null;
-    has_signing_bonus?: string | null;
-    has_similar_roles?: string;
-    has_similar_work_conditions?: string | null;
-    illness_remuneration_details?: string | null;
-    max_annual_gross_salary?: number | null;
-    min_annual_gross_salary?: number | null;
-    overtime_compensation_begins?: number | null;
-    overtime_compensation_type?: string | null;
-    overtime_pay_percentage?: number | null;
-    pension_scheme?: string | null;
-    similar_roles?: string | null;
-    similar_work_conditions_details?: string | null;
-    work_hours_per_week?: number | null;
-    working_days?: Array<string> | null;
-}>, Error>;
-/**
- * Use this hook to invite an employee to the onboarding flow
- * @returns
- */
-declare const useEmploymentInvite: () => _tanstack_react_query.UseMutationResult<({
-    data: SuccessResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: UnprocessableEntityResponse | TooManyRequestsResponse | ConflictResponse | BadRequestResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, {
-    employment_id: string;
-}, unknown>;
-declare const useCreateReserveInvoice: () => _tanstack_react_query.UseMutationResult<({
-    data: SuccessResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | UnauthorizedResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, {
-    employment_slug: string;
-}, unknown>;
-/**
- * Use this hook to get the JSON schema form for the onboarding flow
- * @param param0
- * @returns
- */
-declare const useJSONSchemaForm: ({ countryCode, form, fieldValues, options, query, jsonSchemaVersion, }: {
-    countryCode: string;
-    form: JSONSchemaFormType;
-    fieldValues: FieldValues;
-    options?: FlowOptions & {
-        queryOptions?: {
-            enabled?: boolean;
-        };
-    };
-    query?: Record<string, unknown>;
-    jsonSchemaVersion?: number | "latest";
-}) => UseQueryResult<JSONSchemaFormResultWithFieldsets>;
-declare const useContractDetailsSchema: ({ countryCode, options, query, jsonSchemaVersion, }: {
-    countryCode: string;
-    options?: FlowOptions & {
-        queryOptions?: {
-            enabled?: boolean;
-        };
-        transformMoneyFields?: boolean;
-    };
-    query?: Record<string, unknown>;
-    jsonSchemaVersion?: number | "latest";
-}) => {
-    data: JSONSchemaFormResultWithFieldsets | null;
-    isLoading: boolean;
-};
-declare const useBenefitOffersSchema: (employmentId: string, fieldValues: FieldValues, options: OnboardingFlowProps["options"]) => UseQueryResult<NoInfer<JSONSchemaFormResultWithFieldsets>, Error>;
-/**
- * Use this hook to create an employment
- * @returns
- */
-declare const useCreateEmployment: (options?: OnboardingFlowProps["options"]) => _tanstack_react_query.UseMutationResult<({
-    data: EmploymentCreationResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: UnprocessableEntityResponse | TooManyRequestsResponse | ConflictResponse | BadRequestResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, EmploymentCreateParams, unknown>;
-declare const useUpdateEmployment: (countryCode: string, options?: OnboardingFlowProps["options"]) => _tanstack_react_query.UseMutationResult<({
-    data: EmploymentResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: UnprocessableEntityResponse | TooManyRequestsResponse | ConflictResponse | BadRequestResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, EmploymentFullParams & {
-    employmentId: string;
-}, unknown>;
-declare const useUpdateEmploymentEngagementAgreementDetails: () => _tanstack_react_query.UseMutationResult<({
-    data: SuccessResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | TooManyRequestsResponse | ConflictResponse | BadRequestResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, EmploymentEngagementAgreementDetailsParams & {
-    employmentId: string;
-}, unknown>;
-declare const useUpdateBenefitsOffers: (options?: OnboardingFlowProps["options"]) => _tanstack_react_query.UseMutationResult<({
-    data: SuccessResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | UnauthorizedResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, UnifiedEmploymentUpsertBenefitOffersRequest & {
-    employmentId: string;
-}, unknown>;
-declare const useCountriesSchemaField: (options?: Omit<FlowOptions, "jsonSchemaVersion"> & {
-    queryOptions?: {
-        enabled?: boolean;
-    };
-}) => {
-    isLoading: boolean;
-    selectCountryForm: JSONSchemaFormResultWithFieldsets;
-    countries: NoInfer<{
-        label: string;
-        value: string;
-        employment_agreement_preview_available: boolean | undefined;
-    }[]> | undefined;
-};
-declare const useConvertCurrency: ({ type, }: {
-    type?: "spread" | "no_spread";
-}) => _tanstack_react_query.UseMutationResult<({
-    data: ConvertCurrencyResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | UnauthorizedResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, ConvertCurrencyParams, unknown>;
-declare const useUpsertContractEligibility: () => _tanstack_react_query.UseMutationResult<({
-    data: SuccessResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: UnprocessableEntityResponse | TooManyRequestsResponse | BadRequestResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, {
-    employmentId: string;
-} & CreateContractEligibilityParams, unknown>;
-/**
- * Hook to fetch onboarding reserves status for an employment
- * @param companyId - Company ID
- * @param employmentId - Employment ID
- * @param enabled - Whether the query should be enabled
- * @returns Query result with onboarding reserves status
- */
-declare const useEmploymentOnboardingReservesStatus: (companyId: string | undefined, employmentId: string | undefined, enabled?: boolean) => UseQueryResult<"not_started" | "ready" | "in_progress" | "referred" | "fail" | "deposit_required" | "no_deposit_required", Error>;
-declare const useEngagementAgreementDetailsSchema: (countryCode: string, fieldValues: FieldValues, options?: {
-    jsfModify?: OnboardingJsfModify;
-    queryOptions?: {
-        enabled?: boolean;
-    };
-    jsonSchemaVersion?: number | "latest";
-}) => UseQueryResult<NoInfer<JSONSchemaFormResultWithFieldsets>, Error>;
-/**
- * Get pre-onboarding requirements for an employment
- */
-declare const useGetPreOnboardingRequirements: (employmentId: string, options?: {
-    queryOptions?: {
-        enabled?: boolean;
-    };
-}) => UseQueryResult<NoInfer<PreOnboardingRequirement[]>, Error>;
-/**
- * Create a pre-onboarding document
- */
-declare const useCreatePreOnboardingDocument: () => _tanstack_react_query.UseMutationResult<({
-    data: CreatePreOnboardingDocumentResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | UnauthorizedResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, {
-    employmentId: string;
-    body: PostV1OnboardingEmploymentsEmploymentIdPreOnboardingRequirementsRequirementSlugDocumentsData["path"];
-}, unknown>;
-/**
- * Get pre-onboarding document preview
- */
-declare const useGetPreOnboardingDocument: (employmentId: string, documentId: string | undefined, options?: {
-    queryOptions?: {
-        enabled?: boolean;
-    };
-}) => UseQueryResult<NoInfer<{
-    pre_onboarding_document: {
-        content: Blob | File;
-        name: string;
-        signatories: Array<Signatory>;
-        status: ContractorContractDocumentStatus;
-    };
-}>, Error>;
-/**
- * Sign a pre-onboarding document
- */
-declare const useSignPreOnboardingDocument: () => _tanstack_react_query.UseMutationResult<({
-    data: SuccessResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | BadRequestResponse | UnauthorizedResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, {
-    employmentId: string;
-    documentId: string;
-    signature: string;
-}, unknown>;
-/**
- * Acknowledge a pre-onboarding requirement
- */
-declare const useAcknowledgePreOnboardingRequirement: () => _tanstack_react_query.UseMutationResult<({
-    data: CreatePreOnboardingAcknowledgementResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | UnauthorizedResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, {
-    employmentId: string;
-    requirementSlug: string;
-}, unknown>;
-/**
- * Remove acknowledgement from a pre-onboarding requirement
- */
-declare const useRemoveAcknowledgePreOnboardingRequirement: () => _tanstack_react_query.UseMutationResult<({
-    data: SuccessResponse;
-    error: undefined;
-} | {
-    data: undefined;
-    error: NotFoundResponse | UnprocessableEntityResponse | UnauthorizedResponse | ForbiddenResponse;
-}) & {
-    request: Request;
-    response: Response;
-}, Error, {
-    employmentId: string;
-    requirementSlug: string;
-}, unknown>;
-/**
- * Get employment agreement preview
- */
-declare const useEmploymentAgreementPreview: (employmentId: string | undefined, options?: {
-    queryOptions?: {
-        enabled?: boolean;
-    };
-}) => UseQueryResult<NoInfer<{
-    content: Blob | File;
-    name: string;
-}>, Error>;
-
-declare const usePreOnboardingRequirements: ({ employmentId, }: {
-    employmentId: string;
-    options?: Parameters<typeof useGetPreOnboardingRequirements>[1];
-}) => {
-    requirements: NoInfer<PreOnboardingRequirement[]> | undefined;
-    isLoadingRequirements: boolean;
-    documentPreview: NoInfer<{
-        pre_onboarding_document: {
-            content: Blob | File;
-            name: string;
-            signatories: Array<Signatory>;
-            status: ContractorContractDocumentStatus;
-        };
-    }> | undefined;
-    isSigning: boolean;
-    onCreateDocument: (requirementSlug: string) => Promise<CreatePreOnboardingDocumentResponse | null | undefined>;
-    onSignDocument: (signature: string) => Promise<SuccessResponse | undefined>;
-    onAcknowledgeRequirement: (requirementSlug: string) => Promise<void>;
-    isPendingAcknowledgement: boolean;
-    isAckLocked: (requirementSlug: string) => boolean;
-    isRequirementLoading: (requirementSlug: string) => boolean;
-};
-type PreOnboardingRequirementsBag = ReturnType<typeof usePreOnboardingRequirements>;
-declare const PreOnboardingRequirements: ({ render, }: {
-    render: (bag: PreOnboardingRequirementsBag) => React.ReactNode;
-}) => react.ReactNode;
-
-type OnboardingRenderProps = {
-    /**
-     * The onboarding bag returned by the useOnboarding hook.
-     * This bag contains all the methods and properties needed to handle the onboarding flow.
-     * @see {@link useOnboarding}
-     */
-    onboardingBag: ReturnType<typeof useOnboarding>;
-    /**
-     * The components used in the onboarding flow.
-     * This includes different steps, submit button, back button.
-     * @see {@link BasicInformationStep}
-     * @see {@link EngagementAgreementDetailsStep}
-     * @see {@link ContractDetailsStep}
-     * @see {@link OnboardingSubmit}
-     * @see {@link OnboardingBack}
-     * @see {@link OnboardingInvite}
-     * @see {@link BenefitsStep}
-     * @see {@link OnboardingCreateReserve}
-     * @see {@link InvitationSection}
-     * @see {@link SelectCountryStep}
-     * @see {@link ReviewStep}
-     * @see {@link SaveDraftButton}
-     * @see {@link PreOnboardingRequirements}
-     * @see {@link PreviewEmploymentAgreementStep}
-     */
-    components: {
-        SubmitButton: typeof OnboardingSubmit;
-        BackButton: typeof OnboardingBack;
-        BasicInformationStep: typeof BasicInformationStep;
-        EngagementAgreementDetailsStep: typeof EngagementAgreementDetailsStep;
-        OnboardingInvite: typeof OnboardingInvite;
-        ContractDetailsStep: typeof ContractDetailsStep;
-        BenefitsStep: typeof BenefitsStep;
-        SelectCountryStep: typeof SelectCountryStep;
-        ReviewStep: typeof ReviewStep;
-        SaveDraftButton: typeof SaveDraftButton;
-        PreOnboardingRequirements: typeof PreOnboardingRequirements;
-        PreviewEmploymentAgreementStep: typeof PreviewEmploymentAgreementStep;
-    };
-};
-type OnboardingFeatures = 'onboarding_reserves' | 'dynamic_steps' | 'ea_preview' | 'pre_onboarding_requirements' | 'split_salary_description' | 'daily_schedule';
-/**
- * JSON schema version configuration for a specific country
- */
-type CountryJsonSchemaVersion = {
-    /**
-     * @deprecated Use `jsonSchemaVersion.employment_basic_information` instead for global configuration.
-     * This country-specific override is no longer recommended.
-     *
-     * The json schema version to use for the basic information step by country.
-     * The default value is 1.
-     */
-    employment_basic_information?: number;
-    /**
-     * The json schema version to use for the contract details step by country.
-     * This is used to override the json schema version for the contract details step by country.
-     * The default value is 1.
-     */
-    contract_details?: number | 'latest';
-};
-type OnboardingJsfModify = {
-    select_country?: JSFModify;
-    basic_information?: JSFModify;
-    engagement_agreement_details?: JSFModify;
-    contract_details?: JSFModify;
-    benefits?: JSFModify;
-};
-type OnboardingFlowProps = {
-    /**
-     * The country code to use for the onboarding.
-     */
-    countryCode?: string;
-    /**
-     * The employment id to use for the onboarding.
-     */
-    employmentId?: string;
-    /**
-     * The company id to use for the onboarding.
-     */
-    companyId: string;
-    /**
-     * Unique reference code for the employment record in a non-Remote system. This optional field links to external data sources.
-     * If not provided, it defaults to null. While uniqueness is recommended, it is not strictly enforced within Remote's system.
-     */
-    externalId?: string;
-    /**
-     * A reference code for the employment record, private to your own integration.
-     * If not provided, it defaults to null.
-     */
-    partnerExternalId?: string;
-    /**
-     * Initial values to pre-populate the form fields.
-     * These are flat field values that will be automatically mapped to the correct step.
-     * Server data will override these values. This happens when you pass employmentId and the server returns an employment object.
-     */
-    initialValues?: Record<string, unknown>;
-    /**
-     * The steps to skip for the onboarding. We only support skipping the select_country step for now.
-     */
-    skipSteps?: ['select_country'];
-    /**
-     * The type of employment to use for the onboarding. Employee or contractor.
-     */
-    type?: EmploymentCreateParams['type'];
-    /**
-     * The options to use for the onboarding.
-     */
-    options?: Omit<FlowOptions, 'jsfModify' | 'jsonSchemaVersion'> & {
-        jsfModify?: OnboardingJsfModify;
-        /**
-         * The json schema version to use for the onboarding.
-         * These versions apply globally to all countries.
-         * For country-specific overrides (e.g., contract_details), use jsonSchemaVersionByCountry instead.
-         * The default value is 1.
-         */
-        jsonSchemaVersion?: {
-            /**
-             * The json schema version to use for the basic information step.
-             * Applies globally to all countries.
-             * The default value is 1.
-             */
-            employment_basic_information?: number | 'latest';
-            /**
-             * The json schema version to use for the benefit offers step.
-             * This is used to override the json schema version for the benefit offers step.
-             * The default value is 1.
-             */
-            benefit_offers_form_schema?: number | 'latest';
-            /**
-             * The json schema version to use for the engagement agreement details step.
-             * This is used to override the json schema version for the engagement agreement details step.
-             * The default value is 1.
-             */
-            engagement_agreement_details?: number | 'latest';
-        };
-        /**
-         * The json schema version to use for the onboarding by country.
-         * This is used to override the json schema version for the onboarding by country.
-         * Current use case is to support contract_details
-         */
-        jsonSchemaVersionByCountry?: {
-            [countryCode: string]: CountryJsonSchemaVersion;
-        };
-        /**
-         * The features to use for the onboarding.
-         * This is used to enable or disable features for the onboarding.
-         * - 'onboarding_reserves': Enable onboarding reserves feature
-         * - 'dynamic_steps': Enable dynamic step generation with visibility control (opt-in, will be default in next major version)
-         * - 'split_salary_description': Hand the annual gross salary description, its help center link and the
-         *   currency conversion toggle to the text component as three separate slots (`description`,
-         *   `meta.helpCenter`, `descriptionSuffix`) instead of packing them into `description`.
-         *   Custom text components must render `fieldData.descriptionSuffix` to keep the conversion toggle.
-         */
-        features?: OnboardingFeatures[];
-    };
-    /**
-     * The render prop function with the params passed by the useOnboarding hook and the components available to use for this flow
-     */
-    render: ({ onboardingBag, components, }: OnboardingRenderProps) => React.ReactNode;
-};
-type SelectCountryFormPayload = {
-    countryCode: string;
-};
-type SelectCountrySuccess = {
-    countryCode: string;
-};
-type BasicInformationFormPayload = {
-    name: string;
-    email: string;
-    work_email: string;
-    job_title: string;
-    tax_servicing_countries: string[];
-    tax_job_category: string;
-    department: {
-        id: string;
-        name?: string;
-    };
-    provisional_start_date: string;
-    has_seniority_date: 'yes' | 'no';
-    manager: {
-        id: string;
-    };
-    seniority_date: string;
-};
-type BenefitsFormPayload = Record<string, {
-    value: string;
-    filter?: string;
-}>;
-type ContractDetailsFormPayload = Record<string, unknown>;
-type EngagementAgreementDetailsFormPayload = EmploymentEngagementAgreementDetailsParams;
-type CreditRiskStatus = 'not_started' | 'ready' | 'in_progress' | 'referred' | 'fail' | 'deposit_required' | 'no_deposit_required';
-type Employment = Employment$1 & {
-    /**
-     * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
-     */
-    termination_date?: string | null;
-};
-type CreditRiskState = 'deposit_required' | 'deposit_required_successful' | 'invite' | 'invite_successful' | 'referred' | null;
-
-export { useUpsertContractEligibility as $, useContractDetailsSchema as A, type BasicInformationFormPayload as B, type ContractDetailsFormPayload as C, DEFAULT_VERSION as D, type Employment as E, useConvertCurrency as F, useCountriesSchemaField as G, useCreateEmployment as H, useCreatePreOnboardingDocument as I, useCreateReserveInvoice as J, useEmploymentAgreementPreview as K, useEmploymentEngagementAgreementDetails as L, useEmploymentInvite as M, useEmploymentOnboardingReservesStatus as N, type OnboardingRenderProps as O, type PreOnboardingRequirementsBag as P, useEngagementAgreementDetailsSchema as Q, ReviewStep as R, type SelectCountryFormPayload as S, useGetPreOnboardingDocument as T, useGetPreOnboardingRequirements as U, useJSONSchemaForm as V, useRemoveAcknowledgePreOnboardingRequirement as W, useSignPreOnboardingDocument as X, useUpdateBenefitsOffers as Y, useUpdateEmployment as Z, useUpdateEmploymentEngagementAgreementDetails as _, type BenefitsFormPayload as a, PreOnboardingRequirements as a0, usePreOnboardingRequirements as a1, type OnboardingJsfModify as a2, type CreditRiskState as b, type CreditRiskStatus as c, type EngagementAgreementDetailsFormPayload as d, type SelectCountrySuccess as e, type OnboardingFlowProps as f, type StepKeys as g, SelectCountryStep as h, BasicInformationStep as i, ContractDetailsStep as j, BenefitsStep as k, buildSteps as l, disabledInviteButtonEmploymentStatus as m, getBasicInformationSchemaVersion as n, getBenefitOffersSchemaVersion as o, getContractDetailsSchemaVersion as p, getEngagementAgreementDetailsSchemaVersion as q, reviewStepAllowedEmploymentStatus as r, statusesWithReserveAlreadyHandled as s, usesJsfV1ContractDetails as t, useOnboarding as u, EngagementAgreementDetailsStep as v, useAcknowledgePreOnboardingRequirement as w, useBenefitOffers as x, useBenefitOffersSchema as y, useCompany as z };