@webos-tools/cli 3.0.0

package/bin/ares.js

@@ -0,0 +1,166 @@
+#!/usr/bin/env node
+
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const async = require('async'),
+    Table = require('easy-table'),
+    fs = require('fs'),
+    nopt = require('nopt'),
+    log = require('npmlog'),
+    path = require('path'),
+    commonTools = require('./../lib/base/common-tools');
+
+const cliControl = commonTools.cliControl,
+    version = commonTools.version,
+    help = commonTools.help,
+    appdata = commonTools.appdata,
+    errHndl = commonTools.errMsg;
+
+const processName = path.basename(process.argv[1]).replace(/.js/, '');
+
+process.on('uncaughtException', function(err) {
+    log.error('uncaughtException', err.toString());
+    log.verbose('uncaughtException', err.stack);
+    cliControl.end(-1);
+});
+
+if (process.argv.length === 2) {
+    process.argv.splice(2, 0, '--help');
+}
+
+const knownOpts = {
+    "help": Boolean,
+    "list": Boolean,
+    "version": Boolean,
+    "level": ['silly', 'verbose', 'info', 'http', 'warn', 'error']
+};
+
+const shortHands = {
+    "h": ["--help"],
+    "l": ["--list"],
+    "V": ["--version"],
+    "v": ["--level", "verbose"]
+};
+
+const argv = nopt(knownOpts, shortHands, process.argv, 2),
+    profile = appdata.getConfig(true).profile;
+
+log.heading = processName;
+log.level = argv.level || 'warn';
+log.verbose("argv", argv);
+
+/**
+ * For consistent of "$command -v", argv is used.
+ * By nopt, argv is parsed and set key-value in argv object.
+ * If -v or --level option is input with command, it is set key-value in argv.
+ * After it is deleted, If remained key is only one in argv object
+ * (If any other are remained, it's mean another options is input)
+ * and there is no remaining after parsing the input command by nopt
+ * (If any other are remained, it's mean another parameters ares input),
+ * each command of webOS CLI print help message with log message.
+ */
+if (argv.level) {
+    delete argv.level;
+    if (argv.argv.remain.length === 0 && (Object.keys(argv)).length === 1) {
+        argv.help = true;
+    }
+}
+
+let op;
+if (argv.list) {
+    op = commandList;
+} else if (argv.version) {
+    version.showVersionAndExit();
+} else if (argv.help) {
+    showUsage();
+    cliControl.end();
+} else {
+    op = display;
+}
+
+if (op) {
+    version.checkNodeVersion(function() {
+        async.series([
+            op.bind(this)
+        ],finish);
+    });
+}
+
+function commandList() {
+    log.info("commandList()");
+    const table = new Table();
+    try {
+        const commandsList = JSON.parse(fs.readFileSync(path.join(__dirname, '../', 'files', 'conf', 'ares.json')));
+        Object.keys(commandsList).forEach(function(cmd) {
+            if (commandsList[cmd].profile && !commandsList[cmd].profile.includes(profile)) {
+                return;
+            } else if (!fs.existsSync(path.join(__dirname, cmd + '.js'))) {
+                return;
+            }
+            table.cell('CMD', cmd);
+            table.cell('Description', commandsList[cmd].description);
+            table.newRow();
+        });
+        finish(null, {msg: table.print().trim()});
+    } catch (err) {
+        finish(errHndl.getErrMsg("INVALID_JSON_FORMAT"));
+    }
+}
+
+function display (next) {
+    log.info("display()");
+    let found = false;
+    try{
+        const commandsList = JSON.parse(fs.readFileSync(path.join(__dirname, '../', 'files', 'conf', 'ares.json')));
+        for (const arg in argv) {
+            if (Object.hasOwnProperty.call(commandsList, 'ares-'+ arg) && fs.existsSync(path.join(__dirname, 'ares-'+ arg + '.js'))) {
+                if (commandsList['ares-'+ arg].profile && !commandsList['ares-'+ arg].profile.includes(profile)) {
+                    next(errHndl.getErrMsg("NOT_SUPPORT_COMMOND", profile));
+                } else {
+                    help.display('ares-'+arg, appdata.getConfig(true).profile);
+                    found = true;
+                }
+            }
+
+            if (!found) {
+                next(errHndl.getErrMsg("INVALID_COMMAND"));
+            } else {
+                next();
+            }
+        }
+    } catch (err) {
+        next(errHndl.getErrMsg("INVALID_JSON_FORMAT"));
+    }
+}
+
+function showUsage () {
+    help.display(processName, appdata.getConfig(true).profile);
+}
+
+function finish(err, value) {
+    log.info("finish()");
+    if (err) {
+        // handle err from getErrMsg()
+        if (Array.isArray(err) && err.length > 0) {
+            for (const index in err) {
+                log.error(err[index].heading, err[index].message);
+            }
+            log.verbose(err[0].stack);
+        } else {
+            // handle general err (string & object)
+            log.error(err.toString());
+            log.verbose(err.stack);
+        }
+        cliControl.end(-1);
+    } else {
+        log.verbose("finish()", "value:", value);
+        if (value && value.msg) {
+            console.log(value.msg);
+        }
+        cliControl.end();
+    }
+}

