from __future__ import annotations from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER from govoplan_core.core.modules import DocumentationLink, DocumentationTopic, ModuleManifest, PermissionDefinition, RoleTemplate from govoplan_core.core.provider_governance import declared_module_architecture MODULE_ID = "helpdesk" MODULE_NAME = "Helpdesk" MODULE_VERSION = "0.1.19" READ_SCOPE = "helpdesk:workspace:read" WRITE_SCOPE = "helpdesk:workspace:write" ADMIN_SCOPE = "helpdesk:workspace:admin" OPTIONAL_DEPENDENCIES = ( "tickets", "assets", "facilities", "mail", "notifications", "workflow_engine", "files", "tasks", ) def _permission(scope: str, label: str, description: str) -> PermissionDefinition: module_id, resource, action = scope.split(":", 2) return PermissionDefinition( scope=scope, label=label, description=description, category="Helpdesk", level="tenant", module_id=module_id, resource=resource, action=action, ) PERMISSIONS = ( _permission(READ_SCOPE, "View helpdesk workspace", "Read helpdesk records, configuration, and workflow context."), _permission(WRITE_SCOPE, "Manage helpdesk workspace", "Create and update helpdesk records and workflow state."), _permission(ADMIN_SCOPE, "Administer helpdesk workspace", "Configure helpdesk policies, templates, and tenant-level administration."), ) ROLE_TEMPLATES = ( RoleTemplate( slug="helpdesk_manager", name="Helpdesk manager", description="Manage helpdesk records and workflow state.", permissions=(READ_SCOPE, WRITE_SCOPE), ), RoleTemplate( slug="helpdesk_viewer", name="Helpdesk viewer", description="Read helpdesk records and workflow context.", permissions=(READ_SCOPE,), ), ) DOCUMENTATION = ( DocumentationTopic( id=f"{MODULE_ID}.module-boundary", title=f"{MODULE_NAME} module boundary", summary="Internal service desk workflows for IT, facilities, HR, finance, procurement, access requests, assignment, escalation, and resolution tracking.", body=( "This repository is currently a platform module seed. It registers the domain boundary, " "permission surface, role templates, and documentation metadata before runtime APIs, " "database models, migrations, and WebUI routes are introduced." ), layer="available", documentation_types=("admin", "user"), audience=("user", "operator", "module_admin", "product_owner"), translations={ "de": { "title": "Modulgrenze von Helpdesk", "summary": "Interne Servicedesk-Abläufe für IT, Gebäudemanagement, Personal, Finanzen, Beschaffung, Zugriffsanfragen, Zuordnung, Eskalation und Lösungsnachverfolgung.", "body": "Dieses Repository ist derzeit ein Grundgerüst für ein Plattformmodul. Es registriert die Fachgrenze, Berechtigungsoberfläche, Rollenvorlagen und Dokumentationsmetadaten, bevor Laufzeit-APIs, Datenbankmodelle, Migrationen und WebUI-Routen eingeführt werden.", } }, order=100, related_modules=OPTIONAL_DEPENDENCIES, links=( DocumentationLink( label="Repository domain boundary", href="govoplan-helpdesk/docs/HELPDESK_DOMAIN_BOUNDARY.md", kind="repository", ), ), metadata={ "kind": "reference", "seed": True, "consequence_classes": { "seed_boundary": "Declares ownership and permissions only; no runtime workflow is available yet.", }, "domain_objects": ['internal support tickets', 'service categories', 'assignment and escalation state', 'resolution records', 'SLA-facing timestamps'], "first_slice": ( "Define Helpdesk queue, SLA, and escalation profiles over the " "canonical Tickets model without introducing duplicate ticket storage." ), }, ), ) manifest = ModuleManifest( id=MODULE_ID, name=MODULE_NAME, version=MODULE_VERSION, dependencies=("access",), optional_dependencies=OPTIONAL_DEPENDENCIES, required_capabilities=(CAPABILITY_AUTH_PRINCIPAL_RESOLVER, CAPABILITY_AUTH_PERMISSION_EVALUATOR), permissions=PERMISSIONS, role_templates=ROLE_TEMPLATES, documentation=DOCUMENTATION, architecture=declared_module_architecture( layer="human_work_procedure", kind="domain", maturity="scaffold", documentation_ref="docs/HELPDESK_DOMAIN_BOUNDARY.md", known_limits=("Helpdesk intake, queue, SLA, and resolution lifecycles are not implemented yet.",), owned_concepts=("helpdesk request", "service queue", "resolution"), non_owned_concepts=("case", "project work item", "mailbox message"), ), ) def get_manifest() -> ModuleManifest: return manifest