@sanity/sdk-react 0.0.0-alpha.9 → 0.0.0-rc.1

package/src/hooks/comlink/useWindowConnection.ts

@@ -1,5 +1,6 @@
+import {type MessageData, type Node, type Status} from '@sanity/comlink'
 import {type FrameMessage, getOrCreateNode, releaseNode, type WindowMessage} from '@sanity/sdk'
-import {useCallback, useEffect, useMemo} from 'react'
+import {useCallback, useEffect, useRef} from 'react'
 
 import {useSanityInstance} from '../context/useSanityInstance'
 
@@ -17,6 +18,7 @@ export interface UseWindowConnectionOptions<TMessage extends FrameMessage> {
   name: string
   connectTo: string
   onMessage?: Record<TMessage['type'], WindowMessageHandler<TMessage>>
+  onStatus?: (status: Status) => void
 }
 
 /**
@@ -27,56 +29,94 @@ export interface WindowConnection<TMessage extends WindowMessage> {
     type: TType,
     data?: Extract<TMessage, {type: TType}>['data'],
   ) => void
+  fetch: <TResponse>(
+    type: string,
+    data?: MessageData,
+    options?: {
+      signal?: AbortSignal
+      suppressWarnings?: boolean
+      responseTimeout?: number
+    },
+  ) => Promise<TResponse>
 }
 
 /**
  * @internal
+ * Hook to wrap a Comlink node in a React hook.
+ * Our store functionality takes care of the lifecycle of the node,
+ * as well as sharing a single node between invocations if they share the same name.
+ *
+ * Generally not to be used directly, but to be used as a dependency of
+ * Comlink-powered hooks like `useManageFavorite`.
  */
 export function useWindowConnection<
   TWindowMessage extends WindowMessage,
   TFrameMessage extends FrameMessage,
