splunk-soar-sdk 1.6.2__tar.gz → 1.6.3__tar.gz

{splunk_soar_sdk-1.6.2 → splunk_soar_sdk-1.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 1.6.2
+Version: 1.6.3
 Summary: The official framework for developing and testing Splunk SOAR Apps
 Project-URL: Homepage, https://github.com/phantomcyber/splunk-soar-sdk
 Project-URL: Documentation, https://github.com/phantomcyber/splunk-soar-sdk

{splunk_soar_sdk-1.6.2 → splunk_soar_sdk-1.6.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "1.6.2"
+version = "1.6.3"
 description = "The official framework for developing and testing Splunk SOAR Apps"
 readme = "README.md"
 requires-python = ">=3.9, <3.14"

splunk_soar_sdk-1.6.3/release_notes.txt

@@ -0,0 +1,21 @@
+## [1.6.3](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.6.2...1.6.3) (2025-09-23)
+
+
+### Bug Fixes
+
+* allow ActionOutput to be Optional ([8d6f2c6](https://github.com/phantomcyber/splunk-soar-sdk/commit/8d6f2c650d938f25ae3f6ab71412acbe4c4eeb08))
+
+
+
+
+
+## [1.6.3](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.6.2...1.6.3) (2025-09-23)
+
+
+### Bug Fixes
+
+* allow ActionOutput to be Optional ([8d6f2c6](https://github.com/phantomcyber/splunk-soar-sdk/commit/8d6f2c650d938f25ae3f6ab71412acbe4c4eeb08))
+
+
+
+

splunk_soar_sdk-1.6.3/release_version.txt

@@ -0,0 +1 @@
+1.6.3

{splunk_soar_sdk-1.6.2 → splunk_soar_sdk-1.6.3}/src/soar_sdk/action_results.py

@@ -200,13 +200,15 @@ class ActionOutput(BaseModel):
                 field_type = get_args(field_type)[0]
                 datapath += ".*"
 
-            # For some reason, issubclass(Optional, _) doesn't work.
-            # This provides a nicer error message to an app dev, unless and
-            # until we can build proper support for Optional types.
-            if get_origin(field_type) is Union:
-                raise TypeError(
-                    f"Output field {field_name} cannot be Union or Optional."
-                )
+            if get_origin(field_type) is Union or get_origin(field_type) is Optional:
+                type_args = [
+                    arg for arg in get_args(field_type) if arg is not type(None)
+                ]
+                if len(type_args) > 1:
+                    raise TypeError(
+                        f"Output field {field_name} is invalid: the only valid Union type is Optional, or Union[X, None]."
+                    )
+                field_type = type_args[0]
 
             if issubclass(field_type, ActionOutput):
                 # If the field is another ActionOutput, recursively call _to_json_schema

{splunk_soar_sdk-1.6.2 → splunk_soar_sdk-1.6.3}/tests/test_action_results.py

@@ -19,6 +19,7 @@ class ExampleActionOutput(ActionOutput):
     )
     nested_type: ExampleInnerData
     list_of_types: list[ExampleInnerData]
+    optional_field: Optional[str] = None
 
 
 def test_action_output_to_json_schema():
@@ -43,6 +44,7 @@ def test_action_output_to_json_schema():
             "data_type": "string",
             "example_values": ["example_value_1", "example_value_2"],
         },
+        {"data_path": "action_result.data.*.optional_field", "data_type": "string"},
     ]
 
     schema = list(ExampleActionOutput._to_json_schema())
@@ -53,20 +55,26 @@ class BadActionOutput(ActionOutput):
     byte_field: bytes
 
 
-class BadOptionalActionOutput(ActionOutput):
-    optional_field: Optional[str] = None
+class BadUnionActionOutput(ActionOutput):
+    union_field: Union[str, int]
 
 
-class BadUnionActionOutput(ActionOutput):
-    optional_field: Union[str, int]
+class BadOptionalUnionActionOutput(ActionOutput):
+    evil_field: Optional[Union[str, int]]
 
 
 @pytest.mark.parametrize(
-    "action_output_class",
-    (BadActionOutput, BadOptionalActionOutput, BadUnionActionOutput),
+    "action_output_class, expected_message",
+    [
+        (BadActionOutput, "Unsupported field type"),
+        (BadUnionActionOutput, "only valid Union type"),
+        (BadOptionalUnionActionOutput, "only valid Union type"),
+    ],
 )
-def test_action_output_to_json_schema_bad_type(action_output_class: type[ActionOutput]):
-    with pytest.raises(TypeError):
+def test_action_output_to_json_schema_bad_type(
+    action_output_class: type[ActionOutput], expected_message: str
+):
+    with pytest.raises(TypeError, match=expected_message):
         next(action_output_class._to_json_schema())
 
 
@@ -118,5 +126,6 @@ def test_action_output_to_dict():
             {"inner_string": "inner_value_1"},
             {"inner_string": "inner_value_2"},
         ],
+        "optional_field": None,
     }
     assert action_output.dict(by_alias=True) == expected_dict

{splunk_soar_sdk-1.6.2 → splunk_soar_sdk-1.6.3}/uv.lock

@@ -1291,7 +1291,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "1.6.2"
+version = "1.6.3"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4", marker = "(python_full_version < '3.10' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'linux')" },

splunk_soar_sdk-1.6.2/release_notes.txt

@@ -1,21 +0,0 @@
-## [1.6.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.6.1...1.6.2) (2025-09-22)
-
-
-### Bug Fixes
-
-* weird decrypt error edge case for sensitive params ([93f1f2e](https://github.com/phantomcyber/splunk-soar-sdk/commit/93f1f2ea664fbd003722904c7cdb8c7bbf84e320))
-
-
-
-
-
-## [1.6.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.6.1...1.6.2) (2025-09-22)
-
-
-### Bug Fixes
-
-* weird decrypt error edge case for sensitive params ([93f1f2e](https://github.com/phantomcyber/splunk-soar-sdk/commit/93f1f2ea664fbd003722904c7cdb8c7bbf84e320))
-
-
-
-

splunk_soar_sdk-1.6.2/release_version.txt

@@ -1 +0,0 @@
-1.6.2