sanity-plugin-seofields 1.2.5 → 1.2.7

package/dist/index.d.cts

@@ -0,0 +1,422 @@
+import * as sanity from 'sanity';
+import { SchemaTypeDefinition } from 'sanity';
+import { D as DocumentWithSeoHealth } from './types-B91ena4g.cjs';
+export { S as SeoHealthMetrics, a as SeoHealthStatus } from './types-B91ena4g.cjs';
+import React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { StructureBuilder, ComponentBuilder } from 'sanity/structure';
+
+interface SeoFieldConfig {
+    title?: string;
+    description?: string;
+}
+type SeoFieldKeys = 'title' | 'description' | 'canonicalUrl' | 'metaImage' | 'keywords' | 'metaAttributes' | 'robots';
+type openGraphFieldKeys = 'openGraphUrl' | 'openGraphTitle' | 'openGraphDescription' | 'openGraphSiteName' | 'openGraphType' | 'openGraphImageType' | 'openGraphImage' | 'openGraphImageUrl';
+type twitterFieldKeys = 'twitterCard' | 'twitterSite' | 'twitterCreator' | 'twitterTitle' | 'twitterDescription' | 'twitterImageType' | 'twitterImage' | 'twitterImageUrl';
+type AllFieldKeys = SeoFieldKeys | openGraphFieldKeys | twitterFieldKeys;
+type ValidHiddenFieldKeys = Exclude<AllFieldKeys, 'openGraphImageUrl' | 'twitterImageUrl' | 'openGraphImageType' | 'twitterImageType'>;
+interface FieldVisibilityConfig {
+    hiddenFields?: ValidHiddenFieldKeys[];
+}
+interface SeoFieldsPluginConfig {
+    /**
+     * Enable or configure the SEO preview feature.
+     * If set to `true`, the SEO preview will be enabled with default settings.
+     * If set to an object, you can provide a custom prefix function to modify the URL prefix in the preview.
+     * The prefix function receives the current document as an argument and should return a string.
+     * Example:
+     * ```
+     * seoPreview: {
+     *   prefix: (doc) => `/${doc.slug?.current || 'untitled'}`
+     * }
+     * ```
+     */
+    seoPreview?: boolean | {
+        prefix?: (doc: {
+            _type?: string;
+        } & Record<string, unknown>) => string;
+    };
+    /**
+     * A mapping of field keys to their configuration settings.
+     * This allows customization of field titles and descriptions.
+     * For example, to change the title of the 'title' field:
+     */
+    fieldOverrides?: Partial<Record<AllFieldKeys, SeoFieldConfig>>;
+    /**
+     * A mapping of document types to field visibility configurations.
+     * This allows you to specify which fields should be hidden for specific document types.
+     */
+    fieldVisibility?: Record<string, FieldVisibilityConfig>;
+    /**
+     * A list of fields that should be hidden by default in all document types.
+     * This can be overridden by specific document type settings in `fieldVisibility`.
+     */
+    defaultHiddenFields?: ValidHiddenFieldKeys[];
+    /**
+     * The base URL of your website, used for generating full URLs in the SEO preview.
+     * Defaults to 'https://www.example.com' if not provided.
+     */
+    baseUrl?: string;
+    /**
+     * Enable or configure the SEO Health Dashboard tool.
+     * If set to `true`, the dashboard is enabled with all defaults.
+     * If set to an object, you can customise the tool and dashboard settings.
+     * Defaults to `true`.
+     * Example:
+     * ```
+     * healthDashboard: {
+     *   toolTitle: 'SEO Overview',  // Studio nav tab label
+     *   content: {
+     *     icon: '🔍',               // Emoji icon shown before the page heading
+     *     title: 'My SEO Dashboard',// Page heading inside the tool (no emoji)
+     *     description: 'Track SEO across all documents', // Subtitle under the heading
+     *   },
+     *   display: {
+     *     typeColumn: false,        // Hide the document type column (default: true)
+     *     documentId: false,        // Hide the document ID under titles (default: true)
+     *   },
+     *   query: {
+     *     // Option 1 – filter by specific document types
+     *     types: ['post', 'page'],
+     *     // Option 2 – provide a full custom GROQ query (takes precedence over `types`)
+     *     // Must return documents with at least: _id, _type, title, seo, _updatedAt
+     *     groq: `*[seo != null && defined(slug.current)]{ _id, _type, title, slug, seo, _updatedAt }`,
+     *   },
+     * }
+     * ```
+     */
+    healthDashboard?: boolean | {
+        tool?: {
+            title?: string;
+            name?: string;
+        };
+        toolTitle?: string;
+        content?: {
+            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;
+            documentId?: boolean;
+        };
+        query?: {
+            /**
+             * Limit the dashboard to specific document types.
+             * Example: `['post', 'page']`
+             */
+            types?: string[];
+            /**
+             * When using `types`, also require the `seo` field to be non-null.
+             * Set to `false` to include documents of those types even if `seo` is missing.
+             * Defaults to `true`.
+             */
+            requireSeo?: boolean;
+            /**
+             * Provide a fully custom GROQ query. Takes precedence over `types`.
+             * The query must return documents with at least: _id, _type, title, seo, _updatedAt
+             */
+            groq?: string;
+        };
+        /**
+         * The Sanity API version to use for the client (e.g. '2023-01-01').
+         * Defaults to '2023-01-01'.
+         */
+        apiVersion?: string;
+        /**
+         * License key for the SEO Health Dashboard pro feature.
+         * 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;
+        /**
+         * The `name` of the Sanity structure tool that contains the monitored documents.
+         * Required when you have multiple structure tools and the documents live in a
+         * non-default one. Clicking a title will navigate to
+         * `/{basePath}/{structureTool}/intent/edit/…` directly.
+         *
+         * @example
+         * structureTool: 'common'
+         */
+        structureTool?: string;
+        /**
+         * 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;
+    };
+}
+declare const seofields: sanity.Plugin<void | SeoFieldsPluginConfig>;
+
+declare function seoFieldsSchema(config?: SeoFieldsPluginConfig): SchemaTypeDefinition;
+
+declare function types(config?: SeoFieldsPluginConfig): SchemaTypeDefinition[];
+
+declare const _default$2: {
+    type: "object";
+    name: "metaAttribute";
+} & Omit<sanity.ObjectDefinition, "preview"> & {
+    preview?: sanity.PreviewConfig<{
+        attributeName: string;
+        attributeValueString: string;
+        attributeValueImage: string;
+    }, Record<"attributeName" | "attributeValueString" | "attributeValueImage", any>> | undefined;
+};
+
+declare const _default$1: {
+    type: "object";
+    name: "metaTag";
+} & Omit<sanity.ObjectDefinition, "preview"> & {
+    preview?: sanity.PreviewConfig<Record<string, string>, Record<never, any>> | undefined;
+};
+
+declare function openGraph(config?: SeoFieldsPluginConfig): SchemaTypeDefinition;
+
+declare const _default: {
+    type: "object";
+    name: "robots";
+} & Omit<sanity.ObjectDefinition, "preview"> & {
+    preview?: sanity.PreviewConfig<Record<string, string>, Record<never, any>> | undefined;
+};
+
+declare function twitter(config?: SeoFieldsPluginConfig): SchemaTypeDefinition;
+
+interface SeoHealthDashboardProps {
+    icon?: string;
+    title?: string;
+    description?: string;
+    showTypeColumn?: boolean;
+    showDocumentId?: boolean;
+    /**
+     * Limit the dashboard to specific document type names.
+     * If both queryTypes and customQuery are provided, customQuery takes precedence.
+     */
+    queryTypes?: string[];
+    /**
+     * When using `queryTypes`, also filter by `seo != null`.
+     * Set to `false` to include documents of those types even without an seo field.
+     * Defaults to `true`.
+     */
+    queryRequireSeo?: boolean;
+    /**
+     * A fully custom GROQ query used to fetch documents.
+     * Must return objects with at least: _id, _type, title, seo, _updatedAt
+     * Takes precedence over queryTypes.
+     */
+    customQuery?: string;
+    /**
+     * The Sanity API version to use for the client (e.g. '2023-01-01').
+     * Defaults to '2023-01-01'.
+     */
+    apiVersion?: string;
+    /**
+     * License key for the SEO Health Dashboard.
+     * 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.ReactNode;
+    /**
+     * Custom text shown while documents are being fetched.
+     * Defaults to `"Loading documents…"`.
+     */
+    loadingDocuments?: React.ReactNode;
+    /**
+     * Custom text shown when the query returns zero results.
+     * Defaults to `"No documents found"`.
+     */
+    noDocuments?: React.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;
+    /**
+     * When `true`, clicking a document title opens the document editor as a split
+     * pane to the right, keeping the SEO Health pane visible on the left.
+     * This uses Sanity's pane router and requires the component to be rendered
+     * inside a desk-structure pane context (i.e. via `createSeoHealthPane`).
+     *
+     * When `false` (default), clicking navigates to the document via the standard
+     * intent-link system (full navigation).
+     *
+     * This is set to `true` automatically by `createSeoHealthPane`.
+     */
+    openInPane?: boolean;
+    /**
+     * The `name` of the Sanity structure tool that contains the monitored documents.
+     * When provided, clicking a document title navigates directly to that tool's
+     * intent URL (`/{basePath}/{structureTool}/intent/edit/id=…;type=…/`) instead of
+     * using the generic intent resolver, which always picks the first registered tool.
+     *
+     * Required when you have multiple structure tools and the documents live in a
+     * non-default one (e.g. `name: 'common'`).
+     *
+     * @example
+     * structureTool: 'common'
+     */
+    structureTool?: string;
+}
+declare const SeoHealthDashboard: React.FC<SeoHealthDashboardProps>;
+
+/**
+ * Sanity Tool component for the SEO Health Dashboard
+ * This component wraps the SeoHealthDashboard for use as a custom tool in Sanity Studio
+ */
+declare const SeoHealthTool: (props: SeoHealthDashboardProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Options accepted by `createSeoHealthPane`.
+ * All props from `SeoHealthDashboardProps` are supported.
+ *
+ * `licenseKey` is **required** — the dashboard will not render without it.
+ */
+interface SeoHealthPaneOptions extends Omit<SeoHealthDashboardProps, 'customQuery'> {
+    /** Required license key (format: `SEOF-XXXX-XXXX-XXXX`). */
+    licenseKey: string;
+    /**
+     * A fully custom GROQ query used to fetch documents for the dashboard.
+     * The query must return documents with at least: `_id`, `_type`, `title`, `seo`, `_updatedAt`.
+     *
+     * Takes precedence over `queryTypes` when both are provided.
+     *
+     * @example
+     * query: `*[_type in ["post","page"] && defined(seo)]{ _id, _type, title, slug, seo, _updatedAt }`
+     */
+    query?: string;
+}
+/**
+ * Creates a desk-structure pane for the SEO Health Dashboard.
+ *
+ * Returns a **`ComponentBuilder`** with a built-in `.child()` resolver so that
+ * clicking any document row opens the document editor as a split pane to the right.
+ *
+ * Use it **directly** as the `.child()` value — do **not** wrap it in `S.component()`.
+ *
+ * ```ts
+ * // sanity.config.ts
+ * structure: (S) =>
+ *   S.list().items([
+ *     S.listItem()
+ *       .title('SEO Health')
+ *       .child(
+ *         createSeoHealthPane(S, {
+ *           licenseKey: 'SEOF-XXXX-XXXX-XXXX',
+ *           query: `*[_type == "post" && defined(seo)]{ _id, _type, title, slug, seo, _updatedAt }`,
+ *         })
+ *       ),
+ *   ])
+ * ```
+ */
+declare function createSeoHealthPane(optionsOrS: StructureBuilder, optionsWhenS: SeoHealthPaneOptions): ComponentBuilder;
+
+export { type AllFieldKeys, DocumentWithSeoHealth, type FieldVisibilityConfig, type SeoFieldConfig, type SeoFieldKeys, type SeoFieldsPluginConfig, SeoHealthDashboard, type SeoHealthPaneOptions, SeoHealthTool, type ValidHiddenFieldKeys, types as allSchemas, createSeoHealthPane, seofields as default, _default$2 as metaAttributeSchema, _default$1 as metaTagSchema, type openGraphFieldKeys, openGraph as openGraphSchema, _default as robotsSchema, seoFieldsSchema, type twitterFieldKeys, twitter as twitterSchema };