@lpdfio/lpdf 0.30.0 → 0.31.0

package/dist/attrs.d.ts

@@ -34,7 +34,7 @@ export interface ColumnAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -54,7 +54,7 @@ export interface ColumnAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     align?: string;
     justify?: string;
     /**
@@ -102,7 +102,7 @@ export interface RowAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -122,7 +122,7 @@ export interface RowAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     align?: string;
     justify?: string;
     /**
@@ -168,7 +168,7 @@ export interface GridAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -188,7 +188,7 @@ export interface GridAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     /**
      * 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
@@ -196,7 +196,7 @@ export interface GridAttr {
      */
     width?: string;
     colWidth?: string;
-    cols?: string;
+    cols?: number;
 }
 /**
  * A list of items, each with a marker: a bullet drawn as a shape, or a number the engine gives. The
@@ -236,7 +236,7 @@ export interface ListAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -256,7 +256,7 @@ export interface ListAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     /** bullet marks each item with a shape, number with a number. Default bullet. */
     type?: string;
     /**
@@ -270,7 +270,7 @@ export interface ListAttr {
      * The number of a number list's first item, to continue a list that something cut in two. Default
      * 1.
      */
-    start?: string;
+    start?: number;
     /**
      * Text before each number of a number list: prefix="(" and suffix=")" write (a). Default none.
      */
@@ -338,7 +338,7 @@ export interface LiAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -358,7 +358,7 @@ export interface LiAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     /**
      * Makes the item's marker a checkbox in place of the bullet or the number: an outline in the line
      * color, with a tick in the color of the item's words when this is true, and empty when it is
@@ -366,7 +366,7 @@ export interface LiAttr {
      * number. An item without it keeps its bullet or number. A task item of a Markdown, - [ ] or -
      * [x], is one.
      */
-    checked?: string;
+    checked?: boolean;
 }
 /**
  * A box around a single child, which it centres. Never splits across pages: if it does not fit, the
@@ -403,7 +403,7 @@ export interface FrameAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -423,7 +423,7 @@ export interface FrameAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     /**
      * 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
@@ -448,7 +448,7 @@ export interface LinkAttr {
      */
     width?: string;
     height?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * Attributes of the `divider` element.
@@ -463,22 +463,22 @@ export interface DividerAttr {
      * line; in a column it takes the full width.
      */
     width?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * Attributes of the `span` element.
  */
 export interface SpanAttr {
     font?: string;
-    bold?: string;
+    bold?: boolean;
     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;
+    underline?: boolean;
+    strike?: boolean;
 }
 /**
  * A run of code inside a text: its words in Courier on a light tint, the tint drawn behind them. It
@@ -516,7 +516,7 @@ export interface ImgAttr {
     border?: string;
     radius?: string;
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * A rectangle, a circle or an ellipse in the layout, for a status dot, a color swatch or a progress
@@ -547,8 +547,8 @@ export interface ShapeAttr {
     strokeWidth?: string;
     strokeDash?: string;
     /** How opaque the shape is, from 0 to 1. Default 1. */
-    opacity?: string;
-    debug?: string;
+    opacity?: number;
+    debug?: boolean;
 }
 /**
  * A QR code, a Code 128 or an EAN-13. It is never stretched. With only a width or a height, the
@@ -571,7 +571,7 @@ export interface BarcodeAttr {
      */
     height?: string;
     ec?: string;
