@chiyou/minigame-framework 1.0.0 → 1.0.2

package/assets/Scripts/Framework/Definition/AdDefinition.ts

@@ -0,0 +1,284 @@
+import { PlatformID } from "./SystemDefinition";
+
+export enum AdType {
+    Type_Banner = 0,
+    Type_Custom = 1,
+    Type_Interstitial = 2,
+    Type_RewardedVideo = 3,
+    Type_Portal = 4,
+}
+
+export type InterstitialAd_Scene = string; 
+export type RewardedVideoAd_Scene = string;
+
+export class AdCallback {
+    callback: Function;
+    target: any;
+
+    constructor(callback: Function, target: any) {
+        this.callback = callback;
+        this.target = target;
+    }
+}
+
+export class RewardedVideoAd_Record {
+    clickCount: number;
+    viewCount: number;
+    completeCount: number;
+    giveupCount: number;
+    errorCount: number;
+
+    constructor() {
+        this.clickCount = 0;
+        this.viewCount = 0;
+        this.completeCount = 0;
+        this.giveupCount = 0;
+        this.errorCount = 0;
+    }
+}
+
+export class InterstitialAd_Record {
+    viewCount: number;
+    completeCount: number;
+    errorCount: number;
+
+    constructor() {
+        this.viewCount = 0;
+        this.completeCount = 0;
+        this.errorCount = 0;
+    }
+}
+
+export class Ad_Record {
+    intersitialAdRecord: Map<InterstitialAd_Scene, InterstitialAd_Record>;
+    rewardedVideoAdRecord: Map<InterstitialAd_Scene, RewardedVideoAd_Record>;
+
+    constructor() {
+        this.intersitialAdRecord = new Map<InterstitialAd_Scene, InterstitialAd_Record>();
+        this.rewardedVideoAdRecord = new Map<InterstitialAd_Scene, RewardedVideoAd_Record>();
+    }
+}
+
+export enum InterstitialAd_Callback_Status {
+    Status_NotSupport = -2,
+    Status_Error = -1,
+    Status_Close = 0,
+    Status_Watching = 1,
+    Status_InsufficientInterval = 2,
+}
+
+export enum RewardedVideoAd_Callback_Status {
+    Status_NotSupport = -2,
+    Status_Error = -1,
+    Status_Complete = 0,
+    Status_Giveup = 1,
+    Status_Watching = 2,
+}
+
+export enum AdSwitchType {
+    Off = 0,
+    On_Debug = 1,
+    On_Release = 2,
+}
+
+export type AdPlatformUnitInfo  = {
+    switchType: AdSwitchType;
+    intersitialAd: string;
+    rewardedVideoAd: string;
+    bannerAd: string;
+    customAd: string;
+    portalAd: string;
+}
+
+export type AdPlatformSettingInfo = {
+    launchNoAdInterval_permanentAd: number;
+    launchNoAdInterval_interstitialAd: number;
+    registerUser_interstitialAd_IntervalBase: number;
+    retainUser_interstitialAd_IntervalBase: number;
+}
+
+//BannerAd
+export enum BannerAd_XPosition {
+    Center = 0,
+    Left = 1,
+    Right = 2,
+}
+
+export enum BannerAd_YPosition {
+    Center = 0,
+    Top = 1,
+    Bottom = 2,
+}
+
+export type BannerAd_Info = {
+    xPosition: BannerAd_XPosition;
+    yPosition: BannerAd_YPosition;
+    shouldShow: boolean;
+}
+
+export type BannerAd_PlatformInfo = {
+    xMargin: number;
+    yMargin: number;
+    width: number;
+    height: number;
+    scaleRatio: number;
+    canAutoRefresh: boolean;
+    refreshInterval: number;
+}
+
+// CustomAd
+export enum CustomAd_XPosition {
+    Center = 0,
+    Left = 1,
+    Right = 2,
+}
+
+export enum CustomAd_YPosition {
+    Center = 0,
+    Top = 1,
+    Bottom = 2,
+}
+
+export type CustomAd_Info = {
+    xPostion: CustomAd_XPosition;
+    yPostion: CustomAd_YPosition;
+    shouldShow: boolean;
+}
+
+export type CustomAd_PlatformInfo = {
+    xMargin: number;
+    yMargin: number;
+    width: number;
+    height: number;
+    scaleRatio: number;
+    canAutoRefresh: boolean;
+    refreshInterval: number;
+}
+
+// PortalAd
+export type PortalAd_PlatformInfo = {
+    width: number;
+    height: number;
+    scaleRatio: number;
+}
+
+export class AdDefinition {
+    static readonly AdInfoConfig = class {
+        static CustomAd_Info: CustomAd_Info = {
+            xPostion: CustomAd_XPosition.Center,
+            yPostion: CustomAd_YPosition.Top,
+            shouldShow: true,
+        }
+
+        static BannerAd_Info: BannerAd_Info = {
+            xPosition: BannerAd_XPosition.Center,
+            yPosition: BannerAd_YPosition.Bottom,
+            shouldShow: true,
+        }
+    }
+    
+    static readonly CustomAdStyleConfig: Map<PlatformID, CustomAd_PlatformInfo> = new Map<PlatformID, CustomAd_PlatformInfo>([
+        [PlatformID.ID_MiniGame_WeiXin, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 360,
+            height: 106,
+            scaleRatio: 0.8,
+            canAutoRefresh: true,
+            refreshInterval: 30,
+        }],
+    ]);
+
+    static readonly BannerAdStyleConfig: Map<PlatformID, BannerAd_PlatformInfo> = new Map<PlatformID, BannerAd_PlatformInfo>([
+        [PlatformID.ID_MiniGame_WeiXin, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 300,
+            height: 99.2,
+            scaleRatio: 1,
+            canAutoRefresh: false,
+            refreshInterval: 30,
+        }],
+        [PlatformID.ID_MiniGame_KuaiShou, {
+            xMargin: 4,
+            yMargin: 4,
+            width: 308,
+            height: 76,
+            scaleRatio: 1,
+            canAutoRefresh: true,
+            refreshInterval: 30,
+        }],
+        [PlatformID.ID_MiniGame_TapTap, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 300,
+            height: 105,
+            scaleRatio: 1,
+            canAutoRefresh: true,
+            refreshInterval: 30,
+        }],
+        [PlatformID.ID_QuickGame_XiaoMi, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 314,
+            height: 91,
+            scaleRatio: 1,
+            canAutoRefresh: true,
+            refreshInterval: 30,
+        }],
+        [PlatformID.ID_QuickGame_Oppo, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 1000,
+            height: 340,
+            scaleRatio: 0,
+            canAutoRefresh: false,
+            refreshInterval: 45,
+        }],
+        [PlatformID.ID_QuickGame_Vivo, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 720,
+            height: 113,
+            scaleRatio: 1,
+            canAutoRefresh: true,
+            refreshInterval: 30,
+        }],
+        [PlatformID.ID_QuickGame_Honor, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 600,
+            height: 120,
+            scaleRatio: 1,
+            canAutoRefresh: false,
+            refreshInterval: 30,
+        }],
+        [PlatformID.ID_QuickGame_HuaWei, {
+            xMargin: 0,
+            yMargin: 0,
+            width: 360,
+            height: 57,
+            scaleRatio: 1,
+            canAutoRefresh: true,
+            refreshInterval: 30,
+        }],
+    ]);
+
+    static readonly PortalAdStyleConfig: Map<PlatformID, PortalAd_PlatformInfo> = new Map<PlatformID, PortalAd_PlatformInfo>([
+        [PlatformID.ID_MiniGame_WeiXin, {
+            width: 360,
+            height: 434,
+            scaleRatio: 0.8,
+        }],
+        [PlatformID.ID_QuickGame_Oppo, {
+            width: 0,
+            height: 0,
+            scaleRatio: 1.0,
+        }],
+        [PlatformID.ID_QuickGame_Honor, {
+            width: 0,
+            height: 0,
+            scaleRatio: 1.0,
+        }],
+    ]);
+}

