@segment/analytics-browser-actions-pendo-web-actions 1.7.0 → 1.8.0

package/src/group/index.ts

@@ -1,7 +1,7 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import type { PendoSDK, identifyPayload } from '../types'
+import type { PendoSDK, PendoOptions } from '../types'
 
 const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   title: 'Send Group Event',
@@ -11,59 +11,62 @@ const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   fields: {
     visitorId: {
       label: 'Visitor ID',
-      description: 'Pendo Visitor ID. Defaults to Segment userId',
+      description: 'Pendo Visitor ID. Maps to Segment userId',
       type: 'string',
       required: true,
       default: {
         '@path': '$.userId'
-      }
+      },
+      readOnly: true
     },
     accountId: {
       label: 'Account ID',
-      description: 'Pendo Account ID. This overrides the Pendo Account ID setting',
+      description: 'Pendo Account ID',
       type: 'string',
       required: true,
-      default: { '@path': '$.groupId' }
+      default: { '@path': '$.groupId' },
+      readOnly: true
     },
     accountData: {
       label: 'Account Metadata',
       description: 'Additional Account data to send',
       type: 'object',
-      required: false
-    },
-    parentAccountId: {
-      label: 'Parent Account ID',
-      description:
-        'Pendo Parent Account ID. This overrides the Pendo Parent Account ID setting. Note: Contact Pendo to request enablement of Parent Account feature.',
-      type: 'string',
-      required: false
+      required: false,
+      default: { '@path': '$.traits' },
+      readOnly: true
     },
     parentAccountData: {
       label: 'Parent Account Metadata',
       description:
         'Additional Parent Account data to send. Note: Contact Pendo to request enablement of Parent Account feature.',
       type: 'object',
+      properties: {
+        id: {
+          label: 'Parent Account ID',
+          type: 'string',
+          required: true
+        }
+      },
+      additionalProperties: true,
+      default: { '@path': '$.traits.parentAccount' },
       required: false
     }
   },
   perform: (pendo, event) => {
-    const payload: identifyPayload = {
+    const payload: PendoOptions = {
       visitor: {
         id: event.payload.visitorId
+      },
+      account: {
+        ...event.payload.accountData,
+        id: event.payload.accountId
       }
     }
-    if (event.payload.accountId || event.settings.accountId) {
-      payload.account = {
-        id: event.payload.accountId ?? (event.settings.accountId as string),
-        ...event.payload.accountData
-      }
-    }
-    if (event.payload.parentAccountId || event.settings.parentAccountId) {
-      payload.parentAccount = {
-        id: (event.payload.parentAccountId as string) ?? (event.settings.parentAccountId as string),
-        ...event.payload.parentAccountData
-      }
+
+    if (event.payload.parentAccountData) {
+      payload.parentAccount = event.payload.parentAccountData
     }
+
     pendo.identify(payload)
   }
 }

package/src/identify/__tests__/index.test.ts

@@ -15,9 +15,6 @@ const subscriptions: Subscription[] = [
       },
       visitorData: {
         '@path': '$.traits'
-      },
-      accountId: {
-        '@path': '$.context.group_id'
       }
     }
   }
@@ -26,7 +23,6 @@ const subscriptions: Subscription[] = [
 describe('Pendo.identify', () => {
   const settings = {
     apiKey: 'abc123',
-    setVisitorIdOnLoad: 'disabled',
     region: 'io'
   }
 
@@ -46,7 +42,8 @@ describe('Pendo.identify', () => {
         initialize: jest.fn(),
         isReady: jest.fn(),
         track: jest.fn(),
-        identify: jest.fn()
+        identify: jest.fn(),
+        flushNow: jest.fn()
       }
       return Promise.resolve(mockPendo)
     })
@@ -59,15 +56,11 @@ describe('Pendo.identify', () => {
       userId: 'testUserId',
       traits: {
         first_name: 'Jimbo'
-      },
-      context: {
-        group_id: 'company_id_1'
       }
     })
     await identifyAction.identify?.(context)
 
     expect(mockPendo.identify).toHaveBeenCalledWith({
-      account: { id: 'company_id_1' },
       visitor: { first_name: 'Jimbo', id: 'testUserId' }
     })
   })

