appium-ios-remotexpc 0.6.2 → 0.8.0

package/build/src/services/ios/webinspector/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/services/ios/webinspector/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE3E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIjD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD,MAAM,CAAC,QAAQ,CAAC,gBAAgB,wCAAwC;IAGxE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAA4B;IACzE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,8BAA8B,CACnB;IACnC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,8BAA8B,CACnB;IACnC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAA6B;IAC5E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sCAAsC,CACpB;IAC1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAA8B;IAC9E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAA6B;IAC5E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,6BAA6B,CACpB;IAEjC,OAAO,CAAC,UAAU,CAAkC;IACpD,OAAO,CAAC,cAAc,CAAoC;IAC1D,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,cAAc,CAA8B;gBAExC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;IAKrC;;;;;OAKG;IACG,WAAW,CACf,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,eAAoB,GACzB,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;OAGG;IACI,aAAa,IAAI,cAAc,CAAC,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC;IA6DnE;;OAEG;IACH,aAAa,IAAI,IAAI;IAKrB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAc5B;;;OAGG;IACH,eAAe,IAAI,MAAM;IAIzB;;;OAGG;IACG,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/D;;OAEG;IACG,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAO/C;;;OAGG;IACG,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;;;OAKG;IACG,+BAA+B,CACnC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,eAAe,GAC7B,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;OAMG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,kBAAkB,GAAE,OAAc,GACjC,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;OAMG;IACG,iBAAiB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;OAKG;IACG,sBAAsB,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,IAAI,CAAC;IAQhB;;;OAGG;YACW,4BAA4B;IA2B1C;;OAEG;IACH,OAAO,CAAC,oBAAoB;CA0B7B;AAED,eAAe,mBAAmB,CAAC"}

package/build/src/services/ios/webinspector/index.js

