Merge pull request #1587 from jonking-ajar/feat/jsonata-operation

Author: a3957273

package-lock.json

@@ -140,6 +140,7 @@
     "js-sha3": "^0.9.3",
     "jsesc": "^3.0.2",
     "json5": "^2.2.3",
+    "jsonata": "^2.0.3",
     "jsonpath-plus": "^9.0.0",
     "jsonwebtoken": "8.5.1",
     "jsqr": "^1.4.0",

package.json

@@ -369,6 +369,7 @@
             "Regular expression",
             "XPath expression",
             "JPath expression",
+            "Jsonata Query",
             "CSS selector",
             "Extract EXIF",
             "Extract ID3",

src/core/config/Categories.json

@@ -0,0 +1,65 @@
+/**
+ * @author Jon K ([email protected])
+ * @copyright Crown Copyright 2016
+ * @license Apache-2.0
+ */
+
+import jsonata from "jsonata";
+import Operation from "../Operation.mjs";
+import OperationError from "../errors/OperationError.mjs";
+
+/**
+ * Jsonata Query operation
+ */
+class JsonataQuery extends Operation {
+    /**
+     * JsonataQuery constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "Jsonata Query";
+        this.module = "Code";
+        this.description =
+            "Query and transform JSON data with a jsonata query.";
+        this.infoURL = "https://docs.jsonata.org/overview.html";
+        this.inputType = "string";
+        this.outputType = "string";
+        this.args = [
+            {
+                name: "Query",
+                type: "text",
+                value: "string",
+            },
+        ];
+    }
+
+    /**
+     * @param {string} input
+     * @param {Object[]} args
+     * @returns {string}
+     */
+    async run(input, args) {
+        const [query] = args;
+        let result, jsonObj;
+
+        try {
+            jsonObj = JSON.parse(input);
+        } catch (err) {
+            throw new OperationError(`Invalid input JSON: ${err.message}`);
+        }
+
+        try {
+            const expression = jsonata(query);
+            result = await expression.evaluate(jsonObj);
+        } catch (err) {
+            throw new OperationError(
+                `Invalid Jsonata Expression: ${err.message}`
+            );
+        }
+
+        return JSON.stringify(result === undefined ? "" : result);
+    }
+}
+
+export default JsonataQuery;

src/core/operations/Jsonata.mjs

@@ -11,10 +11,7 @@
  * @license Apache-2.0
  */
 
-import {
-    setLongTestFailure,
-    logTestReport,
-} from "../lib/utils.mjs";
+import { setLongTestFailure, logTestReport } from "../lib/utils.mjs";
 
 import TestRegister from "../lib/TestRegister.mjs";
 import "./tests/AESKeyWrap.mjs";
@@ -89,6 +86,7 @@ import "./tests/IndexOfCoincidence.mjs";
 import "./tests/JA3Fingerprint.mjs";
 import "./tests/JA4.mjs";
 import "./tests/JA3SFingerprint.mjs";
+import "./tests/Jsonata.mjs";
 import "./tests/JSONBeautify.mjs";
 import "./tests/JSONMinify.mjs";
 import "./tests/JSONtoCSV.mjs";
@@ -181,14 +179,14 @@ const testStatus = {
     allTestsPassing: true,
     counts: {
         total: 0,
-    }
+    },
 };
 
 setLongTestFailure();
 
 const logOpsTestReport = logTestReport.bind(null, testStatus);
 
-(async function() {
+(async function () {
     const results = await TestRegister.runTests();
     logOpsTestReport(results);
 })();