keytops-game-framework 1.0.0 → 1.0.2

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

@@ -16,4 +16,13 @@ export declare class Injector {
      * 获取已注入的类型实例
      */
     static getInject<T>(customKey: string): T;
+    /**
+     * 获取已注入的类型实例，如果不存在则使用 fallback 创建
+     * @param key
+     * @param fallback
+     * @returns
+     */
+    static getInjectAlone<T>(key: string, fallback: {
+        new (): T;
+    }): T;
 }

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

@@ -2,6 +2,10 @@ import { AnalyticsAble, AnalyticsData } from "../AnalyticsAble";
 export declare class LaunchAnalyticsAble {
     private readonly _baseAble;
     constructor(baseAble: AnalyticsAble);
+    /**
+     * 标记应用准备就绪，开始统计启动时间
+     */
+    ready(): void;
     /**
      * 上报启动事件
      * @param name 事件名称

package/dist/app/module/net/server/IServer.d.ts

@@ -10,11 +10,64 @@ type BaseValueType = string | number | boolean;
 export type ServerParamStruct = {
     [key: string]: BaseValueType | BaseValueType[] | ServerParamStruct;
 };
+export type RemoteConfigScope = {
+    gameFlag?: string;
+    [key: string]: BaseValueType | undefined;
+};
+export type RemoteConfigRequestOptions = {
+    refresh?: boolean;
+    debug?: boolean;
+};
+export interface RemoteConfigDefinition<TConfig extends OnlineConfig = OnlineConfig, TQuery extends ServerParamStruct | undefined = ServerParamStruct> {
+    /**
+     * 配置端口名称，内置system\config\level
+     */
+    method: string;
+    /**
+     * 创建该配置类型的默认实例。
+     * 未请求远端时，snapshot 也必须能返回一个可用对象，所以这里不能省略。
+     */
+    createDefault(): TConfig;
+    /**
+     * 把业务侧传入的 request 参数转换成服务器协议需要的 data 字段。
+     * 公共字段由 IServer 实现补齐，这里只负责当前配置类型自己的请求载荷。
+     */
+    buildRequestData(request?: TQuery, scope?: RemoteConfigScope): ServerParamStruct | undefined;
+    /**
+     * 从统一的服务器响应中抽出当前配置真正关心的 payload 部分。
+     * 如果后续不同配置类型的响应结构不一致，这里就是第一层适配点。
+     */
+    extractPayloads(response: ServerResponseStruct): Record<string, any> | undefined;
+    /**
+     * 定义当前配置的装配策略。
+     * 可按字段 merge，也可整体替换，RemoteConfigStore 不关心具体策略，只调用这里。
+     */
+    merge(target: TConfig, payloads?: Record<string, any>): TConfig;
+}
+/**
+ * definition 的公共抽象基类。
+ * interface 负责定义框架契约，abstract class 负责沉淀共用实现。
+ */
+export declare abstract class AbstractRemoteConfigDefinition<TConfig extends OnlineConfig = OnlineConfig, TQuery extends ServerParamStruct | undefined = ServerParamStruct> implements RemoteConfigDefinition<TConfig, TQuery> {
+    abstract method: string;
+    abstract createDefault(): TConfig;
+    abstract merge(target: TConfig, payloads?: Record<string, any>): TConfig;
+    protected mergeConfigField(target: OnlineConfig, key: string, payload: unknown): void;
+    protected mergeObjectConfig<T extends OnlineConfig>(target: T, payloads?: Record<string, any>): T;
+    buildRequestData(request?: TQuery, _scope?: RemoteConfigScope): ServerParamStruct | undefined;
+    extractPayloads(response: ServerResponseStruct): Record<string, any> | undefined;
+}
+export interface ServerRequestContext<TConfig extends OnlineConfig = OnlineConfig, TQuery extends ServerParamStruct | undefined = ServerParamStruct> {
+    definition: RemoteConfigDefinition<TConfig, TQuery>;
+    scope?: RemoteConfigScope;
+    request?: TQuery;
+    options?: RemoteConfigRequestOptions;
+}
 export interface IServer {
-    requestConfig(params: ServerParamStruct): Promise<ServerResponseStruct>;
+    requestConfig<TConfig extends OnlineConfig, TQuery extends ServerParamStruct | undefined>(context: ServerRequestContext<TConfig, TQuery>): Promise<ServerResponseStruct | undefined>;
 }
 export declare class NoRequestServer implements IServer {
     static KEY: string;
-    requestConfig(params: ServerParamStruct): Promise<ServerResponseStruct>;
+    requestConfig<TConfig extends OnlineConfig, TQuery extends ServerParamStruct | undefined>(_context: ServerRequestContext<TConfig, TQuery>): Promise<ServerResponseStruct>;
 }
 export {};

