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

package/dist/recall/resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.js","names":[],"sources":["../../src/recall/resolver.ts"],"sourcesContent":["import type { AnyFormFieldDefinition } from '../fields/types'\nimport type { FormFieldInstance } from '../submissions/types'\n\nexport type RecallResolver = (name: string) => string\n\ntype Option = { label?: string; value?: string }\n\n/** Derive a value->label map from a select-like field instance's `options`. */\nexport const optionLabelsFor = (field: FormFieldInstance): Record<string, string> | undefined => {\n\tconst options = field.options\n\tif (!Array.isArray(options)) {\n\t\treturn undefined\n\t}\n\tconst map: Record<string, string> = {}\n\tfor (const option of options as Option[]) {\n\t\tif (option && typeof option.value === 'string') {\n\t\t\tmap[option.value] = option.label ?? option.value\n\t\t}\n\t}\n\treturn Object.keys(map).length > 0 ? map : undefined\n}\n\n/**\n * Build a recall resolver: `{{name}}` -> the field's current value, formatted via its type's `format`\n * (so a select shows its option label, a checkbox Yes/No, a date localized). Missing field or empty\n * value -> ''. Pure and isomorphic; the renderer and server templates share it.\n */\nexport const buildRecallResolver = (args: {\n\tfields: FormFieldInstance[]\n\tvalues: Record<string, unknown>\n\tregistry: Map<string, AnyFormFieldDefinition>\n\tlocale: string\n\tt: (key: string) => string\n}): RecallResolver => {\n\tconst byName = new Map(args.fields.map((field) => [field.name, field]))\n\treturn (name) => {\n\t\tconst field = byName.get(name)\n\t\tif (!field) {\n\t\t\treturn ''\n\t\t}\n\t\tconst value = args.values[name]\n\t\tif (value == null || value === '' || (Array.isArray(value) && value.length === 0)) {\n\t\t\treturn ''\n\t\t}\n\t\tconst definition = args.registry.get(field.blockType)\n\t\tif (definition?.format) {\n\t\t\treturn definition.format({\n\t\t\t\tvalue,\n\t\t\t\tconfig: {},\n\t\t\t\toptionLabels: optionLabelsFor(field),\n\t\t\t\tlocale: args.locale,\n\t\t\t\tt: args.t,\n\t\t\t})\n\t\t}\n\t\treturn Array.isArray(value) ? value.join(', ') : String(value)\n\t}\n}\n"],"mappings":";;AAQA,MAAa,mBAAmB,UAAiE;CAChG,MAAM,UAAU,MAAM;CACtB,IAAI,CAAC,MAAM,QAAQ,OAAO,GACzB;CAED,MAAM,MAA8B,CAAC;CACrC,KAAK,MAAM,UAAU,SACpB,IAAI,UAAU,OAAO,OAAO,UAAU,UACrC,IAAI,OAAO,SAAS,OAAO,SAAS,OAAO;CAG7C,OAAO,OAAO,KAAK,GAAG,EAAE,SAAS,IAAI,MAAM,KAAA;AAC5C;;;;;;AAOA,MAAa,uBAAuB,SAMd;CACrB,MAAM,SAAS,IAAI,IAAI,KAAK,OAAO,KAAK,UAAU,CAAC,MAAM,MAAM,KAAK,CAAC,CAAC;CACtE,QAAQ,SAAS;EAChB,MAAM,QAAQ,OAAO,IAAI,IAAI;EAC7B,IAAI,CAAC,OACJ,OAAO;EAER,MAAM,QAAQ,KAAK,OAAO;EAC1B,IAAI,SAAS,QAAQ,UAAU,MAAO,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,GAC9E,OAAO;EAER,MAAM,aAAa,KAAK,SAAS,IAAI,MAAM,SAAS;EACpD,IAAI,YAAY,QACf,OAAO,WAAW,OAAO;GACxB;GACA,QAAQ,CAAC;GACT,cAAc,gBAAgB,KAAK;GACnC,QAAQ,KAAK;GACb,GAAG,KAAK;EACT,CAAC;EAEF,OAAO,MAAM,QAAQ,KAAK,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,KAAK;CAC9D;AACD"}

package/dist/spam/captcha.d.ts

@@ -0,0 +1,12 @@
+import { CaptchaProvider } from "./types.js";
+
+//#region src/spam/captcha.d.ts
+/**
+ * Identity helper for authoring a captcha provider (mirrors `defineAction`/`defineConsentSource`).
+ * v1 ships no built-in provider; a project supplies one (Turnstile/reCAPTCHA/hCaptcha) and the submit
+ * path verifies a token carried on the submission. Prebuilt providers are a v1.x addition.
+ */
+declare const defineCaptchaProvider: (provider: CaptchaProvider) => CaptchaProvider;
+//#endregion
+export { defineCaptchaProvider };
+//# sourceMappingURL=captcha.d.ts.map

package/dist/spam/captcha.js

@@ -0,0 +1,11 @@
+//#region src/spam/captcha.ts
+/**
+* Identity helper for authoring a captcha provider (mirrors `defineAction`/`defineConsentSource`).
+* v1 ships no built-in provider; a project supplies one (Turnstile/reCAPTCHA/hCaptcha) and the submit
+* path verifies a token carried on the submission. Prebuilt providers are a v1.x addition.
+*/
+const defineCaptchaProvider = (provider) => provider;
+//#endregion
+export { defineCaptchaProvider };
+
+//# sourceMappingURL=captcha.js.map

package/dist/spam/captcha.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"captcha.js","names":[],"sources":["../../src/spam/captcha.ts"],"sourcesContent":["import type { CaptchaProvider } from './types'\n\n/**\n * Identity helper for authoring a captcha provider (mirrors `defineAction`/`defineConsentSource`).\n * v1 ships no built-in provider; a project supplies one (Turnstile/reCAPTCHA/hCaptcha) and the submit\n * path verifies a token carried on the submission. Prebuilt providers are a v1.x addition.\n */\nexport const defineCaptchaProvider = (provider: CaptchaProvider): CaptchaProvider => provider\n"],"mappings":";;;;;;AAOA,MAAa,yBAAyB,aAA+C"}

package/dist/spam/constants.d.ts

@@ -0,0 +1,12 @@
+//#region src/spam/constants.d.ts
+/**
+ * Default honeypot decoy field name. "website" is plausible to bots but doesn't trigger Chrome's
+ * email-address autofill (unlike names containing "email"). Bots fill every input; real users
+ * never see the hidden field.
+ */
+declare const DEFAULT_HONEYPOT_FIELD = "website";
+/** Reserved `values` entry carrying a captcha token from the client. */
+declare const CAPTCHA_TOKEN_KEY = "__fb_captcha";
+//#endregion
+export { CAPTCHA_TOKEN_KEY, DEFAULT_HONEYPOT_FIELD };
+//# sourceMappingURL=constants.d.ts.map

package/dist/spam/constants.js

@@ -0,0 +1,15 @@
+//#region src/spam/constants.ts
+/**
+* Default honeypot decoy field name. "website" is plausible to bots but doesn't trigger Chrome's
+* email-address autofill (unlike names containing "email"). Bots fill every input; real users
+* never see the hidden field.
+*/
+const DEFAULT_HONEYPOT_FIELD = "website";
+/** Reserved `values` entry carrying a captcha token from the client. */
+const CAPTCHA_TOKEN_KEY = "__fb_captcha";
+/** `req.context` key under which the spam guard stashes the resolved identity for upload-ownership verification. */
+const IDENTITY_CONTEXT_KEY = "formBuilderSpamIdentity";
+//#endregion
+export { CAPTCHA_TOKEN_KEY, DEFAULT_HONEYPOT_FIELD, IDENTITY_CONTEXT_KEY };
+
+//# sourceMappingURL=constants.js.map

