@eventcatalog/create-eventcatalog 4.1.3 → 4.2.0

package/templates/default/domains/Orders/services/InventoryService/commands/UpdateInventory/schema.json

@@ -1,29 +1,28 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "UpdateInventoryCommand",
-    "type": "object",
-    "properties": {
-      "productId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the product whose inventory is being updated."
-      },
-      "quantityChange": {
-        "type": "integer",
-        "description": "The change in quantity of the product in the inventory. Positive values indicate an increase, while negative values indicate a decrease."
-      },
-      "warehouseId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the warehouse where the inventory is being updated."
-      },
-      "timestamp": {
-        "type": "string",
-        "format": "date-time",
-        "description": "The date and time when the inventory update occurred."
-      }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "UpdateInventoryCommand",
+  "type": "object",
+  "properties": {
+    "productId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the product whose inventory is being updated."
     },
-    "required": ["productId", "quantityChange", "warehouseId", "timestamp"],
-    "additionalProperties": false
-  }
-  
+    "quantityChange": {
+      "type": "integer",
+      "description": "The change in quantity of the product in the inventory. Positive values indicate an increase, while negative values indicate a decrease."
+    },
+    "warehouseId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the warehouse where the inventory is being updated."
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the inventory update occurred."
+    }
+  },
+  "required": ["productId", "quantityChange", "warehouseId", "timestamp"],
+  "additionalProperties": false
+}

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

@@ -1,9 +1,9 @@
 ---
 createdAt: 2024-08-01
 badges:
-    - content: ⭐️ JSON Schema
-      backgroundColor: purple
-      textColor: purple
+  - content: ⭐️ JSON Schema
+    backgroundColor: purple
+    textColor: purple
 ---
 
 ### Added support for JSON Schema
@@ -29,7 +29,6 @@ InventoryAdjusted uses Avro but now also supports JSON Draft 7.
   },
   "required": ["Name", "Age", "Town"]
 }
-
 ```
 
 Using it with our Kafka Cluster

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

@@ -26,9 +26,19 @@ import Footer from '@catalog/components/footer.astro';
 
 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>
+  <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
@@ -47,7 +57,7 @@ Event example you my see being published.
   "Age": 30,
   "Department": "Engineering",
   "Position": "Software Engineer",
-  "Salary": 85000.50,
+  "Salary": 85000.5,
   "JoinDate": "2024-01-15"
 }
 ```

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

@@ -1,9 +1,9 @@
 ---
 createdAt: 2024-07-01
 badges:
-    - content: Breaking change
-      backgroundColor: red
-      textColor: red
+  - content: Breaking change
+    backgroundColor: red
+    textColor: red
 ---
 
 ### Removed fields from schema, added new owners
@@ -24,7 +24,3 @@ Also added the [full stackers](/docs/teams/full-stack) team as owners of this ev
     ]
   }
 ```
-
-
-
-

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

@@ -6,14 +6,17 @@ schemaPath: schema.json
 summary: |
   Indicates a change in inventory level
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - 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>
+<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
 

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

@@ -1,26 +1,26 @@
 ---
 createdAt: 2024-07-11
 badges:
-    - content: New field
-      backgroundColor: green
-      textColor: green
+  - content: New field
+    backgroundColor: green
+    textColor: green
 ---
 
 ### Added new field to schema
 
-We added the new town property to the schema for downstream consumers. 
+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" },
+  "type": "record",
+  "namespace": "Tutorialspoint",
+  "name": "Employee",
+  "fields": [
+    { "name": "Name", "type": "string" },
+    { "name": "Age", "type": "int" },
 
-     { "name" : "Town" , "type" : "string" },
+    { "name": "Town", "type": "string" }
   ]
 }
 ```

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

@@ -6,18 +6,18 @@ schemaPath: schema.json
 summary: |
   Indicates a change in inventory level
 owners:
-    - dboyne
-    - msmith
-    - asmith
-    - full-stack
-    - mobile-devs
+  - 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
 ---
 
 ## Overview
@@ -29,12 +29,15 @@ The `Inventory Adjusted` event is triggered whenever there is a change in the in
 ## 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"
@@ -102,4 +105,4 @@ consumer = KafkaConsumer(
 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/OutOfStock/index.mdx

@@ -29,6 +29,7 @@ The `Inventory Adjusted` event is triggered whenever there is a change in the in
 <NodeGraph />
 
 ### Payload
+
 The payload of the `Inventory Adjusted` event includes the following fields:
 
 ```json title="Example of payload" frame="terminal"

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1/index.mdx

@@ -6,18 +6,18 @@ schemaPath: schema.json
 summary: |
   Indicates inventory is out of stock
 owners:
-    - dboyne
-    - msmith
-    - asmith
-    - full-stack
-    - mobile-devs
+  - 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
 ---
 
 ## Overview
@@ -27,6 +27,7 @@ The `Inventory Adjusted` event is triggered whenever there is a change in the in
 <NodeGraph />
 
 ### Payload
+
 The payload of the `Inventory Adjusted` event includes the following fields:
 
 ```json title="Example of payload" frame="terminal"
@@ -94,4 +95,4 @@ consumer = KafkaConsumer(
 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/index.mdx

@@ -45,25 +45,41 @@ repository:
 
 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.
 
-<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/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>
+  <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/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 title="Hello world" />
 
-
 <Steps title="How to connect to Inventory Service">
   <Step title="Obtain API credentials">
     Request API credentials from the Inventory Service team.
@@ -77,24 +93,27 @@ The Inventory Service is a critical component of the system responsible for mana
   <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'
-  });
+```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));
-  ```
+```js
+client
+  .getProducts()
+  .then((products) => console.log(products))
+  .catch((error) => console.error(error));
+```
+
   </Step>
 </Steps>
 

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

@@ -5,11 +5,11 @@ version: 0.0.1
 summary: |
   GET request that will return inventory list
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ import Footer from '@catalog/components/footer.astro';
 
 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 />
+<NodeGraph />

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

@@ -1,53 +1,52 @@
 {
-    "$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)."
-          }
+  "$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.)."
         },
-        "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
-          }
+        "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."
         },
-        "required": ["page", "pageSize"]
-      }
+        "inStock": {
+          "type": "boolean",
+          "description": "Filter items that are currently in stock (true) or out of stock (false)."
+        }
+      },
+      "additionalProperties": false
     },
-    "required": [],
-    "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.mdx

@@ -5,11 +5,11 @@ version: 0.0.1
 summary: |
   GET request that will return the current stock status for a specific product.
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: GET Request
-      backgroundColor: green
-      textColor: green
+  - content: GET Request
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 
@@ -17,9 +17,9 @@ 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. 
+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 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.
 
@@ -27,7 +27,6 @@ This query is essential for ensuring accurate stock levels are reported to downs
 
 <SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
 
-
 ### Query using CURL
 
 Use this snippet to query the inventory status

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

@@ -1,28 +1,27 @@
 {
-    "$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"
-      }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "GetInventoryStatusResponse",
+  "type": "object",
+  "properties": {
+    "productId": {
+      "type": "string",
+      "description": "The unique identifier for the product"
     },
-    "required": ["productId", "availableQuantity", "reservedQuantity", "warehouseLocation"],
-    "additionalProperties": false
-  }
-  
+    "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
+}