chromiumly 1.0.2 → 2.0.0

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

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LIBRE_OFFICE_EXTENSIONS = void 0;
+exports.LIBRE_OFFICE_EXTENSIONS = [
+    ".bib",
+    ".doc",
+    ".xml",
+    ".docx",
+    ".fodt",
+    ".html",
+    ".ltx",
+    ".txt",
+    ".odt",
+    ".ott",
+    ".pdb",
+    ".pdf",
+    ".psw",
+    ".rtf",
+    ".sdw",
+    ".stw",
+    ".sxw",
+    ".uot",
+    ".vor",
+    ".wps",
+    ".epub",
+    ".png",
+    ".bmp",
+    ".emf",
+    ".eps",
+    ".fodg",
+    ".gif",
+    ".jpg",
+    ".met",
+    ".odd",
+    ".otg",
+    ".pbm",
+    ".pct",
+    ".pgm",
+    ".ppm",
+    ".ras",
+    ".std",
+    ".svg",
+    ".svm",
+    ".swf",
+    ".sxd",
+    ".sxw",
+    ".tiff",
+    ".xhtml",
+    ".xpm",
+    ".fodp",
+    ".potm",
+    ".pot",
+    ".pptx",
+    ".pps",
+    ".ppt",
+    ".pwp",
+    ".sda",
+    ".sdd",
+    ".sti",
+    ".sxi",
+    ".uop",
+    ".wmf",
+    ".csv",
+    ".dbf",
+    ".dif",
+    ".fods",
+    ".ods",
+    ".ots",
+    ".pxl",
+    ".sdc",
+    ".slk",
+    ".stc",
+    ".sxc",
+    ".uos",
+    ".xls",
+    ".xlt",
+    ".xlsx",
+    ".tif",
+    ".jpeg",
+    ".odp",
+];
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/libre-office/utils/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG;IACrC,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;CACP,CAAC"}

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

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { PathLike } from "fs";
+import FormData from "form-data";
+import { PageProperties } from "../interfaces/libre-office.types";
+export declare class LibreOfficeUtils {
+    static injectFiles(files: PathLike[], data: FormData): Promise<void>;
+    static injectPageProperties(data: FormData, pageProperties: PageProperties): void;
+}

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LibreOfficeUtils = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const path_1 = tslib_1.__importDefault(require("path"));
+const common_1 = require("../../common");
+const constants_1 = require("./constants");
+class LibreOfficeUtils {
+    static injectFiles(files, data) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            for (const file of files) {
+                try {
+                    yield fs_1.promises.access(file, fs_1.constants.R_OK);
+                    const filename = path_1.default.basename(file.toString());
+                    const extension = path_1.default.extname(filename);
+                    if (constants_1.LIBRE_OFFICE_EXTENSIONS.includes(extension)) {
+                        data.append(filename, (0, fs_1.createReadStream)(file));
+                    }
+                    else {
+                        throw new Error(`${extension} is not supported`);
+                    }
+                }
+                catch (error) {
+                    throw error;
+                }
+            }
+        });
+    }
+    static injectPageProperties(data, pageProperties) {
+        if (pageProperties.landscape) {
+            data.append("landscape", String(pageProperties.landscape));
+        }
+        if (pageProperties.nativePageRanges) {
+            common_1.GotenbergUtils.assert(pageProperties.nativePageRanges.from > 0 &&
+                pageProperties.nativePageRanges.to > 0 &&
+                pageProperties.nativePageRanges.to >=
+                    pageProperties.nativePageRanges.from, "page ranges syntax error");
+            data.append("nativePageRanges", `${pageProperties.nativePageRanges.from}-${pageProperties.nativePageRanges.to}`);
+        }
+    }
+}
+exports.LibreOfficeUtils = LibreOfficeUtils;
+//# sourceMappingURL=libre-office.utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"libre-office.utils.js","sourceRoot":"","sources":["../../../src/libre-office/utils/libre-office.utils.ts"],"names":[],"mappings":";;;;AAAA,2BAAqE;AACrE,wDAAwB;AAIxB,yCAA8C;AAC9C,2CAAsD;AAGtD,MAAa,gBAAgB;IACpB,MAAM,CAAO,WAAW,CAAC,KAAiB,EAAE,IAAc;;YAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,IAAI;oBACF,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,mCAAuB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;wBAC/C,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAA,qBAAgB,EAAC,IAAI,CAAC,CAAC,CAAC;qBAC/C;yBAAM;wBACL,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;qBAClD;iBACF;gBAAC,OAAO,KAAK,EAAE;oBACd,MAAM,KAAK,CAAC;iBACb;aACF;QACH,CAAC;KAAA;IAEM,MAAM,CAAC,oBAAoB,CAChC,IAAc,EACd,cAA8B;QAE9B,IAAI,cAAc,CAAC,SAAS,EAAE;YAC5B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;SAC5D;QAED,IAAI,cAAc,CAAC,gBAAgB,EAAE;YACnC,uBAAc,CAAC,MAAM,CACnB,cAAc,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC;gBACtC,cAAc,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC;gBACtC,cAAc,CAAC,gBAAgB,CAAC,EAAE;oBAChC,cAAc,CAAC,gBAAgB,CAAC,IAAI,EACxC,0BAA0B,CAC3B,CAAC;YAEF,IAAI,CAAC,MAAM,CACT,kBAAkB,EAClB,GAAG,cAAc,CAAC,gBAAgB,CAAC,IAAI,IAAI,cAAc,CAAC,gBAAgB,CAAC,EAAE,EAAE,CAChF,CAAC;SACH;IACH,CAAC;CACF;AAzCD,4CAyCC"}

