@amplitude/analytics-browser 0.5.1 → 0.7.0

package/README.md

@@ -32,7 +32,7 @@ Alternatively, the package is also distributed through a CDN. Copy and paste the
 <!-- README_SNIPPET_BLOCK -->
 ```html
 <script type="text/javascript">
-!function(){"use strict";!function(e,t){var r=e.amplitude||{_q:[]};if(r.invoked)e.console&&console.error&&console.error("Amplitude snippet has been loaded.");else{r.invoked=!0;var n=t.createElement("script");n.type="text/javascript",n.integrity="sha384-LXfeh+DR5OUpZh/DgXlUyDk2rPfEHuspdPhunqmzSzvWrAfTubKZI5uIHlzd9Uzz",n.crossOrigin="anonymous",n.async=!0,n.src="https://cdn.amplitude.com/libs/analytics-browser-0.5.1-min.js.gz",n.onload=function(){e.amplitude.runQueuedFunctions||console.log("[Amplitude] Error: could not load SDK")};var s=t.getElementsByTagName("script")[0];function v(e,t){e.prototype[t]=function(){return this._q.push({name:t,args:Array.prototype.slice.call(arguments,0)}),this}}s.parentNode.insertBefore(n,s);for(var o=function(){return this._q=[],this},i=["add","append","clearAll","prepend","set","setOnce","unset","preInsert","postInsert","remove","getUserProperties"],a=0;a<i.length;a++)v(o,i[a]);r.Identify=o;for(var u=function(){return this._q=[],this},c=["getEventProperties","setProductId","setQuantity","setPrice","setRevenue","setRevenueType","setEventProperties"],p=0;p<c.length;p++)v(u,c[p]);r.Revenue=u;var d=["getDeviceId","setDeviceId","regenerateDeviceId","getSessionId","setSessionId","getUserId","setUserId","setOptOut","setTransport"],l=["init","add","remove","track","logEvent","identify","groupIdentify","setGroup","revenue"];function f(e){function t(t,r){e[t]=function(){var n={promise:new Promise((r=>{e._q.push({name:t,args:Array.prototype.slice.call(arguments,0),resolve:r})}))};if(r)return n}}for(var r=0;r<d.length;r++)t(d[r],!1);for(var n=0;n<l.length;n++)t(l[n],!0)}f(r),e.amplitude=r}}(window,document)}();
+!function(){"use strict";!function(e,t){var r=e.amplitude||{_q:[]};if(r.invoked)e.console&&console.error&&console.error("Amplitude snippet has been loaded.");else{r.invoked=!0;var n=t.createElement("script");n.type="text/javascript",n.integrity="sha384-4cI8KmvK50Np4vrOodfx8p0b15oVvHpnhj9jrlCLpvzxkXaIoJu7qoeud6+iIDSv",n.crossOrigin="anonymous",n.async=!0,n.src="https://cdn.amplitude.com/libs/analytics-browser-0.7.0-min.js.gz",n.onload=function(){e.amplitude.runQueuedFunctions||console.log("[Amplitude] Error: could not load SDK")};var o=t.getElementsByTagName("script")[0];function v(e,t){e.prototype[t]=function(){return this._q.push({name:t,args:Array.prototype.slice.call(arguments,0)}),this}}o.parentNode.insertBefore(n,o);for(var s=function(){return this._q=[],this},i=["add","append","clearAll","prepend","set","setOnce","unset","preInsert","postInsert","remove","getUserProperties"],a=0;a<i.length;a++)v(s,i[a]);r.Identify=s;for(var u=function(){return this._q=[],this},c=["getEventProperties","setProductId","setQuantity","setPrice","setRevenue","setRevenueType","setEventProperties"],p=0;p<c.length;p++)v(u,c[p]);r.Revenue=u;var d=["getDeviceId","setDeviceId","regenerateDeviceId","getSessionId","setSessionId","getUserId","setUserId","setOptOut","setTransport"],l=["init","add","remove","track","logEvent","identify","groupIdentify","setGroup","revenue"];function f(e){function t(t,r){e[t]=function(){var n={promise:new Promise((r=>{e._q.push({name:t,args:Array.prototype.slice.call(arguments,0),resolve:r})}))};if(r)return n}}for(var r=0;r<d.length;r++)t(d[r],!1);for(var n=0;n<l.length;n++)t(l[n],!0)}f(r),e.amplitude=r}}(window,document)}();
 
 amplitude.init("YOUR_API_KEY_HERE");
 </script>

package/lib/cjs/attribution/campaign-parser.d.ts

@@ -0,0 +1,10 @@
+import { UTMCookie } from '../storage/utm-cookie';
+import { Campaign, CampaignParser as ICampaignParser, ClickIdParameters, ReferrerParameters, UTMParameters } from '@amplitude/analytics-types';
+export declare class CampaignParser implements ICampaignParser {
+    utmCookieStorage: UTMCookie;
+    parse(): Promise<Campaign>;
+    getUtmParam(): Promise<UTMParameters>;
+    getReferrer(): ReferrerParameters;
+    getClickIds(): ClickIdParameters;
+}
+//# sourceMappingURL=campaign-parser.d.ts.map

package/lib/cjs/attribution/campaign-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-parser.d.ts","sourceRoot":"","sources":["../../../src/attribution/campaign-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAiBlD,OAAO,EACL,QAAQ,EACR,cAAc,IAAI,eAAe,EACjC,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACd,MAAM,4BAA4B,CAAC;AAEpC,qBAAa,cAAe,YAAW,eAAe;IACpD,gBAAgB,YAAmB;IAE7B,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC;IAS1B,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC;IAmB3C,WAAW,IAAI,kBAAkB;IAcjC,WAAW,IAAI,iBAAiB;CAOjC"}

package/lib/cjs/attribution/campaign-parser.js

@@ -0,0 +1,83 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignParser = void 0;
+var tslib_1 = require("tslib");
+var utm_cookie_1 = require("../storage/utm-cookie");
+var query_params_1 = require("../utils/query-params");
+var constants_1 = require("./constants");
+var CampaignParser = /** @class */ (function () {
+    function CampaignParser() {
+        this.utmCookieStorage = new utm_cookie_1.UTMCookie();
+    }
+    CampaignParser.prototype.parse = function () {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            var _a;
+            return (0, tslib_1.__generator)(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = [(0, tslib_1.__assign)({}, constants_1.BASE_CAMPAIGN)];
+                        return [4 /*yield*/, this.getUtmParam()];
+                    case 1: return [2 /*return*/, tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _a.concat([(_b.sent())])), this.getReferrer()]), this.getClickIds()])];
+                }
+            });
+        });
+    };
+    CampaignParser.prototype.getUtmParam = function () {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            var params, cookies, _a, utmSource, utmMedium, utmCampaign, utmTerm, utmContent;
+            return (0, tslib_1.__generator)(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        params = (0, query_params_1.getQueryParams)();
+                        return [4 /*yield*/, this.utmCookieStorage.isEnabled()];
+                    case 1:
+                        _a = (_b.sent());
+                        if (!_a) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.utmCookieStorage.get('__utmz')];
+                    case 2:
+                        _a = (_b.sent());
+                        _b.label = 3;
+                    case 3:
+                        cookies = (_a) || {};
+                        utmSource = params[constants_1.UTM_SOURCE] || cookies[constants_1.UTMZ_SOURCE];
+                        utmMedium = params[constants_1.UTM_MEDIUM] || cookies[constants_1.UTMZ_MEDIUM];
+                        utmCampaign = params[constants_1.UTM_CAMPAIGN] || cookies[constants_1.UTMZ_CAMPAIGN];
+                        utmTerm = params[constants_1.UTM_TERM] || cookies[constants_1.UTMZ_TERM];
+                        utmContent = params[constants_1.UTM_CONTENT] || cookies[constants_1.UTMZ_CONTENT];
+                        return [2 /*return*/, {
+                                utm_source: utmSource,
+                                utm_medium: utmMedium,
+                                utm_campaign: utmCampaign,
+                                utm_term: utmTerm,
+                                utm_content: utmContent,
+                            }];
+                }
+            });
+        });
+    };
+    CampaignParser.prototype.getReferrer = function () {
+        var _a, _b;
+        var data = {
+            referrer: undefined,
+            referring_domain: undefined,
+        };
+        try {
+            data.referrer = document.referrer || undefined;
+            data.referring_domain = (_b = (_a = data.referrer) === null || _a === void 0 ? void 0 : _a.split('/')[2]) !== null && _b !== void 0 ? _b : undefined;
+        }
+        catch (_c) {
+            // nothing to track
+        }
+        return data;
+    };
+    CampaignParser.prototype.getClickIds = function () {
+        var _a;
+        var params = (0, query_params_1.getQueryParams)();
+        return _a = {},
+            _a[constants_1.GCLID] = params[constants_1.GCLID],
+            _a[constants_1.FBCLID] = params[constants_1.FBCLID],
+            _a;
+    };
+    return CampaignParser;
+}());
+exports.CampaignParser = CampaignParser;
+//# sourceMappingURL=campaign-parser.js.map

package/lib/cjs/attribution/campaign-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-parser.js","sourceRoot":"","sources":["../../../src/attribution/campaign-parser.ts"],"names":[],"mappings":";;;AAAA,oDAAkD;AAClD,sDAAuD;AACvD,yCAcqB;AASrB;IAAA;QACE,qBAAgB,GAAG,IAAI,sBAAS,EAAE,CAAC;IAmDrC,CAAC;IAjDO,8BAAK,GAAX;;;;;;wDAEO,yBAAa;wBACZ,qBAAM,IAAI,CAAC,WAAW,EAAE,EAAA;4BAF9B,sBAAO,0GAEF,CAAC,SAAwB,CAAC,KAC1B,IAAI,CAAC,WAAW,EAAE,IAClB,IAAI,CAAC,WAAW,EAAE,EACV,EAAC;;;;KACf;IAEK,oCAAW,GAAjB;;;;;;wBACQ,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;wBACd,qBAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,EAAA;;wBAAxC,KAAA,CAAC,SAAuC,CAAC,CAAA;iCAAzC,wBAAyC;wBAAK,qBAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAA;;wBAA1C,KAAA,CAAC,SAAyC,CAAC,CAAA;;;wBAAnG,OAAO,GAAG,IAA0F,IAAI,EAAE;wBAE1G,SAAS,GAAG,MAAM,CAAC,sBAAU,CAAC,IAAI,OAAO,CAAC,uBAAW,CAAC,CAAC;wBACvD,SAAS,GAAG,MAAM,CAAC,sBAAU,CAAC,IAAI,OAAO,CAAC,uBAAW,CAAC,CAAC;wBACvD,WAAW,GAAG,MAAM,CAAC,wBAAY,CAAC,IAAI,OAAO,CAAC,yBAAa,CAAC,CAAC;wBAC7D,OAAO,GAAG,MAAM,CAAC,oBAAQ,CAAC,IAAI,OAAO,CAAC,qBAAS,CAAC,CAAC;wBACjD,UAAU,GAAG,MAAM,CAAC,uBAAW,CAAC,IAAI,OAAO,CAAC,wBAAY,CAAC,CAAC;wBAEhE,sBAAO;gCACL,UAAU,EAAE,SAAS;gCACrB,UAAU,EAAE,SAAS;gCACrB,YAAY,EAAE,WAAW;gCACzB,QAAQ,EAAE,OAAO;gCACjB,WAAW,EAAE,UAAU;6BACxB,EAAC;;;;KACH;IAED,oCAAW,GAAX;;QACE,IAAM,IAAI,GAAuB;YAC/B,QAAQ,EAAE,SAAS;YACnB,gBAAgB,EAAE,SAAS;SAC5B,CAAC;QACF,IAAI;YACF,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,IAAI,SAAS,CAAC;YAC/C,IAAI,CAAC,gBAAgB,GAAG,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,mCAAI,SAAS,CAAC;SACnE;QAAC,WAAM;YACN,mBAAmB;SACpB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oCAAW,GAAX;;QACE,IAAM,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;QAChC;YACE,GAAC,iBAAK,IAAG,MAAM,CAAC,iBAAK,CAAC;YACtB,GAAC,kBAAM,IAAG,MAAM,CAAC,kBAAM,CAAC;eACxB;IACJ,CAAC;IACH,qBAAC;AAAD,CAAC,AApDD,IAoDC;AApDY,wCAAc","sourcesContent":["import { UTMCookie } from '../storage/utm-cookie';\nimport { getQueryParams } from '../utils/query-params';\nimport {\n  UTM_CAMPAIGN,\n  UTM_CONTENT,\n  UTM_MEDIUM,\n  UTM_SOURCE,\n  UTM_TERM,\n  UTMZ_SOURCE,\n  UTMZ_MEDIUM,\n  UTMZ_CAMPAIGN,\n  UTMZ_TERM,\n  UTMZ_CONTENT,\n  GCLID,\n  FBCLID,\n  BASE_CAMPAIGN,\n} from './constants';\nimport {\n  Campaign,\n  CampaignParser as ICampaignParser,\n  ClickIdParameters,\n  ReferrerParameters,\n  UTMParameters,\n} from '@amplitude/analytics-types';\n\nexport class CampaignParser implements ICampaignParser {\n  utmCookieStorage = new UTMCookie();\n\n  async parse(): Promise<Campaign> {\n    return {\n      ...BASE_CAMPAIGN,\n      ...(await this.getUtmParam()),\n      ...this.getReferrer(),\n      ...this.getClickIds(),\n    } as Campaign;\n  }\n\n  async getUtmParam(): Promise<UTMParameters> {\n    const params = getQueryParams();\n    const cookies = ((await this.utmCookieStorage.isEnabled()) && (await this.utmCookieStorage.get('__utmz'))) || {};\n\n    const utmSource = params[UTM_SOURCE] || cookies[UTMZ_SOURCE];\n    const utmMedium = params[UTM_MEDIUM] || cookies[UTMZ_MEDIUM];\n    const utmCampaign = params[UTM_CAMPAIGN] || cookies[UTMZ_CAMPAIGN];\n    const utmTerm = params[UTM_TERM] || cookies[UTMZ_TERM];\n    const utmContent = params[UTM_CONTENT] || cookies[UTMZ_CONTENT];\n\n    return {\n      utm_source: utmSource,\n      utm_medium: utmMedium,\n      utm_campaign: utmCampaign,\n      utm_term: utmTerm,\n      utm_content: utmContent,\n    };\n  }\n\n  getReferrer(): ReferrerParameters {\n    const data: ReferrerParameters = {\n      referrer: undefined,\n      referring_domain: undefined,\n    };\n    try {\n      data.referrer = document.referrer || undefined;\n      data.referring_domain = data.referrer?.split('/')[2] ?? undefined;\n    } catch {\n      // nothing to track\n    }\n    return data;\n  }\n\n  getClickIds(): ClickIdParameters {\n    const params = getQueryParams();\n    return {\n      [GCLID]: params[GCLID],\n      [FBCLID]: params[FBCLID],\n    };\n  }\n}\n"]}

package/lib/cjs/attribution/campaign-tracker.d.ts

@@ -0,0 +1,72 @@
+import { Storage, Campaign, CampaignParser as ICampaignParser, CampaignTracker as ICampaignTracker, CampaignTrackFunction, CampaignTrackerOptions } from '@amplitude/analytics-types';
+export declare class CampaignTracker implements ICampaignTracker {
+    storage: Storage<Campaign>;
+    storageKey: string;
+    parser: ICampaignParser;
+    track: CampaignTrackFunction;
+    onNewCampaign: (campaign: Campaign) => unknown;
+    disabled: boolean;
+    trackNewCampaigns: boolean;
+    trackPageViews: boolean;
+    excludeReferrers: string[];
+    initialEmptyValue: string;
+    constructor(apiKey: string, options: CampaignTrackerOptions);
+    isNewCampaign(currentCampaign: Campaign, previousCampaign: Campaign): boolean;
+    saveCampaignToStorage(campaign: Campaign): Promise<void>;
+    getCampaignFromStorage(): Promise<Campaign>;
+    createCampaignEvent(campaign: Campaign): {
+        event_type: string;
+        event_properties?: {
+            [key: string]: any;
+        } | undefined;
+        user_properties: {
+            [key: string]: any;
+        } | import("@amplitude/analytics-types").IdentifyUserProperties | {
+            [x: string]: any;
+        };
+        group_properties?: {
+            [key: string]: any;
+        } | undefined;
+        groups?: {
+            [key: string]: any;
+        } | undefined;
+        user_id?: string | undefined;
+        device_id?: string | undefined;
+        time?: number | undefined;
+        location_lat?: number | undefined;
+        location_lng?: number | undefined;
+        app_version?: string | undefined;
+        version_name?: string | undefined;
+        library?: string | undefined;
+        platform?: string | undefined;
+        os_name?: string | undefined;
+        os_version?: string | undefined;
+        device_brand?: string | undefined;
+        device_manufacturer?: string | undefined;
+        device_model?: string | undefined;
+        carrier?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        city?: string | undefined;
+        dma?: string | undefined;
+        idfa?: string | undefined;
+        idfv?: string | undefined;
+        adid?: string | undefined;
+        android_id?: string | undefined;
+        language?: string | undefined;
+        ip?: string | undefined;
+        uuid?: string | undefined;
+        price?: number | undefined;
+        quantity?: number | undefined;
+        revenue?: number | undefined;
+        productId?: string | undefined;
+        revenueType?: string | undefined;
+        event_id?: number | undefined;
+        session_id?: number | undefined;
+        insert_id?: string | undefined;
+        plan?: import("@amplitude/analytics-types").Plan | undefined;
+        partner_id?: string | undefined;
+    };
+    send(isNewSession: boolean): Promise<void>;
+}
+//# sourceMappingURL=campaign-tracker.d.ts.map

package/lib/cjs/attribution/campaign-tracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-tracker.d.ts","sourceRoot":"","sources":["../../../src/attribution/campaign-tracker.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,QAAQ,EACR,cAAc,IAAI,eAAe,EACjC,eAAe,IAAI,gBAAgB,EACnC,qBAAqB,EACrB,sBAAsB,EAEvB,MAAM,4BAA4B,CAAC;AAKpC,qBAAa,eAAgB,YAAW,gBAAgB;IACtD,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,eAAe,CAAC;IACxB,KAAK,EAAE,qBAAqB,CAAC;IAC7B,aAAa,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC;IAE/C,QAAQ,EAAE,OAAO,CAAC;IAClB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB;IAiB3D,aAAa,CAAC,eAAe,EAAE,QAAQ,EAAE,gBAAgB,EAAE,QAAQ;IAe7D,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD,sBAAsB,IAAI,OAAO,CAAC,QAAQ,CAAC;IAIjD,mBAAmB,CAAC,QAAQ,EAAE,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6BhC,IAAI,CAAC,YAAY,EAAE,OAAO;CAejC"}

package/lib/cjs/attribution/campaign-tracker.js

@@ -0,0 +1,113 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignTracker = void 0;
+var tslib_1 = require("tslib");
+var analytics_core_1 = require("@amplitude/analytics-core");
+var cookie_name_1 = require("../utils/cookie-name");
+var campaign_parser_1 = require("./campaign-parser");
+var constants_1 = require("./constants");
+var CampaignTracker = /** @class */ (function () {
+    function CampaignTracker(apiKey, options) {
+        var _a, _b;
+        this.storage = options.storage;
+        this.storageKey = (0, cookie_name_1.getCookieName)(apiKey, constants_1.MKTG);
+        this.parser = new campaign_parser_1.CampaignParser();
+        this.track = options.track;
+        this.onNewCampaign = options.onNewCampaign;
+        this.disabled = Boolean(options.disabled);
+        this.trackNewCampaigns = Boolean(options.trackNewCampaigns);
+        this.trackPageViews = Boolean(options.trackPageViews);
+        this.excludeReferrers = (_a = options.excludeReferrers) !== null && _a !== void 0 ? _a : [];
+        if (typeof location !== 'undefined') {
+            this.excludeReferrers.unshift(location.hostname);
+        }
+        this.initialEmptyValue = (_b = options.initialEmptyValue) !== null && _b !== void 0 ? _b : constants_1.EMPTY_VALUE;
+    }
+    CampaignTracker.prototype.isNewCampaign = function (currentCampaign, previousCampaign) {
+        var isReferrerExcluded = Boolean(currentCampaign.referring_domain && this.excludeReferrers.includes(currentCampaign.referring_domain));
+        var hasNewUtm = previousCampaign.utm_campaign !== currentCampaign.utm_campaign ||
+            previousCampaign.utm_source !== currentCampaign.utm_source ||
+            previousCampaign.utm_medium !== currentCampaign.utm_medium ||
+            previousCampaign.utm_term !== currentCampaign.utm_term ||
+            previousCampaign.utm_content !== currentCampaign.utm_content;
+        var hasNewReferrer = previousCampaign.referring_domain !== currentCampaign.referring_domain;
+        return !isReferrerExcluded && (hasNewUtm || hasNewReferrer);
+    };
+    CampaignTracker.prototype.saveCampaignToStorage = function (campaign) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            return (0, tslib_1.__generator)(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.storage.set(this.storageKey, campaign)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    CampaignTracker.prototype.getCampaignFromStorage = function () {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            return (0, tslib_1.__generator)(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.storage.get(this.storageKey)];
+                    case 1: return [2 /*return*/, (_a.sent()) || (0, tslib_1.__assign)({}, constants_1.BASE_CAMPAIGN)];
+                }
+            });
+        });
+    };
+    CampaignTracker.prototype.createCampaignEvent = function (campaign) {
+        var _this = this;
+        var campaignParameters = (0, tslib_1.__assign)((0, tslib_1.__assign)({}, constants_1.BASE_CAMPAIGN), campaign);
+        var identifyEvent = Object.entries(campaignParameters).reduce(function (identify, _a) {
+            var _b = (0, tslib_1.__read)(_a, 2), key = _b[0], value = _b[1];
+            identify.setOnce("initial_".concat(key), value || _this.initialEmptyValue);
+            if (value) {
+                return identify.set(key, value);
+            }
+            return identify.unset(key);
+        }, new analytics_core_1.Identify());
+        var pageViewEvent = {
+            event_type: 'Page View',
+            event_properties: {
+                page_title: /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '',
+                page_location: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href) || '',
+                page_path: /* istanbul ignore next */ (typeof location !== 'undefined' && location.pathname) || '',
+            },
+        };
+        return (0, tslib_1.__assign)((0, tslib_1.__assign)({}, (0, analytics_core_1.createIdentifyEvent)(identifyEvent)), (this.trackPageViews && pageViewEvent));
+    };
+    CampaignTracker.prototype.send = function (isNewSession) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            var currentCampaign, previousCampaign;
+            return (0, tslib_1.__generator)(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.disabled) {
+                            return [2 /*return*/];
+                        }
+                        return [4 /*yield*/, this.parser.parse()];
+                    case 1:
+                        currentCampaign = _a.sent();
+                        return [4 /*yield*/, this.getCampaignFromStorage()];
+                    case 2:
+                        previousCampaign = _a.sent();
+                        if (!isNewSession) {
+                            if (!this.trackNewCampaigns || !this.isNewCampaign(currentCampaign, previousCampaign)) {
+                                return [2 /*return*/];
+                            }
+                            this.onNewCampaign(currentCampaign);
+                        }
+                        return [4 /*yield*/, this.track(this.createCampaignEvent(currentCampaign))];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, this.saveCampaignToStorage(currentCampaign)];
+                    case 4:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return CampaignTracker;
+}());
+exports.CampaignTracker = CampaignTracker;
+//# sourceMappingURL=campaign-tracker.js.map

package/lib/cjs/attribution/campaign-tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-tracker.js","sourceRoot":"","sources":["../../../src/attribution/campaign-tracker.ts"],"names":[],"mappings":";;;AAAA,4DAA0E;AAU1E,oDAAsE;AACtE,qDAAmD;AACnD,yCAA+D;AAE/D;IAaE,yBAAY,MAAc,EAAE,OAA+B;;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAA,2BAAa,EAAC,MAAM,EAAE,gBAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,IAAI,gCAAc,EAAE,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,CAAC,gBAAgB,GAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,EAAE,CAAC;QACvD,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;YACnC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAClD;QACD,IAAI,CAAC,iBAAiB,GAAG,MAAA,OAAO,CAAC,iBAAiB,mCAAI,uBAAW,CAAC;IACpE,CAAC;IAED,uCAAa,GAAb,UAAc,eAAyB,EAAE,gBAA0B;QACjE,IAAM,kBAAkB,GAAG,OAAO,CAChC,eAAe,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,CACrG,CAAC;QACF,IAAM,SAAS,GACb,gBAAgB,CAAC,YAAY,KAAK,eAAe,CAAC,YAAY;YAC9D,gBAAgB,CAAC,UAAU,KAAK,eAAe,CAAC,UAAU;YAC1D,gBAAgB,CAAC,UAAU,KAAK,eAAe,CAAC,UAAU;YAC1D,gBAAgB,CAAC,QAAQ,KAAK,eAAe,CAAC,QAAQ;YACtD,gBAAgB,CAAC,WAAW,KAAK,eAAe,CAAC,WAAW,CAAC;QAC/D,IAAM,cAAc,GAAG,gBAAgB,CAAC,gBAAgB,KAAK,eAAe,CAAC,gBAAgB,CAAC;QAE9F,OAAO,CAAC,kBAAkB,IAAI,CAAC,SAAS,IAAI,cAAc,CAAC,CAAC;IAC9D,CAAC;IAEK,+CAAqB,GAA3B,UAA4B,QAAkB;;;;4BAC5C,qBAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAA;;wBAAjD,SAAiD,CAAC;;;;;KACnD;IAEK,gDAAsB,GAA5B;;;;4BACU,qBAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,EAAA;4BAA/C,sBAAO,CAAC,SAAuC,CAAC,8BAAS,yBAAa,CAAE,EAAC;;;;KAC1E;IAED,6CAAmB,GAAnB,UAAoB,QAAkB;QAAtC,iBA2BC;QA1BC,IAAM,kBAAkB,mDAGnB,yBAAa,GACb,QAAQ,CACZ,CAAC;QACF,IAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,UAAC,QAAQ,EAAE,EAAY;gBAAZ,KAAA,0BAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YACpF,QAAQ,CAAC,OAAO,CAAC,kBAAW,GAAG,CAAE,EAAE,KAAK,IAAI,KAAI,CAAC,iBAAiB,CAAC,CAAC;YACpE,IAAI,KAAK,EAAE;gBACT,OAAO,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aACjC;YACD,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC,EAAE,IAAI,yBAAQ,EAAE,CAAC,CAAC;QAEnB,IAAM,aAAa,GAAc;YAC/B,UAAU,EAAE,WAAW;YACvB,gBAAgB,EAAE;gBAChB,UAAU,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE;gBAChG,aAAa,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;gBAClG,SAAS,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;aACnG;SACF,CAAC;QACF,uDACK,IAAA,oCAAmB,EAAC,aAAa,CAAC,GAClC,CAAC,IAAI,CAAC,cAAc,IAAI,aAAa,CAAC,EACzC;IACJ,CAAC;IAEK,8BAAI,GAAV,UAAW,YAAqB;;;;;;wBAC9B,IAAI,IAAI,CAAC,QAAQ,EAAE;4BACjB,sBAAO;yBACR;wBACuB,qBAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAA;;wBAA3C,eAAe,GAAG,SAAyB;wBACxB,qBAAM,IAAI,CAAC,sBAAsB,EAAE,EAAA;;wBAAtD,gBAAgB,GAAG,SAAmC;wBAC5D,IAAI,CAAC,YAAY,EAAE;4BACjB,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,gBAAgB,CAAC,EAAE;gCACrF,sBAAO;6BACR;4BACD,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;yBACrC;wBACD,qBAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,EAAA;;wBAA3D,SAA2D,CAAC;wBAC5D,qBAAM,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,EAAA;;wBAAjD,SAAiD,CAAC;;;;;KACnD;IACH,sBAAC;AAAD,CAAC,AAjGD,IAiGC;AAjGY,0CAAe","sourcesContent":["import { createIdentifyEvent, Identify } from '@amplitude/analytics-core';\nimport {\n  Storage,\n  Campaign,\n  CampaignParser as ICampaignParser,\n  CampaignTracker as ICampaignTracker,\n  CampaignTrackFunction,\n  CampaignTrackerOptions,\n  BaseEvent,\n} from '@amplitude/analytics-types';\nimport { getCookieName as getStorageKey } from '../utils/cookie-name';\nimport { CampaignParser } from './campaign-parser';\nimport { BASE_CAMPAIGN, EMPTY_VALUE, MKTG } from './constants';\n\nexport class CampaignTracker implements ICampaignTracker {\n  storage: Storage<Campaign>;\n  storageKey: string;\n  parser: ICampaignParser;\n  track: CampaignTrackFunction;\n  onNewCampaign: (campaign: Campaign) => unknown;\n\n  disabled: boolean;\n  trackNewCampaigns: boolean;\n  trackPageViews: boolean;\n  excludeReferrers: string[];\n  initialEmptyValue: string;\n\n  constructor(apiKey: string, options: CampaignTrackerOptions) {\n    this.storage = options.storage;\n    this.storageKey = getStorageKey(apiKey, MKTG);\n    this.parser = new CampaignParser();\n    this.track = options.track;\n    this.onNewCampaign = options.onNewCampaign;\n\n    this.disabled = Boolean(options.disabled);\n    this.trackNewCampaigns = Boolean(options.trackNewCampaigns);\n    this.trackPageViews = Boolean(options.trackPageViews);\n    this.excludeReferrers = options.excludeReferrers ?? [];\n    if (typeof location !== 'undefined') {\n      this.excludeReferrers.unshift(location.hostname);\n    }\n    this.initialEmptyValue = options.initialEmptyValue ?? EMPTY_VALUE;\n  }\n\n  isNewCampaign(currentCampaign: Campaign, previousCampaign: Campaign) {\n    const isReferrerExcluded = Boolean(\n      currentCampaign.referring_domain && this.excludeReferrers.includes(currentCampaign.referring_domain),\n    );\n    const hasNewUtm =\n      previousCampaign.utm_campaign !== currentCampaign.utm_campaign ||\n      previousCampaign.utm_source !== currentCampaign.utm_source ||\n      previousCampaign.utm_medium !== currentCampaign.utm_medium ||\n      previousCampaign.utm_term !== currentCampaign.utm_term ||\n      previousCampaign.utm_content !== currentCampaign.utm_content;\n    const hasNewReferrer = previousCampaign.referring_domain !== currentCampaign.referring_domain;\n\n    return !isReferrerExcluded && (hasNewUtm || hasNewReferrer);\n  }\n\n  async saveCampaignToStorage(campaign: Campaign): Promise<void> {\n    await this.storage.set(this.storageKey, campaign);\n  }\n\n  async getCampaignFromStorage(): Promise<Campaign> {\n    return (await this.storage.get(this.storageKey)) || { ...BASE_CAMPAIGN };\n  }\n\n  createCampaignEvent(campaign: Campaign) {\n    const campaignParameters: Campaign = {\n      // This object definition allows undefined keys to be iterated on\n      // in .reduce() to build indentify object\n      ...BASE_CAMPAIGN,\n      ...campaign,\n    };\n    const identifyEvent = Object.entries(campaignParameters).reduce((identify, [key, value]) => {\n      identify.setOnce(`initial_${key}`, value || this.initialEmptyValue);\n      if (value) {\n        return identify.set(key, value);\n      }\n      return identify.unset(key);\n    }, new Identify());\n\n    const pageViewEvent: BaseEvent = {\n      event_type: 'Page View',\n      event_properties: {\n        page_title: /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '',\n        page_location: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href) || '',\n        page_path: /* istanbul ignore next */ (typeof location !== 'undefined' && location.pathname) || '',\n      },\n    };\n    return {\n      ...createIdentifyEvent(identifyEvent),\n      ...(this.trackPageViews && pageViewEvent),\n    };\n  }\n\n  async send(isNewSession: boolean) {\n    if (this.disabled) {\n      return;\n    }\n    const currentCampaign = await this.parser.parse();\n    const previousCampaign = await this.getCampaignFromStorage();\n    if (!isNewSession) {\n      if (!this.trackNewCampaigns || !this.isNewCampaign(currentCampaign, previousCampaign)) {\n        return;\n      }\n      this.onNewCampaign(currentCampaign);\n    }\n    await this.track(this.createCampaignEvent(currentCampaign));\n    await this.saveCampaignToStorage(currentCampaign);\n  }\n}\n"]}

package/lib/cjs/{constants.d.ts → attribution/constants.d.ts}

@@ -1,3 +1,4 @@
+import { Campaign } from '@amplitude/analytics-types';
 export declare const UTM_SOURCE = "utm_source";
 export declare const UTM_MEDIUM = "utm_medium";
 export declare const UTM_CAMPAIGN = "utm_campaign";
@@ -10,4 +11,7 @@ export declare const UTMZ_TERM = "utmctr";
 export declare const UTMZ_CONTENT = "utmcct";
 export declare const GCLID = "gclid";
 export declare const FBCLID = "fbclid";
+export declare const EMPTY_VALUE = "EMPTY";
+export declare const BASE_CAMPAIGN: Campaign;
+export declare const MKTG = "MKTG";
 //# sourceMappingURL=constants.d.ts.map

package/lib/cjs/attribution/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/attribution/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAEtD,eAAO,MAAM,UAAU,eAAe,CAAC;AACvC,eAAO,MAAM,UAAU,eAAe,CAAC;AACvC,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAC3C,eAAO,MAAM,QAAQ,aAAa,CAAC;AACnC,eAAO,MAAM,WAAW,gBAAgB,CAAC;AAEzC,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC,eAAO,MAAM,aAAa,WAAW,CAAC;AACtC,eAAO,MAAM,SAAS,WAAW,CAAC;AAClC,eAAO,MAAM,YAAY,WAAW,CAAC;AAErC,eAAO,MAAM,KAAK,UAAU,CAAC;AAC7B,eAAO,MAAM,MAAM,WAAW,CAAC;AAE/B,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,eAAO,MAAM,aAAa,EAAE,QAU3B,CAAC;AAEF,eAAO,MAAM,IAAI,SAAS,CAAC"}

package/lib/cjs/attribution/constants.js

@@ -0,0 +1,28 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MKTG = exports.BASE_CAMPAIGN = exports.EMPTY_VALUE = exports.FBCLID = exports.GCLID = exports.UTMZ_CONTENT = exports.UTMZ_TERM = exports.UTMZ_CAMPAIGN = exports.UTMZ_MEDIUM = exports.UTMZ_SOURCE = exports.UTM_CONTENT = exports.UTM_TERM = exports.UTM_CAMPAIGN = exports.UTM_MEDIUM = exports.UTM_SOURCE = void 0;
+exports.UTM_SOURCE = 'utm_source';
+exports.UTM_MEDIUM = 'utm_medium';
+exports.UTM_CAMPAIGN = 'utm_campaign';
+exports.UTM_TERM = 'utm_term';
+exports.UTM_CONTENT = 'utm_content';
+exports.UTMZ_SOURCE = 'utmcsr';
+exports.UTMZ_MEDIUM = 'utmcmd';
+exports.UTMZ_CAMPAIGN = 'utmccn';
+exports.UTMZ_TERM = 'utmctr';
+exports.UTMZ_CONTENT = 'utmcct';
+exports.GCLID = 'gclid';
+exports.FBCLID = 'fbclid';
+exports.EMPTY_VALUE = 'EMPTY';
+exports.BASE_CAMPAIGN = {
+    utm_source: undefined,
+    utm_medium: undefined,
+    utm_campaign: undefined,
+    utm_term: undefined,
+    utm_content: undefined,
+    referrer: undefined,
+    referring_domain: undefined,
+    gclid: undefined,
+    fbclid: undefined,
+};
+exports.MKTG = 'MKTG';
+//# sourceMappingURL=constants.js.map

package/lib/cjs/attribution/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/attribution/constants.ts"],"names":[],"mappings":";;AAEa,QAAA,UAAU,GAAG,YAAY,CAAC;AAC1B,QAAA,UAAU,GAAG,YAAY,CAAC;AAC1B,QAAA,YAAY,GAAG,cAAc,CAAC;AAC9B,QAAA,QAAQ,GAAG,UAAU,CAAC;AACtB,QAAA,WAAW,GAAG,aAAa,CAAC;AAE5B,QAAA,WAAW,GAAG,QAAQ,CAAC;AACvB,QAAA,WAAW,GAAG,QAAQ,CAAC;AACvB,QAAA,aAAa,GAAG,QAAQ,CAAC;AACzB,QAAA,SAAS,GAAG,QAAQ,CAAC;AACrB,QAAA,YAAY,GAAG,QAAQ,CAAC;AAExB,QAAA,KAAK,GAAG,OAAO,CAAC;AAChB,QAAA,MAAM,GAAG,QAAQ,CAAC;AAElB,QAAA,WAAW,GAAG,OAAO,CAAC;AAEtB,QAAA,aAAa,GAAa;IACrC,UAAU,EAAE,SAAS;IACrB,UAAU,EAAE,SAAS;IACrB,YAAY,EAAE,SAAS;IACvB,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,SAAS;IACtB,QAAQ,EAAE,SAAS;IACnB,gBAAgB,EAAE,SAAS;IAC3B,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;CAClB,CAAC;AAEW,QAAA,IAAI,GAAG,MAAM,CAAC","sourcesContent":["import { Campaign } from '@amplitude/analytics-types';\n\nexport const UTM_SOURCE = 'utm_source';\nexport const UTM_MEDIUM = 'utm_medium';\nexport const UTM_CAMPAIGN = 'utm_campaign';\nexport const UTM_TERM = 'utm_term';\nexport const UTM_CONTENT = 'utm_content';\n\nexport const UTMZ_SOURCE = 'utmcsr';\nexport const UTMZ_MEDIUM = 'utmcmd';\nexport const UTMZ_CAMPAIGN = 'utmccn';\nexport const UTMZ_TERM = 'utmctr';\nexport const UTMZ_CONTENT = 'utmcct';\n\nexport const GCLID = 'gclid';\nexport const FBCLID = 'fbclid';\n\nexport const EMPTY_VALUE = 'EMPTY';\n\nexport const BASE_CAMPAIGN: Campaign = {\n  utm_source: undefined,\n  utm_medium: undefined,\n  utm_campaign: undefined,\n  utm_term: undefined,\n  utm_content: undefined,\n  referrer: undefined,\n  referring_domain: undefined,\n  gclid: undefined,\n  fbclid: undefined,\n};\n\nexport const MKTG = 'MKTG';\n"]}

package/lib/cjs/browser-client.d.ts

@@ -1,7 +1,8 @@
 import { AmplitudeCore } from '@amplitude/analytics-core';
-import { BrowserConfig, BrowserOptions, EventOptions, Identify as IIdentify, Result, Revenue as IRevenue, TransportType } from '@amplitude/analytics-types';
+import { AdditionalBrowserOptions, AttributionBrowserOptions, BrowserConfig, BrowserOptions, EventOptions, Identify as IIdentify, Result, Revenue as IRevenue, TransportType } from '@amplitude/analytics-types';
 export declare class AmplitudeBrowser extends AmplitudeCore<BrowserConfig> {
-    init(apiKey: string, userId?: string, options?: BrowserOptions): Promise<void>;
+    init(apiKey: string, userId?: string, options?: BrowserOptions & AdditionalBrowserOptions): Promise<void>;
+    runAttributionStrategy(attributionConfig?: AttributionBrowserOptions, isNewSession?: boolean): Promise<void>;
     getUserId(): string | undefined;
     setUserId(userId: string | undefined): void;
     getDeviceId(): string | undefined;
@@ -14,7 +15,6 @@ export declare class AmplitudeBrowser extends AmplitudeCore<BrowserConfig> {
     identify(identify: IIdentify, eventOptions?: EventOptions): Promise<Result>;
     groupIdentify(groupType: string, groupName: string | string[], identify: IIdentify, eventOptions?: EventOptions): Promise<Result>;
     revenue(revenue: IRevenue, eventOptions?: EventOptions): Promise<Result>;
-    trackAttributions(): Promise<Result> | undefined;
 }
 /**
  * Initializes the Amplitude SDK with your apiKey, userId and optional configurations.
@@ -24,7 +24,7 @@ export declare class AmplitudeBrowser extends AmplitudeCore<BrowserConfig> {
  * await init(API_KEY, USER_ID, options).promise;
  * ```
  */
