appium-ios-remotexpc 0.13.1 → 0.14.0

package/build/src/services/ios/dvt/dtx-message.js

@@ -0,0 +1,113 @@
+/**
+ * DTX Protocol constants
+ */
+export const DTX_CONSTANTS = {
+    MESSAGE_HEADER_MAGIC: 0x1f3d5b79,
+    MESSAGE_HEADER_SIZE: 32,
+    PAYLOAD_HEADER_SIZE: 16,
+    MESSAGE_AUX_MAGIC: 0x1f0,
+    EMPTY_DICTIONARY: 0xa,
+    // Message types
+    INSTRUMENTS_MESSAGE_TYPE: 2,
+    EXPECTS_REPLY_MASK: 0x1000,
+    // Auxiliary value types
+    AUX_TYPE_OBJECT: 2,
+    AUX_TYPE_INT32: 3,
+    AUX_TYPE_INT64: 6,
+};
+/**
+ * DTX Message utilities for encoding and decoding protocol messages
+ */
+export class DTXMessage {
+    /**
+     * Parse DTX message header from buffer
+     */
+    static parseMessageHeader(buffer) {
+        if (buffer.length < DTX_CONSTANTS.MESSAGE_HEADER_SIZE) {
+            throw new Error('Buffer too small for DTX message header');
+        }
+        return {
+            magic: buffer.readUInt32LE(0),
+            cb: buffer.readUInt32LE(4),
+            fragmentId: buffer.readUInt16LE(8),
+            fragmentCount: buffer.readUInt16LE(10),
+            length: buffer.readUInt32LE(12),
+            identifier: buffer.readUInt32LE(16),
+            conversationIndex: buffer.readUInt32LE(20),
+            channelCode: buffer.readInt32LE(24),
+            expectsReply: buffer.readUInt32LE(28),
+        };
+    }
+    /**
+     * Build DTX message header buffer
+     */
+    static buildMessageHeader(header) {
+        const buffer = Buffer.alloc(DTX_CONSTANTS.MESSAGE_HEADER_SIZE);
+        buffer.writeUInt32LE(header.magic, 0);
+        buffer.writeUInt32LE(header.cb, 4);
+        buffer.writeUInt16LE(header.fragmentId, 8);
+        buffer.writeUInt16LE(header.fragmentCount, 10);
+        buffer.writeUInt32LE(header.length, 12);
+        buffer.writeUInt32LE(header.identifier, 16);
+        buffer.writeUInt32LE(header.conversationIndex, 20);
+        buffer.writeInt32LE(header.channelCode, 24);
+        buffer.writeUInt32LE(header.expectsReply, 28);
+        return buffer;
+    }
+    /**
+     * Parse DTX payload header from buffer
+     */
+    static parsePayloadHeader(buffer) {
+        if (buffer.length < DTX_CONSTANTS.PAYLOAD_HEADER_SIZE) {
+            throw new Error('Buffer too small for DTX payload header');
+        }
+        return {
+            flags: buffer.readUInt32LE(0),
+            auxiliaryLength: buffer.readUInt32LE(4),
+            totalLength: buffer.readBigUInt64LE(8),
+        };
+    }
+    /**
+     * Build DTX payload header buffer
+     */
+    static buildPayloadHeader(header) {
+        const buffer = Buffer.alloc(DTX_CONSTANTS.PAYLOAD_HEADER_SIZE);
+        buffer.writeUInt32LE(header.flags, 0);
+        buffer.writeUInt32LE(header.auxiliaryLength, 4);
+        buffer.writeBigUInt64LE(header.totalLength, 8);
+        return buffer;
+    }
+}
+/**
+ * Message auxiliary builder for DTX protocol parameters
+ */
+export class MessageAux {
+    values = [];
+    /**
+     * Append a 32-bit integer
+     */
+    appendInt(value) {
+        this.values.push({ type: DTX_CONSTANTS.AUX_TYPE_INT32, value });
+        return this;
+    }
+    /**
+     * Append a 64-bit integer (bigint)
+     */
+    appendLong(value) {
+        this.values.push({ type: DTX_CONSTANTS.AUX_TYPE_INT64, value });
+        return this;
+    }
+    /**
+     * Append an object (will be archived as NSKeyedArchiver plist)
+     */
+    appendObj(value) {
+        this.values.push({ type: DTX_CONSTANTS.AUX_TYPE_OBJECT, value });
+        return this;
+    }
+    /**
+     * Get raw values for encoding
+     */
+    getValues() {
+        return this.values;
+    }
+}

package/build/src/services/ios/dvt/index.d.ts

