sanity-plugin-seofields 1.3.1 → 1.4.0

package/dist/index.d.cts

@@ -1,10 +1,9 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-import { D as DocumentWithSeoHealth } from './types-B91ena4g.cjs';
-export { S as SeoHealthMetrics, a as SeoHealthStatus } from './types-B91ena4g.cjs';
-import React from 'react';
+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 * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
 
 interface SeoFieldConfig {
     title?: string;
@@ -102,10 +101,28 @@ 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;
         query?: {
             /**
              * Limit the dashboard to specific document types.
@@ -139,10 +156,23 @@ 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' }
+         */
+        typeDisplayLabels?: Record<string, string>;
         /**
          * Controls how the document type is rendered in the Type column.
          * - `'badge'` (default) — coloured pill
@@ -166,15 +196,35 @@ 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')
+         *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
          *   if (doc.services === 'Private')
          *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
          * }
          */
-        docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
+        getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
             label: string;
             bgColor?: string;
             textColor?: string;
@@ -273,12 +323,13 @@ 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
-     * typeLabels={{ productDrug: 'Products', singleCondition: 'Condition' }}
+     * typeDisplayLabels={{ productDrug: 'Products', singleCondition: 'Condition' }}
      */
-    typeLabels?: Record<string, string>;
+    typeDisplayLabels?: Record<string, string>;
     /**
      * Controls how the type is rendered in the Type column.
      * - `'badge'` (default) — coloured pill, consistent with score badges
@@ -302,17 +353,18 @@ 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
-     * docBadge: (doc) => {
+     * getDocumentBadge: (doc) => {
      *   if (doc.services === 'NHS')
      *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
      *   if (doc.services === 'Private')
      *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
      * }
      */
-    docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
+    getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
         label: string;
         bgColor?: string;
         textColor?: string;
@@ -365,8 +417,13 @@ interface SeoHealthDashboardProps {
      * 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[];
 }
-declare const SeoHealthDashboard: React.FC<SeoHealthDashboardProps>;
 
 /**
  * Options accepted by `createSeoHealthPane`.
@@ -413,10 +470,4 @@ interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuer
  */
 declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
 
-/**
- * Sanity Tool component for the SEO Health Dashboard
- * This component wraps the SeoHealthDashboard for use as a custom tool in Sanity Studio
- */
-declare const SeoHealthTool: (props: SeoHealthDashboardProps) => react_jsx_runtime.JSX.Element;
-
-export { type AllFieldKeys, DocumentWithSeoHealth, type FieldVisibilityConfig, type SeoFieldConfig, type SeoFieldKeys, type SeoFieldsPluginConfig, SeoHealthDashboard, type SeoHealthPaneOptions, SeoHealthTool, type ValidHiddenFieldKeys, types as allSchemas, 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 SeoFieldKeys, type SeoFieldsPluginConfig, type SeoHealthPaneOptions, type ValidHiddenFieldKeys, types as allSchemas, 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,10 +1,9 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-import { D as DocumentWithSeoHealth } from './types-B91ena4g.js';
-export { S as SeoHealthMetrics, a as SeoHealthStatus } from './types-B91ena4g.js';
-import React from 'react';
+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 * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
 
 interface SeoFieldConfig {
     title?: string;
@@ -102,10 +101,28 @@ 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;
         query?: {
             /**
              * Limit the dashboard to specific document types.
@@ -139,10 +156,23 @@ 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' }
+         */
+        typeDisplayLabels?: Record<string, string>;
         /**
          * Controls how the document type is rendered in the Type column.
          * - `'badge'` (default) — coloured pill
@@ -166,15 +196,35 @@ 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')
+         *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
          *   if (doc.services === 'Private')
          *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
          * }
          */
-        docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
+        getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
             label: string;
             bgColor?: string;
             textColor?: string;
@@ -273,12 +323,13 @@ 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
-     * typeLabels={{ productDrug: 'Products', singleCondition: 'Condition' }}
+     * typeDisplayLabels={{ productDrug: 'Products', singleCondition: 'Condition' }}
      */
-    typeLabels?: Record<string, string>;
+    typeDisplayLabels?: Record<string, string>;
     /**
      * Controls how the type is rendered in the Type column.
      * - `'badge'` (default) — coloured pill, consistent with score badges
@@ -302,17 +353,18 @@ 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
-     * docBadge: (doc) => {
+     * getDocumentBadge: (doc) => {
      *   if (doc.services === 'NHS')
      *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
      *   if (doc.services === 'Private')
      *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
      * }
      */
-    docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
+    getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
         label: string;
         bgColor?: string;
         textColor?: string;
@@ -365,8 +417,13 @@ interface SeoHealthDashboardProps {
      * 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[];
 }
-declare const SeoHealthDashboard: React.FC<SeoHealthDashboardProps>;
 
 /**
  * Options accepted by `createSeoHealthPane`.
@@ -413,10 +470,4 @@ interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuer
  */
 declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
 
-/**
- * Sanity Tool component for the SEO Health Dashboard
- * This component wraps the SeoHealthDashboard for use as a custom tool in Sanity Studio
- */
-declare const SeoHealthTool: (props: SeoHealthDashboardProps) => react_jsx_runtime.JSX.Element;
-
-export { type AllFieldKeys, DocumentWithSeoHealth, type FieldVisibilityConfig, type SeoFieldConfig, type SeoFieldKeys, type SeoFieldsPluginConfig, SeoHealthDashboard, type SeoHealthPaneOptions, SeoHealthTool, type ValidHiddenFieldKeys, types as allSchemas, 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 SeoFieldKeys, type SeoFieldsPluginConfig, type SeoHealthPaneOptions, type ValidHiddenFieldKeys, types as allSchemas, 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 };