splunk-soar-sdk 2.1.0__py3-none-any.whl → 2.2.0__py3-none-any.whl

soar_sdk/action_results.py

@@ -83,12 +83,16 @@ class OutputFieldSpecification(TypedDict):
     data_type: str
     contains: NotRequired[list[str]]
     example_values: NotRequired[list[Union[str, float, bool]]]
+    column_name: NotRequired[str]
+    column_order: NotRequired[int]
 
 
 def OutputField(
     cef_types: Optional[list[str]] = None,
     example_values: Optional[list[Union[str, float, bool]]] = None,
     alias: Optional[str] = None,
+    column_name: Optional[str] = None,
+    column_order: Optional[int] = None,
 ) -> Any:  # noqa: ANN401
     """Define metadata for an action output field.
 
@@ -102,6 +106,11 @@ def OutputField(
         example_values: Optional list of example values for this field, used
             in documentation and for testing/validation purposes.
         alias: Optional alternative name for the field when serialized.
+        column_name: Optional name for the field when displayed in a table.
+        column_order: Optional order for the field when displayed in a table (0-indexed).
+
+    Note:
+        Column name and order must be set together, if one is set but the other is not, an error will be raised.
 
     Returns:
         A Pydantic Field object with the specified metadata.
@@ -116,8 +125,10 @@ def OutputField(
     """
     return Field(
         examples=example_values,
-        cef_types=cef_types,
         alias=alias,
+        cef_types=cef_types,
+        column_name=column_name,
+        column_order=column_order,
     )
 
 
@@ -230,6 +241,21 @@ class ActionOutput(BaseModel):
             if field_type is bool:
                 schema_field["example_values"] = [True, False]
 
+            # Validate column metadata - both column_name and column_order must be present together
+            column_name = field.field_info.extra.get("column_name")
+            column_order = field.field_info.extra.get("column_order")
+
+            # Check if exactly one is set (XOR condition - invalid)
+            if (column_name is None) != (column_order is None):
+                raise ValueError(
+                    f"Field '{field_name}' must have both 'column_name' and 'column_order' "
+                    f"or neither. Found: column_name={column_name}, column_order={column_order}"
+                )
+
+            if column_name is not None and column_order is not None:
+                schema_field["column_name"] = column_name
+                schema_field["column_order"] = column_order
+
             yield schema_field
 
 

soar_sdk/app.py

@@ -237,6 +237,7 @@ class App:
         read_only: bool = True,
         params_class: Optional[type[Params]] = None,
         output_class: Optional[type[ActionOutput]] = None,
+        render_as: Optional[str] = None,
         view_handler: Union[str, Callable, None] = None,
         view_template: Optional[str] = None,
         versions: str = "EQ(*)",
@@ -355,6 +356,7 @@ class App:
             read_only=read_only,
             params_class=params_class,
             output_class=output_class,
+            render_as=render_as,
             view_handler=view_handler,
             versions=versions,
             summary_type=summary_type,
@@ -421,6 +423,7 @@ class App:
         read_only: bool = True,
         params_class: Optional[type[Params]] = None,
         output_class: Optional[type[ActionOutput]] = None,
+        render_as: Optional[str] = None,
         view_handler: Optional[Callable] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
@@ -440,6 +443,7 @@ class App:
             read_only=read_only,
             params_class=params_class,
             output_class=output_class,
+            render_as=render_as,
             view_handler=view_handler,
             versions=versions,
             summary_type=summary_type,
@@ -647,9 +651,17 @@ class App:
             statuses = []
             for item in result:
                 statuses.append(
-                    App._adapt_action_result(item, actions_manager, action_params)
+                    App._adapt_action_result(
+                        item, actions_manager, action_params, message, summary
+                    )
+                )
+            # Handle empty list/iterator case
+            if not statuses:
+                result = ActionOutput(
+                    status=True, message=message or "Action completed successfully"
                 )
-            return all(statuses)
+            else:
+                return all(statuses)
 
         if isinstance(result, ActionOutput):
             output_dict = result.dict(by_alias=True)

soar_sdk/decorators/action.py

