@rolandsall24/nest-mediator 1.2.0-beta.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,13 +17,19 @@ A lightweight CQRS mediator for NestJS — start simple, add event persistence w
17
17
  - **Zero config** — Decorator-based auto-discovery, built on NestJS DI
18
18
 
19
19
  ### Topology View
20
- ![Topology View](images/topology-view.png)
20
+ ![Topology View](https://raw.githubusercontent.com/RolandSall/nest-mediator/main/images/topology-view.png)
21
21
 
22
22
  ### Execution Trace — Flow
23
- ![Execution Trace Flow](images/execution-trace-flow.png)
23
+ ![Execution Trace Flow](https://raw.githubusercontent.com/RolandSall/nest-mediator/main/images/execution-trace-flow.png)
24
24
 
25
25
  ### Execution Trace — Sequence
26
- ![Execution Trace Sequence](images/execution-trace-sequence.png)
26
+ ![Execution Trace Sequence](https://raw.githubusercontent.com/RolandSall/nest-mediator/main/images/execution-trace-sequence.png)
27
+
28
+ ### Architect — Drag & Drop Flow Design
29
+ ![Architect Drag & Drop](https://raw.githubusercontent.com/RolandSall/nest-mediator/main/images/architect-drag-drop.png)
30
+
31
+ ### Architect — Code Generation
32
+ ![Architect Code Generation](https://raw.githubusercontent.com/RolandSall/nest-mediator/main/images/architect-code-generation.png)
27
33
 
28
34
  ## Installation
29
35
 
@@ -990,6 +996,32 @@ The embedded PostgreSQL is automatically skipped when `DATABASE_URL` points to a
990
996
 
991
997
  For full documentation, see the [DockerHub page](https://hub.docker.com/r/rolandsall24/mediatorflow).
992
998
 
999
+ ### Architect — Visual CQRS Designer
1000
+
1001
+ The Architect tab in MediatorFlow lets you visually design your CQRS flows using drag-and-drop. Build your application architecture by placing nodes from the palette — Commands, Queries, Handlers, Events, Consumers, Behaviors, and Aggregates — onto a canvas and linking them together.
1002
+
1003
+ #### Drag & Drop Flow Design
1004
+
1005
+ - Drag nodes from the **Palette** (left sidebar) onto the canvas
1006
+ - Connect Commands/Queries to their Handlers, Handlers to Events, Events to Consumers
1007
+ - Visual edge labels (e.g., "handles") clarify the relationship between nodes
1008
+ - Zoom, pan, and resize nodes to organize complex flows
1009
+
1010
+ #### Code Generation
1011
+
1012
+ Once your flow is designed, click **Generate** to produce ready-to-use TypeScript/NestJS code compatible with `@rolandsall24/nest-mediator`. The generated code includes proper decorators, imports, and handler stubs — download everything as a zip file.
1013
+
1014
+ - Preview generated files with syntax highlighting before downloading
1015
+ - Each command/query gets its own file along with its handler
1016
+ - Code follows NestJS conventions with proper `@CommandHandler`/`@QueryHandler` decorators
1017
+ - Download as a zip to drop directly into your project
1018
+
1019
+ #### AI Chat
1020
+
1021
+ The Architect also includes an AI Chat panel where you can describe your CQRS flow in natural language (e.g., *"Build me an order management system with CreateOrder, CancelOrder commands..."*) and have it generate the flow diagram for you. Requires an OpenAI API key configured in settings. **This feature is currently in beta.**
1022
+
1023
+ > **Note:** Code generation currently supports TypeScript + NestJS only.
1024
+
993
1025
  ### Zero Overhead When Disabled
994
1026
 
995
1027
  When `mediatorFlow.enabled` is `false` (or not set), the `StepEmitter` is still registered as a NestJS provider but its `emit()` method returns immediately on line 1 — zero allocation, zero network calls. The `wrapAsync()` method skips telemetry entirely and just executes your function directly. There is no performance impact when telemetry is off.
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rolandsall24/nest-mediator",
3
- "version": "1.2.0-beta.1",
3
+ "version": "1.2.0",
4
4
  "description": "A lightweight CQRS (Command Query Responsibility Segregation) mediator pattern implementation for NestJS applications with optional event sourcing",
5
5
  "author": "Roland Salloum",
6
6
  "license": "MIT",