@businessflow/reviews 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,239 @@
+import { NextRequest, NextResponse } from 'next/server';
+import React from 'react';
+
+interface Review {
+    id: string | number;
+    reviewerName: string;
+    reviewerEmail?: string;
+    reviewerTitle?: string;
+    reviewerCompany?: string;
+    reviewerAvatar?: string;
+    rating: number;
+    content?: string;
+    createdAt: string | Date;
+    updatedAt?: string | Date;
+    featured?: boolean;
+    approved?: boolean;
+    metadata?: Record<string, any>;
+}
+interface ReviewFormData {
+    reviewerName: string;
+    reviewerEmail: string;
+    reviewerTitle?: string;
+    reviewerCompany?: string;
+    rating: number;
+    content?: string;
+    [key: string]: any;
+}
+interface ReviewApiResponse {
+    success: boolean;
+    message?: string;
+    reviewId?: string | number;
+    status?: 'pending' | 'approved' | 'rejected';
+    data?: any;
+}
+interface ReviewSubmissionConfig {
+    endpoint: string;
+    method?: 'POST' | 'PUT';
+    headers?: Record<string, string>;
+    maxRetries?: number;
+    timeout?: number;
+    transformRequest?: (data: ReviewFormData) => any;
+    transformResponse?: (response: any) => ReviewApiResponse;
+    onSuccess?: (response: ReviewApiResponse) => void;
+    onError?: (error: Error) => void;
+}
+interface ReviewFetchConfig {
+    endpoint: string;
+    method?: 'GET';
+    headers?: Record<string, string>;
+    maxRetries?: number;
+    timeout?: number;
+    params?: {
+        limit?: number;
+        offset?: number;
+        featured?: boolean;
+        minRating?: number;
+        sortBy?: 'date' | 'rating' | 'name';
+        sortOrder?: 'asc' | 'desc';
+    };
+    transformResponse?: (response: any) => Review[];
+    onError?: (error: Error) => void;
+}
+interface ReviewFieldConfig {
+    show?: boolean;
+    required?: boolean;
+    label?: string;
+    type?: string;
+    placeholder?: string;
+    validation?: ValidationRule[];
+}
+interface ReviewFormConfig {
+    fields?: {
+        reviewerName?: ReviewFieldConfig;
+        reviewerEmail?: ReviewFieldConfig;
+        reviewerTitle?: ReviewFieldConfig;
+        reviewerCompany?: ReviewFieldConfig;
+        rating?: ReviewFieldConfig;
+        content?: ReviewFieldConfig;
+        [key: string]: ReviewFieldConfig | undefined;
+    };
+    recaptcha?: {
+        siteKey: string;
+        action?: string;
+    };
+    styling?: {
+        className?: string;
+        fieldClassName?: string;
+        buttonClassName?: string;
+        errorClassName?: string;
+        starClassName?: string;
+    };
+}
+interface TestimonialDisplayConfig {
+    limit?: number;
+    showRating?: boolean;
+    showDate?: boolean;
+    showAvatar?: boolean;
+    showCompany?: boolean;
+    showTitle?: boolean;
+    layout?: 'grid' | 'list' | 'slider';
+    columns?: number;
+    autoRefresh?: boolean;
+    refreshInterval?: number;
+    styling?: {
+        containerClassName?: string;
+        cardClassName?: string;
+        headerClassName?: string;
+        contentClassName?: string;
+        ratingClassName?: string;
+    };
+}
+interface ValidationRule {
+    type: 'required' | 'email' | 'minLength' | 'maxLength' | 'pattern' | 'custom' | 'rating';
+    value?: string | number;
+    message?: string;
+    validator?: (value: any) => boolean | string;
+}
+interface ValidationErrors {
+    [field: string]: string;
+}
+interface ReviewHandlerConfig {
+    onFetch?: (params?: any) => Promise<Review[]>;
+    onSubmit?: (data: ReviewFormData) => Promise<ReviewApiResponse>;
+    recaptcha?: {
+        secretKey: string;
+        minimumScore?: number;
+    };
+    validation?: {
+        [field: string]: ValidationRule[];
+    };
+    onSuccess?: (data: ReviewFormData, response: ReviewApiResponse) => Promise<void>;
+    onError?: (data: ReviewFormData, error: Error) => Promise<void>;
+    rateLimiter?: (request: Request) => Promise<boolean>;
+}
+interface StarRatingProps {
+    rating: number;
+    maxRating?: number;
+    editable?: boolean;
+    onChange?: (rating: number) => void;
+    size?: 'small' | 'medium' | 'large';
+    className?: string;
+}
+
+/**
+ * Generic review client for fetching and submitting reviews
+ */
+declare class ReviewClient {
+    private fetchConfig?;
+    private submitConfig?;
+    private maxRetries;
+    private timeout;
+    constructor(config: {
+        fetchConfig?: ReviewFetchConfig;
+        submitConfig?: ReviewSubmissionConfig;
+        maxRetries?: number;
+        timeout?: number;
+    });
+    /**
+     * Fetch reviews with retry logic
+     */
+    fetchReviews(params?: {
+        limit?: number;
+        offset?: number;
+        featured?: boolean;
+        minRating?: number;
+    }, retryCount?: number): Promise<Review[]>;
+    /**
+     * Submit a review with retry logic
+     */
+    submitReview(reviewData: ReviewFormData, retryCount?: number): Promise<ReviewApiResponse>;
+    /**
+     * Update configuration
+     */
+    updateConfig(config: {
+        fetchConfig?: Partial<ReviewFetchConfig>;
+        submitConfig?: Partial<ReviewSubmissionConfig>;
+    }): void;
+}
+
+/**
+ * Combined handler that supports both GET (fetch) and POST (submit)
+ */
+declare function createReviewHandler(config: ReviewHandlerConfig): (request: NextRequest) => Promise<NextResponse>;
+
+/**
+ * Star rating component for displaying and selecting ratings
+ */
+declare const StarRating: React.FC<StarRatingProps>;
+
+interface TestimonialsSectionProps extends TestimonialDisplayConfig {
+    fetchConfig: ReviewFetchConfig;
+    className?: string;
+    renderTestimonial?: (testimonial: Review) => React.ReactNode;
+    renderLoading?: () => React.ReactNode;
+    renderError?: (error: string, canRetry: boolean, onRetry: () => void) => React.ReactNode;
+    renderEmpty?: () => React.ReactNode;
+}
+/**
+ * Generic testimonials display component
+ */
+declare const TestimonialsSection: React.FC<TestimonialsSectionProps>;
+
+interface UseReviewSubmissionConfig extends ReviewFormConfig {
+    endpoint?: string;
+    onSubmit?: (data: ReviewFormData) => Promise<ReviewApiResponse>;
+    onSuccess?: (response: ReviewApiResponse) => void;
+    onError?: (error: Error) => void;
+    maxRetries?: number;
+}
+
+interface ReviewFormProps extends UseReviewSubmissionConfig {
+    className?: string;
+    children?: React.ReactNode;
+    renderField?: (field: {
+        name: keyof ReviewFormData;
+        label: string;
+        value: any;
+        type: string;
+        required: boolean;
+        placeholder?: string;
+        error?: string;
+        onChange: (value: any) => void;
+    }) => React.ReactNode;
+    renderSubmitButton?: (props: {
+        isSubmitting: boolean;
+        isDisabled: boolean;
+        onClick: () => void;
+    }) => React.ReactNode;
+    renderSuccess?: (message: string) => React.ReactNode;
+    renderError?: (error: string, canRetry: boolean, onRetry: () => void) => React.ReactNode;
+}
+/**
+ * Generic review form component with customizable rendering
+ */
+declare const ReviewForm: React.FC<ReviewFormProps>;
+
+declare const version = "1.0.0";
+
+export { type Review, type ReviewApiResponse, ReviewClient, type ReviewFetchConfig, type ReviewFieldConfig, ReviewForm, type ReviewFormConfig, type ReviewFormData, type ReviewHandlerConfig, type ReviewSubmissionConfig, StarRating, type StarRatingProps, type TestimonialDisplayConfig, TestimonialsSection, type ValidationErrors, type ValidationRule, createReviewHandler, version };