chromiumly 2.8.0 → 2.10.0

package/src/libre-office/utils/constants.ts

@@ -1,82 +1,132 @@
 export const LIBRE_OFFICE_EXTENSIONS = [
+    '123',
+    '602',
+    'abw',
     'bib',
+    'bmp',
+    'cdr',
+    'cgm',
+    'cmx',
+    'csv',
+    'cwk',
+    'dbf',
+    'dif',
     'doc',
-    'xml',
+    'docm',
     'docx',
-    'fodt',
-    'html',
-    'ltx',
-    'txt',
-    'odt',
-    'ott',
-    'pdb',
-    'pdf',
-    'psw',
-    'rtf',
-    'sdw',
-    'stw',
-    'sxw',
-    'uot',
-    'vor',
-    'wps',
-    'epub',
-    'png',
-    'bmp',
+    'dot',
+    'dotm',
+    'dotx',
+    'dxf',
     'emf',
     'eps',
+    'epub',
     'fodg',
+    'fodp',
+    'fods',
+    'fodt',
+    'fopd',
     'gif',
+    'htm',
+    'html',
+    'hwp',
+    'jpeg',
     'jpg',
+    'key',
+    'ltx',
+    'lwp',
+    'mcw',
     'met',
+    'mml',
+    'mw',
+    'numbers',
     'odd',
+    'odg',
+    'odm',
+    'odp',
+    'ods',
+    'odt',
     'otg',
+    'oth',
+    'otp',
+    'ots',
+    'ott',
+    'pages',
     'pbm',
+    'pcd',
     'pct',
+    'pcx',
+    'pdb',
+    'pdf',
     'pgm',
+    'png',
+    'pot',
+    'potm',
+    'potx',
     'ppm',
+    'pps',
+    'ppt',
+    'pptm',
+    'pptx',
+    'psd',
+    'psw',
+    'pub',
+    'pwp',
+    'pxl',
     'ras',
+    'rtf',
+    'sda',
+    'sdc',
+    'sdd',
+    'sdp',
+    'sdw',
+    'sgl',
+    'slk',
+    'smf',
+    'stc',
     'std',
+    'sti',
+    'stw',
     'svg',
     'svm',
     'swf',
+    'sxc',
     'sxd',
+    'sxg',
+    'sxi',
+    'sxm',
     'sxw',
+    'tga',
+    'tif',
     'tiff',
-    'xhtml',
-    'xpm',
-    'fodp',
-    'pages',
-    'potm',
-    'pot',
-    'pptx',
-    'pps',
-    'ppt',
-    'pwp',
-    'sda',
-    'sdd',
-    'sti',
-    'sxi',
+    'txt',
+    'uof',
     'uop',
-    'wmf',
-    'csv',
-    'dbf',
-    'dif',
-    'fods',
-    'ods',
-    'ots',
-    'pxl',
-    'sdc',
-    'slk',
-    'stc',
-    'sxc',
     'uos',
+    'uot',
+    'vdx',
+    'vor',
+    'vsd',
+    'vsdm',
+    'vsdx',
+    'wb2',
+    'wk1',
+    'wks',
+    'wmf',
+    'wpd',
+    'wpg',
+    'wps',
+    'xbm',
+    'xhtml',
     'xls',
-    'xlt',
+    'xlsb',
+    'xlsm',
     'xlsx',
-    'tif',
-    'jpeg',
-    'odp',
-    'odg',
-    'dotx',
-    'xltx'
+    'xlt',
+    'xltm',
+    'xltx',
+    'xlw',
+    'xml',
+    'xpm',
+    'zabw'
 ];

package/src/libre-office/utils/libre-office.utils.ts

@@ -81,5 +81,12 @@ export class LibreOfficeUtils {
                 `${pageProperties.nativePageRanges.from}-${pageProperties.nativePageRanges.to}`
             );
         }
+
+        if (pageProperties.exportFormFields === false) {
+            data.append(
+                'exportFormFields',
+                String(pageProperties.exportFormFields)
+            );
+        }
     }
 }

package/src/libre-office/utils/tests/libre-office.utils.test.ts

@@ -109,6 +109,21 @@ describe('LibreOfficeUtils', () => {
             });
         });
 
