From 9ccf99eb4f99b6542606512b80df190c21e1bf02 Mon Sep 17 00:00:00 2001
From: jasquat <jasquat@users.noreply.github.com>
Date: Fri, 13 Oct 2023 11:57:29 -0400
Subject: [PATCH] added some more typed dicts w/ burnettk

---
 poetry.lock                                   |  2 +-
 pyproject.toml                                |  1 +
 .../command_interface.py                      | 50 ++++++++++++++-----
 3 files changed, 40 insertions(+), 13 deletions(-)

diff --git a/poetry.lock b/poetry.lock
index d473ea2..3c64ecb 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -351,4 +351,4 @@ zstd = ["zstandard (>=0.18.0)"]
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.9"
-content-hash = "731eb1f75f491b8d8588d03b91d010b5a11f344d45c933aeeee1d478d3b7d7d5"
+content-hash = "06fcba658e40f009132662bd727c73d2dba09b6201f7149fe1384f770e0ce661"
diff --git a/pyproject.toml b/pyproject.toml
index 63ffb25..61f928f 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -9,6 +9,7 @@ packages = [{include = "spiffworkflow_connector_command", from = "src" }]
 [tool.poetry.dependencies]
 python = "^3.9"
 requests = "^2.28.2"
+typing-extensions = "^4.8.0"
 
 
 [tool.poetry.group.dev.dependencies]
diff --git a/src/spiffworkflow_connector_command/command_interface.py b/src/spiffworkflow_connector_command/command_interface.py
index 713e93b..ffce776 100644
--- a/src/spiffworkflow_connector_command/command_interface.py
+++ b/src/spiffworkflow_connector_command/command_interface.py
@@ -1,26 +1,52 @@
 from __future__ import annotations
 
 import abc
+import sys
 from typing import Any
-from typing import TypedDict
+
+if sys.version_info < (3, 11):
+    from typing_extensions import NotRequired
+    from typing_extensions import TypedDict
+else:
+    from typing import NotRequired
+    from typing import TypedDict
+
+
+class CommandErrorDict(TypedDict):
+    error_name: str
+    message: str
 
 
 class CommandResponseDict(TypedDict):
-    response: dict
+    """This is passed back to spiffworkflow-backend as the response body."""
+
+    # this is given to the service task as task data
+    command_response: dict
+    error: CommandErrorDict | None
+
+    # these are printed to spiffworkflow-backend logs
+    spiff__logs: NotRequired[list[str]| None]
+
+    # added by spiffworkflow-proxy if not set
+    # example: http/GetRequestV2
+    operator_id: NotRequired[str]
+
+
+class CommandResultDict(TypedDict):
+    """spiffworkflow-proxy parses this result to determine what happended."""
+    response: CommandResponseDict
     status: int
+    mimetype: str
 
 
-class CommandInterface(metaclass=abc.ABCMeta):
+class ConnectorCommand(metaclass=abc.ABCMeta):
     """Abstract class to describe how to make a command."""
 
-    @classmethod
-    def __subclasshook__(cls, subclass: Any) -> bool:
-        return (
-            hasattr(subclass, "execute")
-            and callable(subclass.run)
-            and NotImplemented
-        )
-
     @abc.abstractmethod
-    def execute(self, config: Any, task_data: dict) -> CommandResponseDict:
+    def execute(self, config: Any, task_data: dict) -> CommandResultDict:
         raise NotImplementedError("method must be implemented on subclass: execute")
+
+    # this is not a required method but if it gets used then it must be overridden
+    def app_description(self, *args: Any, **kwargs: Any) -> dict:
+        """Return a dict to describe the connector. This is used only for authentication commands at the moment."""
+        raise NotImplementedError("method must be implemented on subclass: app_description")