@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

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

@@ -1,55 +0,0 @@
-{
-  "$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.mdx

@@ -1,26 +0,0 @@
----
-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

@@ -1,46 +0,0 @@
-{
-  "$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
-}

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

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

package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/examples/address-change.json

@@ -1,36 +0,0 @@
-{
-  "eventId": "evt_b7d14e92-6f3a-4c09-9e72-1a5b8d3f6c20",
-  "eventType": "OrderAmended",
-  "timestamp": "2025-11-14T14:05:33.119Z",
-  "orderId": "ord_83102",
-  "userId": "usr_51037",
-  "amendmentType": "ADDRESS_CHANGE",
-  "amendments": [],
-  "shippingAddress": {
-    "previous": {
-      "line1": "42 Oak Street",
-      "line2": "Apt 7B",
-      "city": "Portland",
-      "state": "OR",
-      "postalCode": "97201",
-      "country": "US"
-    },
-    "updated": {
-      "line1": "158 Maple Avenue",
-      "line2": null,
-      "city": "Portland",
-      "state": "OR",
-      "postalCode": "97205",
-      "country": "US"
-    }
-  },
-  "previousOrderTotal": 89.97,
-  "newOrderTotal": 89.97,
-  "currency": "USD",
-  "orderStatus": "confirmed",
-  "metadata": {
-    "source": "mobile-app",
-    "correlationId": "corr_f8e7d6c5-b4a3-2190-fedc-ba0987654321",
-    "userAgent": "EventCatalog-Mobile/2.3.1 (iOS 17.4)"
-  }
-}

package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-quantity-change.json:
-  name: Quantity Change
-  summary: Customer updated the quantity of an item in their order from 1 to 3 units.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @quantity-change.json
-
-address-change.json:
-  name: Shipping Address Change
-  summary: Customer changed the shipping address on a confirmed order before dispatch.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @address-change.json

package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/examples/quantity-change.json

@@ -1,29 +0,0 @@
-{
-  "eventId": "evt_9a3f2c71-4e88-4b1a-b5d0-83c1e7a2f640",
-  "eventType": "OrderAmended",
-  "timestamp": "2025-11-14T09:23:17.482Z",
-  "orderId": "ord_82451",
-  "userId": "usr_44829",
-  "amendmentType": "QUANTITY_CHANGE",
-  "amendments": [
-    {
-      "productId": "prod_1129",
-      "productName": "Wireless Bluetooth Headphones",
-      "sku": "WBH-400-BLK",
-      "previousQuantity": 1,
-      "newQuantity": 3,
-      "unitPrice": 49.99,
-      "previousLineTotal": 49.99,
-      "newLineTotal": 149.97
-    }
-  ],
-  "previousOrderTotal": 124.98,
-  "newOrderTotal": 224.96,
-  "currency": "USD",
-  "orderStatus": "confirmed",
-  "metadata": {
-    "source": "web",
-    "correlationId": "corr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
-    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
-  }
-}

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

@@ -1,58 +0,0 @@
----
-id: OrderAmended
-name: Order amended
-version: 0.0.1
-summary: |
-  Indicates an order has been changed
-owners:
-  - dboyne
-  - msmith
-badges:
-  - content: Recently updated!
-    backgroundColor: green
-    textColor: green
-  - content: 'Channel:Apache Kafka'
-    backgroundColor: yellow
-    textColor: yellow
-schemaPath: schema.avro
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The OrderAmended event is triggered whenever an existing order is modified. This event ensures that all relevant services are notified of changes to an order, such as updates to order items, quantities, shipping information, or status. The event allows the system to maintain consistency and ensure that all dependent services can react appropriately to the amendments.
-
-<NodeGraph />
-
-## Example payload
-
-```json title="Example Payload"
-{
-  "orderId": "123e4567-e89b-12d3-a456-426614174000",
-  "userId": "123e4567-e89b-12d3-a456-426614174000",
-  "amendedItems": [
-    {
-      "productId": "789e1234-b56c-78d9-e012-3456789fghij",
-      "productName": "Example Product",
-      "oldQuantity": 2,
-      "newQuantity": 3,
-      "unitPrice": 29.99,
-      "totalPrice": 89.97
-    }
-  ],
-  "orderStatus": "confirmed",
-  "totalAmount": 150.75,
-  "timestamp": "2024-07-04T14:48:00Z"
-}
-```
-
-## Schema (Avro)
-
-<Schema file="schema.avro" />
-
-## Schema (JSON)
-
-<Schema file="schema.json" />
-
-<Footer />

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

@@ -1,75 +0,0 @@
-{
-  "type": "record",
-  "name": "OrderAmendedEvent",
-  "namespace": "com.example.events",
-  "fields": [
-    {
-      "name": "orderId",
-      "type": "string",
-      "doc": "The unique identifier of the order that was amended."
-    },
-    {
-      "name": "userId",
-      "type": "string",
-      "doc": "The unique identifier of the user who placed the order."
-    },
-    {
-      "name": "amendedItems",
-      "type": {
-        "type": "array",
-        "items": {
-          "type": "record",
-          "name": "AmendedItem",
-          "fields": [
-            {
-              "name": "productId",
-              "type": "string",
-              "doc": "The unique identifier of the product."
-            },
-            {
-              "name": "productName",
-              "type": "string",
-              "doc": "The name of the product."
-            },
-            {
-              "name": "oldQuantity",
-              "type": "int",
-              "doc": "The original quantity of the product ordered."
-            },
-            {
-              "name": "newQuantity",
-              "type": "int",
-              "doc": "The new quantity of the product ordered."
-            },
-            {
-              "name": "unitPrice",
-              "type": "double",
-              "doc": "The price per unit of the product."
-            },
-            {
-              "name": "totalPrice",
-              "type": "double",
-              "doc": "The total price for this order item (newQuantity * unitPrice)."
-            }
-          ]
-        }
-      },
-      "doc": "A list of items that were amended in the order, each containing product details and updated quantities."
-    },
-    {
-      "name": "orderStatus",
-      "type": "string",
-      "doc": "The current status of the order after the amendment."
-    },
-    {
-      "name": "totalAmount",
-      "type": "double",
-      "doc": "The total amount of the order after the amendment."
-    },
-    {
-      "name": "timestamp",
-      "type": "string",
-      "doc": "The date and time when the order was amended, in ISO 8601 format."
-    }
-  ]
-}

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

@@ -1,70 +0,0 @@
-{
-  "$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)."
-          }
-        },
-        "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."
-    }
-  },
-  "required": ["orderId", "userId", "amendedItems", "orderStatus", "totalAmount", "timestamp"],
-  "additionalProperties": false
-}

