@segment/analytics-browser-actions-fullstory 1.29.0 → 1.30.0

package/src/identifyUserV2/index.ts

@@ -0,0 +1,95 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import type { FS } from '../types'
+import { segmentEventSource } from '..'
+
+// Change from unknown to the partner SDK types
+const action: BrowserActionDefinition<Settings, FS, Payload> = {
+  title: 'Identify User V2',
+  description: 'Sets user identity properties',
+  platform: 'web',
+  defaultSubscription: 'type = "identify"',
+  fields: {
+    userId: {
+      type: 'string',
+      required: false,
+      description: "The user's id",
+      label: 'User ID',
+      default: {
+        '@path': '$.userId'
+      }
+    },
+    anonymousId: {
+      type: 'string',
+      required: false,
+      description: "The user's anonymous id",
+      label: 'Anonymous ID',
+      default: {
+        '@path': '$.anonymousId'
+      }
+    },
+    displayName: {
+      type: 'string',
+      required: false,
+      description: "The user's display name",
+      label: 'Display Name',
+      default: {
+        '@path': '$.traits.name'
+      }
+    },
+    email: {
+      type: 'string',
+      required: false,
+      description: "The user's email",
+      label: 'Email',
+      default: {
+        '@path': '$.traits.email'
+      }
+    },
+    traits: {
+      type: 'object',
+      required: false,
+      description: 'The Segment traits to be forwarded to FullStory',
+      label: 'Traits',
+      default: {
+        '@path': '$.traits'
+      }
+    }
+  },
+  perform: (FS, event) => {
+    const newTraits: Record<string, unknown> = event.payload.traits || {}
+
+    if (event.payload.anonymousId) {
+      newTraits.segmentAnonymousId = event.payload.anonymousId
+    }
+
+    const userProperties = {
+      ...newTraits,
+      ...(event.payload.email !== undefined && { email: event.payload.email }),
+      ...(event.payload.displayName !== undefined && { displayName: event.payload.displayName })
+    }
+
+    if (event.payload.userId) {
+      FS(
+        'setIdentity',
+        {
+          uid: event.payload.userId,
+          properties: userProperties
+        },
+        segmentEventSource
+      )
+    } else {
+      FS(
+        'setProperties',
+        {
+          type: 'user',
+          properties: userProperties
+        },
+        segmentEventSource
+      )
+    }
+  }
+}
+
+export default action

package/src/index.ts

@@ -1,11 +1,14 @@
 import type { FS } from './types'
 import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
-import { FSPackage } from './types'
+import { initFullStory } from './types'
 import { browserDestination } from '@segment/browser-destination-runtime/shim'
 import type { Settings } from './generated-types'
 import trackEvent from './trackEvent'
+import trackEventV2 from './trackEventV2'
 import identifyUser from './identifyUser'
+import identifyUserV2 from './identifyUserV2'
 import viewedPage from './viewedPage'
+import viewedPageV2 from './viewedPageV2'
 import { defaultValues } from '@segment/actions-core'
 
 declare global {
@@ -24,15 +27,22 @@ export const destination: BrowserDestinationDefinition<Settings, FS> = {
     {
       name: 'Track Event',
       subscribe: 'type = "track"',
-      partnerAction: 'trackEvent',
-      mapping: defaultValues(trackEvent.fields),
+      partnerAction: 'trackEventV2',
+      mapping: defaultValues(trackEventV2.fields),
       type: 'automatic'
     },
     {
       name: 'Identify User',
       subscribe: 'type = "identify"',
-      partnerAction: 'identifyUser',
-      mapping: defaultValues(identifyUser.fields),
+      partnerAction: 'identifyUserV2',
+      mapping: defaultValues(identifyUserV2.fields),
+      type: 'automatic'
+    },
+    {
+      name: 'Viewed Page',
+      subscribe: 'type = "page"',
+      partnerAction: 'viewedPageV2',
+      mapping: defaultValues(viewedPageV2.fields),
       type: 'automatic'
     }
   ],
@@ -60,11 +70,14 @@ export const destination: BrowserDestinationDefinition<Settings, FS> = {
   },
   actions: {
     trackEvent,
+    trackEventV2,
     identifyUser,
-    viewedPage
+    identifyUserV2,
+    viewedPage,
+    viewedPageV2
   },
   initialize: async ({ settings }, dependencies) => {
-    FSPackage.init(settings)
+    initFullStory(settings)
     await dependencies.resolveWhen(() => Object.prototype.hasOwnProperty.call(window, 'FS'), 100)
     return window.FS
   }

package/src/trackEventV2/generated-types.ts

@@ -0,0 +1,14 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The name of the event.
+   */
+  name: string
+  /**
+   * A JSON object containing additional information about the event that will be indexed by FullStory.
+   */
+  properties?: {
+    [k: string]: unknown
+  }
+}