-    hrt?: string;
+    hrt?: boolean;
     color?: string;
     background?: string;
     /**
@@ -581,7 +581,7 @@ export interface BarcodeAttr {
      */
     width?: string;
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * A block of wrapping text. Use span children to style parts of it, and fn children for footnotes.
@@ -595,28 +595,28 @@ export interface TextAttr {
      * Helvetica-Bold, Times-Roman becomes Times-Bold, Courier becomes Courier-Bold, and the oblique
      * and italic faces their bold forms. A custom font has no bold face to pick, so name one in font.
      */
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
     /**
      * The distance between lines, as a factor of the font size: a number above 0, such as 1.5, or a
      * name from the line-height row of the tokens. Default 1.2, which is the token m.
      */
-    lineHeight?: string;
+    lineHeight?: string | number;
     /**
      * The most lines drawn. Only whole lines are drawn, and the rest of the text is dropped. A text
      * in the layout has no cap by default and wraps at the width it has; the lines it drops take no
      * room, and a text that splits across pages keeps the cap across them. A text-at is one line by
      * default, and above 1 needs a width to wrap within.
      */
-    maxLines?: string;
+    maxLines?: number;
     /**
      * End the last line drawn in an ellipsis when max-lines drops text, shortened to fit the width.
      * Off by default: the text stops at the end of a line. A text-at also ends a line in one when it
      * is cut off at its width. A text in the layout without max-lines is never cut, so there it has
      * no effect.
      */
-    ellipsis?: string;
+    ellipsis?: boolean;
     /**
      * 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
@@ -628,14 +628,14 @@ export interface TextAttr {
      * Default 2. If fewer would be left, lines move from the first page to the next; 1 turns the
      * protection off.
      */
-    widows?: string;
+    widows?: number;
     /**
      * 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;
+    orphans?: number;
     /**
      * Records the words of this text under a name as the pages are filled, so a text with capture-ref
      * in a header or a footer can show them. Put it on a heading in the flow. The page that holds the
@@ -662,7 +662,7 @@ export interface TextAttr {
      */
     captureFallback?: string;
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * Code, or any text whose spaces and lines matter, in a box. The text is kept as it is written:
@@ -706,7 +706,7 @@ export interface CodeAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -726,7 +726,7 @@ export interface CodeAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     /**
      * 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
@@ -737,24 +737,24 @@ export interface CodeAttr {
      * How many columns a tab fills to: it moves the next character to the next multiple of this many
      * characters from the start of the line. Default 4.
      */
-    tabSize?: string;
+    tabSize?: number;
     /**
      * The distance between lines, as a factor of the font size: a number above 0, such as 1.5, or a
      * name from the line-height row of the tokens. Default 1.2, which is the token m.
      */
-    lineHeight?: string;
+    lineHeight?: string | number;
     /**
      * The fewest lines of the code 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;
+    widows?: number;
     /**
      * The fewest lines of the code that may stand alone at the bottom of a page when it splits.
      * Default 2. If fewer would fit, the whole code moves to the next page; 1 turns the protection
      * off.
      */
-    orphans?: string;
+    orphans?: number;
 }
 /**
  * Attributes of the `td` element.
@@ -791,7 +791,7 @@ export interface TdAttr {
      * that overlap do not show through each other, and a box inside a faded box is faded further: 0.5
      * inside 0.5 is drawn at 0.25. A form field in the box is not faded. Default 1.
      */
-    opacity?: string;
+    opacity?: number;
     /**
      * A hard-edged shadow: a copy of the box, moved right and down by the first two lengths (negative
      * is left and up) and filled with the color, drawn under the box with the same radius. An opacity
@@ -811,7 +811,7 @@ export interface TdAttr {
      * box inside another box they are not applied. no applies at any depth.
      */
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
     /**
      * How many of the table's columns the cell spans. It is as wide as those columns and the gaps
      * between them, and the cells after it in the row start at the column after its last. A row whose
@@ -819,7 +819,7 @@ export interface TdAttr {
      * last columns empty. It changes widths only: row heights and page breaks work as before. Default
      * 1.
      */
-    colspan?: string;
+    colspan?: number;
     /**
      * How many rows the cell spans, its own included. It is as tall as those rows and the gaps
      * between them, and the rows under it leave its columns out: their cells start at the first free
@@ -829,7 +829,7 @@ export interface TdAttr {
      * spans stay on one page: the group moves to the next page whole when it does not fit, and one
      * taller than a page is clipped at the page's end. Default 1.
      */
-    rowspan?: string;
+    rowspan?: number;
     align?: string;
     valign?: string;
 }
