@pendo/agent 2.330.2 → 2.332.0

package/dist/servers.json

@@ -2,7 +2,7 @@
   "au": {
     "server": "https://app.au.pendo.io",
     "assetHost": "cdn.au.pendo.io",
-    "assetPath": "agent/releases/2.330.2",
+    "assetPath": "agent/releases/2.332.0",
     "env": "prod-au",
     "designerServer": "https://app.au.pendo.io",
     "globalBucket": "pendo-au-static",
@@ -11,7 +11,7 @@
   "eu": {
     "server": "https://app.eu.pendo.io",
     "assetHost": "cdn.eu.pendo.io",
-    "assetPath": "agent/releases/2.330.2",
+    "assetPath": "agent/releases/2.332.0",
     "env": "prod-eu",
     "designerServer": "https://app.eu.pendo.io",
     "globalBucket": "pendo-eu-static",
@@ -20,7 +20,7 @@
   "gov": {
     "server": "https://app.gov.pendo.io",
     "assetHost": "cdn.gov.pendo.io",
-    "assetPath": "agent/releases/2.330.2",
+    "assetPath": "agent/releases/2.332.0",
     "env": "prod-gov",
     "designerServer": "https://app.gov.pendo.io",
     "globalBucket": "pendo-govramp-static",
@@ -29,7 +29,7 @@
   "hsbc": {
     "server": "https://app.hsbc.pendo.io",
     "assetHost": "cdn.hsbc.pendo.io",
-    "assetPath": "agent/releases/2.330.2",
+    "assetPath": "agent/releases/2.332.0",
     "env": "prod-hsbc",
     "designerServer": "https://app.hsbc.pendo.io",
     "globalBucket": "pendo-hsbc-static",
@@ -38,7 +38,7 @@
   "io": {
     "server": "https://app.pendo.io",
     "assetHost": "cdn.pendo.io",
-    "assetPath": "agent/releases/2.330.2",
+    "assetPath": "agent/releases/2.332.0",
     "env": "prod-io",
     "designerServer": "https://app.pendo.io",
     "globalBucket": "pendo-io-static",
@@ -47,7 +47,7 @@
   "jpn": {
     "server": "https://app.jpn.pendo.io",
     "assetHost": "cdn.jpn.pendo.io",
-    "assetPath": "agent/releases/2.330.2",
+    "assetPath": "agent/releases/2.332.0",
     "env": "prod-jpn",
     "designerServer": "https://app.jpn.pendo.io",
     "globalBucket": "pendo-jp-prod-static",
@@ -56,7 +56,7 @@
   "us1": {
     "server": "us1.https://app.pendo.io",
     "assetHost": "us1.cdn.pendo.io",
-    "assetPath": "agent/releases/2.330.2",
+    "assetPath": "agent/releases/2.332.0",
     "env": "prod-us1",
     "designerServer": "us1.https://app.pendo.io",
     "globalBucket": "pendo-us1-static",

package/package.json

@@ -12,5 +12,5 @@
   "engines": {
     "node": ">=12"
   },
-  "version": "2.330.2"
+  "version": "2.332.0"
 }

package/setup.js

@@ -1,7 +1,9 @@
 import servers from './dist/servers.json';
 
 export async function startAgent(initAgent, options = {}) {
-    if (!options.apiKey) exit('Missing required option "apiKey"');
+    // `publicAppId` is the current option name; `apiKey` is the legacy alias.
+    if (options.apiKey && !options.publicAppId) options.publicAppId = options.apiKey;
+    if (!options.publicAppId) exit('Missing required option "publicAppId"');
 
     const server = await getServerConfig(options);
     delete options.config;
@@ -20,11 +22,13 @@ export async function startAgent(initAgent, options = {}) {
 }
 
 export async function getServerConfig(options) {
+    // `publicAppId` is the current option name; `apiKey` is the legacy alias.
+    if (options.apiKey && !options.publicAppId) options.publicAppId = options.apiKey;
     if (!options.env) exit('Missing option "env", please specify an environment for your Pendo subscription.');
     let config;
     if (!options.config || !Object.keys(options.config).length) {
         const baseConfig = generateBaseAgentConfig(options.env);
-        const configUrl = new URL(`agent/static/${options.apiKey}/config.json`, `https://${baseConfig.assetHost}`).toString();
+        const configUrl = new URL(`agent/static/${options.publicAppId}/config.json`, `https://${baseConfig.assetHost}`).toString();
         const serverConfig = await fetch(configUrl)
             .then(response => {
                 if (!response.ok) exit('could not load config.json');

package/setup.test.js

@@ -0,0 +1,65 @@
+import { startAgent, getServerConfig } from './setup.js';
+
+// `setup.js` statically imports the built `./dist/servers.json`, which is a
+// build artifact that does not exist in the source tree. Provide it virtually.
+jest.mock('./dist/servers.json', () => ({
+    io: { assetHost: 'cdn.pendo.io', server: 'https://app.pendo.io' }
+}), { virtual: true });
+
+describe('npm-web-sdk setup', () => {
+    let fetchMock;
+    let fakeAgent;
+    let pendoInstance;
+
+    beforeEach(() => {
+        fetchMock = jest.fn().mockResolvedValue({
+            ok: true,
+            json: async() => ({ fromServer: true })
+        });
+        global.fetch = fetchMock;
+        pendoInstance = { initialize: jest.fn() };
+        fakeAgent = jest.fn(() => pendoInstance);
+    });
+
+    describe('startAgent', () => {
+        // APP-158650: passing `publicAppId` (the documented option) threw
+        // `Missing required option "apiKey"` because the wrapper only honored
+        // the legacy `apiKey` alias.
+        it('accepts publicAppId and uses it to build the config URL (regression: APP-158650)', async() => {
+            await startAgent(fakeAgent, { publicAppId: 'PUB-123', env: 'io' });
+
+            expect(fetchMock).toHaveBeenCalledWith('https://cdn.pendo.io/agent/static/PUB-123/config.json');
+            expect(pendoInstance.initialize).toHaveBeenCalledWith(expect.objectContaining({ publicAppId: 'PUB-123' }));
+        });
+
+        it('still accepts the legacy apiKey alias', async() => {
+            await startAgent(fakeAgent, { apiKey: 'LEGACY-999', env: 'io' });
+
+            expect(fetchMock).toHaveBeenCalledWith('https://cdn.pendo.io/agent/static/LEGACY-999/config.json');
+        });
+
+        it('prefers publicAppId when both publicAppId and apiKey are provided', async() => {
+            await startAgent(fakeAgent, { publicAppId: 'PUB-123', apiKey: 'LEGACY-999', env: 'io' });
+
+            expect(fetchMock).toHaveBeenCalledWith('https://cdn.pendo.io/agent/static/PUB-123/config.json');
+        });
+
+        it('throws an error naming publicAppId when neither publicAppId nor apiKey is provided', async() => {
+            await expect(startAgent(fakeAgent, { env: 'io' })).rejects.toThrow(/Missing required option "publicAppId"/);
+        });
+    });
+
+    describe('getServerConfig', () => {
+        it('builds the config URL from publicAppId', async() => {
+            await getServerConfig({ publicAppId: 'DIRECT-1', env: 'io' });
+
+            expect(fetchMock).toHaveBeenCalledWith('https://cdn.pendo.io/agent/static/DIRECT-1/config.json');
+        });
+
+        it('normalizes the legacy apiKey alias to publicAppId', async() => {
+            await getServerConfig({ apiKey: 'DIRECT-LEGACY', env: 'io' });
+
+            expect(fetchMock).toHaveBeenCalledWith('https://cdn.pendo.io/agent/static/DIRECT-LEGACY/config.json');
+        });
+    });
+});