npm - qrstylelib - Versions diffs - 1.0.0 - Mend

qrstylelib 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/example.js +135 -0
package/package.json +38 -0
package/src/core/analyzer.ts +55 -0
package/src/core/qr/qrcodegen.ts +1032 -0
package/src/default.ts +27 -0
package/src/export.ts +56 -0
package/src/frame-inset.ts +153 -0
package/src/index.ts +669 -0
package/src/renderer/shapes.ts +118 -0
package/src/types.ts +104 -0
package/test/readability.test.ts +71 -0
package/test.js +160 -0
package/tsconfig.json +15 -0
package/tsup.config.ts +10 -0

package/src/renderer/shapes.ts ADDED Viewed

@@ -0,0 +1,118 @@
+// src/renderer/shapes.ts
+// Exporting static path strings.
+// These paths are designed for a 24x24 viewBox.
+// When used in <use>, the viewBox will be preserved, and width/height will handle scaling.
+export const shapes = {
+  "inner-eye-classy": {
+    viewBox: "0 0 24 24",
+    d: "M4 0H20H24V4V20C24 22.2091 22.2091 24 20 24H4H0V20V4C0 1.79086 1.79086 0 4 0Z",
+  },
+  "inner-eye-dot": {
+    viewBox: "0 0 24 24",
+    d: "M24 12C24 18.6274 18.6274 24 12 24C5.37258 24 0 18.6274 0 12C0 5.37258 5.37258 0 12 0C18.6274 0 24 5.37258 24 12Z",
+  },
+  "inner-eye-dots": {
+    viewBox: "0 0 24 24",
+    d: "M8 4C8 6.20914 6.20914 8 4 8C1.79086 8 0 6.20914 0 4C0 1.79086 1.79086 0 4 0C6.20914 0 8 1.79086 8 4Z M16 4C16 6.20914 14.2091 8 12 8C9.79086 8 8 6.20914 8 4C8 1.79086 9.79086 0 12 0C14.2091 0 16 1.79086 16 4Z M24 4C24 6.20914 22.2091 8 20 8C17.7909 8 16 6.20914 16 4C16 1.79086 17.7909 0 20 0C22.2091 0 24 1.79086 24 4Z M24 12C24 14.2091 22.2091 16 20 16C17.7909 16 16 14.2091 16 12C16 9.79086 17.7909 8 20 8C22.2091 8 24 9.79086 24 12Z M24 20C24 22.2091 22.2091 24 20 24C17.7909 24 16 22.2091 16 20C16 17.7909 17.7909 16 20 16C22.2091 16 24 17.7909 24 20Z M16 20C16 22.2091 14.2091 24 12 24C9.79086 24 8 22.2091 8 20C8 17.7909 9.79086 16 12 16C14.2091 16 16 17.7909 16 20Z M8 20C8 22.2091 6.20914 24 4 24C1.79086 24 0 22.2091 0 20C0 17.7909 1.79086 16 4 16C6.20914 16 8 17.7909 8 20Z M8 12C8 14.2091 6.20914 16 4 16C1.79086 16 0 14.2091 0 12C0 9.79086 1.79086 8 4 8C6.20914 8 8 9.79086 8 12Z M16 12C16 14.2091 14.2091 16 12 16C9.79086 16 8 14.2091 8 12C8 9.79086 9.79086 8 12 8C14.2091 8 16 9.79086 16 12Z",
+  },
+  "inner-eye-extra-classy": {
+    viewBox: "0 0 24 24",
+    d: "M8 0H16H24V8V16C24 20.4183 20.4183 24 16 24H8H0V16V8C0 3.58172 3.58172 0 8 0Z",
+  },
+  "inner-eye-extra-rounded": {
+    viewBox: "0 0 24 24",
+    d: "M0 8C0 3.58172 3.58172 0 8 0H16C20.4183 0 24 3.58172 24 8V16C24 20.4183 20.4183 24 16 24H8C3.58172 24 0 20.4183 0 16V8Z",
+  },
+  "inner-eye-rounded": {
+    viewBox: "0 0 24 24",
+    d: "M0 4C0 1.79086 1.79086 0 4 0H20C22.2091 0 24 1.79086 24 4V20C24 22.2091 22.2091 24 20 24H4C1.79086 24 0 22.2091 0 20V4Z",
+  },
+  "inner-eye-square": {
+    viewBox: "0 0 24 24",
+    d: "M0 0H24V24H0V0Z",
+  },
+  "outer-eye-classy": {
+    viewBox: "0 0 24 24",
+    d: "M24 0V22C24 23.1046 23.1046 24 22 24H0V2C0 0.895431 0.895431 0 2 0H24ZM3.5 3.5V20.5H20.5V3.5H3.5Z",
+  },
+  "outer-eye-dot": {
+    viewBox: "0 0 24 24",
+    d: "M12 0C18.6274 0 24 5.37258 24 12C24 18.6274 18.6274 24 12 24C5.37258 24 0 18.6274 0 12C0 5.37258 5.37258 0 12 0ZM12 3.5C7.30558 3.5 3.5 7.30558 3.5 12C3.5 16.6944 7.30558 20.5 12 20.5C16.6944 20.5 20.5 16.6944 20.5 12C20.5 7.30558 16.6944 3.5 12 3.5Z",
+  },
+  "outer-eye-dots": {
+    viewBox: "0 0 24 24",
+    d: "M1.71429 20.5714C2.66106 20.5714 3.42857 21.3389 3.42857 22.2857C3.42857 23.2325 2.66106 24 1.71429 24C0.767512 24 0 23.2325 0 22.2857C0 21.3389 0.767512 20.5714 1.71429 20.5714Z M5.14286 20.5714C6.08963 20.5714 6.85714 21.3389 6.85714 22.2857C6.85714 23.2325 6.08963 24 5.14286 24C4.19608 24 3.42857 23.2325 3.42857 22.2857C3.42857 21.3389 4.19608 20.5714 5.14286 20.5714Z M8.57143 20.5714C9.5182 20.5714 10.2857 21.3389 10.2857 22.2857C10.2857 23.2325 9.5182 24 8.57143 24C7.62466 24 6.85714 23.2325 6.85714 22.2857C6.85714 21.3389 7.62466 20.5714 8.57143 20.5714Z M12 20.5714C12.9468 20.5714 13.7143 21.3389 13.7143 22.2857C13.7143 23.2325 12.9468 24 12 24C11.0532 24 10.2857 23.2325 10.2857 22.2857C10.2857 21.3389 11.0532 20.5714 12 20.5714Z M15.4286 20.5714C16.3753 20.5714 17.1429 21.3389 17.1429 22.2857C17.1429 23.2325 16.3753 24 15.4286 24C14.4818 24 13.7143 23.2325 13.7143 22.2857C13.7143 21.3389 14.4818 20.5714 15.4286 20.5714Z M18.8571 20.5714C19.8039 20.5714 20.5714 21.3389 20.5714 22.2857C20.5714 23.2325 19.8039 24 18.8571 24C17.9104 24 17.1429 23.2325 17.1429 22.2857C17.1429 21.3389 17.9104 20.5714 18.8571 20.5714Z M22.2857 20.5714C23.2325 20.5714 24 21.3389 24 22.2857C24 23.2325 23.2325 24 22.2857 24C21.3389 24 20.5714 23.2325 20.5714 22.2857C20.5714 21.3389 21.3389 20.5714 22.2857 20.5714Z M1.71429 17.1429C2.66106 17.1429 3.42857 17.9104 3.42857 18.8571C3.42857 19.8039 2.66106 20.5714 1.71429 20.5714C0.767512 20.5714 0 19.8039 0 18.8571C0 17.9104 0.767512 17.1429 1.71429 17.1429Z M22.2857 17.1429C23.2325 17.1429 24 17.9104 24 18.8571C24 19.8039 23.2325 20.5714 22.2857 20.5714C21.3389 20.5714 20.5714 19.8039 20.5714 18.8571C20.5714 17.9104 21.3389 17.1429 22.2857 17.1429Z M1.71429 13.7143C2.66106 13.7143 3.42857 14.4818 3.42857 15.4286C3.42857 16.3753 2.66106 17.1429 1.71429 17.1429C0.767512 17.1429 0 16.3753 0 15.4286C0 14.4818 0.767512 13.7143 1.71429 13.7143Z M22.2857 13.7143C23.2325 13.7143 24 14.4818 24 15.4286C24 16.3753 23.2325 17.1429 22.2857 17.1429C21.3389 17.1429 20.5714 16.3753 20.5714 15.4286C20.5714 14.4818 21.3389 13.7143 22.2857 13.7143Z M1.71429 10.2857C2.66106 10.2857 3.42857 11.0532 3.42857 12C3.42857 12.9468 2.66106 13.7143 1.71429 13.7143C0.767512 13.7143 0 12.9468 0 12C0 11.0532 0.767512 10.2857 1.71429 10.2857Z M22.2857 10.2857C23.2325 10.2857 24 11.0532 24 12C24 12.9468 23.2325 13.7143 22.2857 13.7143C21.3389 13.7143 20.5714 12.9468 20.5714 12C20.5714 11.0532 21.3389 10.2857 22.2857 10.2857Z M1.71429 6.85714C2.66106 6.85714 3.42857 7.62466 3.42857 8.57143C3.42857 9.5182 2.66106 10.2857 1.71429 10.2857C0.767512 10.2857 0 9.5182 0 8.57143C0 7.62466 0.767512 6.85714 1.71429 6.85714Z M22.2857 6.85714C23.2325 6.85714 24 7.62466 24 8.57143C24 9.5182 23.2325 10.2857 22.2857 10.2857C21.3389 10.2857 20.5714 9.5182 20.5714 8.57143C20.5714 7.62466 21.3389 6.85714 22.2857 6.85714Z M1.71429 3.42857C2.66106 3.42857 3.42857 4.19608 3.42857 5.14286C3.42857 6.08963 2.66106 6.85714 1.71429 6.85714C0.767512 6.85714 0 6.08963 0 5.14286C0 4.19608 0.767512 3.42857 1.71429 3.42857Z M22.2857 3.42857C23.2325 3.42857 24 4.19608 24 5.14286C24 6.08963 23.2325 6.85714 22.2857 6.85714C21.3389 6.85714 20.5714 6.08963 20.5714 5.14286C20.5714 4.19608 21.3389 3.42857 22.2857 3.42857Z M1.71429 0C2.66106 0 3.42857 0.767512 3.42857 1.71429C3.42857 2.66106 2.66106 3.42857 1.71429 3.42857C0.767512 3.42857 0 2.66106 0 1.71429C0 0.767512 0.767512 0 1.71429 0Z M5.14286 0C6.08963 0 6.85714 0.767512 6.85714 1.71429C6.85714 2.66106 6.08963 3.42857 5.14286 3.42857C4.19608 3.42857 3.42857 2.66106 3.42857 1.71429C3.42857 0.767512 4.19608 0 5.14286 0Z M8.57143 0C9.5182 0 10.2857 0.767512 10.2857 1.71429C10.2857 2.66106 9.5182 3.42857 8.57143 3.42857C7.62466 3.42857 6.85714 2.66106 6.85714 1.71429C6.85714 0.767512 7.62466 0 8.57143 0Z M12 0C12.9468 0 13.7143 0.767512 13.7143 1.71429C13.7143 2.66106 12.9468 3.42857 12 3.42857C11.0532 3.42857 10.2857 2.66106 10.2857 1.71429C10.2857 0.767512 11.0532 0 12 0Z M15.4286 0C16.3753 0 17.1429 0.767512 17.1429 1.71429C17.1429 2.66106 16.3753 3.42857 15.4286 3.42857C14.4818 3.42857 13.7143 2.66106 13.7143 1.71429C13.7143 0.767512 14.4818 0 15.4286 0Z M18.8571 0C19.8039 0 20.5714 0.767512 20.5714 1.71429C20.5714 2.66106 19.8039 3.42857 18.8571 3.42857C17.9104 3.42857 17.1429 2.66106 17.1429 1.71429C17.1429 0.767512 17.9104 0 18.8571 0Z M22.2857 0C23.2325 0 24 0.767512 24 1.71429C24 2.66106 23.2325 3.42857 22.2857 3.42857C21.3389 3.42857 20.5714 2.66106 20.5714 1.71429C20.5714 0.767512 21.3389 0 22.2857 0Z",
+  },
+  "outer-eye-extra-classy": {
+    viewBox: "0 0 24 24",
+    d: "M24 0V20C24 22.2091 22.2091 24 20 24H0V4C2.57702e-07 1.79086 1.79086 0 4 0H24ZM3.5 3.5V20.5H20.5V3.5H3.5Z",
+  },
+  "outer-eye-extra-rounded": {
+    viewBox: "0 0 24 24",
+    d: "M16 0C20.4183 0 24 3.58172 24 8V16C24 20.4183 20.4183 24 16 24H8C3.58172 24 1.28855e-07 20.4183 0 16V8C0 3.58172 3.58172 1.28851e-07 8 0H16ZM9 3.5C5.96243 3.5 3.5 5.96243 3.5 9V15C3.5 18.0376 5.96243 20.5 9 20.5H15C18.0376 20.5 20.5 18.0376 20.5 15V9C20.5 5.96243 18.0376 3.5 15 3.5H9Z",
+  },
+  "outer-eye-rounded": {
+    viewBox: "0 0 24 24",
+    d: "M20 0C22.2091 2.57702e-07 24 1.79086 24 4V20C24 22.2091 22.2091 24 20 24H4C1.79086 24 6.44266e-08 22.2091 0 20V4C2.57702e-07 1.79086 1.79086 6.44266e-08 4 0H20ZM3.5 3.5V20.5H20.5V3.5H3.5Z",
+  },
+  "outer-eye-square": {
+    viewBox: "0 0 24 24",
+    d: "M24 24H0V0H24V24ZM3.5 3.5V20.5H20.5V3.5H3.5Z",
+  },
+  "dots-classy": {
+    viewBox: "0 0 24 24",
+    d: "M16 4C16 1.79086 17.7909 0 20 0H24V4C24 6.20914 22.2091 8 20 8H16V4Z M4 0C1.79086 0 0 1.79086 0 4V8V24H16H20C22.2091 24 24 22.2091 24 20V16H16V8L8 8V0H4Z",
+  },
+  "dots-classy-rounded": {
+    viewBox: "0 0 24 24",
+    d: "M16 4C16 1.79086 17.7909 0 20 0H24V4C24 6.20914 22.2091 8 20 8H16V4Z M8 0C3.58172 5.15422e-07 0 3.58172 0 8V24H16C20.4183 24 24 20.4183 24 16H16V8L8 8V0Z",
+  },
+  "dots-extra-rounded": {
+    viewBox: "0 0 24 24",
+    d: "M16 4.00003C16 1.79089 17.7909 2.47955e-05 20 2.47955e-05C22.2092 2.47955e-05 24 1.79089 24 4.00003C24 6.20916 22.2092 8.00003 20 8.00003C17.7909 8.00003 16 6.20916 16 4.00003Z M8 4V8C12.4183 8 16 11.5817 16 16H20C22.2091 16 24 17.7909 24 20C24 22.2091 22.2091 24 20 24H8C3.58172 24 0 20.4183 0 16V4C0 1.79086 1.79086 0 4 0C6.20914 0 8 1.79086 8 4Z",
+  },
+  dots: {
+    viewBox: "0 0 24 24",
+    d: "M16 20C16 17.7909 17.7909 16 20 16C22.2091 16 24 17.7909 24 20C24 22.2091 22.2091 24 20 24C17.7909 24 16 22.2091 16 20Z M8 12C8 9.79086 9.79086 8 12 8C14.2091 8 16 9.79086 16 12C16 14.2091 14.2091 16 12 16C9.79086 16 8 14.2091 8 12Z M16 4C16 1.79086 17.7909 0 20 0C22.2091 0 24 1.79086 24 4C24 6.20914 22.2091 8 20 8C17.7909 8 16 6.20914 16 4Z M8 20C8 17.7909 9.79086 16 12 16C14.2091 16 16 17.7909 16 20C16 22.2091 14.2091 24 12 24C9.79086 24 8 22.2091 8 20Z M0 4C0 1.79086 1.79086 0 4 0C6.20914 0 8 1.79086 8 4C8 6.20914 6.20914 8 4 8C1.79086 8 0 6.20914 0 4Z M0 12C0 9.79086 1.79086 8 4 8C6.20914 8 8 9.79086 8 12C8 14.2091 6.20914 16 4 16C1.79086 16 0 14.2091 0 12Z M0 20C0 17.7909 1.79086 16 4 16C6.20914 16 8 17.7909 8 20C8 22.2091 6.20914 24 4 24C1.79086 24 0 22.2091 0 20Z",
+  },
+  "dots-rounded": {
+    viewBox: "0 0 24 24",
+    d: "M16 4C16 1.79086 17.7908 0 20 0C22.2091 0 24 1.79086 24 4C24 6.20914 22.2091 8 20 8C17.7908 8 16 6.20914 16 4Z M3.99976 24.0001C1.79062 24.0001 -0.000244141 22.2092 -0.000244141 20.0001L-1.35708e-05 12L-0.000244141 4.00007C-0.000244141 1.79093 1.79062 7.00951e-05 3.99976 7.00951e-05C6.20889 7.00951e-05 7.99976 1.79093 7.99976 4.00007L7.99999 8H12C14.2091 8 16 9.79086 16 12L15.9998 16.0001H19.9998C22.2089 16.0001 23.9998 17.7909 23.9998 20.0001C23.9998 22.2092 22.2089 24.0001 19.9998 24.0001L12 24L3.99976 24.0001Z",
+  },
+  "dots-square": {
+    viewBox: "0 0 24 24",
+    d: "M16 0H24V8H16V0Z M24 24V16H16V8L8 8V0H0V8V24H16H24Z",
+  },
+};
+export const QRShapes = {
+  // Inner Eye
+  INNER_EYE_CLASSY: "inner-eye-classy",
+  INNER_EYE_DOT: "inner-eye-dot",
+  INNER_EYE_DOTS: "inner-eye-dots",
+  INNER_EYE_EXTRA_CLASSY: "inner-eye-extra-classy",
+  INNER_EYE_EXTRA_ROUNDED: "inner-eye-extra-rounded",
+  INNER_EYE_ROUNDED: "inner-eye-rounded",
+  INNER_EYE_SQUARE: "inner-eye-square",
+  // Outer Eye
+  OUTER_EYE_CLASSY: "outer-eye-classy",
+  OUTER_EYE_DOT: "outer-eye-dot",
+  OUTER_EYE_DOTS: "outer-eye-dots",
+  OUTER_EYE_EXTRA_CLASSY: "outer-eye-extra-classy",
+  OUTER_EYE_EXTRA_ROUNDED: "outer-eye-extra-rounded",
+  OUTER_EYE_ROUNDED: "outer-eye-rounded",
+  OUTER_EYE_SQUARE: "outer-eye-square",
+  // Dots
+  DOTS_CLASSY: "dots-classy",
+  DOTS_CLASSY_ROUNDED: "dots-classy-rounded",
+  DOTS_EXTRA_ROUNDED: "dots-extra-rounded",
+  DOTS: "dots",
+  DOTS_ROUNDED: "dots-rounded",
+  DOTS_SQUARE: "dots-square",
+  // Custom
+  CUSTOM_ICON: "custom-icon",
+} as const;

