@socotra/ec-react-components 2.6.3-next.0 → 2.6.3-next.2

package/dist/index.d.ts

@@ -1,12 +1,14 @@
 import { AccountConfigRecord } from '@socotra/ec-react-schemas';
 import { AccountRequest } from '@socotra/ec-react-schemas';
 import { AccountResponse } from '@socotra/ec-react-schemas';
+import { ConstraintEvaluationResponse } from '@socotra/ec-react-schemas';
 import { CoverageTermsConfigRecord } from '@socotra/ec-react-schemas';
 import { DataModel } from '@socotra/ec-react-schemas';
 import { DataTypeConfigRecord } from '@socotra/ec-react-schemas';
 import { ElementConfig } from '@socotra/ec-react-schemas';
 import { ElementRequest } from '@socotra/ec-react-schemas';
 import { ElementResponse } from '@socotra/ec-react-schemas';
+import { EvaluateConstraintsRequest } from '@socotra/ec-react-schemas';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
 import { ModifyChangeInstructionResponse } from '@socotra/ec-react-schemas';
@@ -14,6 +16,7 @@ import { ParamsChangeInstructionCreateRequest } from '@socotra/ec-react-schemas'
 import { ParamsChangeInstructionResponse } from '@socotra/ec-react-schemas';
 import { PolicyResponse } from '@socotra/ec-react-schemas';
 import { ProductConfig } from '@socotra/ec-react-schemas';
+import { QuoteDependencyMapResponse } from '@socotra/ec-react-schemas';
 import { QuoteRequest } from '@socotra/ec-react-schemas';
 import { QuoteResponse } from '@socotra/ec-react-schemas';
 import { SegmentResponse } from '@socotra/ec-react-schemas';
@@ -39,7 +42,7 @@ export declare const DraftTransactionForm: {
  * ElementForm is a form for creating or updating an element of a Quote. It required the element's data model, custom data types, and an element response object.
  */
 export declare const ElementForm: {
-    ({ elementModel, dataTypes, disabled, handleSubmit, coverageTerms, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, submitButtonText, id, titles, }: Props_3): JSX_2.Element;
+    ({ elementModel, dataTypes, disabled, handleSubmit, dataModel, coverageTerms, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, submitButtonText, id, titles, getEvaluatedConstraints, dependencyMap, }: Props_3): JSX_2.Element;
     displayName: string;
 };
 
@@ -214,6 +217,10 @@ declare type Props_3 = {
      * The custom data types for the configuration that may be referenced by the elementModel
      */
     dataTypes?: DataTypeConfigRecord;
+    /**
+     * The resolved data model retrieved from data model response
+     */
+    dataModel: DataModel;
     /**
      * The coverage terms configuration that may be referenced by the elementModel
      */
@@ -256,11 +263,50 @@ declare type Props_3 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * The dependency map for the quote's constraints (if any)
+     *
+     * This map must be provided to enable the form to evaluate constraints, retrieved by
+     *
+     * @example
+     *	const dependencyMap = await fetch(`/policy/${tenantLocator}/quotes/${locator}/constraints/dependency`, {
+     *		method: "GET",
+     *		headers: {
+     *			Authorization: `Bearer ${token}`,
+     *			"Content-Type": "application/json",
+     *		}
+     *	});
+     */
+    dependencyMap?: QuoteDependencyMapResponse;
+    /**
+     * Evaluates constraints for the quote to determine the values of other fields
+     *
+     * This function must be provided to enable the form to evaluate constraints
+     *
+     * @param {object} request - The request object containing the quote locator
+     * @param {string} tenantLocator - The tenant locator
+     * @param {string} locator - The locator of the element to evaluate constraints for
+     * @example
+     * const getEvaluatedConstraints = async (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => {
+     * 	const response = await fetch(`/policy/${tenantLocator}/quotes/${locator}/constraints/evaluate`, {
+     * 		method: "POST",
+     * 		body: JSON.stringify(request),
+     * 		headers: {
+     * 			Authorization: `Bearer ${token}`,
+     * 			"Content-Type": "application/json",
+     * 		}
+     * 	});
+     * 	const data = await response.json();
+     * 	return data;
+     * 	}
+     */
+    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
     /**
      * Titles for the form
      */
     titles?: {
         coverageTerms?: string;
+        details?: string;
     };
 };
 
@@ -287,6 +333,7 @@ declare type Props_4 = {
     titles?: {
         formTitle?: string;
         seeAdvancedDetails?: string;
+        coverageTerms?: string;
     };
 };