quadqr-js 0.7.0

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "quadqr-js",
+  "version": "0.7.0",
+  "description": "QuadQR: experimental four-state RGBW matrix code with Spectrum ECC, browser/Node scanning, CDN builds, and optional AES-256-GCM secure payloads.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "browser": "./dist/browser.js",
+  "types": "./types/index.d.ts",
+  "unpkg": "./dist/quadqr.min.js",
+  "jsdelivr": "./dist/quadqr.min.js",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./browser": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/browser.js",
+      "default": "./dist/browser.js"
+    },
+    "./node": {
+      "types": "./types/node.d.ts",
+      "import": "./dist/node.js",
+      "require": "./dist/node.cjs",
+      "default": "./dist/node.js"
+    },
+    "./benchmark": {
+      "types": "./types/benchmark.d.ts",
+      "import": "./dist/benchmark.js",
+      "require": "./dist/benchmark.cjs",
+      "default": "./dist/benchmark.js"
+    },
+    "./quadqr.js": "./dist/quadqr.js",
+    "./quadqr.min.js": "./dist/quadqr.min.js",
+    "./wasm/quadqr-core.wasm": "./dist/wasm/quadqr-core.wasm",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "types",
+    "bin",
+    "docs",
+    "FORMAT.md",
+    "README.md",
+    "LICENSE"
+  ],
+  "bin": {
+    "quadqr": "./bin/quadqr.js"
+  },
+  "scripts": {
+    "build": "node scripts/build.js",
+    "start": "node scripts/serve.js",
+    "demo": "node scripts/serve.js",
+    "docs": "node scripts/serve.js --docs",
+    "test": "node tests/self-test.js && node tests/package-test.js",
+    "benchmark": "node scripts/benchmark.js",
+    "pack:check": "npm run build && npm pack --dry-run",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "engines": {
+    "node": ">=20.19"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/akanshsirohi/QuadQR.git"
+  },
+  "bugs": {
+    "url": "https://github.com/akanshsirohi/QuadQR/issues"
+  },
+  "homepage": "https://github.com/akanshsirohi/QuadQR#readme",
+  "author": "Akansh Sirohi",
+  "license": "MIT",
+  "keywords": [
+    "quadqr",
+    "qr",
+    "rgb",
+    "rgbw",
+    "matrix-code",
+    "barcode",
+    "reed-solomon",
+    "ecc",
+    "scanner",
+    "camera-scanner",
+    "encryption",
+    "aes-gcm",
+    "wasm"
+  ],
+  "sideEffects": false
+}

package/types/benchmark.d.ts

@@ -0,0 +1,7 @@
+import type { EccLevel } from "./index.js";
+export const STANDARD_QR_BYTE_CAPACITY: Readonly<Record<EccLevel, readonly number[]>>;
+export function getStandardQrByteCapacity(version: number, ecc?: EccLevel): number;
+export function compareCapacity(version: number, ecc?: EccLevel): Record<string, number | string>;
+export function buildCapacityComparison(options?: { ecc?: EccLevel; versions?: number[] }): Array<Record<string, number | string>>;
+export function benchmarkCodec(options?: Record<string, unknown>): Record<string, unknown>;
+export function benchmarkReport(options?: Record<string, unknown>): string;

package/types/index.d.ts

