sanity-plugin-seofields 1.0.8 → 1.0.9

package/README.md

@@ -589,21 +589,6 @@ import seofields from 'sanity-plugin-seofields'
 
 All types are exported from the main module for use in your project.
 
-### Migration Utilities
-
-The plugin includes utilities for migrating existing data from old formats:
-
-```typescript
-import { 
-  migrateSeoFields, 
-  generateMigrationScript, 
-  needsMigration,
-  normalizeValue 
-} from 'sanity-plugin-seofields'
-```
-
-For detailed migration instructions, see [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md).
-
 ## 🤝 Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.

package/dist/index.d.mts

@@ -1,82 +1,14 @@
 import {ObjectDefinition} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PreviewConfig} from 'sanity'
+import {SchemaTypeDefinition} 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'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'metaAttribute'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?:
-          | PreviewConfig<
-              {
-                attributeName: string
-                attributeValueString: string
-                attributeValueImage: string
-              },
-              {
-                attributeName: string
-                attributeValueString: string
-                attributeValueImage: any
-              }
-            >
-          | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'openGraph'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'robots'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'metaTag'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-)[]
-
-export declare const defaultSeoValidationRules: SeoValidationRules
+export declare function allSchemas(config?: SeoFieldsPluginConfig): SchemaTypeDefinition[]
 
 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
-
-export declare const isSeoFields: (obj: any) => obj is SeoFields
-
-export declare const isTwitterCardSettings: (obj: any) => obj is TwitterCardSettings
-
-export declare interface MetaAttribute {
-  _type: 'metaAttribute'
-  key: string
-  type: 'string' | 'image'
-  value?: string
-  image?: SanityImage
+  hiddenFields?: ValidHiddenFieldKeys[]
 }
 
 export declare const metaAttributeSchema: {
@@ -90,11 +22,7 @@ export declare const metaAttributeSchema: {
             attributeValueString: string
             attributeValueImage: string
           },
-          {
-            attributeName: string
-            attributeValueString: string
-            attributeValueImage: any
-          }
+          Record<'attributeName' | 'attributeValueString' | 'attributeValueImage', any>
         >
       | undefined
   }
@@ -116,23 +44,7 @@ export declare type openGraphFieldKeys =
   | 'openGraphImage'
   | 'openGraphImageUrl'
 
