feat: add new locations and colors to action buttons

canvas_generated/messages/events_pb2.pyi

@@ -1005,6 +1005,8 @@ class EventType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     SHOW_NOTE_FOOTER_BUTTON: _ClassVar[EventType]
     ACTION_BUTTON_CLICKED: _ClassVar[EventType]
     SHOW_NOTE_BODY_BUTTON: _ClassVar[EventType]
+    SHOW_PROFILE_PATIENT_HEADER_BUTTON: _ClassVar[EventType]
+    SHOW_CHART_PATIENT_HEADER_BUTTON: _ClassVar[EventType]
     PATIENT_CHART__CONDITIONS: _ClassVar[EventType]
     PATIENT_CHART__DETECTED_ISSUES: _ClassVar[EventType]
     PATIENT_CHART_SUMMARY__SECTION_CONFIGURATION: _ClassVar[EventType]
@@ -2083,6 +2085,8 @@ SHOW_NOTE_HEADER_BUTTON: EventType
 SHOW_NOTE_FOOTER_BUTTON: EventType
 ACTION_BUTTON_CLICKED: EventType
 SHOW_NOTE_BODY_BUTTON: EventType
+SHOW_PROFILE_PATIENT_HEADER_BUTTON: EventType
+SHOW_CHART_PATIENT_HEADER_BUTTON: EventType
 PATIENT_CHART__CONDITIONS: EventType
 PATIENT_CHART__DETECTED_ISSUES: EventType
 PATIENT_CHART_SUMMARY__SECTION_CONFIGURATION: EventType

canvas_sdk/effects/show_button.py

@@ -17,11 +17,19 @@ class Meta:
     key: str = Field(min_length=1)
     title: str = Field(min_length=1)
     priority: int = Field(default=0)
+    color: str | None = Field(min_length=7, max_length=7, default=None)
+    background: str | None = Field(min_length=7, max_length=7, default=None)
 
     @property
     def values(self) -> dict[str, Any]:
         """The ShowButtonEffect's values."""
-        return {"key": self.key, "title": self.title, "priority": self.priority}
+        return {
+            "key": self.key,
+            "title": self.title,
+            "priority": self.priority,
+            "color": self.color,
+            "background": self.background,
+        }
 
     @property
     def effect_payload(self) -> dict[str, Any]:

canvas_sdk/handlers/action_button.py

@@ -17,6 +17,8 @@ class ActionButton(BaseHandler):
         EventType.Name(EventType.SHOW_NOTE_HEADER_BUTTON),
         EventType.Name(EventType.SHOW_NOTE_FOOTER_BUTTON),
         EventType.Name(EventType.SHOW_NOTE_BODY_BUTTON),
+        EventType.Name(EventType.SHOW_PROFILE_PATIENT_HEADER_BUTTON),
+        EventType.Name(EventType.SHOW_CHART_PATIENT_HEADER_BUTTON),
         EventType.Name(EventType.SHOW_CHART_SUMMARY_SOCIAL_DETERMINANTS_SECTION_BUTTON),
         EventType.Name(EventType.SHOW_CHART_SUMMARY_GOALS_SECTION_BUTTON),
         EventType.Name(EventType.SHOW_CHART_SUMMARY_CONDITIONS_SECTION_BUTTON),
@@ -35,6 +37,8 @@ class ButtonLocation(StrEnum):
         NOTE_HEADER = "note_header"
         NOTE_FOOTER = "note_footer"
         NOTE_BODY = "note_body"
+        PROFILE_PATIENT_HEADER = "profile_patient_header"
+        CHART_PATIENT_HEADER = "chart_patient_header"
         CHART_SUMMARY_SOCIAL_DETERMINANTS_SECTION = "chart_summary_social_determinants_section"
         CHART_SUMMARY_GOALS_SECTION = "chart_summary_goals_section"
         CHART_SUMMARY_CONDITIONS_SECTION = "chart_summary_conditions_section"
@@ -51,6 +55,8 @@ class ButtonLocation(StrEnum):
     BUTTON_KEY: str = ""
     BUTTON_LOCATION: ButtonLocation
     PRIORITY: int = 0
+    BUTTON_TEXT_COLOR: str | None = None
+    BUTTON_BACKGROUND_COLOR: str | None = None
 
     @abstractmethod
     def handle(self) -> list[Effect]:
@@ -73,7 +79,11 @@ def compute(self) -> list[Effect]:
             if self.ButtonLocation[location] == self.BUTTON_LOCATION and self.visible():
                 return [
                     ShowButtonEffect(
-                        key=self.BUTTON_KEY, title=self.BUTTON_TITLE, priority=self.PRIORITY
+                        key=self.BUTTON_KEY,
+                        title=self.BUTTON_TITLE,
+                        priority=self.PRIORITY,
+                        color=self.BUTTON_TEXT_COLOR,
+                        background=self.BUTTON_BACKGROUND_COLOR,
                     ).apply()
                 ]
         elif self.context["key"] == self.BUTTON_KEY:

