@eventcatalog/create-eventcatalog 2.0.21 → 2.1.0

package/templates/default/{events/Inventory → domains/Orders/services/InventoryService/events}/InventoryAdjusted/index.md

@@ -1,7 +1,7 @@
 ---
 id: InventoryAdjusted
 name: Inventory adjusted
-version: 0.0.4
+version: 1.0.1
 summary: |
   Indicates a change in inventory level
 owners:
@@ -10,6 +10,8 @@ owners:
     - asmith
     - full-stack
     - mobile-devs
+channels:
+  - id: inventory.{env}.events
 badges:
     - content: Recently updated!
       backgroundColor: green
@@ -20,10 +22,17 @@ badges:
 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 />
@@ -32,7 +41,7 @@ The `Inventory Adjusted` event is triggered whenever there is a change in the in
 
 ## Payload example
 
-Event example you may see being published.
+Event example you my see being published.
 
 ```json title="Payload example"
 {
@@ -102,4 +111,6 @@ consumer = KafkaConsumer(
 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.json

@@ -0,0 +1,35 @@
+{
+  "$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/{events/Inventory/InventoryAdjusted/versioned/0.0.3 → domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0}/index.md

@@ -1,7 +1,7 @@
 ---
 id: InventoryAdjusted
 name: Inventory adjusted
-version: 0.0.3
+version: 1.0.0
 summary: |
   Indicates a change in inventory level
 owners:

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

@@ -0,0 +1,10 @@
+{
+  "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/OutOfStock/index.md

@@ -0,0 +1,102 @@
+---
+id: OutOfStock
+name: Inventory out of stock
+version: 0.0.4
+summary: |
+  Indicates inventory is out of stock
+owners:
+    - dboyne
+    - msmith
+    - asmith
+    - full-stack
+    - mobile-devs
+channels:
+  - id: inventory.{env}.events
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+    - content: Channel:Apache Kafka
+      backgroundColor: yellow
+      textColor: yellow
+---
+
+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.
+
+<NodeGraph />
+
+### 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}")
+```
+
+<Footer />

package/templates/default/{events/Inventory/OutOfStock → domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1}/index.md

@@ -1,7 +1,7 @@
 ---
 id: OutOfStock
 name: Inventory out of stock
-version: 0.0.3
+version: 0.0.1
 summary: |
   Indicates inventory is out of stock
 owners:

package/templates/default/{services → domains/Orders/services}/InventoryService/index.md

@@ -11,22 +11,29 @@ owners:
 receives:
   - id: OrderConfirmed
     version: 0.0.1
-  - id: OrderCancelled
+  - id: GetInventoryList
     version: 0.0.1
   - id: OrderAmended
-    version: 0.0.1
   - id: UpdateInventory
     version: 0.0.3
+  - id: AddInventory
+  - id: GetInventoryStatus
 sends:
   - id: InventoryAdjusted
     version: 0.0.4
   - id: OutOfStock
     version: 0.0.3
+  - id: GetOrder
+    version: 0.0.1
 repository:
   language: JavaScript
-  url: https://github.com/boyney123/pretend-shipping-service
+  url: https://github.com/event-catalog/pretend-shipping-service
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
+
+
 ## 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.
@@ -38,6 +45,44 @@ The Inventory Service is a critical component of the system responsible for mana
     <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
 </Tiles>
 
+
 ## Architecture diagram
 
-<NodeGraph title="Hello world" />
+<NodeGraph title="Hello world" />
+
+
+<Steps title="How to connect to Inventory Service">
+  <Step title="Obtain API credentials">
+    Request API credentials from the Inventory Service team.
+  </Step>
+  <Step title="Install the SDK">
+    Run the following command in your project directory:
+    ```bash
+    npm install inventory-service-sdk
+    ```
+  </Step>
+  <Step title="Initialize the client">
+  Use the following code to initialize the Inventory Service client:
+
+  ```js
+  const InventoryService = require('inventory-service-sdk');
+  const client = new InventoryService.Client({
+    clientId: 'YOUR_CLIENT_ID',
+    clientSecret: 'YOUR_CLIENT_SECRET',
+    apiUrl: 'https://api.inventoryservice.com/v1'
+  });
+```
+  </Step>
+  <Step title="Make API calls">
+  
+  You can now use the client to make API calls. For example, to get all products:
+
+  ```js
+  client.getProducts()
+    .then(products => console.log(products))
+    .catch(error => console.error(error));
+  ```
+  </Step>
+</Steps>
+
+<Footer />

package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryList/index.md

@@ -0,0 +1,22 @@
+---
+id: GetInventoryList
+name: List inventory list
+version: 0.0.1
+summary: |
+  GET request that will return inventory list
+owners:
+    - dboyne
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The GetInventoryList message is a query used to retrieve a comprehensive list of all available inventory items within a system. It is designed to return detailed information about each item, such as product names, quantities, availability status, and potentially additional metadata like categories or locations. This query is typically utilized by systems or services that require a real-time view of current stock, ensuring that downstream applications or users have accurate and up-to-date information for decision-making or operational purposes. The GetInventoryList is ideal for use cases such as order processing, stock management, or reporting, providing visibility into the full range of inventory data.
+
+<NodeGraph />

