@chiyou/minigame-framework 1.4.0 → 1.4.2

package/src/Framework/Adapter/PlatformAdapter/PlatformAdapterWeiXin.ts

@@ -1,4 +1,5 @@
 import { AbsPlatformAdapter } from './AbsPlatformAdapter';
+import { LaunchCategory } from "../../Definition/AnalyticsDefinition";
 import { LogUtils } from '../../Utils/LogUtils';
 import { FwkErrorCode } from '../../Definition/FwkErrorDefinition';
 import { AuthorizeResult, GetSettingResult } from '../../Definition/PrivacyDefinition';
@@ -87,6 +88,15 @@ class WeiXinPlatformBusiness {
 export class PlatformAdapterWeiXin extends AbsPlatformAdapter {
 
     static TAG: string = "PlatformAdapterWeiXin";
+    protected launchSceneCategoryMap: Map<LaunchCategory, Set<string>> = new Map([
+        [LaunchCategory.RecentUse, new Set(["1001", "1089", "1090", "1256", "1271"])],
+        [LaunchCategory.Desktop, new Set(["1023", "1113", "1114", "1223"])],
+        [LaunchCategory.Search, new Set(["1005", "1006", "1027", "1053", "1106", "1183"])],
+        [LaunchCategory.Chat, new Set(["1007", "1008", "1036", "1096"])],
+        [LaunchCategory.Share, new Set(["1044", "1073", "1074"])],
+        [LaunchCategory.Ad, new Set(["1045", "1046", "1067", "1084", "1095", "1200", "1201", "1228", "1232", "1238", "1274", "1295", "1387"])],
+        [LaunchCategory.Other, new Set([])],
+    ]);
 
     private portalGame: PortalGame = new PortalGame();
     private gameClub: GameClub = new GameClub();
@@ -503,18 +513,18 @@ export class PlatformAdapterWeiXin extends AbsPlatformAdapter {
 
     public onGameColdStart(): void {
         this.coldStartOptions = null;
-        this.coldStartScene = "";
+        this._coldStartScene = "";
 
         if (window["wx"] && window["wx"].getLaunchOptionsSync) {
             this.coldStartOptions = window["wx"].getLaunchOptionsSync();
             if (this.coldStartOptions !== null && this.coldStartOptions["scene"]) {
-                this.coldStartScene = this.coldStartOptions["scene"].toString();
+                this._coldStartScene = this.coldStartOptions["scene"].toString();
             }
         }
 
         LogUtils.Instance.info(PlatformAdapterWeiXin.TAG, "冷启动场景更新", {
             operation: "updateColdStartScene",
-            scene: this.coldStartScene
+            scene: this._coldStartScene
         });
     }
 
@@ -576,52 +586,8 @@ export class PlatformAdapterWeiXin extends AbsPlatformAdapter {
 
     }
 
-    public isLaunchFromRecentUse(): boolean {
-        let recentUseSceneSet: Set<string> = new Set<string>([
-            "1001",
-            "1089",
-            "1256",
-            "1103",
-            "1104",
-            "1257",
-        ]);
-
-        let isLaunchFromRecentUse: boolean = recentUseSceneSet.has(this.coldStartScene) || recentUseSceneSet.has(this.warmStartScene);
-        LogUtils.Instance.info(PlatformAdapterWeiXin.TAG, "判断是否最近使用启动", {
-            operation: "isLaunchFromRecentUse",
-            result: isLaunchFromRecentUse
-        });
-        return isLaunchFromRecentUse;
-    }
 
-    public isLaunchFromDesktopShortcut(): boolean {
-        let desktopShortcutSceneSet: Set<string> = new Set<string>([
-            "1023",
-            "1223",
-        ]);
 
-        let isLaunchFromDesktopShortcut: boolean = desktopShortcutSceneSet.has(this.coldStartScene) || desktopShortcutSceneSet.has(this.warmStartScene);
-        LogUtils.Instance.info(PlatformAdapterWeiXin.TAG, "判断是否桌面快捷方式启动", {
-            operation: "isLaunchFromDesktopShortcut",
-            result: isLaunchFromDesktopShortcut
-        });
-        return isLaunchFromDesktopShortcut;
-    }
-
-    public isLaunchFromAdvertisement(): boolean {
-        let advertisementSceneSet: Set<string> = new Set<string>([
-            "1045", "1046", "1067", "1068", "1084", "1095",
-            "1189", "1200", "1201", "1215", "1228", "1230",
-            "1232", "1238", "1274", "1295",
-        ]);
-
-        let isLaunchFromAdvertisement: boolean = advertisementSceneSet.has(this.coldStartScene);
-        LogUtils.Instance.info(PlatformAdapterWeiXin.TAG, "判断是否广告启动", {
-            operation: "isLaunchFromAdvertisement",
-            result: isLaunchFromAdvertisement
-        });
-        return isLaunchFromAdvertisement;
-    }
 
     public checkSession(callback: (isValid: boolean) => void): void {
         if (window["wx"] && window["wx"].checkSession) {

package/src/Framework/Adapter/PlatformAdapter/PlatformAdapterXiaoMi.ts

@@ -1,4 +1,5 @@
 import { AbsPlatformAdapter } from './AbsPlatformAdapter';
+import { LaunchCategory } from "../../Definition/AnalyticsDefinition";
 import { LogUtils } from '../../Utils/LogUtils';
 import { FwkErrorCode } from '../../Definition/FwkErrorDefinition';
 import { AuthorizeResult, GetSettingResult } from '../../Definition/PrivacyDefinition';
@@ -7,6 +8,15 @@ import { ScreenInfo } from '../../Definition/SystemDefinition';
 export class PlatformAdapterXiaoMi extends AbsPlatformAdapter {
 
     static TAG: string = "PlatformAdapterXiaoMi";
+    protected launchSceneCategoryMap: Map<LaunchCategory, Set<string>> = new Map([
+        [LaunchCategory.RecentUse, new Set([])],
+        [LaunchCategory.Desktop, new Set([])],
+        [LaunchCategory.Search, new Set([])],
+        [LaunchCategory.Chat, new Set([])],
+        [LaunchCategory.Share, new Set([])],
+        [LaunchCategory.Ad, new Set([])],
+        [LaunchCategory.Other, new Set([])],
+    ]);
     
     // Common
     public init(): void {
@@ -284,11 +294,11 @@ export class PlatformAdapterXiaoMi extends AbsPlatformAdapter {
 
     public onGameColdStart(): void {
         this.coldStartOptions = null;
-        this.coldStartScene = "";
+        this._coldStartScene = "";
 
         LogUtils.Instance.info(PlatformAdapterXiaoMi.TAG, "冷启动场景更新", {
             operation: "updateColdStartScene",
-            scene: this.coldStartScene
+            scene: this._coldStartScene
         });
     }
 
@@ -346,17 +356,8 @@ export class PlatformAdapterXiaoMi extends AbsPlatformAdapter {
 
     }
 
-    public isLaunchFromRecentUse(): boolean {
-        return false;
-    }
 
-    public isLaunchFromDesktopShortcut(): boolean {
-        return false;
-    }
 
-    public isLaunchFromAdvertisement(): boolean {
-        return false;
-    }
 
     public checkSession(callback: (isValid: boolean) => void): void {
         // XiaoMi不支持这个方法，直接返回true

package/src/Framework/Adapter/PlatformAdapter/PlatformAdapterZhiFuBao.ts

@@ -1,4 +1,5 @@
 import { AbsPlatformAdapter } from './AbsPlatformAdapter';
+import { LaunchCategory } from "../../Definition/AnalyticsDefinition";
 import { LogUtils } from '../../Utils/LogUtils';
 import { FwkErrorCode } from '../../Definition/FwkErrorDefinition';
 import { AuthorizeResult, GetSettingResult } from '../../Definition/PrivacyDefinition';
@@ -7,6 +8,15 @@ import { ScreenInfo } from '../../Definition/SystemDefinition';
 export class PlatformAdapterZhiFuBao extends AbsPlatformAdapter {
 
     static TAG: string = "PlatformAdapterZhiFuBao";
+    protected launchSceneCategoryMap: Map<LaunchCategory, Set<string>> = new Map([
+        [LaunchCategory.RecentUse, new Set(["1000", "1001", "1002", "1003"])],
+        [LaunchCategory.Desktop, new Set(["1023"])],
+        [LaunchCategory.Search, new Set([])],
+        [LaunchCategory.Chat, new Set([])],
+        [LaunchCategory.Share, new Set([])],
+        [LaunchCategory.Ad, new Set(["1400"])],
+        [LaunchCategory.Other, new Set([])],
+    ]);
 
     // Common
     public init(): void {
@@ -314,18 +324,18 @@ export class PlatformAdapterZhiFuBao extends AbsPlatformAdapter {
 
     public onGameColdStart(): void {
         this.coldStartOptions = null;
-        this.coldStartScene = "";
+        this._coldStartScene = "";
 
         if (window["my"] && window["my"].getLaunchOptionsSync) {
             this.coldStartOptions = window["my"].getLaunchOptionsSync();
             if (this.coldStartOptions !== null && this.coldStartOptions["scene"]) {
-                this.coldStartScene = this.coldStartOptions["scene"];
+                this._coldStartScene = this.coldStartOptions["scene"];
             }
         }
 
         LogUtils.Instance.info(PlatformAdapterZhiFuBao.TAG, "冷启动场景更新", {
             operation: "updateColdStartScene",
-            scene: this.coldStartScene
+            scene: this._coldStartScene
         });
     }
 
@@ -387,47 +397,8 @@ export class PlatformAdapterZhiFuBao extends AbsPlatformAdapter {
 
     }
 
-    public isLaunchFromRecentUse(): boolean {
-        let recentUseSceneSet: Set<string> = new Set<string>([
-            "1000",
-            "1001",
-            "1002",
-            "1003",
-        ]);
 
-        let isLaunchFromRecentUse: boolean = recentUseSceneSet.has(this.coldStartScene) || recentUseSceneSet.has(this.warmStartScene);
-        LogUtils.Instance.info(PlatformAdapterZhiFuBao.TAG, "判断是否最近使用启动", {
-            operation: "isLaunchFromRecentUse",
-            result: isLaunchFromRecentUse
-        });
-        return isLaunchFromRecentUse;
-    }
-
-    public isLaunchFromDesktopShortcut(): boolean {
-        let desktopShortcutSceneSet: Set<string> = new Set<string>([
-            "1023",
-        ]);
 
-        let isLaunchFromDesktopShortcut: boolean = desktopShortcutSceneSet.has(this.coldStartScene) || desktopShortcutSceneSet.has(this.warmStartScene);
-        LogUtils.Instance.info(PlatformAdapterZhiFuBao.TAG, "判断是否桌面快捷方式启动", {
-            operation: "isLaunchFromDesktopShortcut",
-            result: isLaunchFromDesktopShortcut
-        });
-        return isLaunchFromDesktopShortcut;
-    }
-
-    public isLaunchFromAdvertisement(): boolean {
-        let advertisementSceneSet: Set<string> = new Set<string>([
-            "1400",
-        ]);
-
-        let isLaunchFromAdvertisement: boolean = advertisementSceneSet.has(this.coldStartScene);
-        LogUtils.Instance.info(PlatformAdapterZhiFuBao.TAG, "判断是否广告启动", {
-            operation: "isLaunchFromAdvertisement",
-            result: isLaunchFromAdvertisement
-        });
-        return isLaunchFromAdvertisement;
-    }
 
     public checkSession(callback: (isValid: boolean) => void): void {
         // ZhiFuBao不支持这个方法，直接返回true

package/src/Framework/Definition/AnalyticsDefinition.ts

@@ -32,88 +32,14 @@ export interface UmengConfig {
 
 // ==================== SDK 类型声明 ====================
 
-/** 关卡结束事件类型 */
-export enum StageEventType {
-    /** 关卡完成 */
-    Complete = "complete",
-    /** 关卡失败 */
-    Fail = "fail",
-}
-
-/** 关卡中行为事件类型 */
-export enum StageRunningEventType {
-    /** 使用道具 */
-    Tools = "tools",
-    /** 获得奖励 */
-    Award = "award",
-}
-
-/** 关卡开始参数 */
-export interface StageStartParams {
-    /** 关卡ID（必传，string类型） */
-    stageId: string;
-    /** 关卡名称（必传） */
-    stageName: string;
-}
-
-/** 关卡结束参数 */
-export interface StageEndParams {
-    /** 关卡ID（必传，string类型） */
-    stageId: string;
-    /** 关卡名称（必传） */
-    stageName: string;
-    /** 关卡结束结果（必传，complete/fail） */
-    event: StageEventType;
-    /** 关卡耗时（毫秒，可选） */
-    _um_sdu?: number;
-}
-
-/** 关卡中行为事件参数 */
-export interface StageRunningParams {
-    /** 关卡ID（必传，string类型） */
-    stageId: string;
-    /** 关卡名称（必传） */
-    stageName: string;
-    /** 事件类型（必传，tools/award） */
-    event: StageRunningEventType;
-    /** 事件参数 */
-    params?: StageRunningItemParams;
-}
-
-/** 关卡中行为物品参数 */
-export interface StageRunningItemParams {
-    /** 商品/道具名称（必传） */
-    itemName: string;
-    /** 商品/道具ID（可选） */
-    itemId?: string;
-    /** 商品/道具数量（可选） */
-    itemCount?: number;
-    /** 商品/道具单价（可选） */
-    itemMoney?: number;
-    /** 描述（可选） */
-    desc?: string;
-}
-
-/** 友盟关卡 SDK 接口 */
-export interface UmaSDKStage {
-    /** 关卡开始 */
-    onStart(params: StageStartParams): void;
-    /** 关卡结束 */
-    onEnd(params: StageEndParams): void;
-    /** 关卡中行为 */
-    onRunning(params: StageRunningParams): void;
-}
-
 /**
  * 友盟 SDK 接口定义
  * 
- * 仅包含实际可用的方法（共12个）
+ * 仅包含实际可用的方法（共11个）
  * 已移除：removeUserid, setUserInfo, setAnonymousid, setAppVersion, setSuperProperty（不可用）
  * 已移除：revenue, stage, level, rc（插件方法）
  * 
  * 使用方式：SDK 在 game.js 中初始化后，通过 wx.uma 全局实例访问
- * 
- * 关卡行为上报通过 wx.uma.stage 对象访问
  */
 export interface UmaSDK {
     /** 恢复会话（onShow 时调用） */
@@ -138,39 +64,113 @@ export interface UmaSDK {
     onShareAppMessage(callback: () => object): void;
     /** 调用分享 */
     shareAppMessage(options: object): void;
-    /** 关卡行为上报（stage 对象） */
-    stage: UmaSDKStage;
 }
 
-// ==================== 预定义事件 ID ====================
+// ==================== 事件 ID 与参数 ====================
 
-/** 预定义事件 ID */
+/** 事件 ID（按业务分类） */
 export enum AnalyticsEventId {
+    // ==================== 留存 ====================
+    /** 游戏启动（DAU / 留存基数） */
+    GameLaunch = "game_launch",
+
+    // ==================== 关卡 ====================
+    /** 关卡开始 */
+    StageStart = "stage_start",
+    /** 关卡结束（成功 / 失败 / 放弃） */
+    StageEnd = "stage_end",
+    /** 复活成功 */
+    StageRevive = "stage_revive",
+
+    // ==================== 广告 ====================
+    /** 广告加载成功 */
+    AdLoadSuccess = "ad_load_success",
+    /** 广告加载失败 */
+    AdLoadError = "ad_load_error",
+    /** 广告展示 */
     AdShow = "ad_show",
-    AdClick = "ad_click",
-    AdComplete = "ad_complete",
-    AdSkip = "ad_skip",
-    AdError = "ad_error",
-    Purchase = "purchase",
+    /** 广告观看完成（isEnded=true） */
+    AdShowComplete = "ad_show_complete",
+    /** 广告跳过（isEnded=false） */
+    AdShowSkip = "ad_show_skip",
+}
+
+/** 关卡结束结果 */
+export enum StageResult {
+    Success = "success",
+    Fail = "fail",
+    Abandon = "abandon",
+}
+
+/** 复活方式 */
+export enum ReviveMethod {
+    /** 广告复活 */
+    Ad = "ad",
+    /** 道具复活 */
+    Item = "item",
+}
+
+/** 启动场景分类 */
+export enum LaunchCategory {
+    /** 最近使用/我的小程序 */
+    RecentUse = "recent",
+    /** 桌面图标/快捷方式 */
+    Desktop = "desktop",
+    /** 搜索 */
+    Search = "search",
+    /** 聊天消息卡片 */
+    Chat = "chat",
+    /** 分享卡片 */
     Share = "share",
-    Login = "login",
-    GameLaunch = "game_launch",
-    GameError = "game_error",
+    /** 广告 */
+    Ad = "ad",
+    /** 其他/未知 */
+    Other = "other",
 }
 
-/** 事件参数键名 */
+/** 冷启动场景信息 */
+export interface LaunchSceneInfo {
+    /** 原始场景值 */
+    scene: string;
+    /** 归并后的场景分类 */
+    category: LaunchCategory;
+}
+
+/** 事件参数键名（按业务分类） */
 export enum AnalyticsParamKey {
-    Score = "score",
+    // ==================== 通用 ====================
+    /** 时长（毫秒），关卡耗时等通用场景 */
     Duration = "duration",
-    Reason = "reason",
-    AdType = "ad_type",
-    AdId = "ad_id",
-    ItemId = "item_id",
-    ItemName = "item_name",
-    Price = "price",
-    Currency = "currency",
-    ShareType = "share_type",
-    ShareContent = "share_content",
-    ErrorCode = "error_code",
-    ErrorMsg = "error_msg",
+
+    // ==================== 留存 ====================
+    /** 原始启动场景值 */
+    LaunchScene = "launch_scene",
+    /** 归并后的场景分类 */
+    LaunchCategory = "launch_category",
+    /** 启动小时（0-23） */
+    LaunchHour = "launch_hour",
+
+    // ==================== 关卡 ====================
+    /** 关卡ID */
+    StageId = "stage_id",
+    /** 关卡名称 */
+    StageName = "stage_name",
+    /** 是否首次进入（1=首次, 0=重玩） */
+    IsFirst = "is_first",
+    /** 关卡结束结果（success / fail / abandon） */
+    Result = "result",
+    /** 关卡进度（0-1） */
+    Progress = "progress",
+    /** 是否复活后通关（1=是, 0=否） */
+    IsRevived = "is_revived",
+    /** 复活方式（ad / item） */
+    Method = "method",
+
+    // ==================== 广告 ====================
+    /** 广告场景（业务自定义，如 revive / daily_bonus） */
+    AdScene = "ad_scene",
+    /** 广告错误码 */
+    ErrCode = "err_code",
+    /** 广告错误信息 */
+    ErrMsg = "err_msg",
 }