package/assets/Scripts/Framework/Definition/AdDefinition.ts.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "4.0.24",
+  "importer": "typescript",
+  "imported": true,
+  "uuid": "1d1cf073-8e39-49f6-a207-ee0f244a430c",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}

package/assets/Scripts/Framework/Definition/FrameworkBase.ts

@@ -0,0 +1,15 @@
+export class FrameworkBase {
+
+    static readonly LocalStorage = class {
+        static readonly Key_AudioMgr_EffectSwitch = "AudioMgr_EffectSwitch";
+        static readonly Key_AudioMgr_MusicSwitch = "AudioMgr_MusicSwitch";
+        static readonly Key_Settings_EffectSwitch: string = "Settings_EffectSwitch"; // old key
+        static readonly Key_Settings_MusicSwitch: string = "Settings_MusicSwitch";   // old key
+        
+        static readonly Key_UserMgr_NewUser = "UserMgr_NewUser";
+        static readonly Key_UserInfo_NewUser = "UserInfo_NewUser";  //old key
+
+        static readonly Key_PrivacyManager_KindReminder_AgreeVersion: string = "PrivacyManager_KindReminder_AgreeVersion";
+        static readonly Key_KindReminder_AgreeVersion: string = "KindReminder_AgreeVersion"; // old key
+    }
+}

