@liquid-js/qr-code-styling 3.1.3 → 4.0.0-1

package/lib/utils/options.d.ts

@@ -1,5 +1,5 @@
+import { ErrorCorrectionLevel, Mode, TypeNumber } from "@liquid-js/qrcode-generator/lib/qrcode/QRCodeMinimal.js";
 import { browserImageTools } from "../tools/browser-image-tools.js";
-import { ErrorCorrectionLevel, TypeNumber } from "../types/qrcode.js";
 import { Gradient } from "./gradient.js";
 export declare enum DotType {
     dot = "dot",
@@ -12,6 +12,7 @@ export declare enum DotType {
     classyRounded = "classy-rounded",
     square = "square",
     smallSquare = "small-square",
+    tinySquare = "tiny-square",
     diamond = "diamond"
 }
 export declare enum CornerDotType {
@@ -35,6 +36,16 @@ export declare enum ShapeType {
     square = "square",
     circle = "circle"
 }
+export declare enum ImageMode {
+    /**
+     * Place image in the center of the code
+     */
+    center = "center",
+    /**
+     * Use image as background, draw dots over it
+     */
+    background = "background"
+}
 export interface Options {
     /** Use a custom DOM domplementation */
     document: Document;
@@ -54,7 +65,7 @@ export interface Options {
      * @default ShapeType.square
      */
     shape: `${ShapeType}`;
-    /** Options will be passed to `qrcode-generator` lib */
+    /** Options will be passed to `@liquid-js/qrcode-generator` lib */
     qrOptions: {
         typeNumber: TypeNumber;
         mode?: `${Mode}`;
@@ -63,11 +74,24 @@ export interface Options {
     };
     imageOptions: {
         /**
-         * Hide all dots covered by the image
+         * Image mode
          *
-         * @default true
+         * @default ImageMode.center
+         */
+        mode: `${ImageMode}`;
+        /**
+         * Fill blank areas of the code with selected color
          */
-        hideBackgroundDots: boolean;
+        fill: {
+            /**
+             * Color of QR dots
+             *
+             * @default "rgba(255,255,255,0.75)"
+             */
+            color: string;
+            /** Gradient of Corners Dot */
+            gradient?: Gradient;
+        };
         /**
          * Coefficient of the image size
          *

package/lib/utils/qrcode.d.ts

@@ -1,4 +1,4 @@
-import { Mode } from "../types/qrcode.js";
+import { Mode } from "@liquid-js/qrcode-generator/lib/qrcode/QRCodeMinimal.js";
 export declare const ErrorCorrectionPercents: {
     L: number;
     M: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liquid-js/qr-code-styling",
-  "version": "3.1.3",
+  "version": "4.0.0-1",
   "description": "Generate styled QR codes on web or in Node",
   "type": "module",
   "main": "./lib/qr-code-styling-node.js",
@@ -24,19 +24,19 @@
     "lib"
   ],
   "peerDependencies": {
+    "@liquid-js/qrcode-generator": "^1.0.0-8",
     "@xmldom/xmldom": "^0.9.0",
     "file-type": "^19.0.0",
-    "qrcode-generator": "^1.4.4",
     "sharp": ">0.32.1 <1.0.0"
   },
   "peerDependenciesMeta": {
-    "@xmldom/xmldom": {
+    "@liquid-js/qrcode-generator": {
       "optional": true
     },
-    "file-type": {
+    "@xmldom/xmldom": {
       "optional": true
     },
-    "qrcode-generator": {
+    "file-type": {
       "optional": true
     },
     "sharp": {
@@ -70,5 +70,8 @@
   "bugs": {
     "url": "https://github.com/Liquid-JS/qr-code-styling/issues"
   },
-  "homepage": "https://styled-qr.liquidjs.io/"
+  "homepage": "https://styled-qr.liquidjs.io/",
+  "dependencies": {
+    "mocha": "^10.7.3"
+  }
 }

package/lib/types/qrcode.d.ts

@@ -1,22 +0,0 @@
-type TypeNumber = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40;
-declare const TypeNumber: { [P in TypeNumber]: P; };
-export { TypeNumber };
-export declare enum ErrorCorrectionLevel {
-    L = "L",
-    M = "M",
-    Q = "Q",
-    H = "H"
-}
-export declare enum Mode {
-    numeric = "Numeric",
-    alphanumeric = "Alphanumeric",
-    byte = "Byte",
-    kanji = "Kanji",
-    unicode = "Unicode"
-}
-export interface QRCode {
-    addData(data: string, mode?: Mode.alphanumeric | Mode.byte | Mode.kanji | Mode.numeric): void;
-    make(): void;
-    getModuleCount(): number;
-    isDark(row: number, col: number): boolean;
-}