chromiumly 2.9.0 → 3.0.0

package/README.md

@@ -8,7 +8,7 @@
 [![downloads](https://img.shields.io/npm/dt/chromiumly.svg?color=brightgreen&style=flat-square)](https://npm-stat.com/charts.html?package=chromiumly)
 ![licence](https://img.shields.io/github/license/cherfia/chromiumly?style=flat-square)
 
-A lightweight Typescript library that interacts with [Gotenberg](https://gotenberg.dev/)'s different modules to convert
+A lightweight Typescript library that interacts with [Gotenberg](https://gotenberg.dev/)'s different routes to convert
 a variety of document formats to PDF files.
 
 # Table of Contents
@@ -21,6 +21,7 @@ a variety of document formats to PDF files.
    - [dotenv](#dotenv)
    - [config](#config)
 3. [Modules](#modules)
+
    - [Chromium](#chromium)
      - [URL](#url)
      - [HTML](#html)
@@ -28,10 +29,14 @@ a variety of document formats to PDF files.
    - [Customization](#customization)
      - [Conversion](#conversion)
      - [Screenshot](#screenshot)
-   - [PDF Engine](#pdf-engine)
+   - [LibreOffice](#libreoffice)
+   - [PDFEngines](#pdfengines)
      - [convert](#convert)
      - [merge](#merge)
+     - [readMetadata](#readmetadata)
+     - [writeMetadata](#writemetadata)
      - [generate](#generate)
+
 4. [Snippet](#snippet)
 
 ## Install
@@ -243,44 +248,59 @@ type ScreenshotOptions = {
 };
 ```
 
-### PDF Engine
-
-The `PDFEngine` combines the functionality of
-Gotenberg's [PDF Engines](https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route)
-and [LibreOffice](https://gotenberg.dev/docs/routes#convert-with-libreoffice) modules to manipulate different file formats.
-
-#### convert
+### LibreOffice
 
-This method interacts with [LibreOffice](https://gotenberg.dev/docs/routes#convert-with-libreoffice) module to convert different
-documents to PDF files. You can find the file extensions
+The `LibreOffice` class comes with a single method `convert`. This method interacts with [LibreOffice](https://gotenberg.dev/docs/routes#convert-with-libreoffice) route to convert different documents to PDF files. You can find the file extensions
 accepted [here](https://gotenberg.dev/docs/routes#convert-with-libreoffice#route).
 
 ```typescript
-import { PDFEngine } from "chromiumly";
+import { LibreOffice } from "chromiumly";
 
-const buffer = await PDFEngine.convert({
+const buffer = await LibreOffice.convert({
   files: ["path/to/file.docx", "path/to/file.png"],
 });
 ```
 
-Similarly to Chromium's module `convert` method, this method takes the following optional parameters :
+Similarly to Chromium's route `convert` method, this method takes the following optional parameters :
 
 - `properties`: changes how the PDF generated file will look like.
-- `pdfFormat`: PDF format of the conversion resulting file (i.e. `PDF/A-1a`, `PDF/A-2b`, `PDF/A-3b`).
-- `merge`: merge all the resulting files from the conversion into an individual PDF file.
+- `pdfa`: PDF format of the conversion resulting file (i.e. `PDF/A-1a`, `PDF/A-2b`, `PDF/A-3b`).
+- `pdfUA`: enables PDF for Universal Access for optimal accessibility.
+- `merge`: merges all the resulting files from the conversion into an individual PDF file.
+- `metadata`: writes metadata to the generated PDF file.
+
+### PDFEngines
+
+The `PDFEngines` class interacts with Gotenberg's [PDF Engines](https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route) routes to manupilate PDF files.
+
+#### convert
+
+This method interacts with [PDF Engines](https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route) convertion route to transform PDF files into the requested PDF/A format and/or PDF/UA.
+
+```typescript
+import { PDFEngines } from "chromiumly";
+
+const buffer = await PDFEngines.convert({
+  files: ["path/to/file_1.pdf", "path/to/file_2.pdf"],
+  pdfa: PdfFormat.A_2b,
+  pdfUA: true,
+});
+```
 
 #### merge
 
-This method interacts with [PDF Engines](https://gotenberg.dev/docs/routes#merge-pdfs-route) module which gathers different
+This method interacts with [PDF Engines](https://gotenberg.dev/docs/routes#merge-pdfs-route) merge route which gathers different
 engines that can manipulate and merge PDF files such
 as: [PDFtk](https://gitlab.com/pdftk-java/pdftk), [PDFcpu](https://github.com/pdfcpu/pdfcpu), [QPDF](https://github.com/qpdf/qpdf),
 and [UNO](https://github.com/unoconv/unoconv).
 
 ```typescript
-import { PDFEngine } from "chromiumly";
+import { PDFEngines } from "chromiumly";
 
-const buffer = await PDFEngine.merge({
-  files: ["path/to/file.docx", "path/to/file.png"],
+const buffer = await PDFEngines.merge({
+  files: ["path/to/file_1.pdf", "path/to/file_2.pdf"],
+  pdfa: PdfFormat.A_2b,
+  pdfUA: true,
 });
 ```
 
@@ -289,9 +309,9 @@ const buffer = await PDFEngine.merge({
 This method reads metadata from the provided PDF files.
 
 ```typescript
-import { PDFEngine } from "chromiumly";
+import { PDFEngines } from "chromiumly";
 
-const metadataBuffer = await PDFEngine.readMetadata([
+const metadataBuffer = await PDFEngines.readMetadata([
   "path/to/file_1.pdf",
   "path/to/file_2.pdf",
 ]);
@@ -302,9 +322,9 @@ const metadataBuffer = await PDFEngine.readMetadata([
 This method writes metadata to the provided PDF files.
 
 ```typescript
-import { PDFEngine } from "chromiumly";
+import { PDFEngines } from "chromiumly";
 
-const buffer = await PDFEngine.writeMetadata({
+const buffer = await PDFEngines.writeMetadata({
   files: [
   "path/to/file_1.pdf",
   "path/to/file_2.pdf",
@@ -331,7 +351,7 @@ Please note that all the PDF files can be found `__generated__` folder in the ro
 The following is a short snippet of how to use the library.
 
 ```typescript
-import { PDFEngine, UrlConverter } from "chromiumly";
+import { PDFEngines, UrlConverter } from "chromiumly";
 
 async function run() {
   const urlConverter = new UrlConverter();
@@ -339,7 +359,7 @@ async function run() {
     url: "https://gotenberg.dev/",
   });
 
-  await PDFEngine.generate("gotenberg.pdf", buffer);
+  await PDFEngines.generate("gotenberg.pdf", buffer);
 }
 
 run();

package/dist/libre-office/index.d.ts

@@ -1,2 +1 @@
-export { PageProperties } from './interfaces/libre-office.types';
-export { LibreOfficeUtils } from './utils/libre-office.utils';
+export { LibreOffice } from './libre-office';

package/dist/libre-office/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LibreOfficeUtils = void 0;
-var libre_office_utils_1 = require("./utils/libre-office.utils");
-Object.defineProperty(exports, "LibreOfficeUtils", { enumerable: true, get: function () { return libre_office_utils_1.LibreOfficeUtils; } });
+exports.LibreOffice = void 0;
+var libre_office_1 = require("./libre-office");
+Object.defineProperty(exports, "LibreOffice", { enumerable: true, get: function () { return libre_office_1.LibreOffice; } });
 //# sourceMappingURL=index.js.map

package/dist/libre-office/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/libre-office/index.ts"],"names":[],"mappings":";;;AACA,iEAA8D;AAArD,sHAAA,gBAAgB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/libre-office/index.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAApC,2GAAA,WAAW,OAAA"}

package/dist/libre-office/interfaces/libre-office.types.d.ts

@@ -1,7 +1,16 @@
+import { Metadata, PdfFormat } from '../../common';
 export type PageProperties = {
     landscape?: boolean;
     nativePageRanges?: {
         from: number;
         to: number;
     };
+    exportFormFields?: boolean;
+};
+export type ConversionOptions = {
+    properties?: PageProperties;
+    merge?: boolean;
+    pdfa?: PdfFormat;
+    pdfUA?: boolean;
+    metadata?: Metadata;
 };

package/dist/libre-office/libre-office.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="node" />
+import { PathLikeOrReadStream, PdfFormat, Metadata } from '../common';
+import { PageProperties } from './interfaces/libre-office.types';
+/**
+ * Class representing a LibreOffice for various operations such as merging and conversion.
+ */
+export declare class LibreOffice {
+    /**
+     * Converts various document formats to PDF.
+     *
+     * @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 {pdfa} [options.pdfFormat] - 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.
+     */
+    static convert({ files, properties, pdfa, pdfUA, merge, metadata }: {
+        files: PathLikeOrReadStream[];
+        properties?: PageProperties;
+        pdfa?: PdfFormat;
+        pdfUA?: boolean;
+        merge?: boolean;
+        metadata?: Metadata;
+    }): Promise<Buffer>;
+}

package/dist/libre-office/libre-office.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LibreOffice = void 0;
+const tslib_1 = require("tslib");
+const form_data_1 = tslib_1.__importDefault(require("form-data"));
+const main_config_1 = require("../main.config");
+const common_1 = require("../common");
+const libre_office_utils_1 = require("./utils/libre-office.utils");
+/**
+ * Class representing a LibreOffice for various operations such as merging and conversion.
+ */
+class LibreOffice {
+    /**
+     * Converts various document formats to PDF.
+     *
+     * @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 {pdfa} [options.pdfFormat] - 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.
+     */
+    static convert(_a) {
+        return tslib_1.__awaiter(this, arguments, void 0, function* ({ files, properties, pdfa, pdfUA, merge, metadata }) {
+            const data = new form_data_1.default();
+            yield libre_office_utils_1.LibreOfficeUtils.addFiles(files, data);
+            yield libre_office_utils_1.LibreOfficeUtils.customize(data, {
+                properties,
+                merge,
+                pdfa,
+                pdfUA,
+                metadata
+            });
+            const endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.LIBRE_OFFICE_PATH}/${main_config_1.Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
+            return common_1.GotenbergUtils.fetch(endpoint, data);
+        });
+    }
+}
+exports.LibreOffice = LibreOffice;
+//# sourceMappingURL=libre-office.js.map

package/dist/libre-office/libre-office.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"libre-office.js","sourceRoot":"","sources":["../../src/libre-office/libre-office.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,gDAA4C;AAC5C,sCAKmB;AAEnB,mEAA8D;AAE9D;;GAEG;AACH,MAAa,WAAW;IACpB;;;;;;;;;;OAUG;IACI,MAAM,CAAO,OAAO;qEAAC,EACxB,KAAK,EACL,UAAU,EACV,IAAI,EACJ,KAAK,EACL,KAAK,EACL,QAAQ,EAQX;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,qCAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC7C,MAAM,qCAAgB,CAAC,SAAS,CAAC,IAAI,EAAE;gBACnC,UAAU;gBACV,KAAK;gBACL,IAAI;gBACJ,KAAK;gBACL,QAAQ;aACX,CAAC,CAAC;YAEH,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;CACJ;AA1CD,kCA0CC"}

package/dist/libre-office/utils/constants.js

@@ -2,86 +2,135 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LIBRE_OFFICE_EXTENSIONS = void 0;
 exports.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',
+    'xlt',
+    'xltm',
     'xltx',
-    'key'
+    'xlw',
+    'xml',
+    'xpm',
+    'zabw'
 ];
 //# sourceMappingURL=constants.js.map

package/dist/libre-office/utils/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/libre-office/utils/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG;IACnC,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;IACN,OAAO;IACP,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;CACR,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/libre-office/utils/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG;IACnC,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,IAAI;IACJ,SAAS;IACT,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,OAAO;IACP,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,OAAO;IACP,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;CACT,CAAC"}

package/dist/libre-office/utils/libre-office.utils.d.ts

@@ -1,6 +1,6 @@
 import FormData from 'form-data';
 import { PathLikeOrReadStream } from '../../common';
-import { PageProperties } from '../interfaces/libre-office.types';
+import { ConversionOptions, PageProperties } from '../interfaces/libre-office.types';
 /**
  * Utility class for handling common tasks related to LibreOffice conversions.
  */
@@ -20,4 +20,12 @@ export declare class LibreOfficeUtils {
      * @param {PageProperties} pageProperties - The page properties to be added to the FormData.
      */
     static addPageProperties(data: FormData, pageProperties: PageProperties): void;
+    /**
+     * Customizes the FormData object based on the provided conversion options.
+     *
+     * @param {FormData} data - The FormData object to be customized.
+     * @param {ConversionOptions} options - The conversion options to apply to the FormData.
+     * @returns {Promise<void>} A Promise that resolves once the customization is complete.
+     */
+    static customize(data: FormData, options: ConversionOptions): Promise<void>;
 }

package/dist/libre-office/utils/libre-office.utils.js

@@ -65,6 +65,35 @@ class LibreOfficeUtils {
                     pageProperties.nativePageRanges.from, 'page ranges syntax error');
             data.append('nativePageRanges', `${pageProperties.nativePageRanges.from}-${pageProperties.nativePageRanges.to}`);
         }
+        if (pageProperties.exportFormFields === false) {
+            data.append('exportFormFields', String(pageProperties.exportFormFields));
+        }
+    }
+    /**
+     * Customizes the FormData object based on the provided conversion options.
+     *
+     * @param {FormData} data - The FormData object to be customized.
+     * @param {ConversionOptions} options - The conversion options to apply to the FormData.
+     * @returns {Promise<void>} A Promise that resolves once the customization is complete.
+     */
+    static customize(data, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (options.pdfa) {
+                data.append('pdfa', options.pdfa);
+            }
+            if (options.pdfUA) {
+                data.append('pdfUA', String(options.pdfUA));
+            }
+            if (options.merge) {
+                data.append('merge', String(options.merge));
+            }
+            if (options.metadata) {
+                data.append('metadata', JSON.stringify(options.metadata));
+            }
+            if (options.properties) {
+                LibreOfficeUtils.addPageProperties(data, options.properties);
+            }
+        });
     }
 }
 exports.LibreOfficeUtils = LibreOfficeUtils;

package/dist/libre-office/utils/libre-office.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"libre-office.utils.js","sourceRoot":"","sources":["../../../src/libre-office/utils/libre-office.utils.ts"],"names":[],"mappings":";;;;AAAA,2BAAuE;AACvE,wDAAwB;AAExB,yCAAmD;AAInD,yCAAoE;AACpE,2CAAsD;AAGtD;;GAEG;AACH,MAAa,gBAAgB;IACzB;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CACxB,KAA6B,EAC7B,IAAc;;YAEd,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;gBACzC,IAAI,IAAI,GAAG,KAAK,CAAC;gBACjB,IAAI,QAAQ,CAAC;gBAEb,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,QAAQ,GAAG,MAAM,IAAA,sBAAU,EAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;qBAAM,IAAI,KAAK,YAAY,eAAU,EAAE,CAAC;oBACrC,QAAQ,GAAG,MAAM,IAAA,sBAAU,EAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACJ,MAAM,aAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;oBAC7C,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACjD,QAAQ,GAAG,EAAE,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;oBACpD,IAAI,GAAG,IAAA,qBAAgB,EAAC,KAAK,CAAC,CAAC;gBACnC,CAAC;gBAED,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;gBACzD,CAAC;gBAED,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC;gBAE/B,IAAI,mCAAuB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC9C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,GAAG,IAAI,SAAS,EAAE,CAAC,CAAC;gBACtD,CAAC;qBAAM,CAAC;oBACJ,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;gBACrD,CAAC;YACL,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAC3B,IAAc,EACd,cAA8B;QAE9B,IAAI,cAAc,CAAC,SAAS,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,cAAc,CAAC,gBAAgB,EAAE,CAAC;YAClC,uBAAc,CAAC,MAAM,CACjB,cAAc,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC;gBACpC,cAAc,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC;gBACtC,cAAc,CAAC,gBAAgB,CAAC,EAAE;oBAC9B,cAAc,CAAC,gBAAgB,CAAC,IAAI,EAC5C,0BAA0B,CAC7B,CAAC;YAEF,IAAI,CAAC,MAAM,CACP,kBAAkB,EAClB,GAAG,cAAc,CAAC,gBAAgB,CAAC,IAAI,IAAI,cAAc,CAAC,gBAAgB,CAAC,EAAE,EAAE,CAClF,CAAC;QACN,CAAC;IACL,CAAC;CACJ;AAtED,4CAsEC"}
+{"version":3,"file":"libre-office.utils.js","sourceRoot":"","sources":["../../../src/libre-office/utils/libre-office.utils.ts"],"names":[],"mappings":";;;;AAAA,2BAAuE;AACvE,wDAAwB;AAExB,yCAAmD;AAInD,yCAAoE;AACpE,2CAAsD;AAMtD;;GAEG;AACH,MAAa,gBAAgB;IACzB;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CACxB,KAA6B,EAC7B,IAAc;;YAEd,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;gBACzC,IAAI,IAAI,GAAG,KAAK,CAAC;gBACjB,IAAI,QAAQ,CAAC;gBAEb,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,QAAQ,GAAG,MAAM,IAAA,sBAAU,EAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;qBAAM,IAAI,KAAK,YAAY,eAAU,EAAE,CAAC;oBACrC,QAAQ,GAAG,MAAM,IAAA,sBAAU,EAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACJ,MAAM,aAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;oBAC7C,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACjD,QAAQ,GAAG,EAAE,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;oBACpD,IAAI,GAAG,IAAA,qBAAgB,EAAC,KAAK,CAAC,CAAC;gBACnC,CAAC;gBAED,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACZ,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;gBACzD,CAAC;gBAED,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC;gBAE/B,IAAI,mCAAuB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC9C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,GAAG,IAAI,SAAS,EAAE,CAAC,CAAC;gBACtD,CAAC;qBAAM,CAAC;oBACJ,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;gBACrD,CAAC;YACL,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAC3B,IAAc,EACd,cAA8B;QAE9B,IAAI,cAAc,CAAC,SAAS,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,cAAc,CAAC,gBAAgB,EAAE,CAAC;YAClC,uBAAc,CAAC,MAAM,CACjB,cAAc,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC;gBACpC,cAAc,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC;gBACtC,cAAc,CAAC,gBAAgB,CAAC,EAAE;oBAC9B,cAAc,CAAC,gBAAgB,CAAC,IAAI,EAC5C,0BAA0B,CAC7B,CAAC;YAEF,IAAI,CAAC,MAAM,CACP,kBAAkB,EAClB,GAAG,cAAc,CAAC,gBAAgB,CAAC,IAAI,IAAI,cAAc,CAAC,gBAAgB,CAAC,EAAE,EAAE,CAClF,CAAC;QACN,CAAC;QAED,IAAI,cAAc,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;YAC5C,IAAI,CAAC,MAAM,CACP,kBAAkB,EAClB,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAC1C,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAO,SAAS,CACzB,IAAc,EACd,OAA0B;;YAE1B,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;gBACf,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;YAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAChB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9D,CAAC;YAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACrB,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACjE,CAAC;QACL,CAAC;KAAA;CACJ;AA7GD,4CA6GC"}

package/dist/main.d.ts

@@ -1,3 +1,4 @@
 export { PdfFormat } from './common/constants';
 export { HtmlConverter, HtmlScreenshot, MarkdownConverter, MarkdownScreenshot, UrlConverter, UrlScreenshot } from './chromium';
-export { PDFEngine } from './pdf-engines';
+export { PDFEngines } from './pdf-engines';
+export { LibreOffice } from './libre-office';

package/dist/main.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PDFEngine = exports.UrlScreenshot = exports.UrlConverter = exports.MarkdownScreenshot = exports.MarkdownConverter = exports.HtmlScreenshot = exports.HtmlConverter = exports.PdfFormat = void 0;
+exports.LibreOffice = exports.PDFEngines = exports.UrlScreenshot = exports.UrlConverter = exports.MarkdownScreenshot = exports.MarkdownConverter = exports.HtmlScreenshot = exports.HtmlConverter = exports.PdfFormat = void 0;
 var constants_1 = require("./common/constants");
 Object.defineProperty(exports, "PdfFormat", { enumerable: true, get: function () { return constants_1.PdfFormat; } });
 var chromium_1 = require("./chromium");
@@ -11,5 +11,7 @@ Object.defineProperty(exports, "MarkdownScreenshot", { enumerable: true, get: fu
 Object.defineProperty(exports, "UrlConverter", { enumerable: true, get: function () { return chromium_1.UrlConverter; } });
 Object.defineProperty(exports, "UrlScreenshot", { enumerable: true, get: function () { return chromium_1.UrlScreenshot; } });
 var pdf_engines_1 = require("./pdf-engines");
-Object.defineProperty(exports, "PDFEngine", { enumerable: true, get: function () { return pdf_engines_1.PDFEngine; } });
+Object.defineProperty(exports, "PDFEngines", { enumerable: true, get: function () { return pdf_engines_1.PDFEngines; } });
+var libre_office_1 = require("./libre-office");
+Object.defineProperty(exports, "LibreOffice", { enumerable: true, get: function () { return libre_office_1.LibreOffice; } });
 //# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,uCAOoB;AANhB,yGAAA,aAAa,OAAA;AACb,0GAAA,cAAc,OAAA;AACd,6GAAA,iBAAiB,OAAA;AACjB,8GAAA,kBAAkB,OAAA;AAClB,wGAAA,YAAY,OAAA;AACZ,yGAAA,aAAa,OAAA;AAEjB,6CAA0C;AAAjC,wGAAA,SAAS,OAAA"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,uCAOoB;AANhB,yGAAA,aAAa,OAAA;AACb,0GAAA,cAAc,OAAA;AACd,6GAAA,iBAAiB,OAAA;AACjB,8GAAA,kBAAkB,OAAA;AAClB,wGAAA,YAAY,OAAA;AACZ,yGAAA,aAAa,OAAA;AAEjB,6CAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,+CAA6C;AAApC,2GAAA,WAAW,OAAA"}

package/dist/pdf-engines/index.d.ts

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

package/dist/pdf-engines/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PDFEngine = void 0;
-var pdf_engine_1 = require("./pdf.engine");
-Object.defineProperty(exports, "PDFEngine", { enumerable: true, get: function () { return pdf_engine_1.PDFEngine; } });
+exports.PDFEngines = void 0;
+var pdf_engines_1 = require("./pdf-engines");
+Object.defineProperty(exports, "PDFEngines", { enumerable: true, get: function () { return pdf_engines_1.PDFEngines; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pdf-engines/index.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAAhC,uGAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pdf-engines/index.ts"],"names":[],"mappings":";;;AAAA,6CAA2C;AAAlC,yGAAA,UAAU,OAAA"}

package/dist/pdf-engines/interfaces/pdf-engines.types.d.ts

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

package/dist/pdf-engines/interfaces/pdf-engines.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pdf-engines.types.js.map

package/dist/pdf-engines/interfaces/pdf-engines.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdf-engines.types.js","sourceRoot":"","sources":["../../../src/pdf-engines/interfaces/pdf-engines.types.ts"],"names":[],"mappings":""}

package/dist/pdf-engines/{pdf.engine.d.ts → pdf-engines.d.ts}

@@ -1,10 +1,9 @@
 /// <reference types="node" />
 import { PathLikeOrReadStream, PdfFormat, Metadata } from '../common';
-import { PageProperties } from '../libre-office';
 /**
- * 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 declare class PDFEngine {
+export declare class PDFEngines {
     /**
      * Merges multiple PDF files into a single PDF document.
      *
@@ -12,30 +11,25 @@ export declare class PDFEngine {
      * @param {PathLikeOrReadStream[]} options.files - An array of PathLikes or ReadStreams to the PDF files to be merged.
      * @returns {Promise<Buffer>} A Promise resolving to the merged PDF content as a Buffer.
      */
-    static merge({ files }: {
+    static merge({ files, pdfa, pdfUA, metadata }: {
         files: PathLikeOrReadStream[];
+        pdfa?: PdfFormat;
+        pdfUA?: boolean;
+        metadata?: Metadata;
     }): Promise<Buffer>;
     /**
      * Converts various document formats to PDF.
      *
      * @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.
      */
-    static convert({ files, properties, pdfFormat, pdfUA, merge }: {
+    static convert({ files, 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>;
     /**
      * Reads metadata from the provided files.