@segment/analytics-browser-actions-ripe 1.0.0

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@segment/analytics-browser-actions-ripe",
+  "version": "1.0.0",
+  "license": "MIT",
+  "main": "./dist/cjs",
+  "module": "./dist/esm",
+  "scripts": {
+    "build": "yarn build:esm && yarn build:cjs",
+    "build:cjs": "tsc --module commonjs --outDir ./dist/cjs",
+    "build:esm": "tsc --outDir ./dist/esm"
+  },
+  "typings": "./dist/esm",
+  "dependencies": {
+    "@segment/actions-core": "^3.71.0",
+    "@segment/browser-destination-runtime": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@segment/analytics-next": "*"
+  }
+}

package/src/generated-types.ts

@@ -0,0 +1,16 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Settings {
+  /**
+   * The version of the Ripe Widget SDK to use
+   */
+  sdkVersion?: string
+  /**
+   * The Ripe API key found in the Ripe App
+   */
+  apiKey: string
+  /**
+   * The Ripe API endpoint (do not change this unless you know what you're doing)
+   */
+  endpoint?: string
+}

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

@@ -0,0 +1,91 @@
+import type { Subscription } from '@segment/browser-destination-runtime/types'
+import { Analytics, Context } from '@segment/analytics-next'
+import RipeDestination, { destination } from '../../index'
+
+import { loadScript } from '@segment/browser-destination-runtime/load-script'
+import { RipeSDK } from '../../types'
+
+jest.mock('@segment/browser-destination-runtime/load-script')
+beforeEach(async () => {
+  ;(loadScript as jest.Mock).mockResolvedValue(true)
+})
+
+const subscriptions: Subscription[] = [
+  {
+    partnerAction: 'group',
+    name: 'Group user',
+    enabled: true,
+    subscribe: 'type = "group"',
+    mapping: {
+      messageId: {
+        '@path': '$.messageId'
+      },
+      anonymousId: {
+        '@path': '$.anonymousId'
+      },
+      userId: {
+        '@path': '$.userId'
+      },
+      groupId: {
+        '@path': '$.groupId'
+      },
+      traits: {
+        '@path': '$.traits'
+      }
+    }
+  }
+]
+
+describe('Ripe.group', () => {
+  test('it maps the event name and properties and passes them into RipeSDK.track', async () => {
+    window.Ripe = {
+      init: jest.fn().mockResolvedValueOnce('123'),
+      group: jest.fn().mockResolvedValueOnce(undefined),
+      setIds: jest.fn().mockResolvedValueOnce(undefined)
+    } as unknown as RipeSDK
+
+    const [event] = await RipeDestination({
+      subscriptions,
+      apiKey: '123'
+    })
+
+    const ajs = new Analytics({ writeKey: '123' })
+    await event.load(Context.system(), ajs)
+    jest.spyOn(destination.actions.group, 'perform')
+
+    await event.group?.(
+      new Context({
+        messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+        anonymousId: 'anonId1',
+        type: 'group',
+        groupId: 'groupId1',
+        traits: {
+          is_new_group: true
+        }
+      })
+    )
+
+    expect(destination.actions.group.perform).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        payload: {
+          messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+          anonymousId: 'anonId1',
+          userId: undefined,
+          groupId: 'groupId1',
+          traits: {
+            is_new_group: true
+          }
+        }
+      })
+    )
+
+    expect(window.Ripe.group).toHaveBeenCalledWith({
+      messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+      anonymousId: 'anonId1',
+      userId: undefined,
+      groupId: 'groupId1',
+      traits: expect.objectContaining({ is_new_group: true })
+    })
+  })
+})

package/src/group/generated-types.ts

@@ -0,0 +1,26 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The anonymous id
+   */
+  anonymousId: string
+  /**
+   * The ID associated with the user
+   */
+  userId?: string | null
+  /**
+   * The ID associated groupId
+   */
+  groupId: string | null
+  /**
+   * Traits to associate with the group
+   */
+  traits?: {
+    [k: string]: unknown
+  }
+  /**
+   * The Segment messageId
+   */
+  messageId?: string
+}

package/src/group/index.ts

