# app/modules/customers/definition.py """ Customers module definition. Defines the customers 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.customers.routes.admin import admin_router return admin_router def _get_vendor_router(): """Lazy import of vendor router to avoid circular imports.""" from app.modules.customers.routes.vendor import vendor_router return vendor_router def _get_metrics_provider(): """Lazy import of metrics provider to avoid circular imports.""" from app.modules.customers.services.customer_metrics import customer_metrics_provider return customer_metrics_provider # Customers module definition customers_module = ModuleDefinition( code="customers", name="Customer Management", description="Customer database, profiles, addresses, and segmentation.", version="1.0.0", # Module-driven permissions permissions=[ PermissionDefinition( id="customers.view", label_key="customers.permissions.customers_view", description_key="customers.permissions.customers_view_desc", category="customers", ), PermissionDefinition( id="customers.edit", label_key="customers.permissions.customers_edit", description_key="customers.permissions.customers_edit_desc", category="customers", ), PermissionDefinition( id="customers.delete", label_key="customers.permissions.customers_delete", description_key="customers.permissions.customers_delete_desc", category="customers", ), PermissionDefinition( id="customers.export", label_key="customers.permissions.customers_export", description_key="customers.permissions.customers_export_desc", category="customers", ), ], features=[ "customer_view", # View customer profiles "customer_export", # Export customer data "customer_profiles", # Detailed customer profiles "customer_segmentation", # Customer tagging and segments "customer_addresses", # Address management "customer_authentication", # Customer login/registration ], menu_items={ FrontendType.ADMIN: [ "customers", # Platform-wide customer view ], FrontendType.VENDOR: [ "customers", # Vendor customer list ], }, # New module-driven menu definitions menus={ FrontendType.ADMIN: [ MenuSectionDefinition( id="vendorOps", label_key="customers.menu.vendor_operations", icon="user-group", order=40, items=[ MenuItemDefinition( id="customers", label_key="customers.menu.customers", icon="user-group", route="/admin/customers", order=20, ), ], ), ], FrontendType.VENDOR: [ MenuSectionDefinition( id="customers", label_key="customers.menu.customers_section", icon="user-group", order=30, items=[ MenuItemDefinition( id="customers", label_key="customers.menu.all_customers", icon="user-group", route="/vendor/{vendor_code}/customers", order=10, ), ], ), ], }, is_core=True, # Customers is a core module - customer data is fundamental # ========================================================================= # Self-Contained Module Configuration # ========================================================================= is_self_contained=True, services_path="app.modules.customers.services", models_path="app.modules.customers.models", schemas_path="app.modules.customers.schemas", exceptions_path="app.modules.customers.exceptions", # Metrics provider for dashboard statistics metrics_provider=_get_metrics_provider, ) def get_customers_module_with_routers() -> ModuleDefinition: """ Get customers module with routers attached. This function attaches the routers lazily to avoid circular imports during module initialization. """ customers_module.admin_router = _get_admin_router() customers_module.vendor_router = _get_vendor_router() return customers_module __all__ = ["customers_module", "get_customers_module_with_routers"]