package/src/types.ts ADDED Viewed

@@ -0,0 +1,104 @@
+import { QRShapes, shapes } from "./renderer/shapes";
+export type QRErrorCorrectionLevel = "L" | "M" | "Q" | "H";
+export type ModuleType =
+  | "data"
+  | "pos-finder"
+  | "pos-separator"
+  | "alignment"
+  | "timing"
+  | "dark-module"
+  | "version";
+export interface QRCell {
+  x: number;
+  y: number;
+  isDark: boolean;
+  type: ModuleType;
+}
+export type QRMatrix = QRCell[][];
+export type TypeNumber = number;
+// Allowed shapes + custom-icon support
+export type QRShapesType = keyof typeof shapes | "custom-icon";
+// QR Generation specific types (mapped to Nayuki's library later)
+export type ErrorCorrectionLevel = "L" | "M" | "Q" | "H";
+export type Mode = "Numeric" | "Alphanumeric" | "Byte" | "Kanji";
+export type Gradient = {
+  type: "linear" | "radial";
+  rotation?: number; // у градусах, для linear
+  colorStops: {
+    offset: string; // "0%", "100%"
+    color: string;
+  }[];
+};
+// Logo/Image configuration
+export type QrImage = {
+  source: string; // url or base64
+  width: number; // size in modules (e.g., 0.5 or 1 or 5)
+  height: number;
+  x?: number; // Position in modules. If omitted, calculated automatically (center)
+  y?: number;
+  excludeDots?: boolean; // If true, we won't draw QR dots under this image
+  opacity?: number; // 0.0 – 1.0 (default 1)
+  preserveAspectRatio?: string; // SVG preserveAspectRatio attr (default "xMidYMid meet")
+};
+export type QrPart = {
+  type?: QRShapesType;
+  color?: string;
+  gradient?: Gradient;
+  customPath?: string;
+  customViewBox?: string;
+  scale?: number; // 0.1 ... 1.0 (Density)
+  isSingle?: boolean; // Тільки для innerEye/cornersDot: малювати один великий елемент замість 3х3
+};
+// Frame: decorative image that wraps the QR code
+export type QrFrame = {
+  source: string; // URL or base64 of the frame image
+  width: number; // Total frame width in output pixels
+  height: number; // Total frame height in output pixels
+  // Where the QR sits inside the frame (in output pixels).
+  // If omitted entirely, QR is centered with 10% margin on each side.
+  // If only width/height are given (no x/y), QR is auto-centered.
+  inset?: {
+    x?: number; // Left edge of QR area (auto-centered if omitted)
+    y?: number; // Top edge of QR area (auto-centered if omitted)
+    width: number; // Width of QR area inside frame
+    height: number; // Height of QR area inside frame
+  };
+};
+// The Main Config
+export interface Options {
+  data: string;
+  width?: number; // Output width in pixels (e.g. 1000)
+  height?: number; // Output height in pixels
+  margin?: number; // Padding in modules (default 4)
+  borderRadius?: number; // Corner radius in pixels for the entire QR code
+  backgroundOptions?: {
+    color?: string;
+    gradient?: Gradient;
+    image?: string; // URL for background image
+  };
+  images?: QrImage[]; // Logos (Array)
+  frame?: QrFrame; // Decorative frame around the QR code
+  qrOptions?: {
+    typeNumber?: TypeNumber;
+    mode?: Mode;
+    errorCorrectionLevel?: ErrorCorrectionLevel;
+  };
+  // Granular styling
+  dotsOptions?: QrPart; // The main data
+  cornersDotOptions?: QrPart; // Inner Eye (Ball)
+  cornersSquareOptions?: QrPart; // Outer Eye (Frame)
+}