->(options: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage> {
-  const {name, onMessage, connectTo} = options
+>({
+  name,
+  connectTo,
+  onMessage,
+  onStatus,
+}: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage> {
+  const nodeRef = useRef<Node<TWindowMessage, TFrameMessage> | null>(null)
+  const messageUnsubscribers = useRef<(() => void)[]>([])
   const instance = useSanityInstance()
 
-  const node = useMemo(
-    () => getOrCreateNode(instance, {name, connectTo}),
-    [instance, name, connectTo],
-  )
-
   useEffect(() => {
-    if (!onMessage) return
-
-    const unsubscribers: Array<() => void> = []
+    // the type cast is unfortunate, but the generic type of the node is not known here.
+    // We know that the node is a WindowMessage node, but not the generic types.
+    const node = getOrCreateNode(instance, {
+      name,
+      connectTo,
+    }) as unknown as Node<TWindowMessage, TFrameMessage>
+    nodeRef.current = node
 
-    Object.entries(onMessage).forEach(([type, handler]) => {
-      const unsubscribe = node.on(type, handler as WindowMessageHandler<TFrameMessage>)
-      unsubscribers.push(unsubscribe)
+    const statusUnsubscribe = node.onStatus((eventStatus) => {
+      onStatus?.(eventStatus)
     })
 
+    if (onMessage) {
+      Object.entries(onMessage).forEach(([type, handler]) => {
+        const messageUnsubscribe = node.on(type, handler as WindowMessageHandler<TFrameMessage>)
+        messageUnsubscribers.current.push(messageUnsubscribe)
+      })
+    }
+
     return () => {
-      unsubscribers.forEach((unsub) => unsub())
+      statusUnsubscribe()
+      messageUnsubscribers.current.forEach((unsubscribe) => unsubscribe())
+      messageUnsubscribers.current = []
+      releaseNode(instance, name)
+      nodeRef.current = null
     }
-  }, [node, onMessage])
+  }, [instance, name, connectTo, onMessage, onStatus])
 
   const sendMessage = useCallback(
-    <TType extends WindowMessage['type']>(
-      type: TType,
-      data?: Extract<WindowMessage, {type: TType}>['data'],
-    ) => {
-      node?.post(type, data)
+    (type: TWindowMessage['type'], data?: Extract<TWindowMessage, {type: typeof type}>['data']) => {
+      if (!nodeRef.current) {
+        throw new Error('Cannot send message before connection is established')
+      }
+      nodeRef.current.post(type, data)
     },
-    [node],
+    [],
   )
 
-  // cleanup node on unmount
-  useEffect(() => {
-    return () => {
-      releaseNode(instance, name)
-    }
-  }, [instance, name])
-
+  const fetch = useCallback(
+    <TResponse>(
+      type: string,
+      data?: MessageData,
+      fetchOptions?: {
+        responseTimeout?: number
+        signal?: AbortSignal
+        suppressWarnings?: boolean
+      },
+    ): Promise<TResponse> => {
+      return nodeRef.current?.fetch(type, data, fetchOptions ?? {}) as Promise<TResponse>
+    },
+    [],
+  )
   return {
     sendMessage,
+    fetch,
   }
 }

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

@@ -11,7 +11,7 @@ describe('useSanityInstance', () => {
 
   it('returns sanity instance when used within provider', () => {
     const wrapper = ({children}: {children: React.ReactNode}) => (
-      <SanityProvider sanityInstance={sanityInstance}>{children}</SanityProvider>
+      <SanityProvider sanityInstances={[sanityInstance]}>{children}</SanityProvider>
     )
 
     const {result} = renderHook(() => useSanityInstance(), {wrapper})

package/src/hooks/context/useSanityInstance.ts

@@ -1,23 +1,39 @@
 import {type SanityInstance} from '@sanity/sdk'
 import {useContext} from 'react'
 
-import {SanityInstanceContext} from '../../context/SanityProvider'
+import {SanityInstanceContext} from '../../context/SanityInstanceContext'
 
 /**
  * `useSanityInstance` returns the current Sanity instance from the application context.
  * This must be called from within a `SanityProvider` component.
- * @public
+ * @internal
+ *
+ * @param resourceId - The resourceId of the Sanity instance to return (optional)
  * @returns The current Sanity instance
  * @example
  * ```tsx
- * const instance = useSanityInstance()
+ * const instance = useSanityInstance('abc123.production')
  * ```
  */
-export const useSanityInstance = (): SanityInstance => {
+export const useSanityInstance = (resourceId?: string): SanityInstance => {
   const sanityInstance = useContext(SanityInstanceContext)
   if (!sanityInstance) {
     throw new Error('useSanityInstance must be called from within the SanityProvider')
   }
+  if (sanityInstance.length === 0) {
+    throw new Error('No Sanity instances found')
+  }
+  if (sanityInstance.length === 1 || !resourceId) {
+    return sanityInstance[0]
+  }
 
-  return sanityInstance
+  if (!resourceId) {
+    throw new Error('resourceId is required when there are multiple Sanity instances')
+  }
+
+  const instance = sanityInstance.find((inst) => inst.identity.resourceId === resourceId)
+  if (!instance) {
+    throw new Error(`Sanity instance with resourceId ${resourceId} not found`)
+  }
+  return instance
 }

package/src/hooks/dashboard/useNavigateToStudioDocument.ts

@@ -0,0 +1,97 @@
+import {type Status} from '@sanity/comlink'
+import {type DocumentHandle} from '@sanity/sdk'
+import {useCallback, useState} from 'react'
+
+import {useWindowConnection} from '../comlink/useWindowConnection'
+import {useStudioWorkspacesByResourceId} from './useStudioWorkspacesByResourceId'
+
+interface NavigateToResourceMessage {
+  type: 'core/v1/bridge/navigate-to-resource'
+  data: {
+    /**
+     * Resource ID
+     */
+    resourceId: string
+    /**
+     * Resource type
+     * @example 'application' | 'studio'
+     */
+    resourceType: string
+    /**
+     * Path within the resource to navigate to.
+     */
+    path?: string
+  }
+}
+
+interface NavigateToStudioResult {
+  navigateToStudioDocument: () => void
+  isConnected: boolean
+}
+
+/**
+ * @public
+ * Hook that provides a function to navigate to a studio document.
+ * @param documentHandle - The document handle containing document ID, type, and resource ID
+ * @returns An object containing:
+ * - navigateToStudioDocument - Function that when called will navigate to the studio document
+ * - isConnected - Boolean indicating if connection to Core UI is established
+ */
+export function useNavigateToStudioDocument(
+  documentHandle: DocumentHandle,
+): NavigateToStudioResult {
+  const {workspacesByResourceId, isConnected: workspacesConnected} =
+    useStudioWorkspacesByResourceId()
+  const [status, setStatus] = useState<Status>('idle')
+  const {sendMessage} = useWindowConnection<NavigateToResourceMessage, never>({
+    name: 'core/nodes/sdk',
+    connectTo: 'core/channels/sdk',
+    onStatus: setStatus,
+  })
+
+  const navigateToStudioDocument = useCallback(() => {
+    if (!workspacesConnected || status !== 'connected' || !documentHandle.resourceId) {
+      return
+    }
+
+    // Extract projectId and dataset from the resourceId (current format: document:projectId.dataset:documentId)
+    const [, projectAndDataset] = documentHandle.resourceId.split(':')
+    const [projectId, dataset] = projectAndDataset.split('.')
+    if (!projectId || !dataset) {
+      return
+    }
+
+    // Find the workspace for this document
+    const workspaces = workspacesByResourceId[`${projectId}:${dataset}`]
+    if (!workspaces?.length) {
+      // eslint-disable-next-line no-console
+      console.warn('No workspace found for document', documentHandle.resourceId)
+      return
+    }
+
+    if (workspaces.length > 1) {
+      // eslint-disable-next-line no-console
+      console.warn('Multiple workspaces found for document', documentHandle.resourceId)
+      // eslint-disable-next-line no-console
+      console.warn('Using the first one', workspaces[0])
+    }
+
+    const workspace = workspaces[0]
+
+    const message: NavigateToResourceMessage = {
+      type: 'core/v1/bridge/navigate-to-resource',
+      data: {
+        resourceId: workspace._ref,
+        resourceType: 'studio',
+        path: `/intent/edit/id=${documentHandle._id};type=${documentHandle._type}`,
+      },
+    }
+
+    sendMessage(message.type, message.data)
+  }, [documentHandle, workspacesConnected, status, sendMessage, workspacesByResourceId])
+
+  return {
+    navigateToStudioDocument,
+    isConnected: workspacesConnected && status === 'connected',
+  }
+}

package/src/hooks/dashboard/useStudioWorkspacesByResourceId.test.tsx

@@ -0,0 +1,274 @@
+import {type Message, type Status} from '@sanity/comlink'
+import {renderHook, waitFor} from '@testing-library/react'
+import {describe, expect, it, vi} from 'vitest'
+
+import {useWindowConnection, type WindowConnection} from '../comlink/useWindowConnection'
+import {useStudioWorkspacesByResourceId} from './useStudioWorkspacesByResourceId'
+
+vi.mock('../comlink/useWindowConnection', () => ({
+  useWindowConnection: vi.fn(),
+}))
+
+const mockWorkspaceData = {
+  context: {
+    availableResources: [
+      {
+        projectId: 'project1',
+        workspaces: [
+          {
+            name: 'workspace1',
+            title: 'Workspace 1',
+            basePath: '/workspace1',
+            dataset: 'dataset1',
+            userApplicationId: 'user1',
+            url: 'https://test.sanity.studio',
+            _ref: 'user1-workspace1',
+          },
+          {
+            name: 'workspace2',
+            title: 'Workspace 2',
+            basePath: '/workspace2',
+            dataset: 'dataset1',
+            userApplicationId: 'user1',
+            url: 'https://test.sanity.studio',
+            _ref: 'user1-workspace2',
+          },
+        ],
+      },
+      {
+        projectId: 'project2',
+        workspaces: [
+          {
+            name: 'workspace3',
+            title: 'Workspace 3',
+            basePath: '/workspace3',
+            dataset: 'dataset2',
+            userApplicationId: 'user2',
+            url: 'https://test.sanity.studio',
+            _ref: 'user2-workspace3',
+          },
+        ],
+      },
+      {
+        // Project without workspaces
+        projectId: 'project3',
+        workspaces: [],
+      },
+    ],
+  },
+}
+
+describe('useStudioWorkspacesByResourceId', () => {
+  it('should return empty workspaces and connected=false when not connected', async () => {
+    // Create a mock that captures the onStatus callback
+    let capturedOnStatus: ((status: Status) => void) | undefined
+
+    vi.mocked(useWindowConnection).mockImplementation(({onStatus}) => {
+      capturedOnStatus = onStatus
+
+      return {
+        fetch: undefined,
+        sendMessage: vi.fn(),
+      } as unknown as WindowConnection<Message>
+    })
+
+    const {result} = renderHook(() => useStudioWorkspacesByResourceId())
+
+    // Call onStatus with 'idle' to simulate not connected
+    if (capturedOnStatus) capturedOnStatus('idle')
+
+    expect(result.current).toEqual({
+      workspacesByResourceId: {},
+      error: null,
+      isConnected: false,
+    })
+  })
+
+  it('should process workspaces into lookup by projectId:dataset', async () => {
+    const mockFetch = vi.fn().mockResolvedValue(mockWorkspaceData)
+    let capturedOnStatus: ((status: Status) => void) | undefined
+
+    vi.mocked(useWindowConnection).mockImplementation(({onStatus}) => {
+      capturedOnStatus = onStatus
+
+      return {
+        fetch: mockFetch,
+        sendMessage: vi.fn(),
+      } as unknown as WindowConnection<Message>
+    })
+
+    const {result} = renderHook(() => useStudioWorkspacesByResourceId())
+
+    // Call onStatus with 'connected' to simulate connected state
+    if (capturedOnStatus) capturedOnStatus('connected')
+
+    await waitFor(() => {
+      expect(result.current.workspacesByResourceId).toEqual({
+        'project1:dataset1': [
+          {
+            name: 'workspace1',
+            title: 'Workspace 1',
+            basePath: '/workspace1',
+            dataset: 'dataset1',
+            userApplicationId: 'user1',
+            url: 'https://test.sanity.studio',
+            _ref: 'user1-workspace1',
+          },
+          {
+            name: 'workspace2',
+            title: 'Workspace 2',
+            basePath: '/workspace2',
+            dataset: 'dataset1',
+            userApplicationId: 'user1',
+            url: 'https://test.sanity.studio',
+            _ref: 'user1-workspace2',
+          },
+        ],
+        'project2:dataset2': [
+          {
+            name: 'workspace3',
+            title: 'Workspace 3',
+            basePath: '/workspace3',
+            dataset: 'dataset2',
+            userApplicationId: 'user2',
+            url: 'https://test.sanity.studio',
+            _ref: 'user2-workspace3',
+          },
+        ],
+      })
+      expect(result.current.error).toBeNull()
+      expect(result.current.isConnected).toBe(true)
+    })
+
+    expect(mockFetch).toHaveBeenCalledWith('core/v1/bridge/context', undefined, expect.any(Object))
+  })
+
+  it('should handle fetch errors', async () => {
+    const mockFetch = vi.fn().mockRejectedValue(new Error('Failed to fetch'))
+    let capturedOnStatus: ((status: Status) => void) | undefined
+
+    vi.mocked(useWindowConnection).mockImplementation(({onStatus}) => {
+      capturedOnStatus = onStatus
+
+      return {
+        fetch: mockFetch,
+        sendMessage: vi.fn(),
+      } as unknown as WindowConnection<Message>
+    })
+
+    const {result} = renderHook(() => useStudioWorkspacesByResourceId())
+
+    // Call onStatus with 'connected' to simulate connected state
+    if (capturedOnStatus) capturedOnStatus('connected')
+
+    await waitFor(() => {
+      expect(result.current.workspacesByResourceId).toEqual({})
+      expect(result.current.error).toBe('Failed to fetch workspaces')
+      expect(result.current.isConnected).toBe(true)
+    })
+  })
+
+  it('should handle AbortError silently', async () => {
+    const abortError = new Error('Aborted')
+    abortError.name = 'AbortError'
+    const mockFetch = vi.fn().mockRejectedValue(abortError)
+    let capturedOnStatus: ((status: Status) => void) | undefined
+
+    vi.mocked(useWindowConnection).mockImplementation(({onStatus}) => {
+      capturedOnStatus = onStatus
+
+      return {
+        fetch: mockFetch,
+        sendMessage: vi.fn(),
+      } as unknown as WindowConnection<Message>
+    })
+
+    const {result} = renderHook(() => useStudioWorkspacesByResourceId())
+
+    // Call onStatus with 'connected' to simulate connected state
+    if (capturedOnStatus) capturedOnStatus('connected')
+
+    await waitFor(() => {
+      expect(result.current.workspacesByResourceId).toEqual({})
+      expect(result.current.error).toBeNull()
+      expect(result.current.isConnected).toBe(true)
+    })
+  })
+
+  it('should handle projects without workspaces', async () => {
+    const mockFetch = vi.fn().mockResolvedValue({
+      context: {
+        availableResources: [
+          {
+            projectId: 'project1',
+            workspaces: [],
+          },
+        ],
+      },
+    })
+    let capturedOnStatus: ((status: Status) => void) | undefined
+
+    vi.mocked(useWindowConnection).mockImplementation(({onStatus}) => {
+      capturedOnStatus = onStatus
+
+      return {
+        fetch: mockFetch,
+        sendMessage: vi.fn(),
+      } as unknown as WindowConnection<Message>
+    })
+
+    const {result} = renderHook(() => useStudioWorkspacesByResourceId())
+
+    // Call onStatus with 'connected' to simulate connected state
+    if (capturedOnStatus) capturedOnStatus('connected')
+
+    await waitFor(() => {
+      expect(result.current.workspacesByResourceId).toEqual({})
+      expect(result.current.error).toBeNull()
+      expect(result.current.isConnected).toBe(true)
+    })
+  })
+
+  it('should handle projects without projectId', async () => {
+    const mockFetch = vi.fn().mockResolvedValue({
+      context: {
+        availableResources: [
+          {
+            workspaces: [
+              {
+                name: 'workspace1',
+                title: 'Workspace 1',
+                basePath: '/workspace1',
+                dataset: 'dataset1',
+                userApplicationId: 'user1',
+                url: 'https://test.sanity.studio',
+                _ref: 'user1-workspace1',
+              },
+            ],
+          },
+        ],
+      },
+    })
+    let capturedOnStatus: ((status: Status) => void) | undefined
+
+    vi.mocked(useWindowConnection).mockImplementation(({onStatus}) => {
+      capturedOnStatus = onStatus
+
+      return {
+        fetch: mockFetch,
+        sendMessage: vi.fn(),
+      } as unknown as WindowConnection<Message>
+    })
+
+    const {result} = renderHook(() => useStudioWorkspacesByResourceId())
+
+    // Call onStatus with 'connected' to simulate connected state
+    if (capturedOnStatus) capturedOnStatus('connected')
+
+    await waitFor(() => {
+      expect(result.current.workspacesByResourceId).toEqual({})
+      expect(result.current.error).toBeNull()
+      expect(result.current.isConnected).toBe(true)
+    })
+  })
+})

package/src/hooks/dashboard/useStudioWorkspacesByResourceId.ts

@@ -0,0 +1,91 @@
+import {type Status} from '@sanity/comlink'
+import {useEffect, useState} from 'react'
+
+import {useWindowConnection} from '../comlink/useWindowConnection'
+
+interface Workspace {
+  name: string
+  title: string
+  basePath: string
+  dataset: string
+  userApplicationId: string
+  url: string
+  _ref: string
+}
+
+interface WorkspacesByResourceId {
+  [key: string]: Workspace[] // key format: `${projectId}:${dataset}`
+}
+
+interface StudioWorkspacesResult {
+  workspacesByResourceId: WorkspacesByResourceId
+  error: string | null
+  isConnected: boolean
+}
+
+/**
+ * Hook that fetches studio workspaces and organizes them by projectId:dataset
+ * @internal
+ */
+export function useStudioWorkspacesByResourceId(): StudioWorkspacesResult {
+  const [workspacesByResourceId, setWorkspacesByResourceId] = useState<WorkspacesByResourceId>({})
+  const [status, setStatus] = useState<Status>('idle')
+  const [error, setError] = useState<string | null>(null)
+
+  const {fetch} = useWindowConnection({
+    name: 'core/nodes/sdk',
+    connectTo: 'core/channels/sdk',
+    onStatus: setStatus,
+  })
+
+  // Once computed, this should probably be in a store and poll for changes
+  // However, our stores are currently being refactored
+  useEffect(() => {
+    if (!fetch || status !== 'connected') return
+
+    async function fetchWorkspaces(signal: AbortSignal) {
+      try {
+        const data = await fetch<{
+          context: {availableResources: Array<{projectId: string; workspaces: Workspace[]}>}
+        }>('core/v1/bridge/context', undefined, {signal})
+
+        const workspaceMap: WorkspacesByResourceId = {}
+
+        data.context.availableResources.forEach((resource) => {
+          if (!resource.projectId || !resource.workspaces?.length) return
+
+          resource.workspaces.forEach((workspace) => {
+            const key = `${resource.projectId}:${workspace.dataset}`
+            if (!workspaceMap[key]) {
+              workspaceMap[key] = []
+            }
+            workspaceMap[key].push(workspace)
+          })
+        })
+
+        setWorkspacesByResourceId(workspaceMap)
+        setError(null)
+      } catch (err: unknown) {
+        if (err instanceof Error) {
+          if (err.name === 'AbortError') {
+            return
+          }
+          setError('Failed to fetch workspaces')
+        }
+      }
+    }
+
+    const controller = new AbortController()
+    fetchWorkspaces(controller.signal)
+
+    return () => {
+      controller.abort()
+    }
+  }, [fetch, status])
+
+  return {
+    workspacesByResourceId,
+    error,
+    isConnected: status === 'connected',
+  }
+}

package/src/hooks/datasets/useDatasets.ts

@@ -0,0 +1,37 @@
+import {type DatasetsResponse} from '@sanity/client'
+import {getDatasetsState, resolveDatasets, type SanityInstance, type StateSource} from '@sanity/sdk'
+
+import {createStateSourceHook} from '../helpers/createStateSourceHook'
+
+type UseDatasets = {
+  /**
+   *
+   * Returns metadata for each dataset in your organization.
+   *
+   * @category Datasets
+   * @returns The metadata for your organization's datasets
+   *
+   * @example
+   * ```tsx
+   * const datasets = useDatasets()
+   *
+   * return (
+   *   <select>
+   *     {datasets.map((dataset) => (
+   *       <option key={dataset.name}>{dataset.name}</option>
+   *     ))}
+   *   </select>
+   * )
+   * ```
+   *
+   */
+  (): DatasetsResponse
+}
+
+/** @public */
+export const useDatasets: UseDatasets = createStateSourceHook({
+  // remove `undefined` since we're suspending when that is the case
+  getState: getDatasetsState as (instance: SanityInstance) => StateSource<DatasetsResponse>,
+  shouldSuspend: (instance) => getDatasetsState(instance).getCurrent() === undefined,
+  suspender: resolveDatasets,
+})