sanity-plugin-seofields 1.1.1 → 1.2.1

package/dist/index.d.mts

@@ -221,6 +221,12 @@ export declare interface SeoFieldsPluginConfig {
           icon?: string
           title?: string
           description?: string
+          /** Text shown while the license key is being verified. Defaults to "Verifying license…" */
+          loadingLicense?: string
+          /** Text shown while documents are being fetched. Defaults to "Loading documents…" */
+          loadingDocuments?: string
+          /** Text shown when the query returns zero results. Defaults to "No documents found" */
+          noDocuments?: string
         }
         display?: {
           typeColumn?: boolean
@@ -254,6 +260,64 @@ export declare interface SeoFieldsPluginConfig {
          * Obtain a license at https://sanity-plugin-seofields.thehardik.in
          */
         licenseKey?: string
+        /**
+         * Map raw `_type` values to human-readable display labels.
+         * Used in both the Type column and the Type filter dropdown.
+         * Any type without an entry falls back to the raw `_type` string.
+         *
+         * @example
+         * typeLabels: { productDrug: 'Products', singleCondition: 'Condition' }
+         */
+        typeLabels?: Record<string, string>
+        /**
+         * Controls how the document type is rendered in the Type column.
+         * - `'badge'` (default) — coloured pill
+         * - `'text'` — plain text, useful for dense layouts
+         */
+        typeColumnMode?: 'badge' | 'text'
+        /**
+         * The document field to use as the display title in the dashboard.
+         *
+         * - `string` — use this field for every document type (e.g. `'name'`)
+         * - `Record<string, string>` — per-type mapping; unmapped types fall back to `title`
+         *
+         * @example
+         * titleField: 'name'
+         *
+         * @example
+         * titleField: { post: 'title', product: 'name', category: 'label' }
+         */
+        titleField?: string | Record<string, string>
+        /**
+         * Callback function to render a custom badge next to the document title.
+         * Receives the full document and should return badge data or undefined.
+         *
+         * @example
+         * docBadge: (doc) => {
+         *   if (doc.services === 'NHS')
+         *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
+         *   if (doc.services === 'Private')
+         *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
+         * }
+         */
+        docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) =>
+          | {
+              label: string
+              bgColor?: string
+              textColor?: string
+              fontSize?: string
+            }
+          | undefined
+        /**
+         * Enable preview/demo mode to show dummy data.
+         * Useful for testing, documentation, or showcasing the dashboard.
+         * When enabled, displays realistic sample documents with various SEO scores.
+         * Defaults to `false`.
+         *
+         * @example
+         * previewMode: true
+         */
+        previewMode?: boolean
       }
 }
 
@@ -294,6 +358,78 @@ declare interface SeoHealthDashboardProps {
    * Obtain a key at https://sanity-plugin-seofields.thehardik.in
    */
   licenseKey?: string
+  /**
+   * Map raw `_type` values to human-readable display labels used in the
+   * Type column and the Type filter dropdown.
+   * Any type without an entry falls back to the raw `_type` string.
+   *
+   * @example
+   * typeLabels={{ productDrug: 'Products', singleCondition: 'Condition' }}
+   */
+  typeLabels?: Record<string, string>
+  /**
+   * Controls how the type is rendered in the Type column.
+   * - `'badge'` (default) — coloured pill, consistent with score badges
+   * - `'text'` — plain text, useful for dense layouts
+   */
+  typeColumnMode?: 'badge' | 'text'
+  /**
+   * The document field to use as the display title.
+   *
+   * - `string` — use this field for every document type (e.g. `'name'`)
+   * - `Record<string, string>` — per-type mapping; unmapped types fall back to `title`
+   *
+   * @example
+   * // Same field for all types
+   * titleField: 'name'
+   *
+   * @example
+   * // Different field per type
+   * titleField: { post: 'title', product: 'name', category: 'label' }
+   */
+  titleField?: string | Record<string, string>
+  /**
+   * Callback function to render a custom badge next to the document title.
+   * Receives the full document and should return badge data or undefined.
+   *
+   * @example
+   * docBadge: (doc) => {
+   *   if (doc.services === 'NHS')
+   *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
+   *   if (doc.services === 'Private')
+   *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
+   * }
+   */
+  docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) =>
+    | {
+        label: string
+        bgColor?: string
+        textColor?: string
+        fontSize?: string
+      }
+    | undefined
+  /**
+   * Custom text shown while the license key is being verified.
+   * Defaults to `"Verifying license…"`.
+   */
+  loadingLicense?: React_2.ReactNode
+  /**
+   * Custom text shown while documents are being fetched.
+   * Defaults to `"Loading documents…"`.
+   */
+  loadingDocuments?: React_2.ReactNode
+  /**
+   * Custom text shown when the query returns zero results.
+   * Defaults to `"No documents found"`.
+   */
+  noDocuments?: React_2.ReactNode
+  /**
+   * Enable preview/demo mode to show dummy data.
+   * Useful for testing, documentation, or showcasing the dashboard.
+   * When enabled, displays realistic sample documents with various SEO scores.
+   * Defaults to `false`.
+   */
+  previewMode?: boolean
 }
 
 export declare interface SeoHealthMetrics {

package/dist/index.d.ts

@@ -221,6 +221,12 @@ export declare interface SeoFieldsPluginConfig {
           icon?: string
           title?: string
           description?: string
+          /** Text shown while the license key is being verified. Defaults to "Verifying license…" */
+          loadingLicense?: string
+          /** Text shown while documents are being fetched. Defaults to "Loading documents…" */
+          loadingDocuments?: string
+          /** Text shown when the query returns zero results. Defaults to "No documents found" */
+          noDocuments?: string
         }
         display?: {
           typeColumn?: boolean
@@ -254,6 +260,64 @@ export declare interface SeoFieldsPluginConfig {
          * Obtain a license at https://sanity-plugin-seofields.thehardik.in
          */
         licenseKey?: string
+        /**
+         * Map raw `_type` values to human-readable display labels.
+         * Used in both the Type column and the Type filter dropdown.
+         * Any type without an entry falls back to the raw `_type` string.
+         *
+         * @example
+         * typeLabels: { productDrug: 'Products', singleCondition: 'Condition' }
+         */
+        typeLabels?: Record<string, string>
+        /**
+         * Controls how the document type is rendered in the Type column.
+         * - `'badge'` (default) — coloured pill
+         * - `'text'` — plain text, useful for dense layouts
+         */
+        typeColumnMode?: 'badge' | 'text'
+        /**
+         * The document field to use as the display title in the dashboard.
+         *
+         * - `string` — use this field for every document type (e.g. `'name'`)
+         * - `Record<string, string>` — per-type mapping; unmapped types fall back to `title`
+         *
+         * @example
+         * titleField: 'name'
+         *
+         * @example
+         * titleField: { post: 'title', product: 'name', category: 'label' }
+         */
+        titleField?: string | Record<string, string>
+        /**
+         * Callback function to render a custom badge next to the document title.
+         * Receives the full document and should return badge data or undefined.
+         *
+         * @example
+         * docBadge: (doc) => {
+         *   if (doc.services === 'NHS')
+         *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
+         *   if (doc.services === 'Private')
+         *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
+         * }
+         */
+        docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) =>
+          | {
+              label: string
+              bgColor?: string
+              textColor?: string
+              fontSize?: string
+            }
+          | undefined
+        /**
+         * Enable preview/demo mode to show dummy data.
+         * Useful for testing, documentation, or showcasing the dashboard.
+         * When enabled, displays realistic sample documents with various SEO scores.
+         * Defaults to `false`.
+         *
+         * @example
+         * previewMode: true
+         */
+        previewMode?: boolean
       }
 }
 
