qreator 9.0.6

package/src/tests/test.ts

@@ -0,0 +1,250 @@
+import test from "ava";
+import { readFile, writeFile } from "node:fs/promises";
+
+import { getPNG } from "../png.js";
+import { getSVG } from "../svg.js";
+import { getPDF } from "../pdf.js";
+import type { ImageOptions } from "../typing/types.js";
+import { assertEqual, generatedImageDir, goldenDir } from "./_common.js";
+
+const text = "I \u2764\uFE0F QR code!";
+// const text = 'https://yadi.sk/d/FuzPeEg-QyaZN?qr';
+
+const defaultParams = {
+    ec_level: "Q" as const,
+    margin: 1,
+    parse_url: true,
+};
+
+interface TestParams {
+    name: string;
+    fn: typeof getPNG | typeof getPDF | typeof getSVG;
+    filename: string;
+    params: ImageOptions;
+}
+
+([
+    {
+        name: "PNG",
+        fn: getPNG,
+        filename: "qr.png",
+    },
+    {
+        name: "PNG with empty options",
+        fn: getPNG,
+        filename: "qr_with_empty_options.png",
+        options: {},
+    },
+    {
+        name: "PNG with undefined size",
+        fn: getPNG,
+        filename: "qr_with_undefined_size.png",
+        options: {
+            size: undefined,
+        },
+    },
+    {
+        name: "PNG with size",
+        fn: getPNG,
+        filename: "qr_with_size.png",
+        params: {
+            size: 9,
+        }
+    },
+    {
+        name: "PNG with margin",
+        fn: getPNG,
+        filename: "qr_with_margin.png",
+        params: {
+            size: 9,
+            margin: 3,
+        }
+    },
+    {
+        name: "PNG with border radius",
+        fn: getPNG,
+        filename: "qr_with_border_radius.png",
+        params: {
+            borderRadius: 1,
+        },
+    },
+    {
+        name: "PNG with colors",
+        fn: getPNG,
+        filename: "qr_with_colors.png",
+        params: {
+            color: 0x0000a0ff,
+            bgColor: 0xffa0ffff,
+        },
+    },
+    {
+        name: "PNG with colors (hex)",
+        fn: getPNG,
+        filename: "qr_with_colors.png",
+        params: {
+            color: '#0000a0',
+            bgColor: '#ffa0ff',
+        },
+    },
+    {
+        name: "PNG with colors (rgba)",
+        fn: getPNG,
+        filename: "qr_with_colors_rgba.png",
+        params: {
+            color: 'rgba(255, 0, 0, 0.5)',
+            bgColor: 'rgba(255, 255, 255, 0.1)',
+        },
+    },
+    {
+        name: "PNG with logo",
+        fn: getPNG,
+        filename: "qr_with_logo.png",
+        params: { logo: await readFile(`${goldenDir}/logo.png`) },
+    },
+    {
+        name: "PNG with logo (JPG)",
+        fn: getPNG,
+        filename: "qr_with_logo_jpg.png",
+        params: { logo: await readFile(`${goldenDir}/logo.jpg`) },
+    },
+    {
+        name: "PNG with logo (arraybuffer)",
+        fn: getPNG,
+        filename: "qr_with_logo.png",
+        params: { logo: (await readFile(`${goldenDir}/logo.png`)).buffer },
+    },
+    {
+        name: "SVG",
+        fn: getSVG,
+        filename: "qr.svg",
+    },
+    {
+        name: "SVG with border radius",
+        fn: getSVG,
+        filename: "qr_with_border_radius.svg",
+        params: {
+            borderRadius: 4,
+        },
+    },
+    {
+        name: "SVG with EC level",
+        fn: getSVG,
+        filename: "qr_with_ec_level.svg",
+        params: {
+            ec_level: "H",
+        },
+    },
+    {
+        name: "SVG with size",
+        fn: getSVG,
+        filename: "qr_with_size.svg",
+        params: {
+            size: 6,
+        },
+    },
+    {
+        name: "SVG with colors (hex)",
+        fn: getSVG,
+        filename: "qr_with_colors_hex.svg",
+        params: {
+            color: '#ff0000',
+            bgColor: '#00ff00',
+        },
+    },
+    {
+        name: "SVG with colors (rgba)",
+        fn: getSVG,
+        filename: "qr_with_colors_rgba.svg",
+        params: {
+            color: 'rgba(255, 0, 0, 0.5)',
+            bgColor: 'rgba(0, 255, 0, 0.2)',
+        },
+    },
+    {
+        name: "SVG with colors",
+        fn: getSVG,
+        filename: "qr_with_colors.svg",
+        params: {
+            color: 0xff0000ff,
+            bgColor: 0x00ff00ff,
+        },
+    },
+    {
+        name: "SVG with logo as buffer",
+        fn: getSVG,
+        filename: "qr_with_logo.svg",
+        params: { logo: await readFile(`${goldenDir}/logo.png`) },
+    },
+    {
+        name: "SVG with logo as arraybuffer (PNG)",
+        fn: getSVG,
+        filename: "qr_with_logo_as_arraybuffer.svg",
+        params: {
+            logo: (await readFile(`${goldenDir}/logo.png`)).buffer,
+        },
+    },
+    {
+        name: "SVG with logo as arraybuffer (JPG)",
+        fn: getSVG,
+        filename: "qr_with_logo_as_arraybuffer_jpg.svg",
+        params: {
+            logo: (await readFile(`${goldenDir}/logo.jpg`)).buffer,
+        },
+    },
+    {
+        name: "PDF",
+        fn: getPDF,
+        filename: "qr.pdf",
+    },
+    {
+        name: "PDF with border radius",
+        fn: getPDF,
+        filename: "qr_with_border_radius.pdf",
+        params: {
+            borderRadius: 4,
+        }
+    },
+    {
+        name: "PDF with colors",
+        fn: getPDF,
+        filename: "qr_with_colors.pdf",
+        params: { color: 0xff0000ff, bgColor: 0x00ff00ff },
+    },
+    {
+        name: "PDF with colors (hex)",
+        fn: getPDF,
+        filename: "qr_with_colors.pdf",
+        params: { color: '#ff0000', bgColor: '#00ff00' },
+    },
+    {
+        name: "PDF with arraybuffer",
+        fn: getPDF,
+        filename: "qr_logo_arraybuffer.pdf",
+        params: {
+            logo: (await readFile(`${goldenDir}/logo.png`)).buffer,
+        },
+    },
+    {
+        name: "PDF with arraybuffer (JPG)",
+        fn: getPDF,
+        filename: "qr_logo_arraybuffer_jpg.pdf",
+        params: {
+            logo: (await readFile(`${goldenDir}/logo.jpg`)).buffer,
+        },
+    },
+    {
+        name: "PDF with logo",
+        fn: getPDF,
+        filename: "qr_with_logo.pdf",
+        params: { logo: await readFile(`${goldenDir}/logo.png`) },
+    },
+] as TestParams[]).forEach((testData) => {
+    test.serial(testData.name, async (t) => {
+        const image = await testData.fn(text, {
+            ...defaultParams,
+            ...testData.params,
+        });
+        await writeFile(`${generatedImageDir}/${testData.filename}`, image);
+        await assertEqual(t, testData.filename);
+    });
+});

