Merge branch 'main' into chore/exact-version-deps

event-catalog · Oct 20, 2024 · 95bb104 · 95bb104
2 parents de4cd43 + 4525464
commit 95bb104
Show file tree

Hide file tree

Showing 68 changed files with 549 additions and 340 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,23 @@
 # @eventcatalog/core
 
+## 2.9.1
+
+### Patch Changes
+
+- 5fa9228: fix(core): moving rimraf to dep of project
+
+## 2.9.0
+
+### Minor Changes
+
+- 70d27a7: feat(core): support nested folder structures for domains, services and messages
+
+## 2.8.12
+
+### Patch Changes
+
+- e7cb5d7: chore(core): added astro file path to resources
+
 ## 2.8.11
 
 ### Patch Changes

diff --git a/...lt/services/InventoryService/changelog.md → ...rs/services/InventoryService/changelog.md b/...lt/services/InventoryService/changelog.md → ...rs/services/InventoryService/changelog.md
diff --git a/...es/default/commands/AddInventory/index.md → ...oryService/commands/AddInventory/index.md b/...es/default/commands/AddInventory/index.md → ...oryService/commands/AddInventory/index.md
diff --git a/...default/commands/AddInventory/schema.json → ...Service/commands/AddInventory/schema.json b/...default/commands/AddInventory/schema.json → ...Service/commands/AddInventory/schema.json
diff --git a/...ples/default/commands/PlaceOrder/index.md → ...ntoryService/commands/PlaceOrder/index.md b/...ples/default/commands/PlaceOrder/index.md → ...ntoryService/commands/PlaceOrder/index.md
diff --git a/...s/default/commands/PlaceOrder/schema.json → ...ryService/commands/PlaceOrder/schema.json b/...s/default/commands/PlaceOrder/schema.json → ...ryService/commands/PlaceOrder/schema.json
diff --git a/...default/commands/UpdateInventory/index.md → ...Service/commands/UpdateInventory/index.md b/...default/commands/UpdateInventory/index.md → ...Service/commands/UpdateInventory/index.md
diff --git a/...ault/commands/UpdateInventory/schema.json → ...vice/commands/UpdateInventory/schema.json b/...ault/commands/UpdateInventory/schema.json → ...vice/commands/UpdateInventory/schema.json
diff --git a/.../Inventory/InventoryAdjusted/changelog.md → ...ice/events/InventoryAdjusted/changelog.md b/.../Inventory/InventoryAdjusted/changelog.md → ...ice/events/InventoryAdjusted/changelog.md
diff --git a/...ents/Inventory/InventoryAdjusted/index.md → ...Service/events/InventoryAdjusted/index.md b/...ents/Inventory/InventoryAdjusted/index.md → ...Service/events/InventoryAdjusted/index.md
diff --git a/...s/Inventory/InventoryAdjusted/schema.avro → ...vice/events/InventoryAdjusted/schema.avro b/...s/Inventory/InventoryAdjusted/schema.avro → ...vice/events/InventoryAdjusted/schema.avro
diff --git a/...s/Inventory/InventoryAdjusted/schema.json → ...vice/events/InventoryAdjusted/schema.json b/...s/Inventory/InventoryAdjusted/schema.json → ...vice/events/InventoryAdjusted/schema.json
diff --git a/...toryAdjusted/versioned/0.0.1/changelog.md → ...toryAdjusted/versioned/0.0.1/changelog.md b/...toryAdjusted/versioned/0.0.1/changelog.md → ...toryAdjusted/versioned/0.0.1/changelog.md
diff --git a/...nventoryAdjusted/versioned/0.0.1/index.md → ...nventoryAdjusted/versioned/0.0.1/index.md b/...nventoryAdjusted/versioned/0.0.1/index.md → ...nventoryAdjusted/versioned/0.0.1/index.md
diff --git a/...ntoryAdjusted/versioned/0.0.1/schema.avro → ...ntoryAdjusted/versioned/0.0.1/schema.avro b/...ntoryAdjusted/versioned/0.0.1/schema.avro → ...ntoryAdjusted/versioned/0.0.1/schema.avro
diff --git a/...toryAdjusted/versioned/1.0.0/changelog.md → ...toryAdjusted/versioned/1.0.0/changelog.md b/...toryAdjusted/versioned/1.0.0/changelog.md → ...toryAdjusted/versioned/1.0.0/changelog.md
diff --git a/...nventoryAdjusted/versioned/1.0.0/index.md → ...nventoryAdjusted/versioned/1.0.0/index.md b/...nventoryAdjusted/versioned/1.0.0/index.md → ...nventoryAdjusted/versioned/1.0.0/index.md
diff --git a/...ntoryAdjusted/versioned/1.0.0/schema.avro → ...ntoryAdjusted/versioned/1.0.0/schema.avro b/...ntoryAdjusted/versioned/1.0.0/schema.avro → ...ntoryAdjusted/versioned/1.0.0/schema.avro
diff --git a/...ault/events/Inventory/OutOfStock/index.md → ...ventoryService/events/OutOfStock/index.md b/...ault/events/Inventory/OutOfStock/index.md → ...ventoryService/events/OutOfStock/index.md
diff --git a/...ntory/OutOfStock/versioned/0.0.1/index.md → ...vents/OutOfStock/versioned/0.0.1/index.md b/...ntory/OutOfStock/versioned/0.0.1/index.md → ...vents/OutOfStock/versioned/0.0.1/index.md
diff --git a/...efault/services/InventoryService/index.md → ...Orders/services/InventoryService/index.md b/...efault/services/InventoryService/index.md → ...Orders/services/InventoryService/index.md
diff --git a/...InventoryService/versioned/0.0.1/index.md → ...InventoryService/versioned/0.0.1/index.md b/...InventoryService/versioned/0.0.1/index.md → ...InventoryService/versioned/0.0.1/index.md
diff --git a/...ult/services/NotificationService/index.md → ...ers/services/NotificationService/index.md b/...ult/services/NotificationService/index.md → ...ers/services/NotificationService/index.md
diff --git a/...fault/services/OrdersService/changelog.md → ...rders/services/OrdersService/changelog.md b/...fault/services/OrdersService/changelog.md → ...rders/services/OrdersService/changelog.md
diff --git a/...efault/events/Order/OrderAmended/index.md → ...rdersService/events/OrderAmended/index.md b/...efault/events/Order/OrderAmended/index.md → ...rdersService/events/OrderAmended/index.md
diff --git a/...ult/events/Order/OrderAmended/schema.avro → ...rsService/events/OrderAmended/schema.avro b/...ult/events/Order/OrderAmended/schema.avro → ...rsService/events/OrderAmended/schema.avro
diff --git a/...ult/events/Order/OrderAmended/schema.json → ...rsService/events/OrderAmended/schema.json b/...ult/events/Order/OrderAmended/schema.json → ...rsService/events/OrderAmended/schema.json
diff --git a/...ault/events/Order/OrderCancelled/index.md → ...ersService/events/OrderCancelled/index.md b/...ault/events/Order/OrderCancelled/index.md → ...ersService/events/OrderCancelled/index.md
diff --git a/...t/events/Order/OrderCancelled/schema.json → ...Service/events/OrderCancelled/schema.json b/...t/events/Order/OrderCancelled/schema.json → ...Service/events/OrderCancelled/schema.json
diff --git a/...ault/events/Order/OrderConfirmed/index.md → ...ersService/events/OrderConfirmed/index.md b/...ault/events/Order/OrderConfirmed/index.md → ...ersService/events/OrderConfirmed/index.md
diff --git a/...t/events/Order/OrderConfirmed/schema.json → ...Service/events/OrderConfirmed/schema.json b/...t/events/Order/OrderConfirmed/schema.json → ...Service/events/OrderConfirmed/schema.json
diff --git a/...s/default/services/OrdersService/index.md → ...ns/Orders/services/OrdersService/index.md b/...s/default/services/OrdersService/index.md → ...ns/Orders/services/OrdersService/index.md
diff --git a/...efault/services/OrdersService/openapi.yml → ...Orders/services/OrdersService/openapi.yml b/...efault/services/OrdersService/openapi.yml → ...Orders/services/OrdersService/openapi.yml
diff --git a/...OrdersService/order-service-asyncapi.yaml → ...OrdersService/order-service-asyncapi.yaml b/...OrdersService/order-service-asyncapi.yaml → ...OrdersService/order-service-asyncapi.yaml
diff --git a/...rdersService/versioned/0.0.2/changelog.md → ...rdersService/versioned/0.0.2/changelog.md b/...rdersService/versioned/0.0.2/changelog.md → ...rdersService/versioned/0.0.2/changelog.md
diff --git a/...es/OrdersService/versioned/0.0.2/index.md → ...es/OrdersService/versioned/0.0.2/index.md b/...es/OrdersService/versioned/0.0.2/index.md → ...es/OrdersService/versioned/0.0.2/index.md
diff --git a/...OrdersService/versioned/0.0.2/openapi.yml → ...OrdersService/versioned/0.0.2/openapi.yml b/...OrdersService/versioned/0.0.2/openapi.yml → ...OrdersService/versioned/0.0.2/openapi.yml
diff --git a/...rsioned/0.0.2/order-service-asyncapi.yaml → ...rsioned/0.0.2/order-service-asyncapi.yaml b/...rsioned/0.0.2/order-service-asyncapi.yaml → ...rsioned/0.0.2/order-service-asyncapi.yaml
diff --git a/...t/flows/Payment/PaymentProcessed/index.md → ...s/Payment/flows/PaymentProcessed/index.md b/...t/flows/Payment/PaymentProcessed/index.md → ...s/Payment/flows/PaymentProcessed/index.md
diff --git a/examples/default/domains/Payment/index.md b/examples/default/domains/Payment/index.md
@@ -0,0 +1,24 @@
+---
+id: Payment
+name: Payment
+version: 0.0.1
+summary: |
+  Domain that contains payment related services and messages.
+owners:
+    - dboyne
+services:
+    - id: PaymentService
+      version: 0.0.1
+badges:
+    - content: Payment Domain
+      backgroundColor: blue
+      textColor: blue
+---
+
+## Overview
+
+The Payment Domain encompasses all services and components related to handling financial transactions within the system. It is responsible for managing payments, transactions, billing, and financial records. The domain ensures secure, reliable, and efficient processing of all payment-related activities
+
+## Bounded context
+
+<NodeGraph />
diff --git a/.../events/Payment/PaymentInitiated/index.md → ...tService/events/PaymentInitiated/index.md b/.../events/Payment/PaymentInitiated/index.md → ...tService/events/PaymentInitiated/index.md
diff --git a/.../events/Payment/PaymentProcessed/index.md → ...tService/events/PaymentProcessed/index.md b/.../events/Payment/PaymentProcessed/index.md → ...tService/events/PaymentProcessed/index.md
diff --git a/...PaymentProcessed/versioned/0.0.1/index.md → ...PaymentProcessed/versioned/0.0.1/index.md b/...PaymentProcessed/versioned/0.0.1/index.md → ...PaymentProcessed/versioned/0.0.1/index.md
diff --git a/examples/default/domains/Payment/services/PaymentService/index.md b/examples/default/domains/Payment/services/PaymentService/index.md
@@ -0,0 +1,31 @@
+---
+id: PaymentService
+name: Payment Service
+version: 0.0.1
+summary: |
+  Service that handles payments
+owners:
+    - dboyne
+receives:
+  - id: PaymentInitiated
+    version: 0.0.1
+sends:
+  - id: PaymentProcessed
+    version: 0.0.1
+repository:
+  language: JavaScript
+  url: https://github.com/boyney123/pretend-shipping-service
+---
+
+The Payment Service is a crucial component of our system that handles all payment-related operations. It processes payments, manages transactions, and communicates with other services through events. Using an event-driven architecture, it ensures that all actions are asynchronous, decoupled, and scalable.
+
+<NodeGraph />
+
+### Key Components
+- Payment API: Exposes endpoints for initiating payments and querying payment status.
+- Payment Processor: Handles the core payment processing logic.
+- Event Bus: Manages the communication between services using events.
+- Payment Gateway: Interfaces with external payment providers.
+- Transaction Service: Manages transaction records and states.
+- Notification Service: Sends notifications related to payment status changes.
+- Database: Stores transaction data and payment status.
diff --git a/...Subscriptions/CancelSubscription/index.md → ...iptions/flows/CancelSubscription/index.md b/...Subscriptions/CancelSubscription/index.md → ...iptions/flows/CancelSubscription/index.md
diff --git a/...ncelSubscription/versioned/0.0.1/index.md → ...ncelSubscription/versioned/0.0.1/index.md b/...ncelSubscription/versioned/0.0.1/index.md → ...ncelSubscription/versioned/0.0.1/index.md
diff --git a/examples/default/domains/Subscriptions/index.md b/examples/default/domains/Subscriptions/index.md
@@ -0,0 +1,24 @@
+---
+id: Subscription
+name: Subscription
+version: 0.0.1
+summary: |
+  Domain that contains subscription related services and messages.
+owners:
+    - dboyne
+services:
+    - id: SubscriptionService
+      version: 0.0.1
+badges:
+    - content: Payment Domain
+      backgroundColor: blue
+      textColor: blue
+---
+
+## Overview
+
+The Payment Domain encompasses all services and components related to handling financial transactions within the system. It is responsible for managing payments, transactions, billing, and financial records. The domain ensures secure, reliable, and efficient processing of all payment-related activities
+
+## Bounded context
+
+<NodeGraph />
diff --git a/...vice/commands/CancelSubscription/index.md → ...vice/commands/CancelSubscription/index.md b/...vice/commands/CancelSubscription/index.md → ...vice/commands/CancelSubscription/index.md
diff --git a/...onService/commands/SubscribeUser/index.md → ...onService/commands/SubscribeUser/index.md b/...onService/commands/SubscribeUser/index.md → ...onService/commands/SubscribeUser/index.md
diff --git a/...events/UserSubscriptionCancelled/index.md → ...events/UserSubscriptionCancelled/index.md b/...events/UserSubscriptionCancelled/index.md → ...events/UserSubscriptionCancelled/index.md
diff --git a/...e/events/UserSubscriptionStarted/index.md → ...e/events/UserSubscriptionStarted/index.md b/...e/events/UserSubscriptionStarted/index.md → ...e/events/UserSubscriptionStarted/index.md
diff --git a/...ult/services/SubscriptionService/index.md → ...ons/services/SubscriptionService/index.md b/...ult/services/SubscriptionService/index.md → ...ons/services/SubscriptionService/index.md
@@ -9,8 +9,12 @@ owners:
 receives:
   - id: SubscribeUser
     version: 0.0.1
+  - id: CancelSubscription
+    version: 0.0.1
 sends:
-  - id: UserSubscriptionStarted  
+  - id: UserSubscriptionStarted
+    version: 0.0.1
+  - id: UserSubscriptionCancelled  
     version: 0.0.1
 repository:
   language: JavaScript

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.8.11",
+  "version": "2.9.1",
   "publishConfig": {
     "access": "public"
   },
@@ -79,7 +79,8 @@
     "tailwindcss": "3.4.3",
     "typescript": "5.4.5",
     "unist-util-visit": "5.0.0",
-    "uuid": "10.0.0"
+    "uuid": "10.0.0",
+    "rimraf": "5.0.7"
   },
   "devDependencies": {
     "@changesets/cli": "2.27.5",
@@ -88,7 +89,6 @@
     "@types/react-dom": "18.3.0",
     "prettier": "3.3.3",
     "prettier-plugin-astro": "0.14.1",
-    "rimraf": "5.0.7",
     "tsup": "8.1.0",
     "vite-tsconfig-paths": "4.3.2",
     "vitest": "2.0.5"