@macroui/event-tracker 1.3.0

package/dist/plugin/debug-sender.mjs

@@ -0,0 +1,211 @@
+/**
+ * 序列化 & 编码
+ */
+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 */ }
+        },
+    };
+}
+
+export { PresetProperty, debugSender };

package/dist/plugin/encrypt.cjs

@@ -0,0 +1,284 @@
+'use strict';
+
+/******************************************************************************
+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) });
+}
+
+exports.aesGcmDecryptAsync = aesGcmDecryptAsync;
+exports.aesGcmEncrypt = aesGcmEncrypt;
+exports.aesGcmEncryptAsync = aesGcmEncryptAsync;
+exports.defaultDecryptor = defaultDecryptor;
+exports.defaultEncryptor = defaultEncryptor;
+exports.encryptor = encryptor;
+exports.xorBase64 = xorBase64;
+exports.xorEncryptor = xorEncryptor;