@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/changelog.mdx

@@ -1,67 +0,0 @@
----
-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/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-stock-increase.json:
-  name: Stock Increase
-  summary: Inventory increased after receiving a supplier delivery of 200 units at the east warehouse.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @stock-increase.json
-
-stock-decrease.json:
-  name: Stock Decrease
-  summary: Inventory decreased by 3 units due to damaged goods identified during warehouse inspection.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @stock-decrease.json

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/stock-decrease.json

@@ -1,23 +0,0 @@
-{
-  "eventId": "evt_8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d",
-  "eventType": "InventoryAdjusted",
-  "timestamp": "2025-11-17T14:22:09.587Z",
-  "adjustmentId": "adj_40355",
-  "productId": "prod_4102",
-  "productName": "Limited Edition Sneakers",
-  "sku": "LES-42-WHT",
-  "warehouseId": "wh_west_02",
-  "adjustmentType": "DECREASE",
-  "reason": "DAMAGED_GOODS",
-  "previousQuantity": 15,
-  "adjustedQuantity": 3,
-  "newQuantity": 12,
-  "unitCost": 85.0,
-  "currency": "USD",
-  "metadata": {
-    "source": "warehouse-system",
-    "correlationId": "corr_fedcba98-7654-3210-fedc-ba9876543210",
-    "inspectionReportId": "insp_71882",
-    "adjustedBy": "usr_wh_2011"
-  }
-}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/stock-increase.json

@@ -1,23 +0,0 @@
-{
-  "eventId": "evt_3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
-  "eventType": "InventoryAdjusted",
-  "timestamp": "2025-11-17T07:45:22.310Z",
-  "adjustmentId": "adj_40291",
-  "productId": "prod_1129",
-  "productName": "Wireless Bluetooth Headphones",
-  "sku": "WBH-400-BLK",
-  "warehouseId": "wh_east_01",
-  "adjustmentType": "INCREASE",
-  "reason": "SUPPLIER_DELIVERY",
-  "previousQuantity": 42,
-  "adjustedQuantity": 200,
-  "newQuantity": 242,
-  "unitCost": 22.5,
-  "currency": "USD",
-  "metadata": {
-    "source": "warehouse-system",
-    "correlationId": "corr_12345678-abcd-ef01-2345-6789abcdef01",
-    "purchaseOrderId": "po_20251117_003",
-    "receivedBy": "usr_wh_1044"
-  }
-}

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

@@ -1,124 +0,0 @@
----
-id: InventoryAdjusted
-name: Inventory adjusted
-version: 1.0.1
-summary: |
-  Indicates a change in inventory level
-owners:
-  - 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
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The `Inventory Adjusted` event is triggered whenever there is a change in the inventory levels of a product. This could occur due to various reasons such as receiving new stock, sales, returns, or manual adjustments by the inventory management team. The event ensures that all parts of the system that rely on inventory data are kept up-to-date with the latest inventory levels.
-
-<Tiles>
-  <Tile
-    icon="UserGroupIcon"
-    href="/docs/teams/full-stack"
-    title="Contact the team"
-    description="Any questions? Feel free to contact the owners"
-  />
-  <Tile
-    icon="DocumentIcon"
-    href={`/generated/events/Inventory/${frontmatter.id}/schema.avro`}
-    title="View the schema"
-    description="View the schema directly in your browser"
-  />
-</Tiles>
-
-## Architecture diagram
-
-<NodeGraph />
-
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
-
-## Payload example
-
-Event example you my see being published.
-
-```json title="Payload example"
-{
-  "Name": "John Doe",
-  "Age": 30,
-  "Department": "Engineering",
-  "Position": "Software Engineer",
-  "Salary": 85000.5,
-  "JoinDate": "2024-01-15"
-}
-```
-
-## Schema (avro)
-
-<Schema file="schema.avro" title="Inventory Adjusted Schema (avro)" />
-
-## Producing the Event
-
-To produce an Inventory Adjusted event, use the following example Kafka producer configuration in Python:
-
-```python title="Produce event in Python" frame="terminal"
-from kafka import KafkaProducer
-import json
-from datetime import datetime
-
-# Kafka configuration
-producer = KafkaProducer(
-    bootstrap_servers=['localhost:9092'],
-    value_serializer=lambda v: json.dumps(v).encode('utf-8')
-)
-
-# Event data
-event_data = {
-  "event_id": "abc123",
-  "timestamp": datetime.utcnow().isoformat() + 'Z',
-  "product_id": "prod987",
-  "adjusted_quantity": 10,
-  "new_quantity": 150,
-  "adjustment_reason": "restock",
-  "adjusted_by": "user123"
-}
-
-# Send event to Kafka topic
-producer.send('inventory.adjusted', event_data)
-producer.flush()
-```
-
-### Consuming the Event
-
-To consume an Inventory Adjusted event, use the following example Kafka consumer configuration in Python:
-
-```python title="Consuming the event with python" frame="terminal"
-from kafka import KafkaConsumer
-import json
-
-# Kafka configuration
-consumer = KafkaConsumer(
-    'inventory.adjusted',
-    bootstrap_servers=['localhost:9092'],
-    auto_offset_reset='earliest',
-    enable_auto_commit=True,
-    group_id='inventory_group',
-    value_serializer=lambda v: json.dumps(v).encode('utf-8')
-)
-
-# Consume events
-for message in consumer:
-    event_data = json.loads(message.value)
-    print(f"Received Inventory Adjusted event: {event_data}")
-```
-
-<Footer />

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/schema.avro

