sanity-plugin-seofields 1.2.4 → 1.2.6

package/src/schemas/index.ts

@@ -1,121 +0,0 @@
-import {defineField, defineType, SchemaTypeDefinition} from 'sanity'
-
-import MetaDescription from '../components/meta/MetaDescription'
-import MetaTitle from '../components/meta/MetaTitle'
-import SeoPreview from '../components/SeoPreview'
-import {SeoFieldsPluginConfig} from '../plugin'
-import {getFieldHiddenFunction, getFieldInfo} from '../utils/fieldsUtils'
-import {isEmpty} from '../utils/utils'
-import openGraph from './types/openGraph'
-import twitter from './types/twitter'
-
-export default function seoFieldsSchema(config: SeoFieldsPluginConfig = {}): SchemaTypeDefinition {
-  return defineType({
-    name: 'seoFields',
-    title: 'SEO Fields',
-    type: 'object',
-    fields: [
-      defineField({
-        name: 'robots',
-        title: 'Robots Settings',
-        type: 'robots', // Use the separate robots type here
-        hidden: getFieldHiddenFunction('robots', config),
-      }),
-      // 👇 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: SeoPreview},
-              options: {
-                baseUrl: config.baseUrl || 'https://www.example.com',
-                ...(typeof config.seoPreview === 'object' &&
-                config.seoPreview &&
-                config.seoPreview.prefix
-                  ? {prefix: config.seoPreview.prefix}
-                  : {}),
-              } as Record<string, unknown>,
-              // Use a readOnly field to prevent editing
-              // This field is just for preview purposes
-              initialValue: '' as string, // Set an initial value
-              readOnly: true,
-            }),
-          ]
-        : []),
-
-      defineField({
-        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,
-        },
-        // validation: (Rule) => Rule.max(60).warning('Meta title should be under 60 characters.'),
-        hidden: getFieldHiddenFunction('title', config),
-      }),
-      defineField({
-        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,
-        },
-        // validation: (Rule) => Rule.max(160).warning('Meta description should be under 160 characters.'),
-        hidden: getFieldHiddenFunction('description', config),
-      }),
-      defineField({
-        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,
-        },
-        hidden: getFieldHiddenFunction('metaImage', config),
-      }),
-      defineField({
-        name: 'metaAttributes',
-        // title: 'Additional Meta Attributes',
-        ...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({
-        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),
-      }),
-      defineField({
-        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),
-      }),
-      openGraph(config) as any,
-      twitter(config) as any,
-    ],
-  })
-}

package/src/schemas/types/index.ts

@@ -1,20 +0,0 @@
-import {SchemaTypeDefinition} from 'sanity'
-
-import {SeoFieldsPluginConfig} from '../../plugin'
-import seoFields from '..'
-import metaAttribute from './metaAttribute'
-import metaTag from './metaTag'
-import openGraph from './openGraph'
-import robots from './robots'
-import twitter from './twitter'
-
-export default function types(config: SeoFieldsPluginConfig = {}): SchemaTypeDefinition[] {
-  return [
-    seoFields(config), // pass config here
-    openGraph(config), // pass config here
-    twitter(config), // pass config here
-    metaAttribute as SchemaTypeDefinition,
-    metaTag,
-    robots,
-  ]
-}

package/src/schemas/types/metaAttribute/index.ts

@@ -1,60 +0,0 @@
-import {defineField, defineType} from 'sanity'
-
-export default defineType({
-  name: 'metaAttribute',
-  title: 'Meta Attribute',
-  type: 'object',
-  fields: [
-    defineField({
-      name: 'key',
-      title: 'Attribute Name',
-      type: 'string',
-    }),
-    defineField({
-      name: 'type',
-      title: 'Attribute Value Type',
-      type: 'string',
-      options: {
-        list: [
-          {title: 'String', value: 'string'},
-          {title: 'Image', value: 'image'},
-        ],
-      },
-      initialValue: 'string',
-    }),
-    defineField({
-      name: 'value',
-      title: 'Attribute Value',
-      type: 'string',
-      hidden: ({parent}) => parent?.type === 'image',
-    }),
-    defineField({
-      name: 'image',
-      title: 'Attribute Image Value',
-      type: 'image',
-      hidden: ({parent}) => parent?.type === 'string',
-    }),
-  ],
-  preview: {
-    select: {
-      attributeName: 'key',
-      attributeValueString: 'value',
-      attributeValueImage: 'image',
-    },
-    prepare({attributeName, attributeValueString, attributeValueImage}) {
-      let subtitle = ''
-      if (attributeValueString) {
-        subtitle = `Value: ${attributeValueString}`
-      } else if (attributeValueImage) {
-        subtitle = 'Value: [Image]'
-      } else {
-        subtitle = 'No Attribute Value'
-      }
-      return {
-        title: attributeName || 'No Attribute Name',
-        subtitle: subtitle,
-        media: attributeValueImage,
-      }
-    },
-  },
-})

