@formfeed/sdk 0.3.10 → 0.3.12

package/types/lib/client.d.cts

@@ -151,6 +151,54 @@ export interface PostProcessing {
         owner?: string;
         permissions?: PdfPermission[];
     };
+    /**
+     * Makes the PDF a ZUGFeRD / Factur-X e-invoice, built from the `_invoice` block of `data`. `{}`
+     * takes the defaults; `false` switches off what the template's settings declare. Not together
+     * with `password`. Starter plan and above; one unit on top of the render.
+     */
+    einvoice?: EinvoiceOptions | false;
+}
+/** What kind of e-invoice a render makes; every field has a default. */
+export interface EinvoiceOptions {
+    /** `en16931` (default) carries the whole European standard, `basic` the smallest full invoice. */
+    profile?: 'basic' | 'en16931';
+    /** One specification under two names; decides the name and release the render reports. */
+    flavour?: 'factur-x' | 'zugferd';
+    /** `both` stores the XML as a file of its own beside the PDF (`einvoice.xml_url`). */
+    xml?: 'embedded' | 'both';
+    /** What a value of the XML that the PDF does not show does: a warning, or a failed render. */
+    display_check?: 'warn' | 'strict';
+}
+/** One finding of the validator: a rule of the XML, or a clause of PDF/A. */
+export interface EinvoiceMessage {
+    part: 'xml' | 'pdf';
+    severity: 'error' | 'warning';
+    rule: string | null;
+    message: string;
+    /** An XPath into the XML, or the object of the PDF. */
+    location: string | null;
+}
+/** The e-invoice of a render: what was made, what the validator said, what the PDF shows. */
+export interface Einvoice {
+    profile: 'basic' | 'en16931';
+    flavour: 'factur-x' | 'zugferd';
+    /** The release under the flavour's name: Factur-X `1.09` is ZUGFeRD `2.5`. */
+    spec_version: string;
+    /** A signed link to the XML when the render asked for `xml: "both"`; null otherwise. */
+    xml_url: string | null;
+    validation: {
+        valid: boolean;
+        schematron: string;
+        pdfa: string | null;
+        /** At most 50, errors first. */
+        messages: EinvoiceMessage[];
+        truncated?: boolean;
+    } | null;
+    /** The business terms of the XML looked for in the PDF's text, and those it does not show. */
+    display: {
+        checked: string[];
+        missing: string[];
+    } | null;
 }
 /** Where the result of a PDF tool is stored, as for a render. */
 export interface PdfOutputOptions {
@@ -206,6 +254,11 @@ export interface Render {
     deduplicated: boolean;
     /** The copy in the workspace's own bucket; null when none applies. */
     storage: StorageDelivery | null;
+    /**
+     * The e-invoice the render made, with the validator's report; null when it made none. A failed
+     * render keeps it too, which is where it says why. Absent from renders made before the feature.
+     */
+    einvoice?: Einvoice | null;
     timings: Record<string, number> | null;
     error: {
         code?: string;

package/types/lib/client.d.ts

@@ -151,6 +151,54 @@ export interface PostProcessing {
         owner?: string;
         permissions?: PdfPermission[];
     };
+    /**
+     * Makes the PDF a ZUGFeRD / Factur-X e-invoice, built from the `_invoice` block of `data`. `{}`
+     * takes the defaults; `false` switches off what the template's settings declare. Not together
+     * with `password`. Starter plan and above; one unit on top of the render.
+     */
+    einvoice?: EinvoiceOptions | false;
+}
+/** What kind of e-invoice a render makes; every field has a default. */
+export interface EinvoiceOptions {
+    /** `en16931` (default) carries the whole European standard, `basic` the smallest full invoice. */
+    profile?: 'basic' | 'en16931';
+    /** One specification under two names; decides the name and release the render reports. */
+    flavour?: 'factur-x' | 'zugferd';
+    /** `both` stores the XML as a file of its own beside the PDF (`einvoice.xml_url`). */
+    xml?: 'embedded' | 'both';
+    /** What a value of the XML that the PDF does not show does: a warning, or a failed render. */
+    display_check?: 'warn' | 'strict';
+}
+/** One finding of the validator: a rule of the XML, or a clause of PDF/A. */
+export interface EinvoiceMessage {
+    part: 'xml' | 'pdf';
+    severity: 'error' | 'warning';
+    rule: string | null;
+    message: string;
+    /** An XPath into the XML, or the object of the PDF. */
+    location: string | null;
+}
+/** The e-invoice of a render: what was made, what the validator said, what the PDF shows. */
+export interface Einvoice {
+    profile: 'basic' | 'en16931';
+    flavour: 'factur-x' | 'zugferd';
+    /** The release under the flavour's name: Factur-X `1.09` is ZUGFeRD `2.5`. */
+    spec_version: string;
+    /** A signed link to the XML when the render asked for `xml: "both"`; null otherwise. */
+    xml_url: string | null;
+    validation: {
+        valid: boolean;
+        schematron: string;
+        pdfa: string | null;
+        /** At most 50, errors first. */
+        messages: EinvoiceMessage[];
+        truncated?: boolean;
+    } | null;
+    /** The business terms of the XML looked for in the PDF's text, and those it does not show. */
+    display: {
+        checked: string[];
+        missing: string[];
+    } | null;
 }
 /** Where the result of a PDF tool is stored, as for a render. */
 export interface PdfOutputOptions {
@@ -206,6 +254,11 @@ export interface Render {
     deduplicated: boolean;
     /** The copy in the workspace's own bucket; null when none applies. */
     storage: StorageDelivery | null;
+    /**
+     * The e-invoice the render made, with the validator's report; null when it made none. A failed
+     * render keeps it too, which is where it says why. Absent from renders made before the feature.
+     */
+    einvoice?: Einvoice | null;
     timings: Record<string, number> | null;
     error: {
         code?: string;