@amplitude/plugin-web-vitals-browser 1.1.49-video-analytics-5.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +36 -0
  2. package/lib/cjs/constants.d.ts +34 -0
  3. package/lib/cjs/constants.d.ts.map +1 -1
  4. package/lib/cjs/constants.js +14 -1
  5. package/lib/cjs/constants.js.map +1 -1
  6. package/lib/cjs/index.d.ts +9 -1
  7. package/lib/cjs/index.d.ts.map +1 -1
  8. package/lib/cjs/index.js +21 -3
  9. package/lib/cjs/index.js.map +1 -1
  10. package/lib/cjs/utils.d.ts +4 -0
  11. package/lib/cjs/utils.d.ts.map +1 -0
  12. package/lib/cjs/utils.js +29 -0
  13. package/lib/cjs/utils.js.map +1 -0
  14. package/lib/cjs/version.d.ts +1 -1
  15. package/lib/cjs/version.d.ts.map +1 -1
  16. package/lib/cjs/version.js +1 -1
  17. package/lib/cjs/version.js.map +1 -1
  18. package/lib/cjs/web-vitals-plugin.d.ts.map +1 -1
  19. package/lib/cjs/web-vitals-plugin.js +6 -22
  20. package/lib/cjs/web-vitals-plugin.js.map +1 -1
  21. package/lib/cjs/web-vitals-soft-nav-plugin.d.ts +4 -0
  22. package/lib/cjs/web-vitals-soft-nav-plugin.d.ts.map +1 -0
  23. package/lib/cjs/web-vitals-soft-nav-plugin.js +177 -0
  24. package/lib/cjs/web-vitals-soft-nav-plugin.js.map +1 -0
  25. package/lib/esm/constants.d.ts +34 -0
  26. package/lib/esm/constants.d.ts.map +1 -1
  27. package/lib/esm/constants.js +13 -0
  28. package/lib/esm/constants.js.map +1 -1
  29. package/lib/esm/index.d.ts +9 -1
  30. package/lib/esm/index.d.ts.map +1 -1
  31. package/lib/esm/index.js +20 -1
  32. package/lib/esm/index.js.map +1 -1
  33. package/lib/esm/utils.d.ts +4 -0
  34. package/lib/esm/utils.d.ts.map +1 -0
  35. package/lib/esm/utils.js +25 -0
  36. package/lib/esm/utils.js.map +1 -0
  37. package/lib/esm/version.d.ts +1 -1
  38. package/lib/esm/version.d.ts.map +1 -1
  39. package/lib/esm/version.js +1 -1
  40. package/lib/esm/version.js.map +1 -1
  41. package/lib/esm/web-vitals-plugin.d.ts.map +1 -1
  42. package/lib/esm/web-vitals-plugin.js +1 -17
  43. package/lib/esm/web-vitals-plugin.js.map +1 -1
  44. package/lib/esm/web-vitals-soft-nav-plugin.d.ts +4 -0
  45. package/lib/esm/web-vitals-soft-nav-plugin.d.ts.map +1 -0
  46. package/lib/esm/web-vitals-soft-nav-plugin.js +173 -0
  47. package/lib/esm/web-vitals-soft-nav-plugin.js.map +1 -0
  48. package/lib/scripts/amplitude-min.js +1 -1
  49. package/lib/scripts/amplitude-min.js.gz +0 -0
  50. package/lib/scripts/amplitude-min.js.map +1 -1
  51. package/lib/scripts/amplitude-min.umd.js +1 -1
  52. package/lib/scripts/amplitude-min.umd.js.gz +0 -0
  53. package/lib/scripts/constants.d.ts +34 -0
  54. package/lib/scripts/constants.d.ts.map +1 -1
  55. package/lib/scripts/index.d.ts +9 -1
  56. package/lib/scripts/index.d.ts.map +1 -1
  57. package/lib/scripts/utils.d.ts +4 -0
  58. package/lib/scripts/utils.d.ts.map +1 -0
  59. package/lib/scripts/version.d.ts +1 -1
  60. package/lib/scripts/version.d.ts.map +1 -1
  61. package/lib/scripts/web-vitals-plugin.d.ts.map +1 -1
  62. package/lib/scripts/web-vitals-soft-nav-plugin.d.ts +4 -0
  63. package/lib/scripts/web-vitals-soft-nav-plugin.d.ts.map +1 -0
  64. package/package.json +3 -3
package/README.md CHANGED
@@ -35,6 +35,42 @@ import { webVitalsPlugin } from '@amplitude/plugin-web-vitals-browser';
35
35
  const plugin = webVitalsPlugin();
36
36
  ```
37
37
 
38
+ #### Options
39
+
40
+ | Name | Type | Default | Description |
41
+ | --- | --- | --- | --- |
42
+ | `reportSoftNav` | `boolean` | `false` | Also report web vitals for soft navigations, not only for the initial page load. |
43
+
44
+ ##### `reportSoftNav`
45
+
46
+ Single page applications update the URL and history without a full page navigation, so by default
47
+ Core Web Vitals are only measured once, for the initial page load. With `reportSoftNav` enabled,
48
+ LCP, FCP, INP, CLS and TTFB are also measured per
49
+ [soft navigation](https://github.com/WICG/soft-navigations), and one `[Amplitude] Web Vitals` event
50
+ is sent per navigation, with the page properties of the URL the metrics belong to. Metrics measured
51
+ for a soft navigation have a `navigationType` of `soft-navigation`.
52
+
53
+ ```typescript
54
+ const plugin = webVitalsPlugin({ reportSoftNav: true });
55
+ ```
56
+
57
+ This requires browser support for the Soft Navigations API (Chromium 151+). In browsers without it,
58
+ reporting is unchanged from the default behavior.
59
+
60
+ Note that enabling this also changes how the initial page load is measured: its metrics are
61
+ finalized once the first soft navigation occurs, rather than when the page is hidden.
62
+
63
+ When using the Browser SDK's autocapture, the same option can be set through
64
+ `autocapture.webVitals`:
65
+
66
+ ```typescript
67
+ amplitude.init('API_KEY', {
68
+ autocapture: {
69
+ webVitals: { reportSoftNav: true },
70
+ },
71
+ });
72
+ ```
73
+
38
74
  ### 3. Install plugin to Amplitude SDK
39
75
 
40
76
  ```typescript
@@ -1,3 +1,37 @@
1
1
  export declare const PLUGIN_NAME = "web-vitals-browser";
2
2
  export declare const WEB_VITALS_EVENT_NAME = "[Amplitude] Web Vitals";
3
+ import type { Metric } from 'web-vitals';
4
+ /**
5
+ * How long to wait, after a newer navigation starts reporting metrics, before sending the event for
6
+ * a superseded navigation. Metrics for a navigation can be reported slightly after the next soft
7
+ * navigation begins, so the event is deferred to give those late metrics a chance to land.
8
+ */
9
+ export declare const SOFT_NAV_FLUSH_DELAY_MS = 1000;
10
+ export declare const WebVitalsMetricProperty: {
11
+ readonly LCP: "[Amplitude] LCP";
12
+ readonly FCP: "[Amplitude] FCP";
13
+ readonly INP: "[Amplitude] INP";
14
+ readonly CLS: "[Amplitude] CLS";
15
+ readonly TTFB: "[Amplitude] TTFB";
16
+ };
17
+ export type WebVitalsMetricPropertyType = (typeof WebVitalsMetricProperty)[keyof typeof WebVitalsMetricProperty];
18
+ export type WebVitalsMetricPayload = {
19
+ value: number;
20
+ rating: Metric['rating'];
21
+ delta: number;
22
+ navigationType: Metric['navigationType'];
23
+ id: string;
24
+ timestamp: number;
25
+ navigationStart: number;
26
+ navigationId?: number;
27
+ };
28
+ export type WebVitalsEventPayload = {
29
+ [P in WebVitalsMetricPropertyType]?: WebVitalsMetricPayload;
30
+ } & {
31
+ '[Amplitude] Page Domain'?: string;
32
+ '[Amplitude] Page Location'?: string;
33
+ '[Amplitude] Page Path'?: string;
34
+ '[Amplitude] Page Title'?: string;
35
+ '[Amplitude] Page URL'?: string;
36
+ };
3
37
  //# sourceMappingURL=constants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAChD,eAAO,MAAM,qBAAqB,2BAA2B,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAChD,eAAO,MAAM,qBAAqB,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,OAAO,CAAC;AAE5C,eAAO,MAAM,uBAAuB;;;;;;CAM1B,CAAC;AAEX,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC;AAEjH,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;KACjC,CAAC,IAAI,2BAA2B,CAAC,CAAC,EAAE,sBAAsB;CAC5D,GAAG;IACF,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC"}
