@10x-media/form-builder 0.1.0-beta.4 → 0.1.0-beta.6

package/dist/collections/forms.js

@@ -1,25 +1,61 @@
+import { fieldNamesOfType } from "../fields/fieldNamesOfType.js";
 import { localizedIf } from "../fields/localizedIf.js";
 import { keys } from "../translations/keys.js";
-import { labelForKey } from "../translations/server.js";
+import { asTranslate, labelFor, labelForKey } from "../translations/server.js";
+import { resolveFromAddressesRequest } from "../actions/fromAddresses.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 { resolvePollTypes } from "../poll/pollTypeRegistry.js";
+import { enqueuePollClose } from "../poll/closeJob.js";
 import { resolveFormResultsRequest } from "../aggregation/resolveResultsRequest.js";
 import { buildConditionTypeMap } from "../conditions/conditionType.js";
 import { normalizeFormConditions } from "../conditions/normalizeConditions.js";
+import { resolveConsentSourcesRequest } from "../consent/resolveConsentSourcesRequest.js";
+import { resolveConsentStatements } from "../consent/resolveConsentStatements.js";
+import { resolveDepartmentsRequest } from "../email/departments.js";
 import { buildFieldBlocks } from "../fields/buildFieldBlocks.js";
 import { normalizeFlow } from "../flow/normalizeFlow.js";
+import { END_OF_FORM } from "../flow/types.js";
 import { buildPollOptionSourceFields } from "../poll/buildPollOptionSourceFields.js";
+import { pollOutcomeBeforeChange } from "../poll/outcomeBeforeChange.js";
+import { buildDefaultOutcomeFields } from "../poll/outcomeFields.js";
+import { resolvePollCloseRequest } from "../poll/resolvePollCloseRequest.js";
+import { resolvePollOptionsRequest } from "../poll/resolvePollOptionsRequest.js";
+import { buildValidateResultsField, pollEligibleTypes } from "../poll/resultsField.js";
+import { buildDefaultButtonFields } from "./buttonFields.js";
 import { ValidationError } from "payload";
 //#region src/collections/forms.ts
 const FORMS_SLUG = "forms";
