@anthonylzq/simba.js 4.3.1 → 5.1.0

package/README.md

@@ -1,4 +1,7 @@
-# Simba.js
+<h1 align="center">
+  <!-- <p align="center">Simba.js</p> -->
+  <a href="https://simbajs.notion.site/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df"><img src="https://i.ibb.co/QHxn7kP/Gatonowww.png" alt="Simba.js"></a>
+</h1>
 
 [![NPM version](https://img.shields.io/npm/v/@anthonylzq/simba.js.svg?style=flat)](https://www.npmjs.com/package/@anthonylzq/simba.js)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnthonyLzq/simba.js/blob/master/LICENSE)
@@ -34,6 +37,7 @@ By doing this your prompt will ask you the following questions:
 - `Project version (0.1.0):` the initial version of the project, `0.1.0` as default.
 - `Select your license [1...7]:`, the license you have chosen for the project.
 - `License year (current year):`, the year where your license starts, current year as default.
+- `Will this project use GraphQL?  [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
 - `Will this project be deployed with Heroku? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
 
 The second option you have is by passing flags in one single command. If you need help, please run:
@@ -69,6 +73,8 @@ Options:
                                                       [boolean] [default: false]
   -F, --fastify             Whether or not you want to use Fastify for your
                             project                   [boolean] [default: false]
+  -g, --graphql             Whether or not you want to use GraphQL for your
+                            project                   [boolean] [default: false]
   -h, --help                Show help                                  [boolean]
 
 Examples:
@@ -94,18 +100,28 @@ As default, `yarn` is selected as package manager, but if you don't want to use
 simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -n
 ```
 
-And what if I want to use Fastify instead Express? Well, you only have to pass the `-F` flag:
+What if I want to use Fastify instead Express? Well, you only have to pass the `-F` flag:
 
 ```bash
 simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -F
 ```
 
+And how can I use GraphQL? Well, you only have to pass the `-g` flag:
+
+```bash
+simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -F -g
+```
+
 Finally, you may not want to use a license or one of the available licenses, don't worry, just don't pass the flag `-l` neither `--license` as follows:
 
 ```bash
 simba -N myProject -D 'This is a test' -a myName -e myEmail@email.com -H
 ```
 
+#### Why didn't you use [`TypeGraphQL`](https://typegraphql.com/)?
+
+[They don't support GraphQL v16.x.x](https://github.com/MichalLytek/type-graphql/issues/1100), until then.
+
 ## <a name="project-structure"></a>Project structure
 
 Regardless of the option chosen, a new folder will be generated with the name of the project, it will contain the following structure, depending if you have chosen Express or Fastify:
@@ -119,8 +135,6 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┣ 📂custom
  ┃ ┃ ┣ 📜request.d.ts
  ┃ ┃ ┗ 📜response.d.ts
- ┃ ┣ 📂dto
- ┃ ┃ ┗ 📜user.d.ts
  ┃ ┣ 📂models
  ┃ ┃ ┗ 📜user.d.ts
  ┃ ┗ 📜index.d.ts
@@ -137,7 +151,7 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┣ 📂network
  ┃ ┣ 📂routes
  ┃ ┃ ┣ 📂utils
- ┃ ┃ ┃ ┗ 📜docs.ts
+ ┃ ┃ ┃ ┗ 📜index.ts
  ┃ ┃ ┣ 📜home.ts
  ┃ ┃ ┣ 📜index.ts
  ┃ ┃ ┗ 📜user.ts
@@ -179,6 +193,81 @@ Regardless of the option chosen, a new folder will be generated with the name of
 📜yarn.lock (or package-lock.json)
 ```
 
+### Express-GraphQL case
+
+```
+📂node_modules
+📂src
+ ┣ 📂@types
+ ┃ ┣ 📂custom
+ ┃ ┃ ┣ 📜request.d.ts
+ ┃ ┃ ┗ 📜response.d.ts
+ ┃ ┣ 📂graphQL
+ ┃ ┃ ┗ 📜context.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
+ ┣ 📂graphQL
+ ┃ ┣ 📂models
+ ┃ ┃ ┣ 📂User
+ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┣ 📜mutations.ts
+ ┃ ┃ ┃ ┣ 📜mutationsResolver.ts
+ ┃ ┃ ┃ ┣ 📜queries.ts
+ ┃ ┃ ┃ ┣ 📜queriesResolver.ts
+ ┃ ┃ ┃ ┣ 📜schemas.ts
+ ┃ ┃ ┃ ┗ 📜typeDefs.ts
+ ┃ ┃ ┣ 📂utils
+ ┃ ┃ ┃ ┣ 📂messages
+ ┃ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┃ ┗ 📜index.ts
+ ┃ ┃ ┗ 📜index.ts
+ ┃ ┗ 📜index.ts
+ ┣ 📂network
+ ┃ ┣ 📂routes
+ ┃ ┃ ┣ 📂utils
+ ┃ ┃ ┃ ┗ 📜index.ts
+ ┃ ┃ ┣ 📜home.ts
+ ┃ ┃ ┣ 📜index.ts
+ ┃ ┣ 📜index.ts
+ ┃ ┣ 📜response.ts
+ ┃ ┣ 📜routes.ts
+ ┃ ┗ 📜server.ts
+ ┣ 📂schemas
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
+ ┣ 📂utils
+ ┃ ┣ 📜docs.json
+ ┃ ┗ 📜index.ts
+ ┗ 📜index.ts
+📜.env
+📜.eslintignore
+📜.eslintrc
+📜.gitignore
+📜CHANGELOG.md
+📜Dockerfile
+📜heroku.yml
+📜LICENSE
+📜nodemon.json
+📜package.json
+📜README.md
+📜tsconfig.base.json
+📜tsconfig.json
+📜webpack.config.js
+📜yarn.lock (or package-lock.json)
+```
+
 ### Fastify case
 
 ```
@@ -241,12 +330,82 @@ Regardless of the option chosen, a new folder will be generated with the name of
 📜yarn.lock (or package-lock.json)
 ```
 
+### Fastify-GraphQL case
+
+```
+📂node_modules
+📂src
+ ┣ 📂@types
+ ┃ ┣ 📂graphQL
+ ┃ ┃ ┗ 📜context.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
+ ┣ 📂graphQL
+ ┃ ┣ 📂models
+ ┃ ┃ ┣ 📂User
+ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┣ 📜mutations.ts
+ ┃ ┃ ┃ ┣ 📜mutationsResolver.ts
+ ┃ ┃ ┃ ┣ 📜queries.ts
+ ┃ ┃ ┃ ┣ 📜queriesResolver.ts
+ ┃ ┃ ┃ ┣ 📜schemas.ts
+ ┃ ┃ ┃ ┗ 📜typeDefs.ts
+ ┃ ┃ ┣ 📂utils
+ ┃ ┃ ┃ ┣ 📂messages
+ ┃ ┃ ┃ ┃ ┣ 📜index.ts
+ ┃ ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┃ ┗ 📜index.ts
+ ┃ ┃ ┗ 📜index.ts
+ ┃ ┗ 📜index.ts
+ ┣ 📂network
+ ┃ ┣ 📂routes
+ ┃ ┃ ┣ 📜docs.ts
+ ┃ ┃ ┣ 📜home.ts
+ ┃ ┃ ┣ 📜index.ts
+ ┃ ┣ 📜index.ts
+ ┃ ┣ 📜response.ts
+ ┃ ┣ 📜routes.ts
+ ┃ ┗ 📜server.ts
+ ┣ 📂schemas
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
+ ┗ 📜index.ts
+📜.env
+📜.eslintignore
+📜.eslintrc
+📜.gitignore
+📜CHANGELOG.md
+📜Dockerfile
+📜heroku.yml
+📜LICENSE
+📜nodemon.json
+📜package.json
+📜README.md
+📜tsconfig.base.json
+📜tsconfig.json
+📜webpack.config.js
+📜yarn.lock (or package-lock.json)
+```
+
 If you want to check the content of the files, please check the [example](https://github.com/AnthonyLzq/simba.js/tree/master/example) folder, there you will an example for both, Express and Fastify.
 
 ### Some considerations
 
-- 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`).
+- You are able to run a server that has one main route, `home` (`/`), `user` (`api/user` or `api/user/:id`) and `docs` (`api/docs`), in case you are not using GraphQL.
+- In case you are using GraphQL, there are 4 mutations (`storeUser`, `updateUser`, `deleteAllUsers` and `deleteUser`) and 2 queries available (`getUsers` and `getUser`), you can find them in the playground under the route `/api`.
 - 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
@@ -288,16 +447,24 @@ If you want to check the content of the files, please check the [example](https:
 
 Please check the [`changelog.md`](https://github.com/AnthonyLzq/simba.js/blob/master/CHANGELOG.md) file. Also, if you want to check what is coming, check the [road map](https://simbajs.notion.site/simbajs/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df).
 
-### Version 4.x.x
+### Version 5.x.x
 
 In this major version I would be focusing on adding new possible configurations according to the road map. The major changes of this version will be described here:
 
-- Replaced [`joi`](https://www.npmjs.com/package/joi) in favor of [`ajv`](https://www.npmjs.com/package/ajv) + [`@sinclair/typebox`](https://www.npmjs.com/package/@sinclair/typebox) in the Express case. [Why did I do this?](https://simbajs.notion.site/TypeBox-support-for-Express-f4e3cf8dd06f4c7ba4d8e4051a52688c)
-- Using more descriptive nouns, now every database object is represented with a DBO at the end, like: _UserDBO_. Also the objects that are sent and received will have a DTO at the end, like: _UserDTO_.
+- API creation logic was split to improve scalability.
+- Added support for GraphQL in both, Express and Fastify.
 
 ## <a name="notes"></a>Notes
 
-Here is the list of the packages that are being installed, as `devDependencies`:
+Here is the list of the packages that are being installed, as `dependencies`:
+
+- [`@sinclair/typebox`](https://www.npmjs.com/package/@sinclair/typebox)
+- [`ajv`](https://www.npmjs.com/package/ajv)
+- [`http-errors`](https://www.npmjs.com/package/http-errors)
+- [`mongoose`](https://mongoosejs.com/)
+- [`pino-pretty`](https://www.npmjs.com/package/pino-pretty)
+
+As `devDependencies`:
 
 - [`@types/http-errors`](https://www.npmjs.com/package/@types/http-errors)
 - [`@types/node`](https://www.npmjs.com/package/@types/node)
@@ -321,28 +488,35 @@ Here is the list of the packages that are being installed, as `devDependencies`:
 - [`webpack-cli`](https://www.npmjs.com/package/webpack-cli)
 - [`webpack-node-externals`](https://www.npmjs.com/package/webpack-node-externals)
 
-As `dependencies`:
+### In case you are using GraphQL
 
-- [`@sinclair/typebox`](https://www.npmjs.com/package/@sinclair/typebox)
+As `dependencies`:
+- [`@graphql-tools/schema`](https://www.npmjs.com/package/@graphql-tools/schema)
 - [`ajv`](https://www.npmjs.com/package/ajv)
-- [`http-errors`](https://www.npmjs.com/package/http-errors)
-- [`mongoose`](https://mongoosejs.com/)
+- [`ajv-formats`](https://www.npmjs.com/package/ajv-formats)
+- [`apollo-server-core`](https://www.npmjs.com/package/apollo-server-core)
+- [`graphql`](https://www.npmjs.com/package/graphql)
 
 ### Express case
 
+As `dependencies`:
+
+- [`cors`](https://www.npmjs.com/package/cors)
+- [`express`](https://www.npmjs.com/package/express)
+- [`express-pino-logger`](https://www.npmjs.com/package/express-pino-logger)
+- [`swagger-ui-express`](https://www.npmjs.com/package/swagger-ui-express)
+
 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/express-pino-logger`](https://www.npmjs.com/package/@types/express-pino-logger)
 - [`@types/swagger-ui-express`](https://www.npmjs.com/package/@types/swagger-ui-express)
 
-As `dependencies`:
+#### In case you are using GraphQL
 
-- [`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)
+As `dependencies`:
+- [`apollo-server-express`](https://www.npmjs.com/package/apollo-server-express)
 
 ### Fastify case
 
@@ -352,6 +526,12 @@ As `dependencies`:
 - [`fastify-cors`](https://www.npmjs.com/package/fastify-cors)
 - [`fastify-swagger`](https://www.npmjs.com/package/fastify-swagger)
 
+#### In case you are using GraphQL
+
+As `dependencies`:
+- [`apollo-server-fastify`](https://www.npmjs.com/package/apollo-server-fastify)
+- [`apollo-server-plugin-base`](https://www.npmjs.com/package/apollo-server-plugin-base)
+
 Feel free to contribute to this project. Every contribution will be appreciated.
 
 ## Author

package/lib/index.js

@@ -52,6 +52,8 @@ const argv = yargs(hideBin(process.argv))
   )
   .alias('F', 'fastify')
   .describe('F', 'Whether or not you want to use Fastify for your project')
+  .alias('g', 'graphql')
+  .describe('g', 'Whether or not you want to use GraphQL for your project')
   .default({
     H: false,
     n: false,
@@ -60,9 +62,10 @@ const argv = yargs(hideBin(process.argv))
     v: '0.1.0',
     f: 'src/index.ts',
     q: false,
-    F: false
+    F: false,
+    g: false
   })
-  .boolean(['H', 'n', 'q', 'F'])
+  .boolean(['H', 'n', 'q', 'F', 'g'])
   .help('h')
   .alias('h', 'help')
   .epilog('Developed by AnthonyLzq').argv
@@ -80,7 +83,8 @@ const config = {
   npm: false,
   manager: 'yarn add',
   mainFile: 'src/index.ts',
-  fastify: false
+  fastify: false,
+  graphql: false
 }
 const UNLICENSED = 'unlicensed'
 const LICENSES = [
@@ -132,7 +136,6 @@ const main = async () => {
         prompt: '> Express or Fastify? '
       }
     )
-
     readLineSync.promptLoop(
       input => {
         config.projectName = input.toLowerCase()
@@ -145,7 +148,6 @@ const main = async () => {
         prompt: '> Project name: '
       }
     )
-
     readLineSync.promptLoop(
       input => {
         config.projectDescription = input
@@ -158,7 +160,6 @@ const main = async () => {
         prompt: '> Project description: '
       }
     )
-
     readLineSync.promptLoop(
       input => {
         config.author = input
@@ -171,12 +172,10 @@ const main = async () => {
         prompt: '> Author: '
       }
     )
-
     config.email = readLineSync.questionEMail('> Email: ', {
       limit: EMAIL_REGEXP,
       limitMessage: 'That is not a valid email!'
     })
-
     config.version = readLineSync.question('> Project version (0.1.0): ')
     config.version = config.version === '' ? '0.1.0' : config.version
 
@@ -192,7 +191,6 @@ const main = async () => {
       .toLowerCase()
       .replace(/ /g, '-')
       .replace('d', '')
-
     readLineSync.promptLoop(
       input => {
         if (input !== '') config.licenseYear = input
@@ -205,14 +203,18 @@ const main = async () => {
         prompt: `> License year (${config.licenseYear}): `
       }
     )
-
+    config.graphql = readLineSync.keyInYNStrict(
+      '> Will this project use GraphQL? ',
+      {
+        caseSensitive: false
+      }
+    )
     config.heroku = readLineSync.keyInYNStrict(
       '> Will this project be deployed with Heroku? ',
       {
         caseSensitive: false
       }
     )
-
     config.mainFile = readLineSync.question('> Main file (src/index.ts): ')
   } else {
     if (!argv.author) return console.log('Error! An author is required!')
@@ -283,6 +285,8 @@ const main = async () => {
       config.manager = 'npm i'
     }
 
+    if (argv.graphql) config.graphql = true
+
     if (!argv.mainFile) console.log('Using src/index.ts as default main file')
     else config.mainFile = argv.mainFile
   }
@@ -305,4 +309,6 @@ module.exports = main
  * @property {Boolean} npm true means that the package manager will be npm, otherwise yarn
  * @property {'yarn add'|'npm i'} manager command that will be used to install packages
  * @property {String} mainFile main file of the project
+ * @property {Boolean} fastify true means that the project will be using Fastify
+ * @property {Boolean} graphql true means that the project will be using GraphQL
  */

package/lib/src/functions/api/database.js

@@ -0,0 +1,177 @@
+const { platform } = require('os')
+const { promisify } = require('util')
+const exec = promisify(require('child_process').exec)
+const writeFile = require('../../utils/writeFile')
+
+/**
+ * @param {Object} args
+ * @param {String} projectName
+ */
+const mongoF = async ({ projectName }) => {
+  const createFoldersCommand = `mkdir ${projectName}/src/database/mongo \
+${projectName}/src/database/mongo/models \
+${projectName}/src/database/mongo/queries`
+
+  if (platform() === 'win32')
+    await exec(createFoldersCommand.replaceAll('/', '\\'))
+  else await exec(createFoldersCommand)
+
+  const database = {
+    index: {
+      content: "export * from './mongo'\n",
+      file: `${projectName}/src/database/index.ts`
+    },
+    mongo: {
+      index: {
+        content: `export * from './models'
+export * from './queries'
+`,
+        file: `${projectName}/src/database/mongo/index.ts`
+      },
+      models: {
+        index: {
+          content: "export * from './user'\n",
+          file: `${projectName}/src/database/mongo/models/index.ts`
+        },
+        user: {
+          content: `import { model, Schema } from 'mongoose'
+
+const UserSchema = new Schema<UserDBO>(
+  {
+    lastName: {
+      required: true,
+      type: String
+    },
+    name: {
+      required: true,
+      type: String
+    }
+  },
+  {
+    timestamps: true,
+    versionKey: false,
+    toObject: {
+      transform: (_, ret) => {
+        ret.id = ret._id.toString()
+        delete ret._id
+      }
+    }
+  }
+)
+
+const UserModel = model<UserDBO>('users', UserSchema)
+
+export { UserModel }
+`,
+          file: `${projectName}/src/database/mongo/models/user.ts`
+        }
+      },
+      queries: {
+        index: {
+          content: "export * from './user'\n",
+          file: `${projectName}/src/database/mongo/queries/index.ts`
+        },
+        user: {
+          content: `import { Document, Types } from 'mongoose'
+
+import { UserModel } from '..'
+import { UserDTO } from 'schemas'
+
+const userDBOtoDTO = (
+  userDBO: Document<unknown, unknown, UserDBO> &
+    UserDBO & {
+      _id: Types.ObjectId
+    }
+): UserDTO => ({
+  ...userDBO.toObject(),
+  createdAt: userDBO.createdAt.toISOString(),
+  updatedAt: userDBO.updatedAt.toISOString()
+})
+
+const store = async (userData: UserDTO): Promise<UserDTO> => {
+  const user = new UserModel(userData)
+
+  await user.save()
+
+  return userDBOtoDTO(user)
+}
+
+const remove = async (
+  id: string | null = null
+): Promise<UserDTO | number | null> => {
+  if (id) {
+    const removedUser = await UserModel.findByIdAndRemove(id)
+
+    if (!removedUser) return null
+
+    return userDBOtoDTO(removedUser)
+  }
+
+  return (await UserModel.deleteMany({})).deletedCount
+}
+
+const get = async (
+  id: string | null = null
+): Promise<UserDTO[] | UserDTO | null> => {
+  if (id) {
+    const user = await UserModel.findById(id)
+
+    return user ? userDBOtoDTO(user) : null
+  }
+
+  const users = await UserModel.find({})
+
+  return users.map(u => userDBOtoDTO(u))
+}
+
+const update = async (userData: UserDTO): Promise<UserDTO | null> => {
+  const { id, ...rest } = userData
+  const user = await UserModel.findByIdAndUpdate(id, rest, { new: true })
+
+  return user ? userDBOtoDTO(user) : null
+}
+
+export { store, remove, get, update }
+`,
+          file: `${projectName}/src/database/mongo/queries/user.ts`
+        }
+      }
+    }
+  }
+
+  await Promise.all([
+    await writeFile(database.index.file, database.index.content),
+    await writeFile(database.mongo.index.file, database.mongo.index.content),
+    await writeFile(
+      database.mongo.models.index.file,
+      database.mongo.models.index.content
+    ),
+    await writeFile(
+      database.mongo.models.user.file,
+      database.mongo.models.user.content
+    ),
+    await writeFile(
+      database.mongo.queries.index.file,
+      database.mongo.queries.index.content
+    ),
+    await writeFile(
+      database.mongo.queries.user.file,
+      database.mongo.queries.user.content
+    )
+  ])
+}
+
+/**
+ * @param {Object} args
+ * @param {Boolean|undefined} args.mongo
+ * @param {String} args.projectName
+ */
+module.exports = async ({ mongo = true, projectName }) => {
+  const createFoldersCommand = `mkdir ${projectName}/src/database`
+
+  if (platform() === 'win32')
+    await exec(createFoldersCommand.replaceAll('/', '\\'))
+  else await exec(createFoldersCommand)
+
+  if (mongo) await mongoF({ projectName })
+}