keytops-game-framework 1.0.0

package/dist/app/base/utils/StringUtils.d.ts

@@ -0,0 +1,66 @@
+export declare class StringUtils {
+    static random(length: number, chars?: string): string;
+    /**
+     * 判断是否是远程资源
+     * @param url
+     * @returns
+     */
+    static isRemote(url: string): boolean;
+    /**
+     * 是否为空
+     * @param str
+     */
+    static isEmpty(str: string): boolean;
+    /**
+    * 替换全部字符串
+    * @param string src 源串
+    * @param string from_ch 被替换的字符
+    * @param string to_ch 替换的字符
+    *
+    * @return string 结果字符串
+    */
+    static replaceAll(src: string, from_ch: string, to_ch: string): string;
+    /**
+     * 参数替换
+     *  @param  str
+     *  @param  rest
+     *
+     *  @example
+     *
+     *  var str:string = "here is some info '{0}' and {1}";
+     *  trace(StringUtil.substitute(str, 15.4, true));
+     *
+     *  // this will output the following string:
+     *  // "here is some info '15.4' and true"
+     */
+    static format(str: string, ...rest: any[]): string;
+    /**
+     *
+     * 格式化数字
+     * @param amount 目标数字
+     * @param format 支持{1:"", 100:"百", 1000:"千", 10000:"万", 100000:"十万", 1000000:"百万", 10000000:"千万", 100000000:"亿", 1000000000000:"兆"}等
+     * @returns
+     */
+    static formatNumber(amount: number, format: any): string;
+    /**
+     * 带自动补全的秒数格式。
+     * @param second 秒数
+     * @param format 格式化文本
+     * @param pad 填充文本，默认为“0”
+     * @example
+     * formatSecond(86400, "ddd天hh小时mm分ss秒")=>"001天00小时00分00秒"
+     * formatSecond(86400, "dd天hh小时mm分ss秒")=>"01天00小时00分00秒"
+     * formatSecond(86400, "hh小时mm分ss秒")=>"24小时00分00秒"
+     * formatSecond(86400, "mm分ss秒")=>"1440分00秒"
+     * @returns
+     */
+    static formatSecond(second: number, format: string, pad?: string): string;
+    /**
+     * 带自动补全的时间戳格式化
+     * @param milliseconds
+     * @param format
+     * @param pad 填充文本，默认为“0”
+     * @returns
+     */
+    static formatTimestamp(milliseconds: number, format: string, pad?: string): string;
+}

package/dist/app/module/abTesting/ABTesting.d.ts

@@ -0,0 +1,41 @@
+export type ABTestingProportion = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100;
+/**
+ * ABTesting配置
+ */
+export type ABTestingConfig = {
+    [key: string]: ABTestingProportion;
+};
+declare class ABTesting {
+    private _flags;
+    private _nameToKey;
+    private _config;
+    init(abConfig: {
+        [name: string]: ABTestingConfig;
+    }, install?: boolean, launch?: boolean): void;
+    /**
+     * 以当前启动粒度，从一组区间配置中获取命中key。
+     * @param name AB测试的配置名称，需要先调用setFlagConfigs进行配置，否则固定返回Invalid
+     * @returns
+     */
+    getLaunchFlag(name: string): string;
+    /**
+     * 以客户端安装粒度，获取key对应的命中key
+     * @param name AB测试的配置名称，从一组区间配置中获取命中key。
+     * @returns
+     */
+    getInstallFlag(name: string): string;
+    /**
+     * 以临时粒度，获取key对应的命中key
+     * @param name AB测试的配置名称，从一组区间配置中获取命中key。
+     * @returns
+     */
+    getTempFlag(name: string): string;
+    private _getGroupFlag;
+    private _getFlag;
+    private _updateAnalytics;
+}
+/**
+ * AB测试
+ */
+export declare const ab: ABTesting;
+export {};

package/dist/app/module/analytics/ALiAnalyticsSender.d.ts

