appium-ios-remotexpc 0.3.2 → 0.3.3

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.3.3](https://github.com/appium/appium-ios-remotexpc/compare/v0.3.2...v0.3.3) (2025-09-05)
+
+### Bug Fixes
+
+* correct UTF-16BE string parsing and TempObject handling in binary plist parser ([#65](https://github.com/appium/appium-ios-remotexpc/issues/65)) ([e64933a](https://github.com/appium/appium-ios-remotexpc/commit/e64933a5126ea796b12fcd001d12cab93a3bb9f8))
+
+### Miscellaneous Chores
+
+* **deps:** bump actions/checkout from 4 to 5 ([#64](https://github.com/appium/appium-ios-remotexpc/issues/64)) ([2fc7af0](https://github.com/appium/appium-ios-remotexpc/commit/2fc7af0c29f774f4dc37339c0825b109d410b815))
+
 ## [0.3.2](https://github.com/appium/appium-ios-remotexpc/compare/v0.3.1...v0.3.2) (2025-08-31)
 
 ### Miscellaneous Chores

package/build/src/lib/plist/binary-plist-creator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"binary-plist-creator.d.ts","sourceRoot":"","sources":["../../../../src/lib/plist/binary-plist-creator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAmB,UAAU,EAAE,MAAM,aAAa,CAAC;AA4iB/D;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAGzD"}
+{"version":3,"file":"binary-plist-creator.d.ts","sourceRoot":"","sources":["../../../../src/lib/plist/binary-plist-creator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAmB,UAAU,EAAE,MAAM,aAAa,CAAC;AA2jB/D;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAGzD"}

package/build/src/lib/plist/binary-plist-creator.js

@@ -39,7 +39,9 @@ class BinaryPlistCreator {
         const objectOffsets = [];
         const objectData = [];
         for (const value of this._objectTable) {
-            objectOffsets.push(this._calculateObjectDataLength(objectData));
+            // Calculate offset including the header length
+            objectOffsets.push(BPLIST_MAGIC_AND_VERSION.length +
+                this._calculateObjectDataLength(objectData));
             objectData.push(this._createObjectData(value));
         }
         // Calculate offset table size
@@ -291,10 +293,20 @@ class BinaryPlistCreator {
         // Check if string can be ASCII
         // eslint-disable-next-line no-control-regex
         const isAscii = /^[\x00-\x7F]*$/.test(value);
-        const stringBuffer = isAscii
-            ? Buffer.from(value, 'ascii')
-            : Buffer.from(value, 'utf16le');
-        // Fixed the typo here - using stringBuffer.length instead of value.length for Unicode strings
+        let stringBuffer;
+        if (isAscii) {
+            stringBuffer = Buffer.from(value, 'ascii');
+        }
+        else {
+            // Unicode strings should be stored as UTF-16BE in binary plists
+            const utf16leBuffer = Buffer.from(value, 'utf16le');
+            stringBuffer = Buffer.alloc(utf16leBuffer.length);
+            // Convert UTF-16LE to UTF-16BE
+            for (let i = 0; i < utf16leBuffer.length; i += 2) {
+                stringBuffer[i] = utf16leBuffer[i + 1]; // High byte
+                stringBuffer[i + 1] = utf16leBuffer[i]; // Low byte
+            }
+        }
         const length = isAscii ? value.length : stringBuffer.length / 2;
         let header;
         if (length < 15) {

package/build/src/lib/plist/binary-plist-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"binary-plist-parser.d.ts","sourceRoot":"","sources":["../../../../src/lib/plist/binary-plist-parser.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAA+B,UAAU,EAAE,MAAM,aAAa,CAAC;AA+iB3E;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAG3D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAIrD"}
+{"version":3,"file":"binary-plist-parser.d.ts","sourceRoot":"","sources":["../../../../src/lib/plist/binary-plist-parser.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAA+B,UAAU,EAAE,MAAM,aAAa,CAAC;AAyjB3E;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAG3D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAIrD"}

package/build/src/lib/plist/binary-plist-parser.js

@@ -200,12 +200,16 @@ class BinaryPlistParser {
      * @returns The parsed string
      */
     _parseUnicodeString(startOffset, objLength) {
-        // Unicode strings are stored as UTF-16BE
-        const utf16Buffer = Buffer.alloc(objLength * 2);
-        for (let j = 0; j < objLength; j++) {
-            utf16Buffer.writeUInt16BE(this._buffer.readUInt16BE(startOffset + j * 2), j * 2);
+        // Unicode strings are stored as UTF-16BE in binary plists
+        const bytesToRead = objLength * 2;
+        const stringBuffer = this._buffer.slice(startOffset, startOffset + bytesToRead);
+        // Convert UTF-16BE to UTF-16LE for proper decoding
+        const utf16leBuffer = Buffer.alloc(bytesToRead);
+        for (let i = 0; i < bytesToRead; i += 2) {
+            utf16leBuffer[i] = stringBuffer[i + 1]; // Low byte
+            utf16leBuffer[i + 1] = stringBuffer[i]; // High byte
         }
-        return utf16Buffer.toString('utf16le', 0, objLength * 2);
+        return utf16leBuffer.toString('utf16le');
     }
     /**
      * Parses a UID value from the buffer
@@ -358,8 +362,11 @@ class BinaryPlistParser {
         for (let j = 0; j < obj.objLength; j++) {
             const refIdx = this._readObjectRef(obj.startOffset + j * this._objectRefSize);
             const refValue = this._objectTable[refIdx];
-            // Ensure we're not adding a TempObject to the array
-            if (!this._isTempObject(refValue)) {
+            // Handle TempObjects correctly - they should be resolved by the time we get here
+            if (this._isTempObject(refValue)) {
+                array.push(refValue.value);
+            }
+            else {
                 array.push(refValue);
             }
         }
@@ -382,8 +389,11 @@ class BinaryPlistParser {
             if (typeof key !== 'string') {
                 throw new TypeError(`Dictionary key must be a string, got ${typeof key}`);
             }
-            // Ensure we're not adding a TempObject to the dictionary
-            if (!this._isTempObject(value)) {
+            // Handle TempObjects correctly - they should be resolved by the time we get here
+            if (this._isTempObject(value)) {
+                dict[key] = value.value;
+            }
+            else {
                 dict[key] = value;
             }
         }

package/package.json

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

package/src/lib/plist/binary-plist-creator.ts

@@ -59,7 +59,11 @@ class BinaryPlistCreator {
     const objectData: Buffer[] = [];
 
     for (const value of this._objectTable) {
-      objectOffsets.push(this._calculateObjectDataLength(objectData));
+      // Calculate offset including the header length
+      objectOffsets.push(
+        BPLIST_MAGIC_AND_VERSION.length +
+          this._calculateObjectDataLength(objectData),
+      );
       objectData.push(this._createObjectData(value));
     }
 
@@ -341,11 +345,22 @@ class BinaryPlistCreator {
     // Check if string can be ASCII
     // eslint-disable-next-line no-control-regex
     const isAscii = /^[\x00-\x7F]*$/.test(value);
-    const stringBuffer = isAscii
-      ? Buffer.from(value, 'ascii')
-      : Buffer.from(value, 'utf16le');
 
-    // Fixed the typo here - using stringBuffer.length instead of value.length for Unicode strings
+    let stringBuffer: Buffer;
+    if (isAscii) {
+      stringBuffer = Buffer.from(value, 'ascii');
+    } else {
+      // Unicode strings should be stored as UTF-16BE in binary plists
+      const utf16leBuffer = Buffer.from(value, 'utf16le');
+      stringBuffer = Buffer.alloc(utf16leBuffer.length);
+
+      // Convert UTF-16LE to UTF-16BE
+      for (let i = 0; i < utf16leBuffer.length; i += 2) {
+        stringBuffer[i] = utf16leBuffer[i + 1]; // High byte
+        stringBuffer[i + 1] = utf16leBuffer[i]; // Low byte
+      }
+    }
+
     const length = isAscii ? value.length : stringBuffer.length / 2;
     let header: Buffer;
 

package/src/lib/plist/binary-plist-parser.ts

@@ -270,15 +270,21 @@ class BinaryPlistParser {
    * @returns The parsed string
    */
   private _parseUnicodeString(startOffset: number, objLength: number): string {
-    // Unicode strings are stored as UTF-16BE
-    const utf16Buffer = Buffer.alloc(objLength * 2);
-    for (let j = 0; j < objLength; j++) {
-      utf16Buffer.writeUInt16BE(
-        this._buffer.readUInt16BE(startOffset + j * 2),
-        j * 2,
-      );
+    // Unicode strings are stored as UTF-16BE in binary plists
+    const bytesToRead = objLength * 2;
+    const stringBuffer = this._buffer.slice(
+      startOffset,
+      startOffset + bytesToRead,
+    );
+
+    // Convert UTF-16BE to UTF-16LE for proper decoding
+    const utf16leBuffer = Buffer.alloc(bytesToRead);
+    for (let i = 0; i < bytesToRead; i += 2) {
+      utf16leBuffer[i] = stringBuffer[i + 1]; // Low byte
+      utf16leBuffer[i + 1] = stringBuffer[i]; // High byte
     }
-    return utf16Buffer.toString('utf16le', 0, objLength * 2);
+
+    return utf16leBuffer.toString('utf16le');
   }
 
   /**
@@ -476,8 +482,10 @@ class BinaryPlistParser {
         obj.startOffset + j * this._objectRefSize,
       );
       const refValue = this._objectTable[refIdx];
-      // Ensure we're not adding a TempObject to the array
-      if (!this._isTempObject(refValue)) {
+      // Handle TempObjects correctly - they should be resolved by the time we get here
+      if (this._isTempObject(refValue)) {
+        array.push(refValue.value);
+      } else {
         array.push(refValue);
       }
     }
@@ -511,8 +519,10 @@ class BinaryPlistParser {
         );
       }
 
-      // Ensure we're not adding a TempObject to the dictionary
-      if (!this._isTempObject(value)) {
+      // Handle TempObjects correctly - they should be resolved by the time we get here
+      if (this._isTempObject(value)) {
+        dict[key] = value.value;
+      } else {
         dict[key] = value;
       }
     }