@product7/feedback-sdk 1.5.0 → 1.5.2

package/dist/feedback-sdk.js

@@ -720,11 +720,20 @@
 				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,
 				}),
@@ -742,6 +751,19 @@
 			});
 		}
 
+		_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$1(400, 'Survey ID is required');
 
@@ -760,10 +782,16 @@
 				};
 			}
 
+			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 () => {
@@ -6701,6 +6729,8 @@
 				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,
 			};
@@ -7069,10 +7099,14 @@
 				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 = {
@@ -7101,6 +7135,34 @@
 			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 {
@@ -7395,7 +7457,11 @@
 
 			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(
@@ -7412,7 +7478,12 @@
 				);
 			}
 
-			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) {
@@ -7421,6 +7492,15 @@
 				);
 			}
 
+			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,
@@ -7429,7 +7509,7 @@
 				lowLabel: surveyConfig.low_label,
 				highLabel: surveyConfig.high_label,
 				customQuestions: surveyConfig.questions,
-				...options,
+				...displayOptions,
 			});
 		}
 
@@ -7440,6 +7520,15 @@
 				);
 			}
 
+			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',
@@ -7450,6 +7539,8 @@
 				lowLabel: options.lowLabel,
 				highLabel: options.highLabel,
 				customQuestions: options.customQuestions,
+				respondentId: options.respondentId,
+				email: options.email,
 				onSubmit: options.onSubmit,
 				onDismiss: options.onDismiss,
 			});
@@ -7460,6 +7551,56 @@
 			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(