@socotra/ec-react-components 2.24.1-next.1 → 2.24.1-next.3

package/dist/index.d.ts

@@ -18,6 +18,9 @@ import { ElementResponse } from '@socotra/ec-react-schemas';
 import { EvaluateConstraintsRequest } from '@socotra/ec-react-schemas';
 import { EvaluateConstraintsResponse } from '@socotra/ec-react-schemas';
 import { FieldConfigRecord } from '@socotra/ec-react-schemas';
+import { FnolCreateRequest } from '@socotra/ec-react-schemas';
+import { FnolPatchRequest } from '@socotra/ec-react-schemas';
+import { FnolResponse } from '@socotra/ec-react-schemas';
 import { ForwardRefExoticComponent } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
@@ -118,6 +121,21 @@ declare type BaseProps = {
     getEvaluatedConstraints?: (request: AccountEvaluateConstraintsRequest) => Promise<EvaluateConstraintsResponse | undefined>;
 };
 
+declare interface CreateProps extends Props_12 {
+    /**
+     * The fnol object to update
+     */
+    fnol?: undefined;
+    /**
+     * The default values to set in the form
+     */
+    defaultValues?: Partial<FnolCreateRequest>;
+    /**
+     * The function to call when the form is submitted. It will create an PaymentRequest from the form data.
+     */
+    handleSubmit: (data: FnolCreateRequest) => void;
+}
+
 /**
  * DataPropertyForm is a form to render data based on data property schema and data model with edit and submission capabilities.
  */
@@ -150,6 +168,14 @@ export declare const ExistingPaymentForm: {
     displayName: string;
 };
 
+/**
+ * FnolForm is a form to render data based on fnol schema.
+ */
+export declare const FnolForm: {
+    ({ dataModel, id, titles, fnol, defaultValues, handleSubmit, isSubmitting, disabled, hideSubmitButton, validateOnSubmit, submitButtonText, readonly, styles, }: CreateProps | PatchProps): JSX_2.Element;
+    displayName: string;
+};
+
 declare type GetDisbursementFormDefaultFieldsProps = {
     disbursements: DisbursementRefRecord;
     accountBalance: number;
@@ -200,6 +226,21 @@ export declare const NewPaymentForm: {
     displayName: string;
 };
 
+declare interface PatchProps extends Props_12 {
+    /**
+     * The fnol object to update
+     */
+    fnol: Partial<FnolResponse>;
+    /**
+     * The default values to set in the form
+     */
+    defaultValues?: never;
+    /**
+     * The function to call when the form is submitted. It will create an PaymentRequest from the form data.
+     */
+    handleSubmit: (data: FnolPatchRequest) => void;
+}
+
 /**
  * PolicyForm is a form for updating a policy. It required a product data model, custom data types, and policy object to render the form.
  */
@@ -347,6 +388,55 @@ declare type Props_11 = {
     scope?: Array<'P' | 'Q' | 'QQ'>;
 };
 
+declare interface Props_12 {
+    /**
+     * The resolved data model retrieved from data model response
+     */
+    dataModel: DataModel;
+    /**
+     * Set to true when the form is submitting to set fields to readonly and disable the submit button
+     */
+    isSubmitting?: boolean;
+    /**
+     * Disables the form
+     */
+    disabled?: boolean;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
+    /**
+     * The text to display on the submit button
+     */
+    submitButtonText?: string;
+    /**
+     * Readonly mode for the form
+     */
+    readonly?: boolean;
+    /**
+     * ID for the form wrapper
+     */
+    id?: string;
+    /**
+     * Titles for the form and boolean labels
+     */
+    titles?: {
+        type?: string;
+        incidentTime?: string;
+        truthyLabel?: string;
+        falsyLabel?: string;
+    };
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
+}
+
 declare type Props_2 = {
     /**
      * The quote object