@segment/analytics-browser-actions-iterate 1.0.0

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@segment/analytics-browser-actions-iterate",
+  "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,62 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import iterateDestination, { destination } from '../index'
+import { Subscription } from '@segment/browser-destination-runtime/types'
+
+const subscriptions: Subscription[] = [
+  {
+    partnerAction: 'trackEvent',
+    name: 'Track Event',
+    enabled: true,
+    subscribe: 'type = "track"',
+    mapping: {
+      name: {
+        '@path': '$.name'
+      }
+    }
+  }
+]
+
+describe('Iterate initialization', () => {
+  test('can load Iterate', async () => {
+    const [event] = await iterateDestination({
+      apiKey: 'abc123',
+      subscriptions
+    })
+
+    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',
+        name: 'example-event'
+      })
+    )
+
+    expect(destination.actions.trackEvent.perform).toHaveBeenCalled()
+    expect(ctx).not.toBeUndefined()
+
+    const scripts = window.document.querySelectorAll('script')
+    scripts[0].src = scripts[0].src.replace(/match-prod-.*.js/, 'match-prod.js')
+    expect(scripts).toMatchInlineSnapshot(`
+      NodeList [
+        <script
+          id="iterate-script"
+          src="https://platform.iteratehq.com/match-prod.js"
+          type="text/javascript"
+        />,
+        <script
+          src="https://platform.iteratehq.com/loader.js"
+          status="loaded"
+          type="text/javascript"
+        />,
+        <script>
+          // the emptiness
+        </script>,
+      ]
+    `)
+  })
+})

package/src/generated-types.ts

@@ -0,0 +1,8 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Settings {
+  /**
+   * The Embed API Key for your account. You can find this on your settings pages.
+   */
+  apiKey: string
+}

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

@@ -0,0 +1,52 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import iterateDestination, { destination } from '../../index'
+
+describe('Iterate.identifyUser', () => {
+  it('Should call identify', async () => {
+    const [identifyEvent] = await iterateDestination({
+      apiKey: '123',
+      subscriptions: [
+        {
+          partnerAction: 'identifyUser',
+          name: 'Identify User',
+          enabled: true,
+          subscribe: 'type = "identify"',
+          mapping: {
+            userId: {
+              '@path': '$.userId'
+            },
+            traits: {
+              '@path': '$.traits'
+            }
+          }
+        }
+      ]
+    })
+
+    destination.actions.identifyUser.perform = jest.fn()
+    const identifySpy = jest.spyOn(destination.actions.identifyUser, 'perform')
+    await identifyEvent.load(Context.system(), {} as Analytics)
+
+    await identifyEvent.identify?.(
+      new Context({
+        type: 'identify',
+        userId: '123abc',
+        traits: {
+          foo: 'bar'
+        }
+      })
+    )
+
+    expect(identifySpy).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        payload: {
+          userId: '123abc',
+          traits: {
+            foo: 'bar'
+          }
+        }
+      })
+    )
+  })
+})

package/src/identifyUser/generated-types.ts

@@ -0,0 +1,14 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The user's identity.
+   */
+  userId?: string
+  /**
+   * The Segment traits to be forwarded to Iterate.
+   */
+  traits?: {
+    [k: string]: unknown
+  }
+}

package/src/identifyUser/index.ts

@@ -0,0 +1,42 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { Iterate as IterateClient, Command } from '../types'
+
+const action: BrowserActionDefinition<Settings, IterateClient, Payload> = {
+  title: 'Identify User',
+  description: 'Sets user identity',
+  platform: 'web',
+  defaultSubscription: 'type = "identify"',
+  fields: {
+    userId: {
+      type: 'string',
+      required: false,
+      description: "The user's identity.",
+      label: 'Identity',
+      default: {
+        '@path': '$.userId'
+      }
+    },
+    traits: {
+      type: 'object',
+      required: false,
+      description: 'The Segment traits to be forwarded to Iterate.',
+      label: 'Traits',
+      default: {
+        '@path': '$.traits'
+      }
+    }
+  },
+  perform: (Iterate, event) => {
+    const traits = event.payload.traits || {}
+
+    if (event.payload.userId) {
+      traits['external_id'] = event.payload.userId
+    }
+
+    Iterate(Command.Identify, traits)
+  }
+}
+
+export default action

package/src/index.ts