@@ -0,0 +1,119 @@
+import type { PlistDictionary } from '../../../lib/types.js';
+import { BaseService } from '../base-service.js';
+import { ChannelFragmenter } from './channel-fragmenter.js';
+import { Channel } from './channel.js';
+import { DTXMessage, DTX_CONSTANTS, MessageAux } from './dtx-message.js';
+/**
+ * DVTSecureSocketProxyService provides access to Apple's DTServiceHub functionality
+ * This service enables various instruments and debugging capabilities through the DTX protocol
+ */
+export declare class DVTSecureSocketProxyService extends BaseService {
+    static readonly RSD_SERVICE_NAME = "com.apple.instruments.dtservicehub";
+    static readonly BROADCAST_CHANNEL = 0;
+    private connection;
+    private socket;
+    private supportedIdentifiers;
+    private lastChannelCode;
+    private curMessageId;
+    private readonly channelCache;
+    private readonly channelMessages;
+    private isHandshakeComplete;
+    private readBuffer;
+    constructor(address: [string, number]);
+    /**
+     * Connect to the DVT service and perform handshake
+     */
+    connect(): Promise<void>;
+    /**
+     * Get supported service identifiers (capabilities)
+     */
+    getSupportedIdentifiers(): PlistDictionary;
+    /**
+     * Create a communication channel for a specific service identifier
+     * @param identifier The service identifier (e.g., 'com.apple.instruments.server.services.LocationSimulation')
+     * @returns The created channel instance
+     */
+    makeChannel(identifier: string): Promise<Channel>;
+    /**
+     * Send a DTX message on a channel
+     * @param channel The channel code
+     * @param selector The ObjectiveC method selector
+     * @param args Optional message arguments
+     * @param expectsReply Whether a reply is expected
+     */
+    sendMessage(channel: number, selector?: string | null, args?: MessageAux | null, expectsReply?: boolean): Promise<void>;
+    /**
+     * Receive a plist message from a channel
+     * @param channel The channel to receive from
+     * @returns Tuple of [decoded data, auxiliary values]
+     */
+    recvPlist(channel?: number): Promise<[any, any[]]>;
+    /**
+     * Receive a raw message from a channel
+     * @param channel The channel to receive from
+     * @returns Tuple of [raw data, auxiliary values]
+     */
+    recvMessage(channel?: number): Promise<[Buffer | null, any[]]>;
+    /**
+     * Close the DVT service connection
+     */
+    close(): Promise<void>;
+    /**
+     * Perform DTX protocol handshake to establish connection and retrieve capabilities
+     */
+    private performHandshake;
+    private extractSelectorFromResponse;
+    private extractCapabilitiesFromAuxData;
+    /**
+     * Drain any buffered messages that arrived during handshake
+     */
+    private drainBufferedMessages;
+    /**
+     * Receive packet fragments until a complete message is available for the specified channel
+     */
+    private recvPacketFragments;
+    /**
+     * Read exact number of bytes from socket with buffering
+     */
+    private readExact;
+    /**
+     * Check if response contains an NSError and throw if present
+     */
+    private checkForNSError;
+    /**
+     * Archive a value using NSKeyedArchiver format for DTX protocol
+     */
+    private archiveValue;
+    /**
+     * Archive a selector string for DTX messages
+     */
+    private archiveSelector;
+    /**
+     * Build auxiliary data buffer with NSKeyedArchiver encoding for objects
+     */
+    private buildAuxiliaryData;
+    /**
+     * Parse auxiliary data from buffer
+     *
+     * The auxiliary data format can be:
+     * 1. Standard format: [magic:8][size:8][items...]
+     * 2. NSKeyedArchiver bplist format (for handshake responses)
+     */
+    private parseAuxiliaryData;
+    /**
+     * Parse auxiliary data in NSKeyedArchiver bplist format
+     */
+    private parseAuxiliaryAsBplist;
+    /**
+     * Parse auxiliary data in standard DTX format
+     */
+    private parseAuxiliaryStandard;
+    /**
+     * Parse a single auxiliary value
+     */
+    private parseAuxiliaryValue;
+}
+export { Channel, ChannelFragmenter, DTXMessage, MessageAux, DTX_CONSTANTS };
+export { decodeNSKeyedArchiver, NSKeyedArchiverDecoder, } from './nskeyedarchiver-decoder.js';
+export type { DTXMessageHeader, DTXMessagePayloadHeader, MessageAuxValue, } from './dtx-message.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/services/ios/dvt/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAgB,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAczE;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,WAAW;IAC1D,MAAM,CAAC,QAAQ,CAAC,gBAAgB,wCAAwC;IACxE,MAAM,CAAC,QAAQ,CAAC,iBAAiB,KAAK;IAEtC,OAAO,CAAC,UAAU,CAAkC;IACpD,OAAO,CAAC,MAAM,CAA2B;IACzC,OAAO,CAAC,oBAAoB,CAAuB;IACnD,OAAO,CAAC,eAAe,CAAa;IACpC,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmC;IAChE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA6C;IAC7E,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,UAAU,CAA2B;gBAEjC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;IAQrC;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB9B;;OAEG;IACH,uBAAuB,IAAI,eAAe;IAI1C;;;;OAIG;IACG,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BvD;;;;;;OAMG;IACG,WAAW,CACf,OAAO,EAAE,MAAM,EACf,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,IAAI,GAAE,UAAU,GAAG,IAAW,EAC9B,YAAY,GAAE,OAAc,GAC3B,OAAO,CAAC,IAAI,CAAC;IAwDhB;;;;OAIG;IACG,SAAS,CACb,OAAO,GAAE,MAAsD,GAC9D,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAiBxB;;;;OAIG;IACG,WAAW,CACf,OAAO,GAAE,MAAsD,GAC9D,OAAO,CAAC,CAAC,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;IAgClC;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAwC5B;;OAEG;YACW,gBAAgB;IAiC9B,OAAO,CAAC,2BAA2B;IAYnC,OAAO,CAAC,8BAA8B;IAiBtC;;OAEG;YACW,qBAAqB;IA6BnC;;OAEG;YACW,mBAAmB;IA4CjC;;OAEG;YACW,SAAS;IAoCvB;;OAEG;IACH,OAAO,CAAC,eAAe;IA2BvB;;OAEG;IACH,OAAO,CAAC,YAAY;IAWpB;;OAEG;IACH,OAAO,CAAC,eAAe;IAIvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA4D1B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAkB9B;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAkC9B;;OAEG;IACH,OAAO,CAAC,mBAAmB;CAwC5B;AAED,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC;AAC7E,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,GAChB,MAAM,kBAAkB,CAAC"}