@remoteoss/remote-flows 1.54.0 → 1.56.0

package/dist/types-DM3hjkjw.d.ts

@@ -0,0 +1,899 @@
+import { c as JSFFieldset, d as NestedMeta, r as Components, s as JSFFields } from "./remoteFlows-DzjJtmiU.js";
+import { A as EmploymentEngagementAgreementDetailsParams, D as EmploymentCreateParams, E as Employment$1, J as PreOnboardingRequirement, N as File, O as EmploymentCreationResponse, P as ForbiddenResponse, Q as Signatory, U as NotFoundResponse, at as TooManyRequestsResponse, i as BadRequestResponse, j as EmploymentResponse, l as ConflictResponse, p as ContractorContractDocumentStatus, r as FieldValues, st as UnprocessableEntityResponse, tt as SuccessResponse, w as CreatePreOnboardingDocumentResponse } from "./index-DZOv3Kqg.js";
+import { t as Step } from "./useStepState-DPuZ-xcq.js";
+import { i as SuccessResponse$1, n as FieldError, r as NormalizedFieldError, t as ErrorResponse } from "./mutations-BtF_JHC1.js";
+import { r as JSFModify, t as FlowOptions } from "./types-PZPLLCvV.js";
+import { ButtonHTMLAttributes, PropsWithChildren, ReactNode } from "react";
+import { UseQueryResult } from "@tanstack/react-query";
+import { ValidationResult } from "@remoteoss/remote-json-schema-form-kit";
+//#region node_modules/@tanstack/query-core/build/modern/_tsup-dts-rollup.d.ts
+declare type DefaultError = Register extends {
+  defaultError: infer TError;
+} ? TError : Error;
+declare type DefinedQueryObserverResult<TData = unknown, TError = DefaultError> = QueryObserverRefetchErrorResult<TData, TError> | QueryObserverSuccessResult<TData, TError>;
+declare type FetchStatus = 'fetching' | 'paused' | 'idle';
+declare interface QueryObserverBaseResult<TData = unknown, TError = DefaultError> {
+  /**
+   * The last successfully resolved data for the query.
+   */
+  data: TData | undefined;
+  /**
+   * The timestamp for when the query most recently returned the `status` as `"success"`.
+   */
+  dataUpdatedAt: number;
+  /**
+   * The error object for the query, if an error was thrown.
+   * - Defaults to `null`.
+   */
+  error: TError | null;
+  /**
+   * The timestamp for when the query most recently returned the `status` as `"error"`.
+   */
+  errorUpdatedAt: number;
+  /**
+   * The failure count for the query.
+   * - Incremented every time the query fails.
+   * - Reset to `0` when the query succeeds.
+   */
+  failureCount: number;
+  /**
+   * The failure reason for the query retry.
+   * - Reset to `null` when the query succeeds.
+   */
+  failureReason: TError | null;
+  /**
+   * The sum of all errors.
+   */
+  errorUpdateCount: number;
+  /**
+   * A derived boolean from the `status` variable, provided for convenience.
+   * - `true` if the query attempt resulted in an error.
+   */
+  isError: boolean;
+  /**
+   * Will be `true` if the query has been fetched.
+   */
+  isFetched: boolean;
+  /**
+   * Will be `true` if the query has been fetched after the component mounted.
+   * - This property can be used to not show any previously cached data.
+   */
+  isFetchedAfterMount: boolean;
+  /**
+   * A derived boolean from the `fetchStatus` variable, provided for convenience.
+   * - `true` whenever the `queryFn` is executing, which includes initial `pending` as well as background refetch.
+   */
+  isFetching: boolean;
+  /**
+   * Is `true` whenever the first fetch for a query is in-flight.
+   * - Is the same as `isFetching && isPending`.
+   */
+  isLoading: boolean;
+  /**
+   * Will be `pending` if there's no cached data and no query attempt was finished yet.
+   */
+  isPending: boolean;
+  /**
+   * Will be `true` if the query failed while fetching for the first time.
+   */
+  isLoadingError: boolean;
+  /**
+   * @deprecated `isInitialLoading` is being deprecated in favor of `isLoading`
+   * and will be removed in the next major version.
+   */
+  isInitialLoading: boolean;
+  /**
+   * A derived boolean from the `fetchStatus` variable, provided for convenience.
+   * - The query wanted to fetch, but has been `paused`.
+   */
+  isPaused: boolean;
+  /**
+   * Will be `true` if the data shown is the placeholder data.
+   */
+  isPlaceholderData: boolean;
+  /**
+   * Will be `true` if the query failed while refetching.
+   */
+  isRefetchError: boolean;
+  /**
+   * Is `true` whenever a background refetch is in-flight, which _does not_ include initial `pending`.
+   * - Is the same as `isFetching && !isPending`.
+   */
+  isRefetching: boolean;
+  /**
+   * Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
+   */
+  isStale: boolean;
+  /**
+   * A derived boolean from the `status` variable, provided for convenience.
+   * - `true` if the query has received a response with no errors and is ready to display its data.
+   */
+  isSuccess: boolean;
+  /**
+   * `true` if this observer is enabled, `false` otherwise.
+   */
+  isEnabled: boolean;
+  /**
+   * A function to manually refetch the query.
+   */
+  refetch: (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>>;
+  /**
+   * The status of the query.
+   * - Will be:
+   *   - `pending` if there's no cached data and no query attempt was finished yet.
+   *   - `error` if the query attempt resulted in an error.
+   *   - `success` if the query has received a response with no errors and is ready to display its data.
+   */
+  status: QueryStatus;
+  /**
+   * The fetch status of the query.
+   * - `fetching`: Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetch.
+   * - `paused`: The query wanted to fetch, but has been `paused`.
+   * - `idle`: The query is not fetching.
+   * - See [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information.
+   */
+  fetchStatus: FetchStatus;
+  /**
+   * A stable promise that will be resolved with the data of the query.
+   * Requires the `experimental_prefetchInRender` feature flag to be enabled.
+   * @example
+   *
+   * ### Enabling the feature flag
+   * ```ts
+   * const client = new QueryClient({
+   *   defaultOptions: {
+   *     queries: {
+   *       experimental_prefetchInRender: true,
+   *     },
+   *   },
+   * })
+   * ```
+   *
+   * ### Usage
+   * ```tsx
+   * import { useQuery } from '@tanstack/react-query'
+   * import React from 'react'
+   * import { fetchTodos, type Todo } from './api'
+   *
+   * function TodoList({ query }: { query: UseQueryResult<Todo[], Error> }) {
+   *   const data = React.use(query.promise)
+   *
+   *   return (
+   *     <ul>
+   *       {data.map(todo => (
+   *         <li key={todo.id}>{todo.title}</li>
+   *       ))}
+   *     </ul>
+   *   )
+   * }
+   *
+   * export function App() {
+   *   const query = useQuery({ queryKey: ['todos'], queryFn: fetchTodos })
+   *
+   *   return (
+   *     <>
+   *       <h1>Todos</h1>
+   *       <React.Suspense fallback={<div>Loading...</div>}>
+   *         <TodoList query={query} />
+   *       </React.Suspense>
+   *     </>
+   *   )
+   * }
+   * ```
+   */
+  promise: Promise<TData>;
+}
+declare interface QueryObserverLoadingErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
+  data: undefined;
+  error: TError;
+  isError: true;
+  isPending: false;
+  isLoading: false;
+  isLoadingError: true;
+  isRefetchError: false;
+  isSuccess: false;
+  isPlaceholderData: false;
+  status: 'error';
+}
+declare interface QueryObserverLoadingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
+  data: undefined;
+  error: null;
+  isError: false;
+  isPending: true;
+  isLoading: true;
+  isLoadingError: false;
+  isRefetchError: false;
+  isSuccess: false;
+  isPlaceholderData: false;
+  status: 'pending';
+}
+declare interface QueryObserverPendingResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
+  data: undefined;
+  error: null;
+  isError: false;
+  isPending: true;
+  isLoadingError: false;
+  isRefetchError: false;
+  isSuccess: false;
+  isPlaceholderData: false;
+  status: 'pending';
+}
+declare interface QueryObserverPlaceholderResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
+  data: TData;
+  isError: false;
+  error: null;
+  isPending: false;
+  isLoading: false;
+  isLoadingError: false;
+  isRefetchError: false;
+  isSuccess: true;
+  isPlaceholderData: true;
+  status: 'success';
+}
+declare interface QueryObserverRefetchErrorResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
+  data: TData;
+  error: TError;
+  isError: true;
+  isPending: false;
+  isLoading: false;
+  isLoadingError: false;
+  isRefetchError: true;
+  isSuccess: false;
+  isPlaceholderData: false;
+  status: 'error';
+}
+declare type QueryObserverResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError> | QueryObserverLoadingErrorResult<TData, TError> | QueryObserverLoadingResult<TData, TError> | QueryObserverPendingResult<TData, TError> | QueryObserverPlaceholderResult<TData, TError>;
+declare interface QueryObserverSuccessResult<TData = unknown, TError = DefaultError> extends QueryObserverBaseResult<TData, TError> {
+  data: TData;
+  error: null;
+  isError: false;
+  isPending: false;
+  isLoading: false;
+  isLoadingError: false;
+  isRefetchError: false;
+  isSuccess: true;
+  isPlaceholderData: false;
+  status: 'success';
+}
+declare type QueryStatus = 'pending' | 'error' | 'success';
+declare interface RefetchOptions extends ResultOptions {
+  /**
+   * If set to `true`, a currently running request will be cancelled before a new request is made
+   *
+   * If set to `false`, no refetch will be made if there is already a request running.
+   *
+   * Defaults to `true`.
+   */
+  cancelRefetch?: boolean;
+}
+declare interface Register {}
+declare interface ResultOptions {
+  throwOnError?: boolean;
+}
+//#endregion
+//#region src/flows/Onboarding/components/BasicInformationStep.d.ts
+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): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/OnboardingBack.d.ts
+type OnboardingBackProps = ButtonHTMLAttributes<HTMLButtonElement> & Record<string, unknown>;
+declare function OnboardingBack({ children, onClick, ...props }: PropsWithChildren<OnboardingBackProps>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/OnboardingInvite.d.ts
+type OnboardingInviteProps = Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'onError'> & {
+  onSuccess?: ({ data, employmentStatus }: {
+    data: SuccessResponse;
+    employmentStatus: 'invited' | 'created_awaiting_reserve';
+  }) => void | Promise<void>;
+  onError?: ({ error, rawError, fieldErrors }: {
+    error: Error;
+    rawError: Record<string, unknown>;
+    fieldErrors: FieldError[];
+  }) => void;
+  onSubmit?: () => void | Promise<void>;
+  render: (props: {
+    employmentStatus: 'invited' | 'created_awaiting_reserve';
+  }) => ReactNode;
+} & Record<string, unknown>;
+declare function OnboardingInvite({ onSubmit, onSuccess, onError, render, ...props }: OnboardingInviteProps): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/ContractDetailsStep.d.ts
+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): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/OnboardingSubmit.d.ts
+declare function OnboardingSubmit({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement> & Record<string, unknown>>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/BenefitsStep.d.ts
+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): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/utils.d.ts
+type StepKeys = 'select_country' | 'basic_information' | 'engagement_agreement_details' | 'contract_details' | 'benefits' | 'employment_agreement_preview' | 'review';
+//#endregion
+//#region src/flows/Onboarding/hooks.d.ts
+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: ("daily_schedule" | "dynamic_steps" | "ea_preview" | "onboarding_reserves" | "pre_onboarding_requirements" | "split_salary_description")[] | 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: "deposit_required" | "fail" | "in_progress" | "no_deposit_required" | "not_started" | "ready" | "referred" | undefined;
+  /**
+   * Onboarding reserves status for the employment
+   * Returns 'deposit_required' if a deposit is required based on onboarding reserves policies
+   */
+  onboardingReservesStatus: "deposit_required" | "fail" | "in_progress" | "no_deposit_required" | "not_started" | "ready" | "referred" | 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: {
+      basic_information: FieldValues;
+      benefits: FieldValues;
+      contract_details: FieldValues;
+      employment_agreement_preview: FieldValues;
+      engagement_agreement_details: FieldValues;
+      review: FieldValues;
+      select_country: 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: {};
+  } | {
+    engagement_agreement_details?: undefined;
+    select_country: Record<string, unknown>;
+    basic_information: Record<string, unknown>;
+    contract_details: Record<string, unknown>;
+    benefits: Record<string, unknown>;
+    employment_agreement_preview: {};
+  };
+  /**
+   * 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<ErrorResponse<Error> | SuccessResponse$1<({
+    data: EmploymentResponse;
+    error: undefined;
+  } | {
+    data: undefined;
+    error: ConflictResponse | ForbiddenResponse | TooManyRequestsResponse | BadRequestResponse | UnprocessableEntityResponse;
+  }) & {
+    request: Request;
+    response: Response;
+  }> | SuccessResponse$1<({
+    data: EmploymentCreationResponse;
+    error: undefined;
+  } | {
+    data: undefined;
+    error: ConflictResponse | ForbiddenResponse | TooManyRequestsResponse | BadRequestResponse | UnprocessableEntityResponse;
+  }) & {
+    request: Request;
+    response: Response;
+  }> | SuccessResponse$1<({
+    data: SuccessResponse;
+    error: undefined;
+  } | {
+    data: undefined;
+    error: ConflictResponse | ForbiddenResponse | NotFoundResponse | TooManyRequestsResponse | BadRequestResponse | UnprocessableEntityResponse;
+  }) & {
+    request: Request;
+    response: Response;
+  }> | {
+    data: {
+      countryCode: any;
+    };
+  } | 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?: RefetchOptions) => Promise<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;
+};
+//#endregion
+//#region src/flows/Onboarding/components/SelectCountryStep.d.ts
+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): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/ReviewStep.d.ts
+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): import("react").ReactNode;
+//#endregion
+//#region src/flows/Onboarding/components/SaveDraftButton.d.ts
+type SaveDraftButtonProps = Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'onError'> & {
+  onSuccess?: () => void | Promise<void>;
+  onError?: ({ error, rawError, fieldErrors }: {
+    error: Error;
+    rawError: Record<string, unknown>;
+    fieldErrors: NormalizedFieldError[];
+  }) => void;
+};
+declare const SaveDraftButton: ({ onSuccess, onError, className, children, disabled, ...props }: SaveDraftButtonProps) => import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/EngagementAgreementDetailsStep.d.ts
+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): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/api.d.ts
+/**
+ * Get pre-onboarding requirements for an employment
+ */
+declare const useGetPreOnboardingRequirements: (employmentId: string, options?: {
+  queryOptions?: {
+    enabled?: boolean;
+  };
+}) => UseQueryResult<NoInfer<PreOnboardingRequirement[]>, Error>;
+//#endregion
+//#region src/flows/Onboarding/components/PreOnboardingRequirements.d.ts
+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;
+}) => import("react").ReactNode;
+//#endregion
+//#region src/flows/Onboarding/components/PreviewEmploymentAgreementStep.d.ts
+declare function PreviewEmploymentAgreementStep(): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/types.d.ts
+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;
+//#endregion
+export { CreditRiskStatus as a, OnboardingFlowProps as c, SelectCountrySuccess as d, PreOnboardingRequirementsBag as f, RefetchOptions as g, QueryObserverResult as h, CreditRiskState as i, OnboardingRenderProps as l, OnboardingInviteProps as m, BenefitsFormPayload as n, Employment as o, SelectCountryStep as p, ContractDetailsFormPayload as r, EngagementAgreementDetailsFormPayload as s, BasicInformationFormPayload as t, SelectCountryFormPayload as u };
+//# sourceMappingURL=types-DM3hjkjw.d.ts.map