@amplitude/plugin-web-attribution-browser 0.1.3

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 { webAttributionPlugin } from './web-attribution';
+export * as Types from './typings/web-attribution';
+//# 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,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Types = exports.webAttributionPlugin = void 0;
+var tslib_1 = require("tslib");
+var web_attribution_1 = require("./web-attribution");
+Object.defineProperty(exports, "webAttributionPlugin", { enumerable: true, get: function () { return web_attribution_1.webAttributionPlugin; } });
+exports.Types = (0, tslib_1.__importStar)(require("./typings/web-attribution"));
+//# 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,qDAAyD;AAAhD,uHAAA,oBAAoB,OAAA;AAC7B,gFAAmD","sourcesContent":["export { webAttributionPlugin } from './web-attribution';\nexport * as Types from './typings/web-attribution';\n"]}

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

@@ -0,0 +1,69 @@
+import { AttributionOptions, Campaign } from '@amplitude/analytics-types';
+import { CampaignTracker } from '@amplitude/analytics-client-common';
+import { Storage } from '@amplitude/analytics-types';
+export declare class PluginCampaignTracker {
+    campaignTracker: CampaignTracker;
+    constructor(apiKey: string, storage: Storage<Campaign>, options: AttributionOptions);
+    createCampaignEvent(currentCampaign: Campaign): {
+        event_type: string;
+        event_properties?: {
+            [key: string]: any;
+        } | undefined;
+        user_properties: import("@amplitude/analytics-types").IdentifyUserProperties | {
+            [key: string]: any;
+        } | {
+            [x: string]: any;
+        };
+        group_properties?: {
+            [key: string]: any;
+        } | undefined;
+        groups?: {
+            [key: string]: any;
+        } | undefined;
+        user_id?: string | undefined;
+        device_id?: string | undefined;
+        time?: number | undefined;
+        location_lat?: number | undefined;
+        location_lng?: number | undefined;
+        app_version?: string | undefined;
+        version_name?: string | undefined;
+        library?: string | undefined;
+        platform?: string | undefined;
+        os_name?: string | undefined;
+        os_version?: string | undefined;
+        device_brand?: string | undefined;
+        device_manufacturer?: string | undefined;
+        device_model?: string | undefined;
+        carrier?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        city?: string | undefined;
+        dma?: string | undefined;
+        idfa?: string | undefined;
+        idfv?: string | undefined;
+        adid?: string | undefined;
+        android_id?: string | undefined;
+        language?: string | undefined;
+        ip?: string | undefined;
+        price?: number | undefined;
+        quantity?: number | undefined;
+        revenue?: number | undefined;
+        productId?: string | undefined;
+        revenueType?: string | undefined;
+        event_id?: number | undefined;
+        session_id?: number | undefined;
+        insert_id?: string | undefined;
+        plan?: import("@amplitude/analytics-types").Plan | undefined;
+        ingestion_metadata?: import("@amplitude/analytics-types/lib/esm/ingestion-metadata").IngestionMetadataEventProperty | undefined;
+        partner_id?: string | undefined;
+        extra?: {
+            [key: string]: any;
+        } | undefined;
+    };
+    onPageChange(callback: (state: {
+        isNewCampaign: boolean;
+        currentCampaign: Campaign;
+    }) => Promise<unknown>): Promise<void>;
+    private getCurrentState;
+}
+//# sourceMappingURL=plugin-campaign-tracker.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-campaign-tracker.d.ts","sourceRoot":"","sources":["../../src/plugin-campaign-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAErD,qBAAa,qBAAqB;IAChC,eAAe,EAAE,eAAe,CAAC;gBAErB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,kBAAkB;IAUnF,mBAAmB,CAAC,eAAe,EAAE,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIvC,YAAY,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,aAAa,EAAE,OAAO,CAAC;QAAC,eAAe,EAAE,QAAQ,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC;YASjG,eAAe;CAW9B"}

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

