Routing

[JasonWarrenUK]

The Great Router Update

Run npm install before trying this update

1. Scripts

command	outcome
npm run dev	run the project without compiling & monitor for changes in realtime

---

2. Packages

List of changes that should be implemented via npm install

New Packages

package	purpose
@types/prompt-sync	take & store user input from terminal

Updated Packages

package	change	old value	new value
@types/node	version	22.5.5	22.7.4
tsx	dependency type	dependencies	devDependencies

---

3. Configuration

file	parameter	old value	new value
tsconfig	target	es2016	es2020
tsconfig	module	NodeNext	ESNext
tsconfig	strict	false	true
nodemon	exec	"ts-node --esm -r tsconfig-paths/register ./src/app.ts"	"tsx src/app.ts"

---

4. Usage & Endpoints

Endpoint	Note
/	Display HTML menu of available routers
/api/	Tests responsiveness of hub router
/api/transfer	Tests responsiveness of internal router
/api/user	Tests responsiveness of user-facing router
/api/openAI	Tests responsiveness of openAI router
/api/spotify	Tests responsiveness of spotify router

---

5. Documents & Notes

Path	Change	Reason
./docs/DATAFLOW.md	New	Visualise where data goes

---

6. Project Structure

• ./src/controllers/${apiName}/index.ts refactored as modular function calls
• ./src/controllers/server renamed to ./src/controllers/user
• ./models created as a placeholder for later architecture

---

7. Issues

Related to #23, #25, #26, #41, #51, #52, #53
Closes #6, #7, #9, #10, #12, #13, #14, #15, #17, #18, #19, #21, #33, #34, #35, #37, #38, #40, #44, #45, #46, #47, #48, #49, #50, #55, #70