taro-bluetooth-print 2.2.1 → 2.3.0

package/dist/types/adapters/AdapterFactory.d.ts

@@ -1,6 +1,5 @@
 import { IPrinterAdapter } from '../types';
 import { PlatformType } from '../utils/platform';
-
 /**
  * Adapter factory class
  */

package/dist/types/adapters/AlipayAdapter.d.ts

@@ -1,5 +1,4 @@
 import { MiniProgramAdapter, MiniProgramBLEApi } from './BaseAdapter';
-
 /**
  * Alipay Bluetooth Low Energy adapter
  *

package/dist/types/adapters/BaiduAdapter.d.ts

@@ -1,5 +1,4 @@
 import { MiniProgramAdapter, MiniProgramBLEApi } from './BaseAdapter';
-
 /**
  * Baidu Bluetooth Low Energy adapter
  *

package/dist/types/adapters/BaseAdapter.d.ts

@@ -1,5 +1,4 @@
 import { IPrinterAdapter, IAdapterOptions, PrinterState } from '../types';
-
 /**
  * Service information cache entry
  */

package/dist/types/adapters/ByteDanceAdapter.d.ts

@@ -1,5 +1,4 @@
 import { MiniProgramAdapter, MiniProgramBLEApi } from './BaseAdapter';
-
 /**
  * ByteDance Bluetooth Low Energy adapter
  *

package/dist/types/adapters/TaroAdapter.d.ts

@@ -1,5 +1,4 @@
 import { MiniProgramAdapter, MiniProgramBLEApi } from './BaseAdapter';
-
 /**
  * Taro Bluetooth Low Energy adapter
  *

package/dist/types/adapters/WebBluetoothAdapter.d.ts

@@ -1,6 +1,5 @@
 import { IAdapterOptions } from '../types';
 import { BaseAdapter } from './BaseAdapter';
-
 /**
  * Request device options for Web Bluetooth
  */

package/dist/types/config/PrinterConfig.d.ts

@@ -1,5 +1,4 @@
 import { LogLevel } from '../utils/logger';
-
 /**
  * Adapter configuration options
  */

package/dist/types/core/BluetoothPrinter.d.ts

@@ -2,7 +2,6 @@ import { IAdapterOptions, IQrOptions, PrinterState, IPrinterAdapter } from '../t
 import { EventEmitter } from './EventEmitter';
 import { BluetoothPrintError } from '../errors/BluetoothError';
 import { IConnectionManager, IPrintJobManager, ICommandBuilder } from '../services/interfaces';
-
 /**
  * Event types emitted by BluetoothPrinter
  */

package/dist/types/drivers/EscPos.d.ts

@@ -1,5 +1,4 @@
 import { IPrinterDriver, IQrOptions } from '../types';
-
 /**
  * ESC/POS driver options
  */

package/dist/types/drivers/TsplDriver.d.ts