@@ -1,6 +1,19 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.WEB_VITALS_EVENT_NAME = exports.PLUGIN_NAME = void 0;
3
+ exports.WebVitalsMetricProperty = exports.SOFT_NAV_FLUSH_DELAY_MS = exports.WEB_VITALS_EVENT_NAME = exports.PLUGIN_NAME = void 0;
4
4
  exports.PLUGIN_NAME = 'web-vitals-browser';
5
5
  exports.WEB_VITALS_EVENT_NAME = '[Amplitude] Web Vitals';
6
+ /**
7
+ * How long to wait, after a newer navigation starts reporting metrics, before sending the event for
8
+ * a superseded navigation. Metrics for a navigation can be reported slightly after the next soft
9
+ * navigation begins, so the event is deferred to give those late metrics a chance to land.
10
+ */
11
+ exports.SOFT_NAV_FLUSH_DELAY_MS = 1000;
12
+ exports.WebVitalsMetricProperty = {
13
+ LCP: '[Amplitude] LCP',
14
+ FCP: '[Amplitude] FCP',
15
+ INP: '[Amplitude] INP',
16
+ CLS: '[Amplitude] CLS',
17
+ TTFB: '[Amplitude] TTFB',
18
+ };
6
19
  //# sourceMappingURL=constants.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,oBAAoB,CAAC;AACnC,QAAA,qBAAqB,GAAG,wBAAwB,CAAC","sourcesContent":["export const PLUGIN_NAME = 'web-vitals-browser';\nexport const WEB_VITALS_EVENT_NAME = '[Amplitude] Web Vitals';\n"]}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,oBAAoB,CAAC;AACnC,QAAA,qBAAqB,GAAG,wBAAwB,CAAC;AAG9D;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,IAAI,CAAC;AAE/B,QAAA,uBAAuB,GAAG;IACrC,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,IAAI,EAAE,kBAAkB;CAChB,CAAC","sourcesContent":["export const PLUGIN_NAME = 'web-vitals-browser';\nexport const WEB_VITALS_EVENT_NAME = '[Amplitude] Web Vitals';\nimport type { Metric } from 'web-vitals';\n\n/**\n * How long to wait, after a newer navigation starts reporting metrics, before sending the event for\n * a superseded navigation. Metrics for a navigation can be reported slightly after the next soft\n * navigation begins, so the event is deferred to give those late metrics a chance to land.\n */\nexport const SOFT_NAV_FLUSH_DELAY_MS = 1000;\n\nexport const WebVitalsMetricProperty = {\n LCP: '[Amplitude] LCP',\n FCP: '[Amplitude] FCP',\n INP: '[Amplitude] INP',\n CLS: '[Amplitude] CLS',\n TTFB: '[Amplitude] TTFB',\n} as const;\n\nexport type WebVitalsMetricPropertyType = (typeof WebVitalsMetricProperty)[keyof typeof WebVitalsMetricProperty];\n\nexport type WebVitalsMetricPayload = {\n value: number;\n rating: Metric['rating'];\n delta: number;\n navigationType: Metric['navigationType'];\n id: string;\n timestamp: number;\n navigationStart: number;\n navigationId?: number;\n};\n\nexport type WebVitalsEventPayload = {\n [P in WebVitalsMetricPropertyType]?: WebVitalsMetricPayload;\n} & {\n '[Amplitude] Page Domain'?: string;\n '[Amplitude] Page Location'?: string;\n '[Amplitude] Page Path'?: string;\n '[Amplitude] Page Title'?: string;\n '[Amplitude] Page URL'?: string;\n};\n"]}
@@ -1,3 +1,11 @@
1
- export { webVitalsPlugin as plugin, webVitalsPlugin } from './web-vitals-plugin';
1
+ import { WebVitalsOptions } from '@amplitude/analytics-core';
2
+ import { webVitalsSoftNavPlugin } from './web-vitals-soft-nav-plugin';
2
3
  export { VERSION } from './version';
4
+ export { webVitalsSoftNavPlugin };
5
+ /**
6
+ * Creates the web vitals plugin. When `reportSoftNav` is enabled, uses the soft-navigation
7
+ * plugin so each navigation (including SPA route changes) is reported separately.
8
+ */
9
+ export declare const webVitalsPlugin: (options?: WebVitalsOptions) => import("./web-vitals-plugin").BrowserEnrichmentPlugin;
10
+ export { webVitalsPlugin as plugin };
3
11
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,IAAI,MAAM,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAkB,MAAM,2BAA2B,CAAC;AAE7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAEtE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAOlC;;;GAGG;AACH,eAAO,MAAM,eAAe,aAAa,gBAAgB,0DAKxD,CAAC;AAEF,OAAO,EAAE,eAAe,IAAI,MAAM,EAAE,CAAC"}
package/lib/cjs/index.js CHANGED
@@ -1,9 +1,27 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.VERSION = exports.webVitalsPlugin = exports.plugin = void 0;
3
+ exports.plugin = exports.webVitalsPlugin = exports.webVitalsSoftNavPlugin = exports.VERSION = void 0;
4
+ var analytics_core_1 = require("@amplitude/analytics-core");
4
5
  var web_vitals_plugin_1 = require("./web-vitals-plugin");
5
- Object.defineProperty(exports, "plugin", { enumerable: true, get: function () { return web_vitals_plugin_1.webVitalsPlugin; } });
6
- Object.defineProperty(exports, "webVitalsPlugin", { enumerable: true, get: function () { return web_vitals_plugin_1.webVitalsPlugin; } });
6
+ var web_vitals_soft_nav_plugin_1 = require("./web-vitals-soft-nav-plugin");
7
+ Object.defineProperty(exports, "webVitalsSoftNavPlugin", { enumerable: true, get: function () { return web_vitals_soft_nav_plugin_1.webVitalsSoftNavPlugin; } });
7
8
  var version_1 = require("./version");
8
9
  Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () { return version_1.VERSION; } });
