sanity-plugin-seofields 1.7.0 → 1.8.0

package/dist/index.d.ts

@@ -1,15 +1,16 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-import { ComponentType, ReactNode } from 'react';
-import { D as DocumentWithSeoHealth$1 } from './types-B91ena4g.js';
-export { S as SeoHealthMetrics, a as SeoHealthStatus } from './types-B91ena4g.js';
-import { StructureBuilder, ComponentBuilder } from 'sanity/structure';
+import { ComponentType } from 'react';
+import { D as DocumentWithSeoHealth, S as SeoHealthMetrics } from './types-yVmQfby9.js';
+export { a as SeoHealthStatus } from './types-yVmQfby9.js';
+export { SeoHealthPaneOptions, createSeoHealthPane } from 'seofields-pro';
+export { S as SchemaOrgDocumentJsonLdPreview, S as SchemaOrgJsonLdPreview, a as SchemaOrgJsonLdPreviewOptions, b as SchemaOrgJsonLdPreviewProps } from './SchemaOrgJsonLdPreview-DJLkIPq4.js';
 
 interface SeoFieldConfig {
     title?: string;
     description?: string;
 }
-type SeoFieldKeys = 'title' | 'description' | 'canonicalUrl' | 'metaImage' | 'keywords' | 'metaAttributes' | 'robots';
+type SeoFieldKeys = 'title' | 'description' | 'canonicalUrl' | 'metaImage' | 'keywords' | 'metaAttributes' | 'robots' | 'focusKeyword' | 'hreflangs' | 'geoChecklist' | 'metaTagsPreview';
 type openGraphFieldKeys = 'openGraphUrl' | 'openGraphTitle' | 'openGraphDescription' | 'openGraphSiteName' | 'openGraphType' | 'openGraphImageType' | 'openGraphImage' | 'openGraphImageUrl';
 type twitterFieldKeys = 'twitterCard' | 'twitterSite' | 'twitterCreator' | 'twitterTitle' | 'twitterDescription' | 'twitterImageType' | 'twitterImage' | 'twitterImageUrl';
 type AllFieldKeys = SeoFieldKeys | openGraphFieldKeys | twitterFieldKeys;
@@ -17,7 +18,7 @@ type AllFieldKeys = SeoFieldKeys | openGraphFieldKeys | twitterFieldKeys;
  * Names of top-level fields inside the `seoFields` object type.
  * Use these when assigning fields to groups in `fieldGroups`.
  */
-type SeoObjectFieldName = 'robots' | 'preview' | 'title' | 'description' | 'metaImage' | 'metaAttributes' | 'keywords' | 'canonicalUrl' | 'openGraph' | 'twitter';
+type SeoObjectFieldName = 'robots' | 'preview' | 'title' | 'description' | 'metaImage' | 'metaAttributes' | 'keywords' | 'canonicalUrl' | 'openGraph' | 'twitter' | 'focusKeyword' | 'hreflangs' | 'geoChecklist' | 'metaTagsPreview';
 /**
  * Defines a single tab/group within the `seoFields` object.
  */
@@ -42,7 +43,17 @@ type ValidHiddenFieldKeys = Exclude<AllFieldKeys, 'openGraphImageUrl' | 'twitter
 interface FieldVisibilityConfig {
     hiddenFields?: ValidHiddenFieldKeys[];
 }
