node-simctl 7.2.2 → 7.3.0

package/build/lib/subcommands/launch.js

@@ -1,24 +1,33 @@
 "use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-require("source-map-support/register");
-var _lodash = _interopRequireDefault(require("lodash"));
-var _asyncbox = require("asyncbox");
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = __importDefault(require("lodash"));
+const asyncbox_1 = require("asyncbox");
 const commands = {};
+/**
+ * Execute the particular application package on Simulator.
+ * It is required that Simulator is in _booted_ state and
+ * the application with given bundle identifier is already installed.
+ *
+ * @param {string} bundleId - Bundle identifier of the application,
+ *                            which is going to be removed.
+ * @param {number} tries [5] - The maximum number of retries before
+ *                             throwing an exception.
+ * @return {Promise<string>} the actual command output
+ * @throws {Error} If the corresponding simctl subcommand command
+ *                 returns non-zero return code.
+ * @throws {Error} If the `udid` instance property is unset
+ */
 commands.launchApp = async function launchApp(bundleId, tries = 5) {
-  return await (0, _asyncbox.retryInterval)(tries, 1000, async () => {
-    const {
-      stdout
-    } = await this.exec('launch', {
-      args: [this.requireUdid('launch'), bundleId]
+    // @ts-ignore A string will always be returned
+    return await (0, asyncbox_1.retryInterval)(tries, 1000, async () => {
+        const { stdout } = await this.exec('launch', {
+            args: [this.requireUdid('launch'), bundleId],
+        });
+        return lodash_1.default.trim(stdout);
     });
-    return _lodash.default.trim(stdout);
-  });
 };
-var _default = commands;
-exports.default = _default;
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJfbG9kYXNoIiwiX2ludGVyb3BSZXF1aXJlRGVmYXVsdCIsInJlcXVpcmUiLCJfYXN5bmNib3giLCJjb21tYW5kcyIsImxhdW5jaEFwcCIsImJ1bmRsZUlkIiwidHJpZXMiLCJyZXRyeUludGVydmFsIiwic3Rkb3V0IiwiZXhlYyIsImFyZ3MiLCJyZXF1aXJlVWRpZCIsIl8iLCJ0cmltIiwiX2RlZmF1bHQiLCJleHBvcnRzIiwiZGVmYXVsdCJdLCJzb3VyY2VzIjpbIi4uLy4uLy4uL2xpYi9zdWJjb21tYW5kcy9sYXVuY2guanMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IF8gZnJvbSAnbG9kYXNoJztcbmltcG9ydCB7IHJldHJ5SW50ZXJ2YWwgfSBmcm9tICdhc3luY2JveCc7XG5cbmNvbnN0IGNvbW1hbmRzID0ge307XG5cbi8qKlxuICogRXhlY3V0ZSB0aGUgcGFydGljdWxhciBhcHBsaWNhdGlvbiBwYWNrYWdlIG9uIFNpbXVsYXRvci5cbiAqIEl0IGlzIHJlcXVpcmVkIHRoYXQgU2ltdWxhdG9yIGlzIGluIF9ib290ZWRfIHN0YXRlIGFuZFxuICogdGhlIGFwcGxpY2F0aW9uIHdpdGggZ2l2ZW4gYnVuZGxlIGlkZW50aWZpZXIgaXMgYWxyZWFkeSBpbnN0YWxsZWQuXG4gKlxuICogQHBhcmFtIHtzdHJpbmd9IGJ1bmRsZUlkIC0gQnVuZGxlIGlkZW50aWZpZXIgb2YgdGhlIGFwcGxpY2F0aW9uLFxuICogICAgICAgICAgICAgICAgICAgICAgICAgICAgd2hpY2ggaXMgZ29pbmcgdG8gYmUgcmVtb3ZlZC5cbiAqIEBwYXJhbSB7bnVtYmVyfSB0cmllcyBbNV0gLSBUaGUgbWF4aW11bSBudW1iZXIgb2YgcmV0cmllcyBiZWZvcmVcbiAqICAgICAgICAgICAgICAgICAgICAgICAgICAgICB0aHJvd2luZyBhbiBleGNlcHRpb24uXG4gKiBAcmV0dXJuIHtQcm9taXNlPHN0cmluZz59IHRoZSBhY3R1YWwgY29tbWFuZCBvdXRwdXRcbiAqIEB0aHJvd3Mge0Vycm9yfSBJZiB0aGUgY29ycmVzcG9uZGluZyBzaW1jdGwgc3ViY29tbWFuZCBjb21tYW5kXG4gKiAgICAgICAgICAgICAgICAgcmV0dXJucyBub24temVybyByZXR1cm4gY29kZS5cbiAqIEB0aHJvd3Mge0Vycm9yfSBJZiB0aGUgYHVkaWRgIGluc3RhbmNlIHByb3BlcnR5IGlzIHVuc2V0XG4gKi9cbmNvbW1hbmRzLmxhdW5jaEFwcCA9IGFzeW5jIGZ1bmN0aW9uIGxhdW5jaEFwcCAoYnVuZGxlSWQsIHRyaWVzID0gNSkge1xuICByZXR1cm4gYXdhaXQgcmV0cnlJbnRlcnZhbCh0cmllcywgMTAwMCwgYXN5bmMgKCkgPT4ge1xuICAgIGNvbnN0IHtzdGRvdXR9ID0gYXdhaXQgdGhpcy5leGVjKCdsYXVuY2gnLCB7XG4gICAgICBhcmdzOiBbdGhpcy5yZXF1aXJlVWRpZCgnbGF1bmNoJyksIGJ1bmRsZUlkXSxcbiAgICB9KTtcbiAgICByZXR1cm4gXy50cmltKHN0ZG91dCk7XG4gIH0pO1xufTtcblxuZXhwb3J0IGRlZmF1bHQgY29tbWFuZHM7XG4iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7O0FBQUEsSUFBQUEsT0FBQSxHQUFBQyxzQkFBQSxDQUFBQyxPQUFBO0FBQ0EsSUFBQUMsU0FBQSxHQUFBRCxPQUFBO0FBRUEsTUFBTUUsUUFBUSxHQUFHLENBQUMsQ0FBQztBQWdCbkJBLFFBQVEsQ0FBQ0MsU0FBUyxHQUFHLGVBQWVBLFNBQVNBLENBQUVDLFFBQVEsRUFBRUMsS0FBSyxHQUFHLENBQUMsRUFBRTtFQUNsRSxPQUFPLE1BQU0sSUFBQUMsdUJBQWEsRUFBQ0QsS0FBSyxFQUFFLElBQUksRUFBRSxZQUFZO0lBQ2xELE1BQU07TUFBQ0U7SUFBTSxDQUFDLEdBQUcsTUFBTSxJQUFJLENBQUNDLElBQUksQ0FBQyxRQUFRLEVBQUU7TUFDekNDLElBQUksRUFBRSxDQUFDLElBQUksQ0FBQ0MsV0FBVyxDQUFDLFFBQVEsQ0FBQyxFQUFFTixRQUFRO0lBQzdDLENBQUMsQ0FBQztJQUNGLE9BQU9PLGVBQUMsQ0FBQ0MsSUFBSSxDQUFDTCxNQUFNLENBQUM7RUFDdkIsQ0FBQyxDQUFDO0FBQ0osQ0FBQztBQUFDLElBQUFNLFFBQUEsR0FFYVgsUUFBUTtBQUFBWSxPQUFBLENBQUFDLE9BQUEsR0FBQUYsUUFBQSJ9
+exports.default = commands;
+//# sourceMappingURL=launch.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"launch.js","names":["_lodash","_interopRequireDefault","require","_asyncbox","commands","launchApp","bundleId","tries","retryInterval","stdout","exec","args","requireUdid","_","trim","_default","exports","default"],"sources":["../../../lib/subcommands/launch.js"],"sourcesContent":["import _ from 'lodash';\nimport { retryInterval } from 'asyncbox';\n\nconst commands = {};\n\n/**\n * Execute the particular application package on Simulator.\n * It is required that Simulator is in _booted_ state and\n * the application with given bundle identifier is already installed.\n *\n * @param {string} bundleId - Bundle identifier of the application,\n *                            which is going to be removed.\n * @param {number} tries [5] - The maximum number of retries before\n *                             throwing an exception.\n * @return {Promise<string>} the actual command output\n * @throws {Error} If the corresponding simctl subcommand command\n *                 returns non-zero return code.\n * @throws {Error} If the `udid` instance property is unset\n */\ncommands.launchApp = async function launchApp (bundleId, tries = 5) {\n  return await retryInterval(tries, 1000, async () => {\n    const {stdout} = await this.exec('launch', {\n      args: [this.requireUdid('launch'), bundleId],\n    });\n    return _.trim(stdout);\n  });\n};\n\nexport default commands;\n"],"mappings":";;;;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,SAAA,GAAAD,OAAA;AAEA,MAAME,QAAQ,GAAG,CAAC,CAAC;AAgBnBA,QAAQ,CAACC,SAAS,GAAG,eAAeA,SAASA,CAAEC,QAAQ,EAAEC,KAAK,GAAG,CAAC,EAAE;EAClE,OAAO,MAAM,IAAAC,uBAAa,EAACD,KAAK,EAAE,IAAI,EAAE,YAAY;IAClD,MAAM;MAACE;IAAM,CAAC,GAAG,MAAM,IAAI,CAACC,IAAI,CAAC,QAAQ,EAAE;MACzCC,IAAI,EAAE,CAAC,IAAI,CAACC,WAAW,CAAC,QAAQ,CAAC,EAAEN,QAAQ;IAC7C,CAAC,CAAC;IACF,OAAOO,eAAC,CAACC,IAAI,CAACL,MAAM,CAAC;EACvB,CAAC,CAAC;AACJ,CAAC;AAAC,IAAAM,QAAA,GAEaX,QAAQ;AAAAY,OAAA,CAAAC,OAAA,GAAAF,QAAA"}
+{"version":3,"file":"launch.js","sourceRoot":"","sources":["../../../lib/subcommands/launch.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,uCAAyC;AAEzC,MAAM,QAAQ,GAAG,EAAE,CAAC;AAEpB;;;;;;;;;;;;;GAaG;AACH,QAAQ,CAAC,SAAS,GAAG,KAAK,UAAU,SAAS,CAAE,QAAQ,EAAE,KAAK,GAAG,CAAC;IAChE,8CAA8C;IAC9C,OAAO,MAAM,IAAA,wBAAa,EAAC,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzC,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;SAC7C,CAAC,CAAC;QACH,OAAO,gBAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,kBAAe,QAAQ,CAAC"}

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

@@ -0,0 +1,120 @@
+export default commands;
+export type DeviceInfo = {
+    /**
+     * - The device name.
+     */
+    name: string;
+    /**
+     * - The device UDID.
+     */
+    udid: string;
+    /**
+     * - The current Simulator state, for example 'booted' or 'shutdown'.
+     */
+    state: string;
+    /**
+     * - The SDK version, for example '10.3'.
+     */
+    sdk: string;
+};
+declare namespace commands {
+    /**
+     * @typedef {Object} DeviceInfo
+     * @property {string} name - The device name.
+     * @property {string} udid - The device UDID.
+     * @property {string} state - The current Simulator state, for example 'booted' or 'shutdown'.
+     * @property {string} sdk - The SDK version, for example '10.3'.
+     */
+    /**
+     * Parse the list of existing Simulator devices to represent
+     * it as convenient mapping.
+     *
+     * @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
+     *                  array of the matching {@link DeviceInfo} instances.
+     * @throws {Error} If the corresponding simctl subcommand command
+     *                 returns non-zero return code.
+     */
+    function getDevicesByParsing(platform: string | null): Promise<Record<string, any>>;
+    /**
+     * Parse the list of existing Simulator devices to represent
+     * it as convenient mapping for the particular platform version.
+     *
+     * @param {string?} forSdk - The sdk version,
+     *                           for which the devices list should be parsed,
+     *                           for example '10.3'.
+     * @param {string?} platform - The platform name, for example 'watchOS'.
+     * @return {Promise<Object|DeviceInfo[]>} If _forSdk_ is set then the list
+     *                                    of devices for the particular platform version.
+     *                                    Otherwise the same result as for {@link getDevicesByParsing}
+     *                                    function.
+     * @throws {Error} If the corresponding simctl subcommand command
+     *                 returns non-zero return code or if no matching
+     *                 platform version is found in the system.
+     */
+    function getDevices(forSdk: string | null, platform: string | null): Promise<any>;
+    /**
+     * Get the runtime for the particular platform version using --json flag
+     *
+     * @param {string} platformVersion - The platform version name,
+     *                                   for example '10.3'.
+     * @param {string} platform - The platform name, for example 'watchOS'.
+     * @return {Promise<string>} The corresponding runtime name for the given
+     *                  platform version.
+     */
+    function getRuntimeForPlatformVersionViaJson(platformVersion: string, platform?: string): Promise<string>;
+    /**
+     * Get the runtime for the particular platform version.
+     *
+     * @param {string} platformVersion - The platform version name,
+     *                                   for example '10.3'.
+     * @param {string} platform - The platform name, for example 'watchOS'.
+     * @return {Promise<string>} The corresponding runtime name for the given
+     *                  platform version.
+     */
+    function getRuntimeForPlatformVersion(platformVersion: string, platform?: string): Promise<string>;
+    /**
+     * Get the list of device types available in the current Xcode installation
+     *
+     * @return {Promise<string[]>} List of the types of devices available
+     * @throws {Error} If the corresponding simctl command fails
+     */
+    function getDeviceTypes(): Promise<string[]>;
+    /**
+     * Get the full list of runtimes, devicetypes, devices and pairs as Object
+     *
+     * @return {Promise<Object>} Object containing device types, runtimes devices and pairs.
+     * The resulting JSON will be like:
+     *   {
+     *     "devicetypes" : [
+     *       {
+     *         "name" : "iPhone 4s",
+     *         "identifier" : "com.apple.CoreSimulator.SimDeviceType.iPhone-4s"
+     *       },
+     *       ...
+     *      ],
+     *     "runtimes" : [
+     *       {
+     *         "version" : '13.0',
+     *         "bundlePath" : '/Applications/Xcode11beta4.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime',
+     *         "isAvailable" : true,
+     *         "name" : 'iOS 13.0',
+     *         "identifier" : 'com.apple.CoreSimulator.SimRuntime.iOS-13-0',
+     *         "buildversion" : '17A5534d'
+     *       },
+     *       ...
+     *      },
+     *     "devices" :
+     *       {
+     *         'com.apple.CoreSimulator.SimRuntime.iOS-13-0': [ [Object], [Object] ] },
+     *         ...
+     *       },
+     *     "pairs" : {} }
+     *
+     *   }
+     * @throws {Error} If the corresponding simctl command fails
+     */
+    function list(): Promise<any>;
+}
+//# sourceMappingURL=list.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/list.js"],"names":[],"mappings":";;;;;UASc,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;;;SACN,MAAM;;;IALpB;;;;;;OAMG;IAEH;;;;;;;;;;OAUG;IACH,oFA4DC;IAED;;;;;;;;;;;;;;;OAeG;IACH,kFAmEC;IAED;;;;;;;;OAQG;IACH,0GAYC;IAED;;;;;;;;OAQG;IACH,mGAoBC;IAED;;;;;OAKG;IACH,6CAqBC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,8BASC"}