@anthonylzq/simba.js 6.2.2 → 7.0.0

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

@@ -2,108 +2,11 @@ const os = require('os')
 const util = require('util')
 const exec = util.promisify(require('child_process').exec)
 
-const database = require('./database')
-const schemas = require('./schemas')
-const services = require('./services')
-const types = require('./types')
-const network = require('./network')
+const express = require('./express')
+const fastifyF = require('./fastify')
 const utils = require('./utils')
 const writeFile = require('../../utils/writeFile')
-const { ENVIRONMENTS_WITH_MONGO_URI } = require('../../utils/constants')
-
-/*
- * Express api:
- * src
- * |- @types:
- * |- |- custom:
- * |- |- |- request: content, file
- * |- |- |- response: content, file
- * |- |- dto:
- * |- |- |- user: content, file
- * |- |- models:
- * |- |- |- user: content, file
- * |  |- index: content, file
- * |- 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
- * |  |  |- index: content, file
- * |  |  |- user: content, file
- * |  |- response: content, file
- * |  |- router: content, file
- * |  |- server: content, file
- * |  |- index: content, file
- * |- services:
- * |  |- utils:
- * |  |  |- messages:
- * |  |  |  |- user: content, file
- * |  |  |  |- index: content, file
- * |  |  |- index: content, file
- * |  |- user: content, file
- * |  |- index: content, file
- * |- utils:
- * |  |- docs.json: content, file
- * |  |- index: content, file
- * |- .env: content, file
- * |- index: content, file
- * index.http: content, file
- */
-
-/*
- * Fastify api:
- * src
- * |- @types:
- * |- |- dto:
- * |- |- |- user: content, file
- * |- |- models:
- * |- |- |- user: content, file
- * |  |- index: content, file
- * |- 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
- * |  |- response: content, file
- * |  |- router: content, file
- * |  |- server: content, file
- * |  |- index: content, file
- * |- services:
- * |  |- utils:
- * |  |  |- messages:
- * |  |  |  |- user: content, file
- * |  |  |  |- index: content, file
- * |  |  |- index: content, file
- * |  |- user: content, file
- * |  |- index: content, file
- * |- .env: content, file
- * |- index: content, file
- * index.http: content, file
- */
+const { ENVIRONMENTS_WITH_DB_URI } = require('../../utils/constants')
 
 /**
  * @param {Object} args
@@ -112,7 +15,7 @@ const { ENVIRONMENTS_WITH_MONGO_URI } = require('../../utils/constants')
  * @param {String} args.email
  * @param {Boolean} args.fastify
  * @param {Boolean} args.graphql
- * @param {Boolean|undefined} args.mongo
+ * @param {import('../../../').Config['database']} args.database
  */
 module.exports = async ({
   projectName,
@@ -120,8 +23,9 @@ module.exports = async ({
   email,
   fastify,
   graphql,
-  mongo = true
+  database
 }) => {
+  const dbIsSQL = database !== 'mongo'
   const data = {
     test: {
       index: {
@@ -163,11 +67,17 @@ DELETE http://localhost:1996/api/user/60e7e3b93b01c1a7aa74cd6b
       }
     },
     '.env': {
-      content: `MONGO_URI = ${
-        ENVIRONMENTS_WITH_MONGO_URI.includes(process.env.NODE_ENV)
-          ? process.env.MONGO_URI
-          : `mongodb://mongo:mongo@mongo:27017/${projectName}`
-      }`,
+      content: dbIsSQL
+        ? `DB_URI = ${
+            ENVIRONMENTS_WITH_DB_URI.includes(process.env.NODE_ENV)
+              ? process.env.DB_URI
+              : `${database}://${database}:${database}@${database}:27017/${projectName}`
+          }`
+        : `DB_URI = ${
+            ENVIRONMENTS_WITH_DB_URI.includes(process.env.NODE_ENV)
+              ? process.env.MONGO_URI
+              : `mongodb://mongo:mongo@mongo:27017/${projectName}`
+          }`,
       file: `${projectName}/.env`
     },
     index: {
@@ -186,47 +96,33 @@ Server.start()
   else await exec(createFoldersCommands)
 
   const processes = [
-    // /@types
-    types({
-      express: !fastify,
-      projectName,
-      graphql
-    }),
-    // /database
-    database({
-      mongo,
-      projectName,
-      fastify
-    }),
-    // /network
-    network({
-      fastify,
-      projectName,
-      graphql
-    }),
-    // /schemas
-    schemas({ projectName, graphql }),
-    // /utils
-    utils({
-      express: !fastify,
-      projectName,
-      email,
-      projectVersion,
-      graphql
-    }),
     // .env
     writeFile(data['.env'].file, data['.env'].content),
     // index
-    writeFile(data.index.file, data.index.content)
+    writeFile(data.index.file, data.index.content),
+    writeFile(data.test.index.file, data.test.index.content)
   ]
 
-  if (!graphql)
+  if (fastify)
+    processes.push(fastifyF({ projectName, graphQL: graphql, database }))
+  else
     processes.concat([
-      // /services
-      services({ projectName }),
+      express({ projectName, graphQL: graphql, database }),
+      // /utils
+      utils({
+        express: !fastify,
+        projectName,
+        email,
+        projectVersion,
+        graphql
+      })
+    ])
+
+  if (!graphql)
+    processes.push(
       // /test
       writeFile(data.test.index.file, data.test.index.content)
-    ])
+    )
 
   await Promise.all(processes)
 }

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

@@ -203,14 +203,14 @@ export { ErrorForUser as EFU, MessageForUser as MFU }
   }
 
   await Promise.all([
-    await writeFile(services.index.file, services.index.content),
-    await writeFile(services.user.file, services.user.content),
-    await writeFile(services.utils.index.file, services.utils.index.content),
-    await writeFile(
+    writeFile(services.index.file, services.index.content),
+    writeFile(services.user.file, services.user.content),
+    writeFile(services.utils.index.file, services.utils.index.content),
+    writeFile(
       services['utils/messages'].index.file,
       services['utils/messages'].index.content
     ),
-    await writeFile(
+    writeFile(
       services['utils/messages'].user.file,
       services['utils/messages'].user.content
     )

package/lib/src/functions/eslint.js

@@ -1,10 +1,13 @@
 const writeFile = require('../utils/writeFile')
 
 /**
- * @param {String} projectName
+ * @param {Object} args
+ * @param {String} args.projectName
+ * @param {Boolean} args.tests
+ * @param {Boolean} args.dbIsSQL
  * @returns {Promise<void>}
  */
-module.exports = async (projectName, tests) => {
+module.exports = async ({ projectName, tests, dbIsSQL }) => {
   const data = {
     eslintContent: `{
   "env": {
@@ -44,7 +47,9 @@ module.exports = async (projectName, tests) => {
       {
         "devDependencies": [
           "**/*.test.ts",
-          "webpack.config.js"${tests ? ',\n          "jest.config.ts"' : ''}
+          "webpack.config.js"${tests ? ',\n          "jest.config.ts"' : ''}${
+      dbIsSQL ? ',\n          "src/database/postgres/config.js"' : ''
+    }
         ],
         "optionalDependencies": [
           "**/*.test.ts"

package/lib/src/functions/ghat.js

@@ -67,6 +67,7 @@ on: [push]
 
 jobs:
   test:
+    environment: Test
     name: Testing Simba.js API
     runs-on: ubuntu-latest
 
@@ -96,7 +97,7 @@ jobs:
       - name: Run test
         run: ${managerName === 'yarn' ? 'yarn' : 'npm run'} test:ci
         env:
-          MONGO_URI: \${{ secrets.MONGO_URI }}
+          DB_URI: \${{ secrets.DB_URI }}
           NODE_ENV: ci
 `,
       file: `${projectName}/.github/workflows/test.yml`

package/lib/src/functions/tests.js

@@ -2,15 +2,18 @@ const { platform } = require('os')
 const { promisify } = require('util')
 const exec = promisify(require('child_process').exec)
 const writeFile = require('../utils/writeFile')
-const { ENVIRONMENTS_WITH_MONGO_URI } = require('../utils/constants')
+const { ENVIRONMENTS_WITH_DB_URI } = require('../utils/constants')
 
 /**
- * @param {String} projectName
- * @param {Boolean} graphql
+ * @param {Object} args
+ * @param {String} args.projectName
+ * @param {Boolean} args.graphql
+ * @param {Boolean} args.dbIsSQL
  * @returns {Promise<void>}
  */
-module.exports = async (projectName, graphql) => {
+module.exports = async ({ projectName, graphql, dbIsSQL }) => {
   const createFoldersCommand = `mkdir ${projectName}/test`
+  const dbURI = dbIsSQL ? process.env.DB_URI : process.env.MONGO_URI
 
   if (platform() === 'win32')
     await exec(createFoldersCommand.replaceAll('/', '\\'))
@@ -54,7 +57,7 @@ const ajv = addFormats(new Ajv(), ['email'])
   .addKeyword('kind')
   .addKeyword('modifier')
 
-const BASE_URL = 'http://localhost:1996'
+const BASE_URL = 'http://localhost:${process.env.PORT || 1996}'
 const validator = <T extends TProperties>(
   schema: TObject<T>,
   object: unknown
@@ -76,7 +79,7 @@ describe('Simba.js tests', () => {
   })
 
   describe('API endpoints tests', () => {
-    let userID = ''
+    let userID = ${dbIsSQL ? 0 : "''"}
 
     describe('API: GET /', () => {
       let data: BaseResponseDTO
@@ -130,7 +133,7 @@ describe('Simba.js tests', () => {
 
         data = result.data
         status = result.status
-        userID = result.data.data.user.id ?? ''
+        userID = result.data.data.user.id ?? userID
         expect(status).toBe(200)
       })
 
@@ -188,7 +191,7 @@ describe('Simba.js tests', () => {
 
       test('Should return 200 as status code', async () => {
         const result = await axios.post<GetOneUserDTO>(\`\${BASE_URL}/api\`, {
-          query: \`query getUser($id: ID!) {
+          query: \`query getUser($id: ${dbIsSQL ? 'Int' : 'ID'}!) {
             user: getUser(id: $id) {
               id
               name
@@ -268,7 +271,7 @@ describe('Simba.js tests', () => {
 
       test('Should return 200 as status code', async () => {
         const result = await axios.post<DeleteUserDTO>(\`\${BASE_URL}/api\`, {
-          query: \`mutation deleteUser($id: ID!) {
+          query: \`mutation deleteUser($id: ${dbIsSQL ? 'Int' : 'ID'}!) {
             result: deleteUser(id: $id)
           }\`,
           variables: {
@@ -353,7 +356,7 @@ const ajv = new Ajv({
   nullable: true
 })
 
-const BASE_URL = 'http://localhost:1996'
+const BASE_URL = 'http://localhost:${process.env.PORT || 1996}'
 const validator = <T extends TProperties>(
   schema: TObject<T>,
   object: unknown
@@ -375,7 +378,7 @@ describe('Simba.js tests', () => {
   })
 
   describe('API endpoints tests', () => {
-    let userID = ''
+    let userID = ${dbIsSQL ? 0 : "''"}
 
     describe('API: GET /', () => {
       let data: BaseResponseDTO
@@ -417,7 +420,7 @@ describe('Simba.js tests', () => {
 
         data = result.data
         status = result.status
-        userID = result.data.message.id ?? ''
+        userID = result.data.message.id ?? userID
         expect(status).toBe(201)
       })
 
@@ -593,9 +596,11 @@ describe('Simba.js tests', () => {
         file: `${projectName}/test/jestGlobalSetup.ts`
       },
       setEnvVars: {
-        content: `process.env.MONGO_URI =\n${
-          ENVIRONMENTS_WITH_MONGO_URI.includes(process.env.NODE_ENV)
-            ? `  '${process.env.MONGO_URI}'\n`
+        content: `process.env.DB_URI =\n${
+          ENVIRONMENTS_WITH_DB_URI.includes(process.env.NODE_ENV)
+            ? `  '${dbURI}'\n`
+            : dbIsSQL
+            ? `  'postgres://postgres:postgres@postgres:5432/${projectName}'\n`
             : `  'mongodb://mongo:mongo@mongo:27017/${projectName}'\n`
         }`,
         file: `${projectName}/test/setEnvVars.ts`

package/lib/src/functions/tsconfig.js

@@ -2,9 +2,10 @@ const writeFile = require('../utils/writeFile')
 
 /**
  * @param {String} projectName
+ * @param {Boolean} dbIsSQL
  * @returns {Promise<void>}
  */
-module.exports = async projectName => {
+module.exports = async (projectName, dbIsSQL) => {
   const data = {
     base: {
       content: `{
@@ -73,7 +74,11 @@ module.exports = async projectName => {
     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
     /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    ${
+      dbIsSQL
+        ? '    "experimentalDecorators": true,           /* Enables experimental support for ES7 decorators. */'
+        : '    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */'
+    }
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
 
     /* Advanced Options */

package/lib/src/index.js

@@ -35,7 +35,7 @@ const setOptions = process => {
 }
 
 /**
- * @param {Config} config configuration to build the project
+ * @param {import('../').Config} config configuration to build the project
  */
 module.exports = async ({
   author,
@@ -51,7 +51,8 @@ module.exports = async ({
   fastify,
   graphql,
   tests,
-  ghat
+  ghat,
+  database
 }) => {
   const process = 4
   let i = 0
@@ -66,11 +67,37 @@ module.exports = async ({
   const fastifyProdPackages = `fastify@^3 @fastify/swagger@^6 @fastify/cors@^7 ${
     graphql ? 'apollo-server-fastify apollo-server-plugin-base' : ''
   }`
-  const prodPackages = `${manager} @sinclair/typebox http-errors mongoose pino-pretty ${
+  let prodPackages = `${manager} @sinclair/typebox http-errors pino-pretty ${
     graphql
       ? '@graphql-tools/schema ajv ajv-formats apollo-server-core graphql'
       : 'ajv@^6'
   } ${fastify ? fastifyProdPackages : expressProdPackages}`
+
+  switch (database) {
+    case 'mongo':
+      prodPackages += ' mongoose'
+      break
+    case 'postgres':
+      prodPackages +=
+        ' sequelize sequelize-typescript sequelize-typescript-migration-lts pg pg-hstore'
+      break
+    case 'mysql':
+      prodPackages +=
+        ' sequelize sequelize-typescript sequelize-typescript-migration-lts mysql2'
+      break
+    case 'mariadb':
+      prodPackages +=
+        ' sequelize sequelize-typescript sequelize-typescript-migration-lts mariadb'
+      break
+    case 'sqlite':
+      prodPackages +=
+        ' sequelize sequelize-typescript sequelize-typescript-migration-lts sqlite3'
+      break
+    case 'sqlServer':
+      prodPackages +=
+        ' sequelize sequelize-typescript sequelize-typescript-migration-lts tedious'
+  }
+
   const expressDevPackages =
     '@types/express @types/swagger-ui-express @types/cors @types/express-pino-logger'
   const fastifyDevPackages = ''
@@ -114,6 +141,7 @@ webpack-node-externals`
     await exec(`mkdir ${projectName}`)
     bar.update(++i)
 
+    const dbIsSQL = database !== 'mongo'
     const functions = [
       packageJson({
         author: `${author} <${email}>`,
@@ -127,12 +155,12 @@ webpack-node-externals`
       readme(projectName, projectDescription),
       changelog(projectName),
       gitignore(projectName),
-      tsconfig(projectName),
+      tsconfig(projectName, dbIsSQL),
       nodemon(projectName),
-      eslint(projectName, tests),
+      eslint({ projectName, tests, dbIsSQL }),
       webpack(projectName),
       docker(projectName),
-      api({ projectName, version, email, fastify, graphql }),
+      api({ projectName, version, email, fastify, graphql, database }),
       exec('git init', { cwd: `./${projectName}` })
     ]
 
@@ -149,7 +177,7 @@ webpack-node-externals`
 
     if (heroku) functions.push(herokuF(projectName))
 
-    if (tests) functions.push(testsF(projectName, graphql))
+    if (tests) functions.push(testsF({ projectName, graphql, dbIsSQL }))
 
     if (ghat) functions.push(ghatF(projectName, manager))
 
@@ -164,29 +192,10 @@ webpack-node-externals`
 
     bar.stop()
   } catch (e) {
-    console.error(e)
+    console.error('error', e)
   }
 }
 
-/**
- * @typedef {Object} Config configuration to initialize a project
- * @property {String} author author of the project
- * @property {String} email email of the project author
- * @property {String} projectName project name
- * @property {String} projectDescription project description
- * @property {Boolean} heroku true if the project will be deployed in heroku
- * @property {'unlicensed'|'mit'|'apache-2.0'|'mpl-2.0'|'lgpl-3.0'|'gpl-3.0'|'agpl-3.0'} license project license
- * @property {String} version project initial version
- * @property {String} licenseYear year when the license starts in format YYYY
- * @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
- * @property {Boolean} tests true means that the project will have a basic suit of tests with Jest
- * @property {Boolean} ghat true means that the project will have a GitHub Action for the suit of tests
- */
-
 /**
  * @typedef {Object} CliOptions
  * @property {String} format cli format to show the progress to the user

package/lib/src/utils/constants.js

@@ -1,3 +1,3 @@
-const ENVIRONMENTS_WITH_MONGO_URI = ['ci', 'local']
+const ENVIRONMENTS_WITH_DB_URI = ['ci', 'local']
 
-module.exports = { ENVIRONMENTS_WITH_MONGO_URI }
+module.exports = { ENVIRONMENTS_WITH_DB_URI }