@gem-sdk/clarity-decode 0.8.94
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/CHANGELOG.md +9 -0
- package/README.md +1 -0
- package/build/clarity.decode.js +807 -0
- package/build/clarity.decode.min.js +1 -0
- package/build/clarity.decode.module.js +805 -0
- package/package.json +45 -0
- package/rollup.config.ts +32 -0
- package/src/clarity.ts +233 -0
- package/src/data.ts +126 -0
- package/src/diagnostic.ts +35 -0
- package/src/global.ts +9 -0
- package/src/index.ts +1 -0
- package/src/interaction.ts +118 -0
- package/src/layout.ts +186 -0
- package/src/performance.ts +30 -0
- package/test/decode.test.ts +62 -0
- package/tsconfig.json +12 -0
- package/tslint.json +33 -0
- package/types/core.d.ts +8 -0
- package/types/data.d.ts +94 -0
- package/types/diagnostic.d.ts +10 -0
- package/types/index.d.ts +10 -0
- package/types/interaction.d.ts +46 -0
- package/types/layout.d.ts +36 -0
- package/types/performance.d.ts +7 -0
package/package.json
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@gem-sdk/clarity-decode",
|
|
3
|
+
"version": "0.8.94",
|
|
4
|
+
"description": "Decode clarity data",
|
|
5
|
+
"author": "Microsoft Corp.",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"main": "build/clarity.decode.js",
|
|
8
|
+
"module": "build/clarity.decode.module.js",
|
|
9
|
+
"unpkg": "build/clarity.decode.min.js",
|
|
10
|
+
"types": "types/index.d.ts",
|
|
11
|
+
"keywords": [],
|
|
12
|
+
"dependencies": {
|
|
13
|
+
"@gem-sdk/clarity-js": "^0.8.94"
|
|
14
|
+
},
|
|
15
|
+
"devDependencies": {
|
|
16
|
+
"@rollup/plugin-commonjs": "^24.0.0",
|
|
17
|
+
"@rollup/plugin-node-resolve": "^15.0.0",
|
|
18
|
+
"@rollup/plugin-terser": "^0.4.0",
|
|
19
|
+
"@rollup/plugin-typescript": "^11.0.0",
|
|
20
|
+
"del-cli": "^5.0.0",
|
|
21
|
+
"husky": "^8.0.0",
|
|
22
|
+
"lint-staged": "^13.1.0",
|
|
23
|
+
"rollup": "^3.0.0",
|
|
24
|
+
"tslint": "^6.1.3",
|
|
25
|
+
"typescript": "^4.3.5"
|
|
26
|
+
},
|
|
27
|
+
"scripts": {
|
|
28
|
+
"build": "yarn build:clean && yarn build:main",
|
|
29
|
+
"build:main": "rollup -c rollup.config.ts --configPlugin @rollup/plugin-typescript",
|
|
30
|
+
"build:clean": "del-cli build/*",
|
|
31
|
+
"test": "playwright test --config ../../playwright.config.ts --project=clarity-decode",
|
|
32
|
+
"tslint": "tslint --project ./",
|
|
33
|
+
"tslint:fix": "tslint --fix --project ./ --force"
|
|
34
|
+
},
|
|
35
|
+
"husky": {
|
|
36
|
+
"hooks": {
|
|
37
|
+
"pre-commit": "lint-staged"
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"lint-staged": {
|
|
41
|
+
"*.ts": [
|
|
42
|
+
"tslint --format codeFrame"
|
|
43
|
+
]
|
|
44
|
+
}
|
|
45
|
+
}
|
package/rollup.config.ts
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import commonjs from "@rollup/plugin-commonjs";
|
|
2
|
+
import resolve from "@rollup/plugin-node-resolve";
|
|
3
|
+
import terser from "@rollup/plugin-terser";
|
|
4
|
+
import typescript from "@rollup/plugin-typescript";
|
|
5
|
+
import { readFileSync } from "fs";
|
|
6
|
+
|
|
7
|
+
const pkg = JSON.parse(readFileSync("./package.json", "utf-8"));
|
|
8
|
+
|
|
9
|
+
export default [
|
|
10
|
+
{
|
|
11
|
+
input: "src/index.ts",
|
|
12
|
+
output: [
|
|
13
|
+
{ file: pkg.main, format: "cjs", exports: "named" },
|
|
14
|
+
{ file: pkg.module, format: "es", exports: "named" }
|
|
15
|
+
],
|
|
16
|
+
plugins: [
|
|
17
|
+
resolve(),
|
|
18
|
+
typescript(),
|
|
19
|
+
commonjs({ include: ["node_modules/**"] })
|
|
20
|
+
]
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
input: "src/global.ts",
|
|
24
|
+
output: [ { file: pkg.unpkg, format: "iife", exports: "named" } ],
|
|
25
|
+
plugins: [
|
|
26
|
+
resolve(),
|
|
27
|
+
typescript(),
|
|
28
|
+
terser({output: {comments: false}}),
|
|
29
|
+
commonjs({ include: ["node_modules/**"] })
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
];
|
package/src/clarity.ts
ADDED
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import { Data, version } from "@gem-sdk/clarity-js";
|
|
2
|
+
import { BaselineEvent, CustomEvent, DecodedPayload, DecodedVersion, DimensionEvent } from "../types/data";
|
|
3
|
+
import { LimitEvent, MetricEvent, PingEvent, SummaryEvent, UpgradeEvent, UploadEvent, VariableEvent, ExtractEvent, ConsentEvent } from "../types/data";
|
|
4
|
+
import { FraudEvent, LogEvent, ScriptErrorEvent } from "../types/diagnostic";
|
|
5
|
+
import { ChangeEvent, ClickEvent, ContextMenuEvent, ClipboardEvent, InputEvent, PointerEvent, ResizeEvent, ScrollEvent } from "../types/interaction";
|
|
6
|
+
import { SelectionEvent, SubmitEvent, TimelineEvent, UnloadEvent, VisibilityEvent, FocusEvent } from "../types/interaction";
|
|
7
|
+
import { CustomElementEvent, DocumentEvent, DomEvent, RegionEvent } from "../types/layout";
|
|
8
|
+
import { NavigationEvent } from "../types/performance";
|
|
9
|
+
|
|
10
|
+
import * as data from "./data";
|
|
11
|
+
import * as diagnostic from "./diagnostic";
|
|
12
|
+
import * as interaction from "./interaction";
|
|
13
|
+
import * as layout from "./layout";
|
|
14
|
+
import * as performance from "./performance";
|
|
15
|
+
|
|
16
|
+
export function decode(input: string): DecodedPayload {
|
|
17
|
+
let json: Data.Payload = JSON.parse(input);
|
|
18
|
+
let envelope = data.envelope(json.e);
|
|
19
|
+
let timestamp = Date.now();
|
|
20
|
+
let payload: DecodedPayload = { timestamp, envelope };
|
|
21
|
+
|
|
22
|
+
// Sort encoded events by time to simplify summary computation
|
|
23
|
+
// It's possible for individual events to be out of order, dependent on how they are buffered on the client
|
|
24
|
+
// E.g. scroll events are queued internally before they are sent over the wire.
|
|
25
|
+
// By comparison, events like resize & click are sent out immediately.
|
|
26
|
+
let encoded: Data.Token[][] = json.p ? json.a.concat(json.p) : json.a;
|
|
27
|
+
encoded = encoded.sort((a: Data.Token[], b: Data.Token[]): number => (a[0] as number) - (b[0] as number));
|
|
28
|
+
|
|
29
|
+
// Check if the incoming version is compatible with the current running code
|
|
30
|
+
// We do an exact match for the major version and minor version.
|
|
31
|
+
// For patch, we are backward and forward compatible with up to version change.
|
|
32
|
+
let jsonVersion = parseVersion(payload.envelope.version);
|
|
33
|
+
let codeVersion = parseVersion(version);
|
|
34
|
+
|
|
35
|
+
if (jsonVersion.major !== codeVersion.major ||
|
|
36
|
+
Math.abs(jsonVersion.minor - codeVersion.minor) > 1) {
|
|
37
|
+
console.warn(`Invalid version. Actual: ${payload.envelope.version} | Expected: ${version} (+/- 1) | ${input.substr(0, 250)}`);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
for (let entry of encoded) {
|
|
41
|
+
switch (entry[1]) {
|
|
42
|
+
case Data.Event.Baseline:
|
|
43
|
+
if (payload.baseline === undefined) { payload.baseline = []; }
|
|
44
|
+
payload.baseline.push(data.decode(entry) as BaselineEvent);
|
|
45
|
+
break;
|
|
46
|
+
case Data.Event.Ping:
|
|
47
|
+
if (payload.ping === undefined) { payload.ping = []; }
|
|
48
|
+
payload.ping.push(data.decode(entry) as PingEvent);
|
|
49
|
+
break;
|
|
50
|
+
case Data.Event.Limit:
|
|
51
|
+
if (payload.limit === undefined) { payload.limit = []; }
|
|
52
|
+
payload.limit.push(data.decode(entry) as LimitEvent);
|
|
53
|
+
break;
|
|
54
|
+
case Data.Event.Upgrade:
|
|
55
|
+
if (payload.upgrade === undefined) { payload.upgrade = []; }
|
|
56
|
+
payload.upgrade.push(data.decode(entry) as UpgradeEvent);
|
|
57
|
+
break;
|
|
58
|
+
case Data.Event.Metric:
|
|
59
|
+
if (payload.metric === undefined) { payload.metric = []; }
|
|
60
|
+
let metric = data.decode(entry) as MetricEvent;
|
|
61
|
+
// It's not possible to accurately include the byte count of the payload within the same payload
|
|
62
|
+
// The value we get from clarity-js lags behind by a payload. To work around that,
|
|
63
|
+
// we increment the bytes from the incoming payload at decode time.
|
|
64
|
+
metric.data[Data.Metric.TotalBytes] = input.length;
|
|
65
|
+
payload.metric.push(metric);
|
|
66
|
+
break;
|
|
67
|
+
case Data.Event.Dimension:
|
|
68
|
+
if (payload.dimension === undefined) { payload.dimension = []; }
|
|
69
|
+
payload.dimension.push(data.decode(entry) as DimensionEvent);
|
|
70
|
+
break;
|
|
71
|
+
case Data.Event.Summary:
|
|
72
|
+
if (payload.summary === undefined) { payload.summary = []; }
|
|
73
|
+
payload.summary.push(data.decode(entry) as SummaryEvent);
|
|
74
|
+
break;
|
|
75
|
+
case Data.Event.Custom:
|
|
76
|
+
if (payload.custom === undefined) { payload.custom = []; }
|
|
77
|
+
payload.custom.push(data.decode(entry) as CustomEvent);
|
|
78
|
+
break;
|
|
79
|
+
case Data.Event.Variable:
|
|
80
|
+
if (payload.variable === undefined) { payload.variable = []; }
|
|
81
|
+
payload.variable.push(data.decode(entry) as VariableEvent);
|
|
82
|
+
break;
|
|
83
|
+
case Data.Event.Upload:
|
|
84
|
+
if (payload.upload === undefined) { payload.upload = []; }
|
|
85
|
+
payload.upload.push(data.decode(entry) as UploadEvent);
|
|
86
|
+
break;
|
|
87
|
+
case Data.Event.MouseDown:
|
|
88
|
+
case Data.Event.MouseUp:
|
|
89
|
+
case Data.Event.MouseMove:
|
|
90
|
+
case Data.Event.MouseWheel:
|
|
91
|
+
case Data.Event.DoubleClick:
|
|
92
|
+
case Data.Event.TouchStart:
|
|
93
|
+
case Data.Event.TouchCancel:
|
|
94
|
+
case Data.Event.TouchEnd:
|
|
95
|
+
case Data.Event.TouchMove:
|
|
96
|
+
if (payload.pointer === undefined) { payload.pointer = []; }
|
|
97
|
+
payload.pointer.push(interaction.decode(entry) as PointerEvent);
|
|
98
|
+
break;
|
|
99
|
+
case Data.Event.Click:
|
|
100
|
+
if (payload.click === undefined) { payload.click = []; }
|
|
101
|
+
let clickEntry = interaction.decode(entry) as ClickEvent;
|
|
102
|
+
payload.click.push(clickEntry);
|
|
103
|
+
break;
|
|
104
|
+
case Data.Event.ContextMenu:
|
|
105
|
+
if (payload.contextMenu === undefined) { payload.contextMenu = []; }
|
|
106
|
+
let contextMenuEntry = interaction.decode(entry) as ContextMenuEvent;
|
|
107
|
+
payload.contextMenu.push(contextMenuEntry);
|
|
108
|
+
break;
|
|
109
|
+
case Data.Event.Clipboard:
|
|
110
|
+
if (payload.clipboard === undefined) { payload.clipboard = []; }
|
|
111
|
+
let clipEntry = interaction.decode(entry) as ClipboardEvent;
|
|
112
|
+
payload.clipboard.push(clipEntry);
|
|
113
|
+
break;
|
|
114
|
+
case Data.Event.Scroll:
|
|
115
|
+
if (payload.scroll === undefined) { payload.scroll = []; }
|
|
116
|
+
payload.scroll.push(interaction.decode(entry) as ScrollEvent);
|
|
117
|
+
break;
|
|
118
|
+
case Data.Event.Resize:
|
|
119
|
+
if (payload.resize === undefined) { payload.resize = []; }
|
|
120
|
+
payload.resize.push(interaction.decode(entry) as ResizeEvent);
|
|
121
|
+
break;
|
|
122
|
+
case Data.Event.Selection:
|
|
123
|
+
if (payload.selection === undefined) { payload.selection = []; }
|
|
124
|
+
payload.selection.push(interaction.decode(entry) as SelectionEvent);
|
|
125
|
+
break;
|
|
126
|
+
case Data.Event.Change:
|
|
127
|
+
if (payload.change === undefined) { payload.change = []; }
|
|
128
|
+
let changeEntry = interaction.decode(entry) as ChangeEvent;
|
|
129
|
+
payload.change.push(changeEntry);
|
|
130
|
+
break;
|
|
131
|
+
case Data.Event.Submit:
|
|
132
|
+
if (payload.submit === undefined) { payload.submit = []; }
|
|
133
|
+
let submitEntry = interaction.decode(entry) as SubmitEvent;
|
|
134
|
+
payload.submit.push(submitEntry);
|
|
135
|
+
break;
|
|
136
|
+
case Data.Event.Timeline:
|
|
137
|
+
if (payload.timeline === undefined) { payload.timeline = []; }
|
|
138
|
+
payload.timeline.push(interaction.decode(entry) as TimelineEvent);
|
|
139
|
+
break;
|
|
140
|
+
case Data.Event.Input:
|
|
141
|
+
if (payload.input === undefined) { payload.input = []; }
|
|
142
|
+
payload.input.push(interaction.decode(entry) as InputEvent);
|
|
143
|
+
break;
|
|
144
|
+
case Data.Event.Unload:
|
|
145
|
+
if (payload.unload === undefined) { payload.unload = []; }
|
|
146
|
+
payload.unload.push(interaction.decode(entry) as UnloadEvent);
|
|
147
|
+
break;
|
|
148
|
+
case Data.Event.Visibility:
|
|
149
|
+
if (payload.visibility === undefined) { payload.visibility = []; }
|
|
150
|
+
payload.visibility.push(interaction.decode(entry) as VisibilityEvent);
|
|
151
|
+
break;
|
|
152
|
+
case Data.Event.Focus:
|
|
153
|
+
if (payload.focus === undefined) { payload.focus = []; }
|
|
154
|
+
payload.focus.push(interaction.decode(entry) as FocusEvent);
|
|
155
|
+
break;
|
|
156
|
+
case Data.Event.Box:
|
|
157
|
+
/* Deprecated - Intentionally, no-op. For backward compatibility. */
|
|
158
|
+
break;
|
|
159
|
+
case Data.Event.Region:
|
|
160
|
+
if (payload.region === undefined) { payload.region = []; }
|
|
161
|
+
payload.region.push(layout.decode(entry) as RegionEvent);
|
|
162
|
+
break;
|
|
163
|
+
case Data.Event.Discover:
|
|
164
|
+
case Data.Event.Mutation:
|
|
165
|
+
case Data.Event.Snapshot:
|
|
166
|
+
case Data.Event.StyleSheetAdoption:
|
|
167
|
+
case Data.Event.StyleSheetUpdate:
|
|
168
|
+
case Data.Event.Animation:
|
|
169
|
+
if (payload.dom === undefined) { payload.dom = []; }
|
|
170
|
+
payload.dom.push(layout.decode(entry) as DomEvent);
|
|
171
|
+
break;
|
|
172
|
+
case Data.Event.Document:
|
|
173
|
+
if (payload.doc === undefined) { payload.doc = []; }
|
|
174
|
+
payload.doc.push(layout.decode(entry) as DocumentEvent);
|
|
175
|
+
break;
|
|
176
|
+
case Data.Event.ScriptError:
|
|
177
|
+
if (payload.script === undefined) { payload.script = []; }
|
|
178
|
+
payload.script.push(diagnostic.decode(entry) as ScriptErrorEvent);
|
|
179
|
+
break;
|
|
180
|
+
case Data.Event.Log:
|
|
181
|
+
if (payload.log === undefined) { payload.log = []; }
|
|
182
|
+
payload.log.push(diagnostic.decode(entry) as LogEvent);
|
|
183
|
+
break;
|
|
184
|
+
case Data.Event.Fraud:
|
|
185
|
+
if (payload.fraud === undefined) { payload.fraud = []; }
|
|
186
|
+
payload.fraud.push(diagnostic.decode(entry) as FraudEvent);
|
|
187
|
+
break;
|
|
188
|
+
case Data.Event.Navigation:
|
|
189
|
+
if (payload.navigation === undefined) { payload.navigation = []; }
|
|
190
|
+
payload.navigation.push(performance.decode(entry) as NavigationEvent);
|
|
191
|
+
break;
|
|
192
|
+
case Data.Event.Connection:
|
|
193
|
+
case Data.Event.ImageError:
|
|
194
|
+
/* Deprecated - Intentionally, no-op. For backward compatibility. */
|
|
195
|
+
break;
|
|
196
|
+
case Data.Event.Extract:
|
|
197
|
+
if (payload.extract === undefined) { payload.extract = []; }
|
|
198
|
+
payload.extract.push(data.decode(entry) as ExtractEvent);
|
|
199
|
+
break;
|
|
200
|
+
case Data.Event.Consent:
|
|
201
|
+
if (payload.consent === undefined) { payload.consent = []; }
|
|
202
|
+
payload.consent.push(data.decode(entry) as ConsentEvent);
|
|
203
|
+
break;
|
|
204
|
+
case Data.Event.CustomElement:
|
|
205
|
+
if (payload.customElement === undefined) { payload.customElement = []; }
|
|
206
|
+
payload.customElement.push(layout.decode(entry) as CustomElementEvent);
|
|
207
|
+
break;
|
|
208
|
+
default:
|
|
209
|
+
if (typeof entry[1] === "number" && entry[1] < 200) {
|
|
210
|
+
console.error(`No handler for Event: ${JSON.stringify(entry)}`);
|
|
211
|
+
}
|
|
212
|
+
break;
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
return payload;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
function parseVersion(ver: string): DecodedVersion {
|
|
221
|
+
let output: DecodedVersion = { major: 0, minor: 0, patch: 0, beta: 0 };
|
|
222
|
+
let parts = ver.split(".");
|
|
223
|
+
if (parts.length === 3) {
|
|
224
|
+
let subparts = parts[2].split("-b");
|
|
225
|
+
output.major = parseInt(parts[0], 10);
|
|
226
|
+
output.minor = parseInt(parts[1], 10);
|
|
227
|
+
if (subparts.length === 2) {
|
|
228
|
+
output.patch = parseInt(subparts[0], 10);
|
|
229
|
+
output.beta = parseInt(subparts[1], 10);
|
|
230
|
+
} else { output.patch = parseInt(parts[2], 10); }
|
|
231
|
+
}
|
|
232
|
+
return output;
|
|
233
|
+
}
|
package/src/data.ts
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { Data } from "@gem-sdk/clarity-js";
|
|
2
|
+
import { Constant, DataEvent } from "../types/data";
|
|
3
|
+
|
|
4
|
+
export function decode(tokens: Data.Token[]): DataEvent {
|
|
5
|
+
let time = tokens[0] as number;
|
|
6
|
+
let event = tokens[1] as Data.Event;
|
|
7
|
+
switch (event) {
|
|
8
|
+
case Data.Event.Ping:
|
|
9
|
+
let ping: Data.PingData = { gap: tokens[2] as number };
|
|
10
|
+
return { time, event, data: ping };
|
|
11
|
+
case Data.Event.Limit:
|
|
12
|
+
let limit: Data.LimitData = { check: tokens[2] as number };
|
|
13
|
+
return { time, event, data: limit };
|
|
14
|
+
case Data.Event.Custom:
|
|
15
|
+
let custom: Data.CustomData = { key: tokens[2] as string, value: tokens[3] as string };
|
|
16
|
+
return { time, event, data: custom };
|
|
17
|
+
case Data.Event.Upgrade:
|
|
18
|
+
let upgrade: Data.UpgradeData = { key: tokens[2] as string };
|
|
19
|
+
return { time, event, data: upgrade };
|
|
20
|
+
case Data.Event.Upload:
|
|
21
|
+
let upload: Data.UploadData = { sequence: tokens[2] as number, attempts: tokens[3] as number, status: tokens[4] as number };
|
|
22
|
+
return { time, event, data: upload };
|
|
23
|
+
case Data.Event.Metric:
|
|
24
|
+
let m = 2; // Start from 3rd index since first two are used for time & event
|
|
25
|
+
let metrics: Data.MetricData = {};
|
|
26
|
+
while (m < tokens.length) {
|
|
27
|
+
metrics[tokens[m++] as number] = tokens[m++] as number;
|
|
28
|
+
}
|
|
29
|
+
return { time, event, data: metrics };
|
|
30
|
+
case Data.Event.Dimension:
|
|
31
|
+
let d = 2; // Start from 3rd index since first two are used for time & event
|
|
32
|
+
let dimensions: Data.DimensionData = {};
|
|
33
|
+
while (d < tokens.length) {
|
|
34
|
+
dimensions[tokens[d++] as number] = tokens[d++] as string[];
|
|
35
|
+
}
|
|
36
|
+
return { time, event, data: dimensions };
|
|
37
|
+
case Data.Event.Summary:
|
|
38
|
+
let s = 2; // Start from 3rd index since first two are used for time & event
|
|
39
|
+
let summary: Data.SummaryData = {};
|
|
40
|
+
while (s < tokens.length) {
|
|
41
|
+
let key = tokens[s++] as number;
|
|
42
|
+
let values = tokens[s++] as number[];
|
|
43
|
+
summary[key] = [];
|
|
44
|
+
for (let i = 0; i < values.length - 1; i += 2) {
|
|
45
|
+
summary[key].push([values[i], values[i + 1]]);
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
return { time, event, data: summary };
|
|
49
|
+
case Data.Event.Baseline:
|
|
50
|
+
const tokenLength = tokens.length;
|
|
51
|
+
let baselineData: Data.BaselineData = {
|
|
52
|
+
visible: tokens[2] as number,
|
|
53
|
+
docWidth: tokens[3] as number,
|
|
54
|
+
docHeight: tokens[4] as number,
|
|
55
|
+
screenWidth: tokens[5] as number,
|
|
56
|
+
screenHeight: tokens[6] as number,
|
|
57
|
+
scrollX: tokens[7] as number,
|
|
58
|
+
scrollY: tokens[8] as number,
|
|
59
|
+
pointerX: tokens[9] as number,
|
|
60
|
+
pointerY: tokens[10] as number,
|
|
61
|
+
activityTime: tokens[11] as number,
|
|
62
|
+
scrollTime: tokenLength > 12 ? tokens[12] as number: null,
|
|
63
|
+
pointerTime: tokenLength > 13 ? tokens[13] as number: null,
|
|
64
|
+
moveX: tokenLength > 14 ? tokens[14] as number: null,
|
|
65
|
+
moveY: tokenLength > 15 ? tokens[15] as number: null,
|
|
66
|
+
moveTime: tokenLength > 16 ? tokens[16] as number: null,
|
|
67
|
+
downX: tokenLength > 17 ? tokens[17] as number: null,
|
|
68
|
+
downY: tokenLength > 18 ? tokens[18] as number: null,
|
|
69
|
+
downTime: tokenLength > 19 ? tokens[19] as number: null,
|
|
70
|
+
upX: tokenLength > 20 ? tokens[20] as number: null,
|
|
71
|
+
upY: tokenLength > 21 ? tokens[21] as number: null,
|
|
72
|
+
upTime: tokenLength > 22 ? tokens[22] as number: null,
|
|
73
|
+
pointerPrevX: tokenLength > 23 ? tokens[23] as number: null,
|
|
74
|
+
pointerPrevY: tokenLength > 24 ? tokens[24] as number: null,
|
|
75
|
+
pointerPrevTime: tokenLength > 25 ? tokens[25] as number: null,
|
|
76
|
+
modules: tokenLength > 26 ? tokens[26] as number[]: null,
|
|
77
|
+
}
|
|
78
|
+
return { time, event, data: baselineData };
|
|
79
|
+
case Data.Event.Variable:
|
|
80
|
+
let v = 2; // Start from 3rd index since first two are used for time & event
|
|
81
|
+
let variables: Data.VariableData = {};
|
|
82
|
+
while (v < tokens.length) {
|
|
83
|
+
variables[tokens[v++] as string] = typeof tokens[v + 1] == Constant.String ? [tokens[v++] as string] : tokens[v++] as string[];
|
|
84
|
+
}
|
|
85
|
+
return { time, event, data: variables };
|
|
86
|
+
case Data.Event.Extract:
|
|
87
|
+
let e = 2; // Start from 3rd index since first two are used for time & event
|
|
88
|
+
let extract: Data.ExtractData = {};
|
|
89
|
+
while (e < tokens.length) {
|
|
90
|
+
// For backward compatibility from version 0.7.4
|
|
91
|
+
if (typeof(tokens[e + 1]) == Constant.String) {
|
|
92
|
+
extract[tokens[e++] as string | number] = tokens[e++] as string;
|
|
93
|
+
}
|
|
94
|
+
else {
|
|
95
|
+
let key = tokens[e++] as number;
|
|
96
|
+
let values = tokens[e++] as (number | string)[];
|
|
97
|
+
extract[key] = [];
|
|
98
|
+
for (let i = 0; i < values.length - 1; i += 2) {
|
|
99
|
+
extract[key][values[i] as number] = values[i + 1] as string;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
return { time, event, data: extract };
|
|
104
|
+
case Data.Event.Consent:
|
|
105
|
+
let consent: Data.ConsentData = { source: tokens[2] as number, ad_Storage: tokens[3] as number, analytics_Storage: tokens[4] as number};
|
|
106
|
+
return { time, event, data: consent };
|
|
107
|
+
}
|
|
108
|
+
return null;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export function envelope(tokens: Data.Token[]): Data.Envelope {
|
|
112
|
+
return {
|
|
113
|
+
version: tokens[0] as string,
|
|
114
|
+
sequence: tokens[1] as number,
|
|
115
|
+
start: tokens[2] as number,
|
|
116
|
+
duration: tokens[3] as number,
|
|
117
|
+
projectId: tokens[4] as string,
|
|
118
|
+
userId: tokens[5] as string,
|
|
119
|
+
sessionId: tokens[6] as string,
|
|
120
|
+
pageNum: tokens[7] as number,
|
|
121
|
+
upload: tokens[8] as Data.Upload,
|
|
122
|
+
end: tokens[9] as Data.BooleanFlag,
|
|
123
|
+
applicationPlatform: tokens[10] as number,
|
|
124
|
+
url: tokens[11] as string
|
|
125
|
+
};
|
|
126
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Data, Diagnostic } from "@gem-sdk/clarity-js";
|
|
2
|
+
import { DiagnosticEvent } from "../types/diagnostic";
|
|
3
|
+
|
|
4
|
+
export function decode(tokens: Data.Token[]): DiagnosticEvent {
|
|
5
|
+
let time = tokens[0] as number;
|
|
6
|
+
let event = tokens[1] as Data.Event;
|
|
7
|
+
switch (event) {
|
|
8
|
+
case Data.Event.ScriptError:
|
|
9
|
+
let scriptError: Diagnostic.ScriptErrorData = {
|
|
10
|
+
message: tokens[2] as string,
|
|
11
|
+
line: tokens[3] as number,
|
|
12
|
+
column: tokens[4] as number,
|
|
13
|
+
stack: tokens[5] as string,
|
|
14
|
+
source: tokens[6] as string
|
|
15
|
+
};
|
|
16
|
+
return { time, event, data: scriptError };
|
|
17
|
+
case Data.Event.Log:
|
|
18
|
+
let log: Diagnostic.LogData = {
|
|
19
|
+
code: tokens[2] as number,
|
|
20
|
+
name: tokens[3] as string,
|
|
21
|
+
message: tokens[4] as string,
|
|
22
|
+
stack: tokens[5] as string,
|
|
23
|
+
severity: tokens[6] as number
|
|
24
|
+
};
|
|
25
|
+
return { time, event, data: log };
|
|
26
|
+
case Data.Event.Fraud:
|
|
27
|
+
let fraud: Diagnostic.FraudData = {
|
|
28
|
+
id: tokens[2] as number,
|
|
29
|
+
target: tokens[3] as number,
|
|
30
|
+
checksum: tokens[4] as string
|
|
31
|
+
};
|
|
32
|
+
return { time, event, data: fraud };
|
|
33
|
+
}
|
|
34
|
+
return null;
|
|
35
|
+
}
|
package/src/global.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import * as decode from "@src/clarity";
|
|
2
|
+
|
|
3
|
+
// Expose clarity variable globally to allow access to public interface in a browser
|
|
4
|
+
if (typeof window !== "undefined") {
|
|
5
|
+
if ((window as any).clarity === undefined || (window as any).clarity === null) {
|
|
6
|
+
(window as any).clarity = {};
|
|
7
|
+
}
|
|
8
|
+
(window as any).clarity.decode = decode;
|
|
9
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { decode } from "./clarity";
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { Data, Interaction, Layout } from "@gem-sdk/clarity-js";
|
|
2
|
+
import { InteractionEvent, ClickData, TimelineData } from "../types/interaction";
|
|
3
|
+
|
|
4
|
+
export function decode(tokens: Data.Token[]): InteractionEvent {
|
|
5
|
+
let time = tokens[0] as number;
|
|
6
|
+
let event = tokens[1] as Data.Event;
|
|
7
|
+
switch (event) {
|
|
8
|
+
case Data.Event.MouseDown:
|
|
9
|
+
case Data.Event.MouseUp:
|
|
10
|
+
case Data.Event.MouseMove:
|
|
11
|
+
case Data.Event.MouseWheel:
|
|
12
|
+
case Data.Event.DoubleClick:
|
|
13
|
+
case Data.Event.TouchStart:
|
|
14
|
+
case Data.Event.TouchCancel:
|
|
15
|
+
case Data.Event.TouchEnd:
|
|
16
|
+
case Data.Event.TouchMove:
|
|
17
|
+
let pointerData: Interaction.PointerData = {
|
|
18
|
+
target: tokens[2] as number,
|
|
19
|
+
x: tokens[3] as number,
|
|
20
|
+
y: tokens[4] as number,
|
|
21
|
+
id: tokens[5] as number | undefined,
|
|
22
|
+
};
|
|
23
|
+
return { time, event, data: pointerData };
|
|
24
|
+
case Data.Event.Click:
|
|
25
|
+
case Data.Event.ContextMenu:
|
|
26
|
+
let clickHashes = (tokens[12] as string).split(Data.Constant.Dot);
|
|
27
|
+
let clickData: ClickData = {
|
|
28
|
+
target: tokens[2] as number,
|
|
29
|
+
x: tokens[3] as number,
|
|
30
|
+
y: tokens[4] as number,
|
|
31
|
+
eX: tokens[5] as number,
|
|
32
|
+
eY: tokens[6] as number,
|
|
33
|
+
button: tokens[7] as number,
|
|
34
|
+
reaction: tokens[8] as number,
|
|
35
|
+
context: tokens[9] as number,
|
|
36
|
+
text: tokens[10] as string,
|
|
37
|
+
link: tokens[11] as string,
|
|
38
|
+
hash: clickHashes[0],
|
|
39
|
+
hashBeta: clickHashes.length > 0 ? clickHashes[1] : null,
|
|
40
|
+
trust: tokens.length > 13 ? tokens[13] as number : Data.BooleanFlag.True,
|
|
41
|
+
isFullText: tokens.length > 14 ? tokens[14] as number : null,
|
|
42
|
+
w: tokens.length > 15 ? tokens[15] as number : 0,
|
|
43
|
+
h: tokens.length > 16 ? tokens[16] as number : 0,
|
|
44
|
+
tag: tokens.length > 17 ? tokens[17] as string : null,
|
|
45
|
+
class: tokens.length > 18 ? tokens[18] as string : null,
|
|
46
|
+
id: tokens.length > 19 ? tokens[19] as string : null,
|
|
47
|
+
source: tokens.length > 20 ? tokens[20] as number : null,
|
|
48
|
+
};
|
|
49
|
+
return { time, event, data: clickData };
|
|
50
|
+
case Data.Event.Clipboard:
|
|
51
|
+
let clipData: Interaction.ClipboardData = { target: tokens[2] as number, action: tokens[3] as Interaction.Clipboard };
|
|
52
|
+
return { time, event, data: clipData };
|
|
53
|
+
case Data.Event.Resize:
|
|
54
|
+
let resizeData: Interaction.ResizeData = { width: tokens[2] as number, height: tokens[3] as number };
|
|
55
|
+
return { time, event, data: resizeData };
|
|
56
|
+
case Data.Event.Input:
|
|
57
|
+
let inputData: Interaction.InputData = { target: tokens[2] as number, value: tokens[3] as string, trust: tokens.length > 4 ? tokens[4] as number : Data.BooleanFlag.True };
|
|
58
|
+
return { time, event, data: inputData };
|
|
59
|
+
case Data.Event.Selection:
|
|
60
|
+
let selectionData: Interaction.SelectionData = {
|
|
61
|
+
start: tokens[2] as number,
|
|
62
|
+
startOffset: tokens[3] as number,
|
|
63
|
+
end: tokens[4] as number,
|
|
64
|
+
endOffset: tokens[5] as number
|
|
65
|
+
};
|
|
66
|
+
return { time, event, data: selectionData };
|
|
67
|
+
case Data.Event.Change:
|
|
68
|
+
let changeData: Interaction.ChangeData = {
|
|
69
|
+
target: tokens[2] as number,
|
|
70
|
+
type: tokens[3] as string,
|
|
71
|
+
value: tokens[4] as string,
|
|
72
|
+
checksum: tokens[5] as string
|
|
73
|
+
};
|
|
74
|
+
return { time, event, data: changeData };
|
|
75
|
+
case Data.Event.Submit:
|
|
76
|
+
let submitData: Interaction.SubmitData = {
|
|
77
|
+
target: tokens[2] as number
|
|
78
|
+
};
|
|
79
|
+
return { time, event, data: submitData };
|
|
80
|
+
case Data.Event.Scroll:
|
|
81
|
+
let scrollData: Interaction.ScrollData = {
|
|
82
|
+
target: tokens[2] as number,
|
|
83
|
+
x: tokens[3] as number,
|
|
84
|
+
y: tokens[4] as number,
|
|
85
|
+
top: tokens.length > 5 ? tokens[5] as string : null,
|
|
86
|
+
bottom: tokens.length > 6 ? tokens[6] as string : null,
|
|
87
|
+
trust: tokens.length > 7 ? tokens[7] as number : Data.BooleanFlag.True
|
|
88
|
+
};
|
|
89
|
+
return { time, event, data: scrollData };
|
|
90
|
+
case Data.Event.Timeline:
|
|
91
|
+
let timelineHashes = (tokens[3] as string).split(Data.Constant.Dot);
|
|
92
|
+
let timelineData: TimelineData = {
|
|
93
|
+
type: tokens[2] as number,
|
|
94
|
+
hash: timelineHashes[Layout.Selector.Alpha],
|
|
95
|
+
x: tokens[4] as number,
|
|
96
|
+
y: tokens[5] as number,
|
|
97
|
+
reaction: tokens[6] as number,
|
|
98
|
+
context: tokens[7] as number,
|
|
99
|
+
hashBeta: timelineHashes.length > 0 ? timelineHashes[Layout.Selector.Beta] : null
|
|
100
|
+
};
|
|
101
|
+
return { time, event, data: timelineData };
|
|
102
|
+
case Data.Event.Visibility:
|
|
103
|
+
let visibleData: Interaction.VisibilityData;
|
|
104
|
+
if (typeof tokens[2] === "number") {
|
|
105
|
+
visibleData = { visible: tokens[2] as number };
|
|
106
|
+
} else {
|
|
107
|
+
visibleData = { visible: (tokens[2] as string) === "visible" ? Data.BooleanFlag.True : Data.BooleanFlag.False };
|
|
108
|
+
}
|
|
109
|
+
return { time, event, data: visibleData };
|
|
110
|
+
case Data.Event.Focus:
|
|
111
|
+
let focusData: Interaction.FocusData = { focused: tokens[2] as number };
|
|
112
|
+
return { time, event, data: focusData };
|
|
113
|
+
case Data.Event.Unload:
|
|
114
|
+
let unloadData: Interaction.UnloadData = { name: tokens[2] as string, persisted: tokens[3] as number };
|
|
115
|
+
return { time, event, data: unloadData };
|
|
116
|
+
}
|
|
117
|
+
return null;
|
|
118
|
+
}
|