package/src/schemas/types/metaTag/index.ts

@@ -1,17 +0,0 @@
-import {defineType} from 'sanity'
-
-export default defineType({
-  name: 'metaTag',
-  title: 'Meta Tag',
-  type: 'object',
-  fields: [
-    {
-      name: 'metaAttributes',
-      title: 'Meta Attributes',
-      type: 'array',
-      of: [{type: 'metaAttribute'}],
-      description:
-        'Add custom meta attributes to the head of the document for additional SEO and social media integration.',
-    },
-  ],
-})

package/src/schemas/types/openGraph/index.ts

@@ -1,114 +0,0 @@
-import {defineField, defineType, SchemaTypeDefinition} from 'sanity'
-
-import OgDescription from '../../../components/openGraph/OgDescription'
-import OgTitle from '../../../components/openGraph/OgTitle'
-import {SeoFieldsPluginConfig} from '../../../plugin'
-import {getFieldHiddenFunction, getFieldInfo} from '../../../utils/fieldsUtils'
-
-export default function openGraph(config: SeoFieldsPluginConfig = {}): SchemaTypeDefinition {
-  return defineType({
-    name: 'openGraph',
-    title: 'Open Graph Settings',
-    type: 'object',
-    fields: [
-      defineField({
-        name: 'url',
-        type: 'url',
-        ...getFieldInfo('openGraphUrl', config.fieldOverrides),
-        hidden: getFieldHiddenFunction('openGraphUrl', config),
-        description:
-          'The canonical URL of the page. This should be the full URL including protocol (https://).',
-      }),
-      defineField({
-        name: 'title',
-        ...getFieldInfo('openGraphTitle', config.fieldOverrides),
-        type: 'string',
-        hidden: getFieldHiddenFunction('openGraphTitle', config),
-        components: {
-          input: OgTitle, // Can also wrap with a string input + preview
-        },
-      }),
-      defineField({
-        name: 'description',
-        ...getFieldInfo('openGraphDescription', config.fieldOverrides),
-        type: 'text',
-        rows: 3,
-        hidden: getFieldHiddenFunction('openGraphDescription', config),
-        components: {
-          input: OgDescription, // Can also wrap with a text area + preview
-        },
-      }),
-      defineField({
-        name: 'siteName',
-        ...getFieldInfo('openGraphSiteName', config.fieldOverrides),
-        type: 'string',
-        hidden: getFieldHiddenFunction('openGraphSiteName', config),
-      }),
-      defineField({
-        name: 'type',
-        ...getFieldInfo('openGraphType', config.fieldOverrides),
-        type: 'string',
-        options: {
-          list: [
-            {title: 'Website', value: 'website'},
-            {title: 'Article', value: 'article'},
-            {title: 'Profile', value: 'profile'},
-            {title: 'Book', value: 'book'},
-            {title: 'Music', value: 'music'},
-            {title: 'Video', value: 'video'},
-            {title: 'Product', value: 'product'},
-          ],
-          // layout: 'radio', // Display as radio buttons
-        },
-        hidden: getFieldHiddenFunction('openGraphType', config),
-        initialValue: 'website',
-      }),
-      defineField({
-        name: 'imageType',
-        ...getFieldInfo('openGraphImageType', config.fieldOverrides),
-        type: 'string',
-        options: {
-          list: [
-            {title: 'Upload Image', value: 'upload'},
-            {title: 'Image URL', value: 'url'},
-          ],
-        },
-        hidden: getFieldHiddenFunction('openGraphImage', config),
-        initialValue: 'upload',
-      }),
-      defineField({
-        name: 'image',
-        ...getFieldInfo('openGraphImage', config.fieldOverrides),
-        type: 'image',
-        options: {
-          hotspot: true,
-        },
-        fields: [
-          defineField({
-            name: 'alt',
-            title: 'Image Alt Text',
-            type: 'string',
-            description: 'A description of the image for accessibility purposes.',
-          }),
-        ],
-        hidden: (context) => {
-          const {parent} = context
-          if (parent?.imageType !== 'upload') return true
-          const hiddenFn = getFieldHiddenFunction('openGraphImage', config)
-          return typeof hiddenFn === 'function' ? hiddenFn(context) : hiddenFn
-        },
-      }),
-      defineField({
-        name: 'imageUrl',
-        ...getFieldInfo('openGraphImageUrl', config.fieldOverrides),
-        type: 'url',
-        hidden: (context) => {
-          const {parent} = context
-          if (parent?.imageType !== 'url') return true
-          const hiddenFn = getFieldHiddenFunction('openGraphImage', config)
-          return typeof hiddenFn === 'function' ? hiddenFn(context) : hiddenFn
-        },
-      }),
-    ],
-  })
-}

