@socotra/ec-react-components 2.12.0-next.2 → 2.12.0-next.4

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { AccountConfigRecord } from '@socotra/ec-react-schemas';
-import { AccountRequest } from '@socotra/ec-react-schemas';
+import { AccountCreateRequest } 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';
@@ -39,11 +40,88 @@ export declare const AccountForm: {
     displayName: string;
 };
 
+declare type BaseProps = {
+    /**
+     * The resolved data model for **all** accounts retrieved from the data model response
+     */
+    accountsModel: AccountConfigRecord;
+    /**
+     * The account type to use for the form, used to pick the correct data model from the accountsModel
+     */
+    accountType: keyof AccountConfigRecord;
+    /**
+     * The custom data types for the configuration that may be referenced by the account's data model
+     */
+    dataTypes?: DataTypeConfigRecord;
+    advancedOptions?: {
+        /**
+         * The auto renewal plans for the account
+         */
+        autoRenewalPlans?: string[];
+        /**
+         * The delinquency plans available for the account
+         */
+        delinquencyPlans?: string[];
+        /**
+         * The excess credit plans available for the account
+         */
+        excessCreditPlans?: string[];
+        /**
+         * The shortfall tolerance plans available for the account
+         */
+        shortfallTolerancePlans?: string[];
+        /**
+         * The invoice documents available for the account
+         */
+        invoiceDocument?: string[];
+    };
+    /**
+     * 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;
+    /**
+     * Prevents the form from resetting when disabled
+     * default is true
+     */
+    preventFormResetOnDisabled?: boolean;
+    /**
+     * The default values for the form
+     */
+    defaultValues?: Partial<AccountResponse> & {
+        autoValidate?: boolean;
+    };
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * The text to display on the submit button
+     */
+    submitButtonText?: string;
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+    titles?: {
+        seeAdvancedDetails?: string;
+        truthyLabel?: string;
+        falsyLabel?: string;
+    };
+};
+
 /**
  * `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, titles, }: Props_9): JSX_2.Element;
+    ({ transactionSnapshot, handleSubmit, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms: coverageTermsDataModel, titles, }: Props_9): JSX_2.Element;
     displayName: string;
 };
 
@@ -51,7 +129,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, coverageTerms, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, submitButtonText, id, titles, getEvaluatedConstraints, dependencyMap, }: Props_3): JSX_2.Element;
+    ({ elementModel, dataTypes, disabled, handleSubmit, dataModel, coverageTerms: coverageTermsDataModel, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, submitButtonText, id, titles, getEvaluatedConstraints, dependencyMap, }: Props_3): JSX_2.Element;
     displayName: string;
 };
 
@@ -93,7 +171,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, coverageTerms, titles, getEvaluatedConstraints, dependencyMap, }: Props_8): JSX_2.Element;
+    ({ elementResponse, handleSubmit, paramsChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms: coverageTermsDataModel, titles, getEvaluatedConstraints, dependencyMap, }: Props_8): JSX_2.Element;
     displayName: string;
 };
 
@@ -121,90 +199,19 @@ export declare const PolicyForm: {
     displayName: string;
 };
 
-declare type Props = {
+declare type Props = (BaseProps & {
+    account: AccountResponse;
     /**
-     * The resolved data model for **all** accounts retrieved from the data model response
-     */
-    accountsModel: AccountConfigRecord;
-    /**
-     * The account type to use for the form, used to pick the correct data model from the accountsModel
-     */
-    accountType: keyof AccountConfigRecord;
-    /**
-     * The custom data types for the configuration that may be referenced by the account's data model
-     */
-    dataTypes?: DataTypeConfigRecord;
-    advancedOptions?: {
-        /**
-         * The auto renewal plans for the account
-         */
-        autoRenewalPlans?: string[];
-        /**
-         * The delinquency plans available for the account
-         */
-        delinquencyPlans?: string[];
-        /**
-         * The excess credit plans available for the account
-         */
-        excessCreditPlans?: string[];
-        /**
-         * The shortfall tolerance plans available for the account
-         */
-        shortfallTolerancePlans?: string[];
-        /**
-         * The invoice documents available for the account
-         */
-        invoiceDocument?: string[];
-    };
-    /**
-     * The function to call when the form is submitted. It will create an AccountRequest from the form data.
+     * The function to call when the form is submitted. It will create an AccountUpdateRequest from the form data.
      */
-    handleSubmit: (data: AccountRequest) => void;
+    handleSubmit: (data: AccountUpdateRequest) => void;
+}) | (BaseProps & {
     /**
-     * Set to true when the form is submitting to set fields to readonly and disable the submit button
+     * The function to call when the form is submitted. It will create an AccountCreateRequest from the form data.
      */
-    isSubmitting?: boolean;
-    /**
-     * Disables the form
-     */
-    disabled?: boolean;
-    /**
-     * Prevents the form from resetting when disabled
-     * default is true
-     */
-    preventFormResetOnDisabled?: boolean;
-    /**
-     * The account object to put the form in update mode
-     */
-    account?: AccountResponse;
-    /**
-     * The default values for the form
-     */
-    defaultValues?: Partial<AccountResponse> & {
-        autoValidate?: boolean;
-    };
-    /**
-     * Hides the submit button
-     */
-    hideSubmitButton?: boolean;
-    /**
-     * The text to display on the submit button
-     */
-    submitButtonText?: string;
-    /**
-     * Whether to validate the form on submit
-     */
-    validateOnSubmit?: boolean;
-    /**
-     * ID for the form wrapper
-     * */
-    id?: string;
-    titles?: {
-        seeAdvancedDetails?: string;
-        truthyLabel?: string;
-        falsyLabel?: string;
-    };
-};
+    account: undefined;
+    handleSubmit: (data: AccountCreateRequest) => void;
+});
 
 declare type Props_10 = {
     /**