102 lines
3.6 KiB
Python
102 lines
3.6 KiB
Python
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
|
|
|
|
MODULE_ID = "consultation"
|
|
MODULE_NAME = "Consultation"
|
|
MODULE_VERSION = "0.1.7"
|
|
READ_SCOPE = "consultation:workspace:read"
|
|
WRITE_SCOPE = "consultation:workspace:write"
|
|
ADMIN_SCOPE = "consultation:workspace:admin"
|
|
OPTIONAL_DEPENDENCIES = (
|
|
"portal",
|
|
"forms-runtime",
|
|
"files",
|
|
"records",
|
|
"transparency",
|
|
"reporting",
|
|
)
|
|
|
|
|
|
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="Consultation",
|
|
level="tenant",
|
|
module_id=module_id,
|
|
resource=resource,
|
|
action=action,
|
|
)
|
|
|
|
|
|
PERMISSIONS = (
|
|
_permission(READ_SCOPE, "View consultation workspace", "Read consultation records, configuration, and workflow context."),
|
|
_permission(WRITE_SCOPE, "Manage consultation workspace", "Create and update consultation records and workflow state."),
|
|
_permission(ADMIN_SCOPE, "Administer consultation workspace", "Configure consultation policies, templates, and tenant-level administration."),
|
|
)
|
|
|
|
ROLE_TEMPLATES = (
|
|
RoleTemplate(
|
|
slug="consultation_manager",
|
|
name="Consultation manager",
|
|
description="Manage consultation records and workflow state.",
|
|
permissions=(READ_SCOPE, WRITE_SCOPE),
|
|
),
|
|
RoleTemplate(
|
|
slug="consultation_viewer",
|
|
name="Consultation viewer",
|
|
description="Read consultation records and workflow context.",
|
|
permissions=(READ_SCOPE,),
|
|
),
|
|
)
|
|
|
|
DOCUMENTATION = (
|
|
DocumentationTopic(
|
|
id=f"{MODULE_ID}.module-boundary",
|
|
title=f"{MODULE_NAME} module boundary",
|
|
summary="Public consultations, hearings, stakeholder feedback, formal comments, response matrices, and publication of results.",
|
|
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",),
|
|
audience=("operator", "module_admin", "product_owner"),
|
|
order=100,
|
|
related_modules=OPTIONAL_DEPENDENCIES,
|
|
links=(
|
|
DocumentationLink(
|
|
label="Repository domain boundary",
|
|
href="govoplan-consultation/docs/CONSULTATION_DOMAIN_BOUNDARY.md",
|
|
kind="repository",
|
|
),
|
|
),
|
|
metadata={
|
|
"seed": True,
|
|
"domain_objects": ['consultation processes', 'hearing events', 'stakeholder feedback', 'formal comments', 'response matrices', 'publication state'],
|
|
"first_slice": "Define consultation, phase, stakeholder, comment, response, publication, and record-link 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,
|
|
)
|
|
|
|
|
|
def get_manifest() -> ModuleManifest:
|
|
return manifest
|