splunk-soar-sdk 2.1.1__py3-none-any.whl → 2.3.0__py3-none-any.whl

soar_sdk/action_results.py

@@ -2,10 +2,10 @@ from typing import Optional, Union, get_origin, get_args, Any
 from collections.abc import Iterator
 from typing_extensions import NotRequired, TypedDict
 from pydantic import BaseModel, Field
+import itertools
 
 from soar_sdk.compat import remove_when_soar_newer_than
 from soar_sdk.shims.phantom.action_result import ActionResult as PhantomActionResult
-
 from soar_sdk.meta.datatypes import as_datatype
 
 remove_when_soar_newer_than(
@@ -83,12 +83,15 @@ 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,
 ) -> Any:  # noqa: ANN401
     """Define metadata for an action output field.
 
@@ -102,6 +105,10 @@ 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.
+
+    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 +123,9 @@ def OutputField(
     """
     return Field(
         examples=example_values,
-        cef_types=cef_types,
         alias=alias,
+        cef_types=cef_types,
+        column_name=column_name,
     )
 
 
@@ -152,7 +160,9 @@ class ActionOutput(BaseModel):
 
     @classmethod
     def _to_json_schema(
-        cls, parent_datapath: str = "action_result.data.*"
+        cls,
+        parent_datapath: str = "action_result.data.*",
+        column_order_counter: Optional[itertools.count] = None,
     ) -> Iterator[OutputFieldSpecification]:
         """Convert the ActionOutput class to SOAR-compatible JSON schema.
 
@@ -163,6 +173,8 @@ class ActionOutput(BaseModel):
         Args:
             parent_datapath: The base datapath for fields in this output.
                 Defaults to "action_result.data.*" for top-level outputs.
+            column_order_counter: Iterator for tracking column order across fields.
+                Used internally to maintain sequential column ordering. Defaults to itertools.count().
 
         Yields:
             OutputFieldSpecification objects describing each field in the schema.
@@ -176,6 +188,9 @@ class ActionOutput(BaseModel):
             Nested ActionOutput classes are recursively processed.
             Boolean fields automatically get [True, False] example values.
         """
+        if column_order_counter is None:
+            column_order_counter = itertools.count()
+
         for _field_name, field in cls.__fields__.items():
             field_name = alias if (alias := field.alias) else _field_name
 
@@ -208,7 +223,7 @@ class ActionOutput(BaseModel):
 
             if issubclass(field_type, ActionOutput):
                 # If the field is another ActionOutput, recursively call _to_json_schema
-                yield from field_type._to_json_schema(datapath)
+                yield from field_type._to_json_schema(datapath, column_order_counter)
                 continue
             else:
                 try:
@@ -230,6 +245,12 @@ class ActionOutput(BaseModel):
             if field_type is bool:
                 schema_field["example_values"] = [True, False]
 
+            column_name = field.field_info.extra.get("column_name")
+
+            if column_name is not None:
+                schema_field["column_name"] = column_name
+                schema_field["column_order"] = next(column_order_counter)
+
             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,

soar_sdk/cli/manifests/serializers.py

@@ -1,6 +1,7 @@
 from typing import Any, Optional
 from collections.abc import Iterator
 from logging import getLogger
+import itertools
 
 from soar_sdk.meta.datatypes import as_datatype
 from soar_sdk.params import Params
@@ -29,8 +30,12 @@ class OutputsSerializer:
     @staticmethod
     def serialize_parameter_datapaths(
         params_class: type[Params],
+        column_order_counter: Optional[itertools.count] = None,
     ) -> Iterator[OutputFieldSpecification]:
         """Serializes the parameter data paths of a Params class to JSON schema."""
+        if column_order_counter is None:
+            column_order_counter = itertools.count()
+
         for field_name, field in params_class.__fields__.items():
             spec = OutputFieldSpecification(
                 data_path=f"action_result.parameter.{field_name}",
@@ -38,6 +43,12 @@ class OutputsSerializer:
             )
             if cef_types := field.field_info.extra.get("cef_types"):
                 spec["contains"] = cef_types
+
+            column_name = field.field_info.extra.get("column_name")
+
+            if column_name is not None:
+                spec["column_name"] = column_name
+                spec["column_order"] = next(column_order_counter)
             yield spec
 
     @classmethod
@@ -57,10 +68,13 @@ class OutputsSerializer:
             data_path="action_result.message",
             data_type="string",
         )
-        params = cls.serialize_parameter_datapaths(params_class)
-        outputs = outputs_class._to_json_schema()
+        column_order_counter = itertools.count()
+        params = cls.serialize_parameter_datapaths(params_class, column_order_counter)
+        outputs = outputs_class._to_json_schema(
+            column_order_counter=column_order_counter
+        )
         summary = (
-            summary_class._to_json_schema("action_result.summary")
+            summary_class._to_json_schema("action_result.summary", column_order_counter)
             if summary_class
             else []
         )

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}

soar_sdk/params.py

