Add support for W3C Web of Things (WoT) Thing Description

README.md

@@ -1,3 +1,4 @@
+
 # Node generator for Node-RED
 
 Node generator is a command line tool to generate Node-RED nodes based on various sources such as an Open API document or a Function node.
@@ -22,6 +23,8 @@ You may need to run this with `sudo`, or from within an Administrator command sh
     Supported source:
        - Open API document
        - Function node (js file in library, "~/.node-red/lib/function/")
+       - Swagger definition
+       - (Beta) Thing Description of W3C Web of Things (jsonld file or URL that points jsonld file)
 
     Options:
        -o : Destination path to save generated node (default: current directory)
@@ -35,6 +38,8 @@ You may need to run this with `sudo`, or from within an Administrator command sh
        --color : Color for node appearance (format: color hexadecimal numbers like "A6BBCF")
        --tgz : Save node as tgz file
        --help : Show help
+       --wottd : explicitly instruct that source file/URL points a Thing Description
+       --lang : Language negotiation information when retrieve a Thing Description
        -v : Show node generator version
 
 ### Example 1. Create an original node from Open API document
@@ -60,6 +65,28 @@ You may need to run this with `sudo`, or from within an Administrator command sh
 
 -> You can use lower-case node on Node-RED flow editor.
 
+### Example 3. Create original node from Thing Description
+
+- node-red-nodegen example.jsonld
+- cd node-red-contrib-example-thing
+- sudo npm link
+- cd ~/.node-red
+- npm link node-red-contrib-example-thing
+- node-red
+
+-> You can use Example Thing node on Node-RED flow editor.
+
+### Example 4. Create original node from Thing Description via HTTP
+
+- node-red-nodegen http://example.com/td.jsonld --wottd --lang "en-US,en;q=0.5"
+- cd node-red-contrib-example-thing
+- sudo npm link
+- cd ~/.node-red
+- npm link node-red-contrib-example-thing
+- node-red
+
+-> You can use Example Thing node on Node-RED flow editor.
+
 ## Documentation
 - [Use cases](https://github.com/node-red/node-red-nodegen/blob/0.0.4/docs/index.md#use-cases) ([Japanese](https://github.com/node-red/node-red-nodegen/blob/0.0.4/docs/index_ja.md#use-cases))
 - [How to use Node generator](https://github.com/node-red/node-red-nodegen/blob/0.0.4/docs/index.md#how-to-use-node-generator) ([Japanese](https://github.com/node-red/node-red-nodegen/blob/0.0.4/docs/index_ja.md#how-to-use-node-generator))

bin/node-red-nodegen.js

@@ -56,6 +56,8 @@ function help() {
         ' [--color <node color>]' +
         ' [--tgz]' +
         ' [--help]' +
+        ' [--wottd]' +
+        ' [--lang <accept-language>]' +
         ' [-v]\n' +
         '\n' +
         'Description:'.bold + '\n' +
@@ -64,6 +66,8 @@ function help() {
         'Supported source:'.bold + '\n' +
         '   - Open API document\n' +
         // '   - Subflow node (json file of subflow)\n' +
+        '   - Swagger definition\n' +
+        '   - Thing Description (jsonld file or URL that points jsonld file)\n' +
         '   - Function node (js file in library, "~/.node-red/lib/function/")\n' +
         '\n' +
         'Options:\n'.bold +
@@ -78,6 +82,8 @@ function help() {
         '   --color : Color for node appearance (format: color hexadecimal numbers like "A6BBCF")\n' +
         '   --tgz : Save node as tgz file\n' +
         '   --help : Show help\n' +
+        '   --wottd : explicitly instruct source file/URL points a Thing Description\n' +
+        '   --lang : Language negotiation information when retrieve a Thing Description\n' +
         '   -v : Show node generator version\n';
     console.log(helpText);
 }
@@ -87,14 +93,24 @@ function version() {
     console.log(packageJson.version);
 }
 
+function skipBom(body) {
+    if (body[0]===0xEF &&
+        body[1]===0xBB &&
+        body[2]===0xBF) {
+        return body.slice(3);
+    } else {
+        return body;
+    }
+}
+
 if (argv.help || argv.h) {
     help();
 } else if (argv.v) {
     version();
 } else {
     var sourcePath = argv._[0];
     if (sourcePath) {
-        if (sourcePath.startsWith('http://') || sourcePath.startsWith('https://')) {
+        if (!argv.wottd && (sourcePath.startsWith('http://') || sourcePath.startsWith('https://'))) {
             request(sourcePath, function (error, response, body) {
                 if (!error) {
                     data.src = JSON.parse(body);
@@ -107,7 +123,28 @@ if (argv.help || argv.h) {
                     console.error(error);
                 }
             });
-        } else if (sourcePath.endsWith('.json')) {
+        } else if (argv.wottd && (sourcePath.startsWith('http://') || sourcePath.startsWith('https://'))) {
+            const req = {
+                url: sourcePath,
+            }
+            if (argv.lang) {
+                req.headers = {
+                    'Accept-Language': argv.lang
+                }
+            }
+            request(req, function (error, response, body) {
+                if (!error) {
+                    data.src = JSON.parse(skipBom(body));
+                    nodegen.wottd2node(data, options).then(function (result) {
+                        console.log('Success: ' + result);
+                    }).catch(function (error) {
+                        console.log('Error: ' + error);
+                    });
+                } else {
+                    console.error(error);
+                }
+            });
+        } else if (sourcePath.endsWith('.json') && !argv.wottd) {
             data.src = JSON.parse(fs.readFileSync(sourcePath));
             nodegen.swagger2node(data, options).then(function (result) {
                 console.log('Success: ' + result);
@@ -128,6 +165,13 @@ if (argv.help || argv.h) {
             }).catch(function (error) {
                 console.log('Error: ' + error);
             });
+        } else if (sourcePath.endsWith('.jsonld') || argv.wottd) {
+            data.src = JSON.parse(skipBom(fs.readFileSync(sourcePath)));
+            nodegen.wottd2node(data, options).then(function (result) {
+                console.log('Success: ' + result);
+            }).catch(function (error) {
+                console.log('Error: ' + error);
+            });
         } else {
             console.error('error: Unsupported file type');
         }

lib/nodegen.js

@@ -26,6 +26,8 @@ var csv = require('csv-string');
 var CodeGen = require('swagger-js-codegen-formdata').CodeGen;
 var jimp = require("jimp");
 
+var wotutils = require('./wotutils');
+
 function createCommonFiles(templateDirectory, data) {
     "use strict";
     // Make directories
@@ -566,7 +568,194 @@ function swagger2node(data, options) {
     });
 }
 
+
+function wottd2node(data, options) {
+    return when.promise(function (resolve, reject) {
+        let td = data.src;
+
+        // validate TD
+        const validateResult = wotutils.validateTd(td);
+        if (validateResult.result === false) {
+            console.warn(`Invalid Thing Description:\n${validateResult.errorText}`);
+        } else {
+            console.info(`Schema validation succeeded.`);
+        }
+
+        // if name is not specified, use td.title for module name.
+        if (!data.name || data.name === '') {
+            // filtering out special characters
+            data.name = 'wot' + td.title.replace(/[^A-Za-z0-9]/g, '').toLowerCase();
+        }
+
+        if (data.module) {
+            if (data.prefix) {
+                reject('error: module name and prefix are conflicted');
+                return;
+            }
+        } else {
+            if (data.prefix) {
+                data.module = data.prefix + data.name;
+            } else {
+                data.module = 'node-red-contrib-' + data.name;
+            }
+        }
+
+        if (!data.version || data.version === '') {
+            if (td.version && td.version.instance) {
+                data.version = td.version.instance;
+            } else {
+                data.version = '0.0.1';
+            }
+        }
+
+        data.tdstr = JSON.stringify(td);
+        td = wotutils.normalizeTd(td);
+        td = wotutils.filterFormTd(td);
+        data.normtd = JSON.stringify(td);
+        data.properties = [];
+        const rwo = {};
+        for (const p in td.properties) {  // convert to array
+            if (td.properties.hasOwnProperty(p)) {
+                const q = td.properties[p];
+                q.name = p;
+                if (!q.title || q.title === '') {
+                    q.title = q.name;
+                }
+                if (q.forms) {
+                    for (var i = 0; i < q.forms.length; i++) {
+                        q.forms[i].index = i;
+                    }
+                }
+                data.properties.push(q);
+                rwo[p] = {
+                    readable: !q.writeOnly,
+                    writable: !q.readOnly,
+                    observable: q.observable
+                };
+
+            }
+        }
+        data.actions = [];
+        for (const a in td.actions) { 
+            if (td.actions.hasOwnProperty(a)) {
+                const q = td.actions[a];
+                q.name = a;
+                if (!q.title || q.title === '') {
+                    q.title = q.name;
+                }
+                if (q.forms) {
+                    for (var i = 0; i < q.forms.length; i++) {
+                        q.forms[i].index = i;
+                    }
+                }
+                data.actions.push(q);
+            }
+        }
+        data.events = [];
+        for (const e in td.events) {
+            if (td.events.hasOwnProperty(e)) {
+                const q = td.events[e];
+                q.name = e;
+                if (!q.title || q.title === '') {
+                    q.title = q.name;
+                }
+                if (q.forms) {
+                    for (var i = 0; i < q.forms.length; i++) {
+                        q.forms[i].index = i;
+                    }
+                }
+                data.events.push(q);
+            }
+        }
+
+        const wotmeta = [];
+        if (td.hasOwnProperty('lastModified')) { 
+            wotmeta.push({name: "lastModified", value: td.lastModified}); 
+        }
+        if (td.hasOwnProperty('created')) { 
+            wotmeta.push({name: "created", value: td.created}); 
+        }
+        if (td.hasOwnProperty('support')) { 
+            wotmeta.push({name: "support", value: JSON.stringify(td.support)}); 
+        }
+        if (td.hasOwnProperty("id")) {
+            wotmeta.push({name: "id", value: td.id, last: true});
+        }
+
+        const formsel = wotutils.makeformsel(td);
+
+        data.genformsel = JSON.stringify(formsel);
+        data.genproprwo = JSON.stringify(rwo);
+
+        data.ufName = td.title.replace(/[^A-Za-z0-9]/g, ' ').trim();
+        data.nodeName = data.name;
+        data.projectName = data.module;
+        data.projectVersion = data.version;
+        data.keywords = extractKeywords(data.keywords);
+        data.category = data.category || 'Web of Things';
+        data.description = td.description;
+        data.licenseName = 'Apache-2.0';
+        data.licenseUrl = '';
+        data.links = td.links;
+        data.support = td.support;
+        data.iconpath = wotutils.woticon(td);
+        data.wotmeta = wotmeta;
+
+        let lang = null;
+        if (td.hasOwnProperty('@context') && Array.isArray(td['@context'])) {
+            td['@context'].forEach(e => {
+                if (e.hasOwnProperty("@language")) {
+                    lang = e['@language'];
+                }
+            });
+        }
+        if (lang === null) {
+            data.textdir = "auto";
+        } else {
+            data.textdir = wotutils.textDirection(lang);
+        }
+
+        createCommonFiles(path.join(__dirname, '../templates/webofthings'), data);
+
+        // Create package.json
+        const packageTemplate = fs.readFileSync(path.join(__dirname, '../templates/webofthings/package.json.mustache'), 'utf-8');
+        const packageSourceCode = mustache.render(packageTemplate, data);
+        fs.writeFileSync(path.join(data.dst, data.module, 'package.json'), packageSourceCode);
+
+        // Create node.js
+        const nodeTemplate = fs.readFileSync(path.join(__dirname, '../templates/webofthings/node.js.mustache'), 'utf-8');
+        let nodeSourceCode = mustache.render(nodeTemplate, data);
+        if (options.obfuscate) {
+            nodeSourceCode = obfuscator.obfuscate(nodeSourceCode, { stringArrayEncoding: 'rc4' });
+        }
+        fs.writeFileSync(path.join(data.dst, data.module, 'node.js'), nodeSourceCode);
+
+        // Create node.html
+        const htmlTemplate = fs.readFileSync(path.join(__dirname, '../templates/webofthings/node.html.mustache'), 'utf-8');
+        const htmlSourceCode = mustache.render(htmlTemplate, data);
+        fs.writeFileSync(path.join(data.dst, data.module, 'node.html'), htmlSourceCode);
+
+        // Create README.html
+        const readmeTemplate = fs.readFileSync(path.join(__dirname, '../templates/webofthings/README.md.mustache'), 'utf-8');
+        const readmeSourceCode = mustache.render(readmeTemplate, data);
+        fs.writeFileSync(path.join(data.dst, data.module, 'README.md'), readmeSourceCode);
+
+        // Create LICENSE
+        const licenseTemplate = fs.readFileSync(path.join(__dirname, '../templates/webofthings/LICENSE.mustache'), 'utf-8');
+        const licenseSourceCode = mustache.render(licenseTemplate, data);
+        fs.writeFileSync(path.join(data.dst, data.module, 'LICENSE'), licenseSourceCode);
+
+        if (options.tgz) {
+            runNpmPack(data);
+            resolve(path.join(data.dst, data.module + '-' + data.version + '.tgz'));
+        } else {
+            resolve(path.join(data.dst, data.module));
+        }
+    });
+}
+
 module.exports = {
     function2node: function2node,
-    swagger2node: swagger2node
+    swagger2node: swagger2node,
+    wottd2node: wottd2node
 };