feat: add note action buttons events and effects (#258)

canvas_generated/messages/effects_pb2.pyi

@@ -160,6 +160,7 @@ class EffectType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     DELETE_STRUCTURED_ASSESSMENT_COMMAND: _ClassVar[EffectType]
     COMMIT_STRUCTURED_ASSESSMENT_COMMAND: _ClassVar[EffectType]
     ENTER_IN_ERROR_STRUCTURED_ASSESSMENT_COMMAND: _ClassVar[EffectType]
+    SHOW_ACTION_BUTTON: _ClassVar[EffectType]
 UNKNOWN_EFFECT: EffectType
 LOG: EffectType
 ADD_PLAN_COMMAND: EffectType
@@ -313,6 +314,7 @@ EDIT_STRUCTURED_ASSESSMENT_COMMAND: EffectType
 DELETE_STRUCTURED_ASSESSMENT_COMMAND: EffectType
 COMMIT_STRUCTURED_ASSESSMENT_COMMAND: EffectType
 ENTER_IN_ERROR_STRUCTURED_ASSESSMENT_COMMAND: EffectType
+SHOW_ACTION_BUTTON: EffectType
 
 class Effect(_message.Message):
     __slots__ = ("type", "payload", "plugin_name", "classname")

canvas_generated/messages/events_pb2.pyi

@@ -647,6 +647,9 @@ class EventType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     DEFER_CODING_GAP_COMMAND__PRE_EXECUTE_ACTION: _ClassVar[EventType]
     DEFER_CODING_GAP_COMMAND__POST_EXECUTE_ACTION: _ClassVar[EventType]
     DEFER_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE: _ClassVar[EventType]
+    SHOW_NOTE_HEADER_BUTTON: _ClassVar[EventType]
+    SHOW_NOTE_FOOTER_BUTTON: _ClassVar[EventType]
+    ACTION_BUTTON_CLICKED: _ClassVar[EventType]
     PATIENT_CHART__CONDITIONS: _ClassVar[EventType]
     PATIENT_CHART_SUMMARY__SECTION_CONFIGURATION: _ClassVar[EventType]
     PATIENT_PROFILE__SECTION_CONFIGURATION: _ClassVar[EventType]
@@ -1292,6 +1295,9 @@ DEFER_CODING_GAP_COMMAND__POST_ENTER_IN_ERROR: EventType
 DEFER_CODING_GAP_COMMAND__PRE_EXECUTE_ACTION: EventType
 DEFER_CODING_GAP_COMMAND__POST_EXECUTE_ACTION: EventType
 DEFER_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE: EventType
+SHOW_NOTE_HEADER_BUTTON: EventType
+SHOW_NOTE_FOOTER_BUTTON: EventType
+ACTION_BUTTON_CLICKED: EventType
 PATIENT_CHART__CONDITIONS: EventType
 PATIENT_CHART_SUMMARY__SECTION_CONFIGURATION: EventType
 PATIENT_PROFILE__SECTION_CONFIGURATION: EventType

canvas_sdk/effects/show_button.py

@@ -0,0 +1,28 @@
+from typing import Any
+
+from pydantic import Field
+
+from canvas_generated.messages.effects_pb2 import EffectType
+from canvas_sdk.effects.base import _BaseEffect
+
+
+class ShowButtonEffect(_BaseEffect):
+    """
+    An Effect that will decide an action button's properties.
+    """
+
+    class Meta:
+        effect_type = EffectType.SHOW_ACTION_BUTTON
+
+    key: str = Field(min_length=1)
+    title: str = Field(min_length=1)
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """The ShowButtonEffect's values."""
+        return {"key": self.key, "title": self.title}
+
+    @property
+    def effect_payload(self) -> dict[str, Any]:
+        """The payload of the effect."""
+        return {"data": self.values}

canvas_sdk/handlers/action_button.py

@@ -0,0 +1,55 @@
+from abc import abstractmethod
+from enum import StrEnum
+
+from canvas_sdk.effects import Effect
+from canvas_sdk.effects.show_button import ShowButtonEffect
+from canvas_sdk.events import EventType
+from canvas_sdk.handlers.base import BaseHandler
+
+
+class ActionButton(BaseHandler):
+    """Base class for action buttons."""
+
+    RESPONDS_TO = [
+        EventType.Name(EventType.SHOW_NOTE_HEADER_BUTTON),
+        EventType.Name(EventType.SHOW_NOTE_FOOTER_BUTTON),
+        EventType.Name(EventType.ACTION_BUTTON_CLICKED),
+    ]
+
+    class ButtonLocation(StrEnum):
+        NOTE_HEADER = "note_header"
+        NOTE_FOOTER = "note_footer"
+
+    BUTTON_TITLE: str = ""
+    BUTTON_KEY: str = ""
+    BUTTON_LOCATION: ButtonLocation | None = None
+
+    @abstractmethod
+    def handle(self) -> list[Effect]:
+        """Method to handle button click."""
+        raise NotImplementedError("Implement to handle button click")
+
+    def visible(self) -> bool:
+        """Method to determine button visibility."""
+        return True
+
+    def compute(self) -> list[Effect]:
+        """Method to compute the effects."""
+        if self.BUTTON_LOCATION is None:
+            return []
+
+        if self.event.type in (
+            EventType.SHOW_NOTE_HEADER_BUTTON,
+            EventType.SHOW_NOTE_FOOTER_BUTTON,
+        ):
+            if self.context["location"].lower() == self.BUTTON_LOCATION.value and self.visible():
+                return [ShowButtonEffect(key=self.BUTTON_KEY, title=self.BUTTON_TITLE).apply()]
+            else:
+                return []
+        elif (
+            self.event.type == EventType.ACTION_BUTTON_CLICKED
+            and self.context["key"] == self.BUTTON_KEY
+        ):
+            return self.handle()
+
+        return []

canvas_sdk/handlers/base.py

@@ -1,4 +1,5 @@
 import importlib.metadata
+from abc import ABC
 from typing import Any
 
 import deprecation
@@ -8,8 +9,10 @@
 version = importlib.metadata.version("canvas")
 
 
-class BaseHandler:
-    """The class that all handlers inherit from."""
+class BaseHandler(ABC):
+    """
+    The class that all handlers inherit from.
+    """
 
     secrets: dict[str, Any]
     event: Event

protobufs/canvas_generated/messages/effects.proto

@@ -194,6 +194,9 @@ enum EffectType {
   DELETE_STRUCTURED_ASSESSMENT_COMMAND = 902;
   COMMIT_STRUCTURED_ASSESSMENT_COMMAND = 903;
   ENTER_IN_ERROR_STRUCTURED_ASSESSMENT_COMMAND = 904;
+
+  SHOW_ACTION_BUTTON = 1000;
+
 }
 
 message Effect {

protobufs/canvas_generated/messages/events.proto

@@ -987,14 +987,16 @@ enum EventType {
   DEFER_CODING_GAP_COMMAND__POST_EXECUTE_ACTION = 60011;
   DEFER_CODING_GAP_COMMAND__POST_INSERTED_INTO_NOTE = 60012;
 
+  SHOW_NOTE_HEADER_BUTTON = 70000;
+  SHOW_NOTE_FOOTER_BUTTON = 70001;
+  ACTION_BUTTON_CLICKED = 70002;
 
   PATIENT_CHART__CONDITIONS = 100000;
   PATIENT_CHART_SUMMARY__SECTION_CONFIGURATION = 100001;
 
   PATIENT_PROFILE__SECTION_CONFIGURATION = 100002;
   PATIENT_PROFILE__ADD_PHARMACY__POST_SEARCH = 100003;
 
-
   CLAIM__CONDITIONS = 101000;
 
   PLUGIN_CREATED = 102000;