@@ -0,0 +1,59 @@
+import { EmptyAnalyticsSender } from "./AnalyticsAble";
+/**
+ * 阿里云日志时间配置
+ */
+export type AliAnalyticsConfig = {
+    /**
+     * 所在区域的host, 默认为`cn-hangzhou.log.aliyuncs.com`
+     */
+    host?: string;
+    /**
+     * project名称
+     */
+    project: string;
+    /**
+     * logstore名称
+     */
+    logstore: string;
+    /**
+     * 时间戳的获取函数
+     * @returns
+     */
+    timestampCall: () => number;
+    /**
+     * 发送数据的CD，默认是2秒
+     */
+    cd?: number;
+    /**
+     * 发送数据的条数，默认是5条
+     */
+    count?: number;
+};
+/**
+ * 内部阿里云日志事件上报器
+ */
+export declare class ALiAnalyticsSender extends EmptyAnalyticsSender {
+    private _tracker;
+    private _config;
+    protected _eventCache: any[];
+    protected _index: number;
+    private _storageKey;
+    /**
+     *
+     * @param project
+     * @param logstore
+     * @param host
+     * @param exclude
+     * @param cd
+     * @param count
+     */
+    constructor(config: AliAnalyticsConfig, exclude?: string[]);
+    private _setConfig;
+    private _loadStoredEvents;
+    private _storeEvents;
+    private _startLoop;
+    private _addListen;
+    private _restoreEvents;
+    protected _doReport(maxCount?: number, store?: boolean): boolean;
+    send(eventName: string, data: any): Promise<void>;
+}

package/dist/app/module/analytics/AnalyticsAble.d.ts