@@ -895,7 +895,7 @@ export interface TableAttr {
     width?: string;
     height?: string;
     paginate?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * Attributes of the `field` element.
@@ -907,10 +907,10 @@ export interface FieldAttr {
     label?: string;
     options?: string;
     group?: string;
-    checked?: string;
-    required?: string;
-    readonly?: string;
-    maxLen?: string;
+    checked?: boolean;
+    required?: boolean;
+    readonly?: boolean;
+    maxLen?: number;
     actionUrl?: string;
     /**
      * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
@@ -921,7 +921,7 @@ export interface FieldAttr {
     height?: string;
     background?: string;
     border?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * An entry of the PDF's outline, the bookmark panel of a viewer, and a target for links with
@@ -936,7 +936,7 @@ export interface BookmarkAttr {
      * 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;
+    level?: number;
     /**
      * 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
@@ -962,7 +962,7 @@ export interface RegionAttr {
      */
     page?: string;
     w?: string;
-    debug?: string;
+    debug?: boolean;
 }
 /**
  * Markdown as the content of a section, where a layout would go. It holds only Markdown: optional
@@ -1001,8 +1001,8 @@ export interface MarkdownAttr {
      * How many levels of headings become bookmarks, for the outline of the viewer and the table of
      * contents: n keeps the levels 1 to n, 0 none. Default 6.
      */
-    bookmarks?: string;
-    debug?: string;
+    bookmarks?: number;
+    debug?: boolean;
 }
 /**
  * How the parts of the Markdown look. A rule is named after the Markdown it styles and takes the
@@ -1026,10 +1026,10 @@ export interface MarkdownStylesAttr {
 export interface MarkdownH1Attr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1041,10 +1041,10 @@ export interface MarkdownH1Attr {
 export interface MarkdownH2Attr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1056,10 +1056,10 @@ export interface MarkdownH2Attr {
 export interface MarkdownH3Attr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1071,10 +1071,10 @@ export interface MarkdownH3Attr {
 export interface MarkdownH4Attr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1086,10 +1086,10 @@ export interface MarkdownH4Attr {
 export interface MarkdownH5Attr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1101,10 +1101,10 @@ export interface MarkdownH5Attr {
 export interface MarkdownH6Attr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1116,10 +1116,10 @@ export interface MarkdownH6Attr {
 export interface MarkdownPAttr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1134,12 +1134,12 @@ export interface MarkdownCodeAttr {
     font?: string;
     fontSize?: string;
     color?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
     radius?: string;
-    tabSize?: string;
+    tabSize?: number;
 }
 /**
  * A block quote, written > in Markdown: a bar beside its content. font, font-size, color,
@@ -1150,10 +1150,10 @@ export interface MarkdownCodeAttr {
 export interface MarkdownQuoteAttr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
-    lineHeight?: string;
+    lineHeight?: string | number;
     padding?: string;
     background?: string;
     border?: string;
@@ -1182,8 +1182,8 @@ export interface MarkdownLiAttr {
 export interface MarkdownAAttr {
     font?: string;
     color?: string;
-    bold?: string;
-    underline?: string;
+    bold?: boolean;
+    underline?: boolean;
 }
 /**
  * Strong text, written **text** in Markdown. Bold in a built-in font; an embedded font names its
@@ -1192,7 +1192,7 @@ export interface MarkdownAAttr {
 export interface MarkdownStrongAttr {
     font?: string;
     color?: string;
-    bold?: string;
+    bold?: boolean;
 }
 /**
  * Emphasis, written *text* in Markdown. Italic in a built-in font; an embedded font names its
@@ -1208,7 +1208,7 @@ export interface MarkdownEmAttr {
 export interface MarkdownDelAttr {
     font?: string;
     color?: string;
-    strike?: string;
+    strike?: boolean;
 }
 /**
  * A table. Its columns are sized by their content: a column takes the width its cells need on one
@@ -1233,7 +1233,7 @@ export interface MarkdownTableAttr {
 export interface MarkdownThAttr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
     padding?: string;
@@ -1246,7 +1246,7 @@ export interface MarkdownThAttr {
 export interface MarkdownTdAttr {
     font?: string;
     fontSize?: string;
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
     padding?: string;
@@ -1267,7 +1267,7 @@ export interface LayerAttr {
      * How opaque everything in the layer is, from 0 to 1. To fade one element, put it in a layer of
      * its own.
      */
-    opacity?: string;
+    opacity?: number;
     transform?: string;
     /**
      * A rectangle that cuts off what the layer draws outside it: x y w h, in points from the top left
@@ -1415,28 +1415,28 @@ export interface TextAtAttr {
      * Helvetica-Bold, Times-Roman becomes Times-Bold, Courier becomes Courier-Bold, and the oblique
      * and italic faces their bold forms. A custom font has no bold face to pick, so name one in font.
      */