+/**
+ * Individual SEO fields that must be non-empty before publishing.
+ * Dot-notation for nested fields (e.g. 'openGraph.title').
+ */
+type PublishGateRequiredField = 'title' | 'description' | 'metaImage' | 'keywords' | 'canonicalUrl' | 'openGraph.title' | 'openGraph.description' | 'openGraph.image' | 'openGraph.type' | 'twitter.title' | 'twitter.description' | 'twitter.image' | 'twitter.card';
 interface SeoFieldsPluginConfig {
+    /**
+     * License key for pro features (SEO Health Dashboard, Publish Gate).
+     * Obtain at https://sanity-plugin-seofields.thehardik.in
+     */
+    licenseKey?: string;
     /**
      * Enable or configure the SEO preview feature.
      * If set to `true`, the SEO preview will be enabled with default settings.
@@ -127,6 +138,16 @@ interface SeoFieldsPluginConfig {
      * ]
      */
     fieldGroups?: SeoFieldGroup[];
+    /**
+     * Show the GEO / AI Overview readiness checklist inside seoFields.
+     * Defaults to `true`.
+     */
+    geo?: boolean;
+    /**
+     * Show the Meta Tags HTML preview inside seoFields.
+     * Defaults to `true`.
+     */
+    metaTagsPreview?: boolean;
     /**
      * The base URL of your website, used for generating full URLs in the SEO preview.
      * Defaults to 'https://www.example.com' if not provided.
@@ -224,7 +245,7 @@ interface SeoFieldsPluginConfig {
         apiVersion?: string;
         /**
          * License key for the SEO Health Dashboard pro feature.
-         * Obtain a license at https://sanity-plugin-seofields.thehardik.in
+         * @deprecated Use the root-level `licenseKey` option instead.
          */
         licenseKey?: string;
         /**
@@ -267,7 +288,7 @@ interface SeoFieldsPluginConfig {
          *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
          * }
          */
-        getDocumentBadge?: (doc: DocumentWithSeoHealth$1 & Record<string, unknown>) => {
+        getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
             label: string;
             bgColor?: string;
             textColor?: string;
@@ -309,6 +330,49 @@ interface SeoFieldsPluginConfig {
          */
         compactStats?: boolean;
     };
+    /**
+     * Gate publishing based on SEO score or required field presence.
+     * Requires a valid root-level `licenseKey` — silently disabled if key is absent or invalid.
+     *
+     * @example
+     * ```ts
+     * publishGate: {
+     *   mode: 'warn',
+     *   minScore: 70,
+     *   requiredFields: ['title', 'description', 'openGraph.title'],
+     *   types: ['post', 'page'],
+     * }
+     * ```
+     */
+    publishGate?: {
+        /**
+         * 'block' — disables the Publish button with a tooltip reason (default).
+         * 'warn'  — shows a confirm dialog; editor can bypass and publish anyway.
+         * @default 'block'
+         */
+        mode?: 'block' | 'warn';
+        /**
+         * Minimum overall SEO health score (0–100) required to publish.
+         * Gate fires when the document's score is below this threshold.
+         * @default 60
+         */
+        minScore?: number;
+        /**
+         * Individual fields that MUST be non-empty. Gate fires if any are missing.
+         * Use dot-notation for nested fields: 'openGraph.title', 'twitter.image', etc.
+         */
+        requiredFields?: PublishGateRequiredField[];
+        /**
+         * Restrict the gate to specific document types.
+         * Omit to apply to all document types that have an `seo` field.
+         */
+        types?: string[];
+        /**
+         * Custom message shown in the block tooltip or warn dialog.
+         * Accepts a string or a function receiving (score, issues[]).
+         */
+        message?: string | ((score: number, issues: string[]) => string);
+    };
 }
 declare const seofields: sanity.Plugin<void | SeoFieldsPluginConfig>;
 
@@ -347,292 +411,9 @@ declare const _default: {
 
 declare function twitter(config?: SeoFieldsPluginConfig): SchemaTypeDefinition;
 
-interface SanityImage {
-    _type: 'image';
-    asset: {
-        _ref: string;
-        _type: 'reference';
-    };
-    hotspot?: {
-        x: number;
-        y: number;
-        height: number;
-        width: number;
-    };
-    crop?: {
-        top: number;
-        bottom: number;
-        left: number;
-        right: number;
-    };
-    alt?: string;
-}
-interface SanityImageWithAlt extends SanityImage {
-    alt: string;
-}
-interface RobotsSettings {
-    noIndex?: boolean;
-    noFollow?: boolean;
-}
-interface MetaAttribute {
-    _type: 'metaAttribute';
-    key?: string;
-    type?: 'string' | 'image';
-    value?: string;
-    image?: SanityImage;
-}
-interface OpenGraphSettings {
-    _type: 'openGraph';
-    url?: string;
-    title?: string;
-    description?: string;
-    siteName?: string;
-    type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product';
-    imageType?: 'upload' | 'url';
-    image?: SanityImageWithAlt;
-    imageUrl?: string;
-}
-interface TwitterCardSettings {
-    _type: 'twitter';
-    card?: 'summary' | 'summary_large_image' | 'app' | 'player';
-    site?: string;
-    creator?: string;
-    title?: string;
-    description?: string;
-    imageType?: 'upload' | 'url';
-    image?: SanityImageWithAlt;
-    imageUrl?: string;
-}
-interface SeoFields {
-    _type: 'seoFields';
-    robots?: RobotsSettings;
-    preview?: string;
-    title?: string;
-    description?: string;
-    metaImage?: SanityImage;
-    metaAttributes?: MetaAttribute[];
-    keywords?: string[];
-    canonicalUrl?: string;
-    openGraph?: OpenGraphSettings;
-    twitter?: TwitterCardSettings;
-}
-type SeoHealthStatus = 'excellent' | 'good' | 'fair' | 'poor' | 'missing';
-interface SeoHealthMetrics {
-    score: number;
-    status: SeoHealthStatus;
-    issues: string[];
-}
-interface DocumentWithSeoHealth {
-    _id: string;
-    _type: string;
-    title?: string;
-    slug?: {
-        current: string;
-    };
-    seo?: SeoFields;
-    _updatedAt?: string;
-    health: SeoHealthMetrics;
-}
-interface DeprecationWarning {
-    key: string;
-    version: string;
-    changelogUrl: string;
-}
-
-interface SeoHealthDashboardProps {
-    icon?: string;
-    title?: string;
-    description?: string;
-    showTypeColumn?: boolean;
-    showDocumentId?: boolean;
-    /**
-     * Limit the dashboard to specific document type names.
-     * If both queryTypes and customQuery are provided, customQuery takes precedence.
-     */
-    queryTypes?: string[];
-    /**
-     * When using `queryTypes`, also filter by `seo != null`.
-     * Set to `false` to include documents of those types even without an seo field.
-     * Defaults to `true`.
-     */
-    queryRequireSeo?: boolean;
-    /**
-     * A fully custom GROQ query used to fetch documents.
-     * Must return objects with at least: _id, _type, title, seo, _updatedAt
-     * Takes precedence over queryTypes.
-     */
-    customQuery?: string;
-    /**
-     * The Sanity API version to use for the client (e.g. '2023-01-01').
-     * Defaults to '2023-01-01'.
-     */
-    apiVersion?: string;
-    /**
-     * License key for the SEO Health Dashboard.
-     * Obtain a key at https://sanity-plugin-seofields.thehardik.in
-     */
-    licenseKey?: string;
-    /**
-     * Map raw `_type` values to human-readable display labels used in the
-     * Type column and the Type filter dropdown.
-     * Any type without an entry falls back to the raw `_type` string.
-     *
-     * @example
-     * typeDisplayLabels={{ productDrug: 'Products', singleCondition: 'Condition' }}
-     */
-    typeDisplayLabels?: Record<string, string>;
-    /**
-     * Controls how the type is rendered in the Type column.
-     * - `'badge'` (default) — coloured pill, consistent with score badges
-     * - `'text'` — plain text, useful for dense layouts
-     */
-    typeColumnMode?: 'badge' | 'text';
-    /**
-     * The document field to use as the display title.
-     *
-     * - `string` — use this field for every document type (e.g. `'name'`)
-     * - `Record<string, string>` — per-type mapping; unmapped types fall back to `title`
-     *
-     * @example
-     * // Same field for all types
-     * titleField: 'name'
-     *
-     * @example
-     * // Different field per type
-     * titleField: { post: 'title', product: 'name', category: 'label' }
-     */
-    titleField?: string | Record<string, string>;
-    /**
-     * Callback function to render a custom badge next to the document title.
-     * Receives the full document and should return badge data or undefined.
-     *
-     * @example
-     * getDocumentBadge: (doc) => {
-     *   if (doc.services === 'NHS')
-     *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
-     *   if (doc.services === 'Private')
-     *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
-     * }
-     */
-    getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
-        label: string;
-        bgColor?: string;
-        textColor?: string;
-        fontSize?: string;
-    } | undefined;
-    /**
-     * Custom text shown while the license key is being verified.
-     * Defaults to `"Verifying license…"`.
-     */
-    loadingLicense?: ReactNode;
-    /**
-     * Custom text shown while documents are being fetched.
-     * Defaults to `"Loading documents…"`.
-     */
-    loadingDocuments?: ReactNode;
-    /**
-     * Custom text shown when the query returns zero results.
-     * Defaults to `"No documents found"`.
-     */
-    noDocuments?: ReactNode;
-    /**
-     * Enable preview/demo mode to show dummy data.
-     * Useful for testing, documentation, or showcasing the dashboard.
-     * When enabled, displays realistic sample documents with various SEO scores.
-     * Defaults to `false`.
-     */
-    previewMode?: boolean;
-    /**
-     * When `true`, clicking a document title opens the document editor as a split
-     * pane to the right, keeping the SEO Health pane visible on the left.
-     * This uses Sanity's pane router and requires the component to be rendered
-     * inside a desk-structure pane context (i.e. via `createSeoHealthPane`).
-     *
-     * When `false` (default), clicking navigates to the document via the standard
-     * intent-link system (full navigation).
-     *
-     * This is set to `true` automatically by `createSeoHealthPane`.
-     */
-    openInPane?: boolean;
-    /**
-     * The `name` of the Sanity structure tool that contains the monitored documents.
-     * When provided, clicking a document title navigates directly to that tool's
-     * intent URL (`/{basePath}/{structureTool}/intent/edit/id=…;type=…/`) instead of
-     * using the generic intent resolver, which always picks the first registered tool.
-     *
-     * Required when you have multiple structure tools and the documents live in a
-     * non-default one (e.g. `name: 'common'`).
-     *
-     * @example
-     * structureTool: 'common'
-     */
-    structureTool?: string;
-    /**
-     * @internal — populated by the plugin when deprecated config keys are detected.
-     * Each entry carries the migration hint, the version it was deprecated in, and
-     * the matching changelog URL so the banner can group warnings by release.
-     */
-    _deprecationWarnings?: DeprecationWarning[];
-    /**
-     * Whether the export (CSV / JSON) feature is enabled.
-     * Defaults to `true`.
-     */
-    exportEnabled?: boolean;
-    /**
-     * Which export formats to offer.
-     * Defaults to `['csv', 'json']`.
-     */
-    exportFormats?: Array<'csv' | 'json'>;
-    /**
-     * Render compact inline stat pills in the header instead of the full stats grid.
-     * Defaults to `false`.
-     */
-    compactStats?: boolean;
-}
-
-/**
- * Options accepted by `createSeoHealthPane`.
- * All props from `SeoHealthDashboardProps` are supported.
- *
- * `licenseKey` is **required** — the dashboard will not render without it.
- */
-interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuery'> {
-    /** Required license key (format: `SEOF-XXXX-XXXX-XXXX`). */
-    licenseKey: string;
-    /**
-     * A fully custom GROQ query used to fetch documents for the dashboard.
-     * The query must return documents with at least: `_id`, `_type`, `title`, `seo`, `_updatedAt`.
-     *
-     * Takes precedence over `queryTypes` when both are provided.
-     *
-     * @example
-     * query: `*[_type in ["post","page"] && defined(seo)]{ _id, _type, title, slug, seo, _updatedAt }`
-     */
-    query?: string;
+interface SeoDocument {
+    seo?: Record<string, unknown>;
 }
-/**
- * Creates a desk-structure pane for the SEO Health Dashboard.
- *
- * Returns a **`ComponentBuilder`** with a built-in `.child()` resolver so that
- * clicking any document row opens the document editor as a split pane to the right.
- *
- * Use it **directly** as the `.child()` value — do **not** wrap it in `S.component()`.
- *
- * ```ts
- * // sanity.config.ts
- * structure: (S) =>
- *   S.list().items([
- *     S.listItem()
- *       .title('SEO Health')
- *       .child(
- *         createSeoHealthPane(S, {
- *           licenseKey: 'SEOF-XXXX-XXXX-XXXX',
- *           query: `*[_type == "post" && defined(seo)]{ _id, _type, title, slug, seo, _updatedAt }`,
- *         })
- *       ),
- *   ])
- * ```
- */
-declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
+declare const calculateHealthScore: (doc: SeoDocument) => SeoHealthMetrics;
 
-export { type AllFieldKeys, DocumentWithSeoHealth$1 as DocumentWithSeoHealth, type FieldVisibilityConfig, type SeoFieldConfig, type SeoFieldGroup, type SeoFieldKeys, type SeoFieldsPluginConfig, type SeoHealthPaneOptions, type SeoObjectFieldName, type ValidHiddenFieldKeys, types as allSchemas, baseMeta as baseMetaSchema, createSeoHealthPane, seofields as default, _default$2 as metaAttributeSchema, _default$1 as metaTagSchema, type openGraphFieldKeys, openGraph as openGraphSchema, _default as robotsSchema, seoFieldsSchema, type twitterFieldKeys, twitter as twitterSchema };
+export { type AllFieldKeys, DocumentWithSeoHealth, type FieldVisibilityConfig, type PublishGateRequiredField, type SeoFieldConfig, type SeoFieldGroup, type SeoFieldKeys, type SeoFieldsPluginConfig, SeoHealthMetrics, type SeoObjectFieldName, type ValidHiddenFieldKeys, types as allSchemas, baseMeta as baseMetaSchema, calculateHealthScore, seofields as default, _default$2 as metaAttributeSchema, _default$1 as metaTagSchema, type openGraphFieldKeys, openGraph as openGraphSchema, _default as robotsSchema, seoFieldsSchema, type twitterFieldKeys, twitter as twitterSchema };