@segment/analytics-browser-actions-jimo 1.0.1-onSubscriptionSave.1695

package/README.md

@@ -0,0 +1,31 @@
+# @segment/analytics-browser-actions-jimo
+
+The Jimo browser action destination for use with @segment/analytics-next.
+
+## License
+
+MIT License
+
+Copyright (c) 2023 Segment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## Contributing
+
+All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@segment/analytics-browser-actions-jimo",
+  "version": "1.0.1-onSubscriptionSave.1695+c605951c",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "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/browser-destination-runtime": "^1.14.1-onSubscriptionSave.50+c605951c"
+  },
+  "peerDependencies": {
+    "@segment/analytics-next": ">=1.55.0"
+  },
+  "gitHead": "c605951c8cd226a806a2da74654cdefbcda1f5f4"
+}

package/src/generated-types.ts

@@ -0,0 +1,12 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Settings {
+  /**
+   * Id of the Jimo project. You can find it here: https://i.usejimo.com/settings/install/portal
+   */
+  projectId: string
+  /**
+   * Make sure Jimo is not initialized automatically after being added to your website. For more information, check out: https://help.usejimo.com/knowledge-base/for-developers/sdk-guides/manual-initialization
+   */
+  manualInit?: boolean
+}

package/src/index.ts

@@ -0,0 +1,63 @@
+import { defaultValues } from '@segment/actions-core'
+import { browserDestination } from '@segment/browser-destination-runtime/shim'
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from './generated-types'
+import { initScript } from './init-script'
+import sendUserData from './sendUserData'
+import { JimoSDK } from './types'
+
+declare global {
+  interface Window {
+    jimo: JimoSDK | never[]
+    JIMO_PROJECT_ID: string
+    JIMO_MANUAL_INIT: boolean
+  }
+}
+
+const ENDPOINT_UNDERCITY = 'https://undercity.usejimo.com/jimo-invader.js'
+
+export const destination: BrowserDestinationDefinition<Settings, JimoSDK> = {
+  name: 'Jimo (Actions)',
+  slug: 'actions-jimo',
+  mode: 'device',
+  description: 'Load Jimo SDK and send user profile data to Jimo',
+
+  settings: {
+    projectId: {
+      description:
+        'Id of the Jimo project. You can find the Project Id here: https://i.usejimo.com/settings/install/portal',
+      label: 'Id',
+      type: 'string',
+      required: true
+    },
+    manualInit: {
+      label: 'Initialize Jimo manually',
+      description:
+        'Toggling to true will prevent Jimo from initializing automatically. For more information, check out: https://help.usejimo.com/knowledge-base/for-developers/sdk-guides/manual-initialization',
+      type: 'boolean',
+      required: false,
+      default: false
+    }
+  },
+  presets: [
+    {
+      name: 'Send User Data',
+      subscribe: 'type = "identify"',
+      partnerAction: 'sendUserData',
+      mapping: defaultValues(sendUserData.fields),
+      type: 'automatic'
+    }
+  ],
+  initialize: async ({ settings }, deps) => {
+    initScript(settings)
+
+    await deps.loadScript(`${ENDPOINT_UNDERCITY}`)
+
+    return window.jimo as JimoSDK
+  },
+  actions: {
+    sendUserData
+  }
+}
+
+export default browserDestination(destination)

package/src/init-script.ts

@@ -0,0 +1,12 @@
+import { Settings } from './generated-types'
+/* eslint-disable */
+// @ts-nocheck
+export function initScript(settings: Settings) {
+  if (window.jimo) {
+    return
+  }
+
+  window.jimo = []
+  window['JIMO_PROJECT_ID'] = settings.projectId
+  window['JIMO_MANUAL_INIT'] = settings.manualInit === true
+}

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

@@ -0,0 +1,50 @@
+import { Analytics, Context } from '@segment/analytics-next'
+
+import sendUserData from '..'
+import { JimoSDK } from '../../types'
+import { Payload } from '../generated-types'
+
+describe('Jimo - Send User Data', () => {
+  test('user id', async () => {
+    const client = {
+      push: jest.fn()
+    } as any as JimoSDK
+
+    const context = new Context({
+      type: 'identify'
+    })
+
+    await sendUserData.perform(client as any as JimoSDK, {
+      settings: { projectId: 'unk' },
+      analytics: jest.fn() as any as Analytics,
+      context: context,
+      payload: {
+        userId: 'u1'
+      } as Payload
+    })
+
+    expect(client.push).toHaveBeenCalled()
+    expect(client.push).toHaveBeenCalledWith(['set', 'user:id', ['u1']])
+  })
+  test('user email', async () => {
+    const client = {
+      push: jest.fn()
+    } as any as JimoSDK
+
+    const context = new Context({
+      type: 'identify'
+    })
+
+    await sendUserData.perform(client as any as JimoSDK, {
+      settings: { projectId: 'unk' },
+      analytics: jest.fn() as any as Analytics,
+      context: context,
+      payload: {
+        email: 'foo@bar.com'
+      } as Payload
+    })
+
+    expect(client.push).toHaveBeenCalled()
+    expect(client.push).toHaveBeenCalledWith(['set', 'user:email', ['foo@bar.com']])
+  })
+})

package/src/sendUserData/generated-types.ts

@@ -0,0 +1,12 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The users's id provided by segment
+   */
+  userId?: string | null
+  /**
+   * The email of the user
+   */
+  email?: string | null
+}

package/src/sendUserData/index.ts

@@ -0,0 +1,45 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import { JimoSDK } from 'src/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+
+const action: BrowserActionDefinition<Settings, JimoSDK, Payload> = {
+  title: 'Send User Data',
+  description: 'Send user ID and email to Jimo',
+  platform: 'web',
+  fields: {
+    userId: {
+      label: 'User ID',
+      description: 'The unique user identifier',
+      type: 'string',
+      allowNull: true,
+      required: false,
+      default: {
+        '@path': '$.userId'
+      }
+    },
+    email: {
+      label: 'User email',
+      description: 'The email of the user',
+      type: 'string',
+      allowNull: true,
+      required: false,
+      default: {
+        '@path': '$.traits.email'
+      }
+    }
+  },
+  defaultSubscription: 'type = "identify"',
+  perform: (jimo, { payload }) => {
+    if (payload.userId != null) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+      jimo.push(['set', 'user:id', [payload.userId]])
+    }
+    if (payload.email != null) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+      jimo.push(['set', 'user:email', [payload.email]])
+    }
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1,3 @@
+export interface JimoSDK {
+  push: (params: Array<string | string[]>) => Promise<void>
+}

package/tsconfig.json

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