@seamapi/react 4.8.2 → 4.9.1

package/src/lib/seam/SeamQueryProvider.tsx

@@ -0,0 +1,270 @@
+import type {
+  SeamHttp,
+  SeamHttpEndpoints,
+  SeamHttpOptionsWithClientSessionToken,
+} from '@seamapi/http/connect'
+import {
+  QueryClient,
+  QueryClientContext,
+  QueryClientProvider,
+} from '@tanstack/react-query'
+import {
+  createContext,
+  type PropsWithChildren,
+  useContext,
+  useEffect,
+  useMemo,
+} from 'react'
+
+import { useSeamClient } from './use-seam-client.js'
+
+export interface SeamQueryContext {
+  client: SeamHttp | null
+  endpointClient: SeamHttpEndpoints | null
+  clientOptions?: SeamQueryProviderClientOptions | undefined
+  publishableKey?: string | undefined
+  userIdentifierKey?: string | undefined
+  clientSessionToken?: string | undefined
+  queryKeyPrefix?: string | undefined
+}
+
+export type SeamQueryProviderProps =
+  | SeamQueryProviderPropsWithClient
+  | SeamQueryProviderPropsWithPublishableKey
+  | SeamQueryProviderPropsWithClientSessionToken
+
+export interface SeamQueryProviderPropsWithClient
+  extends SeamQueryProviderBaseProps {
+  client: SeamHttp
+  queryKeyPrefix: string
+}
+
+export interface SeamQueryProviderPropsWithPublishableKey
+  extends SeamQueryProviderBaseProps,
+    SeamQueryProviderClientOptions {
+  publishableKey: string
+  userIdentifierKey?: string
+}
+
+export interface SeamQueryProviderPropsWithClientSessionToken
+  extends SeamQueryProviderBaseProps,
+    SeamQueryProviderClientOptions {
+  clientSessionToken: string
+}
+
+interface SeamQueryProviderBaseProps extends PropsWithChildren {
+  queryClient?: QueryClient | undefined
+  onSessionUpdate?: (client: SeamHttp) => void
+}
+
+type SeamClientOptions = SeamHttpOptionsWithClientSessionToken
+
+export type SeamQueryProviderClientOptions = Pick<SeamClientOptions, 'endpoint'>
+
+const defaultQueryClient = new QueryClient()
+
+export function SeamQueryProvider({
+  children,
+  onSessionUpdate = () => {},
+  queryClient,
+  ...props
+}: SeamQueryProviderProps): JSX.Element {
+  const value = useMemo(() => {
+    const context = createSeamQueryContextValue(props)
+    if (
+      context.client == null &&
+      context.publishableKey == null &&
+      context.clientSessionToken == null
+    ) {
+      return defaultSeamQueryContextValue
+    }
+    return context
+  }, [props])
+
+  if (
+    value.client == null &&
+    value.publishableKey == null &&
+    value.clientSessionToken == null
+  ) {
+    throw new Error(
+      `Must provide either a Seam client, clientSessionToken, or a publishableKey.`
+    )
+  }
+
+  const { Provider } = seamContext
+  const queryClientFromContext = useContext(QueryClientContext)
+
+  if (
+    queryClientFromContext != null &&
+    queryClient != null &&
+    queryClientFromContext !== queryClient
+  ) {
+    throw new Error(
+      'The QueryClient passed into SeamQueryProvider is different from the one in the existing QueryClientContext. Omit the queryClient prop from SeamProvider or SeamQueryProvider to use the existing QueryClient provided by the QueryClientProvider.'
+    )
+  }
+
+  return (
+    <QueryClientProvider
+      client={queryClientFromContext ?? queryClient ?? defaultQueryClient}
+    >
+      <Provider value={value}>
+        <Session onSessionUpdate={onSessionUpdate}>{children}</Session>
+      </Provider>
+    </QueryClientProvider>
+  )
+}
+
+function Session({
+  onSessionUpdate,
+  children,
+}: Required<Pick<SeamQueryProviderProps, 'onSessionUpdate'>> &
+  PropsWithChildren): JSX.Element | null {
+  const { client } = useSeamClient()
+  useEffect(() => {
+    if (client != null) onSessionUpdate(client)
+  }, [onSessionUpdate, client])
+
+  return <>{children}</>
+}
+
+const createDefaultSeamQueryContextValue = (): SeamQueryContext => {
+  try {
+    if (globalThis.seam == null) {
+      return { client: null, endpointClient: null }
+    }
+    return createSeamQueryContextValue(globalThis.seam)
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.warn(err)
+    return { client: null, endpointClient: null }
+  }
+}
+
+const createSeamQueryContextValue = (
+  options: SeamQueryProviderProps
+): SeamQueryContext => {
+  if (isSeamQueryProviderPropsWithClient(options)) {
+    if (options.queryKeyPrefix == null) {
+      throw new InvalidSeamQueryProviderProps(
+        'The client prop must be used with a queryKeyPrefix prop.'
+      )
+    }
+    return {
+      ...options,
+      endpointClient: null,
+    }
+  }
+
+  if (isSeamQueryProviderPropsWithClientSessionToken(options)) {
+    const { clientSessionToken, ...clientOptions } = options
+    return {
+      clientSessionToken,
+      clientOptions,
+      client: null,
+      endpointClient: null,
+    }
+  }
+
+  if (isSeamQueryProviderPropsWithPublishableKey(options)) {
+    const { publishableKey, userIdentifierKey, ...clientOptions } = options
+    return {
+      publishableKey,
+      userIdentifierKey,
+      clientOptions,
+      client: null,
+      endpointClient: null,
+    }
+  }
+
+  return { client: null, endpointClient: null }
+}
+
+const defaultSeamQueryContextValue = createDefaultSeamQueryContextValue()
+
+export const seamContext = createContext<SeamQueryContext>(
+  defaultSeamQueryContextValue
+)
+
+export function useSeamQueryContext(): SeamQueryContext {
+  return useContext(seamContext)
+}
+
+const isSeamQueryProviderPropsWithClient = (
+  props: SeamQueryProviderProps
+): props is SeamQueryProviderPropsWithClient => {
+  if (!('client' in props)) return false
+
+  const { client, ...otherProps } = props
+  if (client == null) return false
+
+  const otherNonNullProps = Object.values(otherProps).filter((v) => v != null)
+  if (otherNonNullProps.length > 0) {
+    throw new InvalidSeamQueryProviderProps(
+      `The client prop cannot be used with ${otherNonNullProps.join(' or ')}.`
+    )
+  }
+
+  return true
+}
+
+const isSeamQueryProviderPropsWithPublishableKey = (
+  props: SeamQueryProviderProps
+): props is SeamQueryProviderPropsWithPublishableKey &
+  SeamQueryProviderClientOptions => {
+  if (!('publishableKey' in props)) return false
+
+  const { publishableKey } = props
+  if (publishableKey == null) return false
+
+  if ('client' in props && props.client != null) {
+    throw new InvalidSeamQueryProviderProps(
+      'The client prop cannot be used with the publishableKey prop.'
+    )
+  }
+
+  if ('clientSessionToken' in props && props.clientSessionToken != null) {
+    throw new InvalidSeamQueryProviderProps(
+      'The clientSessionToken prop cannot be used with the publishableKey prop.'
+    )
+  }
+
+  return true
+}
+
+const isSeamQueryProviderPropsWithClientSessionToken = (
+  props: SeamQueryProviderProps
+): props is SeamQueryProviderPropsWithClientSessionToken &
+  SeamQueryProviderClientOptions => {
+  if (!('clientSessionToken' in props)) return false
+
+  const { clientSessionToken } = props
+  if (clientSessionToken == null) return false
+
+  if ('client' in props && props.client != null) {
+    throw new InvalidSeamQueryProviderProps(
+      'The client prop cannot be used with the clientSessionToken prop.'
+    )
+  }
+
+  if ('publishableKey' in props && props.publishableKey != null) {
+    throw new InvalidSeamQueryProviderProps(
+      'The publishableKey prop cannot be used with the clientSessionToken prop.'
+    )
+  }
+
+  if ('userIdentifierKey' in props && props.userIdentifierKey != null) {
+    throw new InvalidSeamQueryProviderProps(
+      'The userIdentifierKey prop cannot be used with the clientSessionToken prop.'
+    )
+  }
+
+  return true
+}
+
+class InvalidSeamQueryProviderProps extends Error {
+  constructor(message: string) {
+    super(`SeamQueryProvider received invalid props: ${message}`)
+    this.name = this.constructor.name
+  }
+}

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

