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

package/src/__tests__/protocol.test.ts

@@ -14,7 +14,7 @@ import {
   buildExpandedMode,
   encodeJob,
 } from '../protocol.js';
-import { type PageData } from '../types.js';
+import type { PageData } from '../types.js';
 import { MEDIA } from '../media.js';
 
 describe('buildInvalidate', () => {
@@ -170,6 +170,52 @@ describe('encodeJob', () => {
     }
     expect(found).toBe(true);
   });
+
+  it('compress option PackBits-encodes each raster row (LEN < uncompressed size)', () => {
+    // All-zero bitmap → every row is 90 zero bytes. PackBits collapses each
+    // row to 2 wire bytes (0xA7 0x00), so the LEN byte in the row header
+    // should be 2 instead of 90.
+    const page: PageData = { ...makePage(696, 3), options: { compress: true } };
+    const buf = encodeJob([page]);
+    // Find single-color row headers (0x67 0x00 LEN). With compression on,
+    // LEN should be 2 for each row, and the payload byte should be 0x00.
+    const rowHeaders: number[] = [];
+    for (let i = 0; i < buf.length - 4; i++) {
+      if (buf[i] === 0x67 && buf[i + 1] === 0x00) {
+        // Skip the byte sequence inside the 200-byte invalidate block
+        // (which is also all zeros, so 0x67 won't appear there). Heuristic:
+        // verify the next byte after LEN is the PackBits header 0xA7.
+        if (buf[i + 2] === 2 && buf[i + 3] === 0xa7 && buf[i + 4] === 0x00) {
+          rowHeaders.push(i);
+        }
+      }
+    }
+    expect(rowHeaders.length).toBe(3);
+  });
+
+  it('compress option two-color: both planes PackBits-encoded per row', () => {
+    const bitmap = createBitmap(696, 2);
+    const redBitmap = createBitmap(696, 2);
+    const page: PageData = {
+      bitmap,
+      redBitmap,
+      media: media62,
+      options: { compress: true },
+    };
+    const buf = encodeJob([page]);
+    const blackRows: number[] = [];
+    const redRows: number[] = [];
+    for (let i = 0; i < buf.length - 4; i++) {
+      // Each compressed row is [0x77 0x01|0x02 0x02 0xA7 0x00] for an empty
+      // 696-pin row (90 zero bytes → 2 PackBits bytes).
+      if (buf[i] === 0x77 && buf[i + 2] === 2 && buf[i + 3] === 0xa7 && buf[i + 4] === 0x00) {
+        if (buf[i + 1] === 0x01) blackRows.push(i);
+        if (buf[i + 1] === 0x02) redRows.push(i);
+      }
+    }
+    expect(blackRows.length).toBe(2);
+    expect(redRows.length).toBe(2);
+  });
 });
 
 describe('buildRasterMode', () => {

package/src/__tests__/status.test.ts

@@ -33,44 +33,53 @@ describe('parseStatus', () => {
   it('returns ready=true with no errors', () => {
     const status = parseStatus(makeStatusBytes());
     expect(status.ready).toBe(true);
-    expect(status.errors).toHaveLength(0);
+    expect(status.errors).toEqual([]);
   });
 
-  it('parses media width and type', () => {
+  it('resolves 62mm continuous to detectedMedia', () => {
     const status = parseStatus(makeStatusBytes({ mediaWidthMm: 62, mediaTypeByte: 0x0a }));
-    expect(status.mediaWidthMm).toBe(62);
-    expect(status.mediaType).toBe('continuous');
+    expect(status.mediaLoaded).toBe(true);
+    expect(status.detectedMedia?.id).toBe(259);
+    expect(status.detectedMedia?.widthMm).toBe(62);
+    expect(status.detectedMedia?.type).toBe('continuous');
   });
 
-  it('parses media length from byte 17 (0 for continuous, mm for die-cut)', () => {
-    const cont = parseStatus(makeStatusBytes({ mediaLengthMm: 0 }));
-    expect(cont.mediaLengthMm).toBe(0);
-    const diecut = parseStatus(makeStatusBytes({ mediaTypeByte: 0x0b, mediaLengthMm: 90 }));
-    expect(diecut.mediaLengthMm).toBe(90);
+  it('resolves 62x29mm die-cut to detectedMedia', () => {
+    const status = parseStatus(
+      makeStatusBytes({ mediaWidthMm: 62, mediaTypeByte: 0x0b, mediaLengthMm: 29 }),
+    );
+    expect(status.detectedMedia?.id).toBe(274);
+    expect(status.detectedMedia?.type).toBe('die-cut');
+    expect(status.detectedMedia?.heightMm).toBe(29);
   });
 
-  it('parses die-cut media type', () => {
-    const status = parseStatus(makeStatusBytes({ mediaTypeByte: 0x0b }));
-    expect(status.mediaType).toBe('die-cut');
+  it('leaves detectedMedia undefined for unknown media', () => {
+    const status = parseStatus(makeStatusBytes({ mediaWidthMm: 100, mediaTypeByte: 0x0a }));
+    expect(status.detectedMedia).toBeUndefined();
   });
 
-  it('returns null mediaType for unknown byte', () => {
-    const status = parseStatus(makeStatusBytes({ mediaTypeByte: 0xff }));
-    expect(status.mediaType).toBeNull();
+  it('leaves mediaLoaded=false when width is 0', () => {
+    const status = parseStatus(makeStatusBytes({ mediaWidthMm: 0, mediaTypeByte: 0 }));
+    expect(status.mediaLoaded).toBe(false);
   });
 
-  it('parses error info 1 bits', () => {
-    const status = parseStatus(makeStatusBytes({ errInfo1: 0b00000001 })); // No media
-    expect(status.errors).toContain('No media');
+  it('surfaces no_media error code for err1 bit 0', () => {
+    const status = parseStatus(makeStatusBytes({ errInfo1: 0b00000001 }));
+    expect(status.errors.map(e => e.code)).toContain('no_media');
     expect(status.ready).toBe(false);
   });
 
-  it('parses error info 2 bits', () => {
-    const status = parseStatus(makeStatusBytes({ errInfo2: 0b00010000 })); // Cover open
-    expect(status.errors).toContain('Cover open');
+  it('surfaces cover_open error code for err2 bit 4', () => {
+    const status = parseStatus(makeStatusBytes({ errInfo2: 0b00010000 }));
+    expect(status.errors.map(e => e.code)).toContain('cover_open');
     expect(status.ready).toBe(false);
   });
 
+  it('surfaces cutter_jam error code for err1 bit 2', () => {
+    const status = parseStatus(makeStatusBytes({ errInfo1: 0b00000100 }));
+    expect(status.errors.map(e => e.code)).toContain('cutter_jam');
+  });
+
   it('ready=false when statusType is error (0x02)', () => {
     const status = parseStatus(makeStatusBytes({ statusType: 0x02 }));
     expect(status.ready).toBe(false);
@@ -82,7 +91,7 @@ describe('parseStatus', () => {
     expect(status.rawBytes).toEqual(bytes);
   });
 
-  it('editorLiteMode is false (detected at discovery time, not from status bytes)', () => {
+  it('editorLiteMode is on the BrotherQLStatus extension', () => {
     const status = parseStatus(makeStatusBytes());
     expect(status.editorLiteMode).toBe(false);
   });

package/src/devices.ts

@@ -1,199 +1,214 @@
-import { type DeviceDescriptor } from './types.js';
+import type { BrotherQLDevice } from './types.js';
 
 const MASS_STORAGE_PIDS = new Set([0x20aa, 0x20ab]);
 
 export const DEVICES = {
   QL_820NWB: {
     name: 'QL-820NWB',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp', 'serial', 'web-serial'],
     vid: 0x04f9,
     pid: 0x20a7,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: true,
     network: 'wifi+wired',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
   },
   QL_820NWBc: {
     name: 'QL-820NWBc',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp', 'serial', 'web-serial'],
     vid: 0x04f9,
     pid: 0x209d,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: true,
     network: 'wifi+wired',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
   },
   QL_810W: {
     name: 'QL-810W',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp'],
     vid: 0x04f9,
     pid: 0x209c,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: true,
     network: 'wifi',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
   },
   QL_800: {
     name: 'QL-800',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x209b,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: true,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
   },
   QL_720NW: {
     name: 'QL-720NW',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp'],
     vid: 0x04f9,
     pid: 0x2045,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'wired',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: false,
   },
   QL_710W: {
     name: 'QL-710W',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp'],
     vid: 0x04f9,
     pid: 0x2044,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'wifi',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
   },
   QL_700: {
     name: 'QL-700',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x2042,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
   },
   QL_600: {
     name: 'QL-600',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x2100,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: false,
   },
   QL_580N: {
     name: 'QL-580N',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp'],
     vid: 0x04f9,
     pid: 0x201b,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'wired',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: false,
   },
   QL_570: {
     name: 'QL-570',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x2019,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: false,
   },
   QL_560: {
     name: 'QL-560',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x2018,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: false,
     editorLite: false,
   },
   QL_550: {
     name: 'QL-550',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x2016,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: false,
     compression: false,
     editorLite: false,
   },
   QL_500: {
     name: 'QL-500',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x2013,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: false,
     compression: false,
     editorLite: false,
   },
   QL_650TD: {
     name: 'QL-650TD',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x201c,
     headPins: 720,
     bytesPerRow: 90,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: false,
   },
   QL_1100: {
     name: 'QL-1100',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x20a8,
     headPins: 1296,
     bytesPerRow: 162,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
@@ -201,13 +216,14 @@ export const DEVICES = {
   },
   QL_1110NWB: {
     name: 'QL-1110NWB',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp'],
     vid: 0x04f9,
     pid: 0x20a9,
     headPins: 1296,
     bytesPerRow: 162,
     twoColor: false,
     network: 'wifi+wired',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
@@ -215,46 +231,49 @@ export const DEVICES = {
   },
   QL_1115NWB: {
     name: 'QL-1115NWB',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp'],
     vid: 0x04f9,
     pid: 0x20ac,
     headPins: 1296,
     bytesPerRow: 162,
     twoColor: false,
     network: 'wifi+wired',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: true,
   },
   QL_1050: {
     name: 'QL-1050',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb'],
     vid: 0x04f9,
     pid: 0x2027,
     headPins: 1296,
     bytesPerRow: 162,
     twoColor: false,
     network: 'none',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: false,
   },
   QL_1060N: {
     name: 'QL-1060N',
+    family: 'brother-ql',
+    transports: ['usb', 'webusb', 'tcp'],
     vid: 0x04f9,
     pid: 0x2028,
     headPins: 1296,
     bytesPerRow: 162,
     twoColor: false,
     network: 'wired',
-    bluetooth: false,
     autocut: true,
     compression: true,
     editorLite: false,
   },
-} as const satisfies Record<string, DeviceDescriptor>;
+} as const satisfies Record<string, BrotherQLDevice>;
 
-export function findDevice(vid: number, pid: number): DeviceDescriptor | undefined {
+export function findDevice(vid: number, pid: number): BrotherQLDevice | undefined {
   return Object.values(DEVICES).find(d => d.vid === vid && d.pid === pid);
 }
 

package/src/index.ts

@@ -1,22 +1,56 @@
-export type { LabelBitmap, RawImageData } from '@mbtech-nl/bitmap';
-export { renderText, renderImage, rotateBitmap, flipHorizontal } from '@mbtech-nl/bitmap';
+export type { LabelBitmap, PaletteEntry, RawImageData } from '@mbtech-nl/bitmap';
+export {
+  flipHorizontal,
+  renderImage,
+  renderMultiPlaneImage,
+  renderText,
+  rotateBitmap,
+} from '@mbtech-nl/bitmap';
+
+export type {
+  DeviceDescriptor,
+  MediaDescriptor,
+  PreviewOptions,
+  PreviewPlane,
+  PreviewResult,
+  PrintOptions,
+  PrinterAdapter,
+  PrinterError,
+  PrinterStatus,
+  RotateDirection,
+  Transport,
+  TransportType,
+} from '@thermal-label/contracts';
+
+export {
+  MediaNotSpecifiedError,
+  pickRotation,
+  UnsupportedOperationError,
+} from '@thermal-label/contracts';
 
 export { DEVICES, findDevice, isMassStorageMode } from './devices.js';
-export { MEDIA, findMedia, findMediaByWidth } from './media.js';
+export {
+  DEFAULT_MEDIA,
+  MEDIA,
+  findMedia,
+  findMediaByDimensions,
+  findMediaByWidth,
+} from './media.js';
+export { ROTATE_DIRECTION } from './orientation.js';
 export { encodeJob } from './protocol.js';
 export { parseStatus, STATUS_REQUEST } from './status.js';
+export { createPreviewOffline } from './preview.js';
 
 export type {
-  MediaType,
-  HeadWidth,
+  BrotherQLDevice,
+  BrotherQLMedia,
+  BrotherQLPrintOptions,
+  BrotherQLStatus,
   ColorMode,
+  HeadWidth,
+  JobOptions,
+  MediaType,
   NetworkSupport,
-  DeviceDescriptor,
-  MediaDescriptor,
   PageData,
   PageOptions,
-  JobOptions,
-  PrinterStatus,
-  TextPrintOptions,
-  ImagePrintOptions,
 } from './types.js';