package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryList/schema.json

@@ -0,0 +1,53 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "GetInventoryList",
+    "description": "A query to retrieve a list of all available inventory items with their details.",
+    "type": "object",
+    "properties": {
+      "filters": {
+        "type": "object",
+        "description": "Optional filters to narrow down the inventory search.",
+        "properties": {
+          "category": {
+            "type": "string",
+            "description": "Filter items by category (e.g., electronics, clothing, etc.)."
+          },
+          "location": {
+            "type": "string",
+            "description": "Filter items by storage location or warehouse."
+          },
+          "minStockLevel": {
+            "type": "integer",
+            "description": "Filter items with a stock level greater than or equal to this value."
+          },
+          "inStock": {
+            "type": "boolean",
+            "description": "Filter items that are currently in stock (true) or out of stock (false)."
+          }
+        },
+        "additionalProperties": false
+      },
+      "pagination": {
+        "type": "object",
+        "description": "Pagination options for the query.",
+        "properties": {
+          "page": {
+            "type": "integer",
+            "description": "The current page of results.",
+            "minimum": 1,
+            "default": 1
+          },
+          "pageSize": {
+            "type": "integer",
+            "description": "The number of items per page.",
+            "minimum": 1,
+            "default": 10
+          }
+        },
+        "required": ["page", "pageSize"]
+      }
+    },
+    "required": [],
+    "additionalProperties": false
+  }
+  

package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryStatus/index.md

@@ -0,0 +1,41 @@
+---
+id: GetInventoryStatus
+name: Get inventory status
+version: 0.0.1
+summary: |
+  GET request that will return the current stock status for a specific product.
+owners:
+    - dboyne
+badges:
+    - content: GET Request
+      backgroundColor: green
+      textColor: green
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The GetInventoryStatus message is a query designed to retrieve the current stock status for a specific product. 
+
+This query provides detailed information about the available quantity, reserved quantity, and the warehouse location where the product is stored. It is typically used by systems or services that need to determine the real-time availability of a product, enabling efficient stock management, order fulfillment, and inventory tracking processes. 
+
+This query is essential for ensuring accurate stock levels are reported to downstream systems, including e-commerce platforms, warehouse management systems, and sales channels.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+
+
+### Query using CURL
+
+Use this snippet to query the inventory status
+
+```sh title="Example CURL command"
+curl -X GET "https://api.yourdomain.com/inventory/status" \
+-H "Content-Type: application/json" \
+-d '{
+  "productId": "12345"
+}'
+```

package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryStatus/schema.json

@@ -0,0 +1,28 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "GetInventoryStatusResponse",
+    "type": "object",
+    "properties": {
+      "productId": {
+        "type": "string",
+        "description": "The unique identifier for the product"
+      },
+      "availableQuantity": {
+        "type": "integer",
+        "description": "The quantity of the product currently available in stock",
+        "minimum": 0
+      },
+      "reservedQuantity": {
+        "type": "integer",
+        "description": "The quantity of the product that is reserved for pending orders",
+        "minimum": 0
+      },
+      "warehouseLocation": {
+        "type": "string",
+        "description": "The location of the warehouse where the product is stored"
+      }
+    },
+    "required": ["productId", "availableQuantity", "reservedQuantity", "warehouseLocation"],
+    "additionalProperties": false
+  }
+  

package/templates/default/{services → domains/Orders/services}/InventoryService/versioned/0.0.1/index.md

@@ -24,7 +24,7 @@ sends:
     version: 0.0.3
 repository:
   language: JavaScript
-  url: https://github.com/boyney123/pretend-shipping-service
+  url: https://github.com/event-catalog/pretend-shipping-service
 ---
 
 ## Overview
@@ -33,4 +33,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/{services → domains/Orders/services}/NotificationService/index.md

@@ -8,22 +8,37 @@ owners:
     - dboyne
 receives:
   - id: InventoryAdjusted
-    version: 0.0.1
+    version: ">1.0.0"
+  - id: PaymentProcessed
+    version: ^1.0.0
+  - id: GetUserNotifications
+    version: x
+  - id: GetNotificationDetails
+    version: x
+sends:
+  - id: OutOfStock
+    version: latest
+  - id: GetInventoryList
+    version: 0.0.x
 repository:
   language: JavaScript
-  url: https://github.com/boyney123/pretend-shipping-service
+  url: https://github.com/event-catalog/pretend-shipping-service
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
 The Notification Service is responsible for managing and delivering notifications to users and other services. It supports various notification channels such as email, SMS, push notifications, and in-app notifications. The service ensures reliable and timely delivery of messages and integrates with other services to trigger notifications based on specific events.
 
 <Tiles >
     <Tile icon="DocumentIcon" href={`/docs/services/${frontmatter.id}/${frontmatter.version}/changelog`}  title="View the changelog" description="Want to know the history of this service? View the change logs" />
