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

package/README.md

@@ -1,6 +1,6 @@
-# @segment/analytics-browser-actions-ms-bing-capi
+# @segment/analytics-browser-actions-ms-bing-capi-plugins
 
-The Ms Bing Capi Plugin browser action destination for use with @segment/analytics-next.
+The Microsoft Bing CAPI Browser Plugins browser action destination for use with @segment/analytics-next.
 
 ## License
 

package/dist/cjs/index.d.ts

@@ -1,5 +1,5 @@
 import type { Settings } from './generated-types';
 import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types';
-export declare const destination: BrowserDestinationDefinition<Settings, unknown>;
+export declare const destination: BrowserDestinationDefinition<Settings, {}>;
 declare const _default: import("@segment/browser-destination-runtime/types").PluginFactory;
 export default _default;

package/dist/cjs/index.js

@@ -3,15 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.destination = void 0;
 const tslib_1 = require("tslib");
 const shim_1 = require("@segment/browser-destination-runtime/shim");
-const msclickId_1 = tslib_1.__importDefault(require("./msclickId"));
+const utils_1 = require("./utils");
+const msclkidPlugin_1 = tslib_1.__importDefault(require("./msclkidPlugin"));
 exports.destination = {
-    name: 'Ms Bing Capi Plugin',
+    name: 'Microsoft Bing CAPI Browser Plugins',
     mode: 'device',
-    initialize: async () => {
+    initialize: async ({ analytics }) => {
+        const storage = analytics.storage ?? utils_1.storageFallback;
+        const urlParams = new URLSearchParams(window.location.search);
+        const msclkid = urlParams.get(utils_1.clickIdQuerystringName) || null;
+        if (msclkid) {
+            storage.set(utils_1.storageClickIdKey, msclkid);
+        }
         return {};
     },
+    settings: {},
     actions: {
-        msclickId: msclickId_1.default
+        msclkidPlugin: msclkidPlugin_1.default
     }
 };
 exports.default = (0, shim_1.browserDestination)(exports.destination);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAEA,oEAA8E;AAE9E,oEAAmC;AAGtB,QAAA,WAAW,GAAoD;IAC1E,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,KAAK,IAAI,EAAE;QAErB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,OAAO,EAAE;QACP,SAAS,EAAT,mBAAS;KACV;CACF,CAAA;AAED,kBAAe,IAAA,yBAAkB,EAAC,mBAAW,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAEA,oEAA8E;AAC9E,mCAAoF;AAEpF,4EAA2C;AAG9B,QAAA,WAAW,GAA+C;IACrE,IAAI,EAAE,qCAAqC;IAC3C,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;QAClC,MAAM,OAAO,GAAI,SAAS,CAAC,OAAoD,IAAI,uBAAe,CAAA;QAClG,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC7D,MAAM,OAAO,GAAkB,SAAS,CAAC,GAAG,CAAC,8BAAsB,CAAC,IAAI,IAAI,CAAA;QAE5E,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,yBAAiB,EAAE,OAAO,CAAC,CAAA;QACzC,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IACD,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE;QACP,aAAa,EAAb,uBAAa;KACd;CACF,CAAA;AAED,kBAAe,IAAA,yBAAkB,EAAC,mBAAW,CAAC,CAAA"}

package/dist/cjs/{msclickId → msclkidPlugin}/generated-types.d.ts

@@ -1,3 +1,2 @@
 export interface Payload {
-    sessionLength?: number;
 }

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

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

package/dist/{esm/msclickId → cjs/msclkidPlugin}/index.d.ts

@@ -1,5 +1,5 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types';
 import type { Settings } from '../generated-types';
 import type { Payload } from './generated-types';
-declare const action: BrowserActionDefinition<Settings, unknown, Payload>;
+declare const action: BrowserActionDefinition<Settings, {}, Payload>;
 export default action;

package/dist/cjs/msclkidPlugin/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const action = {
+    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 ?? utils_1.storageFallback;
+        const msclkid = storage.get(utils_1.storageClickIdKey);
+        const integrationsData = {};
+        if (msclkid) {
+            integrationsData[utils_1.clickIdIntegrationFieldName] = msclkid;
+            if (context.event.integrations?.All !== false || context.event.integrations['Snap Conversions Api']) {
+                context.updateEvent(`integrations.Microsoft Bing CAPI`, integrationsData);
+            }
+        }
+        return;
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/msclkidPlugin/index.ts"],"names":[],"mappings":";;AAGA,oCAA0F;AAG1F,MAAM,MAAM,GAAmD;IAC7D,KAAK,EAAE,uCAAuC;IAC9C,WAAW,EAAE,iFAAiF;IAC9F,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE,KAAK;IACb,mBAAmB,EAAE,0FAA0F;IAC/G,MAAM,EAAE,EAAE;IACV,aAAa,EAAE,YAAY;IAC3B,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE;QACrC,MAAM,OAAO,GAAI,SAAS,CAAC,OAAoD,IAAI,uBAAe,CAAA;QAClG,MAAM,OAAO,GAAkB,OAAO,CAAC,GAAG,CAAC,yBAAiB,CAAC,CAAA;QAC7D,MAAM,gBAAgB,GAA2B,EAAE,CAAA;QACnD,IAAI,OAAO,EAAE,CAAC;YACZ,gBAAgB,CAAC,mCAA2B,CAAC,GAAG,OAAO,CAAA;YACvD,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,KAAK,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,sBAAsB,CAAC,EAAE,CAAC;gBACpG,OAAO,CAAC,WAAW,CAAC,kCAAkC,EAAE,gBAAgB,CAAC,CAAA;YAC3E,CAAC;QACH,CAAC;QACD,OAAM;IACR,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/utils.d.ts

@@ -0,0 +1,8 @@
+export declare const storageClickIdKey = "analytics_ms_capi_click_id";
+export declare const clickIdQuerystringName = "msclkid";
+export declare const clickIdIntegrationFieldName = "msclkid";
+export declare const getCookieValue: (cookieName: string) => string | null;
+export declare const storageFallback: {
+    get: (key: string) => string | null;
+    set: (key: string, value: string) => void;
+};

package/dist/cjs/utils.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storageFallback = exports.getCookieValue = exports.clickIdIntegrationFieldName = exports.clickIdQuerystringName = exports.storageClickIdKey = void 0;
+exports.storageClickIdKey = 'analytics_ms_capi_click_id';
+exports.clickIdQuerystringName = 'msclkid';
+exports.clickIdIntegrationFieldName = 'msclkid';
+const getCookieValue = (cookieName) => {
+    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;
+};
+exports.getCookieValue = getCookieValue;
+exports.storageFallback = {
+    get: (key) => {
+        const data = window.localStorage.getItem(key);
+        return data;
+    },
+    set: (key, value) => {
+        return window.localStorage.setItem(key, value);
+    }
+};
+//# sourceMappingURL=utils.js.map

package/dist/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;AACa,QAAA,iBAAiB,GAAG,4BAA4B,CAAA;AAGhD,QAAA,sBAAsB,GAAG,SAAS,CAAA;AAGlC,QAAA,2BAA2B,GAAG,SAAS,CAAA;AAE7C,MAAM,cAAc,GAAG,CAAC,UAAkB,EAAiB,EAAE;IAClE,MAAM,IAAI,GAAG,UAAU,GAAG,GAAG,CAAA;IAC7B,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAE7C,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAZY,QAAA,cAAc,kBAY1B;AAEY,QAAA,eAAe,GAAG;IAC7B,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE;QACnB,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAC7C,OAAO,IAAI,CAAA;IACb,CAAC;IACD,GAAG,EAAE,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE;QAClC,OAAO,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAChD,CAAC;CACF,CAAA"}

package/dist/esm/index.d.ts

@@ -1,5 +1,5 @@
 import type { Settings } from './generated-types';
 import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types';
-export declare const destination: BrowserDestinationDefinition<Settings, unknown>;
+export declare const destination: BrowserDestinationDefinition<Settings, {}>;
 declare const _default: import("@segment/browser-destination-runtime/types").PluginFactory;
 export default _default;

package/dist/esm/index.js

@@ -1,13 +1,21 @@
 import { browserDestination } from '@segment/browser-destination-runtime/shim';
-import msclickId from './msclickId';
+import { storageClickIdKey, clickIdQuerystringName, storageFallback } from './utils';
+import msclkidPlugin from './msclkidPlugin';
 export const destination = {
-    name: 'Ms Bing Capi Plugin',
+    name: 'Microsoft Bing CAPI Browser Plugins',
     mode: 'device',
-    initialize: async () => {
+    initialize: async ({ analytics }) => {
+        const storage = analytics.storage ?? storageFallback;
+        const urlParams = new URLSearchParams(window.location.search);
+        const msclkid = urlParams.get(clickIdQuerystringName) || null;
+        if (msclkid) {
+            storage.set(storageClickIdKey, msclkid);
+        }
         return {};
     },
+    settings: {},
     actions: {
-        msclickId
+        msclkidPlugin
     }
 };
 export default browserDestination(destination);

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAA;AAE9E,OAAO,SAAS,MAAM,aAAa,CAAA;AAGnC,MAAM,CAAC,MAAM,WAAW,GAAoD;IAC1E,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,KAAK,IAAI,EAAE;QAErB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,OAAO,EAAE;QACP,SAAS;KACV;CACF,CAAA;AAED,eAAe,kBAAkB,CAAC,WAAW,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAA;AAC9E,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAEpF,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAG3C,MAAM,CAAC,MAAM,WAAW,GAA+C;IACrE,IAAI,EAAE,qCAAqC;IAC3C,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;QAClC,MAAM,OAAO,GAAI,SAAS,CAAC,OAAoD,IAAI,eAAe,CAAA;QAClG,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC7D,MAAM,OAAO,GAAkB,SAAS,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,IAAI,CAAA;QAE5E,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;QACzC,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IACD,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE;QACP,aAAa;KACd;CACF,CAAA;AAED,eAAe,kBAAkB,CAAC,WAAW,CAAC,CAAA"}

package/dist/esm/{msclickId → msclkidPlugin}/generated-types.d.ts

@@ -1,3 +1,2 @@
 export interface Payload {
-    sessionLength?: number;
 }

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

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

package/dist/{cjs/msclickId → esm/msclkidPlugin}/index.d.ts

@@ -1,5 +1,5 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types';
 import type { Settings } from '../generated-types';
 import type { Payload } from './generated-types';
-declare const action: BrowserActionDefinition<Settings, unknown, Payload>;
+declare const action: BrowserActionDefinition<Settings, {}, Payload>;
 export default action;

package/dist/esm/msclkidPlugin/index.js

@@ -0,0 +1,24 @@
+import { storageClickIdKey, clickIdIntegrationFieldName, storageFallback } from '../utils';
+const action = {
+    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 ?? storageFallback;
+        const msclkid = storage.get(storageClickIdKey);
+        const integrationsData = {};
+        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;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/msclkidPlugin/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,2BAA2B,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAG1F,MAAM,MAAM,GAAmD;IAC7D,KAAK,EAAE,uCAAuC;IAC9C,WAAW,EAAE,iFAAiF;IAC9F,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE,KAAK;IACb,mBAAmB,EAAE,0FAA0F;IAC/G,MAAM,EAAE,EAAE;IACV,aAAa,EAAE,YAAY;IAC3B,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE;QACrC,MAAM,OAAO,GAAI,SAAS,CAAC,OAAoD,IAAI,eAAe,CAAA;QAClG,MAAM,OAAO,GAAkB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;QAC7D,MAAM,gBAAgB,GAA2B,EAAE,CAAA;QACnD,IAAI,OAAO,EAAE,CAAC;YACZ,gBAAgB,CAAC,2BAA2B,CAAC,GAAG,OAAO,CAAA;YACvD,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,KAAK,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,sBAAsB,CAAC,EAAE,CAAC;gBACpG,OAAO,CAAC,WAAW,CAAC,kCAAkC,EAAE,gBAAgB,CAAC,CAAA;YAC3E,CAAC;QACH,CAAC;QACD,OAAM;IACR,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/esm/utils.d.ts

@@ -0,0 +1,8 @@
+export declare const storageClickIdKey = "analytics_ms_capi_click_id";
+export declare const clickIdQuerystringName = "msclkid";
+export declare const clickIdIntegrationFieldName = "msclkid";
+export declare const getCookieValue: (cookieName: string) => string | null;
+export declare const storageFallback: {
+    get: (key: string) => string | null;
+    set: (key: string, value: string) => void;
+};

package/dist/esm/utils.js

@@ -0,0 +1,24 @@
+export const storageClickIdKey = 'analytics_ms_capi_click_id';
+export const clickIdQuerystringName = 'msclkid';
+export const clickIdIntegrationFieldName = 'msclkid';
+export const getCookieValue = (cookieName) => {
+    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) => {
+        const data = window.localStorage.getItem(key);
+        return data;
+    },
+    set: (key, value) => {
+        return window.localStorage.setItem(key, value);
+    }
+};
+//# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,iBAAiB,GAAG,4BAA4B,CAAA;AAG7D,MAAM,CAAC,MAAM,sBAAsB,GAAG,SAAS,CAAA;AAG/C,MAAM,CAAC,MAAM,2BAA2B,GAAG,SAAS,CAAA;AAEpD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,UAAkB,EAAiB,EAAE;IAClE,MAAM,IAAI,GAAG,UAAU,GAAG,GAAG,CAAA;IAC7B,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzD,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAE7C,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE;QACnB,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAC7C,OAAO,IAAI,CAAA;IACb,CAAC;IACD,GAAG,EAAE,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE;QAClC,OAAO,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAChD,CAAC;CACF,CAAA"}