core-framework 0.3.0__py3-none-any.whl

core_framework/alembic/user/alembic/versions/94b973923895_add_user_change_history_table.py

@@ -0,0 +1,97 @@
+"""add user_change_history table
+
+Revision ID: 94b973923895
+Revises: 62417002cf32
+Create Date: 2026-02-08 08:28:43.812819
+
+"""
+
+from collections.abc import Sequence
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "94b973923895"
+down_revision: str | Sequence[str] | None = "62417002cf32"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    op.execute("""
+        create table user_change_history (
+            id bigint generated always as identity primary key,
+            user_id varchar(128) not null references users(user_id) on delete cascade,
+            actor_id varchar(128),
+            entity_type varchar(50) not null,
+            field varchar(100) not null,
+            old_value text,
+            new_value text,
+            created_at timestamptz not null default now()
+        );
+    """)
+    op.execute("""
+        create index idx_user_change_history_user_created
+        on user_change_history (user_id, created_at desc);
+    """)
+    op.execute("""
+        create or replace function log_user_update_change()
+        returns trigger as $$
+        begin
+            if tg_op = 'UPDATE' then
+                if new.username is distinct from old.username then
+                    insert into "user".user_change_history (user_id, actor_id, entity_type, field, old_value, new_value)
+                    values (new.user_id, current_setting('app.actor_id', true), 'users', 'username', old.username, new.username);
+                end if;
+                if new.role is distinct from old.role then
+                    insert into "user".user_change_history (user_id, actor_id, entity_type, field, old_value, new_value)
+                    values (new.user_id, current_setting('app.actor_id', true), 'users', 'role', old.role::text, new.role::text);
+                end if;
+                if new.avatar_id is distinct from old.avatar_id then
+                    insert into "user".user_change_history (user_id, actor_id, entity_type, field, old_value, new_value)
+                    values (new.user_id, current_setting('app.actor_id', true), 'users', 'avatar_id', old.avatar_id, new.avatar_id);
+                end if;
+            end if;
+            return new;
+        end;
+        $$ language plpgsql;
+    """)
+    op.execute("""
+        create trigger user_change_history_users_trigger
+        after update on users
+        for each row
+        execute function log_user_update_change();
+    """)
+    op.execute("""
+        create or replace function log_user_deletion_change()
+        returns trigger as $$
+        begin
+            if tg_op = 'INSERT' then
+                insert into "user".user_change_history (user_id, actor_id, entity_type, field, old_value, new_value)
+                values (new.user_id, current_setting('app.actor_id', true), 'user_deletions', 'scheduled_for', null, new.scheduled_for::text);
+                return new;
+            elsif tg_op = 'DELETE' then
+                insert into "user".user_change_history (user_id, actor_id, entity_type, field, old_value, new_value)
+                values (old.user_id, current_setting('app.actor_id', true), 'user_deletions', 'scheduled_for', old.scheduled_for::text, null);
+                return old;
+            end if;
+            return null;
+        end;
+        $$ language plpgsql;
+    """)
+    op.execute("""
+        create trigger user_change_history_deletions_trigger
+        after insert or delete on user_deletions
+        for each row
+        execute function log_user_deletion_change();
+    """)
+
+
+def downgrade() -> None:
+    op.execute("drop trigger if exists user_change_history_deletions_trigger on user_deletions;")
+    op.execute("drop trigger if exists user_change_history_users_trigger on users;")
+    op.execute("drop function if exists log_user_deletion_change();")
+    op.execute("drop function if exists log_user_update_change();")
+    op.execute("drop index if exists idx_user_change_history_user_created;")
+    op.execute("drop table if exists user_change_history;")

core_framework/alembic/user/alembic/versions/cbc0f4efe84f_add_avatar_id_column_to_users_table.py

@@ -0,0 +1,31 @@
+"""add avatar_id column to users table
+
+Revision ID: cbc0f4efe84f
+Revises: 47f47ce2110e
+Create Date: 2026-01-17 08:10:44.617640
+
+"""
+
+from collections.abc import Sequence
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "cbc0f4efe84f"
+down_revision: str | Sequence[str] | None = "47f47ce2110e"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.execute("""
+        alter table users
+        add column avatar_id varchar(36) null;
+    """)
+
+
+def downgrade() -> None:
+    op.execute("""
+        alter table users
+        drop column avatar_id;
+    """)