10
+ var isSoftNavSupported = function () {
11
+ var globalScope = (0, analytics_core_1.getGlobalScope)();
12
+ return globalScope && 'PerformanceSoftNavigation' in globalScope;
13
+ };
14
+ /**
15
+ * Creates the web vitals plugin. When `reportSoftNav` is enabled, uses the soft-navigation
16
+ * plugin so each navigation (including SPA route changes) is reported separately.
17
+ */
18
+ var webVitalsPlugin = function (options) {
19
+ if (options === void 0) { options = {}; }
20
+ if (options.reportSoftNav === true && isSoftNavSupported()) {
21
+ return (0, web_vitals_soft_nav_plugin_1.webVitalsSoftNavPlugin)();
22
+ }
23
+ return (0, web_vitals_plugin_1.webVitalsPlugin)();
24
+ };
25
+ exports.webVitalsPlugin = webVitalsPlugin;
26
+ exports.plugin = exports.webVitalsPlugin;
9
27
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,yDAAiF;AAAxE,2GAAA,eAAe,OAAU;AAAE,oHAAA,eAAe,OAAA;AACnD,qCAAoC;AAA3B,kGAAA,OAAO,OAAA","sourcesContent":["export { webVitalsPlugin as plugin, webVitalsPlugin } from './web-vitals-plugin';\nexport { VERSION } from './version';\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,4DAA6E;AAC7E,yDAA+E;AAC/E,2EAAsE;AAG7D,uGAHA,mDAAsB,OAGA;AAD/B,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAGhB,IAAM,kBAAkB,GAAG;IACzB,IAAM,WAAW,GAAG,IAAA,+BAAc,GAAE,CAAC;IACrC,OAAO,WAAW,IAAI,2BAA2B,IAAI,WAAW,CAAC;AACnE,CAAC,CAAC;AAEF;;;GAGG;AACI,IAAM,eAAe,GAAG,UAAC,OAA8B;IAA9B,wBAAA,EAAA,YAA8B;IAC5D,IAAI,OAAO,CAAC,aAAa,KAAK,IAAI,IAAI,kBAAkB,EAAE,EAAE;QAC1D,OAAO,IAAA,mDAAsB,GAAE,CAAC;KACjC;IACD,OAAO,IAAA,mCAAqB,GAAE,CAAC;AACjC,CAAC,CAAC;AALW,QAAA,eAAe,mBAK1B;AAE0B,iBAPf,uBAAe,CAOM","sourcesContent":["import { WebVitalsOptions, getGlobalScope } from '@amplitude/analytics-core';\nimport { webVitalsPlugin as createWebVitalsPlugin } from './web-vitals-plugin';\nimport { webVitalsSoftNavPlugin } from './web-vitals-soft-nav-plugin';\n\nexport { VERSION } from './version';\nexport { webVitalsSoftNavPlugin };\n\nconst isSoftNavSupported = () => {\n const globalScope = getGlobalScope();\n return globalScope && 'PerformanceSoftNavigation' in globalScope;\n};\n\n/**\n * Creates the web vitals plugin. When `reportSoftNav` is enabled, uses the soft-navigation\n * plugin so each navigation (including SPA route changes) is reported separately.\n */\nexport const webVitalsPlugin = (options: WebVitalsOptions = {}) => {\n if (options.reportSoftNav === true && isSoftNavSupported()) {\n return webVitalsSoftNavPlugin();\n }\n return createWebVitalsPlugin();\n};\n\nexport { webVitalsPlugin as plugin };\n"]}
@@ -0,0 +1,4 @@
1
+ import { WebVitalsMetricPayload } from './constants';
2
+ import { Metric } from 'web-vitals';
3
+ export declare function processMetric(metric: Metric, isSoftNav?: boolean): WebVitalsMetricPayload;
4
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAQpC,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,sBAAsB,CAkBvF"}
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.processMetric = void 0;
4
+ function getMetricStartTime(metric) {
5
+ var _a;
6
+ /* istanbul ignore next */
7
+ var startTime = ((_a = metric.entries[0]) === null || _a === void 0 ? void 0 : _a.startTime) || 0;
8
+ return performance.timeOrigin + startTime;
9
+ }
10
+ function processMetric(metric, isSoftNav) {
11
+ if (isSoftNav === void 0) { isSoftNav = false; }
12
+ var payload = {
13
+ value: metric.value,
14
+ rating: metric.rating,
15
+ delta: metric.delta,
16
+ navigationType: metric.navigationType,
17
+ id: metric.id,
18
+ timestamp: Math.floor(getMetricStartTime(metric)),
19
+ navigationStart: !isSoftNav
20
+ ? Math.floor(performance.timeOrigin)
21
+ : Math.floor(performance.timeOrigin + /* istanbul ignore next */ (metric.navigationStartTime || 0)),
22
+ };
23
+ if (isSoftNav) {
24
+ payload.navigationId = metric.navigationId;
25
+ }
26
+ return payload;
27
+ }
28
+ exports.processMetric = processMetric;
29
+ //# sourceMappingURL=utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;AAGA,SAAS,kBAAkB,CAAC,MAAc;;IACxC,0BAA0B;IAC1B,IAAM,SAAS,GAAG,CAAA,MAAA,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,SAAS,KAAI,CAAC,CAAC;IACpD,OAAO,WAAW,CAAC,UAAU,GAAG,SAAS,CAAC;AAC5C,CAAC;AAED,SAAgB,aAAa,CAAC,MAAc,EAAE,SAAiB;IAAjB,0BAAA,EAAA,iBAAiB;IAC7D,IAAM,OAAO,GAA2B;QACtC,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACjD,eAAe,EAAE,CAAC,SAAS;YACzB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC;YACpC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,GAAG,0BAA0B,CAAC,CAAC,MAAM,CAAC,mBAAmB,IAAI,CAAC,CAAC,CAAC;KACtG,CAAC;IAEF,IAAI,SAAS,EAAE;QACb,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;KAC5C;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAlBD,sCAkBC","sourcesContent":["import { WebVitalsMetricPayload } from './constants';\nimport { Metric } from 'web-vitals';\n\nfunction getMetricStartTime(metric: Metric) {\n /* istanbul ignore next */\n const startTime = metric.entries[0]?.startTime || 0;\n return performance.timeOrigin + startTime;\n}\n\nexport function processMetric(metric: Metric, isSoftNav = false): WebVitalsMetricPayload {\n const payload: WebVitalsMetricPayload = {\n value: metric.value,\n rating: metric.rating,\n delta: metric.delta,\n navigationType: metric.navigationType,\n id: metric.id,\n timestamp: Math.floor(getMetricStartTime(metric)),\n navigationStart: !isSoftNav\n ? Math.floor(performance.timeOrigin)\n : Math.floor(performance.timeOrigin + /* istanbul ignore next */ (metric.navigationStartTime || 0)),\n };\n\n if (isSoftNav) {\n payload.navigationId = metric.navigationId;\n }\n\n return payload;\n}\n"]}
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.1.49-video-analytics-5.0";
1
+ export declare const VERSION = "1.2.0";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,+BAA+B,CAAC"}
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '1.1.49-video-analytics-5.0';
4
+ exports.VERSION = '1.2.0';
5
5
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,4BAA4B,CAAC","sourcesContent":["export const VERSION = '1.1.49-video-analytics-5.0';\n"]}
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC","sourcesContent":["export const VERSION = '1.2.0';\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"web-vitals-plugin.d.ts","sourceRoot":"","sources":["../../src/web-vitals-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,aAAa,EACb,gBAAgB,EAGjB,MAAM,2BAA2B,CAAC;AAInC,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AA2CrF,eAAO,MAAM,eAAe,QAAO,uBAkElC,CAAC"}
1
+ {"version":3,"file":"web-vitals-plugin.d.ts","sourceRoot":"","sources":["../../src/web-vitals-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,aAAa,EACb,gBAAgB,EAGjB,MAAM,2BAA2B,CAAC;AAKnC,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAErF,eAAO,MAAM,eAAe,QAAO,uBAkElC,CAAC"}
@@ -6,23 +6,7 @@ var tslib_1 = require("tslib");
6
6
  var analytics_core_1 = require("@amplitude/analytics-core");
7
7
  var constants_1 = require("./constants");
8
8
  var web_vitals_1 = require("web-vitals");
9
- function getMetricStartTime(metric) {
10
- var _a;
11
- /* istanbul ignore next */
12
- var startTime = ((_a = metric.entries[0]) === null || _a === void 0 ? void 0 : _a.startTime) || 0;
13
- return performance.timeOrigin + startTime;
14
- }
15
- function processMetric(metric) {
16
- return {
17
- value: metric.value,
18
- rating: metric.rating,
19
- delta: metric.delta,
20
- navigationType: metric.navigationType,
21
- id: metric.id,
22
- timestamp: Math.floor(getMetricStartTime(metric)),
23
- navigationStart: Math.floor(performance.timeOrigin),
24
- };
25
- }
9
+ var utils_1 = require("./utils");
26
10
  var webVitalsPlugin = function () {
27
11
  var visibilityListener = null;
28
12
  var globalScope = (0, analytics_core_1.getGlobalScope)();
@@ -43,19 +27,19 @@ var webVitalsPlugin = function () {
43
27
  '[Amplitude] Page URL': (0, analytics_core_1.getDecodeURI)(locationHref.split('?')[0], config.loggerProvider),
44
28
  };
45
29
  (0, web_vitals_1.onLCP)(function (metric) {
46
- webVitalsPayload['[Amplitude] LCP'] = processMetric(metric);
30
+ webVitalsPayload['[Amplitude] LCP'] = (0, utils_1.processMetric)(metric);
47
31
  });
48
32
  (0, web_vitals_1.onFCP)(function (metric) {
49
- webVitalsPayload['[Amplitude] FCP'] = processMetric(metric);
33
+ webVitalsPayload['[Amplitude] FCP'] = (0, utils_1.processMetric)(metric);
50
34
  });
51
35
  (0, web_vitals_1.onINP)(function (metric) {
52
- webVitalsPayload['[Amplitude] INP'] = processMetric(metric);
36
+ webVitalsPayload['[Amplitude] INP'] = (0, utils_1.processMetric)(metric);
53
37
  });
54
38
  (0, web_vitals_1.onCLS)(function (metric) {
55
- webVitalsPayload['[Amplitude] CLS'] = processMetric(metric);
39
+ webVitalsPayload['[Amplitude] CLS'] = (0, utils_1.processMetric)(metric);
56
40
  });
57
41
  (0, web_vitals_1.onTTFB)(function (metric) {
58
- webVitalsPayload['[Amplitude] TTFB'] = processMetric(metric);
42
+ webVitalsPayload['[Amplitude] TTFB'] = (0, utils_1.processMetric)(metric);
59
43
  });
60
44
  visibilityListener = function () {
61
45
  if (doc.visibilityState === 'hidden' && visibilityListener) {
@@ -1 +1 @@
1
- {"version":3,"file":"web-vitals-plugin.js","sourceRoot":"","sources":["../../src/web-vitals-plugin.ts"],"names":[],"mappings":";;;;AAAA,0CAA0C;AAC1C,4DAMmC;AACnC,yCAAiE;AACjE,yCAAwE;AA2BxE,SAAS,kBAAkB,CAAC,MAAc;;IACxC,0BAA0B;IAC1B,IAAM,SAAS,GAAG,CAAA,MAAA,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,SAAS,KAAI,CAAC,CAAC;IACpD,OAAO,WAAW,CAAC,UAAU,GAAG,SAAS,CAAC;AAC5C,CAAC;AAED,SAAS,aAAa,CAAC,MAAc;IACnC,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACjD,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC;KACpD,CAAC;AACJ,CAAC;AAEM,IAAM,eAAe,GAAG;IAC7B,IAAI,kBAAkB,GAAiD,IAAI,CAAC;IAC5E,IAAM,WAAW,GAAG,IAAA,+BAAc,GAAE,CAAC;IACrC,IAAM,GAAG,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC;IAClC,IAAM,QAAQ,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC;IACvC,IAAM,KAAK,GAAqC,UAAO,MAAM,EAAE,SAAS;;;YACtE,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,sBAAO;aACR;YACK,YAAY,GAAG,IAAA,6BAAY,EAAC,0BAA0B,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,KAAI,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;YACpG,gBAAgB,GAA0B;gBAC9C,yBAAyB,EAAE,0BAA0B,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,EAAE;gBAC9E,2BAA2B,EAAE,YAAY;gBACzC,uBAAuB,EAAE,IAAA,6BAAY,EAAC,0BAA0B,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC;gBACjH,wBAAwB,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE;gBAC9G,sBAAsB,EAAE,IAAA,6BAAY,EAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;aACxF,CAAC;YAEF,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,mBAAM,EAAC,UAAC,MAAM;gBACZ,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YAEH,kBAAkB,GAAG;gBACnB,IAAI,GAAG,CAAC,eAAe,KAAK,QAAQ,IAAI,kBAAkB,EAAE;oBAC1D,SAAS,CAAC,KAAK,CAAC,iCAAqB,EAAE,gBAAgB,CAAC,CAAC;oBACzD,GAAG,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;oBAChE,kBAAkB,GAAG,IAAI,CAAC;iBAC3B;YACH,CAAC,CAAC;YACF,GAAG,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;;;SAC9D,CAAC;IAEF,IAAM,OAAO,GAAuC,UAAO,KAAK;;YAC9D,sBAAO,KAAK,EAAC;;SACd,CAAC;IAEF,IAAM,QAAQ,GAAG;;YACf,IAAI,kBAAkB,EAAE;gBACtB,0BAA0B;gBAC1B,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,mBAAmB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;aAClE;;;SACF,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,uBAAW;QACjB,IAAI,EAAE,YAAY;QAClB,KAAK,OAAA;QACL,OAAO,SAAA;QACP,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC,CAAC;AAlEW,QAAA,eAAe,mBAkE1B","sourcesContent":["/* eslint-disable no-restricted-globals */\nimport {\n BrowserClient,\n BrowserConfig,\n EnrichmentPlugin,\n getGlobalScope,\n getDecodeURI,\n} from '@amplitude/analytics-core';\nimport { PLUGIN_NAME, WEB_VITALS_EVENT_NAME } from './constants';\nimport { onLCP, onINP, onCLS, onFCP, onTTFB, Metric } from 'web-vitals';\n\nexport type BrowserEnrichmentPlugin = EnrichmentPlugin<BrowserClient, BrowserConfig>;\n\ntype WebVitalsMetricPayload = {\n value: number;\n rating: Metric['rating'];\n delta: number;\n navigationType: Metric['navigationType'];\n id: string;\n timestamp: number;\n navigationStart: number;\n};\n\ntype WebVitalsEventPayload = {\n '[Amplitude] LCP'?: WebVitalsMetricPayload;\n '[Amplitude] FCP'?: WebVitalsMetricPayload;\n '[Amplitude] INP'?: WebVitalsMetricPayload;\n '[Amplitude] CLS'?: WebVitalsMetricPayload;\n '[Amplitude] TTFB'?: WebVitalsMetricPayload;\n '[Amplitude] Page Domain'?: string;\n '[Amplitude] Page Location'?: string;\n '[Amplitude] Page Path'?: string;\n '[Amplitude] Page Title'?: string;\n '[Amplitude] Page URL'?: string;\n};\n\nfunction getMetricStartTime(metric: Metric) {\n /* istanbul ignore next */\n const startTime = metric.entries[0]?.startTime || 0;\n return performance.timeOrigin + startTime;\n}\n\nfunction processMetric(metric: Metric) {\n return {\n value: metric.value,\n rating: metric.rating,\n delta: metric.delta,\n navigationType: metric.navigationType,\n id: metric.id,\n timestamp: Math.floor(getMetricStartTime(metric)),\n navigationStart: Math.floor(performance.timeOrigin),\n };\n}\n\nexport const webVitalsPlugin = (): BrowserEnrichmentPlugin => {\n let visibilityListener: ((this: Document, ev: Event) => void) | null = null;\n const globalScope = getGlobalScope();\n const doc = globalScope?.document;\n const location = globalScope?.location;\n const setup: BrowserEnrichmentPlugin['setup'] = async (config, amplitude) => {\n if (doc === undefined) {\n return;\n }\n const locationHref = getDecodeURI(/* istanbul ignore next */ location?.href || '', config.loggerProvider);\n const webVitalsPayload: WebVitalsEventPayload = {\n '[Amplitude] Page Domain': /* istanbul ignore next */ location?.hostname || '',\n '[Amplitude] Page Location': locationHref,\n '[Amplitude] Page Path': getDecodeURI(/* istanbul ignore next */ location?.pathname || '', config.loggerProvider),\n '[Amplitude] Page Title': /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '',\n '[Amplitude] Page URL': getDecodeURI(locationHref.split('?')[0], config.loggerProvider),\n };\n\n onLCP((metric) => {\n webVitalsPayload['[Amplitude] LCP'] = processMetric(metric);\n });\n\n onFCP((metric) => {\n webVitalsPayload['[Amplitude] FCP'] = processMetric(metric);\n });\n\n onINP((metric) => {\n webVitalsPayload['[Amplitude] INP'] = processMetric(metric);\n });\n\n onCLS((metric) => {\n webVitalsPayload['[Amplitude] CLS'] = processMetric(metric);\n });\n\n onTTFB((metric) => {\n webVitalsPayload['[Amplitude] TTFB'] = processMetric(metric);\n });\n\n visibilityListener = () => {\n if (doc.visibilityState === 'hidden' && visibilityListener) {\n amplitude.track(WEB_VITALS_EVENT_NAME, webVitalsPayload);\n doc.removeEventListener('visibilitychange', visibilityListener);\n visibilityListener = null;\n }\n };\n doc.addEventListener('visibilitychange', visibilityListener);\n };\n\n const execute: BrowserEnrichmentPlugin['execute'] = async (event) => {\n return event;\n };\n\n const teardown = async () => {\n if (visibilityListener) {\n /* istanbul ignore next */\n doc?.removeEventListener('visibilitychange', visibilityListener);\n }\n };\n\n return {\n name: PLUGIN_NAME,\n type: 'enrichment',\n setup,\n execute,\n teardown,\n };\n};\n"]}
1
+ {"version":3,"file":"web-vitals-plugin.js","sourceRoot":"","sources":["../../src/web-vitals-plugin.ts"],"names":[],"mappings":";;;;AAAA,0CAA0C;AAC1C,4DAMmC;AACnC,yCAAwF;AACxF,yCAAgE;AAChE,iCAAwC;AAIjC,IAAM,eAAe,GAAG;IAC7B,IAAI,kBAAkB,GAAiD,IAAI,CAAC;IAC5E,IAAM,WAAW,GAAG,IAAA,+BAAc,GAAE,CAAC;IACrC,IAAM,GAAG,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC;IAClC,IAAM,QAAQ,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC;IACvC,IAAM,KAAK,GAAqC,UAAO,MAAM,EAAE,SAAS;;;YACtE,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,sBAAO;aACR;YACK,YAAY,GAAG,IAAA,6BAAY,EAAC,0BAA0B,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,KAAI,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;YACpG,gBAAgB,GAA0B;gBAC9C,yBAAyB,EAAE,0BAA0B,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,EAAE;gBAC9E,2BAA2B,EAAE,YAAY;gBACzC,uBAAuB,EAAE,IAAA,6BAAY,EAAC,0BAA0B,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC;gBACjH,wBAAwB,EAAE,0BAA0B,CAAC,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE;gBAC9G,sBAAsB,EAAE,IAAA,6BAAY,EAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;aACxF,CAAC;YAEF,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,kBAAK,EAAC,UAAC,MAAM;gBACX,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,IAAA,mBAAM,EAAC,UAAC,MAAM;gBACZ,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YAEH,kBAAkB,GAAG;gBACnB,IAAI,GAAG,CAAC,eAAe,KAAK,QAAQ,IAAI,kBAAkB,EAAE;oBAC1D,SAAS,CAAC,KAAK,CAAC,iCAAqB,EAAE,gBAAgB,CAAC,CAAC;oBACzD,GAAG,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;oBAChE,kBAAkB,GAAG,IAAI,CAAC;iBAC3B;YACH,CAAC,CAAC;YACF,GAAG,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;;;SAC9D,CAAC;IAEF,IAAM,OAAO,GAAuC,UAAO,KAAK;;YAC9D,sBAAO,KAAK,EAAC;;SACd,CAAC;IAEF,IAAM,QAAQ,GAAG;;YACf,IAAI,kBAAkB,EAAE;gBACtB,0BAA0B;gBAC1B,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,mBAAmB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;aAClE;;;SACF,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,uBAAW;QACjB,IAAI,EAAE,YAAY;QAClB,KAAK,OAAA;QACL,OAAO,SAAA;QACP,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC,CAAC;AAlEW,QAAA,eAAe,mBAkE1B","sourcesContent":["/* eslint-disable no-restricted-globals */\nimport {\n BrowserClient,\n BrowserConfig,\n EnrichmentPlugin,\n getGlobalScope,\n getDecodeURI,\n} from '@amplitude/analytics-core';\nimport { PLUGIN_NAME, WEB_VITALS_EVENT_NAME, WebVitalsEventPayload } from './constants';\nimport { onLCP, onINP, onCLS, onFCP, onTTFB } from 'web-vitals';\nimport { processMetric } from './utils';\n\nexport type BrowserEnrichmentPlugin = EnrichmentPlugin<BrowserClient, BrowserConfig>;\n\nexport const webVitalsPlugin = (): BrowserEnrichmentPlugin => {\n let visibilityListener: ((this: Document, ev: Event) => void) | null = null;\n const globalScope = getGlobalScope();\n const doc = globalScope?.document;\n const location = globalScope?.location;\n const setup: BrowserEnrichmentPlugin['setup'] = async (config, amplitude) => {\n if (doc === undefined) {\n return;\n }\n const locationHref = getDecodeURI(/* istanbul ignore next */ location?.href || '', config.loggerProvider);\n const webVitalsPayload: WebVitalsEventPayload = {\n '[Amplitude] Page Domain': /* istanbul ignore next */ location?.hostname || '',\n '[Amplitude] Page Location': locationHref,\n '[Amplitude] Page Path': getDecodeURI(/* istanbul ignore next */ location?.pathname || '', config.loggerProvider),\n '[Amplitude] Page Title': /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '',\n '[Amplitude] Page URL': getDecodeURI(locationHref.split('?')[0], config.loggerProvider),\n };\n\n onLCP((metric) => {\n webVitalsPayload['[Amplitude] LCP'] = processMetric(metric);\n });\n\n onFCP((metric) => {\n webVitalsPayload['[Amplitude] FCP'] = processMetric(metric);\n });\n\n onINP((metric) => {\n webVitalsPayload['[Amplitude] INP'] = processMetric(metric);\n });\n\n onCLS((metric) => {\n webVitalsPayload['[Amplitude] CLS'] = processMetric(metric);\n });\n\n onTTFB((metric) => {\n webVitalsPayload['[Amplitude] TTFB'] = processMetric(metric);\n });\n\n visibilityListener = () => {\n if (doc.visibilityState === 'hidden' && visibilityListener) {\n amplitude.track(WEB_VITALS_EVENT_NAME, webVitalsPayload);\n doc.removeEventListener('visibilitychange', visibilityListener);\n visibilityListener = null;\n }\n };\n doc.addEventListener('visibilitychange', visibilityListener);\n };\n\n const execute: BrowserEnrichmentPlugin['execute'] = async (event) => {\n return event;\n };\n\n const teardown = async () => {\n if (visibilityListener) {\n /* istanbul ignore next */\n doc?.removeEventListener('visibilitychange', visibilityListener);\n }\n };\n\n return {\n name: PLUGIN_NAME,\n type: 'enrichment',\n setup,\n execute,\n teardown,\n };\n};\n"]}
@@ -0,0 +1,4 @@
1
+ import { BrowserClient, BrowserConfig, EnrichmentPlugin } from '@amplitude/analytics-core';
2
+ export type BrowserEnrichmentPlugin = EnrichmentPlugin<BrowserClient, BrowserConfig>;
3
+ export declare const webVitalsSoftNavPlugin: () => BrowserEnrichmentPlugin;
4
+ //# sourceMappingURL=web-vitals-soft-nav-plugin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"web-vitals-soft-nav-plugin.d.ts","sourceRoot":"","sources":["../../src/web-vitals-soft-nav-plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,aAAa,EACb,aAAa,EACb,gBAAgB,EAIjB,MAAM,2BAA2B,CAAC;AAWnC,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAmCrF,eAAO,MAAM,sBAAsB,QAAO,uBA8HzC,CAAC"}
@@ -0,0 +1,177 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.webVitalsSoftNavPlugin = void 0;
4
+ var tslib_1 = require("tslib");
5
+ /* eslint-disable no-restricted-globals */
6
+ var web_vitals_1 = require("web-vitals");
7
+ var analytics_core_1 = require("@amplitude/analytics-core");
8
+ var constants_1 = require("./constants");
9
+ var utils_1 = require("./utils");
10
+ var METRIC_PROPERTIES = Object.values(constants_1.WebVitalsMetricProperty);
11
+ /**
12
+ * Builds the page properties for the URL the metrics belong to. That is the URL of the navigation
13
+ * being reported on, which is not necessarily the current URL: a navigation's metrics can be
14
+ * reported after the next navigation has already started.
15
+ */
16
+ function getPageProperties(url, title, loggerProvider) {
17
+ var hostname = '';
18
+ var pathname = '';
19
+ try {
20
+ var parsedUrl = new URL(url);
21
+ hostname = parsedUrl.hostname;
22
+ pathname = parsedUrl.pathname;
23
+ }
24
+ catch (e) {
25
+ loggerProvider.debug('Web vitals plugin is unable to parse page URL: ', e);
26
+ }
27
+ var locationHref = (0, analytics_core_1.getDecodeURI)(url, loggerProvider);
28
+ return {
29
+ '[Amplitude] Page Domain': hostname,
30
+ '[Amplitude] Page Location': locationHref,
31
+ '[Amplitude] Page Path': (0, analytics_core_1.getDecodeURI)(pathname, loggerProvider),
32
+ '[Amplitude] Page Title': title,
33
+ '[Amplitude] Page URL': (0, analytics_core_1.getDecodeURI)(locationHref.split('?')[0], loggerProvider),
34
+ };
35
+ }
36
+ function hasMetrics(payload) {
37
+ return METRIC_PROPERTIES.some(function (property) { return property in payload; });
38
+ }
39
+ var webVitalsSoftNavPlugin = function () {
40
+ var visibilityListener = null;
41
+ var flushTimeout;
42
+ var globalScope = (0, analytics_core_1.getGlobalScope)();
43
+ var doc = globalScope === null || globalScope === void 0 ? void 0 : globalScope.document;
44
+ var location = globalScope === null || globalScope === void 0 ? void 0 : globalScope.location;
45
+ var isActive = false;
46
+ var recordedNavigationIds = new Set();
47
+ var setup = function (config, amplitude) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
48
+ var payloads, latestNavigationId, getPayload, flush, flushAll, scheduleFlushOfPreviousNavigations, recordMetric, reportOpts;
49
+ return tslib_1.__generator(this, function (_a) {
50
+ if (doc === undefined) {
51
+ return [2 /*return*/];
52
+ }
53
+ isActive = true;
54
+ payloads = new Map();
55
+ latestNavigationId = -1;
56
+ getPayload = function (metric) {
57
+ var key = metric.navigationId;
58
+ var payload = payloads.get(key);
59
+ if (!payload) {
60
+ payload = getPageProperties(
61
+ /* istanbul ignore next */ metric.navigationURL || (location === null || location === void 0 ? void 0 : location.href) || '',
62
+ /* istanbul ignore next */ doc.title || '', config.loggerProvider);
63
+ payloads.set(key, payload);
64
+ }
65
+ return payload;
66
+ };
67
+ flush = function (key) {
68
+ recordedNavigationIds.add(key);
69
+ var payload = payloads.get(key);
70
+ /* istanbul ignore if */
71
+ if (!payload) {
72
+ return;
73
+ }
74
+ payloads.delete(key);
75
+ // The page can be hidden repeatedly without a new navigation reporting anything.
76
+ if (hasMetrics(payload)) {
77
+ amplitude.track(constants_1.WEB_VITALS_EVENT_NAME, payload);
78
+ }
79
+ };
80
+ flushAll = function () {
81
+ var e_1, _a;
82
+ try {
83
+ for (var _b = tslib_1.__values(Array.from(payloads.keys())), _c = _b.next(); !_c.done; _c = _b.next()) {
84
+ var key = _c.value;
85
+ flush(key);
86
+ }
87
+ }
88
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
89
+ finally {
90
+ try {
91
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
92
+ }
93
+ finally { if (e_1) throw e_1.error; }
94
+ }
95
+ };
96
+ scheduleFlushOfPreviousNavigations = function (currentNavigationId) {
97
+ if (flushTimeout !== undefined) {
98
+ clearTimeout(flushTimeout);
99
+ }
100
+ flushTimeout = setTimeout(function () {
101
+ var e_2, _a;
102
+ flushTimeout = undefined;
103
+ try {
104
+ for (var _b = tslib_1.__values(Array.from(payloads.keys())), _c = _b.next(); !_c.done; _c = _b.next()) {
105
+ var key = _c.value;
106
+ if (key < currentNavigationId) {
107
+ flush(key);
108
+ }
109
+ }
110
+ }
111
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
112
+ finally {
113
+ try {
114
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
115
+ }
116
+ finally { if (e_2) throw e_2.error; }
117
+ }
118
+ }, constants_1.SOFT_NAV_FLUSH_DELAY_MS);
119
+ };
120
+ recordMetric = function (property) { return function (metric) {
121
+ if (!isActive || recordedNavigationIds.has(metric.navigationId)) {
122
+ return;
123
+ }
124
+ getPayload(metric)[property] = (0, utils_1.processMetric)(metric, true);
125
+ if (metric.navigationId > latestNavigationId) {
126
+ if (latestNavigationId !== -1) {
127
+ scheduleFlushOfPreviousNavigations(metric.navigationId);
128
+ }
129
+ latestNavigationId = metric.navigationId;
130
+ }
131
+ }; };
132
+ reportOpts = { reportSoftNavs: true };
133
+ (0, web_vitals_1.onLCP)(recordMetric(constants_1.WebVitalsMetricProperty.LCP), reportOpts);
134
+ (0, web_vitals_1.onFCP)(recordMetric(constants_1.WebVitalsMetricProperty.FCP), reportOpts);
135
+ (0, web_vitals_1.onINP)(recordMetric(constants_1.WebVitalsMetricProperty.INP), reportOpts);
136
+ (0, web_vitals_1.onCLS)(recordMetric(constants_1.WebVitalsMetricProperty.CLS), reportOpts);
137
+ (0, web_vitals_1.onTTFB)(recordMetric(constants_1.WebVitalsMetricProperty.TTFB), reportOpts);
138
+ visibilityListener = function () {
139
+ if (doc.visibilityState === 'hidden' && visibilityListener) {
140
+ flushAll();
141
+ // Keep listening: the page can become visible again and report metrics for further navigations.
142
+ }
143
+ };
144
+ doc.addEventListener('visibilitychange', visibilityListener);
145
+ return [2 /*return*/];
146
+ });
147
+ }); };
148
+ var execute = function (event) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
149
+ return tslib_1.__generator(this, function (_a) {
150
+ return [2 /*return*/, event];
151
+ });
152
+ }); };
153
+ var teardown = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
154
+ return tslib_1.__generator(this, function (_a) {
155
+ isActive = false;
156
+ if (flushTimeout !== undefined) {
157
+ clearTimeout(flushTimeout);
158
+ flushTimeout = undefined;
159
+ }
160
+ if (visibilityListener) {
161
+ /* istanbul ignore next */
162
+ doc === null || doc === void 0 ? void 0 : doc.removeEventListener('visibilitychange', visibilityListener);
163
+ visibilityListener = null;
164
+ }
165
+ return [2 /*return*/];
166
+ });
167
+ }); };
168
+ return {
169
+ name: constants_1.PLUGIN_NAME,
170
+ type: 'enrichment',
171
+ setup: setup,
172
+ execute: execute,
173
+ teardown: teardown,
174
+ };
175
+ };
176
+ exports.webVitalsSoftNavPlugin = webVitalsSoftNavPlugin;
177
+ //# sourceMappingURL=web-vitals-soft-nav-plugin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"web-vitals-soft-nav-plugin.js","sourceRoot":"","sources":["../../src/web-vitals-soft-nav-plugin.ts"],"names":[],"mappings":";;;;AAAA,0CAA0C;AAC1C,yCAAwE;AACxE,4DAOmC;AACnC,yCAOqB;AACrB,iCAAwC;AAIxC,IAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,mCAAuB,CAAC,CAAC;AAEjE;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,GAAW,EAAE,KAAa,EAAE,cAAuB;IAC5E,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI;QACF,IAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QAC9B,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;KAC/B;IAAC,OAAO,CAAC,EAAE;QACV,cAAc,CAAC,KAAK,CAAC,iDAAiD,EAAE,CAAC,CAAC,CAAC;KAC5E;IAED,IAAM,YAAY,GAAG,IAAA,6BAAY,EAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAEvD,OAAO;QACL,yBAAyB,EAAE,QAAQ;QACnC,2BAA2B,EAAE,YAAY;QACzC,uBAAuB,EAAE,IAAA,6BAAY,EAAC,QAAQ,EAAE,cAAc,CAAC;QAC/D,wBAAwB,EAAE,KAAK;QAC/B,sBAAsB,EAAE,IAAA,6BAAY,EAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC;KACjF,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,OAA8B;IAChD,OAAO,iBAAiB,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,IAAI,OAAO,EAAnB,CAAmB,CAAC,CAAC;AACnE,CAAC;AAEM,IAAM,sBAAsB,GAAG;IACpC,IAAI,kBAAkB,GAAiD,IAAI,CAAC;IAC5E,IAAI,YAAuD,CAAC;IAC5D,IAAM,WAAW,GAAG,IAAA,+BAAc,GAAE,CAAC;IACrC,IAAM,GAAG,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC;IAClC,IAAM,QAAQ,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC;IACvC,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAM,qBAAqB,GAAG,IAAI,GAAG,EAAU,CAAC;IAEhD,IAAM,KAAK,GAAqC,UAAO,MAAM,EAAE,SAAS;;;YACtE,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,sBAAO;aACR;YACD,QAAQ,GAAG,IAAI,CAAC;YAGV,QAAQ,GAAG,IAAI,GAAG,EAAiC,CAAC;YACtD,kBAAkB,GAAG,CAAC,CAAC,CAAC;YAEtB,UAAU,GAAG,UAAC,MAAc;gBAChC,IAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC;gBAChC,IAAI,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAChC,IAAI,CAAC,OAAO,EAAE;oBACZ,OAAO,GAAG,iBAAiB;oBACzB,0BAA0B,CAAC,MAAM,CAAC,aAAa,KAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAA,IAAI,EAAE;oBACvE,0BAA0B,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,EAC1C,MAAM,CAAC,cAAc,CACtB,CAAC;oBACF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;iBAC5B;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;YAEI,KAAK,GAAG,UAAC,GAAW;gBACxB,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAE/B,IAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAClC,wBAAwB;gBACxB,IAAI,CAAC,OAAO,EAAE;oBACZ,OAAO;iBACR;gBACD,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAErB,iFAAiF;gBACjF,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE;oBACvB,SAAS,CAAC,KAAK,CAAC,iCAAqB,EAAE,OAAO,CAAC,CAAC;iBACjD;YACH,CAAC,CAAC;YAEI,QAAQ,GAAG;;;oBACf,KAAkB,IAAA,KAAA,iBAAA,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA,gBAAA,4BAAE;wBAA1C,IAAM,GAAG,WAAA;wBACZ,KAAK,CAAC,GAAG,CAAC,CAAC;qBACZ;;;;;;;;;YACH,CAAC,CAAC;YAII,kCAAkC,GAAG,UAAC,mBAA2B;gBACrE,IAAI,YAAY,KAAK,SAAS,EAAE;oBAC9B,YAAY,CAAC,YAAY,CAAC,CAAC;iBAC5B;gBACD,YAAY,GAAG,UAAU,CAAC;;oBACxB,YAAY,GAAG,SAAS,CAAC;;wBACzB,KAAkB,IAAA,KAAA,iBAAA,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA,gBAAA,4BAAE;4BAA1C,IAAM,GAAG,WAAA;4BACZ,IAAI,GAAG,GAAG,mBAAmB,EAAE;gCAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;6BACZ;yBACF;;;;;;;;;gBACH,CAAC,EAAE,mCAAuB,CAAC,CAAC;YAC9B,CAAC,CAAC;YAEI,YAAY,GAAG,UAAC,QAAqC,IAAK,OAAA,UAAC,MAAc;gBAC7E,IAAI,CAAC,QAAQ,IAAI,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;oBAC/D,OAAO;iBACR;gBACD,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAA,qBAAa,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAE3D,IAAI,MAAM,CAAC,YAAY,GAAG,kBAAkB,EAAE;oBAC5C,IAAI,kBAAkB,KAAK,CAAC,CAAC,EAAE;wBAC7B,kCAAkC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;qBACzD;oBACD,kBAAkB,GAAG,MAAM,CAAC,YAAY,CAAC;iBAC1C;YACH,CAAC,EAZ+D,CAY/D,CAAC;YAEI,UAAU,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;YAE5C,IAAA,kBAAK,EAAC,YAAY,CAAC,mCAAuB,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7D,IAAA,kBAAK,EAAC,YAAY,CAAC,mCAAuB,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7D,IAAA,kBAAK,EAAC,YAAY,CAAC,mCAAuB,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7D,IAAA,kBAAK,EAAC,YAAY,CAAC,mCAAuB,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7D,IAAA,mBAAM,EAAC,YAAY,CAAC,mCAAuB,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;YAE/D,kBAAkB,GAAG;gBACnB,IAAI,GAAG,CAAC,eAAe,KAAK,QAAQ,IAAI,kBAAkB,EAAE;oBAC1D,QAAQ,EAAE,CAAC;oBACX,gGAAgG;iBACjG;YACH,CAAC,CAAC;YACF,GAAG,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;;;SAC9D,CAAC;IAEF,IAAM,OAAO,GAAuC,UAAO,KAAK;;YAC9D,sBAAO,KAAK,EAAC;;SACd,CAAC;IAEF,IAAM,QAAQ,GAAG;;YACf,QAAQ,GAAG,KAAK,CAAC;YACjB,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC9B,YAAY,CAAC,YAAY,CAAC,CAAC;gBAC3B,YAAY,GAAG,SAAS,CAAC;aAC1B;YACD,IAAI,kBAAkB,EAAE;gBACtB,0BAA0B;gBAC1B,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,mBAAmB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;gBACjE,kBAAkB,GAAG,IAAI,CAAC;aAC3B;;;SACF,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,uBAAW;QACjB,IAAI,EAAE,YAAY;QAClB,KAAK,OAAA;QACL,OAAO,SAAA;QACP,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC,CAAC;AA9HW,QAAA,sBAAsB,0BA8HjC","sourcesContent":["/* eslint-disable no-restricted-globals */\nimport { onLCP, onINP, onCLS, onFCP, onTTFB, Metric } from 'web-vitals';\nimport {\n BrowserClient,\n BrowserConfig,\n EnrichmentPlugin,\n ILogger,\n getGlobalScope,\n getDecodeURI,\n} from '@amplitude/analytics-core';\nimport {\n PLUGIN_NAME,\n SOFT_NAV_FLUSH_DELAY_MS,\n WEB_VITALS_EVENT_NAME,\n WebVitalsEventPayload,\n WebVitalsMetricProperty,\n WebVitalsMetricPropertyType,\n} from './constants';\nimport { processMetric } from './utils';\n\nexport type BrowserEnrichmentPlugin = EnrichmentPlugin<BrowserClient, BrowserConfig>;\n\nconst METRIC_PROPERTIES = Object.values(WebVitalsMetricProperty);\n\n/**\n * Builds the page properties for the URL the metrics belong to. That is the URL of the navigation\n * being reported on, which is not necessarily the current URL: a navigation's metrics can be\n * reported after the next navigation has already started.\n */\nfunction getPageProperties(url: string, title: string, loggerProvider: ILogger): WebVitalsEventPayload {\n let hostname = '';\n let pathname = '';\n try {\n const parsedUrl = new URL(url);\n hostname = parsedUrl.hostname;\n pathname = parsedUrl.pathname;\n } catch (e) {\n loggerProvider.debug('Web vitals plugin is unable to parse page URL: ', e);\n }\n\n const locationHref = getDecodeURI(url, loggerProvider);\n\n return {\n '[Amplitude] Page Domain': hostname,\n '[Amplitude] Page Location': locationHref,\n '[Amplitude] Page Path': getDecodeURI(pathname, loggerProvider),\n '[Amplitude] Page Title': title,\n '[Amplitude] Page URL': getDecodeURI(locationHref.split('?')[0], loggerProvider),\n };\n}\n\nfunction hasMetrics(payload: WebVitalsEventPayload): boolean {\n return METRIC_PROPERTIES.some((property) => property in payload);\n}\n\nexport const webVitalsSoftNavPlugin = (): BrowserEnrichmentPlugin => {\n let visibilityListener: ((this: Document, ev: Event) => void) | null = null;\n let flushTimeout: ReturnType<typeof setTimeout> | undefined;\n const globalScope = getGlobalScope();\n const doc = globalScope?.document;\n const location = globalScope?.location;\n let isActive = false;\n const recordedNavigationIds = new Set<number>();\n\n const setup: BrowserEnrichmentPlugin['setup'] = async (config, amplitude) => {\n if (doc === undefined) {\n return;\n }\n isActive = true;\n\n // One payload per navigation, keyed by the navigation its metrics belong to.\n const payloads = new Map<number, WebVitalsEventPayload>();\n let latestNavigationId = -1;\n\n const getPayload = (metric: Metric): WebVitalsEventPayload => {\n const key = metric.navigationId;\n let payload = payloads.get(key);\n if (!payload) {\n payload = getPageProperties(\n /* istanbul ignore next */ metric.navigationURL || location?.href || '',\n /* istanbul ignore next */ doc.title || '',\n config.loggerProvider,\n );\n payloads.set(key, payload);\n }\n return payload;\n };\n\n const flush = (key: number) => {\n recordedNavigationIds.add(key);\n\n const payload = payloads.get(key);\n /* istanbul ignore if */\n if (!payload) {\n return;\n }\n payloads.delete(key);\n\n // The page can be hidden repeatedly without a new navigation reporting anything.\n if (hasMetrics(payload)) {\n amplitude.track(WEB_VITALS_EVENT_NAME, payload);\n }\n };\n\n const flushAll = () => {\n for (const key of Array.from(payloads.keys())) {\n flush(key);\n }\n };\n\n // Once a newer navigation starts reporting metrics, the navigations before it are final. Sending\n // them is deferred briefly so metrics reported late still make it into their event.\n const scheduleFlushOfPreviousNavigations = (currentNavigationId: number) => {\n if (flushTimeout !== undefined) {\n clearTimeout(flushTimeout);\n }\n flushTimeout = setTimeout(() => {\n flushTimeout = undefined;\n for (const key of Array.from(payloads.keys())) {\n if (key < currentNavigationId) {\n flush(key);\n }\n }\n }, SOFT_NAV_FLUSH_DELAY_MS);\n };\n\n const recordMetric = (property: WebVitalsMetricPropertyType) => (metric: Metric) => {\n if (!isActive || recordedNavigationIds.has(metric.navigationId)) {\n return;\n }\n getPayload(metric)[property] = processMetric(metric, true);\n\n if (metric.navigationId > latestNavigationId) {\n if (latestNavigationId !== -1) {\n scheduleFlushOfPreviousNavigations(metric.navigationId);\n }\n latestNavigationId = metric.navigationId;\n }\n };\n\n const reportOpts = { reportSoftNavs: true };\n\n onLCP(recordMetric(WebVitalsMetricProperty.LCP), reportOpts);\n onFCP(recordMetric(WebVitalsMetricProperty.FCP), reportOpts);\n onINP(recordMetric(WebVitalsMetricProperty.INP), reportOpts);\n onCLS(recordMetric(WebVitalsMetricProperty.CLS), reportOpts);\n onTTFB(recordMetric(WebVitalsMetricProperty.TTFB), reportOpts);\n\n visibilityListener = () => {\n if (doc.visibilityState === 'hidden' && visibilityListener) {\n flushAll();\n // Keep listening: the page can become visible again and report metrics for further navigations.\n }\n };\n doc.addEventListener('visibilitychange', visibilityListener);\n };\n\n const execute: BrowserEnrichmentPlugin['execute'] = async (event) => {\n return event;\n };\n\n const teardown = async () => {\n isActive = false;\n if (flushTimeout !== undefined) {\n clearTimeout(flushTimeout);\n flushTimeout = undefined;\n }\n if (visibilityListener) {\n /* istanbul ignore next */\n doc?.removeEventListener('visibilitychange', visibilityListener);\n visibilityListener = null;\n }\n };\n\n return {\n name: PLUGIN_NAME,\n type: 'enrichment',\n setup,\n execute,\n teardown,\n };\n};\n"]}
@@ -1,3 +1,37 @@
1
1
  export declare const PLUGIN_NAME = "web-vitals-browser";
