@qr-platform/qr-code.js 0.8.24 → 0.9.1

package/lib/node/core/qr-code-js.d.ts

@@ -0,0 +1,61 @@
+import { CanvasOptions } from '~/utils/canvas-options';
+import { RecursivePartial } from '../types/helper';
+import { StyleOptions } from '../types/style-options';
+import { Options } from '../utils/options';
+export declare enum FileExtension {
+    svg = "svg",
+    png = "png",
+    jpeg = "jpeg",
+    webp = "webp"
+}
+export type ExtensionFunction = (svg: SVGElement, options: RecursivePartial<Options>) => void;
+export declare class QRCodeJs {
+    /** Library version injected at build time */
+    static version: string;
+    private static _selectedTemplate;
+    private static _selectedStyle;
+    private options;
+    private container?;
+    private qr?;
+    private extension?;
+    private svgDrawingPromise?;
+    private qrSVG?;
+    get size(): {
+        width: number;
+        height: number;
+    } | undefined;
+    constructor(options: RecursivePartial<Options>, _?: boolean);
+    static setTemplate(templateNameOrOptions: string | RecursivePartial<Options>): typeof QRCodeJs;
+    /**
+     * Sets the static style to be used as a base for new instances.
+     * Accepts either a predefined style name or a StyleOptions object.
+     * @param styleNameOrOptions - The name of the style or the StyleOptions object.
+     * @returns The QRCodeJs class for chaining.
+     */
+    static setStyle(styleNameOrOptions: string | StyleOptions): typeof QRCodeJs;
+    update(options?: RecursivePartial<Options>): Promise<void>;
+    append(
+    /** This container will be used for appending of the QR code */
+    container?: HTMLElement): QRCodeJs | undefined;
+    applyExtension(extension: ExtensionFunction): Promise<void>;
+    deleteExtension(): Promise<void>;
+    serialize(inverted?: boolean): Promise<string | undefined>;
+    private _setupSvgAsync;
+    protected _drawToCanvasForValidation(options?: RecursivePartial<CanvasOptions>): Promise<HTMLCanvasElement>;
+    protected drawToCanvas(options?: RecursivePartial<CanvasOptions>): Promise<{
+        canvas: HTMLCanvasElement;
+        canvasDrawingPromise: Promise<void> | undefined;
+    } | undefined>;
+    private downloadURI;
+    download(downloadOptions?: {
+        name?: string;
+        extension: `${FileExtension}`;
+    }, canvasOptions?: RecursivePartial<CanvasOptions>): Promise<void>;
+    protected createOptimizedQRCanvas(options?: RecursivePartial<CanvasOptions>): Promise<HTMLCanvasElement>;
+    /**
+     * Apply thresholding to enhance QR code contrast
+     */
+    private applyQRThreshold;
+    protected _hls(): boolean;
+    private _logValidationWarnings;
+}

package/lib/node/core/qr-constant.d.ts

@@ -0,0 +1,9 @@
+export declare const rq = "rq";
+export declare const dash = "-";
+export declare const talp = "talp";
+export declare const mrof = "mrof";
+export declare const _s: string;
+export declare const _c: string;
+export declare const chunks1: string[];
+export declare const chunks2: string[];
+export declare const chunks3: string[];

package/lib/node/core/qr-options-validation.d.ts

@@ -0,0 +1,13 @@
+import { RecursivePartial } from '../types/helper';
+import { Options } from '../utils/options.js';
+export interface ValidationWarning {
+    path: string;
+    message: string;
+    value: any;
+}
+interface ValidationResult {
+    warnings: ValidationWarning[];
+    validatedOptions: RecursivePartial<Options>;
+}
+export declare function validateQROptions(options: RecursivePartial<Options>): ValidationResult;
+export {};

package/lib/node/core/qr-styles.d.ts

@@ -0,0 +1,4 @@
+import { StyleOptions } from '../types/style-options';
+export declare const qrStyles: {
+    [key: string]: StyleOptions;
+};

