Merge pull request #50 from Linkurious/develop

Release 1.0.11 [ci:run]

Author: gmasclet

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.10
+current_version = 1.0.11
 commit = False
 tag = False
 serialize = 

.version

@@ -1 +1 @@
-1.0.10
+1.0.11

Jenkinsfile

@@ -3,6 +3,7 @@
 nodeJob {
   // General
   projectName = "linkurious/lke-plugin-data-table"
+  podTemplateNames = ['jnlp-agent-node']
   runUnitTests = false
   runE2eTests = false
 

README.md

@@ -38,7 +38,7 @@ This plugin supports the following URL parameters in the query string:
 
 | Param | Type | Description | Example |
 | :-- | :-- | :-- | :-- |
-| `queryId`                     | integer (**required**, forbidden if `queryName` is used)  | ID of the query to run. | `queryId=87` |
+| `queryId`                     | integer, short UUID or UUID (**required**, forbidden if `queryName` is used)  | ID of the query to run. | `queryId=61b338b0` |
 | `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` |
@@ -52,10 +52,10 @@ This plugin supports the following URL parameters in the query string:
 In order to display the result of a standard query in a table:
 
 1. Create a standard READ query. For example: `MATCH (n) return n LIMIT 1000`.
-2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=87`.
+2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=61b338b0`.
 3. Compose a valid data-table plugin URL and open it in a new tab. For example:
 ```
-{{baseUrl}}plugins/table?queryId=87&sourceKey={{sourceKey}}
+{{baseUrl}}plugins/table?queryId=61b338b0&sourceKey={{sourceKey}}
 ```
 You can save this URL as a [Custom Action](https://doc.linkurio.us/user-manual/latest/custom-actions/), and when triggered, the `{{baseUrl}}` and `{{sourceKey}}` will be replaced with your LKE base URL and your current data-source key, respectively, and the final URL will be opened in a new tab. You can always do it manually, if you want.
 
@@ -64,11 +64,11 @@ You can save this URL as a [Custom Action](https://doc.linkurio.us/user-manual/l
 In order to display the result of a query template in a table:
 
 1. Create a READ query template. For example: `MATCH (n) where n.city={{"City Name":string}} return n LIMIT 1000`.
-2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=19`.
+2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=bf450812`.
 2. Note down each field title, [URL encode it](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent), prepend it with a valid URL parameter and give it a value. For example: `param_string_City%20Name=Paris`.
 3. Compose a valid data-table plugin URL and open it in a new tab. For example:
 ```
-{{baseUrl}}plugins/table?queryId=19&sourceKey={{sourceKey}}&param_string_City%20Name=Paris
+{{baseUrl}}plugins/table?queryId=bf450812&sourceKey={{sourceKey}}&param_string_City%20Name=Paris
 ```
 You can save this URL as a [Custom Action](https://doc.linkurio.us/user-manual/latest/custom-actions/), and when triggered, the `{{baseUrl}}` and `{{sourceKey}}` will be replaced with your LKE base URL and your current data-source key, respectively, and the final URL will be opened in a new tab. You can always do it manually if you want.
 

backend/routeHandler.js

@@ -65,7 +65,7 @@ module.exports = function configureRoutes(options) {
 
   options.router.post('/getQuery', async (req, res) => {
     const getQueryParams = {
-      id: +req.body.id,
+      id: req.body.id,
       sourceKey: req.body.sourceKey
     };
     const query = await options.getRestClient(req).graphQuery.getQuery(getQueryParams);

manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "data-table",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "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.10",
+  "version": "1.0.11",
   "description": "Data-table plugin for Linkurious Enterprise",
   "main": "index.js",
   "homepage": "https://github.com/Linkurious/lke-plugin-data-table#readme",

package.json

@@ -199,14 +199,35 @@ function validateGlobalQueryParams(params) {
         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.queryId !== undefined && !Number.isInteger(+params.queryId) && !isUuid(params.queryId) && !isShortUuid(params.queryId)) {
+        return handleError({body: {message: 'URL parameter “queryId” must be an integer, a UUID or a short UUID'}});
     } else if (params.sourceKey === undefined) {
         return handleError({body: {message: 'Missing URL parameter “sourceKey” (must be a string)'}});
     }
     return true;
 }
 
+/**
+ * Return true if the supplied value is a valid RFC4122 UUID.
+ */
+function isUuid(value) {
+  if (typeof value !== 'string') {
+    return false;
+  }
+  return value === '00000000-0000-0000-0000-000000000000' || /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(value);
+}
+
+/**
+ * Return true if the supplied value is a short UUID, which corresponds to the leftmost eight
+ * hexadecimal characters of a regular UUID.
+ */
+function isShortUuid(value) {
+  if (typeof value !== 'string') {
+    return false;
+  }
+  return /^[0-9a-f]{8}$/i.test(value);
+}
+
 /**
  * set the schema
  * @param result