package/test/readability.test.ts ADDED Viewed

@@ -0,0 +1,71 @@
+import { describe, it, expect } from "vitest";
+import { QRCodeGenerate } from "../src/index";
+import sharp from "sharp";
+import jsQR from "jsqr";
+// Helper: Scans SVG string
+async function scanSVG(svgString: string) {
+  // 1. Convert SVG to "raw" pixel buffer (Raw RGBA)
+  const { data, info } = await sharp(Buffer.from(svgString))
+    .ensureAlpha() // Ensure there's an alpha channel
+    .raw() // Get byte array [R, G, B, A, R, G, B, A...]
+    .toBuffer({ resolveWithObject: true });
+  // 2. Use jsQR library for reading
+  const code = jsQR(new Uint8ClampedArray(data), info.width, info.height);
+  return code ? code.data : null;
+}
+describe("QR Reliability Test", () => {
+  it("should be readable with hearts shape", async () => {
+    const text = "https://github.com/my-lib";
+    const svg = QRCodeGenerate({
+      text: text,
+      shape: "heart", // Testing our hearts
+      color: "#000000",
+      bgColor: "#FFFFFF",
+      padding: 4,
+    });
+    const scannedText = await scanSVG(svg);
+    // Check: does what we scanned equal what we wrote
+    expect(scannedText).toBe(text);
+  });
+  it("should be readable with custom W icon and High Error Correction", async () => {
+    const text = "https://wiki.org";
+    const path1 =
+      "M15.029 34.623c.521.266.399 1.034-.178 1.143a12.592 12.592 0 0 1-6.551-.472C3.466 33.608 0 29.065 0 23.719V13.291c0-1.482 1.012-2.783 2.466-3.17l5.055-1.336a.623.623 0 0 1 .785.592v14.335c0 4.742 2.73 8.86 6.729 10.905l-.006.006ZM24.905 35.295a12.52 12.52 0 0 0 4.153-2.431c2.546-2.244 4.147-5.516 4.147-9.152V4.521c0-1.488 1.012-2.782 2.466-3.17l5.054-1.33a.623.623 0 0 1 .786.593v23.104c0 5.347-3.466 9.89-8.3 11.577-1.3.454-2.693.702-4.153.702-1.46 0-2.852-.248-4.147-.696l-.006-.006Z"; // ...shortened
+    const path2 =
+      "M24.906 35.295a12.548 12.548 0 0 1-4.153-2.425c-2.545-2.244-4.152-5.517-4.152-9.152V8.906c0-1.482 1.012-2.782 2.466-3.17L24.12 4.4a.623.623 0 0 1 .785.592v18.72c0 3.635 1.608 6.901 4.153 9.152a12.564 12.564 0 0 1-4.153 2.431Z"; // ...shortened
+    const fullWLogo = path1 + " " + path2; // Just concatenating
+    const svg = QRCodeGenerate({
+      text: text,
+      shape: "custom-icon",
+      color: "#000000",
+      bgColor: "#FFFFFF",
+      padding: 2,
+      customIconPath: fullWLogo,
+      customIconViewBox: "0 0 41 36",
+    });
+    const scannedText = await scanSVG(svg);
+    expect(scannedText).toBe(text);
+  });
+  it("fails on low contrast", async () => {
+    const svg = QRCodeGenerate({
+      text: "fail",
+      color: "#FFFFFF", // White on white
+      bgColor: "#FFFFFF",
+    });
+    const scannedText = await scanSVG(svg);
+    expect(scannedText).toBeNull(); // Should not be readable
+  });
+});

