@pendo/agent 2.310.0 → 2.311.0

package/dist/dom.esm.js

@@ -5375,7 +5375,7 @@ var shadowAPI = (function () {
                 if (!isShadowSelector(selection)) {
                     var queryResults_1 = Sizzle(selection, context, results, seed);
                     if (shadowDomManager.cache.size > 0) {
-                        // eslint-disable-next-line agent-eslint-rules/no-array-foreach
+                        // eslint-disable-next-line web-sdk-eslint-rules/no-array-foreach
                         shadowDomManager.cache.forEach(function (shadowRoot) {
                             if (!context || context === document || contains(context, shadowRoot)) {
                                 queryResults_1.push.apply(queryResults_1, Sizzle(selection, shadowRoot, results, seed));
@@ -6178,14 +6178,20 @@ var ConfigReader = (function () {
     *
     * key - Actual config property name. Allows for disambiguation for the same property from different sources
     */
-    function addOption(name, sources, defaultValue, anySource) {
+    function addOption(name, sources, defaultValue, anySource, aliases) {
         if (sources === void 0) { sources = [PENDO_CONFIG_SRC]; }
+        if (aliases === void 0) { aliases = []; }
         if (!name)
             return;
         if (optionMap[name])
             return;
+        if (!_.isArray(aliases)) {
+            // not using logging here to keep circular dependency issues clean
+            aliases = [];
+        }
         var opt = {
             name: name,
+            aliases: aliases,
             defaultValue: defaultValue,
             supportedSources: sources
         };
@@ -6193,13 +6199,20 @@ var ConfigReader = (function () {
             opt.useAnySource = anySource;
         }
         optionMap[name] = opt;
+        if (aliases.length > 0) {
+            _.each(aliases, function (alias) {
+                if (optionMap[alias] !== undefined)
+                    return;
+                optionMap[alias] = opt;
+            });
+        }
     }
     function initializeOptions() {
         // Core
         /**
          * Formerly `additionalApiKeys`. When included, all analytics events will be sent to each of the public app IDs in the list (guide events are
          * only sent to the primary public app ID). This will only function if there are no `additionalPublicAppIds` set on
-         * the configuration included in the downloaded Agent.
+         * the configuration included in the downloaded web SDK.
          *
          * @access public
          * @category Config/Core
@@ -6225,8 +6238,8 @@ var ConfigReader = (function () {
          */
         addOption('annotateUrl', [SNIPPET_SRC]);
         /**
-         * Formerly `apiKey`. A primary public app ID to send data to from the Agent. This will only function if there is no `publicAppId` set
-         * on the configuration included in the downloaded Agent.
+         * Formerly `apiKey`. A primary public app ID to send data to from the web SDK. This will only function if there is no `publicAppId` set
+         * on the configuration included in the downloaded web SDK.
          *
          * @access public
          * @category Config/Core
@@ -6238,7 +6251,7 @@ var ConfigReader = (function () {
         addOption('apiKey', [PENDO_CONFIG_SRC, SNIPPET_SRC]);
         addOption('assetHost', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * If set to `true`, the agent will try to install and initialize in all same-origin frames on the page.
+         * If set to `true`, the web SDK will try to install and initialize in all same-origin frames on the page.
          * Read more about [frame support](/advanced/auto-frame-install).
          *
          * @access public
@@ -6262,7 +6275,7 @@ var ConfigReader = (function () {
          */
         addOption('contentHost', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * A unique domain to append to cookies that the Agent stores. If this is set, the Agent will not use local
+         * A unique domain to append to cookies that the web SDK stores. If this is set, the web SDK will not use local
          * storage but will store all information as cookies using this domain. If not set, the browser will use
          * the current domain when setting cookies. **Note:** The domain must match the domain of the JavaScript
          * origin. Setting cookies to foreign domains will be silently ignored.
@@ -6288,7 +6301,7 @@ var ConfigReader = (function () {
         addOption('dataHost', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         addOption('disableAutoInitialize');
         /**
-         * Although the name refers to cookies, if set to `true` the Agent will not persist any data in local
+         * Although the name refers to cookies, if set to `true` the web SDK will not persist any data in local
          * storage or cookies and will rely only on memory.
          *
          * @access public
@@ -6299,7 +6312,7 @@ var ConfigReader = (function () {
          */
         addOption('disableCookies', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * If set to `true` the Agent will cancel out of initialization. This can be useful to disable the Agent
+         * If set to `true` the web SDK will cancel out of initialization. This can be useful to disable the web SDK
          * with minimal code changes.
          *
          * @access public
@@ -6310,9 +6323,9 @@ var ConfigReader = (function () {
          */
         addOption('disablePendo', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         /**
-         * By default, the Agent will store the most recently used visitor and account ids as well as historical
-         * metadata. These stored values will be used if the agent is initialized in the future without them.
-         * Setting this to `true` will mean the agent will not store these values but will only use what is provided
+         * By default, the web SDK will store the most recently used visitor and account ids as well as historical
+         * metadata. These stored values will be used if the web SDK is initialized in the future without them.
+         * Setting this to `true` will mean the web SDK will not store these values but will only use what is provided
          * or fall back to anonymous ids.
          *
          * @access public
@@ -6325,7 +6338,7 @@ var ConfigReader = (function () {
         addOption('enableSignedMetadata', [PENDO_CONFIG_SRC], false);
         /**
          * By default, the identity of a visitor in various iframes on a page are independent from each other.
-         * Setting this to `true` will instead have the Agent make sure all frames use the exact same visitor and
+         * Setting this to `true` will instead have the web SDK make sure all frames use the exact same visitor and
          * account information. Read more about [frame support](/advanced/auto-frame-install).
          *
          * @access public
@@ -6350,7 +6363,7 @@ var ConfigReader = (function () {
         /**
          * Having identity persisted by default makes it so that a transition from using identified visitor ids
          * to using anonymous visitor ids is challenging. Anyone that used your application with an identified
-         * visitor id would have that value persisted to storage and whenever they agent is initialized for them,
+         * visitor id would have that value persisted to storage and whenever the web SDK is initialized for them,
          * that value would be read from storage treating them as the same identified visitor. When set `true`,
          * this config option will only use persisted identity values if they are an anonymous id. It is meant to
          * be used to smoothly make this transition to using anonymous ids while still retaining the benefit of
@@ -6367,7 +6380,7 @@ var ConfigReader = (function () {
         addOption('identityStorageLifetime', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         addOption('identityStorageSuffix', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * If set to `true`, the Agent will strip url fragments from the url used for events (everything after a `#`
+         * If set to `true`, the web SDK will strip url fragments from the url used for events (everything after a `#`
          * symbol). **Deprecated:** new usages to edit the url for events should use the
          * [location api](/advanced/location).
          *
@@ -6379,8 +6392,8 @@ var ConfigReader = (function () {
          */
         addOption('ignoreHashRouting', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * By default, the Agent will wait until the `document.readyState` is set to `"complete"`. Setting this to
-         * `true` will allow the Agent to initialize while the document is still loading.
+         * By default, the web SDK will wait until the `document.readyState` is set to `"complete"`. Setting this to
+         * `true` will allow the web SDK to initialize while the document is still loading.
          *
          * @access public
          * @category Config/Core
@@ -6391,7 +6404,7 @@ var ConfigReader = (function () {
         addOption('initializeImmediately', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         addOption('installType');
         /**
-         * If set to `true`, the Agent will only persist data using local storage and memory.
+         * If set to `true`, the web SDK will only persist data using local storage and memory.
          *
          * @access public
          * @category Config/Core
@@ -6401,7 +6414,7 @@ var ConfigReader = (function () {
          */
         addOption('localStorageOnly', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * If set to `false`, the Agent will not use the `History.pushState` api to detect changes to the browser's
+         * If set to `false`, the web SDK will not use the `History.pushState` api to detect changes to the browser's
          * URL. Instead a poll will be used. This can be necessary to disable for some SFDC applications.
          *
          * @access public
@@ -6414,8 +6427,8 @@ var ConfigReader = (function () {
         addOption('maxCookieTTLDays', [SNIPPET_SRC, PENDO_CONFIG_SRC], Infinity);
         /**
          * Use this setting when using `preferMutationObserver` with an application that has Shadow DOM elements.
-         * On page load, the Agent will run a full document scan for shadow roots and attach a MutationObserver to
-         * all results. This setting also allows the agent to run CSS selectors in all shadow roots, so CSS selectors
+         * On page load, the web SDK will run a full document scan for shadow roots and attach a MutationObserver to
+         * all results. This setting also allows the web SDK to run CSS selectors in all shadow roots, so CSS selectors
          * can be written without specifying the full path through all shadow roots with the `::shadow` pseudo-class.
          *
          * @access public
@@ -6428,8 +6441,8 @@ var ConfigReader = (function () {
         addOption('pendoCore', [PENDO_CONFIG_SRC], true);
         addOption('pendoGlobalKey', [PENDO_CONFIG_SRC]);
         /**
-         * By default, if there are multiple frames on the page that have the Agent installed, they will communicate
-         * using `window.postMessage`. If set to `true` the Agent will instead use the browser's Broadcast Channel
+         * By default, if there are multiple frames on the page that have the web SDK installed, they will communicate
+         * using `window.postMessage`. If set to `true` the web SDK will instead use the browser's Broadcast Channel
          * API to communicate. This will only work when all frames use the same domain.
          *
          * @access public
@@ -6440,8 +6453,8 @@ var ConfigReader = (function () {
          */
         addOption('preferBroadcastChannel', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         /**
-         * By default, the Agent will scan the page every 500ms to determine if any new badges or guides are eligible.
-         * To improve idle performance, this can be set to `true` and then the Agent will instead use a mutation
+         * By default, the web SDK will scan the page every 500ms to determine if any new badges or guides are eligible.
+         * To improve idle performance, this can be set to `true` and then the web SDK will instead use a mutation
          * observer and only check eligibility if the page content has changed.
          *
          * @access public
@@ -6453,8 +6466,8 @@ var ConfigReader = (function () {
         addOption('preferMutationObserver', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         addOption('preventCookieRefresh');
         /**
-         * By default, the Agent adds an `unload` event listener to the page to make sure it sends events upon
-         * navigation. If set to `true`, the Agent will instead use the `visibilitychange` event listener and send
+         * By default, the web SDK adds an `unload` event listener to the page to make sure it sends events upon
+         * navigation. If set to `true`, the web SDK will instead use the `visibilitychange` event listener and send
          * events when the visibility is changing to `"hidden"`.
          *
          * @access public
@@ -6466,7 +6479,7 @@ var ConfigReader = (function () {
         addOption('preventUnloadListener', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         addOption('promotedAgentMetadataConfigurations', [PENDO_CONFIG_SRC]);
         /**
-         * An array of strings or a function that returns an array of strings. The Agent will then strip any query
+         * An array of strings or a function that returns an array of strings. The web SDK will then strip any query
          * string parameters from the url that are not found in the provided array. **Deprecated:** new usages to
          * edit the url for events should use the [location api](/advanced/location).
          *
@@ -6492,7 +6505,7 @@ var ConfigReader = (function () {
         addOption('sanitizeUrl', [SNIPPET_SRC]);
         addOption('selfHosted');
         /**
-         * Meant to be used with `autoFrameInstall`. If set, the Agent will use this as the url to download the Agent
+         * Meant to be used with `autoFrameInstall`. If set, the web SDK will use this as the url to download itself
          * from in child frames. Read more about [frame support](/advanced/auto-frame-install).
          *
          * @access public
@@ -6519,7 +6532,7 @@ var ConfigReader = (function () {
         // Analytics
         /**
          * An array of exact strings that can still be included in event data if text capture is disabled
-         * (`excludeAllText`). This will override any allow list that is stored for your application settings.
+         * (`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')
          *
@@ -6529,9 +6542,9 @@ var ConfigReader = (function () {
          * @default []
          * @type {string[]}
          */
-        addOption('allowedText', [SNIPPET_SRC, PENDO_CONFIG_SRC], []);
+        addOption('allowedText', [PENDO_CONFIG_SRC, SNIPPET_SRC], [], true);
         /**
-         * An array of specific Pendo events that you do not want the Agent to capture. Available event types
+         * An array of specific Pendo events that you do not want the web SDK to capture. Available event types
          * include: `identify`, `meta`, `load`, `click`, `focus`, `submit`, `change`, `track`. See [Event Controls](/events/event-controls)
          * for more information.
          *
@@ -6553,7 +6566,7 @@ var ConfigReader = (function () {
          */
         addOption('analytics.localStorageUnload', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         /**
-         * If set to `true`, the Agent will log out when various events internal to the Agent occur.
+         * If set to `true`, the web SDK will log when various internal events occur.
          *
          * @access public
          * @category Config/Analytics
@@ -6577,7 +6590,7 @@ var ConfigReader = (function () {
          */
         addOption('eventPropertyMatchParents', [SNIPPET_SRC, PENDO_CONFIG_SRC], true);
         /**
-         * By default, the Agent will include text from elements while capturing events. Setting this to `true` will
+         * By default, the web SDK will include text from elements while capturing events. Setting this to `true` will
          * instead prevent the text from being included unless it matches the `allowedText` list. If the subscription
          * flag to disable text capture is turned on, this option cannot be used to reenable it.
          *
@@ -6589,7 +6602,7 @@ var ConfigReader = (function () {
          */
         addOption('excludeAllText', [PENDO_CONFIG_SRC, SNIPPET_SRC], false, true);
         /**
-         * When `true`, the Agent will only send guide and poll events. All other events will not be sent, including:
+         * When `true`, the web SDK will only send guide and poll events. All other events will not be sent, including:
          * identify, meta, load, click, focus, change, submit, or track. Metadata assigned to visitors will still function
          * for guide targeting but will not be sent to Pendo to be visible in the UI. See [Event Controls](/events/event-controls)
          * for more information.
@@ -6605,7 +6618,7 @@ var ConfigReader = (function () {
         addOption('htmlAttributes');
         addOption('interceptElementRemoval', [SNIPPET_SRC, PENDO_CONFIG_SRC], false); // old, use syntheticClicks.elementRemoval instead
         /**
-         * By default, the agent will attempt to intercept calls to `preventDefault` on `touchend` events in order to
+         * By default, the web SDK will attempt to intercept calls to `preventDefault` on `touchend` events in order to
          * ensure that Pendo still tracks the click event. There are cases where your application might prevent these
          * original clicks in order to synthesize your own click event, in that case and where you might be seeing
          * duplicate clicks because of it, this functionality can be disabled.
@@ -6618,7 +6631,7 @@ var ConfigReader = (function () {
          */
         addOption('interceptPreventDefault', [SNIPPET_SRC, PENDO_CONFIG_SRC], true);
         /**
-         * By default, the agent will also attempt to intercept calls to `stopPropagation` and
+         * 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
          * functionality can be disabled.
@@ -6633,7 +6646,7 @@ var ConfigReader = (function () {
         /**
          * Sometimes an application removes an event that is clicked on between the `mousedown` and `mouseup` browser
          * events. In these cases, Pendo will not be able to capture the `click` event properly for events or guide
-         * behavior. Setting this to `true` will have the Agent intercept these types of element removal to ensure
+         * behavior. Setting this to `true` will have the web SDK intercept these types of element removal to ensure
          * more consistent Pendo behavior (this option has been moved from `interceptElementRemoval`).
          *
          * @access public
@@ -6693,7 +6706,7 @@ var ConfigReader = (function () {
         addOption('cacheGuidesTimeout', [PENDO_CONFIG_SRC], 600000);
         addOption('delayGuides', [SNIPPET_SRC]); // old, use guides.delay instead
         /**
-         * If `true`, this will prevent the agent from attempting to launch the Visual Design Studio.
+         * If `true`, this will prevent the web SDK from attempting to launch the Visual Design Studio.
          *
          * @access public
          * @category Config/Guides
@@ -6704,7 +6717,7 @@ var ConfigReader = (function () {
         addOption('disableDesigner', [PENDO_CONFIG_SRC, SNIPPET_SRC], false);
         addOption('disableDesignerKeyboardShortcut', [PENDO_CONFIG_SRC], false);
         /**
-         * If `true`, this will prevent the agent from downloading your application's
+         * If `true`, this will prevent the web SDK from downloading your application's
          * [global css](https://support.pendo.io/hc/en-us/articles/360032206511-Guide-Styling-Classic-#global-css-0-2)
          * file as well as the default classic guide css.
          *
@@ -6740,7 +6753,7 @@ var ConfigReader = (function () {
          */
         addOption('disablePrefetch', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * If `true`, the agent 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
@@ -6860,8 +6873,8 @@ var ConfigReader = (function () {
          */
         addOption('guides.tooltip.arrowSize', [SNIPPET_SRC]);
         /**
-         * If set, the agent will attach the provided value as a [nonce](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP#nonces)
-         * onto all inline stylesheets the agent adds. This is used to remove the need for "unsafe-inline" on the "style-src" of your
+         * If set, the web SDK will attach the provided value as a [nonce](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP#nonces)
+         * onto all inline stylesheets the web SDK adds. This is used to remove the need for "unsafe-inline" on the "style-src" of your
          * CSP and will support live guides as well as Visual Design Studio users.
          *
          * @access public
@@ -6915,7 +6928,7 @@ var ConfigReader = (function () {
         addOption('feedbackSettings', [PENDO_CONFIG_SRC], {});
         addOption('pendoFeedback', [PENDO_CONFIG_SRC], false);
         /**
-         * If set, the Agent will use this as the suffix when writing last step advanced key into the visitors cookie.
+         * 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.
          *
          * @access public
@@ -6926,7 +6939,7 @@ var ConfigReader = (function () {
          */
         addOption('crossAppGuideStorageSuffix', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
-         * If `true`, the Agent will launch a version of the Designer that is compatible with the
+         * If `true`, the web SDK will launch a version of the Designer that is compatible with the
          * `Cross-Origin-Embedder-Policy: require-corp` header.
          *
          * @access public
@@ -7428,7 +7441,7 @@ function applyMatrix2dRect(matrix2d, rect) {
     return transformedRect;
 }
 
-var VERSION = '2.310.0_';
+var VERSION = '2.311.0_';
 
 var decodeURIComponent = _.isFunction(window.decodeURIComponent) ? window.decodeURIComponent : _.identity;