@pdfme/cli 6.1.0 → 6.1.1-dev.10

package/dist/diagnostics.d.ts

@@ -25,10 +25,10 @@ export interface FieldInputHint {
     pages: number[];
     required: boolean;
     expectedInput: {
-        kind: 'string' | 'jsonStringObject' | 'enumString' | 'stringMatrix';
+        kind: 'string' | 'jsonStringObject' | 'enumString' | 'stringMatrix' | 'stringArray';
         variableNames?: string[];
         allowedValues?: string[];
-        example?: string | string[][];
+        example?: string | string[] | string[][];
         format?: string;
         canonicalFormat?: string;
         contentKind?: string;

package/dist/index.js

@@ -3,7 +3,7 @@ import { defineCommand, runMain } from "citty";
 import { PDFDocument } from "@pdfme/pdf-lib";
 import { generate } from "@pdfme/generator";
 import { pdf2img, pdf2size } from "@pdfme/converter";
-import { DEFAULT_FONT_NAME, checkGenerateProps, checkTemplate, getDefaultFont, isUrlSafeToFetch } from "@pdfme/common";
+import { DEFAULT_FONT_NAME, PAGE_SIZE_PRESETS, checkGenerateProps, checkTemplate, detectPaperSize, getDefaultFont, isUrlSafeToFetch } from "@pdfme/common";
 import { basename, dirname, extname, join, resolve } from "node:path";
 import * as schemas from "@pdfme/schemas";
 import { accessSync, constants, existsSync, mkdirSync, readFileSync, statSync, writeFileSync } from "node:fs";
@@ -313,22 +313,6 @@ function readPdfFile(filePath) {
 		});
 	}
 }
-var PAPER_SIZES = {
-	A3: [297, 420],
-	A4: [210, 297],
-	A5: [148, 210],
-	A6: [105, 148],
-	B4: [250, 353],
-	B5: [176, 250],
-	Letter: [216, 279],
-	Legal: [216, 356],
-	Tabloid: [279, 432]
-};
-function detectPaperSize(width, height) {
-	const tolerance = 2;
-	for (const [name, [w, h]] of Object.entries(PAPER_SIZES)) if (Math.abs(width - w) <= tolerance && Math.abs(height - h) <= tolerance || Math.abs(width - h) <= tolerance && Math.abs(height - w) <= tolerance) return `${name} ${width < height ? "portrait" : "landscape"}`;
-	return null;
-}
 function parsePageRange(rangeStr, totalPages) {
 	const pages = /* @__PURE__ */ new Set();
 	for (const part of rangeStr.split(",")) {
@@ -502,8 +486,8 @@ function validateTemplate(template) {
 		fields: 0
 	};
 	const totalFields = schemaPages.reduce((sum, page) => sum + page.length, 0);
-	let pageWidth = 210;
-	let pageHeight = 297;
+	let pageWidth = PAGE_SIZE_PRESETS.A4.width;
+	let pageHeight = PAGE_SIZE_PRESETS.A4.height;
 	if (template.basePdf && typeof template.basePdf === "object" && "width" in template.basePdf) {
 		pageWidth = template.basePdf.width;
 		pageHeight = template.basePdf.height;
@@ -767,6 +751,17 @@ function buildFieldInputHint(schema, page, radioGroupMembers) {
 			}
 		};
 	}
+	if (type === "list") return {
+		name: schema.name,
+		type,
+		pages: [page],
+		required: schema.required === true,
+		expectedInput: {
+			kind: "stringArray",
+			example: ["First item", "Second item"],
+			acceptsJsonString: true
+		}
+	};
 	if (type === "date" || type === "time" || type === "dateTime") {
 		const canonicalFormat = getCanonicalDateStoredFormat(type);
 		return {
@@ -853,6 +848,7 @@ function getInputContractIssue(hint, input, inputIndex) {
 	if (hint.expectedInput.kind === "jsonStringObject") return getMultiVariableTextInputIssue(hint, input, inputIndex);
 	if (hint.expectedInput.kind === "enumString") return getEnumStringInputIssue(hint, input, inputIndex);
 	if (hint.expectedInput.kind === "stringMatrix") return getStringMatrixInputIssue(hint, input, inputIndex);
+	if (hint.expectedInput.kind === "stringArray") return getStringArrayInputIssue(hint, input, inputIndex);
 	if (isCanonicalDateHint(hint)) return getCanonicalDateInputIssue(hint, input, inputIndex);
 	return null;
 }
@@ -957,6 +953,19 @@ function getStringMatrixInputIssue(hint, input, inputIndex) {
 		example
 	});
 }
+function getStringArrayInputIssue(hint, input, inputIndex) {
+	const rawValue = input[hint.name];
+	const example = hint.expectedInput.example;
+	if (rawValue === void 0 || rawValue === "") return null;
+	const issue = getStringArrayShapeIssue(typeof rawValue === "string" && hint.expectedInput.acceptsJsonString === true ? parseListJsonInput(rawValue) ?? rawValue : rawValue);
+	if (!issue) return null;
+	return buildStringArrayErrorMessage({
+		hint,
+		inputIndex,
+		extra: issue,
+		example
+	});
+}
 function isCanonicalDateHint(hint) {
 	return (hint.type === "date" || hint.type === "time" || hint.type === "dateTime") && typeof hint.expectedInput.canonicalFormat === "string" && hint.expectedInput.canonicalFormat.length > 0;
 }
@@ -992,6 +1001,12 @@ function getStringMatrixShapeIssue(value, expectedColumnCount) {
 	}
 	return null;
 }
