@amplitude/analytics-browser 0.3.1 → 0.4.0

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/README.md

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

package/lib/cjs/attribution.d.ts

@@ -1,5 +1,5 @@
 import { BrowserConfig, UTMData } from '@amplitude/analytics-types';
-export declare const trackAttributions: (config: BrowserConfig) => void;
+export declare const getAttributions: (config: BrowserConfig) => Record<string, string>;
 export declare const getUtmParam: () => UTMData;
 export declare const getReferrer: () => Record<string, string | undefined>;
 export declare const getGclid: () => {

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

@@ -1 +1 @@
-{"version":3,"file":"attribution.d.ts","sourceRoot":"","sources":["../../src/attribution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAkBpE,eAAO,MAAM,iBAAiB,WAAY,aAAa,SAoBtD,CAAC;AAEF,eAAO,MAAM,WAAW,QAAO,OAkB9B,CAAC;AAEF,eAAO,MAAM,WAAW,0CAYvB,CAAC;AAEF,eAAO,MAAM,QAAQ;;CAKpB,CAAC;AAEF,eAAO,MAAM,SAAS;;CAKrB,CAAC"}
+{"version":3,"file":"attribution.d.ts","sourceRoot":"","sources":["../../src/attribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAkBpE,eAAO,MAAM,eAAe,WAAY,aAAa,KAAG,OAAO,MAAM,EAAE,MAAM,CAS5E,CAAC;AAEF,eAAO,MAAM,WAAW,QAAO,OAkB9B,CAAC;AAEF,eAAO,MAAM,WAAW,0CAYvB,CAAC;AAEF,eAAO,MAAM,QAAQ;;CAKpB,CAAC;AAEF,eAAO,MAAM,SAAS;;CAKrB,CAAC"}

package/lib/cjs/attribution.js

@@ -1,26 +1,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFbclid = exports.getGclid = exports.getReferrer = exports.getUtmParam = exports.trackAttributions = void 0;
+exports.getFbclid = exports.getGclid = exports.getReferrer = exports.getUtmParam = exports.getAttributions = void 0;
 var tslib_1 = require("tslib");
-var analytics_core_1 = require("@amplitude/analytics-core");
 var constants_1 = require("./constants");
 var utm_cookie_1 = require("./storage/utm-cookie");
 var query_params_1 = require("./utils/query-params");
-var trackAttributions = function (config) {
-    var attribution = (0, tslib_1.__assign)((0, tslib_1.__assign)((0, tslib_1.__assign)((0, tslib_1.__assign)({}, (config.includeUtm && (0, exports.getUtmParam)())), (config.includeReferrer && (0, exports.getReferrer)())), (config.includeGclid && (0, exports.getGclid)())), (config.includeFbclid && (0, exports.getFbclid)()));
-    if (Object.keys(attribution).length === 0) {
-        return;
-    }
-    var id = new analytics_core_1.Identify();
-    Object.entries(attribution).forEach(function (_a) {
-        var _b = (0, tslib_1.__read)(_a, 2), key = _b[0], value = _b[1];
-        if (value) {
-            id.setOnce("initial_".concat(key), value);
-            id.set(key, value);
-        }
-    });
-    void (0, analytics_core_1.identify)(undefined, undefined, id);
+var getAttributions = function (config) {
+    var attributions = (0, tslib_1.__assign)((0, tslib_1.__assign)((0, tslib_1.__assign)((0, tslib_1.__assign)({}, (config.includeUtm && (0, exports.getUtmParam)())), (config.includeReferrer && (0, exports.getReferrer)())), (config.includeGclid && (0, exports.getGclid)())), (config.includeFbclid && (0, exports.getFbclid)()));
+    return attributions;
 };
-exports.trackAttributions = trackAttributions;
+exports.getAttributions = getAttributions;
 var getUtmParam = function () {
     var params = (0, query_params_1.getQueryParams)();
     var utmStorage = new utm_cookie_1.UTMCookie();

package/lib/cjs/attribution.js.map

@@ -1 +1 @@
-{"version":3,"file":"attribution.js","sourceRoot":"","sources":["../../src/attribution.ts"],"names":[],"mappings":";;;AAAA,4DAA+D;AAE/D,yCAaqB;AACrB,mDAAiD;AACjD,qDAAsD;AAE/C,IAAM,iBAAiB,GAAG,UAAC,MAAqB;IACrD,IAAM,WAAW,+FACZ,CAAC,MAAM,CAAC,UAAU,IAAI,IAAA,mBAAW,GAAE,CAAC,GACpC,CAAC,MAAM,CAAC,eAAe,IAAI,IAAA,mBAAW,GAAE,CAAC,GACzC,CAAC,MAAM,CAAC,YAAY,IAAI,IAAA,gBAAQ,GAAE,CAAC,GACnC,CAAC,MAAM,CAAC,aAAa,IAAI,IAAA,iBAAS,GAAE,CAAC,CACzC,CAAC;IAEF,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACzC,OAAO;KACR;IAED,IAAM,EAAE,GAAG,IAAI,yBAAQ,EAAE,CAAC;IAC1B,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,UAAC,EAA8B;YAA9B,KAAA,0BAA8B,EAA7B,GAAG,QAAA,EAAE,KAAK,QAAA;QAC9C,IAAI,KAAK,EAAE;YACT,EAAE,CAAC,OAAO,CAAC,kBAAW,GAAG,CAAE,EAAE,KAAK,CAAC,CAAC;YACpC,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACpB;IACH,CAAC,CAAC,CAAC;IACH,KAAK,IAAA,yBAAQ,EAAC,SAAS,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC,CAAC;AApBW,QAAA,iBAAiB,qBAoB5B;AAEK,IAAM,WAAW,GAAG;IACzB,IAAM,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;IAChC,IAAM,UAAU,GAAG,IAAI,sBAAS,EAAE,CAAC;IACnC,IAAM,OAAO,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAE3E,IAAM,SAAS,GAAG,MAAM,CAAC,sBAAU,CAAC,IAAI,OAAO,CAAC,uBAAW,CAAC,CAAC;IAC7D,IAAM,SAAS,GAAG,MAAM,CAAC,sBAAU,CAAC,IAAI,OAAO,CAAC,uBAAW,CAAC,CAAC;IAC7D,IAAM,WAAW,GAAG,MAAM,CAAC,wBAAY,CAAC,IAAI,OAAO,CAAC,yBAAa,CAAC,CAAC;IACnE,IAAM,OAAO,GAAG,MAAM,CAAC,oBAAQ,CAAC,IAAI,OAAO,CAAC,qBAAS,CAAC,CAAC;IACvD,IAAM,UAAU,GAAG,MAAM,CAAC,uBAAW,CAAC,IAAI,OAAO,CAAC,wBAAY,CAAC,CAAC;IAEhE,IAAM,IAAI,GAAY,EAAE,CAAC;IACzB,IAAI,SAAS;QAAE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC3C,IAAI,SAAS;QAAE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC3C,IAAI,WAAW;QAAE,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACjD,IAAI,OAAO;QAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IACrC,IAAI,UAAU;QAAE,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAC9C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAlBW,QAAA,WAAW,eAkBtB;AAEK,IAAM,WAAW,GAAG;;IACzB,IAAM,IAAI,GAAuC,EAAE,CAAC;IACpD,IAAI;QACF,IAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,IAAI,SAAS,CAAC;QAChD,IAAM,eAAe,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,mCAAI,SAAS,CAAC;QAE7D,IAAI,QAAQ,KAAK,SAAS;YAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACrD,IAAI,eAAe,KAAK,SAAS;YAAE,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;KAC5E;IAAC,WAAM;QACN,EAAE;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAZW,QAAA,WAAW,eAYtB;AAEK,IAAM,QAAQ,GAAG;;IACtB,IAAM,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;IAChC,iCACK,CAAC,MAAM,CAAC,iBAAK,CAAC,cAAM,GAAC,iBAAK,IAAG,MAAM,CAAC,iBAAK,CAAC,KAAE,CAAC,EAChD;AACJ,CAAC,CAAC;AALW,QAAA,QAAQ,YAKnB;AAEK,IAAM,SAAS,GAAG;;IACvB,IAAM,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;IAChC,iCACK,CAAC,MAAM,CAAC,kBAAM,CAAC,cAAM,GAAC,kBAAM,IAAG,MAAM,CAAC,kBAAM,CAAC,KAAE,CAAC,EACnD;AACJ,CAAC,CAAC;AALW,QAAA,SAAS,aAKpB","sourcesContent":["import { Identify, identify } from '@amplitude/analytics-core';\nimport { BrowserConfig, UTMData } from '@amplitude/analytics-types';\nimport {\n  UTM_CAMPAIGN,\n  UTM_CONTENT,\n  UTM_MEDIUM,\n  UTM_SOURCE,\n  UTM_TERM,\n  UTMZ_SOURCE,\n  UTMZ_MEDIUM,\n  UTMZ_CAMPAIGN,\n  UTMZ_TERM,\n  UTMZ_CONTENT,\n  GCLID,\n  FBCLID,\n} from './constants';\nimport { UTMCookie } from './storage/utm-cookie';\nimport { getQueryParams } from './utils/query-params';\n\nexport const trackAttributions = (config: BrowserConfig) => {\n  const attribution = {\n    ...(config.includeUtm && getUtmParam()),\n    ...(config.includeReferrer && getReferrer()),\n    ...(config.includeGclid && getGclid()),\n    ...(config.includeFbclid && getFbclid()),\n  };\n\n  if (Object.keys(attribution).length === 0) {\n    return;\n  }\n\n  const id = new Identify();\n  Object.entries(attribution).forEach(([key, value]: [string, string]) => {\n    if (value) {\n      id.setOnce(`initial_${key}`, value);\n      id.set(key, value);\n    }\n  });\n  void identify(undefined, undefined, id);\n};\n\nexport const getUtmParam = (): UTMData => {\n  const params = getQueryParams();\n  const utmStorage = new UTMCookie();\n  const cookies = (utmStorage.isEnabled() && utmStorage.get('__utmz')) || {};\n\n  const utmSource = params[UTM_SOURCE] || cookies[UTMZ_SOURCE];\n  const utmMedium = params[UTM_MEDIUM] || cookies[UTMZ_MEDIUM];\n  const utmCampaign = params[UTM_CAMPAIGN] || cookies[UTMZ_CAMPAIGN];\n  const utmTerm = params[UTM_TERM] || cookies[UTMZ_TERM];\n  const utmContent = params[UTM_CONTENT] || cookies[UTMZ_CONTENT];\n\n  const data: UTMData = {};\n  if (utmSource) data.utm_source = utmSource;\n  if (utmMedium) data.utm_medium = utmMedium;\n  if (utmCampaign) data.utm_campaign = utmCampaign;\n  if (utmTerm) data.utm_term = utmTerm;\n  if (utmContent) data.utm_content = utmContent;\n  return data;\n};\n\nexport const getReferrer = () => {\n  const data: Record<string, string | undefined> = {};\n  try {\n    const referrer = document.referrer || undefined;\n    const referringDomain = referrer?.split('/')[2] ?? undefined;\n\n    if (referrer !== undefined) data.referrer = referrer;\n    if (referringDomain !== undefined) data.referring_domain = referringDomain;\n  } catch {\n    //\n  }\n  return data;\n};\n\nexport const getGclid = () => {\n  const params = getQueryParams();\n  return {\n    ...(params[GCLID] && { [GCLID]: params[GCLID] }),\n  };\n};\n\nexport const getFbclid = () => {\n  const params = getQueryParams();\n  return {\n    ...(params[FBCLID] && { [FBCLID]: params[FBCLID] }),\n  };\n};\n"]}
+{"version":3,"file":"attribution.js","sourceRoot":"","sources":["../../src/attribution.ts"],"names":[],"mappings":";;;AACA,yCAaqB;AACrB,mDAAiD;AACjD,qDAAsD;AAE/C,IAAM,eAAe,GAAG,UAAC,MAAqB;IACnD,IAAM,YAAY,+FACb,CAAC,MAAM,CAAC,UAAU,IAAI,IAAA,mBAAW,GAAE,CAAC,GACpC,CAAC,MAAM,CAAC,eAAe,IAAI,IAAA,mBAAW,GAAE,CAAC,GACzC,CAAC,MAAM,CAAC,YAAY,IAAI,IAAA,gBAAQ,GAAE,CAAC,GACnC,CAAC,MAAM,CAAC,aAAa,IAAI,IAAA,iBAAS,GAAE,CAAC,CACzC,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AATW,QAAA,eAAe,mBAS1B;AAEK,IAAM,WAAW,GAAG;IACzB,IAAM,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;IAChC,IAAM,UAAU,GAAG,IAAI,sBAAS,EAAE,CAAC;IACnC,IAAM,OAAO,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAE3E,IAAM,SAAS,GAAG,MAAM,CAAC,sBAAU,CAAC,IAAI,OAAO,CAAC,uBAAW,CAAC,CAAC;IAC7D,IAAM,SAAS,GAAG,MAAM,CAAC,sBAAU,CAAC,IAAI,OAAO,CAAC,uBAAW,CAAC,CAAC;IAC7D,IAAM,WAAW,GAAG,MAAM,CAAC,wBAAY,CAAC,IAAI,OAAO,CAAC,yBAAa,CAAC,CAAC;IACnE,IAAM,OAAO,GAAG,MAAM,CAAC,oBAAQ,CAAC,IAAI,OAAO,CAAC,qBAAS,CAAC,CAAC;IACvD,IAAM,UAAU,GAAG,MAAM,CAAC,uBAAW,CAAC,IAAI,OAAO,CAAC,wBAAY,CAAC,CAAC;IAEhE,IAAM,IAAI,GAAY,EAAE,CAAC;IACzB,IAAI,SAAS;QAAE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC3C,IAAI,SAAS;QAAE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC3C,IAAI,WAAW;QAAE,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACjD,IAAI,OAAO;QAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IACrC,IAAI,UAAU;QAAE,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAC9C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAlBW,QAAA,WAAW,eAkBtB;AAEK,IAAM,WAAW,GAAG;;IACzB,IAAM,IAAI,GAAuC,EAAE,CAAC;IACpD,IAAI;QACF,IAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,IAAI,SAAS,CAAC;QAChD,IAAM,eAAe,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,mCAAI,SAAS,CAAC;QAE7D,IAAI,QAAQ,KAAK,SAAS;YAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACrD,IAAI,eAAe,KAAK,SAAS;YAAE,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;KAC5E;IAAC,WAAM;QACN,EAAE;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAZW,QAAA,WAAW,eAYtB;AAEK,IAAM,QAAQ,GAAG;;IACtB,IAAM,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;IAChC,iCACK,CAAC,MAAM,CAAC,iBAAK,CAAC,cAAM,GAAC,iBAAK,IAAG,MAAM,CAAC,iBAAK,CAAC,KAAE,CAAC,EAChD;AACJ,CAAC,CAAC;AALW,QAAA,QAAQ,YAKnB;AAEK,IAAM,SAAS,GAAG;;IACvB,IAAM,MAAM,GAAG,IAAA,6BAAc,GAAE,CAAC;IAChC,iCACK,CAAC,MAAM,CAAC,kBAAM,CAAC,cAAM,GAAC,kBAAM,IAAG,MAAM,CAAC,kBAAM,CAAC,KAAE,CAAC,EACnD;AACJ,CAAC,CAAC;AALW,QAAA,SAAS,aAKpB","sourcesContent":["import { BrowserConfig, UTMData } from '@amplitude/analytics-types';\nimport {\n  UTM_CAMPAIGN,\n  UTM_CONTENT,\n  UTM_MEDIUM,\n  UTM_SOURCE,\n  UTM_TERM,\n  UTMZ_SOURCE,\n  UTMZ_MEDIUM,\n  UTMZ_CAMPAIGN,\n  UTMZ_TERM,\n  UTMZ_CONTENT,\n  GCLID,\n  FBCLID,\n} from './constants';\nimport { UTMCookie } from './storage/utm-cookie';\nimport { getQueryParams } from './utils/query-params';\n\nexport const getAttributions = (config: BrowserConfig): Record<string, string> => {\n  const attributions = {\n    ...(config.includeUtm && getUtmParam()),\n    ...(config.includeReferrer && getReferrer()),\n    ...(config.includeGclid && getGclid()),\n    ...(config.includeFbclid && getFbclid()),\n  };\n\n  return attributions;\n};\n\nexport const getUtmParam = (): UTMData => {\n  const params = getQueryParams();\n  const utmStorage = new UTMCookie();\n  const cookies = (utmStorage.isEnabled() && utmStorage.get('__utmz')) || {};\n\n  const utmSource = params[UTM_SOURCE] || cookies[UTMZ_SOURCE];\n  const utmMedium = params[UTM_MEDIUM] || cookies[UTMZ_MEDIUM];\n  const utmCampaign = params[UTM_CAMPAIGN] || cookies[UTMZ_CAMPAIGN];\n  const utmTerm = params[UTM_TERM] || cookies[UTMZ_TERM];\n  const utmContent = params[UTM_CONTENT] || cookies[UTMZ_CONTENT];\n\n  const data: UTMData = {};\n  if (utmSource) data.utm_source = utmSource;\n  if (utmMedium) data.utm_medium = utmMedium;\n  if (utmCampaign) data.utm_campaign = utmCampaign;\n  if (utmTerm) data.utm_term = utmTerm;\n  if (utmContent) data.utm_content = utmContent;\n  return data;\n};\n\nexport const getReferrer = () => {\n  const data: Record<string, string | undefined> = {};\n  try {\n    const referrer = document.referrer || undefined;\n    const referringDomain = referrer?.split('/')[2] ?? undefined;\n\n    if (referrer !== undefined) data.referrer = referrer;\n    if (referringDomain !== undefined) data.referring_domain = referringDomain;\n  } catch {\n    //\n  }\n  return data;\n};\n\nexport const getGclid = () => {\n  const params = getQueryParams();\n  return {\n    ...(params[GCLID] && { [GCLID]: params[GCLID] }),\n  };\n};\n\nexport const getFbclid = () => {\n  const params = getQueryParams();\n  return {\n    ...(params[FBCLID] && { [FBCLID]: params[FBCLID] }),\n  };\n};\n"]}

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

@@ -1,5 +1,20 @@
-import { Identify, Revenue } from '@amplitude/analytics-core';
-import { AmplitudeReturn, BrowserOptions, EventOptions, Plugin, Result, TransportType } from '@amplitude/analytics-types';
+import { AmplitudeCore } from '@amplitude/analytics-core';
+import { BrowserConfig, BrowserOptions, EventOptions, Identify as IIdentify, Result, Revenue as IRevenue, TransportType } from '@amplitude/analytics-types';
+export declare class AmplitudeBrowser extends AmplitudeCore<BrowserConfig> {
+    init(apiKey: string, userId?: string, options?: BrowserOptions): Promise<void>;
+    getUserId(): string | undefined;
+    setUserId(userId: string): void;
+    getDeviceId(): string | undefined;
+    setDeviceId(deviceId: string): void;
+    getSessionId(): number | undefined;
+    setSessionId(sessionId: number): void;
+    setOptOut(optOut: boolean): void;
+    setTransport(transport: TransportType): void;
+    identify(identify: IIdentify, eventOptions?: EventOptions): Promise<Result>;
+    groupIdentify(groupType: string, groupName: string | string[], identify: IIdentify, eventOptions?: EventOptions): Promise<Result>;
+    revenue(revenue: IRevenue, eventOptions?: EventOptions): Promise<Result>;
+    trackAttributions(): Promise<Result> | undefined;
+}
 /**
  * Initializes the Amplitude SDK with your apiKey, userId and optional configurations.
  * This method must be called before any other operations.
@@ -8,7 +23,7 @@ import { AmplitudeReturn, BrowserOptions, EventOptions, Plugin, Result, Transpor
  * await init(API_KEY, USER_ID, options).promise;
  * ```
  */
-export declare const init: (apiKey: string, userId?: string | undefined, options?: BrowserOptions | undefined) => AmplitudeReturn<void>;
+export declare const init: (apiKey: string, userId?: string | undefined, options?: BrowserOptions | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<void>;
 /**
  * Adds a new plugin.
  *
@@ -17,7 +32,7 @@ export declare const init: (apiKey: string, userId?: string | undefined, options
  * amplitude.add(plugin);
  * ```
  */
-export declare const add: (plugin: Plugin) => AmplitudeReturn<void>;
+export declare const add: (plugin: import("@amplitude/analytics-types").Plugin) => import("@amplitude/analytics-types").AmplitudeReturn<void>;
 /**
  * Removes a plugin.
  *
@@ -25,7 +40,83 @@ export declare const add: (plugin: Plugin) => AmplitudeReturn<void>;
  * amplitude.remove('myPlugin');
  * ```
  */
-export declare const remove: (pluginName: string) => AmplitudeReturn<void>;
+export declare const remove: (pluginName: string) => import("@amplitude/analytics-types").AmplitudeReturn<void>;
+/**
+ * Tracks user-defined event, with specified type, optional event properties and optional overwrites.
+ *
+ * ```typescript
+ * // event tracking with event type only
+ * track('Page Load');
+ *
+ * // event tracking with event type and additional event properties
+ * track('Page Load', { loadTime: 1000 });
+ *
+ * // event tracking with event type, additional event properties, and overwritten event options
+ * track('Page Load', { loadTime: 1000 }, { sessionId: -1 });
+ *
+ * // alternatively, this tracking method is awaitable
+ * const result = await track('Page Load').promise;
+ * console.log(result.event); // {...}
+ * console.log(result.code); // 200
+ * console.log(result.message); // "Event tracked successfully"
+ * ```
+ */
+export declare const track: (eventInput: string | import("@amplitude/analytics-types").BaseEvent, eventProperties?: Record<string, any> | undefined, eventOptions?: EventOptions | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<Result>;
+/**
+ * Alias for track()
+ */
+export declare const logEvent: (eventInput: string | import("@amplitude/analytics-types").BaseEvent, eventProperties?: Record<string, any> | undefined, eventOptions?: EventOptions | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<Result>;
+/**
+ * Sends an identify event containing user property operations
+ *
+ * ```typescript
+ * const id = new Identify();
+ * id.set('colors', ['rose', 'gold']);
+ * identify(id);
+ *
+ * // alternatively, this tracking method is awaitable
+ * const result = await identify(id).promise;
+ * console.log(result.event); // {...}
+ * console.log(result.code); // 200
+ * console.log(result.message); // "Event tracked successfully"
+ * ```
+ */
+export declare const identify: (identify: IIdentify, eventOptions?: EventOptions | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<Result>;
+/**
+ * Sends a group identify event containing group property operations.
+ *
+ * ```typescript
+ * const id = new Identify();
+ * id.set('skills', ['js', 'ts']);
+ * const groupType = 'org';
+ * const groupName = 'engineering';
+ * groupIdentify(groupType, groupName, id);
+ *
+ * // alternatively, this tracking method is awaitable
+ * const result = await groupIdentify(groupType, groupName, id).promise;
+ * console.log(result.event); // {...}
+ * console.log(result.code); // 200
+ * console.log(result.message); // "Event tracked successfully"
+ * ```
+ */
+export declare const groupIdentify: (groupType: string, groupName: string | string[], identify: IIdentify, eventOptions?: EventOptions | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<Result>;
+export declare const setGroup: (groupType: string, groupName: string | string[]) => import("@amplitude/analytics-types").AmplitudeReturn<Result>;
+/**
+ * Sends a revenue event containing revenue property operations.
+ *
+ * ```typescript
+ * const rev = new Revenue();
+ * rev.setRevenue(100);
+ * revenue(rev);
+ *
+ * // alternatively, this tracking method is awaitable
+ * const result = await revenue(rev).promise;
+ * console.log(result.event); // {...}
+ * console.log(result.code); // 200
+ * console.log(result.message); // "Event tracked successfully"
+ * ```
+ */
+export declare const revenue: (revenue: IRevenue, eventOptions?: EventOptions | undefined) => import("@amplitude/analytics-types").AmplitudeReturn<Result>;
 /**
  * Returns current user ID.
  *
@@ -104,80 +195,4 @@ export declare const setOptOut: (optOut: boolean) => void;
  * ```
  */
 export declare const setTransport: (transport: TransportType) => void;
-/**
- * Tracks user-defined event, with specified type, optional event properties and optional overwrites.
- *
- * ```typescript
- * // event tracking with event type only
- * track('Page Load');
- *
- * // event tracking with event type and additional event properties
- * track('Page Load', { loadTime: 1000 });
- *
- * // event tracking with event type, additional event properties, and overwritten event options
- * track('Page Load', { loadTime: 1000 }, { sessionId: -1 });
- *
- * // alternatively, this tracking method is awaitable
- * const result = await track('Page Load').promise;
- * console.log(result.event); // {...}
- * console.log(result.code); // 200
- * console.log(result.message); // "Event tracked successfully"
- * ```
- */
-export declare const track: (eventType: string, eventProperties?: Record<string, any> | undefined, eventOptions?: EventOptions | undefined) => AmplitudeReturn<Result>;
-/**
- * Alis for track()
- */
-export declare const logEvent: (eventType: string, eventProperties?: Record<string, any> | undefined, eventOptions?: EventOptions | undefined) => AmplitudeReturn<Result>;
-/**
- * Sends an identify event containing user property operations
- *
- * ```typescript
- * const id = new Identify();
- * id.set('colors', ['rose', 'gold']);
- * identify(id);
- *
- * // alternatively, this tracking method is awaitable
- * const result = await identify(id).promise;
- * console.log(result.event); // {...}
- * console.log(result.code); // 200
- * console.log(result.message); // "Event tracked successfully"
- * ```
- */
-export declare const identify: (identify: Identify, eventOptions?: EventOptions | undefined) => AmplitudeReturn<Result>;
-/**
- * Sends a group identify event containing group property operations.
- *
- * ```typescript
- * const id = new Identify();
- * id.set('skills', ['js', 'ts']);
- * const groupType = 'org';
- * const groupName = 'engineering';
- * groupIdentify(groupType, groupName, id);
- *
- * // alternatively, this tracking method is awaitable
- * const result = await groupIdentify(groupType, groupName, id).promise;
- * console.log(result.event); // {...}
- * console.log(result.code); // 200
- * console.log(result.message); // "Event tracked successfully"
- * ```
- */
-export declare const groupIdentify: (groupType: string, groupName: string | string[], identify: Identify, eventOptions?: EventOptions | undefined) => AmplitudeReturn<Result>;
-export declare const setGroup: (groupType: string, groupName: string | string[]) => AmplitudeReturn<Result>;
-/**
- * Sends a revenue event containing revenue property operations.
- *
- * ```typescript
- * const rev = new Revenue();
- * rev.setRevenue(100);
- * revenue(rev);
- *
- * // alternatively, this tracking method is awaitable
- * const result = await revenue(rev).promise;
- * console.log(result.event); // {...}
- * console.log(result.code); // 200
- * console.log(result.message); // "Event tracked successfully"
- * ```
- */
-export declare const revenue: (revenue: Revenue, eventOptions?: EventOptions | undefined) => AmplitudeReturn<Result>;
 //# sourceMappingURL=browser-client.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"browser-client.d.ts","sourceRoot":"","sources":["../../src/browser-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,QAAQ,EACR,OAAO,EAIR,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,eAAe,EAEf,cAAc,EACd,YAAY,EACZ,MAAM,EACN,MAAM,EACN,aAAa,EACd,MAAM,4BAA4B,CAAC;AAOpC;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,WAAY,MAAM,wEAA8C,gBAAgB,IAAI,CAYpG,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,WAAY,MAAM,KAAG,gBAAgB,IAAI,CAIxD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,eAAgB,MAAM,KAAG,gBAAgB,IAAI,CAI/D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,0BAErB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,WAAY,MAAM,SAIvC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,0BAEvB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,aAAc,MAAM,SAI3C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,0BAExB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,cAAe,MAAM,SAI7C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,WAAY,OAAO,SAIxC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,cAAe,aAAa,SAIpD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,cACL,MAAM,iGAGhB,gBAAgB,MAAM,CAIxB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,cAZR,MAAM,iGAGhB,gBAAgB,MAAM,CASI,CAAC;AAE9B;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,aAAc,QAAQ,8CAAgC,gBAAgB,MAAM,CAShG,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,cACb,MAAM,aACN,MAAM,GAAG,MAAM,EAAE,YAClB,QAAQ,8CAEjB,gBAAgB,MAAM,CASxB,CAAC;AAEF,eAAO,MAAM,QAAQ,cAAe,MAAM,aAAa,MAAM,GAAG,MAAM,EAAE,KAAG,gBAAgB,MAAM,CAIhG,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,YAAa,OAAO,8CAAgC,gBAAgB,MAAM,CAS7F,CAAC"}
+{"version":3,"file":"browser-client.d.ts","sourceRoot":"","sources":["../../src/browser-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiD,MAAM,2BAA2B,CAAC;AACzG,OAAO,EACL,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,IAAI,SAAS,EACrB,MAAM,EACN,OAAO,IAAI,QAAQ,EACnB,aAAa,EACd,MAAM,4BAA4B,CAAC;AAQpC,qBAAa,gBAAiB,SAAQ,aAAa,CAAC,aAAa,CAAC;IAC1D,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAwBpE,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM;IAKxB,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAK5B,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM;IAK9B,SAAS,CAAC,MAAM,EAAE,OAAO;IAKzB,YAAY,CAAC,SAAS,EAAE,aAAa;IAIrC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAS3E,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAC5B,QAAQ,EAAE,SAAS,EACnB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,MAAM,CAAC;IASlB,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,YAAY;IAStD,iBAAiB;CAclB;AAID;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,mJAA0C,CAAC;AAE5D;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,qHAAyC,CAAC;AAE1D;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,oFAA4C,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,mOAA2C,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,QAAQ,mOAA8C,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,gIAA8C,CAAC;AAEpE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,iLAAmD,CAAC;AAC9E,eAAO,MAAM,QAAQ,mHAA8C,CAAC;AAEpE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,8HAA6C,CAAC;AAElE;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,0BAAgC,CAAC;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,WAhNF,MAAM,SAgN4B,CAAC;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,0BAAkC,CAAC;AAE3D;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,aA3NA,MAAM,SA2N4B,CAAC;AAE3D;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,0BAAmC,CAAC;AAE7D;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,cArOC,MAAM,SAqO4B,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,WA7OF,OAAO,SA6O2B,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,cAxPC,aAAa,SAwPqB,CAAC"}