Update BaseAPI to make it generic

navapbc · Sep 13, 2024 · d165e38 · d165e38
1 parent 95d1232
commit d165e38
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 23 deletions.
diff --git a/frontend/src/app/[locale]/opportunity/[id]/page.tsx b/frontend/src/app/[locale]/opportunity/[id]/page.tsx
@@ -1,7 +1,7 @@
 import {
-  ApiResponse,
+  OpportunityApiResponse,
   Opportunity,
-} from "../../../../types/opportunity/opportunityResponseTypes";
+} from "src/types/opportunity/opportunityResponseTypes";
 
 import BetaAlert from "src/components/BetaAlert";
 import Breadcrumbs from "src/components/Breadcrumbs";
@@ -40,7 +40,7 @@ export default async function OpportunityListing({
   }
 
   const api = new OpportunityListingAPI();
-  let opportunity: ApiResponse;
+  let opportunity: OpportunityApiResponse;
   try {
     opportunity = await api.getOpportunityById(id);
   } catch (error) {

diff --git a/frontend/src/app/api/BaseApi.ts b/frontend/src/app/api/BaseApi.ts
@@ -17,7 +17,7 @@ import { compact, isEmpty } from "lodash";
 import { QueryParamData } from "src/services/search/searchfetcher/SearchFetcher";
 // TODO (#1682): replace search specific references (since this is a generic API file that any
 // future page or different namespace could use)
-import { SearchAPIResponse } from "../../types/search/searchResponseTypes";
+import { APIResponse } from "src/types/apiResponseTypes";
 
 export type ApiMethod = "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
 export interface JSONRequestBody {
@@ -108,10 +108,10 @@ export default abstract class BaseApi {
     queryParamData?: QueryParamData,
   ) {
     let response: Response;
-    let responseBody: SearchAPIResponse;
+    let responseBody: APIResponse;
     try {
       response = await fetch(url, fetchOptions);
-      responseBody = (await response.json()) as SearchAPIResponse;
+      responseBody = (await response.json()) as APIResponse;
     } catch (error) {
       // API most likely down, but also possibly an error setting up or sending a request
       // or parsing the response.
@@ -196,7 +196,7 @@ export function fetchErrorToNetworkError(
 }
 
 function handleNotOkResponse(
-  response: SearchAPIResponse,
+  response: APIResponse,
   message: string,
   status_code: number,
   searchInputs?: QueryParamData,

diff --git a/frontend/src/app/api/OpportunityListingAPI.ts b/frontend/src/app/api/OpportunityListingAPI.ts
@@ -1,6 +1,6 @@
 import "server-only";
 
-import { ApiResponse } from "../../types/opportunity/opportunityResponseTypes";
+import { OpportunityApiResponse } from "src/types/opportunity/opportunityResponseTypes";
 import BaseApi from "./BaseApi";
 
 export default class OpportunityListingAPI extends BaseApi {
@@ -16,14 +16,16 @@ export default class OpportunityListingAPI extends BaseApi {
     return "opportunities";
   }
 
-  async getOpportunityById(opportunityId: number): Promise<ApiResponse> {
+  async getOpportunityById(
+    opportunityId: number,
+  ): Promise<OpportunityApiResponse> {
     const subPath = `${opportunityId}`;
-    const response = await this.request(
+    const response = (await this.request(
       "GET",
       this.basePath,
       this.namespace,
       subPath,
-    );
-    return response as ApiResponse;
+    )) as OpportunityApiResponse;
+    return response;
   }
 }
diff --git a/frontend/src/services/search/searchfetcher/APISearchFetcher.ts b/frontend/src/services/search/searchfetcher/APISearchFetcher.ts
@@ -21,7 +21,9 @@ export class APISearchFetcher extends SearchFetcher {
       // await new Promise((resolve) => setTimeout(resolve, 13250));
 
       const response: SearchAPIResponse =
-        await this.searchApi.searchOpportunities(searchInputs);
+        (await this.searchApi.searchOpportunities(
+          searchInputs,
+        )) as SearchAPIResponse;
       response.actionType = searchInputs.actionType;
       response.fieldChanged = searchInputs.fieldChanged;
 

diff --git a/frontend/src/types/apiResponseTypes.ts b/frontend/src/types/apiResponseTypes.ts
@@ -0,0 +1,17 @@
+export interface PaginationInfo {
+  order_by: string;
+  page_offset: number;
+  page_size: number;
+  sort_direction: string;
+  total_pages: number;
+  total_records: number;
+}
+
+export interface APIResponse {
+  data: unknown[] | object;
+  message: string;
+  status_code: number;
+  pagination_info?: PaginationInfo;
+  warnings?: unknown[] | null | undefined;
+  errors?: unknown[] | null | undefined;
+}
diff --git a/frontend/src/types/opportunity/opportunityResponseTypes.ts b/frontend/src/types/opportunity/opportunityResponseTypes.ts
@@ -50,7 +50,7 @@ export interface Opportunity {
   updated_at: string;
 }
 
-export interface ApiResponse {
+export interface OpportunityApiResponse {
   data: Opportunity;
   message: string;
   status_code: number;

diff --git a/frontend/src/types/search/searchResponseTypes.ts b/frontend/src/types/search/searchResponseTypes.ts
@@ -1,4 +1,5 @@
 import { SearchFetcherActionType } from "./searchRequestTypes";
+import { PaginationInfo } from "src/types/apiResponseTypes";
 
 export interface AssistanceListing {
   assistance_listing_number: string;
@@ -52,15 +53,6 @@ export interface Opportunity {
   updated_at: string;
 }
 
-export interface PaginationInfo {
-  order_by: string;
-  page_offset: number;
-  page_size: number;
-  sort_direction: string;
-  total_pages: number;
-  total_records: number;
-}
-
 export interface SearchAPIResponse {
   data: Opportunity[];
   message: string;