@seamapi/react 2.20.0 → 3.0.0-beta.1

package/src/lib/seam/thermostats/use-heat-cool-thermostat.ts

@@ -1,64 +1,88 @@
+import type {
+  SeamActionAttemptFailedError,
+  SeamActionAttemptTimeoutError,
+  SeamHttpApiError,
+  ThermostatsHeatCoolBody,
+} from '@seamapi/http/connect'
+import type { ActionAttempt, Device } from '@seamapi/types/connect'
 import {
   useMutation,
   type UseMutationResult,
   useQueryClient,
 } from '@tanstack/react-query'
-import type {
-  SeamError,
-  ThermostatDevice,
-  ThermostatHeatCoolRequest,
-  ThermostatsListResponse,
-} from 'seamapi'
 
+import {
+  getCoolingSetPointCelsius,
+  getCoolingSetPointFahrenheit,
+  getHeatingSetPointCelsius,
+  getHeatingSetPointFahrenheit,
+} from 'lib/seam/thermostats/unit-conversion.js'
 import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
-// UPSTREAM: Missing ThermostatHeatCoolResponse in seamapi.
-type UseHeatCoolThermostatData = Record<string, unknown>
-type UseHeatCoolThermostatMutationParams = ThermostatHeatCoolRequest
+export type UseHeatCoolThermostatParams = never
+
+export type UseHeatCoolThermostatData = undefined
+
+export type UseHeatCoolThermostatMutationVariables = Pick<
+  ThermostatsHeatCoolBody,
+  | 'device_id'
+  | 'heating_set_point_celsius'
+  | 'heating_set_point_fahrenheit'
+  | 'cooling_set_point_celsius'
+  | 'cooling_set_point_fahrenheit'
+>
+
+type HeatCoolThermostatActionAttempt = Extract<
+  ActionAttempt,
+  { action_type: 'SET_HEAT_COOL' }
+>
+
+type MutationError =
+  | SeamHttpApiError
+  | SeamActionAttemptFailedError<HeatCoolThermostatActionAttempt>
+  | SeamActionAttemptTimeoutError<HeatCoolThermostatActionAttempt>
 
 export function useHeatCoolThermostat(): UseMutationResult<
   UseHeatCoolThermostatData,