package/files/conf/ares.json

@@ -0,0 +1,49 @@
+{
+    "ares-config": {
+        "description": "Configure webOS CLI"
+    },
+    "ares-device": {
+        "description": "Display the device information"
+    },
+    "ares-generate": {
+        "description": "Generate files for a webOS app or service"
+    },
+    "ares-inspect": {
+        "description": "Enable Web Inspector or Node's Inspector"
+    },
+    "ares-install": {
+        "description": "Install or remove the app on the device"
+    },
+    "ares-launch": {
+        "description": "Launch or close the app"
+    },
+    "ares-log": {
+        "profile": ["ose"],
+        "description": "Show or save logs of webOS apps and services"
+    },
+    "ares-novacom": {
+        "profile": ["tv"],
+        "description": "Command Line Tool to control the device"
+    },
+    "ares-package": {
+        "description": "Create or analyze a package containing a webOS app or service"
+    },
+    "ares-pull": {
+        "profile": ["ose"],
+        "description": "Pull the file from the device"
+    },
+    "ares-push": {
+        "profile": ["ose"],
+        "description": "Push the file to the device"
+    },
+    "ares-server": {
+        "description": "Run a local web server"
+    },
+    "ares-setup-device": {
+        "description": "Add or modify the information of the devices to use"
+    },
+    "ares-shell": {
+        "profile": ["ose"],
+        "description": "Open a device terminal or run a command"
+    }
+}

package/files/conf/command-service.json

@@ -0,0 +1,73 @@
+{
+    "lunaSend": "/usr/bin/luna-send-pub",
+    "lunaAddr": {
+        "install": {
+            "service": "com.webos.appInstallService",
+            "folder": "dev",
+            "method": "install",
+            "returnValue": "return.details.state"
+        },
+        "remove": {
+            "service": "com.webos.appInstallService",
+            "folder": "dev",
+            "method": "remove",
+            "returnValue": "return.details.state"
+        },
+        "list": {
+            "service": "com.webos.applicationManager",
+            "folder": "dev",
+            "method": "listApps",
+            "returnValue": "return.apps"
+        },
+        "launch": {
+            "service": "com.webos.applicationManager",
+            "method": "launch",
+            "returnValue": "return.returnValue"
+        },
+        "terminate": {
+            "service": "com.webos.applicationManager",
+            "folder": "dev",
+            "method": "closeByAppId",
+            "returnValue": "return.returnValue"
+        },
+        "running": {
+            "service": "com.webos.applicationManager",
+            "folder": "dev",
+            "method": "running",
+            "returnValue": "return.running"
+        },
+        "deviceInfo": {
+            "service": "com.webos.service.systemservice",
+            "folder": "deviceInfo",
+            "method": "query",
+            "returnValue": "return.returnValue"
+        },
+        "osInfo": {
+            "service": "com.webos.service.systemservice",
+            "folder": "osInfo",
+            "method": "query",
+            "returnValue": "return.returnValue"
+        },
+        "softwareInfo": {
+            "service": "com.webos.service.systemservice",
+            "folder": "softwareInfo",
+            "method": "query",
+            "returnValue": "return.returnValue"
+        },
+        "getSessionList": {
+            "service": "com.webos.service.sessionmanager",
+            "method": "getSessionList",
+            "returnValue": "return.returnValue"
+        },
+        "captureCompositorOutput": {
+            "service": "com.webos.surfacemanager",
+            "method": "captureCompositorOutput",
+            "returnValue": "return.returnValue"
+        },
+        "deviceInfoSystem": {
+            "service": "com.webos.service.tv.systemproperty",
+            "method": "getSystemInfo",
+            "returnValue": "return.returnValue"
+        }
+    }
+}

package/files/conf/config.json

