Samir Boulahtit
1a52611438
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>
73 lines
2.3 KiB
Python
73 lines
2.3 KiB
Python
# app/modules/billing/definition.py
|
|
"""
|
|
Billing module definition.
|
|
|
|
Defines the billing 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.billing.routes.admin import admin_router
|
|
|
|
return admin_router
|
|
|
|
|
|
def _get_vendor_router():
|
|
"""Lazy import of vendor router to avoid circular imports."""
|
|
from app.modules.billing.routes.vendor import vendor_router
|
|
|
|
return vendor_router
|
|
|
|
|
|
# Billing module definition
|
|
billing_module = ModuleDefinition(
|
|
code="billing",
|
|
name="Billing & Subscriptions",
|
|
description=(
|
|
"Platform subscription management, vendor billing, and invoice history. "
|
|
"Uses the payments module for actual payment processing."
|
|
),
|
|
version="1.0.0",
|
|
requires=["payments"], # Depends on payments module for payment processing
|
|
features=[
|
|
"subscription_management", # Manage subscription tiers
|
|
"billing_history", # View invoices and payment history
|
|
"invoice_generation", # Generate and download invoices
|
|
"subscription_analytics", # Subscription stats and metrics
|
|
"trial_management", # Manage vendor trial periods
|
|
"limit_overrides", # Override tier limits per vendor
|
|
],
|
|
menu_items={
|
|
FrontendType.ADMIN: [
|
|
"subscription-tiers", # Manage tier definitions
|
|
"subscriptions", # View/manage vendor subscriptions
|
|
"billing-history", # View all invoices
|
|
],
|
|
FrontendType.VENDOR: [
|
|
"billing", # Vendor billing dashboard
|
|
"invoices", # Vendor invoice history
|
|
],
|
|
},
|
|
is_core=False, # Billing can be disabled (e.g., internal platforms)
|
|
)
|
|
|
|
|
|
def get_billing_module_with_routers() -> ModuleDefinition:
|
|
"""
|
|
Get billing module with routers attached.
|
|
|
|
This function attaches the routers lazily to avoid circular imports
|
|
during module initialization.
|
|
"""
|
|
billing_module.admin_router = _get_admin_router()
|
|
billing_module.vendor_router = _get_vendor_router()
|
|
return billing_module
|
|
|
|
|
|
__all__ = ["billing_module", "get_billing_module_with_routers"]
|