@product7/feedback-sdk 1.5.0 → 1.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@product7/feedback-sdk",
-	"version": "1.5.0",
+	"version": "1.5.2",
 	"description": "JavaScript SDK for integrating Product7 feedback widgets into any website",
 	"main": "dist/feedback-sdk.js",
 	"module": "src/index.js",

package/src/api/services/SurveyService.js

@@ -15,11 +15,20 @@ export class SurveyService {
 			return { success: true, data: MOCK_SURVEYS };
 		}
 
+		const respondent = this._getRespondentContext(context);
+
 		const params = {
 			url:
 				context.url ||
 				(typeof window !== 'undefined' ? window.location.href : ''),
 			...getDeviceInfo(),
+			...(respondent.respondent_id && {
+				respondent_id: respondent.respondent_id,
+			}),
+			...(respondent.email && { email: respondent.email }),
+			...(context.includeEligibility !== undefined && {
+				include_eligibility: context.includeEligibility,
+			}),
 			...(context.userProperties && {
 				user_properties: context.userProperties,
 			}),
@@ -37,6 +46,19 @@ export class SurveyService {
 		});
 	}
 
+	_getRespondentContext(context = {}) {
+		const userContext =
+			typeof this.api.getUserContext === 'function'
+				? this.api.getUserContext() || {}
+				: {};
+
+		return {
+			respondent_id:
+				context.respondentId || context.userId || userContext.user_id || null,
+			email: context.email || userContext.email || null,
+		};
+	}
+
 	async submitSurveyResponse(surveyId, responseData) {
 		if (!surveyId) throw new APIError(400, 'Survey ID is required');
 
@@ -55,10 +77,16 @@ export class SurveyService {
 			};
 		}
 