@@ -0,0 +1,58 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginCampaignTracker = void 0;
+var tslib_1 = require("tslib");
+var analytics_client_common_1 = require("@amplitude/analytics-client-common");
+var PluginCampaignTracker = /** @class */ (function () {
+    function PluginCampaignTracker(apiKey, storage, options) {
+        this.campaignTracker = new analytics_client_common_1.CampaignTracker(apiKey, (0, tslib_1.__assign)((0, tslib_1.__assign)({}, options), { trackPageViews: false, track: /* istanbul ignore next */ function () { return Promise.resolve(); }, onNewCampaign: /* istanbul ignore next */ function () { return function () { return undefined; }; }, storage: storage }));
+    }
+    PluginCampaignTracker.prototype.createCampaignEvent = function (currentCampaign) {
+        return this.campaignTracker.createCampaignEvent(currentCampaign);
+    };
+    PluginCampaignTracker.prototype.onPageChange = function (callback) {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            var _a, currentState;
+            return (0, tslib_1.__generator)(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = callback;
+                        return [4 /*yield*/, this.getCurrentState()];
+                    case 1: return [4 /*yield*/, _a.apply(void 0, [_b.sent()])];
+                    case 2:
+                        _b.sent();
+                        return [4 /*yield*/, this.getCurrentState()];
+                    case 3:
+                        currentState = _b.sent();
+                        if (currentState.isNewCampaign) {
+                            void this.campaignTracker.saveCampaignToStorage(currentState.currentCampaign);
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    PluginCampaignTracker.prototype.getCurrentState = function () {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            var currentCampaign, isNewCampaign, _a, _b, _c;
+            return (0, tslib_1.__generator)(this, function (_d) {
+                switch (_d.label) {
+                    case 0: return [4 /*yield*/, this.campaignTracker.parser.parse()];
+                    case 1:
+                        currentCampaign = _d.sent();
+                        _b = (_a = this.campaignTracker).isNewCampaign;
+                        _c = [currentCampaign];
+                        return [4 /*yield*/, this.campaignTracker.getCampaignFromStorage()];
+                    case 2:
+                        isNewCampaign = _b.apply(_a, _c.concat([_d.sent()]));
+                        return [2 /*return*/, {
+                                isNewCampaign: isNewCampaign,
+                                currentCampaign: currentCampaign,
+                            }];
+                }
+            });
+        });
+    };
+    return PluginCampaignTracker;
+}());
+exports.PluginCampaignTracker = PluginCampaignTracker;
+//# sourceMappingURL=plugin-campaign-tracker.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-campaign-tracker.js","sourceRoot":"","sources":["../../src/plugin-campaign-tracker.ts"],"names":[],"mappings":";;;AACA,8EAAqE;AAGrE;IAGE,+BAAY,MAAc,EAAE,OAA0B,EAAE,OAA2B;QACjF,IAAI,CAAC,eAAe,GAAG,IAAI,yCAAe,CAAC,MAAM,kDAC5C,OAAO,KACV,cAAc,EAAE,KAAK,EACrB,KAAK,EAAE,0BAA0B,CAAC,cAAM,OAAA,OAAO,CAAC,OAAO,EAAE,EAAjB,CAAiB,EACzD,aAAa,EAAE,0BAA0B,CAAC,cAAM,OAAA,cAAM,OAAA,SAAS,EAAT,CAAS,EAAf,CAAe,EAC/D,OAAO,SAAA,IACP,CAAC;IACL,CAAC;IAED,mDAAmB,GAAnB,UAAoB,eAAyB;QAC3C,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IACnE,CAAC;IAEK,4CAAY,GAAlB,UAAmB,QAA4F;;;;;;wBACvG,KAAA,QAAQ,CAAA;wBAAC,qBAAM,IAAI,CAAC,eAAe,EAAE,EAAA;4BAA3C,qBAAM,kBAAS,SAA4B,EAAC,EAAA;;wBAA5C,SAA4C,CAAC;wBAExB,qBAAM,IAAI,CAAC,eAAe,EAAE,EAAA;;wBAA3C,YAAY,GAAG,SAA4B;wBACjD,IAAI,YAAY,CAAC,aAAa,EAAE;4BAC9B,KAAK,IAAI,CAAC,eAAe,CAAC,qBAAqB,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;yBAC/E;;;;;KACF;IAEa,+CAAe,GAA7B;;;;;4BAC0B,qBAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,EAAA;;wBAA3D,eAAe,GAAG,SAAyC;wBAC3C,KAAA,CAAA,KAAA,IAAI,CAAC,eAAe,CAAA,CAAC,aAAa,CAAA;8BACtD,eAAe;wBACf,qBAAM,IAAI,CAAC,eAAe,CAAC,sBAAsB,EAAE,EAAA;;wBAF/C,aAAa,GAAG,wBAEpB,SAAmD,GACpD;wBACD,sBAAO;gCACL,aAAa,eAAA;gCACb,eAAe,iBAAA;6BAChB,EAAC;;;;KACH;IACH,4BAAC;AAAD,CAAC,AArCD,IAqCC;AArCY,sDAAqB","sourcesContent":["import { AttributionOptions, Campaign } from '@amplitude/analytics-types';\nimport { CampaignTracker } from '@amplitude/analytics-client-common';\nimport { Storage } from '@amplitude/analytics-types';\n\nexport class PluginCampaignTracker {\n  campaignTracker: CampaignTracker;\n\n  constructor(apiKey: string, storage: Storage<Campaign>, options: AttributionOptions) {\n    this.campaignTracker = new CampaignTracker(apiKey, {\n      ...options,\n      trackPageViews: false,\n      track: /* istanbul ignore next */ () => Promise.resolve(),\n      onNewCampaign: /* istanbul ignore next */ () => () => undefined,\n      storage,\n    });\n  }\n\n  createCampaignEvent(currentCampaign: Campaign) {\n    return this.campaignTracker.createCampaignEvent(currentCampaign);\n  }\n\n  async onPageChange(callback: (state: { isNewCampaign: boolean; currentCampaign: Campaign }) => Promise<unknown>) {\n    await callback(await this.getCurrentState());\n\n    const currentState = await this.getCurrentState();\n    if (currentState.isNewCampaign) {\n      void this.campaignTracker.saveCampaignToStorage(currentState.currentCampaign);\n    }\n  }\n\n  private async getCurrentState() {\n    const currentCampaign = await this.campaignTracker.parser.parse();\n    const isNewCampaign = this.campaignTracker.isNewCampaign(\n      currentCampaign,\n      await this.campaignTracker.getCampaignFromStorage(),\n    );\n    return {\n      isNewCampaign,\n      currentCampaign,\n    };\n  }\n}\n"]}

package/lib/cjs/typings/web-attribution.d.ts

@@ -0,0 +1,7 @@
+export interface Options {
+    disabled?: boolean;
+    excludeReferrers?: string[];
+    initialEmptyValue?: string;
+    resetSessionOnNewCampaign?: boolean;
+}
+//# sourceMappingURL=web-attribution.d.ts.map

package/lib/cjs/typings/web-attribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.d.ts","sourceRoot":"","sources":["../../../src/typings/web-attribution.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC"}

package/lib/cjs/typings/web-attribution.js

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

package/lib/cjs/typings/web-attribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../../src/typings/web-attribution.ts"],"names":[],"mappings":"","sourcesContent":["export interface Options {\n  disabled?: boolean;\n  excludeReferrers?: string[];\n  initialEmptyValue?: string;\n  resetSessionOnNewCampaign?: boolean;\n}\n"]}

package/lib/cjs/web-attribution.d.ts

@@ -0,0 +1,4 @@
+import { BeforePlugin, BrowserClient } from '@amplitude/analytics-types';
+import { Options } from './typings/web-attribution';
+export declare const webAttributionPlugin: (client: BrowserClient, options?: Options) => BeforePlugin;
+//# sourceMappingURL=web-attribution.d.ts.map

package/lib/cjs/web-attribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.d.ts","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,aAAa,EAMd,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEpD,eAAO,MAAM,oBAAoB,WAAY,aAAa,YAAW,OAAO,KAAQ,YAsClF,CAAC"}

package/lib/cjs/web-attribution.js

@@ -0,0 +1,53 @@
+var _this = this;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webAttributionPlugin = void 0;
+var tslib_1 = require("tslib");
+var analytics_types_1 = require("@amplitude/analytics-types");
+var plugin_campaign_tracker_1 = require("./plugin-campaign-tracker");
+var webAttributionPlugin = function (client, options) {
+    if (options === void 0) { options = {}; }
+    return ({
+        name: 'web-attribution',
+        type: analytics_types_1.PluginType.BEFORE,
+        setup: function (config) { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
+            var storage, campaignTracker;
+            var _this = this;
+            var _a;
+            return (0, tslib_1.__generator)(this, function (_b) {
+                config.loggerProvider.log('Installing @amplitude/plugin-web-attribution-browser');
+                // Disable "runAttributionStrategy" function
+                if (!((_a = config.attribution) === null || _a === void 0 ? void 0 : _a.disabled)) {
+                    config.loggerProvider.warn('@amplitude/plugin-web-attribution-browser overrides web attribution behavior defined in @amplitude/analytics-browser');
+                    config.attribution = {
+                        disabled: true,
+                    };
+                }
+                storage = config.cookieStorage;
+                campaignTracker = new plugin_campaign_tracker_1.PluginCampaignTracker(config.apiKey, storage, (0, tslib_1.__assign)({}, options));
+                // Web Attribution tracking
+                void campaignTracker.onPageChange(function (_a) {
+                    var isNewCampaign = _a.isNewCampaign, currentCampaign = _a.currentCampaign;
+                    return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () {
+                        return (0, tslib_1.__generator)(this, function (_b) {
+                            if (isNewCampaign) {
+                                if (options.resetSessionOnNewCampaign) {
+                                    client.setSessionId(Date.now());
+                                    config.loggerProvider.log('Created a new session for new campaign');
+                                }
+                                config.loggerProvider.log('Tracking new campaign event');
+                                void client.track(campaignTracker.createCampaignEvent(currentCampaign));
+                            }
+                            return [2 /*return*/];
+                        });
+                    });
+                });
+                return [2 /*return*/];
+            });
+        }); },
+        execute: function (event) { return (0, tslib_1.__awaiter)(_this, void 0, void 0, function () { return (0, tslib_1.__generator)(this, function (_a) {
+            return [2 /*return*/, event];
+        }); }); },
+    });
+};
+exports.webAttributionPlugin = webAttributionPlugin;
+//# sourceMappingURL=web-attribution.js.map

