@twin.org/qr 0.0.1-next.1

package/dist/types/data/qrAlphaNumeric.d.ts

@@ -0,0 +1,23 @@
+import type { BitBuffer } from "../helpers/bitBuffer";
+import { QRDataBase } from "../models/qrDataBase";
+/**
+ * QR Data for representing a alpha numeric.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class QRAlphaNumeric extends QRDataBase {
+    /**
+     * Create a new instance of QRAlphaNumeric.
+     * @param data The data for the qr alpha numeric.
+     */
+    constructor(data: string);
+    /**
+     * Get the length of the data.
+     * @returns The length of the data.
+     */
+    getLength(): number;
+    /**
+     * Write data into the buffer.
+     * @param buffer The buffer to write into.
+     */
+    write(buffer: BitBuffer): void;
+}

package/dist/types/data/qrByte8.d.ts

@@ -0,0 +1,23 @@
+import type { BitBuffer } from "../helpers/bitBuffer";
+import { QRDataBase } from "../models/qrDataBase";
+/**
+ * QR Data for representing a 8 bit data.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class QRByte8 extends QRDataBase {
+    /**
+     * Create a new instance of QRByte8.
+     * @param data The data for the qr 8 bit data.
+     */
+    constructor(data: string);
+    /**
+     * Get the length of the data.
+     * @returns The length of the data.
+     */
+    getLength(): number;
+    /**
+     * Write data into the buffer.
+     * @param buffer The buffer to write into.
+     */
+    write(buffer: BitBuffer): void;
+}

package/dist/types/data/qrNumber.d.ts

@@ -0,0 +1,23 @@
+import type { BitBuffer } from "../helpers/bitBuffer";
+import { QRDataBase } from "../models/qrDataBase";
+/**
+ * QR Data for representing a number.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class QRNumber extends QRDataBase {
+    /**
+     * Create a new instance of QRNumber.
+     * @param data The data for the qr number.
+     */
+    constructor(data: string);
+    /**
+     * Get the length of the data.
+     * @returns The length of the data.
+     */
+    getLength(): number;
+    /**
+     * Write data into the buffer.
+     * @param buffer The buffer to write into.
+     */
+    write(buffer: BitBuffer): void;
+}

package/dist/types/helpers/bitBuffer.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Class for maintaining data bits.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class BitBuffer {
+    /**
+     * Create a new instance of BitBuffer.
+     */
+    constructor();
+    /**
+     * Get the buffer.
+     * @returns The buffer.
+     */
+    getBuffer(): number[];
+    /**
+     * Get the length in bits.
+     * @returns The length.
+     */
+    getLengthInBits(): number;
+    /**
+     * Put a value in to the bit buffer.
+     * @param num The value.
+     * @param length The length.
+     */
+    put(num: number, length: number): void;
+    /**
+     * Put a bit.
+     * @param bit The bit to put.
+     */
+    putBit(bit: boolean): void;
+    /**
+     * Convert to string.
+     * @returns The buffer as string.
+     */
+    toString(): string;
+}

package/dist/types/helpers/mathHelper.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Class to helper with math.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class MathHelper {
+    /**
+     * Initialize the math helper.
+     */
+    static initialize(): void;
+    /**
+     * Get the log of the value.
+     * @param value The value to get the log of.
+     * @returns The log of the value.
+     * @throws Error if value < 1.
+     */
+    static gLog(value: number): number;
+    /**
+     * Get the exponent of the value.
+     * @param value The value to get the exponent of.
+     * @returns The exponent of the value.
+     */
+    static gExp(value: number): number;
+}

package/dist/types/helpers/polynomial.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Class to represent a polynomial.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class Polynomial {
+    /**
+     * Create a new instance of Polynomial.
+     * @param num The num of the polynomial.
+     * @param shift The shift for the polynomial.
+     */
+    constructor(num: number[], shift?: number);
+    /**
+     * The the value of the polynomial at given index.
+     * @param index The index.
+     * @returns The value of the polynomial.
+     */
+    getAt(index: number): number;
+    /**
+     * Get the length of the polynomial.
+     * @returns The polynomial.
+     */
+    getLength(): number;
+    /**
+     * Convert the polynomial to a string.
+     * @returns The string representation of the polynomial.
+     */
+    toString(): string;
+    /**
+     * Get the log representation of the polynomial.
+     * @returns The log representation of the polynomial.
+     */
+    toLogString(): string;
+    /**
+     * Multiply the polynomial with another one.
+     * @param e The polynomial to multiply.
+     * @returns The multiplication of the polynomials.
+     */
+    multiply(e: Polynomial): Polynomial;
+    /**
+     * Get the modulus of the polynomial from another.
+     * @param e The polynomial.
+     * @returns The modules of the polynomials.
+     */
+    mod(e: Polynomial): Polynomial;
+}

