@segment/analytics-browser-actions-stackadapt 1.0.0

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@segment/analytics-browser-actions-stackadapt",
+  "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/__tests__/index.test.ts

@@ -0,0 +1,59 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import stackadapt, { destination } from '..'
+
+describe('StackAdapt', () => {
+  test('can load stackadapt pixel', async () => {
+    const [event] = await stackadapt({
+      universalPixelId: 'test',
+      subscriptions: [
+        {
+          enabled: true,
+          name: 'Track Event',
+          subscribe: 'type = "track"',
+          partnerAction: 'trackEvent',
+          mapping: {
+            name: {
+              '@path': '$.name'
+            },
+            properties: {
+              '@path': '$.properties'
+            }
+          }
+        }
+      ]
+    })
+
+    destination.actions.trackEvent.perform = jest.fn()
+    jest.spyOn(destination.actions.trackEvent, 'perform')
+    jest.spyOn(destination, 'initialize')
+
+    await event.load(Context.system(), {} as Analytics)
+    expect(destination.initialize).toHaveBeenCalled()
+
+    const ctx = await event.track?.(
+      new Context({
+        type: 'track',
+        properties: {
+          abc: 'abc'
+        }
+      })
+    )
+
+    expect(destination.actions.trackEvent.perform).toHaveBeenCalled()
+    expect(ctx).not.toBeUndefined()
+
+    const scripts = window.document.querySelectorAll('script')
+    expect(scripts).toMatchInlineSnapshot(`
+      NodeList [
+        <script
+          src="https://tags.srv.stackadapt.com/events.js"
+          status="loaded"
+          type="text/javascript"
+        />,
+        <script>
+          // the emptiness
+        </script>,
+      ]
+    `)
+  })
+})

package/src/__tests__/page.test.ts

@@ -0,0 +1,49 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import stackadapt, { destination } from '..'
+
+describe('StackAdapt', () => {
+  test('can track page views', async () => {
+    const [trackPage] = await stackadapt({
+      universalPixelId: 'test',
+      subscriptions: [
+        {
+          enabled: true,
+          name: 'Track Page',
+          subscribe: 'type = "page"',
+          partnerAction: 'trackPage',
+          mapping: {
+            properties: {
+              '@path': '$.properties'
+            }
+          }
+        }
+      ]
+    })
+
+    destination.actions.trackPage.perform = jest.fn()
+    jest.spyOn(destination.actions.trackPage, 'perform')
+    jest.spyOn(destination, 'initialize')
+
+    await trackPage.load(Context.system(), {} as Analytics)
+    expect(destination.initialize).toHaveBeenCalled()
+    await trackPage.page?.(
+      new Context({
+        type: 'page',
+        properties: {
+          title: 'stackadapt.com'
+        }
+      })
+    )
+
+    expect(destination.actions.trackPage.perform).toHaveBeenCalledWith(
+      expect.any(Function),
+      expect.objectContaining({
+        payload: {
+          properties: {
+            title: 'stackadapt.com'
+          }
+        }
+      })
+    )
+  })
+})

package/src/__tests__/track.test.ts

@@ -0,0 +1,54 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import stackadapt, { destination } from '..'
+
+describe('StackAdapt', () => {
+  test('can track events', async () => {
+    const [event] = await stackadapt({
+      universalPixelId: 'test',
+      subscriptions: [
+        {
+          enabled: true,
+          name: 'Track Event',
+          subscribe: 'type = "track"',
+          partnerAction: 'trackEvent',
+          mapping: {
+            name: {
+              '@path': '$.event'
+            },
+            properties: {
+              '@path': '$.properties'
+            }
+          }
+        }
+      ]
+    })
+
+    destination.actions.trackEvent.perform = jest.fn()
+    jest.spyOn(destination.actions.trackEvent, 'perform')
+    jest.spyOn(destination, 'initialize')
+
+    await event.load(Context.system(), {} as Analytics)
+    expect(destination.initialize).toHaveBeenCalled()
+    await event.track?.(
+      new Context({
+        type: 'track',
+        event: 'checkout',
+        properties: {
+          item: 'nike react'
+        }
+      })
+    )
+
+    expect(destination.actions.trackEvent.perform).toHaveBeenCalledWith(
+      expect.any(Function),
+      expect.objectContaining({
+        payload: {
+          name: 'checkout',
+          properties: {
+            item: 'nike react'
+          }
+        }
+      })
+    )
+  })
+})

package/src/generated-types.ts

@@ -0,0 +1,8 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Settings {
+  /**
+   * The universal pixel id for StackAdapt.
+   */
+  universalPixelId: string
+}

package/src/index.ts

