@remoteoss/remote-flows 1.13.0 → 1.15.0

package/dist/types-Bs66Ma28.d.ts

@@ -0,0 +1,248 @@
+import { u as CompanyResponse, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, B as BadRequestResponse, a as UnauthorizedResponse } from './types.gen-Yvu8ksE5.js';
+import { F as FieldError, N as NormalizedFieldError } from './mutations-B8OzuyhA.js';
+import * as React$1 from 'react';
+import { FieldValues } from 'react-hook-form';
+import { J as JSFFields, M as Meta, a as JSFFieldset } from './remoteFlows-Bphgh2nl.js';
+import { ValidationResult } from '@remoteoss/remote-json-schema-form-kit';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+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$1.Dispatch<React$1.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_runtime.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_runtime.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 CreateCompanyFlowProps as C, type CreateCompanyRenderProps as a, type CompanyBasicInfoSuccess as b, type CompanyAddressDetailsSuccess as c, CompanyBasicInformationStep as d, type CompanyBasicInfoFormPayload as e, type CompanyAddressDetailsFormPayload as f, useCreateCompany as u };

package/dist/{types-A0hYlRII.d.ts → types-Ck-iVGL_.d.ts}

@@ -1,6 +1,6 @@
-import { O as OffboardingResponse, a6 as PayrollCalendarEor, E as Employment, y as TerminationDetailsParams, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, B as BadRequestResponse, a as UnauthorizedResponse, R as RequestError } from './types.gen-BGBO30Fw.js';
+import { O as OffboardingResponse, ac as PayrollCalendarEor, E as Employment, I as TerminationDetailsParams, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, B as BadRequestResponse, a as UnauthorizedResponse, R as RequestError } from './types.gen-Yvu8ksE5.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { E as ErrorResponse, S as SuccessResponse } from './mutations-DD5sJUOe.js';
+import { E as ErrorResponse, S as SuccessResponse } from './mutations-B8OzuyhA.js';
 import * as React$1 from 'react';
 import * as _remoteoss_json_schema_form from '@remoteoss/json-schema-form';
 import * as _remoteoss_json_schema_form_v0_deprecated from '@remoteoss/json-schema-form-v0-deprecated';

package/dist/{types-CUjmrc0L.d.ts → types-Dcg5CIEH.d.ts}

@@ -1,10 +1,10 @@
-import { d as EmploymentCreationResponse, e as EmploymentResponse, S as SuccessResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, r as ConflictResponse, B as BadRequestResponse, F as ForbiddenResponse, N as NotFoundResponse, a as UnauthorizedResponse, E as Employment$1, s as EmploymentCreateParams } from './types.gen-BGBO30Fw.js';
+import { l as EmploymentCreationResponse, m as EmploymentResponse, S as SuccessResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, x as ConflictResponse, B as BadRequestResponse, F as ForbiddenResponse, N as NotFoundResponse, a as UnauthorizedResponse, E as Employment$1, y as EmploymentCreateParams } from './types.gen-Yvu8ksE5.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 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-DD5sJUOe.js';
+import { N as NormalizedFieldError, S as SuccessResponse$1, E as ErrorResponse } from './mutations-B8OzuyhA.js';
 import { OnboardingSubmit } from './flows/Onboarding/components/OnboardingSubmit.js';
-import { C as Components, J as JSFFields, M as Meta, a as JSFFieldset } from './remoteFlows-XefHitC9.js';
+import { C as Components, J as JSFFields, M as Meta, a as JSFFieldset } from './remoteFlows-Bphgh2nl.js';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import * as React$1 from 'react';
 import { ValidationResult } from '@remoteoss/remote-json-schema-form-kit';

package/dist/{types-PBjnmC_s.d.ts → types-Dr-apmY1.d.ts}

@@ -1,9 +1,9 @@
-import { d as EmploymentCreationResponse, S as SuccessResponse, e as EmploymentResponse, f as CreateContractDocumentResponse, E as Employment, g as Signatory, h as CompanyLegalEntity, D as SignContractDocument } from './types.gen-BGBO30Fw.js';
+import { l as EmploymentCreationResponse, S as SuccessResponse, m as EmploymentResponse, n as CreateContractDocumentResponse, o as EligibilityQuestionnaire, E as Employment, p as Signatory, q as CompanyLegalEntity, L as SignContractDocument } from './types.gen-Yvu8ksE5.js';
 import { OnboardingBack } from './flows/ContractorOnboarding/components/OnboardingBack.js';
 import { OnboardingSubmit } from './flows/ContractorOnboarding/components/OnboardingSubmit.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as Components, J as JSFFields, M as Meta, a as JSFFieldset, $ as $TSFixMe } from './remoteFlows-XefHitC9.js';
-import { N as NormalizedFieldError } from './mutations-DD5sJUOe.js';
+import { C as Components, J as JSFFields, M as Meta, a as JSFFieldset, $ as $TSFixMe } from './remoteFlows-Bphgh2nl.js';
+import { N as NormalizedFieldError } from './mutations-B8OzuyhA.js';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import * as React$1 from 'react';
 import { Step } from './flows/useStepState.js';
