@webos-tools/cli 3.1.3 → 3.2.0

package/lib/base/sdkenv.js

@@ -1,59 +1,59 @@
-/*
- * Copyright (c) 2020-2024 LG Electronics Inc.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-const fs = require('fs'),
-    path = require('path');
-
-(function() {
-    const sdkenv = {};
-    function SdkEnv() {
-        // Read SDK ENV
-        let sdkPath,
-            sdkBrowserPath;
-
-        try {
-            const confFile = path.join(__dirname, '../../files/conf/sdk.json'),
-                sdkConf = JSON.parse(fs.readFileSync(confFile, 'utf8'));
-            sdkPath = process.env[sdkConf.SDKPATH_ENV_NAME];
-            sdkBrowserPath = sdkConf.BROWSER_PATH_IN_SDK[process.platform];
-        } catch(e) {
-            // TBD. allowing exceptions...
-        }
-
-        const browserPath = process.env.ARES_BUNDLE_BROWSER
-                            || (sdkPath && sdkBrowserPath) ? path.join(sdkPath, sdkBrowserPath) : null;
-        this.envList = {};
-
-        if (sdkPath && fs.existsSync(sdkPath)) {
-            this.envList.SDK = sdkPath;
-        }
-
-        if (browserPath && fs.existsSync(browserPath)) {
-            this.envList.BROWSER = browserPath;
-        }
-    }
-
-    sdkenv.Env = SdkEnv;
-
-    sdkenv.create = function() {
-        return new SdkEnv();
-    };
-
-    SdkEnv.prototype = {
-        getEnvList: function(next) {
-            const envNameList = Object.keys(this.envList);
-            setImmediate(next, null, envNameList);
-        },
-        getEnvValue: function(name, next) {
-            const envValue = this.envList[name];
-            setImmediate(next, null, envValue);
-        }
-    };
-
-    if (typeof module !== 'undefined' && module.exports) {
-        module.exports = sdkenv;
-    }
-}());
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const fs = require('fs'),
+    path = require('path');
+
+(function() {
+    const sdkenv = {};
+    function SdkEnv() {
+        // Read SDK ENV
+        let sdkPath,
+            sdkBrowserPath;
+
+        try {
+            const confFile = path.join(__dirname, '../../files/conf/sdk.json'),
+                sdkConf = JSON.parse(fs.readFileSync(confFile, 'utf8'));
+            sdkPath = process.env[sdkConf.SDKPATH_ENV_NAME];
+            sdkBrowserPath = sdkConf.BROWSER_PATH_IN_SDK[process.platform];
+        } catch(e) {
+            // TBD. allowing exceptions...
+        }
+
+        const browserPath = process.env.ARES_BUNDLE_BROWSER
+                            || (sdkPath && sdkBrowserPath) ? path.join(sdkPath, sdkBrowserPath) : null;
+        this.envList = {};
+
+        if (sdkPath && fs.existsSync(sdkPath)) {
+            this.envList.SDK = sdkPath;
+        }
+
+        if (browserPath && fs.existsSync(browserPath)) {
+            this.envList.BROWSER = browserPath;
+        }
+    }
+
+    sdkenv.Env = SdkEnv;
+
+    sdkenv.create = function() {
+        return new SdkEnv();
+    };
+
+    SdkEnv.prototype = {
+        getEnvList: function(next) {
+            const envNameList = Object.keys(this.envList);
+            setImmediate(next, null, envNameList);
+        },
+        getEnvValue: function(name, next) {
+            const envValue = this.envList[name];
+            setImmediate(next, null, envValue);
+        }
+    };
+
+    if (typeof module !== 'undefined' && module.exports) {
+        module.exports = sdkenv;
+    }
+}());

package/lib/base/server.js

@@ -1,137 +1,137 @@
-/*
- * Copyright (c) 2020-2024 LG Electronics Inc.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-const bodyParser = require('body-parser'),
-    Express = require('express'),
-    fs = require('fs'),
-    http = require('http'),
-    npmlog = require('npmlog'),
-    spawn = require('child_process').spawn,
-    errHndl = require('./error-handler');
-
-(function() {
-    const log = npmlog;
-    log.heading = 'server';
-    log.level = 'warn';
-
-    const platformOpen = {
-        win32: [ "cmd" , "/c", "start" ],
-        darwin:[ "open" ],
-        linux: [ "xdg-open" ]
-    };
-
-    const server = {},
-        sockets = {};
-    let localServer,
-        nextSocketId = 0;
-
-    /**
-     * Run a local web server based on the path
-     * @param {path} path where local web server indicates.
-     * @param {port} port number for web server. 0 means random port.
-     * @param {Function} next a common-JS callback invoked when the DB is ready to use.
-     */
-    server.runServer = function(path, port, reqHandlerForIFrame, next) {
-        log.verbose("server#runServer()");
-        if (typeof reqHandlerForIFrame === 'function' && !next) {
-            next = reqHandlerForIFrame;
-            reqHandlerForIFrame = null;
-        }
-        const appPath = fs.realpathSync(path),
-            app = new Express();
-
-        app.use("/", Express.static(appPath));
-        app.use("/ares_cli", Express.static(__dirname));
-        app.use(bodyParser.json());
-
-        if (reqHandlerForIFrame) {
-            app.post('/ares_cli/@@ARES_CLOSE@@', function(req, res) {
-                reqHandlerForIFrame("@@ARES_CLOSE@@", res);
-            });
-            app.post('/ares_cli/@@GET_URL@@', function(req, res) {
-                reqHandlerForIFrame("@@GET_URL@@", res);
-            });
-        }
-
-        localServer = http.createServer(app);
-        localServer.on('error', function(err) {
-            return next(errHndl.getErrMsg(err));
-        });
-        localServer.listen(port, function(err) {
-            if (err) {
-                return next(errHndl.getErrMsg(err));
-            }
-            const localServerPort = localServer.address().port,
-                url = 'http://localhost:' + localServerPort;
-
-            next(null, {
-                "url": url,
-                "port": localServerPort,
-                "openBrowserUrl": url + "/ares_cli/ares.html",
-                "msg":"Local server running on " + url
-            });
-        });
-        localServer.on('connection', function(socket) {
-            // Add a newly connected socket
-            const socketId = nextSocketId++;
-            sockets[socketId] = socket;
-            log.verbose("Socket opened: ", socketId);
-        });
-    };
-
-    /**
-     * Open url with a web browser
-     * @param {url} URL to be opened via web browser.
-     * @param {browserPath} browser exectable path. (optional)
-     * @param {Function} next a common-JS callback invoked when the DB is ready to use. (optional)
-     */
-    server.openBrowser = function(url, browserPath, next) {
-        log.verbose("server#openBrowser()");
-        let info = platformOpen[process.platform];
-        if (typeof browserPath === 'function') {
-            next = browserPath;
-            browserPath = null;
-        }
-        if (browserPath && fs.existsSync(browserPath)) {
-            if (process.platform === 'linux') {
-                info.splice(0, 1); // delete 'xdg-open' command
-            }
-            info = info.concat([browserPath]);
-
-            if (process.platform === 'darwin') {
-                 info = info.concat(['--new', '--args']);
-            }
-        }
-
-        this.browserProcess = spawn(info[0], info.slice(1).concat([url]));
-        if (next) {
-            next(null, {msg:"Browser opened"});
-        }
-    };
-
-    server.stop = function(next) {
-        log.verbose("server#stop()");
-        if (!localServer) {
-            return next(errHndl.getErrMsg("NOT_EXIST_SERVER"));
-        }
-
-        if (Object.keys(sockets).length) {
-            for (const socketId in sockets) {
-                log.verbose("Socket destroyed: ", socketId);
-                sockets[socketId].destroy();
-            }
-        }
-
-        localServer.close(function() {
-            log.verbose("Local server close called");
-            next(null, {msg: "Local server is stopped"});
-        });
-    };
-
-    if (typeof module !== 'undefined' && module.exports) {
-        module.exports = server;
-    }
-}());
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const bodyParser = require('body-parser'),
+    Express = require('express'),
+    fs = require('fs'),
+    http = require('http'),
+    npmlog = require('npmlog'),
+    spawn = require('child_process').spawn,
+    errHndl = require('./error-handler');
+
+(function() {
+    const log = npmlog;
+    log.heading = 'server';
+    log.level = 'warn';
+
+    const platformOpen = {
+        win32: [ "cmd" , "/c", "start" ],
+        darwin:[ "open" ],
+        linux: [ "xdg-open" ]
+    };
+
+    const server = {},
+        sockets = {};
+    let localServer,
+        nextSocketId = 0;
+
+    /**
+     * Run a local web server based on the path
+     * @param {path} path where local web server indicates.
+     * @param {port} port number for web server. 0 means random port.
+     * @param {Function} next a common-JS callback invoked when the DB is ready to use.
+     */
+    server.runServer = function(path, port, reqHandlerForIFrame, next) {
+        log.verbose("server#runServer()");
+        if (typeof reqHandlerForIFrame === 'function' && !next) {
+            next = reqHandlerForIFrame;
+            reqHandlerForIFrame = null;
+        }
+        const appPath = fs.realpathSync(path),
+            app = new Express();
+
+        app.use("/", Express.static(appPath));
+        app.use("/ares_cli", Express.static(__dirname));
+        app.use(bodyParser.json());
+
+        if (reqHandlerForIFrame) {
+            app.post('/ares_cli/@@ARES_CLOSE@@', function(req, res) {
+                reqHandlerForIFrame("@@ARES_CLOSE@@", res);
+            });
+            app.post('/ares_cli/@@GET_URL@@', function(req, res) {
+                reqHandlerForIFrame("@@GET_URL@@", res);
+            });
+        }
+
+        localServer = http.createServer(app);
+        localServer.on('error', function(err) {
+            return next(errHndl.getErrMsg(err));
+        });
+        localServer.listen(port, function(err) {
+            if (err) {
+                return next(errHndl.getErrMsg(err));
+            }
+            const localServerPort = localServer.address().port,
+                url = 'http://localhost:' + localServerPort;
+
+            next(null, {
+                "url": url,
+                "port": localServerPort,
+                "openBrowserUrl": url + "/ares_cli/ares.html",
+                "msg":"Local server running on " + url
+            });
+        });
+        localServer.on('connection', function(socket) {
+            // Add a newly connected socket
+            const socketId = nextSocketId++;
+            sockets[socketId] = socket;
+            log.verbose("Socket opened: ", socketId);
+        });
+    };
+
+    /**
+     * Open url with a web browser
+     * @param {url} URL to be opened via web browser.
+     * @param {browserPath} browser exectable path. (optional)
+     * @param {Function} next a common-JS callback invoked when the DB is ready to use. (optional)
+     */
+    server.openBrowser = function(url, browserPath, next) {
+        log.verbose("server#openBrowser()");
+        let info = platformOpen[process.platform];
+        if (typeof browserPath === 'function') {
+            next = browserPath;
+            browserPath = null;
+        }
+        if (browserPath && fs.existsSync(browserPath)) {
+            if (process.platform === 'linux') {
+                info.splice(0, 1); // delete 'xdg-open' command
+            }
+            info = info.concat([browserPath]);
+
+            if (process.platform === 'darwin') {
+                 info = info.concat(['--new', '--args']);
+            }
+        }
+
+        this.browserProcess = spawn(info[0], info.slice(1).concat([url]));
+        if (next) {
+            next(null, {msg:"Browser opened"});
+        }
+    };
+
+    server.stop = function(next) {
+        log.verbose("server#stop()");
+        if (!localServer) {
+            return next(errHndl.getErrMsg("NOT_EXIST_SERVER"));
+        }
+
+        if (Object.keys(sockets).length) {
+            for (const socketId in sockets) {
+                log.verbose("Socket destroyed: ", socketId);
+                sockets[socketId].destroy();
+            }
+        }
+
+        localServer.close(function() {
+            log.verbose("Local server close called");
+            next(null, {msg: "Local server is stopped"});
+        });
+    };
+
+    if (typeof module !== 'undefined' && module.exports) {
+        module.exports = server;
+    }
+}());

