chromiumly 2.10.0 → 3.0.1

package/src/pdf-engines/index.ts

@@ -1 +1 @@
-export { PDFEngine } from './pdf.engine';
+export { PDFEngines } from './pdf-engines';

package/src/pdf-engines/interfaces/pdf-engines.types.ts

@@ -0,0 +1,10 @@
+import { Metadata, PdfFormat } from '../../common';
+
+export type ConversionOptions = {
+    pdfa?: PdfFormat;
+    pdfUA?: boolean;
+};
+
+export type MergeOptions = ConversionOptions & {
+    metadata?: Metadata;
+};

package/src/pdf-engines/{pdf.engine.ts → pdf-engines.ts}

@@ -10,13 +10,12 @@ import {
     PdfFormat,
     Metadata
 } from '../common';
-import { LibreOfficeUtils, PageProperties } from '../libre-office';
-import { PDFEngineUtils } from './utils/engine.utils';
+import { PDFEnginesUtils } from './utils/pdf-engines.utils';
 
 /**
- * Class representing a PDF engine for various operations such as merging and conversion.
+ * Class uses PDF engines for various operations such as merging and conversion.
  */
-export class PDFEngine {
+export class PDFEngines {
     /**
      * Merges multiple PDF files into a single PDF document.
      *
@@ -25,12 +24,23 @@ export class PDFEngine {
      * @returns {Promise<Buffer>} A Promise resolving to the merged PDF content as a Buffer.
      */
     public static async merge({
-        files
+        files,
+        pdfa,
+        pdfUA,
+        metadata
     }: {
         files: PathLikeOrReadStream[];
+        pdfa?: PdfFormat;
+        pdfUA?: boolean;
+        metadata?: Metadata;
     }): Promise<Buffer> {
         const data = new FormData();
-        await PDFEngineUtils.addFiles(files, data);
+        await PDFEnginesUtils.addFiles(files, data);
+        await PDFEnginesUtils.customize(data, {
+            pdfa,
+            pdfUA,
+            metadata
+        });
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.merge}`;
         return GotenbergUtils.fetch(endpoint, data);
     }
@@ -40,48 +50,26 @@ export class PDFEngine {
      *
      * @param {Object} options - Options for the conversion operation.
      * @param {PathLikeOrReadStream[]} options.files - An array of PathLikes or ReadStreams to the files to be converted to PDF.
-     * @param {PageProperties} [options.properties] - Page properties for the conversion.
-     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
+     * @param {pdfa} [options.pdfa] - PDF format options.
      * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
-     * @param {boolean} [options.merge] - Indicates whether to merge the resulting PDFs.
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
     public static async convert({
         files,
-        properties,
-        pdfFormat,
-        pdfUA,
-        merge
+        pdfa,
+        pdfUA
     }: {
         files: PathLikeOrReadStream[];
-        properties?: PageProperties;
-        /**
-         * @deprecated Starting from Gotenberg version 8.0.0, LibreOffice no longer provides support for pdfFormat.
-         * @see {@link https://github.com/gotenberg/gotenberg/releases/tag/v8.0.0}
-         */
-        pdfFormat?: PdfFormat;
+        pdfa?: PdfFormat;
         pdfUA?: boolean;
-        merge?: boolean;
     }): Promise<Buffer> {
         const data = new FormData();
 
-        if (pdfFormat) {
-            data.append('pdfa', pdfFormat);
-        }
-
-        if (pdfUA) {
-            data.append('pdfUA', String(pdfUA));
-        }
-
-        if (merge) {
-            data.append('merge', String(merge));
-        }
-
-        if (properties) {
-            LibreOfficeUtils.addPageProperties(data, properties);
-        }
-
-        await LibreOfficeUtils.addFiles(files, data);
+        await PDFEnginesUtils.addFiles(files, data);
+        await PDFEnginesUtils.customize(data, {
+            pdfa,
+            pdfUA
+        });
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
 
@@ -99,7 +87,7 @@ export class PDFEngine {
     ): Promise<Buffer> {
         const data = new FormData();
 
-        await PDFEngineUtils.addFiles(files, data);
+        await PDFEnginesUtils.addFiles(files, data);
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.readMetadata}`;
 
@@ -123,7 +111,7 @@ export class PDFEngine {
         const data = new FormData();
         data.append('metadata', JSON.stringify(metadata));
 
-        await PDFEngineUtils.addFiles(files, data);
+        await PDFEnginesUtils.addFiles(files, data);
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.writeMetadata}`;
 

package/src/pdf-engines/tests/pdf.engine.test.ts

@@ -6,12 +6,12 @@ import fetch from 'node-fetch';
 import path from 'path';
 
 import { PdfFormat } from '../../common';
-import { PDFEngine } from '../pdf.engine';
+import { PDFEngines } from '../pdf-engines';
 
 const { Response } = jest.requireActual('node-fetch');
 jest.mock('node-fetch', () => jest.fn());
 
-describe('PDFEngine', () => {
+describe('PDFEngines', () => {
     const mockPromisesAccess = jest.spyOn(promises, 'access');
     const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
     const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
@@ -31,8 +31,8 @@ describe('PDFEngine', () => {
             it('should return a buffer', async () => {
                 mockPromisesAccess.mockResolvedValue();
                 mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await PDFEngine.convert({
-                    files: ['path/to/file.docx', 'path/to/file.bib']
+                const buffer = await PDFEngines.convert({
+                    files: ['path/to/file_1.pdf', 'path/to/file_2.pdf']
                 });
                 expect(buffer).toEqual(Buffer.from('content'));
                 expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
@@ -43,15 +43,13 @@ describe('PDFEngine', () => {
             it('should return a buffer', async () => {
                 mockPromisesAccess.mockResolvedValue();
                 mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await PDFEngine.convert({
-                    files: ['path/to/file.docx', 'path/to/file.bib'],
-                    properties: { landscape: true },
-                    pdfFormat: PdfFormat.A_1a,
-                    pdfUA: true,
-                    merge: true
+                const buffer = await PDFEngines.convert({
+                    files: ['path/to/file_1.pdf', 'path/to/file_2.pdf'],
+                    pdfa: PdfFormat.A_2b,
+                    pdfUA: true
                 });
                 expect(buffer).toEqual(Buffer.from('content'));
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(6);
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(4);
             });
         });
     });
@@ -60,11 +58,14 @@ describe('PDFEngine', () => {
         it('should return a buffer', async () => {
             mockPromisesAccess.mockResolvedValue();
             mockFetch.mockResolvedValue(new Response('content'));
-            const buffer = await PDFEngine.merge({
-                files: ['path/to/file.pdf', 'path/to/another-file.pdf']
+            const buffer = await PDFEngines.merge({
+                files: ['path/to/file.pdf', 'path/to/another-file.pdf'],
+                pdfa: PdfFormat.A_2b,
+                pdfUA: true,
+                metadata: { Author: 'John Doe' }
             });
             expect(buffer).toEqual(Buffer.from('content'));
-            expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+            expect(mockFormDataAppend).toHaveBeenCalledTimes(5);
         });
     });
 
@@ -72,7 +73,7 @@ describe('PDFEngine', () => {
         it('should return a buffer', async () => {
             mockPromisesAccess.mockResolvedValue();
             mockFetch.mockResolvedValue(new Response('content'));
-            const buffer = await PDFEngine.readMetadata(['path/to/file.pdf']);
+            const buffer = await PDFEngines.readMetadata(['path/to/file.pdf']);
             expect(buffer).toEqual(Buffer.from('content'));
             expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
         });
@@ -82,7 +83,7 @@ describe('PDFEngine', () => {
         it('should return a buffer', async () => {
             mockPromisesAccess.mockResolvedValue();
             mockFetch.mockResolvedValue(new Response('content'));
-            const buffer = await PDFEngine.writeMetadata({
+            const buffer = await PDFEngines.writeMetadata({
                 files: ['path/to/file.pdf'],
                 metadata: {
                     Author: 'John Doe',
@@ -127,7 +128,7 @@ describe('PDFEngine', () => {
                 .spyOn(fs, 'writeFile')
                 .mockResolvedValueOnce();
 
-            await PDFEngine.generate(mockFilename, mockBuffer);
+            await PDFEngines.generate(mockFilename, mockBuffer);
 
             expect(mockPromisesMkDir).toHaveBeenCalledWith(mockGeneratedDir, {
                 recursive: true
@@ -145,7 +146,7 @@ describe('PDFEngine', () => {
             );
 
             await expect(
-                PDFEngine.generate(mockFilename, mockBuffer)
+                PDFEngines.generate(mockFilename, mockBuffer)
             ).rejects.toThrow('Cannot create directory');
         });
 
@@ -155,7 +156,7 @@ describe('PDFEngine', () => {
             );
 
             await expect(
-                PDFEngine.generate(mockFilename, mockBuffer)
+                PDFEngines.generate(mockFilename, mockBuffer)
             ).rejects.toThrow('Failed to write to file');
         });
     });

package/src/pdf-engines/utils/{engine.utils.ts → pdf-engines.utils.ts}

@@ -3,11 +3,15 @@ import path from 'path';
 
 import FormData from 'form-data';
 import { PathLikeOrReadStream } from '../../common';
+import {
+    ConversionOptions,
+    MergeOptions
+} from '../interfaces/pdf-engines.types';
 
 /**
  * Utility class for handling common tasks related to PDF engine operations.
  */
-export class PDFEngineUtils {
+export class PDFEnginesUtils {
     /**
      * Adds PDF files to the FormData object.
      *
@@ -37,4 +41,28 @@ export class PDFEngineUtils {
             }
         }
     }
+
+    /**
+     * Customizes the FormData object based on the provided conversion options.
+     *
+     * @param {FormData} data - The FormData object to be customized.
+     * @param {ConversionOptions | MergeOptions} options - The options to apply to the FormData.
+     * @returns {Promise<void>} A Promise that resolves once the customization is complete.
+     */
+    public static async customize(
+        data: FormData,
+        options: ConversionOptions | MergeOptions
+    ): Promise<void> {
+        if (options.pdfa) {
+            data.append('pdfa', options.pdfa);
+        }
+
+        if (options.pdfUA) {
+            data.append('pdfUA', String(options.pdfUA));
+        }
+
+        if ('metadata' in options && options.metadata) {
+            data.append('metadata', JSON.stringify(options.metadata));
+        }
+    }
 }

package/src/pdf-engines/utils/tests/{engine.utils.test.ts → pdf-engines.utils.test.ts}

@@ -1,10 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { createReadStream, promises } from 'fs';
 import FormData from 'form-data';
+import { PDFEnginesUtils } from '../pdf-engines.utils';
 
-import { PDFEngineUtils } from '../engine.utils';
-
-describe('PDFEngineUtils', () => {
+describe('PDFEnginesUtils', () => {
     const mockPromisesAccess = jest.spyOn(promises, 'access');
     const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
     const data = new FormData();
@@ -24,7 +23,7 @@ describe('PDFEngineUtils', () => {
             describe('when files parameter contains paths', () => {
                 it('should append each file to data', async () => {
                     mockPromisesAccess.mockResolvedValue();
-                    await PDFEngineUtils.addFiles(
+                    await PDFEnginesUtils.addFiles(
                         ['path/to/file.pdf', 'path/to/another-file.pdf'],
                         data
                     );
@@ -34,7 +33,7 @@ describe('PDFEngineUtils', () => {
             describe('when files parameter contains a buffer', () => {
                 it('should append each file to data', async () => {
                     mockPromisesAccess.mockResolvedValue();
-                    await PDFEngineUtils.addFiles(
+                    await PDFEnginesUtils.addFiles(
                         [Buffer.from('data'), 'path/to/another-file.pdf'],
                         data
                     );
@@ -47,7 +46,7 @@ describe('PDFEngineUtils', () => {
             it('should throw an error', async () => {
                 mockPromisesAccess.mockResolvedValue();
                 await expect(() =>
-                    PDFEngineUtils.addFiles(
+                    PDFEnginesUtils.addFiles(
                         ['path/to/file.docx', 'path/to/file.pdf'],
                         data
                     )
@@ -61,7 +60,7 @@ describe('PDFEngineUtils', () => {
                     "ENOENT: no such file or directory, access 'path/to/index.html'";
                 mockPromisesAccess.mockRejectedValue(new Error(errorMessage));
                 await expect(() =>
-                    PDFEngineUtils.addFiles(
+                    PDFEnginesUtils.addFiles(
                         ['path/to/file.pdf', 'path/to/another-file.pdf'],
                         data
                     )

package/dist/pdf-engines/pdf.engine.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pdf.engine.js","sourceRoot":"","sources":["../../src/pdf-engines/pdf.engine.ts"],"names":[],"mappings":";;;;AAAA,2BAA8B;AAC9B,wDAAwB;AAExB,kEAAiC;AAEjC,gDAA4C;AAC5C,sCAKmB;AACnB,kDAAmE;AACnE,uDAAsD;AAEtD;;GAEG;AACH,MAAa,SAAS;IAClB;;;;;;OAMG;IACI,MAAM,CAAO,KAAK;qEAAC,EACtB,KAAK,EAGR;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YACzH,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAO,OAAO;qEAAC,EACxB,KAAK,EACL,UAAU,EACV,SAAS,EACT,KAAK,EACL,KAAK,EAWR;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,SAAS,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACnC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,UAAU,EAAE,CAAC;gBACb,+BAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACzD,CAAC;YAED,MAAM,+BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE7C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,iBAAiB,IAAI,wBAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAE9H,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;OAKG;IACI,MAAM,CAAO,YAAY,CAC5B,KAA6B;;YAE7B,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,YAAY,EAAE,CAAC;YAEhI,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;OAMG;IACI,MAAM,CAAO,aAAa;qEAAC,EAC9B,KAAK,EACL,QAAQ,EAIX;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YAElD,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,aAAa,EAAE,CAAC;YAEjI,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CACxB,QAAgB,EAChB,MAAc;;YAEd,MAAM,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAAC;YACnE,MAAM,aAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,MAAM,aAAQ,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;KAAA;CACJ;AAjID,8BAiIC"}

package/dist/pdf-engines/utils/engine.utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"engine.utils.js","sourceRoot":"","sources":["../../../src/pdf-engines/utils/engine.utils.ts"],"names":[],"mappings":";;;;AAAA,2BAAuE;AACvE,wDAAwB;AAKxB;;GAEG;AACH,MAAa,cAAc;IACvB;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CACxB,KAA6B,EAC7B,IAAc;;YAEd,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;gBACxC,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;gBAClC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,IAAI,IAAI,YAAY,eAAU,EAAE,CAAC;oBACpC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACzC,CAAC;qBAAM,CAAC;oBACJ,MAAM,aAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;oBAC5C,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAChD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBACzC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;wBACvB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAA,qBAAgB,EAAC,IAAI,CAAC,CAAC,CAAC;oBAClD,CAAC;yBAAM,CAAC;wBACJ,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;oBACrD,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;KAAA;CACJ;AA9BD,wCA8BC"}