@remoteoss/remote-flows 1.55.0 → 1.56.0

package/dist/types-CASxD27i.d.ts

@@ -1,120 +0,0 @@
-import { W as ListLeavePoliciesSummaryResponse, X as ListTimeoffResponse, Y as TimeoffStatus, Z as TimeoffType, E as Employment } from './types.gen-ClcXnZQX.js';
-import * as _tanstack_react_query from '@tanstack/react-query';
-import { UseQueryResult } from '@tanstack/react-query';
-import { BookedTimeoffBeforeDateResponse, SummaryTimeOffDataResponse } from './flows/Termination/api.js';
-
-/**
- * Hook to retrieve time off data for a specific employment.
- *
- * @param {Object} params - The parameters for the query.
- * @param {string} [params.employmentId] - The ID of the employment to fetch time off data for.
- * @param {TimeoffStatus} [params.status] - The status of the time off requests to filter by (e.g., 'approved', 'pending').
- * @returns {UseQueryResult<any, unknown>} - The result of the query, including the time off data.
- *
- */
-declare const useTimeOffQuery: <TData = ListTimeoffResponse>({ employmentId, status, timeoffType, options, }: {
-    employmentId?: string;
-    status?: TimeoffStatus;
-    timeoffType?: TimeoffType;
-    options?: {
-        enabled?: boolean;
-        select?: (data: ListTimeoffResponse | undefined) => TData;
-    };
-}) => _tanstack_react_query.UseQueryResult<NoInfer<TData>, Error>;
-type PaidTimeoffBreakdownResponse = {
-    bookedDays: number;
-    timeoffs: {
-        status: string;
-        duration: number;
-        startDate: string;
-        endDate: string;
-        formattedDate: string;
-    }[];
-};
-/**
- * Hook to retrieve paid time off breakdown for a specific employment.
- *
- * @param {Object} params - The parameters for the query.
- * @param {string} [params.employmentId] - The ID of the employment to fetch paid time off breakdown for.
- * @returns {UseQueryResult<any, unknown>} - The result of the query, including the paid time off breakdown.
- *
- */
-declare const usePaidTimeoffBreakdownQuery: ({ employmentId, options, }: {
-    employmentId?: string;
-    options?: {
-        enabled?: boolean;
-    };
-}) => _tanstack_react_query.UseQueryResult<NoInfer<PaidTimeoffBreakdownResponse>, Error>;
-/**
- * Hook to retrieve time off balance for a specific employment.
- *
- * @param {Object} params - The parameters for the query.
- * @param {string} [params.employmentId] - The ID of the employment to fetch time off balance for.
- * @returns {UseQueryResult<any, unknown>} - The result of the query, including the time off balance.
- *
- */
-declare const useTimeOffLeavePoliciesSummaryQuery: ({ employmentId, }: {
-    employmentId?: string;
-}) => _tanstack_react_query.UseQueryResult<NoInfer<ListLeavePoliciesSummaryResponse | undefined>, Error>;
-
-type PaidTimeOffRenderProps = {
-    /**
-     * The query result for the leave policies summary.
-     * @see {@link useTimeOffLeavePoliciesSummaryQuery}
-     */
-    leavePoliciesSummaryQuery: UseQueryResult<ListLeavePoliciesSummaryResponse | undefined, Error>;
-    /**
-     * The formatted proposed termination date.
-     */
-    formattedProposedTerminationDate: string;
-    /**
-     * The name of the employee.
-     */
-    employeeName: string;
-    /**
-     * The proposed termination date.
-     */
-    proposedTerminationDate: string;
-    /**
-     * The function to open the details drawer.
-     */
-    onOpenChange: () => void;
-    /**
-     * Whether the details drawer is open.
-     */
-    open: boolean;
-    /**
-     * The query result for the paid time off breakdown.
-     * @see {@link usePaidTimeoffBreakdownQuery}
-     */
-    timeoffQuery: UseQueryResult<PaidTimeoffBreakdownResponse | undefined, Error>;
-    /**
-     * The query result for the booked time off before and after termination.
-     * @see {@link useBookedTimeoffBeforeAndAfterTerminationQuery}
-     */
-    bookedTimeBeforeAndAfterTerminationQuery: UseQueryResult<BookedTimeoffBeforeDateResponse | undefined, Error>;
-    /**
-     * The summary data for the paid time off.
-     * @see {@link useSummaryTimeOffDataQuery}
-     */
-    summaryData: {
-        data: SummaryTimeOffDataResponse;
-        isLoading: boolean;
-        isError: boolean;
-        error: Error | null;
-    };
-    /**
-     * The employment data.
-     * @see {@link Employment}
-     */
-    employment?: Employment;
-};
-type PaidTimeOffContainerProps = {
-    employment?: Employment;
-    employmentId: string;
-    proposedTerminationDate: string;
-    employeeName: string;
-    render: (props: PaidTimeOffRenderProps) => React.ReactNode;
-};
-
-export { type PaidTimeOffRenderProps as P, type PaidTimeOffContainerProps as a, useTimeOffLeavePoliciesSummaryQuery as b, useTimeOffQuery as c, usePaidTimeoffBreakdownQuery as u };

