keytops-game-framework 1.0.0

package/dist/app/module/publisher/IDevice.d.ts

@@ -0,0 +1,42 @@
+export type DeviceInfo = {
+    /**操作系统版本 */
+    system: string;
+    /**操作系统类型 */
+    platform: string;
+    /**手机品牌 */
+    brand: string;
+    /**手机型号 */
+    model: string;
+};
+export type HostInfo = {
+    /**宿主app名称 */
+    name: string;
+    /**宿主app 版本 */
+    version: string;
+};
+/**
+ * 设备
+ */
+export declare class IDevice {
+    protected _type: string;
+    init(type: string): IDevice;
+    /**
+     * 震动开关，自动存储开关数据到本地storage。
+     */
+    set vibrateAble(value: boolean);
+    get vibrateAble(): boolean;
+    /**
+     * 手机震动
+     * @param long
+     * @param style long为false时支持的震动级别，部分机型和平台支持。
+     */
+    vibrate(long: boolean, style?: "heavy" | "medium" | "light"): void;
+    /**
+     * 设备信息
+     */
+    get deviceInfo(): DeviceInfo;
+    /**
+     * 宿主信息
+     */
+    get hostInfo(): HostInfo;
+}

package/dist/app/module/publisher/IGameUpdateAble.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 平台游戏更新。
+ * 获取方式：publisher.updater
+ */
+export declare class IGameUpdateAble {
+    protected _plat: any;
+    private _siwtcha;
+    private _hasInit;
+    private _hasUpdate;
+    get can(): boolean;
+    /**
+     * 是否需要更新
+     */
+    get needUpdate(): boolean;
+    /**
+     * 初始化
+     * @param switcha 自定义开关
+     * @returns
+     */
+    init(switcha: boolean): void;
+}

package/dist/app/module/publisher/ILoginAble.d.ts

@@ -0,0 +1,38 @@
+import { argType } from "./IPublisher";
+/**
+ * 登录能力
+ */
+export declare class ILoginAble {
+    private _openId;
+    protected _type: string;
+    /**
+     * 初始化
+     * @param type 功能类型，如：wx;tt等
+     */
+    init(type: string): ILoginAble;
+    /**
+     * 是否支持
+     */
+    isSupport(): boolean;
+    /**
+     * 登录，helper内登录成功后，必须调用this._setOpenId();否则后续逻辑会有BUG
+     */
+    login(caller?: any, onSuccess?: () => void, onFail?: () => void): void;
+    protected _setOpenID(openID: string): void;
+    /**
+     * 注销
+     */
+    logout(): void;
+    /**
+     * 登录成功的sessionID
+     */
+    get sessionID(): argType;
+    /**
+     * 登录成功的openID
+     */
+    get openID(): argType;
+    /**
+     * 获取用户信息
+     */
+    get userInfo(): any;
+}

package/dist/app/module/publisher/IPayAble.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 支付能力
+ */
+export declare class IPayAble {
+    protected _type: string;
+    init(type: string): IPayAble;
+    /**
+     * 支付
+     */
+    pay(money: number): void;
+}

package/dist/app/module/publisher/IPublisher.d.ts

