@pendo/agent 2.326.0 → 2.328.0

package/dist/dom.esm.js

@@ -5058,16 +5058,17 @@ var SizzleProxy = wrapSizzle(Sizzle);
  * pendo.dom('h1')[0].remove()
  * @example
  * pendo.dom('.left').css({ 'text-align': 'center' })
- */ /**
-* Creates new DOM elements from HTML text.
-*
-* @param {string} htmlString  HTML syntax used to produce new DOM elements
-* @returns {DomQuery} array with the matching elements
-* @access public
-* @category DOM
-* @example
-* pendo.dom('<div><span>this should create an unattached DOM node</span></div>');
-*/
+ */
+/**
+ * Creates new DOM elements from HTML text.
+ *
+ * @param {string} htmlString  HTML syntax used to produce new DOM elements
+ * @returns {DomQuery} array with the newly created elements
+ * @access public
+ * @category DOM
+ * @example
+ * pendo.dom('<div><span>this should create an unattached DOM node</span></div>');
+ */
 function dom(selection, context) {
     var self = this;
     var nodes;
@@ -5141,11 +5142,11 @@ function dom(selection, context) {
 }
 
 /**
- * Utility function to check if passed value exists. Returns false for `null` and `undefined`.
+ * Utility function to check if the passed value exists. Returns false for `null` and `undefined`.
  *
  * @access public
  * @category Utility
- * @param {any} value argument to type check
+ * @param {any} arg value to type check
  * @returns {Boolean}
  * @example
  * pendo.doesExist(null) => false
@@ -6373,7 +6374,7 @@ var ConfigReader = (function () {
          *
          * @access public
          * @category Config/Core
-         * @name forceLeader
+         * @name forcedLeader
          * @default false
          * @type {boolean}
          */
@@ -6560,7 +6561,7 @@ var ConfigReader = (function () {
          * An array of exact strings that can still be included in event data if text capture is disabled
          * (`excludeAllText`). This will not override any allow list specified by your application settings but will apply if none is provided.
          * These are not selectors but are equality checks (the string 'Bug' will allow links that have 'Bug' as the
-         * text to be captured but not ones like 'Bug Report')
+         * text to be captured but not ones like 'Bug Report').
          *
          * @access public
          * @category Config/Analytics
@@ -6658,7 +6659,7 @@ var ConfigReader = (function () {
         /**
          * By default, the web SDK will also attempt to intercept calls to `stopPropagation` and
          * `stopImmediatePropagation` for click, focus, submit, and change events in order to ensure that Pendo can
-         * still probably recognize these events. In the case of this causing duplicate events or other issues, this
+         * still properly recognize these events. In the case of this causing duplicate events or other issues, this
          * functionality can be disabled.
          *
          * @access public
@@ -6721,7 +6722,7 @@ var ConfigReader = (function () {
          */
         addOption('cacheGuides', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         /**
-         * How often to clear the guides cache (in milliseconds)
+         * How often to clear the guides cache (in milliseconds).
          *
          * @access public
          * @category Config/Guides
@@ -6755,7 +6756,7 @@ var ConfigReader = (function () {
         addOption('disableGlobalCSS', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         /**
          * Building block guides use an inline style tag for various pseudo styles (e.g. hover, carets, animations).
-         * These can be turned off using this flag for application's with more restrictive CSP settings but will
+         * These can be turned off using this flag for applications with more restrictive CSP settings but will
          * require custom effort to reach style parity.
          *
          * @access public
@@ -6781,7 +6782,7 @@ var ConfigReader = (function () {
          * cookies, localStorage, click tracking, and metadata. Only displays guides
          * that have been configured explicitly to show to this visitor.
          *
-         * @access public
+         * @access private
          * @category Config/Guides
          * @name doNotTrackGuides
          * @default false
@@ -6789,7 +6790,7 @@ var ConfigReader = (function () {
          */
         addOption('doNotTrackGuides', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * If `true`, the web SDK will listen for `alt+shift+8` on the keyboard and try to launch the designer (). The
+         * If `true`, the web SDK will listen for `alt+shift+8` on the keyboard and try to launch the designer. The
          * keyboard shortcut requires the guide launch modal of Engage to be open in another tab showing the shortcut.
          *
          * @access public
@@ -6867,7 +6868,7 @@ var ConfigReader = (function () {
          */
         addOption('guides.disabled', [SNIPPET_SRC], false, undefined, ['disableGuides']);
         /**
-         * If 'true', guides with slow selectors will be removed from guide display processing.
+         * If `true`, guides with slow selectors will be removed from guide display processing.
          * This will improve application performance, but slow guides will not be shown to users.
          *
          * @access public
@@ -6923,7 +6924,7 @@ var ConfigReader = (function () {
          */
         addOption('inlineStyleNonce', [SNIPPET_SRC]);
         /**
-         * Formerly `leaderKey` Specify a preferred publicAppId to lead the multi-application iframe installation to make decisions about automatic
+         * Formerly `leaderKey`. Specify a preferred publicAppId to lead the multi-application iframe installation to make decisions about automatic
          * guide display. In installations with more than 2 publicAppIds, the leaderApplication can be specified as a priority
          * list (e.g. `leaderApplication: ['key1', 'key2', ...]`). Either all frames must agree on the leaderApplication setting,
          * or only one frame should specify the leaderApplication. If neither of these conditions are met, the default leader
@@ -6953,7 +6954,7 @@ var ConfigReader = (function () {
         addOption('storage.allowKeys', [SNIPPET_SRC], '*');
         // Feedback
         /**
-         * If Feedback is setup for your subscription, this option can be used to selectively disable Feedback.
+         * If Feedback is set up for your subscription, this option can be used to selectively disable Feedback.
          *
          * @access public
          * @category Config/Core
@@ -6966,8 +6967,8 @@ var ConfigReader = (function () {
         addOption('feedbackSettings', [PENDO_CONFIG_SRC], {});
         addOption('pendoFeedback', [PENDO_CONFIG_SRC], false);
         /**
-         * If set, the web SDK will use this as the suffix when writing last step advanced key into the visitors cookie.
-         * This supports cross app guides by having a shared accessible location for different apps on the same effective level domain.
+         * If set, the web SDK will use this as the suffix when writing the last step advanced key into the visitor's cookie.
+         * This supports cross-app guides by having a shared accessible location for different apps on the same effective level domain.
          *
          * @access public
          * @category Config/Core
@@ -7496,7 +7497,7 @@ function applyMatrix2dRect(matrix2d, rect) {
     return transformedRect;
 }
 
-var VERSION = '2.326.0_';
+var VERSION = '2.328.0_';
 
 var decodeURIComponent = _.isFunction(window.decodeURIComponent) ? window.decodeURIComponent : _.identity;
 
@@ -8368,6 +8369,7 @@ Eventable.clear = function (events) {
         new EventType('segmentFlagsReady', [DEBUG, LIFECYCLE]),
         new EventType('segmentFlagsError', [DEBUG, LIFECYCLE]),
         new EventType('guideListChanged', [DEBUG, LIFECYCLE]),
+        new EventType('guidesReceived', [DEBUG, LIFECYCLE]),
         new EventType('guideSeen', [DEBUG, LIFECYCLE]),
         new EventType('guideNotSeen', [DEBUG, LIFECYCLE]),
         new EventType('guideAdvanced', [DEBUG, LIFECYCLE]),
@@ -8814,8 +8816,8 @@ var isUnlocked = function () {
  * Check if the Element has this classname.
  *
  * @alias hasClass
- * @param {element} elem The Element to test for the classname
- * @param {String} class The classname to look for on the element
+ * @param {element} ele The Element to test for the classname
+ * @param {String} cls The classname to look for on the element
  * @returns {Boolean}
  * @access public
  * @category DOM
@@ -8855,7 +8857,7 @@ var _addClass = function (ele, cls) {
     }
 };
 /**
- * Remove a classname from an Elements classlist.
+ * Remove a classname from an Element's classlist.
  *
  * @alias removeClass
  * @param {element} ele The Element from which the class will be removed
@@ -8878,7 +8880,7 @@ var _removeClass = function (ele, cls) {
     }
 };
 /**
- * Sets the classname from an Element.
+ * Sets the classname for an Element.
  *
  * @alias setClass
  * @param {element} ele The Element that will get the new classlist.
@@ -9544,8 +9546,8 @@ DomQuery.$ = {
         return newDom;
     },
     /**
-     * Iterate over each element in the DomQuery list and call the provide callback function passing in the
-     * the element as the argument.
+     * Iterate over each element in the DomQuery list and call the provided callback function passing in the
+     * element as the argument.
      *
      * @function each
      * @param {function} callback The callback to be called for each element in the list
@@ -9567,7 +9569,7 @@ DomQuery.$ = {
      * Iterate over each element in the DomQuery list and create and append the Elements represented by the HTML string provided.
      *
      * @function html
-     * @param {String} htmlString String representing html to be created as dom Elements for each of the Elements in the list.
+     * @param {String} content String representing html to be created as dom Elements for each of the Elements in the list.
      * @returns {DomQuery}
      * @category DOMQuery
      * @access public
@@ -9588,7 +9590,7 @@ DomQuery.$ = {
      * Iterate over each element in the DomQuery list and add the text provided as innerText on the element.
      *
      * @function text
-     * @param {String} content String to be added as innerText
+     * @param {String} content String to be added as innerText.
      * @returns {DomQuery}
      * @access public
      * @category DOMQuery
@@ -9653,7 +9655,7 @@ DomQuery.$ = {
         });
     },
     /**
-     * Iterate over each element and checks for each class name. Returns true if all elements have each classname.
+     * Iterate over each element and check for each class name. Returns true if all elements have each classname.
      *
      * @function hasClass
      * @param {String} classNames Space separated string of classnames.
@@ -9676,7 +9678,7 @@ DomQuery.$ = {
         return allElemsHaveClass;
     },
     /**
-     * Iterate over each element and toggle each class name on or off depending on the
+     * Iterate over each element and toggle each class name on or off depending on
      * the current state of the element.
      *
      * @function toggleClass
@@ -9704,7 +9706,7 @@ DomQuery.$ = {
      * Iterate over each element and apply the styles object.
      *
      * @function css
-     * @param {Object} styles Object containing style attributes names and values
+     * @param {Object} styles Object containing style attribute names and values.
      * @returns {DomQuery}
      * @access public
      * @category DOMQuery
@@ -9758,7 +9760,7 @@ DomQuery.$ = {
         return self;
     },
     /**
-     * Add all elements in the list as top most child nodes of the first element found for the given selector.
+     * Add all elements in the list as topmost child nodes of the first element found for the given selector.
      *
      * @function prependTo
      * @param {String} selector CSS selector to identify the target parent element
@@ -9773,10 +9775,10 @@ DomQuery.$ = {
         return this;
     },
     /**
-     * Add all children from the selector as top most children of the first element in this list
+     * Add all children from the selector as topmost children of the first element in this list.
      *
      * @function prepend
-     * @param {String} selector CSS selector to identify top most child element(s)
+     * @param {String} selector CSS selector to identify topmost child element(s)
      * @returns {DomQuery}
      * @access public
      * @category DOMQuery
@@ -9800,7 +9802,7 @@ DomQuery.$ = {
         return self;
     },
     /**
-     * Return the parent node of the first element in this list
+     * Return the parent node of the first element in this list.
      *
      * @function getParent
      * @returns {element}
@@ -9817,7 +9819,7 @@ DomQuery.$ = {
     },
     /**
      * For the first element in this list, insert the first element from the selector before it
-     * in parent element's child nodes list.
+     * in the parent element's child nodes list.
      *
      * @function insertBefore
      * @param {String} selector CSS selector for the element to be inserted before this element
@@ -9856,7 +9858,7 @@ DomQuery.$ = {
         return this;
     },
     /**
-     * Iterate over each element and set the attribute name to the specified value
+     * Iterate over each element and set the attribute name to the specified value.
      *
      * @function attr
      * @param {String} attrName Name of attribute to set
@@ -9917,10 +9919,10 @@ DomQuery.$ = {
         return dom(this[index]);
     },
     /**
-     * Set the height or unset the height for the first element in the list
+     * Set the height or unset the height for the first element in the list.
      *
      * @function height
-     * @param {Number} height The new height to set. Undefined will remove the height allow it to auto determined.
+     * @param {Number} height The new height to set. Undefined will remove the height and allow it to be auto determined.
      * @returns {DomQuery}
      * @access public
      * @category DOMQuery
@@ -9941,10 +9943,10 @@ DomQuery.$ = {
         }
     },
     /**
-     * Set the width or unset the width for the first element in the list
+     * Set the width or unset the width for the first element in the list.
      *
      * @function width
-     * @param {Number} width The new width to set. Undefined will remove the width allow it to auto determined.
+     * @param {Number} width The new width to set. Undefined will remove the width and allow it to be auto determined.
      * @returns {DomQuery}
      * @access public
      * @category DOMQuery
@@ -9965,7 +9967,7 @@ DomQuery.$ = {
         }
     },
     /**
-     * For each element in the list, call the element's focus method if it exists
+     * For each element in the list, call the element's focus method if it exists.
      *
      * @function focus
      * @returns {DomQuery}