@webos-tools/cli 3.1.1 → 3.1.3

package/bin/ares-shell.js

@@ -54,7 +54,7 @@ log.level = argv.level || 'warn';
 log.verbose("argv", argv);
 
 const curConfigData = appdata.getConfig(true);
-if (curConfigData.profile !== "ose") {
+if (!["ose", "apollo"].includes(curConfigData.profile)) {
     return finish(errHndl.getErrMsg("NOT_SUPPORT_COMMOND", curConfigData.profile));
 }
 

package/bin/ares.js

@@ -119,7 +119,7 @@ function display (next) {
         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)) {
-                   return next(errHndl.getErrMsg("NOT_SUPPORT_COMMOND", profile));
+                    return next(errHndl.getErrMsg("NOT_SUPPORT_COMMOND", profile));
                 } else {
                     help.display('ares-'+arg, appdata.getConfig(true).profile);
                     found = true;

package/files/conf/ares.json

@@ -18,7 +18,7 @@
         "description": "Launch or close the app"
     },
     "ares-log": {
-        "profile": ["ose"],
+        "profile": ["ose", "apollo"],
         "description": "Show or save logs of webOS apps and services"
     },
     "ares-novacom": {
@@ -29,11 +29,11 @@
         "description": "Create or analyze a package containing a webOS app or service"
     },
     "ares-pull": {
-        "profile": ["ose"],
+        "profile": ["ose","apollo"],
         "description": "Pull the file from the device"
     },
     "ares-push": {
-        "profile": ["ose"],
+        "profile": ["ose","apollo"],
         "description": "Push the file to the device"
     },
     "ares-server": {
@@ -43,7 +43,7 @@
         "description": "Add or modify the information of the devices to use"
     },
     "ares-shell": {
-        "profile": ["ose"],
+        "profile": ["ose","apollo"],
         "description": "Open a device terminal or run a command"
     }
-}
+}

package/files/conf/novacom-devices.json

@@ -31,5 +31,22 @@
         "files":"sftp",
         "noPortForwarding":false,
         "indelible": true
+    },
+    {
+        "order":"0",
+        "default": true,
+        "profile": "apollo",
+        "name": "emulator",
+        "type": "starfish",
+        "description": "LG webOS Apollo Emulator",
+        "host": "127.0.0.1",
+        "port": 6622,
+        "username": "developer",
+        "privateKey": {
+            "openSsh": "webos_emul"
+        },
+        "files":"sftp",
+        "noPortForwarding":false,
+        "indelible": true
     }
-]
+]

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

@@ -0,0 +1,8 @@
+{
+    "SDKPATH_ENV_NAME": "LG_WEBOS_APOLLO_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-apollo.json

@@ -0,0 +1,29 @@
+{
+    "profile": "apollo",
+    "defaultAppInfo": {
+        "id": "com.yourdomain.app",
+        "type": "web",
+        "title": "new app",
+        "version": "1.0.0",
+        "main": {
+            "web": "index.html",
+            "native": "executable"
+        }
+    },
+    "defaultDeviceInfo": {
+        "ipAddress": "127.0.0.1",
+        "port": "22",
+        "user": "root",
+        "description": "new device description",
+        "files": "stream",
+        "default": false
+    },
+    "logFilePath": "/media/developer/log/devlog",
+    "install": {
+        "tempDirForIpk": "/media/developer/temp",
+        "changeTempDir": true,
+        "removeIpkAfterInst": true
+    },
+    "dataDir":".webos/apollo",
+    "logDaemon": "journald"
+}

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

@@ -10,7 +10,7 @@
             "native": "executable"
         }
     },