@@ -294,6 +358,78 @@ declare interface SeoHealthDashboardProps {
    * Obtain a key at https://sanity-plugin-seofields.thehardik.in
    */
   licenseKey?: string
+  /**
+   * Map raw `_type` values to human-readable display labels used in the
+   * Type column and the Type filter dropdown.
+   * Any type without an entry falls back to the raw `_type` string.
+   *
+   * @example
+   * typeLabels={{ productDrug: 'Products', singleCondition: 'Condition' }}
+   */
+  typeLabels?: Record<string, string>
+  /**
+   * Controls how the type is rendered in the Type column.
+   * - `'badge'` (default) — coloured pill, consistent with score badges
+   * - `'text'` — plain text, useful for dense layouts
+   */
+  typeColumnMode?: 'badge' | 'text'
+  /**
+   * The document field to use as the display title.
+   *
+   * - `string` — use this field for every document type (e.g. `'name'`)
+   * - `Record<string, string>` — per-type mapping; unmapped types fall back to `title`
+   *
+   * @example
+   * // Same field for all types
+   * titleField: 'name'
+   *
+   * @example
+   * // Different field per type
+   * titleField: { post: 'title', product: 'name', category: 'label' }
+   */
+  titleField?: string | Record<string, string>
+  /**
+   * Callback function to render a custom badge next to the document title.
+   * Receives the full document and should return badge data or undefined.
+   *
+   * @example
+   * docBadge: (doc) => {
+   *   if (doc.services === 'NHS')
+   *     return { label: 'NHS', bgColor: '#e0f2fe', textColor: '#0369a1' }
+   *   if (doc.services === 'Private')
+   *     return { label: 'Private', bgColor: '#fef3c7', textColor: '#92400e' }
+   * }
+   */
+  docBadge?: (doc: DocumentWithSeoHealth & Record<string, unknown>) =>
+    | {
+        label: string
+        bgColor?: string
+        textColor?: string
+        fontSize?: string
+      }
+    | undefined
+  /**
+   * Custom text shown while the license key is being verified.
+   * Defaults to `"Verifying license…"`.
+   */
+  loadingLicense?: React_2.ReactNode
+  /**
+   * Custom text shown while documents are being fetched.
+   * Defaults to `"Loading documents…"`.
+   */
+  loadingDocuments?: React_2.ReactNode
+  /**
+   * Custom text shown when the query returns zero results.
+   * Defaults to `"No documents found"`.
+   */
+  noDocuments?: React_2.ReactNode
+  /**
+   * Enable preview/demo mode to show dummy data.
+   * Useful for testing, documentation, or showcasing the dashboard.
+   * When enabled, displays realistic sample documents with various SEO scores.
+   * Defaults to `false`.
+   */
+  previewMode?: boolean
 }
 
 export declare interface SeoHealthMetrics {