taro-bluetooth-print 2.1.0 → 2.1.1

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

@@ -0,0 +1,161 @@
+import { IAdapterOptions, IQrOptions, PrinterState, IPrinterAdapter } from '../../types';
+
+/**
+ * Connection Manager Interface
+ *
+ * Manages Bluetooth device connections
+ */
+export interface IConnectionManager {
+    /**
+     * Connects to a Bluetooth device
+     *
+     * @param deviceId - Bluetooth device ID
+     * @returns Promise<void>
+     */
+    connect(deviceId: string): Promise<void>;
+    /**
+     * Disconnects from the current device
+     *
+     * @returns Promise<void>
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Checks if a device is connected
+     *
+     * @returns boolean - True if connected, false otherwise
+     */
+    isConnected(): boolean;
+    /**
+     * Gets the current device ID
+     *
+     * @returns string | null - Device ID or null if not connected
+     */
+    getDeviceId(): string | null;
+    /**
+     * Gets the current connection state
+     *
+     * @returns PrinterState - Current state
+     */
+    getState(): PrinterState;
+    /**
+     * Gets the printer adapter instance
+     *
+     * @returns IPrinterAdapter - Printer adapter
+     */
+    getAdapter(): IPrinterAdapter;
+}
+/**
+ * Print Job Manager Interface
+ *
+ * Manages print jobs, including pause/resume/cancel functionality
+ */
+export interface IPrintJobManager {
+    /**
+     * Starts a print job
+     *
+     * @param buffer - Print data buffer
+     * @returns Promise<void>
+     */
+    start(buffer: Uint8Array): Promise<void>;
+    /**
+     * Pauses the current print job
+     */
+    pause(): void;
+    /**
+     * Resumes a paused print job
+     *
+     * @returns Promise<void>
+     */
+    resume(): Promise<void>;
+    /**
+     * Cancels the current print job
+     */
+    cancel(): void;
+    /**
+     * Gets the number of bytes remaining to print
+     *
+     * @returns number - Bytes remaining
+     */
+    remaining(): number;
+    /**
+     * Checks if the print job is paused
+     *
+     * @returns boolean - True if paused, false otherwise
+     */
+    isPaused(): boolean;
+    /**
+     * Checks if a print job is in progress
+     *
+     * @returns boolean - True if in progress, false otherwise
+     */
+    isInProgress(): boolean;
+    /**
+     * Sets adapter options for write operations
+     *
+     * @param options - Adapter options
+     */
+    setOptions(options: IAdapterOptions): void;
+}
+/**
+ * Command Builder Interface
+ *
+ * Builds print commands using the printer driver
+ */
+export interface ICommandBuilder {
+    /**
+     * Adds text to the print queue
+     *
+     * @param content - Text content
+     * @param encoding - Text encoding
+     * @returns this - For method chaining
+     */
+    text(content: string, encoding?: string): this;
+    /**
+     * Adds line feeds to the print queue
+     *
+     * @param lines - Number of lines to feed
+     * @returns this - For method chaining
+     */
+    feed(lines?: number): this;
+    /**
+     * Adds a paper cut command to the print queue
+     *
+     * @returns this - For method chaining
+     */
+    cut(): this;
+    /**
+     * Adds an image to the print queue
+     *
+     * @param data - Image data as Uint8Array
+     * @param width - Image width
+     * @param height - Image height
+     * @returns this - For method chaining
+     */
+    image(data: Uint8Array, width: number, height: number): this;
+    /**
+     * Adds a QR code to the print queue
+     *
+     * @param content - QR code content
+     * @param options - QR code options
+     * @returns this - For method chaining
+     */
+    qr(content: string, options?: IQrOptions): this;
+    /**
+     * Clears the print queue
+     *
+     * @returns this - For method chaining
+     */
+    clear(): this;
+    /**
+     * Gets the current buffer
+     *
+     * @returns Uint8Array - Current print buffer
+     */
+    getBuffer(): Uint8Array;
+    /**
+     * Gets the total number of bytes in the buffer
+     *
+     * @returns number - Total bytes
+     */
+    getTotalBytes(): number;
+}

package/dist/types/utils/encoding.d.ts

@@ -2,6 +2,13 @@
  * Text encoding utilities
  * Handles conversion between strings and byte arrays with various encodings
  */
