Merge pull request 'Alpha Release 0.3.2' (#31) from dev into main

Reviewed-on: #31
Reviewed-by: Philipp Dormann <philipp@philippdormann.de>

CHANGELOG.md

@@ -2,16 +2,40 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
+#### [v0.3.2](https://git.odit.services/lfk/document-server/compare/v0.3.0...v0.3.2)
+
+- 🧾New changelog file version [CI SKIP] [skip ci] [`cc6a53b`](https://git.odit.services/lfk/document-server/commit/cc6a53b25895594874acca370a1439d37bb280de)
+- 🚀Bumped version to v0.3.2 [`a9019e4`](https://git.odit.services/lfk/document-server/commit/a9019e4c67e7620b65650d60b0ebd57bc11a854e)
+- Merge pull request 'Now using full group names feature/18-group_names' (#30) from feature/18-group_names into dev [`e0db6f6`](https://git.odit.services/lfk/document-server/commit/e0db6f6a78d0026a8485a57c88af1e9407bd68a4)
+- 🚀Bumped version to v0.3.1 [`dcde424`](https://git.odit.services/lfk/document-server/commit/dcde424b77dcc9753859f94f7bcbe24fe3523c27)
+- 📖New license file version [CI SKIP] [skip ci] [`92c5240`](https://git.odit.services/lfk/document-server/commit/92c52401b398f6a2f247c10879e17f6dc105aa8e)
+- Now manually parsing runnergroup full names [`c290908`](https://git.odit.services/lfk/document-server/commit/c2909082a2dbb38041ae0fc695bd0fa1451b39ff)
+- Implemented basic auth [`bdeadd2`](https://git.odit.services/lfk/document-server/commit/bdeadd274bc0f9c8cbab35a8a5605bef4c22ba6c)
+- 📖New license file version [CI SKIP] [skip ci] [`9d7d044`](https://git.odit.services/lfk/document-server/commit/9d7d0443848522e5bdfdb6a80c836bea4bc200a1)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`e306cdb`](https://git.odit.services/lfk/document-server/commit/e306cdb2c8e58fc1aef79b95cba5d4cc96ac7658)
+- Added auth to openapi spec [`729f2d7`](https://git.odit.services/lfk/document-server/commit/729f2d7240b54ffe2d4db36cce29de0afdfc9417)
+- Pinned routing controllers version as temp workaround for routing controllers openapi being broken again [`7ca7266`](https://git.odit.services/lfk/document-server/commit/7ca7266ea46965251c9df637a2556f2a1706e7e6)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`adf11ab`](https://git.odit.services/lfk/document-server/commit/adf11ab1c356b6964230541331836abd363170b0)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`b7c6c6e`](https://git.odit.services/lfk/document-server/commit/b7c6c6e15708e471f5c3d0ca4cf11b1c08c88c9c)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`95099c5`](https://git.odit.services/lfk/document-server/commit/95099c5fbd7e6cb07c68151a998eebb0f00556f3)
+- Updated templates with full group name [`0fcfb30`](https://git.odit.services/lfk/document-server/commit/0fcfb30d5c13266ca4faf7697308dfb7a0f91b4f)
+- Merge pull request 'Alpha Release 0.3.1 - API Keys' (#29) from dev into main [`db91661`](https://git.odit.services/lfk/document-server/commit/db916615564813e8d21e3672581e4f3a4d748b89)
+- Merge pull request 'API Key based auth feature/26-api_auth' (#27) from feature/26-api_auth into dev [`2d031da`](https://git.odit.services/lfk/document-server/commit/2d031dae035866a4aa247398ea68ff338ab58cbd)
+- Added api key to env doc [`4543092`](https://git.odit.services/lfk/document-server/commit/454309278ef20a2b97248277b07a7b58a063618d)
+- Fixed bug [`7be211f`](https://git.odit.services/lfk/document-server/commit/7be211f8b7b26f7f620df81af4ebde5eec2feec2)
+
 #### [v0.3.0](https://git.odit.services/lfk/document-server/compare/v0.2.0...v0.3.0)
 
-- 🚀Bumped version to v0.3.0 [`449a96b`](https://git.odit.services/lfk/document-server/commit/449a96b3027fe93d8042b30420245f66e92f14b8)
-- Merge pull request 'Card generation feature/14-card_generation' (#24) from feature/14-card_generation into dev [`703eaa0`](https://git.odit.services/lfk/document-server/commit/703eaa0e9d667b628eab4e8496689fe66238f896)
+> 12 February 2021
+
+- Merge pull request 'Alpha Release 0.3.0 - Runnercard generation' (#25) from dev into main [`406add3`](https://git.odit.services/lfk/document-server/commit/406add3d517473d01628b6405569de6cb85114e0)
 - 🚀Bumped version to v0.2.0 [`491cdb8`](https://git.odit.services/lfk/document-server/commit/491cdb8d71a80ea196d16334c0c80b8f7cc859c5)
 - Added card generation speed tests (part 1) [`68572b1`](https://git.odit.services/lfk/document-server/commit/68572b194eb740238be8101efed6fdb2a207f65b)
 - Implemented first experimental speedtest [`e3a45a6`](https://git.odit.services/lfk/document-server/commit/e3a45a61ac3b2d691c2f75d36155896b7ed301d8)
 - Added basic logic to generate two-sided runnercards [`d3a213c`](https://git.odit.services/lfk/document-server/commit/d3a213ce3326aeb96d924e16a31fc87bf82eb5b3)
 - 🧾New changelog file version [CI SKIP] [skip ci] [`149bf18`](https://git.odit.services/lfk/document-server/commit/149bf1849db20b863ec998a72c77559ec401bc32)
 - Fixed double-sided printing [`7f58dd6`](https://git.odit.services/lfk/document-server/commit/7f58dd694b53152069c2095b2e18dd3a46cd04dd)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`e74b9a4`](https://git.odit.services/lfk/document-server/commit/e74b9a4c9d041780e0cfd8c4d68a5b63f916e091)
 - Added basic card generation function [`8fc6c71`](https://git.odit.services/lfk/document-server/commit/8fc6c7176ee92f813db1e1d4b3e5ef1b2f4e1aef)
 - Beautified output a bit [`aefe549`](https://git.odit.services/lfk/document-server/commit/aefe5493b06c04cc2b20029e1f7fc5f15ec9c04e)
 - Added barcode generatin [`5c075bc`](https://git.odit.services/lfk/document-server/commit/5c075bce8b94ff4482448c3cd56bdc28cbe0a7d9)
@@ -25,6 +49,8 @@ All notable changes to this project will be documented in this file. Dates are d
 - Fixed runnercard backside padding [`08e8587`](https://git.odit.services/lfk/document-server/commit/08e858726c1462b599ba9cb3f7fb057f35178b83)
 - Added sizing for the real cards [`b92a6f7`](https://git.odit.services/lfk/document-server/commit/b92a6f7b2b98fb0074d5a563d9918295e9ec0274)
 - 🧾New changelog file version [CI SKIP] [skip ci] [`8a90f63`](https://git.odit.services/lfk/document-server/commit/8a90f63b0919376beefef6a52aae9a59337aea59)
+- 🚀Bumped version to v0.3.0 [`449a96b`](https://git.odit.services/lfk/document-server/commit/449a96b3027fe93d8042b30420245f66e92f14b8)
+- Merge pull request 'Card generation feature/14-card_generation' (#24) from feature/14-card_generation into dev [`703eaa0`](https://git.odit.services/lfk/document-server/commit/703eaa0e9d667b628eab4e8496689fe66238f896)
 - Added speedtest script to package [`75b8b28`](https://git.odit.services/lfk/document-server/commit/75b8b281b87d9b173093f16beae12d707ec05052)
 - Fixed bug in array swapping function [`9697d53`](https://git.odit.services/lfk/document-server/commit/9697d53a1527854536f8ddf5426f7ca902772f51)
 - Added **very** basic backside [`68f46a4`](https://git.odit.services/lfk/document-server/commit/68f46a45b5a51c8a8edafca852cb274af388fa76)

README.md

@@ -35,6 +35,7 @@ The basic generation mechanism makes the templates and routes interchangeable (i
 | CURRENCY_SYMBOL | String | "€" | The your currency's symbol - used to generate pdf text.
 | SPONSORING_RECEIPT_MINIMUM_AMOUNT | String | "10" | The mimimum total donation amount a sponsor has to donate to be able to receive a donation receipt - used to generate pdf text.
 | SPONOR_LOGOS | Array<String> | Empty png | The sponsor images you want to loop through. You can provide them via http url, local file or base64-encoded image.
+| API_KEY | String(min length: 64) | Random generated string | The api key you want to use for auth (query-param `key`), has to be at least 64 chars long.
 
 ## Templates
 > The document server uses html templates to generate various pdf documents.

licenses.md

@@ -58,7 +58,7 @@ THE SOFTWARE.
 
 # axios
 **Author**: Matt Zabriskie
-**Repo**: [object Object]
+**Repo**: https://github.com/axios/axios.git
 **License**: MIT
 **Description**: Promise based HTTP client for the browser and node.js
 ## License Text
@@ -85,7 +85,7 @@ THE SOFTWARE.
 
 # bwip-js
 **Author**: Mark Warren <mwarren@metafloor.com>
-**Repo**: [object Object]
+**Repo**: https://github.com/metafloor/bwip-js.git
 **License**: MIT
 **Description**: JavaScript barcode generator supporting over 100 types and standards.
 ## License Text
@@ -117,7 +117,7 @@ THE SOFTWARE.
 
 # cheerio
 **Author**: Matt Mueller <mattmuelle@gmail.com> (mat.io)
-**Repo**: [object Object]
+**Repo**: git://github.com/cheeriojs/cheerio.git
 **License**: MIT
 **Description**: Tiny, fast, and elegant implementation of core jQuery designed specifically for the server
 ## License Text
@@ -145,7 +145,7 @@ SOFTWARE.
 
 # class-transformer
 **Author**: [object Object]
-**Repo**: [object Object]
+**Repo**: https://github.com/typestack/class-transformer.git
 **License**: MIT
 **Description**: Proper decorator-based transformation / serialization / deserialization of plain javascript objects to class constructors
 ## License Text
@@ -173,7 +173,7 @@ THE SOFTWARE.
 
 # class-validator
 **Author**: TypeStack contributors
-**Repo**: [object Object]
+**Repo**: https://github.com/typestack/class-validator.git
 **License**: MIT
 **Description**: Decorator-based property validation for classes.
 ## License Text
@@ -240,7 +240,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # dotenv
 **Author**: undefined
-**Repo**: [object Object]
+**Repo**: git://github.com/motdotla/dotenv.git
 **License**: BSD-2-Clause
 **Description**: Loads environment variables from .env file
 ## License Text
@@ -303,7 +303,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # handlebars
 **Author**: Yehuda Katz
-**Repo**: [object Object]
+**Repo**: https://github.com/wycats/handlebars.js.git
 **License**: MIT
 **Description**: Handlebars provides the power necessary to let you build semantic templates effectively with no frustration
 ## License Text
@@ -330,7 +330,7 @@ THE SOFTWARE.
 
 # i18next
 **Author**: Jan Mühlemann <jan.muehlemann@gmail.com> (https://github.com/jamuhl)
-**Repo**: [object Object]
+**Repo**: https://github.com/i18next/i18next.git
 **License**: MIT
 **Description**: i18next internationalization framework
 ## License Text
@@ -359,7 +359,7 @@ SOFTWARE.
 
 # i18next-fs-backend
 **Author**: undefined
-**Repo**: [object Object]
+**Repo**: git@github.com:i18next/i18next-fs-backend.git
 **License**: undefined
 **Description**: i18next-fs-backend is a backend layer for i18next using in Node.js and for Deno to load translations from the filesystem.
 ## License Text
@@ -637,7 +637,7 @@ SOFTWARE.
 
 # reflect-metadata
 **Author**: [object Object]
-**Repo**: [object Object]
+**Repo**: https://github.com/rbuckton/reflect-metadata.git
 **License**: Apache-2.0
 **Description**: Polyfill for Metadata Reflection API
 ## License Text
@@ -699,7 +699,7 @@ END OF TERMS AND CONDITIONS
 
 # routing-controllers
 **Author**: [object Object]
-**Repo**: [object Object]
+**Repo**: https://github.com/typestack/routing-controllers.git
 **License**: MIT
 **Description**: Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage for Express / Koa using TypeScript.
 ## License Text
@@ -736,7 +736,7 @@ SOFTWARE.
 
 # @odit/license-exporter
 **Author**: ODIT.Services
-**Repo**: [object Object]
+**Repo**: https://git.odit.services/odit/license-exporter
 **License**: MIT
 **Description**: A simple license crawler for crediting open source work
 ## License Text
@@ -763,7 +763,7 @@ OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # @types/express
 **Author**: undefined
-**Repo**: [object Object]
+**Repo**: https://github.com/DefinitelyTyped/DefinitelyTyped.git
 **License**: MIT
 **Description**: TypeScript definitions for Express
 ## License Text
@@ -792,7 +792,7 @@ OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # @types/node
 **Author**: undefined
-**Repo**: [object Object]
+**Repo**: https://github.com/DefinitelyTyped/DefinitelyTyped.git
 **License**: MIT
 **Description**: TypeScript definitions for Node.js
 ## License Text
@@ -821,7 +821,7 @@ OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # @types/puppeteer
 **Author**: undefined
-**Repo**: [object Object]
+**Repo**: https://github.com/DefinitelyTyped/DefinitelyTyped.git
 **License**: MIT
 **Description**: TypeScript definitions for puppeteer
 ## License Text
@@ -850,7 +850,7 @@ OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 # cp-cli
 **Author**: undefined
-**Repo**: [object Object]
+**Repo**: git+https://github.com/screendriver/cp-cli.git
 **License**: MIT
 **Description**: A 'cp' CLI util for Node.js
 ## License Text
@@ -879,7 +879,7 @@ SOFTWARE.
 
 # faker
 **Author**: undefined
-**Repo**: [object Object]
+**Repo**: http://github.com/Marak/Faker.js.git
 **License**: MIT
 **Description**: Generate massive amounts of fake contextual data
 ## License Text
@@ -887,7 +887,7 @@ SOFTWARE.
 
 # nodemon
 **Author**: [object Object]
-**Repo**: [object Object]
+**Repo**: https://github.com/remy/nodemon.git
 **License**: MIT
 **Description**: Simple monitor script for use during development of a node.js app.
 ## License Text
@@ -916,7 +916,7 @@ SOFTWARE.
 
 # release-it
 **Author**: [object Object]
-**Repo**: [object Object]
+**Repo**: https://github.com/release-it/release-it.git
 **License**: MIT
 **Description**: Generic CLI tool to automate versioning and package publishing related tasks.
 ## License Text
@@ -968,7 +968,7 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 # start-server-and-test
 **Author**: Gleb Bahmutov <gleb.bahmutov@gmail.com>
-**Repo**: [object Object]
+**Repo**: https://github.com/bahmutov/start-server-and-test.git
 **License**: MIT
 **Description**: Starts server, waits for URL, then runs test command; when the tests end, shuts down server
 ## License Text
@@ -976,7 +976,7 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 # ts-node
 **Author**: [object Object]
-**Repo**: [object Object]
+**Repo**: git://github.com/TypeStrong/ts-node.git
 **License**: MIT
 **Description**: TypeScript execution environment and REPL for node.js, with source map support
 ## License Text
@@ -1005,7 +1005,7 @@ THE SOFTWARE.
 
 # typescript
 **Author**: Microsoft Corp.
-**Repo**: [object Object]
+**Repo**: https://github.com/Microsoft/TypeScript.git
 **License**: Apache-2.0
 **Description**: TypeScript is a language for application scale JavaScript development
 ## License Text

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odit/lfk-document-server",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "The document generation server for the LfK! runner system. This generates certificates, sponsoring aggreements and more",
   "main": "src/app.ts",
   "scripts": {
@@ -59,11 +59,11 @@
     "pdf-lib": "^1.16.0",
     "puppeteer": "^7.0.1",
     "reflect-metadata": "^0.1.13",
-    "routing-controllers": "^0.9.0-alpha.6",
-    "routing-controllers-openapi": "^2.2.0"
+    "routing-controllers": "0.9.0-alpha.6",
+    "routing-controllers-openapi": "2.2.0"
   },
   "devDependencies": {
-    "@odit/license-exporter": "^0.0.9",
+    "@odit/license-exporter": "^0.0.10",
     "@types/express": "^4.17.11",
     "@types/node": "^14.14.22",
     "@types/puppeteer": "^5.4.3",

src/apispec.ts

@@ -1,25 +1,33 @@
-import { MetadataArgsStorage } from 'routing-controllers';
-import { routingControllersToSpec } from 'routing-controllers-openapi';
-import { config } from './config';
-
-/**
- * This function generates a the openapi spec from route metadata and type schemas.
- * @param storage MetadataArgsStorage object generated by routing-controllers.
- * @param schemas MetadataArgsStorage object generated by class-validator-jsonschema.
- */
-export function generateSpec(storage: MetadataArgsStorage, schemas) {
-    return routingControllersToSpec(
-        storage,
-        {},
-        {
-            components: {
-                schemas,
-            },
-            info: {
-                description: "The the API for the LfK! document server.",
-                title: "LfK! document server API",
-                version: config.version
-            },
-        }
-    );
+import { MetadataArgsStorage } from 'routing-controllers';
+import { routingControllersToSpec } from 'routing-controllers-openapi';
+import { config } from './config';
+
+/**
+ * This function generates a the openapi spec from route metadata and type schemas.
+ * @param storage MetadataArgsStorage object generated by routing-controllers.
+ * @param schemas MetadataArgsStorage object generated by class-validator-jsonschema.
+ */
+export function generateSpec(storage: MetadataArgsStorage, schemas) {
+    return routingControllersToSpec(
+        storage,
+        {},
+        {
+            components: {
+                schemas,
+                "securitySchemes": {
+                    "AuthToken": {
+                        "type": "apiKey",
+                        "in": "query",
+                        "name": "key",
+                        description: "A simple api key. See the README's env section for more details."
+                    }
+                }
+            },
+            info: {
+                description: "The the API for the LfK! document server.",
+                title: "LfK! document server API",
+                version: config.version
+            },
+        }
+    );
 }

src/app.ts

@@ -1,29 +1,31 @@
-import consola from "consola";
-import "reflect-metadata";
-import { createExpressServer } from "routing-controllers";
-import { config, e as errors } from './config';
-import loaders from "./loaders/index";
-import { ErrorHandler } from './middlewares/ErrorHandler';
-
-const CONTROLLERS_FILE_EXTENSION = process.env.NODE_ENV === 'production' ? 'js' : 'ts';
-const app = createExpressServer({
-    middlewares: [ErrorHandler],
-    development: config.development,
-    cors: true,
-    controllers: [`${__dirname}/controllers/*.${CONTROLLERS_FILE_EXTENSION}`],
-});
-
-async function main() {
-    await loaders(app);
-    app.listen(config.internal_port, () => {
-        consola.success(
-            `⚡️[server]: Server is running at http://localhost:${config.internal_port}`
-        );
-    });
-}
-if (errors === 0) {
-    main();
-} else {
-    consola.error("error");
-    // something's wrong
-}
+import consola from "consola";
+import "reflect-metadata";
+import { createExpressServer } from "routing-controllers";
+import { config, e as errors } from './config';
+import loaders from "./loaders/index";
+import AuthChecker from './middlewares/AuthChecker';
+import { ErrorHandler } from './middlewares/ErrorHandler';
+
+const CONTROLLERS_FILE_EXTENSION = process.env.NODE_ENV === 'production' ? 'js' : 'ts';
+const app = createExpressServer({
+    middlewares: [ErrorHandler],
+    authorizationChecker: AuthChecker,
+    development: config.development,
+    cors: true,
+    controllers: [`${__dirname}/controllers/*.${CONTROLLERS_FILE_EXTENSION}`],
+});
+
+async function main() {
+    await loaders(app);
+    app.listen(config.internal_port, () => {
+        consola.success(
+            `⚡️[server]: Server is running at http://localhost:${config.internal_port}`
+        );
+    });
+}
+if (errors === 0) {
+    main();
+} else {
+    consola.error("error");
+    // something's wrong
+}

src/config.ts

@@ -1,30 +1,52 @@
-import { config as configDotenv } from 'dotenv';
-
-configDotenv();
-export const config = {
-    internal_port: parseInt(process.env.APP_PORT) || 4010,
-    development: process.env.NODE_ENV === "production",
-    version: process.env.VERSION || require('../package.json').version,
-    eventname: process.env.EVENT_NAME || "Please set the event name",
-    currency_symbol: process.env.CURRENCY_SYMBOL || "€",
-    sponsoring_receipt_minimum_amount: process.env.SPONSORING_RECEIPT_MINIMUM_AMOUNT || "10",
-    codeformat: process.env.CODEFORMAT || "qrcode",
-    sponor_logos: getSponsorLogos()
-}
-let errors = 0
-if (typeof config.internal_port !== "number") {
-    errors++
-}
-if (typeof config.development !== "boolean") {
-    errors++
-}
-function getSponsorLogos(): string[] {
-    try {
-        const logos = JSON.parse(process.env.SPONOR_LOGOS);
-        if (!Array.isArray(logos)) { throw new Error("Not an array.") }
-        return logos;
-    } catch (error) {
-        return ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg=="];
-    }
-}
+import consola from "consola";
+import { config as configDotenv } from 'dotenv';
+
+configDotenv();
+export const config = {
+    internal_port: parseInt(process.env.APP_PORT) || 4010,
+    development: process.env.NODE_ENV === "production",
+    version: process.env.VERSION || require('../package.json').version,
+    eventname: process.env.EVENT_NAME || "Please set the event name",
+    currency_symbol: process.env.CURRENCY_SYMBOL || "€",
+    sponsoring_receipt_minimum_amount: process.env.SPONSORING_RECEIPT_MINIMUM_AMOUNT || "10",
+    codeformat: process.env.CODEFORMAT || "qrcode",
+    sponor_logos: getSponsorLogos(),
+    api_key: getApiKey(),
+}
+let errors = 0
+if (typeof config.internal_port !== "number") {
+    errors++
+}
+if (typeof config.development !== "boolean") {
+    errors++
+}
+function getSponsorLogos(): string[] {
+    try {
+        const logos = JSON.parse(process.env.SPONOR_LOGOS);
+        if (!Array.isArray(logos)) { throw new Error("Not an array.") }
+        return logos;
+    } catch (error) {
+        return ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg=="];
+    }
+}
+
+function getApiKey(): string {
+    const key = process.env.API_KEY;
+    if (!key) {
+        consola.info("No API key set - generating a random one...");
+        let result = '';
+        const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+        const charactersLength = characters.length;
+        for (var i = 0; i < 64; i++) {
+            result += characters.charAt(Math.floor(Math.random() * charactersLength));
+        }
+        consola.info(`API KEY: ${result}`)
+        return result;
+    }
+    if (key.length < 64) {
+        consola.error(`API key is too short - minimum: 64, current: ${key.length}`)
+        throw new Error("API_KEY too short.")
+    }
+    return key
+}
 export let e = errors

src/controllers/PdfController.ts

@@ -1,46 +1,78 @@
-import { Body, JsonController, Post, QueryParam, Res } from 'routing-controllers';
-import { OpenAPI } from 'routing-controllers-openapi';
-import { Runner } from '../models/Runner';
-import { RunnerCard } from '../models/RunnerCard';
-import { PdfCreator } from '../PdfCreator';
-
-/**
- * The pdf controller handels all endpoints concerning pdf generation.
- * It therefore is the hearth of the document-generation server's endpoints.
- * All endpoints have to accept a locale query-param to support i18n. 
- */
-@JsonController()
-export class PdfController {
-    private pdf: PdfCreator = new PdfCreator();
-    private initialized: boolean = false;
-
-    @Post('/contracts')
-    @OpenAPI({ description: "Generate Sponsoring contract pdfs from runner objects.<br>You can choose your prefered locale by passing the 'locale' query-param.<br> If you provide more than 100 runenrs this could take a moment or two (we tested up to 1000 runners in about 70sec so far)." })
-    async generateContracts(@Body({ validate: true, options: { limit: "500mb" } }) runners: Runner | Runner[], @Res() res: any, @QueryParam("locale") locale: string, @QueryParam("codeformat") codeformat: string) {
-        if (!this.initialized) {
-            await this.pdf.init();
-            this.initialized = true;
-        }
-        if (!Array.isArray(runners)) {
-            runners = [runners];
-        }
-        const contracts = await this.pdf.generateSponsoringContract(runners, locale, codeformat);
-        res.setHeader('content-type', 'application/pdf');
-        return contracts;
-    }
-
-    @Post('/cards')
-    @OpenAPI({ description: "Generate runner card pdfs from runner card objects.<br>You can choose your prefered locale by passing the 'locale' query-param." })
-    async generateCards(@Body({ validate: true, options: { limit: "500mb" } }) cards: RunnerCard | RunnerCard[], @Res() res: any, @QueryParam("locale") locale: string) {
-        if (!this.initialized) {
-            await this.pdf.init();
-            this.initialized = true;
-        }
-        if (!Array.isArray(cards)) {
-            cards = [cards];
-        }
-        const contracts = await this.pdf.generateRunnerCards(cards, locale);
-        res.setHeader('content-type', 'application/pdf');
-        return contracts;
-    }
-}
+import { Authorized, Body, JsonController, Post, QueryParam, Res } from 'routing-controllers';
+import { OpenAPI } from 'routing-controllers-openapi';
+import { Runner } from '../models/Runner';
+import { RunnerCard } from '../models/RunnerCard';
+import { PdfCreator } from '../PdfCreator';
+
+/**
+ * The pdf controller handels all endpoints concerning pdf generation.
+ * It therefore is the hearth of the document-generation server's endpoints.
+ * All endpoints have to accept a locale query-param to support i18n. 
+ */
+@JsonController()
+@Authorized()
+@OpenAPI({ security: [{ "AuthToken": [] }] })
+export class PdfController {
+    private pdf: PdfCreator = new PdfCreator();
+    private initialized: boolean = false;
+
+    @Post('/contracts')
+    @OpenAPI({ description: "Generate Sponsoring contract pdfs from runner objects.<br>You can choose your prefered locale by passing the 'locale' query-param.<br> If you provide more than 100 runenrs this could take a moment or two (we tested up to 1000 runners in about 70sec so far)." })
+    async generateContracts(@Body({ validate: true, options: { limit: "500mb" } }) runners: Runner[], @Res() res: any, @QueryParam("locale") locale: string, @QueryParam("codeformat") codeformat: string) {
+        if (!this.initialized) {
+            await this.pdf.init();
+            this.initialized = true;
+        }
+        if (!Array.isArray(runners)) {
+            runners = [runners];
+        }
+        runners = this.mapRunnerGroupNames(runners)
+        const contracts = await this.pdf.generateSponsoringContract(runners, locale, codeformat);
+        res.setHeader('content-type', 'application/pdf');
+        return contracts;
+    }
+
+    @Post('/cards')
+    @OpenAPI({ description: "Generate runner card pdfs from runner card objects.<br>You can choose your prefered locale by passing the 'locale' query-param." })
+    async generateCards(@Body({ validate: true, options: { limit: "500mb" } }) cards: RunnerCard | RunnerCard[], @Res() res: any, @QueryParam("locale") locale: string) {
+        if (!this.initialized) {
+            await this.pdf.init();
+            this.initialized = true;
+        }
+        if (!Array.isArray(cards)) {
+            cards = [cards];
+        }
+        cards = this.mapCardGroupNames(cards);
+        const contracts = await this.pdf.generateRunnerCards(cards, locale);
+        res.setHeader('content-type', 'application/pdf');
+        return contracts;
+    }
+
+    private mapRunnerGroupNames(runners: Runner[]): Runner[] {
+        let response = new Array<Runner>();
+        for (let runner of runners) {
+            if (!runner.group.parentGroup) {
+                runner.group.fullName = runner.group.name;
+            }
+            else {
+                runner.group.fullName = `${runner.group.parentGroup.name}/${runner.group.name}`;
+            }
+            response.push(runner)
+        }
+        return response;
+    }
+
+    private mapCardGroupNames(cards: RunnerCard[]): RunnerCard[] {
+        let response = new Array<RunnerCard>();
+        for (let card of cards) {
+            if (!card.runner.group.parentGroup) {
+                card.runner.group.fullName = card.runner.group.name;
+            }
+            else {
+                card.runner.group.fullName = `${card.runner.group.parentGroup.name}/${card.runner.group.name}`;
+            }
+            response.push(card)
+        }
+        return response;
+    }
+}

src/middlewares/AuthChecker.ts

@@ -0,0 +1,14 @@
+import { Action } from "routing-controllers";
+import { config } from '../config';
+
+/**
+ * Handles authentication via jwt's (Bearer authorization header) for all api endpoints using the @Authorized decorator.
+ * @param action Routing-Controllers action object that provides request and response objects among other stuff.
+ * @param permissions The permissions that the endpoint using @Authorized requires.
+ */
+const AuthChecker = async (action: Action) => {
+    const provided_token = action.request.query.key;
+    return provided_token == config.api_key;
+}
+
+export default AuthChecker

src/models/Runner.ts

@@ -13,7 +13,8 @@ import {
 
     IsPositive,
 
-    IsString
+    IsString,
+    ValidateNested
 } from "class-validator";
 import { RunnerGroup } from './RunnerGroup';
 
@@ -53,6 +54,7 @@ export class Runner {
      * The runner's group.
      */
     @IsObject()
+    @ValidateNested()
     group: RunnerGroup;
 
     /**
@@ -60,4 +62,8 @@ export class Runner {
      */
     @IsInt()
     distance: number;
+
+    constructor() {
+        console.log("called")
+    }
 }

src/models/RunnerGroup.ts

@@ -25,4 +25,6 @@ export class RunnerGroup {
     @IsObject()
     @IsOptional()
     parentGroup?: RunnerGroup;
+
+    fullName: string;
 }

src/templates/runner_card.html

@@ -48,7 +48,7 @@
           </div>
         </div>
         <p>{{this.runner.lastname}}, {{this.runner.firstname}} {{this.runner.middlename}}</p>
-        <p>{{this.runner.group.name}}</p>
+        <p>{{this.runner.group.fullName}}</p>
       </div>
       {{/each}}
     </div>

src/templates/sponsoring_contract.html

@@ -64,7 +64,7 @@
           <p style="font-size: x-small; display: block;">{{__ "lastname"}}</p>
         </div>
         <div class="column is-6">
-          <span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.group.name}}</span>
+          <span style="border-bottom: 1px solid; width: 100%; display: block;">{{this.group.fullName}}</span>
           <p style="font-size: x-small; display: block;">{{__ "group"}}</p>
         </div>
       </div>