clarity-js 0.8.6 → 0.8.8-beta

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 (103) hide show
  1. package/README.md +26 -26
  2. package/build/clarity.extended.js +1 -1
  3. package/build/clarity.insight.js +1 -1
  4. package/build/clarity.js +5257 -5603
  5. package/build/clarity.min.js +1 -1
  6. package/build/clarity.module.js +5257 -5603
  7. package/build/clarity.performance.js +1 -1
  8. package/package.json +70 -70
  9. package/rollup.config.ts +98 -98
  10. package/src/clarity.ts +60 -60
  11. package/src/core/api.ts +8 -8
  12. package/src/core/config.ts +33 -33
  13. package/src/core/copy.ts +3 -3
  14. package/src/core/event.ts +53 -53
  15. package/src/core/hash.ts +19 -19
  16. package/src/core/history.ts +73 -73
  17. package/src/core/index.ts +83 -83
  18. package/src/core/measure.ts +19 -19
  19. package/src/core/report.ts +28 -28
  20. package/src/core/scrub.ts +196 -196
  21. package/src/core/task.ts +181 -181
  22. package/src/core/time.ts +19 -19
  23. package/src/core/timeout.ts +10 -10
  24. package/src/core/version.ts +2 -2
  25. package/src/data/baseline.ts +155 -155
  26. package/src/data/compress.ts +31 -31
  27. package/src/data/consent.ts +20 -20
  28. package/src/data/custom.ts +23 -23
  29. package/src/data/dimension.ts +53 -53
  30. package/src/data/encode.ts +140 -140
  31. package/src/data/envelope.ts +53 -53
  32. package/src/data/extract.ts +211 -211
  33. package/src/data/index.ts +46 -46
  34. package/src/data/limit.ts +44 -44
  35. package/src/data/metadata.ts +344 -344
  36. package/src/data/metric.ts +51 -51
  37. package/src/data/ping.ts +36 -36
  38. package/src/data/signal.ts +30 -30
  39. package/src/data/summary.ts +34 -34
  40. package/src/data/token.ts +39 -39
  41. package/src/data/upgrade.ts +44 -44
  42. package/src/data/upload.ts +283 -283
  43. package/src/data/variable.ts +83 -83
  44. package/src/diagnostic/encode.ts +40 -40
  45. package/src/diagnostic/fraud.ts +36 -36
  46. package/src/diagnostic/index.ts +15 -15
  47. package/src/diagnostic/internal.ts +28 -28
  48. package/src/diagnostic/script.ts +37 -37
  49. package/src/global.ts +6 -6
  50. package/src/index.ts +9 -9
  51. package/src/insight/blank.ts +14 -14
  52. package/src/insight/encode.ts +60 -60
  53. package/src/insight/snapshot.ts +114 -114
  54. package/src/interaction/change.ts +40 -40
  55. package/src/interaction/click.ts +162 -162
  56. package/src/interaction/clipboard.ts +34 -34
  57. package/src/interaction/encode.ts +193 -193
  58. package/src/interaction/index.ts +59 -59
  59. package/src/interaction/input.ts +59 -59
  60. package/src/interaction/pointer.ts +139 -139
  61. package/src/interaction/resize.ts +47 -47
  62. package/src/interaction/scroll.ts +124 -124
  63. package/src/interaction/selection.ts +68 -68
  64. package/src/interaction/submit.ts +32 -32
  65. package/src/interaction/timeline.ts +65 -65
  66. package/src/interaction/unload.ts +28 -28
  67. package/src/interaction/visibility.ts +26 -26
  68. package/src/layout/animation.ts +133 -133
  69. package/src/layout/discover.ts +31 -31
  70. package/src/layout/document.ts +48 -48
  71. package/src/layout/dom.ts +439 -439
  72. package/src/layout/encode.ts +147 -147
  73. package/src/layout/index.ts +41 -41
  74. package/src/layout/mutation.ts +417 -417
  75. package/src/layout/node.ts +292 -292
  76. package/src/layout/offset.ts +19 -19
  77. package/src/layout/region.ts +153 -153
  78. package/src/layout/schema.ts +63 -63
  79. package/src/layout/selector.ts +82 -82
  80. package/src/layout/style.ts +160 -164
  81. package/src/layout/target.ts +32 -32
  82. package/src/layout/traverse.ts +27 -27
  83. package/src/performance/blank.ts +7 -7
  84. package/src/performance/encode.ts +31 -31
  85. package/src/performance/index.ts +14 -14
  86. package/src/performance/interaction.ts +125 -125
  87. package/src/performance/navigation.ts +31 -31
  88. package/src/performance/observer.ts +108 -108
  89. package/src/queue.ts +33 -33
  90. package/test/core.test.ts +139 -139
  91. package/test/helper.ts +162 -162
  92. package/test/html/core.html +27 -27
  93. package/test/stub.test.ts +7 -7
  94. package/test/tsconfig.test.json +5 -5
  95. package/tsconfig.json +21 -21
  96. package/tslint.json +32 -32
  97. package/types/core.d.ts +154 -154
  98. package/types/data.d.ts +514 -511
  99. package/types/diagnostic.d.ts +24 -24
  100. package/types/index.d.ts +39 -39
  101. package/types/interaction.d.ts +165 -165
  102. package/types/layout.d.ts +272 -272
  103. package/types/performance.d.ts +64 -64
