@softwear/latestcollectioncore 1.0.191 → 1.0.192

package/dist/index.d.ts

@@ -19,6 +19,8 @@ export { default as reports, genPDF } from './reports';
 export { default as round2 } from './round2';
 export { default as sizeToMap } from './sizeToMap';
 export { default as transaction } from './transaction';
+export type { LayoutFieldFormat } from './layoutFieldFormat';
+export { isCurrencyFieldFormat, isZeroFieldValue, resolveLayoutFieldText, shouldSuppressZeroField } from './layoutFieldFormat';
 export * from './pdf';
 export type { GenPdfAlert, GenPdfOptions, PdfFontDefinition, PdfFontVariant, PdfImageAsset } from './reports';
 export * from './types';

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAxiosError = exports.exponentialDelay = exports.axiosRetry = exports.createAxiosInstance = exports.lcAxios = exports.transaction = exports.sizeToMap = exports.round2 = exports.genPDF = exports.reports = exports.projectObject = exports.pivotTable = exports.isean13 = exports.imageBinder = exports.hasOnlyDigits = exports.hashBrand = exports.getPreferedPropertyMappings = exports.getBrandName = exports.findMetaBrandSetting = exports.findSkuByBarcode = exports.ensureImpliedProperties = exports.ensureArray = exports.edifact = exports.ean13 = exports.deepCopy = exports.buildPropertyMappingFn = exports.articleStatus = void 0;
+exports.isAxiosError = exports.exponentialDelay = exports.axiosRetry = exports.createAxiosInstance = exports.lcAxios = exports.shouldSuppressZeroField = exports.resolveLayoutFieldText = exports.isZeroFieldValue = exports.isCurrencyFieldFormat = exports.transaction = exports.sizeToMap = exports.round2 = exports.genPDF = exports.reports = exports.projectObject = exports.pivotTable = exports.isean13 = exports.imageBinder = exports.hasOnlyDigits = exports.hashBrand = exports.getPreferedPropertyMappings = exports.getBrandName = exports.findMetaBrandSetting = exports.findSkuByBarcode = exports.ensureImpliedProperties = exports.ensureArray = exports.edifact = exports.ean13 = exports.deepCopy = exports.buildPropertyMappingFn = exports.articleStatus = void 0;
 var articleStatus_1 = require("./articleStatus");
 Object.defineProperty(exports, "articleStatus", { enumerable: true, get: function () { return __importDefault(articleStatus_1).default; } });
 var buildPropertyMappingFn_1 = require("./buildPropertyMappingFn");
@@ -61,6 +61,11 @@ var sizeToMap_1 = require("./sizeToMap");
 Object.defineProperty(exports, "sizeToMap", { enumerable: true, get: function () { return __importDefault(sizeToMap_1).default; } });
 var transaction_1 = require("./transaction");
 Object.defineProperty(exports, "transaction", { enumerable: true, get: function () { return __importDefault(transaction_1).default; } });
