@ada-support/web-storage 1.4.7 → 1.4.8

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 (14) hide show
  1. package/biome.json +11 -0
  2. package/dist/cli/generate-html.js +41 -7
  3. package/dist/create-storage.js +6 -6
  4. package/dist/index.js +1 -1
  5. package/dist/storage-keys.d.ts +25 -24
  6. package/package.json +7 -5
  7. package/src/cli/generate-html.ts +79 -32
  8. package/src/create-storage.ts +62 -54
  9. package/src/functional-storage.ts +21 -21
  10. package/src/index.ts +8 -8
  11. package/src/storage-keys.ts +77 -76
  12. package/src/third-party-items.ts +212 -205
  13. package/.eslintignore +0 -2
  14. package/.eslintrc +0 -10
package/biome.json ADDED
@@ -0,0 +1,11 @@
1
+ {
2
+ "$schema": "https://biomejs.dev/schemas/2.4.10/schema.json",
3
+ "extends": ["../biome-config/biome.json"],
4
+ "vcs": {
5
+ "enabled": true,
6
+ "clientKind": "git",
7
+ "useIgnoreFile": true,
8
+ "defaultBranch": "main"
9
+ },
10
+ "files": { "includes": ["src/**/*.ts"] }
11
+ }
package/dist/cli/generate-html.js CHANGED
@@ -9,20 +9,41 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
9
9
  return to.concat(ar || Array.prototype.slice.call(from));
10
10
  };
11
11
  exports.__esModule = true;
12
- var fs_1 = require("fs");
12
+ var node_fs_1 = require("node:fs");
13
13
  var third_party_items_1 = require("../third-party-items");
14
14
  var OUTPUT_DIR = "dist";
15
15
  var OUTPUT_FILENAME = "ada-web-storage-list.html";
16
16
  var PARSE_ERROR_MESSAGE = "Could not parse StorageValueByKey interface";
17
+ // KEY_LINES is /g only so `.match` returns every key line for the declared list;
18
+ // KEY_LINE must stay non-global so `.match` returns capture groups and [1] is the
19
+ // key name. Don't merge them: with a global regex `[1]` is the second matched line
20
+ // instead, so keyName silently becomes garbage in the published registry.
21
+ // Both need `m` — a key sits on its own line after the entry's doc comment.
22
+ var KEY_LINE = /^\s*"?([\w-]+)"?:\s/m;
23
+ var KEY_LINES = /^\s*"?([\w-]+)"?:\s/gm;
24
+ var INTERFACE_DECL = "export interface StorageValueByKey {";
17
25
  function runScript() {
18
- var data = (0, fs_1.readFileSync)("./src/storage-keys.ts", "utf-8");
26
+ var _a;
27
+ var data = (0, node_fs_1.readFileSync)("./src/storage-keys.ts", "utf-8");
19
28
  var matches = data.match(/StorageValueByKey \{([^}]+)}/);
20
29
  if (!matches) {
21
30
  throw new Error(PARSE_ERROR_MESSAGE);
22
31
  }
23
32
  var items = matches[0].split("\n\n").map(function (item) { return item.trim(); });
24
- var records = __spreadArray(__spreadArray([], items.map(function (item) {
25
- var nameMatches = item.match(/"([^}]+)": /);
33
+ // Read the declared keys from the interface's real extent — its declaration to
34
+ // its own column-0 closing brace — NOT from `matches`. The `[^}]+` above stops
35
+ // at the first `}`, so an inline object value truncates it, and anything derived
36
+ // from that same match would shrink in step and hide the loss.
37
+ var declStart = data.indexOf(INTERFACE_DECL);
38
+ var declEnd = declStart === -1 ? -1 : data.indexOf("\n}", declStart);
39
+ if (declStart === -1 || declEnd === -1) {
40
+ throw new Error(PARSE_ERROR_MESSAGE);
41
+ }
42
+ var declaredNames = ((_a = data.slice(declStart, declEnd).match(KEY_LINES)) !== null && _a !== void 0 ? _a : []).map(function (line) { var _a, _b; return (_b = (_a = line.match(KEY_LINE)) === null || _a === void 0 ? void 0 : _a[1]) !== null && _b !== void 0 ? _b : line.trim(); });
43
+ var storageRecords = items.map(function (item) {
44
+ // Quotes are optional: the formatter strips redundant ones from
45
+ // identifier-safe key names, so only hyphenated keys keep them.
46
+ var nameMatches = item.match(KEY_LINE);
26
47
  var descriptionMatches = item.match(/\/\*\*([^}]+)\*\//);
27
48
  if (!nameMatches || !descriptionMatches) {
28
49
  throw new Error(PARSE_ERROR_MESSAGE);
@@ -34,11 +55,24 @@ function runScript() {
34
55
  duration: "Persistent",
35
56
  purpose: ["Functional"]
36
57
  };
37
- }), true), third_party_items_1.THIRD_PARTY_ITEMS, true).sort(function (a, b) { return a.keyName.localeCompare(b.keyName); });
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 ")
58
+ });
59
+ // Compare the key SETS, not their sizes: a size check passes whenever two
60
+ // defects cancel out, and it can't name what went missing. This can, and it is
61
+ // the assertion a golden-file test would make.
62
+ var parsedNames = storageRecords.map(function (record) { return record.keyName; });
63
+ var missing = declaredNames.filter(function (n) { return parsedNames.indexOf(n) === -1; });
64
+ var unexpected = parsedNames.filter(function (n) { return declaredNames.indexOf(n) === -1; });
65
+ if (missing.length > 0 || unexpected.length > 0) {
66
+ throw new Error("".concat(PARSE_ERROR_MESSAGE, ": declared but not parsed: [").concat(missing.join(", "), "]; parsed but not declared: [").concat(unexpected.join(", "), "]. Each key needs its own entry separated by an empty line, and no entry may contain a brace (see storage-keys.ts)."));
67
+ }
68
+ var records = __spreadArray(__spreadArray([], storageRecords, true), third_party_items_1.THIRD_PARTY_ITEMS, true).sort(function (a, b) { return a.keyName.localeCompare(b.keyName); });
69
+ 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
70
+ .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 "); })
71
+ .join("\n")
72
+ .trim(), "\n </tbody>\n </table>\n </body>\n </html>\n ")
39
73
  .trim()
40
74
  .replace(/ {2}/g, "")
41
75
  .replace(/\n+/g, "\n");
42
- (0, fs_1.writeFileSync)("./".concat(OUTPUT_DIR, "/").concat(OUTPUT_FILENAME), html);
76
+ (0, node_fs_1.writeFileSync)("./".concat(OUTPUT_DIR, "/").concat(OUTPUT_FILENAME), html);
43
77
  }
44
78
  runScript();
