@sanity/sdk-react 3.0.0-rc.0 → 3.0.0-rc.2

package/src/hooks/comments/useComments.test.tsx

@@ -0,0 +1,242 @@
+import {
+  type Comment,
+  type CommentsOptions,
+  getCommentsState,
+  resolveComments,
+  type StateSource,
+} from '@sanity/sdk'
+import {act, render, screen} from '@testing-library/react'
+import {Suspense} from 'react'
+import {type Observable, Subject} from 'rxjs'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {ResourceProvider} from '../../context/ResourceProvider'
+import {ResourcesContext} from '../../context/ResourcesContext'
+import {useComments} from './useComments'
+
+vi.mock('@sanity/sdk', async (importOriginal) => {
+  const original = await importOriginal<typeof import('@sanity/sdk')>()
+  return {...original, getCommentsState: vi.fn(), resolveComments: vi.fn()}
+})
+
+const HANDLE = {documentId: 'doc-1', documentType: 'author'}
+
+function comment(id: string): Comment {
+  return {
+    id,
+    createdAt: '2026-01-01T00:00:00Z',
+    authorId: 'user-1',
+    message: null,
+    threadId: 'thread-1',
+    status: 'open',
+    documentId: 'doc-1',
+    documentType: 'author',
+    fieldPath: '',
+    reactions: [],
+  }
+}
+
+/**
+ * Stands in for the store, one source per option set so a test can hold one
+ * document loaded and another not.
+ *
+ * `getCurrent` must hand back the same array every call for a given option set.
+ * Returning a fresh one sends `useSyncExternalStore` into a render loop, which
+ * is why the store memoises its selectors.
+ */
+function mockSource(
+  getCurrent: (options: CommentsOptions) => Comment[] | undefined,
+  changed$?: Subject<void>,
+) {
+  vi.mocked(getCommentsState).mockImplementation(
+    (_instance, options) =>
+      ({
+        getCurrent: () => getCurrent(options),
+        subscribe: vi.fn((cb?: () => void) => {
+          const subscription = changed$?.subscribe(() => cb?.())
+          return () => subscription?.unsubscribe()
+        }),
+        get observable(): Observable<Comment[] | undefined> {
+          throw new Error('Not implemented')
+        },
+      }) as StateSource<Comment[] | undefined>,
+  )
+}
+
+/** Hoisted so the context value stays identical across renders. */
+const RELEASE_PERSPECTIVE = {releaseName: 'summer'}
+
+function Wrapper({children}: {children: React.ReactNode}) {
+  return (
+    <ResourceProvider projectId="p" dataset="d" fallback={<p>Loading…</p>}>
+      <ResourcesContext.Provider value={{other: {projectId: 'p2', dataset: 'd2'}}}>
+        <Suspense fallback={<p data-testid="suspended">Suspended</p>}>{children}</Suspense>
+      </ResourcesContext.Provider>
+    </ResourceProvider>
+  )
+}
+
+function PerspectiveWrapper({children}: {children: React.ReactNode}) {
+  return (
+    <ResourceProvider
+      projectId="p"
+      dataset="d"
+      perspective={RELEASE_PERSPECTIVE}
+      fallback={<p>Loading…</p>}
+    >
+      <Suspense fallback={<p data-testid="suspended">Suspended</p>}>{children}</Suspense>
+    </ResourceProvider>
+  )
+}
+
+describe('useComments', () => {
+  beforeEach(() => {
+    vi.resetAllMocks()
+  })
+
+  it('renders the comments once they are loaded', () => {
+    const loaded = [comment('a'), comment('b')]
+    mockSource(() => loaded)
+
+    function TestComponent() {
+      const {comments, isPending} = useComments(HANDLE)
+      return <div data-testid="out">{`${comments.length} ${isPending ? 'pending' : 'idle'}`}</div>
+    }
+
+    render(<TestComponent />, {wrapper: Wrapper})
+
+    expect(screen.getByTestId('out').textContent).toBe('2 idle')
+  })
+
+  it('suspends until the first snapshot arrives', async () => {
+    const loaded = [comment('a')]
+    const ref: {current: Comment[] | undefined} = {current: undefined}
+    const changed$ = new Subject<void>()
+    mockSource(() => ref.current, changed$)
+
+    let settle: () => void = () => {}
+    vi.mocked(resolveComments).mockReturnValue(
+      new Promise<Comment[]>((resolve) => {
+        settle = () => resolve(loaded)
+      }),
+    )
+
+    function TestComponent() {
+      const {comments} = useComments(HANDLE)
+      return <div data-testid="out">{comments.length}</div>
+    }
+
+    render(<TestComponent />, {wrapper: Wrapper})
+    expect(screen.getByTestId('suspended')).toBeInTheDocument()
+
+    await act(async () => {
+      ref.current = loaded
+      settle()
+    })
+
+    expect(screen.getByTestId('out').textContent).toBe('1')
+  })
+
+  it('passes the field path and status through to the store', () => {
+    const loaded: Comment[] = []
+    mockSource(() => loaded)
+
+    function TestComponent() {
+      useComments({...HANDLE, fieldPath: ['body', {_key: 'intro'}], status: 'resolved'})
+      return null
+    }
+
+    render(<TestComponent />, {wrapper: Wrapper})
+
+    expect(getCommentsState).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({
+        documentId: 'doc-1',
+        fieldPath: 'body[_key=="intro"]',
+        status: 'resolved',
+        resource: {projectId: 'p', dataset: 'd'},
+      }),
+    )
+  })
+
+  it('resolves a named resource from context', () => {
+    const loaded: Comment[] = []
+    mockSource(() => loaded)
+
+    function TestComponent() {
+      useComments({...HANDLE, resourceName: 'other'})
+      return null
+    }
+
+    render(<TestComponent />, {wrapper: Wrapper})
+
+    expect(getCommentsState).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({resource: {projectId: 'p2', dataset: 'd2'}}),
+    )
+  })
+
+  it('fills in the perspective from context', () => {
+    // Core turns a release perspective into `target.documentVersionId` and into
+    // the key the list is stored under, so dropping it here would read and
+    // write the wrong release with nothing to show that anything went wrong.
+    const loaded: Comment[] = []
+    mockSource(() => loaded)
+
+    function TestComponent() {
+      useComments(HANDLE)
+      return null
+    }
+
+    render(<TestComponent />, {wrapper: PerspectiveWrapper})
+
+    expect(getCommentsState).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({perspective: RELEASE_PERSPECTIVE}),
+    )
+  })
+
+  it('keeps the previous list on screen while a different document loads', async () => {
+    const first = [comment('a')]
+    const second = [comment('b'), comment('c')]
+    // Only `doc-1` is loaded, so switching to `doc-2` has to suspend.
+    const byDocument: Record<string, Comment[] | undefined> = {'doc-1': first}
+    mockSource((options) => byDocument[options.documentId])
+
+    let settle: () => void = () => {}
+    vi.mocked(resolveComments).mockReturnValue(
+      new Promise<Comment[]>((resolve) => {
+        settle = () => resolve(second)
+      }),
+    )
+
+    function TestComponent({documentId}: {documentId: string}) {
+      const {comments, isPending} = useComments({...HANDLE, documentId})
+      return <div data-testid="out">{`${comments.length} ${isPending ? 'pending' : 'idle'}`}</div>
+    }
+
+    const {rerender} = render(<TestComponent documentId="doc-1" />, {wrapper: Wrapper})
+    expect(screen.getByTestId('out').textContent).toBe('1 idle')
+
+    await act(async () => {
+      rerender(<TestComponent documentId="doc-2" />)
+    })
+
+    // The swap happens inside a transition, so the render that suspends is
+    // thrown away rather than falling back: `doc-1` stays on screen and
+    // `isPending` is what reports the switch.
+    expect(screen.queryByTestId('suspended')).not.toBeInTheDocument()
+    expect(screen.getByTestId('out').textContent).toBe('1 pending')
+    expect(getCommentsState).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({documentId: 'doc-2'}),
+    )
+
+    await act(async () => {
+      byDocument['doc-2'] = second
+      settle()
+    })
+
+    expect(screen.getByTestId('out').textContent).toBe('2 idle')
+  })
+})

