feat: renterd autopilot config evaluation api

Author: alexfreska

.changeset/famous-lemons-smile.md

@@ -0,0 +1,5 @@
+---
+'@siafoundation/renterd-js': patch
+---
+
+Fixed a typo in the naming of the config method.

.changeset/new-bananas-double.md

@@ -0,0 +1,5 @@
+---
+'@siafoundation/request': minor
+---
+
+Updated axios imports.

.changeset/nine-crabs-try.md

@@ -0,0 +1,7 @@
+---
+'@siafoundation/renterd-js': minor
+'@siafoundation/renterd-react': minor
+'@siafoundation/renterd-types': minor
+---
+
+Added support for autopilot config evaluation.

libs/renterd-js/src/autopilot.ts

@@ -1,4 +1,7 @@
 import {
+  AutopilotConfigEvaluateParams,
+  AutopilotConfigEvaluatePayload,
+  AutopilotConfigEvaluateResponse,
   AutopilotConfigParams,
   AutopilotConfigPayload,
   AutopilotConfigResponse,
@@ -36,7 +39,7 @@ export function Autopilot({
       AutopilotStatePayload,
       AutopilotStateResponse
     >(axios, 'get', autopilotStateRoute),
-    confg: buildRequestHandler<
+    config: buildRequestHandler<
       AutopilotConfigParams,
       AutopilotConfigPayload,
       AutopilotConfigResponse
@@ -46,6 +49,11 @@ export function Autopilot({
       AutopilotConfigUpdatePayload,
       AutopilotConfigUpdateResponse
     >(axios, 'put', autopilotConfigRoute),
+    configEvaluate: buildRequestHandler<
+      AutopilotConfigEvaluateParams,
+      AutopilotConfigEvaluatePayload,
+      AutopilotConfigEvaluateResponse
+    >(axios, 'post', autopilotConfigRoute),
     hostsSearch: buildRequestHandler<
       AutopilotHostsSearchParams,
       AutopilotHostsSearchPayload,

libs/renterd-js/src/bus.ts

@@ -137,7 +137,6 @@ import {
   ObjectsStatsParams,
   ObjectsStatsPayload,
   ObjectsStatsResponse,
-  Setting,
   SettingParams,
   SettingPayload,
   SettingResponse,
@@ -537,7 +536,7 @@ export function Bus({ api, password }: { api: string; password?: string }) {
     setting: buildRequestHandler<
       SettingParams,
       SettingPayload,
-      SettingResponse<Setting>
+      SettingResponse
     >(axios, 'get', busSettingKeyRoute),
     settingUpdate: buildRequestHandler<
       SettingUpdateParams,

libs/renterd-react/src/autopilot.ts

@@ -14,6 +14,9 @@ import {
   AutopilotConfigUpdateParams,
   AutopilotConfigUpdatePayload,
   AutopilotConfigUpdateResponse,
+  AutopilotConfigEvaluateParams,
+  AutopilotConfigEvaluatePayload,
+  AutopilotConfigEvaluateResponse,
   AutopilotHostsSearchParams,
   AutopilotHostsSearchPayload,
   AutopilotHostsSearchResponse,
@@ -68,6 +71,16 @@ export function useAutopilotConfigUpdate(
   )
 }
 
+export function useAutopilotConfigEvaluate(
+  args?: HookArgsCallback<
+    AutopilotConfigEvaluateParams,
+    AutopilotConfigEvaluatePayload,
+    AutopilotConfigEvaluateResponse
+  >
+) {
+  return usePostFunc({ ...args, route: autopilotConfigRoute })
+}
+
 export function useAutopilotHostsSearch(
   args?: HookArgsWithPayloadSwr<
     AutopilotHostsSearchParams,

libs/renterd-types/src/autopilot.ts

@@ -1,4 +1,9 @@
-import { AutopilotConfig, Host } from './types'
+import {
+  AutopilotConfig,
+  GougingSettings,
+  Host,
+  RedundancySettings,
+} from './types'
 import { HostsSearchPayload, BusStateResponse } from './bus'
 
 export const autopilotStateRoute = '/autopilot/state'
@@ -30,6 +35,34 @@ export type AutopilotConfigUpdateParams = void
 export type AutopilotConfigUpdatePayload = AutopilotConfig
 export type AutopilotConfigUpdateResponse = void
 
+export type ConfigRecommendation = {
+  gougingSettings: GougingSettings
+}
+
+export type AutopilotConfigEvaluateParams = void
+export type AutopilotConfigEvaluatePayload = {
+  autopilotConfig: AutopilotConfig
+  gougingSettings: GougingSettings
+  redundancySettings: RedundancySettings
+}
+export type AutopilotConfigEvaluateResponse = {
+  hosts: number
+  usable: number
+  unusable: {
+    blocked: number
+    gouging: {
+      contract: number
+      download: number
+      gouging: number
+      pruning: number
+      upload: number
+    }
+    notAcceptingContracts: number
+    notScanned: number
+  }
+  recommendation?: ConfigRecommendation
+}
+
 export type AutopilotHost = {
   host: Host
   checks?: {

libs/renterd-types/src/bus.ts

@@ -487,7 +487,7 @@ export type SettingsResponse = string[]
 
 export type SettingParams = { key: string }
 export type SettingPayload = void
-export type SettingResponse<T extends Setting> = T
+export type SettingResponse = Setting
 
 export type SettingUpdateParams = { key: string }
 export type SettingUpdatePayload = Setting

libs/request/src/index.ts

@@ -1,5 +1,6 @@
 import { merge } from '@technically/lodash'
-import axios, {
+import axios from 'axios'
+import type {
   AxiosError,
   AxiosInstance,
   AxiosRequestConfig,