package/dist/main.config.d.ts

@@ -0,0 +1,29 @@
+export declare enum ChromiumRoute {
+    URL = "url",
+    HTML = "html",
+    MARKDOWN = "markdown"
+}
+declare enum PdfEngineRoute {
+    MERGE = "merge"
+}
+declare enum LibreOfficeRoute {
+    CONVERT = "convert"
+}
+export declare class Chromiumly {
+    static readonly GOTENBERG_ENDPOINT: string;
+    static readonly CHROMIUM_PATH = "forms/chromium/convert";
+    static readonly PDF_ENGINES_PATH = "forms/pdfengines";
+    static readonly LIBRE_OFFICE_PATH = "forms/libreoffice";
+    static readonly CHROMIUM_ROUTES: {
+        url: ChromiumRoute;
+        html: ChromiumRoute;
+        markdown: ChromiumRoute;
+    };
+    static readonly PDF_ENGINE_ROUTES: {
+        merge: PdfEngineRoute;
+    };
+    static readonly LIBRE_OFFICE_ROUTES: {
+        convert: LibreOfficeRoute;
+    };
+}
+export {};

package/dist/main.config.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chromiumly = exports.ChromiumRoute = void 0;
+const gotenberg_1 = require("./gotenberg");
+var ChromiumRoute;
+(function (ChromiumRoute) {
+    ChromiumRoute["URL"] = "url";
+    ChromiumRoute["HTML"] = "html";
+    ChromiumRoute["MARKDOWN"] = "markdown";
+})(ChromiumRoute = exports.ChromiumRoute || (exports.ChromiumRoute = {}));
+var PdfEngineRoute;
+(function (PdfEngineRoute) {
+    PdfEngineRoute["MERGE"] = "merge";
+})(PdfEngineRoute || (PdfEngineRoute = {}));
+var LibreOfficeRoute;
+(function (LibreOfficeRoute) {
+    LibreOfficeRoute["CONVERT"] = "convert";
+})(LibreOfficeRoute || (LibreOfficeRoute = {}));
+class Chromiumly {
+}
+exports.Chromiumly = Chromiumly;
+Chromiumly.GOTENBERG_ENDPOINT = gotenberg_1.Gotenberg.endpoint;
+Chromiumly.CHROMIUM_PATH = "forms/chromium/convert";
+Chromiumly.PDF_ENGINES_PATH = "forms/pdfengines";
+Chromiumly.LIBRE_OFFICE_PATH = "forms/libreoffice";
+Chromiumly.CHROMIUM_ROUTES = {
+    url: ChromiumRoute.URL,
+    html: ChromiumRoute.HTML,
+    markdown: ChromiumRoute.MARKDOWN,
+};
+Chromiumly.PDF_ENGINE_ROUTES = {
+    merge: PdfEngineRoute.MERGE,
+};
+Chromiumly.LIBRE_OFFICE_ROUTES = {
+    convert: LibreOfficeRoute.CONVERT,
+};
+//# sourceMappingURL=main.config.js.map