package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/examples/customer-request.json

@@ -1,34 +0,0 @@
-{
-  "eventId": "evt_c4e81a29-7d52-4f6b-a390-2e9f5b8c1d74",
-  "eventType": "OrderCancelled",
-  "timestamp": "2025-11-15T11:42:08.734Z",
-  "orderId": "ord_84219",
-  "userId": "usr_33741",
-  "cancellationReason": "CUSTOMER_REQUEST",
-  "cancellationNote": "Changed my mind about the purchase",
-  "items": [
-    {
-      "productId": "prod_2045",
-      "productName": "Ergonomic Office Chair",
-      "sku": "EOC-200-GRY",
-      "quantity": 1,
-      "unitPrice": 349.99
-    },
-    {
-      "productId": "prod_3087",
-      "productName": "Standing Desk Mat",
-      "sku": "SDM-100-BLK",
-      "quantity": 1,
-      "unitPrice": 44.99
-    }
-  ],
-  "refundAmount": 394.98,
-  "currency": "USD",
-  "previousStatus": "confirmed",
-  "newStatus": "cancelled",
-  "metadata": {
-    "source": "web",
-    "correlationId": "corr_d2c3b4a5-6789-0123-abcd-456789012345",
-    "cancelledBy": "customer"
-  }
-}

