sanity-plugin-seofields 1.0.5 → 1.0.7

package/README.md

@@ -3,19 +3,20 @@
 [![npm version](https://badge.fury.io/js/sanity-plugin-seofields.svg)](https://badge.fury.io/js/sanity-plugin-seofields)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A comprehensive Sanity Studio v3 plugin to manage SEO fields like meta titles, descriptions, Open Graph tags, and Twitter Cards for structured, search-optimized content.
+A comprehensive Sanity Studio v3 plugin to manage SEO fields like meta titles, descriptions, Open Graph tags, and X (Formerly Twitter) Cards for structured, search-optimized content.
 
 ## ✨ Features
 
 - 🎯 **Meta Tags**: Title, description, keywords, and canonical URLs
 - 📱 **Open Graph**: Complete social media sharing optimization
-- 🐦 **Twitter Cards**: Twitter-specific meta tags with image support
+- 🐦 **X (Formerly Twitter) Cards**: X-specific meta tags with image support
 - 🤖 **Robots Control**: Index/follow settings for search engines
 - 🖼️ **Image Management**: Optimized image handling for social sharing
 - 📋 **Live Preview**: Real-time SEO preview as you edit
 - 🔧 **TypeScript Support**: Full type definitions included
 - 📊 **Custom Attributes**: Flexible meta attribute system
 - ✅ **Validation**: Built-in character limits and best practices
+- 🎛️ **Field Visibility**: Hide sitewide fields on specific content types
 
 ## 📦 Installation
 
@@ -112,7 +113,7 @@ export default defineType({
     }),
     defineField({
       name: 'twitterCard',
-      title: 'Twitter Card',
+      title: 'X (Formerly Twitter) Card',
       type: 'twitter',
     }),
     defineField({
@@ -130,7 +131,7 @@ export default defineType({
 | --------------- | ------------------------- | -------------------------------- |
 | `seoFields`     | Complete SEO package      | Main SEO fields for any document |
 | `openGraph`     | Open Graph meta tags      | Social media sharing             |
-| `twitter`       | Twitter Card settings     | Twitter-specific optimization    |
+| `twitter`       | X (Formerly Twitter) Card settings | X-specific optimization    |
 | `metaTag`       | Custom meta attributes    | Advanced meta tag management     |
 | `metaAttribute` | Individual meta attribute | Building custom meta tags        |
 | `robots`        | Search engine directives  | Control indexing and crawling    |
@@ -151,7 +152,7 @@ export default defineConfig({
 
 ### Advanced Configuration
 
-You can customize field titles and descriptions, and control SEO preview functionality:
+You can customize field titles and descriptions, control SEO preview functionality, and manage field visibility:
 
 ```typescript
 import seofields, {SeoFieldsPluginConfig} from 'sanity-plugin-seofields'
@@ -182,6 +183,17 @@ export default defineConfig({
           description: 'Keywords that describe the content of this page',
         },
       },
+      // Hide sitewide fields on specific content types
+      fieldVisibility: {
+        page: {
+          hiddenFields: ['openGraphSiteName', 'twitterSite']
+        },
+        post: {
+          hiddenFields: ['openGraphSiteName', 'twitterSite']
+        }
+      },
+      // Or hide fields globally
+      defaultHiddenFields: ['openGraphSiteName', 'twitterSite']
     } satisfies SeoFieldsPluginConfig),
   ],
 })
@@ -189,10 +201,12 @@ export default defineConfig({
 
 ### Configuration Options
 
-| Option           | Type      | Default | Description                                 |
-| ---------------- | --------- | ------- | ------------------------------------------- |
-| `seoPreview`     | `boolean` | `true`  | Enable/disable the live SEO preview feature |
-| `fieldOverrides` | `object`  | `{}`    | Customize field titles and descriptions     |
+| Option                | Type      | Default | Description                                 |
+| --------------------- | --------- | ------- | ------------------------------------------- |
+| `seoPreview`          | `boolean` | `true`  | Enable/disable the live SEO preview feature |
+| `fieldOverrides`      | `object`  | `{}`    | Customize field titles and descriptions     |
+| `fieldVisibility`     | `object`  | `{}`    | Hide sitewide fields on specific post types |
+| `defaultHiddenFields` | `array`   | `[]`    | Hide sitewide fields globally               |
 
 #### Field Configuration
 
@@ -210,6 +224,50 @@ Each field in the `fieldOverrides` object can have:
 - `keywords`
 - `metaAttributes`
 
+#### Field Visibility Configuration
+
+Control which fields are visible on different content types. You can hide any SEO field on any post type:
+
+**Available field keys:**
+- `title` - Meta Title field
+- `description` - Meta Description field
+- `canonicalUrl` - Canonical URL field
+- `metaImage` - Meta Image field
+- `keywords` - Keywords field
+- `metaAttributes` - Custom Meta Attributes field
+- `robots` - Robots Settings field
+- `openGraphSiteName` - Open Graph Site Name field (sitewide)
+- `twitterSite` - X (Formerly Twitter) Site Handle field (sitewide)
+
+**Example configurations:**
+
+```typescript
+// Hide fields globally
+seofields({
+  defaultHiddenFields: ['openGraphSiteName', 'twitterSite', 'keywords']
+})
+
+// Hide fields on specific content types
+seofields({
+  fieldVisibility: {
+    page: {
+      hiddenFields: ['openGraphSiteName', 'twitterSite', 'keywords']
+    },
+    post: {
+      hiddenFields: ['openGraphSiteName', 'metaAttributes']
+    },
+    product: {
+      hiddenFields: ['canonicalUrl', 'robots']
+    }
+  }
+})
+```
+
+This is particularly useful when you want to:
+- Manage sitewide settings (like site name and X handle) in a dedicated Site Settings document
+- Simplify the editing experience by hiding fields that aren't relevant for certain content types
+- Create different SEO workflows for different content types
+
 ### Field Specifications
 
 #### Meta Title
@@ -238,18 +296,18 @@ Each field in the `fieldOverrides` object can have:
 - **Best Practice**: Use the preferred URL for the page to avoid duplicate content issues
 - **Required**: Should match the actual page URL for consistency
 
-#### Twitter Card Image
+#### X (Formerly Twitter) Card Image
 
 - **Summary Card**: Minimum 120x120px
 - **Large Image**: Minimum 280x150px
 - **Required**: Alt text for accessibility
 
-#### Twitter Card Creator
+#### X (Formerly Twitter) Card Creator
 
-- **Purpose**: Attribution to content creator on Twitter
-- **Format**: Twitter handle with @ symbol (e.g., @creator)
+- **Purpose**: Attribution to content creator on X (formerly Twitter)
+- **Format**: X handle with @ symbol (e.g., @creator)
 - **Usage**: Identifies the individual author of the content
-- **Best Practice**: Use actual Twitter handles for proper attribution
+- **Best Practice**: Use actual X handles for proper attribution
 
 ## 💻 TypeScript Usage
 
@@ -316,6 +374,8 @@ import type {
   SeoFieldsPluginConfig,
   SeoFieldConfig,
   SeoFieldKeys,
+  SitewideFieldKeys,
+  FieldVisibilityConfig,
   OpenGraphSettings,
   TwitterCardSettings,
   MetaAttribute,
@@ -325,7 +385,53 @@ import type {
 } from 'sanity-plugin-seofields'
 ```
 
-## 🎯 Examples
+## 🎛️ Field Visibility Feature
+
+The field visibility feature allows you to hide any SEO field on specific content types. This is perfect for managing sitewide settings in a dedicated Site Settings document or creating customized editing experiences for different content types.
+
+### Quick Example
+
+```typescript
+// Hide specific fields on different content types
+seofields({
+  fieldVisibility: {
+    page: {
+      hiddenFields: ['openGraphSiteName', 'twitterSite', 'keywords']
+    },
+    post: {
+      hiddenFields: ['openGraphSiteName', 'metaAttributes']
+    },
+    product: {
+      hiddenFields: ['canonicalUrl', 'robots']
+    }
+  }
+})
+```
+
+### Site Settings Integration
+
+Create a Site Settings document to manage sitewide fields:
+
+```typescript
+// schemas/siteSettings.ts
+export default defineType({
+  name: 'siteSettings',
+  title: 'Site Settings',
+  type: 'document',
+  fields: [
+    defineField({
+      name: 'openGraphSiteName',
+      title: 'Open Graph Site Name',
+      type: 'string',
+    }),
+    defineField({
+      name: 'twitterSite',
+      title: 'X (Formerly Twitter) Site Handle',
+      type: 'string',
+    }),
+  ],
+})
+```
 
 ### Complete SEO Setup
 

package/dist/index.d.mts

@@ -2,7 +2,15 @@ import {ObjectDefinition} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PreviewConfig} from 'sanity'
 
+export declare type AllFieldKeys = SeoFieldKeys | openGraphFieldKeys | twitterFieldKeys
+
 export declare function allSchemas(config?: SeoFieldsPluginConfig): (
+  | ({
+      type: 'object'
+      name: 'twitter'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+      })
   | ({
       type: 'object'
       name: 'seoFields'
@@ -34,12 +42,6 @@ export declare function allSchemas(config?: SeoFieldsPluginConfig): (
     } & Omit<ObjectDefinition, 'preview'> & {
         preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
       })
-  | ({
-      type: 'object'
-      name: 'twitter'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
   | ({
       type: 'object'
       name: 'robots'
@@ -56,6 +58,11 @@ export declare function allSchemas(config?: SeoFieldsPluginConfig): (
 
 export declare const defaultSeoValidationRules: SeoValidationRules
 
+export declare interface FieldVisibilityConfig {
+  hiddenFields?: AllFieldKeys[]
+  postType?: string
+}
+
 export declare const isMetaAttribute: (obj: any) => obj is MetaAttribute
 
 export declare const isOpenGraphSettings: (obj: any) => obj is OpenGraphSettings
@@ -99,7 +106,17 @@ export declare const metaTagSchema: {
     preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
   }
 
-export declare const openGraphSchema: {
+export declare type openGraphFieldKeys =
+  | 'openGraphUrl'
+  | 'openGraphTitle'
+  | 'openGraphDescription'
+  | 'openGraphSiteName'
+  | 'openGraphType'
+  | 'openGraphImageType'
+  | 'openGraphImage'
+  | 'openGraphImageUrl'
+
+export declare function openGraphSchema(config?: SeoFieldsPluginConfig): {
   type: 'object'
   name: 'openGraph'
 } & Omit<ObjectDefinition, 'preview'> & {
@@ -113,7 +130,7 @@ export declare interface OpenGraphSettings {
   siteName?: string
   type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product'
   imageType?: 'upload' | 'url'
-  image?: SanityImage
+  image?: SanityImageWithAlt
   imageUrl?: string
 }
 
@@ -166,6 +183,7 @@ export declare type SeoFieldKeys =
   | 'metaImage'
   | 'keywords'
   | 'metaAttributes'
+  | 'robots'
 
 export declare interface SeoFields {
   _type: 'seoFields'
@@ -184,10 +202,52 @@ declare const seofields: Plugin_2<void | SeoFieldsPluginConfig>
 export default seofields
 
 export declare interface SeoFieldsPluginConfig {
-  seoPreview?: boolean
+  /**
+   * 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.
+   * Example:
+   * ```
+   * seoPreview: {
+   *   prefix: (doc) => `/${doc.slug?.current || 'untitled'}`
+   * }
+   * ```
+   */
+  seoPreview?:
+    | boolean
+    | {
+        prefix?: (
+          doc: {
+            _type?: string
+          } & Record<string, unknown>,
+        ) => string
+      }
+  /**
+   * A mapping of field keys to their configuration settings.
+   * This allows customization of field titles and descriptions.
+   * For example, to change the title of the 'title' field:
+   */
   fieldOverrides?: {
-    [key in SeoFieldKeys]?: SeoFieldConfig
+    [key in AllFieldKeys]?: SeoFieldConfig
+  }
+  /**
+   * A mapping of document types to field visibility configurations.
+   * This allows you to specify which fields should be hidden for specific document types.
+   */
+  fieldVisibility?: {
+    [postType: string]: FieldVisibilityConfig
   }
+  /**
+   * A list of fields that should be hidden by default in all document types.
+   * This can be overridden by specific document type settings in `fieldVisibility`.
+   */
+  defaultHiddenFields?: AllFieldKeys[]
+  /**
+   * The base URL of your website, used for generating full URLs in the SEO preview.
+   * Defaults to 'https://www.example.com' if not provided.
+   */
+  baseUrl?: string
 }
 
 export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): {
@@ -226,10 +286,22 @@ export declare interface TwitterCardSettings {
   site?: string
   title?: string
   description?: string
+  imageType?: 'upload' | 'url'
   image?: SanityImageWithAlt
+  imageUrl?: string
 }
 
-export declare const twitterSchema: {
+export declare type twitterFieldKeys =
+  | 'twitterCard'
+  | 'twitterSite'
+  | 'twitterCreator'
+  | 'twitterTitle'
+  | 'twitterDescription'
+  | 'twitterImageType'
+  | 'twitterImage'
+  | 'twitterImageUrl'
+
+export declare function twitterSchema(config?: SeoFieldsPluginConfig): {
   type: 'object'
   name: 'twitter'
 } & Omit<ObjectDefinition, 'preview'> & {

package/dist/index.d.ts

@@ -2,7 +2,15 @@ import {ObjectDefinition} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PreviewConfig} from 'sanity'
 
+export declare type AllFieldKeys = SeoFieldKeys | openGraphFieldKeys | twitterFieldKeys
+
 export declare function allSchemas(config?: SeoFieldsPluginConfig): (
+  | ({
+      type: 'object'
+      name: 'twitter'
+    } & Omit<ObjectDefinition, 'preview'> & {
+        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+      })
   | ({
       type: 'object'
       name: 'seoFields'
@@ -34,12 +42,6 @@ export declare function allSchemas(config?: SeoFieldsPluginConfig): (
     } & Omit<ObjectDefinition, 'preview'> & {
         preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
       })
-  | ({
-      type: 'object'
-      name: 'twitter'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
   | ({
       type: 'object'
       name: 'robots'
@@ -56,6 +58,11 @@ export declare function allSchemas(config?: SeoFieldsPluginConfig): (
 
 export declare const defaultSeoValidationRules: SeoValidationRules
 
+export declare interface FieldVisibilityConfig {
+  hiddenFields?: AllFieldKeys[]
+  postType?: string
+}
+
 export declare const isMetaAttribute: (obj: any) => obj is MetaAttribute
 
 export declare const isOpenGraphSettings: (obj: any) => obj is OpenGraphSettings
@@ -99,7 +106,17 @@ export declare const metaTagSchema: {
     preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
   }
 
-export declare const openGraphSchema: {
+export declare type openGraphFieldKeys =
+  | 'openGraphUrl'
+  | 'openGraphTitle'
+  | 'openGraphDescription'
+  | 'openGraphSiteName'
+  | 'openGraphType'
+  | 'openGraphImageType'
+  | 'openGraphImage'
+  | 'openGraphImageUrl'
+
+export declare function openGraphSchema(config?: SeoFieldsPluginConfig): {
   type: 'object'
   name: 'openGraph'
 } & Omit<ObjectDefinition, 'preview'> & {
@@ -113,7 +130,7 @@ export declare interface OpenGraphSettings {
   siteName?: string
   type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product'
   imageType?: 'upload' | 'url'
-  image?: SanityImage
+  image?: SanityImageWithAlt
   imageUrl?: string
 }
 
@@ -166,6 +183,7 @@ export declare type SeoFieldKeys =
   | 'metaImage'
   | 'keywords'
   | 'metaAttributes'
+  | 'robots'
 
 export declare interface SeoFields {
   _type: 'seoFields'
@@ -184,10 +202,52 @@ declare const seofields: Plugin_2<void | SeoFieldsPluginConfig>
 export default seofields
 
 export declare interface SeoFieldsPluginConfig {
-  seoPreview?: boolean
+  /**
+   * 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.
+   * Example:
+   * ```
+   * seoPreview: {
+   *   prefix: (doc) => `/${doc.slug?.current || 'untitled'}`
+   * }
+   * ```
+   */
+  seoPreview?:
+    | boolean
+    | {
+        prefix?: (
+          doc: {
+            _type?: string
+          } & Record<string, unknown>,
+        ) => string
+      }
+  /**
+   * A mapping of field keys to their configuration settings.
+   * This allows customization of field titles and descriptions.
+   * For example, to change the title of the 'title' field:
+   */
   fieldOverrides?: {
-    [key in SeoFieldKeys]?: SeoFieldConfig
+    [key in AllFieldKeys]?: SeoFieldConfig
+  }
+  /**
+   * A mapping of document types to field visibility configurations.
+   * This allows you to specify which fields should be hidden for specific document types.
+   */
+  fieldVisibility?: {
+    [postType: string]: FieldVisibilityConfig
   }
+  /**
+   * A list of fields that should be hidden by default in all document types.
+   * This can be overridden by specific document type settings in `fieldVisibility`.
+   */
+  defaultHiddenFields?: AllFieldKeys[]
+  /**
+   * The base URL of your website, used for generating full URLs in the SEO preview.
+   * Defaults to 'https://www.example.com' if not provided.
+   */
+  baseUrl?: string
 }
 
 export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): {
@@ -226,10 +286,22 @@ export declare interface TwitterCardSettings {
   site?: string
   title?: string
   description?: string
+  imageType?: 'upload' | 'url'
   image?: SanityImageWithAlt
+  imageUrl?: string
 }
 
-export declare const twitterSchema: {
+export declare type twitterFieldKeys =
+  | 'twitterCard'
+  | 'twitterSite'
+  | 'twitterCreator'
+  | 'twitterTitle'
+  | 'twitterDescription'
+  | 'twitterImageType'
+  | 'twitterImage'
+  | 'twitterImageUrl'
+
+export declare function twitterSchema(config?: SeoFieldsPluginConfig): {
   type: 'object'
   name: 'twitter'
 } & Omit<ObjectDefinition, 'preview'> & {