@businessflow/reviews 1.0.0 → 2.0.0

package/dist/server/index.d.mts

@@ -1,3 +1,4 @@
+import * as next_server from 'next/server';
 import { NextRequest, NextResponse } from 'next/server';
 
 interface Review {
@@ -186,4 +187,88 @@ declare function verifyRecaptcha(token: string, config: RecaptchaConfig): Promis
  */
 declare function getRecaptchaErrorMessage(errorCodes: string[]): string;
 
-export { type RecaptchaConfig, type RecaptchaVerificationResult, type Review, type ReviewApiResponse, type ReviewFetchConfig, type ReviewFieldConfig, type ReviewFormConfig, type ReviewFormData, type ReviewHandlerConfig, type ReviewSubmissionConfig, type StarRatingProps, type TestimonialDisplayConfig, type ValidationErrors, type ValidationRule, createCorsHeaders, createReviewFetchHandler, createReviewHandler, createReviewSubmitHandler, getRecaptchaErrorMessage, handleOptions, verifyRecaptcha };
+/**
+ * Configuration for BusinessFlow CRM review integration
+ */
+interface BusinessFlowReviewConfig {
+    /** BusinessFlow API base URL (e.g., https://api.businessflow.co.za) */
+    apiUrl: string;
+    /** BusinessFlow API key for authentication */
+    apiKey: string;
+    /** Source URL for review attribution (optional, will use NEXT_PUBLIC_SITE_URL if not provided) */
+    sourceUrl?: string;
+    /** reCAPTCHA secret key for server-side verification (optional) */
+    recaptchaSecret?: string;
+    /** Minimum reCAPTCHA score for v3 (optional, defaults to 0.5) */
+    minimumScore?: number;
+    /** Custom success callback after review is submitted to BusinessFlow */
+    onSuccess?: (data: ReviewFormData, response: ReviewApiResponse) => Promise<void>;
+    /** Custom error callback if submission fails */
+    onError?: (data: ReviewFormData, error: Error) => Promise<void>;
+}
+/**
+ * Create a NextJS API route handler that submits reviews to BusinessFlow CRM
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/submit/route.ts
+ * import { createBusinessFlowReviewHandler } from '@businessflow/reviews/server';
+ *
+ * export const POST = createBusinessFlowReviewHandler({
+ *   apiUrl: process.env.BUSINESS_FLOW_API_URL!,
+ *   apiKey: process.env.BUSINESS_FLOW_API_KEY!,
+ *   sourceUrl: process.env.SITE_URL!,
+ *   recaptchaSecret: process.env.RECAPTCHA_SECRET_KEY!,
+ * });
+ * ```
+ */
+declare function createBusinessFlowReviewHandler(config: BusinessFlowReviewConfig): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+/**
+ * Create a NextJS API route handler that fetches featured reviews from BusinessFlow CRM
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/featured/route.ts
+ * import { createBusinessFlowFeaturedHandler } from '@businessflow/reviews/server';
+ *
+ * export const GET = createBusinessFlowFeaturedHandler({
+ *   apiUrl: process.env.BUSINESS_FLOW_API_URL!,
+ *   apiKey: process.env.BUSINESS_FLOW_API_KEY!,
+ * });
+ * ```
+ */
+declare function createBusinessFlowFeaturedHandler(config: Pick<BusinessFlowReviewConfig, 'apiUrl' | 'apiKey'>): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+/**
+ * Simplified BusinessFlow review handler for basic use cases
+ * Uses environment variables for configuration
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/submit/route.ts
+ * import { createSimpleBusinessFlowReviewHandler } from '@businessflow/reviews/server';
+ *
+ * export const POST = createSimpleBusinessFlowReviewHandler();
+ * ```
+ *
+ * Required environment variables:
+ * - BUSINESS_FLOW_API_URL
+ * - BUSINESS_FLOW_API_KEY
+ * - RECAPTCHA_SECRET_KEY (optional)
+ * - NEXT_PUBLIC_SITE_URL (optional, for sourceUrl)
+ */
+declare function createSimpleBusinessFlowReviewHandler(): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+/**
+ * Simplified BusinessFlow featured reviews handler for basic use cases
+ * Uses environment variables for configuration
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/featured/route.ts
+ * import { createSimpleBusinessFlowFeaturedHandler } from '@businessflow/reviews/server';
+ *
+ * export const GET = createSimpleBusinessFlowFeaturedHandler();
+ * ```
+ */
+declare function createSimpleBusinessFlowFeaturedHandler(): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+
+export { type BusinessFlowReviewConfig, type RecaptchaConfig, type RecaptchaVerificationResult, type Review, type ReviewApiResponse, type ReviewFetchConfig, type ReviewFieldConfig, type ReviewFormConfig, type ReviewFormData, type ReviewHandlerConfig, type ReviewSubmissionConfig, type StarRatingProps, type TestimonialDisplayConfig, type ValidationErrors, type ValidationRule, createBusinessFlowFeaturedHandler, createBusinessFlowReviewHandler, createCorsHeaders, createReviewFetchHandler, createReviewHandler, createReviewSubmitHandler, createSimpleBusinessFlowFeaturedHandler, createSimpleBusinessFlowReviewHandler, getRecaptchaErrorMessage, handleOptions, verifyRecaptcha };

package/dist/server/index.d.ts

@@ -1,3 +1,4 @@
+import * as next_server from 'next/server';
 import { NextRequest, NextResponse } from 'next/server';
 
 interface Review {
@@ -186,4 +187,88 @@ declare function verifyRecaptcha(token: string, config: RecaptchaConfig): Promis
  */
 declare function getRecaptchaErrorMessage(errorCodes: string[]): string;
 
-export { type RecaptchaConfig, type RecaptchaVerificationResult, type Review, type ReviewApiResponse, type ReviewFetchConfig, type ReviewFieldConfig, type ReviewFormConfig, type ReviewFormData, type ReviewHandlerConfig, type ReviewSubmissionConfig, type StarRatingProps, type TestimonialDisplayConfig, type ValidationErrors, type ValidationRule, createCorsHeaders, createReviewFetchHandler, createReviewHandler, createReviewSubmitHandler, getRecaptchaErrorMessage, handleOptions, verifyRecaptcha };
+/**
+ * Configuration for BusinessFlow CRM review integration
+ */
+interface BusinessFlowReviewConfig {
+    /** BusinessFlow API base URL (e.g., https://api.businessflow.co.za) */
+    apiUrl: string;
+    /** BusinessFlow API key for authentication */
+    apiKey: string;
+    /** Source URL for review attribution (optional, will use NEXT_PUBLIC_SITE_URL if not provided) */
+    sourceUrl?: string;
+    /** reCAPTCHA secret key for server-side verification (optional) */
+    recaptchaSecret?: string;
+    /** Minimum reCAPTCHA score for v3 (optional, defaults to 0.5) */
+    minimumScore?: number;
+    /** Custom success callback after review is submitted to BusinessFlow */
+    onSuccess?: (data: ReviewFormData, response: ReviewApiResponse) => Promise<void>;
+    /** Custom error callback if submission fails */
+    onError?: (data: ReviewFormData, error: Error) => Promise<void>;
+}
+/**
+ * Create a NextJS API route handler that submits reviews to BusinessFlow CRM
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/submit/route.ts
+ * import { createBusinessFlowReviewHandler } from '@businessflow/reviews/server';
+ *
+ * export const POST = createBusinessFlowReviewHandler({
+ *   apiUrl: process.env.BUSINESS_FLOW_API_URL!,
+ *   apiKey: process.env.BUSINESS_FLOW_API_KEY!,
+ *   sourceUrl: process.env.SITE_URL!,
+ *   recaptchaSecret: process.env.RECAPTCHA_SECRET_KEY!,
+ * });
+ * ```
+ */
+declare function createBusinessFlowReviewHandler(config: BusinessFlowReviewConfig): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+/**
+ * Create a NextJS API route handler that fetches featured reviews from BusinessFlow CRM
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/featured/route.ts
+ * import { createBusinessFlowFeaturedHandler } from '@businessflow/reviews/server';
+ *
+ * export const GET = createBusinessFlowFeaturedHandler({
+ *   apiUrl: process.env.BUSINESS_FLOW_API_URL!,
+ *   apiKey: process.env.BUSINESS_FLOW_API_KEY!,
+ * });
+ * ```
+ */
+declare function createBusinessFlowFeaturedHandler(config: Pick<BusinessFlowReviewConfig, 'apiUrl' | 'apiKey'>): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+/**
+ * Simplified BusinessFlow review handler for basic use cases
+ * Uses environment variables for configuration
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/submit/route.ts
+ * import { createSimpleBusinessFlowReviewHandler } from '@businessflow/reviews/server';
+ *
+ * export const POST = createSimpleBusinessFlowReviewHandler();
+ * ```
+ *
+ * Required environment variables:
+ * - BUSINESS_FLOW_API_URL
+ * - BUSINESS_FLOW_API_KEY
+ * - RECAPTCHA_SECRET_KEY (optional)
+ * - NEXT_PUBLIC_SITE_URL (optional, for sourceUrl)
+ */
+declare function createSimpleBusinessFlowReviewHandler(): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+/**
+ * Simplified BusinessFlow featured reviews handler for basic use cases
+ * Uses environment variables for configuration
+ *
+ * @example
+ * ```typescript
+ * // app/api/reviews/featured/route.ts
+ * import { createSimpleBusinessFlowFeaturedHandler } from '@businessflow/reviews/server';
+ *
+ * export const GET = createSimpleBusinessFlowFeaturedHandler();
+ * ```
+ */
+declare function createSimpleBusinessFlowFeaturedHandler(): (request: next_server.NextRequest) => Promise<next_server.NextResponse>;
+
+export { type BusinessFlowReviewConfig, type RecaptchaConfig, type RecaptchaVerificationResult, type Review, type ReviewApiResponse, type ReviewFetchConfig, type ReviewFieldConfig, type ReviewFormConfig, type ReviewFormData, type ReviewHandlerConfig, type ReviewSubmissionConfig, type StarRatingProps, type TestimonialDisplayConfig, type ValidationErrors, type ValidationRule, createBusinessFlowFeaturedHandler, createBusinessFlowReviewHandler, createCorsHeaders, createReviewFetchHandler, createReviewHandler, createReviewSubmitHandler, createSimpleBusinessFlowFeaturedHandler, createSimpleBusinessFlowReviewHandler, getRecaptchaErrorMessage, handleOptions, verifyRecaptcha };

package/dist/server/index.js

@@ -20,10 +20,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/server/index.ts
 var index_exports = {};
 __export(index_exports, {
+  createBusinessFlowFeaturedHandler: () => createBusinessFlowFeaturedHandler,
+  createBusinessFlowReviewHandler: () => createBusinessFlowReviewHandler,
   createCorsHeaders: () => createCorsHeaders,
   createReviewFetchHandler: () => createReviewFetchHandler,
   createReviewHandler: () => createReviewHandler,
   createReviewSubmitHandler: () => createReviewSubmitHandler,
+  createSimpleBusinessFlowFeaturedHandler: () => createSimpleBusinessFlowFeaturedHandler,
+  createSimpleBusinessFlowReviewHandler: () => createSimpleBusinessFlowReviewHandler,
   getRecaptchaErrorMessage: () => getRecaptchaErrorMessage,
   handleOptions: () => handleOptions,
   verifyRecaptcha: () => verifyRecaptcha
@@ -32,95 +36,6 @@ module.exports = __toCommonJS(index_exports);
 
 // src/server/handler.ts
 var import_server = require("next/server");
-
-// src/server/recaptcha.ts
-async function verifyRecaptcha(token, config) {
-  if (!config.secretKey) {
-    console.warn("RECAPTCHA_SECRET_KEY not configured, skipping verification");
-    return { success: true };
-  }
-  if (!token || typeof token !== "string") {
-    return {
-      success: false,
-      errorCodes: ["missing-input-response"]
-    };
-  }
-  const timeout = config.timeoutMs || 1e4;
-  try {
-    const controller = new AbortController();
-    const timeoutId = setTimeout(() => controller.abort(), timeout);
-    const response = await fetch("https://www.google.com/recaptcha/api/siteverify", {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/x-www-form-urlencoded"
-      },
-      body: new URLSearchParams({
-        secret: config.secretKey,
-        response: token
-      }),
-      signal: controller.signal
-    });
-    clearTimeout(timeoutId);
-    if (!response.ok) {
-      console.error("reCAPTCHA API returned non-OK status:", response.status);
-      return {
-        success: false,
-        errorCodes: ["recaptcha-api-error"]
-      };
-    }
-    const data = await response.json();
-    if (config.minimumScore !== void 0 && data.score !== void 0) {
-      if (data.score < config.minimumScore) {
-        return {
-          success: false,
-          score: data.score,
-          errorCodes: ["score-threshold-not-met"]
-        };
-      }
-    }
-    return {
-      success: data.success === true,
-      score: data.score,
-      action: data.action,
-      challengeTimestamp: data.challenge_ts,
-      hostname: data.hostname,
-      errorCodes: data["error-codes"] || []
-    };
-  } catch (error) {
-    if (error instanceof Error && error.name === "AbortError") {
-      console.error("reCAPTCHA verification timeout");
-      return {
-        success: false,
-        errorCodes: ["timeout-or-duplicate"]
-      };
-    }
-    console.error("reCAPTCHA verification error:", error);
-    return {
-      success: false,
-      errorCodes: ["network-error"]
-    };
-  }
-}
-function getRecaptchaErrorMessage(errorCodes) {
-  const errorMessages = {
-    "missing-input-secret": "reCAPTCHA secret key is missing",
-    "invalid-input-secret": "reCAPTCHA secret key is invalid",
-    "missing-input-response": "reCAPTCHA token is missing",
-    "invalid-input-response": "reCAPTCHA token is invalid or malformed",
-    "bad-request": "The request is invalid or malformed",
-    "timeout-or-duplicate": "reCAPTCHA verification timed out or token was already used",
-    "score-threshold-not-met": "reCAPTCHA score is below the required threshold",
-    "recaptcha-api-error": "reCAPTCHA service is unavailable",
-    "network-error": "Network error during reCAPTCHA verification"
-  };
-  if (!errorCodes || errorCodes.length === 0) {
-    return "reCAPTCHA verification failed";
-  }
-  const knownErrors = errorCodes.filter((code) => errorMessages[code]).map((code) => errorMessages[code]);
-  return knownErrors.length > 0 ? knownErrors.join(", ") : "reCAPTCHA verification failed";
-}
-
-// src/server/handler.ts
 function createReviewSubmitHandler(config) {
   return async function reviewSubmitHandler(request) {
     if (request.method !== "POST") {
@@ -228,16 +143,6 @@ function createReviewSubmitHandler(config) {
           }
         }
       }
-      if (config.recaptcha && body.RecaptchaToken) {
-        const recaptchaResult = await verifyRecaptcha(body.RecaptchaToken, config.recaptcha);
-        if (!recaptchaResult.success) {
-          const errorMessage = getRecaptchaErrorMessage(recaptchaResult.errorCodes || []);
-          return import_server.NextResponse.json(
-            { error: `reCAPTCHA verification failed: ${errorMessage}` },
-            { status: 400 }
-          );
-        }
-      }
       let response;
       try {
         if (!config.onSubmit) {
@@ -389,12 +294,231 @@ function handleOptions(allowedOrigins) {
     headers: createCorsHeaders(allowedOrigins)
   });
 }
+
+// src/server/recaptcha.ts
+async function verifyRecaptcha(token, config) {
+  if (!config.secretKey) {
+    console.warn("RECAPTCHA_SECRET_KEY not configured, skipping verification");
+    return { success: true };
+  }
+  if (!token || typeof token !== "string") {
+    return {
+      success: false,
+      errorCodes: ["missing-input-response"]
+    };
+  }
+  const timeout = config.timeoutMs || 1e4;
+  try {
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), timeout);
+    const response = await fetch("https://www.google.com/recaptcha/api/siteverify", {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/x-www-form-urlencoded"
+      },
+      body: new URLSearchParams({
+        secret: config.secretKey,
+        response: token
+      }),
+      signal: controller.signal
+    });
+    clearTimeout(timeoutId);
+    if (!response.ok) {
+      console.error("reCAPTCHA API returned non-OK status:", response.status);
+      return {
+        success: false,
+        errorCodes: ["recaptcha-api-error"]
+      };
+    }
+    const data = await response.json();
+    if (config.minimumScore !== void 0 && data.score !== void 0) {
+      if (data.score < config.minimumScore) {
+        return {
+          success: false,
+          score: data.score,
+          errorCodes: ["score-threshold-not-met"]
+        };
+      }
+    }
+    return {
+      success: data.success === true,
+      score: data.score,
+      action: data.action,
+      challengeTimestamp: data.challenge_ts,
+      hostname: data.hostname,
+      errorCodes: data["error-codes"] || []
+    };
+  } catch (error) {
+    if (error instanceof Error && error.name === "AbortError") {
+      console.error("reCAPTCHA verification timeout");
+      return {
+        success: false,
+        errorCodes: ["timeout-or-duplicate"]
+      };
+    }
+    console.error("reCAPTCHA verification error:", error);
+    return {
+      success: false,
+      errorCodes: ["network-error"]
+    };
+  }
+}
+function getRecaptchaErrorMessage(errorCodes) {
+  const errorMessages = {
+    "missing-input-secret": "reCAPTCHA secret key is missing",
+    "invalid-input-secret": "reCAPTCHA secret key is invalid",
+    "missing-input-response": "reCAPTCHA token is missing",
+    "invalid-input-response": "reCAPTCHA token is invalid or malformed",
+    "bad-request": "The request is invalid or malformed",
+    "timeout-or-duplicate": "reCAPTCHA verification timed out or token was already used",
+    "score-threshold-not-met": "reCAPTCHA score is below the required threshold",
+    "recaptcha-api-error": "reCAPTCHA service is unavailable",
+    "network-error": "Network error during reCAPTCHA verification"
+  };
+  if (!errorCodes || errorCodes.length === 0) {
+    return "reCAPTCHA verification failed";
+  }
+  const knownErrors = errorCodes.filter((code) => errorMessages[code]).map((code) => errorMessages[code]);
+  return knownErrors.length > 0 ? knownErrors.join(", ") : "reCAPTCHA verification failed";
+}
+
+// src/server/businessflow.ts
+function createBusinessFlowReviewHandler(config) {
+  const handlerConfig = {
+    onSubmit: async (data) => {
+      const { token, ...reviewData } = data;
+      const payload = {
+        ReviewerName: reviewData.reviewerName,
+        ReviewerEmail: reviewData.reviewerEmail,
+        Rating: reviewData.rating,
+        Content: reviewData.content || ""
+      };
+      try {
+        const response = await fetch(`${config.apiUrl}/api/Marketing/Review/Submit`, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            "X-API-Key": config.apiKey
+          },
+          body: JSON.stringify(payload)
+        });
+        const responseText = await response.text();
+        let result;
+        try {
+          result = JSON.parse(responseText);
+        } catch {
+          result = {
+            success: response.ok,
+            message: response.ok ? "Review submitted successfully" : responseText || "Unknown error"
+          };
+        }
+        if (!response.ok) {
+          return {
+            success: false,
+            message: result.message || `HTTP ${response.status}: ${response.statusText}`,
+            data: result
+          };
+        }
+        return {
+          success: true,
+          message: result.message || "Review submitted successfully",
+          reviewId: result.reviewId,
+          status: result.status,
+          data: result
+        };
+      } catch (error) {
+        console.error("BusinessFlow Review API error:", error);
+        return {
+          success: false,
+          message: error instanceof Error ? error.message : "Network error occurred"
+        };
+      }
+    },
+    // Configure reCAPTCHA if provided
+    recaptcha: config.recaptchaSecret ? {
+      secretKey: config.recaptchaSecret,
+      minimumScore: config.minimumScore ?? 0.5
+    } : void 0,
+    // Pass through callbacks
+    onSuccess: config.onSuccess,
+    onError: config.onError
+  };
+  return createReviewSubmitHandler(handlerConfig);
+}
+function createBusinessFlowFeaturedHandler(config) {
+  return createReviewFetchHandler({
+    onFetch: async (params) => {
+      const limit = params?.limit || 10;
+      try {
+        const response = await fetch(`${config.apiUrl}/api/Marketing/Review/Featured?limit=${limit}`, {
+          method: "GET",
+          headers: {
+            "Content-Type": "application/json",
+            "X-API-Key": config.apiKey
+          }
+        });
+        if (!response.ok) {
+          const errorText = await response.text();
+          throw new Error(`Failed to fetch featured reviews: ${errorText}`);
+        }
+        const data = await response.json();
+        return data.map((item) => ({
+          id: `review_${Date.now()}_${Math.random()}`,
+          // Generate unique ID
+          reviewerName: item.reviewerName,
+          reviewerEmail: "",
+          // Not included in public response
+          rating: item.rating,
+          content: item.content,
+          createdAt: item.submittedAt,
+          featured: true,
+          approved: true
+        }));
+      } catch (error) {
+        console.error("BusinessFlow Featured Reviews API error:", error);
+        throw error;
+      }
+    }
+  });
+}
+function createSimpleBusinessFlowReviewHandler() {
+  const apiUrl = process.env.BUSINESS_FLOW_API_URL;
+  const apiKey = process.env.BUSINESS_FLOW_API_KEY;
+  if (!apiUrl || !apiKey) {
+    throw new Error(
+      "Missing required environment variables: BUSINESS_FLOW_API_URL and BUSINESS_FLOW_API_KEY must be set"
+    );
+  }
+  return createBusinessFlowReviewHandler({
+    apiUrl,
+    apiKey,
+    sourceUrl: process.env.NEXT_PUBLIC_SITE_URL,
+    recaptchaSecret: process.env.RECAPTCHA_SECRET_KEY
+  });
+}
+function createSimpleBusinessFlowFeaturedHandler() {
+  const apiUrl = process.env.BUSINESS_FLOW_API_URL;
+  const apiKey = process.env.BUSINESS_FLOW_API_KEY;
+  if (!apiUrl || !apiKey) {
+    throw new Error(
+      "Missing required environment variables: BUSINESS_FLOW_API_URL and BUSINESS_FLOW_API_KEY must be set"
+    );
+  }
+  return createBusinessFlowFeaturedHandler({
+    apiUrl,
+    apiKey
+  });
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  createBusinessFlowFeaturedHandler,
+  createBusinessFlowReviewHandler,
   createCorsHeaders,
   createReviewFetchHandler,
   createReviewHandler,
   createReviewSubmitHandler,
+  createSimpleBusinessFlowFeaturedHandler,
+  createSimpleBusinessFlowReviewHandler,
   getRecaptchaErrorMessage,
   handleOptions,
   verifyRecaptcha