package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-customer-request.json:
-  name: Customer Requested Cancellation
-  summary: Customer cancelled a confirmed order containing two items before shipment.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @customer-request.json
-
-out-of-stock.json:
-  name: Out of Stock Cancellation
-  summary: System automatically cancelled an order because the product was no longer available from the supplier.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @out-of-stock.json

package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/examples/out-of-stock.json

@@ -1,28 +0,0 @@
-{
-  "eventId": "evt_e5f92b38-8c63-4a7d-b401-3f0a6c9d2e85",
-  "eventType": "OrderCancelled",
-  "timestamp": "2025-11-15T16:18:45.291Z",
-  "orderId": "ord_84507",
-  "userId": "usr_28956",
-  "cancellationReason": "OUT_OF_STOCK",
-  "cancellationNote": "Product no longer available from supplier",
-  "items": [
-    {
-      "productId": "prod_4102",
-      "productName": "Limited Edition Sneakers",
-      "sku": "LES-42-WHT",
-      "quantity": 1,
-      "unitPrice": 189.99
-    }
-  ],
-  "refundAmount": 189.99,
-  "currency": "USD",
-  "previousStatus": "confirmed",
-  "newStatus": "cancelled",
-  "metadata": {
-    "source": "system",
-    "correlationId": "corr_a9b8c7d6-5432-1098-fedc-ba9876543210",
-    "cancelledBy": "system",
-    "inventoryCheckId": "inv_chk_77201"
-  }
-}

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

@@ -1,54 +0,0 @@
----
-id: OrderCancelled
-name: Order cancelled
-version: 0.0.1
-summary: |
-  Indicates an order has been canceled
-owners:
-  - dboyne
-  - msmith
-badges:
-  - content: Recently updated!
-    backgroundColor: green
-    textColor: green
-  - content: 'Channel:Apache Kafka'
-    backgroundColor: yellow
-    textColor: yellow
-schemaPath: schema.json
----
-
-import Footer from '@catalog/components/footer.astro';
-
-## Overview
-
-The OrderCancelled event is triggered whenever an existing order is cancelled. This event ensures that all relevant services are notified of the cancellation, allowing them to take appropriate actions such as updating inventory levels, refunding payments, and notifying the user. The event helps maintain consistency across the system by ensuring all dependent services are aware of the order cancellation.
-
-## Example payload
-
-```json title="Example payload"
-{
-  "orderId": "123e4567-e89b-12d3-a456-426614174000",
-  "userId": "123e4567-e89b-12d3-a456-426614174000",
-  "orderItems": [
-    {
-      "productId": "789e1234-b56c-78d9-e012-3456789fghij",
-      "productName": "Example Product",
-      "quantity": 2,
-      "unitPrice": 29.99,
-      "totalPrice": 59.98
-    }
-  ],
-  "orderStatus": "cancelled",
-  "totalAmount": 59.98,
-  "cancellationReason": "Customer requested cancellation",
-  "timestamp": "2024-07-04T14:48:00Z"
-}
-```
-
-## Schema
-
-JSON schema for the event.
-
-<Schema title="JSON Schema" file="schema.json" />
-
-<Footer />

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

@@ -1,71 +0,0 @@
-{
-  "$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)."
-          }
-        },
-        "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."
-    }
-  },
-  "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "timestamp"],
-  "additionalProperties": false
-}

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/examples.config.yaml

@@ -1,15 +0,0 @@
-standard-order.json:
-  name: Standard Order
-  summary: A typical confirmed order with two items, standard shipping, and credit card payment.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @standard-order.json
-
-gift-order.json:
-  name: Gift Order
-  summary: A confirmed gift order with gift wrapping, a personal message, and express shipping.
-  usage: |
-    curl -X POST http://localhost:3000/api/events/publish \
-      -H "Content-Type: application/json" \
-      -d @gift-order.json