Merge pull request #109 from glandjs/development

feat(core): introduce saga-based module execution and NestJS-compatible dynamic module support

Author: bitsgenix

examples/very-simple.ts

@@ -1,3 +1,4 @@
 export const PATH_METADATA = 'path';
 export const METHOD_METADATA = 'method';
 export const MODULE_METADATA = '__module__';
+export const SAGA_METADATA = '__saga__';

packages/common/constant.ts

@@ -1,10 +1,11 @@
 import { PATH_METADATA } from '../../constant';
+import type { EventType } from '../../types';
 
 /**
  * @publicApi
  */
-export function Channel(stream?: string): ClassDecorator {
+export function Channel(event?: EventType): ClassDecorator {
   return (target: Function) => {
-    Reflect.defineMetadata(PATH_METADATA, stream, target);
+    Reflect.defineMetadata(PATH_METADATA, event, target);
   };
 }

packages/common/decorators/events/channel.decorator.ts

@@ -0,0 +1,11 @@
+import { METHOD_METADATA } from '../../constant';
+import type { EventType } from '../../types';
+
+/**
+ * @publicApi
+ */
+export function Emit(event: EventType): MethodDecorator {
+  return (target: object, key: string | symbol) => {
+    Reflect.defineMetadata(METHOD_METADATA, event, target, key);
+  };
+}

packages/common/decorators/events/emit.decorator.ts

@@ -1,3 +1,4 @@
 import 'reflect-metadata';
 export * from './on.decorator';
 export * from './channel.decorator';
+export * from './saga';

packages/common/decorators/events/index.ts

@@ -0,0 +1,10 @@
+import { METHOD_METADATA } from '../../../constant';
+
+/**
+ * @publicApi
+ */
+export function Compensate(): MethodDecorator {
+  return (target: object, key: string | symbol) => {
+    Reflect.defineMetadata(METHOD_METADATA, {}, target, key);
+  };
+}

packages/common/decorators/events/saga/compensate.decorator.ts

@@ -0,0 +1,4 @@
+import 'reflect-metadata';
+export * from './saga.decorator';
+export * from './step.decorator';
+export * from './compensate.decorator';

packages/common/decorators/events/saga/index.ts

@@ -0,0 +1,11 @@
+import { SAGA_METADATA } from '../../../constant';
+import type { EventType } from '../../../types';
+
+/**
+ * @publicApi
+ */
+export function Saga(opts: { event: EventType; compensation: EventType }): ClassDecorator {
+  return (target: Function) => {
+    Reflect.defineMetadata(SAGA_METADATA, opts, target);
+  };
+}

packages/common/decorators/events/saga/saga.decorator.ts

@@ -0,0 +1,10 @@
+import { METHOD_METADATA } from '../../../constant';
+
+/**
+ * @publicApi
+ */
+export function Step(opts: { index: number }): MethodDecorator {
+  return (target: object, key: string | symbol) => {
+    Reflect.defineMetadata(METHOD_METADATA, opts, target, key);
+  };
+}

packages/common/decorators/events/saga/step.decorator.ts

@@ -7,8 +7,8 @@ export interface EventOptions {
 export interface EventChannel {
   channel(type: EventType): EventChannel;
 
-  request<R>(type: EventType, data: any, strategy?: 'first' | 'last'): R | undefined;
-  request<R>(type: EventType, data: any, strategy?: 'all'): R[];
+  call<R>(type: EventType, data: any, strategy?: 'first' | 'last'): R | undefined;
+  call<R>(type: EventType, data: any, strategy?: 'all'): R[];
 
   respond<T, R>(listener: (data: T, respond: (result: R) => void) => void): Noop;
   respond<T, R>(type: EventType, listener: (data: T, respond: (result: R) => void) => void): Noop;

packages/common/interfaces/events/event.interface.ts renamed to packages/common/interfaces/events/channel.interface.ts

@@ -1 +1 @@
-export * from './event.interface';
+export * from './channel.interface';

packages/common/interfaces/events/index.ts

@@ -5,8 +5,15 @@ export interface ModuleMetadata<T = any> {
   imports?: ImportableModule<T>[];
   controllers?: ApiController<T>[];
   channels?: ApiChannel<T>[];
-  exports?: InjectionToken<T>[];
+  sagas?: Constructor<T>[];
 }
-export interface DynamicModule<T = any> extends ModuleMetadata<T> {
+
+export interface DynamicModule<T = any> {
+  imports?: ImportableModule<T>[];
+  exports?: InjectionToken<T>[];
   module: Constructor<any>;
+  /**
+   * @default false
+   */
+  global?: boolean;
 }

packages/common/interfaces/modules.interfaces.ts

@@ -1,6 +1,6 @@
 import { DynamicModule, ModuleMetadata } from '../interfaces';
 import { Constructor } from '@medishn/toolkit';
-export type ImportableModule<T = any> = Constructor<T> | DynamicModule<T>;
+export type ImportableModule<T = any> = Constructor<T> | DynamicModule | Promise<DynamicModule>;
 
 export type InjectionToken<T = any> = string | symbol | Constructor<T> | Function;