package/lib/node/core/qr-svg.d.ts

@@ -0,0 +1,76 @@
+import { Position } from '~/plugins/QRBorderHelpers';
+import { QRCodeMinimal } from '~/lib/qrcode/QRCodeMinimal';
+import { Gradient } from '../utils/gradient';
+import { BorderOptions, Options } from '../utils/options';
+type QRSVGOptions = Pick<Options, 'width' | 'height' | 'isResponsive' | 'margin' | 'document' | 'imageTools' | 'image' | 'imageOptions' | 'dotsOptions' | 'cornersDotOptions' | 'cornersSquareOptions' | 'backgroundOptions' | 'borderOptions' | 'shape' | 'scale' | 'verticalOffset' | 'horizontalOffset' | 'offset'> & {
+    width: number;
+    height: number;
+    hls: boolean;
+    errorCorrectionPercent: number;
+    bordersMain: {
+        [key in Position]: number;
+    };
+    bordersOuter: {
+        [key in Position]: number;
+    };
+    bordersInner: {
+        [key in Position]: number;
+    };
+};
+export declare class QRSVG {
+    static instanceCount: number;
+    private _element;
+    private defs;
+    private backgroundMask?;
+    private backgroundMaskGroup?;
+    private dotsMask?;
+    private dotsMaskGroup?;
+    private lightDotsMask?;
+    private lightDotsMaskGroup?;
+    private qr?;
+    private document;
+    private imageTools;
+    private finalWidth;
+    private finalHeight;
+    private _hls;
+    private _innerQrGroup;
+    private _maskedQrGroup;
+    _instanceId: number;
+    private options;
+    constructor(options: QRSVGOptions);
+    get element(): SVGElement;
+    private get qrGroup();
+    get width(): number;
+    get height(): number;
+    get svgSize(): {
+        width: number;
+        height: number;
+    };
+    getElement(): SVGElement;
+    private roundValue;
+    drawQR(qr: QRCodeMinimal): Promise<void>;
+    drawBackground(): void;
+    drawBackgroundForBorder(padding: number, baseRadius: number): SVGElement | undefined;
+    drawDots(filter?: (i: number, j: number) => boolean): void;
+    drawCorners(): void;
+    drawImage({ width, height, count, dotSize }: {
+        width: number;
+        height: number;
+        count: number;
+        dotSize: number;
+    }): Promise<void>;
+    createColor({ options, borderOptions, color, additionalRotation, x, y, height, width, name, returnSVGGroup }: {
+        options?: Gradient;
+        borderOptions?: BorderOptions;
+        color?: string;
+        additionalRotation: number;
+        x: number;
+        y: number;
+        height: number;
+        width: number;
+        name: string;
+        returnSVGGroup?: boolean;
+    }): void | SVGElement;
+    private createMask;
+}
+export {};

package/lib/node/core/qr-templates.d.ts

@@ -0,0 +1,10 @@
+import { type Options } from '~/utils/options';
+import { RecursivePartial } from '~/types/helper';
+export declare const plainQRTemplate: RecursivePartial<Options>;
+export declare const basicQRTemplate: RecursivePartial<Options>;
+export declare const roundedQRTemplate: RecursivePartial<Options>;
+export declare const dotsQRTemplate: RecursivePartial<Options>;
+export declare const classyQRTemplate: RecursivePartial<Options>;
+export declare const qrTemplates: {
+    [key: string]: RecursivePartial<Options>;
+};

package/lib/node/figures/corner-dot.d.ts

