feat/docs: documentation site

.claude/settings.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": ["Bash(yarn test:*)", "Bash(find:*)"],
+    "deny": [],
+    "ask": []
+  }
+}

.env.example

@@ -55,6 +55,9 @@ GENERATE_MOCK_DATA_ON_INITIALISE=true
 # Used only in development builds
 GENERATE_MOCK_DATA_ON_RESTART=false
 
+# LLM
+LLM_OPENAI_API_KEY=""
+
 # Frontend dependencies
 # NB! If adding more such urls with different hosts on the server and client, please check whether /frontend/src/routes/[[lang=locale]]/api/cache/+server.ts needs to be updated accordingly
 # Used to reach backend instance from a browser

.github/workflows/main.yaml

@@ -5,9 +5,9 @@ on:
     branches:
       - main
     paths-ignore:
-      - '**.md'
-      - '**/*/.env.example'
-      - '.env.example'
+      - "**.md"
+      - "**/*/.env.example"
+      - ".env.example"
   pull_request:
     types:
       - opened
@@ -17,12 +17,11 @@ on:
     branches:
       - main
     paths-ignore:
-      - '**.md'
-      - '**/*/.env.example'
-      - '.env.example'
+      - "**.md"
+      - "**/*/.env.example"
+      - ".env.example"
 
 jobs:
-
   frontend-and-shared-module-validation:
     runs-on: ubuntu-latest
 
@@ -40,10 +39,10 @@ jobs:
         with:
           node-version: 20.18.1
           cache: "yarn"
-  
+
       - name: "Install all dependencies"
         run: yarn install --frozen-lockfile
-  
+
       - name: "Build all shared modules"
         run: yarn build:shared
 
@@ -100,7 +99,7 @@ jobs:
 
       - name: "Install all dependencies"
         run: yarn install --frozen-lockfile
-            
+
       - name: "Build all shared modules"
         run: yarn build:shared
 
@@ -134,7 +133,7 @@ jobs:
         uses: threeal/setup-yarn-action@v2
         with:
           version: 4.6
-  
+
       - name: Setup Node.js 20.18.1
         uses: actions/setup-node@v4
         with:
@@ -161,7 +160,7 @@ jobs:
         run: yarn playwright install
 
       - name: "Start OpenVAA"
-        run: yarn dev
+        run: yarn dev:start
 
       - name: "Collect Docker logs on failure"
         if: failure()

.gitignore

@@ -4,11 +4,18 @@
 !.env.example
 node_modules
 