@@ -0,0 +1,22 @@
+{
+    "profile": "tv",
+    "config": "tv_sdk",
+    "defaultAppInfo": {
+        "id": "com.domain.app",
+        "type": "web",
+        "title": "new app",
+        "version": "0.0.1",
+        "main": {
+            "web": "index.html",
+            "native": "executable"
+        }
+    },
+    "logFilePath": "/media/developer/log/devlog",
+    "install": {
+        "tempDirForIpk": "/media/developer/temp",
+        "changeTempDir": true,
+        "removeIpkAfterInst": true
+    },
+    "dataDir": ".webos/tv",
+    "simulatorConfig": "simulator-config.json"
+}

package/files/conf/ipk.json

@@ -0,0 +1,30 @@
+{
+    "tmpPath": "webOSPackage-",
+    "ipkMetaFiles": ["control.tar.gz", "data.tar.gz"],
+    "webOSMetaFiles": ["control", "package", "app", "service"],
+    "webOSMetaFileRootPath": "usr/",
+    "control": {
+        "heading": "< Package Information >",
+        "path": ".",
+        "fileName": "control",
+        "info": ["Package", "Version", "Architecture", "Installed-Size"]
+    },
+    "package": {
+        "path": "usr/palm/packages",
+        "fileName": ["packageinfo.json"],
+        "info": ["app", "services"]
+    },
+    "app": {
+        "heading": "< Application Information >",
+        "path": "usr/palm/applications",
+        "fileName": ["appinfo.json"],
+        "info": ["id", "version", "type", "main"]
+    },
+    "service": {
+        "heading": "< Service Information >",
+        "path": "usr/palm/services",
+        "fileName": ["services.json", "package.json"],
+        "info": ["id", "version", "main", "services"],
+        "services": "name"
+    }
+}

package/files/conf/novacom-devices.json

@@ -0,0 +1,35 @@
+[
+    {
+        "order":"0",
+        "default": true,
+        "profile": "ose",
+        "name": "emulator",
+        "description": "LG webOS Emulator",
+        "host": "127.0.0.1",
+        "port": 6622,
+        "username": "developer",
+        "privateKey": {
+            "openSsh": "webos_emul"
+        },
+        "files":"sftp",
+        "noPortForwarding":false,
+        "indelible": true
+    },
+    {
+        "order":"0",
+        "default": true,
+        "profile": "tv",
+        "name": "emulator",
+        "type": "starfish",
+        "description": "LG webOS TV Emulator",
+        "host": "127.0.0.1",
+        "port": 6622,
+        "username": "developer",
+        "privateKey": {
+            "openSsh": "webos_emul"
+        },
+        "files":"sftp",
+        "noPortForwarding":false,
+        "indelible": true
+    }
+]

package/files/conf/query/query-app.json

@@ -0,0 +1,14 @@
+{
+    "id": {
+        "query": "app id",
+        "default": "com.domain.app"
+    },
+    "title": {
+        "query": "title",
+        "default": "new app"
+    },
+    "version": {
+        "query": "version",
+        "default": "1.0.0"
+    }
+}

package/files/conf/query/query-hosted.json

@@ -0,0 +1,18 @@
+{
+    "id": {
+        "query": "app id",
+        "default": "com.domain.app"
+    },
+    "title": {
+        "query": "title",
+        "default": "new app"
+    },
+    "version": {
+        "query": "version",
+        "default": "1.0.0"
+    },
+    "url": {
+        "query":"url",
+        "default":"http://developer.lge.com/"
+    }
+}

package/files/conf/query/query-package.json

@@ -0,0 +1,10 @@
+{
+    "id": {
+        "query": "package id",
+        "default": "com.domain"
+    },
+    "version": {
+        "query": "version",
+        "default": "1.0.0"
+    }
+}

package/files/conf/query/query-service.json

@@ -0,0 +1,6 @@
+{
+    "id": {
+        "query": "service id",
+        "default": "com.domain.app.service"
+    }
+}

package/files/conf/sdk.json

@@ -0,0 +1,8 @@
+{
+    "SDKPATH_ENV_NAME": "LG_WEBOS_TV_SDK_HOME",
+    "BROWSER_PATH_IN_SDK": {
+        "win32": "/IDE/chromium/chrome.exe",
+        "darwin": "/IDE/chromium/Chromium.app",
+        "linux": "/IDE/chromium/chrome"
+    }
+}

package/files/conf/template.json

