Design/folder restructure (#91)

ezesunrise · ofuochi · commit 51a1c25af2fd · 2019-10-24T22:07:41.000+01:00
* initial separation of layers

* moved folders to appropriate positions

* restructured application layer
diff --git a/src/core/application/logger_service.ts b/src/core/application/logger_service.ts
@@ -0,0 +1,7 @@
+export interface ILoggerService {
+    silly(message: string, meta?: any): void;
+    error(message: string, meta?: any): void;
+    info(message: string, meta?: any): void;
+    debug(message: string, meta?: any): void;
+    warn(message: string, meta?: any): void;
+}
diff --git a/src/core/application/mail_service.ts b/src/core/application/mail_service.ts
@@ -24,11 +24,3 @@ export interface IMailService {
      */
     startEmailSequence(sequenceType: MailJobType, data: any): void;
 }
-
-export interface ILoggerService {
-    silly(message: string, meta?: any): void;
-    error(message: string, meta?: any): void;
-    info(message: string, meta?: any): void;
-    debug(message: string, meta?: any): void;
-    warn(message: string, meta?: any): void;
-}
diff --git a/src/core/domain/constants/decorators.ts b/src/core/domain/constants/decorators.ts
diff --git a/src/core/domain/constants/types.ts b/src/core/domain/constants/types.ts
diff --git a/src/core/domain/data/db_operators.ts b/src/core/domain/data/db_operators.ts
@@ -1,4 +1,4 @@
-import { iocContainer } from "../../infrastructure/config/ioc";
+import { iocContainer } from "../../../infrastructure/config/ioc";
 import { TYPES } from "../constants/types";
 import { IFunctionQuery } from "./function_query";
 
diff --git a/src/core/domain/data/function_query.ts b/src/core/domain/data/function_query.ts
diff --git a/src/core/domain/data/repositories.ts b/src/core/domain/data/repositories.ts
@@ -1,5 +1,5 @@
-import { Tenant } from "../model/tenant";
-import { User } from "../model/user";
+import { Tenant } from "../models/tenant";
+import { User } from "../models/user";
 
 export type Query<T> = {
     [P in keyof T]?: T[P] | { $regex: RegExp };
diff --git a/src/core/domain/models/base.ts b/src/core/domain/models/base.ts
@@ -2,9 +2,9 @@ import { modelOptions, pre, prop, Ref } from "@typegoose/typegoose";
 import { TimeStamps } from "@typegoose/typegoose/lib/defaultClasses";
 import { Expose } from "class-transformer";
 import { Query } from "mongoose";
-import { winstonLoggerInstance } from "../../infrastructure/bootstrapping/loaders/logger";
-import { iocContainer } from "../../infrastructure/config/ioc";
-import { DecodedJwt } from "../../ui/services/auth_service";
+import { iocContainer } from "../../../infrastructure/config/ioc";
+import { DecodedJwt } from "../../../ui/services/auth_service";
+import { winstonLoggerInstance } from "../../../infrastructure/bootstrapping/loaders/logger";
 import { TYPES } from "../constants/types";
 import { Writable } from "../utils/writable";
 import { User } from "./user";
diff --git a/src/core/domain/models/interfaces/must_have_tenant.ts b/src/core/domain/models/interfaces/must_have_tenant.ts
diff --git a/src/core/domain/models/tenant.ts b/src/core/domain/models/tenant.ts
diff --git a/src/core/domain/models/user.ts b/src/core/domain/models/user.ts
@@ -5,8 +5,8 @@ import {
     Ref,
     modelOptions
 } from "@typegoose/typegoose";
-import { config } from "../../infrastructure/config";
-import { iocContainer } from "../../infrastructure/config/ioc";
+import { iocContainer } from "../../../infrastructure/config/ioc";
+import { config } from "../../../infrastructure/config";
 import { TYPES } from "../constants/types";
 import { Writable } from "../utils/writable";
 import { BaseEntity } from "./base";
diff --git a/src/core/domain/services/auth_service.ts b/src/core/domain/services/auth_service.ts
@@ -1,4 +1,8 @@
-import { UserDto, UserSignInInput, UserSignUpInput } from "../models/user_dto";
+import {
+    UserDto,
+    UserSignInInput,
+    UserSignUpInput
+} from "../../../ui/models/user_dto";
 
 export interface IAuthService {
     signUp(
diff --git a/src/core/domain/services/base_service.ts b/src/core/domain/services/base_service.ts
diff --git a/src/core/domain/services/tenant_service.ts b/src/core/domain/services/tenant_service.ts
@@ -1,5 +1,5 @@
-import { TenantDto } from "../models/tenant_dto";
-import { Tenant } from "../../domain/model/tenant";
+import { TenantDto } from "../../../ui/models/tenant_dto";
+import { Tenant } from "../models/tenant";
 import { IBaseService } from "./base_service";
 
 export interface ITenantService extends IBaseService<Tenant> {
diff --git a/src/core/domain/services/user_service.ts b/src/core/domain/services/user_service.ts
@@ -1,5 +1,5 @@
-import { UserSignUpInput } from "../models/user_dto";
-import { User } from "../../domain/model/user";
+import { UserSignUpInput } from "../../../ui/models/user_dto";
+import { User } from "../models/user";
 
 export interface IUserService {
     create(user: UserSignUpInput): Promise<User>;
diff --git a/src/core/domain/utils/writable.ts b/src/core/domain/utils/writable.ts
diff --git a/src/infrastructure/bootstrapping/index.ts b/src/infrastructure/bootstrapping/index.ts
@@ -5,7 +5,7 @@ import { InversifyExpressServer } from "inversify-express-utils";
 import swaggerUi from "swagger-ui-express";
 import { Controller } from "tsoa";
 import swaggerJsonDoc from "../../../swagger.json";
-import { TYPES } from "../../domain/constants/types";
+import { TYPES } from "../../core/domain/constants/types";
 import { exceptionLoggerMiddleware } from "../../ui/api/middleware/interceptor_middleware";
 import { RegisterRoutes } from "../../ui/api/routes";
 import { config } from "../config";
diff --git a/src/infrastructure/config/inversify.config.ts b/src/infrastructure/config/inversify.config.ts
@@ -1,12 +1,12 @@
 import { EventDispatcher } from "event-dispatch";
 import { ContainerModule } from "inversify";
 // Interfaces & Types
-import { TYPES } from "../../domain/constants/types";
+import { TYPES } from "../../core/domain/constants/types";
 
 // Controllers
 import "../../ui/api/controllers/auth_controller";
 import "../../ui/api/controllers/tenant_controller";
-import { IFunctionQuery } from "../../domain/data/function_query";
+import { IFunctionQuery } from "../../core/domain/data/function_query";
 import { FunctionQuery } from "../db/function_query";
 
 export const referenceDataIoCModule = new ContainerModule(bind => {
diff --git a/src/infrastructure/db/db_client.ts b/src/infrastructure/db/db_client.ts
@@ -1,7 +1,7 @@
 import bcrypt from "bcrypt";
 import mongoose, { Mongoose } from "mongoose";
-import { Tenant } from "../../domain/model/tenant";
-import { User, UserRole } from "../../domain/model/user";
+import { Tenant } from "../../core/domain/models/tenant";
+import { User, UserRole } from "../../core/domain/models/user";
 import { winstonLoggerInstance } from "../bootstrapping/loaders/logger";
 
 export type DbClient = Mongoose;
diff --git a/src/infrastructure/db/function_query.ts b/src/infrastructure/db/function_query.ts
@@ -1,4 +1,4 @@
-import { IFunctionQuery } from "../../domain/data/function_query";
+import { IFunctionQuery } from "../../core/domain/data/function_query";
 
 export class FunctionQuery implements IFunctionQuery {
     and(...operands: any[]): { [key: string]: object } {
diff --git a/src/infrastructure/db/repositories/base_repository.ts b/src/infrastructure/db/repositories/base_repository.ts
@@ -1,14 +1,11 @@
 import { plainToClassFromExist } from "class-transformer";
 import { unmanaged } from "inversify";
 import { Document, Model } from "mongoose";
-import { TYPES } from "../../../domain/constants/types";
-import {
-    IBaseRepository,
-    Query
-} from "../../../domain/interfaces/repositories";
-import { BaseEntity } from "../../../domain/model/base";
-import { winstonLoggerInstance } from "../../bootstrapping/loaders/logger";
+import { TYPES } from "../../../core/domain/constants/types";
+import { IBaseRepository, Query } from "../../../core/domain/data/repositories";
+import { BaseEntity } from "../../../core/domain/models/base";
 import { iocContainer, provideSingleton } from "../../config/ioc";
+import { winstonLoggerInstance } from "../../bootstrapping/loaders/logger";
 
 @provideSingleton(BaseRepository)
 export class BaseRepository<TEntity extends BaseEntity, TModel extends Document>
diff --git a/src/infrastructure/db/repositories/tenant_repository.ts b/src/infrastructure/db/repositories/tenant_repository.ts
@@ -1,5 +1,5 @@
 import { Document } from "mongoose";
-import { Tenant } from "../../../domain/model/tenant";
+import { Tenant } from "../../../core/domain/models/tenant";
 import { provideSingleton } from "../../config/ioc";
 import { BaseRepository } from "./base_repository";
 
diff --git a/src/infrastructure/db/repositories/user_repository.ts b/src/infrastructure/db/repositories/user_repository.ts
@@ -1,6 +1,6 @@
 import { Document } from "mongoose";
-import { IUserRepository } from "../../../domain/interfaces/repositories";
-import { User } from "../../../domain/model/user";
+import { IUserRepository } from "../../../core/domain/data/repositories";
+import { User } from "../../../core/domain/models/user";
 import { provideSingleton } from "../../config/ioc";
 import { BaseRepository } from "./base_repository";
 
diff --git a/src/infrastructure/helpers/tenant_helpers.ts b/src/infrastructure/helpers/tenant_helpers.ts
@@ -1,4 +1,4 @@
-import { Tenant } from "../../domain/model/tenant";
+import { Tenant } from "../../core/domain/models/tenant";
 import { iocContainer } from "../config/ioc";
 import { TenantRepository } from "../db/repositories/tenant_repository";
 
diff --git a/src/infrastructure/jobs/mail_job.ts b/src/infrastructure/jobs/mail_job.ts
@@ -1,5 +1,5 @@
-import { ILoggerService } from "../../domain/interfaces/services";
-import { User } from "../../domain/model/user";
+import { ILoggerService } from "../../core/application/logger_service";
+import { User } from "../../core/domain/models/user";
 import { iocContainer } from "../config/ioc";
 import { LoggerService } from "../services/logger_service";
 
diff --git a/src/infrastructure/services/logger_service.ts b/src/infrastructure/services/logger_service.ts
@@ -1,8 +1,10 @@
-import { ILoggerService } from "../../domain/interfaces/services";
-import { IWinstonLogger, winstonLoggerInstance } from "../bootstrapping/loaders/logger";
+import { ILoggerService } from "../../core/application/logger_service";
+import {
+    IWinstonLogger,
+    winstonLoggerInstance
+} from "../bootstrapping/loaders/logger";
 import { provideSingleton } from "../config/ioc";
 
-
 @provideSingleton(LoggerService)
 export class LoggerService implements ILoggerService {
     private readonly _loggerInstance: IWinstonLogger = winstonLoggerInstance;
diff --git a/src/infrastructure/services/mail_service.ts b/src/infrastructure/services/mail_service.ts
@@ -1,7 +1,7 @@
 import Agenda from "agenda";
 import Mailgun from "mailgun-js";
-import { TYPES } from "../../domain/constants/types";
-import { IMailService } from "../../domain/interfaces/services";
+import { TYPES } from "../../core/domain/constants/types";
+import { IMailService } from "../../core/application/mail_service";
 import { config } from "../config";
 import { iocContainer, provideSingleton } from "../config/ioc";
 import { MailJobType } from "../jobs/mail_job";
diff --git a/src/infrastructure/utils/server_utils.ts b/src/infrastructure/utils/server_utils.ts
@@ -1,6 +1,6 @@
 import { Server } from "http";
 import { Types } from "mongoose";
-import { TYPES } from "../../domain/constants/types";
+import { TYPES } from "../../core/domain/constants/types";
 import { App } from "../bootstrapping/loaders/express";
 import { winstonLoggerInstance as log } from "../bootstrapping/loaders/logger";
 import { config } from "../config";
diff --git a/src/ui/api/controllers/auth_controller.ts b/src/ui/api/controllers/auth_controller.ts
@@ -2,14 +2,14 @@ import { plainToClass } from "class-transformer";
 import { inject } from "inversify";
 import { Body, Post, Route, Security, Tags } from "tsoa";
 import { provideSingleton } from "../../../infrastructure/config/ioc";
-import { IAuthService } from "../../interfaces/auth_service";
 import {
     UserSignInInput,
     UserSignUpDto,
     UserSignUpInput
 } from "../../models/user_dto";
 import { AuthService } from "../../services/auth_service";
 import { BaseController } from "./base_controller";
+import { IAuthService } from "../../../core/domain/services/auth_service";
 
 @Tags("Auth")
 @Route("auth")
diff --git a/src/ui/api/controllers/tenant_controller.ts b/src/ui/api/controllers/tenant_controller.ts
@@ -17,7 +17,7 @@ import {
 import { provideSingleton } from "../../../infrastructure/config/ioc";
 import { isIdValid } from "../../../infrastructure/utils/server_utils";
 import { HttpError } from "../../error";
-import { ITenantService } from "../../interfaces/tenant_service";
+import { ITenantService } from "../../../core/domain/services/tenant_service";
 import {
     CreateTenantInput,
     TenantDto,
diff --git a/src/ui/api/controllers/user_controller.ts b/src/ui/api/controllers/user_controller.ts
@@ -13,7 +13,7 @@ import {
 } from "tsoa";
 import { inject, provideSingleton } from "../../../infrastructure/config/ioc";
 import { HttpError } from "../../error";
-import { IUserService } from "../../interfaces/user_service";
+import { IUserService } from "../../../core/domain/services/user_service";
 import {
     UserDto,
     UserSignUpInput,
diff --git a/src/ui/api/middleware/auth_middleware.ts b/src/ui/api/middleware/auth_middleware.ts
@@ -2,9 +2,9 @@ import { Request } from "express";
 import httpStatus from "http-status-codes";
 import { Container } from "inversify";
 import jwt from "jsonwebtoken";
-import { TYPES } from "../../../domain/constants/types";
-import { ITenantRepository } from "../../../domain/interfaces/repositories";
-import { UserRole } from "../../../domain/model/user";
+import { TYPES } from "../../../core/domain/constants/types";
+import { ITenantRepository } from "../../../core/domain/data/repositories";
+import { UserRole } from "../../../core/domain/models/user";
 import { config as env } from "../../../infrastructure/config";
 import { iocContainer } from "../../../infrastructure/config/ioc";
 import { TenantRepository } from "../../../infrastructure/db/repositories/tenant_repository";
diff --git a/src/ui/models/tenant_dto.ts b/src/ui/models/tenant_dto.ts
@@ -7,7 +7,7 @@ import {
 } from "class-validator";
 import { Expose } from "class-transformer";
 
-import { MAX_NAME_LENGTH } from "../../domain/model/user";
+import { MAX_NAME_LENGTH } from "../../core/domain/models/user";
 import { BaseCreateEntityDto, BaseEntityDto } from "./base_dto";
 
 export class CreateTenantInput extends BaseCreateEntityDto {
diff --git a/src/ui/models/user_dto.ts b/src/ui/models/user_dto.ts
@@ -6,7 +6,7 @@ import {
     MaxLength,
     IsOptional
 } from "class-validator";
-import { MAX_NAME_LENGTH } from "../../domain/model/user";
+import { MAX_NAME_LENGTH } from "../../core/domain/models/user";
 import { BaseEntityDto } from "./base_dto";
 
 export class UserSignUpInput {
diff --git a/src/ui/services/auth_service.ts b/src/ui/services/auth_service.ts
@@ -3,17 +3,21 @@ import { plainToClass } from "class-transformer";
 import { EventDispatcher } from "event-dispatch";
 import httpStatus from "http-status-codes";
 import jwt from "jsonwebtoken";
-import { eventDispatcher } from "../../domain/constants/decorators";
-import { IUserRepository, Query } from "../../domain/interfaces/repositories";
-import { PASSWORD_SALT_ROUND, User, UserRole } from "../../domain/model/user";
+import { eventDispatcher } from "../../core/domain/constants/decorators";
+import { IUserRepository, Query } from "../../core/domain/data/repositories";
+import {
+    PASSWORD_SALT_ROUND,
+    User,
+    UserRole
+} from "../../core/domain/models/user";
 import { config } from "../../infrastructure/config";
 import { inject, provideSingleton } from "../../infrastructure/config/ioc";
 import { UserRepository } from "../../infrastructure/db/repositories/user_repository";
 import { HttpError } from "../error";
-import { IAuthService } from "../interfaces/auth_service";
+import { IAuthService } from "../../core/domain/services/auth_service";
 import { UserDto, UserSignInInput, UserSignUpInput } from "../models/user_dto";
 import { events } from "../subscribers/events";
-import { and, or, lt } from "../../domain/data/db_operators";
+import { and, or, lt } from "../../core/domain/data/db_operators";
 
 export interface DecodedJwt {
     userId: string;
diff --git a/src/ui/services/tenant_service.ts b/src/ui/services/tenant_service.ts
@@ -1,9 +1,9 @@
 import httpStatus from "http-status-codes";
 import { plainToClass } from "class-transformer";
-import { ITenantRepository } from "../../domain/interfaces/repositories";
-import { Tenant } from "../../domain/model/tenant";
+import { ITenantRepository } from "../../core/domain/data/repositories";
+import { Tenant } from "../../core/domain/models/tenant";
 import { provideSingleton, inject } from "../../infrastructure/config/ioc";
-import { ITenantService } from "../interfaces/tenant_service";
+import { ITenantService } from "../../core/domain/services/tenant_service";
 import { TenantDto } from "../models/tenant_dto";
 import { TenantRepository } from "../../infrastructure/db/repositories/tenant_repository";
 import { HttpError } from "../error";
diff --git a/src/ui/services/user_service.ts b/src/ui/services/user_service.ts
@@ -1,12 +1,12 @@
 import bcrypt from "bcrypt";
 import httpStatus from "http-status-codes";
-import { IUserRepository } from "../../domain/interfaces/repositories";
-import { PASSWORD_SALT_ROUND, User } from "../../domain/model/user";
+import { IUserRepository } from "../../core/domain/data/repositories";
+import { PASSWORD_SALT_ROUND, User } from "../../core/domain/models/user";
 import { config } from "../../infrastructure/config";
 import { inject, provideSingleton } from "../../infrastructure/config/ioc";
 import { UserRepository } from "../../infrastructure/db/repositories/user_repository";
 import { HttpError } from "../error";
-import { IUserService } from "../interfaces/user_service";
+import { IUserService } from "../../core/domain/services/user_service";
 import { UserSignUpInput } from "../models/user_dto";
 
 @provideSingleton(UserService)
diff --git a/src/ui/subscribers/user.ts b/src/ui/subscribers/user.ts
@@ -1,7 +1,8 @@
 import { EventSubscriber, On } from "event-dispatch";
 import mongoose from "mongoose";
-import { ILoggerService, IMailService } from "../../domain/interfaces/services";
-import { User } from "../../domain/model/user";
+import { ILoggerService } from "../../core/application/logger_service";
+import { IMailService } from "../../core/application/mail_service";
+import { User } from "../../core/domain/models/user";
 import { iocContainer } from "../../infrastructure/config/ioc";
 import { MailJobType } from "../../infrastructure/jobs/mail_job";
 import { LoggerService } from "../../infrastructure/services/logger_service";
diff --git a/test/infrastructure/db/repository/tenant_repository.test.ts b/test/infrastructure/db/repository/tenant_repository.test.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
-import { ITenantRepository } from "../../../../src/domain/interfaces/repositories";
-import { Tenant } from "../../../../src/domain/model/tenant";
+import { ITenantRepository } from "../../../../src/core/domain/data/repositories";
+import { Tenant } from "../../../../src/core/domain/models/tenant";
 import { iocContainer } from "../../../../src/infrastructure/config/ioc";
 import { TenantRepository } from "../../../../src/infrastructure/db/repositories/tenant_repository";
 import { cleanupDb } from "../../../setup";
diff --git a/test/services/mail_service.test.ts b/test/services/mail_service.test.ts
@@ -3,7 +3,7 @@
 
 // import { startServer } from "../../src";
 // import MailerService from "./../../src/infrastructure/services/mail_service";
-// import { IMailService } from "./../../src/domain/interfaces/services";
+// import { IMailService } from "./../../src/core/domain/interfaces/services";
 
 // let server: Server;
 // describe("Mail service", () => {
diff --git a/test/ui/api/auth_controller.test.ts b/test/ui/api/auth_controller.test.ts
@@ -4,8 +4,8 @@ import { Test } from "supertest";
 import {
     ITenantRepository,
     IUserRepository
-} from "../../../src/domain/interfaces/repositories";
-import { Tenant } from "../../../src/domain/model/tenant";
+} from "../../../src/core/domain/data/repositories";
+import { Tenant } from "../../../src/core/domain/models/tenant";
 import { config } from "../../../src/infrastructure/config";
 import { iocContainer } from "../../../src/infrastructure/config/ioc";
 import { TenantRepository } from "../../../src/infrastructure/db/repositories/tenant_repository";
diff --git a/test/ui/api/tenant_controller.test.ts b/test/ui/api/tenant_controller.test.ts
@@ -4,9 +4,9 @@ import httpStatus from "http-status-codes";
 import {
     ITenantRepository,
     IUserRepository
-} from "../../../src/domain/interfaces/repositories";
-import { Tenant } from "../../../src/domain/model/tenant";
-import { User, UserRole } from "../../../src/domain/model/user";
+} from "../../../src/core/domain/data/repositories";
+import { Tenant } from "../../../src/core/domain/models/tenant";
+import { User, UserRole } from "../../../src/core/domain/models/user";
 import { config } from "../../../src/infrastructure/config";
 import { iocContainer } from "../../../src/infrastructure/config/ioc";
 import { TenantRepository } from "../../../src/infrastructure/db/repositories/tenant_repository";
@@ -15,7 +15,7 @@ import {
     X_AUTH_TOKEN_KEY,
     X_TENANT_ID
 } from "../../../src/ui/constants/header_constants";
-import { IAuthService } from "../../../src/ui/interfaces/auth_service";
+import { IAuthService } from "../../../src/core/domain/services/auth_service";
 import {
     CreateTenantInput,
     TenantDto,
diff --git a/test/ui/api/user_controller.test.ts b/test/ui/api/user_controller.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { iocContainer } from "../../infrastructure/config/ioc";`
	`1`	`+import { iocContainer } from "../../../infrastructure/config/ioc";`
`2`	`2`	`import { TYPES } from "../constants/types";`
`3`	`3`	`import { IFunctionQuery } from "./function_query";`
`4`	`4`