feat(ws): automate generation of types and HTTP client layer from Swagger definitions

Signed-off-by: Guilherme Caponetto <[email protected]>

Author: caponetto

.github/workflows/ws-frontend-test.yml

@@ -22,6 +22,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Set up Node.js
         uses: actions/setup-node@v3
@@ -35,6 +37,10 @@ jobs:
       - name: Clean
         working-directory: workspaces/frontend
         run: npm run build:clean
+      
+      - name: Regenerate API layer code
+        working-directory: workspaces/frontend
+        run: npm run generate:api
 
       - name: Build
         working-directory: workspaces/frontend

workspaces/frontend/README.md

@@ -77,3 +77,25 @@ Automatically fix linting issues:
   ```bash
   npm run test:fix
   ```
+
+### API Types & Client Generation
+
+The TypeScript types and the HTTP client layer for interacting with the backend APIs are automatically generated from the backend's `swagger.json` file. This ensures the frontend remains aligned with the backend API contract at all times.
+
+#### Generated Code Location
+
+All generated files live in the `src/generated` directory.
+
+⚠️ Do not manually edit any files in this folder.
+
+#### Updating the Generated Code
+
+To update the generated code, first update the `swagger.version` file in the `scripts` directory to the desired commit hash of the backend's `swagger.json` file.
+
+Then run the following command to update the generated code:
+
+```bash
+npm run generate:api
+```
+
+Finally, make any necessary adaptations based on the changes in the generated code.