@anthonylzq/simba.js 1.10.0 → 2.0.3

package/README.md

@@ -6,7 +6,7 @@ Set up a modern backend app by running one command. This project has the goal to
 
 - `.env`
 - `.eslintignore`
-- `.eslintrc.js`
+- `.eslintrc`
 - `.gitignore`
 - `CHANGELOG.md`
 - `Dockerfile`
@@ -15,15 +15,17 @@ Set up a modern backend app by running one command. This project has the goal to
 - `nodemon.json`
 - `package.json`
 - `README.md`
+- `tsconfig.base.json`
 - `tsconfig.json`
 - `webpack.config.js`
+- `yarn.lock`  (or `package-lock.json`)
 
 ## Installation
 
 This package is meant to be installed globally in your computer by using:
 
 ```bash
-npm i -g simba.js
+npm i -g @anthonylzq/simba.js
 ```
 
 ## Usage
@@ -86,8 +88,8 @@ Options:
   -h, --help                Show help                                  [boolean]
 
 Examples:
-  simba  -N "Project Name" -D "Project description -a Anthony -e
-  sluzquinosa@uni.pe"
+  simba -N 'Project Name' -D 'Project description' -a Anthony -e
+  sluzquinosa@uni.pe
 
 Developed by AnthonyLzq
 ```
@@ -95,34 +97,56 @@ Developed by AnthonyLzq
 Regardless of the option chosen, a new folder will be generated with the name of the project, it will contain the following structure:
 
 ```
-📦node_modules
-📦src
+📂node_modules
+📂src
  ┣ 📂@types
- ┃ ┣ 📜index.d.ts
- ┣ 📂controllers
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
- ┣ 📂dto-interfaces
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.dto.ts
- ┣ 📂models
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
+ ┃ ┣ 📂custom
+ ┃ ┃ ┣ 📜request.d.ts
+ ┃ ┃ ┗ 📜response.d.ts
+ ┃ ┣ 📂dto
+ ┃ ┃ ┗ 📜user.d.ts
+ ┃ ┣ 📂models
+ ┃ ┃ ┗ 📜user.d.ts
+ ┃ ┗ 📜index.d.ts
+ ┣ 📂database
+ ┃ ┣ 📂mongo
+ ┃ ┃ ┣ 📂models
+ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┣ 📂queries
+ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┗ 📜index.ts
+ ┃ ┗ 📜index.ts
  ┣ 📂network
+ ┃ ┣ 📂routes
+ ┃ ┃ ┣ 📂schemas
+ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┣ 📜home.ts
+ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┗ 📜user.ts
  ┃ ┣ 📜index.ts
+ ┃ ┣ 📜response.ts
  ┃ ┣ 📜routes.ts
  ┃ ┗ 📜server.ts
- ┣ 📂routes
- ┃ ┣ 📜home.ts
+ ┣ 📂services
+ ┃ ┣ 📂utils
+ ┃ ┃ ┣ 📂messages
+ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┗ 📜index.ts
  ┃ ┣ 📜index.ts
  ┃ ┗ 📜user.ts
+ ┣ 📂test
+ ┃ ┗ 📜test.http
  ┣ 📂utils
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜response.ts
+ ┃ ┣ 📜docs.json
+ ┃ ┗ 📜index.ts
  ┗ 📜index.ts
 📜.env
 📜.eslintignore
-📜.eslintrc.js
+📜.eslintrc
 📜.gitignore
 📜CHANGELOG.md
 📜Dockerfile
@@ -131,6 +155,7 @@ Regardless of the option chosen, a new folder will be generated with the name of
 📜nodemon.json
 📜package.json
 📜README.md
+📜tsconfig.base.json
 📜tsconfig.json
 📜webpack.config.js
 📜yarn.lock (or package-lock.json)
@@ -160,8 +185,8 @@ simba -N myProject -D 'This is a test' -a myName -e myEmail@email.com -H
 
 ### Some considerations
 
