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

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { AccountRequest } from '@socotra/ec-react-schemas';
 import { AccountResponse } 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 { CurrencyType } from '@socotra/ec-react-schemas';
 import { DataModel } from '@socotra/ec-react-schemas';
 import { DataTypeConfigRecord } from '@socotra/ec-react-schemas';
@@ -38,7 +39,7 @@ export declare const AccountForm: {
  * `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_7): JSX_2.Element;
+    ({ transactionSnapshot, handleSubmit, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, titles, }: Props_8): JSX_2.Element;
     displayName: string;
 };
 
@@ -50,8 +51,11 @@ export declare const ElementForm: {
     displayName: string;
 };
 
+/**
+ * Apply a payment to an existing invoice form
+ */
 export declare const ExistingPaymentForm: {
-    (): JSX_2.Element;
+    ({ accountLocator, invoiceLocator, balance, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, id, titles, }: Props_6): JSX_2.Element;
     displayName: string;
 };
 
@@ -71,7 +75,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, }: Props_6): JSX_2.Element;
+    ({ elementResponse, handleSubmit, paramsChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, titles, getEvaluatedConstraints, dependencyMap, }: Props_7): JSX_2.Element;
     displayName: string;
 };
 
@@ -220,6 +224,44 @@ declare type Props_2 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * The dependency map for the quote's constraints (if any)
+     *
+     * This map must be provided to enable the form to evaluate constraints, retrieved by
+     *
+     * @example
+     *	const dependencyMap = await fetch(`/policy/${tenantLocator}/quotes/${locator}/constraints/dependency`, {
+     *		method: "GET",
+     *		headers: {
+     *			Authorization: `Bearer ${token}`,
+     *			"Content-Type": "application/json",
+     *		}
+     *	});
+     */
+    dependencyMap?: QuoteDependencyMapResponse;
+    /**
+     * 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} locator - The locator of the element to evaluate constraints for
+     * @example
+     * const getEvaluatedConstraints = async (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => {
+     * 	const response = await fetch(`/policy/${tenantLocator}/quotes/${locator}/constraints/evaluate`, {
+     * 		method: "POST",
+     * 		body: JSON.stringify(request),
+     * 		headers: {
+     * 			Authorization: `Bearer ${token}`,
+     * 			"Content-Type": "application/json",
+     * 		}
+     * 	});
+     * 	const data = await response.json();
+     * 	return data;
+     * 	}
+     */
+    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
     /**
      * Titles for the form
      */
@@ -420,6 +462,61 @@ declare type Props_5 = {
 };
 
 declare type Props_6 = {
+    /**
+     * Account locator
+     */
+    accountLocator: string;
+    /**
+     * Invoice locator
+     */
+    invoiceLocator: string;
+    /**
+     * The currency of the invoice
+     */
+    currency: CurrencyType;
+    /**
+     * Account balance
+     */
+    balance: number;
+    /**
+     * The function to call when the form is submitted. It will create an CreditDistributionRequest from the form data.
+     */
+    handleSubmit: (data: CreditDistributionRequest) => void;
+    /**
+     * 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;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
+    /**
+     * The text to display on the submit button
+     */
+    submitButtonText?: string;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+    /**
+     * Titles
+     */
+    titles?: {
+        formTitle?: string;
+        balance?: string;
+        amountToApply?: string;
+    };
+};
+
+declare type Props_7 = {
     /**
      * The transaction snapshot object
      */
@@ -477,6 +574,44 @@ declare type Props_6 = {
      * ID for the form wrapper
      * */
     id?: string;
+    /**
+     * The dependency map for the quote's constraints (if any)
+     *
+     * This map must be provided to enable the form to evaluate constraints, retrieved by
+     *
+     * @example
+     *	const dependencyMap = await fetch(`/policy/${tenantLocator}/quotes/${locator}/constraints/dependency`, {
+     *		method: "GET",
+     *		headers: {
+     *			Authorization: `Bearer ${token}`,
+     *			"Content-Type": "application/json",
+     *		}
+     *	});
+     */
+    dependencyMap?: QuoteDependencyMapResponse;
+    /**
+     * 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} locator - The locator of the element to evaluate constraints for
+     * @example
+     * const getEvaluatedConstraints = async (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => {
+     * 	const response = await fetch(`/policy/${tenantLocator}/quotes/${locator}/constraints/evaluate`, {
+     * 		method: "POST",
+     * 		body: JSON.stringify(request),
+     * 		headers: {
+     * 			Authorization: `Bearer ${token}`,
+     * 			"Content-Type": "application/json",
+     * 		}
+     * 	});
+     * 	const data = await response.json();
+     * 	return data;
+     * 	}
+     */
+    getEvaluatedConstraints?: (request: EvaluateConstraintsRequest, tenantLocator: string, locator: string) => Promise<ConstraintEvaluationResponse | undefined>;
     /**
      * Form titles
      */
@@ -486,7 +621,7 @@ declare type Props_6 = {
     };
 };
 
-declare type Props_7 = {
+declare type Props_8 = {
     /**
      * The transaction snapshot object
      */
@@ -560,7 +695,7 @@ declare type Props_7 = {
  * 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, titles, }: Props_2): JSX_2.Element;
+    ({ quote, dataModel, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, validateOnSubmit, hideSubmitButton, submitButtonText, id, titles, getEvaluatedConstraints, dependencyMap, }: Props_2): JSX_2.Element;
     displayName: string;
 };