@pendo/agent 2.280.1 → 2.281.0

package/dist/pendo.module.js

@@ -3901,8 +3901,8 @@ var SERVER = '';
 var ASSET_HOST = '';
 var ASSET_PATH = '';
 var DESIGNER_ENV = '';
-var VERSION = '2.280.1_';
-var PACKAGE_VERSION = '2.280.1';
+var VERSION = '2.281.0_';
+var PACKAGE_VERSION = '2.281.0';
 var LOADER = 'xhr';
 /* eslint-enable agent-eslint-rules/no-gulp-env-references */
 /**
@@ -8699,6 +8699,13 @@ function dom(selection, context) {
     });
     self.context = context;
     self.length = nodes.length;
+    if (typeof Symbol !== 'undefined' && Symbol.iterator) {
+        self[Symbol.iterator] = function* () {
+            for (const node of nodes) {
+                yield node;
+            }
+        };
+    }
     return self;
 }
 
@@ -11264,6 +11271,7 @@ class ElementGetter {
         if (el && isInDoc)
             return el;
         if (el && !isInDoc) {
+            this.teardown(el);
             return undefined;
         }
         el = dom(this.cssSelector)[0];
@@ -11288,15 +11296,14 @@ class ElementGetter {
                 el.addEventListener(event, (e) => this.onEvent(e));
             }
         }
-        this.listeners[event] = this.listeners[event]
-            ? this.listeners[event].push(callback) : [].concat(callback);
+        this.listeners[event] = this.listeners[event] || [];
+        this.listeners[event].push(callback);
     }
     onEvent(evt) {
         const type = evt.type;
         _.each(this.listeners[type], (cb) => cb(evt));
     }
-    teardown() {
-        const el = this.get();
+    teardown(el = this.get()) {
         if (el) {
             _.each(this.events, (evtType) => el.removeEventListener(evtType, this.onEvent));
         }
@@ -23862,13 +23869,16 @@ var onGuideDismissed = function (evt, step) {
     }
 };
 /**
- * Snoozes the current guide. Guide will redisplay after snooze length, or default
- * of one day. If another guide is eligible to be shown, it will show after snooze.
+ * Snoozes the current guide. If another guide is eligible to be shown automatically, it will show after snooze.
+ * Guide will redisplay after one day by default, or a custom `snoozeDuration` can be set in milliseconds as the third argument.
  *
  * @access public
  * @category Guides
  * @example
  * pendo.onGuideSnoozed()
+ * @example
+ * pendo.onGuideSnoozed(null, null, 30 * 60 * 1000)
+ * // snoozes guide for 30 minutes
  */
 var onGuideSnoozed = function (evt, step, snoozeDuration) {
     log.info('onGuideSnoozed called', { 'contexts': ['guides'] });
@@ -36574,7 +36584,7 @@ class SessionManager {
     }
     isExpired(sessionInfo, timestamp) {
         const prevLastEmitTime = _.get(sessionInfo, 'timestamp');
-        if (prevLastEmitTime && timestamp - prevLastEmitTime > this.inactivityDuration) {
+        if (!this.pendo._.isNumber(prevLastEmitTime) || timestamp - prevLastEmitTime > this.inactivityDuration) {
             return true;
         }
         return false;
@@ -36843,7 +36853,6 @@ function calculateReferrerValue({ referrer, currentHost }) {
     const referrerHost = referrerUrl.hostname;
     let referrerValue = 'self';
     if (referrerHost !== currentHost) {
-        // TODO: what about subdomains or other variations you own that you'd rather consider 'self' instead?
         referrerValue = referrerHost === null || referrerHost === void 0 ? void 0 : referrerHost.toLowerCase();
     }
     return referrerValue;
@@ -36857,60 +36866,65 @@ const paidMediumRegex = new RegExp('^(.*cp.*|ppc|retargeting)$');
 // add other email-related values here, if needed
 const emailRegex = new RegExp('(.*email.*|.*e_mail.*|.*e mail.*|.*e-mail.*)', 'i');
 const channels = [
-    ['Email', ({ source, medium, referrer }) => {
-            return referrer === 'direct' &&
-                (medium.match(emailRegex) !== null ||
-                    source.match(emailRegex) !== null ||
-                    medium === 'newsletter');
+    [undefined, ({ medium, source, referrer, gclid, fbclid }) => {
+            return !medium && !source && referrer === 'self' && !gclid && !fbclid;
+        }],
+    ['Direct', ({ source, medium, referrer }) => {
+            return !medium && (!source || source === 'direct') && referrer === 'direct';
+        }],
+    ['Cross-network', ({ source, medium }) => {
+            return medium === 'cross-network' || source.match(crossNetworkPlatformsRegex);
         }],
     ['Paid Search', ({ source, medium, gclid, _ }) => {
             return gclid ||
                 medium === 'paid-search' ||
                 (medium.match(paidMediumRegex) && _.contains(searchProviders, source));
         }],
-    ['Organic Search', ({ source, medium, referrer, _ }) => {
-            return (medium === 'organic' && _.contains(searchProviders, source)) || (!medium && isReferral(searchProviderRegex, referrer));
-        }],
-    ['Display', ({ medium, _ }) => {
-            return _.contains(['display', 'cpm', 'banner', 'interstitial', 'expandable', 'programmatic'], medium);
-        }],
     ['Paid Social', ({ source, medium, fbclid, _ }) => {
             return fbclid ||
                 medium === 'paid-social' ||
                 (medium.match(paidMediumRegex) && _.contains(socialMediaSources, source));
         }],
+    ['Paid Video', ({ medium, source, _ }) => {
+            return medium == 'paid-video' ||
+                (!medium.match(paidMediumRegex) && _.contains(videoSites, source));
+        }],
+    ['Paid Shopping', ({ medium }) => {
+            return medium == 'shopping' || medium == 'paid-shopping';
+        }],
+    ['Display', ({ medium, _ }) => {
+            return _.contains(['display', 'cpm', 'banner', 'interstitial', 'expandable', 'programmatic'], medium);
+        }],
+    ['Paid Other', ({ medium, source, _ }) => {
+            // Must be after all other paid channels in the list
+            return medium == 'paid-other' ||
+                medium.match(paidMediumRegex);
+        }],
+    ['Organic Search', ({ source, medium, referrer, _ }) => {
+            return (medium === 'organic' && _.contains(searchProviders, source)) || (!medium && isReferral(searchProviderRegex, referrer));
+        }],
     ['Organic Social', ({ source, medium, referrer, _ }) => {
             return (!medium && isReferral(socialMediaRegex, referrer)) ||
                 medium === 'social' ||
                 _.contains(socialMediaSources, source);
         }],
-    ['Paid Shopping', ({ medium }) => {
-            return medium == 'shopping' || medium == 'paid-shopping';
+    ['Organic Video', ({ medium, referrer }) => {
+            return medium === 'video' ||
+                (!medium && isReferral(videoRegex, referrer));
         }],
     ['Organic Shopping', ({ medium, referrer }) => {
             return medium === 'organic-shopping' ||
                 (!medium && isReferral(shoppingRegex, referrer));
         }],
-    ['Paid Video', ({ medium, source, _ }) => {
-            return medium == 'paid-video' ||
-                (!medium.match(paidMediumRegex) && _.contains(videoSites, source));
-        }],
-    ['Organic Video', ({ medium, referrer }) => {
-            return medium === 'video' ||
-                (!medium && isReferral(videoRegex, referrer));
+    ['Email', ({ source, medium, referrer }) => {
+            return referrer === 'direct' &&
+                (medium.match(emailRegex) !== null ||
+                    source.match(emailRegex) !== null ||
+                    medium === 'newsletter');
         }],
     ['Affiliates', ({ medium }) => {
             return medium === 'affiliate' || medium === 'partner';
         }],
-    ['Audio', ({ medium }) => {
-            return medium === 'podcast' || medium === 'audio';
-        }],
-    ['Cross-network', ({ source, medium }) => {
-            return medium === 'cross-network' || source.match(crossNetworkPlatformsRegex);
-        }],
-    ['Other Advertising', ({ medium }) => {
-            return medium === 'cpv' || medium === 'cpa';
-        }],
     ['SMS', ({ source, medium }) => {
             return source === 'sms' || medium === 'sms';
         }],
@@ -36919,20 +36933,15 @@ const channels = [
                 medium.indexOf('notification') >= 0 ||
                 source === 'firebase';
         }],
+    ['Audio', ({ medium }) => {
+            return medium === 'podcast' || medium === 'audio';
+        }],
     ['Referral', ({ medium, referrer }) => {
             return medium === 'referral' ||
                 (!!referrer && referrer !== 'self' && referrer !== 'direct');
         }],
-    ['Paid Other', ({ medium, source, _ }) => {
-            // Must be after all other paid channels in the list
-            return medium == 'paid-other' ||
-                medium.match(paidMediumRegex);
-        }],
-    ['Other', ({ medium }) => {
-            return !!medium;
-        }],
-    ['Direct', ({ source, medium }) => {
-            return !medium && !source;
+    ['Other', ({ medium, source }) => {
+            return !!medium || !!source;
         }]
 ];
 const WEB_ANALYTICS_STORAGE_KEY = 'utm';
@@ -36974,39 +36983,35 @@ class WebAnalytics {
         const locationUrl = new URL(url);
         const currentHost = locationUrl.hostname;
         const referrerValue = calculateReferrerValue({ referrer, currentHost });
-        // Check if this is a self-referral.
-        if (referrerValue !== 'self') {
-            const parsedUrl = this.api.util.parseUrl(url);
-            if (!parsedUrl)
-                return {};
-            const { query } = parsedUrl;
-            // It is not a self referral, therefore we should calculate the channel and track the visit
-            const source = query.utm_source;
-            const medium = query.utm_medium;
-            const campaign = query.utm_campaign;
-            const term = query.utm_term;
-            const content = query.utm_content;
-            const gclid = query.gclid;
-            const fbclid = query.fbclid;
-            if (this.pendo._.compact([source, medium, campaign, term, content, gclid]).length) {
-                const utm = {
-                    source,
-                    medium,
-                    campaign,
-                    term,
-                    content
-                };
-                utm.channel = this.calculateUtmChannel({ referrerValue, utm, gclid, fbclid });
-                if (referrer && this.api.ConfigReader.get(CAPTURE_REFERRER_CONFIG_KEY)) {
-                    utm.referrer = referrer;
-                }
-                else if (referrerValue !== 'direct') {
-                    utm.referrer = referrerValue;
-                }
-                return utm;
-            }
+        const parsedUrl = this.api.util.parseUrl(url);
+        if (!parsedUrl)
+            return {};
+        const { query } = parsedUrl;
+        const source = query.utm_source;
+        const medium = query.utm_medium;
+        const campaign = query.utm_campaign;
+        const term = query.utm_term;
+        const content = query.utm_content;
+        const gclid = query.gclid;
+        const fbclid = query.fbclid;
+        const utm = {
+            source,
+            medium,
+            campaign,
+            term,
+            content
+        };
+        utm.channel = this.calculateUtmChannel({ referrerValue, utm, gclid, fbclid });
+        if (referrer && this.api.ConfigReader.get(CAPTURE_REFERRER_CONFIG_KEY)) {
+            utm.referrer = referrer;
         }
-        return {};
+        else if (referrerValue === 'self') {
+            utm.referrer = currentHost;
+        }
+        else if (referrerValue !== 'direct') {
+            utm.referrer = referrerValue;
+        }
+        return utm;
     }
     calculateUtmChannel({ referrerValue, utm, gclid, fbclid }) {
         var _a, _b;
@@ -37024,11 +37029,9 @@ class WebAnalytics {
         if (channelPair) {
             return channelPair[0];
         }
-        return 'Direct';
     }
     storeParameters(params, storage) {
         if (this.pendo._.size(params) > 0) {
-            this.utm = params;
             storage.write(WEB_ANALYTICS_STORAGE_KEY, JSON.stringify(params), undefined, false, true, this.suffix);
         }
     }
@@ -37044,16 +37047,20 @@ class WebAnalytics {
             unsubscribe();
         }
         this.subscriptions.length = 0;
-        this.utm = null;
     }
     addUtmToEvent(event) {
-        if (this.utm) {
+        let utm;
+        try {
+            utm = this.loadParameters(this.api.agentStorage);
+        }
+        catch (e) {
+        }
+        if (utm) {
             const capturedEvent = event.data[0];
-            capturedEvent.utm = this.utm;
+            capturedEvent.utm = utm;
         }
     }
     sessionChanged() {
-        this.utm = null;
         const agentStorage = this.api.agentStorage;
         agentStorage.clear(WEB_ANALYTICS_STORAGE_KEY);
         agentStorage.clear(WEB_ANALYTICS_STORAGE_KEY, false, this.suffix);
@@ -37617,7 +37624,7 @@ class DOMPrompt {
             // capture value from copy / paste
             this.capturePromptValue();
         }, true);
-        this.inputEl.addEventListener('keydown', (evt) => {
+        this.inputEl.addEventListener('keyup', (evt) => {
             const wasEnterKey = evt.code === 'Enter';
             this.capturePromptValue(wasEnterKey);
             if (wasEnterKey) {
@@ -37625,6 +37632,7 @@ class DOMPrompt {
             }
         }, true);
         this.submitEl.addEventListener('click', () => {
+            this.capturePromptValue();
             this.submit(this.latestPromptValue);
         }, true);
         this.promptContainer = new this.dom.Observer();
@@ -37638,14 +37646,15 @@ class DOMPrompt {
     }
     /*
     * Genernally we want to capture the value from "input" but there can be implementation
-    * dependent scenarios where the input's value has already been cleared by the time we
-    * get the event handler is called. So, in that case, we don't want to throw our saved value out.
+    * dependent scenarios where the input's value has already been cleared by the time
+    * the event handler is called. So, in that case, we don't want to throw our saved value out.
     */
     capturePromptValue(onlyUpdateIfNotEmpty = false) {
         const tmp = this.getPromptValue();
         if (tmp || !onlyUpdateIfNotEmpty) {
             this.latestPromptValue = tmp;
         }
+        return tmp;
     }
     getPromptValue() {
         return this.inputEl.getText();
@@ -49310,6 +49319,11 @@ function initCanvasWebGLMutationObserver(cb, win, blockClass, blockSelector) {
     handlers.forEach((h) => h());
   };
 }
+function WorkerWrapper(options) {
+  return function() {
+    return { onerror: null, onmessage: null };
+  };
+}
 class CanvasManager {
   constructor(options) {
     __publicField(this, "pendingCanvasMutations", /* @__PURE__ */ new Map());
@@ -49340,6 +49354,10 @@ class CanvasManager {
     this.mirror = options.mirror;
     if (recordCanvas && sampling === "all")
       this.initCanvasMutationObserver(win, blockClass, blockSelector);
+    if (recordCanvas && typeof sampling === "number")
+      this.initCanvasFPSObserver(sampling, win, blockClass, blockSelector, {
+        dataURLOptions
+      });
   }
   reset() {
     this.pendingCanvasMutations.clear();
@@ -49357,6 +49375,100 @@ class CanvasManager {
   unlock() {
     this.locked = false;
   }
+  initCanvasFPSObserver(fps, win, blockClass, blockSelector, options) {
+    const canvasContextReset = initCanvasContextObserver(
+      win,
+      blockClass,
+      blockSelector,
+      true
+    );
+    const snapshotInProgressMap = /* @__PURE__ */ new Map();
+    const worker = new WorkerWrapper();
+    worker.onmessage = (e2) => {
+      const { id } = e2.data;
+      snapshotInProgressMap.set(id, false);
+      if (!("base64" in e2.data)) return;
+      const { base64, type, width, height } = e2.data;
+      this.mutationCb({
+        id,
+        type: CanvasContext["2D"],
+        commands: [
+          {
+            property: "clearRect",
+            // wipe canvas
+            args: [0, 0, width, height]
+          },
+          {
+            property: "drawImage",
+            // draws (semi-transparent) image
+            args: [
+              {
+                rr_type: "ImageBitmap",
+                args: [
+                  {
+                    rr_type: "Blob",
+                    data: [{ rr_type: "ArrayBuffer", base64 }],
+                    type
+                  }
+                ]
+              },
+              0,
+              0
+            ]
+          }
+        ]
+      });
+    };
+    const timeBetweenSnapshots = 1e3 / fps;
+    let lastSnapshotTime = 0;
+    let rafId;
+    const getCanvas = () => {
+      const matchedCanvas = [];
+      win.document.querySelectorAll("canvas").forEach((canvas) => {
+        if (!isBlocked(canvas, blockClass, blockSelector, true)) {
+          matchedCanvas.push(canvas);
+        }
+      });
+      return matchedCanvas;
+    };
+    const takeCanvasSnapshots = (timestamp) => {
+      if (lastSnapshotTime && timestamp - lastSnapshotTime < timeBetweenSnapshots) {
+        rafId = requestAnimationFrame(takeCanvasSnapshots);
+        return;
+      }
+      lastSnapshotTime = timestamp;
+      getCanvas().forEach(async (canvas) => {
+        var _a2;
+        const id = this.mirror.getId(canvas);
+        if (snapshotInProgressMap.get(id)) return;
+        if (canvas.width === 0 || canvas.height === 0) return;
+        snapshotInProgressMap.set(id, true);
+        if (["webgl", "webgl2"].includes(canvas.__context)) {
+          const context = canvas.getContext(canvas.__context);
+          if (((_a2 = context == null ? void 0 : context.getContextAttributes()) == null ? void 0 : _a2.preserveDrawingBuffer) === false) {
+            context.clear(context.COLOR_BUFFER_BIT);
+          }
+        }
+        const bitmap = await createImageBitmap(canvas);
+        worker.postMessage(
+          {
+            id,
+            bitmap,
+            width: canvas.width,
+            height: canvas.height,
+            dataURLOptions: options.dataURLOptions
+          },
+          [bitmap]
+        );
+      });
+      rafId = requestAnimationFrame(takeCanvasSnapshots);
+    };
+    rafId = requestAnimationFrame(takeCanvasSnapshots);
+    this.resetObservers = () => {
+      canvasContextReset();
+      cancelAnimationFrame(rafId);
+    };
+  }
   initCanvasMutationObserver(win, blockClass, blockSelector) {
     this.startRAFTimestamping();
     this.startPendingCanvasMutationFlusher();