package/src/hooks/comments/useComments.ts

@@ -0,0 +1,59 @@
+import {type Comment, type CommentsOptions, getCommentsState, resolveComments} from '@sanity/sdk'
+import {useMemo} from 'react'
+
+import {type WithResourceNameSupport} from '../helpers/useNormalizedResourceOptions'
+import {type CommentListSource, useCommentList} from './useCommentList'
+
+/**
+ * @public
+ * @category Types
+ */
+export interface UseCommentsResult {
+  /** Every matching comment, newest first, replies included. */
+  comments: Comment[]
+  /** True while switching to a different document or filter. */
+  isPending: boolean
+}
+
+const SOURCE: CommentListSource<Comment[]> = {
+  getState: getCommentsState,
+  resolve: resolveComments,
+}
+
+/**
+ * Reads a document's comments and keeps them up to date.
+ *
+ * Comments are shared with the Studio: they live in the project's comments
+ * dataset, so a thread started here shows up there and the other way round. The
+ * list is flat, replies included; reach for {@link useCommentThreads} to read it
+ * grouped.
+ *
+ * Suspends until the comments have loaded. Switching document or filter is a
+ * transition, so the previous list stays on screen and `isPending` goes true
+ * rather than the component suspending again.
+ *
+ * @category Comments
+ * @function
+ * @param options - The document to read, optionally narrowed by `fieldPath` or `status`
+ * @returns The matching comments, and whether a switch is in flight
+ *
+ * @example Count the open threads on a field
+ * ```tsx
+ * function TitleCommentCount({documentId}: {documentId: string}) {
+ *   const {comments} = useComments({
+ *     documentId,
+ *     documentType: 'article',
+ *     fieldPath: 'title',
+ *     status: 'open',
+ *   })
+ *
+ *   return <span>{comments.length}</span>
+ * }
+ * ```
+ *
+ * @public
+ */
+export function useComments(options: WithResourceNameSupport<CommentsOptions>): UseCommentsResult {
+  const {value, isPending} = useCommentList('useComments', options, SOURCE)
+  return useMemo(() => ({comments: value, isPending}), [isPending, value])
+}

