chromiumly 3.0.0 → 3.1.0

package/src/gotenberg.ts

@@ -20,11 +20,35 @@ if (dotenvConfig.error) {
  */
 export class Gotenberg {
     /**
-     * The Gotenberg service endpoint.
-     * Defaults to the value from the environment variable `GOTENBERG_ENDPOINT`, or falls back to the configuration file.
+     * The endpoint for the Gotenberg service.
      * @type {string}
      */
-    public static endpoint: string =
-        process.env.GOTENBERG_ENDPOINT ||
-        config.get<string>('gotenberg.endpoint');
+    static get endpoint(): string {
+        return (
+            process.env.GOTENBERG_ENDPOINT ||
+            config.get<string>('gotenberg.endpoint')
+        );
+    }
+
+    /**
+     * The username for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    static get username(): string | undefined {
+        const hasUsername = config.has('gotenberg.api.basicAuth.username');
+        return hasUsername
+            ? config.get<string>('gotenberg.api.basicAuth.username')
+            : process.env.GOTENBERG_API_BASIC_AUTH_USERNAME;
+    }
+
+    /**
+     * The password for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    static get password(): string | undefined {
+        const hasPassword = config.has('gotenberg.api.basicAuth.password');
+        return hasPassword
+            ? config.get<string>('gotenberg.api.basicAuth.password')
+            : process.env.GOTENBERG_API_BASIC_AUTH_PASSWORD;
+    }
 }

package/src/libre-office/interfaces/libre-office.types.ts

@@ -1,9 +1,150 @@
+import { ReadStream } from 'fs';
 import { Metadata, PdfFormat } from '../../common';
 
+type FileExtension =
+    | '123'
+    | '602'
+    | 'abw'
+    | 'bib'
+    | 'bmp'
+    | 'cdr'
+    | 'cgm'
+    | 'cmx'
+    | 'csv'
+    | 'cwk'
+    | 'dbf'
+    | 'dif'
+    | 'doc'
+    | 'docm'
+    | 'docx'
+    | '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'
+    | 'txt'
+    | 'uof'
+    | 'uop'
+    | 'uos'
+    | 'uot'
+    | 'vdx'
+    | 'vor'
+    | 'vsd'
+    | 'vsdm'
+    | 'vsdx'
+    | 'wb2'
+    | 'wk1'
+    | 'wks'
+    | 'wmf'
+    | 'wpd'
+    | 'wpg'
+    | 'wps'
+    | 'xbm'
+    | 'xhtml'
+    | 'xls'
+    | 'xlsb'
+    | 'xlsm'
+    | 'xlsx'
+    | 'xlt'
+    | 'xltm'
+    | 'xltx'
+    | 'xlw'
+    | 'xml'
+    | 'xpm'
+    | 'zabw';
+
+type FileInfo = {
+    data: Buffer | ReadStream;
+    ext: FileExtension;
+};
+
+export type PathLikeOrReadStream = string | FileInfo;
+
 export type PageProperties = {
     landscape?: boolean; // Set the paper orientation to landscape (default false)
     nativePageRanges?: { from: number; to: number }; // Page ranges to print
     exportFormFields?: boolean; // Set whether to export the form fields or to use the inputted/selected content of the fields (default true)
+    singlePageSheets?: boolean; // Set whether to render the entire spreadsheet as a single page. (default false)
 };
 
 export type ConversionOptions = {

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

@@ -1,13 +1,11 @@
 import FormData from 'form-data';
 
 import { Chromiumly } from '../main.config';
+import { GotenbergUtils, PdfFormat, Metadata } from '../common';
 import {
-    GotenbergUtils,
-    PathLikeOrReadStream,
-    PdfFormat,
-    Metadata
-} from '../common';
-import { PageProperties } from './interfaces/libre-office.types';
+    PageProperties,
+    PathLikeOrReadStream
+} from './interfaces/libre-office.types';
 import { LibreOfficeUtils } from './utils/libre-office.utils';
 
 /**
@@ -53,6 +51,11 @@ export class LibreOffice {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 }

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

@@ -1,21 +1,33 @@
-import { constants, createReadStream, promises, ReadStream } from 'fs';
+import { constants, createReadStream, promises } from 'fs';
 import path from 'path';
 
-import { fromStream, fromBuffer } from 'file-type';
-
 import FormData from 'form-data';
 
-import { GotenbergUtils, PathLikeOrReadStream } from '../../common';
+import { GotenbergUtils } from '../../common';
 import { LIBRE_OFFICE_EXTENSIONS } from './constants';
 import {
     ConversionOptions,
-    PageProperties
+    PageProperties,
+    PathLikeOrReadStream
 } from '../interfaces/libre-office.types';
 
 /**
  * Utility class for handling common tasks related to LibreOffice conversions.
  */
 export class LibreOfficeUtils {
+    private static async getFileInfo(file: PathLikeOrReadStream) {
+        if (typeof file === 'string') {
+            await promises.access(file, constants.R_OK);
+            const filename = path.basename(path.parse(file).base);
+            return {
+                data: createReadStream(file),
+                ext: path.extname(filename).slice(1)
+            };
+        } else {
+            return { data: file.data, ext: file.ext };
+        }
+    }
+
     /**
      * Adds files to the FormData object for LibreOffice conversion.
      *
@@ -27,33 +39,15 @@ export class LibreOfficeUtils {
         files: PathLikeOrReadStream[],
         data: FormData
     ) {
-        for (const [key, value] of files.entries()) {
-            let file = value;
-            let fileInfo;
-
-            if (Buffer.isBuffer(value)) {
-                fileInfo = await fromBuffer(value);
-            } else if (value instanceof ReadStream) {
-                fileInfo = await fromStream(value);
-            } else {
-                await promises.access(value, constants.R_OK);
-                const filename = path.basename(value.toString());
-                fileInfo = { ext: path.extname(filename).slice(1) };
-                file = createReadStream(value);
-            }
-
-            if (!fileInfo) {
-                throw new Error('File type could not be determined');
-            }
-
-            const extension = fileInfo.ext;
-
-            if (LIBRE_OFFICE_EXTENSIONS.includes(extension)) {
-                data.append('files', file, `${key}.${extension}`);
-            } else {
-                throw new Error(`${extension} is not supported`);
-            }
-        }
+        await Promise.all(
+            files.map(async (file, key) => {
+                const fileInfo = await this.getFileInfo(file);
+                if (!LIBRE_OFFICE_EXTENSIONS.includes(fileInfo.ext)) {
+                    throw new Error(`${fileInfo.ext} is not supported`);
+                }
+                data.append('files', fileInfo.data, `${key}.${fileInfo.ext}`);
+            })
+        );
     }
 
     /**
@@ -91,6 +85,13 @@ export class LibreOfficeUtils {
                 String(pageProperties.exportFormFields)
             );
         }
+
+        if (pageProperties.singlePageSheets) {
+            data.append(
+                'singlePageSheets',
+                String(pageProperties.singlePageSheets)
+            );
+        }
     }
 
     /**

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

@@ -3,12 +3,10 @@ import { promises, createReadStream } from 'fs';
 import { LibreOfficeUtils } from '../libre-office.utils';
 
 import FormData from 'form-data';
-import FileType from 'file-type';
 
 describe('LibreOfficeUtils', () => {
     const mockPromisesAccess = jest.spyOn(promises, 'access');
     const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
-    const mockFromBuffer = jest.spyOn(FileType, 'fromBuffer');
 
     const data = new FormData();
 
@@ -37,12 +35,11 @@ describe('LibreOfficeUtils', () => {
             describe('when files parameter contains a buffer', () => {
                 it('should append each file to data', async () => {
                     mockPromisesAccess.mockResolvedValueOnce();
-                    mockFromBuffer.mockResolvedValueOnce({
-                        ext: 'docx',
-                        mime: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-                    });
                     await LibreOfficeUtils.addFiles(
-                        [Buffer.from('data'), 'path/to/file.bib'],
+                        [
+                            { data: Buffer.from('data'), ext: 'csv' },
+                            'path/to/file.bib'
+                        ],
                         data
                     );
                     expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
@@ -53,14 +50,16 @@ describe('LibreOfficeUtils', () => {
         describe('when one of the files has undetermined format', () => {
             it('should throw an error', async () => {
                 mockPromisesAccess.mockResolvedValueOnce();
-                mockFromBuffer.mockResolvedValueOnce(undefined);
 
                 await expect(
                     LibreOfficeUtils.addFiles(
-                        [Buffer.from('data'), 'path/to/file.bib'],
+                        [
+                            { data: Buffer.from('data'), ext: 'docx' },
+                            'path/to/file.none'
+                        ],
                         data
                     )
-                ).rejects.toThrow('File type could not be determined');
+                ).rejects.toThrow('none is not supported');
             });
         });
 
@@ -138,5 +137,20 @@ describe('LibreOfficeUtils', () => {
                 });
             });
         });
+
+        describe('Single page sheets', () => {
+            describe('when singlePageSheets parameter is set', () => {
+                it('should append singlePageSheets to data', () => {
+                    LibreOfficeUtils.addPageProperties(data, {
+                        singlePageSheets: true
+                    });
+                    expect(mockFormDataAppend).toHaveBeenCalledTimes(1);
+                    expect(data.append).toHaveBeenCalledWith(
+                        'singlePageSheets',
+                        'true'
+                    );
+                });
+            });
+        });
     });
 });

package/src/main.config.ts

@@ -38,6 +38,20 @@ export class Chromiumly {
      */
     public static readonly GOTENBERG_ENDPOINT = Gotenberg.endpoint;
 
+    /**
+     * The username for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    public static readonly GOTENBERG_API_BASIC_AUTH_USERNAME =
+        Gotenberg.username;
+
+    /**
+     * The password for basic authentication with the Gotenberg service.
+     * @type {string | undefined}
+     */
+    public static readonly GOTENBERG_API_BASIC_AUTH_PASSWORD =
+        Gotenberg.password;
+
     /**
      * The path for Chromium-related conversions.
      * @type {string}

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

@@ -42,7 +42,12 @@ export class PDFEngines {
             metadata
         });
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.merge}`;
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**
@@ -73,7 +78,12 @@ export class PDFEngines {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**
@@ -91,7 +101,12 @@ export class PDFEngines {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.readMetadata}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**
@@ -115,7 +130,12 @@ export class PDFEngines {
 
         const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.writeMetadata}`;
 
-        return GotenbergUtils.fetch(endpoint, data);
+        return GotenbergUtils.fetch(
+            endpoint,
+            data,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
+            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
+        );
     }
 
     /**