@eventcatalog/create-eventcatalog 4.3.2 → 4.3.4-beta.0

package/templates/default/domains/Customer/entities/authentication-session/index.mdx

@@ -0,0 +1,35 @@
+---
+id: authentication-session
+name: Authentication Session
+version: 1.0.0
+identifier: sessionId
+summary: A successful customer authentication session.
+owners:
+  - customer-platform
+properties:
+  - name: sessionId
+    type: UUID
+    required: true
+    description: Unique authentication session identifier.
+  - name: accountId
+    type: UUID
+    required: true
+    description: Account authenticated in the session.
+    references: customer-account
+    relationType: belongsTo
+    referencesIdentifier: accountId
+  - name: authenticatedAt
+    type: datetime
+    required: true
+    description: Time authentication succeeded.
+  - name: expiresAt
+    type: datetime
+    required: true
+    description: Time the session expires.
+---
+
+## Overview
+
+Authentication Session represents successful login behavior emitted by [[event|customer-authenticated]].
+
+<EntityPropertiesTable />

package/templates/default/domains/Customer/entities/customer-account/index.mdx

@@ -0,0 +1,36 @@
+---
+id: customer-account
+name: Customer Account
+version: 1.0.0
+identifier: accountId
+aggregateRoot: true
+summary: The identity account used to authenticate a customer.
+owners:
+  - customer-platform
+properties:
+  - name: accountId
+    type: UUID
+    required: true
+    description: Unique account identifier.
+  - name: customerId
+    type: UUID
+    required: true
+    description: Customer profile linked to this account.
+    references: customer-profile
+    relationType: belongsTo
+    referencesIdentifier: customerId
+  - name: provider
+    type: string
+    required: true
+    description: Identity provider name.
+  - name: status
+    type: string
+    required: true
+    description: Account lifecycle state.
+---
+
+## Overview
+
+Customer Account belongs to the Identity Provider boundary and should not be queried directly by order, payment or review services.
+
+<EntityPropertiesTable />

package/templates/default/domains/Customer/entities/customer-address/index.mdx

@@ -0,0 +1,35 @@
+---
+id: customer-address
+name: Customer Address
+version: 1.0.0
+identifier: addressId
+summary: A saved address attached to a customer profile.
+owners:
+  - customer-platform
+properties:
+  - name: addressId
+    type: UUID
+    required: true
+    description: Unique address identifier.
+  - name: customerId
+    type: UUID
+    required: true
+    description: Customer who owns the address.
+    references: customer-profile
+    relationType: belongsTo
+    referencesIdentifier: customerId
+  - name: countryCode
+    type: string
+    required: true
+    description: ISO country code.
+  - name: postalCode
+    type: string
+    required: true
+    description: Postal or ZIP code.
+---
+
+## Overview
+
+Customer Address supports checkout and fulfilment while remaining owned by the Customer domain.
+
+<EntityPropertiesTable />

package/templates/default/domains/Customer/entities/customer-profile/index.mdx

@@ -0,0 +1,33 @@
+---
+id: customer-profile
+name: Customer Profile
+version: 1.0.0
+identifier: customerId
+aggregateRoot: true
+summary: The customer details Acme uses for commerce interactions.
+owners:
+  - customer-platform
+properties:
+  - name: customerId
+    type: UUID
+    required: true
+    description: Unique customer identifier.
+  - name: email
+    type: string
+    required: true
+    description: Customer email address.
+  - name: displayName
+    type: string
+    required: false
+    description: Preferred customer display name.
+  - name: status
+    type: string
+    required: true
+    description: Customer profile state.
+---
+
+## Overview
+
+Customer Profile is owned by [[system|customer-management-system]] and is separate from authentication credentials.
+
+<EntityPropertiesTable />

package/templates/default/domains/Customer/index.mdx

