@socotra/ec-react-components 2.19.3-next.4 → 2.19.3-next.5

package/dist/index.d.ts

@@ -15,6 +15,7 @@ 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 { ForwardRefExoticComponent } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
 import { ModifyChangeInstructionResponse } from '@socotra/ec-react-schemas';
@@ -27,6 +28,7 @@ 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 { RefAttributes } from 'react';
 import { ReversalTypeConfigRecord } from '@socotra/ec-react-schemas';
 import { SegmentResponse } from '@socotra/ec-react-schemas';
 import { TransactionMethodEnum } from '@socotra/ec-react-schemas';
@@ -36,7 +38,7 @@ 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, }: Props): JSX_2.Element;
+    ({ dataModel, accountType, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, hideAdvancedFields, validateOnSubmit, account, submitButtonText, id, titles, styles, }: Props): JSX_2.Element;
     displayName: string;
 };
 
@@ -83,6 +85,11 @@ declare type BaseProps = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     titles?: {
         seeAdvancedDetails?: string;
         truthyLabel?: string;
@@ -101,7 +108,7 @@ declare type BaseProps = {
  * `DraftTransactionForm` is a form for updating a transaction on an issued policy. It requires a transaction in a `draft` state, a `transactionSnapshot`, `paramsChangeInstruction` (created when the transaction is created), and data types / product model / coverage terms from the tenant data model.
  */
 export declare const DraftTransactionForm: {
-    ({ transactionSnapshot, handleSubmit, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms: coverageTermsDataModel, titles, }: Props_9): JSX_2.Element;
+    ({ transactionSnapshot, handleSubmit, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms: coverageTermsDataModel, titles, styles, }: Props_9): JSX_2.Element;
     displayName: string;
 };
 
@@ -109,7 +116,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, dataModel, timezone, coverageTerms: coverageTermsDataModel, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, hideAllFields, hideCoverageTerms, submitButtonText, id, titles, getEvaluatedConstraints, dependencyMap, quote, }: Props_3): JSX_2.Element;
+    ({ elementModel, dataTypes, disabled, handleSubmit, dataModel, timezone, coverageTerms: coverageTermsDataModel, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, hideAllFields, hideCoverageTerms, submitButtonText, id, titles, getEvaluatedConstraints, dependencyMap, quote, styles, }: Props_3): JSX_2.Element;
     displayName: string;
 };
 
