Samir Boulahtit
967f08e4ba
Add new validation rules MOD-020 to MOD-023 for module definition completeness and standardize permissions across all modules. Changes: - Add MOD-020: Module definitions must have required attributes - Add MOD-021: Modules with menus should have features - Add MOD-022: Feature modules should have permissions - Add MOD-023: Modules with routers should use get_*_with_routers pattern Module permissions added: - analytics: view, export, manage_dashboards - billing: view_tiers, manage_tiers, view_subscriptions, manage_subscriptions, view_invoices - cart: view, manage - checkout: view_settings, manage_settings - cms: view_pages, manage_pages, view_media, manage_media, manage_themes - loyalty: view_programs, manage_programs, view_rewards, manage_rewards - marketplace: view_integration, manage_integration, sync_products - messaging: view_messages, send_messages, manage_templates - payments: view_gateways, manage_gateways, view_transactions Module improvements: - Complete cart module with features and permissions - Complete checkout module with features and permissions - Add features to catalog module - Add version to cms module - Fix loyalty platform_router attachment - Add path definitions to payments module - Remove empty scheduled_tasks from dev_tools module Documentation: - Update module-system.md with new validation rules - Update architecture-rules.md with MOD-020 to MOD-023 Tests: - Add unit tests for module definition completeness - Add tests for permission structure validation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
185 lines
6.4 KiB
Python
185 lines
6.4 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, PermissionDefinition
|
|
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
|
|
],
|
|
# Module-driven permissions
|
|
permissions=[
|
|
PermissionDefinition(
|
|
id="messaging.view_messages",
|
|
label_key="messaging.permissions.view_messages",
|
|
description_key="messaging.permissions.view_messages_desc",
|
|
category="messaging",
|
|
),
|
|
PermissionDefinition(
|
|
id="messaging.send_messages",
|
|
label_key="messaging.permissions.send_messages",
|
|
description_key="messaging.permissions.send_messages_desc",
|
|
category="messaging",
|
|
),
|
|
PermissionDefinition(
|
|
id="messaging.manage_templates",
|
|
label_key="messaging.permissions.manage_templates",
|
|
description_key="messaging.permissions.manage_templates_desc",
|
|
category="messaging",
|
|
),
|
|
],
|
|
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"]
|