feat(image): the delivery select names an inline graphic on the printer itself

Author: u8array

packages/core/src/lib/resourceDelivery.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { applyFontDelivery, applyGraphicDelivery, fontDelivery, graphicDelivery, graphicJobShips } from "./resourceDelivery";
+import { applyFontDelivery, applyGraphicDelivery, draftGraphicIdentity, fontDelivery, graphicDelivery, graphicJobShips, graphicWayBlocks } from "./resourceDelivery";
 import type { ImageProps } from "../registry/image";
 
 const GFA = "^GFA,4,4,1,00FFFF00";
@@ -42,8 +42,8 @@ describe("fontDelivery", () => {
 });
 
 describe("graphicDelivery", () => {
-  it("has no way to choose for an inline ^GF, and reads job while the design ships the bytes", () => {
-    expect(graphicDelivery(image(null), [entry])).toBeUndefined();
+  it("reads job for an inline ^GF and for a design that ships the bytes", () => {
+    expect(graphicDelivery(image(null), [entry])).toBe("job");
     expect(graphicDelivery(image(), [entry])).toBe("job");
     expect(graphicDelivery(image({ embedInZpl: false }), [entry])).toBe("setup");
     expect(graphicDelivery(image({ embedInZpl: false }), undefined)).toBe("printer");
@@ -80,7 +80,39 @@ describe("graphicDelivery", () => {
     expect(graphicJobShips(image({ embedInZpl: false }))).toBe(true);
     expect(graphicJobShips({ ...image(), _gfaCache: undefined })).toBe(false);
     expect(graphicJobShips({ ...image(), _gfaCache: "^GFA,4,4,1," })).toBe(false);
-    expect(graphicJobShips(image(null))).toBe(false);
+  });
+
+  it("names an inline graphic only on the way off the job, and never opaque bytes", () => {
+    const identity = { device: "R", name: "IMG_1" };
+    expect(applyGraphicDelivery("job", image(null), undefined, identity)).toEqual({ patch: null, setupGraphics: undefined });
+    expect(applyGraphicDelivery("printer", image(null), undefined, identity)).toEqual({ patch: { storedAs: { ...identity, embedInZpl: false } }, setupGraphics: undefined });
+    const provided = applyGraphicDelivery("setup", image(null), undefined, identity);
+    expect(provided).toMatchObject({ patch: { storedAs: { ...identity, embedInZpl: false }, _gfaCache: expect.stringContaining("^GFA") }, setupGraphics: [{ path: "R:IMG_1.GRF", gfa: expect.stringContaining("^GFA") }] });
+    expect(applyGraphicDelivery("printer", { ...image(null), rawGf: "^GFA,4,4,1,00FFFF00" }, undefined, identity)).toBeUndefined();
+  });
+
+  it("names why a way is shut, in the order the delivery would refuse it", () => {
+    const identity = { device: "R", name: "IMG_1" };
+    expect(graphicWayBlocks(image(null), identity, undefined, null)).toEqual({ job: undefined, setup: undefined });
+    expect(graphicWayBlocks({ ...image(null), _gfaCache: undefined }, identity, undefined, null)).toEqual({ job: "noJobBytes", setup: "noUploadBytes" });
+    expect(graphicWayBlocks({ ...image(), _gfaCache: undefined }, identity, undefined, null)).toEqual({ job: "noUploadBytes", setup: "noUploadBytes" });
+    expect(graphicWayBlocks({ ...image(null), _gfaCache: undefined, rawGf: GFA }, identity, undefined, null)).toEqual({ job: undefined, setup: "opaque", printer: "opaque" });
+    expect(graphicWayBlocks(image(null), identity, [{ path: "R:IMG_1.GRF", gfa: GFA }], null)).toEqual({ job: undefined });
+    expect(graphicWayBlocks(image(null), identity, undefined, "unshippable")).toEqual({ job: undefined, setup: "tooWide" });
+    expect(graphicWayBlocks(image(null), identity, undefined, "tooLarge")).toEqual({ job: undefined, setup: "tooLarge" });
+  });
+
+  it("drafts a printer name no profile entry holds", () => {
+    const names = ["IMG_0000", "IMG_1111"];
+    const taken = names.map((n) => ({ path: `R:${n}.GRF`, gfa: GFA }));
+    for (let i = 0; i < 50; i++) expect(names).not.toContain(draftGraphicIdentity(taken).name);
+  });
+
+  it("ships an inline job from an upright cache or a raw ^GF and from nothing else", () => {
+    expect(graphicJobShips(image(null))).toBe(true);
+    expect(graphicJobShips({ ...image(null), rotation: "R" })).toBe(false);
+    expect(graphicJobShips({ ...image(null), _gfaCache: undefined })).toBe(false);
+    expect(graphicJobShips({ ...image(null), _gfaCache: undefined, rawGf: "^GFA,4,4,1,00FFFF00" })).toBe(true);
   });
 
   it("refuses setup for bytes the script cannot carry, and does nothing without a printer name", () => {

packages/core/src/lib/resourceDelivery.ts

@@ -1,7 +1,7 @@
 import type { CustomFontMapping } from "../types/LabelConfig";
 import type { PrinterProfile, SetupGraphic } from "../types/PrinterProfile";
-import { setupGraphicOf, storedGraphicShips, type ImageProps } from "../registry/image";
-import { uploadedGraphicPath } from "./storagePath";
+import { canSendSetupGraphic, inlineGraphicShips, setupGraphicOf, setupGraphicState, storedGraphicShips, type ImageProps } from "../registry/image";
+import { defaultStorageName, uploadedGraphicPath } from "./storagePath";
 import { findSetupEntry, withSetupEntry, withoutSetupEntry } from "./setupEntries";
 
 /** How a file reaches the printer: with every job, once through the setup script, or assumed to be there. */
@@ -22,10 +22,9 @@ export function fontDelivery(mapping: FontShip, path: string, setupFonts: readon
   return findSetupEntry(setupFonts, path) ? "setup" : "printer";
 }
 
-/** Undefined for an image without a printer name, which prints as inline ^GF and has no way to choose. */
-export function graphicDelivery(p: ImageProps, setupGraphics: readonly SetupGraphic[] | undefined): ResourceDelivery | undefined {
-  if (!p.storedAs) return undefined;
-  if (p.storedAs.embedInZpl !== false) return "job";
+/** Job while the design ships the bytes, else setup or printer by the profile entry. */
+export function graphicDelivery(p: ImageProps, setupGraphics: readonly SetupGraphic[] | undefined): ResourceDelivery {
+  if (!p.storedAs || p.storedAs.embedInZpl !== false) return "job";
   return findSetupEntry(setupGraphics, uploadedGraphicPath(p.storedAs)) ? "setup" : "printer";
 }
 
@@ -45,7 +44,8 @@ export function applyFontDelivery(
 
 /** Whether "job" would put bytes into the stream, so the choice never claims what the emit cannot send. */
 export function graphicJobShips(p: ImageProps): boolean {
-  return p.storedAs !== undefined && storedGraphicShips({ ...p, storedAs: { ...p.storedAs, embedInZpl: true } });
+  if (!p.storedAs) return inlineGraphicShips(p);
+  return storedGraphicShips({ ...p, storedAs: { ...p.storedAs, embedInZpl: true } });
 }
 
 /** A delivery that provides the file names it as the upload does, so a recall spelled with another
@@ -56,17 +56,53 @@ export function providedGraphic(p: ImageProps): ImageProps {
   return { ...p, storedAs };
 }
 
+export type GraphicIdentity = Pick<NonNullable<ImageProps["storedAs"]>, "device" | "name">;
+
+/** A printer name no profile entry holds yet, so sending the graphic cannot adopt another one's bytes. */
+export function draftGraphicIdentity(setupGraphics: readonly SetupGraphic[] | undefined): GraphicIdentity {
+  let identity: GraphicIdentity;
+  do identity = { device: "R", name: defaultStorageName() };
+  while (findSetupEntry(setupGraphics, uploadedGraphicPath(identity)));
+  return identity;
+}
+
 type GraphicDeliveryPatch =
   | { patch: Partial<ImageProps> | null; setupGraphics: readonly SetupGraphic[] | undefined }
   | { refused: "tooLarge" | "unshippable" };
 
-/** A profile entry the design already has stays as it is, so choosing "setup" encodes only when none exists. */
+export type GraphicWayBlock = "opaque" | "tooLarge" | "tooWide" | "noUploadBytes" | "noJobBytes";
+
+/** Why a way cannot be chosen, so the select and its reasons never disagree with the delivery that follows. */
+export function graphicWayBlocks(
+  p: ImageProps,
+  identity: GraphicIdentity,
+  setupGraphics: readonly SetupGraphic[] | undefined,
+  refusal: "tooLarge" | "unshippable" | null,
+): Partial<Record<ResourceDelivery, GraphicWayBlock>> {
+  const job = graphicJobShips(p) ? undefined : p.storedAs ? "noUploadBytes" : "noJobBytes";
+  if (p.rawGf) return { job, setup: "opaque", printer: "opaque" };
+  const identified = providedGraphic({ ...p, storedAs: p.storedAs ?? identity });
+  // An existing entry needs no encode, so only a missing one lets the bytes decide.
+  if (findSetupEntry(setupGraphics, uploadedGraphicPath(identified.storedAs ?? identity))) return { job };
+  const setup = setupGraphicState(identified, setupGraphics) === "tooLarge" || refusal === "tooLarge"
+    ? "tooLarge"
+    : refusal === "unshippable"
+      ? "tooWide"
+      : canSendSetupGraphic(identified)
+        ? undefined
+        : "noUploadBytes";
+  return { job, setup };
+}
+
+/** An existing profile entry stays, and an inline graphic takes `identity` only on the way off the job. */
 export function applyGraphicDelivery(
   next: ResourceDelivery,
   p: ImageProps,
   setupGraphics: readonly SetupGraphic[] | undefined,
+  identity?: GraphicIdentity,
 ): GraphicDeliveryPatch | undefined {
-  const storedAs = p.storedAs;
+  // Opaque bytes emit before any recall, so a printer name could never replace them.
+  const storedAs: ImageProps["storedAs"] = p.storedAs ?? (p.rawGf ? undefined : identity);
   if (!storedAs) return undefined;
   const path = uploadedGraphicPath(storedAs);
   const ships = storedAs.embedInZpl !== false;

packages/core/src/registry/image.ts

@@ -273,6 +273,12 @@ export function storedGraphicShips(p: ImageProps): boolean {
   return !!getImage(p.imageId) || (!!p._gfaCache && gfShipsSafely(p._gfaCache));
 }
 
+/** Whether an inline ^GF ships bytes, the counterpart of storedGraphicShips. */
+export function inlineGraphicShips(p: ImageProps): boolean {
+  if (p.rawGf) return gfShipsSafely(p.rawGf);
+  return !!getImage(p.imageId) || gfaCacheUsable(p);
+}
+
 /** The path a recall names: the upload's when one ships, else the reference as written. */
 export function recallStoragePath(p: ImageProps): StoragePath | undefined {
   if (!p.storedAs) return undefined;

src/components/Properties/DeliverySelect.tsx

@@ -16,10 +16,11 @@ interface Props {
   issue?: string;
   /** Jumps to the printer tab that provisions the file, offered once the file is delivered at setup. */
   onOpenSetup?: { label: string; open: () => void };
+  disabled?: boolean;
 }
 
 /** One control for every file the printer needs, so job, setup and printer cannot diverge across two widgets. */
-export function DeliverySelect({ value, onChange, resource, subject, blocked, issue, onOpenSetup }: Props) {
+export function DeliverySelect({ value, onChange, resource, subject, blocked, issue, onOpenSetup, disabled }: Props) {
   const t = useT();
   const hints: Record<ResourceDelivery, string> = resource === 'format'
     ? { job: t.delivery.formatJobHint, setup: t.delivery.formatSetupHint, printer: t.delivery.formatPrinterHint }
@@ -34,6 +35,7 @@ export function DeliverySelect({ value, onChange, resource, subject, blocked, is
           if (next !== value) onChange(next);
         }}
         aria-label={`${t.delivery.label}: ${subject}`}
+        disabled={disabled}
         groups={[{ options: RESOURCE_DELIVERIES.map((way) => ({
           value: way,
           label: t.delivery[way],

src/components/Properties/PropertiesPanel.tsx

@@ -262,6 +262,7 @@ export function PropertiesPanel({ canvasRef }: PropertiesPanelProps) {
             key={obj.id}
             obj={obj}
             onChange={(props: object) => updateObject(obj.id, { props })}
+            locked={switchLocked}
           />
         )}
 

src/locales/ar.ts

@@ -1278,7 +1278,6 @@ const ar = {
       widthDots: 'العرض',
       threshold: 'عتبة أحادية',
       storage: 'تخزين الطابعة',
-      storeOnPrinter: 'تفعيل',
       storeOnPrinterHint: 'يشير إلى رسم مخزن في الطابعة عبر ^XG. يحدد التسليم ما إذا كانت البايتات تُرسل مع كل مهمة، أو مرة واحدة في نص الإعداد، أو لا تُرسل إطلاقًا.',
       storeInline: 'تضمين مباشر',
       openObjects: 'إدارة الكائنات المخزّنة',
@@ -1732,6 +1731,8 @@ const ar = {
     printerGraphicHint: 'تكتفي المهام بالإشارة إلى الرسم. إن لم يكن موجودًا على الطابعة، لا يُطبع شيء مكانه.',
     jobNeedsAlias: 'يحتاج اسمًا مستعارًا، ليتمكن ^CW من تسمية الملف.',
     setupNeedsBytes: 'يحتاج بيانات الصورة لترميز الرفع.',
+    jobNeedsBytes: 'يحتاج بيانات الصورة لإرسالها مع مهمة الطباعة.',
+    opaqueBytes: 'تبقى البيانات كما استُورِدت ولا يمكن تخزينها على الطابعة.',
     formatJobHint: 'كل مهمة طباعة تخزّن التنسيق من جديد وتطبعه بصفوف مجموعة بيانات.',
     formatSetupHint: 'يخزّن نص إعداد ملف الطابعة هذا التنسيق مرة واحدة. تكتفي المهام بإرسال البيانات.',
     formatPrinterHint: 'تكتفي المهام بإرسال البيانات. إذا كان التنسيق مفقودًا على الطابعة، لا يُطبع شيء.',

src/locales/bg.ts

@@ -1278,7 +1278,6 @@ const bg = {
       widthDots: 'Ширина',
       threshold: 'Моно праг',
       storage: 'Памет на принтера',
-      storeOnPrinter: 'Активирай',
       storeOnPrinterHint: 'Реферира графика, съхранена в принтера, чрез ^XG. Доставката определя дали байтовете се изпращат с всяко задание, веднъж в скрипта за настройка, или изобщо не се изпращат.',
       storeInline: 'Вграждане',
       openObjects: 'Управление на съхранените обекти',
@@ -1732,6 +1731,8 @@ const bg = {
     printerGraphicHint: 'Заданията само препращат към графиката. Ако принтерът няма я, на нейно място не се отпечатва нищо.',
     jobNeedsAlias: 'Изисква псевдоним, за да може ^CW да именува файла.',
     setupNeedsBytes: 'Изисква данните на изображението, за да кодира качването.',
+    jobNeedsBytes: 'Изисква данните на изображението, за да бъдат изпратени със заданието за печат.',
+    opaqueBytes: 'Данните остават както са импортирани и не могат да се съхранят на принтера.',
     formatJobHint: 'Всяко задание за печат съхранява формата отново и го отпечатва с редовете на набор от данни.',
     formatSetupHint: 'Скриптът за настройка на този принтерен профил съхранява формата веднъж. Заданията изпращат само данните.',
     formatPrinterHint: 'Заданията изпращат само данните. Ако форматът липсва на принтера, не се отпечатва нищо.',

src/locales/cs.ts

@@ -1278,7 +1278,6 @@ const cs = {
       widthDots: 'Šířka',
       threshold: 'Mono práh',
       storage: 'Úložiště tiskárny',
-      storeOnPrinter: 'Aktivovat',
       storeOnPrinterHint: 'Odkazuje na grafiku uloženou v tiskárně pomocí ^XG. Doručení určuje, zda se bajty odešlou s každou úlohou, jednou v instalačním skriptu, nebo vůbec.',
       storeInline: 'Vložit přímo',
       openObjects: 'Spravovat uložené objekty',
@@ -1732,6 +1731,8 @@ const cs = {
     printerGraphicHint: 'Úlohy jen odkazují na grafiku. Pokud ji tiskárna nemá, na jejím místě se nic nevytiskne.',
     jobNeedsAlias: 'Vyžaduje alias, aby ^CW mohl soubor pojmenovat.',
     setupNeedsBytes: 'Vyžaduje obrazová data ke kódování nahrávání.',
+    jobNeedsBytes: 'Vyžaduje obrazová data pro odeslání s tiskovou úlohou.',
+    opaqueBytes: 'Data zůstávají tak, jak byla importována, a nelze je uložit do tiskárny.',
     formatJobHint: 'Každá tisková úloha znovu uloží formát a vytiskne ho s řádky datové sady.',
     formatSetupHint: 'Instalační skript tohoto profilu tiskárny uloží formát jednou. Úlohy odesílají jen data.',
     formatPrinterHint: 'Úlohy odesílají jen data. Pokud na tiskárně chybí formát, nic se nevytiskne.',

src/locales/da.ts

@@ -1278,7 +1278,6 @@ const da = {
       widthDots: 'Bredde',
       threshold: 'Mono-tærskel',
       storage: 'Printer-lager',
-      storeOnPrinter: 'Aktivér',
       storeOnPrinterHint: 'Refererer en grafik gemt på printeren via ^XG. Leveringen afgør, om bytene sendes med hvert job, én gang i opsætningsscriptet, eller slet ikke.',
       storeInline: 'Indlejr direkte',
       openObjects: 'Administrer gemte objekter',
@@ -1732,6 +1731,8 @@ const da = {
     printerGraphicHint: 'Job refererer kun til grafikken. Mangler printeren den, printes der ikke noget i stedet.',
     jobNeedsAlias: 'Kræver et alias, så en ^CW kan navngive filen.',
     setupNeedsBytes: 'Kræver billeddataene for at kode uploadet.',
+    jobNeedsBytes: 'Kræver billeddataene for at sende dem med printjobbet.',
+    opaqueBytes: 'Dataene forbliver som importeret og kan ikke lagres på printeren.',
     formatJobHint: 'Hvert printjob gemmer formatet igen og udskriver det med rækkerne fra et datasæt.',
     formatSetupHint: 'Opsætningsscriptet til denne printerprofil gemmer formatet én gang. Job sender kun dataene.',
     formatPrinterHint: 'Job sender kun dataene. Mangler formatet på printeren, udskrives der ikke noget.',

src/locales/de.ts

@@ -1315,7 +1315,6 @@ const de = {
       widthDots: 'Breite',
       threshold: 'Mono-Schwellenwert',
       storage: 'Drucker-Speicher',
-      storeOnPrinter: 'Aktivieren',
       storeOnPrinterHint: 'Referenziert eine Grafik auf der Drucker-Storage via ^XG. Die Bereitstellung entscheidet, ob die Bytes mit jedem Job, einmalig im Setup-Skript oder gar nicht mitgesendet werden.',
       storeInline: 'Inline einbetten',
       openObjects: 'Gespeicherte Objekte verwalten',
@@ -1769,6 +1768,8 @@ const de = {
     printerGraphicHint: 'Jobs referenzieren nur die Grafik. Fehlt sie auf dem Drucker, wird an ihrer Stelle nichts gedruckt.',
     jobNeedsAlias: 'Braucht einen Alias, damit ein ^CW die Datei benennen kann.',
     setupNeedsBytes: 'Braucht die Bilddaten, um den Upload zu kodieren.',
+    jobNeedsBytes: 'Braucht Bilddaten, die mit dem Auftrag gesendet werden.',
+    opaqueBytes: 'Die Bytes bleiben wie importiert und lassen sich nicht auf dem Drucker ablegen.',
     formatJobHint: 'Jeder Druckjob speichert das Format erneut und druckt es mit den Zeilen eines Datensatzes.',
     formatSetupHint: 'Das Setup-Skript dieses Druckerprofils speichert das Format einmalig. Jobs senden nur die Daten.',
     formatPrinterHint: 'Jobs senden nur die Daten. Fehlt das Format auf dem Drucker, wird nichts gedruckt.',