package/lib/cjs/web-attribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":"AAAA,iBAmDA;;;;AAnDA,8DAQoC;AACpC,qEAAkE;AAG3D,IAAM,oBAAoB,GAAG,UAAC,MAAqB,EAAE,OAAqB;IAArB,wBAAA,EAAA,YAAqB;IAAmB,OAAA,CAAC;QACnG,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,4BAAU,CAAC,MAAM;QAEvB,KAAK,EAAE,UAAO,MAAqB;;;;;gBACjC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,sDAAsD,CAAC,CAAC;gBAElF,4CAA4C;gBAC5C,IAAI,CAAC,CAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,QAAQ,CAAA,EAAE;oBACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CACxB,sHAAsH,CACvH,CAAC;oBACF,MAAM,CAAC,WAAW,GAAG;wBACnB,QAAQ,EAAE,IAAI;qBACf,CAAC;iBACH;gBAGK,OAAO,GAAG,MAAM,CAAC,aAA6C,CAAC;gBAE/D,eAAe,GAAG,IAAI,+CAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,4BACnE,OAAO,EACV,CAAC;gBAEH,2BAA2B;gBAC3B,KAAK,eAAe,CAAC,YAAY,CAAC,UAAO,EAAkC;wBAAhC,aAAa,mBAAA,EAAE,eAAe,qBAAA;;;4BACvE,IAAI,aAAa,EAAE;gCACjB,IAAI,OAAO,CAAC,yBAAyB,EAAE;oCACrC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oCAChC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;iCACrE;gCACD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;gCACzD,KAAK,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;6BACzE;;;;iBACF,CAAC,CAAC;;;aACJ;QAED,OAAO,EAAE,UAAO,KAAY;YAAK,sBAAA,KAAK,EAAA;iBAAA;KACvC,CAAC;AAtCkG,CAsClG,CAAC;AAtCU,QAAA,oBAAoB,wBAsC9B","sourcesContent":["import {\n  BeforePlugin,\n  BrowserClient,\n  BrowserConfig,\n  Campaign,\n  Event,\n  PluginType,\n  Storage,\n} from '@amplitude/analytics-types';\nimport { PluginCampaignTracker } from './plugin-campaign-tracker';\nimport { Options } from './typings/web-attribution';\n\nexport const webAttributionPlugin = (client: BrowserClient, options: Options = {}): BeforePlugin => ({\n  name: 'web-attribution',\n  type: PluginType.BEFORE,\n\n  setup: async (config: BrowserConfig) => {\n    config.loggerProvider.log('Installing @amplitude/plugin-web-attribution-browser');\n\n    // Disable \"runAttributionStrategy\" function\n    if (!config.attribution?.disabled) {\n      config.loggerProvider.warn(\n        '@amplitude/plugin-web-attribution-browser overrides web attribution behavior defined in @amplitude/analytics-browser',\n      );\n      config.attribution = {\n        disabled: true,\n      };\n    }\n\n    // Share cookie storage with user session storage\n    const storage = config.cookieStorage as unknown as Storage<Campaign>;\n\n    const campaignTracker = new PluginCampaignTracker(config.apiKey, storage, {\n      ...options,\n    });\n\n    // Web Attribution tracking\n    void campaignTracker.onPageChange(async ({ isNewCampaign, currentCampaign }) => {\n      if (isNewCampaign) {\n        if (options.resetSessionOnNewCampaign) {\n          client.setSessionId(Date.now());\n          config.loggerProvider.log('Created a new session for new campaign');\n        }\n        config.loggerProvider.log('Tracking new campaign event');\n        void client.track(campaignTracker.createCampaignEvent(currentCampaign));\n      }\n    });\n  },\n\n  execute: async (event: Event) => event,\n});\n"]}

package/lib/esm/index.d.ts

@@ -0,0 +1,3 @@
+export { webAttributionPlugin } from './web-attribution';
+export * as Types from './typings/web-attribution';
+//# 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,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC"}

package/lib/esm/index.js

@@ -0,0 +1,4 @@
+export { webAttributionPlugin } from './web-attribution';
+import * as Types_1 from './typings/web-attribution';
+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,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;yBAClC,2BAA2B;oBAAtC,KAAK","sourcesContent":["export { webAttributionPlugin } from './web-attribution';\nexport * as Types from './typings/web-attribution';\n"]}

package/lib/esm/plugin-campaign-tracker.d.ts

@@ -0,0 +1,69 @@
+import { AttributionOptions, Campaign } from '@amplitude/analytics-types';
+import { CampaignTracker } from '@amplitude/analytics-client-common';
+import { Storage } from '@amplitude/analytics-types';
+export declare class PluginCampaignTracker {
+    campaignTracker: CampaignTracker;
+    constructor(apiKey: string, storage: Storage<Campaign>, options: AttributionOptions);
+    createCampaignEvent(currentCampaign: Campaign): {
+        event_type: string;
+        event_properties?: {
+            [key: string]: any;
+        } | undefined;
+        user_properties: import("@amplitude/analytics-types").IdentifyUserProperties | {
+            [key: string]: any;
+        } | {
+            [x: string]: any;
+        };
+        group_properties?: {
+            [key: string]: any;
+        } | undefined;
+        groups?: {
+            [key: string]: any;
+        } | undefined;
+        user_id?: string | undefined;
+        device_id?: string | undefined;
+        time?: number | undefined;
+        location_lat?: number | undefined;
+        location_lng?: number | undefined;
+        app_version?: string | undefined;
+        version_name?: string | undefined;
+        library?: string | undefined;
+        platform?: string | undefined;
+        os_name?: string | undefined;
+        os_version?: string | undefined;
+        device_brand?: string | undefined;
+        device_manufacturer?: string | undefined;
+        device_model?: string | undefined;
+        carrier?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        city?: string | undefined;
+        dma?: string | undefined;
+        idfa?: string | undefined;
+        idfv?: string | undefined;
+        adid?: string | undefined;
+        android_id?: string | undefined;
+        language?: string | undefined;
+        ip?: string | undefined;
+        price?: number | undefined;
+        quantity?: number | undefined;
+        revenue?: number | undefined;
+        productId?: string | undefined;
+        revenueType?: string | undefined;
+        event_id?: number | undefined;
+        session_id?: number | undefined;
+        insert_id?: string | undefined;
+        plan?: import("@amplitude/analytics-types").Plan | undefined;
+        ingestion_metadata?: import("@amplitude/analytics-types/lib/esm/ingestion-metadata").IngestionMetadataEventProperty | undefined;
+        partner_id?: string | undefined;
+        extra?: {
+            [key: string]: any;
+        } | undefined;
+    };
+    onPageChange(callback: (state: {
+        isNewCampaign: boolean;
+        currentCampaign: Campaign;
+    }) => Promise<unknown>): Promise<void>;
+    private getCurrentState;
+}
+//# sourceMappingURL=plugin-campaign-tracker.d.ts.map

package/lib/esm/plugin-campaign-tracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-campaign-tracker.d.ts","sourceRoot":"","sources":["../../src/plugin-campaign-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAErD,qBAAa,qBAAqB;IAChC,eAAe,EAAE,eAAe,CAAC;gBAErB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,kBAAkB;IAUnF,mBAAmB,CAAC,eAAe,EAAE,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIvC,YAAY,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,aAAa,EAAE,OAAO,CAAC;QAAC,eAAe,EAAE,QAAQ,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC;YASjG,eAAe;CAW9B"}

package/lib/esm/plugin-campaign-tracker.js

@@ -0,0 +1,56 @@
+import { __assign, __awaiter, __generator } from "tslib";
+import { CampaignTracker } from '@amplitude/analytics-client-common';
+var PluginCampaignTracker = /** @class */ (function () {
+    function PluginCampaignTracker(apiKey, storage, options) {
+        this.campaignTracker = new CampaignTracker(apiKey, __assign(__assign({}, options), { trackPageViews: false, track: /* istanbul ignore next */ function () { return Promise.resolve(); }, onNewCampaign: /* istanbul ignore next */ function () { return function () { return undefined; }; }, storage: storage }));
+    }
+    PluginCampaignTracker.prototype.createCampaignEvent = function (currentCampaign) {
+        return this.campaignTracker.createCampaignEvent(currentCampaign);
+    };
+    PluginCampaignTracker.prototype.onPageChange = function (callback) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, currentState;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = callback;
+                        return [4 /*yield*/, this.getCurrentState()];
+                    case 1: return [4 /*yield*/, _a.apply(void 0, [_b.sent()])];
+                    case 2:
+                        _b.sent();
+                        return [4 /*yield*/, this.getCurrentState()];
+                    case 3:
+                        currentState = _b.sent();
+                        if (currentState.isNewCampaign) {
+                            void this.campaignTracker.saveCampaignToStorage(currentState.currentCampaign);
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    PluginCampaignTracker.prototype.getCurrentState = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var currentCampaign, isNewCampaign, _a, _b, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0: return [4 /*yield*/, this.campaignTracker.parser.parse()];
+                    case 1:
+                        currentCampaign = _d.sent();
+                        _b = (_a = this.campaignTracker).isNewCampaign;
+                        _c = [currentCampaign];
+                        return [4 /*yield*/, this.campaignTracker.getCampaignFromStorage()];
+                    case 2:
+                        isNewCampaign = _b.apply(_a, _c.concat([_d.sent()]));
+                        return [2 /*return*/, {
+                                isNewCampaign: isNewCampaign,
+                                currentCampaign: currentCampaign,
+                            }];
+                }
+            });
+        });
+    };
+    return PluginCampaignTracker;
+}());
+export { PluginCampaignTracker };
+//# sourceMappingURL=plugin-campaign-tracker.js.map