@@ -1,13 +0,0 @@
-{
-  "type" : "record",
-  "namespace" : "Tutorialspoint",
-  "name" : "Employee",
-  "fields" : [
-     { "name" : "Name", "type" : "string" },
-     { "name" : "Age", "type" : "int" },
-     { "name" : "Department", "type" : "string" },
-     { "name" : "Position", "type" : "string" },
-     { "name" : "Salary", "type" : "double" },
-     { "name" : "JoinDate", "type" : "string", "logicalType": "date" }
-  ]
-}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/schema.json

@@ -1,35 +0,0 @@
-{
-  "$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"
-    }
-  },
-  "required": ["Name", "Age", "Department", "Position", "Salary", "JoinDate"]
-}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/changelog.mdx

@@ -1,26 +0,0 @@
----
-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/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/index.mdx

@@ -1,23 +0,0 @@
----
-id: InventoryAdjusted
-name: Inventory adjusted
-version: 0.0.1
-schemaPath: schema.json
-summary: |
-  Indicates a change in inventory level
-owners:
-  - dboyne
-badges:
-  - content: Recently updated!
-    backgroundColor: green
-    textColor: green
----
-
-<Admonition>
-  When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you
-  read and follow it.
-</Admonition>
-
-### Details
-
-<NodeGraph />

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/schema.avro

@@ -1,9 +0,0 @@
-{
-  "type" : "record",
-  "namespace" : "Tutorialspoint",
-  "name" : "Employee",
-  "fields" : [
-     { "name" : "Name" , "type" : "string" },
-     { "name" : "Age" , "type" : "int" }
-  ]
-}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/schema.json

@@ -1,36 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "event_id": {
-      "type": "string",
-      "description": "Unique identifier for the event"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "Timestamp of the inventory adjustment"
-    },
-    "product_id": {
-      "type": "string",
-      "description": "Identifier of the adjusted product"
-    },
-    "adjusted_quantity": {
-      "type": "integer",
-      "description": "The quantity adjusted (positive or negative)"
-    },
-    "new_quantity": {
-      "type": "integer",
-      "description": "The new total inventory quantity"
-    },
-    "adjustment_reason": {
-      "type": "string",
-      "description": "Reason for the adjustment"
-    },
-    "adjusted_by": {
-      "type": "string",
-      "description": "Identifier of the user who made the adjustment"
-    }
-  },
-  "required": ["event_id", "timestamp", "product_id", "adjusted_quantity", "new_quantity"]
-}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/changelog.mdx

@@ -1,26 +0,0 @@
----
-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/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/index.mdx