-- This project is based in other project from my own, [`typescript-project-generator`](https://www.npmjs.com/package/typescript-project-generator), but only considering the `express-mongoose-node` part.
-- You are able to run a server that has one main route, `home` (`/`), `user` (`api/user` or `api/user/:userId`) and `docs` (`api/docs`).
+- This project was based in other project from my own, [`typescript-project-generator`](https://www.npmjs.com/package/typescript-project-generator), but only considering the `express-mongoose` part.
+- You are able to run a server that has one main route, `home` (`/`), `user` (`api/user` or `api/user/:id`) and `docs` (`api/docs`).
 - To connect your server with your `MongoDB` database, you need to provide your `uri` in the `.env`. By default, Simba will try to connect to a local database. The content of the `.env` file is:
 
   ```bash
@@ -182,11 +207,16 @@ simba -N myProject -D 'This is a test' -a myName -e myEmail@email.com -H
     // Some more code...
 
     // another file
-    globalStringVariable = 'Hi mom, I am global'
+    global.globalStringVariable = 'Hi mom, I am global'
     console.log({ globalStringVariable })
     ```
 
-- The provided project structure is inspired in my personal experience as [`Node.js`](https://nodejs.org/en/) developer and the [`Nest`](https://nestjs.com/) framework.
+- The provided project structure is inspired in my personal experience as [`Node.js`](https://nodejs.org/en/) developer and the [`Nest`](https://nestjs.com/) framework. It follows a layered architecture:
+
+  1. Presentation layer (network layer): it is represented by the network folder, which contains the routes and the necessary schemas for each route.
+  2. Business layer (services layer): it is represented by the services folder, which contains all the code related to the business logic of your application.
+  3. Persistance layer (database layer): it is represented by the database folder, which contains the database connection, models and queries (that will be used by the services). Multiple database connection are possible and should be implemented here.
+
 - The server is fully tested and has no errors (at least for now), feel free to report one [here](https://github.com/AnthonyLzq/simba.js/issues).
 - Support for windows and linux platforms is available.
 - To check the content of the files generated, please check the `example` folder.
@@ -215,8 +245,6 @@ Here is the list of the packages that are being installed, as `devDependencies`:
 - [`eslint-config-standard`](https://www.npmjs.com/package/eslint-config-standard)
 - [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import)
 - [`eslint-plugin-prettier`](https://www.npmjs.com/package/eslint-plugin-prettier)
-- [`eslint-plugin-sort-keys-fix`](https://www.npmjs.com/package/eslint-plugin-sort-keys-fix)
-- [`eslint-plugin-typescript-sort-keys`](https://www.npmjs.com/package/eslint-plugin-typescript-sort-keys)
 - [`nodemon`](https://www.npmjs.com/package/nodemon)
 - [`prettier`](https://www.npmjs.com/package/prettier)
 - [`standard-version`](https://www.npmjs.com/package/standard-version)

package/lib/index.js

@@ -12,7 +12,7 @@ const argv = yargs(hideBin(process.argv))
     'simba [options] (if you it installed globally) or only simba if you want to be asked for the options one by one'
   )
   .example(
-    'simba  -N "Project Name" -D "Project description -a Anthony -e sluzquinosa@uni.pe"'
+    "simba -N 'Project Name' -D 'Project description' -a Anthony -e sluzquinosa@uni.pe"
   )
   .alias('N', 'projectName')
   .nargs('N', 1)

package/lib/src/functions/docker.js

@@ -14,11 +14,11 @@ COPY package.json ./
 
 RUN yarn install --prod
 
-RUN yarn add webpack webpack-node-externals -D
+RUN yarn add webpack webpack-node-externals tsconfig-paths-webpack-plugin -D
 
 RUN yarn build
 
-RUN yarn remove webpack webpack-node-externals
+RUN yarn remove webpack webpack-node-externals tsconfig-paths-webpack-plugin
 
 COPY dist /app/dist
 

package/lib/src/functions/eslint.js

@@ -74,7 +74,7 @@ module.exports = async projectName => {
   }
 }
 `,
-    eslintFile: '.eslintrc.js',
+    eslintFile: '.eslintrc',
     eslintIgnoreContent: '/dist',
     eslintIgnoreFile: '.eslintignore'
   }

package/lib/src/functions/express.js

@@ -1,3 +1,4 @@
+const os = require('os')
 const util = require('util')
 const exec = util.promisify(require('child_process').exec)
 const writeFile = require('../utils/writeFile')
@@ -5,30 +6,39 @@ const writeFile = require('../utils/writeFile')
 /*
  * src
  * |- @types:
+ * |- |- dto:
+ * |- |- |- user: content, file
+ * |- |- models:
+ * |- |- |- user: content, file
  * |  |- index: content, file
- * |- controllers:
- * |  |- utils:
- * |  |  |- messages:
+ * |- database:
+ * |  |- mongo:
+ * |  |- |- models:
+ * |  |- |- |- index: content, file
+ * |  |- |- |- user: content, file
+ * |  |- |- queries:
+ * |  |- |- |- index: content, file
+ * |  |- |- |- user: content, file
+ * |  |- |- index: content, file
+ * |  |- index: content, file
+ * |- network:
+ * |  |- routes:
+ * |  |  |- schemas:
  * |  |  |  |- user: content, file
  * |  |  |  |- index: content, file
+ * |  |  |- home: content, file
+ * |  |  |- user: content, file
  * |  |  |- index: content, file
- * |  |- user: content, file
- * |  |- index: content, file
- * |- dto-interfaces:
- * |  |- user: content, file
- * |  |- index: content, file
- * |- models:
- * |  |- user: content, file
- * |  |- index: content, file
- * |- network:
+ * |  |  |- response: content, file
+ * |  |- router: content, file
  * |  |- server: content, file
- * |  |- routes: content, file
- * |  |- index: content, file
- * |- routes:
- * |  |- home: content, file
- * |  |- user: content, file
  * |  |- index: content, file
- * |- schemas:
+ * |- services:
+ * |  |- utils:
+ * |  |  |- messages:
+ * |  |  |  |- user: content, file
+ * |  |  |  |- index: content, file
+ * |  |  |- index: content, file
  * |  |- user: content, file
  * |  |- index: content, file
  * |- test:
@@ -50,268 +60,86 @@ module.exports = async (projectName, projectVersion, email) => {
     '@types': {
       index: {
         content: `/* eslint-disable no-var */
-import { IncomingHttpHeaders } from 'http'
-import { Request, Response } from 'express'
-
-import { DtoUser } from 'dto-interfaces'
-
-declare global {
-  interface ResponseProps {
-    error: boolean
-    message: unknown
-    res: Response
-    status: number
-  }
-  // This variable is global, so it will be available everywhere in the code
-  var response: ({ error, message, res, status }: ResponseProps) => void
-
-  // We can personalize the response and request objects in case we need it by
-  // adding new optional attributes to this interface
-  interface CustomResponse extends Response {
-    newValue?: string
-  }
-
-  interface CustomRequest extends Request {
-    body: {
-      args?: DtoUser
-    }
-    // We can add custom headers via intersection, remember that for some reason
-    // headers must be in Snake-Pascal-Case
-    headers: IncomingHttpHeaders & {
-      'Custom-Header'?: string
-    }
-  }
-}
+declare global {}
 
 export {}
 `,
         file: `${projectName}/src/@types/index.d.ts`
       }
     },
-    controllers: {
-      index: {
-        content: `import { User } from './user'
-
-export { User }
-`,
-        file: `${projectName}/src/controllers/index.ts`
-      },
+    '@types/dto': {
       user: {
-        content: `import httpErrors from 'http-errors'
-
-import { DtoUser } from 'dto-interfaces'
-import { IUser, UserModel } from 'models'
-import { EFU, MFU, GE, errorHandling } from './utils'
-
-type Process = {
-  type: 'store' | 'getAll' | 'deleteAll' | 'getOne' | 'update' | 'delete'
+        content: `interface DtoUser {
+  id?: string
+  lastName?: string
+  name?: string
 }
+`,
+        file: `${projectName}/src/@types/dto/user.d.ts`
+      }
+    },
+    '@types/custom': {
+      request: {
+        content: `type ExpressRequest = import('express').Request
 
-class User {
-  private _args: DtoUser | null
-
-  constructor(args: DtoUser | null = null) {
-    this._args = args
-  }
-
-  public process({
-    type
-  }: Process): Promise<string> | Promise<IUser[]> | Promise<IUser> {
-    switch (type) {
-      case 'store':
-        return this._store()
-      case 'getAll':
-        return this._getAll()
-      case 'deleteAll':
-        return this._deleteAll()
-      case 'getOne':
-        return this._getOne()
-      case 'update':
-        return this._update()
-      case 'delete':
-        return this._delete()
-      default:
-        throw new httpErrors.InternalServerError(GE.INTERNAL_SERVER_ERROR)
-    }
-  }
-
-  private async _store(): Promise<IUser> {
-    const { lastName, name } = this._args as DtoUser
-
-    try {
-      const newUser = new UserModel({ lastName, name })
-      const result = await newUser.save()
-
-      return result
-    } catch (e) {
-      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
-    }
-  }
-
-  private async _getAll(): Promise<IUser[]> {
-    try {
-      const users = await UserModel.find({})
-
-      return users
-    } catch (e) {
-      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
-    }
-  }
-
-  private async _deleteAll(): Promise<string> {
-    try {
-      const usersDeleted = await UserModel.deleteMany({})
-
-      if (usersDeleted.deletedCount >= 1) return MFU.ALL_USERS_DELETED
-
-      if (usersDeleted.deletedCount === 0)
-        throw new httpErrors.BadRequest(EFU.NOTHING_TO_DELETE)
-
-      throw new httpErrors.InternalServerError(GE.INTERNAL_SERVER_ERROR)
-    } catch (e) {
-      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
-    }
-  }
-
-  private async _getOne(): Promise<IUser> {
-    const { id } = this._args as DtoUser
-
-    try {
-      const user = await UserModel.findById(id)
-
-      if (!user) throw new httpErrors.NotFound(EFU.NOT_FOUND)
-
-      return user
-    } catch (e) {
-      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
-    }
+interface CustomRequest extends ExpressRequest {
+  body: {
+    args?: DtoUser
   }
-
-  private async _update(): Promise<IUser> {
-    const { id, lastName, name } = this._args as DtoUser
-
-    try {
-      const updatedUser = await UserModel.findByIdAndUpdate(
-        id,
-        { lastName, name },
-        { new: true }
-      )
-
-      if (!updatedUser) throw new httpErrors.NotFound(EFU.NOT_FOUND)
-
-      return updatedUser
-    } catch (e) {
-      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
-    }
-  }
-
-  private async _delete(): Promise<string> {
-    const { id } = this._args as DtoUser
-
-    try {
-      const deletedUser = await UserModel.findByIdAndRemove(id)
-
-      if (!deletedUser) throw new httpErrors.NotFound(EFU.NOT_FOUND)
-
-      return MFU.USER_DELETED
-    } catch (e) {
-      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
-    }
+  // We can add custom headers via intersection, remember that for some reason
+  // headers must be in Snake-Pascal-Case
+  headers: import('http').IncomingHttpHeaders & {
+    'Custom-Header'?: string
   }
 }
-
-export { User }
 `,
-        file: `${projectName}/src/controllers/user.ts`
-      }
-    },
-    'controllers/utils': {
-      index: {
-        content: `import httpErrors from 'http-errors'
-
-import { EFU, MFU, GE } from './messages'
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const errorHandling = (e: any, message?: string): never => {
-  console.error(e)
-
-  if (e instanceof httpErrors.HttpError) throw e
+        file: `${projectName}/src/@types/custom/request.d.ts`
+      },
+      response: {
+        content: `type ExpressResponse = import('express').Response
 
-  throw new httpErrors.InternalServerError(message ?? e.message)
+interface CustomResponse extends ExpressResponse {
+  newValue?: string
 }
-
-export { EFU, MFU, GE, errorHandling }
 `,
-        file: `${projectName}/src/controllers/utils/index.ts`
+        file: `${projectName}/src/@types/custom/response.d.ts`
       }
     },
-    'controllers/utils/messages': {
-      index: {
-        content: `import { EFU, MFU } from './user'
-
-enum GenericErrors {
-  INTERNAL_SERVER_ERROR = 'Something went wrong'
-}
-
-export { EFU, MFU, GenericErrors as GE }
-`,
-        file: `${projectName}/src/controllers/utils/messages/index.ts`
-      },
+    '@types/models': {
       user: {
-        content: `enum ErrorForUser {
-  NOT_FOUND = 'The requested user does not exists',
-  NOTHING_TO_DELETE = 'There is no user to be deleted'
-}
-
-enum MessageForUser {
-  ALL_USERS_DELETED = 'All the users were deleted successfully',
-  USER_DELETED = 'The requested user was successfully deleted'
+        content: `interface IUser {
+  _id: import('mongoose').Types.ObjectId
+  name: string
+  lastName: string
+  updatedAt: Date
 }
-
-export { ErrorForUser as EFU, MessageForUser as MFU }
 `,
-        file: `${projectName}/src/controllers/utils/messages/user.ts`
+        file: `${projectName}/src/@types/models/user.d.ts`
       }
     },
-    'dto-interfaces': {
+    database: {
       index: {
-        content: `import { DtoUser } from './user'
-
-export { DtoUser }
-`,
-        file: `${projectName}/src/dto-interfaces/index.ts`
-      },
-      user: {
-        content: `interface DtoUser {
-  id: string
-  lastName?: string
-  name?: string
-}
-
-export { DtoUser }
-`,
-        file: `${projectName}/src/dto-interfaces/user.ts`
+        content: "export * from './mongo'\n",
+        file: `${projectName}/src/database/index.ts`
       }
     },
-    models: {
+    'database/mongo': {
       index: {
-        content: `import { IUser, UserModel } from './user'
-
-export { IUser, UserModel }
+        content: `export * from './models'
+export * from './queries'
 `,
-        file: `${projectName}/src/models/index.ts`
+        file: `${projectName}/src/database/mongo/index.ts`
+      }
+    },
+    'database/mongo/models': {
+      index: {
+        content: "export * from './user'\n",
+        file: `${projectName}/src/database/mongo/models/index.ts`
       },
       user: {
-        content: `/* eslint-disable no-underscore-dangle */
-import { Document, model, Schema } from 'mongoose'
+        content: `import { model, Schema } from 'mongoose'
 
-interface IUser extends Document {
-  lastName: string
-  name: string
-  updatedAt: Date
-}
-
-const User = new Schema(
+const User = new Schema<IUser>(
   {
     lastName: {
       required: true,
@@ -326,36 +154,98 @@ const User = new Schema(
     timestamps: {
       createdAt: false,
       updatedAt: true
+    },
+    toJSON: {
+      transform(_, ret) {
+        ret.id = ret._id
+        delete ret._id
+        delete ret.__v
+        delete ret.updatedAt
+      },
+      versionKey: false,
+      virtuals: true
     }
   }
 )
 
-User.set('toJSON', {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  transform: function (_: any, ret: any) {
-    ret.id = ret._id
-    delete ret._id
-    delete ret.__v
-    delete ret.updatedAt
-  },
-  versionKey: false,
-  virtuals: true
-})
-
 const UserModel = model<IUser>('users', User)
 
-export { IUser, UserModel }
+export { UserModel }
+`,
+        file: `${projectName}/src/database/mongo/models/user.ts`
+      }
+    },
+    'database/mongo/queries': {
+      index: {
+        content: "export * from './user'\n",
+        file: `${projectName}/src/database/mongo/queries/index.ts`
+      },
+      user: {
+        content: `import { UserModel } from '../models'
+
+const store = async (userData: DtoUser): Promise<IUser> => {
+  const user = new UserModel(userData)
+
+  return await user.save()
+}
+
+const remove = async (
+  id: string | null = null
+): Promise<IUser | number | null> => {
+  if (id) return await UserModel.findByIdAndRemove(id)
+
+  return (await UserModel.deleteMany({})).deletedCount
+}
+
+const get = async (
+  id: string | null = null
+): Promise<IUser[] | IUser | null> => {
+  if (id) return await UserModel.findById(id)
+
+  return await UserModel.find({})
+}
+
+const update = async (userData: DtoUser): Promise<IUser | null> => {
+  const { id, ...rest } = userData
+
+  return await UserModel.findByIdAndUpdate(id, rest, { new: true })
+}
+
+export { store, remove, get, update }
 `,
-        file: `${projectName}/src/models/user.ts`
+        file: `${projectName}/src/database/mongo/queries/user.ts`
       }
     },
     network: {
-      routes: {
+      index: {
+        content: `export * from './routes'
+export * from './server'
+`,
+        file: `${projectName}/src/network/index.ts`
+      },
+      response: {
+        content: `interface ResponseProps {
+  error: boolean
+  message: unknown
+  res: CustomResponse
+  status: number
+}
+
+const response = ({ error, message, res, status }: ResponseProps): void => {
+  res.status(status).send({ error, message })
+}
+
+export { response }
+`,
+        file: `${projectName}/src/network/response.ts`
+      },
+      router: {
         content: `import { Application, Response, Request, Router, NextFunction } from 'express'
 import swaggerUi from 'swagger-ui-express'
 import httpErrors from 'http-errors'
 
-import { Home, User } from 'routes'
+import { response } from './response'
+import { Home, User } from './routes'
 import { docs } from 'utils'
 
 const routers = [User]
@@ -389,14 +279,14 @@ const applyRoutes = (app: Application): void => {
 
 export { applyRoutes }
 `,
-        file: `${projectName}/src/network/routes.ts`
+        file: `${projectName}/src/network/router.ts`
       },
       server: {
         content: `import express from 'express'
 import mongoose from 'mongoose'
 import morgan from 'morgan'
 
-import { applyRoutes } from './routes'
+import { applyRoutes } from './router'
 
 const PORT = (process.env.PORT as string) || '1996'
 
@@ -430,16 +320,6 @@ class Server {
       }
     )
 
-    // setting up the global response
-    global.response = ({
-      error,
-      message,
-      res,
-      status
-    }: ResponseProps): void => {
-      res.status(status).send({ error, message })
-    }
-
     applyRoutes(this._app)
   }
 
@@ -495,20 +375,14 @@ const server = new Server()
 export { server as Server }
 `,
         file: `${projectName}/src/network/server.ts`
-      },
-      index: {
-        content: `import { applyRoutes } from './routes'
-import { Server } from './server'
-
-export { applyRoutes, Server }
-`,
-        file: `${projectName}/src/network/index.ts`
       }
     },
-    routes: {
+    'network/routes': {
       home: {
         content: `import { Response, Request, Router } from 'express'
 
+import { response } from 'network/response'
+
 const Home = Router()
 
 Home.route('').get((req: Request, res: Response) => {
@@ -522,24 +396,22 @@ Home.route('').get((req: Request, res: Response) => {
 
 export { Home }
 `,
-        file: `${projectName}/src/routes/home.ts`
+        file: `${projectName}/src/network/routes/home.ts`
       },
       index: {
-        content: `import { Home } from './home'
-import { User } from './user'
-
-export { Home, User }
+        content: `export * from './home'
+export * from './user'
 `,
-        file: `${projectName}/src/routes/index.ts`
+        file: `${projectName}/src/network/routes/index.ts`
       },
       user: {
         content: `import { Router, NextFunction } from 'express'
 import httpErrors from 'http-errors'
 import { ValidationError } from 'joi'
 
-import { User as UserC } from 'controllers/user'
-import { DtoUser } from 'dto-interfaces'
-import { idSchema, userSchema } from 'schemas'
+import { response } from 'network/response'
+import { UserService } from 'services/user'
+import { idSchema, userSchema } from './schemas'
 
 const User = Router()
 
@@ -553,10 +425,10 @@ User.route('/users')
       const {
         body: { args }
       } = req
-      const u = new UserC(args as DtoUser)
+      const us = new UserService(args as DtoUser)
 
       try {
-        const result = await u.process({ type: 'store' })
+        const result = await us.process({ type: 'store' })
         response({ error: false, message: result, res, status: 201 })
       } catch (e) {
         next(e)
@@ -569,10 +441,10 @@ User.route('/users')
       res: CustomResponse,
       next: NextFunction
     ): Promise<void> => {
-      const u = new UserC()
+      const us = new UserService()
 
       try {
-        const result = await u.process({ type: 'getAll' })
+        const result = await us.process({ type: 'getAll' })
         response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         next(e)
@@ -585,10 +457,10 @@ User.route('/users')
       res: CustomResponse,
       next: NextFunction
     ): Promise<void> => {
-      const u = new UserC()
+      const us = new UserService()
 
       try {
-        const result = await u.process({ type: 'deleteAll' })
+        const result = await us.process({ type: 'deleteAll' })
         response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         next(e)
@@ -609,8 +481,8 @@ User.route('/user/:id')
 
       try {
         await idSchema.validateAsync(id)
-        const u = new UserC({ id } as DtoUser)
-        const result = await u.process({ type: 'getOne' })
+        const us = new UserService({ id } as DtoUser)
+        const result = await us.process({ type: 'getOne' })
         response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         if (e instanceof ValidationError)
@@ -637,8 +509,8 @@ User.route('/user/:id')
 
       try {
         await userSchema.validateAsync(user)
-        const u = new UserC(user)
-        const result = await u.process({ type: 'update' })
+        const us = new UserService(user)
+        const result = await us.process({ type: 'update' })
         response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         if (e instanceof ValidationError)
@@ -660,8 +532,8 @@ User.route('/user/:id')
 
       try {
         await idSchema.validateAsync(id)
-        const u = new UserC({ id } as DtoUser)
-        const result = await u.process({ type: 'delete' })
+        const us = new UserService({ id } as DtoUser)
+        const result = await us.process({ type: 'delete' })
         response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         if (e instanceof ValidationError)
@@ -674,20 +546,19 @@ User.route('/user/:id')
 
 export { User }
 `,
-        file: `${projectName}/src/routes/user.ts`
+        file: `${projectName}/src/network/routes/user.ts`
       }
     },
-    schemas: {
+    'network/routes/schemas': {
       index: {
         content: `import Joi from 'joi'
 
-import { userSchema } from './user'
-
 const idSchema = Joi.string().length(24).required()
 
-export { idSchema, userSchema }
+export { idSchema }
+export * from './user'
 `,
-        file: `${projectName}/src/schemas/index.ts`
+        file: `${projectName}/src/network/routes/schemas/index.ts`
       },
       user: {
         content: `import Joi from 'joi'
@@ -700,7 +571,175 @@ const userSchema = Joi.object().keys({
 
 export { userSchema }
 `,
-        file: `${projectName}/src/schemas/user.ts`
+        file: `${projectName}/src/network/routes/schemas/user.ts`
+      }
+    },
+    services: {
+      index: {
+        content: "export * from './user'\n",
+        file: `${projectName}/src/services/index.ts`
+      },
+      user: {
+        content: `import httpErrors from 'http-errors'
+
+import { store, remove, get, update } from 'database'
+import { EFU, MFU, GE, errorHandling } from './utils'
+
+type Process = {
+  type: 'store' | 'getAll' | 'deleteAll' | 'getOne' | 'update' | 'delete'
+}
+
+class UserService {
+  private _args: DtoUser | null
+
+  constructor(args: DtoUser | null = null) {
+    this._args = args
+  }
+
+  public process({ type }: Process): Promise<string | IUser[] | IUser> {
+    switch (type) {
+      case 'store':
+        return this._store()
+      case 'getAll':
+        return this._getAll()
+      case 'deleteAll':
+        return this._deleteAll()
+      case 'getOne':
+        return this._getOne()
+      case 'update':
+        return this._update()
+      case 'delete':
+        return this._delete()
+      default:
+        throw new httpErrors.InternalServerError(GE.INTERNAL_SERVER_ERROR)
+    }
+  }
+
+  private async _store(): Promise<IUser> {
+    try {
+      const result = await store(this._args as DtoUser)
+
+      return result
+    } catch (e) {
+      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
+    }
+  }
+
+  private async _getAll(): Promise<IUser[]> {
+    try {
+      const users = (await get()) as IUser[]
+
+      return users
+    } catch (e) {
+      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
+    }
+  }
+
+  private async _deleteAll(): Promise<string> {
+    try {
+      const usersDeleted = (await remove()) as number
+
+      if (usersDeleted >= 1) return MFU.ALL_USERS_DELETED
+
+      if (usersDeleted === 0)
+        throw new httpErrors.Conflict(EFU.NOTHING_TO_DELETE)
+
+      throw new httpErrors.InternalServerError(GE.INTERNAL_SERVER_ERROR)
+    } catch (e) {
+      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
+    }
+  }
+
+  private async _getOne(): Promise<IUser> {
+    const { id } = this._args as DtoUser
+
+    try {
+      const user = (await get(id as string)) as IUser | null
+
+      if (!user) throw new httpErrors.NotFound(EFU.NOT_FOUND)
+
+      return user
+    } catch (e) {
+      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
+    }
+  }
+
+  private async _update(): Promise<IUser> {
+    try {
+      const updatedUser = await update(this._args as DtoUser)
+
+      if (!updatedUser) throw new httpErrors.NotFound(EFU.NOT_FOUND)
+
+      return updatedUser
+    } catch (e) {
+      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
+    }
+  }
+
+  private async _delete(): Promise<string> {
+    const { id } = this._args as DtoUser
+
+    try {
+      const deletedUser = await remove(id)
+
+      if (!deletedUser) throw new httpErrors.NotFound(EFU.NOT_FOUND)
+
+      return MFU.USER_DELETED
+    } catch (e) {
+      return errorHandling(e, GE.INTERNAL_SERVER_ERROR)
+    }
+  }
+}
+
+export { UserService }
+`,
+        file: `${projectName}/src/services/user.ts`
+      }
+    },
+    'services/utils': {
+      index: {
+        content: `import httpErrors from 'http-errors'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const errorHandling = (e: any, message?: string): never => {
+  console.error(e)
+
+  if (e instanceof httpErrors.HttpError) throw e
+
+  throw new httpErrors.InternalServerError(message ?? e.message)
+}
+
+export { errorHandling }
+export * from './messages'
+`,
+        file: `${projectName}/src/services/utils/index.ts`
+      }
+    },
+    'services/utils/messages': {
+      index: {
+        content: `enum GenericErrors {
+  INTERNAL_SERVER_ERROR = 'Something went wrong'
+}
+
+export { GenericErrors as GE }
+export * from './user'
+`,
+        file: `${projectName}/src/services/utils/messages/index.ts`
+      },
+      user: {
+        content: `enum ErrorForUser {
+  NOT_FOUND = 'The requested user does not exists',
+  NOTHING_TO_DELETE = 'There is no user to be deleted'
+}
+
+enum MessageForUser {
+  ALL_USERS_DELETED = 'All the users were deleted successfully',
+  USER_DELETED = 'The requested user was successfully deleted'
+}
+
+export { ErrorForUser as EFU, MessageForUser as MFU }
+`,
+        file: `${projectName}/src/services/utils/messages/user.ts`
       }
     },
     test: {
@@ -1164,10 +1203,7 @@ DELETE http://localhost:1996/api/user/60e7e3b93b01c1a7aa74cd6b
         file: `${projectName}/src/utils/docs.json`
       },
       index: {
-        content: `import docs from './docs.json'
-
-export { docs }
-`,
+        content: "export { default as docs } from './docs.json'\n",
         file: `${projectName}/src/utils/index.ts`
       }
     },
@@ -1184,70 +1220,123 @@ Server.start()
     }
   }
 
-  await exec(`mkdir ${projectName}/src \
+  const createFoldersCommands = `mkdir ${projectName}/src \
 ${projectName}/src/@types \
-${projectName}/src/controllers \
-${projectName}/src/controllers/utils \
-${projectName}/src/controllers/utils/messages \
-${projectName}/src/dto-interfaces \
-${projectName}/src/models \
+${projectName}/src/@types/dto \
+${projectName}/src/@types/custom \
+${projectName}/src/@types/models \
+${projectName}/src/services \
+${projectName}/src/services/utils \
+${projectName}/src/services/utils/messages \
+${projectName}/src/database \
+${projectName}/src/database/mongo \
+${projectName}/src/database/mongo/models \
+${projectName}/src/database/mongo/queries \
 ${projectName}/src/network \
-${projectName}/src/routes \
-${projectName}/src/schemas \
+${projectName}/src/network/routes \
+${projectName}/src/network/routes/schemas \
 ${projectName}/src/test \
 ${projectName}/src/utils
-`)
+`
+
+  if (os.platform() === 'win32')
+    await exec(createFoldersCommands.replaceAll('/', '\\'))
+  else await exec(createFoldersCommands)
 
   // /@types
   await writeFile(data['@types'].index.file, data['@types'].index.content)
 
-  // /controllers
-  await writeFile(data.controllers.user.file, data.controllers.user.content)
-  await writeFile(data.controllers.index.file, data.controllers.index.content)
+  // /@types/custom
+  await writeFile(
+    data['@types/custom'].request.file,
+    data['@types/custom'].request.content
+  )
+  await writeFile(
+    data['@types/custom'].response.file,
+    data['@types/custom'].response.content
+  )
+
+  // /@types/dto
+  await writeFile(data['@types/dto'].user.file, data['@types/dto'].user.content)
 
-  // /controllers/utils
+  // /@types/models
   await writeFile(
-    data['controllers/utils'].index.file,
-    data['controllers/utils'].index.content
+    data['@types/models'].user.file,
+    data['@types/models'].user.content
   )
 
-  // /controllers/utils/messages
+  // /services
+  await writeFile(data.services.user.file, data.services.user.content)
+  await writeFile(data.services.index.file, data.services.index.content)
+
+  // /database
+  await writeFile(data.database.index.file, data.database.index.content)
   await writeFile(
-    data['controllers/utils/messages'].user.file,
-    data['controllers/utils/messages'].user.content
+    data['database/mongo'].index.file,
+    data['database/mongo'].index.content
   )
   await writeFile(
-    data['controllers/utils/messages'].index.file,
-    data['controllers/utils/messages'].index.content
+    data['database/mongo/models'].index.file,
+    data['database/mongo/models'].index.content
   )
-
-  // /dto-interfaces
   await writeFile(
-    data['dto-interfaces'].user.file,
-    data['dto-interfaces'].user.content
+    data['database/mongo/models'].user.file,
+    data['database/mongo/models'].user.content
   )
   await writeFile(
-    data['dto-interfaces'].index.file,
-    data['dto-interfaces'].index.content
+    data['database/mongo/queries'].index.file,
+    data['database/mongo/queries'].index.content
+  )
+  await writeFile(
+    data['database/mongo/queries'].user.file,
+    data['database/mongo/queries'].user.content
   )
 
-  // /models
-  await writeFile(data.models.user.file, data.models.user.content)
-  await writeFile(data.models.index.file, data.models.index.content)
+  // /services/utils
+  await writeFile(
+    data['services/utils'].index.file,
+    data['services/utils'].index.content
+  )
+
+  // /services/utils/messages
+  await writeFile(
+    data['services/utils/messages'].user.file,
+    data['services/utils/messages'].user.content
+  )
+  await writeFile(
+    data['services/utils/messages'].index.file,
+    data['services/utils/messages'].index.content
+  )
 
   // /network
-  await writeFile(data.network.routes.file, data.network.routes.content)
-  await writeFile(data.network.server.file, data.network.server.content)
   await writeFile(data.network.index.file, data.network.index.content)
+  await writeFile(data.network.response.file, data.network.response.content)
+  await writeFile(data.network.router.file, data.network.router.content)
+  await writeFile(data.network.server.file, data.network.server.content)
 
-  // /routes
-  await writeFile(data.routes.home.file, data.routes.home.content)
-  await writeFile(data.routes.user.file, data.routes.user.content)
-  await writeFile(data.routes.index.file, data.routes.index.content)
+  // /network/routes
+  await writeFile(
+    data['network/routes'].home.file,
+    data['network/routes'].home.content
+  )
+  await writeFile(
+    data['network/routes'].user.file,
+    data['network/routes'].user.content
+  )
+  await writeFile(
+    data['network/routes'].index.file,
+    data['network/routes'].index.content
+  )
 
-  // /schemas
-  await writeFile(data.schemas.index.file, data.schemas.index.content)
-  await writeFile(data.schemas.user.file, data.schemas.user.content)
+  // /network/routes/schemas
+  await writeFile(
+    data['network/routes/schemas'].index.file,
+    data['network/routes/schemas'].index.content
+  )
+  await writeFile(
+    data['network/routes/schemas'].user.file,
+    data['network/routes/schemas'].user.content
+  )
 
   // /test
   await writeFile(data.test.index.file, data.test.index.content)

package/lib/src/functions/tsconfig.js

@@ -6,7 +6,8 @@ const writeFile = require('../utils/writeFile')
  */
 module.exports = async projectName => {
   const data = {
-    tsconfigContent: `{
+    base: {
+      content: `{
   "ts-node": {
     "files": true,
     "require": ["tsconfig-paths/register"]
@@ -25,8 +26,8 @@ module.exports = async projectName => {
     // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./dist/"                       /* Redirect output structure to the directory. */,
-    "rootDir": "./src/"                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+    "outDir": "dist"                          /* Redirect output structure to the directory. */,
+    "rootDir": "src"                          /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
     // "composite": true,                     /* Enable project compilation */
     // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
     // "removeComments": true,                /* Do not emit comments to output. */
@@ -53,7 +54,7 @@ module.exports = async projectName => {
 
     /* Module Resolution Options */
     "moduleResolution": "node"                /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
-    "baseUrl": "./src",                       /* Base directory to resolve non-absolute module names. */
+    "baseUrl": "src",                         /* Base directory to resolve non-absolute module names. */
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
@@ -79,12 +80,41 @@ module.exports = async projectName => {
     "skipLibCheck": true                      /* Skip type checking of declaration files. */,
     "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
   },
-  "include": ["./src/"],
-  "exclude": ["node_modules", "**/*.test.ts"]
+  "include": [
+    "src",
+    "test",
+    "tests",
+    "__test__"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
 }
 `,
-    tsconfigFile: 'tsconfig.json'
+      file: 'tsconfig.base.json'
+    },
+    prod: {
+      content: `{
+  "compilerOptions": {
+    "rootDir": "src"
+  },
+  "extends": "./tsconfig.base.json",
+  "exclude": [
+    "node_modules",
+    "test",
+    "tests",
+    "__test__",
+    "dist"
+  ],
+  "include": [
+    "src"
+  ]
+}
+`,
+      file: 'tsconfig.json'
+    }
   }
 
-  await writeFile(`${projectName}/${data.tsconfigFile}`, data.tsconfigContent)
+  await writeFile(`${projectName}/${data.base.file}`, data.base.content)
+  await writeFile(`${projectName}/${data.prod.file}`, data.prod.content)
 }

package/lib/src/installation.js

@@ -56,7 +56,7 @@ module.exports = async ({
     cliProgress.Presets.shades_classic
   )
 
-  const prodPackages = `${manager} express mongoose morgan http-errors joi swagger-ui-express`
+  const prodPackages = `${manager} express http-errors joi mongoose morgan swagger-ui-express`
   const devPackages = `${manager} -D \
 @types/express \
 @types/http-errors \
@@ -71,8 +71,6 @@ eslint-config-prettier \
 eslint-config-standard \
 eslint-plugin-import \
 eslint-plugin-prettier \
-eslint-plugin-sort-keys-fix \
-eslint-plugin-typescript-sort-keys \
 nodemon \
 prettier \
 standard-version \

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anthonylzq/simba.js",
-  "version": "1.10.0",
+  "version": "2.0.3",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "directories": {