core_framework/alembic/user/alembic/versions/d8b98ac6b073_add_index_for_get_admin_user_ids_query.py

@@ -0,0 +1,29 @@
+"""add index for retrieve_admin_user_ids query
+
+Revision ID: d8b98ac6b073
+Revises: 7a56631f9927
+Create Date: 2026-01-06 06:43:07.084368
+
+"""
+
+from collections.abc import Sequence
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "d8b98ac6b073"
+down_revision: str | Sequence[str] | None = "7a56631f9927"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.execute("""
+        create index idx_users_role_admin
+        on users (user_id)
+        where role = 'admin'
+    """)
+
+
+def downgrade() -> None:
+    op.execute("drop index if exists idx_users_role_admin")

core_framework/alembic/user/alembic/versions/ddb70cc09d16_create_user_states_table.py

@@ -0,0 +1,34 @@
+"""create user_states table
+
+Revision ID: ddb70cc09d16
+Revises: 831611e589bc
+Create Date: 2025-12-27 11:56:49.222617
+
+"""
+
+from collections.abc import Sequence
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "ddb70cc09d16"
+down_revision: str | Sequence[str] | None = "831611e589bc"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.execute("""
+        create table user_states (
+            user_id varchar(128) primary key references users(user_id) on delete cascade,
+            state user_state not null default 'active',
+            reason text,
+            expires_at timestamptz,
+            created_at timestamptz not null default now(),
+            updated_at timestamptz not null default now()
+        );
+    """)
+
+
+def downgrade() -> None:
+    op.execute("drop table if exists user_states;")

core_framework/alembic/user/alembic/versions/f9ba10815ecd_add_users_table.py

@@ -0,0 +1,33 @@
+"""add users table
+
+Revision ID: f9ba10815ecd
+Revises: 8a94362cad6d
+Create Date: 2025-12-26 12:26:41.852985
+
+"""
+
+from collections.abc import Sequence
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "f9ba10815ecd"
+down_revision: str | Sequence[str] | None = "8a94362cad6d"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.execute("""
+        create table users (
+            user_id varchar(128) primary key,
+            username varchar(50) unique not null,
+            role user_role not null default 'member',
+            created_at timestamptz not null default now(),
+            updated_at timestamptz not null default now()
+        );
+    """)
+
+
+def downgrade() -> None:
+    op.execute("drop table if exists users;")

core_framework/alembic/user/alembic.ini

@@ -0,0 +1,147 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts.
+# this is typically a path given in POSIX (e.g. forward slashes)
+# format, relative to the token %(here)s which refers to the location of this
+# ini file
+script_location = %(here)s/alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.  for multiple paths, the path separator
+# is defined by "path_separator" below.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the tzdata library which can be installed by adding
+# `alembic[tz]` to the pip requirements.
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to <script_location>/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "path_separator"
+# below.
+# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
+
+# path_separator; This indicates what character is used to split lists of file
+# paths, including version_locations and prepend_sys_path within configparser
+# files such as alembic.ini.
+# The default rendered in new alembic.ini files is "os", which uses os.pathsep
+# to provide os-dependent path splitting.
+#
+# Note that in order to support legacy alembic.ini files, this default does NOT
+# take place if path_separator is not present in alembic.ini.  If this
+# option is omitted entirely, fallback logic is as follows:
+#
+# 1. Parsing of the version_locations option falls back to using the legacy
+#    "version_path_separator" key, which if absent then falls back to the legacy
+#    behavior of splitting on spaces and/or commas.
+# 2. Parsing of the prepend_sys_path option falls back to the legacy
+#    behavior of splitting on spaces, commas, or colons.
+#
+# Valid values for path_separator are:
+#
+# path_separator = :
+# path_separator = ;
+# path_separator = space
+# path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+path_separator = os
+
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# database URL.  This is consumed by the user-maintained env.py script only.
+# other means of configuring database URLs may be customized within the env.py
+# file.
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration.  This is also consumed by the user-maintained
+# env.py script only.
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

core_framework/api/admin/comments/router.py

