node-devicectl 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,41 @@
+# node-devicectl
+
+Node.js wrapper around Apple's `devicectl` tool, the command-line utility to control iOS devices. `devicectl` is run as a sub-command of xcrun and requires Xcode 15+ and iOS 17+.
+
+## Installation
+
+Install through npm.
+
+```bash
+npm install node-devicectl
+```
+
+## API
+
+The module exports a single class `Devicectl`. This class contains methods which wrap various devicectl subcommands.
+
+### Advanced Usage
+
+Any devicectl subcommand could be called via `execute` method,
+which accepts the subcommand itself as the first argument and the set of options. For example:
+
+```typescript
+import { Devicectl } from 'node-devicectl';
+
+const devicectl = new Devicectl('device-udid');
+const processes = await devicectl.listProcesses();
+await devicectl.launchApp('com.example.app', {
+  env: { DEBUG: '1' },
+  terminateExisting: true
+});
+```
+
+## Requirements
+
+- Xcode 15+
+- iOS 17+
+- Node.js 20.19.0+ || 22.12.0+ || 24.0.0+
+
+## License
+
+Apache-2.0

package/lib/devicectl.ts

@@ -0,0 +1,102 @@
+import { exec, SubProcess } from 'teen_process';
+import _ from 'lodash';
+import logger from '@appium/logger';
+import type {
+  ExecuteOptions,
+  ExecuteResult,
+} from './types';
+import * as processMixins from './mixins/process';
+import * as infoMixins from './mixins/info';
+import * as copyMixins from './mixins/copy';
+
+const XCRUN = 'xcrun';
+const LOG_TAG = 'Devicectl';
+
+/**
+ * Node.js wrapper around Apple's devicectl tool
+ *
+ * This class provides methods to interact with iOS devices using the devicectl command-line tool.
+ * It requires Xcode 15+ and iOS 17+ to function properly.
+ *
+ */
+export class Devicectl {
+  /** The unique device identifier */
+  public readonly udid: string;
+
+  /**
+   * Creates a new Devicectl instance
+   *
+   * @param udid - The unique device identifier
+   */
+  constructor(udid: string) {
+    this.udid = udid;
+  }
+
+  /**
+   * Executes a devicectl command
+   *
+   * @param subcommand - The devicectl subcommand to execute
+   * @param opts - Execution options
+   * @returns Promise that resolves to the command result
+   */
+  async execute<T extends ExecuteOptions>(
+    subcommand: string[],
+    opts?: T
+  ): Promise<ExecuteResult<T>> {
+    const {
+      logStdout = false,
+      asynchronous = false,
+      asJson = true,
+      subcommandOptions,
+      timeout,
+    } = opts ?? {};
+
+    const finalArgs = [
+      'devicectl', ...subcommand,
+      '--device', this.udid,
+    ];
+
+    if (subcommandOptions && !_.isEmpty(subcommandOptions)) {
+      finalArgs.push(
+        ...(Array.isArray(subcommandOptions) ? subcommandOptions : [subcommandOptions])
+      );
+    }
+
+    if (asJson) {
+      finalArgs.push('--quiet', '--json-output', '-');
+    }
+
+    const cmdStr = [XCRUN, ...finalArgs].map((arg) => `"${arg}"`).join(' ');
+    logger.debug(LOG_TAG, `Executing ${cmdStr}`);
+
+    try {
+      if (asynchronous) {
+        const result = new SubProcess(XCRUN, finalArgs);
+        await result.start(0);
+        return result as ExecuteResult<T>;
+      }
+
+      const result = await exec(
+        XCRUN,
+        finalArgs,
+        ...(_.isNumber(timeout) ? [{ timeout }] : []),
+      );
+
+      if (logStdout) {
+        logger.debug(LOG_TAG, `Command output: ${result.stdout}`);
+      }
+
+      return result as ExecuteResult<T>;
+    } catch (e: any) {
+      throw new Error(`'${cmdStr}' failed. Original error: ${e.stderr || e.stdout || e.message}`);
+    }
+  }
+
+  sendMemoryWarning = processMixins.sendMemoryWarning;
+  sendSignalToProcess = processMixins.sendSignalToProcess;
+  launchApp = processMixins.launchApp;
+  listProcesses = infoMixins.listProcesses;
+  listApps = infoMixins.listApps;
+  listFiles = copyMixins.listFiles;
+  pullFile = copyMixins.pullFile;
+}

package/lib/index.ts

@@ -0,0 +1,2 @@
+export { Devicectl } from './devicectl';
+export type * from './types';

package/lib/mixins/copy.ts