@@ -0,0 +1,286 @@
+import { logger } from '@appium/support';
+import { randomUUID } from 'crypto';
+import { EventEmitter } from 'events';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+const log = logger.getLogger('WebInspectorService');
+/**
+ * WebInspectorService provides an API to:
+ * - Send messages to webinspectord
+ * - Listen to messages from webinspectord
+ * - Communicate with web views and Safari on iOS devices
+ *
+ * This service is used for web automation, inspection, and debugging.
+ */
+export class WebInspectorService extends BaseService {
+    static RSD_SERVICE_NAME = 'com.apple.webinspector.shim.remote';
+    // RPC method selectors
+    static RPC_REPORT_IDENTIFIER = '_rpc_reportIdentifier:';
+    static RPC_REQUEST_APPLICATION_LAUNCH = '_rpc_requestApplicationLaunch:';
+    static RPC_GET_CONNECTED_APPLICATIONS = '_rpc_getConnectedApplications:';
+    static RPC_FORWARD_GET_LISTING = '_rpc_forwardGetListing:';
+    static RPC_FORWARD_AUTOMATION_SESSION_REQUEST = '_rpc_forwardAutomationSessionRequest:';
+    static RPC_FORWARD_SOCKET_SETUP = '_rpc_forwardSocketSetup:';
+    static RPC_FORWARD_SOCKET_DATA = '_rpc_forwardSocketData:';
+    static RPC_FORWARD_INDICATE_WEB_VIEW = '_rpc_forwardIndicateWebView:';
+    connection = null;
+    messageEmitter = new EventEmitter();
+    isReceiving = false;
+    connectionId;
+    receivePromise = null;
+    constructor(address) {
+        super(address);
+        this.connectionId = randomUUID().toUpperCase();
+    }
+    /**
+     * Send a message to the WebInspector service
+     * @param selector The RPC selector (e.g., '_rpc_reportIdentifier:')
+     * @param args The arguments dictionary for the message
+     * @returns Promise that resolves when the message is sent
+     */
+    async sendMessage(selector, args = {}) {
+        const connection = await this.connectToWebInspectorService();
+        // Add connection identifier to all messages
+        const message = {
+            __selector: selector,
+            __argument: {
+                ...args,
+                WIRConnectionIdentifierKey: this.connectionId,
+            },
+        };
+        log.debug(`Sending WebInspector message: ${selector}`);
+        connection.sendPlist(message);
+    }
+    /**
+     * Listen to messages from the WebInspector service using async generator
+     * @yields PlistMessage - Messages received from the WebInspector service
+     */
+    async *listenMessage() {
+        await this.connectToWebInspectorService();
+        // Start receiving messages in background if not already started
+        if (!this.isReceiving) {
+            this.startMessageReceiver();
+        }
+        const queue = [];
+        let resolveNext = null;
+        let stopped = false;
+        const messageHandler = (message) => {
+            if (resolveNext) {
+                resolveNext({ value: message, done: false });
+                resolveNext = null;
+            }
+            else {
+                queue.push(message);
+            }
+        };
+        const stopHandler = () => {
+            stopped = true;
+            if (resolveNext) {
+                resolveNext({ value: undefined, done: true });
+                resolveNext = null;
+            }
+        };
+        this.messageEmitter.on('message', messageHandler);
+        this.messageEmitter.once('stop', stopHandler);
+        try {
+            while (!stopped) {
+                if (queue.length > 0) {
+                    yield queue.shift();
+                }
+                else {
+                    const message = await new Promise((resolve) => {
+                        if (stopped) {
+                            resolve(null);
+                            return;
+                        }
+                        resolveNext = (result) => {
+                            resolve(result.done ? null : result.value);
+                        };
+                    });
+                    if (message === null) {
+                        break;
+                    }
+                    yield message;
+                }
+            }
+        }
+        finally {
+            this.messageEmitter.off('message', messageHandler);
+            this.messageEmitter.off('stop', stopHandler);
+        }
+    }
+    /**
+     * Stop listening to messages
+     */
+    stopListening() {
+        this.isReceiving = false;
+        this.messageEmitter.emit('stop');
+    }
+    /**
+     * Close the connection and clean up resources
+     */
+    async close() {
+        this.stopListening();
+        if (this.connection) {
+            await this.connection.close();
+            this.connection = null;
+            log.debug('WebInspector connection closed');
+        }
+        if (this.receivePromise) {
+            await this.receivePromise;
+        }
+    }
+    /**
+     * Get the connection ID being used for this service
+     * @returns The connection identifier
+     */
+    getConnectionId() {
+        return this.connectionId;
+    }
+    /**
+     * Request application launch
+     * @param bundleId The bundle identifier of the application to launch
+     */
+    async requestApplicationLaunch(bundleId) {
+        await this.sendMessage(WebInspectorService.RPC_REQUEST_APPLICATION_LAUNCH, {
+            WIRApplicationBundleIdentifierKey: bundleId,
+        });
+    }
+    /**
+     * Get connected applications
+     */
+    async getConnectedApplications() {
+        await this.sendMessage(WebInspectorService.RPC_GET_CONNECTED_APPLICATIONS, {});
+    }
+    /**
+     * Forward get listing for an application
+     * @param appId The application identifier
+     */
+    async forwardGetListing(appId) {
+        await this.sendMessage(WebInspectorService.RPC_FORWARD_GET_LISTING, {
+            WIRApplicationIdentifierKey: appId,
+        });
+    }
+    /**
+     * Forward automation session request
+     * @param sessionId The session identifier
+     * @param appId The application identifier
+     * @param capabilities Optional session capabilities
+     */
+    async forwardAutomationSessionRequest(sessionId, appId, capabilities) {
+        const defaultCapabilities = {
+            'org.webkit.webdriver.webrtc.allow-insecure-media-capture': true,
+            'org.webkit.webdriver.webrtc.suppress-ice-candidate-filtering': false,
+        };
+        await this.sendMessage(WebInspectorService.RPC_FORWARD_AUTOMATION_SESSION_REQUEST, {
+            WIRApplicationIdentifierKey: appId,
+            WIRSessionIdentifierKey: sessionId,
+            WIRSessionCapabilitiesKey: {
+                ...defaultCapabilities,
+                ...(capabilities ?? {}),
+            },
+        });
+    }
+    /**
+     * Forward socket setup for inspector connection
+     * @param sessionId The session identifier
+     * @param appId The application identifier
+     * @param pageId The page identifier
+     * @param automaticallyPause Whether to automatically pause (defaults to true)
+     */
+    async forwardSocketSetup(sessionId, appId, pageId, automaticallyPause = true) {
+        const message = {
+            WIRApplicationIdentifierKey: appId,
+            WIRPageIdentifierKey: pageId,
+            WIRSenderKey: sessionId,
+            WIRMessageDataTypeChunkSupportedKey: 0,
+        };
+        if (!automaticallyPause) {
+            message.WIRAutomaticallyPause = false;
+        }
+        await this.sendMessage(WebInspectorService.RPC_FORWARD_SOCKET_SETUP, message);
+    }
+    /**
+     * Forward socket data to a page
+     * @param sessionId The session identifier
+     * @param appId The application identifier
+     * @param pageId The page identifier
+     * @param data The data to send (will be JSON stringified)
+     */
+    async forwardSocketData(sessionId, appId, pageId, data) {
+        const socketData = typeof data === 'string' ? data : JSON.stringify(data);
+        await this.sendMessage(WebInspectorService.RPC_FORWARD_SOCKET_DATA, {
+            WIRApplicationIdentifierKey: appId,
+            WIRPageIdentifierKey: pageId,
+            WIRSessionIdentifierKey: sessionId,
+            WIRSenderKey: sessionId,
+            WIRSocketDataKey: Buffer.from(socketData, 'utf-8'),
+        });
+    }
+    /**
+     * Forward indicate web view
+     * @param appId The application identifier
+     * @param pageId The page identifier
+     * @param enable Whether to enable indication
+     */
+    async forwardIndicateWebView(appId, pageId, enable) {
+        await this.sendMessage(WebInspectorService.RPC_FORWARD_INDICATE_WEB_VIEW, {
+            WIRApplicationIdentifierKey: appId,
+            WIRPageIdentifierKey: pageId,
+            WIRIndicateEnabledKey: enable,
+        });
+    }
+    /**
+     * Connect to the WebInspector service
+     * @returns Promise resolving to the ServiceConnection instance
+     */
+    async connectToWebInspectorService() {
+        if (this.connection) {
+            return this.connection;
+        }
+        const service = {
+            serviceName: WebInspectorService.RSD_SERVICE_NAME,
+            port: this.address[1].toString(),
+        };
+        this.connection = await this.startLockdownService(service);
+        // Consume the StartService response from RSDCheckin
+        const startServiceResponse = await this.connection.receive();
+        if (startServiceResponse?.Request !== 'StartService') {
+            log.warn(`Expected StartService response, got: ${JSON.stringify(startServiceResponse)}`);
+        }
+        // Send initial identifier report
+        await this.sendMessage(WebInspectorService.RPC_REPORT_IDENTIFIER, {});
+        log.debug('Connected to WebInspector service');
+        return this.connection;
+    }
+    /**
+     * Start receiving messages from the WebInspector service in the background
+     */
+    startMessageReceiver() {
+        if (this.isReceiving || !this.connection) {
+            return;
+        }
+        this.isReceiving = true;
+        this.receivePromise = (async () => {
+            try {
+                while (this.isReceiving && this.connection) {
+                    try {
+                        const message = await this.connection.receive();
+                        this.messageEmitter.emit('message', message);
+                    }
+                    catch (error) {
+                        if (this.isReceiving) {
+                            log.error('Error receiving message:', error);
+                            this.messageEmitter.emit('error', error);
+                        }
+                        break;
+                    }
+                }
+            }
+            finally {
+                this.isReceiving = false;
+            }
+        })();
+    }
+}
+export default WebInspectorService;

