-
Notifications
You must be signed in to change notification settings - Fork 5
/
ITelemetryData.ts
102 lines (87 loc) · 2.81 KB
/
ITelemetryData.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
type TelemetryBool = "true" | "false";
export interface ITelemetryEvent {
/**
* The application sending the event
*/
app: string;
/**
* The application stage, e.g. 'CODE' | 'PROD'
*/
stage: string;
/**
* The type of event we're sending, e.g. 'USER_ACTION_1' | 'USER_ACTION_2'
*/
type: string;
/**
* The value of the event in question
*/
value: number;
/**
* The time the event occurred (not the time it was queued, or sent), in ISO-8601 date format
* @format date-time
*/
eventTime: string;
/**
* The event metadata – any additional context we'd like to provide.
*/
tags?: {
[key: string]: string | number | boolean;
};
}
export enum TYPERIGHTER_TELEMETRY_TYPE {
TYPERIGHTER_SUGGESTION_IS_ACCEPTED = "TYPERIGHTER_SUGGESTION_IS_ACCEPTED",
TYPERIGHTER_MARK_AS_CORRECT = "TYPERIGHTER_MARK_AS_CORRECT",
TYPERIGHTER_MATCH_FOUND = "TYPERIGHTER_MATCH_FOUND",
TYPERIGHTER_CHECK_DOCUMENT = "TYPERIGHTER_CHECK_DOCUMENT",
TYPERIGHTER_OPEN_STATE_CHANGED = "TYPERIGHTER_OPEN_STATE_CHANGED",
TYPERIGHTER_SIDEBAR_MATCH_CLICK = "TYPERIGHTER_SIDEBAR_MATCH_CLICK"
}
export interface ITyperighterTelemetryEvent extends ITelemetryEvent {
type: TYPERIGHTER_TELEMETRY_TYPE;
tags: ITelemetryEvent["tags"] & {
// The URL of the resource containing the text that was scanned
documentUrl: string;
};
}
interface IMatchEventTags {
matcherType: string;
ruleId: string;
suggestion?: string;
matchId: string;
matchIsMarkedAsCorrect: TelemetryBool;
matchIsAdvisory: TelemetryBool;
matchHasReplacement: TelemetryBool;
matchedText: string;
matchContext: string;
}
export interface IMatchFoundEvent extends ITyperighterTelemetryEvent {
type: TYPERIGHTER_TELEMETRY_TYPE.TYPERIGHTER_MATCH_FOUND;
value: 1;
tags: ITyperighterTelemetryEvent["tags"] & IMatchEventTags;
}
export interface ISuggestionAcceptedEvent extends ITyperighterTelemetryEvent {
type: TYPERIGHTER_TELEMETRY_TYPE.TYPERIGHTER_SUGGESTION_IS_ACCEPTED;
value: 1;
tags: ITyperighterTelemetryEvent["tags"] &
IMatchEventTags & {
suggestion: string;
};
}
export interface IMarkAsCorrectEvent extends ITyperighterTelemetryEvent {
type: TYPERIGHTER_TELEMETRY_TYPE.TYPERIGHTER_MARK_AS_CORRECT;
value: 1;
tags: ITyperighterTelemetryEvent["tags"] & IMatchEventTags;
}
export interface ICheckDocumentEvent extends ITyperighterTelemetryEvent {
type: TYPERIGHTER_TELEMETRY_TYPE.TYPERIGHTER_CHECK_DOCUMENT;
value: 1;
}
export interface IOpenTyperighterEvent extends ITyperighterTelemetryEvent {
type: TYPERIGHTER_TELEMETRY_TYPE.TYPERIGHTER_OPEN_STATE_CHANGED;
value: 0 | 1;
}
export interface ISidebarClickEvent extends ITyperighterTelemetryEvent {
type: TYPERIGHTER_TELEMETRY_TYPE.TYPERIGHTER_SIDEBAR_MATCH_CLICK;
value: 1;
tags: ITyperighterTelemetryEvent["tags"] & IMatchEventTags;
}