@remoteoss/remote-flows 1.55.0 → 1.56.0

package/dist/index-Zkya1HrW.d.ts

@@ -0,0 +1,191 @@
+import { G as PostV1ContractAmendmentsAutomatableError, K as PostV1ContractAmendmentsError, U as NotFoundResponse, d as ContractAmendmentResponse, ot as UnauthorizedResponse, r as FieldValues, st as UnprocessableEntityResponse, u as ContractAmendmentAutomatableResponse } 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 { t as FlowOptions } from "./types-PZPLLCvV.js";
+import { ButtonHTMLAttributes, PropsWithChildren } from "react";
+//#region src/flows/ContractAmendment/ContractAmendmentConfirmationForm.d.ts
+type ContractAmendmentConfirmationFormProps = {
+  /**
+   * Callback function to be called when the contract amendment form is submitted.
+   * This function is called before the contract amendment is submitted.
+   * It can be used to perform any additional validation or processing before
+   * the contract amendment is submitted.
+   * @param values
+   * @returns
+   */
+  onSubmit?: (values: FieldValues) => void | Promise<void>;
+  /**
+   * Callback function to be called when the contract amendment fails.
+   * @param error
+   * @returns
+   */
+  onError?: (error: PostV1ContractAmendmentsError) => void;
+  /**
+   * Callback function to be called when the contract amendment is successfully submitted.
+   * @param data
+   * @returns
+   */
+  onSuccess?: (data: ContractAmendmentResponse) => void | Promise<void>;
+};
+declare function ContractAmendmentConfirmationForm({ onSubmit, onError, onSuccess }: ContractAmendmentConfirmationFormProps): import("react").JSX.Element | null;
+//#endregion
+//#region src/flows/ContractAmendment/ContractAmendmentBack.d.ts
+declare function ContractAmendmentBack({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement>> & Record<string, unknown>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/ContractAmendment/ContractAmendmentForm.d.ts
+type ContractAmendmentFormProps = {
+  /**
+   * Callback function to be called when the contract amendment form is submitted.
+   * This function is called before the contract amendment is submitted.
+   * It can be used to perform any additional validation or processing before
+   * the contract amendment is submitted.
+   * @param values
+   * @returns
+   */
+  onSubmit?: (values: FieldValues) => void | Promise<void>;
+  /**
+   * Callback function to be called when the contract amendment fails.
+   * @param error
+   * @returns
+   */
+  onError?: (error: PostV1ContractAmendmentsAutomatableError | {
+    message: 'no_changes_detected_contract_details';
+  }) => void;
+  /**
+   * Callback function to be called when the contract amendment is successfully submitted.
+   * This function is called after the contract amendment is submitted.
+   * @param data
+   * @returns
+   */
+  onSuccess?: (data: ContractAmendmentAutomatableResponse) => void | Promise<void>;
+};
+declare function ContractAmendmentForm({ onSubmit, onError, onSuccess }: ContractAmendmentFormProps): import("react").JSX.Element;
+//#endregion
+//#region src/flows/ContractAmendment/ContractAmendmentSubmit.d.ts
+declare function ContractAmendmentSubmit({ children, ...props }: PropsWithChildren<ButtonHTMLAttributes<HTMLButtonElement>> & Record<string, unknown>): import("react").JSX.Element;
+//#endregion
+//#region src/flows/ContractAmendment/types.d.ts
+type ContractAmendmentParams = {
+  employmentId: string;
+  countryCode: string;
+  options?: FlowOptions;
+};
+//#endregion
+//#region src/flows/ContractAmendment/hooks.d.ts
+declare const useContractAmendment: ({ employmentId, countryCode, options }: ContractAmendmentParams) => {
+  /**
+   * Current step state containing the current step and total number of steps
+   */
+  stepState: {
+    currentStep: Step<"confirmation_form" | "form">;
+    totalSteps: number;
+    values: {
+      confirmation_form: FieldValues;
+      form: FieldValues;
+    } | null;
+  };
+  /**
+   * Array of form fields from the contract amendment schema
+   */
+  fields: Fields;
+  /**
+   * Loading state indicating if either employment or contract amendment data is being fetched
+   */
+  isLoading: boolean;
+  /**
+   * Error state indicating if there was an error fetching either employment or contract amendment data
+   */
+  isError: boolean;
+  /**
+   * Error object containing details about any errors that occurred during data fetching
+   */
+  error: {} | null;
+  /**
+   * Loading state indicating if a contract amendment mutation is in progress
+   */
+  isSubmitting: boolean;
+  /**
+   * Initial form values built from employment data and contract amendment fields
+   */
+  initialValues: {};
+  /**
+   * Current form field values
+   */
+  values: FieldValues;
+  /**
+   * 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: FieldValues) => 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<FieldValues>>;
+  /**
+   * Function to handle form submission
+   * @param values - Form values to submit
+   * @returns Promise resolving to the mutation result
+   */
+  onSubmit: (values: FieldValues) => Promise<ErrorResponse<Error> | SuccessResponse<({
+    data: ContractAmendmentAutomatableResponse;
+    error: undefined;
+  } | {
+    data: undefined;
+    error: NotFoundResponse | UnauthorizedResponse | UnprocessableEntityResponse;
+  }) & {
+    request: Request;
+    response: Response;
+  }> | SuccessResponse<({
+    data: ContractAmendmentResponse;
+    error: undefined;
+  } | {
+    data: undefined;
+    error: NotFoundResponse | UnauthorizedResponse | UnprocessableEntityResponse;
+  }) & {
+    request: Request;
+    response: Response;
+  }>>;
+  /**
+   * Function to handle going back to the previous step
+   * @returns {void}
+   */
+  back: () => void;
+};
+//#endregion
+//#region src/flows/ContractAmendment/ContractAmendmentFlow.d.ts
+type TUseContractAmendment = ReturnType<typeof useContractAmendment>;
+type ContractAmendmentRenderProps = {
+  /**
+   * The contract amendment bag returned by the useContractAmendment hook.
+   * This bag contains all the methods and properties needed to handle the contract amendment flow.
+   * @see {@link useContractAmendment}
+   */
+  contractAmendmentBag: TUseContractAmendment;
+  /**
+   * The components used in the contract amendment flow.
+   * This includes the form, submit button, and confirmation form.
+   * @see {@link ContractAmendmentForm}
+   * @see {@link ContractAmendmentSubmit}
+   * @see {@link ContractAmendmentConfirmationForm}
+   */
+  components: {
+    Form: typeof ContractAmendmentForm;
+    SubmitButton: typeof ContractAmendmentSubmit;
+    ConfirmationForm: typeof ContractAmendmentConfirmationForm;
+    BackButton: typeof ContractAmendmentBack;
+  };
+};
+type ContractAmendmentFlowProps = ContractAmendmentParams & {
+  render: ({ contractAmendmentBag, components }: ContractAmendmentRenderProps) => React.ReactNode;
+};
+declare function ContractAmendmentFlow({ employmentId, countryCode, options, render }: ContractAmendmentFlowProps): import("react").JSX.Element;
+//#endregion
+export { ContractAmendmentForm as a, ContractAmendmentSubmit as i, ContractAmendmentRenderProps as n, ContractAmendmentConfirmationForm as o, useContractAmendment as r, ContractAmendmentFlow as t };
+//# sourceMappingURL=index-Zkya1HrW.d.ts.map