@amplitude/plugin-page-view-tracking-browser 0.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Amplitude Analytics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/cjs/index.d.ts

@@ -0,0 +1,3 @@
+export { pageViewTrackingPlugin } from './page-view-tracking';
+export * as Types from './typings/page-view-tracking';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,KAAK,KAAK,MAAM,8BAA8B,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Types = exports.pageViewTrackingPlugin = void 0;
+var tslib_1 = require("tslib");
+var page_view_tracking_1 = require("./page-view-tracking");
+Object.defineProperty(exports, "pageViewTrackingPlugin", { enumerable: true, get: function () { return page_view_tracking_1.pageViewTrackingPlugin; } });
+exports.Types = (0, tslib_1.__importStar)(require("./typings/page-view-tracking"));
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,2DAA8D;AAArD,4HAAA,sBAAsB,OAAA;AAC/B,mFAAsD","sourcesContent":["export { pageViewTrackingPlugin } from './page-view-tracking';\nexport * as Types from './typings/page-view-tracking';\n"]}

package/lib/cjs/page-view-tracking.d.ts

@@ -0,0 +1,5 @@
+import { BrowserClient, EnrichmentPlugin } from '@amplitude/analytics-types';
+import { Options } from './typings/page-view-tracking';
+export declare const pageViewTrackingPlugin: (client: BrowserClient, options?: Options) => EnrichmentPlugin;
+export declare const shouldTrackHistoryPageView: (trackingOption: Options['trackHistoryChanges'], newURL: string, oldURL: string) => boolean;
+//# sourceMappingURL=page-view-tracking.d.ts.map

package/lib/cjs/page-view-tracking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.d.ts","sourceRoot":"","sources":["../../src/page-view-tracking.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,aAAa,EAEb,gBAAgB,EAMjB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAGvD,eAAO,MAAM,sBAAsB,WAAY,aAAa,YAAW,OAAO,KAAQ,gBAoFrF,CAAC;AA8BF,eAAO,MAAM,0BAA0B,mBACrB,OAAO,CAAC,qBAAqB,CAAC,UACtC,MAAM,UACN,MAAM,KACb,OAOF,CAAC"}

package/lib/cjs/page-view-tracking.js

@@ -0,0 +1,152 @@
+var _this = this;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldTrackHistoryPageView = exports.pageViewTrackingPlugin = void 0;
+var tslib_1 = require("tslib");
+var analytics_client_common_1 = require("@amplitude/analytics-client-common");
+var analytics_types_1 = require("@amplitude/analytics-types");
+var analytics_client_common_2 = require("@amplitude/analytics-client-common");
+var utils_1 = require("./utils");
+var pageViewTrackingPlugin = function (client, options) {
+    if (options === void 0) { options = {}; }
+    var loggerProvider = undefined;
+    var shouldTrackOnPageLoad = function () {
+        return typeof options.trackOn === 'undefined' || (typeof options.trackOn === 'function' && options.trackOn());
+    };
+    var previousURL = null;
+    var trackHistoryPageView = function () { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
+        var newURL, _a, _b;
+        return (0, tslib_1.__generator)(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    newURL = location.href;
+                    if (!((0, exports.shouldTrackHistoryPageView)(options.trackHistoryChanges, newURL, previousURL || '') && shouldTrackOnPageLoad())) return [3 /*break*/, 2];
+                    /* istanbul ignore next */
+                    loggerProvider === null || loggerProvider === void 0 ? void 0 : loggerProvider.log('Tracking page view event');
+                    _b = (_a = client).track;
+                    return [4 /*yield*/, createPageViewEvent()];
+                case 1:
+                    _b.apply(_a, [_c.sent()]);
+                    _c.label = 2;
+                case 2:
+                    previousURL = newURL;
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+    var plugin = {
+        name: 'page-view-tracking',
+        type: analytics_types_1.PluginType.ENRICHMENT,
+        setup: function (config) { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
+            var _a, _b;
+            var _c, _d;
+            return (0, tslib_1.__generator)(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        loggerProvider = config.loggerProvider;
+                        loggerProvider.log('Installing @amplitude/plugin-page-view-tracking-browser');
+                        options.trackOn = ((_c = config.attribution) === null || _c === void 0 ? void 0 : _c.trackPageViews) ? 'attribution' : options.trackOn;
+                        // Turn off sending page view event by "runAttributionStrategy" function
+                        if ((_d = config.attribution) === null || _d === void 0 ? void 0 : _d.trackPageViews) {
+                            loggerProvider.warn('@amplitude/plugin-page-view-tracking-browser overrides page view tracking behavior defined in @amplitude/analytics-browser');
+                            config.attribution.trackPageViews = false;
+                        }
+                        if (options.trackHistoryChanges) {
+                            /* istanbul ignore next */
+                            window.addEventListener('popstate', function () {
+                                void trackHistoryPageView();
+                            });
+                            /* istanbul ignore next */
+                            // There is no global browser listener for changes to history, so we have
+                            // to modify pushState directly.
+                            // https://stackoverflow.com/a/64927639
+                            // eslint-disable-next-line @typescript-eslint/unbound-method
+                            window.history.pushState = new Proxy(window.history.pushState, {
+                                apply: function (target, thisArg, _a) {
+                                    var _b = (0, tslib_1.__read)(_a, 3), state = _b[0], unused = _b[1], url = _b[2];
+                                    void trackHistoryPageView();
+                                    return target.apply(thisArg, [state, unused, url]);
+                                },
+                            });
+                        }
+                        if (!shouldTrackOnPageLoad()) return [3 /*break*/, 2];
+                        loggerProvider.log('Tracking page view event');
+                        _b = (_a = client).track;
+                        return [4 /*yield*/, createPageViewEvent()];
+                    case 1:
+                        _b.apply(_a, [_e.sent()]);
+                        _e.label = 2;
+                    case 2: return [2 /*return*/];
+                }
+            });
+        }); },
+        execute: function (event) { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
+            var pageViewEvent;
+            return (0, tslib_1.__generator)(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!(options.trackOn === 'attribution' && isCampaignEvent(event))) return [3 /*break*/, 2];
+                        /* istanbul ignore next */ // loggerProvider should be defined by the time execute is invoked
+                        loggerProvider === null || loggerProvider === void 0 ? void 0 : loggerProvider.log('Enriching campaign event to page view event with campaign parameters');
+                        return [4 /*yield*/, createPageViewEvent()];
+                    case 1:
+                        pageViewEvent = _a.sent();
+                        event.event_type = pageViewEvent.event_type;
+                        event.event_properties = (0, tslib_1.__assign)((0, tslib_1.__assign)({}, event.event_properties), pageViewEvent.event_properties);
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, event];
+                }
+            });
+        }); },
+    };
+    // Required for unit tests
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    plugin.__trackHistoryPageView = trackHistoryPageView;
+    return plugin;
+};
+exports.pageViewTrackingPlugin = pageViewTrackingPlugin;
+var getCampaignParams = 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 = utils_1.omitUndefined;
+            return [4 /*yield*/, new analytics_client_common_1.CampaignParser().parse()];
+        case 1: return [2 /*return*/, _a.apply(void 0, [_b.sent()])];
+    }
+}); }); };
+var createPageViewEvent = function () { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
+    var pageViewEvent, _a;
+    var _b;
+    return (0, tslib_1.__generator)(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                _b = {
+                    event_type: 'Page View'
+                };
+                _a = [{}];
+                return [4 /*yield*/, getCampaignParams()];
+            case 1:
+                pageViewEvent = (_b.event_properties = tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _a.concat([(_c.sent())])), { page_domain: /* istanbul ignore next */ (typeof location !== 'undefined' && location.hostname) || '', page_location: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href) || '', page_path: /* istanbul ignore next */ (typeof location !== 'undefined' && location.pathname) || '', page_title: /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '', page_url: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href.split('?')[0]) || '' }]),
+                    _b);
+                return [2 /*return*/, pageViewEvent];
+        }
+    });
+}); };
+var isCampaignEvent = function (event) {
+    if (event.event_type === '$identify' && event.user_properties) {
+        var properties = event.user_properties;
+        var $set = properties[analytics_types_1.IdentifyOperation.SET] || {};
+        var $unset = properties[analytics_types_1.IdentifyOperation.UNSET] || {};
+        var userProperties_1 = (0, tslib_1.__spreadArray)((0, tslib_1.__spreadArray)([], (0, tslib_1.__read)(Object.keys($set)), false), (0, tslib_1.__read)(Object.keys($unset)), false);
+        return Object.keys(analytics_client_common_2.BASE_CAMPAIGN).every(function (value) { return userProperties_1.includes(value); });
+    }
+    return false;
+};
+var shouldTrackHistoryPageView = function (trackingOption, newURL, oldURL) {
+    switch (trackingOption) {
+        case 'pathOnly':
+            return newURL.split('?')[0] !== oldURL.split('?')[0];
+        default:
+            return newURL !== oldURL;
+    }
+};
+exports.shouldTrackHistoryPageView = shouldTrackHistoryPageView;
+//# sourceMappingURL=page-view-tracking.js.map

