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

package/dist/colour.d.ts

@@ -1,26 +0,0 @@
-import { type LabelBitmap, type RawImageData } from '@mbtech-nl/bitmap';
-export interface TwoColorResult {
-    black: LabelBitmap;
-    red: LabelBitmap;
-}
-export interface TwoColorOptions {
-    threshold?: number;
-    dither?: boolean;
-}
-/**
- * A pixel is "red-ish" when the red channel clearly dominates and
- * alpha is opaque enough to matter. The thresholds come from testing
- * against DK-22251 output — wider tolerances let non-red warm tones
- * bleed into the red plane.
- */
-export declare function isRedish(r: number, g: number, b: number, a: number): boolean;
-/**
- * Split an RGBA image into black and red 1bpp planes for Brother QL
- * two-colour media (DK-22251).
- *
- * The rendering path matches `renderImage(image, { dither: true })`
- * used by `print()` for single-colour media, so overall print density
- * stays consistent regardless of media.
- */
-export declare function splitTwoColor(image: RawImageData, options?: TwoColorOptions): TwoColorResult;
-//# sourceMappingURL=colour.d.ts.map

package/dist/colour.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"colour.d.ts","sourceRoot":"","sources":["../src/colour.ts"],"names":[],"mappings":"AAQA,OAAO,EAAe,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAErF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,WAAW,CAAC;IACnB,GAAG,EAAE,WAAW,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAG5E;AAmDD;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,cAAc,CAY5F"}

package/dist/colour.js