@@ -0,0 +1,80 @@
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
+import { browserDestination } from '@segment/browser-destination-runtime/shim'
+import type { Settings } from './generated-types'
+import { Iterate, IterateApi, IterateSettings } from './types'
+import { defaultValues } from '@segment/actions-core'
+
+import trackEvent from './trackEvent'
+import identifyUser from './identifyUser'
+
+// Declare global to access your client
+declare global {
+  interface Window {
+    Iterate: Iterate
+    iterateSettings: IterateSettings
+    IterateObjectName: string
+  }
+}
+
+// Switch from unknown to the partner SDK client types
+export const destination: BrowserDestinationDefinition<Settings, Iterate> = {
+  name: 'Iterate Web (Actions)',
+  slug: 'actions-iterate',
+  mode: 'device',
+  presets: [
+    {
+      name: 'Track Event',
+      subscribe: 'type = "track"',
+      partnerAction: 'trackEvent',
+      mapping: defaultValues(trackEvent.fields)
+    },
+    {
+      name: 'Identify User',
+      subscribe: 'type = "identify"',
+      partnerAction: 'identifyUser',
+      mapping: defaultValues(identifyUser.fields)
+    }
+  ],
+
+  settings: {
+    // Add any Segment destination settings required here
+    apiKey: {
+      label: 'Embed API Key',
+      description: 'The Embed API Key for your account. You can find this on your settings pages.',
+      type: 'string',
+      required: true
+    }
+  },
+
+  initialize: async ({ settings }, deps) => {
+    // initialize settings
+    window.iterateSettings = {
+      apiKey: settings.apiKey,
+      installOnLoad: false
+    }
+    window.IterateObjectName = 'Iterate'
+
+    // Initialize placeholder Iterate command
+    const iteratePlaceholder = <IterateApi>function (...args) {
+      iteratePlaceholder.command(args)
+    }
+    iteratePlaceholder.loaded = false
+    iteratePlaceholder.q = []
+    iteratePlaceholder.command = function (args: unknown[]) {
+      iteratePlaceholder.q.push(args)
+    }
+    window.Iterate = iteratePlaceholder
+
+    await deps.loadScript('https://platform.iteratehq.com/loader.js')
+    await deps.resolveWhen(() => !Object.prototype.hasOwnProperty.call(window.Iterate, 'loaded'), 100)
+
+    return window.Iterate
+  },
+
+  actions: {
+    trackEvent,
+    identifyUser
+  }
+}
+
+export default browserDestination(destination)

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

@@ -0,0 +1,43 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import iterateDestination, { destination } from '../../index'
+
+describe('Iterate.trackEvent', () => {
+  it('Sends events to Iterate', async () => {
+    const [trackEvent] = await iterateDestination({
+      apiKey: 'abc123',
+      subscriptions: [
+        {
+          partnerAction: 'trackEvent',
+          name: 'Track Event',
+          enabled: true,
+          subscribe: 'type = "track"',
+          mapping: {
+            name: {
+              '@path': '$.name'
+            }
+          }
+        }
+      ]
+    })
+
+    destination.actions.trackEvent.perform = jest.fn()
+    const trackSpy = jest.spyOn(destination.actions.trackEvent, 'perform')
+    await trackEvent.load(Context.system(), {} as Analytics)
+
+    await trackEvent.track?.(
+      new Context({
+        type: 'track',
+        name: 'example-event'
+      })
+    )
+
+    expect(trackSpy).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        payload: {
+          name: 'example-event'
+        }
+      })
+    )
+  })
+})

package/src/trackEvent/generated-types.ts

@@ -0,0 +1,8 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The name of the event.
+   */
+  name: string
+}

package/src/trackEvent/index.ts

@@ -0,0 +1,27 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { Iterate as IterateClient, Command } from '../types'
+
+const action: BrowserActionDefinition<Settings, IterateClient, Payload> = {
+  title: 'Track Event',
+  description: 'Track events',
+  platform: 'web',
+  defaultSubscription: 'type = "track"',
+  fields: {
+    name: {
+      description: 'The name of the event.',
+      label: 'Name',
+      required: true,
+      type: 'string',
+      default: {
+        '@path': '$.event'
+      }
+    }
+  },
+  perform: (Iterate, event) => {
+    Iterate(Command.Event, event.payload.name)
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1,23 @@
+export type Iterate = (command: Command, ...args: unknown[]) => void
+
+export enum Command {
+  Event = 'event',
+  Install = 'install',
+  Identify = 'identify',
+  OnResponse = 'onResponse',
+  OnLoad = 'onLoad',
+  onClose = 'onClose',
+  Uninstall = 'uninstall'
+}
+
+export type IterateApi = {
+  (): void
+  q: unknown[]
+  command: (args: unknown[]) => void
+  loaded: boolean
+}
+
+export type IterateSettings = {
+  apiKey: string
+  installOnLoad?: boolean
+}

package/tsconfig.json

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