← All examples

multi-timeline

%% multi-timeline.srn — one commerce class diagram, two checkouts. The
%% diagram is written once; each named timeline tells its own story over it.
%% `card` pays by credit card, `wallet` from a digital wallet. The two agree
%% up to the payment step, then take their own way: each shows both payment
%% methods, lets go of the one it does not use and lights up the one it does,
%% before both ship the order.
classDiagram
direction LR

namespace ordering {
  class Order {
    <<aggregate root>>
    -OrderId id
    -OrderStatus status
    -List~OrderLine~ lines
    -Money total
    +addLine(Product product, int qty)
    +removeLine(OrderLineId lineId)
    +place() DomainEvent
    +cancel(String reason) DomainEvent
    -recalculate()
  }
  class OrderLine {
    -OrderLineId id
    -int quantity
    -Money unitPrice
    +subtotal() Money
  }
  class OrderStatus {
    <<enumeration>>
    DRAFT
    PLACED
    PAID
    SHIPPED
    CANCELLED
  }
}

namespace catalog {
  class Product {
    +Sku sku
    +String name
    +Money price
    +isAvailable() bool
  }
  class Money {
    <<value object>>
    +long amount
    +Currency currency
    +add(Money other) Money
    +multiply(int factor) Money
    +zero(Currency c)$ Money
  }
}

namespace payment {
  class PaymentMethod {
    <<abstract>>
    #String holderName
    +authorize(Money amount)* PaymentResult
    +refund(Money amount)* PaymentResult
  }
  class CreditCard {
    -String token
    -String last4
    +authorize(Money amount) PaymentResult
    +refund(Money amount) PaymentResult
  }
  class Wallet {
    -String provider
    -String accountRef
    +authorize(Money amount) PaymentResult
    +refund(Money amount) PaymentResult
  }
  class PaymentResult {
    <<value object>>
    +bool approved
    +String transactionId
    +String failureReason
  }
}

namespace fulfilment {
  class Shipment {
    -ShipmentId id
    -Address destination
    -String trackingNumber
    +dispatch(Carrier carrier)
    +markDelivered()
  }
  class Address {
    <<value object>>
    +String line1
    +String city
    +String postalCode
    +String country
  }
  class Carrier {
    <<interface>>
    +quote(Shipment s) Money
    +book(Shipment s) String
  }
}

class Customer {
  +CustomerId id
  +String email
  -List~Address~ addressBook
  +placeOrder(Cart cart) Order
}

class OrderService {
  -Repository~Order~ orders
  -EventBus bus
  +checkout(Customer c, PaymentMethod pm) Order
  +cancel(OrderId id, String reason)
}

Customer "1" --> "0..*" Order : places
Customer "1" o-- "1..*" Address : keeps
Order "1" *-- "1..*" OrderLine : contains
Order --> OrderStatus
OrderLine "0..*" --> "1" Product : refers to
OrderLine ..> Money
Product ..> Money
Order "1" --> "1..*" PaymentMethod : paid with
PaymentMethod <|-- CreditCard
PaymentMethod <|-- Wallet
PaymentMethod ..> PaymentResult : returns
Order "1" --> "0..*" Shipment : fulfilled by
Shipment *-- Address
Shipment --> Carrier : ships via
OrderService ..> Order : orchestrates

note for Order "Invariant: total == sum of line subtotals"

classDef root fill:#f59e0b33,stroke:#f59e0b,stroke-width:2
classDef value fill:#10b98122,stroke:#10b981
classDef port fill:#3b82f633,stroke:#3b82f6,stroke-width:2
cssClass "Order" root
cssClass "Money,PaymentResult,Address" value
cssClass "Carrier" port

timeline card:
  enter Customer slide-left, enter OrderService slide-top, enter namespace:1 fade, enter OrderLine fade, enter OrderStatus fade, enter Customer-Order fade, enter Order-OrderLine fade, enter Order-OrderStatus fade, enter OrderService-Order fade
  enter namespace:2 slide-bottom, enter Product slide-bottom, enter Money slide-bottom, enter OrderLine-Product fade, enter OrderLine-Money fade, enter Product-Money fade, enter note:1 fade
  enter namespace:3 slide-right, enter PaymentMethod slide-right, enter CreditCard fade, enter Wallet fade, enter Order-PaymentMethod fade, enter PaymentMethod-CreditCard fade, enter PaymentMethod-Wallet fade
  exit Wallet fade, exit PaymentMethod-Wallet fade, highlight CreditCard glow
  enter PaymentResult fade, enter PaymentMethod-PaymentResult fade, highlight PaymentMethod-PaymentResult outline
  unhighlight PaymentMethod-PaymentResult, unhighlight CreditCard, enter namespace:4 slide-right, enter Shipment slide-right, enter Address slide-left, enter Order-Shipment fade, enter Customer-Address fade, enter Shipment-Address fade
  enter Carrier slide-right, enter Shipment-Carrier fade, highlight Shipment glow

timeline wallet:
  enter Customer slide-left, enter OrderService slide-top, enter namespace:1 fade, enter OrderLine fade, enter OrderStatus fade, enter Customer-Order fade, enter Order-OrderLine fade, enter Order-OrderStatus fade, enter OrderService-Order fade
  enter namespace:2 slide-bottom, enter Product slide-bottom, enter Money slide-bottom, enter OrderLine-Product fade, enter OrderLine-Money fade, enter Product-Money fade, enter note:1 fade
  enter namespace:3 slide-right, enter PaymentMethod slide-right, enter CreditCard fade, enter Wallet fade, enter Order-PaymentMethod fade, enter PaymentMethod-CreditCard fade, enter PaymentMethod-Wallet fade
  exit CreditCard fade, exit PaymentMethod-CreditCard fade, highlight Wallet glow
  enter PaymentResult fade, enter PaymentMethod-PaymentResult fade, highlight PaymentMethod-PaymentResult outline
  unhighlight PaymentMethod-PaymentResult, unhighlight Wallet, enter namespace:4 slide-right, enter Shipment slide-right, enter Address slide-left, enter Order-Shipment fade, enter Customer-Address fade, enter Shipment-Address fade
  enter Carrier slide-right, enter Shipment-Carrier fade, highlight Shipment glow