+		const respondent = this._getRespondentContext(responseData);
+
 		const payload = {
 			rating: responseData.rating,
 			feedback: responseData.feedback || '',
 			answers: responseData.answers || {},
+			...(respondent.respondent_id && {
+				respondent_id: respondent.respondent_id,
+			}),
+			...(respondent.email && { email: respondent.email }),
 		};
 
 		return this.api._handleAuthRetry(async () => {

package/src/core/FeedbackSDK.js

@@ -94,7 +94,11 @@ export class FeedbackSDK {
 
 		try {
 			const result = await this.apiService.getActiveSurveys(context);
-			return result.data || [];
+			const surveys = result.data || [];
+			if (context.includeIneligible) {
+				return surveys;
+			}
+			return surveys.filter((survey) => this._isSurveyEligible(survey));
 		} catch (error) {
 			this.eventBus.emit('sdk:error', { error });
 			throw new SDKError(
@@ -111,7 +115,12 @@ export class FeedbackSDK {
 			);
 		}
 
-		const surveys = await this.getActiveSurveys();
+		const { context = {}, ...displayOptions } = options;
+		const surveys = await this.getActiveSurveys({
+			...context,
+			includeEligibility: true,
+			includeIneligible: true,
+		});
 		const surveyConfig = surveys.find((s) => s.id === surveyId);
 
 		if (!surveyConfig) {
@@ -120,6 +129,15 @@ export class FeedbackSDK {
 			);
 		}
 
+		if (!this._isSurveyEligible(surveyConfig)) {
+			this.eventBus.emit('survey:suppressed', {
+				surveyId,
+				reason: this._getSurveyIneligibilityReason(surveyConfig),
+				survey: surveyConfig,
+			});
+			return null;
+		}
+
 		return this.showSurvey({
 			surveyId: surveyConfig.id,
 			surveyType: surveyConfig.type,
@@ -128,7 +146,7 @@ export class FeedbackSDK {
 			lowLabel: surveyConfig.low_label,
 			highLabel: surveyConfig.high_label,
 			customQuestions: surveyConfig.questions,
-			...options,
+			...displayOptions,
 		});
 	}
 
@@ -139,6 +157,15 @@ export class FeedbackSDK {
 			);
 		}
 
+		if (!this._isSurveyEligible(options)) {
+			this.eventBus.emit('survey:suppressed', {
+				surveyId: options.surveyId || options.id || null,
+				reason: this._getSurveyIneligibilityReason(options),
+				survey: options,
+			});
+			return null;
+		}
+
 		const surveyWidget = this.createWidget('survey', {
 			surveyId: options.surveyId,
 			surveyType: options.surveyType || options.type || 'nps',
@@ -149,6 +176,8 @@ export class FeedbackSDK {
 			lowLabel: options.lowLabel,
 			highLabel: options.highLabel,
 			customQuestions: options.customQuestions,
+			respondentId: options.respondentId,
+			email: options.email,
 			onSubmit: options.onSubmit,
 			onDismiss: options.onDismiss,
 		});
@@ -159,6 +188,56 @@ export class FeedbackSDK {
 		return surveyWidget;
 	}
 
+	_isSurveyEligible(survey = {}) {
+		const shouldShow = this._getSurveyField(survey, ['shouldShow', 'should_show']);
+		if (typeof shouldShow === 'boolean') {
+			return shouldShow;
+		}
+
+		const eligible = this._getSurveyField(survey, [
+			'eligible',
+			'isEligible',
+			'is_eligible',
+		]);
+		if (typeof eligible === 'boolean') {
+			return eligible;
+		}
+
+		const isAnswered = this._getSurveyField(survey, ['isAnswered', 'is_answered']);
+		if (typeof isAnswered === 'boolean') {
+			return !isAnswered;
+		}
+
+		return true;
+	}
+
+	_getSurveyIneligibilityReason(survey = {}) {
+		const explicitReason = this._getSurveyField(survey, [
+			'reason',
+			'suppressionReason',
+			'suppression_reason',
+		]);
+		if (explicitReason) {
+			return explicitReason;
+		}
+
+		const isAnswered = this._getSurveyField(survey, ['isAnswered', 'is_answered']);
+		if (isAnswered === true) {
+			return 'already_answered';
+		}
+
+		return 'ineligible';
+	}
+
+	_getSurveyField(survey, fields) {
+		for (const field of fields) {
+			if (survey[field] !== undefined && survey[field] !== null) {
+				return survey[field];
+			}
+		}
+		return null;
+	}
+
 	showChangelog(options = {}) {
 		if (!this.initialized) {
 			throw new SDKError(

package/src/widgets/SurveyWidget.js

@@ -13,6 +13,8 @@ export class SurveyWidget extends BaseWidget {
 			lowLabel: options.lowLabel || null,
 			highLabel: options.highLabel || null,
 			customQuestions: options.customQuestions || [],
+			respondentId: options.respondentId || null,
+			email: options.email || null,
 			onSubmit: options.onSubmit || null,
 			onDismiss: options.onDismiss || null,
 		};
@@ -381,10 +383,14 @@ export class SurveyWidget extends BaseWidget {
 			return;
 		}
 
+		const respondent = this._getRespondentContext();
+
 		const responseData = {
 			rating: this.surveyState.score,
 			feedback: this.surveyState.feedback,
 			answers: this.surveyState.customAnswers,
+			...(respondent.respondentId && { respondentId: respondent.respondentId }),
+			...(respondent.email && { email: respondent.email }),
 		};
 
 		const response = {
@@ -413,6 +419,34 @@ export class SurveyWidget extends BaseWidget {
 		this._showSuccessNotification();
 	}
 
+	_getRespondentContext() {
+		const sdkUserContext =
+			typeof this.sdk.getUserContext === 'function'
+				? this.sdk.getUserContext() || {}
+				: {};
+		const apiUserContext =
+			this.apiService &&
+			typeof this.apiService.getUserContext === 'function'
+				? this.apiService.getUserContext() || {}
+				: {};
+		const localUserContext = this.options.userContext || {};
+
+		return {
+			respondentId:
+				this.surveyOptions.respondentId ||
+				localUserContext.user_id ||
+				sdkUserContext.user_id ||
+				apiUserContext.user_id ||
+				null,
+			email:
+				this.surveyOptions.email ||
+				localUserContext.email ||
+				sdkUserContext.email ||
+				apiUserContext.email ||
+				null,
+		};
+	}
+
 	async _handleDismiss() {
 		if (this.surveyOptions.surveyId) {
 			try {

package/types/index.d.ts

@@ -78,6 +78,8 @@ declare module '@product7/feedback-sdk' {
 		lowLabel?: string | null;
 		highLabel?: string | null;
 		customQuestions?: SurveyQuestion[];
+		respondentId?: string | null;
+		email?: string | null;
 		theme?: 'light' | 'dark';
 		onSubmit?: (response: SurveyWidgetResponse) => void;
 		onDismiss?: () => void;