feat: Automatically encode page.html, pdf.headerTemplate and pdf.footerTemplate

Author: TriPSs

src/Doczilla.ts

@@ -1,9 +1,9 @@
 import axios, { Axios } from 'axios'
 
+import { version } from '../package.json'
 import { PdfService } from './services/PdfService'
 import { ScreenshotService } from './services/ScreenshotService'
 import { WebhookService } from './services/WebhookService'
-import { version } from '../package.json'
 
 interface DoczillaOptions {
   baseURL?: string

src/__tests__/page.spec.ts

@@ -0,0 +1,29 @@
+import { describe, expect, test } from '@jest/globals'
+import MockAdapter from 'axios-mock-adapter'
+
+import Doczilla from '../Doczilla'
+
+describe('Page', () => {
+
+  const client = new Doczilla('fake-api-token')
+  // @ts-expect-error private property
+  const axiosMock = new MockAdapter(client.client)
+
+  axiosMock.onAny().reply(200, Buffer.from(''))
+
+  test('it encode the page.html option', async () => {
+    await client.pdf.direct({
+      page: {
+        html: '<div>Your first Doczilla PDF</div>'
+      }
+    })
+
+    expect(axiosMock.history.post.length).toBe(1)
+    expect(axiosMock.history.post[0].data).toEqual(JSON.stringify({
+      page: {
+        html: 'PGRpdj5Zb3VyIGZpcnN0IERvY3ppbGxhIFBERjwvZGl2Pg=='
+      }
+    }))
+  })
+
+})

src/__tests__/pdf.spec.ts

@@ -0,0 +1,37 @@
+import { describe, expect, test } from '@jest/globals'
+import MockAdapter from 'axios-mock-adapter'
+
+import Doczilla from '../Doczilla'
+
+describe('PDF', () => {
+
+  const client = new Doczilla('fake-api-token')
+  // @ts-expect-error private property
+  const axiosMock = new MockAdapter(client.client)
+
+  axiosMock.onAny().reply(200, Buffer.from(''))
+
+  test('it should encode the pdf.headerTemplate and pdf.footerTemplate options', async () => {
+    await client.pdf.direct({
+      page: {
+        html: '<div>Your first Doczilla PDF</div>'
+      },
+      pdf: {
+        headerTemplate: '<div>Header template</div>',
+        footerTemplate: '<div>Footer template</div>'
+      }
+    })
+
+    expect(axiosMock.history.post.length).toBe(1)
+    expect(axiosMock.history.post[0].data).toEqual(JSON.stringify({
+      page: {
+        html: 'PGRpdj5Zb3VyIGZpcnN0IERvY3ppbGxhIFBERjwvZGl2Pg=='
+      },
+      pdf: {
+        headerTemplate: 'PGRpdj5IZWFkZXIgdGVtcGxhdGU8L2Rpdj4=',
+        footerTemplate: 'PGRpdj5Gb290ZXIgdGVtcGxhdGU8L2Rpdj4='
+      }
+    }))
+  })
+
+})

src/services/BaseService.ts

@@ -1,5 +1,11 @@
 import { Axios, AxiosHeaders, AxiosRequestConfig, isAxiosError } from 'axios'
 
+import type { AsyncPdf, AsyncScreenshot, CreatePdf, CreateScreenshot, SyncPdf, SyncScreenshot } from '../generated'
+
+type PdfRequests = CreatePdf | SyncPdf | AsyncPdf
+type ScreenshotRequests = CreateScreenshot | SyncScreenshot | AsyncScreenshot
+type RequestBody = PdfRequests | ScreenshotRequests
+
 export class BaseService {
 
   private rateLimit = {
@@ -16,11 +22,11 @@ export class BaseService {
 
   constructor(private readonly client: Axios) {}
 
-  protected async post<T>(url: string, requestBody: object, config: AxiosRequestConfig = {}, retries = 1): Promise<T> {
+  protected async post<T>(url: string, requestBody: RequestBody, config: AxiosRequestConfig = {}, retries = 1): Promise<T> {
     try {
       await this.waitForRateLimit()
 
-      const axiosResponse = await this.client.post<T>(url, requestBody, config)
+      const axiosResponse = await this.client.post<T>(url, this.encodeRequestBody(requestBody), config)
       this.processRateLimit(new AxiosHeaders(axiosResponse.headers))
 
       if (config.responseType === 'arraybuffer') {
@@ -37,6 +43,22 @@ export class BaseService {
     }
   }
 
+  private encodeRequestBody(requestBody: PdfRequests): object {
+    if (requestBody.page.html) {
+      requestBody.page.html = this.baseEncodeContent(requestBody.page.html)
+    }
+
+    if (requestBody.pdf?.headerTemplate) {
+      requestBody.pdf.headerTemplate = this.baseEncodeContent(requestBody.pdf.headerTemplate)
+    }
+
+    if (requestBody.pdf?.footerTemplate) {
+      requestBody.pdf.footerTemplate = this.baseEncodeContent(requestBody.pdf.footerTemplate)
+    }
+
+    return requestBody
+  }
+
   private async waitForRateLimit(): Promise<void> {
     // Minus 1 to be safe
     if ((this.rateLimit.remaining - 1) <= 0) {
@@ -56,4 +78,7 @@ export class BaseService {
     }
   }
 
+  private baseEncodeContent(content: string): string {
+    return Buffer.from(content).toString('base64')
+  }
 }

src/services/PdfService.ts

@@ -1,4 +1,5 @@
 import type { AsyncJob, AsyncPdf, CreatePdf, SyncJob, SyncPdf } from '../generated'
+
 import { BaseService } from './BaseService'
 
 export class PdfService extends BaseService {

src/services/ScreenshotService.ts

@@ -1,6 +1,7 @@
-import { BaseService } from './BaseService'
 import type { AsyncJob, AsyncScreenshot, CreateScreenshot, SyncJob, SyncScreenshot } from '../generated'
 
+import { BaseService } from './BaseService'
+
 export class ScreenshotService extends BaseService {
 
   /**