@@ -6,7 +6,7 @@ import type { AccessCode } from '@seamapi/types/connect'
 import { useQuery } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseAccessCodeParams = AccessCodesGetParams
 
@@ -14,7 +14,7 @@ export type UseAccessCodeData = AccessCode | null
 
 export function useAccessCode(
   params: UseAccessCodeParams
-): UseSeamQueryResult<'accessCode', UseAccessCodeData> {
+): UseSeamQueryResultLegacy<'accessCode', UseAccessCodeData> {
   const { client } = useSeamClient()
   const { data, ...rest } = useQuery<UseAccessCodeData, SeamHttpApiError>({
     enabled: client != null,

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

@@ -6,7 +6,7 @@ import type { AccessCode } from '@seamapi/types/connect'
 import { useQuery, useQueryClient } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseAccessCodesParams = AccessCodesListParams
 
@@ -14,7 +14,7 @@ export type UseAccessCodesData = AccessCode[]
 
 export function useAccessCodes(
   params: UseAccessCodesParams
-): UseSeamQueryResult<'accessCodes', UseAccessCodesData> {
+): UseSeamQueryResultLegacy<'accessCodes', UseAccessCodesData> {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 

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

@@ -1,39 +1,14 @@
-import type {
-  AccessCodesCreateBody,
-  SeamHttpApiError,
-} from '@seamapi/http/connect'
-import type { AccessCode } 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 UseCreateAccessCodeParams = never
+import { useQueryClient } from '@tanstack/react-query'
 
-export type UseCreateAccessCodeData = AccessCode
-
-export type UseCreateAccessCodeMutationVariables = AccessCodesCreateBody
+import {
+  useSeamMutation,
+  type UseSeamMutationResult,
+} from '../use-seam-mutation.js'
 
-export function useCreateAccessCode(): UseMutationResult<
-  UseCreateAccessCodeData,
-  SeamHttpApiError,
-  UseCreateAccessCodeMutationVariables
-> {
-  const { client } = useSeamClient()
+export function useCreateAccessCode(): UseSeamMutationResult<'/access_codes/create'> {
   const queryClient = useQueryClient()
 
-  return useMutation<
-    UseCreateAccessCodeData,
-    SeamHttpApiError,
-    UseCreateAccessCodeMutationVariables
-  >({
-    mutationFn: async (variables) => {
-      if (client === null) throw new NullSeamClientError()
-      return await client.accessCodes.create(variables)
-    },
+  return useSeamMutation('/access_codes/create', {
     onSuccess: (data) => {
       queryClient.setQueryData(
         ['access_codes', 'get', { access_code_id: data.access_code_id }],

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

@@ -1,5 +1,5 @@
 import type {
-  AccessCodesGenerateCodeBody,
+  AccessCodesGenerateCodeParams,
   SeamHttpApiError,
 } from '@seamapi/http/connect'
 import { useMutation, type UseMutationResult } from '@tanstack/react-query'
@@ -11,7 +11,7 @@ export type UseGenerateAccessCodeCodeParams = never
 export type UseGenerateAccessCodeCodeData = string
 
 export type UseGenerateAccessCodeCodeMutationVariables =
-  AccessCodesGenerateCodeBody
+  AccessCodesGenerateCodeParams
 
 export function useGenerateAccessCodeCode(): UseMutationResult<
   UseGenerateAccessCodeCodeData,

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

@@ -3,13 +3,13 @@ import type { ClientSession } from '@seamapi/types/connect'
 import { useQuery } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseClientSessionParams = never
 
 export type UseClientSessionData = ClientSession | null
 
-export function useClientSession(): UseSeamQueryResult<
+export function useClientSession(): UseSeamQueryResultLegacy<
   'clientSession',
   UseClientSessionData
 > {

package/src/lib/seam/components/SupportedDeviceTable/use-device-model.ts

@@ -7,7 +7,7 @@ import type {
 import { useQuery } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseDeviceModelParams = DeviceModelsGetParams
 
@@ -15,7 +15,7 @@ export type UseDeviceModelData = DeviceModel | null
 
 export function useDeviceModel(
   params: UseDeviceModelParams
-): UseSeamQueryResult<'deviceModel', UseDeviceModelData> {
+): UseSeamQueryResultLegacy<'deviceModel', UseDeviceModelData> {
   const { client: seam } = useSeamClient()
   const { data, ...rest } = useQuery<UseDeviceModelData, SeamHttpApiError>({
     enabled: seam != null,

package/src/lib/seam/components/SupportedDeviceTable/use-device-models.ts

@@ -7,7 +7,7 @@ import type {
 import { useQuery, useQueryClient } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseDeviceModelsParams = DeviceModelsListParams
 
@@ -15,7 +15,7 @@ export type UseDeviceModelsData = DeviceModel[]
 
 export function useDeviceModels(
   params?: UseDeviceModelsParams
-): UseSeamQueryResult<'deviceModels', UseDeviceModelsData> {
+): UseSeamQueryResultLegacy<'deviceModels', UseDeviceModelsData> {
   const { client: seam } = useSeamClient()
   const queryClient = useQueryClient()
 

package/src/lib/seam/components/SupportedDeviceTable/use-manufacturer.ts

@@ -7,7 +7,7 @@ import type {
 import { useQuery } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseManufacturerParams = ManufacturersGetParams
 
@@ -15,7 +15,7 @@ export type UseManufacturerData = Manufacturer | null
 
 export function useManufacturer(
   params: UseManufacturerParams
-): UseSeamQueryResult<'manufacturer', UseManufacturerData> {
+): UseSeamQueryResultLegacy<'manufacturer', UseManufacturerData> {
   const { client: seam } = useSeamClient()
   const { data, ...rest } = useQuery<UseManufacturerData, SeamHttpApiError>({
     enabled: seam != null,

package/src/lib/seam/components/SupportedDeviceTable/use-manufacturers.ts

@@ -7,7 +7,7 @@ import type {
 import { useQuery, useQueryClient } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseManufacturersParams = ManufacturersListParams
 
@@ -15,7 +15,7 @@ export type UseManufacturersData = Manufacturer[]
 
 export function useManufacturers(
   params?: UseManufacturersParams
-): UseSeamQueryResult<'manufacturers', UseManufacturersData> {
+): UseSeamQueryResultLegacy<'manufacturers', UseManufacturersData> {
   const { client: seam } = useSeamClient()
   const queryClient = useQueryClient()
 

package/src/lib/seam/connected-accounts/use-connected-account.ts

@@ -6,7 +6,7 @@ import type { ConnectedAccount } from '@seamapi/types/connect'
 import { useQuery } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseConnectedAccountParams = ConnectedAccountsGetParams
 
@@ -14,7 +14,7 @@ export type UseConnectedAccountData = ConnectedAccount | null
 
 export function useConnectedAccount(
   params: UseConnectedAccountParams
-): UseSeamQueryResult<'connectedAccount', UseConnectedAccountData> {
+): UseSeamQueryResultLegacy<'connectedAccount', UseConnectedAccountData> {
   const { client } = useSeamClient()
   const { data, ...rest } = useQuery<UseConnectedAccountData, SeamHttpApiError>(
     {

package/src/lib/seam/devices/use-device-providers.ts

@@ -6,7 +6,7 @@ import type { DeviceProvider } from '@seamapi/types/connect'
 import { useQuery } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseDeviceProvidersParams = DevicesListDeviceProvidersParams
 
@@ -14,7 +14,7 @@ export type UseDeviceProvidersData = DeviceProvider[]
 
 export function useDeviceProviders(
   params?: UseDeviceProvidersParams
-): UseSeamQueryResult<'deviceProviders', UseDeviceProvidersData> {
+): UseSeamQueryResultLegacy<'deviceProviders', UseDeviceProvidersData> {
   const { client } = useSeamClient()
 
   const { data, ...rest } = useQuery<UseDeviceProvidersData, SeamHttpApiError>({

package/src/lib/seam/devices/use-device.ts

@@ -3,7 +3,7 @@ import type { Device } from '@seamapi/types/connect'
 import { useQuery } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseDeviceParams = DevicesGetParams
 
@@ -11,7 +11,7 @@ export type UseDeviceData = Device | null
 
 export function useDevice(
   params: UseDeviceParams
-): UseSeamQueryResult<'device', UseDeviceData> {
+): UseSeamQueryResultLegacy<'device', UseDeviceData> {
   const { client } = useSeamClient()
   const { data, ...rest } = useQuery<UseDeviceData, SeamHttpApiError>({
     enabled: client != null,

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

@@ -3,7 +3,7 @@ import type { Device } from '@seamapi/types/connect'
 import { useQuery, useQueryClient } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseDevicesParams = DevicesListParams
 
@@ -11,7 +11,7 @@ export type UseDevicesData = Device[]
 
 export function useDevices(
   params?: UseDevicesParams
-): UseSeamQueryResult<'devices', UseDevicesData> {
+): UseSeamQueryResultLegacy<'devices', UseDevicesData> {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 

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

@@ -3,7 +3,7 @@ import type { SeamEvent } from '@seamapi/types/connect'
 import { useQuery, useQueryClient } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseEventsParams = EventsListParams
 
@@ -16,7 +16,7 @@ export interface UseEventsOptions {
 export function useEvents(
   params?: UseEventsParams,
   { refetchInterval }: UseEventsOptions = {}
-): UseSeamQueryResult<'events', UseEventsData> {
+): UseSeamQueryResultLegacy<'events', UseEventsData> {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 

package/src/lib/seam/index.ts

@@ -12,4 +12,6 @@ export * from './devices/use-device-providers.js'
 export * from './devices/use-devices.js'
 export * from './SeamProvider.js'
 export * from './use-seam-client.js'
+export * from './use-seam-mutation.js'
+export * from './use-seam-query.js'
 export * from './use-seam-query-result.js'

package/src/lib/seam/noise-sensors/use-noise-thresholds.ts

@@ -6,7 +6,7 @@ import type { NoiseThreshold } from '@seamapi/types/connect'
 import { useQuery, useQueryClient } from '@tanstack/react-query'
 
 import { useSeamClient } from 'lib/seam/use-seam-client.js'
-import type { UseSeamQueryResult } from 'lib/seam/use-seam-query-result.js'
+import type { UseSeamQueryResultLegacy } from 'lib/seam/use-seam-query-result.js'
 
 export type UseNoiseThresholdsParams = NoiseSensorsNoiseThresholdsListParams
 
@@ -14,7 +14,7 @@ export type UseNoiseThresholdsData = NoiseThreshold[]
 
 export function useNoiseThresholds(
   params: UseNoiseThresholdsParams
-): UseSeamQueryResult<'noiseThresholds', UseNoiseThresholdsData> {
+): UseSeamQueryResultLegacy<'noiseThresholds', UseNoiseThresholdsData> {
   const { client } = useSeamClient()
   const queryClient = useQueryClient()
 

package/src/lib/seam/thermostats/use-delete-thermostat-climate-preset.ts

@@ -1,6 +1,6 @@
 import type {
   SeamHttpApiError,
-  ThermostatsDeleteClimatePresetBody,
+  ThermostatsDeleteClimatePresetParams,
 } from '@seamapi/http/connect'
 import {
   useMutation,
@@ -16,7 +16,7 @@ export type UseDeleteThermostatClimatePresetParams = never
 export type UseDeleteThermostatClimatePresetData = undefined
 
 export type UseDeleteThermostatClimatePresetVariables =
-  ThermostatsDeleteClimatePresetBody
+  ThermostatsDeleteClimatePresetParams
 
 export function useDeleteThermostatClimatePreset(): UseMutationResult<
   UseDeleteThermostatClimatePresetData,