npm - sanity-plugin-seofields - Versions diffs - 1.2.4 → 1.2.6 - Mend

sanity-plugin-seofields 1.2.4 → 1.2.6

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.

Files changed (49) hide show

package/dist/index.cjs +2604 -0
package/dist/index.cjs.map +1 -0
package/dist/index.d.cts +422 -0
package/dist/index.d.ts +339 -492
package/dist/index.js +1284 -2013
package/dist/index.js.map +1 -1
package/dist/next.cjs +182 -0
package/dist/next.cjs.map +1 -0
package/dist/next.d.cts +241 -0
package/dist/next.d.ts +202 -295
package/dist/next.js +110 -70
package/dist/next.js.map +1 -1
package/dist/types-B91ena4g.d.cts +89 -0
package/dist/types-B91ena4g.d.ts +89 -0
package/package.json +37 -18
package/dist/index.d.mts +0 -575
package/dist/index.mjs +0 -3292
package/dist/index.mjs.map +0 -1
package/dist/next.d.mts +0 -334
package/dist/next.mjs +0 -102
package/dist/next.mjs.map +0 -1
package/sanity.json +0 -8
package/src/components/SeoHealthDashboard.tsx +0 -1568
package/src/components/SeoHealthPane.tsx +0 -81
package/src/components/SeoHealthTool.tsx +0 -11
package/src/components/SeoPreview.tsx +0 -178
package/src/components/meta/MetaDescription.tsx +0 -39
package/src/components/meta/MetaTitle.tsx +0 -44
package/src/components/openGraph/OgDescription.tsx +0 -46
package/src/components/openGraph/OgTitle.tsx +0 -45
package/src/components/twitter/twitterDescription.tsx +0 -45
package/src/components/twitter/twitterTitle.tsx +0 -45
package/src/helpers/SeoMetaTags.tsx +0 -154
package/src/helpers/seoMeta.ts +0 -283
package/src/index.ts +0 -26
package/src/next.ts +0 -12
package/src/plugin.ts +0 -344
package/src/schemas/index.ts +0 -121
package/src/schemas/types/index.ts +0 -20
package/src/schemas/types/metaAttribute/index.ts +0 -60
package/src/schemas/types/metaTag/index.ts +0 -17
package/src/schemas/types/openGraph/index.ts +0 -114
package/src/schemas/types/robots/index.ts +0 -26
package/src/schemas/types/twitter/index.ts +0 -108
package/src/types.ts +0 -108
package/src/utils/fieldsUtils.ts +0 -160
package/src/utils/seoUtils.ts +0 -423
package/src/utils/utils.ts +0 -9
package/v2-incompatible.js +0 -11

package/dist/next.d.ts CHANGED Viewed

