@eventcatalog/create-eventcatalog 4.3.3 → 4.3.4

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 />

package/templates/default/domains/Customer/systems/customer-management-system/services/CustomerAPI/openapi.yml

@@ -0,0 +1,164 @@
+openapi: 3.0.3
+info:
+  title: Customer API
+  version: 1.0.0
+  description: |
+    Public-facing API for the Customer Management System. It is the entry point
+    for registering, updating and reading customers. Every change is persisted
+    to the customer database and published as a customer change event.
+  contact:
+    name: Customer Platform
+    email: customer-platform@acme.test
+servers:
+  - url: https://api.acme.test
+    description: Production
+tags:
+  - name: Customers
+    description: Manage and read customer profiles.
+paths:
+  /customers:
+    post:
+      operationId: registerCustomer
+      summary: Register a customer
+      description: Registers a new customer. On success a `CustomerRegistered` event is published.
+      tags:
+        - Customers
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RegisterCustomerRequest'
+      responses:
+        '201':
+          description: The customer was registered.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Customer'
+        '400':
+          description: The request body was invalid.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '409':
+          description: A customer with the same email already exists.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /customers/{customerId}:
+    parameters:
+      - name: customerId
+        in: path
+        required: true
+        description: Unique identifier of the customer.
+        schema:
+          type: string
+          format: uuid
+    get:
+      operationId: getCustomer
+      summary: Get a customer
+      description: Returns the current state of a single customer by their identifier.
+      tags:
+        - Customers
+      responses:
+        '200':
+          description: The customer was found.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Customer'
+        '404':
+          description: No customer exists with that identifier.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    patch:
+      operationId: updateCustomer
+      summary: Update a customer
+      description: Applies a partial update to an existing customer. On success a `CustomerUpdated` event is published.
+      tags:
+        - Customers
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateCustomerRequest'
+      responses:
+        '200':
+          description: The customer was updated.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Customer'
+        '400':
+          description: The request body was invalid.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '404':
+          description: No customer exists with that identifier.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+components:
+  schemas:
+    Customer:
+      type: object
+      required: [customerId, email, status]
+      properties:
+        customerId:
+          type: string
+          format: uuid
+        email:
+          type: string
+          format: email
+        name:
+          type: string
+        status:
+          type: string
+          enum: [ACTIVE, SUSPENDED, CLOSED]
+        registeredAt:
+          type: string
+          format: date-time
+    RegisterCustomerRequest:
+      type: object
+      required: [email, password]
+      properties:
+        email:
+          type: string
+          format: email
+        name:
+          type: string
+          minLength: 1
+        password:
+          type: string
+          minLength: 8
+    UpdateCustomerRequest:
+      type: object
+      description: Only the fields supplied are changed.
+      minProperties: 1
+      properties:
+        email:
+          type: string
+          format: email
+        name:
+          type: string
+          minLength: 1
+        status:
+          type: string
+          enum: [ACTIVE, SUSPENDED, CLOSED]
+    Error:
+      type: object
+      required: [code, message]
+      properties:
+        code:
+          type: string
+        message:
+          type: string

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

@@ -0,0 +1,32 @@
+---
+id: get-customer
+name: Get Customer
+version: 1.0.0
+summary: |
+  Query to fetch a single customer by their identifier.
+owners:
+  - customer-platform
+schemaPath: schema.json
+operation:
+  method: GET
+  path: /customers/{customerId}
+  statusCodes: ['200', '404']
+sidebar:
+  badge: 'GET'
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+`GetCustomer` is handled by the [[service|customer-api]]. It returns the current state of a single customer, read directly from the [[container|customer-database]].
+
+## 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/queries/GetCustomer/schema.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "GetCustomer",
+  "description": "Query to fetch a single customer by their identifier, and the customer returned",
+  "type": "object",
+  "properties": {
+    "request": {
+      "description": "Parameters used to look up the customer",
+      "type": "object",
+      "properties": {
+        "customerId": {
+          "description": "Unique identifier of the customer to fetch",
+          "type": "string",
+          "format": "uuid"
+        }
+      },
+      "required": ["customerId"]
+    },
+    "response": {
+      "description": "The customer returned by the query",
+      "type": "object",
+      "properties": {
+        "customerId": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "email": {
+          "type": "string",
+          "format": "email"
+        },
+        "name": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string",
+          "enum": ["ACTIVE", "SUSPENDED", "CLOSED"]
+        },
+        "registeredAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "required": ["customerId", "email", "status"]
+    }
+  },
+  "required": ["request", "response"]
+}

package/templates/default/domains/Customer/systems/identity-provider/containers/user-directory/index.mdx

@@ -0,0 +1,36 @@
+---
+id: user-directory
+name: User Directory
+version: 1.0.0
+summary: The directory of customer credentials and identities — the source of truth for authentication.
+container_type: database
+technology: postgres@16
+authoritative: true
+access_mode: readWrite
+purpose: System of record for credentials and login identities
+classification: regulated
+retention: indefinite
+residency: eu-west-1
+styles:
+  icon: /icons/database/postgresql.svg
+---
+
+<NodeGraph />
+
+### What is this?
+
+The **User Directory** is the authoritative store for customer credentials and login identities. The [[service|oauth-api]] reads from it to verify sign-in attempts. It holds **only** authentication data — customer profile data lives separately in the [[system|customer-management-system]]'s [[container|customer-database]].
+
+### What does it store?
+
+- **Identities** — one record per customer: the login email and a securely hashed credential.
+- **Login metadata** — last login time, multi-factor settings, lockout state.
+
+### Why is it separate from the customer profile?
+
+Keeping credentials in a dedicated, **regulated**-classification store isolates the most sensitive data from general profile data. Authentication is owned by the Identity Provider; the Customer Management System never sees raw credentials.
+
+### Security
+
+- Credentials are stored only as salted, hashed values — never in plaintext.
+- Access is tightly restricted to the [[service|oauth-api]] under least-privilege roles.