npm - @eventcatalog/create-eventcatalog - Versions diffs - 3.0.13 → 3.1.2 - Mend

@eventcatalog/create-eventcatalog 3.0.13 → 3.1.2

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.

Files changed (25) hide show

package/package.json CHANGED Viewed

@@ -1,10 +1,14 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "3.0.13",
+  "version": "3.1.2",
   "bin": {
     "create-catalog": "./dist/index.js"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/event-catalog/create-eventcatalog.git"
+  },
   "files": [
     "dist",
     "templates"
@@ -12,14 +16,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "prepublishOnly": "npm run build",
-    "build": "tsup index.ts --format cjs --dts",
-    "run": "node dist/index.js",
-    "dev": "npm run build --watch",
-    "changeset": "changeset",
-    "release": "changeset publish"
-  },
   "devDependencies": {
     "@types/async-retry": "1.4.2",
     "@types/ci-info": "2.0.0",
@@ -33,7 +29,6 @@
     "@vercel/ncc": "0.34.0",
     "async-retry": "1.3.1",
     "chalk": "2.4.2",
-    "ci-info": "watson/ci-info#f43f6a1cefff47fb361c88cf4b943fdbcaafe540",
     "commander": "2.20.0",
     "cpy": "^11.0.0",
     "cross-spawn": "6.0.5",
@@ -51,5 +46,12 @@
     "@changesets/cli": "^2.27.6",
     "axios": "^1.7.7",
     "uuid": "^10.0.0"
+  },
+  "scripts": {
+    "build": "tsup index.ts --format cjs --dts",
+    "run": "node dist/index.js",
+    "dev": "npm run build --watch",
+    "changeset": "changeset",
+    "release": "changeset publish"
   }
-}
+}

package/templates/default/channels/orders.{env}.events/index.mdx CHANGED Viewed

@@ -9,7 +9,8 @@ owners:
 address: orders.{env}.events
 protocols:
   - kafka
+routes:
+  - id: inventory-queue
 parameters:
   env:
     enum:

package/templates/default/domains/Orders/services/InventoryService/channels/inventory-dlq/index.mdx ADDED Viewed

@@ -0,0 +1,13 @@
+---
+id: inventory-dlq
+name: Inventory DLQ
+version: 0.0.1
+summary: |
+  Dead Letter Queue for inventory events
+owners:
+  - dboyne
+---
+## Overview
+The Inventory DLQ is a dead letter queue for inventory events. It is used to store inventory events that are not yet processed.

package/templates/default/domains/Orders/services/InventoryService/channels/inventory-queue/index.mdx ADDED Viewed

@@ -0,0 +1,13 @@
+---
+id: inventory-queue
+name: Inventory Queue
+version: 0.0.1
+summary: |
+  Queue for inventory events
+owners:
+  - dboyne
+---
+## Overview
+The Inventory Queue is a queue for inventory events. It is used to store inventory events that are not yet processed.

package/templates/default/domains/Orders/services/InventoryService/commands/AddInventory/index.mdx CHANGED Viewed

@@ -5,20 +5,16 @@ version: 0.0.3
 summary: |
   Command that will add item to a given inventory id
 owners:
-    - dboyne
-    - msmith
-    - asmith
-    - full-stack
-    - mobile-devs
+  - dboyne
+  - msmith
+  - asmith
+  - full-stack
+  - mobile-devs
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
-channels:
-  - id: inventory.{env}.events
-    parameters:
-      env: staging
-schemaPath: 'schema.json'
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
+schemaPath: schema.json
 ---
 import Footer from '@catalog/components/footer.astro';

package/templates/default/domains/Orders/services/InventoryService/commands/UpdateInventory/index.mdx CHANGED Viewed

@@ -5,20 +5,16 @@ version: 0.0.3
 summary: |
   Command that will update a given inventory item
 owners:
-    - dboyne
-    - msmith
-    - asmith
-    - full-stack
-    - mobile-devs
+  - dboyne
+  - msmith
+  - asmith
+  - full-stack
+  - mobile-devs
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
-channels:
-  - id: inventory.{env}.events
-    parameters:
-      env: staging
-schemaPath: "schema.json"
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
+schemaPath: schema.json
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -48,4 +44,4 @@ The UpdateInventory command is issued to update the existing stock levels of a p
 <Schema file="schema.json"/>
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/index.mdx CHANGED Viewed

