feat(renterd-libs): add patch methods

.changeset/moody-rocks-flow.md

@@ -0,0 +1,7 @@
+---
+'@siafoundation/renterd-js': minor
+'@siafoundation/renterd-react': minor
+'@siafoundation/renterd-types': minor
+---
+
+Add settings gouging, pinned, s3, and upload patch APIs.

libs/renterd-js/src/bus.ts

@@ -256,6 +256,18 @@ import {
   ConsensusNetworkPayload,
   ConsensusNetworkResponse,
   busConsensusNetworkRoute,
+  SettingsGougingPatchParams,
+  SettingsGougingPatchPayload,
+  SettingsGougingPatchResponse,
+  SettingsPinnedPatchParams,
+  SettingsPinnedPatchPayload,
+  SettingsPinnedPatchResponse,
+  SettingsS3PatchParams,
+  SettingsS3PatchPayload,
+  SettingsS3PatchResponse,
+  SettingsUploadPatchParams,
+  SettingsUploadPatchPayload,
+  SettingsUploadPatchResponse,
 } from '@siafoundation/renterd-types'
 import { buildRequestHandler, initAxios } from '@siafoundation/request'
 
@@ -533,6 +545,26 @@ export function Bus({ api, password }: { api: string; password?: string }) {
       SettingsUploadUpdatePayload,
       SettingsUploadUpdateResponse
     >(axios, 'put', busSettingsUploadRoute),
+    settingsGougingPatch: buildRequestHandler<
+      SettingsGougingPatchParams,
+      SettingsGougingPatchPayload,
+      SettingsGougingPatchResponse
+    >(axios, 'patch', busSettingsGougingRoute),
+    settingsPinnedPatch: buildRequestHandler<
+      SettingsPinnedPatchParams,
+      SettingsPinnedPatchPayload,
+      SettingsPinnedPatchResponse
+    >(axios, 'patch', busSettingsPinnedRoute),
+    settingsS3Patch: buildRequestHandler<
+      SettingsS3PatchParams,
+      SettingsS3PatchPayload,
+      SettingsS3PatchResponse
+    >(axios, 'patch', busSettingsS3Route),
+    settingsUploadPatch: buildRequestHandler<
+      SettingsUploadPatchParams,
+      SettingsUploadPatchPayload,
+      SettingsUploadPatchResponse
+    >(axios, 'patch', busSettingsUploadRoute),
     alerts: buildRequestHandler<AlertsParams, AlertsPayload, AlertsResponse>(
       axios,
       'get',

libs/renterd-react/src/autopilot.ts

@@ -56,8 +56,8 @@ export function useAutopilotConfigUpdate(
     { ...args, route: autopilotConfigRoute },
     async (mutate) => {
       mutate((key) => key === autopilotConfigRoute)
-      // might need a delay before revalidating status which returns whether
-      // or not autopilot is configured
+      // Might need a delay before revalidating status which returns whether
+      // or not autopilot is configured.
       const func = async () => {
         await delay(1000)
         mutate((key) => key === autopilotStateRoute)

libs/renterd-react/src/bus.ts

@@ -9,6 +9,7 @@ import {
   HookArgsCallback,
   HookArgsWithPayloadSwr,
   delay,
+  usePatchFunc,
 } from '@siafoundation/react-core'
 import {
   getMainnetBlockHeight,
@@ -239,6 +240,18 @@ import {
   SettingsUploadUpdateParams,
   SettingsUploadUpdatePayload,
   SettingsUploadUpdateResponse,
+  SettingsGougingPatchResponse,
+  SettingsGougingPatchPayload,
+  SettingsGougingPatchParams,
+  SettingsPinnedPatchParams,
+  SettingsPinnedPatchPayload,
+  SettingsPinnedPatchResponse,
+  SettingsS3PatchParams,
+  SettingsS3PatchPayload,
+  SettingsS3PatchResponse,
+  SettingsUploadPatchParams,
+  SettingsUploadPatchPayload,
+  SettingsUploadPatchResponse,
   SettingsPinnedResponse,
   busObjectsRemoveRoute,
   ConsensusNetworkParams,
@@ -833,6 +846,78 @@ export function useSettingsUploadUpdate(
   )
 }
 
+export function useSettingsGougingPatch(
+  args?: HookArgsCallback<
+    SettingsGougingPatchParams,
+    SettingsGougingPatchPayload,
+    SettingsGougingPatchResponse
+  >
+) {
+  return usePatchFunc(
+    {
+      ...args,
+      route: busSettingsGougingRoute,
+    },
+    async (mutate) => {
+      mutate((key) => key.startsWith(busSettingsGougingRoute))
+    }
+  )
+}
+
+export function useSettingsPinnedPatch(
+  args?: HookArgsCallback<
+    SettingsPinnedPatchParams,
+    SettingsPinnedPatchPayload,
+    SettingsPinnedPatchResponse
+  >
+) {
+  return usePatchFunc(
+    {
+      ...args,
+      route: busSettingsPinnedRoute,
+    },
+    async (mutate) => {
+      mutate((key) => key.startsWith(busSettingsPinnedRoute))
+    }
+  )
+}
+
+export function useSettingsS3Patch(
+  args?: HookArgsCallback<
+    SettingsS3PatchParams,
+    SettingsS3PatchPayload,
+    SettingsS3PatchResponse
+  >
+) {
+  return usePatchFunc(
+    {
+      ...args,
+      route: busSettingsS3Route,
+    },
+    async (mutate) => {
+      mutate((key) => key.startsWith(busSettingsS3Route))
+    }
+  )
+}
+
+export function useSettingsUploadPatch(
+  args?: HookArgsCallback<
+    SettingsUploadPatchParams,
+    SettingsUploadPatchPayload,
+    SettingsUploadPatchResponse
+  >
+) {
+  return usePatchFunc(
+    {
+      ...args,
+      route: busSettingsUploadRoute,
+    },
+    async (mutate) => {
+      mutate((key) => key.startsWith(busSettingsUploadRoute))
+    }
+  )
+}
+
 // params are required because omitting them returns a deprecated response structure
 export function useAlerts(args?: HookArgsSwr<AlertsParams, AlertsResponse>) {
   return useGetSwr({ ...args, route: busAlertsRoute })

libs/renterd-types/src/bus.ts

@@ -23,6 +23,7 @@ import {
   SettingsUpload,
   SlabSlice,
 } from './types'
+import { DeepPartial } from './utils'
 
 export const busStateRoute = '/bus/state'
 export const busAutopilotsRoute = '/bus/autopilots'
@@ -685,3 +686,19 @@ export type SettingsS3UpdateResponse = void
 export type SettingsUploadUpdateParams = void
 export type SettingsUploadUpdatePayload = SettingsUpload
 export type SettingsUploadUpdateResponse = void
+
+export type SettingsGougingPatchParams = void
+export type SettingsGougingPatchPayload = DeepPartial<SettingsGouging>
+export type SettingsGougingPatchResponse = SettingsGouging
+
+export type SettingsPinnedPatchParams = void
+export type SettingsPinnedPatchPayload = DeepPartial<SettingsPinned>
+export type SettingsPinnedPatchResponse = SettingsPinned
+
+export type SettingsS3PatchParams = void
+export type SettingsS3PatchPayload = DeepPartial<SettingsS3>
+export type SettingsS3PatchResponse = SettingsS3
+
+export type SettingsUploadPatchParams = void
+export type SettingsUploadPatchPayload = DeepPartial<SettingsUpload>
+export type SettingsUploadPatchResponse = SettingsUpload

libs/renterd-types/src/utils.ts

@@ -0,0 +1,3 @@
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object | undefined ? DeepPartial<T[P]> : T[P]
+}