@@ -0,0 +1,191 @@
+/**
+ * 上报数据通用格式定义,方便项目间的通用数据统计
+ */
+export type AnalyticsData = {
+    /**
+     * 标记型ID，可用于关卡id、道具\装备id、广告id等的标记
+     */
+    id?: string | number;
+    /**
+     * number类型，定义偏向索引，可用于对象的顺序、位置等信息的描述
+     */
+    index?: number;
+    /**
+     * string类型，定义偏向于标记，可用于关卡名称、道具名称、行为分类名称等的标记
+     */
+    name?: string;
+    /**
+     * string类型，定义偏向于结果，可用于行为后的结果消息等。
+     */
+    msg?: string;
+    /**
+     * number类型，定义偏向于结果，可用于行为后的结果code等。
+     */
+    code?: number;
+    /**
+     * number类型，定义偏向计数数值，可以用于模型行为的计数、数量等。
+     */
+    count?: number;
+    [key: string]: string | boolean | number;
+};
+export interface IAnalyticsSender {
+    /**
+     * 是否需要发送
+     * @param eventName
+     */
+    sendAble(eventName: string): boolean;
+    /**
+     * 设置排除
+     * @param excludeList 排除事件名称或者名称列表。
+     */
+    exclude(...excludeList: string[]): void;
+    /**
+     * 上报
+     * @param eventName 事件名称
+     * @param data 事件数据
+     */
+    send(eventName: string, data: any): Promise<void>;
+}
+export declare class EmptyAnalyticsSender implements IAnalyticsSender {
+    protected _exclude: string[];
+    /**
+     * @param [exclude] 其他排除的上报日志, 默认不排除
+     */
+    constructor(exclude?: string[]);
+    /**
+     * 设置排除
+     * @param excludeList 排除事件名称或者名称列表。
+     */
+    exclude(...excludeList: string[]): void;
+    sendAble(eventName: string): boolean;
+    send(eventName: string, data: any): Promise<void>;
+}
+/**
+ * 统计分析能力
+ */
+export declare class AnalyticsAble {
+    private _inited;
+    get inited(): boolean;
+    private _hasSetDefaultProperty;
+    protected _debugMode: boolean;
+    protected _senderList: IAnalyticsSender[];
+    protected _staticProperties: AnalyticsData;
+    protected _dynamicCalls: (() => AnalyticsData)[];
+    protected _userProperties: AnalyticsData;
+    protected _userOnceProperties: AnalyticsData;
+    protected _userAddProperties: AnalyticsData;
+    protected _timeEvents: Map<string, {
+        start: number;
+        once: boolean;
+        offset: number;
+    }>;
+    /**
+     * 初始化
+     */
+    init(senders: IAnalyticsSender[], debugMode?: boolean): AnalyticsAble;
+    private _initSenderList;
+    /**
+     * 设置排除
+     * @param excludeEvents 排除事件名称或者名称列表。
+     * @param senderClass [可选] 特定的SenderClass
+     */
+    setExclude<T extends IAnalyticsSender>(excludeEvents: string | string[], senderClass?: {
+        new (): T;
+    }): void;
+    protected _onAppShow(): void;
+    protected _onAppHide(): void;
+    /**
+     * 设置所有上报事件的基础属性
+     */
+    private _setDefaultProperty;
+    /**
+     * 设置事件公共属性
+     * @param key 公共属性key
+     * @param value
+     */
+    setProperty(key: string, value: string | number | boolean): void;
+    /**
+     * 删除事件的公共属性
+     * @param key
+     * @returns
+     */
+    unsetProperty(key: string): boolean;
+    /**
+     * 设置事件公共动态属性,上报事件时会触发回调函数，并把返回的AnalyticsData加入到事件属性中
+     * @param dynamicCall 动态属性的生成函数，事件上报时实时调用
+     */
+    setDynamicProperties(dynamicCall: () => AnalyticsData): void;
+    /**
+     * 对于一般的用户属性，您可以调用 userSet 来进行设置。
+     * 使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致。
+     * 用户名为例：
+     * ```
+     * // username为TA
+     * userSet("username", "TA");
+     * //username为TE
+     * userSet("username", "TE");
+     * ```
+     * @param key 属性key
+     * @param value
+     */
+    userSet(key: string, value: string | number | boolean): void;
+    /**
+     * 如果您要上传的用户属性只要设置一次，则可以调用 userSetOnce 来进行设置。
+     * 当该属性之前已经有值的时候，将会忽略这条信息，比如设置首次付费时间：
+     * ```
+     * //first_payment_time为2018-01-01 01:23:45.678
+     * userOnce("first_payment_time", "2018-01-01 01:23:45.678");
+     * //first_payment_time仍然为2018-01-01 01:23:45.678
+     * userOnce("first_payment_time", "2018-12-31 01:23:45.678");
+     *   ```
+     * @param key 属性key
+     * @param value
+     * @returns
+     */
+    userOnce(key: string, value: string | number | boolean): void;
+    /**
+     *设置用户累积属性，当您要上传数值型的属性时，您可以调用 userAdd 来对该属性进行累加操作，
+     * 如果该属性还未被设置，则会赋值 0 后再进行计算。
+     * 如果传入负值，等同于减法操作。
+     * ```
+     * userAdd("total_revenue", 30); //此时total_revenue为30
+     * userAdd("total_revenue", 648); //此时total_revenue为678
+     * ```
+     * @param key 累积属性key
+     * @param value 累积的偏移值
+     */
+    userAdd(key: string, value: number): void;
+    /**
+     * 移除用户属性。当您要清空用户的用户属性值时，您可以调用 userUnset 来对指定属性进行清空操作，如果该属性还未在集群中被创建，则 user_unset 不会创建该属性
+     * @param key
+     */
+    userUnset(key: string): void;
+    /**
+     * 上报错误
+     * @param error 错误信息
+     */
+    error(error: string): void;
+    /**
+     * 开始事件计时
+     * 如果您需要记录某个事件的持续时长，可以调用 timeEvent 来开始计时。
+     * 配置您想要计时的事件名称，当您上传该事件时，将会自动在您的事件属性中加入 _dt_ 这一属性来表示记录的时长，单位为秒。
+     * 需要注意的是，同一个事件名只能有一个在计时的任务。
+     * @param eventName
+     */
+    time(eventName: string, once?: boolean, offset?: number): void;
+    /**
+     * 取消事件计时
+     * @param eventName
+     * @returns
+     */
+    cancelTime(eventName: string): boolean;
+    /**
+     * 上报事件
+     * @param eventName 事件名称
+     * @param data 事件数据
+     */
+    report(eventName: string, data?: AnalyticsData): Promise<void>;
+    private _sendAble;
+    private _copyToData;
+    protected _sendReport(eventName: string, data: any): Promise<void>;
+}

