appium-remote-debugger 11.4.2 → 11.5.1

package/lib/utils.js

@@ -3,6 +3,8 @@ import _ from 'lodash';
 import B from 'bluebird';
 import { errorFromMJSONWPStatusCode } from '@appium/base-driver';
 import { util, node } from '@appium/support';
+import nodeFs from 'node:fs';
+import path from 'node:path';
 
 const MODULE_NAME = 'appium-remote-debugger';
 
@@ -21,7 +23,7 @@ const ACCEPTED_PAGE_TYPES = [
   'WIRTypePage', // iOS 11.4 webview
 ];
 
-const RESPONSE_LOG_LENGTH = 100;
+export const RESPONSE_LOG_LENGTH = 100;
 
 /**
  * @typedef {Object} DeferredPromise
@@ -49,7 +51,7 @@ const RESPONSE_LOG_LENGTH = 100;
  * @param {Record<string, any>} dict
  * @returns {[string, AppInfo]}
  */
-function appInfoFromDict (dict) {
+export function appInfoFromDict (dict) {
   const id = dict.WIRApplicationIdentifierKey;
   const isProxy = _.isString(dict.WIRIsApplicationProxyKey)
     ? dict.WIRIsApplicationProxyKey.toLowerCase() === 'true'
@@ -85,7 +87,7 @@ function appInfoFromDict (dict) {
  * Take a dictionary from the remote debugger and makes a more manageable
  * dictionary of pages available.
  */
-function pageArrayFromDict (pageDict) {
+export function pageArrayFromDict (pageDict) {
   if (pageDict.id) {
     // the page is already translated, so wrap in an array and pass back
     return [pageDict];
@@ -112,7 +114,7 @@ function pageArrayFromDict (pageDict) {
  * @param {Record<string, any>} appDict
  * @returns {string|undefined}
  */
-function getDebuggerAppKey (bundleId, appDict) {
+export function getDebuggerAppKey (bundleId, appDict) {
   let appId;
   for (const [key, data] of _.toPairs(appDict)) {
     if (data.bundleId === bundleId) {
@@ -141,29 +143,6 @@ function getDebuggerAppKey (bundleId, appDict) {
   return appId;
 }
 
-/**
- *
- * @param {string} bundleId
- * @param {Record<string, any>} appDict
- * @returns {string[]}
- */
-function appIdsForBundle (bundleId, appDict) {
-  /** @type {Set<string>} */
-  const appIds = new Set();
-  for (const [key, data] of _.toPairs(appDict)) {
-    if (data.bundleId.endsWith(bundleId)) {
-      appIds.add(key);
-    }
-  }
-
-  // if nothing is found, try to get the generic app
-  if (appIds.size === 0 && bundleId !== WEB_CONTENT_BUNDLE_ID) {
-    return appIdsForBundle(WEB_CONTENT_BUNDLE_ID, appDict);
-  }
-
-  return Array.from(appIds);
-}
-
 /**
  * Find app keys based on assigned bundleIds from appDict
  * When bundleIds includes a wildcard ('*'), returns all appKeys in appDict.
@@ -171,7 +150,7 @@ function appIdsForBundle (bundleId, appDict) {
  * @param {Record<string, any>} appDict
  * @returns {string[]}
  */
-function getPossibleDebuggerAppKeys(bundleIds, appDict) {
+export function getPossibleDebuggerAppKeys(bundleIds, appDict) {
   if (bundleIds.includes(WILDCARD_BUNDLE_ID)) {
     log.debug('Skip checking bundle identifiers because the bundleIds includes a wildcard');
     return _.uniq(Object.keys(appDict));
@@ -207,7 +186,7 @@ function getPossibleDebuggerAppKeys(bundleIds, appDict) {
   return Array.from(proxiedAppIds);
 }
 
-function checkParams (params) {
+export function checkParams (params) {
   // check if all parameters have a value
   const errors = _.toPairs(params)
     .filter(([, value]) => _.isNil(value))
@@ -217,7 +196,7 @@ function checkParams (params) {
   }
 }
 
-function simpleStringify (value, multiline = false) {
+export function simpleStringify (value, multiline = false) {
   if (!value) {
     return JSON.stringify(value);
   }
@@ -234,7 +213,7 @@ function simpleStringify (value, multiline = false) {
 /**
  * @returns {DeferredPromise}
  */
-function deferredPromise () {
+export function deferredPromise () {
   // http://bluebirdjs.com/docs/api/deferred-migration.html
   /** @type {(...args: any[]) => void}  */
   let resolve;
@@ -253,7 +232,7 @@ function deferredPromise () {
   };
 }
 
-function convertResult (res) {
+export function convertResult (res) {
   if (_.isUndefined(res)) {
     throw new Error(`Did not get OK result from remote debugger. Result was: ${_.truncate(simpleStringify(res), {length: RESPONSE_LOG_LENGTH})}`);
   } else if (_.isString(res)) {
@@ -291,7 +270,7 @@ function convertResult (res) {
  * @returns {string} The full path to module root
  * @throws {Error} If the current module root folder cannot be determined
  */
-const getModuleRoot = _.memoize(function getModuleRoot () {
+export const getModuleRoot = _.memoize(function getModuleRoot () {
   const root = node.getModuleRootSync(MODULE_NAME, __filename);
   if (!root) {
     throw new Error(`Cannot find the root folder of the ${MODULE_NAME} Node.js module`);
@@ -299,8 +278,33 @@ const getModuleRoot = _.memoize(function getModuleRoot () {
   return root;
 });
 
-export {
-  appInfoFromDict, pageArrayFromDict, getDebuggerAppKey,
-  getPossibleDebuggerAppKeys, checkParams, simpleStringify, deferredPromise,
-  convertResult, RESPONSE_LOG_LENGTH, getModuleRoot,
-};
+/**
+ * @returns {import('@appium/types').StringRecord}
+ */
+export function getModuleProperties() {
+  const fullPath = path.resolve(getModuleRoot(), 'package.json');
+  return JSON.parse(nodeFs.readFileSync(fullPath, 'utf8'));
+}
+
+/**
+ *
+ * @param {string} bundleId
+ * @param {Record<string, any>} appDict
+ * @returns {string[]}
+ */
+function appIdsForBundle (bundleId, appDict) {
+  /** @type {Set<string>} */
+  const appIds = new Set();
+  for (const [key, data] of _.toPairs(appDict)) {
+    if (data.bundleId.endsWith(bundleId)) {
+      appIds.add(key);
+    }
+  }
+
+  // if nothing is found, try to get the generic app
+  if (appIds.size === 0 && bundleId !== WEB_CONTENT_BUNDLE_ID) {
+    return appIdsForBundle(WEB_CONTENT_BUNDLE_ID, appDict);
+  }
+
+  return Array.from(appIds);
+}

package/package.json

@@ -4,7 +4,7 @@
   "keywords": [
     "appium"
   ],
-  "version": "11.4.2",
+  "version": "11.5.1",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

package/build/lib/mixins/index.d.ts

@@ -1,5 +0,0 @@
-export default mixins;
-export const mixins: any;
-import events from './events';
-export { events };
-//# sourceMappingURL=index.d.ts.map

package/build/lib/mixins/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/mixins/index.js"],"names":[],"mappings":";AAOA,yBAEE;mBARiB,UAAU"}

package/build/lib/mixins/index.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.events = exports.mixins = void 0;
-const connect_1 = __importDefault(require("./connect"));
-const events_1 = __importDefault(require("./events"));
-exports.events = events_1.default;
-const execute_1 = __importDefault(require("./execute"));
-const navigate_1 = __importDefault(require("./navigate"));
-const message_handlers_1 = __importDefault(require("./message-handlers"));
-const mixins = Object.assign({}, connect_1.default, events_1.default, execute_1.default, navigate_1.default, message_handlers_1.default);
-exports.mixins = mixins;
-exports.default = mixins;
-//# sourceMappingURL=index.js.map

package/build/lib/mixins/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/mixins/index.js"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAChC,sDAA8B;AAWb,iBAXV,gBAAM,CAWU;AAVvB,wDAAgC;AAChC,0DAAkC;AAClC,0EAAiD;AAGjD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAC7B,iBAAO,EAAE,gBAAM,EAAE,iBAAO,EAAE,kBAAQ,EAAE,0BAAe,CACpD,CAAC;AAGO,wBAAM;AACf,kBAAe,MAAM,CAAC"}

package/lib/mixins/index.js

@@ -1,14 +0,0 @@
-import connect from './connect';
-import events from './events';
-import execute from './execute';
-import navigate from './navigate';
-import messageHandlers from './message-handlers';
-
-
-const mixins = Object.assign({},
-  connect, events, execute, navigate, messageHandlers
-);
-
-
-export { mixins, events };
-export default mixins;