package/dist/main.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.config.js","sourceRoot":"","sources":["../src/main.config.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAExC,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,sCAAqB,CAAA;AACvB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAK,cAEJ;AAFD,WAAK,cAAc;IACjB,iCAAe,CAAA;AACjB,CAAC,EAFI,cAAc,KAAd,cAAc,QAElB;AAED,IAAK,gBAEJ;AAFD,WAAK,gBAAgB;IACnB,uCAAmB,CAAA;AACrB,CAAC,EAFI,gBAAgB,KAAhB,gBAAgB,QAEpB;AACD,MAAa,UAAU;;AAAvB,gCAoBC;AAnBwB,6BAAkB,GAAG,qBAAS,CAAC,QAAQ,CAAC;AAExC,wBAAa,GAAG,wBAAwB,CAAC;AACzC,2BAAgB,GAAG,kBAAkB,CAAC;AACtC,4BAAiB,GAAG,mBAAmB,CAAC;AAExC,0BAAe,GAAG;IACvC,GAAG,EAAE,aAAa,CAAC,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC,IAAI;IACxB,QAAQ,EAAE,aAAa,CAAC,QAAQ;CACjC,CAAC;AAEqB,4BAAiB,GAAG;IACzC,KAAK,EAAE,cAAc,CAAC,KAAK;CAC5B,CAAC;AAEqB,8BAAmB,GAAG;IAC3C,OAAO,EAAE,gBAAgB,CAAC,OAAO;CAClC,CAAC"}

package/dist/main.d.ts

@@ -0,0 +1,3 @@
+export { PdfFormat } from "./common/constants";
+export { HtmlConverter, MarkdownConverter, UrlConverter } from "./chromium";
+export { PDFEngine } from "./pdf-engines";

package/dist/main.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UrlConverter = exports.MarkdownConverter = exports.HtmlConverter = void 0;
-var html_converter_1 = require("./converters/html.converter");
-Object.defineProperty(exports, "HtmlConverter", { enumerable: true, get: function () { return html_converter_1.HtmlConverter; } });
-var markdown_converter_1 = require("./converters/markdown.converter");
-Object.defineProperty(exports, "MarkdownConverter", { enumerable: true, get: function () { return markdown_converter_1.MarkdownConverter; } });
-var url_converter_1 = require("./converters/url.converter");
-Object.defineProperty(exports, "UrlConverter", { enumerable: true, get: function () { return url_converter_1.UrlConverter; } });
+exports.PDFEngine = exports.UrlConverter = exports.MarkdownConverter = 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");
+Object.defineProperty(exports, "HtmlConverter", { enumerable: true, get: function () { return chromium_1.HtmlConverter; } });
+Object.defineProperty(exports, "MarkdownConverter", { enumerable: true, get: function () { return chromium_1.MarkdownConverter; } });
+Object.defineProperty(exports, "UrlConverter", { enumerable: true, get: function () { return chromium_1.UrlConverter; } });
+var pdf_engines_1 = require("./pdf-engines");
+Object.defineProperty(exports, "PDFEngine", { enumerable: true, get: function () { return pdf_engines_1.PDFEngine; } });
 //# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,uCAA4E;AAAnE,yGAAA,aAAa,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AAAE,wGAAA,YAAY,OAAA;AACvD,6CAA0C;AAAjC,wGAAA,SAAS,OAAA"}

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

@@ -0,0 +1 @@
+export { PDFEngine } from "./pdf.engine";

package/dist/pdf-engines/index.js

