@jasy/pdf 1.0.0-alpha.1 → 1.0.0-alpha.3

package/dist/api/text.d.ts

@@ -1,5 +1,8 @@
-import { TextElement, TextSegment } from "../elements/text-element";
-import { ColorInput } from "./color";
+import { TextElement, TextSegment } from "../elements/text-element.js";
+import { TextOverflow } from "../text/line-breaker.js";
+import { ResolvedTextStyle } from "../text/text-style.js";
+import { ColorInput } from "./color.js";
+export type { TextOverflow };
 /** Text styling shared by `Text`, `Paragraph` and `span`. `bold`/`italic` are booleans
  *  (locked §7.3) and combine into one engine `FontStyle`. */
 export interface TextStyle {
@@ -12,6 +15,14 @@ export interface TextStyle {
 export interface TextOptions extends TextStyle {
     /** Text-internal alignment (left/center/right) - independent of a parent's `cross` (§5). */
     align?: "left" | "center" | "right";
+    /** Cap the number of wrapped lines (default: unlimited - the text grows down as far as it needs,
+     *  paginating onto the next page). Needs a bounded width (a Column/Expanded/`Box({ width })`). */
+    maxLines?: number;
+    /** What happens past `maxLines`: `"clip"` (default) cuts hard, `"ellipsis"` ends with "…". */
+    overflow?: TextOverflow;
+    /** Line-height multiplier (default `1`). `1.4` gives roomier body copy; each line is
+     *  `size * lineHeight` tall. */
+    lineHeight?: number;
 }
 /**
  * An inline run for mixed-style `Text` (`Text([span("a", {bold:true}), span("b")])`). Each
@@ -26,3 +37,17 @@ export declare function span(text: string, style?: TextStyle): TextSegment;
 export declare function Text(content: string | TextSegment[], opts?: TextOptions): TextElement;
 /** `Text` with body-paragraph defaults (same options; a separate name reads as intent). */
 export declare function Paragraph(content: string | TextSegment[], opts?: TextOptions): TextElement;
+/** The inheritable text defaults a `Document` can set, using the same option names as `Text`.
+ *  Unset fields stay out so they keep inheriting. */
+export interface TextDefaults {
+    size?: number;
+    font?: string;
+    bold?: boolean;
+    italic?: boolean;
+    color?: ColorInput;
+    align?: "left" | "center" | "right";
+    lineHeight?: number;
+}
+/** Maps the `Text`-style option names onto a partial engine `ResolvedTextStyle` (only the set
+ *  fields), for seeding the inheritance cascade. */
+export declare function toTextStyleOverride(opts: TextDefaults): Partial<ResolvedTextStyle>;

package/dist/api/text.js

@@ -1,34 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.span = span;
-exports.Text = Text;
-exports.Paragraph = Paragraph;
-const text_element_1 = require("../elements/text-element");
-const pdf_element_1 = require("../elements/pdf-element");
-const pdf_object_manager_1 = require("../utils/pdf-object-manager");
-const color_1 = require("./color");
-/** Body-text default size when none is given (matches the engine default font). */
-const DEFAULT_SIZE = 12;
+import { TextElement } from "../elements/text-element.js";
+import { HorizontalAlignment } from "../elements/pdf-element.js";
+import { FontStyle } from "../utils/pdf-object-manager.js";
+import { toColor } from "./color.js";
 /** bold + italic → the single engine `FontStyle`. */
 function toFontStyle(bold, italic) {
     if (bold && italic)
-        return pdf_object_manager_1.FontStyle.BoldItalic;
+        return FontStyle.BoldItalic;
     if (bold)
-        return pdf_object_manager_1.FontStyle.Bold;
+        return FontStyle.Bold;
     if (italic)
-        return pdf_object_manager_1.FontStyle.Italic;
-    return pdf_object_manager_1.FontStyle.Normal;
+        return FontStyle.Italic;
+    return FontStyle.Normal;
 }
 const ALIGN = {
-    left: pdf_element_1.HorizontalAlignment.left,
-    center: pdf_element_1.HorizontalAlignment.center,
-    right: pdf_element_1.HorizontalAlignment.right,
+    left: HorizontalAlignment.left,
+    center: HorizontalAlignment.center,
+    right: HorizontalAlignment.right,
 };
 /**
  * An inline run for mixed-style `Text` (`Text([span("a", {bold:true}), span("b")])`). Each
  * field overrides the enclosing `Text`'s defaults for just this run; omitted fields inherit.
  */
-function span(text, style = {}) {
+export function span(text, style = {}) {
     return {
         content: text,
         fontSize: style.size,
@@ -36,7 +29,7 @@ function span(text, style = {}) {
         fontStyle: style.bold !== undefined || style.italic !== undefined
             ? toFontStyle(style.bold, style.italic)
             : undefined,
-        fontColor: style.color !== undefined ? (0, color_1.toColor)(style.color) : undefined,
+        fontColor: style.color !== undefined ? toColor(style.color) : undefined,
     };
 }
 /**
@@ -44,18 +37,43 @@ function span(text, style = {}) {
  * options set the defaults (size/font/style/color) that any spans inherit, plus the
  * text-internal `align`.
  */
-function Text(content, opts = {}) {
-    var _a;
-    return new text_element_1.TextElement({
+export function Text(content, opts = {}) {
+    // Unset properties are left undefined so they inherit the cascaded TextStyle (Document default /
+    // built-in). Only bold/italic that the caller actually set become an explicit FontStyle.
+    return new TextElement({
         content,
-        fontSize: (_a = opts.size) !== null && _a !== void 0 ? _a : DEFAULT_SIZE,
+        fontSize: opts.size,
         fontFamily: opts.font,
-        fontStyle: toFontStyle(opts.bold, opts.italic),
-        color: opts.color !== undefined ? (0, color_1.toColor)(opts.color) : undefined,
+        fontStyle: opts.bold !== undefined || opts.italic !== undefined
+            ? toFontStyle(opts.bold, opts.italic)
+            : undefined,
+        color: opts.color !== undefined ? toColor(opts.color) : undefined,
         textAlignment: opts.align ? ALIGN[opts.align] : undefined,
+        maxLines: opts.maxLines,
+        overflow: opts.overflow,
+        lineHeight: opts.lineHeight,
     });
 }
 /** `Text` with body-paragraph defaults (same options; a separate name reads as intent). */
-function Paragraph(content, opts = {}) {
+export function Paragraph(content, opts = {}) {
     return Text(content, opts);
 }
+/** Maps the `Text`-style option names onto a partial engine `ResolvedTextStyle` (only the set
+ *  fields), for seeding the inheritance cascade. */
+export function toTextStyleOverride(opts) {
+    const style = {};
+    if (opts.size !== undefined)
+        style.fontSize = opts.size;
+    if (opts.font !== undefined)
+        style.fontFamily = opts.font;
+    if (opts.bold !== undefined || opts.italic !== undefined) {
+        style.fontStyle = toFontStyle(opts.bold, opts.italic);
+    }
+    if (opts.color !== undefined)
+        style.color = toColor(opts.color);
+    if (opts.align !== undefined)
+        style.textAlignment = ALIGN[opts.align];
+    if (opts.lineHeight !== undefined)
+        style.lineHeight = opts.lineHeight;
+    return style;
+}

package/dist/assets/font-data.d.ts

@@ -0,0 +1,2 @@
+export declare const STANDARD_AFM: Record<string, string>;
+export declare const AGL: string;