typescript-express-starter 8.1.2 → 9.0.0

package/lib/mikro-orm/swagger.yaml

@@ -0,0 +1,122 @@
+tags:
+- name: users
+  description: users API
+
+paths:
+# [GET] users
+  /users:
+    get:
+      tags:
+      - users
+      summary: Find All Users
+      responses:
+        200:
+          description: 'OK'
+        500:
+          description: 'Server Error'
+
+# [POST] users
+    post:
+      tags:
+      - users
+      summary: Add User
+      parameters:
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        201:
+          description: 'Created'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [GET] users/id
+  /users/{id}:
+    get:
+      tags:
+      - users
+      summary: Find User By Id
+      parameters:
+      - name: id
+        in: path
+        description: User Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [PUT] users/id
+    put:
+      tags:
+      - users
+      summary: Update User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        200:
+          description: 'OK'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [DELETE] users/id
+    delete:
+      tags:
+      - users
+      summary: Delete User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# definitions
+definitions:
+  users:
+    type: object
+    required:
+        - email
+        - password
+    properties:
+      id:
+        description: user Id
+      email:
+        type: string
+        description: user Email
+      password:
+        type: string
+        description: user Password
+
+schemes:
+ - https
+ - http

package/lib/mikro-orm/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "target": "es2017",
+    "lib": ["es2017", "esnext.asynciterable"],
+    "typeRoots": ["node_modules/@types"],
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "pretty": true,
+    "sourceMap": true,
+    "declaration": true,
+    "outDir": "dist",
+    "allowJs": true,
+    "noEmit": false,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "importHelpers": true,
+    "baseUrl": "src",
+    "paths": {
+      "@/*": ["*"],
+      "@config": ["config"],
+      "@controllers/*": ["controllers/*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@entities/*": ["entities/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@models/*": ["models/*"],
+      "@routes/*": ["routes/*"],
+      "@services/*": ["services/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.json", ".env"],
+  "exclude": ["node_modules", "src/http", "src/logs", "src/tests"]
+}

package/lib/mongoose/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/mongoose/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",

package/lib/prisma/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/prisma/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",

package/lib/routing-controllers/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/routing-controllers/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",

package/lib/sequelize/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/sequelize/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",

package/lib/starter.js

@@ -29,7 +29,8 @@ const createProject = async (projectName) => {
 
   try {
     const template = await chooseTemplates();
-    const { isUpdated, isDeduped } = await setupModuleManagement();
+    const isUpdated = await dependenciesUpdates();
+    const isDeduped = await dependenciesDeduped();
 
     console.log("[ 1 / 3 ] 🔍  copying project...");
     console.log("[ 2 / 3 ] 🚚  fetching node_modules...");
@@ -91,29 +92,50 @@ const chooseTemplates = async () => {
 };
 
 /**
- * @method setupModuleManagement
- * @description Set up npm management features.
+ * @method dependenciesUpdates
+ * @description npm dependencies updated.
  */
-const setupModuleManagement = async () => {
+const dependenciesUpdates = async () => {
   const { isUpdated } = await inquirer.prompt([
     {
       type: "confirm",
       name: "isUpdated",
       message:
-        "This command will update all the packages listed to the latest version.",
+        "Do you want to update all packages in the node_modules directory and dependency ?"
     },
   ]);
 
+  if (isUpdated) {
+    const { isUpdatedReconfirm } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "isUpdatedReconfirm",
+        message:
+          "However, updating to the latest version may cause package dependency issues. Do you still want to update ?"
+      },
+    ]);
+
+    return isUpdatedReconfirm;
+  }
+
+  return false;
+};
+
+/**
+ * @method dependenciesDeduped
+ * @description npm duplicate dependencies removed.
+ */
+const dependenciesDeduped = async () => {
   const { isDeduped } = await inquirer.prompt([
     {
       type: "confirm",
       name: "isDeduped",
-      message: "It is used to clean up duplicate packages in npm.",
+      message: "Used to removed duplicate packages at npm. Do you want to ?",
     },
   ]);
 
-  return { isUpdated, isDeduped };
-};
+  return isDeduped;
+}
 
 /**
  * @method copyProjectFiles

package/lib/typegoose/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/typegoose/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",
@@ -29,7 +29,7 @@
     "helmet": "^4.6.0",
     "hpp": "^0.2.3",
     "jsonwebtoken": "^8.5.1",
-    "mongoose": "~6.1.3",
+    "mongoose": "~6.2.3",
     "morgan": "^1.10.0",
     "swagger-jsdoc": "^6.0.0",
     "swagger-ui-express": "^4.1.6",

package/lib/typeorm/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/typeorm/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",

package/package.json

@@ -1,40 +1,31 @@
 {
   "name": "typescript-express-starter",
-  "version": "8.1.2",
+  "version": "9.0.0",
   "description": "Quick and Easy TypeScript Express Starter",
   "author": "AGUMON <ljlm0402@gmail.com>",
   "license": "MIT",
   "keywords": [
     "typescript",
     "express",
-    "routing-controllers",
-    "routing-controllers-openapi",
     "sequelize",
     "mongoose",
-    "typegoose",
     "typeorm",
     "knex",
     "prisma",
     "graphql",
-    "apollo",
+    "typegoose",
+    "mikro-orm",
+    "routing-controllers",
+    "logger",
+    "swagger",
     "jest",
     "nodemon",
-    "jsonwebtoken",
-    "bcrypt",
-    "logs",
-    "winston",
-    "swagger",
     "pm2",
     "eslint",
     "prettier",
     "docker",
     "docker-compose",
     "nginx",
-    "huskyrc",
-    "mysql",
-    "mariadb",
-    "mongodb",
-    "postgresql",
     "swc"
   ],
   "main": "bin/cli.js",