package/dist/types/helpers/qrHelper.d.ts

@@ -0,0 +1,49 @@
+import { Polynomial } from "./polynomial";
+import { ErrorCorrectLevel } from "../models/errorCorrectLevel";
+import { QRDataMode } from "../models/qrDataMode";
+/**
+ * Helper methods for QR generation.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class QRHelper {
+    /**
+     * Get the pattern position for the given type number.
+     * @param typeNumber The type number to get the pattern for.
+     * @returns The pattern for the type number.
+     */
+    static getPatternPosition(typeNumber: number): number[];
+    /**
+     * Get the max length of the data.
+     * @param typeNumber The type number to get the max length for.
+     * @param mode The data mode to get data max length for.
+     * @param errorCorrectLevel The error correction to get the max length for.
+     * @returns The max length.
+     * @throws Error with unknown correction level.
+     */
+    static getMaxLength(typeNumber: number, mode: QRDataMode, errorCorrectLevel: ErrorCorrectLevel): number;
+    /**
+     * Get the error correction polynomial for the error correct to length.
+     * @param errorCorrectLength The error correction length to get the polynomial for.
+     * @returns The polynomial for the error correction length.
+     */
+    static getErrorCorrectPolynomial(errorCorrectLength: number): Polynomial;
+    /**
+     * Get the mask method for the given pattern.
+     * @param maskPattern The pattern to get the mask for.
+     * @returns The mask method for the pattern.
+     * @throws Error with invalid mask.
+     */
+    static getMaskMethod(maskPattern: number): (i: number, j: number) => boolean;
+    /**
+     * Get the BCH type info.
+     * @param data The data to get the BCH type info for.
+     * @returns The type info.
+     */
+    static getBCHTypeInfo(data: number): number;
+    /**
+     * Get the BCH type number.
+     * @param data The data to get the BCH type number for.
+     * @returns The type number.
+     */
+    static getBCHTypeNumber(data: number): number;
+}

package/dist/types/helpers/rsBlock.d.ts

@@ -0,0 +1,30 @@
+import { ErrorCorrectLevel } from "../models/errorCorrectLevel";
+/**
+ * Class to represent a RS Block.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class RSBlock {
+    /**
+     * Create a new instance of RSBlock.
+     * @param totalCount The total count for the block.
+     * @param dataCount The data count for the block.
+     */
+    constructor(totalCount: number, dataCount: number);
+    /**
+     * Get RS Blocks for the type number and error correct level.
+     * @param typeNumber The type number.
+     * @param errorCorrectLevel The error correct level.
+     * @returns The RS Blocks.
+     */
+    static getRSBlocks(typeNumber: number, errorCorrectLevel: ErrorCorrectLevel): RSBlock[];
+    /**
+     * Get the data count of the block.
+     * @returns The data count.
+     */
+    getDataCount(): number;
+    /**
+     * Get the total count of blocks.
+     * @returns The total count.
+     */
+    getTotalCount(): number;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./models/errorCorrectLevel";
+export * from "./models/IBitmapRendererOptions";
+export * from "./models/IRendererOptions";
+export * from "./models/ITextRendererOptions";
+export * from "./models/qrCellData";
+export * from "./qr";
+export * from "./renderers/jpegRenderer";
+export * from "./renderers/pngRenderer";
+export * from "./renderers/textRenderer";

package/dist/types/models/IBitmapRendererOptions.d.ts

@@ -0,0 +1,15 @@
+import type { Color } from "@twin.org/image";
+import type { IRendererOptions } from "./IRendererOptions";
+/**
+ * Options for rendering.
+ */
+export interface IBitmapRendererOptions extends IRendererOptions {
+    /**
+     * Background color.
+     */
+    background?: Color | string;
+    /**
+     * Foreground color.
+     */
+    foreground?: Color | string;
+}

