@ada-support/web-storage 0.8.1 → 0.8.3
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.
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<html lang="en">
|
|
2
2
|
<head>
|
|
3
|
-
<title>Ada
|
|
3
|
+
<title>Ada client-side storage</title>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<style>
|
|
6
6
|
body {
|
|
@@ -20,7 +20,7 @@ border: 1px solid;
|
|
|
20
20
|
</style>
|
|
21
21
|
</head>
|
|
22
22
|
<body>
|
|
23
|
-
<h1>Ada
|
|
23
|
+
<h1>Ada client-side storage (“cookies”)</h1>
|
|
24
24
|
<table>
|
|
25
25
|
<thead>
|
|
26
26
|
<tr>
|
|
@@ -29,106 +29,208 @@ border: 1px solid;
|
|
|
29
29
|
</thead>
|
|
30
30
|
<tbody>
|
|
31
31
|
<tr>
|
|
32
|
-
<td>_dd_s</td
|
|
32
|
+
<td>_dd_s</td>
|
|
33
|
+
<td>Used to monitor user sessions for DataDog RUM Tracking.</td>
|
|
34
|
+
<td>Cookie (functional, security)</td>
|
|
35
|
+
<td>10-15 Minutes</td>
|
|
33
36
|
</tr>
|
|
34
37
|
<tr>
|
|
35
|
-
<td>ada-embed_chat-assigned-version</td
|
|
38
|
+
<td>ada-embed_chat-assigned-version</td>
|
|
39
|
+
<td>Used to store the Chat version assigned to a user.</td>
|
|
40
|
+
<td>Web Storage (functional)</td>
|
|
41
|
+
<td>Persistent</td>
|
|
36
42
|
</tr>
|
|
37
43
|
<tr>
|
|
38
|
-
<td>ada-embed_chat-manifest-cache</td
|
|
44
|
+
<td>ada-embed_chat-manifest-cache</td>
|
|
45
|
+
<td>Used to store information about current versions of Chat available (“canary” or “stable”).</td>
|
|
46
|
+
<td>Web Storage (functional)</td>
|
|
47
|
+
<td>Persistent</td>
|
|
39
48
|
</tr>
|
|
40
49
|
<tr>
|
|
41
|
-
<td>ada-embed_chatter-created</td
|
|
50
|
+
<td>ada-embed_chatter-created</td>
|
|
51
|
+
<td>Used to determine whether chatter session is expired.</td>
|
|
52
|
+
<td>Web Storage (functional)</td>
|
|
53
|
+
<td>Persistent</td>
|
|
42
54
|
</tr>
|
|
43
55
|
<tr>
|
|
44
|
-
<td>ada-embed_is-drawer-open</td
|
|
56
|
+
<td>ada-embed_is-drawer-open</td>
|
|
57
|
+
<td>Used to determine if the drawer was opened previously so when users navigate to other pages we can automatically open chat.</td>
|
|
58
|
+
<td>Web Storage (functional)</td>
|
|
59
|
+
<td>Persistent</td>
|
|
45
60
|
</tr>
|
|
46
61
|
<tr>
|
|
47
|
-
<td>ada-embed_session_token</td
|
|
62
|
+
<td>ada-embed_session_token</td>
|
|
63
|
+
<td>Used for chatter authentication.</td>
|
|
64
|
+
<td>Web Storage (functional)</td>
|
|
65
|
+
<td>Persistent</td>
|
|
48
66
|
</tr>
|
|
49
67
|
<tr>
|
|
50
|
-
<td>ada-embed_zd-messaging-chatter-created</td
|
|
68
|
+
<td>ada-embed_zd-messaging-chatter-created</td>
|
|
69
|
+
<td>Used to determine whether Zendesk session is expired.</td>
|
|
70
|
+
<td>Web Storage (functional)</td>
|
|
71
|
+
<td>Persistent</td>
|
|
51
72
|
</tr>
|
|
52
73
|
<tr>
|
|
53
|
-
<td>ada-embed_zd-messaging-external-user-id</td
|
|
74
|
+
<td>ada-embed_zd-messaging-external-user-id</td>
|
|
75
|
+
<td>Stores Zendesk internal user id.</td>
|
|
76
|
+
<td>Web Storage (functional)</td>
|
|
77
|
+
<td>Persistent</td>
|
|
54
78
|
</tr>
|
|
55
79
|
<tr>
|
|
56
|
-
<td>ada-embed_zd-previous-tags</td
|
|
80
|
+
<td>ada-embed_zd-previous-tags</td>
|
|
81
|
+
<td>Used to cache Zendesk tags assigned to a conversation.</td>
|
|
82
|
+
<td>Web Storage (functional)</td>
|
|
83
|
+
<td>Persistent</td>
|
|
57
84
|
</tr>
|
|
58
85
|
<tr>
|
|
59
|
-
<td>ada-embed_zd-session-id</td
|
|
86
|
+
<td>ada-embed_zd-session-id</td>
|
|
87
|
+
<td>Stores Zendesk session id.</td>
|
|
88
|
+
<td>Web Storage (functional)</td>
|
|
89
|
+
<td>Persistent</td>
|
|
60
90
|
</tr>
|
|
61
91
|
<tr>
|
|
62
|
-
<td>ada-embed-assigned-version</td
|
|
92
|
+
<td>ada-embed-assigned-version</td>
|
|
93
|
+
<td>Used to store the Web SDK version assigned to a user.</td>
|
|
94
|
+
<td>Web Storage (functional)</td>
|
|
95
|
+
<td>Persistent</td>
|
|
63
96
|
</tr>
|
|
64
97
|
<tr>
|
|
65
|
-
<td>ada-embed-manifest-cache</td
|
|
98
|
+
<td>ada-embed-manifest-cache</td>
|
|
99
|
+
<td>Used to store information about current versions of Web SDK available (“canary” or “stable”).</td>
|
|
100
|
+
<td>Web Storage (functional)</td>
|
|
101
|
+
<td>Persistent</td>
|
|
66
102
|
</tr>
|
|
67
103
|
<tr>
|
|
68
|
-
<td>ada-functional-storage</td
|
|
104
|
+
<td>ada-functional-storage</td>
|
|
105
|
+
<td>Used to store general information about Ada application state.</td>
|
|
106
|
+
<td>Web Storage (functional)</td>
|
|
107
|
+
<td>Persistent</td>
|
|
69
108
|
</tr>
|
|
70
109
|
<tr>
|
|
71
|
-
<td>chatter</td
|
|
110
|
+
<td>chatter</td>
|
|
111
|
+
<td>Used to identify the user within Ada.</td>
|
|
112
|
+
<td>Web Storage (functional)</td>
|
|
113
|
+
<td>Persistent</td>
|
|
72
114
|
</tr>
|
|
73
115
|
<tr>
|
|
74
|
-
<td>created</td
|
|
116
|
+
<td>created</td>
|
|
117
|
+
<td>Used to determine whether chatter session is expired. This is stored on Ada domain.</td>
|
|
118
|
+
<td>Web Storage (functional)</td>
|
|
119
|
+
<td>Persistent</td>
|
|
75
120
|
</tr>
|
|
76
121
|
<tr>
|
|
77
|
-
<td>delayMessageAfterLiveChatEndTimeStamp</td
|
|
122
|
+
<td>delayMessageAfterLiveChatEndTimeStamp</td>
|
|
123
|
+
<td>Used for live chat messaging functionality.</td>
|
|
124
|
+
<td>Web Storage (functional)</td>
|
|
125
|
+
<td>Persistent</td>
|
|
78
126
|
</tr>
|
|
79
127
|
<tr>
|
|
80
|
-
<td>fs_uid</td
|
|
128
|
+
<td>fs_uid</td>
|
|
129
|
+
<td>Used to identify and distinguish data for each user</td>
|
|
130
|
+
<td>Cookie (analytics)</td>
|
|
131
|
+
<td>3 Months</td>
|
|
81
132
|
</tr>
|
|
82
133
|
<tr>
|
|
83
|
-
<td>inLiveChat</td
|
|
134
|
+
<td>inLiveChat</td>
|
|
135
|
+
<td>Indicates whether user is connected to a live agent.</td>
|
|
136
|
+
<td>Web Storage (functional)</td>
|
|
137
|
+
<td>Persistent</td>
|
|
84
138
|
</tr>
|
|
85
139
|
<tr>
|
|
86
|
-
<td>liveChatPending</td
|
|
140
|
+
<td>liveChatPending</td>
|
|
141
|
+
<td>Indicates whether user is waiting to connect to a live agent.</td>
|
|
142
|
+
<td>Web Storage (functional)</td>
|
|
143
|
+
<td>Persistent</td>
|
|
87
144
|
</tr>
|
|
88
145
|
<tr>
|
|
89
|
-
<td>netDisruptionMsgStartTime</td
|
|
146
|
+
<td>netDisruptionMsgStartTime</td>
|
|
147
|
+
<td>Used to implement Chat reconnection after an interruption.</td>
|
|
148
|
+
<td>Web Storage (functional)</td>
|
|
149
|
+
<td>Persistent</td>
|
|
90
150
|
</tr>
|
|
91
151
|
<tr>
|
|
92
|
-
<td>parentOrigin</td
|
|
152
|
+
<td>parentOrigin</td>
|
|
153
|
+
<td>Stores Chat iFrame parent window origin.</td>
|
|
154
|
+
<td>Web Storage (functional)</td>
|
|
155
|
+
<td>Persistent</td>
|
|
93
156
|
</tr>
|
|
94
157
|
<tr>
|
|
95
|
-
<td>previouslyAuthenticated</td
|
|
158
|
+
<td>previouslyAuthenticated</td>
|
|
159
|
+
<td>Used for Zendesk authentication functionality.</td>
|
|
160
|
+
<td>Web Storage (functional)</td>
|
|
161
|
+
<td>Persistent</td>
|
|
96
162
|
</tr>
|
|
97
163
|
<tr>
|
|
98
|
-
<td>previousZDTags</td
|
|
164
|
+
<td>previousZDTags</td>
|
|
165
|
+
<td>Used to cache Zendesk tags assigned to a conversation. This is stored on Ada domain.</td>
|
|
166
|
+
<td>Web Storage (functional)</td>
|
|
167
|
+
<td>Persistent</td>
|
|
99
168
|
</tr>
|
|
100
169
|
<tr>
|
|
101
|
-
<td>pusherTransportTLS</td
|
|
170
|
+
<td>pusherTransportTLS</td>
|
|
171
|
+
<td>Used by Pusher API for realtime messaging.</td>
|
|
172
|
+
<td>Web Storage (essential)</td>
|
|
173
|
+
<td>Persistent</td>
|
|
102
174
|
</tr>
|
|
103
175
|
<tr>
|
|
104
|
-
<td>secretButton</td
|
|
176
|
+
<td>secretButton</td>
|
|
177
|
+
<td>Used during Oracle handoffs to indicate whether the agent has sent a request for a secret message. Allows the state to persist between page changes.</td>
|
|
178
|
+
<td>Web Storage (functional)</td>
|
|
179
|
+
<td>Persistent</td>
|
|
105
180
|
</tr>
|
|
106
181
|
<tr>
|
|
107
|
-
<td>sessionToken</td
|
|
182
|
+
<td>sessionToken</td>
|
|
183
|
+
<td>Used for chatter authentication. This is stored on Ada domain.</td>
|
|
184
|
+
<td>Web Storage (functional)</td>
|
|
185
|
+
<td>Persistent</td>
|
|
108
186
|
</tr>
|
|
109
187
|
<tr>
|
|
110
|
-
<td>vuid</td
|
|
188
|
+
<td>vuid</td>
|
|
189
|
+
<td>Used by Vimeo to store the user’s usage history (loaded only if a video has been included).</td>
|
|
190
|
+
<td>Cookie (functional)</td>
|
|
191
|
+
<td>2 Years</td>
|
|
111
192
|
</tr>
|
|
112
193
|
<tr>
|
|
113
|
-
<td>zd_isChatterAuthenticated</td
|
|
194
|
+
<td>zd_isChatterAuthenticated</td>
|
|
195
|
+
<td>Used for Zendesk authentication functionality.</td>
|
|
196
|
+
<td>Web Storage (functional)</td>
|
|
197
|
+
<td>Persistent</td>
|
|
114
198
|
</tr>
|
|
115
199
|
<tr>
|
|
116
|
-
<td>zdAuthChatPending</td
|
|
200
|
+
<td>zdAuthChatPending</td>
|
|
201
|
+
<td>Used for Zendesk authentication functionality.</td>
|
|
202
|
+
<td>Web Storage (functional)</td>
|
|
203
|
+
<td>Persistent</td>
|
|
117
204
|
</tr>
|
|
118
205
|
<tr>
|
|
119
|
-
<td>zdCid</td
|
|
206
|
+
<td>zdCid</td>
|
|
207
|
+
<td>Used for Zendesk SDK functionality.</td>
|
|
208
|
+
<td>Web Storage (functional)</td>
|
|
209
|
+
<td>Persistent</td>
|
|
120
210
|
</tr>
|
|
121
211
|
<tr>
|
|
122
|
-
<td>zdCStore</td
|
|
212
|
+
<td>zdCStore</td>
|
|
213
|
+
<td>Used for Zendesk SDK functionality.</td>
|
|
214
|
+
<td>Web Storage (functional)</td>
|
|
215
|
+
<td>Persistent</td>
|
|
123
216
|
</tr>
|
|
124
217
|
<tr>
|
|
125
|
-
<td>zdMessagingChatterCreated</td
|
|
218
|
+
<td>zdMessagingChatterCreated</td>
|
|
219
|
+
<td>Used for Zendesk SDK functionality.</td>
|
|
220
|
+
<td>Web Storage (functional)</td>
|
|
221
|
+
<td>Persistent</td>
|
|
126
222
|
</tr>
|
|
127
223
|
<tr>
|
|
128
|
-
<td>zdMessagingExternalUserId</td
|
|
224
|
+
<td>zdMessagingExternalUserId</td>
|
|
225
|
+
<td>Used for Zendesk SDK functionality.</td>
|
|
226
|
+
<td>Web Storage (functional)</td>
|
|
227
|
+
<td>Persistent</td>
|
|
129
228
|
</tr>
|
|
130
229
|
<tr>
|
|
131
|
-
<td>zdSessionId</td
|
|
230
|
+
<td>zdSessionId</td>
|
|
231
|
+
<td>Used for Zendesk SDK functionality.</td>
|
|
232
|
+
<td>Web Storage (functional)</td>
|
|
233
|
+
<td>Persistent</td>
|
|
132
234
|
</tr>
|
|
133
235
|
</tbody>
|
|
134
236
|
</table>
|
|
@@ -31,10 +31,11 @@ function runScript() {
|
|
|
31
31
|
keyName: nameMatches[1],
|
|
32
32
|
description: descriptionMatches[1].trim(),
|
|
33
33
|
type: "Web Storage",
|
|
34
|
-
duration: "Persistent"
|
|
34
|
+
duration: "Persistent",
|
|
35
|
+
purpose: ["Functional"]
|
|
35
36
|
};
|
|
36
37
|
}), true), third_party_items_1.THIRD_PARTY_ITEMS, true).sort(function (a, b) { return a.keyName.localeCompare(b.keyName); });
|
|
37
|
-
var html = "\n <html lang=\"en\">\n <head>\n <title>Ada
|
|
38
|
+
var html = "\n <html lang=\"en\">\n <head>\n <title>Ada client-side storage</title>\n <meta charset=\"utf-8\">\n <style>\n body {\n font-family: sans-serif;\n }\n \n h1 {\n font-size: 1.4em;\n }\n \n table {\n border-collapse: collapse;\n }\n \n table th, table td {\n text-align: left;\n padding: 10px;\n border: 1px solid;\n } \n </style>\n </head>\n <body>\n <h1>Ada client-side storage (\u201Ccookies\u201D)</h1>\n <table>\n <thead>\n <tr>\n <th>Name</th><th>Description</th><th>Type</th><th>Duration</th>\n <tr>\n </thead>\n <tbody>\n ".concat(records.map(function (record) { return "\n <tr>\n <td>".concat(record.keyName, "</td>\n <td>").concat(record.description, "</td>\n <td>").concat(record.type, " (").concat(record.purpose.map(function (i) { return i.toLocaleLowerCase(); }).join(", "), ")</td>\n <td>").concat(record.duration, "</td>\n </tr>\n "); }).join("\n").trim(), "\n </tbody>\n </table>\n </body>\n </html>\n ")
|
|
38
39
|
.trim()
|
|
39
40
|
.replace(/ {2}/g, "")
|
|
40
41
|
.replace(/\n+/g, "\n");
|
|
@@ -10,30 +10,35 @@ exports.THIRD_PARTY_ITEMS = [
|
|
|
10
10
|
keyName: "secretButton",
|
|
11
11
|
description: "Used during Oracle handoffs to indicate whether the agent has sent a request for a secret message. Allows the state to persist between page changes.",
|
|
12
12
|
type: "Web Storage",
|
|
13
|
-
duration: "Persistent"
|
|
13
|
+
duration: "Persistent",
|
|
14
|
+
purpose: ["Functional"]
|
|
14
15
|
},
|
|
15
16
|
{
|
|
16
17
|
keyName: "vuid",
|
|
17
18
|
description: "Used by Vimeo to store the user’s usage history (loaded only if a video has been included).",
|
|
18
19
|
type: "Cookie",
|
|
19
|
-
duration: "2 Years"
|
|
20
|
+
duration: "2 Years",
|
|
21
|
+
purpose: ["Functional"]
|
|
20
22
|
},
|
|
21
23
|
{
|
|
22
24
|
keyName: "_dd_s",
|
|
23
25
|
description: "Used to monitor user sessions for DataDog RUM Tracking.",
|
|
24
26
|
type: "Cookie",
|
|
25
|
-
duration: "10-15 Minutes"
|
|
27
|
+
duration: "10-15 Minutes",
|
|
28
|
+
purpose: ["Functional", "Security"]
|
|
26
29
|
},
|
|
27
30
|
{
|
|
28
31
|
keyName: "fs_uid",
|
|
29
32
|
description: "Used to identify and distinguish data for each user",
|
|
30
33
|
type: "Cookie",
|
|
31
|
-
duration: "3 Months"
|
|
34
|
+
duration: "3 Months",
|
|
35
|
+
purpose: ["Analytics"]
|
|
32
36
|
},
|
|
33
37
|
{
|
|
34
38
|
keyName: "pusherTransportTLS",
|
|
35
39
|
description: "Used by Pusher API for realtime messaging.",
|
|
36
40
|
type: "Web Storage",
|
|
37
|
-
duration: "Persistent"
|
|
41
|
+
duration: "Persistent",
|
|
42
|
+
purpose: ["Essential"]
|
|
38
43
|
},
|
|
39
44
|
];
|
package/package.json
CHANGED
package/src/cli/generate-html.ts
CHANGED
|
@@ -32,6 +32,7 @@ function runScript() {
|
|
|
32
32
|
description: descriptionMatches[1].trim(),
|
|
33
33
|
type: "Web Storage",
|
|
34
34
|
duration: "Persistent",
|
|
35
|
+
purpose: ["Functional"],
|
|
35
36
|
} as const;
|
|
36
37
|
}),
|
|
37
38
|
...THIRD_PARTY_ITEMS,
|
|
@@ -40,7 +41,7 @@ function runScript() {
|
|
|
40
41
|
const html = `
|
|
41
42
|
<html lang="en">
|
|
42
43
|
<head>
|
|
43
|
-
<title>Ada
|
|
44
|
+
<title>Ada client-side storage</title>
|
|
44
45
|
<meta charset="utf-8">
|
|
45
46
|
<style>
|
|
46
47
|
body {
|
|
@@ -63,7 +64,7 @@ function runScript() {
|
|
|
63
64
|
</style>
|
|
64
65
|
</head>
|
|
65
66
|
<body>
|
|
66
|
-
<h1>Ada
|
|
67
|
+
<h1>Ada client-side storage (“cookies”)</h1>
|
|
67
68
|
<table>
|
|
68
69
|
<thead>
|
|
69
70
|
<tr>
|
|
@@ -73,7 +74,10 @@ function runScript() {
|
|
|
73
74
|
<tbody>
|
|
74
75
|
${records.map(record => `
|
|
75
76
|
<tr>
|
|
76
|
-
<td>${record.keyName}</td
|
|
77
|
+
<td>${record.keyName}</td>
|
|
78
|
+
<td>${record.description}</td>
|
|
79
|
+
<td>${record.type} (${record.purpose.map(i => i.toLocaleLowerCase()).join(", ")})</td>
|
|
80
|
+
<td>${record.duration}</td>
|
|
77
81
|
</tr>
|
|
78
82
|
`).join("\n").trim()}
|
|
79
83
|
</tbody>
|
package/src/third-party-items.ts
CHANGED
|
@@ -2,6 +2,7 @@ interface WebStorageItem {
|
|
|
2
2
|
keyName: string;
|
|
3
3
|
description: string;
|
|
4
4
|
type: "Web Storage" | "Cookie";
|
|
5
|
+
purpose: ReadonlyArray<"Essential" | "Functional" | "Security" | "Analytics">;
|
|
5
6
|
duration: string;
|
|
6
7
|
}
|
|
7
8
|
|
|
@@ -15,29 +16,34 @@ export const THIRD_PARTY_ITEMS: WebStorageItem[] = [
|
|
|
15
16
|
description: "Used during Oracle handoffs to indicate whether the agent has sent a request for a secret message. Allows the state to persist between page changes.",
|
|
16
17
|
type: "Web Storage",
|
|
17
18
|
duration: "Persistent",
|
|
19
|
+
purpose: ["Functional"],
|
|
18
20
|
},
|
|
19
21
|
{
|
|
20
22
|
keyName: "vuid",
|
|
21
23
|
description: "Used by Vimeo to store the user’s usage history (loaded only if a video has been included).",
|
|
22
24
|
type: "Cookie",
|
|
23
25
|
duration: "2 Years",
|
|
26
|
+
purpose: ["Functional"],
|
|
24
27
|
},
|
|
25
28
|
{
|
|
26
29
|
keyName: "_dd_s",
|
|
27
30
|
description: "Used to monitor user sessions for DataDog RUM Tracking.",
|
|
28
31
|
type: "Cookie",
|
|
29
32
|
duration: "10-15 Minutes",
|
|
33
|
+
purpose: ["Functional", "Security"],
|
|
30
34
|
},
|
|
31
35
|
{
|
|
32
36
|
keyName: "fs_uid",
|
|
33
37
|
description: "Used to identify and distinguish data for each user",
|
|
34
38
|
type: "Cookie",
|
|
35
39
|
duration: "3 Months",
|
|
40
|
+
purpose: ["Analytics"],
|
|
36
41
|
},
|
|
37
42
|
{
|
|
38
43
|
keyName: "pusherTransportTLS",
|
|
39
44
|
description: "Used by Pusher API for realtime messaging.",
|
|
40
45
|
type: "Web Storage",
|
|
41
46
|
duration: "Persistent",
|
|
47
|
+
purpose: ["Essential"],
|
|
42
48
|
},
|
|
43
49
|
];
|