bsmnt 0.5.0 → 0.6.1

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

@@ -0,0 +1,208 @@
+import { stegaClean } from "next-sanity";
+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);
+}

package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/components/same-as-input.tsx

@@ -0,0 +1,66 @@
+import { Badge, Card, Flex, Stack, Text } from "@sanity/ui";
+import { useEffect, useState } from "react";
+import { type ArrayOfPrimitivesInputProps, useClient } from "sanity";
+import { apiVersion } from "../env";
+
+type CompanyProfile = { name?: string | null; url?: string | null };
+
+// Draft-first so editors see unpublished toggle changes.
+export const INCLUDED_COMPANY_PROFILES_QUERY = `coalesce(
+	*[_id == "drafts.companyData"][0],
+	*[_id == "companyData"][0]
+).socialLinks[includeInStructuredData == true]{ name, url }`;
+
+// Shows which Company Data social links are merged into sameAs automatically.
+export function SameAsInput(props: ArrayOfPrimitivesInputProps) {
+	const { renderDefault } = props;
+	const client = useClient({ apiVersion });
+	const [included, setIncluded] = useState<CompanyProfile[]>([]);
+
+	useEffect(() => {
+		let active = true;
+		client
+			.fetch<CompanyProfile[] | null>(INCLUDED_COMPANY_PROFILES_QUERY)
+			.then((rows) => {
+				if (active) setIncluded(rows ?? []);
+			})
+			.catch(() => {
+				// Best-effort preview — never block editing.
+			});
+		return () => {
+			active = false;
+		};
+	}, [client]);
+
+	return (
+		<Stack space={3}>
+			<Card padding={3} radius={2} border tone="transparent">
+				<Stack space={3}>
+					{included.length > 0 ? (
+						<>
+							<Text size={1} muted>
+								Included from Company Data (toggle off there to remove):
+							</Text>
+							{included.map((profile) => (
+								<Flex key={profile.url} gap={2} align="center">
+									<Badge fontSize={0} mode="outline">
+										{profile.name ?? "Profile"}
+									</Badge>
+									<Text size={1} muted textOverflow="ellipsis">
+										{profile.url}
+									</Text>
+								</Flex>
+							))}
+						</>
+					) : (
+						<Text size={1} muted>
+							No Company Data social links are included yet — enable "Include in
+							Structured Data" on a social link to add it here.
+						</Text>
+					)}
+				</Stack>
+			</Card>
+			{renderDefault(props)}
+		</Stack>
+	);
+}

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

@@ -4,19 +4,27 @@ import {
 	COMPANY_DATA_QUERY,
 	FOOTER_QUERY,
 	NAVBAR_QUERY,
+	STRUCTURED_DATA_QUERY,
 } from "@/lib/integrations/sanity/queries";
 import type {
 	COMPANY_DATA_QUERY_RESULT,
 	FOOTER_QUERY_RESULT,
 	NAVBAR_QUERY_RESULT,
+	STRUCTURED_DATA_QUERY_RESULT,
 } from "@/lib/integrations/sanity/sanity.types";
 
 export type NavbarData = NonNullable<NAVBAR_QUERY_RESULT>;
 export type FooterData = NonNullable<FOOTER_QUERY_RESULT>;
 export type CompanyData = NonNullable<COMPANY_DATA_QUERY_RESULT>;
+export type StructuredData = NonNullable<STRUCTURED_DATA_QUERY_RESULT>;
 
 // Singleton document types that, when published, should bust the layout cache.
-export const SANITY_LAYOUT_TAGS = ["navbar", "footer", "companyData"];
+export const SANITY_LAYOUT_TAGS = [
+	"navbar",
+	"footer",
+	"companyData",
+	"structuredData",
+];
 
 // Wrapped in React cache so components sharing a singleton (e.g. Footer + JsonLd
 // both reading companyData) only hit Sanity once per request.
@@ -46,3 +54,14 @@ export const getCompanyData = cache(async (): Promise<CompanyData | null> => {
 
 	return data ?? null;
 });
+
+export const getStructuredData = cache(
+	async (): Promise<StructuredData | null> => {
+		const { data } = await fetchSanity<StructuredData>({
+			query: STRUCTURED_DATA_QUERY,
+			tags: ["structuredData"],
+		});
+
+		return data ?? null;
+	},
+);

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

