feat(api): Add 2014 version to prepare for 2024 version (#636)

* feat(models): All current models are switched to the `2014-` prefixed ones

* refactor(models): Move all current modesl under 2014 folder

* feat(routes): Add in 2014 routes and move controllers

* Now with working tests

* Setup graphql endpoints for 2014

* Allow for versioned schemas

* Swagger updates

* Add versioning readme

README.md

@@ -37,33 +37,37 @@ Then back over here in the 5e-srd-api repo, in the file `docker-compose.yml`, yo
 ## Making API Requests
 
 Make API requests by using the root address:
-`http://localhost:3000/api/`
+`http://localhost:3000/api/2014`
 
 You should get a response with the available endpoints for the root:
 
 ```json
 {
-  "ability-scores": "/api/ability-scores",
-  "classes": "/api/classes",
-  "conditions": "/api/conditions",
-  "damage-types": "/api/damage-types",
-  "equipment-categories": "/api/equipment-categories",
-  "equipment": "/api/equipment",
-  "features": "/api/features",
-  "languages": "/api/languages",
-  "magic-schools": "/api/magic-schools",
-  "monsters": "/api/monsters",
-  "proficiencies": "/api/proficiencies",
-  "races": "/api/races",
-  "skills": "/api/skills",
-  "spells": "/api/spells",
-  "subclasses": "/api/subclasses",
-  "subraces": "/api/subraces",
-  "traits": "/api/traits",
-  "weapon-properties": "/api/weapon-properties"
+  "ability-scores": "/api/2014/ability-scores",
+  "classes": "/api/2014/classes",
+  "conditions": "/api/2014/conditions",
+  "damage-types": "/api/2014/damage-types",
+  "equipment-categories": "/api/2014/equipment-categories",
+  "equipment": "/api/2014/equipment",
+  "features": "/api/2014/features",
+  "languages": "/api/2014/languages",
+  "magic-schools": "/api/2014/magic-schools",
+  "monsters": "/api/2014/monsters",
+  "proficiencies": "/api/2014/proficiencies",
+  "races": "/api/2014/races",
+  "skills": "/api/2014/skills",
+  "spells": "/api/2014/spells",
+  "subclasses": "/api/2014/subclasses",
+  "subraces": "/api/2014/subraces",
+  "traits": "/api/2014/traits",
+  "weapon-properties": "/api/2014/weapon-properties"
 }
 ```
 
+### Versioning
+
+The API is versioned by release years of the SRD. Currently only `/api/2014` is available. The next version will be `/api/2024`.
+
 ## Working with a local image of 5e Database
 
 If you are working on a feature which requires changes to both this repo, _and_ the 5e-database repo, it is useful to know how to connect the former to the latter for testing purposes. A simple process for doing so is as follows:

docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   db:
     image: ghcr.io/5e-bits/5e-database:latest

jest.config.integration.ts

@@ -6,6 +6,7 @@ const integrationConfig: Config.InitialOptions = {
   displayName: 'Integration Tests',
   testRegex: '\\.itest\\.(js|ts)$',
   silent: true,
+  maxWorkers: '50%', // Use 50% of available CPUs
 };
 
 console.log('RUNNING INTEGRATION TESTS');

package.json

@@ -19,7 +19,7 @@
     "gen-postman": "npm run bundle-swagger && portman --cliOptionsFile portman-cli.json",
     "test": "npm run test:unit && npm run test:integration:local",
     "test:unit": "node --experimental-vm-modules node_modules/jest/bin/jest.js -c jest.config.unit.ts",
-    "test:integration": "node --experimental-vm-modules node_modules/jest/bin/jest.js -c jest.config.integration.ts --detectOpenHandles --forceExit",
+    "test:integration": "node --max-old-space-size=4096 --experimental-vm-modules node_modules/jest/bin/jest.js -c jest.config.integration.ts --detectOpenHandles --forceExit --runInBand",
     "test:integration:local": "docker compose pull && docker compose build && docker compose run --use-aliases api npm run test:integration"
   },
   "dependencies": {

src/controllers/api/2014/abilityScoreController.ts

@@ -0,0 +1,4 @@
+import AbilityScore from '../../../models/2014/abilityScore/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(AbilityScore);

src/controllers/api/2014/alignmentController.ts

@@ -0,0 +1,4 @@
+import Alignment from '../../../models/2014/alignment/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Alignment);

src/controllers/api/2014/backgroundController.ts

@@ -0,0 +1,4 @@
+import Background from '../../../models/2014/background/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Background);

src/controllers/api/classController.ts → src/controllers/api/2014/classController.ts

@@ -1,14 +1,14 @@
 import { Request, Response, NextFunction } from 'express';
 
-import { ResourceList, escapeRegExp } from '../../util/index.js';
-
-import Class from '../../models/class/index.js';
-import Feature from '../../models/feature/index.js';
-import Level from '../../models/level/index.js';
-import Proficiency from '../../models/proficiency/index.js';
-import SimpleController from '../simpleController.js';
-import Spell from '../../models/spell/index.js';
-import Subclass from '../../models/subclass/index.js';
+import { ResourceList, escapeRegExp } from '../../../util/index.js';
+
+import Class from '../../../models/2014/class/index.js';
+import Feature from '../../../models/2014/feature/index.js';
+import Level from '../../../models/2014/level/index.js';
+import Proficiency from '../../../models/2014/proficiency/index.js';
+import SimpleController from '../../simpleController.js';
+import Spell from '../../../models/2014/spell/index.js';
+import Subclass from '../../../models/2014/subclass/index.js';
 
 const simpleController = new SimpleController(Class);
 interface ShowLevelsForClassQuery {

src/controllers/api/2014/conditionController.ts

@@ -0,0 +1,4 @@
+import Condition from '../../../models/2014/condition/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Condition);

src/controllers/api/2014/damageTypeController.ts

@@ -0,0 +1,4 @@
+import DamageType from '../../../models/2014/damageType/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(DamageType);

src/controllers/api/2014/equipmentCategoryController.ts

@@ -0,0 +1,4 @@
+import EquipmentCategory from '../../../models/2014/equipmentCategory/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(EquipmentCategory);

src/controllers/api/2014/equipmentController.ts

@@ -0,0 +1,4 @@
+import Equipment from '../../../models/2014/equipment/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Equipment);

src/controllers/api/2014/featController.ts

@@ -0,0 +1,4 @@
+import Feat from '../../../models/2014/feat/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Feat);

src/controllers/api/2014/featureController.ts

@@ -0,0 +1,4 @@
+import Feature from '../../../models/2014/feature/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Feature);

src/controllers/api/imageController.ts → src/controllers/api/2014/imageController.ts

@@ -1,7 +1,7 @@
 import { NextFunction, Request, Response } from 'express';
 
 import { GetObjectCommand } from '@aws-sdk/client-s3';
-import { awsS3Client } from '../../util/index.js';
+import { awsS3Client } from '../../../util/index.js';
 
 const show = async (req: Request, res: Response, next: NextFunction) => {
   try {

src/controllers/api/2014/languageController.ts

@@ -0,0 +1,4 @@
+import Language from '../../../models/2014/language/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Language);

src/controllers/api/magicItemController.ts → src/controllers/api/2014/magicItemController.ts

@@ -1,7 +1,7 @@
 import { Request, Response, NextFunction } from 'express';
 
-import { ResourceList, escapeRegExp, redisClient } from '../../util/index.js';
-import MagicItem from '../../models/magicItem/index.js';
+import { ResourceList, escapeRegExp, redisClient } from '../../../util/index.js';
+import MagicItem from '../../../models/2014/magicItem/index.js';
 
 interface IndexQuery {
   name?: { $regex: RegExp };

src/controllers/api/2014/magicSchoolController.ts

@@ -0,0 +1,4 @@
+import MagicSchool from '../../../models/2014/magicSchool/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(MagicSchool);

src/controllers/api/monsterController.ts → src/controllers/api/2014/monsterController.ts

@@ -1,8 +1,8 @@
 import { Request, Response, NextFunction } from 'express';
 
-import { ResourceList, escapeRegExp, redisClient } from '../../util/index.js';
+import { ResourceList, escapeRegExp, redisClient } from '../../../util/index.js';
 
-import Monster from '../../models/monster/index.js';
+import Monster from '../../../models/2014/monster/index.js';
 
 interface IndexQuery {
   name?: { $regex: RegExp };
@@ -22,7 +22,7 @@ export const index = async (req: Request, res: Response, next: NextFunction) =>
 
       const challengeRating = req.query.challenge_rating as string[];
       searchQueries.challenge_rating = {
-        $in: challengeRating.map(Number).filter(item => !isNaN(item)),
+        $in: challengeRating.map(Number).filter((item) => !isNaN(item)),
       };
     }
 

src/controllers/api/2014/proficiencyController.ts

@@ -0,0 +1,4 @@
+import Proficiency from '../../../models/2014/proficiency/index.js';
+import SimpleController from '../../simpleController.js';
+
+export default new SimpleController(Proficiency);

src/controllers/api/raceController.ts → src/controllers/api/2014/raceController.ts

@@ -1,11 +1,11 @@
 import { Request, Response, NextFunction } from 'express';
 
-import Proficiency from '../../models/proficiency/index.js';
-import Race from '../../models/race/index.js';
-import { ResourceList } from '../../util/data.js';
-import SimpleController from '../simpleController.js';
-import Subrace from '../../models/subrace/index.js';
-import Trait from '../../models/trait/index.js';
+import Proficiency from '../../../models/2014/proficiency/index.js';
+import Race from '../../../models/2014/race/index.js';
+import { ResourceList } from '../../../util/data.js';
+import SimpleController from '../../simpleController.js';
+import Subrace from '../../../models/2014/subrace/index.js';
+import Trait from '../../../models/2014/trait/index.js';
 
 const simpleController = new SimpleController(Race);
 

src/controllers/api/ruleController.ts → src/controllers/api/2014/ruleController.ts

@@ -1,7 +1,7 @@
 import { Request, Response, NextFunction } from 'express';
-import { ResourceList, escapeRegExp, redisClient } from '../../util/index.js';
+import { ResourceList, escapeRegExp, redisClient } from '../../../util/index.js';
 
-import Rule from '../../models/rule/index.js';
+import Rule from '../../../models/2014/rule/index.js';
 
 interface IndexQuery {
   name?: { $regex: RegExp };

src/controllers/api/ruleSectionController.ts → src/controllers/api/2014/ruleSectionController.ts

@@ -1,7 +1,7 @@
 import { Request, Response, NextFunction } from 'express';
-import { ResourceList, escapeRegExp, redisClient } from '../../util/index.js';
+import { ResourceList, escapeRegExp, redisClient } from '../../../util/index.js';
 
-import RuleSection from '../../models/ruleSection/index.js';
+import RuleSection from '../../../models/2014/ruleSection/index.js';
 interface IndexQuery {
   name?: { $regex: RegExp };
   desc?: { $regex: RegExp };

src/controllers/api/2014/skillController.ts

@@ -0,0 +1,4 @@
+import SimpleController from '../../simpleController.js';
+import Skill from '../../../models/2014/skill/index.js';
+
+export default new SimpleController(Skill);

src/controllers/api/spellController.ts → src/controllers/api/2014/spellController.ts

@@ -1,13 +1,13 @@
 import { Request, Response, NextFunction } from 'express';
-import { ResourceList, escapeRegExp, redisClient } from '../../util/index.js';
+import { ResourceList, escapeRegExp, redisClient } from '../../../util/index.js';
 
 interface IndexQuery {
   name?: { $regex: RegExp };
   level?: { $in: string[] };
   'school.name'?: { $in: RegExp[] };
 }
 
-import Spell from '../../models/spell/index.js';
+import Spell from '../../../models/2014/spell/index.js';
 
 export const index = async (req: Request, res: Response, next: NextFunction) => {
   try {
@@ -23,7 +23,7 @@ export const index = async (req: Request, res: Response, next: NextFunction) =>
     if (req.query.school !== undefined) {
       let schoolRegex;
       if (Array.isArray(req.query.school)) {
-        schoolRegex = req.query.school.map(c => new RegExp(escapeRegExp(c as string), 'i'));
+        schoolRegex = req.query.school.map((c) => new RegExp(escapeRegExp(c as string), 'i'));
       } else {
         schoolRegex = [new RegExp(escapeRegExp(req.query.school as string), 'i')];
       }

src/controllers/api/subclassController.ts → src/controllers/api/2014/subclassController.ts

@@ -1,9 +1,9 @@
 import { Request, Response, NextFunction } from 'express';
-import Feature from '../../models/feature/index.js';
-import Level from '../../models/level/index.js';
-import { ResourceList } from '../../util/data.js';
-import SimpleController from '../simpleController.js';
-import Subclass from '../../models/subclass/index.js';
+import Feature from '../../../models/2014/feature/index.js';
+import Level from '../../../models/2014/level/index.js';
+import { ResourceList } from '../../../util/data.js';
+import SimpleController from '../../simpleController.js';
+import Subclass from '../../../models/2014/subclass/index.js';
 
 const simpleController = new SimpleController(Subclass);
 

src/controllers/api/subraceController.ts → src/controllers/api/2014/subraceController.ts

@@ -1,9 +1,9 @@
 import { Request, Response, NextFunction } from 'express';
-import Proficiency from '../../models/proficiency/index.js';
-import { ResourceList } from '../../util/data.js';
-import SimpleController from '../simpleController.js';
-import Subrace from '../../models/subrace/index.js';
-import Trait from '../../models/trait/index.js';
+import Proficiency from '../../../models/2014/proficiency/index.js';
+import { ResourceList } from '../../../util/data.js';
+import SimpleController from '../../simpleController.js';
+import Subrace from '../../../models/2014/subrace/index.js';
+import Trait from '../../../models/2014/trait/index.js';
 
 const simpleController = new SimpleController(Subrace);
 

src/controllers/api/2014/traitController.ts

@@ -0,0 +1,4 @@
+import SimpleController from '../../simpleController.js';
+import Trait from '../../../models/2014/trait/index.js';
+
+export default new SimpleController(Trait);

src/controllers/api/2014/weaponPropertyController.ts

@@ -0,0 +1,4 @@
+import SimpleController from '../../simpleController.js';
+import WeaponProperty from '../../../models/2014/weaponProperty/index.js';
+
+export default new SimpleController(WeaponProperty);