package/dist/spam/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","names":[],"sources":["../../src/spam/constants.ts"],"sourcesContent":["/**\n * Default honeypot decoy field name. \"website\" is plausible to bots but doesn't trigger Chrome's\n * email-address autofill (unlike names containing \"email\"). Bots fill every input; real users\n * never see the hidden field.\n */\nexport const DEFAULT_HONEYPOT_FIELD = 'website'\n\n/** Reserved `values` entry carrying a captcha token from the client. */\nexport const CAPTCHA_TOKEN_KEY = '__fb_captcha'\n\n/** `req.context` key under which the spam guard stashes the resolved identity for upload-ownership verification. */\nexport const IDENTITY_CONTEXT_KEY = 'formBuilderSpamIdentity'\n"],"mappings":";;;;;;AAKA,MAAa,yBAAyB;;AAGtC,MAAa,oBAAoB;;AAGjC,MAAa,uBAAuB"}

package/dist/spam/identify.d.ts

@@ -0,0 +1,12 @@
+import { IdentifyFn } from "./types.js";
+
+//#region src/spam/identify.d.ts
+/**
+ * Default identity resolution for rate-limiting + upload ownership. Prefers an authenticated user id
+ * (trustworthy); else the first hop of the configured trusted IP header (best-effort, proxy-dependent);
+ * else null, in which case the caller fails open (cannot fairly rate-limit an unidentifiable client).
+ */
+declare const defaultIdentify: (ipHeader: string) => IdentifyFn;
+//#endregion
+export { defaultIdentify };
+//# sourceMappingURL=identify.d.ts.map

package/dist/spam/identify.js

@@ -0,0 +1,20 @@
+//#region src/spam/identify.ts
+/**
+* Default identity resolution for rate-limiting + upload ownership. Prefers an authenticated user id
+* (trustworthy); else the first hop of the configured trusted IP header (best-effort, proxy-dependent);
+* else null, in which case the caller fails open (cannot fairly rate-limit an unidentifiable client).
+*/
+const defaultIdentify = (ipHeader) => (req) => {
+	const userId = req.user?.id;
+	if (userId != null) return `user:${String(userId)}`;
+	const header = req.headers?.get(ipHeader);
+	if (header) {
+		const first = header.split(",")[0]?.trim();
+		if (first) return `ip:${first}`;
+	}
+	return null;
+};
+//#endregion
+export { defaultIdentify };
+
+//# sourceMappingURL=identify.js.map

package/dist/spam/identify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identify.js","names":[],"sources":["../../src/spam/identify.ts"],"sourcesContent":["import type { IdentifyFn } from './types'\n\n/**\n * Default identity resolution for rate-limiting + upload ownership. Prefers an authenticated user id\n * (trustworthy); else the first hop of the configured trusted IP header (best-effort, proxy-dependent);\n * else null, in which case the caller fails open (cannot fairly rate-limit an unidentifiable client).\n */\nexport const defaultIdentify =\n\t(ipHeader: string): IdentifyFn =>\n\t(req) => {\n\t\tconst userId = req.user?.id\n\t\tif (userId != null) {\n\t\t\treturn `user:${String(userId)}`\n\t\t}\n\t\tconst header = req.headers?.get(ipHeader)\n\t\tif (header) {\n\t\t\tconst first = header.split(',')[0]?.trim()\n\t\t\tif (first) {\n\t\t\t\treturn `ip:${first}`\n\t\t\t}\n\t\t}\n\t\treturn null\n\t}\n"],"mappings":";;;;;;AAOA,MAAa,mBACX,cACA,QAAQ;CACR,MAAM,SAAS,IAAI,MAAM;CACzB,IAAI,UAAU,MACb,OAAO,QAAQ,OAAO,MAAM;CAE7B,MAAM,SAAS,IAAI,SAAS,IAAI,QAAQ;CACxC,IAAI,QAAQ;EACX,MAAM,QAAQ,OAAO,MAAM,GAAG,EAAE,IAAI,KAAK;EACzC,IAAI,OACH,OAAO,MAAM;CAEf;CACA,OAAO;AACR"}

package/dist/spam/rateLimiter.d.ts

@@ -0,0 +1,18 @@
+import { RateLimiter } from "./types.js";
+
+//#region src/spam/rateLimiter.d.ts
+/**
+ * The default rate limiter: a read-modify-write window counter over Payload's `payload.kv`
+ * (always present; default `DatabaseKVAdapter`, durable + cross-instance). Because the KV interface
+ * has no atomic increment, the get-then-set is NON-ATOMIC, so a concurrent burst can slightly undercount.
+ * This is a SOFT limit, acceptable for spam basics and complemented by edge/WAF limiting. The window
+ * expires lazily on read; stale keys for one-time identities linger (minor; the count self-resets).
+ * `now` is injectable for tests.
+ */
+declare const createKvRateLimiter: (options?: {
+  now?: () => number;
+  namespace?: string;
+}) => RateLimiter;
+//#endregion
+export { createKvRateLimiter };
+//# sourceMappingURL=rateLimiter.d.ts.map

package/dist/spam/rateLimiter.js

@@ -0,0 +1,41 @@
+//#region src/spam/rateLimiter.ts
+/**
+* The default rate limiter: a read-modify-write window counter over Payload's `payload.kv`
+* (always present; default `DatabaseKVAdapter`, durable + cross-instance). Because the KV interface
+* has no atomic increment, the get-then-set is NON-ATOMIC, so a concurrent burst can slightly undercount.
+* This is a SOFT limit, acceptable for spam basics and complemented by edge/WAF limiting. The window
+* expires lazily on read; stale keys for one-time identities linger (minor; the count self-resets).
+* `now` is injectable for tests.
+*/
+const createKvRateLimiter = (options = {}) => {
+	const now = options.now ?? (() => Date.now());
+	const prefix = options.namespace ?? "fb:rl:";
+	return { async check({ key, max, window, req }) {
+		const kv = req.payload.kv;
+		const storeKey = `${prefix}${key}`;
+		const current = now();
+		const existing = await kv.get(storeKey).catch(() => null);
+		let count;
+		let windowStart;
+		if (!existing || current - existing.windowStart >= window) {
+			count = 1;
+			windowStart = current;
+		} else {
+			count = existing.count + 1;
+			windowStart = existing.windowStart;
+		}
+		await kv.set(storeKey, {
+			count,
+			windowStart
+		}).catch(() => void 0);
+		return {
+			ok: count <= max,
+			remaining: Math.max(0, max - count),
+			resetAt: windowStart + window
+		};
+	} };
+};
+//#endregion
+export { createKvRateLimiter };
+
+//# sourceMappingURL=rateLimiter.js.map

