@amplitude/amp-semantic 0.0.0-stage → 0.2.0-codexsemantic-review-integration.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/LICENSE +21 -0
- package/README.md +245 -2
- package/lib/cjs/capture.d.ts +13 -0
- package/lib/cjs/capture.d.ts.map +1 -0
- package/lib/cjs/capture.js +229 -0
- package/lib/cjs/capture.js.map +1 -0
- package/lib/cjs/helpers.d.ts +9 -0
- package/lib/cjs/helpers.d.ts.map +1 -0
- package/lib/cjs/helpers.js +469 -0
- package/lib/cjs/helpers.js.map +1 -0
- package/lib/cjs/identity.d.ts +4 -0
- package/lib/cjs/identity.d.ts.map +1 -0
- package/lib/cjs/identity.js +27 -0
- package/lib/cjs/identity.js.map +1 -0
- package/lib/cjs/index.d.ts +17 -0
- package/lib/cjs/index.d.ts.map +1 -0
- package/lib/cjs/index.js +43 -0
- package/lib/cjs/index.js.map +1 -0
- package/lib/cjs/recorders/analytics.d.ts +7 -0
- package/lib/cjs/recorders/analytics.d.ts.map +1 -0
- package/lib/cjs/recorders/analytics.js +95 -0
- package/lib/cjs/recorders/analytics.js.map +1 -0
- package/lib/cjs/recorders/feedback.d.ts +4 -0
- package/lib/cjs/recorders/feedback.d.ts.map +1 -0
- package/lib/cjs/recorders/feedback.js +611 -0
- package/lib/cjs/recorders/feedback.js.map +1 -0
- package/lib/cjs/recorders/interactions.d.ts +4 -0
- package/lib/cjs/recorders/interactions.d.ts.map +1 -0
- package/lib/cjs/recorders/interactions.js +320 -0
- package/lib/cjs/recorders/interactions.js.map +1 -0
- package/lib/cjs/recorders/keys.d.ts +4 -0
- package/lib/cjs/recorders/keys.d.ts.map +1 -0
- package/lib/cjs/recorders/keys.js +64 -0
- package/lib/cjs/recorders/keys.js.map +1 -0
- package/lib/cjs/recorders/lifecycle.d.ts +4 -0
- package/lib/cjs/recorders/lifecycle.d.ts.map +1 -0
- package/lib/cjs/recorders/lifecycle.js +86 -0
- package/lib/cjs/recorders/lifecycle.js.map +1 -0
- package/lib/cjs/recorders/navigation.d.ts +4 -0
- package/lib/cjs/recorders/navigation.d.ts.map +1 -0
- package/lib/cjs/recorders/navigation.js +18 -0
- package/lib/cjs/recorders/navigation.js.map +1 -0
- package/lib/cjs/recorders/resource-error.d.ts +4 -0
- package/lib/cjs/recorders/resource-error.d.ts.map +1 -0
- package/lib/cjs/recorders/resource-error.js +159 -0
- package/lib/cjs/recorders/resource-error.js.map +1 -0
- package/lib/cjs/types.d.ts +263 -0
- package/lib/cjs/types.d.ts.map +1 -0
- package/lib/cjs/types.js +5 -0
- package/lib/cjs/types.js.map +1 -0
- package/lib/esm/capture.d.ts +13 -0
- package/lib/esm/capture.d.ts.map +1 -0
- package/lib/esm/capture.js +225 -0
- package/lib/esm/capture.js.map +1 -0
- package/lib/esm/helpers.d.ts +9 -0
- package/lib/esm/helpers.d.ts.map +1 -0
- package/lib/esm/helpers.js +461 -0
- package/lib/esm/helpers.js.map +1 -0
- package/lib/esm/identity.d.ts +4 -0
- package/lib/esm/identity.d.ts.map +1 -0
- package/lib/esm/identity.js +23 -0
- package/lib/esm/identity.js.map +1 -0
- package/lib/esm/index.d.ts +17 -0
- package/lib/esm/index.d.ts.map +1 -0
- package/lib/esm/index.js +27 -0
- package/lib/esm/index.js.map +1 -0
- package/lib/esm/recorders/analytics.d.ts +7 -0
- package/lib/esm/recorders/analytics.d.ts.map +1 -0
- package/lib/esm/recorders/analytics.js +92 -0
- package/lib/esm/recorders/analytics.js.map +1 -0
- package/lib/esm/recorders/feedback.d.ts +4 -0
- package/lib/esm/recorders/feedback.d.ts.map +1 -0
- package/lib/esm/recorders/feedback.js +608 -0
- package/lib/esm/recorders/feedback.js.map +1 -0
- package/lib/esm/recorders/interactions.d.ts +4 -0
- package/lib/esm/recorders/interactions.d.ts.map +1 -0
- package/lib/esm/recorders/interactions.js +317 -0
- package/lib/esm/recorders/interactions.js.map +1 -0
- package/lib/esm/recorders/keys.d.ts +4 -0
- package/lib/esm/recorders/keys.d.ts.map +1 -0
- package/lib/esm/recorders/keys.js +61 -0
- package/lib/esm/recorders/keys.js.map +1 -0
- package/lib/esm/recorders/lifecycle.d.ts +4 -0
- package/lib/esm/recorders/lifecycle.d.ts.map +1 -0
- package/lib/esm/recorders/lifecycle.js +83 -0
- package/lib/esm/recorders/lifecycle.js.map +1 -0
- package/lib/esm/recorders/navigation.d.ts +4 -0
- package/lib/esm/recorders/navigation.d.ts.map +1 -0
- package/lib/esm/recorders/navigation.js +15 -0
- package/lib/esm/recorders/navigation.js.map +1 -0
- package/lib/esm/recorders/resource-error.d.ts +4 -0
- package/lib/esm/recorders/resource-error.d.ts.map +1 -0
- package/lib/esm/recorders/resource-error.js +156 -0
- package/lib/esm/recorders/resource-error.js.map +1 -0
- package/lib/esm/types.d.ts +263 -0
- package/lib/esm/types.d.ts.map +1 -0
- package/lib/esm/types.js +2 -0
- package/lib/esm/types.js.map +1 -0
- package/package.json +35 -3
- package/schema.json +1110 -0
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { __values } from "tslib";
|
|
2
|
+
var EVENT_TYPES = new Set([
|
|
3
|
+
'[Amplitude] Dead Click',
|
|
4
|
+
'[Amplitude] Rage Click',
|
|
5
|
+
'[Amplitude] Error Click',
|
|
6
|
+
'[Amplitude] Thrashed Cursor',
|
|
7
|
+
]);
|
|
8
|
+
var NUMERIC_PROPERTIES = ['[Amplitude] Clicks', '[Amplitude] Begin Time', '[Amplitude] End Time'];
|
|
9
|
+
var ELEMENT_TEXT = '[Amplitude] Element Text';
|
|
10
|
+
var ELEMENT_TAG = '[Amplitude] Element Tag';
|
|
11
|
+
var PAGE_PATH = '[Amplitude] Page Path';
|
|
12
|
+
/**
|
|
13
|
+
* Hosts must notify `analytics` only after the analytics pipeline accepts the event.
|
|
14
|
+
* This recorder never subscribes to an SDK's pre-enrichment or pre-filtering hook.
|
|
15
|
+
*/
|
|
16
|
+
export var analyticsRecorder = {
|
|
17
|
+
families: ['amp-event'],
|
|
18
|
+
setup: function (context) {
|
|
19
|
+
if (!context.enabled('amp-event'))
|
|
20
|
+
return function () { return undefined; };
|
|
21
|
+
var lastClick;
|
|
22
|
+
var stopClicks = context.subscribe(function (event) {
|
|
23
|
+
if (event.name === 'click') {
|
|
24
|
+
lastClick = { timestamp: event.timestamp, id: event.payload.id, name: event.payload.name };
|
|
25
|
+
}
|
|
26
|
+
});
|
|
27
|
+
var stopAnalytics = context.on('analytics', function (event) {
|
|
28
|
+
var e_1, _a;
|
|
29
|
+
if (!context.enabled('amp-event') || !EVENT_TYPES.has(event.eventType))
|
|
30
|
+
return;
|
|
31
|
+
var helpers = context.helpers;
|
|
32
|
+
var element = event.element;
|
|
33
|
+
if (element && helpers.blocked(element))
|
|
34
|
+
return;
|
|
35
|
+
if (!context.canEmit('amp-event'))
|
|
36
|
+
return;
|
|
37
|
+
var source = event.properties;
|
|
38
|
+
var props = {};
|
|
39
|
+
var text = null;
|
|
40
|
+
var rawText = source[ELEMENT_TEXT];
|
|
41
|
+
if (typeof rawText === 'string') {
|
|
42
|
+
// A raw SDK text property may contain text from descendants. Check the full
|
|
43
|
+
// source subtree before accepting a string that bypasses tree traversal.
|
|
44
|
+
if (element) {
|
|
45
|
+
var safeSourceText = helpers.text(element);
|
|
46
|
+
var candidate = helpers.text(element, rawText);
|
|
47
|
+
// A stale or mismatched SDK property cannot be justified by a different safe element.
|
|
48
|
+
if (safeSourceText !== null && safeSourceText === candidate)
|
|
49
|
+
text = candidate;
|
|
50
|
+
}
|
|
51
|
+
props[ELEMENT_TEXT] = text;
|
|
52
|
+
}
|
|
53
|
+
var rawTag = source[ELEMENT_TAG];
|
|
54
|
+
if (element)
|
|
55
|
+
props[ELEMENT_TAG] = element.tagName.toLowerCase();
|
|
56
|
+
else if (typeof rawTag === 'string' && /^[a-z][a-z0-9-]{0,59}$/i.test(rawTag))
|
|
57
|
+
props[ELEMENT_TAG] = rawTag.toLowerCase();
|
|
58
|
+
try {
|
|
59
|
+
for (var NUMERIC_PROPERTIES_1 = __values(NUMERIC_PROPERTIES), NUMERIC_PROPERTIES_1_1 = NUMERIC_PROPERTIES_1.next(); !NUMERIC_PROPERTIES_1_1.done; NUMERIC_PROPERTIES_1_1 = NUMERIC_PROPERTIES_1.next()) {
|
|
60
|
+
var property = NUMERIC_PROPERTIES_1_1.value;
|
|
61
|
+
var value = source[property];
|
|
62
|
+
if (typeof value === 'number' && Number.isFinite(value))
|
|
63
|
+
props[property] = value;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
67
|
+
finally {
|
|
68
|
+
try {
|
|
69
|
+
if (NUMERIC_PROPERTIES_1_1 && !NUMERIC_PROPERTIES_1_1.done && (_a = NUMERIC_PROPERTIES_1.return)) _a.call(NUMERIC_PROPERTIES_1);
|
|
70
|
+
}
|
|
71
|
+
finally { if (e_1) throw e_1.error; }
|
|
72
|
+
}
|
|
73
|
+
var rawPath = source[PAGE_PATH];
|
|
74
|
+
if (typeof rawPath === 'string')
|
|
75
|
+
props[PAGE_PATH] = helpers.url(rawPath);
|
|
76
|
+
var age = lastClick ? context.now() - lastClick.timestamp : Infinity;
|
|
77
|
+
var id = text !== null && lastClick && age >= 0 && age <= 3000 && lastClick.name === text ? lastClick.id : null;
|
|
78
|
+
context.emit('amp-event', {
|
|
79
|
+
event_type: event.eventType,
|
|
80
|
+
insert_id: typeof event.insertId === 'string' ? event.insertId : null,
|
|
81
|
+
id: id,
|
|
82
|
+
props: props,
|
|
83
|
+
});
|
|
84
|
+
});
|
|
85
|
+
return function () {
|
|
86
|
+
stopAnalytics();
|
|
87
|
+
stopClicks();
|
|
88
|
+
lastClick = undefined;
|
|
89
|
+
};
|
|
90
|
+
},
|
|
91
|
+
};
|
|
92
|
+
//# sourceMappingURL=analytics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/recorders/analytics.ts"],"names":[],"mappings":";AAEA,IAAM,WAAW,GAAG,IAAI,GAAG,CAAC;IAC1B,wBAAwB;IACxB,wBAAwB;IACxB,yBAAyB;IACzB,6BAA6B;CAC9B,CAAC,CAAC;AACH,IAAM,kBAAkB,GAAG,CAAC,oBAAoB,EAAE,wBAAwB,EAAE,sBAAsB,CAAC,CAAC;AACpG,IAAM,YAAY,GAAG,0BAA0B,CAAC;AAChD,IAAM,WAAW,GAAG,yBAAyB,CAAC;AAC9C,IAAM,SAAS,GAAG,uBAAuB,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,IAAM,iBAAiB,GAAqB;IACjD,QAAQ,EAAE,CAAC,WAAW,CAAC;IACvB,KAAK,YAAC,OAAO;QACX,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;YAAE,OAAO,cAAM,OAAA,SAAS,EAAT,CAAS,CAAC;QAC1D,IAAI,SAAoF,CAAC;QACzF,IAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,UAAC,KAAK;YACzC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC1B,SAAS,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;aAC5F;QACH,CAAC,CAAC,CAAC;QACH,IAAM,aAAa,GAAG,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,UAAC,KAAK;;YAClD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC;gBAAE,OAAO;YACvE,IAAA,OAAO,GAAK,OAAO,QAAZ,CAAa;YAC5B,IAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;YAC9B,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;gBAAE,OAAO;YAChD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;gBAAE,OAAO;YAC1C,IAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC;YAChC,IAAM,KAAK,GAA2C,EAAE,CAAC;YACzD,IAAI,IAAI,GAAkB,IAAI,CAAC;YAC/B,IAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;YACrC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC/B,4EAA4E;gBAC5E,yEAAyE;gBACzE,IAAI,OAAO,EAAE;oBACX,IAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC7C,IAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACjD,sFAAsF;oBACtF,IAAI,cAAc,KAAK,IAAI,IAAI,cAAc,KAAK,SAAS;wBAAE,IAAI,GAAG,SAAS,CAAC;iBAC/E;gBACD,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;aAC5B;YACD,IAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,OAAO;gBAAE,KAAK,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;iBAC3D,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC;gBAC3E,KAAK,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;;gBAC5C,KAAuB,IAAA,uBAAA,SAAA,kBAAkB,CAAA,sDAAA,sFAAE;oBAAtC,IAAM,QAAQ,+BAAA;oBACjB,IAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;wBAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;iBAClF;;;;;;;;;YACD,IAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YAClC,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAAE,KAAK,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACzE,IAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;YACvE,IAAM,EAAE,GAAG,IAAI,KAAK,IAAI,IAAI,SAAS,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,IAAI,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAClH,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;gBACxB,UAAU,EAAE,KAAK,CAAC,SAAS;gBAC3B,SAAS,EAAE,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;gBACrE,EAAE,IAAA;gBACF,KAAK,OAAA;aACN,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO;YACL,aAAa,EAAE,CAAC;YAChB,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,SAAS,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC;CACF,CAAC","sourcesContent":["import type { SemanticPayloads, SemanticRecorder } from '../types';\n\nconst EVENT_TYPES = new Set([\n '[Amplitude] Dead Click',\n '[Amplitude] Rage Click',\n '[Amplitude] Error Click',\n '[Amplitude] Thrashed Cursor',\n]);\nconst NUMERIC_PROPERTIES = ['[Amplitude] Clicks', '[Amplitude] Begin Time', '[Amplitude] End Time'];\nconst ELEMENT_TEXT = '[Amplitude] Element Text';\nconst ELEMENT_TAG = '[Amplitude] Element Tag';\nconst PAGE_PATH = '[Amplitude] Page Path';\n\n/**\n * Hosts must notify `analytics` only after the analytics pipeline accepts the event.\n * This recorder never subscribes to an SDK's pre-enrichment or pre-filtering hook.\n */\nexport const analyticsRecorder: SemanticRecorder = {\n families: ['amp-event'],\n setup(context) {\n if (!context.enabled('amp-event')) return () => undefined;\n let lastClick: { timestamp: number; id: number | null; name: string | null } | undefined;\n const stopClicks = context.subscribe((event) => {\n if (event.name === 'click') {\n lastClick = { timestamp: event.timestamp, id: event.payload.id, name: event.payload.name };\n }\n });\n const stopAnalytics = context.on('analytics', (event) => {\n if (!context.enabled('amp-event') || !EVENT_TYPES.has(event.eventType)) return;\n const { helpers } = context;\n const element = event.element;\n if (element && helpers.blocked(element)) return;\n if (!context.canEmit('amp-event')) return;\n const source = event.properties;\n const props: SemanticPayloads['amp-event']['props'] = {};\n let text: string | null = null;\n const rawText = source[ELEMENT_TEXT];\n if (typeof rawText === 'string') {\n // A raw SDK text property may contain text from descendants. Check the full\n // source subtree before accepting a string that bypasses tree traversal.\n if (element) {\n const safeSourceText = helpers.text(element);\n const candidate = helpers.text(element, rawText);\n // A stale or mismatched SDK property cannot be justified by a different safe element.\n if (safeSourceText !== null && safeSourceText === candidate) text = candidate;\n }\n props[ELEMENT_TEXT] = text;\n }\n const rawTag = source[ELEMENT_TAG];\n if (element) props[ELEMENT_TAG] = element.tagName.toLowerCase();\n else if (typeof rawTag === 'string' && /^[a-z][a-z0-9-]{0,59}$/i.test(rawTag))\n props[ELEMENT_TAG] = rawTag.toLowerCase();\n for (const property of NUMERIC_PROPERTIES) {\n const value = source[property];\n if (typeof value === 'number' && Number.isFinite(value)) props[property] = value;\n }\n const rawPath = source[PAGE_PATH];\n if (typeof rawPath === 'string') props[PAGE_PATH] = helpers.url(rawPath);\n const age = lastClick ? context.now() - lastClick.timestamp : Infinity;\n const id = text !== null && lastClick && age >= 0 && age <= 3000 && lastClick.name === text ? lastClick.id : null;\n context.emit('amp-event', {\n event_type: event.eventType,\n insert_id: typeof event.insertId === 'string' ? event.insertId : null,\n id,\n props,\n });\n });\n return () => {\n stopAnalytics();\n stopClicks();\n lastClick = undefined;\n };\n },\n};\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../../../src/recorders/feedback.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAwD,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAyDvG,yFAAyF;AACzF,eAAO,MAAM,gBAAgB,EAAE,gBAuU9B,CAAC"}
|