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>
124 lines
4.1 KiB
Python
124 lines
4.1 KiB
Python
# app/modules/inventory/definition.py
|
|
"""
|
|
Inventory module definition.
|
|
|
|
Defines the inventory 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.inventory.routes.admin import admin_router
|
|
|
|
return admin_router
|
|
|
|
|
|
def _get_vendor_router():
|
|
"""Lazy import of vendor router to avoid circular imports."""
|
|
from app.modules.inventory.routes.vendor import vendor_router
|
|
|
|
return vendor_router
|
|
|
|
|
|
# Inventory module definition
|
|
inventory_module = ModuleDefinition(
|
|
code="inventory",
|
|
name="Inventory Management",
|
|
description=(
|
|
"Stock level tracking, inventory locations, low stock alerts, "
|
|
"transaction history, and bulk imports."
|
|
),
|
|
version="1.0.0",
|
|
features=[
|
|
"inventory_basic", # Basic stock tracking
|
|
"inventory_locations", # Multiple warehouse locations
|
|
"low_stock_alerts", # Automated low stock notifications
|
|
"inventory_purchase_orders", # Purchase order management
|
|
"product_management", # Product catalog CRUD
|
|
"inventory_transactions", # Stock movement history
|
|
"inventory_import", # Bulk inventory import
|
|
],
|
|
menu_items={
|
|
FrontendType.ADMIN: [
|
|
"inventory", # Platform-wide inventory view
|
|
"vendor-products", # Product catalog management
|
|
],
|
|
FrontendType.VENDOR: [
|
|
"products", # Vendor product catalog
|
|
"inventory", # Vendor inventory management
|
|
],
|
|
},
|
|
# New module-driven menu definitions
|
|
menus={
|
|
FrontendType.ADMIN: [
|
|
MenuSectionDefinition(
|
|
id="vendorOps",
|
|
label_key="inventory.menu.vendor_operations",
|
|
icon="cube",
|
|
order=40,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="vendor-products",
|
|
label_key="inventory.menu.products",
|
|
icon="cube",
|
|
route="/admin/vendor-products",
|
|
order=10,
|
|
),
|
|
MenuItemDefinition(
|
|
id="inventory",
|
|
label_key="inventory.menu.inventory",
|
|
icon="archive",
|
|
route="/admin/inventory",
|
|
order=30,
|
|
),
|
|
],
|
|
),
|
|
],
|
|
FrontendType.VENDOR: [
|
|
MenuSectionDefinition(
|
|
id="products",
|
|
label_key="inventory.menu.products_inventory",
|
|
icon="package",
|
|
order=10,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="inventory",
|
|
label_key="inventory.menu.inventory",
|
|
icon="clipboard-list",
|
|
route="/vendor/{vendor_code}/inventory",
|
|
order=20,
|
|
),
|
|
],
|
|
),
|
|
],
|
|
},
|
|
is_core=False,
|
|
# =========================================================================
|
|
# Self-Contained Module Configuration
|
|
# =========================================================================
|
|
is_self_contained=True,
|
|
services_path="app.modules.inventory.services",
|
|
models_path="app.modules.inventory.models",
|
|
schemas_path="app.modules.inventory.schemas",
|
|
exceptions_path="app.modules.inventory.exceptions",
|
|
)
|
|
|
|
|
|
def get_inventory_module_with_routers() -> ModuleDefinition:
|
|
"""
|
|
Get inventory module with routers attached.
|
|
|
|
This function attaches the routers lazily to avoid circular imports
|
|
during module initialization.
|
|
"""
|
|
inventory_module.admin_router = _get_admin_router()
|
|
inventory_module.vendor_router = _get_vendor_router()
|
|
return inventory_module
|
|
|
|
|
|
__all__ = ["inventory_module", "get_inventory_module_with_routers"]
|