@@ -0,0 +1,56 @@
+import type { Settings } from './generated-types'
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
+import { browserDestination } from '@segment/browser-destination-runtime/shim'
+import { defaultValues } from '@segment/actions-core'
+import { initScript } from './init-script'
+import trackEvent, { trackEventDefaultSubscription } from './trackEvent'
+import trackPage, { trackPageDefaultSubscription } from './trackPage'
+import type { StackAdaptSDK } from './types'
+
+declare global {
+  interface Window {
+    saq: StackAdaptSDK
+  }
+}
+
+export const destination: BrowserDestinationDefinition<Settings, StackAdaptSDK> = {
+  name: 'StackAdapt (Actions)',
+  slug: 'actions-stackadapt',
+  mode: 'device',
+  presets: [
+    {
+      name: 'Track Event',
+      subscribe: trackEventDefaultSubscription,
+      partnerAction: 'trackEvent',
+      mapping: defaultValues(trackEvent.fields)
+    },
+    {
+      name: 'Track Page',
+      subscribe: trackPageDefaultSubscription,
+      partnerAction: 'trackPage',
+      mapping: defaultValues(trackPage.fields)
+    }
+  ],
+  settings: {
+    universalPixelId: {
+      description: 'The universal pixel id for StackAdapt.',
+      label: 'Universal Pixel Id',
+      type: 'string',
+      required: true
+    }
+  },
+
+  initialize: async (_, dependencies) => {
+    initScript()
+    await dependencies.loadScript('https://tags.srv.stackadapt.com/events.js')
+
+    return window.saq
+  },
+
+  actions: {
+    trackEvent,
+    trackPage
+  }
+}
+
+export default browserDestination(destination)

package/src/init-script.ts

@@ -0,0 +1,17 @@
+/* eslint-disable */
+// @ts-nocheck
+export function initScript() {
+  if (window.saq) return
+
+  // Slightly modified version of standard SA Pixel, as the script has already
+  // been loaded.
+  const sdk = (window.saq = function () {
+    sdk.callMethod ? sdk.callMethod.apply(sdk, arguments) : sdk.queue.push(arguments)
+  })
+
+  if (!window._saq) window._saq = sdk
+  sdk.push = sdk
+  sdk.loaded = true
+  sdk.version = '1.0'
+  sdk.queue = []
+}

package/src/trackEvent/generated-types.ts

@@ -0,0 +1,14 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The name of the event.
+   */
+  eventName: string
+  /**
+   * Hash of properties for this event.
+   */
+  eventProperties?: {
+    [k: string]: unknown
+  }
+}

package/src/trackEvent/index.ts

@@ -0,0 +1,43 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { StackAdaptSDK } from '../types'
+import type { Payload } from './generated-types'
+
+export const trackEventDefaultSubscription = 'type = "track"'
+
+const action: BrowserActionDefinition<Settings, StackAdaptSDK, Payload> = {
+  title: 'Track Event',
+  description: 'Track events',
+  platform: 'web',
+  defaultSubscription: trackEventDefaultSubscription,
+  fields: {
+    eventName: {
+      description: 'The name of the event.',
+      label: 'Name',
+      required: true,
+      type: 'string',
+      default: {
+        '@path': '$.event'
+      }
+    },
+    eventProperties: {
+      type: 'object',
+      required: false,
+      description: 'Hash of properties for this event.',
+      label: 'Event Properties',
+      default: {
+        '@path': '$.properties'
+      }
+    }
+  },
+  perform: (saq, { settings, payload }) => {
+    const pixelId = settings.universalPixelId
+
+    saq('ts', pixelId, {
+      eventName: payload.eventName,
+      ...(payload.eventProperties ?? {})
+    })
+  }
+}
+
+export default action

package/src/trackPage/generated-types.ts

@@ -0,0 +1,10 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * Hash of properties for this page view.
+   */
+  properties?: {
+    [k: string]: unknown
+  }
+}

package/src/trackPage/index.ts

@@ -0,0 +1,33 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { StackAdaptSDK } from '../types'
+import type { Payload } from './generated-types'
+
+export const trackPageDefaultSubscription = 'type = "page"'
+
+const action: BrowserActionDefinition<Settings, StackAdaptSDK, Payload> = {
+  title: 'Track Page',
+  description: 'Record when a user visits a page.',
+  platform: 'web',
+  defaultSubscription: trackPageDefaultSubscription,
+  fields: {
+    properties: {
+      type: 'object',
+      required: false,
+      description: 'Hash of properties for this page view.',
+      label: 'Page Properties',
+      default: {
+        '@path': '$.properties'
+      }
+    }
+  },
+  perform: (saq, { settings, payload }) => {
+    const pixelId = settings.universalPixelId
+
+    const properties = payload.properties ?? {}
+
+    saq('ts', pixelId, properties)
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1 @@
+export type StackAdaptSDK = (name: string, pixelId: string, payload: Record<string, unknown>) => void

package/tsconfig.json

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