@@ -0,0 +1,57 @@
+{
+    "basic": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/tv-sdk-templates/bootplate-web",
+        "description": "basic web app for webOS TV",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "webicon"
+        ],
+        "default": true
+    },
+    "hosted_webapp": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/tv-sdk-templates/hosted-webapp",
+        "description": "hosted web app for webOS TV",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "webicon"
+        ]
+    },
+    "webappinfo": {
+        "type": "webappinfo",
+        "path": "$cli-root/files/templates/tv-sdk-templates/appinfo/appinfo.json",
+        "description": "appinfo.json for web app"
+    },
+    "js_service": {
+        "type": "jsservice",
+        "path": "$cli-root/files/templates/tv-sdk-templates/js-service",
+        "description": "js service for webOS TV",
+        "metadata": {
+            "id": "jsserviceinfo"
+        }
+    },
+    "jsserviceinfo": {
+        "type": "jsserviceinfo",
+        "path": [
+            "$cli-root/files/templates/tv-sdk-templates/serviceinfo/services.json",
+            "$cli-root/files/templates/tv-sdk-templates/serviceinfo/package.json"
+        ],
+        "description": "services.json, package.json for JS service"
+    },
+    "webicon": {
+        "type": "icon",
+        "path": "$cli-root/files/templates/tv-sdk-templates/webicon",
+        "description": "web app icon files [80x80, 130x130]",
+        "hide": true
+    },
+    "packageinfo": {
+        "type": "packageinfo",
+        "path": "$cli-root/files/templates/tv-sdk-templates/packageinfo/packageinfo.json",
+        "description": "packageinfo.json for webOS package"
+    }
+}

package/files/conf/webos_emul

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEA0KX2ywyIejqJ5Chc5+p9MbYCR5re8KKlkK/V6n6KcSfMInpr
+lvlJcMtkOxKVXYQ1dQmX407s9biRDZNjlb1VRmFs3FW0PM6p5E5yZzTuHcwHxXeY
+ajg7Ooqp5RjUH/DUegFAiDXI5pGvQn4eOGAiosJBO3fqP/NFlqJIDV9XF8+GKISW
+W/GZtVtnLT8fnyuoOMe/MvNz6YUVLbmYp5PASHoEz2BQ7YB6J2dUO/eU6GuWVQM0
+MVjdPtDZjfWjPsSo927UEXj3o4gxfgP0CCiuFlbjw8glLzaH9HYHnyk0MO9cVo+g
+THtyMBjZaMjQlD8jWvE2lQGCMFU9C/ITjYD68QIDAQABAoIBACnoG6B+vO6n0UhF
+Hxvpigmw/9Y38e0tDcn4tyNpFQ9TKfoG0pM5MJn6EACZY+yrgD0olxwtnwRfdKrg
+XpEVvQnsyXubrx7Dd3YGl43JIMZVU35C3hb/gk3oyeTczsY3jcWPeNGi094Thrr5
+L8Ks9GfyUj3KgP8lMmXl5EjjTE/YnnVPxzfRMBLbxF+2ecHguG1tD7XMnSmMtUtm
+VTjDOhqjPDsrsvsuKlAhpNPY2GxC4Ub2Doz5P22lGxZUDoFbKXKD46LUF6X2z3M9
+tMdEnKDqRHhnbNoBRpuPaQXgyp/vl+btBlZKlruKQwTyi4MoRTLMDZjHSWPaaUkj
+7BNWHY0CgYEA+ysfU8oBBmnr7yonpRTXNn39+ma6hs9cbW1jqsIEiXX6Mo9S3Kai
+Lf/IbEX1PmXWO9vxXXYfTYeG0YrAGYPub2a0U8iAgT/NrC56rUW1xpDztK9axEeN
+zJQEj5FewUoiYVNFgw55GMNCNm+OqVSFtn1XFPqt+CPRXrtq7SAuY2cCgYEA1Klz
+kFU2umKaBHqa+t+zBCJ/TEdENP/71GInb3Xgr7JxD/28FDQs7/uXG6o0lmVsni0T
+/NSM985iMQVYfXgilVRVo3QN3a3gavAFly3uz/9jvYvNzIsy3MXd2AbBC6K1GdkW
+eTUzUe9ba3atnB7XWXlmFFyZZRMcrBaCV5Zzz+cCgYEAuh+xflDiQ5N4f+m4KS/x
+b3McI1O/A6lkL77xLZfK7uZbOt5UpChjZDz4k6uf2dZzVDZffUfMWJKGyH7ObdoD
+ddAg7zlUaPMUAXUL+Zz/4B6ISivr0inIHYLOgmlSU2ARbBfeGgk+magQR/CRQk/d
+KmdlgalmA8zfGRk/WmsPlR8CgYB2wDjb+/mXkr/WiHBKbugUAv96pMEdp2QEcNr8
+jqJs+gPQniuMTKZbS+5RcHX1FaXVne5vXHFrXz/Nh+KmDZOiN3mq0H99rj6G+Ijm
+pquYUlBr48mD0qcQSR1cKElcKfte965o+KAzvKkcFSVU7JPsTrIF5L9zhXyZS+h0
+6Hq7OQKBgQDIZ72uiKWgeRZEOnnYyjOZsjr5Gv8L8TfUNYcau9y86HuMHi0h5C/3
+r3cnD117BawfjtrnOjj4RQsQmVVnO8nOwmfbRD2F3wXjUjhLUGAMIykDVxETp6ll
+3vhLce1DDlW9LQxMZoxCNFGVIjF05rXOmLe5y6KwJ5H0xP31koEQyw==
+-----END RSA PRIVATE KEY-----