@@ -0,0 +1,24 @@
+import { DrawArgs } from '../types/helper.js';
+import { CornerDotType } from '../utils/options.js';
+export declare class QRCornerDot {
+    private readonly type;
+    private readonly document;
+    private _element?;
+    get element(): SVGElement | undefined;
+    constructor(type: `${CornerDotType}`, document: Document);
+    draw(args: DrawArgs): void;
+    private rotateFigure;
+    private basicDot;
+    private basicSquare;
+    private basicHeart;
+    private basicRounded;
+    private basicClassy;
+    private basicInpoint;
+    private drawDot;
+    private drawSquare;
+    private drawHeart;
+    private drawRounded;
+    private drawClassy;
+    private drawInpoint;
+    private drawOutpoint;
+}

package/lib/node/figures/corner-square.d.ts

@@ -0,0 +1,24 @@
+import { DrawArgs } from '../types/helper.js';
+import { CornerSquareType } from '../utils/options.js';
+export declare class QRCornerSquare {
+    private readonly type;
+    private readonly document;
+    private _element?;
+    private _fill?;
+    get element(): SVGElement | undefined;
+    get fill(): SVGElement | undefined;
+    constructor(type: `${CornerSquareType}`, document: Document);
+    draw(args: DrawArgs): void;
+    private rotateFigure;
+    private basicDot;
+    private basicSquare;
+    private basicExtraRounded;
+    private basicClassy;
+    private basicInpoint;
+    private drawDot;
+    private drawSquare;
+    private drawExtraRounded;
+    private drawClassy;
+    private drawInpoint;
+    private drawOutpoint;
+}

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

@@ -0,0 +1,31 @@
+import { DrawArgs } from '../types/helper.js';
+import { DotType } from '../utils/options.js';
+export declare class QRDot {
+    private readonly type;
+    private readonly document;
+    private _element?;
+    get element(): SVGElement | undefined;
+    constructor(type: `${DotType}`, document: Document);
+    draw(args: DrawArgs): void;
+    private rotateFigure;
+    private basicDot;
+    private basicSquare;
+    private basicSideRounded;
+    private basicCornerRounded;
+    private basicCornerExtraRounded;
+    private basicCornersRounded;
+    private drawDot;
+    private drawRandomDot;
+    private drawSquare;
+    private drawSmallSquare;
+    private drawTinySquare;
+    private drawDiamond;
+    private drawRounded;
+    private drawVerticalLine;
+    private drawHorizontalLine;
+    private drawExtraRounded;
+    private drawClassy;
+    private drawClassyRounded;
+    private drawStar;
+    private drawPlus;
+}

package/lib/node/index.d.ts

