splight-lib 5.11.4__tar.gz → 5.11.5.dev0__tar.gz

{splight_lib-5.11.4 → splight_lib-5.11.5.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-lib
-Version: 5.11.4
+Version: 5.11.5.dev0
 Summary: Splight Library
 Author: Splight Dev
 Author-email: dev@splight-ae.com

{splight_lib-5.11.4 → splight_lib-5.11.5.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splight-lib"
-version = "5.11.4"
+version = "5.11.5.dev0"
 description = "Splight Library"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"

{splight_lib-5.11.4 → splight_lib-5.11.5.dev0}/splight_lib/component/spec.py

@@ -8,7 +8,6 @@ from splight_lib.component.exceptions import (
     DuplicatedValuesError,
     ParameterDependencyError,
 )
-from splight_lib.constants import DESCRIPTION_MAX_LENGTH
 from splight_lib.models.component import (
     Component,
     ComponentObjectInstance,
@@ -84,9 +83,7 @@ class Spec(BaseModel):
     splight_cli_version: Optional[str] = Field(
         None, pattern=r"^(\d+)\.(\d+)\.(\d+)(\.dev[0-9]+)?$"
     )
-    description: Optional[str] = Field(
-        default=None, max_length=DESCRIPTION_MAX_LENGTH
-    )
+    description: str | None = None
     privacy_policy: PrivacyPolicy = PrivacyPolicy.PUBLIC
     tags: Set[str] = set()
     component_type: ComponentType = ComponentType.CONNECTOR

{splight_lib-5.11.4 → splight_lib-5.11.5.dev0}/splight_lib/constants.py

@@ -1,6 +1,5 @@
 ENGINE_PREFIX: str = "v2/engine"
 HUB_PREFIX: str = "v2/hub"
-DESCRIPTION_MAX_LENGTH = 500
 
 DL_BUFFER_SIZE = 500
 DL_BUFFER_TIMEOUT = 60  # seconds

{splight_lib-5.11.4 → splight_lib-5.11.5.dev0}/splight_lib/models/alert.py

@@ -13,7 +13,6 @@ from pydantic import (
 from strenum import LowercaseStrEnum, UppercaseStrEnum
 from typing_extensions import TypedDict
 
-from splight_lib.constants import DESCRIPTION_MAX_LENGTH
 from splight_lib.models.database_base import SplightDatabaseBaseModel
 from splight_lib.models.exceptions import (
     InvalidAlertConfiguration,
@@ -209,9 +208,7 @@ class StatementAggregation(LowercaseStrEnum):
 class Alert(SplightDatabaseBaseModel):
     id: Optional[str] = Field(None, max_length=100)
     name: str
-    description: Optional[str] = Field(
-        default=None, max_length=DESCRIPTION_MAX_LENGTH
-    )
+    description: str | None = None
 
     assets: List[QueryFilter] = []
     alert_items: List[AlertItem] = []

{splight_lib-5.11.4 → splight_lib-5.11.5.dev0}/splight_lib/models/asset.py

@@ -4,7 +4,6 @@ from typing import Any, List, Optional, Tuple
 from geojson_pydantic import GeometryCollection
 from pydantic import Field
 
-from splight_lib.constants import DESCRIPTION_MAX_LENGTH
 from splight_lib.models.attribute import Attribute
 from splight_lib.models.database_base import (
     ResourceSummary,
@@ -40,9 +39,7 @@ class AssetRelationship(SplightDatabaseBaseModel):
 class Asset(SplightDatabaseBaseModel):
     id: Optional[str] = None
     name: str
-    description: Optional[str] = Field(
-        default=None, max_length=DESCRIPTION_MAX_LENGTH
-    )
+    description: str | None = None
     tags: List[Tag] = []
     attributes: List[Attribute] = []
     metadata: List[Metadata] = []

{splight_lib-5.11.4 → splight_lib-5.11.5.dev0}/splight_lib/models/component.py

@@ -2,7 +2,7 @@ import re
 import warnings
 from abc import ABC, abstractmethod
 from enum import auto
-from typing import Annotated, Any, ClassVar, Literal, Optional, Type
+from typing import Any, ClassVar, Dict, List, Literal, Optional, Type, Union
 
 from pydantic import (
     BaseModel,
@@ -14,7 +14,6 @@ from pydantic import (
 )
 from strenum import LowercaseStrEnum, PascalCaseStrEnum
 
-from splight_lib.constants import DESCRIPTION_MAX_LENGTH
 from splight_lib.models.asset import Asset
 from splight_lib.models.attribute import Attribute
 from splight_lib.models.data_address import DataAddresses as DLDataAddress
@@ -63,17 +62,17 @@ class ValueType(PascalCaseStrEnum):
 
 class Parameter(BaseModel):
     name: str
-    description: str = ""
+    description: str = Field(default="")
     type: str = "str"
     required: bool = False
     multiple: bool = False
     sensitive: bool = False
-    choices: list[Any] | None = None
-    depends_on: str | None = None
+    choices: Optional[List[Any]] = None
+    depends_on: Optional[str] = None
 
 
 class InputParameter(Parameter):
-    value: Any | None = None
+    value: Optional[Any] = None
 
 
 class DataAddress(Parameter):
@@ -91,7 +90,7 @@ class DataAddress(Parameter):
 
 
 class InputDataAddress(DataAddress):
-    value: list[DLDataAddress] | DLDataAddress | None = None
+    value: Optional[Union[List[DLDataAddress], DLDataAddress]] = None
 
     # NOTE: this is a patch.
     # API returns [] as default for InputDataAddress with multiple set
@@ -100,51 +99,52 @@ class InputDataAddress(DataAddress):
     def validate_file(self):
         if self.multiple and self.value is None:
             self.value = []
+
         return self
 
 
 class OutputParameter(BaseModel):
     name: str
-    description: str = ""
+    description: str = Field(default="")
     type: str
-    choices: list[Any] | None = None
-    depends_on: str | None = None
+    choices: Optional[List[Any]] = None
+    depends_on: Optional[str] = None
     filterable: bool = False
 
 
 class Output(BaseModel):
     name: str
-    fields: list[OutputParameter]
+    fields: List[OutputParameter]
 
 
 class CustomType(BaseModel):
     name: str
-    fields: list[Parameter]
+    fields: List[Parameter]
 
-    _reserved_names: ClassVar[list[str]] = ["id", "name", "description"]
+    _reserved_names: ClassVar[List[str]] = ["id", "name", "description"]
 
 
 class Routine(BaseModel):
     name: str
-    max_instances: int | None = None
+    max_instances: Optional[int] = None
 
-    config: list[InputParameter] | None = []
-    input: list[DataAddress] = []
-    output: list[DataAddress] = []
+    config: Optional[List[InputParameter]] = []
+    input: List[DataAddress] = []
+    output: List[DataAddress] = []
 
-    _reserved_names: ClassVar[list[str]] = ["id", "name", "description"]
+    _reserved_names: ClassVar[List[str]] = ["id", "name", "description"]
 
 
 class Endpoint(BaseModel):
-    name: str | None = None
-    port: int | str
+    name: Optional[str]
+    port: Union[int, str]
 
 
 class SplightObject(SplightDatabaseBaseModel):
-    id: str | None = None
+    id: Optional[str] = None
     name: str
-    component_id: str | None = None
-    description: str = ""
+    component_id: Optional[str] = None
+    description: str = Field(default="")
     type: str
 
     def save(self):
@@ -154,7 +154,7 @@ class SplightObject(SplightDatabaseBaseModel):
 
 
 class ComponentObject(SplightObject):
-    data: list[InputParameter] = []
+    data: List[InputParameter] = []
 
 
 class RoutineEvaluation(SplightDatalakeBaseModel):
@@ -162,18 +162,18 @@ class RoutineEvaluation(SplightDatalakeBaseModel):
 
     routine: str
     status: RoutineStatus
-    status_text: str | None
+    status_text: Optional[str]
 
 
 class RoutineObject(SplightObject):
     status: RoutineStatus = RoutineStatus.RUNNING
 
-    config: list[InputParameter] | None = []
-    input: list[InputDataAddress] = []
-    output: list[InputDataAddress] = []
+    config: Optional[List[InputParameter]] = []
+    input: List[InputDataAddress] = []
+    output: List[InputDataAddress] = []
 
     def report_status(
-        self, status: RoutineStatus, status_text: str | None = None
+        self, status: RoutineStatus, status_text: Optional[str] = None
     ):
         evaluation_status = RoutineEvaluation(
             routine=str(self.id),
@@ -197,15 +197,15 @@ class RoutineObject(SplightObject):
 
 
 class Component(SplightDatabaseBaseModel):
-    id: str | None = None
-    name: str | None = None
+    id: Optional[str] = None
+    name: Optional[str] = None
     version: str
-    custom_types: list[CustomType] = []
+    custom_types: List[CustomType] = []
     component_type: ComponentType = ComponentType.CONNECTOR
-    input: list[InputParameter] = []
-    output: list[Output] = []
-    endpoints: list[Endpoint] = []
-    routines: list[Routine] = []
+    input: List[InputParameter] = []
+    output: List[Output] = []
+    endpoints: List[Endpoint] = []
+    routines: List[Routine] = []
 
 
 DATABASE_TYPES = {
@@ -227,7 +227,7 @@ DB_MODEL_TYPE_MAPPING = {
 }
 
 
-def parse_variable_string(raw_value: str | None) -> Any:
+def parse_variable_string(raw_value: Optional[str]) -> Any:
     if raw_value is None:
         return ""
     pattern = re.compile(r"^\$\{\{(\w+)\.(\w+)\}\}$")
@@ -240,7 +240,7 @@ def parse_variable_string(raw_value: str | None) -> Any:
     return secret.value
 
 
-def get_field_value(field: InputParameter | list[InputParameter]):
+def get_field_value(field: Union[InputParameter, List[InputParameter]]):
     multiple = field.multiple
 
     value = field.value
@@ -289,16 +289,16 @@ def get_field_value(field: InputParameter | list[InputParameter]):
 
 
 class AbstractObjectInstance(ABC, SplightDatabaseBaseModel):
-    id: str | None = None
+    id: Optional[str] = None
     name: str = ""
-    description: Annotated[str, Field("", max_length=DESCRIPTION_MAX_LENGTH)]
+    description: str = ""
 
-    _default_attrs: list[str] = PrivateAttr(
+    _default_attrs: List[str] = PrivateAttr(
         ["id", "name", "component_id", "description"]
     )
-    _schema: ClassVar[BaseModel | None] = None
-    _database_class: ClassVar[Type[SplightDatabaseBaseModel] | None] = None
-    _component_id: ClassVar[str | None] = None
+    _schema: ClassVar[Optional[BaseModel]] = None
+    _database_class: ClassVar[Optional[Type[SplightDatabaseBaseModel]]] = None
+    _component_id: ClassVar[Optional[str]] = None
 
     def save(self):
         component_obj = self.to_object()
@@ -311,7 +311,7 @@ class AbstractObjectInstance(ABC, SplightDatabaseBaseModel):
         component_obj.delete()
 
     @classmethod
-    def list(cls, **params: dict) -> list["AbstractObjectInstance"]:
+    def list(cls, **params: Dict) -> List["AbstractObjectInstance"]:
         if not cls._schema or not cls._component_id:
             raise InvalidObjectInstance(
                 (
@@ -406,7 +406,7 @@ class AbstractObjectInstance(ABC, SplightDatabaseBaseModel):
 
 
 class ComponentObjectInstance(AbstractObjectInstance):
-    _schema: ClassVar[CustomType | None] = None
+    _schema: ClassVar[Optional[CustomType]] = None
     _database_class: ClassVar[Type[SplightDatabaseBaseModel]] = ComponentObject
 
     def to_object(self) -> ComponentObject:
@@ -431,13 +431,13 @@ class ComponentObjectInstance(AbstractObjectInstance):
     def from_custom_type(
         cls,
         custom_type: CustomType,
-        component_id: str | None = None,
+        component_id: Optional[str] = None,
     ) -> Type["ComponentObjectInstance"]:
         fields = {}
 
         for field in custom_type.fields:
             field_type = DB_MODEL_TYPE_MAPPING.get(field.type, cls)
-            field_type = list[field_type] if field.multiple else field_type
+            field_type = List[field_type] if field.multiple else field_type
             field_type = (
                 Optional[field_type] if not field.required else field_type
             )
@@ -486,7 +486,7 @@ class ComponentObjectInstance(AbstractObjectInstance):
     def from_component(
         cls,
         component: Component,
-    ) -> dict[str, "ComponentObjectInstance"]:
+    ) -> Dict[str, "ComponentObjectInstance"]:
         return {
             ct.name: cls.from_custom_type(ct, component.id)
             for ct in component.custom_types
@@ -564,13 +564,13 @@ class RoutineObjectInstance(AbstractObjectInstance):
         return model_class
 
     @classmethod
-    def _create_config_model(cls, parameters: list[Parameter]) -> Type:
+    def _create_config_model(cls, parameters: List[Parameter]) -> Type:
         fields = {}
         for field in parameters:
             field_type = DB_MODEL_TYPE_MAPPING.get(
                 field.type, ComponentObjectInstance
             )
-            field_type = list[field_type] if field.multiple else field_type
+            field_type = List[field_type] if field.multiple else field_type
             field_type = field_type if field.required else Optional[field_type]
             field_value = ... if field.required else None
             fields.update({field.name: (field_type, field_value)})
@@ -578,11 +578,11 @@ class RoutineObjectInstance(AbstractObjectInstance):
         return create_model("Config", **fields)
 
     @classmethod
-    def _create_input_model(cls, parameters: list[DataAddress]) -> Type:
+    def _create_input_model(cls, parameters: List[DataAddress]) -> Type:
         fields = {}
         for field in parameters:
             field_type = (
-                list[DLDataAddress] if field.multiple else DLDataAddress
+                List[DLDataAddress] if field.multiple else DLDataAddress
             )
             field_type = field_type if field.required else Optional[field_type]
             field_value = ... if field.required else None
@@ -590,11 +590,11 @@ class RoutineObjectInstance(AbstractObjectInstance):
         return create_model("Input", **fields)
 
     @classmethod
-    def _create_output_model(cls, parameters: list[DataAddress]) -> Type:
+    def _create_output_model(cls, parameters: List[DataAddress]) -> Type:
         fields = {}
         for field in parameters:
             field_type = (
-                list[DLDataAddress] if field.multiple else DLDataAddress
+                List[DLDataAddress] if field.multiple else DLDataAddress
             )
             field_type = field_type if field.required else Optional[field_type]
             field_value = ... if field.required else None
@@ -631,7 +631,7 @@ class RoutineObjectInstance(AbstractObjectInstance):
         return cls.model_validate(params_dict)
 
     def report_status(
-        self, status: RoutineStatus, status_text: str | None = None
+        self, status: RoutineStatus, status_text: Optional[str] = None
     ):
         routine_object = self.to_object()
         routine_object.report_status(status=status, status_text=status_text)

splight_lib-5.11.5.dev0/splight_lib/models/dashboard.py

@@ -0,0 +1,307 @@
+# TODO: set types fixed values
+import json
+import re
+from enum import auto
+
+from pydantic import BaseModel, ValidationError, model_validator
+from strenum import UppercaseStrEnum
+
+from splight_lib.models.alert import AlertItemType
+from splight_lib.models.database_base import (
+    ResourceSummary,
+    SplightDatabaseBaseModel,
+)
+from splight_lib.models.exceptions import MissingAlertItemExpression
+
+
+class ChartItemType(UppercaseStrEnum):
+    QUERY = auto()
+    EXPRESSION = auto()
+
+
+class Threshold(BaseModel):
+    color: str | None = None
+    display_text: str | None = None
+    value: float | None = None
+
+
+class ValueMapping(BaseModel):
+    display_text: str | None = None
+    order: int = 0
+
+
+class ExactMatchValueMapping(ValueMapping):
+    match_value: str | None = None
+
+
+class RangeValueMapping(ValueMapping):
+    range_start: float | None = None
+    range_end: float | None = None
+
+
+class RegexMatchValueMapping(ValueMapping):
+    regular_expression: str | None = None
+
+
+class Filter(SplightDatabaseBaseModel):
+    id: str | None = None
+    chart_item: str
+    operator: str | None = None
+    key: str | None = None
+    value: str | None = None
+    label: str | None = None
+
+
+class AdvancedFilter(SplightDatabaseBaseModel):
+    id: str | None = None
+    chart_item: str
+    operator: str | None = None
+    key: str | None = None
+    field: str | None = None
+    value: str | None = None
+
+
+class ChartItem(BaseModel):
+    color: str | None = None
+    ref_id: str
+    type: ChartItemType = ChartItemType.QUERY
+    label: str
+    hidden: bool = False
+    expression: str | None = None
+    expression_plain: str | None = None
+    query_filter_asset: ResourceSummary | None = None
+    query_filter_attribute: ResourceSummary | None = None
+    query_plain: str = ""
+    query_group_unit: str | None = None
+    query_group_function: str | None = None
+    query_sort_direction: int | None = -1
+    query_limit: int = 10000
+
+    @model_validator(mode="after")
+    def validate_expression(self):
+        if self.type == AlertItemType.EXPRESSION:
+            if self.expression is None:
+                raise MissingAlertItemExpression(
+                    "Parameter 'expression' is required for expression type alert items"
+                )
+            self.expression_plain = (
+                self._get_expression_plain()
+                if self.expression_plain is None
+                else self.expression_plain
+            )
+        return self
+
+    @model_validator(mode="after")
+    def validate_query(self):
+        if self.type == AlertItemType.QUERY:
+            for attr in [
+                ("query_filter_asset", self.query_filter_asset),
+                ("query_filter_attribute", self.query_filter_attribute),
+            ]:
+                if attr is None:
+                    raise ValidationError(
+                        (
+                            f"Parameter '{attr}' is required for query type "
+                            "alert items"
+                        )
+                    )
+            self.query_plain = (
+                self._get_query_plain()
+                if self.query_plain is None
+                else self.query_plain
+            )
+        return self
+
+    def _get_expression_plain(self):
+        pattern = r"\$\w+"
+        args = re.findall(pattern, self.expression)
+        str_args = ", ".join(args)
+        body = f"function ({str_args}) {{ return {self.expression} }}"
+        expression_plain = {
+            "$function": {"body": body, "args": args, "lang": "js"}
+        }
+        return json.dumps(expression_plain)
+
+    def _get_query_plain(self):
+        query_plain = [
+            {
+                "$match": {
+                    "asset": self.query_filter_asset["id"],
+                    "attribute": self.query_filter_attribute["id"],
+                }
+            },
+        ]
+        if self.query_group_unit and self.query_group_function:
+            query_plain.extend(
+                [
+                    {
+                        "$addFields": {
+                            "timestamp": {
+                                "$dateTrunc": {
+                                    "date": "$timestamp",
+                                    "unit": self.query_group_unit,
+                                    "binSize": 1,
+                                }
+                            }
+                        }
+                    },
+                    {
+                        "$group": {
+                            "_id": "$timestamp",
+                            "value": {
+                                f"${self.query_group_function}": "$value"
+                            },
+                            "timestamp": {"$last": "$timestamp"},
+                        }
+                    },
+                ]
+            )
+        return json.dumps(query_plain)
+
+
+class Dashboard(SplightDatabaseBaseModel):
+    id: str | None = None
+    name: str
+    description: str | None = None
+    related_assets: list(ResourceSummary)
+    tags: list(ResourceSummary)
+
+
+class Tab(SplightDatabaseBaseModel):
+    id: str | None = None
+    name: str
+    order: int | None = None
+    dashboard: str
+
+
+class Chart(SplightDatabaseBaseModel):
+    id: str | None = None
+    name: str
+    tab: str
+    description: str | None = None
+    position_x: int | None = None
+    position_y: int | None = None
+    min_height: int | None = None
+    min_width: int | None = None
+    display_time_range: bool
+    labels_display: bool
+    labels_aggregation: str
+    labels_placement: str
+    refresh_interval: str
+    relative_window_time: str
+    show_beyond_data: bool
+    timezone: str
+    timestamp_gte: str
+    timestamp_lte: str
+    height: int
+    width: int
+    collection: str
+    chart_items: list[ChartItem]
+    thresholds: list[Threshold]
+    value_mappings: list[
+        ExactMatchValueMapping | RangeValueMapping | RegexMatchValueMapping
+    ] = []
+
+
+class DashboardActionListChart(Chart):
+    type: str = "actionlist"
+    action_list_type: str
+    filter_name: str
+    filter_asset_name: str | None = None
+
+
+class DashboardAlertEventsChart(Chart):
+    type: str = "alertevents"
+    filter_name: str
+    filter_old_status: str
+    filter_new_status: str
+
+
+class DashboardAlertListChart(Chart):
+    type: str = "alertlist"
+    filter_name: str
+    filter_status: list(str)
+    alert_list_type: str | None = None
+
+
+class DashboardAssetListChart(Chart):
+    type: str = "assetlist"
+    filter_name: str
+    filter_status: list(str)
+    asset_list_type: str | None = None
+
+
+class DashboardBarChart(Chart):
+    type: str = "bar"
+    y_axis_unit: str | None = None
+    number_of_decimals: int | None = None
+    orientation: int | None = None
+
+
+class DashboardBarGaugeChart(Chart):
+    type: str = "bargauge"
+    max_limit: int | None = None
+    number_of_decimals: int | None = None
+    orientation: str | None = None
+
+
+class DashboardCommandListChart(Chart):
+    type: str = "commandlist"
+    command_list_type: str
+    filter_name: str
+
+
+class DashboardGaugeChart(Chart):
+    type: str = "gauge"
+    max_limit: int | None = None
+    number_of_decimals: int | None = None
+
+
+class DashboardHistogramChart(Chart):
+    type: str = "histogram"
+    number_of_decimals: int | None = None
+    bucket_count: int
+    bucket_size: int
+    histogram_type: str
+    sorting: str
+    stacked: bool
+    categories_top_max_limit: int | None = None
+
+
+class DashboardImageChart(Chart):
+    type: str = "image"
+    image_url: str | None = None
+    image_file: str | None = None
+
+
+class DashboardStatChart(Chart):
+    type: str = "stat"
+    y_axis_unit: str
+    border: bool
+    number_of_decimals: int | None = None
+
+
+class DashboardTableChart(Chart):
+    type: str = "table"
+    y_axis_unit: str
+    number_of_decimals: int
+
+
+class DashboardTextChart(Chart):
+    type: str = "text"
+    text: str | None = None
+
+
+class DashboardTimeseriesChart(Chart):
+    type: str = "timeseries"
+    y_axis_max_limit: int | None = None
+    y_axis_min_limit: int | None = None
+    y_axis_unit: str | None = None
+    number_of_decimals: int | None = None
+    x_axis_format: str
+    x_axis_auto_skip: bool
+    x_axis_max_ticks_limit: int | None = None
+    line_interpolation_style: str | None = None
+    timeseries_type: str | None = None
+    fill: bool
+    show_line: bool