@@ -0,0 +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; } });
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import { PathLike } from "fs";
+import { PdfFormat } from "../common";
+import { PageProperties } from "../libre-office";
+export declare class PDFEngine {
+    static merge({ files }: {
+        files: PathLike[];
+    }): Promise<Buffer>;
+    static convert({ files, properties, pdfFormat, merge, }: {
+        files: PathLike[];
+        properties?: PageProperties;
+        pdfFormat?: PdfFormat;
+        merge?: boolean;
+    }): Promise<Buffer>;
+    static generate(filename: string, buffer: Buffer): Promise<void>;
+}

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

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PDFEngine = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const path_1 = tslib_1.__importDefault(require("path"));
+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_1 = require("../libre-office");
+const engine_utils_1 = require("./utils/engine.utils");
+class PDFEngine {
+    static merge({ files }) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const data = new form_data_1.default();
+            yield engine_utils_1.PDFEngineUtils.injectFiles(files, data);
+            const endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.PDF_ENGINES_PATH}/${main_config_1.Chromiumly.PDF_ENGINE_ROUTES.merge}`;
+            return common_1.GotenbergUtils.fetch(endpoint, data);
+        });
+    }
+    static convert({ files, properties, pdfFormat, merge, }) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const data = new form_data_1.default();
+            if (pdfFormat) {
+                data.append("pdfFormat", pdfFormat);
+            }
+            if (merge) {
+                data.append("merge", String(merge));
+            }
+            if (properties) {
+                libre_office_1.LibreOfficeUtils.injectPageProperties(data, properties);
+            }
+            yield libre_office_1.LibreOfficeUtils.injectFiles(files, data);
+            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);
+        });
+    }
+    static generate(filename, buffer) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const __generated__ = path_1.default.resolve(process.cwd(), "__generated__");
+            yield fs_1.promises.mkdir(path_1.default.resolve(__generated__), { recursive: true });
+            yield fs_1.promises.writeFile(path_1.default.resolve(__generated__, filename), buffer);
+        });
+    }
+}
+exports.PDFEngine = PDFEngine;
+//# sourceMappingURL=pdf.engine.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pdf.engine.js","sourceRoot":"","sources":["../../src/pdf-engines/pdf.engine.ts"],"names":[],"mappings":";;;;AAAA,2BAAwC;AACxC,wDAAwB;AAExB,kEAAiC;AAEjC,gDAA4C;AAC5C,sCAAsD;AACtD,kDAAmE;AACnE,uDAAsD;AAEtD,MAAa,SAAS;IACb,MAAM,CAAO,KAAK,CAAC,EAAE,KAAK,EAAyB;;YACxD,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,MAAM,6BAAc,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC9C,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;QAC9C,CAAC;KAAA;IAEM,MAAM,CAAO,OAAO,CAAC,EAC1B,KAAK,EACL,UAAU,EACV,SAAS,EACT,KAAK,GAMN;;YACC,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,IAAI,SAAS,EAAE;gBACb,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;aACrC;YACD,IAAI,KAAK,EAAE;gBACT,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;aACrC;YACD,IAAI,UAAU,EAAE;gBACd,+BAAgB,CAAC,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;aACzD;YACD,MAAM,+BAAgB,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,iBAAiB,IAAI,wBAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAC9H,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;KAAA;IAEM,MAAM,CAAO,QAAQ,CAC1B,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;QAC1E,CAAC;KAAA;CACF;AA1CD,8BA0CC"}

package/dist/pdf-engines/utils/engine.utils.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import { PathLike } from "fs";
+import FormData from "form-data";
+export declare class PDFEngineUtils {
+    static injectFiles(files: PathLike[], data: FormData): Promise<void>;
+}

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PDFEngineUtils = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const path_1 = tslib_1.__importDefault(require("path"));
+class PDFEngineUtils {
+    static injectFiles(files, data) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            for (const file of files) {
+                try {
+                    yield fs_1.promises.access(file, fs_1.constants.R_OK);
+                    const filename = path_1.default.basename(file.toString());
+                    data.append(filename, (0, fs_1.createReadStream)(file));
+                }
+                catch (error) {
+                    throw error;
+                }
+            }
+        });
+    }
+}
+exports.PDFEngineUtils = PDFEngineUtils;
+//# sourceMappingURL=engine.utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"engine.utils.js","sourceRoot":"","sources":["../../../src/pdf-engines/utils/engine.utils.ts"],"names":[],"mappings":";;;;AAAA,2BAAqE;AACrE,wDAAwB;AAIxB,MAAa,cAAc;IAClB,MAAM,CAAO,WAAW,CAAC,KAAiB,EAAE,IAAc;;YAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,IAAI;oBACF,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,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAA,qBAAgB,EAAC,IAAI,CAAC,CAAC,CAAC;iBAC/C;gBAAC,OAAO,KAAK,EAAE;oBACd,MAAM,KAAK,CAAC;iBACb;aACF;QACH,CAAC;KAAA;CACF;AAZD,wCAYC"}

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "chromiumly",
-  "version": "1.0.2",
-  "description": "A lightweight Typescrpit library which interacts with Gotenberg's Chromium module to convert HTML documents to PDF.",
+  "version": "2.0.0",
+  "description": "A lightweight Typescrpit library which interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/cherfia/chromiumly.git"

package/src/chromium/converters/converter.ts

@@ -0,0 +1,9 @@
+import { Chromiumly, ChromiumRoute } from "../../main.config";
+
+export abstract class Converter {
+  readonly endpoint: string;
+
+  constructor(route: ChromiumRoute) {
+    this.endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.CHROMIUM_PATH}/${Chromiumly.CHROMIUM_ROUTES[route]}`;
+  }
+}

