@appium/universal-xml-plugin 1.0.0-beta.8 → 1.0.0-beta.9

package/lib/plugin.js

@@ -1,49 +1,59 @@
 /* eslint-disable no-case-declarations */
 
-import BasePlugin from '@appium/base-plugin';
-import { errors } from '@appium/base-driver';
-import { transformSourceXml } from './source';
-import { transformQuery } from './xpath';
+import BasePlugin from 'appium/plugin';
+import {errors} from 'appium/driver';
+import {transformSourceXml} from './source';
+import {transformQuery} from './xpath';
 import log from './logger';
 
 export default class UniversalXMLPlugin extends BasePlugin {
+  commands = [
+    'getPageSource',
+    'findElement',
+    'findElements',
+    'findElementFromElement',
+    'findElementsFromElement',
+  ];
 
-  commands = ['getPageSource', 'findElement', 'findElements', 'findElementFromElement',
-    'findElementsFromElement'];
-
-  async getPageSource (next, driver, sessId, addIndexPath = false) {
+  async getPageSource(next, driver, sessId, addIndexPath = false) {
     const source = next ? await next() : await driver.getPageSource();
     const metadata = {};
     const {platformName} = driver.caps;
     if (platformName.toLowerCase() === 'android') {
       metadata.appPackage = driver.opts.appPackage;
     }
-    const {xml, unknowns} = transformSourceXml(source,
-      platformName.toLowerCase(), {metadata, addIndexPath});
+    const {xml, unknowns} = transformSourceXml(source, platformName.toLowerCase(), {
+      metadata,
+      addIndexPath,
+    });
     if (unknowns.nodes.length) {
-      log.warn(`The XML mapper found ${unknowns.nodes.length} node(s) / ` +
-               `tag name(s) that it didn't know about. These should be ` +
-               `reported to improve the quality of the plugin: ` +
-               unknowns.nodes.join(', '));
+      log.warn(
+        `The XML mapper found ${unknowns.nodes.length} node(s) / ` +
+          `tag name(s) that it didn't know about. These should be ` +
+          `reported to improve the quality of the plugin: ` +
+          unknowns.nodes.join(', ')
+      );
     }
     if (unknowns.attrs.length) {
-      log.warn(`The XML mapper found ${unknowns.attrs.length} attributes ` +
-               `that it didn't know about. These should be reported to ` +
-               `improve the quality of the plugin: ` +
-               unknowns.attrs.join(', '));
+      log.warn(
+        `The XML mapper found ${unknowns.attrs.length} attributes ` +
+          `that it didn't know about. These should be reported to ` +
+          `improve the quality of the plugin: ` +
+          unknowns.attrs.join(', ')
+      );
     }
     return xml;
   }
 
-  async findElement (...args) {
+  async findElement(...args) {
     return await this._find(false, ...args);
   }
 
-  async findElements (...args) {
+  async findElements(...args) {
     return await this._find(true, ...args);
   }
 
-  async _find (multiple, next, driver, strategy, selector) {
+  async _find(multiple, next, driver, strategy, selector) {
     const {platformName} = driver.caps;
     if (strategy.toLowerCase() !== 'xpath') {
       return await next();
@@ -54,8 +64,10 @@ export default class UniversalXMLPlugin extends BasePlugin {
     // if the selector was not able to be transformed, that means no elements were found that
     // matched, so do the appropriate thing based on element vs elements
     if (newSelector === null) {
-      log.warn(`Selector was not able to be translated to underlying XML. Either the requested ` +
-               `element does not exist or there was an error in translation`);
+      log.warn(
+        `Selector was not able to be translated to underlying XML. Either the requested ` +
+          `element does not exist or there was an error in translation`
+      );
       if (multiple) {
         return [];
       }
@@ -74,7 +86,6 @@ export default class UniversalXMLPlugin extends BasePlugin {
     const finder = multiple ? 'findElements' : 'findElement';
     return await driver[finder](strategy, newSelector);
   }
-
 }
 
-export { UniversalXMLPlugin };
+export {UniversalXMLPlugin};

package/lib/source.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
-import parser, { j2xParser } from 'fast-xml-parser';
+import parser, {j2xParser} from 'fast-xml-parser';
 import NODE_MAP from './node-map';
-import { ATTR_MAP, REMOVE_ATTRS } from './attr-map';
+import {ATTR_MAP, REMOVE_ATTRS} from './attr-map';
 import TRANSFORMS from './transformers';
 
 const PARSE_OPTS = {
@@ -22,19 +22,23 @@ export const IDX_PREFIX = `${ATTR_PREFIX}index`;
 const isAttr = (k) => k.substring(0, 2) === ATTR_PREFIX;
 const isNode = (k) => !isAttr(k);
 
-export function transformSourceXml (xmlStr, platform, {metadata = {}, addIndexPath = false} = {}) {
+export function transformSourceXml(xmlStr, platform, {metadata = {}, addIndexPath = false} = {}) {
   // first thing we want to do is modify the ios source root node, because it doesn't include the
   // necessary index attribute, so we add it if it's not there
   xmlStr = xmlStr.replace('<AppiumAUT>', '<AppiumAUT index="0">');
   const xmlObj = parser.parse(xmlStr, PARSE_OPTS);
-  const unknowns = transformNode(xmlObj, platform, {metadata, addIndexPath, parentPath: ''});
+  const unknowns = transformNode(xmlObj, platform, {
+    metadata,
+    addIndexPath,
+    parentPath: '',
+  });
   const jParser = new j2xParser(GEN_OPTS);
   let transformedXml = jParser.parse(xmlObj).trim();
   transformedXml = `<?xml version="1.0" encoding="UTF-8"?>\n${transformedXml}`;
   return {xml: transformedXml, unknowns};
 }
 
-function getUniversalName (nameMap, name, platform) {
+function getUniversalName(nameMap, name, platform) {
   for (const translatedName of Object.keys(nameMap)) {
     const sourceNodes = nameMap[translatedName]?.[platform];
     if (_.isArray(sourceNodes) && sourceNodes.includes(name)) {
@@ -47,15 +51,15 @@ function getUniversalName (nameMap, name, platform) {
   return null;
 }
 
-export function getUniversalNodeName (nodeName, platform) {
+export function getUniversalNodeName(nodeName, platform) {
   return getUniversalName(NODE_MAP, nodeName, platform);
 }
 
-export function getUniversalAttrName (attrName, platform) {
+export function getUniversalAttrName(attrName, platform) {
   return getUniversalName(ATTR_MAP, attrName, platform);
 }
 
-export function transformNode (nodeObj, platform, {metadata, addIndexPath, parentPath}) {
+export function transformNode(nodeObj, platform, {metadata, addIndexPath, parentPath}) {
   const unknownNodes = [];
   const unknownAttrs = [];
   if (_.isPlainObject(nodeObj)) {
@@ -76,14 +80,18 @@ export function transformNode (nodeObj, platform, {metadata, addIndexPath, paren
     TRANSFORMS[platform]?.(nodeObj, metadata);
     unknownAttrs.push(...transformAttrs(nodeObj, attrs, platform));
     const unknowns = transformChildNodes(nodeObj, childNodeNames, platform, {
-      metadata, addIndexPath, parentPath: thisIndexPath
+      metadata,
+      addIndexPath,
+      parentPath: thisIndexPath,
     });
     unknownAttrs.push(...unknowns.attrs);
     unknownNodes.push(...unknowns.nodes);
   } else if (_.isArray(nodeObj)) {
     for (const childObj of nodeObj) {
       const {nodes, attrs} = transformNode(childObj, platform, {
-        metadata, addIndexPath, parentPath
+        metadata,
+        addIndexPath,
+        parentPath,
       });
       unknownNodes.push(...nodes);
       unknownAttrs.push(...attrs);
@@ -95,12 +103,21 @@ export function transformNode (nodeObj, platform, {metadata, addIndexPath, paren
   };
 }
 
-export function transformChildNodes (nodeObj, childNodeNames, platform, {metadata, addIndexPath, parentPath}) {
+export function transformChildNodes(
+  nodeObj,
+  childNodeNames,
+  platform,
+  {metadata, addIndexPath, parentPath}
+) {
   const unknownNodes = [];
   const unknownAttrs = [];
   for (const nodeName of childNodeNames) {
     // before modifying the name of this child node, recurse down and modify the subtree
-    const {nodes, attrs} = transformNode(nodeObj[nodeName], platform, {metadata, addIndexPath, parentPath});
+    const {nodes, attrs} = transformNode(nodeObj[nodeName], platform, {
+      metadata,
+      addIndexPath,
+      parentPath,
+    });
     unknownNodes.push(...nodes);
     unknownAttrs.push(...attrs);
 
@@ -127,7 +144,7 @@ export function transformChildNodes (nodeObj, childNodeNames, platform, {metadat
   return {nodes: unknownNodes, attrs: unknownAttrs};
 }
 
-export function transformAttrs (nodeObj, attrs, platform) {
+export function transformAttrs(nodeObj, attrs, platform) {
   const unknownAttrs = [];
   for (const attr of attrs) {
     const cleanAttr = attr.substring(2);

package/lib/transformers.js

@@ -1,10 +1,10 @@
-import { ATTR_PREFIX } from './source';
+import {ATTR_PREFIX} from './source';
 
-function ios (nodeObj/*, metadata*/) {
+function ios(nodeObj /*, metadata*/) {
   return nodeObj;
 }
 
-function android (nodeObj, metadata) {
+function android(nodeObj, metadata) {
   // strip android:id from front of id
   const resId = nodeObj[`${ATTR_PREFIX}resource-id`];
   if (resId && metadata.appPackage) {

package/lib/xpath.js

@@ -1,13 +1,13 @@
-import { select as xpathQuery } from 'xpath';
-import { DOMParser } from 'xmldom';
+import {select as xpathQuery} from 'xpath';
+import {DOMParser} from 'xmldom';
 
-export function runQuery (query, xmlStr) {
+export function runQuery(query, xmlStr) {
   const dom = new DOMParser().parseFromString(xmlStr);
   const nodes = xpathQuery(query, dom);
   return nodes;
 }
 
-export function transformQuery (query, xmlStr, multiple) {
+export function transformQuery(query, xmlStr, multiple) {
   const nodes = runQuery(query, xmlStr);
 
   const newQueries = nodes.map((node) => {
@@ -16,7 +16,8 @@ export function transformQuery (query, xmlStr, multiple) {
     let newQuery = indexPath
       .substring(1) // remove leading / so we can split
       .split('/') // split into idnexes
-      .map((indexStr) => { // map to xpath node indexes (1-based)
+      .map((indexStr) => {
+        // map to xpath node indexes (1-based)
         const xpathIndex = parseInt(indexStr, 10) + 1;
         return `*[${xpathIndex}]`;
       })
@@ -37,7 +38,7 @@ export function transformQuery (query, xmlStr, multiple) {
   return newSelector;
 }
 
-export function getNodeAttrVal (node, attr) {
+export function getNodeAttrVal(node, attr) {
   const attrObjs = Object.values(node.attributes).filter((obj) => obj.name === attr);
   if (!attrObjs.length) {
     throw new Error(`Tried to retrieve a node attribute '${attr}' but the node didn't have it`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/universal-xml-plugin",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0-beta.9",
   "description": "Appium plugin for making XML source and XPath queries the same across iOS and Android",
   "keywords": [
     "appium",
@@ -8,16 +8,17 @@
     "xml",
     "webdriver"
   ],
-  "homepage": "https://github.com/appium/appium-plugins#readme",
+  "homepage": "https://appium.io",
   "bugs": {
-    "url": "https://github.com/appium/appium-plugins/issues"
+    "url": "https://github.com/appium/appium/issues"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/appium/appium-plugins.git"
   },
   "license": "Apache-2.0",
-  "author": "Appium <maintainers@appium.io>",
+  "author": "https://github.com/appium",
+  "types": "./build/lib/plugin.d.ts",
   "files": [
     "index.js",
     "build",
@@ -28,20 +29,25 @@
     "dev": "npm run build -- --watch",
     "fix": "npm run lint -- --fix",
     "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
+    "prepare": "npm run build",
     "test": "npm run test:unit",
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^8.5.3",
-    "@appium/base-plugin": "^1.8.5",
     "fast-xml-parser": "3.21.1",
     "xmldom": "0.6.0",
     "xpath": "0.0.32"
   },
+  "peerDependencies": {
+    "appium": "^2.0.0-beta.35"
+  },
   "appium": {
     "pluginName": "universal-xml",
     "mainClass": "UniversalXMLPlugin"
   },
-  "types": "./build/lib/plugin.d.ts",
-  "gitHead": "5482c921bc187ed8807922c00bd2355585f4971a"
+  "gitHead": "5c7af8ee73078018e4ec52fccf19fe3f77249d72",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6"
+  }
 }