package/dist/spam/rateLimiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateLimiter.js","names":[],"sources":["../../src/spam/rateLimiter.ts"],"sourcesContent":["import type { RateLimiter } from './types'\n\ntype WindowState = { count: number; windowStart: number }\n\n/**\n * The default rate limiter: a read-modify-write window counter over Payload's `payload.kv`\n * (always present; default `DatabaseKVAdapter`, durable + cross-instance). Because the KV interface\n * has no atomic increment, the get-then-set is NON-ATOMIC, so a concurrent burst can slightly undercount.\n * This is a SOFT limit, acceptable for spam basics and complemented by edge/WAF limiting. The window\n * expires lazily on read; stale keys for one-time identities linger (minor; the count self-resets).\n * `now` is injectable for tests.\n */\nexport const createKvRateLimiter = (\n\toptions: { now?: () => number; namespace?: string } = {}\n): RateLimiter => {\n\tconst now = options.now ?? (() => Date.now())\n\tconst prefix = options.namespace ?? 'fb:rl:'\n\treturn {\n\t\tasync check({ key, max, window, req }) {\n\t\t\tconst kv = req.payload.kv\n\t\t\tconst storeKey = `${prefix}${key}`\n\t\t\tconst current = now()\n\t\t\tconst existing = await kv.get<WindowState>(storeKey).catch(() => null)\n\t\t\tlet count: number\n\t\t\tlet windowStart: number\n\t\t\tif (!existing || current - existing.windowStart >= window) {\n\t\t\t\tcount = 1\n\t\t\t\twindowStart = current\n\t\t\t} else {\n\t\t\t\tcount = existing.count + 1\n\t\t\t\twindowStart = existing.windowStart\n\t\t\t}\n\t\t\tawait kv.set(storeKey, { count, windowStart }).catch(() => undefined)\n\t\t\treturn {\n\t\t\t\tok: count <= max,\n\t\t\t\tremaining: Math.max(0, max - count),\n\t\t\t\tresetAt: windowStart + window,\n\t\t\t}\n\t\t},\n\t}\n}\n"],"mappings":";;;;;;;;;AAYA,MAAa,uBACZ,UAAsD,CAAC,MACtC;CACjB,MAAM,MAAM,QAAQ,cAAc,KAAK,IAAI;CAC3C,MAAM,SAAS,QAAQ,aAAa;CACpC,OAAO,EACN,MAAM,MAAM,EAAE,KAAK,KAAK,QAAQ,OAAO;EACtC,MAAM,KAAK,IAAI,QAAQ;EACvB,MAAM,WAAW,GAAG,SAAS;EAC7B,MAAM,UAAU,IAAI;EACpB,MAAM,WAAW,MAAM,GAAG,IAAiB,QAAQ,EAAE,YAAY,IAAI;EACrE,IAAI;EACJ,IAAI;EACJ,IAAI,CAAC,YAAY,UAAU,SAAS,eAAe,QAAQ;GAC1D,QAAQ;GACR,cAAc;EACf,OAAO;GACN,QAAQ,SAAS,QAAQ;GACzB,cAAc,SAAS;EACxB;EACA,MAAM,GAAG,IAAI,UAAU;GAAE;GAAO;EAAY,CAAC,EAAE,YAAY,KAAA,CAAS;EACpE,OAAO;GACN,IAAI,SAAS;GACb,WAAW,KAAK,IAAI,GAAG,MAAM,KAAK;GAClC,SAAS,cAAc;EACxB;CACD,EACD;AACD"}

package/dist/spam/reserved.js

@@ -0,0 +1,30 @@
+import "./constants.js";
+//#region src/spam/reserved.ts
+/**
+* Split reserved entries (honeypot decoy, captcha token) out of the submitted `values`. The honeypot
+* rides a configurable, innocuous field name; the captcha token rides a fixed reserved key. Real field
+* values pass through unchanged. `runSubmission` would already ignore unknown field names, but stripping
+* here keeps them out of storage and out of the validation pass.
+*/
+const extractReservedValues = (values, honeypotField) => {
+	const cleaned = [];
+	const result = { cleaned };
+	for (const entry of values) {
+		if (entry.field === "__fb_captcha") {
+			if (typeof entry.value === "string") result.captchaToken = entry.value;
+			continue;
+		}
+		if (honeypotField !== null && entry.field === honeypotField) {
+			result.honeypot = entry.value;
+			continue;
+		}
+		cleaned.push(entry);
+	}
+	return result;
+};
+/** A honeypot is tripped when the decoy carries any non-empty value (a real user never fills it). */
+const isHoneypotTripped = (value) => value != null && value !== "" && !(Array.isArray(value) && value.length === 0);
+//#endregion
+export { extractReservedValues, isHoneypotTripped };
+
+//# sourceMappingURL=reserved.js.map

package/dist/spam/reserved.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reserved.js","names":[],"sources":["../../src/spam/reserved.ts"],"sourcesContent":["import type { SubmissionValue } from '../submissions/types'\nimport { CAPTCHA_TOKEN_KEY } from './constants'\n\nexport type ExtractedReserved = {\n\t/** Real field values with reserved entries removed. */\n\tcleaned: SubmissionValue[]\n\t/** The honeypot decoy value, if a honeypot field name was active and present. */\n\thoneypot?: unknown\n\t/** A captcha token carried by the client. */\n\tcaptchaToken?: string\n}\n\n/**\n * Split reserved entries (honeypot decoy, captcha token) out of the submitted `values`. The honeypot\n * rides a configurable, innocuous field name; the captcha token rides a fixed reserved key. Real field\n * values pass through unchanged. `runSubmission` would already ignore unknown field names, but stripping\n * here keeps them out of storage and out of the validation pass.\n */\nexport const extractReservedValues = (\n\tvalues: SubmissionValue[],\n\thoneypotField: string | null\n): ExtractedReserved => {\n\tconst cleaned: SubmissionValue[] = []\n\tconst result: ExtractedReserved = { cleaned }\n\tfor (const entry of values) {\n\t\tif (entry.field === CAPTCHA_TOKEN_KEY) {\n\t\t\tif (typeof entry.value === 'string') {\n\t\t\t\tresult.captchaToken = entry.value\n\t\t\t}\n\t\t\tcontinue\n\t\t}\n\t\tif (honeypotField !== null && entry.field === honeypotField) {\n\t\t\tresult.honeypot = entry.value\n\t\t\tcontinue\n\t\t}\n\t\tcleaned.push(entry)\n\t}\n\treturn result\n}\n\n/** A honeypot is tripped when the decoy carries any non-empty value (a real user never fills it). */\nexport const isHoneypotTripped = (value: unknown): boolean =>\n\tvalue != null && value !== '' && !(Array.isArray(value) && value.length === 0)\n"],"mappings":";;;;;;;;AAkBA,MAAa,yBACZ,QACA,kBACuB;CACvB,MAAM,UAA6B,CAAC;CACpC,MAAM,SAA4B,EAAE,QAAQ;CAC5C,KAAK,MAAM,SAAS,QAAQ;EAC3B,IAAI,MAAM,UAAA,gBAA6B;GACtC,IAAI,OAAO,MAAM,UAAU,UAC1B,OAAO,eAAe,MAAM;GAE7B;EACD;EACA,IAAI,kBAAkB,QAAQ,MAAM,UAAU,eAAe;GAC5D,OAAO,WAAW,MAAM;GACxB;EACD;EACA,QAAQ,KAAK,KAAK;CACnB;CACA,OAAO;AACR;;AAGA,MAAa,qBAAqB,UACjC,SAAS,QAAQ,UAAU,MAAM,EAAE,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW"}

package/dist/spam/resolveSpam.d.ts

@@ -0,0 +1,12 @@
+import { ResolvedSpamConfig, SpamOption } from "./types.js";
+
+//#region src/spam/resolveSpam.d.ts
+/**
+ * Resolve the `spam` plugin option into a concrete config. `false` disables the whole subsystem.
+ * Otherwise honeypot + both rate limits default on, captcha + metadata capture default off, and the
+ * identity seam defaults to user id / trusted IP header.
+ */
+declare const resolveSpamConfig: (option: SpamOption | undefined) => ResolvedSpamConfig | false;
+//#endregion
+export { resolveSpamConfig };
+//# sourceMappingURL=resolveSpam.d.ts.map

package/dist/spam/resolveSpam.js

