fix(api): refactor all endpoints a bit

disallow methods other that GET
properly type return types
add type guards where needed
make all endpoints
return same response format for consistency

src/pages/api/find.ts

@@ -1,37 +1,32 @@
-import { NextApiRequest, NextApiResponse } from 'next';
-import Find, { FindQueryParams } from 'src/interfaces/shared/search';
-import getOrSetApiCache from 'src/utils/getOrSetApiCache';
+import type { NextApiRequest, NextApiResponse } from 'next';
+import Find, { type FindQueryParams } from 'src/interfaces/shared/search';
 import basicSearch from 'src/utils/fetchers/basicSearch';
-import { cleanQueryStr } from 'src/utils/helpers';
+import getOrSetApiCache from 'src/utils/getOrSetApiCache';
 import { findKey } from 'src/utils/constants/keys';
+import { AppError, cleanQueryStr } from 'src/utils/helpers';
 
-export default async function handler(req: NextApiRequest, res: NextApiResponse) {
-  const queryObj = req.query as FindQueryParams;
-  const query = queryObj.q?.trim();
-
-  if(!query) {
-	res.status(200);
-    res.json({
-	  title: null,
-	  results: null
-	});
-  }
+type ResponseData =
+  | { status: true; data: { title: null | string; results: null | Find } }
+  | { status: false; message: string };
 
+export default async function handler(req: NextApiRequest, res: NextApiResponse<ResponseData>) {
   try {
-	const entries = Object.entries(queryObj);
+    if (req.method !== 'GET') throw new AppError('Invalid method', 400);
+
+    const queryObj = req.query as FindQueryParams | Record<string, never>;
+    const query = queryObj.q?.trim();
+
+    if (!query) {
+      return res.status(200).json({ status: true, data: { title: null, results: null } });
+    }
+
+    const entries = Object.entries(queryObj);
     const queryStr = cleanQueryStr(entries);
-    const result = await getOrSetApiCache(findKey(queryStr), basicSearch, queryStr);
-    res.status(200);
-    res.json({
-	  title: query,
-	  results: result
-	});
+    const results = await getOrSetApiCache(findKey(queryStr), basicSearch, queryStr);
+
+    res.status(200).json({ status: true, data: { title: query, results } });
   } catch (error: any) {
-    const { message, statusCode } = error;
-    res.status(statusCode);
-    res.json({
-	  success: false,
-	  message: message
-	 });
+    const { message = 'Not found', statusCode = 404 } = error;
+    res.status(statusCode).json({ status: false, message });
   }
 }

src/pages/api/list/[listId].ts

@@ -1,22 +1,23 @@
-import { NextApiRequest, NextApiResponse } from 'next';
-import getOrSetApiCache from 'src/utils/getOrSetApiCache';
+import type { NextApiRequest, NextApiResponse } from 'next';
+import type List from 'src/interfaces/shared/list';
 import list from 'src/utils/fetchers/list';
+import getOrSetApiCache from 'src/utils/getOrSetApiCache';
 import { listKey } from 'src/utils/constants/keys';
+import { AppError } from 'src/utils/helpers';
 
-export default async function handler(req: NextApiRequest, res: NextApiResponse) {
-  const listId = req.query.listId;
-  const pageNum = (req.query.page as string | undefined) ?? '1';
+type ResponseData = { status: true; data: List } | { status: false; message: string };
 
+export default async function handler(req: NextApiRequest, res: NextApiResponse<ResponseData>) {
   try {
+    if (req.method !== 'GET') throw new AppError('Invalid method', 400);
+
+    const listId = req.query.listId as string;
+    const pageNum = req.query.page as string | undefined;
+
     const data = await getOrSetApiCache(listKey(listId, pageNum), list, listId, pageNum);
-    res.status(200);
-    res.json(data);
+    res.status(200).json({ status: true, data });
   } catch (error: any) {
-    const { message, statusCode } = error;
-    res.status(statusCode);
-    res.json({
-	  success: false,
-	  message: message
-	 });
+    const { message = 'Not found', statusCode = 404 } = error;
+    res.status(statusCode).json({ status: false, message });
   }
 }

src/pages/api/name/[nameId].ts

@@ -1,21 +1,22 @@
-import { NextApiRequest, NextApiResponse } from 'next';
-import getOrSetApiCache from 'src/utils/getOrSetApiCache';
+import type { NextApiRequest, NextApiResponse } from 'next';
+import type Name from 'src/interfaces/shared/name';
 import name from 'src/utils/fetchers/name';
+import getOrSetApiCache from 'src/utils/getOrSetApiCache';
 import { nameKey } from 'src/utils/constants/keys';
+import { AppError } from 'src/utils/helpers';
 
-export default async function handler(req: NextApiRequest, res: NextApiResponse) {
-  const nameId = req.query.nameId;
+type ResponseData = { status: true; data: Name } | { status: false; message: string };
 
+export default async function handler(req: NextApiRequest, res: NextApiResponse<ResponseData>) {
   try {
+    if (req.method !== 'GET') throw new AppError('Invalid method', 400);
+
+    const nameId = req.query.nameId as string;
+
     const data = await getOrSetApiCache(nameKey(nameId), name, nameId);
-    res.status(200);
-    res.json(data);
+    res.status(200).json({ status: true, data });
   } catch (error: any) {
-    const { message, statusCode } = error;
-    res.status(statusCode);
-    res.json({
-	  success: false,
-	  message: message
-	 });
+    const { message = 'Not found', statusCode = 404 } = error;
+    res.status(statusCode).json({ status: false, message });
   }
 }

src/pages/api/title/[titleId].ts

@@ -1,21 +1,21 @@
-import { NextApiRequest, NextApiResponse } from 'next';
-import getOrSetApiCache from 'src/utils/getOrSetApiCache';
+import type { NextApiRequest, NextApiResponse } from 'next';
+import type Title from 'src/interfaces/shared/title';
 import title from 'src/utils/fetchers/title';
+import getOrSetApiCache from 'src/utils/getOrSetApiCache';
 import { titleKey } from 'src/utils/constants/keys';
+import { AppError } from 'src/utils/helpers';
 
-export default async function handler(req: NextApiRequest, res: NextApiResponse) {
-  const titleId = req.query.titleId;
+type ResponseData = { status: true; data: Title } | { status: false; message: string };
 
+export default async function handler(req: NextApiRequest, res: NextApiResponse<ResponseData>) {
   try {
+    if (req.method !== 'GET') throw new AppError('Invalid method', 400);
+
+    const titleId = req.query.titleId as string;
     const data = await getOrSetApiCache(titleKey(titleId), title, titleId);
-    res.status(200);
-    res.json(data);
+    res.status(200).json({ status: true, data });
   } catch (error: any) {
-    const { message, statusCode } = error;
-    res.status(statusCode);
-    res.json({
-	  success: false,
-	  message: message
-	 });
+    const { message = 'Not found', statusCode = 404 } = error;
+    res.status(statusCode).json({ status: false, message });
   }
 }