takumi-pdf 0.3.0 → 0.4.0

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 = {
@@ -256,4 +287,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 = {
@@ -256,4 +287,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.0",
   "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",