sanity-plugin-seofields 1.3.1 → 1.4.0

package/dist/schema/next.d.cts

@@ -0,0 +1,438 @@
+import { JSX } from 'react';
+import { x as SchemaOrgAggregateRatingData, y as SchemaOrgArticleData, z as SchemaOrgBlogPostingData, A as SchemaOrgBrandData, B as SchemaOrgBreadcrumbListData, C as SchemaOrgContactPointData, D as SchemaOrgCourseData, E as SchemaOrgEventData, F as SchemaOrgFAQPageData, G as SchemaOrgHowToData, H as SchemaOrgImageObjectData, I as SchemaOrgLocalBusinessData, J as SchemaOrgOfferData, K as SchemaOrgOrganizationData, L as SchemaOrgPersonData, M as SchemaOrgPlaceData, N as SchemaOrgPostalAddressData, P as SchemaOrgProductData, Q as SchemaOrgReviewData, R as SchemaOrgSoftwareApplicationData, T as SchemaOrgVideoObjectData, U as SchemaOrgWebApplicationData, V as SchemaOrgWebPageData, W as SchemaOrgWebsiteData } from '../types-CVaAX7uy.cjs';
+import { S as SanityImage } from '../types-R3n9Fu4w.cjs';
+
+/**
+ * <SchemaOrgScripts> — Renders multiple Schema.org JSON-LD script tags
+ * from a combined `schemaOrg` array field.
+ *
+ * @example
+ * ```tsx
+ * import { SchemaOrgScripts } from 'sanity-plugin-seofields/next'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "settings"][0]{ structuredData }` })
+ *
+ * <SchemaOrgScripts data={data.structuredData} />
+ * ```
+ */
+
+interface SchemaOrgScriptsProps {
+    /** Array of Schema.org items from the combined `schemaOrg` field. */
+    data?: Array<Record<string, unknown>> | null;
+}
+/**
+ * Renders one `<script type="application/ld+json">` tag per Schema.org item.
+ * Skips items that fail validation (missing required fields).
+ */
+declare function SchemaOrgScripts({ data }: SchemaOrgScriptsProps): JSX.Element | null;
+
+interface AggregateRatingSchemaProps {
+    data?: SchemaOrgAggregateRatingData | null;
+}
+declare function buildAggregateRatingJsonLd(data?: SchemaOrgAggregateRatingData | null): Record<string, unknown> | null;
+declare function AggregateRatingSchema({ data }: AggregateRatingSchemaProps): JSX.Element | null;
+
+interface ArticleSchemaProps {
+    /** The Schema.org Article data from your Sanity GROQ query. */
+    data?: SchemaOrgArticleData | null;
+}
+/**
+ * Builds a Schema.org Article JSON-LD object from Sanity data.
+ * Returns `null` if required fields (headline) are missing.
+ */
+declare function buildArticleJsonLd(data?: SchemaOrgArticleData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Article data.
+ * Renders nothing if required fields are missing.
+ */
+declare function ArticleSchema({ data }: ArticleSchemaProps): JSX.Element | null;
+
+interface BlogPostingSchemaProps {
+    /** The Schema.org BlogPosting data from your Sanity GROQ query. */
+    data?: SchemaOrgBlogPostingData | null;
+}
+/**
+ * Builds a Schema.org BlogPosting JSON-LD object from Sanity data.
+ * Returns `null` if required fields (headline) are missing.
+ */
+declare function buildBlogPostingJsonLd(data?: SchemaOrgBlogPostingData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org BlogPosting data.
+ * Renders nothing if required fields are missing.
+ */
+declare function BlogPostingSchema({ data }: BlogPostingSchemaProps): JSX.Element | null;
+
+interface BrandSchemaProps {
+    data?: SchemaOrgBrandData | null;
+}
+declare function buildBrandJsonLd(data?: SchemaOrgBrandData | null): Record<string, unknown> | null;
+declare function BrandSchema({ data }: BrandSchemaProps): JSX.Element | null;
+
+interface BreadcrumbListSchemaProps {
+    /** The Schema.org BreadcrumbList data from your Sanity GROQ query. */
+    data?: SchemaOrgBreadcrumbListData | null;
+}
+/**
+ * Builds a Schema.org BreadcrumbList JSON-LD object from Sanity data.
+ * Returns `null` if data is missing.
+ */
+declare function buildBreadcrumbListJsonLd(data?: SchemaOrgBreadcrumbListData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org BreadcrumbList data.
+ * Renders nothing if data is missing.
+ */
+declare function BreadcrumbListSchema({ data }: BreadcrumbListSchemaProps): JSX.Element | null;
+
+interface ContactPointSchemaProps {
+    data?: SchemaOrgContactPointData | null;
+}
+declare function buildContactPointJsonLd(data?: SchemaOrgContactPointData | null): Record<string, unknown> | null;
+declare function ContactPointSchema({ data }: ContactPointSchemaProps): JSX.Element | null;
+
+/**
+ * <CourseSchema> — Renders Schema.org Course JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { CourseSchema } from 'sanity-plugin-seofields/next/course'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "course"][0]{ seo }` })
+ *
+ * <CourseSchema data={data.seo} />
+ * ```
+ */
+
+interface CourseSchemaProps {
+    /** The Schema.org Course data from your Sanity GROQ query. */
+    data?: SchemaOrgCourseData | null;
+}
+/**
+ * Builds a Schema.org Course JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildCourseJsonLd(data?: SchemaOrgCourseData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Course data.
+ * Renders nothing if required fields are missing.
+ */
+declare function CourseSchema({ data }: CourseSchemaProps): JSX.Element | null;
+
+interface EventSchemaProps {
+    /** The Schema.org Event data from your Sanity GROQ query. */
+    data?: SchemaOrgEventData | null;
+}
+/**
+ * Builds a Schema.org Event JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildEventJsonLd(data?: SchemaOrgEventData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Event data.
+ * Renders nothing if required fields are missing.
+ */
+declare function EventSchema({ data }: EventSchemaProps): JSX.Element | null;
+
+interface FAQPageSchemaProps {
+    /** The Schema.org FAQPage data from your Sanity GROQ query. */
+    data?: SchemaOrgFAQPageData | null;
+}
+/**
+ * Builds a Schema.org FAQPage JSON-LD object from Sanity data.
+ * Returns `null` if data is missing.
+ */
+declare function buildFAQPageJsonLd(data?: SchemaOrgFAQPageData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org FAQPage data.
+ * Renders nothing if data is missing.
+ */
+declare function FAQPageSchema({ data }: FAQPageSchemaProps): JSX.Element | null;
+
+interface HowToSchemaProps {
+    /** The Schema.org HowTo data from your Sanity GROQ query. */
+    data?: SchemaOrgHowToData | null;
+}
+/**
+ * Builds a Schema.org HowTo JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildHowToJsonLd(data?: SchemaOrgHowToData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org HowTo data.
+ * Renders nothing if required fields are missing.
+ */
+declare function HowToSchema({ data }: HowToSchemaProps): JSX.Element | null;
+
+interface ImageObjectSchemaProps {
+    data?: SchemaOrgImageObjectData | null;
+}
+declare function buildImageObjectJsonLd(data?: SchemaOrgImageObjectData | null): Record<string, unknown> | null;
+declare function ImageObjectSchema({ data }: ImageObjectSchemaProps): JSX.Element | null;
+
+interface LocalBusinessSchemaProps {
+    /** The Schema.org LocalBusiness data from your Sanity GROQ query. */
+    data?: SchemaOrgLocalBusinessData | null;
+}
+/**
+ * Builds a Schema.org LocalBusiness JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildLocalBusinessJsonLd(data?: SchemaOrgLocalBusinessData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org LocalBusiness data.
+ * Renders nothing if required fields are missing.
+ */
+declare function LocalBusinessSchema({ data }: LocalBusinessSchemaProps): JSX.Element | null;
+
+interface OfferSchemaProps {
+    data?: SchemaOrgOfferData | null;
+}
+declare function buildOfferJsonLd(data?: SchemaOrgOfferData | null): Record<string, unknown> | null;
+declare function OfferSchema({ data }: OfferSchemaProps): JSX.Element | null;
+
+/**
+ * <OrganizationSchema> — Renders Schema.org Organization JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { OrganizationSchema } from 'sanity-plugin-seofields/next/organization'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "settings"][0]{ organization }` })
+ *
+ * <OrganizationSchema data={data.organization} />
+ * ```
+ */
+
+interface OrganizationSchemaProps {
+    /** The Schema.org Organization data from your Sanity GROQ query. */
+    data?: SchemaOrgOrganizationData | null;
+    /**
+     * Resolve a Sanity image asset to a URL string (for the logo field).
+     * Only needed if you use the Sanity image upload field instead of logoUrl.
+     *
+     * @example
+     * imageUrlResolver={(img) => urlFor(img).width(600).url()}
+     */
+    imageUrlResolver?: (image: SanityImage) => string | null | undefined;
+}
+/**
+ * Builds a Schema.org Organization JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name, url) are missing.
+ */
+declare function buildOrganizationJsonLd(data?: SchemaOrgOrganizationData | null, imageUrlResolver?: (image: SanityImage) => string | null | undefined): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Organization data.
+ * Renders nothing if required fields are missing.
+ */
+declare function OrganizationSchema({ data, imageUrlResolver, }: OrganizationSchemaProps): JSX.Element | null;
+
+/**
+ * <PersonSchema> — Renders Schema.org Person JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { PersonSchema } from 'sanity-plugin-seofields/next/person'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "teamMember"][0]{ person }` })
+ *
+ * <PersonSchema data={data.person} />
+ * ```
+ */
+
+interface PersonSchemaProps {
+    /** The Schema.org Person data from your Sanity GROQ query. */
+    data?: SchemaOrgPersonData | null;
+}
+/**
+ * Builds a Schema.org Person JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildPersonJsonLd(data?: SchemaOrgPersonData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Person data.
+ * Renders nothing if required fields are missing.
+ */
+declare function PersonSchema({ data }: PersonSchemaProps): JSX.Element | null;
+
+interface PlaceSchemaProps {
+    /** The Schema.org Place data from your Sanity GROQ query. */
+    data?: SchemaOrgPlaceData | null;
+}
+/**
+ * Builds a Schema.org Place JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildPlaceJsonLd(data?: SchemaOrgPlaceData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Place data.
+ * Renders nothing if required fields are missing.
+ */
+declare function PlaceSchema({ data }: PlaceSchemaProps): JSX.Element | null;
+
+interface PostalAddressSchemaProps {
+    data?: SchemaOrgPostalAddressData | null;
+}
+declare function buildPostalAddressJsonLd(data?: SchemaOrgPostalAddressData | null): Record<string, unknown> | null;
+declare function PostalAddressSchema({ data }: PostalAddressSchemaProps): JSX.Element | null;
+
+/**
+ * <ProductSchema> — Renders Schema.org Product JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { ProductSchema } from 'sanity-plugin-seofields/next/product'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "product"][0]{ seo }` })
+ *
+ * <ProductSchema data={data.seo} />
+ * ```
+ */
+
+interface ProductSchemaProps {
+    /** The Schema.org Product data from your Sanity GROQ query. */
+    data?: SchemaOrgProductData | null;
+}
+/**
+ * Builds a Schema.org Product JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildProductJsonLd(data?: SchemaOrgProductData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Product data.
+ * Renders nothing if required fields are missing.
+ */
+declare function ProductSchema({ data }: ProductSchemaProps): JSX.Element | null;
+
+interface ReviewSchemaProps {
+    /** The Schema.org Review data from your Sanity GROQ query. */
+    data?: SchemaOrgReviewData | null;
+}
+/**
+ * Builds a Schema.org Review JSON-LD object from Sanity data.
+ * Returns `null` if data is missing.
+ */
+declare function buildReviewJsonLd(data?: SchemaOrgReviewData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org Review data.
+ * Renders nothing if data is missing.
+ */
+declare function ReviewSchema({ data }: ReviewSchemaProps): JSX.Element | null;
+
+/**
+ * <SoftwareApplicationSchema> — Renders Schema.org SoftwareApplication JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { SoftwareApplicationSchema } from 'sanity-plugin-seofields/next/softwareApplication'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "app"][0]{ seo }` })
+ *
+ * <SoftwareApplicationSchema data={data.seo} />
+ * ```
+ */
+
+interface SoftwareApplicationSchemaProps {
+    /** The Schema.org SoftwareApplication data from your Sanity GROQ query. */
+    data?: SchemaOrgSoftwareApplicationData | null;
+}
+/**
+ * Builds a Schema.org SoftwareApplication JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name) are missing.
+ */
+declare function buildSoftwareApplicationJsonLd(data?: SchemaOrgSoftwareApplicationData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org SoftwareApplication data.
+ * Renders nothing if required fields are missing.
+ */
+declare function SoftwareApplicationSchema({ data, }: SoftwareApplicationSchemaProps): JSX.Element | null;
+
+interface VideoObjectSchemaProps {
+    data?: SchemaOrgVideoObjectData | null;
+}
+declare function buildVideoObjectJsonLd(data?: SchemaOrgVideoObjectData | null): Record<string, unknown> | null;
+declare function VideoObjectSchema({ data }: VideoObjectSchemaProps): JSX.Element | null;
+
+/**
+ * <WebApplicationSchema> — Renders Schema.org WebApplication JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { WebApplicationSchema } from 'sanity-plugin-seofields/next/webApplication'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "app"][0]{ seo }` })
+ *
+ * <WebApplicationSchema data={data.seo} />
+ * ```
+ */
+
+interface WebApplicationSchemaProps {
+    /** The Schema.org WebApplication data from your Sanity GROQ query. */
+    data?: SchemaOrgWebApplicationData | null;
+}
+/**
+ * Builds a Schema.org WebApplication JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name, url) are missing.
+ */
+declare function buildWebApplicationJsonLd(data?: SchemaOrgWebApplicationData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org WebApplication data.
+ * Renders nothing if required fields are missing.
+ */
+declare function WebApplicationSchema({ data }: WebApplicationSchemaProps): JSX.Element | null;
+
+/**
+ * <WebPageSchema> — Renders Schema.org WebPage JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { WebPageSchema } from 'sanity-plugin-seofields/next/webPage'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "page"][0]{ seo }` })
+ *
+ * <WebPageSchema data={data.seo} />
+ * ```
+ */
+
+interface WebPageSchemaProps {
+    /** The Schema.org WebPage data from your Sanity GROQ query. */
+    data?: SchemaOrgWebPageData | null;
+}
+/**
+ * Builds a Schema.org WebPage JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name, url) are missing.
+ */
+declare function buildWebPageJsonLd(data?: SchemaOrgWebPageData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org WebPage data.
+ * Renders nothing if required fields are missing.
+ */
+declare function WebPageSchema({ data }: WebPageSchemaProps): JSX.Element | null;
+
+/**
+ * <WebsiteSchema> — Renders Schema.org WebSite JSON-LD structured data.
+ *
+ * @example
+ * ```tsx
+ * import { WebsiteSchema } from 'sanity-plugin-seofields/next/website'
+ *
+ * const data = await sanityFetch({ query: `*[_type == "settings"][0]{ website }` })
+ *
+ * <WebsiteSchema data={data.website} />
+ * ```
+ */
+
+interface WebsiteSchemaProps {
+    /** The Schema.org Website data from your Sanity GROQ query. */
+    data?: SchemaOrgWebsiteData | null;
+}
+/**
+ * Builds a Schema.org WebSite JSON-LD object from Sanity data.
+ * Returns `null` if required fields (name, url) are missing.
+ */
+declare function buildWebsiteJsonLd(data?: SchemaOrgWebsiteData | null): Record<string, unknown> | null;
+/**
+ * Renders a `<script type="application/ld+json">` tag with Schema.org WebSite data.
+ * Renders nothing if required fields are missing.
+ */
+declare function WebsiteSchema({ data }: WebsiteSchemaProps): JSX.Element | null;
+
+export { AggregateRatingSchema, type AggregateRatingSchemaProps, ArticleSchema, type ArticleSchemaProps, BlogPostingSchema, type BlogPostingSchemaProps, BrandSchema, type BrandSchemaProps, BreadcrumbListSchema, type BreadcrumbListSchemaProps, ContactPointSchema, type ContactPointSchemaProps, CourseSchema, type CourseSchemaProps, EventSchema, type EventSchemaProps, FAQPageSchema, type FAQPageSchemaProps, HowToSchema, type HowToSchemaProps, ImageObjectSchema, type ImageObjectSchemaProps, LocalBusinessSchema, type LocalBusinessSchemaProps, OfferSchema, type OfferSchemaProps, OrganizationSchema, type OrganizationSchemaProps, PersonSchema, type PersonSchemaProps, PlaceSchema, type PlaceSchemaProps, PostalAddressSchema, type PostalAddressSchemaProps, ProductSchema, type ProductSchemaProps, ReviewSchema, type ReviewSchemaProps, SchemaOrgScripts, type SchemaOrgScriptsProps, SoftwareApplicationSchema, type SoftwareApplicationSchemaProps, VideoObjectSchema, type VideoObjectSchemaProps, WebApplicationSchema, type WebApplicationSchemaProps, WebPageSchema, type WebPageSchemaProps, WebsiteSchema, type WebsiteSchemaProps, buildAggregateRatingJsonLd, buildArticleJsonLd, buildBlogPostingJsonLd, buildBrandJsonLd, buildBreadcrumbListJsonLd, buildContactPointJsonLd, buildCourseJsonLd, buildEventJsonLd, buildFAQPageJsonLd, buildHowToJsonLd, buildImageObjectJsonLd, buildLocalBusinessJsonLd, buildOfferJsonLd, buildOrganizationJsonLd, buildPersonJsonLd, buildPlaceJsonLd, buildPostalAddressJsonLd, buildProductJsonLd, buildReviewJsonLd, buildSoftwareApplicationJsonLd, buildVideoObjectJsonLd, buildWebApplicationJsonLd, buildWebPageJsonLd, buildWebsiteJsonLd };