@thermal-label/brother-ql-core 0.2.1 → 0.4.0

package/src/protocol.ts

@@ -1,8 +1,18 @@
 import { getRow, createBitmap } from '@mbtech-nl/bitmap';
-import { type BrotherQLMedia, type PageData, type JobOptions, type PageOptions } from './types.js';
+import type { PrintEngine } from '@thermal-label/contracts';
+import { packBits } from './pack-bits.js';
+import { resolveTapeGeometry } from './media.js';
+import type {
+  BrotherEngineCapabilities,
+  BrotherQLMedia,
+  PageData,
+  JobOptions,
+  PageOptions,
+  TapeGeometry,
+} from './types.js';
 
-export function buildInvalidate(): Uint8Array {
-  return new Uint8Array(200);
+export function buildInvalidate(byteCount = 200): Uint8Array {
+  return new Uint8Array(byteCount);
 }
 
 export function buildStatusRequest(): Uint8Array {
@@ -57,11 +67,12 @@ export function buildExpandedMode(
   cutAtEnd: boolean,
   highRes: boolean,
   twoColor = false,
+  highResFlagBit = 0x10,
 ): Uint8Array {
   let flags = 0x00;
   if (twoColor) flags |= 0x01;
   if (cutAtEnd) flags |= 0x08;
-  if (highRes) flags |= 0x10;
+  if (highRes) flags |= highResFlagBit;
   return new Uint8Array([0x1b, 0x69, 0x4b, flags]);
 }
 
@@ -134,14 +145,133 @@ function concat(...arrays: Uint8Array[]): Uint8Array {
   return out;
 }
 
-export function encodeJob(pages: PageData[], options: JobOptions = {}): Uint8Array {
+/**
+ * Per-protocol wire-format constants.
+ *
+ * QL and PT raster differ in three numeric constants and one rule —
+ * everything else (status request, raster opcode, PackBits, two-colour
+ * plane encoding) is shared and lives in `encodeRasterJob`. Per the
+ * plan §4.2 / §7, these are protocol-internal and do not leak onto
+ * the device registry.
+ *
+ * - `feedMarginDots` — leading/trailing blank tape (`ESC i d`). QL = 35,
+ *   PT = 14. Per `brother_label/devices.py` and Brother's PT raster
+ *   manual; verify against print output during phase 4.
+ * - `invalidateBytes` — leading invalidate sequence. QL is 200 by
+ *   default but the encoder bumps it to 400 when the engine carries
+ *   `capabilities.twoColor`. PT is always 200 (no two-colour PT model
+ *   exists today).
+ * - `highResFlagBit` — bit set in `ESC i K` flags when `highRes`
+ *   is requested. QL uses bit 4 (0x10) for 300x600; PT uses bit 6
+ *   (0x40) for 180x360 / 360x720 (per nbuchwitz/ptouch).
+ * - `duplicateRasterLines` — when `highRes` is on, PT requires each
+ *   raster line to be sent twice. QL's high-res mode does not.
+ */
+export interface RasterProtocolConfig {
+  feedMarginDots: number;
+  invalidateBytes: number;
+  highResFlagBit: number;
+  duplicateRasterLines: boolean;
+}
+
+export const QL_PROTOCOL_CONFIG: RasterProtocolConfig = {
+  feedMarginDots: 35,
+  invalidateBytes: 200,
+  highResFlagBit: 0x10,
+  duplicateRasterLines: false,
+};
+
+export const PT_PROTOCOL_CONFIG: RasterProtocolConfig = {
+  feedMarginDots: 14,
+  invalidateBytes: 200,
+  highResFlagBit: 0x40,
+  duplicateRasterLines: true,
+};
+
+/** Engine shape consumed by the encoder — narrow `Pick` so unit tests can synthesise minimal stubs. */
+export type EncoderEngine = Pick<PrintEngine, 'protocol' | 'headDots'> & {
+  capabilities?: BrotherEngineCapabilities;
+};
+
+/**
+ * Cutter compression-required quirk.
+ *
+ * PT-E550W silently fails to cut when compression is disabled —
+ * documented in nbuchwitz/ptouch:PTE550W ("E550W requires compression
+ * ON for cutting to work"). Encoded as a per-name guard rather than a
+ * registry capability so we don't promote a one-model bug into the
+ * data shape.
+ */
+const COMPRESSION_REQUIRED_FOR_CUTTER = new Set(['PT-E550W']);
+
+function maybeCheckCutterCompressionQuirk(
+  deviceName: string | undefined,
+  autoCut: boolean,
+  compress: boolean,
+): void {
+  if (autoCut && !compress && deviceName && COMPRESSION_REQUIRED_FOR_CUTTER.has(deviceName)) {
+    throw new Error(
+      `${deviceName} requires compression to be enabled when autocut is on (per nbuchwitz/ptouch)`,
+    );
+  }
+}
+
+/**
+ * Resolve per-page geometry for the encoder.
+ *
+ * QL paths take the flat fields off the media row directly; PT paths
+ * delegate to `resolveTapeGeometry` so the head-family dispatch lives
+ * in one place. `engine` is required for PT and ignored for QL.
+ */
+function resolveEncoderGeometry(
+  media: BrotherQLMedia,
+  engine: EncoderEngine | undefined,
+): TapeGeometry {
+  if (media.tapeSystem === 'dk') {
+    if (
+      typeof media.printAreaDots !== 'number' ||
+      typeof media.leftMarginPins !== 'number' ||
+      typeof media.rightMarginPins !== 'number'
+    ) {
+      throw new Error(`DK media ${media.id.toString()} missing flat geometry fields`);
+    }
+    return {
+      printAreaDots: media.printAreaDots,
+      leftMarginPins: media.leftMarginPins,
+      rightMarginPins: media.rightMarginPins,
+    };
+  }
+  if (!engine) {
+    throw new Error(
+      `tape system "${media.tapeSystem}" requires an engine to resolve head-family geometry`,
+    );
+  }
+  return resolveTapeGeometry(media, engine);
+}
+
+interface EncodeContext {
+  config: RasterProtocolConfig;
+  engine?: EncoderEngine | undefined;
+  deviceName?: string | undefined;
+}
+
+function encodeRasterJob(pages: PageData[], options: JobOptions, ctx: EncodeContext): Uint8Array {
+  const { config, engine, deviceName } = ctx;
   const copies = options.copies ?? 1;
   const chunks: Uint8Array[] = [];
 
-  // Python brother_ql sequence: raster-mode first, then 200-byte invalidate, then init, then
+  // Two-colour invalidate-byte derivation (§7.1): QL bumps to 400 when
+  // the engine carries `twoColor`. PT has no two-colour models today;
+  // its config keeps invalidateBytes at 200 regardless.
+  const baseInvalidate = config.invalidateBytes;
+  const twoColorInvalidateBoost =
+    engine?.protocol === 'ql-raster' && engine.capabilities?.twoColor === true;
+  const invalidateBytes = twoColorInvalidateBoost ? baseInvalidate * 2 : baseInvalidate;
+
+  // Python brother_ql sequence: raster-mode first, then invalidate, then init, then
   // raster-mode again (matches observed working sequence for QL-820NWB).
   chunks.push(buildRasterMode());
-  chunks.push(buildInvalidate());
+  chunks.push(buildInvalidate(invalidateBytes));
   chunks.push(buildInitialize());
 
   const allPageInstances: PageData[] = [];
@@ -157,16 +287,29 @@ export function encodeJob(pages: PageData[], options: JobOptions = {}): Uint8Arr
     const autoCut = opts.autoCut ?? true;
     const cutAtEnd = opts.cutAtEnd ?? true;
     const highRes = opts.highResolution ?? false;
-    const marginDots = opts.marginDots ?? 35;
     const compress = opts.compress ?? false;
     const { bitmap, media } = page;
 
-    // colorCapable media (e.g. DK-22251) requires two-color mode even for black-only jobs.
+    // High-res mode requires the engine to declare `capabilities.highResDpi`.
+    if (highRes && engine && engine.capabilities?.highResDpi === undefined) {
+      throw new Error(
+        `${deviceName ?? 'device'} does not support high-res mode (engine.capabilities.highResDpi is not set)`,
+      );
+    }
+
+    maybeCheckCutterCompressionQuirk(deviceName, autoCut, compress);
+
+    // Per §7.3: PT high-res doubles the feed margin and duplicates
+    // each raster line. QL high-res leaves both untouched.
+    const baseMargin = opts.marginDots ?? config.feedMarginDots;
+    const marginDots = config.duplicateRasterLines && highRes ? baseMargin * 2 : baseMargin;
+
+    // Multi-ink media (e.g. DK-22251) requires two-color mode even for black-only jobs.
     // Auto-create an empty red plane when the tape demands it but caller didn't supply one.
-    const twoColor = page.redBitmap !== undefined || media.colorCapable;
+    const multiInk = media.palette !== undefined;
+    const twoColor = page.redBitmap !== undefined || multiInk;
     const redBitmap =
-      page.redBitmap ??
-      (media.colorCapable ? createBitmap(bitmap.widthPx, bitmap.heightPx) : undefined);
+      page.redBitmap ?? (multiInk ? createBitmap(bitmap.widthPx, bitmap.heightPx) : undefined);
 
     if (twoColor && redBitmap !== undefined) {
       if (bitmap.widthPx !== redBitmap.widthPx || bitmap.heightPx !== redBitmap.heightPx) {
@@ -181,28 +324,41 @@ export function encodeJob(pages: PageData[], options: JobOptions = {}): Uint8Arr
     chunks.push(buildPrintInfo(media, rowCount, i));
     chunks.push(buildVariousMode(autoCut));
     chunks.push(buildCutEach(1));
-    chunks.push(buildExpandedMode(cutAtEnd, highRes, twoColor));
+    chunks.push(buildExpandedMode(cutAtEnd, highRes, twoColor, config.highResFlagBit));
     chunks.push(buildMargin(marginDots));
     if (compress) chunks.push(buildCompression(true));
 
     // Each raster row must cover the full print head width (derived from media geometry).
-    // leftMarginPins + printAreaDots + rightMarginPins = head pin count (720 or 1296).
-    const totalPins = media.leftMarginPins + media.printAreaDots + media.rightMarginPins;
+    // leftMarginPins + printAreaDots + rightMarginPins = head pin count (720 / 1296 / 128 / 560).
+    const geometry = resolveEncoderGeometry(media, engine);
+    const leftMarginPins = geometry.leftMarginPins;
+    const totalPins = leftMarginPins + geometry.printAreaDots + geometry.rightMarginPins;
     const rowByteLen = Math.ceil(totalPins / 8);
 
     // Rows interleaved per raster line (matches Python brother_ql behaviour).
     // Two-color: black row then red row for each line. Single-color: black only.
+    // When `compress` is on, each row's bytes are PackBits-encoded and the
+    // raster-row LEN byte carries the compressed length.
+    //
+    // Per §7.3: PT high-res duplicates each raster line. QL doesn't.
+    const duplicate = config.duplicateRasterLines && highRes;
     for (let r = 0; r < rowCount; r++) {
       const blackSrc = getRow(bitmap, r);
       const blackBytes = new Uint8Array(rowByteLen);
-      placeBits(blackSrc, bitmap.widthPx, blackBytes, media.leftMarginPins);
-      chunks.push(buildRasterRow(blackBytes, 'black', twoColor));
+      placeBits(blackSrc, bitmap.widthPx, blackBytes, leftMarginPins);
+      const blackPayload = compress ? packBits(blackBytes) : blackBytes;
+      const blackChunk = buildRasterRow(blackPayload, 'black', twoColor);
+      chunks.push(blackChunk);
+      if (duplicate) chunks.push(blackChunk);
 
       if (twoColor && redBitmap !== undefined) {
         const redSrc = getRow(redBitmap, r);
         const redBytes = new Uint8Array(rowByteLen);
-        placeBits(redSrc, redBitmap.widthPx, redBytes, media.leftMarginPins);
-        chunks.push(buildRasterRow(redBytes, 'red', twoColor));
+        placeBits(redSrc, redBitmap.widthPx, redBytes, leftMarginPins);
+        const redPayload = compress ? packBits(redBytes) : redBytes;
+        const redChunk = buildRasterRow(redPayload, 'red', twoColor);
+        chunks.push(redChunk);
+        if (duplicate) chunks.push(redChunk);
       }
     }
 
@@ -211,3 +367,32 @@ export function encodeJob(pages: PageData[], options: JobOptions = {}): Uint8Arr
 
   return concat(...chunks);
 }
+
+/**
+ * Encode a QL job. Public legacy entry point — DK media only, no
+ * engine awareness, two-colour invalidate-byte boost not applied.
+ * Use `encodeJobForEngine` for PT or for QL with two-colour invalidate
+ * derivation from `engine.capabilities.twoColor`.
+ */
+export function encodeJob(pages: PageData[], options: JobOptions = {}): Uint8Array {
+  return encodeRasterJob(pages, options, { config: QL_PROTOCOL_CONFIG });
+}
+
+/**
+ * Encode a job for a specific engine. Dispatches on `engine.protocol`:
+ * `'ql-raster'` picks the QL config, `'pt-raster'` picks the PT config
+ * and threads `engine.headDots` through to head-family geometry
+ * resolution for TZe / HSe media.
+ *
+ * `deviceName` is optional; when supplied, it enables the per-name
+ * cutter-compression guard for PT-E550W (§7.2 / §12.12).
+ */
+export function encodeJobForEngine(
+  pages: PageData[],
+  options: JobOptions,
+  engine: EncoderEngine,
+  deviceName?: string,
+): Uint8Array {
+  const config = engine.protocol === 'pt-raster' ? PT_PROTOCOL_CONFIG : QL_PROTOCOL_CONFIG;
+  return encodeRasterJob(pages, options, { config, engine, deviceName });
+}

package/src/status.ts

@@ -1,6 +1,5 @@
-/* eslint-disable import-x/consistent-type-specifier-style */
-import type { PrinterError } from '@thermal-label/contracts';
-import { type BrotherQLStatus } from './types.js';
+import type { PrintEngine, PrinterError } from '@thermal-label/contracts';
+import type { BrotherQLStatus } from './types.js';
 import { findMediaByDimensions } from './media.js';
 
 export const STATUS_REQUEST = new Uint8Array([0x1b, 0x69, 0x53]);
@@ -38,6 +37,8 @@ const ERROR_INFO_2: { bit: number; code: string; message: string }[] = [
  *   byte 11 — media type (0x0A continuous, 0x0B die-cut)
  *   byte 17 — media length (mm), 0 for continuous
  *   byte 18 — status type (0x02 = error response)
+ *   byte 25 — bit 7 set when the loaded roll is two-color (DK-22251);
+ *             clear on single-color rolls. See scripts/STATUS-CAPTURE.md.
  *
  * `detectedMedia` is resolved against the media registry via
  * `findMediaByDimensions`. `editorLiteMode` is a driver-specific
@@ -46,7 +47,10 @@ const ERROR_INFO_2: { bit: number; code: string; message: string }[] = [
  * set it from other signals (e.g. mass-storage PID detected during
  * discovery) without changing the return type.
  */
-export function parseStatus(bytes: Uint8Array): BrotherQLStatus {
+export function parseStatus(
+  bytes: Uint8Array,
+  engine?: Pick<PrintEngine, 'headDots' | 'mediaCompatibility'>,
+): BrotherQLStatus {
   if (bytes.length < 32) {
     throw new Error(`Status response too short: ${bytes.length.toString()} bytes`);
   }
@@ -58,6 +62,7 @@ export function parseStatus(bytes: Uint8Array): BrotherQLStatus {
   const mediaTypeByte = view.getUint8(11);
   const mediaLengthMm = view.getUint8(17);
   const statusType = view.getUint8(18);
+  const twoColorFlag = (view.getUint8(25) & 0x80) !== 0;
 
   const errors: PrinterError[] = [];
   for (const { bit, code, message } of ERROR_INFO_1) {
@@ -69,13 +74,14 @@ export function parseStatus(bytes: Uint8Array): BrotherQLStatus {
 
   const mediaLoaded = mediaWidthMm > 0 && mediaTypeByte !== 0;
   const detected = mediaLoaded
-    ? findMediaByDimensions(mediaWidthMm, mediaLengthMm, false)
+    ? findMediaByDimensions(mediaWidthMm, mediaLengthMm, twoColorFlag, engine)
     : undefined;
 
   return {
     ready: errors.length === 0 && statusType !== 0x02,
     mediaLoaded,
     ...(detected === undefined ? {} : { detectedMedia: detected }),
+    ...(mediaLoaded ? { twoColorRoll: twoColorFlag } : {}),
     errors,
     editorLiteMode: false,
     rawBytes: bytes,

package/src/types.ts

@@ -1,54 +1,112 @@
-/* eslint-disable import-x/consistent-type-specifier-style */
-import { type LabelBitmap } from '@mbtech-nl/bitmap';
-import type { DeviceDescriptor, MediaDescriptor, PrinterStatus } from '@thermal-label/contracts';
+import type { LabelBitmap } from '@mbtech-nl/bitmap';
+import type {
+  DeviceEntry,
+  MediaDescriptor,
+  PrintEngineCapabilities,
+  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';
 
 /**
- * Brother QL device descriptor.
+ * Tape-system discriminator on `BrotherQLMedia`. DK is the QL series'
+ * paper-label system; TZe is the laminated-tape system used by the
+ * PT-P / PT-E line; HSe 2:1 and HSe 3:1 are heat-shrink tubing systems
+ * supported by most P900-series and PT-E550W. Lookup paths gate on
+ * this so a QL printer never resolves a TZe entry, and vice versa.
+ */
+export type TapeSystem = 'dk' | 'tze' | 'hse-2to1' | 'hse-3to1';
+
+/**
+ * Per-head-family geometry on `BrotherQLMedia`.
  *
- * Extends the contracts base with QL-specific fields: head geometry,
- * protocol feature flags, and the optional mass-storage PID for Editor
- * Lite mode.
+ * Brother's PT-P / PT-E line ships two head families with different
+ * per-tape pin layouts. The same TZe id maps to different
+ * `printAreaDots` / `leftMarginPins` / `rightMarginPins` values on a
+ * 128-pin head (PT-E550W, PT-P750W) versus a 560-pin head (PT-P900,
+ * P900W, P950NW, P910BT). DK media leaves these unset and resolves via
+ * the flat fields on `BrotherQLMedia` directly.
+ */
+export interface TapeGeometry {
+  printAreaDots: number;
+  leftMarginPins: number;
+  rightMarginPins: number;
+}
+
+/**
+ * Brother-specific engine capabilities.
  *
- * **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.
+ * Extends the contracts-defined `PrintEngineCapabilities` (which
+ * carries the multi-vendor named flags `autocut` and `mediaDetection`)
+ * with the driver-side `twoColor` flag — Brother-only today, so it
+ * lands here via the contracts open index signature. Promote to a
+ * named contracts key when a second vendor implements the same
+ * capability with compatible semantics.
  */
-export interface BrotherQLDevice extends DeviceDescriptor {
-  family: 'brother-ql';
-  vid: number;
-  pid: number;
-  headPins: HeadWidth;
-  bytesPerRow: number;
-  twoColor: boolean;
-  network: NetworkSupport;
-  autocut: boolean;
-  compression: boolean;
-  editorLite: boolean;
-  /** Alternate PID seen when the printer is in Editor Lite mass-storage mode. */
-  massStoragePid?: number;
+export interface BrotherEngineCapabilities extends PrintEngineCapabilities {
+  /** Two-colour ribbon path — black + red plane raster encoding. */
+  twoColor?: boolean;
+  /**
+   * Doubled-density mode along the feed axis (`ESC i K` bit 6).
+   * `360` on PT-E550W / PT-P750W (native 180); `720` on the PT-P900
+   * family (native 360). Undefined on QL and PT models that don't
+   * support high-res. The encoder branches on this when
+   * `BrotherQLPrintOptions.highRes` is set.
+   */
+  highResDpi?: 360 | 720;
 }
 
+/**
+ * Brother QL device entry — alias for the contracts `DeviceEntry`
+ * shape. Re-exported under a driver-named type so consumers don't
+ * have to import contracts directly. Per-device chassis-level
+ * capabilities (`editorLite`, `massStoragePid`) ride on the open
+ * index signature of `DeviceEntry.capabilities`; engine-level flags
+ * (`autocut`, `mediaDetection`, `twoColor`) ride on
+ * `engines[].capabilities`.
+ *
+ * **Bluetooth on the QL-820NWB / 820NWBc**: not exposed over GATT.
+ * Classic Bluetooth SPP is paired at the OS level — declared as the
+ * `bluetooth-spp` transport. The runtime's serial implementation
+ * satisfies that transport key by opening the OS-paired RFCOMM
+ * device path. macOS dropped classic Bluetooth SPP — no SPP route
+ * there.
+ */
+export type BrotherQLDevice = DeviceEntry;
+
 /**
  * Brother QL media descriptor.
  *
  * Extends `MediaDescriptor` with the dots-based geometry the raster
- * encoder needs. `colorCapable: true` flips the driver into
- * two-colour mode — only DK-22251 has this set in the registry.
+ * 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;
   type: MediaType;
-  colorCapable: boolean;
-  printAreaDots: number;
-  leftMarginPins: number;
-  rightMarginPins: number;
+  /**
+   * Tape system this entry belongs to. Drives lookup gating in
+   * `findMediaByDimensions(width, height, engine)` so QL engines never
+   * resolve TZe / HSe entries and vice versa.
+   */
+  tapeSystem: TapeSystem;
+  /**
+   * Per-head-family geometry. `narrow` = 128-pin head (PT-E550W,
+   * PT-P750W); `wide` = 560-pin head (PT-P900 family). DK entries
+   * leave both unset and use the flat fields below; TZe / HSe entries
+   * leave the flat fields undefined and populate `narrow` and/or
+   * `wide` per the *Raster Command Reference* PDFs. `undefined` on a
+   * head family means "this tape doesn't fit this head" (e.g. 36 mm
+   * TZe and 31 mm HSe-3:1 have no `narrow` entry).
+   */
+  geometry?: { narrow?: TapeGeometry; wide?: TapeGeometry };
+  /** DK-only flat geometry. PT-* entries populate `geometry` instead. */
+  printAreaDots?: number;
+  leftMarginPins?: number;
+  rightMarginPins?: number;
   /** Die-cut masked area in dots (registration windows). */
   dieCutMaskedAreaDots?: number;
 }
@@ -60,6 +118,11 @@ export interface BrotherQLMedia extends MediaDescriptor {
  */
 export interface BrotherQLStatus extends PrinterStatus {
   editorLiteMode: boolean;
+  /**
+   * True when the loaded roll reports two-color capability via byte 25
+   * bit 7 of the status response. Undefined when no media is loaded.
+   */
+  twoColorRoll?: boolean;
 }
 
 export interface PageData {
@@ -80,3 +143,21 @@ export interface PageOptions {
 export interface JobOptions {
   copies?: number;
 }
+
+/**
+ * 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;
+  /**
+   * Opt into high-resolution mode (doubles dpi along the feed axis).
+   * Requires the engine's `capabilities.highResDpi` to be set; throws
+   * at job-build time otherwise. PT-* only — QL ignores the option.
+   */
+  highRes?: boolean;
+}

package/dist/__tests__/colour.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=colour.test.d.ts.map

package/dist/__tests__/colour.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"colour.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/colour.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/colour.test.js

@@ -1,106 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { getPixel } from '@mbtech-nl/bitmap';
-import { isRedish, splitTwoColor } from '../colour.js';
-function rgbaOf(width, height, [r, g, b, a]) {
-    const data = new Uint8Array(width * height * 4);
-    for (let i = 0; i < data.length; i += 4) {
-        data[i] = r;
-        data[i + 1] = g;
-        data[i + 2] = b;
-        data[i + 3] = a;
-    }
-    return { width, height, data };
-}
-function countInkPixels(bitmap) {
-    let n = 0;
-    for (let y = 0; y < bitmap.heightPx; y++) {
-        for (let x = 0; x < bitmap.widthPx; x++) {
-            if (getPixel(bitmap, x, y))
-                n++;
-        }
-    }
-    return n;
-}
-describe('isRedish', () => {
-    it('treats a strong red as red', () => {
-        expect(isRedish(255, 0, 0, 255)).toBe(true);
-    });
-    it('rejects red when green is too high (threshold g < 100)', () => {
-        expect(isRedish(255, 100, 0, 255)).toBe(false);
-        expect(isRedish(255, 99, 0, 255)).toBe(true);
-    });
-    it('rejects red when blue is too high (threshold b < 100)', () => {
-        expect(isRedish(255, 0, 100, 255)).toBe(false);
-        expect(isRedish(255, 0, 99, 255)).toBe(true);
-    });
-    it('rejects red when the red channel is too low (threshold r > 180)', () => {
-        expect(isRedish(180, 0, 0, 255)).toBe(false);
-        expect(isRedish(181, 0, 0, 255)).toBe(true);
-    });
-    it('rejects transparent pixels (alpha < 128)', () => {
-        expect(isRedish(255, 0, 0, 127)).toBe(false);
-        expect(isRedish(255, 0, 0, 128)).toBe(true);
-    });
-    it('rejects black (no red dominance)', () => {
-        expect(isRedish(0, 0, 0, 255)).toBe(false);
-    });
-    it('rejects white', () => {
-        expect(isRedish(255, 255, 255, 255)).toBe(false);
-    });
-});
-describe('splitTwoColor', () => {
-    it('routes a solid red image to the red plane, nothing to black', () => {
-        const { black, red } = splitTwoColor(rgbaOf(8, 8, [255, 0, 0, 255]));
-        expect(countInkPixels(red)).toBeGreaterThan(0);
-        expect(countInkPixels(black)).toBe(0);
-    });
-    it('routes a solid black image to the black plane, nothing to red', () => {
-        const { black, red } = splitTwoColor(rgbaOf(8, 8, [0, 0, 0, 255]));
-        expect(countInkPixels(black)).toBeGreaterThan(0);
-        expect(countInkPixels(red)).toBe(0);
-    });
-    it('produces bitmaps matching the source dimensions', () => {
-        const { black, red } = splitTwoColor(rgbaOf(16, 12, [128, 128, 128, 255]));
-        expect(black.widthPx).toBe(16);
-        expect(black.heightPx).toBe(12);
-        expect(red.widthPx).toBe(16);
-        expect(red.heightPx).toBe(12);
-    });
-    it('resolves overlapping bits in favour of black (red bit cleared)', () => {
-        // Construct a mixed image: one row red, one row black.
-        const data = new Uint8Array(8 * 2 * 4);
-        // Row 0: red
-        for (let i = 0; i < 8; i++) {
-            data[i * 4] = 255;
-            data[i * 4 + 3] = 255;
-        }
-        // Row 1: black
-        for (let i = 0; i < 8; i++) {
-            const offset = (8 + i) * 4;
-            data[offset] = 0;
-            data[offset + 1] = 0;
-            data[offset + 2] = 0;
-            data[offset + 3] = 255;
-        }
-        const image = { width: 8, height: 2, data };
-        const { black, red } = splitTwoColor(image);
-        // Every non-transparent pixel should land on exactly one plane —
-        // resolveOverlap guarantees no bit is set in both.
-        for (let y = 0; y < 2; y++) {
-            for (let x = 0; x < 8; x++) {
-                const inBlack = getPixel(black, x, y);
-                const inRed = getPixel(red, x, y);
-                expect(inBlack && inRed).toBe(false);
-            }
-        }
-    });
-    it('accepts custom threshold + dither options', () => {
-        const { black, red } = splitTwoColor(rgbaOf(4, 4, [0, 0, 0, 255]), {
-            threshold: 64,
-            dither: false,
-        });
-        expect(black.widthPx).toBe(4);
-        expect(red.widthPx).toBe(4);
-    });
-});
-//# sourceMappingURL=colour.test.js.map

package/dist/__tests__/colour.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"colour.test.js","sourceRoot":"","sources":["../../src/__tests__/colour.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAEvD,SAAS,MAAM,CACb,KAAa,EACb,MAAc,EACd,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAmC;IAM9C,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC;IAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AACjC,CAAC;AAED,SAAS,cAAc,CAAC,MAA+D;IACrF,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;QACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;gBAAE,CAAC,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;QACvB,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QACrE,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7B,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,uDAAuD;QACvD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,aAAa;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;QACxB,CAAC;QACD,eAAe;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;QACzB,CAAC;QACD,MAAM,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;QAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5C,iEAAiE;QACjE,mDAAmD;QACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3B,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClC,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE;YACjE,SAAS,EAAE,EAAE;YACb,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}