sanity-plugin-seofields 1.2.4 → 1.2.6

package/src/utils/fieldsUtils.ts

@@ -1,160 +0,0 @@
-import {AllFieldKeys, SeoFieldsPluginConfig, ValidHiddenFieldKeys} from '../plugin'
-
-const DEFAULT_FIELD_INFO: Record<AllFieldKeys, {title: string; description: string}> = {
-  title: {
-    title: 'Meta Title',
-    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.',
-  },
-  description: {
-    title: 'Meta Description',
-    description:
-      'Provide a concise summary of the page content. This description may be used by search engines in search results.',
-  },
-  metaImage: {
-    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.',
-  },
-  keywords: {
-    title: 'Keywords',
-    description:
-      'Add relevant keywords for this page. These keywords will be used for SEO purposes.',
-  },
-  canonicalUrl: {
-    title: 'Canonical URL',
-    description:
-      'Specify the canonical URL for this page. This helps prevent duplicate content issues by indicating the preferred version of a page.',
-  },
-  robots: {
-    title: 'Robots Settings',
-    description: 'Configure how search engine crawlers should index and follow links on this page.',
-  },
-  metaAttributes: {
-    title: 'Additional Meta Attributes',
-    description:
-      'Add custom meta attributes to the head of the document for additional SEO and social media integration.',
-  },
-  openGraphTitle: {
-    title: 'Open Graph Title',
-    description: '',
-  },
-  openGraphUrl: {
-    title: 'Open Graph URL',
-    description:
-      'The canonical URL of the page. This should be the full URL including protocol (https://).',
-  },
-  openGraphDescription: {
-    title: 'Open Graph Description',
-    description: '',
-  },
-  openGraphSiteName: {
-    title: 'Open Graph Site Name',
-    description: 'The name of your website. This is often the site title.',
-  },
-  openGraphType: {
-    title: 'Open Graph Type',
-    description: 'Select the type of content for Open Graph.',
-  },
-  openGraphImageType: {
-    title: 'Image Type',
-    description: 'Choose whether to upload an image or provide an image URL for Open Graph.',
-  },
-  openGraphImage: {
-    title: 'Open Graph Image',
-    description:
-      'Recommended size: 1200x630px (minimum 600x315px). Max file size: 5MB. Aspect ratio 1.91:1.',
-  },
-  openGraphImageUrl: {
-    title: 'Open Graph Image URL',
-    description:
-      'Enter the full URL of the image. Ensure the image is accessible and meets the recommended size of 1200x630px (minimum 600x315px).',
-  },
-  twitterCard: {
-    title: 'X Card Type',
-    description: '',
-  },
-  twitterSite: {
-    title: 'Site X Handle',
-    description: 'The X (formerly Twitter) handle of the website (e.g., @example)',
-  },
-  twitterCreator: {
-    title: 'X Creator Handle',
-    description: 'The X (formerly Twitter) handle of the content creator (e.g., @creator)',
-  },
-  twitterTitle: {
-    title: 'X Title',
-    description: 'The title of the content as it should appear on X (formerly Twitter).',
-  },
-  twitterDescription: {
-    title: 'X Description',
-    description: 'A brief description of the content for X (formerly Twitter).',
-  },
-  twitterImageType: {
-    title: 'X Image Type',
-    description:
-      'Choose whether to upload an image or provide an image URL for X (formerly Twitter).',
-  },
-  twitterImage: {
-    title: 'X Image',
-    description:
-      'An image URL which should be at least 120x120px for "summary" card and 280x150px for "summary_large_image" card.',
-  },
-  twitterImageUrl: {
-    title: 'X Image URL',
-    description:
-      'Enter the full URL of the image for X (formerly Twitter). Ensure the image is accessible and meets the recommended size.',
-  },
-}
-
-export const getFieldInfo = (
-  fieldName: string,
-  fieldOverrides: SeoFieldsPluginConfig['fieldOverrides'],
-): {title: string; description: string} => {
-  const fieldInfo =
-    (fieldOverrides && fieldOverrides[fieldName as keyof typeof fieldOverrides]) ||
-    DEFAULT_FIELD_INFO[fieldName as keyof typeof DEFAULT_FIELD_INFO]
-  return fieldInfo
-    ? {title: fieldInfo.title || '', description: fieldInfo.description || ''}
-    : {title: '', description: ''}
-}
-
-/**
- * Check if a field should be hidden based on the current document type
- */
-export const isFieldHidden = (
-  fieldName: ValidHiddenFieldKeys,
-  config: SeoFieldsPluginConfig,
-  documentType?: string,
-): boolean => {
-  // Check if field is in default hidden fields
-  if (config.defaultHiddenFields?.includes(fieldName)) {
-    return true
-  }
-
-  // Check if field is hidden for specific post type
-  if (documentType && config.fieldVisibility?.[documentType]?.hiddenFields?.includes(fieldName)) {
-    return true
-  }
-
-  return false
-}
-
-/**
- * Get the hidden function for any field
- */
-export const getFieldHiddenFunction = (
-  fieldName: ValidHiddenFieldKeys,
-  config: SeoFieldsPluginConfig,
-) => {
-  return ({
-    document,
-  }: {
-    document?: {
-      _type?: string
-    }
-  }): boolean => {
-    const documentType = document?._type
-    return isFieldHidden(fieldName, config, documentType)
-  }
-}