@@ -1,9 +1,14 @@
 import type { Icon, IconProps } from "@phosphor-icons/react";
 import {
+	AppWindowIcon,
 	ArrowBendUpRightIcon,
 	ArticleNyTimesIcon,
+	BracketsCurlyIcon,
+	BriefcaseIcon,
 	BrowsersIcon,
 	BuildingsIcon,
+	CalendarBlankIcon,
+	CardsIcon,
 	FileTextIcon,
 	FolderOpenIcon,
 	FootprintsIcon,
@@ -12,12 +17,15 @@ import {
 	ListIcon,
 	PackageIcon,
 	PushPinIcon,
+	QuestionIcon,
 	RocketIcon,
 	ShapesIcon,
 	ShareNetworkIcon,
 	TagIcon,
 	TextAlignLeftIcon,
+	TreeStructureIcon,
 	UserCircleIcon,
+	VideoCameraIcon,
 } from "@phosphor-icons/react/dist/ssr";
 import { createElement, forwardRef } from "react";
 
@@ -50,6 +58,15 @@ export const navbarIcon = asDuotoneIcon(ListIcon);
 export const footerIcon = asDuotoneIcon(FootprintsIcon);
 export const redirectIcon = asDuotoneIcon(ArrowBendUpRightIcon);
 export const layoutFolderIcon = asDuotoneIcon(LayoutIcon);
+export const structuredDataIcon = asDuotoneIcon(TreeStructureIcon);
+
+export const faqJsonLdIcon = asDuotoneIcon(QuestionIcon);
+export const eventJsonLdIcon = asDuotoneIcon(CalendarBlankIcon);
+export const videoJsonLdIcon = asDuotoneIcon(VideoCameraIcon);
+export const jobPostingJsonLdIcon = asDuotoneIcon(BriefcaseIcon);
+export const softwareApplicationJsonLdIcon = asDuotoneIcon(AppWindowIcon);
+export const itemListJsonLdIcon = asDuotoneIcon(CardsIcon);
+export const customJsonLdIcon = asDuotoneIcon(BracketsCurlyIcon);
 
 export const heroIcon = asDuotoneIcon(RocketIcon);
 export const descriptionIcon = asDuotoneIcon(TextAlignLeftIcon);

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

@@ -361,6 +361,21 @@ const footerProjection = `
   }
 `;
 
+// sameAs: flagged Company Data social links + manual profiles, deduped.
+const structuredDataProjection = `
+  name,
+  legalName,
+  description,
+  url,
+  "logo": logo.asset->url,
+  contactPoint,
+  address,
+  "sameAs": array::unique(array::compact(
+    coalesce(*[_type == "companyData"][0].socialLinks[includeInStructuredData == true].url, [])
+    + coalesce(sameAs, [])
+  ))
+`;
+
 export const NAVBAR_QUERY = defineQuery(`
   *[_type == "navbar"][0]{
     ${navbarProjection}
@@ -374,6 +389,13 @@ export const FOOTER_QUERY = defineQuery(`
   }
 `);
 
+// Structured Data (site-wide JSON-LD identity)
+export const STRUCTURED_DATA_QUERY = defineQuery(`
+  *[_type == "structuredData"][0]{
+    ${structuredDataProjection}
+  }
+`);
+
 // Redirects -- source/destination rules applied by the proxy.
 // `source` is a slug; flatten to its slash-free path string.
 export const REDIRECTS_QUERY = defineQuery(`

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

@@ -15,6 +15,7 @@ import { companyData } from "./layout/company-data";
 import { footer } from "./layout/footer";
 import { navbar } from "./layout/navbar";
 import { redirect } from "./layout/redirect";
+import { structuredData } from "./layout/structured-data";
 import { externalLink, link, pageReference } from "./shared/link";
 import { metadata } from "./shared/metadata";
 import {
@@ -27,6 +28,15 @@ import { page } from "./shared/page";
 import { pageBuilder } from "./shared/page-builder";
 import { pageFolder } from "./shared/page-folder";
 import { richText } from "./shared/richText";
+import {
+	customJsonLd,
+	eventJsonLd,
+	faqJsonLd,
+	itemListJsonLd,
+	jobPostingJsonLd,
+	softwareApplicationJsonLd,
+	videoJsonLd,
+} from "./shared/structured-data-blocks";
 
 // Re-export all schemas for convenience
 export {
@@ -35,10 +45,15 @@ export {
 	blogCollection,
 	blogContent,
 	companyData,
+	customJsonLd,
 	description,
+	eventJsonLd,
 	externalLink,
+	faqJsonLd,
 	footer,
 	hero,
+	itemListJsonLd,
+	jobPostingJsonLd,
 	link,
 	metadata,
 	navbar,
@@ -52,6 +67,9 @@ export {
 	pageReference,
 	redirect,
 	richText,
+	softwareApplicationJsonLd,
+	structuredData,
+	videoJsonLd,
 };
 
 // Schema collection for Sanity configuration
@@ -65,6 +83,15 @@ export const schema: { types: SchemaTypeDefinition[] } = {
 		pageBuilder,
 		richText,
 
+		// Page-level JSON-LD blocks (selectable in metadata)
+		faqJsonLd,
+		eventJsonLd,
+		videoJsonLd,
+		jobPostingJsonLd,
+		softwareApplicationJsonLd,
+		itemListJsonLd,
+		customJsonLd,
+
 		// Navigation object types (used by navbar)
 		navLeafItem,
 		navColumn,
@@ -81,6 +108,7 @@ export const schema: { types: SchemaTypeDefinition[] } = {
 		companyData,
 		navbar,
 		footer,
+		structuredData,
 
 		// Layout collections (managed lists, not singletons)
 		redirect,

package/src/modules/features/cms/sanity-pagebuilder/files/lib/integrations/sanity/schemas/layout/company-data.ts

@@ -42,6 +42,14 @@ export const companyData = defineType({
 							description:
 								"Accessible label for the link (e.g. 'Follow us on LinkedIn')",
 						}),
+						defineField({
+							name: "includeInStructuredData",
+							title: "Include in Structured Data",
+							type: "boolean",
+							description:
+								"Add this profile to the site's JSON-LD (schema.org sameAs) emitted for search engines.",
+							initialValue: false,
+						}),
 					],
 					preview: {
 						select: {

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

@@ -0,0 +1,124 @@
+import { defineField, defineType } from "sanity";
+import {
+	INCLUDED_COMPANY_PROFILES_QUERY,
+	SameAsInput,
+} from "@/lib/integrations/sanity/components/same-as-input";
+import { apiVersion } from "@/lib/integrations/sanity/env";
+import { structuredDataIcon } from "@/lib/integrations/sanity/icons";
+
+export const structuredData = defineType({
+	name: "structuredData",
+	title: "Structured Data",
+	type: "document",
+	icon: structuredDataIcon,
+	description:
+		"Site-wide identity emitted as JSON-LD (schema.org Organization + WebSite) on every page for search engines.",
+	fields: [
+		defineField({
+			name: "name",
+			title: "Organization Name",
+			type: "string",
+			description: "Public name of the organization (shown in rich results).",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "legalName",
+			title: "Legal Name",
+			type: "string",
+			description:
+				"Registered legal entity name, if different from the public name.",
+		}),
+		defineField({
+			name: "logo",
+			title: "Logo",
+			type: "image",
+			description:
+				"Square or wide logo used in rich results. Min 112x112px, transparent PNG/SVG recommended.",
+			options: { hotspot: true },
+		}),
+		defineField({
+			name: "description",
+			title: "Description",
+			type: "text",
+			rows: 3,
+			description: "Short sentence describing the organization.",
+		}),
+		defineField({
+			name: "url",
+			title: "Canonical URL",
+			type: "url",
+			description:
+				"Optional override for the canonical site URL. Defaults to the deployed origin.",
+		}),
+		defineField({
+			name: "contactPoint",
+			title: "Contact Point",
+			type: "object",
+			options: { collapsible: true, collapsed: true },
+			fields: [
+				defineField({ name: "email", title: "Email", type: "string" }),
+				defineField({ name: "telephone", title: "Telephone", type: "string" }),
+				defineField({
+					name: "contactType",
+					title: "Contact Type",
+					type: "string",
+					description:
+						"e.g. 'customer support', 'sales', 'press'. See schema.org/ContactPoint.",
+				}),
+			],
+		}),
+		defineField({
+			name: "address",
+			title: "Address",
+			type: "object",
+			options: { collapsible: true, collapsed: true },
+			fields: [
+				defineField({
+					name: "streetAddress",
+					title: "Street Address",
+					type: "string",
+				}),
+				defineField({ name: "locality", title: "City", type: "string" }),
+				defineField({
+					name: "region",
+					title: "Region / State",
+					type: "string",
+				}),
+				defineField({
+					name: "postalCode",
+					title: "Postal Code",
+					type: "string",
+				}),
+				defineField({ name: "country", title: "Country", type: "string" }),
+			],
+		}),
+		defineField({
+			name: "sameAs",
+			title: "Same-As Profiles",
+			type: "array",
+			description:
+				"Additional official profiles representing this organization (LinkedIn, X, GitHub, etc.). Company Data social links with 'Include in Structured Data' enabled are merged in automatically.",
+			of: [
+				{
+					type: "url",
+					validation: (Rule) =>
+						Rule.custom(async (value, context) => {
+							if (!value) return true;
+							const client = context.getClient({ apiVersion });
+							const included = await client.fetch<
+								{ url?: string | null }[] | null
+							>(INCLUDED_COMPANY_PROFILES_QUERY);
+							return (included ?? []).some((p) => p.url === value)
+								? "Already included from Company Data — remove it here or toggle it off there."
+								: true;
+						}),
+				},
+			],
+			validation: (Rule) => Rule.unique(),
+			components: { input: SameAsInput },
+		}),
+	],
+	preview: {
+		prepare: () => ({ title: "Structured Data" }),
+	},
+});

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

@@ -1,4 +1,5 @@
-import { defineField, defineType } from "sanity";
+import { defineArrayMember, defineField, defineType } from "sanity";
+import { pageJsonLdMembers } from "./structured-data-blocks";
 
 export const metadata = defineType({
 	name: "metadata",
@@ -46,6 +47,16 @@ export const metadata = defineType({
 			description: "Allow search engines to index this page",
 			initialValue: true,
 		}),
+		defineField({
+			name: "jsonLd",
+			title: "Structured Data (JSON-LD)",
+			type: "array",
+			description:
+				"Page-level schema.org structured data emitted as JSON-LD. Pick a predefined type, or add a Custom JSON-LD block for anything not listed.",
+			of: pageJsonLdMembers.map((member) =>
+				defineArrayMember({ type: member.name }),
+			),
+		}),
 		defineField({
 			name: "title",
 			title: "Legacy Meta Title",