@lpdfio/lpdf 0.31.0 → 0.33.0

package/dist/attrs.d.ts

@@ -55,6 +55,19 @@ export interface ColumnAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
     align?: string;
     justify?: string;
     /**
@@ -63,6 +76,20 @@ export interface ColumnAttr {
      * line; in a column it takes the full width.
      */
     width?: string;
+    /**
+     * true lays out the texts that the text with data-source repeats one page at a time, straight
+     * from the data, for logs and lists of tens of thousands of lines and more. The pages are the
+     * ones the same column would have without bulk, but where a page would end inside a text of four
+     * lines or more: without bulk the text splits there, and with bulk it moves whole to the next
+     * page. The column holds texts only, and they follow rules: a text holds plain words with no
+     * span, link, bookmark, footnote or reference, sets no widows or orphans and has no data-source
+     * inside it, and a text without max-lines holds one line and ends in an ellipsis. The column sits
+     * directly in the layout, has no data-source of its own and one text with it, has no height, and
+     * neither it nor anything in it has paginate. Its document has no table of contents, no reference
+     * to a bookmark, no pdfua and no pdfa of level a, and its section's columns are not balanced.
+     * Breaking a rule is an error that names it. Default false.
+     */
+    bulk?: boolean;
 }
 /**
  * Children side by side, continuing on the next line when they run out of width. A child with width
@@ -123,6 +150,19 @@ export interface RowAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
     align?: string;
     justify?: string;
     /**
@@ -189,6 +229,19 @@ export interface GridAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: 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
@@ -197,6 +250,20 @@ export interface GridAttr {
     width?: string;
     colWidth?: string;
     cols?: number;
+    /**
+     * true lays out the cells that the child with data-source repeats one page at a time, straight
+     * from the data, for sheets of tens of thousands of labels or cards and more. The pages are the
+     * ones the same grid would have without bulk. The cells follow rules, and so do the grid's other
+     * children: a cell is a text, or a column that holds texts, a text holds plain words with no
+     * span, link, bookmark, footnote or reference, and sets no widows or orphans, a text without
+     * max-lines holds one line and ends in an ellipsis, and nothing in a cell has data-source. A row
+     * of cells never splits across pages. The grid sits directly in the layout, has no data-source of
+     * its own and one child with it, has no height, and neither it nor anything in it has paginate.
+     * Its document has no table of contents, no reference to a bookmark, no pdfua and no pdfa of
+     * level a, and its section's columns are not balanced. Breaking a rule is an error that names it.
+     * Default false.
+     */
+    bulk?: boolean;
 }
 /**
  * A list of items, each with a marker: a bullet drawn as a shape, or a number the engine gives. The
@@ -257,6 +324,19 @@ export interface ListAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
     /** bullet marks each item with a shape, number with a number. Default bullet. */
     type?: string;
     /**
@@ -298,6 +378,21 @@ export interface ListAttr {
      * line; in a column it takes the full width.
      */
     width?: string;
+    /**
+     * true lays out the items that the li with data-source repeats one page at a time, straight from
+     * the data, for logs and lists of tens of thousands of items and more. The pages are the ones the
+     * same list would have without bulk, but where a page would end inside an item, between its texts
+     * or inside a text of four lines or more: without bulk the item splits there, and with bulk it
+     * moves whole to the next page. A number list numbers the items as it does without bulk. The list
+     * has one level, and its items follow rules: an li holds texts only, a text holds plain words
+     * with no span, link, bookmark, footnote or reference, and sets no widows or orphans, a text
+     * without max-lines holds one line and ends in an ellipsis, and nothing in an item has
+     * data-source. The list sits directly in the layout, has no data-source of its own and one li
+     * with it, has no height, and neither it nor anything in it has paginate. Its document has no
+     * table of contents, no reference to a bookmark, no pdfua and no pdfa of level a, and its
+     * section's columns are not balanced. Breaking a rule is an error that names it. Default false.
+     */
+    bulk?: boolean;
 }
 /**
  * One item of a list: a box that holds what a layout holds, such as a text, an image, a table or
@@ -359,6 +454,19 @@ export interface LiAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
     /**
      * 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
@@ -424,6 +532,19 @@ export interface FrameAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: 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
@@ -449,6 +570,19 @@ export interface LinkAttr {
     width?: string;
     height?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `divider` element.
@@ -464,6 +598,19 @@ export interface DividerAttr {
      */
     width?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `span` element.
