@pendo/web-sdk 2.312.1 → 2.314.0

package/README.md

@@ -7,7 +7,7 @@ This package is for Pendo customers who want to host the web SDK on their own in
 Install the package:
 
 ```bash
-npm install @pendo/agent
+npm install @pendo/web-sdk
 ```
 
 ## Usage
@@ -15,7 +15,7 @@ npm install @pendo/agent
 Import the package into your application code and create the web SDK using your own settings:
 
 ```javascript
-import { initialize, TextCapture } from '@pendo/agent';
+import { initialize, TextCapture } from '@pendo/web-sdk';
 import pendoConfig from '../pendo.config.json';
 
 const pendo = await initialize({
@@ -38,7 +38,7 @@ const pendo = await initialize({
 });
 ```
 
-The object returned by calling `initialize` is the same as a snippet install of the web SDK and has access to all public functions found in the public function [documentation pages](https://agent.pendo.io/public/agent).
+The object returned by calling `initialize` is the same as a snippet install of the web SDK and has access to all public functions found in the public function [documentation pages](https://web-sdk.pendo.io/public/core).
 
 ### Parameters
 
@@ -109,7 +109,7 @@ We have created an [example extension](https://github.com/pendo-io/chrome-mv3-ex
 
 ## CLI
 
-The Pendo package includes a CLI tool to be able to simplify a few actions providing greater control of the web SDK in your application. Once you have installed `@pendo/agent` in your application, you will have access to the `pendo` script from your terminal (you can also use a tool like `npx` to make use of the `pendo` script without installing the package if desired by using `npx pendo`). The usage of this script can be found below or by typing `pendo` or `pendo help` into your terminal where the package is installed:
+The Pendo package includes a CLI tool to be able to simplify a few actions providing greater control of the web SDK in your application. Once you have installed `@pendo/web-sdk` in your application, you will have access to the `pendo` script from your terminal (you can also use a tool like `npx` to make use of the `pendo` script without installing the package if desired by using `npx pendo`). The usage of this script can be found below or by typing `pendo` or `pendo help` into your terminal where the package is installed:
 
 > **Note**: If the config, copy, or designer commands are being used by your application, you might want to use those as part of your regular build process to ensure that you always maintain up to date versions of your config and of the static assets. For example, you could add a script to your package.json like below that you then call as part of your build:
 
@@ -122,7 +122,7 @@ The Pendo package includes a CLI tool to be able to simplify a few actions provi
 ```bash
 Usage: pendo <command>
 
-CLI for @pendo/agent to assist in integrating the web SDK into your application.
+CLI for @pendo/web-sdk to assist in integrating the web SDK into your application.
 
 Commands:
     pendo config            download a new web SDK configuration file for your application
@@ -132,7 +132,7 @@ Commands:
     pendo version           show the current version of the web SDK
 
 Documentation for the Pendo Web SDK can be found at:
-    https://agent.pendo.io
+    https://web-sdk.pendo.io
 ```
 
 ### Download Config
@@ -161,7 +161,7 @@ Copy static web SDK files into a local folder for self hosting. Includes guide s
 
 Options:
     --dest      required, the destination folder to copy the static files to, usually the "public" folder of your application
-    --src       optional, the location of the @pendo/agent dist folder, defaults to "./node_modules/@pendo/agent/dist"
+    --src       optional, the location of the @pendo/web-sdk dist folder, defaults to "./node_modules/@pendo/web-sdk/dist"
 
 Examples:
     Copy from the default location to your public folder

package/bin/cli.js

@@ -76,8 +76,8 @@ function copy() {
     }
 
     if (!options.src || typeof options.src !== 'string') {
-        console.debug('No "src" provided, using default of "node_modules/@pendo/agent/dist"');
-        options.src = './node_modules/@pendo/agent/dist';
+        console.debug('No "src" provided, using default of "node_modules/@pendo/web-sdk/dist"');
+        options.src = './node_modules/@pendo/web-sdk/dist';
     }
 
     function copyFiles(srcDir, destDir, files) {
@@ -100,7 +100,7 @@ Copy static Pendo Agent files into a local folder for self hosting. Includes gui
 
 Options:
     --dest      required, the destination folder to copy the static files to, usually the "public" folder of your application
-    --src       optional, the location of the @pendo/agent dist folder, defaults to "./node_modules/@pendo/agent/dist"
+    --src       optional, the location of the @pendo/web-sdk dist folder, defaults to "./node_modules/@pendo/web-sdk/dist"
 
 Examples:
     Copy from the default location to your public folder
@@ -202,18 +202,18 @@ function help() {
     if (!subCommand) {
         console.log(`Usage: pendo <command>
 
-CLI for @pendo/agent to assist in integrating the Pendo Agent into your application.
+CLI for @pendo/web-sdk to assist in integrating the Pendo Web SDK into your application.
 
 Commands:
-    pendo config            download a new Pendo Agent configuration file for your application
-    pendo copy              copy static assets for the Pendo Agent to a static folder
+    pendo config            download a new Pendo Web SDK configuration file for your application
+    pendo copy              copy static assets for the Pendo Web SDK to a static folder
     pendo designer          download new copies of the plugin files needed for the Visual Design Studio
     pendo help              provide help for how to use the Pendo CLI
     pendo help <command>    search for help on a specific <command>
-    pendo version           show the current version of the Pendo Agent
+    pendo version           show the current version of the Pendo Web SDK
 
-Documentation for the Pendo Agent can be found at:
-    https://agent.pendo.io`);
+Documentation for the Pendo Web SDK can be found at:
+    https://web-sdk.pendo.io`);
     } else if (helpers[subCommand]) {
         helpers[subCommand]();
     } else {

package/dist/dom.esm.js

@@ -6210,9 +6210,10 @@ var ConfigReader = (function () {
     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
+         * 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 web SDK.
+         * Alias: `additionalApiKeys`
          *
          * @access public
          * @category Config/Core
@@ -6220,8 +6221,7 @@ var ConfigReader = (function () {
          * @default []
          * @type {string[]}
          */
-        addOption('additionalPublicAppIds', [PENDO_CONFIG_SRC, SNIPPET_SRC]);
-        addOption('additionalApiKeys', [PENDO_CONFIG_SRC, SNIPPET_SRC]);
+        addOption('additionalPublicAppIds', [PENDO_CONFIG_SRC, SNIPPET_SRC], undefined, undefined, ['additionalApiKeys']);
         addOption('allowedOriginServers');
         addOption('allowedOriginServerHashes');
         addOption('allowMixedApplicationFrames', [SNIPPET_SRC, PENDO_CONFIG_SRC], true);
@@ -6238,8 +6238,9 @@ var ConfigReader = (function () {
          */
         addOption('annotateUrl', [SNIPPET_SRC]);
         /**
-         * 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
+         * 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.
+         * Alias: `apiKey`
          *
          * @access public
          * @category Config/Core
@@ -6247,8 +6248,7 @@ var ConfigReader = (function () {
          * @default undefined
          * @type {string}
          */
-        addOption('publicAppId', [PENDO_CONFIG_SRC, SNIPPET_SRC]);
-        addOption('apiKey', [PENDO_CONFIG_SRC, SNIPPET_SRC]);
+        addOption('publicAppId', [PENDO_CONFIG_SRC, SNIPPET_SRC], undefined, undefined, ['apiKey']);
         addOption('assetHost', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
          * If set to `true`, the web SDK will try to install and initialize in all same-origin frames on the page.
@@ -6261,7 +6261,7 @@ var ConfigReader = (function () {
          * @type {boolean}
          */
         addOption('autoFrameInstall', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
-        addOption('blockAgentMetadata', [PENDO_CONFIG_SRC], false);
+        addOption('blockWebSDKMetadata', [PENDO_CONFIG_SRC], false, undefined, ['blockAgentMetadata']);
         /**
          * An alternate url to load guide content from. This will be used to replace the standard google storage
          * url for your subscription. Usually used for
@@ -6336,6 +6336,37 @@ var ConfigReader = (function () {
          */
         addOption('disablePersistence', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         addOption('enableSignedMetadata', [PENDO_CONFIG_SRC], false);
+        /**
+         * 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 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
+         * consistent anonymous ids for visitors. This option will be ignored if you provide an identified
+         * visitorId to the initialize call.
+         *
+         * @access public
+         * @category Config/Core
+         * @name forceAnonymous
+         * @default false
+         * @type {boolean}
+         */
+        addOption('forceAnonymous', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
+        /**
+         * If set to `true`, the web SDK will prioritize this frame to use as the leader frame that will coordinate
+         * the display of guides and the resource center. The leader frame is usually the "top" frame if the SDK is initialized
+         * there and this option is meant to be used when that condition is not met or the leader should be some other
+         * specific frame. Sitewide guides and the resource center will always attempt to be shown in the leader frame
+         * first.
+         *
+         * @access public
+         * @category Config/Core
+         * @name forceLeader
+         * @default false
+         * @type {boolean}
+         */
+        addOption('forcedLeader', [SNIPPET_SRC, 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 web SDK make sure all frames use the exact same visitor and
@@ -6360,23 +6391,6 @@ var ConfigReader = (function () {
          * @type {boolean}
          */
         addOption('frameIdentityTopDownOnly', [SNIPPET_SRC, PENDO_CONFIG_SRC], true);
-        /**
-         * 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 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
-         * consistent anonymous ids for visitors. This option will be ignored if you provide an identified
-         * visitorId to the initialize call.
-         *
-         * @access public
-         * @category Config/Core
-         * @name forceAnonymous
-         * @default false
-         * @type {boolean}
-         */
-        addOption('forceAnonymous', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         addOption('identityStorageLifetime', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         addOption('identityStorageSuffix', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
         /**
@@ -6477,7 +6491,7 @@ var ConfigReader = (function () {
          * @type {boolean}
          */
         addOption('preventUnloadListener', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
-        addOption('promotedAgentMetadataConfigurations', [PENDO_CONFIG_SRC]);
+        addOption('promotedWebSDKMetadataConfigurations', [PENDO_CONFIG_SRC], undefined, undefined, ['promotedAgentMetadataConfigurations']);
         /**
          * 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
@@ -6507,14 +6521,15 @@ var ConfigReader = (function () {
         /**
          * 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).
+         * Alias: `selfHostedAgentUrl`
          *
          * @access public
          * @category Config/Core
-         * @name selfHostedAgentUrl
+         * @name selfHostedWebSDKUrl
          * @default undefined
          * @type {string}
          */
-        addOption('selfHostedAgentUrl', [SNIPPET_SRC, PENDO_CONFIG_SRC]);
+        addOption('selfHostedWebSDKUrl', [SNIPPET_SRC, PENDO_CONFIG_SRC], undefined, undefined, ['selfHostedAgentUrl']);
         /**
          * If this option is set to true, event data will only be transmitted using requests of type POST instead
          * of first trying to use GET requests. This can result in fewer requests being sent each time that event data
@@ -6616,7 +6631,6 @@ var ConfigReader = (function () {
         addOption('excludeNonGuideAnalytics', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
         addOption('htmlAttributeBlacklist');
         addOption('htmlAttributes');
-        addOption('interceptElementRemoval', [SNIPPET_SRC, PENDO_CONFIG_SRC], false); // old, use syntheticClicks.elementRemoval instead
         /**
          * 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
@@ -6648,6 +6662,7 @@ var ConfigReader = (function () {
          * 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 web SDK intercept these types of element removal to ensure
          * more consistent Pendo behavior (this option has been moved from `interceptElementRemoval`).
+         * Alias: `interceptElementRemoval`
          *
          * @access public
          * @category Config/Analytics
@@ -6655,7 +6670,7 @@ var ConfigReader = (function () {
          * @default false
          * @type {boolean}
          */
-        addOption('syntheticClicks.elementRemoval', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
+        addOption('syntheticClicks.elementRemoval', [SNIPPET_SRC, PENDO_CONFIG_SRC], false, undefined, ['interceptElementRemoval']);
         /**
          * A `click` is classified by the browser as the same element receiving the `mousedown` and `mouseup` events.
          * When `true` this option will allow Pendo to treat cases where a visitor clicks down the mouse, moves the
@@ -6704,7 +6719,6 @@ var ConfigReader = (function () {
          * @type {Number}
          */
         addOption('cacheGuidesTimeout', [PENDO_CONFIG_SRC], 600000);
-        addOption('delayGuides', [SNIPPET_SRC]); // old, use guides.delay instead
         /**
          * If `true`, this will prevent the web SDK from attempting to launch the Visual Design Studio.
          *
@@ -6740,7 +6754,6 @@ var ConfigReader = (function () {
          * @type {boolean}
          */
         addOption('disableGuidePseudoStyles', [SNIPPET_SRC, PENDO_CONFIG_SRC], false);
-        addOption('disableGuides', [SNIPPET_SRC]); // old, use guides.disabled instead
         /**
          * Content of badge and target element activated guides will be prefetched on load to improve guide display
          * time unless set to `true`.
@@ -6785,7 +6798,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.
@@ -6810,7 +6822,8 @@ var ConfigReader = (function () {
         addOption('guides.attachPoint', [SNIPPET_SRC]);
         /**
          * Guides will be loaded, but not displayed. Call `pendo.startGuides()` to display guides when you choose
-         * to do so (this options has been moved from `delayGuides`).
+         * to do so.
+         * Alias: `delayGuides`
          *
          * @access public
          * @category Config/Guides
@@ -6818,9 +6831,10 @@ var ConfigReader = (function () {
          * @default false
          * @type {boolean}
          */
-        addOption('guides.delay', [SNIPPET_SRC]);
+        addOption('guides.delay', [SNIPPET_SRC], undefined, undefined, ['delayGuides']);
         /**
          * Completely disables guides (this option has been moved from `disableGuides`).
+         * Alias: `disableGuides`
          *
          * @access public
          * @category Config/Guides
@@ -6828,7 +6842,7 @@ var ConfigReader = (function () {
          * @default false
          * @type {boolean}
          */
-        addOption('guides.disabled', [SNIPPET_SRC]);
+        addOption('guides.disabled', [SNIPPET_SRC], undefined, undefined, ['disableGuides']);
         /**
          * 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.
@@ -6854,6 +6868,7 @@ var ConfigReader = (function () {
         /**
          * How long to wait for guides to load in milliseconds (this option has been moved from `guideTimeout`).
          * By default guides will not timeout.
+         * Alias: `guideTimeout`
          *
          * @access public
          * @category Config/Guides
@@ -6861,7 +6876,7 @@ var ConfigReader = (function () {
          * @default undefined
          * @type {number}
          */
-        addOption('guides.timeout', [SNIPPET_SRC]);
+        addOption('guides.timeout', [SNIPPET_SRC], undefined, undefined, ['guideTimeout']);
         /**
          * The tooltip arrow size (in pixels). This only affects classic guides.
          *
@@ -6952,10 +6967,10 @@ var ConfigReader = (function () {
         // Adopt
         addOption('adoptHost');
         addOption('adoptAnalyticsForwarding');
-        addOption('agentDebuggerPluginLoader');
+        addOption('webSDKDebuggerPluginLoader', [PENDO_CONFIG_SRC], undefined, undefined, ['agentDebuggerPluginLoader']);
         addOption('allowPartnerAnalyticsForwarding', [SNIPPET_SRC], false);
         addOption('adoptPrioritizeAdoptGuides', [PENDO_CONFIG_SRC], false);
-        addOption('designerAgentPluginsLoader', [PENDO_CONFIG_SRC, SNIPPET_SRC]);
+        addOption('designerWebSDKPluginsLoader', [PENDO_CONFIG_SRC, SNIPPET_SRC], undefined, undefined, ['designerAgentPluginsLoader']);
         addOption('guideContentLoader', [PENDO_CONFIG_SRC]);
         addOption('trainingPartner');
         addOption('oemAccountId', [SNIPPET_SRC]);
@@ -6996,6 +7011,16 @@ var ConfigReader = (function () {
             return;
         var source = sourceGetter();
         var v = _.get(source.lookup, getConfigKey(option));
+        // need to also check option aliases if the option.name key is not found in the source
+        if (!doesExist(v)) {
+            var aliasWithValue = _.find(option.aliases || [], function (alias) {
+                var val = _.get(source.lookup, alias);
+                if (doesExist(val))
+                    return val;
+            });
+            if (aliasWithValue)
+                v = _.get(source.lookup, aliasWithValue);
+        }
         return doesExist(v) ? v : undefined;
     }
     function getValueFromSource(option, src) {
@@ -7012,10 +7037,6 @@ var ConfigReader = (function () {
         var option = findOption(optionName);
         defaultValue = defaultValue || _.get(option, 'defaultValue', null);
         var defaultReturn = new ConfigValue(optionName, defaultValue, DEFAULT_SRC);
-        // if (source) {
-        //     var val = getValueFromSource(option, source);
-        //     return val;
-        // }
         var validOptions = mapSourcesToValues(option, sources);
         // defaultValue must exist in order to use non-ordered sources,
         // otherwise you can't know what value to value over another.
@@ -7441,7 +7462,7 @@ function applyMatrix2dRect(matrix2d, rect) {
     return transformedRect;
 }
 
-var VERSION = '2.312.1_';
+var VERSION = '2.314.0_';
 
 var decodeURIComponent = _.isFunction(window.decodeURIComponent) ? window.decodeURIComponent : _.identity;