btrz-liquid-templates 2.0.1 → 2.2.0

package/.githooks/pre-commit

@@ -0,0 +1,18 @@
+#!/bin/sh
+# btrz-banned-libs-hook-v1
+set -eu
+
+DIFF_CONTENT=$(git diff --cached -U0 -- package.json package-lock.json npm-shrinkwrap.json yarn.lock pnpm-lock.yaml 2>/dev/null || true)
+
+if [ -z "$DIFF_CONTENT" ]; then
+  exit 0
+fi
+
+if printf '%s
+' "$DIFF_CONTENT" | rg -q '^\+.*("(lodash|mocha|chai|sinon)"|lodash@|mocha@|chai@|sinon@)'; then
+  echo ""
+  echo "Commit blocked: adding banned libraries is not allowed (lodash, mocha, chai, sinon)."
+  echo "Remove the staged dependency/lockfile additions and retry."
+  echo ""
+  exit 1
+fi

package/docs/index.md

@@ -267,26 +267,33 @@ Parameters
 |------|------------|----------|---------|
 | data | The string to use to generate the barcode, it can be hardcoded or some of the 'data' given to the template | Y | |
 | type | The barcode type | N | code128
-| height | The barcode height | N | 30
-| width | The barcode width | N | 200
+| height | For linear and rectangular barcodes: bar/module height (mm) passed to bwip-js. For square matrix types (see below): ignored so the PNG stays 1:1 | N | 30
+| width | Display width of the image in the PDF (points). For square matrix types this is what controls rendered size | N | 200
 | margin | A list of 4 values for the margin | N | 0,0,0,0
 
+For square matrix types (`qrcode`, `microqr`, `datamatrix`, `aztec`, `azrune`, `hanxin`, `maxicode`, `hibc_qr`, `hibc_dm`, `hibc_aztec`, and `codeone`), `height` is not applied when generating the image. The PNG remains square and the PDF scales it using `width` only. Passing equal `height` and `width` values (for example `50 50`) is fine and matches common templates, but only `width` affects the drawn size.
 
 It will use the value of ticket.code to generate the barcode with all the defaults
 
 ```liquid
-{% raw %} {% barcode ticket.code %} {% endraw %}
+{% raw %}{% barcode ticket.code %}{% endraw %}
 ```
 
 It will use the value given and use generate a 'code11' barcode with a height of 50 and a width of 300
 
 ```liquid
-{% raw %} {% barcode 1234 code11 50 300 20,20,20,0 %} {% endraw %} 
+{% raw %}{% barcode 1234 code11 50 300 20,20,20,0 %}{% endraw %}
+```
+
+A QR code drawn at 50 points wide (height argument is accepted but does not stretch the image):
+
+```liquid
+{% raw %}{% barcode ticket.qrCodeInfo qrcode 50 50 0,0,0,5 %}{% endraw %}
 ```
 
 ### Supported types
 
