av6-pdf-engine 1.0.1 → 1.0.3

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

@@ -25,11 +25,7 @@ yarn add av6-pdf-engine
 ## Quick start
 
 ```ts
-import {
-  renderCustomPdfToBuffer,
-  renderCustomPdf,
-  CustomDocDefinition,
-} from "av6-pdf-engine";
+import { renderCustomPdfToBuffer, renderCustomPdf, CustomDocDefinition } from "av6-pdf-engine";
 
 const doc: CustomDocDefinition = {
   pageSize: "A4",
@@ -83,11 +79,7 @@ const doc: CustomDocDefinition = {
                 { text: "Qty", style: "label", align: "right" },
                 { text: "Total", style: "label", align: "right" },
               ],
-              [
-                { text: "Consulting" },
-                { text: "12", align: "right" },
-                { text: "$3,000", align: "right" },
-              ],
+              [{ text: "Consulting" }, { text: "12", align: "right" }, { text: "$3,000", align: "right" }],
             ],
           },
         ],
@@ -144,11 +136,9 @@ Each block supports a `visible` flag so you can skip rendering without mutating
 - `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
+## Contributors
 
-- 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.
+- [polarizz17](https://github.com/polarizz17)
 
 ## License
 

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 };

package/dist/index.d.ts

@@ -1,3 +1,296 @@
-export * from "./renderer-engine";
-export * from "./types";
-//# sourceMappingURL=index.d.ts.map
+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 };