@lpdfio/lpdf 0.22.0 → 0.24.0

package/README.md

@@ -2,7 +2,7 @@
 
 # @lpdfio/lpdf
 
-**Node.js SDK for [Lpdf](https://lpdf.io?utm_source=readme&utm_medium=referral&utm_campaign=sdk-node) — PDF as Code on every platform**
+**Node.js SDK for [Lpdf](https://lpdf.io?utm_campaign=sdk-node&utm_medium=referral&utm_source=readme) — PDF as Code on every platform**
 
 You describe a document as code or XML. Lpdf renders a compact, pixel-perfect PDF — identical across platforms.
 
@@ -14,8 +14,8 @@ npm install @lpdfio/lpdf
 
 ## Usage — Node.js
 
-```ts
-import { L, NoAttr } from 'lpdf'
+```js
+const { L, NoAttr } = require('@lpdfio/lpdf')
 
 const engine = L.engine()
 
@@ -38,7 +38,7 @@ const doc = L.document({ size: 'letter', margin: '48pt' }, [
     ]),
 ])
 
-const pdf = await engine.render(doc)
+engine.render(doc).then((pdf) => require('node:fs').writeFileSync('proposal.pdf', pdf))
 ```
 
 ## Requirements
@@ -48,7 +48,7 @@ const pdf = await engine.render(doc)
 
 ## Docs
 
-[lpdf.io/docs](https://lpdf.io/docs/?sdk=js&p=install&utm_source=readme&utm_medium=referral&utm_campaign=sdk-node)
+[lpdf.io/docs](https://lpdf.io/docs/install/?sdk=js&utm_campaign=sdk-node&utm_medium=referral&utm_source=readme)
 
 ## Issues
 

package/dist/L.d.ts

@@ -1,4 +1,4 @@
-import type { LpdfTokens, PdfDocument } from './kit';
+import type { DocumentAssets, DocumentTokens, PdfDocument } from './kit';
 import { PdfEngine } from './engine';
 /** Pass as `attrs` when a node has no attributes. Equivalent to `null`. */
 export declare const NoAttr: null;
@@ -11,7 +11,7 @@ export declare const NoAttr: null;
  *
  * @example
  * ```ts
- * import { L, NoAttr } from 'lpdf';
+ * const { L, NoAttr } = require('@lpdfio/lpdf');
  *
  * const engine = L.engine().setLicenseKey(process.env.LPDF_KEY);
  *