@@ -5,21 +5,19 @@ version: 1.0.1
 summary: |
   Indicates a change in inventory level
 owners:
-    - dboyne
-    - msmith
-    - asmith
-    - full-stack
-    - mobile-devs
-channels:
-  - id: inventory.{env}.events
+  - dboyne
+  - msmith
+  - asmith
+  - full-stack
+  - mobile-devs
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
-    - content: Channel:Apache Kafka
-      backgroundColor: yellow
-      textColor: yellow
-schemaPath: 'schema.avro'
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
+  - content: 'Channel:Apache Kafka'
+    backgroundColor: yellow
+    textColor: yellow
+schemaPath: schema.avro
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -113,4 +111,4 @@ for message in consumer:
     print(f"Received Inventory Adjusted event: {event_data}")
 ```
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/index.mdx CHANGED Viewed

@@ -5,20 +5,18 @@ version: 0.0.4
 summary: |
   Indicates inventory is out of stock
 owners:
-    - dboyne
-    - msmith
-    - asmith
-    - full-stack
-    - mobile-devs
-channels:
-  - id: inventory.{env}.events
+  - dboyne
+  - msmith
+  - asmith
+  - full-stack
+  - mobile-devs
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
-    - content: Channel:Apache Kafka
-      backgroundColor: yellow
-      textColor: yellow
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
+  - content: 'Channel:Apache Kafka'
+    backgroundColor: yellow
+    textColor: yellow
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -99,4 +97,4 @@ for message in consumer:
     print(f"Received Inventory Adjusted event: {event_data}")
 ```
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/InventoryService/index.mdx CHANGED Viewed

@@ -5,29 +5,42 @@ name: Inventory Service
 summary: |
   Service that handles the inventory
 owners:
-    - dboyne
-    - full-stack
-    - mobile-devs
+  - dboyne
+  - full-stack
+  - mobile-devs
 receives:
   - id: OrderConfirmed
     version: 0.0.1
-  - id: GetInventoryList
-    version: 0.0.1
+    from:
+      - id: inventory-queue
   - id: OrderAmended
+    from:
+      - id: inventory-queue
   - id: UpdateInventory
     version: 0.0.3
+    from:
+      - id: 'inventory.{env}.events'
+        parameters:
+          env: staging
   - id: AddInventory
+    from:
+      - id: 'inventory.{env}.events'
+        parameters:
+          env: staging
   - id: GetInventoryStatus
+  - id: GetInventoryList
 sends:
   - id: InventoryAdjusted
     version: 0.0.4
+    to:
+      - id: 'inventory.{env}.events'
   - id: OutOfStock
     version: 0.0.3
-  - id: GetOrder
-    version: 0.0.1
+    to:
+      - id: 'inventory.{env}.events'
 repository:
   language: JavaScript
-  url: https://github.com/event-catalog/pretend-shipping-service
+  url: 'https://github.com/event-catalog/pretend-shipping-service'
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -85,4 +98,4 @@ The Inventory Service is a critical component of the system responsible for mana
   </Step>
 </Steps>
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/InventoryService/versioned/0.0.1/index.mdx CHANGED Viewed

@@ -5,26 +5,42 @@ name: Inventory Service
 summary: |
   Service that handles the inventory
 owners:
-    - dboyne
-    - full-stack
-    - mobile-devs
+  - dboyne
+  - full-stack
+  - mobile-devs
 receives:
   - id: OrderConfirmed
     version: 0.0.1
+    from:
+      - id: 'orders.{env}.events'
   - id: OrderCancelled
     version: 0.0.1
+    from:
+      - id: 'orders.{env}.events'
   - id: OrderAmended
     version: 0.0.1
+    from:
+      - id: 'orders.{env}.events'
+        parameters:
+          env: staging
   - id: UpdateInventory
     version: 0.0.3
+    from:
+      - id: 'inventory.{env}.events'
+        parameters:
+          env: staging
 sends:
   - id: InventoryAdjusted
     version: 0.0.4
+    to:
+      - id: 'inventory.{env}.events'
   - id: OutOfStock
     version: 0.0.3
+    to:
+      - id: 'inventory.{env}.events'
 repository:
   language: JavaScript
-  url: https://github.com/event-catalog/pretend-shipping-service
+  url: 'https://github.com/event-catalog/pretend-shipping-service'
 ---
 ## Overview