package/src/typing/index.d.ts

@@ -0,0 +1,5 @@
+declare module NodeJS {
+    interface Process {
+        browser?: string;
+    }
+}

package/src/typing/types.ts

@@ -0,0 +1,99 @@
+export type Matrix = number[][];
+
+export interface Data {
+    blocks: number[][];
+    ec: number[][];
+    ec_len: number;
+    ec_level: EcLevel;
+    version: number;
+    data_len: number;
+}
+
+export interface NumberData {
+    [key: string]: number[];
+}
+
+/**
+ * Error correction level, one of 'L', 'M', 'Q', 'H'.
+ * @default 'M'
+ */
+export type EcLevel = "L" | "M" | "Q" | "H";
+
+/**
+ * Output type, one of 'png', 'svg', 'pdf'.
+ * @default 'png'
+ */
+export type ImageType = "png" | "svg" | "pdf";
+
+/**
+ * Image options.
+ */
+export interface ImageOptions {
+    /**
+     * Error correction level, one of 'L', 'M', 'Q', 'H'.
+     * @default 'M'
+     */
+    ec_level?: EcLevel;
+
+    /**
+     * Output type, one of 'png', 'svg', 'pdf'.
+     * Documentation is wrong though, it's `undefined`!
+     * @default 'png'
+     */
+    type?: ImageType;
+
+    /**
+     * (PNG and SVG only) Module size in pixels.
+     * @default 5 //for PNG
+     * @default 0 //for others
+     */
+    size?: number;
+
+    /**
+     * Margin of the resulting image in modules.
+     * @default 4 //for PNG
+     * @default 1 //for others
+     */
+    margin?: number;
+
+    /**
+     * (EXPERIMENTAL) Try to optimize QR code for URLs.
+     * @default false
+     */
+    parse_url?: boolean;
+
+    /**
+     * Buffer with PNG image to draw on top of QR code.
+     * @default undefined
+     */
+    logo?: ArrayBufferLike | Buffer;
+
+    /**
+     * Width of the overlay logo in percent.
+     * @default 20
+     */
+    logoWidth?: number;
+
+    /**
+     * Height of the overlay logo in percent.
+     * @default 20
+     */
+    logoHeight?: number;
+
+    /**
+     * Foreground color in RGBA format.
+     * @default 0x000000FF
+     */
+    color?: number | string;
+
+    /**
+     * Background color in RGBA format.
+     * @default 0xFFFFFFFF
+     */
+    bgColor?: number | string;
+
+    /**
+     * border radius of the points
+     */
+    borderRadius?: number;
+}

