bsmnt 0.4.3 → 0.6.0

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/link.ts

@@ -0,0 +1,125 @@
+import { defineArrayMember, defineField, defineType } from "sanity";
+
+/**
+ * Page Reference -- internal link to a Sanity page document.
+ */
+export const pageReference = defineType({
+	name: "pageReference",
+	title: "Page",
+	type: "object",
+	fields: [
+		defineField({
+			name: "page",
+			title: "Page",
+			type: "reference",
+			to: [{ type: "page" }],
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "openInNewTab",
+			title: "Open in New Tab",
+			type: "boolean",
+			initialValue: false,
+		}),
+	],
+	preview: {
+		select: {
+			text: "text",
+			pageTitle: "page.title",
+		},
+		prepare({ text, pageTitle }) {
+			return {
+				title: text || pageTitle || "Untitled",
+				subtitle: pageTitle ? `Page: ${pageTitle}` : "Page Reference",
+			};
+		},
+	},
+});
+
+/**
+ * External Link -- URL pointing outside the site (or to pages not yet in Sanity).
+ */
+export const externalLink = defineType({
+	name: "externalLink",
+	title: "URL",
+	type: "object",
+	fields: [
+		defineField({
+			name: "href",
+			title: "URL",
+			type: "url",
+			validation: (Rule) =>
+				Rule.required().uri({
+					scheme: ["http", "https", "mailto", "tel"],
+					allowRelative: true,
+				}),
+		}),
+		defineField({
+			name: "openInNewTab",
+			title: "Open in New Tab",
+			type: "boolean",
+			initialValue: false,
+		}),
+	],
+	preview: {
+		select: {
+			text: "text",
+			href: "href",
+		},
+		prepare({ text, href }) {
+			return {
+				title: text || href || "Untitled",
+				subtitle: href ? `URL: ${href}` : "External Link",
+			};
+		},
+	},
+});
+
+/**
+ * Link -- array-of-one wrapper that accepts either a page reference or external URL.
+ * Editors click "Add" and pick which type they need.
+ */
+export const link = defineType({
+	name: "link",
+	title: "Link",
+	type: "array",
+	of: [
+		defineArrayMember({ type: "pageReference" }),
+		defineArrayMember({ type: "externalLink" }),
+	],
+	validation: (Rule) => Rule.max(1),
+});
+
+/**
+ * Annotations for Portable Text -- both link types as separate mark annotations.
+ */
+export const linkAnnotations = [
+	defineArrayMember({ type: "pageReference" }),
+	defineArrayMember({ type: "externalLink" }),
+];
+
+// Helper field exports for easy reuse
+export const linkField = defineField({
+	name: "link",
+	title: "Link",
+	type: "link",
+});
+
+type LinkFieldOptions = {
+	name?: string;
+	title?: string;
+	required?: boolean;
+};
+
+export function extendedLinkField({
+	name = "link",
+	title = "Link",
+	required = false,
+}: LinkFieldOptions = {}) {
+	return defineField({
+		name,
+		title,
+		type: "link",
+		validation: required ? (Rule) => Rule.required().min(1) : undefined,
+	});
+}

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

@@ -0,0 +1,9 @@
+import { defineField } from "sanity";
+
+export const logoField = defineField({
+	name: "logo",
+	title: "Logo",
+	type: "image",
+	options: { hotspot: true },
+	validation: (Rule) => Rule.required(),
+});

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

@@ -0,0 +1,79 @@
+import { defineArrayMember, defineField, defineType } from "sanity";
+import { pageJsonLdMembers } from "./structured-data-blocks";
+
+export const metadata = defineType({
+	name: "metadata",
+	title: "SEO & Metadata",
+	type: "object",
+	options: {
+		collapsible: true,
+		collapsed: true,
+	},
+	fields: [
+		defineField({
+			name: "metaTitle",
+			title: "Meta Title",
+			type: "string",
+			description: "Title used by search engines",
+			validation: (Rule) =>
+				Rule.max(60).warning(
+					"Title should be under 60 characters for optimal SEO",
+				),
+		}),
+		defineField({
+			name: "metaDescription",
+			title: "Meta Description",
+			type: "text",
+			rows: 3,
+			description: "Description used by search engines",
+			validation: (Rule) =>
+				Rule.max(160).warning(
+					"Description should be under 160 characters for optimal SEO",
+				),
+		}),
+		defineField({
+			name: "image",
+			title: "OG Image",
+			type: "image",
+			description: "Image for social sharing previews (1200x630px recommended)",
+			options: {
+				hotspot: true,
+			},
+		}),
+		defineField({
+			name: "index",
+			title: "Index",
+			type: "boolean",
+			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",
+			type: "string",
+			hidden: true,
+		}),
+		defineField({
+			name: "description",
+			title: "Legacy Meta Description",
+			type: "text",
+			hidden: true,
+		}),
+		defineField({
+			name: "noIndex",
+			title: "Legacy No Index",
+			type: "boolean",
+			hidden: true,
+		}),
+	],
+});

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

