@pdfme/schemas 6.1.1 → 6.1.2-dev.3

package/dist/dynamicTemplate-C7MdZxPm.js

@@ -0,0 +1,75 @@
+import { s as createTextLineSplitRange } from "./splitRange-DmVDtmzO.js";
+import { a as measureTextLines, c as sumLineHeights, d as isInlineMarkdownTextSchema, n as getTextLineHeightsWithBox, r as getTextSplitBoxStyle } from "./measure-L5diay3k.js";
+import { n as substituteVariablesAsInlineMarkdownLiterals, r as validateVariables, t as substituteVariables } from "./helper-CEme39Uo.js";
+//#region src/multiVariableText/dynamicTemplate.ts
+var getDynamicLayoutForMultiVariableText = async (value, args) => {
+	if (args.schema.type !== "multiVariableText") return { heights: [args.schema.height] };
+	const schema = args.schema;
+	if (schema.overflow !== "expand") return { heights: [schema.height] };
+	let renderValue = value;
+	if (!schema.readOnly) {
+		if (!validateVariables(value, schema)) return { heights: [schema.height] };
+		renderValue = isInlineMarkdownTextSchema(schema) ? substituteVariablesAsInlineMarkdownLiterals(schema.text || "", value) : substituteVariables(schema.text || "", value);
+	}
+	const { lineHeights } = await measureTextLines({
+		value: renderValue,
+		schema,
+		font: args.options.font,
+		_cache: args._cache,
+		ignoreDynamicFontSize: true
+	});
+	const heights = getTextLineHeightsWithBox(lineHeights, schema);
+	const measuredHeight = sumLineHeights(heights);
+	if (measuredHeight <= schema.height || lineHeights.length === 0) return {
+		heights: [schema.height],
+		patchSplitSchema: () => ({ dynamicFontSize: void 0 })
+	};
+	return {
+		heights: lineHeights.length === 1 ? [Math.max(schema.height, measuredHeight)] : heights,
+		patchSplitSchema: ({ start, end, isSplit }) => ({
+			dynamicFontSize: void 0,
+			__splitRange: lineHeights.length === 1 ? void 0 : createTextLineSplitRange(start, end),
+			__isSplit: isSplit,
+			...getTextSplitBoxStyle(schema, {
+				start,
+				end
+			}, lineHeights.length)
+		})
+	};
+};
+//#endregion
+//#region src/text/dynamicTemplate.ts
+var getDynamicLayoutForText = async (value, args) => {
+	if (args.schema.type !== "text") return { heights: [args.schema.height] };
+	const schema = args.schema;
+	if (schema.overflow !== "expand") return { heights: [schema.height] };
+	const { lineHeights } = await measureTextLines({
+		value,
+		schema,
+		font: args.options.font,
+		_cache: args._cache,
+		ignoreDynamicFontSize: true
+	});
+	const heights = getTextLineHeightsWithBox(lineHeights, schema);
+	const measuredHeight = sumLineHeights(heights);
+	if (measuredHeight <= schema.height || lineHeights.length === 0) return {
+		heights: [schema.height],
+		patchSplitSchema: () => ({ dynamicFontSize: void 0 })
+	};
+	return {
+		heights: lineHeights.length === 1 ? [Math.max(schema.height, measuredHeight)] : heights,
+		patchSplitSchema: ({ start, end, isSplit }) => ({
+			dynamicFontSize: void 0,
+			__splitRange: lineHeights.length === 1 ? void 0 : createTextLineSplitRange(start, end),
+			__isSplit: isSplit,
+			...getTextSplitBoxStyle(schema, {
+				start,
+				end
+			}, lineHeights.length)
+		})
+	};
+};
+//#endregion
+export { getDynamicLayoutForMultiVariableText as n, getDynamicLayoutForText as t };
+
+//# sourceMappingURL=dynamicTemplate-C7MdZxPm.js.map

