Initial commit

.gitignore

@@ -0,0 +1,18 @@
+# IntelliJ Files
+.idea/
+**/*.iml
+
+# System files
+.DS_STORE
+
+# Node
+node_modules/
+
+# Build Files
+dist/
+logs/
+coverage/
+testResults/
+
+# Secure  files
+.env

app.ts

@@ -0,0 +1,92 @@
+import express from 'express';
+import * as http from 'http';
+import * as dotenv from 'dotenv';
+import swaggerUi from 'swagger-ui-express';
+import swaggerJSDoc from 'swagger-jsdoc';
+import logger from './src/middleware/logger';
+
+// Router imports
+import {calendarRouter} from './src/models/calendar/Calendar.router';
+
+
+let cors = require('cors');
+
+dotenv.config();
+
+if (!process.env.PORT) {
+	logger.error('No port');
+	process.exit(1);
+}
+
+const port: number = parseInt(process.env.PORT, 10);
+
+const app: express.Application = express();
+const server: http.Server = http.createServer(app);
+
+// here we are adding middleware to parse all incoming requests as JSON
+app.use(express.json());
+
+// Configure CORS
+let allowedHosts = [
+	'https://www.nachklang.art',
+	'https://calendar.nachklang.art',
+];
+app.use(cors({
+	origin: function (origin: any, callback: any) {
+		// Allow requests with no origin
+		if (!origin) return callback(null, true);
+
+		// Block requests with wrong origin
+		if (allowedHosts.indexOf(origin) === -1) {
+			return callback(new Error('The CORS policy doesn\'t allow access for your origin.'), false);
+		}
+
+		// Allow all other requests
+		return callback(null, true);
+	}
+}));
+
+// Swagger documentation
+const swaggerDefinition = {
+	openapi: '3.0.0',
+	info: {
+		title: 'Nachklang e.V. REST API',
+		version: '0.1.0',
+		license: {
+			name: 'Licensed Under MIT',
+			url: 'https://spdx.org/licenses/MIT.html'
+		},
+		contact: {
+			name: 'Nachklang e.V.',
+			url: 'https://www.nachklang.art'
+		}
+	}
+};
+
+const options = {
+	swaggerDefinition,
+	// Paths to files containing OpenAPI definitions
+	apis: [
+		'./src/models/**/*.router.ts'
+	]
+};
+
+const swaggerSpec = swaggerJSDoc(options);
+
+app.use(
+	'/docs',
+	swaggerUi.serve,
+	swaggerUi.setup(swaggerSpec)
+);
+
+// Add routers
+app.use('/calendar', calendarRouter);
+
+// this is a simple route to make sure everything is working properly
+app.get('/', (req: express.Request, res: express.Response) => {
+	res.status(200).send('Welcome to the Nachklang e.V. REST API!');
+});
+
+server.listen(port, () => {
+	logger.info('Server listening on Port ' + port);
+});

jest.config.js

@@ -0,0 +1,8 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    roots: [
+        'test'
+    ]
+};

package.json

@@ -0,0 +1,54 @@
+{
+	"name": "nachklang-api",
+	"version": "0.1.0",
+	"description": "",
+	"main": "index.js",
+	"scripts": {
+		"start": "tsc && node ./dist/app.js",
+		"build": "tsc",
+		"debug": "export DEBUG=* && npm run start",
+		"test": "jest --coverage --testResultsProcessor ./node_modules/jest-sonar-reporter/index.js"
+	},
+	"keywords": [],
+	"author": "",
+	"license": "ISC",
+	"dependencies": {
+		"app-root-path": "^3.0.0",
+		"axios": "^0.24.0",
+		"bcrypt": "^5.0.1",
+		"cors": "^2.8.5",
+		"debug": "^4.3.1",
+		"dotenv": "^8.2.0",
+		"express": "^4.17.1",
+		"guid-typescript": "^1.0.9",
+		"mariadb": "^2.5.3",
+		"random-words": "^1.1.1",
+		"swagger-jsdoc": "^6.1.0",
+		"swagger-ui-express": "^4.3.0",
+		"winston": "^3.3.3"
+	},
+	"devDependencies": {
+		"@types/app-root-path": "^1.2.4",
+		"@types/bcrypt": "^3.0.1",
+		"@types/debug": "^4.1.5",
+		"@types/express": "^4.17.11",
+		"@types/jest": "^28.1.3",
+		"@types/random-words": "^1.1.2",
+		"@types/swagger-jsdoc": "^6.0.1",
+		"@types/swagger-ui-express": "^4.1.3",
+		"@types/winston": "^2.4.4",
+		"is-number": "^7.0.0",
+		"jest": "^28.1.1",
+		"jest-sonar-reporter": "^2.0.0",
+		"source-map-support": "^0.5.19",
+		"ts-jest": "^28.0.5",
+		"tslint": "^6.1.3",
+		"typescript": "^4.1.5"
+	},
+	"jestSonar": {
+		"sonar56x": true,
+		"reportPath": "testResults",
+		"reportFile": "sonar-report.xml",
+		"indent": 4
+	}
+}

