@socotra/ec-react-utils 2.24.1-next.2 → 2.24.1-next.3

package/dist/index.d.ts

@@ -15,6 +15,9 @@ import { ErrorObject } from 'ajv';
 import { EvaluateConstraintsRequest } from '@socotra/ec-react-schemas';
 import { EvaluateConstraintsResponse } from '@socotra/ec-react-schemas';
 import { FieldConfigRecord } from '@socotra/ec-react-schemas';
+import { FnolCreateRequest } from '@socotra/ec-react-schemas';
+import { FnolPatchRequest } from '@socotra/ec-react-schemas';
+import { FnolResponse } from '@socotra/ec-react-schemas';
 import { JsonSchema7 } from '@jsonforms/core';
 import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
 import { ParamsChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
@@ -70,6 +73,14 @@ declare type AnyObject = {
 
 export declare const compareData: (originalData: Record<string, PrimitiveValue>, updatedData: Record<string, PrimitiveValue>, path?: string[]) => DataChange[];
 
+export declare interface CreateRequestParams {
+    data: {
+        [key: string]: any;
+    };
+    fnol?: never;
+    default: Partial<Omit<FnolCreateRequest, 'data'>>;
+}
+
 declare type DataChange = {
     originalValue: DataFieldValue;
     newValue: DataFieldValue;
@@ -434,6 +445,30 @@ export declare const getDefaultElementValues: (element: ElementResponse, coverag
     coverageTerms?: Record<string, string> | undefined;
 };
 
+/**
+ * The function `getDefaultFnolValues` returns a partial copy of an FnolResponse object with
+ * default values for the type, incidentTime, incidentSummary, policyLocator, accountLocator,
+ * region, and autoValidate properties.
+ * @param {Partial<FnolResponse>} fnol - The `fnol` parameter is of type `Partial<FnolResponse>`,
+ * which means it is an optional object that extends the `FnolResponse` interface.
+ * @returns A partial FnolResponse object is being returned, with the data from the input fnol
+ * and the default property set to an object with the type, incidentTime, incidentSummary,
+ * policyLocator, accountLocator, region, and autoValidate properties.
+ */
+export declare const getDefaultFnolValues: (fnol: Partial<FnolResponse>) => {
+    default: {
+        type: string;
+        incidentTime: string | undefined;
+        incidentTimezone: string | undefined;
+        incidentSummary: string | undefined;
+        policyLocator: string | undefined;
+        accountLocator: string | undefined;
+        region: string | undefined;
+        autoValidate: boolean;
+    };
+    data?: Record<string, any> | undefined;
+};
+
 /**
  * The function `getDefaultInitializedTransactionValues` takes an `ElementResponse` object and a `CoverageTermsConfigRecord` object,
  * and returns the default initialized transaction values for the element.
@@ -555,6 +590,19 @@ export declare const getEvaluatedConstraintsRequest: ({ dependencyMap, locator,
     locator: string;
 }) => EvaluateConstraintsRequest;
 
+/**
+ * The function `getFnolNameByType` returns the name of an Fnol type by removing the 'Fnol' suffix
+ * if it exists.
+ * @param {string} type - The `type` parameter is a string that represents the type of an Fnol.
+ * @returns The function `getFnolNameByType` returns a string which is the name of the Fnol type
+ * without the 'Fnol' suffix if it exists.
+ */
+export declare const getFnolNameByType: (type: string) => string;
+
+export declare function getFnolRequest(params: PatchRequestParams): FnolPatchRequest;
+
+export declare function getFnolRequest(params: CreateRequestParams): FnolCreateRequest;
+
 export declare const getModifyChangeInstructionCreateRequestFromFormData: ({ data, transactionSnapshot, staticLocator, }: TransactionFormData_2) => {
     staticLocator: string;
     action: "modify";
@@ -594,6 +642,14 @@ export { JsonSchema7 }
 
 export declare const parseToPrimitive: (str: string) => any;
 
+export declare interface PatchRequestParams {
+    fnol: Partial<FnolResponse>;
+    data: {
+        [key: string]: any;
+    };
+    default: Partial<Omit<FnolPatchRequest, 'setData' | 'removeData'>>;
+}
+
 /**
  * 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