@@ -0,0 +1,60 @@
+import type { ListFilesOptions, PullFileOptions } from '../types';
+import type { Devicectl } from '../devicectl';
+
+/**
+ * Lists files at a specified path on the device
+ */
+export async function listFiles(
+  this: Devicectl,
+  domainType: string,
+  domainIdentifier: string,
+  opts: ListFilesOptions = {}
+): Promise<string[]> {
+  const subcommandOptions = [
+    '--domain-type', domainType,
+    '--domain-identifier', domainIdentifier,
+  ];
+
+  if (opts.username) {
+    subcommandOptions.push('--username', opts.username);
+  }
+
+  if (opts.subdirectory) {
+    subcommandOptions.push('--subdirectory', opts.subdirectory);
+  }
+
+  const { stdout } = await this.execute(['device', 'info', 'files'], {
+    subcommandOptions,
+  });
+
+  return JSON.parse(stdout).result.files.map(({ name }: { name: string }) => name);
+}
+
+/**
+ * Pulls a file from the specified path on the device to a local file system
+ */
+export async function pullFile(
+  this: Devicectl,
+  from: string,
+  to: string,
+  opts: PullFileOptions
+): Promise<string> {
+  const subcommandOptions = [
+    '--domain-type', opts.domainType,
+    '--domain-identifier', opts.domainIdentifier,
+    '--source', from,
+    '--destination', to,
+  ];
+
+  if (opts.username) {
+    subcommandOptions.push('--user', opts.username);
+  }
+
+  await this.execute(['device', 'copy', 'from'], {
+    subcommandOptions,
+    timeout: opts.timeout ?? 120000,
+    asJson: false,
+  });
+
+  return to;
+}

package/lib/mixins/info.ts

@@ -0,0 +1,30 @@
+import type { AppInfo, ProcessInfo } from '../types';
+import type { Devicectl } from '../devicectl';
+
+/**
+ * Retrieves the list of installed apps from the device
+ */
+export async function listApps(
+  this: Devicectl,
+  bundleId?: string
+): Promise<AppInfo[]> {
+  const subcommandOptions = ['--include-all-apps'];
+
+  if (bundleId) {
+    subcommandOptions.push('--bundle-id', bundleId);
+  }
+
+  const { stdout } = await this.execute(['device', 'info', 'apps'], {
+    subcommandOptions,
+  });
+
+  return JSON.parse(stdout).result.apps;
+}
+
+/**
+ * Lists running processes on the device
+ */
+export async function listProcesses(this: Devicectl): Promise<ProcessInfo[]> {
+  const { stdout } = await this.execute(['device', 'info', 'processes']);
+  return JSON.parse(stdout).result.runningProcesses;
+}

package/lib/mixins/process.ts

@@ -0,0 +1,63 @@
+import _ from 'lodash';
+import type { LaunchAppOptions } from '../types';
+import type { Devicectl } from '../devicectl';
+
+/**
+ * Simulates memory warning for the process with the given PID
+ */
+export async function sendMemoryWarning(
+  this: Devicectl,
+  pid: number | string
+): Promise<void> {
+  await this.execute(['device', 'process', 'sendMemoryWarning'], {
+    subcommandOptions: ['--pid', `${pid}`]
+  });
+}
+
+/**
+ * Send POSIX signal to the running process
+ */
+export async function sendSignalToProcess(
+  this: Devicectl,
+  pid: number | string,
+  signal: number | string
+): Promise<void> {
+  await this.execute(['device', 'process', 'signal'], {
+    subcommandOptions: ['--signal', `${signal}`, '--pid', `${pid}`]
+  });
+}
+
+/**
+ * Launch the given bundle id application with the given environment variable.
+ * This method is over devicectl command, this it may take additional seconds to launch the app.
+ * Please use via WDA or via appium-ios-device as primary method to launch app if possible.
+ */
+export async function launchApp(
+  this: Devicectl,
+  bundleId: string,
+  opts: LaunchAppOptions = {}
+): Promise<void> {
+  const {
+    env,
+    terminateExisting = false
+  } = opts;
+
+  const subcommandOptions: string[] = [];
+
+  if (terminateExisting) {
+    subcommandOptions.push('--terminate-existing');
+  }
+
+  if (!_.isEmpty(env)) {
+    subcommandOptions.push('--environment-variables', JSON.stringify(_.mapValues(env, (v) => _.toString(v))));
+  }
+
+  // The bundle id should be the last to apply arguments properly.
+  // devicectl command might not raise exception while the order is wrong.
+  subcommandOptions.push(bundleId);
+
+  await this.execute(['device', 'process', 'launch'], {
+    subcommandOptions,
+    asJson: false
+  });
+}

package/lib/types.ts

