@ives_xxz/framework 1.6.3 → 1.6.5

package/FW.d.ts

@@ -6,18 +6,13 @@ declare namespace FW {
     prototype: T;
   };
 
-  type ServiceIdentifierData<TInstance = unknown> =
-    | string
-    | symbol
-    | Newable<TInstance>
-    | Function;
-
-  type CommonNewable<
-    TInstance = unknown,
-    TArgs extends unknown[] = any[]
-  > = Newable<TInstance, TArgs>;
-  type CommonServiceIdentifier<TInstance = unknown> =
-    ServiceIdentifierData<TInstance>;
+  type ServiceIdentifierData<TInstance = unknown> = string | symbol | Newable<TInstance> | Function;
+
+  type CommonNewable<TInstance = unknown, TArgs extends unknown[] = any[]> = Newable<
+    TInstance,
+    TArgs
+  >;
+  type CommonServiceIdentifier<TInstance = unknown> = ServiceIdentifierData<TInstance>;
 
   type ServiceIdentifier<T = unknown> = CommonServiceIdentifier<T>;
   /**
@@ -63,13 +58,13 @@ declare namespace FW {
         resolve: (value: T | PromiseLike<T>) => void,
         reject: (reason?: any) => void,
         signal?: AbortSignal,
-        reason?: any
+        reason?: any,
       ) => void = PromiseExcutor,
-      options: PromiseExecuteOptions = {}
+      options: PromiseExecuteOptions = {},
     ): PromiseProxy<T>;
     all<T = any>(
       promises: FW.PromiseProxy<T>[],
-      options: FW.PromiseExecuteOptions = {}
+      options: FW.PromiseExecuteOptions = {},
     ): FW.PromiseProxy<FW.PromiseResult<T>>;
   };
 
@@ -84,22 +79,18 @@ declare namespace FW {
     registerLanguagePackageEnum(
       bundleName: string,
       language: any,
-      getter: (key: string, language?: string) => string
+      getter: (key: string, language?: string) => string,
     ): void;
     getSupportedLanguages(): string[];
     setSupportedLanguages(languages: string[]): void;
     getBundles(): string[];
     getLanguage(): string;
     getLanguageIndex(): number;
-    getLanguagePackageValue(
-      bundleName: string,
-      key: string,
-      language?: string
-    ): string;
+    getLanguagePackageValue(bundleName: string, key: string, language?: string): string;
     getLanguagePackageEnumKeys(bundleName: string): string[];
     getLanguagePackageEnumValues(bundleName: string): string[];
     getLanguagePackageEnum<K extends keyof ILanguageBundleAccessor>(
-      bundleName: K
+      bundleName: K,
     ): ILanguageBundleAccessor[K];
     initializeLanguage(language: string);
   };
@@ -159,32 +150,32 @@ declare namespace FW {
     createObjectPool<T extends FWObject = FWObject>(
       node: cc.Node,
       parent: cc.Node,
-      tag?: string
+      tag?: string,
     ): Promise<ObjectPool<T>>;
     createObjectPool<T extends FWObject = FWObject>(
       prefab: cc.Prefab,
       parent: cc.Node,
-      tag?: string
+      tag?: string,
     ): Promise<ObjectPool<T>>;
     createObjectPool<T extends FWObject = FWObject>(
       assetProperty: FW.AssetProperty,
       parent: cc.Node,
-      tag?: string
+      tag?: string,
     ): Promise<ObjectPool<T>>;
     createObjectPool<T extends FWObject = FWObject>(
       node: cc.Node,
       parent: cc.Node,
-      type?: number
+      type?: number,
     ): Promise<ObjectPool<T>>;
     createObjectPool<T extends FWObject = FWObject>(
       prefab: cc.Prefab,
       parent: cc.Node,
-      type?: number
+      type?: number,
     ): Promise<ObjectPool<T>>;
     createObjectPool<T extends FWObject = FWObject>(
       assetProperty: FW.AssetProperty,
       parent: cc.Node,
-      type?: number
+      type?: number,
     ): Promise<ObjectPool<T>>;
     /** 获取已经创建的对象池 */
     getObjectPool(tag: string): ObjectPool;
@@ -217,7 +208,7 @@ declare namespace FW {
       address: string,
       sender: SocketSender,
       handle: SocketHandle,
-      config: SocketConfig
+      config: SocketConfig,
     ): Promise<Socket>;
     /**
      * 获取socket
@@ -313,7 +304,7 @@ declare namespace FW {
       tag: string,
       sender: SocketSender,
       handle: SocketHandle,
-      config: SocketConfig
+      config: SocketConfig,
     ): SocketPromiseProxy;
   };
 
@@ -348,7 +339,7 @@ declare namespace FW {
       args7?: FW.EventManagerArgs,
       args8?: FW.EventManagerArgs,
       args9?: FW.EventManagerArgs,
-      args10?: FW.EventManagerArgs
+      args10?: FW.EventManagerArgs,
     );
     /**
      * 比较目标
@@ -409,35 +400,19 @@ declare namespace FW {
     /**
      * 一次性调度器
      */
