Add visitor support

global_config.json

@@ -7,6 +7,10 @@
   // "useJWT": true, // Whether or not to enable JWT. If true, the apiKey will be hidden from the build output and the token must be specified through manual initialization.
   "sessionTrackingEnabled": true, // Whether or not session tracking is enabled for all pages
   "analyticsEventsEnabled": true, // Whether or not to submit user interaction analytics events
+  // "visitor": { // Information about the visitor interacting with the experience
+  //   "id": "<ID_HERE>", // The ID associated with the visitor
+  //   "idMethod": "<ID_METHOD_HERE>" // The method used to generate the visitor ID (e.g. 'YEXT_USER for Yext Auth')
+  // },
   "logo": "", // The link to the logo for open graph meta tag - og:image.
   "favicon": "",
   "googleTagManagerName": "dataLayer", // The name of your Google Tag Manager data layer

static/js/answers-experience.js

@@ -2,6 +2,7 @@ import DeferredPromise from './deferred-promise';
 import analyticsListener from './runtime-config-listeners/analytics';
 import sessionTrackingListener from './runtime-config-listeners/session-tracking';
 import querySourceListener from './runtime-config-listeners/query-source';
+import visitorListener from './runtime-config-listeners/visitor';
 
 /**
  * @typedef {import('./runtime-config.js').RuntimeConfigListener} RuntimeConfigListener
@@ -14,7 +15,8 @@ export default class AnswersExperience {
     this._runtimeConfigListeners = [
       analyticsListener,
       sessionTrackingListener,
-      querySourceListener
+      querySourceListener,
+      visitorListener
     ];
 
     this._registerRuntimeConfigListeners();

static/js/runtime-config-listeners/visitor.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../runtime-config.js').RuntimeConfigListener}
+ */
+ export default {
+  key: 'visitor',
+  callback: value => {
+    // console.error('called');
+    ANSWERS.setVisitor(value);
+  }
+}

test-site/config/global_config.json

@@ -7,6 +7,10 @@
   // "useJWT": true, // Whether or not to enable JWT. If true, the apiKey will be hidden from the build and the token must be specified through the runtime config.
   "sessionTrackingEnabled": true, // Whether or not session tracking is enabled for all pages
   "analyticsEventsEnabled": true, // Whether or not to submit user interaction analytics events
+  // "visitor": { // Information about the user interacting with the experience
+  //   "id": "<ID_HERE>", // The ID associated with the user
+  //   "idMethod": "<ID_METHOD_HERE>" // The method used to generate the visitor ID (e.g. 'YEXT_USER for Yext Auth')
+  // },
   "logo": "", // The link to the logo for open graph meta tag - og:image.
   "favicon": "",
   "googleTagManagerName": "dataLayer", // The name of your Google Tag Manager data layer

tests/static/js/answers-experience.js

@@ -0,0 +1,12 @@
+import AnswersExperience from '../../../static/js/answers-experience';
+import RuntimeConfig from '../../../static/js/runtime-config';
+
+describe('AnswersExperience works properly', () => {
+  it('visitor listener is called when visitor is set', () => {
+    const runtimeConfig = new RuntimeConfig();
+    const experience = new AnswersExperience(runtimeConfig);
+    const callListenerSpy = jest.spyOn(experience.runtimeConfig, '_callKeySpecificListeners');
+    experience.runtimeConfig.set('visitor', { id: '123', idMethod: 'test' });
+    expect(callListenerSpy).toHaveBeenCalledWith('update', 'visitor');
+  });
+});