package/dist/app/module/net/server/KKTServer.d.ts

@@ -0,0 +1,8 @@
+import type { IServer, OnlineConfig, ServerParamStruct, ServerRequestContext, ServerResponseStruct } from "./IServer";
+export declare class KKTServer implements IServer {
+    requestConfig<TConfig extends OnlineConfig, TQuery extends ServerParamStruct | undefined>(context: ServerRequestContext<TConfig, TQuery>): Promise<ServerResponseStruct | undefined>;
+    private getRequestParams;
+    private getResolveUrl;
+    private normalizeResponse;
+    private sentRequest;
+}

package/dist/app/module/net/server/Server.d.ts

@@ -1,27 +1,12 @@
-import { ConfigResolveMeta } from "../../analytics/AnalyticsAbleConst";
-import { ServerParamStruct } from "./IServer";
-import { LevelOnlineConfig } from "./LevelOnlineConfig";
-import { OnlineConfig } from "./IServer";
-import { SystemOnlineConfig } from "./SystemOnlineConfig";
-/**
- * 内置 config、system、level 三个端口
- */
-export declare const INTERNAL_METHODS: {
-    readonly CONFIG: "config";
-    readonly SYSTEM: "system";
-    readonly LEVEL: "level";
-};
+import type { OnlineConfig, ServerParamStruct, ServerRequestContext, ServerResponseStruct } from "./IServer";
 /**
  @name: Server
- @desc: 服务器数据
+ @desc: 统一的服务器请求门面，仅保留请求转发与服务器时间能力。
  @author: timoo
  @date: 2022/11/30
  */
 export declare class Server {
     static KEY: string;
-    private _configs;
-    private _loadedConfigKeys;
-    private _configContexts;
     private _serverTime;
     private _startedAppTime;
     set time(time: number);
@@ -37,65 +22,8 @@ export declare class Server {
      * 一年中的第几天
      */
     get dateOfYear(): number;
-    private getConfigKey;
-    private getDefaultConfig;
-    /**
-     * 服务器配置数据
-     */
-    config<T extends OnlineConfig>(method?: string, gameFlag?: string): T;
-    get systemConfig(): SystemOnlineConfig;
-    /**
-     * 获取关卡配置数据
-     * @param gameFlag 游戏标识.默认为DEFAULT_GAME_FLAG
-     * @returns 关卡配置数据
-     */
-    levelConfig<T extends OnlineConfig>(gameFlag?: string): T;
-    getConfigContext(method?: string, gameFlag?: string): ConfigResolveMeta | undefined;
-    private applyAnalyticsContext;
-    /**
-     * 构建请求参数
-     * @param method 请求方法
-     * @param gameMetrics 关卡维度指标
-     * @param data 额外参数
-     * @param isDebug 是否为调试模式
-     * @returns 请求参数
-     */
-    private getRequestParams;
-    private joinUrl;
-    getSystemUrl(path?: string): string;
-    private getResolveUrl;
-    private normalizeResponse;
-    private updateServerTime;
-    /**
-     * 获取/请求系统配置
-     * @param refresh 是否强制刷新，默认为false
-     * @param isDebug 是否为调试模式，可选
-     * @returns
-     */
-    getSystemConfig(refresh?: boolean, isDebug?: boolean): Promise<SystemOnlineConfig>;
-    /**
-     * 获取/请求配置内容
-     * @param method 请求端口, 默认为config
-     * @param gameFlag 玩法标识, 默认为deafult
-     * @param data 额外参数, 可选为空
-     * @param refresh 是否强制刷新, 默认为false
-     * @param isDebug 是否为调试模式，可选
-     * @returns
-     */
-    getConfig<T extends OnlineConfig>(method?: string, gameFlag?: string, data?: ServerParamStruct, refresh?: boolean, isDebug?: boolean): Promise<T>;
-    /**
-     * 获取/请求关卡配置
-     * @param gameFlag 玩法标识
-     * @param levelid 关卡唯一ID
-     * @param data 额外参数, 可选为空
-     * @param refresh 是否强制刷新, 默认为false
-     * @param isDebug 是否为调试模式，可选
-     * @returns 关卡配置
-     */
-    getLevelConfig<T extends LevelOnlineConfig>(gameFlag: string, levelid: string, data?: ServerParamStruct, refresh?: boolean, isDebug?: boolean): Promise<T>;
-    private _updateConfig;
-    private mergeConfigField;
-    private sentRequest;
+    private syncServerTime;
+    requestConfig<TConfig extends OnlineConfig, TQuery extends ServerParamStruct | undefined>(context: ServerRequestContext<TConfig, TQuery>): Promise<ServerResponseStruct | undefined>;
     private _impl;
     private get impl();
 }

package/dist/app/module/publisher/tt/TTLogin.d.ts

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

package/dist/app/module/remoteConfig/BaseOnlineConfig.d.ts

@@ -0,0 +1,15 @@
+import { AbstractRemoteConfigDefinition, OnlineConfig, type ServerParamStruct } from "../net/server/IServer";
+export declare class BaseOnlineConfig implements OnlineConfig {
+    static KEY: string;
+}
+/**
+ * Base/config 端口的内建定义。
+ * 后续新增 activity / dungeon 等远程配置时，直接新增新的 definition 即可，
+ * 不需要再回到 Server.ts 里扩展 method 分支。
+ */
+export declare class BaseRemoteConfigDefinitionClass extends AbstractRemoteConfigDefinition<BaseOnlineConfig, ServerParamStruct> {
+    method: string;
+    createDefault(): BaseOnlineConfig;
+    merge(target: BaseOnlineConfig, payloads?: Record<string, any>): BaseOnlineConfig;
+}
+export declare const BaseRemoteConfigDefinition: BaseRemoteConfigDefinitionClass;

package/dist/app/module/remoteConfig/IRemoteConfigStore.d.ts

@@ -0,0 +1,9 @@
+import { ConfigResolveMeta } from "../analytics/AnalyticsAbleConst";
+import type { OnlineConfig, RemoteConfigDefinition, RemoteConfigScope, ServerResponseStruct } from "../net/server/IServer";
+export interface IRemoteConfigStore {
+    snapshot<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): TConfig;
+    apply<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope: RemoteConfigScope | undefined, response: ServerResponseStruct): TConfig;
+    getResolveMeta<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): ConfigResolveMeta | undefined;
+    isLoaded<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): boolean;
+    clear(): void;
+}