@@ -0,0 +1,192 @@
+import { defineArrayMember, defineField, defineType } from "sanity";
+
+/**
+ * Nav Leaf Item
+ *
+ * Individual navigation link within a menu column.
+ */
+export const navLeafItem = defineType({
+	name: "navLeafItem",
+	title: "Navigation Link",
+	type: "object",
+	fields: [
+		defineField({
+			name: "title",
+			title: "Title",
+			type: "string",
+			description: "Display text for the navigation link",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "link",
+			title: "Link",
+			type: "link",
+			description:
+				"Optional -- leave empty for items with pages not yet created",
+		}),
+	],
+	preview: {
+		select: {
+			title: "title",
+			internalTitle: "link.0.page.title",
+			externalHref: "link.0.href",
+		},
+		prepare({ title, internalTitle, externalHref }) {
+			return {
+				title: title || "Untitled Link",
+				subtitle: internalTitle || externalHref || "",
+			};
+		},
+	},
+});
+
+/**
+ * Nav Column
+ *
+ * A column within a mega-menu containing a group of leaf items.
+ * Title is optional to support unnamed column groups (e.g. Company's first column).
+ * Link is optional -- some column headers are clickable (Products), some are labels only (Solutions).
+ */
+export const navColumn = defineType({
+	name: "navColumn",
+	title: "Menu Column",
+	type: "object",
+	fields: [
+		defineField({
+			name: "title",
+			title: "Column Title",
+			type: "string",
+			description:
+				"Column header text. Leave empty for unnamed groups (e.g. Company's first column).",
+		}),
+		defineField({
+			name: "link",
+			title: "Column Link",
+			type: "link",
+			description:
+				"Optional -- makes the column header clickable (e.g. Products column headers link to section pages)",
+		}),
+		defineField({
+			name: "items",
+			title: "Items",
+			type: "array",
+			of: [defineArrayMember({ type: "navLeafItem" })],
+			description: "Navigation links within this column",
+		}),
+	],
+	preview: {
+		select: {
+			title: "title",
+			items: "items",
+		},
+		prepare({ title, items }) {
+			const itemCount = items?.length ?? 0;
+			return {
+				title: title || "Unnamed Column",
+				subtitle: `${itemCount} item${itemCount === 1 ? "" : "s"}`,
+			};
+		},
+	},
+});
+
+/**
+ * Nav Menu
+ *
+ * The content of a menu dropdown panel.
+ * Contains columns of navigation links.
+ */
+export const navMegaMenu = defineType({
+	name: "navMegaMenu",
+	title: "Menu",
+	type: "object",
+	fields: [
+		defineField({
+			name: "columns",
+			title: "Columns",
+			type: "array",
+			of: [defineArrayMember({ type: "navColumn" })],
+			validation: (Rule) => Rule.required().min(1),
+			description: "Column groups within the menu dropdown",
+		}),
+	],
+	preview: {
+		select: {
+			columns: "columns",
+		},
+		prepare({ columns }) {
+			const colCount = columns?.length ?? 0;
+			return {
+				title: "Menu",
+				subtitle: `${colCount} column${colCount === 1 ? "" : "s"}`,
+			};
+		},
+	},
+});
+
+/**
+ * Nav Item
+ *
+ * A top-level navigation item. Discriminated union:
+ * - "link" type: a simple direct navigation link (e.g. Customers, Resources, Pricing)
+ * - "mega-menu" type: opens a multi-column dropdown panel (e.g. Products, Solutions, Company)
+ */
+export const navItem = defineType({
+	name: "navItem",
+	title: "Navigation Item",
+	type: "object",
+	fields: [
+		defineField({
+			name: "title",
+			title: "Title",
+			type: "string",
+			description: "Display text in the navigation bar",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "itemType",
+			title: "Item Type",
+			type: "string",
+			options: {
+				list: [
+					{ title: "Direct Link", value: "link" },
+					{ title: "Menu", value: "mega-menu" },
+				],
+				layout: "radio",
+			},
+			initialValue: "link",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "link",
+			title: "Link",
+			type: "link",
+			description: "Destination for direct link items",
+			hidden: ({ parent }) => parent?.itemType !== "link",
+		}),
+		defineField({
+			name: "megaMenu",
+			title: "Menu",
+			type: "navMegaMenu",
+			description: "Dropdown menu content with columns",
+			hidden: ({ parent }) => parent?.itemType !== "mega-menu",
+		}),
+	],
+	preview: {
+		select: {
+			title: "title",
+			itemType: "itemType",
+			columns: "megaMenu.columns",
+		},
+		prepare({ title, itemType, columns }) {
+			const colCount = columns?.length ?? 0;
+			const subtitle =
+				itemType === "mega-menu"
+					? `Menu (${colCount} column${colCount === 1 ? "" : "s"})`
+					: "Direct Link";
+			return {
+				title: title || "Untitled Item",
+				subtitle,
+			};
+		},
+	},
+});

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

