@macroui/event-tracker 1.3.0

package/dist/plugin/encrypt.mjs

@@ -0,0 +1,275 @@
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+/**
+ * encrypt 插件（v1.1 增强版）
+ *
+ * 三个能力：
+ *   1. 加密 + 解密配对（神策风格）
+ *      - config.encryptor / config.decoder
+ *      - 加密函数接收 JSON 字符串返回字符串；解密函数反向
+ *
+ *   2. Web Crypto AES-GCM
+ *      - aesGcmEncrypt / aesGcmDecrypt
+ *      - 基于 Web Crypto API，256-bit key，输出 base64(iv||ciphertext)
+ *
+ *   3. 钩子：encryptEvent / decryptEvent
+ *      - 用于在事件被发送前/接收后做二次处理（脱敏、补字段等）
+ *
+ * 用法示例：
+ *   import { encryptor, aesGcmEncrypt, aesGcmDecrypt } from '@macroui/event-tracker/plugin/encrypt';
+ *   const key = 'my-32-byte-secret-key-1234567890ab';
+ *   sdk.use(encryptor({
+ *     encrypt: aesGcmEncrypt(key),
+ *     decrypt: aesGcmDecrypt(key),
+ *     encryptEvent: (e) => scrubPII(e),
+ *     decryptEvent: (e) => e,
+ *   }));
+ */
+// ============================================================
+// 1. XOR + Base64（兼容 v1.0，作为默认简易实现）
+// ============================================================
+function xorBase64(input, key) {
+    var k = key || 'default';
+    var out = '';
+    for (var i = 0; i < input.length; i++) {
+        out += String.fromCharCode(input.charCodeAt(i) ^ k.charCodeAt(i % k.length));
+    }
+    if (typeof btoa !== 'undefined')
+        return btoa(out);
+    return Buffer.from(out, 'binary').toString('base64');
+}
+function defaultEncryptor(key) {
+    return function (data) { return xorBase64(data, key); };
+}
+function defaultDecryptor(key) {
+    return function (data) {
+        var bin = typeof atob !== 'undefined' ? atob(data) : Buffer.from(data, 'base64').toString('binary');
+        var out = '';
+        var k = key || 'default';
+        for (var i = 0; i < bin.length; i++) {
+            out += String.fromCharCode(bin.charCodeAt(i) ^ k.charCodeAt(i % k.length));
+        }
+        return out;
+    };
+}
+// ============================================================
+// 2. AES-GCM（Web Crypto API；需要 https / localhost）
+// ============================================================
+var ENC = new TextEncoder();
+var DEC = new TextDecoder();
+function bytesToB64(bytes) {
+    if (typeof btoa !== 'undefined') {
+        var s = '';
+        for (var i = 0; i < bytes.length; i++)
+            s += String.fromCharCode(bytes[i]);
+        return btoa(s);
+    }
+    return Buffer.from(bytes).toString('base64');
+}
+function b64ToBytes(b64) {
+    if (typeof atob !== 'undefined') {
+        var bin = atob(b64);
+        var out = new Uint8Array(bin.length);
+        for (var i = 0; i < bin.length; i++)
+            out[i] = bin.charCodeAt(i);
+        return out;
+    }
+    return new Uint8Array(Buffer.from(b64, 'base64'));
+}
+function importAesKey(rawKey) {
+    return __awaiter(this, void 0, void 0, function () {
+        var subtle, hash;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    subtle = getSubtle();
+                    return [4 /*yield*/, subtle.digest('SHA-256', ENC.encode(rawKey))];
+                case 1:
+                    hash = _a.sent();
+                    return [2 /*return*/, subtle.importKey('raw', hash, { name: 'AES-GCM' }, false, ['encrypt', 'decrypt'])];
+            }
+        });
+    });
+}
+function getSubtle() {
+    var _a;
+    if (typeof globalThis !== 'undefined' && ((_a = globalThis.crypto) === null || _a === void 0 ? void 0 : _a.subtle)) {
+        return globalThis.crypto.subtle;
+    }
+    // node 18+ 的 webcrypto
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        var webcrypto = require('crypto').webcrypto;
+        globalThis.crypto = webcrypto;
+        return webcrypto.subtle;
+    }
+    catch (_b) {
+        throw new Error('[encrypt] Web Crypto API not available (need https/localhost or Node 18+)');
+    }
+}
+/** AES-GCM 加密（同步 API 抛错；改用 Async 版本）
+ *  @deprecated Web Crypto API 是异步的，同步签名不现实；
+ *  改用 aesGcmEncryptAsync + asyncSend helper，或预计算密文。
+ */
+function aesGcmEncrypt(_rawKey) {
+    return function () {
+        throw new Error('[encrypt] Web Crypto subtle.encrypt is async-only; use aesGcmEncryptAsync and send via asyncSend()');
+    };
+}
+/** AES-GCM 加密（异步版）：返回 Promise<string> */
+function aesGcmEncryptAsync(rawKey) {
+    var _this = this;
+    var keyPromise = null;
+    return function (data) { return __awaiter(_this, void 0, void 0, function () {
+        var key, subtle, iv, cipher, _a, out;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (!keyPromise)
+                        keyPromise = importAesKey(rawKey);
+                    return [4 /*yield*/, keyPromise];
+                case 1:
+                    key = _b.sent();
+                    subtle = getSubtle();
+                    iv = globalThis.crypto.getRandomValues(new Uint8Array(12));
+                    _a = Uint8Array.bind;
+                    return [4 /*yield*/, subtle.encrypt({ name: 'AES-GCM', iv: iv }, key, ENC.encode(data))];
+                case 2:
+                    cipher = new (_a.apply(Uint8Array, [void 0, _b.sent()]))();
+                    out = new Uint8Array(iv.length + cipher.length);
+                    out.set(iv, 0);
+                    out.set(cipher, iv.length);
+                    return [2 /*return*/, bytesToB64(out)];
+            }
+        });
+    }); };
+}
+/** AES-GCM 解密（异步版） */
+function aesGcmDecryptAsync(rawKey) {
+    var _this = this;
+    var keyPromise = null;
+    return function (data) { return __awaiter(_this, void 0, void 0, function () {
+        var key, subtle, raw, iv, cipher, plain;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!keyPromise)
+                        keyPromise = importAesKey(rawKey);
+                    return [4 /*yield*/, keyPromise];
+                case 1:
+                    key = _a.sent();
+                    subtle = getSubtle();
+                    raw = b64ToBytes(data);
+                    iv = raw.slice(0, 12);
+                    cipher = raw.slice(12);
+                    return [4 /*yield*/, subtle.decrypt({ name: 'AES-GCM', iv: iv }, key, cipher)];
+                case 2:
+                    plain = _a.sent();
+                    return [2 /*return*/, DEC.decode(plain)];
+            }
+        });
+    }); };
+}
+// ============================================================
+// 3. 插件
+// ============================================================
+function encryptor(opts) {
+    return {
+        name: 'encryptor',
+        install: function (_a) {
+            var sdk = _a.sdk, config = _a.config;
+            // 写入 config；tracker.sendEvent 会自动调用
+            config.encryptor = opts.encrypt;
+            config.decoder = opts.decrypt;
+            // config.encryptEvent/decryptEvent 在 TrackerConfig 里是宽松的 Record<string,unknown> 函数
+            var cfg = config;
+            cfg.encryptEvent = opts.encryptEvent;
+            cfg.decryptEvent = opts.decryptEvent;
+            // 保留到 sdk 上，供调试 / 二次使用
+            var ref = sdk;
+            ref.__encryptor = opts.encrypt;
+            ref.__decoder = opts.decrypt;
+            ref.__encryptEvent = opts.encryptEvent;
+            ref.__decryptEvent = opts.decryptEvent;
+        },
+        uninstall: function (ctx) {
+            if (!ctx)
+                return;
+            var config = ctx.config, sdk = ctx.sdk;
+            delete config.encryptor;
+            delete config.decoder;
+            var cfg = config;
+            delete cfg.encryptEvent;
+            delete cfg.decryptEvent;
+            var ref = sdk;
+            delete ref.__encryptor;
+            delete ref.__decoder;
+            delete ref.__encryptEvent;
+            delete ref.__decryptEvent;
+        },
+    };
+}
+/** 便捷工厂：XOR 配对 */
+function xorEncryptor(key) {
+    return encryptor({ encrypt: defaultEncryptor(key), decrypt: defaultDecryptor(key) });
+}
+
+export { aesGcmDecryptAsync, aesGcmEncrypt, aesGcmEncryptAsync, defaultDecryptor, defaultEncryptor, encryptor, xorBase64, xorEncryptor };