package/build/src/services.d.ts

@@ -1,10 +1,12 @@
 import { RemoteXpcConnection } from './lib/remote-xpc/remote-xpc-connection.js';
-import type { DiagnosticsServiceWithConnection, MobileConfigServiceWithConnection, MobileImageMounterServiceWithConnection, NotificationProxyServiceWithConnection, SyslogService as SyslogServiceType } from './lib/types.js';
+import type { DiagnosticsServiceWithConnection, MobileConfigServiceWithConnection, MobileImageMounterServiceWithConnection, NotificationProxyServiceWithConnection, SpringboardServiceWithConnection, SyslogService as SyslogServiceType, WebInspectorServiceWithConnection } from './lib/types.js';
 export declare function startDiagnosticsService(udid: string): Promise<DiagnosticsServiceWithConnection>;
 export declare function startNotificationProxyService(udid: string): Promise<NotificationProxyServiceWithConnection>;
 export declare function startMobileConfigService(udid: string): Promise<MobileConfigServiceWithConnection>;
 export declare function startMobileImageMounterService(udid: string): Promise<MobileImageMounterServiceWithConnection>;
+export declare function startSpringboardService(udid: string): Promise<SpringboardServiceWithConnection>;
 export declare function startSyslogService(udid: string): Promise<SyslogServiceType>;