@@ -11,10 +11,12 @@ 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 { g as SelectCountryStep } from './types-CUjmrc0L.js';
+import { g as SelectCountryStep } from './types-Dcg5CIEH.js';
 import { FlowOptions, JSFModify } from './flows/types.js';
 import { OnboardingInvite } from './flows/Onboarding/components/OnboardingInvite.js';
 import { ContractReviewButton } from './flows/ContractorOnboarding/components/ContractReviewButton.js';
+import { ChooseAlternativePlanStep } from './flows/ContractorOnboarding/components/ChooseAlternativePlanStep.js';
+import { ProductType } from './flows/ContractorOnboarding/constants.js';
 
 type PricingPlanStepProps = {
     /**
@@ -53,6 +55,7 @@ declare const useContractorOnboarding: ({ countryCode, externalId, employmentId,
             select_country: FieldValues;
             basic_information: FieldValues;
             eligibility_questionnaire: FieldValues;
+            choose_alternative_plan: FieldValues;
             contract_preview: FieldValues;
             pricing_plan: FieldValues;
         } | null;
@@ -92,9 +95,8 @@ declare const useContractorOnboarding: ({ countryCode, externalId, employmentId,
             subscription: any;
         };
     } | {
-        data: {
-            eligibility_questionnaire: FieldValues;
-        };
+        _skipNextStep: boolean;
+        data: EligibilityQuestionnaire;
     } | undefined>;
     /**
      * Array of form fields from the onboarding schema
@@ -111,6 +113,7 @@ declare const useContractorOnboarding: ({ countryCode, externalId, employmentId,
             contract_preview: Meta;
             pricing_plan: Meta;
             eligibility_questionnaire: Meta;
+            choose_alternative_plan: Meta;
         };
         fieldsets: JSFFieldset | null | undefined;
     };
@@ -197,6 +200,7 @@ declare const useContractorOnboarding: ({ countryCode, externalId, employmentId,
         name: StepKeys;
         index: number;
         label: string;
+        visible: boolean;
     }[];
 };
 
@@ -264,6 +268,7 @@ type ContractorOnboardingRenderProps = {
         OnboardingInvite: typeof OnboardingInvite;
         ContractReviewButton: typeof ContractReviewButton;
         EligibilityQuestionnaireStep: typeof EligibilityQuestionnaireStep;
+        ChooseAlternativePlanStep: typeof ChooseAlternativePlanStep;
     };
 };
 type ContractorOnboardingFlowProps = {
@@ -292,12 +297,20 @@ type ContractorOnboardingFlowProps = {
      * The options for the contractor onboarding flow.
      */
     options?: Omit<FlowOptions, 'jsfModify'> & {
+        /**
+         * Products to exclude from the available options in pricing_plan and choose_alternative_plan steps.
+         * 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[];
         jsfModify?: {
             select_country?: JSFModify;
             basic_information?: JSFModify;
             contract_details?: JSFModify;
             contract_preview?: JSFModify;
             eligibility_questionnaire?: JSFModify;
+            choose_alternative_plan?: JSFModify;
             pricing_plan?: JSFModify;
         };
     };
@@ -338,4 +351,4 @@ type EligibilityQuestionnaireFormPayload = {
 };
 type EligibilityQuestionnaireResponse = SuccessResponse;
 
-export { type ContractorOnboardingFlowProps as C, type EligibilityQuestionnaireFormPayload as E, type PricingPlanFormPayload as P, type ContractorOnboardingRenderProps as a, type PricingPlanResponse as b, type ContractorOnboardingContractDetailsFormPayload as c, type ContractorOnboardingContractDetailsResponse as d, type ContractPreviewFormPayload as e, type ContractPreviewResponse as f, type EligibilityQuestionnaireResponse as g, PricingPlanStep as h, ContractDetailsStep as i, ContractPreviewStep as j, EligibilityQuestionnaireStep as k, useContractorOnboarding as u };
+export { type ContractorOnboardingFlowProps as C, type EligibilityQuestionnaireFormPayload as E, 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, PricingPlanStep as h, ContractDetailsStep as i, ContractPreviewStep as j, EligibilityQuestionnaireStep as k, useContractorOnboarding as u };

package/dist/{types-CVZaJm8w.d.ts → types-Jy-_3Y7m.d.ts}

@@ -1,4 +1,4 @@
-import { Y as ListTimeoffResponse, Z as TimeoffStatus, _ as TimeoffType, $ as ListLeavePoliciesSummaryResponse, E as Employment } from './types.gen-BGBO30Fw.js';
+import { a2 as ListTimeoffResponse, a3 as TimeoffStatus, a4 as TimeoffType, a5 as ListLeavePoliciesSummaryResponse, E as Employment } from './types.gen-Yvu8ksE5.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
 import * as _tanstack_query_core from '@tanstack/query-core';