@seamapi/react 1.34.0 → 1.36.0

package/src/lib/seam/SeamProvider.tsx

@@ -150,13 +150,7 @@ const defaultSeamContextValue = createDefaultSeamContextValue()
 export const seamContext = createContext<SeamContext>(defaultSeamContextValue)
 
 export function useSeamContext(): SeamContext {
-  const context = useContext(seamContext)
-
-  if (context == null) {
-    throw new Error('useSeamContext must be used inside a <SeamProvider/>')
-  }
-
-  return context
+  return useContext(seamContext)
 }
 
 const isSeamProviderPropsWithClient = (
@@ -167,8 +161,11 @@ const isSeamProviderPropsWithClient = (
   const { client } = props
   if (client == null) return false
 
-  if (Object.values(props).some((v) => v == null)) {
-    throw new Error('Cannot provide a Seam client along with other options.')
+  const otherNonNullProps = Object.values(props).filter((v) => v != null)
+  if (otherNonNullProps.length > 0) {
+    throw new InvalidSeamProviderProps(
+      `The client prop cannot be used with ${otherNonNullProps.join(' or ')}.`
+    )
   }
 
   return true
@@ -183,12 +180,14 @@ const isSeamProviderPropsWithPublishableKey = (
   if (publishableKey == null) return false
 
   if ('client' in props && props.client != null) {
-    throw new Error('Cannot provide a Seam client along with other options.')
+    throw new InvalidSeamProviderProps(
+      'The client prop cannot be used with the publishableKey prop.'
+    )
   }
 
   if ('clientSessionToken' in props && props.clientSessionToken != null) {
-    throw new Error(
-      'Cannot provide both a publishableKey and a clientSessionToken.'
+    throw new InvalidSeamProviderProps(
+      'The clientSessionToken prop cannot be used with the publishableKey prop.'
     )
   }
 
@@ -205,18 +204,30 @@ const isSeamProviderPropsWithClientSessionToken = (
   if (clientSessionToken == null) return false
 
   if ('client' in props && props.client != null) {
-    throw new Error('Cannot provide a Seam client along with other options.')
+    throw new InvalidSeamProviderProps(
+      'The client prop cannot be used with the clientSessionToken prop.'
+    )
   }
 
   if ('publishableKey' in props && props.publishableKey != null) {
-    throw new Error(
-      'Cannot provide both a clientSessionToken and a publishableKey.'
+    throw new InvalidSeamProviderProps(
+      'The publishableKey prop cannot be used with the clientSessionToken prop.'
     )
   }
 
   if ('userIdentifierKey' in props && props.userIdentifierKey != null) {
-    throw new Error('Cannot use a userIdentifierKey with a clientSessionToken.')
+    throw new InvalidSeamProviderProps(
+      'The userIdentifierKey prop cannot be used with the clientSessionToken prop.'
+    )
   }
 
   return true
 }
+
+class InvalidSeamProviderProps extends Error {
+  constructor(message: string) {
+    super(`SeamProvider received invalid props: ${message}`)
+    this.name = this.constructor.name
+    Error.captureStackTrace(this, this.constructor)
+  }
+}

package/src/lib/seam/access-codes/use-create-access-code.ts

@@ -10,7 +10,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 type UseCreateAccessCodeParams = never
 export type UseCreateAccessCodeData = AccessCode
@@ -30,10 +30,7 @@ export function useCreateAccessCode(): UseMutationResult<
     AccessCodeCreateRequest
   >({
     mutationFn: async (mutationParams: UseCreateAccessCodeMutationParams) => {
-      if (client === null) {
-        throw new Error('Missing seam client')
-      }
-
+      if (client === null) throw new NullSeamClientError()
       return await client.accessCodes.create(mutationParams)
     },
     onSuccess: () => {

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.34.0'
+const seamapiReactVersion = '1.36.0'
 
 export default seamapiReactVersion