@socotra/ec-react-components 2.20.1 → 2.21.0-next.1

package/README.md

@@ -15,11 +15,11 @@ Our components are built with modern, robust technologies including **React**, *
 
 ## Key Features
 
--   **Schema-Driven UI**: Forms for quotes, policies, accounts, and transactions are generated dynamically from your data model, not hardcoded.
--   **Complex Logic Handling**: Built-in support for sophisticated insurance workflows, including constraint evaluation for real-time field dependency updates.
--   **Highly Customizable**: A powerful `tag` system allows for deep customization of field behavior directly from the data model—from conditional visibility to special UI controls like multi-select and currency inputs.
--   **Enterprise-Ready**: Designed to handle the intricate details of policy administration, including endorsements, payments, disbursements, and renewals.
--   **Modern Tech Stack**: A clean, modern, and performant codebase that is a pleasure to work with and extend.
+- **Schema-Driven UI**: Forms for quotes, policies, accounts, and transactions are generated dynamically from your data model, not hardcoded.
+- **Complex Logic Handling**: Built-in support for sophisticated insurance workflows, including constraint evaluation for real-time field dependency updates.
+- **Highly Customizable**: A powerful `tag` system allows for deep customization of field behavior directly from the data model—from conditional visibility to special UI controls like multi-select and currency inputs.
+- **Enterprise-Ready**: Designed to handle the intricate details of policy administration, including endorsements, payments, disbursements, and renewals.
+- **Modern Tech Stack**: A clean, modern, and performant codebase that is a pleasure to work with and extend.
 
 ---
 
@@ -37,23 +37,24 @@ Dive into the detailed documentation for our core components to understand their
 
 ### Core Forms
 
-| Component | Description |
-| :--- | :--- |
-| **AccountForm** | A dynamic form for creating and updating customer accounts based on configurable account types. |
-| **QuoteForm** | The cornerstone of the quoting process. A comprehensive, multi-section form for creating and updating quotes with full support for constraint evaluation. |
-| **PolicyForm** | A specialized, read-only view for displaying the complete data of an issued policy in a structured format. |
-| **ElementForm** | A versatile and powerful form for rendering any sub-element of a policy or quote, such as a vehicle, driver, or location. |
-| **PaymentForm** | A suite of components for handling all payment-related actions: creating new payments, applying existing credit, and reversing transactions. |
-| **DisbursementForm** | A specialized form for processing disbursements from an account, with dynamic fields based on disbursement type. |
+| Component            | Description                                                                                                                                               |
+| :------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **AccountForm**      | A dynamic form for creating and updating customer accounts based on configurable account types.                                                           |
+| **QuoteForm**        | The cornerstone of the quoting process. A comprehensive, multi-section form for creating and updating quotes with full support for constraint evaluation. |
+| **PolicyForm**       | A specialized, read-only view for displaying the complete data of an issued policy in a structured format.                                                |
+| **ElementForm**      | A versatile and powerful form for rendering any sub-element of a policy or quote, such as a vehicle, driver, or location.                                 |
+| **PaymentForm**      | A suite of components for handling all payment-related actions: creating new payments, applying existing credit, and reversing transactions.              |
+| **DisbursementForm** | A specialized form for processing disbursements from an account, with dynamic fields based on disbursement type.                                          |
+| **DataPropertyForm** | A dynamic form used for rendering and editing data properties using a provided data model and property schema.                                            |
 
 ### Transaction Forms
 
 These forms are used for handling changes to policies post-issuance (endorsements, renewals, etc.).
 
-| Component | Description |
-| :--- | :--- |
+| Component                      | Description                                                                                                                                                                    |
+| :----------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **InitializedTransactionForm** | Handles transactions in an `initialized` state (e.g., a new business quote), with full support for constraint evaluation to manage complex field dependencies before issuance. |
-| **DraftTransactionForm** | A specialized form for midterm policy changes. It generates the necessary `param` and `modify` change instructions to accurately update a `draft` transaction. |
+| **DraftTransactionForm**       | A specialized form for midterm policy changes. It generates the necessary `param` and `modify` change instructions to accurately update a `draft` transaction.                 |
 
 ---
 
