add Report Content Event to customerio destination

packages/destination-actions/src/destinations/customerio/__tests__/reportContentEvent.test.ts

@@ -0,0 +1,104 @@
+import { createTestEvent, createTestIntegration } from '@segment/actions-core'
+import CustomerIO from '../index'
+import dayjs from '../../../lib/dayjs'
+import { AccountRegion } from '../utils'
+import { nockTrackInternalEndpoint } from '../test-helper'
+
+const trackService = nockTrackInternalEndpoint(AccountRegion.US)
+
+describe('CustomerIO', () => {
+  describe('reportContentEvent', () => {
+    const testDestination = createTestIntegration(CustomerIO)
+
+    type testCase = {
+      name: string
+      anonymousId: string
+      properties: { [key: string]: any }
+      expected: { [key: string]: any }
+    }
+
+    const testCases: testCase[] = [
+      {
+        name: 'should work with viewed',
+        anonymousId: 'abc123',
+        properties: {
+          actionType: 'viewed_content',
+          contentType: 'ctype',
+          contentId: 1,
+          templateId: 1
+        },
+        expected: {
+          action: 'viewed_content',
+          attributes: {
+            contentType: 'ctype',
+            contentId: 1,
+            templateId: 1
+          },
+          identifiers: {
+            anonymous_id: 'abc123'
+          },
+          name: 'viewed_content',
+          type: 'person'
+        }
+      },
+      {
+        name: 'should work with clicked',
+        anonymousId: 'abc123',
+        properties: {
+          actionType: 'clicked_content',
+          contentType: 'ctype',
+          contentId: 1,
+          templateId: 1,
+          actionName: 'aname',
+          actionValue: 'avalue'
+        },
+        expected: {
+          action: 'clicked_content',
+          attributes: {
+            contentType: 'ctype',
+            contentId: 1,
+            templateId: 1,
+            actionName: 'aname',
+            actionValue: 'avalue'
+          },
+          identifiers: {
+            anonymous_id: 'abc123'
+          },
+          name: 'clicked_content',
+          type: 'person'
+        }
+      }
+    ]
+
+    testCases.forEach((testCase) => {
+      it(testCase.name, async () => {
+        trackService.post(`/api/v2/entity`).reply(200, {}, { 'x-customerio-region': 'US' })
+
+        const now = dayjs.utc()
+        const event = createTestEvent({
+          anonymousId: testCase.anonymousId,
+          timestamp: now.toISOString(),
+          type: 'track',
+          event: 'Report Content Event',
+          properties: testCase.properties
+        })
+        const responses = await testDestination.testAction('reportContentEvent', {
+          event,
+          useDefaultMappings: true
+        })
+
+        expect(responses.length).toBe(1)
+        expect(responses[0].status).toBe(200)
+        expect(responses[0].headers.toJSON()).toMatchObject({
+          'x-customerio-region': 'US',
+          'content-type': 'application/json'
+        })
+        expect(responses[0].data).toMatchObject({})
+        expect(responses[0].options.json).toEqual({
+          ...testCase.expected,
+          timestamp: now.unix()
+        })
+      })
+    })
+  })
+})

packages/destination-actions/src/destinations/customerio/index.ts

@@ -8,6 +8,7 @@ import deleteObject from './deleteObject'
 import deletePerson from './deletePerson'
 import mergePeople from './mergePeople'
 import reportDeliveryEvent from './reportDeliveryEvent'
+import reportContentEvent from './reportContentEvent'
 import suppressPerson from './suppressPerson'
 import unsuppressPerson from './unsuppressPerson'
 import trackEvent from './trackEvent'
@@ -72,7 +73,8 @@ const destination: DestinationDefinition<Settings> = {
     mergePeople,
     suppressPerson,
     unsuppressPerson,
-    reportDeliveryEvent
+    reportDeliveryEvent,
+    reportContentEvent
   },
 
   presets: [
@@ -103,6 +105,7 @@ const destination: DestinationDefinition<Settings> = {
         and event != "User Unsuppressed"
         and event != "Object Deleted"
         and event != "Report Delivery Event"
+        and event != "Report Content Event"
       `,
       partnerAction: 'trackEvent',
       mapping: defaultValues(trackEvent.fields),
@@ -136,6 +139,13 @@ const destination: DestinationDefinition<Settings> = {
       mapping: defaultValues(reportDeliveryEvent.fields),
       type: 'automatic'
     },
+    {
+      name: 'Report Content Event',
+      subscribe: 'event = "Report Content Event"',
+      partnerAction: 'reportContentEvent',
+      mapping: defaultValues(reportContentEvent.fields),
+      type: 'automatic',
+    },
     {
       name: 'Associated Entity Added',
       partnerAction: 'trackEvent',

packages/destination-actions/src/destinations/customerio/reportContentEvent/index.ts

@@ -0,0 +1,81 @@
+import type { ActionDefinition } from '@segment/actions-core'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { sendBatch, sendSingle } from '../utils'
+
+const action: ActionDefinition<Settings, Payload> = {
+  title: 'Report Content Event',
+  description: 'Report a Viewed or Clicked Content event.',
+  defaultSubscription: 'event = "Report Content Event"',
+  fields: {
+    anonymous_id: {
+      label: 'Anonymous ID',
+      description: 'ID for the anonymous user.',
+      type: 'string',
+      default: {
+        '@path': '$.anonymousId'
+      }
+    },
+    actionType: {
+      label: 'Action Type',
+      description: 'The type of content event.',
+      type: 'string',
+      required: true,
+      default: {
+        '@path': '$.properties.actionType'
+      },
+      choices: [
+        { label: 'Viewed', value: 'viewed_content' },
+        { label: 'Clicked', value: 'clicked_content' }
+      ]
+    },
+    timestamp: {
+      label: 'Timestamp',
+      description: 'A timestamp of when the event took place. Default is current date and time.',
+      type: 'string',
+      default: {
+        '@path': '$.timestamp'
+      }
+    },
+    data: {
+      label: 'Event Attributes',
+      description: 'Optional data to include with the event.',
+      type: 'object',
+      default: {
+        '@path': '$.properties'
+      }
+    },
+    convert_timestamp: {
+      label: 'Convert Timestamps',
+      description: 'Convert dates to Unix timestamps (seconds since Epoch).',
+      type: 'boolean',
+      default: true
+    },
+  },
+  performBatch: (request, { payload: payloads, ...rest }) => {
+    return sendBatch(
+      request,
+      payloads.map((payload) => ({ ...rest, action: payload.actionType, payload: mapPayload(payload), type: 'person' }))
+    )
+  },
+
+  perform: (request, { payload, ...rest }) => {
+    return sendSingle(request, { ...rest, action: payload.actionType, payload: mapPayload(payload), type: 'person' })
+  }
+}
+
+function mapPayload(payload: Payload) {
+  const { actionType, data, ...rest } = payload
+
+  if (data?.actionType) {
+    delete data.actionType
+  }
+
+  return {
+    ...rest,
+    name: actionType,
+    attributes: data
+  }
+}
+
+export default action