Optional response object in authorized(), switch to 'authorized' in /api/health

src/pages/api/health.ts

@@ -1,20 +1,22 @@
-// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+import { env } from '@/env/server.mjs';
-import type { NextApiRequest, NextApiResponse } from "next";
+import { authorized } from '@/utils/server';
-import { env } from "@/env/server.mjs";
+import type { NextApiRequest, NextApiResponse } from 'next';
 
 type ResponseData = {
-  now: number;
+	now: number;
-  status: string;
+	status: string;
-  timezone: string;
+	timezone: string;
 };
 
 export default async function handler(
-  req: NextApiRequest,
+	req: NextApiRequest,
-  res: NextApiResponse<ResponseData>
+	res: NextApiResponse<ResponseData>
 ) {
-  res.status(200).json({
+	const isAuthorized = authorized(req, null);
-    now: new Date().getTime(),
+
-    status: req.query.key == env.API_KEY ? "Authorized" : "Unauthorized",
+	res.status(200).json({
-    timezone: env.TIMEZONE
+		now: new Date().getTime(),
-  });
+		status: isAuthorized ? 'authorized' : 'unauthorized',
+		timezone: env.TIMEZONE
+	});
 }

src/utils/server.ts

@@ -2,14 +2,38 @@ import { env } from '@/env/server.mjs';
 import logger from '@/logger';
 import { NextApiRequest, NextApiResponse } from 'next';
 
+/**
+ * Check if the request is authorized. If response is provided, send a 401 response if unauthorized.
+
+ * @param req The request object to check.
+ * @param res Optional response object to send a 401 response if unauthorized.
+ * @returns A boolean indicating if the request is authorized.
+ */
 export function unauthorized(
 	req: NextApiRequest,
-	res: NextApiResponse
+	res: NextApiResponse | null
 ): boolean {
 	if (req.query.key != env.API_KEY) {
 		logger.debug('Unauthorized request');
-		res.status(401).json({ status: 'unauthorized' });
+		if (res) res.status(401).json({ status: 'unauthorized' });
 		return true;
 	}
+	logger.debug('Authorized request');
 	return false;
 }
+
+/**
+ * Check if the request is authorized.
+ * Performs identically to `unauthorized`, but returns the opposite value.
+ * 
+ * @param req The request object to check.
+ * @param res Optional response object to send a 401 response if unauthorized.
+ * @returns A boolean indicating if the request is authorized.
+ * @see unauthorized
+ */
+export function authorized(
+	req: NextApiRequest,
+	res: NextApiResponse | null
+): boolean {
+	return !unauthorized(req, res);
+}