reportdesigner

package
v0.7.52 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 10, 2026 License: MIT, MIT Imports: 2 Imported by: 0

README

The Report Designer

The Report Designer is the QuickAgent that designs how your PDF reports look. It has two jobs:

  • Design writes a whole report design from your brief: colours checked for contrast, the faces, the title block and headings, a running header and footer, the brand block, and a cover style. You can give it a design to start from, your logo, up to four reference images, up to two web addresses, such as your own site, and one document of yours, a PDF or a Word document, to build the design around: it takes the document's logo, its cover page's artwork, its header and footer, and can write a custom cover modelled on its cover page.
  • Cover writes a custom cover page for one of your designs, in Typst code. It renders the cover, looks at it and refines it, up to twelve renders, and can draw images you give it.

What it makes is a new design. It is never your default and never replaces one of your designs: you pick it for a run, or make it your default, when you want it. Read more at https://docs.secureagentry.net/runner/.

This is the package that runs

The Report Designer is built into the Agentry CLI, and it runs from there: on your computer when you run agentry report-design design or agentry report-design cover. This release has the same bytes. The registry built its archive from the package the CLI carries, and the archive's digest is the one the CLI reports. Run agentry builtins to print it and compare it with the digest on this page.

Installing this release does not give you the Report Designer. The application runs it as a built-in, with the steps and tools listed below. If you install this release, it runs as an ordinary QuickAgent with only what its manifest declares.

What the application does around it

The manifest declares no network access, no file access and no commands, and one data category, files. When Agentry runs the Report Designer:

  • Before the run, the CLI stages what you gave it as inputs: the design to start from, without its images; the design's own images and yours, each re-encoded from its pixels; and your reference images. A document goes through the decode step like any input (its type checked, scanned for malware, its text extracted); then, in the same decode image with no network, a PDF's first twelve pages are rendered as images by poppler's page renderer with the pictures those pages draw, or a Word document's theme, header, footer and pictures are read (no Word layout is rendered). The CLI re-encodes every image from its pixels and stages what was read, never the document itself. Pages from web addresses are fetched and read by AI Review, with your own TypeSafe key, as the Voice Writer's are; a page drawn by scripts is read during the run with web_read, held to the addresses you gave.
  • During the run, the application grants it six tools of its own, and no other package gets them. render_preview lays out a fixed sample report in a design with the same renderer and confinement as a PDF export, and shows the model one page as an image. check_design holds a design to the rules every design is held to. view_reference shows the model one of your reference images. document_pages shows the model a page or a picture of your document, with its text, fonts and colours; crop_logo takes a picture or a box of a page as the design's logo; and take_picture takes one as the design's cover image or as an image of a custom cover modelled on your document's cover page. It writes its files with write_report.
  • Its guide. The release ships a knowledge pack, knowledge/design-guide: the design document and its closed lists, choosing a look, designing from a document, a custom cover's conventions, a short course in cover design, a worked example, and the checks before finishing. The application attaches it to every run.
  • After the run, the CLI checks what it wrote: the design against the same rules the registry applies, and a custom cover against its bounds. It attaches only the design's own images and yours, re-encoded, and refuses an image that is neither. A logo or a picture taken from your document is taken again by the CLI from its own copy of the page or the picture; no whole page of the document and none of its text is kept. With --save it adds the result to your account's designs under a new name; without it, it leaves the files in the run's output folder.

A custom cover's code

A custom cover is Typst code that the report template calls to draw the first page. When a PDF is exported, it is compiled with the rest of the report, offline, with the fonts in the runner image, and it can read only the report, the design and the images copied beside them. It cannot import a package, fetch anything or write a file. A cover that fails to compile, tries to draw more than one page, leaves an image without alt text, or runs past the render's limits is passed over for the built-in band cover. The export never fails for its cover, and the run's receipt says the cover was passed over and what kind of failure it had.

INSTRUCTION.md is the instruction the model follows.

Documentation

Overview

Package reportdesigner is the Report Designer: the QuickAgent package that designs a person's report design, the look of their PDF reports, embedded in the CLI and run by the runner as a built-in package, the fifth beside the Knowledge Creator, the Drafter, the Voice Writer and the Examiner. It has two jobs. Design writes a whole design document from a brief, a design to start from, the logo, reference images, web addresses and a document to build the design around. Cover writes a custom cover page for a design in Typst code. Its contract declares no egress, no filesystem, no exec and the files data category: the CLI stages what it is given as inputs, the application grants it render_preview, check_design, view_reference, document_pages, crop_logo and take_picture (and web_read held to the addresses the person gave, when a page is drawn by scripts), and it writes its work through write_report; pkg/reportdesigner/build keeps it.

Index

Constants

View Source
const (
	Namespace = "agentry"
	Name      = "report-designer"
	Version   = "1.2.0"
)

The package's identity, as its manifest declares it.

View Source
const (
	// DesignFile is the design document: the whole design a Design run
	// made, without images.
	DesignFile = "design.json"
	// CoverFile is a Cover run's custom cover, Typst code.
	CoverFile = "cover.typ"
	// NotesFile is what both jobs say of their own work: the name a
	// Cover run gives the design it makes, and whether the model looked
	// at its renders.
	NotesFile = "designer.json"
)

The files a run writes under reports/ with write_report.

View Source
const GuideName = "design-guide"

GuideName is the knowledge pack the Report Designer ships in its own release: the design document, its closed lists, choosing a look, a custom cover's conventions, a short course in cover design, a worked example and the checks before finishing. The runner gives it to every run of the package. Its manifest.json, index and lists page are generated (TestTheDesignGuideIsCurrent).

View Source
const LocalTimeoutFloorSeconds = 1800

LocalTimeoutFloorSeconds is the least a Report Designer run on this computer is given: 30 minutes, past the runner policy's 15-minute run timeout, since a cover is rendered and refined up to twelve times. It is a timeout alone, as the Voice Writer's floor is.

Variables

This section is empty.

Functions

func FS

func FS() fs.FS

FS is the package's tree: agent.yaml, INSTRUCTION.md, README.md and LICENSE at its root (a public release carries the last two), and under knowledge/ the pack it ships (GuideName).

Types

type Notes

type Notes struct {
	// Name is the name of the design a Cover run makes; a Design run
	// names its design in DesignFile.
	Name string `json:"name,omitempty"`
	// Looked says the model saw its renders and the references; false
	// when it could not read images.
	Looked bool `json:"looked"`
}

Notes is NotesFile.

Directories

Path Synopsis
Package build runs the Report Designer: it stages what the person gave it (the design to start from without its images, the design's own images and theirs, each re-encoded from its pixels by pkg/reportdesign, their reference images, and the text of the web pages they named, read by AI Review first), runs the built-in over them (pkg/runner/localrun), and collects what it wrote: a design document, or a custom cover for a design.
Package build runs the Report Designer: it stages what the person gave it (the design to start from without its images, the design's own images and theirs, each re-encoded from its pixels by pkg/reportdesign, their reference images, and the text of the web pages they named, read by AI Review first), runs the built-in over them (pkg/runner/localrun), and collects what it wrote: a design document, or a custom cover for a design.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL