@opentui/qrcode 0.0.0-20260528-8a59fd68

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./lib/qrcode.js";
+export * from "./renderables/QRCode.js";

package/index.js

@@ -0,0 +1,22 @@
+// @bun
+import {
+  EciAssignment,
+  ErrorCorrectionLevel,
+  QRCode,
+  QRCodeRenderable,
+  QrSegment,
+  createQrSvg,
+  encodeTextBytes
+} from "./chunk-p6dynys3.js";
+export {
+  encodeTextBytes,
+  createQrSvg,
+  QrSegment,
+  QRCodeRenderable,
+  QRCode,
+  ErrorCorrectionLevel,
+  EciAssignment
+};
+
+//# debugId=B3F12B4C1D75482564756E2164756E21
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1,9 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [
+  ],
+  "mappings": "",
+  "debugId": "B3F12B4C1D75482564756E2164756E21",
+  "names": []
+}

package/lib/qrcode.d.ts

@@ -0,0 +1,183 @@
+import { type ByteEncoding } from "./qrcode.encoding.js";
+import { type TerminalRenderOptions } from "./qrcode.render.js";
+export { EciAssignment, encodeTextBytes, type ByteEncoding } from "./qrcode.encoding.js";
+export type { TerminalRenderOptions } from "./qrcode.render.js";
+export declare enum ErrorCorrectionLevel {
+    /** Recovers about 7% data damage. QR format bits: 01. */
+    L = "L",
+    /** Recovers about 15% data damage. QR format bits: 00. */
+    M = "M",
+    /** Recovers about 25% data damage. QR format bits: 11. */
+    Q = "Q",
+    /** Recovers about 30% data damage. QR format bits: 10. */
+    H = "H"
+}
+export interface StructuredAppendInfo {
+    /** 1-based position of this symbol in the structured append sequence. */
+    position: number;
+    /** Total number of symbols in the structured append sequence, 2..16. */
+    total: number;
+    /** 8-bit parity value, normally computed with QRCode.computeStructuredAppendParity(). */
+    parity: number;
+}
+export interface Fnc1SecondPositionInfo {
+    /** Two decimal digits, a number 0..99, or one Latin alphabetic character. */
+    applicationIndicator: string | number;
+}
+export interface EncodeOptions {
+    /** Minimum QR Code Model 2 version, inclusive. Default: 1. */
+    minVersion?: number;
+    /** Maximum QR Code Model 2 version, inclusive. Default: 40. */
+    maxVersion?: number;
+    /** Force QR mask pattern 0..7. Default: auto-select by penalty score. */
+    mask?: number;
+    /** Upgrade ECC level if the data still fits in the selected version. Default: true. */
+    boostEcl?: boolean;
+    /** Use DP mixed-mode optimization for text. Default: true. */
+    optimize?: boolean;
+    /** Allow Kanji mode for characters encodable in Shift JIS Kanji ranges. Default: false. */
+    kanji?: boolean;
+    /** Byte-segment character encoding for text fallback. Default: utf-8. */
+    byteEncoding?: ByteEncoding;
+    /** Prefix UTF-8 byte-mode text with ECI assignment 26. Default: true when byteEncoding is utf-8. */
+    eciForUtf8?: boolean;
+    /** Override the ECI assignment emitted before byte segments; set null to suppress ECI. */
+    eciAssignment?: number | null;
+    /** Insert FNC1 in first position immediately after any structured append/ECI header. */
+    fnc1First?: boolean;
+    /** Insert FNC1 in second position immediately after any structured append/ECI header. */
+    fnc1Second?: Fnc1SecondPositionInfo;
+    /** Insert a structured append header at the start of the symbol. */
+    structuredAppend?: StructuredAppendInfo;
+}
+export interface Gs1Element {
+    /** Application identifier, e.g. "01", "17", "10". Parentheses are not encoded. */
+    ai: string;
+    /** Element-string data. */
+    data: string;
+    /** Add a FNC1 field separator after this element. Do not set on the last element. */
+    separatorAfter?: boolean;
+}
+declare class BitBuffer {
+    private readonly bits;
+    get length(): number;
+    appendBits(value: number, bitCount: number): void;
+    appendData(other: BitBuffer): void;
+    getBit(index: number): number;
+    toBytes(): number[];
+}
+declare class Mode {
+    readonly name: string;
+    readonly modeBits: number;
+    private readonly charCountBitsForVersionRange;
+    readonly hasCharacterCount: boolean;
+    static readonly NUMERIC: Mode;
+    static readonly ALPHANUMERIC: Mode;
+    static readonly BYTE: Mode;
+    static readonly KANJI: Mode;
+    static readonly ECI: Mode;
+    static readonly STRUCTURED_APPEND: Mode;
+    static readonly FNC1_FIRST: Mode;
+    static readonly FNC1_SECOND: Mode;
+    private constructor();
+    numCharCountBits(version: number): number;
+}
+export declare class QrSegment {
+    readonly mode: Mode;
+    readonly numChars: number;
+    readonly data: BitBuffer;
+    readonly parityBytes: readonly number[];
+    private static readonly ALPHANUMERIC_CHARSET;
+    private constructor();
+    static makeNumeric(digits: string): QrSegment;
+    static makeAlphanumeric(text: string): QrSegment;
+    static makeBytes(bytes: Uint8Array | number[]): QrSegment;
+    static makeBytesFromText(text: string, encoding?: ByteEncoding): QrSegment;
+    static makeKanji(text: string): QrSegment;
+    static makeKanjiFromShiftJis(bytes: Uint8Array | number[]): QrSegment;
+    static makeEci(assignVal: number): QrSegment;
+    static makeStructuredAppendHeader(position: number, total: number, parity: number): QrSegment;
+    static makeFnc1FirstPosition(): QrSegment;
+    static makeFnc1SecondPosition(applicationIndicator: string | number): QrSegment;
+    static isNumeric(text: string): boolean;
+    static isAlphanumeric(text: string): boolean;
+    static isKanji(text: string): boolean;
+    static makeSegments(text: string, options?: Pick<EncodeOptions, "eciForUtf8" | "kanji" | "byteEncoding" | "eciAssignment">): QrSegment[];
+    static makeOptimizedSegments(text: string, version: number, options?: Pick<EncodeOptions, "eciForUtf8" | "kanji" | "byteEncoding" | "eciAssignment">): QrSegment[];
+    static makeEciSegmentsFromEscapedText(escapedText: string, options?: {
+        defaultEncoding?: ByteEncoding;
+        defaultEci?: number | null;
+    }): QrSegment[];
+    getTotalBits(version: number): number;
+    private static addEciIfNeeded;
+    private static makeOptimizedSegmentsInternal;
+}
+export declare class QRCode {
+    readonly version: number;
+    readonly errorCorrectionLevel: ErrorCorrectionLevel;
+    readonly mask: number;
+    private static readonly MIN_VERSION;
+    private static readonly MAX_VERSION;
+    private static readonly ECC_CODEWORDS_PER_BLOCK;
+    private static readonly NUM_ERROR_CORRECTION_BLOCKS;
+    private static readonly FORMAT_BITS_BY_ECL;
+    private static readonly ECL_ORDER;
+    readonly size: number;
+    readonly symbologyIdentifier: string;
+    readonly containsEci: boolean;
+    readonly fnc1: "none" | "first" | "second";
+    private readonly modules;
+    private readonly functionModules;
+    private constructor();
+    static encodeText(text: string, ecl?: ErrorCorrectionLevel, options?: EncodeOptions): QRCode;
+    static encodeBytes(bytes: Uint8Array | number[], ecl?: ErrorCorrectionLevel, options?: EncodeOptions): QRCode;
+    static encodeEciText(escapedText: string, ecl?: ErrorCorrectionLevel, options?: EncodeOptions): QRCode;
+    static encodeGs1Text(gs1Data: string | Gs1Element[], ecl?: ErrorCorrectionLevel, options?: EncodeOptions): QRCode;
+    static encodeStructuredAppend(parts: readonly (readonly QrSegment[])[], ecl?: ErrorCorrectionLevel, options?: EncodeOptions): QRCode[];
+    static computeStructuredAppendParity(segments: readonly QrSegment[]): number;
+    static encodeSegments(segments: QrSegment[], ecl?: ErrorCorrectionLevel, options?: EncodeOptions): QRCode;
+    getModule(x: number, y: number): boolean;
+    /** Returns a deep copy of the QR module matrix. True is dark, false is light. */
+    toMatrix(): boolean[][];
+    /** Render as SVG. The border is the quiet zone in modules; ISO QR Code requires at least 4. */
+    toSvgString(options?: {
+        border?: number;
+        moduleSize?: number;
+        lightColor?: string;
+        darkColor?: string;
+    }): string;
+    /**
+     * Render as terminal text. Default quiet zone is 4 modules, matching the QR Code minimum.
+     * Use { ansi: true } for scanner-facing terminal output with explicit black/white backgrounds.
+     */
+    toTerminalString(options?: number | TerminalRenderOptions): string;
+    static validateVersionPublic(version: number): void;
+    private static applyPrefixSegments;
+    private static validateQrSegmentOrder;
+    private static collectMetadata;
+    private static makeSymbologyIdentifier;
+    private static makeWithBestMask;
+    private drawFunctionPatterns;
+    private drawFinderPattern;
+    private drawAlignmentPattern;
+    private drawFormatBits;
+    private drawVersionBits;
+    private drawCodewords;
+    private applyMask;
+    private getPenaltyScore;
+    private addEccAndInterleave;
+    private getAlignmentPatternPositions;
+    private setFunctionModule;
+    private static getTotalBits;
+    private static getNumDataCodewords;
+    private static getNumRawDataModules;
+    static maskCondition(mask: number, x: number, y: number): boolean;
+    private static eclIndex;
+    private static validateVersion;
+    private static validateMask;
+}
+export declare function createQrSvg(text: string, options?: EncodeOptions & {
+    ecl?: ErrorCorrectionLevel;
+    border?: number;
+    moduleSize?: number;
+}): string;

package/lib/qrcode.encoding.d.ts

@@ -0,0 +1,12 @@
+export type ByteEncoding = "utf-8" | "iso-8859-1" | "shift-jis";
+export declare const EciAssignment: {
+    readonly ISO_8859_1: 3;
+    readonly SHIFT_JIS: 20;
+    readonly UTF_8: 26;
+};
+export declare function encodeTextBytes(text: string, encoding?: ByteEncoding): Uint8Array;
+export declare function shiftJisCodeForCharacter(ch: string): number;
+export declare function isKanjiModeShiftJisValue(value: number): boolean;
+export declare function encodingForKnownEci(eci: number): ByteEncoding | null;
+export declare function validateBytes(bytes: number[]): number[];
+export declare function asciiBytes(text: string): number[];

package/lib/qrcode.render.d.ts

@@ -0,0 +1,19 @@
+export interface TerminalRenderOptions {
+    /** Quiet zone in modules. ISO requires at least 4 for QR Code. */
+    border?: number;
+    /**
+     * Render using ANSI background colors. Recommended when a real scanner will read the terminal.
+     * The ANSI renderer paints light modules white and dark modules black independent of terminal theme.
+     */
+    ansi?: boolean;
+    /** Swap light and dark output. Leave false for normal black-on-white scanner-facing output. */
+    invert?: boolean;
+}
+export interface NormalizedTerminalRenderOptions {
+    border: number;
+    ansi: boolean;
+    invert: boolean;
+}
+export declare function matrixToSvg(matrix: boolean[][], border: number, minimumBorder: number, moduleSize: number, lightColor: string, darkColor: string): string;
+export declare function normalizeTerminalOptions(options: number | TerminalRenderOptions, defaultBorder: number, minimumBorder: number): NormalizedTerminalRenderOptions;
+export declare function matrixToTerminal(matrix: boolean[][], options: NormalizedTerminalRenderOptions): string;

package/lib/qrcode.shift-jis.d.ts

@@ -0,0 +1 @@
+export declare const SHIFT_JIS_CODE_BY_CHAR: Record<string, number>;

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@opentui/qrcode",
+  "module": "index.js",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "type": "module",
+  "version": "0.0.0-20260528-8a59fd68",
+  "description": "QR code encoder and renderable for OpenTUI",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anomalyco/opentui",
+    "directory": "packages/qrcode"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.js",
+      "types": "./index.d.ts"
+    },
+    "./react": {
+      "import": "./react.js",
+      "require": "./react.js",
+      "types": "./react.d.ts"
+    },
+    "./solid": {
+      "import": "./solid.js",
+      "require": "./solid.js",
+      "types": "./solid.d.ts"
+    }
+  },
+  "dependencies": {
+    "@opentui/core": "0.0.0-20260528-8a59fd68",
+    "yoga-layout": "3.2.1"
+  },
+  "devDependencies": {
+    "@opentui/react": "workspace:*",
+    "@opentui/solid": "workspace:*",
+    "@types/bun": "latest",
+    "@types/node": "^24.0.0",
+    "typescript": "^5"
+  },
+  "peerDependencies": {
+    "@opentui/react": "0.0.0-20260528-8a59fd68",
+    "@opentui/solid": "0.0.0-20260528-8a59fd68"
+  },
+  "peerDependenciesMeta": {
+    "@opentui/react": {
+      "optional": true
+    },
+    "@opentui/solid": {
+      "optional": true
+    }
+  }
+}