package/assets/Scripts/Framework/Definition/FrameworkBase.ts.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "4.0.24",
+  "importer": "typescript",
+  "imported": true,
+  "uuid": "8ac4f730-37e4-4fea-8bcb-0376651514c1",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}

package/assets/Scripts/Framework/Definition/PrivacyDefinition.ts

@@ -0,0 +1,95 @@
+import { PlatformID } from "./SystemDefinition";
+
+export enum PrivacyType {
+    PrivacyType_FriendInteraction = 1,
+    PrivacyType_GameClub = 2,
+}
+
+export enum QueryPrivacyResult {
+    Result_Invalid = 0,
+    Result_Agree = 1,
+    Result_Continue = 2,  // 部分平台不支持授权权限，直接调用具体行为方法
+    Result_PrivacyReject = 3,
+    Result_ScopeDisable = 4,
+    Result_AuthorizeReject = 5,
+}
+
+export enum GetSettingResult {
+    Result_SettingNotAvailable = -2,            // -2 无设置
+    Result_Rejected = -1,                       // -1 表示已拒绝，引导在设置里打开
+    Result_NotExist_AuthorizeAvailable = 0,     // 0 表示不存在（历史未操作过），执行authorize
+    Result_Authorized = 1,                      // 1 表示已授权，成功
+    Result_NotExist_AuthorizeNotAvailable = 2,  // 2 表示不存在（历史未操作过），无authorize，直接调用操作
+}
+
+export enum AuthorizeResult {
+    Result_AuthorizeNotAvailable = -1,  // -1 无授权
+    Result_Rejected = 0,                // 0 已拒绝
+    Result_Authorized = 1,              // 1 已授权，成功
+}
+
+export type PrivacyInfo = {
+    privacyPlatformMap: Map<PlatformID, PrivacyPlatformInfo>;
+}
+
+export type PrivacyPlatformInfo = {
+    scopeDescription: string,
+    scopeDisable: boolean,
+    needAuthorize: boolean,
+    scopeName: string;
+}
+
+export enum KindReminderType {
+    Type_UserAgreement = 1,
+    Type_PrivacyPolicy = 2,
+}
+
+export type KindRemindItemContent = {
+    mainContent: string[][];
+    supplementaryContent: Map<PlatformID, string[][]>;
+}
+
+export type KindReminder =  {
+    latestVersion: string;
+    shouldShowPlatform: Set<PlatformID>;
+    userAgreement: KindRemindItemContent;
+    privacyPolicy: KindRemindItemContent;
+}
+
+export class PrivacyDefinition {
+
+    static readonly PrivacyConfig: Map<PrivacyType, PrivacyInfo> = new Map<PrivacyType, PrivacyInfo>([
+            [PrivacyType.PrivacyType_FriendInteraction, {
+                privacyPlatformMap: new Map([
+                    [PlatformID.ID_H5_DesktopBrowser, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_WeiXin, { scopeDescription: "用户信息", scopeDisable: false, needAuthorize: false, scopeName: "scope.WxFriendInteraction" }],
+                    [PlatformID.ID_MiniGame_DouYin, { scopeDescription: "用户信息", scopeDisable: false, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_KuaiShou, { scopeDescription: "用户信息", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_ZhiFuBao, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_Bilibili, { scopeDescription: "用户信息", scopeDisable: false, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_TapTap, { scopeDescription: "用户信息", scopeDisable: false, needAuthorize: true, scopeName: "scope.friendInteraction" }],
+                    [PlatformID.ID_MiniGame_JingDong, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_XiaoMi, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_Oppo, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_Honor, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_Vivo, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                ]),
+            }],
+            [PrivacyType.PrivacyType_GameClub, {
+                privacyPlatformMap: new Map([
+                    [PlatformID.ID_H5_DesktopBrowser, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_WeiXin, { scopeDescription: "游戏圈数据", scopeDisable: false, needAuthorize: true, scopeName: "scope.gameClubData" }],
+                    [PlatformID.ID_MiniGame_DouYin, { scopeDescription: "游戏站数据", scopeDisable: false, needAuthorize: true, scopeName: "scope.gameClub" }],
+                    [PlatformID.ID_MiniGame_KuaiShou, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_ZhiFuBao, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_Bilibili, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_TapTap, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_MiniGame_JingDong, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_XiaoMi, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_Oppo, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_Honor, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                    [PlatformID.ID_QuickGame_Vivo, { scopeDescription: "", scopeDisable: true, needAuthorize: false, scopeName: "" }],
+                ]),
+            }],
+        ]);
+}

package/assets/Scripts/Framework/Definition/PrivacyDefinition.ts.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "4.0.24",
+  "importer": "typescript",
+  "imported": true,
+  "uuid": "7775419f-a289-4373-83d2-8ceaaaa82005",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}

package/assets/Scripts/Framework/Definition/SocialDefinition.ts

@@ -0,0 +1,21 @@
+import { PlatformID } from "./SystemDefinition";
+
+export type ShareDefaultInfo = {
+    title: string;
+    desc: string;
+    imageUrl: string;
+}
+
+export type ShareTemplateInfo = {
+    templateId: string;
+    imageUrl: string;
+}
+
+export type ShareInfo = {
+    defaultInfo: ShareDefaultInfo;
+    templateInfoMap: Map<PlatformID, ShareTemplateInfo>;
+}
+
+export class SocialDefinition {
+    
+}

package/assets/Scripts/Framework/Definition/SocialDefinition.ts.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "4.0.24",
+  "importer": "typescript",
+  "imported": true,
+  "uuid": "474e3aab-4361-4534-abeb-2fc474a2f8e0",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}

package/assets/Scripts/Framework/Definition/SystemDefinition.ts

@@ -0,0 +1,58 @@
+export enum PlatformID {
+    ID_UNKNOWN = -1,
+    ID_H5_DesktopBrowser = 0,       //DESKTOP_BROWSER
+
+    ID_MiniGame_WeiXin = 1,         //WECHAT_GAME
+    ID_MiniGame_DouYin = 2,         //BYTEDANCE_MINI_GAME
+    ID_MiniGame_KuaiShou = 3,       //Transfer From WECHAT_GAME
+    ID_MiniGame_QQ = 4,             //Transfer From WECHAT_GAME
+    ID_MiniGame_ZhiFuBao = 5,       //ALIPAY_MINI_GAME
+    ID_MiniGame_Bilibili = 6,       //Transfer From WECHAT_GAME
+    ID_MiniGame_TapTap = 7,         //Transfer From WECHAT_GAME
+    ID_MiniGame_JingDong = 8,       //Transfer From WECHAT_GAME
+
+    ID_QuickGame_XiaoMi = 101,      //XIAOMI_QUICK_GAME
+    ID_QuickGame_Oppo = 102,        //OPPO_MINI_GAME
+    ID_QuickGame_Honor = 103,       //HONOR_MINI_GAME
+    ID_QuickGame_Vivo = 104,        //VIVO_MINI_GAME
+    ID_QuickGame_HuaWei = 105,      //HUAWEI_QUICK_GAME
+}
+
+export type AppItem = {
+    appIndex: number;
+    appName: string;
+    appLogo_SpriteAtlas: string;
+    appLogo_SpriteFrame: string;
+    appIDMap: Map<PlatformID, string>;
+}
+
+export class ScreenInfo {
+    windowWidth: number;
+    windowHeight: number;
+    screenWidth: number;
+    screenHeight: number;
+
+    constructor(windowWidth: number, windowHeight: number, screenWidth: number, screenHeight: number) {
+        this.windowWidth = windowWidth;
+        this.windowHeight = windowHeight;
+        this.screenWidth = screenWidth;
+        this.screenHeight = screenHeight;
+    }
+}
+
+export type ICPItem = {
+    icpSubject: string;
+    icpNumber: string;
+    isLocalGame: boolean;
+}
+
+export type CopyrightInfo = {
+    copyrightSubject: string;
+    copyrightNumber: string;
+    icpMap: Map<PlatformID, ICPItem>;
+}
+
+export class SystemDefinition {
+    
+    
+}

package/assets/Scripts/Framework/Definition/SystemDefinition.ts.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "4.0.24",
+  "importer": "typescript",
+  "imported": true,
+  "uuid": "79e55149-70e3-4a90-98e4-8110331af231",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}

package/assets/Scripts/Framework/Definition/UIDefinition.ts

@@ -0,0 +1,10 @@
+import { Color } from "cc";
+
+export enum ToastDuration {
+    Duration_Short = 1,
+    Duration_Long = 2,
+}
+
+export class UIDefinition {
+    
+}

package/assets/Scripts/Framework/Definition/UIDefinition.ts.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "4.0.24",
+  "importer": "typescript",
+  "imported": true,
+  "uuid": "6f15e96c-b78f-47d4-9d25-2d6528e881f4",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}

package/assets/Scripts/Framework/Definition/UserDefinition.ts

@@ -0,0 +1,17 @@
+export enum LoginResultType {
+    Type_SessionAvailable = 0,
+    Type_LoginSuccess_Auth_Code = 1,
+    Type_LoginSuccess_Auth_AccountID = 2,
+    Type_LoginFail_ContinueGame = 3,
+    Type_LoginFail_ExitGame = 4,
+}
+
+export type LoginResult = {
+    type: LoginResultType;
+    code: string;
+    accountId: number;
+}
+
+export class UserDefinition {
+    
+}

package/assets/Scripts/Framework/Definition/UserDefinition.ts.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "4.0.24",
+  "importer": "typescript",
+  "imported": true,
+  "uuid": "0bb33157-2b67-442c-9668-f46395c33102",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}

package/assets/Scripts/Framework/Definition.meta

@@ -0,0 +1,9 @@
+{
+  "ver": "1.2.0",
+  "importer": "directory",
+  "imported": true,
+  "uuid": "491072fe-7df6-4af4-a86a-dcf474857ab7",
+  "files": [],
+  "subMetas": {},
+  "userData": {}
+}