@eggjs/core-decorator 4.0.0-beta.6 → 4.0.0-beta.8

package/dist/index.d.ts

@@ -1,15 +1,195 @@
-import { ConfigSourceQualifier } from "./decorator/ConfigSource.js";
-import { ContextProto } from "./decorator/ContextProto.js";
-import { EggQualifier } from "./decorator/EggQualifier.js";
-import { InitTypeQualifier } from "./decorator/InitTypeQualifier.js";
-import { Inject, InjectOptional } from "./decorator/Inject.js";
-import { ModuleQualifier } from "./decorator/ModuleQualifier.js";
-import { MultiInstanceInfo } from "./decorator/MultiInstanceInfo.js";
-import { MultiInstanceProto } from "./decorator/MultiInstanceProto.js";
-import { Prototype } from "./decorator/Prototype.js";
-import { SingletonProto } from "./decorator/SingletonProto.js";
-import { MetadataUtil } from "./util/MetadataUtil.js";
-import { PrototypeUtil } from "./util/PrototypeUtil.js";
-import { QualifierUtil } from "./util/QualifierUtil.js";
+import * as _eggjs_tegg_types0 from "@eggjs/tegg-types";
+import { ContextProtoParams, EggMultiInstanceCallbackPrototypeInfo, EggMultiInstancePrototypeInfo, EggProtoImplClass, EggPrototypeInfo, EggPrototypeName, EggType, InjectConstructorInfo, InjectObjectInfo, InjectParams, InjectType, MetaDataKey, MultiInstancePrototypeGetObjectsContext, MultiInstancePrototypeParams, MultiInstanceType, ObjectInitTypeLike, PrototypeParams, QualifierAttribute, QualifierInfo, QualifierValue, SingletonProtoParams } from "@eggjs/tegg-types";
 export * from "@eggjs/tegg-types/core-decorator";