+        describe('Export form fields', () => {
+            describe('when exportFormFields parameter is set', () => {
+                it('should append exportFormFields to data', () => {
+                    LibreOfficeUtils.addPageProperties(data, {
+                        exportFormFields: false
+                    });
+                    expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
+                    expect(data.append).toHaveBeenCalledWith(
+                        'exportFormFields',
+                        'false'
+                    );
+                });
+            });
+        });
+
         describe('Page ranges', () => {
             describe('when nativePageRanges is valid', () => {
                 it('should append nativePageRanges to data', () => {

package/src/main.config.ts

@@ -15,7 +15,9 @@ export enum ChromiumRoute {
  * @enum {string}
  */
 enum PdfEngineRoute {
-    MERGE = 'merge'
+    MERGE = 'merge',
+    READ_METADATA = 'metadata/read',
+    WRITE_METADATA = 'metadata/write'
 }
 
 /**
@@ -75,7 +77,9 @@ export class Chromiumly {
      * @type {Object}
      */
     public static readonly PDF_ENGINE_ROUTES = {
-        merge: PdfEngineRoute.MERGE
+        merge: PdfEngineRoute.MERGE,
+        readMetadata: PdfEngineRoute.READ_METADATA,
+        writeMetadata: PdfEngineRoute.WRITE_METADATA
     };
 
     /**

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

@@ -4,7 +4,12 @@ import path from 'path';
 import FormData from 'form-data';
 
 import { Chromiumly } from '../main.config';
-import { GotenbergUtils, PathLikeOrReadStream, PdfFormat } from '../common';
+import {
+    GotenbergUtils,
+    PathLikeOrReadStream,
+    PdfFormat,
+    Metadata
+} from '../common';
 import { LibreOfficeUtils, PageProperties } from '../libre-office';
 import { PDFEngineUtils } from './utils/engine.utils';
 
@@ -50,6 +55,10 @@ export class PDFEngine {
     }: {
         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;
         pdfUA?: boolean;
         merge?: boolean;
@@ -79,6 +88,48 @@ export class PDFEngine {
         return GotenbergUtils.fetch(endpoint, data);
     }
 
+    /**
+     * Reads metadata from the provided files.
+     *
+     * @param {PathLikeOrReadStream[]} files An array of PathLikes or ReadStreams to the PDF files.
+     * @returns {Promise<Buffer>} A Promise resolving to the metadata buffer.
+     */
+    public static async readMetadata(
+        files: PathLikeOrReadStream[]
+    ): Promise<Buffer> {
+        const data = new FormData();
+
+        await PDFEngineUtils.addFiles(files, data);
+
+        const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.readMetadata}`;
+
+        return GotenbergUtils.fetch(endpoint, data);
+    }
+
+    /**
+     * Writes metadata to the provided PDF files.
+     *
+     * @param {PathLikeOrReadStream[]} files - An array of PathLikes or ReadStreams to the PDF files.
+     * @param {Metadata} metadata - Metadata to be written.
+     * @returns {Promise<Buffer>} A Promise that resolves to the PDF file containing metadata as a buffer.
+     */
+    public static async writeMetadata({
+        files,
+        metadata
+    }: {
+        files: PathLikeOrReadStream[];
+        metadata: Metadata;
+    }): Promise<Buffer> {
+        const data = new FormData();
+        data.append('metadata', JSON.stringify(metadata));
+
+        await PDFEngineUtils.addFiles(files, data);
+
+        const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.writeMetadata}`;
+
+        return GotenbergUtils.fetch(endpoint, data);
+    }
+
     /**
      * Generates a PDF file from a buffer and saves it to the "__generated__" directory.
      *

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

@@ -68,6 +68,42 @@ describe('PDFEngine', () => {
         });
     });
 
+    describe('readMetadata', () => {
+        it('should return a buffer', async () => {
+            mockPromisesAccess.mockResolvedValue();
+            mockFetch.mockResolvedValue(new Response('content'));
+            const buffer = await PDFEngine.readMetadata(['path/to/file.pdf']);
+            expect(buffer).toEqual(Buffer.from('content'));
+            expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
+        });
+    });
+
+    describe('writeMetadata', () => {
+        it('should return a buffer', async () => {
+            mockPromisesAccess.mockResolvedValue();
+            mockFetch.mockResolvedValue(new Response('content'));
+            const buffer = await PDFEngine.writeMetadata({
+                files: ['path/to/file.pdf'],
+                metadata: {
+                    Author: 'John Doe',
+                    Copyright: 'John Doe',
+                    CreationDate: Date.now(),
+                    Creator: 'Chromiumly',
+                    Keywords: ['first', 'second'],
+                    Marked: true,
+                    ModDate: Date.now(),
+                    PDFVersion: 1.7,
+                    Producer: 'Chromiumly',
+                    Subject: 'Sample',
+                    Title: 'Sample',
+                    Trapped: 'Unknown'
+                }
+            });
+            expect(buffer).toEqual(Buffer.from('content'));
+            expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+        });
+    });
+
     describe('generate', () => {
         const mockFilename = 'test.pdf';
         const mockBuffer = Buffer.from('mock pdf content');