aegis-mp-rum-wrapper 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+export declare const GPPRumID = "zYpo1fz400Vk86JR5Z";
+export interface AegisUserInfo {
+    openid?: string;
+    roleID?: string;
+    area?: number | string;
+    zone?: number | string;
+    channelID?: number | string;
+    plat?: number | string;
+    serviceType?: string;
+    accountType?: string;
+    channelUID?: string;
+    columnUID?: string;
+    platName?: string;
+    eventID?: string;
+    contentID?: string;
+    country?: string;
+    language?: string;
+    locale?: string;
+    in_game?: number | string;
+    env?: string;
+    ext1?: string;
+    ext2?: string;
+    ext3?: string;
+}
+export interface AegisMpWrapperConfig {
+    id?: string;
+    uin?: string;
+    reportApiSpeed?: boolean;
+    reportAssetSpeed?: boolean;
+    pagePerformance?: boolean;
+    webVitals?: boolean;
+    delay?: number;
+}
+export interface ReportParams {
+    name: string;
+    ext1?: string;
+    ext2?: string;
+    ext3?: string;
+    [key: string]: any;
+}
+export declare function configureWrapper(config: AegisMpWrapperConfig): void;
+export declare function setUser(user: Partial<AegisUserInfo>): void;
+export declare function setRumID(rumID: string): void;
+export declare function reportEvent(params: string | ReportParams): void;
+export declare function getInstances(): {
+    defaultAegis: any;
+    serviceAegis: any;
+};
+export interface AegisWrapperFacade {
+    user: AegisUserInfo;
+    rumID: string;
+    reportEvent: (params: string | ReportParams) => void;
+}
+export declare const AegisW: AegisWrapperFacade;

package/dist/index.js

