@thermal-label/brother-ql-core 0.0.1 → 0.3.0

package/src/types.ts

@@ -1,43 +1,74 @@
-import { type LabelBitmap } from '@mbtech-nl/bitmap';
+import type { LabelBitmap } from '@mbtech-nl/bitmap';
+import type {
+  DeviceDescriptor,
+  MediaDescriptor,
+  PrintOptions,
+  PrinterStatus,
+} from '@thermal-label/contracts';
 
 export type MediaType = 'continuous' | 'die-cut';
 export type HeadWidth = 720 | 1296;
 export type ColorMode = 'single' | 'two-color';
 export type NetworkSupport = 'none' | 'wifi' | 'wired' | 'wifi+wired';
 
-export interface DeviceDescriptor {
-  name: string;
+/**
+ * Brother QL device descriptor.
+ *
+ * Extends the contracts base with QL-specific fields: head geometry,
+ * protocol feature flags, and the optional mass-storage PID for Editor
+ * Lite mode.
+ *
+ * **Bluetooth on the QL-820NWB / 820NWBc**: not exposed over GATT.
+ * Classic Bluetooth (SPP) is paired at the OS level; the kernel/driver
+ * exposes an RFCOMM serial port, reachable via the `'serial'` transport
+ * in Node.js and the `'web-serial'` transport in Chrome/Edge. macOS has
+ * dropped classic Bluetooth SPP — no serial route there.
+ */
+export interface BrotherQLDevice extends DeviceDescriptor {
+  family: 'brother-ql';
   vid: number;
   pid: number;
   headPins: HeadWidth;
   bytesPerRow: number;
   twoColor: boolean;
   network: NetworkSupport;
-  bluetooth: boolean;
   autocut: boolean;
   compression: boolean;
   editorLite: boolean;
+  /** Alternate PID seen when the printer is in Editor Lite mass-storage mode. */
   massStoragePid?: number;
 }
 
-export interface MediaDescriptor {
+/**
+ * Brother QL media descriptor.
+ *
+ * Extends `MediaDescriptor` with the dots-based geometry the raster
+ * encoder needs. The base `palette` field flips the driver into
+ * multi-plane mode — only DK-22251 declares one in the registry.
+ */
+export interface BrotherQLMedia extends MediaDescriptor {
   id: number;
-  name: string;
   type: MediaType;
-  widthMm: number;
-  lengthMm: number;
   printAreaDots: number;
   leftMarginPins: number;
   rightMarginPins: number;
+  /** Die-cut masked area in dots (registration windows). */
   dieCutMaskedAreaDots?: number;
-  /** True for DK-22251 and similar two-color tapes — printer rejects single-color jobs */
-  twoColorTape?: boolean;
+}
+
+/**
+ * Brother QL status — contracts `PrinterStatus` plus the
+ * `editorLiteMode` flag (pre-paired QL-820NWB silently drops raster
+ * jobs when in Editor Lite mode; callers need to know).
+ */
+export interface BrotherQLStatus extends PrinterStatus {
+  editorLiteMode: boolean;
 }
 
 export interface PageData {
   bitmap: LabelBitmap;
   redBitmap?: LabelBitmap;
-  media: MediaDescriptor;
+  media: BrotherQLMedia;
   options?: PageOptions;
 }
 
@@ -53,25 +84,14 @@ export interface JobOptions {
   copies?: number;
 }
 
-export interface TextPrintOptions extends PageOptions {
-  invert?: boolean;
-  scaleX?: number;
-  scaleY?: number;
-}
-
-export interface ImagePrintOptions extends PageOptions {
-  threshold?: number;
-  dither?: boolean;
-  invert?: boolean;
-  rotate?: 0 | 90 | 180 | 270;
-}
-
-export interface PrinterStatus {
-  ready: boolean;
-  mediaWidthMm: number;
-  mediaLengthMm: number;
-  mediaType: MediaType | null;
-  errors: string[];
-  editorLiteMode: boolean;
-  rawBytes: Uint8Array;
+/**
+ * Per-call print options for `BrotherQLPrinter.print()`.
+ *
+ * Extends the cross-driver `PrintOptions` with QL-specific knobs. The
+ * `rotate` override picks the rotation angle passed to
+ * `renderImage` / `renderMultiPlaneImage` — `'auto'` (the default)
+ * defers to the media's `defaultOrientation` heuristic.
+ */
+export interface BrotherQLPrintOptions extends PrintOptions {
+  rotate?: 'auto' | 0 | 90 | 180 | 270;
 }