package/lib/esm/plugin-campaign-tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-campaign-tracker.js","sourceRoot":"","sources":["../../src/plugin-campaign-tracker.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAGrE;IAGE,+BAAY,MAAc,EAAE,OAA0B,EAAE,OAA2B;QACjF,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,CAAC,MAAM,wBAC5C,OAAO,KACV,cAAc,EAAE,KAAK,EACrB,KAAK,EAAE,0BAA0B,CAAC,cAAM,OAAA,OAAO,CAAC,OAAO,EAAE,EAAjB,CAAiB,EACzD,aAAa,EAAE,0BAA0B,CAAC,cAAM,OAAA,cAAM,OAAA,SAAS,EAAT,CAAS,EAAf,CAAe,EAC/D,OAAO,SAAA,IACP,CAAC;IACL,CAAC;IAED,mDAAmB,GAAnB,UAAoB,eAAyB;QAC3C,OAAO,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IACnE,CAAC;IAEK,4CAAY,GAAlB,UAAmB,QAA4F;;;;;;wBACvG,KAAA,QAAQ,CAAA;wBAAC,qBAAM,IAAI,CAAC,eAAe,EAAE,EAAA;4BAA3C,qBAAM,kBAAS,SAA4B,EAAC,EAAA;;wBAA5C,SAA4C,CAAC;wBAExB,qBAAM,IAAI,CAAC,eAAe,EAAE,EAAA;;wBAA3C,YAAY,GAAG,SAA4B;wBACjD,IAAI,YAAY,CAAC,aAAa,EAAE;4BAC9B,KAAK,IAAI,CAAC,eAAe,CAAC,qBAAqB,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;yBAC/E;;;;;KACF;IAEa,+CAAe,GAA7B;;;;;4BAC0B,qBAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,EAAA;;wBAA3D,eAAe,GAAG,SAAyC;wBAC3C,KAAA,CAAA,KAAA,IAAI,CAAC,eAAe,CAAA,CAAC,aAAa,CAAA;8BACtD,eAAe;wBACf,qBAAM,IAAI,CAAC,eAAe,CAAC,sBAAsB,EAAE,EAAA;;wBAF/C,aAAa,GAAG,wBAEpB,SAAmD,GACpD;wBACD,sBAAO;gCACL,aAAa,eAAA;gCACb,eAAe,iBAAA;6BAChB,EAAC;;;;KACH;IACH,4BAAC;AAAD,CAAC,AArCD,IAqCC","sourcesContent":["import { AttributionOptions, Campaign } from '@amplitude/analytics-types';\nimport { CampaignTracker } from '@amplitude/analytics-client-common';\nimport { Storage } from '@amplitude/analytics-types';\n\nexport class PluginCampaignTracker {\n  campaignTracker: CampaignTracker;\n\n  constructor(apiKey: string, storage: Storage<Campaign>, options: AttributionOptions) {\n    this.campaignTracker = new CampaignTracker(apiKey, {\n      ...options,\n      trackPageViews: false,\n      track: /* istanbul ignore next */ () => Promise.resolve(),\n      onNewCampaign: /* istanbul ignore next */ () => () => undefined,\n      storage,\n    });\n  }\n\n  createCampaignEvent(currentCampaign: Campaign) {\n    return this.campaignTracker.createCampaignEvent(currentCampaign);\n  }\n\n  async onPageChange(callback: (state: { isNewCampaign: boolean; currentCampaign: Campaign }) => Promise<unknown>) {\n    await callback(await this.getCurrentState());\n\n    const currentState = await this.getCurrentState();\n    if (currentState.isNewCampaign) {\n      void this.campaignTracker.saveCampaignToStorage(currentState.currentCampaign);\n    }\n  }\n\n  private async getCurrentState() {\n    const currentCampaign = await this.campaignTracker.parser.parse();\n    const isNewCampaign = this.campaignTracker.isNewCampaign(\n      currentCampaign,\n      await this.campaignTracker.getCampaignFromStorage(),\n    );\n    return {\n      isNewCampaign,\n      currentCampaign,\n    };\n  }\n}\n"]}

