@midwayjs/core 3.19.0 → 4.0.0-alpha.1

package/dist/interface.d.ts

@@ -1,7 +1,10 @@
 /// <reference types="node" />
-import * as EventEmitter from 'events';
 import type { AsyncContextManager } from './common/asyncContextManager';
 import type { LoggerFactory } from './common/loggerFactory';
+import type { ManagedResolverFactory } from './context/managedResolverFactory';
+import type { EventEmitter } from 'events';
+import type { FunctionalConfiguration } from './functional';
+export type ClassType<T = any> = new (...args: any[]) => T;
 export type PowerPartial<T> = {
     [U in keyof T]?: T[U] extends {} ? PowerPartial<T[U]> : T[U];
 };
@@ -41,7 +44,6 @@ export type WithoutFn<T> = {
 };
 export type MiddlewareParamArray = Array<string | any>;
 export type ObjectIdentifier = string | Symbol;
-export type GroupModeType = 'one' | 'multi';
 export declare enum ScopeEnum {
     Singleton = "Singleton",
     Request = "Request",
@@ -50,15 +52,24 @@ export declare enum ScopeEnum {
 export declare enum InjectModeEnum {
     Identifier = "Identifier",
     Class = "Class",
-    PropertyName = "PropertyName"
+    SelfName = "SelfName"
 }
 /**
- * 内部管理的属性、json、ref等解析实例存储
+ * Metadata when using @Inject property injection
  */
-export interface IManagedInstance {
-    type: string;
-    value?: any;
-    args?: any;
+export interface PropertyInjectMetadata {
+    args: any[];
+    id: ObjectIdentifier | (() => ObjectIdentifier | ClassType);
+    name: string;
+    injectMode: InjectModeEnum;
+    targetKey: string;
+    isLazyInject: boolean;
+}
+/**
+ * Metadata when using @Inject constructor injection
+ */
+export interface ConstructorInjectMetadata extends PropertyInjectMetadata {
+    parameterIndex: number;
 }
 export interface ObjectDefinitionOptions {
     isAsync?: boolean;
@@ -239,27 +250,6 @@ export declare namespace FaaSMetadata {
     }
     export {};
 }
-export declare abstract class FrameworkType {
-    abstract name: string;
-}
-export declare class MidwayFrameworkType extends FrameworkType {
-    name: string;
-    static WEB: MidwayFrameworkType;
-    static WEB_KOA: MidwayFrameworkType;
-    static WEB_EXPRESS: MidwayFrameworkType;
-    static FAAS: MidwayFrameworkType;
-    static MS_GRPC: MidwayFrameworkType;
-    static MS_RABBITMQ: MidwayFrameworkType;
-    static MS_KAFKA: MidwayFrameworkType;
-    static WS_IO: MidwayFrameworkType;
-    static WS: MidwayFrameworkType;
-    static SERVERLESS_APP: MidwayFrameworkType;
-    static CUSTOM: MidwayFrameworkType;
-    static EMPTY: MidwayFrameworkType;
-    static LIGHT: MidwayFrameworkType;
-    static TASK: MidwayFrameworkType;
-    constructor(name: string);
-}
 export declare enum ServerlessTriggerType {
     EVENT = "event",
     HTTP = "http",
@@ -293,11 +283,6 @@ export interface IMethodAspect {
     before?(joinPoint: JoinPoint): void;
     around?(joinPoint: JoinPoint): any;
 }
-export interface IModuleStore {
-    listModule(key: string): any;
-    saveModule(key: string, module: any): any;
-    transformModule?(moduleMap: Map<string, Set<any>>): any;
-}
 export interface TSDesignType<OriginType = unknown> {
     name: string;
     originDesign: OriginType;
@@ -320,6 +305,10 @@ export interface PipeTransform<T = unknown, R = unknown> {
 }
 export type PipeTransformFunction<T = any, R = any> = (value: T) => R;
 export type PipeUnionTransform<T = any, R = any> = PipeTransform<T, R> | (new (...args: any[]) => PipeTransform<T, R>) | PipeTransformFunction<T, R>;
+export interface PropertyDecoratorOptions {
+    impl?: boolean;
+    allowMulti?: boolean;
+}
 export interface MethodDecoratorMetaData<Metadata = any> {
     propertyName: string;
     /** decorator key */
@@ -362,10 +351,6 @@ export interface ILogger {
     error(msg: any, ...args: any[]): void;
     warn(msg: any, ...args: any[]): void;
 }
-/**
- * @deprecated
- */
-export type IMidwayLogger = ILogger;
 /**
  * Logger Options for midway, you can merge this interface in package
  * @example
@@ -445,19 +430,14 @@ export interface ILifeCycle extends Partial<IObjectLifeCycle> {
     onHealthCheck?(container: IMidwayContainer): Promise<HealthResult>;
     onStop?(container: IMidwayContainer, mainApp?: IMidwayApplication): Promise<void>;
 }
-export type ObjectContext = {
-    originName?: string;
-};
 /**
  * Abstract Object Factory
  * 对象容器抽象
  */
 export interface IObjectFactory {
     registry: IObjectDefinitionRegistry;
-    get<T>(identifier: new (...args: any[]) => T, args?: any[], objectContext?: ObjectContext): T;
-    get<T>(identifier: ObjectIdentifier, args?: any[], objectContext?: ObjectContext): T;
-    getAsync<T>(identifier: new (...args: any[]) => T, args?: any[], objectContext?: ObjectContext): Promise<T>;
-    getAsync<T>(identifier: ObjectIdentifier, args?: any[], objectContext?: ObjectContext): Promise<T>;
+    get<T>(identifier: ClassType<T> | string, args?: any[]): T;
+    getAsync<T>(identifier: ClassType<T> | string, args?: any[]): Promise<T>;
 }
 export declare enum ObjectLifeCycleEvent {
     BEFORE_BIND = "beforeBind",
@@ -510,8 +490,8 @@ export interface IObjectDefinition {
     path: any;
     export: string;
     dependsOn: ObjectIdentifier[];
-    constructorArgs: IManagedInstance[];
-    properties: IProperties;
+    constructorArgs: ConstructorInjectMetadata[];
+    properties: Map<string, PropertyInjectMetadata>;
     scope: ScopeEnum;
     isAsync(): boolean;
     isSingletonScope(): boolean;
@@ -540,11 +520,11 @@ export interface IObjectDefinition {
     bindHook?: (module: any, options?: IObjectDefinition) => void;
 }
 export interface IObjectCreator {
+    type: string;
     load(): any;
-    doConstruct(Clzz: any, args?: any, context?: IMidwayContainer): any;
-    doConstructAsync(Clzz: any, args?: any, context?: IMidwayContainer): Promise<any>;
-    doInit(obj: any): void;
-    doInitAsync(obj: any): Promise<void>;
+    doConstruct(Clzz: any, args?: any[]): any;
+    doInit(obj: any, context: IMidwayContainer): any;
+    doInitAsync(obj: any, context: IMidwayContainer): Promise<any>;
     doDestroy(obj: any): void;
     doDestroyAsync(obj: any): Promise<void>;
 }
@@ -568,28 +548,6 @@ export interface IObjectDefinitionRegistry {
     getIdentifierRelation(): IIdentifierRelationShip;
     setIdentifierRelation(identifierRelation: IIdentifierRelationShip): any;
 }
-/**
- * 属性配置抽象
- */
-export interface IProperties extends Map<ObjectIdentifier, any> {
-    getProperty(key: ObjectIdentifier, defaultValue?: any): any;
-    setProperty(key: ObjectIdentifier, value: any): any;
-    propertyKeys(): ObjectIdentifier[];
-}
-/**
- * 解析内部管理的属性、json、ref等实例的解析器
- * 同时创建这些对象的实际使用的对象
- */
-export interface IManagedResolver {
-    type: string;
-    resolve(managed: IManagedInstance): any;
-    resolveAsync(managed: IManagedInstance): Promise<any>;
-}
-export interface IManagedResolverFactoryCreateOptions {
-    definition: IObjectDefinition;
-    args?: any;
-    namespace?: string;
-}
 export type HandlerFunction = (
 /**
  * decorator uuid key
@@ -613,52 +571,57 @@ export type ParameterHandlerFunction = (options: {
     parameterIndex: number;
 }) => any;
 export interface IIdentifierRelationShip {
-    saveClassRelation(module: any, namespace?: string): any;
-    saveFunctionRelation(ObjectIdentifier: any, uuid: any): any;
+    saveClassRelation(module: any, namespace?: string): void;
+    saveFunctionRelation(id: ObjectIdentifier, uuid: string): void;
     hasRelation(id: ObjectIdentifier): boolean;
     getRelation(id: ObjectIdentifier): string;
 }
-export interface IMidwayContainer extends IObjectFactory, WithFn<IObjectLifeCycle> {
-    parent: IMidwayContainer;
+export interface IMidwayGlobalContainer extends IMidwayContainer, WithFn<IObjectLifeCycle> {
     identifierMapping: IIdentifierRelationShip;
     objectCreateEventTarget: EventEmitter;
-    ready(): void | Promise<void>;
-    stop(): Promise<void>;
-    registerObject(identifier: ObjectIdentifier, target: any): any;
-    load(module: any | any[]): any;
-    hasNamespace(namespace: string): boolean;
     getNamespaceList(): string[];
-    hasDefinition(identifier: ObjectIdentifier): any;
-    hasObject(identifier: ObjectIdentifier): any;
+    addNamespace(namespace: string): void;
     bind<T>(target: T, options?: Partial<IObjectDefinition>): void;
     bind<T>(identifier: ObjectIdentifier, target: T, options?: Partial<IObjectDefinition>): void;
-    bindClass(exports: any, options?: Partial<IObjectDefinition>): any;
-    setFileDetector(fileDetector: IFileDetector): any;
-    createChild(): IMidwayContainer;
+    bindClass(exports: any, options?: Partial<IObjectDefinition>): void;
+    stop(): Promise<void>;
+    getManagedResolverFactory(): ManagedResolverFactory;
+}
+export interface IMidwayRequestContainer extends IMidwayContainer {
+    parent: IMidwayContainer;
+    getContext(): IMidwayContext;
+}
+export interface IMidwayContainer extends IObjectFactory {
+    registerObject(identifier: ObjectIdentifier, target: any): void;
+    hasDefinition(identifier: ObjectIdentifier): boolean;
+    getDefinition(identifier: ObjectIdentifier): IObjectDefinition;
+    hasObject(identifier: ObjectIdentifier): boolean;
+    getObject<T>(identifier: ObjectIdentifier): T;
     /**
      * Set value to app attribute map
      * @param key
      * @param value
      */
-    setAttr(key: string, value: any): any;
+    setAttr(key: string, value: any): void;
     /**
      * Get value from app attribute map
      * @param key
      */
     getAttr<T>(key: string): T;
+    /**
+     * Get IoC identifier
+     */
+    getIdentifier(identifier: (ClassType | string)): string;
     /**
      * Get instance IoC container scope
      * @param instance
      */
     getInstanceScope(instance: any): ScopeEnum | undefined;
+    hasNamespace(namespace: string): boolean;
 }
-/**
- * @deprecated
- */
-export type IApplicationContext = IMidwayContainer;
 export interface IFileDetector {
-    run(container: IMidwayContainer, fileDetectorOptions?: Record<string, any>): void | Promise<void>;
-    setExtraDetectorOptions(detectorOptions: Record<string, any>): any;
+    run(container: IMidwayGlobalContainer, namespace: string): Promise<void>;
+    runSync(container: IMidwayGlobalContainer, namespace: string): void;
 }
 export interface IConfigService {
     add(configFilePaths: any[]): any;
@@ -784,11 +747,6 @@ export interface IMidwayBaseApplication<CTX extends IMidwayContext> {
      * get current related framework
      */
     getFramework(): IMidwayFramework<this, CTX, unknown>;
-    /**
-     * @deprecated
-     * Get current framework type in MidwayFrameworkType enum
-     */
-    getFrameworkType(): FrameworkType;
     /**
      * Get current running process type, app or agent, just for egg
      */
@@ -796,7 +754,7 @@ export interface IMidwayBaseApplication<CTX extends IMidwayContext> {
     /**
      * Get global Midway IoC Container
      */
-    getApplicationContext(): IMidwayContainer;
+    getApplicationContext(): IMidwayGlobalContainer;
     /**
      * Get all configuration values or get the specified configuration through parameters
      * @param key config key
@@ -877,20 +835,11 @@ export interface IMidwayBootstrapOptions {
     [customPropertyKey: string]: any;
     baseDir?: string;
     appDir?: string;
-    applicationContext?: IMidwayContainer;
+    applicationContext?: IMidwayGlobalContainer;
     preloadModules?: any[];
-    /**
-     * @deprecated please use 'imports'
-     */
-    configurationModule?: any | any[];
     imports?: any | any[];
     moduleLoadType?: ModuleLoadType;
-    moduleDetector?: IFileDetector | false;
     logger?: boolean | ILogger;
-    /**
-     * @deprecated please set it from '@Configuration' decorator
-     */
-    ignore?: string[];
     globalConfig?: Array<{
         [environmentName: string]: Record<string, any>;
     }> | Record<string, any>;
@@ -906,13 +855,13 @@ export interface IConfigurationOptions {
 export interface IMidwayFramework<APP extends IMidwayApplication<CTX>, CTX extends IMidwayContext, CONFIG extends IConfigurationOptions, ResOrNext = unknown, Next = unknown> {
     app: APP;
     configurationOptions: CONFIG;
-    configure(options?: CONFIG): any;
+    configure(options?: CONFIG): CONFIG;
     isEnable(): boolean;
     initialize(options: Partial<IMidwayBootstrapOptions>): Promise<void>;
     run(): Promise<void>;
     stop(): Promise<void>;
     getApplication(): APP;
-    getApplicationContext(): IMidwayContainer;
+    getApplicationContext(): IMidwayGlobalContainer;
     getConfiguration(key?: string): any;
     getCurrentEnvironment(): string;
     getFrameworkName(): string;
@@ -929,7 +878,6 @@ export interface IMidwayFramework<APP extends IMidwayApplication<CTX>, CTX exten
     useGuard(guard: CommonGuardUnion<CTX>): void;
     runGuard(ctx: CTX, supplierClz: new (...args: any[]) => any, methodName: string): Promise<boolean>;
     getNamespace(): string;
-    setNamespace(namespace: string): void;
 }
 export interface MidwayAppInfo {
     pkg: Record<string, any>;
@@ -1011,6 +959,24 @@ export interface ServerSendEventStreamOptions<CTX extends IMidwayContext> {
     closeEvent?: string;
     tpl?: (data: ServerSendEventMessage, ctx: CTX) => ServerSendEventMessage;
 }
-export type ClassType<T = any> = new (...args: any[]) => T;
+export interface IComponentInfo {
+    component: {
+        Configuration: ClassType<ILifeCycle>;
+    } | FunctionalConfiguration;
+    enabledEnvironment?: string[];
+}
+export interface InjectionConfigurationOptions {
+    imports?: Array<IComponentInfo | {
+        Configuration: ClassType<ILifeCycle>;
+    } | FunctionalConfiguration>;
+    importObjects?: Record<string, unknown>;
+    importConfigs?: Array<{
+        [environmentName: string]: Record<string, any>;
+    }> | Record<string, any>;
+    importConfigFilter?: (config: Record<string, any>) => Record<string, any>;
+    namespace?: string;
+    detector?: IFileDetector | false;
+}
+export type FunctionalConfigurationOptions = InjectionConfigurationOptions & ILifeCycle;
 export {};
 //# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -1,54 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MidwayProcessTypeEnum = exports.ObjectLifeCycleEvent = exports.ServerlessTriggerType = exports.MidwayFrameworkType = exports.FrameworkType = exports.MSListenerType = exports.MSProviderType = exports.InjectModeEnum = exports.ScopeEnum = void 0;
+exports.MidwayProcessTypeEnum = exports.ObjectLifeCycleEvent = exports.ServerlessTriggerType = exports.MSListenerType = exports.MSProviderType = exports.InjectModeEnum = exports.ScopeEnum = void 0;
 var ScopeEnum;
 (function (ScopeEnum) {
     ScopeEnum["Singleton"] = "Singleton";
     ScopeEnum["Request"] = "Request";
     ScopeEnum["Prototype"] = "Prototype";
-})(ScopeEnum = exports.ScopeEnum || (exports.ScopeEnum = {}));
+})(ScopeEnum || (exports.ScopeEnum = ScopeEnum = {}));
 var InjectModeEnum;
 (function (InjectModeEnum) {
     InjectModeEnum["Identifier"] = "Identifier";
     InjectModeEnum["Class"] = "Class";
-    InjectModeEnum["PropertyName"] = "PropertyName";
-})(InjectModeEnum = exports.InjectModeEnum || (exports.InjectModeEnum = {}));
+    InjectModeEnum["SelfName"] = "SelfName";
+})(InjectModeEnum || (exports.InjectModeEnum = InjectModeEnum = {}));
 var MSProviderType;
 (function (MSProviderType) {
     MSProviderType["DUBBO"] = "dubbo";
     MSProviderType["GRPC"] = "gRPC";
-})(MSProviderType = exports.MSProviderType || (exports.MSProviderType = {}));
+})(MSProviderType || (exports.MSProviderType = MSProviderType = {}));
 var MSListenerType;
 (function (MSListenerType) {
     MSListenerType["RABBITMQ"] = "rabbitmq";
     MSListenerType["MQTT"] = "mqtt";
     MSListenerType["KAFKA"] = "kafka";
     MSListenerType["REDIS"] = "redis";
-})(MSListenerType = exports.MSListenerType || (exports.MSListenerType = {}));
-class FrameworkType {
-}
-exports.FrameworkType = FrameworkType;
-class MidwayFrameworkType extends FrameworkType {
-    constructor(name) {
-        super();
-        this.name = name;
-    }
-}
-exports.MidwayFrameworkType = MidwayFrameworkType;
-MidwayFrameworkType.WEB = new MidwayFrameworkType('@midwayjs/web');
-MidwayFrameworkType.WEB_KOA = new MidwayFrameworkType('@midwayjs/web-koa');
-MidwayFrameworkType.WEB_EXPRESS = new MidwayFrameworkType('@midwayjs/express');
-MidwayFrameworkType.FAAS = new MidwayFrameworkType('@midwayjs/faas');
-MidwayFrameworkType.MS_GRPC = new MidwayFrameworkType('@midwayjs/grpc');
-MidwayFrameworkType.MS_RABBITMQ = new MidwayFrameworkType('@midwayjs/rabbitmq');
-MidwayFrameworkType.MS_KAFKA = new MidwayFrameworkType('@midwayjs/kafka');
-MidwayFrameworkType.WS_IO = new MidwayFrameworkType('@midwayjs/socketio');
-MidwayFrameworkType.WS = new MidwayFrameworkType('@midwayjs/ws');
-MidwayFrameworkType.SERVERLESS_APP = new MidwayFrameworkType('@midwayjs/serverless-app');
-MidwayFrameworkType.CUSTOM = new MidwayFrameworkType('');
-MidwayFrameworkType.EMPTY = new MidwayFrameworkType('empty');
-MidwayFrameworkType.LIGHT = new MidwayFrameworkType('light');
-MidwayFrameworkType.TASK = new MidwayFrameworkType('@midwayjs/task');
+})(MSListenerType || (exports.MSListenerType = MSListenerType = {}));
 var ServerlessTriggerType;
 (function (ServerlessTriggerType) {
     ServerlessTriggerType["EVENT"] = "event";
@@ -63,7 +39,7 @@ var ServerlessTriggerType;
     ServerlessTriggerType["HSF"] = "hsf";
     ServerlessTriggerType["MTOP"] = "mtop";
     ServerlessTriggerType["SSR"] = "ssr";
-})(ServerlessTriggerType = exports.ServerlessTriggerType || (exports.ServerlessTriggerType = {}));
+})(ServerlessTriggerType || (exports.ServerlessTriggerType = ServerlessTriggerType = {}));
 var ObjectLifeCycleEvent;
 (function (ObjectLifeCycleEvent) {
     ObjectLifeCycleEvent["BEFORE_BIND"] = "beforeBind";
@@ -71,10 +47,10 @@ var ObjectLifeCycleEvent;
     ObjectLifeCycleEvent["AFTER_CREATED"] = "afterObjectCreated";
     ObjectLifeCycleEvent["AFTER_INIT"] = "afterObjectInit";
     ObjectLifeCycleEvent["BEFORE_DESTROY"] = "beforeObjectDestroy";
-})(ObjectLifeCycleEvent = exports.ObjectLifeCycleEvent || (exports.ObjectLifeCycleEvent = {}));
+})(ObjectLifeCycleEvent || (exports.ObjectLifeCycleEvent = ObjectLifeCycleEvent = {}));
 var MidwayProcessTypeEnum;
 (function (MidwayProcessTypeEnum) {
     MidwayProcessTypeEnum["APPLICATION"] = "APPLICATION";
     MidwayProcessTypeEnum["AGENT"] = "AGENT";
-})(MidwayProcessTypeEnum = exports.MidwayProcessTypeEnum || (exports.MidwayProcessTypeEnum = {}));
+})(MidwayProcessTypeEnum || (exports.MidwayProcessTypeEnum = MidwayProcessTypeEnum = {}));
 //# sourceMappingURL=interface.js.map