package/src/identify/generated-types.ts

@@ -2,7 +2,7 @@
 
 export interface Payload {
   /**
-   * Pendo Visitor ID. Defaults to Segment userId
+   * Pendo Visitor ID. Maps to Segment userId
    */
   visitorId: string
   /**
@@ -11,24 +11,4 @@ export interface Payload {
   visitorData?: {
     [k: string]: unknown
   }
-  /**
-   * Pendo Account ID. This overrides the Pendo Account ID setting
-   */
-  accountId?: string
-  /**
-   * Additional Account data to send
-   */
-  accountData?: {
-    [k: string]: unknown
-  }
-  /**
-   * Pendo Parent Account ID. This overrides the Pendo Parent Account ID setting. Note: Contact Pendo to request enablement of Parent Account feature.
-   */
-  parentAccountId?: string
-  /**
-   * Additional Parent Account data to send. Note: Contact Pendo to request enablement of Parent Account feature.
-   */
-  parentAccountData?: {
-    [k: string]: unknown
-  }
 }

package/src/identify/index.ts

@@ -1,7 +1,7 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import type { PendoSDK, identifyPayload } from '../types'
+import type { PendoSDK, PendoOptions } from '../types'
 
 const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   title: 'Send Identify Event',
@@ -11,12 +11,13 @@ const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   fields: {
     visitorId: {
       label: 'Visitor ID',
-      description: 'Pendo Visitor ID. Defaults to Segment userId',
+      description: 'Pendo Visitor ID. Maps to Segment userId',
       type: 'string',
       required: true,
       default: {
         '@path': '$.userId'
-      }
+      },
+      readOnly: true
     },
     visitorData: {
       label: 'Visitor Metadata',
@@ -24,61 +25,18 @@ const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
       type: 'object',
       default: {
         '@path': '$.traits'
-      }
-    },
-    accountId: {
-      label: 'Account ID',
-      description: 'Pendo Account ID. This overrides the Pendo Account ID setting',
-      type: 'string',
-      required: false,
-      default: {
-        '@if': {
-          exists: { '@path': '$.context.group_id' },
-          then: { '@path': '$.context.group_id' },
-          else: { '@path': '$.groupId' }
-        }
-      }
-    },
-    accountData: {
-      label: 'Account Metadata',
-      description: 'Additional Account data to send',
-      type: 'object',
-      required: false
-    },
-    parentAccountId: {
-      label: 'Parent Account ID',
-      description:
-        'Pendo Parent Account ID. This overrides the Pendo Parent Account ID setting. Note: Contact Pendo to request enablement of Parent Account feature.',
-      type: 'string',
-      required: false
-    },
-    parentAccountData: {
-      label: 'Parent Account Metadata',
-      description:
-        'Additional Parent Account data to send. Note: Contact Pendo to request enablement of Parent Account feature.',
-      type: 'object',
-      required: false
+      },
+      readOnly: true
     }
   },
   perform: (pendo, event) => {
-    const payload: identifyPayload = {
+    const payload: PendoOptions = {
       visitor: {
-        id: event.payload.visitorId,
-        ...event.payload.visitorData
-      }
-    }
-    if (event.payload.accountId || event.settings.accountId) {
-      payload.account = {
-        id: (event.payload.accountId as string) ?? (event.settings.accountId as string),
-        ...event.payload.accountData
-      }
-    }
-    if (event.payload.parentAccountId || event.settings.parentAccountId) {
-      payload.parentAccount = {
-        id: (event.payload.parentAccountId as string) ?? (event.settings.parentAccountId as string),
-        ...event.payload.parentAccountData
+        ...event.payload.visitorData,
+        id: event.payload.visitorId
       }
     }
+
     pendo.identify(payload)
   }
 }

