Zod schemas and content

Zod schemas

Every component ships with a matching Zod schema, exported from @casoon/astro-structured-data/zod. The components validate their props with exactly these schemas, and the prop types are exported from the same entry point (ArticleProps, EventProps, ProductProps, …).

import {
  articleZodSchema,
  eventZodSchema,
  faqZodSchema,
  productZodSchema,
} from '@casoon/astro-structured-data/zod';

Available: articleZodSchema, autoBreadcrumbZodSchema, breadcrumbZodSchema, collectionPageZodSchema, eventZodSchema, faqZodSchema, jobPostingZodSchema, localBusinessZodSchema, organizationZodSchema, productZodSchema, profilePageZodSchema, recipeZodSchema, softwareAppZodSchema, videoZodSchema, webPageZodSchema, webSiteZodSchema.

The exported schemas ignore unknown top-level keys, so they can be used directly for content collections whose frontmatter has additional fields. The components themselves are strict.

Validating frontmatter with the schema the component uses reports wrong data in the file where it is written:

// src/content.config.ts
import { defineCollection } from 'astro:content';
import { glob } from 'astro/loaders';
import { eventZodSchema } from '@casoon/astro-structured-data/zod';

const events = defineCollection({
  loader: glob({ pattern: '**/*.md', base: './src/content/events' }),
  schema: eventZodSchema,
});

export const collections = { events };

The same schemas work for form validation or any other runtime validation.

Recommended fields

validateRecommended checks a schema object for missing recommended fields, matching what the build warning reports:

import { validateRecommended } from '@casoon/astro-structured-data/zod';
import type { SchemaType, RecommendedWarning } from '@casoon/astro-structured-data/zod';

const warnings: RecommendedWarning[] = validateRecommended('Organization', {
  name: 'ACME Corp',
  url: 'https://acme.com',
});
// → [{ field: 'sameAs', message: 'Organization should include "sameAs" ...' }, ...]

A recommended property counts as present when any prop producing it is set: offers or priceRange cover price and priceCurrency. Pass your integration options as third argument to count configured defaults (defaultBrand, defaultArticlePublisher, defaultLocalBusiness):

validateRecommended('Product', { name: 'Widget', offers }, { defaultBrand: 'ACME' });

Recommended fields are optional props that Google’s rich result guidelines list as strongly beneficial; leaving them out does not break validation but may reduce how rich the search result is. Each recommended prop is declared once in the Zod schema together with the schema.org property it produces, and both validateRecommended (on props) and the build report (on the rendered JSON-LD) are derived from that declaration.

The first argument is a schema.org @type name: Article, BlogPosting, NewsArticle, FAQPage, Product, LocalBusiness, Event, Organization, WebPage, WebSite, ProfilePage, JobPosting, SoftwareApplication, CollectionPage, BreadcrumbList, Recipe, VideoObject.

Reading time

calculateReadingTime counts words in plain text or HTML and returns the reading time, for wordCount and readingTimeMinutes on ArticleSchema:

---
import { calculateReadingTime } from '@casoon/astro-structured-data/utils';
import { ArticleSchema } from '@casoon/astro-structured-data/components';
import { getEntry } from 'astro:content';

const post = await getEntry('blog', Astro.params.slug);
const { wordCount, readingTimeMinutes } = calculateReadingTime(post.body);
---
<ArticleSchema
  title={post.data.title}
  description={post.data.description}
  datePublished={post.data.date}
  authorName={post.data.author}
  wordCount={wordCount}
  readingTimeMinutes={readingTimeMinutes}
/>