+# Claude Code local settings
+.claude/*.local.json
+
 # Yarn 4 without Zero-installs
 .pnp.*
 .yarn/*
 !.yarn/patches
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
-!.yarn/versions
+!.yarn/versions
+
+# Generated documentation
+docs/generated/
+typedoc.frontend.json

backend/vaa-strapi/package.json

@@ -11,7 +11,7 @@
     "strapi": "strapi",
     "test:e2e": "jest --forceExit --detectOpenHandles",
     "test:unit": "vitest run ./src",
-    "generate:types": "strapi ts:generate-types"
+    "generate:types": "strapi ts:generate-types || echo 'Maybe you need to copy the .env file from the project root to backend/vaa-strapi?'"
   },
   "dependencies": {
     "@aws-sdk/client-ses": "^3.741.0",

backend/vaa-strapi/src/api/admin-job/content-types/admin-job/schema.json

@@ -0,0 +1,59 @@
+{
+  "kind": "collectionType",
+  "collectionName": "admin_jobs",
+  "info": {
+    "singularName": "admin-job",
+    "pluralName": "admin-jobs",
+    "displayName": "Admin Job",
+    "description": ""
+  },
+  "options": {
+    "draftAndPublish": false
+  },
+  "pluginOptions": {},
+  "attributes": {
+    "electionId": {
+      "type": "string",
+      "required": true
+    },
+    "jobId": {
+      "type": "uid",
+      "required": true
+    },
+    "jobType": {
+      "type": "string",
+      "required": true,
+      "minLength": 1
+    },
+    "author": {
+      "type": "email",
+      "required": true
+    },
+    "endStatus": {
+      "type": "enumeration",
+      "enum": [
+        "completed",
+        "failed",
+        "aborted"
+      ]
+    },
+    "startTime": {
+      "type": "datetime"
+    },
+    "endTime": {
+      "type": "datetime"
+    },
+    "input": {
+      "type": "json"
+    },
+    "output": {
+      "type": "json"
+    },
+    "messages": {
+      "type": "json"
+    },
+    "metadata": {
+      "type": "json"
+    }
+  }
+}

backend/vaa-strapi/src/api/admin-job/controllers/admin-job.ts

@@ -0,0 +1,7 @@
+/**
+ * admin-job controller
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreController('api::admin-job.admin-job');

backend/vaa-strapi/src/api/admin-job/routes/admin-job.ts

@@ -0,0 +1,23 @@
+/**
+ * admin-job router
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreRouter('api::admin-job.admin-job', {
+  only: ['find', 'findOne', 'create', 'update'],
+  config: {
+    find: {
+      policies: ['global::user-is-admin']
+    },
+    findOne: {
+      policies: ['global::user-is-admin']
+    },
+    create: {
+      policies: ['global::user-is-admin']
+    },
+    update: {
+      policies: ['global::user-is-admin']
+    }
+  }
+});

backend/vaa-strapi/src/api/admin-job/services/admin-job.ts

@@ -0,0 +1,7 @@
+/**
+ * admin-job service
+ */
+
+import { factories } from '@strapi/strapi';
+
+export default factories.createCoreService('api::admin-job.admin-job');

backend/vaa-strapi/src/api/question/controllers/customdata.ts

@@ -0,0 +1,29 @@
+import { updateCustomData } from '../../../util/updateCustomData';
+import type { Data } from '@strapi/strapi';
+import type { StrapiContext } from '../../../../types/customStrapiTypes';
+
+export default {
+  /**
+   * Update the `Question`’s `customData` by merging the new data.
+   */
+  async update(ctx: StrapiContext) {
+    const data = await updateQuestionCustomData(ctx);
+    ctx.response.status = 200;
+    ctx.response.body = { data };
+  }
+};
+
+function updateQuestionCustomData({
+  params,
+  request
+}: StrapiContext): Promise<Data.ContentType<'api::question.question'>> {
+  console.error({ params });
+  const customData = request.body?.data;
+  if (!customData || typeof customData !== 'object')
+    throw new Error('[updateQuestionCustomData] No customData object provided.');
+  return updateCustomData({
+    collection: 'api::question.question',
+    documentId: params.id,
+    customData
+  });
+}

backend/vaa-strapi/src/api/question/routes/00-customRoutes.ts

@@ -0,0 +1,19 @@
+/**
+ * Contains the definitions for the `api::question.customData.update` action.
+ * NB. The filename starts with zeros so that it is matched before the core routes.
+ */
+
+import type { Core } from '@strapi/strapi';
+
+export default {
+  routes: [
+    {
+      method: 'POST',
+      path: '/question/:id/update-custom-data',
+      handler: 'customdata.update',
+      config: {
+        policies: ['global::user-is-admin']
+      }
+    } as Core.RouteConfig
+  ]
+};

backend/vaa-strapi/src/components/settings/access.json

@@ -16,6 +16,9 @@
     },
     "answersLocked": {
       "type": "boolean"
+    },
+    "adminApp": {
+      "type": "boolean"
     }
   }
 }

backend/vaa-strapi/src/extensions/documentation/documentation/1.0.0/full_documentation.json

@@ -10011,6 +10011,9 @@
           },
           "answersLocked": {
             "type": "boolean"
+          },
+          "adminApp": {
+            "type": "boolean"
           }
         }
       },