feat: Add Js API (#121)

* feat: Add Js API * Organize imports * Fix code review comments
dhis2 · Jan 18, 2024 · 958ba19 · 958ba19
1 parent 52bb9c6
commit 958ba19
Show file tree

Hide file tree

Showing 44 changed files with 433 additions and 174 deletions.
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/api/RuleEngineContext.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/api/RuleEngineContext.kt
@@ -1,8 +1,6 @@
 package org.hisp.dhis.rules.api
 
 import org.hisp.dhis.rules.models.Rule
-import org.hisp.dhis.rules.models.RuleEnrollment
-import org.hisp.dhis.rules.models.RuleEvent
 import org.hisp.dhis.rules.models.RuleVariable
 
 data class RuleEngineContext(

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleConditionEvaluator.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleConditionEvaluator.kt
@@ -4,11 +4,10 @@ import org.hisp.dhis.lib.expression.Expression
 import org.hisp.dhis.lib.expression.spi.ExpressionData
 import org.hisp.dhis.lib.expression.spi.IllegalExpressionException
 import org.hisp.dhis.rules.createLogger
-import org.hisp.dhis.rules.models.Rule
-import org.hisp.dhis.rules.models.*
 import org.hisp.dhis.rules.engine.RuleEvaluationResult.Companion.errorRule
 import org.hisp.dhis.rules.engine.RuleEvaluationResult.Companion.evaluatedResult
 import org.hisp.dhis.rules.engine.RuleEvaluationResult.Companion.notEvaluatedResult
+import org.hisp.dhis.rules.models.*
 import org.hisp.dhis.rules.utils.unwrapVariableName
 
 internal class RuleConditionEvaluator {

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleEngineMultipleExecution.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleEngineMultipleExecution.kt
@@ -1,6 +1,5 @@
 package org.hisp.dhis.rules.engine
 
-import org.hisp.dhis.rules.models.Rule
 import org.hisp.dhis.rules.models.*
 
 internal class RuleEngineMultipleExecution {

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleVariableValueMapBuilder.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/engine/RuleVariableValueMapBuilder.kt
@@ -6,8 +6,6 @@ import kotlinx.datetime.toLocalDateTime
 import org.hisp.dhis.rules.models.*
 import org.hisp.dhis.rules.utils.RuleEngineUtils
 import org.hisp.dhis.rules.utils.currentDate
-import kotlin.collections.ArrayList
-import kotlin.collections.HashMap
 
 internal class RuleVariableValueMapBuilder private constructor() {
     val allConstantValues: MutableMap<String, String> = HashMap()

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/Option.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/Option.kt
@@ -1,6 +1,8 @@
 package org.hisp.dhis.rules.models
 
-/**
- * @author rajazubair
- */
+import kotlin.js.ExperimentalJsExport
+import kotlin.js.JsExport
+
+@JsExport
+@OptIn(ExperimentalJsExport::class)
 data class Option(val name: String, val code: String)
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleAttributeValue.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleAttributeValue.kt
@@ -1,5 +1,10 @@
 package org.hisp.dhis.rules.models
 
+import kotlin.js.ExperimentalJsExport
+import kotlin.js.JsExport
+
+@JsExport
+@OptIn(ExperimentalJsExport::class)
 data class RuleAttributeValue(
     val trackedEntityAttribute: String,
     val value: String

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleValidationResult.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleValidationResult.kt
@@ -1,5 +1,7 @@
 package org.hisp.dhis.rules.models
 
+import kotlin.js.ExperimentalJsExport
+import kotlin.js.JsExport
 import kotlin.jvm.JvmOverloads
 
 /*
@@ -30,6 +32,8 @@ import kotlin.jvm.JvmOverloads
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+@JsExport
+@OptIn(ExperimentalJsExport::class)
 data class RuleValidationResult @JvmOverloads constructor(
         val valid: Boolean,
         val errorMessage: String? = null,

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariable.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariable.kt
@@ -1,10 +1,13 @@
 package org.hisp.dhis.rules.models
 
 import org.hisp.dhis.rules.engine.RuleVariableValue
-import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
 
 interface RuleVariable {
+    val name: String
+    val useCodeForOptionSet: Boolean
     val options: List<Option>
+    val field: String
+    val fieldType: RuleValueType
     fun createValues(
         ruleEvent: RuleEvent?,
         allEventValues: Map<String, List<RuleDataValue>>,

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableAttribute.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableAttribute.kt
@@ -2,15 +2,14 @@ package org.hisp.dhis.rules.models
 
 import kotlinx.datetime.LocalDate
 import org.hisp.dhis.rules.engine.RuleVariableValue
-import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
 import org.hisp.dhis.rules.utils.currentDate
 
 data class RuleVariableAttribute(
-    val name: String,
-    val useCodeForOptionSet: Boolean,
+    override val name: String,
+    override val useCodeForOptionSet: Boolean,
     override val options: List<Option>,
-    val trackedEntityAttribute: String,
-    val trackedEntityAttributeType: RuleValueType
+    override val field: String,
+    override val fieldType: RuleValueType
 ) : RuleVariable {
     override fun createValues(
         ruleEvent: RuleEvent?,
@@ -20,15 +19,15 @@ data class RuleVariableAttribute(
     ): Map<String, RuleVariableValue> {
         val valueMap: MutableMap<String, RuleVariableValue> = HashMap()
         val currentDate = LocalDate.Companion.currentDate()
-        val variableValue = if (currentEnrollmentValues.containsKey(trackedEntityAttribute)) {
-            val value = currentEnrollmentValues[trackedEntityAttribute]
+        val variableValue = if (currentEnrollmentValues.containsKey(field)) {
+            val value = currentEnrollmentValues[field]
             val optionValue = if (useCodeForOptionSet) value!!.value else getOptionName(value!!.value)!!
             RuleVariableValue(
-                trackedEntityAttributeType, optionValue,
+                fieldType, optionValue,
                 listOf(optionValue), currentDate.toString()
             )
         } else {
-            RuleVariableValue(trackedEntityAttributeType)
+            RuleVariableValue(fieldType)
         }
         valueMap[name] = variableValue
         return valueMap

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableCalculatedValue.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableCalculatedValue.kt
@@ -1,7 +1,6 @@
 package org.hisp.dhis.rules.models
 
 import org.hisp.dhis.rules.engine.RuleVariableValue
-import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
 
 /*
 * Copyright (c) 2004-2018, University of Oslo
@@ -33,11 +32,11 @@ import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
  * @author Zubair Asghar.
  */
 class RuleVariableCalculatedValue(
-    val name: String,
-    val useCodeForOptionSet: Boolean,
+    override val name: String,
+    override val useCodeForOptionSet: Boolean,
     override val options: List<Option>,
-    val calculatedValueVariable: String,
-    val calculatedValueType: RuleValueType
+    override val field: String,
+    override val fieldType: RuleValueType
 ) : RuleVariable {
     override fun createValues(
         ruleEvent: RuleEvent?,
@@ -46,7 +45,7 @@ class RuleVariableCalculatedValue(
         currentEventValues: Map<String, RuleDataValue>
     ): Map<String, RuleVariableValue> {
         val valueMap: MutableMap<String, RuleVariableValue> = HashMap()
-        valueMap[name] = RuleVariableValue(calculatedValueType)
+        valueMap[name] = RuleVariableValue(fieldType)
         return valueMap
     }
 }
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableCurrentEvent.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableCurrentEvent.kt
@@ -1,16 +1,15 @@
 package org.hisp.dhis.rules.models
 
 import org.hisp.dhis.rules.engine.RuleVariableValue
-import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
 import org.hisp.dhis.rules.utils.getLastUpdateDate
 
 class RuleVariableCurrentEvent(
-    val name: String,
-    val useCodeForOptionSet: Boolean,
+    override val name: String,
+    override val useCodeForOptionSet: Boolean,
     override val options: List<Option>,
-    override val dataElement: String,
-    override val dataElementType: RuleValueType,
-) : RuleVariableDataElement {
+    override val field: String,
+    override val fieldType: RuleValueType,
+) : RuleVariable {
     override fun createValues(
         ruleEvent: RuleEvent?,
         allEventValues: Map<String, List<RuleDataValue>>,
@@ -19,15 +18,15 @@ class RuleVariableCurrentEvent(
     ): Map<String, RuleVariableValue> {
         val valueMap: MutableMap<String, RuleVariableValue> = HashMap()
         val variableValue: RuleVariableValue
-        variableValue = if (currentEventValues.containsKey(dataElement)) {
-            val value = currentEventValues[dataElement]
+        variableValue = if (currentEventValues.containsKey(field)) {
+            val value = currentEventValues[field]
             val optionValue = if (useCodeForOptionSet) value!!.value else getOptionName(value!!.value)!!
             RuleVariableValue(
-                dataElementType, optionValue,
+                fieldType, optionValue,
                 listOf(optionValue), getLastUpdateDate(listOf(value))
             )
         } else {
-            RuleVariableValue(dataElementType)
+            RuleVariableValue(fieldType)
         }
         valueMap[name] = variableValue
         return valueMap

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableDataElement.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableDataElement.kt
diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableNewestEvent.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableNewestEvent.kt
@@ -1,33 +1,32 @@
 package org.hisp.dhis.rules.models
 
 import org.hisp.dhis.rules.engine.RuleVariableValue
-import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
 import org.hisp.dhis.rules.utils.getLastUpdateDate
 import org.hisp.dhis.rules.utils.values
 
 class RuleVariableNewestEvent(
-    val name: String,
-    val useCodeForOptionSet: Boolean,
+    override val name: String,
+    override val useCodeForOptionSet: Boolean,
     override val options: List<Option>,
-    override val dataElement: String,
-    override val dataElementType: RuleValueType,
-) : RuleVariableDataElement {
+    override val field: String,
+    override val fieldType: RuleValueType,
+) : RuleVariable {
     override fun createValues(
         ruleEvent: RuleEvent?,
         allEventValues: Map<String, List<RuleDataValue>>,
         currentEnrollmentValues: Map<String, RuleAttributeValue>,
         currentEventValues: Map<String, RuleDataValue>
     ): Map<String, RuleVariableValue> {
         val valueMap: MutableMap<String, RuleVariableValue> = HashMap()
-        val ruleDataValues = allEventValues[dataElement]
+        val ruleDataValues = allEventValues[field]
         if (ruleDataValues.isNullOrEmpty()) {
-            valueMap[name] = RuleVariableValue(dataElementType)
+            valueMap[name] = RuleVariableValue(fieldType)
         } else {
             val variableValue: RuleVariableValue
             val value = ruleDataValues[0]
             val optionValue = if (useCodeForOptionSet) value.value else getOptionName(value.value)!!
             variableValue = RuleVariableValue(
-                dataElementType, optionValue,
+                fieldType, optionValue,
                 values(ruleDataValues), getLastUpdateDate(ruleDataValues)
             )
             valueMap[name] = variableValue

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableNewestStageEvent.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariableNewestStageEvent.kt
@@ -1,18 +1,17 @@
 package org.hisp.dhis.rules.models
 
 import org.hisp.dhis.rules.engine.RuleVariableValue
-import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
 import org.hisp.dhis.rules.utils.getLastUpdateDate
 import org.hisp.dhis.rules.utils.values
 
 class RuleVariableNewestStageEvent(
-    val name: String,
-    val useCodeForOptionSet: Boolean,
+    override val name: String,
+    override val useCodeForOptionSet: Boolean,
     override val options: List<Option>,
-    override val dataElement: String,
-    override val dataElementType: RuleValueType,
+    override val field: String,
+    override val fieldType: RuleValueType,
     val programStage: String
-) : RuleVariableDataElement {
+) : RuleVariable {
 
     override fun createValues(
         ruleEvent: RuleEvent?,
@@ -22,7 +21,7 @@ class RuleVariableNewestStageEvent(
     ): Map<String, RuleVariableValue> {
         val valueMap: MutableMap<String, RuleVariableValue> = HashMap()
         val stageRuleDataValues: MutableList<RuleDataValue> = ArrayList()
-        val sourceRuleDataValues = allEventValues[dataElement]
+        val sourceRuleDataValues = allEventValues[field]
         if (!sourceRuleDataValues.isNullOrEmpty()) {
 
             // filter data values based on program stage
@@ -33,13 +32,13 @@ class RuleVariableNewestStageEvent(
             }
         }
         if (stageRuleDataValues.isEmpty()) {
-            valueMap[name] = RuleVariableValue(dataElementType)
+            valueMap[name] = RuleVariableValue(fieldType)
         } else {
             val variableValue: RuleVariableValue
             val value = stageRuleDataValues[0]
             val optionValue = if (useCodeForOptionSet) value.value else getOptionName(value.value)!!
             variableValue = RuleVariableValue(
-                dataElementType, optionValue,
+                fieldType, optionValue,
                 values(stageRuleDataValues),
                 getLastUpdateDate(stageRuleDataValues)
             )

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariablePreviousEvent.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/models/RuleVariablePreviousEvent.kt
@@ -1,17 +1,16 @@
 package org.hisp.dhis.rules.models
 
 import org.hisp.dhis.rules.engine.RuleVariableValue
-import org.hisp.dhis.rules.engine.RuleVariableValueMapBuilder
 import org.hisp.dhis.rules.utils.getLastUpdateDateForPrevious
 import org.hisp.dhis.rules.utils.values
 
 class RuleVariablePreviousEvent(
-    val name: String,
-    val useCodeForOptionSet: Boolean,
+    override val name: String,
+    override val useCodeForOptionSet: Boolean,
     override val options: List<Option>,
-    override val dataElement: String,
-    override val dataElementType: RuleValueType
-) : RuleVariableDataElement {
+    override val field: String,
+    override val fieldType: RuleValueType
+) : RuleVariable {
     override fun createValues(
         ruleEvent: RuleEvent?,
         allEventValues: Map<String, List<RuleDataValue>>,
@@ -20,7 +19,7 @@ class RuleVariablePreviousEvent(
     ): Map<String, RuleVariableValue> {
         val valueMap: MutableMap<String, RuleVariableValue> = HashMap()
         var variableValue: RuleVariableValue? = null
-        val ruleDataValues = allEventValues[dataElement]
+        val ruleDataValues = allEventValues[field]
         if (ruleEvent != null && !ruleDataValues.isNullOrEmpty()) {
             for (ruleDataValue in ruleDataValues) {
                 // We found preceding value to the current currentEventValues,
@@ -29,7 +28,7 @@ class RuleVariablePreviousEvent(
                     val optionValue =
                         if (useCodeForOptionSet) ruleDataValue.value else getOptionName(ruleDataValue.value)!!
                     variableValue = RuleVariableValue(
-                        dataElementType, optionValue,
+                        fieldType, optionValue,
                         values(ruleDataValues),
                         getLastUpdateDateForPrevious(ruleDataValues, ruleEvent)
                     )
@@ -38,7 +37,7 @@ class RuleVariablePreviousEvent(
             }
         }
         if (variableValue == null) {
-            variableValue = RuleVariableValue(dataElementType)
+            variableValue = RuleVariableValue(fieldType)
         }
         valueMap[name] = variableValue
         return valueMap

diff --git a/src/commonMain/kotlin/org/hisp/dhis/rules/utils/RuleEngineUtils.kt b/src/commonMain/kotlin/org/hisp/dhis/rules/utils/RuleEngineUtils.kt
@@ -1,7 +1,5 @@
 package org.hisp.dhis.rules.utils
 
-import org.hisp.dhis.rules.api.ItemValueType
-
 /*
 * Copyright (c) 2004-2020, University of Oslo
 * All rights reserved.

diff --git a/src/commonTest/kotlin/org/hisp/dhis/rules/ConstantsValueTest.kt b/src/commonTest/kotlin/org/hisp/dhis/rules/ConstantsValueTest.kt
@@ -3,9 +3,7 @@ package org.hisp.dhis.rules
 import kotlinx.datetime.Clock
 import kotlinx.datetime.LocalDate
 import org.hisp.dhis.rules.api.RuleEngine
-import org.hisp.dhis.rules.models.Rule
 import org.hisp.dhis.rules.api.RuleEngineContext
-import org.hisp.dhis.rules.engine.DefaultRuleEngine
 import org.hisp.dhis.rules.models.*
 import org.hisp.dhis.rules.utils.currentDate
 import kotlin.test.Test

diff --git a/src/commonTest/kotlin/org/hisp/dhis/rules/ProgramRuleVariableTest.kt b/src/commonTest/kotlin/org/hisp/dhis/rules/ProgramRuleVariableTest.kt
@@ -3,9 +3,7 @@ package org.hisp.dhis.rules
 import kotlinx.datetime.Instant
 import kotlinx.datetime.LocalDate
 import org.hisp.dhis.rules.api.RuleEngine
-import org.hisp.dhis.rules.models.Rule
 import org.hisp.dhis.rules.api.RuleEngineContext
-import org.hisp.dhis.rules.engine.DefaultRuleEngine
 import org.hisp.dhis.rules.models.*
 import org.hisp.dhis.rules.utils.currentDate
 import kotlin.test.Test