@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

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

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

@@ -1,51 +0,0 @@
-{
-  "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/ReturnInitiated/index.mdx

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

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

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

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

@@ -1,51 +0,0 @@
-{
-  "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/ShipmentCreated/index.mdx

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

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

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

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

@@ -1,31 +0,0 @@
-{
-  "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/ShipmentDelivered/index.mdx

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

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

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

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

@@ -1,32 +0,0 @@
-{
-  "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/ShipmentDispatched/index.mdx

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

@@ -1,17 +0,0 @@
-{
-  "$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/examples/domestic-transit.json

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

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