sanity-plugin-seofields 1.0.1 → 1.0.2

package/src/schemas/index.ts

@@ -2,92 +2,104 @@ import {defineField, defineType} from 'sanity'
 import MetaTitle from '../components/meta/MetaTitle'
 import MetaDescription from '../components/meta/MetaDescription'
 import SeoPreview from '../components/SeoPreview'
+import {SeoFieldsPluginConfig} from '../plugin'
+import {getFieldInfo} from '../utils/fieldsUtils'
 
-export default defineType({
-  name: 'seoFields',
-  title: 'SEO Fields',
-  type: 'object',
-  fields: [
-    defineField({
-      name: 'robots',
-      title: 'Robots Settings',
-      type: 'robots', // Use the separate robots type here
-    }),
-    defineField({
-      name: 'preview',
-      title: 'SEO Preview',
-      type: 'string',
-      components: {
-        input: SeoPreview, // custom React component
-      },
-      // you can mark it read-only if you don't want editors to change it
-      readOnly: true,
-    }),
-    defineField({
-      name: 'title',
-      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.'),
-    }),
-    defineField({
-      name: 'description',
-      title: 'Meta Description',
-      type: 'text',
-      rows: 3,
-      description:
-        'Provide a concise summary of the page content. This description may be used by search engines in search results.',
-      components: {
-        input: MetaDescription,
-      },
-      // validation: (Rule) => Rule.max(160).warning('Meta description should be under 160 characters.'),
-    }),
-    defineField({
-      name: 'metaImage',
-      title: 'Meta Image',
-      type: 'image',
-      options: {
-        hotspot: true,
-      },
-      description:
-        'Upload an image that represents the content of the page. This image may be used in social media previews and search engine results.',
-    }),
-    defineField({
-      name: 'metaAttributes',
-      title: 'Additional 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.',
-    }),
-    defineField({
-      name: 'keywords',
-      title: 'Keywords',
-      type: 'array',
-      of: [{type: 'string'}],
-      description:
-        'Add relevant keywords for this page. These keywords will be used for SEO purposes.',
-    }),
-    defineField({
-      name: 'canonicalUrl',
-      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.',
-    }),
-    defineField({
-      name: 'openGraph',
-      title: 'Open Graph Settings',
-      type: 'openGraph',
-    }),
-    defineField({
-      name: 'twitter',
-      title: 'Twitter Card Settings',
-      type: 'twitter',
-    }),
-  ],
-})
+export default function seoFieldsSchema(config: SeoFieldsPluginConfig = {}) {
+  return defineType({
+    name: 'seoFields',
+    title: 'SEO Fields',
+    type: 'object',
+    fields: [
+      defineField({
+        name: 'robots',
+        title: 'Robots Settings',
+        type: 'robots', // Use the separate robots type here
+      }),
+      // 👇 conditionally spread preview field
+      ...(config.seoPreview
+        ? []
+        : [
+            defineField({
+              name: 'preview',
+              title: 'SEO Preview',
+              type: 'string',
+              components: {input: SeoPreview},
+              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.'),
+      }),
+      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.'),
+      }),
+      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,
+        },
+      }),
+      defineField({
+        name: 'metaAttributes',
+        title: 'Additional 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.',
+      }),
+      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.',
+      }),
+      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.',
+      }),
+      defineField({
+        name: 'openGraph',
+        title: 'Open Graph Settings',
+        type: 'openGraph',
+      }),
+      defineField({
+        name: 'twitter',
+        title: 'Twitter Card Settings',
+        type: 'twitter',
+      }),
+    ],
+  })
+}

package/src/schemas/types/index.ts

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

package/src/utils/fieldsUtils.ts

@@ -0,0 +1,137 @@
+// import {defineField, defineType} from 'sanity'
+// import OgTitle from '../../../components/openGraph/OgTitle'
+// import OgDescription from '../../../components/openGraph/OgDescription'
+
+import {SeoField, SeoFieldsPluginConfig} from '../plugin'
+
+// export default defineType({
+//   name: 'openGraph',
+//   title: 'Open Graph Settings',
+//   type: 'object',
+//   fields: [
+//     defineField({
+//       name: 'title',
+//       title: 'Open Graph Title',
+//       type: 'string',
+//       components: {
+//         input: OgTitle, // Can also wrap with a string input + preview
+//       },
+//     }),
+//     defineField({
+//       name: 'description',
+//       title: 'Open Graph Description',
+//       type: 'text',
+//       rows: 3,
+//       components: {
+//         input: OgDescription, // Can also wrap with a text area + preview
+//       },
+//     }),
+//     defineField({
+//       name: 'siteName',
+//       title: 'Open Graph Site Name',
+//       type: 'string',
+//       description: 'The name of your website. This is often the site title.',
+//     }),
+//     defineField({
+//       name: 'type',
+//       title: 'Open Graph Type',
+//       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
+//       },
+//       initialValue: 'website',
+//       description: 'Select the type of content for Open Graph.',
+//     }),
+
+//     // upload image or ask for url
+//     defineField({
+//       name: 'imageType',
+//       title: 'Image Type',
+//       type: 'string',
+//       options: {
+//         list: [
+//           {title: 'Upload Image', value: 'upload'},
+//           {title: 'Image URL', value: 'url'},
+//         ],
+//       },
+//       initialValue: 'upload',
+//     }),
+//     defineField({
+//       name: 'image',
+//       title: 'Open Graph Image',
+//       type: 'image',
+//       options: {
+//         hotspot: true,
+//       },
+//       hidden: ({parent}) => parent?.imageType !== 'upload',
+//       description:
+//         'Recommended size: 1200x630px (minimum 600x315px). Max file size: 5MB. Aspect ratio 1.91:1.',
+//     }),
+//     defineField({
+//       name: 'imageUrl',
+//       title: 'Open Graph Image URL',
+//       type: 'url',
+//       hidden: ({parent}) => parent?.imageType !== 'url',
+//       description:
+//         'Enter the full URL of the image. Ensure the image is accessible and meets the recommended size of 1200x630px (minimum 600x315px).',
+//     }),
+//   ],
+// })
+
+const DEFAULT_FIELD_INFO = {
+  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.',
+  },
+}
+
+export const getFieldInfo = (
+  fieldName: string,
+  fieldOverrides: SeoFieldsPluginConfig['fieldOverrides'],
+) => {
+  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: ''}
+}

package/src/utils/generaeDynamicJsonLd.ts

@@ -258,7 +258,7 @@ function generateSchemaJson(): JsonSchema {
   }
 
   // Convert each schema
-  schemas.forEach((schema) => {
+  schemas().forEach((schema) => {
     if (schema.name) {
       const jsonSchemaDefinition = convertSanitySchemaToJsonSchema(schema)
       jsonSchema.definitions[schema.name] = jsonSchemaDefinition