@@ -0,0 +1,61 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { RipeSDK } from '../types'
+
+const action: BrowserActionDefinition<Settings, RipeSDK, Payload> = {
+  title: 'Group',
+  description: 'Group user in Ripe',
+  defaultSubscription: 'type = "group"',
+  platform: 'web',
+  fields: {
+    anonymousId: {
+      type: 'string',
+      required: true,
+      description: 'The anonymous id',
+      label: 'Anonymous ID',
+      default: { '@path': '$.anonymousId' }
+    },
+    userId: {
+      type: 'string',
+      required: false,
+      allowNull: true,
+      description: 'The ID associated with the user',
+      label: 'User ID',
+      default: { '@path': '$.userId' }
+    },
+    groupId: {
+      type: 'string',
+      required: true,
+      allowNull: true,
+      description: 'The ID associated groupId',
+      label: 'Group ID',
+      default: { '@path': '$.groupId' }
+    },
+    traits: {
+      type: 'object',
+      label: 'Traits',
+      description: 'Traits to associate with the group',
+      required: false,
+      default: { '@path': '$.traits' }
+    },
+    messageId: {
+      type: 'string',
+      required: false,
+      description: 'The Segment messageId',
+      label: 'MessageId',
+      default: { '@path': '$.messageId' }
+    }
+  },
+  perform: async (ripe, { payload }) => {
+    return ripe.group({
+      messageId: payload.messageId,
+      anonymousId: payload.anonymousId,
+      userId: payload.userId,
+      groupId: payload.groupId,
+      traits: payload.traits
+    })
+  }
+}
+
+export default action

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

@@ -0,0 +1,91 @@
+import type { Subscription } from '@segment/browser-destination-runtime/types'
+import { Analytics, Context } from '@segment/analytics-next'
+import RipeDestination, { destination } from '../../index'
+import { RipeSDK } from '../../types'
+
+import { loadScript } from '@segment/browser-destination-runtime/load-script'
+
+jest.mock('@segment/browser-destination-runtime/load-script')
+beforeEach(async () => {
+  ;(loadScript as jest.Mock).mockResolvedValue(true)
+})
+
+const subscriptions: Subscription[] = [
+  {
+    partnerAction: 'identify',
+    name: 'Identify user',
+    enabled: true,
+    subscribe: 'type = "identify"',
+    mapping: {
+      messageId: {
+        '@path': '$.messageId'
+      },
+      anonymousId: {
+        '@path': '$.anonymousId'
+      },
+      userId: {
+        '@path': '$.userId'
+      },
+      groupId: {
+        '@path': '$.groupId'
+      },
+      traits: {
+        '@path': '$.traits'
+      }
+    }
+  }
+]
+
+describe('Ripe.identify', () => {
+  test('it maps userId and traits and passes them into RipeSDK.identify', async () => {
+    window.Ripe = {
+      init: jest.fn().mockResolvedValueOnce('123'),
+      identify: jest.fn().mockResolvedValueOnce(undefined),
+      setIds: jest.fn().mockResolvedValueOnce(undefined)
+    } as unknown as RipeSDK
+
+    const [event] = await RipeDestination({
+      subscriptions,
+      apiKey: '123'
+    })
+
+    const ajs = new Analytics({ writeKey: '123' })
+    await event.load(Context.system(), ajs)
+    jest.spyOn(destination.actions.identify, 'perform')
+
+    await event.identify?.(
+      new Context({
+        type: 'identify',
+        messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+        anonymousId: 'anonymousId',
+        userId: 'userId',
+        traits: {
+          name: 'Simon'
+        }
+      })
+    )
+
+    expect(destination.actions.identify.perform).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        payload: {
+          messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+          anonymousId: 'anonymousId',
+          userId: 'userId',
+          groupId: undefined,
+          traits: {
+            name: 'Simon'
+          }
+        }
+      })
+    )
+
+    expect(window.Ripe.identify).toHaveBeenCalledWith({
+      messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+      userId: expect.stringMatching('userId'),
+      anonymousId: 'anonymousId',
+      groupId: undefined,
+      traits: expect.objectContaining({ name: 'Simon' })
+    })
+  })
+})

package/src/identify/generated-types.ts

@@ -0,0 +1,26 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The anonymous id
+   */
+  anonymousId: string
+  /**
+   * The ID associated with the user
+   */
+  userId?: string | null
+  /**
+   * The ID associated groupId
+   */
+  groupId?: string | null
+  /**
+   * Traits to associate with the user
+   */
+  traits?: {
+    [k: string]: unknown
+  }
+  /**
+   * The Segment messageId
+   */
+  messageId?: string
+}