@@ -0,0 +1,67 @@
+---
+id: customer
+name: Customer
+version: 1.0.0
+summary: |
+  The Customer domain owns who our customers are — how they register, how their profile is maintained, and how they are authenticated across Acme Inc. It is the source of truth for customer identity and profile data.
+owners:
+  - customer-platform
+systems:
+  - id: customer-management-system
+    version: 1.0.0
+  - id: identity-provider
+    version: 1.0.0
+entities:
+  - id: customer-profile
+    version: 1.0.0
+  - id: customer-account
+    version: 1.0.0
+  - id: authentication-session
+    version: 1.0.0
+  - id: customer-address
+    version: 1.0.0
+badges:
+  - content: Core domain
+    backgroundColor: blue
+    textColor: blue
+    icon: RectangleGroupIcon
+  - content: Business Critical
+    backgroundColor: red
+    textColor: red
+    icon: ShieldCheckIcon
+---
+
+## Overview
+
+The **Customer** domain is responsible for the lifecycle of every customer account at Acme Inc — registration, profile updates, and authentication. It is split into two systems:
+
+<Tiles>
+  <Tile
+    icon="RectangleGroupIcon"
+    href="/docs/systems/customer-management-system/1.0.0"
+    title="Customer Management System"
+    description="System of record for customer profiles — register, update and read customers."
+  />
+  <Tile
+    icon="LockClosedIcon"
+    href="/docs/systems/identity-provider/1.0.0"
+    title="Identity Provider"
+    description="Authenticates customers and is the source of truth for credentials and login."
+  />
+</Tiles>
+
+### How the systems work together
+
+The **Customer Management System** owns customer profile data — it accepts registration and update commands and publishes events when customers change. The **Identity Provider** handles authentication: it verifies credentials and emits an event when a customer successfully authenticates, which the rest of the business can react to.
+
+## System Diagram
+
+The systems in this domain, how they relate, and the people who interact with them.
+
+<ContextDiagram />
+
+## Resource Diagram
+
+The components that make up this domain.
+
+<NodeGraph />

package/templates/default/domains/Customer/systems/customer-management-system/containers/customer-database/index.mdx

@@ -0,0 +1,43 @@
+---
+id: customer-database
+name: Customer Database
+version: 1.0.0
+summary: PostgreSQL database that is the system of record for all customer profile data.
+container_type: database
+technology: postgres@16
+authoritative: true
+access_mode: readWrite
+purpose: System of record for customer profiles
+classification: confidential
+retention: indefinite
+residency: eu-west-1
+styles:
+  icon: /icons/database/postgresql.svg
+---
+
+<NodeGraph />
+
+### What is this?
+
+The **Customer Database** is the authoritative store for every customer profile at Acme Inc. The [[service|customer-api]] reads from and writes to it. It stores profile data only — credentials and authentication live in the [[system|identity-provider]]'s [[container|user-directory]], not here.
+
+### What does it store?
+
+- **Customers** — one row per customer: id, email, name and account status.
+
+### Schema
+
+<AccordionGroup>
+  <Accordion title="Customer Database schema">
+    <Schema file="schema.sql" lang="sql" title="schema.sql" />
+  </Accordion>
+</AccordionGroup>
+
+### Access patterns
+
+- The [[service|customer-api]] is the only writer on the request path.
+- No credentials or passwords are stored here — only profile data. Authentication is owned by the [[system|identity-provider]].
+
+### Classification
+
+Customer profile data is **confidential**. Access is role-based and least-privilege; PII handling follows Acme's data policies.

package/templates/default/domains/Customer/systems/customer-management-system/containers/customer-database/schema.sql

@@ -0,0 +1,14 @@
+-- Customer Database — system of record for customer profiles
+-- Note: credentials/authentication are owned by the Identity Provider, not stored here.
+
+CREATE TABLE customers (
+    customer_id  UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+    email        TEXT NOT NULL UNIQUE,
+    name         TEXT,
+    status       TEXT NOT NULL DEFAULT 'ACTIVE'
+                   CHECK (status IN ('ACTIVE', 'SUSPENDED', 'CLOSED')),
+    registered_at TIMESTAMPTZ NOT NULL DEFAULT now(),
+    updated_at    TIMESTAMPTZ NOT NULL DEFAULT now()
+);
+
+CREATE INDEX idx_customers_status ON customers (status);

package/templates/default/domains/Customer/systems/customer-management-system/index.mdx

@@ -0,0 +1,60 @@
+---
+id: customer-management-system
+name: Customer Management System
+version: 1.0.0
+summary: |
+  Internal system that is the source of truth for customer profile data. Owns the customer database and publishes customer change events for the rest of the business to consume.
+owners:
+  - customer-platform
+services:
+  - id: customer-api
+containers:
+  - id: customer-database
+relationships:
+  - id: identity-provider
+    label: delegates authentication to
+actors:
+  - id: customer
+    name: Customer
+    label: registers and updates their profile
+    direction: inbound
+  - id: support-agent
+    name: Support Agent
+    label: looks up customer details
+    direction: inbound
+badges:
+  - content: Internal
+    backgroundColor: gray
+    textColor: gray
+    icon: LockClosedIcon
+---
+
+## Overview
+
+The **Customer Management System** is the system of record for customer profiles at Acme Inc. It accepts commands to register and update customers, persists them in the [[container|customer-database]], and emits domain events whenever customer data changes so downstream systems can react. It delegates authentication to the [[system|identity-provider]].
+
+## Context Diagram
+
+How this system relates to the other systems around it.
+
+<ContextDiagram />
+
+## Resource Diagram
+
+The services, data stores and messages that make up this system.
+
+<NodeGraph />
+
+## What's inside
+
+| Component                        | Type       | Responsibility                                                                                                |
+| -------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------- |
+| [[service\|customer-api]]        | Service    | Public-facing API. Handles register/update commands and customer reads, and publishes customer change events. |
+| [[container\|customer-database]] | Data store | PostgreSQL system of record for all customer profile data.                                                    |
+
+## Messages this system publishes
+
+When customer data changes, the system emits these events:
+
+- [[event|customer-registered]] — a new customer has registered.
+- [[event|customer-updated]] — an existing customer's profile has changed.

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/RegisterCustomer/index.mdx

