@usertour/helpers 0.0.6 → 0.0.7

package/dist/index.cjs

@@ -58,11 +58,14 @@ __export(src_exports, {
   deepClone: () => deepClone,
   defaultContentConfig: () => defaultContentConfig,
   defaultStep: () => defaultStep,
-  document: () => document,
+  document: () => document2,
   evalCode: () => evalCode,
   fetch: () => fetch,
   filterAutoStartContent: () => filterAutoStartContent,
   findLatestEvent: () => findLatestEvent,
+  finder: () => finder,
+  finderV2: () => finderV2,
+  finderX: () => finderX,
   flowIsDismissed: () => flowIsDismissed,
   flowIsSeen: () => flowIsSeen,
   formatDate: () => formatDate,
@@ -122,6 +125,8 @@ __export(src_exports, {
   nativeIndexOf: () => nativeIndexOf,
   navigator: () => navigator,
   parseUrlParams: () => parseUrlParams,
+  parserV2: () => parserV2,
+  parserX: () => parserX,
   removeAuthToken: () => removeAuthToken,
   setAuthToken: () => setAuthToken,
   storage: () => storage,
@@ -831,7 +836,7 @@ var ArrayProto = Array.prototype;
 var nativeForEach = ArrayProto.forEach;
 var nativeIndexOf = ArrayProto.indexOf;
 var navigator = global == null ? void 0 : global.navigator;
-var document = global == null ? void 0 : global.document;
+var document2 = global == null ? void 0 : global.document;
 var location = global == null ? void 0 : global.location;
 var fetch = global == null ? void 0 : global.fetch;
 var XMLHttpRequest = (global == null ? void 0 : global.XMLHttpRequest) && "withCredentials" in new global.XMLHttpRequest() ? global.XMLHttpRequest : void 0;
@@ -1394,7 +1399,319 @@ var JWTLicenseValidator = {
 
 // src/conditions.ts
 var import_dom = require("@floating-ui/dom");
-var import_finder = require("@usertour-packages/finder");
+
+// src/finderx.ts
+var import_finder = require("@medv/finder");
+var finderAttrs = [
+  "data-for",
+  "data-id",
+  "data-testid",
+  "data-test-id",
+  "for",
+  "id",
+  "name",
+  "placeholder",
+  "role"
+];
+var defaultConfig = {
+  idName: () => false,
+  className: () => false,
+  tagName: () => false,
+  attr: () => false,
+  seedMinLength: 1,
+  optimizedMinLength: 2,
+  threshold: 1e3,
+  maxNumberOfTries: 1e4
+};
+var finderConfigs = [
+  {
+    ...defaultConfig,
+    tagName: () => true
+  },
+  {
+    ...defaultConfig,
+    idName: () => true
+  },
+  {
+    ...defaultConfig,
+    tagName: () => true,
+    attr: (name) => finderAttrs.includes(name)
+  },
+  {
+    ...defaultConfig,
+    className: () => true,
+    attr: (name) => finderAttrs.includes(name)
+  },
+  {
+    ...defaultConfig,
+    tagName: () => true,
+    idName: () => true,
+    className: () => true,
+    attr: () => false
+  },
+  {
+    ...defaultConfig,
+    tagName: () => true,
+    idName: () => true,
+    className: () => true,
+    attr: (name) => finderAttrs.includes(name)
+  }
+];
+function getMaxDepth(node) {
+  if (node.parentNode) {
+    return getMaxDepth(node.parentNode);
+  }
+  return node.depth;
+}
+function queryNodeListBySelectors(selectors, rootDocument, removeRepeat = true) {
+  const nodes = [];
+  if (!selectors) {
+    return nodes;
+  }
+  for (const s of selectors) {
+    const els = rootDocument.querySelectorAll(s.replace(/\\\\/g, "\\"));
+    if (els && els.length > 0) {
+      nodes.push(...Array.from(els));
+    }
+  }
+  return removeRepeat ? [...new Set(nodes)] : nodes;
+}
+function findMostRecurringNode(nodes) {
+  const m = /* @__PURE__ */ new Map();
+  let finalNode = nodes[0];
+  let count = 0;
+  for (const node of nodes) {
+    const i = m.get(node) ? m.get(node) + 1 : 1;
+    m.set(node, i);
+  }
+  m.forEach((value, key) => {
+    if (value > count) {
+      count = value;
+      finalNode = key;
+    }
+  });
+  return finalNode;
+}
+function compareParentNode(node, el, rootDocument, isCompareSibings = false) {
+  let nodeParentNode = node.parentNode;
+  let elParentElement = el.parentElement;
+  const maxDepth = getMaxDepth(node);
+  const xresult = {
+    maxDepth,
+    failedDepth: 0,
+    success: true
+  };
+  while (nodeParentNode && elParentElement) {
+    if (elParentElement === rootDocument) {
+      break;
+    }
+    if (elParentElement === document.body || elParentElement === document.documentElement || elParentElement.parentElement === document.body) {
+      break;
+    }
+    const parentNodes = queryNodeListBySelectors(nodeParentNode.selectors, rootDocument);
+    const isMatchSibings = isCompareSibings ? compareSibingsNode(nodeParentNode, elParentElement, rootDocument) : true;
+    if (!parentNodes || parentNodes.length === 0 || !parentNodes.includes(elParentElement) || !isMatchSibings) {
+      xresult.failedDepth = nodeParentNode.depth;
+      xresult.success = false;
+    }
+    nodeParentNode = nodeParentNode.parentNode;
+    elParentElement = elParentElement.parentElement;
+  }
+  return xresult;
+}
+function compareSibingsNode(node, el, rootDocument) {
+  let isMatchNext = true;
+  let isMatchPrevious = true;
+  const { previousElementSelectors, nextElementSelectors } = node;
+  if (nextElementSelectors && nextElementSelectors.length > 0) {
+    const nextElementSiblings = queryNodeListBySelectors(nextElementSelectors, rootDocument);
+    isMatchNext = el.nextElementSibling && nextElementSiblings.includes(el.nextElementSibling);
+  }
+  if (previousElementSelectors && previousElementSelectors.length > 0) {
+    const previousElementSiblings = queryNodeListBySelectors(
+      previousElementSelectors,
+      rootDocument
+    );
+    isMatchPrevious = el.previousElementSibling && previousElementSiblings.includes(el.previousElementSibling);
+  }
+  return isMatchNext && isMatchPrevious;
+}
+function queryElementSelectors(input) {
+  const classes = Array.from(input.classList);
+  const selectors = [];
+  const configs = [...finderConfigs];
+  for (const className of classes) {
+    configs.push({
+      ...defaultConfig,
+      className: (name) => {
+        if (classes.filter((cn2) => cn2 !== className).includes(name)) {
+          return false;
+        }
+        return true;
+      }
+    });
+  }
+  try {
+    for (const cfg of configs) {
+      selectors.push(finder(input, cfg));
+    }
+  } catch (_) {
+    return selectors;
+  }
+  return [...new Set(selectors)];
+}
+function parseSelectorsTree(input, parentNode, depth = 0) {
+  const selectors = queryElementSelectors(input);
+  if (selectors.length === 0) {
+    return parentNode;
+  }
+  const currentNode = {
+    previousElementSelectors: [],
+    nextElementSelectors: [],
+    selectors,
+    depth
+  };
+  if (input.previousElementSibling) {
+    currentNode.previousElementSelectors = queryElementSelectors(input.previousElementSibling);
+  }
+  if (input.nextElementSibling) {
+    currentNode.nextElementSelectors = queryElementSelectors(input.nextElementSibling);
+  }
+  if (parentNode === null) {
+    if (input.parentElement) {
+      parseSelectorsTree(input.parentElement, currentNode, depth + 1);
+    }
+    return currentNode;
+  }
+  parentNode.parentNode = currentNode;
+  if (input.parentElement) {
+    parseSelectorsTree(input.parentElement, currentNode, depth + 1);
+  }
+  return parentNode;
+}
+function finderMostPrecisionElement(elements, node, rootDocument, precision) {
+  const successEls = [];
+  let failedData = {
+    el: null,
+    failedDepth: 0,
+    maxDepth: 0
+  };
+  for (const el of elements) {
+    const { success, failedDepth, maxDepth } = compareParentNode(node, el, rootDocument);
+    if (success) {
+      successEls.push(el);
+    } else if (!failedData.el || failedDepth > failedData.failedDepth) {
+      failedData = { el, failedDepth, maxDepth };
+    }
+  }
+  if (successEls.length === 1) {
+    return successEls[0];
+  }
+  if (successEls.length > 1) {
+    let tempEl = successEls[0];
+    let tempFailedDepth = 0;
+    for (const el of successEls) {
+      const { success, failedDepth } = compareParentNode(node, el, rootDocument, true);
+      if (success) {
+        return el;
+      }
+      if (failedDepth > tempFailedDepth) {
+        tempFailedDepth = failedDepth;
+        tempEl = el;
+      }
+    }
+    return tempEl;
+  }
+  if (failedData.el) {
+    const { failedDepth, maxDepth, el } = failedData;
+    const rate = (failedDepth - 1) / maxDepth * 10;
+    if (rate >= precision) {
+      return el;
+    }
+  }
+  return null;
+}
+function finder(input, options) {
+  return (0, import_finder.finder)(input, options);
+}
+function parserX(input) {
+  return parseSelectorsTree(input, null);
+}
+function parserV2(element) {
+  var _a;
+  const content = (_a = element.innerText) != null ? _a : "";
+  const selectors = parseSelectorsTree(element, null);
+  const selectorsList = queryElementSelectors(element);
+  return { content, selectors, selectorsList };
+}
+function finderV2(target, root) {
+  const {
+    selectors,
+    content = "",
+    sequence = 0,
+    precision = "strict",
+    isDynamicContent = false,
+    customSelector = "",
+    type = "auto"
+  } = target;
+  if (type === "auto") {
+    const mapping = {
+      looser: 1,
+      loose: 3,
+      loosest: 5,
+      strict: 7,
+      stricter: 8,
+      strictest: 10
+    };
+    const el = finderX(selectors, root, mapping[precision]);
+    if (el) {
+      if (isDynamicContent && content && el.innerText !== content) {
+        return null;
+      }
+      return el;
+    }
+  } else {
+    const sequenceMapping = {
+      "1st": 0,
+      "2st": 1,
+      "3st": 2,
+      "4st": 3,
+      "5st": 4
+    };
+    if (customSelector) {
+      const selector = customSelector.replace(/\\\\/g, "\\");
+      const els = root.querySelectorAll(selector);
+      if (els.length > 0) {
+        const el = els[sequenceMapping[sequence]] || els[0];
+        if (content && el.innerText.trim() !== content) {
+          return null;
+        }
+        return el;
+      }
+    }
+  }
+  return null;
+}
+function finderX(node, root, precision = 10) {
+  if (!node || node.selectors.length === 0) {
+    return null;
+  }
+  const rootDocument = root || document;
+  const elements = [];
+  const nodeList = queryNodeListBySelectors(node.selectors, rootDocument, false);
+  if (!nodeList || nodeList.length === 0) {
+    return null;
+  }
+  if ([...new Set(nodeList)].length !== nodeList.length) {
+    const el = findMostRecurringNode(nodeList);
+    elements.push(el);
+  } else {
+    elements.push(...nodeList);
+  }
+  return finderMostPrecisionElement(elements, node, rootDocument, precision);
+}
+
+// src/conditions.ts
 var import_types4 = require("@usertour/types");
 var import_date_fns = require("date-fns");
 
@@ -1462,10 +1779,10 @@ var isActivedContentRulesCondition = (rules, contentSession) => {
 };
 var isVisible = async (el) => {
   var _a, _b;
-  if (!((_a = document) == null ? void 0 : _a.body)) {
+  if (!((_a = document2) == null ? void 0 : _a.body)) {
     return false;
   }
-  const { middlewareData } = await (0, import_dom.computePosition)(el, document.body, {
+  const { middlewareData } = await (0, import_dom.computePosition)(el, document2.body, {
     strategy: "fixed",
     middleware: [(0, import_dom.hide)()]
   });
@@ -1489,10 +1806,10 @@ var isClicked = (el) => {
 };
 var isActiveRulesByElement = async (rules) => {
   const { data } = rules;
-  if (!document) {
+  if (!document2) {
     return false;
   }
-  const el = (0, import_finder.finderV2)(data.elementData, document);
+  const el = finderV2(data.elementData, document2);
   const isPresent = el ? await isVisible(el) : false;
   const isDisabled = el ? el.disabled : false;
   switch (data.logic) {
@@ -1516,10 +1833,10 @@ var isActiveRulesByTextInput = async (rules) => {
   const {
     data: { elementData, logic, value }
   } = rules;
-  if (!document) {
+  if (!document2) {
     return false;
   }
-  const el = (0, import_finder.finderV2)(elementData, document);
+  const el = finderV2(elementData, document2);
   if (!el) {
     return false;
   }
@@ -1554,10 +1871,10 @@ var isActiveRulesByTextFill = async (rules) => {
   const {
     data: { elementData }
   } = rules;
-  if (!document) {
+  if (!document2) {
     return false;
   }
-  const el = (0, import_finder.finderV2)(elementData, document);
+  const el = finderV2(elementData, document2);
   if (!el) {
     return false;
   }
@@ -1573,13 +1890,13 @@ var isActiveRulesByTextFill = async (rules) => {
       return true;
     }
     if (timestamp !== -1 && now - timestamp > 1e3 && value !== el.value) {
-      off(document, "click", onKeyup);
+      off(document2, "click", onKeyup);
       fillCache.set(el, { timestamp, value, isActive: true });
       return true;
     }
     return false;
   }
-  on(document, "keyup", onKeyup);
+  on(document2, "keyup", onKeyup);
   fillCache.set(el, { timestamp: -1, value: el.value, isActive: false });
   return false;
 };
@@ -1974,6 +2291,9 @@ var wait = (seconds) => {
   fetch,
   filterAutoStartContent,
   findLatestEvent,
+  finder,
+  finderV2,
+  finderX,
   flowIsDismissed,
   flowIsSeen,
   formatDate,
@@ -2033,6 +2353,8 @@ var wait = (seconds) => {
   nativeIndexOf,
   navigator,
   parseUrlParams,
+  parserV2,
+  parserX,
   removeAuthToken,
   setAuthToken,
   storage,

package/dist/index.d.cts

@@ -14,6 +14,7 @@ export { absoluteUrl, cn, cuid, evalCode, formatDate, getRandomColor, hexToRgb,
 export { GenerateLicenseOptions, JWTLicenseSigner, JWTLicenseSignerOptions } from './jwt-license-signer.cjs';
 export { JWTLicenseValidator } from './jwt-license-validator.cjs';
 export { PRIORITIES, activedContentCondition, activedContentRulesConditions, activedRulesConditions, checklistIsDimissed, checklistIsSeen, filterAutoStartContent, findLatestEvent, flowIsDismissed, flowIsSeen, isActive, isActiveContent, isHasActivedContents, isSameContents, isValidContent, isVisible, parseUrlParams, wait } from './conditions.cjs';
+export { Options, Target, TargetResult, XData, XNode, XResult, finder, finderV2, finderX, parserV2, parserX } from './finderx.cjs';
 export { default as isEqual } from 'fast-deep-equal';
 import '@usertour/types';
 import './storage.cjs';

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export { absoluteUrl, cn, cuid, evalCode, formatDate, getRandomColor, hexToRgb,
 export { GenerateLicenseOptions, JWTLicenseSigner, JWTLicenseSignerOptions } from './jwt-license-signer.js';
 export { JWTLicenseValidator } from './jwt-license-validator.js';
 export { PRIORITIES, activedContentCondition, activedContentRulesConditions, activedRulesConditions, checklistIsDimissed, checklistIsSeen, filterAutoStartContent, findLatestEvent, flowIsDismissed, flowIsSeen, isActive, isActiveContent, isHasActivedContents, isSameContents, isValidContent, isVisible, parseUrlParams, wait } from './conditions.js';
+export { Options, Target, TargetResult, XData, XNode, XResult, finder, finderV2, finderX, parserV2, parserX } from './finderx.js';
 export { default as isEqual } from 'fast-deep-equal';
 import '@usertour/types';
 import './storage.js';

package/dist/index.js

@@ -1,3 +1,6 @@
+import {
+  defaultStep
+} from "./chunk-FW54TSA3.js";
 import {
   deepClone
 } from "./chunk-2AEGAICC.js";
@@ -21,9 +24,6 @@ import {
 import {
   JWTLicenseValidator
 } from "./chunk-Y5PCSFVZ.js";
-import {
-  defaultStep
-} from "./chunk-FW54TSA3.js";
 import {
   getAuthToken,
   removeAuthToken,
@@ -50,7 +50,14 @@ import {
   isVisible,
   parseUrlParams,
   wait
-} from "./chunk-OASNBRBF.js";
+} from "./chunk-7IK5Q5N2.js";
+import {
+  finder,
+  finderV2,
+  finderX,
+  parserV2,
+  parserX
+} from "./chunk-DEG6MTU7.js";
 import "./chunk-Y6FPPOKF.js";
 import {
   AbortController,
@@ -156,6 +163,9 @@ export {
   fetch,
   filterAutoStartContent,
   findLatestEvent,
+  finder,
+  finderV2,
+  finderX,
   flowIsDismissed,
   flowIsSeen,
   formatDate,
@@ -215,6 +225,8 @@ export {
   nativeIndexOf,
   navigator,
   parseUrlParams,
+  parserV2,
+  parserX,
   removeAuthToken,
   setAuthToken,
   storage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usertour/helpers",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "type": "module",
   "description": "Utility functions and helpers shared across the UserTour project",
   "homepage": "https://www.usertour.io",
@@ -26,26 +26,28 @@
     "prepublishOnly": "pnpm build"
   },
   "dependencies": {
+    "@floating-ui/dom": "^1.4.4",
+    "@medv/finder": "^3.1.0",
+    "@paralleldrive/cuid2": "^2.2.2",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@usertour-packages/finder": "workspace:^",
+    "@usertour/helpers": "link:",
     "@usertour/types": "^0.0.5",
-    "fast-deep-equal": "^3.1.3",
     "chroma-js": "^3.1.2",
-    "deepmerge-ts": "^7.1.3",
-    "@paralleldrive/cuid2": "^2.2.2",
     "class-variance-authority": "^0.4.0",
     "clsx": "^1.2.1",
-    "tailwind-merge": "^1.13.2",
-    "jsonwebtoken": "^9.0.2",
-    "@floating-ui/dom": "^1.4.4",
-    "@types/jsonwebtoken": "^9.0.10",
-    "@usertour-packages/finder": "workspace:^",
     "date-fns": "^2.30.0",
+    "deepmerge-ts": "^7.1.3",
+    "fast-deep-equal": "^3.1.3",
+    "jsonwebtoken": "^9.0.2",
+    "tailwind-merge": "^1.13.2",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.0",
-    "@typescript-eslint/parser": "^5.59.0",
     "@types/chroma-js": "^3.1.1",
     "@types/uuid": "^9.0.6",
+    "@typescript-eslint/eslint-plugin": "^5.59.0",
+    "@typescript-eslint/parser": "^5.59.0",
     "eslint": "^8.38.0",
     "typescript": "^5.0.2"
   },