@hoangducnhuan/thermal-printer 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Klemen Kastelic
+
+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/dist/core.d.ts

@@ -0,0 +1,178 @@
+import CapacitorInterface from './interfaces/capacitor.js';
+import type Interface from './interfaces/interface.js';
+import type { ExecuteOptions } from './interfaces/interface.js';
+import type PrinterType from './types/printer-type.js';
+import type { BarcodeSettings, Code128Settings, MaxiCodeSettings, PDF417Settings, QRCodeSettings } from './types/printer-type.js';
+export declare enum PrinterTypes {
+    EPSON = "epson",
+    TANCA = "tanca",
+    STAR = "star",
+    DARUMA = "daruma",
+    BROTHER = "brother",
+    CUSTOM = "custom"
+}
+export declare enum BreakLine {
+    NONE = "NONE",
+    CHARACTER = "CHARACTER",
+    WORD = "WORD"
+}
+export declare enum CharacterSet {
+    PC437_USA = "PC437_USA",
+    PC850_MULTILINGUAL = "PC850_MULTILINGUAL",
+    PC860_PORTUGUESE = "PC860_PORTUGUESE",
+    PC863_CANADIAN_FRENCH = "PC863_CANADIAN_FRENCH",
+    PC865_NORDIC = "PC865_NORDIC",
+    PC851_GREEK = "PC851_GREEK",
+    PC857_TURKISH = "PC857_TURKISH",
+    PC737_GREEK = "PC737_GREEK",
+    ISO8859_7_GREEK = "ISO8859_7_GREEK",
+    WPC1252 = "WPC1252",
+    PC866_CYRILLIC2 = "PC866_CYRILLIC2",
+    PC852_LATIN2 = "PC852_LATIN2",
+    SLOVENIA = "SLOVENIA",
+    PC858_EURO = "PC858_EURO",
+    WPC775_BALTIC_RIM = "WPC775_BALTIC_RIM",
+    PC855_CYRILLIC = "PC855_CYRILLIC",
+    PC861_ICELANDIC = "PC861_ICELANDIC",
+    PC862_HEBREW = "PC862_HEBREW",
+    PC864_ARABIC = "PC864_ARABIC",
+    PC869_GREEK = "PC869_GREEK",
+    ISO8859_2_LATIN2 = "ISO8859_2_LATIN2",
+    ISO8859_15_LATIN9 = "ISO8859_15_LATIN9",
+    PC1125_UKRANIAN = "PC1125_UKRANIAN",
+    WPC1250_LATIN2 = "WPC1250_LATIN2",
+    WPC1251_CYRILLIC = "WPC1251_CYRILLIC",
+    WPC1253_GREEK = "WPC1253_GREEK",
+    WPC1254_TURKISH = "WPC1254_TURKISH",
+    WPC1255_HEBREW = "WPC1255_HEBREW",
+    WPC1256_ARABIC = "WPC1256_ARABIC",
+    WPC1257_BALTIC_RIM = "WPC1257_BALTIC_RIM",
+    WPC1258_VIETNAMESE = "WPC1258_VIETNAMESE",
+    KZ1048_KAZAKHSTAN = "KZ1048_KAZAKHSTAN",
+    JAPAN = "JAPAN",
+    KOREA = "KOREA",
+    CHINA = "CHINA",
+    HK_TW = "HK_TW",
+    TCVN_VIETNAMESE = "TCVN_VIETNAMESE",
+    VISCII = "VISCII"
+}
+export interface ThermalPrinterOptions {
+    timeout?: number;
+    debug?: boolean;
+    [key: string]: any;
+}
+export interface ThermalPrinterConfig {
+    type?: PrinterTypes;
+    interface?: string | Interface;
+    width?: number | string;
+    characterSet?: CharacterSet | string;
+    lineCharacter?: string;
+    driver?: any;
+    removeSpecialCharacters?: boolean;
+    breakLine?: BreakLine;
+    options?: ThermalPrinterOptions;
+}
+export interface ThermalPrinterInternalConfig {
+    type?: PrinterTypes;
+    width: number;
+    characterSet?: CharacterSet | string;
+    removeSpecialCharacters: boolean;
+    lineCharacter: string;
+    breakLine: BreakLine;
+    codePage?: string;
+    options?: ThermalPrinterOptions;
+}
+export interface TableCustomItem {
+    text: string;
+    align?: 'CENTER' | 'RIGHT' | 'LEFT';
+    width?: number;
+    cols?: number;
+    bold?: boolean;
+    originalText?: string;
+}
+export interface CutOptions {
+    verticalTabAmount?: number;
+}
+export declare class ThermalPrinter {
+    Interface: Interface;
+    buffer: Buffer | null;
+    config: ThermalPrinterInternalConfig;
+    printer: PrinterType;
+    types: typeof PrinterTypes;
+    constructor(initConfig: ThermalPrinterConfig);
+    setPrinterDriver(driver: any): void;
+    execute(options?: ExecuteOptions): Promise<any>;
+    cut({ verticalTabAmount }?: CutOptions): void;
+    partialCut({ verticalTabAmount }?: CutOptions): void;
+    initHardware(): void;
+    getWidth(): number;
+    getText(): string;
+    getBuffer(): Buffer | null;
+    setBuffer(newBuffer: Buffer): void;
+    clear(): void;
+    add(buffer: Buffer): void;
+    print(text: string): void;
+    println(text: string): void;
+    printVerticalTab(): void;
+    bold(enabled: boolean): void;
+    underline(enabled: boolean): void;
+    underlineThick(enabled: boolean): void;
+    upsideDown(enabled: boolean): void;
+    invert(enabled: boolean): void;
+    openCashDrawer(): void;
+    alignCenter(): void;
+    alignLeft(): void;
+    alignRight(): void;
+    setTypeFontA(): void;
+    setTypeFontB(): void;
+    setTextNormal(): void;
+    setTextDoubleHeight(): void;
+    setTextDoubleWidth(): void;
+    setTextQuadArea(): void;
+    setTextSize(height: number, width: number): void;
+    newLine(): void;
+    setLineSpacing(spacing: number): void;
+    resetLineSpacing(): void;
+    drawLine(character?: string): void;
+    leftRight(left: string, right: string): void;
+    table(data: string[]): void;
+    tableCustom(data: TableCustomItem[]): void;
+    isPrinterConnected(exists?: boolean): Promise<boolean>;
+    getStatus(): Promise<void>;
+    beep(numberOfBeeps?: number, lengthOfTheSound?: number): void;
+    printQR(data: string, settings?: QRCodeSettings): void;
+    printBarcode(data: string, type?: number, settings?: BarcodeSettings): void;
+    maxiCode(data: string, settings?: MaxiCodeSettings): void;
+    code128(data: string, settings?: Code128Settings): void;
+    pdf417(data: string, settings?: PDF417Settings): void;
+    printImage(image: string): Promise<Buffer | null>;
+    printImageBuffer(buffer: Buffer): Promise<Buffer | null>;
+    raw(text: Buffer): Promise<any>;
+    mergeObjects(obj1: Record<string, any>, obj2: Record<string, any>): Record<string, any>;
+    setCharacterSet(characterSet: CharacterSet | string): void;
+    append(text: string | Buffer | null | undefined): void;
+    /**
+     * This function splits text input into multiple lines. Returns array of lines
+     * @param text - text to split into lines
+     * @param lineSize - maximum allowed character count in one line
+     * @param breakWord - Break word or character
+     * @param lineArray - Array of lines passed for recursion
+     * @returns Array of lines
+     */
+    _fold(text: string, lineSize: number, breakWord: boolean, lineArray?: string[]): string[];
+}
+export { BreakLine as breakLine, CapacitorInterface, CharacterSet as characterSet, PrinterTypes as types, PrinterTypes as printerTypes, ThermalPrinter as printer, };
+declare const _default: {
+    printer: typeof ThermalPrinter;
+    types: typeof PrinterTypes;
+    printerTypes: typeof PrinterTypes;
+    breakLine: typeof BreakLine;
+    characterSet: typeof CharacterSet;
+    CapacitorInterface: typeof CapacitorInterface;
+    ThermalPrinter: typeof ThermalPrinter;
+    PrinterTypes: typeof PrinterTypes;
+    BreakLine: typeof BreakLine;
+    CharacterSet: typeof CharacterSet;
+};
+export default _default;
+//# sourceMappingURL=core.d.ts.map