+/**
+ * Encoding configuration options
+ */
+export interface EncodingConfig {
+    /** Whether to show warnings for unsupported encodings */
+    showWarnings?: boolean;
+}
 /**
  * Text encoding utility class
  *
@@ -10,6 +17,9 @@
  *
  * @example
  * ```typescript
+ * // Configure encoding to disable warnings
+ * Encoding.configure({ showWarnings: false });
+ *
  * const bytes = Encoding.encode('Hello World', 'UTF-8');
  * const gbkBytes = Encoding.encode('你好世界', 'GBK');
  * ```
@@ -17,6 +27,20 @@
 export declare class Encoding {
     private static utf8Encoder;
     private static warningShown;
+    private static config;
+    /**
+     * Configures the encoding utility
+     *
+     * @param config - Configuration options
+     *
+     * @example
+     * ```typescript
+     * Encoding.configure({
+     *   showWarnings: false
+     * });
+     * ```
+     */
+    static configure(config: Partial<EncodingConfig>): void;
     /**
      * Encodes a string to a Uint8Array using the specified encoding
      *
@@ -27,7 +51,7 @@ export declare class Encoding {
      * @remarks
      * Note: Native TextEncoder only supports UTF-8.
      * For GBK encoding, a third-party library or polyfill is recommended.
-     * Currently falls back to UTF-8 with a warning.
+     * Currently falls back to UTF-8 with a warning (configurable).
      *
      * @example
      * ```typescript

package/dist/types/utils/logger.d.ts

@@ -1,6 +1,23 @@
 /**
  * Logging utilities for debugging and monitoring
  */
+/**
+ * Log entry structure
+ */
+export interface LogEntry {
+    /** Log level */
+    level: LogLevel;
+    /** Log message */
+    message: string;
+    /** Additional arguments */
+    args: unknown[];
+    /** Timestamp */
+    timestamp: Date;
+    /** Scope name (if any) */
+    scope?: string;
+    /** Formatted log string */
+    formatted: string;
+}
 /**
  * Log levels in order of severity
  */
@@ -11,6 +28,21 @@ export declare enum LogLevel {
     ERROR = 3,
     NONE = 4
 }
+/**
+ * Custom log handler function type
+ */
+export type LogHandler = (entry: LogEntry) => void;
+/**
+ * Logger configuration options
+ */
+export interface LoggerConfig {
+    /** Minimum log level to output */
+    level: LogLevel;
+    /** Global prefix for all log messages */
+    prefix: string;
+    /** Custom log handler function */
+    handler?: LogHandler;
+}
 /**
  * Logger class for consistent logging across the library
  *
@@ -19,6 +51,14 @@ export declare enum LogLevel {
  * // Enable debug logging
  * Logger.setLevel(LogLevel.DEBUG);
  *
+ * // Configure custom log handler
+ * Logger.configure({
+ *   handler: (entry) => {
+ *     // Send logs to a custom logging service
+ *     console.log(entry.formatted);
+ *   }
+ * });
+ *
  * Logger.debug('Connecting to device', deviceId);
  * Logger.info('Print job started');
  * Logger.warn('Retry attempt', { attempt: 2, maxRetries: 3 });
@@ -26,8 +66,13 @@ export declare enum LogLevel {
  * ```
  */
 export declare class Logger {
-    private static level;
-    private static prefix;
+    private static config;
+    /**
+     * Configures the logger
+     *
+     * @param config - Configuration options
+     */
+    static configure(config: Partial<LoggerConfig>): void;
     /**
      * Sets the global log level
      *
@@ -38,34 +83,46 @@ export declare class Logger {
      * Gets the current log level
      */
     static getLevel(): LogLevel;
+    /**
+     * Formats the log prefix
+     */
+    private static formatPrefix;
+    /**
+     * Formats a complete log message for custom handlers
+     */
+    private static formatMessage;
+    /**
+     * Logs a message with the specified level
+     */
+    private static log;
     /**
      * Logs a debug message (only in DEBUG level)
      *
      * @param message - Message to log
      * @param args - Additional arguments to log
      */
-    static debug(message: string, ...args: any[]): void;
+    static debug(message: string, ...args: unknown[]): void;
     /**
      * Logs an info message (DEBUG and INFO levels)
      *
      * @param message - Message to log
      * @param args - Additional arguments to log
      */
-    static info(message: string, ...args: any[]): void;
+    static info(message: string, ...args: unknown[]): void;
     /**
      * Logs a warning message (DEBUG, INFO, and WARN levels)
      *
      * @param message - Message to log
      * @param args - Additional arguments to log
      */
-    static warn(message: string, ...args: any[]): void;
+    static warn(message: string, ...args: unknown[]): void;
     /**
      * Logs an error message (all levels except NONE)
      *
      * @param message - Message to log
      * @param args - Additional arguments to log
      */
-    static error(message: string, ...args: any[]): void;
+    static error(message: string, ...args: unknown[]): void;
     /**
      * Creates a scoped logger with a specific prefix
      *
@@ -73,9 +130,9 @@ export declare class Logger {
      * @returns Scoped logger instance
      */
     static scope(scope: string): {
-        debug: (message: string, ...args: any[]) => void;
-        info: (message: string, ...args: any[]) => void;
-        warn: (message: string, ...args: any[]) => void;
-        error: (message: string, ...args: any[]) => void;
+        debug: (message: string, ...args: unknown[]) => void;
+        info: (message: string, ...args: unknown[]) => void;
+        warn: (message: string, ...args: unknown[]) => void;
+        error: (message: string, ...args: unknown[]) => void;
     };
 }