package/src/chromium/converters/html.converter.ts

@@ -0,0 +1,41 @@
+import { constants, createReadStream, PathLike, promises } from "fs";
+
+import FormData from "form-data";
+
+import { GotenbergUtils, PdfFormat } from "../../common";
+import { IConverter } from "../interfaces/converter.interface";
+import { PageProperties } from "../interfaces/converter.types";
+import { ConverterUtils } from "../utils/converter.utils";
+import { Converter } from "./converter";
+import { ChromiumRoute } from "../../main.config";
+
+export class HtmlConverter extends Converter implements IConverter {
+  constructor() {
+    super(ChromiumRoute.HTML);
+  }
+
+  async convert({
+    html,
+    properties,
+    pdfFormat,
+  }: {
+    html: PathLike;
+    properties?: PageProperties;
+    pdfFormat?: PdfFormat;
+  }): Promise<Buffer> {
+    try {
+      await promises.access(html, constants.R_OK);
+      const data = new FormData();
+      if (pdfFormat) {
+        data.append("pdfFormat", pdfFormat);
+      }
+      data.append("index.html", createReadStream(html));
+      if (properties) {
+        ConverterUtils.injectPageProperties(data, properties);
+      }
+      return GotenbergUtils.fetch(this.endpoint, data);
+    } catch (error) {
+      throw error;
+    }
+  }
+}

package/src/chromium/converters/markdown.converter.ts

@@ -0,0 +1,45 @@
+import { constants, createReadStream, PathLike, promises } from "fs";
+
+import FormData from "form-data";
+
+import { GotenbergUtils, PdfFormat } from "../../common";
+import { IConverter } from "../interfaces/converter.interface";
+import { PageProperties } from "../interfaces/converter.types";
+import { ConverterUtils } from "../utils/converter.utils";
+import { Converter } from "./converter";
+import { ChromiumRoute } from "../../main.config";
+
+export class MarkdownConverter extends Converter implements IConverter {
+  constructor() {
+    super(ChromiumRoute.MARKDOWN);
+  }
+
+  async convert({
+    html,
+    markdown,
+    properties,
+    pdfFormat,
+  }: {
+    html: PathLike;
+    markdown: PathLike;
+    properties?: PageProperties;
+    pdfFormat?: PdfFormat;
+  }): Promise<Buffer> {
+    try {
+      await promises.access(html, constants.R_OK);
+      await promises.access(markdown, constants.R_OK);
+      const data = new FormData();
+      if (pdfFormat) {
+        data.append("pdfFormat", pdfFormat);
+      }
+      data.append("index.html", createReadStream(html));
+      data.append("file.md", createReadStream(markdown));
+      if (properties) {
+        ConverterUtils.injectPageProperties(data, properties);
+      }
+      return GotenbergUtils.fetch(this.endpoint, data);
+    } catch (error) {
+      throw error;
+    }
+  }
+}

package/src/{converters → chromium/converters}/url.converter.ts

@@ -2,32 +2,38 @@ import { URL } from "url";
 
 import FormData from "form-data";
 