package/src/identify/index.ts

@@ -0,0 +1,61 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { RipeSDK } from '../types'
+
+const action: BrowserActionDefinition<Settings, RipeSDK, Payload> = {
+  title: 'Identify',
+  description: 'Identify user in Ripe',
+  defaultSubscription: 'type = "identify"',
+  platform: 'web',
+  fields: {
+    anonymousId: {
+      type: 'string',
+      required: true,
+      description: 'The anonymous id',
+      label: 'Anonymous ID',
+      default: { '@path': '$.anonymousId' }
+    },
+    userId: {
+      type: 'string',
+      required: false,
+      allowNull: true,
+      description: 'The ID associated with the user',
+      label: 'User ID',
+      default: { '@path': '$.userId' }
+    },
+    groupId: {
+      type: 'string',
+      required: false,
+      allowNull: true,
+      description: 'The ID associated groupId',
+      label: 'Group ID',
+      default: { '@path': '$.context.groupId' }
+    },
+    traits: {
+      type: 'object',
+      label: 'Traits',
+      description: 'Traits to associate with the user',
+      required: false,
+      default: { '@path': '$.traits' }
+    },
+    messageId: {
+      type: 'string',
+      required: false,
+      description: 'The Segment messageId',
+      label: 'MessageId',
+      default: { '@path': '$.messageId' }
+    }
+  },
+  perform: async (ripe, { payload }) => {
+    return ripe.identify({
+      messageId: payload.messageId,
+      anonymousId: payload.anonymousId,
+      userId: payload.userId,
+      groupId: payload.groupId,
+      traits: payload.traits
+    })
+  }
+}
+
+export default action

package/src/index.ts

@@ -0,0 +1,109 @@
+import type { Settings } from './generated-types'
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
+import { browserDestination } from '@segment/browser-destination-runtime/shim'
+import { RipeSDK } from './types'
+
+import group from './group'
+import identify from './identify'
+import track from './track'
+
+import { defaultValues } from '@segment/actions-core'
+import { initScript } from './init-script'
+
+import page from './page'
+
+const defaultVersion = 'latest'
+
+declare global {
+  interface Window {
+    Ripe: RipeSDK
+  }
+}
+
+export const destination: BrowserDestinationDefinition<Settings, RipeSDK> = {
+  name: 'Ripe Device Mode (Actions)',
+  slug: 'actions-ripe',
+  mode: 'device',
+
+  settings: {
+    sdkVersion: {
+      description: 'The version of the Ripe Widget SDK to use',
+      label: 'SDK Version',
+      type: 'string',
+      choices: [
+        {
+          value: 'latest',
+          label: 'latest'
+        }
+      ],
+      default: defaultVersion,
+      required: false
+    },
+    apiKey: {
+      description: 'The Ripe API key found in the Ripe App',
+      label: 'API Key',
+      type: 'string',
+      required: true
+    },
+    endpoint: {
+      label: 'API Endpoint',
+      description: `The Ripe API endpoint (do not change this unless you know what you're doing)`,
+      type: 'string',
+      format: 'uri',
+      default: 'https://storage.getripe.com'
+    }
+  },
+
+  initialize: async ({ settings }, deps) => {
+    initScript()
+
+    const { sdkVersion, apiKey } = settings
+    const version = sdkVersion ?? defaultVersion
+    const endpoint = settings.endpoint || 'https://storage.getripe.com'
+
+    await deps
+      .loadScript(`${endpoint}/sdk/${version}/sdk.umd.js`)
+      .catch((err) => console.error('Unable to load Ripe SDK script', err))
+
+    await deps.resolveWhen(() => Object.prototype.hasOwnProperty.call(window, 'Ripe'), 100)
+    await window.Ripe.init(apiKey)
+
+    return window.Ripe
+  },
+
+  actions: {
+    group,
+    identify,
+    page,
+    track
+  },
+
+  presets: [
+    {
+      name: 'Group user',
+      subscribe: 'type = "group"',
+      partnerAction: 'group',
+      mapping: defaultValues(group.fields)
+    },
+    {
+      name: 'Identify user',
+      subscribe: 'type = "identify"',
+      partnerAction: 'identify',
+      mapping: defaultValues(identify.fields)
+    },
+    {
+      name: 'Page view',
+      subscribe: 'type = "page"',
+      partnerAction: 'page',
+      mapping: defaultValues(page.fields)
+    },
+    {
+      name: 'Track event',
+      subscribe: 'type = "track"',
+      partnerAction: 'track',
+      mapping: defaultValues(track.fields)
+    }
+  ]
+}
+
+export default browserDestination(destination)