@@ -0,0 +1,154 @@
+import { EventDispatcher } from "../../base/event/EventDispatcher";
+export type argType = string | boolean | number;
+export type PublisherAppInfoStruct = {
+    /**
+     * 游戏平台id
+     */
+    appId?: string;
+    /**
+     * 游戏版本号
+     */
+    version?: string;
+    /**
+     * 宿主版本类型
+     */
+    envVersion?: string;
+    options?: PublisherOptions;
+};
+export type PublisherOptions = Record<string, any>;
+export declare class EnterOptionParser {
+    protected _options: any;
+    constructor(options: any);
+    /**
+     * 是否匹配对应的来源渠道场景
+     * @param scenes
+     * @returns
+     */
+    isFromScene(scenes: string[] | string): boolean;
+    /**
+     * 来源的渠道场景
+     */
+    get channelScene(): string;
+    /**
+     * 来源的渠道
+     */
+    get channelSource(): string;
+    /**
+     * 获取启动配置项
+     * @param key 支持xx.xx递归索引，任何一级不存在返回null
+     * @returns
+     */
+    getOption<T>(key: string): T | null;
+    getAllOption(): any;
+}
+/**
+ * 平台基类
+ */
+export declare class IPublisher extends EventDispatcher {
+    static TYPE_HL: string;
+    static TYPE_DEV: string;
+    static TYPE_H5: string;
+    static TYPE_TT: string;
+    static TYPE_233: string;
+    protected _type: string;
+    protected _appInfo: PublisherAppInfoStruct;
+    protected _customAppInfo: PublisherAppInfoStruct;
+    protected _enterOptions: EnterOptionParser;
+    protected _installOptions: EnterOptionParser;
+    protected _eventShowMap: Map<string, any>;
+    protected _eventHideMap: Map<string, any>;
+    protected _eventErrorMap: Map<string, any>;
+    protected static INSTALL_SOURCE_KEY: string;
+    /**
+     * 初始化平台
+     * @param type 平台标视
+     * @param config 平台配置 PublisherConfig
+     * @returns
+     */
+    init(type: string, custom?: PublisherAppInfoStruct): IPublisher;
+    protected _onAppShow(info: {
+        query: {};
+        scene: string | number;
+    }): void;
+    /**
+     * 获取发行商名称，Develop保留位开发环境
+     */
+    get type(): string;
+    /**
+     * 获取发行商下的APPID
+     */
+    get appId(): string;
+    /**
+     * 获取版本
+     */
+    get appVersion(): string;
+    /**
+     * 当前版本是否为正式版
+     */
+    get isReleaseEnv(): boolean;
+    /**
+     * 当前版本是否为开发环境中
+     */
+    get isDevelopEnv(): boolean;
+    /**
+     * 当前版本是否为体验版
+     */
+    get isTrialEnv(): boolean;
+    /**
+     * 当前版本是否是处于灰色测试中
+     */
+    get isGrayEnv(): boolean;
+    /**
+     * 平台初始化
+     * @param caller
+     * @param onSuccess
+     * @param onFail
+     */
+    initSDK(caller?: any, onSuccess?: Function, onFail?: Function): void;
+    private _init;
+    private _listenError;
+    /**
+     * 获取启动信息
+     * @param plat
+     * @returns
+     */
+    get enterOptions(): EnterOptionParser;
+    /**
+     * 安装来源
+     */
+    get installOptions(): EnterOptionParser;
+    /**
+     * 获取启动参数
+     * @returns
+     */
+    protected _initEnterOptions(info?: any): EnterOptionParser;
+    /**
+     * 获取安装来源
+     * @returns
+     */
+    protected _initInstallOptions(): EnterOptionParser;
+    /**
+     * 订阅推送
+     * @param subscribeMsgIds 订阅消息模板ID列表
+     * @returns
+     */
+    subscribeMessage(subscribeMsgIds: string[]): Promise<boolean>;
+    protected _subscribeMessage(subscribeMsgIds: string[], plat?: any): Promise<boolean>;
+    /**
+     * 进入平台界面
+     */
+    showView(viewName: string, caller?: any, onClose?: Function): void;
+    protected _getMapKey(call: Function, caller?: any): string;
+    protected _getCall(map: Map<string, any>, call: () => void, caller?: any): any;
+    onError(call: (...error: any[]) => void, caller?: any): void;
+    offError(call: (...error: any[]) => void, caller?: any): void;
+    onShow(call: (data?: any) => void, caller?: any): void;
+    offShow(call: () => void, caller?: any): void;
+    onHide(call: () => void, caller?: any): void;
+    offHide(call: () => void, caller?: any): void;
+    restart(): void;
+    /**
+     * 退出
+     */
+    exit(): void;
+}

package/dist/app/module/publisher/IPublisherManager.d.ts

@@ -0,0 +1,69 @@
+import { IAbleHelper } from "./IAble";
+import { IADAble, ADConfig } from "./IADAble";
+import { IDevice } from "./IDevice";
+import { IGameUpdateAble } from "./IGameUpdateAble";
+import { ILoginAble } from "./ILoginAble";
+import { IPayAble } from "./IPayAble";
+import { IPublisher, PublisherAppInfoStruct } from "./IPublisher";
+import { IRecordAble } from "./IRecordAble";
+import { IShareAble } from "./IShareAble";
+export declare abstract class IPublisherManager {
+    private _publisher;
+    private _ad;
+    private _login;
+    private _pay;
+    private _record;
+    private _share;
+    private _updater;
+    private _device;
+    private _abilityMap;
+    abstract enable(): void;
+    /**
+     * 初始化平台
+     * @param publisherId 平台ID，0保留为DEVELOP
+     * @param publisher
+     */
+    protected setPublisher(type: string, publisher: {
+        new (): IPublisher;
+    }, customAppInfo?: PublisherAppInfoStruct): void;
+    /**
+     * 获取平台类实例
+     * @return IPublisher
+     */
+    get publisher(): IPublisher;
+    protected setDevice(type: string, device: {
+        new (): IDevice;
+    }): void;
+    get device(): IDevice;
+    get type(): string;
+    get appId(): string;
+    get appVersion(): string;
+    isTarget(type: string): boolean;
+    protected enableAdAble(type: string, ad: {
+        new (): IADAble;
+    }, config: ADConfig): void;
+    get ad(): IADAble;
+    protected enableLogin(type: string, login: {
+        new (): ILoginAble;
+    }): void;
+    get login(): ILoginAble;
+    protected enablePay(type: string, pay: {
+        new (): IPayAble;
+    }): void;
+    get pay(): IPayAble;
+    protected enableRecord(type: string, record: {
+        new (): IRecordAble;
+    }): void;
+    get record(): IRecordAble;
+    protected enableShare(type: string, share: {
+        new (): IShareAble;
+    }): void;
+    get share(): IShareAble;
+    protected enableGameUpdate(type: string, updater: {
+        new (): IGameUpdateAble;
+    }): void;
+    get updater(): IGameUpdateAble;
+    helper<T extends IAbleHelper>(abilityClass: {
+        new (): T;
+    }): IAbleHelper;
+}

