@segment/analytics-browser-actions-cj 1.1.0

package/src/order/utils.ts

@@ -0,0 +1,19 @@
+import { CJ } from '../types'
+
+export function getCookieValue(cookieName: string): string | null {
+  const name = cookieName + '='
+  const decodedCookie = decodeURIComponent(document.cookie)
+  const cookieArray = decodedCookie.split('; ')
+
+  for (const cookie of cookieArray) {
+    if (cookie.startsWith(name)) {
+      return cookie.substring(name.length)
+    }
+  }
+
+  return null
+}
+
+export function setOrderJSON(cj: CJ, orderJSON: CJ['order']) {
+  cj.order = orderJSON
+}

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

@@ -0,0 +1,124 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import { Subscription } from '@segment/browser-destination-runtime'
+import CJDestination, { destination } from '../../index'
+import { CJ } from '../../types'
+import * as sendModule from '../../utils'
+import * as sitePageModule from '../utils'
+
+describe('CJ init', () => {
+  const settings = {
+    tagId: '123456789',
+    actionTrackerId: '987654321'
+  }
+
+  let mockCJ: CJ
+  let sitePageEvent: any
+  beforeEach(async () => {
+    jest.spyOn(destination, 'initialize').mockImplementation(() => {
+      mockCJ = {} as CJ
+      return Promise.resolve(mockCJ)
+    })
+
+    jest.spyOn(sendModule, 'send').mockImplementation(() => {
+      return Promise.resolve()
+    })
+
+    jest.spyOn(sitePageModule, 'setSitePageJSON')
+    
+  })
+
+  afterEach(() => {
+    jest.restoreAllMocks()
+  })
+
+  test('CJ pixel sitePage event', async () => {
+    const subscriptions: Subscription[] = [
+      {
+        partnerAction: 'sitePage',
+        name: 'sitePage',
+        enabled: true,
+        subscribe: 'type = "page"',
+        mapping: {
+          userId: { '@path': '$.userId' },
+          enterpriseId: 999999,
+          pageType: 'homepage',
+          referringChannel: { '@path': '$.properties.referring_channel' },
+          cartSubtotal: { '@path': '$.properties.sub_total' },
+          items: {
+            '@arrayPath': [
+              '$.properties.products',
+              {
+                itemPrice: { '@path': '$.price' },
+                itemId: { '@path': '$.id' },
+                quantity: { '@path': '$.quantity' },
+                discount: { '@path': '$.discount' }
+              }
+            ]
+          }
+        }
+      }
+    ]
+    const context = new Context({
+      type: 'page',
+      userId: 'userId-abc123',
+      properties: {
+        referring_channel: 'Email',
+        sub_total: 10.99,
+        products: [
+          {
+            id: '123',
+            quantity: 1,
+            price: 1,
+            discount: 0.5
+          },
+          {
+            id: '456',
+            quantity: 2,
+            price: 2,
+            discount: 0
+          }
+        ]
+      }
+    })
+    const [event] = await CJDestination({
+      ...settings,
+      subscriptions
+    })
+
+    const sitePageJSON = {
+        userId: 'userId-abc123',
+        enterpriseId: 999999,
+        pageType: 'homepage',
+        referringChannel: 'Email',
+        cartSubtotal: 10.99,
+        items:[
+          {
+            itemId: '123',
+            quantity: 1,
+            itemPrice: 1,
+            discount: 0.5
+          },
+          {
+            itemId: '456',
+            quantity: 2,
+            itemPrice: 2,
+            discount: 0
+          }
+        ]
+    }
+
+    sitePageEvent = event
+    const sendSpy = jest.spyOn(sendModule, 'send').mockResolvedValue(undefined)
+    await sitePageEvent.load(Context.system(), {} as Analytics)
+    await sitePageEvent.track?.(context)
+    expect(destination.initialize).toHaveBeenCalled()
+    expect(sitePageModule.setSitePageJSON).toHaveBeenCalled()
+    expect(sitePageModule.setSitePageJSON).toHaveBeenCalledWith(
+      expect.any(Object), 
+      expect.objectContaining(sitePageJSON)
+    )
+    expect(sendSpy).toHaveBeenCalledWith('123456789') 
+    expect(mockCJ.sitePage).toBe(undefined)
+    expect(mockCJ.order).toBe(undefined)
+  })
+})

package/src/sitePage/generated-types.ts

@@ -0,0 +1,45 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * A unique ID assigned by you to the user.
+   */
+  userId?: string
+  /**
+   * Your CJ Enterprise ID.
+   */
+  enterpriseId: number
+  /**
+   * Page type to be sent to CJ.
+   */
+  pageType: string
+  /**
+   * The referring channel to be sent to CJ.
+   */
+  referringChannel?: string
+  /**
+   * The cart subtotal to be sent to CJ.
+   */
+  cartSubtotal?: number
+  /**
+   * The items to be sent to CJ.
+   */
+  items?: {
+    /**
+     * the price of the item before tax and discount.
+     */
+    unitPrice: number
+    /**
+     * The item sku.
+     */
+    itemId: string
+    /**
+     * The quantity of the item.
+     */
+    quantity: number
+    /**
+     * The discount applied to the item.
+     */
+    discount?: number
+  }[]
+}

package/src/sitePage/index.ts

