react-feedback-surveys 1.6.1 → 1.8.0

package/dist/index.d.ts

@@ -1,29 +1,56 @@
 import { default as default_2 } from 'react';
 
-export declare const CES7Survey: default_2.FC<CES7SurveyProps>;
-
-export declare interface CES7SurveyProps extends SharedSurveyProps {
+/** Customer Effort Score survey, rated on a fixed 7-point scale */
+export declare interface CesSurveyProps extends SharedSurveyProps {
+    /** Survey methodology */
+    type: 'ces';
     /** Visual style for the rating scale */
     scaleStyle: 'numbers';
 }
 
-export declare const CSAT2Survey: default_2.FC<CSAT2SurveyProps>;
+/**
+ * Callback function for contact submission
+ * @param payload - The collected contact data
+ * @returns void or Promise<void> for async operations
+ */
+export declare type ContactCallback = (payload: ContactSubmitPayload) => void | Promise<void>;
 
-export declare interface CSAT2SurveyProps extends SharedSurveyProps {
+/**
+ * Payload sent when submitting collected contact
+ */
+export declare interface ContactSubmitPayload {
+    /** Selected rating value */
+    value?: number;
+    /** Submitted feedback text or selected choices */
+    text?: string | string[];
+    /** Respondent's email address */
+    email: string;
+}
+
+/** Customer Satisfaction survey, rated on a 2-point scale */
+export declare interface CsatSurveyProps2 extends SharedSurveyProps {
+    /** Survey methodology */
+    type: 'csat';
+    /** Number of points on the rating scale */
+    points: 2;
     /** Visual style for the rating scale */
     scaleStyle: 'emoji' | 'thumbs';
 }
 
-export declare const CSAT5Survey: default_2.FC<CSAT5SurveyProps>;
-
-export declare interface CSAT5SurveyProps extends SharedSurveyProps {
+/** Customer Satisfaction survey, rated on a 5-point scale */
+export declare interface CsatSurveyProps5 extends SharedSurveyProps {
+    /** Survey methodology */
+    type: 'csat';
+    /** Number of points on the rating scale */
+    points: 5;
     /** Visual style for the rating scale */
     scaleStyle: 'emoji' | 'numbers' | 'stars';
 }
 
-export declare const NPS10Survey: default_2.FC<NPS10SurveyProps>;
-
-export declare interface NPS10SurveyProps extends SharedSurveyProps {
+/** Net Promoter Score survey, rated on a fixed 0–10 scale */
+export declare interface NpsSurveyProps extends SharedSurveyProps {
+    /** Survey methodology */
+    type: 'nps';
     /** Visual style for the rating scale */
     scaleStyle: 'numbers';
 }
@@ -57,6 +84,8 @@ export declare interface RootClassNames {
     rating?: string;
     /** Feedback screen wrapper */
     feedback?: string;
+    /** Contact screen wrapper */
+    contact?: string;
     /** Success screen wrapper */
     success?: string;
     /** Close button element */
@@ -103,21 +132,39 @@ export declare interface SharedSurveyProps {
     /** Follow-up feedback question (screen 2) */
     textQuestion?: string;
     /** Submit button text */
-    textButtonLabel?: string;
+    textButtonSendLabel?: string;
+    /** Skip button text */
+    textButtonSkipLabel?: string;
     /** Optional predefined choices for feedback */
     choiceOptions?: string[] | null;
     /** Success message text */
     thankYouMessage: string;
+    /** Enables an optional email collection step before the success screen. Skipped when `userId` is already provided */
+    collectContact?: boolean;
+    /** Existing user identity, if already known. When provided, the email collection step is skipped */
+    userId?: string;
+    /** Question shown on the contact collection screen */
+    contactQuestion?: string;
+    /** Descriptive text shown above the email input */
+    contactSubtext?: string;
+    /** Submit button text for the contact collection screen */
+    contactButtonSendLabel?: string;
+    /** Skip button text for the contact collection screen */
+    contactButtonSkipLabel?: string;
     /** Callback when score data is submitted */
     onScoreSubmit?: SurveyCallback;
     /** Callback when survey data is submitted */
     onFeedbackSubmit?: SurveyCallback;
+    /** Callback when contact is submitted */
+    onContactSubmit?: ContactCallback;
 }
 
 export declare const Surface: React.FC<SurfaceProps>;
 
 export declare type SurfaceProps = React.HTMLAttributes<HTMLDivElement>;
 
+export declare const Survey: default_2.FC<SurveyProps>;
+
 /**
  * Callback function for survey submission
  * @param payload - The survey data to submit
@@ -125,16 +172,20 @@ export declare type SurfaceProps = React.HTMLAttributes<HTMLDivElement>;
  */
 export declare type SurveyCallback = (payload: SurveySubmitPayload) => void | Promise<void>;
 
+export declare type SurveyProps = CsatSurveyProps5 | CsatSurveyProps2 | CesSurveyProps | NpsSurveyProps;
+
 /**
  * Available screens in survey flow
  */
 export declare type SurveyScreen = 
 /** Rating screen (first screen) */
 'rating'
-/** Final "thanks" message screen */
-| 'success'
 /** Feedback input screen */
-| 'feedback';
+| 'feedback'
+/** Optional email/contact collection screen */
+| 'contact'
+/** Final "thanks" message screen */
+| 'success';
 
 /**
  * Payload sent when submitting survey data