@formfeed/sdk 0.3.20 → 0.3.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formfeed/sdk",
-  "version": "0.3.20",
+  "version": "0.3.22",
   "description": "Formfeed API client: renders, templates, webhooks. No dependencies, Web APIs only.",
   "license": "MIT",
   "type": "module",

package/types/index.d.cts

@@ -1,4 +1,4 @@
 export { Formfeed, FormfeedError } from './lib/client.cjs';
-export type { Template, TemplateCreate, TemplateFiles, TemplateKind, TemplateListOptions, TemplateValidation, VersionRef, TemplateVersion, TemplateVersionCreate, TemplateFile, OfficeTemplateKind, OfficeTemplateCreate, OfficeVersionCreate, OfficeFileUpload, ConvertOptions, VersionStatus, BatchRequest, Channel, ChannelList, ChannelMove, Brand, SharedPartial, SharedPartialPut, SharedPartialPutResult, Diagnostic, Engine, FileListOptions, FileUpload, FormfeedOptions, FormfeedTemplates, Job, LibraryFile, OutputFormat, PdfInfo, PdfOutputOptions, PdfPermission, PostProcessing, Einvoice, EinvoiceMessage, EinvoiceOptions, Accessibility, AccessibilityFailure, AccessibilityWarning, PdfUaOptions, Problem, StorageDelivery, StorageDeliveryEvent, StorageError, StorageOption, WebhookEventType, ProtectOptions, Region, Render, RenderListOptions, RenderRequest, RenderStatus, TemplateData, TypedRenderRequest, RequestOptions, SchemaChange, SchemaCheck, SchemaGuardOptions, Usage, WaitOptions, WatermarkOptions, WebhookEndpoint, WebhookEndpointCreate, WebhookEndpointUpdate, WebhookEnvironment, WebhookResend, ListenSession, ListenSessionOptions, RenderInput, } from './lib/client.cjs';
+export type { Template, TemplateCreate, TemplateFiles, TemplateKind, TemplateListOptions, TemplateValidation, VersionRef, TemplateVersion, TemplateVersionCreate, TemplateFile, OfficeTemplateKind, OfficeTemplateCreate, OfficeVersionCreate, OfficeFileUpload, ConvertOptions, VersionStatus, BatchRequest, Channel, ChannelList, ChannelMove, Brand, SharedPartial, SharedPartialPut, SharedPartialPutResult, Diagnostic, Engine, FileListOptions, FileUpload, FormfeedOptions, FormfeedTemplates, Job, LibraryFile, OutputFormat, PdfInfo, PdfOutputOptions, PdfPermission, PostProcessing, Einvoice, EinvoiceMessage, EinvoiceOptions, Accessibility, AccessibilityFailure, AccessibilityWarning, Pdfa, PdfaLevel, PdfaMessage, PdfUaOptions, Problem, StorageDelivery, StorageDeliveryEvent, StorageError, StorageOption, WebhookEventType, ProtectOptions, Region, Render, RenderListOptions, RenderRequest, RenderStatus, TemplateData, TypedRenderRequest, RequestOptions, SchemaChange, SchemaCheck, SchemaGuardOptions, Usage, WaitOptions, WatermarkOptions, WebhookEndpoint, WebhookEndpointCreate, WebhookEndpointUpdate, WebhookEnvironment, WebhookResend, ListenSession, ListenSessionOptions, RenderInput, } from './lib/client.cjs';
 export { parseWebhookEvent, verifyWebhookSignature } from './lib/webhooks.cjs';
 export type { VerifyOptions } from './lib/webhooks.cjs';

package/types/index.d.ts

@@ -1,4 +1,4 @@
 export { Formfeed, FormfeedError } from './lib/client.js';