package/dist/app/module/publisher/IRecordAble.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 录屏能力
+ */
+export declare class IRecordAble {
+    protected _type: string;
+    /**
+     * 初始化
+     * @param type 功能类型，如：wx;tt等
+     */
+    init(type: string): IRecordAble;
+    startRecord(duration?: number, frameRate?: number): void;
+    stopRecord(): void;
+    pauseRecord(): void;
+    resumeRecord(): void;
+    get videoPath(): string;
+}

package/dist/app/module/publisher/IShareAble.d.ts

@@ -0,0 +1,39 @@
+import { AnalyticsData } from "../analytics/index";
+import { KSShareParameters } from "./ks/KSShare";
+import { TTShareParameters } from "./tt/TTShare";
+import { WXShareParameters } from "./wx/WXShare";
+export type ShareParameters = string | WXShareParameters | TTShareParameters | KSShareParameters;
+/**
+ * 分享能力
+ */
+export declare class IShareAble {
+    protected _type: string;
+    /**
+     * 初始化
+     * @param type 功能类型，如：wx;tt等
+     */
+    init(type: string): IShareAble;
+    /**
+     * 转换分享的query参数
+     * @param query 外部query
+     * @returns
+     */
+    protected _getShareQuery(analyticsName: string | {
+        name: string;
+    } & AnalyticsData, query?: string): string;
+    protected _report(analyticsName: string | AnalyticsData, msg: string): void;
+    /**
+     * 分享图片或者文字
+     * @param analyticsName 玩法发起分享的动作来源，用于统计。
+     * @param data 分享参数，可以通过明确泛型确定不同平台的分享结构体，如：WXShareParameters
+     * @returns
+     */
+    shareTextOrImage<T extends ShareParameters>(analyticsName: string | {
+        name: string;
+    } & AnalyticsData, data?: T): Promise<boolean>;
+    shareVideo(analyticsName: string | {
+        name: string;
+    } & AnalyticsData, data: string | {
+        [key: string]: any;
+    }): Promise<boolean>;
+}

package/dist/app/module/publisher/PublisherManager.d.ts

