@eventcatalog/create-eventcatalog 4.2.2 → 4.2.3

package/dist/index.js

@@ -29808,7 +29808,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "4.2.2",
+  version: "4.2.3",
   bin: {
     "create-catalog": "./dist/index.js"
   },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "4.2.2",
+  "version": "4.2.3",
   "bin": {
     "create-catalog": "./dist/index.js"
   },

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+stock-increase.json:
+  name: Stock Increase
+  summary: Inventory increased after receiving a supplier delivery of 200 units at the east warehouse.
+  usage: |
+    curl -X POST http://localhost:3000/api/events/publish \
+      -H "Content-Type: application/json" \
+      -d @stock-increase.json
+
+stock-decrease.json:
+  name: Stock Decrease
+  summary: Inventory decreased by 3 units due to damaged goods identified during warehouse inspection.
+  usage: |
+    curl -X POST http://localhost:3000/api/events/publish \
+      -H "Content-Type: application/json" \
+      -d @stock-decrease.json

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/stock-decrease.json

@@ -0,0 +1,23 @@
+{
+  "eventId": "evt_8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d",
+  "eventType": "InventoryAdjusted",
+  "timestamp": "2025-11-17T14:22:09.587Z",
+  "adjustmentId": "adj_40355",
+  "productId": "prod_4102",
+  "productName": "Limited Edition Sneakers",
+  "sku": "LES-42-WHT",
+  "warehouseId": "wh_west_02",
+  "adjustmentType": "DECREASE",
+  "reason": "DAMAGED_GOODS",
+  "previousQuantity": 15,
+  "adjustedQuantity": 3,
+  "newQuantity": 12,
+  "unitCost": 85.0,
+  "currency": "USD",
+  "metadata": {
+    "source": "warehouse-system",
+    "correlationId": "corr_fedcba98-7654-3210-fedc-ba9876543210",
+    "inspectionReportId": "insp_71882",
+    "adjustedBy": "usr_wh_2011"
+  }
+}

package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/stock-increase.json

@@ -0,0 +1,23 @@
+{
+  "eventId": "evt_3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
+  "eventType": "InventoryAdjusted",
+  "timestamp": "2025-11-17T07:45:22.310Z",
+  "adjustmentId": "adj_40291",
+  "productId": "prod_1129",
+  "productName": "Wireless Bluetooth Headphones",
+  "sku": "WBH-400-BLK",
+  "warehouseId": "wh_east_01",
+  "adjustmentType": "INCREASE",
+  "reason": "SUPPLIER_DELIVERY",
+  "previousQuantity": 42,
+  "adjustedQuantity": 200,
+  "newQuantity": 242,
+  "unitCost": 22.5,
+  "currency": "USD",
+  "metadata": {
+    "source": "warehouse-system",
+    "correlationId": "corr_12345678-abcd-ef01-2345-6789abcdef01",
+    "purchaseOrderId": "po_20251117_003",
+    "receivedBy": "usr_wh_1044"
+  }
+}

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/examples/examples.config.yaml

@@ -0,0 +1,7 @@
+product-depleted.json:
+  name: Product Depleted
+  summary: A product reached zero stock after fulfilling an order, with 3 pending orders still affected.
+  usage: |
+    curl -X POST http://localhost:3000/api/events/publish \
+      -H "Content-Type: application/json" \
+      -d @product-depleted.json

package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/examples/product-depleted.json

@@ -0,0 +1,19 @@
+{
+  "eventId": "evt_4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
+  "eventType": "OutOfStock",
+  "timestamp": "2025-11-18T10:05:38.922Z",
+  "productId": "prod_4102",
+  "productName": "Limited Edition Sneakers",
+  "sku": "LES-42-WHT",
+  "warehouseId": "wh_west_02",
+  "previousQuantity": 1,
+  "currentQuantity": 0,
+  "lastSoldOrderId": "ord_86701",
+  "restockEstimate": null,
+  "affectedPendingOrders": 3,
+  "metadata": {
+    "source": "inventory-system",
+    "correlationId": "corr_aabbccdd-eeff-0011-2233-445566778899",
+    "triggeredBy": "order_fulfillment"
+  }
+}

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