@@ -22,6 +22,7 @@ def Param(
     allow_list: bool = False,
     sensitive: bool = False,
     alias: Optional[str] = None,
+    column_name: Optional[str] = None,
 ) -> Any:  # noqa: ANN401
     """Representation of a single complex action parameter.
 
@@ -49,6 +50,7 @@ def Param(
     :param allow_list: Use this key to specify if the parameter supports specifying
       multiple values as a comma separated string.
     :param kwargs: additional kwargs accepted by pydantic.Field
+    :param column_name: Optional name for the parameter when displayed in an output table.
     :return: returns the FieldInfo object as pydantic.Field
     """
     if value_list is None:
@@ -64,6 +66,7 @@ def Param(
         allow_list=allow_list,
         sensitive=sensitive,
         alias=alias,
+        column_name=column_name,
     )
 
 
@@ -80,6 +83,8 @@ class InputFieldSpecification(TypedDict):
     value_list: NotRequired[list[str]]
     allow_list: bool
     default: NotRequired[Union[str, int, float, bool]]
+    column_name: NotRequired[str]
+    column_order: NotRequired[int]
 
 
 class Params(BaseModel):

{splunk_soar_sdk-2.1.1.dist-info → splunk_soar_sdk-2.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.1.1
+Version: 2.3.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.1.dist-info → splunk_soar_sdk-2.3.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=NQTcQ3NJcYB6h-YNRqO0bCG_hILmTidv2D4FdvCzyDE,11092
 soar_sdk/actions_manager.py,sha256=wJCyfzkI_6OKZ-Kmll4vRJpGvYdL93Uw-JyEEGnKcw0,5779
-soar_sdk/app.py,sha256=-Iq_0btBwZwRksSfrv7gzlBFJBblNM8VKZK6_rgMGog,33208
+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
@@ -13,7 +13,7 @@ soar_sdk/crypto.py,sha256=qiBMHUQqgn5lPI1DbujSj700s89FuLJrkQgCO9_eBn4,392
 soar_sdk/exceptions.py,sha256=CxJ_Q6N1jlknO_3ItDQNhHEw2pNWZr3sMLqutYmr5HA,1863
 soar_sdk/input_spec.py,sha256=BAa36l8IKDvM8SVMjgZ1XcnWZ2F7O052n2415tLeKK8,4690
 soar_sdk/logging.py,sha256=lSz8PA6hOCw2MHGE0ZSKbw-FzSr1WdbfQ7BHnXBUUY0,11440
-soar_sdk/params.py,sha256=8wo6buia91Hh-bxq0jVUU9MPN3XZVRzkMfKZ2BDuMLQ,7488
+soar_sdk/params.py,sha256=Q2tWOzZWNl2Spvnu29iSUfMleW8U7OD-DdCWtkOXRMw,7720
 soar_sdk/paths.py,sha256=XhpanQCAiTXaulRx440oKu36mnll7P05TethHXgMpgQ,239
 soar_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/types.py,sha256=uMFnNOHpmCLrbAhQOgmXjScXiGE67sM8ySN04MhkC3U,602
@@ -38,7 +38,7 @@ soar_sdk/cli/manifests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 soar_sdk/cli/manifests/cli.py,sha256=cly5xVdj4bBIdZVMQPIWTXRgUfd1ON3qKO-76Fwql18,524
 soar_sdk/cli/manifests/deserializers.py,sha256=FtXv-OywYGb_O5TptS2Hg6niWcfihRPF_RaS5zDBXRk,17045
 soar_sdk/cli/manifests/processors.py,sha256=6B1fQC2WGVaUP-7E9Y5g7BipaVwEomJCkUQ_7gRfSn8,4155
-soar_sdk/cli/manifests/serializers.py,sha256=tlW8QPuaVUF8u384lN02xIK2bS2XkDL52kPNwwPmj9c,2859
+soar_sdk/cli/manifests/serializers.py,sha256=0qps_2jsySXa4ytX3DvFt0tbbZlZ7mowIjMu9FEhQMc,3417
 soar_sdk/cli/package/cli.py,sha256=oCpP9E3PtXq-zCdzQD8Z-4dowKF1YT-uKjTpbt_YT-A,9516
 soar_sdk/cli/package/utils.py,sha256=NQgMxWZSf20hqd4Orov77b7qK23QAO3zIEvRTj9HW-o,1590
 soar_sdk/code_renderers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -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.1.dist-info/METADATA,sha256=DX2tSp9QhI815naidp9yRobLgAyhnu5LvbHljrRm_Zc,7361
-splunk_soar_sdk-2.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-2.1.1.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-2.1.1.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-2.1.1.dist-info/RECORD,,
+splunk_soar_sdk-2.3.0.dist-info/METADATA,sha256=WGypNiW3i7PR8Eef-5QYJUwWSR1ua062kpRU86c7g8Y,7361
+splunk_soar_sdk-2.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-2.3.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-2.3.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-2.3.0.dist-info/RECORD,,