Ts-clean-architecture NPM

Typescript - Clean architecture

This is a light and simple type abstraction for clean architecture, domain driven design (DDD), command and query responsibility segregation (CQRS) and event sourcing.

Dir

dir

Installation

Use the npm to install it.

npm install ts-clean-architecture

Or yarn.

yarn add ts-clean-architecture

Usage (How to make..)

A value object (UuID is a implementation of ValueObject and it is in the package):

class UserId extends UuID {
  readonly _tag: string = "UserId";
}

An aggregate:

class User implements Aggregate<UserId> {
  readonly _tag: string = "User";
  constructor(
    public readonly userId: UserId,
    public readonly userName: string,
    public readonly email: string
  ) {}

  id() {
    return this.userId;
  }
}

A repository:

interface UserRepository extends Repository<User> {
  findAllByEmail(email: string): Promise<User[]>;
}

A service:

// Create output  object
class NewUserName extends StringValueObject {
  readonly _tag: string = "NewUserName";
}

// create service
class GenerateUserNameService implements Service<void, Promise<NewUserName>> {
  readonly _tag: string = "GenerateUserNameService";

  execute(input: void): Promise<NewUserName> {
    return Promise.resolve(new NewUserName("jdgonzalez907"));
  }
}

A query responsability:

// Input
class GetUserNamesByEmailQueryInput implements QueryInput {
  readonly _tag: string = "GetUserNamesByEmail";
  constructor(public readonly email: string) {}
}

// Output
class GetUserNamesByEmailQueryOutput implements QueryOutput {
  readonly _tag: string = "GetUserNamesByEmailQueryOutput";
  constructor(public readonly names: string[]) {}
}

// Handler
class GetUserNamesByEmailQueryHandler
  implements
    QueryHandler<
      GetUserNamesByEmailQueryInput,
      Promise<GetUserNamesByEmailQueryOutput>
    >
{
  readonly _tag: string = "GetUserNamesByEmailQueryHandler";

  constructor(private readonly userRepository: UserRepository) {}

  execute(
    input: GetUserNamesByEmailQueryInput
  ): Promise<GetUserNamesByEmailQueryOutput> {
    return this.userRepository.findAllByEmail(input.email).then((users) => {
      return new GetUserNamesByEmailQueryOutput(
        users.map((user) => user.userName)
      );
    });
  }
}