package/dist/legacy/constants.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @deprecated Use OBJECT_DEFINITION_KEY instead
+ */
+export declare const OBJ_DEF_CLS = "common:object_definition";
+/**
+ * @deprecated Use PROPERTY_INJECT_KEY instead
+ */
+export declare const INJECT_TAG = "common:property_inject";
+/**
+ * @deprecated Use ALL_VALUE_KEY instead
+ */
+export declare const ALL = "common:all_value_key";
+/**
+ * @deprecated Use CUSTOM_PROPERTY_INJECT_KEY instead
+ */
+export declare const INJECT_CUSTOM_PROPERTY = "common:custom_property_inject";
+/**
+ * @deprecated Use CUSTOM_METHOD_INJECT_KEY instead
+ */
+export declare const INJECT_CUSTOM_METHOD = "common:custom_method_inject";
+/**
+ * @deprecated Use CUSTOM_PARAM_INJECT_KEY instead
+ */
+export declare const INJECT_CUSTOM_PARAM = "common:custom_param_inject";
+/**
+ * @deprecated Use PROVIDE_KEY instead
+ */
+export declare const TAGGED_CLS = "common:provide";
+//# sourceMappingURL=constants.d.ts.map

package/dist/legacy/constants.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TAGGED_CLS = exports.INJECT_CUSTOM_PARAM = exports.INJECT_CUSTOM_METHOD = exports.INJECT_CUSTOM_PROPERTY = exports.ALL = exports.INJECT_TAG = exports.OBJ_DEF_CLS = void 0;
+const decorator_1 = require("../decorator");
+/**
+ * @deprecated Use OBJECT_DEFINITION_KEY instead
+ */
+exports.OBJ_DEF_CLS = decorator_1.OBJECT_DEFINITION_KEY;
+/**
+ * @deprecated Use PROPERTY_INJECT_KEY instead
+ */
+exports.INJECT_TAG = decorator_1.PROPERTY_INJECT_KEY;
+/**
+ * @deprecated Use ALL_VALUE_KEY instead
+ */
+exports.ALL = decorator_1.ALL_VALUE_KEY;
+/**
+ * @deprecated Use CUSTOM_PROPERTY_INJECT_KEY instead
+ */
+exports.INJECT_CUSTOM_PROPERTY = decorator_1.CUSTOM_PROPERTY_INJECT_KEY;
+/**
+ * @deprecated Use CUSTOM_METHOD_INJECT_KEY instead
+ */
+exports.INJECT_CUSTOM_METHOD = decorator_1.CUSTOM_METHOD_INJECT_KEY;
+/**
+ * @deprecated Use CUSTOM_PARAM_INJECT_KEY instead
+ */
+exports.INJECT_CUSTOM_PARAM = decorator_1.CUSTOM_PARAM_INJECT_KEY;
+/**
+ * @deprecated Use PROVIDE_KEY instead
+ */
+exports.TAGGED_CLS = decorator_1.PROVIDE_KEY;
+//# sourceMappingURL=constants.js.map