@amplitude/plugin-web-attribution-browser 2.2.23 → 2.2.25-video-analytics-2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,34 @@
1
+ import { BrowserConfig, Storage } from '@amplitude/analytics-core';
2
+ import type { Campaign, ILogger } from '@amplitude/analytics-core';
3
+ export interface Options {
4
+ excludeReferrers?: (string | RegExp)[];
5
+ initialEmptyValue?: string;
6
+ resetSessionOnNewCampaign?: boolean;
7
+ }
8
+ export declare const isNewCampaign: (current: Campaign, previous: Campaign | undefined, options: Options, logger: ILogger, isNewSession?: boolean) => boolean;
9
+ export declare const isExcludedReferrer: (excludeReferrers?: (string | RegExp)[], referringDomain?: string) => boolean;
10
+ export declare const createCampaignEvent: (campaign: Campaign, options: Options) => import("@amplitude/analytics-core").IdentifyEvent;
11
+ export declare const getDefaultExcludedReferrers: (cookieDomain: string | undefined) => RegExp[];
12
+ export declare class WebAttribution {
13
+ options: Options;
14
+ storage: Storage<Campaign>;
15
+ storageKey: string;
16
+ previousCampaign?: Campaign;
17
+ currentCampaign: Campaign;
18
+ shouldTrackNewCampaign: boolean;
19
+ sessionTimeout: number;
20
+ lastEventTime?: number;
21
+ logger: ILogger;
22
+ constructor(options: Options, config: BrowserConfig);
23
+ init(): Promise<void>;
24
+ fetchCampaign(): Promise<[Campaign, Campaign | undefined]>;
25
+ /**
26
+ * This can be called when enable web attribution and either
27
+ * 1. set a new session
28
+ * 2. has new campaign and enable resetSessionOnNewCampaign
29
+ */
30
+ generateCampaignEvent(event_id?: number): import("@amplitude/analytics-core").IdentifyEvent;
31
+ shouldSetSessionIdOnNewCampaign(): boolean;
32
+ }
33
+ export declare const isNewSession: (sessionTimeout: number, lastEventTime?: number) => boolean;
34
+ //# sourceMappingURL=helpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EACb,OAAO,EAIR,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEnE,MAAM,WAAW,OAAO;IACtB,gBAAgB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAiBD,eAAO,MAAM,aAAa,YACf,QAAQ,YACP,QAAQ,GAAG,SAAS,WACrB,OAAO,UACR,OAAO,oCA+BhB,CAAC;AAEF,eAAO,MAAM,kBAAkB,sBAAsB,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,sCAIvE,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAc,QAAQ,WAAW,OAAO,sDAgBvE,CAAC;AAEF,eAAO,MAAM,2BAA2B,iBAAkB,MAAM,GAAG,SAAS,aAS3E,CAAC;AAEF,qBAAa,cAAc;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,eAAe,EAAE,QAAQ,CAAC;IAC1B,sBAAsB,UAAS;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;gBAEJ,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa;IAgB7C,IAAI;IAUJ,aAAa;IAInB;;;;OAIG;IACH,qBAAqB,CAAC,QAAQ,CAAC,EAAE,MAAM;IAUvC,+BAA+B;CAGhC;AAED,eAAO,MAAM,YAAY,mBAAoB,MAAM,kBAAiB,MAAM,KAAgB,OAKzF,CAAC"}
@@ -0,0 +1,147 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isNewSession = exports.WebAttribution = exports.getDefaultExcludedReferrers = exports.createCampaignEvent = exports.isExcludedReferrer = exports.isNewCampaign = void 0;
4
+ var tslib_1 = require("tslib");
5
+ var analytics_core_1 = require("@amplitude/analytics-core");
6
+ var domainWithoutSubdomain = function (domain) {
7
+ var parts = domain.split('.');
8
+ if (parts.length <= 2) {
9
+ return domain;
10
+ }
11
+ return parts.slice(parts.length - 2, parts.length).join('.');
12
+ };
13
+ //Direct traffic mean no external referral, no UTMs, no click-ids, and no other customer identified marketing campaign url params.
14
+ var isDirectTraffic = function (current) {
15
+ return Object.values(current).every(function (value) { return !value; });
16
+ };
17
+ var isNewCampaign = function (current, previous, options, logger, isNewSession) {
18
+ if (isNewSession === void 0) { isNewSession = true; }
19
+ var referrer = current.referrer, referring_domain = current.referring_domain, currentCampaign = tslib_1.__rest(current, ["referrer", "referring_domain"]);
20
+ var _a = previous || {}, _previous_referrer = _a.referrer, prevReferringDomain = _a.referring_domain, previousCampaign = tslib_1.__rest(_a, ["referrer", "referring_domain"]);
21
+ if ((0, exports.isExcludedReferrer)(options.excludeReferrers, current.referring_domain)) {
22
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
23
+ logger.debug("This is not a new campaign because ".concat(current.referring_domain, " is in the exclude referrer list."));
24
+ return false;
25
+ }
26
+ //In the same session, direct traffic should not override or unset any persisting query params
27
+ if (!isNewSession && isDirectTraffic(current) && previous) {
28
+ logger.debug('This is not a new campaign because this is a direct traffic in the same session.');
29
+ return false;
30
+ }
31
+ var hasNewCampaign = JSON.stringify(currentCampaign) !== JSON.stringify(previousCampaign);
32
+ var hasNewDomain = domainWithoutSubdomain(referring_domain || '') !== domainWithoutSubdomain(prevReferringDomain || '');
33
+ var result = !previous || hasNewCampaign || hasNewDomain;
34
+ if (!result) {
35
+ logger.debug("This is not a new campaign because it's the same as the previous one.");
36
+ }
37
+ else {
38
+ logger.debug("This is a new campaign. An $identify event will be sent.");
39
+ }
40
+ return result;
41
+ };
42
+ exports.isNewCampaign = isNewCampaign;
43
+ var isExcludedReferrer = function (excludeReferrers, referringDomain) {
44
+ if (excludeReferrers === void 0) { excludeReferrers = []; }
45
+ if (referringDomain === void 0) { referringDomain = ''; }
46
+ return excludeReferrers.some(function (value) {
47
+ return value instanceof RegExp ? value.test(referringDomain) : value === referringDomain;
48
+ });
49
+ };
50
+ exports.isExcludedReferrer = isExcludedReferrer;
51
+ var createCampaignEvent = function (campaign, options) {
52
+ var campaignParameters = tslib_1.__assign(tslib_1.__assign({}, analytics_core_1.BASE_CAMPAIGN), campaign);
53
+ var identifyEvent = Object.entries(campaignParameters).reduce(function (identify, _a) {
54
+ var _b;
55
+ var _c = tslib_1.__read(_a, 2), key = _c[0], value = _c[1];
56
+ identify.setOnce("initial_".concat(key), (_b = value !== null && value !== void 0 ? value : options.initialEmptyValue) !== null && _b !== void 0 ? _b : 'EMPTY');
57
+ if (value) {
58
+ return identify.set(key, value);
59
+ }
60
+ return identify.unset(key);
61
+ }, new analytics_core_1.Identify());
62
+ return (0, analytics_core_1.createIdentifyEvent)(identifyEvent);
63
+ };
64
+ exports.createCampaignEvent = createCampaignEvent;
65
+ var getDefaultExcludedReferrers = function (cookieDomain) {
66
+ var domain = cookieDomain;
67
+ if (domain) {
68
+ if (domain.startsWith('.')) {
69
+ domain = domain.substring(1);
70
+ }
71
+ return [new RegExp("".concat(domain.replace('.', '\\.'), "$"))];
72
+ }
73
+ return [];
74
+ };
75
+ exports.getDefaultExcludedReferrers = getDefaultExcludedReferrers;
76
+ var WebAttribution = /** @class */ (function () {
77
+ function WebAttribution(options, config) {
78
+ var _a;
79
+ this.shouldTrackNewCampaign = false;
80
+ this.options = tslib_1.__assign({ initialEmptyValue: 'EMPTY', resetSessionOnNewCampaign: false, excludeReferrers: (0, exports.getDefaultExcludedReferrers)((_a = config.cookieOptions) === null || _a === void 0 ? void 0 : _a.domain) }, options);
81
+ this.storage = config.cookieStorage;
82
+ this.storageKey = (0, analytics_core_1.getStorageKey)(config.apiKey, 'MKTG');
83
+ this.currentCampaign = analytics_core_1.BASE_CAMPAIGN;
84
+ this.sessionTimeout = config.sessionTimeout;
85
+ this.lastEventTime = config.lastEventTime;
86
+ this.logger = config.loggerProvider;
87
+ config.loggerProvider.log('Installing web attribution tracking.');
88
+ }
89
+ WebAttribution.prototype.init = function () {
90
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
91
+ var isEventInNewSession;
92
+ var _a;
93
+ return tslib_1.__generator(this, function (_b) {
94
+ switch (_b.label) {
95
+ case 0: return [4 /*yield*/, this.fetchCampaign()];
96
+ case 1:
97
+ _a = tslib_1.__read.apply(void 0, [_b.sent(), 2]), this.currentCampaign = _a[0], this.previousCampaign = _a[1];
98
+ isEventInNewSession = !this.lastEventTime ? true : (0, exports.isNewSession)(this.sessionTimeout, this.lastEventTime);
99
+ if (!(0, exports.isNewCampaign)(this.currentCampaign, this.previousCampaign, this.options, this.logger, isEventInNewSession)) return [3 /*break*/, 3];
100
+ this.shouldTrackNewCampaign = true;
101
+ return [4 /*yield*/, this.storage.set(this.storageKey, this.currentCampaign)];
102
+ case 2:
103
+ _b.sent();
104
+ _b.label = 3;
105
+ case 3: return [2 /*return*/];
106
+ }
107
+ });
108
+ });
109
+ };
110
+ WebAttribution.prototype.fetchCampaign = function () {
111
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
112
+ return tslib_1.__generator(this, function (_a) {
113
+ switch (_a.label) {
114
+ case 0: return [4 /*yield*/, Promise.all([new analytics_core_1.CampaignParser().parse(), this.storage.get(this.storageKey)])];
115
+ case 1: return [2 /*return*/, _a.sent()];
116
+ }
117
+ });
118
+ });
119
+ };
120
+ /**
121
+ * This can be called when enable web attribution and either
122
+ * 1. set a new session
123
+ * 2. has new campaign and enable resetSessionOnNewCampaign
124
+ */
125
+ WebAttribution.prototype.generateCampaignEvent = function (event_id) {
126
+ // Mark this campaign has been tracked
127
+ this.shouldTrackNewCampaign = false;
128
+ var campaignEvent = (0, exports.createCampaignEvent)(this.currentCampaign, this.options);
129
+ if (event_id) {
130
+ campaignEvent.event_id = event_id;
131
+ }
132
+ return campaignEvent;
133
+ };
134
+ WebAttribution.prototype.shouldSetSessionIdOnNewCampaign = function () {
135
+ return this.shouldTrackNewCampaign && !!this.options.resetSessionOnNewCampaign;
136
+ };
137
+ return WebAttribution;
138
+ }());
139
+ exports.WebAttribution = WebAttribution;
140
+ var isNewSession = function (sessionTimeout, lastEventTime) {
141
+ if (lastEventTime === void 0) { lastEventTime = Date.now(); }
142
+ var currentTime = Date.now();
143
+ var timeSinceLastEvent = currentTime - lastEventTime;
144
+ return timeSinceLastEvent > sessionTimeout;
145
+ };
146
+ exports.isNewSession = isNewSession;
147
+ //# sourceMappingURL=helpers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":";;;;AAAA,4DAQmC;AASnC,IAAM,sBAAsB,GAAG,UAAC,MAAc;IAC5C,IAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEhC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE;QACrB,OAAO,MAAM,CAAC;KACf;IAED,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,kIAAkI;AAClI,IAAM,eAAe,GAAG,UAAC,OAAiB;IACxC,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK,IAAK,OAAA,CAAC,KAAK,EAAN,CAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AAEK,IAAM,aAAa,GAAG,UAC3B,OAAiB,EACjB,QAA8B,EAC9B,OAAgB,EAChB,MAAe,EACf,YAAmB;IAAnB,6BAAA,EAAA,mBAAmB;IAEX,IAAA,QAAQ,GAA2C,OAAO,SAAlD,EAAE,gBAAgB,GAAyB,OAAO,iBAAhC,EAAK,eAAe,kBAAK,OAAO,EAA5D,gCAAkD,CAAF,CAAa;IACnE,IAAM,KAA+F,QAAQ,IAAI,EAAE,EAAjG,kBAAkB,cAAA,EAAoB,mBAAmB,sBAAA,EAAK,gBAAgB,sBAA1F,gCAA4F,CAAiB,CAAC;IAEpH,IAAI,IAAA,0BAAkB,EAAC,OAAO,CAAC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE;QAC1E,4EAA4E;QAC5E,MAAM,CAAC,KAAK,CAAC,6CAAsC,OAAO,CAAC,gBAAgB,sCAAmC,CAAC,CAAC;QAChH,OAAO,KAAK,CAAC;KACd;IAED,8FAA8F;IAC9F,IAAI,CAAC,YAAY,IAAI,eAAe,CAAC,OAAO,CAAC,IAAI,QAAQ,EAAE;QACzD,MAAM,CAAC,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACjG,OAAO,KAAK,CAAC;KACd;IAED,IAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5F,IAAM,YAAY,GAChB,sBAAsB,CAAC,gBAAgB,IAAI,EAAE,CAAC,KAAK,sBAAsB,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC;IAEvG,IAAM,MAAM,GAAG,CAAC,QAAQ,IAAI,cAAc,IAAI,YAAY,CAAC;IAE3D,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,CAAC,KAAK,CAAC,uEAAuE,CAAC,CAAC;KACvF;SAAM;QACL,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC1E;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAnCW,QAAA,aAAa,iBAmCxB;AAEK,IAAM,kBAAkB,GAAG,UAAC,gBAA0C,EAAE,eAAoB;IAAhE,iCAAA,EAAA,qBAA0C;IAAE,gCAAA,EAAA,oBAAoB;IACjG,OAAO,gBAAgB,CAAC,IAAI,CAAC,UAAC,KAAK;QACjC,OAAA,KAAK,YAAY,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,eAAe;IAAjF,CAAiF,CAClF,CAAC;AACJ,CAAC,CAAC;AAJW,QAAA,kBAAkB,sBAI7B;AAEK,IAAM,mBAAmB,GAAG,UAAC,QAAkB,EAAE,OAAgB;IACtE,IAAM,kBAAkB,yCAGnB,8BAAa,GACb,QAAQ,CACZ,CAAC;IACF,IAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,UAAC,QAAQ,EAAE,EAAY;;YAAZ,KAAA,qBAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QACpF,QAAQ,CAAC,OAAO,CAAC,kBAAW,GAAG,CAAE,EAAE,MAAA,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,OAAO,CAAC,iBAAiB,mCAAI,OAAO,CAAC,CAAC;QAClF,IAAI,KAAK,EAAE;YACT,OAAO,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACjC;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC,EAAE,IAAI,yBAAQ,EAAE,CAAC,CAAC;IAEnB,OAAO,IAAA,oCAAmB,EAAC,aAAa,CAAC,CAAC;AAC5C,CAAC,CAAC;AAhBW,QAAA,mBAAmB,uBAgB9B;AAEK,IAAM,2BAA2B,GAAG,UAAC,YAAgC;IAC1E,IAAI,MAAM,GAAG,YAAY,CAAC;IAC1B,IAAI,MAAM,EAAE;QACV,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC1B,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC9B;QACD,OAAO,CAAC,IAAI,MAAM,CAAC,UAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,MAAG,CAAC,CAAC,CAAC;KACvD;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AATW,QAAA,2BAA2B,+BAStC;AAEF;IAWE,wBAAY,OAAgB,EAAE,MAAqB;;QALnD,2BAAsB,GAAG,KAAK,CAAC;QAM7B,IAAI,CAAC,OAAO,sBACV,iBAAiB,EAAE,OAAO,EAC1B,yBAAyB,EAAE,KAAK,EAChC,gBAAgB,EAAE,IAAA,mCAA2B,EAAC,MAAA,MAAM,CAAC,aAAa,0CAAE,MAAM,CAAC,IACxE,OAAO,CACX,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,aAA6C,CAAC;QACpE,IAAI,CAAC,UAAU,GAAG,IAAA,8BAAa,EAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvD,IAAI,CAAC,eAAe,GAAG,8BAAa,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC;QACpC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACpE,CAAC;IAEK,6BAAI,GAAV;;;;;;4BACkD,qBAAM,IAAI,CAAC,aAAa,EAAE,EAAA;;wBAA1E,KAAA,8BAAgD,SAA0B,KAAA,EAAzE,IAAI,CAAC,eAAe,QAAA,EAAE,IAAI,CAAC,gBAAgB,QAAA,CAA+B;wBACrE,mBAAmB,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,oBAAY,EAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;6BAE3G,IAAA,qBAAa,EAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAA1G,wBAA0G;wBAC5G,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;wBACnC,qBAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,CAAC,EAAA;;wBAA7D,SAA6D,CAAC;;;;;;KAEjE;IAEK,sCAAa,GAAnB;;;;4BACS,qBAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,+BAAc,EAAE,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAA;4BAA3F,sBAAO,SAAoF,EAAC;;;;KAC7F;IAED;;;;OAIG;IACH,8CAAqB,GAArB,UAAsB,QAAiB;QACrC,sCAAsC;QACtC,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;QACpC,IAAM,aAAa,GAAG,IAAA,2BAAmB,EAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9E,IAAI,QAAQ,EAAE;YACZ,aAAa,CAAC,QAAQ,GAAG,QAAQ,CAAC;SACnC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wDAA+B,GAA/B;QACE,OAAO,IAAI,CAAC,sBAAsB,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC;IACjF,CAAC;IACH,qBAAC;AAAD,CAAC,AA3DD,IA2DC;AA3DY,wCAAc;AA6DpB,IAAM,YAAY,GAAG,UAAC,cAAsB,EAAE,aAAkC;IAAlC,8BAAA,EAAA,gBAAwB,IAAI,CAAC,GAAG,EAAE;IACrF,IAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC/B,IAAM,kBAAkB,GAAG,WAAW,GAAG,aAAa,CAAC;IAEvD,OAAO,kBAAkB,GAAG,cAAc,CAAC;AAC7C,CAAC,CAAC;AALW,QAAA,YAAY,gBAKvB","sourcesContent":["import {\n createIdentifyEvent,\n Identify,\n BrowserConfig,\n Storage,\n CampaignParser,\n getStorageKey,\n BASE_CAMPAIGN,\n} from '@amplitude/analytics-core';\nimport type { Campaign, ILogger } from '@amplitude/analytics-core';\n\nexport interface Options {\n excludeReferrers?: (string | RegExp)[];\n initialEmptyValue?: string;\n resetSessionOnNewCampaign?: boolean;\n}\n\nconst domainWithoutSubdomain = (domain: string) => {\n const parts = domain.split('.');\n\n if (parts.length <= 2) {\n return domain;\n }\n\n return parts.slice(parts.length - 2, parts.length).join('.');\n};\n\n//Direct traffic mean no external referral, no UTMs, no click-ids, and no other customer identified marketing campaign url params.\nconst isDirectTraffic = (current: Campaign) => {\n return Object.values(current).every((value) => !value);\n};\n\nexport const isNewCampaign = (\n current: Campaign,\n previous: Campaign | undefined,\n options: Options,\n logger: ILogger,\n isNewSession = true,\n) => {\n const { referrer, referring_domain, ...currentCampaign } = current;\n const { referrer: _previous_referrer, referring_domain: prevReferringDomain, ...previousCampaign } = previous || {};\n\n if (isExcludedReferrer(options.excludeReferrers, current.referring_domain)) {\n // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n logger.debug(`This is not a new campaign because ${current.referring_domain} is in the exclude referrer list.`);\n return false;\n }\n\n //In the same session, direct traffic should not override or unset any persisting query params\n if (!isNewSession && isDirectTraffic(current) && previous) {\n logger.debug('This is not a new campaign because this is a direct traffic in the same session.');\n return false;\n }\n\n const hasNewCampaign = JSON.stringify(currentCampaign) !== JSON.stringify(previousCampaign);\n const hasNewDomain =\n domainWithoutSubdomain(referring_domain || '') !== domainWithoutSubdomain(prevReferringDomain || '');\n\n const result = !previous || hasNewCampaign || hasNewDomain;\n\n if (!result) {\n logger.debug(\"This is not a new campaign because it's the same as the previous one.\");\n } else {\n logger.debug(`This is a new campaign. An $identify event will be sent.`);\n }\n\n return result;\n};\n\nexport const isExcludedReferrer = (excludeReferrers: (string | RegExp)[] = [], referringDomain = '') => {\n return excludeReferrers.some((value) =>\n value instanceof RegExp ? value.test(referringDomain) : value === referringDomain,\n );\n};\n\nexport const createCampaignEvent = (campaign: Campaign, options: Options) => {\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 ?? options.initialEmptyValue ?? 'EMPTY');\n if (value) {\n return identify.set(key, value);\n }\n return identify.unset(key);\n }, new Identify());\n\n return createIdentifyEvent(identifyEvent);\n};\n\nexport const getDefaultExcludedReferrers = (cookieDomain: string | undefined) => {\n let domain = cookieDomain;\n if (domain) {\n if (domain.startsWith('.')) {\n domain = domain.substring(1);\n }\n return [new RegExp(`${domain.replace('.', '\\\\.')}$`)];\n }\n return [];\n};\n\nexport class WebAttribution {\n options: Options;\n storage: Storage<Campaign>;\n storageKey: string;\n previousCampaign?: Campaign;\n currentCampaign: Campaign;\n shouldTrackNewCampaign = false;\n sessionTimeout: number;\n lastEventTime?: number;\n logger: ILogger;\n\n constructor(options: Options, config: BrowserConfig) {\n this.options = {\n initialEmptyValue: 'EMPTY',\n resetSessionOnNewCampaign: false,\n excludeReferrers: getDefaultExcludedReferrers(config.cookieOptions?.domain),\n ...options,\n };\n this.storage = config.cookieStorage as unknown as Storage<Campaign>;\n this.storageKey = getStorageKey(config.apiKey, 'MKTG');\n this.currentCampaign = BASE_CAMPAIGN;\n this.sessionTimeout = config.sessionTimeout;\n this.lastEventTime = config.lastEventTime;\n this.logger = config.loggerProvider;\n config.loggerProvider.log('Installing web attribution tracking.');\n }\n\n async init() {\n [this.currentCampaign, this.previousCampaign] = await this.fetchCampaign();\n const isEventInNewSession = !this.lastEventTime ? true : isNewSession(this.sessionTimeout, this.lastEventTime);\n\n if (isNewCampaign(this.currentCampaign, this.previousCampaign, this.options, this.logger, isEventInNewSession)) {\n this.shouldTrackNewCampaign = true;\n await this.storage.set(this.storageKey, this.currentCampaign);\n }\n }\n\n async fetchCampaign() {\n return await Promise.all([new CampaignParser().parse(), this.storage.get(this.storageKey)]);\n }\n\n /**\n * This can be called when enable web attribution and either\n * 1. set a new session\n * 2. has new campaign and enable resetSessionOnNewCampaign\n */\n generateCampaignEvent(event_id?: number) {\n // Mark this campaign has been tracked\n this.shouldTrackNewCampaign = false;\n const campaignEvent = createCampaignEvent(this.currentCampaign, this.options);\n if (event_id) {\n campaignEvent.event_id = event_id;\n }\n return campaignEvent;\n }\n\n shouldSetSessionIdOnNewCampaign() {\n return this.shouldTrackNewCampaign && !!this.options.resetSessionOnNewCampaign;\n }\n}\n\nexport const isNewSession = (sessionTimeout: number, lastEventTime: number = Date.now()): boolean => {\n const currentTime = Date.now();\n const timeSinceLastEvent = currentTime - lastEventTime;\n\n return timeSinceLastEvent > sessionTimeout;\n};\n"]}
@@ -2,7 +2,7 @@ import { CreateWebAttributionPlugin } from './typings/web-attribution';
2
2
  /**
3
3
  * @deprecated
4
4
  * This plugin is not used by @amplitude/analytics-browser and
5
- * is replaced by WebAttribution in @amplitude/analytics-client-common to
5
+ * is replaced by WebAttribution in @amplitude/analytics-browser to
6
6
  * be able to send identify events before session start.
7
7
  */