package/src/schemas/types/robots/index.ts

@@ -1,26 +0,0 @@
-import {defineField, defineType} from 'sanity'
-
-export default defineType({
-  name: 'robots',
-  title: 'Robots Settings',
-  type: 'object',
-  fields: [
-    defineField({
-      name: 'noIndex',
-      title: 'No Index',
-      type: 'boolean',
-      initialValue: false,
-      description:
-        'Enable this to prevent search engines from indexing this page. The page will not appear in search results.',
-    }),
-    defineField({
-      name: 'noFollow',
-      title: 'No Follow',
-      type: 'boolean',
-      initialValue: false,
-      description:
-        'Enable this to prevent search engines from following links on this page. Links will not pass SEO value.',
-    }),
-  ],
-  description: 'Select how search engines should index and follow links on this page.',
-})

package/src/schemas/types/twitter/index.ts

@@ -1,108 +0,0 @@
-import {defineField, defineType, SchemaTypeDefinition} from 'sanity'
-
-import TwitterDescription from '../../../components/twitter/twitterDescription'
-import TwitterTitle from '../../../components/twitter/twitterTitle'
-import {SeoFieldsPluginConfig} from '../../../plugin'
-import {getFieldHiddenFunction, getFieldInfo} from '../../../utils/fieldsUtils'
-
-export default function twitter(config: SeoFieldsPluginConfig = {}): SchemaTypeDefinition {
-  return defineType({
-    name: 'twitter',
-    title: 'X (Formerly Twitter)',
-    type: 'object',
-    fields: [
-      defineField({
-        name: 'card',
-        ...getFieldInfo('twitterCard', config.fieldOverrides),
-        type: 'string',
-        options: {
-          list: [
-            {title: 'Summary', value: 'summary'},
-            {title: 'Summary with Large Image', value: 'summary_large_image'},
-            {title: 'App', value: 'app'},
-            {title: 'Player', value: 'player'},
-          ],
-        },
-        hidden: getFieldHiddenFunction('twitterCard', config),
-        initialValue: 'summary_large_image', // good default
-      }),
-      defineField({
-        name: 'site',
-        ...getFieldInfo('twitterSite', config.fieldOverrides),
-        type: 'string',
-        hidden: getFieldHiddenFunction('twitterSite', config),
-      }),
-      defineField({
-        name: 'creator',
-        type: 'string',
-        ...getFieldInfo('twitterCreator', config.fieldOverrides),
-        hidden: getFieldHiddenFunction('twitterCreator', config),
-      }),
-      defineField({
-        name: 'title',
-        type: 'string',
-        ...getFieldInfo('twitterTitle', config.fieldOverrides),
-        hidden: getFieldHiddenFunction('twitterTitle', config),
-        components: {
-          input: TwitterTitle,
-        },
-      }),
-      defineField({
-        name: 'description',
-        type: 'text',
-        rows: 3,
-        ...getFieldInfo('twitterDescription', config.fieldOverrides),
-        hidden: getFieldHiddenFunction('twitterDescription', config),
-        components: {
-          input: TwitterDescription,
-        },
-      }),
-      defineField({
-        name: 'imageType',
-        ...getFieldInfo('twitterImageType', config.fieldOverrides),
-        type: 'string',
-        options: {
-          list: [
-            {title: 'Upload Image', value: 'upload'},
-            {title: 'Image URL', value: 'url'},
-          ],
-        },
-        hidden: getFieldHiddenFunction('twitterImage', config),
-        initialValue: 'upload',
-      }),
-      defineField({
-        name: 'image',
-        ...getFieldInfo('twitterImage', config.fieldOverrides),
-        type: 'image',
-        options: {
-          hotspot: true,
-        },
-        fields: [
-          defineField({
-            name: 'alt',
-            title: 'Image Alt Text',
-            type: 'string',
-            description: 'A description of the image for accessibility purposes.',
-          }),
-        ],
-        hidden: (context) => {
-          const {parent} = context
-          if (parent?.imageType !== 'upload') return true
-          const hiddenFn = getFieldHiddenFunction('twitterImage', config)
-          return typeof hiddenFn === 'function' ? hiddenFn(context) : hiddenFn
-        },
-      }),
-      defineField({
-        name: 'imageUrl',
-        ...getFieldInfo('twitterImageUrl', config.fieldOverrides),
-        type: 'url',
-        hidden: (context) => {
-          const {parent} = context
-          if (parent?.imageType !== 'url') return true
-          const hiddenFn = getFieldHiddenFunction('twitterImage', config)
-          return typeof hiddenFn === 'function' ? hiddenFn(context) : hiddenFn
-        },
-      }),
-    ],
-  })
-}

