Merge pull request #103 from u8array/fix/maxicode-defaultsize-and-approx-severity

fix(maxicode): dpmm-aware defaultSize + correct approx severity

Author: u8array

src/components/Canvas/bwipConstants.ts

@@ -78,7 +78,6 @@ export const BWIP_APPROX_SEVERITY: ReadonlyMap<string, BwipApproxSeverity> = new
   ["gs1databar", "approx"],
   ["code49", "unverified"],
   ["codablock", "unverified"],
-  ["maxicode", "unverified"],
 ]);
 
 // Per-symbology spec module heights for GS1 DataBar. bwip-js renders most

src/components/Palette/ObjectPalette.tsx

@@ -1,10 +1,11 @@
 import { useDraggable } from '@dnd-kit/core';
 import { ObjectRegistry } from '../../registry';
 import { PALETTE_GROUPS } from './paletteGroups';
-import type { ObjectGroup } from '../../types/ObjectType';
 import { useT } from '../../lib/useT';
 import { useLabelStore } from '../../store/labelStore';
 import { mmToDots } from '../../lib/coordinates';
+import type { ObjectGroup, ObjectTypeDefinition } from '../../types/ObjectType';
+import { resolveDefaultSizeDots } from './resolveDefaultSize';
 import { DragHandleIcon } from '../ui/DragHandleIcon';
 import { CollapsibleSection } from '../ui/CollapsibleSection';
 import type { PaletteDragData } from '../../dnd/types';
@@ -16,7 +17,7 @@ interface PaletteEntryProps {
   type: string;
   icon: string;
   label: string;
-  defaultSize: { width: number; height: number };
+  defaultSize: ObjectTypeDefinition["defaultSize"];
   propsOverride?: object;
 }
 
