Add dashboard summary, and improve test coverage and linting

.env.sample

@@ -1,5 +1,4 @@
 PORT=3000
-DB_FILE='investec.db'
 AUTH=false
 CLIENT_ID=
 CLIENT_SECRET=

.gitignore

@@ -2,4 +2,7 @@
 **/dist
 .env
 **.db-shm
-**.db-wal
+**.db-wal
+**.db-journal
+CLAUDE.md
+.idea

README.md

@@ -45,7 +45,7 @@ npm run dev
 
 This will start the simulator on http://localhost:3000
 
-Accessing the room of the domain will show the dashboard view of the server. The dashboard allows you to set the environment variables for the server and view the logs of the server.
+Accessing the root of the domain will show the dashboard view of the server. The dashboard allows you to set the environment variables for the server and view the logs of the server.
 
 There are helpful links to the Investec docs, Community wiki, GitHub repo and the Postman collection.
 
@@ -54,6 +54,8 @@ There are helpful links to the Investec docs, Community wiki, GitHub repo and th
 ### Dashboard
 - **GET /**
     - Dashboard view of the server
+- **GET /health**
+    - Health check endpoint returning service status
 ### Auth
 - **POST /identity/v2/oauth2/token**
     - Get an access token (only required if auth is turned on)
@@ -105,6 +107,10 @@ There are helpful links to the Investec docs, Community wiki, GitHub repo and th
     - Create a new account
 - **DELETE /za/pb/v1/accounts/:accountId**
     - Deletes the account and its transactions
+- **POST /za/pb/v1/accounts/beneficiaries**
+    - Create a new beneficiary
+- **DELETE /za/pb/v1/accounts/beneficiaries/:beneficiaryId**
+    - Delete a beneficiary
 - **POST /za/v1/cards/:cardKey/code/execute-live**
     - Used for the POS to execute the code on the card
 

eslint.config.js

@@ -9,7 +9,7 @@ export default [
       '@stylistic/js': stylisticJs,
     },
     rules: {
-      '@stylistic/js/max-len': 120,
+      '@stylistic/js/max-len': ['error', { code: 120 }],
     },
   },
   { files: ['**/*.{js,mjs,cjs,ts}'] },

prisma/account.ts

@@ -9,34 +9,49 @@ const accountData: Prisma.AccountCreateInput[] = [
     accountName: 'Mr J Soap',
     referenceName: 'Mr J Soap',
     productName: 'Private Bank Account',
+    kycCompliant: true,
+    profileId: '10001234567890',
+    profileName: 'Joe Soap',
   },
   {
     accountId: '4675778129910189600000004',
     accountNumber: '10012420004',
     accountName: 'Mr J Soap',
     referenceName: 'Mr J Soap',
     productName: 'PrimeSaver',
+    kycCompliant: true,
+    profileId: '10001234567890',
+    profileName: 'Joe Soap',
   },
   {
     accountId: '4675778129910189600000005',
     accountNumber: '10012420005',
     accountName: 'Mr J Soap',
     referenceName: 'Mr J Soap',
     productName: 'Cash Management Account',
+    kycCompliant: true,
+    profileId: '10001234567890',
+    profileName: 'Joe Soap',
   },
   {
     accountId: '4675778129910189600000006',
     accountNumber: '10012420006',
     accountName: 'Mr J Soap',
     referenceName: 'Mr J Soap',
     productName: 'Mortgage Loan Account',
+    kycCompliant: true,
+    profileId: '10001234567890',
+    profileName: 'Joe Soap',
   },
   {
     accountId: '4675778129910189600000007',
     accountNumber: '10012420007',
     accountName: 'Mr J Soap',
     referenceName: 'Mr J Soap',
     productName: 'Instalment Sale Loan Account',
+    kycCompliant: true,
+    profileId: '10001234567890',
+    profileName: 'Joe Soap',
   },
 ]
 

prisma/migrations/20250708211014_add_profile_and_kyc/migration.sql

@@ -0,0 +1,28 @@
+-- CreateTable
+CREATE TABLE "Profile" (
+    "profileId" TEXT NOT NULL PRIMARY KEY,
+    "profileName" TEXT NOT NULL
+);
+
+-- Insert default profile
+INSERT INTO "Profile" ("profileId", "profileName") VALUES ('10001234567890', 'Joe Soap');
+
+-- RedefineTables
+PRAGMA defer_foreign_keys=ON;
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_Account" (
+    "accountId" TEXT NOT NULL PRIMARY KEY,
+    "accountNumber" TEXT NOT NULL,
+    "accountName" TEXT NOT NULL,
+    "referenceName" TEXT NOT NULL,
+    "productName" TEXT NOT NULL,
+    "kycCompliant" BOOLEAN NOT NULL DEFAULT true,
+    "profileId" TEXT NOT NULL,
+    "profileName" TEXT NOT NULL
+);
+INSERT INTO "new_Account" ("accountId", "accountName", "accountNumber", "productName", "referenceName", "kycCompliant", "profileId", "profileName") 
+SELECT "accountId", "accountName", "accountNumber", "productName", "referenceName", true, '10001234567890', 'Joe Soap' FROM "Account";
+DROP TABLE "Account";
+ALTER TABLE "new_Account" RENAME TO "Account";
+PRAGMA foreign_keys=ON;
+PRAGMA defer_foreign_keys=OFF;

prisma/profile.ts