package/files/conf-base/env/sdk-ose.json

@@ -0,0 +1,8 @@
+{
+    "SDKPATH_ENV_NAME": "LG_WEBOS_CUSTOM_SDK_HOME",
+    "BROWSER_PATH_IN_SDK": {
+        "win32": "/IDE/chromium/chrome.exe",
+        "darwin": "/IDE/chromium/Chromium.app",
+        "linux": "/IDE/chromium/chrome"
+    }
+}

package/files/conf-base/env/sdk-tv.json

@@ -0,0 +1,8 @@
+{
+    "SDKPATH_ENV_NAME": "LG_WEBOS_TV_SDK_HOME",
+    "BROWSER_PATH_IN_SDK": {
+        "win32": "/IDE/chromium/chrome.exe",
+        "darwin": "/IDE/chromium/Chromium.app",
+        "linux": "/IDE/chromium/chrome"
+    }
+}

package/files/conf-base/profile/config-ose.json

@@ -0,0 +1,21 @@
+{
+    "profile": "ose",
+    "defaultAppInfo": {
+        "id": "com.yourdomain.app",
+        "type": "web",
+        "title": "new app",
+        "version": "1.0.0",
+        "main": {
+            "web": "index.html",
+            "native": "executable"
+        }
+    },
+    "logFilePath": "/media/developer/log/devlog",
+    "install": {
+        "tempDirForIpk": "/media/developer/temp",
+        "changeTempDir": true,
+        "removeIpkAfterInst": true
+    },
+    "dataDir":".webos/ose",
+    "logDaemon": "journald"
+}

package/files/conf-base/profile/config-tv.json

@@ -0,0 +1,22 @@
+{
+    "profile": "tv",
+    "config": "tv_sdk",
+    "defaultAppInfo": {
+        "id": "com.domain.app",
+        "type": "web",
+        "title": "new app",
+        "version": "0.0.1",
+        "main": {
+            "web": "index.html",
+            "native": "executable"
+        }
+    },
+    "logFilePath": "/media/developer/log/devlog",
+    "install": {
+        "tempDirForIpk": "/media/developer/temp",
+        "changeTempDir": true,
+        "removeIpkAfterInst": true
+    },
+    "dataDir": ".webos/tv",
+    "simulatorConfig": "simulator-config.json"
+}

package/files/conf-base/query/query-app.json

@@ -0,0 +1,14 @@
+{
+    "id": {
+        "query": "app id",
+        "default": "com.domain.app"
+    },
+    "title": {
+        "query": "title",
+        "default": "new app"
+    },
+    "version": {
+        "query": "version",
+        "default": "1.0.0"
+    }
+}

package/files/conf-base/query/query-hosted.json

@@ -0,0 +1,18 @@
+{
+    "id": {
+        "query": "app id",
+        "default": "com.domain.app"
+    },
+    "title": {
+        "query": "title",
+        "default": "new app"
+    },
+    "version": {
+        "query": "version",
+        "default": "1.0.0"
+    },
+    "url": {
+        "query":"url",
+        "default":"http://developer.lge.com/"
+    }
+}

package/files/conf-base/query/query-package.json

@@ -0,0 +1,10 @@
+{
+    "id": {
+        "query": "package id",
+        "default": "com.domain"
+    },
+    "version": {
+        "query": "version",
+        "default": "1.0.0"
+    }
+}

package/files/conf-base/query/query-service.json

@@ -0,0 +1,6 @@
+{
+    "id": {
+        "query": "service id",
+        "default": "com.domain.app.service"
+    }
+}