@@ -29,11 +30,12 @@ function PaletteEntry({ id, type, icon, label, defaultSize, propsOverride }: Pal
 
   const handleDoubleClick = () => {
     const { label: labelConfig } = useLabelStore.getState();
+    const size = resolveDefaultSizeDots(defaultSize, labelConfig);
     addObject(
       type,
       {
-        x: Math.round(mmToDots(labelConfig.widthMm, labelConfig.dpmm) / 2 - defaultSize.width / 2),
-        y: Math.round(mmToDots(labelConfig.heightMm, labelConfig.dpmm) / 2 - defaultSize.height / 2),
+        x: Math.round(mmToDots(labelConfig.widthMm, labelConfig.dpmm) / 2 - size.width / 2),
+        y: Math.round(mmToDots(labelConfig.heightMm, labelConfig.dpmm) / 2 - size.height / 2),
       },
       propsOverride,
     );
@@ -67,7 +69,7 @@ interface ResolvedEntry {
   type: string;
   icon: string;
   label: string;
-  defaultSize: { width: number; height: number };
+  defaultSize: ObjectTypeDefinition["defaultSize"];
   propsOverride?: object;
 }
 

src/components/Palette/resolveDefaultSize.test.ts

@@ -0,0 +1,30 @@
+import { describe, it, expect } from "vitest";
+import { resolveDefaultSizeDots } from "./resolveDefaultSize";
+import type { LabelConfig } from "../../types/ObjectType";
+
+const labelAt = (dpmm: number): LabelConfig =>
+  ({ widthMm: 100, heightMm: 50, dpmm }) as LabelConfig;
+
+describe("resolveDefaultSizeDots", () => {
+  it("passes a dots-shape through unchanged regardless of dpmm", () => {
+    const dots = { width: 200, height: 40 };
+    expect(resolveDefaultSizeDots(dots, labelAt(8))).toEqual({ width: 200, height: 40 });
+    expect(resolveDefaultSizeDots(dots, labelAt(12))).toEqual({ width: 200, height: 40 });
+  });
+
+  it("converts mm-shape to dots at the label's dpmm", () => {
+    const mm = { widthMm: 28.14, heightMm: 26.91 };
+    // mmToDots rounds, so spell out the expected integer dot values.
+    expect(resolveDefaultSizeDots(mm, labelAt(8))).toEqual({ width: 225, height: 215 });
+    expect(resolveDefaultSizeDots(mm, labelAt(12))).toEqual({ width: 338, height: 323 });
+  });
+
+  it("keeps the physical footprint constant across dpmm (no drift)", () => {
+    const mm = { widthMm: 28.14, heightMm: 26.91 };
+    const at8 = resolveDefaultSizeDots(mm, labelAt(8));
+    const at12 = resolveDefaultSizeDots(mm, labelAt(12));
+    // dots / dpmm == mm: rounded-trip stays within 0.1 mm of the input
+    expect(at8.width / 8).toBeCloseTo(28.14, 1);
+    expect(at12.width / 12).toBeCloseTo(28.14, 1);
+  });
+});

src/components/Palette/resolveDefaultSize.ts

@@ -0,0 +1,25 @@
+import { mmToDots } from "../../lib/coordinates";
+import type { LabelConfig, ObjectTypeDefinition } from "../../types/ObjectType";
+
+/** Resolve a registry `defaultSize` declaration to dot units against
+ *  the active label config. Spec-fixed-physical-size symbols (e.g.
+ *  Maxicode) declare `widthMm`/`heightMm` so their footprint stays
+ *  correct across dpmm; all other types declare `width`/`height`
+ *  directly in dots. Lives next to the palette since that is the
+ *  only current drop site, but is its own module so the resolver
+ *  stays testable in isolation and any future drop path can reuse
+ *  it without depending on the palette component. */
+export function resolveDefaultSizeDots(
+  defaultSize: ObjectTypeDefinition["defaultSize"],
+  label: LabelConfig,
+): { width: number; height: number } {
+  if ("widthMm" in defaultSize) {
+    return {
+      width: mmToDots(defaultSize.widthMm, label.dpmm),
+      height: mmToDots(defaultSize.heightMm, label.dpmm),
+    };
+  }
+  // Shallow-copy the dots-branch so callers can't accidentally
+  // mutate the shared registry object via the returned reference.
+  return { ...defaultSize };
+}

src/registry/maxicode.tsx

@@ -6,11 +6,13 @@ import { fieldPos, fdFieldFor } from "./zplHelpers";
 import { type ZplRotation } from "./rotation";
 import { RotationSelect } from "../components/Properties/RotationSelect";
 
-/** Maxicode is a fixed-physical-size 2D symbology (1.11" × 1.054"
- *  at standard scale, ~28 × 26 mm). Unlike QR or DataMatrix it has
- *  no per-module magnification — the printer always renders a
- *  single fixed size. Therefore no `commitTransform` and no
- *  magnification prop; only the data, mode, and rotation vary. */
+/** Maxicode is a fixed-physical-size 2D symbology. Per ISO/IEC
+ *  16023 §4.11 the printed footprint is 28.14 × 26.91 mm at
+ *  standard module size (1.11 × 1.054 inch). Unlike QR or
+ *  DataMatrix it has no per-module magnification: the printer
+ *  always renders the same physical dimensions regardless of
+ *  dpmm. Therefore no `commitTransform` and no magnification
+ *  prop; only the data, mode, and rotation vary. */
 
 /** All modes the spec defines. Editor exposes every one and lets
  *  bwip-js validate the (content, mode) pair on encode:
@@ -27,9 +29,6 @@ import { RotationSelect } from "../components/Properties/RotationSelect";
  *  shown instead of an error. */
 const ALL_MODES = [2, 3, 4, 5, 6] as const;
 
-/** Default physical footprint of a Maxicode at 8 dpmm: spec is
- *  ~28 × 26.9 mm; converted to dots that's 224 × 216. */
-const MAXICODE_DEFAULT_FOOTPRINT = { width: 224, height: 216 } as const;
 
 /** Mode 4 = standard symbol with arbitrary payload, the only mode
  *  most users without UPS-domain knowledge can reach for without
@@ -52,10 +51,11 @@ export const maxicode: ObjectTypeDefinition<MaxicodeProps> = {
     mode: MAXICODE_DEFAULT_MODE,
     rotation: "N",
   },
-  // Fixed-size symbol — the printer always renders at standard
-  // Maxicode dimensions, so the resize transformer is disabled
-  // (heightLocked) and no commitTransform is needed.
-  defaultSize: MAXICODE_DEFAULT_FOOTPRINT,
+  // Spec-fixed physical footprint per ISO/IEC 16023. Declared in
+  // mm so the palette resolves to the active label's dpmm at drop
+  // time; `heightLocked` then disables both transformer axes since
+  // the symbology has no resize semantics.
+  defaultSize: { widthMm: 28.14, heightMm: 26.91 },
   heightLocked: true,
 
   toZPL: (obj, ctx) => {

src/types/ObjectType.ts

@@ -198,7 +198,20 @@ export interface ObjectTypeDefinition<P extends object = object> {
   icon: string;
   group: ObjectGroup;
   defaultProps: P;
-  defaultSize: { width: number; height: number };
+  /** Default footprint at palette-drop time. Two shapes:
+   *    `{ width, height }`       in dots (most types: an editor
+   *                              default chosen for visual size,
+   *                              not a spec quantity)
+   *    `{ widthMm, heightMm }`   in millimetres (spec-fixed
+   *                              physical-size types like Maxicode,
+   *                              where the printed footprint is set
+   *                              by the symbology spec regardless
+   *                              of dpmm)
+   *  The palette resolves the active variant against the current
+   *  label's dpmm so centring works at any resolution. */
+  defaultSize:
+    | { width: number; height: number }
+    | { widthMm: number; heightMm: number };
   /**
    * True if the rendered height is fixed by the symbology spec rather than the
    * `height` prop (e.g. GS1 Databar Omnidirectional). The transformer disables