@softwear/latestcollectioncore 1.0.205 → 1.0.206

package/dist/barcodeCanvas.d.ts

@@ -0,0 +1,11 @@
+export interface BarcodeCanvasResult {
+    dataUrl: string;
+    width: number;
+    height: number;
+}
+/**
+ * Render a barcode to a PNG data URL.
+ * Module width is fixed; the caller must scale the image uniformly into the layout box
+ * so bars are not distorted.
+ */
+export declare function renderBarcodeToDataUrl(value: string): BarcodeCanvasResult | null;

package/dist/barcodeCanvas.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderBarcodeToDataUrl = void 0;
+const jsbarcode_1 = __importDefault(require("jsbarcode"));
+/** Vite / CJS interop sometimes wraps the function as `{ default: fn }`. */
+function resolveJsBarcode() {
+    const mod = jsbarcode_1.default;
+    if (typeof mod === 'function')
+        return mod;
+    if (mod && typeof mod.default === 'function')
+        return mod.default;
+    return null;
+}
+function createCanvasElement() {
+    if (typeof document !== 'undefined' && typeof document.createElement === 'function') {
+        return document.createElement('canvas');
+    }
+    return null;
+}
+/**
+ * Render a barcode to a PNG data URL.
+ * Module width is fixed; the caller must scale the image uniformly into the layout box
+ * so bars are not distorted.
+ */
+function renderBarcodeToDataUrl(value) {
+    if (!value)
+        return null;
+    const canvas = createCanvasElement();
+    if (!canvas)
+        return null;
+    const JsBarcode = resolveJsBarcode();
+    if (!JsBarcode)
+        return null;
+    try {
+        JsBarcode(canvas, value, {
+            // Fixed module geometry — do not stretch independently in X/Y when placing on the page.
+            // CODE128 accepts arbitrary values (EAN auto-detect can throw on bad check digits).
+            format: 'CODE128',
+            width: 2,
+            height: 60,
+            displayValue: false,
+            margin: 0,
+        });
+    }
+    catch (e) {
+        if (typeof console !== 'undefined')
+            console.warn('Barcode render failed', value, e);
+        return null;
+    }
+    if (!canvas.width || !canvas.height)
+        return null;
+    return {
+        dataUrl: canvas.toDataURL('image/png'),
+        width: canvas.width,
+        height: canvas.height,
+    };
+}
+exports.renderBarcodeToDataUrl = renderBarcodeToDataUrl;

package/dist/pdf.d.ts

@@ -5,7 +5,7 @@ export interface PaperSize {
     footerHeight: number;
 }
 export type TextAlign = 1 | 2 | 3;
