@socotra/ec-react-utils 2.5.1-next.8 → 2.6.0

package/dist/index.d.ts

@@ -12,6 +12,7 @@ import { ParamsChangeInstructionCreateRequest } 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';
 
 declare type AnyObject = {
@@ -40,20 +41,35 @@ declare interface DataModelToJsonSchemaProps {
 }
 
 /**
- * The function `extractElementDataModel` extracts element data model based on a given quote, data
+ * The function `extractElementDataModelFromQuote` extracts element data model based on a given quote, data
  * model, and element locator.
  * @param  - - `quote`: A QuoteResponse object containing information about a quote.
  * @param  - - `dataModel`: A DataModel object containing information about a data model.
  * @param  - - `elementLocator`: A string containing the element locator.
- * @returns The function `extractElementDataModel` returns either an `ElementConfig` object or `false`
+ * @returns The function `extractElementDataModelFromQuote` returns either an `ElementConfig` object or `false`
  * based on the provided parameters and data model.
  */
-export declare const extractElementDataModel: ({ dataModel, quote, elementLocator, }: {
+export declare const extractElementDataModelFromQuote: ({ dataModel, quote, elementLocator, }: {
     quote: QuoteResponse;
     dataModel: DataModel;
     elementLocator: string;
 }) => ElementConfig | false;
 
+/**
+ * The function `extractElementDataModelFromSegment` extracts element data model based on a given segment, data
+ * model, and element locator.
+ * @param  - - `segment`: A SegmentResponse object containing information about a transaction or policy.
+ * @param  - - `dataModel`: A DataModel object containing information about a data model.
+ * @param  - - `elementLocator`: A string containing the element locator.
+ * @returns The function `extractElementDataModelFromSegment` returns either an `ElementConfig` object or `false`
+ * based on the provided parameters and data model.
+ */
+export declare const extractElementDataModelFromSegment: ({ dataModel, segment, elementLocator, }: {
+    segment: SegmentResponse;
+    dataModel: DataModel;
+    elementLocator: string;
+}) => ElementConfig | false;
+
 /**
  * The function `extractElementDataModelFromType` extracts element data model given a data model and
  * element type.
@@ -101,6 +117,74 @@ export declare const extractElementFromQuote: (quote: QuoteResponse, elementLoca
     } & any)[];
 });
 
+/**
+ * The function `extractElementFromSegment` takes a `SegmentResponse` object and an element locator string,
+ * and returns the element with the matching locator from the segment or its nested elements.
+ * @param {SegmentResponse} segment - The `segment` parameter is of type `SegmentResponse`, which is an object
+ * containing information about a segment.
+ * @param {string} elementLocator - The `elementLocator` parameter is a string that represents the
+ * locator of the element you want to extract from the `segment` object.
+ * @returns The function `extractElementFromSegment` returns the element from the `SegmentResponse` object
+ * that matches the provided `elementLocator`.
+ */
+export declare const extractElementFromSegment: (segment: SegmentResponse, elementLocator: string) => false | ({
+    locator: string;
+    type: string;
+    staticLocator: string;
+    data?: Record<string, any> | undefined;
+    coverageTerms?: Record<string, string> | undefined;
+    parentLocator?: string | undefined;
+    rootLocator?: string | undefined;
+    tenantLocator?: string | undefined;
+    originalEffectiveTime?: string | undefined;
+} & {
+    elements?: ({
+        locator: string;
+        type: string;
+        staticLocator: string;
+        data?: Record<string, any> | undefined;
+        coverageTerms?: Record<string, string> | undefined;
+        parentLocator?: string | undefined;
+        rootLocator?: string | undefined;
+        tenantLocator?: string | undefined;
+        originalEffectiveTime?: string | undefined;
+    } & any)[];
+});
+
+/**
+ * The function `extractElementFromTransactionSegment` takes a `SegmentResponse` object and an element locator string,
+ * and returns the element with the matching locator from the segment or its nested elements.
+ * @param {SegmentResponse} transactionSegment - The `transactionSegment` parameter is of type `SegmentResponse`, which is an object
+ * containing information about a transaction.
+ * @param {string} elementLocator - The `elementLocator` parameter is a string that represents the
+ * locator of the element you want to extract from the `transactionSegment` object.
+ * @returns The function `extractElementFromTransactionSegment` returns the element from the `SegmentResponse` object
+ * that matches the provided `elementLocator`.
+ */
+export declare const extractElementFromTransactionSegment: (transactionSegment: SegmentResponse, elementLocator: string) => false | ({
+    locator: string;
+    type: string;
+    staticLocator: string;
+    data?: Record<string, any> | undefined;
+    coverageTerms?: Record<string, string> | undefined;
+    parentLocator?: string | undefined;
+    rootLocator?: string | undefined;
+    tenantLocator?: string | undefined;
+    originalEffectiveTime?: string | undefined;
+} & {
+    elements?: ({
+        locator: string;
+        type: string;
+        staticLocator: string;
+        data?: Record<string, any> | undefined;
+        coverageTerms?: Record<string, string> | undefined;
+        parentLocator?: string | undefined;
+        rootLocator?: string | undefined;
+        tenantLocator?: string | undefined;
+        originalEffectiveTime?: string | undefined;
+    } & any)[];
+});
+
 export declare const extractElementsFromQuote: (elements: Array<ElementResponse>, elementType: string) => ({
     locator: string;
     type: string;
@@ -125,6 +209,30 @@ export declare const extractElementsFromQuote: (elements: Array<ElementResponse>
     } & any)[];
 })[];
 
+export declare const extractElementsFromTransactionSegment: (elements: Array<ElementResponse>, elementType: string) => ({
+    locator: string;
+    type: string;
+    staticLocator: string;
+    data?: Record<string, any> | undefined;
+    coverageTerms?: Record<string, string> | undefined;
+    parentLocator?: string | undefined;
+    rootLocator?: string | undefined;
+    tenantLocator?: string | undefined;
+    originalEffectiveTime?: string | undefined;
+} & {
+    elements?: ({
+        locator: string;
+        type: string;
+        staticLocator: string;
+        data?: Record<string, any> | undefined;
+        coverageTerms?: Record<string, string> | undefined;
+        parentLocator?: string | undefined;
+        rootLocator?: string | undefined;
+        tenantLocator?: string | undefined;
+        originalEffectiveTime?: string | undefined;
+    } & any)[];
+})[];
+
 /**
  * The function `extractProductDataModel` extracts product data model based on the product name from a
  * given data model.
@@ -152,6 +260,14 @@ export declare const extractProductElements: ({ dataModel, contents, }: {
     contents: string[];
 }) => ProductElementMap;
 
+/**
+ * `findElementInElementArray` is a utility function that takes an array of `ElementResponse` objects and an element locator string,
+ * @param elements - The `elements` parameter is an array of `ElementResponse` objects.
+ * @param elementLocator - The `elementLocator` parameter is a string that represents the locator of the element you want to extract from the `elements` array.
+ * @returns
+ */
+export declare const findElementInElementsArray: (elements: ElementResponse[], elementLocator: string) => ElementResponse | false;
+
 /**
  * The `getCoverageTermsDefaultValues` function extracts default coverage terms values from a
  * `CoverageTermsConfigRecord` object and sets them based on certain conditions.
@@ -167,6 +283,19 @@ export declare const getCoverageTermsDefaultValues: ({ coverageTermOptions, cove
     coverageTermDataModel: CoverageTermsConfigRecord;
 }) => Record<string, string>;
 
+export declare const getDefaultDraftTransactionValues: ({ transactionSnapshot, paramsChangeInstruction, modifyChangeInstruction, coverageTerms, }: {
+    transactionSnapshot: TransactionSnapshotResponse;
+    paramsChangeInstruction: ParamsChangeInstructionCreateRequest;
+    modifyChangeInstruction?: ModifyChangeInstructionCreateRequest;
+    coverageTerms: CoverageTermsConfigRecord;
+}) => {
+    default: {
+        newPolicyEndDate?: string | undefined;
+        effectiveTime: string;
+    };
+    coverageTerms: Record<string, string>;
+};
+
 /**
  * The function `getDefaultElementValues` returns a partial copy of an ElementResponse object with
  * default values for coverageTerms if not provided.
@@ -178,6 +307,22 @@ export declare const getCoverageTermsDefaultValues: ({ coverageTermOptions, cove
  */
 export declare const getDefaultElementValues: (element: ElementResponse, coverageTermDataModel: CoverageTermsConfigRecord) => Partial<ElementResponse>;
 
+/**
+ * The function `getDefaultInitializedTransactionValues` takes an `ElementResponse` object and a `CoverageTermsConfigRecord` object,
+ * and returns the default initialized transaction values for the element.
+ * @param {ElementResponse} elementResponse - The `elementResponse` parameter is of type `ElementResponse`, which is an object
+ * containing information about an element.
+ * @param {CoverageTermsConfigRecord} coverageTerms - The `coverageTerms` parameter is of type `CoverageTermsConfigRecord`, which is an object
+ * containing information about coverage terms.
+ * @returns The function `getDefaultInitializedTransactionValues` returns the default initialized transaction values for the element.
+ */
+export declare const getDefaultInitializedTransactionValues: ({ elementResponse, coverageTerms, }: {
+    elementResponse: ElementResponse;
+    coverageTerms: CoverageTermsConfigRecord;
+}) => {
+    coverageTerms?: Record<string, string> | undefined;
+};
+
 /**
  * The `getDefaultQuoteValues` function extracts default values from a `QuoteResponse`
  * object and sets them based on certain conditions.
@@ -211,20 +356,15 @@ export declare const getDefaultQuoteValues: (quote: QuoteResponse, productModel:
     coverageTerms: Record<string, string>;
 };
 
-export declare const getDefaultTransactionValues: ({ transactionSnapshot, paramsChangeInstruction, modifyChangeInstruction, coverageTerms, }: {
-    transactionSnapshot: TransactionSnapshotResponse;
-    paramsChangeInstruction: ParamsChangeInstructionCreateRequest;
-    modifyChangeInstruction?: ModifyChangeInstructionCreateRequest;
-    coverageTerms: CoverageTermsConfigRecord;
-}) => {
-    default: {
-        newPolicyEndDate?: string | undefined;
-        effectiveTime: string;
-    };
-    coverageTerms: Record<string, string>;
+export declare const getElementTransactionUpdateRequestFromFormData: ({ data, elementResponse, locator, }: TransactionFormData) => {
+    locator: string;
+    removeCoverageTerms?: Record<string, unknown> | undefined;
+    removeData?: Record<string, unknown> | undefined;
+    setCoverageTerms?: Record<string, unknown> | undefined;
+    setData?: Record<string, unknown> | undefined;
 };
 
-export declare const getModifyChangeInstructionCreateRequestFromFormData: ({ data, transactionSnapshot, staticLocator, }: TransactionFormData) => {
+export declare const getModifyChangeInstructionCreateRequestFromFormData: ({ data, transactionSnapshot, staticLocator, }: TransactionFormData_2) => {
     staticLocator: string;
     action: "modify";
     removeCoverageTerms?: Record<string, any> | undefined;
@@ -238,7 +378,7 @@ export declare const getModifyChangeInstructionCreateRequestFromFormData: ({ dat
  * @param data - form data
  * @returns ParamsChangeInstructionCreateRequest
  */
-export declare const getParamsChangeInstructionCreateRequestFromFormData: ({ data, }: TransactionFormData_2) => ParamsChangeInstructionCreateRequest;
+export declare const getParamsChangeInstructionCreateRequestFromFormData: ({ data, }: TransactionFormData_3) => ParamsChangeInstructionCreateRequest;
 
 /**
  * The function `getQuoteRequest` processes form data to create a `QuoteRequest` object.
@@ -306,6 +446,30 @@ export declare const splitInputAndQuantifier: (input: string | undefined) => {
 };
 
 declare interface TransactionFormData {
+    data: {
+        default?: {
+            effectiveTime: string;
+            newPolicyEndDate?: string;
+        };
+        advanced?: {
+            currency?: string;
+            timezone?: string;
+            billingPlan?: string;
+            defaultTermDuration?: string;
+            installmentPlan?: string;
+            durationBasis?: string;
+            delinquencyPlanName?: string;
+        };
+        coverageTerms?: {
+            [key: string]: string;
+        };
+        [key: string]: any;
+    };
+    locator: string;
+    elementResponse: ElementResponse;
+}
+
+declare interface TransactionFormData_2 {
     data: {
         default?: {
             effectiveTime: string;
@@ -329,7 +493,7 @@ declare interface TransactionFormData {
     transactionSnapshot: TransactionSnapshotResponse;
 }
 
-declare interface TransactionFormData_2 {
+declare interface TransactionFormData_3 {
     data: {
         default: {
             effectiveTime: string;