@socotra/ec-react-utils 2.3.0-next.1 → 2.3.0-next.3

package/dist/index.d.ts

@@ -10,6 +10,15 @@ import { ProductConfig } from '@socotra/ec-react-schemas';
 import { QuoteRequest } from '@socotra/ec-react-schemas';
 import { QuoteResponse } from '@socotra/ec-react-schemas';
 
+/**
+ * The function `dataModelToJSONSchema` converts a data model to a JSON schema based on specified
+ * criteria and data types.
+ * @param {DataModelToJsonSchemaProps} args - The `dataModelToJSONSchema` function takes in an object
+ * `args` with the following properties:
+ * @returns The function `dataModelToJSONSchema` returns a JSON schema object based on the provided
+ * arguments `args`. The JSON schema object includes properties, definitions, required fields, and
+ * other schema details based on the input data model and configuration.
+ */
 export declare const dataModelToJSONSchema: (args: DataModelToJsonSchemaProps) => JsonSchema7;
 
 declare interface DataModelToJsonSchemaProps {
@@ -22,12 +31,29 @@ declare interface DataModelToJsonSchemaProps {
     element?: ElementResponse;
 }
 
+/**
+ * The function `extractElementDataModel` extracts element data model based on a given quote, data
+ * model, and element locator.
+ * @param  - - `quote`: A QuoteResponse object containing information about a quote.
+ * @returns The function `extractElementDataModel` returns either an `ElementConfig` object or `false`
+ * based on the provided parameters and data model.
+ */
 export declare const extractElementDataModel: ({ dataModel, quote, elementLocator, }: {
     quote: QuoteResponse;
     dataModel: DataModel;
     elementLocator: string;
 }) => ElementConfig | false;
 
+/**
+ * The function `extractElementFromQuote` takes a `QuoteResponse` object and an element locator string,
+ * and returns the element with the matching locator from the quote or its nested elements.
+ * @param {QuoteResponse} quote - The `quote` parameter is of type `QuoteResponse`, which is an object
+ * containing information about a quote.
+ * @param {string} elementLocator - The `elementLocator` parameter is a string that represents the
+ * locator of the element you want to extract from the `quote` object.
+ * @returns The function `extractElementFromQuote` returns the element from the `QuoteResponse` object
+ * that matches the provided `elementLocator`.
+ */
 export declare const extractElementFromQuote: (quote: QuoteResponse, elementLocator: string) => false | ({
     locator: string;
     type: string;
@@ -50,6 +76,13 @@ export declare const extractElementFromQuote: (quote: QuoteResponse, elementLoca
     } & any)[];
 });
 
