sanity-plugin-seofields 1.0.1 → 1.0.2

package/README.md

@@ -37,7 +37,7 @@ Add the plugin to your `sanity.config.ts` (or `.js`) file:
 
 ```typescript
 import {defineConfig} from 'sanity'
-import {seofields} from 'sanity-plugin-seofields'
+import seofields from 'sanity-plugin-seofields'
 
 export default defineConfig({
   name: 'your-project',
@@ -140,17 +140,69 @@ export default defineType({
 ### Basic Configuration
 
 ```typescript
-import {seofields} from 'sanity-plugin-seofields'
+import seofields from 'sanity-plugin-seofields'
+
+export default defineConfig({
+  plugins: [
+    seofields(), // Use default configuration
+  ],
+})
+```
+
+### Advanced Configuration
+
+You can customize field titles and descriptions, and control SEO preview functionality:
+
+```typescript
+import seofields, {SeoFieldsPluginConfig} from 'sanity-plugin-seofields'
 
 export default defineConfig({
   plugins: [
     seofields({
-      // Plugin options (none required currently)
-    }),
+      seoPreview: true, // Enable/disable SEO preview (default: true)
+      fieldOverrides: {
+        title: {
+          title: 'Page Title',
+          description: 'The main title that appears in search results',
+        },
+        description: {
+          title: 'Meta Description',
+          description: 'A brief description of the page content for search engines',
+        },
+        canonicalUrl: {
+          title: 'Canonical URL',
+          description: 'The preferred URL for this page to avoid duplicate content issues',
+        },
+        metaImage: {
+          title: 'Social Media Image',
+          description: 'Image used when sharing this page on social media',
+        },
+        keywords: {
+          title: 'SEO Keywords',
+          description: 'Keywords that describe the content of this page',
+        },
+      },
+    } satisfies SeoFieldsPluginConfig),
   ],
 })
 ```
 
+### Configuration Options
+
+| Option           | Type      | Default | Description                                 |
+| ---------------- | --------- | ------- | ------------------------------------------- |
+| `seoPreview`     | `boolean` | `true`  | Enable/disable the live SEO preview feature |
+| `fieldOverrides` | `object`  | `{}`    | Customize field titles and descriptions     |
+
+#### Field Configuration
+
+Each field in the `fieldOverrides` object can have:
+
+- `title` - Custom title for the field
+- `description` - Custom description/help text for the field
+
+Available field keys: `title`, `description`, `canonicalUrl`, `metaImage`, `keywords`
+
 ### Field Specifications
 
 #### Meta Title
@@ -183,7 +235,27 @@ export default defineConfig({
 The plugin includes full TypeScript support:
 
 ```typescript