package/dist/types/models/IRendererOptions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Options for rendering.
+ */
+export interface IRendererOptions {
+    /**
+     * The cell size.
+     */
+    cellSize?: number;
+    /**
+     * The margin size.
+     */
+    marginSize?: number;
+}

package/dist/types/models/ITextRendererOptions.d.ts

@@ -0,0 +1,14 @@
+import type { IRendererOptions } from "./IRendererOptions";
+/**
+ * Options for rendering as text.
+ */
+export interface ITextRendererOptions extends IRendererOptions {
+    /**
+     * The character to use for on pixels.
+     */
+    onChar?: string;
+    /**
+     * The character to use for off pixels.
+     */
+    offChar?: string;
+}

package/dist/types/models/errorCorrectLevel.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Error correction level to use for the QR Code.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare const ErrorCorrectLevel: {
+    /**
+     * 7% Error correction.
+     */
+    readonly L: 1;
+    /**
+     * 15% Error correction.
+     */
+    readonly M: 0;
+    /**
+     * 25% Error correction.
+     */
+    readonly Q: 3;
+    /**
+     * 30% Error correction.
+     */
+    readonly H: 2;
+};
+/**
+ * Error correction level to use for the QR Code.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export type ErrorCorrectLevel = (typeof ErrorCorrectLevel)[keyof typeof ErrorCorrectLevel];

package/dist/types/models/maskPattern.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Mask patterns for QR codes.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare const MaskPattern: {
+    /**
+     * Mask pattern 000.
+     */
+    readonly PATTERN000: 0;
+    /**
+     * Mask pattern 001.
+     */
+    readonly PATTERN001: 1;
+    /**
+     * Mask pattern 010.
+     */
+    readonly PATTERN010: 2;
+    /**
+     * Mask pattern 011.
+     */
+    readonly PATTERN011: 3;
+    /**
+     * Mask pattern 100.
+     */
+    readonly PATTERN100: 4;
+    /**
+     * Mask pattern 101.
+     */
+    readonly PATTERN101: 5;
+    /**
+     * Mask pattern 110.
+     */
+    readonly PATTERN110: 6;
+    /**
+     * Mask pattern 111.
+     */
+    readonly PATTERN111: 7;
+};
+/**
+ * Mask patterns for QR codes.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export type MaskPattern = (typeof MaskPattern)[keyof typeof MaskPattern];

package/dist/types/models/qrCellData.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Definition of type for QR Code Cell data.
+ */
+export type QRCellData = (boolean | null)[][];

package/dist/types/models/qrDataBase.d.ts

@@ -0,0 +1,42 @@
+import { QRDataMode } from "./qrDataMode";
+import type { BitBuffer } from "../helpers/bitBuffer";
+/**
+ * Base class for storing QR Data.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare abstract class QRDataBase {
+    /**
+     * Create a new instance of QRDataBase.
+     * @param className The class name for the derived class.
+     * @param mode The mode for the data.
+     * @param data The data.
+     */
+    constructor(className: string, mode: QRDataMode, data: string);
+    /**
+     * Get the data mode.
+     * @returns The data mode.
+     */
+    getMode(): QRDataMode;
+    /**
+     * Get the data for the qr.
+     * @returns The data.
+     */
+    getData(): string;
+    /**
+     * Get the length in bits of the data.
+     * @param typeNumber The type number to get the length for.
+     * @returns The length in bits.
+     * @throws Error if the typeNumber if invalid.
+     */
+    getLengthInBits(typeNumber: number): number;
+    /**
+     * Get the length of the data.
+     * @returns The length of the data.
+     */
+    abstract getLength(): number;
+    /**
+     * Write data into the buffer.
+     * @param buffer The buffer to write into.
+     */
+    abstract write(buffer: BitBuffer): void;
+}