package/dist/app/module/remoteConfig/LevelOnlineConfig.d.ts

@@ -0,0 +1,16 @@
+import { OnlineConfig } from "../net/server/IServer";
+import { BaseRemoteConfigDefinitionClass } from "./BaseOnlineConfig";
+export declare class LevelOnlineConfig implements OnlineConfig {
+    static KEY: string;
+    info: {
+        id: string;
+        repeat: 0 | 1;
+        [key: string]: any;
+    };
+}
+export declare class LevelRemoteConfigDefinitionClass extends BaseRemoteConfigDefinitionClass {
+    method: string;
+    createDefault(): LevelOnlineConfig;
+    merge(_target: LevelOnlineConfig, payloads?: Record<string, any>): LevelOnlineConfig;
+}
+export declare const LevelRemoteConfigDefinition: LevelRemoteConfigDefinitionClass;

package/dist/app/module/remoteConfig/RemoteConfigDefinitions.d.ts

@@ -0,0 +1,7 @@
+import type { OnlineConfig, RemoteConfigDefinition, ServerParamStruct } from "../net/server/IServer";
+export declare const INTERNAL_METHODS: {
+    readonly CONFIG: string;
+    readonly SYSTEM: string;
+    readonly LEVEL: string;
+};
+export declare function getRemoteConfigDefinition(method: string): RemoteConfigDefinition<OnlineConfig, ServerParamStruct>;

