@levischuck/receiptline 0.0.1

package/dist/parse.d.ts

@@ -0,0 +1,73 @@
+import { Barcode, ParsedPrinter, Printer, QRCode } from './types.ts';
+type ParsedProperty = {
+    align?: string;
+    border?: string;
+    code?: string;
+    image?: string;
+    option?: string;
+    text?: string;
+    width?: string;
+    command?: string;
+    comment?: string;
+    [key: string]: string | undefined;
+};
+type ParsedColumn = {
+    align: number;
+    wrap: boolean;
+    border: number;
+    width: number;
+    alignment: number;
+    text?: string[];
+    property?: ParsedProperty;
+    code?: Barcode | QRCode;
+    image?: string;
+    command?: string;
+    comment?: string;
+    hr?: '-' | '=';
+    vr?: '+' | '-';
+    error?: string;
+};
+export type ParseState = {
+    wrap: boolean;
+    border: number;
+    width: number[];
+    align: number;
+    option: {
+        type: 'upc' | 'ean' | 'jan' | 'code39' | 'itf' | 'codabar' | 'nw7' | 'code93' | 'code128' | 'qrcode';
+        width: number;
+        height: number;
+        hri: boolean;
+        cell: number;
+        level: 'l' | 'm' | 'q' | 'h';
+        quietZone: boolean;
+    };
+    line: 'waiting' | 'ready' | 'running' | 'horizontal';
+    rules: {
+        left: number;
+        width: number;
+        right: number;
+        widths: number[];
+    };
+};
+/**
+ * Validate printer configuration.
+ * @param printer printer configuration
+ * @returns validated printer configuration
+ */
+export declare function parseOption(printer?: Partial<Printer>): ParsedPrinter;
+/**
+ * Parse lines.
+ * @param columns line text without line breaks
+ * @param state state variables
+ * @returns parsed line object
+ */
+export declare function parseLine(columns: string, state: ParseState): ParsedColumn[];
+/**
+ * Generate commands from line objects.
+ * @param line parsed line object
+ * @param printer printer configuration
+ * @param state state variables
+ * @returns printer command fragment or SVG image fragment
+ */
+export declare function createLine(line: ParsedColumn[], printer: ParsedPrinter, state: ParseState): string;
+export {};

package/dist/targets/base.d.ts

