Merge pull request #76 from FacturAPI/feat/preview-pdf

javorosas · web-flow · commit 60e103141e39 · 2025-09-05T18:32:42.000+02:00
add previewPdf method to Invoices
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [4.9.1] 2025-07-21:
+## [4.10.0] 2025-09-04
+
+### Added
+
+- Add `invoices.previewPdf` method to generate a preview PDF of an invoice before stamping it.
+
+## [4.9.1] 2025-07-21
 
 ### Fixed
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "facturapi",
-  "version": "4.9.2",
+  "version": "4.10.0",
   "description": "Librería oficial de Facturapi. Crea CFDIs timbrados y enviados al SAT, XML y PDF",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
diff --git a/src/resources/invoices.ts b/src/resources/invoices.ts
@@ -157,4 +157,13 @@ export default class Invoices {
   copyToDraft(id: string): Promise<Invoice> {
     return this.client.post('/invoices/' + id + '/copy');
   }
+
+  /**
+   * Previews an invoice PDF before stamping it
+   * @param body Invoice data
+   * @returns PDF file in a stream (Node.js) or Blob (browser)
+   */
+  previewPdf(body: Record<string, any>): Promise<NodeJS.ReadableStream | Blob> {
+    return this.client.post('/invoices/preview/pdf', { body });
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "facturapi",`
`3`		`- "version": "4.9.2",`
	`3`	`+ "version": "4.10.0",`
`4`	`4`	`"description": "Librería oficial de Facturapi. Crea CFDIs timbrados y enviados al SAT, XML y PDF",`
`5`	`5`	`"main": "dist/index.cjs.js",`
`6`	`6`	`"module": "dist/index.es.js",`
Original file line number	Diff line number	Diff line change
`@@ -157,4 +157,13 @@ export default class Invoices {`
`157`	`157`	`copyToDraft(id: string): Promise<Invoice> {`
`158`	`158`	`return this.client.post('/invoices/' + id + '/copy');`
`159`	`159`	`}`
	`160`	`+`
	`161`	`+ /**`
	`162`	`+ * Previews an invoice PDF before stamping it`
	`163`	`+ * @param body Invoice data`
	`164`	`+ * @returns PDF file in a stream (Node.js) or Blob (browser)`
	`165`	`+ */`
	`166`	`+ previewPdf(body: Record<string, any>): Promise<NodeJS.ReadableStream \| Blob> {`
	`167`	`+ return this.client.post('/invoices/preview/pdf', { body });`
	`168`	`+ }`
`160`	`169`	`}`