thiagomini / event-store-ts

Event Store DB Example

This repository contains an example of how to use the Event Store DB Client API for Typescript. The vision is to use the minimal set of dependencies to make it easy to understand how to use the API. This is the stack we use:

• Event Store DB Client API
• Node Test Runner
• TSX

The Domain used here is a simple library system that registers Members and lend Books to them. Here are the main entities:

Book

Attributes:

• id: A unique identifier for the book.
• title: The title of the book.
• author: The author(s) of the book.
• isbn: The International Standard Book Number.
• publishDate: The date the book was published.
• genre: The genre of the book.
• status: Current status (e.g., Available, Borrowed).

Events:

• BookAdded
• BookUpdated
• BookBorrowed
• BookReturned

Member

Attributes:

• id: A unique identifier for the member.
• name: The name of the member.
• email: The member's email address.
• membershipStatus: Status of the membership (e.g., Active, Inactive).
• membershipStartDate: The start date of the membership.

Events: MemberRegistered MemberUpdated

Loan

Attributes:

• id: A unique identifier for the loan.
• bookId: The ID of the borrowed book.
• memberId: The ID of the member who borrowed the book.
• loanStartDate: The start date of the loan.
• loanEndDate: The end date of the loan (if returned).
• dueDate: The due date for returning the book.

Events:

• LoanCreated
• LoanEnded

Diagram

classDiagram
    class Book {
        -id: string
        -title: string
        -author: string
        -isbn: string
        -publishDate: Date
        -genre: string
        -status: string
    }
    class Member {
        -id: string
        -name: string
        -email: string
        -membershipStartDate: Date
        -membershipStatus: string
    }
    class Loan {
        -id: string
        -bookId: string
        -memberId: string
        -loanStartDate: Date
        -loanEndDate: Date
        -dueDate: Date
    }

    class BookAdded
    class BookUpdated
    class BookBorrowed
    class BookReturned
    class MemberRegistered
    class MemberUpdated
    class LoanCreated
    class LoanEnded

    Book "1" --o "0..*" Loan : has
    Member "1" --o "0..*" Loan : has
    Book --|> BookAdded : triggers
    Book --|> BookUpdated : triggers
    Book --|> BookBorrowed : triggers
    Book --|> BookReturned : triggers
    Member --|> MemberRegistered : triggers
    Member --|> MemberUpdated : triggers
    Loan --|> LoanCreated : triggers
    Loan --|> LoanEnded : triggers