@@ -1,84 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion --
- *   Uint8Array indexed reads are typed `number | undefined` under
- *   `noUncheckedIndexedAccess`, but every index in this file is bounded
- *   by `src.length` (a multiple of 4) or `Math.min(a.length, b.length)`.
- *   The `!` assertions collapse the unreachable `undefined` branches so
- *   branch coverage doesn't count them. See also `non-nullable-type-
- *   assertion-style` which rules out the alternative `as number` form.
- */
-import { renderImage } from '@mbtech-nl/bitmap';
-/**
- * A pixel is "red-ish" when the red channel clearly dominates and
- * alpha is opaque enough to matter. The thresholds come from testing
- * against DK-22251 output — wider tolerances let non-red warm tones
- * bleed into the red plane.
- */
-export function isRedish(r, g, b, a) {
-    if (a < 128)
-        return false;
-    return r > 180 && g < 100 && b < 100;
-}
-function extractRedPixels(image) {
-    const src = image.data;
-    const dst = new Uint8Array(src.length);
-    for (let i = 0; i < src.length; i += 4) {
-        const r = src[i];
-        const g = src[i + 1];
-        const b = src[i + 2];
-        const a = src[i + 3];
-        if (isRedish(r, g, b, a)) {
-            dst[i] = r;
-            dst[i + 1] = g;
-            dst[i + 2] = b;
-            dst[i + 3] = a;
-        }
-    }
-    return { data: dst, width: image.width, height: image.height };
-}
-function extractNonRedPixels(image) {
-    const src = image.data;
-    const dst = new Uint8Array(src.length);
-    for (let i = 0; i < src.length; i += 4) {
-        const r = src[i];
-        const g = src[i + 1];
-        const b = src[i + 2];
-        const a = src[i + 3];
-        if (!isRedish(r, g, b, a)) {
-            dst[i] = r;
-            dst[i + 1] = g;
-            dst[i + 2] = b;
-            dst[i + 3] = a;
-        }
-    }
-    return { data: dst, width: image.width, height: image.height };
-}
-/**
- * Where both planes have a set bit at the same position, black wins.
- * Done by masking the red bits with the inverse of the black bits.
- */
-function resolveOverlap(black, red) {
-    const blackData = black.data;
-    const redData = red.data;
-    const len = Math.min(blackData.length, redData.length);
-    for (let i = 0; i < len; i++) {
-        redData[i] = redData[i] & ~blackData[i];
-    }
-}
-/**
- * Split an RGBA image into black and red 1bpp planes for Brother QL
- * two-colour media (DK-22251).
- *
- * The rendering path matches `renderImage(image, { dither: true })`
- * used by `print()` for single-colour media, so overall print density
- * stays consistent regardless of media.
- */
-export function splitTwoColor(image, options) {
-    const { threshold = 128, dither = true } = options ?? {};
-    const blackImage = extractNonRedPixels(image);
-    const redImage = extractRedPixels(image);
-    const black = renderImage(blackImage, { threshold, dither });
-    const red = renderImage(redImage, { threshold, dither });
-    resolveOverlap(black, red);
-    return { black, red };
-}
-//# sourceMappingURL=colour.js.map

package/dist/colour.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"colour.js","sourceRoot":"","sources":["../src/colour.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,WAAW,EAAuC,MAAM,mBAAmB,CAAC;AAYrF;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS,EAAE,CAAS;IACjE,IAAI,CAAC,GAAG,GAAG;QAAE,OAAO,KAAK,CAAC;IAC1B,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC;AACvC,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAmB;IAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;IACvB,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAE,CAAC;QAClB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;QACtB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;QACtB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;QACtB,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACzB,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACX,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACf,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACf,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;AACjE,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAmB;IAC9C,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;IACvB,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAE,CAAC;QAClB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;QACtB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;QACtB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;QACtB,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YAC1B,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACX,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACf,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACf,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;AACjE,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,KAAkB,EAAE,GAAgB;IAC1D,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;IAC7B,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAE,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAmB,EAAE,OAAyB;IAC1E,MAAM,EAAE,SAAS,GAAG,GAAG,EAAE,MAAM,GAAG,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAEzD,MAAM,UAAU,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAEzC,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,MAAM,GAAG,GAAG,WAAW,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IAEzD,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAE3B,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC"}

package/src/__tests__/colour.test.ts

@@ -1,126 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { getPixel } from '@mbtech-nl/bitmap';
-import { isRedish, splitTwoColor } from '../colour.js';
-
-function rgbaOf(
-  width: number,
-  height: number,
-  [r, g, b, a]: [number, number, number, number],
-): {
-  width: number;
-  height: number;
-  data: Uint8Array;
-} {
-  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: { widthPx: number; heightPx: number; data: Uint8Array }): number {
-  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);
-  });
-});

package/src/colour.ts

@@ -1,101 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion --
- *   Uint8Array indexed reads are typed `number | undefined` under
- *   `noUncheckedIndexedAccess`, but every index in this file is bounded
- *   by `src.length` (a multiple of 4) or `Math.min(a.length, b.length)`.
- *   The `!` assertions collapse the unreachable `undefined` branches so
- *   branch coverage doesn't count them. See also `non-nullable-type-
- *   assertion-style` which rules out the alternative `as number` form.
- */
-import { renderImage, type LabelBitmap, type RawImageData } from '@mbtech-nl/bitmap';
-
-export interface TwoColorResult {
-  black: LabelBitmap;
-  red: LabelBitmap;
-}
-
-export interface TwoColorOptions {
-  threshold?: number;
-  dither?: boolean;
-}
-
-/**
- * A pixel is "red-ish" when the red channel clearly dominates and
- * alpha is opaque enough to matter. The thresholds come from testing
- * against DK-22251 output — wider tolerances let non-red warm tones
- * bleed into the red plane.
- */
-export function isRedish(r: number, g: number, b: number, a: number): boolean {
-  if (a < 128) return false;
-  return r > 180 && g < 100 && b < 100;
-}
-
-function extractRedPixels(image: RawImageData): RawImageData {
-  const src = image.data;
-  const dst = new Uint8Array(src.length);
-  for (let i = 0; i < src.length; i += 4) {
-    const r = src[i]!;
-    const g = src[i + 1]!;
-    const b = src[i + 2]!;
-    const a = src[i + 3]!;
-    if (isRedish(r, g, b, a)) {
-      dst[i] = r;
-      dst[i + 1] = g;
-      dst[i + 2] = b;
-      dst[i + 3] = a;
-    }
-  }
-  return { data: dst, width: image.width, height: image.height };
-}
-
-function extractNonRedPixels(image: RawImageData): RawImageData {
-  const src = image.data;
-  const dst = new Uint8Array(src.length);
-  for (let i = 0; i < src.length; i += 4) {
-    const r = src[i]!;
-    const g = src[i + 1]!;
-    const b = src[i + 2]!;
-    const a = src[i + 3]!;
-    if (!isRedish(r, g, b, a)) {
-      dst[i] = r;
-      dst[i + 1] = g;
-      dst[i + 2] = b;
-      dst[i + 3] = a;
-    }
-  }
-  return { data: dst, width: image.width, height: image.height };
-}
-
-/**
- * Where both planes have a set bit at the same position, black wins.
- * Done by masking the red bits with the inverse of the black bits.
- */
-function resolveOverlap(black: LabelBitmap, red: LabelBitmap): void {
-  const blackData = black.data;
-  const redData = red.data;
-  const len = Math.min(blackData.length, redData.length);
-  for (let i = 0; i < len; i++) {
-    redData[i] = redData[i]! & ~blackData[i]!;
-  }
-}
-
-/**
- * Split an RGBA image into black and red 1bpp planes for Brother QL
- * two-colour media (DK-22251).
- *
- * The rendering path matches `renderImage(image, { dither: true })`
- * used by `print()` for single-colour media, so overall print density
- * stays consistent regardless of media.
- */
-export function splitTwoColor(image: RawImageData, options?: TwoColorOptions): TwoColorResult {
-  const { threshold = 128, dither = true } = options ?? {};
-
-  const blackImage = extractNonRedPixels(image);
-  const redImage = extractRedPixels(image);
-
-  const black = renderImage(blackImage, { threshold, dither });
-  const red = renderImage(redImage, { threshold, dither });
-
-  resolveOverlap(black, red);
-
-  return { black, red };
-}