-    "defaultDeviceInfo":{
+    "defaultDeviceInfo": {
         "ipAddress": "127.0.0.1",
         "port": "22",
         "user": "root",

package/files/conf-base/template-conf/apollo-sdk-templates.json

@@ -0,0 +1,56 @@
+{
+    "webapp": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/apollo-sdk-templates/bootplate-web",
+        "description": "web app for Apollo",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "icon"
+        ],
+        "default": true
+    },
+    "hosted_webapp": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/apollo-sdk-templates/hosted-webapp",
+        "description": "hosted web app for Apollo",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "icon"
+        ]
+    },
+    "webappinfo": {
+        "type": "webappinfo",
+        "path": "$cli-root/files/templates/apollo-sdk-templates/appinfo/appinfo.json",
+        "description": "appinfo.json for web app"
+    },
+    "js_service": {
+        "type": "jsservice",
+        "path": "$cli-root/files/templates/apollo-sdk-templates/js-service",
+        "description": "js service for Apollo",
+        "metadata": {
+            "id": "jsserviceinfo"
+        }
+    },
+    "jsserviceinfo": {
+        "type": "jsserviceinfo",
+        "path": [
+            "$cli-root/files/templates/apollo-sdk-templates/serviceinfo/services.json",
+            "$cli-root/files/templates/apollo-sdk-templates/serviceinfo/package.json"
+        ],
+        "description": "services.json, package.json for JS service"
+    },
+    "native_service": {
+        "type": "nativeservice",
+        "path": "$cli-root/files/templates/apollo-sdk-templates/native-service",
+        "description": "native service for Apollo"
+    },
+    "icon": {
+        "type": "icon",
+        "path": "$cli-root/files/templates/apollo-sdk-templates/icon",
+        "description": "app icon files [80x80]"
+    }
+}

package/files/help/ares-config.help

@@ -13,11 +13,15 @@
             "This command used for configuring the webOS devices profile setting to work with CLI.",
             "",
             "DEVICE_PROFILE is the profile of a target device.",
-            "This parameter can be \"ose\" and \"tv\". \"tv\" is default."
+            "This parameter can be \"ose\", \"tv\" and \"apollo\". \"tv\" is default."
           ],
           "ose" : [
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ],
+          "apollo" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
           ]
         }
     ],
@@ -33,6 +37,7 @@
         "cmdOpt":"option",
         "default" : ["profile", "profile-details", "help", "version", "verbose"],
         "ose" : ["level"],
+        "apollo" : ["level"],
         "profile" : "-p, --profile <DEVICE_PROFILE> @TAB@ Specify a device profile to configure for CLI",
         "profile-details" : "-c, --profile-details @TAB@ Display current configured profile",
         "help" : "-h, --help @TAB@ Display this help",

package/files/help/ares-device.help

@@ -26,12 +26,22 @@
             "The file format can be \".png\", \".jpg\" and \".bmp\". \".png\" is default.",
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+        ],
+        "apollo" : [
+            "",
+            "And This command supports screen capture.",
+            "",
+            "CAPTURE_FILE is file name or file path of capture file.",
+            "The file format can be \".png\", \".jpg\" and \".bmp\". \".png\" is default.",
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
         ]
     },
     "options" : {
         "cmdOpt":"option",
         "default" : ["system", "resource", "list", "id-filter", "interval", "save"],
         "ose" : ["capture", "display", "device", "device-list", "help", "version", "verbose", "level"],
+        "apollo" : ["capture", "display", "device", "device-list", "help", "version", "verbose", "level"],
         "tv" : ["device", "device-list", "help", "version", "verbose"],
         "system" : "-i, --system-info @TAB@ Display the system information",
         "session" : "-se, --session-info @TAB@ Display the session information",
@@ -89,6 +99,11 @@
             "# Capture the screen of display 1 as screen.png",
             "ares-device -c screen.png -dp 1 -d DEVICE",
             ""
+        ],
+        "apollo" : [
+            "# Capture the screen of display as screen.png",
+            "ares-device -c screen.png -d DEVICE",
+            ""
         ]
     }
 }

package/files/help/ares-generate.help

