zombiebox-platform-webos/cli/ares.js

LG webOS Smart TV support abstraction layer for ZombieBox framework

/*
 * This file is part of the ZombieBox package.
 *
 * Copyright © 2014-2020, Interfaced
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
const path = require('path');
const execa = require('execa');


/**
 * @param {string} toolsDir
 * @param {string} executable
 * @return {string}
 */
function getExecutable(toolsDir, executable) {
	const base = toolsDir || process.env.WEBOS_CLI_TV || '';
	return path.join(base, executable);
}


/**
 * @param {string} toolsDir
 * @param {string} command
 * @param {Array<string>} args
 * @param {string=} expectedSuccessMessage
 * @return {Promise}
 */
async function exec(toolsDir, command, args, expectedSuccessMessage) {
	const executable = getExecutable(toolsDir, command);

	const result = await execa(
		executable,
		args,
		{
			all: true
		}
	);

	if (expectedSuccessMessage && !result.stdout.includes(expectedSuccessMessage)) {
		throw new Error(`${command} failed\n${result.stdout}\n${result.stderr}`);
	}

	return result.all;
}


/**
 * @param {string} toolsDir
 * @param {string} deviceName
 * @return {Promise<Array<string>, Error<string>>}
 */
async function getInstalledApps(toolsDir, deviceName) {
	const result = await exec(
		toolsDir,
		'ares-install',
		['-d', deviceName, '-l']
	);

	return result.split(/\s+/);
}

/**
 * @param {string} toolsDir
 * @param {string} srcDir
 * @param {string=} outDir
 * @return {Promise}
 * @protected
 */
async function build(toolsDir, srcDir, outDir = srcDir) {
	await exec(
		toolsDir,
		'ares-package',
		[srcDir, '--outdir', outDir, '--no-minify']
	);
}


/**
 * @param {string} toolsDir
 * @param {string} ipk
 * @param {string} deviceName
 * @return {Promise}
 */
async function install(toolsDir, ipk, deviceName) {
	await exec(
		toolsDir,
		'ares-install',
		[ipk, '-d', deviceName],
		'Success'
	);
}


/**
 * @param {string} toolsDir
 * @param {string} appId
 * @param {string} deviceName
 * @return {Promise}
 */
async function launch(toolsDir, appId, deviceName) {
	await exec(
		toolsDir,
		'ares-launch',
		[appId, '-d', deviceName],
		'Launched'
	);
}


/**
 * @param {string} toolsDir
 * @param {string} appId
 * @param {string} deviceName
 * @return {Promise<string>}
 */
async function inspect(toolsDir, appId, deviceName) {
	const executable = getExecutable(toolsDir, 'ares-inspect');

	const subprocess = execa(
		executable,
		['-d', deviceName, appId]
	);

	return new Promise((resolve) => {
		subprocess.stdout.on('data', (chunk) => {
			const line = chunk.toString();
			const urlMarker = 'Application Debugging - ';
			if (line.startsWith(urlMarker)) {
				resolve(line.slice(urlMarker.length).trim());
			}
		});
	});
}


/**
 * @param {string} toolsDir
 * @param {string} appId
 * @param {string} deviceName
 * @return {Promise}
 */
async function uninstall(toolsDir, appId, deviceName) {
	await exec(
		toolsDir,
		'ares-install',
		['-d', deviceName, '--remove', appId]
	);
}


module.exports = {
	getInstalledApps,
	build,
	install,
	launch,
	inspect,
	uninstall
};