package/react.d.ts

@@ -0,0 +1,8 @@
+import { QRCodeRenderable } from "./renderables/QRCode.js";
+declare module "@opentui/react" {
+    interface OpenTUIComponents {
+        "qr-code": typeof QRCodeRenderable;
+    }
+}
+export declare function registerQRCode(): void;
+export * from "./index.js";

package/react.js

@@ -0,0 +1,29 @@
+// @bun
+import {
+  EciAssignment,
+  ErrorCorrectionLevel,
+  QRCode,
+  QRCodeRenderable,
+  QrSegment,
+  createQrSvg,
+  encodeTextBytes
+} from "./chunk-p6dynys3.js";
+
+// src/react.ts
+import { extend } from "@opentui/react";
+function registerQRCode() {
+  extend({ "qr-code": QRCodeRenderable });
+}
+export {
+  registerQRCode,
+  encodeTextBytes,
+  createQrSvg,
+  QrSegment,
+  QRCodeRenderable,
+  QRCode,
+  ErrorCorrectionLevel,
+  EciAssignment
+};
+
+//# debugId=DDFCE424C87C54B764756E2164756E21
+//# sourceMappingURL=react.js.map

package/react.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/react.ts"],
+  "sourcesContent": [
+    "import { extend } from \"@opentui/react\"\nimport { QRCodeRenderable } from \"./renderables/QRCode.js\"\n\ndeclare module \"@opentui/react\" {\n  interface OpenTUIComponents {\n    \"qr-code\": typeof QRCodeRenderable\n  }\n}\n\nexport function registerQRCode(): void {\n  extend({ \"qr-code\": QRCodeRenderable })\n}\n\nexport * from \"./index.js\"\n"
+  ],
+  "mappings": ";;;;;;;;;;;;AAAA;AASO,SAAS,cAAc,GAAS;AAAA,EACrC,OAAO,EAAE,WAAW,iBAAiB,CAAC;AAAA;",
+  "debugId": "DDFCE424C87C54B764756E2164756E21",
+  "names": []
+}

package/renderables/QRCode.d.ts