-export type { Template, TemplateCreate, TemplateFiles, TemplateKind, TemplateListOptions, TemplateValidation, VersionRef, TemplateVersion, TemplateVersionCreate, TemplateFile, OfficeTemplateKind, OfficeTemplateCreate, OfficeVersionCreate, OfficeFileUpload, ConvertOptions, VersionStatus, BatchRequest, Channel, ChannelList, ChannelMove, Brand, SharedPartial, SharedPartialPut, SharedPartialPutResult, Diagnostic, Engine, FileListOptions, FileUpload, FormfeedOptions, FormfeedTemplates, Job, LibraryFile, OutputFormat, PdfInfo, PdfOutputOptions, PdfPermission, PostProcessing, Einvoice, EinvoiceMessage, EinvoiceOptions, Accessibility, AccessibilityFailure, AccessibilityWarning, PdfUaOptions, Problem, StorageDelivery, StorageDeliveryEvent, StorageError, StorageOption, WebhookEventType, ProtectOptions, Region, Render, RenderListOptions, RenderRequest, RenderStatus, TemplateData, TypedRenderRequest, RequestOptions, SchemaChange, SchemaCheck, SchemaGuardOptions, Usage, WaitOptions, WatermarkOptions, WebhookEndpoint, WebhookEndpointCreate, WebhookEndpointUpdate, WebhookEnvironment, WebhookResend, ListenSession, ListenSessionOptions, RenderInput, } from './lib/client.js';
+export type { Template, TemplateCreate, TemplateFiles, TemplateKind, TemplateListOptions, TemplateValidation, VersionRef, TemplateVersion, TemplateVersionCreate, TemplateFile, OfficeTemplateKind, OfficeTemplateCreate, OfficeVersionCreate, OfficeFileUpload, ConvertOptions, VersionStatus, BatchRequest, Channel, ChannelList, ChannelMove, Brand, SharedPartial, SharedPartialPut, SharedPartialPutResult, Diagnostic, Engine, FileListOptions, FileUpload, FormfeedOptions, FormfeedTemplates, Job, LibraryFile, OutputFormat, PdfInfo, PdfOutputOptions, PdfPermission, PostProcessing, Einvoice, EinvoiceMessage, EinvoiceOptions, Accessibility, AccessibilityFailure, AccessibilityWarning, Pdfa, PdfaLevel, PdfaMessage, PdfUaOptions, Problem, StorageDelivery, StorageDeliveryEvent, StorageError, StorageOption, WebhookEventType, ProtectOptions, Region, Render, RenderListOptions, RenderRequest, RenderStatus, TemplateData, TypedRenderRequest, RequestOptions, SchemaChange, SchemaCheck, SchemaGuardOptions, Usage, WaitOptions, WatermarkOptions, WebhookEndpoint, WebhookEndpointCreate, WebhookEndpointUpdate, WebhookEnvironment, WebhookResend, ListenSession, ListenSessionOptions, RenderInput, } from './lib/client.js';
 export { parseWebhookEvent, verifyWebhookSignature } from './lib/webhooks.js';
 export type { VerifyOptions } from './lib/webhooks.js';

package/types/lib/client.d.cts

