feature: revision module countries core

README.md

@@ -10,6 +10,8 @@ Architecture diagrams
 
 ![Concentric Layers](images/architecture-2.png)
 
+![Dependency Flow](images/architecture-3.png)
+
 ## Project structure
 
 This project is structured by libraries and modules

lerna.json

@@ -1,7 +1,8 @@
 {
+  "version": "1.0.0",
   "packages": [
     "libs/*",
     "modules/**"
   ],
-  "version": "1.0.0"
+  "npmClient": "yarn"
 }

links.txt

@@ -1,7 +1,6 @@
 https://herbertograca.com/2017/11/16/explicit-architecture-01-ddd-hexagonal-onion-clean-cqrs-how-i-put-it-all-together/#application-core-organisation
 https://github.com/stemmlerjs/white-label/tree/master/src
 https://khalilstemmler.com/articles/enterprise-typescript-nodejs/application-layer-use-cases/
-https://github.com/sckv/almeriajs-ddd/
 https://github.com/kgrzybek/modular-monolith-with-ddd/tree/master/src
 https://github.com/ardalis/ddd-guestbook/tree/master/src/CleanArchitecture.Infrastructure
 https://github.com/EduardoPires/EquinoxProject/tree/master/src

modules/countries/app/.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 reports/
-lib/
+lib/
+.env

modules/countries/config/.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 reports/
 lib/
+.env

modules/countries/config/src/env.ts

@@ -1,4 +1,28 @@
 import { resolve } from 'path';
 import { config } from 'dotenv';
 
-config({ path: resolve(__dirname, '.env') });
+export interface CountryDbEnv {
+  name: string;
+  type: string;
+  storage: string;
+}
+
+export interface CountryEnv {
+  db: CountryDbEnv;
+  production: boolean;
+}
+
+export const readEnv = (name: string = '.env'): CountryEnv => {
+  const path = resolve(process.cwd(), name);
+
+  config({ path });
+
+  return {
+    db: {
+      name: process.env.DB_NAME as string,
+      type: process.env.DB_TYPE as string,
+      storage: process.env.DB_STORAGE as string,
+    },
+    production: process.env.NODE_ENV === 'production',
+  };
+};

modules/countries/config/src/index.ts

@@ -1,9 +1 @@
-import './env';
-
-export const DB = {
-  NAME: process.env.DB_NAME,
-  TYPE: process.env.DB_TYPE,
-  STORAGE: process.env.DB_STORAGE,
-};
-
-export const PRODUCTION = process.env.NODE_ENV === 'production';
+export * from './env';

modules/countries/core/.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 reports/
 lib/
+.env

modules/countries/core/src/application/use-cases/create-country/create-country.use-case.ts

@@ -2,7 +2,6 @@ import { UseCase, UseCaseUnexpectedError } from '@micro/kernel';
 import { Either, Result } from '@micro/kernel';
 import { CountryRepository, Iso, Country } from '@domain/index';
 import { IsoInvalidError, CountryInvalidError } from '@domain/errors/index';
-import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { CountryDto } from '@application/dtos/index';
 import { CountryAlreadyExistsError } from './create-country.error';
 