package/dist/app/module/analytics/AnalyticsAbleConst.d.ts

@@ -0,0 +1,20 @@
+export declare enum DimensionType {
+    ACTIVITY = 0,
+    AD = 1,
+    PAYMENT = 2,
+    SOCIAL = 3,
+    PLAYER_ABILITY = 4,
+    LEVEL_STATS = 5
+}
+export type ConfigMatchedUnit = {
+    configName: string;
+    publishId?: string;
+    fingerprint: string;
+    variantId?: string;
+    variantFingerprint?: string;
+};
+export type ConfigResolveMeta = {
+    method: string;
+    resolveKey: string;
+    matchedUnits: ConfigMatchedUnit[];
+};

package/dist/app/module/analytics/BaseDimension.d.ts

@@ -0,0 +1,19 @@
+export declare abstract class BaseDimension {
+    protected _name: string;
+    protected _data: Record<string, number>;
+    protected _initialized: boolean;
+    protected _dirty: boolean;
+    constructor(name: string);
+    get name(): string;
+    protected _ensureInit(): void;
+    protected _loadFromStorage(): void;
+    protected _saveToStorage(): Promise<void>;
+    protected _updateValue(key: string, value: number): void;
+    protected _incrementValue(key: string, delta?: number): void;
+    protected _getValue(key: string, defaultValue?: number): number;
+    getData(): Record<string, number>;
+    protected _compress(data: Record<string, number>): string;
+    protected _decompress(str: string): Record<string, number>;
+    abstract getMetrics(order?: string[]): number[];
+    clear(): void;
+}

package/dist/app/module/analytics/KeytopsAnalyticsSender.d.ts

@@ -0,0 +1,67 @@
+import { EmptyAnalyticsSender } from "./AnalyticsAble";
+export interface KeytopsAnalyticsConfig {
+    /**
+     * 上报地址
+     */
+    url: string;
+    /**
+     * 时间戳的获取函数
+     * @returns
+     */
+    timestampCall?: () => number;
+    /**
+     * 发送数据的CD，默认是2秒
+     */
+    cd?: number;
+    /**
+     * 发送数据的条数，默认是5条
+     */
+    count?: number;
+    /**
+     * 本地缓存触发刷新的最大字节数
+     */
+    maxBufferedBytes?: number;
+    /**
+     * 本地缓存的独立key，避免不同行为混用缓存
+     */
+    cacheKey?: string;
+    /**
+     * 需要排除的事件名称
+     */
+    exclude?: string[];
+}
+type KeytopsAnalyticsEvent = {
+    appid: string;
+    openid: string;
+    deviceid: string;
+    sessionid: string;
+    level: number;
+    data: any;
+    event: string;
+    timestamp: number;
+};
+export declare class KeytopsAnalyticsSender extends EmptyAnalyticsSender {
+    private _config;
+    private _storageKey;
+    private _sending;
+    private _flushScheduled;
+    protected _eventCache: KeytopsAnalyticsEvent[];
+    protected _index: number;
+    constructor(config: KeytopsAnalyticsConfig, exclude?: string[]);
+    private _setConfig;
+    private _loadStoredEvents;
+    private _storeEvents;
+    private _estimateBytes;
+    private _currentBufferedBytes;
+    private _startLoop;
+    private _addListen;
+    private _restoreEvents;
+    private _scheduleFlush;
+    private _buildRequestBody;
+    private buildRequestId;
+    private _sendBatch;
+    private _sendBatchWithRetry;
+    protected _doReport(maxCount?: number, store?: boolean): Promise<boolean>;
+    send(eventName: string, data: any): Promise<void>;
+}
+export {};

package/dist/app/module/analytics/ad/ADAnalyticsAble.d.ts