package/lib/cjs/page-view-tracking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.js","sourceRoot":"","sources":["../../src/page-view-tracking.ts"],"names":[],"mappings":"AAAA,iBA8IA;;;;AA9IA,8EAAoE;AACpE,8DAUoC;AACpC,8EAAmE;AAEnE,iCAAwC;AAEjC,IAAM,sBAAsB,GAAG,UAAC,MAAqB,EAAE,OAAqB;IAArB,wBAAA,EAAA,YAAqB;IACjF,IAAI,cAAc,GAAuB,SAAS,CAAC;IAEnD,IAAM,qBAAqB,GAAG;QAC5B,OAAA,OAAO,OAAO,CAAC,OAAO,KAAK,WAAW,IAAI,CAAC,OAAO,OAAO,CAAC,OAAO,KAAK,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAAtG,CAAsG,CAAC;IAEzG,IAAI,WAAW,GAAkB,IAAI,CAAC;IAEtC,IAAM,oBAAoB,GAAG;;;;;oBACrB,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC;yBAEzB,CAAA,IAAA,kCAA0B,EAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC,IAAI,qBAAqB,EAAE,CAAA,EAA7G,wBAA6G;oBAC/G,0BAA0B;oBAC1B,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,GAAG,CAAC,0BAA0B,CAAC,CAAC;oBAChD,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,KAAK,CAAA;oBAAC,qBAAM,mBAAmB,EAAE,EAAA;;oBAAxC,cAAa,SAA2B,EAAC,CAAC;;;oBAE5C,WAAW,GAAG,MAAM,CAAC;;;;SACtB,CAAC;IAEF,IAAM,MAAM,GAAG;QACb,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,4BAAU,CAAC,UAAmB;QAEpC,KAAK,EAAE,UAAO,MAAqB;;;;;;wBACjC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;wBACvC,cAAc,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAC;wBAE9E,OAAO,CAAC,OAAO,GAAG,CAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,cAAc,EAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;wBAEvF,wEAAwE;wBACxE,IAAI,MAAA,MAAM,CAAC,WAAW,0CAAE,cAAc,EAAE;4BACtC,cAAc,CAAC,IAAI,CACjB,4HAA4H,CAC7H,CAAC;4BACF,MAAM,CAAC,WAAW,CAAC,cAAc,GAAG,KAAK,CAAC;yBAC3C;wBAED,IAAI,OAAO,CAAC,mBAAmB,EAAE;4BAC/B,0BAA0B;4BAC1B,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE;gCAClC,KAAK,oBAAoB,EAAE,CAAC;4BAC9B,CAAC,CAAC,CAAC;4BAEH,0BAA0B;4BAC1B,yEAAyE;4BACzE,gCAAgC;4BAChC,uCAAuC;4BACvC,6DAA6D;4BAC7D,MAAM,CAAC,OAAO,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE;gCAC7D,KAAK,EAAE,UAAC,MAAM,EAAE,OAAO,EAAE,EAAoB;wCAApB,KAAA,0BAAoB,EAAnB,KAAK,QAAA,EAAE,MAAM,QAAA,EAAE,GAAG,QAAA;oCAC1C,KAAK,oBAAoB,EAAE,CAAC;oCAE5B,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;gCACrD,CAAC;6BACF,CAAC,CAAC;yBACJ;6BAEG,qBAAqB,EAAE,EAAvB,wBAAuB;wBACzB,cAAc,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;wBAE/C,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,KAAK,CAAA;wBAAC,qBAAM,mBAAmB,EAAE,EAAA;;wBAAxC,cAAa,SAA2B,EAAC,CAAC;;;;;aAE7C;QAED,OAAO,EAAE,UAAO,KAAY;;;;;6BACtB,CAAA,OAAO,CAAC,OAAO,KAAK,aAAa,IAAI,eAAe,CAAC,KAAK,CAAC,CAAA,EAA3D,wBAA2D;wBAC7D,0BAA0B,CAAC,kEAAkE;wBAC7F,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,GAAG,CAAC,sEAAsE,CAAC,CAAC;wBACtE,qBAAM,mBAAmB,EAAE,EAAA;;wBAA3C,aAAa,GAAG,SAA2B;wBACjD,KAAK,CAAC,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC;wBAC5C,KAAK,CAAC,gBAAgB,mDACjB,KAAK,CAAC,gBAAgB,GACtB,aAAa,CAAC,gBAAgB,CAClC,CAAC;;4BAEJ,sBAAO,KAAK,EAAC;;;aACd;KACF,CAAC;IAEF,0BAA0B;IAC1B,sEAAsE;IACrE,MAAc,CAAC,sBAAsB,GAAG,oBAAoB,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AApFW,QAAA,sBAAsB,0BAoFjC;AAEF,IAAM,iBAAiB,GAAG;;;YAAY,KAAA,qBAAa,CAAA;YAAC,qBAAM,IAAI,wCAAc,EAAE,CAAC,KAAK,EAAE,EAAA;gBAAhD,sBAAA,kBAAc,SAAkC,EAAC,EAAA;;SAAA,CAAC;AAExF,IAAM,mBAAmB,GAAG;;;;;;;oBAExB,UAAU,EAAE,WAAW;;;gBAEjB,qBAAM,iBAAiB,EAAE,EAAA;;gBAH3B,aAAa,IAEjB,mBAAgB,6EACX,CAAC,SAAyB,CAAC,OAC9B,WAAW,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EACpG,aAAa,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAClG,SAAS,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EAClG,UAAU,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAChG,QAAQ,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAC5G;uBACF;gBACD,sBAAO,aAAa,EAAC;;;KACtB,CAAC;AAEF,IAAM,eAAe,GAAG,UAAC,KAAY;IACnC,IAAI,KAAK,CAAC,UAAU,KAAK,WAAW,IAAI,KAAK,CAAC,eAAe,EAAE;QAC7D,IAAM,UAAU,GAAG,KAAK,CAAC,eAAyC,CAAC;QACnE,IAAM,IAAI,GAAG,UAAU,CAAC,mCAAiB,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACrD,IAAM,MAAM,GAAG,UAAU,CAAC,mCAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACzD,IAAM,gBAAc,iFAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,+BAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAC,CAAC;QACtE,OAAO,MAAM,CAAC,IAAI,CAAC,uCAAa,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK,IAAK,OAAA,gBAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,EAA9B,CAA8B,CAAC,CAAC;KACpF;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEK,IAAM,0BAA0B,GAAG,UACxC,cAA8C,EAC9C,MAAc,EACd,MAAc;IAEd,QAAQ,cAAc,EAAE;QACtB,KAAK,UAAU;YACb,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD;YACE,OAAO,MAAM,KAAK,MAAM,CAAC;KAC5B;AACH,CAAC,CAAC;AAXW,QAAA,0BAA0B,8BAWrC","sourcesContent":["import { CampaignParser } from '@amplitude/analytics-client-common';\nimport {\n  BaseEvent,\n  BrowserClient,\n  BrowserConfig,\n  EnrichmentPlugin,\n  Event,\n  IdentifyOperation,\n  IdentifyUserProperties,\n  Logger,\n  PluginType,\n} from '@amplitude/analytics-types';\nimport { BASE_CAMPAIGN } from '@amplitude/analytics-client-common';\nimport { Options } from './typings/page-view-tracking';\nimport { omitUndefined } from './utils';\n\nexport const pageViewTrackingPlugin = (client: BrowserClient, options: Options = {}): EnrichmentPlugin => {\n  let loggerProvider: Logger | undefined = undefined;\n\n  const shouldTrackOnPageLoad = () =>\n    typeof options.trackOn === 'undefined' || (typeof options.trackOn === 'function' && options.trackOn());\n\n  let previousURL: string | null = null;\n\n  const trackHistoryPageView = async (): Promise<void> => {\n    const newURL = location.href;\n\n    if (shouldTrackHistoryPageView(options.trackHistoryChanges, newURL, previousURL || '') && shouldTrackOnPageLoad()) {\n      /* istanbul ignore next */\n      loggerProvider?.log('Tracking page view event');\n      client.track(await createPageViewEvent());\n    }\n    previousURL = newURL;\n  };\n\n  const plugin = {\n    name: 'page-view-tracking',\n    type: PluginType.ENRICHMENT as const,\n\n    setup: async (config: BrowserConfig) => {\n      loggerProvider = config.loggerProvider;\n      loggerProvider.log('Installing @amplitude/plugin-page-view-tracking-browser');\n\n      options.trackOn = config.attribution?.trackPageViews ? 'attribution' : options.trackOn;\n\n      // Turn off sending page view event by \"runAttributionStrategy\" function\n      if (config.attribution?.trackPageViews) {\n        loggerProvider.warn(\n          '@amplitude/plugin-page-view-tracking-browser overrides page view tracking behavior defined in @amplitude/analytics-browser',\n        );\n        config.attribution.trackPageViews = false;\n      }\n\n      if (options.trackHistoryChanges) {\n        /* istanbul ignore next */\n        window.addEventListener('popstate', () => {\n          void trackHistoryPageView();\n        });\n\n        /* istanbul ignore next */\n        // There is no global browser listener for changes to history, so we have\n        // to modify pushState directly.\n        // https://stackoverflow.com/a/64927639\n        // eslint-disable-next-line @typescript-eslint/unbound-method\n        window.history.pushState = new Proxy(window.history.pushState, {\n          apply: (target, thisArg, [state, unused, url]) => {\n            void trackHistoryPageView();\n\n            return target.apply(thisArg, [state, unused, url]);\n          },\n        });\n      }\n\n      if (shouldTrackOnPageLoad()) {\n        loggerProvider.log('Tracking page view event');\n\n        client.track(await createPageViewEvent());\n      }\n    },\n\n    execute: async (event: Event) => {\n      if (options.trackOn === 'attribution' && isCampaignEvent(event)) {\n        /* istanbul ignore next */ // loggerProvider should be defined by the time execute is invoked\n        loggerProvider?.log('Enriching campaign event to page view event with campaign parameters');\n        const pageViewEvent = await createPageViewEvent();\n        event.event_type = pageViewEvent.event_type;\n        event.event_properties = {\n          ...event.event_properties,\n          ...pageViewEvent.event_properties,\n        };\n      }\n      return event;\n    },\n  };\n\n  // Required for unit tests\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n  (plugin as any).__trackHistoryPageView = trackHistoryPageView;\n\n  return plugin;\n};\n\nconst getCampaignParams = async () => omitUndefined(await new CampaignParser().parse());\n\nconst createPageViewEvent = async (): Promise<Event> => {\n  const pageViewEvent: BaseEvent = {\n    event_type: 'Page View',\n    event_properties: {\n      ...(await getCampaignParams()),\n      page_domain: /* istanbul ignore next */ (typeof location !== 'undefined' && location.hostname) || '',\n      page_location: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href) || '',\n      page_path: /* istanbul ignore next */ (typeof location !== 'undefined' && location.pathname) || '',\n      page_title: /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '',\n      page_url: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href.split('?')[0]) || '',\n    },\n  };\n  return pageViewEvent;\n};\n\nconst isCampaignEvent = (event: Event) => {\n  if (event.event_type === '$identify' && event.user_properties) {\n    const properties = event.user_properties as IdentifyUserProperties;\n    const $set = properties[IdentifyOperation.SET] || {};\n    const $unset = properties[IdentifyOperation.UNSET] || {};\n    const userProperties = [...Object.keys($set), ...Object.keys($unset)];\n    return Object.keys(BASE_CAMPAIGN).every((value) => userProperties.includes(value));\n  }\n  return false;\n};\n\nexport const shouldTrackHistoryPageView = (\n  trackingOption: Options['trackHistoryChanges'],\n  newURL: string,\n  oldURL: string,\n): boolean => {\n  switch (trackingOption) {\n    case 'pathOnly':\n      return newURL.split('?')[0] !== oldURL.split('?')[0];\n    default:\n      return newURL !== oldURL;\n  }\n};\n"]}

package/lib/cjs/typings/page-view-tracking.d.ts

@@ -0,0 +1,7 @@
+export interface Options {
+    trackOn?: PageTrackingTrackOn;
+    trackHistoryChanges?: PageTrackingHistoryChanges;
+}
+export declare type PageTrackingTrackOn = 'attribution' | (() => boolean);
+export declare type PageTrackingHistoryChanges = 'all' | 'pathOnly';
+//# sourceMappingURL=page-view-tracking.d.ts.map

package/lib/cjs/typings/page-view-tracking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.d.ts","sourceRoot":"","sources":["../../../src/typings/page-view-tracking.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;CAClD;AAED,oBAAY,mBAAmB,GAAG,aAAa,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;AAElE,oBAAY,0BAA0B,GAAG,KAAK,GAAG,UAAU,CAAC"}

package/lib/cjs/typings/page-view-tracking.js

@@ -0,0 +1,2 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=page-view-tracking.js.map

package/lib/cjs/typings/page-view-tracking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.js","sourceRoot":"","sources":["../../../src/typings/page-view-tracking.ts"],"names":[],"mappings":"","sourcesContent":["export interface Options {\n  trackOn?: PageTrackingTrackOn;\n  trackHistoryChanges?: PageTrackingHistoryChanges;\n}\n\nexport type PageTrackingTrackOn = 'attribution' | (() => boolean);\n\nexport type PageTrackingHistoryChanges = 'all' | 'pathOnly';\n"]}

package/lib/cjs/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const omitUndefined: (input: Record<string, string | undefined>) => Record<string, string>;
+//# sourceMappingURL=utils.d.ts.map

package/lib/cjs/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,UAAW,OAAO,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,2BAStE,CAAC"}

package/lib/cjs/utils.js

@@ -0,0 +1,14 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.omitUndefined = void 0;
+var omitUndefined = function (input) {
+    var obj = {};
+    for (var key in input) {
+        var val = input[key];
+        if (val) {
+            obj[key] = val;
+        }
+    }
+    return obj;
+};
+exports.omitUndefined = omitUndefined;
+//# sourceMappingURL=utils.js.map

package/lib/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;AAAO,IAAM,aAAa,GAAG,UAAC,KAAyC;IACrE,IAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,KAAK,IAAM,GAAG,IAAI,KAAK,EAAE;QACvB,IAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,GAAG,EAAE;YACP,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SAChB;KACF;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AATW,QAAA,aAAa,iBASxB","sourcesContent":["export const omitUndefined = (input: Record<string, string | undefined>) => {\n  const obj: Record<string, string> = {};\n  for (const key in input) {\n    const val = input[key];\n    if (val) {\n      obj[key] = val;\n    }\n  }\n  return obj;\n};\n"]}

package/lib/esm/index.d.ts

@@ -0,0 +1,3 @@
+export { pageViewTrackingPlugin } from './page-view-tracking';
+export * as Types from './typings/page-view-tracking';
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,KAAK,KAAK,MAAM,8BAA8B,CAAC"}

package/lib/esm/index.js

@@ -0,0 +1,4 @@
+export { pageViewTrackingPlugin } from './page-view-tracking';
+import * as Types_1 from './typings/page-view-tracking';
+export { Types_1 as Types };
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;yBACvC,8BAA8B;oBAAzC,KAAK","sourcesContent":["export { pageViewTrackingPlugin } from './page-view-tracking';\nexport * as Types from './typings/page-view-tracking';\n"]}

package/lib/esm/page-view-tracking.d.ts

@@ -0,0 +1,5 @@
+import { BrowserClient, EnrichmentPlugin } from '@amplitude/analytics-types';
+import { Options } from './typings/page-view-tracking';
+export declare const pageViewTrackingPlugin: (client: BrowserClient, options?: Options) => EnrichmentPlugin;
+export declare const shouldTrackHistoryPageView: (trackingOption: Options['trackHistoryChanges'], newURL: string, oldURL: string) => boolean;
+//# sourceMappingURL=page-view-tracking.d.ts.map

package/lib/esm/page-view-tracking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.d.ts","sourceRoot":"","sources":["../../src/page-view-tracking.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,aAAa,EAEb,gBAAgB,EAMjB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAGvD,eAAO,MAAM,sBAAsB,WAAY,aAAa,YAAW,OAAO,KAAQ,gBAoFrF,CAAC;AA8BF,eAAO,MAAM,0BAA0B,mBACrB,OAAO,CAAC,qBAAqB,CAAC,UACtC,MAAM,UACN,MAAM,KACb,OAOF,CAAC"}

package/lib/esm/page-view-tracking.js

@@ -0,0 +1,147 @@
+import { __assign, __awaiter, __generator, __read, __spreadArray } from "tslib";
+import { CampaignParser } from '@amplitude/analytics-client-common';
+import { IdentifyOperation, PluginType, } from '@amplitude/analytics-types';
+import { BASE_CAMPAIGN } from '@amplitude/analytics-client-common';
+import { omitUndefined } from './utils';
+export var pageViewTrackingPlugin = function (client, options) {
+    if (options === void 0) { options = {}; }
+    var loggerProvider = undefined;
+    var shouldTrackOnPageLoad = function () {
+        return typeof options.trackOn === 'undefined' || (typeof options.trackOn === 'function' && options.trackOn());
+    };
+    var previousURL = null;
+    var trackHistoryPageView = function () { return __awaiter(void 0, void 0, void 0, function () {
+        var newURL, _a, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    newURL = location.href;
+                    if (!(shouldTrackHistoryPageView(options.trackHistoryChanges, newURL, previousURL || '') && shouldTrackOnPageLoad())) return [3 /*break*/, 2];
+                    /* istanbul ignore next */
+                    loggerProvider === null || loggerProvider === void 0 ? void 0 : loggerProvider.log('Tracking page view event');
+                    _b = (_a = client).track;
+                    return [4 /*yield*/, createPageViewEvent()];
+                case 1:
+                    _b.apply(_a, [_c.sent()]);
+                    _c.label = 2;
+                case 2:
+                    previousURL = newURL;
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+    var plugin = {
+        name: 'page-view-tracking',
+        type: PluginType.ENRICHMENT,
+        setup: function (config) { return __awaiter(void 0, void 0, void 0, function () {
+            var _a, _b;
+            var _c, _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        loggerProvider = config.loggerProvider;
+                        loggerProvider.log('Installing @amplitude/plugin-page-view-tracking-browser');
+                        options.trackOn = ((_c = config.attribution) === null || _c === void 0 ? void 0 : _c.trackPageViews) ? 'attribution' : options.trackOn;
+                        // Turn off sending page view event by "runAttributionStrategy" function
+                        if ((_d = config.attribution) === null || _d === void 0 ? void 0 : _d.trackPageViews) {
+                            loggerProvider.warn('@amplitude/plugin-page-view-tracking-browser overrides page view tracking behavior defined in @amplitude/analytics-browser');
+                            config.attribution.trackPageViews = false;
+                        }
+                        if (options.trackHistoryChanges) {
+                            /* istanbul ignore next */
+                            window.addEventListener('popstate', function () {
+                                void trackHistoryPageView();
+                            });
+                            /* istanbul ignore next */
+                            // There is no global browser listener for changes to history, so we have
+                            // to modify pushState directly.
+                            // https://stackoverflow.com/a/64927639
+                            // eslint-disable-next-line @typescript-eslint/unbound-method
+                            window.history.pushState = new Proxy(window.history.pushState, {
+                                apply: function (target, thisArg, _a) {
+                                    var _b = __read(_a, 3), state = _b[0], unused = _b[1], url = _b[2];
+                                    void trackHistoryPageView();
+                                    return target.apply(thisArg, [state, unused, url]);
+                                },
+                            });
+                        }
+                        if (!shouldTrackOnPageLoad()) return [3 /*break*/, 2];
+                        loggerProvider.log('Tracking page view event');
+                        _b = (_a = client).track;
+                        return [4 /*yield*/, createPageViewEvent()];
+                    case 1:
+                        _b.apply(_a, [_e.sent()]);
+                        _e.label = 2;
+                    case 2: return [2 /*return*/];
+                }
+            });
+        }); },
+        execute: function (event) { return __awaiter(void 0, void 0, void 0, function () {
+            var pageViewEvent;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!(options.trackOn === 'attribution' && isCampaignEvent(event))) return [3 /*break*/, 2];
+                        /* istanbul ignore next */ // loggerProvider should be defined by the time execute is invoked
+                        loggerProvider === null || loggerProvider === void 0 ? void 0 : loggerProvider.log('Enriching campaign event to page view event with campaign parameters');
+                        return [4 /*yield*/, createPageViewEvent()];
+                    case 1:
+                        pageViewEvent = _a.sent();
+                        event.event_type = pageViewEvent.event_type;
+                        event.event_properties = __assign(__assign({}, event.event_properties), pageViewEvent.event_properties);
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, event];
+                }
+            });
+        }); },
+    };
+    // Required for unit tests
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    plugin.__trackHistoryPageView = trackHistoryPageView;
+    return plugin;
+};
+var getCampaignParams = function () { return __awaiter(void 0, void 0, void 0, function () { var _a; return __generator(this, function (_b) {
+    switch (_b.label) {
+        case 0:
+            _a = omitUndefined;
+            return [4 /*yield*/, new CampaignParser().parse()];
+        case 1: return [2 /*return*/, _a.apply(void 0, [_b.sent()])];
+    }
+}); }); };
+var createPageViewEvent = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var pageViewEvent, _a;
+    var _b;
+    return __generator(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                _b = {
+                    event_type: 'Page View'
+                };
+                _a = [{}];
+                return [4 /*yield*/, getCampaignParams()];
+            case 1:
+                pageViewEvent = (_b.event_properties = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_c.sent())])), { page_domain: /* istanbul ignore next */ (typeof location !== 'undefined' && location.hostname) || '', page_location: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href) || '', page_path: /* istanbul ignore next */ (typeof location !== 'undefined' && location.pathname) || '', page_title: /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '', page_url: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href.split('?')[0]) || '' }]),
+                    _b);
+                return [2 /*return*/, pageViewEvent];
+        }
+    });
+}); };
+var isCampaignEvent = function (event) {
+    if (event.event_type === '$identify' && event.user_properties) {
+        var properties = event.user_properties;
+        var $set = properties[IdentifyOperation.SET] || {};
+        var $unset = properties[IdentifyOperation.UNSET] || {};
+        var userProperties_1 = __spreadArray(__spreadArray([], __read(Object.keys($set)), false), __read(Object.keys($unset)), false);
+        return Object.keys(BASE_CAMPAIGN).every(function (value) { return userProperties_1.includes(value); });
+    }
+    return false;
+};
+export var shouldTrackHistoryPageView = function (trackingOption, newURL, oldURL) {
+    switch (trackingOption) {
+        case 'pathOnly':
+            return newURL.split('?')[0] !== oldURL.split('?')[0];
+        default:
+            return newURL !== oldURL;
+    }
+};
+//# sourceMappingURL=page-view-tracking.js.map

