Merge pull request #36 from Linkurious/develop

Release 1.0.8 [ci:run]

Author: andre91a

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.7
+current_version = 1.0.8
 commit = False
 tag = False
 serialize = 

.version

@@ -1 +1 @@
-1.0.7
+1.0.8

README.md

@@ -38,7 +38,8 @@ This plugin supports the following URL parameters in the query string:
 
 | Param | Type | Description | Example |
 | :-- | :-- | :-- | :-- |
-| `queryId`                     | integer (**required**)  | ID of the query to run. | `queryId=87` |
+| `queryId`                     | integer (**required**, forbidden if `queryName` is used)  | ID of the query to run. | `queryId=87` |
+| `queryName`                   | string (**required**, forbidden if `queryId` is used)  | Name of the query to run. | `queryName=getTransactions` |
 | `sourceKey`                   | string (**required**)   | Key of the data-source to run the query on. | `sourceKey=b16e9ed5` |
 | `limit`                       | integer (**optional**)  | Maximum number of results to display. | `limit=500` |
 | `param_number_{{Encoded field name}}` | number (**optional**)   | *For query templates*, any numerical parameter of the template. | `param_number_age=30` |

backend/routeHandler.js

@@ -74,9 +74,53 @@ module.exports = function configureRoutes(options) {
     res.send(JSON.stringify(query));
   });
 
+  options.router.post('/getQueryByName', async (req, res) => {
+    try {
+    // Checking templates
+      const getQueryParams = {
+        sourceKey: req.body.sourceKey,
+        type: "template"
+      };
+
+      let response = (await options.getRestClient(req).graphQuery.getQueries(getQueryParams));
+
+      let queries = response.body.filter((q) => {
+        return q.name.toLowerCase() === req.body.name.toLowerCase();
+      });
+
+      // Checking statics
+      getQueryParams.type = "static"
+
+      response = (await options.getRestClient(req).graphQuery.getQueries(getQueryParams));
+
+      queries = queries.concat(response.body.filter((q) => {
+        return q.name.toLowerCase() === req.body.name.toLowerCase();
+      }));
+
+      if (queries.length === 0) {
+        throw new Error(`Query ${req.body.name} either does not exist or you do not have access to it.`);
+      }
+      else if (queries.length === 1) {
+        response.body = queries[0]
+        res.status(200);
+        res.contentType('application/json');
+        res.send(JSON.stringify({body: queries[0]}));
+      }
+      else {
+        throw new Error(`Multiple queries named ${req.body.name} exist. The query name must be unique.`);
+      }
+    } catch (error) {
+      res.status(400);
+      res.contentType('application/json');
+      res.send(JSON.stringify({ status: 400, body: { error: {message: error.message } }}));
+    }
+
+  });
+
+
   options.router.post('/runQueryByIDPlugin', async (req, res) => {
     const data = {
-      id: +req.body.queryParams.global.queryId,
+      id: +req.body.query.id,
       sourceKey: req.body.queryParams.global.sourceKey,
       limit: +req.body.queryParams.global.limit
     };

manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "data-table",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "pluginApiVersion": "1.0.0",
   "publicRoute": "public",
   "singlePageAppIndex": "index.html",

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkurious/lke-plugin-data-table",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Data-table plugin for Linkurious Enterprise",
   "main": "index.js",
   "homepage": "https://github.com/Linkurious/lke-plugin-data-table#readme",

package.json

@@ -137,7 +137,8 @@ function getParameter(item) {
         oneOf: [
             'sourceKey',
             'limit',
-            'queryId'
+            'queryId',
+            'queryName'
         ],
         startWith: [
             'param_number_',
@@ -187,12 +188,14 @@ function validateTemplateFieldsParams(query) {
  * @returns {boolean|void}
  */
 function validateGlobalQueryParams(params) {
-    if (params.queryId === undefined) {
-        return handleError({body: {message: 'Missing URL parameter “query_id”'}});
-    } else if (!Number.isInteger(+params.queryId)) {
-        return handleError({body: {message: 'URL parameter “query_id” must be a number'}});
+    if (params.queryId === undefined && params.queryName === undefined) {
+        return handleError({body: {message: 'Missing URL parameter: a “queryId” (number) or a “queryName” (string) is mandatory'}});
+    } else if (params.queryId !== undefined && params.queryName !== undefined) {
+        return handleError({body: {message: 'Only one query parameter is allowed: impossible to use “queryId” and “queryName” at the same moment'}});
+    } else if (params.queryId !== undefined && !Number.isInteger(+params.queryId)) {
+        return handleError({body: {message: 'URL parameter “queryId” must be a number'}});
     } else if (params.sourceKey === undefined) {
-        return handleError({body: {message: 'Missing URL parameter “source_key” (must be a string)'}});
+        return handleError({body: {message: 'Missing URL parameter “sourceKey” (must be a string)'}});
     }
     return true;
 }
@@ -682,14 +685,26 @@ function escapeDotCharacters(value) {
  */
 async function getQuery() {
     try {
-        return await makeRequest(
-            'POST',
-            `api/getQuery`,
-            {
-                id: queryParams.global.queryId,
-                sourceKey: queryParams.global.sourceKey
-            }
-        );
+        if (queryParams.global.queryId !== undefined){
+            return await makeRequest(
+                'POST',
+                `api/getQuery`,
+                {
+                    id: queryParams.global.queryId,
+                    sourceKey: queryParams.global.sourceKey
+                }
+            );    
+        } else {
+            return await makeRequest(
+                'POST',
+                `api/getQueryByName`,
+                {
+                    name: queryParams.global.queryName,
+                    sourceKey: queryParams.global.sourceKey
+                }
+            );
+        }
+        
     } catch(e) {
         handleError(e);
     }