@@ -0,0 +1,42 @@
+import "./constants.js";
+import { defaultIdentify } from "./identify.js";
+import { createKvRateLimiter } from "./rateLimiter.js";
+//#region src/spam/resolveSpam.ts
+const DEFAULT_WINDOW = 6e4;
+const DEFAULT_SUBMISSION_MAX = 5;
+const DEFAULT_UPLOAD_MAX = 20;
+const resolveRateLimit = (option, defaultMax) => {
+	if (option === false) return false;
+	const cfg = option ?? {};
+	return {
+		window: cfg.window ?? DEFAULT_WINDOW,
+		max: cfg.max ?? defaultMax,
+		limiter: cfg.limiter ?? createKvRateLimiter()
+	};
+};
+/**
+* Resolve the `spam` plugin option into a concrete config. `false` disables the whole subsystem.
+* Otherwise honeypot + both rate limits default on, captcha + metadata capture default off, and the
+* identity seam defaults to user id / trusted IP header.
+*/
+const resolveSpamConfig = (option) => {
+	if (option === false) return false;
+	const cfg = option ?? {};
+	const ipHeader = cfg.ipHeader ?? "x-forwarded-for";
+	return {
+		honeypot: cfg.honeypot === false ? false : { fieldName: cfg.honeypot?.fieldName ?? "website" },
+		rateLimit: resolveRateLimit(cfg.rateLimit, DEFAULT_SUBMISSION_MAX),
+		uploadRateLimit: resolveRateLimit(cfg.uploadRateLimit, DEFAULT_UPLOAD_MAX),
+		captcha: cfg.captcha,
+		identify: cfg.identify ?? defaultIdentify(ipHeader),
+		ipHeader,
+		metadata: {
+			ip: cfg.metadata?.ip ?? false,
+			ua: cfg.metadata?.ua ?? false
+		}
+	};
+};
+//#endregion
+export { resolveSpamConfig };
+
+//# sourceMappingURL=resolveSpam.js.map

package/dist/spam/resolveSpam.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveSpam.js","names":[],"sources":["../../src/spam/resolveSpam.ts"],"sourcesContent":["import { DEFAULT_HONEYPOT_FIELD } from './constants'\nimport { defaultIdentify } from './identify'\nimport { createKvRateLimiter } from './rateLimiter'\nimport type {\n\tRateLimitConfig,\n\tResolvedRateLimit,\n\tResolvedSpamConfig,\n\tSpamConfig,\n\tSpamOption,\n} from './types'\n\nconst DEFAULT_WINDOW = 60_000\nconst DEFAULT_SUBMISSION_MAX = 5\nconst DEFAULT_UPLOAD_MAX = 20\n\nconst resolveRateLimit = (\n\toption: false | RateLimitConfig | undefined,\n\tdefaultMax: number\n): false | ResolvedRateLimit => {\n\tif (option === false) {\n\t\treturn false\n\t}\n\tconst cfg = option ?? {}\n\treturn {\n\t\twindow: cfg.window ?? DEFAULT_WINDOW,\n\t\tmax: cfg.max ?? defaultMax,\n\t\tlimiter: cfg.limiter ?? createKvRateLimiter(),\n\t}\n}\n\n/**\n * Resolve the `spam` plugin option into a concrete config. `false` disables the whole subsystem.\n * Otherwise honeypot + both rate limits default on, captcha + metadata capture default off, and the\n * identity seam defaults to user id / trusted IP header.\n */\nexport const resolveSpamConfig = (option: SpamOption | undefined): ResolvedSpamConfig | false => {\n\tif (option === false) {\n\t\treturn false\n\t}\n\tconst cfg: SpamConfig = option ?? {}\n\tconst ipHeader = cfg.ipHeader ?? 'x-forwarded-for'\n\treturn {\n\t\thoneypot:\n\t\t\tcfg.honeypot === false\n\t\t\t\t? false\n\t\t\t\t: { fieldName: cfg.honeypot?.fieldName ?? DEFAULT_HONEYPOT_FIELD },\n\t\trateLimit: resolveRateLimit(cfg.rateLimit, DEFAULT_SUBMISSION_MAX),\n\t\tuploadRateLimit: resolveRateLimit(cfg.uploadRateLimit, DEFAULT_UPLOAD_MAX),\n\t\tcaptcha: cfg.captcha,\n\t\tidentify: cfg.identify ?? defaultIdentify(ipHeader),\n\t\tipHeader,\n\t\tmetadata: { ip: cfg.metadata?.ip ?? false, ua: cfg.metadata?.ua ?? false },\n\t}\n}\n"],"mappings":";;;;AAWA,MAAM,iBAAiB;AACvB,MAAM,yBAAyB;AAC/B,MAAM,qBAAqB;AAE3B,MAAM,oBACL,QACA,eAC+B;CAC/B,IAAI,WAAW,OACd,OAAO;CAER,MAAM,MAAM,UAAU,CAAC;CACvB,OAAO;EACN,QAAQ,IAAI,UAAU;EACtB,KAAK,IAAI,OAAO;EAChB,SAAS,IAAI,WAAW,oBAAoB;CAC7C;AACD;;;;;;AAOA,MAAa,qBAAqB,WAA+D;CAChG,IAAI,WAAW,OACd,OAAO;CAER,MAAM,MAAkB,UAAU,CAAC;CACnC,MAAM,WAAW,IAAI,YAAY;CACjC,OAAO;EACN,UACC,IAAI,aAAa,QACd,QACA,EAAE,WAAW,IAAI,UAAU,aAAA,UAAoC;EACnE,WAAW,iBAAiB,IAAI,WAAW,sBAAsB;EACjE,iBAAiB,iBAAiB,IAAI,iBAAiB,kBAAkB;EACzE,SAAS,IAAI;EACb,UAAU,IAAI,YAAY,gBAAgB,QAAQ;EAClD;EACA,UAAU;GAAE,IAAI,IAAI,UAAU,MAAM;GAAO,IAAI,IAAI,UAAU,MAAM;EAAM;CAC1E;AACD"}

package/dist/spam/spamGuard.js

@@ -0,0 +1,68 @@
+import { keys } from "../translations/keys.js";
+import { asTranslate } from "../translations/server.js";
+import { IDENTITY_CONTEXT_KEY } from "./constants.js";
+import { extractReservedValues, isHoneypotTripped } from "./reserved.js";
+import { APIError } from "payload";
+//#region src/spam/spamGuard.ts
+const firstHop = (req, header) => {
+	const raw = req.headers?.get(header);
+	return raw ? raw.split(",")[0]?.trim() ?? void 0 : void 0;
+};
+/**
+* Submissions spam guard, prepended before `validateSubmission` in `beforeValidate` so it rejects before
+* the form load + field validation. On create it: resolves the request identity once (stashing it on
+* `req.context` for upload-ownership verification downstream); rate-limits per form + identity (429,
+* fail-open when identity is null); strips reserved `values` entries (honeypot, captcha token); rejects a
+* filled honeypot with a generic error; verifies a configured captcha; and writes a server-authoritative
+* `meta` (timestamp + spam signal, with opt-in ip/ua). App-level rate limiting is defense-in-depth that
+* complements edge/CDN/WAF limiting, not a DoS replacement.
+*/
+const buildSpamGuard = (spam) => async ({ data, operation, req }) => {
+	if (operation !== "create" || !data) return data;
+	const t = asTranslate(req.i18n.t);
+	const authenticated = Boolean(req.user);
+	const identity = await spam.identify(req);
+	if (identity != null) req.context[IDENTITY_CONTEXT_KEY] = identity;
+	if (spam.rateLimit !== false && identity != null) {
+		const formKey = data.form != null ? String(data.form) : "unknown";
+		const { ok } = await spam.rateLimit.limiter.check({
+			key: `submissions:${formKey}:${identity}`,
+			max: spam.rateLimit.max,
+			window: spam.rateLimit.window,
+			req
+		});
+		if (!ok) throw new APIError(t(keys.spamRateLimited), 429);
+	}
+	const honeypotField = spam.honeypot === false ? null : spam.honeypot.fieldName;
+	const { cleaned, honeypot, captchaToken } = extractReservedValues(data.values ?? [], honeypotField);
+	data.values = cleaned;
+	if (!authenticated && honeypotField !== null && isHoneypotTripped(honeypot)) throw new APIError(t(keys.spamRejected), 400);
+	const captchaChecked = Boolean(spam.captcha) && !authenticated;
+	if (spam.captcha && !authenticated) {
+		if (!(typeof captchaToken === "string" && captchaToken.length > 0 ? await spam.captcha.verify({
+			token: captchaToken,
+			req
+		}).catch(() => false) : false)) throw new APIError(t(keys.spamCaptchaFailed), 400);
+	}
+	const serverMeta = {
+		at: (/* @__PURE__ */ new Date()).toISOString(),
+		spam: { captcha: captchaChecked ? "passed" : "skipped" }
+	};
+	if (spam.metadata.ip) {
+		const ip = firstHop(req, spam.ipHeader);
+		if (ip) serverMeta.ip = ip;
+	}
+	if (spam.metadata.ua) {
+		const ua = req.headers?.get("user-agent");
+		if (ua) serverMeta.ua = ua;
+	}
+	data.meta = {
+		...authenticated && data.meta != null && typeof data.meta === "object" ? data.meta : {},
+		...serverMeta
+	};
+	return data;
+};
+//#endregion
+export { buildSpamGuard };
+
+//# sourceMappingURL=spamGuard.js.map