package/dist/dynamicTemplate-C7MdZxPm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamicTemplate-C7MdZxPm.js","names":[],"sources":["../src/multiVariableText/dynamicTemplate.ts","../src/text/dynamicTemplate.ts"],"sourcesContent":["import type { DynamicLayoutArgs, DynamicLayoutResult } from '@pdfme/common';\nimport { TEXT_OVERFLOW_EXPAND } from '../text/constants.js';\nimport {\n  getTextLineHeightsWithBox,\n  getTextSplitBoxStyle,\n  measureTextLines,\n  sumLineHeights,\n} from '../text/measure.js';\nimport { isInlineMarkdownTextSchema } from '../text/richText.js';\nimport type { MultiVariableTextSchema } from './types.js';\nimport {\n  substituteVariables,\n  substituteVariablesAsInlineMarkdownLiterals,\n  validateVariables,\n} from './helper.js';\nimport { createTextLineSplitRange } from '../splitRange.js';\n\nexport const getDynamicLayoutForMultiVariableText = async (\n  value: string,\n  args: DynamicLayoutArgs,\n): Promise<DynamicLayoutResult> => {\n  if (args.schema.type !== 'multiVariableText') return { heights: [args.schema.height] };\n\n  const schema = args.schema as MultiVariableTextSchema;\n  if (schema.overflow !== TEXT_OVERFLOW_EXPAND) {\n    return { heights: [schema.height] };\n  }\n\n  let renderValue = value;\n  if (!schema.readOnly) {\n    if (!validateVariables(value, schema)) {\n      return { heights: [schema.height] };\n    }\n\n    renderValue = isInlineMarkdownTextSchema(schema)\n      ? substituteVariablesAsInlineMarkdownLiterals(schema.text || '', value)\n      : substituteVariables(schema.text || '', value);\n  }\n  const { lineHeights } = await measureTextLines({\n    value: renderValue,\n    schema,\n    font: args.options.font,\n    _cache: args._cache,\n    // `expand` owns the height decision, so measuring against a shrink-to-fit font size\n    // would make the field keep its original box instead of growing.\n    ignoreDynamicFontSize: true,\n  });\n  const heights = getTextLineHeightsWithBox(lineHeights, schema);\n  const measuredHeight = sumLineHeights(heights);\n\n  if (measuredHeight <= schema.height || lineHeights.length === 0) {\n    return {\n      heights: [schema.height],\n      patchSplitSchema: () => ({ dynamicFontSize: undefined }),\n    };\n  }\n\n  return {\n    heights: lineHeights.length === 1 ? [Math.max(schema.height, measuredHeight)] : heights,\n    patchSplitSchema: ({ start, end, isSplit }) => ({\n      dynamicFontSize: undefined,\n      __splitRange: lineHeights.length === 1 ? undefined : createTextLineSplitRange(start, end),\n      __isSplit: isSplit,\n      ...getTextSplitBoxStyle(schema, { start, end }, lineHeights.length),\n    }),\n  };\n};\n","import type { DynamicLayoutArgs, DynamicLayoutResult } from '@pdfme/common';\nimport { TEXT_OVERFLOW_EXPAND } from './constants.js';\nimport {\n  getTextLineHeightsWithBox,\n  getTextSplitBoxStyle,\n  measureTextLines,\n  sumLineHeights,\n} from './measure.js';\nimport type { TextSchema } from './types.js';\nimport { createTextLineSplitRange } from '../splitRange.js';\n\nexport const getDynamicLayoutForText = async (\n  value: string,\n  args: DynamicLayoutArgs,\n): Promise<DynamicLayoutResult> => {\n  if (args.schema.type !== 'text') return { heights: [args.schema.height] };\n\n  const schema = args.schema as TextSchema;\n  if (schema.overflow !== TEXT_OVERFLOW_EXPAND) {\n    return { heights: [schema.height] };\n  }\n\n  const { lineHeights } = await measureTextLines({\n    value,\n    schema,\n    font: args.options.font,\n    _cache: args._cache,\n    // `expand` owns the height decision, so measuring against a shrink-to-fit font size\n    // would make the field keep its original box instead of growing.\n    ignoreDynamicFontSize: true,\n  });\n  const heights = getTextLineHeightsWithBox(lineHeights, schema);\n  const measuredHeight = sumLineHeights(heights);\n\n  if (measuredHeight <= schema.height || lineHeights.length === 0) {\n    return {\n      heights: [schema.height],\n      patchSplitSchema: () => ({ dynamicFontSize: undefined }),\n    };\n  }\n\n  return {\n    heights: lineHeights.length === 1 ? [Math.max(schema.height, measuredHeight)] : heights,\n    patchSplitSchema: ({ start, end, isSplit }) => ({\n      dynamicFontSize: undefined,\n      __splitRange: lineHeights.length === 1 ? undefined : createTextLineSplitRange(start, end),\n      __isSplit: isSplit,\n      ...getTextSplitBoxStyle(schema, { start, end }, lineHeights.length),\n    }),\n  };\n};\n"],"mappings":";;;;AAiBA,IAAa,uCAAuC,OAClD,OACA,SACiC;AACjC,KAAI,KAAK,OAAO,SAAS,oBAAqB,QAAO,EAAE,SAAS,CAAC,KAAK,OAAO,OAAO,EAAE;CAEtF,MAAM,SAAS,KAAK;AACpB,KAAI,OAAO,aAAA,SACT,QAAO,EAAE,SAAS,CAAC,OAAO,OAAO,EAAE;CAGrC,IAAI,cAAc;AAClB,KAAI,CAAC,OAAO,UAAU;AACpB,MAAI,CAAC,kBAAkB,OAAO,OAAO,CACnC,QAAO,EAAE,SAAS,CAAC,OAAO,OAAO,EAAE;AAGrC,gBAAc,2BAA2B,OAAO,GAC5C,4CAA4C,OAAO,QAAQ,IAAI,MAAM,GACrE,oBAAoB,OAAO,QAAQ,IAAI,MAAM;;CAEnD,MAAM,EAAE,gBAAgB,MAAM,iBAAiB;EAC7C,OAAO;EACP;EACA,MAAM,KAAK,QAAQ;EACnB,QAAQ,KAAK;EAGb,uBAAuB;EACxB,CAAC;CACF,MAAM,UAAU,0BAA0B,aAAa,OAAO;CAC9D,MAAM,iBAAiB,eAAe,QAAQ;AAE9C,KAAI,kBAAkB,OAAO,UAAU,YAAY,WAAW,EAC5D,QAAO;EACL,SAAS,CAAC,OAAO,OAAO;EACxB,yBAAyB,EAAE,iBAAiB,KAAA,GAAW;EACxD;AAGH,QAAO;EACL,SAAS,YAAY,WAAW,IAAI,CAAC,KAAK,IAAI,OAAO,QAAQ,eAAe,CAAC,GAAG;EAChF,mBAAmB,EAAE,OAAO,KAAK,eAAe;GAC9C,iBAAiB,KAAA;GACjB,cAAc,YAAY,WAAW,IAAI,KAAA,IAAY,yBAAyB,OAAO,IAAI;GACzF,WAAW;GACX,GAAG,qBAAqB,QAAQ;IAAE;IAAO;IAAK,EAAE,YAAY,OAAO;GACpE;EACF;;;;ACtDH,IAAa,0BAA0B,OACrC,OACA,SACiC;AACjC,KAAI,KAAK,OAAO,SAAS,OAAQ,QAAO,EAAE,SAAS,CAAC,KAAK,OAAO,OAAO,EAAE;CAEzE,MAAM,SAAS,KAAK;AACpB,KAAI,OAAO,aAAA,SACT,QAAO,EAAE,SAAS,CAAC,OAAO,OAAO,EAAE;CAGrC,MAAM,EAAE,gBAAgB,MAAM,iBAAiB;EAC7C;EACA;EACA,MAAM,KAAK,QAAQ;EACnB,QAAQ,KAAK;EAGb,uBAAuB;EACxB,CAAC;CACF,MAAM,UAAU,0BAA0B,aAAa,OAAO;CAC9D,MAAM,iBAAiB,eAAe,QAAQ;AAE9C,KAAI,kBAAkB,OAAO,UAAU,YAAY,WAAW,EAC5D,QAAO;EACL,SAAS,CAAC,OAAO,OAAO;EACxB,yBAAyB,EAAE,iBAAiB,KAAA,GAAW;EACxD;AAGH,QAAO;EACL,SAAS,YAAY,WAAW,IAAI,CAAC,KAAK,IAAI,OAAO,QAAQ,eAAe,CAAC,GAAG;EAChF,mBAAmB,EAAE,OAAO,KAAK,eAAe;GAC9C,iBAAiB,KAAA;GACjB,cAAc,YAAY,WAAW,IAAI,KAAA,IAAY,yBAAyB,OAAO,IAAI;GACzF,WAAW;GACX,GAAG,qBAAqB,QAAQ;IAAE;IAAO;IAAK,EAAE,YAAY,OAAO;GACpE;EACF"}

package/dist/graphics/image.d.ts

@@ -1,5 +1,5 @@
 import type { Plugin } from '@pdfme/common';
 import type { Schema } from '@pdfme/common';
-type ImageSchema = Schema;
+export type ImageSchema = Schema;
 declare const imageSchema: Plugin<ImageSchema>;
 export default imageSchema;

package/dist/graphics/signature.d.ts

@@ -1,4 +1,4 @@
 import type { Plugin, Schema } from '@pdfme/common';
-type SignatureSchema = Schema;
+export type SignatureSchema = Schema;
 declare const signature: Plugin<SignatureSchema>;
 export default signature;

package/dist/helper-CEme39Uo.js

@@ -0,0 +1,40 @@
+import { h as escapeInlineMarkdown } from "./measure-L5diay3k.js";
+//#region src/multiVariableText/helper.ts
+var substituteVariables = (text, variablesIn, valueMapper = (value) => value) => {
+	if (!text) return "";
+	let substitutedText = text;
+	if (variablesIn) {
+		let variables;
+		try {
+			variables = typeof variablesIn === "string" ? JSON.parse(variablesIn || "{}") : variablesIn;
+		} catch {
+			throw new SyntaxError(`[@pdfme/schemas] MVT: invalid JSON string '${variablesIn}'`);
+		}
+		Object.keys(variables).forEach((variableName) => {
+			const variableForRegex = variableName.replace(/[/\-\\^$*+?.()|[\]{}]/g, "\\$&");
+			const regex = new RegExp("\\{" + variableForRegex + "\\}", "g");
+			substitutedText = substitutedText.replace(regex, valueMapper(variables[variableName], variableName));
+		});
+	}
+	substitutedText = substitutedText.replace(/{[^{}]+}/g, "");
+	return substitutedText;
+};
+var substituteVariablesAsInlineMarkdownLiterals = (text, variablesIn) => substituteVariables(text, variablesIn, escapeInlineMarkdown);
+var validateVariables = (value, schema) => {
+	if (schema.variables.length === 0) return true;
+	let values;
+	try {
+		values = value ? JSON.parse(value) : {};
+	} catch {
+		throw new SyntaxError(`[@pdfme/generator] invalid JSON string '${value}' for variables in field ${schema.name}`);
+	}
+	for (const variable of schema.variables) if (!values[variable]) {
+		if (schema.required) throw new Error(`[@pdfme/generator] variable ${variable} is missing for field ${schema.name}`);
+		return false;
+	}
+	return true;
+};
+//#endregion
+export { substituteVariablesAsInlineMarkdownLiterals as n, validateVariables as r, substituteVariables as t };
+
+//# sourceMappingURL=helper-CEme39Uo.js.map

package/dist/helper-CEme39Uo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper-CEme39Uo.js","names":[],"sources":["../src/multiVariableText/helper.ts"],"sourcesContent":["import { MultiVariableTextSchema } from './types.js';\nimport { escapeInlineMarkdown } from '../text/inlineMarkdown.js';\n\nexport const substituteVariables = (\n  text: string,\n  variablesIn: string | Record<string, string>,\n  valueMapper: (value: string, variableName: string) => string = (value) => value,\n): string => {\n  if (!text) {\n    return '';\n  }\n\n  let substitutedText = text;\n\n  if (variablesIn) {\n    let variables: Record<string, string>;\n    try {\n      variables =\n        typeof variablesIn === 'string'\n          ? (JSON.parse(variablesIn || '{}') as Record<string, string>)\n          : variablesIn;\n    } catch {\n      throw new SyntaxError(`[@pdfme/schemas] MVT: invalid JSON string '${variablesIn as string}'`);\n    }\n\n    Object.keys(variables).forEach((variableName) => {\n      // handle special characters in variable name\n      const variableForRegex = variableName.replace(/[/\\-\\\\^$*+?.()|[\\]{}]/g, '\\\\$&');\n      const regex = new RegExp('\\\\{' + variableForRegex + '\\\\}', 'g');\n      substitutedText = substitutedText.replace(\n        regex,\n        valueMapper(variables[variableName], variableName),\n      );\n    });\n  }\n\n  // Remove any variables that were not substituted from inputs\n  substitutedText = substitutedText.replace(/{[^{}]+}/g, '');\n\n  return substitutedText;\n};\n\nexport const substituteVariablesAsInlineMarkdownLiterals = (\n  text: string,\n  variablesIn: string | Record<string, string>,\n): string => substituteVariables(text, variablesIn, escapeInlineMarkdown);\n\nexport const validateVariables = (value: string, schema: MultiVariableTextSchema): boolean => {\n  if (schema.variables.length === 0) {\n    return true;\n  }\n\n  let values;\n  try {\n    values = value ? (JSON.parse(value) as Record<string, string>) : {};\n  } catch {\n    throw new SyntaxError(\n      `[@pdfme/generator] invalid JSON string '${value}' for variables in field ${schema.name}`,\n    );\n  }\n\n  for (const variable of schema.variables) {\n    if (!values[variable]) {\n      if (schema.required) {\n        throw new Error(\n          `[@pdfme/generator] variable ${variable} is missing for field ${schema.name}`,\n        );\n      }\n      // If not required, then simply don't render this field if an input is missing\n      return false;\n    }\n  }\n\n  return true;\n};\n"],"mappings":";;AAGA,IAAa,uBACX,MACA,aACA,eAAgE,UAAU,UAC/D;AACX,KAAI,CAAC,KACH,QAAO;CAGT,IAAI,kBAAkB;AAEtB,KAAI,aAAa;EACf,IAAI;AACJ,MAAI;AACF,eACE,OAAO,gBAAgB,WAClB,KAAK,MAAM,eAAe,KAAK,GAChC;UACA;AACN,SAAM,IAAI,YAAY,8CAA8C,YAAsB,GAAG;;AAG/F,SAAO,KAAK,UAAU,CAAC,SAAS,iBAAiB;GAE/C,MAAM,mBAAmB,aAAa,QAAQ,0BAA0B,OAAO;GAC/E,MAAM,QAAQ,IAAI,OAAO,QAAQ,mBAAmB,OAAO,IAAI;AAC/D,qBAAkB,gBAAgB,QAChC,OACA,YAAY,UAAU,eAAe,aAAa,CACnD;IACD;;AAIJ,mBAAkB,gBAAgB,QAAQ,aAAa,GAAG;AAE1D,QAAO;;AAGT,IAAa,+CACX,MACA,gBACW,oBAAoB,MAAM,aAAa,qBAAqB;AAEzE,IAAa,qBAAqB,OAAe,WAA6C;AAC5F,KAAI,OAAO,UAAU,WAAW,EAC9B,QAAO;CAGT,IAAI;AACJ,KAAI;AACF,WAAS,QAAS,KAAK,MAAM,MAAM,GAA8B,EAAE;SAC7D;AACN,QAAM,IAAI,YACR,2CAA2C,MAAM,2BAA2B,OAAO,OACpF;;AAGH,MAAK,MAAM,YAAY,OAAO,UAC5B,KAAI,CAAC,OAAO,WAAW;AACrB,MAAI,OAAO,SACT,OAAM,IAAI,MACR,+BAA+B,SAAS,wBAAwB,OAAO,OACxE;AAGH,SAAO;;AAIX,QAAO"}

package/dist/index.d.ts

@@ -18,3 +18,4 @@ export { builtInPlugins } from './builtins.js';
 export { text, multiVariableText, list, image, signature, svg, table, barcodes, line, rectangle, ellipse, dateTime, date, time, select, radioGroup, checkbox, };
 export { getDynamicHeightsForTable, getDynamicLayoutForTable } from './tables.js';
 export { getDynamicLayoutForList } from './lists.js';
+export { BUILT_IN_DYNAMIC_LAYOUT_SPLIT_UNITS, LIST_ITEM_SPLIT_UNIT, TABLE_BODY_SPLIT_UNIT, TEXT_LINE_SPLIT_UNIT, createListItemSplitRange, createTableBodySplitRange, createTextLineSplitRange, getListItemRange, getTableBodyRange, getTextLineRange, type BuiltInDynamicLayoutSplitUnit, } from './splitRange.js';