@@ -0,0 +1,36 @@
+{
+  "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

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

@@ -0,0 +1,29 @@
+{
+  "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/OrderCancelled/examples/customer-request.json

@@ -0,0 +1,34 @@
+{
+  "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

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

@@ -0,0 +1,28 @@
+{
+  "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/OrderConfirmed/examples/examples.config.yaml

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

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/gift-order.json

@@ -0,0 +1,38 @@
+{
+  "eventId": "evt_7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f",
+  "eventType": "OrderConfirmed",
+  "timestamp": "2025-11-16T12:15:44.882Z",
+  "orderId": "ord_85412",
+  "userId": "usr_72019",
+  "items": [
+    {
+      "productId": "prod_6300",
+      "productName": "Scented Candle Gift Set",
+      "sku": "SCG-050-AST",
+      "quantity": 1,
+      "unitPrice": 59.99,
+      "lineTotal": 59.99
+    }
+  ],
+  "orderTotal": 65.98,
+  "currency": "USD",
+  "isGift": true,
+  "giftMessage": "Happy Birthday! Hope you enjoy these.",
+  "giftWrapping": true,
+  "giftWrappingCost": 5.99,
+  "shippingAddress": {
+    "line1": "305 Pine Lane",
+    "line2": "Suite 4",
+    "city": "Seattle",
+    "state": "WA",
+    "postalCode": "98101",
+    "country": "US"
+  },
+  "shippingMethod": "express",
+  "estimatedDelivery": "2025-11-18",
+  "paymentMethod": "paypal",
+  "metadata": {
+    "source": "mobile-app",
+    "correlationId": "corr_ffeeddcc-bbaa-9988-7766-554433221100"
+  }
+}

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/standard-order.json

@@ -0,0 +1,42 @@
+{
+  "eventId": "evt_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
+  "eventType": "OrderConfirmed",
+  "timestamp": "2025-11-16T08:30:12.654Z",
+  "orderId": "ord_85330",
+  "userId": "usr_61482",
+  "items": [
+    {
+      "productId": "prod_5210",
+      "productName": "USB-C Charging Cable 2m",
+      "sku": "UCC-200-WHT",
+      "quantity": 2,
+      "unitPrice": 14.99,
+      "lineTotal": 29.98
+    },
+    {
+      "productId": "prod_5211",
+      "productName": "Wireless Mouse",
+      "sku": "WM-300-BLK",
+      "quantity": 1,
+      "unitPrice": 34.99,
+      "lineTotal": 34.99
+    }
+  ],
+  "orderTotal": 64.97,
+  "currency": "USD",
+  "shippingAddress": {
+    "line1": "720 Elm Drive",
+    "line2": null,
+    "city": "Austin",
+    "state": "TX",
+    "postalCode": "73301",
+    "country": "US"
+  },
+  "shippingMethod": "standard",
+  "estimatedDelivery": "2025-11-21",
+  "paymentMethod": "credit_card",
+  "metadata": {
+    "source": "web",
+    "correlationId": "corr_11223344-5566-7788-99aa-bbccddeeff00"
+  }
+}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/address-not-found.json

@@ -0,0 +1,23 @@
+{
+  "eventId": "evt_df_60101",
+  "shipmentId": "shp_84201",
+  "orderId": "ord_10482",
+  "failedAt": "2026-03-14T14:30:00Z",
+  "carrier": "FedEx",
+  "trackingNumber": "FX7829041890",
+  "failureReason": "address_not_found",
+  "failureDetails": "Delivery address not found. The provided address does not match any known location.",
+  "deliveryAttempts": 1,
+  "destination": {
+    "line1": "999 Phantom Lane",
+    "city": "Denver",
+    "state": "CO",
+    "zipCode": "80201",
+    "country": "US"
+  },
+  "nextAction": "contact_customer",
+  "customer": {
+    "customerId": "cust_8901",
+    "email": "taylor.morgan@example.com"
+  }
+}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/customer-unavailable.json

@@ -0,0 +1,40 @@
+{
+  "eventId": "evt_df_60108",
+  "shipmentId": "shp_84305",
+  "orderId": "ord_10596",
+  "failedAt": "2026-03-15T17:45:00Z",
+  "carrier": "UPS",
+  "trackingNumber": "1Z9R8F030392850142",
+  "failureReason": "customer_unavailable",
+  "failureDetails": "Customer unavailable. Three delivery attempts were made with no response.",
+  "deliveryAttempts": 3,
+  "attemptHistory": [
+    {
+      "attempt": 1,
+      "timestamp": "2026-03-13T10:30:00Z",
+      "notes": "No answer at door"
+    },
+    {
+      "attempt": 2,
+      "timestamp": "2026-03-14T14:15:00Z",
+      "notes": "No answer at door, left notice"
+    },
+    {
+      "attempt": 3,
+      "timestamp": "2026-03-15T17:45:00Z",
+      "notes": "Final attempt, no answer"
+    }
+  ],
+  "destination": {
+    "line1": "310 Oak Avenue",
+    "city": "Seattle",
+    "state": "WA",
+    "zipCode": "98101",
+    "country": "US"
+  },
+  "nextAction": "return_to_warehouse",
+  "customer": {
+    "customerId": "cust_9340",
+    "email": "chris.baker@example.com"
+  }
+}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/damaged-in-transit.json

@@ -0,0 +1,33 @@
+{
+  "eventId": "evt_df_60115",
+  "shipmentId": "shp_84410",
+  "orderId": "ord_10703",
+  "failedAt": "2026-03-13T08:20:00Z",
+  "carrier": "FedEx",
+  "trackingNumber": "FX7829042104",
+  "failureReason": "damaged_in_transit",
+  "failureDetails": "Package damaged in transit. Item was returned to the warehouse for inspection.",
+  "deliveryAttempts": 0,
+  "damageReport": {
+    "reportId": "dmg_5501",
+    "severity": "major",
+    "description": "Outer packaging crushed, visible damage to contents",
+    "reportedBy": "warehouse_staff",
+    "photos": [
+      "https://cdn.shipping.example.com/damage-reports/dmg_5501_01.jpg",
+      "https://cdn.shipping.example.com/damage-reports/dmg_5501_02.jpg"
+    ]
+  },
+  "destination": {
+    "line1": "88 River Road",
+    "city": "Portland",
+    "state": "OR",
+    "zipCode": "97201",
+    "country": "US"
+  },
+  "nextAction": "reship_order",
+  "customer": {
+    "customerId": "cust_9412",
+    "email": "sam.nguyen@example.com"
+  }
+}

package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/examples.config.yaml

@@ -0,0 +1,23 @@
+address-not-found.json:
+  name: Address Not Found
+  summary: Delivery failed because the provided address could not be located by the carrier.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @address-not-found.json
+
+customer-unavailable.json:
+  name: Customer Unavailable
+  summary: Three delivery attempts were made but the customer was not available to receive the package.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @customer-unavailable.json
+
+damaged-in-transit.json:
+  name: Damaged in Transit
+  summary: Package was damaged during shipping and returned to the warehouse for inspection.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @damaged-in-transit.json

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/examples/defective-item.json

@@ -0,0 +1,33 @@
+{
+  "eventId": "evt_ret_70301",
+  "returnId": "ret_22010",
+  "shipmentId": "shp_88190",
+  "orderId": "ord_10450",
+  "initiatedAt": "2026-03-09T10:22:00Z",
+  "reason": "defective_item",
+  "reasonDetails": "Screen has a dead pixel cluster in the upper-left corner. Noticed after unboxing.",
+  "items": [
+    {
+      "itemId": "item_30291",
+      "sku": "ELEC-MON-27-4K",
+      "name": "27\" 4K Monitor",
+      "quantity": 1,
+      "pricePerUnit": 449.99
+    }
+  ],
+  "customer": {
+    "customerId": "cust_8842",
+    "email": "alex.rivera@example.com"
+  },
+  "returnMethod": "carrier_pickup",
+  "returnLabel": {
+    "carrier": "UPS",
+    "trackingNumber": "1Z9R8F030392811204",
+    "labelUrl": "https://cdn.shipping.example.com/return-labels/ret_22010.pdf"
+  },
+  "refundEstimate": {
+    "amount": 449.99,
+    "currency": "USD",
+    "method": "original_payment"
+  }
+}

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+defective-item.json:
+  name: Defective Item Return
+  summary: A return initiated for a defective monitor with a dead pixel, scheduled for carrier pickup with full refund.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @defective-item.json
+
+wrong-item.json:
+  name: Wrong Item Received
+  summary: A return initiated because the customer received the wrong product, with drop-off return and automatic reshipping.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @wrong-item.json

package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/examples/wrong-item.json

@@ -0,0 +1,51 @@
+{
+  "eventId": "evt_ret_70305",
+  "returnId": "ret_22014",
+  "shipmentId": "shp_88201",
+  "orderId": "ord_10468",
+  "initiatedAt": "2026-03-10T08:15:00Z",
+  "reason": "wrong_item",
+  "reasonDetails": "Ordered navy blue running shoes size 10, received black hiking boots size 11.",
+  "items": [
+    {
+      "itemId": "item_30310",
+      "sku": "SHOE-HIKE-BLK-11",
+      "name": "Trail Hiking Boots - Black (Size 11)",
+      "quantity": 1,
+      "pricePerUnit": 129.95
+    }
+  ],
+  "expectedItems": [
+    {
+      "sku": "SHOE-RUN-NVY-10",
+      "name": "Performance Running Shoes - Navy (Size 10)",
+      "quantity": 1
+    }
+  ],
+  "customer": {
+    "customerId": "cust_9103",
+    "email": "jamie.patel@example.com"
+  },
+  "returnMethod": "drop_off",
+  "dropOffLocations": [
+    {
+      "name": "UPS Store - Downtown",
+      "address": "142 Main St, Portland, OR 97201"
+    },
+    {
+      "name": "UPS Store - Mall",
+      "address": "8500 SE Sunnyside Rd, Portland, OR 97086"
+    }
+  ],
+  "returnLabel": {
+    "carrier": "UPS",
+    "trackingNumber": "1Z9R8F030392811280",
+    "labelUrl": "https://cdn.shipping.example.com/return-labels/ret_22014.pdf"
+  },
+  "refundEstimate": {
+    "amount": 129.95,
+    "currency": "USD",
+    "method": "original_payment"
+  },
+  "reshipping": true
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+single-package.json:
+  name: Single Package Shipment
+  summary: A new shipment created with a single package containing two books, shipped via standard USPS.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @single-package.json
+
+multi-package.json:
+  name: Multi-Package Shipment
+  summary: A new shipment created with two packages (monitor and peripherals) for express delivery via FedEx.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @multi-package.json