@@ -0,0 +1,32 @@
+---
+id: register-customer
+name: Register Customer
+version: 1.0.0
+summary: |
+  Command to register a new customer.
+owners:
+  - customer-platform
+schemaPath: schema.json
+operation:
+  method: POST
+  path: /customers
+  statusCodes: ['201', '400', '409']
+sidebar:
+  badge: 'POST'
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+`RegisterCustomer` is handled by the [[service|customer-api]]. It validates the new customer, writes it to the [[container|customer-database]], and on success publishes a [[event|customer-registered]] event.
+
+## Architecture diagram
+
+<NodeGraph />
+
+## Schema
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+
+<Footer />

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/RegisterCustomer/schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "RegisterCustomer",
+  "description": "Command to register a new customer",
+  "type": "object",
+  "properties": {
+    "email": {
+      "description": "Customer's email address — must be unique",
+      "type": "string",
+      "format": "email"
+    },
+    "name": {
+      "description": "Customer's full name",
+      "type": "string",
+      "minLength": 1
+    },
+    "password": {
+      "description": "Initial password for the customer's credentials",
+      "type": "string",
+      "minLength": 8
+    }
+  },
+  "required": ["email", "password"]
+}

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/UpdateCustomer/index.mdx

@@ -0,0 +1,32 @@
+---
+id: update-customer
+name: Update Customer
+version: 1.0.0
+summary: |
+  Command to update an existing customer's profile.
+owners:
+  - customer-platform
+schemaPath: schema.json
+operation:
+  method: PATCH
+  path: /customers/{customerId}
+  statusCodes: ['200', '400', '404']
+sidebar:
+  badge: 'PATCH'
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+`UpdateCustomer` is handled by the [[service|customer-api]]. It applies a partial update to an existing customer in the [[container|customer-database]] and, on success, publishes a [[event|customer-updated]] event describing what changed.
+
+## Architecture diagram
+
+<NodeGraph />
+
+## Schema
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+
+<Footer />

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/commands/UpdateCustomer/schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "UpdateCustomer",
+  "description": "Command to update an existing customer. Only the fields supplied are changed.",
+  "type": "object",
+  "properties": {
+    "customerId": {
+      "description": "Unique identifier of the customer to update",
+      "type": "string",
+      "format": "uuid"
+    },
+    "email": {
+      "description": "New email address",
+      "type": "string",
+      "format": "email"
+    },
+    "name": {
+      "description": "New full name",
+      "type": "string",
+      "minLength": 1
+    },
+    "status": {
+      "description": "New account status",
+      "type": "string",
+      "enum": ["ACTIVE", "SUSPENDED", "CLOSED"]
+    }
+  },
+  "required": ["customerId"]
+}

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerRegistered/index.mdx

@@ -0,0 +1,29 @@
+---
+id: customer-registered
+name: Customer Registered
+version: 1.0.0
+summary: |
+  Published when a new customer has registered.
+owners:
+  - customer-platform
+badges:
+  - content: 'Broker:Kafka'
+    backgroundColor: blue
+    textColor: blue
+    icon: BoltIcon
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+`CustomerRegistered` is published by the [[service|customer-api]] whenever a new customer successfully registers. Downstream systems consume this event to onboard the customer.
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+
+## Architecture diagram
+
+<NodeGraph />
+
+<Footer />

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerRegistered/schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "CustomerRegistered",
+  "description": "Emitted when a new customer registers",
+  "type": "object",
+  "properties": {
+    "eventId": {
+      "description": "Unique identifier for this event",
+      "type": "string",
+      "format": "uuid"
+    },
+    "occurredAt": {
+      "description": "Time the customer registered",
+      "type": "string",
+      "format": "date-time"
+    },
+    "customer": {
+      "description": "The customer that registered",
+      "type": "object",
+      "properties": {
+        "customerId": {
+          "description": "Unique identifier for the customer",
+          "type": "string",
+          "format": "uuid"
+        },
+        "email": {
+          "description": "Customer's email address",
+          "type": "string",
+          "format": "email"
+        },
+        "name": {
+          "description": "Customer's full name",
+          "type": "string"
+        },
+        "status": {
+          "description": "Lifecycle status of the customer account",
+          "type": "string",
+          "enum": ["ACTIVE", "SUSPENDED", "CLOSED"]
+        }
+      },
+      "required": ["customerId", "email", "status"]
+    }
+  },
+  "required": ["eventId", "occurredAt", "customer"]
+}

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerUpdated/index.mdx

