@eventcatalog/create-eventcatalog 2.0.6 → 2.0.7

package/dist/index.js

@@ -22654,7 +22654,7 @@ function validateNpmName(name) {
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "2.0.6",
+  version: "2.0.7",
   bin: {
     "create-catalog": "./dist/index.js"
   },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "bin": {
     "create-catalog": "./dist/index.js"
   },

package/templates/default/domains/Orders/changelog.md

@@ -0,0 +1,7 @@
+---
+createdAt: 2024-08-01
+---
+
+### Service added to domain
+
+Added the InventoryService to the domain.

package/templates/default/events/Inventory/InventoryAdjusted/changelog.md

@@ -0,0 +1,68 @@
+---
+createdAt: 2024-08-01
+badges:
+    - content: ⭐️ JSON Schema
+      backgroundColor: purple
+      textColor: purple
+---
+
+### Added support for JSON Schema
+
+InventoryAdjusted uses Avro but now also supports JSON Draft 7.
+
+```json title="Employee JSON Draft"
+// labeled-line-markers.jsx
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "Employee",
+  "properties": {
+    "Name": {
+      "type": "string"
+    },
+    "Age": {
+      "type": "integer"
+    },
+    "Town": {
+      "type": "string"
+    }
+  },
+  "required": ["Name", "Age", "Town"]
+}
+
+```
+
+Using it with our Kafka Cluster
+
+## 1. Create a new topic
+
+```sh
+# Create a topic named 'employee_topic'
+kafka-topics.sh --create --topic employee_topic --bootstrap-server localhost:9092 --partitions 1 --replication-factor 1
+```
+
+## Step 2: Prepare the JSON Message
+
+Create a JSON file named `employee.json` with the following content:
+
+```json
+{
+  "Name": "John Doe",
+  "Age": 30,
+  "Town": "Springfield"
+}
+```
+
+## Step 3: Produce the Message to Kafka Topic
+
+Use the Kafka producer CLI to send the JSON message:
+
+```sh
+cat employee.json | kafka-console-producer.sh --topic employee_topic --bootstrap-server localhost:9092
+```
+
+## Step 4: Verify the Message (Optional)
+
+```sh
+kafka-console-consumer.sh --topic employee_topic --from-beginning --bootstrap-server localhost:9092
+```

package/templates/default/events/Inventory/InventoryAdjusted/schema.json

@@ -1,36 +1,17 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Employee",
-    "type": "object",
-    "description": "A record representing an employee",
-    "properties": {
-      "Name": {
-        "type": "string",
-        "description": "The name of the employee"
-      },
-      "Age": {
-        "type": "integer",
-        "description": "The age of the employee"
-      },
-      "Department": {
-        "type": "string",
-        "description": "The department where the employee works"
-      },
-      "Position": {
-        "type": "string",
-        "description": "The position or title of the employee within the department"
-      },
-      "Salary": {
-        "type": "number",
-        "format": "double",
-        "description": "The salary of the employee"
-      },
-      "JoinDate": {
-        "type": "string",
-        "format": "date",
-        "description": "The date when the employee joined the company"
-      }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "Employee",
+  "properties": {
+    "Name": {
+      "type": "string"
     },
-    "required": ["Name", "Age", "Department", "Position", "Salary", "JoinDate"]
-  }
-  
+    "Age": {
+      "type": "integer"
+    },
+    "Town": {
+      "type": "string"
+    }
+  },
+  "required": ["Name", "Age", "Town"]
+}

package/templates/default/events/Inventory/InventoryAdjusted/versioned/0.0.1/changelog.md

@@ -0,0 +1,30 @@
+---
+createdAt: 2024-07-01
+badges:
+    - content: Breaking change
+      backgroundColor: red
+      textColor: red
+---
+
+### Removed fields from schema, added new owners
+
+`Gender` property has been removed from the Schema of the event
+
+Also added the [full stackers](/docs/teams/full-stack) team as owners of this event
+
+```diff lang="json"
+  {
+    "type" : "record",
+    "namespace" : "Tutorialspoint",
+    "name" : "Employee",
+    "fields" : [
+      { "name" : "Name" , "type" : "string" },
+      { "name" : "Age" , "type" : "int" },
+-     { "name" : "Gender" , "type" : "string" },
+    ]
+  }
+```
+
+
+
+

package/templates/default/events/Inventory/InventoryAdjusted/versioned/0.0.3/changelog.md

@@ -0,0 +1,26 @@
+---
+createdAt: 2024-07-11
+badges:
+    - content: New field
+      backgroundColor: green
+      textColor: green
+---
+
+### Added new field to schema
+
+We added the new town property to the schema for downstream consumers. 
+
+```json ins={"New: Added new Town property to schema:":9-10}
+// labeled-line-markers.jsx
+{
+  "type" : "record",
+  "namespace" : "Tutorialspoint",
+  "name" : "Employee",
+  "fields" : [
+     { "name" : "Name" , "type" : "string" },
+     { "name" : "Age" , "type" : "int" },
+
+     { "name" : "Town" , "type" : "string" },
+  ]
+}
+```

package/templates/default/services/InventoryService/0.0.1/index.md

@@ -0,0 +1,36 @@
+---
+id: InventoryService
+version: 0.0.2
+name: Inventory Service
+summary: |
+  Service that handles the inventory
+owners:
+    - dboyne
+    - full-stack
+    - mobile-devs
+receives:
+  - id: OrderConfirmed
+    version: 0.0.1
+  - id: OrderCancelled
+    version: 0.0.1
+  - id: OrderAmended
+    version: 0.0.1
+  - id: UpdateInventory
+    version: 0.0.3
+sends:
+  - id: InventoryAdjusted
+    version: 0.0.4
+  - id: OutOfStock
+    version: 0.0.3
+repository:
+  language: JavaScript
+  url: https://github.com/boyney123/pretend-shipping-service
+---
+
+## Overview
+
+The Inventory Service is a critical component of the system responsible for managing product stock levels, tracking inventory movements, and ensuring product availability. It interacts with other services to maintain accurate inventory records and supports operations such as order fulfillment, restocking, and inventory audits.
+
+## Architecture diagram
+
+<NodeGraph title="Hello world" />

package/templates/default/services/InventoryService/changelog.md

@@ -0,0 +1,7 @@
+---
+createdAt: 2024-08-01
+---
+
+### Service receives additional events
+
+Service now receives [OrderAmended](/docs/events/OrderAmended/0.0.1) and [UpdateInventory](/docs/commands/UpdateInventory/0.0.3) events.