-    <Tile icon="UserGroupIcon" href="/docs/users/dboyne" title="Contact the owner" description="Any questions? Feel free to contact the owners" />
+    <Tile icon="UserGroupIcon" href="/docs/teams/full-stack" title="Contact the team" description="Any questions? Feel free to contact the owners" />
+    <Tile icon="BoltIcon" href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Sends ${frontmatter.sends.length} messages`} description="This service sends messages to downstream consumers" />
     <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
 </Tiles>
 
+
 ## Architecture diagram
 
 <NodeGraph />
@@ -39,4 +54,6 @@ The Notification Service is responsible for managing and delivering notification
     - Description: The medium through which the notification is delivered (e.g., email, SMS, push notification).
     - Attributes: channelId, name, provider, configuration 
   </Accordion>
-</AccordionGroup>
+</AccordionGroup>
+
+<Footer />

package/templates/default/domains/Orders/services/NotificationService/queries/GetNotificationDetails/index.md

@@ -0,0 +1,26 @@
+---
+id: GetNotificationDetails
+name: Get notification details
+version: 0.0.1
+summary: |
+  GET request that will return detailed information about a specific notification, identified by its notificationId.
+owners:
+    - dboyne
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `GetNotificationDetails` message is a query used to retrieve detailed information about a specific notification identified by its `notificationId`. It provides a comprehensive overview of the notification, including the title, message content, status (read/unread), the date it was created, and any additional metadata related to the notification, such as associated orders or system events. This query is helpful in scenarios where users or systems need detailed insights into a particular notification, such as retrieving full messages or auditing notifications sent to users.
+
+Use cases include viewing detailed information about order updates, system notifications, or promotional messages, allowing users to view their full notification history and details.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/NotificationService/queries/GetNotificationDetails/schema.json

@@ -0,0 +1,56 @@
+
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "GetNotificationDetailsResponse",
+  "type": "object",
+  "properties": {
+    "notificationId": {
+      "type": "string",
+      "description": "The unique identifier for the notification."
+    },
+    "title": {
+      "type": "string",
+      "description": "The title or subject of the notification."
+    },
+    "message": {
+      "type": "string",
+      "description": "The content or message body of the notification."
+    },
+    "status": {
+      "type": "string",
+      "enum": ["unread", "read"],
+      "description": "The read status of the notification."
+    },
+    "userId": {
+      "type": "string",
+      "description": "The unique identifier for the user who received the notification."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the notification was created."
+    },
+    "type": {
+      "type": "string",
+      "description": "The type of the notification, such as order or system."
+    },
+    "metadata": {
+      "type": "object",
+      "description": "Additional metadata related to the notification, such as order details.",
+      "properties": {
+        "orderId": {
+          "type": "string",
+          "description": "The associated order ID, if applicable."
+        },
+        "shippingProvider": {
+          "type": "string",
+          "description": "The shipping provider for the associated order, if applicable."
+        }
+      },
+      "required": ["orderId"],
+      "additionalProperties": false
+    }
+  },
+  "required": ["notificationId", "title", "message", "status", "userId", "createdAt", "type"],
+  "additionalProperties": false
+}

package/templates/default/domains/Orders/services/NotificationService/queries/GetUserNotifications/index.md

@@ -0,0 +1,27 @@
+---
+id: GetUserNotifications
+name: Get user notifications
+version: 0.0.1
+summary: |
+  GET request that will return a list of notifications for a specific user, with options to filter by status (unread or all).
+owners:
+    - dboyne
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `GetUserNotifications` message is a query used to retrieve a list of notifications for a specific user. It allows filtering by notification status, such as unread or all notifications. This query is typically utilized by notification services to display user-specific messages, such as order updates, promotional offers, or system notifications. It supports pagination through `limit` and `offset` parameters, ensuring that only a manageable number of notifications are retrieved at once. This query helps users stay informed about important events or updates related to their account, orders, or the platform.
+
+Use cases include delivering notifications for order updates, promotional campaigns, or general system messages to keep the user informed.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+

package/templates/default/domains/Orders/services/NotificationService/queries/GetUserNotifications/schema.json

@@ -0,0 +1,47 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "GetUserNotificationsResponse",
+    "type": "object",
+    "properties": {
+      "userId": {
+        "type": "string",
+        "description": "The unique identifier for the user."
+      },
+      "notifications": {
+        "type": "array",
+        "description": "A list of notifications for the user.",
+        "items": {
+          "type": "object",
+          "properties": {
+            "notificationId": {
+              "type": "string",
+              "description": "The unique identifier for the notification."
+            },
+            "title": {
+              "type": "string",
+              "description": "The title or subject of the notification."
+            },
+            "message": {
+              "type": "string",
+              "description": "The message body of the notification."
+            },
+            "status": {
+              "type": "string",
+              "enum": ["unread", "read"],
+              "description": "The read status of the notification."
+            },
+            "createdAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "The date and time when the notification was created."
+            }
+          },
+          "required": ["notificationId", "title", "message", "status", "createdAt"],
+          "additionalProperties": false
+        }
+      }
+    },
+    "required": ["userId", "notifications"],
+    "additionalProperties": false
+  }
+