@socotra/ec-react-utils 2.16.1 → 2.16.2-next.0

package/dist/index.d.ts

@@ -15,6 +15,7 @@ import { FieldConfigRecord } from '@socotra/ec-react-schemas';
 import { JsonSchema7 } from '@jsonforms/core';
 import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
 import { ParamsChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
+import { PolicyResponse } from '@socotra/ec-react-schemas';
 import { PrimitiveValue } from '@socotra/ec-react-schemas';
 import { ProductConfig } from '@socotra/ec-react-schemas';
 import { Quantifiers } from '@socotra/ec-react-schemas';
@@ -29,11 +30,13 @@ 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 type AccountRequestAdvancedFields = z.infer<typeof advancedFieldSchema_3>;
 
 declare const advancedFieldSchema: z.ZodRecord<z.ZodEnum<["billingLevel", "billingTrigger", "durationBasis", "delinquencyPlanName", "autoRenewalPlanName"]>, z.ZodOptional<z.ZodString>>;
 
-declare const advancedFieldSchema_2: z.ZodObject<{
+declare const advancedFieldSchema_2: z.ZodRecord<z.ZodEnum<["billingLevel", "billingTrigger", "durationBasis", "delinquencyPlanName", "autoRenewalPlanName"]>, z.ZodOptional<z.ZodString>>;
+
+declare const advancedFieldSchema_3: z.ZodObject<{
     autoRenewalPlanName: z.ZodOptional<z.ZodString>;
     delinquencyPlanName: z.ZodOptional<z.ZodString>;
     excessCreditPlanName: z.ZodOptional<z.ZodString>;
@@ -107,6 +110,8 @@ declare interface DataModelToJsonSchemaProps {
 
 declare const defaultFieldSchema: z.ZodRecord<z.ZodEnum<["startTime", "endTime", "expirationTime", "installmentPlanName", "timezone", "currency"]>, z.ZodOptional<z.ZodString>>;
 
+declare const defaultFieldSchema_2: z.ZodRecord<z.ZodEnum<["startTime", "endTime", "timezone", "currency"]>, z.ZodOptional<z.ZodString>>;
+
 declare interface ElementFormData {
     data: {
         [key: string]: any;
@@ -370,6 +375,36 @@ export declare const getDefaultInitializedTransactionValues: ({ elementResponse,
     coverageTerms?: Record<string, string> | undefined;
 };
 
+/**
+ * The `getDefaultPolicyValues` function extracts default values from a `PolicyResponse`
+ * object and sets them based on certain conditions.
+ * @param {PolicyResponse} policy - The `getDefaultPolicyValues` function takes in three parameters:
+ * @param {ProductConfig} productModel - The `productModel` parameter in the `getDefaultPolicyValues`
+ * function represents the configuration settings for a specific product.
+ * @param {ElementResponse} element - The `element` parameter in the `getDefaultPolicyValues` function
+ * represents the element used in the context of generating default values for a policy.
+ * @param {DataModel} dataModel - The `dataModel` parameter in the `getDefaultPolicyValues` function
+ * represents the data model used in the context of generating default values for a policy.
+ * @returns The `getDefaultPolicyValues` function returns an object with properties `default` and
+ * `advanced`.
+ */
+export declare const getDefaultPolicyValues: (policy: PolicyResponse, productModel: ProductConfig, element: ElementResponse, dataModel: DataModel) => {
+    default: {
+        currency: string;
+        timezone: string | undefined;
+        startTime: string;
+        endTime: string;
+    };
+    advanced: {
+        billingLevel: "account" | "inherit" | "policy";
+        billingTrigger: "accept" | "issue";
+        durationBasis: "years" | "months" | "weeks" | "days" | "hours";
+        delinquencyPlanName: string | undefined;
+        autoRenewalPlanName: string | undefined;
+    };
+    coverageTerms: Record<string, string>;
+};
+
 /**
  * The `getDefaultQuoteValues` function extracts default values from a `QuoteResponse`
  * object and sets them based on certain conditions.
@@ -471,6 +506,18 @@ export declare function getRemoveDataFieldValues(originalObj: AnyObject, modifie
 
 export declare const getUpdatedDataFromConstraints: (newData: Record<string, PrimitiveValue>, evaluatedConstraintMap: ConstraintEvaluationResponse | undefined, elementLocator: string) => Record<string, PrimitiveValue>;
 
+/**
+ * The type `PolicyRequestAdvancedFields` is a zod inferred type that represents the advanced fields of a policy request.
+ * It follows the fields that are found on the PolicyForm in @socotra/ec-react-components
+ */
+export declare type PolicyRequestAdvancedFields = z.infer<typeof advancedFieldSchema_2>;
+
+/**
+ * The type `PolicyRequestDefaultFields` is a zod inferred type that represents the default fields of a policy request.
+ * It follows the fields that are found on the PolicyForm in @socotra/ec-react-components
+ */
+export declare type PolicyRequestDefaultFields = z.infer<typeof defaultFieldSchema_2>;
+
 declare type ProductElement = Record<string, ElementConfig & {
     quantifier: Quantifiers;
 }>;