@masters-ws/react-seo 1.2.1 → 1.4.1

package/dist/index-Wu9j5oCk.d.ts

@@ -0,0 +1,721 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface SiteConfig {
+    name: string;
+    description: string;
+    url: string;
+    logo?: string;
+    publisher?: string;
+    twitterHandle?: string;
+    facebookAppId?: string;
+    language?: string;
+    socialLinks?: string[];
+    googleAnalyticsId?: string;
+    gtmId?: string;
+    facebookPixelId?: string;
+    yandexMetricaId?: string;
+    themeColor?: string;
+    manifest?: string;
+}
+interface SEOData {
+    title?: string;
+    description?: string;
+    image?: string;
+    canonical?: string;
+    type?: 'website' | 'article' | 'product' | 'profile' | 'video' | 'faq';
+    robots?: string;
+    noindex?: boolean;
+    keywords?: string[];
+    prev?: string;
+    next?: string;
+    alternates?: Array<{
+        hreflang: string;
+        href: string;
+    }>;
+    ogTitle?: string;
+    ogDescription?: string;
+    ogImage?: string;
+    ogImageWidth?: number;
+    ogImageHeight?: number;
+    ogImageAlt?: string;
+    ogType?: string;
+    ogLocale?: string;
+    twitterCard?: 'summary' | 'summary_large_image' | 'app' | 'player';
+    twitterTitle?: string;
+    twitterDescription?: string;
+    twitterImage?: string;
+    twitterImageAlt?: string;
+    publishedTime?: string;
+    modifiedTime?: string;
+    author?: {
+        name: string;
+        url?: string;
+        image?: string;
+    };
+    tags?: string[];
+    section?: string;
+    readingTime?: number;
+    product?: {
+        sku?: string;
+        brand?: string;
+        price?: number;
+        currency?: string;
+        availability?: string;
+        rating?: number;
+        reviewCount?: number;
+    };
+    dnsPrefetch?: string[];
+    preconnect?: string[];
+    prefetch?: string[];
+    preload?: Array<{
+        href: string;
+        as: string;
+        type?: string;
+    }>;
+    whatsappImage?: string;
+    whatsappDescription?: string;
+    schema?: any;
+}
+interface BreadcrumbItem {
+    name: string;
+    item: string;
+}
+
+/**
+ * Generate Organization Schema
+ */
+declare function generateOrganizationSchema(config: SiteConfig): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    url: string;
+    logo: string | undefined;
+    sameAs: string[];
+};
+/**
+ * Generate WebSite Schema with SearchAction
+ */
+declare function generateWebSiteSchema(config: SiteConfig): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    url: string;
+    potentialAction: {
+        "@type": string;
+        target: string;
+        "query-input": string;
+    };
+};
+/**
+ * Generate NewsArticle Schema
+ */
+declare function generateArticleSchema(data: {
+    title: string;
+    description: string;
+    image?: string;
+    publishedTime?: string;
+    modifiedTime?: string;
+    author?: {
+        name: string;
+        url?: string;
+    };
+    url?: string;
+}, config: SiteConfig): {
+    "@context": string;
+    "@type": string;
+    headline: string;
+    description: string;
+    image: string | undefined;
+    datePublished: string | undefined;
+    dateModified: string | undefined;
+    mainEntityOfPage: string | undefined;
+    author: {
+        "@context": string;
+        "@type": string;
+        name: string;
+        url: string;
+        logo: string | undefined;
+        sameAs: string[];
+    } | {
+        "@type": string;
+        name: string;
+        url: string | undefined;
+    };
+    publisher: {
+        "@context": string;
+        "@type": string;
+        name: string;
+        url: string;
+        logo: string | undefined;
+        sameAs: string[];
+    };
+};
+/**
+ * Generate Product Schema
+ */
+declare function generateProductSchema(data: {
+    name: string;
+    description: string;
+    image?: string;
+    sku?: string;
+    brand?: string;
+    price?: number;
+    currency?: string;
+    availability?: string;
+    rating?: number;
+    reviewCount?: number;
+    url?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    image: string | undefined;
+    sku: string | undefined;
+    brand: {
+        "@type": string;
+        name: string;
+    } | undefined;
+    offers: {
+        "@type": string;
+        url: string | undefined;
+        priceCurrency: string;
+        price: number | undefined;
+        availability: string;
+    };
+    aggregateRating: {
+        "@type": string;
+        ratingValue: number;
+        reviewCount: number;
+    } | undefined;
+};
+/**
+ * Generate FAQ Schema
+ */
+declare function generateFAQSchema(questions: Array<{
+    q: string;
+    a: string;
+}>): {
+    "@context": string;
+    "@type": string;
+    mainEntity: {
+        "@type": string;
+        name: string;
+        acceptedAnswer: {
+            "@type": string;
+            text: string;
+        };
+    }[];
+};
+/**
+ * Generate Breadcrumb Schema
+ */
+declare function generateBreadcrumbSchema(items: Array<{
+    name: string;
+    item: string;
+}>): {
+    "@context": string;
+    "@type": string;
+    itemListElement: {
+        "@type": string;
+        position: number;
+        name: string;
+        item: string;
+    }[];
+};
+/**
+ * Generate Video Schema
+ */
+declare function generateVideoSchema(data: {
+    name: string;
+    description: string;
+    thumbnailUrl: string;
+    uploadDate: string;
+    duration?: string;
+    contentUrl?: string;
+    embedUrl?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    thumbnailUrl: string;
+    uploadDate: string;
+    duration: string | undefined;
+    contentUrl: string | undefined;
+    embedUrl: string | undefined;
+};
+/**
+ * Generate Event Schema
+ */
+declare function generateEventSchema(data: {
+    name: string;
+    description: string;
+    startDate: string;
+    endDate?: string;
+    location?: {
+        name: string;
+        address: string;
+    } | {
+        url: string;
+    };
+    image?: string;
+    offers?: {
+        price: number;
+        currency: string;
+        url: string;
+    };
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    startDate: string;
+    endDate: string | undefined;
+    eventAttendanceMode: string;
+    location: {
+        "@type": string;
+        url: string;
+        name?: undefined;
+        address?: undefined;
+    } | {
+        "@type": string;
+        name: string;
+        address: string;
+        url?: undefined;
+    } | undefined;
+    image: string | undefined;
+    offers: {
+        "@type": string;
+        price: number;
+        priceCurrency: string;
+        url: string;
+    } | undefined;
+};
+/**
+ * Generate LocalBusiness Schema
+ */
+declare function generateLocalBusinessSchema(data: {
+    name: string;
+    description: string;
+    image?: string;
+    telephone?: string;
+    address: {
+        street: string;
+        city: string;
+        region?: string;
+        postalCode?: string;
+        country: string;
+    };
+    geo?: {
+        lat: number;
+        lng: number;
+    };
+    openingHours?: string[];
+    priceRange?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    image: string | undefined;
+    telephone: string | undefined;
+    address: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string | undefined;
+        addressCountry: string;
+    };
+    geo: {
+        "@type": string;
+        latitude: number;
+        longitude: number;
+    } | undefined;
+    openingHours: string[] | undefined;
+    priceRange: string | undefined;
+};
+/**
+ * Generate SoftwareApplication Schema
+ */
+declare function generateSoftwareSchema(data: {
+    name: string;
+    description: string;
+    operatingSystem?: string;
+    applicationCategory?: string;
+    offers?: {
+        price: number;
+        currency: string;
+    };
+    rating?: number;
+    reviewCount?: number;
+    downloadUrl?: string;
+    screenshot?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    operatingSystem: string | undefined;
+    applicationCategory: string | undefined;
+    offers: {
+        "@type": string;
+        price: number;
+        priceCurrency: string;
+    } | undefined;
+    aggregateRating: {
+        "@type": string;
+        ratingValue: number;
+        reviewCount: number;
+    } | undefined;
+    downloadUrl: string | undefined;
+    screenshot: string | undefined;
+};
+/**
+ * Generate Book Schema
+ */
+declare function generateBookSchema(data: {
+    name: string;
+    author: string | {
+        name: string;
+        url?: string;
+    };
+    description: string;
+    isbn?: string;
+    numberOfPages?: number;
+    publisher?: string;
+    datePublished?: string;
+    image?: string;
+    inLanguage?: string;
+    genre?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    author: {
+        "@type": string;
+        name: string;
+        url?: undefined;
+    } | {
+        "@type": string;
+        name: string;
+        url: string | undefined;
+    };
+    description: string;
+    isbn: string | undefined;
+    numberOfPages: number | undefined;
+    publisher: {
+        "@type": string;
+        name: string;
+    } | undefined;
+    datePublished: string | undefined;
+    image: string | undefined;
+    inLanguage: string | undefined;
+    genre: string | undefined;
+};
+/**
+ * Generate Movie Schema
+ */
+declare function generateMovieSchema(data: {
+    name: string;
+    description: string;
+    image?: string;
+    director?: string;
+    actor?: string[];
+    dateCreated?: string;
+    duration?: string;
+    genre?: string[];
+    rating?: number;
+    reviewCount?: number;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    image: string | undefined;
+    director: {
+        "@type": string;
+        name: string;
+    } | undefined;
+    actor: {
+        "@type": string;
+        name: string;
+    }[] | undefined;
+    dateCreated: string | undefined;
+    duration: string | undefined;
+    genre: string[] | undefined;
+    aggregateRating: {
+        "@type": string;
+        ratingValue: number;
+        reviewCount: number;
+    } | undefined;
+};
+/**
+ * Generate Podcast Schema (PodcastSeries)
+ */
+declare function generatePodcastSchema(data: {
+    name: string;
+    description: string;
+    image?: string;
+    author?: string;
+    webFeed?: string;
+    url?: string;
+    genre?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    image: string | undefined;
+    author: {
+        "@type": string;
+        name: string;
+    } | undefined;
+    webFeed: string | undefined;
+    url: string | undefined;
+    genre: string | undefined;
+};
+/**
+ * Generate PodcastEpisode Schema
+ */
+declare function generatePodcastEpisodeSchema(data: {
+    name: string;
+    description: string;
+    datePublished: string;
+    duration?: string;
+    url?: string;
+    audio?: string;
+    partOfSeries?: {
+        name: string;
+        url: string;
+    };
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    datePublished: string;
+    timeRequired: string | undefined;
+    url: string | undefined;
+    associatedMedia: {
+        "@type": string;
+        contentUrl: string;
+    } | undefined;
+    partOfSeries: {
+        "@type": string;
+        name: string;
+        url: string;
+    } | undefined;
+};
+
+/**
+ * Converts SEOData and SiteConfig to a Next.js compatible Metadata object.
+ * This is designed to be used in Server Components (App Router).
+ *
+ * @example
+ * // In page.tsx (Server Component - no 'use client')
+ * import { toNextMetadata } from '@masters-ws/react-seo/core';
+ *
+ * export async function generateMetadata({ params }) {
+ *   const post = await getPost(params.id);
+ *   return toNextMetadata({ title: post.title, ... }, siteConfig);
+ * }
+ */
+declare function toNextMetadata(props: SEOData, config: SiteConfig): any;
+/**
+ * Generates pagination links for category/tag pages.
+ * Returns { prev, next, canonical } URLs.
+ */
+declare function generatePaginationLinks(baseUrl: string, currentPage: number, totalPages: number): {
+    next: string | undefined;
+    prev: string | undefined;
+    canonical: string;
+};
+/**
+ * Generates title with page number suffix for paginated pages.
+ */
+declare function generatePaginatedTitle(title: string, page: number, suffix?: string): string;
+
+/**
+ * Server-safe JSON-LD component for Next.js App Router.
+ * Renders schema markup as <script type="application/ld+json"> in server-rendered HTML.
+ *
+ * Unlike Helmet-based components, this works in Server Components,
+ * so Google sees the schemas on first crawl without JavaScript execution.
+ *
+ * @example
+ * // In a Server Component (page.tsx without 'use client')
+ * import { JsonLd, generateProductSchema } from '@masters-ws/react-seo/core';
+ *
+ * export default function ProductPage() {
+ *   const schema = generateProductSchema({ name: 'Product', ... });
+ *   return (
+ *     <>
+ *       <JsonLd schema={schema} />
+ *       <main>...</main>
+ *     </>
+ *   );
+ * }
+ *
+ * // Multiple schemas
+ * <JsonLd schema={[productSchema, breadcrumbSchema, orgSchema]} />
+ */
+interface JsonLdProps {
+    /** A single schema object or an array of schema objects */
+    schema: Record<string, any> | Record<string, any>[];
+}
+declare function JsonLd({ schema }: JsonLdProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Product metadata input for convenience helper
+ */
+interface ProductMetadataInput {
+    name: string;
+    description: string;
+    image?: string;
+    images?: string[];
+    sku?: string;
+    brand?: string;
+    price?: number;
+    currency?: string;
+    availability?: string;
+    rating?: number;
+    reviewCount?: number;
+    url: string;
+    metaTitle?: string;
+    metaDescription?: string;
+    canonical?: string;
+    noindex?: boolean;
+    breadcrumbs?: Array<{
+        name: string;
+        item: string;
+    }>;
+    category?: string;
+    ogImage?: string;
+    ogImageWidth?: number;
+    ogImageHeight?: number;
+}
+/**
+ * Result from generateProductMetadata
+ */
+interface ProductMetadataResult {
+    /** Next.js Metadata object - use as return from generateMetadata() */
+    metadata: any;
+    /** All JSON-LD schemas for the product page */
+    schemas: Record<string, any>[];
+    /** Individual schemas for granular control */
+    productSchema: Record<string, any>;
+    breadcrumbSchema: Record<string, any>;
+    organizationSchema: Record<string, any>;
+    websiteSchema: Record<string, any>;
+}
+/**
+ * All-in-one helper for product pages in Next.js App Router.
+ * Generates both the Metadata object AND all JSON-LD schemas in one call.
+ *
+ * @example
+ * ```tsx
+ * // app/products/[slug]/page.tsx (Server Component)
+ * import { generateProductMetadata, JsonLd } from '@masters-ws/react-seo/core';
+ *
+ * const siteConfig = { name: 'My Store', url: 'https://store.com', ... };
+ *
+ * export async function generateMetadata({ params }) {
+ *   const product = await fetchProduct(params.slug);
+ *   const { metadata } = generateProductMetadata(product, siteConfig);
+ *   return metadata;
+ * }
+ *
+ * export default async function ProductPage({ params }) {
+ *   const product = await fetchProduct(params.slug);
+ *   const { schemas } = generateProductMetadata(product, siteConfig);
+ *
+ *   return (
+ *     <>
+ *       <JsonLd schema={schemas} />
+ *       <ProductDetailClient product={product} />
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function generateProductMetadata(product: ProductMetadataInput, config: SiteConfig): ProductMetadataResult;
+
+/**
+ * Article metadata input for convenience helper
+ */
+interface ArticleMetadataInput {
+    title: string;
+    description: string;
+    image?: string;
+    publishedTime: string;
+    modifiedTime?: string;
+    author?: {
+        name: string;
+        url?: string;
+        image?: string;
+    };
+    url: string;
+    category?: string;
+    tags?: string[];
+    readingTime?: number;
+    metaTitle?: string;
+    metaDescription?: string;
+    canonical?: string;
+    noindex?: boolean;
+    breadcrumbs?: Array<{
+        name: string;
+        item: string;
+    }>;
+    ogImage?: string;
+    ogImageWidth?: number;
+    ogImageHeight?: number;
+}
+/**
+ * Result from generateArticleMetadata
+ */
+interface ArticleMetadataResult {
+    /** Next.js Metadata object - use as return from generateMetadata() */
+    metadata: any;
+    /** All JSON-LD schemas for the article page */
+    schemas: Record<string, any>[];
+    /** Individual schemas for granular control */
+    articleSchema: Record<string, any>;
+    breadcrumbSchema: Record<string, any>;
+    organizationSchema: Record<string, any>;
+    websiteSchema: Record<string, any>;
+}
+/**
+ * All-in-one helper for article pages in Next.js App Router.
+ * Generates both the Metadata object AND all JSON-LD schemas in one call.
+ *
+ * @example
+ * ```tsx
+ * // app/news/[slug]/page.tsx (Server Component)
+ * import { generateArticleMetadata, JsonLd } from '@masters-ws/react-seo/core';
+ *
+ * const siteConfig = { name: 'My Site', url: 'https://mysite.com', ... };
+ *
+ * export async function generateMetadata({ params }) {
+ *   const article = await fetchArticle(params.slug);
+ *   const { metadata } = generateArticleMetadata(article, siteConfig);
+ *   return metadata;
+ * }
+ *
+ * export default async function ArticlePage({ params }) {
+ *   const article = await fetchArticle(params.slug);
+ *   const { schemas } = generateArticleMetadata(article, siteConfig);
+ *
+ *   return (
+ *     <>
+ *       <JsonLd schema={schemas} />
+ *       <article>...</article>
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function generateArticleMetadata(article: ArticleMetadataInput, config: SiteConfig): ArticleMetadataResult;
+
+export { type ArticleMetadataInput as A, type BreadcrumbItem as B, JsonLd as J, type ProductMetadataInput as P, type SiteConfig as S, type SEOData as a, type ArticleMetadataResult as b, type JsonLdProps as c, type ProductMetadataResult as d, generateArticleSchema as e, generateBookSchema as f, generateArticleMetadata as g, generateBreadcrumbSchema as h, generateEventSchema as i, generateFAQSchema as j, generateLocalBusinessSchema as k, generateMovieSchema as l, generateOrganizationSchema as m, generatePaginatedTitle as n, generatePaginationLinks as o, generatePodcastEpisodeSchema as p, generatePodcastSchema as q, generateProductMetadata as r, generateProductSchema as s, generateSoftwareSchema as t, generateVideoSchema as u, generateWebSiteSchema as v, toNextMetadata as w };