+/**
+* 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);
@@ -51,17 +87,30 @@ const stampFileCollections = (rows, slug) => {
 		if (Array.isArray(subFields)) stampFileCollections(subFields, slug);
 	}
 };
-const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegistry, actionRegistry = /* @__PURE__ */ new Map(), localizeContent = true, uploadsCollectionSlug, resultsAccess, pollSourceRegistry }) => {
+const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentSources, 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 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 && 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 normalizedFlow = normalizeFlow(data.flow, fieldKeys);
 			if (providedFlowStepCount(data.flow) > 0 && normalizedFlow === void 0) throw new ValidationError({
 				collection: FORMS_SLUG,
 				errors: [{
@@ -70,27 +119,64 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 				}]
 			}, 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;
 	};
+	const pollCloseAfterChange = async ({ doc, req }) => {
+		await enqueuePollClose({
+			payload: req.payload,
+			form: doc,
+			req
+		});
+		return doc;
+	};
+	const pollTypeOptionLabel = (label) => typeof label === "string" ? labelFor(label) : label;
 	const fieldsField = {
 		name: "fields",
 		type: "blocks",
 		blocks: buildFieldBlocks({
 			registry,
 			ruleRegistry,
-			consentRegistry,
 			localize: localizeContent
-		})
+		}),
+		admin: { components: { Cell: FIELD_COUNT_CELL_REF } }
 	};
 	const flowField = {
 		name: "flow",
 		type: "json",
 		validate: validateFlow,
-		admin: { components: { Field: {
-			path: FLOW_BUILDER_REF,
-			clientProps: { conditionTypes }
-		} } },
+		admin: { components: {
+			Cell: FLOW_STEPS_CELL_REF,
+			Field: {
+				path: FLOW_BUILDER_REF,
+				clientProps: {
+					conditionTypes,
+					bareTypeLabels
+				}
+			}
+		} },
 		typescriptSchema: [() => ({
 			type: "object",
 			required: ["steps"],
@@ -108,7 +194,7 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 							type: "array",
 							items: { type: "string" }
 						},
-						next: { type: "string" },
+						next: { type: ["string", "null"] },
 						transitions: {
 							type: "array",
 							items: {
@@ -136,6 +222,20 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 		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",
@@ -159,50 +259,104 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 				type: "richText",
 				label: labelForKey(keys.responseMessage),
 				admin: { condition: (_data, siblingData) => siblingData?.type !== "redirect" },
+				...richText?.editor ? { editor: richText.editor } : {},
 				...localizedIf(localizeContent)
 			},
 			{
 				name: "redirect",
 				type: "group",
 				label: labelForKey(keys.responseRedirect),
-				admin: { condition: (_data, siblingData) => siblingData?.type === "redirect" },
-				fields: [{
-					name: "url",
-					type: "text",
-					label: labelForKey(keys.responseUrl),
-					validate: validateUrl
-				}]
-			},
-			{
-				name: "submitLabel",
-				type: "text",
-				label: labelForKey(keys.responseSubmitLabel),
-				...localizedIf(localizeContent)
+				admin: {
+					condition: (_data, siblingData) => siblingData?.type === "redirect",
+					hideGutter: true
+				},
+				fields: redirectFields
 			}
 		]
 	};
-	const displayField = {
-		name: "display",
+	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: "showTitle",
-				type: "checkbox",
-				defaultValue: false,
-				label: labelForKey(keys.displayShowTitle)
+				name: "resultsField",
+				type: "text",
+				label: labelForKey(keys.pollResultsField),
+				validate: buildValidateResultsField(pollResultsTypes),
+				admin: { components: { Field: {
+					path: FIELD_NAME_SELECT_REF,
+					clientProps: {
+						types: pollResultsTypes,
+						descriptionKey: keys.pollResultsFieldDescription
+					}
+				} } }
 			},
 			{
-				name: "title",
-				type: "text",
-				label: labelForKey(keys.displayTitle),
-				admin: { condition: (_data, siblingData) => Boolean(siblingData?.showTitle) },
-				...localizedIf(localizeContent)
+				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: pollTypeOptionLabel(strategy.label),
+					value: strategy.type
+				}))
 			},
 			{
-				name: "intro",
-				type: "richText",
-				label: labelForKey(keys.displayIntro),
-				...localizedIf(localizeContent)
+				name: "resultsVisibility",
+				type: "select",
+				defaultValue: "afterVote",
+				label: labelForKey(keys.pollResultsVisibility),
+				admin: { isClearable: false },
+				options: [{
+					label: labelForKey(keys.pollVisibilityAfterVote),
+					value: "afterVote"
+				}, {
+					label: labelForKey(keys.pollVisibilityAfterClose),
+					value: "afterClose"
+				}]
+			},
+			{
+				name: "closesAt",
+				type: "date",
+				label: labelForKey(keys.pollClosesAt),
+				admin: { date: { pickerAppearance: "dayAndTime" } }
+			},
+			{
+				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]
 			}
 		]
 	};
@@ -210,23 +364,42 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 		{
 			name: "title",
 			type: "text",
-			required: true,
-			label: labelForKey(keys.fieldTitle)
+			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%" }
+			}]
 		},
 		{
 			type: "tabs",
 			tabs: [
 				{
 					label: labelForKey(keys.tabFields),
-					fields: [fieldsField]
+					fields: [fieldsField, submitField]
 				},
 				{
-					label: labelForKey(keys.tabDisplay),
-					fields: [displayField]
+					label: labelForKey(keys.tabFlow),
+					admin: { condition: (_data, siblingData) => siblingData?.multistep === true },
+					fields: [flowField, prevNextRow]
 				},
 				{
-					label: labelForKey(keys.tabFlow),
-					fields: [flowField]
+					label: labelForKey(keys.pollGroup),
+					admin: { condition: (_data, siblingData) => siblingData?.pollEnabled === true },
+					fields: [pollGroupField]
 				},
 				{
 					label: labelForKey(keys.tabActions),
@@ -237,99 +410,105 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 					fields: [responseField]
 				}
 			]
-		},
-		{
-			name: "poll",
-			type: "group",
-			label: labelForKey(keys.pollGroup),
-			admin: { position: "sidebar" },
-			fields: [
-				{
-					name: "enabled",
-					type: "checkbox",
-					defaultValue: false,
-					label: labelForKey(keys.pollEnabled)
-				},
-				{
-					name: "resultsField",
-					type: "text",
-					label: labelForKey(keys.pollResultsField),
-					admin: {
-						description: labelForKey(keys.pollResultsFieldDescription),
-						condition: (_data, siblingData) => Boolean(siblingData?.enabled)
-					}
-				},
-				{
-					name: "resultsVisibility",
-					type: "select",
-					defaultValue: "afterVote",
-					label: labelForKey(keys.pollResultsVisibility),
-					admin: {
-						isClearable: false,
-						condition: (_data, siblingData) => Boolean(siblingData?.enabled)
-					},
-					options: [{
-						label: labelForKey(keys.pollVisibilityAfterVote),
-						value: "afterVote"
-					}, {
-						label: labelForKey(keys.pollVisibilityAfterClose),
-						value: "afterClose"
-					}]
-				},
-				{
-					name: "closesAt",
-					type: "date",
-					label: labelForKey(keys.pollClosesAt),
-					admin: {
-						date: { pickerAppearance: "dayAndTime" },
-						condition: (_data, siblingData) => Boolean(siblingData?.enabled)
-					}
-				},
-				...buildPollOptionSourceFields(pollSourceRegistry ?? /* @__PURE__ */ new Map()),
-				{
-					name: "outcome",
-					type: "group",
-					label: labelForKey(keys.pollOutcome),
-					admin: { condition: (_data, siblingData) => Boolean(siblingData?.enabled) },
-					fields: [{
-						name: "winningValue",
-						type: "text",
-						label: labelForKey(keys.pollWinningValue),
-						admin: { readOnly: true },
-						access: {
-							create: () => false,
-							update: () => false
-						}
-					}, {
-						name: "resolvedAt",
-						type: "date",
-						label: labelForKey(keys.pollResolvedAt),
-						admin: { readOnly: true },
-						access: {
-							create: () => false,
-							update: () => false
-						}
-					}]
-				}
-			]
 		}
 	];
