@10x-media/form-builder 0.1.0-beta.1 → 0.1.0-beta.11

package/dist/collections/forms.js

@@ -1,23 +1,58 @@
+import { fieldNamesOfType } from "../fields/fieldNamesOfType.js";
 import { keys } from "../translations/keys.js";
-import { labelFor, labelForKey } from "../translations/server.js";
+import { asTranslate, labelForKey, resolveDefinitionLabel } from "../translations/server.js";
+import { localizedIf } from "../fields/localizedIf.js";
+import { validateUrl } from "../validation/validateUrl.js";
+import { normalizeCalc } from "../calc/normalizeCalc.js";
 import { isLoggedIn } from "../plugin/access.js";
 import { buildActionBlocks } from "../actions/buildActionBlocks.js";
-import { resolveFormResultsRequest } from "../aggregation/resolveResultsRequest.js";
-import { normalizeCalc } from "../calc/normalizeCalc.js";
 import { buildConditionTypeMap } from "../conditions/conditionType.js";
-import { normalizeFormConditions } from "../conditions/normalizeConditions.js";
+import { buildOperandTypes, normalizeFormConditions, normalizeWhere } from "../conditions/normalizeConditions.js";
+import { resolveConsentStatements } from "../consent/resolveConsentStatements.js";
 import { buildFieldBlocks } from "../fields/buildFieldBlocks.js";
 import { normalizeFlow } from "../flow/normalizeFlow.js";
-import { DEFAULT_PRESENTATION_NAME, defaultPresentationDescriptors } from "../presentations/defaults.js";
+import { END_OF_FORM } from "../flow/types.js";
+import { buildPollOptionSourceFields } from "../poll/buildPollOptionSourceFields.js";
+import { resolvePollTypes } from "../poll/pollTypeRegistry.js";
+import { enqueuePollClose } from "../poll/closeJob.js";
+import { pollOutcomeBeforeChange } from "../poll/outcomeBeforeChange.js";
+import { buildDefaultOutcomeFields } from "../poll/outcomeFields.js";
+import { buildValidateResultsField, pollEligibleTypes } from "../poll/resultsField.js";
+import { buildDefaultButtonFields } from "./buttonFields.js";
+import { buildFormsEndpoints } from "./formsEndpoints.js";
 import { ValidationError } from "payload";
 //#region src/collections/forms.ts
 const FORMS_SLUG = "forms";