package/src/init-script.ts

@@ -0,0 +1,17 @@
+/* eslint-disable */
+// @ts-nocheck
+export function initScript() {
+  if (window.Ripe) {
+    return
+  }
+
+  window.Ripe = []
+  ;['group', 'identify', 'init', 'page', 'track'].forEach(function (method) {
+    window.Ripe[method] = function () {
+      let args = Array.from(arguments)
+      args.unshift(method)
+      window.Ripe.push(args)
+      return window.Ripe
+    }
+  })
+}

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

@@ -0,0 +1,102 @@
+import type { Subscription } from '@segment/browser-destination-runtime/types'
+import { Analytics, Context } from '@segment/analytics-next'
+import RipeDestination, { destination } from '../../index'
+import { RipeSDK } from '../../types'
+
+import { loadScript } from '@segment/browser-destination-runtime/load-script'
+
+jest.mock('@segment/browser-destination-runtime/load-script')
+beforeEach(async () => {
+  ;(loadScript as jest.Mock).mockResolvedValue(true)
+})
+
+const subscriptions: Subscription[] = [
+  {
+    partnerAction: 'page',
+    name: 'Page view',
+    enabled: true,
+    subscribe: 'type = "page"',
+    mapping: {
+      messageId: {
+        '@path': '$.messageId'
+      },
+      anonymousId: {
+        '@path': '$.anonymousId'
+      },
+      userId: {
+        '@path': '$.userId'
+      },
+      groupId: {
+        '@path': '$.groupId'
+      },
+      category: {
+        '@path': '$.category'
+      },
+      name: {
+        '@path': '$.name'
+      },
+      properties: {
+        '@path': '$.properties'
+      }
+    }
+  }
+]
+
+describe('Ripe.page', () => {
+  test('it maps pageview properties and passes them into RipeSDK.page', async () => {
+    window.Ripe = {
+      init: jest.fn().mockResolvedValueOnce('123'),
+      page: jest.fn().mockResolvedValueOnce(undefined),
+      setIds: jest.fn().mockResolvedValueOnce(undefined)
+    } as unknown as RipeSDK
+
+    const [event] = await RipeDestination({
+      subscriptions,
+      apiKey: '123'
+    })
+
+    const ajs = new Analytics({ writeKey: '123' })
+    await event.load(Context.system(), ajs)
+    jest.spyOn(destination.actions.page, 'perform')
+
+    await event.page?.(
+      new Context({
+        messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+        anonymousId: 'anonymousId',
+        type: 'page',
+        category: 'main',
+        name: 'page2',
+        properties: {
+          previous: 'page1'
+        }
+      })
+    )
+
+    expect(destination.actions.page.perform).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        payload: {
+          messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+          anonymousId: 'anonymousId',
+          userId: undefined,
+          groupId: undefined,
+          category: 'main',
+          name: 'page2',
+          properties: {
+            previous: 'page1'
+          }
+        }
+      })
+    )
+
+    expect(window.Ripe.page).toHaveBeenCalledWith({
+      messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+      userId: undefined,
+      groupId: undefined,
+      anonymousId: 'anonymousId',
+      category: 'main',
+      name: 'page2',
+      properties: expect.objectContaining({ previous: 'page1' })
+    })
+  })
+})

package/src/page/generated-types.ts

@@ -0,0 +1,34 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The anonymous id
+   */
+  anonymousId: string
+  /**
+   * The ID associated with the user
+   */
+  userId?: string | null
+  /**
+   * The ID associated groupId
+   */
+  groupId?: string | null
+  /**
+   * The category of the page
+   */
+  category?: string
+  /**
+   * The name of the page
+   */
+  name?: string
+  /**
+   * Page properties
+   */
+  properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * The Segment messageId
+   */
+  messageId?: string
+}

package/src/page/index.ts

