@pdfme/cli 6.1.0 → 6.1.1-dev.5

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

@@ -767,6 +767,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 +864,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 +969,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 +1017,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 +1035,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 +1118,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}.` : "";
@@ -2246,7 +2292,7 @@ var pdf2size_default = defineCommand({
 });
 //#endregion
 //#region src/version.ts
-var CLI_VERSION = "6.1.0";
+var CLI_VERSION = "6.1.1-dev.5";
 //#endregion
 //#region src/example-templates.ts
 function getExamplesBaseUrl() {