@amplitude/plugin-network-capture-browser 1.0.1-usenetworkcaptureinanalyticsbrowser-1.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.
- package/LICENSE +21 -0
- package/README.md +85 -0
- package/lib/cjs/constants.d.ts +3 -0
- package/lib/cjs/constants.d.ts.map +1 -0
- package/lib/cjs/constants.js +6 -0
- package/lib/cjs/constants.js.map +1 -0
- package/lib/cjs/index.d.ts +2 -0
- package/lib/cjs/index.d.ts.map +1 -0
- package/lib/cjs/index.js +7 -0
- package/lib/cjs/index.js.map +1 -0
- package/lib/cjs/network-capture-plugin.d.ts +32 -0
- package/lib/cjs/network-capture-plugin.d.ts.map +1 -0
- package/lib/cjs/network-capture-plugin.js +99 -0
- package/lib/cjs/network-capture-plugin.js.map +1 -0
- package/lib/cjs/track-network-event.d.ts +21 -0
- package/lib/cjs/track-network-event.d.ts.map +1 -0
- package/lib/cjs/track-network-event.js +131 -0
- package/lib/cjs/track-network-event.js.map +1 -0
- package/lib/cjs/version.d.ts +2 -0
- package/lib/cjs/version.d.ts.map +1 -0
- package/lib/cjs/version.js +5 -0
- package/lib/cjs/version.js.map +1 -0
- package/lib/esm/constants.d.ts +3 -0
- package/lib/esm/constants.d.ts.map +1 -0
- package/lib/esm/constants.js +3 -0
- package/lib/esm/constants.js.map +1 -0
- package/lib/esm/index.d.ts +2 -0
- package/lib/esm/index.d.ts.map +1 -0
- package/lib/esm/index.js +2 -0
- package/lib/esm/index.js.map +1 -0
- package/lib/esm/network-capture-plugin.d.ts +32 -0
- package/lib/esm/network-capture-plugin.d.ts.map +1 -0
- package/lib/esm/network-capture-plugin.js +95 -0
- package/lib/esm/network-capture-plugin.js.map +1 -0
- package/lib/esm/track-network-event.d.ts +21 -0
- package/lib/esm/track-network-event.d.ts.map +1 -0
- package/lib/esm/track-network-event.js +126 -0
- package/lib/esm/track-network-event.js.map +1 -0
- package/lib/esm/version.d.ts +2 -0
- package/lib/esm/version.d.ts.map +1 -0
- package/lib/esm/version.js +2 -0
- package/lib/esm/version.js.map +1 -0
- package/lib/scripts/amplitude-min.js +2 -0
- package/lib/scripts/amplitude-min.js.gz +0 -0
- package/lib/scripts/amplitude-min.js.map +1 -0
- package/lib/scripts/amplitude-min.umd.js +1 -0
- package/lib/scripts/amplitude-min.umd.js.gz +0 -0
- package/lib/scripts/constants.d.ts +3 -0
- package/lib/scripts/constants.d.ts.map +1 -0
- package/lib/scripts/index.d.ts +2 -0
- package/lib/scripts/index.d.ts.map +1 -0
- package/lib/scripts/network-capture-plugin.d.ts +32 -0
- package/lib/scripts/network-capture-plugin.d.ts.map +1 -0
- package/lib/scripts/track-network-event.d.ts +21 -0
- package/lib/scripts/track-network-event.d.ts.map +1 -0
- package/lib/scripts/version.d.ts +2 -0
- package/lib/scripts/version.d.ts.map +1 -0
- package/package.json +61 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Amplitude Analytics
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://amplitude.com" target="_blank" align="center">
|
|
3
|
+
<img src="https://static.amplitude.com/lightning/46c85bfd91905de8047f1ee65c7c93d6fa9ee6ea/static/media/amplitude-logo-with-text.4fb9e463.svg" width="280">
|
|
4
|
+
</a>
|
|
5
|
+
<br />
|
|
6
|
+
</p>
|
|
7
|
+
|
|
8
|
+
# @amplitude/plugin-network-capture-browser (beta)
|
|
9
|
+
**This plugin is in beta at the moment, naming and interface might change in the future.**
|
|
10
|
+
|
|
11
|
+
## TODO: Re-write this README.md to match plugin-network-capture
|
|
12
|
+
|
|
13
|
+
Browser SDK plugin for autocapture.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
This package is published on NPM registry and is available to be installed using npm and yarn.
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
# npm
|
|
21
|
+
npm install @amplitude/plugin-network-capture-browser@beta
|
|
22
|
+
|
|
23
|
+
# yarn
|
|
24
|
+
yarn add @amplitude/plugin-network-capture-browser@beta
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Usage
|
|
28
|
+
|
|
29
|
+
This plugin works on top of the Amplitude Browser SDK, generating auto-tracked events and sending to Amplitude.
|
|
30
|
+
|
|
31
|
+
To use this plugin, you need to install `@amplitude/analytics-browser` version `v1.9.1` or later.
|
|
32
|
+
|
|
33
|
+
### 1. Import Amplitude packages
|
|
34
|
+
|
|
35
|
+
* `@amplitude/analytics-browser`
|
|
36
|
+
* `@amplitude/plugin-network-capture-browser`
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
import * as amplitude from '@amplitude/analytics-browser';
|
|
40
|
+
import { autocapturePlugin } from '@amplitude/plugin-network-capture-browser';
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 2. Instantiate the plugin
|
|
44
|
+
|
|
45
|
+
The plugin accepts 1 optional parameter, which is an `Object` to configure the allowed tracking options.
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
const plugin = autocapturePlugin({
|
|
49
|
+
cssSelectorAllowlist: [
|
|
50
|
+
'.amp-tracking',
|
|
51
|
+
'[amp-tracking]'
|
|
52
|
+
],
|
|
53
|
+
pageUrlAllowlist: [
|
|
54
|
+
'https://amplitude.com',
|
|
55
|
+
new RegExp('https://amplitude.com/blog/*')
|
|
56
|
+
],
|
|
57
|
+
});
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Examples:
|
|
61
|
+
- The above `cssSelectorAllowlist` will only allow tracking elements like:
|
|
62
|
+
- `<button amp-tracking>Click</button>`
|
|
63
|
+
- `<a class="amp-tracking">Link</a>`
|
|
64
|
+
- The above `pageUrlAllowlist` will only allow the elements on URL "https://amplitude.com" or any URL matching the "https://amplitude.com/blog/*" to be tracked
|
|
65
|
+
|
|
66
|
+
#### Options
|
|
67
|
+
|
|
68
|
+
|Name|Type|Default|Description|
|
|
69
|
+
|-|-|-|-|
|
|
70
|
+
|`cssSelectorAllowlist`|`string[]`|`['a', 'button', 'input', 'select', 'textarea', 'label', '[data-amp-default-track]', '.amp-default-track']`| When provided, only allow elements matching any selector to be tracked. |
|
|
71
|
+
|`pageUrlAllowlist`|`(string\|RegExp)[]`|`undefined`| When provided, only allow elements matching URLs to be tracked. |
|
|
72
|
+
|`shouldTrackEventResolver`|`(actionType: ActionType, element: Element) => boolean`|`undefined`| When provided, overwrite all other allowlists and configurations. |
|
|
73
|
+
|`dataAttributePrefix`|`string`|`'data-amp-track-'`| Allow data attributes to be collected in event property. |
|
|
74
|
+
|
|
75
|
+
### 3. Install plugin to Amplitude SDK
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
amplitude.add(plugin);
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 4. Initialize Amplitude SDK
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
amplitude.init('API_KEY');
|
|
85
|
+
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,8CAA8C,CAAC;AAEvE,eAAO,MAAM,+BAA+B,gCAAgC,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AMPLITUDE_NETWORK_REQUEST_EVENT = exports.PLUGIN_NAME = void 0;
|
|
4
|
+
exports.PLUGIN_NAME = '@amplitude/plugin-network-capture-browser';
|
|
5
|
+
exports.AMPLITUDE_NETWORK_REQUEST_EVENT = '[Amplitude] Network Request';
|
|
6
|
+
//# sourceMappingURL=constants.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,2CAA2C,CAAC;AAE1D,QAAA,+BAA+B,GAAG,6BAA6B,CAAC","sourcesContent":["export const PLUGIN_NAME = '@amplitude/plugin-network-capture-browser';\n\nexport const AMPLITUDE_NETWORK_REQUEST_EVENT = '[Amplitude] Network Request';\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,IAAI,MAAM,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC"}
|
package/lib/cjs/index.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.networkCapturePlugin = exports.plugin = void 0;
|
|
4
|
+
var network_capture_plugin_1 = require("./network-capture-plugin");
|
|
5
|
+
Object.defineProperty(exports, "plugin", { enumerable: true, get: function () { return network_capture_plugin_1.networkCapturePlugin; } });
|
|
6
|
+
Object.defineProperty(exports, "networkCapturePlugin", { enumerable: true, get: function () { return network_capture_plugin_1.networkCapturePlugin; } });
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,mEAAgG;AAAvF,gHAAA,oBAAoB,OAAU;AAAE,8HAAA,oBAAoB,OAAA","sourcesContent":["export { networkCapturePlugin as plugin, networkCapturePlugin } from './network-capture-plugin';\n"]}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { BrowserClient, BrowserConfig, EnrichmentPlugin, ElementInteractionsOptions, NetworkRequestEvent, NetworkTrackingOptions } from '@amplitude/analytics-core';
|
|
2
|
+
import { Observable } from 'rxjs';
|
|
3
|
+
import { HasEventTargetAddRemove } from 'rxjs/internal/observable/fromEvent';
|
|
4
|
+
declare global {
|
|
5
|
+
interface Window {
|
|
6
|
+
navigation: HasEventTargetAddRemove<Event>;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
export type BrowserEnrichmentPlugin = EnrichmentPlugin<BrowserClient, BrowserConfig>;
|
|
10
|
+
export type AutoCaptureOptionsWithDefaults = Required<Pick<ElementInteractionsOptions, 'debounceTime' | 'cssSelectorAllowlist' | 'actionClickAllowlist'>> & ElementInteractionsOptions;
|
|
11
|
+
export declare enum ObservablesEnum {
|
|
12
|
+
NetworkObservable = "networkObservable"
|
|
13
|
+
}
|
|
14
|
+
type BaseTimestampedEvent<T> = {
|
|
15
|
+
event: T;
|
|
16
|
+
timestamp: number;
|
|
17
|
+
type: 'rage' | 'click' | 'change' | 'error' | 'navigate' | 'mutation' | 'network';
|
|
18
|
+
};
|
|
19
|
+
export type ElementBasedEvent = MouseEvent | Event;
|
|
20
|
+
export type ElementBasedTimestampedEvent<T> = BaseTimestampedEvent<T> & {
|
|
21
|
+
event: MouseEvent | Event;
|
|
22
|
+
type: 'click' | 'change';
|
|
23
|
+
closestTrackedAncestor: Element;
|
|
24
|
+
targetElementProperties: Record<string, any>;
|
|
25
|
+
};
|
|
26
|
+
export type TimestampedEvent<T> = BaseTimestampedEvent<T> | ElementBasedTimestampedEvent<T>;
|
|
27
|
+
export interface AllWindowObservables {
|
|
28
|
+
[ObservablesEnum.NetworkObservable]: Observable<TimestampedEvent<NetworkRequestEvent>>;
|
|
29
|
+
}
|
|
30
|
+
export declare const networkCapturePlugin: (options?: NetworkTrackingOptions) => BrowserEnrichmentPlugin;
|
|
31
|
+
export {};
|
|
32
|
+
//# sourceMappingURL=network-capture-plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"network-capture-plugin.d.ts","sourceRoot":"","sources":["../../src/network-capture-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,0BAA0B,EAC1B,mBAAmB,EAGnB,sBAAsB,EACvB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAgB,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAG7E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,EAAE,uBAAuB,CAAC,KAAK,CAAC,CAAC;KAC5C;CACF;AAED,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAErF,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CACnD,IAAI,CAAC,0BAA0B,EAAE,cAAc,GAAG,sBAAsB,GAAG,sBAAsB,CAAC,CACnG,GACC,0BAA0B,CAAC;AAE7B,oBAAY,eAAe;IACzB,iBAAiB,sBAAsB;CACxC;AAGD,KAAK,oBAAoB,CAAC,CAAC,IAAI;IAC7B,KAAK,EAAE,CAAC,CAAC;IACT,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;CACnF,CAAC;AAGF,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,KAAK,CAAC;AACnD,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,GAAG;IACtE,KAAK,EAAE,UAAU,GAAG,KAAK,CAAC;IAC1B,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9C,CAAC;AAGF,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,GAAG,4BAA4B,CAAC,CAAC,CAAC,CAAC;AAE5F,MAAM,WAAW,oBAAoB;IACnC,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC;CACxF;AAED,eAAO,MAAM,oBAAoB,aAAa,sBAAsB,KAAQ,uBA2E3E,CAAC"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.networkCapturePlugin = exports.ObservablesEnum = void 0;
|
|
4
|
+
var tslib_1 = require("tslib");
|
|
5
|
+
/* eslint-disable no-restricted-globals */
|
|
6
|
+
var analytics_core_1 = require("@amplitude/analytics-core");
|
|
7
|
+
var constants = tslib_1.__importStar(require("./constants"));
|
|
8
|
+
var rxjs_1 = require("rxjs");
|
|
9
|
+
var track_network_event_1 = require("./track-network-event");
|
|
10
|
+
var ObservablesEnum;
|
|
11
|
+
(function (ObservablesEnum) {
|
|
12
|
+
ObservablesEnum["NetworkObservable"] = "networkObservable";
|
|
13
|
+
})(ObservablesEnum = exports.ObservablesEnum || (exports.ObservablesEnum = {}));
|
|
14
|
+
var networkCapturePlugin = function (options) {
|
|
15
|
+
if (options === void 0) { options = {}; }
|
|
16
|
+
var name = constants.PLUGIN_NAME;
|
|
17
|
+
var type = 'enrichment';
|
|
18
|
+
var subscriptions = [];
|
|
19
|
+
var addAdditionalEventProperties = function (event, type) {
|
|
20
|
+
var baseEvent = {
|
|
21
|
+
event: event,
|
|
22
|
+
timestamp: Date.now(),
|
|
23
|
+
type: type,
|
|
24
|
+
};
|
|
25
|
+
return baseEvent;
|
|
26
|
+
};
|
|
27
|
+
// Create observables on events on the window
|
|
28
|
+
var createObservables = function () {
|
|
29
|
+
var _a;
|
|
30
|
+
var networkObservable = new rxjs_1.Observable(function (observer) {
|
|
31
|
+
var callback = new analytics_core_1.NetworkEventCallback(function (event) {
|
|
32
|
+
var eventWithProperties = addAdditionalEventProperties(event, 'network');
|
|
33
|
+
observer.next(eventWithProperties);
|
|
34
|
+
});
|
|
35
|
+
analytics_core_1.networkObserver.subscribe(callback);
|
|
36
|
+
return function () {
|
|
37
|
+
analytics_core_1.networkObserver.unsubscribe(callback);
|
|
38
|
+
};
|
|
39
|
+
});
|
|
40
|
+
return _a = {},
|
|
41
|
+
_a[ObservablesEnum.NetworkObservable] = networkObservable,
|
|
42
|
+
_a;
|
|
43
|
+
};
|
|
44
|
+
var setup = function (config, amplitude) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
45
|
+
var allObservables, networkRequestSubscription;
|
|
46
|
+
var _a;
|
|
47
|
+
return tslib_1.__generator(this, function (_b) {
|
|
48
|
+
/* istanbul ignore if */
|
|
49
|
+
if (typeof document === 'undefined') {
|
|
50
|
+
return [2 /*return*/];
|
|
51
|
+
}
|
|
52
|
+
allObservables = createObservables();
|
|
53
|
+
networkRequestSubscription = (0, track_network_event_1.trackNetworkEvents)({
|
|
54
|
+
allObservables: allObservables,
|
|
55
|
+
networkTrackingOptions: options,
|
|
56
|
+
amplitude: amplitude,
|
|
57
|
+
});
|
|
58
|
+
subscriptions.push(networkRequestSubscription);
|
|
59
|
+
/* istanbul ignore next */
|
|
60
|
+
(_a = config === null || config === void 0 ? void 0 : config.loggerProvider) === null || _a === void 0 ? void 0 : _a.log("".concat(name, " has been successfully added."));
|
|
61
|
+
return [2 /*return*/];
|
|
62
|
+
});
|
|
63
|
+
}); };
|
|
64
|
+
/* istanbul ignore next */
|
|
65
|
+
var execute = function (event) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
66
|
+
return tslib_1.__generator(this, function (_a) {
|
|
67
|
+
return [2 /*return*/, event];
|
|
68
|
+
});
|
|
69
|
+
}); };
|
|
70
|
+
var teardown = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
71
|
+
var subscriptions_1, subscriptions_1_1, subscription;
|
|
72
|
+
var e_1, _a;
|
|
73
|
+
return tslib_1.__generator(this, function (_b) {
|
|
74
|
+
try {
|
|
75
|
+
for (subscriptions_1 = tslib_1.__values(subscriptions), subscriptions_1_1 = subscriptions_1.next(); !subscriptions_1_1.done; subscriptions_1_1 = subscriptions_1.next()) {
|
|
76
|
+
subscription = subscriptions_1_1.value;
|
|
77
|
+
subscription.unsubscribe();
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
81
|
+
finally {
|
|
82
|
+
try {
|
|
83
|
+
if (subscriptions_1_1 && !subscriptions_1_1.done && (_a = subscriptions_1.return)) _a.call(subscriptions_1);
|
|
84
|
+
}
|
|
85
|
+
finally { if (e_1) throw e_1.error; }
|
|
86
|
+
}
|
|
87
|
+
return [2 /*return*/];
|
|
88
|
+
});
|
|
89
|
+
}); };
|
|
90
|
+
return {
|
|
91
|
+
name: name,
|
|
92
|
+
type: type,
|
|
93
|
+
setup: setup,
|
|
94
|
+
execute: execute,
|
|
95
|
+
teardown: teardown,
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
exports.networkCapturePlugin = networkCapturePlugin;
|
|
99
|
+
//# sourceMappingURL=network-capture-plugin.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"network-capture-plugin.js","sourceRoot":"","sources":["../../src/network-capture-plugin.ts"],"names":[],"mappings":";;;;AAAA,0CAA0C;AAC1C,4DASmC;AACnC,6DAAyC;AACzC,6BAAgD;AAEhD,6DAA2D;AAe3D,IAAY,eAEX;AAFD,WAAY,eAAe;IACzB,0DAAuC,CAAA;AACzC,CAAC,EAFW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAE1B;AAyBM,IAAM,oBAAoB,GAAG,UAAC,OAAoC;IAApC,wBAAA,EAAA,YAAoC;IACvE,IAAM,IAAI,GAAG,SAAS,CAAC,WAAW,CAAC;IACnC,IAAM,IAAI,GAAG,YAAY,CAAC;IAE1B,IAAM,aAAa,GAAmB,EAAE,CAAC;IAEzC,IAAM,4BAA4B,GAAG,UACnC,KAAQ,EACR,IAAiC;QAEjC,IAAM,SAAS,GAA8D;YAC3E,KAAK,OAAA;YACL,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;YACrB,IAAI,MAAA;SACL,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,6CAA6C;IAC7C,IAAM,iBAAiB,GAAG;;QACxB,IAAM,iBAAiB,GAAG,IAAI,iBAAU,CAAwC,UAAC,QAAQ;YACvF,IAAM,QAAQ,GAAG,IAAI,qCAAoB,CAAC,UAAC,KAAK;gBAC9C,IAAM,mBAAmB,GAAG,4BAA4B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBAC3E,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,gCAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YACpC,OAAO;gBACL,gCAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH;YACE,GAAC,eAAe,CAAC,iBAAiB,IAAG,iBAAiB;eACtD;IACJ,CAAC,CAAC;IAEF,IAAM,KAAK,GAAqC,UAAO,MAAM,EAAE,SAAS;;;;YACtE,wBAAwB;YACxB,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;gBACnC,sBAAO;aACR;YAGK,cAAc,GAAG,iBAAiB,EAAE,CAAC;YAErC,0BAA0B,GAAG,IAAA,wCAAkB,EAAC;gBACpD,cAAc,gBAAA;gBACd,sBAAsB,EAAE,OAAO;gBAC/B,SAAS,WAAA;aACV,CAAC,CAAC;YACH,aAAa,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAE/C,0BAA0B;YAC1B,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,0CAAE,GAAG,CAAC,UAAG,IAAI,kCAA+B,CAAC,CAAC;;;SACrE,CAAC;IAEF,0BAA0B;IAC1B,IAAM,OAAO,GAAuC,UAAO,KAAK;;YAC9D,sBAAO,KAAK,EAAC;;SACd,CAAC;IAEF,IAAM,QAAQ,GAAG;;;;;gBACf,KAA2B,kBAAA,iBAAA,aAAa,CAAA,mHAAE;oBAA/B,YAAY;oBACrB,YAAY,CAAC,WAAW,EAAE,CAAC;iBAC5B;;;;;;;;;;;SACF,CAAC;IAEF,OAAO;QACL,IAAI,MAAA;QACJ,IAAI,MAAA;QACJ,KAAK,OAAA;QACL,OAAO,SAAA;QACP,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC,CAAC;AA3EW,QAAA,oBAAoB,wBA2E/B","sourcesContent":["/* eslint-disable no-restricted-globals */\nimport {\n BrowserClient,\n BrowserConfig,\n EnrichmentPlugin,\n ElementInteractionsOptions,\n NetworkRequestEvent,\n networkObserver,\n NetworkEventCallback,\n NetworkTrackingOptions,\n} from '@amplitude/analytics-core';\nimport * as constants from './constants';\nimport { Observable, Subscription } from 'rxjs';\nimport { HasEventTargetAddRemove } from 'rxjs/internal/observable/fromEvent';\nimport { trackNetworkEvents } from './track-network-event';\n\ndeclare global {\n interface Window {\n navigation: HasEventTargetAddRemove<Event>;\n }\n}\n\nexport type BrowserEnrichmentPlugin = EnrichmentPlugin<BrowserClient, BrowserConfig>;\n\nexport type AutoCaptureOptionsWithDefaults = Required<\n Pick<ElementInteractionsOptions, 'debounceTime' | 'cssSelectorAllowlist' | 'actionClickAllowlist'>\n> &\n ElementInteractionsOptions;\n\nexport enum ObservablesEnum {\n NetworkObservable = 'networkObservable',\n}\n\n// Base TimestampedEvent type\ntype BaseTimestampedEvent<T> = {\n event: T;\n timestamp: number;\n type: 'rage' | 'click' | 'change' | 'error' | 'navigate' | 'mutation' | 'network';\n};\n\n// Specific types for events with targetElementProperties\nexport type ElementBasedEvent = MouseEvent | Event;\nexport type ElementBasedTimestampedEvent<T> = BaseTimestampedEvent<T> & {\n event: MouseEvent | Event;\n type: 'click' | 'change';\n closestTrackedAncestor: Element;\n targetElementProperties: Record<string, any>;\n};\n\n// Union type for all possible TimestampedEvents\nexport type TimestampedEvent<T> = BaseTimestampedEvent<T> | ElementBasedTimestampedEvent<T>;\n\nexport interface AllWindowObservables {\n [ObservablesEnum.NetworkObservable]: Observable<TimestampedEvent<NetworkRequestEvent>>;\n}\n\nexport const networkCapturePlugin = (options: NetworkTrackingOptions = {}): BrowserEnrichmentPlugin => {\n const name = constants.PLUGIN_NAME;\n const type = 'enrichment';\n\n const subscriptions: Subscription[] = [];\n\n const addAdditionalEventProperties = <T>(\n event: T,\n type: TimestampedEvent<T>['type'],\n ): TimestampedEvent<T> | ElementBasedTimestampedEvent<T> => {\n const baseEvent: BaseTimestampedEvent<T> | ElementBasedTimestampedEvent<T> = {\n event,\n timestamp: Date.now(),\n type,\n };\n\n return baseEvent;\n };\n\n // Create observables on events on the window\n const createObservables = (): AllWindowObservables => {\n const networkObservable = new Observable<TimestampedEvent<NetworkRequestEvent>>((observer) => {\n const callback = new NetworkEventCallback((event) => {\n const eventWithProperties = addAdditionalEventProperties(event, 'network');\n observer.next(eventWithProperties);\n });\n networkObserver.subscribe(callback);\n return () => {\n networkObserver.unsubscribe(callback);\n };\n });\n\n return {\n [ObservablesEnum.NetworkObservable]: networkObservable,\n };\n };\n\n const setup: BrowserEnrichmentPlugin['setup'] = async (config, amplitude) => {\n /* istanbul ignore if */\n if (typeof document === 'undefined') {\n return;\n }\n\n // Create observables for events on the window\n const allObservables = createObservables();\n\n const networkRequestSubscription = trackNetworkEvents({\n allObservables,\n networkTrackingOptions: options,\n amplitude,\n });\n subscriptions.push(networkRequestSubscription);\n\n /* istanbul ignore next */\n config?.loggerProvider?.log(`${name} has been successfully added.`);\n };\n\n /* istanbul ignore next */\n const execute: BrowserEnrichmentPlugin['execute'] = async (event) => {\n return event;\n };\n\n const teardown = async () => {\n for (const subscription of subscriptions) {\n subscription.unsubscribe();\n }\n };\n\n return {\n name,\n type,\n setup,\n execute,\n teardown,\n };\n};\n"]}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { BrowserClient, NetworkRequestEvent, NetworkTrackingOptions } from '@amplitude/analytics-core';
|
|
2
|
+
import { AllWindowObservables } from './network-capture-plugin';
|
|
3
|
+
export declare function shouldTrackNetworkEvent(networkEvent: NetworkRequestEvent, options?: NetworkTrackingOptions): boolean;
|
|
4
|
+
export type NetworkAnalyticsEvent = {
|
|
5
|
+
['[Amplitude] URL']: string;
|
|
6
|
+
['[Amplitude] URL Query']?: string;
|
|
7
|
+
['[Amplitude] URL Fragment']?: string;
|
|
8
|
+
['[Amplitude] Request Method']: string;
|
|
9
|
+
['[Amplitude] Status Code']?: number;
|
|
10
|
+
['[Amplitude] Start Time']?: string;
|
|
11
|
+
['[Amplitude] Completion Time']?: string;
|
|
12
|
+
['[Amplitude] Duration']?: number;
|
|
13
|
+
['[Amplitude] Request Body Size']?: number;
|
|
14
|
+
['[Amplitude] Response Body Size']?: number;
|
|
15
|
+
};
|
|
16
|
+
export declare function trackNetworkEvents({ allObservables, networkTrackingOptions, amplitude, }: {
|
|
17
|
+
allObservables: AllWindowObservables;
|
|
18
|
+
networkTrackingOptions: NetworkTrackingOptions;
|
|
19
|
+
amplitude: BrowserClient;
|
|
20
|
+
}): import("rxjs").Subscription;
|
|
21
|
+
//# sourceMappingURL=track-network-event.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"track-network-event.d.ts","sourceRoot":"","sources":["../../src/track-network-event.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EAEnB,sBAAsB,EACvB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,oBAAoB,EAAoB,MAAM,0BAA0B,CAAC;AA6ClF,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,mBAAmB,EAAE,OAAO,GAAE,sBAA2B,WA2C9G;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC5B,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,CAAC;IACnC,CAAC,0BAA0B,CAAC,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACvC,CAAC,yBAAyB,CAAC,CAAC,EAAE,MAAM,CAAC;IACrC,CAAC,wBAAwB,CAAC,CAAC,EAAE,MAAM,CAAC;IACpC,CAAC,6BAA6B,CAAC,CAAC,EAAE,MAAM,CAAC;IACzC,CAAC,sBAAsB,CAAC,CAAC,EAAE,MAAM,CAAC;IAClC,CAAC,+BAA+B,CAAC,CAAC,EAAE,MAAM,CAAC;IAC3C,CAAC,gCAAgC,CAAC,CAAC,EAAE,MAAM,CAAC;CAC7C,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,EACjC,cAAc,EACd,sBAAsB,EACtB,SAAS,GACV,EAAE;IACD,cAAc,EAAE,oBAAoB,CAAC;IACrC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,SAAS,EAAE,aAAa,CAAC;CAC1B,+BA0CA"}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.trackNetworkEvents = exports.shouldTrackNetworkEvent = void 0;
|
|
4
|
+
var tslib_1 = require("tslib");
|
|
5
|
+
var rxjs_1 = require("rxjs");
|
|
6
|
+
var constants_1 = require("./constants");
|
|
7
|
+
var DEFAULT_STATUS_CODE_RANGE = '500-599';
|
|
8
|
+
function wildcardMatch(str, pattern) {
|
|
9
|
+
// Escape all regex special characters except for *
|
|
10
|
+
var escapedPattern = pattern.replace(/[-[\]{}()+?.,\\^$|#\s]/g, '\\$&');
|
|
11
|
+
// Replace * with .*
|
|
12
|
+
var regexPattern = '^' + escapedPattern.replace(/\*/g, '.*') + '$';
|
|
13
|
+
var regex = new RegExp(regexPattern);
|
|
14
|
+
return regex.test(str);
|
|
15
|
+
}
|
|
16
|
+
function isStatusCodeInRange(statusCode, range) {
|
|
17
|
+
var e_1, _a;
|
|
18
|
+
var ranges = range.split(',');
|
|
19
|
+
try {
|
|
20
|
+
for (var ranges_1 = tslib_1.__values(ranges), ranges_1_1 = ranges_1.next(); !ranges_1_1.done; ranges_1_1 = ranges_1.next()) {
|
|
21
|
+
var r = ranges_1_1.value;
|
|
22
|
+
var _b = tslib_1.__read(r.split('-').map(Number), 2), start = _b[0], end = _b[1];
|
|
23
|
+
if (statusCode === start && end === undefined) {
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
if (statusCode >= start && statusCode <= end) {
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
32
|
+
finally {
|
|
33
|
+
try {
|
|
34
|
+
if (ranges_1_1 && !ranges_1_1.done && (_a = ranges_1.return)) _a.call(ranges_1);
|
|
35
|
+
}
|
|
36
|
+
finally { if (e_1) throw e_1.error; }
|
|
37
|
+
}
|
|
38
|
+
return false;
|
|
39
|
+
}
|
|
40
|
+
function isCaptureRuleMatch(rule, hostname, status) {
|
|
41
|
+
// check if the host is in the allowed hosts
|
|
42
|
+
if (rule.hosts && !rule.hosts.find(function (host) { return wildcardMatch(hostname, host); })) {
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
// check if the status code is in the allowed range
|
|
46
|
+
if (status || status === 0) {
|
|
47
|
+
var statusCodeRange = rule.statusCodeRange || DEFAULT_STATUS_CODE_RANGE;
|
|
48
|
+
if (!isStatusCodeInRange(status, statusCodeRange)) {
|
|
49
|
+
return false;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
return true;
|
|
53
|
+
}
|
|
54
|
+
function shouldTrackNetworkEvent(networkEvent, options) {
|
|
55
|
+
var _a;
|
|
56
|
+
if (options === void 0) { options = {}; }
|
|
57
|
+
var url = new URL(networkEvent.url);
|
|
58
|
+
var host = url.hostname;
|
|
59
|
+
// false if is amplitude request and not configured to track amplitude requests
|
|
60
|
+
if (options.ignoreAmplitudeRequests !== false &&
|
|
61
|
+
(wildcardMatch(host, '*.amplitude.com') || wildcardMatch(host, 'amplitude.com'))) {
|
|
62
|
+
return false;
|
|
63
|
+
}
|
|
64
|
+
// false if the host is in the ignore list
|
|
65
|
+
if ((_a = options.ignoreHosts) === null || _a === void 0 ? void 0 : _a.find(function (ignoreHost) { return wildcardMatch(host, ignoreHost); })) {
|
|
66
|
+
return false;
|
|
67
|
+
}
|
|
68
|
+
// false if the status code is not 500-599 and there are no captureRules
|
|
69
|
+
if (!options.captureRules &&
|
|
70
|
+
networkEvent.status !== undefined &&
|
|
71
|
+
!isStatusCodeInRange(networkEvent.status, DEFAULT_STATUS_CODE_RANGE)) {
|
|
72
|
+
return false;
|
|
73
|
+
}
|
|
74
|
+
if (options.captureRules) {
|
|
75
|
+
// find the first capture rule, in reverse-order,
|
|
76
|
+
// that is a match (true) or a miss (false)
|
|
77
|
+
var isMatch_1;
|
|
78
|
+
tslib_1.__spreadArray([], tslib_1.__read(options.captureRules), false).reverse().find(function (rule) {
|
|
79
|
+
isMatch_1 = isCaptureRuleMatch(rule, host, networkEvent.status);
|
|
80
|
+
return isMatch_1 !== undefined;
|
|
81
|
+
});
|
|
82
|
+
// if we found a miss (false) or no match (undefined),
|
|
83
|
+
// then do not track the event
|
|
84
|
+
if (!isMatch_1) {
|
|
85
|
+
return false;
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
return true;
|
|
89
|
+
}
|
|
90
|
+
exports.shouldTrackNetworkEvent = shouldTrackNetworkEvent;
|
|
91
|
+
function trackNetworkEvents(_a) {
|
|
92
|
+
var allObservables = _a.allObservables, networkTrackingOptions = _a.networkTrackingOptions, amplitude = _a.amplitude;
|
|
93
|
+
var networkObservable = allObservables.networkObservable;
|
|
94
|
+
var filteredNetworkObservable = networkObservable.pipe((0, rxjs_1.filter)(function (event) {
|
|
95
|
+
// Only track network events that should be tracked,
|
|
96
|
+
return shouldTrackNetworkEvent(event.event, networkTrackingOptions);
|
|
97
|
+
}));
|
|
98
|
+
return filteredNetworkObservable.subscribe(function (networkEvent) {
|
|
99
|
+
var _a;
|
|
100
|
+
var request = networkEvent.event;
|
|
101
|
+
// convert to NetworkAnalyticsEvent
|
|
102
|
+
var url, urlQuery, urlFragment;
|
|
103
|
+
try {
|
|
104
|
+
url = new URL(request.url);
|
|
105
|
+
urlQuery = url.searchParams.toString();
|
|
106
|
+
urlFragment = url.hash.replace('#', '');
|
|
107
|
+
}
|
|
108
|
+
catch (e) {
|
|
109
|
+
// if the URL failed to parse, just use the original URL
|
|
110
|
+
// and do not include the query or fragment
|
|
111
|
+
}
|
|
112
|
+
var startTimeAsDate = request.startTime ? new Date(request.startTime).toISOString() : undefined;
|
|
113
|
+
var endTimeAsDate = request.endTime ? new Date(request.endTime).toISOString() : undefined;
|
|
114
|
+
var networkAnalyticsEvent = (_a = {},
|
|
115
|
+
_a['[Amplitude] URL'] = request.url,
|
|
116
|
+
_a['[Amplitude] URL Query'] = urlQuery,
|
|
117
|
+
_a['[Amplitude] URL Fragment'] = urlFragment,
|
|
118
|
+
_a['[Amplitude] Request Method'] = request.method,
|
|
119
|
+
_a['[Amplitude] Status Code'] = request.status,
|
|
120
|
+
_a['[Amplitude] Start Time'] = startTimeAsDate,
|
|
121
|
+
_a['[Amplitude] Completion Time'] = endTimeAsDate,
|
|
122
|
+
_a['[Amplitude] Duration'] = request.duration,
|
|
123
|
+
_a['[Amplitude] Request Body Size'] = request.requestBodySize,
|
|
124
|
+
_a['[Amplitude] Response Body Size'] = request.responseBodySize,
|
|
125
|
+
_a);
|
|
126
|
+
/* istanbul ignore next */
|
|
127
|
+
amplitude === null || amplitude === void 0 ? void 0 : amplitude.track(constants_1.AMPLITUDE_NETWORK_REQUEST_EVENT, networkAnalyticsEvent);
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
exports.trackNetworkEvents = trackNetworkEvents;
|
|
131
|
+
//# sourceMappingURL=track-network-event.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"track-network-event.js","sourceRoot":"","sources":["../../src/track-network-event.ts"],"names":[],"mappings":";;;;AAMA,6BAA8B;AAE9B,yCAA8D;AAE9D,IAAM,yBAAyB,GAAG,SAAS,CAAC;AAE5C,SAAS,aAAa,CAAC,GAAW,EAAE,OAAe;IACjD,mDAAmD;IACnD,IAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC1E,oBAAoB;IACpB,IAAM,YAAY,GAAG,GAAG,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC;IACrE,IAAM,KAAK,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;IACvC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,mBAAmB,CAAC,UAAkB,EAAE,KAAa;;IAC5D,IAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;;QAChC,KAAgB,IAAA,WAAA,iBAAA,MAAM,CAAA,8BAAA,kDAAE;YAAnB,IAAM,CAAC,mBAAA;YACJ,IAAA,KAAA,eAAe,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAA,EAAtC,KAAK,QAAA,EAAE,GAAG,QAA4B,CAAC;YAC9C,IAAI,UAAU,KAAK,KAAK,IAAI,GAAG,KAAK,SAAS,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YACD,IAAI,UAAU,IAAI,KAAK,IAAI,UAAU,IAAI,GAAG,EAAE;gBAC5C,OAAO,IAAI,CAAC;aACb;SACF;;;;;;;;;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAwB,EAAE,QAAgB,EAAE,MAAe;IACrF,4CAA4C;IAC5C,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAC,IAAY,IAAK,OAAA,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,EAA7B,CAA6B,CAAC,EAAE;QACnF,OAAO;KACR;IAED,mDAAmD;IACnD,IAAI,MAAM,IAAI,MAAM,KAAK,CAAC,EAAE;QAC1B,IAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,yBAAyB,CAAC;QAC1E,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;YACjD,OAAO,KAAK,CAAC;SACd;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,uBAAuB,CAAC,YAAiC,EAAE,OAAoC;;IAApC,wBAAA,EAAA,YAAoC;IAC7G,IAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACtC,IAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC;IAE1B,+EAA+E;IAC/E,IACE,OAAO,CAAC,uBAAuB,KAAK,KAAK;QACzC,CAAC,aAAa,CAAC,IAAI,EAAE,iBAAiB,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,EAChF;QACA,OAAO,KAAK,CAAC;KACd;IAED,0CAA0C;IAC1C,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,IAAI,CAAC,UAAC,UAAkB,IAAK,OAAA,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,EAA/B,CAA+B,CAAC,EAAE;QACtF,OAAO,KAAK,CAAC;KACd;IAED,wEAAwE;IACxE,IACE,CAAC,OAAO,CAAC,YAAY;QACrB,YAAY,CAAC,MAAM,KAAK,SAAS;QACjC,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,EAAE,yBAAyB,CAAC,EACpE;QACA,OAAO,KAAK,CAAC;KACd;IAED,IAAI,OAAO,CAAC,YAAY,EAAE;QACxB,iDAAiD;QACjD,2CAA2C;QAC3C,IAAI,SAA4B,CAAC;QACjC,yCAAI,OAAO,CAAC,YAAY,UAAE,OAAO,EAAE,CAAC,IAAI,CAAC,UAAC,IAAI;YAC5C,SAAO,GAAG,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;YAC9D,OAAO,SAAO,KAAK,SAAS,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,8BAA8B;QAC9B,IAAI,CAAC,SAAO,EAAE;YACZ,OAAO,KAAK,CAAC;SACd;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AA3CD,0DA2CC;AAeD,SAAgB,kBAAkB,CAAC,EAQlC;QAPC,cAAc,oBAAA,EACd,sBAAsB,4BAAA,EACtB,SAAS,eAAA;IAMD,IAAA,iBAAiB,GAAK,cAAc,kBAAnB,CAAoB;IAE7C,IAAM,yBAAyB,GAAG,iBAAiB,CAAC,IAAI,CACtD,IAAA,aAAM,EAAC,UAAC,KAA4C;QAClD,oDAAoD;QACpD,OAAO,uBAAuB,CAAC,KAAK,CAAC,KAA4B,EAAE,sBAAsB,CAAC,CAAC;IAC7F,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,yBAAyB,CAAC,SAAS,CAAC,UAAC,YAAY;;QACtD,IAAM,OAAO,GAAG,YAAY,CAAC,KAA4B,CAAC;QAE1D,mCAAmC;QACnC,IAAI,GAAG,EAAE,QAAQ,EAAE,WAAW,CAAC;QAC/B,IAAI;YACF,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3B,QAAQ,GAAG,GAAG,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YACvC,WAAW,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;SACzC;QAAC,OAAO,CAAC,EAAE;YACV,wDAAwD;YACxD,2CAA2C;SAC5C;QAED,IAAM,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAClG,IAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5F,IAAM,qBAAqB;YACzB,GAAC,iBAAiB,IAAG,OAAO,CAAC,GAAG;YAChC,GAAC,uBAAuB,IAAG,QAAQ;YACnC,GAAC,0BAA0B,IAAG,WAAW;YACzC,GAAC,4BAA4B,IAAG,OAAO,CAAC,MAAM;YAC9C,GAAC,yBAAyB,IAAG,OAAO,CAAC,MAAM;YAC3C,GAAC,wBAAwB,IAAG,eAAe;YAC3C,GAAC,6BAA6B,IAAG,aAAa;YAC9C,GAAC,sBAAsB,IAAG,OAAO,CAAC,QAAQ;YAC1C,GAAC,+BAA+B,IAAG,OAAO,CAAC,eAAe;YAC1D,GAAC,gCAAgC,IAAG,OAAO,CAAC,gBAAgB;eAC7D,CAAC;QAEF,0BAA0B;QAC1B,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,CAAC,2CAA+B,EAAE,qBAAqB,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC;AAlDD,gDAkDC","sourcesContent":["import {\n BrowserClient,\n NetworkRequestEvent,\n NetworkCaptureRule,\n NetworkTrackingOptions,\n} from '@amplitude/analytics-core';\nimport { filter } from 'rxjs';\nimport { AllWindowObservables, TimestampedEvent } from './network-capture-plugin';\nimport { AMPLITUDE_NETWORK_REQUEST_EVENT } from './constants';\n\nconst DEFAULT_STATUS_CODE_RANGE = '500-599';\n\nfunction wildcardMatch(str: string, pattern: string) {\n // Escape all regex special characters except for *\n const escapedPattern = pattern.replace(/[-[\\]{}()+?.,\\\\^$|#\\s]/g, '\\\\$&');\n // Replace * with .*\n const regexPattern = '^' + escapedPattern.replace(/\\*/g, '.*') + '$';\n const regex = new RegExp(regexPattern);\n return regex.test(str);\n}\n\nfunction isStatusCodeInRange(statusCode: number, range: string) {\n const ranges = range.split(',');\n for (const r of ranges) {\n const [start, end] = r.split('-').map(Number);\n if (statusCode === start && end === undefined) {\n return true;\n }\n if (statusCode >= start && statusCode <= end) {\n return true;\n }\n }\n return false;\n}\n\nfunction isCaptureRuleMatch(rule: NetworkCaptureRule, hostname: string, status?: number) {\n // check if the host is in the allowed hosts\n if (rule.hosts && !rule.hosts.find((host: string) => wildcardMatch(hostname, host))) {\n return;\n }\n\n // check if the status code is in the allowed range\n if (status || status === 0) {\n const statusCodeRange = rule.statusCodeRange || DEFAULT_STATUS_CODE_RANGE;\n if (!isStatusCodeInRange(status, statusCodeRange)) {\n return false;\n }\n }\n\n return true;\n}\n\nexport function shouldTrackNetworkEvent(networkEvent: NetworkRequestEvent, options: NetworkTrackingOptions = {}) {\n const url = new URL(networkEvent.url);\n const host = url.hostname;\n\n // false if is amplitude request and not configured to track amplitude requests\n if (\n options.ignoreAmplitudeRequests !== false &&\n (wildcardMatch(host, '*.amplitude.com') || wildcardMatch(host, 'amplitude.com'))\n ) {\n return false;\n }\n\n // false if the host is in the ignore list\n if (options.ignoreHosts?.find((ignoreHost: string) => wildcardMatch(host, ignoreHost))) {\n return false;\n }\n\n // false if the status code is not 500-599 and there are no captureRules\n if (\n !options.captureRules &&\n networkEvent.status !== undefined &&\n !isStatusCodeInRange(networkEvent.status, DEFAULT_STATUS_CODE_RANGE)\n ) {\n return false;\n }\n\n if (options.captureRules) {\n // find the first capture rule, in reverse-order,\n // that is a match (true) or a miss (false)\n let isMatch: boolean | undefined;\n [...options.captureRules].reverse().find((rule) => {\n isMatch = isCaptureRuleMatch(rule, host, networkEvent.status);\n return isMatch !== undefined;\n });\n\n // if we found a miss (false) or no match (undefined),\n // then do not track the event\n if (!isMatch) {\n return false;\n }\n }\n\n return true;\n}\n\nexport type NetworkAnalyticsEvent = {\n ['[Amplitude] URL']: string;\n ['[Amplitude] URL Query']?: string;\n ['[Amplitude] URL Fragment']?: string;\n ['[Amplitude] Request Method']: string;\n ['[Amplitude] Status Code']?: number;\n ['[Amplitude] Start Time']?: string; // ISO 8601\n ['[Amplitude] Completion Time']?: string; // ISO 8601\n ['[Amplitude] Duration']?: number; // completionTime - startTime (millis)\n ['[Amplitude] Request Body Size']?: number;\n ['[Amplitude] Response Body Size']?: number;\n};\n\nexport function trackNetworkEvents({\n allObservables,\n networkTrackingOptions,\n amplitude,\n}: {\n allObservables: AllWindowObservables;\n networkTrackingOptions: NetworkTrackingOptions;\n amplitude: BrowserClient;\n}) {\n const { networkObservable } = allObservables;\n\n const filteredNetworkObservable = networkObservable.pipe(\n filter((event: TimestampedEvent<NetworkRequestEvent>) => {\n // Only track network events that should be tracked,\n return shouldTrackNetworkEvent(event.event as NetworkRequestEvent, networkTrackingOptions);\n }),\n );\n\n return filteredNetworkObservable.subscribe((networkEvent) => {\n const request = networkEvent.event as NetworkRequestEvent;\n\n // convert to NetworkAnalyticsEvent\n let url, urlQuery, urlFragment;\n try {\n url = new URL(request.url);\n urlQuery = url.searchParams.toString();\n urlFragment = url.hash.replace('#', '');\n } catch (e) {\n // if the URL failed to parse, just use the original URL\n // and do not include the query or fragment\n }\n\n const startTimeAsDate = request.startTime ? new Date(request.startTime).toISOString() : undefined;\n const endTimeAsDate = request.endTime ? new Date(request.endTime).toISOString() : undefined;\n const networkAnalyticsEvent: NetworkAnalyticsEvent = {\n ['[Amplitude] URL']: request.url,\n ['[Amplitude] URL Query']: urlQuery,\n ['[Amplitude] URL Fragment']: urlFragment,\n ['[Amplitude] Request Method']: request.method,\n ['[Amplitude] Status Code']: request.status,\n ['[Amplitude] Start Time']: startTimeAsDate,\n ['[Amplitude] Completion Time']: endTimeAsDate,\n ['[Amplitude] Duration']: request.duration,\n ['[Amplitude] Request Body Size']: request.requestBodySize,\n ['[Amplitude] Response Body Size']: request.responseBodySize,\n };\n\n /* istanbul ignore next */\n amplitude?.track(AMPLITUDE_NETWORK_REQUEST_EVENT, networkAnalyticsEvent);\n });\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kDAAkD,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,+CAA+C,CAAC","sourcesContent":["export const VERSION = '1.0.1-usenetworkcaptureinanalyticsbrowser-1.0';\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,8CAA8C,CAAC;AAEvE,eAAO,MAAM,+BAA+B,gCAAgC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,WAAW,GAAG,2CAA2C,CAAC;AAEvE,MAAM,CAAC,IAAM,+BAA+B,GAAG,6BAA6B,CAAC","sourcesContent":["export const PLUGIN_NAME = '@amplitude/plugin-network-capture-browser';\n\nexport const AMPLITUDE_NETWORK_REQUEST_EVENT = '[Amplitude] Network Request';\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,IAAI,MAAM,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC"}
|
package/lib/esm/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,IAAI,MAAM,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC","sourcesContent":["export { networkCapturePlugin as plugin, networkCapturePlugin } from './network-capture-plugin';\n"]}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { BrowserClient, BrowserConfig, EnrichmentPlugin, ElementInteractionsOptions, NetworkRequestEvent, NetworkTrackingOptions } from '@amplitude/analytics-core';
|
|
2
|
+
import { Observable } from 'rxjs';
|
|
3
|
+
import { HasEventTargetAddRemove } from 'rxjs/internal/observable/fromEvent';
|
|
4
|
+
declare global {
|
|
5
|
+
interface Window {
|
|
6
|
+
navigation: HasEventTargetAddRemove<Event>;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
export type BrowserEnrichmentPlugin = EnrichmentPlugin<BrowserClient, BrowserConfig>;
|
|
10
|
+
export type AutoCaptureOptionsWithDefaults = Required<Pick<ElementInteractionsOptions, 'debounceTime' | 'cssSelectorAllowlist' | 'actionClickAllowlist'>> & ElementInteractionsOptions;
|
|
11
|
+
export declare enum ObservablesEnum {
|
|
12
|
+
NetworkObservable = "networkObservable"
|
|
13
|
+
}
|
|
14
|
+
type BaseTimestampedEvent<T> = {
|
|
15
|
+
event: T;
|
|
16
|
+
timestamp: number;
|
|
17
|
+
type: 'rage' | 'click' | 'change' | 'error' | 'navigate' | 'mutation' | 'network';
|
|
18
|
+
};
|
|
19
|
+
export type ElementBasedEvent = MouseEvent | Event;
|
|
20
|
+
export type ElementBasedTimestampedEvent<T> = BaseTimestampedEvent<T> & {
|
|
21
|
+
event: MouseEvent | Event;
|
|
22
|
+
type: 'click' | 'change';
|
|
23
|
+
closestTrackedAncestor: Element;
|
|
24
|
+
targetElementProperties: Record<string, any>;
|
|
25
|
+
};
|
|
26
|
+
export type TimestampedEvent<T> = BaseTimestampedEvent<T> | ElementBasedTimestampedEvent<T>;
|
|
27
|
+
export interface AllWindowObservables {
|
|
28
|
+
[ObservablesEnum.NetworkObservable]: Observable<TimestampedEvent<NetworkRequestEvent>>;
|
|
29
|
+
}
|
|
30
|
+
export declare const networkCapturePlugin: (options?: NetworkTrackingOptions) => BrowserEnrichmentPlugin;
|
|
31
|
+
export {};
|
|
32
|
+
//# sourceMappingURL=network-capture-plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"network-capture-plugin.d.ts","sourceRoot":"","sources":["../../src/network-capture-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,0BAA0B,EAC1B,mBAAmB,EAGnB,sBAAsB,EACvB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAgB,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAG7E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,EAAE,uBAAuB,CAAC,KAAK,CAAC,CAAC;KAC5C;CACF;AAED,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAErF,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CACnD,IAAI,CAAC,0BAA0B,EAAE,cAAc,GAAG,sBAAsB,GAAG,sBAAsB,CAAC,CACnG,GACC,0BAA0B,CAAC;AAE7B,oBAAY,eAAe;IACzB,iBAAiB,sBAAsB;CACxC;AAGD,KAAK,oBAAoB,CAAC,CAAC,IAAI;IAC7B,KAAK,EAAE,CAAC,CAAC;IACT,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;CACnF,CAAC;AAGF,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,KAAK,CAAC;AACnD,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,GAAG;IACtE,KAAK,EAAE,UAAU,GAAG,KAAK,CAAC;IAC1B,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9C,CAAC;AAGF,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,GAAG,4BAA4B,CAAC,CAAC,CAAC,CAAC;AAE5F,MAAM,WAAW,oBAAoB;IACnC,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC;CACxF;AAED,eAAO,MAAM,oBAAoB,aAAa,sBAAsB,KAAQ,uBA2E3E,CAAC"}
|