sanity-plugin-seofields 1.5.4 → 1.6.0

package/dist/index.d.cts

@@ -1,9 +1,9 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-import { D as DocumentWithSeoHealth, c as DeprecationWarning } from './types-R3n9Fu4w.cjs';
-export { d as SeoHealthMetrics, e as SeoHealthStatus } from './types-R3n9Fu4w.cjs';
-import { StructureBuilder, ComponentBuilder } from 'sanity/structure';
 import React from 'react';
+import { D as DocumentWithSeoHealth, a as DeprecationWarning } from './types-BtSRRG6C.cjs';
+export { S as SeoHealthMetrics, b as SeoHealthStatus } from './types-BtSRRG6C.cjs';
+import { StructureBuilder, ComponentBuilder } from 'sanity/structure';
 
 interface SeoFieldConfig {
     title?: string;
@@ -13,6 +13,31 @@ type SeoFieldKeys = 'title' | 'description' | 'canonicalUrl' | 'metaImage' | 'ke
 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';
+/**
+ * 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?: React.ComponentType;
+}
 type ValidHiddenFieldKeys = Exclude<AllFieldKeys, 'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'>;
 interface FieldVisibilityConfig {
     hiddenFields?: ValidHiddenFieldKeys[];
@@ -51,6 +76,20 @@ interface SeoFieldsPluginConfig {
      * 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[];
     /**
      * The base URL of your website, used for generating full URLs in the SEO preview.
      * Defaults to 'https://www.example.com' if not provided.
@@ -101,25 +140,13 @@ interface SeoFieldsPluginConfig {
             /** Text shown when the query returns zero results. Defaults to "No documents found" */
             noDocuments?: string;
         };
-        /**
-         * @deprecated Use `showTypeColumn` instead. Will be removed in a future major version.
-         * @see https://github.com/hardik-143/sanity-plugin-seofields/blob/main/CHANGELOG.md#132--2026-03-23
-         */
-        display?: {
-            /** @deprecated Use top-level `showTypeColumn` instead. */
-            typeColumn?: boolean;
-            /** @deprecated Use top-level `showDocumentId` instead. */
-            documentId?: boolean;
-        };
         /**
          * Show or hide the document type column in the results table.
-         * Replaces the deprecated `display.typeColumn`.
          * Defaults to `true`.
          */
         showTypeColumn?: boolean;
         /**
          * Show or hide the Sanity document `_id` under each title.
-         * Replaces the deprecated `display.documentId`.
          * Defaults to `true`.
          */
         showDocumentId?: boolean;
