@businessflow/reviews 2.1.4 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,141 +0,0 @@
1
- interface Review {
2
- id: string | number;
3
- reviewerName: string;
4
- reviewerEmail?: string;
5
- reviewerTitle?: string;
6
- reviewerCompany?: string;
7
- reviewerAvatar?: string;
8
- rating: number;
9
- content?: string;
10
- createdAt: string | Date;
11
- updatedAt?: string | Date;
12
- featured?: boolean;
13
- approved?: boolean;
14
- metadata?: Record<string, any>;
15
- }
16
- interface ReviewFormData {
17
- reviewerName: string;
18
- reviewerEmail: string;
19
- reviewerTitle?: string;
20
- reviewerCompany?: string;
21
- rating: number;
22
- content?: string;
23
- [key: string]: any;
24
- }
25
- interface ReviewApiResponse {
26
- success: boolean;
27
- message?: string;
28
- reviewId?: string | number;
29
- status?: 'pending' | 'approved' | 'rejected';
30
- data?: any;
31
- }
32
- interface ReviewSubmissionConfig {
33
- endpoint: string;
34
- method?: 'POST' | 'PUT';
35
- headers?: Record<string, string>;
36
- maxRetries?: number;
37
- timeout?: number;
38
- transformRequest?: (data: ReviewFormData) => any;
39
- transformResponse?: (response: any) => ReviewApiResponse;
40
- onSuccess?: (response: ReviewApiResponse) => void;
41
- onError?: (error: Error) => void;
42
- }
43
- interface ReviewFetchConfig {
44
- endpoint: string;
45
- method?: 'GET';
46
- headers?: Record<string, string>;
47
- maxRetries?: number;
48
- timeout?: number;
49
- params?: {
50
- limit?: number;
51
- offset?: number;
52
- featured?: boolean;
53
- minRating?: number;
54
- sortBy?: 'date' | 'rating' | 'name';
55
- sortOrder?: 'asc' | 'desc';
56
- };
57
- transformResponse?: (response: any) => Review[];
58
- onError?: (error: Error) => void;
59
- }
60
- interface ReviewFieldConfig {
61
- show?: boolean;
62
- required?: boolean;
63
- label?: string;
64
- type?: string;
65
- placeholder?: string;
66
- validation?: ValidationRule[];
67
- }
68
- interface ReviewFormConfig {
69
- fields?: {
70
- reviewerName?: ReviewFieldConfig;
71
- reviewerEmail?: ReviewFieldConfig;
72
- reviewerTitle?: ReviewFieldConfig;
73
- reviewerCompany?: ReviewFieldConfig;
74
- rating?: ReviewFieldConfig;
75
- content?: ReviewFieldConfig;
76
- [key: string]: ReviewFieldConfig | undefined;
77
- };
78
- recaptcha?: {
79
- siteKey: string;
80
- action?: string;
81
- };
82
- styling?: {
83
- className?: string;
84
- fieldClassName?: string;
85
- buttonClassName?: string;
86
- errorClassName?: string;
87
- starClassName?: string;
88
- };
89
- }
90
- interface TestimonialDisplayConfig {
91
- limit?: number;
92
- showRating?: boolean;
93
- showDate?: boolean;
94
- showAvatar?: boolean;
95
- showCompany?: boolean;
96
- showTitle?: boolean;
97
- layout?: 'grid' | 'list' | 'slider';
98
- columns?: number;
99
- autoRefresh?: boolean;
100
- refreshInterval?: number;
101
- styling?: {
102
- containerClassName?: string;
103
- cardClassName?: string;
104
- headerClassName?: string;
105
- contentClassName?: string;
106
- ratingClassName?: string;
107
- };
108
- }
109
- interface ValidationRule {
110
- type: 'required' | 'email' | 'minLength' | 'maxLength' | 'pattern' | 'custom' | 'rating';
111
- value?: string | number;
112
- message?: string;
113
- validator?: (value: any) => boolean | string;
114
- }
115
- interface ValidationErrors {
116
- [field: string]: string;
117
- }
118
- interface ReviewHandlerConfig {
119
- onFetch?: (params?: any) => Promise<Review[]>;
120
- onSubmit?: (data: ReviewFormData) => Promise<ReviewApiResponse>;
121
- recaptcha?: {
122
- secretKey: string;
123
- minimumScore?: number;
124
- };
125
- validation?: {
126
- [field: string]: ValidationRule[];
127
- };
128
- onSuccess?: (data: ReviewFormData, response: ReviewApiResponse) => Promise<void>;
129
- onError?: (data: ReviewFormData, error: Error) => Promise<void>;
130
- rateLimiter?: (request: Request) => Promise<boolean>;
131
- }
132
- interface StarRatingProps {
133
- rating: number;
134
- maxRating?: number;
135
- editable?: boolean;
136
- onChange?: (rating: number) => void;
137
- size?: 'small' | 'medium' | 'large';
138
- className?: string;
139
- }
140
-
141
- export type { Review, ReviewApiResponse, ReviewFetchConfig, ReviewFieldConfig, ReviewFormConfig, ReviewFormData, ReviewHandlerConfig, ReviewSubmissionConfig, StarRatingProps, TestimonialDisplayConfig, ValidationErrors, ValidationRule };
@@ -1,141 +0,0 @@
1
- interface Review {
2
- id: string | number;
3
- reviewerName: string;
4
- reviewerEmail?: string;
5
- reviewerTitle?: string;
6
- reviewerCompany?: string;
7
- reviewerAvatar?: string;
8
- rating: number;
9
- content?: string;
10
- createdAt: string | Date;
11
- updatedAt?: string | Date;
12
- featured?: boolean;
13
- approved?: boolean;
14
- metadata?: Record<string, any>;
15
- }
16
- interface ReviewFormData {
17
- reviewerName: string;
18
- reviewerEmail: string;
19
- reviewerTitle?: string;
20
- reviewerCompany?: string;
21
- rating: number;
22
- content?: string;
23
- [key: string]: any;
24
- }
25
- interface ReviewApiResponse {
26
- success: boolean;
27
- message?: string;
28
- reviewId?: string | number;
29
- status?: 'pending' | 'approved' | 'rejected';
30
- data?: any;
31
- }
32
- interface ReviewSubmissionConfig {
33
- endpoint: string;
34
- method?: 'POST' | 'PUT';
35
- headers?: Record<string, string>;
36
- maxRetries?: number;
37
- timeout?: number;
38
- transformRequest?: (data: ReviewFormData) => any;
39
- transformResponse?: (response: any) => ReviewApiResponse;
40
- onSuccess?: (response: ReviewApiResponse) => void;
41
- onError?: (error: Error) => void;
42
- }
43
- interface ReviewFetchConfig {
44
- endpoint: string;
45
- method?: 'GET';
46
- headers?: Record<string, string>;
47
- maxRetries?: number;
48
- timeout?: number;
49
- params?: {
50
- limit?: number;
51
- offset?: number;
52
- featured?: boolean;
53
- minRating?: number;
54
- sortBy?: 'date' | 'rating' | 'name';
55
- sortOrder?: 'asc' | 'desc';
56
- };
57
- transformResponse?: (response: any) => Review[];
58
- onError?: (error: Error) => void;
59
- }
60
- interface ReviewFieldConfig {
61
- show?: boolean;
62
- required?: boolean;
63
- label?: string;
64
- type?: string;
65
- placeholder?: string;
66
- validation?: ValidationRule[];
67
- }
68
- interface ReviewFormConfig {
69
- fields?: {
70
- reviewerName?: ReviewFieldConfig;
71
- reviewerEmail?: ReviewFieldConfig;
72
- reviewerTitle?: ReviewFieldConfig;
73
- reviewerCompany?: ReviewFieldConfig;
74
- rating?: ReviewFieldConfig;
75
- content?: ReviewFieldConfig;
76
- [key: string]: ReviewFieldConfig | undefined;
77
- };
78
- recaptcha?: {
79
- siteKey: string;
80
- action?: string;
81
- };
82
- styling?: {
83
- className?: string;
84
- fieldClassName?: string;
85
- buttonClassName?: string;
86
- errorClassName?: string;
87
- starClassName?: string;
88
- };
89
- }
90
- interface TestimonialDisplayConfig {
91
- limit?: number;
92
- showRating?: boolean;
93
- showDate?: boolean;
94
- showAvatar?: boolean;
95
- showCompany?: boolean;
96
- showTitle?: boolean;
97
- layout?: 'grid' | 'list' | 'slider';
98
- columns?: number;
99
- autoRefresh?: boolean;
100
- refreshInterval?: number;
101
- styling?: {
102
- containerClassName?: string;
103
- cardClassName?: string;
104
- headerClassName?: string;
105
- contentClassName?: string;
106
- ratingClassName?: string;
107
- };
108
- }
109
- interface ValidationRule {
110
- type: 'required' | 'email' | 'minLength' | 'maxLength' | 'pattern' | 'custom' | 'rating';
111
- value?: string | number;
112
- message?: string;
113
- validator?: (value: any) => boolean | string;
114
- }
115
- interface ValidationErrors {
116
- [field: string]: string;
117
- }
118
- interface ReviewHandlerConfig {
119
- onFetch?: (params?: any) => Promise<Review[]>;
120
- onSubmit?: (data: ReviewFormData) => Promise<ReviewApiResponse>;
121
- recaptcha?: {
122
- secretKey: string;
123
- minimumScore?: number;
124
- };
125
- validation?: {
126
- [field: string]: ValidationRule[];
127
- };
128
- onSuccess?: (data: ReviewFormData, response: ReviewApiResponse) => Promise<void>;
129
- onError?: (data: ReviewFormData, error: Error) => Promise<void>;
130
- rateLimiter?: (request: Request) => Promise<boolean>;
131
- }
132
- interface StarRatingProps {
133
- rating: number;
134
- maxRating?: number;
135
- editable?: boolean;
136
- onChange?: (rating: number) => void;
137
- size?: 'small' | 'medium' | 'large';
138
- className?: string;
139
- }
140
-
141
- export type { Review, ReviewApiResponse, ReviewFetchConfig, ReviewFieldConfig, ReviewFormConfig, ReviewFormData, ReviewHandlerConfig, ReviewSubmissionConfig, StarRatingProps, TestimonialDisplayConfig, ValidationErrors, ValidationRule };