@macroui/event-tracker 1.3.0

package/dist/plugin/auto-track.cjs

@@ -0,0 +1,201 @@
+'use strict';
+
+/**
+ * 浏览器端辅助方法
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+
+/**
+ * SDK 预置事件名与预置属性 key（v1.1：完整对齐神策）
+ * 命名风格对齐神策，方便跨平台对接
+ */
+/** 预置事件名 */
+var PresetEvent = {
+    PageView: '$pageview',
+    WebClick: '$WebClick',
+    WebStay: '$WebStay'};
+/** 预置属性 key */
+var PresetProperty = {
+    URLPath: '$url_path',
+    Title: '$title',
+    Referrer: '$referrer',
+    // 全埋点元素属性
+    ElementSelector: '$element_selector',
+    ElementType: '$element_type',
+    ElementId: '$element_id',
+    ElementClassName: '$element_class_name',
+    ElementContent: '$element_content',
+    EventDuration: '$event_duration'};
+
+/**
+ * auto-track 插件
+ *  - $pageview:   路由变化时自动 track
+ *  - $WebClick:   监听 click，自动 track
+ *  - $WebStay:    页面离开时上报停留时长
+ *  - $scrolldepth: 25/50/75/100% 触发
+ */
+function autoTrack(opts) {
+    var _a;
+    if (opts === void 0) { opts = {}; }
+    var sdkRef = null;
+    var enterTime = Date.now();
+    var reachedThresholds = new Set();
+    var thresholds = (_a = opts.scrollThresholds) !== null && _a !== void 0 ? _a : [25, 50, 75, 100];
+    function fire(event, properties) {
+        if (properties === void 0) { properties = {}; }
+        if (!sdkRef)
+            return;
+        sdkRef.track(event, properties);
+    }
+    function path() {
+        try {
+            return location.pathname + location.search + location.hash;
+        }
+        catch (_a) {
+            return '';
+        }
+    }
+    function setupPageview() {
+        var send = function () {
+            var _a;
+            fire(PresetEvent.PageView, (_a = {},
+                _a[PresetProperty.URLPath] = path(),
+                _a[PresetProperty.Title] = document.title,
+                _a[PresetProperty.Referrer] = document.referrer,
+                _a));
+        };
+        // 首次加载
+        setTimeout(send, 0);
+        // history.pushState/replaceState
+        var wrap = function (key) {
+            var orig = history[key];
+            history[key] = function () {
+                var args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                var r = orig.apply(this, args);
+                setTimeout(send, 0);
+                return r;
+            };
+        };
+        wrap('pushState');
+        wrap('replaceState');
+        // popstate
+        window.addEventListener('popstate', function () { return setTimeout(send, 0); });
+        // hashchange
+        window.addEventListener('hashchange', function () { return setTimeout(send, 0); });
+    }
+    function setupWebClick(selector, attrs) {
+        var onClick = function (e) {
+            var _a;
+            var target = e.target;
+            if (!target)
+                return;
+            var el = target.closest(selector || 'a, button, [data-track-click]');
+            if (!el)
+                return;
+            var props = (_a = {},
+                _a[PresetProperty.ElementSelector] = cssPath(el),
+                _a[PresetProperty.ElementType] = el.tagName.toLowerCase(),
+                _a[PresetProperty.ElementContent] = (el.textContent || '').trim().slice(0, 100),
+                _a[PresetProperty.ElementId] = el.id || undefined,
+                _a[PresetProperty.ElementClassName] = el.className || undefined,
+                _a);
+            if (el instanceof HTMLAnchorElement) {
+                props['$element_href'] = el.href;
+            }
+            for (var _i = 0, attrs_1 = attrs; _i < attrs_1.length; _i++) {
+                var a = attrs_1[_i];
+                var v = el.getAttribute(a);
+                if (v != null)
+                    props[a] = v;
+            }
+            fire(PresetEvent.WebClick, props);
+        };
+        document.addEventListener('click', onClick, true);
+    }
+    function cssPath(el) {
+        if (el.id)
+            return "#".concat(el.id);
+        var parts = [];
+        var cur = el;
+        var _loop_1 = function () {
+            var self_1 = cur;
+            var part = self_1.tagName.toLowerCase();
+            if (self_1.classList && self_1.classList.length) {
+                part += '.' + Array.from(self_1.classList).slice(0, 2).join('.');
+            }
+            var parent_1 = self_1.parentElement;
+            if (parent_1) {
+                var siblings = Array.from(parent_1.children).filter(function (c) { return c instanceof Element && c.tagName === self_1.tagName; });
+                if (siblings.length > 1) {
+                    part += ":nth-of-type(".concat(siblings.indexOf(self_1) + 1, ")");
+                }
+            }
+            parts.unshift(part);
+            cur = parent_1;
+        };
+        while (cur && cur !== document.body && parts.length < 5) {
+            _loop_1();
+        }
+        return parts.join(' > ');
+    }
+    function setupWebStay() {
+        var onEnter = function () { enterTime = Date.now(); };
+        var onLeave = function () {
+            var _a;
+            var dur = Date.now() - enterTime;
+            fire(PresetEvent.WebStay, (_a = {},
+                _a[PresetProperty.EventDuration] = dur,
+                _a[PresetProperty.URLPath] = path(),
+                _a));
+        };
+        window.addEventListener('beforeunload', onLeave);
+        document.addEventListener('visibilitychange', function () {
+            if (document.visibilityState === 'hidden')
+                onLeave();
+            else
+                onEnter();
+        });
+    }
+    function setupScrollDepth() {
+        reachedThresholds = new Set();
+        var onScroll = function () {
+            var _a;
+            var docH = document.documentElement.scrollHeight - window.innerHeight;
+            if (docH <= 0)
+                return;
+            var pct = Math.min(100, Math.round((window.scrollY / docH) * 100));
+            for (var _i = 0, thresholds_1 = thresholds; _i < thresholds_1.length; _i++) {
+                var t = thresholds_1[_i];
+                if (pct >= t && !reachedThresholds.has(t)) {
+                    reachedThresholds.add(t);
+                    fire('$scroll_depth', (_a = { percent: t }, _a[PresetProperty.URLPath] = path(), _a));
+                }
+            }
+        };
+        window.addEventListener('scroll', onScroll, { passive: true });
+    }
+    return {
+        name: 'auto-track',
+        install: function (_a) {
+            var sdk = _a.sdk;
+            if (!isBrowser())
+                return;
+            sdkRef = sdk;
+            if (opts.pageview !== false)
+                setupPageview();
+            if (opts.webclick !== false)
+                setupWebClick(opts.webclickSelector, opts.webclickAttrs || ['data-track-id', 'data-sensors-click']);
+            if (opts.webstay !== false)
+                setupWebStay();
+            if (opts.scrolldepth)
+                setupScrollDepth();
+        },
+    };
+}
+
+exports.autoTrack = autoTrack;

