@segment/analytics-browser-actions-ms-bing-capi 1.0.1-staging-fb8bbedd8.0 → 1.0.1-staging-feeb4db0d.0

package/src/index.ts

@@ -1,20 +1,28 @@
 import type { Settings } from './generated-types'
 import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
 import { browserDestination } from '@segment/browser-destination-runtime/shim'
-
-import msclickId from './msclickId'
+import { storageClickIdKey, clickIdQuerystringName, storageFallback } from './utils'
+import { UniversalStorage } from '@segment/analytics-next'
+import msclkidPlugin from './msclkidPlugin'
 
 // Switch from unknown to the partner SDK client types
-export const destination: BrowserDestinationDefinition<Settings, unknown> = {
-  name: 'Ms Bing Capi Plugin',
+export const destination: BrowserDestinationDefinition<Settings, {}> = {
+  name: 'Microsoft Bing CAPI Browser Plugins',
   mode: 'device',
-  initialize: async () => {
-    // initialize client code here
+  initialize: async ({ analytics }) => {
+    const storage = (analytics.storage as UniversalStorage<Record<string, string>>) ?? storageFallback
+    const urlParams = new URLSearchParams(window.location.search)
+    const msclkid: string | null = urlParams.get(clickIdQuerystringName) || null
+
+    if (msclkid) {
+      storage.set(storageClickIdKey, msclkid)
+    }
+
     return {}
   },
-
+  settings: {},
   actions: {
-    msclickId
+    msclkidPlugin
   }
 }
 

package/src/msclkidPlugin/generated-types.ts

@@ -0,0 +1,3 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {}

package/src/msclkidPlugin/index.ts

@@ -0,0 +1,29 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { storageClickIdKey, clickIdIntegrationFieldName, storageFallback } from '../utils'
+import { UniversalStorage } from '@segment/analytics-next'
+
+const action: BrowserActionDefinition<Settings, {}, Payload> = {
+  title: 'Microsoft Bing msclkid Browser Plugin',
+  description: 'Enriches all Segment payloads with the Microsoft Bing msclkid Querystring value',
+  platform: 'web',
+  hidden: false,
+  defaultSubscription: 'type = "track" or type = "identify" or type = "page" or type = "group" or type = "alias"',
+  fields: {},
+  lifecycleHook: 'enrichment',
+  perform: (_, { context, analytics }) => {
+    const storage = (analytics.storage as UniversalStorage<Record<string, string>>) ?? storageFallback
+    const msclkid: string | null = storage.get(storageClickIdKey)
+    const integrationsData: Record<string, string> = {}
+    if (msclkid) {
+      integrationsData[clickIdIntegrationFieldName] = msclkid
+      if (context.event.integrations?.All !== false || context.event.integrations['Snap Conversions Api']) {
+        context.updateEvent(`integrations.Microsoft Bing CAPI`, integrationsData)
+      }
+    }
+    return
+  }
+}
+
+export default action

package/src/utils.ts

@@ -0,0 +1,32 @@
+// The name of the storage location where we'll cache the MS Bing msclkid Querystring value
+export const storageClickIdKey = 'analytics_ms_capi_click_id'
+
+// The name of the MS Bing msclkid querystring to retrieve when the page loads
+export const clickIdQuerystringName = 'msclkid'
+
+// The field name to include for the Microsoft Bing CAPI msclkid Querystring in the 'context.integrations.Microsoft Bing CAPI' object
+export const clickIdIntegrationFieldName = 'msclkid'
+
+export const 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 const storageFallback = {
+  get: (key: string) => {
+    const data = window.localStorage.getItem(key)
+    return data
+  },
+  set: (key: string, value: string) => {
+    return window.localStorage.setItem(key, value)
+  }
+}

package/dist/cjs/msclickId/generated-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/msclickId/generated-types.ts"],"names":[],"mappings":""}

package/dist/cjs/msclickId/index.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const uuid_1 = require("@lukeed/uuid");
-function newMsclk() {
-    return (0, uuid_1.v4)();
-}
-function now() {
-    return new Date().getTime();
-}
-const NINETY_DAYS = 90 * 24 * 60 * 60 * 1000;
-function stale(id, updated, length = NINETY_DAYS) {
-    if (id === null || updated === null) {
-        return true;
-    }
-    const accessedAt = updated;
-    if (now() - accessedAt >= length) {
-        return true;
-    }
-    return false;
-}
-const action = {
-    title: 'Msclick Id',
-    description: 'Generates a MSCLK ID and attaches it to every Amplitude browser based event.',
-    platform: 'web',
-    fields: {
-        sessionLength: {
-            label: 'Session Length',
-            type: 'number',
-            description: 'The length of the session in days.',
-            default: 90
-        }
-    },
-    lifecycleHook: 'enrichment',
-    perform: (_, { context, payload, analytics }) => {
-        const storageFallback = {
-            get: (key) => {
-                const data = window.localStorage.getItem(key);
-                return data === null ? null : data;
-            },
-            set: (key, value) => {
-                return window.localStorage.setItem(key, value.toString());
-            }
-        };
-        const storage = analytics.storage
-            ?
-                analytics.storage
-            : storageFallback;
-        const raw = storage.get('analytics_msclk_id');
-        const updatedRaw = storage.get('analytics_msclk_id.last_access');
-        const updated = updatedRaw !== null ? Number(updatedRaw) : null;
-        let id = raw;
-        const sessionLength = payload.sessionLength ? payload.sessionLength * 24 * 60 * 60 * 1000 : NINETY_DAYS;
-        if (stale(raw, updated, sessionLength)) {
-            id = newMsclk();
-            storage.set('analytics_msclk_id', id);
-        }
-        else {
-            storage.set('analytics_msclk_id', id);
-        }
-        storage.set('analytics_msclk_id.last_access', now().toString());
-        if (context.event.integrations?.All !== false || context.event.integrations['MS Bing CAPI']) {
-            context.updateEvent('integrations.MS Bing CAPI', {});
-            context.updateEvent('integrations.MS Bing CAPI.msclk_id', id);
-        }
-        return;
-    }
-};
-exports.default = action;
-//# sourceMappingURL=index.js.map

package/dist/cjs/msclickId/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/msclickId/index.ts"],"names":[],"mappings":";;AAKA,uCAA2C;AAE3C,SAAS,QAAQ;IACf,OAAO,IAAA,SAAM,GAAE,CAAA;AACjB,CAAC;AAED,SAAS,GAAG;IACV,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;AAC7B,CAAC;AAED,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;AAE5C,SAAS,KAAK,CAAC,EAAiB,EAAE,OAAsB,EAAE,SAAiB,WAAW;IACpF,IAAI,EAAE,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,UAAU,GAAG,OAAO,CAAA;IAE1B,IAAI,GAAG,EAAE,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAGD,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,8EAA8E;IAC3F,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,aAAa,EAAE;YACb,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;YACjD,OAAO,EAAE,EAAE;SACZ;KACF;IACD,aAAa,EAAE,YAAY;IAC3B,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE;QAC9C,MAAM,eAAe,GAAG;YACtB,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE;gBACnB,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBAC7C,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;YACpC,CAAC;YACD,GAAG,EAAE,CAAC,GAAW,EAAE,KAAsB,EAAE,EAAE;gBAC3C,OAAO,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC3D,CAAC;SACF,CAAA;QAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO;YAC/B,CAAC;gBACE,SAAS,CAAC,OAAoD;YACjE,CAAC,CAAC,eAAe,CAAA;QAEnB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;QAC7C,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;QAChE,MAAM,OAAO,GAAG,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAE/D,IAAI,EAAE,GAAkB,GAAG,CAAA;QAC3B,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,WAAW,CAAA;QACvG,IAAI,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC;YACvC,EAAE,GAAG,QAAQ,EAAE,CAAA;YACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAA;QACvC,CAAC;aAAM,CAAC;YAGN,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAG,CAAC,CAAA;QACxC,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;QAE/D,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,KAAK,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5F,OAAO,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAA;YACpD,OAAO,CAAC,WAAW,CAAC,oCAAoC,EAAE,EAAE,CAAC,CAAA;QAC/D,CAAC;QAED,OAAM;IACR,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/esm/msclickId/generated-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/msclickId/generated-types.ts"],"names":[],"mappings":""}

package/dist/esm/msclickId/index.js

@@ -1,67 +0,0 @@
-import { v4 as uuidv4 } from '@lukeed/uuid';
-function newMsclk() {
-    return uuidv4();
-}
-function now() {
-    return new Date().getTime();
-}
-const NINETY_DAYS = 90 * 24 * 60 * 60 * 1000;
-function stale(id, updated, length = NINETY_DAYS) {
-    if (id === null || updated === null) {
-        return true;
-    }
-    const accessedAt = updated;
-    if (now() - accessedAt >= length) {
-        return true;
-    }
-    return false;
-}
-const action = {
-    title: 'Msclick Id',
-    description: 'Generates a MSCLK ID and attaches it to every Amplitude browser based event.',
-    platform: 'web',
-    fields: {
-        sessionLength: {
-            label: 'Session Length',
-            type: 'number',
-            description: 'The length of the session in days.',
-            default: 90
-        }
-    },
-    lifecycleHook: 'enrichment',
-    perform: (_, { context, payload, analytics }) => {
-        const storageFallback = {
-            get: (key) => {
-                const data = window.localStorage.getItem(key);
-                return data === null ? null : data;
-            },
-            set: (key, value) => {
-                return window.localStorage.setItem(key, value.toString());
-            }
-        };
-        const storage = analytics.storage
-            ?
-                analytics.storage
-            : storageFallback;
-        const raw = storage.get('analytics_msclk_id');
-        const updatedRaw = storage.get('analytics_msclk_id.last_access');
-        const updated = updatedRaw !== null ? Number(updatedRaw) : null;
-        let id = raw;
-        const sessionLength = payload.sessionLength ? payload.sessionLength * 24 * 60 * 60 * 1000 : NINETY_DAYS;
-        if (stale(raw, updated, sessionLength)) {
-            id = newMsclk();
-            storage.set('analytics_msclk_id', id);
-        }
-        else {
-            storage.set('analytics_msclk_id', id);
-        }
-        storage.set('analytics_msclk_id.last_access', now().toString());
-        if (context.event.integrations?.All !== false || context.event.integrations['MS Bing CAPI']) {
-            context.updateEvent('integrations.MS Bing CAPI', {});
-            context.updateEvent('integrations.MS Bing CAPI.msclk_id', id);
-        }
-        return;
-    }
-};
-export default action;
-//# sourceMappingURL=index.js.map

package/dist/esm/msclickId/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/msclickId/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,cAAc,CAAA;AAE3C,SAAS,QAAQ;IACf,OAAO,MAAM,EAAE,CAAA;AACjB,CAAC;AAED,SAAS,GAAG;IACV,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;AAC7B,CAAC;AAED,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;AAE5C,SAAS,KAAK,CAAC,EAAiB,EAAE,OAAsB,EAAE,SAAiB,WAAW;IACpF,IAAI,EAAE,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,UAAU,GAAG,OAAO,CAAA;IAE1B,IAAI,GAAG,EAAE,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAGD,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,8EAA8E;IAC3F,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,aAAa,EAAE;YACb,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;YACjD,OAAO,EAAE,EAAE;SACZ;KACF;IACD,aAAa,EAAE,YAAY;IAC3B,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE;QAC9C,MAAM,eAAe,GAAG;YACtB,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE;gBACnB,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBAC7C,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;YACpC,CAAC;YACD,GAAG,EAAE,CAAC,GAAW,EAAE,KAAsB,EAAE,EAAE;gBAC3C,OAAO,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC3D,CAAC;SACF,CAAA;QAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO;YAC/B,CAAC;gBACE,SAAS,CAAC,OAAoD;YACjE,CAAC,CAAC,eAAe,CAAA;QAEnB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;QAC7C,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;QAChE,MAAM,OAAO,GAAG,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAE/D,IAAI,EAAE,GAAkB,GAAG,CAAA;QAC3B,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,WAAW,CAAA;QACvG,IAAI,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC;YACvC,EAAE,GAAG,QAAQ,EAAE,CAAA;YACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAA;QACvC,CAAC;aAAM,CAAC;YAGN,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAG,CAAC,CAAA;QACxC,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;QAE/D,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,KAAK,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5F,OAAO,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAA;YACpD,OAAO,CAAC,WAAW,CAAC,oCAAoC,EAAE,EAAE,CAAC,CAAA;QAC/D,CAAC;QAED,OAAM;IACR,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}

package/src/msclickId/generated-types.ts

@@ -1,8 +0,0 @@
-// Generated file. DO NOT MODIFY IT BY HAND.
-
-export interface Payload {
-  /**
-   * The length of the session in days.
-   */
-  sessionLength?: number
-}

package/src/msclickId/index.ts

@@ -1,88 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-import { UniversalStorage } from '@segment/analytics-next'
-import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
-import type { Settings } from '../generated-types'
-import type { Payload } from './generated-types'
-import { v4 as uuidv4 } from '@lukeed/uuid'
-
-function newMsclk(): string {
-  return uuidv4()
-}
-
-function now(): number {
-  return new Date().getTime()
-}
-
-const NINETY_DAYS = 90 * 24 * 60 * 60 * 1000
-
-function stale(id: string | null, updated: number | null, length: number = NINETY_DAYS): id is null {
-  if (id === null || updated === null) {
-    return true
-  }
-
-  const accessedAt = updated
-
-  if (now() - accessedAt >= length) {
-    return true
-  }
-
-  return false
-}
-
-// Change from unknown to the partner SDK types
-const action: BrowserActionDefinition<Settings, unknown, Payload> = {
-  title: 'Msclick Id',
-  description: 'Generates a MSCLK ID and attaches it to every Amplitude browser based event.',
-  platform: 'web',
-  fields: {
-    sessionLength: {
-      label: 'Session Length',
-      type: 'number',
-      description: 'The length of the session in days.',
-      default: 90
-    }
-  },
-  lifecycleHook: 'enrichment',
-  perform: (_, { context, payload, analytics }) => {
-    const storageFallback = {
-      get: (key: string) => {
-        const data = window.localStorage.getItem(key)
-        return data === null ? null : data
-      },
-      set: (key: string, value: string | number) => {
-        return window.localStorage.setItem(key, value.toString())
-      }
-    }
-
-    const storage = analytics.storage
-      ? // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-        (analytics.storage as UniversalStorage<Record<string, string>>)
-      : storageFallback
-
-    const raw = storage.get('analytics_msclk_id')
-    const updatedRaw = storage.get('analytics_msclk_id.last_access')
-    const updated = updatedRaw !== null ? Number(updatedRaw) : null
-
-    let id: string | null = raw
-    const sessionLength = payload.sessionLength ? payload.sessionLength * 24 * 60 * 60 * 1000 : NINETY_DAYS
-    if (stale(raw, updated, sessionLength)) {
-      id = newMsclk()
-      storage.set('analytics_msclk_id', id)
-    } else {
-      // we are storing the session id regardless, so it gets synced between different storage mediums
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- id can't be null because of stale check
-      storage.set('analytics_msclk_id', id!)
-    }
-
-    storage.set('analytics_msclk_id.last_access', now().toString())
-
-    if (context.event.integrations?.All !== false || context.event.integrations['MS Bing CAPI']) {
-      context.updateEvent('integrations.MS Bing CAPI', {})
-      context.updateEvent('integrations.MS Bing CAPI.msclk_id', id)
-    }
-
-    return
-  }
-}
-
-export default action