@@ -0,0 +1,139 @@
+export type EccLevel = "L" | "M" | "Q" | "H";
+export type RenderStyle = "classic" | "depth" | "soft" | "inset";
+export type SecurityMode = "password" | "raw-key";
+
+export interface Palette {
+  black?: string;
+  white?: string;
+  red?: string;
+  green?: string;
+  blue?: string;
+}
+
+export interface EncodeOptions {
+  version?: number;
+  ecc?: EccLevel;
+  maskId?: number;
+  text?: boolean;
+}
+
+export interface PasswordSecurity {
+  mode: "password";
+  password: string;
+  iterations?: number;
+  keyId?: string | Uint8Array | false;
+}
+
+export interface RawKeySecurity {
+  mode: "raw-key";
+  key: string | Uint8Array | ArrayBuffer;
+  keyId?: string | Uint8Array | false;
+}
+
+export interface SecureEncodeOptions extends EncodeOptions {
+  security: PasswordSecurity | RawKeySecurity;
+}
+
+export interface QuadQRCode {
+  matrix: number[][];
+  version: number;
+  size: number;
+  formatVersion: number;
+  eccLevel: EccLevel;
+  payloadBytes: number;
+  capacityBytes: number;
+  secure?: boolean;
+  security?: SecurityMetadata | null;
+  [key: string]: unknown;
+}
+
+export interface SecurityMetadata {
+  securePayloadVersion?: number;
+  mode?: SecurityMode;
+  algorithm?: string;
+  kdf?: string | null;
+  iterations?: number | null;
+  keyId?: string | null;
+  keyIdHex?: string | null;
+  keyIdAuto?: boolean;
+  authenticated?: boolean;
+  decrypted?: boolean;
+  [key: string]: unknown;
+}
+
+export interface DecodeResult {
+  payload: Uint8Array;
+  text: string | null;
+  version: number;
+  size: number;
+  formatVersion: number;
+  eccLevel: EccLevel;
+  secure: boolean;
+  requiresDecryption?: boolean;
+  decrypted?: boolean;
+  security?: SecurityMetadata | null;
+  encryptedPayload?: Uint8Array;
+  [key: string]: unknown;
+}
+
+export interface ImageDataLike {
+  width: number;
+  height: number;
+  data: Uint8ClampedArray | Uint8Array;
+}
+
+export interface RenderOptions {
+  moduleSize?: number;
+  quietZone?: number;
+  palette?: Palette;
+  style?: RenderStyle;
+  [key: string]: unknown;
+}
+
+export interface ScanOptions {
+  minVersion?: number;
+  maxVersion?: number;
+  perspective?: boolean;
+  axisAlignedFallback?: boolean;
+  [key: string]: unknown;
+}
+
+export const FORMAT_VERSION: number;
+export const MIN_VERSION: number;
+export const MAX_VERSION: number;
+export const DEFAULT_ECC_LEVEL: EccLevel;
+export const CELL: Readonly<{ BLACK: -1; RED: 0; GREEN: 1; BLUE: 2; WHITE: 3 }>;
+export const DEFAULT_PALETTE: Readonly<Required<Palette>>;
+export const RENDER_STYLES: Readonly<Record<string, RenderStyle>>;
+export const ECC_LEVELS: Readonly<Record<EccLevel, { id: number; paritySymbols: number; correctableSymbolsPerBlock: number }>>;
+export const SECURITY_MODES: Readonly<{ PASSWORD: "password"; RAW_KEY: "raw-key" }>;
+export const SECURITY_ALGORITHMS: Readonly<{ AES_256_GCM: "AES-256-GCM" }>;
+export const SECURE_PAYLOAD_VERSION: number;
+export const DEFAULT_PBKDF2_ITERATIONS: number;
+
+export function encodeText(text: string, options?: EncodeOptions): QuadQRCode;
+export function encodeBytes(input: Uint8Array | ArrayBuffer | ArrayLike<number>, options?: EncodeOptions): QuadQRCode;
+export function encodeSecureText(text: string, options: SecureEncodeOptions): Promise<QuadQRCode>;
+export function encodeSecureBytes(input: Uint8Array | ArrayBuffer | ArrayLike<number>, options: SecureEncodeOptions): Promise<QuadQRCode>;
+export function decodeMatrix(matrix: number[][], options?: Record<string, unknown>): DecodeResult;
+export function decryptDecoded(result: DecodeResult, credentials: { password: string } | { key: string | Uint8Array | ArrayBuffer }): Promise<DecodeResult>;
+export function renderToCanvas(codeOrMatrix: QuadQRCode | number[][], canvas: HTMLCanvasElement, options?: RenderOptions): HTMLCanvasElement;
+export function renderToImageData(codeOrMatrix: QuadQRCode | number[][], options?: RenderOptions): ImageDataLike;
+export function scanImageData(imageData: ImageDataLike, options?: ScanOptions): DecodeResult;
+export function scanFile(file: Blob, options?: ScanOptions): Promise<DecodeResult>;
+export function scanVideoFrame(video: HTMLVideoElement, options?: ScanOptions): DecodeResult;
+export function startCameraScanner(video: HTMLVideoElement, options?: ScanOptions & { onDecode?: (result: DecodeResult) => void | Promise<void>; onError?: (error: Error) => void; scanInterval?: number; constraints?: MediaStreamConstraints }): Promise<{ stop(): void; scanNow(): DecodeResult; stream: MediaStream }>;
+export function rectifyDetectedCode(imageData: ImageDataLike, options?: Record<string, unknown>): ImageDataLike;
+export function rotateMatrix(matrix: number[][], quarterTurns?: number): number[][];
+export function getVersionInfo(version: number, options?: { ecc?: EccLevel }): Record<string, unknown>;
+export function crc32(bytes: Uint8Array): number;
+export function installCrc32Accelerator(accelerator?: ((bytes: Uint8Array) => number) | null): void;
+export function generateRaw256Key(): Uint8Array;
+export function normalizeRaw256Key(key: string | Uint8Array | ArrayBuffer): Uint8Array;
+export function bytesToHex(bytes: Uint8Array): string;
+
+export function initWasm(options?: { url?: string | URL; bytes?: Uint8Array | ArrayBuffer }): Promise<{ enabled: true; module: string; accelerators: readonly string[]; bytes: number }>;
+export function getWasmState(): { enabled: true; module: string; accelerators: readonly string[]; bytes: number } | null;
+export function disableWasm(): void;
+
+export const internals: Readonly<Record<string, unknown>>;

package/types/node.d.ts

@@ -0,0 +1,9 @@
+export * from "./index.js";
+import type { DecodeResult, ImageDataLike, QuadQRCode, RenderOptions, ScanOptions } from "./index.js";
+
+export function decodePNG(input: Uint8Array | ArrayBuffer): ImageDataLike;
+export function encodePNG(imageData: ImageDataLike, options?: { compressionLevel?: number }): Buffer;
+export function toPNG(codeOrMatrix: QuadQRCode | number[][], options?: RenderOptions & { compressionLevel?: number }): Buffer;
+export function savePNG(codeOrMatrix: QuadQRCode | number[][], filename: string | URL, options?: RenderOptions & { compressionLevel?: number }): Promise<{ filename: string | URL; bytes: number }>;
+export function scanBuffer(input: Uint8Array | ArrayBuffer, options?: ScanOptions): Promise<DecodeResult>;
+export function scanFile(filename: string | URL, options?: ScanOptions): Promise<DecodeResult>;