@anthonylzq/simba.js 5.1.0 → 6.0.0

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

@@ -46,6 +46,10 @@ const user = Type.Object({
 
 type User = Static<typeof user>
 
+const userWithId = Type.Intersect([user, Type.Object({ id })])
+
+type UserWithId = Static<typeof userWithId>
+
 const userDto = Type.Object({
   id: Type.Optional(id),
   lastName: Type.String(),
@@ -56,19 +60,28 @@ const userDto = Type.Object({
 
 type UserDTO = Static<typeof userDto>
 
-const storeUserSchema = Type.Object({
+const storeUserDto = Type.Object({
   args: user
 })
 
-type StoreUser = Static<typeof storeUserSchema>
-
-export { userDto, UserDTO, user, User, storeUserSchema, StoreUser }
+type StoreUserDTO = Static<typeof storeUserDto>
+
+export {
+  userDto,
+  UserDTO,
+  userWithId,
+  UserWithId,
+  user,
+  User,
+  storeUserDto,
+  StoreUserDTO
+}
 `,
       file: `${projectName}/src/schemas/user.ts`
     }
   }
 
-  if (graphql) {
+  if (graphql)
     schemas.index.content = `import { Static, Type } from '@sinclair/typebox'
 import Ajv from 'ajv/dist/2019.js'
 import addFormats from 'ajv-formats'
@@ -90,30 +103,6 @@ const ajv = addFormats(new Ajv(), ['email'])
 export { id, ID, idSchema, IDSchema, ajv }
 export * from './user'
 `
-    schemas.user.content = `import { Static, Type } from '@sinclair/typebox'
-
-import { id } from '.'
-
-const user = Type.Object({
-  lastName: Type.String(),
-  name: Type.String()
-})
-
-type User = Static<typeof user>
-
-const userDto = Type.Object({
-  id: Type.Optional(id),
-  lastName: Type.String(),
-  name: Type.String(),
-  createdAt: Type.Optional(Type.String()),
-  updatedAt: Type.Optional(Type.String())
-})
-
-type UserDTO = Static<typeof userDto>
-
-export { userDto, UserDTO, user, User }
-`
-  }
 
   await Promise.all([
     writeFile(schemas.index.file, schemas.index.content),

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

@@ -25,7 +25,7 @@ ${projectName}/src/services/utils/messages`
       content: `import httpErrors from 'http-errors'
 
 import { store, remove, get, update } from 'database'
-import { UserDTO } from 'schemas'
+import { User, UserDTO, UserWithId } from 'schemas'
 import { EFU, MFU, GE, errorHandling } from './utils'
 
 type Process = {
@@ -34,8 +34,8 @@ type Process = {
 
 type Arguments = {
   id?: string
-  userDto?: UserDTO
-  userDtoWithoutId?: Omit<UserDTO, 'id'>
+  user?: User
+  userWithId?: UserWithId
 }
 
 class UserService {
@@ -66,12 +66,10 @@ class UserService {
 
   async #store(): Promise<UserDTO> {
     try {
-      if (!this.#args.userDtoWithoutId)
+      if (!this.#args.user)
         throw new httpErrors.UnprocessableEntity(GE.INTERNAL_SERVER_ERROR)
 
-      const result = await store({
-        ...this.#args.userDtoWithoutId
-      })
+      const result = await store(this.#args.user)
 
       return result
     } catch (e) {
@@ -122,10 +120,10 @@ class UserService {
 
   async #update(): Promise<UserDTO> {
     try {
-      if (!this.#args.userDto || !this.#args.userDto.id)
+      if (!this.#args.userWithId || !this.#args.userWithId.id)
         throw new httpErrors.UnprocessableEntity(GE.INTERNAL_SERVER_ERROR)
 
-      const updatedUser = await update(this.#args.userDto)
+      const updatedUser = await update(this.#args.userWithId)
 
       if (!updatedUser) throw new httpErrors.NotFound(EFU.NOT_FOUND)
 

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

@@ -32,7 +32,6 @@ export {}
     models: {
       user: {
         content: `interface UserDBO {
-  id: string
   name: string
   lastName: string
   createdAt: Date

package/lib/src/functions/docker.js

@@ -10,7 +10,7 @@ module.exports = async projectName => {
 
 WORKDIR /app
 
-COPY package.json ./
+COPY . ./
 
 RUN yarn install --prod
 
@@ -20,12 +20,28 @@ RUN yarn build
 
 RUN yarn remove webpack webpack-node-externals tsconfig-paths-webpack-plugin
 
-COPY dist /app/dist
-
 CMD [ "yarn", "start" ]
 `,
-    dockerFile: 'Dockerfile'
+    dockerFile: 'Dockerfile',
+    dockerIgnoreContent: `.eslintignore
+.eslintrc
+.gitignore
+CHANGELOG.md
+Dockerfile
+heroku.yml
+*.http
+LICENSE
+nodemon.json
+README.md
+
+# optionally you may want to ignore the .env file, but that depends on your own implementation
+.env`,
+    dockerIgnoreFile: '.dockerignore'
   }
 
   await writeFile(`${projectName}/${data.dockerFile}`, data.dockerContent)
+  await writeFile(
+    `${projectName}/${data.dockerIgnoreFile}`,
+    data.dockerIgnoreContent
+  )
 }

package/lib/src/functions/eslint.js

@@ -8,11 +8,17 @@ module.exports = async projectName => {
   const data = {
     eslintContent: `{
   "env": {
-    "node": true
+    "node": true,
+    "jest/globals": true
   },
   "root": true,
   "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint", "import", "prettier"],
+  "plugins": [
+    "@typescript-eslint",
+    "import",
+    "prettier",
+    "jest"
+  ],
   "extends": [
     "standard",
     "eslint:recommended",
@@ -23,7 +29,10 @@ module.exports = async projectName => {
   "rules": {
     "@typescript-eslint/no-var-requires": "off",
     "@typescript-eslint/no-empty-interface": "off",
-    "arrow-parens": ["error", "as-needed"],
+    "arrow-parens": [
+      "error",
+      "as-needed"
+    ],
     "import/extensions": [
       2,
       {
@@ -35,9 +44,17 @@ module.exports = async projectName => {
     "import/no-extraneous-dependencies": [
       "error",
       {
-        "devDependencies": ["**/*.test.js", "webpack.config.js"],
-        "optionalDependencies": ["**/*.test.js"],
-        "peerDependencies": ["**/*.test.js"]
+        "devDependencies": [
+          "**/*.test.ts",
+          "webpack.config.js",
+          "jest.config.ts"
+        ],
+        "optionalDependencies": [
+          "**/*.test.ts"
+        ],
+        "peerDependencies": [
+          "**/*.test.ts"
+        ]
       }
     ],
     "max-len": [
@@ -53,8 +70,14 @@ module.exports = async projectName => {
       }
     ],
     "newline-before-return": "error",
-    "object-curly-spacing": ["error", "always"],
-    "object-shorthand": ["error", "always"],
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "object-shorthand": [
+      "error",
+      "always"
+    ],
     "prefer-const": "error",
     "prettier/prettier": [
       "error",
@@ -69,11 +92,16 @@ module.exports = async projectName => {
         "trailingComma": "none"
       }
     ],
-    "radix": ["error", "as-needed"],
-    "spaced-comment": ["error", "always"]
+    "radix": [
+      "error",
+      "as-needed"
+    ],
+    "spaced-comment": [
+      "error",
+      "always"
+    ]
   }
-}
-`,
+}`,
     eslintFile: '.eslintrc',
     eslintIgnoreContent: '/dist',
     eslintIgnoreFile: '.eslintignore'

package/lib/src/functions/ghat.js

@@ -0,0 +1,65 @@
+const { platform } = require('os')
+const { promisify } = require('util')
+const exec = promisify(require('child_process').exec)
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {String} projectName
+ * @param {'yarn add'|'npm i'} manager
+ * @returns {Promise<void>}
+ */
+module.exports = async (projectName, manager) => {
+  const createFoldersCommand = `mkdir ${projectName}/.github \
+${projectName}/.github/workflows`
+  const managerName = manager.split()[0]
+
+  if (platform() === 'win32')
+    await exec(createFoldersCommand.replaceAll('/', '\\'))
+  else await exec(createFoldersCommand)
+
+  const data = {
+    test: {
+      content: `name: Tests - ${projectName}
+
+on: [push]
+
+jobs:
+  test:
+    name: Testing Simba.js API
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Install Node.js dependencies
+        run: ${
+          managerName === 'yarn' ? 'yarn install --frozen-lockfile' : 'npm ci'
+        }
+
+      - name: Revert changes into the ${
+        managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
+      } file
+        run: git checkout -- ${
+          managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
+        }
+
+      - name: Run test
+        run: ${managerName === 'yarn' ? 'yarn' : 'npm run'} test:ci
+        env:
+          MONGO_URI: \${{ secrets.MONGO_URI }}
+          NODE_ENV: ci
+`,
+      file: `${projectName}/.github/workflows/test.yml`
+    }
+  }
+
+  await writeFile(data.test.file, data.test.content)
+}

package/lib/src/functions/gitignore.js

@@ -134,6 +134,7 @@ typings/
 # End of https://www.toptal.com/developers/gitignore/api/node,yarn
 
 dist
+test/setEnvVars.ts
 `,
     gitignoreFile: '.gitignore'
   }

package/lib/src/functions/packageJson.js

@@ -10,7 +10,8 @@ module.exports = async ({
   projectDescription,
   projectVersion,
   license,
-  mainFile
+  mainFile,
+  tests
 }) => {
   const data = {
     content: '',
@@ -31,7 +32,14 @@ module.exports = async ({
     "lint": "eslint src/* --ext .ts --fix",
     "service": "nodemon",
     "start": "node dist/index.js",
-    "release": "standard-version"
+    "release": "standard-version"\
+    ${
+      tests
+        ? `,
+    "test:ci": "jest --ci -i",
+    "test:local": "NODE_ENV=local jest --ci -i"`
+        : ''
+    }
   },
   "author": "${author}",${
     license !== 'unlicensed'
@@ -53,4 +61,5 @@ module.exports = async ({
  * @property {String} projectVersion
  * @property {'unlicensed'|'mit'|'apache-2.0'|'mpl-2.0'|'lgpl-3.0'|'gpl-3.0'|'agpl-3.0'} license
  * @property {String} mainFle
+ * @property {Boolean} tests
  */