@@ -0,0 +1,101 @@
+import { QRCodeJs as _QRCodeJs } from './core/qr-code-js';
+import { RecursivePartial } from './types/helper';
+import { StyleOptions } from './types/style-options';
+import { Options, type Options as QRCodeJsOptions } from './utils/options';
+import { ScanValidatorResponse } from './utils/scan-validators/abstract-scan-validator';
+import { type DecodedLicenseToken } from './utils/token-validator';
+export { ErrorCorrectionLevel, Mode, TypeNumber } from './lib/qrcode/QRCodeMinimal';
+export { type ExtensionFunction } from './core/qr-code-js';
+export { FileExtension } from './tools/browser-utils';
+export { type RecursivePartial } from './types/helper';
+export { type CanvasOptions } from './utils/canvas-options';
+export { GradientType, type Gradient } from './utils/gradient';
+export { STORAGE_KEY } from './license/LicenseManager';
+export { type BorderOptions, CornerDotType, CornerSquareType, DotType, ImageMode, ShapeType, type Options as QRCodeJsOptions } from './utils/options.js';
+export declare class QRCodeJs extends _QRCodeJs {
+    constructor(options: RecursivePartial<QRCodeJsOptions>, _?: boolean);
+    protected _hls(): boolean;
+    static initializeIfNeeded(): Promise<boolean>;
+    static get hls(): boolean;
+    static getLicenseDetails(): DecodedLicenseToken | null;
+    static configureLicenseFetcher(fetcher: (licenseKey: string) => Promise<string>): void;
+    /**
+     * Activate the license using a pre-fetched JWT token via LicenseManager.
+     * @param token The JWT token string, or null to clear the license.
+     * @returns A Promise resolving to the validation result.
+     */
+    static token(token: string | null): Promise<{
+        isValid: boolean;
+        token: string | null;
+        license: DecodedLicenseToken | null;
+    }>;
+    /**
+     * Sets the default URL used by the built-in license fetcher.
+     * Call this *before* activating with a key if you are not providing a custom fetcher.
+     * @param url The new default URL for fetching license tokens.
+     */
+    static setLicenseUrl(url: string): typeof QRCodeJs;
+    /**
+     * Activate the license using a license key via LicenseManager.
+     * @param licenseKey The license key string.
+     * @returns A Promise resolving to the validation result.
+     */
+    static license(licenseKey: string): Promise<{
+        isValid: boolean;
+        token: string | null;
+        license: DecodedLicenseToken | null;
+    }>;
+    validateScanning(_validatorId?: string, // Default validator
+    debug?: boolean): Promise<ScanValidatorResponse>;
+    /**
+     * Creates a QRCodeBuilder instance initialized with a specific template.
+     * Allows for fluent configuration chaining. We need it here to avoid circular dependency
+     * @param templateName - The name of the template to start with.
+     * @param templateNameOrOptions - The name of the template or a partial options object to start with.
+     * @returns A new QRCodeBuilder instance.
+     */
+    static useTemplate(templateNameOrOptions: string | RecursivePartial<Options>): QRCodeBuilder;
+    /**
+     * Creates a QRCodeBuilder instance initialized with a specific style.
+     * Allows for fluent configuration chaining.
+     * @param styleNameOrOptions - The name of the predefined style or a StyleOptions object.
+     * @returns A new QRCodeBuilder instance.
+     */
+    static useStyle(styleNameOrOptions: string | StyleOptions): QRCodeBuilder;
+}
+export declare class _ extends QRCodeJs {
+    protected _hls(): boolean;
+    constructor(options: QRCodeJsOptions);
+}
+declare class QRCodeBuilder {
+    protected config: RecursivePartial<Options>;
+    /**
+     * Creates a new QRCodeBuilder instance.
+     * @param templateNameOrOptions - Optional name of a predefined template or a partial options object to start with.
+     */
+    constructor(templateNameOrOptions?: string | RecursivePartial<Options>);
+    /**
+     * Applies a template to the builder's configuration. Template options
+     * will be overridden by subsequently chained .style() or .options() calls.
+     * @param templateNameOrOptions - The name of the template or a partial options object to apply.
+     * @returns The builder instance for chaining.
+     */
+    useTemplate(templateNameOrOptions: string | RecursivePartial<Options>): this;
+    /**
+     * Applies style options to the builder's configuration.
+     * @param styleNameOrOptions - Name of a predefined style or Style options object to apply.
+     * @returns The builder instance for chaining.
+     */
+    useStyle(styleNameOrOptions: string | StyleOptions): this;
+    /**
+     * Merges the provided options into the builder's configuration.
+     * @param options - A partial options object to merge.
+     * @returns The builder instance for chaining.
+     */
+    options(options: RecursivePartial<Options>): QRCodeJs;
+    /**
+     * Builds the QRCodeJs instance with the accumulated configuration.
+     * @returns The created QRCodeJs instance.
+     */
+    build(): QRCodeJs;
+}

package/lib/node/lib/image/GIFImage.d.ts