package/src/hooks/context/useResource.test.tsx

@@ -0,0 +1,32 @@
+import {renderHook as reactRenderHook} from '@testing-library/react'
+import {type ReactNode} from 'react'
+import {describe, expect, it} from 'vitest'
+
+import {renderHook} from '../../../test/test-utils'
+import {ResourceProvider} from '../../context/ResourceProvider'
+import {useResource} from './useResource'
+
+describe('useResource', () => {
+  it('returns the resource from the instance config when no explicit resource is set', () => {
+    // test-utils wraps with ResourceProvider projectId="test" dataset="test"
+    const {result} = renderHook(() => useResource())
+    expect(result.current).toEqual({projectId: 'test', dataset: 'test'})
+  })
+
+  it('returns the explicit resource when ResourceProvider has a resource prop', () => {
+    const resource = {projectId: 'explicit-project', dataset: 'explicit-dataset'}
+    const {result} = reactRenderHook(() => useResource(), {
+      wrapper: ({children}: {children: ReactNode}) => (
+        <ResourceProvider resource={resource} fallback={null}>
+          {children}
+        </ResourceProvider>
+      ),
+    })
+    expect(result.current).toEqual(resource)
+  })
+
+  it('returns undefined when no resource or instance config is available', () => {
+    const {result} = reactRenderHook(() => useResource())
+    expect(result.current).toBeUndefined()
+  })
+})

package/src/hooks/context/useResource.ts

@@ -0,0 +1,24 @@
+import {type DocumentResource} from '@sanity/sdk'
+
+import {useEffectiveContextResource} from '../helpers/useNormalizedResourceOptions'
+
+/**
+ * Returns the currently active `DocumentResource` for the nearest resource context.
+ *
+ * Resolves in priority order:
+ * 1. A `resource` prop on the nearest `<ResourceProvider>`
+ * 2. The `projectId`/`dataset` from the current `SanityInstance` config
+ * 3. `undefined` when neither is available
+ *
+ * @public
+ * @category Platform
+ *
+ * @example
+ * ```tsx
+ * const resource = useResource()
+ * console.log(resource?.projectId, resource?.dataset)
+ * ```
+ */
+export function useResource(): DocumentResource | undefined {
+  return useEffectiveContextResource()
+}

package/src/hooks/context/useSanityInstance.test.tsx

@@ -16,20 +16,37 @@ describe('useSanityInstance', () => {
   }
 
   it('should return the Sanity instance from context', () => {
-    const instance = createSanityInstance()
+    // Create a Sanity instance
+    const instance = createSanityInstance({projectId: 'test-project', dataset: 'test-dataset'})
 
+    // Render the hook with the wrapper that provides the context
     const {result} = renderHook(() => useSanityInstance(), {
       wrapper: createWrapper(instance),
     })
 
+    // Check that the correct instance is returned
     expect(result.current).toBe(instance)
   })
 
   it('should throw an error if no instance is found in context', () => {
+    // Expect the hook to throw when no instance is in context
     expect(() => {
       renderHook(() => useSanityInstance(), {
         wrapper: createWrapper(null),
       })
     }).toThrow('SanityInstance context not found')
   })
+
+  it('should return the current instance when no config is provided', () => {
+    // Create a Sanity instance
+    const instance = createSanityInstance({projectId: 'gp', dataset: 'gp-ds'})
+
+    // Render the hook with the wrapper that provides the context
+    const {result} = renderHook(() => useSanityInstance(), {
+      wrapper: createWrapper(instance),
+    })
+
+    // Should return the instance
+    expect(result.current).toBe(instance)
+  })
 })

package/src/hooks/context/useSanityInstance.ts

@@ -4,21 +4,21 @@ import {useContext} from 'react'
 import {SanityInstanceContext} from '../../context/SanityInstanceContext'
 
 /**
- * Retrieves the current Sanity instance from React context.
+ * Retrieves the current Sanity instance from context
  *
  * @public
  *
  * @category Platform
- * @returns The current instance
+ * @returns The current Sanity instance
  *
  * @remarks
- * This hook accesses the nearest Sanity instance from React context,
- * provided by a `ResourceProvider` or `SanityApp`.
+ * This hook accesses the nearest Sanity instance from the React context.
+ * The hook must be used within a component wrapped by a `ResourceProvider` or `SanityApp`.
  *
  * @example Get the current instance
  * ```tsx
  * const instance = useSanityInstance()
- * console.log(instance.config)
+ * console.log(instance.config.projectId)
  * ```
  *
  * @throws Error if no SanityInstance is found in context
@@ -28,7 +28,7 @@ export const useSanityInstance = (): SanityInstance => {
 
   if (!instance) {
     throw new Error(
-      'SanityInstance context not found. Please ensure that your component is wrapped in a ResourceProvider or a SanityApp component.',
+      `SanityInstance context not found. Please ensure that your component is wrapped in a ResourceProvider or a SanityApp component.`,
     )
   }