@connexup/react-native-xprinter 0.1.0

package/src/printer/index.ts

@@ -0,0 +1,160 @@
+import {
+  ConnectStatus,
+  type DeviceConnectStatusChangeEvent,
+  DeviceType,
+  NativeXPrinterPrinter,
+  type NetDevice,
+  PCLType,
+  type Spec,
+  type UpdateUdpNetConfigRequest,
+} from './NativeXPrinterPrinter';
+import { XPrinterPCLExecutor } from '../type';
+import { XPrinterESCExecutor } from '../esc';
+import { XPrinterTSPLExecutor } from '../tspl';
+
+export class XPrinterPrinter
+  implements
+    Omit<
+      Spec,
+      'getConstants' | 'onDeviceConnectStatusChange' | 'onSearchNetDeviceFound'
+    >
+{
+  private readonly module: Spec;
+
+  constructor(module: Spec) {
+    this.module = module;
+  }
+
+  getUsbDevices = async () => {
+    return this.module.getUsbDevices();
+  };
+
+  searchNetDevice = async () => {
+    return this.module.searchNetDevice();
+  };
+
+  udpNetConfig = async (request: UpdateUdpNetConfigRequest) => {
+    return this.module.udpNetConfig(request);
+  };
+
+  connect = async (
+    connectInfo: string,
+    deviceType: DeviceType,
+    sync: boolean
+  ) => {
+    let handleStatusChangeAction:
+      | ((info: DeviceConnectStatusChangeEvent) => void)
+      | undefined;
+    const pendingPromise = new Promise((resolve, reject) => {
+      handleStatusChangeAction = (info: DeviceConnectStatusChangeEvent) => {
+        if (info.code === ConnectStatus.CONNECT_SUCCESS) {
+          resolve(null);
+        } else {
+          reject(new Error(info.msg ?? 'Connect Error'));
+        }
+      };
+    });
+    const subscription = this.addDeviceConnectStatusChangeListener((info) => {
+      if (handleStatusChangeAction && info.connectInfo === connectInfo) {
+        handleStatusChangeAction(info);
+        handleStatusChangeAction = undefined;
+      }
+    });
+    try {
+      await this.module.connect(connectInfo, deviceType, sync);
+      await pendingPromise;
+    } finally {
+      subscription.remove();
+    }
+  };
+
+  disconnect = async (connectInfo: string) => {
+    return this.module.disconnect(connectInfo);
+  };
+
+  isConnect = async (connectInfo: string) => {
+    return this.module.isConnect(connectInfo);
+  };
+
+  setPrinterPCL = (connectInfo: string, pcl: PCLType) => {
+    return this.module.setPrinterPCL(connectInfo, pcl);
+  };
+
+  getPrinterPCL = (connectInfo: string) => {
+    return this.module.getPrinterPCL(connectInfo);
+  };
+
+  readonly addDeviceConnectStatusChangeListener = (
+    listener: (event: DeviceConnectStatusChangeEvent) => void
+  ) => {
+    return this.module.onDeviceConnectStatusChange(listener);
+  };
+
+  readonly addSearchNetDeviceFoundListener = (
+    listener: (device: NetDevice) => void
+  ) => {
+    return this.module.onSearchNetDeviceFound(listener);
+  };
+}
+
+export const xPrinterPrinter = new XPrinterPrinter(NativeXPrinterPrinter);
+
+export class XPrinterDevice {
+  readonly connectInfo: string;
+  private _pcl: PCLType | null = null;
+  private _executor: XPrinterPCLExecutor | null = null;
+
+  constructor(connectInfo: string, pclType?: PCLType) {
+    this.connectInfo = connectInfo;
+    if (pclType) {
+      this._pcl = pclType;
+      this.setupExecutor();
+    }
+  }
+
+  get pcl(): PCLType | null {
+    return this._pcl;
+  }
+
+  get executor(): XPrinterPCLExecutor | null {
+    return this._executor;
+  }
+
+  connect = async (deviceType: DeviceType, sync: boolean) => {
+    return xPrinterPrinter.connect(this.connectInfo, deviceType, sync);
+  };
+
+  disconnect = async () => {
+    return xPrinterPrinter.disconnect(this.connectInfo);
+  };
+
+  isConnect = async () => {
+    return xPrinterPrinter.isConnect(this.connectInfo);
+  };
+
+  setPCL = async (pcl: PCLType) => {
+    await xPrinterPrinter.setPrinterPCL(this.connectInfo, pcl);
+    this._pcl = pcl;
+    this.setupExecutor();
+  };
+
+  readonly addConnectStatusChangeListener = (
+    listener: (event: DeviceConnectStatusChangeEvent) => void
+  ) => {
+    return xPrinterPrinter.addDeviceConnectStatusChangeListener((event) => {
+      if (event.connectInfo === this.connectInfo) {
+        listener(event);
+      }
+    });
+  };
+
+  private setupExecutor = () => {
+    if (this._pcl === PCLType.ESC) {
+      this._executor = new XPrinterESCExecutor(this.connectInfo);
+    } else if (this._pcl === PCLType.TSPL) {
+      this._executor = new XPrinterTSPLExecutor(this.connectInfo);
+    } else {
+      this._executor = null;
+    }
+  };
+}

