eva4j 1.0.14 → 1.0.16

package/examples/system/notification.yaml

@@ -0,0 +1,147 @@
+# ─────────────────────────────────────────────────────────────────────────────
+# notification — Domain Model (Supporting Domain)
+# ─────────────────────────────────────────────────────────────────────────────
+# Dispatches notifications to users across multiple channels (EMAIL, SMS, PUSH).
+# Tests: listeners (consuming ProductPublishedEvent + ProductDiscontinuedEvent),
+# enum transitions with triggers, soft delete, scaffold endpoint.
+# ─────────────────────────────────────────────────────────────────────────────
+
+aggregates:
+
+  # ════════════════════════════════════════════════════════════════════════════
+  # Aggregate: Notification
+  # ════════════════════════════════════════════════════════════════════════════
+  - name: Notification
+    entities:
+      - name: Notification
+        isRoot: true
+        tableName: notifications
+        hasSoftDelete: true
+        audit:
+          enabled: true
+          trackUser: false
+        fields:
+          - name: id
+            type: String
+          - name: recipientId
+            type: String
+            validations:
+              - type: NotBlank
+                message: "Recipient ID is required"
+          - name: channel
+            type: NotificationChannel
+            validations:
+              - type: NotNull
+                message: "Channel is required"
+          - name: subject
+            type: String
+            validations:
+              - type: NotBlank
+                message: "Subject is required"
+          - name: message
+            type: String
+            validations:
+              - type: NotBlank
+                message: "Message is required"
+          - name: status
+            type: NotificationStatus
+            readOnly: true
+          - name: sentAt
+            type: LocalDateTime
+            readOnly: true
+          - name: readAt
+            type: LocalDateTime
+            readOnly: true
+
+    enums:
+      - name: NotificationChannel
+        values:
+          - EMAIL
+          - SMS
+          - PUSH
+
+      - name: NotificationStatus
+        initialValue: PENDING
+        transitions:
+          - from: PENDING
+            to: SENT
+            method: send
+          - from: SENT
+            to: READ
+            method: markRead
+          - from: [PENDING, SENT]
+            to: FAILED
+            method: fail
+        values:
+          - PENDING
+          - SENT
+          - READ
+          - FAILED
+
+    events:
+      # NotificationSentEvent — triggered by send transition
+      - name: NotificationSentEvent
+        triggers:
+          - send
+        fields:
+          - name: notificationId
+            type: String
+          - name: recipientId
+            type: String
+          - name: sentAt
+            type: LocalDateTime
+
+# ─────────────────────────────────────────────────────────────────────────────
+# Declarative REST endpoints
+# ─────────────────────────────────────────────────────────────────────────────
+endpoints:
+  basePath: /notifications
+  versions:
+    - version: v1
+      operations:
+        - useCase: CreateNotification
+          method: POST
+          path: /
+        - useCase: GetNotification
+          method: GET
+          path: /{id}
+        - useCase: FindAllNotifications
+          method: GET
+          path: /
+        - useCase: DeleteNotification
+          method: DELETE
+          path: /{id}
+        # Scaffold: MarkNotificationRead doesn't match transition pattern
+        # (transition method is markRead → MarkReadNotification, not MarkNotificationRead)
+        # → generates ScaffoldCommand stub with TODO
+        - useCase: MarkNotificationRead
+          method: PUT
+          path: /{id}/read
+
+# ─────────────────────────────────────────────────────────────────────────────
+# Consumed events (listeners)
+# ─────────────────────────────────────────────────────────────────────────────
+listeners:
+  - event: ProductPublishedEvent
+    producer: product
+    topic: PRODUCT_PUBLISHED
+    useCase: SendProductPublishedNotification
+    fields:
+      - name: productId
+        type: String
+      - name: name
+        type: String
+      - name: price
+        type: BigDecimal
+      - name: publishedAt
+        type: LocalDateTime
+
+  - event: ProductDiscontinuedEvent
+    producer: product
+    topic: PRODUCT_DISCONTINUED
+    useCase: SendProductDiscontinuedNotification
+    fields:
+      - name: productId
+        type: String
+      - name: discontinuedAt
+        type: LocalDateTime

package/examples/system/product.yaml

