sanity-plugin-seofields 1.3.1 → 1.4.0

package/dist/schema.d.cts

@@ -0,0 +1,387 @@
+import React from 'react';
+import * as sanity from 'sanity';
+import { SchemaTypeDefinition } from 'sanity';
+import { S as SchemaOrgAggregateRatingConfig, a as SchemaOrgArticleConfig, b as SchemaOrgBlogPostingConfig, c as SchemaOrgBrandConfig, d as SchemaOrgBreadcrumbListConfig, e as SchemaOrgContactPointConfig, f as SchemaOrgCourseConfig, g as SchemaOrgEventConfig, h as SchemaOrgFAQPageConfig, i as SchemaOrgHowToConfig, j as SchemaOrgImageObjectConfig, k as SchemaOrgLocalBusinessConfig, l as SchemaOrgOfferConfig, m as SchemaOrgOrganizationConfig, n as SchemaOrgPersonConfig, o as SchemaOrgPlaceConfig, p as SchemaOrgPostalAddressConfig, q as SchemaOrgProductConfig, r as SchemaOrgReviewConfig, s as SchemaOrgSoftwareApplicationConfig, t as SchemaOrgVideoObjectConfig, u as SchemaOrgWebApplicationConfig, v as SchemaOrgWebPageConfig, w as SchemaOrgWebsiteConfig } from './types-CVaAX7uy.cjs';
+export { O as OrganizationContactPoint, 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, X as WebsitePublisher } from './types-CVaAX7uy.cjs';
+import './types-R3n9Fu4w.cjs';
+
+/**
+ * Dynamic Sanity schema generator for Schema.org types.
+ *
+ * Each Schema.org type declares its fields as a plain `SchemaFieldDef[]` array.
+ * The generator converts them into Sanity `defineType` / `defineField` calls,
+ * wiring up validation, initial values, options, and nested objects/arrays
+ * automatically.
+ *
+ * It also provides a generic JSON-LD builder and React component factory so
+ * adding a new Schema.org type requires only a field definition array.
+ */
+
+interface SchemaFieldOption {
+    title: string;
+    value: string;
+}
+interface SchemaFieldDef {
+    /** Sanity field name */
+    name: string;
+    /** Human-readable title shown in Studio */
+    title: string;
+    /** Sanity field type */
+    type: 'string' | 'url' | 'text' | 'array' | 'object' | 'image' | 'number' | 'date' | 'datetime';
+    /** Help text shown below the field */
+    description?: string;
+    /** If set, field is required — key is the validation config key, message is the default */
+    required?: {
+        key: string;
+        message: string;
+    };
+    /** Initial value for the field */
+    initialValue?: unknown;
+    /** Dropdown / radio options for string fields */
+    options?: SchemaFieldOption[];
+    /** Number of rows for text fields */
+    rows?: number;
+    /** Array member types, e.g. [{type: 'string'}] */
+    of?: {
+        type: string;
+    }[];
+    /** Nested fields for object type */
+    fields?: SchemaFieldDef[];
+    /** Schema.org @type for this nested object or array items in JSON-LD output */
+    jsonLdType?: string;
+    /** JSON-LD key if different from the Sanity field name */
+    jsonLdKey?: string;
+}
+interface SchemaTypeDef {
+    /** Sanity type name, e.g. "schemaOrgWebsite" */
+    name: string;
+    /** Title shown in Studio, e.g. "Schema.org — Website" */
+    title: string;
+    /** Icon component shown in Studio and the array grid picker */
+    icon?: React.ComponentType;
+    /** Field definitions */
+    fields: SchemaFieldDef[];
+}
+interface SchemaOrgConfig {
+    /** Custom validation error messages keyed by field config key */
+    validation?: Record<string, string>;
+}
+/**
+ * Generates a complete Sanity `SchemaTypeDefinition` from a declarative
+ * `SchemaTypeDef` and optional user config.
+ */
+declare function generateSchemaType(def: SchemaTypeDef, config?: SchemaOrgConfig): SchemaTypeDefinition;
+/**
+ * Builds a complete Schema.org JSON-LD object from Sanity data using field defs.
+ * Returns `null` if any of the `requiredFields` are missing.
+ *
+ * @param schemaType  The Schema.org `@type` (e.g. "Person", "Article")
+ * @param data        Raw data from a Sanity GROQ query
+ * @param fieldDefs   The field definitions for this schema type
+ * @param requiredFields  Field names that must be present (returns null if missing)
+ */
+declare function buildGenericJsonLd(schemaType: string, data: Record<string, unknown> | null | undefined, fieldDefs: SchemaFieldDef[], requiredFields?: string[]): Record<string, unknown> | null;
+
+/** Per-type validation overrides for the combined `schemaOrg()` plugin. */
+interface SchemaOrgCombinedConfig {
+    website?: SchemaOrgConfig;
+    organization?: SchemaOrgConfig;
+    webPage?: SchemaOrgConfig;
+    person?: SchemaOrgConfig;
+    breadcrumbList?: SchemaOrgConfig;
+    imageObject?: SchemaOrgConfig;
+    article?: SchemaOrgConfig;
+    blogPosting?: SchemaOrgConfig;
+    faqPage?: SchemaOrgConfig;
+    howTo?: SchemaOrgConfig;
+    product?: SchemaOrgConfig;
+    offer?: SchemaOrgConfig;
+    aggregateRating?: SchemaOrgConfig;
+    review?: SchemaOrgConfig;
+    brand?: SchemaOrgConfig;
+    localBusiness?: SchemaOrgConfig;
+    postalAddress?: SchemaOrgConfig;
+    contactPoint?: SchemaOrgConfig;
+    softwareApplication?: SchemaOrgConfig;
+    webApplication?: SchemaOrgConfig;
+    event?: SchemaOrgConfig;
+    place?: SchemaOrgConfig;
+    videoObject?: SchemaOrgConfig;
+    course?: SchemaOrgConfig;
+}
+declare const schemaOrgWebsitePlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgOrganizationPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgWebPagePlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgPersonPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgBreadcrumbListPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgImageObjectPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgArticlePlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgBlogPostingPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgFAQPagePlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgHowToPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgProductPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgOfferPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgAggregateRatingPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgReviewPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgBrandPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgLocalBusinessPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgPostalAddressPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgContactPointPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgSoftwareApplicationPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgWebApplicationPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgEventPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgPlacePlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgVideoObjectPlugin: sanity.Plugin<void | SchemaOrgConfig>;
+declare const schemaOrgCoursePlugin: sanity.Plugin<void | SchemaOrgConfig>;
+/**
+ * Registers **all** Schema.org types as a single Sanity plugin.
+ * Includes a combined `schemaOrg` array type for multi-type fields.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrg } from 'sanity-plugin-seofields/schema'
+ *
+ * export default defineConfig({
+ *   plugins: [schemaOrg()],
+ * })
+ * ```
+ */
+declare const schemaOrg: sanity.Plugin<void | SchemaOrgCombinedConfig>;
+
+declare function schemaOrgAggregateRating(config?: SchemaOrgAggregateRatingConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org Article — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgArticle } from 'sanity-plugin-seofields/schema/article'
+ *
+ * schemaOrgArticle()
+ * ```
+ */
+declare function schemaOrgArticle(config?: SchemaOrgArticleConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org BlogPosting — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgBlogPosting } from 'sanity-plugin-seofields/schema/blogPosting'
+ *
+ * schemaOrgBlogPosting()
+ * ```
+ */
+declare function schemaOrgBlogPosting(config?: SchemaOrgBlogPostingConfig): SchemaTypeDefinition;
+
+declare function schemaOrgBrand(config?: SchemaOrgBrandConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org BreadcrumbList — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgBreadcrumbList } from 'sanity-plugin-seofields/schema/breadcrumbList'
+ *
+ * schemaOrgBreadcrumbList()
+ * ```
+ */
+declare function schemaOrgBreadcrumbList(config?: SchemaOrgBreadcrumbListConfig): SchemaTypeDefinition;
+
+declare function schemaOrgContactPoint(config?: SchemaOrgContactPointConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org Course — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgCourse } from 'sanity-plugin-seofields/schema/course'
+ *
+ * // Default
+ * schemaOrgCourse()
+ *
+ * // Custom validation messages
+ * schemaOrgCourse({
+ *   validation: { nameRequired: 'Please enter the course name.' },
+ * })
+ * ```
+ */
+declare function schemaOrgCourse(config?: SchemaOrgCourseConfig): SchemaTypeDefinition;
+
+declare function schemaOrgEvent(config?: SchemaOrgEventConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org FAQPage — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgFAQPage } from 'sanity-plugin-seofields/schema/faqPage'
+ *
+ * schemaOrgFAQPage()
+ * ```
+ */
+declare function schemaOrgFAQPage(config?: SchemaOrgFAQPageConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org HowTo — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgHowTo } from 'sanity-plugin-seofields/schema/howTo'
+ *
+ * schemaOrgHowTo()
+ * ```
+ */
+declare function schemaOrgHowTo(config?: SchemaOrgHowToConfig): SchemaTypeDefinition;
+
+declare function schemaOrgImageObject(config?: SchemaOrgImageObjectConfig): SchemaTypeDefinition;
+
+declare function schemaOrgLocalBusiness(config?: SchemaOrgLocalBusinessConfig): SchemaTypeDefinition;
+
+declare function schemaOrgOffer(config?: SchemaOrgOfferConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org Organization — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgOrganization } from 'sanity-plugin-seofields/schema/organization'
+ *
+ * // Default
+ * schemaOrgOrganization()
+ *
+ * // Custom validation messages
+ * schemaOrgOrganization({
+ *   validation: { nameRequired: 'Company name is required.' },
+ * })
+ * ```
+ */
+declare function schemaOrgOrganization(config?: SchemaOrgOrganizationConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org Person — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgPerson } from 'sanity-plugin-seofields/schema/person'
+ *
+ * // Default
+ * schemaOrgPerson()
+ *
+ * // Custom validation messages
+ * schemaOrgPerson({
+ *   validation: { nameRequired: 'Please enter the person\'s name.' },
+ * })
+ * ```
+ */
+declare function schemaOrgPerson(config?: SchemaOrgPersonConfig): SchemaTypeDefinition;
+
+declare function schemaOrgPlace(config?: SchemaOrgPlaceConfig): SchemaTypeDefinition;
+
+declare function schemaOrgPostalAddress(config?: SchemaOrgPostalAddressConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org Product — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgProduct } from 'sanity-plugin-seofields/schema/product'
+ *
+ * // Default
+ * schemaOrgProduct()
+ *
+ * // Custom validation messages
+ * schemaOrgProduct({
+ *   validation: { nameRequired: 'Please enter the product name.' },
+ * })
+ * ```
+ */
+declare function schemaOrgProduct(config?: SchemaOrgProductConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org Review — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgReview } from 'sanity-plugin-seofields/schema/review'
+ *
+ * schemaOrgReview()
+ * ```
+ */
+declare function schemaOrgReview(config?: SchemaOrgReviewConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org SoftwareApplication — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgSoftwareApplication } from 'sanity-plugin-seofields/schema/softwareApplication'
+ *
+ * // Default
+ * schemaOrgSoftwareApplication()
+ *
+ * // Custom validation messages
+ * schemaOrgSoftwareApplication({
+ *   validation: { nameRequired: 'Please enter the application name.' },
+ * })
+ * ```
+ */
+declare function schemaOrgSoftwareApplication(config?: SchemaOrgSoftwareApplicationConfig): SchemaTypeDefinition;
+
+declare function schemaOrgVideoObject(config?: SchemaOrgVideoObjectConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org WebApplication — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgWebApplication } from 'sanity-plugin-seofields/schema/webApplication'
+ *
+ * // Default
+ * schemaOrgWebApplication()
+ *
+ * // Custom validation messages
+ * schemaOrgWebApplication({
+ *   validation: { nameRequired: 'Please enter the application name.' },
+ * })
+ * ```
+ */
+declare function schemaOrgWebApplication(config?: SchemaOrgWebApplicationConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org WebPage — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgWebPage } from 'sanity-plugin-seofields/schema/webPage'
+ *
+ * // Default
+ * schemaOrgWebPage()
+ *
+ * // Custom validation messages
+ * schemaOrgWebPage({
+ *   validation: { nameRequired: 'Please enter a page name.' },
+ * })
+ * ```
+ */
+declare function schemaOrgWebPage(config?: SchemaOrgWebPageConfig): SchemaTypeDefinition;
+
+/**
+ * Schema.org WebSite — Sanity object type.
+ *
+ * @example
+ * ```ts
+ * import { schemaOrgWebsite } from 'sanity-plugin-seofields/schema/website'
+ *
+ * // Default
+ * schemaOrgWebsite()
+ *
+ * // Custom validation messages
+ * schemaOrgWebsite({
+ *   validation: { nameRequired: 'Please enter a website name.' },
+ * })
+ * ```
+ */
+declare function schemaOrgWebsite(config?: SchemaOrgWebsiteConfig): SchemaTypeDefinition;
+
+export { type SchemaFieldDef, type SchemaFieldOption, SchemaOrgAggregateRatingConfig, SchemaOrgArticleConfig, SchemaOrgBlogPostingConfig, SchemaOrgBrandConfig, SchemaOrgBreadcrumbListConfig, type SchemaOrgCombinedConfig, type SchemaOrgConfig, SchemaOrgContactPointConfig, SchemaOrgCourseConfig, SchemaOrgEventConfig, SchemaOrgFAQPageConfig, SchemaOrgHowToConfig, SchemaOrgImageObjectConfig, SchemaOrgLocalBusinessConfig, SchemaOrgOfferConfig, SchemaOrgOrganizationConfig, SchemaOrgPersonConfig, SchemaOrgPlaceConfig, SchemaOrgPostalAddressConfig, SchemaOrgProductConfig, SchemaOrgReviewConfig, SchemaOrgSoftwareApplicationConfig, SchemaOrgVideoObjectConfig, SchemaOrgWebApplicationConfig, SchemaOrgWebPageConfig, SchemaOrgWebsiteConfig, type SchemaTypeDef, buildGenericJsonLd, generateSchemaType, schemaOrg, schemaOrgAggregateRating, schemaOrgAggregateRatingPlugin, schemaOrgArticle, schemaOrgArticlePlugin, schemaOrgBlogPosting, schemaOrgBlogPostingPlugin, schemaOrgBrand, schemaOrgBrandPlugin, schemaOrgBreadcrumbList, schemaOrgBreadcrumbListPlugin, schemaOrgContactPoint, schemaOrgContactPointPlugin, schemaOrgCourse, schemaOrgCoursePlugin, schemaOrgEvent, schemaOrgEventPlugin, schemaOrgFAQPage, schemaOrgFAQPagePlugin, schemaOrgHowTo, schemaOrgHowToPlugin, schemaOrgImageObject, schemaOrgImageObjectPlugin, schemaOrgLocalBusiness, schemaOrgLocalBusinessPlugin, schemaOrgOffer, schemaOrgOfferPlugin, schemaOrgOrganization, schemaOrgOrganizationPlugin, schemaOrgPerson, schemaOrgPersonPlugin, schemaOrgPlace, schemaOrgPlacePlugin, schemaOrgPostalAddress, schemaOrgPostalAddressPlugin, schemaOrgProduct, schemaOrgProductPlugin, schemaOrgReview, schemaOrgReviewPlugin, schemaOrgSoftwareApplication, schemaOrgSoftwareApplicationPlugin, schemaOrgVideoObject, schemaOrgVideoObjectPlugin, schemaOrgWebApplication, schemaOrgWebApplicationPlugin, schemaOrgWebPage, schemaOrgWebPagePlugin, schemaOrgWebsite, schemaOrgWebsitePlugin };