jc-printer-sdk-ts 0.1.0

package/src/types.ts

@@ -0,0 +1,385 @@
+import type {
+  AddressType,
+  GeneralProgress,
+  PrintFailReason,
+  PrintParamName,
+  PrintProgress,
+  PrinterState,
+  ProgressInfo,
+} from "./constants.js";
+
+export type MaybePromise<T> = T | Promise<T>;
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue =
+  | JsonPrimitive
+  | { [key: string]: JsonValue }
+  | JsonValue[];
+
+export type BinaryLike = Uint8Array | ArrayBuffer | ArrayBufferView | string;
+
+export interface BundleLike {
+  [key: string]: unknown;
+}
+
+export interface Rect {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface Line {
+  x1: number;
+  y1: number;
+  x2: number;
+  y2: number;
+}
+
+export interface Point {
+  x: number;
+  y: number;
+}
+
+export interface BitmapLike {
+  width: number;
+  height: number;
+  data?: BinaryLike;
+  mimeType?: string;
+  description?: string;
+  meta?: Record<string, unknown>;
+}
+
+export interface BluetoothDeviceLike {
+  address: string;
+  name?: string;
+  type?: number;
+  bondState?: number;
+}
+
+export interface PrinterAddress {
+  macAddress: string;
+  addressType: AddressType;
+  shownName: string;
+}
+
+export interface PrinterInfo {
+  readonly deviceType: number;
+  readonly deviceName: string;
+  readonly deviceVersion: string;
+  readonly softwareVersion: string;
+  readonly deviceAddress: string;
+  readonly deviceAddrType: number;
+  readonly deviceDPI: number;
+  readonly deviceWidth: number;
+  readonly manufacturer: string;
+  readonly seriesName: string;
+  readonly devIntName: string;
+  readonly peripheralFlags: number;
+  readonly hardwareFlags: number;
+  readonly softwareFlags: number;
+}
+
+export interface PrinterParam {
+  deviceType: number;
+  deviceName: string;
+  deviceVersion: string;
+  softwareVersion: string;
+  deviceAddress: string;
+  deviceAddrType: number;
+  printerDPI: number;
+  printerWidth: number;
+  printDarkness: number;
+  darknessCount: number;
+  darknessMinSuggested: number;
+  printSpeed: number;
+  speedCount: number;
+  gapType: number;
+  gapLength: number;
+  motorMode: number;
+  autoPowerOffMins: number;
+  language: number;
+  supportedGapTypes: number[];
+  supportedMotorModes: number[];
+  supportedLanguages: number[];
+  manufacturer: string;
+  seriesName: string;
+  devIntName: string;
+  peripheralFlags: number;
+  hardwareFlags: number;
+  softwareFlags: number;
+  attributeFlags: number;
+}
+
+export interface DiscoveriedPrinter extends PrinterAddress {
+  discoveriedType: AddressType;
+  rssi: number | null;
+}
+
+export interface PrinterDevice {
+  port: number;
+  connNum: number;
+  deviceName?: string;
+  deviceAddress?: string;
+  deviceIp?: string;
+}
+
+export interface PaperInfo {
+  state: number;
+  gapHeightPixel: number;
+  totalHeightPixel: number;
+  paperType: number;
+  gapHeight: number;
+  totalHeight: number;
+  paperWidthPixel: number;
+  paperWidth: number;
+  direction: number;
+  tailLengthPixel: number;
+  tailLength: number;
+}
+
+export interface ColorSupport {
+  normalMode: number;
+  rbMode: number;
+  grayMode: number;
+}
+
+export interface QualitySupport {
+  highQuality: number;
+  highSpeed: number;
+}
+
+export interface KeyProperty {
+  key: number;
+  functionCode: number[];
+}
+
+export interface PrinterProperty {
+  state: number;
+  keyProperty: KeyProperty[];
+}
+
+export interface PrinterTimeBean {
+  state: number;
+  year: number;
+  month: number;
+  day: number;
+  hour: number;
+  minute: number;
+  second: number;
+}
+
+export interface ImageParam {
+  data?: Uint8Array;
+  channels: number;
+  width: number;
+  height: number;
+  x: number;
+  y: number;
+  fontSize: number;
+  errorCode: number;
+  errorInfo: string;
+}
+
+export interface ImageDataInfo {
+  bitmap?: BitmapLike;
+  errorCode: number;
+  errorInfo: string;
+}
+
+export interface StartJobParameter {
+  density: number;
+  paperType: number;
+  printMode: number;
+  color: number;
+  quality: number;
+  isSetDensity: boolean;
+}
+
+export interface DrawParamState {
+  [name: string]: unknown;
+}
+
+export interface PrintJobOptions {
+  density?: number;
+  paperType?: number;
+  printMode?: number;
+  color?: number;
+  quality?: number;
+  totalQuantity?: number;
+  printMultiple?: number;
+  epc?: string;
+  pageUnit?: "mm" | "px";
+  meta?: Record<string, unknown>;
+}
+
+export interface PageOptions {
+  width: number;
+  height: number;
+  orientation: number;
+  fonts?: string[];
+  background?: number;
+  printQuantity?: number;
+  drawParams?: DrawParamState;
+}
+
+export interface LabelTextOptions {
+  rotation?: number;
+  horizontalAlignment?: number;
+  verticalAlignment?: number;
+  mode?: number;
+  indent?: number;
+  scale?: number;
+  flags?: boolean[];
+}
+
+export interface LabelBarcodeOptions {
+  rotation?: number;
+  ratio?: number;
+  fontSize?: number;
+  fontName?: string;
+  showText?: boolean;
+  threshold?: number;
+  alignment?: number;
+  quietZone?: number;
+}
+
+export interface LabelQrCodeOptions {
+  rotation?: number;
+  version?: number;
+  errorCorrectionLevel?: number;
+  margin?: number;
+}
+
+export interface LabelGraphOptions {
+  rotation?: number;
+  lineWidth?: number;
+  penAlignment?: number;
+  dashPattern?: number[];
+}
+
+export interface LabelImageOptions {
+  rotation?: number;
+  threshold?: number;
+  scale?: number;
+  actualSize?: boolean;
+}
+
+export interface LabelLineOptions {
+  lineWidth?: number;
+  rotation?: number;
+  penAlignment?: number;
+  dashPattern?: number[];
+}
+
+export interface CanvasCommand {
+  kind: string;
+  payload: Record<string, unknown>;
+}
+
+export interface PrintPage {
+  width: number;
+  height: number;
+  orientation: number;
+  fonts: string[];
+  background: number;
+  printQuantity: number;
+  drawParams: DrawParamState;
+  commands: CanvasCommand[];
+}
+
+export interface PrintDocument {
+  schema: "jc-printer-sdk-ts/print-document@1";
+  unit: "mm" | "px";
+  job: PrintJobOptions;
+  pages: PrintPage[];
+}
+
+export interface CommitPayload {
+  jsonPages: string[];
+  infoPages: string[];
+}
+
+export interface PrintCallback {
+  onProgress(
+    pageIndex: number,
+    quantityIndex: number,
+    meta: Record<string, unknown>,
+  ): void;
+  onError(errorCode: number, printState?: number): void;
+  onBufferFree(pageIndex: number, bufferSize: number): void;
+  onCancelJob(isSuccess: boolean): void;
+}
+
+export interface PrinterSdkCallback {
+  onConnectSuccess(address: string, type: number): void;
+  onDisConnect(): void;
+  onElectricityChange(powerLevel: number): void;
+  onCoverStatus(coverStatus: number): void;
+  onPaperStatus(paperStatus: number): void;
+  onRfidReadStatus(rfidReadStatus: number): void;
+  onRibbonStatus(ribbonStatus: number): void;
+  onRibbonRfidReadStatus(ribbonRfidReadStatus: number): void;
+  onFirmErrors(): void;
+}
+
+export interface ScanCallback {
+  onScan(printerDevice: PrinterDevice): void;
+  onFinish(): void;
+}
+
+export interface IDzPrinterCallback {
+  onProgressInfo(info: ProgressInfo, payload: unknown): void;
+  onStateChange(address: PrinterAddress, state: PrinterState): void;
+  onPrintProgress(
+    address: PrinterAddress,
+    job: unknown,
+    progress: PrintProgress,
+    payload: unknown,
+  ): void;
+  onPrinterDiscovery(address: PrinterAddress, info: PrinterInfo): void;
+}
+
+export interface IDzPrinter2Callback extends IDzPrinterCallback {
+  onBondProgress(address: PrinterAddress, progress: GeneralProgress): void;
+  onSetParamProgress(address: PrinterAddress, progress: GeneralProgress): void;
+  onSendDataProgress(packageData: unknown, progress: GeneralProgress): void;
+  onPrinterParamChanged(
+    address: PrinterAddress,
+    previous: PrinterParam,
+    next: PrinterParam,
+  ): void;
+  onDeviceDiscovery(progress: GeneralProgress, payload: unknown): void;
+}
+
+export interface ActionCallback {
+  onProgress(progress: GeneralProgress, payload: unknown): void;
+}
+
+export interface ActionWithResponseCallback extends ActionCallback {
+  onResponse(response: Uint8Array): void;
+}
+
+export interface IAtBitmapDocument {
+  schema: "jc-printer-sdk-ts/at-bitmap@1";
+  unit: "px";
+  job: PrintJobOptions;
+  pages: PrintPage[];
+}
+
+export interface LegacyPrintParams {
+  [name: string]: unknown;
+}
+
+export interface LegacyPrintParamValues {
+  [name: string]: number | string;
+}
+
+export type {
+  AddressType,
+  GeneralProgress,
+  PrintFailReason,
+  PrintParamName,
+  PrintProgress,
+  ProgressInfo,
+  PrinterState,
+};