@@ -0,0 +1,185 @@
+# ─────────────────────────────────────────────────────────────────────────────
+# product — Domain Model (Core Domain)
+# ─────────────────────────────────────────────────────────────────────────────
+# Manages the product catalog and categories. Two aggregates with separate
+# lifecycles. Tests: multi-aggregate endpoints fix, VO-unwrap in raise(),
+# transitions + triggers, cross-aggregate reference.
+# ─────────────────────────────────────────────────────────────────────────────
+
+aggregates:
+
+  # ════════════════════════════════════════════════════════════════════════════
+  # Aggregate: Product
+  # ════════════════════════════════════════════════════════════════════════════
+  - name: Product
+    entities:
+      - name: Product
+        isRoot: true
+        tableName: products
+        audit:
+          enabled: true
+          trackUser: true
+        fields:
+          - name: id
+            type: String
+          - name: name
+            type: String
+            validations:
+              - type: NotBlank
+                message: "Product name is required"
+          - name: description
+            type: String
+          - name: price
+            type: Price
+            validations:
+              - type: NotNull
+                message: "Price is required"
+          - name: categoryId
+            type: String
+            reference:
+              aggregate: Category
+            validations:
+              - type: NotBlank
+                message: "Category ID is required"
+          - name: status
+            type: ProductStatus
+            readOnly: true
+          - name: publishedAt
+            type: LocalDateTime
+            readOnly: true
+
+    valueObjects:
+      - name: Price
+        fields:
+          - name: amount
+            type: BigDecimal
+          - name: currency
+            type: String
+        methods:
+          - name: isPositive
+            returnType: boolean
+            parameters: []
+            body: "return this.amount != null && this.amount.compareTo(java.math.BigDecimal.ZERO) > 0;"
+
+    enums:
+      - name: ProductStatus
+        initialValue: DRAFT
+        transitions:
+          - from: DRAFT
+            to: PUBLISHED
+            method: publish
+          - from: PUBLISHED
+            to: DISCONTINUED
+            method: discontinue
+          - from: DRAFT
+            to: DISCONTINUED
+            method: discontinue
+        values:
+          - DRAFT
+          - PUBLISHED
+          - DISCONTINUED
+
+    events:
+      # ProductPublishedEvent — triggered by publish transition.
+      # price: BigDecimal tests VO-unwrap: entity.price is Price, event expects BigDecimal
+      # → generator should emit: this.getPrice().getAmount()
+      - name: ProductPublishedEvent
+        topic: PRODUCT_PUBLISHED
+        triggers:
+          - publish
+        fields:
+          - name: productId
+            type: String
+          - name: name
+            type: String
+          - name: price
+            type: BigDecimal
+          - name: publishedAt
+            type: LocalDateTime
+
+      # ProductDiscontinuedEvent — triggered by discontinue transition
+      - name: ProductDiscontinuedEvent
+        topic: PRODUCT_DISCONTINUED
+        triggers:
+          - discontinue
+        fields:
+          - name: productId
+            type: String
+          - name: discontinuedAt
+            type: LocalDateTime
+
+  # ════════════════════════════════════════════════════════════════════════════
+  # Aggregate: Category
+  # ════════════════════════════════════════════════════════════════════════════
+  - name: Category
+    entities:
+      - name: Category
+        isRoot: true
+        tableName: categories
+        audit:
+          enabled: true
+          trackUser: false
+        fields:
+          - name: id
+            type: String
+          - name: name
+            type: String
+            validations:
+              - type: NotBlank
+                message: "Category name is required"
+          - name: description
+            type: String
+
+    events:
+      # CategoryCreatedEvent — no triggers, raise() called manually in the handler
+      - name: CategoryCreatedEvent
+        fields:
+          - name: categoryId
+            type: String
+          - name: name
+            type: String
+
+# ─────────────────────────────────────────────────────────────────────────────
+# Declarative REST endpoints
+# ─────────────────────────────────────────────────────────────────────────────
+# Multi-aggregate: Product ops are classified to Product, Category ops to
+# Category. Validates the cross-aggregate classification fix.
+# ─────────────────────────────────────────────────────────────────────────────
+endpoints:
+  basePath: /
+  versions:
+    - version: v1
+      operations:
+        # ── Product ───────────────────────────────────────────────────────────
+        - useCase: CreateProduct
+          method: POST
+          path: /products
+        - useCase: GetProduct
+          method: GET
+          path: /products/{id}
+        - useCase: FindAllProducts
+          method: GET
+          path: /products
+        - useCase: UpdateProduct
+          method: PUT
+          path: /products/{id}
+        - useCase: PublishProduct
+          method: PUT
+          path: /products/{id}/publish
+        - useCase: DiscontinueProduct
+          method: PUT
+          path: /products/{id}/discontinue
+
+        # ── Category ──────────────────────────────────────────────────────────
+        - useCase: CreateCategory
+          method: POST
+          path: /categories
+        - useCase: GetCategory
+          method: GET
+          path: /categories/{id}
+        - useCase: FindAllCategorys
+          method: GET
+          path: /categories
+        - useCase: UpdateCategory
+          method: PUT
+          path: /categories/{id}

