@lpdfio/lpdf 0.0.3

package/dist/kit.d.ts

@@ -0,0 +1,109 @@
+/**
+ * LpdfKit — document skeleton assembly.
+ *
+ * Assembles sections (containing layout and canvas blocks) into a document
+ * tree ready for `LpdfEngine.renderPdf()` or `kitToXml()`.
+ *
+ * @example
+ * ```ts
+ * import { LpdfEngine, LpdfKit, LpdfLayout, LpdfCanvas } from 'lpdf';
+ *
+ * const doc = LpdfKit.document({
+ *   sections: [
+ *     LpdfKit.section({
+ *       nodes: [
+ *         LpdfKit.canvas([ LpdfCanvas.layer([ LpdfCanvas.rect(0, 0, 595, 842) ]) ]),
+ *         LpdfKit.layout([ LpdfLayout.text(['Hello']) ]),
+ *       ],
+ *       options: { size: 'a4', margin: '28pt' },
+ *     }),
+ *   ],
+ *   options: { meta: { title: 'My Doc' } },
+ * });
+ * const bytes = await new LpdfEngine(key).renderPdf(doc);
+ * ```
+ */
+import type { LpdfNode } from './layout';
+import type { LpdfCanvasLayerNode } from './canvas';
+export interface LpdfTokens {
+    colors?: Record<string, string>;
+    space?: Record<string, string>;
+    grid?: Record<string, string>;
+    border?: Record<string, string>;
+    radius?: Record<string, string>;
+    width?: Record<string, string>;
+    text?: Record<string, string>;
+    fonts?: Record<string, LpdfFontDef>;
+}
+export type LpdfFontDef = {
+    src: string;
+    builtin?: never;
+} | {
+    builtin: string;
+    src?: never;
+};
+export interface LpdfMeta {
+    title?: string;
+    author?: string;
+    subject?: string;
+    keywords?: string;
+    creator?: string;
+}
+export interface SectionOptions {
+    size?: string;
+    orientation?: string;
+    margin?: string;
+    background?: string;
+    title?: string;
+    debug?: string;
+}
+export interface DocumentOptions {
+    size?: string;
+    orientation?: string;
+    margin?: string;
+    background?: string;
+    tokens?: LpdfTokens;
+    meta?: LpdfMeta;
+    debug?: string;
+}
+/** A layout block — wraps an ordered list of layout nodes. */
+export interface LpdfLayoutBlock {
+    type: 'layout';
+    nodes: LpdfNode[];
+}
+/** A canvas block — wraps an ordered list of canvas layers. */
+export interface LpdfCanvasBlock {
+    type: 'canvas';
+    nodes: LpdfCanvasLayerNode[];
+}
+export interface LpdfSectionNode {
+    type: 'section';
+    attrs: Record<string, string>;
+    nodes: (LpdfLayoutBlock | LpdfCanvasBlock)[];
+}
+export interface LpdfDocument {
+    version: 1;
+    type: 'document';
+    attrs: Record<string, unknown>;
+    nodes: LpdfSectionNode[];
+}
+export interface SectionInput {
+    nodes?: (LpdfLayoutBlock | LpdfCanvasBlock)[];
+    options?: SectionOptions;
+}
+export interface DocumentInput {
+    /** Sections — serialised as `nodes` on the wire (matching kit_to_xml and parse_tree). */
+    sections?: LpdfSectionNode[];
+    options?: DocumentOptions;
+}
+declare function layout(nodes?: LpdfNode[]): LpdfLayoutBlock;
+declare function canvas(layers?: LpdfCanvasLayerNode[]): LpdfCanvasBlock;
+declare function section(input?: SectionInput): LpdfSectionNode;
+declare function document(input?: DocumentInput): LpdfDocument;
+export declare const LpdfKit: Readonly<{
+    layout: typeof layout;
+    canvas: typeof canvas;
+    section: typeof section;
+    document: typeof document;
+}>;
+export {};

package/dist/kit.js