@@ -0,0 +1,89 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { RipeSDK } from '../types'
+
+const action: BrowserActionDefinition<Settings, RipeSDK, Payload> = {
+  title: 'Page',
+  description: 'Register page view in Ripe',
+  defaultSubscription: 'type = "page"',
+  platform: 'web',
+  fields: {
+    anonymousId: {
+      type: 'string',
+      required: true,
+      description: 'The anonymous id',
+      label: 'Anonymous ID',
+      default: { '@path': '$.anonymousId' }
+    },
+    userId: {
+      type: 'string',
+      required: false,
+      allowNull: true,
+      description: 'The ID associated with the user',
+      label: 'User ID',
+      default: { '@path': '$.userId' }
+    },
+    groupId: {
+      type: 'string',
+      required: false,
+      allowNull: true,
+      description: 'The ID associated groupId',
+      label: 'Group ID',
+      default: { '@path': '$.context.groupId' }
+    },
+    category: {
+      type: 'string',
+      required: false,
+      description: 'The category of the page',
+      label: 'Category',
+      default: {
+        '@if': {
+          exists: { '@path': '$.category' },
+          then: { '@path': '$.category' },
+          else: { '@path': '$.context.category' }
+        }
+      }
+    },
+    name: {
+      type: 'string',
+      required: false,
+      description: 'The name of the page',
+      label: 'Name',
+      default: {
+        '@if': {
+          exists: { '@path': '$.name' },
+          then: { '@path': '$.name' },
+          else: { '@path': '$.context.name' }
+        }
+      }
+    },
+    properties: {
+      type: 'object',
+      required: false,
+      description: 'Page properties',
+      label: 'Properties',
+      default: { '@path': '$.properties' }
+    },
+    messageId: {
+      type: 'string',
+      required: false,
+      description: 'The Segment messageId',
+      label: 'MessageId',
+      default: { '@path': '$.messageId' }
+    }
+  },
+  perform: async (ripe, { payload }) => {
+    return ripe.page({
+      messageId: payload.messageId,
+      anonymousId: payload.anonymousId,
+      userId: payload.userId,
+      groupId: payload.groupId,
+      category: payload.category,
+      name: payload.name,
+      properties: payload.properties
+    })
+  }
+}
+
+export default action

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

@@ -0,0 +1,96 @@
+import type { Subscription } from '@segment/browser-destination-runtime/types'
+import { Analytics, Context } from '@segment/analytics-next'
+import RipeDestination, { destination } from '../../index'
+import { RipeSDK } from '../../types'
+
+import { loadScript } from '@segment/browser-destination-runtime/load-script'
+
+jest.mock('@segment/browser-destination-runtime/load-script')
+beforeEach(async () => {
+  ;(loadScript as jest.Mock).mockResolvedValue(true)
+})
+
+const subscriptions: Subscription[] = [
+  {
+    partnerAction: 'track',
+    name: 'Track user',
+    enabled: true,
+    subscribe: 'type = "track"',
+    mapping: {
+      messageId: {
+        '@path': '$.messageId'
+      },
+      anonymousId: {
+        '@path': '$.anonymousId'
+      },
+      userId: {
+        '@path': '$.userId'
+      },
+      groupId: {
+        '@path': '$.groupId'
+      },
+      event: {
+        '@path': '$.event'
+      },
+      properties: {
+        '@path': '$.properties'
+      }
+    }
+  }
+]
+
+describe('Ripe.track', () => {
+  test('it maps the event name and properties and passes them into RipeSDK.track', async () => {
+    window.Ripe = {
+      init: jest.fn().mockResolvedValueOnce('123'),
+      setIds: jest.fn().mockResolvedValueOnce(undefined),
+      track: jest.fn().mockResolvedValueOnce(undefined)
+    } as unknown as RipeSDK
+
+    const [event] = await RipeDestination({
+      subscriptions,
+      apiKey: '123'
+    })
+
+    const ajs = new Analytics({ writeKey: '123' })
+    await event.load(Context.system(), ajs)
+    jest.spyOn(destination.actions.track, 'perform')
+
+    await event.track?.(
+      new Context({
+        messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+        type: 'track',
+        anonymousId: 'anonymousId',
+        event: 'Form Submitted',
+        properties: {
+          is_new_lead: true
+        }
+      })
+    )
+
+    expect(destination.actions.track.perform).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        payload: {
+          messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+          anonymousId: 'anonymousId',
+          userId: undefined,
+          groupId: undefined,
+          event: 'Form Submitted',
+          properties: {
+            is_new_lead: true
+          }
+        }
+      })
+    )
+
+    expect(window.Ripe.track).toHaveBeenCalledWith({
+      messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+      anonymousId: 'anonymousId',
+      userId: undefined,
+      groupId: undefined,
+      event: 'Form Submitted',
+      properties: expect.objectContaining({ is_new_lead: true })
+    })
+  })
+})

