@segment/analytics-browser-actions-intercom 1.0.0

package/src/trackEvent/index.ts

@@ -0,0 +1,92 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import { Intercom } from '../api'
+import type { Settings } from '../generated-types'
+import { filterCustomTraits, isEmpty } from '../utils'
+import type { Payload } from './generated-types'
+
+const action: BrowserActionDefinition<Settings, Intercom, Payload> = {
+  title: 'Track Event',
+  description: 'Submit an event to Intercom.',
+  defaultSubscription: 'type = "track"',
+  platform: 'web',
+  fields: {
+    event_name: {
+      description: 'The name of the event.',
+      label: 'Event Name',
+      type: 'string',
+      required: true,
+      default: {
+        '@path': '$.event'
+      }
+    },
+    revenue: {
+      description:
+        'The amount associated with a purchase. Segment will multiply by 100 as Intercom requires the amount in cents.',
+      label: 'Revenue',
+      type: 'number',
+      required: false,
+      default: {
+        '@path': '$.properties.revenue'
+      }
+    },
+    currency: {
+      description:
+        'The currency of the purchase amount. Segment will default to USD if revenue is provided without a currency.',
+      label: 'Currency',
+      type: 'string',
+      required: false,
+      default: {
+        '@path': '$.properties.currency'
+      }
+    },
+    event_metadata: {
+      description: 'Optional metadata describing the event.',
+      label: 'Event Metadata',
+      type: 'object',
+      required: false,
+      default: {
+        '@path': '$.properties'
+      }
+    }
+  },
+  perform: (Intercom, event) => {
+    //remove event_name & event_metadata from the payload (they will be handled separately)
+    const { event_name, event_metadata, ...rest } = event.payload
+    const payload = { ...rest }
+    const richLinkProperties = Intercom.richLinkProperties ? Intercom.richLinkProperties : []
+
+    // create a list of the richLinkObjects that will be passed to Intercom
+    const richLinkObjects: { [k: string]: unknown } = {}
+    if (event_metadata && richLinkProperties.length != 0) {
+      Object.entries(event_metadata).forEach(([key, value]) => {
+        if (richLinkProperties.includes(key)) {
+          richLinkObjects[key] = value
+        }
+      })
+    }
+
+    // filter out reserved fields, drop custom objects & arrays
+    const filteredMetadata = filterCustomTraits(event_metadata)
+
+    // create price object
+    let price = {}
+    if (payload.revenue) {
+      price = {
+        amount: payload.revenue * 100,
+        currency: payload.currency ?? 'USD'
+      }
+      delete filteredMetadata.revenue
+      delete filteredMetadata.currency
+    }
+
+    //merge richLinkObjects into the final payload
+    //API call
+    Intercom('trackEvent', event_name, {
+      ...filteredMetadata,
+      ...richLinkObjects,
+      ...(!isEmpty(price) && { price })
+    })
+  }
+}
+
+export default action

package/src/utils.ts

@@ -0,0 +1,43 @@
+import { isArray, isObject } from '@segment/actions-core'
+import { isNonEmpty } from '@segment/actions-shared'
+import dayjs from 'dayjs'
+
+export function convertDateToUnix(created_at: string | number): number {
+  if (typeof created_at === 'number') {
+    let unixDate = dayjs.unix(created_at).unix()
+    if (unixDate.toString().length == 13) {
+      unixDate = Math.floor(unixDate / 1000)
+    }
+    return unixDate
+  }
+  return dayjs(created_at).unix()
+}
+
+export function filterCustomTraits(traits: { [k: string]: unknown } | undefined) {
+  const filteredCustomTraits: { [k: string]: unknown } = {}
+  if (traits) {
+    for (const [key, value] of Object.entries(traits)) {
+      if (!isArray(value) && !isObject(value)) {
+        filteredCustomTraits[key] = value
+      }
+    }
+  }
+  return filteredCustomTraits
+}
+
+export function getWidgetOptions(hide_default_launcher: boolean | undefined, activator: string | undefined) {
+  const widgetOptions: { [key: string]: unknown } = {}
+  if (hide_default_launcher !== undefined) {
+    widgetOptions.hide_default_launcher = hide_default_launcher
+  }
+  if (activator !== '#IntercomDefaultWidget') {
+    widgetOptions.widget = {
+      activator: activator
+    }
+  }
+  return widgetOptions
+}
+
+export function isEmpty(o: object | undefined) {
+  return !isNonEmpty(o)
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "baseUrl": "."
+  },
+  "include": ["src"],
+  "exclude": ["dist", "**/__tests__"]
+}