@mcesystems/apple-kit 1.0.87 → 1.0.91

package/dist/types/index.d.ts

@@ -3,6 +3,84 @@
 import { ChildProcess } from 'node:child_process';
 import { EventEmitter } from 'node:events';
 
+export interface MdmClientOptions {
+	endpoint?: string;
+	authApiUrl?: string;
+	credentialsPath?: string;
+	timeoutMs?: number;
+}
+export interface InstallAppMdmOptions {
+	appId?: string;
+	url?: string;
+	waitForInstalled?: boolean;
+	clientConfig?: MdmClientOptions$1;
+}
+export interface MdmClientOptions$1 {
+	endpoint?: string;
+	authApiUrl?: string;
+	credentialsPath?: string;
+	timeoutMs?: number;
+}
+/**
+ * WiFi Profile Types
+ */
+export type WifiEncryptionType = "WEP" | "WPA" | "WPA2" | "WPA3" | "Any" | "None";
+export type WifiEapType = "TLS" | "TTLS" | "LEAP" | "PEAP" | "EAP-FAST" | "EAP-SIM" | "EAP-AKA";
+export interface WifiProfileConfig {
+	ssid: string;
+	password?: string;
+	encryptionType?: WifiEncryptionType;
+	autoJoin?: boolean;
+	hiddenNetwork?: boolean;
+	organizationName?: string;
+	displayName?: string;
+	enterprise?: boolean;
+	username?: string;
+	eapType?: WifiEapType;
+	acceptAnyCertificate?: boolean;
+}
+export interface ActivationFlowConfig {
+	/**
+	 * Whether to install MDM profile.
+	 * If not set, defaults to true.
+	 */
+	withMdm?: boolean;
+	/**
+	 * Path to the ios CLI binary (go-ios wrapper).
+	 * If not set, defaults to resourcesDir/ios/bin/{platform}/ios(.exe).
+	 */
+	iosBinaryPath?: string;
+	/**
+	 * Path to the certificate file (optional).
+	 * If not set, defaults to CERT_FILE from env.
+	 */
+	certFile?: string;
+	/**
+	 * MDM client options.
+	 * If not set, defaults to MDM_CLIENT_OPTIONS from env.
+	 */
+	mdmClientOptions?: MdmClientOptions;
+	/**
+	 * Organization name used for trust profile display (optional).
+	 * If not set, uses ORGANIZATION_NAME from env.
+	 */
+	organizationName?: string;
+	/**
+	 * Folder to read/write trust_profile.mobileconfig (optional).
+	 * If not set, defaults to the package resources folder.
+	 */
+	resourcesDir?: string;
+	/**
+	 * WiFi profile configuration.
+	 * If not set, defaults to WIFI_PROFILE_CONFIG from env.
+	 */
+	wifiProfileConfig?: WifiProfileConfig;
+	/**
+	 * Folder to read/write plist files (optional).
+	 * If not set, defaults to the package resources folder.
+	 */
+	plistDir?: string;
+}
 export interface DeviceListOutput {
 	deviceList: string[];
 }
@@ -182,11 +260,6 @@ export interface PortForwardResult {
 	/** The device port being forwarded to */
 	devicePort: number;
 }
-export interface InstallAppMdmOptions {
-	appId?: string;
-	url?: string;
-	waitForInstalled?: boolean;
-}
 /**
  * AppleDeviceKit - iOS device operations wrapper
  *
@@ -300,6 +373,14 @@ export declare class AppleDeviceKit {
 	 */
 	wipe(): Promise<void>;
 	removeProfile(profileIdentifier: string): Promise<void>;
+	/**
+	 * Check if the device is connected to WiFi.
+	 * Returns the connected SSID when connected, undefined when not.
+	 * Uses ios syslog capture and parses for the CurrentBSS pattern.
+	 *
+	 * @param timeoutMs Duration to capture syslog before parsing (default 5000)
+	 */
+	isWifiConnected(timeoutMs?: number): Promise<string | undefined>;
 	listProfiles(): Promise<IosProfileListResult>;
 	/**
 	 * Activate the device using the activation flow.
@@ -312,7 +393,7 @@ export declare class AppleDeviceKit {
 	 *
 	 * Precondition: the device must be paired and trusted.
 	 */
