add optional headers to api calls (metlo-labs#83)

Author: akshay288

frontend/src/api/alerts/index.ts

@@ -1,34 +1,40 @@
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import { GetAlertParams, Alert, UpdateAlertParams } from "@common/types"
 import { getAPIURL } from "~/constants"
 
 export const getAlerts = async (
   params: GetAlertParams,
+  headers?: AxiosRequestHeaders,
 ): Promise<[Alert[], number]> => {
   const resp = await axios.get<[Alert[], number]>(`${getAPIURL()}/alerts`, {
     params,
+    headers,
   })
   return resp.data
 }
 
 export const resolveAlert = async (
   alertId: string,
   resolutionMessage: string,
+  headers?: AxiosRequestHeaders,
 ): Promise<Alert> => {
   const resp = await axios.put<Alert>(
     `${getAPIURL()}/alert/resolve/${alertId}`,
     { resolutionMessage },
+    { headers },
   )
   return resp.data
 }
 
 export const updateAlert = async (
   alertId: string,
   updateAlertParams: UpdateAlertParams,
+  headers?: AxiosRequestHeaders,
 ): Promise<Alert> => {
   const resp = await axios.put<Alert>(
     `${getAPIURL()}/alert/${alertId}`,
     updateAlertParams,
+    { headers },
   )
   return resp.data
 }

frontend/src/api/alerts/vulnerabilities.ts

@@ -1,13 +1,14 @@
 import { GetVulnerabilityAggParams, VulnerabilitySummary } from "@common/types"
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import { getAPIURL } from "~/constants"
 
 export const getVulnerabilitySummary = async (
   params: GetVulnerabilityAggParams,
+  headers?: AxiosRequestHeaders,
 ): Promise<VulnerabilitySummary> => {
   const resp = await axios.get<VulnerabilitySummary>(
     `${getAPIURL()}/vulnerability-summary`,
-    { params },
+    { params, headers },
   )
   return resp.data
 }

frontend/src/api/apiSpecs/index.ts

@@ -1,11 +1,14 @@
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import { OpenApiSpec } from "@common/types"
 import { getAPIURL } from "~/constants"
 
-export const getSpecs = async (): Promise<[OpenApiSpec[], number]> => {
+export const getSpecs = async (
+  headers?: AxiosRequestHeaders,
+): Promise<[OpenApiSpec[], number]> => {
   try {
     const resp = await axios.get<[OpenApiSpec[], number]>(
       `${getAPIURL()}/specs?listAutoGenerated=false`,
+      { headers },
     )
     if (resp.status === 200 && resp.data) {
       return resp.data
@@ -17,32 +20,45 @@ export const getSpecs = async (): Promise<[OpenApiSpec[], number]> => {
   }
 }
 
-export const uploadSpec = async (file: File) => {
+export const uploadSpec = async (file: File, headers?: AxiosRequestHeaders) => {
   const formData = new FormData()
   formData.append("file", file)
   return await axios.post(`${getAPIURL()}/spec/new`, formData, {
     headers: {
+      ...headers,
       "Content-Type": "multipart/form-data",
     },
   })
 }
 
-export const updateSpec = async (name: string, file: File) => {
+export const updateSpec = async (
+  name: string,
+  file: File,
+  headers?: AxiosRequestHeaders,
+) => {
   const formData = new FormData()
   formData.append("file", file)
   return await axios.put(`${getAPIURL()}/spec/${name}`, formData, {
     headers: {
+      ...headers,
       "Content-Type": "multipart/form-data",
     },
   })
 }
 
-export const getSpec = async (name: string) => {
-  const resp = await axios.get<OpenApiSpec>(`${getAPIURL()}/spec/${name}`)
+export const getSpec = async (name: string, headers?: AxiosRequestHeaders) => {
+  const resp = await axios.get<OpenApiSpec>(`${getAPIURL()}/spec/${name}`, {
+    headers,
+  })
   return resp.data
 }
 
-export const deleteSpec = async (name: string) => {
-  const resp = await axios.delete<OpenApiSpec>(`/api/v1/spec/${name}`)
+export const deleteSpec = async (
+  name: string,
+  headers?: AxiosRequestHeaders,
+) => {
+  const resp = await axios.delete<OpenApiSpec>(`/api/v1/spec/${name}`, {
+    headers,
+  })
   return resp.data
 }

frontend/src/api/attacks/index.ts

@@ -1,4 +1,4 @@
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import {
   AttackDetailResponse,
   AttackResponse,
@@ -8,22 +8,29 @@ import { getAPIURL } from "~/constants"
 
 export const getAttacks = async (
   params: GetAttackParams,
+  headers?: AxiosRequestHeaders,
 ): Promise<AttackResponse> => {
   const resp = await axios.get<AttackResponse>(`${getAPIURL()}/attacks`, {
     params,
+    headers,
   })
   return resp.data
 }
 
 export const getAttack = async (
   attackId: string,
+  headers?: AxiosRequestHeaders,
 ): Promise<AttackDetailResponse> => {
   const resp = await axios.get<AttackDetailResponse>(
     `${getAPIURL()}/attack/${attackId}`,
+    { headers },
   )
   return resp.data
 }
 
-export const resolveAttack = async (attackId: string): Promise<void> => {
-  await axios.put(`${getAPIURL()}/attack/${attackId}/resolve`)
+export const resolveAttack = async (
+  attackId: string,
+  headers?: AxiosRequestHeaders,
+): Promise<void> => {
+  await axios.put(`${getAPIURL()}/attack/${attackId}/resolve`, { headers })
 }

frontend/src/api/dataFields/index.ts

@@ -1,21 +1,27 @@
-import axios from "axios"
+import axios, { Axios, AxiosRequestHeaders } from "axios"
 import { DataField, UpdateDataFieldClassesParams } from "@common/types"
 import { getAPIURL } from "~/constants"
 
 export const updateDataFieldClasses = async (
   fieldId: string,
   params: UpdateDataFieldClassesParams,
+  headers?: AxiosRequestHeaders,
 ): Promise<DataField> => {
   const resp = await axios.post<DataField>(
     `${getAPIURL()}/data-field/${fieldId}/update-classes`,
     { ...params },
+    { headers },
   )
   return resp.data
 }
 
-export const deleteDataField = async (fieldId: string): Promise<DataField> => {
+export const deleteDataField = async (
+  fieldId: string,
+  headers?: AxiosRequestHeaders,
+): Promise<DataField> => {
   const resp = await axios.delete<DataField>(
     `${getAPIURL()}/data-field/${fieldId}`,
+    { headers },
   )
   return resp.data
 }

frontend/src/api/endpoints/index.ts

@@ -1,4 +1,4 @@
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import {
   ApiEndpoint,
   ApiEndpointDetailed,
@@ -9,11 +9,12 @@ import { getAPIURL } from "~/constants"
 
 export const getEndpoints = async (
   params: GetEndpointParams,
+  headers?: AxiosRequestHeaders,
 ): Promise<[ApiEndpoint[], number]> => {
   try {
     const resp = await axios.get<[ApiEndpoint[], number]>(
       `${getAPIURL()}/endpoints`,
-      { params },
+      { params, headers },
     )
     if (resp.status === 200 && resp.data) {
       return resp.data
@@ -27,10 +28,12 @@ export const getEndpoints = async (
 
 export const getEndpoint = async (
   endpointId: string,
+  headers?: AxiosRequestHeaders,
 ): Promise<ApiEndpointDetailed> => {
   try {
     const resp = await axios.get<ApiEndpointDetailed>(
       `${getAPIURL()}/endpoint/${endpointId}`,
+      { headers },
     )
     if (resp.status === 200 && resp.data) {
       return resp.data
@@ -42,9 +45,15 @@ export const getEndpoint = async (
   }
 }
 
-export const getHosts = async (): Promise<string[]> => {
+export const getHosts = async (
+  headers?: AxiosRequestHeaders,
+): Promise<string[]> => {
   try {
-    const resp = await axios.get<string[]>(`${getAPIURL()}/endpoints/hosts`)
+    const resp = await axios.get<string[]>(
+      `${getAPIURL()}/endpoints/hosts`,
+
+      { headers },
+    )
     if (resp.status === 200 && resp.data) {
       return resp.data
     }
@@ -55,10 +64,14 @@ export const getHosts = async (): Promise<string[]> => {
   }
 }
 
-export const getUsage = async (endpointId: string): Promise<Usage[]> => {
+export const getUsage = async (
+  endpointId: string,
+  headers?: AxiosRequestHeaders,
+): Promise<Usage[]> => {
   try {
     const resp = await axios.get<Usage[]>(
       `${getAPIURL()}/endpoint/${endpointId}/usage`,
+      { headers },
     )
     if (resp.status === 200 && resp.data) {
       return resp.data
@@ -73,8 +86,13 @@ export const getUsage = async (endpointId: string): Promise<Usage[]> => {
 export const updateEndpointAuthenticated = async (
   endpointId: string,
   authenticated: boolean,
+  headers?: AxiosRequestHeaders,
 ): Promise<void> => {
-  await axios.put(`${getAPIURL()}/endpoint/${endpointId}/authenticated`, {
-    authenticated,
-  })
+  await axios.put(
+    `${getAPIURL()}/endpoint/${endpointId}/authenticated`,
+    {
+      authenticated,
+    },
+    { headers },
+  )
 }

frontend/src/api/home/index.ts

@@ -1,10 +1,12 @@
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import { Summary, InstanceSettings } from "@common/types"
 import { getAPIURL } from "~/constants"
 
-export const getSummary = async (): Promise<Summary> => {
+export const getSummary = async (
+  headers?: AxiosRequestHeaders,
+): Promise<Summary> => {
   try {
-    const resp = await axios.get<Summary>(`${getAPIURL()}/summary`)
+    const resp = await axios.get<Summary>(`${getAPIURL()}/summary`, { headers })
     if (resp.status === 200 && resp.data) {
       return resp.data
     }
@@ -15,10 +17,13 @@ export const getSummary = async (): Promise<Summary> => {
   }
 }
 
-export const getInstanceSettings = async (): Promise<InstanceSettings> => {
+export const getInstanceSettings = async (
+  headers?: AxiosRequestHeaders,
+): Promise<InstanceSettings> => {
   try {
     const resp = await axios.get<InstanceSettings>(
       `${getAPIURL()}/instance-settings`,
+      { headers },
     )
     return resp.data
   } catch (err) {

frontend/src/api/home/updateEmail.ts

@@ -1,9 +1,14 @@
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import { getAPIURL } from "~/constants"
 
 export const updateEmail = async (
   email: string,
   skip: boolean,
+  headers?: AxiosRequestHeaders,
 ): Promise<void> => {
-  return axios.put(`${getAPIURL()}/instance-settings`, { email, skip })
+  return axios.put(
+    `${getAPIURL()}/instance-settings`,
+    { email, skip },
+    { headers },
+  )
 }

frontend/src/api/keys/index.ts

@@ -1,10 +1,14 @@
-import axios from "axios"
+import axios, { AxiosRequestHeaders } from "axios"
 import { ApiKey } from "@common/types"
 import { getAPIURL } from "~/constants"
 
-export const getKeys = async (): Promise<Array<ApiKey>> => {
+export const getKeys = async (
+  headers?: AxiosRequestHeaders,
+): Promise<Array<ApiKey>> => {
   try {
-    const resp = await axios.get<Array<ApiKey>>(`${getAPIURL()}/keys/list`)
+    const resp = await axios.get<Array<ApiKey>>(`${getAPIURL()}/keys/list`, {
+      headers,
+    })
     if (resp.status === 200 && resp.data) {
       return resp.data
     }
@@ -13,9 +17,14 @@ export const getKeys = async (): Promise<Array<ApiKey>> => {
     throw err
   }
 }
-export const deleteKey = async (key_name: string): Promise<void> => {
+export const deleteKey = async (
+  key_name: string,
+  headers?: AxiosRequestHeaders,
+): Promise<void> => {
   try {
-    const resp = await axios.delete(`${getAPIURL()}/keys/${key_name}/delete`)
+    const resp = await axios.delete(`${getAPIURL()}/keys/${key_name}/delete`, {
+      headers,
+    })
     if (resp.status === 200 && resp.data) {
       return
     } else {
@@ -31,13 +40,15 @@ export const deleteKey = async (key_name: string): Promise<void> => {
 }
 export const addKey = async (
   key_name: string,
+  headers?: AxiosRequestHeaders,
 ): Promise<ApiKey & { apiKey: string }> => {
   try {
     const resp = await axios.post<ApiKey & { apiKey: string }>(
       `${getAPIURL()}/keys/create`,
       {
         name: key_name,
       },
+      { headers },
     )
     if (resp.status === 200 && resp.data) {
       return resp.data