@@ -0,0 +1,69 @@
+from typing import Annotated, Any
+
+from fastapi import APIRouter, BackgroundTasks, Depends, Request, status
+from ulid import ULID
+
+from core_framework.api.admin.comments.schemas import AdminCommentResponse
+from core_framework.application.comments.admin_service import (
+    remove_comment,
+    restore_comment,
+    retrieve_admin_comment_by_id,
+    retrieve_admin_comments,
+    set_comment_inactive,
+)
+from core_framework.application.comments.authenticated_service import mark_comment_stats_dirty
+from core_framework.core.pagination import (
+    PaginationCursorType,
+    PaginationResponse,
+    TokenCursorQueryParams,
+    paginate_cursor,
+)
+
+router = APIRouter(
+    prefix="/comments",
+    tags=["comments - admin"],
+)
+
+
+@router.get("", response_model=PaginationResponse[AdminCommentResponse])
+async def get_comments(
+    request: Request,
+    pagination_params: Annotated[TokenCursorQueryParams, Depends()],
+) -> Any:
+    comments = await retrieve_admin_comments(
+        cursor=pagination_params.cursor,
+        limit=pagination_params.limit,
+    )
+    return paginate_cursor(
+        request=request,
+        items=comments,
+        limit=pagination_params.limit,
+        cursor_field=PaginationCursorType.CREATED_AT,
+        retrieved=pagination_params.retrieved,
+    )
+
+
+@router.get("/{comment_id}", response_model=AdminCommentResponse)
+async def get_comment(comment_id: ULID) -> Any:
+    return await retrieve_admin_comment_by_id(comment_id=str(comment_id))
+
+
+@router.put("/{comment_id}/inactive", status_code=status.HTTP_204_NO_CONTENT)
+async def put_comment_inactive(comment_id: ULID, background_tasks: BackgroundTasks) -> None:
+    parent_comment_id = await set_comment_inactive(comment_id=str(comment_id))
+    if parent_comment_id is not None:
+        background_tasks.add_task(mark_comment_stats_dirty, comment_id=parent_comment_id)
+
+
+@router.delete("/{comment_id}/inactive", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_comment_inactive(comment_id: ULID, background_tasks: BackgroundTasks) -> None:
+    parent_comment_id = await restore_comment(comment_id=str(comment_id))
+    if parent_comment_id is not None:
+        background_tasks.add_task(mark_comment_stats_dirty, comment_id=parent_comment_id)
+
+
+@router.delete("/{comment_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_comment(comment_id: ULID, background_tasks: BackgroundTasks) -> None:
+    parent_comment_id = await remove_comment(comment_id=str(comment_id))
+    if parent_comment_id is not None:
+        background_tasks.add_task(mark_comment_stats_dirty, comment_id=parent_comment_id)

core_framework/api/admin/comments/schemas.py

@@ -0,0 +1,53 @@
+from datetime import datetime
+from typing import Annotated, Literal
+
+from pydantic import BaseModel, Field
+from ulid import ULID
+
+from core_framework.api.comments.schemas import CommentContent
+from core_framework.api.users.shared.schemas import UserReference
+from core_framework.domains.comment import CommentStatus, CommentSubjectType
+
+
+class AdminCommentStatsResponse(BaseModel):
+    like_count: Annotated[int, Field(ge=0)] = 0
+    reply_count: Annotated[int, Field(ge=0)] = 0
+    report_count: Annotated[int, Field(ge=0)] = 0
+
+
+class PostSubjectPreview(BaseModel):
+    subject_type: Literal[CommentSubjectType.POST]
+    post_id: ULID
+    author: UserReference
+    content_preview: Annotated[str, Field(min_length=1)]
+
+
+class UserWallSubjectPreview(BaseModel):
+    subject_type: Literal[CommentSubjectType.USER_WALL]
+    user: UserReference
+
+
+type AdminCommentSubjectPreview = Annotated[
+    PostSubjectPreview | UserWallSubjectPreview,
+    Field(discriminator="subject_type"),
+]
+
+
+class ParentCommentPreview(BaseModel):
+    comment_id: ULID
+    author: UserReference
+    content_preview: Annotated[str, Field(min_length=1)]
+    status: CommentStatus
+
+
+class AdminCommentResponse(BaseModel):
+    id: ULID
+    author: UserReference
+    content: CommentContent
+    subject: AdminCommentSubjectPreview
+    parent_comment: ParentCommentPreview | None
+    status: CommentStatus
+    edited_count: Annotated[int, Field(ge=0)] = 0
+    stats: AdminCommentStatsResponse
+    edited_at: datetime | None
+    created_at: datetime