-	const defaultEndpoints = [{
-		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({
+	const consentAfterRead = consentSources ? async ({ doc, req }) => {
+		try {
+			const statements = await resolveConsentStatements({
 				payload: req.payload,
-				formId: req.routeParams?.id,
-				field,
-				isAuthed: Boolean(req.user),
 				req,
-				access: resultsAccess
+				form: doc,
+				sources: consentSources
 			});
-			return Response.json(body, { status });
+			if (Object.keys(statements).length > 0) doc.consentStatements = statements;
+		} catch (error) {
+			req.payload.logger?.warn(`form-builder consent afterRead: ${String(error)}`);
 		}
-	}];
+		return doc;
+	} : void 0;
+	const defaultEndpoints = [
+		{
+			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,
+					access: resultsAccess,
+					eligibleTypes: pollResultsTypes
+				});
+				return Response.json(body, { status });
+			}
+		},
+		{
+			path: "/:id/poll-options",
+			method: "get",
+			handler: async (req) => {
+				const { status, body } = await resolvePollOptionsRequest({
+					payload: req.payload,
+					formId: req.routeParams?.id,
+					isAuthed: Boolean(req.user),
+					req
+				});
+				return Response.json(body, { status });
+			}
+		},
+		{
+			path: "/:id/close",
+			method: "post",
+			handler: async (req) => {
+				const { status, body } = await resolvePollCloseRequest({
+					payload: req.payload,
+					formId: req.routeParams?.id,
+					isAuthed: Boolean(req.user),
+					req
+				});
+				return Response.json(body, { status });
+			}
+		},
+		...consentSources ? [{
+			path: "/:id/consent-sources",
+			method: "get",
+			handler: async (req) => {
+				const { status, body } = await resolveConsentSourcesRequest({
+					payload: req.payload,
+					formId: req.routeParams?.id,
+					isAuthed: Boolean(req.user),
+					req,
+					resolver: consentSources
+				});
+				return Response.json(body, { status });
+			}
+		}] : [],
+		...fromAddresses ? [{
+			path: "/:id/from-addresses",
+			method: "get",
+			handler: async (req) => {
+				const { status, body } = await resolveFromAddressesRequest({
+					isAuthed: Boolean(req.user),
+					req,
+					resolver: fromAddresses
+				});
+				return Response.json(body, { status });
+			}
+		}] : [],
+		...departments ? [{
+			path: "/:id/departments",
+			method: "get",
+			handler: async (req) => {
+				const { status, body } = await resolveDepartmentsRequest({
+					isAuthed: Boolean(req.user),
+					req,
+					resolver: departments
+				});
+				return Response.json(body, { status });
+			}
+		}] : []
+	];
 	return {
 		...overrides ?? {},
 		slug: FORMS_SLUG,
@@ -341,6 +520,13 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 		admin: {
 			group: "Forms",
 			useAsTitle: "title",
+			defaultColumns: [
+				"title",
+				"fields",
+				"flow",
+				"pollEnabled",
+				"updatedAt"
+			],
 			...overrides?.admin ?? {}
 		},
 		access: {
@@ -349,7 +535,10 @@ const buildFormsCollection = ({ overrides, registry, ruleRegistry, consentRegist
 		},
 		hooks: {
 			...overrides?.hooks ?? {},
-			beforeValidate: [beforeValidate, ...overrides?.hooks?.beforeValidate ?? []]
+			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