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

package/src/devices.generated.ts

@@ -1,9 +1,26 @@
-// AUTO-GENERATED by scripts/compile-data.mjs — do not edit by hand.
-// Regenerate with `pnpm --filter @thermal-label/brother-ql-core compile-data`.
-import type { DeviceRegistry } from '@thermal-label/contracts';
-import type { BrotherQLDevice } from './types.js';
+// AUTO-GENERATED by scripts/compile-data.mjs from packages/core/data/devices/*.json5.
+// Edit those files, not this one. Run `pnpm --filter @thermal-label/brother-ql-core compile-data`.
 
-export const DEVICE_REGISTRY = {
+import type { DeviceEntry, DeviceRegistry } from '@thermal-label/contracts';
+
+/**
+ * Render-time effective status — superset of the contracts' stored
+ * verification rungs that includes `'expected'` (propagated lift)
+ * and `'unverified'` (no claim). Mirrors `EffectiveStatus` in
+ * @thermal-label/contracts ≥ 0.6; literal here so codegen does not
+ * require the matching contracts version on consumers' machines.
+ */
+export type EffectiveStatus = 'verified' | 'partial' | 'unsupported' | 'expected' | 'unverified';
+
+/** Each entry carries a rolled-up `supportStatus` from the verification grid. */
+export type RegistryDeviceEntry = DeviceEntry & { supportStatus: EffectiveStatus };
+
+/** Registry shape with `supportStatus` stamped on each device. */
+export type RegistryWithStatus = Omit<DeviceRegistry, 'devices'> & {
+  devices: readonly RegistryDeviceEntry[];
+};
+
+export const REGISTRY = {
   "schemaVersion": 1,
   "driver": "brother-ql",
   "devices": [
@@ -41,7 +58,8 @@ export const DEVICE_REGISTRY = {
       "hardwareQuirks": "Cutter requires compression to be enabled — encoder enforces this when (autocut: true && compress: false). Source: nbuchwitz/ptouch:PTE550W (\"E550W requires compression ON for cutting to work\"). Pin configurations from Brother spec cv_pte550wp750wp710bt_eng_raster_102.pdf p.20 §2.3, transcribed into media.json5 via nbuchwitz/ptouch.",
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "unverified"
     },
     {
       "key": "PT_P750W",
@@ -80,7 +98,8 @@ export const DEVICE_REGISTRY = {
       "hardwareQuirks": "PID disagreement between driver projects on which mode 0x2062 vs 0x2065 represents: libptouch.c says 0x2062 is the printer PID and 0x2065 is PLite mass-storage; nbuchwitz/ptouch says 0x2065 is the printer PID. We treat libptouch.c as authoritative; flip via a contributor report if discovery fails on real hardware. Pin configurations from Brother spec cv_pte550wp750wp710bt_eng_raster_102.pdf p.20 §2.3.",
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "unverified"
     },
     {
       "key": "PT_P900",
@@ -113,7 +132,8 @@ export const DEVICE_REGISTRY = {
       "hardwareQuirks": "Pin configurations from Brother spec cv_ptp900_eng_raster_102.pdf pp.23-24 §2.3.5, transcribed into media.json5 via nbuchwitz/ptouch:PTP900Series. Note nbuchwitz/ptouch:PTP900Series.DEFAULT_USE_COMPRESSION = False — unlike PT-E550W, P900 does NOT require compression for the cutter.",
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "unverified"
     },
     {
       "key": "PT_P900W",
@@ -149,7 +169,8 @@ export const DEVICE_REGISTRY = {
       "hardwareQuirks": "PID 0x2085 sourced from nbuchwitz/ptouch:PTP900W; not in most public USB-ID databases — phase 4 hardware verification should confirm.",
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "unverified"
     },
     {
       "key": "PT_P910BT",
@@ -183,7 +204,8 @@ export const DEVICE_REGISTRY = {
       "hardwareQuirks": "Bluetooth assumed classic SPP per nbuchwitz/ptouch — phase 4 hardware verification should confirm classic vs BLE GATT before users rely on it. HSe heat-shrink unsupported (TZe-only); engine.mediaCompatibility excludes hse-2to1 and hse-3to1 so the lookup never returns those entries.",
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "unverified"
     },
     {
       "key": "PT_P950NW",
@@ -219,7 +241,8 @@ export const DEVICE_REGISTRY = {
       "hardwareQuirks": "PID 0x2086 sourced from nbuchwitz/ptouch:PTP950NW. Pin configurations from Brother spec cv_ptp900_eng_raster_102.pdf via nbuchwitz/ptouch.",
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "unverified"
     },
     {
       "key": "QL_1050",
@@ -249,7 +272,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_1060N",
@@ -282,7 +306,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_1100",
@@ -316,7 +341,8 @@ export const DEVICE_REGISTRY = {
       },
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_1110NWB",
@@ -353,7 +379,8 @@ export const DEVICE_REGISTRY = {
       },
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_1115NWB",
@@ -390,7 +417,8 @@ export const DEVICE_REGISTRY = {
       },
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_500",
@@ -418,7 +446,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_550",
@@ -446,7 +475,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_560",
@@ -475,7 +505,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_570",
@@ -504,7 +535,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_580N",
@@ -536,7 +568,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_600",
@@ -565,7 +598,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_650TD",
@@ -594,7 +628,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_700",
@@ -627,7 +662,8 @@ export const DEVICE_REGISTRY = {
       "hardwareQuirks": "Cassette-based media detection. Printer hard-rejects with an error code if the host job dimensions do not match the loaded DK cassette. Apps that compare detected vs selected media should switch to the matching cassette before sending.",
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_710W",
@@ -662,7 +698,8 @@ export const DEVICE_REGISTRY = {
       },
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_720NW",
@@ -694,7 +731,8 @@ export const DEVICE_REGISTRY = {
       ],
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_800",
@@ -727,7 +765,8 @@ export const DEVICE_REGISTRY = {
       },
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_810W",
@@ -763,7 +802,8 @@ export const DEVICE_REGISTRY = {
       },
       "support": {
         "status": "untested"
-      }
+      },
+      "supportStatus": "expected"
     },
     {
       "key": "QL_820NWBc",
@@ -822,19 +862,37 @@ export const DEVICE_REGISTRY = {
             "notes": "Bench verification by the maintainer at the time of seeding this entry. Issue #0 is a placeholder — replace with the real issue number when a public verification report is filed."
           }
         ]
-      }
+      },
+      "supportStatus": "verified"
     }
   ]
-} as const satisfies DeviceRegistry;
+} as const satisfies RegistryWithStatus;
 
-type DeviceKey = (typeof DEVICE_REGISTRY)['devices'][number]['key'];
+export type DeviceKey = 'PT_E550W' | 'PT_P750W' | 'PT_P900' | 'PT_P900W' | 'PT_P910BT' | 'PT_P950NW' | 'QL_1050' | 'QL_1060N' | 'QL_1100' | 'QL_1110NWB' | 'QL_1115NWB' | 'QL_500' | 'QL_550' | 'QL_560' | 'QL_570' | 'QL_580N' | 'QL_600' | 'QL_650TD' | 'QL_700' | 'QL_710W' | 'QL_720NW' | 'QL_800' | 'QL_810W' | 'QL_820NWBc';
 
-/**
- * Per-key map of device entries. Built from the registry array via
- * `Object.fromEntries`, but typed as `Record<DeviceKey, BrotherQLDevice>`
- * so consumers can write `DEVICES.QL_820NWBc` and get a precise type
- * back without literal narrowing leaking into engine capability access.
- */
-export const DEVICES = Object.fromEntries(
-  DEVICE_REGISTRY.devices.map(d => [d.key, d]),
-) as unknown as Record<DeviceKey, BrotherQLDevice>;
+export const DEVICES: Record<DeviceKey, RegistryDeviceEntry> = {
+  PT_E550W: REGISTRY.devices[0],
+  PT_P750W: REGISTRY.devices[1],
+  PT_P900: REGISTRY.devices[2],
+  PT_P900W: REGISTRY.devices[3],
+  PT_P910BT: REGISTRY.devices[4],
+  PT_P950NW: REGISTRY.devices[5],
+  QL_1050: REGISTRY.devices[6],
+  QL_1060N: REGISTRY.devices[7],
+  QL_1100: REGISTRY.devices[8],
+  QL_1110NWB: REGISTRY.devices[9],
+  QL_1115NWB: REGISTRY.devices[10],
+  QL_500: REGISTRY.devices[11],
+  QL_550: REGISTRY.devices[12],
+  QL_560: REGISTRY.devices[13],
+  QL_570: REGISTRY.devices[14],
+  QL_580N: REGISTRY.devices[15],
+  QL_600: REGISTRY.devices[16],
+  QL_650TD: REGISTRY.devices[17],
+  QL_700: REGISTRY.devices[18],
+  QL_710W: REGISTRY.devices[19],
+  QL_720NW: REGISTRY.devices[20],
+  QL_800: REGISTRY.devices[21],
+  QL_810W: REGISTRY.devices[22],
+  QL_820NWBc: REGISTRY.devices[23],
+};

package/src/devices.ts

@@ -1,5 +1,10 @@
 import type { BrotherQLDevice } from './types.js';
-import { DEVICES, DEVICE_REGISTRY } from './devices.generated.js';
+import { DEVICES, REGISTRY } from './devices.generated.js';
+
+// Re-exported under the historical name so external consumers keep
+// importing `DEVICE_REGISTRY` while the generated module exports the
+// labelwriter-aligned `REGISTRY` symbol.
+export const DEVICE_REGISTRY = REGISTRY;
 
 // Mass-storage PIDs aligned to Linux usb-ids (gowdy.us / linux-usb.org).
 // Each large-format printer with Editor Lite enumerates as USB Mass
@@ -13,7 +18,7 @@ const MASS_STORAGE_PIDS = new Set<number>(
   }),
 );
 
-export { DEVICE_REGISTRY, DEVICES };
+export { DEVICES };
 
 /**
  * Numeric VID/PID extracted from a device's USB transport.

package/src/index.ts

@@ -54,6 +54,8 @@ export {
 } from './media.js';
 export { ROTATE_DIRECTION } from './orientation.js';
 export {
+  buildInitialize,
+  buildInvalidate,
   encodeJob,
   encodeJobForEngine,
   PT_PROTOCOL_CONFIG,