@@ -0,0 +1,19 @@
+import { OutputStream } from '../io/OutputStream.js';
+/**
+ * GIF Image (B/W)
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class GIFImage {
+    private width;
+    private height;
+    private data;
+    constructor(width: number, height: number);
+    setPixel(x: number, y: number, pixel: number): void;
+    getPixel(x: number, y: number): number;
+    write(out: OutputStream): void;
+    private getLZWRaster;
+    private writeWord;
+    private writeBytes;
+    toDataURL(): string;
+}

package/lib/node/lib/io/Base64.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Base64
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class Base64 {
+    constructor();
+    static encode(data: number[]): number[];
+    static decode(data: number[]): number[];
+}

package/lib/node/lib/io/Base64DecodeInputStream.d.ts

@@ -0,0 +1,15 @@
+import { InputStream } from './InputStream.js';
+/**
+ * Base64DecodeInputStream
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class Base64DecodeInputStream extends InputStream {
+    private istream;
+    private buffer;
+    private buflen;
+    constructor(istream: InputStream);
+    readByte(): number;
+    private static isWhitespace;
+    private static decode;
+}

package/lib/node/lib/io/Base64EncodeOutputStream.d.ts

@@ -0,0 +1,17 @@
+import { OutputStream } from './OutputStream.js';
+/**
+ * Base64EncodeOutputStream
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class Base64EncodeOutputStream extends OutputStream {
+    private ostream;
+    private buffer;
+    private buflen;
+    private length;
+    constructor(ostream: OutputStream);
+    writeByte(n: number): void;
+    flush(): void;
+    private writeEncoded;
+    private static encode;
+}

package/lib/node/lib/io/ByteArrayInputStream.d.ts

@@ -0,0 +1,12 @@
+import { InputStream } from './InputStream.js';
+/**
+ * ByteArrayInputStream
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class ByteArrayInputStream extends InputStream {
+    private bytes;
+    private pos;
+    constructor(bytes: number[]);
+    readByte(): number;
+}

package/lib/node/lib/io/ByteArrayOutputStream.d.ts

@@ -0,0 +1,12 @@
+import { OutputStream } from './OutputStream.js';
+/**
+ * ByteArrayOutputStream
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class ByteArrayOutputStream extends OutputStream {
+    private bytes;
+    constructor();
+    writeByte(b: number): void;
+    toByteArray(): number[];
+}

package/lib/node/lib/io/InputStream.d.ts

@@ -0,0 +1,10 @@
+/**
+ * InputStream
+ *
+ * @author Kazuhiko Arase
+ */
+export declare abstract class InputStream {
+    constructor();
+    abstract readByte(): number;
+    close(): void;
+}

package/lib/node/lib/io/OutputStream.d.ts

@@ -0,0 +1,12 @@
+/**
+ * OutputStream
+ *
+ * @author Kazuhiko Arase
+ */
+export declare abstract class OutputStream {
+    constructor();
+    abstract writeByte(b: number): void;
+    writeBytes(bytes: number[]): void;
+    flush(): void;
+    close(): void;
+}

package/lib/node/lib/qr-code.d.ts

@@ -0,0 +1,5 @@
+export { QRCode } from './qrcode/QRCode.js';
+export { ErrorCorrectionLevel, Mode, QRCodeMinimal, TypeNumber } from './qrcode/QRCodeMinimal.js';
+export { QRUtil } from './qrcode/QRUtil.js';
+export { stringToBytes_SJIS } from './text/stringToBytes_SJIS.js';
+export { stringToBytes_UTF8 } from './text/stringToBytes_UTF8.js';

package/lib/node/lib/qrcode/BitBuffer.d.ts

@@ -0,0 +1,11 @@
+export declare class BitBuffer {
+    private buffer;
+    private length;
+    constructor();
+    getBuffer(): number[];
+    getLengthInBits(): number;
+    toString(): string;
+    private getBit;
+    put(num: number, length: number): void;
+    putBit(bit: boolean): void;
+}

package/lib/node/lib/qrcode/ErrorCorrectLevel.d.ts

@@ -0,0 +1,23 @@
+/**
+ * ErrorCorrectLevel
+ *
+ * @author Kazuhiko Arase
+ */
+export declare enum ErrorCorrectLevel {
+    /**
+     * 7%
+     */
+    L = 1,
+    /**
+     * 15%
+     */
+    M = 0,
+    /**
+     * 25%
+     */
+    Q = 3,
+    /**
+     * 30%
+     */
+    H = 2
+}