package/src/types.ts

@@ -1,108 +0,0 @@
-// TypeScript interfaces for SEO Fields Plugin
-
-// Base Sanity types
-export 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 interface SanityImageWithAlt extends SanityImage {
-  alt: string
-}
-
-// Robots settings
-export interface RobotsSettings {
-  noIndex?: boolean
-  noFollow?: boolean
-}
-
-// Meta Attribute
-export interface MetaAttribute {
-  _type: 'metaAttribute'
-  key?: string
-  type?: 'string' | 'image'
-  value?: string
-  image?: SanityImage
-}
-
-// Open Graph settings
-export interface OpenGraphSettings {
-  _type: 'openGraph'
-  /** The canonical URL for OpenGraph (og:url). Maps to the `url` field in Sanity. */
-  url?: string
-  title?: string
-  description?: string
-  siteName?: string
-  type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product'
-  imageType?: 'upload' | 'url'
-  image?: SanityImageWithAlt
-  imageUrl?: string
-}
-
-// X (Formerly Twitter) Card settings
-export 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
-}
-
-// Main SEO Fields interface
-export interface SeoFields {
-  _type: 'seoFields'
-  robots?: RobotsSettings
-  preview?: string
-  title?: string
-  description?: string
-  metaImage?: SanityImage
-  metaAttributes?: MetaAttribute[]
-  keywords?: string[]
-  canonicalUrl?: string
-  openGraph?: OpenGraphSettings
-  twitter?: TwitterCardSettings
-}
-export type FeedbackTypeColors = 'green' | 'orange' | 'red'
-export type FeedbackType = {
-  text: string
-  color: FeedbackTypeColors
-}
-
-// SEO Health Dashboard Types
-export type SeoHealthStatus = 'excellent' | 'good' | 'fair' | 'poor' | 'missing'
-
-export interface SeoHealthMetrics {
-  score: number
-  status: SeoHealthStatus
-  issues: string[]
-}
-
-export interface DocumentWithSeoHealth {
-  _id: string
-  _type: string
-  title?: string
-  slug?: {current: string}
-  seo?: SeoFields
-  _updatedAt?: string
-  health: SeoHealthMetrics
-}