node-simctl 7.3.5 → 7.3.7

package/lib/subcommands/keychain.js

@@ -7,6 +7,11 @@ import { rimraf } from 'rimraf';
 
 const commands = {};
 
+/**
+ *
+ * @param {string|Buffer} payload
+ * @param {(filePath: string) => Promise<any>} onPayloadStored
+ */
 async function handleRawPayload (payload, onPayloadStored) {
   const filePath = path.resolve(os.tmpdir(), `${uuidV4()}.pem`);
   try {
@@ -33,6 +38,7 @@ async function handleRawPayload (payload, onPayloadStored) {
  * Adds the given certificate to the Trusted Root Store on the simulator
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
@@ -45,7 +51,7 @@ commands.addRootCertificate = async function addRootCertificate (cert, opts = {}
   const {
     raw = false,
   } = opts;
-  const execMethod = async (certPath) => await this.exec('keychain', {
+  const execMethod = async (/** @type {string} */certPath) => await this.exec('keychain', {
     args: [this.requireUdid('keychain add-root-cert'), 'add-root-cert', certPath],
   });
   if (raw) {
@@ -59,6 +65,7 @@ commands.addRootCertificate = async function addRootCertificate (cert, opts = {}
  * Adds the given certificate to the Keychain Store on the simulator
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
@@ -85,6 +92,7 @@ commands.addCertificate = async function addCertificate (cert, opts = {}) {
  * Resets the simulator keychain
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while resetting the keychain
  * @throws {Error} If the `udid` instance property is unset

package/lib/subcommands/launch.js

@@ -8,6 +8,7 @@ const commands = {};
  * It is required that Simulator is in _booted_ state and
  * the application with given bundle identifier is already installed.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string} bundleId - Bundle identifier of the application,
  *                            which is going to be removed.
  * @param {number} [tries=5] - The maximum number of retries before

package/lib/subcommands/list.js

@@ -17,6 +17,7 @@ const commands = {};
  * Parse the list of existing Simulator devices to represent
  * it as convenient mapping.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string?} [platform] - The platform name, for example 'watchOS'.
  * @return {Promise<Record<string, any>>} The resulting mapping. Each key is platform version,
  *                  for example '10.3' and the corresponding value is an
@@ -25,7 +26,6 @@ const commands = {};
  *                 returns non-zero return code.
  */
 commands.getDevicesByParsing = async function getDevicesByParsing (platform) {
-  // get the list of devices
   const {stdout} = await this.exec('list', {
     args: ['devices'],
   });
@@ -90,6 +90,7 @@ commands.getDevicesByParsing = async function getDevicesByParsing (platform) {
  * Parse the list of existing Simulator devices to represent
  * it as convenient mapping for the particular platform version.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string?} [forSdk] - The sdk version,
  *                           for which the devices list should be parsed,
  *                           for example '10.3'.
@@ -174,6 +175,7 @@ commands.getDevices = async function getDevices (forSdk, platform) {
 /**
  * Get the runtime for the particular platform version using --json flag
  *
+ * @this {import('../simctl').Simctl}
  * @param {string} platformVersion - The platform version name,
  *                                   for example '10.3'.
  * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
@@ -197,6 +199,7 @@ commands.getRuntimeForPlatformVersionViaJson = async function getRuntimeForPlatf
 /**
  * Get the runtime for the particular platform version.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string} platformVersion - The platform version name,
  *                                   for example '10.3'.
  * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
@@ -228,6 +231,7 @@ commands.getRuntimeForPlatformVersion = async function getRuntimeForPlatformVers
 /**
  * Get the list of device types available in the current Xcode installation
  *
+ * @this {import('../simctl').Simctl}
  * @return {Promise<string[]>} List of the types of devices available
  * @throws {Error} If the corresponding simctl command fails
  */
@@ -257,6 +261,7 @@ commands.getDeviceTypes = async function getDeviceTypes () {
 /**
  * Get the full list of runtimes, devicetypes, devices and pairs as Object
  *
+ * @this {import('../simctl').Simctl}
  * @return {Promise<Object>} Object containing device types, runtimes devices and pairs.
  * The resulting JSON will be like:
  *   {

package/lib/subcommands/location.js

@@ -19,6 +19,7 @@ function formatArg (name, value) {
  * Set the Simulator location to a specific latitude and longitude.
  * This functionality is only available since Xcode 14.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string|number} latitude Location latitude value
  * @param {string|number} longitude Location longitude value
  * @throws {Error} If the corresponding simctl subcommand command
@@ -35,7 +36,9 @@ commands.setLocation = async function setLocation (latitude, longitude) {
 
 /**
  * Stop any running scenario and clear any simulated location.
- * This functionality is only available since Xcode 14.
+ *
+ * @since Xcode 14.
+ * @this {import('../simctl').Simctl}
  */
 commands.clearLocation = async function clearLocation () {
   await this.exec('location', {

package/lib/subcommands/openurl.js

@@ -5,6 +5,7 @@ const commands = {};
  * to find a matching application, which supports the given scheme.
  * It is required that Simulator is in _booted_ state.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string} url - The URL scheme to open, for example http://appiom.io
  *                       will be opened by the built-in mobile browser.
  * @return {Promise<import('teen_process').TeenProcessExecResult>} Command execution result.

package/lib/subcommands/pbcopy.js

@@ -5,9 +5,10 @@ const commands = {};
  * It is required that Simulator is in _booted_ state.
  *
  * @since Xcode SDK 8.1
+ * @this {import('../simctl').Simctl}
  * @param {string} content - The actual string content to be set.
- * @param {string} [encoding='utf8'] - The encoding of the given pasteboard content.
- *                                   UTF-8 by default.
+ * @param {BufferEncoding} [encoding='utf8'] - The encoding of the given pasteboard content.
+ * utf8 by default.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.
  * @throws {Error} If the `udid` instance property is unset
@@ -19,10 +20,12 @@ commands.setPasteboard = async function setPasteboard (content, encoding = 'utf8
   });
   await pbCopySubprocess.start(0);
   const exitCodeVerifier = pbCopySubprocess.join();
-  const stdin = pbCopySubprocess.proc.stdin;
-  stdin.setEncoding(encoding);
-  stdin.write(content);
-  stdin.end();
+  const stdin = pbCopySubprocess.proc?.stdin;
+  if (stdin) {
+    stdin.setDefaultEncoding(encoding);
+    stdin.write(content);
+    stdin.end();
+  }
   await exitCodeVerifier;
 };
 

package/lib/subcommands/pbpaste.js

@@ -5,6 +5,7 @@ const commands = {};
  * It is required that Simulator is in _booted_ state.
  *
  * @since Xcode 8.1 SDK
+ * @this {import('../simctl').Simctl}
  * @param {string} [encoding='utf8'] - The encoding of the returned pasteboard content.
  *                                      UTF-8 by default.
  * @return {Promise<string>} Current content of Simulator pasteboard or an empty string.

package/lib/subcommands/privacy.js

@@ -4,6 +4,7 @@ const commands = {};
  * Grants the given permission on the app with the given bundle identifier
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @param {string} bundleId the identifier of the application whose
  * privacy settings are going to be changed
  * @param {string} perm one of possible permission values:
@@ -35,6 +36,7 @@ commands.grantPermission = async function grantPermission (bundleId, perm) {
  * after it has been granted
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @param {string} bundleId the identifier of the application whose
  * privacy settings are going to be changed
  * @param {string} perm one of possible permission values (see `grantPermission`)
@@ -53,6 +55,7 @@ commands.revokePermission = async function revokePermission (bundleId, perm) {
  * to its default state
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @param {string} bundleId the identifier of the application whose
  * privacy settings are going to be changed
  * @param {string} perm one of possible permission values (see `grantPermission`)

package/lib/subcommands/push.js

@@ -10,6 +10,7 @@ const commands = {};
  * Send a simulated push notification
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @param {Object} payload - The object that describes Apple push notification content.
  * It must contain a top-level "Simulator Target Bundle" key with a string value matching
  * the target application‘s bundle identifier and "aps" key with valid Apple Push Notification values.

package/lib/subcommands/shutdown.js

@@ -6,6 +6,7 @@ const commands = {};
 /**
  * Shutdown the given Simulator if it is running.
  *
+ * @this {import('../simctl').Simctl}
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.
  * @throws {Error} If the `udid` instance property is unset

package/lib/subcommands/spawn.js

@@ -7,6 +7,7 @@ const commands = {};
  * Spawn the particular process on Simulator.
  * It is required that Simulator is in _booted_ state.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string|string[]} args - Spawn arguments
  * @param {object} [env={}] - Additional environment variables mapping.
  * @return {Promise<import('teen_process').TeenProcessExecResult>} Command execution result.
@@ -29,6 +30,7 @@ commands.spawnProcess = async function spawnProcess (args, env = {}) {
  * Prepare SubProcess instance for a new process, which is going to be spawned
  * on Simulator.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string|string[]} args - Spawn arguments
  * @param {object} [env={}] - Additional environment variables mapping.
  * @return {Promise<import('teen_process').SubProcess>} The instance of the process to be spawned.

package/lib/subcommands/terminate.js

@@ -4,6 +4,7 @@ const commands = {};
  * Terminate the given running application on Simulator.
  * It is required that Simulator is in _booted_ state.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string} bundleId - Bundle identifier of the application,
  *                            which is going to be terminated.
  * @throws {Error} If the corresponding simctl subcommand command

package/lib/subcommands/ui.js

@@ -7,6 +7,7 @@ const commands = {};
  * Retrieves the current UI appearance value from the given simulator
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @return {Promise<string>} the appearance value, for example 'light' or 'dark'
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while getting the value
@@ -23,6 +24,7 @@ commands.getAppearance = async function getAppearance () {
  * Sets the UI appearance to the given style
  *
  * @since Xcode 11.4 SDK
+ * @this {import('../simctl').Simctl}
  * @param {string} appearance valid appearance value, for example 'light' or 'dark'
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while getting the value

package/lib/subcommands/uninstall.js

@@ -5,6 +5,7 @@ const commands = {};
  * It is required that Simulator is in _booted_ state and
  * the application with given bundle identifier is already installed.
  *
+ * @this {import('../simctl').Simctl}
  * @param {string} bundleId - Bundle identifier of the application,
  *                            which is going to be removed.
  * @throws {Error} If the corresponding simctl subcommand command

package/package.json

@@ -6,7 +6,7 @@
     "ios",
     "simctl"
   ],
-  "version": "7.3.5",
+  "version": "7.3.7",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

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

@@ -1,3 +0,0 @@
-export default subcommands;
-declare const subcommands: any;
-//# sourceMappingURL=index.d.ts.map

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

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

package/build/lib/subcommands/index.js

@@ -1,34 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const addmedia_1 = __importDefault(require("./addmedia"));
-const appinfo_1 = __importDefault(require("./appinfo"));
-const boot_1 = __importDefault(require("./boot"));
-const bootstatus_1 = __importDefault(require("./bootstatus"));
-const create_1 = __importDefault(require("./create"));
-const delete_1 = __importDefault(require("./delete"));
-const erase_1 = __importDefault(require("./erase"));
-const get_app_container_1 = __importDefault(require("./get_app_container"));
-const install_1 = __importDefault(require("./install"));
-const io_1 = __importDefault(require("./io"));
-const keychain_1 = __importDefault(require("./keychain"));
-const launch_1 = __importDefault(require("./launch"));
-const list_1 = __importDefault(require("./list"));
-const openurl_1 = __importDefault(require("./openurl"));
-const pbcopy_1 = __importDefault(require("./pbcopy"));
-const pbpaste_1 = __importDefault(require("./pbpaste"));
-const privacy_1 = __importDefault(require("./privacy"));
-const push_1 = __importDefault(require("./push"));
-const getenv_1 = __importDefault(require("./getenv"));
-const shutdown_1 = __importDefault(require("./shutdown"));
-const spawn_1 = __importDefault(require("./spawn"));
-const terminate_1 = __importDefault(require("./terminate"));
-const ui_1 = __importDefault(require("./ui"));
-const uninstall_1 = __importDefault(require("./uninstall"));
-const location_1 = __importDefault(require("./location"));
-// xcrun simctl --help
-const subcommands = Object.assign({}, addmedia_1.default, appinfo_1.default, boot_1.default, bootstatus_1.default, create_1.default, delete_1.default, erase_1.default, get_app_container_1.default, install_1.default, io_1.default, keychain_1.default, launch_1.default, list_1.default, openurl_1.default, pbcopy_1.default, pbpaste_1.default, privacy_1.default, push_1.default, getenv_1.default, shutdown_1.default, spawn_1.default, terminate_1.default, ui_1.default, uninstall_1.default, location_1.default);
-exports.default = subcommands;
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/subcommands/index.js"],"names":[],"mappings":";;;;;AAAA,0DAA0C;AAC1C,wDAAwC;AACxC,kDAAkC;AAClC,8DAA8C;AAC9C,sDAAsC;AACtC,sDAAsC;AACtC,oDAAoC;AACpC,4EAA0D;AAC1D,wDAAwC;AACxC,8CAA8B;AAC9B,0DAA0C;AAC1C,sDAAsC;AACtC,kDAAkC;AAClC,wDAAwC;AACxC,sDAAsC;AACtC,wDAAwC;AACxC,wDAAwC;AACxC,kDAAkC;AAClC,sDAAmC;AACnC,0DAA0C;AAC1C,oDAAoC;AACpC,4DAA4C;AAC5C,8CAA8B;AAC9B,4DAA4C;AAC5C,0DAA0C;AAE1C,sBAAsB;AACtB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAChC,kBAAgB,EAChB,iBAAe,EACf,cAAY,EACZ,oBAAkB,EAClB,gBAAc,EACd,gBAAc,EACd,eAAa,EACb,2BAAuB,EACvB,iBAAe,EACf,YAAU,EACV,kBAAgB,EAChB,gBAAc,EACd,cAAY,EACZ,iBAAe,EACf,gBAAc,EACd,iBAAe,EACf,iBAAe,EACf,cAAY,EACZ,gBAAW,EACX,kBAAgB,EAChB,eAAa,EACb,mBAAiB,EACjB,YAAU,EACV,mBAAiB,EACjB,kBAAgB,CACnB,CAAC;AAEF,kBAAe,WAAW,CAAC"}

package/lib/subcommands/index.js

@@ -1,56 +0,0 @@
-import addmediaCommands from './addmedia';
-import appinfoCommands from './appinfo';
-import bootCommands from './boot';
-import bootstatusCommands from './bootstatus';
-import createCommands from './create';
-import deleteCommands from './delete';
-import eraseCommands from './erase';
-import getappcontainerCommands from './get_app_container';
-import installCommands from './install';
-import ioCommands from './io';
-import keychainCommands from './keychain';
-import launchCommands from './launch';
-import listCommands from './list';
-import openurlCommands from './openurl';
-import pbcopyCommands from './pbcopy';
-import pbpasteCommands from './pbpaste';
-import privacyCommands from './privacy';
-import pushCommands from './push';
-import envCommands from './getenv';
-import shutdownCommands from './shutdown';
-import spawnCommands from './spawn';
-import terminateCommands from './terminate';
-import uiCommands from './ui';
-import uninstallCommands from './uninstall';
-import locationCommands from './location';
-
-// xcrun simctl --help
-const subcommands = Object.assign({},
-    addmediaCommands,
-    appinfoCommands,
-    bootCommands,
-    bootstatusCommands,
-    createCommands,
-    deleteCommands,
-    eraseCommands,
-    getappcontainerCommands,
-    installCommands,
-    ioCommands,
-    keychainCommands,
-    launchCommands,
-    listCommands,
-    openurlCommands,
-    pbcopyCommands,
-    pbpasteCommands,
-    privacyCommands,
-    pushCommands,
-    envCommands,
-    shutdownCommands,
-    spawnCommands,
-    terminateCommands,
-    uiCommands,
-    uninstallCommands,
-    locationCommands,
-);
-
-export default subcommands;