@@ -117,7 +124,7 @@ export declare const ElementForm: {
  * Apply a payment to an existing invoice form
  */
 export declare const ExistingPaymentForm: {
-    ({ accountLocator, invoiceLocator, balance, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, id, titles, invoiceBalance, }: Props_6): JSX_2.Element;
+    ({ accountLocator, invoiceLocator, balance, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, id, titles, invoiceBalance, styles, }: Props_6): JSX_2.Element;
     displayName: string;
 };
 
@@ -151,7 +158,7 @@ declare type GetPaymentFormDefaultFieldsProps = {
  * `InitializedTransactionForm` is a form for updating a transaction on an issued policy. It requires a transaction in an `initialized` state, the current `segment`, and data types / product model / coverage terms from the tenant data model.
  */
 export declare const InitializedTransactionForm: {
-    ({ elementResponse, handleSubmit, paramsChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, timezone, coverageTerms: coverageTermsDataModel, titles, getEvaluatedConstraints, dependencyMap, }: Props_8): JSX_2.Element;
+    ({ elementResponse, handleSubmit, paramsChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, timezone, coverageTerms: coverageTermsDataModel, titles, getEvaluatedConstraints, dependencyMap, styles, }: Props_8): JSX_2.Element;
     displayName: string;
 };
 
@@ -159,7 +166,7 @@ export declare const InitializedTransactionForm: {
  * DisbursementForm is a form for creating a disbursement.
  */
 export declare const NewDisbursementForm: {
-    ({ accountLocator, accountBalance, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, dataModel, id, titles, }: Props_10): JSX_2.Element;
+    ({ accountLocator, accountBalance, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, dataModel, id, titles, styles, }: Props_10): JSX_2.Element;
     displayName: string;
 };
 
@@ -167,7 +174,7 @@ export declare const NewDisbursementForm: {
  * PaymentForm is a form for making a payment.
  */
 export declare const NewPaymentForm: {
-    ({ accountLocator, invoiceLocator, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, dataModel, id, titles, invoiceBalance, }: Props_5): JSX_2.Element;
+    ({ accountLocator, invoiceLocator, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, dataModel, id, titles, invoiceBalance, styles, }: Props_5): JSX_2.Element;
     displayName: string;
 };
 
@@ -175,7 +182,7 @@ export declare const NewPaymentForm: {
  * PolicyForm is a form for updating a policy. It required a product data model, custom data types, and policy object to render the form.
  */
 export declare const PolicyForm: {
-    ({ policy, segment, dataModel, hideAllFields, id, titles, }: Props_4): JSX_2.Element;
+    ({ policy, segment, dataModel, hideAllFields, id, titles, styles, }: Props_4): JSX_2.Element;
     displayName: string;
 };
 
@@ -238,6 +245,11 @@ declare type Props_10 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Titles
      */
@@ -257,10 +269,6 @@ declare type Props_2 = {
      * The resolved data model retrieved from data model response
      */
     dataModel: DataModel;
-    /**
-     * The custom data types for the configuration that may be referenced by the elementModel
-     */
-    dataTypes?: DataTypeConfigRecord;
     /**
      * The function to call when the form is submitted. It will create an QuoteRequest from the form data.
      */
@@ -355,6 +363,11 @@ declare type Props_2 = {
      * The hidden exception for the form
      */
     hiddenExceptions?: string[];
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Titles for the form
      */
@@ -476,6 +489,11 @@ declare type Props_3 = {
      * 	}
      */
     getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Titles for the form
      */
@@ -512,6 +530,11 @@ declare type Props_4 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Whether to hide all fields
      */
@@ -583,6 +606,11 @@ declare type Props_5 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Titles
      */
@@ -642,6 +670,11 @@ declare type Props_6 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Titles
      */
@@ -698,6 +731,11 @@ declare type Props_7 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Titles
      */
@@ -808,6 +846,11 @@ declare type Props_8 = {
      * 	}
      */
     getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * Form titles
      */
@@ -880,6 +923,11 @@ declare type Props_9 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Custom form styling
+     * See https://github.com/eclipsesource/jsonforms/blob/master/packages/vanilla-renderers/Styles.md
+     */
+    styles?: StyleDefinition[];
     /**
      * The form titles
      */
@@ -894,17 +942,24 @@ declare type Props_9 = {
 /**
  * QuoteForm is a form for updating a quote. It required a product data model, custom data types, and quote object to render the form.
  */
-export declare const QuoteForm: {
-    ({ quote, dataModel, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, validateOnSubmit, hideSubmitButton, hideDefaultFields, hideAdvancedFields, hideCoverageTerms, submitButtonText, id, titles, getEvaluatedConstraints, dependencyMap, hideAllFields, hiddenExceptions, }: Props_2): JSX_2.Element;
-    displayName: string;
+export declare const QuoteForm: ForwardRefExoticComponent<Props_2 & RefAttributes<QuoteFormRef>>;
+
+export declare type QuoteFormRef = {
+    getValues: () => unknown;
+    subscribeOnChange: (field: string, callback: (value: unknown) => void) => () => void;
 };
 
 /**
  * Apply a payment to an existing invoice form
  */
 export declare const ReversePaymentForm: {
-    ({ amount, reversalTypes, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, id, titles, }: Props_7): JSX_2.Element;
+    ({ amount, reversalTypes, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, id, titles, styles, }: Props_7): JSX_2.Element;
     displayName: string;
 };
 
+export declare type StyleDefinition = {
+    name: 'array.layout' | 'array.button' | 'array.children' | 'categorization' | 'categorization.master' | 'categorization.detail' | 'category.subcategories' | 'category.group' | 'array.table' | 'array.table.table' | 'array.table.label' | 'array.table.button' | 'array.table.validation' | 'array.table.validation.error' | 'array.validation.error' | 'group.layout' | 'group.label' | 'group.layout.item' | 'horizontal.layout' | 'horizontal.layout.item' | 'vertical.layout' | 'vertical.layout.item' | 'control' | 'control.input' | 'control.checkbox' | 'control.label' | 'control.validation' | 'control.validation.error' | 'input.description';
+    classNames: string[];
+};
+
 export { }