@@ -0,0 +1,106 @@
+import { IAbleHelper } from "./IAble";
+import { IADAble } from "./IADAble";
+import { IDevice } from "./IDevice";
+import { IGameUpdateAble } from "./IGameUpdateAble";
+import { ILoginAble } from "./ILoginAble";
+import { IPayAble } from "./IPayAble";
+import { IPublisher } from "./IPublisher";
+import { IRecordAble } from "./IRecordAble";
+import { IShareAble } from "./IShareAble";
+export declare class PublisherManager {
+    /**
+     * 全局唯一注入KEY
+     */
+    static KEY: string;
+    private static created;
+    constructor();
+    get publisher(): IPublisher;
+    /**
+     * 带泛型的publisher
+     * @returns
+     */
+    publisherT<T extends IPublisher>(): T;
+    get type(): string;
+    get appId(): string;
+    get appVersion(): string;
+    /**
+     * 是否是目标平台
+     * @param type 目标平台
+     * @returns
+     */
+    isTarget(type: string): boolean;
+    /**
+     * 广告能力banner、插屏、激励视频等
+     */
+    get ad(): IADAble;
+    /**
+     * 带泛型的ad
+     * @returns
+     */
+    adT<T extends IADAble>(): T;
+    /**
+     * 平台登录能力
+     */
+    get login(): ILoginAble;
+    /**
+     * 带泛型的login
+     * @returns
+     */
+    loginT<T extends ILoginAble>(): T;
+    /**
+     * 支付能力
+     */
+    get pay(): IPayAble;
+    /**
+     * 带泛型的pay
+     * @returns
+     */
+    payT<T extends IPayAble>(): T;
+    /**
+     * 录屏能力
+     */
+    get record(): IRecordAble;
+    /**
+     * 带泛型的record
+     * @returns
+     */
+    recordT<T extends IRecordAble>(): T;
+    /**
+     * 分享能力，微信分享、抖音分享等
+     */
+    get share(): IShareAble;
+    /**
+     * 带泛型的share
+     * @returns
+     */
+    shareT<T extends IShareAble>(): T;
+    /**
+     * 设备相关操作[震动、电量、网络状况等]
+     */
+    get device(): IDevice;
+    /**
+     * 带泛型的device
+     * @returns
+     */
+    deviceT<T extends IDevice>(): T;
+    /**
+     * 游戏更新器
+     * @returns
+     */
+    get updater(): IGameUpdateAble;
+    /**
+     * 其他功能的协助协助器
+     * @param abilityClass
+     * @returns
+     */
+    helper<T extends IAbleHelper>(abilityClass: {
+        new (): T;
+    }): T;
+    enable(): void;
+    private _impl;
+    private get impl();
+}
+/**
+ * 多平台管理，集成平台的登录，支付等功能。
+ */
+export declare const publisher: PublisherManager;

package/dist/app/module/publisher/PublisherManagerImpl.d.ts

@@ -0,0 +1,24 @@
+import { PublisherAppInfoStruct } from "./IPublisher";
+import { IPublisherManager } from "./IPublisherManager";
+/**
+ * 通用平台管理实现。
+ * 负责在通用运行时中检测平台并启用对应能力。
+ */
+export declare class PublisherManagerImpl extends IPublisherManager {
+    private _customAppInfo;
+    constructor(customAppInfo?: PublisherAppInfoStruct);
+    private _init;
+    enable(): void;
+    private _initWeb;
+    private _enableWeb;
+    private _initTT;
+    private _enableTT;
+    private _initWX;
+    private _enableWX;
+    private _initKS;
+    private _enableKS;
+    private _initMY;
+    private _enableMY;
+    private _initNative;
+    private _enableNative;
+}

package/dist/app/module/publisher/ks/KSAd.d.ts

@@ -0,0 +1,7 @@
+import { IADAble, ADConfig } from "../IADAble";
+import { AdFrom } from "../../analytics/ad/ADBehaviorReporter";
+import { WXAd } from "../wx/WXAd";
+export declare class KSAd extends WXAd {
+    init(type: string, config: ADConfig): IADAble;
+    loadInterstitial(from: AdFrom, unitIdIndex?: number): Promise<void>;
+}

package/dist/app/module/publisher/ks/KSDevice.d.ts

@@ -0,0 +1,8 @@
+import { IDevice, DeviceInfo, HostInfo } from "../IDevice";
+export declare class KSDevice extends IDevice {
+    protected _ks: any;
+    init(type: string): IDevice;
+    vibrate(long: boolean, style?: "heavy" | "medium" | "light"): void;
+    get deviceInfo(): DeviceInfo;
+    get hostInfo(): HostInfo;
+}

package/dist/app/module/publisher/ks/KSLogin.d.ts

@@ -0,0 +1,7 @@
+import { ILoginAble } from "../ILoginAble";
+export declare class KSLogin extends ILoginAble {
+    protected _ks: any;
+    protected _auth: any;
+    init(type: string): ILoginAble;
+    login(caller?: any, onSuccess?: () => void, onFail?: () => void): void;
+}

package/dist/app/module/publisher/ks/KSPublisher.d.ts

@@ -0,0 +1,34 @@
+import { EnterOptionParser, IPublisher } from "../IPublisher";
+export declare class KSPublisher extends IPublisher {
+    protected _ks: any;
+    init(type: string): IPublisher;
+    get appVersion(): string;
+    get appId(): string;
+    private _setAppInfo;
+    /**
+     * 当前版本是否为正式版
+     */
+    get isReleaseEnv(): boolean;
+    /**
+     * 当前版本是否为开发环境中
+     */
+    get isDevelopEnv(): boolean;
+    /**
+     * 当前版本是否为体验版
+     */
+    get isTrialEnv(): boolean;
+    /**
+     * 当前版本是否是处于灰色测试中
+     */
+    get isGrayEnv(): boolean;
+    protected _initEnterOptions(info: any): EnterOptionParser;
+    protected _initInstallOptions(): EnterOptionParser;
+    subscribeMessage(subscribeMsgIds: string[]): Promise<boolean>;
+    onError(call: (...error: any[]) => void, caller?: any): void;
+    offError(call: (...error: any[]) => void, caller?: any): void;
+    onShow(call: (data?: any) => void, caller?: any): void;
+    offShow(call: () => void, caller?: any): void;
+    onHide(call: () => void, caller?: any): void;
+    offHide(call: () => void, caller?: any): void;
+    restart(): void;
+}