package/lib/node/lib/qrcode/MaskPattern.d.ts

@@ -0,0 +1,39 @@
+/**
+ * MaskPattern
+ *
+ * @author Kazuhiko Arase
+ */
+export declare enum MaskPattern {
+    /**
+     * mask pattern 000
+     */
+    PATTERN000 = 0,
+    /**
+     * mask pattern 001
+     */
+    PATTERN001 = 1,
+    /**
+     * mask pattern 010
+     */
+    PATTERN010 = 2,
+    /**
+     * mask pattern 011
+     */
+    PATTERN011 = 3,
+    /**
+     * mask pattern 100
+     */
+    PATTERN100 = 4,
+    /**
+     * mask pattern 101
+     */
+    PATTERN101 = 5,
+    /**
+     * mask pattern 110
+     */
+    PATTERN110 = 6,
+    /**
+     * mask pattern 111
+     */
+    PATTERN111 = 7
+}

package/lib/node/lib/qrcode/Mode.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Mode
+ *
+ * @author Kazuhiko Arase
+ */
+export declare enum Mode {
+    /**
+     * number
+     */
+    MODE_NUMBER = 1,
+    /**
+     * alphabet and number
+     */
+    MODE_ALPHA_NUM = 2,
+    /**
+     * 8bit byte
+     */
+    MODE_8BIT_BYTE = 4,
+    /**
+     * KANJI
+     */
+    MODE_KANJI = 8
+}

package/lib/node/lib/qrcode/Polynomial.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Polynomial
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class Polynomial {
+    private num;
+    constructor(num: number[], shift?: number);
+    getAt(index: number): number;
+    getLength(): number;
+    toString(): string;
+    toLogString(): string;
+    multiply(e: Polynomial): Polynomial;
+    mod(e: Polynomial): Polynomial;
+}

package/lib/node/lib/qrcode/QR8BitByte.d.ts

@@ -0,0 +1,13 @@
+import { BitBuffer } from './BitBuffer.js';
+import { QRData } from './QRData.js';
+/**
+ * QR8BitByte
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class QR8BitByte extends QRData {
+    private stringToBytes;
+    constructor(data: string, stringToBytes: (s: string) => number[]);
+    write(buffer: BitBuffer): void;
+    getLength(): number;
+}

package/lib/node/lib/qrcode/QRAlphaNum.d.ts

@@ -0,0 +1,13 @@
+import { BitBuffer } from './BitBuffer.js';
+import { QRData } from './QRData.js';
+/**
+ * QRAlphaNum
+ *
+ * @author Kazuhiko Arase
+ */
+export declare class QRAlphaNum extends QRData {
+    constructor(data: string);
+    write(buffer: BitBuffer): void;
+    getLength(): number;
+    private static getCode;
+}

package/lib/node/lib/qrcode/QRCode.d.ts

@@ -0,0 +1,22 @@
+import { QRCodeMinimal } from './QRCodeMinimal.js';
+export declare class QRCode extends QRCodeMinimal {
+    private _createHalfASCII;
+    createASCII(cellSize?: number, margin?: number): string;
+    renderTo2dContext(context: CanvasRenderingContext2D, cellSize?: number): void;
+    toDataURL(cellSize?: number, margin?: number): string;
+    createTableTag(cellSize?: number, margin?: number): string;
+    createSvgTag(opts?: {
+        cellSize?: number;
+        margin?: number;
+        scalable?: boolean;
+        alt?: string | {
+            text?: string | null;
+            id?: string | null;
+        };
+        title?: string | {
+            text?: string | null;
+            id?: string | null;
+        };
+    }): string;
+    createImgTag(cellSize?: number, margin?: number, alt?: string): string;
+}