-export declare const init: (apiKey: string, userId?: string | undefined, options?: BrowserOptions | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<void>;
+export declare const init: (apiKey: string, userId?: string | undefined, options?: (BrowserOptions & AdditionalBrowserOptions) | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<void>;
 /**
  * Adds a new plugin.
  *
@@ -206,4 +206,16 @@ export declare const setOptOut: (optOut: boolean) => void;
  * ```
  */
 export declare const setTransport: (transport: TransportType) => void;
+/**
+ * Flush and send all the events which haven't been sent.
+ *
+ *```typescript
+ * // Send all the unsent events
+ * flush();
+ *
+ * // alternatively, this tracking method is awaitable
+ * await flush().promise;
+ * ```
+ */
+export declare const flush: () => import("@amplitude/analytics-types").AmplitudeReturn<void>;
 //# sourceMappingURL=browser-client.d.ts.map

package/lib/cjs/browser-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser-client.d.ts","sourceRoot":"","sources":["../../src/browser-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiD,MAAM,2BAA2B,CAAC;AACzG,OAAO,EACL,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,IAAI,SAAS,EACrB,MAAM,EACN,OAAO,IAAI,QAAQ,EACnB,aAAa,EACd,MAAM,4BAA4B,CAAC;AAQpC,qBAAa,gBAAiB,SAAQ,aAAa,CAAC,aAAa,CAAC;IAC1D,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAwBpE,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAKpC,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAK5B,kBAAkB;IAKlB,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM;IAK9B,SAAS,CAAC,MAAM,EAAE,OAAO;IAKzB,YAAY,CAAC,SAAS,EAAE,aAAa;IAIrC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAS3E,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAC5B,QAAQ,EAAE,SAAS,EACnB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,MAAM,CAAC;IASlB,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,YAAY;IAStD,iBAAiB;CAclB;AAID;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,mJAA0C,CAAC;AAE5D;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,qHAAyC,CAAC;AAE1D;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,oFAA4C,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,mOAA2C,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,QAAQ,mOAA8C,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,gIAA8C,CAAC;AAEpE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,iLAAmD,CAAC;AAC9E,eAAO,MAAM,QAAQ,mHAA8C,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,8HAA6C,CAAC;AAElE;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,0BAAgC,CAAC;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,WArNF,MAAM,GAAG,SAAS,SAqNgB,CAAC;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,0BAAkC,CAAC;AAE3D;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,aAhOA,MAAM,SAgO4B,CAAC;AAE3D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,YAAyC,CAAC;AAEzE;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,0BAAmC,CAAC;AAE7D;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,cAhPC,MAAM,SAgP4B,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,WAxPF,OAAO,SAwP2B,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,cAnQC,aAAa,SAmQqB,CAAC"}
+{"version":3,"file":"browser-client.d.ts","sourceRoot":"","sources":["../../src/browser-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiD,MAAM,2BAA2B,CAAC;AACzG,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,aAAa,EACb,cAAc,EAEd,YAAY,EACZ,QAAQ,IAAI,SAAS,EACrB,MAAM,EACN,OAAO,IAAI,QAAQ,EACnB,aAAa,EACd,MAAM,4BAA4B,CAAC;AAOpC,qBAAa,gBAAiB,SAAQ,aAAa,CAAC,aAAa,CAAC;IAC1D,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,wBAAwB;IAoCzF,sBAAsB,CAAC,iBAAiB,CAAC,EAAE,yBAAyB,EAAE,YAAY,UAAQ;IAehG,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAIpC,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAI5B,kBAAkB;IAKlB,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM;IAI9B,SAAS,CAAC,MAAM,EAAE,OAAO;IAIzB,YAAY,CAAC,SAAS,EAAE,aAAa;IAIrC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAS3E,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAC5B,QAAQ,EAAE,SAAS,EACnB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,MAAM,CAAC;IASlB,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,YAAY;CAQvD;AAID;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,gLAA0C,CAAC;AAE5D;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,qHAAyC,CAAC;AAE1D;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,oFAA4C,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,mOAA2C,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,QAAQ,mOAA8C,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,gIAA8C,CAAC;AAEpE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,iLAAmD,CAAC;AAC9E,eAAO,MAAM,QAAQ,mHAA8C,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,8HAA6C,CAAC;AAElE;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,0BAAgC,CAAC;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,WAlMF,MAAM,GAAG,SAAS,SAkMgB,CAAC;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,0BAAkC,CAAC;AAE3D;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,aA9MA,MAAM,SA8M4B,CAAC;AAE3D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,YAAyC,CAAC;AAEzE;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,0BAAmC,CAAC;AAE7D;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,cA/NC,MAAM,SA+N4B,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,WAxOF,OAAO,SAwO2B,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,cApPC,aAAa,SAoPqB,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,kEAA2C,CAAC"}

package/lib/cjs/browser-client.js

@@ -1,13 +1,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setTransport = exports.setOptOut = exports.setSessionId = exports.getSessionId = exports.regenerateDeviceId = exports.setDeviceId = exports.getDeviceId = exports.setUserId = exports.getUserId = exports.revenue = exports.setGroup = exports.groupIdentify = exports.identify = exports.logEvent = exports.track = exports.remove = exports.add = exports.init = exports.AmplitudeBrowser = void 0;
+exports.flush = exports.setTransport = exports.setOptOut = exports.setSessionId = exports.getSessionId = exports.regenerateDeviceId = exports.setDeviceId = exports.getDeviceId = exports.setUserId = exports.getUserId = exports.revenue = exports.setGroup = exports.groupIdentify = exports.identify = exports.logEvent = exports.track = exports.remove = exports.add = exports.init = exports.AmplitudeBrowser = void 0;
 var tslib_1 = require("tslib");
 var analytics_core_1 = require("@amplitude/analytics-core");
 var snippet_helper_1 = require("./utils/snippet-helper");
 var context_1 = require("./plugins/context");
 var config_1 = require("./config");
-var attribution_1 = require("./attribution");
-var session_manager_1 = require("./session-manager");
 var cookie_migration_1 = require("./cookie-migration");
+var campaign_tracker_1 = require("./attribution/campaign-tracker");
 var AmplitudeBrowser = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(AmplitudeBrowser, _super);
     function AmplitudeBrowser() {
@@ -16,27 +15,63 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
     AmplitudeBrowser.prototype.init = function (apiKey, userId, options) {
         var _a, _b, _c;
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var oldCookies, browserOptions;
+            var oldCookies, browserOptions, isNewSession;
             return (0, tslib_1.__generator)(this, function (_d) {
                 switch (_d.label) {
-                    case 0:
-                        oldCookies = (0, cookie_migration_1.parseOldCookies)(apiKey, options);
-                        browserOptions = (0, config_1.useBrowserConfig)(apiKey, userId || oldCookies.userId, (0, tslib_1.__assign)((0, tslib_1.__assign)({}, options), { deviceId: (_a = oldCookies.deviceId) !== null && _a !== void 0 ? _a : options === null || options === void 0 ? void 0 : options.deviceId, sessionId: (_b = oldCookies.sessionId) !== null && _b !== void 0 ? _b : options === null || options === void 0 ? void 0 : options.sessionId, optOut: (_c = options === null || options === void 0 ? void 0 : options.optOut) !== null && _c !== void 0 ? _c : oldCookies.optOut }));
-                        return [4 /*yield*/, _super.prototype.init.call(this, undefined, undefined, browserOptions)];
+                    case 0: return [4 /*yield*/, (0, cookie_migration_1.parseOldCookies)(apiKey, options)];
                     case 1:
+                        oldCookies = _d.sent();
+                        return [4 /*yield*/, (0, config_1.useBrowserConfig)(apiKey, userId || oldCookies.userId, (0, tslib_1.__assign)((0, tslib_1.__assign)({}, options), { deviceId: (_a = oldCookies.deviceId) !== null && _a !== void 0 ? _a : options === null || options === void 0 ? void 0 : options.deviceId, sessionId: (_b = oldCookies.sessionId) !== null && _b !== void 0 ? _b : options === null || options === void 0 ? void 0 : options.sessionId, optOut: (_c = options === null || options === void 0 ? void 0 : options.optOut) !== null && _c !== void 0 ? _c : oldCookies.optOut, lastEventTime: oldCookies.lastEventTime }))];
+                    case 2:
+                        browserOptions = _d.sent();
+                        return [4 /*yield*/, _super.prototype.init.call(this, undefined, undefined, browserOptions)];
+                    case 3:
                         _d.sent();
-                        // Step 3: Store user session in cookie storage
-                        (0, session_manager_1.updateCookies)(this.config, oldCookies.lastEventTime);
+                        isNewSession = false;
+                        if (!this.config.sessionId ||
+                            (this.config.lastEventTime && Date.now() - this.config.lastEventTime > this.config.sessionTimeout)) {
+                            // Either
+                            // 1) No previous session; or
+                            // 2) Previous session expired
+                            this.config.sessionId = Date.now();
+                            isNewSession = true;
+                        }
                         // Step 4: Install plugins
+                        // Do not track any events before this
                         return [4 /*yield*/, this.add(new context_1.Context())];
-                    case 2:
+                    case 4:
                         // Step 4: Install plugins
+                        // Do not track any events before this
                         _d.sent();
                         return [4 /*yield*/, this.add(new analytics_core_1.Destination())];
-                    case 3:
+                    case 5:
+                        _d.sent();
+                        // Step 5: Track attributions
+                        return [4 /*yield*/, this.runAttributionStrategy(options === null || options === void 0 ? void 0 : options.attribution, isNewSession)];
+                    case 6:
+                        // Step 5: Track attributions
                         _d.sent();
-                        // Step 4: Track attributions
-                        void this.trackAttributions();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AmplitudeBrowser.prototype.runAttributionStrategy = function (attributionConfig, isNewSession) {
+        if (isNewSession === void 0) { isNewSession = false; }
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            var track, onNewCampaign, storage, campaignTracker;
+            return (0, tslib_1.__generator)(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        track = this.track.bind(this);
+                        onNewCampaign = this.setSessionId.bind(this, Date.now());
+                        return [4 /*yield*/, (0, config_1.createFlexibleStorage)(this.config)];
+                    case 1:
+                        storage = _a.sent();
+                        campaignTracker = new campaign_tracker_1.CampaignTracker(this.config.apiKey, (0, tslib_1.__assign)((0, tslib_1.__assign)({}, attributionConfig), { storage: storage, track: track, onNewCampaign: onNewCampaign }));
+                        return [4 /*yield*/, campaignTracker.send(isNewSession)];
+                    case 2:
+                        _a.sent();
                         return [2 /*return*/];
                 }
             });
@@ -47,14 +82,12 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
     };
     AmplitudeBrowser.prototype.setUserId = function (userId) {
         this.config.userId = userId;
-        (0, session_manager_1.updateCookies)(this.config);
     };
     AmplitudeBrowser.prototype.getDeviceId = function () {
         return this.config.deviceId;
     };
     AmplitudeBrowser.prototype.setDeviceId = function (deviceId) {
         this.config.deviceId = deviceId;
-        (0, session_manager_1.updateCookies)(this.config);
     };
     AmplitudeBrowser.prototype.regenerateDeviceId = function () {
         var deviceId = (0, config_1.createDeviceId)();
@@ -65,11 +98,9 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
     };
     AmplitudeBrowser.prototype.setSessionId = function (sessionId) {
         this.config.sessionId = sessionId;
-        (0, session_manager_1.updateCookies)(this.config);
     };
     AmplitudeBrowser.prototype.setOptOut = function (optOut) {
-        _super.prototype.setOptOut.call(this, optOut);
-        (0, session_manager_1.updateCookies)(this.config);
+        this.config.optOut = optOut;
     };
     AmplitudeBrowser.prototype.setTransport = function (transport) {
         this.config.transportProvider = (0, config_1.createTransport)(transport);
@@ -98,21 +129,6 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
         }
         return _super.prototype.revenue.call(this, revenue, eventOptions);
     };
-    AmplitudeBrowser.prototype.trackAttributions = function () {
-        var attributions = (0, attribution_1.getAttributions)(this.config);
-        if (Object.keys(attributions).length === 0) {
-            return;
-        }
-        var id = new analytics_core_1.Identify();
-        Object.entries(attributions).forEach(function (_a) {
-            var _b = (0, tslib_1.__read)(_a, 2), key = _b[0], value = _b[1];
-            if (value) {
-                id.setOnce("initial_".concat(key), value);
-                id.set(key, value);
-            }
-        });
-        return this.identify(id);
-    };
     return AmplitudeBrowser;
 }(analytics_core_1.AmplitudeCore));
 exports.AmplitudeBrowser = AmplitudeBrowser;
@@ -307,4 +323,16 @@ exports.setOptOut = client.setOptOut.bind(client);
  * ```
  */
 exports.setTransport = client.setTransport.bind(client);
+/**
+ * Flush and send all the events which haven't been sent.
+ *
+ *```typescript
+ * // Send all the unsent events
+ * flush();
+ *
+ * // alternatively, this tracking method is awaitable
+ * await flush().promise;
+ * ```
+ */
+exports.flush = (0, analytics_core_1.returnWrapper)(client.flush.bind(client));
 //# sourceMappingURL=browser-client.js.map