@socotra/ec-react-components 2.5.1-next.9 → 2.6.0

package/dist/index.d.ts

@@ -23,7 +23,15 @@ 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: {
-    ({ accountsModel, accountType, dataTypes, advancedOptions, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, validateOnSubmit, account, defaultValues, submitButtonText, id, }: Props): JSX_2.Element;
+    ({ accountsModel, accountType, dataTypes, advancedOptions, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, validateOnSubmit, account, defaultValues, submitButtonText, id, titles, }: Props): JSX_2.Element;
+    displayName: 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_6): JSX_2.Element;
     displayName: string;
 };
 
@@ -31,7 +39,15 @@ export declare const AccountForm: {
  * 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, }: Props_3): JSX_2.Element;
+    ({ elementModel, dataTypes, disabled, handleSubmit, coverageTerms, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, submitButtonText, id, titles, }: Props_3): JSX_2.Element;
+    displayName: string;
+};
+
+/**
+ * `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, }: Props_5): JSX_2.Element;
     displayName: string;
 };
 
@@ -39,7 +55,7 @@ export declare const ElementForm: {
  * 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 PolicyForm: {
-    ({ policy, segment, dataModel, id, title, }: Props_4): JSX_2.Element;
+    ({ policy, segment, dataModel, id, titles, }: Props_4): JSX_2.Element;
     displayName: string;
 };
 
@@ -121,6 +137,9 @@ declare type Props = {
      * ID for the form wrapper
      * */
     id?: string;
+    titles?: {
+        seeAdvancedDetails?: string;
+    };
 };
 
 declare type Props_2 = {
@@ -169,6 +188,21 @@ declare type Props_2 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Titles for the form
+     */
+    titles?: {
+        details?: string;
+        seeAdvancedDetails?: string;
+        coverageTerms?: string;
+        currency?: string;
+        timezone?: string;
+        billingLevel?: string;
+        billingTrigger?: string;
+        durationBasis?: string;
+        delinquencyPlanName?: string;
+        autoRenewalPlanName?: string;
+    };
 };
 
 declare type Props_3 = {
@@ -222,6 +256,12 @@ declare type Props_3 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * Titles for the form
+     */
+    titles?: {
+        coverageTerms?: string;
+    };
 };
 
 declare type Props_4 = {
@@ -242,12 +282,82 @@ declare type Props_4 = {
      * */
     id?: string;
     /**
-     * Form title
+     * Titles
      */
-    title?: string;
+    titles?: {
+        formTitle?: string;
+        seeAdvancedDetails?: string;
+    };
 };
 
 declare type Props_5 = {
+    /**
+     * The transaction snapshot object
+     */
+    elementResponse: ElementResponse;
+    /**
+     * The params change instruction for the transaction, usually created when the transaction is first created
+     */
+    paramsChangeInstruction: ParamsChangeInstructionResponse;
+    /**
+     * The product model for the transaction, taken from the tenant data model and product name
+     */
+    productModel: ProductConfig;
+    /**
+     * The coverage terms for the transaction, taken from the tenant data model
+     */
+    coverageTerms: CoverageTermsConfigRecord;
+    /**
+     * 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 `ElementRequest` from the form data.
+     */
+    handleSubmit: (data: ElementRequest) => void;
+    /**
+     * The modify change instruction for the transaction, taken from the transaction stack of the transaction. For the form, use the last in the stack.
+     */
+    element?: ElementResponse;
+    /**
+     * Disables the form
+     */
+    disabled?: boolean;
+    /**
+     * Set to true when the form is submitting to set fields to readonly and disable the submit button
+     */
+    isSubmitting?: boolean;
+    /**
+     * Prevents the form from resetting when disabled
+     * default is true
+     */
+    preventFormResetOnDisabled?: boolean;
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * The text to display on the submit button
+     */
+    submitButtonText?: string;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+    /**
+     * Form titles
+     */
+    titles?: {
+        formTitle?: string;
+        coverageTerms?: string;
+    };
+};
+
+declare type Props_6 = {
     /**
      * The transaction snapshot object
      */
@@ -269,7 +379,7 @@ declare type Props_5 = {
      */
     dataTypes: DataTypeConfigRecord;
     /**
-     * The function to call when the form is submitted. It will create an array of ParamsChangeInstructionCreateRequest and ModifyChangeInstructionCreateRequest from the form data.
+     * The function to call when the form is submitted. It will create an array of `ParamsChangeInstructionCreateRequest` and `ModifyChangeInstructionCreateRequest` from the form data.
      */
     handleSubmit: (data: [
     ParamsChangeInstructionCreateRequest,
@@ -279,10 +389,6 @@ declare type Props_5 = {
      * The modify change instruction for the transaction, taken from the transaction stack of the transaction. For the form, use the last in the stack.
      */
     modifyChangeInstruction?: ModifyChangeInstructionResponse;
-    /**
-     * The title of the form, if unused the title will default to 'Transaction' or the product model display name
-     */
-    title?: string;
     /**
      * Disables the form
      */
@@ -312,21 +418,20 @@ declare type Props_5 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * The form titles
+     */
+    titles?: {
+        coverageTerms?: string;
+        formTitle?: string;
+    };
 };
 
 /**
  * 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, submitButtonText, id, }: Props_2): JSX_2.Element;
-    displayName: string;
-};
-
-/**
- * TransactionForm is a form for updating a transaction on an issued policy. It requires a transactionSnapshot, paramsChangeInstruction (created when the transaction is created), and some other configuration settings from the tenant data model.
- */
-export declare const TransactionForm: {
-    ({ transactionSnapshot, title, handleSubmit, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, }: Props_5): JSX_2.Element;
+    ({ quote, dataModel, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, validateOnSubmit, hideSubmitButton, submitButtonText, id, titles, }: Props_2): JSX_2.Element;
     displayName: string;
 };