Merge pull request #292 from Anonym-tsk/rest_api

Remote Control REST API improvements

Author: KristjanESPERANTO

API/api.js

@@ -73,19 +73,17 @@ module.exports = {
                 let modActions = getActions(Module.notificationHandler[mod.module]);
 
                 if (modActions.length > 0) {
-                    let pathGuess = mod.module.replace(/MMM-/g, '').replace(/-/g, '').toLowerCase();
-
                     // Generate formatted actions object
                     let actionsGuess = {};
 
                     modActions.forEach(a => {
                         actionsGuess[a.replace(/[-_]/g, '').toLowerCase()] = { notification: a, guessed: true };
                     });
 
-                    if (pathGuess in this.externalApiRoutes) {
-                        this.externalApiRoutes[pathGuess].actions = Object.assign({}, actionsGuess, this.externalApiRoutes[pathGuess].actions);
+                    if (mod.module in this.externalApiRoutes) {
+                        this.externalApiRoutes[mod.module].actions = Object.assign({}, actionsGuess, this.externalApiRoutes[mod.module].actions);
                     } else {
-                        this.externalApiRoutes[pathGuess] = {
+                        this.externalApiRoutes[mod.module] = {
                             module: mod.module,
                             path: mod.module.replace(/MMM-/g, '').replace(/-/g, '').toLowerCase(),
                             actions: actionsGuess
@@ -326,12 +324,12 @@ module.exports = {
         let extApiRoutes = this.externalApiRoutes;
         let modules = this.configData.moduleData
         let query = {success: true, data: []};
-        
+
         modules.forEach((mod) => {
             if (extApiRoutes[mod.name] === undefined) {
                 query.data.push(mod);
             } else {
-                query.data.push(Object.assign({},mod, {actions: extApiRoutes[mod.name].actions}));
+                query.data.push(Object.assign({}, mod, {actions: extApiRoutes[mod.name].actions, urlpath: extApiRoutes[mod.name].path}));
             }
         });
 
@@ -341,7 +339,7 @@ module.exports = {
     answerModuleApi(req, res) {
         if (!this.checkInitialized(res)) { return; }
         let dataMerged = this.mergeData().data
-        
+
         if (!req.params.moduleName) {
             res.json({ success: true, data: dataMerged });
             return;
@@ -350,7 +348,8 @@ module.exports = {
         let modData = [];
         if(req.params.moduleName !== 'all') {
             modData = dataMerged.filter(m => {
-                return (req.params.moduleName.includes(m.identifier));
+                const name = req.params.moduleName;
+                return name.includes(m.identifier) || name.includes(m.name) || name.includes(m.urlpath);
             });
             if (!modData.length) {
                 modData = dataMerged.filter(m => {
@@ -493,26 +492,26 @@ module.exports = {
             icon: "window-restore",
             items: []
         };
-        Object.keys(this.externalApiRoutes).forEach(r => {
+        Object.values(this.externalApiRoutes).forEach(r => {
             let sub = {
-                id: "mc-" + r,
+                id: "mc-" + r.path,
                 type: "menu",
                 icon: "bars",
-                text: this.formatName(this.externalApiRoutes[r].module),
+                text: this.formatName(r.module),
                 items: []
             };
-            Object.keys(this.externalApiRoutes[r].actions).forEach(a => {
+            Object.keys(r.actions).forEach(a => {
                 let item = {
-                    id: `mc-${r}-${a}`,
+                    id: `mc-${r.path}-${a}`,
                     menu: "item",
                     icon: "dot-circle-o",
                     action: "NOTIFICATION",
-                    content: this.externalApiRoutes[r].actions[a]
+                    content: r.actions[a]
                 };
-                if ("prettyName" in this.externalApiRoutes[r].actions[a]) {
-                    item.text = this.translate(this.externalApiRoutes[r].actions[a].prettyName);
+                if ("prettyName" in r.actions[a]) {
+                    item.text = this.translate(r.actions[a].prettyName);
                 } else {
-                    item.text = this.translate(this.externalApiRoutes[r].actions[a].notification).toLowerCase().replace(/(^|_)(\w)/g, function($0, $1, $2) {
+                    item.text = this.translate(r.actions[a].notification).toLowerCase().replace(/(^|_)(\w)/g, function($0, $1, $2) {
                         return ($1 && ' ') + $2.toUpperCase();
                     });
                 }

MMM-Remote-Control.js

@@ -270,6 +270,7 @@ Module.register("MMM-Remote-Control", {
             let modData = Object.assign({}, module.data);
             modData.hidden = module.hidden;
             modData.lockStrings = module.lockStrings;
+            modData.urlpath = module.name.replace(/MMM-/g, '').replace(/-/g, '').toLowerCase();
             modData.config = module.config;
             currentModuleData.push(modData);
         });

node_helper.js

@@ -83,9 +83,9 @@ module.exports = NodeHelper.create(Object.assign({
 
 		loadTimers() {
             let delay = 24*3600;
-            
+
             let self = this;
-            
+
             clearTimeout(this.delayedQueryTimers['update'])
             this.delayedQueryTimers['update'] = setTimeout(function () {
             	self.updateModuleList();
@@ -716,7 +716,7 @@ module.exports = NodeHelper.create(Object.assign({
             }
             if (query.action === "COMMAND") {
                 if (this.thisConfig.customCommand && this.thisConfig.customCommand[query.command]) {
-                    exec(this.thisConfig.customCommand[query.command], opts, (error, stdout, stderr) => { 
+                    exec(this.thisConfig.customCommand[query.command], opts, (error, stdout, stderr) => {
                         self.checkForExecError(error, stdout, stderr, res, { stdout: stdout });
                     });
                 } else {
@@ -859,7 +859,7 @@ module.exports = NodeHelper.create(Object.assign({
                 return;
             }
             if (query.action === "DELAYED") {
-                /* Expects a nested query object 
+                /* Expects a nested query object
                  *   {
                  *       action: "DELAYED",
                  *       did: "SOME_UNIQUE_ID",
@@ -959,7 +959,7 @@ module.exports = NodeHelper.create(Object.assign({
                     }
                 });
             });
-            
+
         },
 
         checkForExecError(error, stdout, stderr, res, data) {
@@ -1019,6 +1019,7 @@ module.exports = NodeHelper.create(Object.assign({
                 simpleModuleData[k].identifier = moduleData[k].identifier;
                 simpleModuleData[k].hidden = moduleData[k].hidden;
                 simpleModuleData[k].lockStrings = moduleData[k].lockStrings;
+                simpleModuleData[k].urlpath = moduleData[k].urlpath;
             }
 
             let text = JSON.stringify({
@@ -1153,7 +1154,7 @@ module.exports = NodeHelper.create(Object.assign({
                 }
                 let backupPath = path.resolve("config/config.js.backup" + iteration);
             	let req = require(backupPath)
-            	
+
             	this.answerPost({ data: "config" }, { body: req }, { isSocket: true });
             }
             if (notification === "NEW_CONFIG") {
@@ -1176,10 +1177,10 @@ module.exports = NodeHelper.create(Object.assign({
             if (notification === "REGISTER_API") {
                 if ("module" in payload) {
                     if ("actions" in payload && payload.actions !== {}) {
-                        this.externalApiRoutes[payload.path] = payload;
+                        this.externalApiRoutes[payload.module] = payload;
                     } else {
                         // Blank actions means the module has requested to be removed from API
-                        delete this.externalApiRoutes[payload.path];
+                        delete this.externalApiRoutes[payload.module];
                     }
                     this.updateModuleApiMenu();
                 }