@product7/feedback-sdk 1.6.5 → 1.6.7

package/package.json

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

package/src/api/services/ChangelogService.js

@@ -1,4 +1,4 @@
-import { MOCK_CHANGELOGS } from '../mock-data';
+import { MOCK_CHANGELOGS } from '../mock-data/index.js';
 import { delay } from '../utils/helpers.js';
 
 export class ChangelogService {

package/src/api/services/HelpService.js

@@ -1,4 +1,4 @@
-import { MOCK_HELP_COLLECTIONS } from '../mock-data';
+import { MOCK_HELP_COLLECTIONS } from '../mock-data/index.js';
 import { delay } from '../utils/helpers.js';
 
 export class HelpService {

package/src/api/services/MessengerService.js

@@ -1,4 +1,4 @@
-import { MOCK_CONVERSATIONS, MOCK_MESSAGES } from '../mock-data';
+import { MOCK_CONVERSATIONS, MOCK_MESSAGES } from '../mock-data/index.js';
 import { delay } from '../utils/helpers.js';
 
 export class MessengerService {

package/src/api/services/SurveyService.js

@@ -1,5 +1,5 @@
 import { APIError } from '../../utils/errors.js';
-import { MOCK_SURVEYS } from '../mock-data';
+import { MOCK_SURVEYS } from '../mock-data/index.js';
 import { delay, getDeviceInfo } from '../utils/helpers.js';
 
 export class SurveyService {

package/src/core/BaseAPIService.js

@@ -90,15 +90,19 @@ export class BaseAPIService {
 				body: JSON.stringify(payload),
 				headers: { 'Content-Type': 'application/json' },
 			});
+			const initData = this._extractInitResponseData(response);
 
-			this.sessionToken = response.session_token;
-			this.sessionExpiry = new Date(Date.now() + response.expires_in * 1000);
+			this.sessionToken = initData.sessionToken;
+			this.sessionExpiry = new Date(Date.now() + initData.expiresIn * 1000);
 			this._storeSession();
 
 			return {
 				sessionToken: this.sessionToken,
-				config: response.config || {},
-				expiresIn: response.expires_in,
+				config: initData.config,
+				expiresIn: initData.expiresIn,
+				status: initData.status,
+				message: initData.message,
+				configVersion: initData.configVersion,
 			};
 		} catch (error) {
 			throw new APIError(
@@ -109,6 +113,34 @@ export class BaseAPIService {
 		}
 	}
 
+	_extractInitResponseData(response) {
+		const payload =
+			response && typeof response.data === 'object' ? response.data : response || {};
+
+		const sessionToken = payload.session_token || payload.sessionToken;
+		const expiresIn = Number(payload.expires_in ?? payload.expiresIn);
+
+		if (!sessionToken) {
+			throw new APIError(500, 'Invalid init response: missing session_token');
+		}
+
+		if (!Number.isFinite(expiresIn) || expiresIn <= 0) {
+			throw new APIError(500, 'Invalid init response: missing expires_in');
+		}
+
+		return {
+			sessionToken,
+			expiresIn,
+			config:
+				payload.config && typeof payload.config === 'object'
+					? payload.config
+					: {},
+			configVersion: payload.config_version ?? payload.configVersion ?? null,
+			status: response?.status ?? payload?.status ?? true,
+			message: response?.message ?? payload?.message ?? null,
+		};
+	}
+
 	async _ensureSession() {
 		if (!this.isSessionValid()) {
 			await this.init();

package/src/core/FeedbackSDK.js

@@ -65,6 +65,10 @@ export class FeedbackSDK {
 		const widgetId = generateId('widget');
 		const widgetConfig = this._getWidgetTypeConfig(type);
 		const explicitOptions = this._omitUndefined(options);
+		const widgetEnabled = this._isWidgetEnabled(type, {
+			...widgetConfig,
+			...explicitOptions,
+		});
 		const widgetOptions = {
 			id: widgetId,
 			sdk: this,
@@ -72,6 +76,7 @@ export class FeedbackSDK {
 			...this.config,
 			...widgetConfig,
 			...explicitOptions,
+			enabled: widgetEnabled,
 		};
 
 		try {
@@ -162,6 +167,7 @@ export class FeedbackSDK {
 				surveyConfig.showDescription ?? surveyConfig.show_description,
 			customQuestions: surveyConfig.customQuestions || surveyConfig.questions,
 			pages: surveyConfig.pages,
+			enabled: surveyConfig.enabled,
 			...displayOptions,
 		});
 	}
@@ -184,6 +190,17 @@ export class FeedbackSDK {
 
 		const normalizedOptions = this._normalizeSurveyConfig(options);
 		const surveyConfigDefaults = this._getWidgetTypeConfig('survey');
+		const surveyEnabled = this._isWidgetEnabled('survey', normalizedOptions);
+
+		if (!surveyEnabled) {
+			this.eventBus.emit('survey:suppressed', {
+				surveyId:
+					normalizedOptions.surveyId || normalizedOptions.id || options.id || null,
+				reason: 'disabled',
+				survey: normalizedOptions,
+			});
+			return null;
+		}
 
 		const surveyWidget = this.createWidget('survey', {
 			surveyId: normalizedOptions.surveyId,
@@ -215,6 +232,7 @@ export class FeedbackSDK {
 			email: normalizedOptions.email,
 			onSubmit: normalizedOptions.onSubmit,
 			onDismiss: normalizedOptions.onDismiss,
+			enabled: surveyEnabled,
 		});
 
 		surveyWidget.mount();
@@ -308,13 +326,19 @@ export class FeedbackSDK {
 			: {};
 
 		const inferredType =
-			survey.type || this._inferSurveyTypeFromPage(firstPage) || 'nps';
+			survey.surveyType ||
+			survey.survey_type ||
+			survey.type ||
+			this._inferSurveyTypeFromPage(firstPage) ||
+			'nps';
 
 		return {
 			...survey,
-			surveyId: survey.surveyId || survey.id || null,
-			surveyType: survey.surveyType || inferredType,
-			type: survey.type || inferredType,
+			surveyId: survey.surveyId || survey.survey_id || survey.id || null,
+			surveyType: survey.surveyType || survey.survey_type || inferredType,
+			type: survey.type || survey.survey_type || inferredType,
+			enabled:
+				typeof survey.enabled === 'boolean' ? survey.enabled : undefined,
 			should_show:
 				survey.should_show ??
 				(survey.eligibility ? survey.eligibility.should_show : undefined),
@@ -343,7 +367,11 @@ export class FeedbackSDK {
 			showTitle: survey.showTitle ?? survey.show_title ?? null,
 			showDescription:
 				survey.showDescription ?? survey.show_description ?? null,
-			customQuestions: survey.customQuestions || survey.questions || [],
+			customQuestions:
+				survey.customQuestions ||
+				survey.custom_questions ||
+				survey.questions ||
+				[],
 			pages: this._normalizeSurveyPages(survey.pages || []),
 		};
 	}
@@ -418,6 +446,23 @@ export class FeedbackSDK {
 		return this._toCamelCaseObject(mergedTypeConfig);
 	}
 
+	_isWidgetEnabled(type, options = {}) {
+		const typeConfig = this._getWidgetTypeConfig(type);
+		if (typeConfig.enabled === false) {
+			return false;
+		}
+
+		if (typeof options.enabled === 'boolean') {
+			return options.enabled;
+		}
+
+		if (typeof typeConfig.enabled === 'boolean') {
+			return typeConfig.enabled;
+		}
+
+		return true;
+	}
+
 	_isPlainObject(value) {
 		return Object.prototype.toString.call(value) === '[object Object]';
 	}
@@ -471,11 +516,21 @@ export class FeedbackSDK {
 
 		const configDefaults = this._getWidgetTypeConfig('changelog');
 		const explicitOptions = this._omitUndefined(options);
+		const changelogEnabled = this._isWidgetEnabled('changelog', explicitOptions);
+
+		if (!changelogEnabled) {
+			this.eventBus.emit('widget:suppressed', {
+				type: 'changelog',
+				reason: 'disabled',
+			});
+			return null;
+		}
 
 		const changelogWidget = this.createWidget('changelog', {
 			...defaults,
 			...configDefaults,
 			...explicitOptions,
+			enabled: changelogEnabled,
 		});
 
 		changelogWidget.mount();

package/src/widgets/BaseWidget.js

@@ -48,6 +48,15 @@ export class BaseWidget {
 	mount(container) {
 		if (this.mounted || this.destroyed) return this;
 
+		if (this.options.enabled === false) {
+			this.sdk.eventBus.emit('widget:suppressed', {
+				widget: this,
+				type: this.type,
+				reason: 'disabled',
+			});
+			return this;
+		}
+
 		if (this.options.suppressAfterSubmission && this._hasRecentlySubmitted()) {
 			this.sdk.eventBus.emit('widget:suppressed', {
 				widget: this,

package/src/widgets/MessengerWidget.js

@@ -18,6 +18,11 @@ export class MessengerWidget extends BaseWidget {
 	constructor(options) {
 		super({ ...options, type: 'messenger' });
 
+		const resolvedEnableChangelog =
+			typeof options.enableChangelog === 'boolean'
+				? options.enableChangelog
+				: options.enableNews !== false;
+
 		this.messengerOptions = {
 			position: options.position || 'bottom-right',
 			theme: options.theme || 'light',
@@ -30,7 +35,10 @@ export class MessengerWidget extends BaseWidget {
 			greetingMessage: options.greetingMessage || 'Hi there 👋',
 			welcomeMessage: options.welcomeMessage || 'How can we help?',
 			enableHelp: options.enableHelp !== false,
-			enableChangelog: options.enableChangelog !== false,
+			enableChangelog: resolvedEnableChangelog,
+			autoLoadData: options.autoLoadData !== false,
+			initialView: options.initialView || 'home',
+			previewData: options.previewData || null,
 			featuredContent: options.featuredContent || null,
 			feedbackUrl: options.feedbackUrl || null,
 			changelogUrl: options.changelogUrl || null,
@@ -498,6 +506,51 @@ export class MessengerWidget extends BaseWidget {
 		};
 	}
 
+	_applyPreviewData() {
+		const data = this.messengerOptions.previewData;
+		if (!data || typeof data !== 'object') {
+			return;
+		}
+
+		if (Array.isArray(data.conversations)) {
+			this.messengerState.setConversations(data.conversations);
+		}
+
+		if (Array.isArray(data.helpArticles)) {
+			this.messengerState.setHelpArticles(data.helpArticles);
+		}
+
+		if (Array.isArray(data.homeChangelogItems)) {
+			this.messengerState.setHomeChangelogItems(data.homeChangelogItems);
+		}
+
+		if (Array.isArray(data.changelogItems)) {
+			this.messengerState.setChangelogItems(data.changelogItems);
+		}
+
+		if (typeof data.unreadCount === 'number') {
+			this.setUnreadCount(data.unreadCount);
+		}
+
+		if (data.availability && typeof data.availability === 'object') {
+			const availability = data.availability;
+			this.messengerState.agentsOnline = Boolean(
+				availability.agentsOnline ?? availability.agents_online
+			);
+			this.messengerState.onlineCount =
+				availability.onlineCount ?? availability.online_count ?? 0;
+			this.messengerState.responseTime =
+				availability.responseTime ??
+				availability.response_time ??
+				this.messengerState.responseTime;
+			this.messengerState._notify('availabilityUpdate', availability);
+		}
+
+		if (typeof data.currentView === 'string') {
+			this.messengerState.setView(data.currentView);
+		}
+	}
+
 	async loadInitialData() {
 		try {
 			const conversations = await this._fetchConversations();
@@ -824,17 +877,28 @@ export class MessengerWidget extends BaseWidget {
 	}
 
 	async onMount() {
-		this.loadInitialData();
+		this._applyPreviewData();
 
-		if (this.apiService?.sessionToken) {
-			this._initWebSocket();
-		}
+		if (this.messengerOptions.autoLoadData) {
+			this.loadInitialData();
 
-		this.checkAgentAvailability();
+			if (this.apiService?.sessionToken) {
+				this._initWebSocket();
+			}
 
-		this._availabilityInterval = setInterval(() => {
 			this.checkAgentAvailability();
-		}, 60000);
+
+			this._availabilityInterval = setInterval(() => {
+				this.checkAgentAvailability();
+			}, 60000);
+		}
+
+		if (
+			this.messengerOptions.initialView &&
+			this.messengerOptions.initialView !== this.messengerState.currentView
+		) {
+			this.messengerState.setView(this.messengerOptions.initialView);
+		}
 	}
 
 	onDestroy() {

package/src/widgets/SurveyWidget.js

@@ -8,6 +8,8 @@ export class SurveyWidget extends BaseWidget {
 			surveyId: options.surveyId || null,
 			surveyType: options.surveyType || 'nps',
 			position: options.position || 'bottom-right',
+			enabled:
+				typeof options.enabled === 'boolean' ? options.enabled : undefined,
 			title: options.title || null,
 			description: options.description || null,
 			lowLabel: options.lowLabel || null,
@@ -61,6 +63,15 @@ export class SurveyWidget extends BaseWidget {
 	}
 
 	show() {
+		if (this.options.enabled === false || this.surveyOptions.enabled === false) {
+			this.sdk.eventBus.emit('survey:suppressed', {
+				widget: this,
+				surveyId: this.surveyOptions.surveyId,
+				reason: 'disabled',
+			});
+			return this;
+		}
+
 		this._renderSurvey();
 		this.surveyState.isVisible = true;
 		this.sdk.eventBus.emit('survey:shown', {

package/types/index.d.ts

@@ -4,10 +4,14 @@ declare module '@product7/feedback-sdk' {
 		userContext?: UserContext;
 		debug?: boolean;
 		boardId?: string;
+		siteId?: string;
+		sessionToken?: string;
 		position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
 		theme?: 'light' | 'dark';
 		apiUrl?: string;
 		autoShow?: boolean;
+		mock?: boolean;
+		env?: string;
 		widgets?: WidgetConfigMap;
 	}
 
@@ -24,6 +28,7 @@ declare module '@product7/feedback-sdk' {
 	}
 
 	export interface ButtonWidgetOptions {
+		enabled?: boolean;
 		position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
 		theme?: 'light' | 'dark';
 		boardId?: string;
@@ -74,6 +79,9 @@ declare module '@product7/feedback-sdk' {
 			config?: any;
 			sessionToken?: string;
 			expiresIn?: number;
+			status?: boolean;
+			message?: string | null;
+			configVersion?: number | null;
 		}>;
 		createWidget(type: 'button', options?: ButtonWidgetOptions): ButtonWidget;
 		createWidget(type: 'survey', options?: SurveyWidgetOptions): SurveyWidget;
@@ -148,6 +156,7 @@ declare module '@product7/feedback-sdk' {
 	}
 
 	export interface SurveyWidgetOptions {
+		enabled?: boolean;
 		surveyId?: string | null;
 		surveyType?: SurveyType;
 		position?: 'bottom-right' | 'bottom-left' | 'center' | 'bottom';
@@ -221,6 +230,7 @@ declare module '@product7/feedback-sdk' {
 	}
 
 	export interface ChangelogWidgetOptions {
+		enabled?: boolean;
 		position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
 		theme?: 'light' | 'dark';
 		triggerText?: string;
@@ -250,6 +260,7 @@ declare module '@product7/feedback-sdk' {
 	}
 
 	export interface MessengerWidgetOptions {
+		enabled?: boolean;
 		position?: 'bottom-right' | 'bottom-left';
 		theme?: 'light' | 'dark';
 		teamName?: string;
@@ -258,6 +269,25 @@ declare module '@product7/feedback-sdk' {
 		welcomeMessage?: string;
 		enableHelp?: boolean;
 		enableChangelog?: boolean;
+		enableNews?: boolean;
+		autoLoadData?: boolean;
+		initialView?: 'home' | 'messages' | 'chat' | 'prechat' | 'help' | 'changelog';
+		previewData?: {
+			conversations?: any[];
+			helpArticles?: any[];
+			homeChangelogItems?: any[];
+			changelogItems?: any[];
+			unreadCount?: number;
+			currentView?: string;
+			availability?: {
+				agentsOnline?: boolean;
+				agents_online?: boolean;
+				onlineCount?: number;
+				online_count?: number;
+				responseTime?: string;
+				response_time?: string;
+			};
+		};
 		logoUrl?: string;
 		primaryColor?: string;
 		featuredContent?: {