-import { IConverter } from "../common/converter.interface";
-import { PageProperties } from "../common/converter.types";
-import { ConverterUtils } from "../common/converter.utils";
-import { Converter } from "../common/converter";
-import { Route } from "../main.config";
+import { GotenbergUtils, PdfFormat } from "../../common";
+import { IConverter } from "../interfaces/converter.interface";
+import { PageProperties } from "../interfaces/converter.types";
+import { ConverterUtils } from "../utils/converter.utils";
+import { Converter } from "./converter";
+import { ChromiumRoute } from "../../main.config";
 
 export class UrlConverter extends Converter implements IConverter {
   constructor() {
-    super(Route.URL);
+    super(ChromiumRoute.URL);
   }
 
   async convert({
     url,
     properties,
+    pdfFormat,
   }: {
     url: string;
     properties?: PageProperties;
+    pdfFormat?: PdfFormat;
   }): Promise<Buffer> {
     try {
       const _url = new URL(url);
       const data = new FormData();
+      if (pdfFormat) {
+        data.append("pdfFormat", pdfFormat);
+      }
       data.append("url", _url.href);
       if (properties) {
         ConverterUtils.injectPageProperties(data, properties);
       }
-      return ConverterUtils.fetch(this.endpoint, data);
+      return GotenbergUtils.fetch(this.endpoint, data);
     } catch (error) {
       throw error;
     }

package/src/chromium/index.ts

@@ -0,0 +1,3 @@
+export { HtmlConverter } from "./converters/html.converter";
+export { MarkdownConverter } from "./converters/markdown.converter";
+export { UrlConverter } from "./converters/url.converter";

package/src/{common → chromium/interfaces}/converter.interface.ts

@@ -1,11 +1,12 @@
 import { PathLike } from "fs";
 
+import { PdfFormat } from "../../common";
 import { PageProperties } from "./converter.types";
 
 export interface IConverter {
   convert({
     ...args
   }: {
-    [x: string]: string | PathLike | PageProperties;
+    [x: string]: string | PathLike | PageProperties | PdfFormat;
   }): Promise<Buffer>;
 }

package/src/chromium/utils/converter.utils.ts

@@ -0,0 +1,75 @@
+import FormData from "form-data";
+
+import { GotenbergUtils } from "../../common/gotenberg.utils";
+import { PageProperties } from "../interfaces/converter.types";
+
+export class ConverterUtils {
+  public static injectPageProperties(
+    data: FormData,
+    pageProperties: PageProperties
+  ): void {
+    if (pageProperties.size) {
+      GotenbergUtils.assert(
+        pageProperties.size.width >= 1.0 && pageProperties.size.height >= 1.5,
+        "size is smaller than the minimum printing requirements (i.e. 1.0 x 1.5 in)"
+      );
+
+      data.append("paperWidth", pageProperties.size.width);
+      data.append("paperHeight", pageProperties.size.height);
+    }
+
+    if (pageProperties.margins) {
+      GotenbergUtils.assert(
+        pageProperties.margins.top >= 0 &&
+          pageProperties.margins.bottom >= 0 &&
+          pageProperties.margins.left >= 0 &&
+          pageProperties.margins.left >= 0,
+        "negative margins are not allowed"
+      );
+
+      data.append("marginTop", pageProperties.margins.top);
+      data.append("marginBottom", pageProperties.margins.bottom);
+      data.append("marginLeft", pageProperties.margins.left);
+      data.append("marginRight", pageProperties.margins.right);
+    }
+
+    if (pageProperties.preferCssPageSize) {
+      data.append(
+        "preferCssPageSize",
+        String(pageProperties.preferCssPageSize)
+      );
+    }
+
+    if (pageProperties.printBackground) {
+      data.append("printBackground", String(pageProperties.printBackground));
+    }
+
+    if (pageProperties.landscape) {
+      data.append("landscape", String(pageProperties.landscape));
+    }
+
+    if (pageProperties.scale) {
+      GotenbergUtils.assert(
+        pageProperties.scale >= 0.1 && pageProperties.scale <= 2.0,
+        "scale is outside of [0.1 - 2] range"
+      );
+
+      data.append("scale", pageProperties.scale);
+    }
+
+    if (pageProperties.nativePageRanges) {
+      GotenbergUtils.assert(
+        pageProperties.nativePageRanges.from > 0 &&
+          pageProperties.nativePageRanges.to > 0 &&
+          pageProperties.nativePageRanges.to >=
+            pageProperties.nativePageRanges.from,
+        "page ranges syntax error"
+      );
+
+      data.append(
+        "nativePageRanges",
+        `${pageProperties.nativePageRanges.from}-${pageProperties.nativePageRanges.to}`
+      );
+    }
+  }
+}

package/src/common/constants.ts

@@ -0,0 +1,5 @@
+export enum PdfFormat {
+  A_1a = "PDF/A-1a",
+  A_2b = "PDF/A-2b",
+  A_3b = "PDF/A-3b",
+}