@eventcatalog/create-eventcatalog 2.2.4 → 2.2.6

package/dist/index.js

@@ -22466,7 +22466,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "2.2.4",
+  version: "2.2.6",
   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.2.4",
+  "version": "2.2.6",
   "bin": {
     "create-catalog": "./dist/index.js"
   },

package/templates/asyncapi/eventcatalog.config.js

@@ -50,6 +50,13 @@ export default {
       },
     ],
   ],
+  docs: {
+    sidebar: {
+      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
+      // FLAT_VIEW will render the DOCS as a flat list (no nested folders)
+      type: 'TREE_VIEW'
+    },
+  },
   // Enable RSS feed for your eventcatalog
   rss: {
     enabled: true,

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

@@ -7,11 +7,9 @@ owners:
   - full-stack
 services:
   - id: InventoryService
-    version: 0.0.2
   - id: NotificationService
-    version: 0.0.2
   - id: OrdersService
-    version: 0.0.2
+  - id: PaymentService
 badges:
   - content: New domain
     backgroundColor: blue

package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/index.md

@@ -0,0 +1,23 @@
+---
+id: CancelShipment
+name: Cancel shipment
+version: 0.0.1
+summary: |
+  POST request that will cancel a shipment, identified by its shipmentId.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `CancelShipment` message is a command used to cancel a shipment, identified by its `shipmentId`. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This command can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<SchemaViewer file="schema.json" title="Schema" maxHeight="500" />
+
+<NodeGraph />
+

package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/schema.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "CancelShipment",
+    "description": "Schema for cancelling a shipment",
+    "properties": {
+        "shipmentId": {
+            "type": "string",
+            "description": "Unique identifier for the shipment"
+        }
+    },
+    "required": ["shipmentId"]
+}

package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/index.md

@@ -0,0 +1,22 @@
+---
+id: CreateReturnLabel
+name: Create return label
+version: 0.0.1
+summary: |
+  POST request that will create a return label for a specific shipment, identified by its shipmentId.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `CreateReturnLabel` message is a command used to create a return label for a specific shipment, identified by its `shipmentId`. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This command can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/schema.json

@@ -0,0 +1,19 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "CreateReturnLabel",
+    "description": "Schema for creating a return shipping label",
+    "properties": {
+        "CreateReturnLabel": {
+            "type": "object",
+            "properties": {
+                "shipmentId": {
+                    "type": "string",
+                    "description": "Unique identifier for the shipment"
+                }
+            },
+            "required": ["shipmentId"]
+        }
+    },
+    "required": ["CreateReturnLabel"]
+}

package/templates/default/domains/Orders/services/ShippingService/commands/CreateShipment/index.md

@@ -0,0 +1,22 @@
+---
+id: CreateShipment
+name: Create shipment
+version: 0.0.1
+summary: |
+  POST request that will create a shipment for a specific order, identified by its orderId.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `CreateShipment` message is a command used to create a shipment for a specific order, identified by its `orderId`. It provides information such as the order status (e.g., pending, completed, shipped), the items within the order, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This command can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time order data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/commands/CreateShipment/schema.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
+    },
+    "orderId": {
+      "type": "string",
+      "description": "Identifier for the associated order"
+    },
+    "address": {
+      "type": "object",
+      "properties": {
+        "street": {
+          "type": "string",
+          "description": "Street address for the shipment"
+        },
+        "city": {
+          "type": "string",
+          "description": "City for the shipment"
+        },
+        "state": {
+          "type": "string",
+          "description": "State for the shipment"
+        },
+        "postalCode": {
+          "type": "string",
+          "description": "Postal code for the shipment"
+        },
+        "country": {
+          "type": "string",
+          "description": "Country for the shipment"
+        }
+      },
+      "required": ["street", "city", "state", "postalCode", "country"]
+    },
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "itemId": {
+            "type": "string",
+            "description": "Identifier for the item"
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of the item"
+          }
+        },
+        "required": ["itemId", "quantity"]
+      }
+    },
+    "shippingMethod": {
+      "type": "string",
+      "description": "Method of shipping (e.g., standard, express)"
+    }
+  },
+  "required": ["shipmentId", "orderId", "address", "items", "shippingMethod"]
+}

