jc-printer-sdk-ts 0.1.0

package/src/builder.ts

@@ -0,0 +1,562 @@
+import { ItemAlignment, PenAlignment } from "./constants.js";
+import type {
+  BitmapLike,
+  CanvasCommand,
+  CommitPayload,
+  IAtBitmapDocument,
+  LabelBarcodeOptions,
+  LabelGraphOptions,
+  LabelImageOptions,
+  LabelLineOptions,
+  LabelQrCodeOptions,
+  LabelTextOptions,
+  PageOptions,
+  Point,
+  PrintDocument,
+  PrintJobOptions,
+  PrintPage,
+} from "./types.js";
+
+function clone<T>(value: T): T {
+  if (typeof globalThis.structuredClone === "function") {
+    return globalThis.structuredClone(value);
+  }
+  return JSON.parse(JSON.stringify(value)) as T;
+}
+
+function normalizeFonts(fonts: string | string[] | undefined): string[] {
+  if (Array.isArray(fonts)) {
+    return fonts.filter(Boolean);
+  }
+  if (typeof fonts === "string" && fonts.trim()) {
+    return [fonts];
+  }
+  return [];
+}
+
+function toCommand(kind: string, payload: Record<string, unknown>): CanvasCommand {
+  return { kind, payload };
+}
+
+function safeNumber(value: number | undefined, fallback: number): number {
+  return Number.isFinite(value as number) ? (value as number) : fallback;
+}
+
+function buildInfoPage(page: PrintPage, job: PrintJobOptions): string {
+  return JSON.stringify({
+    printerImageProcessingInfo: {
+      orientation: page.orientation,
+      margin: [0, 0, 0, 0],
+      printQuantity: page.printQuantity || job.totalQuantity || 1,
+      horizontalOffset: 0,
+      verticalOffset: 0,
+      width: page.width,
+      height: page.height,
+      printMultiple: job.printMultiple ?? 1,
+      epc: job.epc ?? "",
+    },
+  });
+}
+
+function bitmapFromPayload(
+  description: string,
+  width: number,
+  height: number,
+  payload: Record<string, unknown>,
+): BitmapLike {
+  return {
+    width,
+    height,
+    description,
+    meta: payload,
+  };
+}
+
+function dimensionsFromInfo(info: string): Pick<BitmapLike, "width" | "height"> {
+  try {
+    const parsed = JSON.parse(info) as {
+      printerImageProcessingInfo?: { width?: unknown; height?: unknown };
+    };
+    const imageInfo = parsed.printerImageProcessingInfo;
+    const width = Number(imageInfo?.width ?? 0);
+    const height = Number(imageInfo?.height ?? 0);
+    return {
+      width: Number.isFinite(width) ? width : 0,
+      height: Number.isFinite(height) ? height : 0,
+    };
+  } catch {
+    return { width: 0, height: 0 };
+  }
+}
+
+export class LabelBuilder {
+  readonly unit: "mm" | "px";
+
+  private job: PrintJobOptions = {};
+  private pages: PrintPage[] = [];
+  private currentPage: PrintPage | null = null;
+  private pageDefaults: PageOptions | null = null;
+  private itemOrientation = 0;
+  private itemHorizontalAlignment: number = ItemAlignment.LEFT;
+  private itemVerticalAlignment: number = ItemAlignment.TOP;
+  private itemPenAlignment: number = PenAlignment.CENTER;
+
+  constructor(unit: "mm" | "px" = "mm") {
+    this.unit = unit;
+  }
+
+  reset(): void {
+    this.job = {};
+    this.pages = [];
+    this.currentPage = null;
+    this.pageDefaults = null;
+    this.itemOrientation = 0;
+    this.itemHorizontalAlignment = ItemAlignment.LEFT;
+    this.itemVerticalAlignment = ItemAlignment.TOP;
+    this.itemPenAlignment = PenAlignment.CENTER;
+  }
+
+  startJob(density: number, paperType: number, printMode: number): void {
+    this.pages = [];
+    this.currentPage = null;
+    this.pageDefaults = null;
+    this.job = {
+      ...this.job,
+      density,
+      paperType,
+      printMode,
+      pageUnit: this.unit,
+    };
+  }
+
+  abortJob(): void {
+    this.reset();
+  }
+
+  startPage(): void {
+    this.closePage();
+    this.openPage(this.pageDefaults ?? {
+      width: 0,
+      height: 0,
+      orientation: 0,
+      fonts: [],
+      background: 0xffffff,
+      printQuantity: this.job.totalQuantity ?? 1,
+      drawParams: {},
+    });
+  }
+
+  endPage(): void {
+    this.closePage();
+  }
+
+  endJob(): void {
+    this.closePage();
+  }
+
+  drawEmptyLabel(
+    width: number,
+    height: number,
+    orientation: number,
+    fonts: string | string[],
+  ): void {
+    this.closePage();
+    this.openPage({
+      width,
+      height,
+      orientation,
+      fonts: normalizeFonts(fonts),
+      background: 0xffffff,
+      printQuantity: this.job.totalQuantity ?? 1,
+      drawParams: {},
+    });
+    this.pageDefaults = {
+      width,
+      height,
+      orientation,
+      fonts: normalizeFonts(fonts),
+      background: 0xffffff,
+      printQuantity: this.job.totalQuantity ?? 1,
+      drawParams: {},
+    };
+  }
+
+  drawLabelText(
+    x: number,
+    y: number,
+    width: number,
+    height: number,
+    text: string,
+    fontName: string,
+    fontSize: number,
+    options: LabelTextOptions = {},
+  ): void {
+    this.addCommand("drawLabelText", {
+      x,
+      y,
+      width,
+      height,
+      text,
+      fontName,
+      fontSize,
+      rotation: options.rotation ?? 0,
+      horizontalAlignment: options.horizontalAlignment ?? ItemAlignment.LEFT,
+      verticalAlignment: options.verticalAlignment ?? ItemAlignment.TOP,
+      mode: options.mode ?? 0,
+      indent: options.indent ?? 0,
+      scale: options.scale ?? 1,
+      flags: clone(options.flags ?? []),
+      unit: this.unit,
+    });
+  }
+
+  drawLabelBarCode(
+    x: number,
+    y: number,
+    width: number,
+    height: number,
+    codeType: number,
+    text: string,
+    options: LabelBarcodeOptions = {},
+  ): void {
+    this.addCommand("drawLabelBarCode", {
+      x,
+      y,
+      width,
+      height,
+      codeType,
+      text,
+      rotation: options.rotation ?? 0,
+      ratio: options.ratio ?? 1,
+      fontSize: options.fontSize ?? 0,
+      fontName: options.fontName ?? "",
+      showText: options.showText ?? true,
+      threshold: options.threshold ?? 0,
+      alignment: options.alignment ?? ItemAlignment.LEFT,
+      quietZone: options.quietZone ?? 0,
+      unit: this.unit,
+    });
+  }
+
+  drawLabelQrCode(
+    x: number,
+    y: number,
+    width: number,
+    height: number,
+    text: string,
+    options: LabelQrCodeOptions = {},
+  ): void {
+    this.addCommand("drawLabelQrCode", {
+      x,
+      y,
+      width,
+      height,
+      text,
+      rotation: options.rotation ?? 0,
+      version: options.version ?? 0,
+      errorCorrectionLevel: options.errorCorrectionLevel ?? 0,
+      margin: options.margin ?? 0,
+      unit: this.unit,
+    });
+  }
+
+  drawLabelGraph(
+    x: number,
+    y: number,
+    width: number,
+    height: number,
+    graphType: number,
+    options: LabelGraphOptions = {},
+  ): void {
+    this.addCommand("drawLabelGraph", {
+      x,
+      y,
+      width,
+      height,
+      graphType,
+      rotation: options.rotation ?? 0,
+      lineWidth: options.lineWidth ?? 1,
+      penAlignment: options.penAlignment ?? PenAlignment.CENTER,
+      dashPattern: clone(options.dashPattern ?? []),
+      unit: this.unit,
+    });
+  }
+
+  drawLabelImage(
+    source: string | BitmapLike,
+    x: number,
+    y: number,
+    width: number,
+    height: number,
+    options: LabelImageOptions = {},
+  ): void {
+    this.addCommand("drawLabelImage", {
+      source,
+      x,
+      y,
+      width,
+      height,
+      rotation: options.rotation ?? 0,
+      threshold: options.threshold ?? 0,
+      scale: options.scale ?? 1,
+      actualSize: options.actualSize ?? false,
+      unit: this.unit,
+    });
+  }
+
+  drawLabelLine(
+    x: number,
+    y: number,
+    width: number,
+    height: number,
+    options: LabelLineOptions = {},
+  ): void {
+    this.addCommand("drawLabelLine", {
+      x,
+      y,
+      width,
+      height,
+      rotation: options.rotation ?? 0,
+      lineWidth: options.lineWidth ?? 1,
+      penAlignment: options.penAlignment ?? PenAlignment.CENTER,
+      dashPattern: clone(options.dashPattern ?? []),
+      unit: this.unit,
+    });
+  }
+
+  setDrawParam(name: string, value: unknown): void {
+    this.ensurePage();
+    this.currentPage!.drawParams[name] = clone(value);
+  }
+
+  getItemOrientation(): number {
+    return this.itemOrientation;
+  }
+
+  setItemOrientation(value: number): void {
+    this.itemOrientation = value;
+  }
+
+  getItemHorizontalAlignment(): number {
+    return this.itemHorizontalAlignment;
+  }
+
+  setItemHorizontalAlignment(value: number): void {
+    this.itemHorizontalAlignment = value;
+  }
+
+  getItemVerticalAlignment(): number {
+    return this.itemVerticalAlignment;
+  }
+
+  setItemVerticalAlignment(value: number): void {
+    this.itemVerticalAlignment = value;
+  }
+
+  getItemPenAlignment(): number {
+    return this.itemPenAlignment;
+  }
+
+  setItemPenAlignment(value: number): void {
+    this.itemPenAlignment = value;
+  }
+
+  setBackground(color: number): void {
+    this.ensurePage();
+    this.currentPage!.background = color;
+  }
+
+  getPrintMultiple(): number {
+    return this.job.printMultiple ?? 1;
+  }
+
+  setTotalPrintQuantity(quantity: number): void {
+    this.job.totalQuantity = quantity;
+  }
+
+  setTotalQuantityOfPrints(quantity: number): void {
+    this.setTotalPrintQuantity(quantity);
+  }
+
+  getJobPages(): PrintPage[] {
+    const pages = this.currentPage
+      ? [...this.pages, clone(this.currentPage)]
+      : this.pages;
+    return clone(pages);
+  }
+
+  getCurrentPage(): PrintPage | null {
+    return this.currentPage ? clone(this.currentPage) : null;
+  }
+
+  toDocument(): PrintDocument {
+    const pages = this.getJobPages();
+    return {
+      schema: "jc-printer-sdk-ts/print-document@1",
+      unit: this.unit,
+      job: clone(this.job),
+      pages,
+    };
+  }
+
+  serialize(): string {
+    return JSON.stringify(this.toDocument());
+  }
+
+  generateLabelJson(): Uint8Array {
+    const page = this.currentPage ?? this.pages[this.pages.length - 1];
+    const serialized = page
+      ? JSON.stringify({
+          schema: "jc-printer-sdk-ts/page@1",
+          unit: this.unit,
+          job: clone(this.job),
+          page: clone(page),
+        })
+      : JSON.stringify({
+          schema: "jc-printer-sdk-ts/page@1",
+          unit: this.unit,
+          job: clone(this.job),
+          page: null,
+        });
+    return new TextEncoder().encode(serialized);
+  }
+
+  toCommitPayload(): CommitPayload {
+    const pages = this.getJobPages();
+    return {
+      jsonPages: pages.map((page) =>
+        JSON.stringify({
+          schema: "jc-printer-sdk-ts/page@1",
+          unit: this.unit,
+          job: clone(this.job),
+          page,
+        }),
+      ),
+      infoPages: pages.map((page) => buildInfoPage(page, this.job)),
+    };
+  }
+
+  commitImageData(
+    orientation: number,
+    bitmap: BitmapLike,
+    width: number,
+    height: number,
+    printQuantity: number,
+    marginLeft: number,
+    marginTop: number,
+    marginRight: number,
+    marginBottom: number,
+    rfid: string,
+  ): void {
+    this.addCommand("commitImageData", {
+      orientation,
+      bitmap: clone(bitmap),
+      width,
+      height,
+      printQuantity,
+      marginLeft,
+      marginTop,
+      marginRight,
+      marginBottom,
+      rfid,
+    });
+  }
+
+  generatePreviewImage(json: string, info: string): BitmapLike {
+    const { width, height } = dimensionsFromInfo(info);
+    return bitmapFromPayload("preview", width, height, { json, info, unit: this.unit });
+  }
+
+  getMultiple(): number {
+    return this.getPrintMultiple();
+  }
+
+  measureFontHeight(
+    text: string,
+    x: number,
+    y: number,
+    width: number,
+    height: number,
+    rotation: number,
+    fontSize: number,
+  ): number {
+    const lines = text.split(/\r?\n/).length;
+    const size = safeNumber(fontSize, 0);
+    return Math.max(size, Math.ceil(size * 1.2 * lines));
+  }
+
+  getStrPrintSize(text: string, fontStyle: number, fontSize: number): Point {
+    const lines = text.split(/\r?\n/);
+    const maxLine = lines.reduce((longest, line) => Math.max(longest, line.length), 0);
+    const width = Math.ceil(maxLine * fontSize * 0.6);
+    const height = Math.ceil(lines.length * fontSize * 1.2);
+    return { x: width, y: height };
+  }
+
+  getMin1DBarcode(text: string, codeType: number): BitmapLike {
+    return bitmapFromPayload("min-1d-barcode", 0, 0, { text, codeType });
+  }
+
+  getMin2DQRCode(text: string): BitmapLike {
+    return bitmapFromPayload("min-2d-qrcode", 0, 0, { text });
+  }
+
+  addLabelCommand(kind: string, payload: Record<string, unknown>): void {
+    this.addCommand(kind, payload);
+  }
+
+  private ensurePage(): void {
+    if (!this.currentPage) {
+      this.openPage(this.pageDefaults ?? {
+        width: 0,
+        height: 0,
+        orientation: 0,
+        fonts: [],
+        background: 0xffffff,
+        printQuantity: this.job.totalQuantity ?? 1,
+        drawParams: {},
+      });
+    }
+  }
+
+  private openPage(options: PageOptions): void {
+    this.currentPage = {
+      width: options.width,
+      height: options.height,
+      orientation: options.orientation,
+      fonts: clone(options.fonts ?? []),
+      background: options.background ?? 0xffffff,
+      printQuantity: options.printQuantity ?? this.job.totalQuantity ?? 1,
+      drawParams: clone(options.drawParams ?? {}),
+      commands: [],
+    };
+  }
+
+  private closePage(): void {
+    if (!this.currentPage) {
+      return;
+    }
+    this.pages.push(clone(this.currentPage));
+    this.currentPage = null;
+  }
+
+  private addCommand(kind: string, payload: Record<string, unknown>): void {
+    this.ensurePage();
+    this.currentPage!.commands.push(toCommand(kind, clone(payload)));
+  }
+}
+
+export function createLabelBuilder(unit: "mm" | "px" = "mm"): LabelBuilder {
+  return new LabelBuilder(unit);
+}
+
+export function createAtBitmapDocument(
+  job: PrintJobOptions = {},
+): IAtBitmapDocument {
+  return {
+    schema: "jc-printer-sdk-ts/at-bitmap@1",
+    unit: "px",
+    job: clone(job),
+    pages: [],
+  };
+}