@@ -0,0 +1,113 @@
+import { SubProcess, TeenProcessExecResult } from 'teen_process';
+
+/**
+ * Information about a running process on the device
+ */
+export interface ProcessInfo {
+  /** The process identifier */
+  processIdentifier: number;
+  /** The executable path */
+  executable: string;
+}
+
+/**
+ * Information about an installed app on the device
+ */
+export interface AppInfo {
+  /** Whether this is an app clip */
+  appClip: boolean;
+  /** Whether this app was built by a developer */
+  builtByDeveloper: boolean;
+  /** The bundle identifier */
+  bundleIdentifier: string;
+  /** The bundle version */
+  bundleVersion: string;
+  /** Whether this is a default system app */
+  defaultApp: boolean;
+  /** Whether this app is hidden */
+  hidden: boolean;
+  /** Whether this is an internal system app */
+  internalApp: boolean;
+  /** The app name */
+  name: string;
+  /** Whether this app can be removed */
+  removable: boolean;
+  /** The app URL/path */
+  url: string;
+  /** The app version */
+  version: string;
+}
+
+/**
+ * Options for executing devicectl commands
+ */
+export interface ExecuteOptions {
+  /** Whether to log stdout output */
+  logStdout?: boolean;
+  /** Whether to return JSON output */
+  asJson?: boolean;
+  /** Whether to run the command asynchronously */
+  asynchronous?: boolean;
+  /** Additional subcommand options */
+  subcommandOptions?: string[] | string;
+  /** Timeout in milliseconds */
+  timeout?: number;
+}
+
+/**
+ * Options for asynchronous execution
+ */
+export interface AsyncExecuteOptions extends ExecuteOptions {
+  asynchronous: true;
+}
+
+/**
+ * Options for listing files on the device
+ */
+export interface ListFilesOptions {
+  /** The username of the user we should target. Only relevant for certain domains. */
+  username?: string;
+  /** A subdirectory within the domain. If not specified, defaults to the root. */
+  subdirectory?: string;
+}
+
+/**
+ * Options for pulling files from the device
+ */
+export interface PullFileOptions {
+  /** The username of the user we should target. Only relevant for certain domains. */
+  username?: string;
+  /** The file service domain. Valid values are: temporary, rootStaging, appDataContainer, appGroupDataContainer, systemCrashLogs */
+  domainType: string;
+  /** A unique string used to provide additional context to the domain */
+  domainIdentifier: string;
+  /** The timeout for pulling a file in milliseconds */
+  timeout?: number;
+}
+
+/**
+ * Options for launching an app
+ */
+export interface LaunchAppOptions {
+  /** Environment variables for the launching app process */
+  env?: Record<string, string | number>;
+  /** Whether to terminate the already running app */
+  terminateExisting?: boolean;
+}
+
+/**
+ * Result type for synchronous execution
+ */
+export type SyncExecuteResult = TeenProcessExecResult<string>;
+
+/**
+ * Result type for asynchronous execution
+ */
+export type AsyncExecuteResult = SubProcess;
+
+/**
+ * Union type for execute method return
+ */
+export type ExecuteResult<T extends ExecuteOptions> = T extends AsyncExecuteOptions
+  ? AsyncExecuteResult
+  : SyncExecuteResult;

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "node-devicectl",
+  "description": "Node.js wrapper around Apple's devicectl tool",
+  "tags": [
+    "apple",
+    "ios",
+    "devicectl",
+    "device",
+    "xcode"
+  ],
+  "version": "1.0.0",
+  "author": "Appium Contributors",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/appium/node-devicectl.git"
+  },
+  "bugs": {
+    "url": "https://github.com/appium/node-devicectl/issues"
+  },
+  "engines": {
+    "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
+    "npm": ">=10"
+  },
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "bin": {},
+  "directories": {
+    "lib": "./lib"
+  },
+  "files": [
+    "lib",
+    "build",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "@appium/logger": "^2.0.0-rc.1",
+    "lodash": "^4.2.1",
+    "teen_process": "^3.0.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "npm run build -- --clean",
+    "rebuild": "npm run clean; npm run build",
+    "dev": "npm run build -- --watch",
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "prepare": "npm run build",
+    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.*js\"",
+    "e2e-test": "mocha --exit --timeout 5m \"./test/e2e/**/*-specs.js\""
+  },
+  "prettier": {
+    "bracketSpacing": false,
+    "printWidth": 100,
+    "singleQuote": true
+  },
+  "devDependencies": {
+    "@appium/eslint-config-appium-ts": "^2.0.0-rc.1",
+    "@appium/tsconfig": "^1.0.0-rc.1",
+    "@appium/types": "^1.0.0-rc.1",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@types/lodash": "^4.14.196",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^24.0.0",
+    "@types/teen_process": "^2.0.2",
+    "chai": "^6.0.0",
+    "chai-as-promised": "^8.0.0",
+    "conventional-changelog-conventionalcommits": "^9.0.0",
+    "mocha": "^11.0.1",
+    "prettier": "^3.0.0",
+    "semantic-release": "^25.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.4.3"
+  }
+}