appium-safari-driver 3.5.21 → 3.5.22

package/lib/commands/cookies.js

@@ -1,8 +1,12 @@
-const commands = {};
 
-commands.deleteCookies = async function deleteCookies () {
+/**
+ * @this {SafariDriver}
+ * @returns {Promise<any>}
+ */
+export async function deleteCookies () {
   return await this.safari.proxy.command('/cookie', 'DELETE');
-};
+}
 
-export { commands };
-export default commands;
+/**
+ * @typedef {import('../driver').SafariDriver} SafariDriver
+ */

package/lib/commands/find.js

@@ -1,19 +1,23 @@
 import { util } from 'appium/support';
 
-
-const commands = {};
-
 // This is needed to make lookup by image working
-commands.findElOrEls = async function findElOrEls (strategy, selector, mult, context) {
-  context = util.unwrapElement(context);
-  const endpoint = `/element${context ? `/${context}/element` : ''}${mult ? 's' : ''}`;
-
+/**
+ *
+ * @this {SafariDriver}
+ * @param {string} strategy
+ * @param {string} selector
+ * @param {boolean} mult
+ * @param {string} [context]
+ * @returns {Promise<any>}
+ */
+export async function findElOrEls (strategy, selector, mult, context) {
+  const endpoint = `/element${context ? `/${util.unwrapElement(context)}/element` : ''}${mult ? 's' : ''}`;
   return await this.safari.proxy.command(endpoint, 'POST', {
     using: strategy,
     value: selector,
   });
-};
-
+}
 
-export { commands };
-export default commands;
+/**
+ * @typedef {import('../driver').SafariDriver} SafariDriver
+ */

package/lib/commands/record-screen.js

@@ -3,9 +3,6 @@ import { util, fs, net, tempDir } from 'appium/support';
 import { waitForCondition } from 'asyncbox';
 import { Simctl } from 'node-simctl';
 
-
-const commands = {};
-
 const STARTUP_INTERVAL_MS = 300;
 const STARTUP_TIMEOUT_MS = 10 * 1000;
 const DEFAULT_TIME_LIMIT_MS = 60 * 10 * 1000; // 10 minutes
