SDK changelog

The ForkPDF Node SDK sends its name and version on every API request. The API compares that version with the latest published SDK and returns version headers. The SDK prints a one-time warning when an update is available.

Latest version

1.6.0 is the current published version.

npm install forkpdf@latest

Version response headers

SDK requests include X-ForkPDF-Client and X-ForkPDF-Version. Every API response for an SDK request includes:

Header Meaning
X-ForkPDF-SDK-Latest The latest published SDK version.
X-ForkPDF-SDK-Status current or outdated.
X-ForkPDF-SDK-Upgrade-Url This changelog page when the SDK is outdated.

Raw API clients that do not send the SDK headers do not receive these response headers.

SDK warning

When the API reports outdated, the SDK prints one console.warn per process:

[forkpdf] SDK <installed> is outdated. Latest is <latest>. Update with: npm install forkpdf@latest (https://forkpdf.com/docs/sdk/changelog/)

The warning never blocks generation. Set FORKPDF_DISABLE_UPDATE_WARNING=1 to suppress it in CI environments that treat warnings as failures.

PDF/UA-2 requests print a separate one-time experimental warning. Set FORKPDF_DISABLE_EXPERIMENTAL_WARNING=1 to suppress that warning. The API warning fields are still returned regardless of the SDK setting.

Current release: 1.6.0

  • Adds pdfUa: 1 and pdfUa: 2 tagged output paths.
  • Adds standalone PDF/A-2/3/4 and combined PDF/A + PDF/UA requests.
  • Adds fontPolicy: 'strict' for inline-font enforcement.
  • Adds enriched complianceStatus with fontPolicy, pdfAFlavor, and pdfUaVersion.
  • Adds GET /v1/compliance/capabilities discovery support.
  • Adds UNSUPPORTED_COMPLIANCE_COMBINATION and COMPLIANCE_FORM_UNSUPPORTED.
  • Includes the shared compliance matrix and capability-level status model.
  • See PDF/UA and PDF/A generation for limitations and warnings.

1.5.0

  • Adds experimental PDF/UA-2 generation through compliance: { pdfUa: 2 }.
  • Adds experimental, warnings, and compliance to generation results.
  • Prints a one-time experimental warning unless FORKPDF_DISABLE_EXPERIMENTAL_WARNING=1 is set.
  • Adds ComplianceOptions to the TypeScript definitions.

1.4.10

Starting with 1.4.10, every SDK release is documented here. Previous versions are not listed.

  • One-time console warning when the API reports an outdated SDK.
  • Reads X-ForkPDF-SDK-Latest, X-ForkPDF-SDK-Status, and X-ForkPDF-SDK-Upgrade-Url.
  • Derives the SDK version from package.json.

Related