@@ -477,6 +624,17 @@ export interface SpanAttr {
      * table of contents, # alone jumps to that entry's bookmark.
      */
     href?: string;
+    /**
+     * Makes the span a cross-reference to the bookmark with this id: a link to it whose words say
+     * where it is. In the span's words, {bookmark-page} prints the page the bookmark is on, as the
+     * footer of that page prints it, and {bookmark-label} the bookmark's label, so "{bookmark-label},
+     * on page {bookmark-page}" shows "clause 4, on page 12". An id that no bookmark has, another {…}
+     * token in the words, and href beside it are errors. It works in a text, a footnote, a region, a
+     * text-at and a code. The document is laid out again until each reference shows the page its
+     * bookmark lands on, and a reference keeps room for the widest words it has shown, so a number
+     * that got narrower can leave a small gap after it.
+     */
+    bookmarkRef?: string;
     underline?: boolean;
     strike?: boolean;
 }
@@ -501,6 +659,13 @@ export interface CodeSpanAttr {
  */
 export interface ImgAttr {
     name: string;
+    /**
+     * What the image shows, which a screen reader reads in a tagged document, one with pdfua or a
+     * pdfa of level a; alt="" marks it as decoration, which a reader skips. A PDF/UA document needs
+     * it on every image of the layout; at PDF/A level a without pdfua, an image without it is
+     * decoration. A document that is not tagged ignores it.
+     */
+    alt?: string;
     height?: string;
     /**
      * Width of the element. A length fixes it. fill, in a row, takes the width its line leaves after
@@ -517,6 +682,19 @@ export interface ImgAttr {
     radius?: string;
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * A rectangle, a circle or an ellipse in the layout, for a status dot, a color swatch or a progress
@@ -549,6 +727,19 @@ export interface ShapeAttr {
     /** How opaque the shape is, from 0 to 1. Default 1. */
     opacity?: number;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * A QR code, a Code 128 or an EAN-13. It is never stretched. With only a width or a height, the
@@ -580,8 +771,29 @@ export interface BarcodeAttr {
      * line; in a column it takes the full width.
      */
     width?: string;
+    /**
+     * What the barcode is for, which a screen reader reads in a tagged document, one with pdfua or a
+     * pdfa of level a, in place of its data, which means nothing read aloud: "QR code to pay this
+     * invoice". alt="" marks it as decoration. A PDF/UA document needs it on every barcode of the
+     * layout; at PDF/A level a without pdfua, a barcode without it is decoration. A document that is
+     * not tagged ignores it.
+     */
+    alt?: string;
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * A block of wrapping text. Use span children to style parts of it, and fn children for footnotes.
@@ -623,6 +835,14 @@ export interface TextAttr {
      * line; in a column it takes the full width.
      */
     width?: string;
+    /**
+     * Makes the text a heading, h1 to h6, which a tagged document, one with pdfua or a pdfa of level
+     * a, tags as one: a screen reader lists the headings and moves between them. A text without role
+     * is a paragraph. A PDF/UA document's headings start at h1 and go down one level at a time. It
+     * changes nothing a page shows: set the size and the weight as on any text. A document that is
+     * not tagged ignores it.
+     */
+    role?: 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
@@ -663,6 +883,19 @@ export interface TextAttr {
     captureFallback?: string;
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Code, or any text whose spaces and lines matter, in a box. The text is kept as it is written:
@@ -727,6 +960,19 @@ export interface CodeAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: 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
@@ -812,6 +1058,19 @@ export interface TdAttr {
      */
     paginate?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
     /**
      * 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
@@ -838,6 +1097,19 @@ export interface TdAttr {
  */
 export interface TheadAttr {
     background?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `tr` element.
@@ -852,6 +1124,19 @@ export interface TrAttr {
      */
     keep?: string;
     background?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Rows and cells in columns whose widths are set by cols. The thead row repeats at the top of every
@@ -896,6 +1181,33 @@ export interface TableAttr {
     height?: string;
     paginate?: string;
     debug?: boolean;
+    /**
+     * true lays out the rows that the tr with data-source repeats one page at a time, straight from
+     * the data, for reports of tens of thousands of rows and more. The pages are the ones the same
+     * table would have without bulk. The rows follow rules, and so do the thead and the other rows:
+     * each td holds one text or none, a text holds plain words with no span, link, bookmark, footnote
+     * or reference, and sets no widows or orphans, a text without max-lines holds one line and ends
+     * in an ellipsis, a td has no rowspan, a row no keep, and nothing in a row has data-source. A row
+     * never splits across pages. The table sits directly in the layout, has no data-source of its own
+     * and one tr with it, sets its cols in fr, pt or %, has no height, and neither it nor anything in
+     * it has paginate. Its document has no table of contents, no reference to a bookmark, no pdfua
+     * and no pdfa of level a, and its section's columns are not balanced. Breaking a rule is an error
+     * that names it. Default false.
+     */
+    bulk?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `field` element.
@@ -922,12 +1234,25 @@ export interface FieldAttr {
     background?: string;
     border?: string;
     debug?: boolean;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: 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.
+ * href="#id" and for cross-references with bookmark-ref. 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. */
@@ -938,31 +1263,68 @@ export interface BookmarkAttr {
      */
     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
-     * when an earlier bookmark has it. Two bookmarks may not have the same id.
+     * The name links use to jump here, as href="#id", and cross-references as bookmark-ref="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;
+    /**
+     * true leaves the bookmark out of the viewer's outline and out of the table of contents, for a
+     * figure or a table: label="Table 3" ref-only="true". Links with href="#id" and cross-references
+     * with bookmark-ref still reach it, and {bookmark-label} still shows its label. Defaults to
+     * false.
+     */
+    refOnly?: boolean;
 }
 /**
  * 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.
  * Where it is written among the flow does not matter: pin chooses the edge, and regions on one edge
- * stack in the order written.
+ * stack in the order written. With pin set to inset, it is a block at a spot inside the section's
+ * columns instead, such as a picture or a box across two columns of a newsletter: top and height
+ * place it, col and colspan say which columns it covers, and those columns flow around it, filling
+ * above it and carrying on below it.
  */
 export interface RegionAttr {
     /**
      * Which edge the region sticks to. top and bottom work. left and right pass validation but are
-     * not implemented yet.
+     * not implemented yet. inset places the region inside the columns, where top, height, col and
+     * colspan say.
      */
     pin: string;
     /**
-     * Which pages show the region: each, first, last, odd, even, or a range such as 2-last. Defaults
-     * to each.
+     * Which pages show the region: each, first, last, odd, even, or a range such as 2-last. odd and
+     * even follow the number printed on the page, so in a section that starts on page 4 even shows on
+     * its first page. first, last and ranges count the section's own pages, whatever their numbers.
+     * Defaults to each. An inset on last goes on the last page of the flow filled without it; if it
+     * then pushes text on to a new page, it stays where it is, one page before the end.
      */
     page?: string;
     w?: string;
     debug?: boolean;
+    /**
+     * For pin set to inset: the column the inset starts in, counted from 1 at the left. Defaults to
+     * 1. With colspan, it may not run past the section's columns. An error on any other pin.
+     */
+    col?: number;
+    /**
+     * For pin set to inset: how many columns the inset covers, from col. It is as wide as those
+     * columns and the gaps between them. Defaults to 1. An error on any other pin.
+     */
+    colspan?: number;
+    /**
+     * For pin set to inset, and required with it: how far below the top of the columns the inset
+     * starts, under the headers. An error on any other pin.
+     */
+    top?: string;
+    /**
+     * For pin set to inset, and required with it: how tall the inset is. Content taller than it is
+     * clipped at its foot, and the inset is never cut across pages: one whose top and height reach
+     * below the room the headers and footers leave, on a page it is on, is an error. Footnotes give
+     * way to it. An error on any other pin.
+     */
+    height?: string;
 }
 /**
  * Markdown as the content of a section, where a layout would go. It holds only Markdown: optional
@@ -1262,6 +1624,12 @@ export interface MarkdownTdAttr {
  * of its text. Layers cannot be nested.
  */
 export interface LayerAttr {
+    /**
+     * Which pages of the section show the layer: each, first, last, odd, even, or a range such as
+     * 2-last. odd and even follow the number printed on the page, so in a section that starts on page
+     * 4 even shows on its first page. first, last and ranges count the section's own pages, whatever
+     * their numbers. Defaults to each.
+     */
     page?: string;
     /**
      * How opaque everything in the layer is, from 0 to 1. To fade one element, put it in a layer of
@@ -1287,6 +1655,27 @@ export interface LayerAttr {
      * The color of the text-at in the layer that sets none of its own. Defaults to the text token.
      */
     color?: string;
+    /**
+     * In a tagged document, one with pdfua or a pdfa of level a, what the layer shows, which a screen
+     * reader reads as one figure at the layer's place in the document: a layer before the layout
+     * before it, one after the layout after it. Without alt a layer is decoration, as a header is,
+     * and a screen reader skips it with all its text: a watermark, a running title, a logo's letters.
+     * A document that is not tagged ignores it.
+     */
+    alt?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `rect` element in a layer.
@@ -1309,6 +1698,19 @@ export interface RectAttr {
      * with no fill shows the shadow only outside it.
      */
     shadow?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `circle` element in a layer.
@@ -1339,6 +1741,19 @@ export interface CircleAttr {
      * with no fill shows the shadow only outside it.
      */
     shadow?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `ellipse` element in a layer.
@@ -1370,6 +1785,19 @@ export interface EllipseAttr {
      * with no fill shows the shadow only outside it.
      */
     shadow?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `line` element in a layer.
@@ -1383,6 +1811,19 @@ export interface LineAttr {
     strokeWidth?: string;
     strokeDash?: string;
     lineCap?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Attributes of the `path` element in a layer.
@@ -1395,13 +1836,27 @@ export interface PathAttr {
     strokeWidth?: string;
     strokeDash?: string;
     lineCap?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * Text at a fixed place on the page. It is the text of the layout, with the same defaults: the
  * document's font or Helvetica, 11pt and the text colour. It is one line unless told otherwise;
  * give width to cut it off at a width or to wrap it with max-lines. x and y place its box: the
  * top-left corner, or with anchor, an offset from that point of the page, where the box's matching
- * point goes. {page} and {pages} in it count within the section, and a text that comes from data
+ * point goes. {page} in it prints the page's number and {pages} how many pages its run has, as its
+ * section's page-start, page-format and page-prefix number them, and a text that comes from data
  * belongs in the layout, since a longer text loses its end here without a warning.
  */
 export interface TextAtAttr {
@@ -1444,6 +1899,19 @@ export interface TextAtAttr {
      * and max-lines above 1 wraps the text within it.
      */
     width?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * An image at a fixed place on the page. It needs width or height, and the other follows the
@@ -1459,6 +1927,19 @@ export interface ImgAtAttr {
     anchor?: string;
     width?: string;
     height?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * A barcode at a fixed place on the page. It needs width or height, and the other follows the
@@ -1488,6 +1969,19 @@ export interface BarcodeAtAttr {
     y?: string;
     anchor?: string;
     width?: string;
+    /**
+     * Puts the element, and everything in it, in an optional content group, which the viewer shows or
+     * hides. print: printed, and not shown on screen. screen: shown on screen, and not printed. The
+     * element keeps its room either way, so nothing moves. An element with a group inside an element
+     * with another shows only where both show. Acrobat, Chrome and Firefox switch the groups; Preview
+     * and Safari show everything, on screen and in print. Hidden content is still in the file, where
+     * it can be selected and copied: it is not a way to keep anything secret. A link in print content
+     * is drawn and does nothing, and a form field can't be in print content: use a frame with a
+     * border for a box filled in by hand. With pdfa or pdfua on the output, everything shows. With
+     * pdfx, the file is the print version: screen content stays in it, off, and a reader can turn it
+     * on in a layers panel.
+     */
+    ocg?: string;
 }
 /**
  * The flowing content of a section. Elements stack down the page, and a new page starts when one
@@ -1555,17 +2049,38 @@ export interface FileAttr {
     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.
+     * application/octet-stream, which says only that it is a file, and to text/xml for the invoice of
+     * a Factur-X e-invoice.
      */
     mime?: string;
     /**
      * How the file relates to the document: source, data, alternative, supplement or unspecified, the
-     * default. An e-invoice's XML is data.
+     * default. The invoice of a Factur-X e-invoice defaults to data for the MINIMUM and BASIC WL
+     * profiles, and to alternative for the others, as the Factur-X spec asks.
      */
     relationship?: string;
     /** A line about the file, which a reader shows beside its name. */
     description?: string;
 }
+/**
+ * Declares an ICC color profile that the profile attribute of output names: the profile of the
+ * printing press a PDF/X file is made for, which the printer gives out. The SDK reads the file from
+ * src, or the profile was loaded on the engine under ref or, with no ref, under its own name. The
+ * engine bundles no press profile.
+ */
+export interface ProfileAttr {
+    /**
+     * The name that the profile attribute of output uses to pick this profile: lowercase letters,
+     * digits and -, starting with a letter.
+     */
+    name: string;
+    /** The key the profile was loaded under on the engine, when that is not its name. */
+    ref?: string;
+    /**
+     * A path the SDK reads the ICC profile from, when the profile was not loaded on the engine.
+     */
+    src?: string;
+}
 /**
  * One color of a gradient, at an offset along it.
  */
@@ -1613,3 +2128,75 @@ export interface GradientToken {
      */
     stops?: GradientStop[];
 }
+/**
+ * One set of lines of a ruling, cut by a step or by a count in each direction: x for the lines that
+ * run down the page, y for the lines that run across it. A direction with neither has no lines, so
+ * step-y alone is ruled paper and step both is squared paper. A step and a count in the same
+ * direction is an error. Each set is drawn after the one before it, so a heavier set paints over a
+ * finer one.
+ */
+export interface RulingLines {
+    /**
+     * The distance between two lines in both directions, a length such as 5mm. step-x and step-y take
+     * its place in their direction. A cell narrower than 2.5pt is an error.
+     */
+    step?: string;
+    /**
+     * The distance between two lines that run down the page, from left to right, a length such as
+     * 10mm.
+     */
+    stepX?: string;
+    /**
+     * The distance between two lines that run across the page, from top to bottom, a length such as
+     * 8mm: ruled paper.
+     */
+    stepY?: string;
+    /**
+     * Cuts the space into this many equal parts in both directions, from 1 to 100, so the lines land
+     * on its edges whatever its size. count-x and count-y take its place in their direction. A part
+     * narrower than 2.5pt is an error.
+     */
+    count?: number;
+    /** Cuts the space into this many equal columns, from 1 to 100. */
+    countX?: number;
+    /** Cuts the space into this many equal rows, from 1 to 100. */
+    countY?: number;
+    /**
+     * The color of the lines: hex, cmyk(), rgb(), hsl() or a color token. Defaults to line-muted.
+     */
+    color?: string;
+    /**
+     * The thickness of the lines, a length or a name from the border row of the tokens. Defaults to
+     * 0.4pt.
+     */
+    thickness?: string;
+}
+/**
+ * Lines on every page of a section, for paper to write or draw on, or a grid to place things by:
+ * ruled paper, squared paper, or a page cut into equal parts. A section names it with
+ * ruling="name", and the lines are drawn under everything else on its pages, over the background.
+ * They are decoration, which a screen reader skips.
+ */
+export interface RulingToken {
+    /**
+     * The space the lines fill and a count divides. page, the default, is the whole page up to its
+     * trim edge. margin is the area inside the margin of the section's layout or markdown. A step
+     * starts at its top left corner, and the lines stop at its edges.
+     */
+    origin?: 'page' | 'margin';
+    /**
+     * Whether the lines on the edges of that space are drawn: the first one, and the last one where a
+     * step lands on the far edge. A count of 12 draws 13 lines with them and 11 without. Defaults to
+     * true.
+     */
+    edges?: boolean;
+    /**
+     * Puts the lines in an optional content group, as ocg does on an element: print, printed and not
+     * shown on screen, or screen, shown on screen and not printed, such as a grid to place things by.
+     */
+    ocg?: 'print' | 'screen';
+    /**
+     * The sets of lines, at least one, drawn in this order: a later set paints over an earlier one.
+     */
+    lines: RulingLines[];
+}