package/test.js ADDED Viewed

@@ -0,0 +1,160 @@
+import { QRCodeGenerate } from "./dist/index.js";
+import fs from "fs";
+import path from "path";
+function fileToDataURI(relativePath) {
+  const absolutePath = path.resolve(relativePath);
+  const ext = path.extname(absolutePath).slice(1).toLowerCase();
+  const mimeMap = {
+    png: "image/png",
+    jpg: "image/jpeg",
+    jpeg: "image/jpeg",
+    gif: "image/gif",
+    svg: "image/svg+xml",
+    webp: "image/webp",
+  };
+  const mime = mimeMap[ext] || "application/octet-stream";
+  const data = fs.readFileSync(absolutePath).toString("base64");
+  return `data:${mime};base64,${data}`;
+}
+const placeholderImg = fileToDataURI("assets/placeholder.png");
+const frameImg = fileToDataURI("assets/frames/frame.png");
+const bg1Img = fileToDataURI("assets/bg/bg1.jpg");
+const path1 =
+  "M15.029 34.623c.521.266.399 1.034-.178 1.143a12.592 12.592 0 0 1-6.551-.472C3.466 33.608 0 29.065 0 23.719V13.291c0-1.482 1.012-2.783 2.466-3.17l5.055-1.336a.623.623 0 0 1 .785.592v14.335c0 4.742 2.73 8.86 6.729 10.905l-.006.006ZM24.905 35.295a12.52 12.52 0 0 0 4.153-2.431c2.546-2.244 4.147-5.516 4.147-9.152V4.521c0-1.488 1.012-2.782 2.466-3.17l5.054-1.33a.623.623 0 0 1 .786.593v23.104c0 5.347-3.466 9.89-8.3 11.577-1.3.454-2.693.702-4.153.702-1.46 0-2.852-.248-4.147-.696l-.006-.006Z"; // ...shortened
+const path2 =
+  "M24.906 35.295a12.548 12.548 0 0 1-4.153-2.425c-2.545-2.244-4.152-5.517-4.152-9.152V8.906c0-1.482 1.012-2.782 2.466-3.17L24.12 4.4a.623.623 0 0 1 .785.592v18.72c0 3.635 1.608 6.901 4.153 9.152a12.564 12.564 0 0 1-4.153 2.431Z"; // ...shortened
+const fullWLogo = path1 + " " + path2; // Just concatenating
+(async () => {
+  const {
+    svg: svgWithFrame,
+    matrixSize,
+    eyeZones,
+    getMaxPos,
+  } = await QRCodeGenerate({
+    data: "https://wiki.org",
+    // margin: 1,
+    // width: 500,
+    // height: 500,
+    // borderRadius: 10,
+    // frame: {
+    //   source: frameImg,
+    //   width: 1000,
+    //   height: 1000,
+    //   inset: { width: 500, height: 500 },
+    // },
+    // // --- Background ---
+    // background: {
+    //   // Dark background so white dots are visible
+    //   color: "#1a1a2e",
+    //   // Uncomment to use a full-bleed background image instead:
+    //   image: bg1Img,
+    //   // gradient: {
+    //   //   type: "linear",
+    //   //   rotation: 90,
+    //   //   colorStops: [
+    //   //     { offset: "0%", color: "#021ffa" },
+    //   //     { offset: "100%", color: "#ed0909" },
+    //   //   ],
+    //   // },
+    // },
+    // // --- Images overlaid INSIDE the QR code (logos, icons, etc.) ---
+    // // Multiple images are supported. Use excludeDots:true to clear dots underneath.
+    // // Coordinates are in QR modules (same unit as the matrix grid).
+    // images: [
+    //   {
+    //     // Center logo — inline SVG data URI (works without network)
+    //     // A simple WiFi icon as SVG data URI
+    //     source:
+    //       "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Ccircle cx='12' cy='12' r='12' fill='%2316213e'/%3E%3Cpath d='M12 15.5a1.5 1.5 0 1 1 0 3 1.5 1.5 0 0 1 0-3zm0-4a5.5 5.5 0 0 1 4.95 3.07l-1.6 1.6A3.5 3.5 0 0 0 12 14a3.5 3.5 0 0 0-3.35 2.17l-1.6-1.6A5.5 5.5 0 0 1 12 11.5zm0-4a9.5 9.5 0 0 1 8.49 5.24l-1.6 1.6A7.5 7.5 0 0 0 12 10a7.5 7.5 0 0 0-6.89 4.34l-1.6-1.6A9.5 9.5 0 0 1 12 7.5z' fill='%2300d4ff'/%3E%3C/svg%3E",
+    //     width: 5,
+    //     height: 5,
+    //     excludeDots: true,
+    //   },
+    //   // Second image — also inline SVG (a small star badge)
+    //   {
+    //     source:
+    //       "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Ccircle cx='12' cy='12' r='12' fill='%23edf505'/%3E%3Cpolygon points='12,4 14.5,9.5 21,10.3 16.5,14.6 17.8,21 12,17.8 6.2,21 7.5,14.6 3,10.3 9.5,9.5' fill='%231a1a2e'/%3E%3C/svg%3E",
+    //     width: 3,
+    //     height: 3,
+    //     excludeDots: true,
+    //   },
+    //   {
+    //     source:
+    //       "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Ccircle cx='12' cy='12' r='12' fill='%23edf505'/%3E%3Cpolygon points='12,4 14.5,9.5 21,10.3 16.5,14.6 17.8,21 12,17.8 6.2,21 7.5,14.6 3,10.3 9.5,9.5' fill='%231a1a2e'/%3E%3C/svg%3E",
+    //     width: 3,
+    //     height: 3,
+    //     excludeDots: true,
+    //   },
+    //   {
+    //     source:
+    //       "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Ccircle cx='12' cy='12' r='12' fill='%23edf505'/%3E%3Cpolygon points='12,4 14.5,9.5 21,10.3 16.5,14.6 17.8,21 12,17.8 6.2,21 7.5,14.6 3,10.3 9.5,9.5' fill='%231a1a2e'/%3E%3C/svg%3E",
+    //     width: 3,
+    //     height: 3,
+    //     excludeDots: true,
+    //   },
+    //   {
+    //     // Center logo — inline SVG data URI (works without network)
+    //     // A simple WiFi icon as SVG data URI
+    //     source:
+    //       "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Ccircle cx='12' cy='12' r='12' fill='%2316213e'/%3E%3Cpath d='M12 15.5a1.5 1.5 0 1 1 0 3 1.5 1.5 0 0 1 0-3zm0-4a5.5 5.5 0 0 1 4.95 3.07l-1.6 1.6A3.5 3.5 0 0 0 12 14a3.5 3.5 0 0 0-3.35 2.17l-1.6-1.6A5.5 5.5 0 0 1 12 11.5zm0-4a9.5 9.5 0 0 1 8.49 5.24l-1.6 1.6A7.5 7.5 0 0 0 12 10a7.5 7.5 0 0 0-6.89 4.34l-1.6-1.6A9.5 9.5 0 0 1 12 7.5z' fill='%2300d4ff'/%3E%3C/svg%3E",
+    //     width: 5,
+    //     height: 5,
+    //     x: 18,
+    //     y: 20,
+    //     excludeDots: true,
+    //   },
+    // ],
+    // // 1. DOTS — use a simple square shape with visible color
+    // dotsOptions: {
+    //   // shape: "square",
+    //   color: "#e0e0e0",
+    //   scale: 0.85,
+    //   // To use custom-icon shape, uncomment below and comment out shape/color above:
+    //   shape: "qr-duck",
+    //   // color: "white",
+    // },
+    // // 2. CORNER SQUARE (outer eye frame)
+    // cornersSquareOptions: {
+    //   shape: "qr-duck",
+    //   color: "black",
+    //   gradient: {
+    //     type: "linear",
+    //     rotation: 180,
+    //     colorStops: [
+    //       { offset: "0%", color: "#EEAECA" },
+    //       { offset: "100%", color: "#00D4FF" },
+    //     ],
+    //   },
+    // },
+    // // 3. CORNER DOT (inner eye ball)
+    // cornersDotOptions: {
+    //   shape: "",
+    //   // customIconPath: fullWLogo,
+    //   // customIconViewBox: "0 0 41 36",
+    //   gradient: {
+    //     type: "linear",
+    //     rotation: 90,
+    //     colorStops: [
+    //       { offset: "0%", color: "#edf505" },
+    //       { offset: "100%", color: "#1aebd9" },
+    //     ],
+    //   },
+    //   isSingle: true,
+    //   scale: 1.2,
+    // },
+  });
+  fs.writeFileSync("output-frame.svg", svgWithFrame);
+  console.log(
+    `Frame demo written to output-frame.svg (matrixSize: ${matrixSize})`,
+  );
+  console.log("Eye zones:", JSON.stringify(eyeZones));
+  console.log("Max pos for 5x5 image:", getMaxPos(5, 5));
+})();

package/tsconfig.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "declaration": true,
+    "sourceMap": true,
+    "strict": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/*.test.ts"]
+}

package/tsup.config.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup";
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["cjs", "esm"],
+  dts: true,
+  clean: true,
+  minify: true,
+  external: ["sharp"],
+});