f3-data-models 0.2.4__tar.gz → 0.3.0__tar.gz

{f3_data_models-0.2.4 → f3_data_models-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: f3-data-models
-Version: 0.2.4
+Version: 0.3.0
 Summary: The data schema and models for F3 Nation applications.
 License: MIT
 Author: Evan Petzoldt
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: alembic (>=1.14.0,<2.0.0)
+Requires-Dist: alembic-postgresql-enum (>=1.6.1,<2.0.0)
 Requires-Dist: cloud-sql-python-connector (>=1.13.0,<2.0.0)
 Requires-Dist: graphviz (>=0.20.3,<0.21.0)
 Requires-Dist: pg8000 (>=1.31.2,<2.0.0)
@@ -68,7 +69,8 @@ poetry version patch[minor][major]
 git tag <new_version> -a -m "Your message here"
 git push origin --tags
 ```
-> [!NOTE] The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
+> [!NOTE]
+> The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
 
 ```sh
 poetry run sphinx-build -b html docs docs/_build/html

{f3_data_models-0.2.4 → f3_data_models-0.3.0}/README.md

@@ -40,7 +40,8 @@ poetry version patch[minor][major]
 git tag <new_version> -a -m "Your message here"
 git push origin --tags
 ```
-> [!NOTE] The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
+> [!NOTE]
+> The github pages documentation will be updated when you push to `main`, but if you would like to preview locally, run:
 
 ```sh
 poetry run sphinx-build -b html docs docs/_build/html

{f3_data_models-0.2.4 → f3_data_models-0.3.0}/f3_data_models/models.py

@@ -1,16 +1,22 @@
 from datetime import datetime, date, time
 from typing import Any, Dict, List, Optional
+import uuid
 from sqlalchemy import (
+    ARRAY,
     JSON,
     TEXT,
     TIME,
+    UUID,
     VARCHAR,
     Boolean,
     DateTime,
+    Float,
     ForeignKey,
     Integer,
     func,
     UniqueConstraint,
+    Enum,
+    Uuid,
 )
 from typing_extensions import Annotated
 from sqlalchemy.orm import (
@@ -19,9 +25,11 @@ from sqlalchemy.orm import (
     Mapped,
     relationship,
 )
+import enum
 
 # Custom Annotations
-time_notz = Annotated[time, TIME]
+time_notz = Annotated[time, TIME(timezone=False)]
+time_with_tz = Annotated[time, TIME(timezone=True)]
 text = Annotated[str, TEXT]
 intpk = Annotated[int, mapped_column(Integer, primary_key=True, autoincrement=True)]
 dt_create = Annotated[
@@ -37,6 +45,30 @@ dt_update = Annotated[
 ]
 
 
+class UserStatus(enum.Enum):
+    active = 1
+    inactive = 2
+    deleted = 3
+
+
+class RegionRole(enum.Enum):
+    user = 1
+    editor = 2
+    admin = 3
+
+
+class UserRole(enum.Enum):
+    user = 1
+    editor = 2
+    admin = 3
+
+
+class UpdateRequestStatus(enum.Enum):
+    pending = 1
+    approved = 2
+    rejected = 3
+
+
 class Base(DeclarativeBase):
     """
     Base class for all models, providing common methods.
@@ -187,7 +219,7 @@ class Role(Base):
 
     Attributes:
         id (int): Primary Key of the model.
-        name (str): The name of the role.
+        name (RegionRole): The name of the role.
         description (Optional[text]): A description of the role.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
@@ -196,7 +228,7 @@ class Role(Base):
     __tablename__ = "roles"
 
     id: Mapped[intpk]
-    name: Mapped[str]
+    name: Mapped[RegionRole]
     description: Mapped[Optional[text]]
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
@@ -285,7 +317,6 @@ class Org(Base):
         event_tags (Optional[List[EventTag]]): The event tags associated with the organization. Used to control which event tags are available for selection at the region level.
         achievements (Optional[List[Achievement]]): The achievements available within the organization.
         parent_org (Optional[Org]): The parent organization.
-        event_tags_x_org (Optional[List[EventTag_x_Org]]): The association between event tags and organizations.
         slack_space (Optional[SlackSpace]): The associated Slack workspace.
     """
 
@@ -313,10 +344,16 @@ class Org(Base):
         "Location", cascade="expunge"
     )
     event_types: Mapped[Optional[List["EventType"]]] = relationship(
-        "EventType", secondary="event_types_x_org", cascade="expunge", viewonly=True
+        "EventType",
+        primaryjoin="or_(EventType.specific_org_id == Org.id, EventType.specific_org_id.is_(None))",
+        cascade="expunge",
+        viewonly=True,
     )
     event_tags: Mapped[Optional[List["EventTag"]]] = relationship(
-        "EventTag", secondary="event_tags_x_org", cascade="expunge", viewonly=True
+        "EventTag",
+        primaryjoin="or_(EventTag.specific_org_id == Org.id, EventTag.specific_org_id.is_(None))",
+        cascade="expunge",
+        viewonly=True,
     )
     achievements: Mapped[Optional[List["Achievement"]]] = relationship(
         "Achievement", secondary="achievements_x_org", cascade="expunge"
@@ -324,9 +361,6 @@ class Org(Base):
     parent_org: Mapped[Optional["Org"]] = relationship(
         "Org", remote_side=[id], cascade="expunge"
     )
-    event_tags_x_org: Mapped[Optional[List["EventTag_x_Org"]]] = relationship(
-        "EventTag_x_Org", cascade="expunge"
-    )
     slack_space: Mapped[Optional["SlackSpace"]] = relationship(
         "SlackSpace", secondary="orgs_x_slack_spaces", cascade="expunge"
     )
@@ -342,6 +376,7 @@ class EventType(Base):
         description (Optional[text]): A description of the event type.
         acronym (Optional[str]): Acronyms associated with the event type.
         category_id (int): The ID of the associated event category.
+        specific_org_id (Optional[int]): The ID of the specific organization.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
     """
@@ -353,6 +388,7 @@ class EventType(Base):
     description: Mapped[Optional[text]]
     acronym: Mapped[Optional[str]]
     category_id: Mapped[int] = mapped_column(ForeignKey("event_categories.id"))
+    specific_org_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -378,23 +414,23 @@ class EventType_x_Event(Base):
     event: Mapped["Event"] = relationship(back_populates="event_x_event_types")
 
 
-class EventType_x_Org(Base):
-    """
-    Model representing the association between event types and organizations. This controls which event types are available for selection at the region level, as well as default types for each AO.
+# class EventType_x_Org(Base):
+#     """
+#     Model representing the association between event types and organizations. This controls which event types are available for selection at the region level, as well as default types for each AO.
 
-    Attributes:
-        event_type_id (int): The ID of the associated event type.
-        org_id (int): The ID of the associated organization.
-        is_default (bool): Whether this is the default event type for the organization. Default is False.
-    """
+#     Attributes:
+#         event_type_id (int): The ID of the associated event type.
+#         org_id (int): The ID of the associated organization.
+#         is_default (bool): Whether this is the default event type for the organization. Default is False.
+#     """
 
-    __tablename__ = "event_types_x_org"
+#     __tablename__ = "event_types_x_org"
 
-    event_type_id: Mapped[int] = mapped_column(
-        ForeignKey("event_types.id"), primary_key=True
-    )
-    org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
-    is_default: Mapped[bool] = mapped_column(Boolean, default=False)
+#     event_type_id: Mapped[int] = mapped_column(
+#         ForeignKey("event_types.id"), primary_key=True
+#     )
+#     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
+#     is_default: Mapped[bool] = mapped_column(Boolean, default=False)
 
 
 class EventTag(Base):
@@ -406,6 +442,7 @@ class EventTag(Base):
         name (str): The name of the event tag.
         description (Optional[text]): A description of the event tag.
         color (Optional[str]): The color used for the calendar.
+        specific_org_id (Optional[int]): Used for custom tags for specific regions.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
     """
@@ -416,6 +453,7 @@ class EventTag(Base):
     name: Mapped[str]
     description: Mapped[Optional[text]]
     color: Mapped[Optional[str]]
+    specific_org_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -441,23 +479,23 @@ class EventTag_x_Event(Base):
     event: Mapped["Event"] = relationship(back_populates="event_x_event_tags")
 
 
-class EventTag_x_Org(Base):
-    """
-    Model representing the association between event tags and organizations. Controls which event tags are available for selection at the region level.
+# class EventTag_x_Org(Base):
+#     """
+#     Model representing the association between event tags and organizations. Controls which event tags are available for selection at the region level.
 
-    Attributes:
-        event_tag_id (int): The ID of the associated event tag.
-        org_id (int): The ID of the associated organization.
-        color_override (Optional[str]): The calendar color override for the event tag (if the region wants to use something other than the default).
-    """
+#     Attributes:
+#         event_tag_id (int): The ID of the associated event tag.
+#         org_id (int): The ID of the associated organization.
+#         color_override (Optional[str]): The calendar color override for the event tag (if the region wants to use something other than the default).
+#     """
 
-    __tablename__ = "event_tags_x_org"
+#     __tablename__ = "event_tags_x_org"
 
-    event_tag_id: Mapped[int] = mapped_column(
-        ForeignKey("event_tags.id"), primary_key=True
-    )
-    org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
-    color_override: Mapped[Optional[str]]
+#     event_tag_id: Mapped[int] = mapped_column(
+#         ForeignKey("event_tags.id"), primary_key=True
+#     )
+#     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
+#     color_override: Mapped[Optional[str]]
 
 
 class Org_x_SlackSpace(Base):
@@ -535,8 +573,8 @@ class Event(Base):
         highlight (bool): Whether the event is highlighted. Default is False.
         start_date (date): The start date of the event.
         end_date (Optional[date]): The end date of the event.
-        start_time (Optional[time_notz]): The start time of the event.
-        end_time (Optional[time_notz]): The end time of the event.
+        start_time (Optional[time_with_tz]): The start time of the event.
+        end_time (Optional[time_with_tz]): The end time of the event.
         day_of_week (Optional[int]): The day of the week of the event. (0=Monday, 6=Sunday)
         name (str): The name of the event.
         description (Optional[text]): A description of the event.
@@ -575,8 +613,8 @@ class Event(Base):
     highlight: Mapped[bool] = mapped_column(Boolean, default=False)
     start_date: Mapped[date]
     end_date: Mapped[Optional[date]]
-    start_time: Mapped[Optional[time_notz]]
-    end_time: Mapped[Optional[time_notz]]
+    start_time: Mapped[Optional[time_with_tz]]
+    end_time: Mapped[Optional[time_with_tz]]
     day_of_week: Mapped[Optional[int]]
     name: Mapped[str]
     description: Mapped[Optional[text]]
@@ -674,6 +712,8 @@ class User(Base):
         home_region_id (Optional[int]): The ID of the home region.
         avatar_url (Optional[str]): The URL of the user's avatar.
         meta (Optional[Dict[str, Any]]): Additional metadata for the user.
+        email_verified (Optional[datetime]): The timestamp when the user's email was verified.
+        status (UserStatus): The status of the user. Default is 'active'.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
     """
@@ -692,7 +732,11 @@ class User(Base):
     home_region_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
     avatar_url: Mapped[Optional[str]]
     meta: Mapped[Optional[Dict[str, Any]]]
-    email_verified_ts: Mapped[Optional[datetime]]
+    email_verified: Mapped[Optional[datetime]]
+    status: Mapped[UserStatus] = mapped_column(
+        Enum(UserStatus), default=UserStatus.active
+    )
+    role: Mapped[UserRole] = mapped_column(Enum(UserRole), default=UserRole.user)
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -949,38 +993,187 @@ class Expansion_x_User(Base):
     notes: Mapped[Optional[text]]
 
 
-# class Org_x_SlackChannel(Base):
-#     """
-#     Model representing the association between organizations (specifically AOs) and Slack channels.
+class NextAuthAccount(Base):
+    """
+    Model representing an authentication account.
 
-#     Attributes:
-#         org_id (int): The ID of the associated organization.
-#         slack_channel_id (str): The Slack-internal ID of the associated Slack channel.
-#     """
+    Attributes:
+        user_id (int): The ID of the associated user.
+        type (text): The type of the account.
+        provider (text): The provider of the account.
+        provider_account_id (text): The provider account ID.
+        refresh_token (Optional[text]): The refresh token.
+        access_token (text): The access token.
+        expires_at (Optional[datetime]): The expiration time of the token.
+        token_type (Optional[text]): The token type.
+        scope (Optional[text]): The scope of the token.
+        id_token (Optional[text]): The ID token.
+        session_state (Optional[text]): The session state.
+        created (datetime): The timestamp when the record was created.
+        updated (datetime): The timestamp when the record was last updated.
+    """
 
-#     __tablename__ = "orgs_x_slack_channels"
+    __tablename__ = "auth_accounts"
 
-#     org_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"), primary_key=True)
-#     slack_channel_id: Mapped[str] = mapped_column(
-#         primary_key=True
-#     )  # Do we need a slack channel table?
+    user_id: Mapped[int] = mapped_column(ForeignKey("users.id"))
+    type: Mapped[text]  # need adapter account_type?
+    provider: Mapped[text] = mapped_column(VARCHAR, primary_key=True)
+    provider_account_id: Mapped[text] = mapped_column(VARCHAR, primary_key=True)
+    refresh_token: Mapped[Optional[text]]
+    access_token: Mapped[text]
+    expires_at: Mapped[Optional[datetime]]
+    token_type: Mapped[Optional[text]]
+    scope: Mapped[Optional[text]]
+    id_token: Mapped[Optional[text]]
+    session_state: Mapped[Optional[text]]
+    created: Mapped[dt_create]
+    updated: Mapped[dt_update]
 
-# class SlackSpaceLog(Base):
-#     """
-#     Model representing a log of Slack space events.
 
-#     Attributes:
-#         id (int): Primary Key of the model.
-#         slack_space_id (int): The ID of the associated Slack space.
-#         event (str): The event that occurred.
-#         data (Optional[Dict[str, Any]]): Additional data for the log.
-#         created (datetime): The timestamp when the record was created.
-#     """
+class NextAuthSession(Base):
+    """
+    Model representing an authentication session.
+
+    Attributes:
+        session_token (text): The session token.
+        user_id (int): The ID of the associated user.
+        expires (date): The expiration time of the session.
+        created (datetime): The timestamp when the record was created.
+        updated (datetime): The timestamp when the record was last updated.
+    """
+
+    __tablename__ = "auth_sessions"
+
+    session_token: Mapped[text] = mapped_column(TEXT, primary_key=True)
+    user_id: Mapped[int] = mapped_column(ForeignKey("users.id"))
+    expires: Mapped[date]
+    created: Mapped[dt_create]
+    updated: Mapped[dt_update]
+
+
+class NextAuthVerificationToken(Base):
+    """
+    Model representing an authentication verification token.
+
+    Attributes:
+        identifier (text): The identifier of the token.
+        token (text): The token.
+        expires (date): The expiration time of the token.
+        created (datetime): The timestamp when the record was created.
+        updated (datetime): The timestamp when the record was last updated.
+    """
 
-#     __tablename__ = "slack_space_logs"
+    __tablename__ = "auth_verification_tokens"
+
+    identifier: Mapped[text] = mapped_column(VARCHAR, primary_key=True)
+    token: Mapped[text] = mapped_column(VARCHAR, primary_key=True)
+    expires: Mapped[date]
+    created: Mapped[dt_create]
+    updated: Mapped[dt_update]
 
-#     id: Mapped[intpk]
-#     slack_space_id: Mapped[int] = mapped_column(ForeignKey("slack_spaces.id"))
-#     event: Mapped[str]
-#     data: Mapped[Optional[Dict[str, Any]]]
-#     created: Mapped[dt_create]
+
+class UpdateRequest(Base):
+    """
+    Model representing an update request.
+
+    Attributes:
+        id (UUID): The ID of the update request.
+        token (UUID): The token of the update request.
+        region_id (int): The ID of the associated region.
+        event_id (Optional[int]): The ID of the associated event.
+        event_type_ids (Optional[List[int]]): The associated event type IDs.
+        event_tag (Optional[str]): The associated event tag.
+        event_series_id (Optional[int]): The ID of the associated event series.
+        event_is_series (Optional[bool]): Whether the event is a series.
+        event_is_active (Optional[bool]): Whether the event is active.
+        event_highlight (Optional[bool]): Whether the event is highlighted.
+        event_start_date (Optional[date]): The start date of the event.
+        event_end_date (Optional[date]): The end date of the event.
+        event_start_time (Optional[time_notz]): The start time of the event.
+        event_end_time (Optional[time_notz]): The end time of the event.
+        event_day_of_week (Optional[int]): The day of the week of the event.
+        event_name (str): The name of the event.
+        event_description (Optional[text]): A description of the event.
+        event_recurrence_pattern (Optional[str]): The recurrence pattern of the event.
+        event_recurrence_interval (Optional[int]): The recurrence interval of the event.
+        event_index_within_interval (Optional[int]): The index within the recurrence interval.
+        event_meta (Optional[Dict[str, Any]]): Additional metadata for the event.
+        event_contact_email (Optional[str]): The contact email of the event.
+        location_name (Optional[text]): The name of the location.
+        location_description (Optional[text]): A description of the location.
+        location_address (Optional[text]): The address of the location.
+        location_address2 (Optional[text]): The second address line of the location.
+        location_city (Optional[text]): The city of the location.
+        location_state (Optional[str]): The state of the location.
+        location_zip (Optional[str]): The ZIP code of the location.
+        location_country (Optional[str]): The country of the location.
+        location_lat (Optional[float]): The latitude of the location.
+        location_lng (Optional[float]): The longitude of the location.
+        location_id (Optional[int]): The ID of the location.
+        location_contact_email (Optional[str]): The contact email of the location.
+        ao_logo (Optional[text]): The URL of the AO logo.
+        submitted_by (str): The user who submitted the request.
+        submitter_validated (Optional[bool]): Whether the submitter has validated the request. Default is False.
+        reviewed_by (Optional[str]): The user who reviewed the request.
+        reviewed_at (Optional[datetime]): The timestamp when the request was reviewed.
+        status (UpdateRequestStatus): The status of the request. Default is 'pending'.
+        meta (Optional[Dict[str, Any]]): Additional metadata for the request.
+        created (datetime): The timestamp when the record was created.
+        updated (datetime): The timestamp when the record was last updated.
+    """
+
+    __tablename__ = "update_requests"
+
+    id: Mapped[Uuid] = mapped_column(UUID(as_uuid=True), primary_key=True)
+    token: Mapped[Uuid] = mapped_column(UUID(as_uuid=True), default=uuid.uuid4)
+    region_id: Mapped[int] = mapped_column(ForeignKey("orgs.id"))
+    event_id: Mapped[Optional[int]] = mapped_column(ForeignKey("events.id"))
+    event_type_ids: Mapped[Optional[List[int]]] = mapped_column(ARRAY(Integer))
+    event_tag: Mapped[Optional[str]]
+    event_series_id: Mapped[Optional[int]]
+    event_is_series: Mapped[Optional[bool]]
+    event_is_active: Mapped[Optional[bool]]
+    event_highlight: Mapped[Optional[bool]]
+    event_start_date: Mapped[Optional[date]]
+    event_end_date: Mapped[Optional[date]]
+    event_start_time: Mapped[Optional[time_notz]]
+    event_end_time: Mapped[Optional[time_notz]]
+    event_day_of_week: Mapped[Optional[str]] = mapped_column(VARCHAR(length=30))
+    event_name: Mapped[str]
+    event_description: Mapped[Optional[text]]
+    event_recurrence_pattern: Mapped[Optional[str]] = mapped_column(VARCHAR(length=30))
+    event_recurrence_interval: Mapped[Optional[int]]
+    event_index_within_interval: Mapped[Optional[int]]
+    event_meta: Mapped[Optional[Dict[str, Any]]]
+    event_contact_email: Mapped[Optional[str]]
+
+    location_name: Mapped[Optional[text]]
+    location_description: Mapped[Optional[text]]
+    location_address: Mapped[Optional[text]]
+    location_address2: Mapped[Optional[text]]
+    location_city: Mapped[Optional[text]]
+    location_state: Mapped[Optional[str]]
+    location_zip: Mapped[Optional[str]]
+    location_country: Mapped[Optional[str]]
+    location_lat: Mapped[Optional[float]] = mapped_column(
+        Float(precision=8, decimal_return_scale=5)
+    )
+    location_lng: Mapped[Optional[float]] = mapped_column(
+        Float(precision=8, decimal_return_scale=5)
+    )
+    location_id: Mapped[Optional[int]] = mapped_column(ForeignKey("locations.id"))
+    location_contact_email: Mapped[Optional[str]]
+
+    ao_logo: Mapped[Optional[text]]
+
+    submitted_by: Mapped[text]
+    submitter_validated: Mapped[Optional[bool]] = mapped_column(Boolean, default=False)
+    reviewed_by: Mapped[Optional[text]]
+    reviewed_at: Mapped[Optional[datetime]]
+    status: Mapped[UpdateRequestStatus] = mapped_column(
+        Enum(UpdateRequestStatus), default=UpdateRequestStatus.pending
+    )
+    meta: Mapped[Optional[Dict[str, Any]]]
+
+    created: Mapped[dt_create]
+    updated: Mapped[dt_update]

{f3_data_models-0.2.4 → f3_data_models-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "f3-data-models"
-version = "0.2.4"
+version = "0.3.0"
 description = "The data schema and models for F3 Nation applications."
 authors = ["Evan Petzoldt <evan.petzoldt@protonmail.com>"]
 readme = "README.md"
@@ -24,6 +24,7 @@ sphinx-rtd-theme = "^3.0.2"
 sphinx-multiversion = "^0.2.4"
 psycopg2-binary = "^2.9.10"
 sqlmodel = "^0.0.22"
+alembic-postgresql-enum = "^1.6.1"
 
 
 [build-system]