improvements on the margin param

Author: iamdual

.github/workflows/ci.yml

@@ -2,6 +2,8 @@ name: CI
 
 on:
   push:
+    branches:
+      - "master"
     paths-ignore:
       - "**.md"
   pull_request:

src/config.ts

@@ -7,7 +7,6 @@
 import { PaperFormat, PDFMargin } from "puppeteer";
 
 export default class Config {
-  static defaultUnit: string = "px";
   static defaultFormat: PaperFormat = "A4";
   static formatList: PaperFormat[] = [
     "A0",
@@ -131,9 +130,16 @@ export default class Config {
           break;
         case "margin":
           if (typeof params[param] === "string") {
-            this.margin = new Margin().fromString(params[param]);
+            this.margin = Margin.fromString(params[param]);
           } else if (params[param] instanceof Margin) {
             this.margin = params[param];
+          } else if (Margin.isImplements(params[param])) {
+            this.margin = new Margin(
+              params[param].top,
+              params[param].right,
+              params[param].bottom,
+              params[param].left
+            );
           }
           break;
       }
@@ -143,11 +149,16 @@ export default class Config {
 
 export class Margin implements PDFMargin {
   top?: string | number;
+  right?: string | number;
   bottom?: string | number;
   left?: string | number;
-  right?: string | number;
 
-  constructor(top?: number, right?: number, bottom?: number, left?: number) {
+  constructor(
+    top?: string | number,
+    right?: string | number,
+    bottom?: string | number,
+    left?: string | number
+  ) {
     this.top = top ?? 0;
     this.right = right ?? 0;
     this.bottom = bottom ?? 0;
@@ -165,27 +176,24 @@ export class Margin implements PDFMargin {
     }
   }
 
-  fromString(margins: string): Margin {
+  static fromString(margins: string): Margin {
     const _margins = margins.split(" ", 4);
     if (_margins.length === 1) {
-      return new Margin(parseInt(_margins[0]));
+      return new Margin(_margins[0]);
+    } else if (_margins.length === 2) {
+      return new Margin(_margins[0], _margins[1], _margins[0], _margins[1]);
     } else if (_margins.length === 4) {
-      return new Margin(
-        parseInt(_margins[0]),
-        parseInt(_margins[1]),
-        parseInt(_margins[2]),
-        parseInt(_margins[3])
-      );
+      return new Margin(_margins[0], _margins[1], _margins[2], _margins[3]);
     }
     return new Margin();
   }
 
-  toUnits(): PDFMargin {
-    return {
-      top: (this.top ?? 0) + Config.defaultUnit,
-      right: (this.right ?? 0) + Config.defaultUnit,
-      bottom: (this.bottom ?? 0) + Config.defaultUnit,
-      left: (this.left ?? 0) + Config.defaultUnit,
-    };
+  static isImplements(obj: any): boolean {
+    return (
+      ["string", "number", "undefined"].includes(typeof obj.top) &&
+      ["string", "number", "undefined"].includes(typeof obj.right) &&
+      ["string", "number", "undefined"].includes(typeof obj.bottom) &&
+      ["string", "number", "undefined"].includes(typeof obj.left)
+    );
   }
 }

src/generator/index.ts

@@ -49,7 +49,7 @@ export default async (config: Config) => {
     height: config.height,
     scale: config.scale,
     landscape: config.landscape,
-    margin: config.margin.toUnits(),
+    margin: config.margin,
   });
 
   // Close the browser instance

src/rest-api/generate.ts

@@ -44,7 +44,7 @@ export default async (req: Request, res: Response) => {
       return;
     }
     if (process.env.NODE_ENV === "development") {
-      console.log(error);
+      console.error(error);
     }
     res.status(500).json({
       error: "SERVER_ERROR",

src/rest-api/index.ts

@@ -10,6 +10,9 @@ import generate from "./generate";
 export const route: Express = express();
 route.use(express.json());
 route.use((err: Error, _req: Request, res: Response, next: NextFunction) => {
+  if (err !== undefined && process.env.NODE_ENV === "development") {
+    console.error(err);
+  }
   if (err instanceof SyntaxError) {
     res
       .status(400)

test/config.margins.test.ts

@@ -2,55 +2,83 @@ import assert from "assert";
 import Config, { Margin } from "../src/config";
 
 describe("Margins", function () {
-  describe("Default margins", function () {
+  describe("Defaults", function () {
     it("Should be zero", function () {
       const config = new Config();
       assert.equal(config.margin.top, 0);
       assert.equal(config.margin.right, 0);
       assert.equal(config.margin.bottom, 0);
       assert.equal(config.margin.left, 0);
     });
-    it("getMargins() returns as expected", function () {
-      const config = new Config();
-      assert.equal(config.margin.toUnits().top, "0px");
-      assert.equal(config.margin.toUnits().right, "0px");
-      assert.equal(config.margin.toUnits().bottom, "0px");
-      assert.equal(config.margin.toUnits().left, "0px");
-    });
   });
 
   describe("Set margins", function () {
     it("Should set all four margins", function () {
-      const config = new Config();
       const margin = new Margin(2);
       assert.equal(margin.top, 2);
       assert.equal(margin.right, 2);
       assert.equal(margin.bottom, 2);
       assert.equal(margin.left, 2);
     });
     it("Should set all four margins with fromString()", function () {
-      const config = new Config();
-      const margin = new Margin().fromString("2");
-      assert.equal(margin.top, 2);
-      assert.equal(margin.right, 2);
-      assert.equal(margin.bottom, 2);
-      assert.equal(margin.left, 2);
+      const margin = Margin.fromString("2px");
+      assert.equal(margin.top, "2px");
+      assert.equal(margin.right, "2px");
+      assert.equal(margin.bottom, "2px");
+      assert.equal(margin.left, "2px");
     });
     it("Should set specific margins", function () {
-      const config = new Config();
       const margin = new Margin(2, 0, 10, 9);
       assert.equal(margin.top, 2);
       assert.equal(margin.right, 0);
       assert.equal(margin.bottom, 10);
       assert.equal(margin.left, 9);
     });
     it("Should set specific margins with fromString()", function () {
-      const config = new Config();
-      const margin = new Margin().fromString("2 0 10 9");
-      assert.equal(margin.top, 2);
-      assert.equal(margin.right, 0);
-      assert.equal(margin.bottom, 10);
-      assert.equal(margin.left, 9);
+      const margin = Margin.fromString("2 0 10 9");
+      assert.equal(margin.top, "2");
+      assert.equal(margin.right, "0");
+      assert.equal(margin.bottom, "10");
+      assert.equal(margin.left, "9");
+    });
+    it("Should set specific margins with fromString()", function () {
+      const margin = Margin.fromString("0 100");
+      assert.equal(margin.top, "0");
+      assert.equal(margin.right, "100");
+      assert.equal(margin.bottom, "0");
+      assert.equal(margin.left, "100");
+    });
+    it("Should set with Config", function () {
+      const config = new Config({ margin: new Margin(1, 2, 3, 4) });
+      assert.equal(config.margin.top, 1);
+      assert.equal(config.margin.right, 2);
+      assert.equal(config.margin.bottom, 3);
+      assert.equal(config.margin.left, 4);
+    });
+    it("Should set with an object", function () {
+      const config = new Config({ margin: { top: 1, left: 2, right: 3 } });
+      assert.equal(config.margin.top, 1);
+      assert.equal(config.margin.left, 2);
+      assert.equal(config.margin.right, 3);
+      assert.equal(config.margin.bottom, 0);
+    });
+  });
+
+  describe("isImplements()", function () {
+    it("Valid object", function () {
+      const obj = {
+        top: 100,
+        right: undefined,
+        bottom: "100",
+      };
+      assert.equal(Margin.isImplements(obj), true);
+    });
+    it("Invalid object", function () {
+      const obj = {
+        top: {},
+        right: false,
+      };
+      assert.equal(Margin.isImplements(obj), false);
     });
   });
 });