@liquid-js/qr-code-styling 1.9.0 → 1.10.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Denys Kozak
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 Denys Kozak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/core/QROptions.d.ts

@@ -4,6 +4,7 @@ export interface RequiredOptions extends Options {
     shape: ShapeType;
     width: number;
     height: number;
+    margin: number;
     data: string;
     qrOptions: {
         typeNumber: TypeNumber;

package/lib/qr-code-styling-node.js

@@ -168,6 +168,7 @@ const defaultOptions = {
     shape: exports.ShapeType.square,
     width: undefined,
     height: undefined,
+    margin: 0,
     data: "",
     qrOptions: {
         typeNumber: TypeNumber[0],
@@ -613,7 +614,11 @@ class QRDot {
 function calculateImageSize({ originalHeight, originalWidth, maxHiddenDots, maxHiddenAxisDots, dotSize, margin }) {
     const hideDots = { x: 0, y: 0 };
     const imageSize = { x: 0, y: 0 };
-    if (originalHeight <= 0 || originalWidth <= 0 || maxHiddenDots <= 0 || dotSize <= 0) {
+    if (originalHeight <= 0 ||
+        originalWidth <= 0 ||
+        maxHiddenDots <= 0 ||
+        dotSize <= 0 ||
+        4 * margin ** 2 > maxHiddenDots) {
         return {
             height: 0,
             width: 0,
@@ -621,56 +626,47 @@ function calculateImageSize({ originalHeight, originalWidth, maxHiddenDots, maxH
             hideXDots: 0
         };
     }
-    if (maxHiddenAxisDots) {
-        // Adjust max size based on image aspect ratio and margin
-        const maxD = maxHiddenAxisDots - 2 * margin;
-        if (originalWidth > originalHeight) {
-            const newH = (maxD * originalHeight) / originalWidth + 2 * margin;
-            maxHiddenDots = Math.min(maxHiddenDots, maxHiddenAxisDots * newH);
-        }
-        else {
-            const newW = (maxD * originalWidth) / originalHeight + 2 * margin;
-            maxHiddenDots = Math.min(maxHiddenDots, maxHiddenAxisDots * newW);
-        }
+    //If set, ensure maxHiddenAxisDots is odd and at least 1
+    if (maxHiddenAxisDots && maxHiddenAxisDots % 2 == 0)
+        maxHiddenAxisDots = Math.max(1, maxHiddenAxisDots - 1);
+    //Determine the bigger and smaller image dimension
+    const dimMax = Math.max(originalWidth, originalHeight);
+    const dimMin = Math.min(originalWidth, originalHeight);
+    //Find max image size along the bigger dimension
+    let lower = 0, upper = (maxHiddenAxisDots || maxHiddenDots) - 2 * margin;
+    do {
+        const size = lower + (upper - lower) / 2;
+        let dotsMax = Math.max(1, Math.ceil(size + 2 * margin));
+        if (dotsMax % 2 == 0)
+            dotsMax++;
+        let dotsMin = Math.max(1, Math.ceil((size * dimMin) / dimMax + 2 * margin));
+        if (dotsMin % 2 == 0)
+            dotsMin++;
+        if (dotsMax * dotsMin > maxHiddenDots)
+            upper = size;
+        else
+            lower = size;
+    } while (Math.abs(lower - upper) > 0.001);
+    //Calculate how many dots the given size corresponds to
+    const size = lower;
+    let hideMax = Math.max(1, Math.ceil(size + 2 * margin));
+    if (hideMax % 2 == 0)
+        hideMax++;
+    let hideMin = Math.max(1, Math.ceil((size * dimMin) / dimMax + 2 * margin));
+    if (hideMin % 2 == 0)
+        hideMin++;
+    //Set hidden dots along bigger and smaller dimension to the right axis
+    if (originalWidth > originalHeight) {
+        hideDots.x = hideMax;
+        hideDots.y = hideMin;
     }
-    const m2 = margin ** 2;
-    const w2 = originalWidth ** 2;
-    const h2 = originalHeight ** 2;
-    //Margin-adjuseted scale
-    const scale = (Math.sqrt(w2 * m2 + h2 * m2 + originalWidth * originalHeight * (maxHiddenDots - 2 * m2)) -
-        originalHeight * margin -
-        originalWidth * margin) /
-        (originalHeight * originalWidth);
-    hideDots.x = Math.max(1, Math.floor(originalWidth * scale + 2 * margin));
-    hideDots.y = Math.max(1, Math.floor(originalHeight * scale + 2 * margin));
-    if (hideDots.x > hideDots.y) {
-        //The count of dots should be odd
-        if (hideDots.x % 2 === 0)
-            hideDots.x--;
-        hideDots.y = Math.max(1, Math.ceil(((hideDots.x - 2 * margin) * originalHeight) / originalWidth + 2 * margin));
-        //The count of dots should be odd
-        if (hideDots.y % 2 === 0)
-            hideDots.y--;
-    }
-    else if (hideDots.x < hideDots.y) {
-        //The count of dots should be odd
-        if (hideDots.y % 2 === 0)
-            hideDots.y--;
-        hideDots.x = Math.max(1, Math.ceil(((hideDots.y - 2 * margin) * originalWidth) / originalHeight + 2 * margin));
-        //The count of dots should be odd
-        if (hideDots.x % 2 === 0)
-            hideDots.x--;
+    else {
+        hideDots.x = hideMin;
+        hideDots.y = hideMax;
     }
+    //Fit image to the hidden dots
     const maxW = (hideDots.x - 2 * margin) * dotSize;
     const maxH = (hideDots.y - 2 * margin) * dotSize;
-    if (maxW <= 0 || maxH <= 0) {
-        return {
-            height: 0,
-            width: 0,
-            hideYDots: hideDots.y,
-            hideXDots: hideDots.x
-        };
-    }
     imageSize.x = maxW;
     imageSize.y = (maxW * originalHeight) / originalWidth;
     if (imageSize.y > maxH) {
@@ -779,7 +775,7 @@ class QRSVG {
         const count = qr.getModuleCount();
         const minSize = Math.min(this._options.width, this._options.height);
         const realQRSize = this._options.shape === exports.ShapeType.circle ? minSize / Math.sqrt(2) : minSize;
-        const dotSize = Math.floor(realQRSize / count);
+        const dotSize = Math.floor(realQRSize / (count + 2 * this._options.margin));
         let drawImageSize = {
             hideXDots: 0,
             hideYDots: 0,
@@ -865,7 +861,7 @@ class QRSVG {
         }
         const minSize = Math.min(options.width, options.height);
         const realQRSize = options.shape === exports.ShapeType.circle ? minSize / Math.sqrt(2) : minSize;
-        const dotSize = Math.floor(realQRSize / count);
+        const dotSize = Math.floor(realQRSize / (count + 2 * this._options.margin));
         const xBeginning = Math.floor((options.width - count * dotSize) / 2);
         const yBeginning = Math.floor((options.height - count * dotSize) / 2);
         const dot = new QRDot({ svg: this._element, type: options.dotsOptions.type, document: this._document });
@@ -903,7 +899,7 @@ class QRSVG {
             }
         }
         if (options.shape === exports.ShapeType.circle) {
-            const additionalDots = Math.floor((minSize / dotSize - count) / 2);
+            const additionalDots = Math.floor((minSize / dotSize - count - 2 * this._options.margin) / 2);
             const fakeCount = count + additionalDots * 2;
             const xFakeBeginning = xBeginning - additionalDots * dotSize;
             const yFakeBeginning = yBeginning - additionalDots * dotSize;
@@ -955,7 +951,7 @@ class QRSVG {
         const count = this._qr.getModuleCount();
         const minSize = Math.min(options.width, options.height);
         const realQRSize = options.shape === exports.ShapeType.circle ? minSize / Math.sqrt(2) : minSize;
-        const dotSize = Math.floor(realQRSize / count);
+        const dotSize = Math.floor(realQRSize / (count + 2 * this._options.margin));
         const cornersSquareSize = dotSize * 7;
         const cornersDotSize = dotSize * 3;
         const xBeginning = Math.floor((options.width - count * dotSize) / 2);
@@ -1181,7 +1177,7 @@ let QRCodeStyling$1 = class QRCodeStyling {
         if (!this._qr) {
             return;
         }
-        this._options.width = this._options.height = 10 * this._qr.getModuleCount();
+        this._options.width = this._options.height = 10 * (this._qr.getModuleCount() + 2 * this._options.margin);
         const qrSVG = new QRSVG(this._options);
         this._svg = qrSVG.getElement();
         this._svgDrawingPromise = qrSVG.drawQR(this._qr).then(() => {