package/dist/app/module/remoteConfig/RemoteConfigService.d.ts

@@ -0,0 +1,51 @@
+import type { OnlineConfig, RemoteConfigDefinition, RemoteConfigRequestOptions, RemoteConfigScope, ServerParamStruct } from "../net/server/IServer";
+import { ConfigResolveMeta } from "../analytics/AnalyticsAbleConst";
+export declare class RemoteConfigService {
+    private _store;
+    /**
+     * 统一暴露给测试和少量编排场景的 server 门面。
+     * 真正的协议实现仍然隐藏在 server 内部注入链路后面。
+     */
+    get server(): import("../net/server/Server").Server;
+    /**
+     * store 只负责快照/持久化/resolveMeta，不负责发请求。
+     * 这样请求协议切换时，不需要改缓存与装配逻辑。
+     */
+    private get store();
+    /**
+     * 请求并应用远程配置，返回已装配的快照。
+     * @param definition 配置定义
+     * @param request 请求参数
+     * @param scope 作用域
+     * @param options 请求选项
+     * @returns 装配后的配置快照
+     */
+    refresh<TConfig extends OnlineConfig, TQuery extends ServerParamStruct | undefined>(definition: RemoteConfigDefinition<TConfig, TQuery>, request?: TQuery, scope?: RemoteConfigScope, options?: RemoteConfigRequestOptions): Promise<TConfig>;
+    /**
+     * 与旧调用习惯兼容的主入口。
+     * 语义上等价于 refresh：必要时请求远端，失败时回退本地快照。
+     */
+    resolve<TConfig extends OnlineConfig, TQuery extends ServerParamStruct | undefined>(definition: RemoteConfigDefinition<TConfig, TQuery>, request?: TQuery, scope?: RemoteConfigScope, options?: RemoteConfigRequestOptions): Promise<TConfig>;
+    /**
+     * 获取配置。
+     * @param definition 配置定义
+     * @param scope 作用域
+     * @returns 配置
+     */
+    config<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): TConfig;
+    /**
+     * 与旧调用习惯兼容的只读快照接口。
+     */
+    snapshot<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): TConfig;
+    /**
+     * 读取最近一次成功命中的 resolve 元信息。
+     */
+    resolveMeta<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): ConfigResolveMeta | undefined;
+    /**
+     * system URL 统一从这里解析，避免调用方直接依赖 helper 或拼接规则。
+     */
+    getSystemUrl(path?: string): string;
+    private applyResolveSideEffects;
+    private getLevelId;
+}
+export declare const remoteConfigService: RemoteConfigService;

package/dist/app/module/remoteConfig/RemoteConfigStore.d.ts

@@ -0,0 +1,20 @@
+import type { IRemoteConfigStore } from "./IRemoteConfigStore";
+import type { OnlineConfig, RemoteConfigDefinition, RemoteConfigScope, ServerResponseStruct } from "../net/server/IServer";
+import { ConfigResolveMeta } from "../analytics/AnalyticsAbleConst";
+export declare class RemoteConfigStore implements IRemoteConfigStore {
+    static KEY: string;
+    private _snapshots;
+    private _loadedKeys;
+    private _contexts;
+    snapshot<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): TConfig;
+    apply<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope: RemoteConfigScope | undefined, response: ServerResponseStruct): TConfig;
+    getResolveMeta<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): ConfigResolveMeta | undefined;
+    isLoaded<TConfig extends OnlineConfig>(definition: RemoteConfigDefinition<TConfig, any>, scope?: RemoteConfigScope): boolean;
+    clear(): void;
+    private ensureContexts;
+    private getScopeGameFlag;
+    private createScopedKey;
+    private getScopeKey;
+    private getStorageKey;
+    private setResolveMeta;
+}