package/dist/plugin/exposure.cjs

@@ -0,0 +1,121 @@
+'use strict';
+
+/**
+ * 浏览器端辅助方法
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+
+/**
+ * SDK 预置事件名与预置属性 key（v1.1：完整对齐神策）
+ * 命名风格对齐神策，方便跨平台对接
+ */
+/** 预置事件名 */
+var PresetEvent = {
+    ElementExposure: '$element_exposure'};
+/** 预置属性 key */
+var PresetProperty = {
+    // 全埋点元素属性
+    ElementSelector: '$element_selector',
+    ElementType: '$element_type'};
+
+/**
+ * exposure 插件：元素曝光（IntersectionObserver）
+ *  - $element_exposure 事件
+ *  - 元素进入视口超过阈值持续 X ms 才上报（默认 500ms）
+ *  - 同元素同阈值只上报一次
+ */
+function exposure(opts) {
+    if (opts === void 0) { opts = {}; }
+    var sdkRef = null;
+    var observer = null;
+    var reported = new WeakSet();
+    function cssPath(el) {
+        if (el.id)
+            return "#".concat(el.id);
+        var parts = [];
+        var cur = el;
+        while (cur && cur !== document.body && parts.length < 5) {
+            var part = cur.tagName.toLowerCase();
+            if (cur.classList && cur.classList.length) {
+                part += '.' + Array.from(cur.classList).slice(0, 2).join('.');
+            }
+            parts.unshift(part);
+            cur = cur.parentElement;
+        }
+        return parts.join(' > ');
+    }
+    function setupObserver() {
+        var _a, _b;
+        if (!('IntersectionObserver' in window))
+            return;
+        var threshold = (_a = opts.threshold) !== null && _a !== void 0 ? _a : 0.5;
+        var duration = (_b = opts.duration) !== null && _b !== void 0 ? _b : 500;
+        observer = new IntersectionObserver(function (entries) {
+            var _loop_1 = function (entry) {
+                if (entry.intersectionRatio >= threshold) {
+                    var el_1 = entry.target;
+                    var timer_1 = setTimeout(function () {
+                        var _a;
+                        if (reported.has(el_1))
+                            return;
+                        reported.add(el_1);
+                        if (!sdkRef)
+                            return;
+                        var props = (_a = {},
+                            _a[PresetProperty.ElementSelector] = cssPath(el_1),
+                            _a[PresetProperty.ElementType] = el_1.tagName.toLowerCase(),
+                            _a.$intersection_ratio = entry.intersectionRatio,
+                            _a.$exposure_duration = duration,
+                            _a);
+                        if (el_1 instanceof HTMLElement && el_1.dataset) {
+                            var prefix = opts.attrPrefix || 'data-exp-';
+                            for (var _i = 0, _b = Object.keys(el_1.dataset); _i < _b.length; _i++) {
+                                var k = _b[_i];
+                                if (k.startsWith(prefix)) {
+                                    props[k] = el_1.dataset[k];
+                                }
+                            }
+                        }
+                        sdkRef.track(PresetEvent.ElementExposure, props);
+                    }, duration);
+                    // 离开时取消未上报
+                    var off_1 = function () {
+                        clearTimeout(timer_1);
+                        el_1.removeEventListener('mouseleave', off_1);
+                    };
+                    el_1.addEventListener('mouseleave', off_1);
+                }
+            };
+            for (var _i = 0, entries_1 = entries; _i < entries_1.length; _i++) {
+                var entry = entries_1[_i];
+                _loop_1(entry);
+            }
+        }, { threshold: [threshold] });
+        if (opts.selector) {
+            var targets = document.querySelectorAll(opts.selector);
+            targets.forEach(function (t) { return observer.observe(t); });
+        }
+    }
+    return {
+        name: 'exposure',
+        install: function (_a) {
+            var sdk = _a.sdk;
+            if (!isBrowser())
+                return;
+            sdkRef = sdk;
+            if (document.readyState === 'complete')
+                setupObserver();
+            else
+                window.addEventListener('load', setupObserver, { once: true });
+        },
+        uninstall: function () {
+            observer === null || observer === void 0 ? void 0 : observer.disconnect();
+            observer = null;
+            sdkRef = null;
+        },
+    };
+}
+
+exports.exposure = exposure;