@@ -23,12 +23,17 @@
           "ose" : [
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ],
+          "apollo" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
           ]
         }
     ],
     "examples" : [
         {
-            "default" : [
+            "default":[],
+            "ose" : [
                 "# Create a webOS app in ~/project/app and set the id, version, title",
                 "ares-generate -t webapp -p \"{'id':'com.domain.app', 'version':'1.0.0', 'title':'First App'}\" ~/projects/app",
                 " Or",
@@ -37,6 +42,26 @@
                 "# Create a webOS service named 'com.domain.app.service'",
                 "ares-generate -t js_service -s \"com.domain.app.service\" ~/projects/service",
                 ""
+            ],
+             "apollo" : [
+                "# Create a webOS app in ~/project/app and set the id, version, title",
+                "ares-generate -t webapp -p \"{'id':'com.domain.app', 'version':'1.0.0', 'title':'First App'}\" ~/projects/app",
+                " Or",
+                "ares-generate -t webapp -p \"id=com.domain.app\" -p \"version=1.0.0\" -p \"title=First App\" ~/projects/app",
+                "",
+                "# Create a webOS service named 'com.domain.app.service'",
+                "ares-generate -t js_service -s \"com.domain.app.service\" ~/projects/service",
+                ""
+            ],
+            "tv" : [
+                "# Create a webOS app in ~/project/app and set the id, version, title",
+                "ares-generate -t basic -p \"{'id':'com.domain.app', 'version':'1.0.0', 'title':'First App'}\" ~/projects/app",
+                " Or",
+                "ares-generate -t basic -p \"id=com.domain.app\" -p \"version=1.0.0\" -p \"title=First App\" ~/projects/app",
+                "",
+                "# Create a webOS service named 'com.domain.app.service'",
+                "ares-generate -t js_service -s \"com.domain.app.service\" ~/projects/service",
+                ""
             ]
         }
     ],
@@ -44,6 +69,7 @@
         "cmdOpt":"option",
         "default" : ["template", "list", "property", "servicename", "overwrite", "help", "version", "verbose"],
         "ose" : ["level"],
+        "apollo" : ["level"],
         "template" : [
             "-t, --template <TEMPLATE> @TAB@ Use the template named TEMPLATE"
         ],

package/files/help/ares-inspect.help

@@ -4,6 +4,7 @@
     "notab":["examples", "extraexample"],
     "name" : {
         "ose" : "ares-inspect - Enable Web Inspector or Node's Inspector for webOS web app or service",
+        "apollo" : "ares-inspect - Enable Web Inspector or Node's Inspector for webOS web app or service",
         "tv" : "ares-inspect - Provide URL to use Remote Web Inspector or Node Inspector"
     },
     "synopsis" : {
@@ -23,6 +24,10 @@
           "ose" : [
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ],
+          "apollo" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
           ]
         }
     ],
@@ -30,6 +35,7 @@
         "cmdOpt":"option",
         "default" : ["open", "device", "device-list", "help", "version", "verbose"],
         "ose" : ["display", "level"],
+        "apollo" : ["display", "level"],
         "open" : "-o, --open @TAB@ Open url with a web browser",
         "device" : [
             "-d, --device <DEVICE> @TAB@ Specify DEVICE to use",

package/files/help/ares-install.help

@@ -19,6 +19,10 @@
           "ose" : [
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ],
+          "apollo" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
           ]
         }
     ],
@@ -40,6 +44,7 @@
         "cmdOpt":"option",
         "default" : ["device", "device-list", "list", "listfull", "type", "help", "version", "verbose"],
         "ose" : ["level"],
+        "apollo" : ["level"],
         "device" : [
             "-d, --device <DEVICE> @TAB@ Specify DEVICE to use",
             "@TAB@ If not specified, set to default device"

package/files/help/ares-launch.help

@@ -30,6 +30,10 @@
         "",
         "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
         ],
+        "apollo" : [
+        "",
+        "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+        ],
         "tv" : [
         "",
         "If 'hosted' option does not work with network connection error,",
@@ -41,6 +45,7 @@
         "cmdOpt":"option",
         "default" : ["running", "close", "params"],
         "ose" : ["hosted", "display", "device", "device-list", "help", "version", "verbose", "level"],
+        "apollo" : ["hosted", "device", "device-list", "help", "version", "verbose", "level"],
         "tv" : ["device", "device-list", "help", "version", "verbose"],
         "device" : [
             "-d, --device <DEVICE> @TAB@ Specify DEVICE to use",

package/files/help/ares-server.help

@@ -10,6 +10,7 @@
         "cmdOpt":"option",
         "default" : ["port", "open","help", "version", "verbose"],
         "ose" : ["level"],
+        "apollo" : ["level"],
         "port" : "-p, --port <PORT> @TAB@ Specify port to use [default:random]",
         "open" : "-o, --open @TAB@ Open localhost url with a web browser",
         "help" : "-h, --help @TAB@ Display this help",
@@ -25,6 +26,10 @@
           "ose" : [
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ],
+          "apollo" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
           ]
         }
     ],