@@ -0,0 +1,270 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AegisW = exports.GPPRumID = void 0;
+exports.configureWrapper = configureWrapper;
+exports.setUser = setUser;
+exports.setRumID = setRumID;
+exports.reportEvent = reportEvent;
+exports.getInstances = getInstances;
+var aegis_mp_sdk_1 = __importDefault(require("aegis-mp-sdk"));
+// rum id
+exports.GPPRumID = 'zYpo1fz400Vk86JR5Z'; // cn services
+var logItemTemplate = {
+    report_type: 11,
+    event_id: '',
+    service_type: '',
+    openid: '',
+    role_id: '',
+    area_id: 0,
+    zone_id: 0,
+    plat_id: 0,
+    channel_id: 0,
+    mod_name: 'h5_frontend',
+    country: '',
+    language: '',
+    seq: '',
+    client_ip: '',
+    env: 'prd',
+    log_time: '',
+    log_ts: 0,
+    extend1: '',
+    extend2: '',
+    extend3: '',
+    extend4: '',
+    in_game: 2,
+    open_panel: '2',
+    player_attr: 1,
+    inviter_open_id: '',
+    inviter_role_id: '',
+    inviter_zone_area_id: 0,
+    inviter_zone_id: 0,
+    inviter_plat_id: 0,
+    invitation_token: '',
+    price: 0,
+    coin_type: '',
+    login_phase: 0,
+    share_channel: 0,
+    task_id: '',
+    account_type: '',
+    column_uid: '',
+    channel_uid: '',
+    plat: '',
+    content_id: '',
+    source: 'fe_rum',
+};
+// 內部狀態
+var defaultAegis;
+var serviceAegis;
+var internalState = {
+    id: exports.GPPRumID,
+    uin: '',
+    reportApiSpeed: false,
+    reportAssetSpeed: false,
+    pagePerformance: false,
+    webVitals: false,
+    delay: 100,
+    user: {},
+    rumID: '',
+    ready: false,
+};
+function buildReportStr(params, isPV) {
+    var _a, _b, _c, _d, _e;
+    var logItem = __assign({}, logItemTemplate);
+    if (isPV) {
+        logItem.report_type = 1;
+    }
+    var user = internalState.user;
+    logItem.openid = ((_a = user.openid) !== null && _a !== void 0 ? _a : '') + '';
+    logItem.role_id = user.roleID ? user.roleID + '' : '';
+    logItem.area_id = user.area ? parseInt(String(user.area), 10) : 0;
+    logItem.zone_id = user.zone ? parseInt(String(user.zone), 10) : 0;
+    logItem.plat_id = user.plat ? parseInt(String(user.plat), 10) : 0;
+    logItem.channel_id = user.channelID ? parseInt(String(user.channelID), 10) : 0;
+    logItem.service_type = ((_b = user.serviceType) !== null && _b !== void 0 ? _b : '') + '';
+    logItem.event_id = ((_c = user.eventID) !== null && _c !== void 0 ? _c : '') + '';
+    logItem.country = user.country ? user.country + '' : '';
+    logItem.content_id = user.contentID ? user.contentID + '' : '';
+    var lang = (_e = (_d = user.language) !== null && _d !== void 0 ? _d : user.locale) !== null && _e !== void 0 ? _e : '';
+    logItem.language = lang ? lang + '' : '';
+    logItem.in_game = user.in_game ? parseInt(String(user.in_game), 10) : logItem.in_game;
+    logItem.env = user.env ? user.env + '' : logItem.env;
+    logItem.account_type = user.accountType ? user.accountType + '' : '';
+    logItem.column_uid = user.columnUID ? user.columnUID + '' : '';
+    logItem.channel_uid = user.channelUID ? user.channelUID + '' : '';
+    logItem.plat = user.platName ? user.platName + '' : '';
+    if (typeof params === 'string') {
+        logItem.extend1 = params;
+    }
+    else if (typeof params === 'object' && params) {
+        logItem.extend1 = params.name;
+        if (typeof params.ext1 === 'string') {
+            logItem.extend2 = params.ext1;
+        }
+        if (typeof params.ext2 === 'string') {
+            logItem.extend3 = params.ext2;
+        }
+        if (typeof params.ext3 === 'string') {
+            logItem.extend4 = params.ext3;
+        }
+    }
+    logItem.log_ts = Math.floor(Date.now() / 1000);
+    return JSON.stringify(logItem);
+}
+function initAegis(isDefault) {
+    var id = internalState.id;
+    var apiSpeed = internalState.reportApiSpeed;
+    var assetSpeed = internalState.reportAssetSpeed;
+    var pagePerformance = internalState.pagePerformance;
+    var webVitals = internalState.webVitals;
+    var delay = internalState.delay;
+    var ext1;
+    if (!isDefault) {
+        id = internalState.rumID || internalState.id;
+        apiSpeed = true;
+        assetSpeed = true;
+        pagePerformance = true;
+        webVitals = true;
+        delay = 1000;
+    }
+    if (internalState.ready) {
+        ext1 = buildReportStr({
+            name: '@@init',
+            ext1: internalState.user.ext1,
+            ext2: internalState.user.ext2,
+            ext3: internalState.user.ext3,
+        }, true);
+    }
+    // 小程序環境直接使用構造函數
+    if (typeof aegis_mp_sdk_1.default === 'function') {
+        return new aegis_mp_sdk_1.default({
+            id: id,
+            uin: internalState.uin,
+            reportApiSpeed: apiSpeed,
+            reportAssetSpeed: assetSpeed,
+            pagePerformance: pagePerformance,
+            webVitals: webVitals,
+            delay: delay,
+            spa: true,
+            ext1: ext1,
+            beforeRequest: function (data) {
+                if (!isDefault) {
+                    return data;
+                }
+                if (data.logType === 'pv' || data.logType === 'event') {
+                    return data;
+                }
+                return false;
+            },
+        });
+    }
+    console.error('[Aegis Wrapper] 找不到 aegis-mp-sdk 構造函數，請確認依賴是否正確安裝和引用');
+    return undefined;
+}
+// 對外暴露的 API
+function configureWrapper(config) {
+    if (config.id)
+        internalState.id = config.id;
+    if (typeof config.uin === 'string')
+        internalState.uin = config.uin;
+    if (typeof config.reportApiSpeed === 'boolean')
+        internalState.reportApiSpeed = config.reportApiSpeed;
+    if (typeof config.reportAssetSpeed === 'boolean')
+        internalState.reportAssetSpeed = config.reportAssetSpeed;
+    if (typeof config.pagePerformance === 'boolean')
+        internalState.pagePerformance = config.pagePerformance;
+    if (typeof config.webVitals === 'boolean')
+        internalState.webVitals = config.webVitals;
+    if (typeof config.delay === 'number')
+        internalState.delay = config.delay;
+}
+function setUser(user) {
+    var incoming = user;
+    var nextUser = __assign(__assign({}, internalState.user), user);
+    // 兼容 channeldID（文檔示例裡的字段名）到 channelID
+    if (incoming.channeldID != null && nextUser.channelID == null) {
+        nextUser.channelID = incoming.channeldID;
+    }
+    // 兼容 locale -> language
+    if (incoming.locale != null && nextUser.language == null) {
+        nextUser.language = incoming.locale;
+    }
+    internalState.user = nextUser;
+    var u = internalState.user;
+    if (u.openid && u.serviceType && u.eventID) {
+        if (!internalState.ready) {
+            internalState.ready = true;
+            defaultAegis = initAegis(true);
+            console.log('[Aegis Wrapper] default aegis ready');
+        }
+    }
+    else {
+        console.log('[Aegis Wrapper] 初始化條件不足: 需要 openid / serviceType / eventID', u);
+    }
+}
+function setRumID(rumID) {
+    internalState.rumID = rumID;
+    serviceAegis = initAegis(false);
+    console.log('[Aegis Wrapper] service aegis rumID 已設置');
+}
+function reportEvent(params) {
+    // 先調用服務實例（如果存在）
+    if (serviceAegis && typeof serviceAegis.reportEvent === 'function') {
+        serviceAegis.reportEvent(params);
+    }
+    if (!defaultAegis || typeof defaultAegis.reportEvent !== 'function') {
+        console.error('[Aegis Wrapper] default aegis 尚未準備就緒，請先調用 setUser 並補全必要字段');
+        return;
+    }
+    if (typeof params !== 'string' && typeof params !== 'object') {
+        console.error('[Aegis Wrapper] reportEvent 參數類型錯誤，應為 string 或 object');
+        return;
+    }
+    if (typeof params === 'object' && params.name === undefined) {
+        console.error('[Aegis Wrapper] reportEvent 缺少 name 字段');
+        return;
+    }
+    var payload = typeof params === 'string' ? { name: params } : __assign({}, params);
+    payload.ext1 = buildReportStr(payload, false);
+    defaultAegis.reportEvent(payload);
+}
+// 方便調試或高級用戶直接訪問實例
+function getInstances() {
+    return {
+        defaultAegis: defaultAegis,
+        serviceAegis: serviceAegis,
+    };
+}
+exports.AegisW = {};
+Object.defineProperty(exports.AegisW, 'user', {
+    get: function () {
+        return internalState.user;
+    },
+    set: function (v) {
+        setUser(v);
+    },
+    enumerable: true,
+});
+Object.defineProperty(exports.AegisW, 'rumID', {
+    get: function () {
+        return internalState.rumID;
+    },
+    set: function (v) {
+        setRumID(v);
+    },
+    enumerable: true,
+});
+exports.AegisW.reportEvent = reportEvent;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "aegis-mp-rum-wrapper",
+  "version": "0.1.0",
+  "description": "基於 aegis-mp-sdk 的小程序上報封裝 SDK，支持雙實例與自定義 RUM 日誌構造。",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "aegis",
+    "rum",
+    "mp",
+    "miniprogram",
+    "sdk"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "aegis-mp-sdk": "^1.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0"
+  },
+  "files": ["dist", "src", "README.md", "package.json"]
+}
+
+