@@ -0,0 +1,251 @@
+/**
+ * TSPL Driver
+ * TSC Printer Language driver for label/barcode printers
+ *
+ * TSPL is commonly used in thermal transfer label printers (TSC, Zebra, etc.)
+ */
+/**
+ * Label size configuration
+ */
+export interface LabelSize {
+    /** Label width in mm */
+    width: number;
+    /** Label height in mm */
+    height: number;
+    /** Gap between labels in mm (default: 3) */
+    gap?: number;
+}
+/**
+ * Text position and style
+ */
+export interface TextOptions {
+    /** X position in dots */
+    x: number;
+    /** Y position in dots */
+    y: number;
+    /** Font size (1-8, default: 2) */
+    font?: number;
+    /** Rotation (0, 90, 180, 270, default: 0) */
+    rotation?: 0 | 90 | 180 | 270;
+    /** Horizontal multiplier (1-10, default: 1) */
+    xMultiplier?: number;
+    /** Vertical multiplier (1-10, default: 1) */
+    yMultiplier?: number;
+}
+/**
+ * Barcode options
+ */
+export interface BarcodeOptions {
+    /** X position in dots */
+    x: number;
+    /** Y position in dots */
+    y: number;
+    /** Barcode type */
+    type: '128' | '39' | 'EAN13' | 'EAN8' | 'UPCA' | 'QRCODE';
+    /** Height in dots (default: 100) */
+    height?: number;
+    /** Narrow bar width (default: 2) */
+    narrow?: number;
+    /** Wide bar width (default: 4) */
+    wide?: number;
+    /** Show human-readable text (default: true) */
+    showText?: boolean;
+    /** Rotation (0, 90, 180, 270, default: 0) */
+    rotation?: 0 | 90 | 180 | 270;
+}
+/**
+ * QR Code options
+ */
+export interface QRCodeOptions {
+    /** X position in dots */
+    x: number;
+    /** Y position in dots */
+    y: number;
+    /** Error correction level (L, M, Q, H, default: M) */
+    eccLevel?: 'L' | 'M' | 'Q' | 'H';
+    /** Cell width (1-10, default: 6) */
+    cellWidth?: number;
+    /** Mode (A=Auto, M=Manual, default: A) */
+    mode?: 'A' | 'M';
+    /** Rotation (0, 90, 180, 270, default: 0) */
+    rotation?: 0 | 90 | 180 | 270;
+}
+/**
+ * Box/Rectangle options
+ */
+export interface BoxOptions {
+    /** X position in dots */
+    x: number;
+    /** Y position in dots */
+    y: number;
+    /** Width in dots */
+    width: number;
+    /** Height in dots */
+    height: number;
+    /** Line thickness (default: 2) */
+    thickness?: number;
+}
+/**
+ * Line options
+ */
+export interface LineOptions {
+    /** Start X position in dots */
+    x1: number;
+    /** Start Y position in dots */
+    y1: number;
+    /** End X position in dots */
+    x2: number;
+    /** End Y position in dots */
+    y2: number;
+    /** Line thickness (default: 2) */
+    thickness?: number;
+}
+/**
+ * TSPL Driver for label printers
+ *
+ * @example
+ * ```typescript
+ * const tspl = new TsplDriver();
+ *
+ * const commands = tspl
+ *   .size(60, 40)
+ *   .gap(3)
+ *   .clear()
+ *   .text('Product Name', { x: 50, y: 50, font: 3 })
+ *   .barcode('1234567890', { x: 50, y: 100, type: '128' })
+ *   .print(1)
+ *   .getBuffer();
+ * ```
+ */
+export declare class TsplDriver {
+    private commands;
+    private readonly logger;
+    private dpi;
+    /**
+     * Set printer DPI (dots per inch)
+     * @param dpi - DPI value (203 or 300)
+     */
+    setDPI(dpi: 203 | 300): this;
+    /**
+     * Convert mm to dots
+     */
+    mmToDots(mm: number): number;
+    /**
+     * Convert dots to mm
+     */
+    dotsToMm(dots: number): number;
+    /**
+     * Set label size
+     * @param width - Label width in mm
+     * @param height - Label height in mm
+     */
+    size(width: number, height: number): this;
+    /**
+     * Set gap between labels
+     * @param gap - Gap size in mm
+     * @param offset - Offset in mm (default: 0)
+     */
+    gap(gap: number, offset?: number): this;
+    /**
+     * Set print speed
+     * @param speed - Speed level (1-10)
+     */
+    speed(speed: number): this;
+    /**
+     * Set print density
+     * @param density - Density level (0-15)
+     */
+    density(density: number): this;
+    /**
+     * Set print direction
+     * @param direction - 0=normal, 1=reversed
+     */
+    direction(direction: 0 | 1): this;
+    /**
+     * Clear image buffer
+     */
+    clear(): this;
+    /**
+     * Add text to label
+     * @param content - Text content
+     * @param options - Text options
+     */
+    text(content: string, options: TextOptions): this;
+    /**
+     * Add barcode to label
+     * @param content - Barcode content
+     * @param options - Barcode options
+     */
+    barcode(content: string, options: BarcodeOptions): this;
+    /**
+     * Add QR code to label
+     * @param content - QR code content
+     * @param options - QR code options
+     */
+    qrcode(content: string, options: QRCodeOptions): this;
+    /**
+     * Draw a box/rectangle
+     * @param options - Box options
+     */
+    box(options: BoxOptions): this;
+    /**
+     * Draw a line
+     * @param options - Line options
+     */
+    line(options: LineOptions): this;
+    /**
+     * Fill a rectangular area
+     * @param x - X position
+     * @param y - Y position
+     * @param width - Width
+     * @param height - Height
+     */
+    bar(x: number, y: number, width: number, height: number): this;
+    /**
+     * Reverse a rectangular area (white becomes black and vice versa)
+     * @param x - X position
+     * @param y - Y position
+     * @param width - Width
+     * @param height - Height
+     */
+    reverse(x: number, y: number, width: number, height: number): this;
+    /**
+     * Print the label
+     * @param copies - Number of copies (default: 1)
+     * @param sets - Number of sets (default: 1)
+     */
+    print(copies?: number, sets?: number): this;
+    /**
+     * Feed labels
+     * @param count - Number of labels to feed
+     */
+    feed(count?: number): this;
+    /**
+     * Cut paper (if cutter available)
+     */
+    cut(): this;
+    /**
+     * Beep the buzzer
+     */
+    beep(): this;
+    /**
+     * Home the print head
+     */
+    home(): this;
+    /**
+     * Escape special characters in string
+     */
+    private escapeString;
+    /**
+     * Get all commands as string
+     */
+    getCommands(): string;
+    /**
+     * Get commands as buffer for sending to printer
+     */
+    getBuffer(): Uint8Array;
+    /**
+     * Clear all commands
+     */
+    reset(): this;
+}