package/files/help/ares-setup-device.help

@@ -32,6 +32,24 @@
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
           ],
+          "apollo": [
+            "This command manages the information of the devices.",
+            "",
+              "** Attributes of DEVICE_INFO **",
+              "  description [string]   description of target device",
+              "  host        [string]   ip address",
+              "  port        [string]   port number",
+              "  username    [string]   user name to connect ('developer')",
+              "  privatekey  [string]   ssh private key file name",
+              "                         ssh private key should exist under $HOME/.ssh/",
+              "  password    [string]   password for ssh connection",
+              "  default     [boolean]  set default device with 'add' option",
+            "",
+            "This command can set a default device.",
+            "If you don't specify a target device, the default device is used as the target device.",
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ],
           "tv": [
             "This command manages the information of the devices.",
             "",
@@ -77,6 +95,28 @@
             "ares-setup-device -m DEVICE -i \"password=\"",
             ""
           ],
+          "apollo" : [
+            "",
+            "# Add a DEVICE and set the username, host, port",
+            "ares-setup-device -a DEVICE -i \"{'username':'root', 'host':'127.0.0.1','port':'22'}\"",
+            " Or",
+            "ares-setup-device -a DEVICE -i \"username=root\" -i \"host=127.0.0.1\" -i \"port=22\"",
+            "",
+            "# Modify the information of the DEVICE",
+            "ares-setup-device -m DEVICE -i \"{'username':'developer','host':'192.168.0.123'}\"",
+            " Or",
+            "ares-setup-device -m DEVICE -i \"username=developer\" -i \"host=192.168.0.123\"",
+            "",
+            "# Remove the DEVICE",
+            "ares-setup-device -r DEVICE",
+            "",
+            "# Set default the DEVICE",
+            "ares-setup-device -f DEVICE",
+            "",
+            "# Change the ssh password of the DEVICE as an empty value",
+            "ares-setup-device -m DEVICE -i \"password=\"",
+            ""
+          ],
           "tv" : [
             "",
             "# Add a DEVICE and set the username, host, port",

package/files/help/ares.help

@@ -18,6 +18,10 @@
           "ose" : [
             "",
             "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ],
+          "apollo" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
           ]
         }
     ],
@@ -33,6 +37,7 @@
         "cmdOpt":"option",
         "default" : ["list", "<COMMAND>", "help", "version"],
         "ose" : ["verbose", "level"],
+        "apollo" : ["verbose", "level"],
         "list" : [
             "-l, --list @TAB@ List all the ares commands"
         ],

package/files/schema/NovacomDevices.schema

@@ -16,7 +16,8 @@
         "profile": {
             "enum": [
                 "ose",
-                "tv"
+                "tv",
+                "apollo"
             ],
             "description": "webOS Device Type"
         },

package/files/templates/apollo-sdk-templates/appinfo/appinfo.json

@@ -0,0 +1,10 @@
+{
+    "id": "com.domain.app",
+    "version": "1.0.0",
+    "vendor": "My Company",
+    "type": "web",
+    "main": "index.html",
+    "title": "new app",
+    "icon": "icon.png",
+    "requiredPermissions": ["time.query", "activity.operation"]
+}

package/files/templates/apollo-sdk-templates/bootplate-web/index.html