@@ -0,0 +1,39 @@
+import { defineArrayMember, defineType } from "sanity";
+import { PageBuilderInput } from "@/lib/integrations/sanity/components/page-builder-input";
+import {
+	pageBuilderInsertMenuGroups,
+	pageBuilderReferenceMembers,
+} from "@/lib/integrations/sanity/page-builder-config";
+
+export const pageBuilder = defineType({
+	name: "pageBuilder",
+	title: "Page Builder",
+	type: "array",
+	components: { input: PageBuilderInput },
+	options: {
+		insertMenu: {
+			filter: true,
+			groups: pageBuilderInsertMenuGroups,
+		},
+	},
+	of: pageBuilderReferenceMembers.map((member) =>
+		defineArrayMember({
+			name: member.name,
+			title: member.title,
+			type: "reference",
+			to: [{ type: member.documentType }],
+			...(member.documentId
+				? {
+						options: {
+							disableNew: true,
+							filter: "_id in [$documentId, $draftDocumentId]",
+							filterParams: {
+								documentId: member.documentId,
+								draftDocumentId: `drafts.${member.documentId}`,
+							},
+						},
+					}
+				: {}),
+		}),
+	),
+});

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

@@ -0,0 +1,124 @@
+import { defineField, defineType } from "sanity";
+import { apiVersion } from "@/lib/integrations/sanity/env";
+import { pageFolderIcon } from "@/lib/integrations/sanity/icons";
+
+type FolderValidationDocument = {
+	_id?: string;
+};
+
+export const pageFolder = defineType({
+	name: "pageFolder",
+	title: "Page Folder",
+	type: "document",
+	icon: pageFolderIcon,
+	fields: [
+		defineField({
+			name: "title",
+			title: "Title",
+			type: "string",
+			validation: (Rule) => Rule.required(),
+		}),
+		defineField({
+			name: "parentFolder",
+			title: "Parent Folder",
+			type: "reference",
+			to: [{ type: "pageFolder" }],
+			description: "Optional parent folder for nesting inside the Pages tree.",
+			hidden: true,
+			options: {
+				disableNew: true,
+				filter: ({ document }) => {
+					const currentId = (document as FolderValidationDocument | undefined)
+						?._id;
+					const normalizedId = currentId?.replace(/^drafts\./, "");
+
+					return normalizedId
+						? {
+								filter: `_type == "pageFolder" && !(_id in [$id, "drafts." + $id])`,
+								params: { id: normalizedId },
+							}
+						: { filter: `_type == "pageFolder"` };
+				},
+			},
+			validation: (Rule) =>
+				Rule.custom((value, context) => {
+					const document = context.document as
+						| FolderValidationDocument
+						| undefined;
+					const currentId = document?._id?.replace(/^drafts\./, "");
+
+					if (value?._ref && currentId && value._ref === currentId) {
+						return "A folder cannot be its own parent";
+					}
+
+					return true;
+				}),
+		}),
+		defineField({
+			name: "slug",
+			title: "Slug",
+			type: "slug",
+			description:
+				"Required full folder path for organization, for example blog or blog/guides.",
+			options: {
+				source: "title",
+				maxLength: 200,
+			},
+			validation: (Rule) =>
+				Rule.required().custom(async (slug, context) => {
+					if (!slug?.current) {
+						return "Slug is required";
+					}
+
+					if (!/^[a-z0-9-/]+$/.test(slug.current)) {
+						return "Slug must be lowercase with hyphens, letters, numbers, and forward slashes only";
+					}
+
+					if (slug.current.startsWith("/") || slug.current.endsWith("/")) {
+						return "Slug must not start or end with a forward slash";
+					}
+
+					const document = context.document as
+						| FolderValidationDocument
+						| undefined;
+					const id = document?._id?.replace(/^drafts\./, "");
+
+					if (!id) return true;
+
+					const client = context.getClient({ apiVersion });
+					const existing = await client.fetch<number>(
+						`count(*[
+              _type == "pageFolder" &&
+              slug.current == $slug &&
+              !(_id in [$id, "drafts." + $id])
+            ])`,
+						{
+							slug: slug.current,
+							id,
+						},
+					);
+
+					return existing === 0 || "Another page folder already uses this slug";
+				}),
+		}),
+	],
+	preview: {
+		select: {
+			title: "title",
+			slug: "slug.current",
+		},
+		prepare({ title, slug }) {
+			return {
+				title: title || "Untitled Folder",
+				subtitle: slug ? `/${slug}` : "Folder",
+			};
+		},
+	},
+	orderings: [
+		{
+			title: "Title A-Z",
+			name: "titleAsc",
+			by: [{ field: "title", direction: "asc" }],
+		},
+	],
+});