@lpdfio/lpdf 0.24.0 → 0.26.0

package/README.md

@@ -22,16 +22,16 @@ const engine = L.engine()
 const doc = L.document({ size: 'letter', margin: '48pt' }, [
     L.section(NoAttr, [
         L.layout(NoAttr, [
-            L.stack({ gap: '24pt' }, [
-                L.split(NoAttr, [
+            L.column({ gap: '24pt' }, [
+                L.row({ justify: 'between' }, [
                     L.text({ fontSize: '8pt', color: '#888888' }, ['ACME CORP']),
                     L.text({ fontSize: '22pt', bold: 'true' }, ['Project Proposal']),
                 ]),
                 L.divider({ thickness: 'xs' }),
                 L.text({ fontSize: '13pt', bold: 'true' }, ['Scope of Work']),
-                L.flank({ gap: '12pt', align: 'start' }, [
+                L.row({ gap: '12pt', align: 'start' }, [
                     L.text({ color: '#888888', width: '24pt' }, ['01']),
-                    L.text(NoAttr, ['Discovery & Research']),
+                    L.text({ width: 'fill' }, ['Discovery & Research']),
                 ]),
             ]),
         ]),

package/dist/L.d.ts

@@ -30,15 +30,13 @@ export declare const L: Readonly<{
     /** Convert a `PdfDocument` tree to an lpdf XML string. */
     toXml: (doc: PdfDocument) => string;
     document: (attrs: import("./kit").DocumentAttr | null, nodes?: import("./kit").LpdfSectionNode[]) => PdfDocument;
-    section: (attrs: import("./kit").SectionAttr | null, nodes?: (import("./kit").LpdfLayoutBlock | import("./kit").LpdfCanvasBlock)[]) => import("./kit").LpdfSectionNode;
+    section: (attrs: import("./kit").SectionAttr | null, nodes?: (import("./layout").LpdfBookmarkNode | import("./kit").LpdfLayoutBlock | import("./kit").LpdfCanvasBlock)[]) => import("./kit").LpdfSectionNode;
     layout: (_attrs: null, nodes?: import("./layout").LpdfNode[]) => import("./kit").LpdfLayoutBlock;
     canvas: (_attrs: null, layers?: import("./canvas").LpdfCanvasLayerNode[]) => import("./kit").LpdfCanvasBlock;
     assets: (attrs: DocumentAssets) => DocumentAssets;
     tokens: (attrs: DocumentTokens) => DocumentTokens;
-    stack: (attrs: import("./attrs").StackAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    flank: (attrs: import("./attrs").FlankAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    split: (attrs: import("./attrs").SplitAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    cluster: (attrs: import("./attrs").ClusterAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
+    column: (attrs: import("./attrs").ColumnAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
+    row: (attrs: import("./attrs").RowAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
     grid: (attrs: import("./attrs").GridAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
     frame: (attrs: import("./attrs").FrameAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
     link: (attrs: import("./attrs").LinkAttr, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
@@ -53,6 +51,7 @@ export declare const L: Readonly<{
     barcode: (attrs: import("./attrs").BarcodeAttr) => import("./layout").LpdfBarcodeNode;
     region: (attrs: import("./attrs").RegionAttr, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfRegionNode;
     field: (attrs: import("./attrs").FieldAttr) => import("./layout").LpdfFieldNode;
+    bookmark: (attrs: import("./attrs").BookmarkAttr) => import("./layout").LpdfBookmarkNode;
     layer: (attrs: import("./attrs").LayerAttr | null, nodes?: import("./canvas").LpdfCanvasPrimitiveNode[]) => import("./canvas").LpdfCanvasLayerNode;
     rect: (attrs: import("./attrs").RectAttr) => import("./canvas").LpdfCanvasRectNode;
     line: (attrs: import("./attrs").LineAttr) => import("./canvas").LpdfCanvasLineNode;

package/dist/L.js

@@ -43,10 +43,8 @@ exports.L = Object.freeze({
     assets: (attrs) => attrs,
     tokens: (attrs) => attrs,
     // ── Layout ────────────────────────────────────────────────────────────────
-    stack: layout_1.LpdfLayout.stack,
-    flank: layout_1.LpdfLayout.flank,
-    split: layout_1.LpdfLayout.split,
-    cluster: layout_1.LpdfLayout.cluster,
+    column: layout_1.LpdfLayout.column,
+    row: layout_1.LpdfLayout.row,
     grid: layout_1.LpdfLayout.grid,
     frame: layout_1.LpdfLayout.frame,
     link: layout_1.LpdfLayout.link,
@@ -61,6 +59,7 @@ exports.L = Object.freeze({
     barcode: layout_1.LpdfLayout.barcode,
     region: layout_1.LpdfLayout.region,
     field: layout_1.LpdfLayout.field,
+    bookmark: layout_1.LpdfLayout.bookmark,
     // ── Canvas ────────────────────────────────────────────────────────────────
     layer: canvas_1.LpdfCanvas.layer,
     rect: canvas_1.LpdfCanvas.rect,

package/dist/attrs.d.ts

@@ -2,7 +2,7 @@
  * Places children top to bottom, each at the full width, with gap between them. Can split across
  * pages between children.
  */
-export interface StackAttr {
+export interface ColumnAttr {
     font?: string;
     fontSize?: string;
     gap?: string;
@@ -33,55 +33,20 @@ export interface StackAttr {
     debug?: string;
     align?: string;
     justify?: string;
-    width?: string;
-}
-/**
- * One row where the children keep their own width except one, which fills the rest. By default the
- * last child fills; set end to true and the first fills. Never splits across pages.
- */
-export interface FlankAttr {
-    font?: string;
-    fontSize?: string;
-    gap?: string;
-    /**
-     * Space between the edge of the box and its content, written like CSS: one value for all sides,
-     * two for top-bottom and left-right, three for top, left-right and bottom, four for top, right,
-     * bottom and left.
-     */
-    padding?: string;
-    /**
-     * Height of the box. Leave it out to size to the content. A length fixes it; fill takes what is
-     * left after its siblings (shared equally if several use fill); full takes all the height
-     * available. Any of these stops the box splitting across pages.
-     */
-    height?: string;
-    background?: string;
-    border?: string;
-    radius?: string;
-    /**
-     * Where the box falls in the page flow. no: never split the box, and move it whole to the next
-     * page when it does not fit. break-before: start it on a new page. break-after: start the next
-     * sibling on a new page. keep-next: keep it on one page with the sibling that follows, moving
-     * both to the next page if that sibling would not fit. break-before, break-after and keep-next
-     * take effect on the children of layout; on a box inside another box they are not applied. no
-     * applies at any depth.
-     */
-    paginate?: string;
-    debug?: string;
-    align?: string;
     /**
-     * false (the default): every child but the last keeps its own width at the left, and the last
-     * fills the rest. true: the first child fills, and the others keep their own width at the right.
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
      */
-    end?: string;
     width?: string;
 }
 /**
- * Two children side by side; any further children are ignored. By default each keeps its own width,
- * the first at the left edge and the second at the right. With equal set to true they take half the
- * width each. Never splits across pages.
+ * Children side by side, continuing on the next line when they run out of width. A child with width
+ * set to fill takes what its line leaves; justify set to between puts a line's first child at the
+ * left edge, its last at the right and the others evenly between. Splits across pages between
+ * lines.
  */
-export interface SplitAttr {
+export interface RowAttr {
     font?: string;
     fontSize?: string;
     gap?: string;
@@ -111,48 +76,12 @@ export interface SplitAttr {
     paginate?: string;
     debug?: string;
     align?: string;
+    justify?: string;
     /**
-     * false (the default): each child keeps its own width, the first at the left edge and the second
-     * at the right edge. true: the two children share the width in equal halves.
-     */
-    equal?: string;
-    width?: string;
-}
-/**
- * A row that wraps: children sit side by side, and continue on the next line when they run out of
- * width. Splits across pages between lines.
- */
-export interface ClusterAttr {
-    font?: string;
-    fontSize?: string;
-    gap?: string;
-    /**
-     * Space between the edge of the box and its content, written like CSS: one value for all sides,
-     * two for top-bottom and left-right, three for top, left-right and bottom, four for top, right,
-     * bottom and left.
-     */
-    padding?: string;
-    /**
-     * Height of the box. Leave it out to size to the content. A length fixes it; fill takes what is
-     * left after its siblings (shared equally if several use fill); full takes all the height
-     * available. Any of these stops the box splitting across pages.
-     */
-    height?: string;
-    background?: string;
-    border?: string;
-    radius?: string;
-    /**
-     * Where the box falls in the page flow. no: never split the box, and move it whole to the next
-     * page when it does not fit. break-before: start it on a new page. break-after: start the next
-     * sibling on a new page. keep-next: keep it on one page with the sibling that follows, moving
-     * both to the next page if that sibling would not fit. break-before, break-after and keep-next
-     * take effect on the children of layout; on a box inside another box they are not applied. no
-     * applies at any depth.
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
      */
-    paginate?: string;
-    debug?: string;
-    align?: string;
-    justify?: string;
     width?: string;
 }
 /**
@@ -188,6 +117,11 @@ export interface GridAttr {
      */
     paginate?: string;
     debug?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
     colWidth?: string;
     cols?: string;
@@ -224,14 +158,28 @@ export interface FrameAttr {
      */
     paginate?: string;
     debug?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
 }
 /**
  * Attributes of the `link` element.
  */
 export interface LinkAttr {
+    /**
+     * Where the link goes: a URL, or #id to jump to the bookmark with that id. In an entry of a table
+     * of contents, # alone jumps to that entry's bookmark.
+     */
     href: string;
     gap?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
     height?: string;
     debug?: string;
@@ -243,6 +191,12 @@ export interface DividerAttr {
     direction?: string;
     color?: string;
     thickness?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
+    width?: string;
     debug?: string;
 }
 /**
@@ -252,6 +206,10 @@ export interface SpanAttr {
     font?: string;
     bold?: string;
     color?: string;
+    /**
+     * Makes the span a link: a URL, or #id to jump to the bookmark with that id. In an entry of a
+     * table of contents, # alone jumps to that entry's bookmark.
+     */
     href?: string;
     underline?: string;
     strike?: string;
@@ -262,6 +220,11 @@ export interface SpanAttr {
 export interface ImgAttr {
     name: string;
     height?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
     font?: string;
     fontSize?: string;
@@ -280,6 +243,11 @@ export interface BarcodeAttr {
     type: string;
     data: string;
     size?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
     height?: string;
     ec?: string;
@@ -304,7 +272,25 @@ export interface TextAttr {
     bold?: string;
     color?: string;
     align?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
+    /**
+     * The fewest lines of the text that may stand alone at the top of the next page when it splits.
+     * Default 2. If fewer would be left, lines move from the first page to the next; 1 turns the
+     * protection off.
+     */
+    widows?: string;
+    /**
+     * The fewest lines of the text that may stand alone at the bottom of a page when it splits.
+     * Default 2. If fewer would fit, the whole text moves to the next page; 1 turns the protection
+     * off. When no split can keep both widows and orphans, even on an empty page, the text splits
+     * where the lines fit.
+     */
+    orphans?: string;
     paginate?: string;
     debug?: string;
 }
@@ -369,6 +355,11 @@ export interface TableAttr {
     gap?: string;
     padding?: string;
     background?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
     height?: string;
     paginate?: string;
@@ -389,12 +380,38 @@ export interface FieldAttr {
     readonly?: string;
     maxLen?: string;
     actionUrl?: string;
+    /**
+     * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
+     * the other children, shared equally if several on the line use fill, and never moves to the next
+     * line; in a column it takes the full width.
+     */
     width?: string;
     height?: string;
     background?: string;
     border?: string;
     debug?: string;
 }
+/**
+ * An entry of the PDF's outline, the bookmark panel of a viewer, and a target for links with
+ * href="#id". It draws nothing and marks the element that follows it, so it is never left at the
+ * bottom of a page apart from that element. Directly inside a section, it marks the section's first
+ * page.
+ */
+export interface BookmarkAttr {
+    /** The text of the entry, in the outline and in a table of contents. */
+    label: string;
+    /**
+     * Depth in the outline, 1 to 6. Defaults to 1. An entry nests under the closest entry before it
+     * with a lower level.
+     */
+    level?: string;
+    /**
+     * The name links use to jump here, as href="#id". Leave it out to make it from the label:
+     * lowercase, with other characters than letters and digits turned into hyphens, and -2, -3 added
+     * when an earlier bookmark has it. Two bookmarks may not have the same id.
+     */
+    id?: string;
+}
 /**
  * Pins content to the top or bottom edge of pages, outside the normal flow, for headers and
  * footers. It reserves that space on every page it appears on. Only allowed directly inside layout,

package/dist/browser.js

@@ -410,6 +410,9 @@ var Orientation = {
   Portrait: "portrait",
   Landscape: "landscape"
 };
+var SectionType = {
+  Toc: "toc"
+};
 var BuiltinFont = {
   Courier: "Courier",
   CourierBold: "Courier-Bold",
@@ -491,5 +494,6 @@ export {
   Orientation,
   PageScope,
   Pin,
+  SectionType,
   initLpdf
 };

package/dist/constants.d.ts

@@ -21,6 +21,11 @@ export declare const Orientation: {
     readonly Landscape: "landscape";
 };
 export type Orientation = (typeof Orientation)[keyof typeof Orientation];
+/** The values of the `type` attribute of a section. */
+export declare const SectionType: {
+    readonly Toc: "toc";
+};
+export type SectionType = (typeof SectionType)[keyof typeof SectionType];
 /** The values of the `core` attribute of a font: the built-in PDF fonts, which need no file. */
 export declare const BuiltinFont: {
     readonly Courier: "Courier";

package/dist/constants.js

@@ -2,7 +2,7 @@
 // Generated from lpdf.xsd by scripts/gen-sdk-api.mjs.
 // Do not edit: change the schema and run `make gen-sdk-api`.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageScope = exports.BuiltinFont = exports.Orientation = exports.Pin = exports.FieldType = void 0;
+exports.PageScope = exports.BuiltinFont = exports.SectionType = exports.Orientation = exports.Pin = exports.FieldType = void 0;
 /** The values of the `type` attribute of a field. */
 exports.FieldType = {
     Text: 'text',
@@ -23,6 +23,10 @@ exports.Orientation = {
     Portrait: 'portrait',
     Landscape: 'landscape',
 };
+/** The values of the `type` attribute of a section. */
+exports.SectionType = {
+    Toc: 'toc',
+};
 /** The values of the `core` attribute of a font: the built-in PDF fonts, which need no file. */
 exports.BuiltinFont = {
     Courier: 'Courier',

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 export { PdfEngine, LpdfRenderError } from './engine';
 export type { EncryptPermissions, EncryptOptions } from './engine';
 export type { RenderOptions, EngineOptions } from './_shared';
-export { FieldType, Pin, Orientation, BuiltinFont, PageScope } from './constants';
+export { FieldType, Pin, Orientation, SectionType, BuiltinFont, PageScope } from './constants';
 export type { PdfDocument, LpdfSectionNode, LpdfLayoutBlock, LpdfCanvasBlock, DocumentTokens, DocumentAssets, DocumentMeta, SectionAttr, DocumentAttr, } from './kit';
-export type { StackAttr, FlankAttr, SplitAttr, ClusterAttr, GridAttr, FrameAttr, LinkAttr, TableAttr, TheadAttr, TrAttr, TdAttr, TextAttr, SpanAttr, DividerAttr, ImgAttr, BarcodeAttr, RegionAttr, FieldAttr, LayerAttr, RectAttr, CircleAttr, EllipseAttr, LineAttr, PathAttr, CanvasTextAttr, CanvasImgAttr, FontAttr, ImageAttr, } from './attrs';
-export type { LpdfNode, LpdfContainerNode, LpdfTextNode, LpdfSpanNode, LpdfDividerNode, LpdfImgNode, LpdfBarcodeNode, LpdfTableNode, LpdfTheadNode, LpdfTrNode, LpdfTdNode, LpdfRegionNode, LpdfFieldNode, } from './layout';
+export type { ColumnAttr, RowAttr, GridAttr, FrameAttr, LinkAttr, TableAttr, TheadAttr, TrAttr, TdAttr, TextAttr, SpanAttr, DividerAttr, ImgAttr, BarcodeAttr, RegionAttr, FieldAttr, BookmarkAttr, LayerAttr, RectAttr, CircleAttr, EllipseAttr, LineAttr, PathAttr, CanvasTextAttr, CanvasImgAttr, FontAttr, ImageAttr, } from './attrs';
+export type { LpdfNode, LpdfContainerNode, LpdfTextNode, LpdfSpanNode, LpdfDividerNode, LpdfImgNode, LpdfBarcodeNode, LpdfTableNode, LpdfTheadNode, LpdfTrNode, LpdfTdNode, LpdfRegionNode, LpdfFieldNode, LpdfBookmarkNode, } from './layout';
 export { CanvasTransform } from './canvas';
 export type { LpdfCanvasLayerNode, LpdfCanvasPrimitiveNode, LpdfCanvasRectNode, LpdfCanvasLineNode, LpdfCanvasEllipseNode, LpdfCanvasCircleNode, LpdfCanvasPathNode, LpdfCanvasTextNode, LpdfCanvasImgNode, } from './canvas';
 export { L, NoAttr } from './L';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoAttr = exports.L = exports.CanvasTransform = exports.PageScope = exports.BuiltinFont = exports.Orientation = exports.Pin = exports.FieldType = exports.LpdfRenderError = exports.PdfEngine = void 0;
+exports.NoAttr = exports.L = exports.CanvasTransform = exports.PageScope = exports.BuiltinFont = exports.SectionType = exports.Orientation = exports.Pin = exports.FieldType = exports.LpdfRenderError = exports.PdfEngine = void 0;
 // ── Engine ────────────────────────────────────────────────────────────────────
 var engine_1 = require("./engine");
 Object.defineProperty(exports, "PdfEngine", { enumerable: true, get: function () { return engine_1.PdfEngine; } });
@@ -10,6 +10,7 @@ var constants_1 = require("./constants");
 Object.defineProperty(exports, "FieldType", { enumerable: true, get: function () { return constants_1.FieldType; } });
 Object.defineProperty(exports, "Pin", { enumerable: true, get: function () { return constants_1.Pin; } });
 Object.defineProperty(exports, "Orientation", { enumerable: true, get: function () { return constants_1.Orientation; } });
+Object.defineProperty(exports, "SectionType", { enumerable: true, get: function () { return constants_1.SectionType; } });
 Object.defineProperty(exports, "BuiltinFont", { enumerable: true, get: function () { return constants_1.BuiltinFont; } });
 Object.defineProperty(exports, "PageScope", { enumerable: true, get: function () { return constants_1.PageScope; } });
 // ── Canvas types ──────────────────────────────────────────────────────────────

package/dist/kit.d.ts

@@ -23,7 +23,7 @@
  * const bytes = await new LpdfEngine(key).renderPdf(doc);
  * ```
  */
-import type { LpdfNode } from './layout';
+import type { LpdfBookmarkNode, LpdfNode } from './layout';
 import type { LpdfCanvasLayerNode } from './canvas';
 import type { FontAttr, ImageAttr } from './attrs';
 export interface DocumentTokens {
@@ -57,6 +57,8 @@ export interface SectionAttr {
     background?: string;
     title?: string;
     debug?: string;
+    type?: string;
+    tocIndentStep?: string;
 }
 export interface DocumentAttr {
     size?: string;
@@ -82,7 +84,7 @@ export interface LpdfCanvasBlock {
 export interface LpdfSectionNode {
     type: 'section';
     attrs: Record<string, string>;
-    nodes: (LpdfLayoutBlock | LpdfCanvasBlock)[];
+    nodes: (LpdfBookmarkNode | LpdfLayoutBlock | LpdfCanvasBlock)[];
 }
 export interface PdfDocument {
     version: 1;
@@ -92,7 +94,7 @@ export interface PdfDocument {
 }
 declare function layout(_attrs: null, nodes?: LpdfNode[]): LpdfLayoutBlock;
 declare function canvas(_attrs: null, layers?: LpdfCanvasLayerNode[]): LpdfCanvasBlock;
-declare function section(attrs: SectionAttr | null, nodes?: (LpdfLayoutBlock | LpdfCanvasBlock)[]): LpdfSectionNode;
+declare function section(attrs: SectionAttr | null, nodes?: (LpdfBookmarkNode | LpdfLayoutBlock | LpdfCanvasBlock)[]): LpdfSectionNode;
 declare function document(attrs: DocumentAttr | null, nodes?: LpdfSectionNode[]): PdfDocument;
 export declare const LpdfKit: Readonly<{
     layout: typeof layout;

package/dist/layout.d.ts

@@ -1,11 +1,11 @@
-import type { StackAttr, FlankAttr, SplitAttr, ClusterAttr, GridAttr, FrameAttr, LinkAttr, TableAttr, TheadAttr, TrAttr, TdAttr, TextAttr, SpanAttr, DividerAttr, ImgAttr, BarcodeAttr, FieldAttr, RegionAttr } from './attrs';
+import type { ColumnAttr, RowAttr, GridAttr, FrameAttr, LinkAttr, TableAttr, TheadAttr, TrAttr, TdAttr, TextAttr, SpanAttr, DividerAttr, ImgAttr, BarcodeAttr, FieldAttr, RegionAttr, BookmarkAttr } from './attrs';
 export interface LpdfSpanNode {
     type: 'span';
     attrs: Record<string, string>;
     nodes: string[];
 }
 export interface LpdfContainerNode {
-    type: 'stack' | 'flank' | 'split' | 'cluster' | 'grid' | 'frame' | 'link';
+    type: 'column' | 'row' | 'grid' | 'frame' | 'link';
     attrs: Record<string, string>;
     nodes: LpdfNode[];
 }
@@ -55,11 +55,14 @@ export interface LpdfFieldNode {
     type: 'field';
     attrs: Record<string, string>;
 }
-export type LpdfNode = LpdfContainerNode | LpdfTextNode | LpdfDividerNode | LpdfTableNode | LpdfImgNode | LpdfBarcodeNode | LpdfRegionNode | LpdfFieldNode;
-declare function stack(attrs: StackAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
-declare function flank(attrs: FlankAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
-declare function split(attrs: SplitAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
-declare function cluster(attrs: ClusterAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
+/** An outline entry and link target that marks the node after it; it draws nothing. */
+export interface LpdfBookmarkNode {
+    type: 'bookmark';
+    attrs: Record<string, string>;
+}
+export type LpdfNode = LpdfContainerNode | LpdfTextNode | LpdfDividerNode | LpdfTableNode | LpdfImgNode | LpdfBarcodeNode | LpdfRegionNode | LpdfFieldNode | LpdfBookmarkNode;
+declare function column(attrs: ColumnAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
+declare function row(attrs: RowAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
 declare function grid(attrs: GridAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
 declare function frame(attrs: FrameAttr | null, nodes?: LpdfNode[]): LpdfContainerNode;
 declare function link(attrs: LinkAttr, nodes?: LpdfNode[]): LpdfContainerNode;
@@ -74,11 +77,14 @@ declare function img(attrs: ImgAttr): LpdfImgNode;
 declare function barcode(attrs: BarcodeAttr): LpdfBarcodeNode;
 declare function region(attrs: RegionAttr, nodes?: LpdfNode[]): LpdfRegionNode;
 declare function field(attrs: FieldAttr): LpdfFieldNode;
+/**
+ * An entry of the PDF's outline and a target for `href: '#id'` links. It marks the node that follows it
+ * in the same list; directly in a section's nodes, it marks the section's first page.
+ */
+declare function bookmark(attrs: BookmarkAttr): LpdfBookmarkNode;
 export declare const LpdfLayout: Readonly<{
-    stack: typeof stack;
-    flank: typeof flank;
-    split: typeof split;
-    cluster: typeof cluster;
+    column: typeof column;
+    row: typeof row;
     grid: typeof grid;
     frame: typeof frame;
     link: typeof link;
@@ -93,5 +99,6 @@ export declare const LpdfLayout: Readonly<{
     td: typeof td;
     region: typeof region;
     field: typeof field;
+    bookmark: typeof bookmark;
 }>;
 export {};

package/dist/layout.js

@@ -7,17 +7,11 @@ function makeContainer(type, attrs, nodes) {
     return { type, attrs: (0, _shared_1.buildAttrs)(attrs), nodes };
 }
 // ── LpdfLayout factory ────────────────────────────────────────────────────────
-function stack(attrs, nodes = []) {
-    return makeContainer('stack', attrs, nodes);
+function column(attrs, nodes = []) {
+    return makeContainer('column', attrs, nodes);
 }
-function flank(attrs, nodes = []) {
-    return makeContainer('flank', attrs, nodes);
-}
-function split(attrs, nodes = []) {
-    return makeContainer('split', attrs, nodes);
-}
-function cluster(attrs, nodes = []) {
-    return makeContainer('cluster', attrs, nodes);
+function row(attrs, nodes = []) {
+    return makeContainer('row', attrs, nodes);
 }
 function grid(attrs, nodes = []) {
     return makeContainer('grid', attrs, nodes);
@@ -61,11 +55,16 @@ function region(attrs, nodes = []) {
 function field(attrs) {
     return { type: 'field', attrs: (0, _shared_1.buildAttrs)(attrs) };
 }
+/**
+ * An entry of the PDF's outline and a target for `href: '#id'` links. It marks the node that follows it
+ * in the same list; directly in a section's nodes, it marks the section's first page.
+ */
+function bookmark(attrs) {
+    return { type: 'bookmark', attrs: (0, _shared_1.buildAttrs)(attrs) };
+}
 exports.LpdfLayout = Object.freeze({
-    stack,
-    flank,
-    split,
-    cluster,
+    column,
+    row,
     grid,
     frame,
     link,
@@ -80,4 +79,5 @@ exports.LpdfLayout = Object.freeze({
     td,
     region,
     field,
+    bookmark,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lpdfio/lpdf",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "description": "Node.js SDK for Lpdf — PDF as Code on every platform. You describe a document as code or XML. Lpdf renders a compact, pixel-perfect PDF — identical across platforms.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",