package/src/utils.ts

@@ -0,0 +1,86 @@
+import colorString from "color-string";
+import { ImageOptions, ImageType, Matrix } from "./typing/types";
+
+export function getOptions(inOptions: ImageOptions) {
+    const type: ImageType = inOptions?.type ?? "png";
+    const defaults = type === "png" ? BITMAP_OPTIONS : VECTOR_OPTIONS;
+    return { ...defaults, ...inOptions };
+}
+
+export function colorToHex(color: number | string): string {
+    if (typeof color === "string") {
+        return colorString.to.hex(colorString.get.rgb(color));
+    }
+    return `#${(color >>> 8).toString(16).padStart(6, "0")}`;
+}
+
+export function getSVGPath(matrix: Matrix, size: number, margin: number = 0, borderRadius: number = 0) {
+    let rectangles = [];
+    for (let x = 0; x < matrix.length; x++) {
+        const column = matrix[x];
+        for (let y = 0; y < column.length; y++) {
+            if (column[y]) {
+                const leftX = x * size + margin;
+                const rightX = (x + 1) * size + margin;
+                const topY = y * size + margin;
+                const bottomY = (y + 1) * size + margin;
+                const rectangle = [];
+                rectangle.push(`M ${leftX} ${topY + borderRadius}`)
+                rectangle.push(`L ${leftX} ${bottomY - borderRadius}`)
+                if (borderRadius > 0) {
+                    rectangle.push(`A ${borderRadius} ${borderRadius} 0 0 0 ${leftX + borderRadius} ${bottomY} `)
+                }
+                rectangle.push(`L ${rightX - borderRadius} ${bottomY}`)
+                if (borderRadius > 0) {
+                    rectangle.push(`A ${borderRadius} ${borderRadius} 0 0 0 ${rightX} ${bottomY - borderRadius}`)
+                }
+                rectangle.push(`L ${rightX} ${topY + borderRadius}`)
+                if (borderRadius > 0) {
+                    rectangle.push(`A ${borderRadius} ${borderRadius} 0 0 0 ${rightX - borderRadius} ${topY}`)
+                }
+                rectangle.push(`L ${leftX + borderRadius} ${topY}`)
+                if (borderRadius > 0) {
+                    rectangle.push(`A ${borderRadius} ${borderRadius} 0 0 0 ${leftX} ${topY + borderRadius}`)
+                }
+                rectangle.push(`z`)
+                rectangles.push(rectangle.join(" "));
+            }
+        }
+    }
+    return rectangles.join(" ");
+}
+
+
+
+const commonOptions: Pick<
+    ImageOptions,
+    | "type"
+    | "parse_url"
+    | "ec_level"
+    | "logo"
+    | "logoWidth"
+    | "logoHeight"
+    | "bgColor"
+    | "color"
+> = {
+    type: "png",
+    parse_url: false,
+    ec_level: "M",
+    logo: undefined,
+    logoWidth: 20,
+    logoHeight: 20,
+    bgColor: 0xffffffff,
+    color: 0x000000ff,
+};
+
+const BITMAP_OPTIONS: ImageOptions = {
+    ...commonOptions,
+    margin: 1,
+    size: 5,
+};
+
+const VECTOR_OPTIONS: ImageOptions = {
+    ...commonOptions,
+    margin: 1,
+    size: 0,
+};