sanity-plugin-seofields 1.5.3 → 1.5.5

package/dist/index.d.cts

@@ -1,9 +1,9 @@
 import * as sanity from 'sanity';
 import { SchemaTypeDefinition } from 'sanity';
+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 React from 'react';
 
 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.
@@ -273,6 +312,8 @@ declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefi
 
 declare function types(config?: SeoFieldsPluginConfig): SchemaTypeDefinition[];
 
+declare function baseMeta(config?: SeoFieldsPluginConfig): SchemaTypeDefinition;
+
 declare const _default$2: {
     type: "object";
     name: "metaAttribute";
@@ -500,4 +541,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, 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 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 React from 'react';
 
 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.
@@ -273,6 +312,8 @@ declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefi
 
 declare function types(config?: SeoFieldsPluginConfig): SchemaTypeDefinition[];
 
+declare function baseMeta(config?: SeoFieldsPluginConfig): SchemaTypeDefinition;
+
 declare const _default$2: {
     type: "object";
     name: "metaAttribute";
@@ -500,4 +541,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, 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.js

@@ -655,69 +655,181 @@ function twitter(config = {}) {
 // src/schemas/index.ts
 var LazySeoPreview = React12.lazy(() => import('./SeoPreview-G3LPA7GV.js'));
 var SeoPreviewWrapper = (props) => React12.createElement(React12.Suspense, { fallback: null }, React12.createElement(LazySeoPreview, props));
+function buildFieldGroupMap(groups) {
+  const map = /* @__PURE__ */ new Map();
+  for (const g of groups) {
+    for (const fieldName of g.fields) {
+      const existing = map.get(fieldName);
+      if (existing) {
+        existing.push(g.name);
+      } else {
+        map.set(fieldName, [g.name]);
+      }
+    }
+  }
+  return map;
+}
+function toSanityGroups(groups) {
+  return groups.map((g) => {
+    const def = {
+      name: g.name,
+      title: g.title,
+      default: g.default
+    };
+    if (g.icon && typeof g.icon !== "string") {
+      def.icon = g.icon;
+    }
+    return def;
+  });
+}
+function withGroup(field, fieldGroupMap) {
+  if (!fieldGroupMap) return field;
+  const groups = fieldGroupMap.get(field.name);
+  if (!groups || groups.length === 0) return field;
+  return __spreadProps(__spreadValues({}, field), { group: groups.length === 1 ? groups[0] : groups });
+}
 function seoFieldsSchema(config = {}) {
-  return defineType({
+  const groupsCfg = config.fieldGroups;
+  const fieldGroupMap = (groupsCfg == null ? void 0 : groupsCfg.length) ? buildFieldGroupMap(groupsCfg) : void 0;
+  const sanityGroups = (groupsCfg == null ? void 0 : groupsCfg.length) ? toSanityGroups(groupsCfg) : void 0;
+  return defineType(__spreadProps(__spreadValues({
     name: "seoFields",
     title: "SEO Fields",
-    type: "object",
+    type: "object"
+  }, sanityGroups ? { groups: sanityGroups } : {}), {
     fields: [
-      defineField({
-        name: "robots",
-        title: "Robots Settings",
-        type: "robots",
-        // Use the separate robots type here
-        hidden: getFieldHiddenFunction("robots", config)
-      }),
+      withGroup(
+        defineField({
+          name: "robots",
+          title: "Robots Settings",
+          type: "robots",
+          hidden: getFieldHiddenFunction("robots", config)
+        }),
+        fieldGroupMap
+      ),
       // 👇 conditionally spread preview field
       ...typeof config.seoPreview === "boolean" && config.seoPreview || typeof config.seoPreview === "object" && !isEmpty(config.seoPreview) ? [
-        defineField({
-          name: "preview",
-          title: "SEO Preview",
-          type: "string",
-          components: { input: SeoPreviewWrapper },
-          options: __spreadValues({
-            baseUrl: config.baseUrl || "https://www.example.com"
-          }, typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.prefix ? { prefix: config.seoPreview.prefix } : {}),
-          // Use a readOnly field to prevent editing
-          // This field is just for preview purposes
-          initialValue: "",
-          // Set an initial value
-          readOnly: true
-        })
+        withGroup(
+          defineField({
+            name: "preview",
+            title: "SEO Preview",
+            type: "string",
+            components: { input: SeoPreviewWrapper },
+            options: __spreadValues({
+              baseUrl: config.baseUrl || "https://www.example.com"
+            }, typeof config.seoPreview === "object" && config.seoPreview && config.seoPreview.prefix ? { prefix: config.seoPreview.prefix } : {}),
+            initialValue: "",
+            readOnly: true
+          }),
+          fieldGroupMap
+        )
       ] : [],
+      withGroup(
+        defineField(__spreadProps(__spreadValues({
+          name: "title"
+        }, getFieldInfo("title", config.fieldOverrides)), {
+          type: "string",
+          components: {
+            input: MetaTitle_default
+          },
+          hidden: getFieldHiddenFunction("title", config)
+        })),
+        fieldGroupMap
+      ),
+      withGroup(
+        defineField(__spreadProps(__spreadValues({
+          name: "description"
+        }, getFieldInfo("description", config.fieldOverrides)), {
+          type: "text",
+          rows: 3,
+          components: {
+            input: MetaDescription_default
+          },
+          hidden: getFieldHiddenFunction("description", config)
+        })),
+        fieldGroupMap
+      ),
+      withGroup(
+        defineField(__spreadProps(__spreadValues({
+          name: "metaImage"
+        }, getFieldInfo("metaImage", config.fieldOverrides)), {
+          type: "image",
+          options: {
+            hotspot: true
+          },
+          components: {
+            input: MetaImage_default
+          },
+          hidden: getFieldHiddenFunction("metaImage", config)
+        })),
+        fieldGroupMap
+      ),
+      withGroup(
+        defineField(__spreadProps(__spreadValues({
+          name: "metaAttributes"
+        }, getFieldInfo("metaAttributes", config.fieldOverrides)), {
+          type: "array",
+          of: [{ type: "metaAttribute" }],
+          hidden: getFieldHiddenFunction("metaAttributes", config)
+        })),
+        fieldGroupMap
+      ),
+      withGroup(
+        defineField(__spreadProps(__spreadValues({
+          name: "keywords"
+        }, getFieldInfo("keywords", config.fieldOverrides)), {
+          title: "Keywords",
+          type: "array",
+          of: [{ type: "string" }],
+          description: "Add relevant keywords for this page. These keywords will be used for SEO purposes.",
+          hidden: getFieldHiddenFunction("keywords", config)
+        })),
+        fieldGroupMap
+      ),
+      withGroup(
+        defineField(__spreadProps(__spreadValues({
+          name: "canonicalUrl"
+        }, getFieldInfo("canonicalUrl", config.fieldOverrides)), {
+          title: "Canonical URL",
+          type: "url",
+          description: "Specify the canonical URL for this page. This helps prevent duplicate content issues by indicating the preferred version of a page.",
+          hidden: getFieldHiddenFunction("canonicalUrl", config)
+        })),
+        fieldGroupMap
+      ),
+      withGroup(openGraph(config), fieldGroupMap),
+      withGroup(twitter(config), fieldGroupMap)
+    ]
+  }));
+}
+function baseMeta(config = {}) {
+  return defineType({
+    name: "baseMeta",
+    title: "Basic Meta Settings",
+    type: "object",
+    fields: [
       defineField(__spreadProps(__spreadValues({
         name: "title"
       }, getFieldInfo("title", config.fieldOverrides)), {
-        // title: 'Meta Title',
         type: "string",
-        // description:
-        // 'The meta title is displayed in search engine results as the clickable headline for a given result. It should be concise and accurately reflect the content of the page.',
         components: {
           input: MetaTitle_default
         },
-        // validation: (Rule) => Rule.max(60).warning('Meta title should be under 60 characters.'),
         hidden: getFieldHiddenFunction("title", config)
       })),
       defineField(__spreadProps(__spreadValues({
         name: "description"
       }, getFieldInfo("description", config.fieldOverrides)), {
-        // title: 'Meta Description',
-        // description:
-        //   'Provide a concise summary of the page content. This description may be used by search engines in search results.',
         type: "text",
         rows: 3,
         components: {
           input: MetaDescription_default
         },
-        // validation: (Rule) => Rule.max(160).warning('Meta description should be under 160 characters.'),
         hidden: getFieldHiddenFunction("description", config)
       })),
       defineField(__spreadProps(__spreadValues({
         name: "metaImage"
       }, getFieldInfo("metaImage", config.fieldOverrides)), {
-        // title: 'Meta Image',
-        // description:
-        // 'Upload an image that represents the content of the page. This image may be used in social media previews and search engine results.',
         type: "image",
         options: {
           hotspot: true
@@ -727,15 +839,6 @@ function seoFieldsSchema(config = {}) {
         },
         hidden: getFieldHiddenFunction("metaImage", config)
       })),
-      defineField(__spreadProps(__spreadValues({
-        name: "metaAttributes"
-      }, getFieldInfo("metaAttributes", config.fieldOverrides)), {
-        type: "array",
-        of: [{ type: "metaAttribute" }],
-        // description:
-        //   'Add custom meta attributes to the head of the document for additional SEO and social media integration.',
-        hidden: getFieldHiddenFunction("metaAttributes", config)
-      })),
       defineField(__spreadProps(__spreadValues({
         name: "keywords"
       }, getFieldInfo("keywords", config.fieldOverrides)), {
@@ -753,8 +856,13 @@ function seoFieldsSchema(config = {}) {
         description: "Specify the canonical URL for this page. This helps prevent duplicate content issues by indicating the preferred version of a page.",
         hidden: getFieldHiddenFunction("canonicalUrl", config)
       })),
-      openGraph(config),
-      twitter(config)
+      defineField(__spreadProps(__spreadValues({
+        name: "metaAttributes"
+      }, getFieldInfo("metaAttributes", config.fieldOverrides)), {
+        type: "array",
+        of: [{ type: "metaAttribute" }],
+        hidden: getFieldHiddenFunction("metaAttributes", config)
+      }))
     ]
   });
 }
@@ -858,6 +966,8 @@ function types(config = {}) {
   return [
     seoFieldsSchema(config),
     // pass config here
+    baseMeta(config),
+    // pass config here
     openGraph(config),
     // pass config here
     twitter(config),
@@ -1053,6 +1163,6 @@ function createSeoHealthPane(optionsOrS, optionsWhenS) {
 // src/index.ts
 var src_default = plugin_default;
 
-export { types as allSchemas, createSeoHealthPane, src_default as default, metaAttribute_default as metaAttributeSchema, metaTag_default as metaTagSchema, openGraph as openGraphSchema, robots_default as robotsSchema, seoFieldsSchema, twitter as twitterSchema };
+export { types as allSchemas, baseMeta as baseMetaSchema, createSeoHealthPane, src_default as default, metaAttribute_default as metaAttributeSchema, metaTag_default as metaTagSchema, openGraph as openGraphSchema, robots_default as robotsSchema, seoFieldsSchema, twitter as twitterSchema };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map