+
+//#region src/decorator/ConfigSource.d.ts
+declare function ConfigSourceQualifier(moduleName: string): (target: any, propertyKey?: PropertyKey, parameterIndex?: number) => void;
+//#endregion
+//#region src/decorator/ContextProto.d.ts
+declare function ContextProto(params?: ContextProtoParams): (clazz: _eggjs_tegg_types0.EggProtoImplClass) => void;
+//#endregion
+//#region src/decorator/EggQualifier.d.ts
+declare function EggQualifier(eggType: EggType): (target: any, propertyKey?: PropertyKey, parameterIndex?: number) => void;
+//#endregion
+//#region src/decorator/InitTypeQualifier.d.ts
+declare function InitTypeQualifier(initType: ObjectInitTypeLike): (target: any, propertyKey?: PropertyKey, parameterIndex?: number) => void;
+//#endregion
+//#region src/decorator/Inject.d.ts
+declare function Inject(param?: InjectParams | string): (target: any, propertyKey?: PropertyKey, parameterIndex?: number) => void;
+declare function InjectOptional(param?: Omit<InjectParams, 'optional'> | string): (target: any, propertyKey?: PropertyKey, parameterIndex?: number) => void;
+//#endregion
+//#region src/decorator/ModuleQualifier.d.ts
+declare function ModuleQualifier(moduleName: string): (target: any, propertyKey?: PropertyKey, parameterIndex?: number) => void;
+//#endregion
+//#region src/decorator/MultiInstanceInfo.d.ts
+declare function MultiInstanceInfo(attributes: QualifierAttribute[]): (target: any, _propertyKey: PropertyKey | undefined, parameterIndex: number) => void;
+//#endregion
+//#region src/decorator/MultiInstanceProto.d.ts
+declare function MultiInstanceProto(param: MultiInstancePrototypeParams): (clazz: EggProtoImplClass) => void;
+//#endregion
+//#region src/decorator/Prototype.d.ts
+declare function Prototype(param?: PrototypeParams): (clazz: EggProtoImplClass) => void;
+//#endregion
+//#region src/decorator/SingletonProto.d.ts
+declare function SingletonProto(params?: SingletonProtoParams): (clazz: _eggjs_tegg_types0.EggProtoImplClass) => void;
+//#endregion
+//#region src/util/MetadataUtil.d.ts
+declare class MetadataUtil {
+  static deleteMetaData(metadataKey: MetaDataKey, clazz: EggProtoImplClass): void;
+  static defineMetaData<T>(metadataKey: MetaDataKey, metadataValue: T, clazz: EggProtoImplClass): void;
+  static getOwnMetaData<T>(metadataKey: MetaDataKey, clazz: EggProtoImplClass): T | undefined;
+  static hasMetaData(metadataKey: MetaDataKey, clazz: EggProtoImplClass, propKey?: PropertyKey): boolean;
+  static getMetaData<T>(metadataKey: MetaDataKey, clazz: EggProtoImplClass, propKey?: PropertyKey): T | undefined;
+  static getBooleanMetaData(metadataKey: MetaDataKey, clazz: EggProtoImplClass): boolean;
+  static getOwnBooleanMetaData(metadataKey: MetaDataKey, clazz: EggProtoImplClass): boolean;
+  static getArrayMetaData<T>(metadataKey: MetaDataKey, clazz: EggProtoImplClass): Array<T>;
+  /**
+   * init array metadata
+   * not inherit parent metadata
+   * return value true means use default value
+   * return value false means use map value
+   */
+  static initArrayMetaData<T>(metadataKey: MetaDataKey, clazz: EggProtoImplClass, defaultValue: Array<T>): Array<T>;
+  /**
+   * init own array metadata
+   * if parent metadata exists, inherit
+   * if parent metadata not exits, use default value
+   * return value true means use default value
+   * return value false means use map value
+   */
+  static initOwnArrayMetaData<T>(metadataKey: MetaDataKey, clazz: EggProtoImplClass, defaultValue: Array<T>): Array<T>;
+  /**
+   * init own map metadata
+   * if parent metadata exists, inherit
+   * if parent metadata not exits, use default value
+   * return value true means use default value
+   * return value false means use map value
+   */
+  static initOwnMapMetaData<K, V>(metadataKey: MetaDataKey, clazz: EggProtoImplClass, defaultValue: Map<K, V>): Map<K, V>;
+  static getOrStoreMetaData<T>(metadataKey: MetaDataKey, clazz: EggProtoImplClass, metadataValue: T): T;
+}
+//#endregion
+//#region src/util/PrototypeUtil.d.ts
+declare class PrototypeUtil {
+  static readonly IS_EGG_OBJECT_PROTOTYPE: unique symbol;
+  static readonly IS_EGG_OBJECT_MULTI_INSTANCE_PROTOTYPE: unique symbol;
+  static readonly FILE_PATH: unique symbol;
+  static readonly PROTOTYPE_PROPERTY: unique symbol;
+  static readonly MULTI_INSTANCE_PROTOTYPE_STATIC_PROPERTY: unique symbol;
+  static readonly MULTI_INSTANCE_PROTOTYPE_CALLBACK_PROPERTY: unique symbol;
+  static readonly INJECT_OBJECT_NAME_SET: unique symbol;
+  static readonly INJECT_TYPE: unique symbol;
+  static readonly INJECT_CONSTRUCTOR_NAME_SET: unique symbol;
+  static readonly CLAZZ_PROTO: unique symbol;
+  static readonly MULTI_INSTANCE_CONSTRUCTOR_INDEX: unique symbol;
+  static readonly MULTI_INSTANCE_CONSTRUCTOR_ATTRIBUTES: unique symbol;
+  /**
+   * Mark class is egg object prototype
+   * @param {Function} clazz -
+   */
+  static setIsEggPrototype(clazz: EggProtoImplClass): void;
+  /**
+   * If class is egg object prototype, return true
+   * @param {Function} clazz -
+   */
+  static isEggPrototype(clazz: EggProtoImplClass): boolean;
+  /**
+   * Mark class is egg object multi instance prototype
+   * @param {Function} clazz -
+   */
+  static setIsEggMultiInstancePrototype(clazz: EggProtoImplClass): void;
+  /**
+   * If class is egg object multi instance prototype, return true
+   * @param {Function} clazz -
+   */
+  static isEggMultiInstancePrototype(clazz: EggProtoImplClass): boolean;
+  /**
+   * Get the type of the egg multi-instance prototype.
+   * @param {Function} clazz -
+   */
+  static getEggMultiInstancePrototypeType(clazz: EggProtoImplClass): MultiInstanceType | undefined;
+  /**
+   * set class file path
+   * @param {Function} clazz -
+   * @param {string} filePath -
+   */
+  static setFilePath(clazz: EggProtoImplClass, filePath: string): void;
+  /**
+   * get class file path
+   * @param {Function} clazz -
+   */
+  static getFilePath(clazz: EggProtoImplClass): string | undefined;
+  /**
+   * set class property
+   * @param {EggProtoImplClass} clazz -
+   * @param {EggPrototypeInfo} property -
+   */
+  static setProperty(clazz: EggProtoImplClass, property: EggPrototypeInfo): void;
+  /**
+   * get class property
+   * @param {EggProtoImplClass} clazz -
+   * @return {EggPrototypeInfo} -
+   */
+  static getProperty(clazz: EggProtoImplClass): EggPrototypeInfo | undefined;
+  static getInitType(clazz: EggProtoImplClass, ctx: MultiInstancePrototypeGetObjectsContext): Promise<string | undefined>;
+  static getAccessLevel(clazz: EggProtoImplClass, ctx: MultiInstancePrototypeGetObjectsContext): Promise<string | undefined>;
+  static getObjNames(clazz: EggProtoImplClass, ctx: MultiInstancePrototypeGetObjectsContext): Promise<EggPrototypeName[]>;
+  /**
+   * set class property
+   * @param {EggProtoImplClass} clazz -
+   * @param {EggPrototypeInfo} property -
+   */
+  static setMultiInstanceStaticProperty(clazz: EggProtoImplClass, property: EggMultiInstancePrototypeInfo): void;
+  /**
+   * set class property
+   * @param {EggProtoImplClass} clazz -
+   * @param {EggPrototypeInfo} property -
+   */
+  static setMultiInstanceCallbackProperty(clazz: EggProtoImplClass, property: EggMultiInstanceCallbackPrototypeInfo): void;
+  /**
+   * Get instance property of Static multi-instance prototype.
+   * @param {EggProtoImplClass} clazz -
+   */
+  static getStaticMultiInstanceProperty(clazz: EggProtoImplClass): EggMultiInstancePrototypeInfo | undefined;
+  /**
+   * Get instance property of Dynamic multi-instance prototype.
+   * @param {EggProtoImplClass} clazz -
+   * @param {MultiInstancePrototypeGetObjectsContext} ctx -
+   */
+  static getDynamicMultiInstanceProperty(clazz: EggProtoImplClass, ctx: MultiInstancePrototypeGetObjectsContext): Promise<EggMultiInstancePrototypeInfo | undefined>;
+  /**
+   * get class property
+   * @param {EggProtoImplClass} clazz -
+   * @param {MultiInstancePrototypeGetObjectsContext} ctx -
+   */
+  static getMultiInstanceProperty(clazz: EggProtoImplClass, ctx: MultiInstancePrototypeGetObjectsContext): Promise<EggMultiInstancePrototypeInfo | undefined>;
+  static setMultiInstanceConstructorAttributes(clazz: EggProtoImplClass, attributes: QualifierAttribute[]): void;
+  static getMultiInstanceConstructorAttributes(clazz: EggProtoImplClass): QualifierAttribute[];
+  static setMultiInstanceConstructorIndex(clazz: EggProtoImplClass, index: number): void;
+  static getMultiInstanceConstructorIndex(clazz: EggProtoImplClass): number | undefined;
+  static setInjectType(clazz: EggProtoImplClass, type: InjectType): void;
+  static addInjectObject(clazz: EggProtoImplClass, injectObject: InjectObjectInfo): void;
+  static addInjectConstructor(clazz: EggProtoImplClass, injectConstructorInfo: InjectConstructorInfo): void;
+  static getInjectType(clazz: EggProtoImplClass): InjectType | undefined;
+  static getInjectObjects(clazz: EggProtoImplClass): Array<InjectObjectInfo | InjectConstructorInfo>;
+  static getClazzProto(clazz: EggProtoImplClass): object | undefined;
+  static setClazzProto(clazz: EggProtoImplClass, proto: object): void;
+  static getDesignType(clazz: EggProtoImplClass, propKey?: PropertyKey): unknown;
+  static getDesignParamtypes(clazz: EggProtoImplClass, propKey?: PropertyKey): unknown[];
+}
+//#endregion
+//#region src/util/QualifierUtil.d.ts
+declare class QualifierUtil {
+  static addProtoQualifier(clazz: EggProtoImplClass, attribute: QualifierAttribute, value: QualifierValue): void;
+  static getProtoQualifiers(clazz: EggProtoImplClass): QualifierInfo[];
+  static addInjectQualifier(clazz: EggProtoImplClass, property: PropertyKey | undefined, parameterIndex: number | undefined, attribute: QualifierAttribute, value: QualifierValue): void;
+  static addProperQualifier(clazz: EggProtoImplClass, property: PropertyKey, attribute: QualifierAttribute, value: QualifierValue): void;
+  static getProperQualifiers(clazz: EggProtoImplClass, property: PropertyKey): QualifierInfo[];
+  static getQualifierValue(clazz: EggProtoImplClass, attribute: QualifierAttribute): QualifierValue | undefined;
+  static getProperQualifier(clazz: EggProtoImplClass, property: PropertyKey, attribute: QualifierAttribute): QualifierValue | undefined;
+  static matchQualifiers(clazzQualifiers: QualifierInfo[], requestQualifiers: QualifierInfo[]): boolean;
+  static equalQualifiers(clazzQualifiers: QualifierInfo[], requestQualifiers: QualifierInfo[]): boolean;
+  static mergeQualifiers(...qualifiers: QualifierInfo[][]): QualifierInfo[];
+}
+//#endregion
 export { ConfigSourceQualifier, ContextProto, EggQualifier, InitTypeQualifier, Inject, InjectOptional, MetadataUtil, ModuleQualifier, MultiInstanceInfo, MultiInstanceProto, Prototype, PrototypeUtil, QualifierUtil, SingletonProto };