@eventcatalog/create-eventcatalog 4.3.12-beta.1 → 4.3.13

package/templates/default/domains/Reviews/services/ReviewModerationWorker/events/review-published/examples/index.mdx

@@ -0,0 +1,183 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Publish an approved five-star review
+
+The Review Moderation Worker has screened the T-shirt review and found no problems, so the review is now visible on the storefront. The Rating Aggregator consumes this event to recalculate the product's rating.
+
+### Payload details
+
+- `reviewId` is the review that passed moderation.
+- `productId` is `prod_tshirt_classic_white`, the product whose rating needs updating.
+- `customerId` is included (`cust_4821`) so consumers can link the review to its author.
+- `rating` is `5`, which the aggregator adds to the product's totals.
+- `publishedAt` is when the review went live, shortly after it was submitted.
+
+### Using this example
+
+The Rating Aggregator should add this `rating` to the product's totals and publish `RatingUpdated` for the same `productId`.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ReviewPublished schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-review-published.ts
+import { EventsClient } from '@acme/events';
+import type { ReviewPublished } from './schemas/review-published';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ReviewPublished = {
+  reviewId: '3f2b8c1e-5d4a-4e7b-9a1c-6b2d8e4f7a90',
+  productId: 'prod_tshirt_classic_white',
+  customerId: 'cust_4821',
+  rating: 5,
+  publishedAt: '2026-09-14T18:23:02Z',
+};
+
+await client.publish('ReviewPublished', event);
+```
+
+```python publish_review_published.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "reviewId": "3f2b8c1e-5d4a-4e7b-9a1c-6b2d8e4f7a90",
+    "productId": "prod_tshirt_classic_white",
+    "customerId": "cust_4821",
+    "rating": 5,
+    "publishedAt": "2026-09-14T18:23:02Z",
+}
+
+client.publish("ReviewPublished", event)
+```
+
+```java PublishReviewPublished.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishReviewPublished {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "reviewId", "3f2b8c1e-5d4a-4e7b-9a1c-6b2d8e4f7a90",
+      "productId", "prod_tshirt_classic_white",
+      "customerId", "cust_4821",
+      "rating", 5,
+      "publishedAt", "2026-09-14T18:23:02Z"
+    );
+
+    client.publish("ReviewPublished", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Publish an approved review with only required fields
+
+The two-star hoodie review passes moderation. This event carries only the fields the Rating Aggregator needs.
+
+### Payload details
+
+- `customerId` is optional and left out; the aggregator only needs the product and the rating.
+- `productId` is `prod_hoodie_oversized_grey`.
+- `rating` is `2`, so the product's average rating will drop.
+- `publishedAt` is when the review became visible.
+
+### Using this example
+
+Use this payload to check that consumers do not depend on `customerId` and that low ratings update the average correctly.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ReviewPublished schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-review-published.ts
+import { EventsClient } from '@acme/events';
+import type { ReviewPublished } from './schemas/review-published';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ReviewPublished = {
+  reviewId: 'a7c4e2d9-1b3f-4c8a-b6e5-9d0f2a1c3e47',
+  productId: 'prod_hoodie_oversized_grey',
+  rating: 2,
+  publishedAt: '2026-09-15T09:05:38Z',
+};
+
+await client.publish('ReviewPublished', event);
+```
+
+```python publish_review_published.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "reviewId": "a7c4e2d9-1b3f-4c8a-b6e5-9d0f2a1c3e47",
+    "productId": "prod_hoodie_oversized_grey",
+    "rating": 2,
+    "publishedAt": "2026-09-15T09:05:38Z",
+}
+
+client.publish("ReviewPublished", event)
+```
+
+```java PublishReviewPublished.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishReviewPublished {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "reviewId", "a7c4e2d9-1b3f-4c8a-b6e5-9d0f2a1c3e47",
+      "productId", "prod_hoodie_oversized_grey",
+      "rating", 2,
+      "publishedAt", "2026-09-15T09:05:38Z"
+    );
+
+    client.publish("ReviewPublished", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

package/templates/default/domains/Reviews/services/ReviewModerationWorker/events/review-rejected/examples/index.mdx

@@ -0,0 +1,178 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Reject a spam review
+
+A review on the navy baseball cap contains a promotional link for a discount site. The Review Moderation Worker rejects it as spam, so it is kept for audit but never shown on the storefront.
+
+### Payload details
+
+- `reviewId` identifies the rejected review.
+- `productId` is `prod_cap_baseball_navy`.
+- `reason` is `spam`, one of `spam`, `abuse`, `off_topic` or `policy_violation`.
+- `rejectedAt` is when the moderation decision was made.
+
+### Using this example
+
+Check that the review stays hidden, the product's rating is not changed, and the `reason` is recorded against the review for audit.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ReviewRejected schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-review-rejected.ts
+import { EventsClient } from '@acme/events';
+import type { ReviewRejected } from './schemas/review-rejected';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ReviewRejected = {
+  reviewId: 'c9e1f4a2-7b6d-4d3c-8e2f-1a5b9c7d0e63',
+  productId: 'prod_cap_baseball_navy',
+  reason: 'spam',
+  rejectedAt: '2026-09-16T07:41:19Z',
+};
+
+await client.publish('ReviewRejected', event);
+```
+
+```python publish_review_rejected.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "reviewId": "c9e1f4a2-7b6d-4d3c-8e2f-1a5b9c7d0e63",
+    "productId": "prod_cap_baseball_navy",
+    "reason": "spam",
+    "rejectedAt": "2026-09-16T07:41:19Z",
+}
+
+client.publish("ReviewRejected", event)
+```
+
+```java PublishReviewRejected.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishReviewRejected {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "reviewId", "c9e1f4a2-7b6d-4d3c-8e2f-1a5b9c7d0e63",
+      "productId", "prod_cap_baseball_navy",
+      "reason", "spam",
+      "rejectedAt", "2026-09-16T07:41:19Z"
+    );
+
+    client.publish("ReviewRejected", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Reject a review that breaks the content policy
+
+A review on the black zip hoodie includes a delivery driver's full name and phone number. Sharing personal details breaks the review policy, so the worker rejects it.
+
+### Payload details
+
+- `productId` is `prod_hoodie_zip_black`.
+- `reason` is `policy_violation`, used when a review is on topic but breaks a content rule.
+- `rejectedAt` is the UTC time of the decision.
+
+### Using this example
+
+Use this payload to test that each `reason` value maps to the right message shown to the customer who wrote the review.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ReviewRejected schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-review-rejected.ts
+import { EventsClient } from '@acme/events';
+import type { ReviewRejected } from './schemas/review-rejected';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ReviewRejected = {
+  reviewId: 'e4b7d1c3-9a2f-4b6e-a8d5-2c7f0e9b1a36',
+  productId: 'prod_hoodie_zip_black',
+  reason: 'policy_violation',
+  rejectedAt: '2026-09-16T14:02:55Z',
+};
+
+await client.publish('ReviewRejected', event);
+```
+
+```python publish_review_rejected.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "reviewId": "e4b7d1c3-9a2f-4b6e-a8d5-2c7f0e9b1a36",
+    "productId": "prod_hoodie_zip_black",
+    "reason": "policy_violation",
+    "rejectedAt": "2026-09-16T14:02:55Z",
+}
+
+client.publish("ReviewRejected", event)
+```
+
+```java PublishReviewRejected.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishReviewRejected {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "reviewId", "e4b7d1c3-9a2f-4b6e-a8d5-2c7f0e9b1a36",
+      "productId", "prod_hoodie_zip_black",
+      "reason", "policy_violation",
+      "rejectedAt", "2026-09-16T14:02:55Z"
+    );
+
+    client.publish("ReviewRejected", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/AddItemToCart/examples/index.mdx

@@ -0,0 +1,171 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Add a single T-shirt to a cart
+
+A shopper taps **Add to basket** on a T-shirt product page. The storefront sends `AddItemToCart` to the Cart API, which adds the line to the cart and saves it to the cart database.
+
+### Payload details
+
+- `cartId` identifies the shopper's open cart.
+- `productId` is the catalogue ID of the T-shirt.
+- `quantity` is `1`, the storefront default for a single click.
+
+### Using this example
+
+Check that the cart now holds one T-shirt line with a quantity of 1, and that a second identical command increases the quantity to 2 rather than adding a new line.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the AddItemToCart schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-add-item-to-cart.ts
+import { EventsClient } from '@acme/events';
+import type { AddItemToCart } from './schemas/add-item-to-cart';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: AddItemToCart = {
+  cartId: 'a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24',
+  productId: '0e8f4b2a-7c1d-4f3e-9a5b-6d2c8e1f7a93',
+  quantity: 1,
+};
+
+await client.send('AddItemToCart', command);
+```
+
+```python send_add_item_to_cart.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "cartId": "a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24",
+    "productId": "0e8f4b2a-7c1d-4f3e-9a5b-6d2c8e1f7a93",
+    "quantity": 1,
+}
+
+client.send("AddItemToCart", command)
+```
+
+```java SendAddItemToCart.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendAddItemToCart {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "cartId", "a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24",
+      "productId", "0e8f4b2a-7c1d-4f3e-9a5b-6d2c8e1f7a93",
+      "quantity", 1
+    );
+
+    client.send("AddItemToCart", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Add several caps in one go
+
+A shopper picks a quantity of 3 in the quantity selector before adding a cap to the same cart. The Cart API adds all three units in one command.
+
+### Payload details
+
+- `cartId` is the same cart as in the first example.
+- `productId` is the catalogue ID of the cap.
+- `quantity` is `3`; it must be at least 1.
+
+### Using this example
+
+Check that the cap line has a quantity of 3, and that a `quantity` of 0 is rejected with a `400` response.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the AddItemToCart schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-add-item-to-cart.ts
+import { EventsClient } from '@acme/events';
+import type { AddItemToCart } from './schemas/add-item-to-cart';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: AddItemToCart = {
+  cartId: 'a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24',
+  productId: '8d4f6a2c-3e5b-4c7d-9f1a-5b7d9e3c1a46',
+  quantity: 3,
+};
+
+await client.send('AddItemToCart', command);
+```
+
+```python send_add_item_to_cart.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "cartId": "a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24",
+    "productId": "8d4f6a2c-3e5b-4c7d-9f1a-5b7d9e3c1a46",
+    "quantity": 3,
+}
+
+client.send("AddItemToCart", command)
+```
+
+```java SendAddItemToCart.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendAddItemToCart {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "cartId", "a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24",
+      "productId", "8d4f6a2c-3e5b-4c7d-9f1a-5b7d9e3c1a46",
+      "quantity", 3
+    );
+
+    client.send("AddItemToCart", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

package/templates/default/domains/Shopping/systems/cart-system/services/CartAPI/commands/CheckoutCart/examples/index.mdx

@@ -0,0 +1,168 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Check out without a promotion code
+
+A returning customer clicks **Checkout** with a basket of T-shirts and no voucher. The Cart API prices the cart and, on success, publishes `CartCheckedOut`.
+
+### Payload details
+
+- `cartId` is the cart being checked out.
+- `customerId` is the signed-in customer.
+- `promotionCode` is omitted, so only automatic promotions can apply.
+
+### Using this example
+
+Check that the cart is locked and a `CartCheckedOut` event is published for the same `cartId` and `customerId`. A second checkout of the same cart should return `409`.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the CheckoutCart schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-checkout-cart.ts
+import { EventsClient } from '@acme/events';
+import type { CheckoutCart } from './schemas/checkout-cart';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: CheckoutCart = {
+  cartId: 'c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f',
+  customerId: '7a1e5c9d-8b3f-4f2a-a6d4-2e9c0b7f3d51',
+};
+
+await client.send('CheckoutCart', command);
+```
+
+```python send_checkout_cart.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "cartId": "c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
+    "customerId": "7a1e5c9d-8b3f-4f2a-a6d4-2e9c0b7f3d51",
+}
+
+client.send("CheckoutCart", command)
+```
+
+```java SendCheckoutCart.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendCheckoutCart {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "cartId", "c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
+      "customerId", "7a1e5c9d-8b3f-4f2a-a6d4-2e9c0b7f3d51"
+    );
+
+    client.send("CheckoutCart", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Check out with an autumn voucher
+
+A customer enters the voucher code `AUTUMN10` at checkout. The Cart API asks the Promotion Service to calculate the discount before it completes the checkout.
+
+### Payload details
+
+- `cartId` is the cart holding T-shirts, a hoodie and a cap.
+- `customerId` is the customer who owns the cart.
+- `promotionCode` is `AUTUMN10`, a 10% off voucher.
+
+### Using this example
+
+Check that a `CalculateDiscount` command is sent with the promotion code, and that the resulting `CartCheckedOut` event includes the discount.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the CheckoutCart schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-checkout-cart.ts
+import { EventsClient } from '@acme/events';
+import type { CheckoutCart } from './schemas/checkout-cart';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: CheckoutCart = {
+  cartId: 'a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24',
+  customerId: '3f2c8a91-6b4e-4d7a-9c1f-8e5b2a7d4c60',
+  promotionCode: 'AUTUMN10',
+};
+
+await client.send('CheckoutCart', command);
+```
+
+```python send_checkout_cart.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "cartId": "a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24",
+    "customerId": "3f2c8a91-6b4e-4d7a-9c1f-8e5b2a7d4c60",
+    "promotionCode": "AUTUMN10",
+}
+
+client.send("CheckoutCart", command)
+```
+
+```java SendCheckoutCart.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendCheckoutCart {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "cartId", "a7c3e9f1-2b4d-4e6a-8f1c-3d5b7e9a1c24",
+      "customerId", "3f2c8a91-6b4e-4d7a-9c1f-8e5b2a7d4c60",
+      "promotionCode", "AUTUMN10"
+    );
+
+    client.send("CheckoutCart", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>