public/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Nachklang REST API</title>
+</head>
+<body>
+Welcome to the Nachklang e.V. REST API!
+</body>
+</html>

sonar-project.properties

@@ -0,0 +1,6 @@
+sonar.projectKey=nk-api
+sonar.sources=src
+sonar.tests=test
+sonar.language=ts
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.testExecutionReportPaths=testResults/sonar-report.xml

src/common/common.routes.config.ts

@@ -0,0 +1,18 @@
+import express from 'express';
+
+export abstract class CommonRoutesConfig {
+	app: express.Application;
+	name: string;
+
+	constructor(app: express.Application, name: string) {
+		this.app = app;
+		this.name = name;
+		this.configureRoutes();
+	}
+
+	getName() {
+		return this.name;
+	}
+
+	abstract configureRoutes(): express.Application;
+}

src/middleware/logger.ts

@@ -0,0 +1,52 @@
+import * as appRoot from 'app-root-path';
+import * as winston from 'winston';
+
+const options = {
+	file_info: {
+		level: 'info',
+		filename: `${appRoot}/logs/app.log`,
+		handleExceptions: true,
+		json: true,
+		maxsize: 5242880, // 5MB
+		maxFiles: 5,
+		colorize: false
+	},
+	file_error: {
+		level: 'error',
+		filename: `${appRoot}/logs/error.log`,
+		handleExceptions: true,
+		json: true,
+		maxsize: 5242880, // 5MB
+		maxFiles: 5,
+		colorize: false
+	},
+	file_debug: {
+		level: 'debug',
+		filename: `${appRoot}/logs/debug.log`,
+		handleExceptions: true,
+		json: true,
+		maxsize: 5242880, // 5MB
+		maxFiles: 5,
+		colorize: false
+	},
+	console: {
+		level: 'debug',
+		handleExceptions: true,
+		json: false,
+		colorize: true
+	}
+};
+const logger: winston.Logger = winston.createLogger({
+	format: winston.format.combine(
+		winston.format.timestamp(),
+		winston.format.json()
+	),
+	transports: [
+		new winston.transports.File(options.file_info),
+		new winston.transports.File(options.file_error),
+		new winston.transports.File(options.file_debug),
+		new winston.transports.Console(options.console)
+	],
+	exitOnError: false // do not exit on handled exceptions
+});
+export default logger;

src/models/calendar/Calendar.db.ts

@@ -0,0 +1,19 @@
+import * as dotenv from 'dotenv';
+
+const mariadb = require('mariadb');
+
+dotenv.config();
+
+export namespace NachklangCalendarDB {
+	const pool = mariadb.createPool({
+		host: process.env.DB_HOST,
+		user: process.env.DB_USER,
+		password: process.env.DB_PASSWORD,
+		database: process.env.CALENDAR_DB,
+		connectionLimit: 5
+	});
+
+	export const getConnection = async () => {
+		return pool.getConnection();
+	};
+}

src/models/calendar/Calendar.router.ts

@@ -0,0 +1,26 @@
+/**
+ * Required External Modules and Interfaces
+ */
+import express, {Request, Response} from 'express';
+import {Guid} from 'guid-typescript';
+import logger from '../../middleware/logger';
+
+/**
+ * Router Definition
+ */
+export const calendarRouter = express.Router();
+
+
+calendarRouter.get('/', async (req: Request, res: Response) => {
+	try {
+		res.status(200).send('Nachklang e.V. Calendar API Endpoint');
+	} catch (e: any) {
+		let errorGuid = Guid.create().toString();
+		logger.error('Error handling a request: ' + e.message, {reference: errorGuid});
+		res.status(500).send({
+			'status': 'PROCESSING_ERROR',
+			'message': 'Internal Server Error. Try again later.',
+			'reference': errorGuid
+		});
+	}
+});

test/template.test.ts

@@ -0,0 +1,3 @@
+test('Test template', async () => {
+	expect(true).toBe(true);
+});

tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                  /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    "inlineSourceMap": true,                             /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}