@segment/analytics-browser-actions-replaybird 1.1.0

package/src/trackEvent/index.ts

@@ -0,0 +1,68 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { ReplayBird } from '../types'
+
+// Change from unknown to the partner SDK types
+const action: BrowserActionDefinition<Settings, ReplayBird, Payload> = {
+  title: 'Send Track Events',
+  description: 'Send Segment track() events and / or Segment page() events to ReplayBird',
+  platform: 'web',
+  defaultSubscription: 'type = "track" or type = "page"',
+  fields: {
+    name: {
+      description: 'The track() event name or page() name for the event.',
+      label: 'Event Name',
+      required: true,
+      type: 'string',
+      default: {
+        '@if': {
+          exists: { '@path': '$.event' },
+          then: { '@path': '$.event' },
+          else: { '@path': '$.name' }
+        }
+      }
+    },
+    properties: {
+      description:
+        'A JSON object containing additional information about the event that will be indexed by replaybird.',
+      label: 'Properties',
+      required: false,
+      type: 'object',
+      default: {
+        '@path': '$.properties'
+      }
+    },
+    userId: {
+      description: 'A unique ID for a known user',
+      label: 'User ID',
+      required: false,
+      type: 'string',
+      default: {
+        '@path': '$.userId'
+      }
+    },
+    anonymousId: {
+      description: 'A unique ID for a anonymous user',
+      label: 'Anonymous ID',
+      required: false,
+      type: 'string',
+      default: {
+        '@path': '$.anonymousId'
+      }
+    }
+  },
+  perform: (replaybird, event) => {
+    // Invoke Partner SDK here
+    const payload = event.payload
+    if (payload) {
+      replaybird.capture(payload.name, {
+        ...payload.properties,
+        userId: payload.userId,
+        anonymousId: payload.anonymousId
+      })
+    }
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1,14 @@
+type EventProperties = {
+  [key: string]: unknown
+}
+
+type UserProperties = {
+  [k: string]: unknown
+}
+
+export type ReplayBird = {
+  apiKey: string
+  capture: (eventName: string, eventProperties: EventProperties) => void
+  identify: (userId: string, traits: UserProperties) => void
+  init: (apiKey: string, options: object) => void
+}

package/src/utils.ts

@@ -0,0 +1,51 @@
+import { Subscription } from '@segment/browser-destination-runtime/types'
+import nock from 'nock'
+import { ReplayBird } from './types'
+
+export const trackSubscription: Subscription = {
+  partnerAction: 'trackEvent',
+  name: 'Track',
+  enabled: true,
+  subscribe: 'type = "track"',
+  mapping: {
+    name: {
+      '@path': '$.name'
+    },
+    properties: {
+      '@path': '$.properties'
+    }
+  }
+}
+
+export const identifySubscription: Subscription = {
+  partnerAction: 'identifyUser',
+  name: 'Identify',
+  enabled: true,
+  subscribe: 'type = "identify"',
+  mapping: {
+    userId: {
+      '@path': '$.userId'
+    },
+    traits: {
+      '@path': '$.traits'
+    }
+  }
+}
+
+export const REPLAYBIRD_API_KEY = 'secret'
+
+export const createMockedReplaybirdJsSdk = (): ReplayBird => {
+  return {
+    apiKey: REPLAYBIRD_API_KEY,
+    init: jest.fn(),
+    capture: jest.fn(),
+    identify: jest.fn()
+  }
+}
+
+// https://cdn.replaybird.com/agent/latest/replaybird.js
+export const mockReplaybirdJsHttpRequest = (): void => {
+  nock('https://cdn.replaybird.com').get(`/agent/latest/replaybird.js`).reply(200, {})
+}
+
+export const subscriptions = [trackSubscription, identifySubscription]

package/tsconfig.json

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