-export declare function openGraphSchema(config?: SeoFieldsPluginConfig): {
-  type: 'object'
-  name: 'openGraph'
-} & Omit<ObjectDefinition, 'preview'> & {
-    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-  }
-
-export declare interface OpenGraphSettings {
-  _type: 'openGraph'
-  title?: string
-  description?: string
-  siteName?: string
-  type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product'
-  imageType?: 'upload' | 'url'
-  image?: SanityImageWithAlt
-  imageUrl?: string
-}
+export declare function openGraphSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition
 
 export declare const robotsSchema: {
   type: 'object'
@@ -141,36 +53,6 @@ export declare const robotsSchema: {
     preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
   }
 
-export declare interface RobotsSettings {
-  noIndex?: boolean
-  noFollow?: boolean
-}
-
-export declare 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
-}
-
-export declare interface SanityImageWithAlt extends SanityImage {
-  alt: string
-}
-
 export declare interface SeoFieldConfig {
   title?: string
   description?: string
@@ -185,19 +67,6 @@ export declare type SeoFieldKeys =
   | 'metaAttributes'
   | 'robots'
 
-export declare interface SeoFields {
-  _type: 'seoFields'
-  robots?: RobotsSettings
-  preview?: string
-  title?: string
-  description?: string
-  metaImage?: SanityImage
-  keywords?: string[]
-  canonicalUrl?: string
-  openGraph?: OpenGraphSettings
-  twitter?: TwitterCardSettings
-}
-
 declare const seofields: Plugin_2<void | SeoFieldsPluginConfig>
 export default seofields
 
@@ -228,21 +97,17 @@ export declare interface SeoFieldsPluginConfig {
    * This allows customization of field titles and descriptions.
    * For example, to change the title of the 'title' field:
    */
-  fieldOverrides?: {
-    [key in AllFieldKeys]?: SeoFieldConfig
-  }
+  fieldOverrides?: Partial<Record<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
-  }
+  fieldVisibility?: Record<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[]
+  defaultHiddenFields?: ValidHiddenFieldKeys[]
   /**
    * The base URL of your website, used for generating full URLs in the SEO preview.
    * Defaults to 'https://www.example.com' if not provided.
@@ -250,46 +115,7 @@ export declare interface SeoFieldsPluginConfig {
   baseUrl?: string
 }
 
-export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): {
-  type: 'object'
-  name: 'seoFields'
-} & Omit<ObjectDefinition, 'preview'> & {
-    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-  }
-
-export declare interface SeoValidationRules {
-  title: {
-    maxLength: number
-    warningLength: number
-  }
-  description: {
-    maxLength: number
-    warningLength: number
-  }
-  openGraphTitle: {
-    maxLength: number
-  }
-  openGraphDescription: {
-    maxLength: number
-  }
-  twitterTitle: {
-    maxLength: number
-  }
-  twitterDescription: {
-    maxLength: number
-  }
-}
-
-export declare interface TwitterCardSettings {
-  _type: 'twitter'
-  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
-  site?: string
-  title?: string
-  description?: string
-  imageType?: 'upload' | 'url'
-  image?: SanityImageWithAlt
-  imageUrl?: string
-}
+export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition
 
 export declare type twitterFieldKeys =
   | 'twitterCard'
@@ -301,11 +127,11 @@ export declare type twitterFieldKeys =
   | 'twitterImage'
   | 'twitterImageUrl'
 
-export declare function twitterSchema(config?: SeoFieldsPluginConfig): {
-  type: 'object'
-  name: 'twitter'
-} & Omit<ObjectDefinition, 'preview'> & {
-    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-  }
+export declare function twitterSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition
+
+export declare type ValidHiddenFieldKeys = Exclude<
+  AllFieldKeys,
+  'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'
+>
 
 export {}

package/dist/index.d.ts

@@ -1,82 +1,14 @@
 import {ObjectDefinition} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PreviewConfig} from 'sanity'
+import {SchemaTypeDefinition} 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'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'metaAttribute'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?:
-          | PreviewConfig<
-              {
-                attributeName: string
-                attributeValueString: string
-                attributeValueImage: string
-              },
-              {
-                attributeName: string
-                attributeValueString: string
-                attributeValueImage: any
-              }
-            >
-          | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'openGraph'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'robots'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-  | ({
-      type: 'object'
-      name: 'metaTag'
-    } & Omit<ObjectDefinition, 'preview'> & {
-        preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-      })
-)[]
-
-export declare const defaultSeoValidationRules: SeoValidationRules
+export declare function allSchemas(config?: SeoFieldsPluginConfig): SchemaTypeDefinition[]
 
 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
-
-export declare const isSeoFields: (obj: any) => obj is SeoFields
-
-export declare const isTwitterCardSettings: (obj: any) => obj is TwitterCardSettings
-
-export declare interface MetaAttribute {
-  _type: 'metaAttribute'
-  key: string
-  type: 'string' | 'image'
-  value?: string
-  image?: SanityImage
+  hiddenFields?: ValidHiddenFieldKeys[]
 }
 
 export declare const metaAttributeSchema: {
@@ -90,11 +22,7 @@ export declare const metaAttributeSchema: {
             attributeValueString: string
             attributeValueImage: string
           },
-          {
-            attributeName: string
-            attributeValueString: string
-            attributeValueImage: any
-          }
+          Record<'attributeName' | 'attributeValueString' | 'attributeValueImage', any>
         >
       | undefined
   }
@@ -116,23 +44,7 @@ export declare type openGraphFieldKeys =
   | 'openGraphImage'
   | 'openGraphImageUrl'
 
-export declare function openGraphSchema(config?: SeoFieldsPluginConfig): {
-  type: 'object'
-  name: 'openGraph'
-} & Omit<ObjectDefinition, 'preview'> & {
-    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-  }
-
-export declare interface OpenGraphSettings {
-  _type: 'openGraph'
-  title?: string
-  description?: string
-  siteName?: string
-  type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product'
-  imageType?: 'upload' | 'url'
-  image?: SanityImageWithAlt
-  imageUrl?: string
-}
+export declare function openGraphSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition
 
 export declare const robotsSchema: {
   type: 'object'
@@ -141,36 +53,6 @@ export declare const robotsSchema: {
     preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
   }
 
-export declare interface RobotsSettings {
-  noIndex?: boolean
-  noFollow?: boolean
-}
-
-export declare 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
-}
-
-export declare interface SanityImageWithAlt extends SanityImage {
-  alt: string
-}
-
 export declare interface SeoFieldConfig {
   title?: string
   description?: string
@@ -185,19 +67,6 @@ export declare type SeoFieldKeys =
   | 'metaAttributes'
   | 'robots'
 
-export declare interface SeoFields {
-  _type: 'seoFields'
-  robots?: RobotsSettings
-  preview?: string
-  title?: string
-  description?: string
-  metaImage?: SanityImage
-  keywords?: string[]
-  canonicalUrl?: string
-  openGraph?: OpenGraphSettings
-  twitter?: TwitterCardSettings
-}
-
 declare const seofields: Plugin_2<void | SeoFieldsPluginConfig>
 export default seofields
 
@@ -228,21 +97,17 @@ export declare interface SeoFieldsPluginConfig {
    * This allows customization of field titles and descriptions.
    * For example, to change the title of the 'title' field:
    */
-  fieldOverrides?: {
-    [key in AllFieldKeys]?: SeoFieldConfig
-  }
+  fieldOverrides?: Partial<Record<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
-  }
+  fieldVisibility?: Record<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[]
+  defaultHiddenFields?: ValidHiddenFieldKeys[]
   /**
    * The base URL of your website, used for generating full URLs in the SEO preview.
    * Defaults to 'https://www.example.com' if not provided.
@@ -250,46 +115,7 @@ export declare interface SeoFieldsPluginConfig {
   baseUrl?: string
 }
 
-export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): {
-  type: 'object'
-  name: 'seoFields'
-} & Omit<ObjectDefinition, 'preview'> & {
-    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-  }
-
-export declare interface SeoValidationRules {
-  title: {
-    maxLength: number
-    warningLength: number
-  }
-  description: {
-    maxLength: number
-    warningLength: number
-  }
-  openGraphTitle: {
-    maxLength: number
-  }
-  openGraphDescription: {
-    maxLength: number
-  }
-  twitterTitle: {
-    maxLength: number
-  }
-  twitterDescription: {
-    maxLength: number
-  }
-}
-
-export declare interface TwitterCardSettings {
-  _type: 'twitter'
-  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
-  site?: string
-  title?: string
-  description?: string
-  imageType?: 'upload' | 'url'
-  image?: SanityImageWithAlt
-  imageUrl?: string
-}
+export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition
 
 export declare type twitterFieldKeys =
   | 'twitterCard'
@@ -301,11 +127,11 @@ export declare type twitterFieldKeys =
   | 'twitterImage'
   | 'twitterImageUrl'
 
-export declare function twitterSchema(config?: SeoFieldsPluginConfig): {
-  type: 'object'
-  name: 'twitter'
-} & Omit<ObjectDefinition, 'preview'> & {
-    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
-  }
+export declare function twitterSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition
+
+export declare type ValidHiddenFieldKeys = Exclude<
+  AllFieldKeys,
+  'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'
+>
 
 export {}