package/src/index.ts

@@ -2,7 +2,8 @@ import type { Settings } from './generated-types'
 import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
 import { browserDestination } from '@segment/browser-destination-runtime/shim'
 import { loadPendo } from './loadScript'
-import { InitializeData, PendoSDK } from './types'
+import { PendoOptions, PendoSDK } from './types'
+import { ID } from '@segment/analytics-next'
 
 import identify from './identify'
 import track from './track'
@@ -28,90 +29,68 @@ export const destination: BrowserDestinationDefinition<Settings, PendoSDK> = {
       type: 'string',
       required: true
     },
-    accountId: {
-      label: 'Set Pendo Account ID on Load',
-      description:
-        'Segment can set the Pendo Account ID upon page load. This can be overridden via the Account ID field in the Send Identify/Group Actions',
-      type: 'string',
-      required: false
-    },
-    parentAccountId: {
-      label: 'Set Pendo Parent Account ID on Load',
-      description:
-        'Segment can set the Pendo Parent Account ID upon page load. This can be overridden via the Parent Account ID field in the Send Identify/Group Actions. Note: Contact Pendo to request enablement of Parent Account feature.',
-      type: 'string',
-      required: false
-    },
     region: {
       label: 'Region',
       type: 'string',
-      description: "The Pendo Region you'd like to send data to",
+      description: 'The region for your Pendo subscription.',
       required: true,
-      default: 'io',
+      default: 'https://cdn.pendo.io',
       choices: [
-        { value: 'io', label: 'io' },
-        { value: 'eu', label: 'eu' }
+        { value: 'https://cdn.pendo.io', label: 'US (default)' },
+        { value: 'https://cdn.eu.pendo.io', label: 'EU' },
+        { value: 'https://us1.cdn.pendo.io', label: 'US restricted' },
+        { value: 'https://cdn.jpn.pendo.io', label: 'Japan' }
       ]
     },