package/dist/plugin/auto-track.mjs

@@ -0,0 +1,199 @@
+/**
+ * 浏览器端辅助方法
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+
+/**
+ * SDK 预置事件名与预置属性 key（v1.1：完整对齐神策）
+ * 命名风格对齐神策，方便跨平台对接
+ */
+/** 预置事件名 */
+var PresetEvent = {
+    PageView: '$pageview',
+    WebClick: '$WebClick',
+    WebStay: '$WebStay'};
+/** 预置属性 key */
+var PresetProperty = {
+    URLPath: '$url_path',
+    Title: '$title',
+    Referrer: '$referrer',
+    // 全埋点元素属性
+    ElementSelector: '$element_selector',
+    ElementType: '$element_type',
+    ElementId: '$element_id',
+    ElementClassName: '$element_class_name',
+    ElementContent: '$element_content',
+    EventDuration: '$event_duration'};
+
+/**
+ * auto-track 插件
+ *  - $pageview:   路由变化时自动 track
+ *  - $WebClick:   监听 click，自动 track
+ *  - $WebStay:    页面离开时上报停留时长
+ *  - $scrolldepth: 25/50/75/100% 触发
+ */
+function autoTrack(opts) {
+    var _a;
+    if (opts === void 0) { opts = {}; }
+    var sdkRef = null;
+    var enterTime = Date.now();
+    var reachedThresholds = new Set();
+    var thresholds = (_a = opts.scrollThresholds) !== null && _a !== void 0 ? _a : [25, 50, 75, 100];
+    function fire(event, properties) {
+        if (properties === void 0) { properties = {}; }
+        if (!sdkRef)
+            return;
+        sdkRef.track(event, properties);
+    }
+    function path() {
+        try {
+            return location.pathname + location.search + location.hash;
+        }
+        catch (_a) {
+            return '';
+        }
+    }
+    function setupPageview() {
+        var send = function () {
+            var _a;
+            fire(PresetEvent.PageView, (_a = {},
+                _a[PresetProperty.URLPath] = path(),
+                _a[PresetProperty.Title] = document.title,
+                _a[PresetProperty.Referrer] = document.referrer,
+                _a));
+        };
+        // 首次加载
+        setTimeout(send, 0);
+        // history.pushState/replaceState
+        var wrap = function (key) {
+            var orig = history[key];
+            history[key] = function () {
+                var args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                var r = orig.apply(this, args);
+                setTimeout(send, 0);
+                return r;
+            };
+        };
+        wrap('pushState');
+        wrap('replaceState');
+        // popstate
+        window.addEventListener('popstate', function () { return setTimeout(send, 0); });
+        // hashchange
+        window.addEventListener('hashchange', function () { return setTimeout(send, 0); });
+    }
+    function setupWebClick(selector, attrs) {
+        var onClick = function (e) {
+            var _a;
+            var target = e.target;
+            if (!target)
+                return;
+            var el = target.closest(selector || 'a, button, [data-track-click]');
+            if (!el)
+                return;
+            var props = (_a = {},
+                _a[PresetProperty.ElementSelector] = cssPath(el),
+                _a[PresetProperty.ElementType] = el.tagName.toLowerCase(),
+                _a[PresetProperty.ElementContent] = (el.textContent || '').trim().slice(0, 100),
+                _a[PresetProperty.ElementId] = el.id || undefined,
+                _a[PresetProperty.ElementClassName] = el.className || undefined,
+                _a);
+            if (el instanceof HTMLAnchorElement) {
+                props['$element_href'] = el.href;
+            }
+            for (var _i = 0, attrs_1 = attrs; _i < attrs_1.length; _i++) {
+                var a = attrs_1[_i];
+                var v = el.getAttribute(a);
+                if (v != null)
+                    props[a] = v;
+            }
+            fire(PresetEvent.WebClick, props);
+        };
+        document.addEventListener('click', onClick, true);
+    }
+    function cssPath(el) {
+        if (el.id)
+            return "#".concat(el.id);
+        var parts = [];
+        var cur = el;
+        var _loop_1 = function () {
+            var self_1 = cur;
+            var part = self_1.tagName.toLowerCase();
+            if (self_1.classList && self_1.classList.length) {
+                part += '.' + Array.from(self_1.classList).slice(0, 2).join('.');
+            }
+            var parent_1 = self_1.parentElement;
+            if (parent_1) {
+                var siblings = Array.from(parent_1.children).filter(function (c) { return c instanceof Element && c.tagName === self_1.tagName; });
+                if (siblings.length > 1) {
+                    part += ":nth-of-type(".concat(siblings.indexOf(self_1) + 1, ")");
+                }
+            }
+            parts.unshift(part);
+            cur = parent_1;
+        };
+        while (cur && cur !== document.body && parts.length < 5) {
+            _loop_1();
+        }
+        return parts.join(' > ');
+    }
+    function setupWebStay() {
+        var onEnter = function () { enterTime = Date.now(); };
+        var onLeave = function () {
+            var _a;
+            var dur = Date.now() - enterTime;
+            fire(PresetEvent.WebStay, (_a = {},
+                _a[PresetProperty.EventDuration] = dur,
+                _a[PresetProperty.URLPath] = path(),
+                _a));
+        };
+        window.addEventListener('beforeunload', onLeave);
+        document.addEventListener('visibilitychange', function () {
+            if (document.visibilityState === 'hidden')
+                onLeave();
+            else
+                onEnter();
+        });
+    }
+    function setupScrollDepth() {
+        reachedThresholds = new Set();
+        var onScroll = function () {
+            var _a;
+            var docH = document.documentElement.scrollHeight - window.innerHeight;
+            if (docH <= 0)
+                return;
+            var pct = Math.min(100, Math.round((window.scrollY / docH) * 100));
+            for (var _i = 0, thresholds_1 = thresholds; _i < thresholds_1.length; _i++) {
+                var t = thresholds_1[_i];
+                if (pct >= t && !reachedThresholds.has(t)) {
+                    reachedThresholds.add(t);
+                    fire('$scroll_depth', (_a = { percent: t }, _a[PresetProperty.URLPath] = path(), _a));
+                }
+            }
+        };
+        window.addEventListener('scroll', onScroll, { passive: true });
+    }
+    return {
+        name: 'auto-track',
+        install: function (_a) {
+            var sdk = _a.sdk;
+            if (!isBrowser())
+                return;
+            sdkRef = sdk;
+            if (opts.pageview !== false)
+                setupPageview();
+            if (opts.webclick !== false)
+                setupWebClick(opts.webclickSelector, opts.webclickAttrs || ['data-track-id', 'data-sensors-click']);
+            if (opts.webstay !== false)
+                setupWebStay();
+            if (opts.scrolldepth)
+                setupScrollDepth();
+        },
+    };
+}
+
+export { autoTrack };