package/src/track/generated-types.ts

@@ -0,0 +1,30 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The anonymous id
+   */
+  anonymousId: string
+  /**
+   * The ID associated with the user
+   */
+  userId?: string | null
+  /**
+   * The ID associated groupId
+   */
+  groupId?: string | null
+  /**
+   * The event name
+   */
+  event: string
+  /**
+   * Properties to send with the event
+   */
+  properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * The Segment messageId
+   */
+  messageId?: string
+}

package/src/track/index.ts

@@ -0,0 +1,71 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { RipeSDK } from '../types'
+
+const action: BrowserActionDefinition<Settings, RipeSDK, Payload> = {
+  title: 'Track',
+  description: 'Send user events to Ripe',
+  defaultSubscription: 'type = "track"',
+  platform: 'web',
+  fields: {
+    anonymousId: {
+      type: 'string',
+      required: true,
+      description: 'The anonymous id',
+      label: 'Anonymous ID',
+      default: { '@path': '$.anonymousId' }
+    },
+    userId: {
+      type: 'string',
+      required: false,
+      allowNull: true,
+      description: 'The ID associated with the user',
+      label: 'User ID',
+      default: { '@path': '$.userId' }
+    },
+    groupId: {
+      type: 'string',
+      required: false,
+      allowNull: true,
+      description: 'The ID associated groupId',
+      label: 'Group ID',
+      default: { '@path': '$.context.groupId' }
+    },
+    event: {
+      type: 'string',
+      required: true,
+      description: 'The event name',
+      label: 'Event Name',
+      default: { '@path': '$.event' }
+    },
+    properties: {
+      type: 'object',
+      required: false,
+      description: 'Properties to send with the event',
+      label: 'Event properties',
+      default: { '@path': '$.properties' }
+    },
+    messageId: {
+      type: 'string',
+      required: false,
+      description: 'The Segment messageId',
+      label: 'MessageId',
+      default: { '@path': '$.messageId' }
+    }
+  },
+  perform: async (ripe, { payload }) => {
+    if (payload?.event) {
+      return ripe.track({
+        messageId: payload.messageId,
+        anonymousId: payload.anonymousId,
+        userId: payload.userId,
+        groupId: payload.groupId,
+        event: payload.event,
+        properties: payload.properties
+      })
+    }
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1,61 @@
+export interface RipeSDK {
+  group: ({
+    anonymousId,
+    userId,
+    messageId,
+    groupId,
+    traits
+  }: {
+    messageId?: string
+    anonymousId: string
+    userId?: string | null
+    groupId: string | null
+    traits?: Record<string, unknown>
+  }) => Promise<void>
+  identify: ({
+    messageId,
+    anonymousId,
+    userId,
+    groupId,
+    traits
+  }: {
+    messageId?: string
+    anonymousId: string
+    userId?: string | null
+    groupId?: string | null
+    traits?: Record<string, unknown>
+  }) => Promise<void>
+  init: (apiKey: string) => Promise<void>
+  page: ({
+    messageId,
+    anonymousId,
+    userId,
+    groupId,
+    category,
+    name,
+    properties
+  }: {
+    messageId?: string
+    anonymousId: string
+    userId?: string | null
+    groupId?: string | null
+    category?: string
+    name?: string
+    properties?: Record<string, unknown>
+  }) => Promise<void>
+  track: ({
+    messageId,
+    anonymousId,
+    userId,
+    groupId,
+    event,
+    properties
+  }: {
+    messageId?: string
+    anonymousId: string
+    userId?: string | null
+    groupId?: string | null
+    event: string
+    properties?: Record<string, unknown>
+  }) => Promise<void>
+}

package/tsconfig.json

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