@@ -0,0 +1,128 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { CJ } from '../types'
+import { send } from '../utils'
+import { setSitePageJSON } from './utils'
+
+const action: BrowserActionDefinition<Settings, CJ, Payload> = {
+  title: 'Site Page',
+  description: 'Send site page data to CJ.',
+  platform: 'web',
+  defaultSubscription: 'type = "page"',
+  fields: {
+    userId: {
+      label: 'User ID',
+      description: 'A unique ID assigned by you to the user.',
+      type: 'string',
+      required: false,
+      default: { '@path': '$.userId' }
+    },
+    enterpriseId: {
+      label: 'Enterprise ID',
+      description: 'Your CJ Enterprise ID.',
+      type: 'number',
+      required: true
+    },
+    pageType: {
+      label: 'Page Type',
+      description: 'Page type to be sent to CJ.',
+      type: 'string',
+      choices: [
+        { label: 'Account Center', value: 'accountCenter' },
+        { label: 'Account Signup', value: 'accountSignup' },
+        { label: 'Application Start', value: 'applicationStart' },
+        { label: 'Branch Locator', value: 'branchLocator' },
+        { label: 'Cart', value: 'cart' },
+        { label: 'Category', value: 'category' },
+        { label: 'Conversion Confirmation', value: 'conversionConfirmation' },
+        { label: 'Department', value: 'department' },
+        { label: 'Homepage', value: 'homepage' },
+        { label: 'Information', value: 'information' },
+        { label: 'Product Detail', value: 'productDetail' },
+        { label: 'Property Detail', value: 'propertyDetail' },
+        { label: 'Property Results', value: 'propertyResults' },
+        { label: 'Search Results', value: 'searchResults' },
+        { label: 'Store Locator', value: 'storeLocator' },
+        { label: 'Sub Category', value: 'subCategory' }
+      ],
+      required: true
+    },
+    referringChannel: {
+      label: 'Referring Channel',
+      description: 'The referring channel to be sent to CJ.',
+      type: 'string',
+      choices: [
+        { label: 'Affiliate', value: 'Affiliate' },
+        { label: 'Display', value: 'Display' },
+        { label: 'Social', value: 'Social' },
+        { label: 'Search', value: 'Search' },
+        { label: 'Email', value: 'Email' },
+        { label: 'Direct Navigation', value: 'Direct_Navigation' }
+      ]
+    },
+    cartSubtotal: {
+      label: 'Cart Subtotal',
+      description: 'The cart subtotal to be sent to CJ.',
+      type: 'number',
+      required: false
+    },
+    items: {
+      label: 'Items',
+      description: 'The items to be sent to CJ.',
+      type: 'object',
+      multiple: true,
+      properties: {
+        unitPrice: {
+          label: 'Unit Price',
+          description: 'the price of the item before tax and discount.',
+          type: 'number',
+          required: true
+        },
+        itemId: {
+          label: 'Item ID',
+          description: 'The item sku.',
+          type: 'string',
+          required: true
+        },
+        quantity: {
+          label: 'Quantity',
+          description: 'The quantity of the item.',
+          type: 'number',
+          required: true
+        },
+        discount: {
+          label: 'Discount',
+          description: 'The discount applied to the item.',
+          type: 'number',
+          required: false
+        }
+      },
+      default: {
+        '@arrayPath': [
+          '$.properties.products',
+          {
+            itemPrice: { '@path': '$.price' },
+            itemId: { '@path': '$.id' },
+            quantity: { '@path': '$.quantity' },
+            discount: { '@path': '$.discount' }
+          }
+        ]
+      }
+    }
+  },
+  perform: (cj, { payload, settings }) => {
+    setSitePageJSON(cj, payload)
+    const { tagId } = settings
+    send(tagId)
+      .then(() => {
+        cj.sitePage = undefined
+        cj.order = undefined
+      })
+      .catch((err) => {
+        console.warn(err)
+      })
+  }
+}
+
+export default action

package/src/sitePage/utils.ts

@@ -0,0 +1,5 @@
+import { CJ } from '../types'
+
+export function setSitePageJSON(cj: CJ, sitePageJSON: CJ['sitePage']) {
+  cj.sitePage = sitePageJSON
+}

package/src/types.ts

@@ -0,0 +1,38 @@
+export interface CJ {
+  sitePage?: {
+    enterpriseId: number
+    pageType: string
+    referringChannel?: string
+    cartSubtotal?: number
+    items?: Item[]
+    userId?: string
+  }
+  order?: SimpleOrder | AdvancedOrder
+}
+
+export interface Item {
+  unitPrice: number
+  itemId: string
+  quantity: number
+  discount?: number
+}
+
+export interface SimpleOrder {
+  trackingSource: 'Segment'
+  enterpriseId: number
+  pageType?: string
+  userId?: string
+  emailHash?: string
+  orderId: string
+  actionTrackerId?: string // This is required. If not provided, log a warning to the console.
+  currency: string
+  amount: number // should default to 0 if not provided
+  discount?: number
+  coupon?: string
+  cjeventOrder?: string //required whenever advertiser uses their own cookie to store the Event ID
+}
+
+export interface AdvancedOrder extends SimpleOrder {
+  items: Item[]
+}
+

package/src/utils.ts

@@ -0,0 +1,21 @@
+/* eslint-disable */
+// @ts-nocheck
+
+export function send(tagId): Promise<void> {
+  return new Promise((resolve, reject) => {
+    ;(function (a, b, c, d) {
+      a = `//www.mczbf.com/tags/${tagId}/tag.js`
+      b = document
+      c = 'script'
+      d = b.createElement(c)
+      d.src = a
+      d.type = 'text/java' + c
+      d.async = true
+      d.id = 'cjapitag'
+      d.onload = () => resolve()
+      d.onerror = () => reject(new Error('JC script failed to load correctly'))
+      a = b.getElementsByTagName(c)[0]
+      a.parentNode.insertBefore(d, a)
+    })()
+  })
+}

package/tsconfig.json

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