First commit

Author: Lionel Dcosta

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+

.env.example

@@ -0,0 +1,3 @@
+BASEURL=http://localhost
+NODE_ENV=development
+LOG_LEVEL=debug

.gitignore

@@ -0,0 +1,50 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# node-waf configuration
+.lock-wscript
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+
+# vscode
+.vscode
+.vs
+
+# output dirs
+build/
+
+# config files
+config/local*
+ 

.npmrc

@@ -0,0 +1 @@
+loglevel="silent"

.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports =  {
+    semi:  true,
+    trailingComma:  'all',
+    singleQuote:  true,
+    printWidth:  120,
+    tabWidth:  2,
+    bracketSpacing: true
+  };
+  

README.md

@@ -0,0 +1,6 @@
+{
+  "exec": "node -r ts-node/register ./src/bootstrap/index",
+  "ext": "ts",
+  "ignore": ["/**/*.spec.ts"],
+  "legacyWatch": true
+}

nodemon.json

@@ -0,0 +1,78 @@
+{
+  "name": "blue-app",
+  "version": "0.0.1",
+  "description": "Blue App",
+  "main": "src/bootstrap/index",
+  "license": "ISC",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "start-dev": "nodemon",
+    "start-prod": "yarn build && npx pm2 start pm2.yaml",
+    "inspect": "nodemon --inspect src/bootstrap/index",
+    "test": "mocha --require ts-node/register --require ts-jest --require source-map-support/register --watch-extensions ts --forbid-only --full-trace --bail --check-leaks --reporter list --timeout 10000 --recursive  tests",
+    "jest": "jest",
+    "format": "prettier --write './src/**/**/*.ts'",
+    "tslint": "tslint -c tslint.json -p tsconfig.json",
+    "precise-commits": "precise-commits --check-only"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.1.7",
+    "@types/chai-as-promised": "^7.1.0",
+    "@types/express": "^4.16.1",
+    "@types/http-server": "^0.10.0",
+    "@types/ip": "^1.1.0",
+    "@types/jest": "^24.0.15",
+    "@types/lodash": "^4.14.133",
+    "@types/node": "^12.0.4",
+    "@types/pg": "^7.4.14",
+    "@types/sinon-as-promised": "^4.0.12",
+    "@types/supertest": "^2.0.7",
+    "@typescript-eslint/eslint-plugin": "^1.9.0",
+    "@typescript-eslint/parser": "^1.9.0",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "eslint": "^5.16.0",
+    "eslint-config-prettier": "^4.3.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "jest": "^24.8.0",
+    "mocha": "^6.1.4",
+    "nodemon": "^1.19.1",
+    "npx": "^10.2.0",
+    "prettier": "^1.17.1",
+    "qs": "^6.7.0",
+    "sinon": "^7.3.2",
+    "sinon-as-promised": "^4.0.3",
+    "supertest": "^4.0.2",
+    "ts-jest": "^24.0.2",
+    "ts-node": "^8.2.0",
+    "tslint": "^5.17.0",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.5.1"
+  },
+  "dependencies": {
+    "compression": "^1.7.4",
+    "cors": "^2.8.5",
+    "dotenv-safe": "^6.1.0",
+    "express": "^4.17.1",
+    "helmet": "^3.18.0",
+    "http": "^0.0.0",
+    "module-alias": "^2.2.0",
+    "morgan": "^1.9.1",
+    "pg": "^7.11.0",
+    "pm2": "^3.5.1",
+    "reflect-metadata": "^0.1.13",
+    "swagger-jsdoc": "^3.2.9",
+    "swagger-ui-express": "^4.0.6",
+    "typedi": "^0.8.0",
+    "winston": "^3.2.1"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "yarn tslint && yarn precise-commits"
+    }
+  },
+  "_moduleAliases": {
+    "@interfaces/*": "./src/interfaces/*",
+    "@cfg/*": "./src/cfg/*"
+  }
+}

package.json

@@ -0,0 +1,4 @@
+apps:
+  - script: ./build/bootstrap/index.js
+    instances: max
+    exec_mode: cluster

pm2.yaml

@@ -0,0 +1,3 @@
+import StatusRoute from './v1/status/index';
+
+export default [...StatusRoute];

src/api/index.ts

@@ -0,0 +1,3 @@
+export const version = 'v1';
+export const prefix = 'api';
+export const path = `/${prefix}/${version}`;

src/api/v1/index.ts

@@ -0,0 +1,52 @@
+import { Request, Response, NextFunction } from 'express';
+import { Container } from 'typedi';
+import statusService from './../../../services/status';
+import { path } from './../index';
+
+/**
+ * @swagger
+ *
+ * definition:
+ *    status:
+ *      properties:
+ *        status:
+ *          type: object
+ *          properties:
+ *            apiStatus:
+ *              type: string
+ * /status:
+ *    get:
+ *      tags:
+ *       - "status"
+ *      summary: "return the status of server"
+ *      consumes:
+ *        - "application/json"
+ *      produces:
+ *        - "application/json"
+ *      responses:
+ *        200:
+ *          description: "Successful operation"
+ *          schema:
+ *            $ref: '#/definitions/status'
+ *        500:
+ *          description: "Error connecting the all the resources"
+ */
+
+export default [
+  {
+    path: `${path}/status`,
+    method: 'get',
+    handler: [
+      async (Req: Request, res: Response, next: NextFunction) => {
+        try {
+          let statusServiceInstance = Container.get(statusService);
+          let apiStatus = await statusServiceInstance.status();
+          res.json({ status: apiStatus }).status(200);
+        } catch (error) {
+          console.log('error detected', error);
+          next(error);
+        }
+      },
+    ],
+  },
+];