package/src/tspl/NativeXPrinterTSPL.ts

@@ -0,0 +1,388 @@
+import { type TurboModule, TurboModuleRegistry } from 'react-native';
+
+export interface Spec extends TurboModule {
+  sizeInch(connectInfo: string, width: number, height: number): Promise<void>;
+
+  sizeMm(connectInfo: string, width: number, height: number): Promise<void>;
+
+  gapInch(connectInfo: string, m: number, n: number): Promise<void>;
+
+  gapMm(connectInfo: string, m: number, n: number): Promise<void>;
+
+  speed(connectInfo: string, speed: number): Promise<void>;
+
+  density(
+    connectInfo: string,
+    //0-15
+    density: number
+  ): Promise<void>;
+
+  direction(
+    connectInfo: string,
+    direction: Direction,
+    //android only
+    isMirror: boolean
+  ): Promise<void>;
+
+  cls(connectInfo: string): Promise<void>;
+
+  box(connectInfo: string, payload: BoxRequest): Promise<void>;
+
+  bar(connectInfo: string, payload: BarRequest): Promise<void>;
+
+  barcode(connectInfo: string, payload: BarcodeRequest): Promise<void>;
+
+  text(connectInfo: string, payload: TextRequest): Promise<void>;
+
+  offsetInch(connectInfo: string, offset: number): Promise<void>;
+
+  offsetMm(connectInfo: string, offset: number): Promise<void>;
+
+  reference(connectInfo: string, x: number, y: number): Promise<void>;
+
+  qrcode(connectInfo: string, payload: QRCodeRequest): Promise<void>;
+
+  print(connectInfo: string, count: number): Promise<void>;
+
+  //only android
+  printWithResponse(
+    connectInfo: string,
+    count: number,
+    timeout: number
+  ): Promise<number>;
+
+  feed(
+    connectInfo: string,
+    //1-9999
+    length: number
+  ): Promise<void>;
+
+  backFeed(
+    connectInfo: string,
+    //1-9999
+    length: number
+  ): Promise<void>;
+
+  formFeed(connectInfo: string): Promise<void>;
+
+  limitFeedMm(connectInfo: string, length: number): Promise<void>;
+
+  limitFeedInch(connectInfo: string, length: number): Promise<void>;
+
+  home(connectInfo: string): Promise<void>;
+
+  codePage(
+    connectInfo: string,
+    //见文档
+    page: string
+  ): Promise<void>;
+
+  sound(
+    connectInfo: string,
+    //0-9
+    level: number,
+    //ms, 1-4096
+    interval: number
+  ): Promise<void>;
+
+  bitmap(connectInfo: string, payload: BitmapRequest): Promise<void>;
+
+  bitmapCompression(
+    connectInfo: string,
+    payload: BitmapCompressionRequest
+  ): Promise<void>;
+
+  //only android
+  pdfBase64(connectInfo: string, payload: PDFBase64Request): Promise<void>;
+
+  erase(connectInfo: string, payload: EraseRequest): Promise<void>;
+
+  reverse(connectInfo: string, payload: ReverseRequest): Promise<void>;
+
+  cut(connectInfo: string): Promise<void>;
+
+  setPeel(connectInfo: string, isOpen: boolean): Promise<void>;
+
+  setTear(connectInfo: string, isOpen: boolean): Promise<void>;
+
+  //only android
+  setCutter(connectInfo: string, pieces: number): Promise<void>;
+
+  putBMP(connectInfo: string, payload: PutBMPRequest): Promise<void>;
+
+  blineInch(
+    connectInfo: string,
+    //0.1-1
+    m: number,
+    //0-label length
+    n: number
+  ): Promise<void>;
+
+  blineMm(
+    connectInfo: string,
+    //2.54 25.4
+    m: number,
+    //0-label length
+    n: number
+  ): Promise<void>;
+
+  //only android
+  setPrinterModel(connectInfo: string, model: string): Promise<void>;
+
+  //only android
+  getPrinterModel(connectInfo: string): Promise<string>;
+
+  printerStatus(
+    connectInfo: string,
+    //only android
+    timeout: number
+  ): Promise<{
+    status: number;
+    debugCode?: number;
+  }>;
+}
+
+export const NativeXPrinterTSPL =
+  TurboModuleRegistry.getEnforcing<Spec>('NativeXPrinterTSPL');
+
+export enum Direction {
+  DIRECTION_FORWARD = 'DIRECTION_FORWARD',
+  DIRECTION_REVERSE = 'DIRECTION_REVERSE',
+}
+
+export enum BarcodeType {
+  CODE_TYPE_12 = 'CODE_TYPE_128',
+  CODE_TYPE_128M = 'CODE_TYPE_128M',
+  CODE_TYPE_EAN128 = 'CODE_TYPE_EAN128',
+  CODE_TYPE_25 = 'CODE_TYPE_25',
+  CODE_TYPE_25C = 'CODE_TYPE_25C',
+  CODE_TYPE_39 = 'CODE_TYPE_39',
+  CODE_TYPE_39C = 'CODE_TYPE_39C',
+  CODE_TYPE_93 = 'CODE_TYPE_93',
+  CODE_TYPE_EAN13 = 'CODE_TYPE_EAN13',
+  CODE_TYPE_EAN13_2 = 'CODE_TYPE_EAN13_2',
+  CODE_TYPE_EAN13_5 = 'CODE_TYPE_EAN13_5',
+  CODE_TYPE_EAN8 = 'CODE_TYPE_EAN8',
+  CODE_TYPE_EAN8_2 = 'CODE_TYPE_EAN8_2',
+  CODE_TYPE_EAN8_5 = 'CODE_TYPE_EAN8_5',
+  CODE_TYPE_CODA = 'CODE_TYPE_CODA',
+  CODE_TYPE_POST = 'CODE_TYPE_POST',
+  CODE_TYPE_UPCA = 'CODE_TYPE_UPCA',
+  CODE_TYPE_UPCA_2 = 'CODE_TYPE_UPCA_2',
+  CODE_TYPE_UPCA_5 = 'CODE_TYPE_UPCA_5',
+  CODE_TYPE_UPCE = 'CODE_TYPE_UPCE',
+  CODE_TYPE_UPCE_2 = 'CODE_TYPE_UPCE_2',
+  CODE_TYPE_UPCE_5 = 'CODE_TYPE_UPCE_5',
+  CODE_TYPE_CPOST = 'CODE_TYPE_CPOST',
+  CODE_TYPE_MSI = 'CODE_TYPE_MSI',
+  CODE_TYPE_MSIC = 'CODE_TYPE_MSIC',
+  CODE_TYPE_PLESSE = 'CODE_TYPE_PLESSEY',
+  CODE_TYPE_ITF14 = 'CODE_TYPE_ITF14',
+  CODE_TYPE_EAN14 = 'CODE_TYPE_EAN14',
+  CODE_TYPE_11 = 'CODE_TYPE_11',
+  CODE_TYPE_TELEPEN = 'CODE_TYPE_TELEPEN',
+  CODE_TYPE_TELEPENN = 'CODE_TYPE_TELEPENN',
+  CODE_TYPE_PLANET = 'CODE_TYPE_PLANET',
+  CODE_TYPE_CODE49 = 'CODE_TYPE_CODE49',
+  CODE_TYPE_DPI = 'CODE_TYPE_DPI',
+  CODE_TYPE_DPL = 'CODE_TYPE_DPL',
+}
+
+export enum Readable {
+  READABLE_NONE = 'READABLE_NONE',
+  READABLE_LEFT = 'READABLE_LEFT',
+  READABLE_CENTER = 'READABLE_CENTER',
+  READABLE_RIGHT = 'READABLE_RIGHT',
+}
+
+export enum Rotation {
+  ROTATION_0 = 'ROTATION_0',
+  ROTATION_90 = 'ROTATION_90',
+  ROTATION_180 = 'ROTATION_180',
+  ROTATION_270 = 'ROTATION_270',
+}
+
+export enum Font {
+  FNT_8_12 = 'FNT_8_12',
+  FNT_12_20 = 'FNT_12_20',
+  FNT_16_24 = 'FNT_16_24',
+  FNT_24_32 = 'FNT_24_32',
+  FNT_32_48 = 'FNT_32_48',
+  FNT_14_19 = 'FNT_14_19',
+  FNT_14_25 = 'FNT_14_25',
+  FNT_21_27 = 'FNT_21_27',
+  FNT_SIMPLIFIED_CHINESE = 'FNT_SIMPLIFIED_CHINESE',
+  FNT_TRADITIONAL_CHINESE = 'FNT_TRADITIONAL_CHINESE',
+  FNT_KOREAN = 'FNT_KOREAN',
+}
+
+export enum ECLevel {
+  EC_LEVEL_L = 'EC_LEVEL_L',
+  EC_LEVEL_M = 'EC_LEVEL_M',
+  EC_LEVEL_Q = 'EC_LEVEL_Q',
+  EC_LEVEL_H = 'EC_LEVEL_H',
+}
+
+export enum QRCodeMode {
+  QRCODE_MODE_AUTO = 'QRCODE_MODE_AUTO',
+  QRCODE_MODE_MANUAL = 'QRCODE_MODE_MANUAL',
+}
+
+export enum QRCodeModel {
+  QRCODE_MODEL_M1 = 'QRCODE_MODEL_M1',
+  QRCODE_MODEL_M2 = 'QRCODE_MODE_MANUAL',
+}
+
+export enum BitmapMode {
+  BMP_MODE_OVERWRITE = 'BMP_MODE_OVERWRITE',
+  BMP_MODE_OR = 'BMP_MODE_OR',
+  BMP_MODE_XOR = 'BMP_MODE_XOR',
+}
+
+export enum BitmapAlgorithmType {
+  THRESHOLD = 'THRESHOLD',
+  DITHERING = 'DITHERING',
+  NONE = 'NONE',
+  DIFFUSION = 'DIFFUSION',
+  HALFTONE = 'HALFTONE',
+}
+
+export enum BitmapCompressionMode {
+  BMP_MODE_OVERWRITE_C = 'BMP_MODE_OVERWRITE_C',
+  BMP_MODE_OR_C = 'BMP_MODE_OR_C',
+  BMP_MODE_XOR_C = 'BMP_MODE_XOR_C',
+}
+
+export enum PrinterStatus {
+  PRINTER_STATUS_NORMAL = 'PRINTER_STATUS_NORMAL',
+  PRINTER_STATUS_COVER_OPEN = 'PRINTER_STATUS_COVER_OPEN',
+  PRINTER_STATUS_PAPER_JAM = 'PRINTER_STATUS_PAPER_JAM',
+  PRINTER_STATUS_PAPER_JAM_AND_COVER_OPEN = 'PRINTER_STATUS_PAPER_JAM_AND_COVER_OPEN',
+  PRINTER_STATUS_OUT_OF_PAPER = 'PRINTER_STATUS_OUT_OF_PAPER',
+  PRINTER_STATUS_OUT_OF_PAPER_AND_COVER_OPEN = 'PRINTER_STATUS_OUT_OF_PAPER_AND_COVER_OPEN',
+  PRINTER_STATUS_NO_RIBBON = 'PRINTER_STATUS_NO_RIBBON',
+  PRINTER_STATUS_NO_RIBBON_AND_COVER_OPEN = 'PRINTER_STATUS_NO_RIBBON_AND_COVER_OPEN',
+  PRINTER_STATUS_NO_RIBBON_AND_PAPER_JAM = 'PRINTER_STATUS_NO_RIBBON_AND_PAPER_JAM',
+  PRINTER_STATUS_NO_RIBBON_AND_PAPER_JAM_AND_COVER_OPEN = 'PRINTER_STATUS_NO_RIBBON_AND_PAPER_JAM_AND_COVER_OPEN',
+  PRINTER_STATUS_NO_RIBBON_AND_OUT_OF_PAPER = 'PRINTER_STATUS_NO_RIBBON_AND_OUT_OF_PAPER',
+  PRINTER_STATUS_NO_RIBBON_AND_OUT_OF_PAPER_AND_COVER_OPEN = 'PRINTER_STATUS_NO_RIBBON_AND_OUT_OF_PAPER_AND_COVER_OPEN',
+  PRINTER_STATUS_PAUSED = 'PRINTER_STATUS_PAUSED',
+  PRINTER_STATUS_PRINTING = 'PRINTER_STATUS_PRINTING',
+  PRINTER_STATUS_OTHER_ERROR = 'PRINTER_STATUS_OTHER_ERROR',
+  PRINTER_STATUS_TIMOUT_OR_DATA_ERROR = 'PRINTER_STATUS_TIMOUT_OR_DATA_ERROR',
+  PRINTER_STATUS_UNKNOWN = 'PRINTER_STATUS_UNKNOWN',
+}
+
+export interface BoxRequest {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  thickness: number;
+}
+
+export interface BarRequest {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface BarcodeRequest {
+  x: number;
+  y: number;
+  codeType: BarcodeType;
+  height: number;
+  readable: Readable;
+  rotation: Rotation;
+  narrow: number;
+  wide: number;
+  content: string;
+}
+
+export interface TextRequest {
+  x: number;
+  y: number;
+  font: Font;
+  rotation: Rotation;
+  //1-10
+  xRatio: number;
+  //1-10
+  yRatio: number;
+  content: string;
+}
+
+export interface QRCodeRequest {
+  x: number;
+  y: number;
+  ecLevel: ECLevel;
+  //1-10
+  cellWidth: number;
+  mode: QRCodeMode;
+  rotation: Rotation;
+  //only android
+  model: QRCodeModel;
+  //S0-S8
+  mask: string;
+  data: string;
+}
+
+export type BitmapRequest = {
+  x: number;
+  y: number;
+  mode: BitmapMode;
+  width: number;
+  bitmapPath: string | null;
+  bitmapContent: string | null;
+  //only android
+  algorithmType?: BitmapAlgorithmType;
+};
+
+export type BitmapCompressionRequest = {
+  x: number;
+  y: number;
+  mode: BitmapCompressionMode;
+  width: number;
+  bitmapPath: string | null;
+  bitmapContent: string | null;
+  algorithmType?: BitmapAlgorithmType;
+};
+
+export interface PDFBase64Request {
+  x: number;
+  y: number;
+  pageWidth: number;
+  base64String: string;
+  algorithmType: BitmapAlgorithmType;
+}
+
+export interface EraseRequest {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface ReverseRequest {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface PutBMPRequest {
+  x: number;
+  y: number;
+  fileName: string;
+}
+
+export const DEFAULT_READABLE = Readable.READABLE_LEFT;
+export const DEFAULT_ROTATION = Rotation.ROTATION_0;
+export const DEFAULT_NARROW = 2;
+export const DEFAULT_WIDE = 2;
+export const DEFAULT_EC_LEVEL = ECLevel.EC_LEVEL_L;
+export const DEFAULT_QR_MASK = 'S7';
+export const DEFAULT_QR_MODE = QRCodeMode.QRCODE_MODE_AUTO;
+export const DEFAULT_QR_MODEL = QRCodeModel.QRCODE_MODEL_M1;
+export const DEFAULT_BITMAP_ALGORITHM_TYPE = BitmapAlgorithmType.THRESHOLD;
+export const DEFAULT_PRINT_STATUS_TIMEOUT = 5000;