package/dist/types/index.d.ts

@@ -8,6 +8,8 @@ export { BluetoothPrinter } from './core/BluetoothPrinter';
 export type { PrinterEvents } from './core/BluetoothPrinter';
 export { EventEmitter } from './core/EventEmitter';
 export { EscPos } from './drivers/EscPos';
+export { TsplDriver } from './drivers/TsplDriver';
+export type { LabelSize, TextOptions as TsplTextOptions, BarcodeOptions as TsplBarcodeOptions, QRCodeOptions as TsplQRCodeOptions, BoxOptions, LineOptions, } from './drivers/TsplDriver';
 export { TaroAdapter } from './adapters/TaroAdapter';
 export { AdapterFactory } from './adapters/AdapterFactory';
 export { BaseAdapter } from './adapters/BaseAdapter';
@@ -38,4 +40,7 @@ export { PlatformType, detectPlatform, isPlatformSupported } from './utils/platf
 export { BluetoothPrintError, ErrorCode } from './errors/BluetoothError';
 export { DEFAULT_CONFIG, mergeConfig } from './config/PrinterConfig';
 export type { PrinterConfig, AdapterConfig, DriverConfig, LoggingConfig, } from './config/PrinterConfig';
+export { PluginManager } from './plugins/PluginManager';
+export { createLoggingPlugin, createRetryPlugin } from './plugins';
+export type { Plugin, PluginHooks, PluginOptions, PluginFactory } from './plugins/types';
 export * from './types';

package/dist/types/plugins/PluginManager.d.ts