package/dist/types-Cgl9btOl.d.ts

@@ -1,247 +0,0 @@
-import { z as CompanyResponse, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, B as BadRequestResponse, a as UnauthorizedResponse } from './types.gen-ClcXnZQX.js';
-import { F as FieldError, N as NormalizedFieldError } from './mutations-CP-6Q1qD.js';
-import * as react from 'react';
-import { FieldValues } from 'react-hook-form';
-import { J as JSFFields, M as Meta, b as JSFFieldset } from './remoteFlows-XC0Ss0fy.js';
-import { ValidationResult } from '@remoteoss/remote-json-schema-form-kit';
-import { FlowOptions, JSFModify } from './flows/types.js';
-import { CreateCompanySubmit } from './flows/CreateCompany/components/CreateCompanySubmit.js';
-import { STEPS } from './flows/CreateCompany/utils.js';
-import { Step } from './flows/useStepState.js';
-
-type useCreateCompanyProps = Omit<CreateCompanyFlowProps, 'render'>;
-/**
- * Main hook for the CreateCompany flow
- * Manages the two-step flow: company creation and address details
- * @param countryCode - Optional initial country code
- * @param options - Flow options including jsfModify and jsonSchemaVersion
- * @returns CreateCompany bag with all flow state and methods
- */
-declare const useCreateCompany: ({ countryCode, options, initialValues: createCompanyInitialValues, }: useCreateCompanyProps) => {
-    /**
-     * Loading state indicating if the flow is loading data
-     */
-    isLoading: boolean;
-    /**
-     * Loading state indicating if the company creation or update mutation is in progress
-     */
-    isSubmitting: 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<"address_details" | "company_basic_information">;
-        totalSteps: number;
-        values: {
-            address_details: FieldValues;
-            company_basic_information: FieldValues;
-        } | null;
-    };
-    /**
-     * Function to update the current form field values
-     * @param values - New form values to set
-     */
-    checkFieldUpdates: react.Dispatch<react.SetStateAction<FieldValues>>;
-    /**
-     * 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: keyof typeof STEPS) => void;
-    /**
-     * 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;
-            companyOwnerEmail: any;
-            companyOwnerName: any;
-            desiredCurrency: any;
-            name: any;
-            phoneNumber: any;
-            taxNumber: any;
-        };
-    } | {
-        data: null;
-        error: Error;
-        rawError: Record<string, unknown>;
-        fieldErrors: FieldError[];
-    } | {
-        data: ({
-            data: CompanyResponse;
-            error: undefined;
-        } | {
-            data: undefined;
-            error: NotFoundResponse | UnprocessableEntityResponse | TooManyRequestsResponse | BadRequestResponse | UnauthorizedResponse;
-        }) & {
-            request: Request;
-            response: Response;
-        };
-    }>;
-    /**
-     * Array of form fields from the onboarding schema
-     */
-    fields: JSFFields;
-    /**
-     * Fields metadata for each step
-     */
-    meta: {
-        fields: {
-            company_basic_information: Meta;
-            address_details: Meta;
-        };
-        fieldsets: JSFFieldset | 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>>;
-    /**
-     * 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: {
-        company_basic_information: Record<string, unknown>;
-        address_details: Record<string, unknown>;
-    };
-};
-
-type CompanyBasicInformationStepProps = {
-    /**
-     * The function is called when the form is submitted. It receives the form values as an argument.
-     */
-    onSubmit?: (payload: CompanyBasicInfoFormPayload) => void | Promise<void>;
-    /**
-     * The function is called when the form submission is successful.
-     */
-    onSuccess?: (data: CompanyBasicInfoSuccess) => 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;
-};
-/**
- * CompanyBasicInformationStep component for the first step of company creation
- * Handles company basic information form submission
- */
-declare function CompanyBasicInformationStep({ onSubmit, onSuccess, onError, }: CompanyBasicInformationStepProps): react.JSX.Element;
-
-type AddressDetailsStepProps = {
-    /**
-     * The function is called when the form is submitted. It receives the form values as an argument.
-     */
-    onSubmit?: (payload: CompanyAddressDetailsFormPayload) => void | Promise<void>;
-    /**
-     * The function is called when the form submission is successful.
-     */
-    onSuccess?: (data: CompanyAddressDetailsSuccess) => 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;
-};
-/**
- * AddressDetailsStep component for the second step of company creation
- * Handles address details form submission and company update
- */
-declare function AddressDetailsStep({ onSubmit, onSuccess, onError, }: AddressDetailsStepProps): react.JSX.Element;
-
-type CountryFormFields = {
-    countryCode: string;
-    companyOwnerEmail: string;
-    companyOwnerName: string;
-    desiredCurrency: string;
-    name: string;
-    phoneNumber: string;
-    taxNumber: string;
-};
-type CompanyBasicInfoFormPayload = CountryFormFields;
-type CompanyBasicInfoSuccess = CountryFormFields;
-type CompanyAddressDetailsFormPayload = Record<string, unknown>;
-type CompanyAddressDetailsSuccess = Record<string, unknown>;
-type CreateCompanyRenderProps = {
-    /**
-     * The create company bag returned by the useCreateCompany hook.
-     * This bag contains all the methods and properties needed to handle the create company flow.
-     * @see {@link useCreateCompany}
-     */
-    createCompanyBag: ReturnType<typeof useCreateCompany>;
-    /**
-     * The components used in the create company flow.
-     * @see {@link CompanyBasicInformationStep}
-     * @see {@link AddressDetailsStep}
-     */
-    components: {
-        CompanyBasicInformationStep: typeof CompanyBasicInformationStep;
-        AddressDetailsStep: typeof AddressDetailsStep;
-        SubmitButton: typeof CreateCompanySubmit;
-    };
-};
-type CreateCompanyFlowProps = {
-    /**
-     * The country code to use for the onboarding.
-     */
-    countryCode?: string;
-    /**
-     * The render prop function with the params passed by the useCreateCompany hook and the components available to use for this flow
-     */
-    render: ({ createCompanyBag, components, }: CreateCompanyRenderProps) => React.ReactNode;
-    /**
-     * The options for the create company flow.
-     */
-    options?: Omit<FlowOptions, 'jsfModify'> & {
-        jsfModify?: {
-            company_basic_information?: JSFModify;
-            address_details?: JSFModify;
-        };
-    };
-    /**
-     * 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 BasicInformationFormPayload = {
-    company_owner_email: string;
-    company_owner_name: string;
-    country_code: string;
-    desired_currency: string;
-    name: string;
-    phone_number: string;
-    tax_number: string;
-    tax_servicing_countries: string[];
-};
-
-export { AddressDetailsStep as A, type BasicInformationFormPayload as B, type CompanyAddressDetailsSuccess as C, type CompanyBasicInfoSuccess as a, type CreateCompanyFlowProps as b, type CreateCompanyRenderProps as c, CompanyBasicInformationStep as d, type CompanyAddressDetailsFormPayload as e, type CompanyBasicInfoFormPayload as f, useCreateCompany as u };

package/dist/types-DUb6Xtze.d.ts

@@ -1,128 +0,0 @@
-import { FlowOptions, JSONSchemaFormResultWithFieldsets, GPStepCallbacks } from './flows/types.js';
-import * as react from 'react';
-import { K as Step$1, L as SubStep, S as SuccessResponse, I as EmploymentDetailsOnlyResponse } from './types.gen-ClcXnZQX.js';
-import './remoteFlows-XC0Ss0fy.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 };