package/dist/plugin/exposure.mjs

@@ -0,0 +1,119 @@
+/**
+ * 浏览器端辅助方法
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+
+/**
+ * SDK 预置事件名与预置属性 key（v1.1：完整对齐神策）
+ * 命名风格对齐神策，方便跨平台对接
+ */
+/** 预置事件名 */
+var PresetEvent = {
+    ElementExposure: '$element_exposure'};
+/** 预置属性 key */
+var PresetProperty = {
+    // 全埋点元素属性
+    ElementSelector: '$element_selector',
+    ElementType: '$element_type'};
+
+/**
+ * exposure 插件：元素曝光（IntersectionObserver）
+ *  - $element_exposure 事件
+ *  - 元素进入视口超过阈值持续 X ms 才上报（默认 500ms）
+ *  - 同元素同阈值只上报一次
+ */
+function exposure(opts) {
+    if (opts === void 0) { opts = {}; }
+    var sdkRef = null;
+    var observer = null;
+    var reported = new WeakSet();
+    function cssPath(el) {
+        if (el.id)
+            return "#".concat(el.id);
+        var parts = [];
+        var cur = el;
+        while (cur && cur !== document.body && parts.length < 5) {
+            var part = cur.tagName.toLowerCase();
+            if (cur.classList && cur.classList.length) {
+                part += '.' + Array.from(cur.classList).slice(0, 2).join('.');
+            }
+            parts.unshift(part);
+            cur = cur.parentElement;
+        }
+        return parts.join(' > ');
+    }
+    function setupObserver() {
+        var _a, _b;
+        if (!('IntersectionObserver' in window))
+            return;
+        var threshold = (_a = opts.threshold) !== null && _a !== void 0 ? _a : 0.5;
+        var duration = (_b = opts.duration) !== null && _b !== void 0 ? _b : 500;
+        observer = new IntersectionObserver(function (entries) {
+            var _loop_1 = function (entry) {
+                if (entry.intersectionRatio >= threshold) {
+                    var el_1 = entry.target;
+                    var timer_1 = setTimeout(function () {
+                        var _a;
+                        if (reported.has(el_1))
+                            return;
+                        reported.add(el_1);
+                        if (!sdkRef)
+                            return;
+                        var props = (_a = {},
+                            _a[PresetProperty.ElementSelector] = cssPath(el_1),
+                            _a[PresetProperty.ElementType] = el_1.tagName.toLowerCase(),
+                            _a.$intersection_ratio = entry.intersectionRatio,
+                            _a.$exposure_duration = duration,
+                            _a);
+                        if (el_1 instanceof HTMLElement && el_1.dataset) {
+                            var prefix = opts.attrPrefix || 'data-exp-';
+                            for (var _i = 0, _b = Object.keys(el_1.dataset); _i < _b.length; _i++) {
+                                var k = _b[_i];
+                                if (k.startsWith(prefix)) {
+                                    props[k] = el_1.dataset[k];
+                                }
+                            }
+                        }
+                        sdkRef.track(PresetEvent.ElementExposure, props);
+                    }, duration);
+                    // 离开时取消未上报
+                    var off_1 = function () {
+                        clearTimeout(timer_1);
+                        el_1.removeEventListener('mouseleave', off_1);
+                    };
+                    el_1.addEventListener('mouseleave', off_1);
+                }
+            };
+            for (var _i = 0, entries_1 = entries; _i < entries_1.length; _i++) {
+                var entry = entries_1[_i];
+                _loop_1(entry);
+            }
+        }, { threshold: [threshold] });
+        if (opts.selector) {
+            var targets = document.querySelectorAll(opts.selector);
+            targets.forEach(function (t) { return observer.observe(t); });
+        }
+    }
+    return {
+        name: 'exposure',
+        install: function (_a) {
+            var sdk = _a.sdk;
+            if (!isBrowser())
+                return;
+            sdkRef = sdk;
+            if (document.readyState === 'complete')
+                setupObserver();
+            else
+                window.addEventListener('load', setupObserver, { once: true });
+        },
+        uninstall: function () {
+            observer === null || observer === void 0 ? void 0 : observer.disconnect();
+            observer = null;
+            sdkRef = null;
+        },
+    };
+}
+
+export { exposure };

