@eventcatalog/create-eventcatalog 4.2.2 → 4.2.4

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

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/examples/multi-package.json

@@ -0,0 +1,76 @@
+{
+  "eventId": "evt_sc_12005",
+  "shipmentId": "shp_88245",
+  "orderId": "ord_10558",
+  "createdAt": "2026-03-10T11:00:00Z",
+  "status": "created",
+  "customer": {
+    "customerId": "cust_9225",
+    "name": "David Kim",
+    "email": "david.kim@example.com"
+  },
+  "shippingAddress": {
+    "line1": "500 Technology Square",
+    "line2": "Apt 12B",
+    "city": "San Francisco",
+    "state": "CA",
+    "zipCode": "94105",
+    "country": "US"
+  },
+  "shippingMethod": "express",
+  "carrier": "FedEx",
+  "packages": [
+    {
+      "packageId": "pkg_44350",
+      "weightKg": 8.5,
+      "dimensions": {
+        "lengthCm": 60,
+        "widthCm": 45,
+        "heightCm": 35
+      },
+      "items": [
+        {
+          "itemId": "item_30420",
+          "sku": "ELEC-MON-32-4K",
+          "name": "32\" 4K Professional Monitor",
+          "quantity": 1
+        }
+      ],
+      "fragile": true
+    },
+    {
+      "packageId": "pkg_44351",
+      "weightKg": 3.2,
+      "dimensions": {
+        "lengthCm": 40,
+        "widthCm": 30,
+        "heightCm": 20
+      },
+      "items": [
+        {
+          "itemId": "item_30421",
+          "sku": "ELEC-KB-MECH-01",
+          "name": "Mechanical Keyboard",
+          "quantity": 1
+        },
+        {
+          "itemId": "item_30422",
+          "sku": "ELEC-MOUSE-ERG-01",
+          "name": "Ergonomic Wireless Mouse",
+          "quantity": 1
+        },
+        {
+          "itemId": "item_30423",
+          "sku": "ELEC-DOCK-USB-01",
+          "name": "USB-C Docking Station",
+          "quantity": 1
+        }
+      ]
+    }
+  ],
+  "estimatedDelivery": "2026-03-12T14:00:00Z",
+  "shippingCost": {
+    "amount": 24.99,
+    "currency": "USD"
+  }
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/examples/single-package.json

@@ -0,0 +1,51 @@
+{
+  "eventId": "evt_sc_12001",
+  "shipmentId": "shp_88240",
+  "orderId": "ord_10550",
+  "createdAt": "2026-03-10T07:30:00Z",
+  "status": "created",
+  "customer": {
+    "customerId": "cust_9210",
+    "name": "Emily Watson",
+    "email": "emily.watson@example.com"
+  },
+  "shippingAddress": {
+    "line1": "742 Evergreen Terrace",
+    "city": "Austin",
+    "state": "TX",
+    "zipCode": "73301",
+    "country": "US"
+  },
+  "shippingMethod": "standard",
+  "carrier": "USPS",
+  "packages": [
+    {
+      "packageId": "pkg_44320",
+      "weightKg": 1.2,
+      "dimensions": {
+        "lengthCm": 25,
+        "widthCm": 18,
+        "heightCm": 10
+      },
+      "items": [
+        {
+          "itemId": "item_30400",
+          "sku": "BOOK-PROG-TS-01",
+          "name": "Programming TypeScript",
+          "quantity": 1
+        },
+        {
+          "itemId": "item_30401",
+          "sku": "BOOK-PROG-RS-01",
+          "name": "The Rust Programming Language",
+          "quantity": 1
+        }
+      ]
+    }
+  ],
+  "estimatedDelivery": "2026-03-16T18:00:00Z",
+  "shippingCost": {
+    "amount": 5.99,
+    "currency": "USD"
+  }
+}

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

@@ -0,0 +1,15 @@
+front-door-delivery.json:
+  name: Front Door Delivery
+  summary: A standard delivery left at the customer's front door with photo proof of delivery.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @front-door-delivery.json
+
+signed-delivery.json:
+  name: Signed Delivery
+  summary: A delivery requiring recipient signature, hand-delivered and signed by the customer.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @signed-delivery.json

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/examples/front-door-delivery.json

@@ -0,0 +1,30 @@
+{
+  "eventId": "evt_del_40210",
+  "shipmentId": "shp_88214",
+  "orderId": "ord_10482",
+  "deliveredAt": "2026-03-14T11:42:00Z",
+  "carrier": "FedEx",
+  "trackingNumber": "FX7829041635",
+  "deliveryType": "front_door",
+  "signatureRequired": false,
+  "deliveryLocation": {
+    "type": "front_door",
+    "notes": "Left at front door per customer instructions"
+  },
+  "proofOfDelivery": {
+    "photoUrl": "https://cdn.shipping.example.com/delivery-photos/shp_88214.jpg",
+    "gpsCoordinates": {
+      "latitude": 42.3601,
+      "longitude": -71.0589
+    }
+  },
+  "recipient": {
+    "name": "Sarah Johnson",
+    "address": {
+      "city": "Boston",
+      "state": "MA",
+      "zipCode": "02101",
+      "country": "US"
+    }
+  }
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/examples/signed-delivery.json

@@ -0,0 +1,31 @@
+{
+  "eventId": "evt_del_40215",
+  "shipmentId": "shp_88220",
+  "orderId": "ord_10517",
+  "deliveredAt": "2026-03-12T15:08:00Z",
+  "carrier": "UPS",
+  "trackingNumber": "1Z9R8F030392847582",
+  "deliveryType": "signed",
+  "signatureRequired": true,
+  "deliveryLocation": {
+    "type": "hand_delivered",
+    "notes": "Signed by recipient at front door"
+  },
+  "proofOfDelivery": {
+    "signedBy": "Michael Chen",
+    "signatureUrl": "https://cdn.shipping.example.com/signatures/shp_88220.png",
+    "gpsCoordinates": {
+      "latitude": 40.7128,
+      "longitude": -74.006
+    }
+  },
+  "recipient": {
+    "name": "Michael Chen",
+    "address": {
+      "city": "New York",
+      "state": "NY",
+      "zipCode": "10001",
+      "country": "US"
+    }
+  }
+}

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

@@ -0,0 +1,15 @@
+standard-shipping.json:
+  name: Standard Shipping Dispatch
+  summary: A shipment dispatched via standard ground shipping from the East Coast warehouse to Boston.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @standard-shipping.json
+
+express-shipping.json:
+  name: Express Shipping Dispatch
+  summary: A high-priority express shipment dispatched for next-day delivery via UPS.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @express-shipping.json

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/examples/express-shipping.json

@@ -0,0 +1,33 @@
+{
+  "eventId": "evt_sd_29302",
+  "shipmentId": "shp_88215",
+  "orderId": "ord_10499",
+  "dispatchedAt": "2026-03-10T14:30:00Z",
+  "carrier": "UPS",
+  "trackingNumber": "1Z9R8F030392847561",
+  "shippingMethod": "express",
+  "estimatedDelivery": "2026-03-11T12:00:00Z",
+  "priority": true,
+  "warehouse": {
+    "id": "wh_central_03",
+    "name": "Central Fulfillment Hub",
+    "location": "Chicago, IL"
+  },
+  "destination": {
+    "city": "Minneapolis",
+    "state": "MN",
+    "zipCode": "55401",
+    "country": "US"
+  },
+  "packages": [
+    {
+      "packageId": "pkg_44210",
+      "weightKg": 0.8,
+      "dimensions": {
+        "lengthCm": 22,
+        "widthCm": 15,
+        "heightCm": 10
+      }
+    }
+  ]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/examples/standard-shipping.json

@@ -0,0 +1,32 @@
+{
+  "eventId": "evt_sd_29301",
+  "shipmentId": "shp_88214",
+  "orderId": "ord_10482",
+  "dispatchedAt": "2026-03-10T09:15:00Z",
+  "carrier": "FedEx",
+  "trackingNumber": "FX7829041635",
+  "shippingMethod": "standard",
+  "estimatedDelivery": "2026-03-15T18:00:00Z",
+  "warehouse": {
+    "id": "wh_east_01",
+    "name": "East Coast Distribution Center",
+    "location": "Newark, NJ"
+  },
+  "destination": {
+    "city": "Boston",
+    "state": "MA",
+    "zipCode": "02101",
+    "country": "US"
+  },
+  "packages": [
+    {
+      "packageId": "pkg_44102",
+      "weightKg": 2.3,
+      "dimensions": {
+        "lengthCm": 30,
+        "widthCm": 20,
+        "heightCm": 15
+      }
+    }
+  ]
+}

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/examples/domestic-transit.json

@@ -0,0 +1,48 @@
+{
+  "eventId": "evt_tr_55010",
+  "shipmentId": "shp_88214",
+  "orderId": "ord_10482",
+  "timestamp": "2026-03-12T06:20:00Z",
+  "carrier": "FedEx",
+  "trackingNumber": "FX7829041635",
+  "transitType": "domestic",
+  "currentLocation": {
+    "facility": "FedEx Ground Hub",
+    "city": "Hartford",
+    "state": "CT",
+    "country": "US",
+    "coordinates": {
+      "latitude": 41.7658,
+      "longitude": -72.6734
+    }
+  },
+  "origin": {
+    "city": "Newark",
+    "state": "NJ",
+    "country": "US"
+  },
+  "destination": {
+    "city": "Boston",
+    "state": "MA",
+    "country": "US"
+  },
+  "status": "in_transit",
+  "estimatedDelivery": "2026-03-15T18:00:00Z",
+  "transitHistory": [
+    {
+      "location": "Newark, NJ",
+      "status": "picked_up",
+      "timestamp": "2026-03-10T09:15:00Z"
+    },
+    {
+      "location": "Edison, NJ",
+      "status": "departed_facility",
+      "timestamp": "2026-03-10T22:00:00Z"
+    },
+    {
+      "location": "Hartford, CT",
+      "status": "arrived_at_facility",
+      "timestamp": "2026-03-12T06:20:00Z"
+    }
+  ]
+}

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

@@ -0,0 +1,15 @@
+domestic-transit.json:
+  name: Domestic Transit Update
+  summary: A shipment moving between facilities within the US, currently at a ground hub in Connecticut.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @domestic-transit.json
+
+international-transit.json:
+  name: International Transit Update
+  summary: An international shipment routed through London with customs clearance, en route from the US to Germany.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @international-transit.json

package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/examples/international-transit.json

@@ -0,0 +1,61 @@
+{
+  "eventId": "evt_tr_55018",
+  "shipmentId": "shp_88230",
+  "orderId": "ord_10534",
+  "timestamp": "2026-03-11T18:45:00Z",
+  "carrier": "DHL",
+  "trackingNumber": "DHL4829173650",
+  "transitType": "international",
+  "currentLocation": {
+    "facility": "DHL International Gateway",
+    "city": "London",
+    "country": "GB",
+    "coordinates": {
+      "latitude": 51.47,
+      "longitude": -0.4543
+    }
+  },
+  "origin": {
+    "city": "New York",
+    "state": "NY",
+    "country": "US"
+  },
+  "destination": {
+    "city": "Berlin",
+    "country": "DE"
+  },
+  "status": "in_transit",
+  "estimatedDelivery": "2026-03-16T14:00:00Z",
+  "customs": {
+    "status": "cleared",
+    "clearedAt": "2026-03-11T14:30:00Z",
+    "declarationNumber": "GB-CUS-2026-0384751"
+  },
+  "transitHistory": [
+    {
+      "location": "New York, US",
+      "status": "picked_up",
+      "timestamp": "2026-03-09T16:00:00Z"
+    },
+    {
+      "location": "JFK Airport, US",
+      "status": "departed_country",
+      "timestamp": "2026-03-10T02:30:00Z"
+    },
+    {
+      "location": "London Heathrow, GB",
+      "status": "arrived_at_hub",
+      "timestamp": "2026-03-11T10:15:00Z"
+    },
+    {
+      "location": "London, GB",
+      "status": "customs_cleared",
+      "timestamp": "2026-03-11T14:30:00Z"
+    },
+    {
+      "location": "London, GB",
+      "status": "in_transit_to_destination",
+      "timestamp": "2026-03-11T18:45:00Z"
+    }
+  ]
+}

package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/examples/check-flagged.json

@@ -0,0 +1,50 @@
+{
+  "eventId": "evt_fc_a7b8c9d0-7890-bcde-f012-345678901234",
+  "timestamp": "2024-03-16T19:05:50.219Z",
+  "type": "FraudCheckCompleted",
+  "source": "fraud-detection-service",
+  "data": {
+    "checkId": "chk_9e0f1a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
+    "assessmentId": "risk_4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
+    "paymentId": "pay_6f7a8b9c-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
+    "orderId": "ord_92860445",
+    "customerId": "cust_31207",
+    "result": "flagged",
+    "riskScore": 82,
+    "riskLevel": "high",
+    "checksPerformed": [
+      {
+        "name": "identity_verification",
+        "status": "passed",
+        "details": "Customer identity verified"
+      },
+      {
+        "name": "card_bin_check",
+        "status": "passed",
+        "details": "Card BIN matches issuing bank"
+      },
+      {
+        "name": "address_verification",
+        "status": "warning",
+        "details": "AVS returned partial match - postal code mismatch"
+      },
+      {
+        "name": "geolocation_check",
+        "status": "failed",
+        "details": "IP geolocation (Lagos, Nigeria) does not match billing country (US)"
+      },
+      {
+        "name": "impossible_travel_check",
+        "status": "failed",
+        "details": "Impossible travel detected between Portland, OR and Lagos in 2 hours"
+      }
+    ],
+    "processingTimeMs": 1205,
+    "fraudDetected": true,
+    "completedAt": "2024-03-16T19:05:50.219Z"
+  },
+  "metadata": {
+    "correlationId": "corr_11aa22bb-33cc-44dd-55ee-66ff77008899",
+    "modelVersion": "fraud-ml-v3.2.1"
+  }
+}

package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/examples/check-passed.json

@@ -0,0 +1,45 @@
+{
+  "eventId": "evt_fc_f6a7b8c9-6789-abcd-ef01-234567890123",
+  "timestamp": "2024-03-15T10:59:05.118Z",
+  "type": "FraudCheckCompleted",
+  "source": "fraud-detection-service",
+  "data": {
+    "checkId": "chk_3a4b5c6d-7e8f-9a0b-1c2d-3e4f5a6b7c8d",
+    "assessmentId": "risk_7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
+    "paymentId": "pay_4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
+    "orderId": "ord_92840123",
+    "customerId": "cust_10482",
+    "result": "passed",
+    "riskScore": 12,
+    "riskLevel": "low",
+    "checksPerformed": [
+      {
+        "name": "identity_verification",
+        "status": "passed",
+        "details": "Customer identity verified against government records"
+      },
+      {
+        "name": "card_bin_check",
+        "status": "passed",
+        "details": "Card BIN matches issuing bank in expected region"
+      },
+      {
+        "name": "address_verification",
+        "status": "passed",
+        "details": "AVS check returned full match on street and postal code"
+      },
+      {
+        "name": "velocity_check",
+        "status": "passed",
+        "details": "Transaction frequency within normal parameters"
+      }
+    ],
+    "processingTimeMs": 342,
+    "fraudDetected": false,
+    "completedAt": "2024-03-15T10:59:05.118Z"
+  },
+  "metadata": {
+    "correlationId": "corr_b2c3d4e5-f6a7-8901-bcde-f23456789012",
+    "modelVersion": "fraud-ml-v3.2.1"
+  }
+}

package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+check-passed.json:
+  name: Check Passed
+  summary: All fraud checks passed for a low-risk returning customer. Identity, card BIN, address, and velocity checks all cleared in 342ms.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @check-passed.json
+
+check-flagged.json:
+  name: Check Flagged
+  summary: Fraud check flagged due to geolocation mismatch and impossible travel detection. Address verification returned a partial match.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @check-flagged.json

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/card-declined.json

@@ -0,0 +1,38 @@
+{
+  "eventId": "evt_pf_8a3b1c9d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
+  "timestamp": "2024-03-15T14:23:47.892Z",
+  "type": "PaymentFailed",
+  "source": "payment-gateway-service",
+  "data": {
+    "paymentId": "pay_7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f",
+    "orderId": "ord_92847561",
+    "customerId": "cust_10482",
+    "amount": 249.99,
+    "currency": "USD",
+    "paymentMethod": {
+      "type": "credit_card",
+      "brand": "visa",
+      "last4": "4242",
+      "expiryMonth": 11,
+      "expiryYear": 2026
+    },
+    "failureReason": "card_declined",
+    "failureCode": "DECLINED_GENERIC",
+    "failureMessage": "The card was declined. Please contact your card issuer for more information.",
+    "gatewayResponse": {
+      "gatewayId": "gw_stripe",
+      "transactionId": "txn_3PqR5sT7uV9wX1y",
+      "responseCode": "05",
+      "avsCheck": "pass",
+      "cvvCheck": "pass"
+    },
+    "retryable": true,
+    "attemptNumber": 1,
+    "maxAttempts": 3
+  },
+  "metadata": {
+    "correlationId": "corr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+    "ipAddress": "192.168.1.42",
+    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
+  }
+}