@@ -0,0 +1,29 @@
+---
+id: customer-updated
+name: Customer Updated
+version: 1.0.0
+summary: |
+  Published when an existing customer's profile has changed.
+owners:
+  - customer-platform
+badges:
+  - content: 'Broker:Kafka'
+    backgroundColor: blue
+    textColor: blue
+    icon: BoltIcon
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+`CustomerUpdated` is published by the [[service|customer-api]] whenever an existing customer's profile changes. Downstream systems consume this event to keep their copy of customer data in sync.
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+
+## Architecture diagram
+
+<NodeGraph />
+
+<Footer />

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/events/CustomerUpdated/schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "CustomerUpdated",
+  "description": "Emitted when an existing customer's profile changes",
+  "type": "object",
+  "properties": {
+    "eventId": {
+      "description": "Unique identifier for this event",
+      "type": "string",
+      "format": "uuid"
+    },
+    "occurredAt": {
+      "description": "Time the customer was updated",
+      "type": "string",
+      "format": "date-time"
+    },
+    "customerId": {
+      "description": "Unique identifier for the customer that changed",
+      "type": "string",
+      "format": "uuid"
+    },
+    "changes": {
+      "description": "The fields that changed and their new values",
+      "type": "object",
+      "properties": {
+        "email": {
+          "type": "string",
+          "format": "email"
+        },
+        "name": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string",
+          "enum": ["ACTIVE", "SUSPENDED", "CLOSED"]
+        }
+      },
+      "minProperties": 1
+    }
+  },
+  "required": ["eventId", "occurredAt", "customerId", "changes"]
+}

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/index.mdx

@@ -0,0 +1,72 @@
+---
+id: customer-api
+version: 1.0.0
+name: Customer API
+summary: |
+  The public-facing API for customer profiles. Handles commands to register and update customers, serves customer reads, and publishes customer change events.
+styles:
+  icon: /icons/languages/nodejs.svg
+owners:
+  - customer-platform
+receives:
+  - id: register-customer
+    version: 1.0.0
+  - id: update-customer
+    version: 1.0.0
+  - id: get-customer
+    version: 1.0.0
+sends:
+  - id: customer-registered
+    version: 1.0.0
+  - id: customer-updated
+    version: 1.0.0
+writesTo:
+  - id: customer-database
+readsFrom:
+  - id: customer-database
+repository:
+  language: TypeScript
+  url: 'https://github.com/acme/customer-api'
+specifications:
+  - type: openapi
+    path: openapi.yml
+    name: Customer API
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The **Customer API** is the front door to the Customer Management System. It validates incoming commands, persists customer data to the [[container|customer-database]], and publishes domain events (<ResourceLink id="customer-registered" type="event">CustomerRegistered</ResourceLink>, <ResourceLink id="customer-updated" type="event">CustomerUpdated</ResourceLink>) so the rest of the business can react to changes.
+
+<Tiles>
+  <Tile
+    icon="BoltIcon"
+    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
+    title={`Sends ${frontmatter.sends.length} messages`}
+    description="Domain events published when customer data changes"
+  />
+  <Tile
+    icon="BoltIcon"
+    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
+    title={`Receives ${frontmatter.receives.length} messages`}
+    description="Commands and queries handled by this service"
+  />
+</Tiles>
+
+### Responsibilities
+
+| Area             | Description                                                                            |
+| ---------------- | -------------------------------------------------------------------------------------- |
+| Command handling | Validates and applies [[command\|register-customer]] and [[command\|update-customer]]. |
+| Reads            | Serves [[query\|get-customer]] directly from the customer database.                    |
+| Event publishing | Emits [[event\|customer-registered]] and [[event\|customer-updated]] on every change.  |
+| Persistence      | Reads from and writes to the [[container\|customer-database]] (system of record).      |
+
+## Architecture diagram
+
+<NodeGraph />
+
+<MessageTable format="all" limit={8} />
+
+<Footer />