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

package/dist/index.d.ts

@@ -1,11 +1,14 @@
 import { AccountConfigRecord } 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 { DataFieldValue } from '@socotra/ec-react-schemas';
 import { DataModel } from '@socotra/ec-react-schemas';
 import { DataTypeConfigRecord } from '@socotra/ec-react-schemas';
 import { ElementConfig } from '@socotra/ec-react-schemas';
+import { ElementRequest } from '@socotra/ec-react-schemas';
 import { ElementResponse } from '@socotra/ec-react-schemas';
 import { ErrorObject } from 'ajv';
 import { FieldConfigRecord } from '@socotra/ec-react-schemas';
@@ -20,6 +23,38 @@ 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';
+import { z } from 'zod';
+
+/**
+ * The type `QuoteRequestAdvancedFields` is a zod infererred type that represents the advanced fields of a quote request.
+ * It follows the fields that are found on the QuoteForm in @socotra/ec-react-components
+ */
+declare type AccountRequestAdvancedFields = z.infer<typeof advancedFieldSchema_2>;
+
+declare const advancedFieldSchema: z.ZodRecord<z.ZodEnum<["currency", "timezone", "billingLevel", "billingTrigger", "durationBasis", "delinquencyPlanName", "autoRenewalPlanName"]>, z.ZodOptional<z.ZodString>>;
+
+declare const advancedFieldSchema_2: z.ZodObject<{
+    autoRenewalPlanName: z.ZodOptional<z.ZodString>;
+    delinquencyPlanName: z.ZodOptional<z.ZodString>;
+    excessCreditPlanName: z.ZodOptional<z.ZodString>;
+    shortfallTolerancePlanName: z.ZodOptional<z.ZodString>;
+    billingLevel: z.ZodOptional<z.ZodEnum<["account", "policy"]>>;
+    invoiceDocument: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    billingLevel?: "account" | "policy" | undefined;
+    delinquencyPlanName?: string | undefined;
+    autoRenewalPlanName?: string | undefined;
+    excessCreditPlanName?: string | undefined;
+    shortfallTolerancePlanName?: string | undefined;
+    invoiceDocument?: string | undefined;
+}, {
+    billingLevel?: "account" | "policy" | undefined;
+    delinquencyPlanName?: string | undefined;
+    autoRenewalPlanName?: string | undefined;
+    excessCreditPlanName?: string | undefined;
+    shortfallTolerancePlanName?: string | undefined;
+    invoiceDocument?: string | undefined;
+}>;
 
 declare type AnyObject = {
     [key: string]: any;
@@ -61,6 +96,16 @@ declare interface DataModelToJsonSchemaProps {
     falsyLabel?: string;
 }
 
+declare interface ElementFormData {
+    data: {
+        [key: string]: any;
+    };
+    coverageTerms?: {
+        [key: string]: string;
+    };
+    element: ElementResponse;
+}
+
 /**
  * The function `extractElementFromElement takes a `QuoteResponse`, `SegmentResponse` or `ElementResponse` object and an element locator string,
  * and returns the element with the matching locator from the quote or its nested elements.
@@ -214,6 +259,26 @@ export declare const extractProductElements: ({ dataModel, contents, }: {
     contents: string[];
 }) => ProductElementMap;
 
+export declare function getAccountRequest(params: {
+    data: {
+        [key: string]: any;
+    };
+    advanced: AccountRequestAdvancedFields;
+    type: string;
+    autoValidate: boolean;
+    account: AccountResponse;
+}): AccountUpdateRequest;
+
+export declare function getAccountRequest(params: {
+    data: {
+        [key: string]: any;
+    };
+    advanced: AccountRequestAdvancedFields;
+    type: string;
+    autoValidate: boolean;
+    account?: undefined;
+}): AccountCreateRequest;
+
 /**
  * The `getCoverageTermsDefaultValues` function extracts default coverage terms values from a
  * `CoverageTermsConfigRecord` object and sets them based on certain conditions.
@@ -224,9 +289,10 @@ export declare const extractProductElements: ({ dataModel, contents, }: {
  * @returns The `getCoverageTermsDefaultValues` function returns an object with default values for
  * coverage terms.
  */
-export declare const getCoverageTermsDefaultValues: ({ coverageTermOptions, coverageTermDataModel, }: {
+export declare const getCoverageTermsDefaultValues: ({ coverageTermOptions, coverageTermDataModel, coverageTerms, }: {
     coverageTermOptions: Record<string, string>;
     coverageTermDataModel?: CoverageTermsConfigRecord;
+    coverageTerms: string[];
 }) => Record<string, string>;
 
 export declare const getDefaultAccountFormValues: ({ defaultValues, accountType, account, }: {
@@ -249,11 +315,12 @@ export declare const getDefaultAccountFormValues: ({ defaultValues, accountType,
     saveAsDraft: boolean;
 };
 
-export declare const getDefaultDraftTransactionValues: ({ transactionSnapshot, paramsChangeInstruction, modifyChangeInstruction, coverageTerms, }: {
+export declare const getDefaultDraftTransactionValues: ({ transactionSnapshot, paramsChangeInstruction, modifyChangeInstruction, coverageTerms, coverageTermsDataModel, }: {
     transactionSnapshot: TransactionSnapshotResponse;
     paramsChangeInstruction: ParamsChangeInstructionCreateRequest;
+    coverageTerms: string[];
     modifyChangeInstruction?: ModifyChangeInstructionCreateRequest;
-    coverageTerms?: CoverageTermsConfigRecord;
+    coverageTermsDataModel?: CoverageTermsConfigRecord;
 }) => {
     default: {
         newPolicyEndDate?: string | undefined;
@@ -271,7 +338,7 @@ export declare const getDefaultDraftTransactionValues: ({ transactionSnapshot, p
  * @returns A partial ElementResponse object is being returned, with the data from the input element
  * and the coverageTerms property set to element.coverageTerms if it exists, otherwise an empty object.
  */
-export declare const getDefaultElementValues: (element: ElementResponse, coverageTermDataModel?: CoverageTermsConfigRecord) => Partial<ElementResponse>;
+export declare const getDefaultElementValues: (element: ElementResponse, coverageTerms: string[], coverageTermDataModel?: CoverageTermsConfigRecord) => Partial<ElementResponse>;
 
 /**
  * The function `getDefaultInitializedTransactionValues` takes an `ElementResponse` object and a `CoverageTermsConfigRecord` object,
@@ -282,9 +349,10 @@ export declare const getDefaultElementValues: (element: ElementResponse, coverag
  * containing information about coverage terms.
  * @returns The function `getDefaultInitializedTransactionValues` returns the default initialized transaction values for the element.
  */
-export declare const getDefaultInitializedTransactionValues: ({ elementResponse, coverageTerms, }: {
+export declare const getDefaultInitializedTransactionValues: ({ elementResponse, coverageTerms, coverageTermsDataModel, }: {
     elementResponse: ElementResponse;
-    coverageTerms?: CoverageTermsConfigRecord;
+    coverageTerms: string[];
+    coverageTermsDataModel?: CoverageTermsConfigRecord;
 }) => {
     coverageTerms?: Record<string, string> | undefined;
 };
@@ -330,7 +398,14 @@ export declare const getDefaultQuoteValues: (quote: QuoteResponse, productModel:
  */
 export declare const getElementNameByType: (elementType: string) => string;
 
-export declare const getElementTransactionUpdateRequestFromFormData: ({ data, elementResponse, locator, }: TransactionFormData) => {
+/**
+ * Get the ElementRequest object from the ElementFormData object.
+ * @param formData The ElementFormData object
+ * @returns The ElementRequest object
+ */
+export declare const getElementRequest: (formData: ElementFormData) => ElementRequest;
+
+export declare const getElementTransactionUpdateRequestFromFormData: (params: TransactionFormData) => {
     locator: string;
     removeCoverageTerms?: Record<string, unknown> | undefined;
     removeData?: Record<string, unknown> | undefined;
@@ -367,7 +442,7 @@ export declare const getParamsChangeInstructionCreateRequestFromFormData: ({ dat
  * @returns The function `getQuoteRequest` returns a `QuoteRequest` object based on the provided
  * `QuoteFormData` data.
  */
-export declare const getQuoteRequest: ({ data }: QuoteFormData) => QuoteRequest;
+export declare const getQuoteRequest: (params: QuoteFormData) => QuoteRequest;
 
 /**
  * Recursively compare two objects and return the values that should be removed.
@@ -392,27 +467,26 @@ declare interface ProductElementMap {
 
 declare interface QuoteFormData {
     data: {
-        default?: {
-            startTime?: string;
-            endTime?: string;
-            expirationTime?: string;
-        };
-        advanced?: {
-            currency?: string;
-            timezone?: string;
-            billingPlan?: string;
-            defaultTermDuration?: string;
-            installmentPlan?: string;
-            durationBasis?: string;
-            delinquencyPlanName?: string;
-        };
-        coverageTerms?: {
-            [key: string]: string;
-        };
         [key: string]: any;
     };
+    default?: {
+        startTime?: string;
+        endTime?: string;
+        expirationTime?: string;
+    };
+    advanced?: QuoteRequestAdvancedFields;
+    coverageTerms?: {
+        [key: string]: string;
+    };
+    quote: QuoteResponse;
 }
 
+/**
+ * The type `QuoteRequestAdvancedFields` is a zod infererred type that represents the advanced fields of a quote request.
+ * It follows the fields that are found on the QuoteForm in @socotra/ec-react-components
+ */
+export declare type QuoteRequestAdvancedFields = z.infer<typeof advancedFieldSchema>;
+
 /**
  * The function `splitInputAndQuantifier` takes a string input, removes certain characters from it, and
  * extracts a quantifier if present.
@@ -431,26 +505,18 @@ 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;
+    default?: {
+        startTime?: string;
+        endTime?: string;
+        expirationTime?: string;
+    };
+    advanced?: QuoteRequestAdvancedFields;
+    coverageTerms?: {
+        [key: string]: string;
+    };
+    element: ElementResponse;
 }
 
 declare interface TransactionFormData_2 {