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

package/dist/consent/captureConsent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"captureConsent.js","names":[],"sources":["../../src/consent/captureConsent.ts"],"sourcesContent":["import { createHash } from 'node:crypto'\nimport type { Payload, PayloadRequest } from 'payload'\nimport { hasDraftsEnabled } from 'payload/shared'\nimport { textOfBody } from '../actions/body/textOfBody'\nimport type { FormFieldInstance } from '../submissions/types'\nimport { resolvePublishedVersionRef } from './resolvePublishedVersionRef'\nimport type { ConsentSourceEntry, ConsentSourcePage } from './types'\n\n/** What a submission snapshots of the agreed wording. `'hash'` and `'text'` combine as `'both'`. */\nexport type ConsentSnapshotMode = 'hash' | 'text' | 'both' | false\n\nexport type ConsentProof = {\n\tagreed: boolean\n\t/** The source `id` the field referenced; empty when the author never picked one. */\n\tsource: string\n\tpage?: ConsentSourcePage\n\tversionRef?: string\n\t/** The source label at submit time, so an audit names the statement even after a rename or delete. */\n\tname?: string\n\t/** sha256 of the statement plain text agreed to: tamper-evident and PII-free. */\n\tstatementHash?: string\n\t/** Plain-text snapshot of the statement agreed to, for a human-readable audit. */\n\tstatementText?: string\n\tat: string\n}\n\n/**\n * The authoritative consent proof, built at submit time from the server's own view of the source\n * (the field carries an id, never a statement, so there is nothing here the client could forge).\n *\n * Proof is id-based on purpose: it records which document was agreed to, so renaming, re-slugging,\n * or re-routing the policy leaves every past proof intact and resolvable. `snapshot` additionally\n * captures the agreed wording (a `statementHash`, the plain `statementText`, or both) plus the source\n * `name`, so an audit shows exactly what was agreed to independent of later edits; `false` keeps the\n * lean id-only proof. The snapshot is captured in every branch, including a refusal and a page-less\n * source.\n *\n * Time-of-check/time-of-use: a visitor reads the wording resolved when the form loaded, but the\n * snapshot here is re-resolved from the source at submit. If the source text changed in that window,\n * the proof records the submit-time wording, not the exact bytes rendered earlier. This is\n * deliberate, the server's live view is authoritative and the window is one visitor session; a form\n * that must freeze the exact wording agreed to should version the source (drafts give a `versionRef`\n * pinning the published version, below).\n *\n * `versionRef` is recorded only when the page's collection has drafts enabled, and then it is the\n * published version document's own id. Versions without drafts get no `versionRef`, because there\n * is no published/draft distinction to pin to: `_status` only exists under drafts, so a\n * published-version lookup there matches nothing, and recording that as a version reference would\n * be inventing one. Absent means absent, in both cases.\n *\n * `now` is injected by the caller (`new Date().toISOString()`) for testability.\n */\nexport const captureConsent = async (args: {\n\tfield: FormFieldInstance\n\tagreed: boolean\n\t/** The host's resolved sources for this request (see `resolveConsentEntries`). */\n\tentries: ConsentSourceEntry[]\n\tpayload: Payload\n\treq?: PayloadRequest\n\tnow: string\n\t/** What to snapshot of the agreed wording (plugin option `consent.snapshot`); defaults to `'both'`. */\n\tsnapshot?: ConsentSnapshotMode\n}): Promise<ConsentProof> => {\n\tconst source = typeof args.field.source === 'string' ? args.field.source : ''\n\tconst entry = source ? args.entries.find((candidate) => candidate.id === source) : undefined\n\tconst snapshot = args.snapshot ?? 'both'\n\n\t// Capture the agreed wording (and the source label) onto every proof branch. Kept out of the two\n\t// returns so a refusal and a page-less source are snapshotted the same as the happy path.\n\tconst withSnapshot = (proof: ConsentProof): ConsentProof => {\n\t\tif (!entry || snapshot === false) {\n\t\t\treturn proof\n\t\t}\n\t\tif (typeof entry.name === 'string' && entry.name.trim().length > 0) {\n\t\t\tproof.name = entry.name.trim()\n\t\t}\n\t\tconst text = textOfBody(entry.statement)\n\t\tif (text.length > 0) {\n\t\t\tif (snapshot === 'hash' || snapshot === 'both') {\n\t\t\t\tproof.statementHash = createHash('sha256').update(text).digest('hex')\n\t\t\t}\n\t\t\tif (snapshot === 'text' || snapshot === 'both') {\n\t\t\t\tproof.statementText = text\n\t\t\t}\n\t\t}\n\t\treturn proof\n\t}\n\n\tconst page = entry?.page\n\tif (!page) {\n\t\treturn withSnapshot({ agreed: args.agreed, source, at: args.now })\n\t}\n\t// `page.relationTo` is a runtime string; cast the key so the lookup type-checks against a host's\n\t// narrowed collection map (a consumer's generated `CollectionSlug`) as well as the plugin's own\n\t// broad one. The value is still guarded below, since an unregistered slug resolves to undefined.\n\tconst collection = args.payload.collections[page.relationTo as keyof Payload['collections']]\n\tconst versionRef =\n\t\tcollection && hasDraftsEnabled(collection.config)\n\t\t\t? await resolvePublishedVersionRef({\n\t\t\t\t\tpayload: args.payload,\n\t\t\t\t\tcollection: page.relationTo,\n\t\t\t\t\tid: page.id,\n\t\t\t\t\treq: args.req,\n\t\t\t\t})\n\t\t\t: null\n\treturn withSnapshot({\n\t\tagreed: args.agreed,\n\t\tsource,\n\t\tpage: { relationTo: page.relationTo, id: page.id },\n\t\t...(versionRef ? { versionRef } : {}),\n\t\tat: args.now,\n\t})\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDA,MAAa,iBAAiB,OAAO,SAUR;CAC5B,MAAM,SAAS,OAAO,KAAK,MAAM,WAAW,WAAW,KAAK,MAAM,SAAS;CAC3E,MAAM,QAAQ,SAAS,KAAK,QAAQ,MAAM,cAAc,UAAU,OAAO,MAAM,IAAI,KAAA;CACnF,MAAM,WAAW,KAAK,YAAY;CAIlC,MAAM,gBAAgB,UAAsC;EAC3D,IAAI,CAAC,SAAS,aAAa,OAC1B,OAAO;EAER,IAAI,OAAO,MAAM,SAAS,YAAY,MAAM,KAAK,KAAK,EAAE,SAAS,GAChE,MAAM,OAAO,MAAM,KAAK,KAAK;EAE9B,MAAM,OAAO,WAAW,MAAM,SAAS;EACvC,IAAI,KAAK,SAAS,GAAG;GACpB,IAAI,aAAa,UAAU,aAAa,QACvC,MAAM,gBAAgB,WAAW,QAAQ,EAAE,OAAO,IAAI,EAAE,OAAO,KAAK;GAErE,IAAI,aAAa,UAAU,aAAa,QACvC,MAAM,gBAAgB;EAExB;EACA,OAAO;CACR;CAEA,MAAM,OAAO,OAAO;CACpB,IAAI,CAAC,MACJ,OAAO,aAAa;EAAE,QAAQ,KAAK;EAAQ;EAAQ,IAAI,KAAK;CAAI,CAAC;CAKlE,MAAM,aAAa,KAAK,QAAQ,YAAY,KAAK;CACjD,MAAM,aACL,cAAc,iBAAiB,WAAW,MAAM,IAC7C,MAAM,2BAA2B;EACjC,SAAS,KAAK;EACd,YAAY,KAAK;EACjB,IAAI,KAAK;EACT,KAAK,KAAK;CACX,CAAC,IACA;CACJ,OAAO,aAAa;EACnB,QAAQ,KAAK;EACb;EACA,MAAM;GAAE,YAAY,KAAK;GAAY,IAAI,KAAK;EAAG;EACjD,GAAI,aAAa,EAAE,WAAW,IAAI,CAAC;EACnC,IAAI,KAAK;CACV,CAAC;AACF"}