+export declare function startWebInspectorService(udid: string): Promise<WebInspectorServiceWithConnection>;
 export declare function createRemoteXPCConnection(udid: string): Promise<{
     remoteXPC: RemoteXpcConnection;
     tunnelConnection: {

package/build/src/services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../src/services.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAGhF,OAAO,KAAK,EACV,gCAAgC,EAChC,iCAAiC,EACjC,uCAAuC,EACvC,sCAAsC,EACtC,aAAa,IAAI,iBAAiB,EACnC,MAAM,gBAAgB,CAAC;AAUxB,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,gCAAgC,CAAC,CAY3C;AAED,wBAAsB,6BAA6B,CACjD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,sCAAsC,CAAC,CAYjD;AAED,wBAAsB,wBAAwB,CAC5C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iCAAiC,CAAC,CAY5C;AACD,wBAAsB,8BAA8B,CAClD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,uCAAuC,CAAC,CAYlD;AAED,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC,CAG5B;AAED,wBAAsB,yBAAyB,CAAC,IAAI,EAAE,MAAM;;;;;;;;GAO3D"}
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../src/services.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAGhF,OAAO,KAAK,EACV,gCAAgC,EAChC,iCAAiC,EACjC,uCAAuC,EACvC,sCAAsC,EACtC,gCAAgC,EAChC,aAAa,IAAI,iBAAiB,EAClC,iCAAiC,EAClC,MAAM,gBAAgB,CAAC;AAYxB,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,gCAAgC,CAAC,CAY3C;AAED,wBAAsB,6BAA6B,CACjD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,sCAAsC,CAAC,CAYjD;AAED,wBAAsB,wBAAwB,CAC5C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iCAAiC,CAAC,CAY5C;AACD,wBAAsB,8BAA8B,CAClD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,uCAAuC,CAAC,CAYlD;AAED,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,gCAAgC,CAAC,CAY3C;AAED,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC,CAG5B;AAED,wBAAsB,wBAAwB,CAC5C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iCAAiC,CAAC,CAY5C;AAED,wBAAsB,yBAAyB,CAAC,IAAI,EAAE,MAAM;;;;;;;;GAO3D"}

package/build/src/services.js

@@ -6,7 +6,9 @@ import DiagnosticsService from './services/ios/diagnostic-service/index.js';
 import { MobileConfigService } from './services/ios/mobile-config/index.js';
 import MobileImageMounterService from './services/ios/mobile-image-mounter/index.js';
 import { NotificationProxyService } from './services/ios/notification-proxy/index.js';
+import { SpringBoardService } from './services/ios/springboard-service/index.js';
 import SyslogService from './services/ios/syslog-service/index.js';
+import { WebInspectorService } from './services/ios/webinspector/index.js';
 const APPIUM_XCUITEST_DRIVER_NAME = 'appium-xcuitest-driver';
 const TUNNEL_REGISTRY_PORT = 'tunnelRegistryPort';
 export async function startDiagnosticsService(udid) {
@@ -53,10 +55,32 @@ export async function startMobileImageMounterService(udid) {
         ]),
     };
 }