package/dist/create-storage.js CHANGED
@@ -19,7 +19,7 @@ var createStorage = function (storageType) {
19
19
  try {
20
20
  storageProvider = storageType === "local" ? localStorage : sessionStorage;
21
21
  }
22
- catch (e) {
22
+ catch (_a) {
23
23
  console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
24
24
  }
25
25
  var storage = {
@@ -27,7 +27,7 @@ var createStorage = function (storageType) {
27
27
  try {
28
28
  storageProvider.setItem(key, JSON.stringify(value));
29
29
  }
30
- catch (e) {
30
+ catch (_a) {
31
31
  console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
32
32
  }
33
33
  },
@@ -36,7 +36,7 @@ var createStorage = function (storageType) {
36
36
  var rawStorageValue = storageProvider.getItem(key);
37
37
  return rawStorageValue && JSON.parse(rawStorageValue);
38
38
  }
39
- catch (e) {
39
+ catch (_a) {
40
40
  console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
41
41
  return null;
42
42
  }
@@ -45,7 +45,7 @@ var createStorage = function (storageType) {
45
45
  try {
46
46
  storageProvider.removeItem(key);
47
47
  }
48
- catch (e) {
48
+ catch (_a) {
49
49
  console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
50
50
  }
51
51
  },
@@ -53,7 +53,7 @@ var createStorage = function (storageType) {
53
53
  try {
54
54
  storageProvider.clear();
55
55
  }
56
- catch (e) {
56
+ catch (_a) {
57
57
  console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
58
58
  }
59
59
  },
@@ -67,7 +67,7 @@ var createStorage = function (storageType) {
67
67
  /** Gets a value under `ada-functional-storage` Storage key */
68
68
  getFnItem: function (key) {
69
69
  var value = storage.getItem("ada-functional-storage");
70
- return (value && value[key]) || null;
70
+ return (value === null || value === void 0 ? void 0 : value[key]) || null;
71
71
  }
72
72
  };
73
73
  return storage;
package/dist/index.js CHANGED
@@ -12,7 +12,7 @@ var isWebStorageSupported = function () {
12
12
  localStorage.removeItem(key);
13
13
  return true;
14
14
  }
15
- catch (e) {
15
+ catch (_a) {
16
16
  return false;
17
17
  }
18
18
  };
package/dist/storage-keys.d.ts CHANGED
@@ -18,7 +18,8 @@ export interface MessagingAuthState {
18
18
  *
19
19
  * The interface is being parsed by `./src/cli/generate-html.ts` script.
20
20
  * The format of code here must be consistent, i.e.
21
- * each key should have a comment, the key name must be quoted, and keys must be separated by an empty line.
21
+ * each key should have a comment, and keys must be separated by an empty line.
22
+ * Quoting the key name is optional — the parser accepts either form.
22
23
  */
23
24
  export interface StorageValueByKey {
24
25
  /** Used to store the Web SDK version assigned to a user. */
@@ -44,52 +45,52 @@ export interface StorageValueByKey {
44
45
  /** Used to store general information about Ada application state. */
45
46
  "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
46
47
  /** Used to identify the user within Ada. */
47
- "chatter": string;
48
+ chatter: string;
48
49
  /** Used to determine whether chatter session is expired. This is stored on Ada domain. */
49
- "created": string;
50
+ created: string;
50
51
  /** Used for live chat messaging functionality. */
51
- "delayMessageAfterLiveChatEndTimeStamp": number;
52
+ delayMessageAfterLiveChatEndTimeStamp: number;
52
53
  /** Indicates whether user is connected to a live agent. */
53
- "inLiveChat": boolean;
54
+ inLiveChat: boolean;
54
55
  /** Indicates whether user is waiting to connect to a live agent. */
55
- "liveChatPending": boolean;
56
+ liveChatPending: boolean;
56
57
  /** Used to implement Chat reconnection after an interruption. */
57
- "netDisruptionMsgStartTime": number;
58
+ netDisruptionMsgStartTime: number;
58
59
  /** Stores Chat iFrame parent window origin. */
59
- "parentOrigin": string;
60
+ parentOrigin: string;
60
61
  /** Used to cache Zendesk tags assigned to a conversation. This is stored on Ada domain. */
61
- "previousZDTags": string;
62
+ previousZDTags: string;
62
63
  /** Used for Zendesk authentication functionality. */
63
- "previouslyAuthenticated": boolean;
64
+ previouslyAuthenticated: boolean;
64
65
  /** Used for chatter authentication. */
65
66
  "ada-embed_session-token": string;
66
67
  /** Stores the messaging authentication state (its owner chatter, a short-lived messaging access token and expiry, a rotating session refresh token, and a refresh counter) used to authenticate the visitor's generative chat session with Ada. Set on the bot's Ada subdomain. */
67
- "messagingAuthState": MessagingAuthState;
68
+ messagingAuthState: MessagingAuthState;
68
69
  /** Used to implement Chat reconnection after an interruption. */
69
- "backoffTimeout": number;
70
+ backoffTimeout: number;
70
71
  /** 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. */
71
- "secretButton": string;
72
+ secretButton: string;
72
73
  /** Used to keep the builder session active for 24 hours before authentication is required again. Note this is only added if a chatter has logged into the dashboard. */
73
- "session": string;
74
+ session: string;
74
75
  /** Used for chatter authentication. This is stored on Ada domain. */
75
- "sessionToken": string;
76
+ sessionToken: string;
76
77
  /** Used to default the test bot to the previously tested modality */
77
- "testBotModality": "messaging" | "voice" | undefined;
78
+ testBotModality: "messaging" | "voice" | undefined;
78
79
  /** Used for voice chat functionality in the bot builder dashboard */
79
- "testBotPhoneNumber": string;
80
+ testBotPhoneNumber: string;
80
81
  /** Used for Zendesk authentication functionality. */
81
- "zdAuthChatPending": boolean;
82
+ zdAuthChatPending: boolean;
82
83
  /** Used for Zendesk SDK functionality. */
83
- "zdCid": string;
84
+ zdCid: string;
84
85
  /** Used for Zendesk SDK functionality. */
85
- "zdCStore": string;
86
+ zdCStore: string;
86
87
  /** Used for Zendesk SDK functionality. */
87
- "zdMessagingExternalUserId": string;
88
+ zdMessagingExternalUserId: string;
88
89
  /** Used for Zendesk SDK functionality. */
89
- "zdMessagingChatterCreated": string;
90
+ zdMessagingChatterCreated: string;
90
91
  /** Used for Zendesk SDK functionality. */
91
- "zdSessionId": string;
92
+ zdSessionId: string;
92
93
  /** Used for Zendesk authentication functionality. */
93
- "zd_isChatterAuthenticated": boolean;
94
+ zd_isChatterAuthenticated: boolean;
94
95
  }
95
96
  export declare type StorageKey = keyof StorageValueByKey;
package/package.json CHANGED
@@ -1,13 +1,16 @@
1
1
  {
2
2
  "name": "@ada-support/web-storage",
3
- "version": "1.4.7",
3
+ "version": "1.4.8",
4
4
  "description": "A package to provide access to Web Storage API",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {
7
7
  "access": "public"
8
8
  },
9
9
  "scripts": {
10
- "lint": "tsc --noEmit && npx eslint --ext .ts .",
10
+ "lint": "biome check",
11
+ "lint:fix": "biome check --write",
12
+ "lint:ci": "biome ci --error-on-warnings",
13
+ "typecheck": "tsc --noEmit",
11
14
  "check-package-version": "./ci-tools/check-package-version.sh",
12
15
  "compile": "rm -rf dist && npx tsc && npx ts-node ./src/cli/generate-html.ts"
13
16
  },
@@ -24,8 +27,7 @@
24
27
  "typescript": "^4.8.4"
25
28
  },
26
29
  "devDependencies": {
27
- "@ada-support/eslint-config-ada": "^1.2.4",
28
- "@types/node": "^18.8.2",
29
- "eslint": "^8.24.0"
30
+ "@biomejs/biome": "2.4.10",
31
+ "@types/node": "^18.8.2"
30
32
  }
31
33
  }
package/src/cli/generate-html.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { readFileSync, writeFileSync } from "fs";
1
+ import { readFileSync, writeFileSync } from "node:fs";
2
2
 
3
3
  import { THIRD_PARTY_ITEMS } from "../third-party-items";
4
4
 
@@ -7,38 +7,80 @@ const OUTPUT_FILENAME = "ada-web-storage-list.html";
7
7
 
8
8
  const PARSE_ERROR_MESSAGE = "Could not parse StorageValueByKey interface";
9
9
 
10
+ // KEY_LINES is /g only so `.match` returns every key line for the declared list;
11
+ // KEY_LINE must stay non-global so `.match` returns capture groups and [1] is the
12
+ // key name. Don't merge them: with a global regex `[1]` is the second matched line
13
+ // instead, so keyName silently becomes garbage in the published registry.
14
+ // Both need `m` — a key sits on its own line after the entry's doc comment.
15
+ const KEY_LINE = /^\s*"?([\w-]+)"?:\s/m;
16
+ const KEY_LINES = /^\s*"?([\w-]+)"?:\s/gm;
17
+
18
+ const INTERFACE_DECL = "export interface StorageValueByKey {";
19
+
10
20
  function runScript() {
11
- const data = readFileSync("./src/storage-keys.ts", "utf-8");
21
+ const data = readFileSync("./src/storage-keys.ts", "utf-8");
22
+
23
+ const matches = data.match(/StorageValueByKey \{([^}]+)}/);
24
+
25
+ if (!matches) {
26
+ throw new Error(PARSE_ERROR_MESSAGE);
27
+ }
28
+
29
+ const items = matches[0].split("\n\n").map((item) => item.trim());
30
+
31
+ // Read the declared keys from the interface's real extent — its declaration to
32
+ // its own column-0 closing brace — NOT from `matches`. The `[^}]+` above stops
33
+ // at the first `}`, so an inline object value truncates it, and anything derived
34
+ // from that same match would shrink in step and hide the loss.
35
+ const declStart = data.indexOf(INTERFACE_DECL);
36
+ const declEnd = declStart === -1 ? -1 : data.indexOf("\n}", declStart);
37
+
38
+ if (declStart === -1 || declEnd === -1) {
39
+ throw new Error(PARSE_ERROR_MESSAGE);
40
+ }
41
+
42
+ const declaredNames = (
43
+ data.slice(declStart, declEnd).match(KEY_LINES) ?? []
44
+ ).map((line) => line.match(KEY_LINE)?.[1] ?? line.trim());
12
45
 
13
- const matches = data.match(/StorageValueByKey \{([^}]+)}/);
46
+ const storageRecords: typeof THIRD_PARTY_ITEMS = items.map((item) => {
47
+ // Quotes are optional: the formatter strips redundant ones from
48
+ // identifier-safe key names, so only hyphenated keys keep them.
49
+ const nameMatches = item.match(KEY_LINE);
50
+ const descriptionMatches = item.match(/\/\*\*([^}]+)\*\//);
14
51
 
15
- if (!matches) {
16
- throw new Error(PARSE_ERROR_MESSAGE);
17
- }
52
+ if (!nameMatches || !descriptionMatches) {
53
+ throw new Error(PARSE_ERROR_MESSAGE);
54
+ }
18
55
 
19
- const items = matches[0].split("\n\n").map(item => item.trim());
56
+ return {
57
+ keyName: nameMatches[1],
58
+ description: descriptionMatches[1].trim(),
59
+ type: "Web Storage",
60
+ duration: "Persistent",
61
+ purpose: ["Functional"],
62
+ } as const;
63
+ });
20
64
 
21
- const records: (typeof THIRD_PARTY_ITEMS) = [
22
- ...items.map((item) => {
23
- const nameMatches = item.match(/"([^}]+)": /);
24
- const descriptionMatches = item.match(/\/\*\*([^}]+)\*\//);
65
+ // Compare the key SETS, not their sizes: a size check passes whenever two
66
+ // defects cancel out, and it can't name what went missing. This can, and it is
67
+ // the assertion a golden-file test would make.
68
+ const parsedNames = storageRecords.map((record) => record.keyName);
69
+ const missing = declaredNames.filter((n) => parsedNames.indexOf(n) === -1);
70
+ const unexpected = parsedNames.filter((n) => declaredNames.indexOf(n) === -1);
25
71
 
26
- if (!nameMatches || !descriptionMatches) {
27
- throw new Error(PARSE_ERROR_MESSAGE);
28
- }
72
+ if (missing.length > 0 || unexpected.length > 0) {
73
+ throw new Error(
74
+ `${PARSE_ERROR_MESSAGE}: declared but not parsed: [${missing.join(", ")}]; parsed but not declared: [${unexpected.join(", ")}]. Each key needs its own entry separated by an empty line, and no entry may contain a brace (see storage-keys.ts).`,
75
+ );
76
+ }
29
77
 
30
- return {
31
- keyName: nameMatches[1],
32
- description: descriptionMatches[1].trim(),
33
- type: "Web Storage",
34
- duration: "Persistent",
35
- purpose: ["Functional"],
36
- } as const;
37
- }),
38
- ...THIRD_PARTY_ITEMS,
39
- ].sort((a, b) => a.keyName.localeCompare(b.keyName));
78
+ const records: typeof THIRD_PARTY_ITEMS = [
79
+ ...storageRecords,
80
+ ...THIRD_PARTY_ITEMS,
81
+ ].sort((a, b) => a.keyName.localeCompare(b.keyName));
40
82
 
41
- const html = `
83
+ const html = `
42
84
  <html lang="en">
43
85
  <head>
44
86
  <title>Ada client-side storage</title>
@@ -72,24 +114,29 @@ function runScript() {
72
114
  <tr>
73
115
  </thead>
74
116
  <tbody>
75
- ${records.map(record => `
117
+ ${records
118
+ .map(
119
+ (record) => `
76
120
  <tr>
77
121
  <td>${record.keyName}</td>
78
122
  <td>${record.description}</td>
79
- <td>${record.type} (${record.purpose.map(i => i.toLocaleLowerCase()).join(", ")})</td>
123
+ <td>${record.type} (${record.purpose.map((i) => i.toLocaleLowerCase()).join(", ")})</td>
80
124
  <td>${record.duration}</td>
81
125
  </tr>
82
- `).join("\n").trim()}
126
+ `,
127
+ )
128
+ .join("\n")
129
+ .trim()}
83
130
  </tbody>
84
131
  </table>
85
132
  </body>
86
133
  </html>
87
134
  `
88
- .trim()
89
- .replace(/ {2}/g, "")
90
- .replace(/\n+/g, "\n");
135
+ .trim()
136
+ .replace(/ {2}/g, "")
137
+ .replace(/\n+/g, "\n");
91
138
 
92
- writeFileSync(`./${OUTPUT_DIR}/${OUTPUT_FILENAME}`, html);
139
+ writeFileSync(`./${OUTPUT_DIR}/${OUTPUT_FILENAME}`, html);
93
140
  }
94
141
 
95
142
  runScript();
package/src/create-storage.ts CHANGED
@@ -4,70 +4,78 @@ import type { StorageKey, StorageValueByKey } from "./storage-keys";
4
4
  const WEB_STORAGE_ACCESS_ERROR_MESSAGE = "Cannot access Web Storage API";
5
5
 
6
6
  export const createStorage = (storageType: "local" | "session") => {
7
- let storageProvider: Storage;
7
+ let storageProvider: Storage;
8
8
 
9
- // To handle incognito mode. Calling localStorage throws an error when in incognito
10
- try {
11
- storageProvider = storageType === "local" ? localStorage : sessionStorage;
12
- } catch (e) {
13
- console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
14
- }
9
+ // To handle incognito mode. Calling localStorage throws an error when in incognito
10
+ try {
11
+ storageProvider = storageType === "local" ? localStorage : sessionStorage;
12
+ } catch {
13
+ console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
14
+ }
15
15
 
16
- const storage = {
17
- setItem: <K extends StorageKey>(key: K, value: StorageValueByKey[K]): void => {
18
- try {
19
- storageProvider.setItem(key, JSON.stringify(value));
20
- } catch (e) {
21
- console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
22
- }
23
- },
16
+ const storage = {
17
+ setItem: <K extends StorageKey>(
18
+ key: K,
19
+ value: StorageValueByKey[K],
20
+ ): void => {
21
+ try {
22
+ storageProvider.setItem(key, JSON.stringify(value));
23
+ } catch {
24
+ console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
25
+ }
26
+ },
24
27
 
25
- getItem: <K extends StorageKey>(key: K): StorageValueByKey[K] | null => {
26
- try {
27
- const rawStorageValue = storageProvider.getItem(key);
28
+ getItem: <K extends StorageKey>(key: K): StorageValueByKey[K] | null => {
29
+ try {
30
+ const rawStorageValue = storageProvider.getItem(key);
28
31
 
29
- return rawStorageValue && JSON.parse(rawStorageValue);
30
- } catch (e) {
31
- console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
32
+ return rawStorageValue && JSON.parse(rawStorageValue);
33
+ } catch {
34
+ console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
32
35
 
33
- return null;
34
- }
35
- },
36
+ return null;
37
+ }
38
+ },
36
39
 
37
- removeItem: <K extends StorageKey>(key: K): void => {
38
- try {
39
- storageProvider.removeItem(key);
40
- } catch (e) {
41
- console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
42
- }
43
- },
40
+ removeItem: <K extends StorageKey>(key: K): void => {
41
+ try {
42
+ storageProvider.removeItem(key);
43
+ } catch {
44
+ console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
45
+ }
46
+ },
44
47
 
45
- clear: () => {
46
- try {
47
- storageProvider.clear();
48
- } catch (e) {
49
- console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
50
- }
51
- },
48
+ clear: () => {
49
+ try {
50
+ storageProvider.clear();
51
+ } catch {
52
+ console.warn(WEB_STORAGE_ACCESS_ERROR_MESSAGE);
53
+ }
54
+ },
52
55
 
53
- /** Stores a key/value pair within `ada-functional-storage` Storage key */
54
- setFnItem: <K extends keyof AdaFunctionalStorageValue>(key: K, value: AdaFunctionalStorageValue[K]): void => {
55
- const currentValue = storage.getItem("ada-functional-storage") || {};
56
- const newValue = {
57
- ...currentValue,
58
- [key]: value,
59
- };
56
+ /** Stores a key/value pair within `ada-functional-storage` Storage key */
57
+ setFnItem: <K extends keyof AdaFunctionalStorageValue>(
58
+ key: K,
59
+ value: AdaFunctionalStorageValue[K],
60
+ ): void => {
61
+ const currentValue = storage.getItem("ada-functional-storage") || {};
62
+ const newValue = {
63
+ ...currentValue,
64
+ [key]: value,
65
+ };
60
66
 
61
- storage.setItem("ada-functional-storage", newValue);
62
- },
67
+ storage.setItem("ada-functional-storage", newValue);
68
+ },
63
69
 
64
- /** Gets a value under `ada-functional-storage` Storage key */
65
- getFnItem: <K extends keyof AdaFunctionalStorageValue>(key: K): AdaFunctionalStorageValue[K] | null => {
66
- const value = storage.getItem("ada-functional-storage");
70
+ /** Gets a value under `ada-functional-storage` Storage key */
71
+ getFnItem: <K extends keyof AdaFunctionalStorageValue>(
72
+ key: K,
73
+ ): AdaFunctionalStorageValue[K] | null => {
74
+ const value = storage.getItem("ada-functional-storage");
67
75
 
68
- return (value && value[key]) || null;
69
- },
70
- } as const;
76
+ return value?.[key] || null;
77
+ },
78
+ } as const;
71
79
 
72
- return storage;
80
+ return storage;
73
81
  };
package/src/functional-storage.ts CHANGED
@@ -1,23 +1,23 @@
1
1
  export interface AdaFunctionalStorageValue {
2
- rolloutGroup: {
3
- [clientHandle: string]: "A" | "B" | undefined;
4
- };
5
- rolloutLastValue: {
6
- [clientHandle: string]: number | undefined;
7
- };
8
- marketing_campaigns_shown: {
9
- [clientHandle: string]: string | undefined;
10
- };
11
- zdmChatResetCount: {
12
- [clientHandle: string]: number | undefined;
13
- };
14
- botAssignment: {
15
- [clientHandle: string]: "primary" | "alternative" | undefined;
16
- };
17
- proactive_conversations_shown: {
18
- [clientHandle: string]: string | undefined;
19
- };
20
- proactive_conversations_shown_user: {
21
- [clientHandle: string]: string | undefined;
22
- };
2
+ rolloutGroup: {
3
+ [clientHandle: string]: "A" | "B" | undefined;
4
+ };
5
+ rolloutLastValue: {
6
+ [clientHandle: string]: number | undefined;
7
+ };
8
+ marketing_campaigns_shown: {
9
+ [clientHandle: string]: string | undefined;
10
+ };
11
+ zdmChatResetCount: {
12
+ [clientHandle: string]: number | undefined;
13
+ };
14
+ botAssignment: {
15
+ [clientHandle: string]: "primary" | "alternative" | undefined;
16
+ };
17
+ proactive_conversations_shown: {
18
+ [clientHandle: string]: string | undefined;
19
+ };
20
+ proactive_conversations_shown_user: {
21
+ [clientHandle: string]: string | undefined;
22
+ };
23
23
  }
package/src/index.ts CHANGED
@@ -8,13 +8,13 @@ export type AdaStorageValueByKey = StorageValueByKey;
8
8
 
9
9
  /** Checks if Web Storage API is supported */
10
10
  export const isWebStorageSupported = (): boolean => {
11
- try {
12
- const key = "key_to_test_local_storage";
13
- localStorage.setItem(key, key);
14
- localStorage.removeItem(key);
11
+ try {
12
+ const key = "key_to_test_local_storage";
13
+ localStorage.setItem(key, key);
14
+ localStorage.removeItem(key);
15
15
 
16
- return true;
17
- } catch (e) {
18
- return false;
19
- }
16
+ return true;
17
+ } catch {
18
+ return false;
19
+ }
20
20
  };
package/src/storage-keys.ts CHANGED
@@ -6,11 +6,11 @@ import type { AdaFunctionalStorageValue } from "./functional-storage";
6
6
  * interface up to its first `}`, so an inline object value would truncate the parse.
7
7
  */
8
8
  export interface MessagingAuthState {
9
- ownerChatterToken?: string;
10
- messagingToken: string;
11
- messagingTokenExpiresAt: number;
12
- sessionRefreshToken: string;
13
- refreshGeneration: number;
9
+ ownerChatterToken?: string;
10
+ messagingToken: string;
11
+ messagingTokenExpiresAt: number;
12
+ sessionRefreshToken: string;
13
+ refreshGeneration: number;
14
14
  }
15
15
 
16
16
  /**
@@ -20,113 +20,114 @@ export interface MessagingAuthState {
20
20
  *
21
21
  * The interface is being parsed by `./src/cli/generate-html.ts` script.
22
22
  * The format of code here must be consistent, i.e.
23
- * each key should have a comment, the key name must be quoted, and keys must be separated by an empty line.
23
+ * each key should have a comment, and keys must be separated by an empty line.
24
+ * Quoting the key name is optional — the parser accepts either form.
24
25
  */
25
26
  export interface StorageValueByKey {
26
- /** Used to store the Web SDK version assigned to a user. */
27
- "ada-embed-assigned-version": string;
27
+ /** Used to store the Web SDK version assigned to a user. */
28
+ "ada-embed-assigned-version": string;
28
29
 
29
- /** Used to store information about current versions of Web SDK available (“canary” or “stable”). */
30
- "ada-embed-manifest-cache": string;
30
+ /** Used to store information about current versions of Web SDK available (“canary” or “stable”). */
31
+ "ada-embed-manifest-cache": string;
31
32
 
32
- /** Used to store the Chat version assigned to a user. */
33
- "ada-embed_chat-assigned-version": string;
33
+ /** Used to store the Chat version assigned to a user. */
34
+ "ada-embed_chat-assigned-version": string;
34
35
 
35
- /** Used to store information about current versions of Chat available (“canary” or “stable”). */
36
- "ada-embed_chat-manifest-cache": string;
36
+ /** Used to store information about current versions of Chat available (“canary” or “stable”). */
37
+ "ada-embed_chat-manifest-cache": string;
37
38
 
38
- /** Used to determine whether chatter session is expired. */
39
- "ada-embed_chatter-created": string;
39
+ /** Used to determine whether chatter session is expired. */
40
+ "ada-embed_chatter-created": string;
40
41
 
41
- /** Used to determine if the drawer was opened previously so when users navigate to other pages we can automatically open chat. */
42
- "ada-embed_is-drawer-open": boolean;
42
+ /** Used to determine if the drawer was opened previously so when users navigate to other pages we can automatically open chat. */
43
+ "ada-embed_is-drawer-open": boolean;
43
44
 
44
- /** Used to cache Zendesk tags assigned to a conversation. */
45
- "ada-embed_zd-previous-tags": string;
45
+ /** Used to cache Zendesk tags assigned to a conversation. */
46
+ "ada-embed_zd-previous-tags": string;
46
47
 
47
- /** Stores Zendesk session id. */
48
- "ada-embed_zd-session-id": string;
48
+ /** Stores Zendesk session id. */
49
+ "ada-embed_zd-session-id": string;
49
50
 
50
- /** Used to determine whether Zendesk session is expired. */
51
- "ada-embed_zd-messaging-chatter-created": string;
51
+ /** Used to determine whether Zendesk session is expired. */
52
+ "ada-embed_zd-messaging-chatter-created": string;
52
53
 
53
- /** Stores Zendesk internal user id. */
54
- "ada-embed_zd-messaging-external-user-id": string;
54
+ /** Stores Zendesk internal user id. */
55
+ "ada-embed_zd-messaging-external-user-id": string;
55
56
 
56
- /** Used to store general information about Ada application state. */
57
- "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
57
+ /** Used to store general information about Ada application state. */
58
+ "ada-functional-storage": Partial<AdaFunctionalStorageValue>;
58
59
 
59
- /** Used to identify the user within Ada. */
60
- "chatter": string;
60
+ /** Used to identify the user within Ada. */
61
+ chatter: string;
61
62
 
62
- /** Used to determine whether chatter session is expired. This is stored on Ada domain. */
63
- "created": string;
63
+ /** Used to determine whether chatter session is expired. This is stored on Ada domain. */
64
+ created: string;
64
65
 
65
- /** Used for live chat messaging functionality. */
66
- "delayMessageAfterLiveChatEndTimeStamp": number;
66
+ /** Used for live chat messaging functionality. */
67
+ delayMessageAfterLiveChatEndTimeStamp: number;
67
68
 
68
- /** Indicates whether user is connected to a live agent. */
69
- "inLiveChat": boolean;
69
+ /** Indicates whether user is connected to a live agent. */
70
+ inLiveChat: boolean;
70
71
 
71
- /** Indicates whether user is waiting to connect to a live agent. */
72
- "liveChatPending": boolean;
72
+ /** Indicates whether user is waiting to connect to a live agent. */
73
+ liveChatPending: boolean;
73
74
 
74
- /** Used to implement Chat reconnection after an interruption. */
75
- "netDisruptionMsgStartTime": number;
75
+ /** Used to implement Chat reconnection after an interruption. */
76
+ netDisruptionMsgStartTime: number;
76
77
 
77
- /** Stores Chat iFrame parent window origin. */
78
- "parentOrigin": string;
78
+ /** Stores Chat iFrame parent window origin. */
79
+ parentOrigin: string;
79
80
 
80
- /** Used to cache Zendesk tags assigned to a conversation. This is stored on Ada domain. */
81
- "previousZDTags": string;
81
+ /** Used to cache Zendesk tags assigned to a conversation. This is stored on Ada domain. */
82
+ previousZDTags: string;
82
83
 
83
- /** Used for Zendesk authentication functionality. */
84
- "previouslyAuthenticated": boolean;
84
+ /** Used for Zendesk authentication functionality. */
85
+ previouslyAuthenticated: boolean;
85
86
 
86
- /** Used for chatter authentication. */
87
- "ada-embed_session-token": string;
87
+ /** Used for chatter authentication. */
88
+ "ada-embed_session-token": string;
88
89
 
89
- /** Stores the messaging authentication state (its owner chatter, a short-lived messaging access token and expiry, a rotating session refresh token, and a refresh counter) used to authenticate the visitor's generative chat session with Ada. Set on the bot's Ada subdomain. */
90
- "messagingAuthState": MessagingAuthState;
90
+ /** Stores the messaging authentication state (its owner chatter, a short-lived messaging access token and expiry, a rotating session refresh token, and a refresh counter) used to authenticate the visitor's generative chat session with Ada. Set on the bot's Ada subdomain. */
91
+ messagingAuthState: MessagingAuthState;
91
92
 
92
- /** Used to implement Chat reconnection after an interruption. */
93
- "backoffTimeout": number;
93
+ /** Used to implement Chat reconnection after an interruption. */
94
+ backoffTimeout: number;
94
95
 
95
- /** 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. */
96
- "secretButton": string;
96
+ /** 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. */
97
+ secretButton: string;
97
98
 
98
- /** Used to keep the builder session active for 24 hours before authentication is required again. Note this is only added if a chatter has logged into the dashboard. */
99
- "session": string;
99
+ /** Used to keep the builder session active for 24 hours before authentication is required again. Note this is only added if a chatter has logged into the dashboard. */
100
+ session: string;
100
101
 
101
- /** Used for chatter authentication. This is stored on Ada domain. */
102
- "sessionToken": string;
102
+ /** Used for chatter authentication. This is stored on Ada domain. */
103
+ sessionToken: string;
103
104
 
104
- /** Used to default the test bot to the previously tested modality */
105
- "testBotModality": "messaging" | "voice" | undefined;
105
+ /** Used to default the test bot to the previously tested modality */
106
+ testBotModality: "messaging" | "voice" | undefined;
106
107
 
107
- /** Used for voice chat functionality in the bot builder dashboard */
108
- "testBotPhoneNumber": string;
108
+ /** Used for voice chat functionality in the bot builder dashboard */
109
+ testBotPhoneNumber: string;
109
110
 
110
- /** Used for Zendesk authentication functionality. */
111
- "zdAuthChatPending": boolean;
111
+ /** Used for Zendesk authentication functionality. */
112
+ zdAuthChatPending: boolean;
112
113
 
113
- /** Used for Zendesk SDK functionality. */
114
- "zdCid": string;
114
+ /** Used for Zendesk SDK functionality. */
115
+ zdCid: string;
115
116
 
116
- /** Used for Zendesk SDK functionality. */
117
- "zdCStore": string;
117
+ /** Used for Zendesk SDK functionality. */
118
+ zdCStore: string;
118
119
 
119
- /** Used for Zendesk SDK functionality. */
120
- "zdMessagingExternalUserId": string;
120
+ /** Used for Zendesk SDK functionality. */
121
+ zdMessagingExternalUserId: string;
121
122
 
122
- /** Used for Zendesk SDK functionality. */
123
- "zdMessagingChatterCreated": string;
123
+ /** Used for Zendesk SDK functionality. */
124
+ zdMessagingChatterCreated: string;
124
125
 
125
- /** Used for Zendesk SDK functionality. */
126
- "zdSessionId": string;
126
+ /** Used for Zendesk SDK functionality. */
127
+ zdSessionId: string;
127
128
 
128
- /** Used for Zendesk authentication functionality. */
129
- "zd_isChatterAuthenticated": boolean;
129
+ /** Used for Zendesk authentication functionality. */
130
+ zd_isChatterAuthenticated: boolean;
130
131
  }
131
132
 
132
133
  export type StorageKey = keyof StorageValueByKey;
package/src/third-party-items.ts CHANGED
@@ -1,9 +1,11 @@
1
1
  interface WebStorageItem {
2
- keyName: string;
3
- description: string;
4
- type: "Web Storage" | "Cookie";
5
- purpose: ReadonlyArray<"Essential" | "Functional" | "Security" | "Analytics" | "Marketing">;
6
- duration: string;
2
+ keyName: string;
3
+ description: string;
4
+ type: "Web Storage" | "Cookie";
5
+ purpose: ReadonlyArray<
6
+ "Essential" | "Functional" | "Security" | "Analytics" | "Marketing"
7
+ >;
8
+ duration: string;
7
9
  }
8
10
 
9
11
  /**
@@ -11,204 +13,209 @@ interface WebStorageItem {
11
13
  * but must include in the list: https://static.ada.support/ada-web-storage-list.html
12
14
  */
13
15
  export const THIRD_PARTY_ITEMS: WebStorageItem[] = [
14
- {
15
- keyName: "vuid",
16
- description: "Used by Vimeo to store the user’s usage history (loaded only if a video has been included).",
17
- type: "Cookie",
18
- duration: "2 Years",
19
- purpose: ["Functional"],
20
- },
21
- {
22
- keyName: "_dd_s",
23
- description: "Used to monitor user sessions for DataDog RUM Tracking.",
24
- type: "Cookie",
25
- duration: "10-15 Minutes",
26
- purpose: ["Functional", "Security"],
27
- },
28
- {
29
- keyName: "fs_uid",
30
- description: "Used to identify and distinguish data for each user",
31
- type: "Cookie",
32
- duration: "3 Months",
33
- purpose: ["Analytics"],
34
- },
35
- {
36
- keyName: "pusherTransportTLS",
37
- description: "Used by Pusher API for realtime messaging.",
38
- type: "Web Storage",
39
- duration: "Persistent",
40
- purpose: ["Essential"],
41
- },
42
- {
43
- keyName: "__cfruid",
44
- description: "Used by Zendesk Messaging to filter malicious web traffic through Cloudflare",
45
- type: "Cookie",
46
- duration: "Session (as long as the browser application is open)",
47
- purpose: ["Essential"],
48
- },
49
- {
50
- keyName: "_MUTEX_LOCK_X_zendeskSessionLock",
51
- description: "Used by FastMutex for Zendesk Chat sessions.",
52
- type: "Web Storage",
53
- duration: "Duration of live agent chat",
54
- purpose: ["Essential"],
55
- },
56
- {
57
- keyName: "__Secure-[alphanumeric ID]",
58
- description: "Used by Youtube to deliver relevant advertisements",
59
- type: "Cookie",
60
- duration: "1 Year",
61
- purpose: ["Marketing"],
62
- },
63
- {
64
- keyName: "HSID",
65
- description: "Youtube uses this cookie for security purposes in order to block many types of web attacks",
66
- type: "Cookie",
67
- duration: "1 Year",
68
- purpose: ["Security"],
69
- },
70
- {
71
- keyName: "SSID",
72
- description: "Youtube uses this cookie for security purposes in order to block many types of web attacks",
73
- type: "Cookie",
74
- duration: "1 Year",
75
- purpose: ["Security"],
76
- },
77
- {
78
- keyName: "VISITOR_INFO1_LIVE",
79
- description: "Used by Youtube to evaluate the user's network capabilities",
80
- type: "Cookie",
81
- duration: "6 months",
82
- purpose: ["Functional"],
83
- },
84
- {
85
- keyName: "PREF",
86
- description: "Used by Youtube to store user preferences",
87
- type: "Cookie",
88
- duration: "8 months",
89
- purpose: ["Marketing"],
90
- },
91
- {
92
- keyName: "SIDCC",
93
- description: "Used by Youtube to identify trusted web traffic",
94
- type: "Cookie",
95
- duration: "1 Year",
96
- purpose: ["Security"],
97
- },
98
- {
99
- keyName: "YSC",
100
- description: "Used by Youtube to store user interactions",
101
- type: "Cookie",
102
- duration: "Session (as long as the browser application is open)",
103
- purpose: ["Marketing"],
104
- },
105
- {
106
- keyName: "SID",
107
- description: "Used by Youtube to provide advertisement targeting",
108
- type: "Cookie",
109
- duration: "2 Years",
110
- purpose: ["Marketing"],
111
- },
112
- {
113
- keyName: "SAPISID",
114
- description: "Used by Youtube to link content to your Google account",
115
- type: "Cookie",
116
- duration: "2 Years",
117
- purpose: ["Analytics"],
118
- },
119
- {
120
- keyName: "APISID",
121
- description: "Used by Youtube to gather information on played videos",
122
- type: "Cookie",
123
- duration: "1 Year",
124
- purpose: ["Analytics"],
125
- },
126
- {
127
- keyName: "wide",
128
- description: "Used by Youtube to store user preferences",
129
- type: "Cookie",
130
- duration: "Session (as long as the browser application is open)",
131
- purpose: ["Functional"],
132
- },
133
- {
134
- keyName: "__cf_bm",
135
- description: "Used by Vimeo to filter bots",
136
- type: "Cookie",
137
- duration: "1 Year",
138
- purpose: ["Analytics"],
139
- },
140
- {
141
- keyName: "_GRECAPTCHA",
142
- description: "Used by Calendly to prevent spamming",
143
- type: "Cookie",
144
- duration: "6 months",
145
- purpose: ["Functional"],
146
- },
147
- {
148
- keyName: "_ga",
149
- description: "Used by Calendly to track page views",
150
- type: "Cookie",
151
- duration: "1 Year",
152
- purpose: ["Analytics"],
153
- },
154
- {
155
- keyName: "_hp2_id.[user_id]",
156
- description: "Used by Calendly to gather page interactions of users",
157
- type: "Cookie",
158
- duration: "1 Year",
159
- purpose: ["Analytics"],
160
- },
161
- {
162
- keyName: "_calendly_session",
163
- description: "Used by Calendly to store user's preferences",
164
- type: "Cookie",
165
- duration: "15 days",
166
- purpose: ["Functional"],
167
- },
168
- {
169
- keyName: "__stripe_mid",
170
- description: "Used by Calendly to prevent fraudulent transactions",
171
- type: "Cookie",
172
- duration: "1 Year",
173
- purpose: ["Functional"],
174
- },
175
- {
176
- keyName: "OptanonAlertBoxClosed",
177
- description: "Used by Calendly to store OneTrust cookie consent preferences",
178
- type: "Cookie",
179
- duration: "1 Year",
180
- purpose: ["Functional"],
181
- },
182
- {
183
- keyName: "OptanonConsent",
184
- description: "Used by Calendly to store OneTrust cookie consent preferences",
185
- type: "Cookie",
186
- duration: "2 Year",
187
- purpose: ["Functional"],
188
- },
189
- {
190
- keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]",
191
- description:
192
- "Used by LaunchDarkly to cache feature flag values for the chat widget. Scoped per bot (client_handle), not per end-user.",
193
- type: "Web Storage",
194
- duration: "Persistent",
195
- purpose: ["Functional"],
196
- },
197
- {
198
- keyName: "LaunchDarkly_[alphanumeric ID]_ContextIndex",
199
- description:
200
- "Used by LaunchDarkly to index evaluation contexts (bots) that have fetched feature flags for the chat widget.",
201
- type: "Web Storage",
202
- duration: "Persistent",
203
- purpose: ["Functional"],
204
- },
205
- {
206
- keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]_freshness",
207
- description:
208
- "Used by LaunchDarkly to record when the associated cached feature flag values were last refreshed. Paired with the flag cache entry.",
209
- type: "Web Storage",
210
- duration: "Persistent",
211
- purpose: ["Functional"],
212
- },
213
-
16
+ {
17
+ keyName: "vuid",
18
+ description:
19
+ "Used by Vimeo to store the user’s usage history (loaded only if a video has been included).",
20
+ type: "Cookie",
21
+ duration: "2 Years",
22
+ purpose: ["Functional"],
23
+ },
24
+ {
25
+ keyName: "_dd_s",
26
+ description: "Used to monitor user sessions for DataDog RUM Tracking.",
27
+ type: "Cookie",
28
+ duration: "10-15 Minutes",
29
+ purpose: ["Functional", "Security"],
30
+ },
31
+ {
32
+ keyName: "fs_uid",
33
+ description: "Used to identify and distinguish data for each user",
34
+ type: "Cookie",
35
+ duration: "3 Months",
36
+ purpose: ["Analytics"],
37
+ },
38
+ {
39
+ keyName: "pusherTransportTLS",
40
+ description: "Used by Pusher API for realtime messaging.",
41
+ type: "Web Storage",
42
+ duration: "Persistent",
43
+ purpose: ["Essential"],
44
+ },
45
+ {
46
+ keyName: "__cfruid",
47
+ description:
48
+ "Used by Zendesk Messaging to filter malicious web traffic through Cloudflare",
49
+ type: "Cookie",
50
+ duration: "Session (as long as the browser application is open)",
51
+ purpose: ["Essential"],
52
+ },
53
+ {
54
+ keyName: "_MUTEX_LOCK_X_zendeskSessionLock",
55
+ description: "Used by FastMutex for Zendesk Chat sessions.",
56
+ type: "Web Storage",
57
+ duration: "Duration of live agent chat",
58
+ purpose: ["Essential"],
59
+ },
60
+ {
61
+ keyName: "__Secure-[alphanumeric ID]",
62
+ description: "Used by Youtube to deliver relevant advertisements",
63
+ type: "Cookie",
64
+ duration: "1 Year",
65
+ purpose: ["Marketing"],
66
+ },
67
+ {
68
+ keyName: "HSID",
69
+ description:
70
+ "Youtube uses this cookie for security purposes in order to block many types of web attacks",
71
+ type: "Cookie",
72
+ duration: "1 Year",
73
+ purpose: ["Security"],
74
+ },
75
+ {
76
+ keyName: "SSID",
77
+ description:
78
+ "Youtube uses this cookie for security purposes in order to block many types of web attacks",
79
+ type: "Cookie",
80
+ duration: "1 Year",
81
+ purpose: ["Security"],
82
+ },
83
+ {
84
+ keyName: "VISITOR_INFO1_LIVE",
85
+ description: "Used by Youtube to evaluate the user's network capabilities",
86
+ type: "Cookie",
87
+ duration: "6 months",
88
+ purpose: ["Functional"],
89
+ },
90
+ {
91
+ keyName: "PREF",
92
+ description: "Used by Youtube to store user preferences",
93
+ type: "Cookie",
94
+ duration: "8 months",
95
+ purpose: ["Marketing"],
96
+ },
97
+ {
98
+ keyName: "SIDCC",
99
+ description: "Used by Youtube to identify trusted web traffic",
100
+ type: "Cookie",
101
+ duration: "1 Year",
102
+ purpose: ["Security"],
103
+ },
104
+ {
105
+ keyName: "YSC",
106
+ description: "Used by Youtube to store user interactions",
107
+ type: "Cookie",
108
+ duration: "Session (as long as the browser application is open)",
109
+ purpose: ["Marketing"],
110
+ },
111
+ {
112
+ keyName: "SID",
113
+ description: "Used by Youtube to provide advertisement targeting",
114
+ type: "Cookie",
115
+ duration: "2 Years",
116
+ purpose: ["Marketing"],
117
+ },
118
+ {
119
+ keyName: "SAPISID",
120
+ description: "Used by Youtube to link content to your Google account",
121
+ type: "Cookie",
122
+ duration: "2 Years",
123
+ purpose: ["Analytics"],
124
+ },
125
+ {
126
+ keyName: "APISID",
127
+ description: "Used by Youtube to gather information on played videos",
128
+ type: "Cookie",
129
+ duration: "1 Year",
130
+ purpose: ["Analytics"],
131
+ },
132
+ {
133
+ keyName: "wide",
134
+ description: "Used by Youtube to store user preferences",
135
+ type: "Cookie",
136
+ duration: "Session (as long as the browser application is open)",
137
+ purpose: ["Functional"],
138
+ },
139
+ {
140
+ keyName: "__cf_bm",
141
+ description: "Used by Vimeo to filter bots",
142
+ type: "Cookie",
143
+ duration: "1 Year",
144
+ purpose: ["Analytics"],
145
+ },
146
+ {
147
+ keyName: "_GRECAPTCHA",
148
+ description: "Used by Calendly to prevent spamming",
149
+ type: "Cookie",
150
+ duration: "6 months",
151
+ purpose: ["Functional"],
152
+ },
153
+ {
154
+ keyName: "_ga",
155
+ description: "Used by Calendly to track page views",
156
+ type: "Cookie",
157
+ duration: "1 Year",
158
+ purpose: ["Analytics"],
159
+ },
160
+ {
161
+ keyName: "_hp2_id.[user_id]",
162
+ description: "Used by Calendly to gather page interactions of users",
163
+ type: "Cookie",
164
+ duration: "1 Year",
165
+ purpose: ["Analytics"],
166
+ },
167
+ {
168
+ keyName: "_calendly_session",
169
+ description: "Used by Calendly to store user's preferences",
170
+ type: "Cookie",
171
+ duration: "15 days",
172
+ purpose: ["Functional"],
173
+ },
174
+ {
175
+ keyName: "__stripe_mid",
176
+ description: "Used by Calendly to prevent fraudulent transactions",
177
+ type: "Cookie",
178
+ duration: "1 Year",
179
+ purpose: ["Functional"],
180
+ },
181
+ {
182
+ keyName: "OptanonAlertBoxClosed",
183
+ description:
184
+ "Used by Calendly to store OneTrust cookie consent preferences",
185
+ type: "Cookie",
186
+ duration: "1 Year",
187
+ purpose: ["Functional"],
188
+ },
189
+ {
190
+ keyName: "OptanonConsent",
191
+ description:
192
+ "Used by Calendly to store OneTrust cookie consent preferences",
193
+ type: "Cookie",
194
+ duration: "2 Year",
195
+ purpose: ["Functional"],
196
+ },
197
+ {
198
+ keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]",
199
+ description:
200
+ "Used by LaunchDarkly to cache feature flag values for the chat widget. Scoped per bot (client_handle), not per end-user.",
201
+ type: "Web Storage",
202
+ duration: "Persistent",
203
+ purpose: ["Functional"],
204
+ },
205
+ {
206
+ keyName: "LaunchDarkly_[alphanumeric ID]_ContextIndex",
207
+ description:
208
+ "Used by LaunchDarkly to index evaluation contexts (bots) that have fetched feature flags for the chat widget.",
209
+ type: "Web Storage",
210
+ duration: "Persistent",
211
+ purpose: ["Functional"],
212
+ },
213
+ {
214
+ keyName: "LaunchDarkly_[alphanumeric ID]_[alphanumeric ID]_freshness",
215
+ description:
216
+ "Used by LaunchDarkly to record when the associated cached feature flag values were last refreshed. Paired with the flag cache entry.",
217
+ type: "Web Storage",
218
+ duration: "Persistent",
219
+ purpose: ["Functional"],
220
+ },
214
221
  ];
package/.eslintignore DELETED
@@ -1,2 +0,0 @@
1
- dist/
2
- node_modules/
package/.eslintrc DELETED
@@ -1,10 +0,0 @@
1
- {
2
- "root": true,
3
- "extends": [
4
- "@ada-support/eslint-config-ada"
5
- ],
6
- "parser": "@typescript-eslint/parser",
7
- "parserOptions": {
8
- "project": "./tsconfig.json"
9
- }
10
- }