@qr-platform/qr-code.js 0.9.4 → 0.9.6

package/lib/node/node.d.ts

@@ -4,6 +4,7 @@ import type * as _browserUtils from './tools/browser-utils';
 import { RecursivePartial } from './types/helper';
 import { StyleOptions } from './types/style-options';
 import { Options } from './utils/options';
+import { ImageDataLike } from './utils/scan-validator-worker';
 import { ScanValidatorResponse } from './utils/scan-validators/abstract-scan-validator';
 import { type DecodedLicenseToken } from './utils/token-validator';
 export { ErrorCorrectionLevel, Mode, TypeNumber } from '~/lib/qrcode/QRCodeMinimal';
@@ -33,7 +34,9 @@ export declare class QRCodeJs extends _QRCodeJs {
     static _initPromise: Promise<void> | null;
     static initXmldom(): Promise<void>;
     constructor(options: RecursivePartial<Options>, _?: boolean);
+    static validateImageData(imageData: ImageDataLike): Promise<ScanValidatorResponse>;
     validateScanning(): Promise<ScanValidatorResponse>;
+    static validateSvg(svgSource: string): Promise<ScanValidatorResponse>;
     /**
      * Creates a QRCodeBuilder instance initialized with a specific template.
      * Allows for fluent configuration chaining. We need it here to avoid circular dependency
@@ -84,5 +87,6 @@ declare class QRCodeBuilder {
 }
 export declare class _ extends QRCodeJs {
     protected _hls(): boolean;
+    static get hls(): boolean;
     constructor(options: RecursivePartial<Options>);
 }

package/lib/node/plugins/QRValidatorZbar.d.ts

@@ -29,6 +29,12 @@ declare class QRValidatorZbar {
      * @returns {Promise<Object>} - Validation result after retries
      */
     decodeQRWithRetry(imageData: ImageData): Promise<Object>;
+    /**
+     * Validate and decode a QR code directly from ImageData
+     * @param {object} imageData - Object with { data: Uint8ClampedArray, width: number, height: number }
+     * @returns {Promise<Object>} - Validation results
+     */
+    validateImageData(imageData: object): Promise<Object>;
     /**
      * Decode QR code from image data using zbar-wasm
      * @param {ImageData} imageData - Raw image data

package/lib/node/plugins/QRValidatorZbarNode.d.ts

@@ -4,6 +4,7 @@
  * This server-side class uses zbar-wasm to decode QR codes and other barcodes,
  * with Jimp (and Resvg for SVG conversion) for image processing.
  */
+import { ScanValidatorResponse } from '~/utils/scan-validators/abstract-scan-validator';
 interface QRValidatorOptions {
     /** Maximum number of retry attempts */
     maxRetries?: number;
@@ -12,21 +13,13 @@ interface QRValidatorOptions {
     /** Enable debug logging */
     debug?: boolean;
 }
-interface QRValidationResult {
-    /** Whether the validation was successful */
-    isValid: boolean;
-    /** Decoded data from the QR code (if successful) */
-    data?: string;
-    /** Format of the detected barcode */
-    format?: string;
-    /** Number of retry attempts made */
-    attempts?: number;
-    /** Whether the successful decode came from an inverted image */
-    isInverted?: boolean;
-    /** Error message if validation failed */
-    error?: string;
-    /** Error code if validation failed */
-    errorCode?: string;
+interface ImageDataLike {
+    /** Raw pixel data (RGBA) */
+    data: Uint8ClampedArray;
+    /** Image width */
+    width: number;
+    /** Image height */
+    height: number;
 }
 declare class QRValidatorZbarNode {
     private maxRetries;
@@ -37,7 +30,7 @@ declare class QRValidatorZbarNode {
     /**
      * Validate and decode a QR code from an SVG string (or file path)
      */
-    validate(input: string, isInverted?: boolean): Promise<QRValidationResult>;
+    validate(input: string, isInverted?: boolean): Promise<ScanValidatorResponse>;
     private sleep;
     /**
      * Process image using Sharp and get raw pixel data
@@ -48,6 +41,10 @@ declare class QRValidatorZbarNode {
      */
     private processImageResvg;
     private validateWithRetry;
+    /**
+     * Validate and decode a QR code directly from ImageData
+     */
+    validateImageData(imageData: ImageDataLike): Promise<ScanValidatorResponse>;
     /**
      * Save a debug image using Jimp. The raw image data is used to reconstruct an image.
      */

package/lib/node/plugins/QRValidatorZbarNodeSharp.d.ts

@@ -1,3 +1,4 @@
+import { ScanValidatorResponse } from '~/utils/scan-validators/abstract-scan-validator';
 interface QRValidatorOptions {
     /** Maximum number of retry attempts */
     maxRetries?: number;
@@ -6,22 +7,6 @@ interface QRValidatorOptions {
     /** Enable debug logging */
     debug?: boolean;
 }
-interface QRValidationResult {
-    /** Whether the validation was successful */
-    isValid: boolean;
-    /** Decoded data from the QR code (if successful) */
-    data?: string;
-    /** Format of the detected barcode */
-    format?: string;
-    /** Number of retry attempts made */
-    attempts?: number;
-    /** Whether the successful decode came from an inverted image */
-    isInverted?: boolean;
-    /** Error message if validation failed */
-    error?: string;
-    /** Error code if validation failed */
-    errorCode?: string;
-}
 declare class QRValidatorZbarNode {
     private maxRetries;
     private retryInterval;
@@ -43,7 +28,7 @@ declare class QRValidatorZbarNode {
      * @param height Optional height for resizing
      * @returns Validation results with decoded data if successful
      */
-    validate(input: string | Buffer, isInverted?: boolean, width?: number | null, height?: number | null): Promise<QRValidationResult>;
+    validate(input: string | Buffer, isInverted?: boolean, width?: number | null, height?: number | null): Promise<ScanValidatorResponse>;
     /**
      * Sleep function to wait between retry attempts
      * @param ms Milliseconds to wait

package/lib/node/plugins/QRValidatorZbarWorker.d.ts

@@ -4,6 +4,7 @@
  * This server-side class uses zbar-wasm to decode QR codes and other barcodes,
  * with Jimp (and Resvg for SVG conversion) for image processing.
  */
+import { ScanValidatorResponse } from '~/utils/scan-validators/abstract-scan-validator';
 interface QRValidatorOptions {
     /** Maximum number of retry attempts */
     maxRetries?: number;
@@ -12,21 +13,13 @@ interface QRValidatorOptions {
     /** Enable debug logging */
     debug?: boolean;
 }
-interface QRValidationResult {
-    /** Whether the validation was successful */
-    isValid: boolean;
-    /** Decoded data from the QR code (if successful) */
-    data?: string;
-    /** Format of the detected barcode */
-    format?: string;
-    /** Number of retry attempts made */
-    attempts?: number;
-    /** Whether the successful decode came from an inverted image */
-    isInverted?: boolean;
-    /** Error message if validation failed */
-    error?: string;
-    /** Error code if validation failed */
-    errorCode?: string;
+interface ImageDataLike {
+    /** Raw pixel data (RGBA) */
+    data: Uint8ClampedArray;
+    /** Image width */
+    width: number;
+    /** Image height */
+    height: number;
 }
 declare class QRValidatorZbarNode {
     private maxRetries;
@@ -37,7 +30,7 @@ declare class QRValidatorZbarNode {
     /**
      * Validate and decode a QR code from an SVG string (or file path)
      */
-    validate(input: string, isInverted?: boolean): Promise<QRValidationResult>;
+    validate(input: string, isInverted?: boolean): Promise<ScanValidatorResponse>;
     private sleep;
     /**
      * Process image using Sharp and get raw pixel data
@@ -48,6 +41,10 @@ declare class QRValidatorZbarNode {
      */
     private processImageResvg;
     private validateWithRetry;
+    /**
+     * Validate and decode a QR code directly from ImageData
+     */
+    validateImageData(imageData: ImageDataLike): Promise<ScanValidatorResponse>;
     /**
      * Save a debug image using Jimp. The raw image data is used to reconstruct an image.
      */

package/lib/node/utils/scan-validator-node.d.ts

@@ -1,8 +1,13 @@
 import { ScanValidatorResponse } from './scan-validators/abstract-scan-validator';
+interface ImageDataLike {
+    data: Uint8ClampedArray;
+    width: number;
+    height: number;
+}
 /**
  * QR Code validator for Node.js environment
  */
-export declare const qrValidator: {
+export declare const qrValidatorZbar: {
     /**
      * Validate QR code using zbar with SVG as input
      * @param svgSource SVG string containing QR code
@@ -12,4 +17,12 @@ export declare const qrValidator: {
      * @returns Validation result
      */
     validateZbar: (svgSource: string | undefined, debug?: boolean) => Promise<ScanValidatorResponse>;
+    /**
+     * Validate QR code using zbar with ImageData as input (Node.js)
+     * @param imageData Object with { data: Uint8ClampedArray, width: number, height: number }
+     * @param debug Enable detailed debugging (passed to underlying validator)
+     * @returns Validation result
+     */
+    validateZbarImageData: (imageData: ImageDataLike, debug?: boolean) => Promise<ScanValidatorResponse>;
 };
+export {};

package/lib/node/utils/scan-validator-worker.d.ts

@@ -1,8 +1,13 @@
 import { ScanValidatorResponse } from './scan-validators/abstract-scan-validator';
+export interface ImageDataLike {
+    data: Uint8ClampedArray;
+    width: number;
+    height: number;
+}
 /**
  * QR Code validator for Node.js environment
  */
-export declare const qrValidator: {
+export declare const qrValidatorZbar: {
     /**
      * Validate QR code using zbar with SVG as input
      * @param svgSource SVG string containing QR code
@@ -12,4 +17,11 @@ export declare const qrValidator: {
      * @returns Validation result
      */
     validateZbar: (svgSource: string | undefined, debug?: boolean) => Promise<ScanValidatorResponse>;
+    /**
+     * Validate QR code using zbar with ImageData as input
+     * @param imageData Object with { data: Uint8ClampedArray, width: number, height: number }
+     * @param debug Enable detailed debugging (passed to underlying validator)
+     * @returns Validation result
+     */
+    validateZbarImageData: (imageData: ImageDataLike, debug?: boolean) => Promise<ScanValidatorResponse>;
 };

package/lib/node/utils/scan-validator-zxing-node.d.ts

@@ -1,6 +1,11 @@
 import { BinaryBitmap } from '~/lib/zxing-js/src';
 import { NodeLuminanceSource } from '~/lib/zxing-js/src/node';
 import { ScanValidatorResponse } from './scan-validators/abstract-scan-validator';
+interface ImageDataLike {
+    data: Uint8ClampedArray;
+    width: number;
+    height: number;
+}
 export interface PreprocessingOptions {
     lower?: number;
     upper?: number;
@@ -14,5 +19,6 @@ export interface PreprocessingOptions {
  */
 export declare const qrValidatorZxing: {
     validateZxing: (svgString: string | undefined) => Promise<ScanValidatorResponse>;
+    validateImageData: (imageData: ImageDataLike) => Promise<ScanValidatorResponse>;
 };
 export type { NodeLuminanceSource, BinaryBitmap, ScanValidatorResponse };

package/lib/node/utils/scan-validators/abstract-scan-validator.d.ts

@@ -9,7 +9,11 @@ export interface ScanValidatorResponse {
     /**
      * Decoded data from the QR code
      */
-    decodedText?: string | null;
+    data?: string | null;
+    /**
+     * Format of the detected barcode
+     */
+    format?: string;
     /**
      * Whether the successful decode was from an inverted image
      */

package/lib/node/utils/scan-validators/zxing-canvas-scan-validator.d.ts

@@ -1,10 +1,16 @@
 import { LuminanceSource } from '~/lib/zxing-js/src';
 import QRCodeReader from '~/lib/zxing-js/src/core/qrcode/QRCodeReader';
 import AbstractScanValidator, { ScanValidator, ScanValidatorResponse } from './abstract-scan-validator';
+interface ImageDataLike {
+    data: Uint8ClampedArray;
+    width: number;
+    height: number;
+}
 declare class ZXingCanvasScanValidator extends AbstractScanValidator implements ScanValidator {
     validator: QRCodeReader;
     constructor(debug?: boolean);
     displayLuminanceSource(source: LuminanceSource, label: string): void;
     validate(canvas: HTMLCanvasElement, debug?: boolean): Promise<ScanValidatorResponse>;
+    validateImageData(imageData: ImageDataLike, debug?: boolean): Promise<ScanValidatorResponse>;
 }
 export default ZXingCanvasScanValidator;

package/lib/node.d.ts

@@ -4,6 +4,7 @@ import type * as _browserUtils from './tools/browser-utils';
 import { RecursivePartial } from './types/helper';
 import { StyleOptions } from './types/style-options';
 import { Options } from './utils/options';
+import { ImageDataLike } from './utils/scan-validator-worker';
 import { ScanValidatorResponse } from './utils/scan-validators/abstract-scan-validator';
 import { type DecodedLicenseToken } from './utils/token-validator';
 export { ErrorCorrectionLevel, Mode, TypeNumber } from '~/lib/qrcode/QRCodeMinimal';
@@ -33,7 +34,9 @@ export declare class QRCodeJs extends _QRCodeJs {
     static _initPromise: Promise<void> | null;
     static initXmldom(): Promise<void>;
     constructor(options: RecursivePartial<Options>, _?: boolean);
+    static validateImageData(imageData: ImageDataLike): Promise<ScanValidatorResponse>;
     validateScanning(): Promise<ScanValidatorResponse>;
+    static validateSvg(svgSource: string): Promise<ScanValidatorResponse>;
     /**
      * Creates a QRCodeBuilder instance initialized with a specific template.
      * Allows for fluent configuration chaining. We need it here to avoid circular dependency
@@ -84,5 +87,6 @@ declare class QRCodeBuilder {
 }
 export declare class _ extends QRCodeJs {
     protected _hls(): boolean;
+    static get hls(): boolean;
     constructor(options: RecursivePartial<Options>);
 }