@intuned/browser-dev 2.2.3-unify-sdks.21 → 2.2.3-unify-sdks.23

package/dist/playwright/staticExtractors/extractHelpers.js

@@ -0,0 +1,170 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.compressStringSpaces = compressStringSpaces;
+exports.injectExtractorsHelperFunctions = injectExtractorsHelperFunctions;
+exports.selectArrayValuesUsingRelativeSelector = selectArrayValuesUsingRelativeSelector;
+exports.selectLocatorsUsingXpath = selectLocatorsUsingXpath;
+exports.selectMultiValueUsingRelativeSelector = selectMultiValueUsingRelativeSelector;
+exports.selectValueUsingRelativeSelector = selectValueUsingRelativeSelector;
+exports.splitContainerIntoListLocators = splitContainerIntoListLocators;
+async function injectExtractorsHelperFunctions(page) {
+  await page.evaluate(() => {
+    const generateMultiValueWarningMessage = ({
+      propertyName,
+      nodesLength
+    }) => {
+      return `The selector for the property '${propertyName}' is matching ${nodesLength} elements. Please ensure that the 'multiValue' flag is enabled to retrieve all matching elements. Without this flag, only the first element will be processed.`;
+    };
+    window["cleanValue"] = (regex, value) => {
+      var _text$match;
+      const compressStringSpaces = str => str.replace(/\s+/g, " ").trim();
+      const text = compressStringSpaces(value);
+      if (!regex) return text;
+      const regexMatchIndex = regex.matchIndex === undefined || regex.matchIndex === null ? 1 : regex.matchIndex;
+      const regexFromString = new RegExp(regex.pattern);
+      const valueFromRegex = (_text$match = text.match(regexFromString)) === null || _text$match === void 0 ? void 0 : _text$match[regexMatchIndex];
+      return compressStringSpaces(valueFromRegex ?? "") || null;
+    };
+    window["getValueUsingNodeAndSelector"] = ({
+      selector,
+      element
+    }) => {
+      if (selector.selectionMethod === "all-text") {
+        return element.textContent;
+      } else if (selector.selectionMethod === "direct-text") {
+        return Array.from(element.childNodes).filter(child => child.nodeType === Node.TEXT_NODE).map(child => child.textContent ?? "").join("");
+      } else {
+        return element.getAttribute(selector.selectionMethod.propertyName);
+      }
+    };
+    window["getValueUsingSelector"] = ({
+      selector,
+      relativeElement,
+      propertyName
+    }) => {
+      let node = null;
+      const warningMessages = [];
+      if (selector.selector.trim() === "") {
+        node = relativeElement ?? document.documentElement;
+      } else if (selector.type === "xpath") {
+        if (!relativeElement && !selector.selector.startsWith("/")) {
+          selector.selector = `/${selector.selector}`;
+        }
+        const nodes = document.evaluate(selector.selector, relativeElement ? relativeElement : document.documentElement, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
+        if (nodes.snapshotLength > 0) {
+          if (nodes.snapshotLength > 1) {
+            warningMessages.push(generateMultiValueWarningMessage({
+              propertyName,
+              nodesLength: nodes.snapshotLength
+            }));
+          }
+          node = nodes.snapshotItem(0);
+        } else {
+          return {
+            value: null,
+            warnings: warningMessages
+          };
+        }
+      } else {
+        const nodes = relativeElement ? relativeElement.querySelectorAll(selector.selector) : document.querySelectorAll(selector.selector);
+        if (nodes.length > 0) {
+          if (nodes.length > 1) {
+            warningMessages.push(generateMultiValueWarningMessage({
+              propertyName,
+              nodesLength: nodes.length
+            }));
+          }
+          node = nodes[0];
+        } else {
+          return {
+            value: null,
+            warnings: warningMessages
+          };
+        }
+      }
+      if (!node) return {
+        value: null,
+        warnings: warningMessages
+      };
+      const result = window["getValueUsingNodeAndSelector"]({
+        selector,
+        element: node
+      });
+      if (!result) return {
+        value: null,
+        warnings: warningMessages
+      };
+      return {
+        value: window["cleanValue"](selector.regex, result),
+        warnings: warningMessages
+      };
+    };
+    window["getMultiValueUsingSelector"] = ({
+      selector,
+      relativeElement
+    }) => {
+      let nodes = [];
+      if (selector.selector.trim() === "") {
+        nodes = [relativeElement ?? document.documentElement];
+      } else if (selector.type === "xpath") {
+        if (!relativeElement && !selector.selector.startsWith("/")) {
+          selector.selector = `/${selector.selector}`;
+        }
+        const nodesSnapshot = document.evaluate(selector.selector, relativeElement ? relativeElement : document.documentElement, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
+        for (let i = 0; i < nodesSnapshot.snapshotLength; i++) {
+          const node = nodesSnapshot.snapshotItem(i);
+          node && nodes.push(node);
+        }
+      } else {
+        nodes = Array.from(relativeElement ? relativeElement.querySelectorAll(selector.selector) : document.querySelectorAll(selector.selector));
+      }
+      return nodes.map(node => window["getValueUsingNodeAndSelector"]({
+        selector,
+        element: node
+      })).map(result => window["cleanValue"](selector.regex, result)).filter(v => v !== null && v !== undefined);
+    };
+  });
+}
+async function splitContainerIntoListLocators(locator) {
+  const childrenLocators = await locator.locator(":scope > *").all();
+  return childrenLocators;
+}
+function compressStringSpaces(str) {
+  return str.replace(/\s+/g, " ").trim();
+}
+async function selectArrayValuesUsingRelativeSelector(locators, selectorInfo) {
+  const extractorFn = selectorInfo.multiValue ? selectMultiValueUsingRelativeSelector : selectValueUsingRelativeSelector;
+  const listValuesPromises = locators.map(locator => {
+    return extractorFn(locator, selectorInfo);
+  });
+  const listValues = await Promise.all(listValuesPromises);
+  const someValidValues = listValues.some(value => !!value);
+  if (someValidValues) return listValues;
+  return locators.map(() => null);
+}
+async function selectMultiValueUsingRelativeSelector(locator, valueSelector) {
+  await injectExtractorsHelperFunctions(locator.page());
+  return locator.evaluate((element, valueSelector) => {
+    return window["getMultiValueUsingSelector"]({
+      relativeElement: element,
+      selector: valueSelector
+    });
+  }, valueSelector);
+}
+async function selectValueUsingRelativeSelector(locator, valueSelector) {
+  const page = locator.page();
+  await injectExtractorsHelperFunctions(page);
+  return locator.evaluate((element, valueSelector) => {
+    return window["getValueUsingSelector"]({
+      relativeElement: element,
+      selector: valueSelector
+    }).value;
+  }, valueSelector);
+}
+async function selectLocatorsUsingXpath(page, xpath) {
+  const trimmed = xpath.replace(/^(\/+)/, "");
+  return await page.locator(`//${trimmed}`).all();
+}

package/dist/playwright/staticExtractors/getArrayUsingArrayExtractor.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getArrayUsingArrayExtractor = getArrayUsingArrayExtractor;
+var _extractHelpers = require("./extractHelpers");
+var _Logger = require("../../common/Logger");
+async function getArrayUsingArrayExtractor(page, listExtractor) {
+  await (0, _extractHelpers.injectExtractorsHelperFunctions)(page);
+  const results = await page.evaluate(async ({
+    listExtractor
+  }) => {
+    const {
+      containerSelector,
+      propertySelectors
+    } = listExtractor;
+    const findContainerElement = selectors => {
+      if (!Array.isArray(selectors)) selectors = [selectors];
+      for (const selector of selectors) {
+        let containerElement = null;
+        if (selector.type === "xpath") {
+          if (!selector.selector.startsWith("/")) {
+            selector.selector = `/${selector.selector}`;
+          }
+          containerElement = document.evaluate(selector.selector, document.documentElement, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+        } else {
+          containerElement = document.querySelector(selector.selector);
+        }
+        if (containerElement) return containerElement;
+      }
+      return null;
+    };
+    const containerElement = findContainerElement(containerSelector);
+    if (!containerElement) {
+      throw new Error("Failed to find container element");
+    }
+    const listItems = Array.from(containerElement.children);
+    const listToReturn = listItems.map(() => ({}));
+    const warningMessages = [];
+    for (const [propertyName, selectorInfo] of Object.entries(propertySelectors)) {
+      if (!selectorInfo) return;
+      for (let index = 0; index < listItems.length; index++) {
+        const item = listItems[index];
+        const selectorInfoList = Array.isArray(selectorInfo) ? selectorInfo : [selectorInfo];
+        for (const selector of selectorInfoList) {
+          const result = selector.multiValue ? await Promise.all(window["getMultiValueUsingSelector"]({
+            relativeElement: item,
+            selector
+          })) : await window["getValueUsingSelector"]({
+            relativeElement: item,
+            selector,
+            propertyName
+          });
+          if (selector.multiValue && Array.isArray(result) && result.length > 0) {
+            listToReturn[index][propertyName] = result;
+            break;
+          } else if (!selector.multiValue && window) {
+            const {
+              value,
+              warnings
+            } = result;
+            warningMessages.push(...warnings);
+            listToReturn[index][propertyName] = value;
+            break;
+          }
+        }
+        if (!listToReturn[index][propertyName]) {
+          listToReturn[index][propertyName] = selectorInfoList[0].multiValue ? [] : null;
+        }
+      }
+    }
+    return {
+      listToReturn,
+      warnings: warningMessages
+    };
+  }, {
+    listExtractor
+  });
+  if (results !== null && results !== void 0 && results.warnings) {
+    results.warnings.forEach(warning => _Logger.logger.warn(warning));
+  }
+  return results === null || results === void 0 ? void 0 : results.listToReturn;
+}

package/dist/playwright/staticExtractors/getObjectUsingObjectExtractor.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getObjectUsingObjectExtractor = getObjectUsingObjectExtractor;
+var _extractHelpers = require("./extractHelpers");
+async function getObjectUsingObjectExtractor(page, objectExtractor) {
+  await (0, _extractHelpers.injectExtractorsHelperFunctions)(page);
+  const results = await page.evaluate(async ({
+    objectExtractor
+  }) => {
+    const result = {};
+    for (const [propertyName, selectorInfo] of Object.entries(objectExtractor)) {
+      if (!selectorInfo) return;
+      const selectors = Array.isArray(selectorInfo) ? selectorInfo : [selectorInfo];
+      for (const selector of selectors) {
+        if (selector.multiValue) {
+          const values = await Promise.all(window["getMultiValueUsingSelector"]({
+            selector
+          }));
+          if (values.length) {
+            result[propertyName] = values;
+            break;
+          }
+        } else {
+          const value = await window["getValueUsingSelector"]({
+            selector
+          }).value;
+          if (value && value !== null && value !== undefined) {
+            result[propertyName] = value;
+            break;
+          }
+        }
+      }
+    }
+    if (Object.keys(result).length === 0) {
+      throw new Error("No data found.");
+    }
+    return result;
+  }, {
+    objectExtractor
+  });
+  return results;
+}

package/dist/playwright/staticExtractors/index.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractArrayFromPageUsingSelectors = extractArrayFromPageUsingSelectors;
+exports.extractObjectFromPageUsingSelectors = extractObjectFromPageUsingSelectors;
+var _formatZodError = require("../../common/formatZodError");
+var _types = require("./types");
+var _getArrayUsingArrayExtractor = require("./getArrayUsingArrayExtractor");
+var _getObjectUsingObjectExtractor = require("./getObjectUsingObjectExtractor");
+async function extractObjectFromPageUsingSelectors(page, extractor) {
+  const objectExtractorParsingResult = _types.objectExtractorSchema.safeParse(extractor);
+  if (!objectExtractorParsingResult.success) {
+    const messages = (0, _formatZodError.formatZodError)(objectExtractorParsingResult.error);
+    throw new Error(`Invalid object extractor: ${messages.join(", ")}`);
+  }
+  try {
+    return await (0, _getObjectUsingObjectExtractor.getObjectUsingObjectExtractor)(page, objectExtractorParsingResult.data);
+  } catch (error) {
+    console.log("Extraction failed because:", error.message, "\nThis could be due to the list container being empty.");
+    return {};
+  }
+}
+async function extractArrayFromPageUsingSelectors(page, listExtractor) {
+  const listExtractorParsing = _types.listStaticExtractorSchema.safeParse(listExtractor);
+  if (!listExtractorParsing.success) {
+    const messages = (0, _formatZodError.formatZodError)(listExtractorParsing.error);
+    throw new Error(`invalid array extractor: ${messages.join(", ")}`);
+  }
+  try {
+    return await (0, _getArrayUsingArrayExtractor.getArrayUsingArrayExtractor)(page, listExtractorParsing.data);
+  } catch (error) {
+    console.log("Extraction failed because:", error.message, "\nThis could be due to the list container being empty.");
+    return [];
+  }
+}

package/dist/playwright/staticExtractors/types.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.objectExtractorSchema = exports.listStaticExtractorSchema = void 0;
+var _zod = require("zod");
+const elementSelectorSchema = _zod.z.object({
+  selector: _zod.z.string(),
+  type: _zod.z.enum(["xpath", "css"]).optional().default("css")
+});
+const valueSelectorSchema = elementSelectorSchema.extend({
+  selectionMethod: _zod.z.union([_zod.z.enum(["direct-text", "all-text"]), _zod.z.object({
+    propertyName: _zod.z.string()
+  })]).default("all-text"),
+  regex: _zod.z.object({
+    pattern: _zod.z.string(),
+    matchIndex: _zod.z.number().default(0)
+  }).optional(),
+  multiValue: _zod.z.boolean().optional()
+});
+const listStaticExtractorSchema = exports.listStaticExtractorSchema = _zod.z.object({
+  containerSelector: _zod.z.union([elementSelectorSchema, _zod.z.array(elementSelectorSchema)]),
+  propertySelectors: _zod.z.record(_zod.z.union([valueSelectorSchema, _zod.z.array(valueSelectorSchema)]))
+});
+const objectExtractorSchema = exports.objectExtractorSchema = _zod.z.record(_zod.z.union([valueSelectorSchema, _zod.z.array(valueSelectorSchema)]));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/browser-dev",
-  "version": "2.2.3-unify-sdks.21",
+  "version": "2.2.3-unify-sdks.23",
   "description": "runner package for intuned functions",
   "types": "./dist/index.d.ts",
   "typesVersions": {
@@ -13,6 +13,9 @@
       ],
       "ai": [
         "./dist/ai/index.d.ts"
+      ],
+      "playwright": [
+        "./dist/playwright/index.d.ts"
       ]
     }
   },
@@ -21,6 +24,7 @@
     "./ai-extractors": "./dist/ai-extractors/index.js",
     "./optimized-extractors": "./dist/optimized-extractors/index.js",
     "./ai": "./dist/ai/index.js",
+    "./playwright": "./dist/playwright/index.js",
     "./dist/common/settingsSchema": "./dist/common/settingsSchema.js",
     "./dist/common/getPlaywrightConstructs": "./dist/common/getPlaywrightConstructs.js",
     "./dist/common/contextStorageStateHelpers": "./dist/common/contextStorageStateHelpers.js",
@@ -33,7 +37,8 @@
     "./dist/commands/common/getFirstLineNumber": "./dist/commands/common/getFirstLineNumber.js",
     "./dist/commands/common/constants": "./dist/commands/common/constants.js",
     "./dist/files/FileUploadAndDownload/utils": "./dist/files/FileUploadAndDownload/utils.js",
-    "./dist/ai/index.d.ts": "./dist/ai/index.d.ts"
+    "./dist/ai/index.d.ts": "./dist/ai/index.d.ts",
+    "./dist/playwright/index.d.ts": "./dist/playwright/index.d.ts"
   },
   "author": "Intuned Team",
   "license": "Elastic-2.0",
@@ -100,6 +105,7 @@
     "@types/async-retry": "1.4.8",
     "@types/fs-extra": "11.0.1",
     "@types/jest": "^30.0.0",
+    "@types/json-schema": "^7.0.15",
     "@types/lodash": "4.14.200",
     "@types/node": "^24.1.0",
     "@typescript-eslint/eslint-plugin": "^5.47.1",