package/lib/esm/typings/web-attribution.d.ts

@@ -0,0 +1,7 @@
+export interface Options {
+    disabled?: boolean;
+    excludeReferrers?: string[];
+    initialEmptyValue?: string;
+    resetSessionOnNewCampaign?: boolean;
+}
+//# sourceMappingURL=web-attribution.d.ts.map

package/lib/esm/typings/web-attribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.d.ts","sourceRoot":"","sources":["../../../src/typings/web-attribution.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC"}

package/lib/esm/typings/web-attribution.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=web-attribution.js.map

package/lib/esm/typings/web-attribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../../src/typings/web-attribution.ts"],"names":[],"mappings":"","sourcesContent":["export interface Options {\n  disabled?: boolean;\n  excludeReferrers?: string[];\n  initialEmptyValue?: string;\n  resetSessionOnNewCampaign?: boolean;\n}\n"]}

package/lib/esm/web-attribution.d.ts

@@ -0,0 +1,4 @@
+import { BeforePlugin, BrowserClient } from '@amplitude/analytics-types';
+import { Options } from './typings/web-attribution';
+export declare const webAttributionPlugin: (client: BrowserClient, options?: Options) => BeforePlugin;
+//# sourceMappingURL=web-attribution.d.ts.map

package/lib/esm/web-attribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.d.ts","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,aAAa,EAMd,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEpD,eAAO,MAAM,oBAAoB,WAAY,aAAa,YAAW,OAAO,KAAQ,YAsClF,CAAC"}