@@ -156,19 +183,6 @@ interface SeoFieldsPluginConfig {
          * Used in both the Type column and the Type filter dropdown.
          * Any type without an entry falls back to the raw `_type` string.
          *
-         * @deprecated Use `typeDisplayLabels` instead. Will be removed in a future major version.
-         * @see https://github.com/hardik-143/sanity-plugin-seofields/blob/main/CHANGELOG.md#132--2026-03-23
-         *
-         * @example
-         * typeLabels: { productDrug: 'Products', singleCondition: 'Condition' }
-         */
-        typeLabels?: Record<string, string>;
-        /**
-         * Map raw `_type` values to human-readable display labels.
-         * Replaces the deprecated `typeLabels`.
-         * 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' }
          */
@@ -196,26 +210,6 @@ interface SeoFieldsPluginConfig {
          * Callback function to render a custom badge next to the document title.
          * Receives the full document and should return badge data or undefined.
          *
-         * @deprecated Use `getDocumentBadge` instead. Will be removed in a future major version.
-         * @see https://github.com/hardik-143/sanity-plugin-seofields/blob/main/CHANGELOG.md#132--2026-03-23
-         *
-         * @example
-         * docBadge: (doc) => {
-         *   if (doc.services === 'NHS')
-         *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
-         * }
-         */
-        docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
-            label: string;
-            bgColor?: string;
-            textColor?: string;
-            fontSize?: string;
-        } | undefined;
-        /**
-         * Callback function to render a custom badge next to the document title.
-         * Replaces the deprecated `docBadge`.
-         * Receives the full document and should return badge data or undefined.
-         *
          * @example
          * getDocumentBadge: (doc) => {
          *   if (doc.services === 'NHS')
@@ -340,7 +334,6 @@ interface SeoHealthDashboardProps {
     /**
      * Map raw `_type` values to human-readable display labels used in the
      * Type column and the Type filter dropdown.
-     * Replaces the deprecated `typeLabels`.
      * Any type without an entry falls back to the raw `_type` string.
      *
      * @example
@@ -370,7 +363,6 @@ interface SeoHealthDashboardProps {
     titleField?: string | Record<string, string>;
     /**
      * Callback function to render a custom badge next to the document title.
-     * Replaces the deprecated `docBadge`.
      * Receives the full document and should return badge data or undefined.
      *
      * @example
@@ -502,4 +494,4 @@ interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuer
  */
 declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
 
-export { type AllFieldKeys, DocumentWithSeoHealth, type FieldVisibilityConfig, type SeoFieldConfig, type SeoFieldKeys, type SeoFieldsPluginConfig, type SeoHealthPaneOptions, 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 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 };

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-import { D as DocumentWithSeoHealth, c as DeprecationWarning } from './types-R3n9Fu4w.js';
-export { d as SeoHealthMetrics, e as SeoHealthStatus } from './types-R3n9Fu4w.js';
-import { StructureBuilder, ComponentBuilder } from 'sanity/structure';
 import React from 'react';
+import { D as DocumentWithSeoHealth, a as DeprecationWarning } from './types-BtSRRG6C.js';
+export { S as SeoHealthMetrics, b as SeoHealthStatus } from './types-BtSRRG6C.js';
+import { StructureBuilder, ComponentBuilder } from 'sanity/structure';
 
 interface SeoFieldConfig {
     title?: string;
@@ -13,6 +13,31 @@ type SeoFieldKeys = 'title' | 'description' | 'canonicalUrl' | 'metaImage' | 'ke
 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';
+/**
+ * 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?: React.ComponentType;
+}
 type ValidHiddenFieldKeys = Exclude<AllFieldKeys, 'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'>;
 interface FieldVisibilityConfig {
     hiddenFields?: ValidHiddenFieldKeys[];
@@ -51,6 +76,20 @@ interface SeoFieldsPluginConfig {
      * 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[];
     /**
      * The base URL of your website, used for generating full URLs in the SEO preview.
      * Defaults to 'https://www.example.com' if not provided.
@@ -101,25 +140,13 @@ interface SeoFieldsPluginConfig {
             /** Text shown when the query returns zero results. Defaults to "No documents found" */
             noDocuments?: string;
         };
-        /**
-         * @deprecated Use `showTypeColumn` instead. Will be removed in a future major version.
-         * @see https://github.com/hardik-143/sanity-plugin-seofields/blob/main/CHANGELOG.md#132--2026-03-23
-         */
-        display?: {
-            /** @deprecated Use top-level `showTypeColumn` instead. */
-            typeColumn?: boolean;
-            /** @deprecated Use top-level `showDocumentId` instead. */
-            documentId?: boolean;
-        };
         /**
          * Show or hide the document type column in the results table.
-         * Replaces the deprecated `display.typeColumn`.
          * Defaults to `true`.
          */
         showTypeColumn?: boolean;
         /**
          * Show or hide the Sanity document `_id` under each title.
-         * Replaces the deprecated `display.documentId`.
          * Defaults to `true`.
          */
         showDocumentId?: boolean;
@@ -156,19 +183,6 @@ interface SeoFieldsPluginConfig {
          * Used in both the Type column and the Type filter dropdown.
          * Any type without an entry falls back to the raw `_type` string.
          *
-         * @deprecated Use `typeDisplayLabels` instead. Will be removed in a future major version.
-         * @see https://github.com/hardik-143/sanity-plugin-seofields/blob/main/CHANGELOG.md#132--2026-03-23
-         *
-         * @example
-         * typeLabels: { productDrug: 'Products', singleCondition: 'Condition' }
-         */
-        typeLabels?: Record<string, string>;
-        /**
-         * Map raw `_type` values to human-readable display labels.
-         * Replaces the deprecated `typeLabels`.
-         * 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' }
          */
@@ -196,26 +210,6 @@ interface SeoFieldsPluginConfig {
          * Callback function to render a custom badge next to the document title.
          * Receives the full document and should return badge data or undefined.
          *
-         * @deprecated Use `getDocumentBadge` instead. Will be removed in a future major version.
-         * @see https://github.com/hardik-143/sanity-plugin-seofields/blob/main/CHANGELOG.md#132--2026-03-23
-         *
-         * @example
-         * docBadge: (doc) => {
-         *   if (doc.services === 'NHS')
-         *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
-         * }
-         */
-        docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
-            label: string;
-            bgColor?: string;
-            textColor?: string;
-            fontSize?: string;
-        } | undefined;
-        /**
-         * Callback function to render a custom badge next to the document title.
-         * Replaces the deprecated `docBadge`.
-         * Receives the full document and should return badge data or undefined.
-         *
          * @example
          * getDocumentBadge: (doc) => {
          *   if (doc.services === 'NHS')
@@ -340,7 +334,6 @@ interface SeoHealthDashboardProps {
     /**
      * Map raw `_type` values to human-readable display labels used in the
      * Type column and the Type filter dropdown.
-     * Replaces the deprecated `typeLabels`.
      * Any type without an entry falls back to the raw `_type` string.
      *
      * @example
@@ -370,7 +363,6 @@ interface SeoHealthDashboardProps {
     titleField?: string | Record<string, string>;
     /**
      * Callback function to render a custom badge next to the document title.
-     * Replaces the deprecated `docBadge`.
      * Receives the full document and should return badge data or undefined.
      *
      * @example
@@ -502,4 +494,4 @@ interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuer
  */
 declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
 
-export { type AllFieldKeys, DocumentWithSeoHealth, type FieldVisibilityConfig, type SeoFieldConfig, type SeoFieldKeys, type SeoFieldsPluginConfig, type SeoHealthPaneOptions, 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 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 };