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

package/LICENSE

@@ -19,13 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
----
-
-Note: Source code within the following directories is licensed under the
-EventCatalog Commercial License and is NOT covered by the MIT License above:
-
-- `packages/core/eventcatalog/src/enterprise/`
-- `packages/core/src/federation/`
-
-See the `LICENSE` file in each directory for the full terms.

package/dist/index.js

@@ -29835,7 +29835,7 @@ var import_os2 = __toESM(require("os"));
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "4.3.12",
+  version: "4.3.14-beta.0",
   license: "MIT",
   bin: {
     "create-catalog": "./dist/index.js"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "4.3.12",
+  "version": "4.3.14-beta.0",
   "license": "MIT",
   "bin": {
     "create-catalog": "./dist/index.js"

package/templates/amazon-api-gateway/README-template.md

@@ -52,3 +52,7 @@ EventCatalog gives AI tools structured context about your domains, services, mes
 ## Found a Problem?
 
 Open an issue on [GitHub](https://github.com/event-catalog/generators).
+
+## License
+
+This catalog is built with [EventCatalog](https://www.eventcatalog.dev). EventCatalog 5.0.0 and later is licensed under the [Business Source License 1.1](https://github.com/event-catalog/eventcatalog/blob/main/LICENSE), which covers production use of EventCatalog itself. Your catalog's content (your documentation, schemas and configuration) is yours. See the [license FAQ](https://www.eventcatalog.dev/license-faq) for what's included.

package/templates/asyncapi/README-template.md

@@ -61,3 +61,7 @@ npx skills add event-catalog/skills
 ## Found a Problem?
 
 Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
+
+## License
+
+This catalog is built with [EventCatalog](https://www.eventcatalog.dev). EventCatalog 5.0.0 and later is licensed under the [Business Source License 1.1](https://github.com/event-catalog/eventcatalog/blob/main/LICENSE), which covers production use of EventCatalog itself. Your catalog's content (your documentation, schemas and configuration) is yours. See the [license FAQ](https://www.eventcatalog.dev/license-faq) for what's included.

package/templates/asyncapi/env

@@ -1,8 +1,3 @@
-# EventCatalog Scale License Key, if you want to unlock the scale features
-# You can get a 14 day trial license key from https://eventcatalog.cloud
-
-EVENTCATALOG_SCALE_LICENSE_KEY=
-
 # Optional key if you are using EventCatalog Chat with OpenAI Models.
 # You need to set `output` to `server` in your eventcatalog.config.js file.
 # See documentation for more details: https://www.eventcatalog.dev/features/ai-assistant

package/templates/confluent/README-template.md

@@ -53,3 +53,7 @@ EventCatalog gives AI tools structured context about your domains, services, mes
 ## Found a Problem?
 
 Open an issue on [GitHub](https://github.com/event-catalog/generators).
+
+## License
+
+This catalog is built with [EventCatalog](https://www.eventcatalog.dev). EventCatalog 5.0.0 and later is licensed under the [Business Source License 1.1](https://github.com/event-catalog/eventcatalog/blob/main/LICENSE), which covers production use of EventCatalog itself. Your catalog's content (your documentation, schemas and configuration) is yours. See the [license FAQ](https://www.eventcatalog.dev/license-faq) for what's included.

package/templates/default/README-template.md

@@ -62,3 +62,7 @@ npx skills add event-catalog/skills
 ## Found a Problem?
 
 Open an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues).
+
+## License
+
+This catalog is built with [EventCatalog](https://www.eventcatalog.dev). EventCatalog 5.0.0 and later is licensed under the [Business Source License 1.1](https://github.com/event-catalog/eventcatalog/blob/main/LICENSE), which covers production use of EventCatalog itself. Your catalog's content (your documentation, schemas and configuration) is yours. See the [license FAQ](https://www.eventcatalog.dev/license-faq) for what's included.

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

@@ -0,0 +1,194 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Create a draft product with required fields only
+
+A merchandiser adds a new cap to the catalog with only the fields the Product API needs. Because `status` is left out, the product is stored as a draft and the Product API publishes a ProductCreated event.
+
+### Payload details
+
+- `sku` is `CAP-LOGO-NVY`. It must be unique across the catalog; a clash returns `409`.
+- `name` is the display name shown to shoppers.
+- `price` is `1499` in minor units, with `currency` set to `GBP`.
+- `status` is omitted, so the Product API defaults it to `DRAFT`.
+- `description` and `category` are optional and can be added later with UpdateProduct.
+
+The price is **1,499 pence (£14.99)**.
+
+### Using this example
+
+A handler should accept this command, default the status to `DRAFT`, return `201` and publish a ProductCreated event whose `product.status` is `DRAFT`.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the CreateProduct schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-create-product.ts
+import { EventsClient } from '@acme/events';
+import type { CreateProduct } from './schemas/create-product';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: CreateProduct = {
+  sku: 'CAP-LOGO-NVY',
+  name: 'Embroidered Logo Cap',
+  price: 1499,
+  currency: 'GBP',
+};
+
+await client.send('CreateProduct', command);
+```
+
+```python send_create_product.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "sku": "CAP-LOGO-NVY",
+    "name": "Embroidered Logo Cap",
+    "price": 1499,
+    "currency": "GBP",
+}
+
+client.send("CreateProduct", command)
+```
+
+```java SendCreateProduct.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendCreateProduct {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "sku", "CAP-LOGO-NVY",
+      "name", "Embroidered Logo Cap",
+      "price", 1499,
+      "currency", "GBP"
+    );
+
+    client.send("CreateProduct", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Create an active product with every field
+
+The new hoodie is ready to sell, so it is created with a description, category and `ACTIVE` status in one request. It becomes searchable once the Search System indexes the resulting ProductCreated event.
+
+### Payload details
+
+- `sku` is `HOODIE-ZIP-GRY-L` (zip hoodie, grey, large).
+- `description` holds the long-form copy for the product page.
+- `category` is `hoodies`, which the Search System uses for filtering.
+- `status` is `ACTIVE`, so the product skips the draft stage and goes live straight away.
+- `price` is `4999` in minor units, with `currency` set to `GBP`.
+
+The price is **4,999 pence (£49.99)**.
+
+### Using this example
+
+Check that every optional field is stored exactly as sent and copied into the ProductCreated event, and that `status` is `ACTIVE` rather than the default.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the CreateProduct schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-create-product.ts
+import { EventsClient } from '@acme/events';
+import type { CreateProduct } from './schemas/create-product';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: CreateProduct = {
+  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.send('CreateProduct', command);
+```
+
+```python send_create_product.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "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.send("CreateProduct", command)
+```
+
+```java SendCreateProduct.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendCreateProduct {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "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.send("CreateProduct", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

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

@@ -0,0 +1,161 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Delete a product without a reason
+
+An admin removes a bucket hat listing that was added by mistake. No reason is given, so only the product identifier is sent. On success the Product API returns `204` and publishes a ProductDeleted event.
+
+### Payload details
+
+- `productId` identifies the product to remove and matches the `{productId}` in the request path.
+- `reason` is optional and is left out here.
+
+### Using this example
+
+Check that the product is removed, `204` is returned and the ProductDeleted event has no `reason`. Sending the same command again should return `404`.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the DeleteProduct schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-delete-product.ts
+import { EventsClient } from '@acme/events';
+import type { DeleteProduct } from './schemas/delete-product';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: DeleteProduct = {
+  productId: 'e4f6a8b0-2c4d-4e6f-8a0b-1c3d5e7f9a12',
+};
+
+await client.send('DeleteProduct', command);
+```
+
+```python send_delete_product.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "productId": "e4f6a8b0-2c4d-4e6f-8a0b-1c3d5e7f9a12",
+}
+
+client.send("DeleteProduct", command)
+```
+
+```java SendDeleteProduct.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendDeleteProduct {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "productId", "e4f6a8b0-2c4d-4e6f-8a0b-1c3d5e7f9a12"
+    );
+
+    client.send("DeleteProduct", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Retire a discontinued product
+
+The Tie-Dye T-Shirt has sold out and will not be restocked, so it is removed from the catalog with the reason `DISCONTINUED`.
+
+### Payload details
+
+- `productId` identifies the Tie-Dye T-Shirt.
+- `reason` is `DISCONTINUED`. The allowed values are `DISCONTINUED`, `DUPLICATE`, `MERCHANT_REQUEST` and `OTHER`.
+- The reason is passed on in the ProductDeleted event for downstream systems and reporting.
+
+### Using this example
+
+Check that `reason` is carried through to the ProductDeleted event, so consumers can tell a discontinued line from, for example, a duplicate listing.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the DeleteProduct schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-delete-product.ts
+import { EventsClient } from '@acme/events';
+import type { DeleteProduct } from './schemas/delete-product';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: DeleteProduct = {
+  productId: '5c7e9a1b-3d5f-4a7c-9e1b-2d4f6a8c0e35',
+  reason: 'DISCONTINUED',
+};
+
+await client.send('DeleteProduct', command);
+```
+
+```python send_delete_product.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "productId": "5c7e9a1b-3d5f-4a7c-9e1b-2d4f6a8c0e35",
+    "reason": "DISCONTINUED",
+}
+
+client.send("DeleteProduct", command)
+```
+
+```java SendDeleteProduct.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendDeleteProduct {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "productId", "5c7e9a1b-3d5f-4a7c-9e1b-2d4f6a8c0e35",
+      "reason", "DISCONTINUED"
+    );
+
+    client.send("DeleteProduct", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

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

@@ -0,0 +1,182 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Reduce the price of a T-shirt
+
+The Classic Crew Neck T-Shirt is marked down for a weekend promotion. Only the price fields are sent, so the rest of the product stays as it is, and the Product API publishes a ProductUpdated event with the new price.
+
+### Payload details
+
+- `productId` identifies the T-shirt and matches the `{productId}` in the request path.
+- `price` is `1499` in minor units, replacing the previous price of `1999`.
+- `currency` is sent with the price so the new amount is unambiguous.
+- `name`, `description`, `category` and `status` are not sent, so they do not change.
+
+The new price is **1,499 pence (£14.99)**, a reduction of **500 pence (£5.00)** from £19.99.
+
+### Using this example
+
+Check that only `price` and `currency` change on the stored product, and that the ProductUpdated event lists just those two fields in `changes`.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the UpdateProduct schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-update-product.ts
+import { EventsClient } from '@acme/events';
+import type { UpdateProduct } from './schemas/update-product';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: UpdateProduct = {
+  productId: '4c8e2a6f-1d3b-4f5a-9e7c-0b2d4f6a8c13',
+  price: 1499,
+  currency: 'GBP',
+};
+
+await client.send('UpdateProduct', command);
+```
+
+```python send_update_product.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "productId": "4c8e2a6f-1d3b-4f5a-9e7c-0b2d4f6a8c13",
+    "price": 1499,
+    "currency": "GBP",
+}
+
+client.send("UpdateProduct", command)
+```
+
+```java SendUpdateProduct.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendUpdateProduct {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "productId", "4c8e2a6f-1d3b-4f5a-9e7c-0b2d4f6a8c13",
+      "price", 1499,
+      "currency", "GBP"
+    );
+
+    client.send("UpdateProduct", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Launch a draft product with final copy
+
+The Embroidered Logo Cap was created as a draft. Before launch, the merchandiser renames it, adds its description and category, and moves it to `ACTIVE` in a single update.
+
+### Payload details
+
+- `productId` identifies the draft cap.
+- `name` adds the colour to the display name.
+- `description` and `category` are set for the first time; `category` is `caps`.
+- `status` changes from `DRAFT` to `ACTIVE`, making the cap visible to shoppers.
+- `price` and `currency` are not sent, so the cap stays at 1,499 pence (£14.99).
+
+### Using this example
+
+A handler should apply all four fields in one write, return `200` and publish a single ProductUpdated event whose `changes` contains the same four fields.
+
+The examples use a **fictional Acme Events SDK** to send a payload matching the UpdateProduct schema. The package names and send methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript send-update-product.ts
+import { EventsClient } from '@acme/events';
+import type { UpdateProduct } from './schemas/update-product';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const command: UpdateProduct = {
+  productId: 'a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71',
+  name: 'Embroidered Logo Cap - Navy',
+  description: 'Six-panel cotton twill cap with an adjustable strap.',
+  category: 'caps',
+  status: 'ACTIVE',
+};
+
+await client.send('UpdateProduct', command);
+```
+
+```python send_update_product.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+command = {
+    "productId": "a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71",
+    "name": "Embroidered Logo Cap - Navy",
+    "description": "Six-panel cotton twill cap with an adjustable strap.",
+    "category": "caps",
+    "status": "ACTIVE",
+}
+
+client.send("UpdateProduct", command)
+```
+
+```java SendUpdateProduct.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class SendUpdateProduct {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var command = Map.of(
+      "productId", "a7c4e2d9-1b3f-4c8a-8e5d-2f6b9a0c3d71",
+      "name", "Embroidered Logo Cap - Navy",
+      "description", "Six-panel cotton twill cap with an adjustable strap.",
+      "category", "caps",
+      "status", "ACTIVE"
+    );
+
+    client.send("UpdateProduct", command);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>