-  SeamError,
-  UseHeatCoolThermostatMutationParams
+  MutationError,
+  UseHeatCoolThermostatMutationVariables
 > {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 
   return useMutation<
     UseHeatCoolThermostatData,
-    SeamError,
-    UseHeatCoolThermostatMutationParams
+    MutationError,
+    UseHeatCoolThermostatMutationVariables
   >({
-    mutationFn: async (mutationParams: UseHeatCoolThermostatMutationParams) => {
+    mutationFn: async (variables) => {
       if (client === null) throw new NullSeamClientError()
-
-      return await client.thermostats.heatCool(mutationParams)
+      await client.thermostats.heatCool(variables)
     },
     onSuccess: (_data, variables) => {
-      queryClient.setQueryData<ThermostatDevice | null>(
+      queryClient.setQueryData<Device | null>(
         ['devices', 'get', { device_id: variables.device_id }],
-        (thermostat) => {
-          if (thermostat == null) {
+        (device) => {
+          if (device == null) {
             return
           }
-
-          return getUpdatedThermostat(thermostat, variables)
+          return getUpdatedDevice(device, variables)
         }
       )
 
-      queryClient.setQueryData<ThermostatsListResponse['thermostats']>(
+      queryClient.setQueryData<Device[]>(
         ['devices', 'list', { device_id: variables.device_id }],
-        (thermostats): ThermostatDevice[] => {
-          if (thermostats == null) {
+        (devices): Device[] => {
+          if (devices == null) {
             return []
           }
 
-          return thermostats.map((thermostat) => {
-            if (thermostat.device_id === variables.device_id) {
-              return getUpdatedThermostat(thermostat, variables)
+          return devices.map((device) => {
+            if (device.device_id === variables.device_id) {
+              return getUpdatedDevice(device, variables)
             }
 
-            return thermostat
+            return device
           })
         }
       )
@@ -66,18 +90,43 @@ export function useHeatCoolThermostat(): UseMutationResult<
   })
 }
 
-function getUpdatedThermostat(
-  thermostat: ThermostatDevice,
-  variables: UseHeatCoolThermostatMutationParams
-): ThermostatDevice {
-  return {
-    ...thermostat,
-    properties: {
-      ...thermostat.properties,
-      current_climate_setting: {
-        ...thermostat.properties.current_climate_setting,
-        ...variables,
+const getUpdatedDevice = (
+  device: Device,
+  variables: UseHeatCoolThermostatMutationVariables
+): Device => {
+  const { properties } = device
+  if (
+    'current_climate_setting' in properties &&
+    properties.current_climate_setting != null
+  ) {
+    return {
+      ...device,
+      properties: {
+        ...properties,
+        current_climate_setting: {
+          ...properties.current_climate_setting,
+          hvac_mode_setting: 'heat_cool',
+          automatic_heating_enabled: true,
+          automatic_cooling_enabled: true,
+          heating_set_point_celsius: getHeatingSetPointCelsius(
+            variables,
+            device
+          ),
+          heating_set_point_fahrenheit: getHeatingSetPointFahrenheit(
+            variables,
+            device
+          ),
+          cooling_set_point_celsius: getCoolingSetPointCelsius(
+            variables,
+            device
+          ),
+          cooling_set_point_fahrenheit: getCoolingSetPointFahrenheit(
+            variables,
+            device
+          ),
+        },
       },
-    },
+    }
   }
+  return device
 }

package/src/lib/seam/thermostats/use-heat-thermostat.ts

@@ -1,64 +1,82 @@
+import type {
+  SeamActionAttemptFailedError,
+  SeamActionAttemptTimeoutError,
+  SeamHttpApiError,
+  ThermostatsHeatBody,
+} from '@seamapi/http/connect'
+import type { ActionAttempt, Device } from '@seamapi/types/connect'
 import {
   useMutation,
   type UseMutationResult,
   useQueryClient,
 } from '@tanstack/react-query'
-import type {
-  SeamError,
-  ThermostatDevice,
-  ThermostatHeatRequest,
-  ThermostatsListResponse,
-} from 'seamapi'
 
+import {
+  getHeatingSetPointCelsius,
+  getHeatingSetPointFahrenheit,
+} from 'lib/seam/thermostats/unit-conversion.js'
 import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
-// UPSTREAM: Missing ThermostatHeatResponse in seamapi.
-type UseHeatThermostatData = Record<string, unknown>
-type UseHeatThermostatMutationParams = ThermostatHeatRequest
+export type UseHeatThermostatParams = never
+
+export type UseHeatThermostatData = undefined
+
+export type UseHeatThermostatMutationVariables = Pick<
+  ThermostatsHeatBody,
+  'device_id' | 'heating_set_point_celsius' | 'heating_set_point_fahrenheit'
+>
+
+type HeatThermostatActionAttempt = Extract<
+  ActionAttempt,
+  { action_type: 'SET_HEAT' }
+>
+
+type MutationError =
+  | SeamHttpApiError
+  | SeamActionAttemptFailedError<HeatThermostatActionAttempt>
+  | SeamActionAttemptTimeoutError<HeatThermostatActionAttempt>
 
 export function useHeatThermostat(): UseMutationResult<
   UseHeatThermostatData,
-  SeamError,
-  UseHeatThermostatMutationParams
+  MutationError,
+  UseHeatThermostatMutationVariables
 > {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 
   return useMutation<
     UseHeatThermostatData,
-    SeamError,
-    UseHeatThermostatMutationParams
+    MutationError,
+    UseHeatThermostatMutationVariables
   >({
-    mutationFn: async (mutationParams: UseHeatThermostatMutationParams) => {
+    mutationFn: async (variables) => {
       if (client === null) throw new NullSeamClientError()
-
-      return await client.thermostats.heat(mutationParams)
+      await client.thermostats.heat(variables)
     },
     onSuccess: (_data, variables) => {
-      queryClient.setQueryData<ThermostatDevice | null>(
+      queryClient.setQueryData<Device | null>(
         ['devices', 'get', { device_id: variables.device_id }],
-        (thermostat) => {
-          if (thermostat == null) {
+        (device) => {
+          if (device == null) {
             return
           }
-
-          return getUpdatedThermostat(thermostat, variables)
+          return getUpdatedDevice(device, variables)
         }
       )
 
-      queryClient.setQueryData<ThermostatsListResponse['thermostats']>(
+      queryClient.setQueryData<Device[]>(
         ['devices', 'list', { device_id: variables.device_id }],
-        (thermostats): ThermostatDevice[] => {
-          if (thermostats == null) {
+        (devices): Device[] => {
+          if (devices == null) {
             return []
           }
 
-          return thermostats.map((thermostat) => {
-            if (thermostat.device_id === variables.device_id) {
-              return getUpdatedThermostat(thermostat, variables)
+          return devices.map((device) => {
+            if (device.device_id === variables.device_id) {
+              return getUpdatedDevice(device, variables)
             }
 
-            return thermostat
+            return device
           })
         }
       )
@@ -66,25 +84,37 @@ export function useHeatThermostat(): UseMutationResult<
   })
 }
 
-function getUpdatedThermostat(
-  thermostat: ThermostatDevice,
-  variables: UseHeatThermostatMutationParams
-): ThermostatDevice {
-  return {
-    ...thermostat,
-    properties: {
-      ...thermostat.properties,
-      current_climate_setting: {
-        ...thermostat.properties.current_climate_setting,
-        heating_set_point_fahrenheit:
-          variables.heating_set_point_fahrenheit ??
-          thermostat.properties.current_climate_setting
-            .heating_set_point_fahrenheit,
-        heating_set_point_celsius:
-          variables.heating_set_point_celsius ??
-          thermostat.properties.current_climate_setting
-            .heating_set_point_celsius,
+const getUpdatedDevice = (
+  device: Device,
+  variables: UseHeatThermostatMutationVariables
+): Device => {
+  const { properties } = device
+  if (
+    'current_climate_setting' in properties &&
+    properties.current_climate_setting != null
+  ) {
+    return {
+      ...device,
+      properties: {
+        ...properties,
+        current_climate_setting: {
+          ...properties.current_climate_setting,
+          hvac_mode_setting: 'heat',
+          automatic_heating_enabled: true,
+          automatic_cooling_enabled: false,
+          cooling_set_point_celsius: undefined,
+          cooling_set_point_fahrenheit: undefined,
+          heating_set_point_celsius: getHeatingSetPointCelsius(
+            variables,
+            device
+          ),
+          heating_set_point_fahrenheit: getHeatingSetPointFahrenheit(
+            variables,
+            device
+          ),
+        },
       },
-    },
+    }
   }
+  return device
 }

package/src/lib/seam/thermostats/use-set-thermostat-fan-mode.ts

@@ -0,0 +1,95 @@
+import type {
+  SeamActionAttemptFailedError,
+  SeamActionAttemptTimeoutError,
+  SeamHttpApiError,
+  ThermostatsSetFanModeBody,
+} from '@seamapi/http/connect'
+import type { ActionAttempt, Device } from '@seamapi/types/connect'
+import {
+  useMutation,
+  type UseMutationResult,
+  useQueryClient,
+} from '@tanstack/react-query'
+
+import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
+
+export type UseSetThermostatFanModeParams = never
+
+export type UseSetThermostatFanModeData = undefined
+
+export type UseSetThermostatFanModeMutationVariables = ThermostatsSetFanModeBody
+
+type SetThermostatFanModeActionAttempt = Extract<
+  ActionAttempt,
+  { action_type: 'SET_FAN_MODE' }
+>
+
+type MutationError =
+  | SeamHttpApiError
+  | SeamActionAttemptFailedError<SetThermostatFanModeActionAttempt>
+  | SeamActionAttemptTimeoutError<SetThermostatFanModeActionAttempt>
+
+export function useSetThermostatFanMode(): UseMutationResult<
+  UseSetThermostatFanModeData,
+  MutationError,
+  UseSetThermostatFanModeMutationVariables
+> {
+  const { client } = useSeamClient()
+  const queryClient = useQueryClient()
+
+  return useMutation<
+    UseSetThermostatFanModeData,
+    MutationError,
+    UseSetThermostatFanModeMutationVariables
+  >({
+    mutationFn: async (variables) => {
+      if (client === null) throw new NullSeamClientError()
+      await client.thermostats.setFanMode(variables)
+    },
+    onSuccess: (_data, variables) => {
+      queryClient.setQueryData<Device | null>(
+        ['devices', 'get', { device_id: variables.device_id }],
+        (device) => {
+          if (device == null) {
+            return
+          }
+          return getUpdatedDevice(device, variables)
+        }
+      )
+
+      queryClient.setQueryData<Device[]>(
+        ['devices', 'list', { device_id: variables.device_id }],
+        (devices): Device[] => {
+          if (devices == null) {
+            return []
+          }
+
+          return devices.map((device) => {
+            if (device.device_id === variables.device_id) {
+              return getUpdatedDevice(device, variables)
+            }
+
+            return device
+          })
+        }
+      )
+    },
+  })
+}
+
+const getUpdatedDevice = (
+  device: Device,
+  variables: UseSetThermostatFanModeMutationVariables
+): Device => {
+  const { properties } = device
+  if ('fan_mode_setting' in properties && properties.fan_mode_setting != null) {
+    return {
+      ...device,
+      properties: {
+        ...properties,
+        fan_mode_setting: variables.fan_mode_setting,
+      },
+    }
+  }
+  return device
+}

package/src/lib/seam/thermostats/use-set-thermostat-off.ts

@@ -1,64 +1,75 @@
+import type {
+  SeamActionAttemptFailedError,
+  SeamActionAttemptTimeoutError,
+  SeamHttpApiError,
+  ThermostatsOffBody,
+} from '@seamapi/http/connect'
+import type { ActionAttempt, Device } from '@seamapi/types/connect'
 import {
   useMutation,
   type UseMutationResult,
   useQueryClient,
 } from '@tanstack/react-query'
-import type {
-  SeamError,
-  ThermostatDevice,
-  ThermostatOffRequest,
-  ThermostatsListResponse,
-} from 'seamapi'
 
 import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
-// UPSTREAM: Missing ThermostatOffResponse in seamapi.
-type UseSetThermostatOffData = Record<string, unknown>
-type UseSetThermostatOffMutationParams = ThermostatOffRequest
+export type UseSetThermostatOffParams = never
+
+export type UseSetThermostatOffData = undefined
+
+export type UseSetThermostatOffMutationVariables = ThermostatsOffBody
+
+type SetThermostatOffActionAttempt = Extract<
+  ActionAttempt,
+  { action_type: 'SET_THERMOSTAT_OFF' }
+>
+
+type MutationError =
+  | SeamHttpApiError
+  | SeamActionAttemptFailedError<SetThermostatOffActionAttempt>
+  | SeamActionAttemptTimeoutError<SetThermostatOffActionAttempt>
 
 export function useSetThermostatOff(): UseMutationResult<
   UseSetThermostatOffData,
-  SeamError,
-  UseSetThermostatOffMutationParams
+  MutationError,
+  UseSetThermostatOffMutationVariables
 > {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 
   return useMutation<
     UseSetThermostatOffData,
-    SeamError,
-    UseSetThermostatOffMutationParams
+    MutationError,
+    UseSetThermostatOffMutationVariables
   >({
-    mutationFn: async (mutationParams: UseSetThermostatOffMutationParams) => {
+    mutationFn: async (variables) => {
       if (client === null) throw new NullSeamClientError()
-
-      return await client.thermostats.off(mutationParams)
+      await client.thermostats.off(variables)
     },
     onSuccess: (_data, variables) => {
-      queryClient.setQueryData<ThermostatDevice | null>(
+      queryClient.setQueryData<Device | null>(
         ['devices', 'get', { device_id: variables.device_id }],
-        (thermostat) => {
-          if (thermostat == null) {
+        (device) => {
+          if (device == null) {
             return
           }
-
-          return getUpdatedThermostat(thermostat)
+          return getUpdatedDevice(device)
         }
       )
 
-      queryClient.setQueryData<ThermostatsListResponse['thermostats']>(
+      queryClient.setQueryData<Device[]>(
         ['devices', 'list', { device_id: variables.device_id }],
-        (thermostats): ThermostatDevice[] => {
-          if (thermostats == null) {
+        (devices): Device[] => {
+          if (devices == null) {
             return []
           }
 
-          return thermostats.map((thermostat) => {
-            if (thermostat.device_id === variables.device_id) {
-              return getUpdatedThermostat(thermostat)
+          return devices.map((device) => {
+            if (device.device_id === variables.device_id) {
+              return getUpdatedDevice(device)
             }
 
-            return thermostat
+            return device
           })
         }
       )
@@ -66,18 +77,31 @@ export function useSetThermostatOff(): UseMutationResult<
   })
 }
 
-function getUpdatedThermostat(thermostat: ThermostatDevice): ThermostatDevice {
-  return {
-    ...thermostat,
-    properties: {
-      ...thermostat.properties,
-      is_fan_running: false,
-      current_climate_setting: {
-        ...thermostat.properties.current_climate_setting,
-        automatic_cooling_enabled: false,
-        automatic_heating_enabled: false,
-        hvac_mode_setting: 'off',
+const getUpdatedDevice = (device: Device): Device => {
+  const { properties } = device
+  if (
+    'current_climate_setting' in properties &&
+    properties.current_climate_setting != null
+  ) {
+    return {
+      ...device,
+      properties: {
+        ...properties,
+        is_fan_running: false,
+        is_cooling: false,
+        is_heating: false,
+        current_climate_setting: {
+          ...properties.current_climate_setting,
+          automatic_cooling_enabled: false,
+          automatic_heating_enabled: false,
+          hvac_mode_setting: 'off',
+          heating_set_point_celsius: undefined,
+          heating_set_point_fahrenheit: undefined,
+          cooling_set_point_celsius: undefined,
+          cooling_set_point_fahrenheit: undefined,
+        },
       },
-    },
+    }
   }
+  return device
 }