Samir Boulahtit
03395a9dfa
File Relocations: - Delete app/config/ folder (empty after menu_registry removal) - Move feature_gate.py → app/modules/billing/dependencies/ - Move theme_presets.py → app/modules/cms/services/ Module-Driven Permissions System: - Add PermissionDefinition dataclass to app/modules/base.py - Create PermissionDiscoveryService in tenancy module - Update module definitions to declare their own permissions: - core: dashboard.view, settings.* - catalog: products.* - orders: orders.* - inventory: stock.* - customers: customers.* - tenancy: team.* - Update app/core/permissions.py to use discovery service - Role presets (owner, manager, staff, etc.) now use module permissions This follows the same pattern as module-driven menus: - Each module defines its permissions in definition.py - PermissionDiscoveryService aggregates all permissions at runtime - Tenancy module handles role-to-permission assignment Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
143 lines
4.7 KiB
Python
143 lines
4.7 KiB
Python
# 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
|
|
|
|
|
|
# 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",
|
|
)
|
|
|
|
|
|
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"]
|