@sprig-technologies/sprig-browser 2.14.0 → 2.14.4

package/controller/controller.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Initialize frame and bootstrap data
+ * @param {Object} config this is included in the compilation step (points to the default viewSDKURL)
+ * @param {String} config.envId Environment Id
+ * @param {String} config.path Frame script url
+ * @param {String} [config.border] Border color
+ */
+export default function sprigInitializer(config?: {
+    envId: string;
+    path: string;
+    border?: string;
+}): void;
+//# sourceMappingURL=controller.d.ts.map

package/controller/controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../../sprig-browser/controller/controller.js"],"names":[],"mappings":"AA68BA;;;;;;GAMG;AACH;IAJ0B,KAAK;IACL,IAAI;IACH,MAAM;SAkFhC"}

package/controller/controller.js

@@ -7,7 +7,7 @@ import ConflictingWidgets from '../shared/conflicting_widgets';
 import { APP_MODES, CSS_CONSTANTS } from '../shared/constants';
 import { ulFetch, killNetworkRequests, getHttpHeaders } from '../shared/network';
 import { createFrame, createContainer, removeContainerOnClose, removeContainer } from '../controller/iframe';
-import './queue';
+import { UserLeapQueue } from './queue';
 import eventEmitter from '../shared/eventEmitter';
 import { ulEvents, DISMISS_REASONS, SURVEY_STATE, internalEvents } from '../shared/ulEvents';
 import { calculateFrameHeight, overrideStyles } from '../shared/tool';
@@ -20,6 +20,7 @@ import {
   MOBILE_PLATFORM_HEADERS,
   INSTALLATION_METHOD,
 } from '../shared/constants';
+import { encodedViewJs } from './encodedViewJs';
 
 const credentialsStorageKey = 'userleap.ids';
 const pageViewsStorageKey = 'userleap.pageviews';
