{escape(revision.content_text or '')}"
+ rendered = [
+ _substitute(body, _render_context(request.parameters, item, index), html=True)
+ for index, item in enumerate(items)
+ ]
+ page_count = _page_count(revision, len(items))
+ document = _html_document(definition, revision, rendered)
+ return document.encode("utf-8"), "text/html; charset=utf-8", page_count
+
+
+def _html_document(
+ definition: TemplateDefinition,
+ revision: TemplateRevision,
+ rendered: Sequence[str],
+) -> str:
+ page_size = _page_size(revision.layout.get("page_size") or _profile_page_size(revision))
+ margin = _millimetres(revision.layout.get("margin_mm"), 15.0, minimum=0, maximum=60)
+ template_type = revision.template_type
+ if template_type == "label_sheet":
+ columns = _integer(revision.layout.get("columns"), 3, minimum=1, maximum=12)
+ rows = _integer(revision.layout.get("rows"), 8, minimum=1, maximum=30)
+ gap = _millimetres(revision.layout.get("gap_mm"), 2.0, minimum=0, maximum=20)
+ per_page = columns * rows
+ pages = []
+ for start in range(0, len(rendered), per_page):
+ labels = "".join(f'Hello {{name}}
{{postal.address}}
", +) -> TemplateCreateRequest: + return TemplateCreateRequest.model_validate( + { + "name": name, + "template_type": template_type, + "usages": ["campaign.postal"], + "locale": "de-DE", + "required_fields": [ + {"path": "name", "value_type": "string", "required": True}, + {"path": "postal.address", "value_type": "string", "required": True}, + ], + "content_html": body, + "layout": { + "page_size": "A4", + "margin_mm": 15, + "columns": 2, + "rows": 2, + }, + } + ) + + +class _Registry: + def __init__(self, capability=None) -> None: + self._capability = capability + + def has_capability(self, name: str) -> bool: + return self._capability is not None and name == "files.artifact_store" + + def capability(self, name: str): + return self._capability if name == "files.artifact_store" else None + + +class _ArtifactStore: + def __init__(self) -> None: + self.request = None + + def store_artifact(self, session, principal, *, request): + del session, principal + self.request = request + return ManagedArtifactRef( + file_asset_id="file-1", + file_version_id="version-1", + filename=request.filename, + display_path=f"Generated/Templates/{request.filename}", + content_type=request.content_type, + size_bytes=len(request.payload), + sha256=hashlib.sha256(request.payload).hexdigest(), + provenance={"module": "files", "managed": True}, + ) + + +class TemplateServiceTests(unittest.TestCase): + def setUp(self) -> None: + self.database = configure_database("sqlite:///:memory:") + Base.metadata.create_all( + self.database.engine, + tables=[ + TemplateDefinition.__table__, + TemplateRevision.__table__, + TemplateRender.__table__, + ], + ) + + def tearDown(self) -> None: + reset_database(dispose=True) + + def test_catalogue_exposes_typed_contract_and_immutable_revisions(self) -> None: + with self.database.session() as session: + item, first = create_template(session, principal(), payload()) + update = TemplateUpdateRequest.model_validate( + { + **payload(body="Dear {{name}}
{{postal.address}}
").model_dump(mode="json"), + "base_revision": 1, + } + ) + item, second = update_template(session, principal(), item, update) + session.commit() + + refs = SqlTemplateCatalog().list_templates( + session, + principal(), + usage="campaign.postal", + ) + self.assertEqual(1, len(refs)) + self.assertEqual("serial_letter", refs[0].template_type) + self.assertEqual(("campaign.postal",), refs[0].revision.usages) + self.assertEqual("postal.address", refs[0].revision.required_fields[1].path) + self.assertNotEqual(first.definition_hash, second.definition_hash) + self.assertEqual(2, second.revision) + + def test_frozen_postal_snapshot_renders_deterministic_letter_bundle(self) -> None: + frozen = ( + {"name": "Ada", "postal": {"address": "Street 1"}}, + {"name": "Grace", "postal": {"address": "Street 2"}}, + ) + with self.database.session() as session: + item, _ = create_template(session, principal(), payload()) + item, revision = publish_template( + session, + principal(), + item, + revision=1, + base_revision=1, + ) + request = TemplateRenderRequest( + template_id=item.id, + revision=revision.revision, + usage="campaign.postal", + items=frozen, + input_snapshot={"provider": "dist_lists", "snapshot_id": "snapshot-1"}, + mode="final", + idempotency_key="campaign-1:postal-output-1", + ) + first = render_template(session, principal(), registry=_Registry(), request=request) + second = render_template(session, principal(), registry=_Registry(), request=request) + session.commit() + + self.assertEqual(first.render_id, second.render_id) + self.assertEqual(first.input_hash, second.input_hash) + self.assertEqual(first.output_sha256, second.output_sha256) + self.assertEqual(2, first.item_count) + self.assertEqual(2, first.page_count) + self.assertEqual("bounded_download", first.artifact.kind) + self.assertIn(b"Ada", first.payload) + self.assertIn(b"Grace", first.payload) + + def test_label_sheet_page_count_and_missing_fields(self) -> None: + with self.database.session() as session: + item, _ = create_template( + session, + principal(), + payload("Address labels", template_type="label_sheet"), + ) + with self.assertRaises(TemplateCompatibilityError): + render_template( + session, + principal(), + registry=_Registry(), + request=TemplateRenderRequest( + template_id=item.id, + usage="campaign.postal", + items=({"name": "Missing address"},), + ), + ) + result = render_template( + session, + principal(), + registry=_Registry(), + request=TemplateRenderRequest( + template_id=item.id, + usage="campaign.postal", + items=tuple( + {"name": f"Person {index}", "postal": {"address": f"Street {index}"}} + for index in range(5) + ), + ), + ) + self.assertEqual(2, result.page_count) + + def test_optional_files_store_receives_hashes_without_templates_payload_copy(self) -> None: + store = _ArtifactStore() + with self.database.session() as session: + item, _ = create_template(session, principal(), payload()) + item, revision = publish_template(session, principal(), item, revision=1, base_revision=1) + result = render_template( + session, + principal(), + registry=_Registry(store), + request=TemplateRenderRequest( + template_id=item.id, + revision=revision.revision, + usage="campaign.postal", + items=({"name": "Ada", "postal": {"address": "Street 1"}},), + input_snapshot={"snapshot_id": "snapshot-1"}, + mode="final", + idempotency_key="managed-output-1", + persist_to_files=True, + ), + ) + session.commit() + row = session.get(TemplateRender, result.render_id) + + self.assertEqual("managed_file", result.artifact.kind) + self.assertIsNone(row.payload) + self.assertEqual(result.output_sha256, store.request.metadata["output_sha256"]) + self.assertNotIn("Ada", str(store.request.metadata)) + + def test_tenant_isolation_and_html_sanitization(self) -> None: + self.assertEqual("Safe
", sanitize_template_html("Safe
")) + self.assertEqual("Unsafe", sanitize_template_html('Unsafe')) + with self.database.session() as session: + item, _ = create_template(session, principal("tenant-1"), payload()) + session.commit() + self.assertIsNone( + SqlTemplateCatalog().get_template( + session, + principal("tenant-2"), + template_id=item.id, + ) + ) + + +class TemplateManifestTests(unittest.TestCase): + def test_manifest_announces_provider_neutral_capabilities(self) -> None: + from govoplan_templates.backend.manifest import get_manifest + + manifest = get_manifest() + self.assertEqual("templates", manifest.id) + self.assertFalse(manifest.dependencies) + self.assertIn("files", manifest.optional_dependencies) + self.assertIn(CAPABILITY_TEMPLATE_CATALOG, manifest.capability_factories) + self.assertIn(CAPABILITY_TEMPLATE_RENDERER, manifest.capability_factories) + self.assertEqual("@govoplan/templates-webui", manifest.frontend.package_name) + + +if __name__ == "__main__": + unittest.main() diff --git a/webui/package.json b/webui/package.json new file mode 100644 index 0000000..55ce5c2 --- /dev/null +++ b/webui/package.json @@ -0,0 +1,32 @@ +{ + "name": "@govoplan/templates-webui", + "version": "0.1.14", + "private": true, + "type": "module", + "main": "src/index.ts", + "module": "src/index.ts", + "types": "src/index.ts", + "exports": { + ".": { + "types": "./src/index.ts", + "import": "./src/index.ts" + }, + "./styles/templates.css": "./src/styles/templates.css" + }, + "scripts": { + "typecheck": "tsc --noEmit" + }, + "peerDependencies": { + "@govoplan/core-webui": "^0.1.14", + "lucide-react": "^1.23.0", + "react": ">=19.2.7 <20", + "react-dom": ">=19.2.7 <20", + "react-router": ">=8.3.0 <9", + "typescript": "^5.7.2" + }, + "peerDependenciesMeta": { + "@govoplan/core-webui": { + "optional": true + } + } +} diff --git a/webui/src/api/templates.ts b/webui/src/api/templates.ts new file mode 100644 index 0000000..b7b4f9c --- /dev/null +++ b/webui/src/api/templates.ts @@ -0,0 +1,266 @@ +import { + apiDownload, + apiFetch, + apiPath, + type ApiSettings +} from "@govoplan/core-webui"; + +export type TemplateType = + | "label" + | "label_sheet" + | "envelope" + | "serial_letter" + | "form_letter" + | "list_layout" + | "email" + | "generic"; + +export type TemplateFieldType = + | "string" + | "integer" + | "number" + | "boolean" + | "date" + | "datetime" + | "object" + | "array"; + +export type TemplateFieldRequirement = { + path: string; + value_type: TemplateFieldType; + label?: string | null; + required: boolean; + description?: string | null; +}; + +export type TemplateOutputProfile = { + id: string; + label: string; + output_format: "html" | "text"; + media_type: string; + channel: string; + capabilities: string[]; + page: RecordCreate or select a reusable template.
: view === "definition" ? <> +No revision evidence is available.
} +No output has been rendered for this template.
} +No required fields. Tokens still resolve from supplied parameters and items.
} +