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>
165 lines
5.8 KiB
Python
165 lines
5.8 KiB
Python
# app/modules/marketplace/definition.py
|
|
"""
|
|
Marketplace module definition.
|
|
|
|
Defines the marketplace module including its features, menu items,
|
|
dependencies, route configurations, and scheduled tasks.
|
|
|
|
Note: This module requires the inventory module to be enabled.
|
|
"""
|
|
|
|
from app.modules.base import MenuItemDefinition, MenuSectionDefinition, ModuleDefinition, PermissionDefinition, ScheduledTask
|
|
from app.modules.enums import FrontendType
|
|
|
|
|
|
def _get_admin_router():
|
|
"""Lazy import of admin router to avoid circular imports."""
|
|
from app.modules.marketplace.routes.api.admin import admin_router
|
|
|
|
return admin_router
|
|
|
|
|
|
def _get_vendor_router():
|
|
"""Lazy import of vendor router to avoid circular imports."""
|
|
from app.modules.marketplace.routes.api.vendor import vendor_router
|
|
|
|
return vendor_router
|
|
|
|
|
|
# Marketplace module definition
|
|
marketplace_module = ModuleDefinition(
|
|
code="marketplace",
|
|
name="Marketplace (Letzshop)",
|
|
description=(
|
|
"Letzshop marketplace integration for product sync, order import, "
|
|
"and catalog synchronization."
|
|
),
|
|
version="1.0.0",
|
|
requires=["inventory"], # Depends on inventory module
|
|
features=[
|
|
"letzshop_sync", # Sync products with Letzshop
|
|
"marketplace_import", # Import products from marketplace
|
|
"product_sync", # Bidirectional product sync
|
|
"order_import", # Import orders from marketplace
|
|
"marketplace_analytics", # Marketplace performance metrics
|
|
],
|
|
# Module-driven permissions
|
|
permissions=[
|
|
PermissionDefinition(
|
|
id="marketplace.view_integration",
|
|
label_key="marketplace.permissions.view_integration",
|
|
description_key="marketplace.permissions.view_integration_desc",
|
|
category="marketplace",
|
|
),
|
|
PermissionDefinition(
|
|
id="marketplace.manage_integration",
|
|
label_key="marketplace.permissions.manage_integration",
|
|
description_key="marketplace.permissions.manage_integration_desc",
|
|
category="marketplace",
|
|
),
|
|
PermissionDefinition(
|
|
id="marketplace.sync_products",
|
|
label_key="marketplace.permissions.sync_products",
|
|
description_key="marketplace.permissions.sync_products_desc",
|
|
category="marketplace",
|
|
),
|
|
],
|
|
menu_items={
|
|
FrontendType.ADMIN: [
|
|
"marketplace-letzshop", # Marketplace monitoring
|
|
],
|
|
FrontendType.VENDOR: [
|
|
"marketplace", # Vendor marketplace settings
|
|
"letzshop", # Letzshop integration
|
|
],
|
|
},
|
|
# New module-driven menu definitions
|
|
menus={
|
|
FrontendType.ADMIN: [
|
|
MenuSectionDefinition(
|
|
id="marketplace",
|
|
label_key="marketplace.menu.marketplace",
|
|
icon="shopping-cart",
|
|
order=60,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="marketplace-letzshop",
|
|
label_key="marketplace.menu.letzshop",
|
|
icon="shopping-cart",
|
|
route="/admin/marketplace/letzshop",
|
|
order=10,
|
|
),
|
|
],
|
|
),
|
|
],
|
|
FrontendType.VENDOR: [
|
|
MenuSectionDefinition(
|
|
id="products",
|
|
label_key="marketplace.menu.products_inventory",
|
|
icon="download",
|
|
order=10,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="marketplace",
|
|
label_key="marketplace.menu.marketplace_import",
|
|
icon="download",
|
|
route="/vendor/{vendor_code}/marketplace",
|
|
order=30,
|
|
),
|
|
],
|
|
),
|
|
MenuSectionDefinition(
|
|
id="sales",
|
|
label_key="marketplace.menu.sales_orders",
|
|
icon="external-link",
|
|
order=20,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="letzshop",
|
|
label_key="marketplace.menu.letzshop_orders",
|
|
icon="external-link",
|
|
route="/vendor/{vendor_code}/letzshop",
|
|
order=20,
|
|
),
|
|
],
|
|
),
|
|
],
|
|
},
|
|
is_core=False,
|
|
# =========================================================================
|
|
# Self-Contained Module Configuration
|
|
# =========================================================================
|
|
is_self_contained=True,
|
|
services_path="app.modules.marketplace.services",
|
|
models_path="app.modules.marketplace.models",
|
|
schemas_path="app.modules.marketplace.schemas",
|
|
exceptions_path="app.modules.marketplace.exceptions",
|
|
tasks_path="app.modules.marketplace.tasks",
|
|
# =========================================================================
|
|
# Scheduled Tasks
|
|
# =========================================================================
|
|
scheduled_tasks=[
|
|
ScheduledTask(
|
|
name="marketplace.sync_vendor_directory",
|
|
task="app.modules.marketplace.tasks.sync_tasks.sync_vendor_directory",
|
|
schedule="0 2 * * *", # Daily at 02:00
|
|
options={"queue": "scheduled"},
|
|
),
|
|
],
|
|
)
|
|
|
|
|
|
def get_marketplace_module_with_routers() -> ModuleDefinition:
|
|
"""
|
|
Get marketplace module with routers attached.
|
|
|
|
This function attaches the routers lazily to avoid circular imports
|
|
during module initialization.
|
|
"""
|
|
marketplace_module.admin_router = _get_admin_router()
|
|
marketplace_module.vendor_router = _get_vendor_router()
|
|
return marketplace_module
|
|
|
|
|
|
__all__ = ["marketplace_module", "get_marketplace_module_with_routers"]
|