@@ -33,4 +49,4 @@ The Inventory Service is a critical component of the system responsible for mana
 ## Architecture diagram
-<NodeGraph title="Hello world" />
+<NodeGraph title="Hello world" />

package/templates/default/domains/Orders/services/NotificationService/index.mdx CHANGED Viewed

@@ -5,24 +5,28 @@ name: Notifications
 summary: |
   Service that handles orders
 owners:
-    - dboyne
+  - dboyne
 receives:
   - id: InventoryAdjusted
-    version: ">1.0.0"
+    version: '>1.0.0'
+    from:
+      - id: 'inventory.{env}.events'
   - id: PaymentProcessed
     version: ^1.0.0
-  - id: GetUserNotifications
-    version: x
+    from:
+      - id: 'payments.{env}.events'
+        parameters:
+          env: staging
   - id: GetNotificationDetails
-    version: x
+  - id: GetUserNotifications
 sends:
   - id: OutOfStock
     version: latest
-  - id: GetInventoryList
-    version: 0.0.x
+    to:
+      - id: 'inventory.{env}.events'
 repository:
   language: JavaScript
-  url: https://github.com/event-catalog/pretend-shipping-service
+  url: 'https://github.com/event-catalog/pretend-shipping-service'
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -56,4 +60,4 @@ The Notification Service is responsible for managing and delivering notification
   </Accordion>
 </AccordionGroup>
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/index.mdx CHANGED Viewed

@@ -5,20 +5,16 @@ version: 0.0.1
 summary: |
   Indicates an order has been changed
 owners:
-    - dboyne
-    - msmith
+  - dboyne
+  - msmith
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
-    - content: Channel:Apache Kafka
-      backgroundColor: yellow
-      textColor: yellow
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
+  - content: 'Channel:Apache Kafka'
+    backgroundColor: yellow
+    textColor: yellow
 schemaPath: schema.avro
-channels:
-  - id: orders.{env}.events
-    parameters:
-      env: staging
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -59,4 +55,4 @@ The OrderAmended event is triggered whenever an existing order is modified. This
 <Schema file="schema.json" />
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/index.mdx CHANGED Viewed

@@ -5,18 +5,16 @@ version: 0.0.1
 summary: |
   Indicates an order has been canceled
 owners:
-    - dboyne
-    - msmith
+  - dboyne
+  - msmith
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
-    - content: Channel:Apache Kafka
-      backgroundColor: yellow
-      textColor: yellow
-schemaPath: 'schema.json'
-channels:
-  - id: orders.{env}.events
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
+  - content: 'Channel:Apache Kafka'
+    backgroundColor: yellow
+    textColor: yellow
+schemaPath: schema.json
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -54,4 +52,4 @@ JSON schema for the event.
 <Schema title="JSON Schema" file="schema.json"/>
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/index.mdx CHANGED Viewed

@@ -5,18 +5,16 @@ version: 0.0.1
 summary: |
   Indicates an order has been confirmed
 owners:
-    - dboyne
-    - msmith
+  - dboyne
+  - msmith
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
-    - content: Channel:Apache Kafka
-      backgroundColor: yellow
-      textColor: yellow
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
+  - content: 'Channel:Apache Kafka'
+    backgroundColor: yellow
+    textColor: yellow
 schemaPath: schema.json
-channels:
-  - id: orders.{env}.events
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -54,4 +52,4 @@ The OrderConfirmed event is triggered when an order has been successfully confir
 <Schema file="schema.json"/>
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/OrdersService/index.mdx CHANGED Viewed

@@ -5,21 +5,37 @@ name: Orders Service
 summary: |
   Service that handles orders
 owners:
-    - dboyne
+  - dboyne
 receives:
   - id: InventoryAdjusted
     version: 0.0.3
+    from:
+      - id: 'inventory.{env}.events'
+  - id: CreateReturnLabel
+  - id: PlaceOrder
   - id: GetOrder
 sends:
   - id: OrderAmended
+    to:
+      - id: 'orders.{env}.events'
+        parameters:
+          env: staging
   - id: OrderCancelled
+    to:
+      - id: 'orders.{env}.events'
   - id: OrderConfirmed
-  - id: AddInventory
+    to:
+      - id: 'orders.{env}.events'
+  - id: AddInventory
     version: 0.0.3
+    to:
+      - id: 'inventory.{env}.events'
+        parameters:
+          env: staging
 repository:
   language: JavaScript
