sanity-plugin-seofields 1.6.4 → 1.7.0

package/dist/index.d.cts

@@ -1,8 +1,8 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
 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 { D as DocumentWithSeoHealth$1 } from './types-B91ena4g.cjs';
+export { S as SeoHealthMetrics, a as SeoHealthStatus } from './types-B91ena4g.cjs';
 import { StructureBuilder, ComponentBuilder } from 'sanity/structure';
 
 interface SeoFieldConfig {
@@ -267,7 +267,7 @@ interface SeoFieldsPluginConfig {
          *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
          * }
          */
-        getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
+        getDocumentBadge?: (doc: DocumentWithSeoHealth$1 & Record<string, unknown>) => {
             label: string;
             bgColor?: string;
             textColor?: string;
@@ -347,6 +347,98 @@ 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;
@@ -543,4 +635,4 @@ interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuer
  */
 declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
 
-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 };
+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 };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
 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 { 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';
 
 interface SeoFieldConfig {
@@ -267,7 +267,7 @@ interface SeoFieldsPluginConfig {
          *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
          * }
          */
-        getDocumentBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) => {
+        getDocumentBadge?: (doc: DocumentWithSeoHealth$1 & Record<string, unknown>) => {
             label: string;
             bgColor?: string;
             textColor?: string;
@@ -347,6 +347,98 @@ 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;
@@ -543,4 +635,4 @@ interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuer
  */
 declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
 
-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 };
+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 };

package/dist/index.js

@@ -1,7 +1,7 @@
-import { getMetaTitleValidationMessages, getMetaDescriptionValidationMessages, getMetaImageValidation, getOgTitleValidation, getOgDescriptionValidation, getOgImageValidation, getOgImageUrlValidation, getTwitterTitleValidation, getTwitterDescriptionValidation, getTwitterImageValidation, getTwitterImageUrlValidation } from './chunk-25JLWVEU.js';
+import { getMetaTitleValidationMessages, getMetaDescriptionValidationMessages, getMetaImageValidation, getOgTitleValidation, getOgDescriptionValidation, getOgImageValidation, getOgImageUrlValidation, getTwitterTitleValidation, getTwitterDescriptionValidation, getTwitterImageValidation, getTwitterImageUrlValidation } from './chunk-HDZZQCH7.js';
 import { __spreadValues, __spreadProps, __objRest } from './chunk-2NMEKWO5.js';
-import { lazy, createElement, Suspense, useMemo } from 'react';
-import { defineType, defineField, definePlugin, useFormValue } from 'sanity';
+import { lazy, createElement, Suspense, useMemo, useState, useEffect } from 'react';
+import { defineType, defineField, definePlugin, useFormValue, useClient } from 'sanity';
 import { Stack, Text } from '@sanity/ui';
 import { jsxs, jsx } from 'react/jsx-runtime';
 
@@ -56,13 +56,37 @@ var MetaImage = (props) => {
 };
 var MetaImage_default = MetaImage;
 var MetaTitle = (props) => {
-  const { value, renderDefault, path } = props;
+  var _a, _b;
+  const { value, renderDefault, path, schemaType } = props;
+  const { options } = schemaType;
   const parent = useFormValue([path[0]]);
   const isParentseoField = parent && (parent == null ? void 0 : parent._type) === "seoFields";
   const keywords = useMemo(() => (parent == null ? void 0 : parent.keywords) || [], [parent == null ? void 0 : parent.keywords]);
+  const rootDoc = (_a = useFormValue([])) != null ? _a : {};
+  const client = useClient({ apiVersion: (_b = options == null ? void 0 : options.apiVersion) != null ? _b : "2024-01-01" });
+  const [groqTitleSuffix, setGroqTitleSuffix] = useState("");
+  const titleSuffixQuery = options == null ? void 0 : options.titleSuffixQuery;
+  const titleSuffixOption = options == null ? void 0 : options.titleSuffix;
+  useEffect(() => {
+    if (!titleSuffixQuery) return;
+    client.fetch(titleSuffixQuery).then((result) => {
+      setGroqTitleSuffix(result === null || result === void 0 ? "" : String(result));
+    }).catch(() => {
+      setGroqTitleSuffix("");
+    });
+  }, [titleSuffixQuery, client]);
+  const resolvedSuffix = useMemo(() => {
+    if (titleSuffixQuery) return groqTitleSuffix;
+    if (!titleSuffixOption) return "";
+    if (typeof titleSuffixOption === "function") {
+      return titleSuffixOption(rootDoc);
+    }
+    return titleSuffixOption;
+  }, [titleSuffixQuery, groqTitleSuffix, titleSuffixOption, rootDoc]);
+  const suffixLength = resolvedSuffix ? resolvedSuffix.length + 3 : 0;
   const feedbackItems = useMemo(
-    () => getMetaTitleValidationMessages(value || "", keywords, isParentseoField),
-    [value, keywords, isParentseoField]
+    () => getMetaTitleValidationMessages(value || "", keywords, isParentseoField, suffixLength),
+    [value, keywords, isParentseoField, suffixLength]
   );
   return /* @__PURE__ */ jsxs(Stack, { space: 3, children: [
     renderDefault(props),
@@ -653,7 +677,7 @@ function twitter(config = {}) {
 }
 
 // src/schemas/index.ts
-var LazySeoPreview = lazy(() => import('./SeoPreview-XVAZYHCL.js'));
+var LazySeoPreview = lazy(() => import('./SeoPreview-KEGGQSPJ.js'));
 var SeoPreviewWrapper = (props) => createElement(Suspense, { fallback: null }, createElement(LazySeoPreview, props));
 function buildFieldGroupMap(groups) {
   const map = /* @__PURE__ */ new Map();
@@ -732,6 +756,7 @@ function seoFieldsSchema(config = {}) {
           components: {
             input: MetaTitle_default
           },
+          options: __spreadValues(__spreadValues(__spreadValues({}, config.apiVersion ? { apiVersion: config.apiVersion } : {}), typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.titleSuffix ? { titleSuffix: config.seoPreview.titleSuffix } : {}), typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.titleSuffixQuery ? { titleSuffixQuery: config.seoPreview.titleSuffixQuery } : {}),
           hidden: getFieldHiddenFunction("title", config)
         })),
         fieldGroupMap
@@ -1035,7 +1060,7 @@ var resolveDashboardConfig = (healthDashboard, rootApiVersion) => {
 var seofields = definePlugin((config = {}) => {
   const { healthDashboard = true } = config;
   const dash = resolveDashboardConfig(healthDashboard, config.apiVersion);
-  const LazySeoHealthTool = lazy(() => import('./SeoHealthTool-BSTYAKQS.js'));
+  const LazySeoHealthTool = lazy(() => import('./SeoHealthTool-IULT4G25.js'));
   const BoundSeoHealthTool = () => createElement(
     Suspense,
     { fallback: null },
@@ -1082,7 +1107,7 @@ var seofields = definePlugin((config = {}) => {
   });
 });
 var plugin_default = seofields;
-var LazySeoHealthDashboard = lazy(() => import('./SeoHealthDashboard-BEZVLLFG.js'));
+var LazySeoHealthDashboard = lazy(() => import('./SeoHealthDashboard-PTUEVYZL.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"]);