@seamapi/react 4.8.2 → 4.9.0

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

@@ -0,0 +1,50 @@
+import type {
+  SeamHttpApiError,
+  SeamHttpEndpointMutationPaths,
+  SeamHttpEndpoints,
+} from '@seamapi/http/connect'
+import {
+  useMutation,
+  type UseMutationOptions,
+  type UseMutationResult,
+} from '@tanstack/react-query'
+
+import { NullSeamClientError, useSeamClient } from 'lib/seam/use-seam-client.js'
+
+export type UseSeamMutationVariables<T extends SeamHttpEndpointMutationPaths> =
+  Parameters<SeamHttpEndpoints[T]>[0]
+
+export type UseSeamMutationResult<T extends SeamHttpEndpointMutationPaths> =
+  UseMutationResult<
+    MutationData<T>,
+    SeamHttpApiError,
+    UseSeamMutationVariables<T>
+  >
+
+export function useSeamMutation<T extends SeamHttpEndpointMutationPaths>(
+  endpointPath: T,
+  options: Parameters<SeamHttpEndpoints[T]>[1] &
+    MutationOptions<
+      MutationData<T>,
+      SeamHttpApiError,
+      UseSeamMutationVariables<T>
+    > = {}
+): UseSeamMutationResult<T> {
+  const { endpointClient: client } = useSeamClient()
+  return useMutation({
+    ...options,
+    mutationFn: async (variables) => {
+      if (client === null) throw new NullSeamClientError()
+      // Using @ts-expect-error over any is preferred, but not possible here because TypeScript will run out of memory.
+      // Type assertion is needed here for performance reasons. The types are correct at runtime.
+      const endpoint = client[endpointPath] as (...args: any) => Promise<any>
+      return await endpoint(variables, options)
+    },
+  })
+}
+
+type MutationData<T extends SeamHttpEndpointMutationPaths> = Awaited<
+  ReturnType<SeamHttpEndpoints[T]>
+>
+
+type MutationOptions<X, Y, Z> = Omit<UseMutationOptions<X, Y, Z>, 'mutationFn'>

package/src/lib/seam/use-seam-query-result.ts

@@ -1,7 +1,9 @@
 import type { SeamHttpApiError } from '@seamapi/http/connect'
 import type { UseQueryResult } from '@tanstack/react-query'
 
-export type UseSeamQueryResult<Field extends string, ResponsePayload> = Omit<
-  UseQueryResult<ResponsePayload, SeamHttpApiError>,
-  'data'
-> & { [key in Field]?: ResponsePayload }
+export type UseSeamQueryResultLegacy<
+  Field extends string,
+  ResponsePayload,
+> = Omit<UseQueryResult<ResponsePayload, SeamHttpApiError>, 'data'> & {
+  [key in Field]?: ResponsePayload
+}

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

@@ -0,0 +1,45 @@
+import type {
+  SeamHttpApiError,
+  SeamHttpEndpointQueryPaths,
+  SeamHttpEndpoints,
+} from '@seamapi/http/connect'
+import {
+  useQuery,
+  type UseQueryOptions,
+  type UseQueryResult,
+} from '@tanstack/react-query'
+
+import { useSeamClient } from 'lib/seam/use-seam-client.js'
+
+export type UseSeamQueryParameters<T extends SeamHttpEndpointQueryPaths> =
+  Parameters<SeamHttpEndpoints[T]>[0]
+
+export type UseSeamQueryResult<T extends SeamHttpEndpointQueryPaths> =
+  UseQueryResult<QueryData<T>, SeamHttpApiError>
+
+export function useSeamQuery<T extends SeamHttpEndpointQueryPaths>(
+  endpointPath: T,
+  parameters?: UseSeamQueryParameters<T>,
+  options: Parameters<SeamHttpEndpoints[T]>[1] &
+    QueryOptions<QueryData<T>, SeamHttpApiError> = {}
+): UseSeamQueryResult<T> {
+  const { endpointClient: client } = useSeamClient()
+  return useQuery({
+    enabled: client != null,
+    ...options,
+    queryKey: [endpointPath, parameters],
+    queryFn: async () => {
+      if (client == null) return null
+      // Using @ts-expect-error over any is preferred, but not possible here because TypeScript will run out of memory.
+      // Type assertion is needed here for performance reasons. The types are correct at runtime.
+      const endpoint = client[endpointPath] as (...args: any) => Promise<any>
+      return await endpoint(parameters, options)
+    },
+  })
+}
+
+type QueryData<T extends SeamHttpEndpointQueryPaths> = Awaited<
+  ReturnType<SeamHttpEndpoints[T]>
+>
+
+type QueryOptions<X, Y> = Omit<UseQueryOptions<X, Y>, 'queryKey' | 'queryFn'>

package/src/lib/telemetry/hooks.ts

@@ -1,7 +1,7 @@
 import { useEffect, useLayoutEffect } from 'react'
 
 import { useClientSession } from 'lib/seam/client-sessions/use-client-session.js'
-import { useSeamContext } from 'lib/seam/SeamProvider.js'
+import { useSeamQueryContext } from 'lib/seam/SeamQueryProvider.js'
 
 import type { TelemetryClient } from './client.js'
 import { useTelemetryContext } from './TelemetryProvider.js'
@@ -23,7 +23,7 @@ export function useComponentTelemetry(name: string): void {
 
 export function useUserTelemetry(): void {
   const telemetry = useTelemetryClient()
-  const { publishableKey } = useSeamContext()
+  const { publishableKey } = useSeamQueryContext()
   const { clientSession } = useClientSession()
 
   // Ensure identify runs earlier than other effects to avoid anonymous telemetry data.

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiReactVersion = '4.8.2'
+const seamapiReactVersion = '4.9.0'
 
 export default seamapiReactVersion