Engine · Available

Report

Definitions, templates, generate, and run history.

@keystone/engine-report

Purpose

Report generation as a platform capability — definitions, templates, and runs reusable across applications. HTML renders with {{key}} replacement today; PDF/DOCX/XLSX store a preview plus a stub artifact key until real renderers land.

In a product

query → assess risk (AI) → generate a daily_ops report → notify the owner with a link to the run.

How it works

  1. Authors create templates (body with {{placeholders}}) and definitions that point at a template and default format.
  2. generate resolves the template, publishes report.generation.requested, renders HTML, then completes or fails with matching events.
  3. Non-HTML formats still produce an htmlPreview and a stub artifactKey like reports/{runId}.pdf for later storage wiring.
  4. Runs are listed and fetched for history in your app UI.

Capabilities

  • Definition and template CRUD
  • generate with {{key}} / nested path rendering
  • HTML preview; stub artifact keys for pdf / docx / xlsx
  • Run list and get
  • API under /v1/reports (definitions, templates, generate, runs)

Related

Automation · Trigger · AI · Notification

All enginesBuild on Keystone