-import type {SeoFields, OpenGraphSettings, TwitterCardSettings} from 'sanity-plugin-seofields'
+import type {
+  SeoFields,
+  OpenGraphSettings,
+  TwitterCardSettings,
+  SeoFieldsPluginConfig,
+} from 'sanity-plugin-seofields'
+
+// Plugin configuration
+const pluginConfig: SeoFieldsPluginConfig = {
+  seoPreview: true,
+  fields: {
+    title: {
+      title: 'Page Title',
+      description: 'The main title for search engines',
+    },
+    description: {
+      title: 'Meta Description',
+      description: 'Brief description for search results',
+    },
+  },
+}
 
 // Use in your document interfaces
 interface PageDocument {
@@ -211,6 +283,9 @@ const seoData: SeoFields = {
 ```typescript
 import type {
   SeoFields,
+  SeoFieldsPluginConfig,
+  SeoField,
+  SeoFieldKeys,
   OpenGraphSettings,
   TwitterCardSettings,
   MetaAttribute,
@@ -338,7 +413,7 @@ export function SEO({seo}: SEOProps) {
 ### Main Export
 
 ```typescript
-import {seofields} from 'sanity-plugin-seofields'
+import seofields from 'sanity-plugin-seofields'
 ```
 
 ### Schema Types

package/dist/index.d.mts

@@ -2,7 +2,7 @@ import {ObjectDefinition} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PreviewConfig} from 'sanity'
 
-export declare const allSchemas: (
+export declare function allSchemas(config?: SeoFieldsPluginConfig): (
   | ({
       type: 'object'
       name: 'seoFields'
@@ -99,8 +99,6 @@ export declare const metaTagSchema: {
     preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
   }
 
-declare interface MyPluginConfig {}
-
 export declare const openGraphSchema: {
   type: 'object'
   name: 'openGraph'
@@ -119,6 +117,13 @@ export declare interface OpenGraphSettings {
   imageUrl?: string
 }
 
+export declare const robotsSchema: {
+  type: 'object'
+  name: 'robots'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+  }
+
 export declare interface RobotsSettings {
   noIndex?: boolean
   noFollow?: boolean
@@ -149,6 +154,18 @@ export declare interface SanityImageWithAlt extends SanityImage {
   alt: string
 }
 
+export declare interface SeoField {
+  title?: string
+  description?: string
+}
+
+export declare type SeoFieldKeys =
+  | 'title'
+  | 'description'
+  | 'canonicalUrl'
+  | 'metaImage'
+  | 'keywords'
+
 export declare interface SeoFields {
   _type: 'seoFields'
   robots?: RobotsSettings
@@ -162,22 +179,17 @@ export declare interface SeoFields {
   twitter?: TwitterCardSettings
 }
 
-/**
- * Usage in `sanity.config.ts` (or .js)
- *
- * ```ts
- * import {defineConfig} from 'sanity'
- * import {myPlugin} from 'sanity-plugin-seofields'
- *
- * export default defineConfig({
- *   // ...
- *   plugins: [seofields()],
- * })
- * ```
- */
-export declare const seofields: Plugin_2<void | MyPluginConfig>
-
-export declare const seoFieldsSchema: {
+declare const seofields: Plugin_2<void | SeoFieldsPluginConfig>
+export default seofields
+
+export declare interface SeoFieldsPluginConfig {
+  seoPreview?: boolean
+  fieldOverrides?: {
+    [key in SeoFieldKeys]?: SeoField
+  }
+}
+
+export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): {
   type: 'object'
   name: 'seoFields'
 } & Omit<ObjectDefinition, 'preview'> & {

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import {ObjectDefinition} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PreviewConfig} from 'sanity'
 
-export declare const allSchemas: (
+export declare function allSchemas(config?: SeoFieldsPluginConfig): (
   | ({
       type: 'object'
       name: 'seoFields'
@@ -99,8 +99,6 @@ export declare const metaTagSchema: {
     preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
   }
 
-declare interface MyPluginConfig {}
-
 export declare const openGraphSchema: {
   type: 'object'
   name: 'openGraph'
@@ -119,6 +117,13 @@ export declare interface OpenGraphSettings {
   imageUrl?: string
 }
 
+export declare const robotsSchema: {
+  type: 'object'
+  name: 'robots'
+} & Omit<ObjectDefinition, 'preview'> & {
+    preview?: PreviewConfig<Record<string, string>, Record<never, any>> | undefined
+  }
+
 export declare interface RobotsSettings {
   noIndex?: boolean
   noFollow?: boolean
@@ -149,6 +154,18 @@ export declare interface SanityImageWithAlt extends SanityImage {
   alt: string
 }
 
+export declare interface SeoField {
+  title?: string
+  description?: string
+}
+
+export declare type SeoFieldKeys =
+  | 'title'
+  | 'description'
+  | 'canonicalUrl'
+  | 'metaImage'
+  | 'keywords'
+
 export declare interface SeoFields {
   _type: 'seoFields'
   robots?: RobotsSettings
@@ -162,22 +179,17 @@ export declare interface SeoFields {
   twitter?: TwitterCardSettings
 }
 
-/**
- * Usage in `sanity.config.ts` (or .js)
- *
- * ```ts
- * import {defineConfig} from 'sanity'
- * import {myPlugin} from 'sanity-plugin-seofields'
- *
- * export default defineConfig({
- *   // ...
- *   plugins: [seofields()],
- * })
- * ```
- */
-export declare const seofields: Plugin_2<void | MyPluginConfig>
-
-export declare const seoFieldsSchema: {
+declare const seofields: Plugin_2<void | SeoFieldsPluginConfig>
+export default seofields
+
+export declare interface SeoFieldsPluginConfig {
+  seoPreview?: boolean
+  fieldOverrides?: {
+    [key in SeoFieldKeys]?: SeoField
+  }
+}
+
+export declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): {
   type: 'object'
   name: 'seoFields'
 } & Omit<ObjectDefinition, 'preview'> & {