package/dist/plugin/debug-sender.cjs

@@ -0,0 +1,214 @@
+'use strict';
+
+/**
+ * 序列化 & 编码
+ */
+function encodeEvent(event, encryptor) {
+    var json = JSON.stringify(event);
+    return encryptor ? encryptor(json) : json;
+}
+function buildUrl(serverUrl, payload, contentType) {
+    var base = Array.isArray(serverUrl) ? serverUrl[0] || '' : serverUrl;
+    var has = base.indexOf('?') >= 0;
+    {
+        return "".concat(base).concat(has ? '&' : '?', "data=").concat(encodeURIComponent(payload));
+    }
+}
+
+/**
+ * 浏览器端辅助方法
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+function hasImage() {
+    return isBrowser() && typeof Image === 'function';
+}
+
+/**
+ * SDK 预置事件名与预置属性 key（v1.1：完整对齐神策）
+ * 命名风格对齐神策，方便跨平台对接
+ */
+/** 预置事件名 */
+/** 预置属性 key */
+var PresetProperty = {
+    // 设备 / 环境
+    AppId: '$app_id',
+    AppVersion: '$app_version',
+    Lib: '$lib',
+    LibMethod: '$lib_method',
+    LibDetail: '$lib_detail',
+    LibVersion: '$lib_version',
+    ScreenWidth: '$screen_width',
+    ScreenHeight: '$screen_height',
+    ViewportWidth: '$viewport_width',
+    ViewportHeight: '$viewport_height',
+    TimezoneOffset: '$timezone_offset',
+    UserAgent: '$user_agent',
+    Language: '$language',
+    FirstBrowserCharset: '$first_browser_charset',
+    FirstBrowserLanguage: '$first_browser_language',
+    // 位置 / 流量来源
+    URL: '$url',
+    URLPath: '$url_path',
+    Title: '$title',
+    Referrer: '$referrer',
+    ReferrerHost: '$referrer_host',
+    LatestReferrer: '$latest_referrer',
+    LatestReferrerHost: '$latest_referrer_host',
+    LatestLandingPage: '$latest_landing_page',
+    LatestSearchKeyword: '$latest_search_keyword',
+    LatestTrafficSourceType: '$latest_traffic_source_type',
+    FirstReferrer: '$first_referrer',
+    FirstReferrerHost: '$first_referrer_host',
+    FirstSearchKeyword: '$first_search_keyword',
+    FirstTrafficSourceType: '$first_traffic_source_type',
+    FirstVisitTime: '$first_visit_time',
+    SearchKeywordId: '$search_keyword_id',
+    SearchKeywordIdHash: '$search_keyword_id_hash',
+    SearchKeywordIdType: '$search_keyword_id_type',
+    IsFirstDay: '$is_first_day',
+    IsFirstTime: '$is_first_time',
+    // UTM
+    LatestUtmSource: '$latest_utm_source',
+    LatestUtmMedium: '$latest_utm_medium',
+    LatestUtmCampaign: '$latest_utm_campaign',
+    LatestUtmContent: '$latest_utm_content',
+    LatestUtmTerm: '$latest_utm_term',
+    Utms: '$utms',
+    // 身份
+    DistinctId: '$distinct_id',
+    AnonymousId: '$anonymous_id',
+    FirstId: '$first_id',
+    OriginalId: '$original_id',
+    LoginId: '$login_id',
+    IsLoginId: '$is_login_id',
+    IdentityLoginId: '$identity_login_id',
+    IdentityAnonymousId: '$identity_anonymous_id',
+    IdentityCookieId: '$identity_cookie_id',
+    IdentityEmail: '$identity_email',
+    IdentityMobile: '$identity_mobile',
+    // 全埋点元素属性
+    ElementSelector: '$element_selector',
+    ElementPath: '$element_path',
+    ElementType: '$element_type',
+    ElementId: '$element_id',
+    ElementClassName: '$element_class_name',
+    ElementName: '$element_name',
+    ElementContent: '$element_content',
+    ElementTargetUrl: '$element_target_url',
+    ElementPosition: '$element_position',
+    PageX: '$page_x',
+    PageY: '$page_y',
+    // 性能
+    PageHeight: '$page_height',
+    PageResourceSize: '$page_resource_size',
+    EventDuration: '$event_duration',
+    ViewportPosition: '$viewport_position',
+    // 渠道
+    LatestWxAdClickId: '$latest_wx_ad_click_id',
+    LatestWxAdCallbacks: '$latest_wx_ad_callbacks',
+    LatestWxAdHashKey: '$latest_wx_ad_hash_key',
+    IsChannelCallbackEvent: '$is_channel_callback_event',
+    // 会话
+    EventSessionId: '$event_session_id',
+    // 元信息
+    Time: '$time',
+    Event: '$event',
+    Option: '$option',
+    Project: '$project',
+    Token: '$token',
+    // 特殊
+    SignupMethod: '$signup_method',
+};
+
+/**
+ * Debug 发送器（独立 plugin）
+ *  - 启用后走 GET 请求到 debug_mode_url（默认从 server_url 推导 ?debug）
+ *  - 成功后 alert("debug数据发送成功" + data)
+ *  - 失败时 alert("debug失败" + JSON.stringify(err))
+ *  - 优先级最高（先于其它 senders 执行）
+ */
+function deriveDebugUrl(serverUrl) {
+    var base = Array.isArray(serverUrl) ? serverUrl[0] : serverUrl;
+    return base.includes('?') ? base + '&debug' : base + '?debug';
+}
+function debugSender(opts) {
+    if (opts === void 0) { opts = {}; }
+    return {
+        name: 'debug-sender',
+        install: function (_a) {
+            var _b, _c, _d, _e, _f;
+            var config = _a.config, stages = _a.stages, registry = _a.registry, sdk = _a.sdk;
+            var enabled = (_b = opts.enable) !== null && _b !== void 0 ? _b : !!config.debug_mode;
+            if (!enabled)
+                return;
+            var url = (_d = (_c = opts.url) !== null && _c !== void 0 ? _c : config.debug_mode_url) !== null && _d !== void 0 ? _d : deriveDebugUrl(config.server_url);
+            var upload = (_f = (_e = opts.upload) !== null && _e !== void 0 ? _e : config.debug_mode_upload) !== null && _f !== void 0 ? _f : 'true';
+            stages.sendDataStage.register({
+                name: 'debug-sender',
+                priority: 30, // 最高优先级
+                entry: function (ctx) {
+                    var event = ctx.data;
+                    try {
+                        var enc = encodeEvent(event, config.encryptor);
+                        Promise.resolve(enc).then(function (payload) {
+                            var fullUrl = buildUrl(url, payload, 'form');
+                            if (hasImage()) {
+                                var img = new Image(1, 1);
+                                img.onload = function () {
+                                    var _a;
+                                    try {
+                                        (_a = opts.onSuccess) === null || _a === void 0 ? void 0 : _a.call(opts, event);
+                                    }
+                                    catch ( /* ignore */_b) { /* ignore */ }
+                                    try {
+                                        if (typeof alert !== 'undefined')
+                                            alert('debug数据发送成功' + (event.event || ''));
+                                    }
+                                    catch ( /* ignore */_c) { /* ignore */ }
+                                };
+                                img.onerror = function () {
+                                    var _a;
+                                    var err = new Error('Image load failed');
+                                    try {
+                                        (_a = opts.onError) === null || _a === void 0 ? void 0 : _a.call(opts, err, event);
+                                    }
+                                    catch ( /* ignore */_b) { /* ignore */ }
+                                    try {
+                                        if (typeof alert !== 'undefined')
+                                            alert('debug失败 错误原因' + JSON.stringify({ message: err.message }));
+                                    }
+                                    catch ( /* ignore */_c) { /* ignore */ }
+                                };
+                                img.src = fullUrl;
+                            }
+                            else {
+                                ctx.cancellationToken.stop();
+                            }
+                        }).catch(function (e) {
+                            sdk.getLogger().error('debug-sender error:', e);
+                        });
+                    }
+                    catch (e) {
+                        sdk.getLogger().error('debug-sender error:', e);
+                    }
+                    return event;
+                },
+            });
+            // 标记 Dry-Run 风格
+            registry.on('sdkAfterInitAPI', function () {
+                Object.defineProperty(globalThis, '__et_debug_upload__', { value: upload, writable: true });
+            });
+        },
+        uninstall: function () {
+            try {
+                delete globalThis.__et_debug_upload__;
+            }
+            catch ( /* ignore */_a) { /* ignore */ }
+        },
+    };
+}
+
+exports.PresetProperty = PresetProperty;
+exports.debugSender = debugSender;