package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/index.md

@@ -0,0 +1,22 @@
+---
+id: UpdateShipmentStatus
+name: Update shipment status
+version: 0.0.1
+summary: |
+  POST request that will update the status of a shipment, identified by its shipmentId.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `UpdateShipmentStatus` message is a command used to update the status of a shipment, identified by its `shipmentId`. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This command can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/schema.json

@@ -0,0 +1,29 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "UpdateShipmentStatus",
+    "description": "Schema for updating a shipment's status",
+    "properties": {
+        "UpdateShipmentStatus": {
+            "type": "object",
+            "properties": {
+                "shipmentId": {
+                    "type": "string",
+                    "description": "Unique identifier for the shipment"
+                },
+                "status": {
+                    "type": "string",
+                    "enum": ["pending", "shipped", "delivered", "returned"],
+                    "description": "Current status of the shipment"
+                },
+                "updatedAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "Timestamp when the status was last updated"
+                }
+            },
+            "required": ["shipmentId", "status"]
+        }
+    },
+    "required": ["UpdateShipmentStatus"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/index.md

@@ -0,0 +1,22 @@
+---
+id: DeliveryFailed
+name: Delivery failed
+version: 0.0.1
+summary: |
+  Event that is emitted when a shipment delivery fails.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `DeliveryFailed` event is emitted when a shipment delivery fails. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This event can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/schema.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "DeliveryFailed",
+    "description": "Schema for delivery failed event",
+    "properties": {
+        "shipmentId": {
+            "type": "string",
+            "description": "Unique identifier for the shipment"
+        },
+        "orderId": {
+            "type": "string",
+            "description": "Identifier for the associated order"
+        }
+    },
+    "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/index.md

@@ -0,0 +1,22 @@
+---
+id: ReturnInitiated
+name: Return initiated
+version: 0.0.1
+summary: |
+  Event that is emitted when a return is initiated.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `ReturnInitiated` event is emitted when a return is initiated. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This event can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time return data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/schema.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "ReturnInitiated",
+    "description": "Schema for return initiated event",
+    "properties": {
+        "shipmentId": {
+            "type": "string",
+            "description": "Unique identifier for the shipment"
+        },
+        "orderId": {
+            "type": "string",
+            "description": "Identifier for the associated order"
+        }
+    },
+    "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/index.md

@@ -0,0 +1,22 @@
+---
+id: ShipmentCreated
+name: Shipment created
+version: 0.0.1
+summary: |
+  Event that is emitted when a shipment is created.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `ShipmentCreated` event is emitted when a shipment is created. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This event can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/schema.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "ShipmentCreated",
+  "description": "Schema for shipment created event",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
+    },
+    "orderId": {
+      "type": "string",
+      "description": "Identifier for the associated order"
+    },
+    "address": {
+      "type": "object",
+      "properties": {
+        "street": {
+          "type": "string",
+          "description": "Street address for the shipment"
+        },
+        "city": {
+          "type": "string",
+          "description": "City for the shipment"
+        },
+        "state": {
+          "type": "string",
+          "description": "State for the shipment"
+        },
+        "postalCode": {
+          "type": "string",
+          "description": "Postal code for the shipment"
+        },
+        "country": {
+          "type": "string",
+          "description": "Country for the shipment"
+        }
+      },
+      "required": ["street", "city", "state", "postalCode", "country"]
+    },
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "itemId": {
+            "type": "string",
+            "description": "Identifier for the item"
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of the item"
+          }
+        },
+        "required": ["itemId", "quantity"]
+      }
+    },
+    "shippingMethod": {
+      "type": "string",
+      "description": "Method of shipping (e.g., standard, express)"
+    }
+  },
+  "required": ["shipmentId", "orderId", "address", "items", "shippingMethod"]
+}
+

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/index.md

@@ -0,0 +1,22 @@
+---
+id: ShipmentDelivered
+name: Shipment delivered
+version: 0.0.1
+summary: |
+  Event that is emitted when a shipment is delivered.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `ShipmentDelivered` event is emitted when a shipment is delivered. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This event can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/schema.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "ShipmentDelivered",
+    "description": "Schema for shipment delivered event",
+    "properties": {
+        "shipmentId": {
+            "type": "string",
+            "description": "Unique identifier for the shipment"
+        },
+        "orderId": {
+            "type": "string",
+            "description": "Identifier for the associated order"
+        }
+    },
+    "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/index.md