+function getStringArrayShapeIssue(value) {
+	if (typeof value === "string") return null;
+	if (!Array.isArray(value)) return `Received ${describeValue(value)}.`;
+	for (let index = 0; index < value.length; index++) if (typeof value[index] !== "string") return `Item ${index + 1} must be a string. Received ${describeValue(value[index])}.`;
+	return null;
+}
 function getFirstArrayLength(rows) {
 	for (const row of rows) if (Array.isArray(row)) return row.length;
 	return 0;
@@ -1004,6 +1019,16 @@ function parseTableStringMatrix(rawValue) {
 		return null;
 	}
 }
+function parseListJsonInput(rawValue) {
+	if (typeof rawValue !== "string") return null;
+	const trimmed = rawValue.trim();
+	if (!trimmed.startsWith("[") && !trimmed.startsWith("{")) return null;
+	try {
+		return JSON.parse(trimmed);
+	} catch {
+		return null;
+	}
+}
 function isValidCanonicalDateValue(value, type) {
 	switch (type) {
 		case "date": return isValidCanonicalDate(value);
@@ -1077,6 +1102,11 @@ function buildStringMatrixErrorMessage(args) {
 	const compatibilityLabel = args.hint.expectedInput.acceptsJsonString === true ? " JSON string input is also accepted for compatibility." : "";
 	return `Field "${args.hint.name}" (${args.hint.type}) in input ${args.inputIndex + 1} expects a JSON array of string arrays${columnLabel}.${headerLabel}${exampleLabel}${compatibilityLabel} ${args.extra}`.trim();
 }
+function buildStringArrayErrorMessage(args) {
+	const exampleLabel = args.example !== void 0 ? ` Example: ${JSON.stringify(args.example)}.` : "";
+	const compatibilityLabel = args.hint.expectedInput.acceptsJsonString === true ? " A newline string or JSON string array is also accepted." : "";
+	return `Field "${args.hint.name}" (${args.hint.type}) in input ${args.inputIndex + 1} expects an array of strings.${exampleLabel}${compatibilityLabel} ${args.extra}`.trim();
+}
 function buildCanonicalDateErrorMessage(args) {
 	const displayFormat = args.hint.expectedInput.format;
 	const displayLabel = typeof displayFormat === "string" && displayFormat.length > 0 && displayFormat !== args.hint.expectedInput.canonicalFormat ? ` Display format hint: ${displayFormat}.` : "";
@@ -1891,10 +1921,7 @@ var generate_default = defineCommand({
 					for (let i = 0; i < images.length; i++) {
 						const templateSchemas = template.schemas ?? [];
 						const pageSchemas = templateSchemas[i % templateSchemas.length] ?? [];
-						const size = renderedPageSizes[i] ?? renderedPageSizes[0] ?? {
-							width: 210,
-							height: 297
-						};
+						const size = renderedPageSizes[i] ?? renderedPageSizes[0] ?? PAGE_SIZE_PRESETS.A4;
 						const gridImage = await drawGridOnImage(images[i], pageSchemas, gridSize, size.width, size.height, imageFormat);
 						writeOutput(imagePaths[i], gridImage);
 					}
@@ -2155,10 +2182,7 @@ var pdf2img_default = defineCommand({
 			const results = [];
 			for (const pageIdx of pageIndices) {
 				let imageData = allImages[pageIdx];
-				const size = sizes[pageIdx] ?? {
-					width: 210,
-					height: 297
-				};
+				const size = sizes[pageIdx] ?? PAGE_SIZE_PRESETS.A4;
 				if (args.grid) imageData = await drawGridOnPdfImage(imageData, gridSize, size.width, size.height, imageFormat);
 				const outputPath = join(outputDir, `${inputBase}-${pageIdx + 1}.${ext}`);
 				writeOutput(outputPath, imageData);
@@ -2246,7 +2270,7 @@ var pdf2size_default = defineCommand({
 });
 //#endregion
 //#region src/version.ts
-var CLI_VERSION = "6.1.0";
+var CLI_VERSION = "6.1.1-dev.10";
 //#endregion
 //#region src/example-templates.ts
 function getExamplesBaseUrl() {