@@ -1,108 +0,0 @@
----
-id: InventoryAdjusted
-name: Inventory adjusted
-version: 1.0.0
-schemaPath: schema.json
-summary: |
-  Indicates a change in inventory level
-owners:
-  - dboyne
-  - msmith
-  - asmith
-  - full-stack
-  - mobile-devs
-badges:
-  - content: Recently updated!
-    backgroundColor: green
-    textColor: green
-  - content: Channel:Apache Kafka
-    backgroundColor: yellow
-    textColor: yellow
----
-
-## Overview
-
-The `Inventory Adjusted` event is triggered whenever there is a change in the inventory levels of a product. This could occur due to various reasons such as receiving new stock, sales, returns, or manual adjustments by the inventory management team. The event ensures that all parts of the system that rely on inventory data are kept up-to-date with the latest inventory levels.
-
-<NodeGraph />
-
-## Event Details
-
-### Event Name
-
-`inventory.adjusted`
-
-### Description
-
-This event indicates that the inventory count for one or more products has been adjusted. The event carries the updated inventory details including the product ID, the new quantity, and the reason for the adjustment.
-
-### Payload
-
-The payload of the `Inventory Adjusted` event includes the following fields:
-
-```json title="Example of payload" frame="terminal"
-{
-  "event_id": "string",
-  "timestamp": "ISO 8601 date-time",
-  "product_id": "string",
-  "adjusted_quantity": "integer",
-  "new_quantity": "integer",
-  "adjustment_reason": "string",
-  "adjusted_by": "string"
-}
-```
-
-### Producing the Event
-
-To produce an Inventory Adjusted event, use the following example Kafka producer configuration in Python:
-
-```python title="Produce event in Python" frame="terminal"
-from kafka import KafkaProducer
-import json
-from datetime import datetime
-
-# Kafka configuration
-producer = KafkaProducer(
-    bootstrap_servers=['localhost:9092'],
-    value_serializer=lambda v: json.dumps(v).encode('utf-8')
-)
-
-# Event data
-event_data = {
-  "event_id": "abc123",
-  "timestamp": datetime.utcnow().isoformat() + 'Z',
-  "product_id": "prod987",
-  "adjusted_quantity": 10,
-  "new_quantity": 150,
-  "adjustment_reason": "restock",
-  "adjusted_by": "user123"
-}
-
-# Send event to Kafka topic
-producer.send('inventory.adjusted', event_data)
-producer.flush()
-```
-
-### Consuming the Event
-
-To consume an Inventory Adjusted event, use the following example Kafka consumer configuration in Python:
-
-```python title="Consuming the event with python" frame="terminal"
-from kafka import KafkaConsumer
-import json
-
-# Kafka configuration
-consumer = KafkaConsumer(
-    'inventory.adjusted',
-    bootstrap_servers=['localhost:9092'],
-    auto_offset_reset='earliest',
-    enable_auto_commit=True,
-    group_id='inventory_group',
-    value_serializer=lambda v: json.dumps(v).encode('utf-8')
-)
-
-# Consume events
-for message in consumer:
-    event_data = json.loads(message.value)
-    print(f"Received Inventory Adjusted event: {event_data}")
-```

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/schema.avro

@@ -1,10 +0,0 @@
-{
-  "type" : "record",
-  "namespace" : "Tutorialspoint",
-  "name" : "Employee",
-  "fields" : [
-     { "name" : "Name" , "type" : "string" },
-     { "name" : "Age" , "type" : "int" },
-     { "name" : "Town" , "type" : "string" },
-  ]
-}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/schema.json

@@ -1,36 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "event_id": {
-      "type": "string",
-      "description": "Unique identifier for the event"
-    },
-    "timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "description": "Timestamp of the inventory adjustment"
-    },
-    "product_id": {
-      "type": "string",
-      "description": "Identifier of the adjusted product"
-    },
-    "adjusted_quantity": {
-      "type": "integer",
-      "description": "The quantity adjusted (positive or negative)"
-    },
-    "new_quantity": {
-      "type": "integer",
-      "description": "The new total inventory quantity"
-    },
-    "adjustment_reason": {
-      "type": "string",
-      "description": "Reason for the adjustment"
-    },
-    "adjusted_by": {
-      "type": "string",
-      "description": "Identifier of the user who made the adjustment"
-    }
-  },
-  "required": ["event_id", "timestamp", "product_id", "adjusted_quantity", "new_quantity"]
-}

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/examples/examples.config.yaml

@@ -1,7 +0,0 @@
-product-depleted.json:
-  name: Product Depleted
-  summary: A product reached zero stock after fulfilling an order, with 3 pending orders still affected.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @product-depleted.json

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/examples/product-depleted.json

@@ -1,19 +0,0 @@
-{
-  "eventId": "evt_4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
-  "eventType": "OutOfStock",
-  "timestamp": "2025-11-18T10:05:38.922Z",
-  "productId": "prod_4102",
-  "productName": "Limited Edition Sneakers",
-  "sku": "LES-42-WHT",
-  "warehouseId": "wh_west_02",
-  "previousQuantity": 1,
-  "currentQuantity": 0,
-  "lastSoldOrderId": "ord_86701",
-  "restockEstimate": null,
-  "affectedPendingOrders": 3,
-  "metadata": {
-    "source": "inventory-system",
-    "correlationId": "corr_aabbccdd-eeff-0011-2233-445566778899",
-    "triggeredBy": "order_fulfillment"
-  }
-}