package/src/trackEventV2/index.ts

@@ -0,0 +1,44 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import type { FS } from '../types'
+import { segmentEventSource } from '..'
+
+const action: BrowserActionDefinition<Settings, FS, Payload> = {
+  title: 'Track Event V2',
+  description: 'Track events',
+  platform: 'web',
+  defaultSubscription: 'type = "track"',
+  fields: {
+    name: {
+      description: 'The name of the event.',
+      label: 'Name',
+      required: true,
+      type: 'string',
+      default: {
+        '@path': '$.event'
+      }
+    },
+    properties: {
+      description: 'A JSON object containing additional information about the event that will be indexed by FullStory.',
+      label: 'Properties',
+      required: false,
+      type: 'object',
+      default: {
+        '@path': '$.properties'
+      }
+    }
+  },
+  perform: (FS, event) => {
+    FS(
+      'trackEvent',
+      {
+        name: event.payload.name,
+        properties: event.payload.properties ?? {}
+      },
+      segmentEventSource
+    )
+  }
+}
+
+export default action

package/src/types.ts

@@ -1,10 +1,4 @@
-import * as FullStory from '@fullstory/browser'
+import { FullStory, init as initFullStory } from '@fullstory/browser'
 
-export const FSPackage = FullStory
-export type FS = typeof FullStory & {
-  // setVars is not available on the FS client yet.
-  setVars: (eventName: string, eventProperties: object, source: string) => {}
-  setUserVars: (eventProperties: object, source: string) => void
-  event: (eventName: string, eventProperties: { [key: string]: unknown }, source: string) => void
-  identify: (uid: string, customVars: FullStory.UserVars, source: string) => void
-}
+export type FS = typeof FullStory
+export { FullStory, initFullStory }

package/src/viewedPageV2/generated-types.ts

@@ -0,0 +1,14 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The name of the page that was viewed.
+   */
+  pageName?: string
+  /**
+   * The properties of the page that was viewed.
+   */
+  properties?: {
+    [k: string]: unknown
+  }
+}

package/src/viewedPageV2/index.ts

@@ -0,0 +1,52 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import type { FS } from '../types'
+import { segmentEventSource } from '..'
+
+const action: BrowserActionDefinition<Settings, FS, Payload> = {
+  title: 'Viewed Page V2',
+  description: 'Sets page properties',
+  defaultSubscription: 'type = "page"',
+  platform: 'web',
+  fields: {
+    pageName: {
+      type: 'string',
+      required: false,
+      description: 'The name of the page that was viewed.',
+      label: 'Page Name',
+      default: {
+        '@if': {
+          exists: { '@path': '$.category' },
+          then: { '@path': '$.category' },
+          else: { '@path': '$.name' }
+        }
+      }
+    },
+    properties: {
+      type: 'object',
+      required: false,
+      description: 'The properties of the page that was viewed.',
+      label: 'Properties',
+      default: {
+        '@path': '$.properties'
+      }
+    }
+  },
+  perform: (FS, event) => {
+    const properties: object = event.payload.pageName
+      ? { pageName: event.payload.pageName, ...event.payload.properties }
+      : { ...event.payload.properties }
+
+    FS(
+      'setProperties',
+      {
+        type: 'page',
+        properties
+      },
+      segmentEventSource
+    )
+  }
+}
+
+export default action