appium-ios-remotexpc 0.6.2 → 0.7.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.7.0](https://github.com/appium/appium-ios-remotexpc/compare/v0.6.2...v0.7.0) (2025-10-09)
+
+### Features
+
+* implement springboard service  ([#79](https://github.com/appium/appium-ios-remotexpc/issues/79)) ([eae9b42](https://github.com/appium/appium-ios-remotexpc/commit/eae9b427dfb644a8b67f8eb76505d4aba7094311))
+
 ## [0.6.2](https://github.com/appium/appium-ios-remotexpc/compare/v0.6.1...v0.6.2) (2025-10-08)
 
 ### Bug Fixes

package/build/src/index.d.ts

@@ -4,6 +4,6 @@ import { TunnelRegistryServer, startTunnelRegistryServer } from './lib/tunnel/tu
 import { Usbmux, createUsbmux } from './lib/usbmux/index.js';
 import * as Services from './services.js';
 import { startCoreDeviceProxy } from './services/ios/tunnel-service/index.js';
-export type { DiagnosticsService, MobileImageMounterService, NotificationProxyService, MobileConfigService, SyslogService, SocketInfo, TunnelResult, TunnelRegistry, TunnelRegistryEntry, DiagnosticsServiceWithConnection, MobileImageMounterServiceWithConnection, NotificationProxyServiceWithConnection, MobileConfigServiceWithConnection, } from './lib/types.js';
+export type { DiagnosticsService, MobileImageMounterService, NotificationProxyService, MobileConfigService, SpringboardService, SyslogService, SocketInfo, TunnelResult, TunnelRegistry, TunnelRegistryEntry, DiagnosticsServiceWithConnection, MobileImageMounterServiceWithConnection, NotificationProxyServiceWithConnection, MobileConfigServiceWithConnection, SpringboardServiceWithConnection, } from './lib/types.js';
 export { createUsbmux, Services, Usbmux, TunnelManager, PacketStreamServer, PacketStreamClient, createLockdownServiceByUDID, startCoreDeviceProxy, TunnelRegistryServer, startTunnelRegistryServer, };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9E,YAAY,EACV,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,gCAAgC,EAChC,uCAAuC,EACvC,sCAAsC,EACtC,iCAAiC,GAClC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,2BAA2B,EAC3B,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,GAC1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9E,YAAY,EACV,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,gCAAgC,EAChC,uCAAuC,EACvC,sCAAsC,EACtC,iCAAiC,EACjC,gCAAgC,GACjC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,2BAA2B,EAC3B,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,GAC1B,CAAC"}

package/build/src/lib/types.d.ts

@@ -5,6 +5,7 @@ import type { PacketData } from 'appium-ios-tuntap';
 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';
 /**
@@ -430,4 +431,103 @@ 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;
+}
 //# sourceMappingURL=types.d.ts.map

package/build/src/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,MAAM,GACN,UAAU,GACV,eAAe,GACf,IAAI,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAChB,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,aAAa,GACb,IAAI,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAEpD,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,kDAAkD;IAClD,cAAc,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC7C,kCAAkC;IAClC,QAAQ,EAAE;QACR,iDAAiD;QACjD,WAAW,EAAE,MAAM,CAAC;QACpB,8CAA8C;QAC9C,YAAY,EAAE,MAAM,CAAC;QACrB,yCAAyC;QACzC,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,UAAU,EAAE;QACV,+BAA+B;QAC/B,IAAI,EAAE,MAAM,CAAC;QACb,+BAA+B;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,0DAA0D;QAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,MAAM,EAAE;QACN,+BAA+B;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,0DAA0D;QAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,yCAAyC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,OAAO,EAAE,OAAO,CAAC;IACjB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAEpC;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAErC;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,eAAe,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D;;;OAGG;IACH,iCAAiC,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChE;;;;OAIG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxD;;;;OAIG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrD;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC;IACpE;;;;OAIG;IACH,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD;;;OAGG;IACH,4BAA4B,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC3D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,cAAc,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3C;;;;OAIG;IACH,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD;;;OAGG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD;;;OAGG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,KAAK,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,kBAAkB,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,sCAAsC;IACtC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,uCAAuC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+CAA+C;IAC/C,iBAAiB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IACtD,+BAA+B;IAC/B,oBAAoB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD;;;;;;OAMG;IACH,KAAK,CACH,OAAO,EAAE,OAAO,EAChB,YAAY,EAAE,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,EACtD,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,KAAK,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,WAAW;IAC5D;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAE9C;;;OAGG;IACH,0BAA0B,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,KAAK,CACH,aAAa,EAAE,MAAM,EACrB,qBAAqB,EAAE,MAAM,EAC7B,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;OAGG;IACH,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C;;;;OAIG;IACH,UAAU,CAAC,qBAAqB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5D;;;OAGG;IACH,+BAA+B,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAE5D;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAE9B;;;;;OAKG;IACH,4BAA4B,CAC1B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,KAAK,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,yBAAyB,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD,6CAA6C;IAC7C,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,sDAAsD;IACtD,SAAS,EAAE,mBAAmB,CAAC;CAChC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACzF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,MAAM,GACN,UAAU,GACV,eAAe,GACf,IAAI,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAChB,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,aAAa,GACb,IAAI,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAEpD,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,kDAAkD;IAClD,cAAc,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC7C,kCAAkC;IAClC,QAAQ,EAAE;QACR,iDAAiD;QACjD,WAAW,EAAE,MAAM,CAAC;QACpB,8CAA8C;QAC9C,YAAY,EAAE,MAAM,CAAC;QACrB,yCAAyC;QACzC,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,UAAU,EAAE;QACV,+BAA+B;QAC/B,IAAI,EAAE,MAAM,CAAC;QACb,+BAA+B;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,0DAA0D;QAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,MAAM,EAAE;QACN,+BAA+B;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,0DAA0D;QAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,yCAAyC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,OAAO,EAAE,OAAO,CAAC;IACjB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAEpC;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAErC;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,eAAe,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D;;;OAGG;IACH,iCAAiC,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChE;;;;OAIG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxD;;;;OAIG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrD;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC;IACpE;;;;OAIG;IACH,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD;;;OAGG;IACH,4BAA4B,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC3D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,cAAc,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3C;;;;OAIG;IACH,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD;;;OAGG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD;;;OAGG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,KAAK,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,kBAAkB,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,sCAAsC;IACtC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,uCAAuC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+CAA+C;IAC/C,iBAAiB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IACtD,+BAA+B;IAC/B,oBAAoB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD;;;;;;OAMG;IACH,KAAK,CACH,OAAO,EAAE,OAAO,EAChB,YAAY,EAAE,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,EACtD,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,KAAK,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,WAAW;IAC5D;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAE9C;;;OAGG;IACH,0BAA0B,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,KAAK,CACH,aAAa,EAAE,MAAM,EACrB,qBAAqB,EAAE,MAAM,EAC7B,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;OAGG;IACH,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C;;;;OAIG;IACH,UAAU,CAAC,qBAAqB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5D;;;OAGG;IACH,+BAA+B,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAE5D;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAE9B;;;;;OAKG;IACH,4BAA4B,CAC1B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,KAAK,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,yBAAyB,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD,6CAA6C;IAC7C,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,sDAAsD;IACtD,SAAS,EAAE,mBAAmB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAEzC;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAElE;;;;;;;;;;;;;;;;;OAiBG;IACH,wBAAwB,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAErD;;;;;;;OAOG;IACH,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEzD;;;;OAIG;IACH,wBAAwB,CACtB,aAAa,EAAE,YAAY,GAAG,YAAY,GACzC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnB;;;;;;OAMG;IACH,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,sCAAsC;IACtC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,sDAAsD;IACtD,SAAS,EAAE,mBAAmB,CAAC;CAChC"}

package/build/src/services/ios/springboard-service/index.d.ts

@@ -0,0 +1,39 @@
+import { type PlistDictionary, type SpringboardService as SpringboardInterface } from '../../../lib/types.js';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+declare enum InterfaceOrientation {
+    PORTRAIT = 1,// 0 degrees (default)
+    PORTRAIT_UPSIDE_DOWN = 2,// 180 degrees
+    LANDSCAPE = 3,// 90 degrees clockwise
+    LANDSCAPE_HOME_TO_LEFT = 4
+}
+declare class SpringBoardService extends BaseService implements SpringboardInterface {
+    static readonly RSD_SERVICE_NAME = "com.apple.springboardservices.shim.remote";
+    private _conn;
+    constructor(address: [string, number]);
+    getIconState(): Promise<PlistDictionary>;
+    /**
+     * TODO: This does not work currently due to a bug in Apple protocol implementation (maybe?)
+     * Uncomment tests when it is fixed
+     */
+    setIconState(newState?: PlistDictionary[]): Promise<void>;
+    getIconPNGData(bundleID: string): Promise<Buffer>;
+    /**
+     * TODO: This does not work currently due to a bug in Apple protocol implementation
+     * Add tests when it is fixed
+     */
+    getWallpaperInfo(wallpaperName: string): Promise<PlistDictionary>;
+    getWallpaperPreviewImage(wallpaperName: 'homescreen' | 'lockscreen'): Promise<Buffer>;
+    getHomescreenIconMetrics(): Promise<PlistDictionary>;
+    getInterfaceOrientation(): Promise<InterfaceOrientation>;
+    /**
+     * TODO: This does not work currently due to a bug in Apple protocol implementation
+     * Add tests when it is fixed
+     */
+    getWallpaperPNGData(wallpaperName: string): Promise<Buffer>;
+    connectToSpringboardService(): Promise<ServiceConnection>;
+    private sendRequestAndReceive;
+    private getServiceConfig;
+}
+export { SpringBoardService, InterfaceOrientation };
+//# sourceMappingURL=index.d.ts.map

package/build/src/services/ios/springboard-service/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/services/ios/springboard-service/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,kBAAkB,IAAI,oBAAoB,EAChD,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,aAAK,oBAAoB;IACvB,QAAQ,IAAI,CAAE,sBAAsB;IACpC,oBAAoB,IAAI,CAAE,cAAc;IACxC,SAAS,IAAI,CAAE,uBAAuB;IACtC,sBAAsB,IAAI;CAC3B;AAED,cAAM,kBAAmB,SAAQ,WAAY,YAAW,oBAAoB;IAC1E,MAAM,CAAC,QAAQ,CAAC,gBAAgB,+CACc;IAC9C,OAAO,CAAC,KAAK,CAAkC;gBAEnC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;IAI/B,YAAY,IAAI,OAAO,CAAC,eAAe,CAAC;IAe9C;;;OAGG;IACG,YAAY,CAAC,QAAQ,GAAE,eAAe,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB7D,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBvD;;;OAGG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAejE,wBAAwB,CAC5B,aAAa,EAAE,YAAY,GAAG,YAAY,GACzC,OAAO,CAAC,MAAM,CAAC;IAkBZ,wBAAwB,IAAI,OAAO,CAAC,eAAe,CAAC;IAgBpD,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAgB9D;;;OAGG;IACG,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAgB3D,2BAA2B,IAAI,OAAO,CAAC,iBAAiB,CAAC;YASjD,qBAAqB;IAWnC,OAAO,CAAC,gBAAgB;CASzB;AAED,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,CAAC"}

package/build/src/services/ios/springboard-service/index.js

@@ -0,0 +1,174 @@
+import {} from '../../../lib/types.js';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+var InterfaceOrientation;
+(function (InterfaceOrientation) {
+    InterfaceOrientation[InterfaceOrientation["PORTRAIT"] = 1] = "PORTRAIT";
+    InterfaceOrientation[InterfaceOrientation["PORTRAIT_UPSIDE_DOWN"] = 2] = "PORTRAIT_UPSIDE_DOWN";
+    InterfaceOrientation[InterfaceOrientation["LANDSCAPE"] = 3] = "LANDSCAPE";
+    InterfaceOrientation[InterfaceOrientation["LANDSCAPE_HOME_TO_LEFT"] = 4] = "LANDSCAPE_HOME_TO_LEFT";
+})(InterfaceOrientation || (InterfaceOrientation = {}));
+class SpringBoardService extends BaseService {
+    static RSD_SERVICE_NAME = 'com.apple.springboardservices.shim.remote';
+    _conn = null;
+    constructor(address) {
+        super(address);
+    }
+    async getIconState() {
+        try {
+            const req = {
+                command: 'getIconState',
+                formatVersion: '2',
+            };
+            return await this.sendRequestAndReceive(req);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to get Icon state: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    /**
+     * TODO: This does not work currently due to a bug in Apple protocol implementation (maybe?)
+     * Uncomment tests when it is fixed
+     */
+    async setIconState(newState = []) {
+        try {
+            const req = {
+                command: 'setIconState',
+                iconState: newState,
+            };
+            await this.sendRequestAndReceive(req);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to set icon state: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    async getIconPNGData(bundleID) {
+        try {
+            const req = {
+                command: 'getIconPNGData',
+                bundleId: bundleID,
+            };
+            const res = await this.sendRequestAndReceive(req);
+            return res.pngData;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to get Icon PNG data: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    /**
+     * TODO: This does not work currently due to a bug in Apple protocol implementation
+     * Add tests when it is fixed
+     */
+    async getWallpaperInfo(wallpaperName) {
+        try {
+            const req = {
+                command: 'getWallpaperInfo',
+                wallpaperName,
+            };
+            return await this.sendRequestAndReceive(req);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to get wallpaper info: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    async getWallpaperPreviewImage(wallpaperName) {
+        try {
+            const req = {
+                command: 'getWallpaperPreviewImage',
+                wallpaperName,
+            };
+            const res = await this.sendRequestAndReceive(req);
+            return res.pngData;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to get wallpaper preview image: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    async getHomescreenIconMetrics() {
+        try {
+            const req = {
+                command: 'getHomeScreenIconMetrics',
+            };
+            return await this.sendRequestAndReceive(req);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to get homescreen icon metrics: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    async getInterfaceOrientation() {
+        try {
+            const req = {
+                command: 'getInterfaceOrientation',
+            };
+            const res = await this.sendRequestAndReceive(req);
+            return res.interfaceOrientation;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to get interface orientation: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    /**
+     * TODO: This does not work currently due to a bug in Apple protocol implementation
+     * Add tests when it is fixed
+     */
+    async getWallpaperPNGData(wallpaperName) {
+        try {
+            const req = {
+                command: 'getHomeScreenWallpaperPNGData',
+                wallpaperName,
+            };
+            const res = await this.sendRequestAndReceive(req);
+            return res.pngData;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to get wallpaper PNG data: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    async connectToSpringboardService() {
+        if (this._conn) {
+            return this._conn;
+        }
+        const service = this.getServiceConfig();
+        this._conn = await this.startLockdownService(service);
+        return this._conn;
+    }
+    async sendRequestAndReceive(request) {
+        if (!this._conn) {
+            this._conn = await this.connectToSpringboardService();
+        }
+        // Skip StartService response
+        await this._conn.sendAndReceive(request);
+        return await this._conn.sendPlistRequest(request);
+    }
+    getServiceConfig() {
+        return {
+            serviceName: SpringBoardService.RSD_SERVICE_NAME,
+            port: this.address[1].toString(),
+        };
+    }
+}
+export { SpringBoardService, InterfaceOrientation };

package/build/src/services.d.ts

@@ -1,9 +1,10 @@
 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 } 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 createRemoteXPCConnection(udid: string): Promise<{
     remoteXPC: RemoteXpcConnection;

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,EACnC,MAAM,gBAAgB,CAAC;AAWxB,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,yBAAyB,CAAC,IAAI,EAAE,MAAM;;;;;;;;GAO3D"}

package/build/src/services.js

@@ -6,6 +6,7 @@ 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';
 const APPIUM_XCUITEST_DRIVER_NAME = 'appium-xcuitest-driver';
 const TUNNEL_REGISTRY_PORT = 'tunnelRegistryPort';
@@ -53,6 +54,17 @@ 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]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-ios-remotexpc",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "type": "module",
@@ -31,6 +31,7 @@
     "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: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,7 @@ export type {
   MobileImageMounterService,
   NotificationProxyService,
   MobileConfigService,
+  SpringboardService,
   SyslogService,
   SocketInfo,
   TunnelResult,
@@ -26,6 +27,7 @@ export type {
   MobileImageMounterServiceWithConnection,
   NotificationProxyServiceWithConnection,
   MobileConfigServiceWithConnection,
+  SpringboardServiceWithConnection,
 } 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';
 
@@ -508,3 +509,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/services/ios/springboard-service/index.ts

@@ -0,0 +1,197 @@
+import {
+  type PlistDictionary,
+  type SpringboardService as SpringboardInterface,
+} from '../../../lib/types.js';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+
+enum InterfaceOrientation {
+  PORTRAIT = 1, // 0 degrees (default)
+  PORTRAIT_UPSIDE_DOWN = 2, // 180 degrees
+  LANDSCAPE = 3, // 90 degrees clockwise
+  LANDSCAPE_HOME_TO_LEFT = 4, // 270 degrees clockwise
+}
+
+class SpringBoardService extends BaseService implements SpringboardInterface {
+  static readonly RSD_SERVICE_NAME =
+    'com.apple.springboardservices.shim.remote';
+  private _conn: ServiceConnection | null = null;
+
+  constructor(address: [string, number]) {
+    super(address);
+  }
+
+  async getIconState(): Promise<PlistDictionary> {
+    try {
+      const req = {
+        command: 'getIconState',
+        formatVersion: '2',
+      };
+      return await this.sendRequestAndReceive(req);
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`Failed to get Icon state: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+
+  /**
+   * TODO: This does not work currently due to a bug in Apple protocol implementation (maybe?)
+   * Uncomment tests when it is fixed
+   */
+  async setIconState(newState: PlistDictionary[] = []): Promise<void> {
+    try {
+      const req = {
+        command: 'setIconState',
+        iconState: newState,
+      };
+
+      await this.sendRequestAndReceive(req);
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`Failed to set icon state: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+
+  async getIconPNGData(bundleID: string): Promise<Buffer> {
+    try {
+      const req = {
+        command: 'getIconPNGData',
+        bundleId: bundleID,
+      };
+      const res = await this.sendRequestAndReceive(req);
+      return res.pngData as Buffer;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`Failed to get Icon PNG data: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+
+  /**
+   * TODO: This does not work currently due to a bug in Apple protocol implementation
+   * Add tests when it is fixed
+   */
+  async getWallpaperInfo(wallpaperName: string): Promise<PlistDictionary> {
+    try {
+      const req = {
+        command: 'getWallpaperInfo',
+        wallpaperName,
+      };
+      return await this.sendRequestAndReceive(req);
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`Failed to get wallpaper info: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+
+  async getWallpaperPreviewImage(
+    wallpaperName: 'homescreen' | 'lockscreen',
+  ): Promise<Buffer> {
+    try {
+      const req = {
+        command: 'getWallpaperPreviewImage',
+        wallpaperName,
+      };
+      const res = await this.sendRequestAndReceive(req);
+      return res.pngData as Buffer;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(
+          `Failed to get wallpaper preview image: ${error.message}`,
+        );
+      }
+      throw error;
+    }
+  }
+
+  async getHomescreenIconMetrics(): Promise<PlistDictionary> {
+    try {
+      const req = {
+        command: 'getHomeScreenIconMetrics',
+      };
+      return await this.sendRequestAndReceive(req);
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(
+          `Failed to get homescreen icon metrics: ${error.message}`,
+        );
+      }
+      throw error;
+    }
+  }
+
+  async getInterfaceOrientation(): Promise<InterfaceOrientation> {
+    try {
+      const req = {
+        command: 'getInterfaceOrientation',
+      };
+      const res = await this.sendRequestAndReceive(req);
+      return res.interfaceOrientation as InterfaceOrientation;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(
+          `Failed to get interface orientation: ${error.message}`,
+        );
+      }
+      throw error;
+    }
+  }
+  /**
+   * TODO: This does not work currently due to a bug in Apple protocol implementation
+   * Add tests when it is fixed
+   */
+  async getWallpaperPNGData(wallpaperName: string): Promise<Buffer> {
+    try {
+      const req = {
+        command: 'getHomeScreenWallpaperPNGData',
+        wallpaperName,
+      };
+      const res = await this.sendRequestAndReceive(req);
+      return res.pngData as Buffer;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`Failed to get wallpaper PNG data: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+
+  async connectToSpringboardService(): Promise<ServiceConnection> {
+    if (this._conn) {
+      return this._conn;
+    }
+    const service = this.getServiceConfig();
+    this._conn = await this.startLockdownService(service);
+    return this._conn;
+  }
+
+  private async sendRequestAndReceive(
+    request: PlistDictionary,
+  ): Promise<PlistDictionary> {
+    if (!this._conn) {
+      this._conn = await this.connectToSpringboardService();
+    }
+    // Skip StartService response
+    await this._conn.sendAndReceive(request);
+    return await this._conn.sendPlistRequest(request);
+  }
+
+  private getServiceConfig(): {
+    serviceName: string;
+    port: string;
+  } {
+    return {
+      serviceName: SpringBoardService.RSD_SERVICE_NAME,
+      port: this.address[1].toString(),
+    };
+  }
+}
+
+export { SpringBoardService, InterfaceOrientation };

package/src/services.ts

@@ -8,12 +8,14 @@ import type {
   MobileConfigServiceWithConnection,
   MobileImageMounterServiceWithConnection,
   NotificationProxyServiceWithConnection,
+  SpringboardServiceWithConnection,
   SyslogService as SyslogServiceType,
 } from './lib/types.js';
 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';
 
 const APPIUM_XCUITEST_DRIVER_NAME = 'appium-xcuitest-driver';
@@ -82,6 +84,22 @@ export async function startMobileImageMounterService(
   };
 }
 
+export async function startSpringboardService(
+  udid: string,
+): Promise<SpringboardServiceWithConnection> {
+  const { remoteXPC, tunnelConnection } = await createRemoteXPCConnection(udid);
+  const springboardService = remoteXPC.findService(
+    SpringBoardService.RSD_SERVICE_NAME,
+  );
+  return {
+    remoteXPC: remoteXPC as RemoteXpcConnection,
+    springboardService: new SpringBoardService([
+      tunnelConnection.host,
+      parseInt(springboardService.port, 10),
+    ]),
+  };
+}
+
 export async function startSyslogService(
   udid: string,
 ): Promise<SyslogServiceType> {