-The `{% barcode %}` tag accepts legacy Symbology-style type names and maps them to [bwip-js](https://github.com/metafloor/bwip-js) barcode identifiers. Common examples include `code128`, `code11`, `code39`, `qrcode`, `pdf417`, and `datamatrix`.
+The `{% raw %}{% barcode %}{% endraw %}` tag accepts legacy Symbology-style type names and maps them to [bwip-js](https://github.com/metafloor/bwip-js) barcode identifiers. Common examples include `code128`, `code11`, `code39`, `qrcode`, `pdf417`, and `datamatrix`.
 
 The following legacy type names are not supported and will throw an explicit error: `gridmatrix`, `koreapost`, `upnqr`, and `vin`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-liquid-templates",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "Extension and helpers for liquid templates to deal with our data and other things we need to encapsulate",
   "main": "src/index.js",
   "scripts": {
@@ -8,7 +8,8 @@
     "test": "node --test test/*-test.js",
     "preversion": "npm test",
     "postversion": "git push origin main && git push --tags",
-    "version": "git tag $1"
+    "version": "git tag $1",
+    "prepare": "git config core.hooksPath .githooks"
   },
   "repository": {
     "type": "git",
@@ -22,9 +23,9 @@
   "homepage": "https://github.com/Betterez/btrz-liquid-templates#readme",
   "dependencies": {
     "axios": "1.18.1",
-    "btrz-formatter": "1.7.0",
+    "btrz-formatter": "1.8.0",
     "bwip-js": "^4.11.2",
-    "bz-date": "2.2.0",
+    "bz-date": "2.4.0",
     "liquidjs": "10.27.1",
     "moment": "2.30.1",
     "moment-timezone": "0.6.2",

package/src/barcode-generator.js

@@ -1,17 +1,38 @@
 const bwipjs = require("bwip-js");
 const {resolveBarcodeType} = require("./barcode-types.js");
 
+const SQUARE_BCIDS = new Set([
+  "qrcode",
+  "microqrcode",
+  "datamatrix",
+  "azteccode",
+  "aztecrune",
+  "hanxin",
+  "maxicode",
+  "hibcqrcode",
+  "hibcdatamatrix",
+  "hibcazteccode",
+  "codeone"
+]);
+
 async function generateBarcodePng({type, content, height}) {
   const bcid = resolveBarcodeType(type);
-  const pngBuffer = await bwipjs.toBuffer({
+  const opts = {
     bcid,
     text: String(content),
     scale: 2,
-    height: Number(height) || 30,
     includetext: false,
     backgroundcolor: "FFFFFF"
-  });
+  };
+
+  // Linear (and rectangular 2D) barcodes: height is bar/module height in mm.
+  // Square matrix codes: omit height so bwip keeps a 1:1 PNG; display size
+  // is controlled by the image width in the document definition.
+  if (!SQUARE_BCIDS.has(bcid)) {
+    opts.height = Number(height) || 30;
+  }
 
+  const pngBuffer = await bwipjs.toBuffer(opts);
   return `data:image/png;base64,${pngBuffer.toString("base64")}`;
 }
 

package/test/barcode-test.js

@@ -1,7 +1,11 @@
 const assert = require("node:assert/strict");
 const {describe, it} = require("node:test");
 const {generateBarcodePng} = require("../src/barcode-generator.js");
-const {decodePngDataUri, isValidPngDataUri} = require("./helpers/barcode-decode.js");
+const {
+  decodePngDataUri,
+  isValidPngDataUri,
+  getPngDimensionsFromDataUri
+} = require("./helpers/barcode-decode.js");
 
 describe("barcode-generator.js", () => {
   it("should generate a valid PNG data URI for code128", async () => {
@@ -15,6 +19,34 @@ describe("barcode-generator.js", () => {
     assert.equal(isValidPngDataUri(image), true);
   });
 
+  it("should keep qrcode PNGs square when a height is provided", async () => {
+    const image = await generateBarcodePng({
+      type: "qrcode",
+      content: "test-payload",
+      height: 50
+    });
+
+    const {width, height} = getPngDimensionsFromDataUri(image);
+    assert.equal(width, height);
+  });
+
+  it("should apply height to linear barcodes so taller height produces a taller PNG", async () => {
+    const shortImage = await generateBarcodePng({
+      type: "code128",
+      content: "1234",
+      height: 10
+    });
+    const tallImage = await generateBarcodePng({
+      type: "code128",
+      content: "1234",
+      height: 50
+    });
+
+    const short = getPngDimensionsFromDataUri(shortImage);
+    const tall = getPngDimensionsFromDataUri(tallImage);
+    assert.ok(tall.height > short.height);
+  });
+
   it("should decode generated code128 barcodes to the original payload", async () => {
     const image = await generateBarcodePng({
       type: "code128",

package/test/helpers/barcode-decode.js

@@ -24,7 +24,14 @@ function isValidPngDataUri(dataUri) {
   return signature.equals(pngSignature);
 }
 
+function getPngDimensionsFromDataUri(dataUri) {
+  const base64 = dataUri.replace(/^data:image\/png;base64,/, "");
+  const png = PNG.sync.read(Buffer.from(base64, "base64"));
+  return {width: png.width, height: png.height};
+}
+
 module.exports = {
   decodePngDataUri,
-  isValidPngDataUri
+  isValidPngDataUri,
+  getPngDimensionsFromDataUri
 };