clarity-js 0.8.41 → 0.8.42

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 (113) 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 +6027 -6027
  5. package/build/clarity.min.js +1 -1
  6. package/build/clarity.module.js +6027 -6027
  7. package/build/clarity.performance.js +1 -1
  8. package/package.json +70 -70
  9. package/rollup.config.ts +161 -161
  10. package/src/clarity.ts +65 -65
  11. package/src/core/api.ts +8 -8
  12. package/src/core/config.ts +29 -29
  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 +71 -71
  17. package/src/core/index.ts +81 -81
  18. package/src/core/measure.ts +19 -19
  19. package/src/core/report.ts +28 -28
  20. package/src/core/scrub.ts +202 -202
  21. package/src/core/task.ts +181 -181
  22. package/src/core/throttle.ts +46 -46
  23. package/src/core/time.ts +26 -26
  24. package/src/core/timeout.ts +10 -10
  25. package/src/core/version.ts +2 -2
  26. package/src/data/baseline.ts +162 -162
  27. package/src/data/compress.ts +31 -31
  28. package/src/data/consent.ts +77 -77
  29. package/src/data/custom.ts +23 -23
  30. package/src/data/dimension.ts +53 -53
  31. package/src/data/encode.ts +155 -155
  32. package/src/data/envelope.ts +53 -53
  33. package/src/data/extract.ts +211 -211
  34. package/src/data/index.ts +50 -50
  35. package/src/data/limit.ts +44 -44
  36. package/src/data/metadata.ts +408 -408
  37. package/src/data/metric.ts +51 -51
  38. package/src/data/ping.ts +36 -36
  39. package/src/data/signal.ts +30 -30
  40. package/src/data/summary.ts +34 -34
  41. package/src/data/token.ts +39 -39
  42. package/src/data/upgrade.ts +44 -44
  43. package/src/data/upload.ts +333 -333
  44. package/src/data/variable.ts +83 -83
  45. package/src/diagnostic/encode.ts +40 -40
  46. package/src/diagnostic/fraud.ts +36 -36
  47. package/src/diagnostic/index.ts +13 -13
  48. package/src/diagnostic/internal.ts +28 -28
  49. package/src/diagnostic/script.ts +35 -35
  50. package/src/dynamic/agent/blank.ts +2 -2
  51. package/src/dynamic/agent/crisp.ts +40 -40
  52. package/src/dynamic/agent/encode.ts +25 -25
  53. package/src/dynamic/agent/index.ts +8 -8
  54. package/src/dynamic/agent/livechat.ts +58 -58
  55. package/src/dynamic/agent/tidio.ts +44 -44
  56. package/src/global.ts +6 -6
  57. package/src/index.ts +9 -9
  58. package/src/insight/blank.ts +14 -14
  59. package/src/insight/encode.ts +60 -60
  60. package/src/insight/snapshot.ts +114 -114
  61. package/src/interaction/change.ts +38 -38
  62. package/src/interaction/click.ts +173 -173
  63. package/src/interaction/clipboard.ts +32 -32
  64. package/src/interaction/encode.ts +210 -210
  65. package/src/interaction/index.ts +60 -60
  66. package/src/interaction/input.ts +57 -57
  67. package/src/interaction/pointer.ts +137 -137
  68. package/src/interaction/resize.ts +50 -50
  69. package/src/interaction/scroll.ts +129 -129
  70. package/src/interaction/selection.ts +66 -66
  71. package/src/interaction/submit.ts +30 -30
  72. package/src/interaction/timeline.ts +69 -69
  73. package/src/interaction/unload.ts +26 -26
  74. package/src/interaction/visibility.ts +27 -27
  75. package/src/layout/animation.ts +133 -133
  76. package/src/layout/custom.ts +42 -42
  77. package/src/layout/discover.ts +31 -31
  78. package/src/layout/document.ts +46 -46
  79. package/src/layout/dom.ts +439 -439
  80. package/src/layout/encode.ts +154 -154
  81. package/src/layout/index.ts +42 -42
  82. package/src/layout/mutation.ts +411 -411
  83. package/src/layout/node.ts +294 -294
  84. package/src/layout/offset.ts +19 -19
  85. package/src/layout/region.ts +151 -151
  86. package/src/layout/schema.ts +63 -63
  87. package/src/layout/selector.ts +82 -82
  88. package/src/layout/style.ts +159 -159
  89. package/src/layout/target.ts +32 -32
  90. package/src/layout/traverse.ts +27 -27
  91. package/src/performance/blank.ts +9 -9
  92. package/src/performance/encode.ts +31 -31
  93. package/src/performance/index.ts +12 -12
  94. package/src/performance/interaction.ts +125 -125
  95. package/src/performance/navigation.ts +31 -31
  96. package/src/performance/observer.ts +112 -112
  97. package/src/queue.ts +33 -33
  98. package/test/core.test.ts +139 -139
  99. package/test/helper.ts +162 -162
  100. package/test/html/core.html +27 -27
  101. package/test/stub.test.ts +7 -7
  102. package/test/tsconfig.test.json +5 -5
  103. package/tsconfig.json +21 -21
  104. package/tslint.json +32 -32
  105. package/types/agent.d.ts +39 -39
  106. package/types/core.d.ts +150 -150
  107. package/types/data.d.ts +571 -571
  108. package/types/diagnostic.d.ts +24 -24
  109. package/types/global.d.ts +30 -30
  110. package/types/index.d.ts +40 -40
  111. package/types/interaction.d.ts +177 -177
  112. package/types/layout.d.ts +276 -276
  113. package/types/performance.d.ts +31 -31