package/lib/esm/web-attribution.js

@@ -0,0 +1,48 @@
+import { __assign, __awaiter, __generator } from "tslib";
+import { PluginType, } from '@amplitude/analytics-types';
+import { PluginCampaignTracker } from './plugin-campaign-tracker';
+export var webAttributionPlugin = function (client, options) {
+    if (options === void 0) { options = {}; }
+    return ({
+        name: 'web-attribution',
+        type: PluginType.BEFORE,
+        setup: function (config) { return __awaiter(void 0, void 0, void 0, function () {
+            var storage, campaignTracker;
+            var _a;
+            return __generator(this, function (_b) {
+                config.loggerProvider.log('Installing @amplitude/plugin-web-attribution-browser');
+                // Disable "runAttributionStrategy" function
+                if (!((_a = config.attribution) === null || _a === void 0 ? void 0 : _a.disabled)) {
+                    config.loggerProvider.warn('@amplitude/plugin-web-attribution-browser overrides web attribution behavior defined in @amplitude/analytics-browser');
+                    config.attribution = {
+                        disabled: true,
+                    };
+                }
+                storage = config.cookieStorage;
+                campaignTracker = new PluginCampaignTracker(config.apiKey, storage, __assign({}, options));
+                // Web Attribution tracking
+                void campaignTracker.onPageChange(function (_a) {
+                    var isNewCampaign = _a.isNewCampaign, currentCampaign = _a.currentCampaign;
+                    return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_b) {
+                            if (isNewCampaign) {
+                                if (options.resetSessionOnNewCampaign) {
+                                    client.setSessionId(Date.now());
+                                    config.loggerProvider.log('Created a new session for new campaign');
+                                }
+                                config.loggerProvider.log('Tracking new campaign event');
+                                void client.track(campaignTracker.createCampaignEvent(currentCampaign));
+                            }
+                            return [2 /*return*/];
+                        });
+                    });
+                });
+                return [2 /*return*/];
+            });
+        }); },
+        execute: function (event) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/, event];
+        }); }); },
+    });
+};
+//# sourceMappingURL=web-attribution.js.map