@@ -0,0 +1,99 @@
+import { OptimizedBuffer, RGBA, Renderable, type ColorInput, type RenderableOptions, type RenderContext } from "@opentui/core";
+import { ErrorCorrectionLevel, QRCode } from "../lib/qrcode.js";
+export type QRCodeFitMode = "contain" | "none";
+interface EncodedQRCode<TVersion extends number> {
+    readonly version: TVersion;
+    readonly size: number;
+    toMatrix(): boolean[][];
+}
+interface QRCodeSharedOptions<TRenderable extends Renderable, TEcl> extends RenderableOptions<TRenderable> {
+    content?: string;
+    errorCorrectionLevel?: TEcl;
+    quietZone?: number;
+    scale?: number;
+    fit?: QRCodeFitMode;
+    foregroundColor?: ColorInput;
+    backgroundColor?: ColorInput;
+    fallbackContent?: string;
+    fallbackColor?: ColorInput;
+}
+export interface QRCodeOptions extends QRCodeSharedOptions<QRCodeRenderable, ErrorCorrectionLevel> {
+}
+interface QRCodeRenderableDefaults<TEcl> {
+    content: string;
+    errorCorrectionLevel: TEcl;
+    quietZone: number;
+    scale: number;
+    fit: QRCodeFitMode;
+    foregroundColor: RGBA;
+    backgroundColor: RGBA;
+    fallbackContent: string;
+    fallbackColor: RGBA;
+}
+declare abstract class BaseQRCodeRenderable<TEcl, TVersion extends number, TEncoded extends EncodedQRCode<TVersion>> extends Renderable {
+    private readonly minimumQuietZone;
+    private readonly encodeContent;
+    private _content;
+    private _errorCorrectionLevel;
+    private _quietZone;
+    private _scale;
+    private _fit;
+    private _foregroundColor;
+    private _backgroundColor;
+    private _fallbackContent;
+    private _fallbackColor;
+    private encoded;
+    private modules;
+    private renderBuffer;
+    private renderBufferDirty;
+    protected constructor(ctx: RenderContext, options: QRCodeSharedOptions<any, TEcl>, defaults: QRCodeRenderableDefaults<TEcl>, minimumQuietZone: number, encodeContent: (content: string, errorCorrectionLevel: TEcl) => TEncoded);
+    get content(): string;
+    set content(value: string);
+    get errorCorrectionLevel(): TEcl;
+    set errorCorrectionLevel(value: TEcl);
+    get quietZone(): number;
+    set quietZone(value: number);
+    get scale(): number;
+    set scale(value: number);
+    get fit(): QRCodeFitMode;
+    set fit(value: QRCodeFitMode);
+    get foregroundColor(): RGBA;
+    set foregroundColor(value: ColorInput);
+    get backgroundColor(): RGBA;
+    set backgroundColor(value: ColorInput);
+    get fallbackContent(): string;
+    set fallbackContent(value: string);
+    get fallbackColor(): RGBA;
+    set fallbackColor(value: ColorInput);
+    get version(): TVersion;
+    get moduleCount(): number;
+    protected renderSelf(buffer: OptimizedBuffer): void;
+    protected onResize(width: number, height: number): void;
+    protected destroySelf(): void;
+    private paintRenderBuffer;
+    private rebuildMatrix;
+    private remeasure;
+    private invalidateRenderBuffer;
+    private getRenderBuffer;
+    private setupMeasureFunc;
+    private resolveMeasuredScale;
+    private resolveRenderScale;
+    private resolveScaleForBounds;
+    private isDarkAtScaledPixel;
+    private paintFallback;
+}
+export declare class QRCodeRenderable extends BaseQRCodeRenderable<ErrorCorrectionLevel, number, QRCode> {
+    protected static readonly _defaultOptions: {
+        content: string;
+        errorCorrectionLevel: ErrorCorrectionLevel.M;
+        quietZone: number;
+        scale: number;
+        fit: QRCodeFitMode;
+        foregroundColor: RGBA;
+        backgroundColor: RGBA;
+        fallbackContent: string;
+        fallbackColor: RGBA;
+    };
+    constructor(ctx: RenderContext, options?: QRCodeOptions);
+}
+export {};

package/solid.d.ts

@@ -0,0 +1,8 @@
+import { QRCodeRenderable } from "./renderables/QRCode.js";
+declare module "@opentui/solid" {
+    interface OpenTUIComponents {
+        qr_code: typeof QRCodeRenderable;
+    }
+}
+export declare function registerQRCode(): void;
+export * from "./index.js";

package/solid.js

@@ -0,0 +1,29 @@
+// @bun
+import {
+  EciAssignment,
+  ErrorCorrectionLevel,
+  QRCode,
+  QRCodeRenderable,
+  QrSegment,
+  createQrSvg,
+  encodeTextBytes
+} from "./chunk-p6dynys3.js";
+
+// src/solid.ts
+import { extend } from "@opentui/solid/components";
+function registerQRCode() {
+  extend({ qr_code: QRCodeRenderable });
+}
+export {
+  registerQRCode,
+  encodeTextBytes,
+  createQrSvg,
+  QrSegment,
+  QRCodeRenderable,
+  QRCode,
+  ErrorCorrectionLevel,
+  EciAssignment
+};
+
+//# debugId=7BC890A66B23EA5864756E2164756E21
+//# sourceMappingURL=solid.js.map

package/solid.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/solid.ts"],
+  "sourcesContent": [
+    "import { extend } from \"@opentui/solid/components\"\nimport { QRCodeRenderable } from \"./renderables/QRCode.js\"\n\ndeclare module \"@opentui/solid\" {\n  interface OpenTUIComponents {\n    qr_code: typeof QRCodeRenderable\n  }\n}\n\nexport function registerQRCode(): void {\n  extend({ qr_code: QRCodeRenderable })\n}\n\nexport * from \"./index.js\"\n"
+  ],
+  "mappings": ";;;;;;;;;;;;AAAA;AASO,SAAS,cAAc,GAAS;AAAA,EACrC,OAAO,EAAE,SAAS,iBAAiB,CAAC;AAAA;",
+  "debugId": "7BC890A66B23EA5864756E2164756E21",
+  "names": []
+}