@remoteoss/remote-flows 1.55.0 → 1.56.0

package/dist/index-CpUmq5t-.d.ts

@@ -0,0 +1,408 @@
+import { E as Employment, L as ListLeavePoliciesSummaryResponse, R as ListTimeoffResponse, U as NotFoundResponse, W as OffboardingResponse, Y as RequestError, at as TooManyRequestsResponse, i as BadRequestResponse, it as TimeoffType, nt as TerminationDetailsParams, ot as UnauthorizedResponse, rt as TimeoffStatus, st as UnprocessableEntityResponse } from "./index-DZOv3Kqg.js";
+import { t as Step } from "./useStepState-DPuZ-xcq.js";
+import { n as Fields, t as $TSFixMe } from "./json-schema-form-AtvQYqTV.js";
+import { n as ValidationResult } from "./index-xjEJT03m.js";
+import { i as SuccessResponse, t as ErrorResponse } from "./mutations-BtF_JHC1.js";
+import { r as JSFModify } from "./types-PZPLLCvV.js";
+import "./types-DM3hjkjw.js";
+import { ButtonHTMLAttributes, PropsWithChildren } from "react";
+import { UseQueryResult } from "@tanstack/react-query";
+//#region src/flows/Termination/AdditionalDetailsForm.d.ts
+type AdditionalDetailsFormProps = {
+  onSubmit?: (payload: TerminationFormValues) => void | Promise<void>;
+  onError?: (error: Record<string, unknown>) => void;
+  onSuccess?: (data: OffboardingResponse) => void | Promise<void>;
+};
+declare function AdditionalDetailsForm({ onSubmit, onSuccess, onError }: AdditionalDetailsFormProps): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/EmployeeComunicationForm.d.ts
+type EmployeeComunicationProps = {
+  onSubmit?: (payload: EmployeeCommunicationFormValues) => void | Promise<void>;
+};
+declare function EmployeeCommunicationForm({ onSubmit }: EmployeeComunicationProps): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/utils.d.ts
+type StepTerminationKeys = 'employee_communication' | 'termination_details' | 'paid_time_off' | 'additional_information';
+//#endregion
+//#region src/flows/Termination/hooks.d.ts
+type TerminationHookProps = Omit<TerminationFlowProps, 'render'>;
+declare const useTermination: ({ employmentId, options, initialValues: terminationInitialValues }: TerminationHookProps) => {
+  /**
+   * Employment id passed useful to be used between components
+   */
+  employmentId: string;
+  /**
+   * Employment data
+   */
+  employment: (Employment & {
+    termination_date?: string | null;
+  }) | undefined;
+  /**
+   * Current form field values, we use formValues to let the user know about all the current form values
+   */
+  fieldValues: {
+    confidential: string;
+    customer_informed_employee: string;
+    customer_informed_employee_date: string | null;
+    customer_informed_employee_description: string | null;
+    personal_email: string;
+    proposed_termination_date: string;
+    reason_description: string;
+    risk_assessment_reasons: TerminationDetailsParams['risk_assessment_reasons'];
+    termination_reason: TerminationDetailsParams['termination_reason'] | undefined;
+    termination_reason_files: TerminationDetailsParams['termination_reason_files'];
+    additional_comments: string | null;
+    will_challenge_termination: string;
+    will_challenge_termination_description: string | null;
+    agrees_to_pto_amount: string;
+    agrees_to_pto_amount_notes: string | null;
+    timesheet_file: TerminationDetailsParams['timesheet_file'];
+    acknowledge_termination_procedure: boolean;
+  };
+  /**
+   * Indicates if the form is dirty
+   */
+  isDirty: boolean;
+  /**
+   * Current step state containing the current step and total number of steps
+   */
+  stepState: {
+    currentStep: Step<StepTerminationKeys>;
+    totalSteps: number;
+    values: {
+      additional_information: TerminationFormValues;
+      employee_communication: TerminationFormValues;
+      paid_time_off: TerminationFormValues;
+      termination_details: TerminationFormValues;
+    } | null;
+  };
+  /**
+   * Array of form fields from the contract amendment schema
+   */
+  fields: Fields;
+  /**
+   * Loading state indicating if the termination schema is being fetched
+   */
+  isLoading: boolean;
+  /**
+   * Loading state indicating if a contract amendment mutation is in progress
+   */
+  isSubmitting: boolean;
+  /**
+   * Initial form values
+   */
+  initialValues: TerminationFormValues;
+  /**
+   * Function to validate form values against the contract amendment schema
+   * @param values - Form values to validate
+   * @returns Validation result or null if no schema is available
+   */
+  handleValidation: (values: TerminationFormValues) => Promise<ValidationResult | {
+    yupError: $TSFixMe;
+    formErrors: $TSFixMe;
+  } | null>;
+  /**
+   * Function to update the current form field values
+   * @param values - New form values to set
+   */
+  checkFieldUpdates: import("react").Dispatch<import("react").SetStateAction<TerminationFormValues>>;
+  /**
+   * Function to parse form values before submission
+   * @param values - Form values to parse
+   * @returns Parsed form values
+   */
+  parseFormValues: (values: TerminationFormValues, includeAllFields?: boolean) => Promise<EmployeeCommunicationFormValues | TerminationDetailsFormValues | PaidTimeOffFormValues | TerminationFormValues>;
+  /**
+   * Function to handle form submission
+   * @param values - Form values to submit
+   * @returns Promise resolving to the mutation result
+   */
+  onSubmit: (values: TerminationFormValues) => Promise<(ErrorResponse<Error> | SuccessResponse<({
+    data: OffboardingResponse;
+    error: undefined;
+  } | {
+    data: undefined;
+    error: NotFoundResponse | RequestError | TooManyRequestsResponse | UnauthorizedResponse | BadRequestResponse | UnprocessableEntityResponse;
+  }) & {
+    request: Request;
+    response: Response;
+  }>) | 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;
+};
+//#endregion
+//#region src/flows/Termination/PaidTimeOffForm.d.ts
+type PaidTimeOffFormProps = {
+  onSubmit?: (payload: PaidTimeOffFormValues) => void | Promise<void>;
+};
+declare function PaidTimeOffForm({ onSubmit }: PaidTimeOffFormProps): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/TerminationBack.d.ts
+declare function TerminationBack({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement>> & Record<string, unknown>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/TerminationDetailsForm.d.ts
+type TerminationDetailsFormProps = {
+  onSubmit?: (payload: TerminationDetailsFormValues) => void | Promise<void>;
+};
+declare function TerminationDetailsForm({ onSubmit }: TerminationDetailsFormProps): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/TerminationSubmit.d.ts
+declare function TerminationSubmit({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement>> & Record<string, unknown>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/types.d.ts
+type EmployeeCommunicationFormValues = {
+  confidential: string;
+  customer_informed_employee: string;
+  customer_informed_employee_date: string | null;
+  customer_informed_employee_description: string | null;
+  personal_email: string;
+};
+type TerminationDetailsFormValues = {
+  proposed_termination_date: string;
+  reason_description: string;
+  risk_assessment_reasons: TerminationDetailsParams['risk_assessment_reasons'];
+  termination_reason: TerminationDetailsParams['termination_reason'] | undefined;
+  termination_reason_files: TerminationDetailsParams['termination_reason_files'];
+  additional_comments: string | null;
+  will_challenge_termination: string;
+  will_challenge_termination_description: string | null;
+};
+type PaidTimeOffFormValues = {
+  agrees_to_pto_amount: string;
+  agrees_to_pto_amount_notes: string | null;
+  timesheet_file: TerminationDetailsParams['timesheet_file'];
+};
+type AdditionalDetailsFormValues = {
+  acknowledge_termination_procedure: boolean;
+};
+type TerminationFormValues = EmployeeCommunicationFormValues & TerminationDetailsFormValues & PaidTimeOffFormValues & AdditionalDetailsFormValues;
+type TerminationRenderProps = {
+  /**
+   * The termination bag returned by the useTermination hook.
+   * This bag contains all the methods and properties needed to handle the termination flow.
+   * @see {@link useTermination}
+   */
+  terminationBag: ReturnType<typeof useTermination>;
+  /**
+   * The components used in the termination flow.
+   * This includes different steps, submit button, back button and timeoff.
+   * @see {@link TerminationSubmit}
+   * @see {@link TerminationBack}
+   * @see {@link EmployeeCommunicationForm}
+   * @see {@link TerminationDetailsForm}
+   * @see {@link PaidTimeOffForm}
+   * @see {@link AdditionalDetailsForm}
+   */
+  components: {
+    SubmitButton: typeof TerminationSubmit;
+    Back: typeof TerminationBack;
+    EmployeeComunicationStep: typeof EmployeeCommunicationForm;
+    TerminationDetailsStep: typeof TerminationDetailsForm;
+    PaidTimeOffStep: typeof PaidTimeOffForm;
+    AdditionalDetailsStep: typeof AdditionalDetailsForm;
+  };
+};
+type TerminationFlowProps = {
+  employmentId: string;
+  render: ({ terminationBag, components }: TerminationRenderProps) => React.ReactNode;
+  options?: {
+    jsfModify?: JSFModify;
+  };
+  initialValues?: Record<string, unknown>;
+};
+//#endregion
+//#region src/flows/Termination/TerminationFlow.d.ts
+declare const TerminationFlow: ({ employmentId, render, options, initialValues }: TerminationFlowProps) => import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/components/TerminationReasonsDetailContent/TerminationReasonsDetailContent.d.ts
+declare const TerminationReasonsDetailContent: () => import("react").JSX.Element;
+//#endregion
+//#region src/flows/Termination/components/TerminationDialogInfoContent/TerminationDialogInfoContent.d.ts
+declare const TerminationDialogInfoContent: () => import("react").JSX.Element;
+//#endregion
+//#region src/common/api/timeoff.d.ts
+/**
+ * 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;
+  };
+}) => import("@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;
+  };
+}) => import("@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;
+}) => import("@tanstack/react-query").UseQueryResult<NoInfer<ListLeavePoliciesSummaryResponse | undefined>, Error>;
+//#endregion
+//#region src/lib/time.d.ts
+type DaysAndHours = {
+  hours: number;
+  days: number;
+};
+//#endregion
+//#region src/flows/Termination/api.d.ts
+type BookedTimeoffBeforeDateResponse = {
+  bookedDaysBeforeTermination: DaysAndHours;
+  bookedDaysAfterTermination: DaysAndHours;
+};
+type SummaryTimeOffDataResponse = {
+  entitledDays: string;
+  bookedDays: string;
+  usedDays: string;
+  currentEntitlementDays: string;
+  approvedDaysBeforeTermination: string;
+  approvedDaysAfterTermination: string;
+  remainingDays: string;
+  isUnlimitedPto: boolean;
+};
+//#endregion
+//#region src/flows/Termination/components/PaidTimeOff/types.d.ts
+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;
+};
+//#endregion
+//#region src/flows/Termination/components/PaidTimeOff/PaidTimeOff.d.ts
+type PaidTimeOffProps = PaidTimeOffRenderProps;
+//#endregion
+//#region src/flows/Termination/components/AcknowledgeInformation/AcknowledgeInformationFees.d.ts
+/**
+ * The acknowledge information fees component props
+ */
+type AcknowledgeInformationFeesProps = {
+  /**
+   * The Zendesk ID for the involuntary offboarding service charge
+   */
+  involuntaryOffboardingServiceChargeZendeskId: number;
+  /**
+   * The Zendesk ID for the reconciliation invoice
+   */
+  reconciliationInvoiceZendeskId: number;
+};
+//#endregion
+//#region src/flows/Termination/components/AcknowledgeInformation/constants.d.ts
+declare const cards$1: {
+  remoteDoesNext: {
+    title: string;
+    description: string;
+  };
+  whatYouNeedToDo: {
+    title: string;
+    list: string[];
+  };
+};
+//#endregion
+//#region src/flows/Termination/components/AcknowledgeInformation/types.d.ts
+type AcknowledgeInformationContainerRenderProps = {
+  /**
+   * The cards to display in the acknowledge information component.
+   * @see {@link cards}
+   */
+  cards: typeof cards$1;
+};
+//#endregion
+//#region src/flows/Termination/components/AcknowledgeInformation/AcknowledgeInformation.d.ts
+/**
+ * The acknowledge information component props
+ */
+type AcknowledgeInformationProps = AcknowledgeInformationContainerRenderProps;
+//#endregion
+export { useTimeOffLeavePoliciesSummaryQuery as a, TerminationReasonsDetailContent as c, EmployeeCommunicationFormValues as d, PaidTimeOffFormValues as f, TerminationRenderProps as g, TerminationFormValues as h, usePaidTimeoffBreakdownQuery as i, TerminationFlow as l, TerminationFlowProps as m, AcknowledgeInformationFeesProps as n, useTimeOffQuery as o, TerminationDetailsFormValues as p, PaidTimeOffProps as r, TerminationDialogInfoContent as s, AcknowledgeInformationProps as t, AdditionalDetailsFormValues as u };
+//# sourceMappingURL=index-CpUmq5t-.d.ts.map

package/dist/index-CtaBzbkN.d.ts

@@ -0,0 +1,9 @@
+import { c as OnboardingFlowProps } from "./types-DM3hjkjw.js";
+//#region src/flows/Onboarding/OnboardingFlow.d.ts
+declare const OnboardingFlow: ({ employmentId, companyId, countryCode, type, externalId, partnerExternalId, skipSteps, initialValues, render, options }: OnboardingFlowProps) => import("react").JSX.Element;
+//#endregion
+//#region src/flows/Onboarding/components/EmploymentAgreementInfoContent.d.ts
+declare const EmploymentAgreementInfoContent: () => import("react").JSX.Element;
+//#endregion
+export { OnboardingFlow as n, EmploymentAgreementInfoContent as t };
+//# sourceMappingURL=index-CtaBzbkN.d.ts.map

package/dist/index-DSNiRSgk.d.ts

@@ -0,0 +1,111 @@
+import { c as JSFFieldset, r as Components } from "./remoteFlows-DzjJtmiU.js";
+import { r as FieldValues } from "./index-DZOv3Kqg.js";
+import { n as Fields, t as $TSFixMe } from "./json-schema-form-AtvQYqTV.js";
+import { n as ValidationResult, t as Field } from "./index-xjEJT03m.js";
+import React, { ButtonHTMLAttributes, PropsWithChildren } from "react";
+//#region src/flows/JsonSchemaPlayground/hooks.d.ts
+declare const useJsonSchemaPlayground: (options: UseJsonSchemaPlaygroundOptions) => {
+  selectedSchema: string;
+  resetKey: number;
+  isLoading: boolean;
+  isSubmitting: boolean;
+  submittedResults: JsonSchemaPlaygroundResult[];
+  fieldValues: {
+    [x: string]: any;
+  };
+  initialValues: Record<string, unknown>;
+  currentSchemaData: SampleSchema;
+  fields: Field[] | Fields;
+  meta: {
+    'x-jsf-fieldsets': JSFFieldset;
+    'x-jsf-presentation'?: Record<string, unknown>;
+  };
+  handleSchemaChange: (schemaKey: string) => void;
+  handleSubmit: (values: FieldValues) => Promise<JsonSchemaPlaygroundResult>;
+  handleReset: () => void;
+  clearResults: () => void;
+  /**
+   * Function to update the current form field values
+   * @param values - New form values to set
+   */
+  checkFieldUpdates: (values: FieldValues) => Promise<void>;
+  handleValidation: (values: FieldValues) => Promise<ValidationResult | {
+    yupError: $TSFixMe;
+    formErrors: $TSFixMe;
+  } | null>;
+};
+//#endregion
+//#region src/flows/JsonSchemaPlayground/JsonSchemaPlaygroundForm.d.ts
+interface JsonSchemaPlaygroundFormProps {
+  onSubmit?: (values: Record<string, unknown>) => void;
+  className?: string;
+  components?: Components;
+  defaultValues?: Record<string, unknown>;
+}
+declare const JsonSchemaPlaygroundForm: (props: JsonSchemaPlaygroundFormProps) => import("react").JSX.Element;
+//#endregion
+//#region src/flows/JsonSchemaPlayground/JsonSchemaPlaygroundSubmitButton.d.ts
+declare function JsonSchemaPlaygroundSubmitButton({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement> & Record<string, unknown>>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/JsonSchemaPlayground/JsonSchemaPlaygroundResetButton.d.ts
+declare function JsonSchemaPlaygroundResetButton({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement>> & Record<string, unknown>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/JsonSchemaPlayground/types.d.ts
+interface JsonSchemaPlaygroundResult {
+  success: boolean;
+  data: FieldValues;
+  timestamp: string;
+}
+interface SampleSchema {
+  name: string;
+  description: string;
+  schema: Record<string, unknown>;
+}
+interface UseJsonSchemaPlaygroundOptions {
+  defaultSchema?: string;
+  initialValues?: FieldValues;
+  /**
+   * Extra schemas made available alongside the built-in samples, keyed by
+   * schema key. An entry with the same key as a built-in overrides it.
+   */
+  schemas: Record<string, SampleSchema>;
+  onSubmit?: (values: FieldValues) => void | Promise<void>;
+  onSchemaChange?: (schema: string) => void;
+  onError?: (error: unknown) => void;
+}
+type JsonSchemaPlaygroundRenderProps = {
+  /**
+   * The playground bag returned by the useJsonSchemaPlayground hook.
+   * This bag contains all the methods and properties needed to handle the playground flow.
+   * @see {@link useJsonSchemaPlayground}
+   */
+  playgroundBag: ReturnType<typeof useJsonSchemaPlayground>;
+  /**
+   * The components used in the playground flow.
+   * This includes the form, submit button, and reset button.
+   * @see {@link JsonSchemaPlaygroundForm}
+   * @see {@link JsonSchemaPlaygroundSubmitButton}
+   * @see {@link JsonSchemaPlaygroundResetButton}
+   */
+  components: {
+    Form: typeof JsonSchemaPlaygroundForm;
+    SubmitButton: typeof JsonSchemaPlaygroundSubmitButton;
+    ResetButton: typeof JsonSchemaPlaygroundResetButton;
+  };
+};
+//#endregion
+//#region src/flows/JsonSchemaPlayground/JsonSchemaPlaygroundFlow.d.ts
+interface JsonSchemaPlaygroundFlowProps extends UseJsonSchemaPlaygroundOptions {
+  render: (renderProps: JsonSchemaPlaygroundRenderProps) => React.ReactNode;
+}
+declare const JsonSchemaPlaygroundFlow: ({ defaultSchema, initialValues, schemas, onSubmit, onSchemaChange, onError, render }: JsonSchemaPlaygroundFlowProps) => React.JSX.Element;
+//#endregion
+//#region src/flows/JsonSchemaPlayground/context.d.ts
+interface JsonSchemaPlaygroundContextValue {
+  formId: string;
+  playgroundBag: ReturnType<typeof useJsonSchemaPlayground>;
+}
+declare const useJsonSchemaPlaygroundContext: () => JsonSchemaPlaygroundContextValue;
+//#endregion
+export { SampleSchema as a, JsonSchemaPlaygroundRenderProps as i, JsonSchemaPlaygroundFlow as n, JsonSchemaPlaygroundFormProps as o, JsonSchemaPlaygroundFlowProps as r, useJsonSchemaPlayground as s, useJsonSchemaPlaygroundContext as t };
+//# sourceMappingURL=index-DSNiRSgk.d.ts.map