@seamapi/react 2.20.0 → 3.0.1

package/src/lib/seam/thermostats/climate-setting-schedules/use-create-climate-setting-schedule.ts

@@ -1,48 +1,53 @@
+import type {
+  SeamHttpApiError,
+  ThermostatsClimateSettingSchedulesCreateBody,
+} from '@seamapi/http/connect'
+import type { ClimateSettingSchedule } from '@seamapi/types/connect'
 import {
   useMutation,
   type UseMutationResult,
   useQueryClient,
 } from '@tanstack/react-query'
-import type {
-  ClimateSettingSchedule,
-  ClimateSettingScheduleCreateRequest,
-  ClimateSettingScheduleCreateResponse,
-  SeamError,
-} from 'seamapi'
 
 import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
+export type UseCreateClimateSettingScheduleParams = never
+
 export type UseCreateClimateSettingScheduleData = ClimateSettingSchedule
-export type UseCreateClimateSettingScheduleMutationParams =
-  ClimateSettingScheduleCreateRequest
+
+export type UseCreateClimateSettingScheduleMutationVariables =
+  ThermostatsClimateSettingSchedulesCreateBody
 
 export function useCreateClimateSettingSchedule(): UseMutationResult<
   UseCreateClimateSettingScheduleData,
-  SeamError,
-  UseCreateClimateSettingScheduleMutationParams
+  SeamHttpApiError,
+  UseCreateClimateSettingScheduleMutationVariables
 > {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 
   return useMutation<
-    ClimateSettingScheduleCreateResponse['climate_setting_schedule'],
-    SeamError,
-    ClimateSettingScheduleCreateRequest
+    UseCreateClimateSettingScheduleData,
+    SeamHttpApiError,
+    UseCreateClimateSettingScheduleMutationVariables
   >({
-    mutationFn: async (
-      mutationParams: UseCreateClimateSettingScheduleMutationParams
-    ) => {
+    mutationFn: async (variables) => {
       if (client === null) throw new NullSeamClientError()
-      return await client.thermostats.climateSettingSchedules.create(
-        mutationParams
-      )
+      return await client.thermostats.climateSettingSchedules.create(variables)
     },
-    onSuccess: () => {
-      void queryClient.invalidateQueries([
-        'thermostats',
-        'climate_setting_schedules',
-        'list',
-      ])
+    onSuccess: (data) => {
+      queryClient.setQueryData(
+        [
+          'thermostats',
+          'climate_setting_schedules',
+          'get',
+          { climate_setting_schedules: data.climate_setting_schedule_id },
+        ],
+        data
+      )
+      void queryClient.invalidateQueries({
+        queryKey: ['thermostats', 'climate_setting_schedules', 'list'],
+      })
     },
   })
 }

package/src/lib/seam/thermostats/climate-setting-schedules/use-delete-climate-setting-schedule.ts

@@ -1,53 +1,51 @@
+import type {
+  SeamHttpApiError,
+  ThermostatsClimateSettingSchedulesDeleteParams,
+} from '@seamapi/http/connect'
 import {
   useMutation,
   type UseMutationResult,
   useQueryClient,
 } from '@tanstack/react-query'
-import type {
-  ClimateSettingScheduleDeleteRequest,
-  ClimateSettingScheduleDeleteResponse,
-  SeamError,
-} from 'seamapi'
 
 import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
-export type UseDeleteClimateSettingScheduleMutationParams =
-  ClimateSettingScheduleDeleteRequest
+export type UseDeleteClimateSettingScheduleParams = never
+
+export type UseDeleteClimateSettingScheduleData = undefined
 
-export type UseDeleteClimateSettingScheduleData =
-  ClimateSettingScheduleDeleteResponse
+export type UseDeleteClimateSettingScheduleMutationVariables =
+  ThermostatsClimateSettingSchedulesDeleteParams
 
 export function useDeleteClimateSettingSchedule(): UseMutationResult<
   UseDeleteClimateSettingScheduleData,
-  SeamError,
-  UseDeleteClimateSettingScheduleMutationParams
+  SeamHttpApiError,
+  UseDeleteClimateSettingScheduleMutationVariables
 > {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 
   return useMutation<
     UseDeleteClimateSettingScheduleData,
-    SeamError,
-    ClimateSettingScheduleDeleteRequest
+    SeamHttpApiError,
+    UseDeleteClimateSettingScheduleMutationVariables
   >({
-    mutationFn: async (
-      mutationParams: UseDeleteClimateSettingScheduleMutationParams
-    ) => {
+    mutationFn: async (variables) => {
       if (client === null) throw new NullSeamClientError()
-      await client.thermostats.climateSettingSchedules.delete(mutationParams)
+      await client.thermostats.climateSettingSchedules.delete(variables)
     },
     onSuccess: (_data, variables) => {
-      void queryClient.invalidateQueries([
-        'thermostats',
-        'climate_setting_schedules',
-        'get',
-        { climate_setting_schedule_id: variables.climate_setting_schedule_id },
-      ])
-      void queryClient.invalidateQueries([
-        'thermostats',
-        'climate_setting_schedules',
-        'list',
-      ])
+      void queryClient.invalidateQueries({
+        queryKey: [
+          'thermostats',
+          'climate_setting_schedules',
+          'get',
+          { climate_setting_schedules: variables.climate_setting_schedule_id },
+        ],
+      })
+      void queryClient.invalidateQueries({
+        queryKey: ['thermostats', 'climate_setting_schedules', 'list'],
+      })
     },
   })
 }

package/src/lib/seam/thermostats/climate-setting-schedules/use-update-climate-setting-schedule.ts

@@ -1,53 +1,48 @@
+import type {
+  SeamHttpApiError,
+  ThermostatsClimateSettingSchedulesUpdateBody,
+} from '@seamapi/http/connect'
+import type { ClimateSettingSchedule } from '@seamapi/types/connect'
 import {
   useMutation,
   type UseMutationResult,
   useQueryClient,
 } from '@tanstack/react-query'
-import type {
-  ClimateSettingSchedule,
-  ClimateSettingSchedulesListResponse,
-  ClimateSettingScheduleUpdateRequest,
-  ClimateSettingScheduleUpdateResponse,
-  SeamError,
-} from 'seamapi'
 
-import { NullSeamClientError, useSeamClient } from 'lib/index.js'
+import { shake } from 'lib/object.js'
+import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
+
+export type UseUpdateClimateSettingScheduleParams = never
 
-type UseUpdateClimateSettingScheduleData =
-  ClimateSettingScheduleUpdateResponse['climate_setting_schedule']
-type UseUpdateClimateSettingScheduleMutationParams =
-  ClimateSettingScheduleUpdateRequest
+export type UseUpdateClimateSettingScheduleData = undefined
+
+export type UseUpdateClimateSettingScheduleMutationVariables =
+  ThermostatsClimateSettingSchedulesUpdateBody
 
 export function useUpdateClimateSettingSchedule(): UseMutationResult<
   UseUpdateClimateSettingScheduleData,
-  SeamError,
-  UseUpdateClimateSettingScheduleMutationParams
+  SeamHttpApiError,
+  UseUpdateClimateSettingScheduleMutationVariables
 > {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 
   return useMutation<
     UseUpdateClimateSettingScheduleData,
-    SeamError,
-    UseUpdateClimateSettingScheduleMutationParams
+    SeamHttpApiError,
+    UseUpdateClimateSettingScheduleMutationVariables
   >({
-    mutationFn: async (
-      mutationPararms: UseUpdateClimateSettingScheduleMutationParams
-    ) => {
+    mutationFn: async (variables) => {
       if (client === null) throw new NullSeamClientError()
-      return await client.thermostats.climateSettingSchedules.update(
-        mutationPararms
-      )
+      await client.thermostats.climateSettingSchedules.update(variables)
     },
-    onSuccess: (updated) => {
-      queryClient.setQueryData<ClimateSettingSchedule>(
+    onSuccess: (_data, variables) => {
+      queryClient.setQueryData<ClimateSettingSchedule | null>(
         [
           'thermostats',
           'climate_setting_schedules',
           'get',
-          {
-            climate_setting_schedule_id: updated.climate_setting_schedule_id,
-          },
+          { climate_setting_schedules: variables.climate_setting_schedule_id },
         ],
         (climateSettingSchedule) => {
           if (climateSettingSchedule == null) {
@@ -56,30 +51,26 @@ export function useUpdateClimateSettingSchedule(): UseMutationResult<
 
           return {
             ...climateSettingSchedule,
-            ...updated,
+            ...shake(variables),
           }
         }
       )
 
-      queryClient.setQueryData<
-        ClimateSettingSchedulesListResponse['climate_setting_schedules']
-      >(
-        [
-          'thermostats',
-          'climate_setting_schedules',
-          'list',
-          { device_id: updated.device_id },
-        ],
-        (climateSettingSchedules): ClimateSettingSchedule[] => {
+      queryClient.setQueryData<ClimateSettingSchedule[]>(
+        ['thermostats', 'climate_setting_schedules', 'list'],
+        (climateSettingSchedules) => {
           if (climateSettingSchedules == null) {
-            return []
+            return climateSettingSchedules
           }
 
           return climateSettingSchedules.map((climateSettingSchedule) => {
-            if (climateSettingSchedule.device_id === updated.device_id) {
+            if (
+              climateSettingSchedule.climate_setting_schedule_id ===
+              variables.climate_setting_schedule_id
+            ) {
               return {
                 ...climateSettingSchedule,
-                ...updated,
+                ...shake(variables),
               }
             }
 

package/src/lib/{temperature-bounds.ts → seam/thermostats/temperature-bounds.ts}

@@ -1,4 +1,7 @@
-import type { HvacModeSetting, ThermostatDevice } from 'seamapi'
+import type {
+  HvacModeSetting,
+  ThermostatDevice,
+} from 'lib/seam/thermostats/thermostat-device.js'
 
 export interface ControlBounds {
   mode: Exclude<HvacModeSetting, 'off'>
@@ -60,13 +63,13 @@ export const getSupportedThermostatModes = (
   return allModes.filter((mode) => {
     switch (mode) {
       case 'cool':
-        return device.properties.is_cooling_available
+        return device.properties.is_cooling_available ?? false
       case 'heat':
-        return device.properties.is_heating_available
+        return device.properties.is_heating_available ?? false
       case 'heat_cool':
         return (
-          device.properties.is_heating_available &&
-          device.properties.is_cooling_available
+          (device.properties.is_heating_available ?? false) &&
+          (device.properties.is_cooling_available ?? false)
         )
       default:
         return true

package/src/lib/seam/thermostats/thermostat-device.ts

@@ -0,0 +1,43 @@
+import type { Device } from '@seamapi/types/connect'
+
+export type ThermostatDevice = Omit<Device, 'properties'> & {
+  properties: Device['properties'] &
+    Required<
+      Pick<
+        Device['properties'],
+        | 'temperature_celsius'
+        | 'temperature_fahrenheit'
+        | 'is_heating'
+        | 'is_cooling'
+        | 'is_fan_running'
+        | 'is_cooling_available'
+        | 'is_heating_available'
+        | 'available_hvac_mode_settings'
+        | 'fan_mode_setting'
+        | 'current_climate_setting'
+      >
+    >
+}
+
+// UPSTREAM: FanModeSetting missing in @seamapi/types.
+export type FanModeSetting = ThermostatDevice['properties']['fan_mode_setting']
+
+// UPSTREAM: HvacModeSetting missing in @seamapi/types.
+export type HvacModeSetting =
+  ThermostatDevice['properties']['available_hvac_mode_settings'][number]
+
+// UPSTREAM: ClimateSetting missing in @seamapi/types.
+export interface ClimateSetting {
+  automatic_heating_enabled?: boolean
+  automatic_cooling_enabled?: boolean
+  hvac_mode_setting?: HvacModeSetting
+  cooling_set_point_celsius?: number
+  heating_set_point_celsius?: number
+  cooling_set_point_fahrenheit?: number
+  heating_set_point_fahrenheit?: number
+  manual_override_allowed?: boolean
+}
+
+export const isThermostatDevice = (
+  device: Device
+): device is ThermostatDevice => 'is_fan_running' in device.properties

package/src/lib/seam/thermostats/unit-conversion.ts

@@ -0,0 +1,89 @@
+import type { Device } from '@seamapi/types/connect'
+
+export const celsiusToFahrenheit = (t: number): number => (t * 9) / 5 + 32
+
+export const fahrenheitToCelsius = (t: number): number => (t - 32) * (5 / 9)
+
+export const getCoolingSetPointCelsius = (
+  variables: {
+    cooling_set_point_celsius?: number
+    cooling_set_point_fahrenheit?: number
+  },
+  device: Device
+): number | undefined => {
+  if (variables.cooling_set_point_celsius != null) {
+    return variables.cooling_set_point_celsius
+  }
+
+  if (variables.cooling_set_point_fahrenheit != null) {
+    return fahrenheitToCelsius(variables.cooling_set_point_fahrenheit)
+  }
+
+  return (
+    device.properties.current_climate_setting?.cooling_set_point_celsius ??
+    undefined
+  )
+}
+
+export const getCoolingSetPointFahrenheit = (
+  variables: {
+    cooling_set_point_celsius?: number
+    cooling_set_point_fahrenheit?: number
+  },
+  device: Device
+): number | undefined => {
+  if (variables.cooling_set_point_fahrenheit != null) {
+    return variables.cooling_set_point_fahrenheit
+  }
+
+  if (variables.cooling_set_point_celsius != null) {
+    return celsiusToFahrenheit(variables.cooling_set_point_celsius)
+  }
+
+  return (
+    device.properties.current_climate_setting?.cooling_set_point_fahrenheit ??
+    undefined
+  )
+}
+
+export const getHeatingSetPointCelsius = (
+  variables: {
+    heating_set_point_celsius?: number
+    heating_set_point_fahrenheit?: number
+  },
+  device: Device
+): number | undefined => {
+  if (variables.heating_set_point_celsius != null) {
+    return variables.heating_set_point_celsius
+  }
+
+  if (variables.heating_set_point_fahrenheit != null) {
+    return fahrenheitToCelsius(variables.heating_set_point_fahrenheit)
+  }
+
+  return (
+    device.properties.current_climate_setting?.heating_set_point_celsius ??
+    undefined
+  )
+}
+
+export const getHeatingSetPointFahrenheit = (
+  variables: {
+    heating_set_point_celsius?: number
+    heating_set_point_fahrenheit?: number
+  },
+  device: Device
+): number | undefined => {
+  if (variables.heating_set_point_fahrenheit != null) {
+    return variables.heating_set_point_fahrenheit
+  }
+
+  if (variables.heating_set_point_celsius != null) {
+    return celsiusToFahrenheit(variables.heating_set_point_celsius)
+  }
+
+  return (
+    device.properties.current_climate_setting?.heating_set_point_fahrenheit ??
+    undefined
+  )
+}

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

@@ -1,64 +1,82 @@
+import type {
+  SeamActionAttemptFailedError,
+  SeamActionAttemptTimeoutError,
+  SeamHttpApiError,
+  ThermostatsCoolBody,
+} from '@seamapi/http/connect'
+import type { ActionAttempt, Device } from '@seamapi/types/connect'
 import {
   useMutation,
   type UseMutationResult,
   useQueryClient,
 } from '@tanstack/react-query'
-import type {
-  SeamError,
-  ThermostatCoolRequest,
-  ThermostatDevice,
-  ThermostatsListResponse,
-} from 'seamapi'
 
+import {
+  getCoolingSetPointCelsius,
+  getCoolingSetPointFahrenheit,
+} from 'lib/seam/thermostats/unit-conversion.js'
 import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
-// UPSTREAM: Missing ThermostatCoolResponse in seamapi.
-type UseCoolThermostatData = Record<string, unknown>
-type UseCoolThermostatMutationParams = ThermostatCoolRequest
+export type UseCoolThermostatParams = never
+
+export type UseCoolThermostatData = undefined
+
+export type UseCoolThermostatMutationVariables = Pick<
+  ThermostatsCoolBody,
+  'device_id' | 'cooling_set_point_celsius' | 'cooling_set_point_fahrenheit'
+>
+
+type CoolThermostatActionAttempt = Extract<
+  ActionAttempt,
+  { action_type: 'SET_COOL' }
+>
+
+type MutationError =
+  | SeamHttpApiError
+  | SeamActionAttemptFailedError<CoolThermostatActionAttempt>
+  | SeamActionAttemptTimeoutError<CoolThermostatActionAttempt>
 
 export function useCoolThermostat(): UseMutationResult<
   UseCoolThermostatData,
-  SeamError,
-  UseCoolThermostatMutationParams
+  MutationError,
+  UseCoolThermostatMutationVariables
 > {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 
   return useMutation<
     UseCoolThermostatData,
-    SeamError,
-    UseCoolThermostatMutationParams
+    MutationError,
+    UseCoolThermostatMutationVariables
   >({
-    mutationFn: async (mutationParams: UseCoolThermostatMutationParams) => {
+    mutationFn: async (variables) => {
       if (client === null) throw new NullSeamClientError()
-
-      return await client.thermostats.cool(mutationParams)
+      await client.thermostats.cool(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 useCoolThermostat(): UseMutationResult<
   })
 }
 
-function getUpdatedThermostat(
-  thermostat: ThermostatDevice,
-  variables: UseCoolThermostatMutationParams
-): ThermostatDevice {
-  return {
-    ...thermostat,
-    properties: {
-      ...thermostat.properties,
-      current_climate_setting: {
-        ...thermostat.properties.current_climate_setting,
-        cooling_set_point_fahrenheit:
-          variables.cooling_set_point_fahrenheit ??
-          thermostat.properties.current_climate_setting
-            .cooling_set_point_fahrenheit,
-        cooling_set_point_celsius:
-          variables.cooling_set_point_celsius ??
-          thermostat.properties.current_climate_setting
-            .cooling_set_point_celsius,
+const getUpdatedDevice = (
+  device: Device,
+  variables: UseCoolThermostatMutationVariables
+): 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: 'cool',
+          automatic_heating_enabled: false,
+          automatic_cooling_enabled: true,
+          heating_set_point_celsius: undefined,
+          heating_set_point_fahrenheit: undefined,
+          cooling_set_point_celsius: getCoolingSetPointCelsius(
+            variables,
+            device
+          ),
+          cooling_set_point_fahrenheit: getCoolingSetPointFahrenheit(
+            variables,
+            device
+          ),
+        },
       },
-    },
+    }
   }
+  return device
 }