@bison-lab/payload-blocks 2.0.0

package/dist/index.mjs

@@ -0,0 +1,677 @@
+//#region src/fields/image.ts
+/**
+* A single image from the site's upload collection, for any block with a
+* picture in it.
+*
+* Optional unless the block says otherwise: `imageField({ name: 'portrait',
+* required: true })`. `admin` is replaced, not merged, so a block that passes
+* its own description writes the whole thing.
+*/
+function imageField(overrides = {}) {
+	return {
+		name: "image",
+		type: "upload",
+		relationTo: "media",
+		...overrides.required ? {} : { admin: { description: "Optional." } },
+		...overrides
+	};
+}
+//#endregion
+//#region src/fields/link.ts
+/**
+* The three fields a call to action is made of, unwrapped.
+*
+* `href` is plain text rather than a relationship to a `pages` row: a block in
+* this package has to work on a site whose page collection is named something
+* else, or which links out more often than in. Resolving an internal reference
+* is the site's job.
+*
+* `newTab` drives `target="_blank"` *and* the matching `rel`, which is why no
+* renderer takes one without the other.
+*/
+function linkFields({ required = false, labelFieldLabel = "Label" } = {}) {
+	return [
+		{
+			name: "label",
+			type: "text",
+			label: labelFieldLabel,
+			required
+		},
+		{
+			name: "href",
+			type: "text",
+			required,
+			admin: { description: "A site path (\"/contact\") or a full URL (\"https://example.com\")." }
+		},
+		{
+			name: "newTab",
+			type: "checkbox",
+			label: "Open in a new tab",
+			defaultValue: false
+		}
+	];
+}
+/** `linkFields()` as one named group, for a block with a single CTA. */
+function linkField({ name = "link", label, admin, ...rest } = {}) {
+	return {
+		name,
+		type: "group",
+		fields: linkFields(rest),
+		...label === void 0 ? {} : { label },
+		...admin === void 0 ? {} : { admin }
+	};
+}
+//#endregion
+//#region src/blocks/hero/config.ts
+/**
+* The band a page opens with.
+*
+* Unlike every other block here this one has no `@bison-lab/ui` counterpart:
+* a hero is where a site's brand is loudest, and the shipped renderer is
+* deliberately plain markup so a site can swap in its own by overriding this
+* one registry entry. The *fields* are the shared part — that is what makes a
+* page portable between sites.
+*/
+const HeroBlock = {
+	slug: "hero",
+	interfaceName: "HeroBlock",
+	labels: {
+		singular: "Hero",
+		plural: "Heroes"
+	},
+	fields: [
+		{
+			name: "eyebrow",
+			type: "text",
+			admin: { description: "Small label above the heading. Optional." }
+		},
+		{
+			name: "heading",
+			type: "text",
+			required: true
+		},
+		{
+			name: "body",
+			type: "textarea"
+		},
+		{
+			name: "tone",
+			type: "select",
+			defaultValue: "sweep",
+			options: [
+				{
+					label: "Sweep (brand gradient)",
+					value: "sweep"
+				},
+				{
+					label: "Dark (flat brand band)",
+					value: "dark"
+				},
+				{
+					label: "Light (page background)",
+					value: "light"
+				}
+			],
+			admin: { description: "How the band is painted. Sites map these to their own surfaces." }
+		},
+		imageField({ admin: { description: "Optional background or lead image." } }),
+		{
+			name: "links",
+			type: "array",
+			maxRows: 2,
+			labels: {
+				singular: "Call to action",
+				plural: "Calls to action"
+			},
+			fields: linkFields({ required: true })
+		}
+	]
+};
+//#endregion
+//#region src/blocks/rich-text/config.ts
+/** A prose section: one Lexical document at reading measure. */
+const RichTextBlock = {
+	slug: "richText",
+	interfaceName: "RichTextBlock",
+	labels: {
+		singular: "Rich Text",
+		plural: "Rich Text"
+	},
+	fields: [{
+		name: "content",
+		type: "richText",
+		required: true
+	}]
+};
+//#endregion
+//#region src/blocks/showcase-panels/config.ts
+/** Expanding panels, one per service or product line. */
+const ShowcasePanelsBlock = {
+	slug: "showcasePanels",
+	interfaceName: "ShowcasePanelsBlock",
+	labels: {
+		singular: "Showcase Panels",
+		plural: "Showcase Panels"
+	},
+	fields: [
+		{
+			name: "items",
+			type: "array",
+			required: true,
+			minRows: 3,
+			maxRows: 6,
+			labels: {
+				singular: "Panel",
+				plural: "Panels"
+			},
+			fields: [
+				{
+					name: "title",
+					type: "text",
+					required: true
+				},
+				{
+					name: "summary",
+					type: "textarea",
+					required: true,
+					admin: { description: "Revealed when the panel expands." }
+				},
+				imageField({ required: true }),
+				{
+					name: "href",
+					type: "text",
+					admin: { description: "Optional \"read more\" destination for this panel." }
+				},
+				{
+					name: "numeral",
+					type: "text",
+					admin: { description: "Overrides the spine numeral (\"01\", \"II\"). Leave empty to number automatically." }
+				}
+			]
+		},
+		{
+			name: "spineVariant",
+			type: "select",
+			defaultValue: "numbered",
+			options: [
+				{
+					label: "Numbered (01, 02)",
+					value: "numbered"
+				},
+				{
+					label: "Volume (I, II)",
+					value: "volume"
+				},
+				{
+					label: "Minimal (no numeral)",
+					value: "minimal"
+				}
+			]
+		},
+		{
+			name: "watermark",
+			type: "text",
+			admin: { description: "Faint mark behind the panels, e.g. a brand word." }
+		},
+		{
+			name: "defaultActiveIndex",
+			type: "number",
+			defaultValue: 0,
+			min: 0,
+			admin: { description: "Which panel is open on load, counting from 0." }
+		},
+		{
+			name: "ariaLabel",
+			type: "text",
+			admin: { description: "Names the region for screen readers. Defaults to \"Showcase panels\"." }
+		},
+		{
+			name: "labels",
+			type: "group",
+			admin: { description: "Overrides for the panel state text." },
+			fields: [{
+				name: "selected",
+				type: "text"
+			}, {
+				name: "preview",
+				type: "text"
+			}]
+		}
+	]
+};
+//#endregion
+//#region src/blocks/process-steps/config.ts
+/** An ordered walkthrough that advances on its own. */
+const ProcessStepsBlock = {
+	slug: "processSteps",
+	interfaceName: "ProcessStepsBlock",
+	labels: {
+		singular: "Process Steps",
+		plural: "Process Steps"
+	},
+	fields: [
+		{
+			name: "items",
+			type: "array",
+			required: true,
+			minRows: 3,
+			maxRows: 6,
+			labels: {
+				singular: "Step",
+				plural: "Steps"
+			},
+			fields: [
+				{
+					name: "title",
+					type: "text",
+					required: true
+				},
+				{
+					name: "description",
+					type: "textarea",
+					required: true
+				},
+				imageField({ required: true }),
+				{
+					name: "step",
+					type: "number",
+					min: 1,
+					admin: { description: "Overrides the displayed number. Leave empty to number by position." }
+				}
+			]
+		},
+		{
+			name: "autoAdvance",
+			type: "checkbox",
+			defaultValue: true,
+			admin: { description: "Advance on a timer. Always off for visitors who prefer reduced motion." }
+		},
+		{
+			name: "autoAdvanceDuration",
+			type: "number",
+			defaultValue: 6e3,
+			min: 1e3,
+			admin: { description: "Milliseconds each step holds before advancing." }
+		},
+		{
+			name: "pauseOnHover",
+			type: "checkbox",
+			defaultValue: true
+		},
+		{
+			name: "defaultActiveIndex",
+			type: "number",
+			defaultValue: 0,
+			min: 0,
+			admin: { description: "Which step is active on load, counting from 0." }
+		},
+		{
+			name: "ariaLabel",
+			type: "text",
+			admin: { description: "Names the region for screen readers. Defaults to \"Process steps\"." }
+		},
+		{
+			name: "labels",
+			type: "group",
+			admin: { description: "Overrides for the play/pause control text." },
+			fields: [{
+				name: "pause",
+				type: "text"
+			}, {
+				name: "resume",
+				type: "text"
+			}]
+		}
+	]
+};
+//#endregion
+//#region src/fields/heading.ts
+/**
+* The eyebrow / title / description trio every marketing band opens with.
+*
+* They are three top-level fields rather than a group: editors read a section
+* heading as the first thing in the block, and burying it one collapse deep
+* puts the least-optional copy behind a click. The field names match the
+* `@bison-lab/ui` prop names so the renderers stay a pass-through.
+*/
+function headingFields({ required = true, eyebrowDescription = "Small label above the heading. Leave empty to hide the row." } = {}) {
+	return [
+		{
+			name: "eyebrow",
+			type: "text",
+			admin: { description: eyebrowDescription }
+		},
+		{
+			name: "title",
+			type: "text",
+			required
+		},
+		{
+			name: "description",
+			type: "textarea"
+		}
+	];
+}
+//#endregion
+//#region src/blocks/faq-columns/config.ts
+/** A sticky intro beside a column of questions. */
+const FaqColumnsBlock = {
+	slug: "faqColumns",
+	interfaceName: "FaqColumnsBlock",
+	labels: {
+		singular: "FAQ Columns",
+		plural: "FAQ Columns"
+	},
+	fields: [
+		...headingFields(),
+		{
+			name: "items",
+			type: "array",
+			required: true,
+			minRows: 1,
+			labels: {
+				singular: "Question",
+				plural: "Questions"
+			},
+			fields: [{
+				name: "question",
+				type: "text",
+				required: true
+			}, {
+				name: "answer",
+				type: "textarea",
+				required: true
+			}]
+		},
+		{
+			name: "cta",
+			type: "group",
+			label: "Call to action",
+			admin: { description: "Shown under the intro. Leave the link empty to hide it." },
+			fields: [
+				{
+					name: "title",
+					type: "text",
+					admin: { description: "Lead-in line, e.g. \"Still have questions?\"." }
+				},
+				{
+					name: "linkText",
+					type: "text"
+				},
+				{
+					name: "href",
+					type: "text"
+				},
+				{
+					name: "newTab",
+					type: "checkbox",
+					label: "Open in a new tab",
+					defaultValue: false
+				}
+			]
+		},
+		{
+			name: "sticky",
+			type: "checkbox",
+			defaultValue: true,
+			admin: { description: "Pin the intro column while the answers scroll." }
+		},
+		{
+			name: "type",
+			type: "select",
+			defaultValue: "single",
+			options: [{
+				label: "One answer open at a time",
+				value: "single"
+			}, {
+				label: "Several answers open at once",
+				value: "multiple"
+			}]
+		},
+		{
+			name: "collapsible",
+			type: "checkbox",
+			defaultValue: true,
+			admin: { description: "Allow the open answer to be closed again. Single mode only." }
+		}
+	]
+};
+//#endregion
+//#region src/blocks/testimonial-masonry/config.ts
+/** Quotes in a masonry grid, clipped behind a fade once there are enough. */
+const TestimonialMasonryBlock = {
+	slug: "testimonialMasonry",
+	interfaceName: "TestimonialMasonryBlock",
+	labels: {
+		singular: "Testimonial Masonry",
+		plural: "Testimonial Masonry"
+	},
+	fields: [
+		...headingFields(),
+		{
+			name: "items",
+			type: "array",
+			required: true,
+			minRows: 1,
+			labels: {
+				singular: "Testimonial",
+				plural: "Testimonials"
+			},
+			fields: [{
+				name: "content",
+				type: "textarea",
+				required: true,
+				label: "Quote"
+			}, {
+				name: "author",
+				type: "group",
+				fields: [
+					{
+						name: "name",
+						type: "text",
+						required: true
+					},
+					{
+						name: "title",
+						type: "text",
+						admin: { description: "Role or organisation, e.g. \"Orthopaedic surgeon\"." }
+					},
+					imageField({
+						name: "avatar",
+						admin: { description: "Optional. Initials from the name are used when empty." }
+					})
+				]
+			}]
+		},
+		linkField({
+			label: "Link",
+			admin: { description: "Shown under the fade, once there are enough quotes to clip." }
+		}),
+		{
+			name: "minItemsForFade",
+			type: "number",
+			defaultValue: 7,
+			min: 1,
+			admin: { description: "How many quotes before the grid clips and the bottom fade appears." }
+		},
+		{
+			name: "maxVisibleRows",
+			type: "number",
+			min: 1,
+			admin: { description: "Rows shown before the fade. Optional." }
+		}
+	]
+};
+//#endregion
+//#region src/blocks/nap/config.ts
+/**
+* Name, address, phone — the block local SEO is graded on.
+*
+* The `e164` phone number is a separate field from the displayed one because
+* `NapBlock` uses it, and only it, for the `tel:` href and the JSON-LD
+* `telephone`. A prettified string can never silently become an unreachable
+* link.
+*/
+const NapBlock = {
+	slug: "nap",
+	interfaceName: "NapBlock",
+	labels: {
+		singular: "Name, Address, Phone",
+		plural: "Name, Address, Phone"
+	},
+	fields: [
+		{
+			name: "businessName",
+			type: "text",
+			required: true,
+			label: "Business name"
+		},
+		{
+			name: "businessType",
+			type: "text",
+			required: true,
+			defaultValue: "LocalBusiness",
+			admin: { description: "schema.org type, e.g. \"MedicalBusiness\", \"Chiropractor\", \"LocalBusiness\"." }
+		},
+		{
+			name: "address",
+			type: "group",
+			fields: [
+				{
+					name: "streetAddress",
+					type: "text",
+					required: true
+				},
+				{
+					name: "addressLocality",
+					type: "text",
+					required: true,
+					label: "City"
+				},
+				{
+					name: "addressRegion",
+					type: "text",
+					required: true,
+					label: "State or region"
+				},
+				{
+					name: "postalCode",
+					type: "text",
+					required: true
+				},
+				{
+					name: "addressCountry",
+					type: "text",
+					defaultValue: "US",
+					admin: { description: "ISO 3166-1 alpha-2, e.g. US." }
+				}
+			]
+		},
+		{
+			name: "departments",
+			type: "array",
+			required: true,
+			minRows: 1,
+			labels: {
+				singular: "Department",
+				plural: "Departments"
+			},
+			admin: { description: "A single-location business has one entry, usually named after the business." },
+			fields: [
+				{
+					name: "name",
+					type: "text",
+					required: true
+				},
+				{
+					name: "departmentType",
+					type: "text",
+					admin: { description: "schema.org type for this department. Falls back to the business type." }
+				},
+				{
+					name: "phoneE164",
+					type: "text",
+					required: true,
+					label: "Phone (E.164)",
+					admin: { description: "Dialable form, e.g. \"+15551234567\". This is what the tel: link and the structured data use." }
+				},
+				{
+					name: "phoneDisplay",
+					type: "text",
+					label: "Phone (as displayed)",
+					admin: { description: "Optional. US numbers are formatted automatically when this is empty." }
+				}
+			]
+		},
+		{
+			name: "url",
+			type: "text",
+			admin: { description: "Canonical URL for the business. Optional." }
+		},
+		{
+			name: "showName",
+			type: "checkbox",
+			defaultValue: true,
+			admin: { description: "Turn off when a heading above the block already names the business." }
+		},
+		{
+			name: "headingLevel",
+			type: "select",
+			defaultValue: "h2",
+			options: [
+				{
+					label: "H2",
+					value: "h2"
+				},
+				{
+					label: "H3",
+					value: "h3"
+				},
+				{
+					label: "H4",
+					value: "h4"
+				}
+			],
+			admin: { description: "Keeps the page's heading order intact." }
+		},
+		{
+			name: "emitJsonLd",
+			type: "checkbox",
+			defaultValue: true,
+			label: "Emit structured data",
+			admin: { description: "Adds a schema.org LocalBusiness script. Turn off if the page emits its own." }
+		}
+	]
+};
+//#endregion
+//#region src/media.ts
+function isMediaDoc(value) {
+	return typeof value === "object" && value !== null;
+}
+/**
+* Narrows an upload value to something renderable, or `undefined`.
+*
+* `undefined` covers three cases a renderer must treat identically: the field
+* is empty, `depth: 0` left it as a bare id, or the document exists but has no
+* `url` yet (an upload mid-flight). A renderer that gets `undefined` omits the
+* image rather than emitting a broken `<img>`.
+*
+* `alt` is always a string: the media collection requires it, but a draft saved
+* before that validation ran can still reach a renderer, and an `alt` of
+* `undefined` would silently drop the attribute entirely.
+*/
+function resolveMedia(value) {
+	if (!isMediaDoc(value)) return void 0;
+	const { url, alt, width, height } = value;
+	if (typeof url !== "string" || url.length === 0) return void 0;
+	return {
+		src: url,
+		alt: typeof alt === "string" ? alt : "",
+		...typeof width === "number" ? { width } : {},
+		...typeof height === "number" ? { height } : {}
+	};
+}
+//#endregion
+export { FaqColumnsBlock, HeroBlock, NapBlock, ProcessStepsBlock, RichTextBlock, ShowcasePanelsBlock, TestimonialMasonryBlock, headingFields, imageField, linkField, linkFields, resolveMedia };
+
+//# sourceMappingURL=index.mjs.map