feat: Added page.htmlTemplate support

Author: TriPSs

src/__tests__/pdf.spec.ts

@@ -11,25 +11,27 @@ describe('PDF', () => {
 
   axiosMock.onAny().reply(200, Buffer.from(''))
 
-  test('it should encode the pdf.headerTemplate and pdf.footerTemplate options', async () => {
+  test('it should encode the page.html, page.htmlTemplate, pdf.headerHtml and pdf.footerHtml options', async () => {
     await client.pdf.direct({
       page: {
-        html: '<div>Your first Doczilla PDF</div>'
+        html: '<div>Your first Doczilla PDF</div>',
+        htmlTemplate: '<div>Your first Doczilla {{ type }}</div>',
       },
       pdf: {
-        headerTemplate: '<div>Header template</div>',
-        footerTemplate: '<div>Footer template</div>'
+        headerHtml: '<div>Header template</div>',
+        footerHtml: '<div>Footer template</div>'
       }
     })
 
     expect(axiosMock.history.post.length).toBe(1)
     expect(axiosMock.history.post[0].data).toEqual(JSON.stringify({
       page: {
-        html: 'PGRpdj5Zb3VyIGZpcnN0IERvY3ppbGxhIFBERjwvZGl2Pg=='
+        html: 'PGRpdj5Zb3VyIGZpcnN0IERvY3ppbGxhIFBERjwvZGl2Pg==',
+        htmlTemplate: 'PGRpdj5Zb3VyIGZpcnN0IERvY3ppbGxhIHt7IHR5cGUgfX08L2Rpdj4='
       },
       pdf: {
-        headerTemplate: 'PGRpdj5IZWFkZXIgdGVtcGxhdGU8L2Rpdj4=',
-        footerTemplate: 'PGRpdj5Gb290ZXIgdGVtcGxhdGU8L2Rpdj4='
+        headerHtml: 'PGRpdj5IZWFkZXIgdGVtcGxhdGU8L2Rpdj4=',
+        footerHtml: 'PGRpdj5Gb290ZXIgdGVtcGxhdGU8L2Rpdj4='
       }
     }))
   })

src/generated/index.ts

@@ -6,20 +6,27 @@
 export { AsyncJob } from './models/AsyncJob';
 export type { AsyncPdf } from './models/AsyncPdf';
 export type { AsyncScreenshot } from './models/AsyncScreenshot';
+export type { BadRequestResponse } from './models/BadRequestResponse';
 export type { CreatePdf } from './models/CreatePdf';
 export type { CreateScreenshot } from './models/CreateScreenshot';
+export type { ForbiddenResponse } from './models/ForbiddenResponse';
+export type { InternalServerErrorResponse } from './models/InternalServerErrorResponse';
 export type { PageAuthentication } from './models/PageAuthentication';
 export { PageCookie } from './models/PageCookie';
 export { PageOptions } from './models/PageOptions';
+export type { PayloadTooLargeResponse } from './models/PayloadTooLargeResponse';
 export type { PDFMargin } from './models/PDFMargin';
 export { PdfOptions } from './models/PdfOptions';
 export type { ScreenshotClip } from './models/ScreenshotClip';
 export { ScreenshotOptions } from './models/ScreenshotOptions';
 export { ScreenshotOverlay } from './models/ScreenshotOverlay';
 export type { ScreenshotViewport } from './models/ScreenshotViewport';
 export type { StorageOptions } from './models/StorageOptions';
+export type { SubscriptionLimitReachedResponse } from './models/SubscriptionLimitReachedResponse';
 export { SyncJob } from './models/SyncJob';
 export type { SyncPdf } from './models/SyncPdf';
 export type { SyncScreenshot } from './models/SyncScreenshot';
+export type { TooManyRequestsResponse } from './models/TooManyRequestsResponse';
+export type { UnauthorizedResponse } from './models/UnauthorizedResponse';
 export { WebhookEvent } from './models/WebhookEvent';
 export { WebhookOptions } from './models/WebhookOptions';

src/generated/models/AsyncPdf.ts

@@ -10,13 +10,9 @@ import type { WebhookOptions } from './WebhookOptions';
 
 export type AsyncPdf = {
     /**
-     * Page options, either provide the `url` or `html` option.
+     * Page options, either provide the `url`, `html` or `htmlTemplate` option.
      */
     page: PageOptions;
-    /**
-     * Template data, only used in combination with `page.htmlTemplate`.
-     */
-    templateData?: Record<string, any> | null;
     pdf?: PdfOptions | null;
     storage?: StorageOptions | null;
     /**

src/generated/models/AsyncScreenshot.ts

@@ -10,13 +10,9 @@ import type { WebhookOptions } from './WebhookOptions';
 
 export type AsyncScreenshot = {
     /**
-     * Page options, either provide the `url` or `html` option.
+     * Page options, either provide the `url`, `html` or `htmlTemplate` option.
      */
     page: PageOptions;
-    /**
-     * Template data, only used in combination with `page.htmlTemplate`.
-     */
-    templateData?: Record<string, any> | null;
     screenshot?: ScreenshotOptions | null;
     storage?: StorageOptions | null;
     /**

src/generated/models/CreatePdf.ts

@@ -8,13 +8,9 @@ import type { PdfOptions } from './PdfOptions';
 
 export type CreatePdf = {
     /**
-     * Page options, either provide the `url` or `html` option.
+     * Page options, either provide the `url`, `html` or `htmlTemplate` option.
      */
     page: PageOptions;
-    /**
-     * Template data, only used in combination with `page.htmlTemplate`.
-     */
-    templateData?: Record<string, any> | null;
     pdf?: PdfOptions | null;
 };
 

src/generated/models/CreateScreenshot.ts

@@ -8,13 +8,9 @@ import type { ScreenshotOptions } from './ScreenshotOptions';
 
 export type CreateScreenshot = {
     /**
-     * Page options, either provide the `url` or `html` option.
+     * Page options, either provide the `url`, `html` or `htmlTemplate` option.
      */
     page: PageOptions;
-    /**
-     * Template data, only used in combination with `page.htmlTemplate`.
-     */
-    templateData?: Record<string, any> | null;
     screenshot?: ScreenshotOptions | null;
 };
 

src/generated/models/PageOptions.ts

@@ -19,6 +19,10 @@ export type PageOptions = {
      * HTML template to render. Needs to be base64 encoded!
      */
     htmlTemplate?: string | null;
+    /**
+     * Template data, only used in combination with `page.htmlTemplate`.
+     */
+    templateData?: Record<string, any> | null;
     /**
      * When to consider waiting succeeds.
      * - `auto` our smart waiting option that can handle 90% of the cases.

src/generated/models/SyncPdf.ts

@@ -9,13 +9,9 @@ import type { StorageOptions } from './StorageOptions';
 
 export type SyncPdf = {
     /**
-     * Page options, either provide the `url` or `html` option.
+     * Page options, either provide the `url`, `html` or `htmlTemplate` option.
      */
     page: PageOptions;
-    /**
-     * Template data, only used in combination with `page.htmlTemplate`.
-     */
-    templateData?: Record<string, any> | null;
     pdf?: PdfOptions | null;
     storage?: StorageOptions | null;
 };

src/generated/models/SyncScreenshot.ts

@@ -9,13 +9,9 @@ import type { StorageOptions } from './StorageOptions';
 
 export type SyncScreenshot = {
     /**
-     * Page options, either provide the `url` or `html` option.
+     * Page options, either provide the `url`, `html` or `htmlTemplate` option.
      */
     page: PageOptions;
-    /**
-     * Template data, only used in combination with `page.htmlTemplate`.
-     */
-    templateData?: Record<string, any> | null;
     screenshot?: ScreenshotOptions | null;
     storage?: StorageOptions | null;
 };

src/services/BaseService.ts

@@ -48,12 +48,16 @@ export class BaseService {
       requestBody.page.html = this.baseEncodeContent(requestBody.page.html)
     }
 
-    if (requestBody.pdf?.headerTemplate) {
-      requestBody.pdf.headerTemplate = this.baseEncodeContent(requestBody.pdf.headerTemplate)
+    if (requestBody.page.htmlTemplate) {
+      requestBody.page.htmlTemplate = this.baseEncodeContent(requestBody.page.htmlTemplate)
     }
 
-    if (requestBody.pdf?.footerTemplate) {
-      requestBody.pdf.footerTemplate = this.baseEncodeContent(requestBody.pdf.footerTemplate)
+    if (requestBody.pdf?.headerHtml) {
+      requestBody.pdf.headerHtml = this.baseEncodeContent(requestBody.pdf.headerHtml)
+    }
+
+    if (requestBody.pdf?.footerHtml) {
+      requestBody.pdf.footerHtml = this.baseEncodeContent(requestBody.pdf.footerHtml)
     }
 
     return requestBody