-    scheduleOnce(
-      cb?: () => void,
-      time?: number,
-      tag?: string
-    ): FW.TimerSchedule;
+    scheduleOnce(cb?: () => void, time?: number, tag?: string): FW.TimerSchedule;
     /**
      * 一次性调度器
      */
-    scheduleOnce(
-      time?: number,
-      cb?: () => void,
-      tag?: string
-    ): FW.TimerSchedule;
+    scheduleOnce(time?: number, cb?: () => void, tag?: string): FW.TimerSchedule;
     /**
      * 一次性调度器
      */
-    scheduleOnce(
-      time?: number,
-      cb?: () => void,
-      target?: any
-    ): FW.TimerSchedule;
+    scheduleOnce(time?: number, cb?: () => void, target?: any): FW.TimerSchedule;
     /**
      * 一次性调度器
      */
-    scheduleOnce(
-      cb?: () => void,
-      time?: number,
-      target?: any
-    ): FW.TimerSchedule;
+    scheduleOnce(cb?: () => void, time?: number, target?: any): FW.TimerSchedule;
     /**
      * 自定义调度器
      * */
@@ -446,7 +421,7 @@ declare namespace FW {
       time?: number,
       repeat?: number,
       target?: TargetType,
-      tag?: string
+      tag?: string,
     ): TimerSchedule;
     /** 暂停调度器 */
     pauseSchedule(tag: string): void;
@@ -497,13 +472,13 @@ declare namespace FW {
         args7?: EventManagerArgs,
         args8?: EventManagerArgs,
         args9?: EventManagerArgs,
-        args10?: EventManagerArgs
+        args10?: EventManagerArgs,
       ) => void,
       target: TargetType,
       options?: {
         priority?: FWSystemDefine.FWPriorityOrder;
         intercept?: boolean;
-      }
+      },
     );
 
     registerOnce(
@@ -518,13 +493,13 @@ declare namespace FW {
         args7?: EventManagerArgs,
         args8?: EventManagerArgs,
         args9?: EventManagerArgs,
-        args10?: EventManagerArgs
+        args10?: EventManagerArgs,
       ) => void,
       target: TargetType,
       options?: {
         priority?: number;
         intercept?: boolean;
-      }
+      },
     ): void;
 
     /**
@@ -558,7 +533,7 @@ declare namespace FW {
       args7?: FW.EventManagerArgs,
       args8?: FW.EventManagerArgs,
       args9?: FW.EventManagerArgs,
-      args10?: FW.EventManagerArgs
+      args10?: FW.EventManagerArgs,
     ): void;
     /**
      * 注销事件
@@ -704,23 +679,19 @@ declare namespace FW {
      * @param data
      */
     openAsync<Ctr extends FWLayerController = FWLayerController>(
-      data: LayerOpenArgs<Ctr>
+      data: LayerOpenArgs<Ctr>,
     ): Promise<Ctr>;
 
     /**
      * 同步打开layer
      * @param data
      */
-    openSync<Ctr extends FWLayerController = FWLayerController>(
-      data: LayerOpenArgs<Ctr>
-    ): Ctr;
+    openSync<Ctr extends FWLayerController = FWLayerController>(data: LayerOpenArgs<Ctr>): Ctr;
     /**
      * 显示常驻layer
      * @param layer
      */
-    displayLayer<Ctr extends FWLayerController = FWLayerController>(
-      ctr: Ctr
-    ): Ctr;
+    displayLayer<Ctr extends FWLayerController = FWLayerController>(ctr: Ctr): Ctr;
     /**
      * 隐藏常驻layer
      * @param layer
@@ -730,9 +701,7 @@ declare namespace FW {
      * 关闭layer
      * @param layer
      */
-    close<Ctr extends FWLayerController = FWLayerController>(
-      ctr: Ctr
-    ): FWLayerController;
+    close<Ctr extends FWLayerController = FWLayerController>(ctr: Ctr): FWLayerController;
 
     /**
      * 从栈关闭
@@ -801,8 +770,6 @@ declare namespace FW {
   };
 
   type ResManager = {
-    assetMgr: AssetManager;
-    bundleMgr: BundleManager;
     initialize(): void;
     onDestroy(): void;
 
@@ -840,10 +807,7 @@ declare namespace FW {
      * @param url
      * @param cb
      */