+/** `req.context` key under which `consentAfterRead` tracks the form ids it is currently resolving, to break re-entrant reads. */
+const CONSENT_AFTER_READ_GUARD = "formBuilderConsentAfterReadInFlight";
+/**
+* Require the title in the default locale (and on hosts without localization), but let it be empty in
+* other locales so a localized form falls back to the default-locale title rather than forcing a
+* translation for every locale. Payload's field-level `required` cannot express this: it enforces per
+* write-locale, which would make a title mandatory in every locale and break the documented fallback.
+*/
+const validateFormTitle = (value, { req }) => {
+	const localization = req.payload.config.localization;
+	const defaultLocale = localization ? localization.defaultLocale : void 0;
+	if ((defaultLocale === void 0 || req.locale === void 0 || req.locale === defaultLocale) && (typeof value !== "string" || value.trim().length === 0)) return req.t("validation:required");
+	return true;
+};
+/**
+* Field-level validation for the raw flow JSON: step ids must be non-empty, unique, and not the
+* reserved `END_OF_FORM` sentinel, and every explicit step-id reference (a string `next`, a
+* transition `to`) must resolve to a known step. `next: null` (explicit end of form) and an
+* absent `next` (fall through to the next step in array order) are always valid. On full-document
+* saves the beforeValidate pass has already run `normalizeFlow` and laundered dangling
+* references, so the unknown-target checks mainly protect partial API updates that send `flow`
+* without `fields`.
+*/
 const validateFlow = (raw) => {
 	if (raw === null || raw === void 0) return true;
 	const r = raw;
 	if (!Array.isArray(r.steps)) return true;
 	const steps = r.steps;
 	if (steps.find((s) => typeof s?.id !== "string" || s.id.length === 0)) return "Flow: every step must have a non-empty ID";
+	if (steps.some((s) => s.id === "__end__")) return `Flow: step ID "${END_OF_FORM}" is reserved`;
 	const ids = steps.map((s) => s.id);
 	if (new Set(ids).size !== ids.length) return "Flow: duplicate step IDs found";
 	const idSet = new Set(ids);
@@ -36,149 +71,416 @@ const providedFlowStepCount = (raw) => {
 	const steps = raw.steps;
 	return Array.isArray(steps) ? steps.length : 0;
 };
-const buildFormsCollection = ({ registry, ruleRegistry, consentRegistry, presentationRegistry = new Map(Object.entries(defaultPresentationDescriptors)), actionRegistry = /* @__PURE__ */ new Map() }) => {
+/**
+* Stamp the configured uploads collection slug onto every `file` block (including repeater
+* sub-fields) on each save. The block carries a hidden `uploadsCollection` field so the slug
+* reaches the client renderer through the form document; the server always overwrites it from
+* plugin config, so the stored value is never author- or client-controlled.
+*/
+const stampFileCollections = (rows, slug) => {
+	for (const row of rows) {
+		if (row.blockType === "file") row.uploadsCollection = slug;
+		const subFields = row.subFields;
+		if (Array.isArray(subFields)) stampFileCollections(subFields, slug);
+	}
+};
+const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentSources, consentResolveOnRead, actionRegistry = /* @__PURE__ */ new Map(), localizeContent = true, richText, uploadsCollectionSlug, resultsAccess, pollSourceRegistry, pollTypeRegistry, outcomeFields, buttons, response, fromAddresses, departments, redirectRelationships }) => {
 	const conditionTypes = buildConditionTypeMap(registry);
+	const pollTypes = pollTypeRegistry ?? resolvePollTypes();
+	const pollResultsTypes = pollEligibleTypes(registry);
+	const bareTypes = new Set([...registry.values()].filter((d) => d.bare === true).map((d) => d.type));
+	const bareTypeLabels = Object.fromEntries([...registry.values()].filter((d) => d.bare === true).map((d) => [d.type, d.label]));
+	const responseEditor = richText?.responseEditor ?? richText?.editor;
 	const FLOW_BUILDER_REF = "@10x-media/form-builder/client#FlowBuilder";
+	const FIELD_NAME_SELECT_REF = "@10x-media/form-builder/client#FieldNameSelect";
+	const FLOW_STEPS_CELL_REF = "@10x-media/form-builder/client#FlowStepsCell";
+	const FIELD_COUNT_CELL_REF = "@10x-media/form-builder/client#FieldCountCell";
+	const CLOSE_POLL_BUTTON_REF = "@10x-media/form-builder/client#ClosePollButton";
+	const hasOptionSources = (pollSourceRegistry?.size ?? 0) > 0;
+	const orderedPollTypes = [...[...pollTypes.values()].filter((strategy) => strategy.type === "mostVoted"), ...[...pollTypes.values()].filter((strategy) => strategy.type !== "mostVoted")];
 	const beforeValidate = ({ data, req }) => {
-		if (data && typeof data.defaultPresentation === "string" && !presentationRegistry.has(data.defaultPresentation)) data.defaultPresentation = DEFAULT_PRESENTATION_NAME;
 		if (data && Array.isArray(data.fields)) {
 			const normalized = normalizeFormConditions(data.fields, conditionTypes);
 			for (const field of normalized) if ("expression" in field) field.expression = normalizeCalc(field.expression);
+			if (uploadsCollectionSlug) stampFileCollections(normalized, uploadsCollectionSlug);
 			data.fields = normalized;
-			const fieldNames = normalized.map((field) => typeof field.name === "string" ? field.name : void 0).filter((name) => name !== void 0);
-			const normalizedFlow = normalizeFlow(data.flow, fieldNames);
+			const fieldKeys = normalized.map((field) => {
+				if (typeof field.name === "string" && field.name.length > 0) return field.name;
+				return bareTypes.has(field.blockType) && field.id != null ? String(field.id) : void 0;
+			}).filter((key) => key !== void 0);
+			const operandTypes = buildOperandTypes(normalized, conditionTypes);
+			const normalizedFlow = normalizeFlow(data.flow, fieldKeys, (w) => normalizeWhere(w, operandTypes));
 			if (providedFlowStepCount(data.flow) > 0 && normalizedFlow === void 0) throw new ValidationError({
 				collection: FORMS_SLUG,
 				errors: [{
 					path: "flow",
-					message: "A flow needs at least two steps with unique, non-empty IDs. Add another step or remove the flow."
+					message: "A flow needs at least two steps. Add another step or remove the flow."
 				}]
 			}, req.t);
 			data.flow = normalizedFlow;
+			if (data.pollEnabled === true) {
+				const poll = data.poll != null && typeof data.poll === "object" ? data.poll : {};
+				const resultsField = typeof poll.resultsField === "string" ? poll.resultsField.trim() : "";
+				const sourceDriven = (typeof poll.optionSource === "string" ? poll.optionSource.trim() : "").length > 0 || poll.type === "source";
+				if (resultsField.length === 0 && !sourceDriven) {
+					const eligible = fieldNamesOfType(data.fields, pollResultsTypes);
+					if (eligible.length === 1) data.poll = {
+						...poll,
+						resultsField: eligible[0]
+					};
+					else {
+						const messageKey = eligible.length > 1 ? keys.pollVoteFieldChoose : keys.pollVoteFieldMissing;
+						throw new ValidationError({
+							collection: FORMS_SLUG,
+							errors: [{
+								path: "poll.resultsField",
+								message: asTranslate(req.t)(messageKey)
+							}]
+						}, req.t);
+					}
+				}
+			}
 		}
 		return data;
 	};
-	return {
-		slug: FORMS_SLUG,
-		labels: {
-			singular: "Form",
-			plural: "Forms"
-		},
-		admin: {
-			group: "Forms",
-			useAsTitle: "title"
-		},
-		access: { read: () => true },
-		hooks: { beforeValidate: [beforeValidate] },
+	const pollCloseAfterChange = async ({ doc, req }) => {
+		await enqueuePollClose({
+			payload: req.payload,
+			form: doc,
+			req
+		});
+		return doc;
+	};
+	const fieldsField = {
+		name: "fields",
+		type: "blocks",
+		blocks: buildFieldBlocks({
+			registry,
+			ruleRegistry,
+			localize: localizeContent
+		}),
+		admin: { components: { Cell: FIELD_COUNT_CELL_REF } }
+	};
+	const flowField = {
+		name: "flow",
+		type: "json",
+		validate: validateFlow,
+		admin: { components: {
+			Cell: FLOW_STEPS_CELL_REF,
+			Field: {
+				path: FLOW_BUILDER_REF,
+				clientProps: {
+					conditionTypes,
+					bareTypeLabels
+				}
+			}
+		} },
+		typescriptSchema: [() => ({
+			type: "object",
+			required: ["steps"],
+			additionalProperties: false,
+			properties: { steps: {
+				type: "array",
+				items: {
+					type: "object",
+					required: ["id"],
+					additionalProperties: true,
+					properties: {
+						id: { type: "string" },
+						title: { type: "string" },
+						fields: {
+							type: "array",
+							items: { type: "string" }
+						},
+						next: { type: ["string", "null"] },
+						transitions: {
+							type: "array",
+							items: {
+								type: "object",
+								required: ["to"],
+								additionalProperties: true,
+								properties: {
+									to: { type: "string" },
+									when: {
+										type: "object",
+										additionalProperties: true
+									}
+								}
+							}
+						}
+					}
+				}
+			} }
+		})]
+	};
+	const actionsField = {
+		name: "actions",
+		type: "blocks",
+		blocks: buildActionBlocks(actionRegistry),
+		label: labelForKey(keys.configActions),
+		access: { read: isLoggedIn }
+	};
+	const redirectReferenceField = redirectRelationships && redirectRelationships.length > 0 ? [{
+		name: "reference",
+		type: "relationship",
+		relationTo: redirectRelationships,
+		label: labelForKey(keys.responseRedirectReference),
+		admin: { description: labelForKey(keys.responseRedirectReferenceDescription) }
+	}] : [];
+	const defaultRedirectFields = [{
+		name: "url",
+		type: "text",
+		label: labelForKey(keys.responseUrl),
+		validate: validateUrl
+	}, ...redirectReferenceField];
+	const redirectFields = response?.redirect?.fields ? response.redirect.fields({ defaultFields: defaultRedirectFields }) : defaultRedirectFields;
+	const responseField = {
+		name: "response",
+		type: "group",
 		fields: [
 			{
-				name: "title",
-				type: "text",
-				required: true,
-				label: labelForKey(keys.fieldTitle)
+				name: "type",
+				type: "select",
+				defaultValue: "message",
+				label: labelForKey(keys.responseType),
+				admin: { isClearable: false },
+				options: [{
+					label: labelForKey(keys.responseTypeMessage),
+					value: "message"
+				}, {
+					label: labelForKey(keys.responseTypeRedirect),
+					value: "redirect"
+				}]
 			},
 			{
-				name: "fields",
-				type: "blocks",
-				blocks: buildFieldBlocks(registry, ruleRegistry, consentRegistry)
+				name: "message",
+				type: "richText",
+				label: labelForKey(keys.responseMessage),
+				admin: { condition: (_data, siblingData) => siblingData?.type !== "redirect" },
+				...responseEditor ? { editor: responseEditor } : {},
+				...localizedIf(localizeContent)
 			},
 			{
-				name: "flow",
-				type: "json",
-				validate: validateFlow,
+				name: "redirect",
+				type: "group",
+				label: labelForKey(keys.responseRedirect),
+				admin: {
+					condition: (_data, siblingData) => siblingData?.type === "redirect",
+					hideGutter: true
+				},
+				fields: redirectFields
+			}
+		]
+	};
+	const defaultOutcomeFields = buildDefaultOutcomeFields();
+	const defaultButtonFields = buildDefaultButtonFields(localizeContent);
+	const halfWidth = (field) => ({
+		...field,
+		admin: {
+			...field.admin,
+			width: "50%"
+		}
+	});
+	const composedButtons = buttons?.fields ? buttons.fields({ defaultFields: defaultButtonFields }) : defaultButtonFields;
+	const submitField = composedButtons.submit;
+	const prevNextRow = {
+		type: "row",
+		admin: { condition: (data) => {
+			const steps = data?.flow?.steps;
+			return Array.isArray(steps) && steps.length >= 1;
+		} },
+		fields: [halfWidth(composedButtons.prev), halfWidth(composedButtons.next)]
+	};
+	const pollGroupField = {
+		name: "poll",
+		type: "group",
+		label: false,
+		fields: [
+			{
+				name: "resultsField",
+				type: "text",
+				label: labelForKey(keys.pollResultsField),
+				validate: buildValidateResultsField(pollResultsTypes),
 				admin: { components: { Field: {
-					path: FLOW_BUILDER_REF,
-					clientProps: { conditionTypes }
-				} } },
-				typescriptSchema: [() => ({
-					type: "object",
-					required: ["steps"],
-					additionalProperties: false,
-					properties: { steps: {
-						type: "array",
-						items: {
-							type: "object",
-							required: ["id"],
-							additionalProperties: true,
-							properties: {
-								id: { type: "string" },
-								title: { type: "string" },
-								fields: {
-									type: "array",
-									items: { type: "string" }
-								},
-								next: { type: "string" },
-								transitions: {
-									type: "array",
-									items: {
-										type: "object",
-										required: ["to"],
-										additionalProperties: true,
-										properties: {
-											to: { type: "string" },
-											when: {
-												type: "object",
-												additionalProperties: true
-											}
-										}
-									}
-								}
-							}
-						}
-					} }
-				})]
+					path: FIELD_NAME_SELECT_REF,
+					clientProps: {
+						types: pollResultsTypes,
+						descriptionKey: keys.pollResultsFieldDescription
+					}
+				} } }
 			},
 			{
-				name: "actions",
-				type: "blocks",
-				blocks: buildActionBlocks(actionRegistry),
-				label: labelForKey(keys.configActions),
-				access: { read: isLoggedIn }
+				name: "type",
+				type: "select",
+				defaultValue: "mostVoted",
+				label: labelForKey(keys.pollType),
+				admin: {
+					isClearable: false,
+					description: labelForKey(keys.pollTypeDescription)
+				},
+				options: orderedPollTypes.filter((strategy) => strategy.type !== "source" || hasOptionSources).map((strategy) => ({
+					label: resolveDefinitionLabel(strategy.label),
+					value: strategy.type
+				}))
 			},
 			{
-				name: "defaultPresentation",
+				name: "resultsVisibility",
 				type: "select",
-				defaultValue: DEFAULT_PRESENTATION_NAME,
-				options: [...presentationRegistry.values()].map((descriptor) => ({
-					label: labelFor(descriptor.label),
-					value: descriptor.name
-				})),
-				label: labelForKey(keys.configDefaultPresentation),
-				admin: { position: "sidebar" }
+				defaultValue: "afterVote",
+				label: labelForKey(keys.pollResultsVisibility),
+				admin: { isClearable: false },
+				options: [{
+					label: labelForKey(keys.pollVisibilityAfterVote),
+					value: "afterVote"
+				}, {
+					label: labelForKey(keys.pollVisibilityAfterClose),
+					value: "afterClose"
+				}]
 			},
 			{
-				name: "showResults",
-				type: "checkbox",
-				defaultValue: false,
-				label: labelForKey(keys.configShowResults),
-				admin: { position: "sidebar" }
+				name: "closesAt",
+				type: "date",
+				label: labelForKey(keys.pollClosesAt),
+				admin: { date: { pickerAppearance: "dayAndTime" } }
 			},
 			{
-				name: "resultsField",
-				type: "text",
-				label: labelForKey(keys.configResultsField),
-				admin: {
-					position: "sidebar",
-					description: "Field whose aggregate results are public when \"Show results publicly\" is on. Use a choice field, never a free-text or PII field.",
-					condition: (data) => Boolean(data?.showResults)
-				}
-			}
-		],
-		endpoints: [{
-			path: "/:id/results",
-			method: "get",
-			handler: async (req) => {
-				const field = typeof req.query?.field === "string" ? req.query.field : void 0;
-				const { status, body } = await resolveFormResultsRequest({
-					payload: req.payload,
-					formId: req.routeParams?.id,
-					field,
-					isAuthed: Boolean(req.user),
-					req
-				});
-				return Response.json(body, { status });
+				name: "closePoll",
+				type: "ui",
+				admin: { components: { Field: CLOSE_POLL_BUTTON_REF } }
+			},
+			...buildPollOptionSourceFields(pollSourceRegistry ?? /* @__PURE__ */ new Map()),
+			{
+				name: "outcome",
+				type: "group",
+				label: labelForKey(keys.pollOutcome),
+				admin: { hideGutter: true },
+				fields: outcomeFields ? outcomeFields({ defaultFields: defaultOutcomeFields }) : [defaultOutcomeFields.winningValues, defaultOutcomeFields.resolvedAt]
 			}
-		}]
+		]
+	};
+	const defaultFields = [
+		{
+			name: "title",
+			type: "text",
+			label: labelForKey(keys.fieldTitle),
+			...localizedIf(localizeContent),
+			validate: validateFormTitle
+		},
+		{
+			type: "row",
+			fields: [{
+				name: "multistep",
+				type: "checkbox",
+				defaultValue: false,
+				label: labelForKey(keys.formMultistep),
+				admin: { width: "50%" }
+			}, {
+				name: "pollEnabled",
+				type: "checkbox",
+				defaultValue: false,
+				label: labelForKey(keys.formPollEnabled),
+				admin: { width: "50%" }
+			}]
+		},
+		{
+			name: "persistSubmissions",
+			type: "checkbox",
+			defaultValue: true,
+			label: labelForKey(keys.formPersistSubmissions),
+			admin: { width: "50%" }
+		},
+		{
+			type: "tabs",
+			tabs: [
+				{
+					label: labelForKey(keys.tabFields),
+					fields: [fieldsField, submitField]
+				},
+				{
+					label: labelForKey(keys.tabFlow),
+					admin: { condition: (_data, siblingData) => siblingData?.multistep === true },
+					fields: [flowField, prevNextRow]
+				},
+				{
+					label: labelForKey(keys.pollGroup),
+					admin: { condition: (_data, siblingData) => siblingData?.pollEnabled === true },
+					fields: [pollGroupField]
+				},
+				{
+					label: labelForKey(keys.tabActions),
+					fields: [actionsField]
+				},
+				{
+					label: labelForKey(keys.tabResponse),
+					fields: [responseField]
+				}
+			]
+		}
+	];
+	const consentAfterRead = consentSources && consentResolveOnRead !== false ? async ({ doc, req }) => {
+		const id = doc.id;
+		const key = id == null ? void 0 : String(id);
+		if (key !== void 0 && req.context) {
+			const inFlight = req.context[CONSENT_AFTER_READ_GUARD] ?? /* @__PURE__ */ new Set();
+			if (inFlight.has(key)) return doc;
+			inFlight.add(key);
+			req.context[CONSENT_AFTER_READ_GUARD] = inFlight;
+		}
+		try {
+			const statements = await resolveConsentStatements({
+				payload: req.payload,
+				req,
+				form: doc,
+				sources: consentSources
+			});
+			if (Object.keys(statements).length > 0) doc.consentStatements = statements;
+		} catch (error) {
+			req.payload.logger?.warn(`form-builder consent afterRead: ${String(error)}`);
+		} finally {
+			if (key !== void 0 && req.context) req.context[CONSENT_AFTER_READ_GUARD]?.delete(key);
+		}
+		return doc;
+	} : void 0;
+	const defaultEndpoints = buildFormsEndpoints({
+		resultsAccess,
+		pollResultsTypes,
+		consentSources,
+		fromAddresses,
+		departments
+	});
+	return {
+		...overrides ?? {},
+		slug: FORMS_SLUG,
+		labels: {
+			singular: labelForKey(keys.collectionFormSingular),
+			plural: labelForKey(keys.collectionFormPlural),
+			...overrides?.labels ?? {}
+		},
+		admin: {
+			group: "Forms",
+			useAsTitle: "title",
+			defaultColumns: [
+				"title",
+				"fields",
+				"flow",
+				"pollEnabled",
+				"updatedAt"
+			],
+			...overrides?.admin ?? {}
+		},
+		access: {
+			read: () => true,
+			...overrides?.access ?? {}
+		},
+		hooks: {
+			...overrides?.hooks ?? {},
+			beforeValidate: [beforeValidate, ...overrides?.hooks?.beforeValidate ?? []],
+			beforeChange: [pollOutcomeBeforeChange, ...overrides?.hooks?.beforeChange ?? []],
+			afterChange: [pollCloseAfterChange, ...overrides?.hooks?.afterChange ?? []],
+			afterRead: [...consentAfterRead ? [consentAfterRead] : [], ...overrides?.hooks?.afterRead ?? []]
+		},
+		endpoints: [...defaultEndpoints, ...Array.isArray(overrides?.endpoints) ? overrides.endpoints : []],
+		fields: overrides?.fields ? overrides.fields({ defaultFields }) : defaultFields
 	};
 };
 //#endregion