takumi-pdf 0.3.0 → 0.4.1

package/README.md

@@ -188,6 +188,8 @@ Omit `metadata` to keep output byte-identical across runs.
 
 Output is **tagged by default**: HTML semantics (`h1`–`h6`, `p`, `img` with `alt`, `a`, lists) become a PDF structure tree, like Chromium's print-to-PDF. Set `tagged: "ua1"` to validate against PDF/UA-1, or `tagged: false` to drop the tree when file size matters more than accessibility.
 
+`<table>` markup is not supported, and a table built out of flex rows carries no `Table` structure elements.
+
 `pdfa` renders archival output. Validation runs during rendering. A document that cannot conform fails with the violated rule instead of writing a broken file. Every level, and PDF/UA-1, passes [veraPDF](https://verapdf.org).
 
 ```tsx
@@ -205,6 +207,7 @@ const pdf = await render(report, {
 | `"2a"` / `"3a"`          | A tagged structure tree.              |
 | `"3b"` / `"3u"` / `"3a"` | Arbitrary file attachments.           |
 | `"4"`                    | The PDF 2.0 revision of the standard. |
+| `"4f"`                   | PDF 2.0 with file attachments.        |
 
 Invalid combinations are **TypeScript type errors**. See the [PDF/A docs](https://takumi.kane.tw/docs/pdf/pdf-a) for the structure-tree mapping and required metadata.
 

package/dist/export.d.cts

@@ -151,6 +151,37 @@ type PdfMetadata = {
    * standards require one; supplying it keeps output deterministic.
    */
   creationDate?: string;
+  /**
+   * Custom XMP schemas written into the packet, for metadata the renderer
+   * knows nothing about, e.g. the `fx:` properties a Factur-X invoice needs.
+   */
+  xmp?: XmpSchema[];
+};
+/**
+ * A namespace written into the XMP packet, with the schema description PDF/A
+ * requires for it.
+ */
+type XmpSchema = {
+  /** Human-readable name, e.g. "Factur-X PDF/A Extension". */
+  name: string;
+  /** Namespace prefix the properties are written under, e.g. "fx". */
+  prefix: string;
+  /** Namespace URI. */
+  namespace: string;
+  /**
+   * Properties written under the namespace. Each is written as a value and
+   * described in the schema, so the two cannot drift apart.
+   */
+  properties: XmpProperty[];
+};
+/** A property of an {@link XmpSchema}. */
+type XmpProperty = {
+  /** Property name, e.g. "DocumentFileName". */
+  name: string;
+  /** Property value. */
+  value: string;
+  /** What the property means. PDF/A requires one. */
+  description: string;
 };
 /** A file attached to the PDF, shown in the viewer's attachment panel. */
 type Attachment = {
@@ -182,7 +213,7 @@ type ArchivalAttachment = Attachment & {
  * Standards conformance. Invalid combinations are type errors: the `a` levels
  * imply a structure tree so `tagged: false` is rejected, PDF/A-4 is PDF 2.0
  * while PDF/UA-1 is PDF 1.7-only so they cannot combine, and only the
- * PDF/A-3 levels (or plain PDF) accept attachments.
+ * PDF/A-3 levels, PDF/A-4f (or plain PDF) accept attachments.
  */
 type ConformanceOptions = {
   pdfa?: never;
@@ -211,6 +242,10 @@ type ConformanceOptions = {
   pdfa: "4";
   tagged?: boolean;
   attachments?: never;
+} | {
+  pdfa: "4f";
+  tagged?: boolean;
+  attachments?: ArchivalAttachment[];
 };
 type RenderOptions = (PagedOptions | ViewportOptions) & ConformanceOptions & {
   /** Fonts to register before rendering, deduped across calls. */
@@ -256,4 +291,4 @@ declare function render(node: NodeInput, options?: RenderOptions): Promise<Uint8
 /** Measures with a lazily created shared {@link PdfRenderer}. */
 declare function measure(node: NodeInput, options?: MeasureOptions): Promise<MeasuredSize>;
 //#endregion
-export { ArchivalAttachment, Attachment, Dimensions, type FontLoader, type ImagesInput, MeasureOptions, MeasuredSize, NodeInput, PageMargin, PageSize, PdfMetadata, PdfRenderer, RenderOptions, ViewportInput, __wbg_init as default, initSync, measure, render };
+export { ArchivalAttachment, Attachment, Dimensions, type FontLoader, type ImagesInput, MeasureOptions, MeasuredSize, NodeInput, PageMargin, PageSize, PdfMetadata, PdfRenderer, RenderOptions, ViewportInput, XmpProperty, XmpSchema, __wbg_init as default, initSync, measure, render };

package/dist/export.d.mts

@@ -151,6 +151,37 @@ type PdfMetadata = {
    * standards require one; supplying it keeps output deterministic.
    */
   creationDate?: string;
+  /**
+   * Custom XMP schemas written into the packet, for metadata the renderer
+   * knows nothing about, e.g. the `fx:` properties a Factur-X invoice needs.
+   */
+  xmp?: XmpSchema[];
+};
+/**
+ * A namespace written into the XMP packet, with the schema description PDF/A
+ * requires for it.
+ */
+type XmpSchema = {
+  /** Human-readable name, e.g. "Factur-X PDF/A Extension". */
+  name: string;
+  /** Namespace prefix the properties are written under, e.g. "fx". */
+  prefix: string;
+  /** Namespace URI. */
+  namespace: string;
+  /**
+   * Properties written under the namespace. Each is written as a value and
+   * described in the schema, so the two cannot drift apart.
+   */
+  properties: XmpProperty[];
+};
+/** A property of an {@link XmpSchema}. */
+type XmpProperty = {
+  /** Property name, e.g. "DocumentFileName". */
+  name: string;
+  /** Property value. */
+  value: string;
+  /** What the property means. PDF/A requires one. */
+  description: string;
 };
 /** A file attached to the PDF, shown in the viewer's attachment panel. */
 type Attachment = {
@@ -182,7 +213,7 @@ type ArchivalAttachment = Attachment & {
  * Standards conformance. Invalid combinations are type errors: the `a` levels
  * imply a structure tree so `tagged: false` is rejected, PDF/A-4 is PDF 2.0
  * while PDF/UA-1 is PDF 1.7-only so they cannot combine, and only the
- * PDF/A-3 levels (or plain PDF) accept attachments.
+ * PDF/A-3 levels, PDF/A-4f (or plain PDF) accept attachments.
  */
 type ConformanceOptions = {
   pdfa?: never;
@@ -211,6 +242,10 @@ type ConformanceOptions = {
   pdfa: "4";
   tagged?: boolean;
   attachments?: never;
+} | {
+  pdfa: "4f";
+  tagged?: boolean;
+  attachments?: ArchivalAttachment[];
 };
 type RenderOptions = (PagedOptions | ViewportOptions) & ConformanceOptions & {
   /** Fonts to register before rendering, deduped across calls. */
@@ -256,4 +291,4 @@ declare function render(node: NodeInput, options?: RenderOptions): Promise<Uint8
 /** Measures with a lazily created shared {@link PdfRenderer}. */
 declare function measure(node: NodeInput, options?: MeasureOptions): Promise<MeasuredSize>;
 //#endregion
-export { ArchivalAttachment, Attachment, Dimensions, type FontLoader, type ImagesInput, MeasureOptions, MeasuredSize, NodeInput, PageMargin, PageSize, PdfMetadata, PdfRenderer, RenderOptions, ViewportInput, __wbg_init as default, initSync, measure, render };
+export { ArchivalAttachment, Attachment, Dimensions, type FontLoader, type ImagesInput, MeasureOptions, MeasuredSize, NodeInput, PageMargin, PageSize, PdfMetadata, PdfRenderer, RenderOptions, ViewportInput, XmpProperty, XmpSchema, __wbg_init as default, initSync, measure, render };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "takumi-pdf",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "HTML/JSX to paged, selectable-text PDF, powered by takumi. WebAssembly, no Chromium.",
   "keywords": [
     "css",
@@ -83,7 +83,7 @@
     "publish-lint": "attw --pack . && publint --strict ."
   },
   "dependencies": {
-    "@takumi-rs/helpers": "2.5.10"
+    "@takumi-rs/helpers": "2.5.11"
   },
   "devDependencies": {
     "@types/bun": "^1.3.14",