-    setVisitorIdOnLoad: {
-      label: 'Set Vistor ID on Load',
+    cnameContentHost: {
+      label: 'Optional CNAME content host',
       description:
-        'Segment can set the Pendo Visitor ID upon page load to either the Segment userId or anonymousId. This can be overridden via the Visitor ID field in the Send Identify/Group Actions',
+        "If you are using Pendo's CNAME feature, this will update your Pendo install snippet with your content host.",
       type: 'string',
-      default: 'disabled',
-      choices: [
-        { value: 'disabled', label: 'Do not set Visitor ID on load' },
-        { value: 'userIdOnly', label: 'Set Visitor ID to userId on load' },
-        { value: 'userIdOrAnonymousId', label: 'Set Visitor ID to userId or anonymousId on load' },
-        { value: 'anonymousIdOnly', label: 'Set Visitor ID to anonymousId on load' }
-      ],
-      required: true
+      required: false
     }
   },
 
   initialize: async ({ settings, analytics }, deps) => {
-    loadPendo(settings.apiKey, settings.region)
-
-    await deps.resolveWhen(() => window.pendo != null, 100)
+    if (settings.cnameContentHost && !/^https?:/.exec(settings.cnameContentHost) && settings.cnameContentHost.length) {
+      settings.cnameContentHost = 'https://' + settings.cnameContentHost
+    }
 
-    const initialData: InitializeData = {}
+    loadPendo(settings.apiKey, settings.region, settings.cnameContentHost)
 
-    if (settings.setVisitorIdOnLoad) {
-      let vistorId: string | null = null
+    await deps.resolveWhen(() => window.pendo != null, 100)
 
-      switch (settings.setVisitorIdOnLoad) {
-        case 'disabled':
-          vistorId = null
-          break
-        case 'userIdOnly':
-          vistorId = analytics.user().id() ?? null
-          break
-        case 'userIdOrAnonymousId':
-          vistorId = analytics.user().id() ?? analytics.user().anonymousId() ?? null
-          break
-        case 'anonymousIdOnly':
-          vistorId = analytics.user().anonymousId() ?? null
-          break
-      }
+    let visitorId: ID = null
+    let accountId: ID = null
 
-      if (vistorId) {
-        initialData.visitor = {
-          id: vistorId
-        }
-      }
+    if (analytics.user().id()) {
+      visitorId = analytics.user().id()
+    } else if (analytics.user().anonymousId()) {
+      // Append Pendo anonymous visitor tag
+      // https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/pendo/lib/index.js#L114
+      visitorId = '_PENDO_T_' + analytics.user().anonymousId()
     }
-    if (settings.accountId) {
-      initialData.account = {
-        id: settings.accountId
-      }
+
+    if (analytics.group().id()) {
+      accountId = analytics.group().id()
     }
-    if (settings.parentAccountId) {
-      initialData.parentAccount = {
-        id: settings.parentAccountId
-      }
+
+    const options: PendoOptions = {
+      visitor: {
+        ...analytics.user().traits(),
+        id: visitorId
+      },
+      ...(accountId
+        ? {
+            account: {
+              ...analytics.group().traits(),
+              id: accountId
+            }
+          }
+        : {})
     }
 
-    window.pendo.initialize(initialData)
+    window.pendo.initialize(options)
 
     return window.pendo
   },

package/src/loadScript.ts

@@ -1,6 +1,6 @@
 /* eslint-disable */
 // @ts-nocheck
-export function loadPendo(apiKey, region) {
+export function loadPendo(apiKey, region, cnameContentHost) {
   ;(function (p, e, n, d, o) {
     var v, w, x, y, z
     o = p[d] = p[d] || {}
@@ -16,7 +16,7 @@ export function loadPendo(apiKey, region) {
       })(v[w])
     y = e.createElement(n)
     y.async = !0
-    y.src = `https://cdn.pendo.${region}/agent/static/` + apiKey + '/pendo.js'
+    y.src = `${cnameContentHost ?? region}/agent/static/${apiKey}/pendo.js`
     z = e.getElementsByTagName(n)[0]
     z.parentNode.insertBefore(y, z)
   })(window, document, 'script', 'pendo')

package/src/track/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 import type { PendoSDK } from '../types'
 
-// Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
   title: 'Send Track Event',
   description: 'Send Segment track() events to Pendo',
@@ -17,7 +16,8 @@ const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
       required: true,
       default: {
         '@path': '$.event'
-      }
+      },
+      readOnly: true
     },
     metadata: {
       label: 'Metadata',
@@ -25,12 +25,12 @@ const action: BrowserActionDefinition<Settings, PendoSDK, Payload> = {
       type: 'object',
       default: {
         '@path': '$.properties'
-      }
+      },
+      readOnly: true
     }
   },
   perform: (pendo, { payload }) => {
     pendo.track(payload.event, payload.metadata)
-    pendo.flushNow(true)
   }
 }
 

package/src/types.ts

@@ -1,27 +1,25 @@
+import { ID } from '@segment/analytics-next'
+
 export type Visitor = {
-  id?: string | null | undefined
+  id: ID
+  [propName: string]: unknown
 }
 
 export type Account = {
-  id?: string | null | undefined
+  id: ID
+  [propName: string]: unknown
 }
 
-export type InitializeData = {
+export type PendoOptions = {
   visitor?: Visitor
   account?: Account
   parentAccount?: Account
 }
 
-export type identifyPayload = {
-  visitor: { [key: string]: string }
-  account?: { [key: string]: string }
-  parentAccount?: { [key: string]: string }
-}
-
 export type PendoSDK = {
-  initialize: ({ visitor, account }: InitializeData) => void
+  initialize: ({ visitor, account }: PendoOptions) => void
   track: (eventName: string, metadata?: { [key: string]: unknown }) => void
-  identify: (data: identifyPayload) => void
+  identify: (data: PendoOptions) => void
   flushNow: (force: boolean) => void
   isReady: () => boolean
 }