prismiq 0.1.0__py3-none-any.whl

prismiq/persistence/tables.py

@@ -0,0 +1,76 @@
+"""SQLAlchemy Core table definitions for Prismiq metadata."""
+
+from __future__ import annotations
+
+from sqlalchemy import (
+    Boolean,
+    Column,
+    ForeignKey,
+    Index,
+    MetaData,
+    String,
+    Table,
+    Text,
+    UniqueConstraint,
+)
+from sqlalchemy.dialects.postgresql import ARRAY, JSONB, TIMESTAMP, UUID
+
+metadata = MetaData()
+
+# Dashboards table
+dashboards_table = Table(
+    "prismiq_dashboards",
+    metadata,
+    Column("id", UUID(as_uuid=True), primary_key=True),
+    Column("tenant_id", String(255), nullable=False),
+    Column("name", String(255), nullable=False),
+    Column("description", Text, nullable=True),
+    Column("layout", JSONB, nullable=False),
+    Column("filters", JSONB, nullable=False),
+    Column("owner_id", String(255), nullable=True),
+    Column("is_public", Boolean, nullable=False, default=False),
+    Column("allowed_viewers", ARRAY(Text), nullable=False),
+    Column("created_at", TIMESTAMP(timezone=True), nullable=False),
+    Column("updated_at", TIMESTAMP(timezone=True), nullable=False),
+    UniqueConstraint("tenant_id", "name", name="unique_dashboard_name_per_tenant"),
+    Index("idx_dashboards_tenant_id", "tenant_id"),
+    Index("idx_dashboards_owner_id", "tenant_id", "owner_id"),
+)
+
+# Widgets table
+widgets_table = Table(
+    "prismiq_widgets",
+    metadata,
+    Column("id", UUID(as_uuid=True), primary_key=True),
+    Column(
+        "dashboard_id",
+        UUID(as_uuid=True),
+        ForeignKey("prismiq_dashboards.id", ondelete="CASCADE"),
+        nullable=False,
+    ),
+    Column("type", String(50), nullable=False),
+    Column("title", String(255), nullable=False),
+    Column("query", JSONB, nullable=True),  # Null for text widgets
+    Column("position", JSONB, nullable=False),
+    Column("config", JSONB, nullable=False),
+    Column("created_at", TIMESTAMP(timezone=True), nullable=False),
+    Column("updated_at", TIMESTAMP(timezone=True), nullable=False),
+    Index("idx_widgets_dashboard_id", "dashboard_id"),
+)
+
+# Saved queries table
+saved_queries_table = Table(
+    "prismiq_saved_queries",
+    metadata,
+    Column("id", UUID(as_uuid=True), primary_key=True),
+    Column("tenant_id", String(255), nullable=False),
+    Column("name", String(255), nullable=False),
+    Column("description", Text, nullable=True),
+    Column("query", JSONB, nullable=False),
+    Column("owner_id", String(255), nullable=True),
+    Column("is_shared", Boolean, nullable=False, default=False),
+    Column("created_at", TIMESTAMP(timezone=True), nullable=False),
+    Column("updated_at", TIMESTAMP(timezone=True), nullable=False),
+    UniqueConstraint("tenant_id", "name", name="unique_query_name_per_tenant"),
+    Index("idx_saved_queries_tenant", "tenant_id"),
+)

prismiq/pins.py

@@ -0,0 +1,72 @@
+"""Pydantic models for dashboard pinning functionality.
+
+Pins allow users to save dashboards to system-defined contexts
+(e.g., "dashboard", "accounts", "home") for quick access in different
+areas of the embedding application.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Annotated
+
+from pydantic import BaseModel, Field, StringConstraints
+
+# Non-empty string type for dashboard IDs
+NonEmptyStr = Annotated[str, StringConstraints(min_length=1)]
+
+
+class PinnedDashboard(BaseModel):
+    """A pinned dashboard entry.
+
+    Attributes:
+        id: Unique identifier for this pin (non-empty).
+        dashboard_id: ID of the pinned dashboard (non-empty).
+        context: Context where the dashboard is pinned (e.g., "accounts").
+        position: Order position within the context (0-based, non-negative).
+        pinned_at: When the dashboard was pinned.
+    """
+
+    id: str = Field(..., min_length=1)
+    dashboard_id: str = Field(..., min_length=1)
+    context: str = Field(..., min_length=1, max_length=100)
+    position: int = Field(..., ge=0)
+    pinned_at: datetime
+
+
+class PinRequest(BaseModel):
+    """Request to pin a dashboard to a context.
+
+    Attributes:
+        dashboard_id: ID of the dashboard to pin (non-empty).
+        context: Context to pin to (e.g., "accounts", "dashboard").
+        position: Optional position in the list (non-negative). If None, appends at end.
+    """
+
+    dashboard_id: str = Field(..., min_length=1)
+    context: str = Field(..., min_length=1, max_length=100)
+    position: int | None = Field(default=None, ge=0)
+
+
+class UnpinRequest(BaseModel):
+    """Request to unpin a dashboard from a context.
+
+    Attributes:
+        dashboard_id: ID of the dashboard to unpin (non-empty).
+        context: Context to unpin from (1-100 characters).
+    """
+
+    dashboard_id: str = Field(..., min_length=1)
+    context: str = Field(..., min_length=1, max_length=100)
+
+
+class ReorderPinsRequest(BaseModel):
+    """Request to reorder pinned dashboards in a context.
+
+    Attributes:
+        context: Context to reorder pins in.
+        dashboard_ids: Ordered list of dashboard IDs (new order). Each ID must be non-empty.
+    """
+
+    context: str = Field(..., min_length=1, max_length=100)
+    dashboard_ids: list[NonEmptyStr] = Field(..., min_length=1)