@@ -0,0 +1,88 @@
+<!--
+Copyright (c) 2020-2024 LG Electronics Inc.
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<!DOCTYPE html>
+<html>
+<head>
+<title>Example Web App</title>
+<style type="text/css">
+    body {
+        width: 100%;
+        height: 100%;
+        background-color:#202020;
+    }
+    div {
+        position:absolute;
+        height:100%;
+        width:100%;
+        display: table;
+    }
+    h1 {
+        display: table-cell;
+        vertical-align: middle;
+        text-align:center;
+        color:#FFFFFF;
+    }
+</style>
+<script type="text/javascript">
+window.onload = function() {
+    var bridge = new WebOSServiceBridge();
+    /*
+     *  getTimeApi calls gettime of systemservice, a module in the platform.
+     */
+    var getTimeApi = 'luna://com.webos.service.systemservice/clock/getTime';
+    var getTimeParams = '{}';
+
+    /*
+     *  helloApi calls the hello method of js_service template provided by CLI.
+     *  In this case, the service name is used as default name "com.domain.app.service" is.
+     *  If you change this service name, you need to change the service name of the following API.
+     *
+     *  If you change the name to helloParmas as you want, the contents will be reflected on the screen.
+     */
+    var helloApi = 'luna://com.domain.app.service/hello';
+    var helloParams = '{"name":"webOS"}';
+
+    function getTime_callback(msg){
+        var arg = JSON.parse(msg);
+        if (arg.returnValue) {
+            console.log("[APP_NAME: example web app] GETTIME_SUCCESS UTC : " + arg.utc);
+            //webOSSystem.PmLogString(6, "GETTIME_SUCCESS", '{"APP_NAME": "example web app"}', "UTC : " + arg.utc);
+        }
+        else {
+            console.error("[APP_NAME: example web app] GETTIME_FAILED errorText : " + arg.errorText);
+            //webOSSystem.PmLogString(3, "GETTIME_FAILED", '{"APP_NAME": "example web app"}', "errorText : " + arg.errorText);
+        }
+    }
+
+    function hello_callback(msg){
+        var arg = JSON.parse(msg);
+        if (arg.returnValue) {
+            document.getElementById("txt_msg").innerHTML = arg.Response;
+            console.log("[APP_NAME: example web app] CALLHELLO_SUCCESS response : " + arg.Response);
+            //webOSSystem.PmLogString(6, "CALLHELLO_SUCCESS", '{"APP_NAME": "example web app"}', "response : " + arg.Response);
+        }
+        else {
+            console.error("[APP_NAME: example web app] CALLHELLO_FAILED errorText : " + arg.errorText);
+            //webOSSystem.PmLogString(3, "CALLHELLO_FAILED", '{"APP_NAME": "example web app"}', "errorText : " + arg.errorText);
+        }
+    }
+
+    bridge.onservicecallback = getTime_callback;
+    bridge.call(getTimeApi, getTimeParams);
+    document.getElementById("txt_msg").onclick = function() {
+        bridge.onservicecallback = hello_callback;
+        bridge.call(helloApi, helloParams);
+    };
+}
+</script>
+</head>
+<body>
+    <div>
+        <h1 id="txt_msg">Hello, Web Application!!</h1>
+    </div>
+</body>
+</html>

package/files/templates/apollo-sdk-templates/hosted-webapp/index.html

@@ -0,0 +1,14 @@
+<!--
+Copyright (c) 2020-2024 LG Electronics Inc.
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+<!DOCTYPE html>
+<html>
+<head>
+    <script>location.href='http://webosose.org/';</script>
+</head>
+<body>
+</body>
+</html>

package/files/templates/apollo-sdk-templates/js-service/helloclient.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2020-2024 LG Electronics Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// helloclient.js
+// Subscribe & cancel subscription to helloService's heartbeat method
+const Service = require('webos-service');
+
+const service = new Service("com.example.helloclient"); // Register com.example.helloworld
+
+console.log("simple call");
+// Change @SERVICE-NAME@ to real service name
+service.call("luna://@SERVICE-NAME@/hello", {}, function(message) {
+    console.log("call @SERVICE-NAME@/hello");
+    console.log("message payload: " + JSON.stringify(message.payload));
+    const sub = service.subscribe("luna://@SERVICE-NAME@/heartbeat", {subscribe: true});
+    const max = 10;
+    let count = 0;
+    sub.addListener("response", function(msg) {
+        console.log(JSON.stringify(msg.payload));
+        if (++count >= max) {
+            sub.cancel();
+            setTimeout(function() {
+                console.log(max+" responses received, exiting...");
+                process.exit(0);
+            }, 1000);
+        }
+    });
+});