2
2
  export declare const WEB_VITALS_EVENT_NAME = "[Amplitude] Web Vitals";
3
+ import type { Metric } from 'web-vitals';
4
+ /**
5
+ * How long to wait, after a newer navigation starts reporting metrics, before sending the event for
6
+ * a superseded navigation. Metrics for a navigation can be reported slightly after the next soft
7
+ * navigation begins, so the event is deferred to give those late metrics a chance to land.
8
+ */
9
+ export declare const SOFT_NAV_FLUSH_DELAY_MS = 1000;
10
+ export declare const WebVitalsMetricProperty: {
11
+ readonly LCP: "[Amplitude] LCP";
12
+ readonly FCP: "[Amplitude] FCP";
13
+ readonly INP: "[Amplitude] INP";
14
+ readonly CLS: "[Amplitude] CLS";
15
+ readonly TTFB: "[Amplitude] TTFB";
16
+ };
17
+ export type WebVitalsMetricPropertyType = (typeof WebVitalsMetricProperty)[keyof typeof WebVitalsMetricProperty];
18
+ export type WebVitalsMetricPayload = {
19
+ value: number;
20
+ rating: Metric['rating'];
21
+ delta: number;
22
+ navigationType: Metric['navigationType'];
23
+ id: string;
24
+ timestamp: number;
25
+ navigationStart: number;
26
+ navigationId?: number;
27
+ };
28
+ export type WebVitalsEventPayload = {
29
+ [P in WebVitalsMetricPropertyType]?: WebVitalsMetricPayload;
30
+ } & {
31
+ '[Amplitude] Page Domain'?: string;
32
+ '[Amplitude] Page Location'?: string;
33
+ '[Amplitude] Page Path'?: string;
34
+ '[Amplitude] Page Title'?: string;
35
+ '[Amplitude] Page URL'?: string;
36
+ };
3
37
  //# sourceMappingURL=constants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAChD,eAAO,MAAM,qBAAqB,2BAA2B,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAChD,eAAO,MAAM,qBAAqB,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,OAAO,CAAC;AAE5C,eAAO,MAAM,uBAAuB;;;;;;CAM1B,CAAC;AAEX,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC;AAEjH,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;KACjC,CAAC,IAAI,2BAA2B,CAAC,CAAC,EAAE,sBAAsB;CAC5D,GAAG;IACF,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC"}
