@buildinams/tracking 0.3.0 → 0.4.0
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/README.md +72 -83
- package/dist/{sources/cart → cart}/index.d.ts +4 -4
- package/dist/{sources/cart → cart}/index.js +13 -3
- package/dist/cart/index.js.map +1 -0
- package/dist/chunk-JZ6HFGVJ.js +163 -0
- package/dist/chunk-JZ6HFGVJ.js.map +1 -0
- package/dist/{compatibility-Dc1JmTeG.d.ts → compatibility-wHn2I_ws.d.ts} +2 -2
- package/dist/{consent/index.d.ts → consent-types-DgKtGapr.d.ts} +1 -1
- package/dist/{consent/cookiebot → cookiebot}/index.d.ts +1 -1
- package/dist/{consent/cookiebot → cookiebot}/index.js +1 -1
- package/dist/cookiebot/index.js.map +1 -0
- package/dist/destination-types-DNMBOW_e.d.ts +22 -0
- package/dist/devtools/index.d.ts +18 -0
- package/dist/devtools/index.js +299 -0
- package/dist/devtools/index.js.map +1 -0
- package/dist/{sources/dom → dom}/index.d.ts +28 -38
- package/dist/{sources/dom → dom}/index.js +123 -245
- package/dist/dom/index.js.map +1 -0
- package/dist/events/index.d.ts +3 -6
- package/dist/events/index.js +5 -4
- package/dist/events/index.js.map +1 -1
- package/dist/flow/index.d.ts +10 -8
- package/dist/flow/index.js +16 -4
- package/dist/flow/index.js.map +1 -1
- package/dist/{consent/google → google}/index.d.ts +15 -2
- package/dist/{consent/google → google}/index.js +19 -6
- package/dist/google/index.js.map +1 -0
- package/dist/{page → navigation}/index.d.ts +7 -12
- package/dist/{page → navigation}/index.js +4 -10
- package/dist/navigation/index.js.map +1 -0
- package/dist/{consent/onetrust → onetrust}/index.d.ts +1 -1
- package/dist/{consent/onetrust → onetrust}/index.js +1 -1
- package/dist/onetrust/index.js.map +1 -0
- package/dist/shopify/index.d.ts +45 -0
- package/dist/{consent/shopify → shopify}/index.js +18 -5
- package/dist/shopify/index.js.map +1 -0
- package/dist/{sources/index.d.ts → source-types-fJXZeF2Q.d.ts} +1 -1
- package/dist/{types-DfPz7mBl.d.ts → types-CZEg03xW.d.ts} +3 -7
- package/docs/annotations.md +72 -22
- package/docs/context.md +14 -14
- package/docs/decisions/001-vendor-neutral-event-pipeline.md +2 -2
- package/docs/decisions/002-data-per-annotation-word.md +34 -0
- package/docs/events.md +86 -81
- package/docs/setup.md +63 -28
- package/package.json +41 -76
- package/dist/chunk-MRBVRDP6.js +0 -6
- package/dist/chunk-MRBVRDP6.js.map +0 -1
- package/dist/consent/cookiebot/index.js.map +0 -1
- package/dist/consent/google/index.js.map +0 -1
- package/dist/consent/index.js +0 -3
- package/dist/consent/index.js.map +0 -1
- package/dist/consent/onetrust/index.js.map +0 -1
- package/dist/consent/shopify/index.d.ts +0 -19
- package/dist/consent/shopify/index.js.map +0 -1
- package/dist/destinations/ga4/index.d.ts +0 -16
- package/dist/destinations/ga4/index.js +0 -17
- package/dist/destinations/ga4/index.js.map +0 -1
- package/dist/destinations/index.d.ts +0 -9
- package/dist/destinations/index.js +0 -17
- package/dist/destinations/index.js.map +0 -1
- package/dist/destinations/shopify/index.d.ts +0 -12
- package/dist/destinations/shopify/index.js +0 -18
- package/dist/destinations/shopify/index.js.map +0 -1
- package/dist/page/index.js.map +0 -1
- package/dist/sources/cart/index.js.map +0 -1
- package/dist/sources/cart/shopify/index.d.ts +0 -28
- package/dist/sources/cart/shopify/index.js +0 -16
- package/dist/sources/cart/shopify/index.js.map +0 -1
- package/dist/sources/dom/index.js.map +0 -1
- package/dist/sources/index.js +0 -3
- package/dist/sources/index.js.map +0 -1
- package/dist/types-BfJsv8AV.d.ts +0 -30
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
import { ROLES, FLAGS, DATA_ATTRIBUTES, AUTO_ATTRIBUTE, CLONE_ATTRIBUTE, IGNORE_ATTRIBUTE, ANNOTATION_ATTRIBUTE, IGNORED, isIgnored, hasWord, isRole, roleSelector, parse, DATA_WORDS, dataAttribute, readAnnotated } from '../chunk-JZ6HFGVJ.js';
|
|
2
|
+
import '../chunk-KLN5K6PR.js';
|
|
3
|
+
|
|
4
|
+
// src/dom/check-annotations.ts
|
|
5
|
+
var WORDS = [...ROLES, ...FLAGS];
|
|
6
|
+
var PREFIX = `${ANNOTATION_ATTRIBUTE}-`;
|
|
7
|
+
var KNOWN_ATTRIBUTES = [
|
|
8
|
+
...DATA_ATTRIBUTES,
|
|
9
|
+
AUTO_ATTRIBUTE,
|
|
10
|
+
CLONE_ATTRIBUTE,
|
|
11
|
+
IGNORE_ATTRIBUTE
|
|
12
|
+
];
|
|
13
|
+
var checkElement = (element, issues) => {
|
|
14
|
+
const report = (code, message) => issues.push({ code, element, message });
|
|
15
|
+
if (isIgnored(element)) {
|
|
16
|
+
if (element.hasAttribute(AUTO_ATTRIBUTE))
|
|
17
|
+
report(
|
|
18
|
+
"auto-in-ignored",
|
|
19
|
+
`${AUTO_ATTRIBUTE} has no effect inside ${IGNORE_ATTRIBUTE}: nothing there is tracked.`
|
|
20
|
+
);
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
for (const word of (element.getAttribute(ANNOTATION_ATTRIBUTE) ?? "").split(/\s+/).filter(Boolean))
|
|
24
|
+
if (!WORDS.includes(word))
|
|
25
|
+
report(
|
|
26
|
+
"unknown-word",
|
|
27
|
+
`"${word}" in ${ANNOTATION_ATTRIBUTE} isn't a Role (${ROLES.join(", ")}) or Flag (${FLAGS.join(", ")}).`
|
|
28
|
+
);
|
|
29
|
+
if (hasWord(element, "detail") && !hasWord(element, "item"))
|
|
30
|
+
report(
|
|
31
|
+
"detail-without-item",
|
|
32
|
+
`"detail" only applies to an Item: use ${ANNOTATION_ATTRIBUTE}="item detail".`
|
|
33
|
+
);
|
|
34
|
+
for (const { name, value } of element.attributes) {
|
|
35
|
+
if (!name.startsWith(PREFIX)) continue;
|
|
36
|
+
if (!KNOWN_ATTRIBUTES.includes(name)) {
|
|
37
|
+
report(
|
|
38
|
+
"unknown-attribute",
|
|
39
|
+
`${name} isn't read: Data attributes are ${DATA_ATTRIBUTES.join(", ")}.`
|
|
40
|
+
);
|
|
41
|
+
continue;
|
|
42
|
+
}
|
|
43
|
+
if (name === AUTO_ATTRIBUTE || name === CLONE_ATTRIBUTE || name === IGNORE_ATTRIBUTE)
|
|
44
|
+
continue;
|
|
45
|
+
const word = name.slice(PREFIX.length);
|
|
46
|
+
const own = !isRole(word) || hasWord(element, word) || word === "form" && element instanceof HTMLFormElement;
|
|
47
|
+
if (!own && !element.closest(roleSelector(word))) {
|
|
48
|
+
report(
|
|
49
|
+
"orphan-field",
|
|
50
|
+
`${name} is a field of the nearest ${word} above it, and there is none.`
|
|
51
|
+
);
|
|
52
|
+
continue;
|
|
53
|
+
}
|
|
54
|
+
for (const { key, value: fieldValue } of parse(value)) {
|
|
55
|
+
if (fieldValue !== void 0) continue;
|
|
56
|
+
if (own)
|
|
57
|
+
report(
|
|
58
|
+
"ignored-key",
|
|
59
|
+
`"${key}" in ${name} has no value; only a field on a descendant reads its text.`
|
|
60
|
+
);
|
|
61
|
+
else if (!element.textContent?.trim())
|
|
62
|
+
report("empty-field", `Field "${key}" in ${name} has no text.`);
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
var checkAnnotation = (element) => {
|
|
67
|
+
const issues = [];
|
|
68
|
+
checkElement(element, issues);
|
|
69
|
+
return issues;
|
|
70
|
+
};
|
|
71
|
+
var checkAnnotations = (root = document) => {
|
|
72
|
+
const issues = [];
|
|
73
|
+
if (root instanceof Element) checkElement(root, issues);
|
|
74
|
+
for (const element of root.querySelectorAll("*"))
|
|
75
|
+
checkElement(element, issues);
|
|
76
|
+
return issues;
|
|
77
|
+
};
|
|
78
|
+
var CHECK_DELAY = 500;
|
|
79
|
+
var watchAnnotations = () => {
|
|
80
|
+
const warned = /* @__PURE__ */ new WeakMap();
|
|
81
|
+
const check = () => {
|
|
82
|
+
for (const issue of checkAnnotations()) {
|
|
83
|
+
let seen = warned.get(issue.element);
|
|
84
|
+
if (!seen) warned.set(issue.element, seen = /* @__PURE__ */ new Set());
|
|
85
|
+
if (seen.has(issue.message)) continue;
|
|
86
|
+
seen.add(issue.message);
|
|
87
|
+
console.warn(`[tracking] ${issue.message}`, issue.element);
|
|
88
|
+
}
|
|
89
|
+
};
|
|
90
|
+
let timer;
|
|
91
|
+
const schedule = () => {
|
|
92
|
+
clearTimeout(timer);
|
|
93
|
+
timer = setTimeout(check, CHECK_DELAY);
|
|
94
|
+
};
|
|
95
|
+
const observer = new MutationObserver(schedule);
|
|
96
|
+
observer.observe(document.documentElement, {
|
|
97
|
+
childList: true,
|
|
98
|
+
subtree: true,
|
|
99
|
+
attributes: true,
|
|
100
|
+
attributeFilter: [ANNOTATION_ATTRIBUTE, ...KNOWN_ATTRIBUTES]
|
|
101
|
+
});
|
|
102
|
+
schedule();
|
|
103
|
+
return () => {
|
|
104
|
+
observer.disconnect();
|
|
105
|
+
clearTimeout(timer);
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
|
|
109
|
+
// src/dom/inspect.ts
|
|
110
|
+
var ANNOTATED_SELECTOR = [
|
|
111
|
+
`[${ANNOTATION_ATTRIBUTE}]`,
|
|
112
|
+
IGNORED,
|
|
113
|
+
...DATA_ATTRIBUTES.map((attribute) => `[${attribute}]`)
|
|
114
|
+
].join(", ");
|
|
115
|
+
var inspect = (element) => {
|
|
116
|
+
const ignoredBy = element.closest(IGNORED) ?? void 0;
|
|
117
|
+
if (ignoredBy)
|
|
118
|
+
return {
|
|
119
|
+
ignoredBy,
|
|
120
|
+
words: {},
|
|
121
|
+
fields: {},
|
|
122
|
+
issues: checkAnnotation(element)
|
|
123
|
+
};
|
|
124
|
+
const words = {};
|
|
125
|
+
const fields = {};
|
|
126
|
+
for (const word of DATA_WORDS) {
|
|
127
|
+
const declared = hasWord(element, word);
|
|
128
|
+
if (!declared && !element.hasAttribute(dataAttribute(word))) continue;
|
|
129
|
+
if (declared || !isRole(word)) {
|
|
130
|
+
words[word] = readAnnotated(element, word);
|
|
131
|
+
continue;
|
|
132
|
+
}
|
|
133
|
+
const owner = element.closest(roleSelector(word));
|
|
134
|
+
if (owner) fields[word] = owner;
|
|
135
|
+
}
|
|
136
|
+
return { words, fields, issues: checkAnnotation(element) };
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
// src/devtools/inspector.ts
|
|
140
|
+
var ISSUE_ATTRIBUTE = "data-tracking-inspector-issue";
|
|
141
|
+
var RECHECK_DELAY = 300;
|
|
142
|
+
var STYLE = `
|
|
143
|
+
[${ANNOTATION_ATTRIBUTE}] { outline: 1px dashed #7c3aed; outline-offset: -1px; }
|
|
144
|
+
[${ISSUE_ATTRIBUTE}] { outline: 2px solid #dc2626; outline-offset: -2px; }
|
|
145
|
+
${IGNORED} { outline: 2px dashed #9ca3af; outline-offset: -2px; }
|
|
146
|
+
${IGNORED} [${ANNOTATION_ATTRIBUTE}] { outline-color: #9ca3af; }
|
|
147
|
+
`;
|
|
148
|
+
var create = (tag, style, text) => {
|
|
149
|
+
const element = document.createElement(tag);
|
|
150
|
+
Object.assign(element.style, style);
|
|
151
|
+
if (text !== void 0) element.textContent = text;
|
|
152
|
+
return element;
|
|
153
|
+
};
|
|
154
|
+
var box = (color) => create("div", {
|
|
155
|
+
position: "fixed",
|
|
156
|
+
pointerEvents: "none",
|
|
157
|
+
zIndex: "2147483646",
|
|
158
|
+
border: `2px solid ${color}`,
|
|
159
|
+
background: `${color}1a`,
|
|
160
|
+
display: "none"
|
|
161
|
+
});
|
|
162
|
+
var place = (highlight, element) => {
|
|
163
|
+
if (!element) {
|
|
164
|
+
highlight.style.display = "none";
|
|
165
|
+
return;
|
|
166
|
+
}
|
|
167
|
+
const { top, left, width, height } = element.getBoundingClientRect();
|
|
168
|
+
Object.assign(highlight.style, {
|
|
169
|
+
display: "block",
|
|
170
|
+
top: `${top}px`,
|
|
171
|
+
left: `${left}px`,
|
|
172
|
+
width: `${width}px`,
|
|
173
|
+
height: `${height}px`
|
|
174
|
+
});
|
|
175
|
+
};
|
|
176
|
+
var describe = (element) => {
|
|
177
|
+
const words = element.getAttribute(ANNOTATION_ATTRIBUTE);
|
|
178
|
+
return `<${element.tagName.toLowerCase()}${words ? ` ${ANNOTATION_ATTRIBUTE}="${words}"` : ""}>`;
|
|
179
|
+
};
|
|
180
|
+
var showInspector = () => {
|
|
181
|
+
const style = document.createElement("style");
|
|
182
|
+
style.textContent = STYLE;
|
|
183
|
+
const hovered = box("#7c3aed");
|
|
184
|
+
const owner = box("#16a34a");
|
|
185
|
+
const panel = create("aside", {
|
|
186
|
+
position: "fixed",
|
|
187
|
+
right: "8px",
|
|
188
|
+
bottom: "8px",
|
|
189
|
+
zIndex: "2147483647",
|
|
190
|
+
width: "min(420px, calc(100vw - 16px))",
|
|
191
|
+
maxHeight: "50vh",
|
|
192
|
+
overflow: "auto",
|
|
193
|
+
padding: "8px 12px",
|
|
194
|
+
background: "#111827",
|
|
195
|
+
color: "#f9fafb",
|
|
196
|
+
font: "12px/1.4 ui-monospace, monospace",
|
|
197
|
+
borderRadius: "6px",
|
|
198
|
+
boxShadow: "0 4px 16px rgb(0 0 0 / 0.3)"
|
|
199
|
+
});
|
|
200
|
+
const summary = create("p", { margin: "0 0 4px", color: "#9ca3af" });
|
|
201
|
+
const details = create("div", {});
|
|
202
|
+
panel.append(summary, details);
|
|
203
|
+
document.head.append(style);
|
|
204
|
+
document.body.append(hovered, owner, panel);
|
|
205
|
+
let marked = [];
|
|
206
|
+
let current = null;
|
|
207
|
+
const recheck = () => {
|
|
208
|
+
current = null;
|
|
209
|
+
for (const element of marked) element.removeAttribute(ISSUE_ATTRIBUTE);
|
|
210
|
+
const issues = checkAnnotations();
|
|
211
|
+
marked = issues.map(({ element }) => element);
|
|
212
|
+
for (const element of marked) element.setAttribute(ISSUE_ATTRIBUTE, "");
|
|
213
|
+
summary.textContent = `${issues.length} Annotation issue${issues.length === 1 ? "" : "s"} \xB7 hover an outlined element`;
|
|
214
|
+
};
|
|
215
|
+
const show = (element) => {
|
|
216
|
+
const { ignoredBy, words, fields, issues } = inspect(element);
|
|
217
|
+
details.replaceChildren(
|
|
218
|
+
create("strong", {}, describe(element)),
|
|
219
|
+
...ignoredBy ? [
|
|
220
|
+
create(
|
|
221
|
+
"p",
|
|
222
|
+
{ margin: "4px 0", color: "#9ca3af" },
|
|
223
|
+
`not tracked: inside ${IGNORE_ATTRIBUTE} on ${describe(ignoredBy)}`
|
|
224
|
+
)
|
|
225
|
+
] : [],
|
|
226
|
+
...Object.entries(words).map(
|
|
227
|
+
([word, annotated]) => create(
|
|
228
|
+
"pre",
|
|
229
|
+
{ margin: "4px 0", whiteSpace: "pre-wrap" },
|
|
230
|
+
`${word}: ${JSON.stringify(annotated, null, 2)}`
|
|
231
|
+
)
|
|
232
|
+
),
|
|
233
|
+
...Object.entries(fields).map(
|
|
234
|
+
([role, fieldOwner]) => create(
|
|
235
|
+
"p",
|
|
236
|
+
{ margin: "4px 0", color: "#86efac" },
|
|
237
|
+
`field of ${role} \u2192 ${describe(fieldOwner)}`
|
|
238
|
+
)
|
|
239
|
+
),
|
|
240
|
+
...issues.map(
|
|
241
|
+
({ message }) => create("p", { margin: "4px 0", color: "#fca5a5" }, message)
|
|
242
|
+
)
|
|
243
|
+
);
|
|
244
|
+
place(hovered, element);
|
|
245
|
+
const [firstOwner] = Object.values(fields);
|
|
246
|
+
place(owner, firstOwner);
|
|
247
|
+
};
|
|
248
|
+
const onPointerMove = (event) => {
|
|
249
|
+
if (!(event.target instanceof Element) || panel.contains(event.target))
|
|
250
|
+
return;
|
|
251
|
+
const element = event.target.closest(ANNOTATED_SELECTOR);
|
|
252
|
+
if (element === current) return;
|
|
253
|
+
current = element;
|
|
254
|
+
if (element) show(element);
|
|
255
|
+
else {
|
|
256
|
+
place(hovered, void 0);
|
|
257
|
+
place(owner, void 0);
|
|
258
|
+
}
|
|
259
|
+
};
|
|
260
|
+
const onScroll = () => {
|
|
261
|
+
current = null;
|
|
262
|
+
place(hovered, void 0);
|
|
263
|
+
place(owner, void 0);
|
|
264
|
+
};
|
|
265
|
+
let timer;
|
|
266
|
+
const observer = new MutationObserver((records) => {
|
|
267
|
+
if (records.every(({ target }) => panel.contains(target))) return;
|
|
268
|
+
clearTimeout(timer);
|
|
269
|
+
timer = setTimeout(recheck, RECHECK_DELAY);
|
|
270
|
+
});
|
|
271
|
+
observer.observe(document.body, {
|
|
272
|
+
childList: true,
|
|
273
|
+
subtree: true,
|
|
274
|
+
attributes: true,
|
|
275
|
+
attributeFilter: [
|
|
276
|
+
ANNOTATION_ATTRIBUTE,
|
|
277
|
+
...DATA_ATTRIBUTES,
|
|
278
|
+
IGNORE_ATTRIBUTE
|
|
279
|
+
]
|
|
280
|
+
});
|
|
281
|
+
document.addEventListener("pointermove", onPointerMove);
|
|
282
|
+
window.addEventListener("scroll", onScroll, { capture: true, passive: true });
|
|
283
|
+
recheck();
|
|
284
|
+
return () => {
|
|
285
|
+
observer.disconnect();
|
|
286
|
+
clearTimeout(timer);
|
|
287
|
+
document.removeEventListener("pointermove", onPointerMove);
|
|
288
|
+
window.removeEventListener("scroll", onScroll, { capture: true });
|
|
289
|
+
for (const element of marked) element.removeAttribute(ISSUE_ATTRIBUTE);
|
|
290
|
+
style.remove();
|
|
291
|
+
hovered.remove();
|
|
292
|
+
owner.remove();
|
|
293
|
+
panel.remove();
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
|
|
297
|
+
export { checkAnnotations, showInspector, watchAnnotations };
|
|
298
|
+
//# sourceMappingURL=index.js.map
|
|
299
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/dom/check-annotations.ts","../../src/dom/inspect.ts","../../src/devtools/inspector.ts"],"names":[],"mappings":";;;;AA+BA,IAAM,KAAA,GAA2B,CAAC,GAAG,KAAA,EAAO,GAAG,KAAK,CAAA;AACpD,IAAM,MAAA,GAAS,GAAG,oBAAoB,CAAA,CAAA,CAAA;AACtC,IAAM,gBAAA,GAAsC;AAAA,EAC3C,GAAG,eAAA;AAAA,EACH,cAAA;AAAA,EACA,eAAA;AAAA,EACA;AACD,CAAA;AAEA,IAAM,YAAA,GAAe,CAAC,OAAA,EAAkB,MAAA,KAA8B;AACrE,EAAA,MAAM,MAAA,GAAS,CAAC,IAAA,EAA2B,OAAA,KAC1C,MAAA,CAAO,KAAK,EAAE,IAAA,EAAM,OAAA,EAAS,OAAA,EAAS,CAAA;AAGvC,EAAA,IAAI,SAAA,CAAU,OAAO,CAAA,EAAG;AACvB,IAAA,IAAI,OAAA,CAAQ,aAAa,cAAc,CAAA;AACtC,MAAA,MAAA;AAAA,QACC,iBAAA;AAAA,QACA,CAAA,EAAG,cAAc,CAAA,sBAAA,EAAyB,gBAAgB,CAAA,2BAAA;AAAA,OAC3D;AACD,IAAA;AAAA,EACD;AAEA,EAAA,KAAA,MAAW,IAAA,IAAA,CAAS,OAAA,CAAQ,YAAA,CAAa,oBAAoB,CAAA,IAAK,IAChE,KAAA,CAAM,KAAK,CAAA,CACX,MAAA,CAAO,OAAO,CAAA;AACf,IAAA,IAAI,CAAC,KAAA,CAAM,QAAA,CAAS,IAAI,CAAA;AACvB,MAAA,MAAA;AAAA,QACC,cAAA;AAAA,QACA,CAAA,CAAA,EAAI,IAAI,CAAA,KAAA,EAAQ,oBAAoB,CAAA,eAAA,EAAkB,KAAA,CAAM,IAAA,CAAK,IAAI,CAAC,CAAA,WAAA,EAAc,KAAA,CAAM,IAAA,CAAK,IAAI,CAAC,CAAA,EAAA;AAAA,OACrG;AAEF,EAAA,IAAI,QAAQ,OAAA,EAAS,QAAQ,KAAK,CAAC,OAAA,CAAQ,SAAS,MAAM,CAAA;AACzD,IAAA,MAAA;AAAA,MACC,qBAAA;AAAA,MACA,yCAAyC,oBAAoB,CAAA,eAAA;AAAA,KAC9D;AAED,EAAA,KAAA,MAAW,EAAE,IAAA,EAAM,KAAA,EAAM,IAAK,QAAQ,UAAA,EAAY;AACjD,IAAA,IAAI,CAAC,IAAA,CAAK,UAAA,CAAW,MAAM,CAAA,EAAG;AAC9B,IAAA,IAAI,CAAC,gBAAA,CAAiB,QAAA,CAAS,IAAI,CAAA,EAAG;AACrC,MAAA,MAAA;AAAA,QACC,mBAAA;AAAA,QACA,GAAG,IAAI,CAAA,iCAAA,EAAoC,eAAA,CAAgB,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA;AAAA,OACtE;AACA,MAAA;AAAA,IACD;AACA,IAAA,IACC,IAAA,KAAS,cAAA,IACT,IAAA,KAAS,eAAA,IACT,IAAA,KAAS,gBAAA;AAET,MAAA;AAED,IAAA,MAAM,IAAA,GAAO,IAAA,CAAK,KAAA,CAAM,MAAA,CAAO,MAAM,CAAA;AAErC,IAAA,MAAM,GAAA,GACL,CAAC,MAAA,CAAO,IAAI,CAAA,IACZ,OAAA,CAAQ,OAAA,EAAS,IAAI,CAAA,IACpB,IAAA,KAAS,MAAA,IAAU,OAAA,YAAmB,eAAA;AACxC,IAAA,IAAI,CAAC,OAAO,CAAC,OAAA,CAAQ,QAAQ,YAAA,CAAa,IAAI,CAAC,CAAA,EAAG;AACjD,MAAA,MAAA;AAAA,QACC,cAAA;AAAA,QACA,CAAA,EAAG,IAAI,CAAA,2BAAA,EAA8B,IAAI,CAAA,6BAAA;AAAA,OAC1C;AACA,MAAA;AAAA,IACD;AACA,IAAA,KAAA,MAAW,EAAE,GAAA,EAAK,KAAA,EAAO,YAAW,IAAK,KAAA,CAAM,KAAK,CAAA,EAAG;AACtD,MAAA,IAAI,eAAe,MAAA,EAAW;AAC9B,MAAA,IAAI,GAAA;AACH,QAAA,MAAA;AAAA,UACC,aAAA;AAAA,UACA,CAAA,CAAA,EAAI,GAAG,CAAA,KAAA,EAAQ,IAAI,CAAA,2DAAA;AAAA,SACpB;AAAA,WAAA,IACQ,CAAC,OAAA,CAAQ,WAAA,EAAa,IAAA,EAAK;AACnC,QAAA,MAAA,CAAO,aAAA,EAAe,CAAA,OAAA,EAAU,GAAG,CAAA,KAAA,EAAQ,IAAI,CAAA,aAAA,CAAe,CAAA;AAAA,IAChE;AAAA,EACD;AACD,CAAA;AAGO,IAAM,eAAA,GAAkB,CAAC,OAAA,KAAqB;AACpD,EAAA,MAAM,SAA4B,EAAC;AACnC,EAAA,YAAA,CAAa,SAAS,MAAM,CAAA;AAC5B,EAAA,OAAO,MAAA;AACR,CAAA;AAGO,IAAM,gBAAA,GAAmB,CAAC,IAAA,GAAmB,QAAA,KAAa;AAChE,EAAA,MAAM,SAA4B,EAAC;AACnC,EAAA,IAAI,IAAA,YAAgB,OAAA,EAAS,YAAA,CAAa,IAAA,EAAM,MAAM,CAAA;AACtD,EAAA,KAAA,MAAW,OAAA,IAAW,IAAA,CAAK,gBAAA,CAAiB,GAAG,CAAA;AAC9C,IAAA,YAAA,CAAa,SAAS,MAAM,CAAA;AAC7B,EAAA,OAAO,MAAA;AACR;AAEA,IAAM,WAAA,GAAc,GAAA;AAGb,IAAM,mBAAmB,MAAM;AACrC,EAAA,MAAM,MAAA,uBAAa,OAAA,EAA8B;AACjD,EAAA,MAAM,QAAQ,MAAM;AACnB,IAAA,KAAA,MAAW,KAAA,IAAS,kBAAiB,EAAG;AACvC,MAAA,IAAI,IAAA,GAAO,MAAA,CAAO,GAAA,CAAI,KAAA,CAAM,OAAO,CAAA;AACnC,MAAA,IAAI,CAAC,MAAM,MAAA,CAAO,GAAA,CAAI,MAAM,OAAA,EAAU,IAAA,mBAAO,IAAI,GAAA,EAAM,CAAA;AACvD,MAAA,IAAI,IAAA,CAAK,GAAA,CAAI,KAAA,CAAM,OAAO,CAAA,EAAG;AAC7B,MAAA,IAAA,CAAK,GAAA,CAAI,MAAM,OAAO,CAAA;AACtB,MAAA,OAAA,CAAQ,KAAK,CAAA,WAAA,EAAc,KAAA,CAAM,OAAO,CAAA,CAAA,EAAI,MAAM,OAAO,CAAA;AAAA,IAC1D;AAAA,EACD,CAAA;AAEA,EAAA,IAAI,KAAA;AACJ,EAAA,MAAM,WAAW,MAAM;AACtB,IAAA,YAAA,CAAa,KAAK,CAAA;AAClB,IAAA,KAAA,GAAQ,UAAA,CAAW,OAAO,WAAW,CAAA;AAAA,EACtC,CAAA;AACA,EAAA,MAAM,QAAA,GAAW,IAAI,gBAAA,CAAiB,QAAQ,CAAA;AAC9C,EAAA,QAAA,CAAS,OAAA,CAAQ,SAAS,eAAA,EAAiB;AAAA,IAC1C,SAAA,EAAW,IAAA;AAAA,IACX,OAAA,EAAS,IAAA;AAAA,IACT,UAAA,EAAY,IAAA;AAAA,IACZ,eAAA,EAAiB,CAAC,oBAAA,EAAsB,GAAG,gBAAgB;AAAA,GAC3D,CAAA;AACD,EAAA,QAAA,EAAS;AACT,EAAA,OAAO,MAAM;AACZ,IAAA,QAAA,CAAS,UAAA,EAAW;AACpB,IAAA,YAAA,CAAa,KAAK,CAAA;AAAA,EACnB,CAAA;AACD;;;AC/IO,IAAM,kBAAA,GAAqB;AAAA,EACjC,IAAI,oBAAoB,CAAA,CAAA,CAAA;AAAA,EACxB,OAAA;AAAA,EACA,GAAG,eAAA,CAAgB,GAAA,CAAI,CAAC,SAAA,KAAc,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA,CAAG;AACvD,CAAA,CAAE,KAAK,IAAI,CAAA;AAaJ,IAAM,OAAA,GAAU,CAAC,OAAA,KAAiC;AACxD,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,OAAA,CAAQ,OAAO,CAAA,IAAK,MAAA;AAC9C,EAAA,IAAI,SAAA;AACH,IAAA,OAAO;AAAA,MACN,SAAA;AAAA,MACA,OAAO,EAAC;AAAA,MACR,QAAQ,EAAC;AAAA,MACT,MAAA,EAAQ,gBAAgB,OAAO;AAAA,KAChC;AACD,EAAA,MAAM,QAA6B,EAAC;AACpC,EAAA,MAAM,SAA+B,EAAC;AACtC,EAAA,KAAA,MAAW,QAAQ,UAAA,EAAY;AAC9B,IAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,OAAA,EAAS,IAAI,CAAA;AACtC,IAAA,IAAI,CAAC,YAAY,CAAC,OAAA,CAAQ,aAAa,aAAA,CAAc,IAAI,CAAC,CAAA,EAAG;AAC7D,IAAA,IAAI,QAAA,IAAY,CAAC,MAAA,CAAO,IAAI,CAAA,EAAG;AAC9B,MAAA,KAAA,CAAM,IAAI,CAAA,GAAI,aAAA,CAAc,OAAA,EAAS,IAAI,CAAA;AACzC,MAAA;AAAA,IACD;AACA,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,OAAA,CAAQ,YAAA,CAAa,IAAI,CAAC,CAAA;AAChD,IAAA,IAAI,KAAA,EAAO,MAAA,CAAO,IAAI,CAAA,GAAI,KAAA;AAAA,EAC3B;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,MAAA,EAAQ,MAAA,EAAQ,eAAA,CAAgB,OAAO,CAAA,EAAE;AAC1D,CAAA;;;AC9CA,IAAM,eAAA,GAAkB,+BAAA;AACxB,IAAM,aAAA,GAAgB,GAAA;AAEtB,IAAM,KAAA,GAAQ;AAAA,CAAA,EACX,oBAAoB,CAAA;AAAA,CAAA,EACpB,eAAe,CAAA;AAAA,EAChB,OAAO,CAAA;AAAA,EACP,OAAO,KAAK,oBAAoB,CAAA;AAAA,CAAA;AAGlC,IAAM,MAAA,GAAS,CACd,GAAA,EACA,KAAA,EACA,IAAA,KACI;AACJ,EAAA,MAAM,OAAA,GAAU,QAAA,CAAS,aAAA,CAAc,GAAG,CAAA;AAC1C,EAAA,MAAA,CAAO,MAAA,CAAO,OAAA,CAAQ,KAAA,EAAO,KAAK,CAAA;AAClC,EAAA,IAAI,IAAA,KAAS,MAAA,EAAW,OAAA,CAAQ,WAAA,GAAc,IAAA;AAC9C,EAAA,OAAO,OAAA;AACR,CAAA;AAEA,IAAM,GAAA,GAAM,CAAC,KAAA,KACZ,MAAA,CAAO,KAAA,EAAO;AAAA,EACb,QAAA,EAAU,OAAA;AAAA,EACV,aAAA,EAAe,MAAA;AAAA,EACf,MAAA,EAAQ,YAAA;AAAA,EACR,MAAA,EAAQ,aAAa,KAAK,CAAA,CAAA;AAAA,EAC1B,UAAA,EAAY,GAAG,KAAK,CAAA,EAAA,CAAA;AAAA,EACpB,OAAA,EAAS;AACV,CAAC,CAAA;AAEF,IAAM,KAAA,GAAQ,CAAC,SAAA,EAAwB,OAAA,KAAiC;AACvE,EAAA,IAAI,CAAC,OAAA,EAAS;AACb,IAAA,SAAA,CAAU,MAAM,OAAA,GAAU,MAAA;AAC1B,IAAA;AAAA,EACD;AACA,EAAA,MAAM,EAAE,GAAA,EAAK,IAAA,EAAM,OAAO,MAAA,EAAO,GAAI,QAAQ,qBAAA,EAAsB;AACnE,EAAA,MAAA,CAAO,MAAA,CAAO,UAAU,KAAA,EAAO;AAAA,IAC9B,OAAA,EAAS,OAAA;AAAA,IACT,GAAA,EAAK,GAAG,GAAG,CAAA,EAAA,CAAA;AAAA,IACX,IAAA,EAAM,GAAG,IAAI,CAAA,EAAA,CAAA;AAAA,IACb,KAAA,EAAO,GAAG,KAAK,CAAA,EAAA,CAAA;AAAA,IACf,MAAA,EAAQ,GAAG,MAAM,CAAA,EAAA;AAAA,GACjB,CAAA;AACF,CAAA;AAEA,IAAM,QAAA,GAAW,CAAC,OAAA,KAAqB;AACtC,EAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,YAAA,CAAa,oBAAoB,CAAA;AACvD,EAAA,OAAO,CAAA,CAAA,EAAI,OAAA,CAAQ,OAAA,CAAQ,WAAA,EAAa,CAAA,EAAG,KAAA,GAAQ,CAAA,CAAA,EAAI,oBAAoB,CAAA,EAAA,EAAK,KAAK,CAAA,CAAA,CAAA,GAAM,EAAE,CAAA,CAAA,CAAA;AAC9F,CAAA;AAMO,IAAM,gBAAgB,MAAM;AAClC,EAAA,MAAM,KAAA,GAAQ,QAAA,CAAS,aAAA,CAAc,OAAO,CAAA;AAC5C,EAAA,KAAA,CAAM,WAAA,GAAc,KAAA;AACpB,EAAA,MAAM,OAAA,GAAU,IAAI,SAAS,CAAA;AAC7B,EAAA,MAAM,KAAA,GAAQ,IAAI,SAAS,CAAA;AAC3B,EAAA,MAAM,KAAA,GAAQ,OAAO,OAAA,EAAS;AAAA,IAC7B,QAAA,EAAU,OAAA;AAAA,IACV,KAAA,EAAO,KAAA;AAAA,IACP,MAAA,EAAQ,KAAA;AAAA,IACR,MAAA,EAAQ,YAAA;AAAA,IACR,KAAA,EAAO,gCAAA;AAAA,IACP,SAAA,EAAW,MAAA;AAAA,IACX,QAAA,EAAU,MAAA;AAAA,IACV,OAAA,EAAS,UAAA;AAAA,IACT,UAAA,EAAY,SAAA;AAAA,IACZ,KAAA,EAAO,SAAA;AAAA,IACP,IAAA,EAAM,kCAAA;AAAA,IACN,YAAA,EAAc,KAAA;AAAA,IACd,SAAA,EAAW;AAAA,GACX,CAAA;AACD,EAAA,MAAM,OAAA,GAAU,OAAO,GAAA,EAAK,EAAE,QAAQ,SAAA,EAAW,KAAA,EAAO,WAAW,CAAA;AACnE,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,KAAA,EAAO,EAAE,CAAA;AAChC,EAAA,KAAA,CAAM,MAAA,CAAO,SAAS,OAAO,CAAA;AAC7B,EAAA,QAAA,CAAS,IAAA,CAAK,OAAO,KAAK,CAAA;AAC1B,EAAA,QAAA,CAAS,IAAA,CAAK,MAAA,CAAO,OAAA,EAAS,KAAA,EAAO,KAAK,CAAA;AAE1C,EAAA,IAAI,SAAoB,EAAC;AACzB,EAAA,IAAI,OAAA,GAA0B,IAAA;AAC9B,EAAA,MAAM,UAAU,MAAM;AACrB,IAAA,OAAA,GAAU,IAAA;AACV,IAAA,KAAA,MAAW,OAAA,IAAW,MAAA,EAAQ,OAAA,CAAQ,eAAA,CAAgB,eAAe,CAAA;AACrE,IAAA,MAAM,SAAS,gBAAA,EAAiB;AAChC,IAAA,MAAA,GAAS,OAAO,GAAA,CAAI,CAAC,EAAE,OAAA,OAAc,OAAO,CAAA;AAC5C,IAAA,KAAA,MAAW,OAAA,IAAW,MAAA,EAAQ,OAAA,CAAQ,YAAA,CAAa,iBAAiB,EAAE,CAAA;AACtE,IAAA,OAAA,CAAQ,WAAA,GAAc,GAAG,MAAA,CAAO,MAAM,oBAAoB,MAAA,CAAO,MAAA,KAAW,CAAA,GAAI,EAAA,GAAK,GAAG,CAAA,+BAAA,CAAA;AAAA,EACzF,CAAA;AAEA,EAAA,MAAM,IAAA,GAAO,CAAC,OAAA,KAAqB;AAClC,IAAA,MAAM,EAAE,SAAA,EAAW,KAAA,EAAO,QAAQ,MAAA,EAAO,GAAI,QAAQ,OAAO,CAAA;AAC5D,IAAA,OAAA,CAAQ,eAAA;AAAA,MACP,OAAO,QAAA,EAAU,EAAC,EAAG,QAAA,CAAS,OAAO,CAAC,CAAA;AAAA,MACtC,GAAI,SAAA,GACD;AAAA,QACA,MAAA;AAAA,UACC,GAAA;AAAA,UACA,EAAE,MAAA,EAAQ,OAAA,EAAS,KAAA,EAAO,SAAA,EAAU;AAAA,UACpC,CAAA,oBAAA,EAAuB,gBAAgB,CAAA,IAAA,EAAO,QAAA,CAAS,SAAS,CAAC,CAAA;AAAA;AAClE,UAEA,EAAC;AAAA,MACJ,GAAG,MAAA,CAAO,OAAA,CAAQ,KAAK,CAAA,CAAE,GAAA;AAAA,QAAI,CAAC,CAAC,IAAA,EAAM,SAAS,CAAA,KAC7C,MAAA;AAAA,UACC,KAAA;AAAA,UACA,EAAE,MAAA,EAAQ,OAAA,EAAS,UAAA,EAAY,UAAA,EAAW;AAAA,UAC1C,CAAA,EAAG,IAAI,CAAA,EAAA,EAAK,IAAA,CAAK,UAAU,SAAA,EAAW,IAAA,EAAM,CAAC,CAAC,CAAA;AAAA;AAC/C,OACD;AAAA,MACA,GAAG,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA,CAAE,GAAA;AAAA,QAAI,CAAC,CAAC,IAAA,EAAM,UAAU,CAAA,KAC/C,MAAA;AAAA,UACC,GAAA;AAAA,UACA,EAAE,MAAA,EAAQ,OAAA,EAAS,KAAA,EAAO,SAAA,EAAU;AAAA,UACpC,CAAA,SAAA,EAAY,IAAI,CAAA,QAAA,EAAM,QAAA,CAAS,UAAU,CAAC,CAAA;AAAA;AAC3C,OACD;AAAA,MACA,GAAG,MAAA,CAAO,GAAA;AAAA,QAAI,CAAC,EAAE,OAAA,EAAQ,KACxB,MAAA,CAAO,GAAA,EAAK,EAAE,MAAA,EAAQ,OAAA,EAAS,KAAA,EAAO,SAAA,EAAU,EAAG,OAAO;AAAA;AAC3D,KACD;AACA,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,MAAM,CAAC,UAAU,CAAA,GAAI,MAAA,CAAO,OAAO,MAAM,CAAA;AACzC,IAAA,KAAA,CAAM,OAAO,UAAU,CAAA;AAAA,EACxB,CAAA;AAEA,EAAA,MAAM,aAAA,GAAgB,CAAC,KAAA,KAAwB;AAC9C,IAAA,IAAI,EAAE,KAAA,CAAM,MAAA,YAAkB,YAAY,KAAA,CAAM,QAAA,CAAS,MAAM,MAAM,CAAA;AACpE,MAAA;AACD,IAAA,MAAM,OAAA,GAAU,KAAA,CAAM,MAAA,CAAO,OAAA,CAAQ,kBAAkB,CAAA;AACvD,IAAA,IAAI,YAAY,OAAA,EAAS;AACzB,IAAA,OAAA,GAAU,OAAA;AACV,IAAA,IAAI,OAAA,OAAc,OAAO,CAAA;AAAA,SACpB;AACJ,MAAA,KAAA,CAAM,SAAS,MAAS,CAAA;AACxB,MAAA,KAAA,CAAM,OAAO,MAAS,CAAA;AAAA,IACvB;AAAA,EACD,CAAA;AACA,EAAA,MAAM,WAAW,MAAM;AACtB,IAAA,OAAA,GAAU,IAAA;AACV,IAAA,KAAA,CAAM,SAAS,MAAS,CAAA;AACxB,IAAA,KAAA,CAAM,OAAO,MAAS,CAAA;AAAA,EACvB,CAAA;AAEA,EAAA,IAAI,KAAA;AACJ,EAAA,MAAM,QAAA,GAAW,IAAI,gBAAA,CAAiB,CAAC,OAAA,KAAY;AAClD,IAAA,IAAI,OAAA,CAAQ,KAAA,CAAM,CAAC,EAAE,MAAA,OAAa,KAAA,CAAM,QAAA,CAAS,MAAM,CAAC,CAAA,EAAG;AAC3D,IAAA,YAAA,CAAa,KAAK,CAAA;AAClB,IAAA,KAAA,GAAQ,UAAA,CAAW,SAAS,aAAa,CAAA;AAAA,EAC1C,CAAC,CAAA;AACD,EAAA,QAAA,CAAS,OAAA,CAAQ,SAAS,IAAA,EAAM;AAAA,IAC/B,SAAA,EAAW,IAAA;AAAA,IACX,OAAA,EAAS,IAAA;AAAA,IACT,UAAA,EAAY,IAAA;AAAA,IACZ,eAAA,EAAiB;AAAA,MAChB,oBAAA;AAAA,MACA,GAAG,eAAA;AAAA,MACH;AAAA;AACD,GACA,CAAA;AACD,EAAA,QAAA,CAAS,gBAAA,CAAiB,eAAe,aAAa,CAAA;AACtD,EAAA,MAAA,CAAO,gBAAA,CAAiB,UAAU,QAAA,EAAU,EAAE,SAAS,IAAA,EAAM,OAAA,EAAS,MAAM,CAAA;AAC5E,EAAA,OAAA,EAAQ;AAER,EAAA,OAAO,MAAM;AACZ,IAAA,QAAA,CAAS,UAAA,EAAW;AACpB,IAAA,YAAA,CAAa,KAAK,CAAA;AAClB,IAAA,QAAA,CAAS,mBAAA,CAAoB,eAAe,aAAa,CAAA;AACzD,IAAA,MAAA,CAAO,oBAAoB,QAAA,EAAU,QAAA,EAAU,EAAE,OAAA,EAAS,MAAM,CAAA;AAChE,IAAA,KAAA,MAAW,OAAA,IAAW,MAAA,EAAQ,OAAA,CAAQ,eAAA,CAAgB,eAAe,CAAA;AACrE,IAAA,KAAA,CAAM,MAAA,EAAO;AACb,IAAA,OAAA,CAAQ,MAAA,EAAO;AACf,IAAA,KAAA,CAAM,MAAA,EAAO;AACb,IAAA,KAAA,CAAM,MAAA,EAAO;AAAA,EACd,CAAA;AACD","file":"index.js","sourcesContent":["import type { DataWord } from \"./annotations\";\nimport {\n\tANNOTATION_ATTRIBUTE,\n\tCLONE_ATTRIBUTE,\n\tDATA_ATTRIBUTES,\n\tFLAGS,\n\thasWord,\n\tIGNORE_ATTRIBUTE,\n\tisIgnored,\n\tisRole,\n\tparse,\n\tROLES,\n\troleSelector,\n} from \"./annotations\";\nimport { AUTO_ATTRIBUTE } from \"./opt-in\";\n\nexport type AnnotationIssueCode =\n\t| \"unknown-word\"\n\t| \"unknown-attribute\"\n\t| \"orphan-field\"\n\t| \"ignored-key\"\n\t| \"empty-field\"\n\t| \"detail-without-item\"\n\t| \"auto-in-ignored\";\n\nexport type AnnotationIssue = {\n\tcode: AnnotationIssueCode;\n\telement: Element;\n\tmessage: string;\n};\n\nconst WORDS: readonly string[] = [...ROLES, ...FLAGS];\nconst PREFIX = `${ANNOTATION_ATTRIBUTE}-`;\nconst KNOWN_ATTRIBUTES: readonly string[] = [\n\t...DATA_ATTRIBUTES,\n\tAUTO_ATTRIBUTE,\n\tCLONE_ATTRIBUTE,\n\tIGNORE_ATTRIBUTE,\n];\n\nconst checkElement = (element: Element, issues: AnnotationIssue[]) => {\n\tconst report = (code: AnnotationIssueCode, message: string) =>\n\t\tissues.push({ code, element, message });\n\n\t// Nothing in an ignored area is read, so only a setting that can't take effect there is a mistake.\n\tif (isIgnored(element)) {\n\t\tif (element.hasAttribute(AUTO_ATTRIBUTE))\n\t\t\treport(\n\t\t\t\t\"auto-in-ignored\",\n\t\t\t\t`${AUTO_ATTRIBUTE} has no effect inside ${IGNORE_ATTRIBUTE}: nothing there is tracked.`,\n\t\t\t);\n\t\treturn;\n\t}\n\n\tfor (const word of (element.getAttribute(ANNOTATION_ATTRIBUTE) ?? \"\")\n\t\t.split(/\\s+/)\n\t\t.filter(Boolean))\n\t\tif (!WORDS.includes(word))\n\t\t\treport(\n\t\t\t\t\"unknown-word\",\n\t\t\t\t`\"${word}\" in ${ANNOTATION_ATTRIBUTE} isn't a Role (${ROLES.join(\", \")}) or Flag (${FLAGS.join(\", \")}).`,\n\t\t\t);\n\n\tif (hasWord(element, \"detail\") && !hasWord(element, \"item\"))\n\t\treport(\n\t\t\t\"detail-without-item\",\n\t\t\t`\"detail\" only applies to an Item: use ${ANNOTATION_ATTRIBUTE}=\"item detail\".`,\n\t\t);\n\n\tfor (const { name, value } of element.attributes) {\n\t\tif (!name.startsWith(PREFIX)) continue;\n\t\tif (!KNOWN_ATTRIBUTES.includes(name)) {\n\t\t\treport(\n\t\t\t\t\"unknown-attribute\",\n\t\t\t\t`${name} isn't read: Data attributes are ${DATA_ATTRIBUTES.join(\", \")}.`,\n\t\t\t);\n\t\t\tcontinue;\n\t\t}\n\t\tif (\n\t\t\tname === AUTO_ATTRIBUTE ||\n\t\t\tname === CLONE_ATTRIBUTE ||\n\t\t\tname === IGNORE_ATTRIBUTE\n\t\t)\n\t\t\tcontinue;\n\n\t\tconst word = name.slice(PREFIX.length) as DataWord;\n\t\t// An auto-tracked `<form>` reads its own `data-e-form` without the Role.\n\t\tconst own =\n\t\t\t!isRole(word) ||\n\t\t\thasWord(element, word) ||\n\t\t\t(word === \"form\" && element instanceof HTMLFormElement);\n\t\tif (!own && !element.closest(roleSelector(word))) {\n\t\t\treport(\n\t\t\t\t\"orphan-field\",\n\t\t\t\t`${name} is a field of the nearest ${word} above it, and there is none.`,\n\t\t\t);\n\t\t\tcontinue;\n\t\t}\n\t\tfor (const { key, value: fieldValue } of parse(value)) {\n\t\t\tif (fieldValue !== undefined) continue;\n\t\t\tif (own)\n\t\t\t\treport(\n\t\t\t\t\t\"ignored-key\",\n\t\t\t\t\t`\"${key}\" in ${name} has no value; only a field on a descendant reads its text.`,\n\t\t\t\t);\n\t\t\telse if (!element.textContent?.trim())\n\t\t\t\treport(\"empty-field\", `Field \"${key}\" in ${name} has no text.`);\n\t\t}\n\t}\n};\n\n/** The mistakes in this element's own Annotation. */\nexport const checkAnnotation = (element: Element) => {\n\tconst issues: AnnotationIssue[] = [];\n\tcheckElement(element, issues);\n\treturn issues;\n};\n\n/** Annotation mistakes the DOM Source would otherwise silently ignore, in document order. */\nexport const checkAnnotations = (root: ParentNode = document) => {\n\tconst issues: AnnotationIssue[] = [];\n\tif (root instanceof Element) checkElement(root, issues);\n\tfor (const element of root.querySelectorAll(\"*\"))\n\t\tcheckElement(element, issues);\n\treturn issues;\n};\n\nconst CHECK_DELAY = 500;\n\n/** Warns about each new issue once, rechecking whenever the DOM changes. */\nexport const watchAnnotations = () => {\n\tconst warned = new WeakMap<Element, Set<string>>();\n\tconst check = () => {\n\t\tfor (const issue of checkAnnotations()) {\n\t\t\tlet seen = warned.get(issue.element);\n\t\t\tif (!seen) warned.set(issue.element, (seen = new Set()));\n\t\t\tif (seen.has(issue.message)) continue;\n\t\t\tseen.add(issue.message);\n\t\t\tconsole.warn(`[tracking] ${issue.message}`, issue.element);\n\t\t}\n\t};\n\n\tlet timer: ReturnType<typeof setTimeout> | undefined;\n\tconst schedule = () => {\n\t\tclearTimeout(timer);\n\t\ttimer = setTimeout(check, CHECK_DELAY);\n\t};\n\tconst observer = new MutationObserver(schedule);\n\tobserver.observe(document.documentElement, {\n\t\tchildList: true,\n\t\tsubtree: true,\n\t\tattributes: true,\n\t\tattributeFilter: [ANNOTATION_ATTRIBUTE, ...KNOWN_ATTRIBUTES],\n\t});\n\tschedule();\n\treturn () => {\n\t\tobserver.disconnect();\n\t\tclearTimeout(timer);\n\t};\n};\n","import type { Annotated, DataWord, Role } from \"./annotations\";\nimport {\n\tANNOTATION_ATTRIBUTE,\n\tDATA_ATTRIBUTES,\n\tDATA_WORDS,\n\tdataAttribute,\n\thasWord,\n\tIGNORED,\n\tisRole,\n\treadAnnotated,\n\troleSelector,\n} from \"./annotations\";\nimport type { AnnotationIssue } from \"./check-annotations\";\nimport { checkAnnotation } from \"./check-annotations\";\n\n/** Selects every element with an Annotation, a field or `data-e-ignore`. */\nexport const ANNOTATED_SELECTOR = [\n\t`[${ANNOTATION_ATTRIBUTE}]`,\n\tIGNORED,\n\t...DATA_ATTRIBUTES.map((attribute) => `[${attribute}]`),\n].join(\", \");\n\nexport type Inspection = {\n\t/** The `data-e-ignore` area it's in, whose content the DOM Source doesn't see. */\n\tignoredBy?: Element;\n\t/** What each of the element's words publishes with. */\n\twords: Partial<Record<DataWord, Annotated>>;\n\t/** The element each of its fields belongs to. */\n\tfields: Partial<Record<Role, Element>>;\n\tissues: AnnotationIssue[];\n};\n\n/** How the DOM Source reads this element: each word's Data and Composition, its fields' owners and its mistakes. */\nexport const inspect = (element: Element): Inspection => {\n\tconst ignoredBy = element.closest(IGNORED) ?? undefined;\n\tif (ignoredBy)\n\t\treturn {\n\t\t\tignoredBy,\n\t\t\twords: {},\n\t\t\tfields: {},\n\t\t\tissues: checkAnnotation(element),\n\t\t};\n\tconst words: Inspection[\"words\"] = {};\n\tconst fields: Inspection[\"fields\"] = {};\n\tfor (const word of DATA_WORDS) {\n\t\tconst declared = hasWord(element, word);\n\t\tif (!declared && !element.hasAttribute(dataAttribute(word))) continue;\n\t\tif (declared || !isRole(word)) {\n\t\t\twords[word] = readAnnotated(element, word);\n\t\t\tcontinue;\n\t\t}\n\t\tconst owner = element.closest(roleSelector(word));\n\t\tif (owner) fields[word] = owner;\n\t}\n\treturn { words, fields, issues: checkAnnotation(element) };\n};\n","import {\n\tANNOTATION_ATTRIBUTE,\n\tDATA_ATTRIBUTES,\n\tIGNORE_ATTRIBUTE,\n\tIGNORED,\n} from \"../dom/annotations\";\nimport { checkAnnotations } from \"../dom/check-annotations\";\nimport { ANNOTATED_SELECTOR, inspect } from \"../dom/inspect\";\n\nconst ISSUE_ATTRIBUTE = \"data-tracking-inspector-issue\";\nconst RECHECK_DELAY = 300;\n\nconst STYLE = `\n[${ANNOTATION_ATTRIBUTE}] { outline: 1px dashed #7c3aed; outline-offset: -1px; }\n[${ISSUE_ATTRIBUTE}] { outline: 2px solid #dc2626; outline-offset: -2px; }\n${IGNORED} { outline: 2px dashed #9ca3af; outline-offset: -2px; }\n${IGNORED} [${ANNOTATION_ATTRIBUTE}] { outline-color: #9ca3af; }\n`;\n\nconst create = <K extends keyof HTMLElementTagNameMap>(\n\ttag: K,\n\tstyle: Partial<CSSStyleDeclaration>,\n\ttext?: string,\n) => {\n\tconst element = document.createElement(tag);\n\tObject.assign(element.style, style);\n\tif (text !== undefined) element.textContent = text;\n\treturn element;\n};\n\nconst box = (color: string) =>\n\tcreate(\"div\", {\n\t\tposition: \"fixed\",\n\t\tpointerEvents: \"none\",\n\t\tzIndex: \"2147483646\",\n\t\tborder: `2px solid ${color}`,\n\t\tbackground: `${color}1a`,\n\t\tdisplay: \"none\",\n\t});\n\nconst place = (highlight: HTMLElement, element: Element | undefined) => {\n\tif (!element) {\n\t\thighlight.style.display = \"none\";\n\t\treturn;\n\t}\n\tconst { top, left, width, height } = element.getBoundingClientRect();\n\tObject.assign(highlight.style, {\n\t\tdisplay: \"block\",\n\t\ttop: `${top}px`,\n\t\tleft: `${left}px`,\n\t\twidth: `${width}px`,\n\t\theight: `${height}px`,\n\t});\n};\n\nconst describe = (element: Element) => {\n\tconst words = element.getAttribute(ANNOTATION_ATTRIBUTE);\n\treturn `<${element.tagName.toLowerCase()}${words ? ` ${ANNOTATION_ATTRIBUTE}=\"${words}\"` : \"\"}>`;\n};\n\n/**\n * Outlines Annotated Elements, marks the ones with mistakes in red, and shows how the DOM Source reads the element\n * under the pointer: each word's Data and Composition, and where its fields go. For development and QA; returns `hide`.\n */\nexport const showInspector = () => {\n\tconst style = document.createElement(\"style\");\n\tstyle.textContent = STYLE;\n\tconst hovered = box(\"#7c3aed\");\n\tconst owner = box(\"#16a34a\");\n\tconst panel = create(\"aside\", {\n\t\tposition: \"fixed\",\n\t\tright: \"8px\",\n\t\tbottom: \"8px\",\n\t\tzIndex: \"2147483647\",\n\t\twidth: \"min(420px, calc(100vw - 16px))\",\n\t\tmaxHeight: \"50vh\",\n\t\toverflow: \"auto\",\n\t\tpadding: \"8px 12px\",\n\t\tbackground: \"#111827\",\n\t\tcolor: \"#f9fafb\",\n\t\tfont: \"12px/1.4 ui-monospace, monospace\",\n\t\tborderRadius: \"6px\",\n\t\tboxShadow: \"0 4px 16px rgb(0 0 0 / 0.3)\",\n\t});\n\tconst summary = create(\"p\", { margin: \"0 0 4px\", color: \"#9ca3af\" });\n\tconst details = create(\"div\", {});\n\tpanel.append(summary, details);\n\tdocument.head.append(style);\n\tdocument.body.append(hovered, owner, panel);\n\n\tlet marked: Element[] = [];\n\tlet current: Element | null = null;\n\tconst recheck = () => {\n\t\tcurrent = null;\n\t\tfor (const element of marked) element.removeAttribute(ISSUE_ATTRIBUTE);\n\t\tconst issues = checkAnnotations();\n\t\tmarked = issues.map(({ element }) => element);\n\t\tfor (const element of marked) element.setAttribute(ISSUE_ATTRIBUTE, \"\");\n\t\tsummary.textContent = `${issues.length} Annotation issue${issues.length === 1 ? \"\" : \"s\"} · hover an outlined element`;\n\t};\n\n\tconst show = (element: Element) => {\n\t\tconst { ignoredBy, words, fields, issues } = inspect(element);\n\t\tdetails.replaceChildren(\n\t\t\tcreate(\"strong\", {}, describe(element)),\n\t\t\t...(ignoredBy\n\t\t\t\t? [\n\t\t\t\t\t\tcreate(\n\t\t\t\t\t\t\t\"p\",\n\t\t\t\t\t\t\t{ margin: \"4px 0\", color: \"#9ca3af\" },\n\t\t\t\t\t\t\t`not tracked: inside ${IGNORE_ATTRIBUTE} on ${describe(ignoredBy)}`,\n\t\t\t\t\t\t),\n\t\t\t\t\t]\n\t\t\t\t: []),\n\t\t\t...Object.entries(words).map(([word, annotated]) =>\n\t\t\t\tcreate(\n\t\t\t\t\t\"pre\",\n\t\t\t\t\t{ margin: \"4px 0\", whiteSpace: \"pre-wrap\" },\n\t\t\t\t\t`${word}: ${JSON.stringify(annotated, null, 2)}`,\n\t\t\t\t),\n\t\t\t),\n\t\t\t...Object.entries(fields).map(([role, fieldOwner]) =>\n\t\t\t\tcreate(\n\t\t\t\t\t\"p\",\n\t\t\t\t\t{ margin: \"4px 0\", color: \"#86efac\" },\n\t\t\t\t\t`field of ${role} → ${describe(fieldOwner)}`,\n\t\t\t\t),\n\t\t\t),\n\t\t\t...issues.map(({ message }) =>\n\t\t\t\tcreate(\"p\", { margin: \"4px 0\", color: \"#fca5a5\" }, message),\n\t\t\t),\n\t\t);\n\t\tplace(hovered, element);\n\t\tconst [firstOwner] = Object.values(fields);\n\t\tplace(owner, firstOwner);\n\t};\n\n\tconst onPointerMove = (event: PointerEvent) => {\n\t\tif (!(event.target instanceof Element) || panel.contains(event.target))\n\t\t\treturn;\n\t\tconst element = event.target.closest(ANNOTATED_SELECTOR);\n\t\tif (element === current) return;\n\t\tcurrent = element;\n\t\tif (element) show(element);\n\t\telse {\n\t\t\tplace(hovered, undefined);\n\t\t\tplace(owner, undefined);\n\t\t}\n\t};\n\tconst onScroll = () => {\n\t\tcurrent = null;\n\t\tplace(hovered, undefined);\n\t\tplace(owner, undefined);\n\t};\n\n\tlet timer: ReturnType<typeof setTimeout> | undefined;\n\tconst observer = new MutationObserver((records) => {\n\t\tif (records.every(({ target }) => panel.contains(target))) return;\n\t\tclearTimeout(timer);\n\t\ttimer = setTimeout(recheck, RECHECK_DELAY);\n\t});\n\tobserver.observe(document.body, {\n\t\tchildList: true,\n\t\tsubtree: true,\n\t\tattributes: true,\n\t\tattributeFilter: [\n\t\t\tANNOTATION_ATTRIBUTE,\n\t\t\t...DATA_ATTRIBUTES,\n\t\t\tIGNORE_ATTRIBUTE,\n\t\t],\n\t});\n\tdocument.addEventListener(\"pointermove\", onPointerMove);\n\twindow.addEventListener(\"scroll\", onScroll, { capture: true, passive: true });\n\trecheck();\n\n\treturn () => {\n\t\tobserver.disconnect();\n\t\tclearTimeout(timer);\n\t\tdocument.removeEventListener(\"pointermove\", onPointerMove);\n\t\twindow.removeEventListener(\"scroll\", onScroll, { capture: true });\n\t\tfor (const element of marked) element.removeAttribute(ISSUE_ATTRIBUTE);\n\t\tstyle.remove();\n\t\thovered.remove();\n\t\towner.remove();\n\t\tpanel.remove();\n\t};\n};\n"]}
|
|
@@ -1,37 +1,40 @@
|
|
|
1
|
-
import { C as
|
|
2
|
-
import { C as
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
import { C as Catalog, b as EventBroker } from '../types-CZEg03xW.js';
|
|
2
|
+
import { C as CheckPublished } from '../compatibility-wHn2I_ws.js';
|
|
3
|
+
import { S as Source } from '../source-types-fJXZeF2Q.js';
|
|
4
|
+
import { ClientNavigation } from '../navigation/index.js';
|
|
5
5
|
|
|
6
6
|
declare const ROLES: readonly ["location", "list", "item", "promotion", "form"];
|
|
7
7
|
declare const FLAGS: readonly ["click", "video", "detail", "page"];
|
|
8
8
|
type Role = (typeof ROLES)[number];
|
|
9
9
|
type Flag = (typeof FLAGS)[number];
|
|
10
|
+
/** Words with their own Data attribute, `data-e-<word>`. */
|
|
11
|
+
type DataWord = Exclude<Role | Flag, "detail">;
|
|
10
12
|
type AnnotationData = Record<string, string>;
|
|
11
13
|
type AnnotationValue = string | number | boolean | null | undefined;
|
|
12
|
-
/** Attributes to spread onto an element. */
|
|
13
|
-
type Annotation = {
|
|
14
|
-
"data-e": string;
|
|
15
|
-
"data-e-data"?: string;
|
|
16
|
-
};
|
|
17
14
|
type Annotated = {
|
|
18
15
|
data: AnnotationData;
|
|
19
16
|
composed: Partial<Record<Role, {
|
|
20
17
|
data: AnnotationData;
|
|
21
18
|
}>>;
|
|
22
19
|
};
|
|
20
|
+
/** Data typed by the project's own shape, e.g. a `ProductData` type without an index signature. */
|
|
21
|
+
type AnnotationFields<D> = {
|
|
22
|
+
[K in keyof D]: AnnotationValue;
|
|
23
|
+
};
|
|
23
24
|
/**
|
|
24
|
-
*
|
|
25
|
-
* e.g. `<div
|
|
26
|
-
* `null` and `undefined`
|
|
25
|
+
* Data as a `data-e-<word>` value, the inverse of the DOM Source's reader,
|
|
26
|
+
* e.g. `<div data-e="item" data-e-item={encodeData({ id, title })} />`.
|
|
27
|
+
* `null` and `undefined` values are left out; values may contain `;` and `\`.
|
|
27
28
|
*/
|
|
28
|
-
declare const
|
|
29
|
+
declare const encodeData: <D extends AnnotationFields<D>>(data: D) => string;
|
|
29
30
|
|
|
30
31
|
type DetectorContext = {
|
|
31
32
|
publish(name: string, event: {
|
|
32
33
|
data: object;
|
|
33
34
|
composed: Annotated["composed"];
|
|
34
35
|
}): void;
|
|
36
|
+
/** Called with every batch of DOM changes, from one observer the DOM Source shares between its Detectors; returns the unsubscribe. */
|
|
37
|
+
onMutation(listener: (records: MutationRecord[]) => void): () => void;
|
|
35
38
|
};
|
|
36
39
|
/** `P` maps each Event Name it publishes to the Data it guarantees; the catalog must declare them compatibly. */
|
|
37
40
|
type Detector<P extends Record<string, object> = Record<string, object>> = {
|
|
@@ -48,12 +51,6 @@ type Detector<P extends Record<string, object> = Record<string, object>> = {
|
|
|
48
51
|
type LinkClickData = {
|
|
49
52
|
url: string;
|
|
50
53
|
text: string;
|
|
51
|
-
/** On another host than the page and `internalHosts`. */
|
|
52
|
-
outbound: boolean;
|
|
53
|
-
download?: {
|
|
54
|
-
name: string;
|
|
55
|
-
extension: string;
|
|
56
|
-
};
|
|
57
54
|
[field: string]: unknown;
|
|
58
55
|
};
|
|
59
56
|
type ButtonClickData = {
|
|
@@ -66,23 +63,21 @@ type ClicksOptions = {
|
|
|
66
63
|
links?: boolean;
|
|
67
64
|
buttons?: boolean;
|
|
68
65
|
};
|
|
69
|
-
/** Hosts besides the page's own that links aren't outbound to. */
|
|
70
|
-
internalHosts?: string[];
|
|
71
|
-
downloadExtensions?: string[];
|
|
72
66
|
};
|
|
73
67
|
/** Publishes `link:click` and `button:click` for opted-in links and buttons. */
|
|
74
|
-
declare const clicks: ({ auto
|
|
68
|
+
declare const clicks: ({ auto }?: ClicksOptions) => Detector<{
|
|
75
69
|
"link:click": LinkClickData;
|
|
76
70
|
"button:click": ButtonClickData;
|
|
77
71
|
}>;
|
|
78
72
|
|
|
79
73
|
type DomSourceOptions = {
|
|
80
|
-
|
|
74
|
+
/** Leave out when every navigation is a full page load. */
|
|
75
|
+
clientNavigation?: Pick<ClientNavigation, "subscribe">;
|
|
81
76
|
};
|
|
82
77
|
type DomSource = Source & {
|
|
83
78
|
flush(): void;
|
|
84
79
|
};
|
|
85
|
-
declare const createDomSource: <C extends Catalog, const D extends readonly Detector<any>[]>(broker: EventBroker<C>, detectors: [...D] & { [I in keyof D]: D[I] extends Detector<infer P> ? Detector<CheckPublished<C, P>> : never; }, {
|
|
80
|
+
declare const createDomSource: <C extends Catalog, const D extends readonly Detector<any>[]>(broker: EventBroker<C>, detectors: [...D] & { [I in keyof D]: D[I] extends Detector<infer P> ? Detector<CheckPublished<C, P>> : never; }, { clientNavigation }?: DomSourceOptions) => DomSource;
|
|
86
81
|
|
|
87
82
|
type DetailViewsOptions = {
|
|
88
83
|
/** What makes two detail Items the same Item; by default all their Data. E.g. `(data) => data.handle` counts a variant switch as the same product. */
|
|
@@ -123,6 +118,11 @@ type ListViewData = {
|
|
|
123
118
|
items: ListViewItem[];
|
|
124
119
|
[field: string]: unknown;
|
|
125
120
|
};
|
|
121
|
+
type PromotionData = {
|
|
122
|
+
/** Every Item in the Promotion, in order, seen or not. */
|
|
123
|
+
items: ListViewItem[];
|
|
124
|
+
[field: string]: unknown;
|
|
125
|
+
};
|
|
126
126
|
type ImpressionsOptions = {
|
|
127
127
|
/** Share of an element that must be visible. */
|
|
128
128
|
threshold?: number;
|
|
@@ -134,7 +134,7 @@ type ImpressionsOptions = {
|
|
|
134
134
|
* `list:view` with the Items of a List first visible on a Page, batched per List.
|
|
135
135
|
*/
|
|
136
136
|
declare const impressions: ({ threshold, delay, }?: ImpressionsOptions) => Detector<{
|
|
137
|
-
"promotion:view":
|
|
137
|
+
"promotion:view": PromotionData;
|
|
138
138
|
"list:view": ListViewData;
|
|
139
139
|
}>;
|
|
140
140
|
|
|
@@ -143,16 +143,6 @@ declare const pageViews: () => Detector<{
|
|
|
143
143
|
"page:view": AnnotationData;
|
|
144
144
|
}>;
|
|
145
145
|
|
|
146
|
-
/**
|
|
147
|
-
* An exact pathname (`"/search"`), a pathname ending in `/*` for everything below it
|
|
148
|
-
* (`"/collections/*"`), a `RegExp` tested against the pathname, or a function of the URL.
|
|
149
|
-
*/
|
|
150
|
-
type PathMatcher = string | RegExp | ((url: URL) => boolean);
|
|
151
|
-
/** Publishes the Detector's Events only on Pages matching one of `paths`. */
|
|
152
|
-
declare const only: <P extends Record<string, object>>(detector: Detector<P>, paths: PathMatcher[]) => Detector<P>;
|
|
153
|
-
/** Publishes the Detector's Events on every Page except those matching one of `paths`. */
|
|
154
|
-
declare const except: <P extends Record<string, object>>(detector: Detector<P>, paths: PathMatcher[]) => Detector<P>;
|
|
155
|
-
|
|
156
146
|
type ScrollOptions = {
|
|
157
147
|
/** Percentages of the page height. */
|
|
158
148
|
thresholds?: number[];
|
|
@@ -176,7 +166,7 @@ type ItemSelectData = {
|
|
|
176
166
|
*/
|
|
177
167
|
declare const selections: () => Detector<{
|
|
178
168
|
"item:select": ItemSelectData;
|
|
179
|
-
"promotion:select":
|
|
169
|
+
"promotion:select": PromotionData;
|
|
180
170
|
}>;
|
|
181
171
|
|
|
182
172
|
type VideoEventData = {
|
|
@@ -203,4 +193,4 @@ declare const videos: ({ auto, thresholds, }?: VideosOptions) => Detector<{
|
|
|
203
193
|
"video:complete": VideoEventData;
|
|
204
194
|
}>;
|
|
205
195
|
|
|
206
|
-
export { type
|
|
196
|
+
export { type AnnotationData, type AnnotationFields, type AnnotationValue, type ButtonClickData, type ClicksOptions, type DataWord, type DetailViewsOptions, type Detector, type DetectorContext, type DomSource, type DomSourceOptions, type Flag, type FormEventData, type FormSubmitData, type FormsOptions, type ImpressionsOptions, type ItemSelectData, type LinkClickData, type ListViewData, type ListViewItem, type PromotionData, type Role, type ScrollOptions, type VideoEventData, type VideosOptions, clicks, createDomSource, detailViews, encodeData, forms, impressions, pageViews, scroll, selections, videos };
|