@@ -0,0 +1,87 @@
+import { Plugin, PluginHooks, PluginOptions } from './types';
+import { BluetoothPrintError } from '../errors/BluetoothError';
+import { PrinterState } from '../types';
+/**
+ * Manages plugins for BluetoothPrinter
+ */
+export declare class PluginManager {
+    private plugins;
+    private readonly logger;
+    /**
+     * Register a plugin
+     * @param plugin - Plugin to register
+     * @param options - Plugin options
+     * @throws {BluetoothPrintError} If plugin with same name already exists
+     */
+    register(plugin: Plugin, options?: PluginOptions): Promise<void>;
+    /**
+     * Unregister a plugin
+     * @param name - Plugin name to unregister
+     */
+    unregister(name: string): Promise<void>;
+    /**
+     * Get a registered plugin
+     * @param name - Plugin name
+     * @returns Plugin instance or undefined
+     */
+    get(name: string): Plugin | undefined;
+    /**
+     * Get all registered plugin names
+     * @returns Array of plugin names
+     */
+    getNames(): string[];
+    /**
+     * Check if a plugin is registered
+     * @param name - Plugin name
+     * @returns True if registered
+     */
+    has(name: string): boolean;
+    /**
+     * Execute a hook across all plugins
+     * @param hookName - Name of the hook to execute
+     * @param args - Arguments to pass to the hook
+     * @returns Result from hooks (last non-void result)
+     */
+    executeHook<K extends keyof PluginHooks>(hookName: K, ...args: Parameters<NonNullable<PluginHooks[K]>>): Promise<unknown>;
+    /**
+     * Execute beforeConnect hooks
+     */
+    beforeConnect(deviceId: string): Promise<string>;
+    /**
+     * Execute afterConnect hooks
+     */
+    afterConnect(deviceId: string): Promise<void>;
+    /**
+     * Execute beforeDisconnect hooks
+     */
+    beforeDisconnect(deviceId: string): Promise<void>;
+    /**
+     * Execute afterDisconnect hooks
+     */
+    afterDisconnect(deviceId: string): Promise<void>;
+    /**
+     * Execute beforePrint hooks
+     */
+    beforePrint(buffer: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Execute afterPrint hooks
+     */
+    afterPrint(bytesSent: number): Promise<void>;
+    /**
+     * Execute onError hooks
+     * @returns True if error should be suppressed
+     */
+    onError(error: BluetoothPrintError): Promise<boolean>;
+    /**
+     * Execute onStateChange hooks
+     */
+    onStateChange(state: PrinterState, previousState: PrinterState): Promise<void>;
+    /**
+     * Execute onProgress hooks
+     */
+    onProgress(sent: number, total: number): Promise<void>;
+    /**
+     * Clear all plugins
+     */
+    clear(): Promise<void>;
+}

package/dist/types/plugins/builtin/LoggingPlugin.d.ts

@@ -0,0 +1,14 @@
+import { PluginFactory, PluginOptions } from '../types';
+import { LogLevel } from '../../utils/logger';
+export interface LoggingPluginOptions extends PluginOptions {
+    /** Log level (default: DEBUG) */
+    level?: LogLevel;
+    /** Include timestamps (default: true) */
+    timestamps?: boolean;
+    /** Log progress updates (default: false, can be noisy) */
+    logProgress?: boolean;
+}
+/**
+ * Creates a logging plugin instance
+ */
+export declare const createLoggingPlugin: PluginFactory;

package/dist/types/plugins/builtin/RetryPlugin.d.ts

@@ -0,0 +1,18 @@
+import { PluginFactory, PluginOptions } from '../types';
+import { ErrorCode } from '../../errors/BluetoothError';
+export interface RetryPluginOptions extends PluginOptions {
+    /** Maximum retry attempts (default: 3) */
+    maxRetries?: number;
+    /** Initial delay in ms (default: 1000) */
+    initialDelay?: number;
+    /** Maximum delay in ms (default: 10000) */
+    maxDelay?: number;
+    /** Backoff multiplier (default: 2) */
+    backoffMultiplier?: number;
+    /** Error codes that should trigger retry */
+    retryableErrors?: ErrorCode[];
+}
+/**
+ * Creates a retry plugin instance
+ */
+export declare const createRetryPlugin: PluginFactory;

package/dist/types/plugins/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Plugin System Exports
+ */
+export { PluginManager } from './PluginManager';
+export type { Plugin, PluginHooks, PluginOptions, PluginFactory } from './types';
+export { createLoggingPlugin } from './builtin/LoggingPlugin';
+export { createRetryPlugin } from './builtin/RetryPlugin';

package/dist/types/plugins/types.d.ts

@@ -0,0 +1,97 @@
+import { BluetoothPrintError } from '../errors/BluetoothError';
+import { PrinterState } from '../types';
+/**
+ * Plugin lifecycle hooks
+ */
+export interface PluginHooks {
+    /**
+     * Called before connecting to a device
+     * @param deviceId - Target device ID
+     * @returns Modified device ID or void
+     */
+    beforeConnect?: (deviceId: string) => string | void | Promise<string | void>;
+    /**
+     * Called after successful connection
+     * @param deviceId - Connected device ID
+     */
+    afterConnect?: (deviceId: string) => void | Promise<void>;
+    /**
+     * Called before disconnecting
+     * @param deviceId - Device ID to disconnect
+     */
+    beforeDisconnect?: (deviceId: string) => void | Promise<void>;
+    /**
+     * Called after disconnection
+     * @param deviceId - Disconnected device ID
+     */
+    afterDisconnect?: (deviceId: string) => void | Promise<void>;
+    /**
+     * Called before sending print data
+     * @param buffer - Data buffer to send
+     * @returns Modified buffer or void
+     */
+    beforePrint?: (buffer: Uint8Array) => Uint8Array | void | Promise<Uint8Array | void>;
+    /**
+     * Called after print job completes
+     * @param bytesSent - Total bytes sent
+     */
+    afterPrint?: (bytesSent: number) => void | Promise<void>;
+    /**
+     * Called when an error occurs
+     * @param error - The error that occurred
+     * @returns Whether to suppress the error (true = suppress)
+     */
+    onError?: (error: BluetoothPrintError) => boolean | void | Promise<boolean | void>;
+    /**
+     * Called when printer state changes
+     * @param state - New printer state
+     * @param previousState - Previous state
+     */
+    onStateChange?: (state: PrinterState, previousState: PrinterState) => void | Promise<void>;
+    /**
+     * Called during print progress
+     * @param sent - Bytes sent
+     * @param total - Total bytes
+     */
+    onProgress?: (sent: number, total: number) => void | Promise<void>;
+}
+/**
+ * Plugin configuration options
+ */
+export interface PluginOptions {
+    [key: string]: unknown;
+}
+/**
+ * Plugin interface
+ */
+export interface Plugin {
+    /**
+     * Unique plugin name
+     */
+    name: string;
+    /**
+     * Plugin version
+     */
+    version?: string;
+    /**
+     * Plugin description
+     */
+    description?: string;
+    /**
+     * Plugin hooks
+     */
+    hooks: PluginHooks;
+    /**
+     * Plugin initialization
+     * @param options - Plugin options
+     */
+    init?: (options?: PluginOptions) => void | Promise<void>;
+    /**
+     * Plugin cleanup
+     */
+    destroy?: () => void | Promise<void>;
+}
+/**
+ * Plugin factory function type
+ */
+export type PluginFactory = (options?: PluginOptions) => Plugin;

package/dist/types/services/CommandBuilder.d.ts

@@ -2,7 +2,6 @@ import { IPrinterDriver, IQrOptions } from '../types';
 import { ICommandBuilder } from './interfaces';
 import { TextAlign, TextStyle } from '../formatter';
 import { BarcodeOptions } from '../barcode';
-
 /**
  * Command Builder implementation
  */

package/dist/types/services/ConnectionManager.d.ts

@@ -2,7 +2,6 @@ import { IPrinterAdapter, PrinterState } from '../types';
 import { IConnectionManager } from './interfaces';
 import { BluetoothPrintError } from '../errors/BluetoothError';
 import { EventEmitter } from '../core/EventEmitter';
-
 /**
  * Connection manager configuration
  */

package/dist/types/services/PrintJobManager.d.ts

@@ -1,6 +1,5 @@
 import { IAdapterOptions } from '../types';
 import { IPrintJobManager, IConnectionManager } from './interfaces';
-
 /**
  * Print Job Manager implementation
  */

package/dist/types/services/interfaces/index.d.ts

@@ -1,7 +1,6 @@
 import { IAdapterOptions, IQrOptions, PrinterState, IPrinterAdapter } from '../../types';
 import { TextAlign, TextStyle } from '../../formatter';
 import { BarcodeOptions } from '../../barcode';
-
 /**
  * Connection Manager Interface
  *

package/dist/types/template/TemplateEngine.d.ts

@@ -1,6 +1,5 @@
 import { TextAlign } from '../formatter';
 import { BarcodeFormat } from '../barcode';
-
 /**
  * Template type
  */

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "taro-bluetooth-print",
-  "version": "2.2.1",
-  "description": "Taro 蓝牙打印库 v2.2 - 轻量级、高性能、跨平台支持微信、支付宝、百度、字节跳动小程序及H5 Web Bluetooth",
+  "version": "2.3.0",
+  "description": "Taro 蓝牙打印库 v2.3 - 轻量级、高性能、跨平台支持微信、支付宝、百度、字节跳动小程序及H5 Web Bluetooth",
   "type": "module",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "types": "dist/types/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.es.js",
       "require": "./dist/index.cjs.js",
-      "types": "./dist/types/index.d.ts",
       "default": "./dist/index.umd.js"
     },
     "./package.json": "./package.json"
@@ -34,9 +34,9 @@
     "format:check": "prettier --check \"src/**/*.{ts,tsx,json,md}\"",
     "type-check": "tsc --noEmit",
     "prepublishOnly": "npm run build",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage"
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
   },
   "keywords": [
     "taro",
@@ -50,27 +50,25 @@
   "author": "Agions",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/taro": "^3.6.0"
+    "@tarojs/taro": "^4.1.11"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.11",
     "@types/node": "^20.14.8",
     "@typescript-eslint/eslint-plugin": "^6.19.0",
     "@typescript-eslint/parser": "^6.19.0",
+    "@vitest/coverage-v8": "^4.0.18",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "fast-check": "^4.5.3",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "prettier": "^3.2.4",
-    "rimraf": "^5.0.0",
-    "terser": "^5.24.0",
-    "ts-jest": "^29.1.1",
+    "prettier": "^3.8.1",
+    "rimraf": "^6.1.2",
+    "terser": "^5.46.0",
     "typescript": "^5.9.3",
-    "vite": "^5.0.0",
-    "vite-plugin-dts": "^3.9.1",
-    "vitepress": "^1.0.0"
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitepress": "^1.0.0",
+    "vitest": "^4.0.18"
   },
   "sideEffects": false
 }