package/dist/types/utils/platform.d.ts

@@ -31,7 +31,7 @@ export declare function detectPlatform(): PlatformType;
  *
  * @returns The platform-specific global object or null if unknown
  */
-export declare function getPlatformGlobal(): any;
+export declare function getPlatformGlobal(): unknown;
 /**
  * Checks if the current platform is supported
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taro-bluetooth-print",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Taro 蓝牙打印库 v2.1 - 轻量级、高性能、跨平台支持微信、支付宝、百度、字节跳动小程序",
   "type": "module",
   "main": "dist/index.cjs.js",
@@ -50,7 +50,9 @@
   "author": "Agions",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/taro": "^3.6.0"
+    "@tarojs/taro": "^3.6.0",
+    "reflect-metadata": "^0.2.2",
+    "typedi": "^0.10.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.11",

package/src/adapters/AdapterFactory.ts

@@ -1,6 +1,6 @@
 /**
  * Adapter Factory
- * 
+ *
  * Creates and returns the appropriate adapter based on the detected platform
  */
 
@@ -18,13 +18,13 @@ import { BluetoothPrintError, ErrorCode } from '@/errors/BluetoothError';
 export class AdapterFactory {
   /**
    * Creates an adapter instance based on the detected platform
-   * 
+   *
    * @returns An instance of the appropriate adapter for the current platform
    * @throws BluetoothPrintError if the platform is not supported
    */
   static create(): IPrinterAdapter {
     const platform = detectPlatform();
-    
+
     switch (platform) {
       case PlatformType.WECHAT:
         return new TaroAdapter();
@@ -44,7 +44,7 @@ export class AdapterFactory {
 
   /**
    * Creates an adapter instance for a specific platform
-   * 
+   *
    * @param platform - The platform type to create an adapter for
    * @returns An instance of the appropriate adapter for the specified platform
    * @throws BluetoothPrintError if the platform is not supported

package/src/adapters/AlipayAdapter.ts

@@ -8,7 +8,66 @@ import { BaseAdapter } from './BaseAdapter';
 import { BluetoothPrintError, ErrorCode } from '@/errors/BluetoothError';
 
 // Declare Alipay global for TypeScript
-declare const my: any;
+interface AlipayBLEService {
+  uuid: string;
+}
+
+interface AlipayBLECharacteristicProperties {
+  write?: boolean;
+  writeWithoutResponse?: boolean;
+  read?: boolean;
+  notify?: boolean;
+  indicate?: boolean;
+}
+
+interface AlipayBLECharacteristic {
+  uuid: string;
+  properties: AlipayBLECharacteristicProperties;
+}
+
+interface AlipayBLEDeviceServicesResult {
+  services: AlipayBLEService[];
+}
+
+interface AlipayBLEDeviceCharacteristicsResult {
+  characteristics: AlipayBLECharacteristic[];
+}
+
+interface AlipayBLEConnectionStateResult {
+  connected: boolean;
+}
+
+interface AlipayBLEConnectionOptions {
+  deviceId: string;
+}
+
+interface AlipayBLEWriteOptions {
+  deviceId: string;
+  serviceId: string;
+  characteristicId: string;
+  value: ArrayBuffer;
+}
+
+interface AlipayBLEConnectionStateChangeCallback {
+  (res: { deviceId: string; connected: boolean }): void;
+}
+
+interface AlipayGlobal {
+  createBLEConnection(options: AlipayBLEConnectionOptions): Promise<void>;
+  closeBLEConnection(options: AlipayBLEConnectionOptions): Promise<void>;
+  getBLEConnectionState(
+    options: AlipayBLEConnectionOptions
+  ): Promise<AlipayBLEConnectionStateResult>;
+  writeBLECharacteristicValue(options: AlipayBLEWriteOptions): Promise<void>;
+  getBLEDeviceServices(options: AlipayBLEConnectionOptions): Promise<AlipayBLEDeviceServicesResult>;
+  getBLEDeviceCharacteristics(options: {
+    deviceId: string;
+    serviceId: string;
+  }): Promise<AlipayBLEDeviceCharacteristicsResult>;
+  onBLEConnectionStateChange(callback: AlipayBLEConnectionStateChangeCallback): void;
+}
+
+declare const my: AlipayGlobal;
 
 /**
  * Alipay Bluetooth Low Energy adapter
@@ -22,7 +81,6 @@ declare const my: any;
  * ```
  */
 export class AlipayAdapter extends BaseAdapter {
-
   /**
    * Connects to a Bluetooth device and discovers services
    *
@@ -44,17 +102,21 @@ export class AlipayAdapter extends BaseAdapter {
 
     try {
       // Add connection timeout handling
+      let timeoutId: NodeJS.Timeout | undefined;
       const connectionPromise = my.createBLEConnection({
-        deviceId
+        deviceId,
       });
-      
+
       const timeoutPromise = new Promise((_, reject) => {
-        setTimeout(() => {
+        timeoutId = setTimeout(() => {
           reject(new Error('Connection timeout after 10 seconds'));
         }, 10000);
       });
 
       await Promise.race([connectionPromise, timeoutPromise]);
+      if (timeoutId) {
+        clearTimeout(timeoutId); // Clear timeout after successful connection
+      }
       this.logger.info('BLE connection established');
 
       // Discover and cache services
@@ -64,7 +126,7 @@ export class AlipayAdapter extends BaseAdapter {
       this.logger.info('Device connected successfully');
 
       // Listen for connection state changes
-      my.onBLEConnectionStateChange((res: any) => {
+      my.onBLEConnectionStateChange((res: { deviceId: string; connected: boolean }) => {
         if (res.deviceId === deviceId && !res.connected) {
           this.logger.warn('Device disconnected unexpectedly');
           this.updateState(PrinterState.DISCONNECTED);
@@ -74,7 +136,7 @@ export class AlipayAdapter extends BaseAdapter {
     } catch (error) {
       this.updateState(PrinterState.DISCONNECTED);
       this.logger.error('Connection failed:', error);
-      
+
       // Return more specific error codes based on error message
       const errorMessage = (error as Error).message || '';
       if (errorMessage.includes('timeout')) {
@@ -90,7 +152,7 @@ export class AlipayAdapter extends BaseAdapter {
           error as Error
         );
       }
-      
+
       throw new BluetoothPrintError(
         ErrorCode.CONNECTION_FAILED,
         `Failed to connect to device ${deviceId}`,
@@ -111,7 +173,7 @@ export class AlipayAdapter extends BaseAdapter {
 
     try {
       await my.closeBLEConnection({
-        deviceId
+        deviceId,
       });
       this.cleanupDevice(deviceId);
       this.updateState(PrinterState.DISCONNECTED);
@@ -141,14 +203,11 @@ export class AlipayAdapter extends BaseAdapter {
     // Validate device is still connected
     try {
       const state = await my.getBLEConnectionState({
-        deviceId
+        deviceId,
       });
       if (!state.connected) {
         this.cleanupDevice(deviceId);
-        throw new BluetoothPrintError(
-          ErrorCode.DEVICE_DISCONNECTED,
-          'Device disconnected'
-        );
+        throw new BluetoothPrintError(ErrorCode.DEVICE_DISCONNECTED, 'Device disconnected');
       }
     } catch (error) {
       this.cleanupDevice(deviceId);
@@ -185,7 +244,7 @@ export class AlipayAdapter extends BaseAdapter {
             characteristicId: serviceInfo.characteristicId,
             value: chunk.buffer,
           });
-          
+
           const timeoutPromise = new Promise((_, reject) => {
             setTimeout(() => {
               reject(new Error('Write timeout after 5 seconds'));
@@ -233,7 +292,7 @@ export class AlipayAdapter extends BaseAdapter {
 
     try {
       const services = await my.getBLEDeviceServices({
-        deviceId
+        deviceId,
       });
 
       for (const service of services.services) {
@@ -243,7 +302,7 @@ export class AlipayAdapter extends BaseAdapter {
         });
 
         const writeChar = chars.characteristics.find(
-          (c: any) => c.properties.write || c.properties.writeWithoutResponse
+          (c: AlipayBLECharacteristic) => c.properties.write || c.properties.writeWithoutResponse
         );
 
         if (writeChar) {