@liquid-js/qr-code-styling 3.0.0-2 → 3.0.0-4

package/lib/tools/{browserImageTools.d.ts → browser-image-tools.d.ts}

@@ -1,8 +1,7 @@
 /// <reference types="node" />
-import { Options } from "../types/index.js";
 export declare const browserImageTools: {
     toDataURL(url: string | Buffer | Blob): Promise<string>;
-    getSize(options: Options): Promise<{
+    getSize(src: string | Blob | Buffer, crossOrigin?: string): Promise<{
         width: number;
         height: number;
     }>;

package/lib/tools/browser-utils.d.ts

@@ -0,0 +1,18 @@
+import { QRCodeStyling } from "../core/qr-code-styling.js";
+import { RecursivePartial } from "../types/helper.js";
+import { CanvasOptions } from "../utils/canvas-options.js";
+export declare enum FileExtension {
+    svg = "svg",
+    png = "png",
+    jpeg = "jpeg",
+    webp = "webp"
+}
+export declare function drawToCanvas(qrCode: QRCodeStyling, options?: RecursivePartial<CanvasOptions>): {
+    canvas: HTMLCanvasElement;
+    canvasDrawingPromise: Promise<void> | undefined;
+} | undefined;
+export declare function download(qrCode: QRCodeStyling, downloadOptions: `${FileExtension}` | {
+    name?: string;
+    extension: `${FileExtension}`;
+}, options?: RecursivePartial<CanvasOptions>): Promise<void>;
+export declare function downloadURI(uri: string, name: string): void;

package/lib/types/helper.d.ts

@@ -0,0 +1,23 @@
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object | undefined ? RecursivePartial<T[P]> : T[P];
+};
+export type DrawArgs = {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+    getNeighbor?: (x: number, y: number) => boolean;
+};
+export type BasicFigureDrawArgs = {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+};
+export type RotateFigureArgs = {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+    draw: () => void;
+};

package/lib/types/qrcode.d.ts

@@ -0,0 +1,64 @@
+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: {
+    0: 0;
+    1: 1;
+    2: 2;
+    3: 3;
+    4: 4;
+    5: 5;
+    6: 6;
+    7: 7;
+    8: 8;
+    9: 9;
+    10: 10;
+    11: 11;
+    12: 12;
+    13: 13;
+    14: 14;
+    15: 15;
+    16: 16;
+    17: 17;
+    18: 18;
+    19: 19;
+    20: 20;
+    21: 21;
+    22: 22;
+    23: 23;
+    24: 24;
+    25: 25;
+    26: 26;
+    27: 27;
+    28: 28;
+    29: 29;
+    30: 30;
+    31: 31;
+    32: 32;
+    33: 33;
+    34: 34;
+    35: 35;
+    36: 36;
+    37: 37;
+    38: 38;
+    39: 39;
+    40: 40;
+};
+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;
+}

package/lib/utils/canvas-options.d.ts

@@ -0,0 +1,7 @@
+export interface CanvasOptions {
+    width: number;
+    height: number;
+    margin: number;
+}
+export declare const defaultCanvasOptions: CanvasOptions;
+export declare function sanitizeCanvasOptions(options: CanvasOptions): CanvasOptions;

package/lib/utils/gradient.d.ts

@@ -0,0 +1,26 @@
+export declare enum GradientType {
+    radial = "radial",
+    linear = "linear"
+}
+export type Gradient = {
+    /**
+     * Type of gradient spread
+     *
+     * @default GradientType.linear
+     */
+    type: `${GradientType}`;
+    /**
+     * Rotation of gradient (in radians, Math.PI === 180 degrees)
+     *
+     * @default 0
+     */
+    rotation?: number;
+    /** Gradient colors. */
+    colorStops: {
+        /** Position of color in gradient range */
+        offset: number;
+        /** Color of stop in gradient range */
+        color: string;
+    }[];
+};
+export declare function sanitizeGradient(gradient: Gradient): Gradient;

package/lib/{tools → utils}/merge.d.ts

@@ -1,2 +1,4 @@
-import { UnknownObject } from "../types/index.js";
+export type UnknownObject = {
+    [key: string]: any;
+} | undefined;
 export declare function mergeDeep(target: UnknownObject, ...sources: UnknownObject[]): UnknownObject;

