feat: create request validation & openapi spec generation library

.github/workflows/ci.yml

@@ -0,0 +1,98 @@
+name: CI
+run-name: CI for ${{ github.ref }}
+on:
+  push:
+    branches-ignore:
+      - "tools/*"
+  pull_request:
+jobs:
+  Tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v6
+      - name: NPM Install
+        run: npm i
+        working-directory: ${{ github.workspace }}
+      - name: Test Suite
+        run: |
+          export DOCUMENTED=1
+          export MBUS_URL=https://mbus.bustime.mock.mb.thething.fyi/
+          export RIDE_URL=https://ride.bustime.mock.mb.thething.fyi/
+          npm start &
+          until curl localhost:3000 > /dev/null 2>&1
+          do
+            sleep 1 # waits for initial startup
+          done
+          sleep 10
+          until curl localhost:3000 > /dev/null 2>&1
+          do
+            sleep 1 # waits for the walking cache to populate
+          done
+          sleep 10 # waits for the graph/predictions to be built
+          npx vitest run test
+          # npm test
+        working-directory: ${{ github.workspace }}
+
+  Typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v6
+      # - name: Placeholder
+      #   run: echo hi
+      #   working-directory: ${{ github.workspace }}
+      - name: NPM Install
+        run: npm i
+        working-directory: ${{ github.workspace }}
+      - name: Typecheck
+        run: tsc --noEmit
+        working-directory: ${{ github.workspace }}
+
+  Typedoc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v6
+      - name: NPM Install
+        run: npm i
+        working-directory: ${{ github.workspace }}
+      - name: Build Docs
+        run: npx typedoc --entryPointStrategy expand ./src --treatWarningsAsErrors
+        working-directory: ${{ github.workspace }}
+      - name: Sync Files
+        uses: SamKirkland/FTP-Deploy-Action@v4.4.0
+        with:
+          server: ${{ secrets.FTP_SERVER }}
+          port: ${{ secrets.FTP_PORT }}
+          username: ${{ secrets.FTP_USERNAME }}
+          password: ${{ secrets.FTP_PASSWORD }}
+          local-dir: ${{ github.workspace }}/docs/
+          server-dir: ${{ github.ref }}/typedoc/
+
+  OpenAPI:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v6
+      - name: NPM Install
+        run: npm i
+        working-directory: ${{ github.workspace }}
+      - name: Build Spec
+        run: |
+          export DOCUMENTED=1
+          export DOCUMENTED_OUTPUT_FILE=openapi/spec.json
+          export DOCUMENTED_EXIT_ON_OUTPUT=1
+          mkdir openapi
+          npm start
+        working-directory: ${{ github.workspace }}
+      - name: Sync Files
+        uses: SamKirkland/FTP-Deploy-Action@v4.4.0
+        with:
+          server: ${{ secrets.FTP_SERVER }}
+          port: ${{ secrets.FTP_PORT }}
+          username: ${{ secrets.FTP_USERNAME }}
+          password: ${{ secrets.FTP_PASSWORD }}
+          local-dir: ${{ github.workspace }}/openapi/
+          server-dir: ${{ github.ref }}/openapi/
+

.gitignore

@@ -2,4 +2,6 @@ node_modules/
 package-lock.json
 .env
 .vscode/
-src/assets/walkingCache.json
+src/assets/walkingCache.json
+*.log
+/docs/