package/dist/app/module/publisher/ks/KSRecorder.d.ts

@@ -0,0 +1,13 @@
+import { IRecordAble } from "../IRecordAble";
+export declare class KSRecorder extends IRecordAble {
+    protected _recorder: any;
+    protected _videoPath: string;
+    protected _videoID: string;
+    init(type: string): IRecordAble;
+    startRecord(duration?: number, frameRate?: number): void;
+    stopRecord(): void;
+    pauseRecord(): void;
+    resumeRecord(): void;
+    get videoPath(): string;
+    publicVideo(query: string, mouldId?: string): Promise<boolean>;
+}

package/dist/app/module/publisher/ks/KSShare.d.ts

@@ -0,0 +1,32 @@
+import { AnalyticsData } from "../../analytics/index";
+import { argType } from "../IPublisher";
+import { IShareAble, ShareParameters } from "../IShareAble";
+/**
+ * 快手分享参数，用于share.shareTextOrImage接口的泛型指定
+ *
+ * - 方式1：图文模板分享 ```{templateId:"通过审核的分享ID", query: "通过分享进入的启动参数"}```
+ *
+ * tips:分享到好友增加参数：```channel:"invite"```
+ */
+export type KSShareParameters = {
+    /**
+     * 查询字符串，从这条转发消息进入后，可通过 app.publisher.publisher.enterOptions 获取启动参数中的 query。必须是 key1=val1&key2=val2 的格式。
+     */
+    query?: string;
+    /**
+     * 通过审核的分享ID
+     */
+    templateId?: string;
+};
+export declare class KSShare extends IShareAble {
+    protected _ks: any;
+    init(type: string): IShareAble;
+    shareTextOrImage<T extends ShareParameters>(analyticsName: string | ({
+        name: string;
+    } & AnalyticsData), data?: T): Promise<boolean>;
+    shareVideo(analyticsName: string | {
+        name: string;
+    } & AnalyticsData, data: {
+        [key: string]: argType;
+    }): Promise<boolean>;
+}

package/dist/app/module/publisher/my/MYAd.d.ts

@@ -0,0 +1,13 @@
+import { IADAble, ADConfig } from "../IADAble";
+import { AdFrom } from "../../analytics/ad/ADBehaviorReporter";
+/**
+ * 支付宝广告
+ */
+export declare class MYAd extends IADAble {
+    protected _my: any;
+    protected _tempInterstitial: any;
+    init(type: string, config: ADConfig): IADAble;
+    loadInterstitial(from: AdFrom, unitIdIndex?: number): Promise<void>;
+    showInterstitial(from: AdFrom, unitIdIndex?: number): Promise<void>;
+    showRewardVideo(from: AdFrom, breakConfirm?: boolean, unitIdIndex?: number): Promise<boolean>;
+}

package/dist/app/module/publisher/my/MYDevice.d.ts

@@ -0,0 +1,7 @@
+import { DeviceInfo, HostInfo, IDevice } from "../IDevice";
+import { WXDevice } from "../wx/WXDevice";
+export declare class MYDevice extends WXDevice {
+    init(type: string): IDevice;
+    get deviceInfo(): DeviceInfo;
+    get hostInfo(): HostInfo;
+}

package/dist/app/module/publisher/my/MYLogin.d.ts

@@ -0,0 +1,6 @@
+import { ILoginAble } from "../ILoginAble";
+export declare class MYLogin extends ILoginAble {
+    protected _my: any;
+    init(type: string): ILoginAble;
+    login(caller?: any, onSuccess?: () => void, onFail?: () => void): void;
+}

package/dist/app/module/publisher/my/MYPublisher.d.ts

@@ -0,0 +1,6 @@
+import { IPublisher } from "../IPublisher";
+import { WXPublisher } from "../wx/WXPublisher";
+export declare class MYPublisher extends WXPublisher {
+    init(type: string): IPublisher;
+    subscribeMessage(subscribeMsgIds: string[]): Promise<boolean>;
+}