canvas_sdk/tests/handlers/test_action_button.py

@@ -0,0 +1,192 @@
+import json
+
+from canvas_sdk.effects import Effect
+from canvas_sdk.effects.show_button import ShowButtonEffect
+from canvas_sdk.events import Event, EventRequest, EventType
+from canvas_sdk.handlers.action_button import SHOW_BUTTON_REGEX, ActionButton
+
+
+class ExampleActionButton(ActionButton):
+    """A concrete implementation of ActionButton for testing."""
+
+    BUTTON_TITLE = "Test Button"
+    BUTTON_KEY = "test_button_key"
+    BUTTON_LOCATION = ActionButton.ButtonLocation.NOTE_HEADER
+    PRIORITY = 5
+    COLOR = "#FF0000"
+
+    def handle(self) -> list[Effect]:
+        """Handle button click by returning a mock effect."""
+        return [ShowButtonEffect(key="result", title="Clicked", priority=0).apply()]
+
+
+class InvisibleActionButton(ActionButton):
+    """An action button that is never visible."""
+
+    BUTTON_TITLE = "Hidden Button"
+    BUTTON_KEY = "hidden_key"
+    BUTTON_LOCATION = ActionButton.ButtonLocation.NOTE_FOOTER
+    PRIORITY = 0
+
+    def handle(self) -> list[Effect]:
+        """Handle button click."""
+        return []
+
+    def visible(self) -> bool:
+        """Always hidden."""
+        return False
+
+
+class NoColorActionButton(ActionButton):
+    """An action button with no color."""
+
+    BUTTON_TITLE = "No Color"
+    BUTTON_KEY = "no_color_key"
+    BUTTON_LOCATION = ActionButton.ButtonLocation.NOTE_BODY
+    PRIORITY = 0
+
+    def handle(self) -> list[Effect]:
+        """Handle button click."""
+        return []
+
+
+# --- SHOW_BUTTON_REGEX tests ---
+
+
+def test_show_button_regex_matches_show_events() -> None:
+    """Test that SHOW_BUTTON_REGEX matches SHOW_*_BUTTON event names."""
+    match = SHOW_BUTTON_REGEX.fullmatch("SHOW_NOTE_HEADER_BUTTON")
+    assert match is not None, "Expected regex to match SHOW_NOTE_HEADER_BUTTON"
+    assert match.group(1) == "NOTE_HEADER", "Expected extracted location to be NOTE_HEADER"
+
+
+def test_show_button_regex_extracts_location() -> None:
+    """Test that the regex extracts location correctly for various events."""
+    cases = {
+        "SHOW_NOTE_FOOTER_BUTTON": "NOTE_FOOTER",
+        "SHOW_NOTE_BODY_BUTTON": "NOTE_BODY",
+        "SHOW_CHART_PATIENT_HEADER_BUTTON": "CHART_PATIENT_HEADER",
+        "SHOW_CHART_SUMMARY_GOALS_SECTION_BUTTON": "CHART_SUMMARY_GOALS_SECTION",
+    }
+    for event_name, expected_location in cases.items():
+        match = SHOW_BUTTON_REGEX.fullmatch(event_name)
+        assert match is not None, f"Expected regex to match {event_name}"
+        assert match.group(1) == expected_location
+
+
+def test_show_button_regex_does_not_match_non_show_events() -> None:
+    """Test that the regex does not match non-SHOW events."""
+    assert SHOW_BUTTON_REGEX.fullmatch("ACTION_BUTTON_CLICKED") is None
+    assert SHOW_BUTTON_REGEX.fullmatch("SHOW_BUTTON") is None
+    assert SHOW_BUTTON_REGEX.fullmatch("RANDOM_EVENT") is None
+
+
+# --- RESPONDS_TO tests ---
+
+
+def test_responds_to_contains_expected_event_types() -> None:
+    """Test that RESPONDS_TO includes all show button events and ACTION_BUTTON_CLICKED."""
+    assert "ACTION_BUTTON_CLICKED" in ActionButton.RESPONDS_TO
+    assert "SHOW_NOTE_HEADER_BUTTON" in ActionButton.RESPONDS_TO
+    assert "SHOW_NOTE_FOOTER_BUTTON" in ActionButton.RESPONDS_TO
+    assert "SHOW_NOTE_BODY_BUTTON" in ActionButton.RESPONDS_TO
+    assert "SHOW_CHART_PATIENT_HEADER_BUTTON" in ActionButton.RESPONDS_TO
+    assert "SHOW_PROFILE_PATIENT_HEADER_BUTTON" in ActionButton.RESPONDS_TO
+
+
+# --- ButtonLocation enum tests ---
+
+
+def test_button_location_enum_values() -> None:
+    """Test that ButtonLocation enum has expected values."""
+    assert ActionButton.ButtonLocation.NOTE_HEADER.value == "note_header"
+    assert ActionButton.ButtonLocation.NOTE_FOOTER.value == "note_footer"
+    assert ActionButton.ButtonLocation.NOTE_BODY.value == "note_body"
+    assert ActionButton.ButtonLocation.CHART_PATIENT_HEADER.value == "chart_patient_header"
+    assert ActionButton.ButtonLocation.PROFILE_PATIENT_HEADER.value == "profile_patient_header"
+
+
+# --- visible() tests ---
+
+
+def test_default_visible_returns_true() -> None:
+    """Test that the default visible() method returns True."""
+    event = Event(EventRequest(type=EventType.SHOW_NOTE_HEADER_BUTTON))
+    button = ExampleActionButton(event)
+    assert button.visible() is True, "Default visible() should return True"
+
+
+# --- compute() show event tests ---
+
+
+def test_compute_show_event_matching_location() -> None:
+    """Test compute returns ShowButtonEffect for matching show event and location."""
+    event = Event(EventRequest(type=EventType.SHOW_NOTE_HEADER_BUTTON))
+    button = ExampleActionButton(event)
+    result = button.compute()
+
+    assert len(result) == 1, "Expected a single effect for matching location"
+    assert isinstance(result[0], Effect), "Effect should be an instance of Effect"
+
+
+def test_compute_show_event_non_matching_location() -> None:
+    """Test compute returns empty list when show event location doesn't match."""
+    event = Event(EventRequest(type=EventType.SHOW_NOTE_FOOTER_BUTTON))
+    button = ExampleActionButton(event)
+    result = button.compute()
+
+    assert result == [], "Expected no effects when location doesn't match"
+
+
+def test_compute_show_event_invisible_button() -> None:
+    """Test compute returns empty list when button is not visible."""
+    event = Event(EventRequest(type=EventType.SHOW_NOTE_FOOTER_BUTTON))
+    button = InvisibleActionButton(event)
+    result = button.compute()
+
+    assert result == [], "Expected no effects when button is not visible"
+
+
+def test_compute_show_button_effect_properties() -> None:
+    """Test that the ShowButtonEffect has correct properties from the handler."""
+    event = Event(EventRequest(type=EventType.SHOW_NOTE_HEADER_BUTTON))
+    button = ExampleActionButton(event)
+    effects = button.compute()
+
+    assert len(effects) == 1
+    payload = json.loads(effects[0].payload)
+    assert payload["data"]["key"] == "test_button_key"
+    assert payload["data"]["title"] == "Test Button"
+    assert payload["data"]["priority"] == 5
+    assert payload["data"]["color"] == "#FF0000"
+
+
+def test_compute_show_button_effect_no_color() -> None:
+    """Test that ShowButtonEffect works when COLOR is None."""
+    event = Event(EventRequest(type=EventType.SHOW_NOTE_BODY_BUTTON))
+    button = NoColorActionButton(event)
+    effects = button.compute()
+
+    assert len(effects) == 1
+    payload = json.loads(effects[0].payload)
+    assert payload["data"]["color"] is None
+
+
+# --- compute() no location tests ---
+
+
+def test_compute_no_button_location() -> None:
+    """Test compute returns empty list when BUTTON_LOCATION is falsy."""
+
+    class NoLocationButton(ActionButton):
+        BUTTON_TITLE = "No Location"
+        BUTTON_KEY = "no_loc"
+        BUTTON_LOCATION = ""  # type: ignore[assignment]
+        PRIORITY = 0
+
+        def handle(self) -> list[Effect]:
+            return []
+
+    event = Event(EventRequest(type=EventType.SHOW_NOTE_HEADER_BUTTON))
+    button = NoLocationButton(event)
+    assert button.compute() == [], "Expected no effects when BUTTON_LOCATION is falsy"

protobufs/canvas_generated/messages/events.proto

@@ -1217,6 +1217,8 @@ enum EventType {
   SHOW_NOTE_FOOTER_BUTTON = 70001;
   ACTION_BUTTON_CLICKED = 70002;
   SHOW_NOTE_BODY_BUTTON = 70003;
+  SHOW_PROFILE_PATIENT_HEADER_BUTTON = 70004;
+  SHOW_CHART_PATIENT_HEADER_BUTTON = 70005;
 
   PATIENT_CHART__CONDITIONS = 100000;
   PATIENT_CHART__DETECTED_ISSUES = 100005;