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,30 +2,98 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
-#### [v0.1.3](https://git.odit.services/lfk/document-server/compare/v0.1.2...v0.1.3)
+#### [v0.3.2](https://git.odit.services/lfk/document-server/compare/v0.3.0...v0.3.2)
 
-- Merge pull request 'Barcode generation feature/13-barcode_generation' (#21) from feature/13-barcode_generation into dev [`ff36b48`](https://git.odit.services/lfk/document-server/commit/ff36b4871f2d696c0b86883d529365ee8f1c6132)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`cc6a53b`](https://git.odit.services/lfk/document-server/commit/cc6a53b25895594874acca370a1439d37bb280de)
-- 🚀Bumped version to v0.1.3 [`6a14232`](https://git.odit.services/lfk/document-server/commit/6a142328898d5b89fa11eaf033372971d1093b0c)
+- 🚀Bumped version to v0.3.2 [`a9019e4`](https://git.odit.services/lfk/document-server/commit/a9019e4c67e7620b65650d60b0ebd57bc11a854e)
-- 🧾New changelog file version [CI SKIP] [skip ci] [`ad9a8a4`](https://git.odit.services/lfk/document-server/commit/ad9a8a4fe0649d48db924771be8ecb4cbf5c162a)
+- 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)
+
+> 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)
+- Implemented runner generation using fakerjs [`0894446`](https://git.odit.services/lfk/document-server/commit/08944460854c78cd4368cf178b022c31b624c8d9)
+- Styled front [`016f746`](https://git.odit.services/lfk/document-server/commit/016f746c7cec29ab391b3918c7589dea0cff9890)
+- Now loading sponsor logos from env [`29376a7`](https://git.odit.services/lfk/document-server/commit/29376a7782ce39f04f856ec78775e65aa11f0ed7)
+- Implmented sponsoring image selection from array [`68a1b8f`](https://git.odit.services/lfk/document-server/commit/68a1b8f3e0515e56c7c6069f7f3ef8db24c92674)
+- 📖New license file version [CI SKIP] [skip ci] [`dbccbf6`](https://git.odit.services/lfk/document-server/commit/dbccbf68f4e22470b4fc93c894527cc78973e324)
+- Added cards api endpoint [`929ac81`](https://git.odit.services/lfk/document-server/commit/929ac81515b3b426ff06f1d6d913bab930421a92)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`96204d8`](https://git.odit.services/lfk/document-server/commit/96204d809e852c1bcea808a9c8f5ca0f8475c87f)
+- 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)
+- Added card generation speed tests (part 2) [`d38923c`](https://git.odit.services/lfk/document-server/commit/d38923c4ad3a2cf8872e236dd42f078e2a0e1045)
+- Implemented basic contracts tests in various sizes [`a1b0a19`](https://git.odit.services/lfk/document-server/commit/a1b0a1918db552eb385fedcbaa576ad493a1d605)
+- tmp [`0d27916`](https://git.odit.services/lfk/document-server/commit/0d27916188114fa41e666170135de2b714ff113a)
+- Added new env vars to readme [`cf0f583`](https://git.odit.services/lfk/document-server/commit/cf0f5839ee1e1b87f7b5bd5a299a35574fd1bb3c)
+- Merge pull request 'Added speedtest feature/19-speed_test' (#23) from feature/19-speed_test into dev [`7ac8edb`](https://git.odit.services/lfk/document-server/commit/7ac8edb5cf4b7317a703faa32ded482a8c2b9b91)
+
+#### [v0.2.0](https://git.odit.services/lfk/document-server/compare/v0.1.3...v0.2.0)
+
+> 9 February 2021
+
+- Merge pull request 'Alpha Release 0.2.0 - The barcode release' (#22) from dev into main [`b952ac4`](https://git.odit.services/lfk/document-server/commit/b952ac4d728952e1fb6d26b0929e3f946748b85b)
 - Implemented async barcode generation using async helpers [`edc846a`](https://git.odit.services/lfk/document-server/commit/edc846ab05319a4e60422625678f204bc145884c)
+- 📖New license file version [CI SKIP] [skip ci] [`fea0b1d`](https://git.odit.services/lfk/document-server/commit/fea0b1dc0582d2906bad22f2ff5e5aad90a1c885)
 - Reworked template layout for barcode [`1c06689`](https://git.odit.services/lfk/document-server/commit/1c066898009883f510fa204c66800e5f6228a15d)
-- Added basic barcode generation [`8072d0b`](https://git.odit.services/lfk/document-server/commit/8072d0b1940ef6f316ce78dcbcb9e5af5bab04e7)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`7122fe7`](https://git.odit.services/lfk/document-server/commit/7122fe7dbe3fae64806492636255147078eb03c8)
-- 🧾New changelog file version [CI SKIP] [skip ci] [`03f63e3`](https://git.odit.services/lfk/document-server/commit/03f63e3777381a4475910e6fa4a3986f87b73f39)
+- Merge pull request 'Barcode generation feature/13-barcode_generation' (#21) from feature/13-barcode_generation into dev [`ff36b48`](https://git.odit.services/lfk/document-server/commit/ff36b4871f2d696c0b86883d529365ee8f1c6132)
-- Merge pull request 'Alpha Release 0.1.3 - More env vars' (#20) from dev into main [`ecd02a1`](https://git.odit.services/lfk/document-server/commit/ecd02a1af7431d0bf615c4ec064f64e023946e49)
 - Now with working code scaleing [`4b79b29`](https://git.odit.services/lfk/document-server/commit/4b79b29ee6319559c9d68ddb11f831d25f12b3da)
+- Added basic barcode generation [`8072d0b`](https://git.odit.services/lfk/document-server/commit/8072d0b1940ef6f316ce78dcbcb9e5af5bab04e7)
 - Now loading barcode format from env with overwrite via query param [`9a7c1d6`](https://git.odit.services/lfk/document-server/commit/9a7c1d64fdbdadbd104739133a87773e4d2bca01)
 - Added fallback error image [`5023457`](https://git.odit.services/lfk/document-server/commit/502345782f26895ccf3089d15c3817709b62dfcc)
 - First part of the handlebars barcode generation [`a35f8cf`](https://git.odit.services/lfk/document-server/commit/a35f8cfd3aa94923968fd77425c074844d28ec0d)
-- 🧾New changelog file version [CI SKIP] [skip ci] [`b6296b8`](https://git.odit.services/lfk/document-server/commit/b6296b8d97cda943dfb5e11bc9dfbb2f363f5b81)
 - Added todo [`75d2ac3`](https://git.odit.services/lfk/document-server/commit/75d2ac3c5f80f8440b6d48c33b15ef17565559b3)
 - Removed promise [`e1ec193`](https://git.odit.services/lfk/document-server/commit/e1ec193a4ff1cd618da90f5f2d029ec848a6f669)
-- Added new env vars to config [`3bb322e`](https://git.odit.services/lfk/document-server/commit/3bb322ede5db15a147c0d7a8db2a68ccb7fa2112)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`03f63e3`](https://git.odit.services/lfk/document-server/commit/03f63e3777381a4475910e6fa4a3986f87b73f39)
-- Now loading interpolation vars from config/env [`b4ebae2`](https://git.odit.services/lfk/document-server/commit/b4ebae283b472b2f0c6e28caed49b30edb119585)
 - Fixed broken mime-type [`4187a8e`](https://git.odit.services/lfk/document-server/commit/4187a8e82015495c0e0362e957e236ed6935a908)
-- Merge pull request 'Load more stuff from env feature/16-env_vars' (#17) from feature/16-env_vars into dev [`bc4d16e`](https://git.odit.services/lfk/document-server/commit/bc4d16e6f8959ed35d7e87647de84584cdfddd7b)
-- Added new env vars to readme [`b77bb3a`](https://git.odit.services/lfk/document-server/commit/b77bb3ad9dba9d73c2c81215ba57936192155a9a)
 - Switched to using the current runner's id as the barcode text [`3e2b011`](https://git.odit.services/lfk/document-server/commit/3e2b011d2887d261fb9c36820982095d6dd6d847)
 - Added barcode field to template [`27d1d69`](https://git.odit.services/lfk/document-server/commit/27d1d69360c8513079abcfe3a6fc2a50309a2b61)
+
+#### [v0.1.3](https://git.odit.services/lfk/document-server/compare/v0.1.2...v0.1.3)
+
+> 9 February 2021
+
+- Merge pull request 'Alpha Release 0.1.3 - More env vars' (#20) from dev into main [`ecd02a1`](https://git.odit.services/lfk/document-server/commit/ecd02a1af7431d0bf615c4ec064f64e023946e49)
+- 🚀Bumped version to v0.1.3 [`6a14232`](https://git.odit.services/lfk/document-server/commit/6a142328898d5b89fa11eaf033372971d1093b0c)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`ad9a8a4`](https://git.odit.services/lfk/document-server/commit/ad9a8a4fe0649d48db924771be8ecb4cbf5c162a)
+- 🧾New changelog file version [CI SKIP] [skip ci] [`b6296b8`](https://git.odit.services/lfk/document-server/commit/b6296b8d97cda943dfb5e11bc9dfbb2f363f5b81)
+- Merge pull request 'Load more stuff from env feature/16-env_vars' (#17) from feature/16-env_vars into dev [`bc4d16e`](https://git.odit.services/lfk/document-server/commit/bc4d16e6f8959ed35d7e87647de84584cdfddd7b)
+- Added new env vars to config [`3bb322e`](https://git.odit.services/lfk/document-server/commit/3bb322ede5db15a147c0d7a8db2a68ccb7fa2112)
+- Added new env vars to readme [`b77bb3a`](https://git.odit.services/lfk/document-server/commit/b77bb3ad9dba9d73c2c81215ba57936192155a9a)
+- Now loading interpolation vars from config/env [`b4ebae2`](https://git.odit.services/lfk/document-server/commit/b4ebae283b472b2f0c6e28caed49b30edb119585)
 - 🧾New changelog file version [CI SKIP] [skip ci] [`a306009`](https://git.odit.services/lfk/document-server/commit/a30600943d01116b99e946cb705a16d0372b5095)
 
 #### [v0.1.2](https://git.odit.services/lfk/document-server/compare/v0.1.1...v0.1.2)

README.md

@@ -34,6 +34,8 @@ The basic generation mechanism makes the templates and routes interchangeable (i
 | EVENT_NAME | String | "Please set the event name" | The event's name - used to generate pdf text.
 | 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
@@ -877,9 +877,17 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
  
 
+# faker
+**Author**: undefined
+**Repo**: http://github.com/Marak/Faker.js.git
+**License**: MIT
+**Description**: Generate massive amounts of fake contextual data
+## License Text
+ 
+
 # 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
@@ -908,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
@@ -958,9 +966,17 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  
 
+# start-server-and-test
+**Author**: Gleb Bahmutov <gleb.bahmutov@gmail.com>
+**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
+ 
+
 # 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
@@ -989,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.1.3",
+  "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": {
@@ -8,7 +8,9 @@
     "build": "rimraf ./dist && tsc && cp-cli ./src/templates ./dist/templates && cp-cli ./src/locales ./dist/locales",
     "licenses:export": "license-exporter --markdown",
     "release": "release-it --only-version",
-    "translations:sort": "node sort_translations.js"
+    "translations:sort": "node sort_translations.js",
+    "test:speed": "start-server-and-test dev http://localhost:4010/docs/openapi.json test:speed:run",
+    "test:speed:run": "ts-node src/tests/speedtest.ts"
   },
   "repository": {
     "type": "git",
@@ -57,18 +59,20 @@
     "pdf-lib": "^1.16.0",
     "puppeteer": "^7.0.1",
     "reflect-metadata": "^0.1.13",
-    "routing-controllers": "^0.9.0-alpha.6",
+    "routing-controllers": "0.9.0-alpha.6",
-    "routing-controllers-openapi": "^2.2.0"
+    "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",
     "cp-cli": "^2.0.0",
+    "faker": "^5.3.1",
     "nodemon": "^2.0.7",
     "release-it": "^14.2.2",
     "rimraf": "^3.0.2",
+    "start-server-and-test": "^1.12.0",
     "ts-node": "^9.1.1",
     "typescript": "^4.1.3"
   },

src/PdfCreator.ts

@@ -11,6 +11,7 @@ import puppeteer from "puppeteer";
 import { awaitAsyncHandlebarHelpers, helpers } from './asyncHelpers';
 import { config } from './config';
 import { Runner } from './models/Runner';
+import { RunnerCard } from './models/RunnerCard';
 import { RunnerGroup } from './models/RunnerGroup';
 
 /**
@@ -86,6 +87,15 @@ export class PdfCreator {
                 return i18next.t(str, PdfCreator.interpolations).toString();
             }
         );
+        await Handlebars.registerHelper('--sponsor',
+            function (str) {
+                const index = (parseInt(str) % config.sponor_logos.length);
+                if (isNaN(index)) {
+                    return "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg=="
+                }
+                return config.sponor_logos[index];
+            }
+        );
         this.browser = await puppeteer.launch({ headless: true, args: minimal_args });
     }
 
@@ -117,6 +127,33 @@ export class PdfCreator {
         return pdf
     }
 
+    /**
+     * Generate runner card pdfs.
+     * @param cards The runner cars you want to generate the cards for.
+     * @param locale The locale used for the cards (default:en)
+     */
+    public async generateRunnerCards(cards: RunnerCard[], locale: string = "en", codeformat: string = config.codeformat): Promise<Buffer> {
+        if (cards.length > 10) {
+            let pdf_promises = new Array<Promise<Buffer>>();
+            let i, j;
+            for (i = 0, j = cards.length; i < j; i += 10) {
+                let chunk = cards.slice(i, i + 10);
+                pdf_promises.push(this.generateRunnerCards(chunk, locale));
+            }
+            const pdfs = await Promise.all(pdf_promises);
+            return await this.mergePdfs(pdfs);
+        }
+        const cards_swapped = this.swapArrayPairs(cards);
+        await i18next.changeLanguage(locale);
+        const template_source = fs.readFileSync(`${this.templateDir}/runner_card.html`, 'utf8');
+        const template = Handlebars.compile(template_source);
+        let result = template({ cards, cards_swapped, eventname: "LfK! 2069", codeformat: "qrcode" })
+        result = await awaitAsyncHandlebarHelpers(result);
+        fs.writeFileSync("lelelelele.tmp", result);
+        const pdf = await this.renderPdf(result, { format: "A4", landscape: false });
+        return pdf
+    }
+
     /**
      * Converts all images in html to base64.
      * Works with image files in the template directory or images from urls.
@@ -203,4 +240,26 @@ export class PdfCreator {
         runner.group = group;
         return runner;
     }
+
+    /**
+     * Swaps pairs (0/1, 2/3, ...) of elements in an array recursively.
+     * If the last element has no partner it inserts an empty element at the end and swaps the two
+     * This is needed to generate pdfs with front- and backside that get printet on one paper.
+     * @param array The array which's pairs shall get switched.
+     * @returns Array with swapped pairs,
+     */
+    private swapArrayPairs(array): Array<any> {
+        if (array.length == 1) {
+            return [null, array[0]];
+        }
+        if (array.length == 0) {
+            return null;
+        }
+
+        const rest = this.swapArrayPairs(array.slice(2))
+        if (!rest) {
+            return [array[1], array[0]]
+        }
+        return [array[1], array[0]].concat(rest);
+    }
 }

src/apispec.ts

@@ -14,6 +14,14 @@ export function generateSpec(storage: MetadataArgsStorage, schemas) {
         {
             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.",

src/app.ts

@@ -3,11 +3,13 @@ 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}`],

src/asyncHelpers.ts

@@ -3,6 +3,7 @@ import bwipjs from "bwip-js";
 
 export const asyncHelpers = new AsyncHelpers();
 async function generateBarcode(str, options, emtpy, cb) {
+    if (str == null) { cb(null, "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg=="); return; }
     let res = await generateBase64Barcode(options.toString(), str.toString());
     cb(null, res);
 }
@@ -18,7 +19,7 @@ export async function generateBase64Barcode(type: string, content: string): Prom
         height: 10,
         width: 10,
         includetext: true,
-        textxalign: 'center',
+        textxalign: 'center'
     }
     if (type != "qrcode") {
         delete options.width;

src/config.ts

@@ -1,3 +1,4 @@
+import consola from "consola";
 import { config as configDotenv } from 'dotenv';
 
 configDotenv();
@@ -8,7 +9,9 @@ export const config = {
     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"
+    codeformat: process.env.CODEFORMAT || "qrcode",
+    sponor_logos: getSponsorLogos(),
+    api_key: getApiKey(),
 }
 let errors = 0
 if (typeof config.internal_port !== "number") {
@@ -17,4 +20,33 @@ if (typeof config.internal_port !== "number") {
 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,6 +1,7 @@
-import { Body, JsonController, Post, QueryParam, Res } from 'routing-controllers';
+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';
 
 /**
@@ -9,13 +10,15 @@ import { PdfCreator } from '../PdfCreator';
  * 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 | Runner[], @Res() res: any, @QueryParam("locale") locale: string, @QueryParam("codeformat") codeformat: string) {
+    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;
@@ -23,8 +26,53 @@ export class PdfController {
         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

@@ -0,0 +1,71 @@
+<html>
+
+<head>
+  <meta charset="utf8">
+  <title>Sponsoring contract</title>
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.1/css/bulma.min.css">
+  <style>
+    .sheet {
+      margin: 0;
+      overflow: hidden;
+      position: relative;
+      box-sizing: border-box;
+      page-break-after: always;
+      padding: 1.2cm 2cm 1.2cm 2cm
+    }
+
+    body.A4 .sheet {
+      width: 210mm;
+      height: 296mm
+    }
+
+    .runnercard {
+      border: 1px solid;
+      height: 5.5cm;
+      overflow: hidden;
+    }
+  </style>
+</head>
+
+<body class="A4 landscape">
+  <div class="sheet">
+    <div class="columns is-multiline">
+      {{#each cards}}
+      <div class="column is-half runnercard">
+        <p class="title is-5" style="text-align: center; padding-bottom: 0; margin-top: -0.75rem;">{{../eventname}}</p>
+        <p style="text-align: center; margin-top: -1.5rem; font-size: small;">lauf-fuer-kaya.de - am 01.01.2021</p>
+        <p style="font-size: small;">Mit unterstützung von:</p>
+        <div class="columns" style="height: 6rem; overflow: hidden;">
+          <div class="column is-two-thirds">
+            <!--SPONSOR LOGO HERE-->
+            <img style="vertical-align: revert; margin-top: auto; object-fit: cover; max-height: 2cm;"
+              src="{{--sponsor this.id}}" />
+          </div>
+          <div class="column is-one-third">
+            <!--BARCODE HERE-->
+            <img style="vertical-align: revert; margin-top: auto; object-fit: cover; max-height: 2cm;"
+              src="{{--bc this.id ../codeformat}}" />
+          </div>
+        </div>
+        <p>{{this.runner.lastname}}, {{this.runner.firstname}} {{this.runner.middlename}}</p>
+        <p>{{this.runner.group.fullName}}</p>
+      </div>
+      {{/each}}
+    </div>
+  </div>
+  <div class="sheet">
+    <div class="columns is-multiline">
+      {{#each cards_swapped}}
+      <div class="column is-half runnercard" style="justify-content: center; align-items: center; text-align: center;">
+        <!--SPONSOR LOGO FIRST-->
+        <div style="height: 2cm; padding: 0 0 2.25cm 0">
+          <img style="object-fit: cover; max-height: 2cm;" src="{{--sponsor this.id}}" />
+        </div>
+        <img style="object-fit: cover; max-height: 2.5cm; position: relative;" src="{{--bc this.id ../codeformat}}" />
+      </div>
+      {{/each}}
+    </div>
+  </div>
+</body>
+
+</html>

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>

src/tests/speedtest.ts

@@ -0,0 +1,128 @@
+import axios from "axios"
+import faker from "faker"
+import { Runner } from '../models/Runner'
+import { RunnerCard } from '../models/RunnerCard'
+import { RunnerGroup } from '../models/RunnerGroup'
+
+const baseurl = "http://localhost:4010"
+
+axios.interceptors.request.use((config) => {
+    config.headers['request-startTime'] = process.hrtime()
+    return config
+})
+
+axios.interceptors.response.use((response) => {
+    const start = response.config.headers['request-startTime']
+    const end = process.hrtime(start)
+    const milliseconds = Math.round((end[0] * 1000) + (end[1] / 1000000))
+    response.headers['request-duration'] = milliseconds
+    return response
+})
+
+function generateRunners(amount: number): Runner[] {
+    let runners: Runner[] = new Array<Runner>();
+    let group = new RunnerGroup();
+    let runner = new Runner();
+    for (var i = 0; i < amount; i++) {
+        group.name = faker.company.bsBuzz();
+        group.id = Math.floor(Math.random() * (9999999 - 1) + 1);
+        runner.firstname = faker.name.firstName();
+        runner.lastname = faker.name.lastName();
+        runner.id = Math.floor(Math.random() * (9999999 - 1) + 1);
+        runners.push(runner);
+    }
+    return runners;
+}
+
+function generateCards(amount: number): RunnerCard[] {
+    let cards: RunnerCard[] = new Array<RunnerCard>();
+    let card = new RunnerCard();
+    for (let runner of generateRunners(amount)) {
+        card.id = runner.id;
+        card.code = idToEan13(card.id);
+        card.runner = runner;
+        cards.push(card);
+    }
+    return cards;
+}
+
+function idToEan13(id): string {
+    const multiply = [1, 3];
+    id = id.toString();
+
+    if (id.length > 12) {
+        throw new Error("id too long");
+    }
+    while (id.length < 12) { id = '0' + id; }
+
+    let total = 0;
+    id.split('').forEach((letter, index) => {
+        total += parseInt(letter, 10) * multiply[index % 2];
+    });
+    const checkSum = (Math.ceil(total / 10) * 10) - total;
+    return id + checkSum.toString();
+}
+
+async function postContracts(runners: Runner[]): Promise<Measurement> {
+    const res = await axios.post(`${baseurl}/contracts`, runners);
+    return new Measurement("contract", runners.length, parseInt(res.headers['request-duration']))
+}
+
+async function postCards(cards: RunnerCard[]): Promise<Measurement> {
+    const res = await axios.post(`${baseurl}/cards`, cards);
+    return new Measurement("card", cards.length, parseInt(res.headers['request-duration']))
+}
+
+async function testContracts(sizes): Promise<Measurement[]> {
+    let measurements = new Array<Measurement>();
+    console.log("#### Testing contracts ####");
+
+    for (let size of sizes) {
+        const m = await postContracts(generateRunners(size));
+        console.log(m.toString());
+        measurements.push(m);
+    }
+    return measurements;
+}
+
+async function testCards(sizes): Promise<Measurement[]> {
+    let measurements = new Array<Measurement>();
+    console.log("#### Testing Cards ####");
+
+    for (let size of sizes) {
+        const m = await postCards(generateCards(size));
+        console.log(m.toString());
+        measurements.push(m);
+    }
+    return measurements;
+}
+
+async function main() {
+    const sizes = [0, 1, 10, 50, 100, 200, 500, 1000]
+    console.log("########### Speedtest ###########");
+    console.log(`Document server version (according to the api): ${(await axios.get("http://localhost:4010/version")).data.version}`);
+    console.log("####### Running tests #######");
+    const contractResults = await testContracts(sizes);
+    const cardResults = await testCards(sizes);
+    console.log("####### Results #######");
+    console.table(contractResults);
+    console.table(cardResults);
+}
+
+main();
+
+class Measurement {
+    public type: string;
+    public inputcount: number;
+    public responsetime: number;
+
+    constructor(type: string, input: number, time: number) {
+        this.type = type;
+        this.inputcount = input;
+        this.responsetime = time;
+    }
+
+    public toString(): string {
+        return `It took ${this.responsetime}ms to generate ${this.inputcount} pdfs for the type ${this.type}.`
+    }
+}