@socotra/ec-react-utils 2.21.0-next.0 → 2.21.0-next.2

package/README.md

@@ -62,6 +62,7 @@ Follow instructions in the `ec-react/packages/docs/README.md` file to build the
 
 | Function | Description | Returns |
 |----------|-------------|---------|
+| `getAccountEvaluatedConstraintsRequest` | Creates a request payload to evaluate constraints for an account. | `AccountEvaluateConstraintsRequest` |
 | `extractElementByLocator` | Extracts the first element from a policy, quote, or transaction segment that matches the specified locator. | `Element` or `undefined` |
 | `extractElementByType` | Extracts the first element from a policy, quote, or transaction segment that matches the specified type. | `Element` or `undefined` |
 | `extractElementsByType` | Extracts all elements from a policy, quote, or transaction segment that match the specified type. | `Element[]` |
@@ -72,6 +73,7 @@ Follow instructions in the `ec-react/packages/docs/README.md` file to build the
 | `extractElementsFromTransactionSegment` | Extracts all elements from a transaction segment's exposures. | `Element[]` |
 | `extractProductDataModel` | Extracts the data model for a specific product from a policy or quote. | `object` or `undefined` |
 | `extractProductElements` | Extracts all elements associated with a product from a policy or quote. | `Element[]` |
+| `shouldEvaluateConstraints` | Checks if the constraints should be evaluated based on the original and new data. | `boolean` |
 
 ### Default Value Getters
 

package/dist/index.d.ts

@@ -1,16 +1,19 @@
 import { AccountConfigRecord } from '@socotra/ec-react-schemas';
 import { AccountCreateRequest } from '@socotra/ec-react-schemas';
+import { AccountEvaluateConstraintsRequest } from '@socotra/ec-react-schemas';
 import { AccountResponse } from '@socotra/ec-react-schemas';
 import { AccountUpdateRequest } from '@socotra/ec-react-schemas';
-import { ConstraintEvaluationResponse } from '@socotra/ec-react-schemas';
 import { CoverageTermsConfigRecord } from '@socotra/ec-react-schemas';
 import { DataFieldValue } from '@socotra/ec-react-schemas';
 import { DataModel } from '@socotra/ec-react-schemas';
 import { DataTypeConfigRecord } from '@socotra/ec-react-schemas';
+import { DependencyMapResponse } 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 { ErrorObject } from 'ajv';
+import { EvaluateConstraintsRequest } from '@socotra/ec-react-schemas';
+import { EvaluateConstraintsResponse } from '@socotra/ec-react-schemas';
 import { FieldConfigRecord } from '@socotra/ec-react-schemas';
 import { JsonSchema7 } from '@jsonforms/core';
 import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
@@ -19,7 +22,6 @@ import { PolicyResponse } from '@socotra/ec-react-schemas';
 import { PrimitiveValue } from '@socotra/ec-react-schemas';
 import { ProductConfig } from '@socotra/ec-react-schemas';
 import { Quantifiers } 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';
@@ -93,8 +95,8 @@ declare interface DataModelToJsonSchemaProps {
     data: FieldConfigRecord;
     timezone?: string;
     dataTypes?: DataTypeConfigRecord;
-    evaluatedConstraints?: ConstraintEvaluationResponse;
-    constraintDependencyMap?: QuoteDependencyMapResponse;
+    evaluatedConstraints?: EvaluateConstraintsResponse;
+    constraintDependencyMap?: DependencyMapResponse;
     ignoreConstraints?: boolean;
     scope: Array<'P' | 'Q' | 'QQ'>;
     rootDisplayName?: string;
@@ -304,6 +306,12 @@ export declare const extractProductElements: ({ dataModel, contents, }: {
     contents: string[];
 }) => ProductElementMap;
 
+export declare const getAccountEvaluatedConstraintsRequest: ({ dependencyMap, locator, data, }: {
+    dependencyMap: DependencyMapResponse;
+    data: any;
+    locator: string;
+}) => AccountEvaluateConstraintsRequest;
+
 export declare function getAccountRequest(params: {
     data: {
         [key: string]: any;
@@ -498,10 +506,10 @@ export declare const getElementTransactionUpdateRequestFromFormData: (params: Tr
 };
 
 export declare const getEvaluatedConstraintsRequest: ({ dependencyMap, locator, data, }: {
-    dependencyMap: QuoteDependencyMapResponse;
+    dependencyMap: DependencyMapResponse;
     data: any;
     locator: string;
-}) => Record<string, Record<string, Record<string, string | Record<string, string>>>>;
+}) => EvaluateConstraintsRequest;
 
 export declare const getModifyChangeInstructionCreateRequestFromFormData: ({ data, transactionSnapshot, staticLocator, }: TransactionFormData_2) => {
     action: "modify";
@@ -536,7 +544,7 @@ export declare const getQuoteRequest: (params: QuoteFormData) => QuoteRequest;
  */
 export declare function getRemoveDataFieldValues(originalObj: AnyObject, modifiedObj: AnyObject): AnyObject;
 
-export declare const getUpdatedDataFromConstraints: (newData: Record<string, PrimitiveValue>, evaluatedConstraintMap: ConstraintEvaluationResponse | undefined, elementLocator: string) => Record<string, PrimitiveValue>;
+export declare const getUpdatedDataFromConstraints: (newData: Record<string, PrimitiveValue>, evaluatedConstraintMap: EvaluateConstraintsResponse | undefined, elementLocator: string) => Record<string, PrimitiveValue>;
 
 export declare const parseToPrimitive: (str: string) => any;
 
@@ -587,6 +595,8 @@ export declare type QuoteRequestAdvancedFields = z.infer<typeof advancedFieldSch
  */
 export declare type QuoteRequestDefaultFields = z.infer<typeof defaultFieldSchema>;
 
+export declare const shouldEvaluateConstraints: (data: Record<string, unknown>, localData: Record<string, unknown>, constraintFieldNames: string[]) => boolean;
+
 /**
  * The function `splitInputAndQuantifier` takes a string input, removes certain characters from it, and
  * extracts a quantifier if present.