@connexup/react-native-xprinter 0.1.0

package/src/esc/NativeXPrinterESC.ts

@@ -0,0 +1,516 @@
+import { type TurboModule, TurboModuleRegistry } from 'react-native';
+
+export interface Spec extends TurboModule {
+  setCharSet(connectInfo: string, charSet: CharSet): Promise<void>;
+
+  //only ios
+  selectInternationCharacterSets(
+    connectInfo: string,
+    n: InternationCharacterSet
+  ): Promise<void>;
+
+  //only ios
+  isConnect(connectInfo: string): Promise<boolean>;
+
+  initializePrinter(connectInfo: string): Promise<void>;
+
+  printString(connectInfo: string, data: string): Promise<void>;
+
+  printTextSize(
+    connectInfo: string,
+    payload: PrintTextSizeRequest
+  ): Promise<void>;
+
+  printTextAttribute(
+    connectInfo: string,
+    data: string,
+    attribute: TextAttribute
+  ): Promise<void>;
+
+  printTextAlignment(
+    connectInfo: string,
+    //使用对齐方式时，data 需以”\n”结尾，否则有可能会无效
+    data: string,
+    alignment: Alignment
+  ): Promise<void>;
+
+  printText(connectInfo: string, payload: PrintTextRequest): Promise<void>;
+
+  printBitmap(connectInfo: string, payload: PrintBitmapRequest): Promise<void>;
+
+  compressionPrintBitmap(
+    connectInfo: string,
+    payload: PrintBitmapRequest
+  ): Promise<void>;
+
+  printBarCode(
+    connectInfo: string,
+    payload: PrintBarCodeRequest
+  ): Promise<void>;
+
+  lineFeed(connectInfo: string, lineCount: number): Promise<void>;
+
+  feedDot(connectInfo: string, dotCount: number): Promise<void>;
+
+  printerCheck(
+    connectInfo: string,
+    type: PrinterCheckType,
+    timeout: number
+  ): Promise<{
+    debugArray?: number[] | null;
+    status: PrinterCheckStatus;
+  }>;
+
+  printerStatus(connectInfo: string): Promise<{
+    status: PrinterStatus;
+    debugCode?: number;
+  }>;
+
+  printerStatusII(connectInfo: string): Promise<{
+    status: PrinterStatusII;
+    debugCode?: number;
+  }>;
+
+  printQRCode(connectInfo: string, payload: PrintQRCodeRequest): Promise<void>;
+
+  cutPaper(connectInfo: string, model: CutModel): Promise<void>;
+
+  cutHalfAndFeed(connectInfo: string, distance: number): Promise<void>;
+
+  setPrintArea(
+    connectInfo: string,
+    payload: SetPrintAreaRequest
+  ): Promise<void>;
+
+  setPageModel(connectInfo: string, isOpen: boolean): Promise<void>;
+
+  printPageModelData(connectInfo: string): Promise<void>;
+
+  setPrintDirection(connectInfo: string, direction: Direction): Promise<void>;
+
+  setAbsoluteHorizontal(connectInfo: string, position: number): Promise<void>;
+
+  setRelativeHorizontal(connectInfo: string, position: number): Promise<void>;
+
+  setAbsoluteVertical(connectInfo: string, position: number): Promise<void>;
+
+  setRelativeVertical(connectInfo: string, position: number): Promise<void>;
+
+  setTextStyle(
+    connectInfo: string,
+    payload: SetTextStyleRequest
+  ): Promise<void>;
+
+  setAlignment(connectInfo: string, alignment: Alignment): Promise<void>;
+
+  downloadNVImage(
+    connectInfo: string,
+    //图片绝对路径，不同的图片用“,”隔开。
+    imagePaths: string,
+    imageWidth: number
+  ): Promise<void>;
+
+  //only android
+  clearNVImage(connectInfo: string): Promise<void>;
+
+  printNVImage(
+    connectInfo: string,
+    //图片下标 [1,255]
+    index: number,
+    model: BMPModel
+  ): Promise<void>;
+
+  selectBitmapModel(
+    connectInfo: string,
+    payload: SelectBitmapModelRequest
+  ): Promise<void>;
+
+  setLineSpacing(connectInfo: string, space: number): Promise<void>;
+
+  setTurnUpsideDownMode(connectInfo: string, on: boolean): Promise<void>;
+
+  /**
+   * @param connectInfo
+   * @param page
+   * 需要查看文档有具体的对应值
+   */
+  selectCodePage(connectInfo: string, page: number): Promise<void>;
+
+  selectCharacterFont(connectInfo: string, font: FontType): Promise<void>;
+
+  printPDF417(connectInfo: string, payload: PrintPDF417Request): Promise<void>;
+
+  printTable(connectInfo: string, payload: PrintTableRequest): Promise<void>;
+
+  wifiConfig(connectInfo: string, payload: WifiConfigRequest): Promise<void>;
+
+  //only android
+  setIp(connectInfo: string, ip: string): Promise<void>;
+
+  //only android
+  setMask(connectInfo: string, mask: string): Promise<void>;
+
+  //only android
+  setGateway(connectInfo: string, gateway: string): Promise<void>;
+
+  setNetAll(connectInfo: string, payload: SetNetAllRequest): Promise<void>;
+
+  setBluetooth(connectInfo: string, name: string, pin: string): Promise<void>;
+
+  //
+  getSerialNumber(connectInfo: string): Promise<string>;
+}
+
+export const NativeXPrinterESC =
+  TurboModuleRegistry.getEnforcing<Spec>('NativeXPrinterESC');
+
+export enum CharSet {
+  GBK = 'GBK',
+  UTF_8 = 'UTF-8',
+}
+
+export enum TextWidth {
+  TXT_1_WIDTH = 'TXT_1_WIDTH',
+  TXT_2_WIDTH = 'TXT_2_WIDTH',
+  TXT_3_WIDTH = 'TXT_3_WIDTH',
+  TXT_4_WIDTH = 'TXT_4_WIDTH',
+  TXT_5_WIDTH = 'TXT_5_WIDTH',
+  TXT_6_WIDTH = 'TXT_6_WIDTH',
+  TXT_7_WIDTH = 'TXT_7_WIDTH',
+  TXT_8_WIDTH = 'TXT_8_WIDTH',
+}
+
+export enum TextHeight {
+  TXT_1_HEIGHT = 'TXT_1_HEIGHT',
+  TXT_2_HEIGHT = 'TXT_2_HEIGHT',
+  TXT_3_HEIGHT = 'TXT_3_HEIGHT',
+  TXT_4_HEIGHT = 'TXT_4_HEIGHT',
+  TXT_5_HEIGHT = 'TXT_5_HEIGHT',
+  TXT_6_HEIGHT = 'TXT_6_HEIGHT',
+  TXT_7_HEIGHT = 'TXT_7_HEIGHT',
+  TXT_8_HEIGHT = 'TXT_8_HEIGHT',
+}
+
+export enum TextAttribute {
+  DEFAULT = 'DEFAULT',
+  FONTB = 'FONTB',
+  BOLD = 'BOLD',
+  REVERSE = 'REVERSE',
+  UNDERLINE = 'UNDERLINE',
+  UNDERLINE2 = 'UNDERLINE2',
+}
+
+export enum Alignment {
+  LEFT = 'LEFT',
+  CENTER = 'CENTER',
+  RIGHT = 'RIGHT',
+}
+
+export enum BMPModel {
+  NORMAL = 'NORMAL',
+  WIDTH_DOUBLE = 'WIDTH_DOUBLE',
+  HEIGHT_DOUBLE = 'HEIGHT_DOUBLE',
+  WIDTH_HEIGHT_DOUBLE = 'WIDTH_HEIGHT_DOUBLE',
+}
+
+export enum BMPType {
+  DITHERING = 'DITHERING',
+  THRESHOLD = 'THRESHOLD',
+}
+
+export enum BarcodeType {
+  UPCA = 'UPCA',
+  UPCE = 'UPCE',
+  EAN8 = 'EAN8',
+  EAN13 = 'EAN13',
+  JAN8 = 'JAN8',
+  JAN13 = 'JAN13',
+  ITF = 'ITF',
+  CODEBAR = 'CODEBAR',
+  CODE39 = 'CODE39',
+  CODE93 = 'CODE93',
+  //Code 128 类型，该类型时，data 必须加上{A， {B，{C 等
+  CODE128 = 'CODE128',
+}
+
+export enum TextPosition {
+  NONE = 'NONE',
+  ABOVE = 'ABOVE',
+  BELOW = 'BELOW',
+  BOTH = 'BOTH',
+}
+
+export enum PrinterCheckType {
+  PRINT = 'PRINT',
+  OFFLINE = 'OFFLINE',
+  ERR = 'ERR',
+  PAPER = 'PAPER',
+}
+
+export enum PrinterCheckStatus {
+  START_READ_LOOP_RETURN = 'START_READ_LOOP_RETURN',
+  DISCONNECT = 'DISCONNECT',
+  TIMEOUT = 'TIMEOUT',
+  UNKNOWN = 'UNKNOWN',
+}
+
+export enum PrinterStatus {
+  NORMAL = 'NORMAL',
+  COVER_OPEN = 'COVER_OPEN',
+  PRESS_FEED = 'PRESS_FEED',
+  PAPER_EMPTY = 'PAPER_EMPTY',
+  PRINTER_ERR = 'PRINTER_ERR',
+  COVER_OPEN_AND_PAPER_EMPTY = 'COVER_OPEN_AND_PAPER_EMPTY',
+  OTHER_ERROR = 'OTHER_ERROR',
+  DISCONNECT = 'DISCONNECT',
+  TIMEOUT = 'TIMEOUT',
+  UNKNOWN = 'UNKNOWN',
+}
+
+export enum PrinterStatusII {
+  NORMAL = 'NORMAL',
+  PRINTER = 'PRINTING',
+  COVER_OPEN = 'COVER_OPEN',
+  PAPER_EMPTY = 'PAPER_EMPTY',
+  PAPER_IS_OVER = 'PAPER_IS_OVER',
+  MONEY_BOX_OPEN = 'MONEY_BOX_OPEN',
+  OTHER_ERROR = 'OTHER_ERROR',
+  CUTTING_ERROR = 'CUTTING_ERROR',
+  PRINT_HEAD_OVERHEATING = 'PRINT_HEAD_OVERHEATING',
+  DISCONNECT = 'DISCONNECT',
+  TIMEOUT = 'TIMEOUT',
+  UNKNOWN = 'UNKNOWN',
+}
+
+export enum PingPrinterStatus {
+  NORMAL = 'NORMAL',
+  PRINTER_IS_BUSY = 'PRINTER_IS_BUSY',
+  COVER_OPEN = 'COVER_OPEN',
+  PAPER_EMPTY = 'PAPER_EMPTY',
+  OTHER_ERROR = 'OTHER_ERROR',
+  CUTTING_ERROR = 'CUTTING_ERROR',
+  PRINT_HEAD_OVERHEATING = 'PRINT_HEAD_OVERHEATING',
+  DISCONNECT = 'DISCONNECT',
+  TIMEOUT = 'TIMEOUT',
+  UNKNOWN = 'UNKNOWN',
+}
+
+export enum ECLevel {
+  LEVEL_L = 'LEVEL_L',
+  LEVEL_M = 'LEVEL_M',
+  LEVEL_Q = 'LEVEL_Q',
+  LEVEL_H = 'LEVEL_H',
+}
+
+export enum CutModel {
+  CUT_ALL = 'CUT_ALL',
+  CUT_HALF = 'CUT_HALF',
+}
+
+export enum Direction {
+  LEFT_TOP = 'LEFT_TOP',
+  LEFT_BOTTOM = 'LEFT_BOTTOM',
+  RIGHT_BOTTOM = 'RIGHT_BOTTOM',
+  RIGHT_TOP = 'RIGHT_TOP',
+}
+
+export enum SelectBitmapModel {
+  SINGLE_DENSITY_8 = 'SINGLE_DENSITY_8',
+  DOUBLE_DENSITY_8 = 'DOUBLE_DENSITY_8',
+  SINGLE_DENSITY_24 = 'SINGLE_DENSITY_24',
+  DOUBLE_DENSITY_24 = 'DOUBLE_DENSITY_24',
+}
+
+export enum FontType {
+  STANDARD = 'STANDARD',
+  COMPRESS = 'COMPRESS',
+}
+
+export enum WifiEncrypt {
+  NULL = 'NULL',
+  WEP64 = 'WEP64',
+  WEP128 = 'WEP128',
+  WPA_AES_PSK = 'WPA_AES_PSK',
+  WPA_TKIP_PSK = 'WPA_TKIP_PSK',
+  WPA_TKIP_AES_PSK = 'WPA_TKIP_AES_PSK',
+  WPA2_AES_PSK = 'WPA2_AES_PSK',
+  WPA2_TKIP = 'WPA2_TKIP',
+  WPA2_TKIP_AES_PSK = 'WPA2_TKIP_AES_PSK',
+  WPA_WPA2_MixedMode = 'WPA_WPA2_MixedMode',
+}
+
+export enum InternationCharacterSet {
+  AMERICA = 'AMERICA',
+  FRANCE = 'FRANCE',
+  GERMANY = 'GERMANY',
+  ENGLAND = 'ENGLAND',
+  DENMARK1 = 'DENMARK1',
+  SWEDEN = 'SWEDEN',
+  ITALY = 'ITALY',
+  SPAIN1 = 'SPAIN1',
+  JAPAN = 'JAPAN',
+  NORWAY = 'NORWAY',
+  DENMARK2 = 'DENMARK2',
+  SPAIN2 = 'SPAIN2',
+  LATIN_AMERICA = 'LATIN_AMERICA',
+  KOREA = 'KOREA',
+  SLOVENIA_OR_CROATIA = 'SLOVENIA_OR_CROATIA',
+  CHINA = 'CHINA',
+}
+
+export interface PrintTextSizeRequest {
+  data: string;
+  textWidth: TextWidth;
+  textHeight: TextHeight;
+}
+
+export interface PrintTextRequest {
+  //使用对齐方式时，data 需以”\n”结尾，否则有可能会无效
+  data: string;
+  alignment: Alignment;
+  attribute: TextAttribute;
+  textWidth: TextWidth;
+  textHeight: TextHeight;
+}
+
+export type PrintBitmapRequest = {
+  alignment: Alignment;
+  width: number;
+  model: BMPModel;
+  type?: BMPType; //only ios
+  bitmapPath: string | null;
+  bitmapContent: string | null;
+};
+
+export interface PrintBarCodeRequest {
+  data: string;
+  codeType: BarcodeType;
+  //[2，6]
+  width: number;
+  //[1，255]
+  height: number;
+  alignment: Alignment;
+  textPosition: TextPosition;
+}
+
+export interface PrintQRCodeRequest {
+  data: string;
+  //[1,16]
+  moduleSize: number;
+  ecLevel: ECLevel;
+  alignment: Alignment;
+}
+
+export interface SetPrintAreaRequest {
+  //默认为 0
+  x: number;
+  //默认为 0
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface SetTextStyleRequest {
+  //only android
+  attribute: TextAttribute;
+  textWidth: TextWidth;
+  textHeight: TextHeight;
+}
+
+export interface SelectBitmapModelRequest {
+  bitmapPath: string;
+  width: number;
+  model: SelectBitmapModel;
+}
+
+export interface PrintPDF417Request {
+  data: string;
+  //[2- 8]
+  cellWidth: number;
+  //[2-8]
+  cellHeightRatio: number;
+  //[0-30]
+  numberOfColumns: number;
+  //[0, 3-90]
+  //only android
+  numberOfRows: number;
+  //错误纠正等级类型
+  // 范围[0-1]。
+  // 0:误差校正级别由级别来设定 1:误差校正级别由比率设定。比率为 eclValue x 10%
+  //only android
+  eclType: number;
+  //错误纠正等级值
+  // eclType = 0 :范围[ 0 – 8 ].
+  // eclType = 1 :范围[ 1 – 40 ].
+  //only android
+  eclValue: number;
+  alignment: Alignment;
+}
+
+//表的列宽是以单字节字符为 1 个单位来统计的,例如字母‘a’的宽度为 1，中 文的‘印’的宽度为 2。
+// 如果需要换行可再文本中加入‘\n’。 如果文本宽度大于设定的列宽，会自动换行。
+export interface PrintTableRequest {
+  //标题数组集合
+  titles: string[];
+  //各列中单字节字符数量集合
+  numberOfSingleBytesPerCol: number[];
+  //各列的对齐方式，0 左对齐 1 右对齐。 默认为 0。
+  align: number[];
+  rows?: PrintTableRow[];
+}
+
+export interface PrintTableRow {
+  title?: string;
+  data: string[];
+  remark?: string;
+  barcode?: PrintTableBarcode;
+}
+
+export interface PrintTableBarcode {
+  data: string;
+  codeType: BarcodeType;
+  //[1，255] 默认 80
+  width: number;
+  //[2，6] 默认 2
+  height: number;
+  alignment: Alignment;
+  textPosition: TextPosition;
+}
+
+export interface WifiConfigRequest {
+  ip: string;
+  mask: string;
+  gateway: string;
+  ssid: string;
+  password: string;
+  encrypt: WifiEncrypt;
+}
+
+export interface SetNetAllRequest {
+  ip: string;
+  mask: string;
+  gateway: string;
+  dhcpIsOpen: boolean;
+}
+
+export const DEFAULT_TEXT_ATTRIBUTE = TextAttribute.DEFAULT;
+
+export const DEFAULT_TEXT_ALIGNMENT = Alignment.LEFT;
+
+export const DEFAULT_TEXT_POSITION = TextPosition.BELOW;
+
+export const DEFAULT_BARCODE_HEIGHT = 162;
+export const DEFAULT_BARCODE_WIDTH = 3;
+
+export const DEFAULT_LINE_COUNT = 1;
+
+export const DEFAULT_QRCODE_MODULE_SIZE = 8;
+export const DEFAULT_QRCODE_ALIGNMENT = Alignment.CENTER;
+
+export const DEFAULT_PRINT_TABLE_BARCODE_WIDTH = 80;
+export const DEFAULT_PRINT_TABLE_BARCODE_HEIGHT = 2;
+export const DEFAULT_PRINT_TABLE_ALIGNMENT = Alignment.LEFT;
+
+// export const STS_UNKNOWN = -1;
+// export const STS_CASH_OPEN = 0;
+// export const STS_CASH_CLOSE = 1;