package/lib/esm/page-view-tracking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.js","sourceRoot":"","sources":["../../src/page-view-tracking.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAML,iBAAiB,EAGjB,UAAU,GACX,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,CAAC,IAAM,sBAAsB,GAAG,UAAC,MAAqB,EAAE,OAAqB;IAArB,wBAAA,EAAA,YAAqB;IACjF,IAAI,cAAc,GAAuB,SAAS,CAAC;IAEnD,IAAM,qBAAqB,GAAG;QAC5B,OAAA,OAAO,OAAO,CAAC,OAAO,KAAK,WAAW,IAAI,CAAC,OAAO,OAAO,CAAC,OAAO,KAAK,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAAtG,CAAsG,CAAC;IAEzG,IAAI,WAAW,GAAkB,IAAI,CAAC;IAEtC,IAAM,oBAAoB,GAAG;;;;;oBACrB,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC;yBAEzB,CAAA,0BAA0B,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC,IAAI,qBAAqB,EAAE,CAAA,EAA7G,wBAA6G;oBAC/G,0BAA0B;oBAC1B,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,GAAG,CAAC,0BAA0B,CAAC,CAAC;oBAChD,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,KAAK,CAAA;oBAAC,qBAAM,mBAAmB,EAAE,EAAA;;oBAAxC,cAAa,SAA2B,EAAC,CAAC;;;oBAE5C,WAAW,GAAG,MAAM,CAAC;;;;SACtB,CAAC;IAEF,IAAM,MAAM,GAAG;QACb,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,UAAU,CAAC,UAAmB;QAEpC,KAAK,EAAE,UAAO,MAAqB;;;;;;wBACjC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;wBACvC,cAAc,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAC;wBAE9E,OAAO,CAAC,OAAO,GAAG,CAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,cAAc,EAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;wBAEvF,wEAAwE;wBACxE,IAAI,MAAA,MAAM,CAAC,WAAW,0CAAE,cAAc,EAAE;4BACtC,cAAc,CAAC,IAAI,CACjB,4HAA4H,CAC7H,CAAC;4BACF,MAAM,CAAC,WAAW,CAAC,cAAc,GAAG,KAAK,CAAC;yBAC3C;wBAED,IAAI,OAAO,CAAC,mBAAmB,EAAE;4BAC/B,0BAA0B;4BAC1B,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE;gCAClC,KAAK,oBAAoB,EAAE,CAAC;4BAC9B,CAAC,CAAC,CAAC;4BAEH,0BAA0B;4BAC1B,yEAAyE;4BACzE,gCAAgC;4BAChC,uCAAuC;4BACvC,6DAA6D;4BAC7D,MAAM,CAAC,OAAO,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE;gCAC7D,KAAK,EAAE,UAAC,MAAM,EAAE,OAAO,EAAE,EAAoB;wCAApB,KAAA,aAAoB,EAAnB,KAAK,QAAA,EAAE,MAAM,QAAA,EAAE,GAAG,QAAA;oCAC1C,KAAK,oBAAoB,EAAE,CAAC;oCAE5B,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;gCACrD,CAAC;6BACF,CAAC,CAAC;yBACJ;6BAEG,qBAAqB,EAAE,EAAvB,wBAAuB;wBACzB,cAAc,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;wBAE/C,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,KAAK,CAAA;wBAAC,qBAAM,mBAAmB,EAAE,EAAA;;wBAAxC,cAAa,SAA2B,EAAC,CAAC;;;;;aAE7C;QAED,OAAO,EAAE,UAAO,KAAY;;;;;6BACtB,CAAA,OAAO,CAAC,OAAO,KAAK,aAAa,IAAI,eAAe,CAAC,KAAK,CAAC,CAAA,EAA3D,wBAA2D;wBAC7D,0BAA0B,CAAC,kEAAkE;wBAC7F,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,GAAG,CAAC,sEAAsE,CAAC,CAAC;wBACtE,qBAAM,mBAAmB,EAAE,EAAA;;wBAA3C,aAAa,GAAG,SAA2B;wBACjD,KAAK,CAAC,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC;wBAC5C,KAAK,CAAC,gBAAgB,yBACjB,KAAK,CAAC,gBAAgB,GACtB,aAAa,CAAC,gBAAgB,CAClC,CAAC;;4BAEJ,sBAAO,KAAK,EAAC;;;aACd;KACF,CAAC;IAEF,0BAA0B;IAC1B,sEAAsE;IACrE,MAAc,CAAC,sBAAsB,GAAG,oBAAoB,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,IAAM,iBAAiB,GAAG;;;YAAY,KAAA,aAAa,CAAA;YAAC,qBAAM,IAAI,cAAc,EAAE,CAAC,KAAK,EAAE,EAAA;gBAAhD,sBAAA,kBAAc,SAAkC,EAAC,EAAA;;SAAA,CAAC;AAExF,IAAM,mBAAmB,GAAG;;;;;;;oBAExB,UAAU,EAAE,WAAW;;;gBAEjB,qBAAM,iBAAiB,EAAE,EAAA;;gBAH3B,aAAa,IAEjB,mBAAgB,6DACX,CAAC,SAAyB,CAAC,OAC9B,WAAW,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EACpG,aAAa,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAClG,SAAS,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EAClG,UAAU,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAChG,QAAQ,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAC5G;uBACF;gBACD,sBAAO,aAAa,EAAC;;;KACtB,CAAC;AAEF,IAAM,eAAe,GAAG,UAAC,KAAY;IACnC,IAAI,KAAK,CAAC,UAAU,KAAK,WAAW,IAAI,KAAK,CAAC,eAAe,EAAE;QAC7D,IAAM,UAAU,GAAG,KAAK,CAAC,eAAyC,CAAC;QACnE,IAAM,IAAI,GAAG,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACrD,IAAM,MAAM,GAAG,UAAU,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACzD,IAAM,gBAAc,0CAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAC,CAAC;QACtE,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,UAAC,KAAK,IAAK,OAAA,gBAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,EAA9B,CAA8B,CAAC,CAAC;KACpF;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,0BAA0B,GAAG,UACxC,cAA8C,EAC9C,MAAc,EACd,MAAc;IAEd,QAAQ,cAAc,EAAE;QACtB,KAAK,UAAU;YACb,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD;YACE,OAAO,MAAM,KAAK,MAAM,CAAC;KAC5B;AACH,CAAC,CAAC","sourcesContent":["import { CampaignParser } from '@amplitude/analytics-client-common';\nimport {\n  BaseEvent,\n  BrowserClient,\n  BrowserConfig,\n  EnrichmentPlugin,\n  Event,\n  IdentifyOperation,\n  IdentifyUserProperties,\n  Logger,\n  PluginType,\n} from '@amplitude/analytics-types';\nimport { BASE_CAMPAIGN } from '@amplitude/analytics-client-common';\nimport { Options } from './typings/page-view-tracking';\nimport { omitUndefined } from './utils';\n\nexport const pageViewTrackingPlugin = (client: BrowserClient, options: Options = {}): EnrichmentPlugin => {\n  let loggerProvider: Logger | undefined = undefined;\n\n  const shouldTrackOnPageLoad = () =>\n    typeof options.trackOn === 'undefined' || (typeof options.trackOn === 'function' && options.trackOn());\n\n  let previousURL: string | null = null;\n\n  const trackHistoryPageView = async (): Promise<void> => {\n    const newURL = location.href;\n\n    if (shouldTrackHistoryPageView(options.trackHistoryChanges, newURL, previousURL || '') && shouldTrackOnPageLoad()) {\n      /* istanbul ignore next */\n      loggerProvider?.log('Tracking page view event');\n      client.track(await createPageViewEvent());\n    }\n    previousURL = newURL;\n  };\n\n  const plugin = {\n    name: 'page-view-tracking',\n    type: PluginType.ENRICHMENT as const,\n\n    setup: async (config: BrowserConfig) => {\n      loggerProvider = config.loggerProvider;\n      loggerProvider.log('Installing @amplitude/plugin-page-view-tracking-browser');\n\n      options.trackOn = config.attribution?.trackPageViews ? 'attribution' : options.trackOn;\n\n      // Turn off sending page view event by \"runAttributionStrategy\" function\n      if (config.attribution?.trackPageViews) {\n        loggerProvider.warn(\n          '@amplitude/plugin-page-view-tracking-browser overrides page view tracking behavior defined in @amplitude/analytics-browser',\n        );\n        config.attribution.trackPageViews = false;\n      }\n\n      if (options.trackHistoryChanges) {\n        /* istanbul ignore next */\n        window.addEventListener('popstate', () => {\n          void trackHistoryPageView();\n        });\n\n        /* istanbul ignore next */\n        // There is no global browser listener for changes to history, so we have\n        // to modify pushState directly.\n        // https://stackoverflow.com/a/64927639\n        // eslint-disable-next-line @typescript-eslint/unbound-method\n        window.history.pushState = new Proxy(window.history.pushState, {\n          apply: (target, thisArg, [state, unused, url]) => {\n            void trackHistoryPageView();\n\n            return target.apply(thisArg, [state, unused, url]);\n          },\n        });\n      }\n\n      if (shouldTrackOnPageLoad()) {\n        loggerProvider.log('Tracking page view event');\n\n        client.track(await createPageViewEvent());\n      }\n    },\n\n    execute: async (event: Event) => {\n      if (options.trackOn === 'attribution' && isCampaignEvent(event)) {\n        /* istanbul ignore next */ // loggerProvider should be defined by the time execute is invoked\n        loggerProvider?.log('Enriching campaign event to page view event with campaign parameters');\n        const pageViewEvent = await createPageViewEvent();\n        event.event_type = pageViewEvent.event_type;\n        event.event_properties = {\n          ...event.event_properties,\n          ...pageViewEvent.event_properties,\n        };\n      }\n      return event;\n    },\n  };\n\n  // Required for unit tests\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n  (plugin as any).__trackHistoryPageView = trackHistoryPageView;\n\n  return plugin;\n};\n\nconst getCampaignParams = async () => omitUndefined(await new CampaignParser().parse());\n\nconst createPageViewEvent = async (): Promise<Event> => {\n  const pageViewEvent: BaseEvent = {\n    event_type: 'Page View',\n    event_properties: {\n      ...(await getCampaignParams()),\n      page_domain: /* istanbul ignore next */ (typeof location !== 'undefined' && location.hostname) || '',\n      page_location: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href) || '',\n      page_path: /* istanbul ignore next */ (typeof location !== 'undefined' && location.pathname) || '',\n      page_title: /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '',\n      page_url: /* istanbul ignore next */ (typeof location !== 'undefined' && location.href.split('?')[0]) || '',\n    },\n  };\n  return pageViewEvent;\n};\n\nconst isCampaignEvent = (event: Event) => {\n  if (event.event_type === '$identify' && event.user_properties) {\n    const properties = event.user_properties as IdentifyUserProperties;\n    const $set = properties[IdentifyOperation.SET] || {};\n    const $unset = properties[IdentifyOperation.UNSET] || {};\n    const userProperties = [...Object.keys($set), ...Object.keys($unset)];\n    return Object.keys(BASE_CAMPAIGN).every((value) => userProperties.includes(value));\n  }\n  return false;\n};\n\nexport const shouldTrackHistoryPageView = (\n  trackingOption: Options['trackHistoryChanges'],\n  newURL: string,\n  oldURL: string,\n): boolean => {\n  switch (trackingOption) {\n    case 'pathOnly':\n      return newURL.split('?')[0] !== oldURL.split('?')[0];\n    default:\n      return newURL !== oldURL;\n  }\n};\n"]}

package/lib/esm/typings/page-view-tracking.d.ts

@@ -0,0 +1,7 @@
+export interface Options {
+    trackOn?: PageTrackingTrackOn;
+    trackHistoryChanges?: PageTrackingHistoryChanges;
+}
+export declare type PageTrackingTrackOn = 'attribution' | (() => boolean);
+export declare type PageTrackingHistoryChanges = 'all' | 'pathOnly';
+//# sourceMappingURL=page-view-tracking.d.ts.map

package/lib/esm/typings/page-view-tracking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.d.ts","sourceRoot":"","sources":["../../../src/typings/page-view-tracking.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;CAClD;AAED,oBAAY,mBAAmB,GAAG,aAAa,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;AAElE,oBAAY,0BAA0B,GAAG,KAAK,GAAG,UAAU,CAAC"}

package/lib/esm/typings/page-view-tracking.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=page-view-tracking.js.map

package/lib/esm/typings/page-view-tracking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view-tracking.js","sourceRoot":"","sources":["../../../src/typings/page-view-tracking.ts"],"names":[],"mappings":"","sourcesContent":["export interface Options {\n  trackOn?: PageTrackingTrackOn;\n  trackHistoryChanges?: PageTrackingHistoryChanges;\n}\n\nexport type PageTrackingTrackOn = 'attribution' | (() => boolean);\n\nexport type PageTrackingHistoryChanges = 'all' | 'pathOnly';\n"]}

package/lib/esm/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const omitUndefined: (input: Record<string, string | undefined>) => Record<string, string>;
+//# sourceMappingURL=utils.d.ts.map

package/lib/esm/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,UAAW,OAAO,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,2BAStE,CAAC"}

package/lib/esm/utils.js

@@ -0,0 +1,11 @@
+export var omitUndefined = function (input) {
+    var obj = {};
+    for (var key in input) {
+        var val = input[key];
+        if (val) {
+            obj[key] = val;
+        }
+    }
+    return obj;
+};
+//# sourceMappingURL=utils.js.map

package/lib/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,KAAyC;IACrE,IAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,KAAK,IAAM,GAAG,IAAI,KAAK,EAAE;QACvB,IAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,GAAG,EAAE;YACP,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SAChB;KACF;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC","sourcesContent":["export const omitUndefined = (input: Record<string, string | undefined>) => {\n  const obj: Record<string, string> = {};\n  for (const key in input) {\n    const val = input[key];\n    if (val) {\n      obj[key] = val;\n    }\n  }\n  return obj;\n};\n"]}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@amplitude/plugin-page-view-tracking-browser",
+  "version": "0.3.1",
+  "description": "",
+  "author": "Amplitude Inc",
+  "homepage": "https://github.com/amplitude/Amplitude-TypeScript",
+  "license": "MIT",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "types": "lib/esm/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/amplitude/Amplitude-TypeScript.git"
+  },
+  "scripts": {
+    "build": "yarn build:es5 && yarn build:esm",
+    "build:es5": "tsc -p ./tsconfig.es5.json",
+    "build:esm": "tsc -p ./tsconfig.esm.json",
+    "clean": "rimraf node_modules lib coverage",
+    "fix": "yarn fix:eslint & yarn fix:prettier",
+    "fix:eslint": "eslint '{src,test}/**/*.ts' --fix",
+    "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
+    "lint": "yarn lint:eslint & yarn lint:prettier",
+    "lint:eslint": "eslint '{src,test}/**/*.ts'",
+    "lint:prettier": "prettier --check \"{src,test}/**/*.ts\"",
+    "test": "jest",
+    "typecheck": "tsc -p ./tsconfig.json"
+  },
+  "bugs": {
+    "url": "https://github.com/amplitude/Amplitude-TypeScript/issues"
+  },
+  "dependencies": {
+    "@amplitude/analytics-browser": "^1.5.0",
+    "@amplitude/analytics-client-common": "^0.2.1",
+    "@amplitude/analytics-types": "^0.10.2",
+    "tslib": "^2.3.1"
+  },
+  "files": [
+    "lib"
+  ],
+  "gitHead": "d5d22e7f4f52d5ed816cd473acc4c9e57a9e61dd"
+}