-	activate(signal?: AbortSignal): {
+	activate(signal?: AbortSignal, config?: ActivationFlowConfig): {
 		promise: Promise<(() => Promise<void>) | undefined>;
 		events: EventEmitter;
 	};
@@ -353,7 +434,7 @@ export declare class IosClient {
 	private iosPath;
 	private udid;
 	private readonly _usbmuxdAddress?;
-	constructor(iosPath: string, udid: string, _usbmuxdAddress?: string | undefined);
+	constructor(iosPath: string, udid: string, _usbmuxdAddress?: string);
 	get usbmuxdAddress(): string | undefined;
 	private safeParseJson;
 	private parseFsyncTreeStdout;
@@ -365,7 +446,7 @@ export declare class IosClient {
 	installProfile(profilePath: string): Promise<IosCommandResult>;
 	removeProfile(profileName: string): Promise<IosCommandResult>;
 	listProfiles(): Promise<IosProfileListResult>;
-	skipSteps(steps?: string[]): Promise<IosCommandResult>;
+	skipSteps(steps?: string[], certFile?: string, organizationName?: string): Promise<IosCommandResult>;
 	listSteps(): Promise<IosCommandResult>;
 	activate(): Promise<IosCommandResult>;
 	pair(): Promise<IosCommandResult>;
@@ -393,27 +474,70 @@ export declare class IosClient {
 		srcPath: string;
 		dstPath: string;
 	}): Promise<IosCommandResult>;
+	/**
+	 * Capture syslog output for a duration. The syslog command streams and does not exit;
+	 * we run it for timeoutMs then kill the process.
+	 * If stopWhen returns true, we stop early and return immediately.
+	 */
+	captureSyslog(timeoutMs?: number, stopWhen?: (output: {
+		stdout: string;
+		stderr: string;
+	}) => boolean): Promise<{
+		stdout: string;
+		stderr: string;
+	}>;
 	fsyncTree({ app, path, }: {
 		app: string;
 		path?: string;
 	}): Promise<IosFsyncTreeResult>;
 }
+declare class DeviceActions {
+	private readonly udid;
+	private readonly iosClient;
+	constructor(udid: string, iosClient: IosClient);
+	info(): Promise<LockdownInfo>;
+	listDevices(): Promise<IosListResult>;
+	wipe(): Promise<void>;
+	removeProfile(profileIdentifier: string): Promise<void>;
+	listProfiles(): Promise<IosProfileListResult>;
+	pair(): Promise<boolean>;
+	trustDevice({ timeout, pollInterval, onWaitingForTrust, signal, }: {
+		timeout?: number;
+		pollInterval?: number;
+		onWaitingForTrust?: () => void;
+		signal?: AbortSignal;
+	}): Promise<boolean>;
+	waitForPairing({ timeout, pollInterval, signal, }: {
+		timeout?: number;
+		pollInterval?: number;
+		signal?: AbortSignal;
+	}): Promise<boolean>;
+	/**
+	 * Returns true if device is paired and trusted.
+	 * Uses info() which only succeeds when full pairing is established (user has accepted Trust).
+	 * Prefer this over lockdown file check since file location/timing can vary by platform.
+	 */
+	private isPairedViaInfo;
+	isWifiConnected(timeoutMs?: number): Promise<string | undefined>;
+	unpair(): Promise<boolean>;
+}
 export declare class ActivationFlow {
 	private readonly udid;
 	private readonly iosClient;
+	private readonly deviceActions;
 	private mdmClient;
-	constructor(udid: string, iosClient: IosClient);
-	run(steps?: string[], signal?: AbortSignal): {
+	constructor(udid: string, iosClient: IosClient, deviceActions: DeviceActions);
+	run(steps?: string[], signal?: AbortSignal, config?: ActivationFlowConfig): {
 		promise: Promise<(() => Promise<void>) | undefined>;
 		events: EventEmitter;
 	};
 	private runInternal;
 	private installWifiProfile;
 	private installMdmProfile;
+	private retryMdmEnrollmentProfile;
 	private removeWifiProfile;
 	private retryIosCommand;
 	private retryActivateCommand;
-	private retry;
 }
 /**
  * Activation flow event names (use with EventEmitter.on/emit).

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@mcesystems/apple-kit",
-  "version": "1.0.87",
+  "version": "1.0.91",
   "description": "iOS device management toolkit using libimobiledevice command-line tools",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/types/index.d.ts",
   "exports": {
     ".": {
+      "my-internal": "./src/index.ts",
       "types": "./dist/types/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js"
@@ -37,8 +38,9 @@
     "graphql-request": "^5.2.0",
     "tsx": "^4.21.0",
     "plist": "^3.1.0",
-    "@mcesystems/tool-debug-g4": "1.0.87",
-    "@mcesystems/mdm-client-g4": "1.0.87"
+    "ts-retry-promise": "^0.8.1",
+    "@mcesystems/tool-debug-g4": "1.0.91",
+    "@mcesystems/mdm-client-g4": "1.0.91"
   },
   "devDependencies": {
     "@types/node": "^22.10.2",
@@ -52,8 +54,7 @@
     "rimraf": "^6.0.1",
     "typescript": "^5.7.2",
     "vitest": "^2.1.8",
-    "@types/plist": "^3.0.5",
-    "@mcesystems/usb-device-listener": "1.0.87"
+    "@types/plist": "^3.0.5"
   },
   "files": [
     "dist",
@@ -71,10 +72,10 @@
     "build": "tsx esbuild.config.mts",
     "build:all": "pnpm --filter @mcesystems/apple-kit... build",
     "clean": "rimraf dist",
-    "check:types": "tsc --noEmit",
+    "check:types": "tsc -p tsconfig.build.json --noEmit",
     "activate:example": "tsx src/examples/activationExample.ts",
     "ios:example": "tsx src/examples/iosExample.ts",
-    "usbmuxd:example": "tsx src/examples/usbmuxdIntegrationExample.ts",
+    "pairing:example": "tsx src/examples/waitForPairingExample.ts",
     "pack": "npm pack",
     "test": "vitest run",
     "test:watch": "vitest"

package/scripts/prepare-ios.ts

@@ -9,15 +9,15 @@ import { fileURLToPath } from "node:url";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
-const PACKAGE_ROOT = path.resolve(__dirname, "..");
-const RESOURCES_DIR = path.join(PACKAGE_ROOT, "resources");
+const PACKAGE_ROOT = process.env.PACKAGE_ROOT ?? path.resolve(__dirname, "..");
+const DESTINATION_DIR = process.env.DESTINATION_DIR ?? path.join(PACKAGE_ROOT, "resources");
 const GO_IOS_DIST_DIR = path.join(PACKAGE_ROOT, "node_modules", "go-ios", "dist");
 
 const WINTUN_VERSION = "0.14.1";
 const WINTUN_ZIP_NAME = `wintun-${WINTUN_VERSION}.zip`;
 const WINTUN_URL = `https://www.wintun.net/builds/${WINTUN_ZIP_NAME}`;
-const WINTUN_ZIP_PATH = path.join(RESOURCES_DIR, WINTUN_ZIP_NAME);
-const WINTUN_EXTRACT_DIR = path.join(RESOURCES_DIR, ".wintun-extract");
+const WINTUN_ZIP_PATH = path.join(DESTINATION_DIR, WINTUN_ZIP_NAME);
+const WINTUN_EXTRACT_DIR = path.join(DESTINATION_DIR, ".wintun-extract");
 
 async function pathExists(targetPath: string): Promise<boolean> {
 	try {
@@ -180,7 +180,7 @@ async function copyGoIosBinary(): Promise<void> {
 	if (!(await pathExists(sourcePath))) {
 		throw new Error(`go-ios binary not found: ${sourcePath}`);
 	}
-	await copyFile(sourcePath, path.join(RESOURCES_DIR, destinationName));
+	await copyFile(sourcePath, path.join(DESTINATION_DIR, destinationName));
 	console.log(`Copied go-ios binary to resources/${destinationName}`);
 }
 
@@ -201,17 +201,17 @@ async function copyWintunDll(): Promise<void> {
 		throw new Error(`wintun.dll not found after extraction: ${dllPath}`);
 	}
 
-	await copyFile(dllPath, path.join(RESOURCES_DIR, "wintun.dll"));
+	await copyFile(dllPath, path.join(DESTINATION_DIR, "wintun.dll"));
 	console.log(`Copied wintun.dll (${archFolder}) to resources/`);
 
 	if (await pathExists(licensePath)) {
-		await copyFile(licensePath, path.join(RESOURCES_DIR, "wintun-LICENSE.txt"));
+		await copyFile(licensePath, path.join(DESTINATION_DIR, "wintun-LICENSE.txt"));
 		console.log("Copied Wintun license to resources/wintun-LICENSE.txt");
 	}
 }
 
 async function main(): Promise<void> {
-	await mkdir(RESOURCES_DIR, { recursive: true });
+	await mkdir(DESTINATION_DIR, { recursive: true });
 	await copyGoIosBinary();
 	await copyWintunDll();
 }