package/lib/esm/web-attribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-attribution.js","sourceRoot":"","sources":["../../src/web-attribution.ts"],"names":[],"mappings":";AAAA,OAAO,EAML,UAAU,GAEX,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAGlE,MAAM,CAAC,IAAM,oBAAoB,GAAG,UAAC,MAAqB,EAAE,OAAqB;IAArB,wBAAA,EAAA,YAAqB;IAAmB,OAAA,CAAC;QACnG,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,UAAU,CAAC,MAAM;QAEvB,KAAK,EAAE,UAAO,MAAqB;;;;gBACjC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,sDAAsD,CAAC,CAAC;gBAElF,4CAA4C;gBAC5C,IAAI,CAAC,CAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,QAAQ,CAAA,EAAE;oBACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CACxB,sHAAsH,CACvH,CAAC;oBACF,MAAM,CAAC,WAAW,GAAG;wBACnB,QAAQ,EAAE,IAAI;qBACf,CAAC;iBACH;gBAGK,OAAO,GAAG,MAAM,CAAC,aAA6C,CAAC;gBAE/D,eAAe,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,eACnE,OAAO,EACV,CAAC;gBAEH,2BAA2B;gBAC3B,KAAK,eAAe,CAAC,YAAY,CAAC,UAAO,EAAkC;wBAAhC,aAAa,mBAAA,EAAE,eAAe,qBAAA;;;4BACvE,IAAI,aAAa,EAAE;gCACjB,IAAI,OAAO,CAAC,yBAAyB,EAAE;oCACrC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oCAChC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;iCACrE;gCACD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;gCACzD,KAAK,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;6BACzE;;;;iBACF,CAAC,CAAC;;;aACJ;QAED,OAAO,EAAE,UAAO,KAAY;YAAK,sBAAA,KAAK,EAAA;iBAAA;KACvC,CAAC;AAtCkG,CAsClG,CAAC","sourcesContent":["import {\n  BeforePlugin,\n  BrowserClient,\n  BrowserConfig,\n  Campaign,\n  Event,\n  PluginType,\n  Storage,\n} from '@amplitude/analytics-types';\nimport { PluginCampaignTracker } from './plugin-campaign-tracker';\nimport { Options } from './typings/web-attribution';\n\nexport const webAttributionPlugin = (client: BrowserClient, options: Options = {}): BeforePlugin => ({\n  name: 'web-attribution',\n  type: PluginType.BEFORE,\n\n  setup: async (config: BrowserConfig) => {\n    config.loggerProvider.log('Installing @amplitude/plugin-web-attribution-browser');\n\n    // Disable \"runAttributionStrategy\" function\n    if (!config.attribution?.disabled) {\n      config.loggerProvider.warn(\n        '@amplitude/plugin-web-attribution-browser overrides web attribution behavior defined in @amplitude/analytics-browser',\n      );\n      config.attribution = {\n        disabled: true,\n      };\n    }\n\n    // Share cookie storage with user session storage\n    const storage = config.cookieStorage as unknown as Storage<Campaign>;\n\n    const campaignTracker = new PluginCampaignTracker(config.apiKey, storage, {\n      ...options,\n    });\n\n    // Web Attribution tracking\n    void campaignTracker.onPageChange(async ({ isNewCampaign, currentCampaign }) => {\n      if (isNewCampaign) {\n        if (options.resetSessionOnNewCampaign) {\n          client.setSessionId(Date.now());\n          config.loggerProvider.log('Created a new session for new campaign');\n        }\n        config.loggerProvider.log('Tracking new campaign event');\n        void client.track(campaignTracker.createCampaignEvent(currentCampaign));\n      }\n    });\n  },\n\n  execute: async (event: Event) => event,\n});\n"]}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@amplitude/plugin-web-attribution-browser",
+  "version": "0.1.3",
+  "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"
+}