@@ -0,0 +1,168 @@
+import { Encoding, ParsedPrinter, QRCode, Barcode, BaseTargetInterface } from '../types.ts';
+/**
+ * Base target class for ReceiptLine commands.
+ */
+export declare class BaseTarget implements BaseTargetInterface {
+    /**
+     * Measure text width.
+     * @param {string} text string to measure
+     * @param {string} encoding codepage
+     * @returns {number} string width
+     */
+    measureText(text: string, encoding: Encoding): number;
+    /**
+     * Create character array from string (supporting Thai combining characters).
+     * @param {string} text string
+     * @param {string} encoding codepage
+     * @returns {string[]} array instance
+     */
+    arrayFrom(text: string, encoding: Encoding): string[];
+    /**
+     * Start printing.
+     * @param {object} printer printer configuration
+     * @returns {string} commands
+     */
+    open(printer: ParsedPrinter): string;
+    /**
+     * Finish printing.
+     * @returns {string} commands
+     */
+    close(): string;
+    /**
+     * Set print area.
+     * @param {number} left left margin (unit: characters)
+     * @param {number} width print area (unit: characters)
+     * @param {number} right right margin (unit: characters)
+     * @returns {string} commands
+     */
+    area(left: number, width: number, right: number): string;
+    /**
+     * Set line alignment.
+     * @param {number} align line alignment (0: left, 1: center, 2: right)
+     * @returns {string} commands
+     */
+    align(align: number): string;
+    /**
+     * Set absolute print position.
+     * @param {number} position absolute position (unit: characters)
+     * @returns {string} commands
+     */
+    absolute(position: number): string;
+    /**
+     * Set relative print position.
+     * @param {number} position relative position (unit: characters)
+     * @returns {string} commands
+     */
+    relative(position: number): string;
+    /**
+     * Print horizontal rule.
+     * @param {number} width line width (unit: characters)
+     * @returns {string} commands
+     */
+    hr(width: number): string;
+    /**
+     * Print vertical rules.
+     * @param {number[]} widths vertical line spacing
+     * @param {number} height text height (1-6)
+     * @returns {string} commands
+     */
+    vr(widths: number[], height: number): string;
+    /**
+     * Start rules.
+     * @param {number[]} widths vertical line spacing
+     * @returns {string} commands
+     */
+    vrstart(widths: number[]): string;
+    /**
+     * Stop rules.
+     * @param {number[]} widths vertical line spacing
+     * @returns {string} commands
+     */
+    vrstop(widths: number[]): string;
+    /**
+     * Print vertical and horizontal rules.
+     * @param {number[]} widths1 vertical line spacing (stop)
+     * @param {number[]} widths2 vertical line spacing (start)
+     * @param {number} dl difference in left position
+     * @param {number} dr difference in right position
+     * @returns {string} commands
+     */
+    vrhr(widths1: number[], widths2: number[], dl: number, dr: number): string;
+    /**
+     * Set line spacing and feed new line.
+     * @param {boolean} vr whether vertical ruled lines are printed
+     * @returns {string} commands
+     */
+    vrlf(vr: boolean): string;
+    /**
+     * Cut paper.
+     * @returns {string} commands
+     */
+    cut(): string;
+    /**
+     * Underline text.
+     * @returns {string} commands
+     */
+    ul(): string;
+    /**
+     * Emphasize text.
+     * @returns {string} commands
+     */
+    em(): string;
+    /**
+     * Invert text.
+     * @returns {string} commands
+     */
+    iv(): string;
+    /**
+     * Scale up text.
+     * @param {number} wh number of special character '^' (1-7)
+     * @returns {string} commands
+     */
+    wh(wh: number): string;
+    /**
+     * Cancel text decoration.
+     * @returns {string} commands
+     */
+    normal(): string;
+    /**
+     * Print text.
+     * @param {string} text string to print
+     * @param {string} encoding codepage
+     * @returns {string} commands
+     */
+    text(text: string, encoding: Encoding): string;
+    /**
+     * Feed new line.
+     * @returns {string} commands
+     */
+    lf(): string;
+    /**
+     * Insert commands.
+     * @param {string} command commands to insert
+     * @returns {string} commands
+     */
+    command(command: string): string;
+    /**
+     * Print image.
+     * @param {string} image image data (base64 png format)
+     * @returns {string} commands
+     */
+    image(image: string): string;
+    /**
+     * Print QR Code.
+     * @param {object} symbol QR Code information (data, type, cell, level)
+     * @param {string} encoding codepage
+     * @returns {string} commands
+     */
+    qrcode(symbol: QRCode, encoding: Encoding): string;
+    /**
+     * Print barcode.
+     * @param {object} symbol barcode information (data, type, width, height, hri)
+     * @param {string} encoding codepage
+     * @returns {string} commands
+     */
+    barcode(symbol: Barcode, encoding: Encoding): string;
+    calculatedWidth(): number;
+    calculatedHeight(): number;
+}

package/dist/targets/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseTarget } from './base.ts';
+import { SvgTarget } from './svg.ts';
+declare const _default: {
+    base: BaseTarget;
+    svg: SvgTarget;
+};
+export default _default;

package/dist/targets/svg.d.ts

@@ -0,0 +1,52 @@
+import { BaseTarget } from './base.ts';
+import { Encoding, ParsedPrinter, QRCode, Barcode } from '../types.ts';
+/**
+ * SVG target class for ReceiptLine commands.
+ */
+export declare class SvgTarget extends BaseTarget {
+    charWidth: number;
+    receiptId: string;
+    svgWidth: number;
+    svgHeight: number;
+    svgContent: string;
+    lineMargin: number;
+    lineAlign: number;
+    lineWidth: number;
+    lineHeight: number;
+    textElement: string;
+    textAttributes: Record<string, string>;
+    textPosition: number;
+    textScale: number;
+    textEncoding: Encoding;
+    feedMinimum: number;
+    spacing: boolean;
+    defaultFont: string;
+    fontSize: number;
+    open(printer: ParsedPrinter): string;
+    setDefaultFont(font: string): string;
+    close(): string;
+    area(left: number, width: number, right: number): string;
+    align(align: number): string;
+    absolute(position: number): string;
+    relative(position: number): string;
+    hr(width: number): string;
+    vr(widths: number[], height: number): string;
+    vrstart(widths: number[]): string;
+    vrstop(widths: number[]): string;
+    vrhr(widths1: number[], widths2: number[], dl: number, dr: number): string;
+    vrlf(vr: boolean): string;
+    cut(): string;
+    ul(): string;
+    em(): string;
+    iv(): string;
+    wh(wh: number): string;
+    normal(): string;
+    text(text: string, encoding: Encoding): string;
+    lf(): string;
+    command(command: string): string;
+    image(image: string): string;
+    qrcode(symbol: QRCode, _encoding: Encoding): string;
+    barcode(symbol: Barcode, encoding: Encoding): string;
+    calculatedWidth(): number;
+    calculatedHeight(): number;
+}

