sanity-plugin-seofields 1.8.0 → 1.9.0

package/dist/index.d.ts

@@ -1,380 +1,12 @@
+import { S as SeoFieldsPluginConfig, s as seofields } from './plugin-DQdThyxG.js';
+export { A as AiConfig, a as AiIndustry, b as AllFieldKeys, F as FieldVisibilityConfig, P as PublishGateRequiredField, c as SeoFieldConfig, d as SeoFieldGroup, e as SeoFieldKeys, f as SeoObjectFieldName, V as ValidHiddenFieldKeys, o as openGraphFieldKeys, t as twitterFieldKeys } from './plugin-DQdThyxG.js';
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-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' | '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;
-/**
- * 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' | 'focusKeyword' | 'hreflangs' | 'geoChecklist' | 'metaTagsPreview';
-/**
- * Defines a single tab/group within the `seoFields` object.
- */
-interface SeoFieldGroup {
-    /** Unique key for this group (used internally by Sanity). */
-    name: string;
-    /** Human-readable label shown as the tab title. */
-    title: string;
-    /** Whether this tab is selected by default. Only one group should be `true`. */
-    default?: boolean;
-    /**
-     * Field names to include in this group.
-     * Use the top-level seoFields field names: `'title'`, `'description'`, `'metaImage'`,
-     * `'keywords'`, `'canonicalUrl'`, `'metaAttributes'`, `'robots'`, `'preview'`,
-     * `'openGraph'`, `'twitter'`.
-     */
-    fields: SeoObjectFieldName[];
-    /** Optional icon displayed next to the tab title. Must be a React component. */
-    icon?: ComponentType;
-}
-type ValidHiddenFieldKeys = Exclude<AllFieldKeys, 'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'>;
-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.
-     * If set to an object, you can provide a custom `prefix` function to modify the URL prefix
-     * and/or a `titleSuffix` to append text (e.g. a brand name) after the meta title in the preview.
-     * The plugin automatically adds a `|` separator — only provide the suffix text itself.
-     *
-     * Example:
-     * ```
-     * seoPreview: {
-     *   prefix: (doc) => `/${doc.slug?.current || 'untitled'}`,
-     *   titleSuffix: 'Acme Corp',
-     *   // or dynamically:
-     *   titleSuffix: (doc) => doc.brandName || 'Acme Corp',
-     * }
-     * ```
-     */
-    seoPreview?: boolean | {
-        prefix?: (doc: {
-            _type?: string;
-        } & Record<string, unknown>) => string;
-        /**
-         * A static string or function appended to the meta title in the Live Preview.
-         * Useful for showing a brand suffix (e.g. `'Acme Corp'`) that is added
-         * via your Next.js title template but not stored in the Sanity field.
-         * The plugin automatically prepends a `|` separator so only provide the
-         * text itself. The suffix is rendered in a muted style so editors can
-         * distinguish it from the typed title. The combined length (including the
-         * separator) is checked against the 60-character SERP limit.
-         */
-        titleSuffix?: string | ((doc: {
-            _type?: string;
-        } & Record<string, unknown>) => string);
-        /**
-         * When `true`, the `titleSuffix` is rendered in the same color and weight
-         * as the main title (`#1a0dab`, `fontWeight: 500`) instead of the default
-         * muted style (`#70757a`, `fontWeight: 400`).
-         *
-         * @default false
-         */
-        titleSuffixInheritColor?: boolean;
-        /**
-         * A GROQ query string whose result is used as the title suffix in the Live Preview.
-         * The query runs against your dataset at Studio load time, making it useful for
-         * fetching a dynamic value from another document (e.g. a settings singleton).
-         * Takes priority over `titleSuffix` when both are provided.
-         *
-         * @example
-         * ```ts
-         * titleSuffixQuery: '*[_type == "siteSettings"][0].siteName'
-         * ```
-         */
-        titleSuffixQuery?: string;
-    };
-    /**
-     * A mapping of field keys to their configuration settings.
-     * This allows customization of field titles and descriptions.
-     * For example, to change the title of the 'title' field:
-     */
-    fieldOverrides?: Partial<Record<AllFieldKeys, SeoFieldConfig>>;
-    /**
-     * A mapping of document types to field visibility configurations.
-     * This allows you to specify which fields should be hidden for specific document types.
-     */
-    fieldVisibility?: Record<string, FieldVisibilityConfig>;
-    /**
-     * A list of fields that should be hidden by default in all document types.
-     * This can be overridden by specific document type settings in `fieldVisibility`.
-     */
-    defaultHiddenFields?: ValidHiddenFieldKeys[];
-    /**
-     * Group the SEO fields into tabbed sections inside the `seoFields` object.
-     * When configured, the Studio shows tabs (Sanity groups) so editors can
-     * switch between e.g. "Meta", "Open Graph", and "Twitter Card" panels.
-     *
-     * @example
-     * fieldGroups: [
-     *   { name: 'meta',      title: 'Meta',         default: true,
-     *     fields: ['title', 'description', 'metaImage', 'keywords', 'canonicalUrl', 'metaAttributes', 'robots', 'preview'] },
-     *   { name: 'openGraph', title: 'Open Graph',   fields: ['openGraph'] },
-     *   { name: 'twitter',   title: 'Twitter Card', fields: ['twitter'] },
-     * ]
-     */
-    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.
-     */
-    baseUrl?: string;
-    /**
-     * The Sanity API version to use for all plugin clients (SEO Preview, Health Dashboard).
-     * Defaults to '2024-01-01'.
-     * @example '2024-01-01'
-     */
-    apiVersion?: string;
-    /**
-     * Enable or configure the SEO Health Dashboard tool.
-     * If set to `true`, the dashboard is enabled with all defaults.
-     * If set to an object, you can customise the tool and dashboard settings.
-     * Defaults to `true`.
-     * Example:
-     * ```
-     * healthDashboard: {
-     *   toolTitle: 'SEO Overview',  // Studio nav tab label
-     *   content: {
-     *     icon: '🔍',               // Emoji icon shown before the page heading
-     *     title: 'My SEO Dashboard',// Page heading inside the tool (no emoji)
-     *     description: 'Track SEO across all documents', // Subtitle under the heading
-     *   },
-     *   display: {
-     *     typeColumn: false,        // Hide the document type column (default: true)
-     *     documentId: false,        // Hide the document ID under titles (default: true)
-     *   },
-     *   query: {
-     *     // Option 1 – filter by specific document types
-     *     types: ['post', 'page'],
-     *     // Option 2 – provide a full custom GROQ query (takes precedence over `types`)
-     *     // Must return documents with at least: _id, _type, title, seo, _updatedAt
-     *     groq: `*[seo != null && defined(slug.current)]{ _id, _type, title, slug, seo, _updatedAt }`,
-     *   },
-     * }
-     * ```
-     */
-    healthDashboard?: boolean | {
-        tool?: {
-            title?: string;
-            name?: string;
-        };
-        toolTitle?: string;
-        content?: {
-            icon?: string;
-            title?: string;
-            description?: string;
-            /** Text shown while the license key is being verified. Defaults to "Verifying license…" */
-            loadingLicense?: string;
-            /** Text shown while documents are being fetched. Defaults to "Loading documents…" */
-            loadingDocuments?: string;
-            /** Text shown when the query returns zero results. Defaults to "No documents found" */
-            noDocuments?: string;
-        };
-        /**
-         * Show or hide the document type column in the results table.
-         * Defaults to `true`.
-         */
-        showTypeColumn?: boolean;
-        /**
-         * Show or hide the Sanity document `_id` under each title.
-         * Defaults to `true`.
-         */
-        showDocumentId?: boolean;
-        query?: {
-            /**
-             * Limit the dashboard to specific document types.
-             * Example: `['post', 'page']`
-             */
-            types?: string[];
-            /**
-             * When using `types`, also require the `seo` field to be non-null.
-             * Set to `false` to include documents of those types even if `seo` is missing.
-             * Defaults to `true`.
-             */
-            requireSeo?: boolean;
-            /**
-             * Provide a fully custom GROQ query. Takes precedence over `types`.
-             * The query must return documents with at least: _id, _type, title, seo, _updatedAt
-             */
-            groq?: string;
-        };
-        /**
-         * The Sanity API version to use for the client (e.g. '2023-01-01').
-         * Defaults to '2023-01-01'.
-         * @deprecated Use the root-level `apiVersion` option instead.
-         * @example
-         * // Before (deprecated):
-         * healthDashboard: { apiVersion: '2024-01-01' }
-         * // After:
-         * apiVersion: '2024-01-01'
-         */
-        apiVersion?: string;
-        /**
-         * License key for the SEO Health Dashboard pro feature.
-         * @deprecated Use the root-level `licenseKey` option instead.
-         */
-        licenseKey?: string;
-        /**
-         * Map raw `_type` values to human-readable display labels.
-         * Used in both 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 document type is rendered in the Type column.
-         * - `'badge'` (default) — coloured pill
-         * - `'text'` — plain text, useful for dense layouts
-         */
-        typeColumnMode?: 'badge' | 'text';
-        /**
-         * The document field to use as the display title in the dashboard.
-         *
-         * - `string` — use this field for every document type (e.g. `'name'`)
-         * - `Record<string, string>` — per-type mapping; unmapped types fall back to `title`
-         *
-         * @example
-         * titleField: 'name'
-         *
-         * @example
-         * 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;
-        /**
-         * The `name` of the Sanity structure tool that contains the monitored documents.
-         * Required when you have multiple structure tools and the documents live in a
-         * non-default one. Clicking a title will navigate to
-         * `/{basePath}/{structureTool}/intent/edit/…` directly.
-         *
-         * @example
-         * structureTool: 'common'
-         */
-        structureTool?: string;
-        /**
-         * 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`.
-         *
-         * @example
-         * previewMode: true
-         */
-        previewMode?: boolean;
-        /**
-         * Export options for the SEO Health Dashboard.
-         * Set to `true` (default) to enable both CSV and JSON export,
-         * or configure per-format.
-         */
-        export?: boolean | {
-            enabled?: boolean;
-            formats?: Array<'csv' | 'json'>;
-        };
-        /**
-         * Show compact inline stat pills in the header row instead of the
-         * full 6-card stats grid. Useful for saving vertical space.
-         * Defaults to `false`.
-         */
-        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>;
+import { c as SeoHealthMetrics } from './types-DxlPXihz.js';
+export { D as DocumentWithSeoHealth, d as SeoHealthStatus } from './types-DxlPXihz.js';
+import 'react';
 
 declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition;
 
@@ -416,4 +48,4 @@ interface SeoDocument {
 }
 declare const calculateHealthScore: (doc: SeoDocument) => SeoHealthMetrics;
 
-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 };
+export { SeoFieldsPluginConfig, SeoHealthMetrics, types as allSchemas, baseMeta as baseMetaSchema, calculateHealthScore, seofields as default, _default$2 as metaAttributeSchema, _default$1 as metaTagSchema, openGraph as openGraphSchema, _default as robotsSchema, seoFieldsSchema, twitter as twitterSchema };