sanity-plugin-seofields 1.6.0 → 1.6.2

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-import React from 'react';
+import { ComponentType, ReactNode } 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';
@@ -36,7 +36,7 @@ interface SeoFieldGroup {
      */
     fields: SeoObjectFieldName[];
     /** Optional icon displayed next to the tab title. Must be a React component. */
-    icon?: React.ComponentType;
+    icon?: ComponentType;
 }
 type ValidHiddenFieldKeys = Exclude<AllFieldKeys, 'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'>;
 interface FieldVisibilityConfig {
@@ -46,12 +46,17 @@ interface SeoFieldsPluginConfig {
     /**
      * 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 in the preview.
-     * The prefix function receives the current document as an argument and should return a string.
+     * 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'}`
+     *   prefix: (doc) => `/${doc.slug?.current || 'untitled'}`,
+     *   titleSuffix: 'Acme Corp',
+     *   // or dynamically:
+     *   titleSuffix: (doc) => doc.brandName || 'Acme Corp',
      * }
      * ```
      */
@@ -59,6 +64,38 @@ interface SeoFieldsPluginConfig {
         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.
@@ -95,6 +132,12 @@ interface SeoFieldsPluginConfig {
      * 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.
@@ -171,6 +214,12 @@ interface SeoFieldsPluginConfig {
         /**
          * 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;
         /**
@@ -383,17 +432,17 @@ interface SeoHealthDashboardProps {
      * Custom text shown while the license key is being verified.
      * Defaults to `"Verifying license…"`.
      */
-    loadingLicense?: React.ReactNode;
+    loadingLicense?: ReactNode;
     /**
      * Custom text shown while documents are being fetched.
      * Defaults to `"Loading documents…"`.
      */
-    loadingDocuments?: React.ReactNode;
+    loadingDocuments?: ReactNode;
     /**
      * Custom text shown when the query returns zero results.
      * Defaults to `"No documents found"`.
      */
-    noDocuments?: React.ReactNode;
+    noDocuments?: ReactNode;
     /**
      * Enable preview/demo mode to show dummy data.
      * Useful for testing, documentation, or showcasing the dashboard.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
-import React from 'react';
+import { ComponentType, ReactNode } 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';
@@ -36,7 +36,7 @@ interface SeoFieldGroup {
      */
     fields: SeoObjectFieldName[];
     /** Optional icon displayed next to the tab title. Must be a React component. */
-    icon?: React.ComponentType;
+    icon?: ComponentType;
 }
 type ValidHiddenFieldKeys = Exclude<AllFieldKeys, 'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'>;
 interface FieldVisibilityConfig {
@@ -46,12 +46,17 @@ interface SeoFieldsPluginConfig {
     /**
      * 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 in the preview.
-     * The prefix function receives the current document as an argument and should return a string.
+     * 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'}`
+     *   prefix: (doc) => `/${doc.slug?.current || 'untitled'}`,
+     *   titleSuffix: 'Acme Corp',
+     *   // or dynamically:
+     *   titleSuffix: (doc) => doc.brandName || 'Acme Corp',
      * }
      * ```
      */
@@ -59,6 +64,38 @@ interface SeoFieldsPluginConfig {
         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.
@@ -95,6 +132,12 @@ interface SeoFieldsPluginConfig {
      * 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.
@@ -171,6 +214,12 @@ interface SeoFieldsPluginConfig {
         /**
          * 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;
         /**
@@ -383,17 +432,17 @@ interface SeoHealthDashboardProps {
      * Custom text shown while the license key is being verified.
      * Defaults to `"Verifying license…"`.
      */
-    loadingLicense?: React.ReactNode;
+    loadingLicense?: ReactNode;
     /**
      * Custom text shown while documents are being fetched.
      * Defaults to `"Loading documents…"`.
      */
-    loadingDocuments?: React.ReactNode;
+    loadingDocuments?: ReactNode;
     /**
      * Custom text shown when the query returns zero results.
      * Defaults to `"No documents found"`.
      */
-    noDocuments?: React.ReactNode;
+    noDocuments?: ReactNode;
     /**
      * Enable preview/demo mode to show dummy data.
      * Useful for testing, documentation, or showcasing the dashboard.

package/dist/index.js

@@ -1,6 +1,6 @@
 import { getMetaTitleValidationMessages, getMetaDescriptionValidationMessages, getMetaImageValidation, getOgTitleValidation, getOgDescriptionValidation, getOgImageValidation, getOgImageUrlValidation, getTwitterTitleValidation, getTwitterDescriptionValidation, getTwitterImageValidation, getTwitterImageUrlValidation } from './chunk-25JLWVEU.js';
 import { __spreadValues, __spreadProps, __objRest } from './chunk-2NMEKWO5.js';
-import React12, { useMemo } from 'react';
+import { lazy, createElement, Suspense, useMemo } from 'react';
 import { defineType, defineField, definePlugin, useFormValue } from 'sanity';
 import { Stack, Text } from '@sanity/ui';
 import { jsxs, jsx } from 'react/jsx-runtime';
@@ -653,8 +653,8 @@ function twitter(config = {}) {
 }
 
 // src/schemas/index.ts
-var LazySeoPreview = React12.lazy(() => import('./SeoPreview-F6GGPZWI.js'));
-var SeoPreviewWrapper = (props) => React12.createElement(React12.Suspense, { fallback: null }, React12.createElement(LazySeoPreview, props));
+var LazySeoPreview = lazy(() => import('./SeoPreview-XVAZYHCL.js'));
+var SeoPreviewWrapper = (props) => createElement(Suspense, { fallback: null }, createElement(LazySeoPreview, props));
 function buildFieldGroupMap(groups) {
   const map = /* @__PURE__ */ new Map();
   for (const g of groups) {
@@ -715,9 +715,9 @@ function seoFieldsSchema(config = {}) {
             title: "SEO Preview",
             type: "string",
             components: { input: SeoPreviewWrapper },
-            options: __spreadValues({
+            options: __spreadValues(__spreadValues(__spreadValues(__spreadValues(__spreadValues({
               baseUrl: config.baseUrl || "https://www.example.com"
-            }, typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.prefix ? { prefix: config.seoPreview.prefix } : {}),
+            }, config.apiVersion ? { apiVersion: config.apiVersion } : {}), typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.prefix ? { prefix: config.seoPreview.prefix } : {}), typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.titleSuffix ? { titleSuffix: config.seoPreview.titleSuffix } : {}), typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.titleSuffixInheritColor ? { titleSuffixInheritColor: config.seoPreview.titleSuffixInheritColor } : {}), typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.titleSuffixQuery ? { titleSuffixQuery: config.seoPreview.titleSuffixQuery } : {}),
             initialValue: "",
             readOnly: true
           }),
@@ -979,9 +979,20 @@ function types(config = {}) {
 }
 
 // src/plugin.ts
-var resolveDashboardConfig = (healthDashboard) => {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
+var resolveDashboardConfig = (healthDashboard, rootApiVersion) => {
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o;
   const cfg = typeof healthDashboard === "object" ? healthDashboard : void 0;
+  const deprecationWarnings = [];
+  if ((cfg == null ? void 0 : cfg.apiVersion) !== void 0) {
+    deprecationWarnings.push({
+      key: "healthDashboard.apiVersion \u2192 apiVersion",
+      version: "v1.6.1",
+      changelogUrl: "https://github.com/hardik-143/sanity-plugin-seofields/blob/main/CHANGELOG.md"
+    });
+    console.warn(
+      '[sanity-plugin-seofields] "healthDashboard.apiVersion" is deprecated. Move it to the root "apiVersion" option instead.'
+    );
+  }
   return {
     enabled: healthDashboard !== false,
     toolTitle: (_b = (_a = cfg == null ? void 0 : cfg.tool) == null ? void 0 : _a.title) != null ? _b : "SEO Health",
@@ -994,15 +1005,15 @@ var resolveDashboardConfig = (healthDashboard) => {
     queryTypes: (_h = cfg == null ? void 0 : cfg.query) == null ? void 0 : _h.types,
     queryRequireSeo: (_i = cfg == null ? void 0 : cfg.query) == null ? void 0 : _i.requireSeo,
     queryGroq: (_j = cfg == null ? void 0 : cfg.query) == null ? void 0 : _j.groq,
-    apiVersion: cfg == null ? void 0 : cfg.apiVersion,
+    apiVersion: (_k = cfg == null ? void 0 : cfg.apiVersion) != null ? _k : rootApiVersion,
     licenseKey: cfg == null ? void 0 : cfg.licenseKey,
     typeDisplayLabels: cfg == null ? void 0 : cfg.typeDisplayLabels,
     typeColumnMode: cfg == null ? void 0 : cfg.typeColumnMode,
     titleField: cfg == null ? void 0 : cfg.titleField,
     getDocumentBadge: cfg == null ? void 0 : cfg.getDocumentBadge,
-    loadingLicense: (_k = cfg == null ? void 0 : cfg.content) == null ? void 0 : _k.loadingLicense,
-    loadingDocuments: (_l = cfg == null ? void 0 : cfg.content) == null ? void 0 : _l.loadingDocuments,
-    noDocuments: (_m = cfg == null ? void 0 : cfg.content) == null ? void 0 : _m.noDocuments,
+    loadingLicense: (_l = cfg == null ? void 0 : cfg.content) == null ? void 0 : _l.loadingLicense,
+    loadingDocuments: (_m = cfg == null ? void 0 : cfg.content) == null ? void 0 : _m.loadingDocuments,
+    noDocuments: (_n = cfg == null ? void 0 : cfg.content) == null ? void 0 : _n.noDocuments,
     previewMode: cfg == null ? void 0 : cfg.previewMode,
     structureTool: cfg == null ? void 0 : cfg.structureTool,
     exportEnabled: (() => {
@@ -1017,18 +1028,18 @@ var resolveDashboardConfig = (healthDashboard) => {
       if (typeof exportCfg === "object" && exportCfg.formats) return exportCfg.formats;
       return ["csv", "json"];
     })(),
-    compactStats: (_n = cfg == null ? void 0 : cfg.compactStats) != null ? _n : false,
-    deprecationWarnings: []
+    compactStats: (_o = cfg == null ? void 0 : cfg.compactStats) != null ? _o : false,
+    deprecationWarnings
   };
 };
 var seofields = definePlugin((config = {}) => {
   const { healthDashboard = true } = config;
-  const dash = resolveDashboardConfig(healthDashboard);
-  const LazySeoHealthTool = React12.lazy(() => import('./SeoHealthTool-XCXINAQI.js'));
-  const BoundSeoHealthTool = () => React12.createElement(
-    React12.Suspense,
+  const dash = resolveDashboardConfig(healthDashboard, config.apiVersion);
+  const LazySeoHealthTool = lazy(() => import('./SeoHealthTool-SKY7FAKK.js'));
+  const BoundSeoHealthTool = () => createElement(
+    Suspense,
     { fallback: null },
-    React12.createElement(LazySeoHealthTool, {
+    createElement(LazySeoHealthTool, {
       icon: dash.icon,
       title: dash.title,
       description: dash.description,
@@ -1071,11 +1082,11 @@ var seofields = definePlugin((config = {}) => {
   });
 });
 var plugin_default = seofields;
-var LazySeoHealthDashboard = React12.lazy(() => import('./SeoHealthDashboard-UWPLB5DM.js'));
+var LazySeoHealthDashboard = lazy(() => import('./SeoHealthDashboard-PY5MKJCZ.js'));
 function createSeoHealthPane(optionsOrS, optionsWhenS) {
   const S = optionsOrS;
   const _a = optionsWhenS != null ? optionsWhenS : {}, { query, openInPane = true, title: paneTitle } = _a, rest = __objRest(_a, ["query", "openInPane", "title"]);
-  const SeoHealthPane = () => /* @__PURE__ */ jsx(React12.Suspense, { fallback: null, children: /* @__PURE__ */ jsx(
+  const SeoHealthPane = () => /* @__PURE__ */ jsx(Suspense, { fallback: null, children: /* @__PURE__ */ jsx(
     LazySeoHealthDashboard,
     __spreadValues({
       customQuery: query,