@@ -0,0 +1,19 @@
+import { PrismaClient, Prisma } from '@prisma/client'
+
+const prisma = new PrismaClient()
+
+const profileData: Prisma.ProfileCreateInput[] = [
+  {
+    profileId: '10001234567890',
+    profileName: 'Joe Soap',
+  },
+]
+
+export async function seedProfiles() {
+  for (const p of profileData) {
+    const profile = await prisma.profile.create({
+      data: p,
+    })
+    console.log(`Created profile with id: ${profile.profileId}`)
+  }
+}

prisma/schema.prisma

@@ -7,12 +7,20 @@ datasource db {
   url      = "file:./dev.db"
 }
 
+model Profile {
+    profileId String @id
+    profileName String
+}
+
 model Account {
     accountId String @id
     accountNumber String
     accountName String
     referenceName String
     productName String
+    kycCompliant Boolean @default(true)
+    profileId String
+    profileName String
 }
 
 model Transaction {

prisma/seed.ts

@@ -2,6 +2,7 @@ import { PrismaClient } from '@prisma/client'
 import { seedCurrencies } from './currency'
 import { seedCountries } from './country'
 import { seedMerchants } from './merchant'
+import { seedProfiles } from './profile'
 import { seedAccounts } from './account'
 import { seedTransactions } from './transaction'
 import { seedSettings } from './settings'
@@ -16,6 +17,7 @@ async function main() {
   await seedCurrencies()
   await seedCountries()
   await seedMerchants()
+  await seedProfiles()
   await seedAccounts()
   await seedTransactions()
   await seedCards()

src/app.ts

@@ -22,11 +22,11 @@ import { seedTransactions } from '../prisma/transaction.js'
 import { seedBeneficiaries } from '../prisma/beneficiary.js'
 import { seedCards } from '../prisma/card.js'
 import { seedCardCodes } from '../prisma/card-code.js'
+import { seedProfiles } from '../prisma/profile.js'
 
 dotenv.config()
 
 export const port = process.env.PORT || 3000
-// const dbFile = process.env.DB_FILE || 'investec.db'
 // const overdraft = process.env.OVERDRAFT || 5000
 const prisma = new PrismaClient()
 export const app = express()
@@ -67,18 +67,23 @@ io.on('connection', socket => {
         await prisma.beneficiary.deleteMany()
         await prisma.card.deleteMany()
         await prisma.cardCode.deleteMany()
+        await prisma.profile.deleteMany()
+        await emitDatabaseSummary()
         break
       case 'restore':
         await prisma.account.deleteMany()
         await prisma.transaction.deleteMany()
         await prisma.beneficiary.deleteMany()
         await prisma.card.deleteMany()
         await prisma.cardCode.deleteMany()
+        await prisma.profile.deleteMany()
+        seedProfiles()
         seedAccounts()
         seedTransactions()
         seedBeneficiaries()
         seedCards()
         seedCardCodes()
+        await emitDatabaseSummary()
         break
     }
     //io.emit('control', settings);
@@ -202,6 +207,33 @@ app.get('/envs', async (req: Request, res: Response) => {
   }
 })
 
+app.get('/health', (req: Request, res: Response) => {
+  res.status(200).json({ status: 'ok' })
+})
+
+app.get('/database-summary', async (req: Request, res: Response) => {
+  try {
+    const [profileCount, accountCount, cardCount, transactionCount] = await Promise.all([
+      prisma.profile.count(),
+      prisma.account.count(),
+      prisma.card.count(),
+      prisma.transaction.count()
+    ])
+
+    const summary = {
+      profiles: profileCount,
+      accounts: accountCount,
+      cards: cardCount,
+      transactions: transactionCount
+    }
+
+    return formatResponse(summary, req, res)
+  } catch (error) {
+    console.log(error)
+    return formatErrorResponse(req, res, 500)
+  }
+})
+
 function isValidToken(req: Request) {
   if (settings.auth !== true) {
     return true
@@ -223,20 +255,45 @@ function isValidToken(req: Request) {
   return false
 }
 
+export async function emitDatabaseSummary() {
+  try {
+    const [profileCount, accountCount, cardCount, transactionCount] = await Promise.all([
+      prisma.profile.count(),
+      prisma.account.count(),
+      prisma.card.count(),
+      prisma.transaction.count()
+    ])
+
+    const summary = {
+      profiles: profileCount,
+      accounts: accountCount,
+      cards: cardCount,
+      transactions: transactionCount
+    }
+
+    io.sockets.emit('database-summary', summary)
+  } catch (error) {
+    console.log('Error emitting database summary:', error)
+  }
+}
+
 export function formatResponse (data: unknown, req: Request, res: Response) {
   const date = new Date()
-  io.sockets.emit(
-    messageQueue,
-    date.toUTCString() +
-      ' ' +
-      req.method +
-      ' ' +
-      req.url +
-      ' HTTP/' +
-      req.httpVersion +
-      ' ' +
-      res.statusCode,
-  )
+  // Don't log database-summary calls as they're internal dashboard calls
+  if (req.originalUrl !== '/database-summary') {
+    io.sockets.emit(
+      messageQueue,
+      date.toUTCString() +
+        ' ' +
+        req.method +
+        ' ' +
+        req.originalUrl +
+        ' HTTP/' +
+        req.httpVersion +
+        ' ' +
+        res.statusCode,
+    )
+  }
   return res.json({
     data,
     links: {
@@ -255,7 +312,7 @@ export function formatErrorResponse(req: Request, res: Response, code: number) {
       ' ' +
       req.method +
       ' ' +
-      req.url +
+      req.originalUrl +
       ' HTTP/' +
       req.httpVersion +
       ' ' +