@@ -235,11 +232,12 @@ async function extractSimulatorUdid (caps) {
  * This method uses `xcrun simctl io recordVideo` helper under the hood.
  * Check the output of `xcrun simctl io` command for more details.
  *
+ * @this {SafariDriver}
  * @param {StartRecordingOptions} options - The available options.
  * @this {import('../driver').SafariDriver}
  * @throws {Error} If screen recording has failed to start or is not supported for the destination device.
  */
-commands.startRecordingScreen = async function startRecordingScreen (options) {
+export async function startRecordingScreen (options) {
   const {
     timeLimit,
     codec,
@@ -280,7 +278,7 @@ commands.startRecordingScreen = async function startRecordingScreen (options) {
     this._screenRecorder = null;
     throw e;
   }
-};
+}
 
 /**
  * @typedef {Object} StopRecordingOptions
@@ -304,6 +302,7 @@ commands.startRecordingScreen = async function startRecordingScreen (options) {
  * Stop recording the screen.
  * If no screen recording has been started before then the method returns an empty string.
  *
+ * @this {SafariDriver}
  * @param {StopRecordingOptions} options - The available options.
  * @returns {Promise<string>} Base64-encoded content of the recorded media file if 'remotePath'
  * parameter is falsy or an empty string.
@@ -312,7 +311,7 @@ commands.startRecordingScreen = async function startRecordingScreen (options) {
  * or the file content cannot be uploaded to the remote location
  * or screen recording is not supported on the device under test.
  */
-commands.stopRecordingScreen = async function stopRecordingScreen (options) {
+export async function stopRecordingScreen (options) {
   if (!this._screenRecorder) {
     this.log.info('No screen recording has been started. Doing nothing');
     return '';
@@ -329,6 +328,8 @@ commands.stopRecordingScreen = async function stopRecordingScreen (options) {
     this.log.debug(`The size of the resulting screen recording is ${util.toReadableSizeString(size)}`);
   }
   return await uploadRecordedMedia(videoPath, options?.remotePath, options);
-};
+}
 
-export default commands;
+/**
+ * @typedef {import('../driver').SafariDriver} SafariDriver
+ */

package/lib/driver.js

@@ -1,8 +1,9 @@
-import _ from 'lodash';
 import { BaseDriver } from 'appium/driver';
-import SafariDriverServer from './safari';
+import { SafariDriverServer } from './safari';
 import { desiredCapConstraints } from './desired-caps';
-import { commands } from './commands/index';
+import * as cookieCommands from './commands/cookies';
+import * as findCommands from './commands/find';
+import * as recordScreenCommands from './commands/record-screen';
 import { formatCapsForServer } from './utils';
 import { newMethodMap } from './method-map';
 
@@ -20,6 +21,9 @@ export class SafariDriver extends BaseDriver {
   /** @type {boolean} */
   isProxyActive;
 
+  /** @type {SafariDriverServer} */
+  safari;
+
   static newMethodMap = newMethodMap;
 
   constructor (opts = {}) {
@@ -37,13 +41,10 @@ export class SafariDriver extends BaseDriver {
       'name',
     ];
     this.resetState();
-
-    for (const [cmd, fn] of _.toPairs(commands)) {
-      SafariDriver.prototype[cmd] = fn;
-    }
   }
 
   resetState () {
+    // @ts-ignore That's ok
     this.safari = null;
     this.proxyReqRes = null;
     this.isProxyActive = false;
@@ -86,6 +87,13 @@ export class SafariDriver extends BaseDriver {
 
     await super.deleteSession();
   }
+
+  deleteCookies = cookieCommands.deleteCookies;
+
+  findElOrEls = findCommands.findElOrEls;
+
+  startRecordingScreen = recordScreenCommands.startRecordingScreen;
+  stopRecordingScreen = recordScreenCommands.stopRecordingScreen;
 }
 
 export default SafariDriver;

package/lib/safari.js

@@ -98,9 +98,16 @@ process.once('exit', () => {
   }
 });
 
-class SafariDriverServer {
+export class SafariDriverServer {
+  /** @type {SafariProxy} */
+  proxy;
+
+  /**
+   * @param {import('@appium/types').AppiumLogger} log
+   */
   constructor (log) {
     this.log = log;
+    // @ts-ignore That's ok
     this.proxy = null;
   }
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-safari-driver",
-  "version": "3.5.21",
+  "version": "3.5.22",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-safari-driver",
-      "version": "3.5.21",
+      "version": "3.5.22",
       "license": "Apache-2.0",
       "dependencies": {
         "asyncbox": "^3.0.0",
@@ -263,9 +263,9 @@
       "license": "MIT"
     },
     "node_modules/@types/node": {
-      "version": "22.12.0",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.12.0.tgz",
-      "integrity": "sha512-Fll2FZ1riMjNmlmJOdAyY5pUbkftXslB5DgEzlIuNaiWhXd00FhWxVC/r4yV/4wBb9JfImTu+jiSvXTkJ7F/gA==",
+      "version": "22.13.0",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.13.0.tgz",
+      "integrity": "sha512-ClIbNe36lawluuvq3+YYhnIN2CELi+6q8NpnM7PYp4hBn/TatfboPgVSm2rwKRfnV2M+Ty9GWDFI64KEe+kysA==",
       "license": "MIT",
       "dependencies": {
         "undici-types": "~6.20.0"
@@ -1560,13 +1560,6 @@
       "extraneous": true,
       "license": "MIT"
     },
-    "node_modules/queue-tick": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/queue-tick/-/queue-tick-1.0.1.tgz",
-      "integrity": "sha512-kJt5qhMxoszgU/62PLP1CJytzd2NKetjSRnyuj31fDd3Rlcz3fzlFdFLD1SItunPwyqEOkca6GbV612BWfaBag==",
-      "extraneous": true,
-      "license": "MIT"
-    },
     "node_modules/readable-stream": {
       "version": "4.7.0",
       "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz",
@@ -1840,14 +1833,13 @@
       "license": "CC0-1.0"
     },
     "node_modules/streamx": {
-      "version": "2.21.1",
-      "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.21.1.tgz",
-      "integrity": "sha512-PhP9wUnFLa+91CPy3N6tiQsK+gnYyUNuk15S3YG/zjYE7RuPeCjJngqnzpC31ow0lzBHQ+QGO4cNJnd0djYUsw==",
+      "version": "2.22.0",
+      "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.22.0.tgz",
+      "integrity": "sha512-sLh1evHOzBy/iWRiR6d1zRcLao4gGZr3C1kzNz4fopCOKJb6xD9ub8Mpi9Mr1R6id5o43S+d93fI48UC5uM9aw==",
       "extraneous": true,
       "license": "MIT",
       "dependencies": {
         "fast-fifo": "^1.3.2",
-        "queue-tick": "^1.0.1",
         "text-decoder": "^1.1.0"
       },
       "optionalDependencies": {

package/package.json

@@ -5,7 +5,7 @@
     "appium",
     "safari"
   ],
-  "version": "3.5.21",
+  "version": "3.5.22",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

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

@@ -1,3 +0,0 @@
-export default commands;
-export const commands: {};
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/commands/index.js"],"names":[],"mappings":";AAIA,0BAAoB"}

package/build/lib/commands/index.js

@@ -1,14 +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.commands = void 0;
-const find_1 = __importDefault(require("./find"));
-const cookies_1 = __importDefault(require("./cookies"));
-const record_screen_1 = __importDefault(require("./record-screen"));
-const commands = {};
-exports.commands = commands;
-Object.assign(commands, find_1.default, cookies_1.default, record_screen_1.default);
-exports.default = commands;
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/commands/index.js"],"names":[],"mappings":";;;;;;AAAA,kDAA8B;AAC9B,wDAAmC;AACnC,oEAAmD;AAEnD,MAAM,QAAQ,GAAG,EAAE,CAAC;AASX,4BAAQ;AARjB,MAAM,CAAC,MAAM,CACX,QAAQ,EACR,cAAQ,EACR,iBAAU,EACV,uBAAoB,CAErB,CAAC;AAGF,kBAAe,QAAQ,CAAC"}

package/lib/commands/index.js

@@ -1,15 +0,0 @@
-import findCmds from './find';
-import cookieCmds from './cookies';
-import recordScreenCommands from './record-screen';
-
-const commands = {};
-Object.assign(
-  commands,
-  findCmds,
-  cookieCmds,
-  recordScreenCommands,
-  // add other command types here
-);
-
-export { commands };
-export default commands;