package/lib/base/setup-device.js

@@ -57,6 +57,7 @@ const async = require('async'),
                     table.cell('deviceinfo', item.info);
                     table.cell('connection', item.connection);
                     table.cell('profile', item.profile);
+                    table.cell('passphrase', item.passphrase);
                     table.newRow();
                 });
                 next(null, table.toString());
@@ -203,7 +204,7 @@ const async = require('async'),
             async.series([
                 resolver.load.bind(resolver),
                 resolver.modifyDeviceFile.bind(resolver, mode, inDevice),
-                this.showDeviceList.bind(this)
+                this.showDeviceList.bind(this),
             ], function(err, results) {
                 if (err) {
                     return next(err);
@@ -229,6 +230,7 @@ const async = require('async'),
             resolver.list.bind(resolver),
             function(devices, next) {
                 if (Array.isArray(devices)) {
+                    devices.sort((device1, device2) => device2.index - device1.index);
                     devices.forEach(function(device) {
                         const conn = device.conn.concat([]),
                             info = (device.username && device.host && device.port) ? device.username + '@' + device.host + ':' + device.port : device.id,
@@ -263,7 +265,16 @@ const async = require('async'),
                             item.deviceinfo.uid = device.id;
                             item.details.type = device.name.slice(0, 3);
                         }
-                        const data = (mode === 'full') ? item : {name: device.name, default: device.default, info:info, connection: (device.conn || 'ssh'), profile: device.profile };
+                        const data = (mode === 'full')
+                                        ? item
+                                        : {
+                                            name: device.name,
+                                            default: device.default,
+                                            info: info,
+                                            connection: (device.conn || 'ssh'),
+                                            profile: device.profile,
+                                            passphrase: device.passphrase || ""
+                                        };
                         datas.push(data);
                     });
                 }
@@ -326,12 +337,19 @@ const async = require('async'),
     }
 
     function displayGetKeyGuide(deviceName) {
-        const guideSteps = "** To connect to TV you need to do following steps:"
-                              + "\n 1. Turning on Developer Mode following this guide: https://webostv.developer.lge.com/develop/getting-started/developer-mode-app"
-                              + "\n 2. Launch the Developer Mode app and click the Key Server button in the Developer Mode app"
-                              + "\n 3. Get the ssh key file from your webOS TV with the following command on your PC"
-                              + "\n    > ares-novacom --device " + deviceName + " --getkey"
-                              + "\n    > Enter the passphrase displayed on the Developer Mode app";
+        const profile = appdata.getConfig().profile;
+        let webOSName = "webOS TV", guideURL = "https://webostv.developer.lge.com/develop/getting-started/developer-mode-app";
+        if(profile === "signage"){
+            webOSName = "Signage",
+            guideURL = "https://webossignage-docs.developer.lge.com/guides/developer-guides/system-feature/developer-mode";
+        }
+
+        const guideSteps = "** After adding your device, you'll need to get the key file from your " + webOSName + "."
+                              + "\n Follow these steps:"
+                              + "\n 1. Ensure that the key server button in the Developer Mode app on your " + webOSName + " is enabled."
+                              + "\n 2. Run the command \"ares-novacom --device " + deviceName + " --getkey\" to retrieve the key file from your " + webOSName + "."
+                              + "\n 3. Enter the passphrase displayed in the Developer Mode app into the prompt."
+                              + "\n For more details, refer to the " + guideURL;
                     
         console.log(guideSteps);
     }

package/lib/base/version-tools.js

@@ -1,79 +1,79 @@
-/*
- * Copyright (c) 2020-2024 LG Electronics Inc.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-const fs = require('fs'),
-    path = require('path'),
-    semver = require('semver');
-
-(function() {
-    const vtools = {};
-    let pkgInfo = null;
-
-    vtools.showVersionAndExit = function() {
-        getPackageVersion(function(err, version) {
-            console.log("Version: " + version);
-            process.exit(0);
-        });
-    };
-
-    vtools.checkNodeVersion = function(next) {
-        getAllowedNodeVersion(function(err, range) {
-            const expectedRange = semver.validRange(range);
-            if (expectedRange) {
-                if (semver.satisfies(process.version, expectedRange)) {
-                    next();
-                } else {
-                    console.error("This command only works on Node.js version: " + expectedRange);
-                    process.exit(1);
-                }
-            } else {
-                console.error("Invalid Node.js version range: " + range);
-                process.exit(1);
-            }
-        });
-    };
-
-    // Private methods
-    function getAllowedNodeVersion(next) {
-        if (pkgInfo) {
-            next(null, (pkgInfo && pkgInfo.engines && pkgInfo.engines.node) || "");
-        } else {
-            loadPackageJson(function(err) {
-                next(err, (pkgInfo && pkgInfo.engines && pkgInfo.engines.node) || "");
-            });
-        }
-    }
-
-    function loadPackageJson(next) {
-        const filename = path.resolve(__dirname, "../..", "package.json");
-        fs.readFile(filename, function(err, data) {
-            if (err) {
-                return next("loadPackageJson_error");
-            }
-
-            try {
-                pkgInfo = JSON.parse(data);
-                next();
-            } catch(error) {
-                next(error);
-            }
-        });
-    }
-
-    function getPackageVersion(next) {
-        if (pkgInfo) {
-            next(null, pkgInfo.version);
-        } else {
-            loadPackageJson(function(err) {
-                next(err, (pkgInfo && pkgInfo.version) || "unknown");
-            });
-        }
-    }
-
-    if (typeof module !== 'undefined' && module.exports) {
-        module.exports = vtools;
-    }
-}());
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const fs = require('fs'),
+    path = require('path'),
+    semver = require('semver');
+
+(function() {
+    const vtools = {};
+    let pkgInfo = null;
+
+    vtools.showVersionAndExit = function() {
+        getPackageVersion(function(err, version) {
+            console.log("Version: " + version);
+            process.exit(0);
+        });
+    };
+
+    vtools.checkNodeVersion = function(next) {
+        getAllowedNodeVersion(function(err, range) {
+            const expectedRange = semver.validRange(range);
+            if (expectedRange) {
+                if (semver.satisfies(process.version, expectedRange)) {
+                    next();
+                } else {
+                    console.error("This command only works on Node.js version: " + expectedRange);
+                    process.exit(1);
+                }
+            } else {
+                console.error("Invalid Node.js version range: " + range);
+                process.exit(1);
+            }
+        });
+    };
+
+    // Private methods
+    function getAllowedNodeVersion(next) {
+        if (pkgInfo) {
+            next(null, (pkgInfo && pkgInfo.engines && pkgInfo.engines.node) || "");
+        } else {
+            loadPackageJson(function(err) {
+                next(err, (pkgInfo && pkgInfo.engines && pkgInfo.engines.node) || "");
+            });
+        }
+    }
+
+    function loadPackageJson(next) {
+        const filename = path.resolve(__dirname, "../..", "package.json");
+        fs.readFile(filename, function(err, data) {
+            if (err) {
+                return next("loadPackageJson_error");
+            }
+
+            try {
+                pkgInfo = JSON.parse(data);
+                next();
+            } catch(error) {
+                next(error);
+            }
+        });
+    }
+
+    function getPackageVersion(next) {
+        if (pkgInfo) {
+            next(null, pkgInfo.version);
+        } else {
+            loadPackageJson(function(err) {
+                next(err, (pkgInfo && pkgInfo.version) || "unknown");
+            });
+        }
+    }
+
+    if (typeof module !== 'undefined' && module.exports) {
+        module.exports = vtools;
+    }
+}());