+export async function startSpringboardService(udid) {
+    const { remoteXPC, tunnelConnection } = await createRemoteXPCConnection(udid);
+    const springboardService = remoteXPC.findService(SpringBoardService.RSD_SERVICE_NAME);
+    return {
+        remoteXPC: remoteXPC,
+        springboardService: new SpringBoardService([
+            tunnelConnection.host,
+            parseInt(springboardService.port, 10),
+        ]),
+    };
+}
 export async function startSyslogService(udid) {
     const { tunnelConnection } = await createRemoteXPCConnection(udid);
     return new SyslogService([tunnelConnection.host, tunnelConnection.port]);
 }
+export async function startWebInspectorService(udid) {
+    const { remoteXPC, tunnelConnection } = await createRemoteXPCConnection(udid);
+    const webInspectorService = remoteXPC.findService(WebInspectorService.RSD_SERVICE_NAME);
+    return {
+        remoteXPC: remoteXPC,
+        webInspectorService: new WebInspectorService([
+            tunnelConnection.host,
+            parseInt(webInspectorService.port, 10),
+        ]),
+    };
+}
 export async function createRemoteXPCConnection(udid) {
     const tunnelConnection = await getTunnelInformation(udid);
     const remoteXPC = await startService(tunnelConnection.host, tunnelConnection.port);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-ios-remotexpc",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "type": "module",
@@ -31,6 +31,8 @@
     "test:notification": "mocha test/integration/notification-proxy-test.ts --exit --timeout 1m",
     "test:image-mounter": "mocha test/integration/mobile-image-mounter-test.ts --exit --timeout 1m",
     "test:mobile-config": "mocha test/integration/mobile-config-test.ts --exit --timeout 1m",
+    "test:springboard": "mocha test/integration/springboard-service-test.ts --exit --timeout 1m",
+    "test:webinspector": "mocha test/integration/webinspector-test.ts --exit --timeout 1m",
     "test:unit": "mocha 'test/unit/**/*.ts' --exit --timeout 2m",
     "test:tunnel-creation": "sudo tsx scripts/test-tunnel-creation.ts",
     "test:tunnel-creation:lsof": "sudo tsx scripts/test-tunnel-creation.ts --keep-open"

package/src/index.ts

@@ -17,6 +17,8 @@ export type {
   MobileImageMounterService,
   NotificationProxyService,
   MobileConfigService,
+  SpringboardService,
+  WebInspectorService,
   SyslogService,
   SocketInfo,
   TunnelResult,
@@ -26,6 +28,8 @@ export type {
   MobileImageMounterServiceWithConnection,
   NotificationProxyServiceWithConnection,
   MobileConfigServiceWithConnection,
+  SpringboardServiceWithConnection,
+  WebInspectorServiceWithConnection,
 } from './lib/types.js';
 export {
   createUsbmux,

package/src/lib/types.ts

@@ -6,6 +6,7 @@ import { EventEmitter } from 'events';
 
 import type { ServiceConnection } from '../service-connection.js';
 import type { BaseService, Service } from '../services/ios/base-service.js';
+import type { InterfaceOrientation } from '../services/ios/springboard-service/index.js';
 import type { RemoteXpcConnection } from './remote-xpc/remote-xpc-connection.js';
 import type { Device } from './usbmux/index.js';
 
@@ -311,6 +312,121 @@ export interface MobileConfigServiceWithConnection {
   remoteXPC: RemoteXpcConnection;
 }
 
+/**
+ * Represents the WebInspectorService
+ */
+export interface WebInspectorService extends BaseService {
+  /**
+   * Send a message to the WebInspector service
+   * @param selector The RPC selector (e.g., '_rpc_reportIdentifier:')
+   * @param args The arguments dictionary for the message
+   * @returns Promise that resolves when the message is sent
+   */
+  sendMessage(selector: string, args?: PlistDictionary): Promise<void>;
+
+  /**
+   * Listen to messages from the WebInspector service using async generator
+   * @yields PlistMessage - Messages received from the WebInspector service
+   */
+  listenMessage(): AsyncGenerator<PlistMessage, void, unknown>;
+
+  /**
+   * Stop listening to messages
+   */
+  stopListening(): void;
+
+  /**
+   * Close the connection and clean up resources
+   */
+  close(): Promise<void>;
+
+  /**
+   * Get the connection ID being used for this service
+   * @returns The connection identifier
+   */
+  getConnectionId(): string;
+
+  /**
+   * Request application launch
+   * @param bundleId The bundle identifier of the application to launch
+   */
+  requestApplicationLaunch(bundleId: string): Promise<void>;
+
+  /**
+   * Get connected applications
+   */
+  getConnectedApplications(): Promise<void>;
+
+  /**
+   * Forward get listing for an application
+   * @param appId The application identifier
+   */
+  forwardGetListing(appId: string): Promise<void>;
+
+  /**
+   * Forward automation session request
+   * @param sessionId The session identifier
+   * @param appId The application identifier
+   * @param capabilities Optional session capabilities
+   */
+  forwardAutomationSessionRequest(
+    sessionId: string,
+    appId: string,
+    capabilities?: PlistDictionary,
+  ): Promise<void>;
+
+  /**
+   * Forward socket setup for inspector connection
+   * @param sessionId The session identifier
+   * @param appId The application identifier
+   * @param pageId The page identifier
+   * @param automaticallyPause Whether to automatically pause (defaults to true)
+   */
+  forwardSocketSetup(
+    sessionId: string,
+    appId: string,
+    pageId: number,
+    automaticallyPause?: boolean,
+  ): Promise<void>;
+
+  /**
+   * Forward socket data to a page
+   * @param sessionId The session identifier
+   * @param appId The application identifier
+   * @param pageId The page identifier
+   * @param data The data to send (will be JSON stringified)
+   */
+  forwardSocketData(
+    sessionId: string,
+    appId: string,
+    pageId: number,
+    data: any,
+  ): Promise<void>;
+
+  /**
+   * Forward indicate web view
+   * @param appId The application identifier
+   * @param pageId The page identifier
+   * @param enable Whether to enable indication
+   */
+  forwardIndicateWebView(
+    appId: string,
+    pageId: number,
+    enable: boolean,
+  ): Promise<void>;
+}
+
+/**
+ * Represents a WebInspectorService instance with its associated RemoteXPC connection
+ * This allows callers to properly manage the connection lifecycle
+ */
+export interface WebInspectorServiceWithConnection {
+  /** The WebInspectorService instance */
+  webInspectorService: WebInspectorService;
+  /** The RemoteXPC connection that can be used to close the connection */
+  remoteXPC: RemoteXpcConnection;
+}
+
 /**
  * Options for configuring syslog capture
  */
@@ -508,3 +624,113 @@ export interface MobileImageMounterServiceWithConnection {
   /** The RemoteXPC connection for service management */
   remoteXPC: RemoteXpcConnection;
 }
+
+/**
+ * Represents the instance side of SpringboardService
+ */
+export interface SpringboardService extends BaseService {
+  /**
+   * Gets the icon state
+   * @returns Promise resolving to the icon state
+   * e.g.
+   * [
+   *     {
+   *       displayIdentifier: 'com.apple.MobileSMS',
+   *       displayName: 'Messages',
+   *       iconModDate: 2025-09-03T12:55:46.400Z,
+   *       bundleVersion: '1402.700.63.2.1',
+   *       bundleIdentifier: 'com.apple.MobileSMS'
+   *     },
+   *     {
+   *       displayIdentifier: 'com.apple.measure',
+   *       displayName: 'Measure',
+   *       iconModDate: 2025-09-03T12:55:49.522Z,
+   *       bundleVersion: '175.100.3.0.1',
+   *       bundleIdentifier: 'com.apple.measure'
+   *     },
+   *     ...
+   *  ]
+   */
+  getIconState(): Promise<PlistDictionary>;
+
+  /**
+   * TODO: This does not work currently due to a bug in Apple protocol implementation (maybe?)
+   * Sets the icon state
+   * @param newState where is the payload from getIconState
+   */
+  setIconState(newState: PlistDictionary[]): Promise<void>;
+
+  /**
+   * Gets the icon PNG data for a given bundle ID
+   * @param bundleID The bundle ID of the app
+   * @returns {Promise<Buffer>} which is the PNG data of the app icon
+   */
+  getIconPNGData(bundleID: string): Promise<Buffer>;
+
+  /**
+   * TODO: This does not work currently due to a bug in Apple protocol implementation
+   * Add payload structure when it is fixed
+   * Gets wallpaper info
+   * @param wallpaperName The name of the wallpaper
+   * @returns Promise resolving to the wallpaper info
+   */
+  getWallpaperInfo(wallpaperName: string): Promise<PlistDictionary>;
+
+  /**
+   * Gets homescreen icon metrics
+   * @returns {Promise<PlistDictionary>}
+   * e.g.
+   * {
+   *   homeScreenIconHeight: 64,
+   *   homeScreenIconMaxPages: 15,
+   *   homeScreenWidth: 414,
+   *   homeScreenHeight: 896,
+   *   homeScreenIconDockMaxCount: 4,
+   *   homeScreenIconFolderMaxPages: 15,
+   *   homeScreenIconWidth: 64,
+   *   homeScreenIconRows: 6,
+   *   homeScreenIconColumns: 4,
+   *   homeScreenIconFolderColumns: 3,
+   *   homeScreenIconFolderRows: 3
+   * }
+   */
+  getHomescreenIconMetrics(): Promise<PlistDictionary>;
+
+  /**
+   * Gets the current interface orientation
+   * @returns {Promise<InterfaceOrientation>}
+   * 1 = Portrait
+   * 2 = PortraitUpsideDown
+   * 3 = Landscape
+   * 4 = LandscapeHomeToLeft
+   */
+  getInterfaceOrientation(): Promise<InterfaceOrientation>;
+
+  /**
+   * Gets wallpaper preview image for homescreen and lockscreen
+   * @param wallpaperName
+   * @returns {Promise<Buffer>} which is a wallpaper preview image
+   */
+  getWallpaperPreviewImage(
+    wallpaperName: 'homescreen' | 'lockscreen',
+  ): Promise<Buffer>;
+
+  /**
+   * TODO: This does not work currently due to a bug in Apple protocol implementation
+   * Use getWallpaperPreviewImage('homescreen') instead
+   * Gets wallpaper PNG data
+   * @param wallpaperName
+   * @returns {Promise<Buffer>}
+   */
+  getWallpaperPNGData(wallpaperName: string): Promise<Buffer>;
+}
+
+/**
+ * Represents a SpringboardService instance with its associated RemoteXPC connection
+ */
+export interface SpringboardServiceWithConnection {
+  /** The SpringboardService instance */
+  springboardService: SpringboardService;
+  /** The RemoteXPC connection for service management */
+  remoteXPC: RemoteXpcConnection;
+}

package/src/service-connection.ts

@@ -60,6 +60,15 @@ export class ServiceConnection extends BasePlistService {
     return this.sendAndReceive(requestObj, timeout);
   }
 
+  /**
+   * Sends a plist message without waiting for a response
+   * This is useful for fire-and-forget style communication
+   * @param message The message to send
+   */
+  sendPlist(message: PlistDictionary): void {
+    this.send(message);
+  }
+
   /**
    * Gets the underlying socket
    * @returns The socket used by this service

package/src/services/index.ts

@@ -6,12 +6,14 @@ import * as diagnostics from './ios/diagnostic-service/index.js';
 import * as mobileImageMounter from './ios/mobile-image-mounter/index.js';
 import * as syslog from './ios/syslog-service/index.js';
 import * as tunnel from './ios/tunnel-service/index.js';
+import * as webinspector from './ios/webinspector/index.js';
 
 export {
   diagnostics,
   mobileImageMounter,
   syslog,
   tunnel,
+  webinspector,
   TunnelRegistryServer,
   startTunnelRegistryServer,
 };