package/src/index.ts

@@ -0,0 +1,376 @@
+import AegisCtor from 'aegis-mp-sdk';
+
+// rum id
+export const GPPRumID = 'zYpo1fz400Vk86JR5Z'; // cn services
+
+// 封裝的用戶信息結構
+export interface AegisUserInfo {
+  openid?: string;
+  roleID?: string;
+  area?: number | string;
+  zone?: number | string;
+  channelID?: number | string;
+  plat?: number | string;
+  serviceType?: string;
+  accountType?: string;
+  channelUID?: string;
+  columnUID?: string;
+  platName?: string;
+  eventID?: string;
+  contentID?: string;
+  country?: string;
+  language?: string;
+  locale?: string;
+  in_game?: number | string;
+  env?: string;
+  ext1?: string;
+  ext2?: string;
+  ext3?: string;
+}
+
+export interface AegisMpWrapperConfig {
+  id?: string; // 默認使用 GPPRumID
+  uin?: string;
+  reportApiSpeed?: boolean;
+  reportAssetSpeed?: boolean;
+  pagePerformance?: boolean;
+  webVitals?: boolean;
+  delay?: number;
+}
+
+// log item template
+interface LogItem {
+  report_type: number;
+  event_id: string;
+  service_type: string;
+  openid: string;
+  role_id: string;
+  area_id: number;
+  zone_id: number;
+  plat_id: number;
+  channel_id: number;
+  mod_name: string;
+  country: string;
+  language: string;
+  seq: string;
+  client_ip: string;
+  env: string;
+  log_time: string;
+  log_ts: number;
+  extend1: string;
+  extend2: string;
+  extend3: string;
+  extend4: string;
+  in_game: number;
+  open_panel: string;
+  player_attr: number;
+  inviter_open_id: string;
+  inviter_role_id: string;
+  inviter_zone_area_id: number;
+  inviter_zone_id: number;
+  inviter_plat_id: number;
+  invitation_token: string;
+  price: number;
+  coin_type: string;
+  login_phase: number;
+  share_channel: number;
+  task_id: string;
+  account_type: string;
+  column_uid: string;
+  channel_uid: string;
+  plat: string;
+  content_id: string;
+  source: string;
+}
+
+const logItemTemplate: LogItem = {
+  report_type: 11,
+  event_id: '',
+  service_type: '',
+  openid: '',
+  role_id: '',
+  area_id: 0,
+  zone_id: 0,
+  plat_id: 0,
+  channel_id: 0,
+  mod_name: 'h5_frontend',
+  country: '',
+  language: '',
+  seq: '',
+  client_ip: '',
+  env: 'prd',
+  log_time: '',
+  log_ts: 0,
+  extend1: '',
+  extend2: '',
+  extend3: '',
+  extend4: '',
+  in_game: 2,
+  open_panel: '2',
+  player_attr: 1,
+  inviter_open_id: '',
+  inviter_role_id: '',
+  inviter_zone_area_id: 0,
+  inviter_zone_id: 0,
+  inviter_plat_id: 0,
+  invitation_token: '',
+  price: 0,
+  coin_type: '',
+  login_phase: 0,
+  share_channel: 0,
+  task_id: '',
+  account_type: '',
+  column_uid: '',
+  channel_uid: '',
+  plat: '',
+  content_id: '',
+  source: 'fe_rum',
+};
+
+// 內部狀態
+let defaultAegis: any;
+let serviceAegis: any;
+
+const internalState = {
+  id: GPPRumID,
+  uin: '',
+  reportApiSpeed: false,
+  reportAssetSpeed: false,
+  pagePerformance: false,
+  webVitals: false,
+  delay: 100,
+  user: {} as AegisUserInfo,
+  rumID: '',
+  ready: false,
+};
+
+export interface ReportParams {
+  name: string;
+  ext1?: string;
+  ext2?: string;
+  ext3?: string;
+  [key: string]: any;
+}
+
+function buildReportStr(params: string | ReportParams, isPV: boolean): string {
+  const logItem: LogItem = { ...logItemTemplate };
+
+  if (isPV) {
+    logItem.report_type = 1;
+  }
+
+  const user = internalState.user;
+
+  logItem.openid = (user.openid ?? '') + '';
+  logItem.role_id = user.roleID ? user.roleID + '' : '';
+  logItem.area_id = user.area ? parseInt(String(user.area), 10) : 0;
+  logItem.zone_id = user.zone ? parseInt(String(user.zone), 10) : 0;
+  logItem.plat_id = user.plat ? parseInt(String(user.plat), 10) : 0;
+  logItem.channel_id = user.channelID ? parseInt(String(user.channelID), 10) : 0;
+  logItem.service_type = (user.serviceType ?? '') + '';
+  logItem.event_id = (user.eventID ?? '') + '';
+  logItem.country = user.country ? user.country + '' : '';
+  logItem.content_id = user.contentID ? user.contentID + '' : '';
+  const lang = user.language ?? user.locale ?? '';
+  logItem.language = lang ? lang + '' : '';
+  logItem.in_game = user.in_game ? parseInt(String(user.in_game), 10) : logItem.in_game;
+  logItem.env = user.env ? user.env + '' : logItem.env;
+  logItem.account_type = user.accountType ? user.accountType + '' : '';
+  logItem.column_uid = user.columnUID ? user.columnUID + '' : '';
+  logItem.channel_uid = user.channelUID ? user.channelUID + '' : '';
+  logItem.plat = user.platName ? user.platName + '' : '';
+
+  if (typeof params === 'string') {
+    logItem.extend1 = params;
+  } else if (typeof params === 'object' && params) {
+    logItem.extend1 = params.name;
+    if (typeof params.ext1 === 'string') {
+      logItem.extend2 = params.ext1;
+    }
+    if (typeof params.ext2 === 'string') {
+      logItem.extend3 = params.ext2;
+    }
+    if (typeof params.ext3 === 'string') {
+      logItem.extend4 = params.ext3;
+    }
+  }
+
+  logItem.log_ts = Math.floor(Date.now() / 1000);
+  return JSON.stringify(logItem);
+}
+
+function initAegis(isDefault: boolean): any | undefined {
+  let id = internalState.id;
+  let apiSpeed = internalState.reportApiSpeed;
+  let assetSpeed = internalState.reportAssetSpeed;
+  let pagePerformance = internalState.pagePerformance;
+  let webVitals = internalState.webVitals;
+  let delay = internalState.delay;
+  let ext1: string | undefined;
+
+  if (!isDefault) {
+    id = internalState.rumID || internalState.id;
+    apiSpeed = true;
+    assetSpeed = true;
+    pagePerformance = true;
+    webVitals = true;
+    delay = 1000;
+  }
+
+  if (internalState.ready) {
+    ext1 = buildReportStr(
+      {
+        name: '@@init',
+        ext1: internalState.user.ext1,
+        ext2: internalState.user.ext2,
+        ext3: internalState.user.ext3,
+      },
+      true,
+    );
+  }
+
+  // 小程序環境直接使用構造函數
+  if (typeof AegisCtor === 'function') {
+    return new (AegisCtor as any)({
+      id,
+      uin: internalState.uin,
+      reportApiSpeed: apiSpeed,
+      reportAssetSpeed: assetSpeed,
+      pagePerformance,
+      webVitals,
+      delay,
+      spa: true,
+      ext1,
+      beforeRequest(data: any) {
+        if (!isDefault) {
+          return data;
+        }
+        if (data.logType === 'pv' || data.logType === 'event') {
+          return data;
+        }
+        return false;
+      },
+    });
+  }
+
+  console.error('[Aegis Wrapper] 找不到 aegis-mp-sdk 構造函數，請確認依賴是否正確安裝和引用');
+  return undefined;
+}
+
+// 對外暴露的 API
+export function configureWrapper(config: AegisMpWrapperConfig): void {
+  if (config.id) internalState.id = config.id;
+  if (typeof config.uin === 'string') internalState.uin = config.uin;
+  if (typeof config.reportApiSpeed === 'boolean') internalState.reportApiSpeed = config.reportApiSpeed;
+  if (typeof config.reportAssetSpeed === 'boolean') internalState.reportAssetSpeed = config.reportAssetSpeed;
+  if (typeof config.pagePerformance === 'boolean') internalState.pagePerformance = config.pagePerformance;
+  if (typeof config.webVitals === 'boolean') internalState.webVitals = config.webVitals;
+  if (typeof config.delay === 'number') internalState.delay = config.delay;
+}
+
+export function setUser(user: Partial<AegisUserInfo>): void {
+  const incoming: any = user as any;
+  const nextUser: AegisUserInfo = {
+    ...internalState.user,
+    ...user,
+  };
+
+  // 兼容 channeldID（文檔示例裡的字段名）到 channelID
+  if (incoming.channeldID != null && nextUser.channelID == null) {
+    (nextUser as any).channelID = incoming.channeldID;
+  }
+
+  // 兼容 locale -> language
+  if (incoming.locale != null && nextUser.language == null) {
+    nextUser.language = incoming.locale;
+  }
+
+  internalState.user = nextUser;
+
+  const u = internalState.user;
+  if (u.openid && u.serviceType && u.eventID) {
+    if (!internalState.ready) {
+      internalState.ready = true;
+      defaultAegis = initAegis(true);
+      console.log('[Aegis Wrapper] default aegis ready');
+    }
+  } else {
+    console.log('[Aegis Wrapper] 初始化條件不足: 需要 openid / serviceType / eventID', u);
+  }
+}
+
+export function setRumID(rumID: string): void {
+  internalState.rumID = rumID;
+  serviceAegis = initAegis(false);
+  console.log('[Aegis Wrapper] service aegis rumID 已設置');
+}
+
+export function reportEvent(params: string | ReportParams): void {
+  // 先調用服務實例（如果存在）
+  if (serviceAegis && typeof (serviceAegis as any).reportEvent === 'function') {
+    (serviceAegis as any).reportEvent(params as any);
+  }
+
+  if (!defaultAegis || typeof (defaultAegis as any).reportEvent !== 'function') {
+    console.error('[Aegis Wrapper] default aegis 尚未準備就緒，請先調用 setUser 並補全必要字段');
+    return;
+  }
+
+  if (typeof params !== 'string' && typeof params !== 'object') {
+    console.error('[Aegis Wrapper] reportEvent 參數類型錯誤，應為 string 或 object');
+    return;
+  }
+
+  if (typeof params === 'object' && (params as any).name === undefined) {
+    console.error('[Aegis Wrapper] reportEvent 缺少 name 字段');
+    return;
+  }
+
+  const payload: any = typeof params === 'string' ? { name: params } : { ...params };
+  payload.ext1 = buildReportStr(payload, false);
+  (defaultAegis as any).reportEvent(payload);
+}
+
+// 方便調試或高級用戶直接訪問實例
+export function getInstances() {
+  return {
+    defaultAegis,
+    serviceAegis,
+  };
+}
+
+// 物件式封裝，支持示例中的兩種用法：
+// 1）AegisW.user = {...}
+// 2）AegisW.reportEvent({...})
+export interface AegisWrapperFacade {
+  user: AegisUserInfo;
+  rumID: string;
+  reportEvent: (params: string | ReportParams) => void;
+}
+
+export const AegisW: AegisWrapperFacade = {} as any;
+
+Object.defineProperty(AegisW, 'user', {
+  get() {
+    return internalState.user;
+  },
+  set(v: AegisUserInfo) {
+    setUser(v);
+  },
+  enumerable: true,
+});
+
+Object.defineProperty(AegisW, 'rumID', {
+  get() {
+    return internalState.rumID;
+  },
+  set(v: string) {
+    setRumID(v);
+  },
+  enumerable: true,
+});
+
+(AegisW as any).reportEvent = reportEvent;
+
+
+