ff-dom 1.0.18-beta.1 → 1.0.18-beta.3

package/src/utils/referenceXpath.ts

@@ -1,13 +1,11 @@
 import { parseDOM } from "./xpath.ts";
 import {
   findXpathWithIndex,
-  findRoot,
   getShadowRoot,
   getTextContent,
   escapeCharacters,
   getCountOfXPath,
   checkBlockedAttributes,
-  isNumberExist,
   getAbsoluteXPath,
   isSvg,
   getCombinationXpath,
@@ -17,14 +15,12 @@ import {
   getReferenceElementsXpath,
   getRelativeXPath,
   findMatchingParenthesis,
-  removeParenthesis,
-  modifiedElementAttributes
+  removeParenthesis
 } from "./xpathHelpers.ts";
 
 let xpathDataWithIndex: any[] = [];
 let xpathData: { key: string; value: string }[] = [];
 const reWhiteSpace = /^[\S]+( [\S]+)*$/gi;
-let multiElementReferenceMode: boolean = false;
 
 export const findRelativeXpath = (
   element1: HTMLElement | Element,
@@ -32,7 +28,8 @@ export const findRelativeXpath = (
   docmt: Document,
   xpaths1: any[],
   xpaths2: any[],
-  isIndex: any
+  isIndex: boolean,
+  multiElementReferenceMode: boolean = false
 ) => {
   // debugger;
   const par1 = element1.parentElement;
@@ -40,7 +37,6 @@ export const findRelativeXpath = (
   let rel_xpath: any[] = [];
 
   let tempElement;
-  const root = findRoot(element1);
   let finalXpaths: any[] = [];
 
   if (isIndex) {
@@ -74,7 +70,8 @@ export const findRelativeXpath = (
         "self",
         xpaths1,
         xpaths2,
-        isIndex
+        isIndex,
+        multiElementReferenceMode
       );
       if (rel_xpath) finalXpaths = finalXpaths.concat(rel_xpath);
     }
@@ -89,7 +86,8 @@ export const findRelativeXpath = (
         "parent",
         xpaths1,
         xpaths2,
-        isIndex
+        isIndex,
+        multiElementReferenceMode
       );
       if (rel_xpath) finalXpaths = finalXpaths.concat(rel_xpath);
     }
@@ -105,7 +103,8 @@ export const findRelativeXpath = (
           "ancestor",
           xpaths1,
           xpaths2,
-          isIndex
+          isIndex,
+          multiElementReferenceMode
         );
         if (rel_xpath) {
           finalXpaths = finalXpaths.concat(rel_xpath);
@@ -126,7 +125,8 @@ export const findRelativeXpath = (
           "ancestor-or-self",
           xpaths1,
           xpaths2,
-          isIndex
+          isIndex,
+          multiElementReferenceMode
         );
         if (rel_xpath) {
           finalXpaths = finalXpaths.concat(rel_xpath);
@@ -151,7 +151,8 @@ export const findRelativeXpath = (
             "following-sibling",
             xpaths1,
             xpaths2,
-            isIndex
+            isIndex,
+            multiElementReferenceMode
           );
           if (rel_xpath) {
             finalXpaths = finalXpaths.concat(rel_xpath);
@@ -172,7 +173,8 @@ export const findRelativeXpath = (
             "preceding-sibling",
             xpaths1,
             xpaths2,
-            isIndex
+            isIndex,
+            multiElementReferenceMode
           );
           if (rel_xpath) {
             finalXpaths = finalXpaths.concat(rel_xpath);
@@ -192,7 +194,8 @@ export const findRelativeXpath = (
             "child",
             xpaths1,
             xpaths2,
-            isIndex
+            isIndex,
+            multiElementReferenceMode
           );
           if (rel_xpath) {
             finalXpaths = finalXpaths.concat(rel_xpath);
@@ -211,7 +214,8 @@ export const findRelativeXpath = (
         "preceding",
         xpaths1,
         xpaths2,
-        isIndex
+        isIndex,
+        multiElementReferenceMode
       );
     }
 
@@ -222,7 +226,8 @@ export const findRelativeXpath = (
         "following",
         xpaths1,
         xpaths2,
-        isIndex
+        isIndex,
+        multiElementReferenceMode
       );
     }
     if (rel_xpath) {
@@ -235,7 +240,8 @@ export const findRelativeXpath = (
       xpaths1,
       xpaths2,
       "descendant",
-      isIndex
+      isIndex,
+      multiElementReferenceMode
     );
     if (descendantXpath) finalXpaths = finalXpaths.concat(descendantXpath);
 
@@ -245,7 +251,8 @@ export const findRelativeXpath = (
       xpaths1,
       xpaths2,
       "descedant-or-self",
-      isIndex
+      isIndex,
+      multiElementReferenceMode
     );
     if (descendantSelfXpath) {
       finalXpaths = finalXpaths.concat(descendantSelfXpath);
@@ -274,7 +281,8 @@ const descendantExpression = (
   isIndex: any,
   expCommonParentXpathElements: string | any[],
   step4: string,
-  refCommonParentXpathElementLength: number
+  refCommonParentXpathElementLength: number = 0,
+  multiElementReferenceMode: boolean = false
 ) => {
   let finalExpectedElementXpath: string | undefined = "";
 
@@ -282,7 +290,7 @@ const descendantExpression = (
     xpath2.split(/\/(?=(?:[^']*\'[^\']*\')*[^\']*$)/g)?.length >=
     expCommonParentXpathElements.length
   ) {
-    const xpaths2Els = [];
+    const xpaths2Els: string[] = [];
     const xpath2Elements = xpath2.split(/\/(?=(?:[^']*\'[^\']*\')*[^\']*$)/g);
     for (let x = 1; x <= expCommonParentXpathElements.length; x++) {
       xpaths2Els.unshift(
@@ -304,7 +312,8 @@ const descendantExpression = (
       refExpectElement,
       docmt,
       relation,
-      isIndex
+      isIndex,
+      multiElementReferenceMode
     );
     if (traverseXpath) {
       return traverseXpath;
@@ -365,7 +374,8 @@ const getDescendantXpath = (
   xpaths1: { key: string; value: string }[],
   xpaths2: { key: string; value: string }[],
   relation: "descendant" | "descedant-or-self",
-  isIndex: boolean
+  isIndex: boolean = false,
+  multiElementReferenceMode: boolean = false
 ) => {
   const refElement: HTMLElement | Element = refExpectElement[refExpectElement.length - 2];
   const expElement: HTMLElement | Element = refExpectElement[refExpectElement.length - 1];
@@ -413,7 +423,7 @@ const getDescendantXpath = (
     }
   }
 
-  const expCommonParentXpathElements = [];
+  const expCommonParentXpathElements: string[] = [];
   for (
     let j =
       relation === "descendant" ? parentElementNumber : parentElementNumber - 1;
@@ -488,15 +498,16 @@ const getDescendantXpath = (
           isIndex,
           expCommonParentXpathElements,
           step4,
-          refCommonParentXpathElementLength
+          refCommonParentXpathElementLength,
+          multiElementReferenceMode
         );
       }
     }
   }
 
   if (refExpectElement[refExpectElement.length - 2].attributes) {
-    for (const attrName of refExpectElement[refExpectElement.length - 2]
-      .attributes) {
+    for (const attrName of Array.from(refExpectElement[refExpectElement.length - 2]
+      .attributes)) {
       if (
         checkBlockedAttributes(attrName, refExpectElement[refExpectElement.length - 2], false)
       ) {
@@ -539,15 +550,16 @@ const getDescendantXpath = (
               isIndex,
               expCommonParentXpathElements,
               step4,
-              refCommonParentXpathElementLength
+              refCommonParentXpathElementLength,
+              multiElementReferenceMode
             );
           }
         }
       }
     }
 
-    for (const attrName of refExpectElement[refExpectElement.length - 2]
-      .attributes) {
+    for (const attrName of Array.from(refExpectElement[refExpectElement.length - 2]
+      .attributes)) {
       if (
         checkBlockedAttributes(attrName, refExpectElement[refExpectElement.length - 2], false)
       ) {
@@ -595,7 +607,8 @@ const getDescendantXpath = (
                 isIndex,
                 expCommonParentXpathElements,
                 step4,
-                refCommonParentXpathElementLength
+                refCommonParentXpathElementLength,
+                multiElementReferenceMode
               );
             }
           }
@@ -614,12 +627,13 @@ const getDescendantXpath = (
       ? "]".repeat(refCommonParentXpathElementLength)
       : "")
     }`,
-    expCommonParentXpathElements.reverse(),
+    expCommonParentXpathElements,
     refExpectElement[refExpectElement.length - 1],
     refExpectElement,
     docmt,
     relation,
-    isIndex
+    isIndex,
+    multiElementReferenceMode
   );
   if (traverseXpath) {
     return traverseXpath;
@@ -632,7 +646,8 @@ const getXpathRelationExpression = (
   relation: string,
   xpath1: any[],
   xpath2: any[],
-  isIndex: any
+  isIndex: boolean,
+  multiElementReferenceMode: boolean
 ) => {
   let xpaths1;
   let xpaths2;
@@ -716,7 +731,7 @@ const getXpathRelationExpression = (
             ? xpaths2[j].value
             : xpaths2[j].value.substring(xpaths2[j].value.indexOf("//") + 2)
             }`;
-          const xpath2Elements = tempPath.split(
+          const xpath2Elements: string[] = tempPath.split(
             /\/(?=(?:[^']*\'[^\']*\')*[^\']*$)/g
           );
           if (xpath2Elements.length > 1) {
@@ -735,7 +750,8 @@ const getXpathRelationExpression = (
               [element1, element2],
               element2.ownerDocument,
               relation,
-              isIndex
+              isIndex,
+              multiElementReferenceMode
             );
 
             console.log('getXpathRelationExpression traverseXpath', traverseXpath)
@@ -787,7 +803,7 @@ const getReferenceElementXpath = (element: HTMLElement | Element) => {
     xpaths1 = [
       {
         key: "",
-        value: getRelativeXPath(element, element.ownerDocument, false, false, [...element.attributes]),
+        value: getRelativeXPath(element, element.ownerDocument, false, false, Array.from(element.attributes)),
       },
     ];
   }
@@ -796,7 +812,7 @@ const getReferenceElementXpath = (element: HTMLElement | Element) => {
     xpaths1 = [
       {
         key: "",
-        value: getRelativeXPath(element, element.ownerDocument, true, false, [...element.attributes]),
+        value: getRelativeXPath(element, element.ownerDocument, true, false, Array.from(element.attributes)),
       },
     ];
     xpaths1 = xpaths1?.map((x) =>
@@ -836,52 +852,16 @@ const getReferenceElementXpath = (element: HTMLElement | Element) => {
 
 const getTraverseXpathExpression = (
   xpathe1: string,
-  absoluteXpathElements: any[],
+  absoluteXpathElements: string[],
   element2: HTMLElement | Element,
   refExpectElement: Array<HTMLElement | Element>,
   docmt: Node,
   relation: string,
-  isIndex: any
+  isIndex: boolean,
+  multiElementReferenceMode: boolean
 ) => {
-  let finalExpectedElementXpath: string | undefined
-  if (multiElementReferenceMode) {
-    const xpath2 = absoluteXpathElements.join("/");
-    finalExpectedElementXpath = `//${xpathe1}/${relation}::${replaceActualAttributes(
-      xpath2,
-      element2
-    )}`;
-    const rel_count = getCountOfXPath(
-      finalExpectedElementXpath,
-      element2,
-      docmt
-    );
-    if (rel_count === 1) {
-      return [
-        {
-          key: `dynamic ${relation}`,
-          value: replaceTempAttributes(finalExpectedElementXpath),
-        },
-      ];
-    }
-    if (rel_count > 1) {
-      if (isIndex) {
-        finalExpectedElementXpath = findXpathWithIndex(
-          finalExpectedElementXpath,
-          refExpectElement[refExpectElement.length - 1],
-          docmt,
-          rel_count
-        );
-        if (finalExpectedElementXpath) {
-          return [
-            {
-              key: `dynamic ${relation}${isIndex ? " index" : ""}`,
-              value: replaceTempAttributes(finalExpectedElementXpath),
-            },
-          ];
-        }
-      }
-    }
-  } else {
+  let finalExpectedElementXpath: string | undefined;
+  if (!multiElementReferenceMode) {
     for (let x = 1; x <= absoluteXpathElements.length; x++) {
       const xpath2 = absoluteXpathElements
         .slice(absoluteXpathElements.length - x, absoluteXpathElements.length)
@@ -922,6 +902,43 @@ const getTraverseXpathExpression = (
         }
       }
     }
+  } else {
+    const xpath2 = absoluteXpathElements.join("/");
+    finalExpectedElementXpath = `//${xpathe1}/${relation}::${replaceActualAttributes(
+      xpath2,
+      element2
+    )}`;
+    const rel_count = getCountOfXPath(
+      finalExpectedElementXpath,
+      element2,
+      docmt
+    );
+    if (rel_count === 1) {
+      return [
+        {
+          key: `dynamic ${relation}`,
+          value: replaceTempAttributes(finalExpectedElementXpath),
+        },
+      ];
+    }
+    if (rel_count > 1) {
+      if (isIndex) {
+        finalExpectedElementXpath = findXpathWithIndex(
+          finalExpectedElementXpath,
+          refExpectElement[refExpectElement.length - 1],
+          docmt,
+          rel_count
+        );
+        if (finalExpectedElementXpath) {
+          return [
+            {
+              key: `dynamic ${relation}${isIndex ? " index" : ""}`,
+              value: replaceTempAttributes(finalExpectedElementXpath),
+            },
+          ];
+        }
+      }
+    }
   }
 };
 

package/src/utils/xpath.ts

@@ -127,7 +127,7 @@ const getUniqueParentXpath = (
 
     while (currentNode && currentNode.nodeType === 1) {
       const hasUniqueAttr = false;
-      for (const attrName of currentNode.attributes) {
+      for (const attrName of Array.from(currentNode.attributes)) {
         if (checkBlockedAttributes(attrName, currentNode, isTarget)) {
           let attrValue = attrName.nodeValue;
 
@@ -299,7 +299,7 @@ const getParentRelativeXpath = (
 
       // BASE CASE #2: Check for unique attributes
       let uniqueAttrFound = false;
-      for (const attr of currentNode.attributes) {
+      for (const attr of Array.from(currentNode.attributes)) {
         if (checkBlockedAttributes(attr, currentNode, isTarget)) {
           let attrValue = attr.nodeValue;
 
@@ -393,7 +393,7 @@ const getChildRelativeXpath = (
     do {
       let uniqueAttrFound = false;
       for (currentNode = st.pop()!; currentNode !== null; ) {
-        for (const attr of currentNode.attributes) {
+        for (const attr of Array.from(currentNode.attributes)) {
           if (checkBlockedAttributes(attr, currentNode, true)) {
             let attrValue = attr.nodeValue;
 
@@ -522,7 +522,7 @@ const processSibling = (
 ) => {
   try {
     if (sibling.hasAttributes()) {
-      for (const attr of sibling.attributes) {
+      for (const attr of Array.from(sibling.attributes)) {
         let xpathe = intermediateXpathStep(
           sibling,
           {
@@ -1055,13 +1055,15 @@ export const parseDOM = (
   const docmt = targetElemt?.ownerDocument || doc;
   const tag = targetElemt.tagName;
   const { attributes } = targetElemt;
-  addAllXPathAttributes([...attributes], targetElemt, docmt, isIndex, isTarget);
+  addAllXPathAttributes(Array.from(attributes), targetElemt, docmt, isIndex, isTarget);
   if (!referenceElementMode) {
     if (xpathData.length) {
       const len = xpathData.length;
       for (let i = 0; i < len; i++) {
         let xpth = xpathData[i].value;
-        xpth = xpth.replace(tag, "*");
+        xpth = "//*" + xpth.substring(
+          xpth.indexOf("//") + 2 + tag.length
+        );
         const count = getCountOfXPath(xpth, element, docmt);
         if (count === 1) {
           xpathData.push({
@@ -1080,7 +1082,7 @@ export const parseDOM = (
       docmt,
       isIndex,
       isTarget,
-      [...targetElemt.attributes]
+      Array.from(targetElemt.attributes)
     );
   }
 

package/src/utils/xpathHelpers.ts

@@ -1,7 +1,6 @@
 export const reWhiteSpace = /^[\S]+( [\S]+)*$/gi;
-let cspEnabled: boolean = false;
+export let cspEnabled: boolean = false;
 const xpathCache: { [x: string]: number } = {};
-let multiElementReferenceMode: boolean = false;
 let relativeXPathCache = new Map();
 export let modifiedElementAttributes: {
   url: string | null;
@@ -67,7 +66,7 @@ export const buildPattern = (
   pattern: string,
   isSvg: boolean,
   tagName: string
-) => {
+): string => {
   return isSvg
     ? `//*[local-name()='${tagName}' and ${pattern}]`
     : `//${tagName}[${pattern}]`;
@@ -99,15 +98,16 @@ export const getTextContent = (
   return "";
 };
 
-export const getFilteredText = (element: Node) => {
+export const getFilteredText = (element: Node): string => {
   return element?.childNodes[0]?.nodeValue || "";
 };
 
 export const getCountOfXPath = (
   xpath: string,
   element: HTMLElement | Element,
-  docmt: Node
-) => {
+  docmt: Node,
+  multiElementReferenceMode: boolean = false
+): number => {
   try {
     let count;
     // Check if result is cached
@@ -160,7 +160,7 @@ export const getCountOfXPath = (
   }
 };
 
-export const escapeCharacters = (text: string) => {
+export const escapeCharacters = (text: string): string => {
   if (text) {
     if (!(text.indexOf('"') === -1)) {
       return `'${text}'`;
@@ -172,7 +172,7 @@ export const escapeCharacters = (text: string) => {
   return `'${text}'`;
 };
 
-export const removeParenthesis = (xpath: string) => {
+export const removeParenthesis = (xpath: string): string => {
   const charArr = xpath.split("");
 
   let count = charArr.length;
@@ -243,12 +243,12 @@ export const findXpathWithIndex = (
   }
 };
 
-const deleteLineGap = (a: string) => {
+const deleteLineGap = (a: string): string => {
   a &&= a.split("\n")[0].length > 0 ? a.split("\n")[0] : a.split("\n")[1];
   return a;
 };
 
-const deleteGarbageFromInnerText = (a: string) => {
+const deleteGarbageFromInnerText = (a: string): string => {
   a = deleteLineGap(a);
   a = a
     .split(/[^\u0000-\u00ff]/)
@@ -259,7 +259,7 @@ const deleteGarbageFromInnerText = (a: string) => {
   return (a = a.split("/")[0].trim());
 };
 
-export const replaceWhiteSpaces = (str: string) => {
+export const replaceWhiteSpaces = (str: string): string => {
   if (str) {
     return str.replace(/\s\s+/g, " ").trim();
   }
@@ -267,7 +267,7 @@ export const replaceWhiteSpaces = (str: string) => {
   return str;
 };
 
-export const getShadowRoot = (a: HTMLElement | Element) => {
+export const getShadowRoot = (a: HTMLElement | Element): Element | null => {
   for (a = a && a.parentElement!; a; ) {
     if (a.toString() === "[object ShadowRoot]") return a;
     a = a.parentElement!;
@@ -282,7 +282,7 @@ export const checkBlockedAttributes = (
   },
   targetElement: HTMLElement | Element,
   isTarget: boolean
-) => {
+): boolean => {
   if (
     !attribute?.value ||
     typeof attribute?.value === "boolean" ||
@@ -308,7 +308,7 @@ export const checkBlockedAttributes = (
   return true;
 };
 
-export const getRelationship = (a: HTMLElement, b: HTMLElement) => {
+export const getRelationship = (a: HTMLElement, b: HTMLElement): string => {
   let pos = a.compareDocumentPosition(b);
   return pos === 2
     ? "preceding"
@@ -323,14 +323,6 @@ export const getRelationship = (a: HTMLElement, b: HTMLElement) => {
     : "";
 };
 
-export const findRoot = (node: Node) => {
-  while (node && node.parentNode) {
-    node = node.parentNode;
-  }
-
-  return node;
-};
-
 export const isSvg = (element: HTMLElement | Element) => {
   return element instanceof SVGElement;
 };
@@ -654,10 +646,10 @@ export const getRelativeXPath = (
     while (currentNode) {
       let xpathe: string | undefined = "";
       let hasUniqueAttr = false;
-      let attributes = domNode === currentNode ? attributesArray : currentNode.attributes
+      let attributes = domNode === currentNode ? attributesArray ?? currentNode.attributes : currentNode.attributes
 
       // Loop through attributes to check for unique identifiers
-      for (const attrName of attributes) {
+      for (const attrName of Array.from(attributes)) {
         if (checkBlockedAttributes(attrName, currentNode, isTarget)) {
           let attrValue = attrName.nodeValue;
 
@@ -880,7 +872,7 @@ export const getAttributeCombinationXpath = (
   docmt: Document,
   uniqueAttributes: Attr[],
   isTarget: boolean
-) => {
+): string | undefined => {
   try {
     const xpathAttributes = [];
 
@@ -971,7 +963,7 @@ export const intermediateXpathStep = (
 export const getFilteredTextXPath = (
   node: HTMLElement | Element,
   docmt: Document
-) => {
+): string => {
   if (!node.textContent) return "";
 
   const filteredText = getFilteredText(node);
@@ -997,7 +989,7 @@ export const getFilteredTextXPath = (
   return xpathe;
 };
 
-export const getTextXpathFunction = (domNode: HTMLElement | Element) => {
+export const getTextXpathFunction = (domNode: HTMLElement | Element): string | undefined => {
   const trimmedText = getTextContent(domNode)?.trim();
   const filteredText = trimmedText
     ? escapeCharacters(deleteGarbageFromInnerText(trimmedText))
@@ -1014,7 +1006,7 @@ export const getXpathString = (
   node: HTMLElement | Element,
   attrName: string,
   attrValue: string
-) => {
+): string => {
   const reWhiteSpace = new RegExp(/^[\S]+( [\S]+)*$/gi);
   let xpathe: string = "";
 
@@ -1052,7 +1044,7 @@ export const getXpathString = (
 export const replaceActualAttributes = (
   str: string,
   element: { attributes: any }
-) => {
+): string => {
   if (str) {
     return str.replace(/\bdisabled\b/gi, "flndisabled");
   }
@@ -1064,7 +1056,7 @@ const addAttributeSplitCombineXpaths = (
   targetElemt: HTMLElement | Element,
   docmt: Document,
   isTarget: boolean
-) => {
+): { key: string; value: string }[] => {
   const attributesArray = Array.prototype.slice.call(attributes);
   const xpaths: { key: string; value: string }[] = [];
   try {
@@ -1090,7 +1082,7 @@ export const getReferenceElementsXpath = (
   domNode: HTMLElement | Element,
   docmt: Document,
   isTarget: boolean
-) => {
+): { key: string; value: string }[] => {
   let nodeXpath1;
   const xpaths1 = [];
   if (
@@ -1119,7 +1111,7 @@ export const getReferenceElementsXpath = (
   }
 
   if (domNode.attributes) {
-    for (const attrName of domNode.attributes) {
+    for (const attrName of Array.from(domNode.attributes)) {
       if (checkBlockedAttributes(attrName, domNode, isTarget)) {
         let attrValue = attrName.nodeValue;
         if (attrValue) {
@@ -1232,7 +1224,7 @@ export const getReferenceElementsXpath = (
   return xpaths1;
 };
 
-export function parseXml(xmlStr: string) {
+export const parseXml = (xmlStr: string): Document | null => {
   if (window.DOMParser) {
     return new window.DOMParser().parseFromString(xmlStr, "text/xml");
   }
@@ -1296,4 +1288,5 @@ export const xpathUtils = {
   startObserver,
   stopObserver,
   modifiedElementAttributes,
+  cspEnabled
 };

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
     "compilerOptions": {
       "target": "esnext",
-      "lib": ["dom", "ESNext"],
+      "lib": ["dom", "dom.iterable", "ESNext"],
       "moduleResolution": "bundler",
       "module": "esnext",
       "allowImportingTsExtensions": true,