@eventcatalog/create-eventcatalog 4.3.12 → 4.3.14-beta.0

package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductCreated/examples/index.mdx

@@ -0,0 +1,227 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Publish a newly created draft product
+
+The Product API has just stored the Embroidered Logo Cap as a draft, so ProductCreated is published with only the required product fields. The Search System consumes it to index the new product.
+
+### Payload details
+
+- `eventId` is unique to this event; consumers can use it to ignore duplicate deliveries.
+- `occurredAt` is the ISO-8601 UTC time the product was created.
+- `product.status` is `DRAFT`, so the product is not yet on sale.
+- `product.price` is `1499` in minor units, with `product.currency` set to `GBP`.
+- `product.description` and `product.category` are optional and omitted.
+
+The price is **1,499 pence (£14.99)**.
+
+### Using this example
+
+Use this to check how the search consumer handles `DRAFT` products and products without a category, for example indexing them without showing them to shoppers.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ProductCreated schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-product-created.ts
+import { EventsClient } from '@acme/events';
+import type { ProductCreated } from './schemas/product-created';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ProductCreated = {
+  eventId: 'b2d4f6a8-0c1e-4a3b-9d5f-7e9a1c3b5d6e',
+  occurredAt: '2026-09-11T08:12:45Z',
+  product: {
+    productId: 'a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71',
+    sku: 'CAP-LOGO-NVY',
+    name: 'Embroidered Logo Cap',
+    price: 1499,
+    currency: 'GBP',
+    status: 'DRAFT',
+  },
+};
+
+await client.publish('ProductCreated', event);
+```
+
+```python publish_product_created.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "eventId": "b2d4f6a8-0c1e-4a3b-9d5f-7e9a1c3b5d6e",
+    "occurredAt": "2026-09-11T08:12:45Z",
+    "product": {
+        "productId": "a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71",
+        "sku": "CAP-LOGO-NVY",
+        "name": "Embroidered Logo Cap",
+        "price": 1499,
+        "currency": "GBP",
+        "status": "DRAFT",
+    },
+}
+
+client.publish("ProductCreated", event)
+```
+
+```java PublishProductCreated.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishProductCreated {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "eventId", "b2d4f6a8-0c1e-4a3b-9d5f-7e9a1c3b5d6e",
+      "occurredAt", "2026-09-11T08:12:45Z",
+      "product", Map.of(
+        "productId", "a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71",
+        "sku", "CAP-LOGO-NVY",
+        "name", "Embroidered Logo Cap",
+        "price", 1499,
+        "currency", "GBP",
+        "status", "DRAFT"
+      )
+    );
+
+    client.publish("ProductCreated", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Publish an active product with full details
+
+The Heavyweight Zip Hoodie was created as `ACTIVE` with every field filled in. The Search System indexes it straight away so shoppers can find it.
+
+### Payload details
+
+- `eventId` and `occurredAt` identify this event and when the product was created.
+- `product.productId` is the identifier the Product API assigned to the hoodie.
+- `product.sku` is `HOODIE-ZIP-GRY-L`.
+- `product.description` and `product.category` (`hoodies`) are both present, so the search document can be fully populated.
+- `product.status` is `ACTIVE`, so the product is on sale.
+
+The price is **4,999 pence (£49.99)**.
+
+### Using this example
+
+A search consumer should index every field, including `category` for filtering, and the product should appear in results for a search such as "hoodie".
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ProductCreated schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-product-created.ts
+import { EventsClient } from '@acme/events';
+import type { ProductCreated } from './schemas/product-created';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ProductCreated = {
+  eventId: 'd8f0a2c4-6e8b-4d1f-b3a5-9c7e1f2a4b68',
+  occurredAt: '2026-09-12T10:30:00Z',
+  product: {
+    productId: 'c9e1f3a5-6b2d-4f7e-a8c0-1d3e5f7a9b24',
+    sku: 'HOODIE-ZIP-GRY-L',
+    name: 'Heavyweight Zip Hoodie',
+    description: 'Brushed-back cotton hoodie with a full-length zip.',
+    price: 4999,
+    currency: 'GBP',
+    category: 'hoodies',
+    status: 'ACTIVE',
+  },
+};
+
+await client.publish('ProductCreated', event);
+```
+
+```python publish_product_created.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "eventId": "d8f0a2c4-6e8b-4d1f-b3a5-9c7e1f2a4b68",
+    "occurredAt": "2026-09-12T10:30:00Z",
+    "product": {
+        "productId": "c9e1f3a5-6b2d-4f7e-a8c0-1d3e5f7a9b24",
+        "sku": "HOODIE-ZIP-GRY-L",
+        "name": "Heavyweight Zip Hoodie",
+        "description": "Brushed-back cotton hoodie with a full-length zip.",
+        "price": 4999,
+        "currency": "GBP",
+        "category": "hoodies",
+        "status": "ACTIVE",
+    },
+}
+
+client.publish("ProductCreated", event)
+```
+
+```java PublishProductCreated.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishProductCreated {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "eventId", "d8f0a2c4-6e8b-4d1f-b3a5-9c7e1f2a4b68",
+      "occurredAt", "2026-09-12T10:30:00Z",
+      "product", Map.of(
+        "productId", "c9e1f3a5-6b2d-4f7e-a8c0-1d3e5f7a9b24",
+        "sku", "HOODIE-ZIP-GRY-L",
+        "name", "Heavyweight Zip Hoodie",
+        "description", "Brushed-back cotton hoodie with a full-length zip.",
+        "price", 4999,
+        "currency", "GBP",
+        "category", "hoodies",
+        "status", "ACTIVE"
+      )
+    );
+
+    client.publish("ProductCreated", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductDeleted/examples/index.mdx

@@ -0,0 +1,175 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Publish a deletion without a reason
+
+A bucket hat listing added by mistake has been removed through the Product API. No reason was given, so the event carries only the required fields. The Search System removes the product from its index.
+
+### Payload details
+
+- `eventId` is unique to this event and can be used to ignore duplicate deliveries.
+- `occurredAt` is the ISO-8601 UTC time the product was deleted.
+- `productId` identifies the product to remove.
+- `reason` is optional and omitted.
+
+### Using this example
+
+A consumer should remove the product by `productId` and must not fail when `reason` is missing.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ProductDeleted schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-product-deleted.ts
+import { EventsClient } from '@acme/events';
+import type { ProductDeleted } from './schemas/product-deleted';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ProductDeleted = {
+  eventId: '6a8c0e2f-4b6d-4e8a-9c1f-3d5b7a9e1c46',
+  occurredAt: '2026-09-19T16:45:03Z',
+  productId: 'e4f6a8b0-2c4d-4e6f-8a0b-1c3d5e7f9a12',
+};
+
+await client.publish('ProductDeleted', event);
+```
+
+```python publish_product_deleted.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "eventId": "6a8c0e2f-4b6d-4e8a-9c1f-3d5b7a9e1c46",
+    "occurredAt": "2026-09-19T16:45:03Z",
+    "productId": "e4f6a8b0-2c4d-4e6f-8a0b-1c3d5e7f9a12",
+}
+
+client.publish("ProductDeleted", event)
+```
+
+```java PublishProductDeleted.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishProductDeleted {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "eventId", "6a8c0e2f-4b6d-4e8a-9c1f-3d5b7a9e1c46",
+      "occurredAt", "2026-09-19T16:45:03Z",
+      "productId", "e4f6a8b0-2c4d-4e6f-8a0b-1c3d5e7f9a12"
+    );
+
+    client.publish("ProductDeleted", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Publish a discontinued product
+
+The Tie-Dye T-Shirt has been retired because it will not be restocked. The event includes the reason so downstream systems can report on why products leave the catalog.
+
+### Payload details
+
+- `productId` identifies the Tie-Dye T-Shirt.
+- `reason` is `DISCONTINUED`, copied from the DeleteProduct command.
+- `occurredAt` records when the product was removed.
+
+### Using this example
+
+Check that the product is removed from the search index and that `reason` is recorded, so a discontinued line can be told apart from a `DUPLICATE` or `MERCHANT_REQUEST` removal.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ProductDeleted schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-product-deleted.ts
+import { EventsClient } from '@acme/events';
+import type { ProductDeleted } from './schemas/product-deleted';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ProductDeleted = {
+  eventId: '7b9d1f3a-5c7e-4a9b-b0d2-4e6f8a0c2e57',
+  occurredAt: '2026-09-20T11:20:30Z',
+  productId: '5c7e9a1b-3d5f-4a7c-9e1b-2d4f6a8c0e35',
+  reason: 'DISCONTINUED',
+};
+
+await client.publish('ProductDeleted', event);
+```
+
+```python publish_product_deleted.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "eventId": "7b9d1f3a-5c7e-4a9b-b0d2-4e6f8a0c2e57",
+    "occurredAt": "2026-09-20T11:20:30Z",
+    "productId": "5c7e9a1b-3d5f-4a7c-9e1b-2d4f6a8c0e35",
+    "reason": "DISCONTINUED",
+}
+
+client.publish("ProductDeleted", event)
+```
+
+```java PublishProductDeleted.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishProductDeleted {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "eventId", "7b9d1f3a-5c7e-4a9b-b0d2-4e6f8a0c2e57",
+      "occurredAt", "2026-09-20T11:20:30Z",
+      "productId", "5c7e9a1b-3d5f-4a7c-9e1b-2d4f6a8c0e35",
+      "reason", "DISCONTINUED"
+    );
+
+    client.publish("ProductDeleted", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

package/templates/default/domains/Catalog/systems/product-catalog-system/services/ProductAPI/events/ProductUpdated/examples/index.mdx

@@ -0,0 +1,205 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Publish a price change
+
+The Classic Crew Neck T-Shirt has been marked down, so ProductUpdated is published with only the fields that changed. The Search System re-indexes the product so results show the new price.
+
+### Payload details
+
+- `productId` identifies the T-shirt that changed.
+- `changes` holds only the changed fields: `price` and `currency`.
+- `changes.price` is `1499` in minor units, down from `1999`.
+- `occurredAt` is the ISO-8601 UTC time the update was applied.
+
+The new price is **1,499 pence (£14.99)**, **500 pence (£5.00)** less than before.
+
+### Using this example
+
+A consumer should update only the fields in `changes` and leave the rest of its copy of the product untouched.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ProductUpdated schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-product-updated.ts
+import { EventsClient } from '@acme/events';
+import type { ProductUpdated } from './schemas/product-updated';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ProductUpdated = {
+  eventId: 'f1a3c5e7-9b2d-4f6a-8c0e-3b5d7f9a1c24',
+  occurredAt: '2026-09-18T09:00:00Z',
+  productId: '4c8e2a6f-1d3b-4f5a-9e7c-0b2d4f6a8c13',
+  changes: {
+    price: 1499,
+    currency: 'GBP',
+  },
+};
+
+await client.publish('ProductUpdated', event);
+```
+
+```python publish_product_updated.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "eventId": "f1a3c5e7-9b2d-4f6a-8c0e-3b5d7f9a1c24",
+    "occurredAt": "2026-09-18T09:00:00Z",
+    "productId": "4c8e2a6f-1d3b-4f5a-9e7c-0b2d4f6a8c13",
+    "changes": {
+        "price": 1499,
+        "currency": "GBP",
+    },
+}
+
+client.publish("ProductUpdated", event)
+```
+
+```java PublishProductUpdated.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishProductUpdated {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "eventId", "f1a3c5e7-9b2d-4f6a-8c0e-3b5d7f9a1c24",
+      "occurredAt", "2026-09-18T09:00:00Z",
+      "productId", "4c8e2a6f-1d3b-4f5a-9e7c-0b2d4f6a8c13",
+      "changes", Map.of(
+        "price", 1499,
+        "currency", "GBP"
+      )
+    );
+
+    client.publish("ProductUpdated", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Publish a product launch with several changes
+
+The Embroidered Logo Cap has moved from draft to live with its final name, description and category. All four changes come from one UpdateProduct command, so they arrive in a single event.
+
+### Payload details
+
+- `changes.name` and `changes.description` replace the text shown to shoppers.
+- `changes.category` is `caps`, so the product can now be found with a category filter.
+- `changes.status` is `ACTIVE`, moving the cap out of `DRAFT`.
+- Price is not in `changes`, so it is unchanged.
+
+### Using this example
+
+Check that a consumer applies every field in `changes` together, and that a search for "cap" now returns the product.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the ProductUpdated schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-product-updated.ts
+import { EventsClient } from '@acme/events';
+import type { ProductUpdated } from './schemas/product-updated';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: ProductUpdated = {
+  eventId: '0e2c4a6f-8d1b-4b3e-a5c7-9f1d3b5e7a80',
+  occurredAt: '2026-09-15T14:05:12Z',
+  productId: 'a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71',
+  changes: {
+    name: 'Embroidered Logo Cap - Navy',
+    description: 'Six-panel cotton twill cap with an adjustable strap.',
+    category: 'caps',
+    status: 'ACTIVE',
+  },
+};
+
+await client.publish('ProductUpdated', event);
+```
+
+```python publish_product_updated.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "eventId": "0e2c4a6f-8d1b-4b3e-a5c7-9f1d3b5e7a80",
+    "occurredAt": "2026-09-15T14:05:12Z",
+    "productId": "a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71",
+    "changes": {
+        "name": "Embroidered Logo Cap - Navy",
+        "description": "Six-panel cotton twill cap with an adjustable strap.",
+        "category": "caps",
+        "status": "ACTIVE",
+    },
+}
+
+client.publish("ProductUpdated", event)
+```
+
+```java PublishProductUpdated.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishProductUpdated {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "eventId", "0e2c4a6f-8d1b-4b3e-a5c7-9f1d3b5e7a80",
+      "occurredAt", "2026-09-15T14:05:12Z",
+      "productId", "a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71",
+      "changes", Map.of(
+        "name", "Embroidered Logo Cap - Navy",
+        "description", "Six-panel cotton twill cap with an adjustable strap.",
+        "category", "caps",
+        "status", "ACTIVE"
+      )
+    );
+
+    client.publish("ProductUpdated", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>