sanity-plugin-seofields 1.2.2 → 1.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -55,6 +55,14 @@ export declare interface FieldVisibilityConfig {
55
55
  hiddenFields?: ValidHiddenFieldKeys[]
56
56
  }
57
57
 
58
+ declare interface MetaAttribute {
59
+ _type: 'metaAttribute'
60
+ key?: string
61
+ type?: 'string' | 'image'
62
+ value?: string
63
+ image?: SanityImage
64
+ }
65
+
58
66
  export declare const metaAttributeSchema: {
59
67
  type: 'object'
60
68
  name: 'metaAttribute'
@@ -92,6 +100,8 @@ export declare function openGraphSchema(config?: SeoFieldsPluginConfig): SchemaT
92
100
 
93
101
  declare interface OpenGraphSettings {
94
102
  _type: 'openGraph'
103
+ /** The canonical URL for OpenGraph (og:url). Maps to the `url` field in Sanity. */
104
+ url?: string
95
105
  title?: string
96
106
  description?: string
97
107
  siteName?: string
@@ -159,6 +169,7 @@ declare interface SeoFields {
159
169
  title?: string
160
170
  description?: string
161
171
  metaImage?: SanityImage
172
+ metaAttributes?: MetaAttribute[]
162
173
  keywords?: string[]
163
174
  canonicalUrl?: string
164
175
  openGraph?: OpenGraphSettings
@@ -338,6 +349,16 @@ export declare interface SeoFieldsPluginConfig {
338
349
  fontSize?: string
339
350
  }
340
351
  | undefined
352
+ /**
353
+ * The `name` of the Sanity structure tool that contains the monitored documents.
354
+ * Required when you have multiple structure tools and the documents live in a
355
+ * non-default one. Clicking a title will navigate to
356
+ * `/{basePath}/{structureTool}/intent/edit/…` directly.
357
+ *
358
+ * @example
359
+ * structureTool: 'common'
360
+ */
361
+ structureTool?: string
341
362
  /**
342
363
  * Enable preview/demo mode to show dummy data.
343
364
  * Useful for testing, documentation, or showcasing the dashboard.
@@ -472,6 +493,19 @@ declare interface SeoHealthDashboardProps {
472
493
  * This is set to `true` automatically by `createSeoHealthPane`.
473
494
  */
474
495
  openInPane?: boolean
496
+ /**
497
+ * The `name` of the Sanity structure tool that contains the monitored documents.
498
+ * When provided, clicking a document title navigates directly to that tool's
499
+ * intent URL (`/{basePath}/{structureTool}/intent/edit/id=…;type=…/`) instead of
500
+ * using the generic intent resolver, which always picks the first registered tool.
501
+ *
502
+ * Required when you have multiple structure tools and the documents live in a
503
+ * non-default one (e.g. `name: 'common'`).
504
+ *
505
+ * @example
506
+ * structureTool: 'common'
507
+ */
508
+ structureTool?: string
475
509
  }
476
510
 
477
511
  export declare interface SeoHealthMetrics {
@@ -513,6 +547,7 @@ declare interface TwitterCardSettings {
513
547
  _type: 'twitter'
514
548
  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
515
549
  site?: string
550
+ creator?: string
516
551
  title?: string
517
552
  description?: string
518
553
  imageType?: 'upload' | 'url'
package/dist/index.d.ts CHANGED
@@ -55,6 +55,14 @@ export declare interface FieldVisibilityConfig {
55
55
  hiddenFields?: ValidHiddenFieldKeys[]
56
56
  }
57
57
 
58
+ declare interface MetaAttribute {
59
+ _type: 'metaAttribute'
60
+ key?: string
61
+ type?: 'string' | 'image'
62
+ value?: string
63
+ image?: SanityImage
64
+ }
65
+
58
66
  export declare const metaAttributeSchema: {
59
67
  type: 'object'
60
68
  name: 'metaAttribute'
@@ -92,6 +100,8 @@ export declare function openGraphSchema(config?: SeoFieldsPluginConfig): SchemaT
92
100
 
93
101
  declare interface OpenGraphSettings {
94
102
  _type: 'openGraph'
103
+ /** The canonical URL for OpenGraph (og:url). Maps to the `url` field in Sanity. */
104
+ url?: string
95
105
  title?: string
96
106
  description?: string
97
107
  siteName?: string
@@ -159,6 +169,7 @@ declare interface SeoFields {
159
169
  title?: string
160
170
  description?: string
161
171
  metaImage?: SanityImage
172
+ metaAttributes?: MetaAttribute[]
162
173
  keywords?: string[]
163
174
  canonicalUrl?: string
164
175
  openGraph?: OpenGraphSettings
@@ -338,6 +349,16 @@ export declare interface SeoFieldsPluginConfig {
338
349
  fontSize?: string
339
350
  }
340
351
  | undefined
352
+ /**
353
+ * The `name` of the Sanity structure tool that contains the monitored documents.
354
+ * Required when you have multiple structure tools and the documents live in a
355
+ * non-default one. Clicking a title will navigate to
356
+ * `/{basePath}/{structureTool}/intent/edit/…` directly.
357
+ *
358
+ * @example
359
+ * structureTool: 'common'
360
+ */
361
+ structureTool?: string
341
362
  /**
342
363
  * Enable preview/demo mode to show dummy data.
343
364
  * Useful for testing, documentation, or showcasing the dashboard.
@@ -472,6 +493,19 @@ declare interface SeoHealthDashboardProps {
472
493
  * This is set to `true` automatically by `createSeoHealthPane`.
473
494
  */
474
495
  openInPane?: boolean
496
+ /**
497
+ * The `name` of the Sanity structure tool that contains the monitored documents.
498
+ * When provided, clicking a document title navigates directly to that tool's
499
+ * intent URL (`/{basePath}/{structureTool}/intent/edit/id=…;type=…/`) instead of
500
+ * using the generic intent resolver, which always picks the first registered tool.
501
+ *
502
+ * Required when you have multiple structure tools and the documents live in a
503
+ * non-default one (e.g. `name: 'common'`).
504
+ *
505
+ * @example
506
+ * structureTool: 'common'
507
+ */
508
+ structureTool?: string
475
509
  }
476
510
 
477
511
  export declare interface SeoHealthMetrics {
@@ -513,6 +547,7 @@ declare interface TwitterCardSettings {
513
547
  _type: 'twitter'
514
548
  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
515
549
  site?: string
550
+ creator?: string
516
551
  title?: string
517
552
  description?: string
518
553
  imageType?: 'upload' | 'url'