@socotra/ec-react-components 2.5.1-next.0 → 2.5.1-next.10

package/dist/index.d.ts

@@ -8,10 +8,16 @@ import { ElementConfig } from '@socotra/ec-react-schemas';
 import { ElementRequest } from '@socotra/ec-react-schemas';
 import { ElementResponse } from '@socotra/ec-react-schemas';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
+import { ModifyChangeInstructionResponse } from '@socotra/ec-react-schemas';
+import { ParamsChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
+import { ParamsChangeInstructionResponse } from '@socotra/ec-react-schemas';
 import { PolicyResponse } from '@socotra/ec-react-schemas';
+import { ProductConfig } 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';
+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.
@@ -21,6 +27,14 @@ export declare const AccountForm: {
     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, title, handleSubmit, coverageTermTitle, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, }: Props_6): JSX_2.Element;
+    displayName: string;
+};
+
 /**
  * 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.
  */
@@ -29,6 +43,14 @@ export declare const ElementForm: {
     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: {
+    ({ segmentResponse, title, handleSubmit, paramsChangeInstruction, coverageTermTitle, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, }: Props_5): JSX_2.Element;
+    displayName: 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.
  */
@@ -151,9 +173,6 @@ declare type Props_2 = {
      * Hides the submit button
      */
     hideSubmitButton?: boolean;
-    /**
-     * The text to display on the submit button
-     */
     /**
      * Whether to validate the form on submit
      */
@@ -244,6 +263,145 @@ declare type Props_4 = {
     title?: string;
 };
 
+declare type Props_5 = {
+    /**
+     * The transaction snapshot object
+     */
+    segmentResponse: SegmentResponse;
+    /**
+     * 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;
+    /**
+     * The title of the form, if unused the title will default to 'Transaction' or the product model display name
+     */
+    title?: string;
+    /**
+     * The title of the coverage term section
+     */
+    coverageTermTitle?: string;
+    /**
+     * 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;
+};
+
+declare type Props_6 = {
+    /**
+     * The transaction snapshot object
+     */
+    transactionSnapshot: TransactionSnapshotResponse;
+    /**
+     * 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 array of `ParamsChangeInstructionCreateRequest` and `ModifyChangeInstructionCreateRequest` from the form data.
+     */
+    handleSubmit: (data: [
+    ParamsChangeInstructionCreateRequest,
+    ModifyChangeInstructionCreateRequest
+    ]) => 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.
+     */
+    modifyChangeInstruction?: ModifyChangeInstructionResponse;
+    /**
+     * The title of the coverage terms section
+     */
+    coverageTermTitle?: string;
+    /**
+     * The title of the form, if unused the title will default to 'Transaction' or the product model display name
+     */
+    title?: string;
+    /**
+     * 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;
+};
+
 /**
  * QuoteForm is a form for updating a quote. It required a product data model, custom data types, and quote object to render the form.
  */