package/examples/system/system.yaml

@@ -0,0 +1,112 @@
+system:
+  name: product-catalog
+  groupId: com.example
+  javaVersion: 21
+  springBootVersion: 3.5.5
+  database: postgresql
+
+messaging:
+  enabled: true
+  broker: kafka
+  kafka:
+    bootstrapServers: localhost:9092
+    defaultGroupId: product-catalog
+    topicPrefix: catalog
+
+modules:
+
+  # ─────────────────────────────────────────────
+  # CATÁLOGO DE PRODUCTOS
+  # ─────────────────────────────────────────────
+
+  - name: product
+    description: "Catálogo de productos y categorías. Gestiona el ciclo de vida de un producto (DRAFT → PUBLISHED → DISCONTINUED). Dos agregados: Product y Category."
+    exposes:
+      # ── Product ───────────────────────────────
+      - method: POST
+        path: /products
+        useCase: CreateProduct
+        description: "Crear nuevo producto en estado DRAFT"
+      - method: GET
+        path: /products/{id}
+        useCase: GetProduct
+        description: "Obtener detalle de un producto"
+      - method: GET
+        path: /products
+        useCase: FindAllProducts
+        description: "Listar productos con paginación"
+      - method: PUT
+        path: /products/{id}
+        useCase: UpdateProduct
+        description: "Actualizar datos de un producto en estado DRAFT"
+      - method: PUT
+        path: /products/{id}/publish
+        useCase: PublishProduct
+        description: "Publicar un producto: DRAFT → PUBLISHED. Emite ProductPublishedEvent."
+      - method: PUT
+        path: /products/{id}/discontinue
+        useCase: DiscontinueProduct
+        description: "Discontinuar un producto: PUBLISHED/DRAFT → DISCONTINUED"
+      # ── Category ──────────────────────────────
+      - method: POST
+        path: /categories
+        useCase: CreateCategory
+        description: "Crear nueva categoría de productos"
+      - method: GET
+        path: /categories/{id}
+        useCase: GetCategory
+        description: "Obtener detalle de una categoría"
+      - method: GET
+        path: /categories
+        useCase: FindAllCategorys
+        description: "Listar categorías con paginación"
+      - method: PUT
+        path: /categories/{id}
+        useCase: UpdateCategory
+        description: "Actualizar nombre/descripción de una categoría"
+
+  # ─────────────────────────────────────────────
+  # NOTIFICACIONES
+  # ─────────────────────────────────────────────
+
+  - name: notification
+    description: "Despacha notificaciones a usuarios por EMAIL, SMS o PUSH. Reacciona a eventos del dominio product para informar a usuarios interesados."
+    exposes:
+      - method: POST
+        path: /notifications
+        useCase: CreateNotification
+        description: "Crear y encolar una notificación manualmente"
+      - method: GET
+        path: /notifications/{id}
+        useCase: GetNotification
+        description: "Obtener estado de una notificación"
+      - method: GET
+        path: /notifications
+        useCase: FindAllNotifications
+        description: "Listar notificaciones con paginación"
+      - method: DELETE
+        path: /notifications/{id}
+        useCase: DeleteNotification
+        description: "Eliminar lógicamente una notificación (soft delete)"
+      - method: PUT
+        path: /notifications/{id}/read
+        useCase: MarkNotificationRead
+        description: "Marcar notificación como leída"
+
+integrations:
+  async:
+    # Producto publicado → notification envía alerta a usuarios suscritos
+    - event: ProductPublishedEvent
+      producer: product
+      topic: PRODUCT_PUBLISHED
+      consumers:
+        - module: notification
+          useCase: SendProductPublishedNotification
+
+    # Producto discontinuado → notification informa aos usuarios
+    - event: ProductDiscontinuedEvent
+      producer: product
+      topic: PRODUCT_DISCONTINUED
+      consumers:
+        - module: notification
+          useCase: SendProductDiscontinuedNotification