bsmnt 0.5.0 → 0.6.0

package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/shared/structured-data-blocks.ts

@@ -0,0 +1,436 @@
+import { defineArrayMember, defineField, defineType } from "sanity";
+import {
+	customJsonLdIcon,
+	eventJsonLdIcon,
+	faqJsonLdIcon,
+	itemListJsonLdIcon,
+	jobPostingJsonLdIcon,
+	softwareApplicationJsonLdIcon,
+	videoJsonLdIcon,
+} from "@/lib/integrations/sanity/icons";
+
+/**
+ * Editor-selectable JSON-LD blocks (predefined schema.org types + a raw
+ * `customJsonLd` escape hatch), each emitted as its own script tag.
+ */
+
+export const faqJsonLd = defineType({
+	name: "faqJsonLd",
+	title: "FAQ",
+	type: "object",
+	icon: faqJsonLdIcon,
+	fields: [
+		defineField({
+			name: "questions",
+			title: "Questions",
+			type: "array",
+			validation: (Rule) => Rule.min(1),
+			of: [
+				defineArrayMember({
+					type: "object",
+					fields: [
+						defineField({
+							name: "question",
+							title: "Question",
+							type: "string",
+							validation: (Rule) => Rule.required(),
+						}),
+						defineField({
+							name: "answer",
+							title: "Answer",
+							type: "text",
+							rows: 3,
+							validation: (Rule) => Rule.required(),
+						}),
+					],
+					preview: {
+						select: { title: "question", subtitle: "answer" },
+					},
+				}),
+			],
+		}),
+	],
+	preview: {
+		select: { questions: "questions" },
+		prepare: ({ questions }) => ({
+			title: "FAQ",
+			subtitle: `${Array.isArray(questions) ? questions.length : 0} question(s)`,
+		}),
+	},
+});
+
+export const jobPostingJsonLd = defineType({
+	name: "jobPostingJsonLd",
+	title: "Job Posting",
+	type: "object",
+	icon: jobPostingJsonLdIcon,
+	fields: [
+		defineField({
+			name: "title",
+			title: "Job Title",
+			type: "string",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "description",
+			title: "Description",
+			type: "text",
+			rows: 4,
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "datePosted",
+			title: "Date Posted",
+			type: "datetime",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "validThrough",
+			title: "Valid Through",
+			type: "datetime",
+			description: "When the posting expires.",
+		}),
+		defineField({
+			name: "employmentType",
+			title: "Employment Type",
+			type: "string",
+			options: {
+				list: [
+					{ title: "Full-time", value: "FULL_TIME" },
+					{ title: "Part-time", value: "PART_TIME" },
+					{ title: "Contractor", value: "CONTRACTOR" },
+					{ title: "Temporary", value: "TEMPORARY" },
+					{ title: "Intern", value: "INTERN" },
+					{ title: "Volunteer", value: "VOLUNTEER" },
+					{ title: "Per diem", value: "PER_DIEM" },
+					{ title: "Other", value: "OTHER" },
+				],
+			},
+		}),
+		defineField({
+			name: "organizationName",
+			title: "Hiring Organization",
+			type: "string",
+		}),
+		defineField({
+			name: "organizationUrl",
+			title: "Organization URL",
+			type: "url",
+		}),
+		defineField({
+			name: "remote",
+			title: "Remote / Telecommute",
+			type: "boolean",
+			initialValue: false,
+		}),
+		defineField({ name: "locality", title: "City", type: "string" }),
+		defineField({ name: "region", title: "Region / State", type: "string" }),
+		defineField({ name: "country", title: "Country", type: "string" }),
+	],
+	preview: {
+		select: { title: "title", subtitle: "organizationName" },
+		prepare: ({ title, subtitle }) => ({
+			title: title || "Job Posting",
+			subtitle: subtitle ? `Job · ${subtitle}` : "Job Posting",
+		}),
+	},
+});
+
+export const softwareApplicationJsonLd = defineType({
+	name: "softwareApplicationJsonLd",
+	title: "Software Application",
+	type: "object",
+	icon: softwareApplicationJsonLdIcon,
+	fields: [
+		defineField({
+			name: "name",
+			title: "Name",
+			type: "string",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "description",
+			title: "Description",
+			type: "text",
+			rows: 2,
+		}),
+		defineField({
+			name: "applicationCategory",
+			title: "Application Category",
+			type: "string",
+			options: {
+				list: [
+					{ title: "Web application", value: "WebApplication" },
+					{ title: "Mobile application", value: "MobileApplication" },
+					{ title: "Developer tool", value: "DeveloperApplication" },
+					{ title: "Business application", value: "BusinessApplication" },
+					{ title: "Design application", value: "DesignApplication" },
+					{ title: "Game", value: "GameApplication" },
+				],
+			},
+		}),
+		defineField({
+			name: "operatingSystem",
+			title: "Operating System",
+			type: "string",
+			description: "e.g. 'Web', 'macOS, Windows', 'iOS, Android'.",
+		}),
+		defineField({
+			name: "price",
+			title: "Price",
+			type: "number",
+			description: "Use 0 for free apps. Enables the rich result.",
+		}),
+		defineField({
+			name: "currency",
+			title: "Currency",
+			type: "string",
+			description: "ISO 4217 code, e.g. USD, EUR.",
+			initialValue: "USD",
+		}),
+		defineField({ name: "url", title: "URL", type: "url" }),
+		defineField({ name: "image", title: "Screenshot / Icon", type: "image" }),
+	],
+	preview: {
+		select: { title: "name", subtitle: "applicationCategory" },
+		prepare: ({ title, subtitle }) => ({
+			title: title || "Software Application",
+			subtitle: subtitle ? `App · ${subtitle}` : "Software Application",
+		}),
+	},
+});
+
+export const itemListJsonLd = defineType({
+	name: "itemListJsonLd",
+	title: "Item List / Carousel",
+	type: "object",
+	icon: itemListJsonLdIcon,
+	description:
+		"An ordered list of links (e.g. a carousel of articles or products). Each item points to a page on your site.",
+	fields: [
+		defineField({
+			name: "name",
+			title: "List Name",
+			type: "string",
+			description: "Optional title for the list.",
+		}),
+		defineField({
+			name: "items",
+			title: "Items",
+			type: "array",
+			validation: (Rule) => Rule.min(1),
+			of: [
+				defineArrayMember({
+					type: "object",
+					fields: [
+						defineField({
+							name: "name",
+							title: "Name",
+							type: "string",
+							validation: (Rule) => Rule.required(),
+						}),
+						defineField({
+							name: "url",
+							title: "URL",
+							type: "url",
+							validation: (Rule) => Rule.required(),
+						}),
+					],
+					preview: {
+						select: { title: "name", subtitle: "url" },
+					},
+				}),
+			],
+		}),
+	],
+	preview: {
+		select: { title: "name", items: "items" },
+		prepare: ({ title, items }) => ({
+			title: title || "Item List / Carousel",
+			subtitle: `${Array.isArray(items) ? items.length : 0} item(s)`,
+		}),
+	},
+});
+
+export const eventJsonLd = defineType({
+	name: "eventJsonLd",
+	title: "Event",
+	type: "object",
+	icon: eventJsonLdIcon,
+	fields: [
+		defineField({
+			name: "name",
+			title: "Name",
+			type: "string",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "description",
+			title: "Description",
+			type: "text",
+			rows: 2,
+		}),
+		defineField({
+			name: "startDate",
+			title: "Start Date",
+			type: "datetime",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({ name: "endDate", title: "End Date", type: "datetime" }),
+		defineField({
+			name: "locationName",
+			title: "Location Name",
+			type: "string",
+			description: "Venue name, or leave blank for online events.",
+		}),
+		defineField({
+			name: "locationAddress",
+			title: "Location Address",
+			type: "string",
+		}),
+		defineField({
+			name: "url",
+			title: "Event URL",
+			type: "url",
+		}),
+		defineField({ name: "image", title: "Image", type: "image" }),
+	],
+	preview: {
+		select: { title: "name", subtitle: "startDate" },
+		prepare: ({ title, subtitle }) => ({
+			title: title || "Event",
+			subtitle: subtitle ? `Event · ${subtitle}` : "Event",
+		}),
+	},
+});
+
+export const videoJsonLd = defineType({
+	name: "videoJsonLd",
+	title: "Video",
+	type: "object",
+	icon: videoJsonLdIcon,
+	fields: [
+		defineField({
+			name: "name",
+			title: "Name",
+			type: "string",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "description",
+			title: "Description",
+			type: "text",
+			rows: 2,
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "thumbnail",
+			title: "Thumbnail",
+			type: "image",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "uploadDate",
+			title: "Upload Date",
+			type: "datetime",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "contentUrl",
+			title: "Content URL",
+			type: "url",
+			description: "Direct link to the video file (.mp4, etc.).",
+		}),
+		defineField({
+			name: "embedUrl",
+			title: "Embed URL",
+			type: "url",
+			description: "Player embed URL (YouTube, Vimeo, etc.).",
+		}),
+	],
+	preview: {
+		select: { title: "name" },
+		prepare: ({ title }) => ({
+			title: title || "Video",
+			subtitle: "Video",
+		}),
+	},
+});
+
+export const customJsonLd = defineType({
+	name: "customJsonLd",
+	title: "Custom JSON-LD",
+	type: "object",
+	icon: customJsonLdIcon,
+	description:
+		"Optional JSON-LD block for advanced rich results (FAQ, Product, HowTo, etc.). Emits its own <script> tag. Validate snippets with https://search.google.com/test/rich-results — invalid blocks are skipped at render time.",
+	fields: [
+		defineField({
+			name: "label",
+			title: "Internal Label",
+			type: "string",
+			description:
+				"For your reference only (e.g. 'FAQ – pricing tiers'). Not emitted.",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "json",
+			title: "JSON-LD",
+			type: "text",
+			rows: 10,
+			description:
+				"Paste a single schema.org JSON-LD object. Omit the <script> wrapper. Must include an @type (@context is added automatically if omitted).",
+			validation: (Rule) =>
+				Rule.required().custom((value) => {
+					if (typeof value !== "string" || value.trim() === "") {
+						return "JSON-LD is required";
+					}
+					try {
+						const parsed = JSON.parse(value);
+						if (Array.isArray(parsed)) {
+							return "Use one block per entry (split arrays into multiple blocks).";
+						}
+						if (typeof parsed !== "object" || parsed === null) {
+							return "Must be a JSON object.";
+						}
+						if (!("@type" in parsed)) {
+							return 'Must include an @type (e.g. "@type": "FAQPage").';
+						}
+						return true;
+					} catch {
+						return "Invalid JSON. Use https://jsonlint.com to debug.";
+					}
+				}),
+		}),
+	],
+	preview: {
+		select: { title: "label", subtitle: "json" },
+		prepare: ({ title, subtitle }) => {
+			let type: string | undefined;
+			if (typeof subtitle === "string") {
+				try {
+					const parsed = JSON.parse(subtitle);
+					if (parsed && typeof parsed === "object" && "@type" in parsed) {
+						type = String(parsed["@type"]);
+					}
+				} catch {
+					// ignore — render-time skips invalid blocks
+				}
+			}
+			return {
+				title: title || "Custom JSON-LD",
+				subtitle: type ? `@type: ${type}` : "JSON-LD",
+			};
+		},
+	},
+});
+
+export const pageJsonLdMembers = [
+	faqJsonLd,
+	eventJsonLd,
+	videoJsonLd,
+	jobPostingJsonLd,
+	softwareApplicationJsonLd,
+	itemListJsonLd,
+	customJsonLd,
+] as const;

package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/singletons.ts

@@ -1,4 +1,10 @@
-import { companyDataIcon, footerIcon, navbarIcon, pageListIcon } from "./icons";
+import {
+	companyDataIcon,
+	footerIcon,
+	navbarIcon,
+	pageListIcon,
+	structuredDataIcon,
+} from "./icons";
 
 export const singletonComponents = [
 	{
@@ -28,6 +34,12 @@ export const singletonLayout = [
 		title: "Footer",
 		icon: footerIcon,
 	},
+	{
+		schemaType: "structuredData",
+		documentId: "structuredData",
+		title: "Structured Data",
+		icon: structuredDataIcon,
+	},
 ] as const;
 
 export const singletonComponentTypes: Set<string> = new Set(

package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/utils/page-json-ld.ts

@@ -0,0 +1,208 @@
+import { stegaClean } from "@sanity/client/stega";
+import type { Thing, WithContext } from "schema-dts";
+import {
+	type FaqJsonLdItem,
+	generateEventJsonLd,
+	generateFaqJsonLd,
+	generateItemListJsonLd,
+	generateJobPostingJsonLd,
+	generateSoftwareApplicationJsonLd,
+	generateVideoJsonLd,
+	type ItemListEntry,
+} from "@/lib/utils/json-ld";
+import { urlForImage } from "./image";
+
+/**
+ * Turns `metadata.jsonLd` blocks from Sanity into renderable JSON-LD —
+ * stega-cleaned, with image refs resolved to absolute CDN URLs.
+ */
+
+type SanityImageRef = Parameters<typeof urlForImage>[0];
+
+type JsonLdBlock = {
+	_type?: string;
+	_key?: string;
+	[key: string]: unknown;
+};
+
+const clean = (value: unknown): string | undefined => {
+	const cleaned = stegaClean(value);
+	return typeof cleaned === "string" && cleaned.trim() !== ""
+		? cleaned
+		: undefined;
+};
+
+const resolveImage = (value: unknown): string | undefined => {
+	if (!value || typeof value !== "object") return undefined;
+	try {
+		return urlForImage(value as SanityImageRef).url();
+	} catch {
+		return undefined;
+	}
+};
+
+const buildFaq = (block: JsonLdBlock): WithContext<Thing> | null => {
+	const questions = Array.isArray(block.questions) ? block.questions : [];
+	const items = questions
+		.map((entry): FaqJsonLdItem | null => {
+			const question = clean((entry as JsonLdBlock)?.question);
+			const answer = clean((entry as JsonLdBlock)?.answer);
+			return question && answer ? { question, answer } : null;
+		})
+		.filter((item): item is FaqJsonLdItem => item !== null);
+	return items.length ? generateFaqJsonLd(items) : null;
+};
+
+const buildJobPosting = (block: JsonLdBlock): WithContext<Thing> | null => {
+	const title = clean(block.title);
+	const description = clean(block.description);
+	const datePosted = clean(block.datePosted);
+	if (!title || !description || !datePosted) return null;
+	return generateJobPostingJsonLd({
+		title,
+		description,
+		datePosted,
+		validThrough: clean(block.validThrough),
+		employmentType: clean(block.employmentType),
+		organizationName: clean(block.organizationName),
+		organizationUrl: clean(block.organizationUrl),
+		remote: block.remote === true,
+		locality: clean(block.locality),
+		region: clean(block.region),
+		country: clean(block.country),
+	});
+};
+
+const buildSoftwareApplication = (
+	block: JsonLdBlock,
+): WithContext<Thing> | null => {
+	const name = clean(block.name);
+	if (!name) return null;
+	const priceValue = stegaClean(block.price);
+	const price =
+		typeof priceValue === "number" && Number.isFinite(priceValue)
+			? priceValue
+			: undefined;
+	return generateSoftwareApplicationJsonLd({
+		name,
+		description: clean(block.description),
+		applicationCategory: clean(block.applicationCategory),
+		operatingSystem: clean(block.operatingSystem),
+		price,
+		currency: clean(block.currency),
+		url: clean(block.url),
+		image: resolveImage(block.image),
+	});
+};
+
+const buildItemList = (block: JsonLdBlock): WithContext<Thing> | null => {
+	const rawItems = Array.isArray(block.items) ? block.items : [];
+	const items = rawItems
+		.map((entry): ItemListEntry | null => {
+			const name = clean((entry as JsonLdBlock)?.name);
+			if (!name) return null;
+			return { name, url: clean((entry as JsonLdBlock)?.url) };
+		})
+		.filter((item): item is ItemListEntry => item !== null);
+	if (!items.length) return null;
+	return generateItemListJsonLd({ name: clean(block.name), items });
+};
+
+const buildEvent = (block: JsonLdBlock): WithContext<Thing> | null => {
+	const name = clean(block.name);
+	const startDate = clean(block.startDate);
+	if (!name || !startDate) return null;
+	return generateEventJsonLd({
+		name,
+		startDate,
+		endDate: clean(block.endDate),
+		description: clean(block.description),
+		locationName: clean(block.locationName),
+		locationAddress: clean(block.locationAddress),
+		url: clean(block.url),
+		image: resolveImage(block.image),
+	});
+};
+
+const buildVideo = (block: JsonLdBlock): WithContext<Thing> | null => {
+	const name = clean(block.name);
+	const description = clean(block.description);
+	const uploadDate = clean(block.uploadDate);
+	const thumbnail = resolveImage(block.thumbnail);
+	if (!name || !description || !uploadDate || !thumbnail) return null;
+	return generateVideoJsonLd({
+		name,
+		description,
+		thumbnail,
+		uploadDate,
+		contentUrl: clean(block.contentUrl),
+		embedUrl: clean(block.embedUrl),
+	});
+};
+
+const buildCustom = (block: JsonLdBlock): WithContext<Thing> | null => {
+	const raw = clean(block.json);
+	if (!raw) return null;
+	try {
+		const parsed = JSON.parse(raw);
+		// Skip structurally-incomplete blocks: schema.org requires an @type.
+		if (
+			typeof parsed !== "object" ||
+			parsed === null ||
+			Array.isArray(parsed) ||
+			!("@type" in parsed)
+		) {
+			return null;
+		}
+		// Default @context so editors can omit the boilerplate (an explicit
+		// @context in the pasted object always wins).
+		return {
+			"@context": "https://schema.org",
+			...parsed,
+		} as WithContext<Thing>;
+	} catch {
+		return null;
+	}
+};
+
+export type PageJsonLd = { key: string; data: WithContext<Thing> };
+
+export function buildPageJsonLd(blocks: unknown): PageJsonLd[] {
+	if (!Array.isArray(blocks)) return [];
+
+	return blocks
+		.map((entry, index): PageJsonLd | null => {
+			const block = entry as JsonLdBlock;
+			let data: WithContext<Thing> | null;
+			switch (block._type) {
+				case "faqJsonLd":
+					data = buildFaq(block);
+					break;
+				case "eventJsonLd":
+					data = buildEvent(block);
+					break;
+				case "videoJsonLd":
+					data = buildVideo(block);
+					break;
+				case "jobPostingJsonLd":
+					data = buildJobPosting(block);
+					break;
+				case "softwareApplicationJsonLd":
+					data = buildSoftwareApplication(block);
+					break;
+				case "itemListJsonLd":
+					data = buildItemList(block);
+					break;
+				case "customJsonLd":
+					data = buildCustom(block);
+					break;
+				default:
+					data = null;
+			}
+			if (!data) return null;
+			const key =
+				typeof block._key === "string" ? block._key : `jsonld-${index}`;
+			return { key, data };
+		})
+		.filter((item): item is PageJsonLd => item !== null);
+}