@@ -13,10 +12,10 @@ type Response<T> = Either<
 
 export class CreateCountryUseCase
   implements UseCase<CountryDto, Response<any>> {
-  private countryRepository: CountryRepository;
+  private repository: CountryRepository;
 
-  constructor() {
-    this.countryRepository = new CountryRepositoryImpl();
+  constructor(repository: CountryRepository) {
+    this.repository = repository;
   }
 
   async execute(request: CountryDto): Promise<Response<any>> {
@@ -40,14 +39,14 @@ export class CreateCountryUseCase
     }
 
     const country: Country = countryOrError.value;
-    const countryAlreadyExists = await this.countryRepository.exists(iso.value);
+    const countryAlreadyExists = await this.repository.exists(iso.value);
 
     if (countryAlreadyExists) {
       return Result.fail(CountryAlreadyExistsError.create(iso.value, null));
     }
 
     try {
-      await this.countryRepository.create(country);
+      await this.repository.create(country);
     } catch (err) {
       return Result.fail(UseCaseUnexpectedError.create(err));
     }

modules/countries/core/src/application/use-cases/create-country/index.ts

@@ -1,6 +1,9 @@
-export * from './create-country.error';
-
+import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { CreateCountryUseCase } from './create-country.use-case';
-const createCountryUseCase = new CreateCountryUseCase();
 
+const repository = new CountryRepositoryImpl();
+const createCountryUseCase = new CreateCountryUseCase(repository);
+
+export * from './create-country.error';
+export * from './create-country.use-case';
 export { createCountryUseCase };

modules/countries/core/src/application/use-cases/delete-country/delete.use-case.ts

@@ -2,16 +2,15 @@ import { UseCase, UseCaseUnexpectedError } from '@micro/kernel';
 import { Either, Result } from '@micro/kernel';
 import { CountryRepository, Iso } from '@domain/index';
 import { IsoInvalidError } from '@domain/errors/index';
-import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { IsoDto } from '@application/dtos/index';
 
 type Response<T> = Either<IsoInvalidError | UseCaseUnexpectedError, T>;
 
 export class DeleteCountryUseCase implements UseCase<IsoDto, Response<any>> {
-  private countryRepository: CountryRepository;
+  private repository: CountryRepository;
 
-  constructor() {
-    this.countryRepository = new CountryRepositoryImpl();
+  constructor(repository: CountryRepository) {
+    this.repository = repository;
   }
 
   async execute(request: IsoDto): Promise<Response<any>> {
@@ -24,7 +23,7 @@ export class DeleteCountryUseCase implements UseCase<IsoDto, Response<any>> {
     const iso = isoOrError.value;
 
     try {
-      await this.countryRepository.delete(iso.value);
+      await this.repository.delete(iso.value);
     } catch (err) {
       return Result.fail(UseCaseUnexpectedError.create(err));
     }

modules/countries/core/src/application/use-cases/delete-country/index.ts

@@ -1,5 +1,8 @@
+import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { DeleteCountryUseCase } from './delete.use-case';
 
-const deleteCountryUseCase = new DeleteCountryUseCase();
+const repository = new CountryRepositoryImpl();
+const deleteCountryUseCase = new DeleteCountryUseCase(repository);
 
+export * from './delete.use-case';
 export { deleteCountryUseCase };

modules/countries/core/src/application/use-cases/find-country/find-country.use-case.ts

@@ -2,7 +2,6 @@ import { UseCase, UseCaseUnexpectedError } from '@micro/kernel';
 import { Either, Result } from '@micro/kernel';
 import { CountryRepository, Iso, Country } from '@domain/index';
 import { IsoInvalidError } from '@domain/errors/index';
-import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { IsoDto, CountryDto } from '@application/dtos/index';
 import { Transform } from '@micro/kernel/lib/application';
 import { CountryTransform } from '@application/transforms/index';
@@ -11,12 +10,12 @@ type Response<T> = Either<IsoInvalidError | UseCaseUnexpectedError, T>;
 
 export class FindCountryUseCase
   implements UseCase<IsoDto, Response<CountryDto>> {
-  private countryRepository: CountryRepository;
-  private countryTransform: Transform<Country, CountryDto>;
+  private repository: CountryRepository;
+  private transform: Transform<Country, CountryDto>;
 
-  constructor() {
-    this.countryRepository = new CountryRepositoryImpl();
-    this.countryTransform = new CountryTransform();
+  constructor(repository: CountryRepository) {
+    this.repository = repository;
+    this.transform = new CountryTransform();
   }
 
   async execute(request: IsoDto): Promise<Response<CountryDto>> {
@@ -29,8 +28,8 @@ export class FindCountryUseCase
     const iso = isoOrError.value;
 
     try {
-      const country = await this.countryRepository.findByIso(iso.value);
-      return Result.ok(this.countryTransform.toDto(country));
+      const country = await this.repository.findByIso(iso.value);
+      return Result.ok(this.transform.toDto(country));
     } catch (err) {
       return Result.fail(UseCaseUnexpectedError.create(err));
     }

modules/countries/core/src/application/use-cases/find-country/index.ts

@@ -1,5 +1,8 @@
+import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { FindCountryUseCase } from './find-country.use-case';
 
-const findCountryUseCase = new FindCountryUseCase();
+const repository = new CountryRepositoryImpl();
+const findCountryUseCase = new FindCountryUseCase(repository);
 
+export * from './find-country.use-case';
 export { findCountryUseCase };

modules/countries/core/src/application/use-cases/list-country/index.ts

@@ -1,5 +1,8 @@
+import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { ListCountryUseCase } from './list-country.use-case';
 
-const listCountryUseCase = new ListCountryUseCase();
+const repository = new CountryRepositoryImpl();
+const listCountryUseCase = new ListCountryUseCase(repository);
 
+export * from './list-country.use-case';
 export { listCountryUseCase };

modules/countries/core/src/application/use-cases/list-country/list-country.use-case.ts

@@ -2,7 +2,6 @@ import { UseCase, UseCaseUnexpectedError } from '@micro/kernel';
 import { Either, Result } from '@micro/kernel';
 import { CountryRepository, Country } from '@domain/index';
 import { IsoInvalidError, CountryInvalidError } from '@domain/errors/index';
-import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { IsoDto, CountryDto } from '@application/dtos/index';
 import { Transform } from '@micro/kernel/lib/application';
 import { CountryTransform } from '@application/transforms/index';
@@ -11,18 +10,18 @@ type Response<T> = Either<IsoInvalidError | CountryInvalidError, T>;
 
 export class ListCountryUseCase
   implements UseCase<IsoDto, Response<CountryDto[]>> {
-  private countryRepository: CountryRepository;
-  private countryTransform: Transform<Country, CountryDto>;
+  private repository: CountryRepository;
+  private transform: Transform<Country, CountryDto>;
 
-  constructor() {
-    this.countryRepository = new CountryRepositoryImpl();
-    this.countryTransform = new CountryTransform();
+  constructor(repository: CountryRepository) {
+    this.repository = repository;
+    this.transform = new CountryTransform();
   }
 
   async execute(): Promise<Response<CountryDto[]>> {
     try {
-      const countries = await this.countryRepository.findAll();
-      return Result.ok(this.countryTransform.toColletion!(countries));
+      const countries = await this.repository.findAll();
+      return Result.ok(this.transform.toColletion!(countries));
     } catch (err) {
       return Result.fail(UseCaseUnexpectedError.create(err));
     }

modules/countries/core/src/application/use-cases/update-country/index.ts

@@ -1,6 +1,10 @@
-export * from './update-country.error';
 
+import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { UpdateCountryUseCase } from './update-country.use-case';
-const updateCountryUseCase = new UpdateCountryUseCase();
 
+const repository = new CountryRepositoryImpl();
+const updateCountryUseCase = new UpdateCountryUseCase(repository);
+
+export * from './update-country.error';
+export * from './update-country.use-case';
 export { updateCountryUseCase };

modules/countries/core/src/application/use-cases/update-country/update-country.use-case.ts

@@ -2,7 +2,6 @@ import { UseCase, UseCaseUnexpectedError } from '@micro/kernel';
 import { Either, Result } from '@micro/kernel';
 import { CountryRepository, Iso, Country } from '@domain/index';
 import { IsoInvalidError, CountryInvalidError } from '@domain/errors';
-import { CountryRepositoryImpl } from '@infraestructure/repositories/index';
 import { CountryDto } from '@application/dtos';
 import { CountryNotExistsError } from './update-country.error';
 
@@ -13,10 +12,10 @@ type Response<T> = Either<
 
 export class UpdateCountryUseCase
   implements UseCase<CountryDto, Response<any>> {
-  private countryRepository: CountryRepository;
+  private repository: CountryRepository;
 
-  constructor() {
-    this.countryRepository = new CountryRepositoryImpl();
+  constructor(repository: CountryRepository) {
+    this.repository = repository;
   }
 
   async execute(request: CountryDto): Promise<Response<any>> {
@@ -40,14 +39,14 @@ export class UpdateCountryUseCase
     }
 
     const country: Country = countryOrError.value;
-    const countryAlreadyExists = await this.countryRepository.exists(iso.value);
+    const countryAlreadyExists = await this.repository.exists(iso.value);
 
     if (!countryAlreadyExists) {
       return Result.fail(CountryNotExistsError.create(iso.value, null));
     }
 
     try {
-      await this.countryRepository.update(country);
+      await this.repository.update(country);
     } catch (err) {
       return Result.fail(UseCaseUnexpectedError.create(err));
     }

modules/countries/core/src/index.ts

@@ -1,3 +1,2 @@
-export * from './infraestructure';
 export * from './domain';
 export * from './application';

modules/countries/core/src/infraestructure/database/index.ts

@@ -1,16 +1,18 @@
 import { Sequelize, Dialect } from 'sequelize';
-import { DB, PRODUCTION } from '@micro/country-config';
+import { readEnv } from '@micro/country-config';
 import { Logger } from '@micro/logger';
 
 const l = Logger.create('database');
+const env = readEnv();
 
 export const db = new Sequelize({
-  database: DB.NAME,
-  dialect: DB.TYPE as Dialect,
-  storage: DB.STORAGE,
+  database: env.db.name,
+  dialect: env.db.type as Dialect,
+  storage: env.db.storage,
 });
 
-if (!PRODUCTION) {
+if (!env.production) {
+  l.info('Creando...');
   db.sync({ force: true }).then(() => {
     l.info('Tables created!!!');
   });

modules/countries/core/src/infraestructure/database/models/country.model.ts

@@ -19,6 +19,7 @@ CountryModel.init(
     id: {
       type: DataTypes.UUIDV4,
       allowNull: false,
+      primaryKey: true,
     },
     name: {
       type: DataTypes.STRING,

modules/countries/core/webpack.config.js

@@ -36,7 +36,7 @@ const aliases = Object.keys(tsconfig.compilerOptions.paths).reduce(
 module.exports = {
   target: 'node',
   entry: entries,
-  mode: 'production',
+  mode: 'development',
   module: {
     rules: [
       {

modules/countries/interfaces/console/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

modules/countries/interfaces/console/.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 reports/
-lib/
+lib/
+.env

modules/countries/interfaces/console/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "endOfLine": "auto",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5"
+}

modules/countries/interfaces/console/@types/package.d.ts

@@ -0,0 +1,4 @@
+declare module '*.json' {
+  const value: any;
+  export default value;
+}