h17-sspdf 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,409 @@
+# sspdf
+
+Define the layout once. Feed it JSON. The core is blind to both and does all the math.
+
+The theme does not know what the content says. The JSON does not know how it looks. The core does not know it is rendering a newspaper, an invoice, or a certificate. Three blind components, one coherent output.
+
+```
+Source JSON  +  Theme  =  PDF
+```
+
+## Install
+
+```bash
+npm install h17-sspdf
+```
+
+## The problem it solves
+
+Generating PDFs imperatively means tracking the cursor yourself. Every element you place shifts everything below it. Line wrapping, page breaks, font resets — all manual.
+
+This engine inverts that. You describe *what* to render and *how it looks*. The cursor, the math, the page breaks happen automatically.
+
+## How it works
+
+Every operation has a `type` and a `label`. The label maps to a style in the theme. The engine looks up the style, lays out the content, advances the cursor by an exact calculated amount, and moves to the next operation.
+
+```
+operation → label → theme style → layout → cursor advance → next operation
+```
+
+Page breaks happen automatically when content reaches the bottom margin. Style resets after every operation — nothing leaks.
+
+## Quick start
+
+```js
+const { renderDocument } = require('h17-sspdf');
+
+renderDocument({
+  source: {
+    operations: [
+      { type: 'text', label: 'doc.title', text: 'My Document' },
+      { type: 'divider', label: 'doc.rule' },
+      { type: 'text', label: 'doc.body', text: 'First paragraph.' }
+    ]
+  },
+  theme: {
+    name: 'My Theme',
+    page: {
+      format: 'a4',
+      orientation: 'portrait',
+      unit: 'mm',
+      marginTopMm: 20,
+      marginBottomMm: 20,
+      marginLeftMm: 20,
+      marginRightMm: 20,
+      backgroundColor: [255, 255, 255],
+      defaultText:      { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 10, color: [0,0,0], lineHeight: 1.4 },
+      defaultStroke:    { color: [200,200,200], lineWidth: 0.3, lineCap: 'butt', lineJoin: 'miter' },
+      defaultFillColor: [255, 255, 255],
+    },
+    labels: {
+      'doc.title': { fontFamily: 'helvetica', fontStyle: 'bold', fontSize: 22, color: [0,0,0], lineHeight: 1.2, marginBottomMm: 4 },
+      'doc.rule':  { color: [200,200,200], lineWidth: 0.3, marginBottomMm: 4 },
+      'doc.body':  { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 10, color: [40,40,40], lineHeight: 1.5 },
+    }
+  },
+  outputPath: 'output/doc.pdf'
+});
+```
+
+## Building a layout
+
+### The newspaper front page
+
+The most complex built-in layout is a newspaper front page. It has a masthead, edition line, heavy rule, headline hierarchy, byline, multi-paragraph body, pull quote, stat scoreboard, and a footer that repeats on every page. Here is how it is built.
+
+#### Page template (repeating footer)
+
+Declare it once. The engine stamps it on every page at the specified Y position.
+
+```json
+{
+  "pageTemplates": {
+    "footer": [
+      { "type": "divider", "label": "news.footer.rule", "x1Mm": 18, "x2Mm": 192 },
+      {
+        "type": "row",
+        "leftLabel":  "news.footer.left",
+        "rightLabel": "news.footer.right",
+        "leftText":   "The Meridian Times | Civic Desk",
+        "rightText":  "Page {{page}}",
+        "xLeftMm": 18,
+        "xRightMm": 192
+      }
+    ],
+    "footerHeightMm": 8,
+    "footerStartMm": 284
+  }
+}
+```
+
+`{{page}}` is replaced with the current page number at render time.
+
+#### Masthead block
+
+The masthead, edition row, heavy rule, kicker, headline, deck, and byline are all inside a `section`. A section allows page breaks inside it but groups the content logically.
+
+```json
+{
+  "type": "section",
+  "content": [
+    { "type": "text",  "label": "news.masthead", "text": "The Meridian Times", "xMm": 18, "maxWidthMm": 174 },
+    {
+      "type": "row",
+      "leftLabel":  "news.edition.left",
+      "rightLabel": "news.edition.right",
+      "leftText":   "Saturday, March 7, 2026",
+      "rightText":  "Late City Edition",
+      "xLeftMm": 18,
+      "xRightMm": 192
+    },
+    { "type": "divider", "label": "news.rule.heavy", "x1Mm": 18, "x2Mm": 192 },
+    { "type": "text", "label": "news.kicker",   "text": "Infrastructure & Society", "xMm": 18, "maxWidthMm": 174 },
+    { "type": "text", "label": "news.headline", "text": "Local Governments Are Finally Rewriting How They Publish Public Records", "xMm": 18, "maxWidthMm": 174 },
+    { "type": "text", "label": "news.deck",     "text": "A quiet wave of procurement reform...", "xMm": 18, "maxWidthMm": 174 },
+    {
+      "type": "row",
+      "leftLabel":  "news.byline",
+      "rightLabel": "news.timestamp",
+      "leftText":   "By Marta Ruiz",
+      "rightText":  "Updated 6:40 PM",
+      "xLeftMm": 18,
+      "xRightMm": 192
+    },
+    { "type": "divider", "label": "news.rule.light", "x1Mm": 18, "x2Mm": 192 }
+  ]
+}
+```
+
+`xMm` and `maxWidthMm` override the page margins for this operation. This is how you position content independently of the theme margins.
+
+#### Multi-paragraph body text
+
+Pass `text` as an array. Each string becomes a paragraph with the label's spacing applied between them.
+
+```json
+{
+  "type": "text",
+  "label": "news.body",
+  "text": [
+    "First paragraph.",
+    "Second paragraph.",
+    "Third paragraph."
+  ],
+  "xMm": 18,
+  "maxWidthMm": 174
+}
+```
+
+#### Keeping a heading with its content
+
+`keepWithNext: N` tells the engine this operation must stay on the same page as the next N operations. Use it on section headings so they never strand at the bottom of a page.
+
+```json
+{ "type": "text", "label": "news.section.title", "text": "Inside the shift", "keepWithNext": 3 }
+```
+
+#### Stat scoreboard
+
+A repeating pattern of `row` + `text` pairs. The row carries the label/value, the text below carries the annotation.
+
+```json
+{
+  "type": "row",
+  "leftLabel":  "news.stat.label",
+  "rightLabel": "news.stat.value",
+  "leftText":   "Harbor City planning notices",
+  "rightText":  "42% faster"
+},
+{
+  "type": "text",
+  "label": "news.stat.note",
+  "text": "Review time fell after zoning notices moved to a single contract."
+}
+```
+
+#### Pull quote
+
+```json
+{
+  "type": "quote",
+  "label": "news.pullquote",
+  "text": "When the format becomes a system instead of a template, agencies stop re-solving the same layout problem every week.",
+  "attribution": "— Elena Ward, public records modernization lead",
+  "xMm": 22,
+  "maxWidthMm": 166
+}
+```
+
+`xMm` and `maxWidthMm` indent it from the body column — the indentation is in the source, not the theme.
+
+#### Hidden text (ATS / search metadata)
+
+Invisible in the rendered PDF, present in text extraction.
+
+```json
+{
+  "type": "hiddenText",
+  "label": "news.hidden.tags",
+  "text": "public records procurement modernization searchable notices"
+}
+```
+
+---
+
+### The theme labels for this layout
+
+Each label the source uses must exist in the theme. These are the ones the newspaper source uses:
+
+```js
+labels: {
+  'news.masthead':     { fontFamily: 'custom', fontStyle: 'bold', fontSize: 36, color: [0,0,0], lineHeight: 1.1, marginBottomMm: 2 },
+  'news.edition.left': { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 8, color: [80,80,80], lineHeight: 1 },
+  'news.edition.right':{ fontFamily: 'helvetica', fontStyle: 'italic', fontSize: 8, color: [80,80,80], lineHeight: 1, marginBottomMm: 1 },
+  'news.rule.heavy':   { color: [0,0,0], lineWidth: 1.2, marginBottomMm: 2 },
+  'news.rule.light':   { color: [160,160,160], lineWidth: 0.3, marginBottomMm: 3 },
+  'news.kicker':       { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 9, color: [100,100,100], lineHeight: 1, textTransform: 'uppercase', marginBottomMm: 1 },
+  'news.headline':     { fontFamily: 'custom', fontStyle: 'bold', fontSize: 28, color: [0,0,0], lineHeight: 1.15, marginBottomMm: 3 },
+  'news.deck':         { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 11, color: [40,40,40], lineHeight: 1.4, marginBottomMm: 2 },
+  'news.byline':       { fontFamily: 'helvetica', fontStyle: 'bold', fontSize: 8, color: [0,0,0], lineHeight: 1 },
+  'news.timestamp':    { fontFamily: 'helvetica', fontStyle: 'italic', fontSize: 8, color: [80,80,80], lineHeight: 1, marginBottomMm: 2 },
+  'news.body':         { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 10, color: [20,20,20], lineHeight: 1.55, marginBottomMm: 3 },
+  'news.section.title':{ fontFamily: 'helvetica', fontStyle: 'bold', fontSize: 11, color: [0,0,0], lineHeight: 1.2, marginTopMm: 3, marginBottomMm: 1 },
+  'news.pullquote':    { fontFamily: 'custom', fontStyle: 'italic', fontSize: 13, color: [30,30,30], lineHeight: 1.5,
+                         leftBorder: { widthMm: 1.5, color: [0,0,0], paddingMm: 4 }, marginTopMm: 4, marginBottomMm: 4 },
+  'news.stat.label':   { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 9, color: [40,40,40], lineHeight: 1 },
+  'news.stat.value':   { fontFamily: 'helvetica', fontStyle: 'bold', fontSize: 9, color: [0,0,0], lineHeight: 1 },
+  'news.stat.note':    { fontFamily: 'helvetica', fontStyle: 'italic', fontSize: 8, color: [100,100,100], lineHeight: 1.3, marginBottomMm: 3 },
+  'news.brief.text':   { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 10, color: [20,20,20], lineHeight: 1.5 },
+  'news.brief.marker': { color: [0,0,0] },
+  'news.footer.rule':  { color: [160,160,160], lineWidth: 0.3, marginBottomMm: 1 },
+  'news.footer.left':  { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 7, color: [120,120,120], lineHeight: 1 },
+  'news.footer.right': { fontFamily: 'helvetica', fontStyle: 'normal', fontSize: 7, color: [120,120,120], lineHeight: 1 },
+  'news.hidden.tags':  { fontSize: 0.1, color: [255,255,255] },
+}
+```
+
+---
+
+## Operation types
+
+| Type | Purpose | Key fields |
+|------|---------|------------|
+| `text` | Wrapped text block | `label`, `text` (string or array of strings) |
+| `row` | Left/right pair on one line | `leftLabel`, `rightLabel`, `leftText`, `rightText` |
+| `bullet` | Marker + wrapped text | `label`, `markerLabel`, `bullets` (array) |
+| `divider` | Horizontal rule | `label`, `x1Mm`, `x2Mm` |
+| `spacer` | Vertical gap | `mm`, `px`, or `label` |
+| `hiddenText` | Invisible text | `label`, `text` |
+| `quote` | Blockquote with attribution | `label`, `text`, `attribution` |
+| `block` | Group children, optional background + border | `children`, `keepTogether` |
+| `section` | Logical group, allows breaks inside | `content` |
+
+### Position overrides
+
+Any operation accepts `xMm` and `maxWidthMm` to override the theme margins for that operation only.
+
+### Page break control
+
+- `keepWithNext: N` — keep this operation on the same page as the next N operations
+- `block` with `keepTogether: true` — all children stay on the same page
+
+---
+
+## Label style properties
+
+```js
+{
+  // Typography
+  fontFamily: 'helvetica',       // or any registered custom font family
+  fontStyle: 'normal',           // 'normal' | 'bold' | 'italic' | 'bolditalic'
+  fontSize: 10,                  // pt
+  color: [0, 0, 0],              // RGB
+  lineHeight: 1.4,               // multiplier
+  textTransform: 'uppercase',    // 'uppercase' | 'lowercase' | undefined
+
+  // Spacing
+  marginTopMm: 0,
+  marginBottomMm: 0,
+  marginTopPx: 0,
+  marginBottomPx: 0,
+  paddingTopMm: 0,
+  paddingBottomMm: 0,
+  paddingTopPx: 0,
+  paddingBottomPx: 0,
+
+  // Dividers
+  lineWidth: 0.3,
+
+  // Container (block/section)
+  backgroundColor: [245, 245, 245],
+  borderColor: [200, 200, 200],
+  borderWidthMm: 0.3,
+  paddingMm: 4,
+
+  // Left border accent (quote, callout)
+  leftBorder: {
+    widthMm: 1.5,
+    color: [0, 0, 0],
+    paddingMm: 4,
+  },
+}
+```
+
+---
+
+## Custom fonts
+
+Embed TTF as base64 and register in the theme:
+
+```js
+customFonts: [
+  {
+    family: 'Inter',
+    faces: [
+      { style: 'normal', fileName: 'Inter-Regular.ttf', data: '<base64>' },
+      { style: 'bold',   fileName: 'Inter-Bold.ttf',    data: '<base64>' },
+    ],
+  },
+],
+```
+
+Then use `fontFamily: 'Inter'` in any label.
+
+---
+
+## Chart plugin
+
+Renders any Chart.js configuration to a PNG and embeds it in the PDF.
+
+### Install peer dependencies
+
+```bash
+npm install chart.js chartjs-node-canvas
+```
+
+### Register
+
+```js
+const { registerPlugin, plugins } = require('h17-sspdf');
+registerPlugin('chart', plugins.chart);
+```
+
+### Operation format
+
+```json
+{
+  "type": "chart",
+  "chartType": "bar",
+  "widthMm": 160,
+  "heightMm": 80,
+  "canvasWidth": 1600,
+  "canvasHeight": 800,
+  "data": {
+    "labels": ["Q1", "Q2", "Q3", "Q4"],
+    "datasets": [
+      {
+        "label": "Revenue",
+        "data": [120000, 145000, 138000, 172000],
+        "backgroundColor": "rgba(110, 158, 210, 0.80)"
+      }
+    ]
+  },
+  "options": {
+    "scales": {
+      "y": { "beginAtZero": true }
+    }
+  }
+}
+```
+
+`data` and `options` are passed directly to Chart.js — the plugin does not abstract the Chart.js API. `canvasWidth`/`canvasHeight` control render resolution (default 1600×800). `widthMm`/`heightMm` control the slot size in the PDF.
+
+---
+
+## CLI
+
+```bash
+npx sspdf -s source.json -t theme.js -o output.pdf
+```
+
+| Flag | Short | Description |
+|------|-------|-------------|
+| `--source` | `-s` | Path to source JSON (or pipe via stdin) |
+| `--theme` | `-t` | Path to theme `.js` file |
+| `--output` | `-o` | Output PDF path |
+
+---
+
+## Constraints
+
+- A4 only
+- Server-side (Node.js) only
+- Single-line `row` cells — no multi-line column pairs
+- No `{{pages}}` total page count token
+
+---
+
+Hugo Palma, 2026