node-devicectl 1.0.0 → 1.1.0

package/lib/mixins/process.ts

@@ -1,16 +1,13 @@
 import _ from 'lodash';
-import type { LaunchAppOptions } from '../types';
-import type { Devicectl } from '../devicectl';
+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> {
+export async function sendMemoryWarning(this: Devicectl, pid: number | string): Promise<void> {
   await this.execute(['device', 'process', 'sendMemoryWarning'], {
-    subcommandOptions: ['--pid', `${pid}`]
+    subcommandOptions: ['--pid', `${pid}`],
   });
 }
 
@@ -20,10 +17,10 @@ export async function sendMemoryWarning(
 export async function sendSignalToProcess(
   this: Devicectl,
   pid: number | string,
-  signal: number | string
+  signal: number | string,
 ): Promise<void> {
   await this.execute(['device', 'process', 'signal'], {
-    subcommandOptions: ['--signal', `${signal}`, '--pid', `${pid}`]
+    subcommandOptions: ['--signal', `${signal}`, '--pid', `${pid}`],
   });
 }
 
@@ -35,12 +32,9 @@ export async function sendSignalToProcess(
 export async function launchApp(
   this: Devicectl,
   bundleId: string,
-  opts: LaunchAppOptions = {}
+  opts: LaunchAppOptions = {},
 ): Promise<void> {
-  const {
-    env,
-    terminateExisting = false
-  } = opts;
+  const {env, terminateExisting = false} = opts;
 
   const subcommandOptions: string[] = [];
 
@@ -49,7 +43,10 @@ export async function launchApp(
   }
 
   if (!_.isEmpty(env)) {
-    subcommandOptions.push('--environment-variables', JSON.stringify(_.mapValues(env, (v) => _.toString(v))));
+    subcommandOptions.push(
+      '--environment-variables',
+      JSON.stringify(_.mapValues(env, (v) => _.toString(v))),
+    );
   }
 
   // The bundle id should be the last to apply arguments properly.
@@ -58,6 +55,6 @@ export async function launchApp(
 
   await this.execute(['device', 'process', 'launch'], {
     subcommandOptions,
-    asJson: false
+    asJson: false,
   });
 }

package/lib/types.ts

@@ -1,4 +1,4 @@
-import { SubProcess, TeenProcessExecResult } from 'teen_process';
+import {SubProcess, TeenProcessExecResult} from 'teen_process';
 
 /**
  * Information about a running process on the device
@@ -42,11 +42,25 @@ export interface AppInfo {
  * Options for executing devicectl commands
  */
 export interface ExecuteOptions {
-  /** Whether to log stdout output */
+  /**
+   * Whether to drop the --device option from the actual devicectl command
+   * @default false
+   */
+  noDevice?: boolean;
+  /**
+   * Whether to log stdout output
+   * @default false
+   */
   logStdout?: boolean;
-  /** Whether to return JSON output */
+  /**
+   * Whether to return JSON output
+   * @default true
+   */
   asJson?: boolean;
-  /** Whether to run the command asynchronously */
+  /**
+   * Whether to run the command asynchronously
+   * @default false
+   */
   asynchronous?: boolean;
   /** Additional subcommand options */
   subcommandOptions?: string[] | string;
@@ -111,3 +125,186 @@ export type AsyncExecuteResult = SubProcess;
 export type ExecuteResult<T extends ExecuteOptions> = T extends AsyncExecuteOptions
   ? AsyncExecuteResult
   : SyncExecuteResult;
+
+/**
+ * CPU type information
+ */
+export interface CPUType {
+  /** The CPU type name
+   * @example "arm64e" */
+  name: string;
+  /** The CPU subtype
+   * @example 2 */
+  subType: number;
+  /** The CPU type identifier
+   * @example 16777228 */
+  type: number;
+}
+
+/**
+ * Device capability information
+ */
+export interface Capability {
+  /** The feature identifier
+   * @example "com.apple.coredevice.feature.installapp" */
+  featureIdentifier: string;
+  /** The capability name
+   * @example "Install Application" */
+  name: string;
+}
+
+/**
+ * Connection properties for the device
+ */
+export interface ConnectionProperties {
+  /** The authentication type
+   * @example "manualPairing" */
+  authenticationType: string;
+  /** Whether this is a mobile device only
+   * @example false */
+  isMobileDeviceOnly: boolean;
+  /** The last connection date in ISO format
+   * @example "2025-01-01T12:00:00.000Z" */
+  lastConnectionDate?: string;
+  /** List of local hostnames
+   * @example ["MyDevice.coredevice.local", "ABCD1234-5678-90EF-GHIJ-KLMNOPQRSTUV.coredevice.local"] */
+  localHostnames?: string[];
+  /** The pairing state
+   * @example "paired" */
+  pairingState: string;
+  /** List of potential hostnames
+   * @example ["MyDevice.coredevice.local", "ABCD1234-5678-90EF-GHIJ-KLMNOPQRSTUV.coredevice.local"] */
+  potentialHostnames: string[];
+  /** The transport type
+   * @example "wired" */
+  transportType?: string;
+  /** The tunnel IP address
+   * @example "fdda:f9b3:f5d9::1" */
+  tunnelIPAddress?: string;
+  /** The tunnel state
+   * @example "connected" */
+  tunnelState: string;
+  /** The tunnel transport protocol
+   * @example "tcp" */
+  tunnelTransportProtocol?: string;
+}
+
+/**
+ * Device properties
+ */
+export interface DeviceProperties {
+  /** The boot state
+   * @example "booted" */
+  bootState?: string;
+  /** Whether booted from snapshot
+   * @example true */
+  bootedFromSnapshot?: boolean;
+  /** The booted snapshot name
+   * @example "com.apple.os.update-ABCDEF1234567890" */
+  bootedSnapshotName?: string;
+  /** Whether DDI services are available
+   * @example true */
+  ddiServicesAvailable?: boolean;
+  /** The developer mode status
+   * @example "enabled" */
+  developerModeStatus?: string;
+  /** Whether has internal OS build
+   * @example false */
+  hasInternalOSBuild?: boolean;
+  /** The device name
+   * @example "My iPhone" */
+  name: string;
+  /** The OS build update
+   * @example "22A100" */
+  osBuildUpdate: string;
+  /** The OS version number
+   * @example "18.0.0" */
+  osVersionNumber: string;
+  /** Whether root file system is writable
+   * @example false */
+  rootFileSystemIsWritable?: boolean;
+  /** The screen viewing URL
+   * @example "devices://device/open?id=ABCD1234-5678-90EF-GHIJ-KLMNOPQRSTUV" */
+  screenViewingURL?: string;
+  /** Whether supports checked allocations
+   * @example false */
+  supportsCheckedAllocations?: boolean;
+}
+
+/**
+ * Hardware properties for the device
+ */
+export interface HardwareProperties {
+  /** The CPU type
+   * @example { name: "arm64e", subType: 2, type: 16777228 } */
+  cpuType: CPUType;
+  /** The device type
+   * @example "iPhone" */
+  deviceType: string;
+  /** The ECID
+   * @example 1234567890123456 */
+  ecid: number;
+  /** The hardware model
+   * @example "D63AP" */
+  hardwareModel: string;
+  /** The internal storage capacity in bytes
+   * @example 128000000000 */
+  internalStorageCapacity?: number;
+  /** Whether is production fused
+   * @example true */
+  isProductionFused?: boolean;
+  /** The marketing name
+   * @example "iPhone 15" */
+  marketingName?: string;
+  /** The platform
+   * @example "iOS", "tvOS" */
+  platform: string;
+  /** The product type
+   * @example "iPhone16,1" */
+  productType: string;
+  /** The reality type (physical or simulator)
+   * @example "physical" */
+  reality?: string;
+  /** The serial number
+   * @example "ABC1234XYZ" */
+  serialNumber?: string;
+  /** List of supported CPU types
+   * @example [{ name: "arm64e", subType: 2, type: 16777228 }, { name: "arm64", subType: 0, type: 16777228 }] */
+  supportedCPUTypes?: CPUType[];
+  /** List of supported device families
+   * @example [1, 2], [3] */
+  supportedDeviceFamilies: number[];
+  /** The thinning product type
+   * @example "iPhone16,1" */
+  thinningProductType?: string;
+  /** The UDID
+   * @example "00000000-0000000000000000" */
+  udid: string;
+}
+
+/**
+ * Complete device information
+ */
+export interface DeviceInfo {
+  /** List of device capabilities
+   * @example [{ featureIdentifier: "com.apple.coredevice.feature.installapp", name: "Install Application" }] */
+  capabilities: Capability[];
+  /** Connection properties
+   * @example { authenticationType: "manualPairing", pairingState: "paired", transportType: "wired" } */
+  connectionProperties: ConnectionProperties;
+  /** Device properties
+   * @example { name: "My iPhone", bootState: "booted", osVersionNumber: "18.0.0" } */
+  deviceProperties: DeviceProperties;
+  /** Hardware properties
+   * @example { deviceType: "iPhone", platform: "iOS", udid: "00000000-0000000000000000" } */
+  hardwareProperties: HardwareProperties;
+  /** The device identifier
+   * @example "ABCD1234-5678-90EF-GHIJ-KLMNOPQRSTUV" */
+  identifier: string;
+  /** List of tags
+   * @example [] */
+  tags: string[];
+  /** The visibility class
+   * @example "default" */
+  visibilityClass: string;
+}

package/package.json

@@ -8,7 +8,7 @@
     "device",
     "xcode"
   ],
-  "version": "1.0.0",
+  "version": "1.1.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -22,8 +22,8 @@
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
     "npm": ">=10"
   },
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
+  "main": "./build/lib/index.js",
+  "types": "./build/lib/index.d.ts",
   "bin": {},
   "directories": {
     "lib": "./lib"
@@ -43,6 +43,7 @@
     "clean": "npm run build -- --clean",
     "rebuild": "npm run clean; npm run build",
     "dev": "npm run build -- --watch",
+    "format": "prettier -w ./lib",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "npm run build",