@eventcatalog/create-eventcatalog 4.1.3 → 4.2.0

package/templates/default/domains/Orders/services/NotificationService/index.mdx

@@ -35,14 +35,33 @@ import Footer from '@catalog/components/footer.astro';
 
 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/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 />
@@ -51,12 +70,12 @@ The Notification Service is responsible for managing and delivering notification
 
 <AccordionGroup>
   <Accordion title="Notification">
-    - Description: A message that is sent to a user or a service.
-    - Attributes: notificationId, type, recipient, content, channel, status, timestamp
+    - Description: A message that is sent to a user or a service. - Attributes: notificationId, type, recipient, content, channel,
+    status, timestamp
   </Accordion>
   <Accordion title="Channel">
-    - Description: The medium through which the notification is delivered (e.g., email, SMS, push notification).
-    - Attributes: channelId, name, provider, configuration 
+    - Description: The medium through which the notification is delivered (e.g., email, SMS, push notification). - Attributes:
+    channelId, name, provider, configuration
   </Accordion>
 </AccordionGroup>
 

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

@@ -5,11 +5,11 @@ version: 0.0.1
 summary: |
   GET request that will return detailed information about a specific notification, identified by its notificationId.
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 

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

@@ -1,4 +1,3 @@
-
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "GetNotificationDetailsResponse",

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

@@ -5,11 +5,11 @@ 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
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 
@@ -24,4 +24,3 @@ Use cases include delivering notifications for order updates, promotional campai
 <NodeGraph />
 
 <SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
-

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

@@ -1,47 +1,46 @@
 {
-    "$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."
-            }
+  "$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."
           },
-          "required": ["notificationId", "title", "message", "status", "createdAt"],
-          "additionalProperties": false
-        }
+          "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
-  }
-  
+    }
+  },
+  "required": ["userId", "notifications"],
+  "additionalProperties": false
+}

package/templates/default/domains/Orders/services/OrdersService/changelog.mdx

@@ -1,3 +1,3 @@
 ---
 createdAt: 2024-08-01
----
+---

package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/schema.json

@@ -1,71 +1,70 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "OrderAmendedEvent",
-    "type": "object",
-    "properties": {
-      "orderId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the order that was amended."
-      },
-      "userId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the user who placed the order."
-      },
-      "amendedItems": {
-        "type": "array",
-        "description": "A list of items that were amended in the order, each containing product details and updated quantities.",
-        "items": {
-          "type": "object",
-          "properties": {
-            "productId": {
-              "type": "string",
-              "format": "uuid",
-              "description": "The unique identifier of the product."
-            },
-            "productName": {
-              "type": "string",
-              "description": "The name of the product."
-            },
-            "oldQuantity": {
-              "type": "integer",
-              "description": "The original quantity of the product ordered."
-            },
-            "newQuantity": {
-              "type": "integer",
-              "description": "The new quantity of the product ordered."
-            },
-            "unitPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The price per unit of the product."
-            },
-            "totalPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The total price for this order item (newQuantity * unitPrice)."
-            }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "OrderAmendedEvent",
+  "type": "object",
+  "properties": {
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the order that was amended."
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the user who placed the order."
+    },
+    "amendedItems": {
+      "type": "array",
+      "description": "A list of items that were amended in the order, each containing product details and updated quantities.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "productId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The unique identifier of the product."
+          },
+          "productName": {
+            "type": "string",
+            "description": "The name of the product."
+          },
+          "oldQuantity": {
+            "type": "integer",
+            "description": "The original quantity of the product ordered."
           },
-          "required": ["productId", "productName", "oldQuantity", "newQuantity", "unitPrice", "totalPrice"]
-        }
-      },
-      "orderStatus": {
-        "type": "string",
-        "description": "The current status of the order after the amendment."
-      },
-      "totalAmount": {
-        "type": "number",
-        "format": "float",
-        "description": "The total amount of the order after the amendment."
-      },
-      "timestamp": {
-        "type": "string",
-        "format": "date-time",
-        "description": "The date and time when the order was amended, in ISO 8601 format."
+          "newQuantity": {
+            "type": "integer",
+            "description": "The new quantity of the product ordered."
+          },
+          "unitPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The price per unit of the product."
+          },
+          "totalPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The total price for this order item (newQuantity * unitPrice)."
+          }
+        },
+        "required": ["productId", "productName", "oldQuantity", "newQuantity", "unitPrice", "totalPrice"]
       }
     },
-    "required": ["orderId", "userId", "amendedItems", "orderStatus", "totalAmount", "timestamp"],
-    "additionalProperties": false
-  }
-  
+    "orderStatus": {
+      "type": "string",
+      "description": "The current status of the order after the amendment."
+    },
+    "totalAmount": {
+      "type": "number",
+      "format": "float",
+      "description": "The total amount of the order after the amendment."
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the order was amended, in ISO 8601 format."
+    }
+  },
+  "required": ["orderId", "userId", "amendedItems", "orderStatus", "totalAmount", "timestamp"],
+  "additionalProperties": false
+}

package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/index.mdx

@@ -43,13 +43,12 @@ The OrderCancelled event is triggered whenever an existing order is cancelled. T
   "cancellationReason": "Customer requested cancellation",
   "timestamp": "2024-07-04T14:48:00Z"
 }
