@seamapi/react 1.35.0 → 1.37.0

package/src/lib/seam/components/DeviceTable/DeviceTable.tsx

@@ -34,6 +34,7 @@ export interface DeviceTableProps {
   onDeviceClick?: (deviceId: string) => void
   preventDefaultOnDeviceClick?: boolean
   onBack?: () => void
+  title?: string | null
   className?: string
 }
 
@@ -56,6 +57,7 @@ export function DeviceTable({
   onBack,
   deviceFilter = defaultDeviceFilter,
   deviceComparator = compareByCreatedAtDesc,
+  title = t.devices,
   className,
 }: DeviceTableProps = {}): JSX.Element {
   const { devices, isLoading, isError, error } = useDevices({
@@ -109,9 +111,13 @@ export function DeviceTable({
     <div className={classNames('seam-device-table', className)}>
       <ContentHeader onBack={onBack} />
       <TableHeader>
-        <TableTitle>
-          {t.devices} <Caption>({filteredDevices.length})</Caption>
-        </TableTitle>
+        {title != null ? (
+          <TableTitle>
+            {title ?? t.devices} <Caption>({filteredDevices.length})</Caption>
+          </TableTitle>
+        ) : (
+          <div className='seam-fragment' />
+        )}
         {!disableSearch && (
           <SearchTextField
             value={searchInputValue}

package/src/lib/seam/connect-webviews/use-create-connect-webview.ts

@@ -6,7 +6,7 @@ import type {
   SeamError,
 } from 'seamapi'
 
-import { useSeamClient } from 'lib/seam/use-seam-client.js'
+import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
 export interface UseCreateConnectWebviewParams {
   willNavigateToWebview?: boolean
@@ -32,10 +32,7 @@ export function useCreateConnectWebview({
     mutationFn: async (
       mutationParams: UseCreateConnectWebviewMutationParams
     ) => {
-      if (client == null) {
-        throw new Error('Missing seam client')
-      }
-
+      if (client === null) throw new NullSeamClientError()
       return await client.connectWebviews.create(mutationParams)
     },
     onSuccess: ({ url }) => {

package/src/lib/seam/devices/use-toggle-lock.ts

@@ -11,7 +11,7 @@ import {
   type SeamError,
 } from 'seamapi'
 
-import { useSeamClient } from 'lib/seam/use-seam-client.js'
+import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
 
 export function useToggleLock({
   device_id: deviceId,
@@ -26,10 +26,7 @@ export function useToggleLock({
 
   return useMutation<{ actionAttempt: ActionAttempt }, SeamError>({
     mutationFn: async () => {
-      if (client == null) {
-        throw new Error('Missing seam client')
-      }
-
+      if (client === null) throw new NullSeamClientError()
       const toggle = locked ? client.locks.unlockDoor : client.locks.lockDoor
       return await toggle(deviceId)
     },

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

@@ -0,0 +1,53 @@
+import { useQuery, useQueryClient } from '@tanstack/react-query'
+import type {
+  ClimateSettingSchedule,
+  ClimateSettingSchedulesListRequest,
+  ClimateSettingSchedulesListResponse,
+  SeamError,
+} from 'seamapi'
+
+import { useSeamClient } from 'lib/seam/use-seam-client.js'
+import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+
+export type UseClimateSettingSchedulesParams =
+  ClimateSettingSchedulesListRequest
+export type UseClimateSettingSchedulesData = ClimateSettingSchedule[]
+
+export function useClimateSettingSchedules(
+  params: UseClimateSettingSchedulesParams
+): UseSeamQueryResult<
+  'climateSettingSchedules',
+  UseClimateSettingSchedulesData
+> {
+  const { client } = useSeamClient()
+  const queryClient = useQueryClient()
+
+  const { data, ...rest } = useQuery<
+    ClimateSettingSchedulesListResponse['climate_setting_schedules'],
+    SeamError
+  >({
+    enabled: client != null,
+    queryKey: ['thermostats', 'climate_setting_schedules', 'list', params],
+    queryFn: async () => {
+      if (client == null) return []
+      return await client.thermostats.climateSettingSchedules.list(params)
+    },
+    onSuccess: (schedules) => {
+      // Prime cache for each schedule.
+      for (const schedule of schedules) {
+        queryClient.setQueryData(
+          [
+            'climate_setting_schedules',
+            'get',
+            {
+              climate_setting_schedule_id: schedule.climate_setting_schedule_id,
+            },
+          ],
+          schedule
+        )
+      }
+    },
+  })
+
+  return { ...rest, climateSettingSchedules: data }
+}

package/src/lib/seam/use-seam-client.ts

@@ -71,6 +71,21 @@ export function useSeamClient(): {
   return { client: data ?? null, isLoading, isError, error }
 }
 
+export class NullSeamClientError extends Error {
+  constructor() {
+    super(
+      [
+        'Attempted to use a null Seam client.',
+        'Either a hook using useSeamClient was called outside of a SeamProvider,',
+        'or there was an error when creating the Seam client in useSeamClient,',
+        'or useSeamClient is still loading the client.',
+      ].join(' ')
+    )
+    this.name = this.constructor.name
+    Error.captureStackTrace(this, this.constructor)
+  }
+}
+
 function useUserIdentifierKeyOrFingerprint(
   userIdentifierKey: string | undefined
 ): string {

package/src/lib/ui/RadioField/RadioField.tsx

@@ -14,11 +14,12 @@ interface RadioOption<Value> {
   value: Value
 }
 
-type RadioFieldContext<Value extends string> =
-  | Omit<RadioFieldProps<Value>, 'options'>
-  | undefined
+type RadioFieldContext<Value extends string> = Omit<
+  RadioFieldProps<Value>,
+  'options'
+> | null
 
-const radioFieldContext = createContext<RadioFieldContext<any>>(undefined)
+const radioFieldContext = createContext<RadioFieldContext<any>>(null)
 
 export function RadioField<Value extends string>({
   value,
@@ -48,7 +49,7 @@ export function useRadioField<Value extends string>(): NonNullable<
   RadioFieldContext<Value>
 > {
   const context = useContext<RadioFieldContext<Value>>(radioFieldContext)
-  if (context === undefined) {
+  if (context === null) {
     throw new Error('useRadioField must be used within a <RadioField/>')
   }
   return context

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiReactVersion = '1.35.0'
+const seamapiReactVersion = '1.37.0'
 
 export default seamapiReactVersion