package/src/utils/seoUtils.ts

@@ -1,423 +0,0 @@
-import {FeedbackType} from '../types'
-
-export const stopWords = ['the', 'a', 'an', 'and', 'or', 'but']
-
-export const hasMatchingKeyword = (title: string, keywordList: string[]): boolean => {
-  if (!title || keywordList.length === 0) return false
-  const lowerTitle = title.toLowerCase()
-  return keywordList.some((keyword) => keyword && lowerTitle.includes(keyword.toLowerCase()))
-}
-
-export const hasKeywordOveruse = (
-  title: string,
-  keywordList: string[],
-  maxOccurrences = 3,
-): boolean => {
-  if (!title || keywordList.length === 0) return false
-  const lowerTitle = title.toLowerCase()
-  return keywordList.some((keyword) => {
-    if (!keyword) return false
-    const matches = lowerTitle.match(new RegExp(keyword.toLowerCase(), 'g'))
-    return matches ? matches.length > maxOccurrences : false
-  })
-}
-
-export const startsWithStopWord = (title: string): boolean => {
-  if (!title) return false
-  const firstWord = title.trim().split(' ')[0].toLowerCase()
-  return stopWords.includes(firstWord)
-}
-
-export const primaryKeywordAtStart = (title: string, keywords: string[]): boolean => {
-  if (!title || keywords.length === 0) return true
-  return title.toLowerCase().startsWith(keywords[0].toLowerCase())
-}
-
-export const truncate = (text: string, maxLength: number): string =>
-  text.length > maxLength ? `${text.slice(0, maxLength)}…` : text
-
-export const hasExcessivePunctuation = (title: string): boolean => /[!@#$%^&*]{2,}/.test(title)
-
-export const getMetaTitleValidationMessages = (
-  title: string,
-  keywords: string[],
-  isParentseoField: boolean,
-): FeedbackType[] => {
-  const feedback: FeedbackType[] = []
-
-  const minChar = 50
-  const maxChar = 60
-  const charCount = title?.length || 0
-
-  // Empty check
-  if (!title?.trim()) {
-    feedback.push({text: 'Meta Title is empty. Add content to improve SEO.', color: 'red'})
-    return feedback
-  }
-
-  // Length check
-  if (charCount < minChar)
-    feedback.push({
-      text: `Title is ${charCount} characters — below recommended ${minChar}.`,
-      color: 'orange',
-    })
-  else if (charCount > maxChar)
-    feedback.push({
-      text: `Title is ${charCount} characters — exceeds recommended ${maxChar}.`,
-      color: 'red',
-    })
-  else feedback.push({text: `Title length (${charCount}) looks good for SEO.`, color: 'green'})
-
-  // Keyword checks
-  if (isParentseoField) {
-    if (keywords.length > 0) {
-      const hasKeyword = hasMatchingKeyword(title, keywords)
-      feedback.push({
-        text: hasKeyword
-          ? 'Keyword found in title — good job!'
-          : 'Keywords defined but missing in title.',
-        color: hasKeyword ? 'green' : 'red',
-      })
-
-      if (hasKeywordOveruse(title, keywords)) {
-        feedback.push({
-          text: 'Keyword appears too many times — avoid keyword stuffing.',
-          color: 'orange',
-        })
-      }
-    } else {
-      feedback.push({
-        text: 'No keywords defined. Consider adding relevant keywords.',
-        color: 'orange',
-      })
-    }
-  }
-
-  // Stop word check
-  if (startsWithStopWord(title))
-    feedback.push({text: 'Title starts with a stop word — consider rephrasing.', color: 'orange'})
-
-  // Punctuation check
-  if (hasExcessivePunctuation(title))
-    feedback.push({text: 'Title contains excessive punctuation — simplify it.', color: 'orange'})
-
-  return feedback
-}
-
-export const getMetaDescriptionValidationMessages = (
-  description: string,
-  keywords: string[],
-  isParentseoField: boolean,
-): FeedbackType[] => {
-  const feedback: FeedbackType[] = []
-
-  const minChar = 120
-  const maxChar = 160
-  const charCount = description?.length || 0
-
-  if (!description?.trim()) {
-    feedback.push({text: 'Meta description is empty. Add content to improve SEO.', color: 'red'})
-    return feedback
-  }
-
-  // Length check
-  if (charCount < minChar)
-    feedback.push({
-      text: `Description is ${charCount} chars — below recommended ${minChar}.`,
-      color: 'orange',
-    })
-  else if (charCount > maxChar)
-    feedback.push({
-      text: `Description is ${charCount} chars — exceeds recommended ${maxChar}.`,
-      color: 'red',
-    })
-  else
-    feedback.push({text: `Description length (${charCount}) looks good for SEO.`, color: 'green'})
-
-  // Keyword checks
-  if (isParentseoField) {
-    if (keywords.length > 0) {
-      const hasKeyword = hasMatchingKeyword(description, keywords)
-      feedback.push({
-        text: hasKeyword
-          ? 'Keyword found in description — good job!'
-          : 'Keywords defined but missing in description.',
-        color: hasKeyword ? 'green' : 'red',
-      })
-
-      if (hasKeywordOveruse(description, keywords)) {
-        feedback.push({
-          text: 'Keyword appears too many times — avoid keyword stuffing.',
-          color: 'orange',
-        })
-      }
-    } else {
-      feedback.push({
-        text: 'No keywords defined. Consider adding relevant keywords.',
-        color: 'orange',
-      })
-    }
-  }
-
-  // Stop word / filler check
-  if (startsWithStopWord(description))
-    feedback.push({
-      text: 'Description starts with a stop word — consider rephrasing.',
-      color: 'orange',
-    })
-
-  // Punctuation / special characters
-  if (hasExcessivePunctuation(description))
-    feedback.push({
-      text: 'Description contains excessive punctuation — simplify it.',
-      color: 'orange',
-    })
-
-  return feedback
-}
-
-export const getOgTitleValidation = (
-  title: string,
-  keywords: string[] = [],
-  isParentseoField: boolean,
-): FeedbackType[] => {
-  const feedback: FeedbackType[] = []
-  const min = 40
-  const max = 60
-  const count = title?.length || 0
-
-  // Empty check
-  if (!title?.trim()) {
-    feedback.push({text: 'OG Title is empty. Add content for better social preview.', color: 'red'})
-    return feedback
-  }
-
-  // Length check
-  if (count < min)
-    feedback.push({
-      text: `OG Title is ${count} chars — shorter than recommended ${min}.`,
-      color: 'orange',
-    })
-  else if (count > max)
-    feedback.push({text: `OG Title is ${count} chars — exceeds recommended ${max}.`, color: 'red'})
-  else feedback.push({text: `OG Title length (${count}) looks good.`, color: 'green'})
-
-  if (isParentseoField) {
-    // Keyword checks
-    if (keywords.length > 0) {
-      const hasKeyword = hasMatchingKeyword(title, keywords)
-      feedback.push({
-        text: hasKeyword
-          ? 'Keyword found in OG title — good job!'
-          : 'Keywords defined but missing in OG title.',
-        color: hasKeyword ? 'green' : 'red',
-      })
-
-      if (hasKeywordOveruse(title, keywords)) {
-        feedback.push({
-          text: 'Keyword appears too many times in OG title — avoid keyword stuffing.',
-          color: 'orange',
-        })
-      }
-    } else {
-      feedback.push({
-        text: 'No keywords defined. Consider adding relevant keywords.',
-        color: 'orange',
-      })
-    }
-  }
-
-  // Additional OG-specific checks
-  if (startsWithStopWord(title))
-    feedback.push({
-      text: 'OG Title starts with a stop word — consider rephrasing.',
-      color: 'orange',
-    })
-
-  if (hasExcessivePunctuation(title))
-    feedback.push({text: 'OG Title contains excessive punctuation — simplify it.', color: 'orange'})
-
-  return feedback
-}
-
-export const getOgDescriptionValidation = (
-  desc: string,
-  keywords: string[] = [],
-  isParentseoField: boolean,
-): FeedbackType[] => {
-  const feedback: FeedbackType[] = []
-  const min = 90
-  const max = 120
-  const count = desc?.length || 0
-
-  // Empty check
-  if (!desc?.trim()) {
-    feedback.push({
-      text: 'OG Description is empty. Add content for better social preview.',
-      color: 'red',
-    })
-    return feedback
-  }
-
-  // Length check
-  if (count < min)
-    feedback.push({
-      text: `OG Description is ${count} chars — shorter than recommended ${min}.`,
-      color: 'orange',
-    })
-  else if (count > max)
-    feedback.push({
-      text: `OG Description is ${count} chars — exceeds recommended ${max}.`,
-      color: 'red',
-    })
-  else feedback.push({text: `OG Description length (${count}) looks good.`, color: 'green'})
-
-  // Keyword checks
-  if (isParentseoField) {
-    if (keywords.length > 0) {
-      const hasKeyword = hasMatchingKeyword(desc, keywords)
-      feedback.push({
-        text: hasKeyword
-          ? 'Keyword found in OG description — good job!'
-          : 'Keywords defined but missing in OG description.',
-        color: hasKeyword ? 'green' : 'red',
-      })
-
-      if (hasKeywordOveruse(desc, keywords)) {
-        feedback.push({
-          text: 'Keyword appears too many times in OG description — avoid keyword stuffing.',
-          color: 'orange',
-        })
-      }
-    } else {
-      feedback.push({
-        text: 'No keywords defined. Consider adding relevant keywords.',
-        color: 'orange',
-      })
-    }
-  }
-
-  // Additional OG-specific checks
-  if (startsWithStopWord(desc))
-    feedback.push({
-      text: 'OG Description starts with a stop word — consider rephrasing.',
-      color: 'orange',
-    })
-
-  if (hasExcessivePunctuation(desc))
-    feedback.push({
-      text: 'OG Description contains excessive punctuation — simplify it.',
-      color: 'orange',
-    })
-
-  return feedback
-}
-
-export const getTwitterTitleValidation = (
-  title: string,
-  keywords: string[] = [],
-  isParentseoField: boolean,
-): FeedbackType[] => {
-  const feedback: FeedbackType[] = []
-  const min = 30
-  const max = 70
-  const count = title?.length || 0
-
-  if (!title?.trim()) {
-    feedback.push({text: 'X Title is empty. Add content for better SEO.', color: 'red'})
-    return feedback
-  }
-
-  // Length check
-  if (count < min)
-    feedback.push({
-      text: `X Title is ${count} chars — shorter than recommended ${min}.`,
-      color: 'orange',
-    })
-  else if (count > max)
-    feedback.push({
-      text: `X Title is ${count} chars — exceeds recommended ${max}.`,
-      color: 'red',
-    })
-  else feedback.push({text: `X Title length (${count}) looks good.`, color: 'green'})
-
-  if (isParentseoField) {
-    // Keyword checks
-    if (keywords.length > 0) {
-      const hasKeyword = hasMatchingKeyword(title, keywords)
-      feedback.push({
-        text: hasKeyword
-          ? 'Keyword found in X title — good job!'
-          : 'Keywords defined but missing in X title.',
-        color: hasKeyword ? 'green' : 'red',
-      })
-    } else {
-      feedback.push({
-        text: 'No keywords defined. Consider adding relevant keywords.',
-        color: 'orange',
-      })
-    }
-  }
-
-  // Punctuation check
-  if (/[!@#$%^&*]{2,}/.test(title))
-    feedback.push({text: 'X Title has excessive punctuation — simplify it.', color: 'orange'})
-
-  return feedback
-}
-
-export const getTwitterDescriptionValidation = (
-  desc: string,
-  keywords: string[] = [],
-  isParentseoField: boolean,
-): FeedbackType[] => {
-  const feedback: FeedbackType[] = []
-  const min = 50
-  const max = 200
-  const count = desc?.length || 0
-
-  if (!desc?.trim()) {
-    feedback.push({text: 'X Description is empty. Add content for better SEO.', color: 'red'})
-    return feedback
-  }
-
-  // Length check
-  if (count < min)
-    feedback.push({
-      text: `X Description is ${count} chars — shorter than recommended ${min}.`,
-      color: 'orange',
-    })
-  else if (count > max)
-    feedback.push({
-      text: `X Description is ${count} chars — exceeds recommended ${max}.`,
-      color: 'red',
-    })
-  else feedback.push({text: `X Description length (${count}) looks good.`, color: 'green'})
-
-  if (isParentseoField) {
-    // Keyword checks
-    if (keywords.length > 0) {
-      const hasKeyword = hasMatchingKeyword(desc, keywords)
-      feedback.push({
-        text: hasKeyword
-          ? 'Keyword found in X description — good job!'
-          : 'Keywords defined but missing in X description.',
-        color: hasKeyword ? 'green' : 'red',
-      })
-    } else {
-      feedback.push({
-        text: 'No keywords defined. Consider adding relevant keywords.',
-        color: 'orange',
-      })
-    }
-  }
-
-  // Punctuation check
-  if (/[!@#$%^&*]{2,}/.test(desc))
-    feedback.push({
-      text: 'X Description has excessive punctuation — simplify it.',
-      color: 'orange',
-    })
-
-  return feedback
-}

package/src/utils/utils.ts

@@ -1,9 +0,0 @@
-export const isEmpty = (value: unknown): boolean => {
-  return (
-    value === null ||
-    value === undefined ||
-    (typeof value === 'string' && value.trim() === '') ||
-    (Array.isArray(value) && value.length === 0) ||
-    (typeof value === 'object' && !Array.isArray(value) && Object.keys(value).length === 0)
-  )
-}

package/v2-incompatible.js

@@ -1,11 +0,0 @@
-const {showIncompatiblePluginDialog} = require('@sanity/incompatible-plugin')
-const {name, version, sanityExchangeUrl} = require('./package.json')
-
-export default showIncompatiblePluginDialog({
-  name: name,
-  versions: {
-    v3: version,
-    v2: undefined,
-  },
-  sanityExchangeUrl,
-})