-  url: https://github.com/event-catalog/pretend-shipping-service
-schemaPath: "openapi.yml"
+  url: 'https://github.com/event-catalog/pretend-shipping-service'
+schemaPath: openapi.yml
 specifications:
   asyncapiPath: order-service-asyncapi.yaml
   openapiPath: openapi.yml
@@ -42,4 +58,4 @@ The Orders Service is responsible for managing customer orders within the system
 <NodeGraph />
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/index.mdx CHANGED Viewed

@@ -5,17 +5,23 @@ name: Orders Service
 summary: |
   Service that handles orders
 owners:
-    - dboyne
+  - dboyne
 receives:
   - id: InventoryAdjusted
     version: 0.0.3
+    from:
+      - id: 'inventory.{env}.events'
 sends:
-  - id: AddInventory
+  - id: AddInventory
     version: 0.0.3
+    to:
+      - id: 'inventory.{env}.events'
+        parameters:
+          env: staging
 repository:
   language: JavaScript
-  url: https://github.com/event-catalog/pretend-shipping-service
-schemaPath: "openapi.yml"
+  url: 'https://github.com/event-catalog/pretend-shipping-service'
+schemaPath: openapi.yml
 specifications:
   asyncapiPath: order-service-asyncapi.yaml
   openapiPath: openapi.yml
@@ -31,4 +37,4 @@ The Orders Service is responsible for managing customer orders within the system
 <NodeGraph />
-<Footer />
+<Footer />

package/templates/default/domains/Orders/services/ShippingService/index.mdx CHANGED Viewed

@@ -5,13 +5,16 @@ name: Shipping Service
 summary: |
   Service that handles shipping
 owners:
-    - dboyne
+  - dboyne
 receives:
+  - id: PaymentProcessed
+    from:
+      - id: 'payments.{env}.events'
+        parameters:
+          env: staging
   - id: CancelShipment
-  - id: CreateReturnLabel
   - id: CreateShipment
   - id: UpdateShipmentStatus
-  - id: PaymentProcessed
 sends:
   - id: ShipmentCreated
   - id: ReturnInitiated
@@ -21,7 +24,7 @@ sends:
   - id: DeliveryFailed
 repository:
   language: JavaScript
-  url: https://github.com/event-catalog/pretend-shipping-service
+  url: 'https://github.com/event-catalog/pretend-shipping-service'
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -46,4 +49,4 @@ The Shipping Service is responsible for managing shipping within the system. It
 <MessageTable format="all" limit={4} />
-<Footer />
+<Footer />

package/templates/default/domains/Payment/services/FraudDetectionService/index.mdx CHANGED Viewed

@@ -4,14 +4,20 @@ version: 0.0.1
 name: Fraud Detection Service
 summary: Analyzes payment transactions for fraudulent activity and risk assessment
 repository:
-  url: https://github.com/eventcatalog/fraud-detection-service
+  url: 'https://github.com/eventcatalog/fraud-detection-service'
 receives:
   - id: PaymentInitiated
     version: 0.0.1
+    from:
+      - id: 'payments.{env}.events'
+        parameters:
+          env: staging
   - id: PaymentProcessed
     version: 0.0.1
-  - id: SubscriptionPaymentDue
-    version: 0.0.1
+    from:
+      - id: 'payments.{env}.events'
+        parameters:
+          env: staging
 sends:
   - id: FraudCheckCompleted
     version: 0.0.1
@@ -56,4 +62,4 @@ fraud_detection:
   ml_model_version: "2.3.1"
 ```
-<Footer />
+<Footer />

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/index.mdx CHANGED Viewed

@@ -4,11 +4,7 @@ name: Payment Initiated
 version: 0.0.1
 summary: Event is triggered when a user initiates a payment through the Payment Service
 owners:
-    - dboyne
-channels:
-  - id: payments.{env}.events
-    parameters:
-      env: staging
+  - dboyne
 ---
 import Footer from '@catalog/components/footer.astro';
@@ -37,4 +33,4 @@ The Payment Initiated event is triggered when a user initiates a payment through
 - **Data Validation**: Validate all input data to prevent injection attacks or other malicious input.
 - **Sensitive Data Handling**: Avoid including sensitive information (e.g., credit card numbers) in the event payload. Use secure channels and encryption for such data.
-<Footer />
+<Footer />