Files
orion/app/modules/customers/definition.py
Samir Boulahtit 1a52611438 feat: implement three-tier module classification and framework layer
Module Classification:
- Core (4): core, tenancy, cms, customers - always enabled
- Optional (7): payments, billing, inventory, orders, marketplace, analytics, messaging
- Internal (2): dev-tools, monitoring - admin-only

Key Changes:
- Rename platform-admin module to tenancy
- Promote CMS and Customers to core modules
- Create new payments module (gateway abstractions)
- Add billing→payments and orders→payments dependencies
- Mark dev-tools and monitoring as internal modules

New Infrastructure:
- app/modules/events.py: Module event bus (ENABLED, DISABLED, STARTUP, SHUTDOWN)
- app/modules/migrations.py: Module-specific migration discovery
- app/core/observability.py: Health checks, Prometheus metrics, Sentry integration

Enhanced ModuleDefinition:
- version, is_internal, permissions
- config_schema, default_config
- migrations_path
- Lifecycle hooks: on_enable, on_disable, on_startup, health_check

New Registry Functions:
- get_optional_module_codes(), get_internal_module_codes()
- is_core_module(), is_internal_module()
- get_modules_by_tier(), get_module_tier()

Migrations:
- zc*: Rename platform-admin to tenancy
- zd*: Ensure CMS and Customers enabled for all platforms

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-27 22:02:39 +01:00

63 lines
1.8 KiB
Python

# app/modules/customers/definition.py
"""
Customers module definition.
Defines the customers module including its features, menu items,
and route configurations.
"""
from app.modules.base import ModuleDefinition
from models.database.admin_menu_config 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
# Customers module definition
customers_module = ModuleDefinition(
code="customers",
name="Customer Management",
description="Customer database, profiles, and segmentation.",
features=[
"customer_view", # View customer profiles
"customer_export", # Export customer data
"customer_profiles", # Detailed customer profiles
"customer_segmentation", # Customer tagging and segments
],
menu_items={
FrontendType.ADMIN: [
"customers", # Platform-wide customer view
],
FrontendType.VENDOR: [
"customers", # Vendor customer list
],
},
is_core=True, # Customers is a core module - customer data is fundamental
)
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"]