package/dist/app/module/remoteConfig/SystemOnlineConfig.d.ts

@@ -0,0 +1,41 @@
+import type { AliAnalyticsConfig } from "../analytics/ALiAnalyticsSender";
+import type { KeytopsAnalyticsConfig } from "../analytics/KeytopsAnalyticsSender";
+import { ADConfig } from "../publisher/IADAble";
+import { OnlineConfig } from "../net/server/IServer";
+import { BaseRemoteConfigDefinitionClass } from "./BaseOnlineConfig";
+export type RelayAnalyticsConfig = Partial<AliAnalyticsConfig> & KeytopsAnalyticsConfig;
+/**
+ * system 端口默认配置，承载 SDK 基础运行时能力。
+ */
+export declare class SystemOnlineConfig implements OnlineConfig {
+    static KEY: string;
+    url: {
+        domain: string;
+        configAPI: string;
+        loginAPI: string;
+        saveStoreAPI: string;
+        getStoreAPI: string;
+    };
+    analytics: RelayAnalyticsConfig;
+    assignment: KeytopsAnalyticsConfig;
+    ad: ADConfig;
+    storage: {
+        cacheEnable: boolean;
+        cacheCD: number;
+    };
+    getAnalyticsConfig(): RelayAnalyticsConfig;
+    getAssignmentConfig(): KeytopsAnalyticsConfig;
+    getStorageConfig(): {
+        cacheEnable: boolean;
+        cacheCD: number;
+    };
+    toString(): string;
+    resolveSystemUrl(path?: string): string;
+}
+export declare class SystemRemoteConfigDefinitionClass extends BaseRemoteConfigDefinitionClass {
+    method: string;
+    createDefault(): SystemOnlineConfig;
+    merge(target: SystemOnlineConfig, payloads?: Record<string, any>): SystemOnlineConfig;
+}
+export declare const SystemRemoteConfigDefinition: SystemRemoteConfigDefinitionClass;
+export declare function resolveSystemUrl(path?: string, config?: SystemOnlineConfig): string;

package/dist/index.d.ts

@@ -2,8 +2,7 @@ export * from './cocos';
 export * from './app/module/abTesting/ABTesting';
 export * from './app/module/net/NetManager';
 export * from './app/module/net/NetInterface';
-export * from './app/module/net/server/SystemOnlineConfig';
-export * from './app/module/net/server/LevelOnlineConfig';
+export * from './app/module/net/server/KKTServer';
 export * from './app/module/net/server/IServer';
 export * from './app/module/net/server/Server';
 export * from './app/module/net/http/HttpRequest';
@@ -68,6 +67,13 @@ export * from './app/module/publisher/tt/TTPublisher';
 export * from './app/module/publisher/tt/TTAd';
 export * from './app/module/publisher/tt/TTAnalyticsSender';
 export * from './app/module/publisher/tt/TTDevice';
+export * from './app/module/remoteConfig/SystemOnlineConfig';
+export * from './app/module/remoteConfig/BaseOnlineConfig';
+export * from './app/module/remoteConfig/LevelOnlineConfig';
+export * from './app/module/remoteConfig/RemoteConfigService';
+export * from './app/module/remoteConfig/RemoteConfigStore';
+export * from './app/module/remoteConfig/RemoteConfigDefinitions';
+export * from './app/module/remoteConfig/IRemoteConfigStore';
 export * from './app/module/timer/TimerImpl';
 export * from './app/module/timer/ITimer';
 export * from './app/module/timer/Timer';