av6-pdf-engine 1.0.0 → 1.0.2

package/.prettierignore

@@ -0,0 +1,4 @@
+node_module
+build
+dist
+.vscode

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+    "semi": true,
+    "singleQuote": false,
+    "trailingComma": "es5",
+    "printWidth": 120
+}

package/README.md

@@ -0,0 +1,155 @@
+# av6-pdf-engine
+
+`av6-pdf-engine` is a JSON-driven PDF layout engine built on top of [PDFKit](https://github.com/foliojs/pdfkit).  
+Describe your document once (page setup, styles, headers, blocks, tables, QR/barcodes, signatures, etc.) and render it to a file or in-memory buffer from any Node.js service.
+
+## Highlights
+
+- JSON definition that mirrors pdfmake-style blocks while staying close to raw PDFKit features.
+- Built-in layout helpers for headers, footers, watermarks, page backgrounds, and signature flows.
+- Rich block catalog: text, columns, tables, key/value grids, images, QR codes, 1D barcodes, lines, and explicit page breaks.
+- Automatic asset normalization for remote URLs, Buffers, or local paths (images, QR, barcode payloads).
+- Custom font registration plus reusable style definitions with full TypeScript types.
+- Two rendering targets: `renderCustomPdf(def, "/tmp/doc.pdf")` or `renderCustomPdfToBuffer(def)` for HTTP responses/storage.
+
+## Installation
+
+```bash
+npm install av6-pdf-engine
+# or
+pnpm add av6-pdf-engine
+# or
+yarn add av6-pdf-engine
+```
+
+## Quick start
+
+```ts
+import {
+  renderCustomPdfToBuffer,
+  renderCustomPdf,
+  CustomDocDefinition,
+} from "av6-pdf-engine";
+
+const doc: CustomDocDefinition = {
+  pageSize: "A4",
+  margins: { top: 80, right: 40, bottom: 80, left: 40 },
+  fonts: [{ name: "Inter", src: "./assets/Inter-Regular.ttf" }],
+  styles: {
+    heading: { font: "Helvetica-Bold", fontSize: 16 },
+    label: { color: "#999", fontSize: 9, bold: true },
+  },
+  header: {
+    blocks: [{ type: "text", text: "ACME Corp — Invoice", style: "heading" }],
+    backgroundColor: "#f7f7f7",
+  },
+  footer: (page, size) => ({
+    blocks: [
+      {
+        type: "text",
+        text: `Page ${page} / ${Math.round(size.height)}`,
+        align: "center",
+      },
+    ],
+  }),
+  pageBackground: { src: "./assets/background.png", opacity: 0.05 },
+  watermark: { text: "ACME CONFIDENTIAL", mode: "exceptFirst", opacity: 0.1 },
+  content: [
+    {
+      type: "columns",
+      widths: [200, "*"],
+      columns: [
+        [
+          { type: "text", text: "Invoice #1234", style: "heading" },
+          {
+            type: "keyValueGrid",
+            columns: [
+              [
+                { key: "Issued", value: "2025-12-01" },
+                { key: "Due", value: "2025-12-15" },
+              ],
+            ],
+            keyStyle: "label",
+          },
+        ],
+        [
+          {
+            type: "table",
+            widths: ["*", 80, 80],
+            headerRows: 1,
+            body: [
+              [
+                { text: "Item", style: "label" },
+                { text: "Qty", style: "label", align: "right" },
+                { text: "Total", style: "label", align: "right" },
+              ],
+              [
+                { text: "Consulting" },
+                { text: "12", align: "right" },
+                { text: "$3,000", align: "right" },
+              ],
+            ],
+          },
+        ],
+      ],
+    },
+    { type: "qr", value: "https://acme.example.com/pay/1234", size: 80 },
+    { type: "barcode", value: "123456789012", bcType: "EAN13", width: 200 },
+    { type: "signature", height: 100, label: "Authorized signature" },
+  ],
+};
+
+// Write directly to disk
+await renderCustomPdf(doc, "./tmp/invoice.pdf");
+
+// Or capture an in-memory Buffer (perfect for HTTP responses / uploads)
+const pdfBuffer = await renderCustomPdfToBuffer(doc);
+```
+
+## Document definition
+
+- `pageSize`: Any PDFKit-supported size (`"A4"`, `"LETTER"`, `[width, height]`, etc.). Defaults to A4.
+- `margins`: Required `{ top, right, bottom, left }`. `top`/`bottom` double as header/footer bands.
+- `fonts`: Optional array of `{ name, src }` for custom TTF/OTF registration before rendering.
+- `header` / `footer`: Structured block arrays. Footers can also be a single block, array, or a callback `(pageNumber, pageSize) => Block | FooterDef`.
+- `pageBackground`: Optional image (path, URL, or Buffer) painted before content each page.
+- `watermark`: Text watermark with opacity, angle, font size, color, and placement mode (`all`, `first`, `last`, `exceptFirst`, etc.).
+- `styles`: Named `StyleDef` map that can be referenced via `style` on text/table cells/key-value items.
+- `content`: Ordered array of `Block` objects (see below) rendered top to bottom with automatic pagination.
+
+## Block catalog
+
+- `text`: Paragraph with typography controls (alignment, inline styles, links, margins).
+- `image`: Local path, Buffer, or remote URL (auto-downloaded) with sizing/alignment.
+- `qr`: QR codes via `qrcode` with size, version, and error correction level support.
+- `barcode`: CODE128, EAN13, CODE39, ITF, CODE93 via `bwip-js`, including rotation, scaling, and caption text.
+- `columns`: Multi-column layouts (`widths`, gaps, `keepTogether`) that can nest any other blocks.
+- `table`: Simple table primitive with header rows, cell styles, and optional border layout hints.
+- `keyValueGrid`: Responsive key/value pairs with shared or per-row styles, separators, and column widths.
+- `line`: Horizontal rule with configurable width, color, and surrounding margins.
+- `pageBreak`: Forces the renderer to finish the current page before continuing.
+- `signature`: Reserves space (height/width) and optionally renders nested blocks or an image to support wet/digital signatures.
+
+Each block supports a `visible` flag so you can skip rendering without mutating arrays.
+
+## Asset handling & async preparation
+
+- Images, QR payloads, and barcodes accept paths, Buffers, or HTTPS URLs. Remote sources are fetched and cached as Buffers before rendering begins.
+- Nested structures (columns, signature blocks, headers/footers) are traversed automatically, so you can reference assets anywhere in the tree.
+- When using remote assets, ensure your runtime has outbound network access and consider wrapping `renderCustomPdf*` in your own caching layer.
+
+## Headers, footers, backgrounds, and watermarks
+
+- Headers render inside the `top` margin band; footers render inside the `bottom` band. Adjust `marginTop/marginBottom` on header/footer defs for fine-grained spacing.
+- `pageBackground` is painted before header/content on every new page, while `watermark.mode` decides which pages receive the overlay.
+- Footer callbacks receive `(pageNumber, pageSize)` so you can display pagination, print timestamps, or conditionally hide content.
+
+## Development
+
+- Build TypeScript to `dist/`: `pnpm build`
+- Regenerate before publishing: `pnpm prepublishOnly`
+- Run the sample script (if you add one) with `pnpm demo` to exercise the renderer locally.
+
+## License
+
+MIT — see `LICENSE` (provide your own if distributing).

package/dist/index.d.mts

@@ -0,0 +1,296 @@
+interface SignatureBlock extends BaseBlock {
+    type: "signature";
+    height: number;
+    blocks?: Block[];
+    image?: string;
+    label?: string;
+    width?: number;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+interface KeyValueItem {
+    key: string;
+    value: string;
+    keyStyle?: StyleRef;
+    valueStyle?: StyleRef;
+    keyTextStyle?: InlineTextStyle;
+    valueTextStyle?: InlineTextStyle;
+    keyAlign?: Alignment;
+    valueAlign?: Alignment;
+}
+interface KeyValueGridBlock extends BaseBlock {
+    type: "keyValueGrid";
+    columns: KeyValueItem[][];
+    columnGap?: number;
+    keyWidth?: Width;
+    columnWidths?: (Width | undefined)[];
+    orientation?: Orientation;
+    verticalKeyValueGap?: number;
+    keyStyle?: StyleRef;
+    valueStyle?: StyleRef;
+    keyTextStyle?: InlineTextStyle;
+    valueTextStyle?: InlineTextStyle;
+    keyAlign?: Alignment;
+    valueAlign?: Alignment;
+    separator?: string;
+    separatorGap?: number;
+    rowGap?: number;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+interface PageBreakBlock extends BaseBlock {
+    type: "pageBreak";
+}
+
+interface TableCell {
+    text: string;
+    italic?: boolean;
+    underline?: boolean;
+    link?: string;
+    strike?: boolean;
+    bold?: boolean;
+    fontSize?: number;
+    font?: FontName;
+    align?: Alignment;
+    color?: string;
+    fillColor?: string;
+    style?: StyleRef;
+}
+interface TableBlock extends BaseBlock {
+    type: "table";
+    headerRows?: number;
+    widths: Width[];
+    body: TableCell[][];
+    layout?: {
+        border?: "all" | "none";
+        hLineColor?: string;
+        vLineColor?: string;
+    };
+    lineGap?: number;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+interface ColumnsBlock extends BaseBlock {
+    type: "columns";
+    columns: Block[][];
+    gap?: number;
+    widths?: Width[];
+    mode?: "fixedGap" | "spaceBetween";
+    keepTogether?: boolean;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+interface LineBlock extends BaseBlock {
+    type: "line";
+    lineWidth?: number;
+    color?: string;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+type QRErrorLevel = "L" | "M" | "Q" | "H";
+declare const QR_ERROR_LEVEL: {
+    LOW: QRErrorLevel;
+    MEDIUM: QRErrorLevel;
+    QUARTILE: QRErrorLevel;
+    HIGH: QRErrorLevel;
+};
+interface QrCodeBlock extends BaseBlock {
+    type: "qr";
+    value?: string;
+    src?: string | Buffer;
+    size?: number;
+    qrVersion?: number;
+    errorCorrectionLevel?: QRErrorLevel;
+    align?: Alignment;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+interface ImageBlock extends BaseBlock {
+    type: "image";
+    src?: string | Buffer;
+    width?: number;
+    height?: number;
+    align?: Alignment;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+interface TextBlock extends BaseBlock {
+    type: "text";
+    text: string;
+    fontSize?: number;
+    lineGap?: number;
+    align?: Alignment;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strike?: boolean;
+    link?: string;
+    color?: string;
+    font?: FontName;
+    style?: StyleRef;
+    marginLeft?: number;
+    marginRight?: number;
+}
+
+type Alignment = "left" | "right" | "center" | "justify";
+type Orientation = "horizontal" | "vertical";
+type Width = number | "*";
+type InlineTextStyle = Omit<TextBlock, "type" | "text" | "style">;
+type BuiltInFont = "Helvetica" | "Helvetica-Bold" | "Helvetica-Oblique" | "Helvetica-BoldOblique" | "Times-Roman" | "Times-Bold" | "Times-Italic" | "Times-BoldItalic" | "Courier" | "Courier-Bold" | "Courier-Oblique" | "Courier-BoldOblique";
+/**
+ * FontName:
+ *  - autocomplete for built-ins
+ *  - but still allows any custom string when you registerFont
+ */
+type FontName = BuiltInFont | (string & {});
+/**
+ * Style definition similar to pdfmake's style object.
+ * Can be applied to text blocks and table cells.
+ */
+interface StyleDef {
+    italic?: boolean;
+    underline?: boolean;
+    link?: string;
+    strike?: boolean;
+    fontSize?: number;
+    lineGap?: number;
+    align?: Alignment;
+    bold?: boolean;
+    color?: string;
+    fillColor?: string;
+    font?: FontName;
+}
+/** Shared style reference field (single or multiple style names). */
+type StyleRef = string | string[] | undefined;
+interface PageMargins {
+    /**
+     * TOP is treated as header band height.
+     * BOTTOM is treated as footer band height.
+     * LEFT/RIGHT are used for content only.
+     */
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+type WatermarkMode = "all" | "first" | "last" | "firstLast" | "exceptFirst" | "exceptLast" | "exceptFirstLast";
+interface WatermarkDef {
+    text: string;
+    opacity?: number;
+    fontSize?: number;
+    color?: string;
+    angle?: number;
+    mode?: WatermarkMode;
+}
+interface PageBackgroundDef {
+    /** Path or Buffer for the image to be used as full-page background */
+    src?: string | Buffer;
+    /** Optional global opacity for background (0–1). Default: 1 */
+    opacity?: number;
+}
+interface FontRegistration {
+    name: FontName;
+    src: string | Buffer;
+}
+interface CustomDocDefinition {
+    pageSize?: PDFKit.PDFDocumentOptions["size"];
+    margins: PageMargins;
+    /** Optional font registrations (custom TTF/OTF) */
+    fonts?: FontRegistration[];
+    header?: HeaderDef;
+    pageBackground?: PageBackgroundDef;
+    watermark?: WatermarkDef;
+    content: Block[];
+    styles?: Record<string, StyleDef>;
+    footer?: FooterInput;
+}
+interface HeaderDef {
+    blocks: Block[];
+    visible?: boolean;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+    backgroundColor?: string;
+    backgroundImage?: string | Buffer;
+}
+interface FooterDef {
+    blocks: Block[];
+    visible?: boolean;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+    backgroundColor?: string;
+    backgroundImage?: string | Buffer;
+}
+type FooterInput = FooterDef | Block | Block[] | ((pageNumber: number, pageSize: {
+    width: number;
+    height: number;
+}) => FooterDef | Block | Block[] | null | undefined);
+interface BaseBlock {
+    visible?: boolean;
+}
+type Block = TextBlock | ImageBlock | QrCodeBlock | BarcodeBlock | LineBlock | ColumnsBlock | TableBlock | PageBreakBlock | KeyValueGridBlock | SignatureBlock;
+
+type BarcodeType = "CODE128" | "EAN13" | "CODE39" | "ITF" | "CODE93";
+declare const BARCODE_TYPES: Record<BarcodeType, BarcodeType>;
+interface BarcodeBlock extends BaseBlock {
+    type: "barcode";
+    value?: string;
+    src?: string | Buffer;
+    bcType?: BarcodeType;
+    width?: number;
+    height?: number;
+    align?: Alignment;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+    orientation?: Orientation;
+    rotate?: number;
+    scale?: number;
+    barHeight?: number;
+    includetext?: boolean;
+    textalign?: "left" | "center" | "right";
+}
+
+interface PageContext {
+    pageNumber: number;
+    currentY: number;
+    signatureBlock: SignatureBlock | null;
+    signatureTopY: number | null;
+    signatureHeight: number;
+    signaturePlaced: boolean;
+    afterSignature: boolean;
+    inFooter: boolean;
+}
+interface RenderEnv {
+    marginLeft: number;
+    innerWidth: number;
+    allowPageBreak: boolean;
+}
+
+declare function renderCustomPdf(def: CustomDocDefinition, outputPath: string): Promise<void>;
+declare function renderCustomPdfToBuffer(def: CustomDocDefinition): Promise<Buffer>;
+
+export { type Alignment, BARCODE_TYPES, type BarcodeBlock, type BarcodeType, type BaseBlock, type Block, type BuiltInFont, type ColumnsBlock, type CustomDocDefinition, type FontName, type FontRegistration, type FooterDef, type FooterInput, type HeaderDef, type ImageBlock, type InlineTextStyle, type KeyValueGridBlock, type KeyValueItem, type LineBlock, type Orientation, type PageBackgroundDef, type PageBreakBlock, type PageContext, type PageMargins, type QRErrorLevel, QR_ERROR_LEVEL, type QrCodeBlock, type RenderEnv, type SignatureBlock, type StyleDef, type StyleRef, type TableBlock, type TableCell, type TextBlock, type WatermarkDef, type WatermarkMode, type Width, renderCustomPdf, renderCustomPdfToBuffer };