@anthonylzq/simba.js 4.0.0 → 4.3.1

package/README.md

@@ -136,9 +136,8 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┗ 📜index.ts
  ┣ 📂network
  ┃ ┣ 📂routes
- ┃ ┃ ┣ 📂schemas
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┣ 📂utils
+ ┃ ┃ ┃ ┗ 📜docs.ts
  ┃ ┃ ┣ 📜home.ts
  ┃ ┃ ┣ 📜index.ts
  ┃ ┃ ┗ 📜user.ts
@@ -146,6 +145,9 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┣ 📜response.ts
  ┃ ┣ 📜routes.ts
  ┃ ┗ 📜server.ts
+ ┣ 📂schemas
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
  ┣ 📂services
  ┃ ┣ 📂utils
  ┃ ┃ ┣ 📂messages
@@ -183,8 +185,6 @@ Regardless of the option chosen, a new folder will be generated with the name of
 📂node_modules
 📂src
  ┣ 📂@types
- ┃ ┣ 📂dto
- ┃ ┃ ┗ 📜user.d.ts
  ┃ ┣ 📂models
  ┃ ┃ ┗ 📜user.d.ts
  ┃ ┗ 📜index.d.ts
@@ -200,9 +200,8 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┗ 📜index.ts
  ┣ 📂network
  ┃ ┣ 📂routes
- ┃ ┃ ┣ 📂schemas
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┣ 📂utils
+ ┃ ┃ ┃ ┗ 📜docs.ts
  ┃ ┃ ┣ 📜docs.ts
  ┃ ┃ ┣ 📜home.ts
  ┃ ┃ ┣ 📜index.ts
@@ -211,6 +210,9 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┣ 📜response.ts
  ┃ ┣ 📜routes.ts
  ┃ ┗ 📜server.ts
+ ┣ 📂schemas
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
  ┣ 📂services
  ┃ ┣ 📂utils
  ┃ ┃ ┣ 📂messages