@@ -1,24 +1,24 @@
1
- import { Code, Severity, Target } from "./data";
2
-
3
- /* Event Data */
4
- export interface ScriptErrorData {
5
- source: string;
6
- message: string;
7
- line: number;
8
- column: number;
9
- stack: string;
10
- }
11
-
12
- export interface LogData {
13
- code: Code;
14
- name: string;
15
- message: string;
16
- stack: string;
17
- severity: Severity;
18
- }
19
-
20
- export interface FraudData {
21
- id: number;
22
- target: number;
23
- checksum: string;
24
- }
1
+ import { Code, Severity, Target } from "./data";
2
+
3
+ /* Event Data */
4
+ export interface ScriptErrorData {
5
+ source: string;
6
+ message: string;
7
+ line: number;
8
+ column: number;
9
+ stack: string;
10
+ }
11
+
12
+ export interface LogData {
13
+ code: Code;
14
+ name: string;
15
+ message: string;
16
+ stack: string;
17
+ severity: Severity;
18
+ }
19
+
20
+ export interface FraudData {
21
+ id: number;
22
+ target: number;
23
+ checksum: string;
24
+ }
package/types/global.d.ts CHANGED
@@ -1,30 +1,30 @@
1
- declare global {
2
- interface Window {
3
- clarityOverrides?: { [key: string]: ((...args: any[]) => any) | undefined };
4
- google_tag_data?: {
5
- ics: {
6
- addListener: (keys: string[], callback: () => void) => void;
7
- getConsentState: (key: string) => any;
8
- usedUpdate: boolean;
9
- };
10
- };
11
- LiveChatWidget?: {
12
- off(eventName: string, callback: (data: any) => void): unknown;
13
- on: (eventName: string, callback: (data: any) => void) => void;
14
- };
15
- tidioChatApi?: {
16
- on: (eventName: string, callback: (data: any) => void) => void;
17
- };
18
- $crisp?: {
19
- push: (
20
- args: [action: string, eventName: string, callback: (data: any) => void]
21
- ) => void;
22
- };
23
- }
24
-
25
- interface Function {
26
- dn?: number;
27
- }
28
- }
29
-
30
- export {};
1
+ declare global {
2
+ interface Window {
3
+ clarityOverrides?: { [key: string]: ((...args: any[]) => any) | undefined };
4
+ google_tag_data?: {
5
+ ics: {
6
+ addListener: (keys: string[], callback: () => void) => void;
7
+ getConsentState: (key: string) => any;
8
+ usedUpdate: boolean;
9
+ };
10
+ };
11
+ LiveChatWidget?: {
12
+ off(eventName: string, callback: (data: any) => void): unknown;
13
+ on: (eventName: string, callback: (data: any) => void) => void;
14
+ };
15
+ tidioChatApi?: {
16
+ on: (eventName: string, callback: (data: any) => void) => void;
17
+ };
18
+ $crisp?: {
19
+ push: (
20
+ args: [action: string, eventName: string, callback: (data: any) => void]
21
+ ) => void;
22
+ };
23
+ }
24
+
25
+ interface Function {
26
+ dn?: number;
27
+ }
28
+ }
29
+
30
+ export {};
package/types/index.d.ts CHANGED
@@ -1,40 +1,40 @@
1
- import * as Core from "./core";
2
- import * as Data from "./data";
3
- import * as Diagnostic from "./diagnostic";
4
- import * as Layout from "./layout";
5
- import * as Interaction from "./interaction";
6
- import * as Performance from "./performance";
7
-
8
- interface Clarity {
9
- start: (config?: Core.Config) => void;
10
- stop: () => void;
11
- pause: () => void;
12
- resume: () => void;
13
- upgrade: (key: string) => void;
14
- consent: () => void;
15
- consentv2: () => void;
16
- event: (name: string, value: string) => void;
17
- set: (variable: string, value: string | string[]) => void;
18
- identify: (userId: string, sessionId?: string, pageId?: string, userHint?: string) => void;
19
- metadata: (callback: Data.MetadataCallback, wait?: boolean) => void;
20
- signal: (callback: Data.SignalCallback) => void;
21
- }
22
-
23
- interface Selector {
24
- get: (input: Layout.SelectorInput, type: Layout.Selector) => string;
25
- reset: () => void;
26
- }
27
-
28
- interface Helper {
29
- get: (node: Node) => Layout.NodeValue;
30
- getNode: (id: number) => Node;
31
- hash: (input: string) => string;
32
- lookup: (hash: string) => number;
33
- selector: Selector;
34
- }
35
-
36
- declare const clarity: Clarity;
37
- declare const helper: Helper;
38
- declare const version: string;
39
-
40
- export { clarity, version, helper, Core, Data, Diagnostic, Layout, Interaction, Performance };
1
+ import * as Core from "./core";
2
+ import * as Data from "./data";
3
+ import * as Diagnostic from "./diagnostic";
4
+ import * as Layout from "./layout";
5
+ import * as Interaction from "./interaction";
6
+ import * as Performance from "./performance";
7
+
8
+ interface Clarity {
9
+ start: (config?: Core.Config) => void;
10
+ stop: () => void;
11
+ pause: () => void;
12
+ resume: () => void;
13
+ upgrade: (key: string) => void;
14
+ consent: () => void;
15
+ consentv2: () => void;
16
+ event: (name: string, value: string) => void;
17
+ set: (variable: string, value: string | string[]) => void;
18
+ identify: (userId: string, sessionId?: string, pageId?: string, userHint?: string) => void;
19
+ metadata: (callback: Data.MetadataCallback, wait?: boolean) => void;
20
+ signal: (callback: Data.SignalCallback) => void;
21
+ }
22
+
23
+ interface Selector {
24
+ get: (input: Layout.SelectorInput, type: Layout.Selector) => string;
25
+ reset: () => void;
26
+ }
27
+
28
+ interface Helper {
29
+ get: (node: Node) => Layout.NodeValue;
30
+ getNode: (id: number) => Node;
31
+ hash: (input: string) => string;
32
+ lookup: (hash: string) => number;
33
+ selector: Selector;
34
+ }
35
+
36
+ declare const clarity: Clarity;
37
+ declare const helper: Helper;
38
+ declare const version: string;
39
+
40
+ export { clarity, version, helper, Core, Data, Diagnostic, Layout, Interaction, Performance };
@@ -1,177 +1,177 @@
1
- import { BooleanFlag } from "@clarity-types/data";
2
- import { Time } from "./core";
3
- import { Event, Target } from "./data";
4
-
5
- /* Enum */
6
-
7
- export const enum BrowsingContext {
8
- Self = 0,
9
- Blank = 1,
10
- Parent = 2,
11
- Top = 3
12
- }
13
-
14
- export const enum Setting {
15
- LookAhead = 500, // 500ms
16
- InputLookAhead = 1000, // 1s
17
- Distance = 20, // 20 pixels
18
- ScrollInterval = 50, // 25 milliseconds
19
- PointerInterval = 25, // 25 milliseconds
20
- Throttle = 25, // 25 milliseconds
21
- TimelineSpan = 2 * Time.Second, // 2 seconds
22
- }
23
-
24
- export const enum Clipboard {
25
- Cut = 0,
26
- Copy = 1,
27
- Paste = 2
28
- }
29
-
30
- /* Helper Interfaces */
31
- export interface PointerState {
32
- time: number;
33
- event: number;
34
- data: PointerData;
35
- }
36
-
37
- export interface ClickState {
38
- time: number;
39
- event: number;
40
- data: ClickData;
41
- }
42
-
43
- export interface ClipboardState {
44
- time: number;
45
- event: number;
46
- data: ClipboardData;
47
- }
48
-
49
- export interface ScrollState {
50
- time: number;
51
- event: number;
52
- data: ScrollData;
53
- }
54
-
55
- export interface SubmitState {
56
- time: number;
57
- event: number;
58
- data: SubmitData;
59
- }
60
-
61
- export interface ChangeState {
62
- time: number;
63
- event: number;
64
- data: ChangeData;
65
- }
66
-
67
- export interface InputState {
68
- time: number;
69
- event: number;
70
- data: InputData;
71
- }
72
-
73
- export interface TimelineState {
74
- time: number;
75
- event: number;
76
- data: TimelineData;
77
- }
78
-
79
- /* Event Data */
80
- export interface TimelineData {
81
- type: Event;
82
- hash: string;
83
- x: number;
84
- y: number;
85
- reaction: number;
86
- context: number;
87
- }
88
-
89
- export interface ChangeData {
90
- target: Target;
91
- type: string;
92
- value: string;
93
- checksum: string;
94
- }
95
-
96
- export interface InputData {
97
- target: Target;
98
- value: string;
99
- type?: string;
100
- trust: BooleanFlag;
101
- }
102
-
103
- export interface SubmitData {
104
- target: Target;
105
- }
106
-
107
- export interface PointerData {
108
- target: Target;
109
- x: number;
110
- y: number;
111
- id?: number;
112
- isPrimary?: boolean;
113
- }
114
-
115
- export interface ClickData {
116
- target: Target;
117
- x: number;
118
- y: number;
119
- eX: number;
120
- eY: number;
121
- button: number;
122
- reaction: number;
123
- context: BrowsingContext;
124
- text: string;
125
- link: string;
126
- hash: string;
127
- trust: number;
128
- isFullText: BooleanFlag;
129
- w: number;
130
- h: number;
131
- tag: string;
132
- class: string;
133
- id: string;
134
- }
135
-
136
- export interface TextInfo {
137
- text: string;
138
- isFullText: BooleanFlag;
139
- }
140
-
141
- export interface ClipboardData {
142
- target: Target;
143
- action: Clipboard;
144
- }
145
-
146
- export interface ResizeData {
147
- width: number;
148
- height: number;
149
- }
150
-
151
- export interface ScrollData {
152
- target: Target;
153
- x: number;
154
- y: number;
155
- top: Node | string;
156
- bottom: Node | string;
157
- }
158
-
159
- export interface SelectionData {
160
- start: Target;
161
- startOffset: number;
162
- end: Target;
163
- endOffset: number;
164
- }
165
-
166
- export interface UnloadData {
167
- name: string;
168
- persisted: BooleanFlag;
169
- }
170
-
171
- export interface VisibilityData {
172
- visible: BooleanFlag;
173
- }
174
-
175
- export interface FocusData {
176
- focused: BooleanFlag;
177
- }
1
+ import { BooleanFlag } from "@clarity-types/data";
2
+ import { Time } from "./core";
3
+ import { Event, Target } from "./data";
4
+
5
+ /* Enum */
6
+
7
+ export const enum BrowsingContext {
8
+ Self = 0,
9
+ Blank = 1,
10
+ Parent = 2,
11
+ Top = 3
12
+ }
13
+
14
+ export const enum Setting {
15
+ LookAhead = 500, // 500ms
16
+ InputLookAhead = 1000, // 1s
17
+ Distance = 20, // 20 pixels
18
+ ScrollInterval = 50, // 25 milliseconds
19
+ PointerInterval = 25, // 25 milliseconds
20
+ Throttle = 25, // 25 milliseconds
21
+ TimelineSpan = 2 * Time.Second, // 2 seconds
22
+ }
23
+
24
+ export const enum Clipboard {
25
+ Cut = 0,
26
+ Copy = 1,
27
+ Paste = 2
28
+ }
29
+
30
+ /* Helper Interfaces */
31
+ export interface PointerState {
32
+ time: number;
33
+ event: number;
34
+ data: PointerData;
35
+ }
36
+
37
+ export interface ClickState {
38
+ time: number;
39
+ event: number;
40
+ data: ClickData;
41
+ }
42
+
43
+ export interface ClipboardState {
44
+ time: number;
45
+ event: number;
46
+ data: ClipboardData;
47
+ }
48
+
49
+ export interface ScrollState {
50
+ time: number;
51
+ event: number;
52
+ data: ScrollData;
53
+ }
54
+
55
+ export interface SubmitState {
56
+ time: number;
57
+ event: number;
58
+ data: SubmitData;
59
+ }
60
+
61
+ export interface ChangeState {
62
+ time: number;
63
+ event: number;
64
+ data: ChangeData;
65
+ }
66
+
67
+ export interface InputState {
68
+ time: number;
69
+ event: number;
70
+ data: InputData;
71
+ }
72
+
73
+ export interface TimelineState {
74
+ time: number;
75
+ event: number;
76
+ data: TimelineData;
77
+ }
78
+
79
+ /* Event Data */
80
+ export interface TimelineData {
81
+ type: Event;
82
+ hash: string;
83
+ x: number;
84
+ y: number;
85
+ reaction: number;
86
+ context: number;
87
+ }
88
+
89
+ export interface ChangeData {
90
+ target: Target;
91
+ type: string;
92
+ value: string;
93
+ checksum: string;
94
+ }
95
+
96
+ export interface InputData {
97
+ target: Target;
98
+ value: string;
99
+ type?: string;
100
+ trust: BooleanFlag;
101
+ }
102
+
103
+ export interface SubmitData {
104
+ target: Target;
105
+ }
106
+
107
+ export interface PointerData {
108
+ target: Target;
109
+ x: number;
110
+ y: number;
111
+ id?: number;
112
+ isPrimary?: boolean;
113
+ }
114
+
115
+ export interface ClickData {
116
+ target: Target;
117
+ x: number;
118
+ y: number;
119
+ eX: number;
120
+ eY: number;
121
+ button: number;
122
+ reaction: number;
123
+ context: BrowsingContext;
124
+ text: string;
125
+ link: string;
126
+ hash: string;
127
+ trust: number;
128
+ isFullText: BooleanFlag;
129
+ w: number;
130
+ h: number;
131
+ tag: string;
132
+ class: string;
133
+ id: string;
134
+ }
135
+
136
+ export interface TextInfo {
137
+ text: string;
138
+ isFullText: BooleanFlag;
139
+ }
140
+
141
+ export interface ClipboardData {
142
+ target: Target;
143
+ action: Clipboard;
144
+ }
145
+
146
+ export interface ResizeData {
147
+ width: number;
148
+ height: number;
149
+ }
150
+
151
+ export interface ScrollData {
152
+ target: Target;
153
+ x: number;
154
+ y: number;
155
+ top: Node | string;
156
+ bottom: Node | string;
157
+ }
158
+
159
+ export interface SelectionData {
160
+ start: Target;
161
+ startOffset: number;
162
+ end: Target;
163
+ endOffset: number;
164
+ }
165
+
166
+ export interface UnloadData {
167
+ name: string;
168
+ persisted: BooleanFlag;
169
+ }
170
+
171
+ export interface VisibilityData {
172
+ visible: BooleanFlag;
173
+ }
174
+
175
+ export interface FocusData {
176
+ focused: BooleanFlag;
177
+ }