@@ -62,21 +63,21 @@ These forms are used for handling changes to policies post-issuance (endorsement
 To unlock the full potential of this library, it's essential to understand the `tag` system. Our custom rendering guide provides a detailed walkthrough of how to control form behavior directly from your data model.
 
 This guide covers:
--   Conditional Field Hiding (`hidden|...`, `rootHidden|...`, `hidden`)
--   Advanced UI Controls (`multiselect`, `horizontal-layout`)
--   Data Formatting (`currency`)
 
+- Conditional Field Hiding (`hidden|...`, `rootHidden|...`, `hidden`)
+- Advanced UI Controls (`multiselect`, `horizontal-layout`)
+- Data Formatting (`currency`)
 
 ## Theming
 
 To style the components, follow the instructions in the theming guide.
 
-This guide covers:  
+This guide covers:
+
 - Theming with Tailwind CSS and `shadcn/ui`
 - CSS Imports from the package
 - Per-Component Style Overrides
 
-
 ## Documentation
 
 The documentation for this package is generated from a script that must be run after the package is built.
@@ -92,4 +93,4 @@ Edit files under the `components` directory.
 
 Run `pnpm run sync` to update the documentation in the `README.md` files of the other packages.
 
-Follow instructions in the `ec-react/packages/docs/README.md` file to build the documentation and update the `Socotra Documentation` repo.
+Follow instructions in the `ec-react/packages/docs/README.md` file to build the documentation and update the `Socotra Documentation` repo.

package/dist/index.d.ts

@@ -1,20 +1,22 @@
 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 { CreditDistributionRequest } from '@socotra/ec-react-schemas';
 import { CreditDistributionReverseRequest } from '@socotra/ec-react-schemas';
 import { CurrencyType } 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 { DisbursementCreateRequest } from '@socotra/ec-react-schemas';
 import { DisbursementRefRecord } 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 { EvaluateConstraintsResponse } from '@socotra/ec-react-schemas';
 import { FieldConfigRecord } from '@socotra/ec-react-schemas';
 import { ForwardRefExoticComponent } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
@@ -27,7 +29,6 @@ import { PaymentRequest as PaymentRequest_2 } from '@socotra/ec-react-schemas';
 import { PolicyResponse } from '@socotra/ec-react-schemas';
 import { ProductConfig } from '@socotra/ec-react-schemas';
 import { PropertyRef } 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 { RefAttributes } from 'react';
@@ -40,7 +41,10 @@ import { TransactionSnapshotResponse } from '@socotra/ec-react-schemas';
  * AccountForm is a form for creating or updating an account. It required a resolved data model, custom data types, and an optional account object to put the form in update mode.
  */
 export declare const AccountForm: {
-    ({ dataModel, accountType, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, hideAdvancedFields, validateOnSubmit, account, submitButtonText, id, titles, styles, }: Props): JSX_2.Element;
+    ({ dataModel, accountType, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, hideAdvancedFields, validateOnSubmit, account, submitButtonText, id, titles, styles, dependencyMap, getEvaluatedConstraints, }: Props & {
+        dependencyMap?: DependencyMapResponse;
+        getEvaluatedConstraints?: (request: AccountEvaluateConstraintsRequest) => Promise<EvaluateConstraintsResponse | undefined>;
+    }): JSX_2.Element;
     displayName: string;
 };
 
@@ -104,6 +108,14 @@ declare type BaseProps = {
         invoiceDocument?: string;
         installmentPlanName?: string;
     };
+    /**
+     * Optional dependency map for account constraints
+     */
+    dependencyMap?: DependencyMapResponse;
+    /**
+     * Optional function to evaluate constraints for the account
+     */
+    getEvaluatedConstraints?: (request: AccountEvaluateConstraintsRequest) => Promise<EvaluateConstraintsResponse | undefined>;
 };
 
 /**
@@ -337,7 +349,9 @@ declare type Props_2 = {
     /**
      * The function to call when the form is submitted. It will create an QuoteRequest from the form data.
      */
-    handleSubmit: (data: QuoteRequest) => void;
+    handleSubmit: (data: QuoteRequest, staticData?: {
+        [key: string]: any;
+    }) => void;
     /**
      * Set to true when the form is submitting to set fields to readonly and disable the submit button
      */
@@ -373,6 +387,11 @@ declare type Props_2 = {
      * default is false
      */
     hideAdvancedFields?: boolean;
+    /**
+     * Whether to hide the static data fields
+     * default is false
+     */
+    hideStaticDataFields?: boolean;
     /**
      * Whether to hide the coverage terms fields
      * default is false
@@ -396,14 +415,14 @@ declare type Props_2 = {
      *		}
      *	});
      */
-    dependencyMap?: QuoteDependencyMapResponse;
+    dependencyMap?: DependencyMapResponse;
     /**
      * 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} quoteLocator - The locator of the quote
      * @param {string} locator - The locator of the element to evaluate constraints for
      * @example
      * const getEvaluatedConstraints = async (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => {
@@ -419,7 +438,7 @@ declare type Props_2 = {
      * 	return data;
      * 	}
      */
-    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
+    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, quoteLocator: string, locator: string) => Promise<EvaluateConstraintsResponse | undefined>;
     /**
      * Whether to hide all fields
      */
@@ -450,6 +469,16 @@ declare type Props_2 = {
         truthyLabel?: string;
         falsyLabel?: string;
         installmentPlanName?: string;
+        staticData?: string;
+    };
+    /**
+     * Default open state for advanced and static data fields
+     * If not provided, the advanced fields will be closed and static data fields will be open
+     * Default value is { advancedFields: false, staticDataFields: true }
+     */
+    defaultOpen?: {
+        advancedFields?: boolean;
+        staticDataFields?: boolean;
     };
 };
 
@@ -530,7 +559,7 @@ declare type Props_3 = {
      *		}
      *	});
      */
-    dependencyMap?: QuoteDependencyMapResponse;
+    dependencyMap?: DependencyMapResponse;
     /**
      * Evaluates constraints for the quote to determine the values of other fields
      *
@@ -553,7 +582,7 @@ declare type Props_3 = {
      * 	return data;
      * 	}
      */
-    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
+    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<EvaluateConstraintsResponse | undefined>;
     /**
      * Custom form styling
      * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
@@ -887,7 +916,7 @@ declare type Props_8 = {
      *		}
      *	});
      */
-    dependencyMap?: QuoteDependencyMapResponse;
+    dependencyMap?: DependencyMapResponse;
     /**
      * Evaluates constraints for the quote to determine the values of other fields
      *
@@ -910,7 +939,7 @@ declare type Props_8 = {
      * 	return data;
      * 	}
      */
-    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
+    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<EvaluateConstraintsResponse | undefined>;
     /**
      * Custom form styling
      * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md