appium-ios-remotexpc 0.4.2 → 0.5.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.5.0](https://github.com/appium/appium-ios-remotexpc/compare/v0.4.2...v0.5.0) (2025-09-29)
+
+### Features
+
+* implement `mcinstall` service ([#71](https://github.com/appium/appium-ios-remotexpc/issues/71)) ([dbd2a6d](https://github.com/appium/appium-ios-remotexpc/commit/dbd2a6dece3d4994d301b0891fff20af77c1a1f2))
+
 ## [0.4.2](https://github.com/appium/appium-ios-remotexpc/compare/v0.4.1...v0.4.2) (2025-09-16)
 
 ### Miscellaneous Chores

package/build/src/lib/plist/constants.d.ts

@@ -33,4 +33,5 @@ export declare const BPLIST_TYPE: {
     SET: number;
     DICT: number;
 };
+export declare const SUPPORTED_EXTENSIONS: readonly [".pem", ".cer", ".crt", ".p12", ".pfx", ".mobileconfig", ".plist"];
 //# sourceMappingURL=constants.d.ts.map

package/build/src/lib/plist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/lib/plist/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,eAAO,MAAM,YAAY,WAAW,CAAC;AACrC,eAAO,MAAM,cAAc,OAAO,CAAC;AACnC,eAAO,MAAM,wBAAwB,qBAEpC,CAAC;AAGF,eAAO,MAAM,kBAAkB,aAAa,CAAC;AAC7C,eAAO,MAAM,mBAAmB,cAAc,CAAC;AAC/C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAG5C,eAAO,MAAM,eAAe,UAAU,CAAC;AACvC,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAG5C,eAAO,MAAM,mBAAmB,IAAI,CAAC;AACrC,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,sBAAsB,aAAc,CAAC;AAGlD,eAAO,MAAM,aAAa,SAAS,CAAC;AAGpC,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAG5C,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAGtC,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;CAevB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/lib/plist/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,eAAO,MAAM,YAAY,WAAW,CAAC;AACrC,eAAO,MAAM,cAAc,OAAO,CAAC;AACnC,eAAO,MAAM,wBAAwB,qBAEpC,CAAC;AAGF,eAAO,MAAM,kBAAkB,aAAa,CAAC;AAC7C,eAAO,MAAM,mBAAmB,cAAc,CAAC;AAC/C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAG5C,eAAO,MAAM,eAAe,UAAU,CAAC;AACvC,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAG5C,eAAO,MAAM,mBAAmB,IAAI,CAAC;AACrC,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,sBAAsB,aAAc,CAAC;AAGlD,eAAO,MAAM,aAAa,SAAS,CAAC;AAGpC,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAG5C,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAGtC,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;CAevB,CAAC;AAGF,eAAO,MAAM,oBAAoB,8EAQvB,CAAC"}

package/build/src/lib/plist/constants.js

@@ -41,3 +41,13 @@ export const BPLIST_TYPE = {
     SET: 0xc0,
     DICT: 0xd0,
 };
+// Supported file extensions for plist-related file
+export const SUPPORTED_EXTENSIONS = [
+    '.pem',
+    '.cer',
+    '.crt',
+    '.p12',
+    '.pfx',
+    '.mobileconfig',
+    '.plist',
+];

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

@@ -174,6 +174,56 @@ export interface NotificationProxyService extends BaseService {
      */
     expectNotification(timeout?: number): Promise<PlistMessage>;
 }
+/**
+ * Represents the static side of MobileConfigService
+ */
+export interface MobileConfigService extends BaseService {
+    /**
+     * Connect to the mobile config service
+     * @returns Promise resolving to the ServiceConnection instance
+     */
+    connectToMobileConfigService(): Promise<ServiceConnection>;
+    /**
+     * Get all profiles of iOS devices
+     * @returns {Promise<PlistDictionary>}
+     * e.g.
+     * {
+     *   OrderedIdentifiers: [ '2fac1c2b3d684843189b2981c718b0132854a847a' ],
+     *   ProfileManifest: {
+     *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+     *       Description: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+     *       IsActive: true
+     *     }
+     *   },
+     *   ProfileMetadata: {
+     *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+     *       PayloadDisplayName: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+     *       PayloadRemovalDisallowed: false,
+     *       PayloadUUID: 'B30005CC-BC73-4E42-8545-8DA6C44A8A71',
+     *       PayloadVersion: 1
+     *     }
+     *   },
+     *   Status: 'Acknowledged'
+     * }
+     */
+    getProfileList(): Promise<PlistDictionary>;
+    /**
+     * Install profile to iOS device
+     * @param {String} path  must be a certificate file .PEM .CER and more formats
+     * e.g: /Downloads/charles-certificate.pem
+     */
+    installProfileFromPath(path: string): Promise<void>;
+    /**
+     * Install profile to iOS device from buffer
+     * @param {Buffer} payload  must be a certificate file .PEM .CER and more formats
+     */
+    installProfileFromBuffer(payload: Buffer): Promise<void>;
+    /**
+     * Remove profile from iOS device
+     * @param {String} identifier Query identifier list through getProfileList method
+     */
+    removeProfile(identifier: string): Promise<void>;
+}
 /**
  * Represents the static side of DiagnosticsService
  */
@@ -208,6 +258,16 @@ export interface NotificationProxyServiceWithConnection {
     /** The RemoteXPC connection that can be used to close the connection */
     remoteXPC: RemoteXpcConnection;
 }
+/**
+ * Represents a MobileConfigService instance with its associated RemoteXPC connection
+ * This allows callers to properly manage the connection lifecycle
+ */
+export interface MobileConfigServiceWithConnection {
+    /** The MobileConfigService instance */
+    mobileConfigService: MobileConfigService;
+    /** The RemoteXPC connection that can be used to close the connection */
+    remoteXPC: RemoteXpcConnection;
+}
 /**
  * Options for configuring syslog capture
  */

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,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;;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,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"}

package/build/src/services/ios/mobile-config/index.d.ts

@@ -0,0 +1,65 @@
+import { type MobileConfigService as MobileConfigServiceInterface, type PlistDictionary } from '../../../lib/types.js';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+/**
+ * MobileConfigService provides an API to:
+ * - Install configuration profiles
+ * - Remove configuration profiles
+ * - List installed configuration profiles
+ */
+declare class MobileConfigService extends BaseService implements MobileConfigServiceInterface {
+    static readonly RSD_SERVICE_NAME = "com.apple.mobile.MCInstall.shim.remote";
+    private _conn;
+    constructor(address: [string, number]);
+    /**
+     * Connect to the mobile config service
+     * @returns Promise resolving to the ServiceConnection instance
+     */
+    connectToMobileConfigService(): Promise<ServiceConnection>;
+    /**
+     * Get all profiles of iOS devices
+     * @returns {Promise<PlistDictionary>}
+     * e.g.
+     * {
+     *   OrderedIdentifiers: [ '2fac1c2b3d684843189b2981c718b0132854a847a' ],
+     *   ProfileManifest: {
+     *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+     *       Description: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+     *       IsActive: true
+     *     }
+     *   },
+     *   ProfileMetadata: {
+     *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+     *       PayloadDisplayName: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+     *       PayloadRemovalDisallowed: false,
+     *       PayloadUUID: 'B30005CC-BC73-4E42-8545-8DA6C44A8A71',
+     *       PayloadVersion: 1
+     *     }
+     *   },
+     *   Status: 'Acknowledged'
+     * }
+     */
+    getProfileList(): Promise<PlistDictionary>;
+    /**
+     * Install profile from path to iOS device
+     * The phone must be unlocked before installing the profile
+     * @param {String} filePath  must be a certificate file .PEM .CER and more formats
+     * e.g: /Downloads/charles-certificate.pem
+     */
+    installProfileFromPath(filePath: string): Promise<void>;
+    /**
+     * Install profile to iOS device from buffer
+     * The phone must be unlocked before installing the profile
+     * @param {Buffer} payload  must be a certificate file buffer .PEM .CER and more formats
+     */
+    installProfileFromBuffer(payload: Buffer): Promise<void>;
+    /**
+     * Remove profile from iOS device
+     * @param {String} identifier Query identifier list through getProfileList method
+     */
+    removeProfile(identifier: string): Promise<void>;
+    private _sendPlistAndReceive;
+    private getServiceConfig;
+}
+export { MobileConfigService };
+//# sourceMappingURL=index.d.ts.map

package/build/src/services/ios/mobile-config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/services/ios/mobile-config/index.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,KAAK,mBAAmB,IAAI,4BAA4B,EACxD,KAAK,eAAe,EACrB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAKjD;;;;;GAKG;AACH,cAAM,mBACJ,SAAQ,WACR,YAAW,4BAA4B;IAEvC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,4CAA4C;IAC5E,OAAO,CAAC,KAAK,CAAkC;gBAEnC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;IAGrC;;;OAGG;IACG,4BAA4B,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAUhE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,cAAc,IAAI,OAAO,CAAC,eAAe,CAAC;IAQhD;;;;;OAKG;IACG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB7D;;;;OAIG;IACG,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc9D;;;OAGG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YA0CxC,oBAAoB;IAuBlC,OAAO,CAAC,gBAAgB;CASzB;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/build/src/services/ios/mobile-config/index.js

@@ -0,0 +1,166 @@
+import { fs, logger } from '@appium/support';
+import path from 'node:path';
+import { SUPPORTED_EXTENSIONS } from '../../../lib/plist/constants.js';
+import { createPlist, parsePlist } from '../../../lib/plist/index.js';
+import {} from '../../../lib/types.js';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+const ERROR_CLOUD_CONFIGURATION_ALREADY_PRESENT = 14002;
+const log = logger.getLogger('MobileConfigService');
+/**
+ * MobileConfigService provides an API to:
+ * - Install configuration profiles
+ * - Remove configuration profiles
+ * - List installed configuration profiles
+ */
+class MobileConfigService extends BaseService {
+    static RSD_SERVICE_NAME = 'com.apple.mobile.MCInstall.shim.remote';
+    _conn = null;
+    constructor(address) {
+        super(address);
+    }
+    /**
+     * Connect to the mobile config service
+     * @returns Promise resolving to the ServiceConnection instance
+     */
+    async connectToMobileConfigService() {
+        if (this._conn) {
+            return this._conn;
+        }
+        const service = this.getServiceConfig();
+        this._conn = await this.startLockdownService(service);
+        return this._conn;
+    }
+    /**
+     * Get all profiles of iOS devices
+     * @returns {Promise<PlistDictionary>}
+     * e.g.
+     * {
+     *   OrderedIdentifiers: [ '2fac1c2b3d684843189b2981c718b0132854a847a' ],
+     *   ProfileManifest: {
+     *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+     *       Description: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+     *       IsActive: true
+     *     }
+     *   },
+     *   ProfileMetadata: {
+     *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+     *       PayloadDisplayName: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+     *       PayloadRemovalDisallowed: false,
+     *       PayloadUUID: 'B30005CC-BC73-4E42-8545-8DA6C44A8A71',
+     *       PayloadVersion: 1
+     *     }
+     *   },
+     *   Status: 'Acknowledged'
+     * }
+     */
+    async getProfileList() {
+        const req = {
+            RequestType: 'GetProfileList',
+        };
+        return this._sendPlistAndReceive(req);
+    }
+    /**
+     * Install profile from path to iOS device
+     * The phone must be unlocked before installing the profile
+     * @param {String} filePath  must be a certificate file .PEM .CER and more formats
+     * e.g: /Downloads/charles-certificate.pem
+     */
+    async installProfileFromPath(filePath) {
+        // Check if file exists
+        try {
+            await fs.access(filePath);
+        }
+        catch (error) {
+            throw new Error(`Profile filepath does not exist: ${filePath}`);
+        }
+        const fileExtension = path.extname(filePath).toLowerCase();
+        if (!fileExtension ||
+            !SUPPORTED_EXTENSIONS.includes(fileExtension)) {
+            throw new Error(`Unsupported file format. Supported formats: ${SUPPORTED_EXTENSIONS.join(', ')}`);
+        }
+        const payload = await fs.readFile(filePath);
+        await this.installProfileFromBuffer(payload);
+    }
+    /**
+     * Install profile to iOS device from buffer
+     * The phone must be unlocked before installing the profile
+     * @param {Buffer} payload  must be a certificate file buffer .PEM .CER and more formats
+     */
+    async installProfileFromBuffer(payload) {
+        try {
+            const req = {
+                RequestType: 'InstallProfile',
+                Payload: parsePlist(payload),
+            };
+            await this._sendPlistAndReceive(req);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to install profile: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    /**
+     * Remove profile from iOS device
+     * @param {String} identifier Query identifier list through getProfileList method
+     */
+    async removeProfile(identifier) {
+        const profileList = await this.getProfileList();
+        if (!profileList?.ProfileMetadata) {
+            return;
+        }
+        const profileMetadata = profileList.ProfileMetadata;
+        if (!(identifier in profileMetadata)) {
+            // Get available identifiers from OrderedIdentifiers array or ProfileMetadata keys
+            let availableIdentifiers;
+            if (profileList.OrderedIdentifiers &&
+                Array.isArray(profileList.OrderedIdentifiers)) {
+                availableIdentifiers = profileList.OrderedIdentifiers;
+            }
+            else {
+                availableIdentifiers = Object.keys(profileMetadata);
+            }
+            throw new Error(`Trying to remove not installed profile: ${identifier}. Expected one of: ${availableIdentifiers.join(', ')}`);
+        }
+        const meta = profileMetadata[identifier];
+        const payloadData = {
+            PayloadIdentifier: identifier,
+            PayloadType: 'Configuration',
+            PayloadUUID: meta.PayloadUUID,
+            PayloadVersion: meta.PayloadVersion,
+        };
+        const req = {
+            RequestType: 'RemoveProfile',
+            ProfileIdentifier: createPlist(payloadData),
+        };
+        log.info(req);
+        await this._sendPlistAndReceive(req);
+    }
+    async _sendPlistAndReceive(req) {
+        if (!this._conn) {
+            this._conn = await this.connectToMobileConfigService();
+        }
+        // Ignore first response as it is just status check
+        await this._conn.sendAndReceive(req);
+        const res = await this._conn.sendAndReceive(req);
+        if (res.Status !== 'Acknowledged') {
+            const errorCode = res.ErrorChain?.[0]?.ErrorCode;
+            if (Number.isInteger(errorCode)) {
+                if (errorCode === ERROR_CLOUD_CONFIGURATION_ALREADY_PRESENT) {
+                    throw new Error('A cloud configuration is already present on device. You must first erase the device to install a new configuration.');
+                }
+            }
+            throw new Error(`Invalid response: ${JSON.stringify(res)}`);
+        }
+        return res;
+    }
+    getServiceConfig() {
+        return {
+            serviceName: MobileConfigService.RSD_SERVICE_NAME,
+            port: this.address[1].toString(),
+        };
+    }
+}
+export { MobileConfigService };

package/build/src/services.d.ts

@@ -1,7 +1,8 @@
 import { RemoteXpcConnection } from './lib/remote-xpc/remote-xpc-connection.js';
-import type { DiagnosticsServiceWithConnection, MobileImageMounterServiceWithConnection, NotificationProxyServiceWithConnection, SyslogService as SyslogServiceType } from './lib/types.js';
+import type { DiagnosticsServiceWithConnection, MobileConfigServiceWithConnection, MobileImageMounterServiceWithConnection, NotificationProxyServiceWithConnection, 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 startSyslogService(udid: string): Promise<SyslogServiceType>;
 export declare function createRemoteXPCConnection(udid: string): Promise<{

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,uCAAuC,EACvC,sCAAsC,EACtC,aAAa,IAAI,iBAAiB,EACnC,MAAM,gBAAgB,CAAC;AASxB,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,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,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"}

package/build/src/services.js

@@ -3,6 +3,7 @@ import { RemoteXpcConnection } from './lib/remote-xpc/remote-xpc-connection.js';
 import { TunnelManager } from './lib/tunnel/index.js';
 import { TunnelApiClient } from './lib/tunnel/tunnel-api-client.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 SyslogService from './services/ios/syslog-service/index.js';
@@ -30,6 +31,17 @@ export async function startNotificationProxyService(udid) {
         ]),
     };
 }
+export async function startMobileConfigService(udid) {
+    const { remoteXPC, tunnelConnection } = await createRemoteXPCConnection(udid);
+    const mobileConfigService = remoteXPC.findService(MobileConfigService.RSD_SERVICE_NAME);
+    return {
+        remoteXPC: remoteXPC,
+        mobileConfigService: new MobileConfigService([
+            tunnelConnection.host,
+            parseInt(mobileConfigService.port, 10),
+        ]),
+    };
+}
 export async function startMobileImageMounterService(udid) {
     const { remoteXPC, tunnelConnection } = await createRemoteXPCConnection(udid);
     const mobileImageMounterService = remoteXPC.findService(MobileImageMounterService.RSD_SERVICE_NAME);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-ios-remotexpc",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "type": "module",

package/src/lib/plist/constants.ts

@@ -51,3 +51,14 @@ export const BPLIST_TYPE = {
   SET: 0xc0,
   DICT: 0xd0,
 };
+
+// Supported file extensions for plist-related file
+export const SUPPORTED_EXTENSIONS = [
+  '.pem',
+  '.cer',
+  '.crt',
+  '.p12',
+  '.pfx',
+  '.mobileconfig',
+  '.plist',
+] as const;

package/src/lib/types.ts

@@ -212,6 +212,57 @@ export interface NotificationProxyService extends BaseService {
   expectNotification(timeout?: number): Promise<PlistMessage>;
 }
 
+/**
+ * Represents the static side of MobileConfigService
+ */
+export interface MobileConfigService extends BaseService {
+  /**
+   * Connect to the mobile config service
+   * @returns Promise resolving to the ServiceConnection instance
+   */
+  connectToMobileConfigService(): Promise<ServiceConnection>;
+  /**
+   * Get all profiles of iOS devices
+   * @returns {Promise<PlistDictionary>}
+   * e.g.
+   * {
+   *   OrderedIdentifiers: [ '2fac1c2b3d684843189b2981c718b0132854a847a' ],
+   *   ProfileManifest: {
+   *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+   *       Description: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+   *       IsActive: true
+   *     }
+   *   },
+   *   ProfileMetadata: {
+   *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+   *       PayloadDisplayName: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+   *       PayloadRemovalDisallowed: false,
+   *       PayloadUUID: 'B30005CC-BC73-4E42-8545-8DA6C44A8A71',
+   *       PayloadVersion: 1
+   *     }
+   *   },
+   *   Status: 'Acknowledged'
+   * }
+   */
+  getProfileList(): Promise<PlistDictionary>;
+  /**
+   * Install profile to iOS device
+   * @param {String} path  must be a certificate file .PEM .CER and more formats
+   * e.g: /Downloads/charles-certificate.pem
+   */
+  installProfileFromPath(path: string): Promise<void>;
+  /**
+   * Install profile to iOS device from buffer
+   * @param {Buffer} payload  must be a certificate file .PEM .CER and more formats
+   */
+  installProfileFromBuffer(payload: Buffer): Promise<void>;
+  /**
+   * Remove profile from iOS device
+   * @param {String} identifier Query identifier list through getProfileList method
+   */
+  removeProfile(identifier: string): Promise<void>;
+}
+
 /**
  * Represents the static side of DiagnosticsService
  */
@@ -249,6 +300,17 @@ export interface NotificationProxyServiceWithConnection {
   remoteXPC: RemoteXpcConnection;
 }
 
+/**
+ * Represents a MobileConfigService instance with its associated RemoteXPC connection
+ * This allows callers to properly manage the connection lifecycle
+ */
+export interface MobileConfigServiceWithConnection {
+  /** The MobileConfigService instance */
+  mobileConfigService: MobileConfigService;
+  /** The RemoteXPC connection that can be used to close the connection */
+  remoteXPC: RemoteXpcConnection;
+}
+
 /**
  * Options for configuring syslog capture
  */

package/src/services/ios/mobile-config/index.ts

@@ -0,0 +1,204 @@
+import { fs, logger } from '@appium/support';
+import path from 'node:path';
+
+import { SUPPORTED_EXTENSIONS } from '../../../lib/plist/constants.js';
+import { createPlist, parsePlist } from '../../../lib/plist/index.js';
+import {
+  type MobileConfigService as MobileConfigServiceInterface,
+  type PlistDictionary,
+} from '../../../lib/types.js';
+import { ServiceConnection } from '../../../service-connection.js';
+import { BaseService } from '../base-service.js';
+
+const ERROR_CLOUD_CONFIGURATION_ALREADY_PRESENT = 14002;
+const log = logger.getLogger('MobileConfigService');
+
+/**
+ * MobileConfigService provides an API to:
+ * - Install configuration profiles
+ * - Remove configuration profiles
+ * - List installed configuration profiles
+ */
+class MobileConfigService
+  extends BaseService
+  implements MobileConfigServiceInterface
+{
+  static readonly RSD_SERVICE_NAME = 'com.apple.mobile.MCInstall.shim.remote';
+  private _conn: ServiceConnection | null = null;
+
+  constructor(address: [string, number]) {
+    super(address);
+  }
+  /**
+   * Connect to the mobile config service
+   * @returns Promise resolving to the ServiceConnection instance
+   */
+  async connectToMobileConfigService(): Promise<ServiceConnection> {
+    if (this._conn) {
+      return this._conn;
+    }
+
+    const service = this.getServiceConfig();
+    this._conn = await this.startLockdownService(service);
+    return this._conn;
+  }
+
+  /**
+   * Get all profiles of iOS devices
+   * @returns {Promise<PlistDictionary>}
+   * e.g.
+   * {
+   *   OrderedIdentifiers: [ '2fac1c2b3d684843189b2981c718b0132854a847a' ],
+   *   ProfileManifest: {
+   *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+   *       Description: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+   *       IsActive: true
+   *     }
+   *   },
+   *   ProfileMetadata: {
+   *     '2fac1c2b3d684843189b2981c718b0132854a847a': {
+   *       PayloadDisplayName: 'Charles Proxy CA (7 Dec 2020, MacBook-Pro.local)',
+   *       PayloadRemovalDisallowed: false,
+   *       PayloadUUID: 'B30005CC-BC73-4E42-8545-8DA6C44A8A71',
+   *       PayloadVersion: 1
+   *     }
+   *   },
+   *   Status: 'Acknowledged'
+   * }
+   */
+  async getProfileList(): Promise<PlistDictionary> {
+    const req = {
+      RequestType: 'GetProfileList',
+    };
+
+    return this._sendPlistAndReceive(req);
+  }
+
+  /**
+   * Install profile from path to iOS device
+   * The phone must be unlocked before installing the profile
+   * @param {String} filePath  must be a certificate file .PEM .CER and more formats
+   * e.g: /Downloads/charles-certificate.pem
+   */
+  async installProfileFromPath(filePath: string): Promise<void> {
+    // Check if file exists
+    try {
+      await fs.access(filePath);
+    } catch (error) {
+      throw new Error(`Profile filepath does not exist: ${filePath}`);
+    }
+
+    const fileExtension = path.extname(filePath).toLowerCase();
+    if (
+      !fileExtension ||
+      !SUPPORTED_EXTENSIONS.includes(fileExtension as any)
+    ) {
+      throw new Error(
+        `Unsupported file format. Supported formats: ${SUPPORTED_EXTENSIONS.join(', ')}`,
+      );
+    }
+
+    const payload = await fs.readFile(filePath);
+    await this.installProfileFromBuffer(payload);
+  }
+
+  /**
+   * Install profile to iOS device from buffer
+   * The phone must be unlocked before installing the profile
+   * @param {Buffer} payload  must be a certificate file buffer .PEM .CER and more formats
+   */
+  async installProfileFromBuffer(payload: Buffer): Promise<void> {
+    try {
+      const req = {
+        RequestType: 'InstallProfile',
+        Payload: parsePlist(payload),
+      };
+      await this._sendPlistAndReceive(req);
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(`Failed to install profile: ${error.message}`);
+      }
+      throw error;
+    }
+  }
+  /**
+   * Remove profile from iOS device
+   * @param {String} identifier Query identifier list through getProfileList method
+   */
+  async removeProfile(identifier: string): Promise<void> {
+    const profileList = await this.getProfileList();
+    if (!profileList?.ProfileMetadata) {
+      return;
+    }
+
+    const profileMetadata = profileList.ProfileMetadata as Record<string, any>;
+    if (!(identifier in profileMetadata)) {
+      // Get available identifiers from OrderedIdentifiers array or ProfileMetadata keys
+      let availableIdentifiers: string[];
+      if (
+        profileList.OrderedIdentifiers &&
+        Array.isArray(profileList.OrderedIdentifiers)
+      ) {
+        availableIdentifiers = profileList.OrderedIdentifiers as string[];
+      } else {
+        availableIdentifiers = Object.keys(profileMetadata);
+      }
+
+      throw new Error(
+        `Trying to remove not installed profile: ${identifier}. Expected one of: ${availableIdentifiers.join(', ')}`,
+      );
+    }
+
+    const meta = profileMetadata[identifier];
+    const payloadData = {
+      PayloadIdentifier: identifier,
+      PayloadType: 'Configuration',
+      PayloadUUID: meta.PayloadUUID,
+      PayloadVersion: meta.PayloadVersion,
+    };
+
+    const req = {
+      RequestType: 'RemoveProfile',
+      ProfileIdentifier: createPlist(payloadData),
+    };
+
+    log.info(req);
+
+    await this._sendPlistAndReceive(req);
+  }
+
+  private async _sendPlistAndReceive(
+    req: PlistDictionary,
+  ): Promise<PlistDictionary> {
+    if (!this._conn) {
+      this._conn = await this.connectToMobileConfigService();
+    }
+    // Ignore first response as it is just status check
+    await this._conn.sendAndReceive(req);
+    const res = await this._conn.sendAndReceive(req);
+    if (res.Status !== 'Acknowledged') {
+      const errorCode = (res.ErrorChain as any[])?.[0]?.ErrorCode;
+      if (Number.isInteger(errorCode)) {
+        if (errorCode === ERROR_CLOUD_CONFIGURATION_ALREADY_PRESENT) {
+          throw new Error(
+            'A cloud configuration is already present on device. You must first erase the device to install a new configuration.',
+          );
+        }
+      }
+      throw new Error(`Invalid response: ${JSON.stringify(res)}`);
+    }
+    return res;
+  }
+
+  private getServiceConfig(): {
+    serviceName: string;
+    port: string;
+  } {
+    return {
+      serviceName: MobileConfigService.RSD_SERVICE_NAME,
+      port: this.address[1].toString(),
+    };
+  }
+}
+
+export { MobileConfigService };

package/src/services.ts

@@ -5,11 +5,13 @@ import { TunnelManager } from './lib/tunnel/index.js';
 import { TunnelApiClient } from './lib/tunnel/tunnel-api-client.js';
 import type {
   DiagnosticsServiceWithConnection,
+  MobileConfigServiceWithConnection,
   MobileImageMounterServiceWithConnection,
   NotificationProxyServiceWithConnection,
   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 SyslogService from './services/ios/syslog-service/index.js';
@@ -49,6 +51,21 @@ export async function startNotificationProxyService(
   };
 }
 
+export async function startMobileConfigService(
+  udid: string,
+): Promise<MobileConfigServiceWithConnection> {
+  const { remoteXPC, tunnelConnection } = await createRemoteXPCConnection(udid);
+  const mobileConfigService = remoteXPC.findService(
+    MobileConfigService.RSD_SERVICE_NAME,
+  );
+  return {
+    remoteXPC: remoteXPC as RemoteXpcConnection,
+    mobileConfigService: new MobileConfigService([
+      tunnelConnection.host,
+      parseInt(mobileConfigService.port, 10),
+    ]),
+  };
+}
 export async function startMobileImageMounterService(
   udid: string,
 ): Promise<MobileImageMounterServiceWithConnection> {