@sanity/sdk-react 2.8.0 → 2.9.0

package/src/hooks/releases/useActiveReleases.ts

@@ -1,19 +1,18 @@
 import {
+  type DocumentSource,
   getActiveReleasesState,
   type ReleaseDocument,
+  type SanityConfig,
   type SanityInstance,
   type StateSource,
 } from '@sanity/sdk'
 import {filter, firstValueFrom} from 'rxjs'
 
 import {createStateSourceHook} from '../helpers/createStateSourceHook'
-
-/**
- * @public
- */
-type UseActiveReleases = {
-  (): ReleaseDocument[]
-}
+import {
+  useNormalizedSourceOptions,
+  type WithSourceNameSupport,
+} from '../helpers/useNormalizedSourceOptions'
 
 /**
  * @public
@@ -30,10 +29,30 @@ type UseActiveReleases = {
  * const activeReleases = useActiveReleases()
  * ```
  */
-export const useActiveReleases: UseActiveReleases = createStateSourceHook({
-  getState: getActiveReleasesState as (instance: SanityInstance) => StateSource<ReleaseDocument[]>,
-  shouldSuspend: (instance: SanityInstance) =>
-    getActiveReleasesState(instance).getCurrent() === undefined,
-  suspender: (instance: SanityInstance) =>
-    firstValueFrom(getActiveReleasesState(instance).observable.pipe(filter(Boolean))),
+type UseActiveReleases = {
+  (options?: WithSourceNameSupport<SanityConfig> | undefined): ReleaseDocument[]
+}
+
+const useActiveReleasesValue: UseActiveReleases = createStateSourceHook({
+  getState: getActiveReleasesState as (
+    instance: SanityInstance,
+    options?: {source?: DocumentSource},
+  ) => StateSource<ReleaseDocument[]>,
+  shouldSuspend: (instance: SanityInstance, options?: {source?: DocumentSource}) =>
+    getActiveReleasesState(instance, options ?? {}).getCurrent() === undefined,
+  suspender: (instance: SanityInstance, options?: {source?: DocumentSource}) =>
+    firstValueFrom(
+      getActiveReleasesState(instance, options ?? {}).observable.pipe(filter(Boolean)),
+    ),
 })
+
+/**
+ * @public
+ * @function
+ */
+export const useActiveReleases: UseActiveReleases = (
+  options: WithSourceNameSupport<{source?: DocumentSource}> | undefined,
+) => {
+  const normalizedOptions = useNormalizedSourceOptions(options ?? {})
+  return useActiveReleasesValue(normalizedOptions)
+}

package/src/hooks/releases/usePerspective.ts

@@ -1,20 +1,17 @@
 import {
-  getActiveReleasesState,
+  type DatasetHandle,
+  type DocumentSource,
   getPerspectiveState,
-  type PerspectiveHandle,
   type SanityInstance,
   type StateSource,
 } from '@sanity/sdk'
 import {filter, firstValueFrom} from 'rxjs'
 
 import {createStateSourceHook} from '../helpers/createStateSourceHook'
-
-/**
- * @public
- */
-type UsePerspective = {
-  (perspectiveHandle: PerspectiveHandle): string | string[]
-}
+import {
+  useNormalizedSourceOptions,
+  type WithSourceNameSupport,
+} from '../helpers/useNormalizedSourceOptions'
 
 /**
  * @public
@@ -38,13 +35,28 @@ type UsePerspective = {
  *
  * @returns The perspective for the given perspective handle.
  */
-export const usePerspective: UsePerspective = createStateSourceHook({
+type UsePerspective = {
+  (perspectiveHandle: DatasetHandle): string | string[]
+}
+
+const usePerspectiveValue: UsePerspective = createStateSourceHook({
   getState: getPerspectiveState as (
     instance: SanityInstance,
-    perspectiveHandle?: PerspectiveHandle,
+    perspectiveHandle?: {source?: DocumentSource},
   ) => StateSource<string | string[]>,
-  shouldSuspend: (instance: SanityInstance, options: PerspectiveHandle): boolean =>
+  shouldSuspend: (instance: SanityInstance, options: {source?: DocumentSource}): boolean =>
     getPerspectiveState(instance, options).getCurrent() === undefined,
-  suspender: (instance: SanityInstance, _options?: PerspectiveHandle) =>
-    firstValueFrom(getActiveReleasesState(instance).observable.pipe(filter(Boolean))),
+  suspender: (instance: SanityInstance, _options?: {source?: DocumentSource}) =>
+    firstValueFrom(getPerspectiveState(instance, _options ?? {}).observable.pipe(filter(Boolean))),
 })
+
+/**
+ * @public
+ * @function
+ */
+export const usePerspective: UsePerspective = (
+  options: WithSourceNameSupport<DatasetHandle> | undefined,
+) => {
+  const normalizedOptions = useNormalizedSourceOptions(options ?? {})
+  return usePerspectiveValue(normalizedOptions)
+}

package/src/hooks/users/useUser.ts

@@ -9,6 +9,7 @@ import {
 import {useEffect, useMemo, useState, useSyncExternalStore, useTransition} from 'react'
 
 import {useSanityInstance} from '../context/useSanityInstance'
+import {trackHookUsage} from '../helpers/useTrackHookUsage'
 
 /**
  * @public
@@ -59,6 +60,7 @@ export interface UserResult {
  */
 export function useUser(options: GetUserOptions): UserResult {
   const instance = useSanityInstance(options)
+  trackHookUsage(instance, 'useUser')
   // Use React's useTransition to avoid UI jank when user options change
   const [isPending, startTransition] = useTransition()
 

package/src/hooks/users/useUsers.ts

@@ -10,6 +10,7 @@ import {
 import {useCallback, useEffect, useMemo, useState, useSyncExternalStore, useTransition} from 'react'
 
 import {useSanityInstance} from '../context/useSanityInstance'
+import {trackHookUsage} from '../helpers/useTrackHookUsage'
 
 /**
  * @public
@@ -69,6 +70,7 @@ export interface UsersResult {
  */
 export function useUsers(options?: GetUsersOptions): UsersResult {
   const instance = useSanityInstance(options)
+  trackHookUsage(instance, 'useUsers')
   // Use React's useTransition to avoid UI jank when user options change
   const [isPending, startTransition] = useTransition()