@reactwright/template-report 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Reactwright contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,129 @@
+# @reactwright/template-report
+
+Technical and business report template for the Reactwright document
+engine. US Letter, single-column, Times 11pt with comfortable line
+spacing, optional executive-summary box, decimal section numbering
+(`1.`, `1.1`, `1.1.1`), auto-numbered figure and table captions, and
+a numeric `[N]` bibliography at the back.
+
+## When to use this over alternatives
+
+- Pick `@reactwright/template-report` for internal company reports,
+  consulting deliverables, white papers, lab write-ups, or any
+  professional document that wants decimal section numbering and a
+  cover-page-style title block but does not need IEEE branding.
+- Pick `@reactwright/template-ieee-report` for IEEE-branded long-form
+  reports (Times serif, Roman section numbers, "Fig. 1." captions).
+- Pick `@reactwright/template-ieee` for two-column IEEE conference
+  papers.
+- Pick `@reactwright/template-essay` for short MLA-style essays.
+
+## Format conventions
+
+- US Letter paper, 1" top/bottom margins, 1.25" left/right margins.
+- Body: Times New Roman 11pt, line-height 1.4, justified.
+- Title: 18pt bold centered.
+- Author / date: 11pt italic centered below the title.
+- Executive summary / abstract (`role="abstract"`): tinted box with
+  bold uppercase heading and justified body inside.
+- Section heads (depth 1): 13pt bold left-aligned, decimal numbering
+  (`1.`, `2.`, `3.`, …). The numbering counter is reset for each
+  top-level section; subsection counter resets on each new section.
+- Subsection heads (depth 2): 11pt bold left-aligned, decimal
+  numbering (`1.1`, `1.2`, `2.1`, …).
+- Body paragraphs: block style — no first-line indent, 6pt top
+  margin between paragraphs, justified. The first paragraph after a
+  heading has its top margin suppressed (sits flush against the
+  heading).
+- Figure captions: 10pt italic centered "Figure N. …" below the
+  figure, auto-numbered via the `report-figure` counter.
+- Table captions: 10pt italic left-aligned "Table N. …" above the
+  table, auto-numbered via the `report-table` counter.
+- Tables: full-width, fixed-layout, 10pt, light grey rules around
+  cells, bold header row on a grey tint with bolder top and bottom
+  rules.
+- Citations: `[N]` numeric via `target-counter`.
+- Bibliography (`role="bibliography"`): 10pt with hanging indent and
+  `[N]` numeric prefix.
+- Running header on page 2+: document title italic top-left, page
+  number top-right (both 9pt).
+- Footer: `page-number / page-count` centered 9pt.
+
+## Usage
+
+```tsx
+import "reactwright/jsx";
+import { Template } from "@reactwright/template-report";
+
+export { Template };
+
+export default function MyReport() {
+  return (
+    <document title="Q3 Engineering Review" author="A. Author">
+      <section role="abstract" title="Executive Summary">
+        <p>
+          Three-sentence digest of the report. The template renders
+          this in a tinted box at the top of the body.
+        </p>
+      </section>
+
+      <section title="Background">
+        <p>
+          Section-1 prose. Top-level headings auto-number as
+          "1. Background", "2. Findings", and so on.
+        </p>
+
+        <section title="Prior work">
+          <p>Subsection prose; depth-2 headings number as "1.1".</p>
+        </section>
+      </section>
+
+      <section title="Findings">
+        <p>
+          Body prose with a citation <cite cite="kuhn1962" /> and a
+          reference to the figure below.
+        </p>
+
+        <figure src="./build-times.png" caption="Build times by commit" />
+      </section>
+
+      <section title="Recommendations">
+        <p>Closing paragraph.</p>
+      </section>
+
+      <refs>
+        <ref-entry refKey="kuhn1962">
+          T. S. Kuhn, <em>The Structure of Scientific Revolutions</em>,
+          University of Chicago Press, 1962.
+        </ref-entry>
+      </refs>
+    </document>
+  );
+}
+```
+
+## Implementation notes
+
+Styling is expressed entirely via the styling dialect (`<styles>` +
+`<rule>`). The exported `REPORT_STYLES` is the CSS-dialect source the
+template binds; there is no engine-bypass CSS.
+
+Section numbering is implemented through the dialect's `numbering`
+declaration on the section-head classes — the engine emits the
+counter machinery and the `report-subsection` counter resets when a
+new `report-section` increment fires.
+
+The bibliography is rendered by the userland `<Bibliography>` helper
+that the template includes after the body slot (titled "References"
+in this template). Author-side, supply entries via a `<refs>` block.
+
+## Limitations
+
+- **No cover page.** Title and author render at the top of page 1
+  above the body, not on a dedicated cover. Authors who need a cover
+  page can add a separate first section with the cover content and a
+  `page-break` after it, or extend the template to register a
+  cover-page regime.
+- **No table of contents.** A TOC is not part of the default chrome.
+  Authors who need one can add `<toc />` (deprecated, but functional)
+  or compose a TOC from `<toc-data>` per the styling spec.

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@reactwright/template-report",
+  "version": "0.1.0",
+  "description": "Business/technical report template for the Reactwright document engine.",
+  "license": "MIT",
+  "author": "Reactwright contributors",
+  "homepage": "https://github.com/PurpleReverie/reactwright/tree/main/packages/template-report#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PurpleReverie/reactwright.git",
+    "directory": "packages/template-report"
+  },
+  "bugs": {
+    "url": "https://github.com/PurpleReverie/reactwright/issues"
+  },
+  "keywords": ["reactwright", "template", "report", "technical", "business"],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "files": [
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "check": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "reactwright": "workspace:*",
+    "react": "^18 || ^19"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.18",
+    "@types/react": "^19.1.2",
+    "react": "^19.1.0",
+    "reactwright": "workspace:*",
+    "typescript": "^5.8.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+// Business/technical report helper package. Exports a Template plus
+// the raw styles string so authors can compose it into their own
+// templates.
+export { Template, REPORT_STYLES } from "./template.js";

package/src/template.tsx

@@ -0,0 +1,334 @@
+import "reactwright/jsx";
+import { Bibliography } from "../../reactwright/src/userland/Bibliography.js";
+
+// Business/technical report template, packaged as a reusable module.
+// Templates that want the same report styling can:
+//
+//   import { Template, REPORT_STYLES } from "./report";
+//
+// Rules captured:
+//   • US Letter paper, 1" top/bottom, 1.25" left/right margins
+//   • Body: Times 11pt, line-height 1.4 (NOT double-spaced)
+//   • Title: 18pt bold centered; Author/Date block below
+//   • Section headings: decimal-numbered ("1.", "2.", ...)
+//   • Subsections: nested decimal ("1.1", "2.1", ...)
+//   • Paragraphs: block style (no indent, 6pt top margin)
+//   • Figure captions: "Figure 1." auto-numbered
+//   • Table captions: "Table 1." auto-numbered
+//   • Page header (page 2+): document title left, page number right
+//   • Bibliography: IEEE-style [1], [2] numeric
+//
+// Slice-1+ dialect only. customCss is empty.
+
+export const REPORT_STYLES = `
+  .report-title {
+    font-size: 18pt;
+    font-weight: bold;
+    font-family: 'Times New Roman', Times, serif;
+    text-align: center;
+    margin: 0 0 6pt 0;
+    line-height: 1.2;
+    text-indent: 0;
+  }
+
+  .report-author {
+    font-size: 11pt;
+    font-style: italic;
+    font-weight: normal;
+    text-align: center;
+    margin: 0 0 18pt 0;
+    text-indent: 0;
+  }
+
+  .report-abstract {
+    margin: 0 0 12pt 0;
+    padding: 8pt 12pt;
+    background-color: #f5f5f5;
+  }
+
+  .report-abstract-heading {
+    font-size: 11pt;
+    font-weight: bold;
+    text-transform: uppercase;
+    letter-spacing: 0.04em;
+    margin: 0 0 4pt 0;
+    text-indent: 0;
+    text-align: left;
+  }
+
+  .report-abstract-p {
+    margin: 0;
+    text-indent: 0;
+    text-align: justify;
+  }
+
+  .report-section-head {
+    font-size: 13pt;
+    font-weight: bold;
+    font-family: 'Times New Roman', Times, serif;
+    text-align: left;
+    text-transform: none;
+    letter-spacing: 0;
+    margin: 14pt 0 4pt 0;
+    text-indent: 0;
+    numbering: counter(report-section) "$report-section. ";
+    numbering-reset: report-subsection;
+    break: after(avoid);
+  }
+
+  .report-subsection-head {
+    font-size: 11pt;
+    font-weight: bold;
+    font-style: normal;
+    font-family: 'Times New Roman', Times, serif;
+    text-align: left;
+    margin: 10pt 0 2pt 0;
+    text-indent: 0;
+    numbering: counter(report-subsection) "$report-section.$report-subsection. ";
+    break: after(avoid);
+  }
+
+  .report-body-p {
+    margin: 6pt 0 0 0;
+    text-indent: 0;
+    text-align: justify;
+  }
+
+  .report-heading-adjacent-p {
+    margin-top: 0;
+  }
+
+  .report-figure {
+    margin: 10pt 0;
+    text-align: center;
+    break: inside(avoid);
+  }
+
+  .report-figure-img {
+    max-width: 100%;
+    height: auto;
+    display: block;
+    margin: 0 auto 4pt auto;
+  }
+
+  .report-fig-caption {
+    font-size: 10pt;
+    font-style: italic;
+    font-family: 'Times New Roman', Times, serif;
+    text-align: center;
+    line-height: 1.3;
+    text-indent: 0;
+    numbering: counter(report-figure) "Figure $report-figure. ";
+  }
+
+  .report-table {
+    margin: 10pt 0;
+    border-collapse: collapse;
+    font-size: 10pt;
+    width: 100%;
+    table-layout: fixed;
+    break: inside(avoid);
+  }
+
+  .report-table-cell {
+    padding: 3pt 6pt;
+    text-align: left;
+    text-indent: 0;
+    border: 0.5pt solid #888;
+  }
+
+  .report-table-header-cell {
+    font-weight: bold;
+    background-color: #eeeeee;
+    border-top: 0.75pt solid #000;
+    border-bottom: 0.75pt solid #000;
+  }
+
+  .report-table-caption {
+    font-size: 10pt;
+    font-style: italic;
+    font-family: 'Times New Roman', Times, serif;
+    text-align: left;
+    line-height: 1.3;
+    text-indent: 0;
+    margin-bottom: 4pt;
+    caption-side: top;
+    numbering: counter(report-table) "Table $report-table. ";
+  }
+
+  .report-cell-p {
+    margin: 0;
+    text-indent: 0;
+    font-size: inherit;
+  }
+
+  .report-cite {
+    color: inherit;
+    text-decoration: none;
+    prefix: "[";
+    suffix: target-counter(attr(href url), reactwright-bib) "]";
+  }
+
+  .report-bibliography {
+    font-size: 10pt;
+    margin-top: 18pt;
+  }
+
+  .report-bib-heading {
+    font-size: 13pt;
+    font-weight: bold;
+    font-style: normal;
+    text-align: left;
+    margin: 0 0 6pt 0;
+    text-indent: 0;
+    break: after(avoid);
+  }
+
+  .report-bib-list {
+    list-style: none;
+    padding-left: 0;
+    margin: 0;
+  }
+
+  .report-bib-entry {
+    margin-bottom: 3pt;
+  }
+
+  .report-bib-entry-p {
+    margin: 0;
+    text-align: left;
+    text-indent: -1.6em;
+    padding-left: 1.6em;
+    prefix: "[" counter(reactwright-bib) "] ";
+  }
+
+  .report-code-inline {
+    background: none;
+    padding: 0;
+    border-radius: 0;
+    font-family: 'SFMono-Regular', Consolas, Menlo, monospace;
+    font-size: 0.92em;
+  }
+`;
+
+export function Template() {
+  return (
+    <page
+      page={{
+        size: "letter",
+        marginTop: "1in",
+        marginBottom: "1in",
+        marginLeft: "1.25in",
+        marginRight: "1.25in"
+      }}
+      typography={{
+        fontFamily: "'Times New Roman', Times, serif",
+        fontSize: "11pt",
+        lineHeight: 1.4,
+        textAlign: "justify"
+      }}
+    >
+      <styles>{REPORT_STYLES}</styles>
+
+      <rule match={{ kind: "title" }} className="report-title" />
+      <rule match={{ kind: "author" }} className="report-author" />
+      <rule match={{ kind: "code" }} className="report-code-inline" />
+
+      {/* Abstract / Executive Summary */}
+      <rule match={{ kind: "section", role: "abstract" }} className="report-abstract" />
+      <rule
+        match={{ kind: "section-heading", within: { kind: "section", role: "abstract" } }}
+        className="report-abstract-heading"
+      />
+      <rule
+        match={{ kind: "paragraph", within: { kind: "section", role: "abstract" } }}
+        className="report-abstract-p"
+      />
+
+      {/* Numbered top-level section headings (skip abstract + bibliography) */}
+      <rule
+        match={{
+          kind: "section-heading",
+          depth: 1,
+          not: {
+            or: [
+              { within: { kind: "section", role: "bibliography" } },
+              { within: { kind: "section", role: "abstract" } }
+            ]
+          }
+        }}
+        className="report-section-head"
+      />
+      <rule match={{ kind: "section-heading", depth: 2 }} className="report-subsection-head" />
+
+      {/* Body paragraphs — exclude abstract/blockquote/bibliography/cell */}
+      <rule
+        match={{
+          kind: "paragraph",
+          not: {
+            or: [
+              { within: { kind: "section", role: "bibliography" } },
+              { within: { kind: "section", role: "abstract" } },
+              { within: { kind: "cell" } }
+            ]
+          }
+        }}
+        className="report-body-p"
+      />
+      <rule
+        match={{ kind: "paragraph", follows: { kind: "section-heading" } }}
+        className="report-heading-adjacent-p"
+      />
+
+      {/* Figures + tables */}
+      <rule match={{ kind: "figure" }} className="report-figure" />
+      <rule match={{ kind: "figure-image" }} className="report-figure-img" />
+      <rule match={{ kind: "caption", parent: { kind: "figure" } }} className="report-fig-caption" />
+      <rule match={{ kind: "table" }} className="report-table" />
+      <rule match={{ kind: "caption", parent: { kind: "table" } }} className="report-table-caption" />
+      <rule match={{ kind: "cell" }} className="report-table-cell" />
+      <rule match={{ kind: "cell", attr: { header: true } }} className="report-table-header-cell" />
+      <rule match={{ kind: "paragraph", within: { kind: "cell" } }} className="report-cell-p" />
+
+      {/* Cites + IEEE-style numeric bibliography (via userland Bibliography) */}
+      <rule match={{ kind: "cite" }} className="report-cite" />
+      <rule match={{ kind: "section", role: "bibliography" }} className="report-bibliography" />
+      <rule
+        match={{ kind: "section-heading", within: { kind: "section", role: "bibliography" } }}
+        className="report-bib-heading"
+      />
+      <rule
+        match={{ kind: "list", within: { kind: "section", role: "bibliography" } }}
+        className="report-bib-list"
+      />
+      <rule
+        match={{ kind: "item", within: { kind: "section", role: "bibliography" } }}
+        className="report-bib-entry"
+      />
+      <rule
+        match={{ kind: "paragraph", within: { kind: "section", role: "bibliography" } }}
+        className="report-bib-entry-p"
+      />
+
+      <header anchor="top-left" when="not-first-page" typography={{ fontSize: "9pt", fontStyle: "italic" }}>
+        <running name="document-title" />
+      </header>
+      <header anchor="top-right" when="not-first-page" typography={{ fontSize: "9pt" }}>
+        <page-number />
+      </header>
+      <footer anchor="bottom-center" typography={{ fontSize: "9pt" }}>
+        <page-number /> / <page-count />
+      </footer>
+
+      <stack gap="0">
+        <region>
+          <slot name="title" />
+          <slot name="author" />
+          <slot name="abstract" />
+          <slot name="body" />
+          <Bibliography title="References" />
+        </region>
+      </stack>
+    </page>
+  );
+}