@@ -0,0 +1,22 @@
+---
+id: ShipmentDispatched
+name: Shipment dispatched
+version: 0.0.1
+summary: |
+  Event that is emitted when a shipment is dispatched.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `ShipmentDispatched` event is emitted when a shipment is dispatched. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This event can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/schema.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "ShipmentDispatched",
+    "description": "Schema for shipment dispatched event",
+    "properties": {
+        "shipmentId": {
+            "type": "string",
+            "description": "Unique identifier for the shipment"
+        },
+        "orderId": {
+            "type": "string",
+            "description": "Identifier for the associated order"
+        }
+    },
+    "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/index.md

@@ -0,0 +1,22 @@
+---
+id: ShipmentInTransit
+name: Shipment in transit
+version: 0.0.1
+summary: |
+  Event that is emitted when a shipment is in transit.
+owners:
+    - dboyne
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `ShipmentInTransit` event is emitted when a shipment is in transit. It provides information such as the shipment status (e.g., pending, completed, shipped), the items within the shipment, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This event can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time shipment data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/schema.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "ShipmentInTransit",
+    "description": "Schema for shipment in transit event",
+    "properties": {
+        "shipmentId": {
+            "type": "string",
+            "description": "Unique identifier for the shipment"
+        },
+        "orderId": {
+            "type": "string",
+            "description": "Identifier for the associated order"
+        }
+    },
+    "required": ["shipmentId", "orderId"]
+}

package/templates/default/domains/Orders/services/ShippingService/index.md

@@ -0,0 +1,49 @@
+---
+id: ShippingService
+version: 0.0.1
+name: Shipping Service
+summary: |
+  Service that handles shipping
+owners:
+    - dboyne
+receives:
+  - id: CancelShipment
+  - id: CreateReturnLabel
+  - id: CreateShipment
+  - id: UpdateShipmentStatus
+  - id: PaymentProcessed
+sends:
+  - id: ShipmentCreated
+  - id: ReturnInitiated
+  - id: ShipmentDispatched
+  - id: ShipmentInTransit
+  - id: ShipmentDelivered
+  - id: DeliveryFailed
+repository:
+  language: JavaScript
+  url: https://github.com/event-catalog/pretend-shipping-service
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The Shipping Service is responsible for managing shipping within the system. It handles order creation, updating, status tracking, and interactions with other services such as Inventory, Payment, and Notification services to ensure smooth order processing and fulfillment.
+
+<Tiles >
+    <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>
+
+### Core features
+
+The Shipping Service is responsible for managing shipping within the system. It handles order creation, updating, status tracking, and interactions with other services such as Inventory, Payment, and Notification services to ensure smooth order processing and fulfillment.
+
+
+## Architecture diagram 
+
+<NodeGraph />
+
+<MessageTable format="all" limit={4} />
+
+<Footer />

package/templates/default/eventcatalog.config.js

@@ -16,6 +16,13 @@ export default {
     src: '/logo.png',
     text: 'EventCatalog'
   },
+  docs: {
+    sidebar: {
+      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
+      // FLAT_VIEW will render the DOCS as a flat list (no nested folders)
+      type: 'TREE_VIEW'
+    },
+  },
   // Enable RSS feed for your eventcatalog
   rss: {
     enabled: true,

package/templates/empty/eventcatalog.config.js

@@ -22,6 +22,13 @@ export default {
     // number of items to include in the feed per resource (event, service, etc)
     limit: 20
   },
+  docs: {
+    sidebar: {
+      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
+      // FLAT_VIEW will render the DOCS as a flat list (no nested folders)
+      type: 'TREE_VIEW'
+    },
+  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 }

package/templates/openapi/eventcatalog.config.js

@@ -55,6 +55,13 @@ export default {
       },
     ],
   ],
+  docs: {
+    sidebar: {
+      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
+      // FLAT_VIEW will render the DOCS as a flat list (no nested folders)
+      type: 'TREE_VIEW'
+    },
+  },
   // Enable RSS feed for your eventcatalog
   rss: {
     enabled: true,