Samir Boulahtit
d7a0ff8818
This commit completes the migration to a fully module-driven architecture: ## Models Migration - Moved all domain models from models/database/ to their respective modules: - tenancy: User, Admin, Vendor, Company, Platform, VendorDomain, etc. - cms: MediaFile, VendorTheme - messaging: Email, VendorEmailSettings, VendorEmailTemplate - core: AdminMenuConfig - models/database/ now only contains Base and TimestampMixin (infrastructure) ## Schemas Migration - Moved all domain schemas from models/schema/ to their respective modules: - tenancy: company, vendor, admin, team, vendor_domain - cms: media, image, vendor_theme - messaging: email - models/schema/ now only contains base.py and auth.py (infrastructure) ## Routes Migration - Moved admin routes from app/api/v1/admin/ to modules: - menu_config.py -> core module - modules.py -> tenancy module - module_config.py -> tenancy module - app/api/v1/admin/ now only aggregates auto-discovered module routes ## Menu System - Implemented module-driven menu system with MenuDiscoveryService - Extended FrontendType enum: PLATFORM, ADMIN, VENDOR, STOREFRONT - Added MenuItemDefinition and MenuSectionDefinition dataclasses - Each module now defines its own menu items in definition.py - MenuService integrates with MenuDiscoveryService for template rendering ## Documentation - Updated docs/architecture/models-structure.md - Updated docs/architecture/menu-management.md - Updated architecture validation rules for new exceptions ## Architecture Validation - Updated MOD-019 rule to allow base.py in models/schema/ - Created core module exceptions.py and schemas/ directory - All validation errors resolved (only warnings remain) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
164 lines
5.5 KiB
Python
164 lines
5.5 KiB
Python
# app/modules/messaging/definition.py
|
|
"""
|
|
Messaging module definition.
|
|
|
|
Defines the messaging module including its features, menu items,
|
|
route configurations, and self-contained module settings.
|
|
"""
|
|
|
|
from app.modules.base import MenuItemDefinition, MenuSectionDefinition, ModuleDefinition
|
|
from app.modules.enums import FrontendType
|
|
|
|
|
|
def _get_admin_router():
|
|
"""Lazy import of admin router to avoid circular imports."""
|
|
from app.modules.messaging.routes.admin import admin_router
|
|
|
|
return admin_router
|
|
|
|
|
|
def _get_vendor_router():
|
|
"""Lazy import of vendor router to avoid circular imports."""
|
|
from app.modules.messaging.routes.vendor import vendor_router
|
|
|
|
return vendor_router
|
|
|
|
|
|
# Messaging module definition
|
|
messaging_module = ModuleDefinition(
|
|
code="messaging",
|
|
name="Messaging & Notifications",
|
|
description="Internal messages, customer communication, and notifications.",
|
|
version="1.0.0",
|
|
features=[
|
|
"customer_messaging", # Customer communication
|
|
"internal_messages", # Internal team messages
|
|
"notification_center", # Notification management
|
|
"message_attachments", # File attachments
|
|
"admin_notifications", # System admin notifications
|
|
],
|
|
menu_items={
|
|
FrontendType.ADMIN: [
|
|
"messages", # Admin messages
|
|
"notifications", # Admin notifications
|
|
],
|
|
FrontendType.VENDOR: [
|
|
"messages", # Vendor messages
|
|
"notifications", # Vendor notifications
|
|
],
|
|
},
|
|
# New module-driven menu definitions
|
|
menus={
|
|
FrontendType.ADMIN: [
|
|
MenuSectionDefinition(
|
|
id="platformAdmin",
|
|
label_key="messaging.menu.platform_admin",
|
|
icon="chat-bubble-left-right",
|
|
order=20,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="messages",
|
|
label_key="messaging.menu.messages",
|
|
icon="chat-bubble-left-right",
|
|
route="/admin/messages",
|
|
order=30,
|
|
),
|
|
],
|
|
),
|
|
MenuSectionDefinition(
|
|
id="monitoring",
|
|
label_key="messaging.menu.platform_monitoring",
|
|
icon="bell",
|
|
order=80,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="notifications",
|
|
label_key="messaging.menu.notifications",
|
|
icon="bell",
|
|
route="/admin/notifications",
|
|
order=40,
|
|
),
|
|
],
|
|
),
|
|
MenuSectionDefinition(
|
|
id="settings",
|
|
label_key="messaging.menu.platform_settings",
|
|
icon="mail",
|
|
order=900,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="email-templates",
|
|
label_key="messaging.menu.email_templates",
|
|
icon="mail",
|
|
route="/admin/email-templates",
|
|
order=20,
|
|
),
|
|
],
|
|
),
|
|
],
|
|
FrontendType.VENDOR: [
|
|
MenuSectionDefinition(
|
|
id="customers",
|
|
label_key="messaging.menu.customers",
|
|
icon="chat-bubble-left-right",
|
|
order=30,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="messages",
|
|
label_key="messaging.menu.messages",
|
|
icon="chat-bubble-left-right",
|
|
route="/vendor/{vendor_code}/messages",
|
|
order=20,
|
|
),
|
|
MenuItemDefinition(
|
|
id="notifications",
|
|
label_key="messaging.menu.notifications",
|
|
icon="bell",
|
|
route="/vendor/{vendor_code}/notifications",
|
|
order=30,
|
|
),
|
|
],
|
|
),
|
|
MenuSectionDefinition(
|
|
id="account",
|
|
label_key="messaging.menu.account_settings",
|
|
icon="mail",
|
|
order=900,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="email-templates",
|
|
label_key="messaging.menu.email_templates",
|
|
icon="mail",
|
|
route="/vendor/{vendor_code}/email-templates",
|
|
order=40,
|
|
),
|
|
],
|
|
),
|
|
],
|
|
},
|
|
is_core=False,
|
|
# =========================================================================
|
|
# Self-Contained Module Configuration
|
|
# =========================================================================
|
|
is_self_contained=True,
|
|
services_path="app.modules.messaging.services",
|
|
models_path="app.modules.messaging.models",
|
|
schemas_path="app.modules.messaging.schemas",
|
|
exceptions_path="app.modules.messaging.exceptions",
|
|
)
|
|
|
|
|
|
def get_messaging_module_with_routers() -> ModuleDefinition:
|
|
"""
|
|
Get messaging module with routers attached.
|
|
|
|
This function attaches the routers lazily to avoid circular imports
|
|
during module initialization.
|
|
"""
|
|
messaging_module.admin_router = _get_admin_router()
|
|
messaging_module.vendor_router = _get_vendor_router()
|
|
return messaging_module
|
|
|
|
|
|
__all__ = ["messaging_module", "get_messaging_module_with_routers"]
|