Add read functionality with Jsonpath expressions for Ballerina json datatypes

.gitignore

@@ -18,7 +18,14 @@
 *.zip
 *.tar.gz
 *.rar
+bin
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 replay_pid*
+.DS_Store
+.gradle
+.vscode
+build
+target
+.idea

ballerina/Ballerina.toml

@@ -0,0 +1,34 @@
+[package]
+org = "ballerina"
+name = "data.jsondata"
+version = "0.1.0"
+authors = ["Ballerina"]
+keywords = ["json", "json path", "json-transform", "json transform", "json to json", "json-convert", "json convert"]
+repository = "https://github.com/ballerina-platform/module-ballerina-data.jsondata"
+license = ["Apache-2.0"]
+distribution = "2201.8.3"
+export = ["data.jsondata"]
+
+[[platform.java11.dependency]]
+path = "../native/build/libs/jsonpath-native-1.0.2-SNAPSHOT.jar"
+groupId = "io.ballerina.xlibb"
+artifactId = "jsonpath-native"
+version = "1.0.2"
+
+[[platform.java11.dependency]]
+path = "./lib/json-path-2.7.0.jar"
+groupId = "com.jayway.jsonpath"
+artifactId = "json-path"
+version = "2.7.0"
+
+[[platform.java11.dependency]]
+path = "./lib/json-smart-2.4.7.jar"
+groupId = "net.minidev.json"
+artifactId = "json-smart"
+version = "2.4.7"
+
+[[platform.java11.dependency]]
+path = "./lib/accessors-smart-2.4.7.jar"
+groupId = "net.minidev.json"
+artifactId = "accessors-smart"
+version = "2.4.7"

ballerina/Dependencies.toml

@@ -0,0 +1,98 @@
+# AUTO-GENERATED FILE. DO NOT MODIFY.
+
+# This file is auto-generated by Ballerina for managing dependency versions.
+# It should not be modified by hand.
+
+[ballerina]
+dependencies-toml-version = "2"
+distribution-version = "2201.8.3"
+
+[[package]]
+org = "ballerina"
+name = "data.jsondata"
+version = "0.1.0"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.float"},
+	{org = "ballerina", name = "lang.int"},
+	{org = "ballerina", name = "lang.object"},
+	{org = "ballerina", name = "test"}
+]
+modules = [
+	{org = "ballerina", packageName = "data.jsondata", moduleName = "data.jsondata"}
+]
+
+[[package]]
+org = "ballerina"
+name = "jballerina.java"
+version = "0.0.0"
+modules = [
+	{org = "ballerina", packageName = "jballerina.java", moduleName = "jballerina.java"}
+]
+
+[[package]]
+org = "ballerina"
+name = "lang.__internal"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.object"}
+]
+
+[[package]]
+org = "ballerina"
+name = "lang.error"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"}
+]
+
+[[package]]
+org = "ballerina"
+name = "lang.float"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"}
+]
+modules = [
+	{org = "ballerina", packageName = "lang.float", moduleName = "lang.float"}
+]
+
+[[package]]
+org = "ballerina"
+name = "lang.int"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.__internal"},
+	{org = "ballerina", name = "lang.object"}
+]
+modules = [
+	{org = "ballerina", packageName = "lang.int", moduleName = "lang.int"}
+]
+
+[[package]]
+org = "ballerina"
+name = "lang.object"
+version = "0.0.0"
+modules = [
+	{org = "ballerina", packageName = "lang.object", moduleName = "lang.object"}
+]
+
+[[package]]
+org = "ballerina"
+name = "test"
+version = "0.0.0"
+scope = "testOnly"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.error"}
+]
+modules = [
+	{org = "ballerina", packageName = "test", moduleName = "test"}
+]
+

ballerina/errors.bal

@@ -0,0 +1,18 @@
+// Copyright (c) 2024 WSO2 LLC (http://www.wso2.org) All Rights Reserved.
+//
+// WSO2 Inc. licenses this file to you under the Apache License,
+// Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+# Represents any error related to Ballerina JsonPath module
+public type Error distinct error;

ballerina/init.bal

@@ -0,0 +1,25 @@
+// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com) All Rights Reserved.
+//
+// WSO2 LLC. licenses this file to you under the Apache License,
+// Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+import ballerina/jballerina.java;
+
+function init() {
+    setModule();
+}
+
+function setModule() = @java:Method {
+    'class: "io.ballerina.xlibb.jsonpath.Utils"
+} external;

ballerina/jsonpath.bal

@@ -0,0 +1,53 @@
+// Copyright (c) 2024 WSO2 LLC (http://www.wso2.org) All Rights Reserved.
+//
+// WSO2 Inc. licenses this file to you under the Apache License,
+// Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+import ballerina/jballerina.java;
+import ballerina/lang.'object as obj;
+
+public type JsonPathValue ()|boolean|int|float|decimal|string|json[]|map<json>;
+
+public type JsonPathRawTemplate object {
+    *obj:RawTemplate;
+    public (string[] & readonly) strings;
+    public JsonPathValue[] insertions;
+};
+
+# Extract details from the given JSON value using the provided query template expression
+# + 'json - JSON value
+# + query - JSON path expression
+# + return - extracted details as JSON value, a jsonpath:Error otherwise
+public isolated function read(json 'json, JsonPathRawTemplate query) returns json|Error {
+    return readJson('json, new JsonPathRawTemplateImpl(query));
+}
+
+public class JsonPathRawTemplateImpl {
+    *object:RawTemplate;
+    public string[] & readonly strings;
+    public JsonPathValue[] insertions;
+
+    public isolated function init(JsonPathRawTemplate jsonPathRawTemplate) {
+        self.strings = jsonPathRawTemplate.strings;
+        self.insertions = jsonPathRawTemplate.insertions;
+    }
+}
+
+# Extract details from the given JSON value using the provided query expression
+# + 'json - JSON value
+# + query - JSON path expression
+# + return - extracted details as JSON value, a jsonpath:Error otherwise
+public isolated function readJson(json 'json, JsonPathRawTemplateImpl query) returns json|Error = @java:Method {
+    'class: "io.ballerina.xlibb.jsonpath.BJsonPath"
+} external;

ballerina/tests/error_test.bal

@@ -0,0 +1,56 @@
+// Copyright (c) 2024 WSO2 LLC (http://www.wso2.org) All Rights Reserved.
+//
+// WSO2 Inc. licenses this file to you under the Apache License,
+// Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+import ballerina/test;
+
+@test:Config {}
+function errorTest() {
+    json|Error result = read(j4, `$.a1[:]`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Failed to parse SliceOperation: :");
+
+    result = read(j4, `#`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Unable to execute query '#' on the provided JSON value");
+
+    result = read({name: ""}, `$.id`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Unable to execute query '$.id' on the provided JSON value");
+
+    result = read("test", `$.id`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Unable to execute query '$.id' on the provided JSON value");
+
+    result = read(1, `$.a1[:]`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Failed to parse SliceOperation: :");
+
+    result = read([j4], `$.a3[-1]`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Unable to execute query '$.a3[-1]' on the provided JSON value");
+
+    result = read(j4, `$.a1[-1].a12`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Unable to execute query '$.a1[-1].a12' on the provided JSON value");
+
+    result = read(j4, `$.a40.sum()`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Unable to execute query '$.a40.sum()' on the provided JSON value");
+
+    result = read(j1, `$.a1[1]`);
+    test:assertTrue(result is Error);
+    test:assertEquals((<Error> result).message(), "Unable to execute query '$.a1[1]' on the provided JSON value");
+}