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 = "inspections" MODULE_NAME = "Inspections" MODULE_VERSION = "0.1.19" READ_SCOPE = "inspections:workspace:read" WRITE_SCOPE = "inspections:workspace:write" ADMIN_SCOPE = "inspections:workspace:admin" OPTIONAL_DEPENDENCIES = ( "permits", "facilities", "grants", "assets", "files", "forms_runtime", "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="Inspections", level="tenant", module_id=module_id, resource=resource, action=action, ) PERMISSIONS = ( _permission(READ_SCOPE, "View inspections workspace", "Read inspections records, configuration, and workflow context."), _permission(WRITE_SCOPE, "Manage inspections workspace", "Create and update inspections records and workflow state."), _permission(ADMIN_SCOPE, "Administer inspections workspace", "Configure inspections policies, templates, and tenant-level administration."), ) ROLE_TEMPLATES = ( RoleTemplate( slug="inspections_manager", name="Inspections manager", description="Manage inspections records and workflow state.", permissions=(READ_SCOPE, WRITE_SCOPE), ), RoleTemplate( slug="inspections_viewer", name="Inspections viewer", description="Read inspections records and workflow context.", permissions=(READ_SCOPE,), ), ) DOCUMENTATION = ( DocumentationTopic( id=f"{MODULE_ID}.module-boundary", title=f"{MODULE_NAME} module boundary", summary="Inspection workflows for site visits, checklists, findings, measures, deadlines, evidence, and re-inspections.", 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 Inspections", "summary": "Prüfabläufe für Ortsbesuche, Checklisten, Feststellungen, Maßnahmen, Fristen, Nachweise und Wiederholungsprüfungen.", "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-inspections/docs/INSPECTIONS_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": ['inspection plans', 'site visits', 'checklists', 'findings', 'corrective measures', 'deadlines', 're-inspection links'], "first_slice": "Define inspection type, visit, checklist, finding, measure, deadline, evidence, and re-inspection concepts.", }, ), ) 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="domain_capability", kind="domain", maturity="scaffold", documentation_ref="docs/INSPECTIONS_DOMAIN_BOUNDARY.md", known_limits=("Inspection planning, findings, measures, and follow-up are not implemented yet.",), owned_concepts=("inspection", "inspection finding", "inspection measure"), non_owned_concepts=("risk control", "case", "facility"), ), ) def get_manifest() -> ModuleManifest: return manifest