@masters-ws/react-seo 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,351 @@
+import React from 'react';
+
+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;
+}
+
+interface SEOProviderProps {
+    config: SiteConfig;
+    children: React.ReactNode;
+    helmetContext?: {};
+}
+declare const SEOProvider: React.FC<SEOProviderProps>;
+declare const useSEOConfig: () => SiteConfig;
+
+interface SEOProps extends SEOData {
+    children?: React.ReactNode;
+}
+declare const SEO: React.FC<SEOProps>;
+
+interface BreadcrumbProps {
+    items: BreadcrumbItem[];
+    className?: string;
+    separator?: React.ReactNode;
+    renderLink?: (item: BreadcrumbItem, isLast: boolean) => React.ReactNode;
+}
+declare const Breadcrumb: React.FC<BreadcrumbProps>;
+
+interface SeoArticleProps extends Omit<SEOProps, 'type'> {
+    article: {
+        title: string;
+        description: string;
+        image: string;
+        publishedAt: string;
+        updatedAt?: string;
+        author: {
+            name: string;
+            url?: string;
+        };
+        category?: string;
+        tags?: string[];
+    };
+}
+declare const SeoArticle: React.FC<SeoArticleProps>;
+
+interface SeoProductProps extends Omit<SEOProps, 'type' | 'product'> {
+    item: {
+        name: string;
+        description: string;
+        image: string;
+        sku?: string;
+        brand?: string;
+        price: number;
+        currency: string;
+        availability?: string;
+        rating?: number;
+        reviewCount?: number;
+    };
+}
+declare const SeoProduct: React.FC<SeoProductProps>;
+
+interface FAQItem {
+    question: string;
+    answer: string;
+}
+interface SeoFAQProps {
+    items: FAQItem[];
+}
+declare const SeoFAQ: React.FC<SeoFAQProps>;
+
+interface SeoVideoProps {
+    video: {
+        name: string;
+        description: string;
+        thumbnailUrl: string[] | string;
+        uploadDate: string;
+        contentUrl?: string;
+        embedUrl?: string;
+        duration?: string;
+        interactionStatistic?: {
+            viewCount?: number;
+        };
+    };
+}
+declare const SeoVideo: React.FC<SeoVideoProps>;
+
+interface SeoEventProps {
+    event: {
+        name: string;
+        description: string;
+        startDate: string;
+        endDate?: string;
+        eventStatus?: 'EventCancelled' | 'EventMovedOnline' | 'EventPostponed' | 'EventRescheduled' | 'EventScheduled';
+        eventAttendanceMode?: 'OfflineEventAttendanceMode' | 'OnlineEventAttendanceMode' | 'MixedEventAttendanceMode';
+        location: {
+            name: string;
+            address?: string;
+            url?: string;
+        };
+        image?: string[] | string;
+        offers?: {
+            price: number;
+            priceCurrency: string;
+            url?: string;
+            availability?: string;
+        };
+        organizer?: {
+            name: string;
+            url?: string;
+        };
+    };
+}
+declare const SeoEvent: React.FC<SeoEventProps>;
+
+interface SeoLocalBusinessProps {
+    business: {
+        type?: string;
+        name: string;
+        image?: string[] | string;
+        description?: string;
+        id?: string;
+        url?: string;
+        telephone?: string;
+        address: {
+            streetAddress: string;
+            addressLocality: string;
+            addressRegion?: string;
+            postalCode?: string;
+            addressCountry: string;
+        };
+        geo?: {
+            latitude: number;
+            longitude: number;
+        };
+        openingHours?: string[] | string;
+        priceRange?: string;
+    };
+}
+declare const SeoLocalBusiness: React.FC<SeoLocalBusinessProps>;
+
+interface SeoCategoryProps extends Omit<SEOProps, 'type'> {
+    category: {
+        name: string;
+        description: string;
+        image?: string;
+        url: string;
+    };
+    page?: number;
+    totalPage?: number;
+}
+declare const SeoCategory: React.FC<SeoCategoryProps>;
+
+interface SeoTagProps extends Omit<SEOProps, 'type'> {
+    tag: {
+        name: string;
+        description?: string;
+        url: string;
+    };
+    page?: number;
+    totalPage?: number;
+}
+declare const SeoTag: React.FC<SeoTagProps>;
+
+interface SeoAuthorProps extends Omit<SEOProps, 'type'> {
+    author: {
+        name: string;
+        description?: string;
+        image?: string;
+        url: string;
+        jobTitle?: string;
+    };
+    page?: number;
+    totalPage?: number;
+}
+declare const SeoAuthor: React.FC<SeoAuthorProps>;
+
+interface HowToStep {
+    name: string;
+    text: string;
+    image?: string;
+    url?: string;
+}
+interface SeoHowToProps {
+    name: string;
+    description?: string;
+    image?: string;
+    steps: HowToStep[] | string[];
+}
+declare const SeoHowTo: React.FC<SeoHowToProps>;
+
+interface SeoReviewProps {
+    itemReviewed: {
+        type: string;
+        name: string;
+        image?: string;
+    };
+    review: {
+        author: string;
+        datePublished?: string;
+        reviewBody: string;
+        ratingValue: number;
+        bestRating?: number;
+        worstRating?: number;
+    };
+}
+declare const SeoReview: React.FC<SeoReviewProps>;
+
+interface SeoCourseProps {
+    course: {
+        name: string;
+        description: string;
+        providerName: string;
+        providerUrl?: string;
+        image?: string;
+    };
+}
+declare const SeoCourse: React.FC<SeoCourseProps>;
+
+interface SeoRecipeProps {
+    recipe: {
+        name: string;
+        description: string;
+        image: string[] | string;
+        author: string;
+        publishedDate?: string;
+        prepTime?: string;
+        cookTime?: string;
+        totalTime?: string;
+        recipeYield?: string;
+        recipeCategory?: string;
+        recipeCuisine?: string;
+        ingredients: string[];
+        instructions: Array<{
+            name?: string;
+            text: string;
+            image?: string;
+        }>;
+    };
+}
+declare const SeoRecipe: React.FC<SeoRecipeProps>;
+
+interface SeoJobPostingProps {
+    job: {
+        title: string;
+        description: string;
+        datePosted: string;
+        validThrough?: string;
+        employmentType?: string | string[];
+        hiringOrganization: {
+            name: string;
+            sameAs?: string;
+            logo?: string;
+        };
+        jobLocation: {
+            streetAddress: string;
+            addressLocality: string;
+            addressRegion?: string;
+            postalCode?: string;
+            addressCountry: string;
+        };
+        baseSalary?: {
+            currency: string;
+            value: number | {
+                minValue: number;
+                maxValue: number;
+            };
+            unitText?: string;
+        };
+    };
+}
+declare const SeoJobPosting: React.FC<SeoJobPostingProps>;
+
+/**
+ * Converts SEOData and SiteConfig to a Next.js compatible Metadata object.
+ * This is designed to be used in Server Components (App Router).
+ */
+declare function toNextMetadata(props: SEOData, config: SiteConfig): any;
+
+export { Breadcrumb, type BreadcrumbItem, type BreadcrumbProps, type FAQItem, type HowToStep, SEO, type SEOData, type SEOProps, SEOProvider, type SEOProviderProps, SeoArticle, type SeoArticleProps, SeoAuthor, type SeoAuthorProps, SeoCategory, type SeoCategoryProps, SeoCourse, type SeoCourseProps, SeoEvent, type SeoEventProps, SeoFAQ, type SeoFAQProps, SeoHowTo, type SeoHowToProps, SeoJobPosting, type SeoJobPostingProps, SeoLocalBusiness, type SeoLocalBusinessProps, SeoProduct, type SeoProductProps, SeoRecipe, type SeoRecipeProps, SeoReview, type SeoReviewProps, SeoTag, type SeoTagProps, SeoVideo, type SeoVideoProps, type SiteConfig, toNextMetadata, useSEOConfig };