@levischuck/tiny-qr 0.0.1

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Levi Schuck, 2025 kennytm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+# tiny-qr
+
+A minimal, dependency-free TypeScript QR code encoder.
+
+## Usage
+
+```typescript
+import { qrCode, EcLevel } from '@levischuck/tiny-qr';
+
+// Create a QR code with default settings (Medium error correction)
+const qr = qrCode({ data: 'HELLO WORLD' });
+
+// With custom error correction level
+const qrHighEc = qrCode({ data: 'HELLO WORLD', ec: EcLevel.H });
+
+// Encode binary data
+const qrBinary = qrCode({ data: new Uint8Array([0x01, 0x02, 0x03]) });
+
+// Access the result
+console.log('Size:', qr.width);
+console.log('Version:', qr.version);
+
+// Matrix is a 2D boolean array (true = dark, false = light)
+for (let y = 0; y < qr.width; y++) {
+  for (let x = 0; x < qr.width; x++) {
+    const isDark = qr.matrix[y][x];
+  }
+}
+```
+
+This package is intended to be chained with other tiny-packages for rendering:
+
+- `@levischuck/tiny-qr-svg` - SVG output
+- `@levischuck/tiny-qr-png` - PNG output
+
+If you're looking to manually render from the modules,
+the result contains a `boolean[][]` matrix.
+
+## API
+
+### `qrCode(options: QrOptions): QrResult`
+
+Generates a QR code from the given data.
+
+**Options:**
+- `data: string | Uint8Array` - The data to encode
+- `ec?: EcLevel` - Error correction level (default: `EcLevel.M`)
+
+**Result:**
+- `matrix: boolean[][]` - 2D array of modules (true = dark, false = light)
+- `width: number` - Width/height of the QR code in modules
+- `version: Version` - QR code version (1-40)
+- `ec: EcLevel` - Error correction level used
+  - `EcLevel.L` or `0`
+  - `EcLevel.M` or `1`
+  - `EcLevel.Q` or `2`
+  - `EcLevel.H` or `3`
+
+## Rendering
+
+## License
+
+MIT Licensed.
+
+This code is largely derived from [qrcode-rust](https://github.com/kennytm/qrcode-rust) by kennytm, which provides an MIT and Apache 2 license to its code.

package/dist/bits.d.ts

@@ -0,0 +1,22 @@
+import { EcLevel, Version } from './types.ts';
+import { Segment } from './optimize.ts';
+/** The Bits state stores the encoded data for a QR code */
+export interface BitsState {
+    readonly data: number[];
+    readonly bitOffset: number;
+    readonly version: Version;
+}
+/** Creates a new bits state */
+export declare function createBits(version: Version): BitsState;
+/** Gets the version from bits state */
+export declare function bitsVersion(bits: BitsState): Version;
+/** Convert the bits into a bytes array */
+export declare function bitsIntoBytes(bits: BitsState): Uint8Array;
+/** Pushes terminator and padding */
+export declare function bitsPushTerminator(bits: BitsState, ecLevel: EcLevel): BitsState;
+/** Pushes segments */
+export declare function bitsPushSegments(bits: BitsState, data: Uint8Array, segments: Segment[]): BitsState;
+/** Pushes data using optimal encoding */
+export declare function bitsPushOptimalData(bits: BitsState, data: Uint8Array): BitsState;
+/** Automatically determines minimum version and encodes data */
+export declare function encodeAuto(data: Uint8Array, ecLevel: EcLevel): BitsState;

package/dist/canvas.d.ts

@@ -0,0 +1,20 @@
+import { Color, EcLevel, Version } from './types.ts';
+declare enum Module {
+    Empty = 0,
+    MaskedLight = 1,
+    MaskedDark = 2,
+    UnmaskedLight = 3,
+    UnmaskedDark = 4
+}
+export interface CanvasState {
+    readonly width: number;
+    readonly version: Version;
+    readonly ecLevel: EcLevel;
+    readonly modules: Module[];
+}
+export declare function createCanvas(version: Version, ecLevel: EcLevel): CanvasState;
+export declare function canvasDrawAllFunctionalPatterns(canvas: CanvasState): CanvasState;
+export declare function canvasDrawData(canvas: CanvasState, data: Uint8Array, ecCode: Uint8Array): CanvasState;
+export declare function canvasApplyBestMask(canvas: CanvasState): CanvasState;
+export declare function canvasIntoColors(canvas: CanvasState): Color[];
+export {};

package/dist/ec.d.ts

@@ -0,0 +1,5 @@
+import { EcLevel, Version } from './types.ts';
+/** Creates error correction code */
+export declare function createErrorCorrectionCode(data: Uint8Array, ecCodeSize: number): Uint8Array;
+/** Constructs data and error correction codewords */
+export declare function constructCodewords(rawbits: Uint8Array, version: Version, ecLevel: EcLevel): [Uint8Array, Uint8Array];

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { EcLevel, QrOptions, QrResult } from './types.ts';
+export type { Version } from './types.ts';
+/**
+ * Generates a QR code from the given data
+ * @param options - QR code generation options
+ * @returns A QR code result object with matrix, width, version, and error correction level
+ */
+export declare function qrCode(options: QrOptions): QrResult;
+/**
+ * Converts a QR code result to a debug string
+ * @param qr - The QR code result object
+ * @param darkChar - Character to use for dark modules (default: '#')
+ * @param lightChar - Character to use for light modules (default: '.')
+ * @returns A string representation of the QR code
+ */
+export declare function debugString(qr: QrResult, darkChar?: string, lightChar?: string): string;
+export { EcLevel };
+export type { QrOptions, QrResult };