@masters-ws/react-seo 1.0.0 → 1.2.0

package/dist/index-CGVLxGDj.d.mts

@@ -0,0 +1,362 @@
+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;
+    ogType?: string;
+    ogLocale?: string;
+    twitterCard?: 'summary' | 'summary_large_image' | 'app' | 'player';
+    twitterTitle?: string;
+    twitterDescription?: string;
+    twitterImage?: 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;
+};
+
+/**
+ * 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
+ * import { toNextMetadata } from '@masters-ws/react-seo';
+ *
+ * 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;
+
+export { type BreadcrumbItem as B, type SiteConfig as S, type SEOData as a, generateBreadcrumbSchema as b, generateEventSchema as c, generateFAQSchema as d, generateLocalBusinessSchema as e, generateOrganizationSchema as f, generateArticleSchema as g, generatePaginatedTitle as h, generatePaginationLinks as i, generateProductSchema as j, generateVideoSchema as k, generateWebSiteSchema as l, toNextMetadata as t };

package/dist/index-CGVLxGDj.d.ts

@@ -0,0 +1,362 @@
+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;
+    ogType?: string;
+    ogLocale?: string;
+    twitterCard?: 'summary' | 'summary_large_image' | 'app' | 'player';
+    twitterTitle?: string;
+    twitterDescription?: string;
+    twitterImage?: 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;
+};
+
+/**
+ * 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
+ * import { toNextMetadata } from '@masters-ws/react-seo';
+ *
+ * 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;
+
+export { type BreadcrumbItem as B, type SiteConfig as S, type SEOData as a, generateBreadcrumbSchema as b, generateEventSchema as c, generateFAQSchema as d, generateLocalBusinessSchema as e, generateOrganizationSchema as f, generateArticleSchema as g, generatePaginatedTitle as h, generatePaginationLinks as i, generateProductSchema as j, generateVideoSchema as k, generateWebSiteSchema as l, toNextMetadata as t };