package/dist/types.d.ts

@@ -0,0 +1,65 @@
+export type Encoding = 'cp437' | 'cp852' | 'cp858' | 'cp860' | 'cp863' | 'cp865' | 'cp866' | 'cp1252' | 'cp932' | 'cp936' | 'cp949' | 'cp950' | 'multilingual' | 'shiftjis' | 'gb18030' | 'ksc5601' | 'big5' | 'tis620';
+export type ParsedPrinter = {
+    cpl: number;
+    charWidth: number;
+    encoding: Encoding;
+    spacing: boolean;
+    margin: number;
+    marginRight: number;
+    target: BaseTargetInterface;
+};
+export interface BaseTargetInterface {
+    measureText(text: string, encoding: Encoding): number;
+    arrayFrom(text: string, encoding: Encoding): string[];
+    open(printer: ParsedPrinter): string;
+    close(): string;
+    area(left: number, width: number, right: number): string;
+    align(align: number): string;
+    absolute(position: number): string;
+    relative(position: number): string;
+    hr(width: number): string;
+    vr(widths: number[], height: number): string;
+    vrstart(widths: number[]): string;
+    vrstop(widths: number[]): string;
+    vrhr(widths1: number[], widths2: number[], dl: number, dr: number): string;
+    vrlf(vr: boolean): string;
+    cut(): string;
+    ul(): string;
+    em(): string;
+    iv(): string;
+    wh(wh: number): string;
+    normal(): string;
+    text(text: string, encoding: Encoding): string;
+    lf(): string;
+    command(command: string): string;
+    image(image: string): string;
+    qrcode(symbol: QRCode, encoding: Encoding): string;
+    barcode(symbol: Barcode, encoding: Encoding): string;
+    calculatedWidth(): number;
+    calculatedHeight(): number;
+}
+export type Printer = {
+    cpl?: number;
+    charWidth?: number;
+    encoding?: Encoding;
+    spacing?: boolean;
+    target?: string | BaseTargetInterface;
+    margin?: number;
+    marginRight?: number;
+    [propName: string]: any;
+};
+export type QRCode = {
+    data: string;
+    type: 'qrcode';
+    cell: number;
+    level: 'l' | 'm' | 'q' | 'h';
+    quietZone?: boolean;
+};
+export type Barcode = {
+    data: string;
+    type: 'upc' | 'ean' | 'jan' | 'code39' | 'itf' | 'codabar' | 'nw7' | 'code93' | 'code128';
+    width: number;
+    height: number;
+    hri: boolean;
+    quietZone?: boolean;
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@levischuck/receiptline",
+  "module": "./dist/index.js",
+  "description": "Markdown for receipts. Printable digital receipts. Generate receipt printer commands and images.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "author": "Open Foodservice System Consortium, Levi Schuck",
+  "version": "0.0.1",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "unplugin-dts": "^1.0.0-beta.6",
+    "vite": "^7.3.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@levischuck/tiny-qr": "^0.0.5",
+    "@levischuck/tiny-qr-svg": "^0.0.5"
+  },
+  "keywords": [
+    "kiosk",
+    "receipt",
+    "invoice",
+    "kitchen",
+    "ticket",
+    "svg",
+    "markdown"
+  ],
+  "files": [
+    "dist",
+    "LICENSE.txt",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/levischuck/receiptline.git"
+  },
+  "scripts": {
+    "build": "vite build",
+    "type-check": "tsc --noEmit"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}