astrbot_plugin_imagestudio/backend/route_registry.py

376 行
23 KiB
Python

"""Route registry manifest for AstrBot Web API mounting."""
from __future__ import annotations
from dataclasses import dataclass
from typing import Any
PERMISSION_MATRIX: dict[str, dict[str, Any]] = {
"read": {"auth_required": True, "required_permission": None, "description": "authenticated read"},
"write": {"auth_required": True, "required_permission": "can_write", "description": "profile/workflow write"},
"config": {
"auth_required": True,
"required_permission": "can_manage_config",
"description": "configuration management",
},
"materials": {
"auth_required": True,
"required_permission": "can_manage_materials",
"description": "material library management",
},
"retry": {
"auth_required": True,
"required_permission": "can_retry_tasks",
"required_permissions": ["can_write", "can_retry_tasks"],
"description": "task retry management (write + retry capabilities)",
},
"public_token": {"auth_required": False, "required_permission": None, "description": "signed public token"},
}
@dataclass(frozen=True)
class RouteSpec:
method: str
endpoint: str
handler: str
permission: str
def to_dict(self) -> dict[str, Any]:
matrix = permission_requirement(self.permission)
return {
"method": self.method,
"endpoint": self.endpoint,
"handler": self.handler,
"permission": self.permission,
"auth_required": matrix["auth_required"],
"required_permission": matrix["required_permission"],
"required_permissions": list(
matrix.get("required_permissions")
or ([matrix["required_permission"]] if matrix["required_permission"] else [])
),
}
ROUTES: tuple[RouteSpec, ...] = (
RouteSpec("GET", "ui/bootstrap", "backend.routes.ui_routes.get_ui_bootstrap", "read"),
RouteSpec("GET", "ui/actions", "backend.routes.ui_routes.get_ui_actions", "read"),
RouteSpec("GET", "contract", "backend.routes.contract_routes.get_api_contract", "read"),
RouteSpec("GET", "dashboard/summary", "backend.routes.dashboard_routes.get_dashboard_summary", "read"),
RouteSpec("GET", "profiles", "backend.routes.profile_routes.list_profiles", "read"),
RouteSpec("POST", "profiles", "backend.routes.profile_routes.create_profile", "write"),
RouteSpec("POST", "profiles/quick-draft", "backend.routes.profile_routes.create_quick_profile_draft", "read"),
RouteSpec("POST", "profiles/quick-draft/from-document", "backend.routes.profile_routes.import_profile_document", "read"),
RouteSpec("POST", "profiles/quick-draft/save", "backend.routes.profile_routes.save_quick_profile_draft", "write"),
RouteSpec("GET", "profiles/{profile_id}", "backend.routes.profile_routes.get_profile", "read"),
RouteSpec("PUT", "profiles/{profile_id}", "backend.routes.profile_routes.update_profile", "write"),
RouteSpec("DELETE", "profiles/{profile_id}", "backend.routes.profile_routes.delete_profile", "write"),
RouteSpec("POST", "profiles/{profile_id}/archive", "backend.routes.profile_routes.archive_profile", "write"),
RouteSpec("GET", "profiles/{profile_id}/workflows", "backend.routes.workflow_routes.list_profile_workflows", "read"),
RouteSpec("POST", "profiles/{profile_id}/workflows", "backend.routes.workflow_routes.create_profile_workflow", "write"),
RouteSpec("GET", "profiles/{profile_id}/profile-cards", "backend.routes.profile_card_routes.list_profile_cards", "read"),
RouteSpec("GET", "workflows/{workflow_id}", "backend.routes.workflow_routes.get_workflow", "read"),
RouteSpec("PUT", "workflows/{workflow_id}", "backend.routes.workflow_routes.update_workflow", "write"),
RouteSpec("POST", "workflows/{workflow_id}/start", "backend.routes.workflow_routes.start_workflow", "write"),
RouteSpec("POST", "workflows/{workflow_id}/cancel", "backend.routes.workflow_routes.cancel_workflow", "write"),
RouteSpec("POST", "workflows/{workflow_id}/archive", "backend.routes.workflow_routes.archive_workflow", "write"),
RouteSpec("POST", "workflows/{workflow_id}/execute-character", "backend.routes.workflow_routes.execute_character_workflow", "write"),
RouteSpec("POST", "workflows/{workflow_id}/finalize-card", "backend.routes.profile_card_routes.finalize_profile_card", "write"),
RouteSpec("GET", "workflows/{workflow_id}/nodes", "backend.routes.node_routes.list_workflow_nodes", "read"),
RouteSpec("POST", "workflows/{workflow_id}/nodes", "backend.routes.node_routes.create_workflow_node", "write"),
RouteSpec("GET", "workflows/{workflow_id}/branches", "backend.routes.branch_routes.list_workflow_branches", "read"),
RouteSpec("POST", "workflows/{workflow_id}/branches", "backend.routes.branch_routes.create_workflow_branch", "write"),
RouteSpec("POST", "workflows/{workflow_id}/switch-branch", "backend.routes.branch_routes.switch_workflow_branch", "write"),
RouteSpec("GET", "workflows/{workflow_id}/history", "backend.routes.history_routes.list_workflow_history", "read"),
RouteSpec("POST", "workflows/{workflow_id}/history", "backend.routes.history_routes.save_workflow_history", "write"),
RouteSpec("GET", "nodes/{node_id}", "backend.routes.node_routes.get_node", "read"),
RouteSpec("GET", "nodes/{node_id}/dependency-context", "backend.routes.node_routes.get_node_dependency_context", "read"),
RouteSpec("GET", "nodes/{node_id}/material-bindings", "backend.routes.node_material_routes.get_node_material_bindings", "read"),
RouteSpec("PUT", "nodes/{node_id}/material-bindings", "backend.routes.node_material_routes.save_node_material_bindings", "write"),
RouteSpec("GET", "nodes/{node_id}/rounds", "backend.routes.round_routes.list_node_rounds", "read"),
RouteSpec("POST", "nodes/{node_id}/rounds", "backend.routes.round_routes.create_node_round", "write"),
RouteSpec("GET", "rounds/{round_id}", "backend.routes.round_routes.get_round", "read"),
RouteSpec("POST", "rounds/{round_id}/feedback", "backend.routes.round_routes.update_round_feedback", "write"),
RouteSpec("POST", "rounds/{round_id}/next", "backend.routes.round_routes.create_next_round", "write"),
RouteSpec("POST", "rounds/{round_id}/confirm", "backend.routes.round_routes.confirm_round_candidate", "write"),
RouteSpec(
"POST",
"rounds/{round_id}/generation-cross-review",
"backend.routes.generation_cross_review_routes.decide_generation_cross_review",
"write",
),
RouteSpec(
"POST",
"rounds/{round_id}/generation-cross-review/regenerate",
"backend.routes.generation_cross_review_routes.regenerate_generation_cross_review",
"write",
),
RouteSpec(
"POST",
"rounds/{round_id}/generation-cross-review/approve",
"backend.routes.generation_cross_review_routes.approve_generation_cross_review",
"write",
),
RouteSpec("PUT", "nodes/{node_id}", "backend.routes.node_routes.update_node", "write"),
RouteSpec("POST", "nodes/{node_id}/generate", "backend.routes.node_routes.generate_node", "write"),
RouteSpec("POST", "nodes/{node_id}/retry", "backend.routes.node_routes.retry_node", "retry"),
RouteSpec("POST", "nodes/{node_id}/complete", "backend.routes.node_routes.mark_node_completed", "write"),
RouteSpec("POST", "nodes/{node_id}/mark-completed", "backend.routes.node_routes.mark_node_completed", "write"),
RouteSpec("POST", "nodes/{node_id}/select-image", "backend.routes.node_routes.select_node_image", "write"),
RouteSpec("POST", "nodes/{node_id}/adopt-image", "backend.routes.history_routes.adopt_node_image", "write"),
RouteSpec("GET", "review/policy", "backend.routes.review_routes.get_review_policy", "read"),
RouteSpec("POST", "review/policy/validate", "backend.routes.review_routes.validate_review_policy", "config"),
RouteSpec("POST", "review/policy/save", "backend.routes.review_routes.save_review_policy", "config"),
RouteSpec("POST", "prompts/expand", "backend.routes.prompt_routes.expand_prompt", "read"),
RouteSpec("POST", "prompts/governance-preview", "backend.routes.prompt_routes.preview_prompt_governance", "read"),
RouteSpec("GET", "nodes/{node_id}/review", "backend.routes.review_routes.review_node", "read"),
RouteSpec("GET", "nodes/{node_id}/images", "backend.routes.image_routes.list_node_images", "read"),
RouteSpec("GET", "workflows/{workflow_id}/review", "backend.routes.review_routes.review_workflow", "read"),
RouteSpec("GET", "images", "backend.routes.image_routes.list_images", "read"),
RouteSpec("GET", "images/{image_id}", "backend.routes.image_routes.get_image", "read"),
RouteSpec("POST", "images/{image_id}/select", "backend.routes.image_routes.select_image", "write"),
RouteSpec("POST", "images/{image_id}/unselect", "backend.routes.image_routes.unselect_image", "write"),
RouteSpec("POST", "images/{image_id}/archive", "backend.routes.image_routes.archive_image", "write"),
RouteSpec("POST", "images/{image_id}/moderation-review", "backend.routes.image_routes.review_moderated_image", "materials"),
RouteSpec("POST", "images/{image_id}/safe-delete", "backend.routes.image_routes.safe_delete_image", "write"),
RouteSpec("DELETE", "images/{image_id}", "backend.routes.image_routes.delete_image", "write"),
RouteSpec("GET", "profile-cards/{card_id}", "backend.routes.profile_card_routes.get_profile_card", "read"),
RouteSpec("GET", "jobs", "backend.routes.job_routes.list_jobs", "read"),
RouteSpec("GET", "jobs/{task_id}", "backend.routes.job_routes.get_job", "read"),
RouteSpec("DELETE", "jobs/{task_id}", "backend.routes.job_routes.delete_job", "retry"),
RouteSpec("POST", "jobs/{task_id}/cancel", "backend.routes.job_routes.cancel_job", "write"),
RouteSpec("POST", "jobs/{task_id}/retry", "backend.routes.job_routes.retry_job", "retry"),
RouteSpec("POST", "jobs/failed/retry", "backend.routes.job_routes.retry_failed_jobs", "retry"),
RouteSpec("POST", "jobs/failed/clear", "backend.routes.job_routes.clear_failed_jobs", "retry"),
RouteSpec("POST", "jobs/terminal/clear", "backend.routes.job_routes.clear_terminal_jobs", "retry"),
RouteSpec("POST", "jobs/dead-letter/retry", "backend.routes.job_routes.retry_dead_letter_jobs", "retry"),
RouteSpec("POST", "jobs/dead-letter/move-failed", "backend.routes.job_routes.move_failed_jobs_to_dead_letter", "retry"),
RouteSpec("GET", "costs/usage", "backend.routes.cost_routes.get_cost_usage", "read"),
RouteSpec("POST", "costs/guard", "backend.routes.cost_routes.check_cost_guard", "read"),
RouteSpec("GET", "models/runtime", "backend.routes.model_runtime_routes.list_runtime_models", "read"),
RouteSpec("GET", "settings/schema", "backend.routes.settings_routes.get_settings_schema", "read"),
RouteSpec("GET", "settings/current", "backend.routes.settings_routes.get_current_settings", "read"),
RouteSpec("POST", "settings/validate", "backend.routes.settings_routes.validate_settings", "config"),
RouteSpec("POST", "settings/diff", "backend.routes.settings_routes.diff_settings", "config"),
RouteSpec("POST", "settings/save", "backend.routes.settings_routes.save_settings", "config"),
RouteSpec("POST", "settings/reload", "backend.routes.settings_routes.reload_settings", "config"),
RouteSpec("GET", "settings/export", "backend.routes.settings_routes.export_settings", "config"),
RouteSpec("POST", "settings/import", "backend.routes.settings_routes.import_settings", "config"),
RouteSpec("GET", "settings/snapshots", "backend.routes.settings_routes.list_settings_snapshots", "config"),
RouteSpec("GET", "settings/snapshots/{snapshot_id}", "backend.routes.settings_routes.get_settings_snapshot", "config"),
RouteSpec("POST", "settings/rollback", "backend.routes.settings_routes.rollback_settings", "config"),
RouteSpec("GET", "backups", "backend.routes.data_backup_routes.list_backups", "config"),
RouteSpec("POST", "backups", "backend.routes.data_backup_routes.create_backup", "config"),
RouteSpec("GET", "backups/{backup_id}", "backend.routes.data_backup_routes.inspect_backup", "config"),
RouteSpec("POST", "backups/{backup_id}/restore", "backend.routes.data_backup_routes.restore_backup", "config"),
RouteSpec("GET", "storage/status", "backend.routes.storage_routes.get_storage_status", "read"),
RouteSpec("POST", "storage/migrate", "backend.routes.storage_routes.migrate_storage", "config"),
RouteSpec("GET", "media/sign", "backend.routes.media_routes.sign_media", "read"),
RouteSpec("GET", "media/index", "backend.routes.media_routes.index_media", "read"),
RouteSpec("GET", "media/orphans", "backend.routes.media_routes.scan_orphan_media", "read"),
RouteSpec("GET", "media/payload", "backend.routes.media_routes.fetch_media_payload", "read"),
RouteSpec("GET", "media/fetch", "backend.routes.media_routes.fetch_media", "public_token"),
RouteSpec(
"GET",
"advanced-material-imports",
"backend.routes.advanced_material_routes.list_advanced_material_imports",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/upload",
"backend.routes.advanced_material_routes.upload_advanced_material",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/style-set/upload",
"backend.routes.advanced_material_routes.upload_advanced_style_set",
"materials",
),
RouteSpec(
"GET",
"advanced-material-imports/{import_id}",
"backend.routes.advanced_material_routes.get_advanced_material_import",
"materials",
),
RouteSpec(
"DELETE",
"advanced-material-imports/{import_id}",
"backend.routes.advanced_material_routes.delete_advanced_material_import",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/retry",
"backend.routes.advanced_material_routes.retry_advanced_material_import",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/style-sources/{source_id}/retry",
"backend.routes.advanced_material_routes.retry_advanced_style_source",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/style-sources/{source_id}/exclude",
"backend.routes.advanced_material_routes.exclude_advanced_style_source",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/style-consensus",
"backend.routes.advanced_material_routes.create_advanced_style_consensus",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/style-validation-cases/{case_id}/retry",
"backend.routes.advanced_material_routes.retry_advanced_style_validation_case",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/cancel",
"backend.routes.advanced_material_routes.cancel_advanced_material_import",
"materials",
),
RouteSpec(
"GET",
"advanced-material-imports/{import_id}/validation-attempts",
"backend.routes.advanced_material_routes.list_advanced_material_attempts",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/validation-attempts",
"backend.routes.advanced_material_routes.create_advanced_material_attempt",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/attempts/{attempt_id}/reject",
"backend.routes.advanced_material_routes.reject_advanced_material_attempt",
"materials",
),
RouteSpec(
"POST",
"advanced-material-imports/{import_id}/attempts/{attempt_id}/accept",
"backend.routes.advanced_material_routes.accept_advanced_material_attempt",
"materials",
),
RouteSpec("GET", "advanced-materials", "backend.routes.advanced_material_routes.list_advanced_materials", "read"),
RouteSpec(
"GET",
"advanced-materials/{material_id}",
"backend.routes.advanced_material_routes.get_advanced_material",
"read",
),
RouteSpec(
"DELETE",
"advanced-materials/{material_id}",
"backend.routes.advanced_material_routes.archive_advanced_material",
"materials",
),
RouteSpec("GET", "material-catalog", "backend.routes.advanced_material_routes.list_material_catalog", "read"),
RouteSpec("GET", "material-categories", "backend.routes.material_routes.list_material_categories", "read"),
RouteSpec("POST", "material-categories", "backend.routes.material_routes.create_material_category", "materials"),
RouteSpec(
"PUT",
"material-categories/{category_id}",
"backend.routes.material_routes.update_material_category",
"materials",
),
RouteSpec(
"DELETE",
"material-categories/{category_id}",
"backend.routes.material_routes.delete_material_category",
"materials",
),
RouteSpec("GET", "materials", "backend.routes.material_routes.list_materials", "read"),
RouteSpec("GET", "materials/analytics", "backend.routes.material_routes.material_analytics", "read"),
RouteSpec("POST", "materials", "backend.routes.material_routes.create_material", "materials"),
RouteSpec("POST", "materials/upload", "backend.routes.material_routes.upload_material", "materials"),
RouteSpec("POST", "materials/renormalize-batch", "backend.routes.material_routes.renormalize_materials_batch", "materials"),
RouteSpec("GET", "materials/{material_id}", "backend.routes.material_routes.get_material", "read"),
RouteSpec("PUT", "materials/{material_id}", "backend.routes.material_routes.update_material", "materials"),
RouteSpec("DELETE", "materials/{material_id}", "backend.routes.material_routes.delete_material", "materials"),
RouteSpec("POST", "materials/{material_id}/recognize", "backend.routes.material_routes.recognize_material", "materials"),
RouteSpec("POST", "materials/{material_id}/re-recognize", "backend.routes.material_routes.re_recognize_material", "materials"),
RouteSpec("POST", "materials/{material_id}/renormalize", "backend.routes.material_routes.renormalize_material", "materials"),
RouteSpec("POST", "materials/{material_id}/confirm", "backend.routes.material_routes.confirm_material", "materials"),
RouteSpec("POST", "assets/import-pack", "backend.routes.asset_routes.import_asset_pack", "materials"),
RouteSpec("GET", "profiles/{profile_id}/wardrobe", "backend.routes.wardrobe_routes.list_wardrobe_items", "read"),
RouteSpec("POST", "profiles/{profile_id}/wardrobe/import-material", "backend.routes.wardrobe_routes.import_wardrobe_material", "materials"),
RouteSpec("POST", "profiles/{profile_id}/wardrobe/items", "backend.routes.wardrobe_routes.import_wardrobe_material", "materials"),
RouteSpec(
"DELETE",
"profiles/{profile_id}/wardrobe/{wardrobe_item_id}",
"backend.routes.wardrobe_routes.delete_wardrobe_item",
"materials",
),
RouteSpec(
"DELETE",
"profiles/{profile_id}/wardrobe/items/{wardrobe_item_id}",
"backend.routes.wardrobe_routes.delete_wardrobe_item",
"materials",
),
RouteSpec("POST", "profiles/{profile_id}/wardrobe/match", "backend.routes.wardrobe_routes.match_wardrobe", "read"),
RouteSpec("GET", "profiles/{profile_id}/wardrobe-templates", "backend.routes.wardrobe_routes.list_wardrobe_templates", "read"),
RouteSpec("POST", "profiles/{profile_id}/wardrobe-templates", "backend.routes.wardrobe_routes.save_wardrobe_template", "materials"),
RouteSpec("POST", "profiles/{profile_id}/wardrobe-templates/{template_id}/apply", "backend.routes.wardrobe_routes.apply_wardrobe_template", "read"),
RouteSpec("DELETE", "profiles/{profile_id}/wardrobe-templates/{template_id}", "backend.routes.wardrobe_routes.delete_wardrobe_template", "materials"),
RouteSpec("POST", "integrations/private-companion/daily-outfit", "backend.routes.integration_routes.private_companion_daily_outfit", "read"),
RouteSpec("GET", "integrations/private-companion/token", "backend.routes.integration_routes.get_private_companion_token_status", "config"),
RouteSpec("POST", "integrations/private-companion/token/rotate", "backend.routes.integration_routes.rotate_private_companion_token", "config"),
RouteSpec("GET", "integrations/logs", "backend.routes.integration_routes.list_integration_logs", "read"),
RouteSpec("GET", "logs/generation", "backend.routes.log_routes.get_generation_logs", "read"),
RouteSpec("GET", "logs/workflows", "backend.routes.log_routes.get_workflow_logs", "read"),
RouteSpec("GET", "logs/errors", "backend.routes.log_routes.get_error_logs", "read"),
RouteSpec("GET", "logs/integrations", "backend.routes.log_routes.get_integration_logs", "read"),
RouteSpec("GET", "security/audit-logs", "backend.routes.log_routes.get_audit_logs", "config"),
RouteSpec("GET", "events/stream", "backend.routes.event_routes.get_event_stream", "read"),
RouteSpec("GET", "api-discovery/dialects", "backend.routes.api_discovery_routes.list_dialects", "read"),
RouteSpec("POST", "api-discovery/probe-provider", "backend.routes.api_discovery_routes.probe_provider", "config"),
RouteSpec("POST", "api-discovery/probe-model", "backend.routes.api_discovery_routes.probe_model", "config"),
RouteSpec("GET", "api-discovery/capabilities", "backend.routes.api_discovery_routes.list_capabilities", "read"),
RouteSpec("POST", "api-discovery/manual-override", "backend.routes.api_discovery_routes.manual_override", "config"),
RouteSpec("POST", "api-discovery/validate-render-plan", "backend.routes.api_discovery_routes.validate_render_plan", "read"),
RouteSpec("GET", "web/manifest", "backend.routes.web_routes.get_web_manifest", "read"),
)
def route_manifest() -> list[dict[str, Any]]:
return [route.to_dict() for route in ROUTES]
def permission_requirement(permission: str) -> dict[str, Any]:
normalized = str(permission or "").strip()
return dict(PERMISSION_MATRIX.get(normalized) or {"auth_required": True, "required_permission": normalized})
def permission_matrix() -> list[dict[str, Any]]:
return [
{
"permission": permission,
**definition,
"route_count": sum(1 for route in ROUTES if route.permission == permission),
}
for permission, definition in sorted(PERMISSION_MATRIX.items())
]
def assert_unique_routes() -> None:
seen: set[tuple[str, str]] = set()
for route in ROUTES:
key = (route.method, route.endpoint)
if key in seen:
raise RuntimeError(f"duplicate route: {route.method} {route.endpoint}")
seen.add(key)
def assert_known_permissions() -> None:
unknown = sorted({route.permission for route in ROUTES if route.permission not in PERMISSION_MATRIX})
if unknown:
raise RuntimeError(f"unknown route permissions: {', '.join(unknown)}")