sanity-plugin-seofields 1.3.1 → 1.4.0

package/dist/types-CVaAX7uy.d.cts

@@ -0,0 +1,589 @@
+import { S as SanityImage } from './types-R3n9Fu4w.cjs';
+
+/** Schema.org AggregateRating — data shape from GROQ query */
+interface SchemaOrgAggregateRatingData {
+    _type?: 'schemaOrgAggregateRating';
+    /** Average rating value, e.g. "4.5" */
+    ratingValue?: string;
+    /** Total number of reviews, e.g. "120" */
+    reviewCount?: string;
+}
+/** Configuration for `schemaOrgAggregateRating()` */
+interface SchemaOrgAggregateRatingConfig {
+    validation?: {
+        /** Custom error message when rating value is missing */
+        ratingValueRequired?: string;
+    };
+}
+
+/** Schema.org Article — data shape returned from a Sanity GROQ query */
+interface SchemaOrgArticleData {
+    _type?: 'schemaOrgArticle';
+    /** Headline of the article */
+    headline?: string;
+    /** Short summary of the article */
+    description?: string;
+    /** URL of the article image */
+    image?: string;
+    /** Author of the article */
+    author?: {
+        name?: string;
+    };
+    /** Publisher of the article */
+    publisher?: {
+        name?: string;
+        logo?: {
+            url?: string;
+        };
+    };
+    /** Date the article was published */
+    datePublished?: string;
+}
+/** Configuration for `schemaOrgArticle()` */
+interface SchemaOrgArticleConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when headline is missing */
+        headlineRequired?: string;
+    };
+}
+
+/** Schema.org BlogPosting — data shape returned from a Sanity GROQ query */
+interface SchemaOrgBlogPostingData {
+    _type?: 'schemaOrgBlogPosting';
+    /** Headline of the blog post */
+    headline?: string;
+    /** Short summary of the blog post */
+    description?: string;
+    /** Author of the blog post */
+    author?: {
+        name?: string;
+    };
+    /** Date the blog post was published */
+    datePublished?: string;
+    /** Main entity of the page */
+    mainEntityOfPage?: {
+        id?: string;
+    };
+}
+/** Configuration for `schemaOrgBlogPosting()` */
+interface SchemaOrgBlogPostingConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when headline is missing */
+        headlineRequired?: string;
+    };
+}
+
+/** Schema.org Brand — data shape from GROQ query */
+interface SchemaOrgBrandData {
+    _type?: 'schemaOrgBrand';
+    /** Brand name */
+    name?: string;
+}
+/** Configuration for `schemaOrgBrand()` */
+interface SchemaOrgBrandConfig {
+    validation?: {
+        /** Custom error message when brand name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** A single item in a BreadcrumbList */
+interface BreadcrumbListItem {
+    /** Position of this item in the breadcrumb trail */
+    position?: number;
+    /** Display label for this breadcrumb */
+    name?: string;
+    /** URL for this breadcrumb */
+    item?: string;
+}
+/** Schema.org BreadcrumbList — data shape returned from a Sanity GROQ query */
+interface SchemaOrgBreadcrumbListData {
+    _type?: 'schemaOrgBreadcrumbList';
+    /** Ordered list of breadcrumb items */
+    itemListElement?: BreadcrumbListItem[];
+}
+/** Configuration for `schemaOrgBreadcrumbList()` */
+interface SchemaOrgBreadcrumbListConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when position is missing */
+        positionRequired?: string;
+        /** Custom error message when name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org ContactPoint — data shape from GROQ query */
+interface SchemaOrgContactPointData {
+    _type?: 'schemaOrgContactPoint';
+    /** Type of contact, e.g. "customer support", "sales" */
+    contactType?: string;
+    /** Contact email address */
+    email?: string;
+    /** Contact telephone number */
+    telephone?: string;
+    /** Languages supported, e.g. ["English"] */
+    availableLanguage?: string[];
+}
+/** Configuration for `schemaOrgContactPoint()` */
+interface SchemaOrgContactPointConfig {
+    validation?: {
+        /** Custom error message when contact type is missing */
+        contactTypeRequired?: string;
+    };
+}
+
+/** Provider info nested within the Course schema */
+interface CourseProvider {
+    /** Provider organization name */
+    name?: string;
+    /** Provider organization URL */
+    sameAs?: string;
+}
+/** Schema.org Course — data shape returned from a Sanity GROQ query */
+interface SchemaOrgCourseData {
+    _type?: 'schemaOrgCourse';
+    /** Course name */
+    name?: string;
+    /** Short description of the course */
+    description?: string;
+    /** The organization that provides this course */
+    provider?: CourseProvider;
+}
+/** Configuration for `schemaOrgCourse()` */
+interface SchemaOrgCourseConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when course name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org Event — data shape returned from a Sanity GROQ query */
+interface SchemaOrgEventData {
+    _type?: 'schemaOrgEvent';
+    /** Name of the event */
+    name?: string;
+    /** Start date of the event (ISO 8601) */
+    startDate?: string;
+    /** Location of the event */
+    location?: {
+        name?: string;
+        address?: string;
+    };
+}
+/** Configuration for `schemaOrgEvent()` */
+interface SchemaOrgEventConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when event name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** A single FAQ question/answer pair */
+interface FAQItem {
+    /** The question text */
+    name?: string;
+    /** The accepted answer */
+    acceptedAnswer?: {
+        text?: string;
+    };
+}
+/** Schema.org FAQPage — data shape returned from a Sanity GROQ query */
+interface SchemaOrgFAQPageData {
+    _type?: 'schemaOrgFAQPage';
+    /** List of FAQ questions and answers */
+    mainEntity?: FAQItem[];
+}
+/** Configuration for `schemaOrgFAQPage()` */
+interface SchemaOrgFAQPageConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when question text is missing */
+        questionRequired?: string;
+    };
+}
+
+/** A single step in a HowTo guide */
+interface HowToStepItem {
+    /** Name of the step */
+    name?: string;
+    /** Description of the step */
+    text?: string;
+}
+/** Schema.org HowTo — data shape returned from a Sanity GROQ query */
+interface SchemaOrgHowToData {
+    _type?: 'schemaOrgHowTo';
+    /** Name of the how-to guide */
+    name?: string;
+    /** Short description of the how-to guide */
+    description?: string;
+    /** Steps in the how-to guide */
+    step?: HowToStepItem[];
+}
+/** Configuration for `schemaOrgHowTo()` */
+interface SchemaOrgHowToConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when name is missing */
+        nameRequired?: string;
+        /** Custom error message when step name is missing */
+        stepNameRequired?: string;
+    };
+}
+
+/** Schema.org ImageObject — data shape from GROQ query */
+interface SchemaOrgImageObjectData {
+    _type?: 'schemaOrgImageObject';
+    /** URL of the image */
+    url?: string;
+    /** Image width in pixels */
+    width?: number;
+    /** Image height in pixels */
+    height?: number;
+    /** Caption or alt text for the image */
+    caption?: string;
+}
+/** Configuration for `schemaOrgImageObject()` */
+interface SchemaOrgImageObjectConfig {
+    validation?: {
+        /** Custom error message when image URL is missing */
+        urlRequired?: string;
+    };
+}
+
+/** Schema.org LocalBusiness — data shape returned from a Sanity GROQ query */
+interface SchemaOrgLocalBusinessData {
+    _type?: 'schemaOrgLocalBusiness';
+    /** Official name of the business */
+    name?: string;
+    /** URL to the business image */
+    image?: string;
+    /** Telephone number */
+    telephone?: string;
+    /** Physical address of the business */
+    address?: {
+        streetAddress?: string;
+        addressLocality?: string;
+        addressCountry?: string;
+    };
+}
+/** Configuration for `schemaOrgLocalBusiness()` */
+interface SchemaOrgLocalBusinessConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when business name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org Offer — data shape from GROQ query */
+interface SchemaOrgOfferData {
+    _type?: 'schemaOrgOffer';
+    /** Price of the offer, e.g. "199.99" */
+    price?: string;
+    /** Currency code, e.g. "USD" */
+    priceCurrency?: string;
+    /** Schema.org availability URL, e.g. "https://schema.org/InStock" */
+    availability?: string;
+    /** URL of the offer page */
+    url?: string;
+}
+/** Configuration for `schemaOrgOffer()` */
+interface SchemaOrgOfferConfig {
+    validation?: {
+        /** Custom error message when price is missing */
+        priceRequired?: string;
+    };
+}
+
+/** Contact point nested within the Organization schema */
+interface OrganizationContactPoint {
+    /** e.g. "customer support", "sales", "technical support" */
+    contactType?: string;
+    /** Contact email address */
+    email?: string;
+    /** Languages supported, e.g. ["English", "Spanish"] */
+    availableLanguage?: string[];
+}
+/** Schema.org Organization — data shape returned from a Sanity GROQ query */
+interface SchemaOrgOrganizationData {
+    _type?: 'schemaOrgOrganization';
+    /** Official name of the organization */
+    name?: string;
+    /** Full URL of the organization website */
+    url?: string;
+    /** Direct URL to the organization logo */
+    logoUrl?: string;
+    /** Sanity image upload for the logo (use imageUrlResolver to convert) */
+    logo?: SanityImage;
+    /** Short description of the organization */
+    description?: string;
+    /** Social media and external profile URLs */
+    sameAs?: string[];
+    /** Primary contact information */
+    contactPoint?: OrganizationContactPoint;
+}
+/** Configuration for `schemaOrgOrganization()` */
+interface SchemaOrgOrganizationConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when organization name is missing */
+        nameRequired?: string;
+        /** Custom error message when organization URL is missing */
+        urlRequired?: string;
+    };
+}
+
+/** Organization info nested within the Person schema (worksFor) */
+interface PersonWorksFor {
+    /** Organization name */
+    name?: string;
+}
+/** Schema.org Person — data shape returned from a Sanity GROQ query */
+interface SchemaOrgPersonData {
+    _type?: 'schemaOrgPerson';
+    /** Full name of the person */
+    name?: string;
+    /** Job title or role */
+    jobTitle?: string;
+    /** URL of the person's profile or website */
+    url?: string;
+    /** URL to a photo/image of this person (mapped to "image" in JSON-LD) */
+    imageUrl?: string;
+    /** Social media and external profile URLs */
+    sameAs?: string[];
+    /** The organization this person works for */
+    worksFor?: PersonWorksFor;
+}
+/** Configuration for `schemaOrgPerson()` */
+interface SchemaOrgPersonConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when person name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org Place — data shape returned from a Sanity GROQ query */
+interface SchemaOrgPlaceData {
+    _type?: 'schemaOrgPlace';
+    /** Name of the place */
+    name?: string;
+    /** Physical address of the place */
+    address?: {
+        addressLocality?: string;
+        addressCountry?: string;
+    };
+}
+/** Configuration for `schemaOrgPlace()` */
+interface SchemaOrgPlaceConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when place name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org PostalAddress — data shape from GROQ query */
+interface SchemaOrgPostalAddressData {
+    _type?: 'schemaOrgPostalAddress';
+    /** Street address, e.g. "123 Main St" */
+    streetAddress?: string;
+    /** City or locality, e.g. "New York" */
+    addressLocality?: string;
+    /** Postal or ZIP code, e.g. "10001" */
+    postalCode?: string;
+    /** Country code, e.g. "US" */
+    addressCountry?: string;
+}
+/** Configuration for `schemaOrgPostalAddress()` */
+interface SchemaOrgPostalAddressConfig {
+    validation?: Record<string, string>;
+}
+
+/** Brand info nested within the Product schema */
+interface ProductBrand {
+    /** Brand name */
+    name?: string;
+}
+/** Schema.org Product — data shape returned from a Sanity GROQ query */
+interface SchemaOrgProductData {
+    _type?: 'schemaOrgProduct';
+    /** Product name */
+    name?: string;
+    /** URL to the product image (mapped to "image" in JSON-LD) */
+    imageUrl?: string;
+    /** Short description of the product */
+    description?: string;
+    /** The brand of the product */
+    brand?: ProductBrand;
+}
+/** Configuration for `schemaOrgProduct()` */
+interface SchemaOrgProductConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when product name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org Review — data shape returned from a Sanity GROQ query */
+interface SchemaOrgReviewData {
+    _type?: 'schemaOrgReview';
+    /** Rating for the reviewed item */
+    reviewRating?: {
+        ratingValue?: string;
+    };
+    /** Author of the review */
+    author?: {
+        name?: string;
+    };
+    /** Full text of the review */
+    reviewBody?: string;
+}
+/** Configuration for `schemaOrgReview()` */
+interface SchemaOrgReviewConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when rating value is missing */
+        ratingValueRequired?: string;
+        /** Custom error message when author name is missing */
+        authorNameRequired?: string;
+    };
+}
+
+/** Schema.org SoftwareApplication — data shape returned from a Sanity GROQ query */
+interface SchemaOrgSoftwareApplicationData {
+    _type?: 'schemaOrgSoftwareApplication';
+    /** Application name */
+    name?: string;
+    /** Category of the application */
+    applicationCategory?: string;
+    /** Supported operating systems */
+    operatingSystem?: string;
+    /** URL of the application */
+    url?: string;
+}
+/** Configuration for `schemaOrgSoftwareApplication()` */
+interface SchemaOrgSoftwareApplicationConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when application name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org VideoObject — data shape from GROQ query */
+interface SchemaOrgVideoObjectData {
+    _type?: 'schemaOrgVideoObject';
+    /** Name of the video */
+    name?: string;
+    /** Description of the video */
+    description?: string;
+    /** URL of the video thumbnail image */
+    thumbnailUrl?: string;
+    /** Date the video was uploaded (ISO 8601) */
+    uploadDate?: string;
+    /** URL to the actual video file */
+    contentUrl?: string;
+}
+/** Configuration for `schemaOrgVideoObject()` */
+interface SchemaOrgVideoObjectConfig {
+    validation?: {
+        /** Custom error message when video name is missing */
+        nameRequired?: string;
+    };
+}
+
+/** Schema.org WebApplication — data shape returned from a Sanity GROQ query */
+interface SchemaOrgWebApplicationData {
+    _type?: 'schemaOrgWebApplication';
+    /** Application name */
+    name?: string;
+    /** URL of the web application */
+    url?: string;
+    /** Category of the application */
+    applicationCategory?: string;
+    /** Supported operating systems */
+    operatingSystem?: string;
+}
+/** Configuration for `schemaOrgWebApplication()` */
+interface SchemaOrgWebApplicationConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when application name is missing */
+        nameRequired?: string;
+        /** Custom error message when application URL is missing */
+        urlRequired?: string;
+    };
+}
+
+/** Website info nested within the WebPage schema (isPartOf) */
+interface WebPageWebSite {
+    /** URL of the parent website */
+    url?: string;
+}
+/** Schema.org WebPage — data shape returned from a Sanity GROQ query */
+interface SchemaOrgWebPageData {
+    _type?: 'schemaOrgWebPage';
+    /** Page title */
+    name?: string;
+    /** Full URL of the page */
+    url?: string;
+    /** Short description of the page */
+    description?: string;
+    /** Language code, e.g. "en" */
+    inLanguage?: string;
+    /** The website this page is part of */
+    isPartOf?: WebPageWebSite;
+}
+/** Configuration for `schemaOrgWebPage()` */
+interface SchemaOrgWebPageConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when page name is missing */
+        nameRequired?: string;
+        /** Custom error message when page URL is missing */
+        urlRequired?: string;
+    };
+}
+
+/** Publisher info nested within the WebSite schema */
+interface WebsitePublisher {
+    /** Publisher organization name */
+    name?: string;
+    /** Publisher organization URL */
+    url?: string;
+    /** Direct URL to the publisher logo image */
+    logoUrl?: string;
+}
+/** Schema.org WebSite — data shape returned from a Sanity GROQ query */
+interface SchemaOrgWebsiteData {
+    _type?: 'schemaOrgWebsite';
+    /** Website name, e.g. "My Website" */
+    name?: string;
+    /** Full URL of the website, e.g. "https://www.example.com" */
+    url?: string;
+    /** Short description of the website */
+    description?: string;
+    /** Language code, e.g. "en" */
+    inLanguage?: string;
+    /** The organization that publishes this website */
+    publisher?: WebsitePublisher;
+}
+/** Configuration for `schemaOrgWebsite()` */
+interface SchemaOrgWebsiteConfig {
+    /** Custom validation messages */
+    validation?: {
+        /** Custom error message when website name is missing */
+        nameRequired?: string;
+        /** Custom error message when website URL is missing */
+        urlRequired?: string;
+    };
+}
+
+export type { SchemaOrgBrandData as A, SchemaOrgBreadcrumbListData as B, SchemaOrgContactPointData as C, SchemaOrgCourseData as D, SchemaOrgEventData as E, SchemaOrgFAQPageData as F, SchemaOrgHowToData as G, SchemaOrgImageObjectData as H, SchemaOrgLocalBusinessData as I, SchemaOrgOfferData as J, SchemaOrgOrganizationData as K, SchemaOrgPersonData as L, SchemaOrgPlaceData as M, SchemaOrgPostalAddressData as N, OrganizationContactPoint as O, SchemaOrgProductData as P, SchemaOrgReviewData as Q, SchemaOrgSoftwareApplicationData as R, SchemaOrgAggregateRatingConfig as S, SchemaOrgVideoObjectData as T, SchemaOrgWebApplicationData as U, SchemaOrgWebPageData as V, SchemaOrgWebsiteData as W, WebsitePublisher as X, SchemaOrgArticleConfig as a, SchemaOrgBlogPostingConfig as b, SchemaOrgBrandConfig as c, SchemaOrgBreadcrumbListConfig as d, SchemaOrgContactPointConfig as e, SchemaOrgCourseConfig as f, SchemaOrgEventConfig as g, SchemaOrgFAQPageConfig as h, SchemaOrgHowToConfig as i, SchemaOrgImageObjectConfig as j, SchemaOrgLocalBusinessConfig as k, SchemaOrgOfferConfig as l, SchemaOrgOrganizationConfig as m, SchemaOrgPersonConfig as n, SchemaOrgPlaceConfig as o, SchemaOrgPostalAddressConfig as p, SchemaOrgProductConfig as q, SchemaOrgReviewConfig as r, SchemaOrgSoftwareApplicationConfig as s, SchemaOrgVideoObjectConfig as t, SchemaOrgWebApplicationConfig as u, SchemaOrgWebPageConfig as v, SchemaOrgWebsiteConfig as w, SchemaOrgAggregateRatingData as x, SchemaOrgArticleData as y, SchemaOrgBlogPostingData as z };