add manual test, upgrade deps, doc (#7)

.docs/arm.md

@@ -2,8 +2,9 @@
 
 This example is for Macbook Pro M1.
 
-## Steps
+Run installation of these tools in your terminal.
+You have to use brew.
 
-1. [Install tooling for Rosseta](https://support.apple.com/en-gb/HT211861)
-2. [Open iTerm / Terminal with Rosseta](https://apple.stackexchange.com/a/428769)
-3. Run package and projects depending on that from this terminal
+```
+arch -arm64 brew install pkg-config cairo pango jpeg giflib librsvg
+```

.github/workflows/pull-request-created.yml

@@ -31,6 +31,9 @@ jobs:
       - name: 'Build'
         run: npm run build
 
+      - name: 'Tests'
+        run: npm run test
+
       - name: 'The job has failed'
         if: ${{ failure() }}
         uses: marocchino/sticky-pull-request-comment@v1

.gitignore

@@ -9,3 +9,5 @@ node_modules
 .vscode
 
 dist/
+
+tmp/*

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trisbee/qr-image-nodejs",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "types": "dist/index.d.ts",
   "description": "Allows you to generate image in middle of QR code",
   "main": "dist/index.js",
@@ -9,11 +9,12 @@
     "url": "git+https://github.com/trisbee/qr-image-nodejs.git"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc --removeComments",
+    "test": "node ./test/qr-code-without-img.js"
   },
   "dependencies": {
-    "canvas": "^2.7.0",
-    "qrcode": "^1.4.4"
+    "canvas": "^2.9.0",
+    "qrcode": "^1.5.0"
   },
   "devDependencies": {
     "@types/node": "^14.0.27",

src/index.ts

@@ -1,6 +1,6 @@
 import QRCOde = require('qrcode');
-import {QRCodeToBufferOptions} from "qrcode";
-import {createCanvas, loadImage} from "canvas";
+import { QRCodeToBufferOptions } from "qrcode";
+import { createCanvas, loadImage } from "canvas";
 
 interface QRResponse {
     buffer: Buffer,

test/qr-code-without-img.js

@@ -0,0 +1,20 @@
+const { generateQRWithImage } = require('../dist/index');
+const { printToTerminal } = require("./tools");
+
+async function TestQRCodeWithoutImage()
+{
+  console.debug(`⏳ QR code start ...`);
+
+  const data = await generateQRWithImage(
+    "https://www.trisbee.com/en/careers",
+    256,
+    256,
+    null
+  );
+
+  console.info(`👍 QR code generated ...`);
+
+  printToTerminal(data.buffer);
+}
+
+TestQRCodeWithoutImage();

test/tools.js

@@ -0,0 +1,48 @@
+const fs = require('fs');
+const path = require('path');
+const resolve = require('path').resolve
+
+/**
+ * convert buffer data to file on disk
+ */
+async function imageToFile(body) {
+
+  const suffix = Math.floor(new Date().getTime() / 1000);
+  const fileName = `image-${suffix}.png`;
+  const folder = '/../tmp/';
+
+  let fileAbsolutePath = path.join(__dirname, folder, fileName);
+
+  ensureDirectoryExistence(fileAbsolutePath);
+
+  fs.writeFile(fileAbsolutePath, body, function(err) {
+    if (err) throw err;
+    console.log("✅ File saved to:", 'file://' + fileAbsolutePath);
+  });
+}
+
+/**
+ * check if directory path exist
+ * if not, create it
+ */
+function ensureDirectoryExistence(filePath)
+{
+  const dirname = path.dirname(filePath);
+  if (fs.existsSync(dirname)) {
+    return true;
+  }
+  ensureDirectoryExistence(dirname);
+
+  fs.mkdirSync(dirname);
+}
+
+
+/**
+ * get buffer and print QR code to terminal
+ */
+async function printToTerminal(buffer) {
+  await imageToFile(buffer);
+}
+
+
+module.exports.printToTerminal = printToTerminal;