@@ -39,6 +39,7 @@ class ActionDecorator:
             AsyncGenerator[type[ActionOutput]],
             list[type[ActionOutput]],
         ] = None,
+        render_as: Optional[str] = None,
         view_handler: Optional[Callable] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
@@ -53,6 +54,7 @@ class ActionDecorator:
         self.read_only = read_only
         self.params_class = params_class
         self.output_class = output_class
+        self.render_as = render_as
         self.view_handler = view_handler
         self.versions = versions
         self.summary_type = summary_type
@@ -100,6 +102,14 @@ class ActionDecorator:
                 "Return type for action function must be derived from ActionOutput class."
             )
 
+        if self.view_handler:
+            self.render_as = "custom"
+
+        if self.render_as and self.render_as not in ("table", "json", "custom"):
+            raise ValueError(
+                "Please only specify render_as as 'table' or 'json' or 'custom'."
+            )
+
         @action_protocol
         @wraps(function)
         def inner(
@@ -152,6 +162,7 @@ class ActionDecorator:
             parameters=validated_params_class,
             output=validated_output_class,
             versions=self.versions,
+            render_as=self.render_as,
             view_handler=self.view_handler,
             summary_type=self.summary_type,
             enable_concurrency_lock=self.enable_concurrency_lock,

soar_sdk/meta/actions.py

@@ -20,6 +20,7 @@ class ActionMeta(BaseModel):
     verbose: str = ""
     parameters: Type[Params] = Field(default=Params)  # noqa: UP006
     output: Type[ActionOutput] = Field(default=ActionOutput)  # noqa: UP006
+    render_as: Optional[str] = None
     view_handler: Optional[Callable] = None
     summary_type: Optional[Type[ActionOutput]] = Field(default=None, exclude=True)  # noqa: UP006
     enable_concurrency_lock: bool = False
@@ -31,6 +32,13 @@ class ActionMeta(BaseModel):
         data["output"] = OutputsSerializer.serialize_datapaths(
             self.parameters, self.output, summary_class=self.summary_type
         )
+        if self.view_handler:
+            self.render_as = "custom"
+
+        if self.render_as:
+            data["render"] = {
+                "type": self.render_as,
+            }
 
         if self.view_handler:
             remove_when_soar_newer_than("6.4.1")
@@ -45,13 +53,11 @@ class ActionMeta(BaseModel):
             else:
                 relative_module = module
 
-            data["render"] = {
-                "type": "custom",
-                "view": f"{relative_module}.{self.view_handler.__name__}",
-            }
+            data["render"]["view"] = f"{relative_module}.{self.view_handler.__name__}"
 
         # Remove view_handler from the output since in render
         data.pop("view_handler", None)
+        data.pop("render_as", None)
 
         if self.enable_concurrency_lock:
             data["lock"] = {"enabled": True}

{splunk_soar_sdk-2.1.0.dist-info → splunk_soar_sdk-2.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.1.0
+Version: 2.2.0
 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-2.1.0.dist-info → splunk_soar_sdk-2.2.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
 soar_sdk/abstract.py,sha256=jGXs2Fv5TRpnh5Duz3mWjY8_DAOpY4RSSzvw_z4XN4I,7950
-soar_sdk/action_results.py,sha256=7uEl1KidC2gkNOuBzOq2_3EiAGfRQYrDYD3CR-G6DKg,10116
+soar_sdk/action_results.py,sha256=5Lr3J1G2hcVVTQD35eo7OG3Cvr7eGZgb-FL2Eb5pBx8,11424
 soar_sdk/actions_manager.py,sha256=wJCyfzkI_6OKZ-Kmll4vRJpGvYdL93Uw-JyEEGnKcw0,5779
-soar_sdk/app.py,sha256=yCD4HqJKFhfehyXixHqO-kEwzycII-_ephRpxEINIE0,32906
+soar_sdk/app.py,sha256=lYvaDUYEV6b_uF4CyPh6wlAIbCNISya7bJ8Z2xJyyGY,33356
 soar_sdk/app_cli_runner.py,sha256=fJoozhyAt7QUMuc02nE5RL_InpsjQBpr6U4rF9sey3E,11627
 soar_sdk/app_client.py,sha256=0r3jIvMM8szCEHXOgRu07VaovKH96pZut5rn2GfYcsc,6275
 soar_sdk/asset.py,sha256=deS8_B5hr7W2fED8_6wUpVriRgiQ5r8TkGVHiasIaro,10666
@@ -49,14 +49,14 @@ soar_sdk/code_renderers/renderer.py,sha256=oDlmU-MzDqpc4Yq6zupoT4XN-vRjgL4UV5lOG
 soar_sdk/code_renderers/toml_renderer.py,sha256=-zP8UzlYMCVVA5ex9slaNLeFTu4xLjkv88YLmRNLrTM,1505
 soar_sdk/code_renderers/templates/pyproject.toml.jinja,sha256=Ti6A5kWMb902Lbd1kmw8qPgVDPNNzlV6rd0pcVEbVUo,3917
 soar_sdk/decorators/__init__.py,sha256=ttvapTczeQpReZVYgjTw4qnEqKd7b8pR7lNaCpO0npQ,513
-soar_sdk/decorators/action.py,sha256=WgkOtlfUpRGkFv1Be1ycRm3s_1UYabCJqoI5MMFWsi8,6304
+soar_sdk/decorators/action.py,sha256=ZuSsowsBeEuenGQw03iyd2uv-Ymp9kQYnhYsx7k7pX8,6695
 soar_sdk/decorators/make_request.py,sha256=W_ltGvryTvdKomiJ8gL7rE_KVc1VVodhFYstGxB8d4Q,5527
 soar_sdk/decorators/on_poll.py,sha256=xdT0QSa_dnh37XdJNGW-DAZsb9oQO5tjxPbIQmWpaZs,8232
 soar_sdk/decorators/test_connectivity.py,sha256=8uXMD4NW5bokpsAfBctUrfOR4K_geYLEZUY0Y6uI6aU,3568
 soar_sdk/decorators/view_handler.py,sha256=jhBzbJcokWOeUWR4_orDRWTXiiVwE9RZdRSvNUYF3S0,7362
 soar_sdk/decorators/webhook.py,sha256=Pde0MjxC2kckpxoKb3m4WVfLWtiFAAzAwZe5AF5VIbE,2400
 soar_sdk/meta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-soar_sdk/meta/actions.py,sha256=L64T9DaWGiqjS2EpB72kO-63gPuVyCJ-lYlaKAvT2uM,2394
+soar_sdk/meta/actions.py,sha256=nrTBwCnCwjOzof-_8Ww9vfoTIfZfauiL6C6DTRg2Mhs,2580
 soar_sdk/meta/adapters.py,sha256=KjSYIUtkCz2eesA_vhsNCjfi5C-Uz71tbSuDIjhuB8U,1112
 soar_sdk/meta/app.py,sha256=rwgoFfIFnLutLB9PF1kR7X1neKs175VA0Xx4KpJ6c7I,1765
 soar_sdk/meta/datatypes.py,sha256=piR-oBVAATiRciXSdVE7XaqjUZTgSaOvTEqcOcNvCS0,795
@@ -96,8 +96,8 @@ soar_sdk/views/components/pie_chart.py,sha256=LVTeHVJN6nf2vjUs9y7PDBhS0U1fKW750l
 soar_sdk/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/webhooks/models.py,sha256=-rjuFA9cRX5zTLp7cHSHVTkt5eVJD6BdESGbj_qkyHI,4540
 soar_sdk/webhooks/routing.py,sha256=BKbURSrBPdOTS5UFL-mHzFEr-Fj04mJMx9KeiPrZ2VQ,6872
-splunk_soar_sdk-2.1.0.dist-info/METADATA,sha256=lk4jyDyQKtbWUH3aTODNW4eSQho4UKsQ4sNmiMB7MH8,7361
-splunk_soar_sdk-2.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-2.1.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-2.1.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-2.1.0.dist-info/RECORD,,
+splunk_soar_sdk-2.2.0.dist-info/METADATA,sha256=N4S0W2q6KuT_hGulekYRuub3Ux29bFmEShcrwHguVzc,7361
+splunk_soar_sdk-2.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-2.2.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-2.2.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-2.2.0.dist-info/RECORD,,