@businessflow/reviews 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,141 @@
+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;
+}
+
+export type { Review, ReviewApiResponse, ReviewFetchConfig, ReviewFieldConfig, ReviewFormConfig, ReviewFormData, ReviewHandlerConfig, ReviewSubmissionConfig, StarRatingProps, TestimonialDisplayConfig, ValidationErrors, ValidationRule };

package/dist/types/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/types/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["// Generic review/testimonial data\nexport interface Review {\n  id: string | number;\n  reviewerName: string;\n  reviewerEmail?: string;\n  reviewerTitle?: string;\n  reviewerCompany?: string;\n  reviewerAvatar?: string;\n  rating: number; // 1-5 stars\n  content?: string;\n  createdAt: string | Date;\n  updatedAt?: string | Date;\n  featured?: boolean;\n  approved?: boolean;\n  metadata?: Record<string, any>;\n}\n\n// Form data for submitting a new review\nexport interface ReviewFormData {\n  reviewerName: string;\n  reviewerEmail: string;\n  reviewerTitle?: string;\n  reviewerCompany?: string;\n  rating: number;\n  content?: string;\n  [key: string]: any; // Allow additional fields\n}\n\n// Generic API response for review operations\nexport interface ReviewApiResponse {\n  success: boolean;\n  message?: string;\n  reviewId?: string | number;\n  status?: 'pending' | 'approved' | 'rejected';\n  data?: any;\n}\n\n// Configuration for review submission\nexport interface ReviewSubmissionConfig {\n  endpoint: string;\n  method?: 'POST' | 'PUT';\n  headers?: Record<string, string>;\n  maxRetries?: number;\n  timeout?: number; // in milliseconds\n  transformRequest?: (data: ReviewFormData) => any;\n  transformResponse?: (response: any) => ReviewApiResponse;\n  onSuccess?: (response: ReviewApiResponse) => void;\n  onError?: (error: Error) => void;\n}\n\n// Configuration for fetching reviews\nexport interface ReviewFetchConfig {\n  endpoint: string;\n  method?: 'GET';\n  headers?: Record<string, string>;\n  maxRetries?: number;\n  timeout?: number; // in milliseconds\n  params?: {\n    limit?: number;\n    offset?: number;\n    featured?: boolean;\n    minRating?: number;\n    sortBy?: 'date' | 'rating' | 'name';\n    sortOrder?: 'asc' | 'desc';\n  };\n  transformResponse?: (response: any) => Review[];\n  onError?: (error: Error) => void;\n}\n\n// Form field configuration for reviews\nexport interface ReviewFieldConfig {\n  show?: boolean;\n  required?: boolean;\n  label?: string;\n  type?: string;\n  placeholder?: string;\n  validation?: ValidationRule[];\n}\n\n// Review form configuration\nexport interface ReviewFormConfig {\n  fields?: {\n    reviewerName?: ReviewFieldConfig;\n    reviewerEmail?: ReviewFieldConfig;\n    reviewerTitle?: ReviewFieldConfig;\n    reviewerCompany?: ReviewFieldConfig;\n    rating?: ReviewFieldConfig;\n    content?: ReviewFieldConfig;\n    [key: string]: ReviewFieldConfig | undefined;\n  };\n  recaptcha?: {\n    siteKey: string;\n    action?: string;\n  };\n  styling?: {\n    className?: string;\n    fieldClassName?: string;\n    buttonClassName?: string;\n    errorClassName?: string;\n    starClassName?: string;\n  };\n}\n\n// Display configuration for testimonials\nexport interface TestimonialDisplayConfig {\n  limit?: number;\n  showRating?: boolean;\n  showDate?: boolean;\n  showAvatar?: boolean;\n  showCompany?: boolean;\n  showTitle?: boolean;\n  layout?: 'grid' | 'list' | 'slider';\n  columns?: number;\n  autoRefresh?: boolean;\n  refreshInterval?: number; // in milliseconds\n  styling?: {\n    containerClassName?: string;\n    cardClassName?: string;\n    headerClassName?: string;\n    contentClassName?: string;\n    ratingClassName?: string;\n  };\n}\n\n// Validation\nexport interface ValidationRule {\n  type: 'required' | 'email' | 'minLength' | 'maxLength' | 'pattern' | 'custom' | 'rating';\n  value?: string | number;\n  message?: string;\n  validator?: (value: any) => boolean | string;\n}\n\nexport interface ValidationErrors {\n  [field: string]: string;\n}\n\n// Server-side handler configuration\nexport interface ReviewHandlerConfig {\n  // User-provided functions\n  onFetch?: (params?: any) => Promise<Review[]>;\n  onSubmit?: (data: ReviewFormData) => Promise<ReviewApiResponse>;\n  \n  // Optional reCAPTCHA verification\n  recaptcha?: {\n    secretKey: string;\n    minimumScore?: number;\n  };\n  \n  // Optional validation\n  validation?: {\n    [field: string]: ValidationRule[];\n  };\n  \n  // Optional logging/monitoring\n  onSuccess?: (data: ReviewFormData, response: ReviewApiResponse) => Promise<void>;\n  onError?: (data: ReviewFormData, error: Error) => Promise<void>;\n  \n  // Optional rate limiting (user implements)\n  rateLimiter?: (request: Request) => Promise<boolean>;\n}\n\n// Star rating component props\nexport interface StarRatingProps {\n  rating: number;\n  maxRating?: number;\n  editable?: boolean;\n  onChange?: (rating: number) => void;\n  size?: 'small' | 'medium' | 'large';\n  className?: string;\n}"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/types/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "@businessflow/reviews",
+  "version": "1.0.0",
+  "description": "Generic review and testimonial management utilities with customizable display components",
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.esm.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "require": "./dist/client/index.js",
+      "import": "./dist/client/index.esm.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "require": "./dist/server/index.js",
+      "import": "./dist/server/index.esm.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "require": "./dist/react/index.js",
+      "import": "./dist/react/index.esm.js"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "test:ui": "vitest --ui",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "prepublishOnly": "npm run build && npm run typecheck"
+  },
+  "keywords": [
+    "reviews",
+    "testimonials",
+    "ratings",
+    "feedback",
+    "nextjs",
+    "react",
+    "typescript"
+  ],
+  "author": "BusinessFlow",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/businessflow/reviews.git"
+  },
+  "bugs": {
+    "url": "https://github.com/businessflow/reviews/issues"
+  },
+  "homepage": "https://github.com/businessflow/reviews#readme",
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0",
+    "next": ">=13.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "tslib": "^2.6.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "@types/react": "^18.2.42",
+    "@types/react-dom": "^18.2.17",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
+    "@vitest/ui": "^1.0.4",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "next": "^15.0.0",
+    "prettier": "^3.1.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.2",
+    "vitest": "^1.0.4"
+  }
+}