8
8
  export declare const webAttributionPlugin: CreateWebAttributionPlugin;
@@ -2,12 +2,12 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.webAttributionPlugin = void 0;
4
4
  var tslib_1 = require("tslib");
5
- var analytics_client_common_1 = require("@amplitude/analytics-client-common");
5
+ var helpers_1 = require("./helpers");
6
6
  /* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment */
7
7
  /**
8
8
  * @deprecated
9
9
  * This plugin is not used by @amplitude/analytics-browser and
10
- * is replaced by WebAttribution in @amplitude/analytics-client-common to
10
+ * is replaced by WebAttribution in @amplitude/analytics-browser to
11
11
  * be able to send identify events before session start.
12
12
  */
13
13
  var webAttributionPlugin = function (options) {
@@ -22,15 +22,15 @@ var webAttributionPlugin = function (options) {
22
22
  return tslib_1.__generator(this, function (_a) {
23
23
  switch (_a.label) {
24
24
  case 0:
25
- webAttribution = new analytics_client_common_1.WebAttribution(options, config);
25
+ webAttribution = new helpers_1.WebAttribution(options, config);
26
26
  return [4 /*yield*/, webAttribution.init()];
27
27
  case 1:
28
28
  _a.sent();
29
29
  pluginConfig = webAttribution.options;
30
30
  currentCampaign = webAttribution.currentCampaign;
31
31
  previousCampaign = webAttribution.previousCampaign;
32
- isEventInNewSession = (0, analytics_client_common_1.isNewSession)(config.sessionTimeout, config.lastEventTime);
33
- if ((0, analytics_client_common_1.isNewCampaign)(currentCampaign, previousCampaign, pluginConfig, config.loggerProvider, isEventInNewSession)) {
32
+ isEventInNewSession = (0, helpers_1.isNewSession)(config.sessionTimeout, config.lastEventTime);
33
+ if ((0, helpers_1.isNewCampaign)(currentCampaign, previousCampaign, pluginConfig, config.loggerProvider, isEventInNewSession)) {
34
34
  if (pluginConfig.resetSessionOnNewCampaign) {
35
35
  amplitude.setSessionId(Date.now());
36
36
  config.loggerProvider.log('Created a new session for new campaign.');
@@ -1 +1 @@
1
- {"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":";;;;AAAA,8EAAiG;AAIjG,mGAAmG;AAEnG;;;;;GAKG;AACI,IAAM,oBAAoB,GAA+B,UAAU,OAAqB;IAA/B,iBA8B/D;IA9ByE,wBAAA,EAAA,YAAqB;IAC7F,IAAM,MAAM,GAAiB;QAC3B,IAAI,EAAE,2CAA2C;QACjD,IAAI,EAAE,QAAQ;QAEd,KAAK,EAAE,UAAgB,MAAqB,EAAE,SAAwB;;;;;;4BAC9D,cAAc,GAAG,IAAI,wCAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;4BAC3D,qBAAM,cAAc,CAAC,IAAI,EAAE,EAAA;;4BAA3B,SAA2B,CAAC;4BAEtB,YAAY,GAAG,cAAc,CAAC,OAAO,CAAC;4BACtC,eAAe,GAAG,cAAc,CAAC,eAAe,CAAC;4BACjD,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAC;4BAEnD,mBAAmB,GAAG,IAAA,sCAAY,EAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;4BAEtF,IAAI,IAAA,uCAAa,EAAC,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,EAAE;gCAC9G,IAAI,YAAY,CAAC,yBAAyB,EAAE;oCAC1C,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oCACnC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;iCACtE;gCACD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;gCAC7C,aAAa,GAAG,cAAc,CAAC,qBAAqB,EAAE,CAAC;gCAC7D,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;6BAChC;;;;;SACF;QAED,OAAO,EAAE,UAAO,KAAY;YAAK,sBAAA,KAAK,EAAA;iBAAA;KACvC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA9BW,QAAA,oBAAoB,wBA8B/B","sourcesContent":["import { WebAttribution, isNewCampaign, isNewSession } from '@amplitude/analytics-client-common';\nimport { BeforePlugin, BrowserClient, BrowserConfig, Event } from '@amplitude/analytics-types';\nimport { CreateWebAttributionPlugin, Options } from './typings/web-attribution';\n\n/* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment */\n\n/**\n * @deprecated\n * This plugin is not used by @amplitude/analytics-browser and\n * is replaced by WebAttribution in @amplitude/analytics-client-common to\n * be able to send identify events before session start.\n */\nexport const webAttributionPlugin: CreateWebAttributionPlugin = function (options: Options = {}) {\n const plugin: BeforePlugin = {\n name: '@amplitude/plugin-web-attribution-browser',\n type: 'before',\n\n setup: async function (config: BrowserConfig, amplitude: BrowserClient) {\n const webAttribution = new WebAttribution(options, config);\n await webAttribution.init();\n\n const pluginConfig = webAttribution.options;\n const currentCampaign = webAttribution.currentCampaign;\n const previousCampaign = webAttribution.previousCampaign;\n\n const isEventInNewSession = isNewSession(config.sessionTimeout, config.lastEventTime);\n\n if (isNewCampaign(currentCampaign, previousCampaign, pluginConfig, config.loggerProvider, isEventInNewSession)) {\n if (pluginConfig.resetSessionOnNewCampaign) {\n amplitude.setSessionId(Date.now());\n config.loggerProvider.log('Created a new session for new campaign.');\n }\n config.loggerProvider.log('Tracking attribution.');\n const campaignEvent = webAttribution.generateCampaignEvent();\n amplitude.track(campaignEvent);\n }\n },\n\n execute: async (event: Event) => event,\n };\n\n return plugin;\n};\n"]}
1
+ {"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":";;;;AAAA,qCAAwE;AAIxE,mGAAmG;AAEnG;;;;;GAKG;AACI,IAAM,oBAAoB,GAA+B,UAAU,OAAqB;IAA/B,iBA8B/D;IA9ByE,wBAAA,EAAA,YAAqB;IAC7F,IAAM,MAAM,GAAiB;QAC3B,IAAI,EAAE,2CAA2C;QACjD,IAAI,EAAE,QAAQ;QAEd,KAAK,EAAE,UAAgB,MAAqB,EAAE,SAAwB;;;;;;4BAC9D,cAAc,GAAG,IAAI,wBAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;4BAC3D,qBAAM,cAAc,CAAC,IAAI,EAAE,EAAA;;4BAA3B,SAA2B,CAAC;4BAEtB,YAAY,GAAG,cAAc,CAAC,OAAO,CAAC;4BACtC,eAAe,GAAG,cAAc,CAAC,eAAe,CAAC;4BACjD,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAC;4BAEnD,mBAAmB,GAAG,IAAA,sBAAY,EAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;4BAEtF,IAAI,IAAA,uBAAa,EAAC,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,EAAE;gCAC9G,IAAI,YAAY,CAAC,yBAAyB,EAAE;oCAC1C,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oCACnC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;iCACtE;gCACD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;gCAC7C,aAAa,GAAG,cAAc,CAAC,qBAAqB,EAAE,CAAC;gCAC7D,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;6BAChC;;;;;SACF;QAED,OAAO,EAAE,UAAO,KAAY;YAAK,sBAAA,KAAK,EAAA;iBAAA;KACvC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA9BW,QAAA,oBAAoB,wBA8B/B","sourcesContent":["import { WebAttribution, isNewCampaign, isNewSession } from './helpers';\nimport { BeforePlugin, BrowserClient, BrowserConfig, Event } from '@amplitude/analytics-types';\nimport { CreateWebAttributionPlugin, Options } from './typings/web-attribution';\n\n/* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment */\n\n/**\n * @deprecated\n * This plugin is not used by @amplitude/analytics-browser and\n * is replaced by WebAttribution in @amplitude/analytics-browser to\n * be able to send identify events before session start.\n */\nexport const webAttributionPlugin: CreateWebAttributionPlugin = function (options: Options = {}) {\n const plugin: BeforePlugin = {\n name: '@amplitude/plugin-web-attribution-browser',\n type: 'before',\n\n setup: async function (config: BrowserConfig, amplitude: BrowserClient) {\n const webAttribution = new WebAttribution(options, config);\n await webAttribution.init();\n\n const pluginConfig = webAttribution.options;\n const currentCampaign = webAttribution.currentCampaign;\n const previousCampaign = webAttribution.previousCampaign;\n\n const isEventInNewSession = isNewSession(config.sessionTimeout, config.lastEventTime);\n\n if (isNewCampaign(currentCampaign, previousCampaign, pluginConfig, config.loggerProvider, isEventInNewSession)) {\n if (pluginConfig.resetSessionOnNewCampaign) {\n amplitude.setSessionId(Date.now());\n config.loggerProvider.log('Created a new session for new campaign.');\n }\n config.loggerProvider.log('Tracking attribution.');\n const campaignEvent = webAttribution.generateCampaignEvent();\n amplitude.track(campaignEvent);\n }\n },\n\n execute: async (event: Event) => event,\n };\n\n return plugin;\n};\n"]}
@@ -0,0 +1,34 @@
1
+ import { BrowserConfig, Storage } from '@amplitude/analytics-core';
2
+ import type { Campaign, ILogger } from '@amplitude/analytics-core';
3
+ export interface Options {
4
+ excludeReferrers?: (string | RegExp)[];
5
+ initialEmptyValue?: string;
6
+ resetSessionOnNewCampaign?: boolean;
7
+ }
8
+ export declare const isNewCampaign: (current: Campaign, previous: Campaign | undefined, options: Options, logger: ILogger, isNewSession?: boolean) => boolean;
9
+ export declare const isExcludedReferrer: (excludeReferrers?: (string | RegExp)[], referringDomain?: string) => boolean;
10
+ export declare const createCampaignEvent: (campaign: Campaign, options: Options) => import("@amplitude/analytics-core").IdentifyEvent;
11
+ export declare const getDefaultExcludedReferrers: (cookieDomain: string | undefined) => RegExp[];
12
+ export declare class WebAttribution {
13
+ options: Options;
14
+ storage: Storage<Campaign>;
15
+ storageKey: string;
16
+ previousCampaign?: Campaign;
17
+ currentCampaign: Campaign;
18
+ shouldTrackNewCampaign: boolean;
19
+ sessionTimeout: number;
20
+ lastEventTime?: number;
21
+ logger: ILogger;
22
+ constructor(options: Options, config: BrowserConfig);
23
+ init(): Promise<void>;
24
+ fetchCampaign(): Promise<[Campaign, Campaign | undefined]>;
25
+ /**
26
+ * This can be called when enable web attribution and either
27
+ * 1. set a new session
28
+ * 2. has new campaign and enable resetSessionOnNewCampaign
29
+ */
30
+ generateCampaignEvent(event_id?: number): import("@amplitude/analytics-core").IdentifyEvent;
31
+ shouldSetSessionIdOnNewCampaign(): boolean;
32
+ }
33
+ export declare const isNewSession: (sessionTimeout: number, lastEventTime?: number) => boolean;
34
+ //# sourceMappingURL=helpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EACb,OAAO,EAIR,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEnE,MAAM,WAAW,OAAO;IACtB,gBAAgB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAiBD,eAAO,MAAM,aAAa,YACf,QAAQ,YACP,QAAQ,GAAG,SAAS,WACrB,OAAO,UACR,OAAO,oCA+BhB,CAAC;AAEF,eAAO,MAAM,kBAAkB,sBAAsB,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,sCAIvE,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAc,QAAQ,WAAW,OAAO,sDAgBvE,CAAC;AAEF,eAAO,MAAM,2BAA2B,iBAAkB,MAAM,GAAG,SAAS,aAS3E,CAAC;AAEF,qBAAa,cAAc;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,eAAe,EAAE,QAAQ,CAAC;IAC1B,sBAAsB,UAAS;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;gBAEJ,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa;IAgB7C,IAAI;IAUJ,aAAa;IAInB;;;;OAIG;IACH,qBAAqB,CAAC,QAAQ,CAAC,EAAE,MAAM;IAUvC,+BAA+B;CAGhC;AAED,eAAO,MAAM,YAAY,mBAAoB,MAAM,kBAAiB,MAAM,KAAgB,OAKzF,CAAC"}
@@ -0,0 +1,139 @@
1
+ import { __assign, __awaiter, __generator, __read, __rest } from "tslib";
2
+ import { createIdentifyEvent, Identify, CampaignParser, getStorageKey, BASE_CAMPAIGN, } from '@amplitude/analytics-core';
3
+ var domainWithoutSubdomain = function (domain) {
4
+ var parts = domain.split('.');
5
+ if (parts.length <= 2) {
6
+ return domain;
7
+ }
8
+ return parts.slice(parts.length - 2, parts.length).join('.');
9
+ };
10
+ //Direct traffic mean no external referral, no UTMs, no click-ids, and no other customer identified marketing campaign url params.
11
+ var isDirectTraffic = function (current) {
12
+ return Object.values(current).every(function (value) { return !value; });
13
+ };
14
+ export var isNewCampaign = function (current, previous, options, logger, isNewSession) {
15
+ if (isNewSession === void 0) { isNewSession = true; }
16
+ var referrer = current.referrer, referring_domain = current.referring_domain, currentCampaign = __rest(current, ["referrer", "referring_domain"]);
17
+ var _a = previous || {}, _previous_referrer = _a.referrer, prevReferringDomain = _a.referring_domain, previousCampaign = __rest(_a, ["referrer", "referring_domain"]);
18
+ if (isExcludedReferrer(options.excludeReferrers, current.referring_domain)) {
19
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
20
+ logger.debug("This is not a new campaign because ".concat(current.referring_domain, " is in the exclude referrer list."));
21
+ return false;
22
+ }
23
+ //In the same session, direct traffic should not override or unset any persisting query params
24
+ if (!isNewSession && isDirectTraffic(current) && previous) {
25
+ logger.debug('This is not a new campaign because this is a direct traffic in the same session.');
26
+ return false;
27
+ }
28
+ var hasNewCampaign = JSON.stringify(currentCampaign) !== JSON.stringify(previousCampaign);
29
+ var hasNewDomain = domainWithoutSubdomain(referring_domain || '') !== domainWithoutSubdomain(prevReferringDomain || '');
30
+ var result = !previous || hasNewCampaign || hasNewDomain;
31
+ if (!result) {
32
+ logger.debug("This is not a new campaign because it's the same as the previous one.");
33
+ }
34
+ else {
35
+ logger.debug("This is a new campaign. An $identify event will be sent.");
36
+ }
37
+ return result;
38
+ };
39
+ export var isExcludedReferrer = function (excludeReferrers, referringDomain) {
40
+ if (excludeReferrers === void 0) { excludeReferrers = []; }
41
+ if (referringDomain === void 0) { referringDomain = ''; }
42
+ return excludeReferrers.some(function (value) {
43
+ return value instanceof RegExp ? value.test(referringDomain) : value === referringDomain;
44
+ });
45
+ };
46
+ export var createCampaignEvent = function (campaign, options) {
47
+ var campaignParameters = __assign(__assign({}, BASE_CAMPAIGN), campaign);
48
+ var identifyEvent = Object.entries(campaignParameters).reduce(function (identify, _a) {
49
+ var _b;
50
+ var _c = __read(_a, 2), key = _c[0], value = _c[1];
51
+ identify.setOnce("initial_".concat(key), (_b = value !== null && value !== void 0 ? value : options.initialEmptyValue) !== null && _b !== void 0 ? _b : 'EMPTY');
52
+ if (value) {
53
+ return identify.set(key, value);
54
+ }
55
+ return identify.unset(key);
56
+ }, new Identify());
57
+ return createIdentifyEvent(identifyEvent);
58
+ };
59
+ export var getDefaultExcludedReferrers = function (cookieDomain) {
60
+ var domain = cookieDomain;
61
+ if (domain) {
62
+ if (domain.startsWith('.')) {
63
+ domain = domain.substring(1);
64
+ }
65
+ return [new RegExp("".concat(domain.replace('.', '\\.'), "$"))];
66
+ }
67
+ return [];
68
+ };
69
+ var WebAttribution = /** @class */ (function () {
70
+ function WebAttribution(options, config) {
71
+ var _a;
72
+ this.shouldTrackNewCampaign = false;
73
+ this.options = __assign({ initialEmptyValue: 'EMPTY', resetSessionOnNewCampaign: false, excludeReferrers: getDefaultExcludedReferrers((_a = config.cookieOptions) === null || _a === void 0 ? void 0 : _a.domain) }, options);
74
+ this.storage = config.cookieStorage;
75
+ this.storageKey = getStorageKey(config.apiKey, 'MKTG');
76
+ this.currentCampaign = BASE_CAMPAIGN;
77
+ this.sessionTimeout = config.sessionTimeout;
78
+ this.lastEventTime = config.lastEventTime;
79
+ this.logger = config.loggerProvider;
80
+ config.loggerProvider.log('Installing web attribution tracking.');
81
+ }
82
+ WebAttribution.prototype.init = function () {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var isEventInNewSession;
85
+ var _a;
86
+ return __generator(this, function (_b) {
87
+ switch (_b.label) {
88
+ case 0: return [4 /*yield*/, this.fetchCampaign()];
89
+ case 1:
90
+ _a = __read.apply(void 0, [_b.sent(), 2]), this.currentCampaign = _a[0], this.previousCampaign = _a[1];
91
+ isEventInNewSession = !this.lastEventTime ? true : isNewSession(this.sessionTimeout, this.lastEventTime);
92
+ if (!isNewCampaign(this.currentCampaign, this.previousCampaign, this.options, this.logger, isEventInNewSession)) return [3 /*break*/, 3];
93
+ this.shouldTrackNewCampaign = true;
94
+ return [4 /*yield*/, this.storage.set(this.storageKey, this.currentCampaign)];
95
+ case 2:
96
+ _b.sent();
97
+ _b.label = 3;
98
+ case 3: return [2 /*return*/];
99
+ }
100
+ });
101
+ });
102
+ };
103
+ WebAttribution.prototype.fetchCampaign = function () {
104
+ return __awaiter(this, void 0, void 0, function () {
105
+ return __generator(this, function (_a) {
106
+ switch (_a.label) {
107
+ case 0: return [4 /*yield*/, Promise.all([new CampaignParser().parse(), this.storage.get(this.storageKey)])];
108
+ case 1: return [2 /*return*/, _a.sent()];
109
+ }
110
+ });
111
+ });
112
+ };
113
+ /**
114
+ * This can be called when enable web attribution and either
115
+ * 1. set a new session
116
+ * 2. has new campaign and enable resetSessionOnNewCampaign
117
+ */
118
+ WebAttribution.prototype.generateCampaignEvent = function (event_id) {
119
+ // Mark this campaign has been tracked
120
+ this.shouldTrackNewCampaign = false;
121
+ var campaignEvent = createCampaignEvent(this.currentCampaign, this.options);
122
+ if (event_id) {
123
+ campaignEvent.event_id = event_id;
124
+ }
125
+ return campaignEvent;
126
+ };
127
+ WebAttribution.prototype.shouldSetSessionIdOnNewCampaign = function () {
128
+ return this.shouldTrackNewCampaign && !!this.options.resetSessionOnNewCampaign;
129
+ };
130
+ return WebAttribution;
131
+ }());
132
+ export { WebAttribution };
133
+ export var isNewSession = function (sessionTimeout, lastEventTime) {
134
+ if (lastEventTime === void 0) { lastEventTime = Date.now(); }
135
+ var currentTime = Date.now();
136
+ var timeSinceLastEvent = currentTime - lastEventTime;
137
+ return timeSinceLastEvent > sessionTimeout;
138
+ };
139
+ //# sourceMappingURL=helpers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,mBAAmB,EACnB,QAAQ,EAGR,cAAc,EACd,aAAa,EACb,aAAa,GACd,MAAM,2BAA2B,CAAC;AASnC,IAAM,sBAAsB,GAAG,UAAC,MAAc;IAC5C,IAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEhC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE;QACrB,OAAO,MAAM,CAAC;KACf;IAED,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,kIAAkI;AAClI,IAAM,eAAe,GAAG,UAAC,OAAiB;IACxC,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK,IAAK,OAAA,CAAC,KAAK,EAAN,CAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,aAAa,GAAG,UAC3B,OAAiB,EACjB,QAA8B,EAC9B,OAAgB,EAChB,MAAe,EACf,YAAmB;IAAnB,6BAAA,EAAA,mBAAmB;IAEX,IAAA,QAAQ,GAA2C,OAAO,SAAlD,EAAE,gBAAgB,GAAyB,OAAO,iBAAhC,EAAK,eAAe,UAAK,OAAO,EAA5D,gCAAkD,CAAF,CAAa;IACnE,IAAM,KAA+F,QAAQ,IAAI,EAAE,EAAjG,kBAAkB,cAAA,EAAoB,mBAAmB,sBAAA,EAAK,gBAAgB,cAA1F,gCAA4F,CAAiB,CAAC;IAEpH,IAAI,kBAAkB,CAAC,OAAO,CAAC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE;QAC1E,4EAA4E;QAC5E,MAAM,CAAC,KAAK,CAAC,6CAAsC,OAAO,CAAC,gBAAgB,sCAAmC,CAAC,CAAC;QAChH,OAAO,KAAK,CAAC;KACd;IAED,8FAA8F;IAC9F,IAAI,CAAC,YAAY,IAAI,eAAe,CAAC,OAAO,CAAC,IAAI,QAAQ,EAAE;QACzD,MAAM,CAAC,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACjG,OAAO,KAAK,CAAC;KACd;IAED,IAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5F,IAAM,YAAY,GAChB,sBAAsB,CAAC,gBAAgB,IAAI,EAAE,CAAC,KAAK,sBAAsB,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC;IAEvG,IAAM,MAAM,GAAG,CAAC,QAAQ,IAAI,cAAc,IAAI,YAAY,CAAC;IAE3D,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,CAAC,KAAK,CAAC,uEAAuE,CAAC,CAAC;KACvF;SAAM;QACL,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC1E;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAC,gBAA0C,EAAE,eAAoB;IAAhE,iCAAA,EAAA,qBAA0C;IAAE,gCAAA,EAAA,oBAAoB;IACjG,OAAO,gBAAgB,CAAC,IAAI,CAAC,UAAC,KAAK;QACjC,OAAA,KAAK,YAAY,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,eAAe;IAAjF,CAAiF,CAClF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,mBAAmB,GAAG,UAAC,QAAkB,EAAE,OAAgB;IACtE,IAAM,kBAAkB,yBAGnB,aAAa,GACb,QAAQ,CACZ,CAAC;IACF,IAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,UAAC,QAAQ,EAAE,EAAY;;YAAZ,KAAA,aAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QACpF,QAAQ,CAAC,OAAO,CAAC,kBAAW,GAAG,CAAE,EAAE,MAAA,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,OAAO,CAAC,iBAAiB,mCAAI,OAAO,CAAC,CAAC;QAClF,IAAI,KAAK,EAAE;YACT,OAAO,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACjC;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC;IAEnB,OAAO,mBAAmB,CAAC,aAAa,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,2BAA2B,GAAG,UAAC,YAAgC;IAC1E,IAAI,MAAM,GAAG,YAAY,CAAC;IAC1B,IAAI,MAAM,EAAE;QACV,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC1B,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC9B;QACD,OAAO,CAAC,IAAI,MAAM,CAAC,UAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,MAAG,CAAC,CAAC,CAAC;KACvD;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;IAWE,wBAAY,OAAgB,EAAE,MAAqB;;QALnD,2BAAsB,GAAG,KAAK,CAAC;QAM7B,IAAI,CAAC,OAAO,cACV,iBAAiB,EAAE,OAAO,EAC1B,yBAAyB,EAAE,KAAK,EAChC,gBAAgB,EAAE,2BAA2B,CAAC,MAAA,MAAM,CAAC,aAAa,0CAAE,MAAM,CAAC,IACxE,OAAO,CACX,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,aAA6C,CAAC;QACpE,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvD,IAAI,CAAC,eAAe,GAAG,aAAa,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC;QACpC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACpE,CAAC;IAEK,6BAAI,GAAV;;;;;;4BACkD,qBAAM,IAAI,CAAC,aAAa,EAAE,EAAA;;wBAA1E,KAAA,sBAAgD,SAA0B,KAAA,EAAzE,IAAI,CAAC,eAAe,QAAA,EAAE,IAAI,CAAC,gBAAgB,QAAA,CAA+B;wBACrE,mBAAmB,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;6BAE3G,aAAa,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAA1G,wBAA0G;wBAC5G,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;wBACnC,qBAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,CAAC,EAAA;;wBAA7D,SAA6D,CAAC;;;;;;KAEjE;IAEK,sCAAa,GAAnB;;;;4BACS,qBAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAA;4BAA3F,sBAAO,SAAoF,EAAC;;;;KAC7F;IAED;;;;OAIG;IACH,8CAAqB,GAArB,UAAsB,QAAiB;QACrC,sCAAsC;QACtC,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;QACpC,IAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9E,IAAI,QAAQ,EAAE;YACZ,aAAa,CAAC,QAAQ,GAAG,QAAQ,CAAC;SACnC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wDAA+B,GAA/B;QACE,OAAO,IAAI,CAAC,sBAAsB,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC;IACjF,CAAC;IACH,qBAAC;AAAD,CAAC,AA3DD,IA2DC;;AAED,MAAM,CAAC,IAAM,YAAY,GAAG,UAAC,cAAsB,EAAE,aAAkC;IAAlC,8BAAA,EAAA,gBAAwB,IAAI,CAAC,GAAG,EAAE;IACrF,IAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC/B,IAAM,kBAAkB,GAAG,WAAW,GAAG,aAAa,CAAC;IAEvD,OAAO,kBAAkB,GAAG,cAAc,CAAC;AAC7C,CAAC,CAAC","sourcesContent":["import {\n createIdentifyEvent,\n Identify,\n BrowserConfig,\n Storage,\n CampaignParser,\n getStorageKey,\n BASE_CAMPAIGN,\n} from '@amplitude/analytics-core';\nimport type { Campaign, ILogger } from '@amplitude/analytics-core';\n\nexport interface Options {\n excludeReferrers?: (string | RegExp)[];\n initialEmptyValue?: string;\n resetSessionOnNewCampaign?: boolean;\n}\n\nconst domainWithoutSubdomain = (domain: string) => {\n const parts = domain.split('.');\n\n if (parts.length <= 2) {\n return domain;\n }\n\n return parts.slice(parts.length - 2, parts.length).join('.');\n};\n\n//Direct traffic mean no external referral, no UTMs, no click-ids, and no other customer identified marketing campaign url params.\nconst isDirectTraffic = (current: Campaign) => {\n return Object.values(current).every((value) => !value);\n};\n\nexport const isNewCampaign = (\n current: Campaign,\n previous: Campaign | undefined,\n options: Options,\n logger: ILogger,\n isNewSession = true,\n) => {\n const { referrer, referring_domain, ...currentCampaign } = current;\n const { referrer: _previous_referrer, referring_domain: prevReferringDomain, ...previousCampaign } = previous || {};\n\n if (isExcludedReferrer(options.excludeReferrers, current.referring_domain)) {\n // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n logger.debug(`This is not a new campaign because ${current.referring_domain} is in the exclude referrer list.`);\n return false;\n }\n\n //In the same session, direct traffic should not override or unset any persisting query params\n if (!isNewSession && isDirectTraffic(current) && previous) {\n logger.debug('This is not a new campaign because this is a direct traffic in the same session.');\n return false;\n }\n\n const hasNewCampaign = JSON.stringify(currentCampaign) !== JSON.stringify(previousCampaign);\n const hasNewDomain =\n domainWithoutSubdomain(referring_domain || '') !== domainWithoutSubdomain(prevReferringDomain || '');\n\n const result = !previous || hasNewCampaign || hasNewDomain;\n\n if (!result) {\n logger.debug(\"This is not a new campaign because it's the same as the previous one.\");\n } else {\n logger.debug(`This is a new campaign. An $identify event will be sent.`);\n }\n\n return result;\n};\n\nexport const isExcludedReferrer = (excludeReferrers: (string | RegExp)[] = [], referringDomain = '') => {\n return excludeReferrers.some((value) =>\n value instanceof RegExp ? value.test(referringDomain) : value === referringDomain,\n );\n};\n\nexport const createCampaignEvent = (campaign: Campaign, options: Options) => {\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 ?? options.initialEmptyValue ?? 'EMPTY');\n if (value) {\n return identify.set(key, value);\n }\n return identify.unset(key);\n }, new Identify());\n\n return createIdentifyEvent(identifyEvent);\n};\n\nexport const getDefaultExcludedReferrers = (cookieDomain: string | undefined) => {\n let domain = cookieDomain;\n if (domain) {\n if (domain.startsWith('.')) {\n domain = domain.substring(1);\n }\n return [new RegExp(`${domain.replace('.', '\\\\.')}$`)];\n }\n return [];\n};\n\nexport class WebAttribution {\n options: Options;\n storage: Storage<Campaign>;\n storageKey: string;\n previousCampaign?: Campaign;\n currentCampaign: Campaign;\n shouldTrackNewCampaign = false;\n sessionTimeout: number;\n lastEventTime?: number;\n logger: ILogger;\n\n constructor(options: Options, config: BrowserConfig) {\n this.options = {\n initialEmptyValue: 'EMPTY',\n resetSessionOnNewCampaign: false,\n excludeReferrers: getDefaultExcludedReferrers(config.cookieOptions?.domain),\n ...options,\n };\n this.storage = config.cookieStorage as unknown as Storage<Campaign>;\n this.storageKey = getStorageKey(config.apiKey, 'MKTG');\n this.currentCampaign = BASE_CAMPAIGN;\n this.sessionTimeout = config.sessionTimeout;\n this.lastEventTime = config.lastEventTime;\n this.logger = config.loggerProvider;\n config.loggerProvider.log('Installing web attribution tracking.');\n }\n\n async init() {\n [this.currentCampaign, this.previousCampaign] = await this.fetchCampaign();\n const isEventInNewSession = !this.lastEventTime ? true : isNewSession(this.sessionTimeout, this.lastEventTime);\n\n if (isNewCampaign(this.currentCampaign, this.previousCampaign, this.options, this.logger, isEventInNewSession)) {\n this.shouldTrackNewCampaign = true;\n await this.storage.set(this.storageKey, this.currentCampaign);\n }\n }\n\n async fetchCampaign() {\n return await Promise.all([new CampaignParser().parse(), this.storage.get(this.storageKey)]);\n }\n\n /**\n * This can be called when enable web attribution and either\n * 1. set a new session\n * 2. has new campaign and enable resetSessionOnNewCampaign\n */\n generateCampaignEvent(event_id?: number) {\n // Mark this campaign has been tracked\n this.shouldTrackNewCampaign = false;\n const campaignEvent = createCampaignEvent(this.currentCampaign, this.options);\n if (event_id) {\n campaignEvent.event_id = event_id;\n }\n return campaignEvent;\n }\n\n shouldSetSessionIdOnNewCampaign() {\n return this.shouldTrackNewCampaign && !!this.options.resetSessionOnNewCampaign;\n }\n}\n\nexport const isNewSession = (sessionTimeout: number, lastEventTime: number = Date.now()): boolean => {\n const currentTime = Date.now();\n const timeSinceLastEvent = currentTime - lastEventTime;\n\n return timeSinceLastEvent > sessionTimeout;\n};\n"]}
@@ -2,7 +2,7 @@ import { CreateWebAttributionPlugin } from './typings/web-attribution';
2
2
  /**
3
3
  * @deprecated
4
4
  * This plugin is not used by @amplitude/analytics-browser and
5
- * is replaced by WebAttribution in @amplitude/analytics-client-common to
5
+ * is replaced by WebAttribution in @amplitude/analytics-browser to
6
6
  * be able to send identify events before session start.
7
7
  */
8
8
  export declare const webAttributionPlugin: CreateWebAttributionPlugin;
@@ -1,10 +1,10 @@
1
1
  import { __awaiter, __generator } from "tslib";
2
- import { WebAttribution, isNewCampaign, isNewSession } from '@amplitude/analytics-client-common';
2
+ import { WebAttribution, isNewCampaign, isNewSession } from './helpers';
3
3
  /* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment */
4
4
  /**
5
5
  * @deprecated
6
6
  * This plugin is not used by @amplitude/analytics-browser and
7
- * is replaced by WebAttribution in @amplitude/analytics-client-common to
7
+ * is replaced by WebAttribution in @amplitude/analytics-browser to
8
8
  * be able to send identify events before session start.
9
9
  */
10
10
  export var webAttributionPlugin = function (options) {
@@ -1 +1 @@
1
- {"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAIjG,mGAAmG;AAEnG;;;;;GAKG;AACH,MAAM,CAAC,IAAM,oBAAoB,GAA+B,UAAU,OAAqB;IAA/B,iBA8B/D;IA9ByE,wBAAA,EAAA,YAAqB;IAC7F,IAAM,MAAM,GAAiB;QAC3B,IAAI,EAAE,2CAA2C;QACjD,IAAI,EAAE,QAAQ;QAEd,KAAK,EAAE,UAAgB,MAAqB,EAAE,SAAwB;;;;;;4BAC9D,cAAc,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;4BAC3D,qBAAM,cAAc,CAAC,IAAI,EAAE,EAAA;;4BAA3B,SAA2B,CAAC;4BAEtB,YAAY,GAAG,cAAc,CAAC,OAAO,CAAC;4BACtC,eAAe,GAAG,cAAc,CAAC,eAAe,CAAC;4BACjD,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAC;4BAEnD,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;4BAEtF,IAAI,aAAa,CAAC,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,EAAE;gCAC9G,IAAI,YAAY,CAAC,yBAAyB,EAAE;oCAC1C,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oCACnC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;iCACtE;gCACD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;gCAC7C,aAAa,GAAG,cAAc,CAAC,qBAAqB,EAAE,CAAC;gCAC7D,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;6BAChC;;;;;SACF;QAED,OAAO,EAAE,UAAO,KAAY;YAAK,sBAAA,KAAK,EAAA;iBAAA;KACvC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import { WebAttribution, isNewCampaign, isNewSession } from '@amplitude/analytics-client-common';\nimport { BeforePlugin, BrowserClient, BrowserConfig, Event } from '@amplitude/analytics-types';\nimport { CreateWebAttributionPlugin, Options } from './typings/web-attribution';\n\n/* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment */\n\n/**\n * @deprecated\n * This plugin is not used by @amplitude/analytics-browser and\n * is replaced by WebAttribution in @amplitude/analytics-client-common to\n * be able to send identify events before session start.\n */\nexport const webAttributionPlugin: CreateWebAttributionPlugin = function (options: Options = {}) {\n const plugin: BeforePlugin = {\n name: '@amplitude/plugin-web-attribution-browser',\n type: 'before',\n\n setup: async function (config: BrowserConfig, amplitude: BrowserClient) {\n const webAttribution = new WebAttribution(options, config);\n await webAttribution.init();\n\n const pluginConfig = webAttribution.options;\n const currentCampaign = webAttribution.currentCampaign;\n const previousCampaign = webAttribution.previousCampaign;\n\n const isEventInNewSession = isNewSession(config.sessionTimeout, config.lastEventTime);\n\n if (isNewCampaign(currentCampaign, previousCampaign, pluginConfig, config.loggerProvider, isEventInNewSession)) {\n if (pluginConfig.resetSessionOnNewCampaign) {\n amplitude.setSessionId(Date.now());\n config.loggerProvider.log('Created a new session for new campaign.');\n }\n config.loggerProvider.log('Tracking attribution.');\n const campaignEvent = webAttribution.generateCampaignEvent();\n amplitude.track(campaignEvent);\n }\n },\n\n execute: async (event: Event) => event,\n };\n\n return plugin;\n};\n"]}
1
+ {"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAIxE,mGAAmG;AAEnG;;;;;GAKG;AACH,MAAM,CAAC,IAAM,oBAAoB,GAA+B,UAAU,OAAqB;IAA/B,iBA8B/D;IA9ByE,wBAAA,EAAA,YAAqB;IAC7F,IAAM,MAAM,GAAiB;QAC3B,IAAI,EAAE,2CAA2C;QACjD,IAAI,EAAE,QAAQ;QAEd,KAAK,EAAE,UAAgB,MAAqB,EAAE,SAAwB;;;;;;4BAC9D,cAAc,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;4BAC3D,qBAAM,cAAc,CAAC,IAAI,EAAE,EAAA;;4BAA3B,SAA2B,CAAC;4BAEtB,YAAY,GAAG,cAAc,CAAC,OAAO,CAAC;4BACtC,eAAe,GAAG,cAAc,CAAC,eAAe,CAAC;4BACjD,gBAAgB,GAAG,cAAc,CAAC,gBAAgB,CAAC;4BAEnD,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;4BAEtF,IAAI,aAAa,CAAC,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,EAAE;gCAC9G,IAAI,YAAY,CAAC,yBAAyB,EAAE;oCAC1C,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oCACnC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;iCACtE;gCACD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;gCAC7C,aAAa,GAAG,cAAc,CAAC,qBAAqB,EAAE,CAAC;gCAC7D,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;6BAChC;;;;;SACF;QAED,OAAO,EAAE,UAAO,KAAY;YAAK,sBAAA,KAAK,EAAA;iBAAA;KACvC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import { WebAttribution, isNewCampaign, isNewSession } from './helpers';\nimport { BeforePlugin, BrowserClient, BrowserConfig, Event } from '@amplitude/analytics-types';\nimport { CreateWebAttributionPlugin, Options } from './typings/web-attribution';\n\n/* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment */\n\n/**\n * @deprecated\n * This plugin is not used by @amplitude/analytics-browser and\n * is replaced by WebAttribution in @amplitude/analytics-browser to\n * be able to send identify events before session start.\n */\nexport const webAttributionPlugin: CreateWebAttributionPlugin = function (options: Options = {}) {\n const plugin: BeforePlugin = {\n name: '@amplitude/plugin-web-attribution-browser',\n type: 'before',\n\n setup: async function (config: BrowserConfig, amplitude: BrowserClient) {\n const webAttribution = new WebAttribution(options, config);\n await webAttribution.init();\n\n const pluginConfig = webAttribution.options;\n const currentCampaign = webAttribution.currentCampaign;\n const previousCampaign = webAttribution.previousCampaign;\n\n const isEventInNewSession = isNewSession(config.sessionTimeout, config.lastEventTime);\n\n if (isNewCampaign(currentCampaign, previousCampaign, pluginConfig, config.loggerProvider, isEventInNewSession)) {\n if (pluginConfig.resetSessionOnNewCampaign) {\n amplitude.setSessionId(Date.now());\n config.loggerProvider.log('Created a new session for new campaign.');\n }\n config.loggerProvider.log('Tracking attribution.');\n const campaignEvent = webAttribution.generateCampaignEvent();\n amplitude.track(campaignEvent);\n }\n },\n\n execute: async (event: Event) => event,\n };\n\n return plugin;\n};\n"]}
@@ -1 +1 @@
1
- !function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).amplitude={})}(this,function(e){"use strict";var t=function(){return t=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var i in t=arguments[r])Object.prototype.hasOwnProperty.call(t,i)&&(e[i]=t[i]);return e},t.apply(this,arguments)};function r(e,t){var r={};for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var i=0;for(n=Object.getOwnPropertySymbols(e);i<n.length;i++)t.indexOf(n[i])<0&&Object.prototype.propertyIsEnumerable.call(e,n[i])&&(r[n[i]]=e[n[i]])}return r}function n(e,t,r,n){return new(r||(r=Promise))(function(i,o){function s(e){try{u(n.next(e))}catch(e){o(e)}}function a(e){try{u(n.throw(e))}catch(e){o(e)}}function u(e){var t;e.done?i(e.value):(t=e.value,t instanceof r?t:new r(function(e){e(t)})).then(s,a)}u((n=n.apply(e,t||[])).next())})}function i(e,t){var r,n,i,o={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]},s=Object.create(("function"==typeof Iterator?Iterator:Object).prototype);return s.next=a(0),s.throw=a(1),s.return=a(2),"function"==typeof Symbol&&(s[Symbol.iterator]=function(){return this}),s;function a(a){return function(u){return function(a){if(r)throw new TypeError("Generator is already executing.");for(;s&&(s=0,a[0]&&(o=0)),o;)try{if(r=1,n&&(i=2&a[0]?n.return:a[0]?n.throw||((i=n.return)&&i.call(n),0):n.next)&&!(i=i.call(n,a[1])).done)return i;switch(n=0,i&&(a=[2&a[0],i.value]),a[0]){case 0:case 1:i=a;break;case 4:return o.label++,{value:a[1],done:!1};case 5:o.label++,n=a[1],a=[0];continue;case 7:a=o.ops.pop(),o.trys.pop();continue;default:if(!(i=o.trys,(i=i.length>0&&i[i.length-1])||6!==a[0]&&2!==a[0])){o=0;continue}if(3===a[0]&&(!i||a[1]>i[0]&&a[1]<i[3])){o.label=a[1];break}if(6===a[0]&&o.label<i[1]){o.label=i[1],i=a;break}if(i&&o.label<i[2]){o.label=i[2],o.ops.push(a);break}i[2]&&o.ops.pop(),o.trys.pop();continue}a=t.call(e,o)}catch(e){a=[6,e],n=0}finally{r=i=0}if(5&a[0])throw a[1];return{value:a[0]?a[1]:void 0,done:!0}}([a,u])}}}function o(e,t){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var n,i,o=r.call(e),s=[];try{for(;(void 0===t||t-- >0)&&!(n=o.next()).done;)s.push(n.value)}catch(e){i={error:e}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(i)throw i.error}}return s}"function"==typeof SuppressedError&&SuppressedError;var s,a,u=function(){var e,t,r=(t="ampIntegrationContext","undefined"!=typeof globalThis&&void 0!==globalThis[t]?globalThis[t]:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof self?self:"undefined"!=typeof global?global:void 0);return(null===(e=null==r?void 0:r.location)||void 0===e?void 0:e.search)?r.location.search.substring(1).split("&").filter(Boolean).reduce(function(e,t){var r=t.split("=",2),n=c(r[0]),i=c(r[1]);return i?(e[n]=i,e):e},{}):{}},c=function(e){void 0===e&&(e="");try{return decodeURIComponent(e)}catch(e){return""}},f="dclid",l="fbclid",p="gbraid",d="gclid",h="ko_click_id",v="li_fat_id",g="msclkid",m="rdt_cid",y="ttclid",b="twclid",E="wbraid",_={utm_campaign:void 0,utm_content:void 0,utm_id:void 0,utm_medium:void 0,utm_source:void 0,utm_term:void 0,referrer:void 0,referring_domain:void 0,dclid:void 0,gbraid:void 0,gclid:void 0,fbclid:void 0,ko_click_id:void 0,li_fat_id:void 0,msclkid:void 0,rdt_cid:void 0,ttclid:void 0,twclid:void 0,wbraid:void 0},S=function(){function e(){}return e.prototype.parse=function(){return n(this,void 0,void 0,function(){return i(this,function(e){return[2,t(t(t(t({},_),this.getUtmParam()),this.getReferrer()),this.getClickIds())]})})},e.prototype.getUtmParam=function(){var e=u();return{utm_campaign:e.utm_campaign,utm_content:e.utm_content,utm_id:e.utm_id,utm_medium:e.utm_medium,utm_source:e.utm_source,utm_term:e.utm_term}},e.prototype.getReferrer=function(){var e,t,r={referrer:void 0,referring_domain:void 0};try{r.referrer=document.referrer||void 0,r.referring_domain=null!==(t=null===(e=r.referrer)||void 0===e?void 0:e.split("/")[2])&&void 0!==t?t:void 0}catch(e){}return r},e.prototype.getClickIds=function(){var e,t=u();return(e={})[f]=t[f],e[l]=t[l],e[p]=t[p],e[d]=t[d],e[h]=t[h],e[v]=t[v],e[g]=t[g],e[m]=t[m],e[y]=t[y],e[b]=t[b],e[E]=t[E],e},e}();!function(e){e.SET="$set",e.SET_ONCE="$setOnce",e.ADD="$add",e.APPEND="$append",e.PREPEND="$prepend",e.REMOVE="$remove",e.PREINSERT="$preInsert",e.POSTINSERT="$postInsert",e.UNSET="$unset",e.CLEAR_ALL="$clearAll"}(s||(s={})),function(e){e.IDENTIFY="$identify",e.GROUP_IDENTIFY="$groupidentify",e.REVENUE="revenue_amount"}(a||(a={}));var T,w="AMP",P=function(e){if(Object.keys(e).length>1e3)return!1;for(var t in e){var r=e[t];if(!O(t,r))return!1}return!0},O=function(e,t){var r,n;if("string"!=typeof e)return!1;if(Array.isArray(t)){var i=!0;try{for(var o=function(e){var t="function"==typeof Symbol&&Symbol.iterator,r=t&&e[t],n=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&n>=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}(t),s=o.next();!s.done;s=o.next()){var a=s.value;if(Array.isArray(a))return!1;if("object"==typeof a)i=i&&P(a);else if(!["number","string"].includes(typeof a))return!1;if(!i)return!1}}catch(e){r={error:e}}finally{try{s&&!s.done&&(n=o.return)&&n.call(o)}finally{if(r)throw r.error}}}else{if(null==t)return!1;if("object"==typeof t)return P(t);if(!["number","string","boolean"].includes(typeof t))return!1}return!0},N=function(){function e(){this._propertySet=new Set,this._properties={}}return e.prototype.getUserProperties=function(){return t({},this._properties)},e.prototype.set=function(e,t){return this._safeSet(T.SET,e,t),this},e.prototype.setOnce=function(e,t){return this._safeSet(T.SET_ONCE,e,t),this},e.prototype.append=function(e,t){return this._safeSet(T.APPEND,e,t),this},e.prototype.prepend=function(e,t){return this._safeSet(T.PREPEND,e,t),this},e.prototype.postInsert=function(e,t){return this._safeSet(T.POSTINSERT,e,t),this},e.prototype.preInsert=function(e,t){return this._safeSet(T.PREINSERT,e,t),this},e.prototype.remove=function(e,t){return this._safeSet(T.REMOVE,e,t),this},e.prototype.add=function(e,t){return this._safeSet(T.ADD,e,t),this},e.prototype.unset=function(e){return this._safeSet(T.UNSET,e,"-"),this},e.prototype.clearAll=function(){return this._properties={},this._properties[T.CLEAR_ALL]="-",this},e.prototype._safeSet=function(e,t,r){if(this._validate(e,t,r)){var n=this._properties[e];return void 0===n&&(n={},this._properties[e]=n),n[t]=r,this._propertySet.add(t),!0}return!1},e.prototype._validate=function(e,t,r){return void 0===this._properties[T.CLEAR_ALL]&&(!this._propertySet.has(t)&&(e===T.ADD?"number"==typeof r:e===T.UNSET||e===T.REMOVE||O(t,r)))},e}();!function(e){e.SET="$set",e.SET_ONCE="$setOnce",e.ADD="$add",e.APPEND="$append",e.PREPEND="$prepend",e.REMOVE="$remove",e.PREINSERT="$preInsert",e.POSTINSERT="$postInsert",e.UNSET="$unset",e.CLEAR_ALL="$clearAll"}(T||(T={})),T.CLEAR_ALL,T.UNSET,T.SET,T.SET_ONCE,T.ADD,T.APPEND,T.PREPEND,T.PREINSERT,T.POSTINSERT,T.REMOVE;var C=function(e){var t=e.split(".");return t.length<=2?e:t.slice(t.length-2,t.length).join(".")},R=function(e,t,n,i,o){void 0===o&&(o=!0),e.referrer;var s=e.referring_domain,a=r(e,["referrer","referring_domain"]),u=t||{};u.referrer;var c=u.referring_domain,f=r(u,["referrer","referring_domain"]);if(I(n.excludeReferrers,e.referring_domain))return i.debug("This is not a new campaign because ".concat(e.referring_domain," is in the exclude referrer list.")),!1;if(!o&&function(e){return Object.values(e).every(function(e){return!e})}(e)&&t)return i.debug("This is not a new campaign because this is a direct traffic in the same session."),!1;var l=JSON.stringify(a)!==JSON.stringify(f),p=C(s||"")!==C(c||""),d=!t||l||p;return d?i.debug("This is a new campaign. An $identify event will be sent."):i.debug("This is not a new campaign because it's the same as the previous one."),d},I=function(e,t){return void 0===e&&(e=[]),void 0===t&&(t=""),e.some(function(e){return e instanceof RegExp?e.test(t):e===t})},A=function(e,r){var n,i,s=t(t({},_),e),u=Object.entries(s).reduce(function(e,t){var n,i=o(t,2),s=i[0],a=i[1];return e.setOnce("initial_".concat(s),null!==(n=null!=a?a:r.initialEmptyValue)&&void 0!==n?n:"EMPTY"),a?e.set(s,a):e.unset(s)},new N);return n=u,t(t({},i),{event_type:a.IDENTIFY,user_properties:n.getUserProperties()})},D=function(e,t){return void 0===t&&(t=Date.now()),Date.now()-t>e},$=function(){function e(e,r){var n,i,o,s,a,u;this.shouldTrackNewCampaign=!1,this.options=t({initialEmptyValue:"EMPTY",resetSessionOnNewCampaign:!1,excludeReferrers:(i=null===(n=r.cookieOptions)||void 0===n?void 0:n.domain,o=i,o?(o.startsWith(".")&&(o=o.substring(1)),[new RegExp("".concat(o.replace(".","\\."),"$"))]):[])},e),this.storage=r.cookieStorage,this.storageKey=(s=r.apiKey,void 0===(a="MKTG")&&(a=""),void 0===u&&(u=10),[w,a,s.substring(0,u)].filter(Boolean).join("_")),this.currentCampaign=_,this.sessionTimeout=r.sessionTimeout,this.lastEventTime=r.lastEventTime,this.logger=r.loggerProvider,r.loggerProvider.log("Installing web attribution tracking.")}return e.prototype.init=function(){return n(this,void 0,void 0,function(){var e,t;return i(this,function(r){switch(r.label){case 0:return[4,this.fetchCampaign()];case 1:return t=o.apply(void 0,[r.sent(),2]),this.currentCampaign=t[0],this.previousCampaign=t[1],e=!this.lastEventTime||D(this.sessionTimeout,this.lastEventTime),R(this.currentCampaign,this.previousCampaign,this.options,this.logger,e)?(this.shouldTrackNewCampaign=!0,[4,this.storage.set(this.storageKey,this.currentCampaign)]):[3,3];case 2:r.sent(),r.label=3;case 3:return[2]}})})},e.prototype.fetchCampaign=function(){return n(this,void 0,void 0,function(){return i(this,function(e){switch(e.label){case 0:return[4,Promise.all([(new S).parse(),this.storage.get(this.storageKey)])];case 1:return[2,e.sent()]}})})},e.prototype.generateCampaignEvent=function(e){this.shouldTrackNewCampaign=!1;var t=A(this.currentCampaign,this.options);return e&&(t.event_id=e),t},e.prototype.shouldSetSessionIdOnNewCampaign=function(){return this.shouldTrackNewCampaign&&!!this.options.resetSessionOnNewCampaign},e}(),k=function(e){var t=this;return void 0===e&&(e={}),{name:"@amplitude/plugin-web-attribution-browser",type:"before",setup:function(t,r){return n(this,void 0,void 0,function(){var n,o,s,a,u,c;return i(this,function(i){switch(i.label){case 0:return[4,(n=new $(e,t)).init()];case 1:return i.sent(),o=n.options,s=n.currentCampaign,a=n.previousCampaign,u=D(t.sessionTimeout,t.lastEventTime),R(s,a,o,t.loggerProvider,u)&&(o.resetSessionOnNewCampaign&&(r.setSessionId(Date.now()),t.loggerProvider.log("Created a new session for new campaign.")),t.loggerProvider.log("Tracking attribution."),c=n.generateCampaignEvent(),r.track(c)),[2]}})})},execute:function(e){return n(t,void 0,void 0,function(){return i(this,function(t){return[2,e]})})}}};e.plugin=k,e.webAttributionPlugin=k,Object.defineProperty(e,"__esModule",{value:!0})});
1
+ !function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).amplitude={})}(this,function(e){"use strict";var t,r,n=function(){return n=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var i in t=arguments[r])Object.prototype.hasOwnProperty.call(t,i)&&(e[i]=t[i]);return e},n.apply(this,arguments)};function i(e,t){var r={};for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var i=0;for(n=Object.getOwnPropertySymbols(e);i<n.length;i++)t.indexOf(n[i])<0&&Object.prototype.propertyIsEnumerable.call(e,n[i])&&(r[n[i]]=e[n[i]])}return r}function o(e,t,r,n){return new(r||(r=Promise))(function(i,o){function s(e){try{u(n.next(e))}catch(e){o(e)}}function a(e){try{u(n.throw(e))}catch(e){o(e)}}function u(e){var t;e.done?i(e.value):(t=e.value,t instanceof r?t:new r(function(e){e(t)})).then(s,a)}u((n=n.apply(e,t||[])).next())})}function s(e,t){var r,n,i,o={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]},s=Object.create(("function"==typeof Iterator?Iterator:Object).prototype);return s.next=a(0),s.throw=a(1),s.return=a(2),"function"==typeof Symbol&&(s[Symbol.iterator]=function(){return this}),s;function a(a){return function(u){return function(a){if(r)throw new TypeError("Generator is already executing.");for(;s&&(s=0,a[0]&&(o=0)),o;)try{if(r=1,n&&(i=2&a[0]?n.return:a[0]?n.throw||((i=n.return)&&i.call(n),0):n.next)&&!(i=i.call(n,a[1])).done)return i;switch(n=0,i&&(a=[2&a[0],i.value]),a[0]){case 0:case 1:i=a;break;case 4:return o.label++,{value:a[1],done:!1};case 5:o.label++,n=a[1],a=[0];continue;case 7:a=o.ops.pop(),o.trys.pop();continue;default:if(!(i=o.trys,(i=i.length>0&&i[i.length-1])||6!==a[0]&&2!==a[0])){o=0;continue}if(3===a[0]&&(!i||a[1]>i[0]&&a[1]<i[3])){o.label=a[1];break}if(6===a[0]&&o.label<i[1]){o.label=i[1],i=a;break}if(i&&o.label<i[2]){o.label=i[2],o.ops.push(a);break}i[2]&&o.ops.pop(),o.trys.pop();continue}a=t.call(e,o)}catch(e){a=[6,e],n=0}finally{r=i=0}if(5&a[0])throw a[1];return{value:a[0]?a[1]:void 0,done:!0}}([a,u])}}}function a(e,t){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var n,i,o=r.call(e),s=[];try{for(;(void 0===t||t-- >0)&&!(n=o.next()).done;)s.push(n.value)}catch(e){i={error:e}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(i)throw i.error}}return s}"function"==typeof SuppressedError&&SuppressedError,function(e){e.SET="$set",e.SET_ONCE="$setOnce",e.ADD="$add",e.APPEND="$append",e.PREPEND="$prepend",e.REMOVE="$remove",e.PREINSERT="$preInsert",e.POSTINSERT="$postInsert",e.UNSET="$unset",e.CLEAR_ALL="$clearAll"}(t||(t={})),function(e){e.IDENTIFY="$identify",e.GROUP_IDENTIFY="$groupidentify",e.REVENUE="revenue_amount"}(r||(r={}));var u,c="AMP",f="dclid",l="fbclid",p="gbraid",d="gclid",h="ko_click_id",v="li_fat_id",g="msclkid",m="rdt_cid",y="ttclid",b="twclid",E="wbraid",_={utm_campaign:void 0,utm_content:void 0,utm_id:void 0,utm_medium:void 0,utm_source:void 0,utm_term:void 0,referrer:void 0,referring_domain:void 0,dclid:void 0,gbraid:void 0,gclid:void 0,fbclid:void 0,ko_click_id:void 0,li_fat_id:void 0,msclkid:void 0,rdt_cid:void 0,ttclid:void 0,twclid:void 0,wbraid:void 0},S=function(e){if(Object.keys(e).length>1e3)return!1;for(var t in e){var r=e[t];if(!T(t,r))return!1}return!0},T=function(e,t){var r,n;if("string"!=typeof e)return!1;if(Array.isArray(t)){var i=!0;try{for(var o=function(e){var t="function"==typeof Symbol&&Symbol.iterator,r=t&&e[t],n=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&n>=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}(t),s=o.next();!s.done;s=o.next()){var a=s.value;if(Array.isArray(a))return!1;if("object"==typeof a)i=i&&S(a);else if(!["number","string"].includes(typeof a))return!1;if(!i)return!1}}catch(e){r={error:e}}finally{try{s&&!s.done&&(n=o.return)&&n.call(o)}finally{if(r)throw r.error}}}else{if(null==t)return!1;if("object"==typeof t)return S(t);if(!["number","string","boolean"].includes(typeof t))return!1}return!0},w=function(){function e(){this._propertySet=new Set,this._properties={}}return e.prototype.getUserProperties=function(){return n({},this._properties)},e.prototype.set=function(e,t){return this._safeSet(u.SET,e,t),this},e.prototype.setOnce=function(e,t){return this._safeSet(u.SET_ONCE,e,t),this},e.prototype.append=function(e,t){return this._safeSet(u.APPEND,e,t),this},e.prototype.prepend=function(e,t){return this._safeSet(u.PREPEND,e,t),this},e.prototype.postInsert=function(e,t){return this._safeSet(u.POSTINSERT,e,t),this},e.prototype.preInsert=function(e,t){return this._safeSet(u.PREINSERT,e,t),this},e.prototype.remove=function(e,t){return this._safeSet(u.REMOVE,e,t),this},e.prototype.add=function(e,t){return this._safeSet(u.ADD,e,t),this},e.prototype.unset=function(e){return this._safeSet(u.UNSET,e,"-"),this},e.prototype.clearAll=function(){return this._properties={},this._properties[u.CLEAR_ALL]="-",this},e.prototype._safeSet=function(e,t,r){if(this._validate(e,t,r)){var n=this._properties[e];return void 0===n&&(n={},this._properties[e]=n),n[t]=r,this._propertySet.add(t),!0}return!1},e.prototype._validate=function(e,t,r){return void 0===this._properties[u.CLEAR_ALL]&&(!this._propertySet.has(t)&&(e===u.ADD?"number"==typeof r:e===u.UNSET||e===u.REMOVE||T(t,r)))},e}();!function(e){e.SET="$set",e.SET_ONCE="$setOnce",e.ADD="$add",e.APPEND="$append",e.PREPEND="$prepend",e.REMOVE="$remove",e.PREINSERT="$preInsert",e.POSTINSERT="$postInsert",e.UNSET="$unset",e.CLEAR_ALL="$clearAll"}(u||(u={})),u.CLEAR_ALL,u.UNSET,u.SET,u.SET_ONCE,u.ADD,u.APPEND,u.PREPEND,u.PREINSERT,u.POSTINSERT,u.REMOVE;var P=function(){var e,t,r=(t="ampIntegrationContext","undefined"!=typeof globalThis&&void 0!==globalThis[t]?globalThis[t]:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof self?self:"undefined"!=typeof global?global:void 0);return(null===(e=null==r?void 0:r.location)||void 0===e?void 0:e.search)?r.location.search.substring(1).split("&").filter(Boolean).reduce(function(e,t){var r=t.split("=",2),n=O(r[0]),i=O(r[1]);return i?(e[n]=i,e):e},{}):{}},O=function(e){void 0===e&&(e="");try{return decodeURIComponent(e)}catch(e){return""}},N=function(){function e(){}return e.prototype.parse=function(){return o(this,void 0,void 0,function(){return s(this,function(e){return[2,n(n(n(n({},_),this.getUtmParam()),this.getReferrer()),this.getClickIds())]})})},e.prototype.getUtmParam=function(){var e=P();return{utm_campaign:e.utm_campaign,utm_content:e.utm_content,utm_id:e.utm_id,utm_medium:e.utm_medium,utm_source:e.utm_source,utm_term:e.utm_term}},e.prototype.getReferrer=function(){var e,t,r={referrer:void 0,referring_domain:void 0};try{r.referrer=document.referrer||void 0,r.referring_domain=null!==(t=null===(e=r.referrer)||void 0===e?void 0:e.split("/")[2])&&void 0!==t?t:void 0}catch(e){}return r},e.prototype.getClickIds=function(){var e,t=P();return(e={})[f]=t[f],e[l]=t[l],e[p]=t[p],e[d]=t[d],e[h]=t[h],e[v]=t[v],e[g]=t[g],e[m]=t[m],e[y]=t[y],e[b]=t[b],e[E]=t[E],e},e}(),C=function(e){var t=e.split(".");return t.length<=2?e:t.slice(t.length-2,t.length).join(".")},R=function(e,t,r,n,o){void 0===o&&(o=!0),e.referrer;var s=e.referring_domain,a=i(e,["referrer","referring_domain"]),u=t||{};u.referrer;var c=u.referring_domain,f=i(u,["referrer","referring_domain"]);if(I(r.excludeReferrers,e.referring_domain))return n.debug("This is not a new campaign because ".concat(e.referring_domain," is in the exclude referrer list.")),!1;if(!o&&function(e){return Object.values(e).every(function(e){return!e})}(e)&&t)return n.debug("This is not a new campaign because this is a direct traffic in the same session."),!1;var l=JSON.stringify(a)!==JSON.stringify(f),p=C(s||"")!==C(c||""),d=!t||l||p;return d?n.debug("This is a new campaign. An $identify event will be sent."):n.debug("This is not a new campaign because it's the same as the previous one."),d},I=function(e,t){return void 0===e&&(e=[]),void 0===t&&(t=""),e.some(function(e){return e instanceof RegExp?e.test(t):e===t})},A=function(e,t){var i,o,s=n(n({},_),e),u=Object.entries(s).reduce(function(e,r){var n,i=a(r,2),o=i[0],s=i[1];return e.setOnce("initial_".concat(o),null!==(n=null!=s?s:t.initialEmptyValue)&&void 0!==n?n:"EMPTY"),s?e.set(o,s):e.unset(o)},new w);return i=u,n(n({},o),{event_type:r.IDENTIFY,user_properties:i.getUserProperties()})},D=function(){function e(e,t){var r,i,o,s,a,u;this.shouldTrackNewCampaign=!1,this.options=n({initialEmptyValue:"EMPTY",resetSessionOnNewCampaign:!1,excludeReferrers:(i=null===(r=t.cookieOptions)||void 0===r?void 0:r.domain,o=i,o?(o.startsWith(".")&&(o=o.substring(1)),[new RegExp("".concat(o.replace(".","\\."),"$"))]):[])},e),this.storage=t.cookieStorage,this.storageKey=(s=t.apiKey,void 0===(a="MKTG")&&(a=""),void 0===u&&(u=10),[c,a,s.substring(0,u)].filter(Boolean).join("_")),this.currentCampaign=_,this.sessionTimeout=t.sessionTimeout,this.lastEventTime=t.lastEventTime,this.logger=t.loggerProvider,t.loggerProvider.log("Installing web attribution tracking.")}return e.prototype.init=function(){return o(this,void 0,void 0,function(){var e,t;return s(this,function(r){switch(r.label){case 0:return[4,this.fetchCampaign()];case 1:return t=a.apply(void 0,[r.sent(),2]),this.currentCampaign=t[0],this.previousCampaign=t[1],e=!this.lastEventTime||$(this.sessionTimeout,this.lastEventTime),R(this.currentCampaign,this.previousCampaign,this.options,this.logger,e)?(this.shouldTrackNewCampaign=!0,[4,this.storage.set(this.storageKey,this.currentCampaign)]):[3,3];case 2:r.sent(),r.label=3;case 3:return[2]}})})},e.prototype.fetchCampaign=function(){return o(this,void 0,void 0,function(){return s(this,function(e){switch(e.label){case 0:return[4,Promise.all([(new N).parse(),this.storage.get(this.storageKey)])];case 1:return[2,e.sent()]}})})},e.prototype.generateCampaignEvent=function(e){this.shouldTrackNewCampaign=!1;var t=A(this.currentCampaign,this.options);return e&&(t.event_id=e),t},e.prototype.shouldSetSessionIdOnNewCampaign=function(){return this.shouldTrackNewCampaign&&!!this.options.resetSessionOnNewCampaign},e}(),$=function(e,t){return void 0===t&&(t=Date.now()),Date.now()-t>e},k=function(e){var t=this;return void 0===e&&(e={}),{name:"@amplitude/plugin-web-attribution-browser",type:"before",setup:function(t,r){return o(this,void 0,void 0,function(){var n,i,o,a,u,c;return s(this,function(s){switch(s.label){case 0:return[4,(n=new D(e,t)).init()];case 1:return s.sent(),i=n.options,o=n.currentCampaign,a=n.previousCampaign,u=$(t.sessionTimeout,t.lastEventTime),R(o,a,i,t.loggerProvider,u)&&(i.resetSessionOnNewCampaign&&(r.setSessionId(Date.now()),t.loggerProvider.log("Created a new session for new campaign.")),t.loggerProvider.log("Tracking attribution."),c=n.generateCampaignEvent(),r.track(c)),[2]}})})},execute:function(e){return o(t,void 0,void 0,function(){return s(this,function(t){return[2,e]})})}}};e.plugin=k,e.webAttributionPlugin=k,Object.defineProperty(e,"__esModule",{value:!0})});
Binary file
@@ -0,0 +1,34 @@
1
+ import { BrowserConfig, Storage } from '@amplitude/analytics-core';
2
+ import type { Campaign, ILogger } from '@amplitude/analytics-core';
3
+ export interface Options {
4
+ excludeReferrers?: (string | RegExp)[];
5
+ initialEmptyValue?: string;
6
+ resetSessionOnNewCampaign?: boolean;
7
+ }
8
+ export declare const isNewCampaign: (current: Campaign, previous: Campaign | undefined, options: Options, logger: ILogger, isNewSession?: boolean) => boolean;
9
+ export declare const isExcludedReferrer: (excludeReferrers?: (string | RegExp)[], referringDomain?: string) => boolean;
10
+ export declare const createCampaignEvent: (campaign: Campaign, options: Options) => import("@amplitude/analytics-core").IdentifyEvent;
11
+ export declare const getDefaultExcludedReferrers: (cookieDomain: string | undefined) => RegExp[];
12
+ export declare class WebAttribution {
13
+ options: Options;
14
+ storage: Storage<Campaign>;
15
+ storageKey: string;
16
+ previousCampaign?: Campaign;
17
+ currentCampaign: Campaign;
18
+ shouldTrackNewCampaign: boolean;
19
+ sessionTimeout: number;
20
+ lastEventTime?: number;
21
+ logger: ILogger;
22
+ constructor(options: Options, config: BrowserConfig);
23
+ init(): Promise<void>;
24
+ fetchCampaign(): Promise<[Campaign, Campaign | undefined]>;
25
+ /**
26
+ * This can be called when enable web attribution and either
27
+ * 1. set a new session
28
+ * 2. has new campaign and enable resetSessionOnNewCampaign
29
+ */
30
+ generateCampaignEvent(event_id?: number): import("@amplitude/analytics-core").IdentifyEvent;
31
+ shouldSetSessionIdOnNewCampaign(): boolean;
32
+ }
33
+ export declare const isNewSession: (sessionTimeout: number, lastEventTime?: number) => boolean;
34
+ //# sourceMappingURL=helpers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EACb,OAAO,EAIR,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEnE,MAAM,WAAW,OAAO;IACtB,gBAAgB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAiBD,eAAO,MAAM,aAAa,YACf,QAAQ,YACP,QAAQ,GAAG,SAAS,WACrB,OAAO,UACR,OAAO,oCA+BhB,CAAC;AAEF,eAAO,MAAM,kBAAkB,sBAAsB,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,sCAIvE,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAc,QAAQ,WAAW,OAAO,sDAgBvE,CAAC;AAEF,eAAO,MAAM,2BAA2B,iBAAkB,MAAM,GAAG,SAAS,aAS3E,CAAC;AAEF,qBAAa,cAAc;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,eAAe,EAAE,QAAQ,CAAC;IAC1B,sBAAsB,UAAS;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;gBAEJ,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa;IAgB7C,IAAI;IAUJ,aAAa;IAInB;;;;OAIG;IACH,qBAAqB,CAAC,QAAQ,CAAC,EAAE,MAAM;IAUvC,+BAA+B;CAGhC;AAED,eAAO,MAAM,YAAY,mBAAoB,MAAM,kBAAiB,MAAM,KAAgB,OAKzF,CAAC"}
@@ -2,7 +2,7 @@ import { CreateWebAttributionPlugin } from './typings/web-attribution';
2
2
  /**
3
3
  * @deprecated
4
4
  * This plugin is not used by @amplitude/analytics-browser and
5
- * is replaced by WebAttribution in @amplitude/analytics-client-common to
5
+ * is replaced by WebAttribution in @amplitude/analytics-browser to
6
6
  * be able to send identify events before session start.
7
7
  */
8
8
  export declare const webAttributionPlugin: CreateWebAttributionPlugin;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amplitude/plugin-web-attribution-browser",
3
- "version": "2.2.23",
3
+ "version": "2.2.25-video-analytics-2.0",
4
4
  "description": "",
5
5
  "author": "Amplitude Inc",
6
6
  "homepage": "https://github.com/amplitude/Amplitude-TypeScript",
@@ -22,9 +22,8 @@
22
22
  },
23
23
  "dependencies": {
24
24
  "tslib": "^2.4.1",
25
- "@amplitude/analytics-client-common": "2.4.60",
26
- "@amplitude/analytics-types": "2.11.1",
27
- "@amplitude/analytics-core": "2.54.2"
25
+ "@amplitude/analytics-core": "2.56.0-video-analytics-2.0",
26
+ "@amplitude/analytics-types": "2.11.1"
28
27
  },
29
28
  "devDependencies": {
30
29
  "@rollup/plugin-commonjs": "^23.0.4",