@@ -1,5 +1,175 @@
-import {default as React_2} from 'react'
+import { b as SanityImage, c as SanityImageWithAlt, d as SeoFields } from './types-B91ena4g.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+/**
+ * Headless CMS integration helpers for sanity-plugin-seofields
+ *
+ * Provides framework-agnostic SEO metadata utilities for use with:
+ * - Next.js App Router  → buildSeoMeta() inside generateMetadata()
+ * - Next.js Pages Router → <SeoMetaTags> inside Next.js <Head>
+ * - Nuxt / Remix / any SSR → <SeoMetaTags> inside your <head> slot
+ */
+/** Structured metadata returned by buildSeoMeta(). Compatible with Next.js Metadata (App Router). */
+interface SeoMetadata {
+    title?: string | null;
+    description?: string | null;
+    keywords?: string[];
+    robots?: {
+        index?: boolean;
+        follow?: boolean;
+        googleBot?: {
+            index?: boolean;
+            follow?: boolean;
+        };
+    };
+    openGraph?: {
+        type?: string;
+        url?: string;
+        title?: string;
+        description?: string;
+        siteName?: string;
+        images?: Array<{
+            url: string;
+            width?: number;
+            height?: number;
+            alt?: string;
+        }>;
+    };
+    twitter?: {
+        card?: string;
+        site?: string;
+        creator?: string;
+        title?: string;
+        description?: string;
+        images?: string[];
+    };
+    alternates?: {
+        canonical?: string;
+    };
+    /** Any custom meta attributes from seo.metaAttributes */
+    other?: Record<string, string>;
+}
+/** Default values used when SEO fields are missing. */
+interface SeoMetaDefaults {
+    title?: string;
+    description?: string;
+    siteName?: string;
+    twitterSite?: string;
+    twitterCreator?: string;
+    /** Fallback image URL when no OG / Twitter image is set. */
+    ogImage?: string;
+}
+/**
+ * Permissive image shape accepted by buildSeoMeta — compatible with both the
+ * plugin's SanityImage and Sanity's code-generated image type (where `asset`
+ * and `alt` are optional).
+ */
+interface SeoImageInput {
+    _type?: string;
+    asset?: {
+        _ref: string;
+        _type: string;
+        _weak?: boolean;
+        [key: string]: unknown;
+    };
+    hotspot?: unknown;
+    crop?: unknown;
+    alt?: string;
+}
+/**
+ * Input-compatible variant of SeoFields. Structurally matches Sanity's
+ * code-generated types (where `asset`, `alt`, `key`, and `type` are all
+ * optional), so you can pass `data.seo` from a sanityFetch result directly
+ * without any `as any` or manual casting.
+ */
+interface SeoFieldsInput {
+    _type?: string;
+    robots?: {
+        noIndex?: boolean | null;
+        noFollow?: boolean | null;
+    } | null;
+    title?: string | null;
+    description?: string | null;
+    metaImage?: SeoImageInput | null;
+    metaAttributes?: Array<{
+        _key?: string;
+        key?: string;
+        value?: string;
+        type?: string;
+    }> | null;
+    keywords?: string[] | null;
+    canonicalUrl?: string | null;
+    openGraph?: {
+        _type?: string;
+        url?: string | null;
+        title?: string | null;
+        description?: string | null;
+        siteName?: string | null;
+        type?: string | null;
+        imageType?: string | null;
+        image?: SeoImageInput | null;
+        imageUrl?: string | null;
+    } | null;
+    twitter?: {
+        _type?: string;
+        card?: string | null;
+        site?: string | null;
+        creator?: string | null;
+        title?: string | null;
+        description?: string | null;
+        imageType?: string | null;
+        image?: SeoImageInput | null;
+        imageUrl?: string | null;
+    } | null;
+}
+/** Options accepted by buildSeoMeta(). */
+interface BuildSeoMetaOptions {
+    /**
+     * The raw SEO object from Sanity (_type excluded or included — both work).
+     * Pass `null` or `undefined` to fall back entirely to `defaults`.
+     *
+     * Accepts both the strict plugin `SeoFields` type and Sanity's code-generated
+     * type (which has all nested fields optional) without any `as any` cast.
+     */
+    seo?: SeoFieldsInput | null;
+    /**
+     * The base URL of your site, e.g. "https://example.com".
+     * Used for canonical URL and OpenGraph URL construction.
+     */
+    baseUrl?: string;
+    /**
+     * The path for the current page, e.g. "/about".
+     * Combined with baseUrl to produce the canonical + OG url.
+     * Defaults to "".
+     */
+    path?: string;
+    /**
+     * Default values used when the Sanity SEO fields are empty / missing.
+     */
+    defaults?: SeoMetaDefaults;
+    /**
+     * Resolve a Sanity image asset to a plain URL string.
+     *
+     * @example (using @sanity/image-url)
+     * imageUrlResolver: (img) => urlFor(img).width(1200).url()
+     */
+    imageUrlResolver?: (image: SanityImage | SanityImageWithAlt) => string | null | undefined;
+}
+declare const VALID_OG_TYPES: readonly ["website", "article", "profile", "book", "music", "video", "product"];
+type OGType = (typeof VALID_OG_TYPES)[number];
+/**
+ * Coerce an arbitrary string to a valid OpenGraph type.
+ * Falls back to "website" when the value is invalid.
+ */
+declare function sanitizeOGType(value?: string): OGType;
+declare const VALID_TWITTER_CARDS: readonly ["summary", "summary_large_image", "app", "player"];
+type TwitterCard = (typeof VALID_TWITTER_CARDS)[number];
+/**
+ * Coerce an arbitrary string to a valid Twitter card type.
+ * Falls back to "summary_large_image" when the value is invalid.
+ */
+declare function sanitizeTwitterCard(value?: string): TwitterCard;
 /**
  * Convert a Sanity SEO object into a structured metadata object.
  *
@@ -23,238 +193,36 @@ import {default as React_2} from 'react'
  * }
  * ```
  */
