planar 0.5.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

planar/rules/models.py

@@ -4,7 +4,7 @@ import json
 from typing import Annotated, Literal, Type
 from uuid import uuid4
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from planar.modeling.field_helpers import JsonSchema
 from planar.object_config.object_config import (
@@ -12,14 +12,18 @@ from planar.object_config.object_config import (
 )
 
 
-class Position(BaseModel):
+class JDMBaseModel(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+
+class Position(JDMBaseModel):
     """Represents the x,y coordinates of a node in the graph"""
 
-    x: int
-    y: int
+    x: int | float
+    y: int | float
 
 
-class InputOutputNodeContent(BaseModel):
+class InputOutputNodeContent(JDMBaseModel):
     """Content structure for input or output nodes containing JSON schema"""
 
     schema_: str = Field(
@@ -27,15 +31,15 @@ class InputOutputNodeContent(BaseModel):
     )  # JSON string representation of the input schema
 
 
-class RuleTableInput(BaseModel):
+class RuleTableInput(JDMBaseModel):
     """Represents an input column in a decision table"""
 
     id: str
-    field: str  # The field name from the input schema
+    field: str | None = None  # The field name from the input schema
     name: str
 
 
-class RuleTableOutput(BaseModel):
+class RuleTableOutput(JDMBaseModel):
     """Represents an output column in a decision table"""
 
     id: str
@@ -43,23 +47,11 @@ class RuleTableOutput(BaseModel):
     name: str
 
 
-class DecisionRule(BaseModel):
-    """Represents a single rule row in a decision table with dynamic values"""
-
-    rule_id: str = Field(
-        alias="_id"
-    )  # Using alias to maintain compatibility with _id field
-    # Note: Additional dynamic keys will be present based on input/output column IDs
-    # These are handled using model_extra="allow" configuration
-
-    model_config = {"extra": "allow", "populate_by_name": True}
-
-
-class DecisionTableNodeContent(BaseModel):
+class DecisionTableNodeContent(JDMBaseModel):
     """Content structure for decision table nodes"""
 
-    hitPolicy: Literal["first"]  # Policy for rule evaluation
-    rules: list[DecisionRule]  # List of rule rows
+    hitPolicy: Literal["first"] | Literal["collect"]  # Policy for rule evaluation
+    rules: list[dict[str, str]]  # List of rule rows
     inputs: list[RuleTableInput]  # Input column definitions
     outputs: list[RuleTableOutput]  # Output column definitions
 
@@ -73,7 +65,7 @@ class DecisionTableNodeContent(BaseModel):
     executionMode: Literal["single", "loop"] | None  # Execution mode for the table
 
 
-class InputNode(BaseModel):
+class InputNode(JDMBaseModel):
     """Represents an input node in the JDM graph"""
 
     id: str
@@ -83,7 +75,7 @@ class InputNode(BaseModel):
     position: Position
 
 
-class DecisionTableNode(BaseModel):
+class DecisionTableNode(JDMBaseModel):
     """Represents a decision table node in the JDM graph"""
 
     id: str
@@ -93,7 +85,7 @@ class DecisionTableNode(BaseModel):
     position: Position
 
 
-class OutputNode(BaseModel):
+class OutputNode(JDMBaseModel):
     """Represents an output node in the JDM graph"""
 
     id: str
@@ -103,13 +95,13 @@ class OutputNode(BaseModel):
     position: Position
 
 
-class FunctionNodeContent(BaseModel):
+class FunctionNodeContent(JDMBaseModel):
     """Content structure for a function node containing JavaScript source code."""
 
     source: str
 
 
-class FunctionNode(BaseModel):
+class FunctionNode(JDMBaseModel):
     """Represents a JavaScript function node in the JDM graph."""
 
     id: str
@@ -119,11 +111,13 @@ class FunctionNode(BaseModel):
     position: Position
 
 
-# class LegacyFunctionNode(BaseModel):
+# The gorules site sometimes uses this legacy node in their (presumably outdated) examples.
+# so safe to ignore since our go rules editor frontend won't generate this node.
+#
+# class LegacyFunctionNode(JDMBaseModel):
 #     """Represents a legacy JavaScript function node in the JDM graph.
 #     The GoRules examples (such as https://editor.gorules.io/?template=shipping-fees use a legacy fn node)
 #     """
-
 #     id: str
 #     type: Literal["functionNode"]
 #     name: str
@@ -131,21 +125,22 @@ class FunctionNode(BaseModel):
 #     position: Position
 
 
-class SwitchStatement(BaseModel):
+class SwitchStatement(JDMBaseModel):
     """Represents a statement in a switch node."""
 
     id: str
     condition: str
+    isDefault: bool
 
 
-class SwitchNodeContent(BaseModel):
+class SwitchNodeContent(JDMBaseModel):
     """Content structure for a switch node."""
 
     hitPolicy: Literal["collect", "first"]
     statements: list[SwitchStatement]
 
 
-class SwitchNode(BaseModel):
+class SwitchNode(JDMBaseModel):
     """Represents a switch node in the JDM graph."""
 
     id: str
@@ -155,7 +150,7 @@ class SwitchNode(BaseModel):
     position: Position
 
 
-class Expression(BaseModel):
+class Expression(JDMBaseModel):
     """Represents a single expression in an expression node."""
 
     id: str
@@ -163,7 +158,7 @@ class Expression(BaseModel):
     value: str
 
 
-class ExpressionNodeContent(BaseModel):
+class ExpressionNodeContent(JDMBaseModel):
     """Content structure for an expression node."""
 
     expressions: list[Expression]
@@ -175,7 +170,7 @@ class ExpressionNodeContent(BaseModel):
     )
 
 
-class ExpressionNode(BaseModel):
+class ExpressionNode(JDMBaseModel):
     """Represents an expression node in the JDM graph."""
 
     id: str
@@ -198,21 +193,23 @@ JDMNode = (
 JDMNodeWithType = Annotated[JDMNode, Field(discriminator="type")]
 
 
-class JDMEdge(BaseModel):
+class JDMEdge(JDMBaseModel):
     """Represents an edge connecting nodes in the JDM graph"""
 
     id: str
     type: Literal["edge"]
     sourceId: str  # ID of the source node
     targetId: str  # ID of the target node
+    sourceHandle: str | None = None
 
 
-class JDMGraph(BaseModel):
+class JDMGraph(JDMBaseModel):
     """
     Complete JDM (JSON Decision Model) graph structure.
     This represents a GoRules decision flow with input, processing, and output nodes.
     """
 
+    contentType: Literal["application/vnd.gorules.decision"] | None = None
     nodes: list[JDMNodeWithType]  # All nodes in the graph
     edges: list[JDMEdge]  # All edges connecting the nodes
 
@@ -287,7 +284,7 @@ def create_jdm_graph(rule: Rule) -> JDMGraph:
                 name="decisionTable1",
                 content=DecisionTableNodeContent(
                     hitPolicy="first",
-                    rules=[DecisionRule(_id=str(uuid4()), **rule_values)],
+                    rules=[{"_id": str(uuid4()), **rule_values}],
                     inputs=[
                         RuleTableInput(
                             id=input_column_id,

planar/rules/test_data/account_dormancy_management.json

@@ -0,0 +1,223 @@
+{
+  "nodes": [
+    {
+      "type": "inputNode",
+      "content": {
+        "schema": ""
+      },
+      "id": "ip1",
+      "name": "request",
+      "position": {
+        "x": 110,
+        "y": 173.5
+      }
+    },
+    {
+      "type": "expressionNode",
+      "content": {
+        "expressions": [
+          {
+            "id": "e1-1",
+            "key": "daysSinceLastActivity",
+            "value": "date('now') - date(lastActivityDate)"
+          },
+          {
+            "id": "e1-2",
+            "key": "daysToThreshold",
+            "value": "dormancyThreshold - $.daysSinceLastActivity"
+          }
+        ],
+        "passThrough": true,
+        "inputField": null,
+        "outputPath": null,
+        "executionMode": "single"
+      },
+      "id": "ex1",
+      "name": "calculate_dormancy",
+      "position": {
+        "x": 430,
+        "y": 173.5
+      }
+    },
+    {
+      "type": "decisionTableNode",
+      "content": {
+        "hitPolicy": "first",
+        "rules": [
+          {
+            "_id": "r1-1",
+            "i1-1": "< 0",
+            "o1-1": "'dormant'"
+          },
+          {
+            "_id": "r1-2",
+            "i1-1": "< 30",
+            "o1-1": "'at_risk'"
+          },
+          {
+            "_id": "r1-3",
+            "i1-1": "< 60",
+            "o1-1": "'warning'"
+          },
+          {
+            "_id": "r1-4",
+            "i1-1": "",
+            "o1-1": "'active'"
+          }
+        ],
+        "inputs": [
+          {
+            "id": "i1-1",
+            "name": "Days To Threshold",
+            "field": "daysToThreshold"
+          }
+        ],
+        "outputs": [
+          {
+            "id": "o1-1",
+            "name": "Status",
+            "field": "dormancyStatus"
+          }
+        ],
+        "passThrough": true,
+        "inputField": null,
+        "outputPath": null,
+        "executionMode": "single"
+      },
+      "id": "dt1",
+      "name": "dormancy_status",
+      "position": {
+        "x": 750,
+        "y": 173.5
+      }
+    },
+    {
+      "type": "switchNode",
+      "content": {
+        "hitPolicy": "first",
+        "statements": [
+          {
+            "id": "s1-1",
+            "condition": "dormancyStatus != 'active'",
+            "isDefault": false
+          },
+          {
+            "id": "s1-2",
+            "condition": "",
+            "isDefault": true
+          }
+        ]
+      },
+      "id": "sw1",
+      "name": "route_by_status",
+      "position": {
+        "x": 1070,
+        "y": 173.5
+      }
+    },
+    {
+      "type": "decisionTableNode",
+      "content": {
+        "hitPolicy": "first",
+        "rules": [
+          {
+            "_id": "r2-1",
+            "i2-1": "'dormant'",
+            "i2-2": "'premium'",
+            "o2-1": "'fee_waiver'",
+            "o2-2": "'high'"
+          },
+          {
+            "_id": "r2-2",
+            "i2-1": "'dormant'",
+            "i2-2": "",
+            "o2-1": "'auto_close'",
+            "o2-2": "'medium'"
+          },
+          {
+            "_id": "r2-3",
+            "i2-1": "'at_risk'",
+            "i2-2": "'premium'",
+            "o2-1": "'account_review'",
+            "o2-2": "'high'"
+          },
+          {
+            "_id": "r2-4",
+            "i2-1": "'at_risk'",
+            "i2-2": "",
+            "o2-1": "'final_notice'",
+            "o2-2": "'high'"
+          },
+          {
+            "_id": "r2-5",
+            "i2-1": "'warning'",
+            "i2-2": "",
+            "o2-1": "'notification'",
+            "o2-2": "'medium'"
+          }
+        ],
+        "inputs": [
+          {
+            "id": "i2-1",
+            "name": "Status",
+            "field": "dormancyStatus"
+          },
+          {
+            "id": "i2-2",
+            "name": "Customer Tier",
+            "field": "customerTier"
+          }
+        ],
+        "outputs": [
+          {
+            "id": "o2-1",
+            "name": "Action",
+            "field": "recommendedAction"
+          },
+          {
+            "id": "o2-2",
+            "name": "Priority",
+            "field": "actionPriority"
+          }
+        ],
+        "passThrough": false,
+        "inputField": null,
+        "outputPath": null,
+        "executionMode": "single"
+      },
+      "id": "dt2",
+      "name": "determine_action",
+      "position": {
+        "x": 1390,
+        "y": 173.5
+      }
+    }
+  ],
+  "edges": [
+    {
+      "id": "ed1",
+      "sourceId": "ip1",
+      "targetId": "ex1",
+      "type": "edge"
+    },
+    {
+      "id": "ed2",
+      "sourceId": "ex1",
+      "targetId": "dt1",
+      "type": "edge"
+    },
+    {
+      "id": "ed3",
+      "sourceId": "dt1",
+      "targetId": "sw1",
+      "type": "edge"
+    },
+    {
+      "id": "ed4",
+      "sourceId": "sw1",
+      "targetId": "dt2",
+      "sourceHandle": "s1-1",
+      "type": "edge"
+    }
+  ]
+}

planar/rules/test_data/airline_loyalty_points_calculator.json

@@ -0,0 +1,262 @@
+{
+  "nodes": [
+    {
+      "type": "inputNode",
+      "content": {
+        "schema": ""
+      },
+      "id": "ip1",
+      "name": "request",
+      "position": {
+        "x": 110,
+        "y": 114
+      }
+    },
+    {
+      "type": "decisionTableNode",
+      "content": {
+        "hitPolicy": "first",
+        "rules": [
+          {
+            "_id": "r1-1",
+            "i1-1": "'First'",
+            "o1-1": "3"
+          },
+          {
+            "_id": "r1-2",
+            "i1-1": "'Business'",
+            "o1-1": "2"
+          },
+          {
+            "_id": "r1-3",
+            "i1-1": "'Premium Economy'",
+            "o1-1": "1.5"
+          },
+          {
+            "_id": "r1-4",
+            "i1-1": "'Economy Plus'",
+            "o1-1": "1.25"
+          },
+          {
+            "_id": "r1-5",
+            "i1-1": "",
+            "o1-1": "1"
+          }
+        ],
+        "inputs": [
+          {
+            "id": "i1-1",
+            "name": "Fare Class",
+            "field": "booking.fareClass"
+          }
+        ],
+        "outputs": [
+          {
+            "id": "o1-1",
+            "name": "Fare Multiplier",
+            "field": "points.fareMultiplier"
+          }
+        ],
+        "passThrough": true,
+        "inputField": null,
+        "outputPath": null,
+        "executionMode": "single"
+      },
+      "id": "dt1",
+      "name": "fareClassMultiplier",
+      "position": {
+        "x": 430,
+        "y": 114
+      }
+    },
+    {
+      "type": "decisionTableNode",
+      "content": {
+        "hitPolicy": "first",
+        "rules": [
+          {
+            "_id": "r2-1",
+            "i2-1": "'Domestic'",
+            "i2-2": "< 500",
+            "o2-1": "250"
+          },
+          {
+            "_id": "r2-2",
+            "i2-1": "'Domestic'",
+            "i2-2": "[500..1000]",
+            "o2-1": "500"
+          },
+          {
+            "_id": "r2-3",
+            "i2-1": "'Domestic'",
+            "i2-2": "> 1000",
+            "o2-1": "750"
+          },
+          {
+            "_id": "r2-4",
+            "i2-1": "'International'",
+            "i2-2": "< 2000",
+            "o2-1": "1000"
+          },
+          {
+            "_id": "r2-5",
+            "i2-1": "'International'",
+            "i2-2": "[2000..5000]",
+            "o2-1": "2000"
+          },
+          {
+            "_id": "r2-6",
+            "i2-1": "'International'",
+            "i2-2": "> 5000",
+            "o2-1": "3000"
+          },
+          {
+            "_id": "r2-7",
+            "i2-1": "",
+            "i2-2": "",
+            "o2-1": "500"
+          }
+        ],
+        "inputs": [
+          {
+            "id": "i2-1",
+            "name": "Route Type",
+            "field": "booking.routeType"
+          },
+          {
+            "id": "i2-2",
+            "name": "Distance (miles)",
+            "field": "booking.distance"
+          }
+        ],
+        "outputs": [
+          {
+            "id": "o2-1",
+            "name": "Base Points",
+            "field": "points.basePoints"
+          }
+        ],
+        "passThrough": true,
+        "inputField": null,
+        "outputPath": null,
+        "executionMode": "single"
+      },
+      "id": "dt2",
+      "name": "routeBasePoints",
+      "position": {
+        "x": 750,
+        "y": 114
+      }
+    },
+    {
+      "type": "decisionTableNode",
+      "content": {
+        "hitPolicy": "first",
+        "rules": [
+          {
+            "_id": "r3-1",
+            "i3-1": "'Platinum'",
+            "o3-1": "2"
+          },
+          {
+            "_id": "r3-2",
+            "i3-1": "'Gold'",
+            "o3-1": "1.5"
+          },
+          {
+            "_id": "r3-3",
+            "i3-1": "'Silver'",
+            "o3-1": "1.25"
+          },
+          {
+            "_id": "r3-4",
+            "i3-1": "",
+            "o3-1": "1"
+          }
+        ],
+        "inputs": [
+          {
+            "id": "i3-1",
+            "name": "Member Status",
+            "field": "member.status"
+          }
+        ],
+        "outputs": [
+          {
+            "id": "o3-1",
+            "name": "Status Multiplier",
+            "field": "points.statusMultiplier"
+          }
+        ],
+        "passThrough": true,
+        "inputField": null,
+        "outputPath": null,
+        "executionMode": "single"
+      },
+      "id": "dt3",
+      "name": "memberStatusMultiplier",
+      "position": {
+        "x": 1070,
+        "y": 114
+      }
+    },
+    {
+      "type": "expressionNode",
+      "content": {
+        "expressions": [
+          {
+            "id": "e1-1",
+            "key": "seasonalPromotion",
+            "value": "booking.isSeasonalPromotion == true ? 1.5 : 1"
+          },
+          {
+            "id": "e1-2",
+            "key": "calculatedPoints",
+            "value": "floor(points.basePoints * points.fareMultiplier * points.statusMultiplier * $.seasonalPromotion)"
+          },
+          {
+            "id": "e1-3",
+            "key": "totalPoints",
+            "value": "$.calculatedPoints"
+          }
+        ],
+        "passThrough": false,
+        "inputField": null,
+        "outputPath": null,
+        "executionMode": "single"
+      },
+      "id": "ex1",
+      "name": "calculateTotalPoints",
+      "position": {
+        "x": 1390,
+        "y": 114
+      }
+    }
+  ],
+  "edges": [
+    {
+      "id": "ed1",
+      "sourceId": "ip1",
+      "targetId": "dt1",
+      "type": "edge"
+    },
+    {
+      "id": "ed2",
+      "sourceId": "dt1",
+      "targetId": "dt2",
+      "type": "edge"
+    },
+    {
+      "id": "ed3",
+      "sourceId": "dt2",
+      "targetId": "dt3",
+      "type": "edge"
+    },
+    {
+      "id": "ed4",
+      "sourceId": "dt3",
+      "targetId": "ex1",
+      "type": "edge"
+    }
+  ]
+}