chromiumly 1.0.2 → 2.0.0

package/src/common/gotenberg.utils.ts

@@ -0,0 +1,25 @@
+import FormData from "form-data";
+import fetch from "node-fetch";
+
+export class GotenbergUtils {
+  public static assert(condition: boolean, message: string): asserts condition {
+    if (!condition) {
+      throw new Error(message);
+    }
+  }
+
+  public static async fetch(endpoint: string, data: FormData): Promise<Buffer> {
+    const response = await fetch(endpoint, {
+      method: "post",
+      body: data,
+      headers: {
+        ...data.getHeaders(),
+      },
+    });
+
+    if (!response.ok) {
+      throw new Error(`${response.status} ${response.statusText}`);
+    }
+    return response.buffer();
+  }
+}

package/src/common/index.ts

@@ -0,0 +1,2 @@
+export { PdfFormat } from "./constants";
+export { GotenbergUtils } from "./gotenberg.utils";

package/src/libre-office/index.ts

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

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

@@ -0,0 +1,4 @@
+export type PageProperties = {
+  landscape?: boolean; // Set the paper orientation to landscape (default false)
+  nativePageRanges?: { from: number; to: number }; // Page ranges to print
+};

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

@@ -0,0 +1,78 @@
+export const 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",
+];

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

@@ -0,0 +1,51 @@
+import { constants, createReadStream, PathLike, promises } from "fs";
+import path from "path";
+
+import FormData from "form-data";
+
+import { GotenbergUtils } from "../../common";
+import { LIBRE_OFFICE_EXTENSIONS } from "./constants";
+import { PageProperties } from "../interfaces/libre-office.types";
+
+export class LibreOfficeUtils {
+  public static async injectFiles(files: PathLike[], data: FormData) {
+    for (const file of files) {
+      try {
+        await promises.access(file, constants.R_OK);
+        const filename = path.basename(file.toString());
+        const extension = path.extname(filename);
+        if (LIBRE_OFFICE_EXTENSIONS.includes(extension)) {
+          data.append(filename, createReadStream(file));
+        } else {
+          throw new Error(`${extension} is not supported`);
+        }
+      } catch (error) {
+        throw error;
+      }
+    }
+  }
+
+  public static injectPageProperties(
+    data: FormData,
+    pageProperties: PageProperties
+  ): void {
+    if (pageProperties.landscape) {
+      data.append("landscape", String(pageProperties.landscape));
+    }
+
+    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/main.config.ts

@@ -1,23 +1,36 @@
 import { Gotenberg } from "./gotenberg";
 
-export enum Route {
+export enum ChromiumRoute {
   URL = "url",
   HTML = "html",
   MARKDOWN = "markdown",
 }
 
+enum PdfEngineRoute {
+  MERGE = "merge",
+}
+
+enum LibreOfficeRoute {
+  CONVERT = "convert",
+}
 export class Chromiumly {
-  private static readonly GOTENBERG_ENDPOINT = Gotenberg.endpoint;
+  public static readonly GOTENBERG_ENDPOINT = Gotenberg.endpoint;
 
-  private static readonly PATH = "forms/chromium/convert";
+  public static readonly CHROMIUM_PATH = "forms/chromium/convert";
+  public static readonly PDF_ENGINES_PATH = "forms/pdfengines";
+  public static readonly LIBRE_OFFICE_PATH = "forms/libreoffice";
 
-  private static readonly ROUTES = {
-    url: Route.URL,
-    html: Route.HTML,
-    markdown: Route.MARKDOWN,
+  public static readonly CHROMIUM_ROUTES = {
+    url: ChromiumRoute.URL,
+    html: ChromiumRoute.HTML,
+    markdown: ChromiumRoute.MARKDOWN,
   };
 
-  public static readonly endpoint = Chromiumly.GOTENBERG_ENDPOINT;
-  public static readonly path = Chromiumly.PATH;
-  public static readonly routes = Chromiumly.ROUTES;
+  public static readonly PDF_ENGINE_ROUTES = {
+    merge: PdfEngineRoute.MERGE,
+  };
+
+  public static readonly LIBRE_OFFICE_ROUTES = {
+    convert: LibreOfficeRoute.CONVERT,
+  };
 }

package/src/main.ts

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

package/src/pdf-engines/index.ts

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

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

@@ -0,0 +1,53 @@
+import { PathLike, promises } from "fs";
+import path from "path";
+
+import FormData from "form-data";
+
+import { Chromiumly } from "../main.config";
+import { GotenbergUtils, PdfFormat } from "../common";
+import { LibreOfficeUtils, PageProperties } from "../libre-office";
+import { PDFEngineUtils } from "./utils/engine.utils";
+
+export class PDFEngine {
+  public static async merge({ files }: { files: PathLike[] }): Promise<Buffer> {
+    const data = new FormData();
+    await PDFEngineUtils.injectFiles(files, data);
+    const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.PDF_ENGINES_PATH}/${Chromiumly.PDF_ENGINE_ROUTES.merge}`;
+    return GotenbergUtils.fetch(endpoint, data);
+  }
+
+  public static async convert({
+    files,
+    properties,
+    pdfFormat,
+    merge,
+  }: {
+    files: PathLike[];
+    properties?: PageProperties;
+    pdfFormat?: PdfFormat;
+    merge?: boolean;
+  }): Promise<Buffer> {
+    const data = new FormData();
+    if (pdfFormat) {
+      data.append("pdfFormat", pdfFormat);
+    }
+    if (merge) {
+      data.append("merge", String(merge));
+    }
+    if (properties) {
+      LibreOfficeUtils.injectPageProperties(data, properties);
+    }
+    await LibreOfficeUtils.injectFiles(files, data);
+    const endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.LIBRE_OFFICE_PATH}/${Chromiumly.LIBRE_OFFICE_ROUTES.convert}`;
+    return GotenbergUtils.fetch(endpoint, data);
+  }
+
+  public static async generate(
+    filename: string,
+    buffer: Buffer
+  ): Promise<void> {
+    const __generated__ = path.resolve(process.cwd(), "__generated__");
+    await promises.mkdir(path.resolve(__generated__), { recursive: true });
+    await promises.writeFile(path.resolve(__generated__, filename), buffer);
+  }
+}

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

@@ -0,0 +1,18 @@
+import { constants, createReadStream, PathLike, promises } from "fs";
+import path from "path";
+
+import FormData from "form-data";
+
+export class PDFEngineUtils {
+  public static async injectFiles(files: PathLike[], data: FormData) {
+    for (const file of files) {
+      try {
+        await promises.access(file, constants.R_OK);
+        const filename = path.basename(file.toString());
+        data.append(filename, createReadStream(file));
+      } catch (error) {
+        throw error;
+      }
+    }
+  }
+}

package/.github/workflows/publish.yml

@@ -1,18 +0,0 @@
-name: Publish
-on:
-  release:
-    types: [published]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: "14.x"
-          registry-url: "https://registry.npmjs.org"
-      - run: yarn
-      - run: yarn build
-      - run: yarn publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/src/common/converter.ts

@@ -1,18 +0,0 @@
-import { promises } from "fs";
-import path from "path";
-
-import { Chromiumly, Route } from "../main.config";
-
-export abstract class Converter {
-  readonly endpoint: string;
-
-  constructor(route: Route) {
-    this.endpoint = `${Chromiumly.endpoint}/${Chromiumly.path}/${Chromiumly.routes[route]}`;
-  }
-
-  async generate(filename: string, buffer: Buffer): Promise<void> {
-    const __generated__ = path.resolve(process.cwd(), "__generated__");
-    await promises.mkdir(path.resolve(__generated__), { recursive: true });
-    await promises.writeFile(path.resolve(__generated__, filename), buffer);
-  }
-}

package/src/common/converter.utils.ts

@@ -1,101 +0,0 @@
-import FormData from "form-data";
-import fetch from "node-fetch";
-
-import { PageProperties } from "./converter.types";
-
-export class ConverterUtils {
-  private static assert(
-    condition: boolean,
-    message: string
-  ): asserts condition {
-    if (!condition) {
-      throw new Error(message);
-    }
-  }
-
-  public static injectPageProperties(
-    data: FormData,
-    pageProperties: PageProperties
-  ): void {
-    if (pageProperties) {
-      if (pageProperties.size) {
-        ConverterUtils.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) {
-        ConverterUtils.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) {
-        ConverterUtils.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) {
-        ConverterUtils.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}`
-        );
-      }
-    }
-  }
-
-  static async fetch(endpoint: string, data: FormData): Promise<Buffer> {
-    const response = await fetch(endpoint, {
-      method: "post",
-      body: data,
-      headers: {
-        ...data.getHeaders(),
-      },
-    });
-
-    if (!response.ok) {
-      throw new Error(`${response.status} ${response.statusText}`);
-    }
-    return response.buffer();
-  }
-}

package/src/converters/html.converter.ts

@@ -1,30 +0,0 @@
-import { createReadStream, PathLike } from "fs";
-
-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";
-
-export class HtmlConverter extends Converter implements IConverter {
-  constructor() {
-    super(Route.HTML);
-  }
-
-  async convert({
-    html,
-    properties,
-  }: {
-    html: PathLike;
-    properties?: PageProperties;
-  }): Promise<Buffer> {
-    const data = new FormData();
-    data.append("index.html", createReadStream(html));
-    if (properties) {
-      ConverterUtils.injectPageProperties(data, properties);
-    }
-    return ConverterUtils.fetch(this.endpoint, data);
-  }
-}

package/src/converters/markdown.converter.ts

@@ -1,33 +0,0 @@
-import { createReadStream, PathLike } from "fs";
-
-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";
-
-export class MarkdownConverter extends Converter implements IConverter {
-  constructor() {
-    super(Route.MARKDOWN);
-  }
-
-  async convert({
-    html,
-    markdown,
-    properties,
-  }: {
-    html: PathLike;
-    markdown: PathLike;
-    properties?: PageProperties;
-  }): Promise<Buffer> {
-    const data = new FormData();
-    data.append("index.html", createReadStream(html));
-    data.append("file.md", createReadStream(markdown));
-    if (properties) {
-      ConverterUtils.injectPageProperties(data, properties);
-    }
-    return ConverterUtils.fetch(this.endpoint, data);
-  }
-}

package/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "declaration": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "strictFunctionTypes": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "importHelpers": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "types": ["node"],
-    "lib": ["ES6"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "**/*.test.ts"]
-}