@@ -0,0 +1,19 @@
+import { AnalyticsAble } from "../AnalyticsAble";
+import { ADType, AdFrom } from "./ADBehaviorReporter";
+export declare class ADAnalyticsAble {
+    private _reporter;
+    private _dimension;
+    constructor(baseAble: AnalyticsAble);
+    onStartLoad(type: ADType, from: AdFrom, msg?: string): void;
+    onLoadComplete(type: ADType, from: AdFrom): void;
+    onLoadFail(type: ADType, from: AdFrom, msg?: string): void;
+    onStartShow(type: ADType, from: AdFrom): void;
+    onShowComplete(type: ADType, from: AdFrom, isEnded: boolean): void;
+    onShowFail(type: ADType, from: AdFrom, msg?: string): void;
+    onCloseByUser(type: ADType, from: AdFrom): void;
+    getMetrics(): number[];
+    /**
+     * 广告维度
+     */
+    private get dimension();
+}

package/dist/app/module/analytics/ad/ADBehaviorReporter.d.ts

@@ -0,0 +1,90 @@
+import { AnalyticsAble, AnalyticsData } from "../AnalyticsAble";
+export declare enum ADType {
+    BANNER = 0,
+    INTERSTITIAL = 1,
+    REWARD_VIDEO = 2,
+    NATIVE = 3
+}
+export declare enum ADEvent {
+    LOAD = 0,
+    LOAD_COMPLETE = 1,
+    LOAD_FAIL = 2,
+    SHOW = 3,
+    SHOW_COMPLETE = 4,
+    SHOW_FAIL = 5,
+    CLOSE_BY_USER = 6
+}
+export type AdFrom = {
+    /**
+     * 广告调起的动作（按钮）
+     */
+    action?: string;
+    /**
+     * 广告发生的模块
+     */
+    group?: string;
+    [key: string]: string | boolean | number;
+} & AnalyticsData;
+export declare class ADBehaviorReporter {
+    private baseAble;
+    private _groupCount;
+    constructor(baseAble: AnalyticsAble);
+    /**
+     * 重置单个模块的广告计数
+     * @param group 模块名称，默认为game
+     */
+    resetGroupCount(group?: string): void;
+    /**
+     * 开始加载广告
+     * @param type 广告类型
+     * @param from 广告来源
+     * @param msg 广告失败原因
+     */
+    onStartLoad(type: ADType, from: AdFrom, msg?: string): void;
+    /**
+     * 广告加载完成
+     * @param type 广告类型
+     * @param from 广告来源
+     */
+    onLoadComplete(type: ADType, from: AdFrom): void;
+    /**
+     * 广告加载失败
+     * @param type 广告类型
+     * @param from 广告来源
+     * @param msg 广告失败原因
+     */
+    onLoadFail(type: ADType, from: AdFrom, msg?: string): void;
+    /**
+     * 显示广告
+     * @param type 广告类型
+     * @param from 广告来源
+     */
+    onShow(type: ADType, from: AdFrom): void;
+    /**
+     * 广告显示完成
+     * @param type 广告类型
+     * @param from 广告来源
+     */
+    onShowComplete(type: ADType, from: AdFrom): void;
+    /**
+     * 广告显示失败
+     * @param type 广告类型
+     * @param from 广告来源
+     * @param msg 广告失败原因
+     */
+    onShowFail(type: ADType, from: AdFrom, msg?: string): void;
+    /**
+     * 用户关闭广告
+     * @param type 广告类型
+     * @param from 广告来源
+     */
+    onCloseByUser(type: ADType, from: AdFrom): void;
+    /**
+     * 上报广告事件
+     * @param type 广告类型
+     * @param event 广告事件
+     * @param from 广告来源
+     * @param msg 广告失败原因
+     */
+    report(type: ADType, event: ADEvent, from: AdFrom, msg?: string): void;
+}

package/dist/app/module/analytics/ad/AdDimension.d.ts