-    loadRemote<T extends cc.Asset = cc.Asset>(
-      url: string,
-      cb?: (asset: cc.Asset) => T
-    ): Promise<T>;
+    loadRemote<T extends cc.Asset = cc.Asset>(url: string, cb?: (asset: cc.Asset) => T): Promise<T>;
     /**
      * 从远程加载spine动画
      * @param data
@@ -859,18 +823,13 @@ declare namespace FW {
      * 加载资源返回数据
      * @param assetProperty
      */
-    loadAssetData<T extends cc.Asset>(
-      assetProperty: AssetProperty
-    ): Promise<AssetData>;
+    loadAssetData<T extends cc.Asset>(assetProperty: AssetProperty): Promise<AssetData>;
 
     /**
      * 加载资源
      * @param assetProperty
      */
-    loadAsset<T extends cc.Asset>(
-      assetProperty: AssetProperty,
-      cb?: () => void
-    ): Promise<T>;
+    loadAsset<T extends cc.Asset>(assetProperty: AssetProperty, cb?: () => void): Promise<T>;
 
     /**
      * 获取资源
@@ -1018,10 +977,7 @@ declare namespace FW {
      * @param url
      * @param cb
      */
-    loadRemote<T extends cc.Asset = cc.Asset>(
-      url: string,
-      cb?: (asset: cc.Asset) => T
-    ): Promise<T>;
+    loadRemote<T extends cc.Asset = cc.Asset>(url: string, cb?: (asset: cc.Asset) => T): Promise<T>;
     /**
      * 从远程加载spine动画
      * @param data
@@ -1137,7 +1093,7 @@ declare namespace FW {
       referenceNode: cc.Node,
       type?: {
         prototype: T;
-      }
+      },
     ): T;
     registerEvent(args: RegisterArgs): void;
     unRegisterEvent(args: RegisterArgs);
@@ -1314,7 +1270,7 @@ declare namespace FW {
      */
     register(
       state: FW.StateMachineRegisterArgs | FW.StateMachineRegisterArgs[],
-      stateMachineName?: string
+      stateMachineName?: string,
     );
     /**
      * 注销指定状态机的某个状态
@@ -1370,22 +1326,22 @@ declare namespace FW {
         progress: Function;
         easing: Function | String;
         onUpdate: Function;
-      }>
+      }>,
     >(
       duration: number,
       props: ConstructorType<T>,
-      opts?: OPTS
+      opts?: OPTS,
     ): FW.Tween;
     by<
       OPTS extends Partial<{
         progress: Function;
         easing: Function | String;
         onUpdate: Function;
-      }>
+      }>,
     >(
       duration: number,
       props: ConstructorType<T>,
-      opts?: OPTS
+      opts?: OPTS,
     ): FW.Tween;
     set(props: ConstructorType<T>): FW.Tween;
   };
@@ -1630,11 +1586,7 @@ declare namespace FW {
      * @param volume
      * @param loop
      */
-    playMusic(
-      assetProperty: AssetProperty,
-      volume?: number,
-      loop?: boolean
-    ): void;
+    playMusic(assetProperty: AssetProperty, volume?: number, loop?: boolean): void;
     /**
      * 停止背景音乐
      */
