appium-ios-device
Version:
Appium API for dealing with iOS devices
113 lines • 4.56 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.LOCKDOWN_PORT = exports.Lockdown = void 0;
const lodash_1 = __importDefault(require("lodash"));
const base_service_1 = require("../base-service");
const LOCKDOWN_PORT = 62078;
exports.LOCKDOWN_PORT = LOCKDOWN_PORT;
const LABEL = 'usbmuxd';
const PROTOCOL_VERSION = 2;
class Lockdown extends base_service_1.BaseServicePlist {
/**
* Makes a query type request to lockdown
* @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
* @returns {Promise<any>}
*/
async queryType(timeout = 5000) {
const data = await this._plistService.sendPlistAndReceive({
Label: LABEL,
ProtocolVersion: PROTOCOL_VERSION,
Request: 'QueryType'
}, timeout);
if (data.Request === 'QueryType' && data.Type === 'com.apple.mobile.lockdown') {
return data;
}
else {
throw new Error(`Unexpected data: ${JSON.stringify(data)}`);
}
}
/**
* Starts a lockdown session which allows to use certain apis
* @param {string} hostID the host id which can be retrieved from the pair record
* @param {string} systemBUID the host BUID which can be retrieved from the pair record
* @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
* @returns {Promise<any>}
*/
async startSession(hostID, systemBUID, timeout = 5000) {
const data = await this._plistService.sendPlistAndReceive({
Label: LABEL,
ProtocolVersion: PROTOCOL_VERSION,
Request: 'StartSession',
HostID: hostID,
SystemBUID: systemBUID
}, timeout);
if (data.Request === 'StartSession' && data.SessionID) {
return { sessionID: data.SessionID, enableSessionSSL: data.EnableSessionSSL };
}
else {
throw new Error(`Unexpected data: ${JSON.stringify(data)}`);
}
}
/**
* Enables ssl in the underlying socket socket connection
* @param {Buffer} hostPrivateKey the private key which can be retrieved from the pair record
* @param {Buffer} hostCertificate the certificate which can be retrieved from the pair record
*/
enableSessionSSL(hostPrivateKey, hostCertificate) {
this._plistService.enableSessionSSL(hostPrivateKey, hostCertificate);
}
/**
* @typedef {Object} Query
*
* @property {string} Key The key we want to access
* @property {string} Domain The domain where we want to access
*/
/**
* Gets values from the device according to the query passed
*
* @param {Partial<Query>} query the query we want to send to lockdownd
* @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
* @returns {Promise<any>} The actual response value. It should never be `null` or `undefined`
* @throws {Error} If an unexpected response is received from lockdownd
*/
async getValue(query = {}, timeout = 5000) {
const plist = {
Label: LABEL,
ProtocolVersion: PROTOCOL_VERSION,
Request: 'GetValue',
...query
};
const data = await this._plistService.sendPlistAndReceive(plist, timeout);
if (data?.Request === 'GetValue' && !lodash_1.default.isNil(data?.Value)) {
return data.Value;
}
throw new Error(`Unexpected data received for ${JSON.stringify(query)} request: ` +
JSON.stringify(data));
}
/**
* Starts a service on the phone corresponding to the name
* @param {string} serviceName the name of the service which we want to start
* @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
* @returns {Promise<any>}
*/
async startService(serviceName, timeout = 5000) {
const data = await this._plistService.sendPlistAndReceive({
Label: LABEL,
ProtocolVersion: PROTOCOL_VERSION,
Request: 'StartService',
Service: serviceName,
}, timeout);
if (data.Error) {
throw new Error(`Unexpected data: ${JSON.stringify(data)}`);
}
else {
return data;
}
}
}
exports.Lockdown = Lockdown;
exports.default = Lockdown;
//# sourceMappingURL=index.js.map