@@ -0,0 +1,78 @@
+"use strict";
+/**
+ * LpdfKit — document skeleton assembly.
+ *
+ * Assembles sections (containing layout and canvas blocks) into a document
+ * tree ready for `LpdfEngine.renderPdf()` or `kitToXml()`.
+ *
+ * @example
+ * ```ts
+ * import { LpdfEngine, LpdfKit, LpdfLayout, LpdfCanvas } from 'lpdf';
+ *
+ * const doc = LpdfKit.document({
+ *   sections: [
+ *     LpdfKit.section({
+ *       nodes: [
+ *         LpdfKit.canvas([ LpdfCanvas.layer([ LpdfCanvas.rect(0, 0, 595, 842) ]) ]),
+ *         LpdfKit.layout([ LpdfLayout.text(['Hello']) ]),
+ *       ],
+ *       options: { size: 'a4', margin: '28pt' },
+ *     }),
+ *   ],
+ *   options: { meta: { title: 'My Doc' } },
+ * });
+ * const bytes = await new LpdfEngine(key).renderPdf(doc);
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LpdfKit = void 0;
+// ── camelCase → kebab-case helper ─────────────────────────────────────────────
+function attrKey(camel) {
+    return camel.replace(/[A-Z]/g, c => '-' + c.toLowerCase());
+}
+function buildAttrs(options) {
+    const result = {};
+    for (const [key, val] of Object.entries(options)) {
+        if (val !== undefined) {
+            result[attrKey(key)] = val;
+        }
+    }
+    return result;
+}
+// ── Factory functions ─────────────────────────────────────────────────────────
+function layout(nodes = []) {
+    return { type: 'layout', nodes };
+}
+function canvas(layers = []) {
+    return { type: 'canvas', nodes: layers };
+}
+function section(input = {}) {
+    return {
+        type: 'section',
+        attrs: buildAttrs((input.options ?? {})),
+        nodes: input.nodes ?? [],
+    };
+}
+function document(input = {}) {
+    const { tokens, meta, ...restOpts } = input.options ?? {};
+    const attrs = {
+        ...buildAttrs(restOpts),
+    };
+    if (tokens !== undefined)
+        attrs['tokens'] = tokens;
+    if (meta !== undefined)
+        attrs['meta'] = meta;
+    return {
+        version: 1,
+        type: 'document',
+        attrs,
+        nodes: input.sections ?? [],
+    };
+}
+// ── LpdfKit export ────────────────────────────────────────────────────────────
+exports.LpdfKit = Object.freeze({
+    layout,
+    canvas,
+    section,
+    document,
+});

package/dist/layout.d.ts

@@ -0,0 +1,260 @@
+import type { PageScope } from './_shared';
+export interface StackOptions {
+    gap?: string;
+    padding?: string;
+    background?: string;
+    align?: string;
+    justify?: string;
+    width?: string;
+    height?: string;
+    border?: string;
+    radius?: string;
+    debug?: string;
+}
+export interface FlankOptions {
+    gap?: string;
+    padding?: string;
+    background?: string;
+    align?: string;
+    justify?: string;
+    end?: string;
+    width?: string;
+    height?: string;
+    border?: string;
+    radius?: string;
+    debug?: string;
+}
+export interface SplitOptions {
+    gap?: string;
+    padding?: string;
+    background?: string;
+    align?: string;
+    equal?: string;
+    width?: string;
+    height?: string;
+    border?: string;
+    radius?: string;
+    debug?: string;
+}
+export interface ClusterOptions {
+    gap?: string;
+    padding?: string;
+    background?: string;
+    align?: string;
+    justify?: string;
+    width?: string;
+    height?: string;
+    border?: string;
+    radius?: string;
+    debug?: string;
+}
+export interface GridOptions {
+    cols?: string;
+    colWidth?: string;
+    gap?: string;
+    equal?: string;
+    padding?: string;
+    background?: string;
+    width?: string;
+    height?: string;
+    border?: string;
+    radius?: string;
+    debug?: string;
+}
+export interface FrameOptions {
+    width?: string;
+    height?: string;
+    padding?: string;
+    background?: string;
+    border?: string;
+    radius?: string;
+    align?: string;
+    debug?: string;
+}
+export interface LinkOptions {
+    url?: string;
+    width?: string;
+    height?: string;
+    debug?: string;
+}
+export interface TableOptions {
+    cols: string;
+    border?: string;
+    stripe?: string;
+    gap?: string;
+    padding?: string;
+    background?: string;
+    width?: string;
+    height?: string;
+    repeat?: string;
+    debug?: string;
+}
+export interface TheadOptions {
+    background?: string;
+}
+export interface TrOptions {
+    background?: string;
+}
+export interface TdOptions {
+    padding?: string;
+    background?: string;
+    align?: string;
+    valign?: string;
+    border?: string;
+    radius?: string;
+    gap?: string;
+    debug?: string;
+}
+export interface TextOptions {
+    font?: string;
+    fontSize?: string;
+    textAlign?: string;
+    color?: string;
+    bold?: string;
+    end?: string;
+    padding?: string;
+    background?: string;
+    width?: string;
+    height?: string;
+    border?: string;
+    radius?: string;
+    repeat?: string;
+    debug?: string;
+}
+export interface SpanOptions {
+    font?: string;
+    fontSize?: string;
+    color?: string;
+    bold?: string;
+    url?: string;
+    underline?: string;
+    strike?: string;
+}
+export interface DividerOptions {
+    color?: string;
+    thickness?: string;
+    direction?: string;
+    debug?: string;
+}
+export interface ImgOptions {
+    name: string;
+    height?: string;
+    width?: string;
+    font?: string;
+    fontSize?: string;
+    gap?: string;
+    padding?: string;
+    background?: string;
+    border?: string;
+    radius?: string;
+    repeat?: string;
+    debug?: string;
+}
+export interface BarcodeOptions {
+    type: string;
+    data: string;
+    size?: string;
+    width?: string;
+    height?: string;
+    ec?: string;
+    hrt?: string;
+    color?: string;
+    background?: string;
+    repeat?: string;
+    debug?: string;
+}
+export interface RegionOptions {
+    page?: PageScope | string;
+    w?: string;
+    debug?: string;
+}
+export interface LpdfSpanNode {
+    type: 'span';
+    attrs: Record<string, string>;
+    nodes: string[];
+}
+export interface LpdfContainerNode {
+    type: 'stack' | 'flank' | 'split' | 'cluster' | 'grid' | 'frame' | 'link';
+    attrs: Record<string, string>;
+    nodes: LpdfNode[];
+}
+export interface LpdfTextNode {
+    type: 'text';
+    attrs: Record<string, string>;
+    nodes: (string | LpdfSpanNode)[];
+}
+export interface LpdfDividerNode {
+    type: 'divider';
+    attrs: Record<string, string>;
+}
+export interface LpdfImgNode {
+    type: 'img';
+    attrs: Record<string, string>;
+}
+export interface LpdfBarcodeNode {
+    type: 'barcode';
+    attrs: Record<string, string>;
+}
+export interface LpdfTheadNode {
+    type: 'thead';
+    attrs: Record<string, string>;
+    nodes: LpdfTdNode[];
+}
+export interface LpdfTrNode {
+    type: 'tr';
+    attrs: Record<string, string>;
+    nodes: LpdfTdNode[];
+}
+export interface LpdfTdNode {
+    type: 'td';
+    attrs: Record<string, string>;
+    nodes: LpdfNode[];
+}
+export interface LpdfTableNode {
+    type: 'table';
+    attrs: Record<string, string>;
+    nodes: (LpdfTheadNode | LpdfTrNode)[];
+}
+export interface LpdfRegionNode {
+    type: 'layout-region';
+    attrs: Record<string, string>;
+    nodes: LpdfNode[];
+}
+export type LpdfNode = LpdfContainerNode | LpdfTextNode | LpdfDividerNode | LpdfTableNode | LpdfImgNode | LpdfBarcodeNode | LpdfRegionNode;
+declare function stack(nodes?: LpdfNode[], options?: StackOptions): LpdfContainerNode;
+declare function flank(nodes?: LpdfNode[], options?: FlankOptions): LpdfContainerNode;
+declare function split(nodes?: LpdfNode[], options?: SplitOptions): LpdfContainerNode;
+declare function cluster(nodes?: LpdfNode[], options?: ClusterOptions): LpdfContainerNode;
+declare function grid(nodes?: LpdfNode[], options?: GridOptions): LpdfContainerNode;
+declare function frame(nodes?: LpdfNode[], options?: FrameOptions): LpdfContainerNode;
+declare function link(nodes?: LpdfNode[], options?: LinkOptions): LpdfContainerNode;
+declare function table(options: TableOptions, nodes?: (LpdfTheadNode | LpdfTrNode)[]): LpdfTableNode;
+declare function thead(nodes?: LpdfTdNode[], options?: TheadOptions): LpdfTheadNode;
+declare function tr(nodes?: LpdfTdNode[], options?: TrOptions): LpdfTrNode;
+declare function td(nodes?: LpdfNode[], options?: TdOptions): LpdfTdNode;
+declare function text(nodes?: (string | LpdfSpanNode)[], options?: TextOptions): LpdfTextNode;
+declare function span(nodes?: string[], options?: SpanOptions): LpdfSpanNode;
+declare function divider(options?: DividerOptions): LpdfDividerNode;
+declare function img(options: ImgOptions): LpdfImgNode;
+declare function barcode(options: BarcodeOptions): LpdfBarcodeNode;
+declare function region(pin: string, nodes?: LpdfNode[], options?: RegionOptions): LpdfRegionNode;
+export declare const LpdfLayout: Readonly<{
+    stack: typeof stack;
+    flank: typeof flank;
+    split: typeof split;
+    cluster: typeof cluster;
+    grid: typeof grid;
+    frame: typeof frame;
+    link: typeof link;
+    text: typeof text;
+    span: typeof span;
+    divider: typeof divider;
+    img: typeof img;
+    barcode: typeof barcode;
+    table: typeof table;
+    thead: typeof thead;
+    tr: typeof tr;
+    td: typeof td;
+    region: typeof region;
+}>;
+export {};

package/dist/layout.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LpdfLayout = void 0;
+// ── camelCase → kebab-case helper ─────────────────────────────────────────────
+function attrKey(camel) {
+    return camel.replace(/[A-Z]/g, c => '-' + c.toLowerCase());
+}
+function buildAttrs(options) {
+    const result = {};
+    for (const [key, val] of Object.entries(options)) {
+        if (val !== undefined) {
+            result[attrKey(key)] = val;
+        }
+    }
+    return result;
+}
+// ── Helper ────────────────────────────────────────────────────────────────────
+function makeContainer(type, nodes, options) {
+    return { type, attrs: buildAttrs(options ?? {}), nodes };
+}
+// ── LpdfLayout factory ────────────────────────────────────────────────────────
+function stack(nodes = [], options) {
+    return makeContainer('stack', nodes, options);
+}
+function flank(nodes = [], options) {
+    return makeContainer('flank', nodes, options);
+}
+function split(nodes = [], options) {
+    return makeContainer('split', nodes, options);
+}
+function cluster(nodes = [], options) {
+    return makeContainer('cluster', nodes, options);
+}
+function grid(nodes = [], options) {
+    return makeContainer('grid', nodes, options);
+}
+function frame(nodes = [], options) {
+    return makeContainer('frame', nodes, options);
+}
+function link(nodes = [], options) {
+    return makeContainer('link', nodes, options);
+}
+function table(options, nodes = []) {
+    return {
+        type: 'table',
+        attrs: buildAttrs(options),
+        nodes,
+    };
+}
+function thead(nodes = [], options) {
+    return {
+        type: 'thead',
+        attrs: buildAttrs((options ?? {})),
+        nodes,
+    };
+}
+function tr(nodes = [], options) {
+    return {
+        type: 'tr',
+        attrs: buildAttrs((options ?? {})),
+        nodes,
+    };
+}
+function td(nodes = [], options) {
+    return {
+        type: 'td',
+        attrs: buildAttrs((options ?? {})),
+        nodes,
+    };
+}
+function text(nodes = [], options) {
+    return {
+        type: 'text',
+        attrs: buildAttrs((options ?? {})),
+        nodes,
+    };
+}
+function span(nodes = [], options) {
+    return {
+        type: 'span',
+        attrs: buildAttrs((options ?? {})),
+        nodes,
+    };
+}
+function divider(options) {
+    return {
+        type: 'divider',
+        attrs: buildAttrs((options ?? {})),
+    };
+}
+function img(options) {
+    return {
+        type: 'img',
+        attrs: buildAttrs(options),
+    };
+}
+function barcode(options) {
+    return {
+        type: 'barcode',
+        attrs: buildAttrs(options),
+    };
+}
+function region(pin, nodes = [], options) {
+    const attrs = { pin };
+    if (options?.page !== undefined)
+        attrs['page'] = options.page;
+    if (options?.w !== undefined)
+        attrs['w'] = options.w;
+    if (options?.debug !== undefined)
+        attrs['debug'] = options.debug;
+    return { type: 'layout-region', attrs, nodes };
+}
+exports.LpdfLayout = Object.freeze({
+    stack,
+    flank,
+    split,
+    cluster,
+    grid,
+    frame,
+    link,
+    text,
+    span,
+    divider,
+    img,
+    barcode,
+    table,
+    thead,
+    tr,
+    td,
+    region,
+});