clarity-js 0.8.0 → 0.8.1
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/README.md +26 -26
- package/build/clarity.extended.js +1 -1
- package/build/clarity.insight.js +1 -1
- package/build/clarity.js +5568 -5508
- package/build/clarity.min.js +1 -1
- package/build/clarity.module.js +5568 -5508
- package/build/clarity.performance.js +1 -1
- package/package.json +70 -70
- package/rollup.config.ts +98 -98
- package/src/clarity.ts +60 -60
- package/src/core/api.ts +8 -8
- package/src/core/config.ts +32 -32
- package/src/core/copy.ts +3 -3
- package/src/core/event.ts +53 -30
- package/src/core/hash.ts +19 -19
- package/src/core/history.ts +73 -73
- package/src/core/index.ts +83 -83
- package/src/core/measure.ts +19 -19
- package/src/core/report.ts +28 -28
- package/src/core/scrub.ts +196 -196
- package/src/core/task.ts +180 -180
- package/src/core/time.ts +19 -19
- package/src/core/timeout.ts +10 -10
- package/src/core/version.ts +2 -2
- package/src/data/baseline.ts +155 -155
- package/src/data/compress.ts +31 -31
- package/src/data/consent.ts +20 -20
- package/src/data/custom.ts +23 -23
- package/src/data/dimension.ts +53 -53
- package/src/data/encode.ts +140 -140
- package/src/data/envelope.ts +53 -53
- package/src/data/extract.ts +211 -204
- package/src/data/index.ts +46 -46
- package/src/data/limit.ts +44 -44
- package/src/data/metadata.ts +356 -356
- package/src/data/metric.ts +51 -51
- package/src/data/ping.ts +36 -36
- package/src/data/signal.ts +30 -30
- package/src/data/summary.ts +34 -34
- package/src/data/token.ts +39 -39
- package/src/data/upgrade.ts +37 -37
- package/src/data/upload.ts +283 -283
- package/src/data/variable.ts +83 -83
- package/src/diagnostic/encode.ts +40 -40
- package/src/diagnostic/fraud.ts +36 -36
- package/src/diagnostic/index.ts +15 -15
- package/src/diagnostic/internal.ts +28 -28
- package/src/diagnostic/script.ts +37 -37
- package/src/global.ts +6 -6
- package/src/index.ts +9 -9
- package/src/insight/blank.ts +14 -14
- package/src/insight/encode.ts +60 -60
- package/src/insight/snapshot.ts +114 -114
- package/src/interaction/change.ts +40 -40
- package/src/interaction/click.ts +162 -162
- package/src/interaction/clipboard.ts +34 -34
- package/src/interaction/encode.ts +193 -193
- package/src/interaction/index.ts +59 -59
- package/src/interaction/input.ts +59 -59
- package/src/interaction/pointer.ts +139 -139
- package/src/interaction/resize.ts +47 -47
- package/src/interaction/scroll.ts +124 -124
- package/src/interaction/selection.ts +68 -68
- package/src/interaction/submit.ts +32 -32
- package/src/interaction/timeline.ts +65 -65
- package/src/interaction/unload.ts +28 -28
- package/src/interaction/visibility.ts +26 -26
- package/src/layout/animation.ts +133 -133
- package/src/layout/discover.ts +31 -31
- package/src/layout/document.ts +48 -48
- package/src/layout/dom.ts +437 -414
- package/src/layout/encode.ts +147 -147
- package/src/layout/index.ts +41 -41
- package/src/layout/mutation.ts +409 -412
- package/src/layout/node.ts +292 -264
- package/src/layout/offset.ts +19 -19
- package/src/layout/region.ts +153 -153
- package/src/layout/schema.ts +63 -63
- package/src/layout/selector.ts +82 -82
- package/src/layout/style.ts +150 -150
- package/src/layout/target.ts +32 -32
- package/src/layout/traverse.ts +27 -27
- package/src/performance/blank.ts +7 -7
- package/src/performance/encode.ts +31 -31
- package/src/performance/index.ts +14 -14
- package/src/performance/interaction.ts +125 -125
- package/src/performance/navigation.ts +31 -31
- package/src/performance/observer.ts +108 -108
- package/src/queue.ts +33 -33
- package/test/core.test.ts +139 -139
- package/test/helper.ts +162 -162
- package/test/html/core.html +27 -27
- package/test/tsconfig.test.json +5 -5
- package/tsconfig.json +21 -21
- package/tslint.json +32 -32
- package/types/core.d.ts +153 -154
- package/types/data.d.ts +510 -510
- package/types/diagnostic.d.ts +24 -24
- package/types/index.d.ts +39 -39
- package/types/interaction.d.ts +165 -165
- package/types/layout.d.ts +272 -273
- package/types/performance.d.ts +64 -64
package/src/data/encode.ts
CHANGED
|
@@ -1,140 +1,140 @@
|
|
|
1
|
-
import { Event, Token } from "@clarity-types/data";
|
|
2
|
-
import { time } from "@src/core/time";
|
|
3
|
-
import * as baseline from "@src/data/baseline";
|
|
4
|
-
import * as custom from "@src/data/custom";
|
|
5
|
-
import * as dimension from "@src/data/dimension";
|
|
6
|
-
import * as limit from "@src/data/limit";
|
|
7
|
-
import * as metric from "@src/data/metric";
|
|
8
|
-
import * as ping from "@src/data/ping";
|
|
9
|
-
import * as summary from "@src/data/summary";
|
|
10
|
-
import * as upgrade from "@src/data/upgrade";
|
|
11
|
-
import * as variable from "@src/data/variable";
|
|
12
|
-
import * as extract from "@src/data/extract";
|
|
13
|
-
import { queue, track } from "./upload";
|
|
14
|
-
|
|
15
|
-
export default function(event: Event): void {
|
|
16
|
-
let t = time();
|
|
17
|
-
let tokens: Token[] = [t, event];
|
|
18
|
-
switch (event) {
|
|
19
|
-
case Event.Baseline:
|
|
20
|
-
let b = baseline.state;
|
|
21
|
-
if (b) {
|
|
22
|
-
tokens = [b.time, b.event];
|
|
23
|
-
tokens.push(b.data.visible);
|
|
24
|
-
tokens.push(b.data.docWidth);
|
|
25
|
-
tokens.push(b.data.docHeight);
|
|
26
|
-
tokens.push(b.data.screenWidth);
|
|
27
|
-
tokens.push(b.data.screenHeight);
|
|
28
|
-
tokens.push(b.data.scrollX);
|
|
29
|
-
tokens.push(b.data.scrollY);
|
|
30
|
-
tokens.push(b.data.pointerX);
|
|
31
|
-
tokens.push(b.data.pointerY);
|
|
32
|
-
tokens.push(b.data.activityTime);
|
|
33
|
-
tokens.push(b.data.scrollTime);
|
|
34
|
-
tokens.push(b.data.pointerTime);
|
|
35
|
-
tokens.push(b.data.moveX);
|
|
36
|
-
tokens.push(b.data.moveY);
|
|
37
|
-
tokens.push(b.data.moveTime);
|
|
38
|
-
tokens.push(b.data.downX);
|
|
39
|
-
tokens.push(b.data.downY);
|
|
40
|
-
tokens.push(b.data.downTime);
|
|
41
|
-
tokens.push(b.data.upX);
|
|
42
|
-
tokens.push(b.data.upY);
|
|
43
|
-
tokens.push(b.data.upTime);
|
|
44
|
-
tokens.push(b.data.pointerPrevX);
|
|
45
|
-
tokens.push(b.data.pointerPrevY);
|
|
46
|
-
tokens.push(b.data.pointerPrevTime);
|
|
47
|
-
queue(tokens, false);
|
|
48
|
-
}
|
|
49
|
-
baseline.reset();
|
|
50
|
-
break;
|
|
51
|
-
case Event.Ping:
|
|
52
|
-
tokens.push(ping.data.gap);
|
|
53
|
-
queue(tokens);
|
|
54
|
-
break;
|
|
55
|
-
case Event.Limit:
|
|
56
|
-
tokens.push(limit.data.check);
|
|
57
|
-
queue(tokens, false);
|
|
58
|
-
break;
|
|
59
|
-
case Event.Upgrade:
|
|
60
|
-
tokens.push(upgrade.data.key);
|
|
61
|
-
queue(tokens);
|
|
62
|
-
break;
|
|
63
|
-
case Event.Upload:
|
|
64
|
-
tokens.push(track.sequence);
|
|
65
|
-
tokens.push(track.attempts);
|
|
66
|
-
tokens.push(track.status);
|
|
67
|
-
queue(tokens, false);
|
|
68
|
-
break;
|
|
69
|
-
case Event.Custom:
|
|
70
|
-
// not all custom events have a key - if it wasn't passed server handles just value
|
|
71
|
-
custom.data.key && tokens.push(custom.data.key);
|
|
72
|
-
tokens.push(custom.data.value);
|
|
73
|
-
queue(tokens);
|
|
74
|
-
break;
|
|
75
|
-
case Event.Variable:
|
|
76
|
-
let variableKeys = Object.keys(variable.data);
|
|
77
|
-
if (variableKeys.length > 0) {
|
|
78
|
-
for (let v of variableKeys) {
|
|
79
|
-
tokens.push(v);
|
|
80
|
-
tokens.push(variable.data[v]);
|
|
81
|
-
}
|
|
82
|
-
variable.reset();
|
|
83
|
-
queue(tokens, false);
|
|
84
|
-
}
|
|
85
|
-
break;
|
|
86
|
-
case Event.Metric:
|
|
87
|
-
let metricKeys = Object.keys(metric.updates);
|
|
88
|
-
if (metricKeys.length > 0) {
|
|
89
|
-
for (let m of metricKeys) {
|
|
90
|
-
let key = parseInt(m, 10);
|
|
91
|
-
tokens.push(key);
|
|
92
|
-
// For computation, we need microseconds precision that performance.now() API offers
|
|
93
|
-
// However, for data over the wire, we round it off to milliseconds precision.
|
|
94
|
-
tokens.push(Math.round(metric.updates[m]));
|
|
95
|
-
}
|
|
96
|
-
metric.reset();
|
|
97
|
-
queue(tokens, false);
|
|
98
|
-
}
|
|
99
|
-
break;
|
|
100
|
-
case Event.Dimension:
|
|
101
|
-
let dimensionKeys = Object.keys(dimension.updates);
|
|
102
|
-
if (dimensionKeys.length > 0) {
|
|
103
|
-
for (let d of dimensionKeys) {
|
|
104
|
-
let key = parseInt(d, 10);
|
|
105
|
-
tokens.push(key);
|
|
106
|
-
tokens.push(dimension.updates[d]);
|
|
107
|
-
}
|
|
108
|
-
dimension.reset();
|
|
109
|
-
queue(tokens, false);
|
|
110
|
-
}
|
|
111
|
-
break;
|
|
112
|
-
case Event.Summary:
|
|
113
|
-
let eventKeys = Object.keys(summary.data);
|
|
114
|
-
if (eventKeys.length > 0) {
|
|
115
|
-
for (let e of eventKeys) {
|
|
116
|
-
let key = parseInt(e, 10);
|
|
117
|
-
tokens.push(key);
|
|
118
|
-
tokens.push([].concat(...summary.data[e]));
|
|
119
|
-
}
|
|
120
|
-
summary.reset();
|
|
121
|
-
queue(tokens, false);
|
|
122
|
-
}
|
|
123
|
-
break;
|
|
124
|
-
case Event.Extract:
|
|
125
|
-
let extractKeys = extract.keys;
|
|
126
|
-
extractKeys.forEach((e => {
|
|
127
|
-
tokens.push(e);
|
|
128
|
-
let token = []
|
|
129
|
-
for (let d in extract.data[e]) {
|
|
130
|
-
let key = parseInt(d, 10);
|
|
131
|
-
token.push(key);
|
|
132
|
-
token.push(extract.data[e][d]);
|
|
133
|
-
}
|
|
134
|
-
tokens.push(token);
|
|
135
|
-
}));
|
|
136
|
-
|
|
137
|
-
extract.reset();
|
|
138
|
-
queue(tokens, false);
|
|
139
|
-
}
|
|
140
|
-
}
|
|
1
|
+
import { Event, Token } from "@clarity-types/data";
|
|
2
|
+
import { time } from "@src/core/time";
|
|
3
|
+
import * as baseline from "@src/data/baseline";
|
|
4
|
+
import * as custom from "@src/data/custom";
|
|
5
|
+
import * as dimension from "@src/data/dimension";
|
|
6
|
+
import * as limit from "@src/data/limit";
|
|
7
|
+
import * as metric from "@src/data/metric";
|
|
8
|
+
import * as ping from "@src/data/ping";
|
|
9
|
+
import * as summary from "@src/data/summary";
|
|
10
|
+
import * as upgrade from "@src/data/upgrade";
|
|
11
|
+
import * as variable from "@src/data/variable";
|
|
12
|
+
import * as extract from "@src/data/extract";
|
|
13
|
+
import { queue, track } from "./upload";
|
|
14
|
+
|
|
15
|
+
export default function(event: Event): void {
|
|
16
|
+
let t = time();
|
|
17
|
+
let tokens: Token[] = [t, event];
|
|
18
|
+
switch (event) {
|
|
19
|
+
case Event.Baseline:
|
|
20
|
+
let b = baseline.state;
|
|
21
|
+
if (b) {
|
|
22
|
+
tokens = [b.time, b.event];
|
|
23
|
+
tokens.push(b.data.visible);
|
|
24
|
+
tokens.push(b.data.docWidth);
|
|
25
|
+
tokens.push(b.data.docHeight);
|
|
26
|
+
tokens.push(b.data.screenWidth);
|
|
27
|
+
tokens.push(b.data.screenHeight);
|
|
28
|
+
tokens.push(b.data.scrollX);
|
|
29
|
+
tokens.push(b.data.scrollY);
|
|
30
|
+
tokens.push(b.data.pointerX);
|
|
31
|
+
tokens.push(b.data.pointerY);
|
|
32
|
+
tokens.push(b.data.activityTime);
|
|
33
|
+
tokens.push(b.data.scrollTime);
|
|
34
|
+
tokens.push(b.data.pointerTime);
|
|
35
|
+
tokens.push(b.data.moveX);
|
|
36
|
+
tokens.push(b.data.moveY);
|
|
37
|
+
tokens.push(b.data.moveTime);
|
|
38
|
+
tokens.push(b.data.downX);
|
|
39
|
+
tokens.push(b.data.downY);
|
|
40
|
+
tokens.push(b.data.downTime);
|
|
41
|
+
tokens.push(b.data.upX);
|
|
42
|
+
tokens.push(b.data.upY);
|
|
43
|
+
tokens.push(b.data.upTime);
|
|
44
|
+
tokens.push(b.data.pointerPrevX);
|
|
45
|
+
tokens.push(b.data.pointerPrevY);
|
|
46
|
+
tokens.push(b.data.pointerPrevTime);
|
|
47
|
+
queue(tokens, false);
|
|
48
|
+
}
|
|
49
|
+
baseline.reset();
|
|
50
|
+
break;
|
|
51
|
+
case Event.Ping:
|
|
52
|
+
tokens.push(ping.data.gap);
|
|
53
|
+
queue(tokens);
|
|
54
|
+
break;
|
|
55
|
+
case Event.Limit:
|
|
56
|
+
tokens.push(limit.data.check);
|
|
57
|
+
queue(tokens, false);
|
|
58
|
+
break;
|
|
59
|
+
case Event.Upgrade:
|
|
60
|
+
tokens.push(upgrade.data.key);
|
|
61
|
+
queue(tokens);
|
|
62
|
+
break;
|
|
63
|
+
case Event.Upload:
|
|
64
|
+
tokens.push(track.sequence);
|
|
65
|
+
tokens.push(track.attempts);
|
|
66
|
+
tokens.push(track.status);
|
|
67
|
+
queue(tokens, false);
|
|
68
|
+
break;
|
|
69
|
+
case Event.Custom:
|
|
70
|
+
// not all custom events have a key - if it wasn't passed server handles just value
|
|
71
|
+
custom.data.key && tokens.push(custom.data.key);
|
|
72
|
+
tokens.push(custom.data.value);
|
|
73
|
+
queue(tokens);
|
|
74
|
+
break;
|
|
75
|
+
case Event.Variable:
|
|
76
|
+
let variableKeys = Object.keys(variable.data);
|
|
77
|
+
if (variableKeys.length > 0) {
|
|
78
|
+
for (let v of variableKeys) {
|
|
79
|
+
tokens.push(v);
|
|
80
|
+
tokens.push(variable.data[v]);
|
|
81
|
+
}
|
|
82
|
+
variable.reset();
|
|
83
|
+
queue(tokens, false);
|
|
84
|
+
}
|
|
85
|
+
break;
|
|
86
|
+
case Event.Metric:
|
|
87
|
+
let metricKeys = Object.keys(metric.updates);
|
|
88
|
+
if (metricKeys.length > 0) {
|
|
89
|
+
for (let m of metricKeys) {
|
|
90
|
+
let key = parseInt(m, 10);
|
|
91
|
+
tokens.push(key);
|
|
92
|
+
// For computation, we need microseconds precision that performance.now() API offers
|
|
93
|
+
// However, for data over the wire, we round it off to milliseconds precision.
|
|
94
|
+
tokens.push(Math.round(metric.updates[m]));
|
|
95
|
+
}
|
|
96
|
+
metric.reset();
|
|
97
|
+
queue(tokens, false);
|
|
98
|
+
}
|
|
99
|
+
break;
|
|
100
|
+
case Event.Dimension:
|
|
101
|
+
let dimensionKeys = Object.keys(dimension.updates);
|
|
102
|
+
if (dimensionKeys.length > 0) {
|
|
103
|
+
for (let d of dimensionKeys) {
|
|
104
|
+
let key = parseInt(d, 10);
|
|
105
|
+
tokens.push(key);
|
|
106
|
+
tokens.push(dimension.updates[d]);
|
|
107
|
+
}
|
|
108
|
+
dimension.reset();
|
|
109
|
+
queue(tokens, false);
|
|
110
|
+
}
|
|
111
|
+
break;
|
|
112
|
+
case Event.Summary:
|
|
113
|
+
let eventKeys = Object.keys(summary.data);
|
|
114
|
+
if (eventKeys.length > 0) {
|
|
115
|
+
for (let e of eventKeys) {
|
|
116
|
+
let key = parseInt(e, 10);
|
|
117
|
+
tokens.push(key);
|
|
118
|
+
tokens.push([].concat(...summary.data[e]));
|
|
119
|
+
}
|
|
120
|
+
summary.reset();
|
|
121
|
+
queue(tokens, false);
|
|
122
|
+
}
|
|
123
|
+
break;
|
|
124
|
+
case Event.Extract:
|
|
125
|
+
let extractKeys = extract.keys;
|
|
126
|
+
extractKeys.forEach((e => {
|
|
127
|
+
tokens.push(e);
|
|
128
|
+
let token = []
|
|
129
|
+
for (let d in extract.data[e]) {
|
|
130
|
+
let key = parseInt(d, 10);
|
|
131
|
+
token.push(key);
|
|
132
|
+
token.push(extract.data[e][d]);
|
|
133
|
+
}
|
|
134
|
+
tokens.push(token);
|
|
135
|
+
}));
|
|
136
|
+
|
|
137
|
+
extract.reset();
|
|
138
|
+
queue(tokens, false);
|
|
139
|
+
}
|
|
140
|
+
}
|
package/src/data/envelope.ts
CHANGED
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
import { BooleanFlag, Token, Upload, Envelope, ApplicationPlatform } from "@clarity-types/data";
|
|
2
|
-
import { time } from "@src/core/time";
|
|
3
|
-
import version from "@src/core/version";
|
|
4
|
-
import * as metadata from "@src/data/metadata";
|
|
5
|
-
import * as scrub from "@src/core/scrub";
|
|
6
|
-
|
|
7
|
-
export let data: Envelope = null;
|
|
8
|
-
|
|
9
|
-
export function start(): void {
|
|
10
|
-
const m = metadata.data;
|
|
11
|
-
data = {
|
|
12
|
-
version,
|
|
13
|
-
sequence: 0,
|
|
14
|
-
start: 0,
|
|
15
|
-
duration: 0,
|
|
16
|
-
projectId: m.projectId,
|
|
17
|
-
userId: m.userId,
|
|
18
|
-
sessionId: m.sessionId,
|
|
19
|
-
pageNum: m.pageNum,
|
|
20
|
-
upload: Upload.Async,
|
|
21
|
-
end: BooleanFlag.False,
|
|
22
|
-
applicationPlatform: ApplicationPlatform.WebApp,
|
|
23
|
-
url: ''
|
|
24
|
-
};
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
export function stop(): void {
|
|
28
|
-
data = null;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
export function envelope(last: boolean): Token[] {
|
|
32
|
-
data.start = data.start + data.duration;
|
|
33
|
-
data.duration = time() - data.start;
|
|
34
|
-
data.sequence++;
|
|
35
|
-
data.upload = last && "sendBeacon" in navigator ? Upload.Beacon : Upload.Async;
|
|
36
|
-
data.end = last ? BooleanFlag.True : BooleanFlag.False;
|
|
37
|
-
data.applicationPlatform = ApplicationPlatform.WebApp;
|
|
38
|
-
data.url = scrub.url(location.href, false, true);
|
|
39
|
-
return [
|
|
40
|
-
data.version,
|
|
41
|
-
data.sequence,
|
|
42
|
-
data.start,
|
|
43
|
-
data.duration,
|
|
44
|
-
data.projectId,
|
|
45
|
-
data.userId,
|
|
46
|
-
data.sessionId,
|
|
47
|
-
data.pageNum,
|
|
48
|
-
data.upload,
|
|
49
|
-
data.end,
|
|
50
|
-
data.applicationPlatform,
|
|
51
|
-
data.url
|
|
52
|
-
];
|
|
53
|
-
}
|
|
1
|
+
import { BooleanFlag, Token, Upload, Envelope, ApplicationPlatform } from "@clarity-types/data";
|
|
2
|
+
import { time } from "@src/core/time";
|
|
3
|
+
import version from "@src/core/version";
|
|
4
|
+
import * as metadata from "@src/data/metadata";
|
|
5
|
+
import * as scrub from "@src/core/scrub";
|
|
6
|
+
|
|
7
|
+
export let data: Envelope = null;
|
|
8
|
+
|
|
9
|
+
export function start(): void {
|
|
10
|
+
const m = metadata.data;
|
|
11
|
+
data = {
|
|
12
|
+
version,
|
|
13
|
+
sequence: 0,
|
|
14
|
+
start: 0,
|
|
15
|
+
duration: 0,
|
|
16
|
+
projectId: m.projectId,
|
|
17
|
+
userId: m.userId,
|
|
18
|
+
sessionId: m.sessionId,
|
|
19
|
+
pageNum: m.pageNum,
|
|
20
|
+
upload: Upload.Async,
|
|
21
|
+
end: BooleanFlag.False,
|
|
22
|
+
applicationPlatform: ApplicationPlatform.WebApp,
|
|
23
|
+
url: ''
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export function stop(): void {
|
|
28
|
+
data = null;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export function envelope(last: boolean): Token[] {
|
|
32
|
+
data.start = data.start + data.duration;
|
|
33
|
+
data.duration = time() - data.start;
|
|
34
|
+
data.sequence++;
|
|
35
|
+
data.upload = last && "sendBeacon" in navigator ? Upload.Beacon : Upload.Async;
|
|
36
|
+
data.end = last ? BooleanFlag.True : BooleanFlag.False;
|
|
37
|
+
data.applicationPlatform = ApplicationPlatform.WebApp;
|
|
38
|
+
data.url = scrub.url(location.href, false, true);
|
|
39
|
+
return [
|
|
40
|
+
data.version,
|
|
41
|
+
data.sequence,
|
|
42
|
+
data.start,
|
|
43
|
+
data.duration,
|
|
44
|
+
data.projectId,
|
|
45
|
+
data.userId,
|
|
46
|
+
data.sessionId,
|
|
47
|
+
data.pageNum,
|
|
48
|
+
data.upload,
|
|
49
|
+
data.end,
|
|
50
|
+
data.applicationPlatform,
|
|
51
|
+
data.url
|
|
52
|
+
];
|
|
53
|
+
}
|