ff-automationv2 2.2.28 → 2.2.30

package/dist/fireflinkData/fireflinkLocators/utils/xpathHelpers.d.ts

@@ -0,0 +1,135 @@
+import { platform } from "../../../core/types/scriptTypesType";
+export declare const reWhiteSpace: RegExp;
+export declare const cspEnabled: boolean;
+export declare const timeLog: (label: string, start: number) => void;
+type EvalResult = {
+    first: Node | null;
+    second: Node | null;
+};
+export declare const clearAiXPathEvalCache: (node?: Node | null) => void;
+type XPathIteratorResult = {
+    iterateNext: () => Node | null;
+};
+type XPathFirstResult = {
+    singleNodeValue: Node | null;
+};
+type XPathSnapshotResult = {
+    snapshotLength: number;
+    snapshotItem: (index: number) => Node | null;
+};
+export declare function evaluateAiXPath(xpath: string, contextNode: Node, mode?: "iterator"): XPathIteratorResult;
+export declare function evaluateAiXPath(xpath: string, contextNode: Node, mode: "first"): XPathFirstResult;
+export declare function evaluateAiXPath(xpath: string, contextNode: Node, mode: "snapshot"): XPathSnapshotResult;
+export declare const evaluateAIXPathOnce: (xpath: string, docmt: Node) => EvalResult;
+export declare const modifiedElementAttributes: {
+    url: string | null;
+    attributeName: string | null;
+    element: HTMLElement | Element;
+    doc: Document;
+}[];
+export declare const sanitizeAiAttributeValue: (attributeName: string, attributeValue: string | null | undefined) => string;
+export declare const isAiNumberExist: (str: string) => boolean;
+export declare const buildAiPattern: (pattern: string, isAiSvg: boolean, tagName: string) => string;
+export declare const getAiTextContent: (targetElement: HTMLElement | Element) => string;
+export declare const getAiFilteredText: (element: Node) => string;
+export declare const getAiCountOfXPath: (xpath: string, element: HTMLElement | Element, docmt: Node, multiElementReferenceMode?: boolean) => number;
+export declare const escapeAiCharacters: (text: string) => string;
+export declare const removeAiParenthesis: (xpath: string) => string;
+export declare const findAiXpathWithIndex: (val: string, node: HTMLElement | Element, docmt: Node, count: number) => string | undefined;
+export declare const aiReplaceWhiteSpaces: (str: string) => string;
+export declare const getAiShadowRoot: (el: HTMLElement | Element) => Element | null;
+export declare const createAIShadowEvaluationContext: (root: ShadowRoot, element?: HTMLElement | Element | (HTMLElement | Element)[]) => {
+    contextNode: HTMLDivElement;
+    cloneElement: Element | null;
+    cloneElements: (Element | null)[];
+};
+export declare const checkAiBlockedAttributes: (attribute: {
+    name: string;
+    value: string;
+}, targetElement: HTMLElement | Element, isTarget: boolean) => boolean;
+export declare const getAiRelationship: (a: HTMLElement, b: HTMLElement) => string;
+export declare const isAiSvg: (element: Element | null | undefined) => boolean;
+export declare const replaceAiTempAttributes: (str: string) => string;
+export declare const getAiPropertyXPath: (element: HTMLElement | Element, docmt: Document, prop: string, value: string, isTarget: boolean, platform: platform) => string | undefined;
+export declare const getAiAbsoluteXPath: (domNode: Element | null, docmt: Document) => string;
+export declare const getAIRelativeXPath: (domNode: HTMLElement | Element, docmt: Document, _isTarget?: boolean, attributesArray?: Attr[], platform?: platform) => string | null;
+export declare const getAiCombinationXpath: (attribute: Attr, domNode: HTMLElement | Element) => string | undefined;
+export declare const getAiAttributeCombinationXpath: (domNode: HTMLElement | Element, docmt: Document | ShadowRoot, uniqueAttributes: Attr[], isTarget: boolean, platform: platform) => string | undefined;
+export declare const intermediateAiXpathStep: (targetElemt: HTMLElement | Element, attr: {
+    name: string;
+    value: string;
+}, isTarget: boolean) => string;
+export declare const getAiFilteredTextXPath: (node: HTMLElement | Element) => string;
+export declare const getAiNormalizedPropertyXPath: (element: HTMLElement | Element, prop: string, value: string, platform: platform) => string;
+export declare const getAiStartsWithPropertyXPath: (element: HTMLElement | Element, prop: string, value: string, platform: platform) => string;
+export declare const getAiContainsPropertyXPath: (element: HTMLElement | Element, prop: string, value: string, platform: platform) => string;
+export declare const getOrAttributesAiXPath: (element: HTMLElement | Element, attributes: Attr[], platform: platform) => string;
+export declare const getAiTagOnlyXPath: (element: HTMLElement | Element, platform: platform, docmt?: Document | ShadowRoot) => string;
+export declare const getAiFirstMatchedNode: (xpath: string, docmt: Document | ShadowRoot) => HTMLElement | Element | null;
+export declare const isAiExactUniqueXpath: (xpath: string, element: HTMLElement | Element, docmt: Document | ShadowRoot) => boolean;
+export declare const getAiAxisNodeTest: (element: HTMLElement | Element, platform: platform) => string;
+export declare const getAiUniqueNodeAnchorXpaths: (node: Element, docmt: Document | ShadowRoot, isTarget: boolean, platform: platform) => {
+    key: string;
+    value: string;
+}[];
+export declare const getAiTextXpathFunction: (domNode: HTMLElement | Element) => string | undefined;
+export declare const getAiXpathString: (node: HTMLElement | Element, attrName: string, attrValue: string) => string;
+export declare const replaceAiActualAttributes: (str: string) => string;
+export declare const getReferenceElementsXpath: (domNode: HTMLElement | Element, docmt: Document, isTarget: boolean, platform: platform) => {
+    key: string;
+    value: string;
+}[];
+export declare const normalizeXPath: (xpath: string) => string;
+export declare const findMatchingParenthesis: (text: string, openPos: number) => number;
+export declare function escapeAttrValue(value: string): string;
+export declare function isAiUniqueInDOM(docmt: Document, name: string, value: string, element?: Element | null): boolean;
+export declare const xpathUtils: {
+    getReferenceElementsXpath: (domNode: HTMLElement | Element, docmt: Document, isTarget: boolean, platform: platform) => {
+        key: string;
+        value: string;
+    }[];
+    getAiAbsoluteXPath: (domNode: Element | null, docmt: Document) => string;
+    getAIRelativeXPath: (domNode: HTMLElement | Element, docmt: Document, _isTarget?: boolean, attributesArray?: Attr[], platform?: platform) => string | null;
+    getAiCombinationXpath: (attribute: Attr, domNode: HTMLElement | Element) => string | undefined;
+    getAiAttributeCombinationXpath: (domNode: HTMLElement | Element, docmt: Document | ShadowRoot, uniqueAttributes: Attr[], isTarget: boolean, platform: platform) => string | undefined;
+    isAiSvg: (element: Element | null | undefined) => boolean;
+    findAiXpathWithIndex: (val: string, node: HTMLElement | Element, docmt: Node, count: number) => string | undefined;
+    isAiNumberExist: (str: string) => boolean;
+    getAiTextContent: (targetElement: HTMLElement | Element) => string;
+    getAiCountOfXPath: (xpath: string, element: HTMLElement | Element, docmt: Node, multiElementReferenceMode?: boolean) => number;
+    normalizeXPath: (xpath: string) => string;
+    getAiShadowRoot: (el: HTMLElement | Element) => Element | null;
+    escapeAiCharacters: (text: string) => string;
+    removeAiParenthesis: (xpath: string) => string;
+    checkAiBlockedAttributes: (attribute: {
+        name: string;
+        value: string;
+    }, targetElement: HTMLElement | Element, isTarget: boolean) => boolean;
+    getAiRelationship: (a: HTMLElement, b: HTMLElement) => string;
+    findMatchingParenthesis: (text: string, openPos: number) => number;
+    deleteAiGarbageFromInnerText: (a: string) => string;
+    replaceAiTempAttributes: (str: string) => string;
+    modifiedElementAttributes: {
+        url: string | null;
+        attributeName: string | null;
+        element: HTMLElement | Element;
+        doc: Document;
+    }[];
+    cspEnabled: boolean;
+    getAiNormalizedPropertyXPath: (element: HTMLElement | Element, prop: string, value: string, platform: platform) => string;
+    getAiStartsWithPropertyXPath: (element: HTMLElement | Element, prop: string, value: string, platform: platform) => string;
+    getAiContainsPropertyXPath: (element: HTMLElement | Element, prop: string, value: string, platform: platform) => string;
+    getOrAttributesAiXPath: (element: HTMLElement | Element, attributes: Attr[], platform: platform) => string;
+    getAiTagOnlyXPath: (element: HTMLElement | Element, platform: platform, docmt?: Document | ShadowRoot) => string;
+    getAiFirstMatchedNode: (xpath: string, docmt: Document | ShadowRoot) => HTMLElement | Element | null;
+    isAiExactUniqueXpath: (xpath: string, element: HTMLElement | Element, docmt: Document | ShadowRoot) => boolean;
+    getAiAxisNodeTest: (element: HTMLElement | Element, platform: platform) => string;
+    getAiUniqueNodeAnchorXpaths: (node: Element, docmt: Document | ShadowRoot, isTarget: boolean, platform: platform) => {
+        key: string;
+        value: string;
+    }[];
+    escapeAttrValue: typeof escapeAttrValue;
+    isAiUniqueInDOM: typeof isAiUniqueInDOM;
+    sanitizeAiAttributeValue: (attributeName: string, attributeValue: string | null | undefined) => string;
+};
+export {};