@sanity/sdk-react 2.1.0 → 2.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/sdk-react",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "private": false,
   "description": "Sanity SDK React toolkit for Content OS",
   "keywords": [
@@ -48,10 +48,10 @@
     "@types/lodash-es": "^4.17.12",
     "groq": "3.88.1-typegen-experimental.0",
     "lodash-es": "^4.17.21",
-    "react-compiler-runtime": "19.1.0-rc.1",
+    "react-compiler-runtime": "19.1.0-rc.2",
     "react-error-boundary": "^5.0.0",
     "rxjs": "^7.8.2",
-    "@sanity/sdk": "2.1.0"
+    "@sanity/sdk": "2.1.2"
   },
   "devDependencies": {
     "@sanity/browserslist-config": "^1.0.5",

package/src/_exports/sdk-react.ts

@@ -53,6 +53,7 @@ export {
   type PaginatedDocumentsResponse,
   usePaginatedDocuments,
 } from '../hooks/paginatedDocuments/usePaginatedDocuments'
+export {usePresence} from '../hooks/presence/usePresence'
 export {
   useDocumentPreview,
   type useDocumentPreviewOptions,
@@ -68,6 +69,7 @@ export {type ProjectWithoutMembers, useProjects} from '../hooks/projects/useProj
 export {useQuery} from '../hooks/query/useQuery'
 export {useActiveReleases} from '../hooks/releases/useActiveReleases'
 export {usePerspective} from '../hooks/releases/usePerspective'
+export {type UserResult, useUser} from '../hooks/users/useUser'
 export {type UsersResult, useUsers} from '../hooks/users/useUsers'
 export {REACT_SDK_VERSION} from '../version'
 export {type DatasetsResponse, type SanityProjectMember} from '@sanity/client'

package/src/components/SanityApp.test.tsx

@@ -170,6 +170,7 @@ describe('SanityApp', () => {
 
   it('redirects to core if not inside iframe and not local url', async () => {
     const originalLocation = window.location
+    const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
 
     const mockLocation = {
       replace: vi.fn(),
@@ -203,6 +204,7 @@ describe('SanityApp', () => {
       value: originalLocation,
       writable: true,
     })
+    consoleWarnSpy.mockRestore()
   })
 
   it('does not redirect to core if not inside iframe and local url', async () => {
@@ -241,4 +243,44 @@ describe('SanityApp', () => {
       writable: true,
     })
   })
+
+  it('does not redirect to core if studioMode is enabled', async () => {
+    const originalLocation = window.location
+    const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
+    const mockLocation = {
+      replace: vi.fn(),
+      href: 'http://sanity-test.app',
+    }
+
+    const mockSanityConfig: SanityConfig = {
+      projectId: 'test-project',
+      dataset: 'test-dataset',
+      studioMode: {enabled: true},
+    }
+
+    Object.defineProperty(window, 'location', {
+      value: mockLocation,
+      writable: true,
+    })
+
+    render(
+      <SanityApp config={[mockSanityConfig]} fallback={<div>Fallback</div>}>
+        <div>Test Child</div>
+      </SanityApp>,
+    )
+
+    // Wait for 1 second
+    await new Promise((resolve) => setTimeout(resolve, 1010))
+
+    // Add assertions based on your iframe-specific behavior
+    expect(mockLocation.replace).not.toHaveBeenCalled()
+
+    // Clean up the mock
+    Object.defineProperty(window, 'location', {
+      value: originalLocation,
+      writable: true,
+    })
+    consoleWarnSpy.mockRestore()
+  })
 })

package/src/components/SanityApp.tsx

@@ -86,8 +86,9 @@ export function SanityApp({
 }: SanityAppProps): ReactElement {
   useEffect(() => {
     let timeout: NodeJS.Timeout | undefined
+    const primaryConfig = Array.isArray(config) ? config[0] : config
 
-    if (!isInIframe() && !isLocalUrl(window)) {
+    if (!isInIframe() && !isLocalUrl(window) && !primaryConfig?.studioMode?.enabled) {
       // If the app is not running in an iframe and is not a local url, redirect to core.
       timeout = setTimeout(() => {
         // eslint-disable-next-line no-console
@@ -96,7 +97,7 @@ export function SanityApp({
       }, 1000)
     }
     return () => clearTimeout(timeout)
-  }, [])
+  }, [config])
 
   return (
     <SDKProvider {...props} fallback={fallback} config={config}>

package/src/context/ResourceProvider.test.tsx

@@ -1,5 +1,5 @@
 import {type SanityConfig, type SanityInstance} from '@sanity/sdk'
-import {render, screen} from '@testing-library/react'
+import {act, render, screen} from '@testing-library/react'
 import {StrictMode, use, useEffect} from 'react'
 import {describe, expect, it} from 'vitest'
 
@@ -36,7 +36,7 @@ describe('ResourceProvider', () => {
     expect(screen.getByTestId('test-child')).toBeInTheDocument()
   })
 
-  it('shows fallback during loading', () => {
+  it('shows fallback during loading', async () => {
     const {promise, resolve} = promiseWithResolvers()
     function SuspendingChild(): React.ReactNode {
       throw promise
@@ -49,7 +49,9 @@ describe('ResourceProvider', () => {
     )
 
     expect(screen.getByTestId('fallback')).toBeInTheDocument()
-    resolve()
+    act(() => {
+      resolve()
+    })
   })
 
   it('creates root instance when no parent context exists', async () => {
@@ -138,7 +140,7 @@ describe('ResourceProvider', () => {
     expect(instance?.isDisposed()).toBe(false)
   })
 
-  it('uses default fallback when none provided', () => {
+  it('uses default fallback when none provided', async () => {
     const {promise, resolve} = promiseWithResolvers()
     function SuspendingChild(): React.ReactNode {
       throw promise
@@ -152,6 +154,8 @@ describe('ResourceProvider', () => {
     )
 
     expect(screen.getByText(/Warning: No fallback provided/)).toBeInTheDocument()
-    resolve()
+    act(() => {
+      resolve()
+    })
   })
 })

package/src/hooks/dashboard/useManageFavorite.test.ts

@@ -172,6 +172,7 @@ describe('useManageFavorite', () => {
 
   it('should throw error during favorite/unfavorite actions', async () => {
     const errorMessage = 'Failed to update favorite status'
+    const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
 
     mockFetch.mockImplementation(() => {
       throw new Error(errorMessage)
@@ -191,6 +192,7 @@ describe('useManageFavorite', () => {
     })
 
     expect(resolveFavoritesState).not.toHaveBeenCalled()
+    consoleErrorSpy.mockRestore()
   })
 
   it('should throw error when studio resource is missing projectId or dataset', () => {

package/src/hooks/dashboard/useNavigateToStudioDocument.test.ts

@@ -75,10 +75,12 @@ describe('useNavigateToStudioDocument', () => {
   })
 
   it('does not send message when no workspace is found', () => {
+    const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
     mockWorkspacesByProjectIdAndDataset = {}
     const {result} = renderHook(() => useNavigateToStudioDocument(mockDocumentHandle))
     result.current.navigateToStudioDocument()
     expect(mockSendMessage).not.toHaveBeenCalled()
+    consoleSpy.mockRestore()
   })
 
   it('warns when multiple workspaces are found', () => {

package/src/hooks/dashboard/useRecordDocumentHistoryEvent.test.ts

@@ -45,6 +45,7 @@ describe('useRecordDocumentHistoryEvent', () => {
   })
 
   it('should handle errors when sending messages', () => {
+    const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
     mockSendMessage.mockImplementation(() => {
       throw new Error('Failed to send message')
     })
@@ -52,6 +53,7 @@ describe('useRecordDocumentHistoryEvent', () => {
     const {result} = renderHook(() => useRecordDocumentHistoryEvent(mockDocumentHandle))
 
     expect(() => result.current.recordEvent('viewed')).toThrow('Failed to send message')
+    consoleErrorSpy.mockRestore()
   })
 
   it('should throw error when resourceId is missing for non-studio resources', () => {

package/src/hooks/presence/usePresence.test.tsx

@@ -0,0 +1,80 @@
+import {getPresence, type SanityUser, type UserPresence} from '@sanity/sdk'
+import {NEVER} from 'rxjs'
+import {describe, expect, it, vi} from 'vitest'
+
+import {act, renderHook} from '../../../test/test-utils'
+import {usePresence} from './usePresence'
+
+vi.mock('@sanity/sdk', () => ({
+  getPresence: vi.fn(),
+  createSanityInstance: vi.fn(() => ({
+    createChild: vi.fn(),
+    isDisposed: vi.fn(() => false),
+    dispose: vi.fn(),
+  })),
+}))
+
+vi.mock('../context/useSanityInstance', () => ({
+  useSanityInstance: vi.fn(() => ({config: {projectId: 'test', dataset: 'test'}})),
+}))
+
+describe('usePresence', () => {
+  it('should return presence locations and update when the store changes', () => {
+    const initialLocations: UserPresence[] = [
+      {
+        user: {
+          sanityUserId: 'user1',
+          profile: undefined,
+          memberships: [],
+        } as unknown as SanityUser,
+        sessionId: 'session1',
+        state: 'online',
+        lastActiveAt: new Date().toISOString(),
+      },
+    ] as unknown as UserPresence[]
+    const updatedLocations: UserPresence[] = [
+      ...initialLocations,
+      {
+        user: {
+          sanityUserId: 'user2',
+          profile: undefined,
+          memberships: [],
+        } as unknown as SanityUser,
+        sessionId: 'session2',
+        state: 'online',
+        lastActiveAt: new Date().toISOString(),
+      },
+    ] as unknown as UserPresence[]
+
+    let onStoreChange: () => void = () => {}
+    const getCurrent = vi.fn().mockReturnValue(initialLocations)
+    const mockPresenceSource = {
+      // It's called once for the server snapshot, and once for the client
+      getCurrent,
+      subscribe: vi.fn((callback) => {
+        onStoreChange = callback
+        // Return an unsubscribe function
+        return () => {}
+      }),
+      observable: NEVER,
+    }
+    vi.mocked(getPresence).mockReturnValue(mockPresenceSource)
+
+    const {result, unmount} = renderHook(() => usePresence())
+
+    // Initial state should be correct
+    expect(result.current.locations).toEqual(initialLocations)
+    expect(getCurrent).toHaveBeenCalled()
+    expect(mockPresenceSource.subscribe).toHaveBeenCalledTimes(1)
+
+    // Update state
+    getCurrent.mockReturnValue(updatedLocations)
+    act(() => {
+      onStoreChange()
+    })
+
+    // The hook should have been updated
+    expect(result.current.locations).toEqual(updatedLocations)
+    unmount()
+  })
+})

package/src/hooks/presence/usePresence.ts

@@ -0,0 +1,23 @@
+import {getPresence, type UserPresence} from '@sanity/sdk'
+import {useCallback, useMemo, useSyncExternalStore} from 'react'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+
+/**
+ * A hook for subscribing to presence information for the current project.
+ * @public
+ */
+export function usePresence(): {
+  locations: UserPresence[]
+} {
+  const sanityInstance = useSanityInstance()
+  const source = useMemo(() => getPresence(sanityInstance), [sanityInstance])
+  const subscribe = useCallback((callback: () => void) => source.subscribe(callback), [source])
+  const locations = useSyncExternalStore(
+    subscribe,
+    () => source.getCurrent(),
+    () => source.getCurrent(),
+  )
+
+  return {locations: locations || []}
+}