package/dist/plugin/indexeddb-sender.cjs

@@ -0,0 +1,94 @@
+'use strict';
+
+/**
+ * 浏览器端辅助方法
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+
+/**
+ * 序列化 & 编码
+ */
+function encodeEvent(event, encryptor) {
+    var json = JSON.stringify(event);
+    return json;
+}
+
+/**
+ * indexeddb-sender 插件：把事件写到 IndexedDB（用于离线缓存 / 批量消费）
+ *  - 不实际发送，只把序列化事件追加到指定 IDB store
+ *  - 适合后续被 webview bridge / native / service worker 消费
+ */
+function indexedDBSender(opts) {
+    if (opts === void 0) { opts = {}; }
+    var dbName = opts.dbName || 'event-tracker-outbox';
+    var storeName = opts.storeName || 'outbox';
+    var max = opts.max || 500;
+    var dbPromise = null;
+    function openDB() {
+        if (!isBrowser() || typeof indexedDB === 'undefined')
+            return Promise.resolve(null);
+        return new Promise(function (resolve) {
+            try {
+                var req_1 = indexedDB.open(dbName, 1);
+                req_1.onupgradeneeded = function () {
+                    var db = req_1.result;
+                    if (!db.objectStoreNames.contains(storeName)) {
+                        db.createObjectStore(storeName, { autoIncrement: true });
+                    }
+                };
+                req_1.onsuccess = function () { return resolve(req_1.result); };
+                req_1.onerror = function () { return resolve(null); };
+            }
+            catch (_a) {
+                resolve(null);
+            }
+        });
+    }
+    var interceptor = {
+        name: 'indexeddb-sender',
+        priority: 60,
+        entry: function (ctx) {
+            if (ctx.meta.stage !== 'sendDataStage')
+                return;
+            var ev = ctx.data;
+            dbPromise !== null && dbPromise !== void 0 ? dbPromise : (dbPromise = openDB());
+            dbPromise.then(function (db) {
+                if (!db)
+                    return;
+                try {
+                    var tx = db.transaction(storeName, 'readwrite');
+                    var store_1 = tx.objectStore(storeName);
+                    var payload_1 = encodeEvent(ev);
+                    // 限制大小：> max 则删头
+                    var cntReq_1 = store_1.count();
+                    cntReq_1.onsuccess = function () {
+                        if (cntReq_1.result >= max) {
+                            store_1.delete(IDBKeyRange.lowerBound(0, true));
+                        }
+                        store_1.add({ time: Date.now(), payload: payload_1 });
+                    };
+                }
+                catch (_a) {
+                    /* ignore */
+                }
+            }).catch(function () { });
+            return ev;
+        },
+    };
+    return {
+        name: 'indexeddb-sender',
+        install: function (_a) {
+            var stages = _a.stages;
+            if (!isBrowser())
+                return;
+            stages.sendDataStage.register(interceptor);
+        },
+        uninstall: function () {
+            dbPromise = null;
+        },
+    };
+}
+
+exports.indexedDBSender = indexedDBSender;