@foxpixel/react 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -405,4 +405,460 @@ interface UseContactCaptureReturn {
  */
 declare function useContactCapture(): UseContactCaptureReturn;
 
-export { type ApiError$1 as ApiError, AuthProvider, type CreateLeadRequest, type EndUser, type EndUserLoginRequest, type FoxPixelConfig, FoxPixelHttpClient, FoxPixelProvider, GuestOnlyRoute, type Lead, ProtectedRoute, type Service, type ServiceCatalogResponse, useAuth, useContactCapture, useFoxPixelContext, useLeadCapture, useServices, withAuth };
+/**
+ * Blog module types for FoxPixel SDK
+ * Aligned with backend BlogPostResponse, BlogCategoryResponse, BlogTagResponse
+ */
+interface BlogAuthor {
+    id: string;
+    name: string;
+    email?: string;
+}
+interface BlogCategory {
+    id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    color?: string;
+    sortOrder?: number;
+}
+interface BlogTag {
+    id: string;
+    name: string;
+    slug: string;
+}
+type BlogPostStatus = 'DRAFT' | 'SCHEDULED' | 'PUBLISHED' | 'ARCHIVED';
+interface BlogPost {
+    id: string;
+    title: string;
+    slug: string;
+    excerpt: string | null;
+    content: string;
+    coverImageUrl: string | null;
+    metaTitle: string | null;
+    metaDescription: string | null;
+    canonicalUrl: string | null;
+    ogTitle: string | null;
+    ogDescription: string | null;
+    ogImageUrl: string | null;
+    status: BlogPostStatus;
+    publishedAt: string | null;
+    scheduledAt: string | null;
+    readingTimeMinutes: number | null;
+    isFeatured: boolean;
+    allowComments: boolean;
+    authorId: string | null;
+    author?: BlogAuthor | null;
+    version: number;
+    isAiGenerated: boolean;
+    categories: BlogCategory[];
+    tags: BlogTag[];
+    createdAt: string;
+    updatedAt: string;
+}
+/** Spring Data Page response shape */
+interface BlogPostPage {
+    content: BlogPost[];
+    totalElements: number;
+    totalPages: number;
+    size: number;
+    number: number;
+    first: boolean;
+    last: boolean;
+    numberOfElements: number;
+    empty: boolean;
+}
+/** Blog comment (approved, for display) */
+interface BlogComment {
+    id: string;
+    postId: string;
+    postTitle?: string | null;
+    postSlug?: string | null;
+    parentId?: string | null;
+    authorName?: string | null;
+    content: string;
+    status: string;
+    createdAt: string;
+    replies?: BlogComment[];
+}
+/** Payload to create a comment (guest) */
+interface CreateBlogCommentPayload {
+    guestName?: string;
+    guestEmail?: string;
+    content: string;
+    parentId?: string;
+}
+type NewsletterFrequency = 'instant' | 'daily' | 'weekly' | 'monthly';
+type NewsletterStatus = 'ACTIVE' | 'UNSUBSCRIBED' | 'BOUNCED';
+interface NewsletterSubscriber {
+    id: string;
+    email: string;
+    name?: string | null;
+    frequency: NewsletterFrequency;
+    categories?: string[] | null;
+    status: NewsletterStatus;
+    source?: string | null;
+    confirmedAt?: string | null;
+    unsubscribedAt?: string | null;
+    createdAt: string;
+}
+interface SubscribeNewsletterPayload {
+    email: string;
+    name?: string;
+    frequency?: NewsletterFrequency;
+    categories?: string[];
+    source?: string;
+}
+interface NewsletterSubscriberPage {
+    content: NewsletterSubscriber[];
+    totalElements: number;
+    totalPages: number;
+    size: number;
+    number: number;
+    first: boolean;
+    last: boolean;
+    numberOfElements: number;
+    empty: boolean;
+}
+interface NewsletterStats {
+    activeSubscribers: number;
+}
+interface BlogSettings {
+    businessContext?: string | null;
+    defaultLanguage?: string | null;
+    automationEnabled?: boolean | null;
+    autoPublishAsDraft?: boolean | null;
+    siteUrl?: string | null;
+    organizationName?: string | null;
+    blogName?: string | null;
+}
+interface BlogAnalyticsSummary {
+    totalViews: number;
+    totalUniqueVisitors: number;
+    totalPosts: number;
+    publishedPosts: number;
+    draftPosts: number;
+    scheduledPosts: number;
+    topPosts?: Array<{
+        postId: string;
+        postTitle: string;
+        postSlug: string;
+        views: number;
+    }>;
+}
+interface PostAnalyticsRow {
+    postId: string;
+    postTitle: string;
+    postSlug: string;
+    date: string;
+    views: number;
+    uniqueVisitors: number;
+}
+
+/**
+ * Hooks for Blog module (public API - SDK / headless)
+ */
+
+interface UseBlogPostsOptions {
+    page?: number;
+    limit?: number;
+}
+interface UseBlogPostsReturn {
+    data: BlogPostPage | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Fetch published blog posts (paginated)
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading, error } = useBlogPosts({ page: 0, limit: 10 });
+ * data?.content.map(post => <PostCard key={post.id} post={post} />)
+ * ```
+ */
+declare function useBlogPosts(options?: UseBlogPostsOptions): UseBlogPostsReturn;
+interface UseBlogPostReturn {
+    data: BlogPost | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Fetch a single published blog post by slug
+ *
+ * @example
+ * ```tsx
+ * const { data: post, isLoading } = useBlogPost('my-post-slug');
+ * ```
+ */
+declare function useBlogPost(slug: string | undefined | null): UseBlogPostReturn;
+interface UseBlogCategoriesReturn {
+    data: BlogCategory[] | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Fetch blog categories (for filters / navigation)
+ */
+declare function useBlogCategories(): UseBlogCategoriesReturn;
+interface UseBlogTagsReturn {
+    data: BlogTag[] | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Fetch blog tags (for filters / display)
+ */
+declare function useBlogTags(): UseBlogTagsReturn;
+interface UseBlogCommentsReturn {
+    data: BlogComment[] | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Fetch approved comments for a published blog post (public API)
+ *
+ * @example
+ * ```tsx
+ * const { data: comments, refetch } = useBlogComments(post?.slug);
+ * ```
+ */
+declare function useBlogComments(slug: string | undefined | null): UseBlogCommentsReturn;
+interface UseBlogCommentSubmitReturn {
+    submit: (payload: CreateBlogCommentPayload) => Promise<BlogComment | null>;
+    isSubmitting: boolean;
+    error: ApiError$1 | null;
+    resetError: () => void;
+}
+/**
+ * Submit a comment on a published blog post (public API). Call refetch on comments after success.
+ *
+ * @example
+ * ```tsx
+ * const { submit, isSubmitting, error } = useBlogCommentSubmit(post?.slug);
+ * await submit({ guestName: 'João', guestEmail: 'j@x.com', content: 'Texto' });
+ * refetch(); // from useBlogComments
+ * ```
+ */
+declare function useBlogCommentSubmit(slug: string | undefined | null): UseBlogCommentSubmitReturn;
+interface UseBlogFeaturedPostsReturn {
+    data: BlogPostPage | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Fetch featured blog posts
+ */
+declare function useBlogFeaturedPosts(limit?: number): UseBlogFeaturedPostsReturn;
+interface UseNewsletterSubscribeReturn {
+    subscribe: (payload: SubscribeNewsletterPayload) => Promise<NewsletterSubscriber | null>;
+    isSubmitting: boolean;
+    error: ApiError$1 | null;
+    success: boolean;
+    reset: () => void;
+}
+/**
+ * Subscribe to newsletter (public API)
+ *
+ * @example
+ * ```tsx
+ * const { subscribe, isSubmitting, success, error } = useNewsletterSubscribe();
+ * await subscribe({ email: 'user@example.com', name: 'John' });
+ * ```
+ */
+declare function useNewsletterSubscribe(): UseNewsletterSubscribeReturn;
+interface UseNewsletterUnsubscribeReturn {
+    unsubscribe: (email: string) => Promise<boolean>;
+    isSubmitting: boolean;
+    error: ApiError$1 | null;
+    success: boolean;
+}
+/**
+ * Unsubscribe from newsletter (public API)
+ */
+declare function useNewsletterUnsubscribe(): UseNewsletterUnsubscribeReturn;
+
+/**
+ * Admin hooks for Blog module (tenant-admin dashboard)
+ * These hooks use the authenticated admin API endpoints
+ */
+
+interface CreateBlogPostPayload {
+    title: string;
+    slug?: string;
+    excerpt?: string;
+    content: string;
+    coverImageUrl?: string;
+    metaTitle?: string;
+    metaDescription?: string;
+    canonicalUrl?: string;
+    ogTitle?: string;
+    ogDescription?: string;
+    ogImageUrl?: string;
+    status?: 'DRAFT' | 'SCHEDULED' | 'PUBLISHED';
+    scheduledAt?: string;
+    isFeatured?: boolean;
+    allowComments?: boolean;
+    categoryIds?: string[];
+    tagIds?: string[];
+    isAiGenerated?: boolean;
+    aiGenerationMetadata?: Record<string, unknown>;
+    businessContextSnapshot?: string;
+}
+interface UpdateBlogPostPayload extends Partial<CreateBlogPostPayload> {
+    changeReason?: string;
+}
+interface UseAdminBlogPostsOptions {
+    page?: number;
+    size?: number;
+}
+interface UseAdminBlogPostsReturn {
+    data: BlogPostPage | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+declare function useAdminBlogPosts(options?: UseAdminBlogPostsOptions): UseAdminBlogPostsReturn;
+interface UseAdminBlogPostReturn {
+    data: BlogPost | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+declare function useAdminBlogPost(id: string | undefined | null): UseAdminBlogPostReturn;
+interface UseAdminBlogPostMutationsReturn {
+    create: (payload: CreateBlogPostPayload) => Promise<BlogPost | null>;
+    update: (id: string, payload: UpdateBlogPostPayload) => Promise<BlogPost | null>;
+    remove: (id: string) => Promise<boolean>;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+}
+declare function useAdminBlogPostMutations(): UseAdminBlogPostMutationsReturn;
+interface CreateCategoryPayload {
+    name: string;
+    slug?: string;
+    description?: string;
+    color?: string;
+    parentId?: string;
+    sortOrder?: number;
+}
+interface UseAdminBlogCategoriesReturn {
+    data: BlogCategory[] | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+    create: (payload: CreateCategoryPayload) => Promise<BlogCategory | null>;
+    update: (id: string, payload: Partial<CreateCategoryPayload>) => Promise<BlogCategory | null>;
+    remove: (id: string) => Promise<boolean>;
+}
+declare function useAdminBlogCategories(): UseAdminBlogCategoriesReturn;
+interface CreateTagPayload {
+    name: string;
+    slug?: string;
+}
+interface UseAdminBlogTagsReturn {
+    data: BlogTag[] | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+    create: (payload: CreateTagPayload) => Promise<BlogTag | null>;
+    update: (id: string, payload: Partial<CreateTagPayload>) => Promise<BlogTag | null>;
+    remove: (id: string) => Promise<boolean>;
+}
+declare function useAdminBlogTags(): UseAdminBlogTagsReturn;
+interface UseAdminBlogCommentsOptions {
+    status?: string;
+    postId?: string;
+    page?: number;
+    size?: number;
+}
+interface BlogCommentAdmin extends BlogComment {
+    postTitle?: string;
+    postSlug?: string;
+    authorEmail?: string;
+}
+interface BlogCommentPage {
+    content: BlogCommentAdmin[];
+    totalElements: number;
+    totalPages: number;
+    size: number;
+    number: number;
+    first: boolean;
+    last: boolean;
+    empty: boolean;
+}
+interface UseAdminBlogCommentsReturn {
+    data: BlogCommentPage | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+    updateStatus: (id: string, status: 'APPROVED' | 'REJECTED' | 'SPAM') => Promise<boolean>;
+    remove: (id: string) => Promise<boolean>;
+}
+declare function useAdminBlogComments(options?: UseAdminBlogCommentsOptions): UseAdminBlogCommentsReturn;
+interface UseAdminNewsletterSubscribersOptions {
+    status?: string;
+    page?: number;
+    size?: number;
+}
+interface UseAdminNewsletterSubscribersReturn {
+    data: NewsletterSubscriberPage | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+    remove: (id: string) => Promise<boolean>;
+}
+declare function useAdminNewsletterSubscribers(options?: UseAdminNewsletterSubscribersOptions): UseAdminNewsletterSubscribersReturn;
+interface UseAdminNewsletterStatsReturn {
+    data: NewsletterStats | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+declare function useAdminNewsletterStats(): UseAdminNewsletterStatsReturn;
+interface UseAdminBlogSettingsReturn {
+    data: BlogSettings | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+    update: (settings: Partial<BlogSettings>) => Promise<BlogSettings | null>;
+}
+declare function useAdminBlogSettings(): UseAdminBlogSettingsReturn;
+interface UseAdminBlogAnalyticsReturn {
+    data: BlogAnalyticsSummary | null;
+    isLoading: boolean;
+    error: ApiError$1 | null;
+    refetch: () => Promise<void>;
+}
+declare function useAdminBlogAnalytics(): UseAdminBlogAnalyticsReturn;
+
+/**
+ * Blog utilities - Schema.org JSON-LD for SEO
+ */
+
+interface BlogPostSchemaLdOptions {
+    /** Full URL of the site (e.g. https://example.com) */
+    siteUrl: string;
+    /** Organization name for publisher */
+    publisherName?: string;
+    /** Logo URL for publisher */
+    publisherLogoUrl?: string;
+}
+/**
+ * Build Schema.org BlogPosting JSON-LD for a blog post
+ *
+ * @example
+ * ```tsx
+ * const schemaLd = getBlogPostSchemaLd(post, { siteUrl: 'https://example.com', publisherName: 'My Site' });
+ * <script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify(schemaLd) }} />
+ * ```
+ */
+declare function getBlogPostSchemaLd(post: BlogPost, options: BlogPostSchemaLdOptions): Record<string, unknown>;
+
+export { type ApiError$1 as ApiError, AuthProvider, type BlogAnalyticsSummary, type BlogAuthor, type BlogCategory, type BlogComment, type BlogCommentAdmin, type BlogCommentPage, type BlogPost, type BlogPostPage, type BlogPostSchemaLdOptions, type BlogPostStatus, type BlogSettings, type BlogTag, type CreateBlogCommentPayload, type CreateBlogPostPayload, type CreateCategoryPayload, type CreateLeadRequest, type CreateTagPayload, type EndUser, type EndUserLoginRequest, type FoxPixelConfig, FoxPixelHttpClient, FoxPixelProvider, GuestOnlyRoute, type Lead, type NewsletterFrequency, type NewsletterStats, type NewsletterStatus, type NewsletterSubscriber, type NewsletterSubscriberPage, type PostAnalyticsRow, ProtectedRoute, type Service, type ServiceCatalogResponse, type SubscribeNewsletterPayload, type UpdateBlogPostPayload, type UseAdminBlogAnalyticsReturn, type UseAdminBlogCategoriesReturn, type UseAdminBlogCommentsOptions, type UseAdminBlogCommentsReturn, type UseAdminBlogPostMutationsReturn, type UseAdminBlogPostReturn, type UseAdminBlogPostsOptions, type UseAdminBlogPostsReturn, type UseAdminBlogSettingsReturn, type UseAdminBlogTagsReturn, type UseAdminNewsletterStatsReturn, type UseAdminNewsletterSubscribersOptions, type UseAdminNewsletterSubscribersReturn, type UseBlogCategoriesReturn, type UseBlogCommentSubmitReturn, type UseBlogCommentsReturn, type UseBlogFeaturedPostsReturn, type UseBlogPostReturn, type UseBlogPostsOptions, type UseBlogPostsReturn, type UseBlogTagsReturn, type UseNewsletterSubscribeReturn, type UseNewsletterUnsubscribeReturn, getBlogPostSchemaLd, useAdminBlogAnalytics, useAdminBlogCategories, useAdminBlogComments, useAdminBlogPost, useAdminBlogPostMutations, useAdminBlogPosts, useAdminBlogSettings, useAdminBlogTags, useAdminNewsletterStats, useAdminNewsletterSubscribers, useAuth, useBlogCategories, useBlogCommentSubmit, useBlogComments, useBlogFeaturedPosts, useBlogPost, useBlogPosts, useBlogTags, useContactCapture, useFoxPixelContext, useLeadCapture, useNewsletterSubscribe, useNewsletterUnsubscribe, useServices, withAuth };