@remoteoss/remote-flows 1.55.0 → 1.56.0

package/dist/index-Bfp0Dih3.d.ts

@@ -0,0 +1,416 @@
+import { l as Meta } from "./remoteFlows-DzjJtmiU.js";
+import { H as MinimalRegion, M as EmploymentTermType, S as CostCalculatorEstimateResponse, U as NotFoundResponse, V as MinimalCountry, b as CostCalculatorEstimateParams, ct as ValidationError$1, q as PostV1CostCalculatorEstimationError, st as UnprocessableEntityResponse, v as CostCalculatorEmployment, x as CostCalculatorEstimatePdfResponse, y as CostCalculatorEstimateCsvResponse } from "./index-DZOv3Kqg.js";
+import { i as SuccessResponse, r as NormalizedFieldError, t as ErrorResponse } from "./mutations-BtF_JHC1.js";
+import { r as JSFModify } from "./types-PZPLLCvV.js";
+import React$1, { ButtonHTMLAttributes, PropsWithChildren } from "react";
+import { ValidationError } from "yup";
+//#region src/flows/CostCalculator/constants.d.ts
+declare const BASE_RATES: {
+  AUD: number;
+  CAD: number;
+  CHF: number;
+  DKK: number;
+  EUR: number;
+  GBP: number;
+  JPY: number;
+  NOK: number;
+  NZD: number;
+  SEK: number;
+  SGD: number;
+  USD: number;
+};
+//#endregion
+//#region src/flows/CostCalculator/types.d.ts
+type CostCalculatorEstimationSubmitValues = {
+  currency: string;
+  currency_code: string;
+  country: string;
+  salary_converted: 'salary' | 'salary_conversion';
+  hiring_budget: string;
+  salary: number;
+} & Partial<{
+  region: string;
+  age: number;
+  contract_duration_type: EmploymentTermType;
+  benefits: Record<string, string>;
+  management: {
+    management_fee: string;
+  };
+  estimation_title: string;
+}>;
+type CostCalculatorEstimationFormValues = {
+  currency: string;
+  currency_code: string;
+  country: string;
+  salary: string;
+  salary_converted: 'salary' | 'salary_conversion';
+  salary_conversion: string;
+} & Partial<{
+  region: string;
+  age: number;
+  hiring_budget: string;
+  contract_duration_type: EmploymentTermType;
+  benefits: Record<string, string>;
+  management: {
+    management_fee: string;
+  };
+  estimation_title: string;
+}>;
+type CostCalculatorEstimationOptions = Partial<{
+  /**
+   * Title of the estimation. Default is 'Estimation'.
+   */
+  title: string;
+  /**
+   * Include benefits in the estimation. Default is false.
+   */
+  includeBenefits: boolean;
+  /**
+   * Include cost breakdowns in the estimation. Default is false.
+   */
+  includeCostBreakdowns: boolean;
+  /**
+   * Include premium benefits in the estimation. Default is false.
+   */
+  includePremiumBenefits: boolean;
+  /**
+   * Enable currency conversion. Default is false.
+   */
+  enableCurrencyConversion: boolean;
+  /**
+   * Include management fee in the estimation. Default is false.
+   */
+  includeManagementFee: boolean;
+  /**
+   * Include estimation title field in the estimation. Default is false.
+   */
+  includeEstimationTitle: boolean;
+  /**
+   * Management fees by currency. Default is null.
+   */
+  managementFees: Partial<Record<CurrencyKey, number>>;
+  /**
+   * Show management fee field in the estimation. Default is false.
+   */
+  showManagementFee: boolean;
+}>;
+type EstimationError = PostV1CostCalculatorEstimationError | ValidationError$1;
+type CostCalculatorFeatures = 'split_salary_description';
+type UseCostCalculatorOptions = {
+  jsfModify?: JSFModify;
+  onCurrencyChange?: (currency: string) => void;
+  onValidation?: (values: CostCalculatorEstimationFormValues) => void;
+  /**
+   * The features to enable for the cost calculator.
+   * - 'split_salary_description': Hand the 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?: CostCalculatorFeatures[];
+};
+type CurrencyKey = keyof typeof BASE_RATES;
+type CostCalculatorEstimation = CostCalculatorEmployment & {
+  title?: string;
+};
+type CostCalculatorEstimationResponse = {
+  data: {
+    employments?: Array<CostCalculatorEstimation>;
+  };
+};
+//#endregion
+//#region src/flows/CostCalculator/hooks.d.ts
+type CostCalculatorVersion = 'standard' | 'marketing';
+type UseCostCalculatorParams = {
+  /**
+   * The default region slug to preselect a country and a region.
+   */
+  defaultRegion?: string;
+  /**
+   * The default currency slug to preselect a currency.
+   */
+  defaultCurrency?: string;
+  /**
+   * The default salary to preselect a salary.
+   */
+  defaultSalary?: string;
+  /**
+   * The estimation options.
+   */
+  estimationOptions: CostCalculatorEstimationOptions;
+  options?: UseCostCalculatorOptions;
+  version?: CostCalculatorVersion;
+};
+/**
+ * Hook to use the cost calculator.
+ */
+declare const useCostCalculator: ({ defaultRegion, defaultCurrency, defaultSalary, estimationOptions, options, version }?: UseCostCalculatorParams) => {
+  /**
+   * Current step state containing the current step and total number of steps
+   */
+  stepState: {
+    current: number;
+    total: number;
+    isLastStep: boolean;
+  };
+  /**
+   * Array of form fields from the cost calculator schema + dynamic region fields like benefits, age, etc.
+   */
+  fields: Record<string, unknown>[];
+  /**
+   * Validation schema for the cost calculator form
+   */
+  validationSchema: import("yup").AnyObjectSchema;
+  /**
+   * Function to parse form values before submission
+   * @param values - Form values to parse
+   * @returns Parsed form values
+   */
+  parseFormValues: (values: CostCalculatorEstimationFormValues) => Promise<CostCalculatorEstimationSubmitValues>;
+  /**
+   * Function to handle validation of the cost calculator form
+   * @param values - Form values to validate
+   * @returns Validation result
+   */
+  handleValidation: (values: CostCalculatorEstimationFormValues) => Promise<{
+    formErrors: any;
+    yupError: ValidationError;
+  }>;
+  /**
+   * Whether the cost calculator form is currently being submitted
+   */
+  isSubmitting: boolean;
+  /**
+   * Whether the cost calculator form is currently loading
+   */
+  isLoading: boolean;
+  /**
+   * Function to submit the cost calculator form
+   */
+  onSubmit: (values: CostCalculatorEstimationSubmitValues) => Promise<ErrorResponse<Error> | SuccessResponse<({
+    data: CostCalculatorEstimateResponse;
+    error: undefined;
+  } | {
+    data: undefined;
+    error: NotFoundResponse | UnprocessableEntityResponse;
+  }) & {
+    request: Request;
+    response: Response;
+  }>>;
+  /**
+   * Function to reset the cost calculator form
+   */
+  resetForm: () => void;
+  /**
+   * Currencies data useful to get the currency if you have a currencySlug
+   */
+  currencies: NoInfer<{
+    value: string;
+    label: string;
+  }[] | undefined> | undefined;
+  /**
+   * Fields metadata
+   */
+  meta: {
+    fields: Meta;
+  };
+};
+//#endregion
+//#region src/flows/CostCalculator/CostCalculatorFlow.d.ts
+type CostCalculatorFlowProps = {
+  /**
+   * Estimation params allows you to customize the parameters sent to the /cost-calculator/estimation endpoint.
+   */
+  estimationOptions?: CostCalculatorEstimationOptions;
+  /**
+   * Default values for the form fields.
+   */
+  defaultValues?: Partial<{
+    /**
+     * Default value for the country field.
+     */
+    countryRegionSlug: string;
+    /**
+     * Default value for the currency field.
+     */
+    currencySlug: string;
+    /**
+     * Default value for the salary field.
+     */
+    salary: string;
+    /**
+     * Default value for the benefits field.
+     */
+    benefits: Record<string, string>;
+    /**
+     * Default value for the hiring budget field
+     */
+    hiringBudget: string;
+    /**
+     * Default value for the age field.
+     */
+    age: number;
+    /**
+     * Default value for the contract duration type field.
+     */
+    contractDurationType: 'fixed' | 'indefinite';
+    /**
+     * Default value for the management fee field.
+     */
+    management: {
+      management_fee: string;
+    };
+    /**
+     * Default value for the region field.
+     */
+    regionSlug: string;
+  } & Record<string, unknown>>;
+  options?: UseCostCalculatorOptions;
+  render: (costCalculatorBag: ReturnType<typeof useCostCalculator>) => React$1.ReactNode;
+  /**
+   * Whether to include annual_gross_salary in the estimation payload
+   */
+  version?: CostCalculatorVersion;
+};
+declare const CostCalculatorFlow: ({ estimationOptions, defaultValues, options, render, version }: CostCalculatorFlowProps) => React$1.JSX.Element;
+//#endregion
+//#region src/flows/CostCalculator/CostCalculatorForm.d.ts
+type CostCalculatorFormProps = Partial<{
+  /**
+   * Callback function that handles form submission. When form is submit, the form values are sent to the consumer app before behind submitted to Remote.
+   * @param data - The payload sent to the /cost-calculator/estimation endpoint.
+   */
+  onSubmit: (data: CostCalculatorEstimationSubmitValues) => Promise<void> | void;
+  /**
+   * Callback function to handle the success when the estimation succeeds. The CostCalculatorEstimateResponse is sent back to you.
+   * @param data - The response data from the /cost-calculator/estimation endpoint.
+   */
+  onSuccess: (data: CostCalculatorEstimationResponse) => Promise<void> | void;
+  /**
+   * Callback function to handle the error when the estimation fails.
+   * @param error - The error object.
+   */
+  onError: (error: EstimationError) => void;
+  /**
+   * Enhanced callback function to handle errors with field-level details.
+   * @param error - The error object with field errors.
+   */
+  onErrorWithFields?: ({ error, fieldErrors }: {
+    error: Error;
+    fieldErrors: NormalizedFieldError[];
+    rawError: Record<string, unknown>;
+  }) => void;
+  /**
+   * Whether to reset the form when the form is successfully submitted.
+   */
+  shouldResetForm?: boolean;
+  /**
+   * Fields to reset when the form is successfully submitted.
+   */
+  resetFields?: ('country' | 'currency' | 'salary')[];
+}>;
+declare function CostCalculatorForm({ onSubmit, onError, onSuccess, onErrorWithFields, shouldResetForm, resetFields }: CostCalculatorFormProps): import("react").JSX.Element;
+//#endregion
+//#region src/flows/CostCalculator/CostCalculatorSubmitButton.d.ts
+declare function CostCalculatorSubmitButton({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement>> & Record<string, unknown>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/CostCalculator/CostCalculatorResetButton.d.ts
+declare function CostCalculatorResetButton({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement>> & Record<string, unknown>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/CostCalculator/api.d.ts
+/**
+ * Custom hook to create a PDF estimation.
+ *
+ * @returns
+ */
+declare const useCostCalculatorEstimationPdf: () => import("@tanstack/react-query").UseMutationResult<({
+  data: CostCalculatorEstimatePdfResponse;
+  error: undefined;
+} | {
+  data: undefined;
+  error: NotFoundResponse | UnprocessableEntityResponse;
+}) & {
+  request: Request;
+  response: Response;
+}, Error, CostCalculatorEstimateParams, unknown>;
+/**
+ * Custom hook to create a CSV estimation.
+ *
+ * @returns
+ */
+declare const useCostCalculatorEstimationCsv: () => import("@tanstack/react-query").UseMutationResult<({
+  data: CostCalculatorEstimateCsvResponse;
+  error: undefined;
+} | {
+  data: undefined;
+  error: NotFoundResponse | UnprocessableEntityResponse;
+}) & {
+  request: Request;
+  response: Response;
+}, Error, CostCalculatorEstimateParams, unknown>;
+//#endregion
+//#region src/flows/CostCalculator/EstimationResults/EstimationResults.d.ts
+interface OnboardingTimelineStep {
+  title: string;
+  description: string;
+  id: string;
+}
+interface OnboardingTimelineData {
+  steps: OnboardingTimelineStep[];
+  helpText: string;
+  zendeskArticleId?: number;
+}
+type EstimationResultsComponents = {
+  HiringSection?: React.ComponentType<{
+    country: MinimalCountry;
+    countryBenefitsUrl: string;
+    countryGuideUrl: string;
+  }>;
+  OnboardingTimeline?: React.ComponentType<{
+    minimumOnboardingDays: number | null;
+    data: OnboardingTimelineData;
+  }>;
+  Header?: React.ComponentType<{
+    title: string;
+    region?: MinimalRegion;
+    country: MinimalCountry;
+    onDelete: () => void;
+    onExportPdf: () => void;
+  }>;
+  Footer?: React.ComponentType;
+};
+type EstimationResultsProps = {
+  estimation: CostCalculatorEstimation;
+  title: string;
+  components?: EstimationResultsComponents;
+  onDelete: () => void;
+  onExportPdf: () => void;
+  onEdit: () => void;
+};
+declare const EstimationResults: ({ estimation, title, components, onDelete, onExportPdf, onEdit }: EstimationResultsProps) => import("react").JSX.Element;
+//#endregion
+//#region src/flows/CostCalculator/SummaryResults/SummaryResults.d.ts
+type SummaryResultsProps = {
+  /**
+   * Array of employments to compare costs for.
+   * 2 estimations required for the component to render
+   */
+  estimations: CostCalculatorEstimation[];
+};
+/**
+ * Displays a summary comparison of costs across multiple estimations.
+ * The component will return null if you pass less than 2 estimations.
+ */
+declare const SummaryResults: ({ estimations }: SummaryResultsProps) => import("react").JSX.Element | null;
+//#endregion
+//#region src/flows/CostCalculator/utils.d.ts
+/**
+ * Build the payload for the cost calculator estimation.
+ * @param values
+ * @param estimationOptions
+ * @returns
+ */
+declare function buildPayload(values: CostCalculatorEstimationSubmitValues | CostCalculatorEstimationSubmitValues[], estimationOptions?: CostCalculatorEstimationOptions, version?: CostCalculatorVersion): CostCalculatorEstimateParams;
+//#endregion
+export { CostCalculatorFeatures as _, useCostCalculatorEstimationPdf as a, UseCostCalculatorOptions as b, CostCalculatorForm as c, useCostCalculator as d, CostCalculatorEstimation as f, CostCalculatorEstimationSubmitValues as g, CostCalculatorEstimationResponse as h, useCostCalculatorEstimationCsv as i, CostCalculatorFlow as l, CostCalculatorEstimationOptions as m, SummaryResults as n, CostCalculatorResetButton as o, CostCalculatorEstimationFormValues as p, EstimationResults as r, CostCalculatorSubmitButton as s, buildPayload as t, CostCalculatorFlowProps as u, CurrencyKey as v, EstimationError as y };
+//# sourceMappingURL=index-Bfp0Dih3.d.ts.map