package/lib/{types/index.d.ts → utils/options.d.ts}

@@ -1,14 +1,13 @@
 /// <reference types="node" />
-import { browserImageTools } from "../tools/browserImageTools.js";
-export interface UnknownObject {
-    [key: string]: any;
-}
+import { browserImageTools } from "../tools/browser-image-tools.js";
+import { ErrorCorrectionLevel, TypeNumber } from "../types/qrcode.js";
+import { Gradient } from "./gradient.js";
 export declare enum DotType {
-    dots = "dots",
-    randomDots = "random-dots",
+    dot = "dot",
+    randomDot = "random-dot",
     rounded = "rounded",
-    verticalLines = "vertical-lines",
-    horizontalLines = "horizontal-lines",
+    verticalLine = "vertical-line",
+    horizontalLine = "horizontal-line",
     classy = "classy",
     classyRounded = "classy-rounded",
     square = "square",
@@ -33,110 +32,21 @@ export declare enum CornerSquareType {
     outpoint = "outpoint",
     inpoint = "inpoint"
 }
-export declare enum GradientType {
-    radial = "radial",
-    linear = "linear"
-}
 export declare enum ShapeType {
     square = "square",
     circle = "circle"
 }
-export type Gradient = {
-    /**
-     * Type of gradient spread
-     *
-     * @default GradientType.linear
-     */
-    type: GradientType;
-    /**
-     * Rotation of gradient (in radians, Math.PI === 180 degrees)
-     *
-     * @default 0
-     */
-    rotation?: number;
-    /** Gradient colors. */
-    colorStops: {
-        /** Position of color in gradient range */
-        offset: number;
-        /** Color of stop in gradient range */
-        color: string;
-    }[];
-};
-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: {
-    0: 0;
-    1: 1;
-    2: 2;
-    3: 3;
-    4: 4;
-    5: 5;
-    6: 6;
-    7: 7;
-    8: 8;
-    9: 9;
-    10: 10;
-    11: 11;
-    12: 12;
-    13: 13;
-    14: 14;
-    15: 15;
-    16: 16;
-    17: 17;
-    18: 18;
-    19: 19;
-    20: 20;
-    21: 21;
-    22: 22;
-    23: 23;
-    24: 24;
-    25: 25;
-    26: 26;
-    27: 27;
-    28: 28;
-    29: 29;
-    30: 30;
-    31: 31;
-    32: 32;
-    33: 33;
-    34: 34;
-    35: 35;
-    36: 36;
-    37: 37;
-    38: 38;
-    39: 39;
-    40: 40;
-};
-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;
-}
-export type Options = {
+export interface Options {
     /** Use a custom DOM domplementation */
-    document?: Document;
+    document: Document;
     /** Use a custom image fetching & serializaton implementation */
     imageTools?: typeof browserImageTools;
     /** @ignore */
-    width?: number;
+    width: number;
     /** @ignore */
-    height?: number;
+    height: number;
     /** The data will be encoded in the QR code */
-    data?: string;
+    data: string;
     /** The image will be copied to the center of the QR code */
     image?: string | Buffer | Blob;
     /**
@@ -144,51 +54,51 @@ export type Options = {
      *
      * @default ShapeType.square
      */
-    shape?: ShapeType;
+    shape: `${ShapeType}`;
     /** Options will be passed to `qrcode-generator` lib */
-    qrOptions?: {
-        typeNumber?: TypeNumber;
-        mode?: Mode;
+    qrOptions: {
+        typeNumber: TypeNumber;
+        mode?: `${Mode}`;
         /** @default ErrorCorrectionLevel.Q */
-        errorCorrectionLevel?: ErrorCorrectionLevel;
+        errorCorrectionLevel: `${ErrorCorrectionLevel}`;
     };
-    imageOptions?: {
+    imageOptions: {
         /**
          * Hide all dots covered by the image
          *
          * @default true
          */
-        hideBackgroundDots?: boolean;
+        hideBackgroundDots: boolean;
         /**
          * Coefficient of the image size
          *
          * @default 0.4
          */
-        imageSize?: number;
+        imageSize: number;
         /**
          * Margin of the image (in blocks)
          *
          * @default 0
          */
-        margin?: number;
+        margin: number;
         /**
          * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLImageElement/crossOrigin)
          */
         crossOrigin?: string;
     };
-    dotsOptions?: {
+    dotsOptions: {
         /**
          * QR dot size (in pixels)
          *
          * @default 10
          */
-        size?: number;
+        size: number;
         /**
          * Color of QR dots
          *
          * @default "#000"
          */
-        color?: string;
+        color: string;
         /** Gradient of QR dots */
         gradient?: Gradient;
         /**
@@ -196,7 +106,7 @@ export type Options = {
          *
          * @default DotType.square
          */
-        type?: DotType;
+        type: `${DotType}`;
     };
     /** Corners Square options, omitted values match dots */
     cornersSquareOptions?: {
@@ -205,7 +115,7 @@ export type Options = {
         /** Gradient of Corners Square */
         gradient?: Gradient;
         /** Style of Corners Square */
-        type?: CornerSquareType;
+        type?: `${CornerSquareType}`;
     };
     /** Corners Dot options, omitted values match squares */
     cornersDotOptions?: {
@@ -214,7 +124,7 @@ export type Options = {
         /** Gradient of Corners Dot */
         gradient?: Gradient;
         /** Style of Corners Dot */
-        type?: CornerDotType;
+        type?: `${CornerDotType}`;
     };
     /** QR background styling options, false to disable background */
     backgroundOptions?: {
@@ -235,38 +145,6 @@ export type Options = {
     stringToBytesFuncs?: {
         [encoding: string]: (s: string) => number[];
     };
-};
-export type CanvasOptions = {
-    width?: number;
-    height?: number;
-    margin?: number;
-};
-export type FilterFunction = (i: number, j: number) => boolean;
-export type DrawArgs = {
-    x: number;
-    y: number;
-    size: number;
-    rotation?: number;
-    getNeighbor?: GetNeighbor;
-};
-export type BasicFigureDrawArgs = {
-    x: number;
-    y: number;
-    size: number;
-    rotation?: number;
-};
-export type RotateFigureArgs = {
-    x: number;
-    y: number;
-    size: number;
-    rotation?: number;
-    draw: () => void;
-};
-export type GetNeighbor = (x: number, y: number) => boolean;
-export type ExtensionFunction = (svg: SVGElement, options: Options) => void;
-export declare enum FileExtension {
-    svg = "svg",
-    png = "png",
-    jpeg = "jpeg",
-    webp = "webp"
 }
+export declare const defaultOptions: Options;
+export declare function sanitizeOptions(options: Options): Options;

package/lib/{constants/errorCorrectionPercents.d.ts → utils/qrcode.d.ts}

@@ -1,6 +1,8 @@
+import { Mode } from "../types/qrcode.js";
 export declare const ErrorCorrectionPercents: {
     L: number;
     M: number;
     Q: number;
     H: number;
 };
+export declare function getMode(data: string): Mode;

package/lib/utils/svg.d.ts

@@ -0,0 +1,2 @@
+export declare function numToAttr(value: number): string;
+export declare function svgPath(strings: TemplateStringsArray, ...values: unknown[]): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liquid-js/qr-code-styling",
-  "version": "3.0.0-2",
+  "version": "3.0.0-4",
   "description": "Generate styled QR codes on web or in Node",
   "type": "module",
   "main": "./lib/qr-code-styling-node.js",

package/lib/core/QROptions.d.ts

@@ -1,32 +0,0 @@
-import { CanvasOptions, DotType, ErrorCorrectionLevel, Gradient, Mode, Options, ShapeType, TypeNumber } from "../types/index.js";
-export interface RequiredOptions extends Options {
-    document: Document;
-    shape: ShapeType;
-    width: number;
-    height: number;
-    data: string;
-    qrOptions: {
-        typeNumber: TypeNumber;
-        mode?: Mode;
-        errorCorrectionLevel: ErrorCorrectionLevel;
-    };
-    imageOptions: {
-        hideBackgroundDots: boolean;
-        imageSize: number;
-        crossOrigin?: string;
-        margin: number;
-    };
-    dotsOptions: {
-        type: DotType;
-        color: string;
-        gradient?: Gradient;
-        size: number;
-    };
-}
-export declare const defaultOptions: RequiredOptions;
-export interface RequiredCanvasOptions extends CanvasOptions {
-    width: number;
-    height: number;
-    margin: number;
-}
-export declare const defaultCanvasOptions: RequiredCanvasOptions;

package/lib/core/QRSVG.d.ts

@@ -1,58 +0,0 @@
-import { FilterFunction, Gradient, QRCode } from "../types/index.js";
-import { RequiredOptions } from "./QROptions.js";
-export declare class QRSVG {
-    /** @ignore */
-    _element: SVGElement;
-    /** @ignore */
-    _defs: SVGElement;
-    /** @ignore */
-    _backgroundMask?: SVGElement;
-    /** @ignore */
-    _backgroundMaskGroup?: SVGElement;
-    /** @ignore */
-    _dotsMask?: SVGElement;
-    /** @ignore */
-    _dotsMaskGroup?: SVGElement;
-    /** @ignore */
-    _cornersSquareMask?: SVGElement;
-    /** @ignore */
-    _cornersSquareMaskGroup?: SVGElement;
-    /** @ignore */
-    _cornersDotMask?: SVGElement;
-    /** @ignore */
-    _cornersDotMaskGroup?: SVGElement;
-    /** @ignore */
-    _options: RequiredOptions;
-    /** @ignore */
-    _qr?: QRCode;
-    /** @ignore */
-    _document: Document;
-    /** @ignore */
-    private _imageTools;
-    constructor(options: RequiredOptions);
-    get width(): number;
-    get height(): number;
-    getElement(): SVGElement;
-    drawQR(qr: QRCode): Promise<void>;
-    drawBackground(): void;
-    drawDots(filter?: FilterFunction): void;
-    drawCorners(): void;
-    drawImage({ width, height, count, dotSize }: {
-        width: number;
-        height: number;
-        count: number;
-        dotSize: number;
-    }): Promise<void>;
-    /** @ignore */
-    _createColor({ options, color, additionalRotation, x, y, height, width, name }: {
-        options?: Gradient;
-        color?: string;
-        additionalRotation: number;
-        x: number;
-        y: number;
-        height: number;
-        width: number;
-        name: string;
-    }): void;
-    _createMask(id: string): (SVGGElement | SVGMaskElement)[];
-}

package/lib/figures/cornerDot/QRCornerDot.d.ts

@@ -1,27 +0,0 @@
-import { BasicFigureDrawArgs, CornerDotType, DrawArgs, RotateFigureArgs } from "../../types/index.js";
-export declare class QRCornerDot {
-    _element?: SVGElement;
-    _svg: SVGElement;
-    _type: CornerDotType;
-    _document: Document;
-    constructor({ svg, type, document }: {
-        svg: SVGElement;
-        type: CornerDotType;
-        document: Document;
-    });
-    draw(x: number, y: number, size: number, rotation: number): void;
-    _rotateFigure({ x, y, size, rotation, draw }: RotateFigureArgs): void;
-    _basicDot(args: BasicFigureDrawArgs): void;
-    _basicSquare(args: BasicFigureDrawArgs): void;
-    _basicHeart(args: BasicFigureDrawArgs): void;
-    _basicRounded(args: BasicFigureDrawArgs): void;
-    _basicClassy(args: BasicFigureDrawArgs): void;
-    _basicInpoint(args: BasicFigureDrawArgs): void;
-    _drawDot({ x, y, size, rotation }: DrawArgs): void;
-    _drawSquare({ x, y, size, rotation }: DrawArgs): void;
-    _drawHeart({ x, y, size, rotation }: DrawArgs): void;
-    _drawRounded({ x, y, size, rotation }: DrawArgs): void;
-    _drawClassy({ x, y, size, rotation }: DrawArgs): void;
-    _drawInpoint({ x, y, size, rotation }: DrawArgs): void;
-    _drawOutpoint({ x, y, size, rotation }: DrawArgs): void;
-}

package/lib/figures/cornerSquare/QRCornerSquare.d.ts

@@ -1,25 +0,0 @@
-import { CornerSquareType, DrawArgs, BasicFigureDrawArgs, RotateFigureArgs } from "../../types/index.js";
-export declare class QRCornerSquare {
-    _element?: SVGElement;
-    _svg: SVGElement;
-    _type: CornerSquareType;
-    _document: Document;
-    constructor({ svg, type, document }: {
-        svg: SVGElement;
-        type: CornerSquareType;
-        document: Document;
-    });
-    draw(x: number, y: number, size: number, rotation: number): void;
-    _rotateFigure({ x, y, size, rotation, draw }: RotateFigureArgs): void;
-    _basicDot(args: BasicFigureDrawArgs): void;
-    _basicSquare(args: BasicFigureDrawArgs): void;
-    _basicExtraRounded(args: BasicFigureDrawArgs): void;
-    _basicClassy(args: BasicFigureDrawArgs): void;
-    _basicInpoint(args: BasicFigureDrawArgs): void;
-    _drawDot({ x, y, size, rotation }: DrawArgs): void;
-    _drawSquare({ x, y, size, rotation }: DrawArgs): void;
-    _drawExtraRounded({ x, y, size, rotation }: DrawArgs): void;
-    _drawClassy({ x, y, size, rotation }: DrawArgs): void;
-    _drawInpoint({ x, y, size, rotation }: DrawArgs): void;
-    _drawOutpoint({ x, y, size, rotation }: DrawArgs): void;
-}

package/lib/figures/dot/QRDot.d.ts

@@ -1,31 +0,0 @@
-import { DotType, GetNeighbor, DrawArgs, BasicFigureDrawArgs, RotateFigureArgs } from "../../types/index.js";
-export declare class QRDot {
-    _element?: SVGElement;
-    _svg: SVGElement;
-    _type: DotType;
-    _document: Document;
-    constructor({ svg, type, document }: {
-        svg: SVGElement;
-        type: DotType;
-        document: Document;
-    });
-    draw(x: number, y: number, size: number, getNeighbor: GetNeighbor): void;
-    _rotateFigure({ x, y, size, rotation, draw }: RotateFigureArgs): void;
-    _basicDot(args: BasicFigureDrawArgs): void;
-    _basicSquare(args: BasicFigureDrawArgs): void;
-    _basicSideRounded(args: BasicFigureDrawArgs): void;
-    _basicCornerRounded(args: BasicFigureDrawArgs): void;
-    _basicCornerExtraRounded(args: BasicFigureDrawArgs): void;
-    _basicCornersRounded(args: BasicFigureDrawArgs): void;
-    _drawDot({ x, y, size }: DrawArgs): void;
-    _drawRandomDot({ x, y, size }: DrawArgs): void;
-    _drawSquare({ x, y, size }: DrawArgs): void;
-    _drawSmallSquare({ x, y, size }: DrawArgs): void;
-    _drawDiamond({ x, y, size }: DrawArgs): void;
-    _drawRounded({ x, y, size, getNeighbor }: DrawArgs): void;
-    _drawVerticalLines({ x, y, size, getNeighbor }: DrawArgs): void;
-    _drawHorizontalLines({ x, y, size, getNeighbor }: DrawArgs): void;
-    _drawExtraRounded({ x, y, size, getNeighbor }: DrawArgs): void;
-    _drawClassy({ x, y, size, getNeighbor }: DrawArgs): void;
-    _drawClassyRounded({ x, y, size, getNeighbor }: DrawArgs): void;
-}

package/lib/tools/browserUtils.d.ts

@@ -1,11 +0,0 @@
-import { QRCodeStyling } from "../core/QRCodeStyling.js";
-import { CanvasOptions, FileExtension } from "../types/index.js";
-export declare function drawToCanvas(qrCode: QRCodeStyling, options?: CanvasOptions): {
-    canvas: HTMLCanvasElement;
-    canvasDrawingPromise: Promise<void> | undefined;
-} | undefined;
-export declare function download(qrCode: QRCodeStyling, downloadOptions: FileExtension | {
-    name?: string;
-    extension: FileExtension;
-}, options?: CanvasOptions): Promise<void>;
-export declare function downloadURI(uri: string, name: string): void;

package/lib/tools/getMode.d.ts

@@ -1,2 +0,0 @@
-import { Mode } from "../types/index.js";
-export declare function getMode(data: string): Mode;

package/lib/tools/sanitizeOptions.d.ts

@@ -1,3 +0,0 @@
-import { RequiredCanvasOptions, RequiredOptions } from "../core/QROptions.js";
-export declare function sanitizeOptions(options: RequiredOptions): RequiredOptions;
-export declare function sanitizeCanvasOptions(options: RequiredCanvasOptions): RequiredCanvasOptions;