@@ -29,35 +29,36 @@ export declare const L: Readonly<{
     engine: () => PdfEngine;
     /** 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;
-    layout: (_attrs: null, nodes: import("./layout").LpdfNode[]) => import("./kit").LpdfLayoutBlock;
-    canvas: (_attrs: null, layers: import("./canvas").LpdfCanvasLayerNode[]) => import("./kit").LpdfCanvasBlock;
-    tokens: (attrs: LpdfTokens) => LpdfTokens;
-    stack: (attrs: import("./layout").StackAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    flank: (attrs: import("./layout").FlankAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    split: (attrs: import("./layout").SplitAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    cluster: (attrs: import("./layout").ClusterAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    grid: (attrs: import("./layout").GridAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    frame: (attrs: import("./layout").FrameAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    link: (attrs: import("./layout").LinkAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfContainerNode;
-    table: (attrs: import("./layout").TableAttr, nodes: (import("./layout").LpdfTheadNode | import("./layout").LpdfTrNode)[]) => import("./layout").LpdfTableNode;
-    thead: (attrs: import("./layout").TheadAttr | null, nodes: import("./layout").LpdfTdNode[]) => import("./layout").LpdfTheadNode;
-    tr: (attrs: import("./layout").TrAttr | null, nodes: import("./layout").LpdfTdNode[]) => import("./layout").LpdfTrNode;
-    td: (attrs: import("./layout").TdAttr | null, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfTdNode;
-    text: (attrs: import("./layout").TextAttr | null, nodes: (string | import("./layout").LpdfSpanNode)[]) => import("./layout").LpdfTextNode;
-    span: (attrs: import("./layout").SpanAttr | null, nodes: string[]) => import("./layout").LpdfSpanNode;
-    divider: (attrs: import("./layout").DividerAttr | null) => import("./layout").LpdfDividerNode;
-    img: (attrs: import("./layout").ImgAttr) => import("./layout").LpdfImgNode;
-    barcode: (attrs: import("./layout").BarcodeAttr) => import("./layout").LpdfBarcodeNode;
-    region: (attrs: import("./layout").RegionAttr, nodes: import("./layout").LpdfNode[]) => import("./layout").LpdfRegionNode;
-    field: (type: string, name: string, attrs?: import("./layout").FieldAttr | null) => import("./layout").LpdfFieldNode;
-    layer: (attrs: import("./canvas").LayerAttr | null, nodes: import("./canvas").LpdfCanvasPrimitiveNode[]) => import("./canvas").LpdfCanvasLayerNode;
-    rect: (x: number, y: number, w: number, h: number, style?: import("./canvas").CanvasRectStyle) => import("./canvas").LpdfCanvasRectNode;
-    line: (x1: number, y1: number, x2: number, y2: number, style?: import("./canvas").CanvasLineStyle) => import("./canvas").LpdfCanvasLineNode;
-    ellipse: (cx: number, cy: number, rx: number, ry: number, style?: import("./canvas").CanvasEllipseStyle) => import("./canvas").LpdfCanvasEllipseNode;
-    circle: (cx: number, cy: number, r: number, style?: import("./canvas").CanvasEllipseStyle) => import("./canvas").LpdfCanvasCircleNode;
-    path: (d: string, style?: import("./canvas").CanvasPathStyle) => import("./canvas").LpdfCanvasPathNode;
-    textAt: (x: number, y: number, content: string, style?: import("./canvas").CanvasTextStyle, runs?: import("./canvas").CanvasRun[]) => import("./canvas").LpdfCanvasTextNode;
-    imgAt: (x: number, y: number, w: number, h: number, name: string, anchor?: string) => import("./canvas").LpdfCanvasImgNode;
+    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;
+    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;
+    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;
+    table: (attrs: import("./attrs").TableAttr, nodes?: (import("./layout").LpdfTheadNode | import("./layout").LpdfTrNode)[]) => import("./layout").LpdfTableNode;
+    thead: (attrs: import("./attrs").TheadAttr | null, nodes?: import("./layout").LpdfTdNode[]) => import("./layout").LpdfTheadNode;
+    tr: (attrs: import("./attrs").TrAttr | null, nodes?: import("./layout").LpdfTdNode[]) => import("./layout").LpdfTrNode;
+    td: (attrs: import("./attrs").TdAttr | null, nodes?: import("./layout").LpdfNode[]) => import("./layout").LpdfTdNode;
+    text: (attrs: import("./attrs").TextAttr | null, nodes?: (string | import("./layout").LpdfSpanNode)[]) => import("./layout").LpdfTextNode;
+    span: (attrs: import("./attrs").SpanAttr | null, nodes?: string[]) => import("./layout").LpdfSpanNode;
+    divider: (attrs?: import("./attrs").DividerAttr | null) => import("./layout").LpdfDividerNode;
+    img: (attrs: import("./attrs").ImgAttr) => import("./layout").LpdfImgNode;
+    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;
+    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;
+    ellipse: (attrs: import("./attrs").EllipseAttr) => import("./canvas").LpdfCanvasEllipseNode;
+    circle: (attrs: import("./attrs").CircleAttr) => import("./canvas").LpdfCanvasCircleNode;
+    path: (attrs: import("./attrs").PathAttr) => import("./canvas").LpdfCanvasPathNode;
+    textAt: (attrs: import("./attrs").CanvasTextAttr, nodes?: (string | import("./layout").LpdfSpanNode)[]) => import("./canvas").LpdfCanvasTextNode;
+    imgAt: (attrs: import("./attrs").CanvasImgAttr) => import("./canvas").LpdfCanvasImgNode;
 }>;

package/dist/L.js

@@ -17,7 +17,7 @@ exports.NoAttr = null;
  *
  * @example
  * ```ts
- * import { L, NoAttr } from 'lpdf';
+ * const { L, NoAttr } = require('@lpdfio/lpdf');
  *
  * const engine = L.engine().setLicenseKey(process.env.LPDF_KEY);
  *
@@ -40,6 +40,7 @@ exports.L = Object.freeze({
     section: kit_1.LpdfKit.section,
     layout: kit_1.LpdfKit.layout,
     canvas: kit_1.LpdfKit.canvas,
+    assets: (attrs) => attrs,
     tokens: (attrs) => attrs,
     // ── Layout ────────────────────────────────────────────────────────────────
     stack: layout_1.LpdfLayout.stack,

package/dist/_shared.d.ts

@@ -19,7 +19,8 @@ export interface RenderOptions {
     data?: Record<string, unknown> | null;
 }
 /**
- * Page scope for canvas layers and layout regions.
- * Numeric ranges (e.g. '2-4', '1,3-5', '2-last') remain as plain strings.
+ * The attributes of an element: an attribute object's own properties, with each camelCase name
+ * written as the schema's kebab-case one (`fontSize` as `font-size`) and each value as a string.
+ * Properties that are `undefined` are left out.
  */
-export type PageScope = 'each' | 'first' | 'last' | 'odd' | 'even';
+export declare function buildAttrs(options: object | null | undefined): Record<string, string>;

package/dist/_shared.js

@@ -3,3 +3,18 @@
  * Shared types used by both the Node.js and browser entry points.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAttrs = buildAttrs;
+/**
+ * The attributes of an element: an attribute object's own properties, with each camelCase name
+ * written as the schema's kebab-case one (`fontSize` as `font-size`) and each value as a string.
+ * Properties that are `undefined` are left out.
+ */
+function buildAttrs(options) {
+    const result = {};
+    for (const [key, value] of Object.entries(options ?? {})) {
+        if (value !== undefined && value !== null) {
+            result[key.replace(/[A-Z]/g, c => '-' + c.toLowerCase())] = String(value);
+        }
+    }
+    return result;
+}