@@ -1663,36 +1615,21 @@ declare namespace FW {
      * @param volume
      * @param loop
      */
-    play(
-      path: string,
-      cb?: (id: number) => void,
-      volume?: number,
-      loop?: boolean
-    );
+    play(path: string, cb?: (id: number) => void, volume?: number, loop?: boolean);
     /**
      * 播放音效
      * @param audio
      * @param volume
      * @param loop
      */
-    play(
-      audio: cc.AudioClip,
-      cb?: (id: number) => void,
-      volume?: number,
-      loop?: boolean
-    );
+    play(audio: cc.AudioClip, cb?: (id: number) => void, volume?: number, loop?: boolean);
     /**
      * 播放音效
      * @param assetProperty
      * @param volume
      * @param loop
      */
-    play(
-      assetProperty: AssetProperty,
-      cb?: (id: number) => void,
-      volume?: number,
-      loop?: boolean
-    );
+    play(assetProperty: AssetProperty, cb?: (id: number) => void, volume?: number, loop?: boolean);
     /**
      * 暂停所有
      */
@@ -1713,11 +1650,7 @@ declare namespace FW {
   };
 
   type PerformanceManager = {
-    recordOperationMetric(
-      manager: string,
-      operation: string,
-      duration: number
-    ): void;
+    recordOperationMetric(manager: string, operation: string, duration: number): void;
     getModuleReport(manager: string): PerformanceReport;
     getAllReports(): Map<string, FW.PerformanceReport>;
   };
@@ -2016,7 +1949,7 @@ declare namespace FW {
     abort?: (reason?: any) => void;
     addAbortEventListener?: (
       listener: (this: AbortSignal, ev: Event) => any,
-      options?: boolean | AddEventListenerOptions
+      options?: boolean | AddEventListenerOptions,
     ) => void;
   };
 
@@ -2024,7 +1957,7 @@ declare namespace FW {
     resolve: (value: T | PromiseLike<T>) => void,
     reject: (reason?: any) => void,
     signal: AbortSignal,
-    reason?: any
+    reason?: any,
   ) => void;
 
   type PromiseExecuteOptions = {
@@ -2035,10 +1968,7 @@ declare namespace FW {
     retryCondition?: (error: any, retryCount: number) => boolean;
   };
 
-  type Promise = (
-    resolve: (value: any) => void,
-    reject: (reason?: any) => void
-  ) => void;
+  type Promise = (resolve: (value: any) => void, reject: (reason?: any) => void) => void;
 
   type PromiseResult<T = any> = {
     success: PromiseProxy<T>[];
@@ -2046,7 +1976,7 @@ declare namespace FW {
     cancelled: number[];
   };
 
-  type PromiseStatus = "pending" | "fulfilled" | "rejected" | "cancelled";
+  type PromiseStatus = 'pending' | 'fulfilled' | 'rejected' | 'cancelled';
 
   /**
    * 性能管理器配置
@@ -2094,3 +2024,22 @@ declare namespace FW {
   declare function timeScale(scale: number);
   declare let Entry: Entry;
 }
+
+declare namespace FW {
+  export type Framework = {
+    initialize(): void;
+    addRegistry(bundleName: string, registry: new () => Registry): void;
+    getContainer(): any;
+    getComponent<T>(serviceIdentifier: ServiceIdentifier<T>): T;
+    getComponents<T>(serviceIdentifier: ServiceIdentifier<T>): T[];
+    hasRegistry(bundleName: string): boolean;
+    getRegistry(bundleName: string): Registry;
+    createRegistry(bundleName: string): Registry;
+    destroyRegistry(bundleName: string): void;
+    register(data: RegisterFramework): void;
+    unRegister(data: RegisterFramework): void;
+    restart(): void;
+    getRegisteredComponents(): Map<string, RegisterFramework[]>;
+  };
+  declare let Framework: Framework;
+}

package/Framework.ts

@@ -1,44 +1,35 @@
-import "reflect-metadata";
-import { Container, interfaces } from "inversify";
-import { FWSystemDefine } from "./define/FWSystemDefine";
-import FWLog from "./log/FWLog";
-import { FWEventDefine } from "./define/FWEventDefine";
-import { FrameworkBase } from "./FrameworkBase";
-
-class Framework {
+import 'reflect-metadata';
+import { Container, interfaces } from 'inversify';
+import { FWSystemDefine } from './define/FWSystemDefine';
+import FWLog from './log/FWLog';
+import { FWEventDefine } from './define/FWEventDefine';
+import { FrameworkBase } from './FrameworkBase';
+
+export class Framework implements FW.Framework {
   private container: Container;
   private registry: Map<string, new () => FW.Registry>;
   private registeredComponents: Map<string, FW.RegisterFramework[]> = new Map();
-  private static instance: Framework;
-  private constructor() {}
 
   initialize() {
     this.container = new Container({
-      defaultScope: "Singleton",
+      defaultScope: 'Singleton',
       autoBindInjectable: true,
     });
     this.registry = new Map<string, new () => FW.Registry>();
     this.registeredComponents.clear();
   }
 
-  public static getInstance() {
-    if (!this.instance) {
-      this.instance = new Framework();
-    }
-    return this.instance;
-  }
-
   public getContainer(): Container {
     return this.container;
   }
 
   /** 获取组件 */
   public getComponent<T>(serviceIdentifier: FW.ServiceIdentifier<T>): T {
-    if (typeof serviceIdentifier === "string") {
+    if (typeof serviceIdentifier === 'string') {
       if (this.container.isBound(serviceIdentifier)) {
         return this.container.get<T>(serviceIdentifier);
       }
-    } else if (typeof serviceIdentifier === "function") {
+    } else if (typeof serviceIdentifier === 'function') {
       const className = serviceIdentifier.name;
 
       if (this.container.isBound(serviceIdentifier)) {
@@ -53,9 +44,7 @@ class Framework {
         Handle: FWSystemDefine.FWBindTag.HANDLE,
       };
 
-      const [suffix] =
-        Object.entries(suffixMap).find(([key]) => className.endsWith(key)) ||
-        [];
+      const [suffix] = Object.entries(suffixMap).find(([key]) => className.endsWith(key)) || [];
 
       if (suffix) {
         const bundleName = FW.Entry.bundleName;
@@ -131,10 +120,7 @@ class Framework {
    */
   createRegistry(bundleName: string): FW.Registry {
     if (!this.registry.has(bundleName)) return;
-    this.container
-      .bind(this.registry.get(bundleName))
-      .toSelf()
-      .inSingletonScope();
+    this.container.bind(this.registry.get(bundleName)).toSelf().inSingletonScope();
     return this.getRegistry(bundleName);
   }
 
@@ -152,13 +138,7 @@ class Framework {
    * @param data
    */
   register(data: FW.RegisterFramework) {
-    const classes = [
-      data.logic,
-      data.data,
-      data.config,
-      data.sender,
-      data.handle,
-    ];
+    const classes = [data.logic, data.data, data.config, data.sender, data.handle];
     classes.forEach((cls, index) => {
       if (cls && !this.container.isBound(cls)) {
         this.container.bind(cls).toSelf().inSingletonScope();
@@ -186,21 +166,15 @@ class Framework {
    * @returns
    */
   unRegister(data: FW.RegisterFramework) {
-    const classes = [
-      data.logic,
-      data.data,
-      data.config,
-      data.sender,
-      data.handle,
-    ];
+    const classes = [data.logic, data.data, data.config, data.sender, data.handle];
     classes.forEach((cls, index) => {
       const key = this.getKey(data.bundleName, index);
       if (cls && this.container.isBound(cls)) {
-        this.container.get(key)?.["onDestroy"]?.();
+        this.container.get(key)?.['onDestroy']?.();
         this.container.unbind(cls);
       }
       if (this.container.isBound(key)) {
-        this.container.get(key)?.["onDestroy"]?.();
+        this.container.get(key)?.['onDestroy']?.();
         this.container.unbind(this.getKey(data.bundleName, index));
       }
     });
@@ -216,10 +190,7 @@ class Framework {
 
     const registrations = this.registeredComponents.get(bundleName)!;
     const exists = registrations.some(
-      (reg) =>
-        reg.logic === data.logic &&
-        reg.data === data.data &&
-        reg.config === data.config
+      (reg) => reg.logic === data.logic && reg.data === data.data && reg.config === data.config,
     );
 
     if (!exists) {
@@ -232,10 +203,7 @@ class Framework {
     if (this.registeredComponents.has(bundleName)) {
       const registrations = this.registeredComponents.get(bundleName)!;
       const index = registrations.findIndex(
-        (reg) =>
-          reg.logic === data.logic &&
-          reg.data === data.data &&
-          reg.config === data.config
+        (reg) => reg.logic === data.logic && reg.data === data.data && reg.config === data.config,
       );
 
       if (index !== -1) {
@@ -252,7 +220,7 @@ class Framework {
     this.destroyAllComponents();
     this.container.unbindAll();
     this.container = new Container({
-      defaultScope: "Singleton",
+      defaultScope: 'Singleton',
       autoBindInjectable: true,
     });
 
@@ -268,7 +236,7 @@ class Framework {
         try {
           if (this.container.isBound(binding.serviceIdentifier)) {
             const instance = this.container.get(binding.serviceIdentifier);
-            instance?.["onDestroy"]?.();
+            instance?.['onDestroy']?.();
           }
         } catch (e) {
           FWLog.warn(`Error destroying component ${key}:`, e);
@@ -278,18 +246,12 @@ class Framework {
   }
 
   private reregisterAllComponents(): void {
-    for (const [
-      bundleName,
-      registrations,
-    ] of this.registeredComponents.entries()) {
+    for (const [bundleName, registrations] of this.registeredComponents.entries()) {
       for (const data of registrations) {
         try {
           this.register(data);
         } catch (e) {
-          console.error(
-            `Error re-registering component for bundle ${bundleName}:`,
-            e
-          );
+          console.error(`Error re-registering component for bundle ${bundleName}:`, e);
         }
       }
     }
@@ -304,7 +266,7 @@ class Framework {
   }
 
   private isSubclassOf(child: any, parent: any): boolean {
-    if (typeof child !== "function" || typeof parent !== "function") {
+    if (typeof child !== 'function' || typeof parent !== 'function') {
       return false;
     }
     let current = child;
@@ -317,5 +279,3 @@ class Framework {
     return false;
   }
 }
-
-export default Framework.getInstance();