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

package/dist/index.d.ts

@@ -45,6 +45,18 @@ declare interface DataModelToJsonSchemaProps {
     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.
+ * @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 `extractElementByLocator` returns the element from the response object
+ * that matches the provided `elementLocator`.
+ */
+export declare const extractElementByLocator: <T extends ElementResponse>(response: QuoteResponse | SegmentResponse | ElementResponse, elementLocator: string) => T | null;
+
 /**
  * The function `extractElementDataModelFromQuote` extracts element data model based on a given quote, data
  * model, and element locator.
@@ -58,7 +70,7 @@ export declare const extractElementDataModelFromQuote: ({ dataModel, quote, elem
     quote: QuoteResponse;
     dataModel: DataModel;
     elementLocator: string;
-}) => ElementConfig | false;
+}) => ElementConfig | null;
 
 /**
  * The function `extractElementDataModelFromSegment` extracts element data model based on a given segment, data
@@ -73,7 +85,7 @@ export declare const extractElementDataModelFromSegment: ({ dataModel, segment,
     segment: SegmentResponse;
     dataModel: DataModel;
     elementLocator: string;
-}) => ElementConfig | false;
+}) => ElementConfig | null;
 
 /**
  * The function `extractElementDataModelFromType` extracts element data model given a data model and
@@ -83,112 +95,28 @@ export declare const extractElementDataModelFromSegment: ({ dataModel, segment,
  * @returns The function `extractElementDataModelFromType` returns either an `ElementConfig` object or `false`
  * based on the provided parameters and data model.
  */
-export declare const extractElementDataModelFromType: ({ dataModel, elementType, }: {
-    dataModel: DataModel;
-    elementType: 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;
-    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 `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 extractElementDataModelFromType: ExtractElementDataModelFromTypeInterface;
+
+declare interface ExtractElementDataModelFromTypeInterface {
+    (props: {
+        dataModel: DataModel;
+        elementType: string;
+        resultType?: 'value';
+    }): ElementConfig | null;
+    (props: {
+        dataModel: DataModel;
+        elementType: string;
+        resultType?: 'all';
+    }): {
+        value: ElementConfig;
+        path: string;
+    } | null;
+    (props: {
+        dataModel: DataModel;
+        elementType: string;
+        resultType?: 'path';
+    }): string | null;
+}
 
 export declare const extractElementsFromQuote: (elements: Array<ElementResponse>, elementType: string) => ({
     locator: string;
@@ -270,14 +198,6 @@ 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.
@@ -366,6 +286,14 @@ export declare const getDefaultQuoteValues: (quote: QuoteResponse, productModel:
     coverageTerms: Record<string, string>;
 };
 
+/**
+ * The function `getElementNameByType` returns the element name based on the element type and suffix.
+ * @param  - - `elementType`: A string containing the element type.
+ * @param  - - `suffix`: A string containing the suffix.
+ * @returns The function `getElementNameByType` returns the element name.
+ */
+export declare const getElementNameByType: (elementType: string) => string;
+
 export declare const getElementTransactionUpdateRequestFromFormData: ({ data, elementResponse, locator, }: TransactionFormData) => {
     locator: string;
     removeCoverageTerms?: Record<string, unknown> | undefined;