@@ -331,12 +333,14 @@ As `dependencies`:
 As `devDependencies`:
 
 - [`@types/express`](https://www.npmjs.com/package/@types/express)
+- [`@types/cors`](https://www.npmjs.com/package/@types/cors)
 - [`@types/morgan`](https://www.npmjs.com/package/@types/morgan)
 - [`@types/swagger-ui-express`](https://www.npmjs.com/package/@types/swagger-ui-express)
 
 As `dependencies`:
 
-- [`express`](https://expressjs.com/)
+- [`cors`](https://www.npmjs.com/package/cors)
+- [`express`](https://www.npmjs.com/package/express)
 - [`morgan`](https://www.npmjs.com/package/morgan)
 - [`swagger-ui-express`](https://www.npmjs.com/package/swagger-ui-express)
 
@@ -345,6 +349,7 @@ As `dependencies`:
 As `dependencies`:
 
 - [`fastify`](https://www.npmjs.com/package/fastify)
+- [`fastify-cors`](https://www.npmjs.com/package/fastify-cors)
 - [`fastify-swagger`](https://www.npmjs.com/package/fastify-swagger)
 
 Feel free to contribute to this project. Every contribution will be appreciated.

package/lib/src/functions/api.js

@@ -121,17 +121,6 @@ export {}
         file: `${projectName}/src/@types/index.d.ts`
       }
     },
-    '@types/dto': {
-      user: {
-        content: `interface UserDTO {
-  id: string
-  lastName: string
-  name: string
-}
-`,
-        file: `${projectName}/src/@types/dto/user.d.ts`
-      }
-    },
     '@types/models': {
       user: {
         content: `interface UserDBO {
@@ -661,26 +650,27 @@ export { applyRoutes }
         content: `import express from 'express'
 import mongoose from 'mongoose'
 import morgan from 'morgan'
+import cors from 'cors'
 
 import { applyRoutes } from './router'
 
 const PORT = (process.env.PORT as string) || '1996'
 
 class Server {
-  private _app: express.Application
-  private _connection: mongoose.Connection | undefined
+  #app: express.Application
+  #connection: mongoose.Connection | undefined
 
   constructor() {
-    this._app = express()
-    this._config()
+    this.#app = express()
+    this.#config()
   }
 
-  private _config() {
-    this._app.set('port', PORT)
-    this._app.use(morgan('dev'))
-    this._app.use(express.json())
-    this._app.use(express.urlencoded({ extended: false }))
-    this._app.use(
+  #config() {
+    this.#app.use(cors())
+    this.#app.use(morgan('dev'))
+    this.#app.use(express.json())
+    this.#app.use(express.urlencoded({ extended: false }))
+    this.#app.use(
       (
         req: express.Request,
         res: express.Response,
@@ -696,23 +686,23 @@ class Server {
       }
     )
 
-    applyRoutes(this._app)
+    applyRoutes(this.#app)
   }
 
-  private async _mongo(): Promise<void> {
-    this._connection = mongoose.connection
+  async #mongo(): Promise<void> {
+    this.#connection = mongoose.connection
     const connection = {
       keepAlive: true,
       useNewUrlParser: true,
       useUnifiedTopology: true
     }
-    this._connection.on('connected', () => {
+    this.#connection.on('connected', () => {
       console.log('Mongo connection established.')
     })
-    this._connection.on('reconnected', () => {
+    this.#connection.on('reconnected', () => {
       console.log('Mongo connection reestablished')
     })
-    this._connection.on('disconnected', () => {
+    this.#connection.on('disconnected', () => {
       console.log('Mongo connection disconnected')
       console.log('Trying to reconnected to Mongo...')
       setTimeout(() => {
@@ -723,10 +713,10 @@ class Server {
         })
       }, 3000)
     })
-    this._connection.on('close', () => {
+    this.#connection.on('close', () => {
       console.log('Mongo connection closed')
     })
-    this._connection.on('error', (e: Error) => {
+    this.#connection.on('error', (e: Error) => {
       console.log('Mongo connection error:')
       console.error(e)
     })
@@ -734,12 +724,12 @@ class Server {
   }
 
   public start(): void {
-    this._app.listen(PORT, () => {
+    this.#app.listen(PORT, () => {
       console.log(\`Server running at port \${PORT}\`)
     })
 
     try {
-      this._mongo()
+      this.#mongo()
     } catch (e) {
       console.error(e)
     }
@@ -781,7 +771,7 @@ export * from './user'
         file: `${projectName}/src/network/routes/index.ts`
       },
       user: {
-        content: `import { Router } from 'express'
+        content: `import { NextFunction, Router } from 'express'
 
 import { response } from 'network/response'
 import { UserService } from 'services'
@@ -793,70 +783,122 @@ const User = Router()
 User.route('/users')
   .post(
     validatorCompiler(storeUserSchema, 'body'),
-    async (req: CustomRequest, res: CustomResponse): Promise<void> => {
-      const {
-        body: { args }
-      } = req
-      const us = new UserService({ userDtoWithoutId: args })
-      const result = await us.process({ type: 'store' })
-
-      response({ error: false, message: result, res, status: 201 })
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
+      try {
+        const {
+          body: { args }
+        } = req
+        const us = new UserService({ userDtoWithoutId: args })
+        const result = await us.process({ type: 'store' })
+
+        response({ error: false, message: result, res, status: 201 })
+      } catch (error) {
+        next(error)
+      }
     }
   )
-  .get(async (req: CustomRequest, res: CustomResponse): Promise<void> => {
-    const us = new UserService()
-    const result = await us.process({ type: 'getAll' })
+  .get(
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
+      try {
+        const us = new UserService()
+        const result = await us.process({ type: 'getAll' })
 
-    response({ error: false, message: result, res, status: 200 })
-  })
-  .delete(async (req: CustomRequest, res: CustomResponse): Promise<void> => {
-    const us = new UserService()
-    const result = await us.process({ type: 'deleteAll' })
+        response({ error: false, message: result, res, status: 200 })
+      } catch (error) {
+        next(error)
+      }
+    }
+  )
+  .delete(
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
+      try {
+        const us = new UserService()
+        const result = await us.process({ type: 'deleteAll' })
 
-    response({ error: false, message: result, res, status: 200 })
-  })
+        response({ error: false, message: result, res, status: 200 })
+      } catch (error) {
+        next(error)
+      }
+    }
+  )
 
 User.route('/user/:id')
   .get(
     validatorCompiler(idSchema, 'params'),
-    async (req: CustomRequest, res: CustomResponse): Promise<void> => {
-      const {
-        params: { id }
-      } = req
-      const us = new UserService({ id })
-      const result = await us.process({ type: 'getOne' })
-
-      response({ error: false, message: result, res, status: 200 })
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
+      try {
+        const {
+          params: { id }
+        } = req
+        const us = new UserService({ id })
+        const result = await us.process({ type: 'getOne' })
+
+        response({ error: false, message: result, res, status: 200 })
+      } catch (error) {
+        next(error)
+      }
     }
   )
   .patch(
     validatorCompiler(idSchema, 'params'),
     validatorCompiler(storeUserSchema, 'body'),
-    async (req: CustomRequest, res: CustomResponse): Promise<void> => {
-      const {
-        body: { args },
-        params: { id }
-      } = req
-      const userDto = {
-        id,
-        ...args
-      } as UserDTO
-      const us = new UserService({ userDto })
-      const result = await us.process({ type: 'update' })
-
-      response({ error: false, message: result, res, status: 200 })
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
+      try {
+        const {
+          body: { args },
+          params: { id }
+        } = req
+        const userDto = {
+          id,
+          ...args
+        } as UserDTO
+        const us = new UserService({ userDto })
+        const result = await us.process({ type: 'update' })
+
+        response({ error: false, message: result, res, status: 200 })
+      } catch (error) {
+        next(error)
+      }
     }
   )
   .delete(
     validatorCompiler(idSchema, 'params'),
-    async (req: CustomRequest, res: CustomResponse): Promise<void> => {
-      const {
-        params: { id }
-      } = req
-      const us = new UserService({ id })
-      const result = await us.process({ type: 'delete' })
-
-      response({ error: false, message: result, res, status: 200 })
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
+      try {
+        const {
+          params: { id }
+        } = req
+        const us = new UserService({ id })
+        const result = await us.process({ type: 'delete' })
+
+        response({ error: false, message: result, res, status: 200 })
+      } catch (error) {
+        next(error)
+      }
     }
   )
 
@@ -1397,24 +1439,26 @@ export { applyRoutes }
         file: `${projectName}/src/network/router.ts`
       },
       server: {
-        content: `import Fastify, { FastifyInstance } from 'fastify'
+        content: `import fastify, { FastifyInstance } from 'fastify'
 import mongoose from 'mongoose'
 
 import { applyRoutes } from './router'
+import { validatorCompiler } from './utils'
 
 const PORT = process.env.PORT ?? '1996'
 
 class Server {
-  private _app: FastifyInstance
-  private _connection: mongoose.Connection | undefined
+  #app: FastifyInstance
+  #connection: mongoose.Connection | undefined
 
   constructor() {
-    this._app = Fastify({ logger: true })
-    this._config()
+    this.#app = fastify({ logger: { prettyPrint: true } })
+    this.#config()
   }
 
-  private _config() {
-    this._app.addHook('preHandler', (req, reply, done) => {
+  #config() {
+    this.#app.register(require('fastify-cors'), {})
+    this.#app.addHook('preHandler', (req, reply, done) => {
       reply.header('Access-Control-Allow-Methods', 'GET, POST, PATCH, DELETE')
       reply.header('Access-Control-Allow-Origin', '*')
       reply.header(
@@ -1423,25 +1467,26 @@ class Server {
       )
       done()
     })
-    applyRoutes(this._app)
+    this.#app.setValidatorCompiler(validatorCompiler)
+    applyRoutes(this.#app)
   }
 
-  private async _mongo(): Promise<void> {
-    this._connection = mongoose.connection
+  async #mongo(): Promise<void> {
+    this.#connection = mongoose.connection
     const connection = {
       keepAlive: true,
       useNewUrlParser: true,
       useUnifiedTopology: true
     }
-    this._connection.on('connected', () => {
-      this._app.log.info('Mongo connection established.')
+    this.#connection.on('connected', () => {
+      this.#app.log.info('Mongo connection established.')
     })
-    this._connection.on('reconnected', () => {
-      this._app.log.info('Mongo connection reestablished')
+    this.#connection.on('reconnected', () => {
+      this.#app.log.info('Mongo connection reestablished')
     })
-    this._connection.on('disconnected', () => {
-      this._app.log.info('Mongo connection disconnected')
-      this._app.log.info('Trying to reconnected to Mongo...')
+    this.#connection.on('disconnected', () => {
+      this.#app.log.info('Mongo connection disconnected')
+      this.#app.log.info('Trying to reconnected to Mongo...')
       setTimeout(() => {
         mongoose.connect(process.env.MONGO_URI as string, {
           ...connection,
@@ -1450,20 +1495,20 @@ class Server {
         })
       }, 3000)
     })
-    this._connection.on('close', () => {
-      this._app.log.info('Mongo connection closed')
+    this.#connection.on('close', () => {
+      this.#app.log.info('Mongo connection closed')
     })
-    this._connection.on('error', (e: Error) => {
-      this._app.log.info('Mongo connection error:')
-      this._app.log.error(e)
+    this.#connection.on('error', (e: Error) => {
+      this.#app.log.info('Mongo connection error:')
+      this.#app.log.error(e)
     })
     await mongoose.connect(process.env.MONGO_URI as string, connection)
   }
 
   public async start(): Promise<void> {
     try {
-      await this._app.listen(PORT)
-      this._mongo()
+      await this.#app.listen(PORT)
+      this.#mongo()
     } catch (e) {
       console.error(e)
     }
@@ -1558,7 +1603,6 @@ import {
   StoreUser
 } from 'schemas'
 import { UserService } from 'services'
-import { validatorCompiler } from './utils'
 
 const User = (app: FastifyInstance, prefix = '/api'): void => {
   app
@@ -1576,8 +1620,7 @@ const User = (app: FastifyInstance, prefix = '/api'): void => {
             }
           },
           tags: ['user']
-        },
-        validatorCompiler
+        }
       },
       async (request, reply) => {
         const {
@@ -1668,8 +1711,7 @@ const User = (app: FastifyInstance, prefix = '/api'): void => {
             }
           },
           tags: ['user']
-        },
-        validatorCompiler
+        }
       },
       async (request, reply) => {
         const {
@@ -1763,7 +1805,7 @@ export { User }
         file: `${projectName}/src/network/routes/user.ts`
       }
     },
-    'network/routes/utils': {
+    'network/utils': {
       index: {
         content: `/* eslint-disable @typescript-eslint/no-explicit-any */
 import {
@@ -1801,17 +1843,19 @@ const validatorCompiler = ({
 
 export { validatorCompiler }
 `,
-        file: `${projectName}/src/network/routes/utils/index.ts`
+        file: `${projectName}/src/network/utils/index.ts`
       }
     }
   }
 
   const expressFolders = `${projectName}/src/utils \
-${projectName}/src/@types/custom`
+${projectName}/src/@types/custom \
+${projectName}/src/network/routes/utils`
+
+  const fastifyFolders = `${projectName}/src/network/utils`
 
   const createFoldersCommands = `mkdir ${projectName}/src \
 ${projectName}/src/@types \
-${projectName}/src/@types/dto \
 ${projectName}/src/@types/models \
 ${projectName}/src/database \
 ${projectName}/src/database/mongo \
@@ -1819,12 +1863,11 @@ ${projectName}/src/database/mongo/models \
 ${projectName}/src/database/mongo/queries \
 ${projectName}/src/network \
 ${projectName}/src/network/routes \
-${projectName}/src/network/routes/utils \
 ${projectName}/src/schemas \
 ${projectName}/src/services \
 ${projectName}/src/services/utils \
 ${projectName}/src/services/utils/messages \
-${fastify ? '' : `${expressFolders}`}
+${fastify ? `${fastifyFolders}` : `${expressFolders}`}
 `
 
   if (os.platform() === 'win32')
@@ -1834,9 +1877,6 @@ ${fastify ? '' : `${expressFolders}`}
   // /@types
   await writeFile(data['@types'].index.file, data['@types'].index.content)
 
-  // /@types/dto
-  await writeFile(data['@types/dto'].user.file, data['@types/dto'].user.content)
-
   // /@types/models
   await writeFile(
     data['@types/models'].user.file,
@@ -1937,8 +1977,8 @@ ${fastify ? '' : `${expressFolders}`}
 
     // /network/routes/utils
     await writeFile(
-      fastifyData['network/routes/utils'].index.file,
-      fastifyData['network/routes/utils'].index.content
+      fastifyData['network/utils'].index.file,
+      fastifyData['network/utils'].index.content
     )
   } else {
     // /@types/custom

package/lib/src/index.js

@@ -57,13 +57,13 @@ module.exports = async ({
     cliProgress.Presets.shades_classic
   )
 
-  const expressProdPackages = 'express morgan swagger-ui-express'
-  const fastifyProdPackages = 'fastify fastify-swagger'
+  const expressProdPackages = 'express morgan swagger-ui-express cors'
+  const fastifyProdPackages = 'fastify fastify-swagger fastify-cors pino-pretty'
   const prodPackages = `${manager} http-errors mongoose @sinclair/typebox ajv@^6 ${
     fastify ? fastifyProdPackages : expressProdPackages
   }`
 
-  const expressDevPackages = `@types/express @types/morgan @types/swagger-ui-express`
+  const expressDevPackages = `@types/express @types/morgan @types/swagger-ui-express @types/cors`
   const fastifyDevPackages = ''
   const devPackages = `${manager} -D \
 @types/http-errors \

package/lib/src/utils/titleCase.js

@@ -12,5 +12,5 @@ module.exports = projectName => {
     if (index !== array.length - 1) title += ' '
   })
 
-  return title
+  return title.trim()
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anthonylzq/simba.js",
-  "version": "4.0.0",
+  "version": "4.3.1",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "directories": {
@@ -19,7 +19,8 @@
     "rm-fastify": "if [ -d \"example/fastify\" ]; then rm -rf example/fastify; fi",
     "rm-git-express": "if [ -d \"example/express/.git\" ]; then rm -rf example/express/.git; fi",
     "rm-git-fastify": "if [ -d \"example/fastify/.git\" ]; then rm -rf example/fastify/.git; fi",
-    "cd-mv-example": "if [ ! -d \"example\" ]; then mkdir example && cd example; fi"
+    "cd-mv-example": "if [ ! -d \"example\" ]; then mkdir example && cd example; fi",
+    "version": "npm run release && git add CHANGELOG.md"
   },
   "bin": {
     "simba": "./bin/index.js"
@@ -41,16 +42,18 @@
     "colors": "^1.4.0",
     "readline-sync": "^1.4.10",
     "underscore": "^1.13.2",
-    "yargs": "^17.3.1"
+    "yargs": "^17.4.1"
   },
   "devDependencies": {
     "dotenv": "^16.0.0",
-    "eslint": "^8.10.0",
+    "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "prettier": "^2.6.2",
     "standard-version": "^9.3.2"
   },
   "repository": {
@@ -64,5 +67,12 @@
   "files": [
     "lib",
     "bin"
-  ]
+  ],
+  "standard-version": {
+    "skip": {
+      "tag": true,
+      "commit": true,
+      "bump": true
+    }
+  }
 }