@@ -1,162 +1,162 @@
1
- import { BooleanFlag, Constant, Event, Setting } from "@clarity-types/data";
2
- import { BrowsingContext, ClickState, TextInfo } from "@clarity-types/interaction";
3
- import { Box } from "@clarity-types/layout";
4
- import { FunctionNames } from "@clarity-types/performance";
5
- import { bind } from "@src/core/event";
6
- import { schedule } from "@src/core/task";
7
- import { time } from "@src/core/time";
8
- import { iframe } from "@src/layout/dom";
9
- import { offset } from "@src/layout/offset";
10
- import { target } from "@src/layout/target";
11
- import encode from "./encode";
12
-
13
- const UserInputTags = ["input", "textarea", "radio", "button", "canvas", "select"];
14
- export let state: ClickState[] = [];
15
-
16
- export function start(): void {
17
- reset();
18
- }
19
-
20
- export function observe(root: Node): void {
21
- bind(root, "click", handler.bind(this, Event.Click, root), true);
22
- }
23
-
24
- function handler(event: Event, root: Node, evt: MouseEvent): void {
25
- handler.dn = FunctionNames.ClickHandler;
26
- let frame = iframe(root);
27
- let d = frame ? frame.contentDocument.documentElement : document.documentElement;
28
- let x = "pageX" in evt ? Math.round(evt.pageX) : ("clientX" in evt ? Math.round(evt["clientX"] + d.scrollLeft) : null);
29
- let y = "pageY" in evt ? Math.round(evt.pageY) : ("clientY" in evt ? Math.round(evt["clientY"] + d.scrollTop) : null);
30
- // In case of iframe, we adjust (x,y) to be relative to top parent's origin
31
- if (frame) {
32
- let distance = offset(frame);
33
- x = x ? x + Math.round(distance.x) : x;
34
- y = y ? y + Math.round(distance.y) : y;
35
- }
36
-
37
- let t = target(evt);
38
- // Find nearest anchor tag (<a/>) parent if current target node is part of one
39
- // If present, we use the returned link element to populate text and link properties below
40
- let a = link(t);
41
-
42
- // Get layout rectangle for the target element
43
- let l = layout(t as Element);
44
-
45
- // Reference: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail
46
- // This property helps differentiate between a keyboard navigation vs. pointer click
47
- // In case of a keyboard navigation, we use center of target element as (x,y)
48
- if (evt.detail === 0 && l) {
49
- x = Math.round(l.x + (l.w / 2));
50
- y = Math.round(l.y + (l.h / 2));
51
- }
52
-
53
- let eX = l ? Math.max(Math.floor(((x - l.x) / l.w) * Setting.ClickPrecision), 0) : 0;
54
- let eY = l ? Math.max(Math.floor(((y - l.y) / l.h) * Setting.ClickPrecision), 0) : 0;
55
-
56
- // Check for null values before processing this event
57
- if (x !== null && y !== null) {
58
- const textInfo = text(t);
59
- state.push({
60
- time: time(evt), event, data: {
61
- target: t,
62
- x,
63
- y,
64
- eX,
65
- eY,
66
- button: evt.button,
67
- reaction: reaction(t),
68
- context: context(a),
69
- text: textInfo.text,
70
- link: a ? a.href : null,
71
- hash: null,
72
- trust: evt.isTrusted ? BooleanFlag.True : BooleanFlag.False,
73
- isFullText: textInfo.isFullText,
74
- }
75
- });
76
- schedule(encode.bind(this, event));
77
- }
78
- }
79
-
80
- function link(node: Node): HTMLAnchorElement {
81
- while (node && node !== document) {
82
- if (node.nodeType === Node.ELEMENT_NODE) {
83
- let element = node as HTMLElement;
84
- if (element.tagName === "A") {
85
- return element as HTMLAnchorElement;
86
- }
87
- }
88
- node = node.parentNode;
89
- }
90
- return null;
91
- }
92
-
93
- function text(element: Node): TextInfo {
94
- let output = null;
95
- let isFullText = false;
96
- if (element) {
97
- // Grab text using "textContent" for most HTMLElements, however, use "value" for HTMLInputElements and "alt" for HTMLImageElement.
98
- let t = element.textContent || String((element as HTMLInputElement).value || '') || (element as HTMLImageElement).alt;
99
- if (t) {
100
- // Replace multiple occurrence of space characters with a single white space
101
- // Also, trim any spaces at the beginning or at the end of string
102
- const trimmedText = t.replace(/\s+/g, Constant.Space).trim();
103
- // Finally, send only first few characters as specified by the Setting
104
- output = trimmedText.substring(0, Setting.ClickText);
105
- isFullText = output.length === trimmedText.length;
106
- }
107
- }
108
-
109
- return { text: output, isFullText: isFullText ? BooleanFlag.True : BooleanFlag.False };
110
- }
111
-
112
- function reaction(element: Node): BooleanFlag {
113
- if (element.nodeType === Node.ELEMENT_NODE) {
114
- let tag = (element as HTMLElement).tagName.toLowerCase();
115
- if (UserInputTags.indexOf(tag) >= 0) {
116
- return BooleanFlag.False;
117
- }
118
- }
119
- return BooleanFlag.True;
120
- }
121
-
122
- function layout(element: Element): Box {
123
- let box: Box = null;
124
- let de = document.documentElement;
125
- if (typeof element.getBoundingClientRect === "function") {
126
- // getBoundingClientRect returns rectangle relative positioning to viewport
127
- let rect = element.getBoundingClientRect();
128
-
129
- if (rect && rect.width > 0 && rect.height > 0) {
130
- // Add viewport's scroll position to rectangle to get position relative to document origin
131
- // Also: using Math.floor() instead of Math.round() because in Edge,
132
- // getBoundingClientRect returns partial pixel values (e.g. 162.5px) and Chrome already
133
- // floors the value (e.g. 162px). This keeps consistent behavior across browsers.
134
- box = {
135
- x: Math.floor(rect.left + ("pageXOffset" in window ? window.pageXOffset : de.scrollLeft)),
136
- y: Math.floor(rect.top + ("pageYOffset" in window ? window.pageYOffset : de.scrollTop)),
137
- w: Math.floor(rect.width),
138
- h: Math.floor(rect.height)
139
- };
140
- }
141
- }
142
- return box;
143
- }
144
-
145
- function context(a: HTMLAnchorElement): BrowsingContext {
146
- if (a && a.hasAttribute(Constant.Target)) {
147
- switch (a.getAttribute(Constant.Target)) {
148
- case Constant.Blank: return BrowsingContext.Blank;
149
- case Constant.Parent: return BrowsingContext.Parent;
150
- case Constant.Top: return BrowsingContext.Top;
151
- }
152
- }
153
- return BrowsingContext.Self;
154
- }
155
-
156
- export function reset(): void {
157
- state = [];
158
- }
159
-
160
- export function stop(): void {
161
- reset();
162
- }
1
+ import { BooleanFlag, Constant, Event, Setting } from "@clarity-types/data";
2
+ import { BrowsingContext, ClickState, TextInfo } from "@clarity-types/interaction";
3
+ import { Box } from "@clarity-types/layout";
4
+ import { FunctionNames } from "@clarity-types/performance";
5
+ import { bind } from "@src/core/event";
6
+ import { schedule } from "@src/core/task";
7
+ import { time } from "@src/core/time";
8
+ import { iframe } from "@src/layout/dom";
9
+ import { offset } from "@src/layout/offset";
10
+ import { target } from "@src/layout/target";
11
+ import encode from "./encode";
12
+
13
+ const UserInputTags = ["input", "textarea", "radio", "button", "canvas", "select"];
14
+ export let state: ClickState[] = [];
15
+
16
+ export function start(): void {
17
+ reset();
18
+ }
19
+
20
+ export function observe(root: Node): void {
21
+ bind(root, "click", handler.bind(this, Event.Click, root), true);
22
+ }
23
+
24
+ function handler(event: Event, root: Node, evt: MouseEvent): void {
25
+ handler.dn = FunctionNames.ClickHandler;
26
+ let frame = iframe(root);
27
+ let d = frame ? frame.contentDocument.documentElement : document.documentElement;
28
+ let x = "pageX" in evt ? Math.round(evt.pageX) : ("clientX" in evt ? Math.round(evt["clientX"] + d.scrollLeft) : null);
29
+ let y = "pageY" in evt ? Math.round(evt.pageY) : ("clientY" in evt ? Math.round(evt["clientY"] + d.scrollTop) : null);
30
+ // In case of iframe, we adjust (x,y) to be relative to top parent's origin
31
+ if (frame) {
32
+ let distance = offset(frame);
33
+ x = x ? x + Math.round(distance.x) : x;
34
+ y = y ? y + Math.round(distance.y) : y;
35
+ }
36
+
37
+ let t = target(evt);
38
+ // Find nearest anchor tag (<a/>) parent if current target node is part of one
39
+ // If present, we use the returned link element to populate text and link properties below
40
+ let a = link(t);
41
+
42
+ // Get layout rectangle for the target element
43
+ let l = layout(t as Element);
44
+
45
+ // Reference: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail
46
+ // This property helps differentiate between a keyboard navigation vs. pointer click
47
+ // In case of a keyboard navigation, we use center of target element as (x,y)
48
+ if (evt.detail === 0 && l) {
49
+ x = Math.round(l.x + (l.w / 2));
50
+ y = Math.round(l.y + (l.h / 2));
51
+ }
52
+
53
+ let eX = l ? Math.max(Math.floor(((x - l.x) / l.w) * Setting.ClickPrecision), 0) : 0;
54
+ let eY = l ? Math.max(Math.floor(((y - l.y) / l.h) * Setting.ClickPrecision), 0) : 0;
55
+
56
+ // Check for null values before processing this event
57
+ if (x !== null && y !== null) {
58
+ const textInfo = text(t);
59
+ state.push({
60
+ time: time(evt), event, data: {
61
+ target: t,
62
+ x,
63
+ y,
64
+ eX,
65
+ eY,
66
+ button: evt.button,
67
+ reaction: reaction(t),
68
+ context: context(a),
69
+ text: textInfo.text,
70
+ link: a ? a.href : null,
71
+ hash: null,
72
+ trust: evt.isTrusted ? BooleanFlag.True : BooleanFlag.False,
73
+ isFullText: textInfo.isFullText,
74
+ }
75
+ });
76
+ schedule(encode.bind(this, event));
77
+ }
78
+ }
79
+
80
+ function link(node: Node): HTMLAnchorElement {
81
+ while (node && node !== document) {
82
+ if (node.nodeType === Node.ELEMENT_NODE) {
83
+ let element = node as HTMLElement;
84
+ if (element.tagName === "A") {
85
+ return element as HTMLAnchorElement;
86
+ }
87
+ }
88
+ node = node.parentNode;
89
+ }
90
+ return null;
91
+ }
92
+
93
+ function text(element: Node): TextInfo {
94
+ let output = null;
95
+ let isFullText = false;
96
+ if (element) {
97
+ // Grab text using "textContent" for most HTMLElements, however, use "value" for HTMLInputElements and "alt" for HTMLImageElement.
98
+ let t = element.textContent || String((element as HTMLInputElement).value || '') || (element as HTMLImageElement).alt;
99
+ if (t) {
100
+ // Replace multiple occurrence of space characters with a single white space
101
+ // Also, trim any spaces at the beginning or at the end of string
102
+ const trimmedText = t.replace(/\s+/g, Constant.Space).trim();
103
+ // Finally, send only first few characters as specified by the Setting
104
+ output = trimmedText.substring(0, Setting.ClickText);
105
+ isFullText = output.length === trimmedText.length;
106
+ }
107
+ }
108
+
109
+ return { text: output, isFullText: isFullText ? BooleanFlag.True : BooleanFlag.False };
110
+ }
111
+
112
+ function reaction(element: Node): BooleanFlag {
113
+ if (element.nodeType === Node.ELEMENT_NODE) {
114
+ let tag = (element as HTMLElement).tagName.toLowerCase();
115
+ if (UserInputTags.indexOf(tag) >= 0) {
116
+ return BooleanFlag.False;
117
+ }
118
+ }
119
+ return BooleanFlag.True;
120
+ }
121
+
122
+ function layout(element: Element): Box {
123
+ let box: Box = null;
124
+ let de = document.documentElement;
125
+ if (typeof element.getBoundingClientRect === "function") {
126
+ // getBoundingClientRect returns rectangle relative positioning to viewport
127
+ let rect = element.getBoundingClientRect();
128
+
129
+ if (rect && rect.width > 0 && rect.height > 0) {
130
+ // Add viewport's scroll position to rectangle to get position relative to document origin
131
+ // Also: using Math.floor() instead of Math.round() because in Edge,
132
+ // getBoundingClientRect returns partial pixel values (e.g. 162.5px) and Chrome already
133
+ // floors the value (e.g. 162px). This keeps consistent behavior across browsers.
134
+ box = {
135
+ x: Math.floor(rect.left + ("pageXOffset" in window ? window.pageXOffset : de.scrollLeft)),
136
+ y: Math.floor(rect.top + ("pageYOffset" in window ? window.pageYOffset : de.scrollTop)),
137
+ w: Math.floor(rect.width),
138
+ h: Math.floor(rect.height)
139
+ };
140
+ }
141
+ }
142
+ return box;
143
+ }
144
+
145
+ function context(a: HTMLAnchorElement): BrowsingContext {
146
+ if (a && a.hasAttribute(Constant.Target)) {
147
+ switch (a.getAttribute(Constant.Target)) {
148
+ case Constant.Blank: return BrowsingContext.Blank;
149
+ case Constant.Parent: return BrowsingContext.Parent;
150
+ case Constant.Top: return BrowsingContext.Top;
151
+ }
152
+ }
153
+ return BrowsingContext.Self;
154
+ }
155
+
156
+ export function reset(): void {
157
+ state = [];
158
+ }
159
+
160
+ export function stop(): void {
161
+ reset();
162
+ }
@@ -1,34 +1,34 @@
1
- import { Event } from "@clarity-types/data";
2
- import { Clipboard, ClipboardState } from "@clarity-types/interaction";
3
- import { FunctionNames } from "@clarity-types/performance";
4
- import { bind } from "@src/core/event";
5
- import { schedule } from "@src/core/task";
6
- import { time } from "@src/core/time";
7
- import encode from "./encode";
8
- import { target } from "@src/layout/target";
9
-
10
- export let state: ClipboardState[] = [];
11
-
12
- export function start(): void {
13
- reset();
14
- }
15
-
16
- export function observe(root: Node): void {
17
- bind(root, "cut", recompute.bind(this, Clipboard.Cut), true);
18
- bind(root, "copy", recompute.bind(this, Clipboard.Copy), true);
19
- bind(root, "paste", recompute.bind(this, Clipboard.Paste), true);
20
- }
21
-
22
- function recompute(action: Clipboard, evt: UIEvent): void {
23
- recompute.dn = FunctionNames.ClipboardRecompute;
24
- state.push({ time: time(evt), event: Event.Clipboard, data: { target: target(evt), action } });
25
- schedule(encode.bind(this, Event.Clipboard));
26
- }
27
-
28
- export function reset(): void {
29
- state = [];
30
- }
31
-
32
- export function stop(): void {
33
- reset();
34
- }
1
+ import { Event } from "@clarity-types/data";
2
+ import { Clipboard, ClipboardState } from "@clarity-types/interaction";
3
+ import { FunctionNames } from "@clarity-types/performance";
4
+ import { bind } from "@src/core/event";
5
+ import { schedule } from "@src/core/task";
6
+ import { time } from "@src/core/time";
7
+ import encode from "./encode";
8
+ import { target } from "@src/layout/target";
9
+
10
+ export let state: ClipboardState[] = [];
11
+
12
+ export function start(): void {
13
+ reset();
14
+ }
15
+
16
+ export function observe(root: Node): void {
17
+ bind(root, "cut", recompute.bind(this, Clipboard.Cut), true);
18
+ bind(root, "copy", recompute.bind(this, Clipboard.Copy), true);
19
+ bind(root, "paste", recompute.bind(this, Clipboard.Paste), true);
20
+ }
21
+
22
+ function recompute(action: Clipboard, evt: UIEvent): void {
23
+ recompute.dn = FunctionNames.ClipboardRecompute;
24
+ state.push({ time: time(evt), event: Event.Clipboard, data: { target: target(evt), action } });
25
+ schedule(encode.bind(this, Event.Clipboard));
26
+ }
27
+
28
+ export function reset(): void {
29
+ state = [];
30
+ }
31
+
32
+ export function stop(): void {
33
+ reset();
34
+ }