package/dist/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../lib/core.ts"],"names":[],"mappings":"AAQA,OAAO,kBAAkB,MAAM,2BAA2B,CAAC;AAE3D,OAAO,KAAK,SAAS,MAAM,2BAA2B,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAKhE,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAIlI,oBAAY,YAAY;IACtB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,MAAM,WAAW;CAClB;AAED,oBAAY,SAAS;IACnB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,IAAI,SAAS;CACd;AAED,oBAAY,YAAY;IACtB,SAAS,cAAc;IACvB,kBAAkB,uBAAuB;IACzC,gBAAgB,qBAAqB;IACrC,qBAAqB,0BAA0B;IAC/C,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,OAAO,YAAY;IACnB,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,iBAAiB,sBAAsB;IACvC,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;IACvC,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,cAAc,mBAAmB;IACjC,kBAAkB,uBAAuB;IACzC,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,eAAe,oBAAoB;IACnC,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IACrC,uBAAuB,EAAE,OAAO,CAAC;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,qBAAa,cAAc;IACzB,SAAS,EAAG,SAAS,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC7B,MAAM,EAAG,4BAA4B,CAAC;IACtC,OAAO,EAAG,WAAW,CAAC;IACtB,KAAK,sBAAgB;IAErB,YAAY,UAAU,EAAE,oBAAoB,EA4C3C;IAED,gBAAgB,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAGlC;IAEK,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,CAOxD;IAED,GAAG,CAAC,EAAE,iBAAqB,EAAE,GAAE,UAAe,GAAG,IAAI,CAOpD;IAED,UAAU,CAAC,EAAE,iBAAqB,EAAE,GAAE,UAAe,GAAG,IAAI,CAO3D;IAED,YAAY,IAAI,IAAI,CAEnB;IAED,QAAQ,IAAI,MAAM,CAEjB;IAED,OAAO,IAAI,MAAM,CAEhB;IAED,SAAS,IAAI,MAAM,GAAG,IAAI,CAEzB;IAED,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAEjC;IAED,KAAK,IAAI,IAAI,CAGZ;IAED,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAExB;IAED,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAOxB;IAED,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAG1B;IAED,gBAAgB,IAAI,IAAI,CAEvB;IAED,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAG3B;IAED,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAGhC;IAED,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAGrC;IAED,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAGjC;IAED,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAG7B;IAED,cAAc,IAAI,IAAI,CAOrB;IAED,WAAW,IAAI,IAAI,CAElB;IAED,SAAS,IAAI,IAAI,CAEhB;IAED,UAAU,IAAI,IAAI,CAEjB;IAED,YAAY,IAAI,IAAI,CAEnB;IAED,YAAY,IAAI,IAAI,CAEnB;IAED,aAAa,IAAI,IAAI,CAEpB;IAED,mBAAmB,IAAI,IAAI,CAE1B;IAED,kBAAkB,IAAI,IAAI,CAEzB;IAED,eAAe,IAAI,IAAI,CAEtB;IAED,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAE/C;IAGD,OAAO,IAAI,IAAI,CAEd;IAGD,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAEpC;IAED,gBAAgB,IAAI,IAAI,CAEvB;IAGD,QAAQ,CAAC,SAAS,GAAE,MAAkC,GAAG,IAAI,CAK5D;IAGD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAQ3C;IAGD,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAU1B;IAID,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,GAAG,IAAI,CAsEzC;IAGK,kBAAkB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAE3D;IAGK,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/B;IAGD,IAAI,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAE5D;IAGD,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI,CAErD;IAGD,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAE1E;IAGD,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAExD;IAGD,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAEtD;IAGD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI,CAEpD;IAKK,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAsBtD;IAKK,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAU7D;IAGK,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAMpC;IAGD,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAStF;IAGD,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,GAAG,IAAI,CAQzD;IAGD,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAyDrD;IAGD;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,GAAE,MAAM,EAAO,GAAG,MAAM,EAAE,CAoC5F;CACF;AAED,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,kBAAkB,EAClB,YAAY,IAAI,YAAY,EAC5B,YAAY,IAAI,KAAK,EACrB,YAAY,IAAI,YAAY,EAC5B,cAAc,IAAI,OAAO,GAC1B,CAAC"}