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

package/src/devices.ts

@@ -1,280 +1,38 @@
 import type { BrotherQLDevice } from './types.js';
+import { DEVICES, DEVICE_REGISTRY } from './devices.generated.js';
 
-const MASS_STORAGE_PIDS = new Set([0x20aa, 0x20ab]);
+// Mass-storage PIDs aligned to Linux usb-ids (gowdy.us / linux-usb.org).
+// Each large-format printer with Editor Lite enumerates as USB Mass
+// Storage Class on this alternate PID until the user holds the Editor
+// Lite button to switch back to printer-class. Aggregated from each
+// device entry's `capabilities.massStoragePid`.
+const MASS_STORAGE_PIDS = new Set<number>(
+  Object.values(DEVICES).flatMap(d => {
+    const pid = d.capabilities?.massStoragePid;
+    return typeof pid === 'string' ? [parseInt(pid, 16)] : [];
+  }),
+);
 
-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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    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',
-    autocut: true,
-    compression: true,
-    editorLite: true,
-    massStoragePid: 0x20aa,
-  },
-  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',
-    autocut: true,
-    compression: true,
-    editorLite: true,
-    massStoragePid: 0x20ab,
-  },
-  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',
-    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',
-    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',
-    autocut: true,
-    compression: true,
-    editorLite: false,
-  },
-} as const satisfies Record<string, BrotherQLDevice>;
+export { DEVICE_REGISTRY, DEVICES };
+
+/**
+ * Numeric VID/PID extracted from a device's USB transport.
+ *
+ * Returns `undefined` when the device has no USB transport. Hex
+ * strings on the registry (`'0x04f9'`) are parsed at this boundary so
+ * runtime callers stay numeric.
+ */
+export function getUsbIds(device: BrotherQLDevice): { vid: number; pid: number } | undefined {
+  const usb = device.transports.usb;
+  if (!usb) return undefined;
+  return { vid: parseInt(usb.vid, 16), pid: parseInt(usb.pid, 16) };
+}
 
 export function findDevice(vid: number, pid: number): BrotherQLDevice | undefined {
-  return Object.values(DEVICES).find(d => d.vid === vid && d.pid === pid);
+  return Object.values(DEVICES).find(d => {
+    const ids = getUsbIds(d);
+    return ids?.vid === vid && ids.pid === pid;
+  });
 }
 
 export function isMassStorageMode(pid: number): boolean {

package/src/index.ts

@@ -8,11 +8,15 @@ export {
 } from '@mbtech-nl/bitmap';
 
 export type {
-  DeviceDescriptor,
+  DeviceEntry,
+  DeviceRegistry,
+  DeviceTransports,
   MediaDescriptor,
   PreviewOptions,
   PreviewPlane,
   PreviewResult,
+  PrintEngine,
+  PrintEngineCapabilities,
   PrintOptions,
   PrinterAdapter,
   PrinterError,
@@ -20,6 +24,7 @@ export type {
   RotateDirection,
   Transport,
   TransportType,
+  UsbTransport,
 } from '@thermal-label/contracts';
 
 export {
@@ -28,20 +33,38 @@ export {
   UnsupportedOperationError,
 } from '@thermal-label/contracts';
 
-export { DEVICES, findDevice, isMassStorageMode } from './devices.js';
+export { DEVICE_REGISTRY, DEVICES, findDevice, getUsbIds, isMassStorageMode } from './devices.js';
+
+/**
+ * Protocols this core's encoder produces correct wire bytes for.
+ * Pair with `DEVICE_REGISTRY` and pass to `resolveSupportedDevices`
+ * from `@thermal-label/contracts` to filter a device list down to
+ * what this runtime can actually drive.
+ */
+export const PROTOCOLS: ReadonlySet<string> = new Set(['ql-raster', 'pt-raster']);
 export {
   DEFAULT_MEDIA,
+  DEFAULT_PT_MEDIA,
   MEDIA,
+  defaultMediaForEngine,
   findMedia,
   findMediaByDimensions,
   findMediaByWidth,
+  resolveTapeGeometry,
 } from './media.js';
 export { ROTATE_DIRECTION } from './orientation.js';
-export { encodeJob } from './protocol.js';
+export {
+  encodeJob,
+  encodeJobForEngine,
+  PT_PROTOCOL_CONFIG,
+  QL_PROTOCOL_CONFIG,
+} from './protocol.js';
+export type { EncoderEngine, RasterProtocolConfig } from './protocol.js';
 export { parseStatus, STATUS_REQUEST } from './status.js';
 export { createPreviewOffline } from './preview.js';
 
 export type {
+  BrotherEngineCapabilities,
   BrotherQLDevice,
   BrotherQLMedia,
   BrotherQLPrintOptions,
@@ -50,7 +73,8 @@ export type {
   HeadWidth,
   JobOptions,
   MediaType,
-  NetworkSupport,
   PageData,
   PageOptions,
+  TapeGeometry,
+  TapeSystem,
 } from './types.js';