-export type ObjectType = 'text' | 'field' | 'rectangle' | 'image' | 'container';
+export type ObjectType = 'text' | 'field' | 'rectangle' | 'image' | 'container' | 'barcode';
 export type RepeatContainer = 'horizontal' | 'vertical' | undefined;
 export interface BaseLayoutObject {
     type: ObjectType;
@@ -44,6 +44,15 @@ export interface ImageLayoutObject extends BaseLayoutObject {
     url?: string;
     image?: HTMLImageElement;
 }
+/**
+ * Renders a 1D barcode from printBuffer via `source` (default `barcode`).
+ * Drawn with uniform scale to fit width×height (never independently stretched).
+ */
+export interface BarcodeLayoutObject extends BaseLayoutObject {
+    type: 'barcode';
+    /** Path into the current print buffer item; defaults to `barcode`. */
+    source?: string;
+}
 export interface ContainerLayoutObject extends BaseLayoutObject {
     type: 'container';
     source: string;
@@ -51,7 +60,10 @@ export interface ContainerLayoutObject extends BaseLayoutObject {
     repeatContainer?: RepeatContainer;
     repeatOnOverflow?: boolean;
     pageBreak?: boolean;
-    /** Minimum mm of remaining space before drawing next item; if less, break to next page first */
+    /**
+     * Minimum remaining space before drawing the next item; if less, break to the next page first.
+     * Same units as layout x/y/width/height (tenths of mm), e.g. 220 ≈ 22mm.
+     */
     minHeightBeforeBreak?: number;
     /** When true, container and children are drawn only once at the end of the report, not on every page */
     printOnlyAtEnd?: boolean;
@@ -61,7 +73,7 @@ export interface ContainerLayoutObject extends BaseLayoutObject {
      */
     printOnlyAtStart?: boolean;
 }
-export type LayoutObject = TextLayoutObject | FieldLayoutObject | RectangleLayoutObject | ImageLayoutObject | ContainerLayoutObject;
+export type LayoutObject = TextLayoutObject | FieldLayoutObject | RectangleLayoutObject | ImageLayoutObject | BarcodeLayoutObject | ContainerLayoutObject;
 export interface Layout {
     name?: string;
     group?: string;

package/dist/reports.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.genPDF = exports.computeImageDrawRect = void 0;
 const jspdf_1 = require("jspdf");
 const date_fns_1 = require("date-fns");
+const barcodeCanvas_1 = require("./barcodeCanvas");
 const deepCopy_1 = __importDefault(require("./deepCopy"));
 const layoutFieldFormat_1 = require("./layoutFieldFormat");
 /** Measurement uses context `currentPageNumber` (1-based). Rendering uses jsPDF’s `getCurrentPageInfo().pageNumber`, which is already 1-based (first page is 1). */
@@ -287,7 +288,7 @@ function truncateTextToFitWidth(doc, text, maxWidth) {
     return truncatedText + ELLIPSIS;
 }
 function drawSimpleObject(x, y, doc, object, printBuffer, width, height, options, context) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _f;
     let text = ''; // Will hold text to display for either 'text' or 'field'
     // Get text from object for text objects
     if (object.type == 'text') {
@@ -377,6 +378,28 @@ function drawSimpleObject(x, y, doc, object, printBuffer, width, height, options
             }
         }
     }
+    // Draw barcode for barcode objects (uniform scale into the layout box — never stretch bars)
+    if (object.type == 'barcode') {
+        const barcodeObj = object;
+        const source = barcodeObj.source || 'barcode';
+        const raw = getProperty(source, printBuffer);
+        const value = raw == null ? '' : String(raw);
+        if (!value) {
+            (_d = options.onAlert) === null || _d === void 0 ? void 0 : _d.call(options, { header: 'fieldnotfound', body: source, type: 'warning', timeout: 10000 });
+        }
+        else {
+            const rendered = (0, barcodeCanvas_1.renderBarcodeToDataUrl)(value);
+            if (rendered) {
+                const { x: drawX, y: drawY, width: drawWidth, height: drawHeight } = computeImageDrawRect(x, y, width, height, rendered.width, rendered.height);
+                try {
+                    doc.addImage(rendered.dataUrl, 'PNG', drawX, drawY, drawWidth, drawHeight);
+                }
+                catch (_e) {
+                    // Skip if jsPDF cannot embed the canvas data URL
+                }
+            }
+        }
+    }
     // Draw text for text and field objets
     if ((object.type == 'text' || object.type == 'field') && text) {
         let textAlign;
@@ -394,7 +417,7 @@ function drawSimpleObject(x, y, doc, object, printBuffer, width, height, options
             return;
         const fontStyleStr = FONT_STYLES[object.fontStyle & 3] || 'normal';
         // Use object font if it's a custom font; otherwise layout default overrides standard fonts (Helvetica etc.)
-        const fontFamily = object.fontFamily && ((_d = options.isCustomPdfFont) === null || _d === void 0 ? void 0 : _d.call(options, object.fontFamily)) ? object.fontFamily : context.defaultFontFamily || object.fontFamily || 'Helvetica';
+        const fontFamily = object.fontFamily && ((_f = options.isCustomPdfFont) === null || _f === void 0 ? void 0 : _f.call(options, object.fontFamily)) ? object.fontFamily : context.defaultFontFamily || object.fontFamily || 'Helvetica';
         doc.setFont(fontFamily, fontStyleStr);
         doc.setFontSize(object.fontSize / 4);
         doc.text(truncateTextToFitWidth(doc, text, width), x, y, { align: textAlign, baseline: 'hanging' });
@@ -531,9 +554,10 @@ addObjectToPDF = function (originX, originY, doc, object, printBuffer, paperSize
             });
             const container = source[containerIndex];
             absoluteLowerRightHandSide = { x: originX / 10, y: originY / 10 };
-            const minHeightMm = object.minHeightBeforeBreak;
-            const useOrphanCheck = minHeightMm != null && minHeightMm > 0;
-            if (useOrphanCheck && (object.pageBreak || originY + minHeightMm > paperSize.height - paperSize.footerHeight)) {
+            // Layout units (tenths of mm), same as originY / paperSize after genPDF scales them ×10.
+            const minHeightBeforeBreak = object.minHeightBeforeBreak;
+            const useOrphanCheck = minHeightBeforeBreak != null && minHeightBeforeBreak > 0;
+            if (useOrphanCheck && (object.pageBreak || originY + minHeightBeforeBreak > paperSize.height - paperSize.footerHeight)) {
                 // We ran out of paper
                 originX = layoutXtenths;
                 // Continuation sheets must not reuse the page-1-only overlap bump: addPage hasn't run yet so getCurrentPageNumber is still 1.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softwear/latestcollectioncore",
-  "version": "1.0.205",
+  "version": "1.0.206",
   "description": "Core functions for LatestCollections applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,6 +38,7 @@
   "dependencies": {
     "date-fns": "^2.29.3",
     "filtrex": "^2.2.3",
+    "jsbarcode": "^3.12.3",
     "jspdf": "^4.2.1"
   }
 }

package/src/barcodeCanvas.ts

@@ -0,0 +1,59 @@
+import JsBarcodeImport from 'jsbarcode'
+
+export interface BarcodeCanvasResult {
+  dataUrl: string
+  width: number
+  height: number
+}
+
+/** Vite / CJS interop sometimes wraps the function as `{ default: fn }`. */
+function resolveJsBarcode(): ((element: unknown, value: string, options?: object) => void) | null {
+  const mod: any = JsBarcodeImport
+  if (typeof mod === 'function') return mod
+  if (mod && typeof mod.default === 'function') return mod.default
+  return null
+}
+
+function createCanvasElement(): HTMLCanvasElement | null {
+  if (typeof document !== 'undefined' && typeof document.createElement === 'function') {
+    return document.createElement('canvas')
+  }
+  return null
+}
+
+/**
+ * Render a barcode to a PNG data URL.
+ * Module width is fixed; the caller must scale the image uniformly into the layout box
+ * so bars are not distorted.
+ */
+export function renderBarcodeToDataUrl(value: string): BarcodeCanvasResult | null {
+  if (!value) return null
+  const canvas = createCanvasElement()
+  if (!canvas) return null
+
+  const JsBarcode = resolveJsBarcode()
+  if (!JsBarcode) return null
+
+  try {
+    JsBarcode(canvas, value, {
+      // Fixed module geometry — do not stretch independently in X/Y when placing on the page.
+      // CODE128 accepts arbitrary values.
+      format: 'CODE128',
+      width: 2,
+      height: 60,
+      displayValue: false,
+      margin: 0,
+    })
+  } catch (e) {
+    if (typeof console !== 'undefined') console.warn('Barcode render failed', value, e)
+    return null
+  }
+
+  if (!canvas.width || !canvas.height) return null
+
+  return {
+    dataUrl: canvas.toDataURL('image/png'),
+    width: canvas.width,
+    height: canvas.height,
+  }
+}

package/src/pdf.ts

@@ -7,7 +7,7 @@ export interface PaperSize {
 }
 
 export type TextAlign = 1 | 2 | 3 // 1: left, 2: center, 3: right
-export type ObjectType = 'text' | 'field' | 'rectangle' | 'image' | 'container'
+export type ObjectType = 'text' | 'field' | 'rectangle' | 'image' | 'container' | 'barcode'
 export type RepeatContainer = 'horizontal' | 'vertical' | undefined
 
 export interface BaseLayoutObject {
@@ -52,6 +52,15 @@ export interface ImageLayoutObject extends BaseLayoutObject {
   image?: HTMLImageElement
 }
 
+/**
+ * Renders a 1D barcode from printBuffer via `source` (default `barcode`).
+ * Drawn with uniform scale to fit width×height (never independently stretched).
+ */
+export interface BarcodeLayoutObject extends BaseLayoutObject {
+  type: 'barcode'
+  source?: string
+}
+
 export interface ContainerLayoutObject extends BaseLayoutObject {
   type: 'container'
   source: string
@@ -70,7 +79,7 @@ export interface ContainerLayoutObject extends BaseLayoutObject {
   printOnlyAtStart?: boolean
 }
 
-export type LayoutObject = TextLayoutObject | FieldLayoutObject | RectangleLayoutObject | ImageLayoutObject | ContainerLayoutObject
+export type LayoutObject = TextLayoutObject | FieldLayoutObject | RectangleLayoutObject | ImageLayoutObject | BarcodeLayoutObject | ContainerLayoutObject
 
 export interface Layout {
   name?: string

package/src/reports.ts

@@ -1,8 +1,9 @@
 import { jsPDF } from 'jspdf'
 import { format } from 'date-fns'
+import { renderBarcodeToDataUrl } from './barcodeCanvas'
 import deepCopy from './deepCopy'
 import { resolveLayoutFieldText } from './layoutFieldFormat'
-import { PaperSize, Layout, LayoutObject, ContainerLayoutObject } from './pdf'
+import { PaperSize, Layout, LayoutObject, ContainerLayoutObject, BarcodeLayoutObject } from './pdf'
 
 type RenderMode = 'measurement' | 'rendering'
 
@@ -453,6 +454,27 @@ function drawSimpleObject(x: number, y: number, doc: jsPDF, object: LayoutObject
     }
   }
 
+  // Draw barcode for barcode objects (uniform scale into the layout box — never stretch bars)
+  if (object.type == 'barcode') {
+    const barcodeObj = object as BarcodeLayoutObject
+    const source = barcodeObj.source || 'barcode'
+    const raw = getProperty(source, printBuffer)
+    const value = raw == null ? '' : String(raw)
+    if (!value) {
+      options.onAlert?.({ header: 'fieldnotfound', body: source, type: 'warning', timeout: 10000 })
+    } else {
+      const rendered = renderBarcodeToDataUrl(value)
+      if (rendered) {
+        const { x: drawX, y: drawY, width: drawWidth, height: drawHeight } = computeImageDrawRect(x, y, width, height, rendered.width, rendered.height)
+        try {
+          doc.addImage(rendered.dataUrl, 'PNG', drawX, drawY, drawWidth, drawHeight)
+        } catch (_e) {
+          // Skip if jsPDF cannot embed the canvas data URL
+        }
+      }
+    }
+  }
+
   // Draw text for text and field objets
   if ((object.type == 'text' || object.type == 'field') && text) {
     let textAlign: 'left' | 'center' | 'right' | undefined

package/test/reports.spec.ts

@@ -455,4 +455,82 @@ describe('genPDF', () => {
     const pdfText = Buffer.from(doc.output('arraybuffer')).toString('latin1')
     expect(pdfText).toMatch(/\(\s*.\s*5\.00\) Tj/)
   })
+
+  /**
+   * Check multi-page vertical repeat with minHeightBeforeBreak.
+   */
+  function barcodeSheetLayout(): Layout {
+    return {
+      name: 'barcodesheet',
+      paperSize: { width: 210, height: 297, footerHeight: 10 },
+      objects: [
+        {
+          type: 'container',
+          name: 'items',
+          source: 'items',
+          x: 100,
+          y: 100,
+          width: 1900,
+          height: 220,
+          active: true,
+          repeatContainer: 'vertical',
+          minHeightBeforeBreak: 220,
+          children: [
+            {
+              type: 'barcode',
+              name: 'barcode',
+              source: 'barcode',
+              x: 0,
+              y: 20,
+              width: 900,
+              height: 160,
+              active: true,
+            },
+            {
+              type: 'field',
+              name: 'barcodeText',
+              source: 'barcode',
+              x: 0,
+              y: 185,
+              width: 900,
+              height: 30,
+              active: true,
+              fontFamily: 'Helvetica',
+              fontSize: 20,
+              fontStyle: 0,
+              textAlign: 2,
+            },
+          ],
+        },
+      ],
+    }
+  }
+
+  function barcodeMarksOnPage(doc: Awaited<ReturnType<typeof genPDF>>, page: number): string[] {
+    const pageOps = (doc as any).internal.pages[page] as string[] | undefined
+    if (!pageOps) return []
+    return [...pageOps.join('\n').matchAll(/\(BC-\d{3}\)/g)].map((m) => m[0].slice(1, -1))
+  }
+
+  it('keeps barcode rows that fit under minHeightBeforeBreak on a single page', async () => {
+    const items = Array.from({ length: 12 }, (_, i) => ({ barcode: `BC-${String(i).padStart(3, '0')}` }))
+    const doc = await genPDF(barcodeSheetLayout(), { items })
+    expect(doc.getNumberOfPages()).toBe(1)
+    expect(barcodeMarksOnPage(doc, 1)).toEqual(items.map((item) => item.barcode))
+  })
+
+  it('breaks barcode rows before drawing when minHeightBeforeBreak would overflow', async () => {
+    const items = Array.from({ length: 15 }, (_, i) => ({ barcode: `BC-${String(i).padStart(3, '0')}` }))
+    const doc = await genPDF(barcodeSheetLayout(), { items })
+
+    expect(doc.getNumberOfPages()).toBe(2)
+    expect(barcodeMarksOnPage(doc, 1)).toEqual(items.slice(0, 12).map((item) => item.barcode))
+    expect(barcodeMarksOnPage(doc, 2)).toEqual(items.slice(12).map((item) => item.barcode))
+
+    const pdfText = Buffer.from(doc.output('arraybuffer')).toString('latin1')
+    for (const item of items) {
+      const matches = pdfText.match(new RegExp(`\\(${item.barcode}\\)`, 'g'))
+      expect(matches, `${item.barcode} should appear exactly once`).toHaveLength(1)
+    }
+  })
 })