+var layoutFieldFormat_1 = require("./layoutFieldFormat");
+Object.defineProperty(exports, "isCurrencyFieldFormat", { enumerable: true, get: function () { return layoutFieldFormat_1.isCurrencyFieldFormat; } });
+Object.defineProperty(exports, "isZeroFieldValue", { enumerable: true, get: function () { return layoutFieldFormat_1.isZeroFieldValue; } });
+Object.defineProperty(exports, "resolveLayoutFieldText", { enumerable: true, get: function () { return layoutFieldFormat_1.resolveLayoutFieldText; } });
+Object.defineProperty(exports, "shouldSuppressZeroField", { enumerable: true, get: function () { return layoutFieldFormat_1.shouldSuppressZeroField; } });
 __exportStar(require("./pdf"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./consts"), exports);

package/dist/layoutFieldFormat.d.ts

@@ -0,0 +1,16 @@
+export type LayoutFieldFormat = 'text' | 'number' | 'date' | 'currency' | 'number-nonzero' | 'currency-nonzero';
+export interface ResolveLayoutFieldTextOptions {
+    pageNumber?: number;
+    pageCount?: number;
+    formatDate: (raw: number | string) => string;
+    formatCurrency?: (raw: string) => string;
+    onFieldNotFound?: (source: string) => void;
+}
+export declare function isZeroFieldValue(value: unknown): boolean;
+export declare function isCurrencyFieldFormat(format: string | undefined): boolean;
+export declare function shouldSuppressZeroField(format: string | undefined): boolean;
+export declare function resolveLayoutFieldText(object: {
+    format?: string;
+    source?: string;
+    type?: string;
+}, printBuffer: any, getProperty: (propertyName: string, object: any) => any, options: ResolveLayoutFieldTextOptions): string;

package/dist/layoutFieldFormat.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveLayoutFieldText = exports.shouldSuppressZeroField = exports.isCurrencyFieldFormat = exports.isZeroFieldValue = void 0;
+function isZeroFieldValue(value) {
+    if (value === 0 || value === '0')
+        return true;
+    if (typeof value === 'number')
+        return value === 0;
+    if (typeof value !== 'string')
+        return false;
+    const trimmed = value.trim();
+    if (trimmed === '0')
+        return true;
+    const normalized = trimmed.replace(',', '.');
+    const parsed = parseFloat(normalized);
+    return trimmed !== '' && !Number.isNaN(parsed) && parsed === 0;
+}
+exports.isZeroFieldValue = isZeroFieldValue;
+function isCurrencyFieldFormat(format) {
+    return format === 'currency' || format === 'currency-nonzero';
+}
+exports.isCurrencyFieldFormat = isCurrencyFieldFormat;
+function shouldSuppressZeroField(format) {
+    return format === 'currency-nonzero' || format === 'number-nonzero';
+}
+exports.shouldSuppressZeroField = shouldSuppressZeroField;
+function resolveLayoutFieldText(object, printBuffer, getProperty, options) {
+    var _a, _b, _c, _d, _e;
+    if (object.type !== 'field')
+        return '';
+    let raw;
+    if (object.source === 'pageNumber')
+        raw = String((_a = options.pageNumber) !== null && _a !== void 0 ? _a : '');
+    else if (object.source === 'pageCount')
+        raw = String((_b = options.pageCount) !== null && _b !== void 0 ? _b : 0);
+    else if (object.source === 'page')
+        raw = `${(_c = options.pageNumber) !== null && _c !== void 0 ? _c : ''} / ${(_d = options.pageCount) !== null && _d !== void 0 ? _d : 0}`;
+    else if (object.source && printBuffer !== undefined && printBuffer !== null)
+        raw = getProperty(object.source, printBuffer);
+    else
+        raw = printBuffer;
+    if (shouldSuppressZeroField(object.format) && isZeroFieldValue(raw))
+        return '';
+    let text;
+    if (typeof raw === 'number')
+        text = String(raw);
+    else if (raw === undefined || raw === null) {
+        (_e = options.onFieldNotFound) === null || _e === void 0 ? void 0 : _e.call(options, object.source || '');
+        return '';
+    }
+    else
+        text = String(raw);
+    if (object.format === 'date')
+        text = options.formatDate(parseInt(text));
+    if (isCurrencyFieldFormat(object.format)) {
+        text = options.formatCurrency ? options.formatCurrency(text) : '€ ' + parseFloat(text).toFixed(2);
+    }
+    return text;
+}
+exports.resolveLayoutFieldText = resolveLayoutFieldText;

package/dist/pdf.d.ts

@@ -1,3 +1,4 @@
+import type { LayoutFieldFormat } from './layoutFieldFormat';
 export interface PaperSize {
     width: number;
     height: number;
@@ -28,7 +29,7 @@ export interface TextLayoutObject extends BaseLayoutObject {
 export interface FieldLayoutObject extends BaseLayoutObject {
     type: 'field';
     source?: string;
-    format?: 'date' | 'currency';
+    format?: LayoutFieldFormat;
     textAlign?: TextAlign;
     fontFamily: string;
     fontSize: number;

package/dist/reports.js

@@ -16,6 +16,7 @@ exports.genPDF = void 0;
 const jspdf_1 = require("jspdf");
 const date_fns_1 = require("date-fns");
 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). */
 function getCurrentPageNumber(doc, context) {
     var _a;
@@ -268,7 +269,7 @@ function truncateTextToFitWidth(doc, text, maxWidth) {
     return truncatedText + ELLIPSIS;
 }
 function drawSimpleObject(x, y, doc, object, printBuffer, width, height, options, context) {
-    var _a, _b, _c;
+    var _a, _b;
     let text = ''; // Will hold text to display for either 'text' or 'field'
     // Get text from object for text objects
     if (object.type == 'text') {
@@ -276,33 +277,16 @@ function drawSimpleObject(x, y, doc, object, printBuffer, width, height, options
     }
     // Get text from printBuffer for field objects
     if (object.type == 'field') {
-        if (object.source === 'pageNumber') {
-            text = String(doc.getNumberOfPages());
-        }
-        else if (object.source === 'pageCount') {
-            text = String(context.pageCount || 0);
-        }
-        else if (object.source === 'page') {
-            text = String(doc.getNumberOfPages()) + ' / ' + String(context.pageCount || 0);
-        }
-        else if (object.source && printBuffer) {
-            text = getProperty(object.source, printBuffer);
-        }
-        else {
-            text = printBuffer;
-        }
-        if (typeof text == 'number')
-            text = '' + text;
-        if (object.format == 'date')
-            text = formatDate(parseInt(text));
-        if (text === undefined || typeof text != 'string') {
-            (_a = options.onAlert) === null || _a === void 0 ? void 0 : _a.call(options, { header: 'fieldnotfound', body: object.source, type: 'warning', timeout: 10000 });
-            text = '';
-        }
-        if (object.format == 'currency') {
-            const raw = text;
-            text = options.formatCurrency ? options.formatCurrency(raw) : '€ ' + parseFloat(raw).toFixed(2);
-        }
+        text = (0, layoutFieldFormat_1.resolveLayoutFieldText)(object, printBuffer, getProperty, {
+            pageNumber: doc.getNumberOfPages(),
+            pageCount: context.pageCount || 0,
+            formatDate,
+            formatCurrency: options.formatCurrency,
+            onFieldNotFound: (source) => {
+                var _a;
+                (_a = options.onAlert) === null || _a === void 0 ? void 0 : _a.call(options, { header: 'fieldnotfound', body: source, type: 'warning', timeout: 10000 });
+            },
+        });
     }
     // Manipulate case as specified in object
     if ((object.type === 'text' || object.type === 'field') && object.case === 1)
@@ -364,7 +348,7 @@ function drawSimpleObject(x, y, doc, object, printBuffer, width, height, options
         const imgUrl = resolveImageUrl(object, printBuffer);
         if (imgUrl) {
             const urlLower = String(imgUrl).toLowerCase();
-            const imageAsset = (_b = context.imageAssets) === null || _b === void 0 ? void 0 : _b.get(String(imgUrl));
+            const imageAsset = (_a = context.imageAssets) === null || _a === void 0 ? void 0 : _a.get(String(imgUrl));
             const format = (imageAsset === null || imageAsset === void 0 ? void 0 : imageAsset.format) || (urlLower.endsWith('.png') ? 'PNG' : urlLower.endsWith('.jpg') || urlLower.endsWith('.jpeg') ? 'JPEG' : 'JPEG');
             let drawX = x;
             let drawY = y;
@@ -403,7 +387,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 && ((_c = options.isCustomPdfFont) === null || _c === void 0 ? void 0 : _c.call(options, object.fontFamily)) ? object.fontFamily : context.defaultFontFamily || object.fontFamily || 'Helvetica';
+        const fontFamily = object.fontFamily && ((_b = options.isCustomPdfFont) === null || _b === void 0 ? void 0 : _b.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' });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softwear/latestcollectioncore",
-  "version": "1.0.191",
+  "version": "1.0.192",
   "description": "Core functions for LatestCollections applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -19,6 +19,8 @@ export { default as reports, genPDF } from './reports'
 export { default as round2 } from './round2'
 export { default as sizeToMap } from './sizeToMap'
 export { default as transaction } from './transaction'
+export type { LayoutFieldFormat } from './layoutFieldFormat'
+export { isCurrencyFieldFormat, isZeroFieldValue, resolveLayoutFieldText, shouldSuppressZeroField } from './layoutFieldFormat'
 export * from './pdf'
 export type { GenPdfAlert, GenPdfOptions, PdfFontDefinition, PdfFontVariant, PdfImageAsset } from './reports'
 export * from './types'

package/src/layoutFieldFormat.ts

@@ -0,0 +1,60 @@
+export type LayoutFieldFormat = 'text' | 'number' | 'date' | 'currency' | 'number-nonzero' | 'currency-nonzero'
+
+export interface ResolveLayoutFieldTextOptions {
+  pageNumber?: number
+  pageCount?: number
+  formatDate: (raw: number | string) => string
+  formatCurrency?: (raw: string) => string
+  onFieldNotFound?: (source: string) => void
+}
+
+export function isZeroFieldValue(value: unknown): boolean {
+  if (value === 0 || value === '0') return true
+  if (typeof value === 'number') return value === 0
+  if (typeof value !== 'string') return false
+  const trimmed = value.trim()
+  if (trimmed === '0') return true
+  const normalized = trimmed.replace(',', '.')
+  const parsed = parseFloat(normalized)
+  return trimmed !== '' && !Number.isNaN(parsed) && parsed === 0
+}
+
+export function isCurrencyFieldFormat(format: string | undefined): boolean {
+  return format === 'currency' || format === 'currency-nonzero'
+}
+
+export function shouldSuppressZeroField(format: string | undefined): boolean {
+  return format === 'currency-nonzero' || format === 'number-nonzero'
+}
+
+export function resolveLayoutFieldText(
+  object: { format?: string; source?: string; type?: string },
+  printBuffer: any,
+  getProperty: (propertyName: string, object: any) => any,
+  options: ResolveLayoutFieldTextOptions,
+): string {
+  if (object.type !== 'field') return ''
+
+  let raw: unknown
+  if (object.source === 'pageNumber') raw = String(options.pageNumber ?? '')
+  else if (object.source === 'pageCount') raw = String(options.pageCount ?? 0)
+  else if (object.source === 'page') raw = `${options.pageNumber ?? ''} / ${options.pageCount ?? 0}`
+  else if (object.source && printBuffer !== undefined && printBuffer !== null) raw = getProperty(object.source, printBuffer)
+  else raw = printBuffer
+
+  if (shouldSuppressZeroField(object.format) && isZeroFieldValue(raw)) return ''
+
+  let text: string
+  if (typeof raw === 'number') text = String(raw)
+  else if (raw === undefined || raw === null) {
+    options.onFieldNotFound?.(object.source || '')
+    return ''
+  } else text = String(raw)
+
+  if (object.format === 'date') text = options.formatDate(parseInt(text))
+  if (isCurrencyFieldFormat(object.format)) {
+    text = options.formatCurrency ? options.formatCurrency(text) : '€ ' + parseFloat(text).toFixed(2)
+  }
+
+  return text
+}

package/src/pdf.ts

@@ -1,3 +1,5 @@
+import type { LayoutFieldFormat } from './layoutFieldFormat'
+
 export interface PaperSize {
   width: number
   height: number
@@ -32,7 +34,7 @@ export interface TextLayoutObject extends BaseLayoutObject {
 export interface FieldLayoutObject extends BaseLayoutObject {
   type: 'field'
   source?: string
-  format?: 'date' | 'currency'
+  format?: LayoutFieldFormat
   textAlign?: TextAlign
   fontFamily: string
   fontSize: number

package/src/reports.ts

@@ -1,6 +1,7 @@
 import { jsPDF } from 'jspdf'
 import { format } from 'date-fns'
 import deepCopy from './deepCopy'
+import { resolveLayoutFieldText } from './layoutFieldFormat'
 import { PaperSize, Layout, LayoutObject, ContainerLayoutObject } from './pdf'
 
 type RenderMode = 'measurement' | 'rendering'
@@ -342,27 +343,15 @@ function drawSimpleObject(x: number, y: number, doc: jsPDF, object: LayoutObject
   }
   // Get text from printBuffer for field objects
   if (object.type == 'field') {
-    if (object.source === 'pageNumber') {
-      text = String(doc.getNumberOfPages())
-    } else if (object.source === 'pageCount') {
-      text = String(context.pageCount || 0)
-    } else if (object.source === 'page') {
-      text = String(doc.getNumberOfPages()) + ' / ' + String(context.pageCount || 0)
-    } else if (object.source && printBuffer) {
-      text = getProperty(object.source, printBuffer)
-    } else {
-      text = printBuffer
-    }
-    if (typeof text == 'number') text = '' + text
-    if (object.format == 'date') text = formatDate(parseInt(text))
-    if (text === undefined || typeof text != 'string') {
-      options.onAlert?.({ header: 'fieldnotfound', body: object.source, type: 'warning', timeout: 10000 })
-      text = ''
-    }
-    if (object.format == 'currency') {
-      const raw = text
-      text = options.formatCurrency ? options.formatCurrency(raw) : '€ ' + parseFloat(raw).toFixed(2)
-    }
+    text = resolveLayoutFieldText(object, printBuffer, getProperty, {
+      pageNumber: doc.getNumberOfPages(),
+      pageCount: context.pageCount || 0,
+      formatDate,
+      formatCurrency: options.formatCurrency,
+      onFieldNotFound: (source) => {
+        options.onAlert?.({ header: 'fieldnotfound', body: source, type: 'warning', timeout: 10000 })
+      },
+    })
   }
   // Manipulate case as specified in object
   if ((object.type === 'text' || object.type === 'field') && object.case === 1) text = text.toUpperCase()

package/test/layoutFieldFormat.spec.ts

@@ -0,0 +1,69 @@
+import { describe, expect, it } from 'vitest'
+import { isZeroFieldValue, resolveLayoutFieldText } from '../src/layoutFieldFormat'
+
+const getProperty = (propertyName: string, object: any) => object[propertyName]
+
+describe('isZeroFieldValue', () => {
+  it('detects numeric and string zero values', () => {
+    expect(isZeroFieldValue(0)).toBe(true)
+    expect(isZeroFieldValue('0')).toBe(true)
+    expect(isZeroFieldValue('0.00')).toBe(true)
+    expect(isZeroFieldValue('0,00')).toBe(true)
+    expect(isZeroFieldValue('  0.0  ')).toBe(true)
+  })
+
+  it('does not treat empty or non-zero values as zero', () => {
+    expect(isZeroFieldValue('')).toBe(false)
+    expect(isZeroFieldValue(null)).toBe(false)
+    expect(isZeroFieldValue(undefined)).toBe(false)
+    expect(isZeroFieldValue('10')).toBe(false)
+    expect(isZeroFieldValue(0.01)).toBe(false)
+  })
+})
+
+describe('resolveLayoutFieldText', () => {
+  const baseOptions = {
+    formatDate: (raw: number | string) => `DATE:${raw}`,
+    formatCurrency: (raw: string) => `CUR:${raw}`,
+  }
+
+  it('suppresses currency-nonzero fields with zero values', () => {
+    const text = resolveLayoutFieldText(
+      { type: 'field', source: 'amount', format: 'currency-nonzero' },
+      { amount: '0.00' },
+      getProperty,
+      baseOptions,
+    )
+    expect(text).toBe('')
+  })
+
+  it('formats non-zero currency-nonzero fields as currency', () => {
+    const text = resolveLayoutFieldText(
+      { type: 'field', source: 'amount', format: 'currency-nonzero' },
+      { amount: '12.5' },
+      getProperty,
+      baseOptions,
+    )
+    expect(text).toBe('CUR:12.5')
+  })
+
+  it('suppresses number-nonzero fields with zero values', () => {
+    const text = resolveLayoutFieldText(
+      { type: 'field', source: 'qty', format: 'number-nonzero' },
+      { qty: 0 },
+      getProperty,
+      baseOptions,
+    )
+    expect(text).toBe('')
+  })
+
+  it('keeps regular number fields at zero', () => {
+    const text = resolveLayoutFieldText(
+      { type: 'field', source: 'qty', format: 'number' },
+      { qty: 0 },
+      getProperty,
+      baseOptions,
+    )
+    expect(text).toBe('0')
+  })
+})

package/test/reports.spec.ts

@@ -389,4 +389,58 @@ describe('genPDF', () => {
     // jsPDF encodes U+20AC as WinAnsi 0x80 in the text operator; still one glyph before digits.
     expect(pdfText).toMatch(/\(\s*.\s*10\.00\) Tj/)
   })
+
+  it('suppresses currency-nonzero fields when the value is zero', async () => {
+    const layout: Layout = {
+      name: 'currency-nonzero',
+      paperSize: { width: 210, height: 297, footerHeight: 20 },
+      objects: [
+        {
+          type: 'field' as const,
+          name: 'discount',
+          x: 20,
+          y: 20,
+          width: 500,
+          height: 50,
+          active: true,
+          source: 'discount',
+          format: 'currency-nonzero' as const,
+          textAlign: 1 as const,
+          fontFamily: 'Helvetica',
+          fontSize: 32,
+          fontStyle: 0,
+        },
+      ],
+    }
+    const doc = await genPDF(layout, { discount: '0.00' })
+    const pdfText = Buffer.from(doc.output('arraybuffer')).toString('latin1')
+    expect(pdfText).not.toMatch(/0\.00/)
+  })
+
+  it('renders currency-nonzero fields when the value is non-zero', async () => {
+    const layout: Layout = {
+      name: 'currency-nonzero-value',
+      paperSize: { width: 210, height: 297, footerHeight: 20 },
+      objects: [
+        {
+          type: 'field' as const,
+          name: 'discount',
+          x: 20,
+          y: 20,
+          width: 500,
+          height: 50,
+          active: true,
+          source: 'discount',
+          format: 'currency-nonzero' as const,
+          textAlign: 1 as const,
+          fontFamily: 'Helvetica',
+          fontSize: 32,
+          fontStyle: 0,
+        },
+      ],
+    }
+    const doc = await genPDF(layout, { discount: '5' })
+    const pdfText = Buffer.from(doc.output('arraybuffer')).toString('latin1')
+    expect(pdfText).toMatch(/\(\s*.\s*5\.00\) Tj/)
+  })
 })