-export declare function buildSeoMeta(options: BuildSeoMetaOptions): SeoMetadata
-/** Options accepted by buildSeoMeta(). */
-export declare interface BuildSeoMetaOptions {
-  /**
-   * The raw SEO object from Sanity (_type excluded or included — both work).
-   * Pass `null` or `undefined` to fall back entirely to `defaults`.
-   *
-   * Accepts both the strict plugin `SeoFields` type and Sanity's code-generated
-   * type (which has all nested fields optional) without any `as any` cast.
-   */
-  seo?: SeoFieldsInput | null
-  /**
-   * The base URL of your site, e.g. "https://example.com".
-   * Used for canonical URL and OpenGraph URL construction.
-   */
-  baseUrl?: string
-  /**
-   * The path for the current page, e.g. "/about".
-   * Combined with baseUrl to produce the canonical + OG url.
-   * Defaults to "".
-   */
-  path?: string
-  /**
-   * Default values used when the Sanity SEO fields are empty / missing.
-   */
-  defaults?: SeoMetaDefaults
-  /**
-   * Resolve a Sanity image asset to a plain URL string.
-   *
-   * @example (using @sanity/image-url)
-   * imageUrlResolver: (img) => urlFor(img).width(1200).url()
-   */
-  imageUrlResolver?: (image: SanityImage | SanityImageWithAlt) => string | null | undefined
+declare function buildSeoMeta(options: BuildSeoMetaOptions): SeoMetadata;
+interface SeoMetaTagsProps {
+    /**
+     * The raw SEO object from Sanity.
+     * Pass `null` / `undefined` to render only the defaults.
+     */
+    data?: Partial<SeoFields> | null;
+    /**
+     * Base URL of your site, e.g. "https://example.com".
+     * Used for canonical link, og:url fallback.
+     */
+    baseUrl?: string;
+    /**
+     * Current page path, e.g. "/about".
+     * Defaults to "".
+     */
+    path?: string;
+    /**
+     * Default values used when SEO fields are missing.
+     */
+    defaults?: BuildSeoMetaOptions['defaults'];
+    /**
+     * Resolve a Sanity image asset reference to a full URL string.
+     *
+     * @example
+     * imageUrlResolver={(img) => urlFor(img).width(1200).url()}
+     */
+    imageUrlResolver?: (image: SanityImage | SanityImageWithAlt) => string | null | undefined;
 }
-declare interface MetaAttribute {
-  _type: 'metaAttribute'
-  key?: string
-  type?: 'string' | 'image'
-  value?: string
-  image?: SanityImage
-}
-declare type OGType = (typeof VALID_OG_TYPES)[number]
-declare interface OpenGraphSettings {
-  _type: 'openGraph'
-  /** The canonical URL for OpenGraph (og:url). Maps to the `url` field in Sanity. */
-  url?: string
-  title?: string
-  description?: string
-  siteName?: string
-  type?: 'website' | 'article' | 'profile' | 'book' | 'music' | 'video' | 'product'
-  imageType?: 'upload' | 'url'
-  image?: SanityImageWithAlt
-  imageUrl?: string
-}
-declare interface RobotsSettings {
-  noIndex?: boolean
-  noFollow?: boolean
-}
-/**
- * Coerce an arbitrary string to a valid OpenGraph type.
- * Falls back to "website" when the value is invalid.
- */
-export declare function sanitizeOGType(value?: string): OGType
-/**
- * Coerce an arbitrary string to a valid Twitter card type.
- * Falls back to "summary_large_image" when the value is invalid.
- */
-export declare function sanitizeTwitterCard(value?: string): TwitterCard
-declare interface SanityImage {
-  _type: 'image'
-  asset: {
-    _ref: string
-    _type: 'reference'
-  }
-  hotspot?: {
-    x: number
-    y: number
-    height: number
-    width: number
-  }
-  crop?: {
-    top: number
-    bottom: number
-    left: number
-    right: number
-  }
-  alt?: string
-}
-declare interface SanityImageWithAlt extends SanityImage {
-  alt: string
-}
-declare interface SeoFields {
-  _type: 'seoFields'
-  robots?: RobotsSettings
-  preview?: string
-  title?: string
-  description?: string
-  metaImage?: SanityImage
-  metaAttributes?: MetaAttribute[]
-  keywords?: string[]
-  canonicalUrl?: string
-  openGraph?: OpenGraphSettings
-  twitter?: TwitterCardSettings
-}
-/**
- * Input-compatible variant of SeoFields. Structurally matches Sanity's
- * code-generated types (where `asset`, `alt`, `key`, and `type` are all
- * optional), so you can pass `data.seo` from a sanityFetch result directly
- * without any `as any` or manual casting.
- */
-declare interface SeoFieldsInput {
-  _type?: string
-  robots?: {
-    noIndex?: boolean | null
-    noFollow?: boolean | null
-  } | null
-  title?: string | null
-  description?: string | null
-  metaImage?: SeoImageInput | null
-  metaAttributes?: Array<{
-    _key?: string
-    key?: string
-    value?: string
-    type?: string
-  }> | null
-  keywords?: string[] | null
-  canonicalUrl?: string | null
-  openGraph?: {
-    _type?: string
-    url?: string | null
-    title?: string | null
-    description?: string | null
-    siteName?: string | null
-    type?: string | null
-    imageType?: string | null
-    image?: SeoImageInput | null
-    imageUrl?: string | null
-  } | null
-  twitter?: {
-    _type?: string
-    card?: string | null
-    site?: string | null
-    creator?: string | null
-    title?: string | null
-    description?: string | null
-    imageType?: string | null
-    image?: SeoImageInput | null
-    imageUrl?: string | null
-  } | null
-}
-/**
- * Permissive image shape accepted by buildSeoMeta — compatible with both the
- * plugin's SanityImage and Sanity's code-generated image type (where `asset`
- * and `alt` are optional).
- */
-declare interface SeoImageInput {
-  _type?: string
-  asset?: {
-    _ref: string
-    _type: string
-    _weak?: boolean
-    [key: string]: unknown
-  }
-  hotspot?: unknown
-  crop?: unknown
-  alt?: string
-}
-/** Structured metadata returned by buildSeoMeta(). Compatible with Next.js Metadata (App Router). */
-export declare interface SeoMetadata {
-  title?: string | null
-  description?: string | null
-  keywords?: string[]
-  robots?: {
-    index?: boolean
-    follow?: boolean
-    googleBot?: {
-      index?: boolean
-      follow?: boolean
-    }
-  }
-  openGraph?: {
-    type?: string
-    url?: string
-    title?: string
-    description?: string
-    siteName?: string
-    images?: Array<{
-      url: string
-      width?: number
-      height?: number
-      alt?: string
-    }>
-  }
-  twitter?: {
-    card?: string
-    site?: string
-    creator?: string
-    title?: string
-    description?: string
-    images?: string[]
-  }
-  alternates?: {
-    canonical?: string
-  }
-  /** Any custom meta attributes from seo.metaAttributes */
-  other?: Record<string, string>
-}
-/** Default values used when SEO fields are missing. */
-export declare interface SeoMetaDefaults {
-  title?: string
-  description?: string
-  siteName?: string
-  twitterSite?: string
-  twitterCreator?: string
-  /** Fallback image URL when no OG / Twitter image is set. */
-  ogImage?: string
-}
 /**
  * Renders all SEO meta tags for a page as plain React elements.
  * Intended to be placed inside your framework's <Head> / <head> component.
@@ -268,67 +236,6 @@ export declare interface SeoMetaDefaults {
  * - Twitter Card meta tags (`twitter:*`)
  * - Any custom `seo.metaAttributes` as `<meta name="..." content="...">`
  */
-export declare function SeoMetaTags({
-  data,
-  baseUrl,
-  path,
-  defaults,
-  imageUrlResolver,
-}: SeoMetaTagsProps): React_2.JSX.Element
-export declare interface SeoMetaTagsProps {
-  /**
-   * The raw SEO object from Sanity.
-   * Pass `null` / `undefined` to render only the defaults.
-   */
-  data?: Partial<SeoFields> | null
-  /**
-   * Base URL of your site, e.g. "https://example.com".
-   * Used for canonical link, og:url fallback.
-   */
-  baseUrl?: string
-  /**
-   * Current page path, e.g. "/about".
-   * Defaults to "".
-   */
-  path?: string
-  /**
-   * Default values used when SEO fields are missing.
-   */
-  defaults?: BuildSeoMetaOptions['defaults']
-  /**
-   * Resolve a Sanity image asset reference to a full URL string.
-   *
-   * @example
-   * imageUrlResolver={(img) => urlFor(img).width(1200).url()}
-   */
-  imageUrlResolver?: (image: SanityImage | SanityImageWithAlt) => string | null | undefined
-}
-declare type TwitterCard = (typeof VALID_TWITTER_CARDS)[number]
-declare interface TwitterCardSettings {
-  _type: 'twitter'
-  card?: 'summary' | 'summary_large_image' | 'app' | 'player'
-  site?: string
-  creator?: string
-  title?: string
-  description?: string
-  imageType?: 'upload' | 'url'
-  image?: SanityImageWithAlt
-  imageUrl?: string
-}
-declare const VALID_OG_TYPES: readonly [
-  'website',
-  'article',
-  'profile',
-  'book',
-  'music',
-  'video',
-  'product',
-]
-declare const VALID_TWITTER_CARDS: readonly ['summary', 'summary_large_image', 'app', 'player']
+declare function SeoMetaTags({ data, baseUrl, path, defaults, imageUrlResolver }: SeoMetaTagsProps): react_jsx_runtime.JSX.Element;
-export {}
+export { type BuildSeoMetaOptions, type SeoMetaDefaults, SeoMetaTags, type SeoMetaTagsProps, type SeoMetadata, buildSeoMeta, sanitizeOGType, sanitizeTwitterCard };