@pendo/agent 2.313.0 → 2.314.1

package/dist/pendo.module.js

@@ -3389,7 +3389,6 @@ var ConfigReader = (function () {
          * @type {number}
          */
         addOption('guideSeenTimeoutLength', [PENDO_CONFIG_SRC, SNIPPET_SRC], 10000);
-        // addOption('guideTimeout', [SNIPPET_SRC]); // old, use guides.timeout instead
         /**
          * If `true`, guides will be verified against their saved content hash before display to ensure validity of
          * guide content.
@@ -3946,8 +3945,8 @@ let SERVER = '';
 let ASSET_HOST = '';
 let ASSET_PATH = '';
 let DESIGNER_SERVER = '';
-let VERSION = '2.313.0_';
-let PACKAGE_VERSION = '2.313.0';
+let VERSION = '2.314.1_';
+let PACKAGE_VERSION = '2.314.1';
 let LOADER = 'xhr';
 /* eslint-enable web-sdk-eslint-rules/no-gulp-env-references */
 /**
@@ -12275,16 +12274,17 @@ var JWT = (function () {
     };
 })();
 
-const MAX_BACKOFF = 6;
-const MAX_FAILURES = 100;
+const MAX_RETRY_DELAY_MS = 5 * 60 * 1000; // 5 minutes
+const ONE_HOUR = 60 * 60 * 1000; // 1 hour
+const FAILURE_WINDOW_MS = 2 * ONE_HOUR;
 class SendQueue {
-    constructor(sendFn, maxFailures = MAX_FAILURES) {
+    constructor(sendFn) {
         this.queue = [];
         this.unloads = new Set();
         this.pending = new Set();
         this.failures = new Map();
+        this.firstFailureTime = null;
         this.sendFn = sendFn;
-        this.maxFailures = maxFailures;
     }
     isEmpty() {
         return this.queue.length <= 0;
@@ -12294,6 +12294,7 @@ class SendQueue {
         this.unloads.clear();
         this.pending.clear();
         this.failures.clear();
+        this.firstFailureTime = null;
         this.stopped = true;
         clearTimeout(this.timer);
         delete this.timer;
@@ -12314,12 +12315,16 @@ class SendQueue {
     incrementFailure(payload) {
         const failureCount = (this.failures.get(payload) || 0) + 1;
         this.failures.set(payload, failureCount);
+        if (this.firstFailureTime == null) {
+            this.firstFailureTime = new Date().getTime();
+        }
         return failureCount;
     }
     pass(payload, dequeue = true) {
         this.unloads.delete(payload);
         this.pending.delete(payload);
-        this.failures.clear();
+        this.failures.delete(payload);
+        this.firstFailureTime = null;
         const index = this.queue.indexOf(payload);
         if (index >= 0) {
             this.queue.splice(index, 1);
@@ -12334,18 +12339,26 @@ class SendQueue {
         const failureCount = this.incrementFailure(payload);
         if (this.stopped || !retry)
             return;
-        if (failureCount >= this.maxFailures) {
+        const now = new Date().getTime();
+        const elapsed = now - (this.firstFailureTime || now);
+        if (elapsed >= FAILURE_WINDOW_MS) {
             if (this.onTimeout) {
                 this.onTimeout();
             }
-            this.pass(payload, false);
+            this.firstFailureTime = null;
+            this.retryLater(ONE_HOUR);
+            return;
         }
-        this.retryLater(Math.pow(2, Math.min(failureCount - 1, MAX_BACKOFF)) * 1000);
+        this.retryLater(Math.min(Math.pow(2, failureCount - 1) * 1000, MAX_RETRY_DELAY_MS));
+    }
+    retryNow() {
+        clearTimeout(this.timer);
+        delete this.timer;
+        this.next();
     }
     retryLater(delay) {
         this.timer = setTimeout$1(() => {
-            delete this.timer;
-            this.next();
+            this.retryNow();
         }, delay);
     }
     failed() {
@@ -12360,7 +12373,7 @@ class SendQueue {
     }
     drain(finalPayloadArray, isUnload = true) {
         this.queue.push(...finalPayloadArray);
-        if (this.failed())
+        if (this.failed() && !this.allowDrainWhileFailed)
             return Promise$2.reject();
         const promises = [];
         for (const payload of this.queue) {
@@ -12379,7 +12392,7 @@ class SendQueue {
 }
 
 const UNSENT_EVENTS_KEY = 'unsentEvents';
-const UNSENT_EVENTS_DURATION = 6 * 24 * 60 * 60 * 1000; // 6 days
+const UNSENT_EVENTS_MAX_AGE = 7 * 24 * 60 * 60 * 1000; // 7 days
 class LocalStorageEventBuffer {
     constructor() {
         this.events = {};
@@ -12421,7 +12434,7 @@ class LocalStorageEventBuffer {
     }
     write(storage) {
         if (_.size(this.events) > 0) {
-            storage.write(UNSENT_EVENTS_KEY, JSON.stringify(this.events), UNSENT_EVENTS_DURATION);
+            storage.write(UNSENT_EVENTS_KEY, JSON.stringify(this.events), UNSENT_EVENTS_MAX_AGE);
         }
         else {
             storage.clear(UNSENT_EVENTS_KEY);
@@ -12920,6 +12933,7 @@ function addSiloParams(options) {
         silo.params = _.extend({}, silo.params, options.params);
         silo.beacon = options.beacon;
         silo.eventLength = silo.JZB.length;
+        silo.ts = silo[0].browser_time || getNow();
         var jwtOptions = JWT.get();
         if (!_.isEmpty(jwtOptions)) {
             silo.auth = jwtOptions;
@@ -13110,6 +13124,9 @@ function createSendQueue(options, send, guaranteedSend) {
     const apiKeys = getApiKeysFromOptions(options);
     const queues = _.map(apiKeys, (apiKey, i) => {
         const queue = new SendQueue(function (request, isUnload, failureCount) {
+            if (getNow() - request.ts > UNSENT_EVENTS_MAX_AGE) {
+                return q.resolve(); // ignore event if it's too old
+            }
             if (failureCount) {
                 request.params = _.extend({}, request.params, {
                     rt: failureCount
@@ -13121,7 +13138,10 @@ function createSendQueue(options, send, guaranteedSend) {
                 }
                 return q.resolve();
             }
-            else if (isUnload) {
+            if (isUnload && queue.failed()) {
+                return q.reject();
+            }
+            if (isUnload) {
                 return guaranteedSend(apiKey, request);
             }
             else {
@@ -13131,6 +13151,7 @@ function createSendQueue(options, send, guaranteedSend) {
         queue.onTimeout = function () {
             performanceMonitor.count(BEACON_GIF_FAILURES[options.beacon]);
         };
+        queue.allowDrainWhileFailed = true;
         queue.retryPending = true;
         return queue;
     });
@@ -25978,6 +25999,9 @@ var mostRecentGuideRequest;
 var loadGuideJs = function (apiKey, params) {
     var guideRequestId = _.uniqueId();
     var deferred = q.defer();
+    if (mostRecentGuideRequest && mostRecentGuideRequest.deferred) {
+        mostRecentGuideRequest.deferred.resolve(); // make sure that we don't leave open any promises if multiple guide requests are made in quick succession
+    }
     mostRecentGuideRequest = {
         id: guideRequestId,
         deferred
@@ -26204,8 +26228,7 @@ var loadGuides = function (apiKey, visitorId, page, callback) {
             resetPendoUI();
             var lastGuideStepSeen = pendo$1.lastGuideStepSeen;
             if (!lastGuideStepSeen) {
-                log.info('lastGuideStepSeen is not set, shutting down guides');
-                return;
+                throw new Error('lastGuideStepSeen is not set, check response from guide payload');
             }
             store.dispatch('guideState/receiveLastGuideStepSeen', lastGuideStepSeen);
             lastGuideStepSeen.visitorId = visitorId;
@@ -26270,6 +26293,7 @@ var loadGuides = function (apiKey, visitorId, page, callback) {
             }
         }
     }).catch(function (err) {
+        log.info(`Error in loadGuideJs, shutting down guides, err: ${_.get(err, 'message', err || 'Unknown error')}`);
         Events.guidesFailed.trigger();
         deferred.reject(err);
     });
@@ -38501,7 +38525,6 @@ const FrustrationEvent = (function () {
 // A guide that show nested inside another element.
 // Multiple embedded guides can show at the same time.
 const buildGuideBehaviors = function ({ globalPendo, pluginApi }) {
-    const guide = this;
     const { _ } = globalPendo;
     const { store } = pluginApi;
     this.process = function () {
@@ -38558,12 +38581,6 @@ const buildGuideBehaviors = function ({ globalPendo, pluginApi }) {
         const nextStep = guide.nextStep(lastSeenStep) || firstStep;
         return nextStep.show(reason);
     };
-    // when embedded guide is initialized set the forceShowFirstStep property.
-    // This property is deleted after the guide shows because we no longer want to foce show the first step.
-    // The propert is reset on urlChanged events.
-    if (!this.hasOwnProperty('forceShowFirstStep')) {
-        this.forceShowFirstStep = _.get(guide, 'attributes.restartOnReload');
-    }
     this.isShownInThisFrame = function () {
         const guide = this;
         return _.any(guide.steps, function (step) {
@@ -38620,7 +38637,6 @@ const EmbeddedGuides = (function () {
         pluginApi.Events.on('deliverablesLoaded', clearEmbeddedGuides);
         pluginApi.Events.on('guideLoopStopped', onGuidesStopped);
         pluginApi.Events.on('guideListChanged', initializeEmbeddedGuides);
-        pluginApi.Events.on('urlChanged', setForceShowFirstStepFlags);
         pluginApi.Events.on('guideAdvanced', hideGuide);
         pluginApi.Events.on('metadata', onMetadataChange);
         pluginApi.Events.on('identify', onIdentify);
@@ -38635,7 +38651,6 @@ const EmbeddedGuides = (function () {
         pluginApi.Events.off('deliverablesLoaded', clearEmbeddedGuides);
         pluginApi.Events.off('guideLoopStopped', onGuidesStopped);
         pluginApi.Events.off('guideListChanged', initializeEmbeddedGuides);
-        pluginApi.Events.off('urlChanged', setForceShowFirstStepFlags);
         pluginApi.Events.off('guideAdvanced', hideGuide);
         pluginApi.Events.off('metadata', onMetadataChange);
         pluginApi.Events.off('identify', onIdentify);
@@ -38700,13 +38715,6 @@ const EmbeddedGuides = (function () {
     function onIdentify() {
         setEmbeddedGuideCacheValid(false);
     }
-    // This function syncs the forceShowFirstStep with the restartOnReload property on guides
-    // This function is run on the urlChanged event.
-    function setForceShowFirstStepFlags() {
-        _.forEach(embeddedGuides, function (guide) {
-            guide.forceShowFirstStep = !!_.get(guide, 'attributes.restartOnReload');
-        });
-    }
     function extractEmbeddedGuides(guide) {
         if (isEmbedded(guide)) {
             if (!_.some(embeddedGuides, ({ id }) => id === guide.id)) {
@@ -40339,6 +40347,35 @@ class PromptPlugin {
 }
 var PromptAnalytics = new PromptPlugin();
 
+class RestartOnReload {
+    initialize(pendo, { Events }) {
+        this.pendo = pendo;
+        const { _, attachEvent } = pendo;
+        const boundSetForceShowFirstStepFlags = _.bind(this.setForceShowFirstStepFlags, this);
+        this.subscriptions = [
+            attachEvent(Events, 'deliverablesLoaded', boundSetForceShowFirstStepFlags),
+            attachEvent(Events, 'urlChanged', boundSetForceShowFirstStepFlags)
+        ];
+    }
+    teardown() {
+        this.pendo._.forEach(this.subscriptions, function (unsubscribe) {
+            unsubscribe();
+        });
+        this.subscriptions.length = 0;
+    }
+    setForceShowFirstStepFlags() {
+        const { pendo } = this;
+        const { _ } = pendo;
+        _.forEach(pendo.guides, function (guide) {
+            const restartOnReload = !!_.get(guide, 'attributes.restartOnReload');
+            if (restartOnReload) {
+                guide.forceShowFirstStep = true;
+            }
+        });
+    }
+}
+var RestartOnReload$1 = new RestartOnReload();
+
 function registerBuiltInPlugins() {
     registerPlugin(IFrameMonitor);
     registerPlugin(DOMActivation);
@@ -40358,6 +40395,7 @@ function registerBuiltInPlugins() {
     registerPlugin(WebAnalytics$1);
     registerPlugin(FormValidation);
     registerPlugin(PromptAnalytics);
+    registerPlugin(RestartOnReload$1);
 }
 
 /*
@@ -40536,6 +40574,7 @@ const substitutionRegex = '\\{(?:\\s?)([^.\\s]?visitor|account|parentAccount)\\.
 const skipStepString = '{skipStep:* *(auto|\\d+)\\/}';
 const goToMiddleString = '(?!0)(\\d+)';
 const goToString = `({goto-${goToMiddleString}\\/})`;
+const containerSelector = '[id^="pendo-guide-container"]';
 function lookupGuideButtons(domJson, buttons = []) {
     if (domJson.type === 'button' && domJson.actions) {
         buttons.push(domJson);
@@ -40573,6 +40612,7 @@ var guideMarkdownUtil = {
     substitutionRegex,
     skipStepString,
     goToString,
+    containerSelector,
     lookupGuideButtons,
     removeMarkdownSyntax
 };
@@ -40626,7 +40666,7 @@ const PollBranching = {
             attributes: true,
             childList: true,
             characterData: true,
-            subtree: false
+            subtree: true
         };
         const MutationObserver = getZoneSafeMethod$1(pendo._, 'MutationObserver');
         const observer = new MutationObserver(applyBranchingIndicators);
@@ -40745,13 +40785,13 @@ function branchingGoToStep(event, step, guide, pendo) {
     if (pollStepIndex < 0)
         return;
     const destinationObject = {
-        destinationStepId: guide.steps[pollStepIndex].id
+        destinationStepId: guide.steps[pollStepIndex].id,
+        step
     };
     pendo.goToStep(destinationObject);
     event.cancel = true;
 }
 
-const containerSelector = '[id^="pendo-guide-container"]';
 const MetadataSubstitution = {
     name: 'MetadataSubstitution',
     script(step, guide, pendo) {
@@ -40775,7 +40815,7 @@ const MetadataSubstitution = {
             attributes: true,
             childList: true,
             characterData: true,
-            subtree: false
+            subtree: true
         };
         const MutationObserver = getZoneSafeMethod$1(pendo._, 'MutationObserver');
         const observer = new MutationObserver(applySubstitutionIndicators);
@@ -40784,7 +40824,7 @@ const MetadataSubstitution = {
             pendo._.each(mutations, function (mutation) {
                 var _a;
                 if (mutation.addedNodes.length) {
-                    if (document.querySelector(containerSelector)) {
+                    if (document.querySelector(guideMarkdownUtil.containerSelector)) {
                         const placeholderData = findSubstitutableElements(pendo);
                         const step = (_a = pendo.designerv2.currentlyPreviewedGuide) === null || _a === void 0 ? void 0 : _a.steps[0];
                         if (!step)
@@ -40851,9 +40891,9 @@ function substituteMetadataByTarget(data, target, mdValue, matched) {
 }
 function updateGuideContainer(containerId, context, pendo) {
     if (pendo.designer && !pendo._.size(pendo.dom('#pendo-ps-substitution-icon'))) {
-        pendo.dom(containerSelector).append(substitutionIcon('#999', '30px'));
+        pendo.dom(guideMarkdownUtil.containerSelector).append(substitutionIcon('#999', '30px'));
     }
-    pendo.flexElement(pendo.dom(containerSelector));
+    pendo.flexElement(pendo.dom(guideMarkdownUtil.containerSelector));
     pendo.BuildingBlocks.BuildingBlockGuides.recalculateGuideHeight(containerId, context);
 }
 function findSubstitutableUrlsInJson(originalData, placeholderData = [], pendo) {
@@ -40894,7 +40934,7 @@ function findSubstitutableUrlsInJson(originalData, placeholderData = [], pendo)
     return placeholderData;
 }
 function findSubstitutableElements(pendo) {
-    let elements = pendo.dom(`${containerSelector} *:not(.pendo-inline-ui)`);
+    let elements = pendo.dom(`${guideMarkdownUtil.containerSelector} *:not(.pendo-inline-ui)`);
     return pendo._.chain(elements)
         .filter(function (placeholder) {
         const subRegex = new RegExp(guideMarkdownUtil.substitutionRegex);
@@ -41002,7 +41042,7 @@ const RequiredQuestions = {
                     });
                 }
             });
-            step.attachEvent(step.guideElement.find('[id^="pendo-guide-container"]')[0], 'click', function (event) {
+            step.attachEvent(step.guideElement.find(guideMarkdownUtil.containerSelector)[0], 'click', function (event) {
                 if (!event.target.classList.contains('_pendo-button')) {
                     evaluateRequiredQuestions(requiredQuestions);
                 }
@@ -41173,7 +41213,7 @@ const SkipToEligibleStep = {
     script(step, guide, pendo) {
         let isAdvanceIntercepted = false;
         let isPreviousIntercepted = false;
-        let guideContainer = step.guideElement.find('#pendo-guide-container');
+        let guideContainer = step.guideElement.find(guideMarkdownUtil.containerSelector);
         let guideContainerAriaLabel = guideContainer.attr('aria-label');
         let stepNumberOrAuto = skipStepRegex.exec(guideContainerAriaLabel)[1];
         if (guideContainer) {
@@ -41185,7 +41225,7 @@ const SkipToEligibleStep = {
             let eligibleStep = findEligibleSkipStep(stepNumberOrAuto, 'next');
             if (!isAdvanceIntercepted && stepNumberOrAuto) {
                 isAdvanceIntercepted = true;
-                pendo.goToStep({ destinationStepId: eligibleStep.id });
+                pendo.goToStep({ destinationStepId: eligibleStep.id, step });
                 evt.cancel = true;
             }
         });
@@ -41195,7 +41235,7 @@ const SkipToEligibleStep = {
             let eligibleStep = findEligibleSkipStep(stepNumberOrAuto, 'previous');
             if (!isPreviousIntercepted && stepNumberOrAuto) {
                 isPreviousIntercepted = true;
-                pendo.goToStep({ destinationStepId: eligibleStep.id });
+                pendo.goToStep({ destinationStepId: eligibleStep.id, step });
                 evt.cancel = true;
             }
         });
@@ -41205,10 +41245,10 @@ const SkipToEligibleStep = {
             let skipForwardStep = findStepOnPage(guide.getPositionOfStep(step), 'next', stepNumber);
             let skipPreviousStep = findStepOnPage(guide.getPositionOfStep(step) - 2, 'previous', stepNumber);
             if (skipForwardStep && direction == 'next') {
-                pendo.goToStep({ destinationStepId: skipForwardStep });
+                pendo.goToStep({ destinationStepId: skipForwardStep, step });
             }
             if (skipPreviousStep && direction == 'previous') {
-                pendo.goToStep({ destinationStepId: skipPreviousStep });
+                pendo.goToStep({ destinationStepId: skipPreviousStep, step });
             }
             return direction === 'next' ? skipForwardStep : skipPreviousStep;
         }
@@ -41234,7 +41274,7 @@ const SkipToEligibleStep = {
     },
     test(step, guide, pendo) {
         var _a;
-        const guideContainerAriaLabel = (_a = step.guideElement) === null || _a === void 0 ? void 0 : _a.find('#pendo-guide-container').attr('aria-label');
+        const guideContainerAriaLabel = (_a = step.guideElement) === null || _a === void 0 ? void 0 : _a.find(guideMarkdownUtil.containerSelector).attr('aria-label');
         return pendo._.isString(guideContainerAriaLabel) && guideContainerAriaLabel.indexOf('{skipStep') !== -1;
     },
     designerListener(pendo) {
@@ -41244,7 +41284,7 @@ const SkipToEligibleStep = {
             attributes: true,
             childList: true,
             characterData: true,
-            subtree: false
+            subtree: true
         };
         const MutationObserver = getZoneSafeMethod$1(pendo._, 'MutationObserver');
         const observer = new MutationObserver(applySkipStepIndicator);
@@ -41255,14 +41295,14 @@ const SkipToEligibleStep = {
                 var _a, _b;
                 const nodeHasQuerySelector = pendo._.isFunction((_a = mutation.addedNodes[0]) === null || _a === void 0 ? void 0 : _a.querySelectorAll);
                 if (mutation.addedNodes.length && nodeHasQuerySelector) {
-                    let guideContainer = mutation.addedNodes[0].querySelectorAll('#pendo-guide-container');
+                    let guideContainer = mutation.addedNodes[0].querySelectorAll(guideMarkdownUtil.containerSelector);
                     let guideContainerAriaLabel = (_b = guideContainer[0]) === null || _b === void 0 ? void 0 : _b.getAttribute('aria-label');
                     if (guideContainerAriaLabel) {
                         if (guideContainerAriaLabel.match(skipStepRegex)) {
                             let fullSkipStepString = guideContainerAriaLabel.match(skipStepRegex)[0];
                             guideContainerAriaLabel.replace(fullSkipStepString, '');
                             if (!pendo.dom('#_pendoSkipIcon').length) {
-                                pendo.dom('#pendo-guide-container').append(skipIcon('#999', '30px').trim());
+                                pendo.dom(guideMarkdownUtil.containerSelector).append(skipIcon('#999', '30px').trim());
                             }
                         }
                     }
@@ -48566,16 +48606,17 @@ class SessionRecorderBuffer {
     }
 }
 
-const MAX_BACKOFF = 6;
-const MAX_FAILURES = 100;
+const MAX_RETRY_DELAY_MS = 5 * 60 * 1000; // 5 minutes
+const ONE_HOUR = 60 * 60 * 1000; // 1 hour
+const FAILURE_WINDOW_MS = 2 * ONE_HOUR;
 class SendQueue {
-    constructor(sendFn, maxFailures = MAX_FAILURES) {
+    constructor(sendFn) {
         this.queue = [];
         this.unloads = new Set();
         this.pending = new Set();
         this.failures = new Map();
+        this.firstFailureTime = null;
         this.sendFn = sendFn;
-        this.maxFailures = maxFailures;
     }
     isEmpty() {
         return this.queue.length <= 0;
@@ -48585,6 +48626,7 @@ class SendQueue {
         this.unloads.clear();
         this.pending.clear();
         this.failures.clear();
+        this.firstFailureTime = null;
         this.stopped = true;
         clearTimeout(this.timer);
         delete this.timer;
@@ -48605,12 +48647,16 @@ class SendQueue {
     incrementFailure(payload) {
         const failureCount = (this.failures.get(payload) || 0) + 1;
         this.failures.set(payload, failureCount);
+        if (this.firstFailureTime == null) {
+            this.firstFailureTime = new Date().getTime();
+        }
         return failureCount;
     }
     pass(payload, dequeue = true) {
         this.unloads.delete(payload);
         this.pending.delete(payload);
-        this.failures.clear();
+        this.failures.delete(payload);
+        this.firstFailureTime = null;
         const index = this.queue.indexOf(payload);
         if (index >= 0) {
             this.queue.splice(index, 1);
@@ -48625,18 +48671,26 @@ class SendQueue {
         const failureCount = this.incrementFailure(payload);
         if (this.stopped || !retry)
             return;
-        if (failureCount >= this.maxFailures) {
+        const now = new Date().getTime();
+        const elapsed = now - (this.firstFailureTime || now);
+        if (elapsed >= FAILURE_WINDOW_MS) {
             if (this.onTimeout) {
                 this.onTimeout();
             }
-            this.pass(payload, false);
+            this.firstFailureTime = null;
+            this.retryLater(ONE_HOUR);
+            return;
         }
-        this.retryLater(Math.pow(2, Math.min(failureCount - 1, MAX_BACKOFF)) * 1000);
+        this.retryLater(Math.min(Math.pow(2, failureCount - 1) * 1000, MAX_RETRY_DELAY_MS));
+    }
+    retryNow() {
+        clearTimeout(this.timer);
+        delete this.timer;
+        this.next();
     }
     retryLater(delay) {
         this.timer = setTimeout$1(() => {
-            delete this.timer;
-            this.next();
+            this.retryNow();
         }, delay);
     }
     failed() {
@@ -48651,7 +48705,7 @@ class SendQueue {
     }
     drain(finalPayloadArray, isUnload = true) {
         this.queue.push(...finalPayloadArray);
-        if (this.failed())
+        if (this.failed() && !this.allowDrainWhileFailed)
             return Promise$2.reject();
         const promises = [];
         for (const payload of this.queue) {
@@ -56940,7 +56994,6 @@ var ConfigReader = (function () {
          * @type {number}
          */
         addOption('guideSeenTimeoutLength', [PENDO_CONFIG_SRC, SNIPPET_SRC], 10000);
-        // addOption('guideTimeout', [SNIPPET_SRC]); // old, use guides.timeout instead
         /**
          * If `true`, guides will be verified against their saved content hash before display to ensure validity of
          * guide content.