@@ -41,6 +41,8 @@ export interface RenderRequest {
     /**
      * Merged over the template's settings. `{ pdf: { ua: true } }` makes the file a PDF/UA-1 document
      * and the render carry the validator's verdict as `accessibility`; see `PdfUaOptions`.
+     * `{ pdf: { pdfa: '2b' } }` (or `'3b'`, or `true` for `'3b'`) makes it a PDF/A file for
+     * archiving, checked before it is delivered; the render carries the verdict as `pdfa`.
      */
     settings?: Record<string, unknown>;
     filename?: string;
@@ -173,19 +175,25 @@ export interface EinvoiceOptions {
     /** 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. */
+/**
+ * One finding of the validator: a rule of the XML, or a clause of PDF/A. `part` and `severity` name
+ * today's values and take any other text, which a later release of the API may send.
+ */
 export interface EinvoiceMessage {
-    part: 'xml' | 'pdf';
-    severity: 'error' | 'warning';
+    part: 'xml' | 'pdf' | (string & {});
+    severity: 'error' | 'warning' | (string & {});
     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. */
+/**
+ * The e-invoice of a render: what was made, what the validator said, what the PDF shows. `profile`
+ * and `flavour` name today's values and take any other text, which a later release may send.
+ */
 export interface Einvoice {
-    profile: 'basic' | 'en16931';
-    flavour: 'factur-x' | 'zugferd';
+    profile: 'basic' | 'en16931' | (string & {});
+    flavour: 'factur-x' | 'zugferd' | (string & {});
     /** 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. */
@@ -260,6 +268,35 @@ export interface Accessibility {
     warnings: AccessibilityWarning[];
     truncated?: boolean;
 }
+/** A level of PDF/A a render can ask for in `settings.pdf.pdfa`; `true` stands for `'3b'`. */
+export type PdfaLevel = '2b' | '3b';
+/** One rule of the PDF/A level a file failed. */
+export interface PdfaMessage {
+    severity: 'error' | 'warning' | (string & {});
+    /** The clause of ISO 19005 and veraPDF's test number, `6.2.11.4.1-1`. */
+    rule: string | null;
+    message: string;
+    /** veraPDF's path to the object of the PDF. */
+    location: string | null;
+}
+/**
+ * What the validator said about a file as PDF/A: which rules of the format it passed, by which
+ * validator. A render delivers a file only when it passed; a failed render keeps the report.
+ */
+export interface Pdfa {
+    standard: 'PDF/A-2b' | 'PDF/A-3b' | (string & {});
+    conformant: boolean;
+    /** The validator and its version, `veraPDF 1.30.2`. */
+    validator: string;
+    /** The validator's own id for this report. */
+    id: string;
+    versions: Record<string, string>;
+    /** SHA-256 of the file that was judged: the delivered file of a render that succeeded. */
+    pdf_sha256: string | null;
+    /** At most 50; empty for a file that passed. */
+    messages: PdfaMessage[];
+    truncated?: boolean;
+}
 /** Where the result of a PDF tool is stored, as for a render. */
 export interface PdfOutputOptions {
     filename?: string;
@@ -325,6 +362,12 @@ export interface Render {
      * renders made before the feature.
      */
     accessibility?: Accessibility | null;
+    /**
+     * The validator's verdict on the file as PDF/A; null unless the render set `settings.pdf.pdfa`.
+     * A render whose file failed keeps it too, which is where it names the rules. Absent from renders
+     * made before the feature.
+     */
+    pdfa?: Pdfa | null;
     timings: Record<string, number> | null;
     error: {
         code?: string;
@@ -540,7 +583,8 @@ export interface RenderInput {
     url?: string;
     data?: Record<string, unknown>;
     locale?: string | null;
-    output?: OutputFormat;
+    /** One of today's output formats, or one a later release of the API adds. */
+    output?: OutputFormat | (string & {});
     settings?: Record<string, unknown>;
     filename?: string;
     post?: Record<string, unknown>;
@@ -692,6 +736,8 @@ export interface TemplateCreate extends TemplateFiles {
     kind: TemplateKind;
     engine: Engine;
     tags?: string[];
+    /** What version 1 is; shown in the version history. */
+    change_note?: string;
     publish?: boolean;
 }
 export interface TemplateVersionCreate extends TemplateFiles {

package/types/lib/client.d.ts

@@ -41,6 +41,8 @@ export interface RenderRequest {
     /**
      * Merged over the template's settings. `{ pdf: { ua: true } }` makes the file a PDF/UA-1 document
      * and the render carry the validator's verdict as `accessibility`; see `PdfUaOptions`.
+     * `{ pdf: { pdfa: '2b' } }` (or `'3b'`, or `true` for `'3b'`) makes it a PDF/A file for
+     * archiving, checked before it is delivered; the render carries the verdict as `pdfa`.
      */
     settings?: Record<string, unknown>;
     filename?: string;
@@ -173,19 +175,25 @@ export interface EinvoiceOptions {
     /** 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. */
+/**
+ * One finding of the validator: a rule of the XML, or a clause of PDF/A. `part` and `severity` name
+ * today's values and take any other text, which a later release of the API may send.
+ */
 export interface EinvoiceMessage {
-    part: 'xml' | 'pdf';
-    severity: 'error' | 'warning';
+    part: 'xml' | 'pdf' | (string & {});
+    severity: 'error' | 'warning' | (string & {});
     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. */
+/**
+ * The e-invoice of a render: what was made, what the validator said, what the PDF shows. `profile`
+ * and `flavour` name today's values and take any other text, which a later release may send.
+ */
 export interface Einvoice {
-    profile: 'basic' | 'en16931';
-    flavour: 'factur-x' | 'zugferd';
+    profile: 'basic' | 'en16931' | (string & {});
+    flavour: 'factur-x' | 'zugferd' | (string & {});
     /** 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. */
@@ -260,6 +268,35 @@ export interface Accessibility {
     warnings: AccessibilityWarning[];
     truncated?: boolean;
 }
+/** A level of PDF/A a render can ask for in `settings.pdf.pdfa`; `true` stands for `'3b'`. */
+export type PdfaLevel = '2b' | '3b';
+/** One rule of the PDF/A level a file failed. */
+export interface PdfaMessage {
+    severity: 'error' | 'warning' | (string & {});
+    /** The clause of ISO 19005 and veraPDF's test number, `6.2.11.4.1-1`. */
+    rule: string | null;
+    message: string;
+    /** veraPDF's path to the object of the PDF. */
+    location: string | null;
+}
+/**
+ * What the validator said about a file as PDF/A: which rules of the format it passed, by which
+ * validator. A render delivers a file only when it passed; a failed render keeps the report.
+ */
+export interface Pdfa {
+    standard: 'PDF/A-2b' | 'PDF/A-3b' | (string & {});
+    conformant: boolean;
+    /** The validator and its version, `veraPDF 1.30.2`. */
+    validator: string;
+    /** The validator's own id for this report. */
+    id: string;
+    versions: Record<string, string>;
+    /** SHA-256 of the file that was judged: the delivered file of a render that succeeded. */
+    pdf_sha256: string | null;
+    /** At most 50; empty for a file that passed. */
+    messages: PdfaMessage[];
+    truncated?: boolean;
+}
 /** Where the result of a PDF tool is stored, as for a render. */
 export interface PdfOutputOptions {
     filename?: string;
@@ -325,6 +362,12 @@ export interface Render {
      * renders made before the feature.
      */
     accessibility?: Accessibility | null;
+    /**
+     * The validator's verdict on the file as PDF/A; null unless the render set `settings.pdf.pdfa`.
+     * A render whose file failed keeps it too, which is where it names the rules. Absent from renders
+     * made before the feature.
+     */
+    pdfa?: Pdfa | null;
     timings: Record<string, number> | null;
     error: {
         code?: string;
@@ -540,7 +583,8 @@ export interface RenderInput {
     url?: string;
     data?: Record<string, unknown>;
     locale?: string | null;
-    output?: OutputFormat;
+    /** One of today's output formats, or one a later release of the API adds. */
+    output?: OutputFormat | (string & {});
     settings?: Record<string, unknown>;
     filename?: string;
     post?: Record<string, unknown>;
@@ -692,6 +736,8 @@ export interface TemplateCreate extends TemplateFiles {
     kind: TemplateKind;
     engine: Engine;
     tags?: string[];
+    /** What version 1 is; shown in the version history. */
+    change_note?: string;
     publish?: boolean;
 }
 export interface TemplateVersionCreate extends TemplateFiles {