Rework API Responses

apps/api/src/index.ts

@@ -18,6 +18,7 @@ import {
 	authenticatedMiddleware,
 	afterRouteLogicMiddleware,
 } from "./lib/functions/middleware";
+import { API_ERROR_MESSAGES } from "shared";
 
 interface Env {}
 
@@ -44,7 +45,8 @@ export const api = HonoBetterAuth()
 
 		return c.json(
 			{
-				error: "Internal Server Error",
+				message: "An unexpected error occurred.",
+				code: API_ERROR_MESSAGES.GENERIC_ERROR,
 			},
 			500,
 		);

apps/api/src/lib/functions/database.ts

@@ -45,11 +45,12 @@ export function isSiteAdminUser(
 }
 
 export async function leaveTeam(userId: string, teamId: string) {
-	await db
+	return db
 		.delete(userToTeam)
 		.where(
 			and(eq(userToTeam.userId, userId), eq(userToTeam.teamId, teamId)),
-		);
+		)
+		.returning({ teamId: userToTeam.teamId });
 }
 
 export async function getAdminUserForTeam(userId: string, teamId: string) {
@@ -61,7 +62,7 @@ export async function getAdminUserForTeam(userId: string, teamId: string) {
 		),
 	});
 }
-
+// TODO: This function is lowkey pivotal so we should ensure it is WAI.
 export async function isUserSiteAdminOrQueryHasPermissions<T = unknown>(
 	userSiteRole: SiteRoleType,
 	// Accept either a Promise (already invoked query) or a function that returns a Promise

apps/api/src/lib/functions/middleware.ts

@@ -16,10 +16,7 @@ export async function setUserSessionContextMiddleware(c: Context, next: Next) {
 	const requestId = nanoid();
 	c.set("requestId", requestId);
 
-	await logInfo(
-		`Middleware for request path ${c.req.path} for ${userString}`,
-		c,
-	);
+	logInfo(`Middleware for request path ${c.req.path} for ${userString}`, c);
 
 	if (!session) {
 		c.set("user", null);
@@ -44,8 +41,14 @@ export async function authenticatedMiddleware(c: ApiContext, next: Next) {
 	const user = c.get("user");
 	const session = c.get("session");
 	if (!(user && session)) {
-		await logInfo(`Unauthorized access attempt to ${c.req.path}`, c);
-		return c.json({ error: API_ERROR_MESSAGES.notAuthorized }, 401);
+		logInfo(`Unauthorized access attempt to ${c.req.path}`, c);
+		return c.json(
+			{
+				message: "Please log in.",
+				code: API_ERROR_MESSAGES.NOT_AUTHENTICATED,
+			},
+			401,
+		);
 	}
 	return next();
 }

apps/api/src/lib/types.ts

@@ -1,5 +1,5 @@
 import { log } from "db";
-import { SessionType, UserType } from "db/types";
+import type { SessionType, UserType } from "db/types";
 import type { Context } from "hono";
 
 // Match the Variables shape declared in HonoBetterAuth

apps/api/src/routes/log.ts

@@ -27,30 +27,50 @@ const logHandler = HonoBetterAuth()
 	.get("/admin/all", async (c) => {
 		const user = c.get("user");
 		if (!user || !isSiteAdminUser(user.siteRole)) {
-			return c.json({ message: API_ERROR_MESSAGES.notAuthorized }, 401);
+			return c.json(
+				{
+					message:
+						"You are not authorized to access this endpoint. Only site admins can access all logs.",
+					code: API_ERROR_MESSAGES.NOT_AUTHORIZED,
+				},
+				403,
+			);
 		}
 		const allLogs = await db.query.log.findMany();
-		return c.json({ message: allLogs }, 200);
+		return c.json({ data: allLogs }, 200);
 	})
 	// This route needs to be made to get logs from a team. Logs should be paginated and alllow for basic filtering on the frontend
 	.get("/:teamId", zValidator("param", teamIdSchema), async (c) => {
 		const user = c.get("user");
 		const teamId = c.req.valid("param").teamId;
 
 		if (!user) {
-			return c.json({ message: API_ERROR_MESSAGES.notAuthorized }, 401);
+			return c.json(
+				{
+					message: "Please log in.",
+					code: API_ERROR_MESSAGES.NOT_AUTHENTICATED,
+				},
+				401,
+			);
 		}
 
 		const hasPermissions = await isUserSiteAdminOrQueryHasPermissions(
 			user.siteRole,
 			getAdminUserForTeam(user.id, teamId),
 		);
 		if (!hasPermissions) {
-			return c.json({ message: API_ERROR_MESSAGES.notAuthorized }, 401);
+			return c.json(
+				{
+					message:
+						"You are not authorized to access this endpoint. Only admins can access team logs.",
+					code: API_ERROR_MESSAGES.NOT_AUTHORIZED,
+				},
+				403,
+			);
 		}
 		const logs = await db.query.log.findMany({
 			where: eq(log.teamId, teamId),
 		});
-		return c.json({ message: logs }, 200);
+		return c.json({ data: logs }, 200);
 	});
 export default logHandler;