@@ -0,0 +1,34 @@
+import { BaseDimension } from "../BaseDimension";
+export declare const AD_METRIC_ORDER_V1: readonly ["AD.show_count", "AD.show_days", "AD.complete_count", "AD.last_show_day", "AD.today_show_count", "AD.first_show_time", "AD.last_show_time", "AD.avg_show_interval", "AD.today_avg_show_interval", "AD.avg_show_per_day", "AD.avg_complete_per_day"];
+/**
+ * 广告维度,记录广告展示次数、完成次数、展示天数、展示间隔等信息
+ */
+export declare class AdDimension extends BaseDimension {
+    private _todayPrevShowTime;
+    constructor();
+    /**
+     * 检测并重置今日数据（仅在新的一天的新启动时）
+     */
+    private _checkAndResetDailyData;
+    recordShow(): void;
+    recordComplete(): void;
+    /**
+     * 获取日均展示次数
+     */
+    get avgShowPerDay(): number;
+    /**
+     * 获取日均完成次数
+     */
+    get avgCompletePerDay(): number;
+    /**
+     * 获取平均广告展示间隔（秒）
+     * 使用增量平均算法计算相邻两次展示的平均间隔
+     */
+    get avgShowInterval(): number;
+    /**
+     * 获取今日平均广告展示间隔（秒）
+     * 使用增量平均算法计算今日相邻两次展示的平均间隔
+     */
+    get todayAvgShowInterval(): number;
+    getMetrics(order?: string[]): number[];
+}

package/dist/app/module/analytics/index.d.ts

@@ -0,0 +1,65 @@
+import { ADAnalyticsAble } from "./ad/ADAnalyticsAble";
+import { AnalyticsAble, IAnalyticsSender } from "./AnalyticsAble";
+import { LevelAnalyticsAble } from "./level/LevelAnalyticsAble";
+import { LaunchAnalyticsAble } from "./launch/LaunchAnalyticsAble";
+import { SessionAnalyticsAble } from "./session/SessionAnalyticsAble";
+import { SocialAnalyticsAble } from "./social/SocialAnalyticsAble";
+export * from "./AnalyticsAble";
+export * from "./ALiAnalyticsSender";
+export * from "./KeytopsAnalyticsSender";
+export * from "./launch/LaunchAnalyticsAble";
+declare class AnalyticsManager {
+    private hasRelayUrl;
+    private hasAliDirectConfig;
+    private createBehaviorSenders;
+    private _base;
+    /**
+     * 基础统计能力
+     */
+    get base(): AnalyticsAble;
+    private _level;
+    /**
+     * 关卡统计能力，用于关卡分析
+     */
+    get level(): LevelAnalyticsAble;
+    private _ad;
+    /**
+     * 广告统计能力，用于广告分析
+     */
+    get ad(): ADAnalyticsAble;
+    private _session;
+    /**
+     * 会话统计能力，用于会话分析
+     */
+    get session(): SessionAnalyticsAble;
+    private _launch;
+    /**
+     * 启动统计能力,用于启动性能分析
+     */
+    get launch(): LaunchAnalyticsAble;
+    private _social;
+    /**
+     * 社交统计能力
+     */
+    get social(): SocialAnalyticsAble;
+    /**
+     * 启用统计（基础统计能力）
+     * @param debugMode 调试模式，是否打印日志信息，默认为false
+     * @param senders 上报器列表，允许多个 默认为ALiAnalyticsSender
+     * @returns
+     */
+    enable(debugMode?: boolean, senders?: IAnalyticsSender[]): void;
+    get version(): string;
+    /**
+     * 获取所有维度的数据
+     * @returns 所有维度的数据
+     */
+    private getMetrics;
+    private _assignmentSender;
+    private get assignmentSender();
+    private reportAssignments;
+}
+/**
+ * 埋点统计能力
+ */
+export declare const analytics: AnalyticsManager;

package/dist/app/module/analytics/launch/LaunchAnalyticsAble.d.ts

@@ -0,0 +1,11 @@
+import { AnalyticsAble, AnalyticsData } from "../AnalyticsAble";
+export declare class LaunchAnalyticsAble {
+    private readonly _baseAble;
+    constructor(baseAble: AnalyticsAble);
+    /**
+     * 上报启动事件
+     * @param name 事件名称
+     * @param data 事件数据
+     */
+    report(name: string, data?: AnalyticsData): void;
+}