@@ -1,3 +1,16 @@
1
1
  export var PLUGIN_NAME = 'web-vitals-browser';
2
2
  export var WEB_VITALS_EVENT_NAME = '[Amplitude] Web Vitals';
3
+ /**
4
+ * How long to wait, after a newer navigation starts reporting metrics, before sending the event for
5
+ * a superseded navigation. Metrics for a navigation can be reported slightly after the next soft
6
+ * navigation begins, so the event is deferred to give those late metrics a chance to land.
7
+ */
8
+ export var SOFT_NAV_FLUSH_DELAY_MS = 1000;
9
+ export var WebVitalsMetricProperty = {
10
+ LCP: '[Amplitude] LCP',
11
+ FCP: '[Amplitude] FCP',
12
+ INP: '[Amplitude] INP',
13
+ CLS: '[Amplitude] CLS',
14
+ TTFB: '[Amplitude] TTFB',
15
+ };
3
16
  //# sourceMappingURL=constants.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,WAAW,GAAG,oBAAoB,CAAC;AAChD,MAAM,CAAC,IAAM,qBAAqB,GAAG,wBAAwB,CAAC","sourcesContent":["export const PLUGIN_NAME = 'web-vitals-browser';\nexport const WEB_VITALS_EVENT_NAME = '[Amplitude] Web Vitals';\n"]}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,WAAW,GAAG,oBAAoB,CAAC;AAChD,MAAM,CAAC,IAAM,qBAAqB,GAAG,wBAAwB,CAAC;AAG9D;;;;GAIG;AACH,MAAM,CAAC,IAAM,uBAAuB,GAAG,IAAI,CAAC;AAE5C,MAAM,CAAC,IAAM,uBAAuB,GAAG;IACrC,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,IAAI,EAAE,kBAAkB;CAChB,CAAC","sourcesContent":["export const PLUGIN_NAME = 'web-vitals-browser';\nexport const WEB_VITALS_EVENT_NAME = '[Amplitude] Web Vitals';\nimport type { Metric } from 'web-vitals';\n\n/**\n * How long to wait, after a newer navigation starts reporting metrics, before sending the event for\n * a superseded navigation. Metrics for a navigation can be reported slightly after the next soft\n * navigation begins, so the event is deferred to give those late metrics a chance to land.\n */\nexport const SOFT_NAV_FLUSH_DELAY_MS = 1000;\n\nexport const WebVitalsMetricProperty = {\n LCP: '[Amplitude] LCP',\n FCP: '[Amplitude] FCP',\n INP: '[Amplitude] INP',\n CLS: '[Amplitude] CLS',\n TTFB: '[Amplitude] TTFB',\n} as const;\n\nexport type WebVitalsMetricPropertyType = (typeof WebVitalsMetricProperty)[keyof typeof WebVitalsMetricProperty];\n\nexport type WebVitalsMetricPayload = {\n value: number;\n rating: Metric['rating'];\n delta: number;\n navigationType: Metric['navigationType'];\n id: string;\n timestamp: number;\n navigationStart: number;\n navigationId?: number;\n};\n\nexport type WebVitalsEventPayload = {\n [P in WebVitalsMetricPropertyType]?: WebVitalsMetricPayload;\n} & {\n '[Amplitude] Page Domain'?: string;\n '[Amplitude] Page Location'?: string;\n '[Amplitude] Page Path'?: string;\n '[Amplitude] Page Title'?: string;\n '[Amplitude] Page URL'?: string;\n};\n"]}