src/api/v1/status/index.ts

@@ -0,0 +1,25 @@
+import 'reflect-metadata';
+
+//import 'module-alias/register';
+import * as express from 'express';
+import { createServer } from 'http';
+import { middlewareLoader } from './middleware';
+import { handleServerExit, handleExceptions } from './middleware/errorMiddleware';
+import Config from './../cfg';
+
+async function startServer() {
+  let app = express();
+
+  await middlewareLoader(app);
+
+  let server = createServer(app);
+
+  server.listen(Config.api.port);
+
+  process.on('unhandledRejection', handleExceptions);
+  process.on('uncaughtException', handleExceptions);
+  process.on('SIGINT', handleServerExit('SIGINT', server));
+  process.on('SIGTERM', handleServerExit('SIGTERM', server));
+}
+
+startServer();

src/bootstrap/index.ts

@@ -0,0 +1,37 @@
+import { Router } from 'express';
+import * as swaggerUi from 'swagger-ui-express';
+//import * as swaggerDocument from '../../util/swagger.json';
+import * as swaggerJsdoc from 'swagger-jsdoc';
+
+const options = {
+  swaggerDefinition: {
+    // Like the one described here: http://swagger.io/specification/#infoObject
+    info: {
+      title: 'API Documentation',
+      version: '0.0.1',
+      description: "Documentation to check & verify the api's",
+    },
+    host: 'localhost:3000',
+    basePath: '/api/v1',
+    tags: [
+      {
+        name: 'status',
+        description: 'Get the server status',
+      },
+    ],
+    schemes: {
+      http: 'http',
+    },
+  },
+  // List of files to be processes. You can also set globs './routes/*.js'
+  apis: ['src/api/v1/*/*.ts'],
+};
+
+const specs = swaggerJsdoc(options);
+
+const handleAPIDocs = (router: Router) => {
+  router.use('/api-docs', swaggerUi.serve);
+  router.get('/api-docs', swaggerUi.setup(specs));
+};
+
+export default [handleAPIDocs];

src/bootstrap/middleware/apiDocs.ts

@@ -0,0 +1,21 @@
+import { Router, Request, Response, NextFunction } from 'express';
+
+const dataFormat = (router: Router) => {
+  router.use((req: Request, res: Response, next: NextFunction) => {
+    req._data = [];
+    next();
+  });
+};
+
+const resFormat = (router: Router) => {
+  router.use((req: Request, res: Response, next: NextFunction) => {
+    res.api = {
+      status: 200,
+      errors: [],
+      data: [] || {},
+    };
+    next();
+  });
+};
+
+export default [dataFormat, resFormat];

src/bootstrap/middleware/dataMiddleware.ts

@@ -0,0 +1,23 @@
+import { Container } from 'typedi';
+import { Logger } from 'winston';
+import { Pool } from 'pg';
+
+//set the db connection here
+//set the logger here
+
+type Models = {};
+
+export default ({ models, logger, db }: { models: Models[]; logger: Logger; db: Pool }) => {
+  try {
+    models &&
+      models.forEach(model => {
+        Container.set(model);
+      });
+
+    Container.set('logger', logger);
+    Container.set('db', db);
+  } catch (e) {
+    console.log('🔥 Error on dependency injector loader %o', e);
+    throw e;
+  }
+};

src/bootstrap/middleware/dependencyInjector.ts

@@ -0,0 +1,36 @@
+import * as pg from 'pg';
+import { Logger } from 'winston';
+import { Container } from 'typedi';
+import cfg from './../../../cfg';
+
+const config = {
+  user: cfg.db.user, //this is the db user credential
+  database: cfg.db.database,
+  password: cfg.db.password,
+  port: cfg.db.port,
+  max: cfg.db.max, // max number of clients in the pool
+  idleTimeoutMillis: cfg.db.idleTimeoutMillis,
+};
+
+const pool = new pg.Pool(config);
+
+pool.on('connect', () => {
+  console.log('connected to the Database');
+});
+
+pool.on('error', function(err, client) {
+  console.error('idle client error', err.message, err.stack);
+  if (err) {
+    const logger: Logger = Container.get('logger');
+    logger.error('500', {
+      method: '',
+      url: '',
+      query: '',
+      ip: '',
+      error: err.message,
+      stack: err.stack,
+    });
+  }
+});
+
+export default pool;

src/bootstrap/middleware/di/diDatabase.ts

@@ -0,0 +1,5 @@
+import StatusModel from './../../../core/status';
+
+export const statusDI = {
+  StatusModel,
+};