@connectedxm/zpl-generator 0.0.19 → 0.0.21

package/dist/src/generate.d.ts

@@ -4,6 +4,14 @@ export declare function generate(badge: Badge, data?: SourceData, overrides?: {
     [key: string]: string;
 }): string;
 export declare function getFieldValue(field: Field, data?: SourceData): string | undefined;
+export declare function applyTextTransformation(field: TextField, value: string): string;
+/**
+ * Splits a field value the way the printer lays it out: explicit \& breaks
+ * delimit segments, whitespace delimits words within a segment. Exported so
+ * consumers measuring word widths (e.g. injectMeasuredWidths) tokenize
+ * identically to the wrap simulation in countLinesAtHeight.
+ */
+export declare function tokenizeWords(value: string): string[][];
 /**
  * Counts how many lines the field data will occupy inside a ^FB field at
  * a given font height. The field's own `fontHeight` is treated as the
@@ -18,10 +26,9 @@ export declare function countLinesAtHeight(field: TextField, value: string, heig
  * Exported so consuming projects (e.g. React label previews) can reuse
  * the same logic to stay in sync with the generator.
  *
- * When measuredWidth is provided (total rendered width in dots, as measured
- * by the consumer), line count is estimated via ceil(measuredWidth / maxWidth).
- *
- * Otherwise falls back to a character-width heuristic using charsPerLine.
+ * Priority: wordWidths (exact ^FB word-wrap simulation, when the measured
+ * words match the rendered value) → measuredWidth (continuous-stream
+ * estimate) → charsPerLine heuristic.
  */
 export declare function countLines(field: TextField, value: string): number;
 /**

package/dist/src/interfaces.d.ts

@@ -20,13 +20,23 @@ export interface SourcePass {
     passType: string;
 }
 export interface SourcePassAttribute {
+    id: string;
     name: string;
     value: string;
 }
 export interface SourcePassResponse {
+    id: string;
     name: string;
     value: string;
 }
+export interface SourcePassAddOn {
+    id: string;
+    addOn: {
+        id: string;
+        name: string;
+        shortDescription: string;
+    };
+}
 export interface SourceData {
     account: SourceAccount;
     accountAttributes: SourceAccountAttribute[];
@@ -34,4 +44,5 @@ export interface SourceData {
     pass: SourcePass;
     passResponses: SourcePassResponse[];
     passAttributes: SourcePassAttribute[];
+    passAddOns: SourcePassAddOn[];
 }

package/dist/src/validate.d.ts

@@ -206,6 +206,7 @@ export declare const SourceType: {
     readonly pass: "pass";
     readonly passResponses: "passResponses";
     readonly passAttributes: "passAttributes";
+    readonly passAddOns: "passAddOns";
 };
 export declare const sourceTypeSchema: z.ZodEnum<{
     readonly account: "account";
@@ -214,6 +215,7 @@ export declare const sourceTypeSchema: z.ZodEnum<{
     readonly pass: "pass";
     readonly passResponses: "passResponses";
     readonly passAttributes: "passAttributes";
+    readonly passAddOns: "passAddOns";
 }>;
 export type SourceType = z.infer<typeof sourceTypeSchema>;
 export declare const TextTransformation: {
@@ -251,6 +253,7 @@ export declare const textFieldSchema: z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -284,6 +287,11 @@ export declare const textFieldSchema: z.ZodObject<{
     }>;
     maxCharacters: z.ZodNumber;
     measuredWidth: z.ZodOptional<z.ZodNumber>;
+    wordWidths: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        word: z.ZodString;
+        width: z.ZodNumber;
+        spaceWidth: z.ZodNumber;
+    }, z.core.$strip>>>;
     minFontHeight: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type TextField = z.infer<typeof textFieldSchema>;
@@ -303,6 +311,7 @@ export declare const barcodeFieldSchema: z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -352,6 +361,7 @@ export declare const qrcodeFieldSchema: z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -386,6 +396,7 @@ export declare const imageFieldSchema: z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -393,6 +404,7 @@ export declare const imageFieldSchema: z.ZodObject<{
     editable: z.ZodBoolean;
     type: z.ZodLiteral<"image">;
     data: z.ZodString;
+    valueMatch: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type ImageField = z.infer<typeof imageFieldSchema>;
 export declare const fieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -411,6 +423,7 @@ export declare const fieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -444,6 +457,11 @@ export declare const fieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     }>;
     maxCharacters: z.ZodNumber;
     measuredWidth: z.ZodOptional<z.ZodNumber>;
+    wordWidths: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        word: z.ZodString;
+        width: z.ZodNumber;
+        spaceWidth: z.ZodNumber;
+    }, z.core.$strip>>>;
     minFontHeight: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>, z.ZodObject<{
     name: z.ZodString;
@@ -461,6 +479,7 @@ export declare const fieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -508,6 +527,7 @@ export declare const fieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -540,6 +560,7 @@ export declare const fieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         readonly pass: "pass";
         readonly passResponses: "passResponses";
         readonly passAttributes: "passAttributes";
+        readonly passAddOns: "passAddOns";
     }>;
     sourceLookup: z.ZodString;
     sourceSeperator: z.ZodString;
@@ -547,6 +568,7 @@ export declare const fieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     editable: z.ZodBoolean;
     type: z.ZodLiteral<"image">;
     data: z.ZodString;
+    valueMatch: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>], "type">;
 export type Field = z.infer<typeof fieldSchema>;
 export declare const fontSchema: z.ZodObject<{
@@ -672,6 +694,7 @@ export declare const badgeSchema: z.ZodObject<{
             readonly pass: "pass";
             readonly passResponses: "passResponses";
             readonly passAttributes: "passAttributes";
+            readonly passAddOns: "passAddOns";
         }>;
         sourceLookup: z.ZodString;
         sourceSeperator: z.ZodString;
@@ -705,6 +728,11 @@ export declare const badgeSchema: z.ZodObject<{
         }>;
         maxCharacters: z.ZodNumber;
         measuredWidth: z.ZodOptional<z.ZodNumber>;
+        wordWidths: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            word: z.ZodString;
+            width: z.ZodNumber;
+            spaceWidth: z.ZodNumber;
+        }, z.core.$strip>>>;
         minFontHeight: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>, z.ZodObject<{
         name: z.ZodString;
@@ -722,6 +750,7 @@ export declare const badgeSchema: z.ZodObject<{
             readonly pass: "pass";
             readonly passResponses: "passResponses";
             readonly passAttributes: "passAttributes";
+            readonly passAddOns: "passAddOns";
         }>;
         sourceLookup: z.ZodString;
         sourceSeperator: z.ZodString;
@@ -769,6 +798,7 @@ export declare const badgeSchema: z.ZodObject<{
             readonly pass: "pass";
             readonly passResponses: "passResponses";
             readonly passAttributes: "passAttributes";
+            readonly passAddOns: "passAddOns";
         }>;
         sourceLookup: z.ZodString;
         sourceSeperator: z.ZodString;
@@ -801,6 +831,7 @@ export declare const badgeSchema: z.ZodObject<{
             readonly pass: "pass";
             readonly passResponses: "passResponses";
             readonly passAttributes: "passAttributes";
+            readonly passAddOns: "passAddOns";
         }>;
         sourceLookup: z.ZodString;
         sourceSeperator: z.ZodString;
@@ -808,6 +839,7 @@ export declare const badgeSchema: z.ZodObject<{
         editable: z.ZodBoolean;
         type: z.ZodLiteral<"image">;
         data: z.ZodString;
+        valueMatch: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>], "type">>;
     fonts: z.ZodArray<z.ZodObject<{
         alias: z.ZodString;
@@ -875,7 +907,7 @@ export declare function validateBadge(data: Badge): z.ZodSafeParseResult<{
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
@@ -893,6 +925,11 @@ export declare function validateBadge(data: Badge): z.ZodSafeParseResult<{
         transformation: "None" | "Uppercase" | "Lowercase" | "Capitalize";
         maxCharacters: number;
         measuredWidth?: number | undefined;
+        wordWidths?: {
+            word: string;
+            width: number;
+            spaceWidth: number;
+        }[] | undefined;
         minFontHeight?: number | undefined;
     } | {
         name: string;
@@ -900,7 +937,7 @@ export declare function validateBadge(data: Badge): z.ZodSafeParseResult<{
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
@@ -919,7 +956,7 @@ export declare function validateBadge(data: Badge): z.ZodSafeParseResult<{
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
@@ -936,13 +973,14 @@ export declare function validateBadge(data: Badge): z.ZodSafeParseResult<{
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
         editable: boolean;
         type: "image";
         data: string;
+        valueMatch?: string | undefined;
     })[];
     fonts: {
         alias: string;
@@ -984,7 +1022,7 @@ export declare function validateBadgeOrThrow(data: Badge): {
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
@@ -1002,6 +1040,11 @@ export declare function validateBadgeOrThrow(data: Badge): {
         transformation: "None" | "Uppercase" | "Lowercase" | "Capitalize";
         maxCharacters: number;
         measuredWidth?: number | undefined;
+        wordWidths?: {
+            word: string;
+            width: number;
+            spaceWidth: number;
+        }[] | undefined;
         minFontHeight?: number | undefined;
     } | {
         name: string;
@@ -1009,7 +1052,7 @@ export declare function validateBadgeOrThrow(data: Badge): {
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
@@ -1028,7 +1071,7 @@ export declare function validateBadgeOrThrow(data: Badge): {
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
@@ -1045,13 +1088,14 @@ export declare function validateBadgeOrThrow(data: Badge): {
         y: number;
         defaultValue: string;
         verticalAlignment: "start" | "end";
-        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes";
+        sourceType: "account" | "accountAttributes" | "accountTiers" | "pass" | "passResponses" | "passAttributes" | "passAddOns";
         sourceLookup: string;
         sourceSeperator: string;
         hideEmpty: boolean;
         editable: boolean;
         type: "image";
         data: string;
+        valueMatch?: string | undefined;
     })[];
     fonts: {
         alias: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/zpl-generator",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "",
   "license": "ISC",
   "author": "",