package/dist/consent/consentSourcesField.d.ts

@@ -0,0 +1,66 @@
+import { ArrayField, CollectionSlug, RichTextField } from "payload";
+
+//#region src/consent/consentSourcesField.d.ts
+type ConsentSourcesFieldOptions = {
+  /** Field name, i.e. what the row array is stored under. Defaults to `consentSources`. */name?: string; /** Field label. Defaults to the plugin's translated one. */
+  label?: ArrayField['label'];
+  /**
+   * Collections whose documents can be picked as a source's policy page. Omitted (the default):
+   * no page picker at all, so sources are statement-only and their proofs carry no page or
+   * version reference. Always stored polymorphically, even for a single slug (see below).
+   */
+  relationTo?: CollectionSlug | CollectionSlug[];
+  /**
+   * Whether the visitor-facing `statement` and `name` carry `localized: true`. Default `true`;
+   * Payload strips the flag on hosts without `localization`, so it is safe either way. Mirrors
+   * the plugin's `localizeContent` option, which this host-called factory cannot see.
+   */
+  localized?: boolean; /** Overrides the project's default richText editor for the `statement`, as `richText.editor` does plugin-side. */
+  editor?: RichTextField['editor'];
+};
+/**
+ * The consent sources array, for the host to place on any collection or global they own: a
+ * settings global, a tenants collection, a legal-pages parent, wherever the sources belong. The
+ * plugin never registers it and never guesses where it lives; a matching `consent.sources` resolver
+ * reads it back (see {@link ConsentSourcesResolver}), which is also where multi-tenant scoping goes:
+ * place this on the tenant-scoped document and have the resolver return only the sources of the
+ * tenant it derives from `req`.
+ *
+ * A row is a `name` (shown when picking the source on a form, and used as the policy link text
+ * beside the statement), the `statement` the visitor agrees to, and optionally the `page` that
+ * statement belongs to. The stable reference a consent field stores, and the only part that must
+ * outlive edits, is the row's own auto-assigned `id`: it survives a `name` edit or reordering,
+ * unlike a hand-authored key would. Authors fill in no version, no URL, and no document id by
+ * hand: the version is detected and recorded at submit time, and the page is a picker.
+ *
+ * `page` is always polymorphic, even when `relationTo` names a single collection, because a
+ * monomorphic relationship stores a bare id: the proof needs the collection alongside it to stay
+ * resolvable, and a host adding a second collection later would otherwise change the stored shape.
+ *
+ * ```ts
+ * // The host's own collection or global:
+ * fields: [consentSourcesField({ relationTo: ['pages', 'legal-notices'] })]
+ *
+ * // The plugin, reading it back:
+ * formBuilder({
+ *   consent: {
+ *     sources: async ({ req }) => {
+ *       const settings = await req.payload.findGlobal({ slug: 'settings', depth: 0, locale: req.locale, req })
+ *       return (settings.consentSources ?? []).map((row) => ({ ... }))
+ *     },
+ *   },
+ * })
+ * ```
+ *
+ * The resolver receives the whole form document, so derive tenant scoping from a field on it rather
+ * than reading the form back: reading the `forms` collection from the resolver re-enters this form's
+ * afterRead hook (the plugin guards against the resulting recursion, but the read is still wasted).
+ *
+ * A resolver reading its settings document must not thread the save's `req` into a `locale: 'all'`
+ * read from within a form's save validation: that flips `req.locale` to `all` and corrupts the
+ * localized write of the document being saved. It reads already-committed data, so no `req` is needed.
+ */
+declare const consentSourcesField: (options?: ConsentSourcesFieldOptions) => ArrayField;
+//#endregion
+export { ConsentSourcesFieldOptions, consentSourcesField };
+//# sourceMappingURL=consentSourcesField.d.ts.map

package/dist/consent/consentSourcesField.js

@@ -0,0 +1,90 @@
+import { keys } from "../translations/keys.js";
+import { labelForKey } from "../translations/server.js";
+import { localizedIf } from "../fields/localizedIf.js";
+//#region src/consent/consentSourcesField.ts
+/**
+* The consent sources array, for the host to place on any collection or global they own: a
+* settings global, a tenants collection, a legal-pages parent, wherever the sources belong. The
+* plugin never registers it and never guesses where it lives; a matching `consent.sources` resolver
+* reads it back (see {@link ConsentSourcesResolver}), which is also where multi-tenant scoping goes:
+* place this on the tenant-scoped document and have the resolver return only the sources of the
+* tenant it derives from `req`.
+*
+* A row is a `name` (shown when picking the source on a form, and used as the policy link text
+* beside the statement), the `statement` the visitor agrees to, and optionally the `page` that
+* statement belongs to. The stable reference a consent field stores, and the only part that must
+* outlive edits, is the row's own auto-assigned `id`: it survives a `name` edit or reordering,
+* unlike a hand-authored key would. Authors fill in no version, no URL, and no document id by
+* hand: the version is detected and recorded at submit time, and the page is a picker.
+*
+* `page` is always polymorphic, even when `relationTo` names a single collection, because a
+* monomorphic relationship stores a bare id: the proof needs the collection alongside it to stay
+* resolvable, and a host adding a second collection later would otherwise change the stored shape.
+*
+* ```ts
+* // The host's own collection or global:
+* fields: [consentSourcesField({ relationTo: ['pages', 'legal-notices'] })]
+*
+* // The plugin, reading it back:
+* formBuilder({
+*   consent: {
+*     sources: async ({ req }) => {
+*       const settings = await req.payload.findGlobal({ slug: 'settings', depth: 0, locale: req.locale, req })
+*       return (settings.consentSources ?? []).map((row) => ({ ... }))
+*     },
+*   },
+* })
+* ```
+*
+* The resolver receives the whole form document, so derive tenant scoping from a field on it rather
+* than reading the form back: reading the `forms` collection from the resolver re-enters this form's
+* afterRead hook (the plugin guards against the resulting recursion, but the read is still wasted).
+*
+* A resolver reading its settings document must not thread the save's `req` into a `locale: 'all'`
+* read from within a form's save validation: that flips `req.locale` to `all` and corrupts the
+* localized write of the document being saved. It reads already-committed data, so no `req` is needed.
+*/
+const consentSourcesField = (options = {}) => {
+	const localize = options.localized !== false;
+	const relationTo = options.relationTo && (!Array.isArray(options.relationTo) || options.relationTo.length > 0) ? options.relationTo : void 0;
+	const pageField = relationTo ? [{
+		name: "page",
+		type: "relationship",
+		relationTo: Array.isArray(relationTo) ? relationTo : [relationTo],
+		label: labelForKey(keys.consentSourcePage),
+		admin: { description: labelForKey(keys.consentSourcePageDescription) }
+	}] : [];
+	return {
+		name: options.name ?? "consentSources",
+		type: "array",
+		label: options.label ?? labelForKey(keys.consentSourcesField),
+		labels: {
+			singular: labelForKey(keys.consentSourceSingular),
+			plural: labelForKey(keys.consentSourcePlural)
+		},
+		admin: {
+			description: labelForKey(keys.consentSourcesFieldDescription),
+			components: { RowLabel: "@10x-media/form-builder/client#ConsentSourceRowLabel" }
+		},
+		fields: [
+			{
+				name: "name",
+				type: "text",
+				label: labelForKey(keys.consentSourceLabel),
+				...localizedIf(localize)
+			},
+			{
+				name: "statement",
+				type: "richText",
+				label: labelForKey(keys.consentSourceStatement),
+				...options.editor ? { editor: options.editor } : {},
+				...localizedIf(localize)
+			},
+			...pageField
+		]
+	};
+};
+//#endregion
+export { consentSourcesField };
+
+//# sourceMappingURL=consentSourcesField.js.map

