@socotra/ec-react-utils 2.5.1-next.10 → 2.5.1-next.11

package/dist/index.d.ts

@@ -50,7 +50,7 @@ declare interface DataModelToJsonSchemaProps {
  * based on the provided parameters and data model.
  */
 export declare const extractElementDataModel: ({ dataModel, quote, elementLocator, }: {
-    quote: QuoteResponse;
+    quote: QuoteResponse | SegmentResponse;
     dataModel: DataModel;
     elementLocator: string;
 }) => ElementConfig | false;
@@ -78,7 +78,41 @@ export declare const extractElementDataModelFromType: ({ dataModel, elementType,
  * @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 | ({
+export declare const extractElementFromQuote: (quote: QuoteResponse | 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;
@@ -126,6 +160,30 @@ export declare const extractElementsFromQuote: (elements: Array<ElementResponse>
     } & any)[];
 })[];
 
+export declare const extractElementsFromTransactionSegment: (elements: Array<ElementResponse>, elementType: string) => ({
+    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 `extractProductDataModel` extracts product data model based on the product name from a
  * given data model.