bsmnt 0.5.0 → 0.6.0

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

@@ -0,0 +1,416 @@
+import { defineArrayMember, defineField, defineType } from "sanity";
+
+/**
+ * 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",
+	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",
+	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",
+	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",
+	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",
+	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",
+	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",
+	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/files/lib/integrations/sanity/schemas/structured-data.ts

@@ -0,0 +1,100 @@
+import { defineField, defineType } from "sanity";
+
+export const structuredData = defineType({
+	name: "structuredData",
+	title: "Structured Data",
+	type: "document",
+	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: "sameAs",
+			title: "Same-As Profiles",
+			type: "array",
+			description:
+				"Official profiles representing this organization (LinkedIn, X, GitHub, Crunchbase, Wikipedia, etc.).",
+			of: [{ type: "url" }],
+		}),
+		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" }),
+			],
+		}),
+	],
+	preview: {
+		prepare: () => ({ title: "Structured Data" }),
+	},
+});

package/src/modules/features/cms/sanity/files/lib/integrations/sanity/structure.ts

@@ -1,5 +1,40 @@
+import {
+	ComponentIcon,
+	DocumentsIcon,
+	MenuIcon,
+	SchemaIcon,
+	ThLargeIcon,
+} from "@sanity/icons";
 import type { StructureResolver } from "sanity/structure";
 
-// https://www.sanity.io/docs/structure-builder-cheat-sheet
+// Explicit menu: new schema types must be listed here, which keeps plugin
+// types (e.g. media.tag) out of the Studio.
 export const structure: StructureResolver = (S) =>
-	S.list().title("Content").items(S.documentTypeListItems());
+	S.list()
+		.title("Content")
+		.items([
+			S.documentTypeListItem("article").title("Articles").icon(DocumentsIcon),
+			S.documentTypeListItem("example").title("Examples").icon(ComponentIcon),
+			S.documentTypeListItem("navigation").title("Navigation").icon(MenuIcon),
+			S.divider(),
+			// Layout — site-wide singletons.
+			S.listItem()
+				.title("Layout")
+				.id("layout")
+				.icon(ThLargeIcon)
+				.child(
+					S.list()
+						.title("Layout")
+						.items([
+							S.listItem()
+								.title("Structured Data")
+								.id("structuredData")
+								.icon(SchemaIcon)
+								.child(
+									S.document()
+										.schemaType("structuredData")
+										.documentId("structuredData"),
+								),
+						]),
+				),
+		]);