@eventcatalog/create-eventcatalog 4.3.2 → 4.3.4-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +8 -4
- package/package.json +1 -1
- package/templates/amazon-api-gateway/README-template.md +45 -18
- package/templates/asyncapi/README-template.md +39 -31
- package/templates/confluent/README-template.md +45 -18
- package/templates/default/README-template.md +40 -31
- package/templates/default/_data/visualizer-layouts/domains-systems-context/catalog/1.0.0.json +31 -0
- package/templates/default/_data/visualizer-layouts/domains-systems-context/customer/1.0.0.json +23 -0
- package/templates/default/_data/visualizer-layouts/system-context-map/system-context-map/1.0.0.json +91 -0
- package/templates/default/_data/visualizer-layouts/systems-context/customer-management-system/1.0.0.json +23 -0
- package/templates/default/components/footer.astro +0 -1
- package/templates/default/domains/Catalog/entities/category/index.mdx +36 -0
- package/templates/default/domains/Catalog/entities/product/index.mdx +37 -0
- package/templates/default/domains/Catalog/entities/product-variant/index.mdx +35 -0
- package/templates/default/domains/Catalog/entities/search-document/index.mdx +35 -0
- package/templates/default/domains/Catalog/index.mdx +65 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/adrs/adr-001-use-transactional-outbox/index.mdx +43 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/adrs/adr-002-postgres-as-system-of-record/index.mdx +40 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/adrs/adr-003-offload-async-work-to-worker/index.mdx +41 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/containers/product-database/index.mdx +45 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/containers/product-database/schema.sql +33 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/index.mdx +72 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/commands/CreateProduct/index.mdx +32 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/commands/CreateProduct/schema.json +41 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/commands/DeleteProduct/index.mdx +32 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/commands/DeleteProduct/schema.json +19 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/commands/UpdateProduct/index.mdx +32 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/commands/UpdateProduct/schema.json +42 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductCreated/index.mdx +29 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductCreated/schema.json +62 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductDeleted/index.mdx +29 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductDeleted/schema.json +29 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductUpdated/index.mdx +29 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductUpdated/schema.json +55 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/index.mdx +69 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/openapi.yml +219 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/queries/GetProduct/index.mdx +32 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/queries/GetProduct/schema.json +56 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductSearchPublisher/index.mdx +56 -0
- package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductWorker/index.mdx +48 -0
- package/templates/default/domains/Catalog/systems/search-system/containers/search-index/index.mdx +39 -0
- package/templates/default/domains/Catalog/systems/search-system/flows/ProductSearchIndexing/index.mdx +130 -0
- package/templates/default/domains/Catalog/systems/search-system/index.mdx +66 -0
- package/templates/default/domains/Catalog/systems/search-system/services/SearchAPI/index.mdx +44 -0
- package/templates/default/domains/Catalog/systems/search-system/services/SearchAPI/openapi.yml +138 -0
- package/templates/default/domains/Catalog/systems/search-system/services/SearchAPI/queries/SearchProducts/index.mdx +32 -0
- package/templates/default/domains/Catalog/systems/search-system/services/SearchAPI/queries/SearchProducts/schema.json +108 -0
- package/templates/default/domains/Catalog/systems/search-system/services/SearchIndexer/index.mdx +54 -0
- package/templates/default/domains/Catalog/ubiquitous-language.mdx +54 -0
- package/templates/default/domains/Customer/entities/authentication-session/index.mdx +35 -0
- package/templates/default/domains/Customer/entities/customer-account/index.mdx +36 -0
- package/templates/default/domains/Customer/entities/customer-address/index.mdx +35 -0
- package/templates/default/domains/Customer/entities/customer-profile/index.mdx +33 -0
- package/templates/default/domains/Customer/index.mdx +67 -0
- package/templates/default/domains/Customer/systems/customer-management-system/containers/customer-database/index.mdx +43 -0
- package/templates/default/domains/Customer/systems/customer-management-system/containers/customer-database/schema.sql +14 -0
- package/templates/default/domains/Customer/systems/customer-management-system/index.mdx +60 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/RegisterCustomer/index.mdx +32 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/RegisterCustomer/schema.json +24 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/UpdateCustomer/index.mdx +32 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/UpdateCustomer/schema.json +29 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerRegistered/index.mdx +29 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerRegistered/schema.json +45 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerUpdated/index.mdx +29 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerUpdated/schema.json +42 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/index.mdx +72 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/openapi.yml +164 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/queries/GetCustomer/index.mdx +32 -0
- package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/queries/GetCustomer/schema.json +47 -0
- package/templates/default/domains/Customer/systems/identity-provider/containers/user-directory/index.mdx +36 -0
- package/templates/default/domains/Customer/systems/identity-provider/index.mdx +54 -0
- package/templates/default/domains/Customer/systems/identity-provider/services/OAuthAPI/commands/AuthenticateCustomer/index.mdx +32 -0
- package/templates/default/domains/Customer/systems/identity-provider/services/OAuthAPI/commands/AuthenticateCustomer/schema.json +41 -0
- package/templates/default/domains/Customer/systems/identity-provider/services/OAuthAPI/events/CustomerAuthenticated/index.mdx +29 -0
- package/templates/default/domains/Customer/systems/identity-provider/services/OAuthAPI/events/CustomerAuthenticated/schema.json +33 -0
- package/templates/default/domains/Customer/systems/identity-provider/services/OAuthAPI/index.mdx +59 -0
- package/templates/default/domains/Customer/ubiquitous-language.mdx +48 -0
- package/templates/default/domains/Fulfilment/entities/inventory-reservation/index.mdx +39 -0
- package/templates/default/domains/Fulfilment/entities/shipment/index.mdx +36 -0
- package/templates/default/domains/Fulfilment/entities/stock-item/index.mdx +36 -0
- package/templates/default/domains/Fulfilment/entities/warehouse-pick/index.mdx +35 -0
- package/templates/default/domains/Fulfilment/index.mdx +83 -0
- package/templates/default/domains/Fulfilment/systems/carrier/index.mdx +52 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierShippingAPI/index.mdx +40 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierTrackingAPI/events/ShipmentCreated/index.mdx +29 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierTrackingAPI/events/ShipmentCreated/schema.json +15 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierTrackingAPI/events/ShipmentDelivered/index.mdx +29 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierTrackingAPI/events/ShipmentDelivered/schema.json +13 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierTrackingAPI/events/ShipmentFailed/index.mdx +29 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierTrackingAPI/events/ShipmentFailed/schema.json +16 -0
- package/templates/default/domains/Fulfilment/systems/carrier/services/CarrierTrackingAPI/index.mdx +44 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/containers/inventory-database/index.mdx +35 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/containers/inventory-database/schema.sql +26 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/index.mdx +49 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/commands/ReleaseInventory/index.mdx +32 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/commands/ReleaseInventory/schema.json +14 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/events/InventoryReserved/index.mdx +29 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/events/InventoryReserved/schema.json +24 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/events/InventoryUnavailable/index.mdx +29 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/events/InventoryUnavailable/schema.json +24 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/index.mdx +67 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/queries/GetStockLevel/index.mdx +32 -0
- package/templates/default/domains/Fulfilment/systems/inventory-system/services/InventoryService/queries/GetStockLevel/schema.json +25 -0
- package/templates/default/domains/Fulfilment/systems/shipping-system/index.mdx +47 -0
- package/templates/default/domains/Fulfilment/systems/shipping-system/services/CarrierAdapter/commands/CreateShipment/index.mdx +32 -0
- package/templates/default/domains/Fulfilment/systems/shipping-system/services/CarrierAdapter/commands/CreateShipment/schema.json +26 -0
- package/templates/default/domains/Fulfilment/systems/shipping-system/services/CarrierAdapter/index.mdx +40 -0
- package/templates/default/domains/Fulfilment/systems/shipping-system/services/ShippingAPI/index.mdx +40 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/containers/warehouse-database/index.mdx +35 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/containers/warehouse-database/schema.sql +21 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/index.mdx +53 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/services/PickingWorker/events/OrderPacked/index.mdx +29 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/services/PickingWorker/events/OrderPacked/schema.json +13 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/services/PickingWorker/index.mdx +44 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/services/WarehouseService/events/OrderReadyForShipping/index.mdx +29 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/services/WarehouseService/events/OrderReadyForShipping/schema.json +23 -0
- package/templates/default/domains/Fulfilment/systems/warehouse-system/services/WarehouseService/index.mdx +53 -0
- package/templates/default/domains/Fulfilment/ubiquitous-language.mdx +44 -0
- package/templates/default/domains/Ordering/entities/checkout-session/index.mdx +36 -0
- package/templates/default/domains/Ordering/entities/order/index.mdx +36 -0
- package/templates/default/domains/Ordering/entities/order-line/index.mdx +38 -0
- package/templates/default/domains/Ordering/entities/order-status-history/index.mdx +35 -0
- package/templates/default/domains/Ordering/flows/PlaceAnOrder/index.mdx +158 -0
- package/templates/default/domains/Ordering/index.mdx +70 -0
- package/templates/default/domains/Ordering/systems/checkout-system/flows/CheckoutSaga/index.mdx +101 -0
- package/templates/default/domains/Ordering/systems/checkout-system/index.mdx +57 -0
- package/templates/default/domains/Ordering/systems/checkout-system/services/CheckoutAPI/index.mdx +53 -0
- package/templates/default/domains/Ordering/systems/checkout-system/services/CheckoutOrchestrator/commands/AuthorizePayment/index.mdx +32 -0
- package/templates/default/domains/Ordering/systems/checkout-system/services/CheckoutOrchestrator/commands/AuthorizePayment/schema.json +29 -0
- package/templates/default/domains/Ordering/systems/checkout-system/services/CheckoutOrchestrator/commands/ReserveInventory/index.mdx +32 -0
- package/templates/default/domains/Ordering/systems/checkout-system/services/CheckoutOrchestrator/commands/ReserveInventory/schema.json +37 -0
- package/templates/default/domains/Ordering/systems/checkout-system/services/CheckoutOrchestrator/index.mdx +59 -0
- package/templates/default/domains/Ordering/systems/order-management-system/containers/order-database/index.mdx +39 -0
- package/templates/default/domains/Ordering/systems/order-management-system/containers/order-database/schema.sql +24 -0
- package/templates/default/domains/Ordering/systems/order-management-system/flows/OrderCancellation/index.mdx +105 -0
- package/templates/default/domains/Ordering/systems/order-management-system/index.mdx +53 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/asyncapi.yml +233 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/commands/CancelOrder/index.mdx +32 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/commands/CancelOrder/schema.json +19 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/commands/CreateOrder/index.mdx +32 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/commands/CreateOrder/schema.json +55 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/events/OrderCancelled/index.mdx +29 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/events/OrderCancelled/schema.json +25 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/events/OrderCompleted/index.mdx +29 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/events/OrderCompleted/schema.json +21 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/events/OrderCreated/index.mdx +29 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/events/OrderCreated/schema.json +29 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/index.mdx +74 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/queries/GetOrder/index.mdx +32 -0
- package/templates/default/domains/Ordering/systems/order-management-system/services/OrderService/queries/GetOrder/schema.json +64 -0
- package/templates/default/domains/Ordering/ubiquitous-language.mdx +53 -0
- package/templates/default/domains/Payments/entities/fraud-check/index.mdx +39 -0
- package/templates/default/domains/Payments/entities/payment/index.mdx +36 -0
- package/templates/default/domains/Payments/entities/payment-authorization/index.mdx +35 -0
- package/templates/default/domains/Payments/entities/refund/index.mdx +36 -0
- package/templates/default/domains/Payments/index.mdx +69 -0
- package/templates/default/domains/Payments/systems/fraud-detection/index.mdx +49 -0
- package/templates/default/domains/Payments/systems/fraud-detection/services/FraudAPI/events/FraudCheckFailed/index.mdx +29 -0
- package/templates/default/domains/Payments/systems/fraud-detection/services/FraudAPI/events/FraudCheckFailed/schema.json +22 -0
- package/templates/default/domains/Payments/systems/fraud-detection/services/FraudAPI/events/FraudCheckPassed/index.mdx +29 -0
- package/templates/default/domains/Payments/systems/fraud-detection/services/FraudAPI/events/FraudCheckPassed/schema.json +18 -0
- package/templates/default/domains/Payments/systems/fraud-detection/services/FraudAPI/index.mdx +51 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/containers/payment-database/index.mdx +39 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/containers/payment-database/schema.sql +25 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/index.mdx +53 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/services/PaymentAPI/index.mdx +51 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/services/PaymentWorker/events/PaymentRequested/index.mdx +29 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/services/PaymentWorker/events/PaymentRequested/schema.json +19 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/services/PaymentWorker/events/RefundRequested/index.mdx +29 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/services/PaymentWorker/events/RefundRequested/schema.json +20 -0
- package/templates/default/domains/Payments/systems/payment-processing-system/services/PaymentWorker/index.mdx +66 -0
- package/templates/default/domains/Payments/systems/stripe/index.mdx +52 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripePaymentsAPI/index.mdx +42 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripeWebhookEndpoint/events/PaymentFailed/index.mdx +29 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripeWebhookEndpoint/events/PaymentFailed/schema.json +16 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripeWebhookEndpoint/events/PaymentSucceeded/index.mdx +29 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripeWebhookEndpoint/events/PaymentSucceeded/schema.json +15 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripeWebhookEndpoint/events/RefundProcessed/index.mdx +29 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripeWebhookEndpoint/events/RefundProcessed/schema.json +14 -0
- package/templates/default/domains/Payments/systems/stripe/services/StripeWebhookEndpoint/index.mdx +44 -0
- package/templates/default/domains/Payments/ubiquitous-language.mdx +41 -0
- package/templates/default/domains/Reviews/asyncapi.yml +181 -0
- package/templates/default/domains/Reviews/containers/rating-cache/index.mdx +29 -0
- package/templates/default/domains/Reviews/containers/review-database/index.mdx +33 -0
- package/templates/default/domains/Reviews/entities/moderation-decision/index.mdx +38 -0
- package/templates/default/domains/Reviews/entities/rating-summary/index.mdx +35 -0
- package/templates/default/domains/Reviews/entities/review/index.mdx +63 -0
- package/templates/default/domains/Reviews/entities/review-flag/index.mdx +35 -0
- package/templates/default/domains/Reviews/entities/review-vote/index.mdx +38 -0
- package/templates/default/domains/Reviews/flows/review-submission/index.mdx +120 -0
- package/templates/default/domains/Reviews/index.mdx +93 -0
- package/templates/default/domains/Reviews/openapi.yml +209 -0
- package/templates/default/domains/Reviews/services/RatingAggregator/events/rating-updated/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/RatingAggregator/events/rating-updated/schema.json +12 -0
- package/templates/default/domains/Reviews/services/RatingAggregator/index.mdx +47 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/commands/flag-review/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/commands/flag-review/schema.json +13 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/commands/submit-review/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/commands/submit-review/schema.json +15 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/commands/vote-review-helpful/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/commands/vote-review-helpful/schema.json +12 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/events/review-flagged/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/events/review-flagged/schema.json +13 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/events/review-helpful-voted/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/events/review-helpful-voted/schema.json +12 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/events/review-submitted/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/events/review-submitted/schema.json +15 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/index.mdx +58 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/queries/get-product-reviews/index.mdx +24 -0
- package/templates/default/domains/Reviews/services/ReviewAPI/queries/get-product-reviews/schema.json +12 -0
- package/templates/default/domains/Reviews/services/ReviewModerationWorker/events/review-published/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewModerationWorker/events/review-published/schema.json +13 -0
- package/templates/default/domains/Reviews/services/ReviewModerationWorker/events/review-rejected/index.mdx +29 -0
- package/templates/default/domains/Reviews/services/ReviewModerationWorker/events/review-rejected/schema.json +12 -0
- package/templates/default/domains/Reviews/services/ReviewModerationWorker/index.mdx +50 -0
- package/templates/default/domains/Shopping/entities/cart/index.mdx +40 -0
- package/templates/default/domains/Shopping/entities/cart-item/index.mdx +38 -0
- package/templates/default/domains/Shopping/entities/discount/index.mdx +35 -0
- package/templates/default/domains/Shopping/entities/promotion/index.mdx +40 -0
- package/templates/default/domains/Shopping/index.mdx +67 -0
- package/templates/default/domains/Shopping/systems/cart-system/containers/cart-database/index.mdx +39 -0
- package/templates/default/domains/Shopping/systems/cart-system/containers/cart-database/schema.sql +22 -0
- package/templates/default/domains/Shopping/systems/cart-system/index.mdx +53 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/AddItemToCart/index.mdx +32 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/AddItemToCart/schema.json +25 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/CheckoutCart/index.mdx +32 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/CheckoutCart/schema.json +23 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/RemoveItemFromCart/index.mdx +32 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/RemoveItemFromCart/schema.json +24 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/events/CartCheckedOut/index.mdx +29 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/events/CartCheckedOut/schema.json +62 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/index.mdx +72 -0
- package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/openapi.yml +200 -0
- package/templates/default/domains/Shopping/systems/promotion-system/containers/promotion-database/index.mdx +40 -0
- package/templates/default/domains/Shopping/systems/promotion-system/containers/promotion-database/schema.sql +21 -0
- package/templates/default/domains/Shopping/systems/promotion-system/index.mdx +48 -0
- package/templates/default/domains/Shopping/systems/promotion-system/services/PromotionService/commands/CalculateDiscount/index.mdx +32 -0
- package/templates/default/domains/Shopping/systems/promotion-system/services/PromotionService/commands/CalculateDiscount/schema.json +53 -0
- package/templates/default/domains/Shopping/systems/promotion-system/services/PromotionService/events/DiscountCalculated/index.mdx +29 -0
- package/templates/default/domains/Shopping/systems/promotion-system/services/PromotionService/events/DiscountCalculated/schema.json +37 -0
- package/templates/default/domains/Shopping/systems/promotion-system/services/PromotionService/index.mdx +59 -0
- package/templates/default/domains/Shopping/ubiquitous-language.mdx +48 -0
- package/templates/default/eventcatalog.config.js +13 -0
- package/templates/default/pages/homepage.astro +109 -0
- package/templates/default/public/icons/analytics/clickhouse.svg +1 -0
- package/templates/default/public/icons/cache/redis.svg +1 -0
- package/templates/default/public/icons/database/postgresql.svg +1 -0
- package/templates/default/public/icons/languages/go.svg +1 -0
- package/templates/default/public/icons/languages/java.svg +1 -0
- package/templates/default/public/icons/languages/nodejs.svg +1 -0
- package/templates/default/public/icons/payments/stripe.svg +1 -0
- package/templates/default/teams/customer-platform.mdx +18 -0
- package/templates/default/teams/fulfilment-platform.mdx +20 -0
- package/templates/default/teams/ordering-platform.mdx +18 -0
- package/templates/default/teams/payments-platform.mdx +18 -0
- package/templates/default/teams/product-platform.mdx +20 -0
- package/templates/default/teams/reviews-platform.mdx +20 -0
- package/templates/default/teams/search-platform.mdx +19 -0
- package/templates/default/teams/shopping-platform.mdx +18 -0
- package/templates/default/users/dboyne.mdx +1 -1
- package/templates/empty/README-template.md +39 -31
- package/templates/eventbridge/README-template.md +44 -17
- package/templates/graphql/README-template.md +39 -31
- package/templates/index.ts +1 -0
- package/templates/openapi/README-template.md +37 -33
- package/templates/default/channels/inventory.{env}.events/index.mdx +0 -159
- package/templates/default/channels/orders.{env}.events/index.mdx +0 -85
- package/templates/default/channels/payment.{env}.events/index.mdx +0 -89
- package/templates/default/domains/E-Commerce/index.mdx +0 -140
- package/templates/default/domains/E-Commerce/ubiquitous-language.mdx +0 -87
- package/templates/default/domains/Orders/changelog.mdx +0 -7
- package/templates/default/domains/Orders/entities/CartItem/index.mdx +0 -124
- package/templates/default/domains/Orders/entities/Customer/index.mdx +0 -59
- package/templates/default/domains/Orders/entities/Order/index.mdx +0 -98
- package/templates/default/domains/Orders/entities/OrderItem/index.mdx +0 -62
- package/templates/default/domains/Orders/entities/ShoppingCart/index.mdx +0 -151
- package/templates/default/domains/Orders/index.mdx +0 -117
- package/templates/default/domains/Orders/services/InventoryService/changelog.mdx +0 -7
- package/templates/default/domains/Orders/services/InventoryService/channels/inventory-dlq/index.mdx +0 -13
- package/templates/default/domains/Orders/services/InventoryService/channels/inventory-queue/index.mdx +0 -13
- package/templates/default/domains/Orders/services/InventoryService/commands/AddInventory/index.mdx +0 -45
- package/templates/default/domains/Orders/services/InventoryService/commands/AddInventory/schema.json +0 -28
- package/templates/default/domains/Orders/services/InventoryService/commands/PlaceOrder/index.mdx +0 -34
- package/templates/default/domains/Orders/services/InventoryService/commands/PlaceOrder/schema.json +0 -124
- package/templates/default/domains/Orders/services/InventoryService/commands/UpdateInventory/index.mdx +0 -47
- package/templates/default/domains/Orders/services/InventoryService/commands/UpdateInventory/schema.json +0 -28
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/changelog.mdx +0 -67
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/stock-decrease.json +0 -23
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/examples/stock-increase.json +0 -23
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/index.mdx +0 -124
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/schema.avro +0 -13
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/schema.json +0 -35
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/changelog.mdx +0 -26
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/index.mdx +0 -23
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/schema.avro +0 -9
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/0.0.1/schema.json +0 -36
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/changelog.mdx +0 -26
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/index.mdx +0 -108
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/schema.avro +0 -10
- package/templates/default/domains/Orders/services/InventoryService/events/InventoryAdjusted/versioned/1.0.0/schema.json +0 -36
- package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/examples/examples.config.yaml +0 -7
- package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/examples/product-depleted.json +0 -19
- package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/index.mdx +0 -102
- package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/schema.json +0 -28
- package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1/index.mdx +0 -98
- package/templates/default/domains/Orders/services/InventoryService/events/OutOfStock/versioned/0.0.1/schema.json +0 -28
- package/templates/default/domains/Orders/services/InventoryService/index.mdx +0 -120
- package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryList/index.mdx +0 -22
- package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryList/schema.json +0 -52
- package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryStatus/index.mdx +0 -40
- package/templates/default/domains/Orders/services/InventoryService/queries/GetInventoryStatus/schema.json +0 -27
- package/templates/default/domains/Orders/services/InventoryService/versioned/0.0.1/index.mdx +0 -52
- package/templates/default/domains/Orders/services/NotificationService/index.mdx +0 -82
- package/templates/default/domains/Orders/services/NotificationService/queries/GetNotificationDetails/index.mdx +0 -26
- package/templates/default/domains/Orders/services/NotificationService/queries/GetNotificationDetails/schema.json +0 -55
- package/templates/default/domains/Orders/services/NotificationService/queries/GetUserNotifications/index.mdx +0 -26
- package/templates/default/domains/Orders/services/NotificationService/queries/GetUserNotifications/schema.json +0 -46
- package/templates/default/domains/Orders/services/OrdersService/changelog.mdx +0 -3
- package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/examples/address-change.json +0 -36
- package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/examples/quantity-change.json +0 -29
- package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/index.mdx +0 -58
- package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/schema.avro +0 -75
- package/templates/default/domains/Orders/services/OrdersService/events/OrderAmended/schema.json +0 -70
- package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/examples/customer-request.json +0 -34
- package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/examples/out-of-stock.json +0 -28
- package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/index.mdx +0 -54
- package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/schema.json +0 -71
- package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/gift-order.json +0 -38
- package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/examples/standard-order.json +0 -42
- package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/index.mdx +0 -55
- package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/schema.json +0 -66
- package/templates/default/domains/Orders/services/OrdersService/index.mdx +0 -81
- package/templates/default/domains/Orders/services/OrdersService/openapi.yml +0 -185
- package/templates/default/domains/Orders/services/OrdersService/order-service-asyncapi.yaml +0 -148
- package/templates/default/domains/Orders/services/OrdersService/queries/GetOrder/index.mdx +0 -26
- package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/changelog.mdx +0 -3
- package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/index.mdx +0 -40
- package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/openapi.yml +0 -96
- package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/order-service-asyncapi.yaml +0 -148
- package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/schema.json +0 -13
- package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/schema.json +0 -19
- package/templates/default/domains/Orders/services/ShippingService/commands/CreateShipment/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/commands/CreateShipment/schema.json +0 -62
- package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/commands/UpdateShipmentStatus/schema.json +0 -29
- package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/address-not-found.json +0 -23
- package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/customer-unavailable.json +0 -40
- package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/damaged-in-transit.json +0 -33
- package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/examples/examples.config.yaml +0 -23
- package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/events/DeliveryFailed/schema.json +0 -17
- package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/examples/defective-item.json +0 -33
- package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/examples/wrong-item.json +0 -51
- package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/events/ReturnInitiated/schema.json +0 -17
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/examples/multi-package.json +0 -76
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/examples/single-package.json +0 -51
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentCreated/schema.json +0 -64
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/examples/front-door-delivery.json +0 -30
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/examples/signed-delivery.json +0 -31
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDelivered/schema.json +0 -17
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/examples/express-shipping.json +0 -33
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/examples/standard-shipping.json +0 -32
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentDispatched/schema.json +0 -17
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/examples/domestic-transit.json +0 -48
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/examples/international-transit.json +0 -61
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/index.mdx +0 -22
- package/templates/default/domains/Orders/services/ShippingService/events/ShipmentInTransit/schema.json +0 -17
- package/templates/default/domains/Orders/services/ShippingService/index.mdx +0 -61
- package/templates/default/domains/Orders/ubiquitous-language.mdx +0 -127
- package/templates/default/domains/Orders/versioned/0.0.1/index.mdx +0 -21
- package/templates/default/domains/Orders/versioned/0.0.2/index.mdx +0 -50
- package/templates/default/domains/Payment/entities/Address/index.mdx +0 -165
- package/templates/default/domains/Payment/entities/Invoice/index.mdx +0 -92
- package/templates/default/domains/Payment/entities/Payment/index.mdx +0 -140
- package/templates/default/domains/Payment/entities/PaymentMethod/index.mdx +0 -80
- package/templates/default/domains/Payment/entities/Transaction/index.mdx +0 -80
- package/templates/default/domains/Payment/flows/PaymentProcessed/index.mdx +0 -82
- package/templates/default/domains/Payment/index.mdx +0 -40
- package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/examples/check-flagged.json +0 -50
- package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/examples/check-passed.json +0 -45
- package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/index.mdx +0 -50
- package/templates/default/domains/Payment/services/FraudDetectionService/events/FraudCheckCompleted/schema.json +0 -44
- package/templates/default/domains/Payment/services/FraudDetectionService/index.mdx +0 -62
- package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/index.mdx +0 -75
- package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/schema.json +0 -58
- package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/card-declined.json +0 -38
- package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/examples.config.yaml +0 -23
- package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/expired-card.json +0 -38
- package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/examples/insufficient-funds.json +0 -38
- package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/index.mdx +0 -64
- package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/schema.json +0 -68
- package/templates/default/domains/Payment/services/PaymentGatewayService/index.mdx +0 -71
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/express-checkout.json +0 -45
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/standard-checkout.json +0 -52
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/index.mdx +0 -37
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/schema.json +0 -31
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/examples/international-payment.json +0 -48
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/examples/successful-payment.json +0 -48
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/index.mdx +0 -43
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/schema.json +0 -54
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/index.mdx +0 -43
- package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/schema.json +0 -54
- package/templates/default/domains/Payment/services/PaymentService/index.mdx +0 -41
- package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/index.mdx +0 -26
- package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/schema.json +0 -39
- package/templates/default/domains/Payment/ubiquitous-language.mdx +0 -96
- package/templates/default/domains/ProductCatalog/entities/Category/index.mdx +0 -127
- package/templates/default/domains/ProductCatalog/entities/Inventory/index.mdx +0 -119
- package/templates/default/domains/ProductCatalog/entities/Product/index.mdx +0 -118
- package/templates/default/domains/ProductCatalog/entities/Review/index.mdx +0 -157
- package/templates/default/domains/ProductCatalog/index.mdx +0 -73
- package/templates/default/domains/ProductCatalog/ubiquitous-language.mdx +0 -88
- package/templates/default/domains/Subscriptions/entities/BillingProfile/index.mdx +0 -71
- package/templates/default/domains/Subscriptions/entities/SubscriptionPeriod/index.mdx +0 -76
- package/templates/default/domains/Subscriptions/flows/CancelSubscription/SubscriptionRenewed/index.mdx +0 -300
- package/templates/default/domains/Subscriptions/flows/CancelSubscription/index.mdx +0 -69
- package/templates/default/domains/Subscriptions/flows/CancelSubscription/versioned/0.0.1/index.mdx +0 -51
- package/templates/default/domains/Subscriptions/index.mdx +0 -35
- package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/examples/examples.config.yaml +0 -7
- package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/examples/upcoming-renewal.json +0 -28
- package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/index.mdx +0 -63
- package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/schema.json +0 -54
- package/templates/default/domains/Subscriptions/services/BillingService/index.mdx +0 -83
- package/templates/default/domains/Subscriptions/services/PlanManagementService/index.mdx +0 -83
- package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/index.mdx +0 -26
- package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/CancelSubscription/schema.json +0 -30
- package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/SubscribeUser/index.mdx +0 -26
- package/templates/default/domains/Subscriptions/services/SubscriptionService/commands/SubscribeUser/schema.json +0 -31
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/payment-failure.json +0 -25
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/voluntary-cancellation.json +0 -23
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/index.mdx +0 -26
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/schema.json +0 -35
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/annual-plan.json +0 -26
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/examples.config.yaml +0 -15
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/monthly-plan.json +0 -25
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/index.mdx +0 -26
- package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/schema.json +0 -36
- package/templates/default/domains/Subscriptions/services/SubscriptionService/index.mdx +0 -62
- package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/index.mdx +0 -26
- package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/schema.json +0 -54
- package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/versioned/0.0.1/index.mdx +0 -26
- package/templates/default/domains/Subscriptions/services/SubscriptionService/queries/GetSubscriptionStatus/versioned/0.0.1/schema.json +0 -54
- package/templates/default/domains/Subscriptions/ubiquitous-language.mdx +0 -129
- package/templates/default/teams/full-stack.mdx +0 -26
- package/templates/default/teams/mobile-devs.mdx +0 -23
- package/templates/default/users/aSmith.mdx +0 -27
- package/templates/default/users/mSmith.mdx +0 -9
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
id: dboyne
|
|
3
3
|
name: David Boyne
|
|
4
|
-
summary: Tech Lead of the Full Stackers team
|
|
5
4
|
avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png'
|
|
6
5
|
role: Lead developer
|
|
7
6
|
email: test@test.com
|
|
8
7
|
slackDirectMessageUrl: https://yourteam.slack.com/channels/boyney123
|
|
8
|
+
msTeamsDirectMessageUrl: https://teams.microsoft.com/l/chat/0/0?users=test@test.com
|
|
9
9
|
---
|
|
10
10
|
|
|
11
11
|
Hello! I'm David Boyne, the Tech Lead of an amazing team called Full Stackers. With a passion for building robust and scalable systems, I specialize in designing and implementing event-driven architectures that power modern, responsive applications.
|
|
@@ -1,55 +1,63 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Welcome to EventCatalog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Start the Catalog
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
8
|
npm run dev
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
Open [http://localhost:3000](http://localhost:3000) to
|
|
11
|
+
Open [http://localhost:3000](http://localhost:3000) to view your catalog.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Edit Your Catalog
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
- **Map events, commands & queries** — capture every message flowing through your system
|
|
19
|
-
- **Organize with domains** — group resources into bounded contexts
|
|
20
|
-
- **Visualize your architecture** — auto-generated diagrams of your services and message flows
|
|
21
|
-
- **Version everything** — track how your architecture evolves over time
|
|
22
|
-
- **Use AI to explore & document** — connect AI tools directly to your catalog
|
|
17
|
+
Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
|
|
23
18
|
|
|
24
|
-
|
|
19
|
+
Good places to start:
|
|
25
20
|
|
|
26
|
-
|
|
21
|
+
- `domains/` - bounded contexts, business capabilities, and ownership
|
|
22
|
+
- `domains/<domain>/services/` - services, APIs, and message producers or consumers
|
|
23
|
+
- `events/`, `commands/`, and `queries/` - the messages flowing through your system
|
|
24
|
+
- `teams/` and `users/` - who owns each part of the architecture
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
28
|
+
## Make Your First Change
|
|
29
|
+
|
|
30
|
+
1. Add or edit a domain, service, or message.
|
|
31
|
+
2. Run `npm run dev` and check the generated pages and diagrams.
|
|
32
|
+
3. Commit the MDX and schema files to Git.
|
|
33
|
+
|
|
34
|
+
## Keep It in Sync
|
|
33
35
|
|
|
34
|
-
|
|
36
|
+
Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
|
|
35
37
|
|
|
36
|
-
|
|
38
|
+
Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
|
|
37
39
|
|
|
38
|
-
|
|
40
|
+
## Use AI with Architecture Context
|
|
39
41
|
|
|
40
|
-
|
|
42
|
+
EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
|
|
41
43
|
|
|
42
|
-
|
|
44
|
+
- Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
|
|
45
|
+
- Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
npx skills add event-catalog/skills
|
|
49
|
+
```
|
|
43
50
|
|
|
44
|
-
## Learn
|
|
51
|
+
## Learn by Task
|
|
45
52
|
|
|
46
|
-
- [
|
|
47
|
-
- [
|
|
48
|
-
- [
|
|
49
|
-
- [
|
|
50
|
-
- [
|
|
51
|
-
- [
|
|
53
|
+
- [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
|
|
54
|
+
- [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
|
|
55
|
+
- [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
|
|
56
|
+
- [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
|
|
57
|
+
- [Generate from integrations](https://www.eventcatalog.dev/integrations)
|
|
58
|
+
- [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
|
|
59
|
+
- [Join the community](https://discord.gg/3rjaZMmrAm)
|
|
52
60
|
|
|
53
|
-
## Found a
|
|
61
|
+
## Found a Problem?
|
|
54
62
|
|
|
55
63
|
Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
|
|
@@ -1,27 +1,54 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Welcome to EventCatalog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. This template adds the EventBridge generator so you can import schemas from Amazon EventBridge and document how they connect to your domains, services, and teams.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Generate Your Catalog
|
|
6
6
|
|
|
7
|
-
1. Edit
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
1. Run `npm run dev` to start the development server.
|
|
11
|
-
1. Go to localhost:3000 to view your catalog.
|
|
7
|
+
1. Edit `.env` with your AWS settings.
|
|
8
|
+
2. Configure the region and schema registry name in `eventcatalog.config.js`.
|
|
9
|
+
3. Import your EventBridge schemas:
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
```sh
|
|
12
|
+
npm run generate
|
|
13
|
+
```
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
4. Start the catalog:
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
17
|
+
```sh
|
|
18
|
+
npm run dev
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Open [http://localhost:3000](http://localhost:3000) to view your catalog.
|
|
22
|
+
|
|
23
|
+
## Edit Your Catalog
|
|
24
|
+
|
|
25
|
+
Your generated resources are docs-as-code. You can enrich them with ownership, domain context, Markdown, examples, and relationships that are not always available in the source schema.
|
|
26
|
+
|
|
27
|
+
Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
|
|
28
|
+
|
|
29
|
+
## Keep It in Sync
|
|
30
|
+
|
|
31
|
+
Run `npm run generate` whenever your EventBridge schemas change. You can also run the generator in CI so your catalog stays aligned with your registry.
|
|
32
|
+
|
|
33
|
+
With this integration you can:
|
|
34
|
+
|
|
35
|
+
- Document EventBridge schemas and events
|
|
36
|
+
- Assign schemas to producers and consumers
|
|
37
|
+
- Connect resources to users and teams
|
|
20
38
|
- Visualize your EventBridge architecture
|
|
21
|
-
- And much more!
|
|
22
39
|
|
|
23
|
-
|
|
40
|
+
## Use AI with Architecture Context
|
|
41
|
+
|
|
42
|
+
EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows. Connect an MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
|
|
43
|
+
|
|
44
|
+
## Learn by Task
|
|
45
|
+
|
|
46
|
+
- [EventBridge integration docs](https://www.eventcatalog.dev/docs/plugins/eventbridge/intro)
|
|
47
|
+
- [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
|
|
48
|
+
- [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
|
|
49
|
+
- [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
|
|
50
|
+
- [Join the community](https://discord.gg/3rjaZMmrAm)
|
|
24
51
|
|
|
25
|
-
|
|
52
|
+
## Found a Problem?
|
|
26
53
|
|
|
27
|
-
|
|
54
|
+
Open an issue on [GitHub](https://github.com/event-catalog/generators).
|
|
@@ -1,55 +1,63 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Welcome to EventCatalog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Start the Catalog
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
8
|
npm run dev
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
Open [http://localhost:3000](http://localhost:3000) to
|
|
11
|
+
Open [http://localhost:3000](http://localhost:3000) to view your catalog.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Edit Your Catalog
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
- **Map events, commands & queries** — capture every message flowing through your system
|
|
19
|
-
- **Organize with domains** — group resources into bounded contexts
|
|
20
|
-
- **Visualize your architecture** — auto-generated diagrams of your services and message flows
|
|
21
|
-
- **Version everything** — track how your architecture evolves over time
|
|
22
|
-
- **Use AI to explore & document** — connect AI tools directly to your catalog
|
|
17
|
+
Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
|
|
23
18
|
|
|
24
|
-
|
|
19
|
+
Good places to start:
|
|
25
20
|
|
|
26
|
-
|
|
21
|
+
- `domains/` - bounded contexts, business capabilities, and ownership
|
|
22
|
+
- `domains/<domain>/services/` - services, APIs, and message producers or consumers
|
|
23
|
+
- `events/`, `commands/`, and `queries/` - the messages flowing through your system
|
|
24
|
+
- `teams/` and `users/` - who owns each part of the architecture
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
28
|
+
## Make Your First Change
|
|
29
|
+
|
|
30
|
+
1. Add or edit a domain, service, or message.
|
|
31
|
+
2. Run `npm run dev` and check the generated pages and diagrams.
|
|
32
|
+
3. Commit the MDX and schema files to Git.
|
|
33
|
+
|
|
34
|
+
## Keep It in Sync
|
|
33
35
|
|
|
34
|
-
|
|
36
|
+
Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
|
|
35
37
|
|
|
36
|
-
|
|
38
|
+
Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
|
|
37
39
|
|
|
38
|
-
|
|
40
|
+
## Use AI with Architecture Context
|
|
39
41
|
|
|
40
|
-
|
|
42
|
+
EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
|
|
41
43
|
|
|
42
|
-
|
|
44
|
+
- Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
|
|
45
|
+
- Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
npx skills add event-catalog/skills
|
|
49
|
+
```
|
|
43
50
|
|
|
44
|
-
## Learn
|
|
51
|
+
## Learn by Task
|
|
45
52
|
|
|
46
|
-
- [
|
|
47
|
-
- [
|
|
48
|
-
- [
|
|
49
|
-
- [
|
|
50
|
-
- [
|
|
51
|
-
- [
|
|
53
|
+
- [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
|
|
54
|
+
- [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
|
|
55
|
+
- [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
|
|
56
|
+
- [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
|
|
57
|
+
- [Generate from integrations](https://www.eventcatalog.dev/integrations)
|
|
58
|
+
- [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
|
|
59
|
+
- [Join the community](https://discord.gg/3rjaZMmrAm)
|
|
52
60
|
|
|
53
|
-
## Found a
|
|
61
|
+
## Found a Problem?
|
|
54
62
|
|
|
55
63
|
Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
|
package/templates/index.ts
CHANGED
|
@@ -1,59 +1,63 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Welcome to EventCatalog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[EventCatalog](https://www.eventcatalog.dev/) is your architecture catalog for distributed systems. Use it to document, govern, and discover your services, domains, APIs, events, commands, queries, schemas, teams, and flows in one place.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Start the Catalog
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
8
|
npm run dev
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
Open [http://localhost:3000](http://localhost:3000) to
|
|
11
|
+
Open [http://localhost:3000](http://localhost:3000) to view your catalog.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Using `pnpm` or `yarn`? Run the same scripts with the package manager you chose when creating this project.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Edit Your Catalog
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
- **Map events, commands & queries** — capture every message flowing through your system
|
|
19
|
-
- **Organize with domains** — group resources into bounded contexts
|
|
20
|
-
- **Visualize your architecture** — auto-generated diagrams of your services and message flows
|
|
21
|
-
- **Version everything** — track how your architecture evolves over time
|
|
22
|
-
- **Use AI to explore & document** — connect AI tools directly to your catalog
|
|
17
|
+
Your catalog is docs-as-code. Resources live in folders with an `index.mdx` file for frontmatter metadata and Markdown content.
|
|
23
18
|
|
|
24
|
-
|
|
19
|
+
Good places to start:
|
|
25
20
|
|
|
26
|
-
|
|
21
|
+
- `domains/` - bounded contexts, business capabilities, and ownership
|
|
22
|
+
- `domains/<domain>/services/` - services, APIs, and message producers or consumers
|
|
23
|
+
- `events/`, `commands/`, and `queries/` - the messages flowing through your system
|
|
24
|
+
- `teams/` and `users/` - who owns each part of the architecture
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
Prefer a visual workflow? Run `npm run editor` to open the [EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview) and browse, create, or update catalog resources through a GitHub-backed UI.
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
28
|
+
## Make Your First Change
|
|
29
|
+
|
|
30
|
+
1. Add or edit a domain, service, or message.
|
|
31
|
+
2. Run `npm run dev` and check the generated pages and diagrams.
|
|
32
|
+
3. Commit the MDX and schema files to Git.
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
## Keep It in Sync
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
Use `npm run generate` with [EventCatalog integrations](https://www.eventcatalog.dev/integrations) to import architecture data from OpenAPI, AsyncAPI, schema registries, EventBridge, GitHub, internal systems, and more.
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
Run generators locally while you work, or in CI so your catalog stays aligned with the systems it describes.
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Use AI with Architecture Context
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
EventCatalog gives AI tools structured context about your domains, services, messages, schemas, owners, and flows.
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
- Connect Claude, Cursor, VS Code, Windsurf, or another MCP-compatible tool with the [EventCatalog MCP Server](https://www.eventcatalog.dev/docs/development/guides/ai/using-mcp-server).
|
|
45
|
+
- Install [EventCatalog Skills](https://github.com/event-catalog/skills) to help agents document services, create domain models, and map business flows:
|
|
45
46
|
|
|
46
|
-
|
|
47
|
+
```sh
|
|
48
|
+
npx skills add event-catalog/skills
|
|
49
|
+
```
|
|
47
50
|
|
|
48
|
-
## Learn
|
|
51
|
+
## Learn by Task
|
|
49
52
|
|
|
50
|
-
- [
|
|
51
|
-
- [
|
|
52
|
-
- [
|
|
53
|
-
- [
|
|
54
|
-
- [
|
|
55
|
-
- [
|
|
53
|
+
- [Create a domain](https://www.eventcatalog.dev/docs/development/guides/domains)
|
|
54
|
+
- [Document a service](https://www.eventcatalog.dev/docs/development/guides/services)
|
|
55
|
+
- [Add events, commands, and queries](https://www.eventcatalog.dev/docs/development/guides/messages/adding-messages)
|
|
56
|
+
- [Use the EventCatalog Editor](https://www.eventcatalog.dev/docs/editor/overview)
|
|
57
|
+
- [Generate from integrations](https://www.eventcatalog.dev/integrations)
|
|
58
|
+
- [Manage your catalog with the SDK](https://www.eventcatalog.dev/docs/development/sdk)
|
|
59
|
+
- [Join the community](https://discord.gg/3rjaZMmrAm)
|
|
56
60
|
|
|
57
|
-
## Found a
|
|
61
|
+
## Found a Problem?
|
|
58
62
|
|
|
59
63
|
Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
|
|
@@ -1,159 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: inventory.{env}.events
|
|
3
|
-
name: Inventory Events Channel
|
|
4
|
-
version: 1.0.0
|
|
5
|
-
summary: |
|
|
6
|
-
Central event stream for all inventory-related events including stock updates, allocations, and adjustments
|
|
7
|
-
owners:
|
|
8
|
-
- dboyne
|
|
9
|
-
address: inventory.{env}.events
|
|
10
|
-
protocols:
|
|
11
|
-
- kafka
|
|
12
|
-
|
|
13
|
-
parameters:
|
|
14
|
-
env:
|
|
15
|
-
enum:
|
|
16
|
-
- dev
|
|
17
|
-
- sit
|
|
18
|
-
- prod
|
|
19
|
-
description: 'Environment to use'
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
### Overview
|
|
23
|
-
|
|
24
|
-
The Inventory Events channel is the central stream for all inventory-related events across the system. This includes stock level changes, inventory allocations, adjustments, and stocktake events. Events for a specific SKU are guaranteed to be processed in sequence when using productId as the partition key.
|
|
25
|
-
|
|
26
|
-
<ChannelInformation />
|
|
27
|
-
|
|
28
|
-
### Publishing and Subscribing to Events
|
|
29
|
-
|
|
30
|
-
#### Publishing Example
|
|
31
|
-
|
|
32
|
-
```python
|
|
33
|
-
from kafka import KafkaProducer
|
|
34
|
-
import json
|
|
35
|
-
from datetime import datetime
|
|
36
|
-
|
|
37
|
-
# Kafka configuration
|
|
38
|
-
bootstrap_servers = ['localhost:9092']
|
|
39
|
-
topic = f'inventory.{env}.events'
|
|
40
|
-
|
|
41
|
-
# Create a Kafka producer
|
|
42
|
-
producer = KafkaProducer(
|
|
43
|
-
bootstrap_servers=bootstrap_servers,
|
|
44
|
-
value_serializer=lambda v: json.dumps(v).encode('utf-8')
|
|
45
|
-
)
|
|
46
|
-
|
|
47
|
-
# Example inventory update event
|
|
48
|
-
inventory_event = {
|
|
49
|
-
"eventType": "STOCK_LEVEL_CHANGED",
|
|
50
|
-
"timestamp": datetime.utcnow().isoformat(),
|
|
51
|
-
"version": "1.0",
|
|
52
|
-
"payload": {
|
|
53
|
-
"productId": "PROD-456",
|
|
54
|
-
"locationId": "WH-123",
|
|
55
|
-
"previousQuantity": 100,
|
|
56
|
-
"newQuantity": 95,
|
|
57
|
-
"changeReason": "ORDER_FULFILLED",
|
|
58
|
-
"unitOfMeasure": "EACH",
|
|
59
|
-
"batchInfo": {
|
|
60
|
-
"batchId": "BATCH-789",
|
|
61
|
-
"expiryDate": "2025-12-31"
|
|
62
|
-
}
|
|
63
|
-
},
|
|
64
|
-
"metadata": {
|
|
65
|
-
"source": "warehouse_system",
|
|
66
|
-
"correlationId": "inv-xyz-123",
|
|
67
|
-
"userId": "john.doe"
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
# Send the message - using productId as key for partitioning
|
|
72
|
-
producer.send(
|
|
73
|
-
topic,
|
|
74
|
-
key=inventory_event['payload']['productId'].encode('utf-8'),
|
|
75
|
-
value=inventory_event
|
|
76
|
-
)
|
|
77
|
-
producer.flush()
|
|
78
|
-
|
|
79
|
-
print(f"Inventory event sent to topic {topic}")
|
|
80
|
-
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
### Subscription example
|
|
84
|
-
|
|
85
|
-
```python
|
|
86
|
-
from kafka import KafkaConsumer
|
|
87
|
-
import json
|
|
88
|
-
from datetime import datetime
|
|
89
|
-
|
|
90
|
-
class InventoryEventConsumer:
|
|
91
|
-
def __init__(self):
|
|
92
|
-
# Kafka configuration
|
|
93
|
-
self.topic = f'inventory.{env}.events'
|
|
94
|
-
self.consumer = KafkaConsumer(
|
|
95
|
-
self.topic,
|
|
96
|
-
bootstrap_servers=['localhost:9092'],
|
|
97
|
-
group_id='inventory-processor-group',
|
|
98
|
-
auto_offset_reset='earliest',
|
|
99
|
-
enable_auto_commit=False,
|
|
100
|
-
value_deserializer=lambda x: json.loads(x.decode('utf-8')),
|
|
101
|
-
key_deserializer=lambda x: x.decode('utf-8') if x else None
|
|
102
|
-
)
|
|
103
|
-
|
|
104
|
-
def process_event(self, event):
|
|
105
|
-
"""Process individual inventory events based on type"""
|
|
106
|
-
event_type = event.get('eventType')
|
|
107
|
-
|
|
108
|
-
if event_type == 'STOCK_LEVEL_CHANGED':
|
|
109
|
-
self.handle_stock_level_change(event)
|
|
110
|
-
elif event_type == 'LOW_STOCK_ALERT':
|
|
111
|
-
self.handle_low_stock_alert(event)
|
|
112
|
-
# Add more event type handlers as needed
|
|
113
|
-
|
|
114
|
-
def handle_stock_level_change(self, event):
|
|
115
|
-
"""Handle stock level change events"""
|
|
116
|
-
payload = event['payload']
|
|
117
|
-
print(f"Stock level change detected for product {payload['productId']}")
|
|
118
|
-
print(f"New quantity: {payload['newQuantity']}")
|
|
119
|
-
# Add your business logic here
|
|
120
|
-
|
|
121
|
-
def handle_low_stock_alert(self, event):
|
|
122
|
-
"""Handle low stock alert events"""
|
|
123
|
-
payload = event['payload']
|
|
124
|
-
print(f"Low stock alert for product {payload['productId']}")
|
|
125
|
-
print(f"Current quantity: {payload['currentQuantity']}")
|
|
126
|
-
# Add your business logic here
|
|
127
|
-
|
|
128
|
-
def start_consuming(self):
|
|
129
|
-
"""Start consuming messages from the topic"""
|
|
130
|
-
try:
|
|
131
|
-
print(f"Starting consumption from topic: {self.topic}")
|
|
132
|
-
for message in self.consumer:
|
|
133
|
-
try:
|
|
134
|
-
# Process the message
|
|
135
|
-
event = message.value
|
|
136
|
-
print(f"Received event: {event['eventType']} for product: {event['payload']['productId']}")
|
|
137
|
-
|
|
138
|
-
# Process the event
|
|
139
|
-
self.process_event(event)
|
|
140
|
-
|
|
141
|
-
# Commit the offset after successful processing
|
|
142
|
-
self.consumer.commit()
|
|
143
|
-
|
|
144
|
-
except Exception as e:
|
|
145
|
-
print(f"Error processing message: {str(e)}")
|
|
146
|
-
# Implement your error handling logic here
|
|
147
|
-
# You might want to send to a DLQ (Dead Letter Queue)
|
|
148
|
-
|
|
149
|
-
except Exception as e:
|
|
150
|
-
print(f"Consumer error: {str(e)}")
|
|
151
|
-
finally:
|
|
152
|
-
# Clean up
|
|
153
|
-
self.consumer.close()
|
|
154
|
-
|
|
155
|
-
if __name__ == "__main__":
|
|
156
|
-
# Create and start the consumer
|
|
157
|
-
consumer = InventoryEventConsumer()
|
|
158
|
-
consumer.start_consuming()
|
|
159
|
-
```
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: orders.{env}.events
|
|
3
|
-
name: Order Events Channel
|
|
4
|
-
version: 1.0.1
|
|
5
|
-
summary: |
|
|
6
|
-
Central event stream for all order-related events in the order processing lifecycle
|
|
7
|
-
owners:
|
|
8
|
-
- dboyne
|
|
9
|
-
address: orders.{env}.events
|
|
10
|
-
protocols:
|
|
11
|
-
- kafka
|
|
12
|
-
routes:
|
|
13
|
-
- id: inventory-queue
|
|
14
|
-
parameters:
|
|
15
|
-
env:
|
|
16
|
-
enum:
|
|
17
|
-
- dev
|
|
18
|
-
- sit
|
|
19
|
-
- prod
|
|
20
|
-
description: 'Environment to use'
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
### Overview
|
|
24
|
-
|
|
25
|
-
The Orders Events channel is the central stream for all order-related events across the order processing lifecycle. This includes order creation, updates, payment status, fulfillment status, and customer communications. All events related to a specific order are guaranteed to be processed in sequence when using orderId as the partition key.
|
|
26
|
-
|
|
27
|
-
<ChannelInformation />
|
|
28
|
-
|
|
29
|
-
### Publishing a message using Kafka
|
|
30
|
-
|
|
31
|
-
Here is an example of how to publish an order event using Kafka:
|
|
32
|
-
|
|
33
|
-
```python
|
|
34
|
-
from kafka import KafkaProducer
|
|
35
|
-
import json
|
|
36
|
-
from datetime import datetime
|
|
37
|
-
|
|
38
|
-
# Kafka configuration
|
|
39
|
-
bootstrap_servers = ['localhost:9092']
|
|
40
|
-
topic = f'orders.{env}.events'
|
|
41
|
-
|
|
42
|
-
# Create a Kafka producer
|
|
43
|
-
producer = KafkaProducer(
|
|
44
|
-
bootstrap_servers=bootstrap_servers,
|
|
45
|
-
value_serializer=lambda v: json.dumps(v).encode('utf-8')
|
|
46
|
-
)
|
|
47
|
-
|
|
48
|
-
# Example order created event
|
|
49
|
-
order_event = {
|
|
50
|
-
"eventType": "ORDER_CREATED",
|
|
51
|
-
"timestamp": datetime.utcnow().isoformat(),
|
|
52
|
-
"version": "1.0",
|
|
53
|
-
"payload": {
|
|
54
|
-
"orderId": "12345",
|
|
55
|
-
"customerId": "CUST-789",
|
|
56
|
-
"items": [
|
|
57
|
-
{
|
|
58
|
-
"productId": "PROD-456",
|
|
59
|
-
"quantity": 2,
|
|
60
|
-
"price": 29.99
|
|
61
|
-
}
|
|
62
|
-
],
|
|
63
|
-
"totalAmount": 59.98,
|
|
64
|
-
"shippingAddress": {
|
|
65
|
-
"street": "123 Main St",
|
|
66
|
-
"city": "Springfield",
|
|
67
|
-
"country": "US"
|
|
68
|
-
}
|
|
69
|
-
},
|
|
70
|
-
"metadata": {
|
|
71
|
-
"source": "web_checkout",
|
|
72
|
-
"correlationId": "abc-xyz-123"
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
# Send the message - using orderId as key for partitioning
|
|
77
|
-
producer.send(
|
|
78
|
-
topic,
|
|
79
|
-
key=order_event['payload']['orderId'].encode('utf-8'),
|
|
80
|
-
value=order_event
|
|
81
|
-
)
|
|
82
|
-
producer.flush()
|
|
83
|
-
|
|
84
|
-
print(f"Order event sent to topic {topic}")
|
|
85
|
-
```
|