@anthonylzq/simba.js 4.3.0 → 5.0.0

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

@@ -0,0 +1,466 @@
+const { platform } = require('os')
+const { promisify } = require('util')
+const exec = promisify(require('child_process').exec)
+const writeFile = require('../../utils/writeFile')
+
+/**
+ * @param {Object} args
+ * @param {Boolean} args.express
+ * @param {String} args.projectName
+ * @param {String} args.email
+ * @param {String} args.projectVersion
+ * @param {String} args.graphql
+ */
+module.exports = async ({
+  express,
+  projectName,
+  email,
+  projectVersion,
+  graphql
+}) => {
+  if (express) {
+    const createFoldersCommand = `mkdir ${projectName}/src/utils`
+
+    if (platform() === 'win32')
+      await exec(createFoldersCommand.replaceAll('/', '\\'))
+    else await exec(createFoldersCommand)
+
+    const utils = {
+      docs: {
+        content: `{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "${projectName}",
+    "description": "Documentation of the test",
+    "contact": {
+      "email": "${email}"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://opensource.org/licenses/MIT"
+    },
+    "version": "${projectVersion}"
+  },
+  "servers": [
+    {
+      "url": "http://localhost:1996/api",
+      "description": "${projectName} local API"
+    }
+  ],
+  "tags": [
+    {
+      "name": "user",
+      "description": "Operations related to the user"
+    }
+  ]
+${
+  !graphql
+    ? `,
+  "paths": {
+    "/users": {
+      "post": {
+        "tags": [
+          "user"
+        ],
+        "summary": "Save a user in the database",
+        "operationId": "store",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/UserDTO"
+        },
+        "responses": {
+          "201": {
+            "description": "User successfully stored",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Invalid request format",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          }
+        }
+      },
+      "get": {
+        "tags": [
+          "user"
+        ],
+        "summary": "Get all the users in the database",
+        "operationId": "getAll",
+        "responses": {
+          "200": {
+            "description": "All the users in the database",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "boolean",
+                      "default": false
+                    },
+                    "message": {
+                      "type": "object",
+                      "properties": {
+                        "result": {
+                          "type": "array",
+                          "items": {
+                            "$ref": "#/components/schemas/User"
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "user"
+        ],
+        "summary": "Delete all the users in the database",
+        "operationId": "deleteAll",
+        "responses": {
+          "200": {
+            "description": "All the users in the database",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultSuccess"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/user/{id}": {
+      "get": {
+        "tags": [
+          "user"
+        ],
+        "summary": "Get an specific user",
+        "operationId": "getOne",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "MongoDB user id",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "User stored in the database",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "User not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Invalid request format",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "tags": [
+          "user"
+        ],
+        "summary": "Update the user data",
+        "operationId": "update",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "MongoDB user id",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/UserDTO"
+        },
+        "responses": {
+          "200": {
+            "description": "User successfully updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "User not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Invalid request format",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "user"
+        ],
+        "summary": "Delete one user from the database",
+        "operationId": "delete",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "MongoDB user id",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "User successfully deleted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultSuccess"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "User not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Invalid request format",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DefaultError"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "lastName": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "DefaultSuccess": {
+        "type": "object",
+        "properties": {
+          "error": {
+            "type": "boolean",
+            "default": false
+          },
+          "message": {
+            "type": "object",
+            "properties": {
+              "result": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      },
+      "DefaultError": {
+        "type": "object",
+        "properties": {
+          "error": {
+            "type": "boolean",
+            "default": true
+          },
+          "message": {
+            "type": "object",
+            "properties": {
+              "result": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    },
+    "requestBodies": {
+      "UserDTO": {
+        "description": "User name and last name",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "args": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "lastName": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "required": true
+      }
+    }
+  }
+}`
+    : '}'
+}`,
+        file: `${projectName}/src/utils/docs.json`
+      },
+      index: {
+        content: "export { default as docs } from './docs.json'\n",
+        file: `${projectName}/src/utils/index.ts`
+      }
+    }
+
+    if (express)
+      await Promise.all([
+        writeFile(utils.docs.file, utils.docs.content),
+        writeFile(utils.index.file, utils.index.content)
+      ])
+  }
+}

package/lib/src/index.js

@@ -46,7 +46,8 @@ module.exports = async ({
   licenseYear,
   manager,
   mainFile,
-  fastify
+  fastify,
+  graphql
 }) => {
   const process = 4
   let i = 0
@@ -57,14 +58,25 @@ module.exports = async ({
     cliProgress.Presets.shades_classic
   )
 
-  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 expressProdPackages = `express swagger-ui-express cors express-pino-logger ${
+    graphql ? 'apollo-server-express' : ''
   }`
 
-  const expressDevPackages = `@types/express @types/morgan @types/swagger-ui-express @types/cors`
+  const fastifyProdPackages = `fastify fastify-swagger fastify-cors ${
+    graphql ? 'apollo-server-fastify apollo-server-plugin-base' : ''
+  }`
+
+  const prodPackages = `${manager} @sinclair/typebox http-errors mongoose pino-pretty ${
+    graphql
+      ? '@graphql-tools/schema ajv ajv-formats apollo-server-core graphql'
+      : 'ajv@^6'
+  } ${fastify ? fastifyProdPackages : expressProdPackages}`
+
+  const expressDevPackages =
+    '@types/express @types/swagger-ui-express @types/cors @types/express-pino-logger'
+
   const fastifyDevPackages = ''
+
   const devPackages = `${manager} -D \
 @types/http-errors \
 @types/node \
@@ -114,7 +126,7 @@ ${fastify ? fastifyDevPackages : expressDevPackages}`
       eslint(projectName),
       webpack(projectName),
       docker(projectName),
-      api({ projectName, version, email, fastify }),
+      api({ projectName, version, email, fastify, graphql }),
       exec('git init', { cwd: `./${projectName}` })
     ]
 
@@ -159,6 +171,8 @@ ${fastify ? fastifyDevPackages : expressDevPackages}`
  * @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/utils/writeFile.js

@@ -1,4 +1,4 @@
-const fs = require('fs')
+const { writeFile } = require('fs')
 
 /**
  * @param {String} filename
@@ -7,7 +7,7 @@ const fs = require('fs')
  */
 module.exports = (filename, data) => {
   return new Promise((resolve, reject) => {
-    fs.writeFile(filename, data, error => {
+    writeFile(filename, data, error => {
       if (error) reject(error.message)
       else resolve('Saved successfully')
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anthonylzq/simba.js",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "directories": {
@@ -9,17 +9,25 @@
   },
   "scripts": {
     "service": "node ./bin",
+    "help": "node ./bin --help",
     "release": "standard-version",
-    "test": "npm run rm && npm run test-express && npm run test-fastify",
+    "test": "npm run rm && npm run test-express && npm run test-fastify && npm run test-express-graphql && npm run test-fastify-graphql",
     "test-express": "npm run rm-express && npm run cd-mv-example && node -r dotenv/config ./bin -N example/express -D 'This is a test using express' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H && npm run rm-git-express",
     "test-fastify": "npm run rm-fastify && npm run cd-mv-example && node -r dotenv/config ./bin -N example/fastify -D 'This is a test using fastify' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H -F && npm run rm-git-fastify",
+    "test-express-graphql": "npm run rm-express-graphql && npm run cd-mv-example && node -r dotenv/config ./bin -N example/express-graphql -D 'This is a test using express with GraphQL' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H -g && npm run rm-git-express-graphql",
+    "test-fastify-graphql": "npm run rm-fastify-graphql && npm run cd-mv-example && node -r dotenv/config ./bin -N example/fastify-graphql -D 'This is a test using fastify with GraphQL' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H -F -g && npm run rm-git-fastify-graphql",
     "lint": "eslint --ext js lib/ --fix",
     "rm": "if [ -d \"example\" ]; then rm -rf example; fi",
     "rm-express": "if [ -d \"example/express\" ]; then rm -rf example/express; fi",
     "rm-fastify": "if [ -d \"example/fastify\" ]; then rm -rf example/fastify; fi",
+    "rm-express-graphql": "if [ -d \"example/express-graphql\" ]; then rm -rf example/express-graphql; fi",
+    "rm-fastify-graphql": "if [ -d \"example/fastify-graphql\" ]; then rm -rf example/fastify-graphql; 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"
+    "rm-git-express-graphql": "if [ -d \"example/express-graphql/.git\" ]; then rm -rf example/express-graphql/.git; fi",
+    "rm-git-fastify-graphql": "if [ -d \"example/fastify-graphql/.git\" ]; then rm -rf example/fastify-graphql/.git; 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"
@@ -66,5 +74,12 @@
   "files": [
     "lib",
     "bin"
-  ]
+  ],
+  "standard-version": {
+    "skip": {
+      "tag": true,
+      "commit": true,
+      "bump": true
+    }
+  }
 }