+/**
+ * The function `extractProductDataModel` extracts product data model based on the product name from a
+ * given data model.
+ * @param  - The `extractProductDataModel` function takes in two parameters:
+ * @returns The function `extractProductDataModel` returns the product configuration data for the
+ * specified product name from the provided data model.
+ */
 export declare const extractProductDataModel: ({ dataModel, element: { productName }, }: {
     element: {
         productName: string;
@@ -57,13 +90,41 @@ export declare const extractProductDataModel: ({ dataModel, element: { productNa
     dataModel: DataModel;
 }) => ProductConfig;
 
+/**
+ * The function `extractProductElements` extracts specific elements from a data model based on a
+ * product data model configuration.
+ * @param  - The `extractProductElements` function takes in two parameters:
+ * @returns The function `extractProductElements` returns a `ProductElementMap` object containing
+ * elements related to coverages, exposures, policy lines, and exposure groups that are available based
+ * on the provided `dataModel` and `productDataModel`.
+ */
 export declare const extractProductElements: ({ dataModel, productDataModel, }: {
     dataModel: DataModel;
     productDataModel: ProductConfig;
 }) => ProductElementMap;
 
+/**
+ * The function `getDefaultElementValues` returns a partial copy of an ElementResponse object with
+ * default values for coverageTerms if not provided.
+ * @param {ElementResponse} element - The `element` parameter in the `getDefaultElementValues` function
+ * is of type `ElementResponse`, which contains data related to an element in a system or
+ * application.
+ * @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) => Partial<ElementResponse>;
 
+/**
+ * The `getDefaultQuoteValues` function extracts default values from a `QuoteResponse`
+ * object and sets them based on certain conditions.
+ * @param {QuoteResponse} quote - The `getDefaultQuoteValues` function takes in three parameters:
+ * @param {ProductConfig} productModel - The `productModel` parameter in the `getDefaultQuoteValues`
+ * function represents the configuration settings for a specific product.
+ * @param {DataModel} dataModel - The `dataModel` parameter in the `getDefaultQuoteValues` function
+ * represents the data model used in the context of generating default values for a quote.
+ * @returns The `getDefaultQuoteValues` function returns an object with properties `default` and
+ * `advanced`.
+ */
 export declare const getDefaultQuoteValues: (quote: QuoteResponse, productModel: ProductConfig, dataModel: DataModel) => {
     default: {
         expirationTime?: string | undefined;
@@ -81,23 +142,14 @@ export declare const getDefaultQuoteValues: (quote: QuoteResponse, productModel:
     };
 };
 
-export declare const getQuoteElementRequest: ({ formData, locator, }: GetQuoteElementRequestAttributes) => QuoteRequest;
-
-declare type GetQuoteElementRequestAttributes = {
-    formData: {
-        [key: string]: unknown;
-    };
-    locator: string;
-};
-
-export declare const getQuoteRequest: ({ data }: QuoteFormData) => QuoteRequest;
-
 /**
- * Takes an element type and splits the postfix scope from the base model name. E.g., 'PersonalAutoQuote' becomes ['PersonalAuto', 'Quote']
- * @param elementType The element type to parse, e.g. `element.type` from an `ElementResponse`
- * @returns [elementName: string, scope: 'Quote' | 'QuickQuote' | 'Policy' | null]
+ * The function `getQuoteRequest` processes form data to create a `QuoteRequest` object.
+ * @param {QuoteFormData}  - The `getQuoteRequest` function takes in a parameter `data` of type
+ * `QuoteFormData` and returns a `QuoteRequest` object.
+ * @returns The function `getQuoteRequest` returns a `QuoteRequest` object based on the provided
+ * `QuoteFormData` data.
  */
-export declare const parseElementTypeAndScopeByElementType: (elementType: string) => [elementName: string, scope: "Quote" | "QuickQuote" | "Policy" | null];
+export declare const getQuoteRequest: ({ data }: QuoteFormData) => QuoteRequest;
 
 declare type ProductElement = Record<string, ElementConfig>;
 
@@ -129,45 +181,16 @@ declare interface QuoteFormData {
 }
 
 /**
- * Looks through a data model for a matching element type and returns the element model
- * @param element The element to retrieve the data model for
- * @param dataModel The full resolved data model to search
- * @returns ElementConfig
- */
-export declare function retrieveDataModelFromElement(element: ElementResponse, dataModel: DataModel): {
-    displayName?: string | undefined;
-    abstract?: boolean | undefined;
-    extend?: string | undefined;
-    data?: Record<string, {
-        options?: string[] | undefined;
-        type?: string | undefined;
-        displayName?: string | undefined;
-        defaultValue?: string | undefined;
-        minLength?: number | undefined;
-        maxLength?: number | undefined;
-        regex?: string | undefined;
-        min?: string | undefined;
-        multiline?: boolean | undefined;
-        max?: string | undefined;
-        overrides?: string | undefined;
-        scope?: string | undefined;
-        inherited?: boolean | undefined;
-        precision?: number | undefined;
-        readOnly?: boolean | undefined;
-    }> | undefined;
-    contents?: string[] | undefined;
-    coverageTerms?: string[] | undefined;
-    charges?: string[] | undefined;
-};
-
-/**
- * Takes the root element of a quote and a locator and returns the element with the matching locator
- * @param quoteElement The root element from the QuoteResponse
- * @param locator The locator of the element to retrieve
- * @returns ElementResponse | undefined
+ * The function `splitInputAndQuantifier` takes a string input, removes certain characters from it, and
+ * extracts a quantifier if present.
+ * @param {string | undefined} input - The `splitInputAndQuantifier` function takes a string input and
+ * splits it into two parts: the name and the quantifier. The quantifier is extracted from the end of
+ * the input string, while the name is the input string with certain characters (? * ! +) removed.
+ * @returns The function `splitInputAndQuantifier` returns an object with two properties:
+ * - `name`: a string that is the input with any of the characters '?', '*', '!', or '+' removed
+ * - `quantifier`: a string that represents the quantifier found at the end of the input string, or an
+ * empty string if no quantifier is found
  */
-export declare function retrieveElementFromQuoteByLocator(quoteElement: ElementResponse, locator: string): ElementResponse | undefined;
-
 export declare const splitInputAndQuantifier: (input: string | undefined) => {
     name: string;
     quantifier: "" | "*" | "?" | "+" | "!";