Files
resolutionflow/backend/app/models/step_library.py
chihlasm c782d41eff Add step library foundation and user preferences (Issues #3, #5, #6, #7)
Issue #3: User Preferences - export format default
- Add userPreferencesStore with localStorage persistence
- Create Settings page with export format dropdown and theme toggle
- SessionDetailPage now uses default export format from preferences

Issue #5: Step Categories - database table and seed data
- Migration 007: step_categories table with team scoping
- Seed 10 default global categories (Citrix/VDI, AD, M365, etc.)
- Full CRUD API at /api/v1/step-categories

Issue #6: Step Library - database schema
- Migration 008: step_library, step_ratings, step_usage_log tables
- Support for decision/action/solution step types
- Visibility levels: private, team, public
- Rating aggregates and usage tracking

Issue #7: Step Library - CRUD API endpoints
- Full CRUD at /api/v1/steps with visibility filtering
- Full-text search endpoint
- Popular tags endpoint
- Rating/review system with verified use tracking

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 01:25:31 -05:00

178 lines
6.2 KiB
Python

import uuid
from datetime import datetime, timezone
from decimal import Decimal
from typing import TYPE_CHECKING, Optional
from sqlalchemy import String, DateTime, Integer, Boolean, Text, Numeric, ForeignKey, CheckConstraint
from sqlalchemy.orm import Mapped, mapped_column, relationship
from sqlalchemy.dialects.postgresql import UUID, JSONB, ARRAY
from app.core.database import Base
if TYPE_CHECKING:
from app.models.user import User
from app.models.team import Team
from app.models.step_category import StepCategory
from app.models.session import Session
class StepLibrary(Base):
__tablename__ = "step_library"
__table_args__ = (
CheckConstraint(
"step_type IN ('decision', 'action', 'solution')",
name='ck_step_library_step_type'
),
)
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
primary_key=True,
default=uuid.uuid4
)
title: Mapped[str] = mapped_column(String(255), nullable=False)
step_type: Mapped[str] = mapped_column(String(50), nullable=False)
content: Mapped[dict] = mapped_column(JSONB, nullable=False)
# Ownership
created_by: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("users.id", ondelete="CASCADE"),
nullable=False
)
team_id: Mapped[Optional[uuid.UUID]] = mapped_column(
UUID(as_uuid=True),
ForeignKey("teams.id", ondelete="CASCADE"),
nullable=True
)
# Organization
category_id: Mapped[Optional[uuid.UUID]] = mapped_column(
UUID(as_uuid=True),
ForeignKey("step_categories.id", ondelete="SET NULL"),
nullable=True
)
tags: Mapped[list[str]] = mapped_column(
ARRAY(String(100)),
nullable=False,
default=list
)
# Visibility: 'private', 'team', 'public'
visibility: Mapped[str] = mapped_column(
String(50),
nullable=False,
default="private"
)
# Aggregated ratings
usage_count: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
rating_average: Mapped[Decimal] = mapped_column(Numeric(3, 2), nullable=False, default=Decimal("0"))
rating_count: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
helpful_yes: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
helpful_no: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
# Flags
is_featured: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
is_verified: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
# Timestamps
created_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.now(timezone.utc)
)
updated_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.now(timezone.utc),
onupdate=lambda: datetime.now(timezone.utc)
)
# Soft delete
is_active: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True)
# Relationships
creator: Mapped["User"] = relationship("User", foreign_keys=[created_by])
team: Mapped[Optional["Team"]] = relationship("Team")
category: Mapped[Optional["StepCategory"]] = relationship("StepCategory")
ratings: Mapped[list["StepRating"]] = relationship("StepRating", back_populates="step", cascade="all, delete-orphan")
usage_logs: Mapped[list["StepUsageLog"]] = relationship("StepUsageLog", back_populates="step", cascade="all, delete-orphan")
class StepRating(Base):
__tablename__ = "step_ratings"
__table_args__ = (
CheckConstraint('rating >= 1 AND rating <= 5', name='ck_step_ratings_rating_range'),
)
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
primary_key=True,
default=uuid.uuid4
)
step_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("step_library.id", ondelete="CASCADE"),
nullable=False
)
user_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("users.id", ondelete="CASCADE"),
nullable=False
)
rating: Mapped[int] = mapped_column(Integer, nullable=False)
was_helpful: Mapped[Optional[bool]] = mapped_column(Boolean, nullable=True)
review_text: Mapped[Optional[str]] = mapped_column(String(500), nullable=True)
is_verified_use: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
session_id: Mapped[Optional[uuid.UUID]] = mapped_column(
UUID(as_uuid=True),
ForeignKey("sessions.id", ondelete="SET NULL"),
nullable=True
)
is_visible: Mapped[bool] = mapped_column(Boolean, nullable=False, default=True)
created_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.now(timezone.utc)
)
updated_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.now(timezone.utc),
onupdate=lambda: datetime.now(timezone.utc)
)
# Relationships
step: Mapped["StepLibrary"] = relationship("StepLibrary", back_populates="ratings")
user: Mapped["User"] = relationship("User")
session: Mapped[Optional["Session"]] = relationship("Session")
class StepUsageLog(Base):
__tablename__ = "step_usage_log"
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
primary_key=True,
default=uuid.uuid4
)
step_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("step_library.id", ondelete="CASCADE"),
nullable=False
)
user_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("users.id", ondelete="CASCADE"),
nullable=False
)
session_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("sessions.id", ondelete="CASCADE"),
nullable=False
)
used_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.now(timezone.utc)
)
# Relationships
step: Mapped["StepLibrary"] = relationship("StepLibrary", back_populates="usage_logs")
user: Mapped["User"] = relationship("User")
session: Mapped["Session"] = relationship("Session")