package/dist/types/models/qrDataMode.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The mode for the qr data.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare const QRDataMode: {
+    /**
+     * Number.
+     */
+    readonly Number: 1;
+    /**
+     * Alphabet and number.
+     */
+    readonly AlphaNumeric: 2;
+    /**
+     * 8bit byte.
+     */
+    readonly Byte8: 4;
+};
+/**
+ * The mode for the qr data.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export type QRDataMode = (typeof QRDataMode)[keyof typeof QRDataMode];

package/dist/types/qr.d.ts

@@ -0,0 +1,35 @@
+import { ErrorCorrectLevel } from "./models/errorCorrectLevel";
+import type { QRCellData } from "./models/qrCellData";
+/**
+ * Class to generates QR codes from data.
+ * Based on https://github.com/kazuhikoarase/qrcode-generator/ .
+ */
+export declare class QR {
+    /**
+     * Create a new instance of QR.
+     * @param typeNumber 0 to 40, 0 means autodetect.
+     * @param errorCorrectLevel 'L','M','Q','H'.
+     * @throws Error if the typeNumber is invalid.
+     */
+    constructor(typeNumber?: number, errorCorrectLevel?: ErrorCorrectLevel);
+    /**
+     * Add text data to the QR Code.
+     * @param qrData The data to add.
+     */
+    addText(qrData: string): void;
+    /**
+     * Add number to the QR Code.
+     * @param qrData The data to add.
+     */
+    addNumber(qrData: string): void;
+    /**
+     * Add alpha numeric to the QR Code.
+     * @param qrData The data to add.
+     */
+    addAlphaNumeric(qrData: string): void;
+    /**
+     * Generate the display buffer.
+     * @returns Boolean buffer of pixels.
+     */
+    generate(): QRCellData;
+}

package/dist/types/renderers/jpegRenderer.d.ts

@@ -0,0 +1,14 @@
+import type { IBitmapRendererOptions } from "../models/IBitmapRendererOptions";
+import type { QRCellData } from "../models/qrCellData";
+/**
+ * Class to render qr data as jpeg.
+ */
+export declare class JpegRenderer {
+    /**
+     * Render the QR code data as a bitmap.
+     * @param cellData The cell data for the QR code.
+     * @param options The options for rendering.
+     * @returns The bitmap content.
+     */
+    static render(cellData: QRCellData, options?: IBitmapRendererOptions): Promise<Uint8Array>;
+}

package/dist/types/renderers/pngRenderer.d.ts

@@ -0,0 +1,14 @@
+import type { IBitmapRendererOptions } from "../models/IBitmapRendererOptions";
+import type { QRCellData } from "../models/qrCellData";
+/**
+ * Class to render qr data as png.
+ */
+export declare class PngRenderer {
+    /**
+     * Render the QR code data as a bitmap.
+     * @param cellData The cell data for the QR code.
+     * @param options The options for rendering.
+     * @returns The bitmap content.
+     */
+    static render(cellData: QRCellData, options?: IBitmapRendererOptions): Promise<Uint8Array>;
+}

package/dist/types/renderers/textRenderer.d.ts

@@ -0,0 +1,14 @@
+import type { ITextRendererOptions } from "../models/ITextRendererOptions";
+import type { QRCellData } from "../models/qrCellData";
+/**
+ * Class to render qr data as text.
+ */
+export declare class TextRenderer {
+    /**
+     * Render the QR code data as text.
+     * @param cellData The cell data for the QR code.
+     * @param options The options for rendering.
+     * @returns The text content.
+     */
+    static render(cellData: QRCellData, options?: ITextRendererOptions): Promise<string>;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/qr - Changelog
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/qr - Examples

package/docs/reference/classes/JpegRenderer.md

@@ -0,0 +1,37 @@
+# Class: JpegRenderer
+
+Class to render qr data as jpeg.
+
+## Constructors
+
+### new JpegRenderer()
+
+> **new JpegRenderer**(): [`JpegRenderer`](JpegRenderer.md)
+
+#### Returns
+
+[`JpegRenderer`](JpegRenderer.md)
+
+## Methods
+
+### render()
+
+> `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\>
+
+Render the QR code data as a bitmap.
+
+#### Parameters
+
+• **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
+
+The cell data for the QR code.
+
+• **options?**: [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
+
+The options for rendering.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+The bitmap content.

package/docs/reference/classes/PngRenderer.md

@@ -0,0 +1,37 @@
+# Class: PngRenderer
+
+Class to render qr data as png.
+
+## Constructors
+
+### new PngRenderer()
+
+> **new PngRenderer**(): [`PngRenderer`](PngRenderer.md)
+
+#### Returns
+
+[`PngRenderer`](PngRenderer.md)
+
+## Methods
+
+### render()
+
+> `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\>
+
+Render the QR code data as a bitmap.
+
+#### Parameters
+
+• **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
+
+The cell data for the QR code.
+
+• **options?**: [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
+
+The options for rendering.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+The bitmap content.