@@ -66,7 +67,7 @@ function shouldDisplaySurveyAfterDelay(triggeringEventId, trackStartUrl) {
 function locationChangeHandler(event) {
   const { pageUrlEvents, interactiveEvents, dismissOnPageChange, platform } = UserLeap._config;
   if (platform && platform !== 'web') return; // we should clean this up during web sdk controller refactor along with the should direct embed
-  if (pageUrlEvents) UserLeap.trackPageView(window.location.href);
+  if (pageUrlEvents) trackPageView(window.location.href);
   if (interactiveEvents) {
     // need to remove old listeners bc current page may not be targeted
     removeInteractiveEventListener();
@@ -117,7 +118,7 @@ function apiUrl(version, fillPaths, trailing) {
     fillPaths.forEach((p) => {
       components.push(p);
       if (p === PATH_ENV) components.push(UserLeap.envId);
-      else if (p === PATH_VISITOR) components.push(UserLeap.widgetGetVID());
+      else if (p === PATH_VISITOR) components.push(widgetGetVID());
     });
   }
   if (trailing) components.push(trailing);
@@ -209,13 +210,11 @@ function generateVisitorId() {
   eventEmitter.emit(ulEvents.VISITOR_ID_UPDATED, { visitorId: UserLeap.visitorId });
 }
 
-UserLeap.UPDATES = ulEvents;
-
-UserLeap.widgetGetVID = function() {
+function widgetGetVID() {
   return window.previewMode ? 0 : UserLeap.visitorId;
-};
+}
 
-UserLeap.trackPageView = function(location) {
+function trackPageView(location) {
   if (!UserLeap.localStorageAvailable) return;
   if (location.endsWith('mock_snippet.html')) {
     return;
@@ -283,7 +282,7 @@ UserLeap.trackPageView = function(location) {
     console.warn(`[Sprig] (ERR-425) Failed to update page views in local storage`);
     UserLeap.reportError('trackPageView', err);
   }
-};
+}
 
 function bindTrackingEvents() {
   const historyRef = 'Backbone' in window && window.Backbone && Backbone.history ? Backbone.history : window.history;
@@ -308,8 +307,8 @@ function bindTrackingEvents() {
   registerEventListeners();
 }
 
-UserLeap.getQuestions = async function(options, submitAnswers) {
-  const visitorId = UserLeap.widgetGetVID();
+async function getQuestions(options, submitAnswers) {
+  const visitorId = widgetGetVID();
   if (options && !submitAnswers) {
     UserLeap._config.mode = APP_MODES.test;
   }
@@ -322,10 +321,10 @@ UserLeap.getQuestions = async function(options, submitAnswers) {
     return { success: false, surveyState: SURVEY_STATE.NO_SURVEY };
   }
   response.json.delay && (await delay(response.json.delay));
-  return UserLeap.displayQuestions(response.json);
-};
+  return displayQuestions(response.json);
+}
 
-UserLeap.displayQuestions = function(responseJson) {
+function displayQuestions(responseJson) {
   const { vid, uuid, questions, surveyId, context, locale, responseGroupUid, endCard, productConfig } = responseJson;
   const experimentFlags = responseJson.experimentFlags || {};
   const headers = getHttpHeaders(UserLeap);
@@ -435,8 +434,7 @@ UserLeap.displayQuestions = function(responseJson) {
   }
 
   if (config.installationMethod === INSTALLATION_METHOD.NPM) {
-    const encodedViewJs = require('./encodedViewJs');
-    frameScript.textContent = atob(encodedViewJs.default);
+    frameScript.textContent = atob(encodedViewJs);
   } else {
     frameScript.src = frameSrc;
     contentWindow.addEventListener(
@@ -454,7 +452,7 @@ UserLeap.displayQuestions = function(responseJson) {
   }
   contentWinDocHead.appendChild(frameScript);
   return { success: true, surveyState: SURVEY_STATE.READY };
-};
+}
 
 function calculateUseMobileStyling(headers) {
   if (UserLeap.useMobileStyling !== undefined) return UserLeap.useMobileStyling;
@@ -486,9 +484,10 @@ function shuffleInteractiveEvents(events) {
  * Gather identifier data, retrieve questions, and render widget
  * @param  {Object} config [description]
  */
-UserLeap.widgetInitialize = function(config) {
+function widgetInitialize(config) {
   if (!config) return;
   UserLeap._config = config;
+
   if (config.mute) {
     // Userleap.mute isn't defined yet
     UserLeap._queue.pause();
@@ -501,7 +500,7 @@ UserLeap.widgetInitialize = function(config) {
     bindTrackingEvents();
     locationChangeHandler();
   }
-};
+}
 
 async function authenticatedFetch(url, options, attempt = 0, shouldDropOnRateLimit = false) {
   options.headers = Object.assign(getHttpHeaders(UserLeap), options.headers);
@@ -533,13 +532,18 @@ const __enableUserLeapAPIActions = function(config) {
     return;
   }
 
-  const identifyAndTrackHelper = async (payload) => {
+  const identifyAndTrackHelper = async (payload = {}) => {
     const { userId, anonymousId, metadata = {} } = payload;
     let { eventName } = payload;
     if (UserLeap.debugMode && eventName !== PAGE_URL_EVENT_NAME) console.log('[DEBUG] Sprig track', arguments);
     if (config.mode === 'test') {
       return;
     }
+    if (config.requireUserIdForTracking && !UserLeap.userId && !userId) {
+      const message = '[Sprig] - Skipping tracking without userId';
+      console.warn(message);
+      return { success: false, message, surveyState: SURVEY_STATE.NO_SURVEY };
+    }
     if (!eventName || eventName.trim().length === 0) {
       eventName = eventName ? String(eventName) : '';
       const message = `[Sprig] - Invalid event name ` + eventName;
@@ -583,7 +587,7 @@ const __enableUserLeapAPIActions = function(config) {
     const responseBody = result.json;
     responseBody.delay && (await delay(responseBody.delay));
     if (shouldDisplaySurveyAfterDelay(responseBody.eventId, trackStartUrl)) {
-      return UserLeap.displayQuestions(responseBody);
+      return displayQuestions(responseBody);
     } else {
       return {
         success: false,
@@ -597,17 +601,17 @@ const __enableUserLeapAPIActions = function(config) {
     // Triggers displaying specified survey. Does submit answers!
     async displaySurvey(surveyId) {
       UserLeap('dismissActiveSurvey', DISMISS_REASONS.OVERRIDE);
-      return UserLeap.getQuestions({ surveyId }, true);
+      return getQuestions({ surveyId }, true);
     },
     // Triggers displaying specified survey template. Does not submit answers
     previewSurvey(surveyTemplateId) {
       UserLeap('dismissActiveSurvey', DISMISS_REASONS.OVERRIDE);
-      UserLeap.getQuestions({ surveyTemplateId }, false);
+      getQuestions({ surveyTemplateId }, false);
     },
     // Triggers displaying specified survey. Does not submit answers
     reviewSurvey(surveyId) {
       UserLeap('dismissActiveSurvey', DISMISS_REASONS.OVERRIDE);
-      UserLeap.getQuestions({ surveyId }, false);
+      getQuestions({ surveyId }, false);
     },
     mute() {
       UserLeap._queue.pause();
@@ -629,6 +633,11 @@ const __enableUserLeapAPIActions = function(config) {
     async setAttributes(attributes) {
       if (UserLeap.debugMode) console.log('[DEBUG] Sprig setAttributes', arguments);
       if (config.mode === 'test') return;
+      if (config.requireUserIdForTracking && !UserLeap.userId) {
+        const message = '[Sprig] - Skipping tracking without userId';
+        console.warn(message);
+        return { success: false, message };
+      }
       if (attributes === null || attributes === undefined || Object.keys(attributes).length === 0) {
         const message = `[Sprig] - Disregarding empty attributes provided`;
         console.warn(message);
@@ -659,6 +668,12 @@ const __enableUserLeapAPIActions = function(config) {
       }
       const { userId, anonymousId, attributes } = payload;
 
+      if (config.requireUserIdForTracking && !UserLeap.userId && !userId) {
+        const message = '[Sprig] - Skipping tracking without userId';
+        console.warn(message);
+        return { success: false, message };
+      }
+
       if (
         // no attributes to set, and the provided userId and/or anonymousId are already set locally; nothing to do.
         !attributes &&
@@ -711,6 +726,11 @@ const __enableUserLeapAPIActions = function(config) {
         console.warn(message);
         return { success: false, message };
       }
+      if (config.requireUserIdForTracking && !UserLeap.userId) {
+        const message = '[Sprig] - Skipping tracking without userId';
+        console.warn(message);
+        return { success: false, message };
+      }
       const result = await authenticatedFetch(apiUrl(1, [PATH_ENV, PATH_VISITOR], 'attributes'), {
         body: JSON.stringify({ delete: attributes }),
         method: 'DELETE',
@@ -864,7 +884,7 @@ const __enableUserLeapAPIActions = function(config) {
  * Pulls down presentation config settings from server and
  * applies them to supplied config dict
  */
-UserLeap.applyRemoteConfig = async function(config) {
+async function applyRemoteConfig(config) {
   const headers = UserLeap.mobileHeadersJSON ? JSON.parse(UserLeap.mobileHeadersJSON) : {};
   let response = await ulFetch(apiUrl(1, [PATH_ENV], 'config'), { headers });
 
@@ -893,10 +913,10 @@ UserLeap.applyRemoteConfig = async function(config) {
   return newConfig;
 };
 
-UserLeap.reportError = async function(action, err) {
+async function reportError(action, err) {
   const mode = window.__cfg && window.__cfg.mode;
   const fetchFreshIfNotSet = false;
-  const vid = UserLeap.widgetGetVID(fetchFreshIfNotSet);
+  const vid = widgetGetVID(fetchFreshIfNotSet);
   const envId = UserLeap.envId;
   const pde = window.document.documentElement;
   const meta = {
@@ -928,9 +948,9 @@ UserLeap.reportError = async function(action, err) {
   if (!result.ok) {
     console.warn(`[Sprig] (ERR-444) Failed to report error to API`, err);
   }
-};
+}
 
-UserLeap.logoutUser = function() {
+function logoutUser() {
   if (UserLeap.debugMode) console.log('[DEBUG] Sprig logout');
   //clear in-memory
   UserLeap.visitorId = null;
@@ -949,7 +969,7 @@ UserLeap.logoutUser = function() {
   if (UserLeap._queue.isPaused()) UserLeap._queue.empty();
   generateVisitorId();
   UserLeap._queue.unpause();
-};
+}
 
 /**
  * Initialize frame and bootstrap data
@@ -961,6 +981,9 @@ UserLeap.logoutUser = function() {
 export default function sprigInitializer(config = {}) {
   async function load() {
     if (UserLeap.loaded) return;
+    UserLeap.UPDATES = ulEvents;
+    UserLeap.reportError = reportError;
+    UserLeap.logoutUser = logoutUser;
     UserLeap.loaded = true;
     //combine compile-provided config and installation-snippet config
     UserLeap._config = Object.assign({}, config, UserLeap.config);
@@ -1005,7 +1028,7 @@ export default function sprigInitializer(config = {}) {
     //Note: UserLeap._queue is an array at this point (defined in installation snippet)
     const queueItems = [...UserLeap._queue];
     //converts [] -> Queue()
-    UserLeap._queue = new UserLeap.Queue(UserLeap, []);
+    UserLeap._queue = new UserLeapQueue(UserLeap, []);
     UserLeap._queue.pause();
     for (let i = 0; i < queueItems.length; i++) {
       UserLeap._queue.push(queueItems[i]);
@@ -1021,9 +1044,9 @@ export default function sprigInitializer(config = {}) {
       if (UserLeap.localStorageAvailable) localStorage.removeItem(credentialsStorageKey);
       generateVisitorId();
     }
-    const remoteConfig = await UserLeap.applyRemoteConfig(config);
+    const remoteConfig = await applyRemoteConfig(config);
     __enableUserLeapAPIActions(remoteConfig);
-    await UserLeap.widgetInitialize(remoteConfig);
+    await widgetInitialize(remoteConfig);
     UserLeap._queue.unpause();
     eventEmitter.emit(ulEvents.SDK_READY);
     eventEmitter.emit(ulEvents.VISITOR_ID_UPDATED, { visitorId: UserLeap.visitorId });