-
 ```
 
 ## Schema
 
 JSON schema for the event.
 
-<Schema title="JSON Schema" file="schema.json"/>
+<Schema title="JSON Schema" file="schema.json" />
 
 <Footer />

package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/schema.json

@@ -1,72 +1,71 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "OrderCancelledEvent",
-    "type": "object",
-    "properties": {
-      "orderId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the order that was cancelled."
-      },
-      "userId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the user who placed the order."
-      },
-      "orderItems": {
-        "type": "array",
-        "description": "A list of items included in the cancelled order, each containing product details and quantities.",
-        "items": {
-          "type": "object",
-          "properties": {
-            "productId": {
-              "type": "string",
-              "format": "uuid",
-              "description": "The unique identifier of the product."
-            },
-            "productName": {
-              "type": "string",
-              "description": "The name of the product."
-            },
-            "quantity": {
-              "type": "integer",
-              "description": "The quantity of the product ordered."
-            },
-            "unitPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The price per unit of the product."
-            },
-            "totalPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The total price for this order item (quantity * unit price)."
-            }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "OrderCancelledEvent",
+  "type": "object",
+  "properties": {
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the order that was cancelled."
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the user who placed the order."
+    },
+    "orderItems": {
+      "type": "array",
+      "description": "A list of items included in the cancelled order, each containing product details and quantities.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "productId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The unique identifier of the product."
+          },
+          "productName": {
+            "type": "string",
+            "description": "The name of the product."
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "The quantity of the product ordered."
           },
-          "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
-        }
-      },
-      "orderStatus": {
-        "type": "string",
-        "description": "The current status of the order after cancellation.",
-        "enum": ["cancelled"]
-      },
-      "totalAmount": {
-        "type": "number",
-        "format": "float",
-        "description": "The total amount of the order that was cancelled."
-      },
-      "cancellationReason": {
-        "type": "string",
-        "description": "The reason for the order cancellation, if provided."
-      },
-      "timestamp": {
-        "type": "string",
-        "format": "date-time",
-        "description": "The date and time when the order was cancelled."
+          "unitPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The price per unit of the product."
+          },
+          "totalPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The total price for this order item (quantity * unit price)."
+          }
+        },
+        "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
       }
     },
-    "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "timestamp"],
-    "additionalProperties": false
-  }
-  
+    "orderStatus": {
+      "type": "string",
+      "description": "The current status of the order after cancellation.",
+      "enum": ["cancelled"]
+    },
+    "totalAmount": {
+      "type": "number",
+      "format": "float",
+      "description": "The total amount of the order that was cancelled."
+    },
+    "cancellationReason": {
+      "type": "string",
+      "description": "The reason for the order cancellation, if provided."
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the order was cancelled."
+    }
+  },
+  "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "timestamp"],
+  "additionalProperties": false
+}

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/index.mdx

@@ -50,6 +50,6 @@ The OrderConfirmed event is triggered when an order has been successfully confir
 
 ## Schema
 
-<Schema file="schema.json"/>
+<Schema file="schema.json" />
 
 <Footer />

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/schema.json

@@ -1,67 +1,66 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "OrderConfirmedEvent",
-    "type": "object",
-    "properties": {
-      "orderId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the confirmed order."
-      },
-      "userId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the user who placed the order."
-      },
-      "orderItems": {
-        "type": "array",
-        "description": "A list of items included in the confirmed order, each containing product details and quantities.",
-        "items": {
-          "type": "object",
-          "properties": {
-            "productId": {
-              "type": "string",
-              "format": "uuid",
-              "description": "The unique identifier of the product."
-            },
-            "productName": {
-              "type": "string",
-              "description": "The name of the product."
-            },
-            "quantity": {
-              "type": "integer",
-              "description": "The quantity of the product ordered."
-            },
-            "unitPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The price per unit of the product."
-            },
-            "totalPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The total price for this order item (quantity * unitPrice)."
-            }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "OrderConfirmedEvent",
+  "type": "object",
+  "properties": {
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the confirmed order."
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the user who placed the order."
+    },
+    "orderItems": {
+      "type": "array",
+      "description": "A list of items included in the confirmed order, each containing product details and quantities.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "productId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The unique identifier of the product."
+          },
+          "productName": {
+            "type": "string",
+            "description": "The name of the product."
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "The quantity of the product ordered."
           },
-          "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
-        }
-      },
-      "orderStatus": {
-        "type": "string",
-        "description": "The current status of the order after confirmation."
-      },
-      "totalAmount": {
-        "type": "number",
-        "format": "float",
-        "description": "The total amount of the confirmed order."
-      },
-      "confirmationTimestamp": {
-        "type": "string",
-        "format": "date-time",
-        "description": "The date and time when the order was confirmed."
+          "unitPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The price per unit of the product."
+          },
+          "totalPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The total price for this order item (quantity * unitPrice)."
+          }
+        },
+        "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
       }
     },
-    "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "confirmationTimestamp"],
-    "additionalProperties": false
-  }
-  
+    "orderStatus": {
+      "type": "string",
+      "description": "The current status of the order after confirmation."
+    },
+    "totalAmount": {
+      "type": "number",
+      "format": "float",
+      "description": "The total amount of the confirmed order."
+    },
+    "confirmationTimestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the order was confirmed."
+    }
+  },
+  "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "confirmationTimestamp"],
+  "additionalProperties": false
+}