package/dist/consent/consentSourcesField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consentSourcesField.js","names":[],"sources":["../../src/consent/consentSourcesField.ts"],"sourcesContent":["import type { ArrayField, CollectionSlug, Field, RichTextField } from 'payload'\nimport { localizedIf } from '../fields/localizedIf'\nimport { keys } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\n\nexport type ConsentSourcesFieldOptions = {\n\t/** Field name, i.e. what the row array is stored under. Defaults to `consentSources`. */\n\tname?: string\n\t/** Field label. Defaults to the plugin's translated one. */\n\tlabel?: ArrayField['label']\n\t/**\n\t * Collections whose documents can be picked as a source's policy page. Omitted (the default):\n\t * no page picker at all, so sources are statement-only and their proofs carry no page or\n\t * version reference. Always stored polymorphically, even for a single slug (see below).\n\t */\n\trelationTo?: CollectionSlug | CollectionSlug[]\n\t/**\n\t * Whether the visitor-facing `statement` and `name` carry `localized: true`. Default `true`;\n\t * Payload strips the flag on hosts without `localization`, so it is safe either way. Mirrors\n\t * the plugin's `localizeContent` option, which this host-called factory cannot see.\n\t */\n\tlocalized?: boolean\n\t/** Overrides the project's default richText editor for the `statement`, as `richText.editor` does plugin-side. */\n\teditor?: RichTextField['editor']\n}\n\n/**\n * The consent sources array, for the host to place on any collection or global they own: a\n * settings global, a tenants collection, a legal-pages parent, wherever the sources belong. The\n * plugin never registers it and never guesses where it lives; a matching `consent.sources` resolver\n * reads it back (see {@link ConsentSourcesResolver}), which is also where multi-tenant scoping goes:\n * place this on the tenant-scoped document and have the resolver return only the sources of the\n * tenant it derives from `req`.\n *\n * A row is a `name` (shown when picking the source on a form, and used as the policy link text\n * beside the statement), the `statement` the visitor agrees to, and optionally the `page` that\n * statement belongs to. The stable reference a consent field stores, and the only part that must\n * outlive edits, is the row's own auto-assigned `id`: it survives a `name` edit or reordering,\n * unlike a hand-authored key would. Authors fill in no version, no URL, and no document id by\n * hand: the version is detected and recorded at submit time, and the page is a picker.\n *\n * `page` is always polymorphic, even when `relationTo` names a single collection, because a\n * monomorphic relationship stores a bare id: the proof needs the collection alongside it to stay\n * resolvable, and a host adding a second collection later would otherwise change the stored shape.\n *\n * ```ts\n * // The host's own collection or global:\n * fields: [consentSourcesField({ relationTo: ['pages', 'legal-notices'] })]\n *\n * // The plugin, reading it back:\n * formBuilder({\n *   consent: {\n *     sources: async ({ req }) => {\n *       const settings = await req.payload.findGlobal({ slug: 'settings', depth: 0, locale: req.locale, req })\n *       return (settings.consentSources ?? []).map((row) => ({ ... }))\n *     },\n *   },\n * })\n * ```\n *\n * The resolver receives the whole form document, so derive tenant scoping from a field on it rather\n * than reading the form back: reading the `forms` collection from the resolver re-enters this form's\n * afterRead hook (the plugin guards against the resulting recursion, but the read is still wasted).\n *\n * A resolver reading its settings document must not thread the save's `req` into a `locale: 'all'`\n * read from within a form's save validation: that flips `req.locale` to `all` and corrupts the\n * localized write of the document being saved. It reads already-committed data, so no `req` is needed.\n */\nexport const consentSourcesField = (options: ConsentSourcesFieldOptions = {}): ArrayField => {\n\tconst localize = options.localized !== false\n\t// An empty `relationTo` array is treated as \"no page picker\", not a relationship field pointing\n\t// at nothing (which Payload rejects at boot).\n\tconst relationTo =\n\t\toptions.relationTo && (!Array.isArray(options.relationTo) || options.relationTo.length > 0)\n\t\t\t? options.relationTo\n\t\t\t: undefined\n\tconst pageField: Field[] = relationTo\n\t\t? [\n\t\t\t\t{\n\t\t\t\t\tname: 'page',\n\t\t\t\t\ttype: 'relationship',\n\t\t\t\t\trelationTo: Array.isArray(relationTo) ? relationTo : [relationTo],\n\t\t\t\t\tlabel: labelForKey(keys.consentSourcePage),\n\t\t\t\t\tadmin: { description: labelForKey(keys.consentSourcePageDescription) },\n\t\t\t\t},\n\t\t\t]\n\t\t: []\n\n\treturn {\n\t\tname: options.name ?? 'consentSources',\n\t\ttype: 'array',\n\t\tlabel: options.label ?? labelForKey(keys.consentSourcesField),\n\t\tlabels: {\n\t\t\tsingular: labelForKey(keys.consentSourceSingular),\n\t\t\tplural: labelForKey(keys.consentSourcePlural),\n\t\t},\n\t\tadmin: {\n\t\t\tdescription: labelForKey(keys.consentSourcesFieldDescription),\n\t\t\tcomponents: { RowLabel: '@10x-media/form-builder/client#ConsentSourceRowLabel' },\n\t\t},\n\t\tfields: [\n\t\t\t{\n\t\t\t\tname: 'name',\n\t\t\t\ttype: 'text',\n\t\t\t\tlabel: labelForKey(keys.consentSourceLabel),\n\t\t\t\t...localizedIf(localize),\n\t\t\t},\n\t\t\t{\n\t\t\t\tname: 'statement',\n\t\t\t\ttype: 'richText',\n\t\t\t\tlabel: labelForKey(keys.consentSourceStatement),\n\t\t\t\t...(options.editor ? { editor: options.editor } : {}),\n\t\t\t\t...localizedIf(localize),\n\t\t\t},\n\t\t\t...pageField,\n\t\t],\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,MAAa,uBAAuB,UAAsC,CAAC,MAAkB;CAC5F,MAAM,WAAW,QAAQ,cAAc;CAGvC,MAAM,aACL,QAAQ,eAAe,CAAC,MAAM,QAAQ,QAAQ,UAAU,KAAK,QAAQ,WAAW,SAAS,KACtF,QAAQ,aACR,KAAA;CACJ,MAAM,YAAqB,aACxB,CACA;EACC,MAAM;EACN,MAAM;EACN,YAAY,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU;EAChE,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,YAAY,KAAK,4BAA4B,EAAE;CACtE,CACD,IACC,CAAC;CAEJ,OAAO;EACN,MAAM,QAAQ,QAAQ;EACtB,MAAM;EACN,OAAO,QAAQ,SAAS,YAAY,KAAK,mBAAmB;EAC5D,QAAQ;GACP,UAAU,YAAY,KAAK,qBAAqB;GAChD,QAAQ,YAAY,KAAK,mBAAmB;EAC7C;EACA,OAAO;GACN,aAAa,YAAY,KAAK,8BAA8B;GAC5D,YAAY,EAAE,UAAU,uDAAuD;EAChF;EACA,QAAQ;GACP;IACC,MAAM;IACN,MAAM;IACN,OAAO,YAAY,KAAK,kBAAkB;IAC1C,GAAG,YAAY,QAAQ;GACxB;GACA;IACC,MAAM;IACN,MAAM;IACN,OAAO,YAAY,KAAK,sBAAsB;IAC9C,GAAI,QAAQ,SAAS,EAAE,QAAQ,QAAQ,OAAO,IAAI,CAAC;IACnD,GAAG,YAAY,QAAQ;GACxB;GACA,GAAG;EACJ;CACD;AACD"}

package/dist/consent/resolveConsentEntries.d.ts

@@ -0,0 +1,24 @@
+import { ConsentSourceEntry, ConsentSourcesResolver } from "./types.js";
+import { Payload, PayloadRequest } from "payload";
+
+//#region src/consent/resolveConsentEntries.d.ts
+type ResolveConsentEntriesArgs = {
+  payload: Payload;
+  req: PayloadRequest; /** The whole form being resolved; forwarded to the resolver, which casts for non-standard fields (e.g. tenant). */
+  form: {
+    id: number | string;
+    title?: string | null;
+  }; /** Resolver override for plugin-internal callers; defaults to the one the plugin stashed on the config. */
+  sources?: ConsentSourcesResolver;
+};
+/**
+ * The host's consent sources for this request, or an empty list when no resolver is configured
+ * (in which case the `consent` field type is not registered either, so nothing can reference one).
+ * Throws whatever the resolver throws: every caller decides how to fail, and none of them fail open.
+ * Cached per request and form id, so one submission resolves the host's sources once no matter how
+ * many consent fields the form carries.
+ */
+declare const resolveConsentEntries: (args: ResolveConsentEntriesArgs) => Promise<ConsentSourceEntry[]>;
+//#endregion
+export { ResolveConsentEntriesArgs, resolveConsentEntries };
+//# sourceMappingURL=resolveConsentEntries.d.ts.map

package/dist/consent/resolveConsentEntries.js

@@ -0,0 +1,40 @@
+import { customStateOf, stashCustomState } from "../plugin/customState.js";
+//#region src/consent/resolveConsentEntries.ts
+/** Park the host's resolver on the config so root-level helpers can find it via `payload.config`. */
+const stashConsentSources = (custom, sources) => stashCustomState(custom, { consentSources: sources });
+const consentSourcesOf = (payload) => customStateOf(payload).consentSources;
+const CACHE_KEY = "formBuilderConsentSourcesCache";
+const cacheOf = (req) => {
+	if (!req.context) return;
+	const existing = req.context[CACHE_KEY];
+	if (existing instanceof Map) return existing;
+	const created = /* @__PURE__ */ new Map();
+	req.context[CACHE_KEY] = created;
+	return created;
+};
+/**
+* The host's consent sources for this request, or an empty list when no resolver is configured
+* (in which case the `consent` field type is not registered either, so nothing can reference one).
+* Throws whatever the resolver throws: every caller decides how to fail, and none of them fail open.
+* Cached per request and form id, so one submission resolves the host's sources once no matter how
+* many consent fields the form carries.
+*/
+const resolveConsentEntries = async (args) => {
+	const { payload, req, form } = args;
+	const resolver = args.sources ?? consentSourcesOf(payload);
+	if (!resolver) return [];
+	const cache = cacheOf(req);
+	const cacheKey = String(form.id);
+	const cached = cache?.get(cacheKey);
+	if (cached) return cached;
+	const entries = await resolver({
+		req,
+		form
+	});
+	cache?.set(cacheKey, entries);
+	return entries;
+};
+//#endregion
+export { resolveConsentEntries, stashConsentSources };
+
+//# sourceMappingURL=resolveConsentEntries.js.map

package/dist/consent/resolveConsentEntries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveConsentEntries.js","names":[],"sources":["../../src/consent/resolveConsentEntries.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport { customStateOf, stashCustomState } from '../plugin/customState'\nimport type { ConsentSourceEntry, ConsentSourcesResolver } from './types'\n\ntype ConsentCustomState = { consentSources: ConsentSourcesResolver }\n\n/** Park the host's resolver on the config so root-level helpers can find it via `payload.config`. */\nexport const stashConsentSources = (\n\tcustom: Record<string, unknown> | undefined,\n\tsources: ConsentSourcesResolver\n): Record<string, unknown> =>\n\tstashCustomState<ConsentCustomState>(custom, { consentSources: sources })\n\nexport const consentSourcesOf = (payload: Payload): ConsentSourcesResolver | undefined =>\n\tcustomStateOf<ConsentCustomState>(payload).consentSources\n\nconst CACHE_KEY = 'formBuilderConsentSourcesCache'\n\ntype EntriesCache = Map<string, ConsentSourceEntry[]>\n\nconst cacheOf = (req: PayloadRequest): EntriesCache | undefined => {\n\tif (!req.context) {\n\t\treturn undefined\n\t}\n\tconst existing = req.context[CACHE_KEY]\n\tif (existing instanceof Map) {\n\t\treturn existing as EntriesCache\n\t}\n\tconst created: EntriesCache = new Map()\n\treq.context[CACHE_KEY] = created\n\treturn created\n}\n\nexport type ResolveConsentEntriesArgs = {\n\tpayload: Payload\n\treq: PayloadRequest\n\t/** The whole form being resolved; forwarded to the resolver, which casts for non-standard fields (e.g. tenant). */\n\tform: { id: number | string; title?: string | null }\n\t/** Resolver override for plugin-internal callers; defaults to the one the plugin stashed on the config. */\n\tsources?: ConsentSourcesResolver\n}\n\n/**\n * The host's consent sources for this request, or an empty list when no resolver is configured\n * (in which case the `consent` field type is not registered either, so nothing can reference one).\n * Throws whatever the resolver throws: every caller decides how to fail, and none of them fail open.\n * Cached per request and form id, so one submission resolves the host's sources once no matter how\n * many consent fields the form carries.\n */\nexport const resolveConsentEntries = async (\n\targs: ResolveConsentEntriesArgs\n): Promise<ConsentSourceEntry[]> => {\n\tconst { payload, req, form } = args\n\tconst resolver = args.sources ?? consentSourcesOf(payload)\n\tif (!resolver) {\n\t\treturn []\n\t}\n\tconst cache = cacheOf(req)\n\tconst cacheKey = String(form.id)\n\tconst cached = cache?.get(cacheKey)\n\tif (cached) {\n\t\treturn cached\n\t}\n\tconst entries = await resolver({ req, form })\n\tcache?.set(cacheKey, entries)\n\treturn entries\n}\n"],"mappings":";;;AAOA,MAAa,uBACZ,QACA,YAEA,iBAAqC,QAAQ,EAAE,gBAAgB,QAAQ,CAAC;AAEzE,MAAa,oBAAoB,YAChC,cAAkC,OAAO,EAAE;AAE5C,MAAM,YAAY;AAIlB,MAAM,WAAW,QAAkD;CAClE,IAAI,CAAC,IAAI,SACR;CAED,MAAM,WAAW,IAAI,QAAQ;CAC7B,IAAI,oBAAoB,KACvB,OAAO;CAER,MAAM,0BAAwB,IAAI,IAAI;CACtC,IAAI,QAAQ,aAAa;CACzB,OAAO;AACR;;;;;;;;AAkBA,MAAa,wBAAwB,OACpC,SACmC;CACnC,MAAM,EAAE,SAAS,KAAK,SAAS;CAC/B,MAAM,WAAW,KAAK,WAAW,iBAAiB,OAAO;CACzD,IAAI,CAAC,UACJ,OAAO,CAAC;CAET,MAAM,QAAQ,QAAQ,GAAG;CACzB,MAAM,WAAW,OAAO,KAAK,EAAE;CAC/B,MAAM,SAAS,OAAO,IAAI,QAAQ;CAClC,IAAI,QACH,OAAO;CAER,MAAM,UAAU,MAAM,SAAS;EAAE;EAAK;CAAK,CAAC;CAC5C,OAAO,IAAI,UAAU,OAAO;CAC5B,OAAO;AACR"}

package/dist/consent/resolveConsentSourcesRequest.d.ts

@@ -0,0 +1,37 @@
+import { ConsentSourcesResolver } from "./types.js";
+import { Payload, PayloadRequest } from "payload";
+
+//#region src/consent/resolveConsentSourcesRequest.d.ts
+/** One selectable consent source for the consent field's `source` select. */
+type ConsentSourceOption = {
+  label: string;
+  value: string;
+};
+type ResolveConsentSourcesRequestArgs = {
+  payload: Payload;
+  formId: number | string | undefined; /** Whether the caller is authenticated (an admin/user). */
+  isAuthed: boolean;
+  req: PayloadRequest;
+  resolver: ConsentSourcesResolver;
+};
+type ResolveConsentSourcesRequestResult = {
+  status: number;
+  body: {
+    options: ConsentSourceOption[];
+  } | {
+    errors: {
+      message: string;
+    }[];
+  };
+};
+/**
+ * Authorize and resolve the `GET /:id/consent-sources` request backing the consent `source` select:
+ * authenticated callers get the host's sources for this request (a multi-tenant resolver scoping by
+ * `req` therefore offers an author only their own tenant's), anonymous callers are always refused.
+ * Statuses mirror the poll-options endpoint: 400 missing id, 403 unauthenticated, 404 unknown form,
+ * 503 when the resolver throws (fail closed).
+ */
+declare const resolveConsentSourcesRequest: (args: ResolveConsentSourcesRequestArgs) => Promise<ResolveConsentSourcesRequestResult>;
+//#endregion
+export { ConsentSourceOption, ResolveConsentSourcesRequestArgs, ResolveConsentSourcesRequestResult, resolveConsentSourcesRequest };
+//# sourceMappingURL=resolveConsentSourcesRequest.d.ts.map

package/dist/consent/resolveConsentSourcesRequest.js

@@ -0,0 +1,54 @@
+import { resolveConsentEntries } from "./resolveConsentEntries.js";
+import { FORMS_SLUG } from "../collections/forms.js";
+//#region src/consent/resolveConsentSourcesRequest.ts
+/**
+* Authorize and resolve the `GET /:id/consent-sources` request backing the consent `source` select:
+* authenticated callers get the host's sources for this request (a multi-tenant resolver scoping by
+* `req` therefore offers an author only their own tenant's), anonymous callers are always refused.
+* Statuses mirror the poll-options endpoint: 400 missing id, 403 unauthenticated, 404 unknown form,
+* 503 when the resolver throws (fail closed).
+*/
+const resolveConsentSourcesRequest = async (args) => {
+	const { payload, formId, isAuthed, req, resolver } = args;
+	if (!isAuthed) return {
+		status: 403,
+		body: { errors: [{ message: "Forbidden" }] }
+	};
+	if (formId == null) return {
+		status: 400,
+		body: { errors: [{ message: "Missing form id" }] }
+	};
+	const form = await payload.findByID({
+		collection: FORMS_SLUG,
+		id: formId,
+		depth: 0,
+		req
+	}).catch(() => null);
+	if (!form) return {
+		status: 404,
+		body: { errors: [{ message: "Not found" }] }
+	};
+	try {
+		return {
+			status: 200,
+			body: { options: (await resolveConsentEntries({
+				payload,
+				req,
+				form,
+				sources: resolver
+			})).map((entry) => ({
+				label: entry.name ?? entry.id,
+				value: entry.id
+			})) }
+		};
+	} catch {
+		return {
+			status: 503,
+			body: { errors: [{ message: "Consent sources unavailable" }] }
+		};
+	}
+};
+//#endregion
+export { resolveConsentSourcesRequest };
+
+//# sourceMappingURL=resolveConsentSourcesRequest.js.map

package/dist/consent/resolveConsentSourcesRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveConsentSourcesRequest.js","names":[],"sources":["../../src/consent/resolveConsentSourcesRequest.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport { FORMS_SLUG } from '../collections/forms'\nimport { resolveConsentEntries } from './resolveConsentEntries'\nimport type { ConsentSourcesResolver } from './types'\n\n/** One selectable consent source for the consent field's `source` select. */\nexport type ConsentSourceOption = { label: string; value: string }\n\nexport type ResolveConsentSourcesRequestArgs = {\n\tpayload: Payload\n\tformId: number | string | undefined\n\t/** Whether the caller is authenticated (an admin/user). */\n\tisAuthed: boolean\n\treq: PayloadRequest\n\tresolver: ConsentSourcesResolver\n}\n\nexport type ResolveConsentSourcesRequestResult = {\n\tstatus: number\n\tbody: { options: ConsentSourceOption[] } | { errors: { message: string }[] }\n}\n\n/**\n * Authorize and resolve the `GET /:id/consent-sources` request backing the consent `source` select:\n * authenticated callers get the host's sources for this request (a multi-tenant resolver scoping by\n * `req` therefore offers an author only their own tenant's), anonymous callers are always refused.\n * Statuses mirror the poll-options endpoint: 400 missing id, 403 unauthenticated, 404 unknown form,\n * 503 when the resolver throws (fail closed).\n */\nexport const resolveConsentSourcesRequest = async (\n\targs: ResolveConsentSourcesRequestArgs\n): Promise<ResolveConsentSourcesRequestResult> => {\n\tconst { payload, formId, isAuthed, req, resolver } = args\n\tif (!isAuthed) {\n\t\treturn { status: 403, body: { errors: [{ message: 'Forbidden' }] } }\n\t}\n\tif (formId == null) {\n\t\treturn { status: 400, body: { errors: [{ message: 'Missing form id' }] } }\n\t}\n\t// Load under the caller's own read access (no overrideAccess): a tenant-scoped `forms.access.read`\n\t// then refuses a cross-tenant form id (null -> 404), so an authed user can never enumerate another\n\t// tenant's consent source labels/ids.\n\tconst form = await payload\n\t\t.findByID({ collection: FORMS_SLUG, id: formId, depth: 0, req })\n\t\t.catch(() => null)\n\tif (!form) {\n\t\treturn { status: 404, body: { errors: [{ message: 'Not found' }] } }\n\t}\n\ttry {\n\t\tconst entries = await resolveConsentEntries({ payload, req, form, sources: resolver })\n\t\treturn {\n\t\t\tstatus: 200,\n\t\t\tbody: {\n\t\t\t\toptions: entries.map((entry) => ({ label: entry.name ?? entry.id, value: entry.id })),\n\t\t\t},\n\t\t}\n\t} catch {\n\t\treturn { status: 503, body: { errors: [{ message: 'Consent sources unavailable' }] } }\n\t}\n}\n"],"mappings":";;;;;;;;;;AA6BA,MAAa,+BAA+B,OAC3C,SACiD;CACjD,MAAM,EAAE,SAAS,QAAQ,UAAU,KAAK,aAAa;CACrD,IAAI,CAAC,UACJ,OAAO;EAAE,QAAQ;EAAK,MAAM,EAAE,QAAQ,CAAC,EAAE,SAAS,YAAY,CAAC,EAAE;CAAE;CAEpE,IAAI,UAAU,MACb,OAAO;EAAE,QAAQ;EAAK,MAAM,EAAE,QAAQ,CAAC,EAAE,SAAS,kBAAkB,CAAC,EAAE;CAAE;CAK1E,MAAM,OAAO,MAAM,QACjB,SAAS;EAAE,YAAY;EAAY,IAAI;EAAQ,OAAO;EAAG;CAAI,CAAC,EAC9D,YAAY,IAAI;CAClB,IAAI,CAAC,MACJ,OAAO;EAAE,QAAQ;EAAK,MAAM,EAAE,QAAQ,CAAC,EAAE,SAAS,YAAY,CAAC,EAAE;CAAE;CAEpE,IAAI;EAEH,OAAO;GACN,QAAQ;GACR,MAAM,EACL,UAAS,MAJW,sBAAsB;IAAE;IAAS;IAAK;IAAM,SAAS;GAAS,CAAC,GAIlE,KAAK,WAAW;IAAE,OAAO,MAAM,QAAQ,MAAM;IAAI,OAAO,MAAM;GAAG,EAAE,EACrF;EACD;CACD,QAAQ;EACP,OAAO;GAAE,QAAQ;GAAK,MAAM,EAAE,QAAQ,CAAC,EAAE,SAAS,8BAA8B,CAAC,EAAE;EAAE;CACtF;AACD"}

package/dist/consent/resolveConsentStatements.d.ts

@@ -0,0 +1,45 @@
+import { ConsentSourcesResolver } from "./types.js";
+import { Payload, PayloadRequest } from "payload";
+
+//#region src/consent/resolveConsentStatements.d.ts
+/** What a consent field shows the visitor, resolved from its source at request time. */
+type ConsentStatement = {
+  /** Rich text state (or whatever the host's resolver returned), for the request's locale. */statement?: unknown; /** The policy link beside the statement, present only when the source carries both a `url` and a `label`. */
+  link?: {
+    label: string;
+    url: string;
+  };
+};
+/** Resolved statements keyed by consent field name, as `toFormDocument`'s `consentStatements` takes them. */
+type ConsentStatements = Record<string, ConsentStatement>;
+type ResolveConsentStatementsArgs = {
+  payload: Payload;
+  req: PayloadRequest; /** A loaded forms document; its consent fields' `source` ids drive resolution. The whole doc is forwarded to the resolver. */
+  form: {
+    id: number | string;
+    title?: string | null;
+    fields?: {
+      blockType: string;
+      name?: string;
+      [key: string]: unknown;
+    }[] | null;
+  }; /** Resolver override for plugin-internal callers; defaults to the one the plugin stashed on the config. */
+  sources?: ConsentSourcesResolver;
+};
+/**
+ * Resolve every consent field's statement for this request, ready to hand to
+ * `toFormDocument(doc, { consentStatements })`.
+ *
+ * The statement is a live reference, not a copy: a form stores only its source id, and the
+ * sentence the visitor reads is resolved here, in their locale, from whatever the source says
+ * right now. So correcting a policy sentence corrects every form referencing it, with nothing to
+ * re-save, and a form rendered without this step shows no statement at all rather than a stale one.
+ *
+ * Call it server-side (a Server Component, a route handler) before rendering `<Form>`. Throws
+ * whatever the host's resolver throws, so a page can decide between failing and rendering without
+ * consent; a submit resolves the source again regardless, and the proof is built from that.
+ */
+declare const resolveConsentStatements: (args: ResolveConsentStatementsArgs) => Promise<ConsentStatements>;
+//#endregion
+export { ConsentStatement, ConsentStatements, ResolveConsentStatementsArgs, resolveConsentStatements };
+//# sourceMappingURL=resolveConsentStatements.d.ts.map

package/dist/consent/resolveConsentStatements.js

@@ -0,0 +1,44 @@
+import { resolveConsentEntries } from "./resolveConsentEntries.js";
+//#region src/consent/resolveConsentStatements.ts
+/**
+* Resolve every consent field's statement for this request, ready to hand to
+* `toFormDocument(doc, { consentStatements })`.
+*
+* The statement is a live reference, not a copy: a form stores only its source id, and the
+* sentence the visitor reads is resolved here, in their locale, from whatever the source says
+* right now. So correcting a policy sentence corrects every form referencing it, with nothing to
+* re-save, and a form rendered without this step shows no statement at all rather than a stale one.
+*
+* Call it server-side (a Server Component, a route handler) before rendering `<Form>`. Throws
+* whatever the host's resolver throws, so a page can decide between failing and rendering without
+* consent; a submit resolves the source again regardless, and the proof is built from that.
+*/
+const resolveConsentStatements = async (args) => {
+	const { payload, req, form, sources } = args;
+	const consentFields = (form.fields ?? []).filter((field) => field.blockType === "consent" && typeof field.name === "string" && field.name.length > 0);
+	if (consentFields.length === 0) return {};
+	const entries = await resolveConsentEntries({
+		payload,
+		req,
+		form,
+		sources
+	});
+	const statements = {};
+	for (const field of consentFields) {
+		const entry = entries.find((candidate) => candidate.id === field.source);
+		if (!entry) continue;
+		const label = typeof entry.name === "string" && entry.name.trim() !== "" ? entry.name : "";
+		statements[field.name] = {
+			...entry.statement != null ? { statement: entry.statement } : {},
+			...label && typeof entry.url === "string" && entry.url.length > 0 ? { link: {
+				label,
+				url: entry.url
+			} } : {}
+		};
+	}
+	return statements;
+};
+//#endregion
+export { resolveConsentStatements };
+
+//# sourceMappingURL=resolveConsentStatements.js.map

package/dist/consent/resolveConsentStatements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveConsentStatements.js","names":[],"sources":["../../src/consent/resolveConsentStatements.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport { resolveConsentEntries } from './resolveConsentEntries'\nimport type { ConsentSourcesResolver } from './types'\n\n/** What a consent field shows the visitor, resolved from its source at request time. */\nexport type ConsentStatement = {\n\t/** Rich text state (or whatever the host's resolver returned), for the request's locale. */\n\tstatement?: unknown\n\t/** The policy link beside the statement, present only when the source carries both a `url` and a `label`. */\n\tlink?: { label: string; url: string }\n}\n\n/** Resolved statements keyed by consent field name, as `toFormDocument`'s `consentStatements` takes them. */\nexport type ConsentStatements = Record<string, ConsentStatement>\n\nexport type ResolveConsentStatementsArgs = {\n\tpayload: Payload\n\treq: PayloadRequest\n\t/** A loaded forms document; its consent fields' `source` ids drive resolution. The whole doc is forwarded to the resolver. */\n\tform: {\n\t\tid: number | string\n\t\ttitle?: string | null\n\t\tfields?: { blockType: string; name?: string; [key: string]: unknown }[] | null\n\t}\n\t/** Resolver override for plugin-internal callers; defaults to the one the plugin stashed on the config. */\n\tsources?: ConsentSourcesResolver\n}\n\n/**\n * Resolve every consent field's statement for this request, ready to hand to\n * `toFormDocument(doc, { consentStatements })`.\n *\n * The statement is a live reference, not a copy: a form stores only its source id, and the\n * sentence the visitor reads is resolved here, in their locale, from whatever the source says\n * right now. So correcting a policy sentence corrects every form referencing it, with nothing to\n * re-save, and a form rendered without this step shows no statement at all rather than a stale one.\n *\n * Call it server-side (a Server Component, a route handler) before rendering `<Form>`. Throws\n * whatever the host's resolver throws, so a page can decide between failing and rendering without\n * consent; a submit resolves the source again regardless, and the proof is built from that.\n */\nexport const resolveConsentStatements = async (\n\targs: ResolveConsentStatementsArgs\n): Promise<ConsentStatements> => {\n\tconst { payload, req, form, sources } = args\n\tconst consentFields = (form.fields ?? []).filter(\n\t\t(field): field is { blockType: string; name: string; source?: unknown } =>\n\t\t\tfield.blockType === 'consent' && typeof field.name === 'string' && field.name.length > 0\n\t)\n\tif (consentFields.length === 0) {\n\t\treturn {}\n\t}\n\tconst entries = await resolveConsentEntries({ payload, req, form, sources })\n\tconst statements: ConsentStatements = {}\n\tfor (const field of consentFields) {\n\t\tconst entry = entries.find((candidate) => candidate.id === field.source)\n\t\tif (!entry) {\n\t\t\tcontinue\n\t\t}\n\t\t// The link needs a name of its own, so it takes the source's `name` and never falls back to\n\t\t// the `id`: the id is a machine identifier, and showing it as the words a visitor clicks is\n\t\t// worse than no link at all. A source with a url and no name simply has no link.\n\t\tconst label = typeof entry.name === 'string' && entry.name.trim() !== '' ? entry.name : ''\n\t\tstatements[field.name] = {\n\t\t\t...(entry.statement != null ? { statement: entry.statement } : {}),\n\t\t\t...(label && typeof entry.url === 'string' && entry.url.length > 0\n\t\t\t\t? { link: { label, url: entry.url } }\n\t\t\t\t: {}),\n\t\t}\n\t}\n\treturn statements\n}\n"],"mappings":";;;;;;;;;;;;;;;AAyCA,MAAa,2BAA2B,OACvC,SACgC;CAChC,MAAM,EAAE,SAAS,KAAK,MAAM,YAAY;CACxC,MAAM,iBAAiB,KAAK,UAAU,CAAC,GAAG,QACxC,UACA,MAAM,cAAc,aAAa,OAAO,MAAM,SAAS,YAAY,MAAM,KAAK,SAAS,CACzF;CACA,IAAI,cAAc,WAAW,GAC5B,OAAO,CAAC;CAET,MAAM,UAAU,MAAM,sBAAsB;EAAE;EAAS;EAAK;EAAM;CAAQ,CAAC;CAC3E,MAAM,aAAgC,CAAC;CACvC,KAAK,MAAM,SAAS,eAAe;EAClC,MAAM,QAAQ,QAAQ,MAAM,cAAc,UAAU,OAAO,MAAM,MAAM;EACvE,IAAI,CAAC,OACJ;EAKD,MAAM,QAAQ,OAAO,MAAM,SAAS,YAAY,MAAM,KAAK,KAAK,MAAM,KAAK,MAAM,OAAO;EACxF,WAAW,MAAM,QAAQ;GACxB,GAAI,MAAM,aAAa,OAAO,EAAE,WAAW,MAAM,UAAU,IAAI,CAAC;GAChE,GAAI,SAAS,OAAO,MAAM,QAAQ,YAAY,MAAM,IAAI,SAAS,IAC9D,EAAE,MAAM;IAAE;IAAO,KAAK,MAAM;GAAI,EAAE,IAClC,CAAC;EACL;CACD;CACA,OAAO;AACR"}

package/dist/consent/resolvePublishedVersionRef.d.ts

@@ -0,0 +1,23 @@
+import { Payload, PayloadRequest } from "payload";
+
+//#region src/consent/resolvePublishedVersionRef.d.ts
+type ResolvePublishedVersionRefArgs = {
+  payload: Payload;
+  collection: string;
+  id: number | string; /** Threaded into `findVersions` so a version written earlier in the same transaction is visible. */
+  req?: PayloadRequest;
+};
+/**
+ * The id of a document's latest published version, or null when nothing is published.
+ *
+ * Drafts-only, and deliberately not a versions check: `_status` exists only where
+ * `versions.drafts` is on (Payload adds the base version fields inside that branch when
+ * sanitizing), so on a collection with plain versions and no drafts this query matches nothing and
+ * returns null, which is indistinguishable from having no versions at all. Callers must decide the
+ * difference themselves with `hasDraftsEnabled` rather than reading null as "no versions" (see
+ * `captureConsent`). Never throws.
+ */
+declare const resolvePublishedVersionRef: (args: ResolvePublishedVersionRefArgs) => Promise<string | null>;
+//#endregion
+export { ResolvePublishedVersionRefArgs, resolvePublishedVersionRef };
+//# sourceMappingURL=resolvePublishedVersionRef.d.ts.map

package/dist/consent/resolvePublishedVersionRef.js

@@ -0,0 +1,30 @@
+//#region src/consent/resolvePublishedVersionRef.ts
+/**
+* The id of a document's latest published version, or null when nothing is published.
+*
+* Drafts-only, and deliberately not a versions check: `_status` exists only where
+* `versions.drafts` is on (Payload adds the base version fields inside that branch when
+* sanitizing), so on a collection with plain versions and no drafts this query matches nothing and
+* returns null, which is indistinguishable from having no versions at all. Callers must decide the
+* difference themselves with `hasDraftsEnabled` rather than reading null as "no versions" (see
+* `captureConsent`). Never throws.
+*/
+const resolvePublishedVersionRef = async (args) => {
+	try {
+		const doc = (await args.payload.findVersions({
+			collection: args.collection,
+			where: { and: [{ parent: { equals: args.id } }, { "version._status": { equals: "published" } }] },
+			sort: "-updatedAt",
+			limit: 1,
+			depth: 0,
+			req: args.req
+		}))?.docs?.[0];
+		return doc ? String(doc.id) : null;
+	} catch {
+		return null;
+	}
+};
+//#endregion
+export { resolvePublishedVersionRef };
+
+//# sourceMappingURL=resolvePublishedVersionRef.js.map

package/dist/consent/resolvePublishedVersionRef.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePublishedVersionRef.js","names":[],"sources":["../../src/consent/resolvePublishedVersionRef.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\n\nexport type ResolvePublishedVersionRefArgs = {\n\tpayload: Payload\n\tcollection: string\n\tid: number | string\n\t/** Threaded into `findVersions` so a version written earlier in the same transaction is visible. */\n\treq?: PayloadRequest\n}\n\n/**\n * The id of a document's latest published version, or null when nothing is published.\n *\n * Drafts-only, and deliberately not a versions check: `_status` exists only where\n * `versions.drafts` is on (Payload adds the base version fields inside that branch when\n * sanitizing), so on a collection with plain versions and no drafts this query matches nothing and\n * returns null, which is indistinguishable from having no versions at all. Callers must decide the\n * difference themselves with `hasDraftsEnabled` rather than reading null as \"no versions\" (see\n * `captureConsent`). Never throws.\n */\nexport const resolvePublishedVersionRef = async (\n\targs: ResolvePublishedVersionRefArgs\n): Promise<string | null> => {\n\ttry {\n\t\tconst result = await args.payload.findVersions({\n\t\t\tcollection: args.collection as never,\n\t\t\twhere: {\n\t\t\t\tand: [{ parent: { equals: args.id } }, { 'version._status': { equals: 'published' } }],\n\t\t\t},\n\t\t\tsort: '-updatedAt',\n\t\t\tlimit: 1,\n\t\t\tdepth: 0,\n\t\t\treq: args.req,\n\t\t})\n\t\tconst doc = result?.docs?.[0]\n\t\treturn doc ? String(doc.id) : null\n\t} catch {\n\t\treturn null\n\t}\n}\n"],"mappings":";;;;;;;;;;;AAoBA,MAAa,6BAA6B,OACzC,SAC4B;CAC5B,IAAI;EAWH,MAAM,OAAM,MAVS,KAAK,QAAQ,aAAa;GAC9C,YAAY,KAAK;GACjB,OAAO,EACN,KAAK,CAAC,EAAE,QAAQ,EAAE,QAAQ,KAAK,GAAG,EAAE,GAAG,EAAE,mBAAmB,EAAE,QAAQ,YAAY,EAAE,CAAC,EACtF;GACA,MAAM;GACN,OAAO;GACP,OAAO;GACP,KAAK,KAAK;EACX,CAAC,IACmB,OAAO;EAC3B,OAAO,MAAM,OAAO,IAAI,EAAE,IAAI;CAC/B,QAAQ;EACP,OAAO;CACR;AACD"}

package/dist/consent/types.d.ts

@@ -0,0 +1,61 @@
+import { PayloadRequest } from "payload";
+
+//#region src/consent/types.d.ts
+/** A document reference, kept id-based so renaming or re-slugging the page never breaks it. */
+type ConsentSourcePage = {
+  relationTo: string;
+  id: number | string;
+};
+/**
+ * One consent source a form author can reference by `id`: the statement the visitor agrees to, and
+ * optionally the policy document that statement belongs to. Produced by the host's
+ * {@link ConsentSourcesResolver}, normally by mapping the rows of a placed `consentSourcesField()`.
+ *
+ * `id` is the array row's own auto-assigned identifier, so it survives name edits and reordering
+ * and is the stable reference stored on the consent field and in every proof. `statement` is rich
+ * text state (the visitor-facing sentence), already resolved for the request's locale by virtue of
+ * the resolver reading its own localized field under `req.locale`. `page` drives proof: an id and
+ * its collection, never a URL, so the document can be renamed, re-slugged, or re-routed without
+ * stranding past proofs. `url` is the visitor-facing link the renderer shows beside the statement;
+ * only the host knows how a document id maps to a public route, so the plugin never derives one.
+ */
+type ConsentSourceEntry = {
+  id: string;
+  name?: string;
+  statement?: unknown;
+  page?: ConsentSourcePage;
+  url?: string;
+};
+/**
+ * Host seam resolving the consent sources a form's authors can reference (plugin option
+ * `consent.sources`). Without it there are no sources, so the `consent` field type is not
+ * registered at all.
+ *
+ * The intended shape: place `consentSourcesField()` on a collection or global you own, then read it
+ * back here. Multi-tenant hosts scope the read by the tenant derived from `req` (host header,
+ * cookie, or auth context) and return only that tenant's sources, so one tenant's statements are
+ * never selectable, resolvable, or provable under another's. Read under `req.locale` so the
+ * statement the visitor agrees to is the one they were shown.
+ *
+ * Do not thread the save's `req` into a `find({ locale: 'all' })` from within a form's save
+ * validation: it flips `req.locale` to `all` and corrupts the localized write of the document being
+ * saved. Read the settings document without the save's `req` (already-committed data, no transaction).
+ */
+type ConsentSourcesResolver = (args: {
+  req: PayloadRequest;
+  /**
+   * The form document being read: `id`, `title`, and (at runtime) every other field. Derive
+   * multi-tenant scoping from a field on it, casting for non-standard fields (e.g.
+   * `(form as { tenant?: string }).tenant`), rather than reading the form back: reading the same
+   * `forms` collection from within this resolver re-enters the form's afterRead hook. The type is
+   * kept index-signature-free so a generated `Form` interface assigns without a cast. Treat `form`
+   * as read-only.
+   */
+  form: {
+    id: number | string;
+    title?: string | null;
+  };
+}) => ConsentSourceEntry[] | Promise<ConsentSourceEntry[]>;
+//#endregion
+export { ConsentSourceEntry, ConsentSourcePage, ConsentSourcesResolver };
+//# sourceMappingURL=types.d.ts.map