package/dist/spam/spamGuard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spamGuard.js","names":[],"sources":["../../src/spam/spamGuard.ts"],"sourcesContent":["import { APIError, type CollectionBeforeValidateHook } from 'payload'\nimport type { SubmissionValue } from '../submissions/types'\nimport { keys } from '../translations/keys'\nimport { asTranslate } from '../translations/server'\nimport { IDENTITY_CONTEXT_KEY } from './constants'\nimport { extractReservedValues, isHoneypotTripped } from './reserved'\nimport type { ResolvedSpamConfig } from './types'\n\nconst firstHop = (req: { headers?: Headers }, header: string): string | undefined => {\n\tconst raw = req.headers?.get(header)\n\treturn raw ? (raw.split(',')[0]?.trim() ?? undefined) : undefined\n}\n\n/**\n * Submissions spam guard, prepended before `validateSubmission` in `beforeValidate` so it rejects before\n * the form load + field validation. On create it: resolves the request identity once (stashing it on\n * `req.context` for upload-ownership verification downstream); rate-limits per form + identity (429,\n * fail-open when identity is null); strips reserved `values` entries (honeypot, captcha token); rejects a\n * filled honeypot with a generic error; verifies a configured captcha; and writes a server-authoritative\n * `meta` (timestamp + spam signal, with opt-in ip/ua). App-level rate limiting is defense-in-depth that\n * complements edge/CDN/WAF limiting, not a DoS replacement.\n */\nexport const buildSpamGuard =\n\t(spam: ResolvedSpamConfig): CollectionBeforeValidateHook =>\n\tasync ({ data, operation, req }) => {\n\t\tif (operation !== 'create' || !data) {\n\t\t\treturn data\n\t\t}\n\t\tconst t = asTranslate(req.i18n.t)\n\t\t// Honeypot + captcha are anti-bot measures for the anonymous public path; an authenticated request\n\t\t// (admin panel, logged-in API client) is already gated by auth and never carries a decoy/token, so\n\t\t// checking it would falsely reject legitimate authed creates. Rate-limit + ownership still apply.\n\t\tconst authenticated = Boolean(req.user)\n\n\t\tconst identity = await spam.identify(req)\n\t\tif (identity != null) {\n\t\t\treq.context[IDENTITY_CONTEXT_KEY] = identity\n\t\t}\n\n\t\tif (spam.rateLimit !== false && identity != null) {\n\t\t\tconst formKey = data.form != null ? String(data.form) : 'unknown'\n\t\t\tconst { ok } = await spam.rateLimit.limiter.check({\n\t\t\t\tkey: `submissions:${formKey}:${identity}`,\n\t\t\t\tmax: spam.rateLimit.max,\n\t\t\t\twindow: spam.rateLimit.window,\n\t\t\t\treq,\n\t\t\t})\n\t\t\tif (!ok) {\n\t\t\t\tthrow new APIError(t(keys.spamRateLimited), 429)\n\t\t\t}\n\t\t}\n\n\t\tconst honeypotField = spam.honeypot === false ? null : spam.honeypot.fieldName\n\t\tconst values = (data.values as SubmissionValue[] | undefined) ?? []\n\t\tconst { cleaned, honeypot, captchaToken } = extractReservedValues(values, honeypotField)\n\t\tdata.values = cleaned\n\n\t\tif (!authenticated && honeypotField !== null && isHoneypotTripped(honeypot)) {\n\t\t\tthrow new APIError(t(keys.spamRejected), 400)\n\t\t}\n\n\t\tconst captchaChecked = Boolean(spam.captcha) && !authenticated\n\t\tif (spam.captcha && !authenticated) {\n\t\t\tconst passed =\n\t\t\t\ttypeof captchaToken === 'string' && captchaToken.length > 0\n\t\t\t\t\t? await spam.captcha.verify({ token: captchaToken, req }).catch(() => false)\n\t\t\t\t\t: false\n\t\t\tif (!passed) {\n\t\t\t\tthrow new APIError(t(keys.spamCaptchaFailed), 400)\n\t\t\t}\n\t\t}\n\n\t\tconst serverMeta: Record<string, unknown> = {\n\t\t\tat: new Date().toISOString(),\n\t\t\tspam: { captcha: captchaChecked ? 'passed' : 'skipped' },\n\t\t}\n\t\tif (spam.metadata.ip) {\n\t\t\tconst ip = firstHop(req, spam.ipHeader)\n\t\t\tif (ip) {\n\t\t\t\tserverMeta.ip = ip\n\t\t\t}\n\t\t}\n\t\tif (spam.metadata.ua) {\n\t\t\tconst ua = req.headers?.get('user-agent')\n\t\t\tif (ua) {\n\t\t\t\tserverMeta.ua = ua\n\t\t\t}\n\t\t}\n\t\t// Preserve an authenticated (trusted) caller's own `meta` keys, with server fields winning. Anonymous\n\t\t// `meta` is never trusted, so it is discarded.\n\t\tconst clientMeta =\n\t\t\tauthenticated && data.meta != null && typeof data.meta === 'object'\n\t\t\t\t? (data.meta as Record<string, unknown>)\n\t\t\t\t: {}\n\t\tdata.meta = { ...clientMeta, ...serverMeta }\n\n\t\treturn data\n\t}\n"],"mappings":";;;;;;AAQA,MAAM,YAAY,KAA4B,WAAuC;CACpF,MAAM,MAAM,IAAI,SAAS,IAAI,MAAM;CACnC,OAAO,MAAO,IAAI,MAAM,GAAG,EAAE,IAAI,KAAK,KAAK,KAAA,IAAa,KAAA;AACzD;;;;;;;;;;AAWA,MAAa,kBACX,SACD,OAAO,EAAE,MAAM,WAAW,UAAU;CACnC,IAAI,cAAc,YAAY,CAAC,MAC9B,OAAO;CAER,MAAM,IAAI,YAAY,IAAI,KAAK,CAAC;CAIhC,MAAM,gBAAgB,QAAQ,IAAI,IAAI;CAEtC,MAAM,WAAW,MAAM,KAAK,SAAS,GAAG;CACxC,IAAI,YAAY,MACf,IAAI,QAAQ,wBAAwB;CAGrC,IAAI,KAAK,cAAc,SAAS,YAAY,MAAM;EACjD,MAAM,UAAU,KAAK,QAAQ,OAAO,OAAO,KAAK,IAAI,IAAI;EACxD,MAAM,EAAE,OAAO,MAAM,KAAK,UAAU,QAAQ,MAAM;GACjD,KAAK,eAAe,QAAQ,GAAG;GAC/B,KAAK,KAAK,UAAU;GACpB,QAAQ,KAAK,UAAU;GACvB;EACD,CAAC;EACD,IAAI,CAAC,IACJ,MAAM,IAAI,SAAS,EAAE,KAAK,eAAe,GAAG,GAAG;CAEjD;CAEA,MAAM,gBAAgB,KAAK,aAAa,QAAQ,OAAO,KAAK,SAAS;CAErE,MAAM,EAAE,SAAS,UAAU,iBAAiB,sBAD5B,KAAK,UAA4C,CAAC,GACQ,aAAa;CACvF,KAAK,SAAS;CAEd,IAAI,CAAC,iBAAiB,kBAAkB,QAAQ,kBAAkB,QAAQ,GACzE,MAAM,IAAI,SAAS,EAAE,KAAK,YAAY,GAAG,GAAG;CAG7C,MAAM,iBAAiB,QAAQ,KAAK,OAAO,KAAK,CAAC;CACjD,IAAI,KAAK,WAAW,CAAC;MAKhB,EAHH,OAAO,iBAAiB,YAAY,aAAa,SAAS,IACvD,MAAM,KAAK,QAAQ,OAAO;GAAE,OAAO;GAAc;EAAI,CAAC,EAAE,YAAY,KAAK,IACzE,QAEH,MAAM,IAAI,SAAS,EAAE,KAAK,iBAAiB,GAAG,GAAG;CAAA;CAInD,MAAM,aAAsC;EAC3C,qBAAI,IAAI,KAAK,GAAE,YAAY;EAC3B,MAAM,EAAE,SAAS,iBAAiB,WAAW,UAAU;CACxD;CACA,IAAI,KAAK,SAAS,IAAI;EACrB,MAAM,KAAK,SAAS,KAAK,KAAK,QAAQ;EACtC,IAAI,IACH,WAAW,KAAK;CAElB;CACA,IAAI,KAAK,SAAS,IAAI;EACrB,MAAM,KAAK,IAAI,SAAS,IAAI,YAAY;EACxC,IAAI,IACH,WAAW,KAAK;CAElB;CAOA,KAAK,OAAO;EAAE,GAHb,iBAAiB,KAAK,QAAQ,QAAQ,OAAO,KAAK,SAAS,WACvD,KAAK,OACN,CAAC;EACwB,GAAG;CAAW;CAE3C,OAAO;AACR"}

package/dist/spam/types.d.ts

@@ -0,0 +1,73 @@
+import { PayloadRequest } from "payload";
+
+//#region src/spam/types.d.ts
+/** Stable identity key for a request, or null/undefined when the client cannot be identified (rate-limiting then skips: fail-open). */
+type IdentifyFn = (req: PayloadRequest) => null | string | undefined | Promise<null | string | undefined>;
+type RateLimitResult = {
+  ok: boolean; /** Remaining requests in the current window (>= 0). */
+  remaining: number; /** Epoch ms when the current window resets. */
+  resetAt: number;
+};
+type RateLimitCheckArgs = {
+  key: string; /** Max requests per window. */
+  max: number; /** Window length in ms. */
+  window: number;
+  req: PayloadRequest;
+};
+/** Pluggable limiter. The default is a window counter over `payload.kv`; swap for Redis/etc. */
+type RateLimiter = {
+  check(args: RateLimitCheckArgs): Promise<RateLimitResult>;
+};
+type CaptchaVerifyArgs = {
+  token: string;
+  req: PayloadRequest;
+};
+/** A captcha adapter. v1 ships the seam only (no built-in provider). Build with `defineCaptchaProvider`. */
+type CaptchaProvider = {
+  type: string;
+  verify(args: CaptchaVerifyArgs): Promise<boolean>;
+};
+type RateLimitConfig = {
+  /** Window length in ms. Default 60000. */window?: number; /** Max creates per identity per window. */
+  max?: number; /** Override the limiter (default: KV window counter). */
+  limiter?: RateLimiter;
+};
+type SpamMetadataConfig = {
+  /** Persist the client IP (from the trusted header) onto the submission `meta`. Default false (privacy). */ip?: boolean; /** Persist the user-agent onto the submission `meta`. Default false. */
+  ua?: boolean;
+};
+type SpamConfig = {
+  /** Honeypot decoy. Default on. `false` disables. */honeypot?: false | {
+    fieldName?: string;
+  }; /** Per-identity rate limit on submission create. Default on (60s window, max 5). `false` disables. */
+  rateLimit?: false | RateLimitConfig; /** Per-identity rate limit on upload create. Default on (60s window, max 20). `false` disables. */
+  uploadRateLimit?: false | RateLimitConfig; /** A captcha provider (none by default; seam only in v1). */
+  captcha?: CaptchaProvider; /** Identity resolution for rate-limiting, upload ownership, and (future) poll dedup. Default: user id, else trusted IP header. */
+  identify?: IdentifyFn; /** Header read for the client IP (proxy-dependent, best-effort). Default 'x-forwarded-for'. */
+  ipHeader?: string; /** Opt-in capture of client metadata onto the submission `meta`. Off by default. */
+  metadata?: SpamMetadataConfig;
+};
+/** `false` disables the whole subsystem; an object configures it (all controls default on except captcha + metadata). */
+type SpamOption = false | SpamConfig;
+type ResolvedRateLimit = {
+  window: number;
+  max: number;
+  limiter: RateLimiter;
+};
+type ResolvedSpamConfig = {
+  honeypot: false | {
+    fieldName: string;
+  };
+  rateLimit: false | ResolvedRateLimit;
+  uploadRateLimit: false | ResolvedRateLimit;
+  captcha?: CaptchaProvider;
+  identify: IdentifyFn;
+  ipHeader: string;
+  metadata: {
+    ip: boolean;
+    ua: boolean;
+  };
+};
+//#endregion
+export { CaptchaProvider, CaptchaVerifyArgs, IdentifyFn, RateLimitCheckArgs, RateLimitConfig, RateLimitResult, RateLimiter, ResolvedSpamConfig, SpamConfig, SpamMetadataConfig, SpamOption };
+//# sourceMappingURL=types.d.ts.map

package/dist/spam/uploadHooks.js

@@ -0,0 +1,33 @@
+import { keys } from "../translations/keys.js";
+import { asTranslate } from "../translations/server.js";
+import { APIError } from "payload";
+//#region src/spam/uploadHooks.ts
+/**
+* Stamp the resolved request identity onto a new upload's `owner`. `captureFileRef` later requires the
+* referencing submission's identity to match, so an anonymous submitter cannot capture another identity's
+* upload. No identity (no user, no trusted IP header) means no stamp, so the upload stays unscoped (a
+* deliberate fail-open; identity granularity is IP-level, so same-network clients share scope -- documented).
+*/
+const buildUploadOwnerStamp = (spam) => async ({ data, operation, req }) => {
+	if (operation !== "create" || !data) return data;
+	const identity = await spam.identify(req);
+	if (identity != null && data.owner == null) data.owner = identity;
+	return data;
+};
+/** Reject upload floods per identity before the file is written to `staticDir`. Fail-open without identity. */
+const buildUploadRateLimit = (spam) => async ({ operation, req }) => {
+	if (operation !== "create" || spam.uploadRateLimit === false) return;
+	const identity = await spam.identify(req);
+	if (identity == null) return;
+	const { ok } = await spam.uploadRateLimit.limiter.check({
+		key: `uploads:${identity}`,
+		max: spam.uploadRateLimit.max,
+		window: spam.uploadRateLimit.window,
+		req
+	});
+	if (!ok) throw new APIError(asTranslate(req.i18n.t)(keys.spamRateLimited), 429);
+};
+//#endregion
+export { buildUploadOwnerStamp, buildUploadRateLimit };
+
+//# sourceMappingURL=uploadHooks.js.map

package/dist/spam/uploadHooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadHooks.js","names":[],"sources":["../../src/spam/uploadHooks.ts"],"sourcesContent":["import {\n\tAPIError,\n\ttype CollectionBeforeOperationHook,\n\ttype CollectionBeforeValidateHook,\n} from 'payload'\nimport { keys } from '../translations/keys'\nimport { asTranslate } from '../translations/server'\nimport type { ResolvedSpamConfig } from './types'\n\n/**\n * Stamp the resolved request identity onto a new upload's `owner`. `captureFileRef` later requires the\n * referencing submission's identity to match, so an anonymous submitter cannot capture another identity's\n * upload. No identity (no user, no trusted IP header) means no stamp, so the upload stays unscoped (a\n * deliberate fail-open; identity granularity is IP-level, so same-network clients share scope -- documented).\n */\nexport const buildUploadOwnerStamp =\n\t(spam: ResolvedSpamConfig): CollectionBeforeValidateHook =>\n\tasync ({ data, operation, req }) => {\n\t\tif (operation !== 'create' || !data) {\n\t\t\treturn data\n\t\t}\n\t\tconst identity = await spam.identify(req)\n\t\tif (identity != null && (data as { owner?: unknown }).owner == null) {\n\t\t\t;(data as { owner?: string }).owner = identity\n\t\t}\n\t\treturn data\n\t}\n\n/** Reject upload floods per identity before the file is written to `staticDir`. Fail-open without identity. */\nexport const buildUploadRateLimit =\n\t(spam: ResolvedSpamConfig): CollectionBeforeOperationHook =>\n\tasync ({ operation, req }) => {\n\t\tif (operation !== 'create' || spam.uploadRateLimit === false) {\n\t\t\treturn\n\t\t}\n\t\tconst identity = await spam.identify(req)\n\t\tif (identity == null) {\n\t\t\treturn\n\t\t}\n\t\tconst { ok } = await spam.uploadRateLimit.limiter.check({\n\t\t\tkey: `uploads:${identity}`,\n\t\t\tmax: spam.uploadRateLimit.max,\n\t\t\twindow: spam.uploadRateLimit.window,\n\t\t\treq,\n\t\t})\n\t\tif (!ok) {\n\t\t\tthrow new APIError(asTranslate(req.i18n.t)(keys.spamRateLimited), 429)\n\t\t}\n\t}\n"],"mappings":";;;;;;;;;;AAeA,MAAa,yBACX,SACD,OAAO,EAAE,MAAM,WAAW,UAAU;CACnC,IAAI,cAAc,YAAY,CAAC,MAC9B,OAAO;CAER,MAAM,WAAW,MAAM,KAAK,SAAS,GAAG;CACxC,IAAI,YAAY,QAAS,KAA6B,SAAS,MAC7D,KAA6B,QAAQ;CAEvC,OAAO;AACR;;AAGD,MAAa,wBACX,SACD,OAAO,EAAE,WAAW,UAAU;CAC7B,IAAI,cAAc,YAAY,KAAK,oBAAoB,OACtD;CAED,MAAM,WAAW,MAAM,KAAK,SAAS,GAAG;CACxC,IAAI,YAAY,MACf;CAED,MAAM,EAAE,OAAO,MAAM,KAAK,gBAAgB,QAAQ,MAAM;EACvD,KAAK,WAAW;EAChB,KAAK,KAAK,gBAAgB;EAC1B,QAAQ,KAAK,gBAAgB;EAC7B;CACD,CAAC;CACD,IAAI,CAAC,IACJ,MAAM,IAAI,SAAS,YAAY,IAAI,KAAK,CAAC,EAAE,KAAK,eAAe,GAAG,GAAG;AAEvE"}

package/dist/submissions/SubmissionAnswers.d.ts

@@ -0,0 +1,16 @@
+import { UIFieldServerProps } from "payload";
+
+//#region src/submissions/SubmissionAnswers.d.ts
+/**
+ * Read-only, localized submission view (server component). Renders each answered field's snapshot
+ * label next to its type-aware formatted value via the field type's `format`, using the request
+ * locale and i18n, with no client bundle. The built-in field types are formatted directly; threading
+ * the full resolved registry (custom types) to the view is a future enhancement.
+ */
+declare const SubmissionAnswers: ({
+  data,
+  req
+}: UIFieldServerProps) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+export { SubmissionAnswers };
+//# sourceMappingURL=SubmissionAnswers.d.ts.map

package/dist/submissions/SubmissionAnswers.js

@@ -0,0 +1,57 @@
+import { keys } from "../translations/keys.js";
+import { asFieldTranslate } from "../translations/server.js";
+import { defaultFieldDefinitions } from "../fields/builtin/index.js";
+import { buildRegistry } from "../fields/registry.js";
+import { jsx, jsxs } from "react/jsx-runtime";
+//#region src/submissions/SubmissionAnswers.tsx
+const registry = buildRegistry(defaultFieldDefinitions);
+/** A stored file answer's link, when the captured `FileRef` carries a url; null otherwise. */
+const fileHref = (raw) => {
+	if (raw && typeof raw === "object" && "url" in raw) {
+		const ref = raw;
+		if (typeof ref.url === "string" && ref.url.length > 0) return {
+			url: ref.url,
+			filename: typeof ref.filename === "string" ? ref.filename : ref.url
+		};
+	}
+	return null;
+};
+/**
+* Read-only, localized submission view (server component). Renders each answered field's snapshot
+* label next to its type-aware formatted value via the field type's `format`, using the request
+* locale and i18n, with no client bundle. The built-in field types are formatted directly; threading
+* the full resolved registry (custom types) to the view is a future enhancement.
+*/
+const SubmissionAnswers = ({ data, req }) => {
+	const doc = data ?? {};
+	const descriptors = doc.descriptors ?? [];
+	const values = doc.values ?? [];
+	const locale = doc.locale ?? req.locale ?? "en";
+	const t = asFieldTranslate(req.i18n.t);
+	if (descriptors.length === 0) return /* @__PURE__ */ jsx("p", { children: t(keys.submissionNoAnswers) });
+	const valueByField = new Map(values.map((entry) => [entry.field, entry.value]));
+	return /* @__PURE__ */ jsxs("div", {
+		className: "form-builder-submission-answers",
+		children: [/* @__PURE__ */ jsx("h4", { children: t(keys.submissionAnswers) }), /* @__PURE__ */ jsx("dl", { children: descriptors.map((descriptor) => {
+			const definition = registry.get(descriptor.fieldType);
+			const raw = valueByField.get(descriptor.field);
+			const formatted = definition?.format ? definition.format({
+				value: raw,
+				config: {},
+				optionLabels: descriptor.optionLabels,
+				locale,
+				t
+			}) : raw == null ? "" : String(raw);
+			const href = descriptor.fieldType === "file" ? fileHref(raw) : null;
+			return /* @__PURE__ */ jsxs("div", { children: [/* @__PURE__ */ jsx("dt", { children: descriptor.label }), /* @__PURE__ */ jsx("dd", { children: href ? /* @__PURE__ */ jsx("a", {
+				href: href.url,
+				rel: "noreferrer",
+				children: href.filename
+			}) : formatted })] }, descriptor.field);
+		}) })]
+	});
+};
+//#endregion
+export { SubmissionAnswers };
+
+//# sourceMappingURL=SubmissionAnswers.js.map

package/dist/submissions/SubmissionAnswers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubmissionAnswers.js","names":[],"sources":["../../src/submissions/SubmissionAnswers.tsx"],"sourcesContent":["import type { UIFieldServerProps } from 'payload'\nimport { defaultFieldDefinitions } from '../fields/builtin'\nimport { buildRegistry } from '../fields/registry'\nimport { keys } from '../translations/keys'\nimport { asFieldTranslate } from '../translations/server'\nimport type { SubmissionDescriptor, SubmissionValue } from './types'\n\nconst registry = buildRegistry(defaultFieldDefinitions)\n\ntype SubmissionDoc = {\n\tvalues?: SubmissionValue[]\n\tdescriptors?: SubmissionDescriptor[]\n\tlocale?: string\n}\n\n/** A stored file answer's link, when the captured `FileRef` carries a url; null otherwise. */\nconst fileHref = (raw: unknown): { url: string; filename: string } | null => {\n\tif (raw && typeof raw === 'object' && 'url' in raw) {\n\t\tconst ref = raw as { url?: unknown; filename?: unknown }\n\t\tif (typeof ref.url === 'string' && ref.url.length > 0) {\n\t\t\treturn { url: ref.url, filename: typeof ref.filename === 'string' ? ref.filename : ref.url }\n\t\t}\n\t}\n\treturn null\n}\n\n/**\n * Read-only, localized submission view (server component). Renders each answered field's snapshot\n * label next to its type-aware formatted value via the field type's `format`, using the request\n * locale and i18n, with no client bundle. The built-in field types are formatted directly; threading\n * the full resolved registry (custom types) to the view is a future enhancement.\n */\nexport const SubmissionAnswers = ({ data, req }: UIFieldServerProps) => {\n\tconst doc = (data ?? {}) as SubmissionDoc\n\tconst descriptors = doc.descriptors ?? []\n\tconst values = doc.values ?? []\n\tconst locale = doc.locale ?? req.locale ?? 'en'\n\tconst t = asFieldTranslate(req.i18n.t)\n\n\tif (descriptors.length === 0) {\n\t\treturn <p>{t(keys.submissionNoAnswers)}</p>\n\t}\n\n\tconst valueByField = new Map(values.map((entry) => [entry.field, entry.value]))\n\n\treturn (\n\t\t<div className=\"form-builder-submission-answers\">\n\t\t\t<h4>{t(keys.submissionAnswers)}</h4>\n\t\t\t<dl>\n\t\t\t\t{descriptors.map((descriptor) => {\n\t\t\t\t\tconst definition = registry.get(descriptor.fieldType)\n\t\t\t\t\tconst raw = valueByField.get(descriptor.field)\n\t\t\t\t\tconst formatted = definition?.format\n\t\t\t\t\t\t? definition.format({\n\t\t\t\t\t\t\t\tvalue: raw,\n\t\t\t\t\t\t\t\tconfig: {},\n\t\t\t\t\t\t\t\toptionLabels: descriptor.optionLabels,\n\t\t\t\t\t\t\t\tlocale,\n\t\t\t\t\t\t\t\tt,\n\t\t\t\t\t\t\t})\n\t\t\t\t\t\t: raw == null\n\t\t\t\t\t\t\t? ''\n\t\t\t\t\t\t\t: String(raw)\n\t\t\t\t\tconst href = descriptor.fieldType === 'file' ? fileHref(raw) : null\n\t\t\t\t\treturn (\n\t\t\t\t\t\t<div key={descriptor.field}>\n\t\t\t\t\t\t\t<dt>{descriptor.label}</dt>\n\t\t\t\t\t\t\t<dd>\n\t\t\t\t\t\t\t\t{href ? (\n\t\t\t\t\t\t\t\t\t<a href={href.url} rel=\"noreferrer\">\n\t\t\t\t\t\t\t\t\t\t{href.filename}\n\t\t\t\t\t\t\t\t\t</a>\n\t\t\t\t\t\t\t\t) : (\n\t\t\t\t\t\t\t\t\tformatted\n\t\t\t\t\t\t\t\t)}\n\t\t\t\t\t\t\t</dd>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t)\n\t\t\t\t})}\n\t\t\t</dl>\n\t\t</div>\n\t)\n}\n"],"mappings":";;;;;;AAOA,MAAM,WAAW,cAAc,uBAAuB;;AAStD,MAAM,YAAY,QAA2D;CAC5E,IAAI,OAAO,OAAO,QAAQ,YAAY,SAAS,KAAK;EACnD,MAAM,MAAM;EACZ,IAAI,OAAO,IAAI,QAAQ,YAAY,IAAI,IAAI,SAAS,GACnD,OAAO;GAAE,KAAK,IAAI;GAAK,UAAU,OAAO,IAAI,aAAa,WAAW,IAAI,WAAW,IAAI;EAAI;CAE7F;CACA,OAAO;AACR;;;;;;;AAQA,MAAa,qBAAqB,EAAE,MAAM,UAA8B;CACvE,MAAM,MAAO,QAAQ,CAAC;CACtB,MAAM,cAAc,IAAI,eAAe,CAAC;CACxC,MAAM,SAAS,IAAI,UAAU,CAAC;CAC9B,MAAM,SAAS,IAAI,UAAU,IAAI,UAAU;CAC3C,MAAM,IAAI,iBAAiB,IAAI,KAAK,CAAC;CAErC,IAAI,YAAY,WAAW,GAC1B,OAAO,oBAAC,KAAD,EAAA,UAAI,EAAE,KAAK,mBAAmB,EAAK,CAAA;CAG3C,MAAM,eAAe,IAAI,IAAI,OAAO,KAAK,UAAU,CAAC,MAAM,OAAO,MAAM,KAAK,CAAC,CAAC;CAE9E,OACC,qBAAC,OAAD;EAAK,WAAU;YAAf,CACC,oBAAC,MAAD,EAAA,UAAK,EAAE,KAAK,iBAAiB,EAAM,CAAA,GACnC,oBAAC,MAAD,EAAA,UACE,YAAY,KAAK,eAAe;GAChC,MAAM,aAAa,SAAS,IAAI,WAAW,SAAS;GACpD,MAAM,MAAM,aAAa,IAAI,WAAW,KAAK;GAC7C,MAAM,YAAY,YAAY,SAC3B,WAAW,OAAO;IAClB,OAAO;IACP,QAAQ,CAAC;IACT,cAAc,WAAW;IACzB;IACA;GACD,CAAC,IACA,OAAO,OACN,KACA,OAAO,GAAG;GACd,MAAM,OAAO,WAAW,cAAc,SAAS,SAAS,GAAG,IAAI;GAC/D,OACC,qBAAC,OAAD,EAAA,UAAA,CACC,oBAAC,MAAD,EAAA,UAAK,WAAW,MAAU,CAAA,GAC1B,oBAAC,MAAD,EAAA,UACE,OACA,oBAAC,KAAD;IAAG,MAAM,KAAK;IAAK,KAAI;cACrB,KAAK;GACJ,CAAA,IAEH,UAEE,CAAA,CACA,EAAA,GAXK,WAAW,KAWhB;EAEP,CAAC,EACE,CAAA,CACA;;AAEP"}