-    bold?: string;
+    bold?: boolean;
     color?: string;
     align?: string;
     /**
      * The distance between lines, as a factor of the font size: a number above 0, such as 1.5, or a
      * name from the line-height row of the tokens. Default 1.2, which is the token m.
      */
-    lineHeight?: string;
+    lineHeight?: string | number;
     /**
      * The most lines drawn. Only whole lines are drawn, and the rest of the text is dropped. A text
      * in the layout has no cap by default and wraps at the width it has; the lines it drops take no
      * room, and a text that splits across pages keeps the cap across them. A text-at is one line by
      * default, and above 1 needs a width to wrap within.
      */
-    maxLines?: string;
+    maxLines?: number;
     /**
      * End the last line drawn in an ellipsis when max-lines drops text, shortened to fit the width.
      * Off by default: the text stops at the end of a line. A text-at also ends a line in one when it
      * is cut off at its width. A text in the layout without max-lines is never cut, so there it has
      * no effect.
      */
-    ellipsis?: string;
+    ellipsis?: boolean;
     /**
      * Width of the box. Without it the text is one line of the width its characters need, and align
      * has no effect; a long text runs on past the edge of the page, which cuts it off, but stays in
@@ -1481,7 +1481,7 @@ export interface BarcodeAtAttr {
      */
     height?: string;
     ec?: string;
-    hrt?: string;
+    hrt?: boolean;
     color?: string;
     background?: string;
     x?: string;
@@ -1538,3 +1538,78 @@ export interface ImageAttr {
      */
     src?: string;
 }
+/**
+ * A file the PDF carries, under the name a reader shows. The SDK reads it from src, or it was
+ * loaded on the engine under ref or, with no ref, under its own name. A file with no bytes is an
+ * error, and so are two files with the same name.
+ */
+export interface FileAttr {
+    /**
+     * The name a reader shows the file under and saves it as, such as invoice.xml. Each file of the
+     * document has a name of its own.
+     */
+    name: string;
+    /** A path the SDK reads the file from, when the file was not loaded on the engine. */
+    src?: string;
+    /** The key the file was loaded under on the engine, when that is not its name. */
+    ref?: string;
+    /**
+     * The type of the file, such as text/xml, application/pdf or text/csv. Defaults to
+     * application/octet-stream, which says only that it is a file.
+     */
+    mime?: string;
+    /**
+     * How the file relates to the document: source, data, alternative, supplement or unspecified, the
+     * default. An e-invoice's XML is data.
+     */
+    relationship?: string;
+    /** A line about the file, which a reader shows beside its name. */
+    description?: string;
+}
+/**
+ * One color of a gradient, at an offset along it.
+ */
+export interface GradientStop {
+    /**
+     * Where the color is reached along the gradient, from 0% (the start) to 100% (the end). Stops go
+     * in increasing order.
+     */
+    offset: string;
+    /**
+     * The color at the stop: hex, cmyk(), rgb(), hsl() or a color token. The stops of a gradient are
+     * all CMYK or all RGB.
+     */
+    color: string;
+}
+/**
+ * A named blend of colors. A background or a fill uses it as gradient:name, and the blend spans the
+ * box it fills. Give from and to for two colors, or stop children for more.
+ */
+export interface GradientToken {
+    /**
+     * linear runs along a line across the box. radial runs from the center out to the farthest
+     * corner.
+     */
+    type: 'linear' | 'radial';
+    /**
+     * The first color: hex, cmyk(), rgb(), hsl() or a color token, CMYK if to is and RGB if it is
+     * not. Used with to, when there are no stop children. For a radial gradient it is the center.
+     */
+    from?: string;
+    /**
+     * The last color: hex, cmyk(), rgb(), hsl() or a color token. Used with from, when there are no
+     * stop children. For a radial gradient it is the edge.
+     */
+    to?: string;
+    /**
+     * The direction of a linear gradient, in degrees: 0 runs from the top to the bottom, 90 from the
+     * left to the right, 180 from the bottom to the top. Default 0. A radial gradient has no
+     * direction.
+     */
+    angle?: number;
+    /**
+     * The colors of the gradient, for more than two: each at an offset, in increasing order. Give
+     * these, or from and to.
+     */
+    stops?: GradientStop[];
+}