@remoteoss/remote-flows 1.54.0 → 1.56.0

package/dist/types-DitVjS70.d.ts

@@ -1,498 +0,0 @@
-import { e as ContractorInvoiceSchedule, f as EmploymentCreationResponse, g as ContractorInvoiceScheduleResponse, S as SuccessResponse, h as EmploymentResponse, i as ContractorInvoiceScheduleCreateResponseFailure, j as ContractorInvoiceScheduleCreateResponseSuccess, E as Employment, k as Signatory, l as ContractorContractDocumentStatus, m as CompanyLegalEntity, _ as CreateContractDocumentResponse, $ as SignContractDocument } from './types.gen-CMDAS1NL.js';
-import { OnboardingBack } from './flows/ContractorOnboarding/components/OnboardingBack.js';
-import { OnboardingSubmit } from './flows/ContractorOnboarding/components/OnboardingSubmit.js';
-import * as react from 'react';
-import { C as Components, J as JSFFields, N as NestedMeta, a as JSFFieldset } from './remoteFlows-BlMarq2K.js';
-import { N as NormalizedFieldError } from './mutations-DU9Ens-k.js';
-import * as _tanstack_query_core from '@tanstack/query-core';
-import { Step } from './flows/useStepState.js';
-import { FieldValues } from 'react-hook-form';
-import { ValidationResult } from '@remoteoss/remote-json-schema-form-kit';
-import { StepKeys } from './flows/ContractorOnboarding/utils.js';
-import { BasicInformationStep } from './flows/ContractorOnboarding/components/BasicInformationStep.js';
-import { h as SelectCountryStep } from './types-DFnvapWX.js';
-import { FlowOptions, JSFModify } from './flows/types.js';
-import { OnboardingInvite } from './flows/ContractorOnboarding/components/OnboardingInvite.js';
-import { ContractReviewButton } from './flows/ContractorOnboarding/components/ContractReviewButton.js';
-import { ContractOriginStep } from './flows/ContractorOnboarding/components/ContractOriginStep.js';
-import { CreateInvoiceScheduleStep } from './flows/ContractorOnboarding/components/CreateInvoiceScheduleStep.js';
-import { ProductType } from './flows/ContractorOnboarding/constants.js';
-import { SaveDraftButton } from './flows/ContractorOnboarding/components/SaveDraftButton.js';
-import { SkipInvoiceScheduleButton } from './flows/ContractorOnboarding/components/SkipInvoiceScheduleButton.js';
-import { PreviewInvoiceButton } from './flows/ContractorOnboarding/components/PreviewInvoiceButton.js';
-import './types-DvsjrBmu.js';
-
-type PricingPlanStepProps = {
-    /**
-     * Components to override the default field components used in the form.
-     */
-    components?: Components;
-    onSubmit?: (payload: PricingPlanFormPayload) => void | Promise<void>;
-    onSuccess?: (data: PricingPlanResponse) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function PricingPlanStep({ components, onSubmit, onSuccess, onError, }: PricingPlanStepProps): react.JSX.Element;
-
-type useContractorOnboardingProps = Omit<ContractorOnboardingFlowProps, 'render' | 'options'> & {
-    options: ContractorOnboardingHookOptions;
-};
-declare const useContractorOnboarding: ({ countryCode, externalId, partnerExternalId, employmentId, skipSteps, options, initialValues: onboardingInitialValues, }: useContractorOnboardingProps) => {
-    /**
-     * Loading state indicating if the flow is loading data
-     */
-    isLoading: boolean;
-    /**
-     * 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;
-            contract_details: FieldValues;
-            select_country: FieldValues;
-            basic_information: FieldValues;
-            contract_preview: FieldValues;
-            contract_origin: FieldValues;
-            invoice_schedule: FieldValues;
-            create_invoice_schedule: FieldValues;
-            eligibility_questionnaire: FieldValues;
-            pricing_plan: FieldValues;
-        } | null;
-    };
-    /**
-     * Function to update the current form field values
-     * @param values - New form values to set
-     */
-    checkFieldUpdates: (values: FieldValues) => Promise<void>;
-    /**
-     * Function to mark the contract as reviewed
-     * @param values - New form values to check
-     * @returns {boolean}
-     */
-    markContractAsReviewed: () => void;
-    /**
-     * The existing invoice schedule for the current employment, if any.
-     */
-    existingInvoiceSchedule: NoInfer<ContractorInvoiceSchedule | undefined> | undefined;
-    /**
-     * Skips (cancels) the existing invoice schedule and returns to the
-     * invoice_schedule step.
-     * @returns {Promise<void>}
-     */
-    skipInvoiceSchedule: () => Promise<void>;
-    /**
-     * Whether a skip-invoice-schedule request is in flight.
-     */
-    isSkippingInvoiceSchedule: boolean;
-    /**
-     * Previews a contractor invoice as a draft PDF from the given (typically
-     * unsaved) form values, without persisting anything.
-     * @param values - Form values to build the preview from
-     * @returns {Promise<{name: string; content: string} | undefined>}
-     */
-    previewContractorInvoice: (values: FieldValues) => Promise<{
-        content: string;
-        name: string;
-    } | undefined>;
-    /**
-     * Whether a preview-contractor-invoice request is in flight.
-     */
-    isPreviewingInvoiceSchedule: boolean;
-    /**
-     * 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;
-    /**
-     * Function to handle form submission
-     * @param values - Form values to submit
-     * @returns Promise resolving to the mutation result
-     */
-    onSubmit: (values: FieldValues) => Promise<EmploymentCreationResponse | ContractorInvoiceScheduleResponse | SuccessResponse | EmploymentResponse | {
-        data: {
-            failures: Array<ContractorInvoiceScheduleCreateResponseFailure>;
-            successes: Array<ContractorInvoiceScheduleCreateResponseSuccess>;
-        };
-    } | {
-        data: {
-            countryCode: any;
-        };
-    } | {
-        data: {
-            contract_document: {
-                id: string | undefined;
-            };
-        };
-    } | {
-        data: {
-            subscription: any;
-        };
-    } | {
-        data: {
-            contractOrigin: any;
-            invoiceSchedulePreference?: undefined;
-        };
-    } | {
-        data: {
-            invoiceSchedulePreference: any;
-            contractOrigin?: undefined;
-        };
-    } | undefined>;
-    /**
-     * Array of form fields from the onboarding schema
-     */
-    fields: JSFFields;
-    /**
-     * Fields metadata for each step
-     */
-    meta: {
-        fields: {
-            select_country: NestedMeta;
-            basic_information: NestedMeta;
-            contract_origin: NestedMeta;
-            invoice_schedule: NestedMeta;
-            create_invoice_schedule: NestedMeta;
-            contract_details: NestedMeta;
-            contract_preview: NestedMeta;
-            pricing_plan: NestedMeta;
-            eligibility_questionnaire: NestedMeta;
-        };
-        fieldsets: JSFFieldset | null | undefined;
-        presentation: Record<string, unknown> | null | undefined;
-    };
-    /**
-     * Function to parse form values before submission
-     * @param values - Form values to parse
-     * @returns Parsed form values
-     */
-    parseFormValues: (values: FieldValues) => Promise<Record<string, any>>;
-    /**
-     * Indicates whether AI validation errors can be skipped (user can continue at their own risk).
-     * True when there's a skippable AI validation error on services_and_deliverables field.
-     * @returns {boolean}
-     */
-    canSkipAiValidation: boolean;
-    /**
-     * 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>;
-    /**
-     * Initial form values
-     */
-    initialValues: {
-        select_country: Record<string, unknown>;
-        basic_information: Record<string, unknown>;
-        contract_origin: Record<string, unknown>;
-        invoice_schedule: Record<string, unknown>;
-        create_invoice_schedule: Record<string, unknown>;
-        contract_details: Record<string, unknown>;
-        contract_preview: Record<string, unknown>;
-        pricing_plan: Record<string, unknown>;
-        eligibility_questionnaire: Record<string, unknown>;
-    };
-    /**
-     * Employment id
-     */
-    employmentId: string | undefined;
-    /**
-     * Function to refetch the employment data
-     * @returns {void}
-     */
-    refetchEmployment: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<(Employment & {
-        termination_date?: string | null;
-    }) | undefined, unknown>>;
-    /**
-     * Loading state indicating if the onboarding mutation is in progress
-     */
-    isSubmitting: boolean;
-    /**
-     * Document preview PDF data
-     */
-    documentPreviewPdf: NoInfer<{
-        contract_document: {
-            content: string;
-            name?: string | undefined;
-            signatories?: Signatory[] | undefined;
-            status?: ContractorContractDocumentStatus | undefined;
-        };
-    }> | undefined;
-    /**
-     * let's the user know if the company can invite employees
-     * @returns {boolean}
-     */
-    canInvite: boolean | undefined;
-    /**
-     * let's the user know that the employment cannot be edited, happens when employment.status is invited
-     * @returns {boolean}
-     */
-    isEmploymentReadOnly: boolean | undefined;
-    /**
-     * let's the user know if the employment is invited or not
-     * @returns {'invited' | 'not_invited'}
-     */
-    invitedStatus: "invited" | "not_invited";
-    /**
-     * Employment data
-     * @returns {Employment}
-     */
-    employment: (Employment & {
-        termination_date?: string | null;
-    }) | undefined;
-    /**
-     * Default legal entity
-     * @returns {CompanyLegalEntity}
-     */
-    defaultLegalEntity: CompanyLegalEntity | undefined;
-    /**
-     * Whether the company needs to complete KYB verification before contractors can be paid.
-     * Use this to show a company verification nudge banner on the review step.
-     */
-    needsCompanyVerification: boolean;
-    /**
-     * Whether the company needs to set up Remote Payments.
-     * Use this to show a Remote Payments setup nudge banner on the review step.
-     */
-    needsRemotePaymentsSetup: boolean;
-    /**
-     * Steps array
-     * @returns {Array<{name: string, index: number, visible: boolean, label: string}>}
-     */
-    steps: {
-        name: StepKeys;
-        index: number;
-        label: string;
-        visible: boolean;
-    }[];
-};
-
-type ContractDetailsStepProps = {
-    onSubmit?: (payload: ContractorOnboardingContractDetailsFormPayload) => void | Promise<void>;
-    onSuccess?: (data: ContractorOnboardingContractDetailsResponse) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function ContractDetailsStep({ onSubmit, onSuccess, onError, }: ContractDetailsStepProps): react.JSX.Element;
-
-type ContractPreviewStepProps = {
-    onSubmit?: (payload: ContractPreviewFormPayload) => void | Promise<void>;
-    onSuccess?: (data: ContractPreviewResponse) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function ContractPreviewStep({ onSubmit, onSuccess, onError, }: ContractPreviewStepProps): react.JSX.Element;
-
-type EligibilityQuestionnaireStepProps = {
-    onSubmit?: (payload: EligibilityQuestionnaireFormPayload) => void | Promise<void>;
-    onSuccess?: (data: EligibilityQuestionnaireResponse) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function EligibilityQuestionnaireStep({ onSubmit, onSuccess, onError, }: EligibilityQuestionnaireStepProps): react.JSX.Element;
-
-type InvoiceScheduleStepProps = {
-    /**
-     * Components to override the default field components used in the form.
-     */
-    components?: Components;
-    onSubmit?: (payload: InvoiceScheduleFormPayload) => void | Promise<void>;
-    onSuccess?: (data: InvoiceScheduleResponse) => void | Promise<void>;
-    onError?: ({ error, rawError, fieldErrors, }: {
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: NormalizedFieldError[];
-    }) => void;
-};
-declare function InvoiceScheduleStep({ components, onSubmit, onSuccess, onError, }: InvoiceScheduleStepProps): react.JSX.Element;
-
-type ContractorOnboardingRenderProps = {
-    /**
-     * The contractor onboarding bag returned by the useContractorOnboarding hook.
-     * This bag contains all the methods and properties needed to handle the contractor onboarding flow.
-     * @see {@link useContractorOnboarding}
-     */
-    contractorOnboardingBag: ReturnType<typeof useContractorOnboarding>;
-    /**
-     * The components used in the contractor onboarding flow.
-     * @see {@link BasicInformationStep}
-     * @see {@link SelectCountryStep}
-     * @see {@link OnboardingBack}
-     * @see {@link PricingPlanStep}
-     * @see {@link ContractDetailsStep}
-     * @see {@link ContractPreviewStep}
-     * @see {@link OnboardingSubmit}
-     * @see {@link OnboardingBack}
-     * @see {@link OnboardingInvite}
-     * @see {@link EligibilityQuestionnaireStep}
-     */
-    components: {
-        BasicInformationStep: typeof BasicInformationStep;
-        SelectCountryStep: typeof SelectCountryStep;
-        BackButton: typeof OnboardingBack;
-        SubmitButton: typeof OnboardingSubmit;
-        PricingPlanStep: typeof PricingPlanStep;
-        ContractOriginStep: typeof ContractOriginStep;
-        InvoiceScheduleStep: typeof InvoiceScheduleStep;
-        CreateInvoiceScheduleStep: typeof CreateInvoiceScheduleStep;
-        ContractDetailsStep: typeof ContractDetailsStep;
-        ContractPreviewStep: typeof ContractPreviewStep;
-        OnboardingInvite: typeof OnboardingInvite;
-        ContractReviewButton: typeof ContractReviewButton;
-        EligibilityQuestionnaireStep: typeof EligibilityQuestionnaireStep;
-        SaveDraftButton: typeof SaveDraftButton;
-        SkipInvoiceScheduleButton: typeof SkipInvoiceScheduleButton;
-        PreviewInvoiceButton: typeof PreviewInvoiceButton;
-    };
-};
-type ContractorOnboardingFeatures = 'create_invoice_schedule';
-type ContractorOnboardingFlowOptions = Omit<FlowOptions, 'jsfModify'> & {
-    /**
-     * Products to exclude from the available options in pricing_plan step.
-     * By default, all products are shown. Use this to hide specific products.
-     * @example excludeProducts: ['eor'] // Hide EOR option
-     * @example excludeProducts: ['eor', 'cor'] // Hide both EOR and COR
-     */
-    excludeProducts?: ProductType[];
-    /**
-     * Features to enable for the contractor onboarding flow.
-     * - 'create_invoice_schedule': Enable the invoice schedule step
-     */
-    features?: ContractorOnboardingFeatures[];
-    /**
-     * The JSON schema modification to use for the onboarding.
-     * This is used to modify the JSON schema for the onboarding.
-     * @see {@link JSFModify}
-     */
-    jsfModify?: {
-        select_country?: JSFModify;
-        basic_information?: JSFModify;
-        contract_details?: JSFModify;
-        contract_preview?: JSFModify;
-        eligibility_questionnaire?: JSFModify;
-        pricing_plan?: JSFModify;
-        contract_origin?: JSFModify;
-        invoice_schedule?: JSFModify;
-        create_invoice_schedule?: JSFModify;
-    };
-};
-type ContractorOnboardingFlowProps = {
-    /**
-     * The country code to use for the onboarding.
-     */
-    countryCode?: string;
-    /**
-     * The employment id to use for the onboarding.
-     */
-    employmentId?: 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;
-    /**
-     * The steps to skip for the onboarding.
-     */
-    skipSteps?: Array<'select_country' | 'contract_origin'>;
-    /**
-     * The render prop function with the params passed by the useContractorOnboarding hook and the components available to use for this flow
-     */
-    render: ({ contractorOnboardingBag, components, }: ContractorOnboardingRenderProps) => React.ReactNode;
-    /**
-     * The options for the contractor onboarding flow.
-     */
-    options?: ContractorOnboardingFlowOptions;
-    /**
-     * 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>;
-};
-type ContractorOnboardingHookOptions = ContractorOnboardingFlowOptions & {
-    /**
-     * Callback invoked when the contract review is completed.
-     * Use this to sync external form state if implementing custom forms.
-     */
-    onContractReviewed?: () => void;
-};
-type PricingPlanFormPayload = {
-    subscription: string;
-};
-type PricingPlanResponse = {
-    subscription: string;
-};
-type ContractorOnboardingContractDetailsFormPayload = {
-    services_and_deliverables: string;
-    service_duration: {
-        expiration_date?: string;
-        provisional_start_date: string;
-    };
-    termination: {
-        contractor_notice_period_amount: number;
-        company_notice_period_amount: number;
-    };
-    payment_terms: {
-        payment_terms_type: string;
-        invoicing_frequency: string;
-        compensation_gross_amount: string;
-        compensation_currency_code?: string;
-        period_unit: string;
-    };
-};
-type ContractorOnboardingContractDetailsResponse = CreateContractDocumentResponse;
-type AiValidationError = {
-    error: string[];
-    source: string;
-    skippable: boolean;
-};
-type ContractPreviewFormPayload = SignContractDocument;
-type ContractPreviewResponse = SuccessResponse;
-type EligibilityQuestionnaireFormPayload = {
-    control_the_way_contractors_work: 'no' | 'yes';
-    previously_hired_contractors_as_employees: 'no' | 'yes';
-    treating_contractors_as_employees: 'no' | 'yes';
-};
-type EligibilityQuestionnaireResponse = SuccessResponse;
-type InvoiceScheduleFormPayload = {
-    invoice_schedule_preference: string;
-};
-type InvoiceScheduleResponse = {
-    invoiceSchedulePreference: string;
-};
-
-export { type AiValidationError as A, type ContractorOnboardingFlowProps as C, type EligibilityQuestionnaireFormPayload as E, type InvoiceScheduleFormPayload as I, type PricingPlanFormPayload as P, type ContractorOnboardingContractDetailsFormPayload as a, type ContractorOnboardingRenderProps as b, type PricingPlanResponse as c, type ContractorOnboardingContractDetailsResponse as d, type ContractPreviewFormPayload as e, type ContractPreviewResponse as f, type EligibilityQuestionnaireResponse as g, type InvoiceScheduleResponse as h, PricingPlanStep as i, ContractDetailsStep as j, ContractPreviewStep as k, EligibilityQuestionnaireStep as l, InvoiceScheduleStep as m, type ContractorOnboardingHookOptions as n, useContractorOnboarding as u };

package/dist/types-KKMzDO4l.d.ts

@@ -1,128 +0,0 @@
-import { FlowOptions, JSONSchemaFormResultWithFieldsets, GPStepCallbacks } from './flows/types.js';
-import * as react from 'react';
-import { J as Step$1, K as SubStep, S as SuccessResponse, H as EmploymentDetailsOnlyResponse } from './types.gen-CMDAS1NL.js';
-import './remoteFlows-BlMarq2K.js';
-import * as _remoteoss_json_schema_form from '@remoteoss/json-schema-form';
-import { FieldValues } from 'react-hook-form';
-import { Step } from './flows/useStepState.js';
-import * as _remoteoss_json_schema_form_v0_deprecated from '@remoteoss/json-schema-form-v0-deprecated';
-import * as _tanstack_query_core from '@tanstack/query-core';
-
-type EmployeeStepKey = 'personal_details' | 'home_address' | 'bank_account' | 'federal_taxes' | 'state_taxes';
-declare const usePayrollEmployeeOnboarding: ({ employmentId, countryCode: countryCodeProp, jurisdiction: jurisdictionProp, initialValues, options, }: Omit<PayrollEmployeeOnboardingFlowProps, "render">) => {
-    stepState: {
-        currentStep: Step<EmployeeStepKey>;
-        totalSteps: number;
-        values: {
-            personal_details: FieldValues;
-            home_address: FieldValues;
-            bank_account: FieldValues;
-            federal_taxes: FieldValues;
-            state_taxes: FieldValues;
-        } | null;
-    };
-    isLoading: boolean;
-    isSubmitting: boolean;
-    isComplete: boolean;
-    employmentId: string;
-    countryCode: string | undefined;
-    jurisdiction: string | undefined;
-    initialValues: Record<string, unknown> | undefined;
-    options: Omit<FlowOptions, "jsfModify" | "jsonSchemaVersion"> | undefined;
-    apiSteps: NoInfer<Step$1[]> | undefined;
-    selfOnboardingSubsteps: SubStep[];
-    taxStepsAvailability: {
-        federal_taxes: {
-            isAvailable: boolean;
-            unavailableReason: TaxStepUnavailableReason | null;
-        };
-        state_taxes: {
-            isAvailable: boolean;
-            unavailableReason: TaxStepUnavailableReason | null;
-        };
-    };
-    refetchSteps: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<NoInfer<Step$1[]>, Error>>;
-    fields: _remoteoss_json_schema_form_v0_deprecated.Fields;
-    meta: JSONSchemaFormResultWithFieldsets["meta"];
-    fieldValues: FieldValues;
-    setFieldValues: react.Dispatch<react.SetStateAction<FieldValues>>;
-    handleValidation: (values: FieldValues) => Promise<_remoteoss_json_schema_form.ValidationResult | {
-        yupError: _remoteoss_json_schema_form_v0_deprecated.$TSFixMe;
-        formErrors: _remoteoss_json_schema_form_v0_deprecated.$TSFixMe;
-    } | null>;
-    parseFormValues: (values: FieldValues) => Promise<Record<string, unknown>>;
-    onSubmit: (values: FieldValues) => Promise<SuccessResponse | EmploymentDetailsOnlyResponse | undefined>;
-    next: () => void;
-    back: () => void;
-    goToStep: (step: EmployeeStepKey) => void;
-    setStepValues: (values: Record<EmployeeStepKey, FieldValues>) => void;
-};
-
-type StepComponentType = React.ComponentType<GPStepCallbacks>;
-/**
- * Reasons a tax step (federal or state) is unavailable to the employee right now.
- *
- * - `unsupported_country`: only USA employments expose the tax steps.
- * - `pending_enrollment`: the employment is not yet `active`, so the
- *   corresponding tax_task does not exist on the backend yet (PUT returns 404
- *   with `Tax task not found...`).
- * - `no_jurisdiction`: no `jurisdiction` was resolved — either not supplied
- *   as a prop, or not derivable from the employment's work/home address —
- *   and it's required for the state-taxes endpoint.
- * - `schema_unavailable`: the backend doesn't expose the form schema for this
- *   step (e.g. `GET /v1/countries/USA/global_payroll_state_taxes` returns 400
- *   or 404). Common on local/staging backends where a schema isn't seeded yet.
- */
-type TaxStepUnavailableReason = 'unsupported_country' | 'pending_enrollment' | 'no_jurisdiction' | 'schema_unavailable';
-type PayrollEmployeeOnboardingRenderProps = {
-    employeeBag: ReturnType<typeof usePayrollEmployeeOnboarding>;
-    components: {
-        PersonalDetailsStep: StepComponentType;
-        HomeAddressStep: StepComponentType;
-        /** Check employeeBag.selfOnboardingSubsteps for 'employee_provides_bank_details' before rendering. */
-        BankAccountStep: StepComponentType;
-        /**
-         * USA W-4 step. Returns null when `employeeBag.taxStepsAvailability.federal_taxes.isAvailable`
-         * is false — read the bag to render your own not-available UI.
-         */
-        FederalTaxesStep: StepComponentType;
-        /**
-         * USA state-taxes step for a single jurisdiction (`employeeBag.jurisdiction`,
-         * either the `jurisdiction` prop or derived from the employment). Returns
-         * null when `employeeBag.taxStepsAvailability.state_taxes.isAvailable` is false.
-         */
-        StateTaxesStep: StepComponentType;
-        SubmitButton: React.ComponentType<React.ButtonHTMLAttributes<HTMLButtonElement> & {
-            children?: React.ReactNode;
-        }>;
-        BackButton: React.ComponentType<React.ButtonHTMLAttributes<HTMLButtonElement> & {
-            children?: React.ReactNode;
-        }>;
-    };
-};
-type PayrollEmployeeOnboardingFlowProps = {
-    /** UUID of the employment, scoped to the employee token. */
-    employmentId: string;
-    /**
-     * ISO 3166-1 alpha-3 country code of the employment (e.g. 'USA'). Optional
-     * — when omitted, the flow derives it by calling `GET /v1/employments/:id`
-     * itself. Only supply this if your `auth` resolves to a direct
-     * employee-scoped token for the whole client (no per-request/per-path
-     * token routing): that token can't call `/v1/employments/:id` (401), so
-     * there'd be nothing to derive from.
-     */
-    countryCode?: string;
-    /**
-     * Optional US state code (e.g. 'CA', 'NY'), required for the state_taxes
-     * step to be rendered. When `countryCode` is also omitted, this is derived
-     * from the employment's work/home address. See `countryCode` above for
-     * when to supply it explicitly.
-     */
-    jurisdiction?: string;
-    /** Optional. Pre-populate form fields. */
-    initialValues?: Record<string, unknown>;
-    options?: Omit<FlowOptions, 'jsfModify' | 'jsonSchemaVersion'>;
-    render: (props: PayrollEmployeeOnboardingRenderProps) => React.ReactNode;
-};
-
-export { type EmployeeStepKey as E, type PayrollEmployeeOnboardingFlowProps as P, type TaxStepUnavailableReason as T, type PayrollEmployeeOnboardingRenderProps as a, usePayrollEmployeeOnboarding as u };

package/dist/types-Q5jEmNSC.d.ts

@@ -1,62 +0,0 @@
-import react__default from 'react';
-import * as react_hook_form from 'react-hook-form';
-import { Step } from './flows/useStepState.js';
-import { Fields } from '@remoteoss/remote-json-schema-form-kit';
-
-/**
- * Headless hook powering the standalone contract-document flow: the contract details and
- * contract preview screens of contractor onboarding, mountable on their own.
- */
-declare const useContractDocument: () => {
-    /**
-     * Current step state containing the current step and total number of steps.
-     */
-    stepState: {
-        currentStep: Step<ContractDocumentStepKeys>;
-        totalSteps: number;
-        values: {
-            contract_details: react_hook_form.FieldValues;
-            contract_preview: react_hook_form.FieldValues;
-        } | null;
-    };
-    /**
-     * Every step of the flow, in order.
-     */
-    steps: {
-        label: string;
-        index: number;
-        name: ContractDocumentStepKeys;
-        visible?: boolean;
-    }[];
-    /**
-     * Moves to the next step.
-     */
-    next: () => void;
-    /**
-     * Moves to the previous step.
-     */
-    back: () => void;
-    /**
-     * Moves to a specific step.
-     */
-    goTo: (step: ContractDocumentStepKeys) => void;
-    /**
-     * Form fields for the current step.
-     */
-    fields: Fields;
-    /**
-     * True while the flow is loading data.
-     */
-    isLoading: boolean;
-    /**
-     * True while a submission is in flight.
-     */
-    isSubmitting: boolean;
-};
-
-type ContractDocumentStepKeys = 'contract_details' | 'contract_preview';
-type ContractDocumentFlowProps = {
-    render: (contractDocumentBag: ReturnType<typeof useContractDocument>) => react__default.ReactNode;
-};
-
-export { type ContractDocumentStepKeys as C, type ContractDocumentFlowProps as a, useContractDocument as u };