@sanity/sdk-react 0.0.0-alpha.2 → 0.0.0-alpha.21

package/src/hooks/comlink/useManageFavorite.ts

@@ -0,0 +1,130 @@
+import {type Status} from '@sanity/comlink'
+import {
+  type CanvasResource,
+  type Events,
+  type MediaResource,
+  SDK_CHANNEL_NAME,
+  SDK_NODE_NAME,
+  type StudioResource,
+} from '@sanity/message-protocol'
+import {type FrameMessage} from '@sanity/sdk'
+import {useCallback, useState} from 'react'
+
+import {useWindowConnection} from './useWindowConnection'
+
+// should we import this whole type from the message protocol?
+
+interface ManageFavorite {
+  favorite: () => void
+  unfavorite: () => void
+  isFavorited: boolean
+  isConnected: boolean
+}
+
+interface UseManageFavoriteProps {
+  documentId: string
+  documentType: string
+  resourceId?: string
+  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type']
+}
+
+/**
+ * @beta
+ *
+ * ## useManageFavorite
+ * This hook provides functionality to add and remove documents from favorites,
+ * and tracks the current favorite status of the document.
+ * @category Dashboard Communication
+ * @param documentHandle - The document handle containing document ID and type, like `{_id: '123', _type: 'book'}`
+ * @returns An object containing:
+ * - `favorite` - Function to add document to favorites
+ * - `unfavorite` - Function to remove document from favorites
+ * - `isFavorited` - Boolean indicating if document is currently favorited
+ * - `isConnected` - Boolean indicating if connection to Dashboard UI is established
+ *
+ * @example
+ * ```tsx
+ * function MyDocumentAction(props: DocumentActionProps) {
+ *   const {documentId, documentType} = props
+ *   const {favorite, unfavorite, isFavorited, isConnected} = useManageFavorite({
+ *     documentId,
+ *     documentType
+ *   })
+ *
+ *   return (
+ *     <Button
+ *       disabled={!isConnected}
+ *       onClick={() => isFavorited ? unfavorite() : favorite()}
+ *       text={isFavorited ? 'Remove from favorites' : 'Add to favorites'}
+ *     />
+ *   )
+ * }
+ * ```
+ */
+export function useManageFavorite({
+  documentId,
+  documentType,
+  resourceId,
+  resourceType,
+}: UseManageFavoriteProps): ManageFavorite {
+  const [isFavorited, setIsFavorited] = useState(false) // should load this from a comlink fetch
+  const [status, setStatus] = useState<Status>('idle')
+  const {sendMessage} = useWindowConnection<Events.FavoriteMessage, FrameMessage>({
+    name: SDK_NODE_NAME,
+    connectTo: SDK_CHANNEL_NAME,
+    onStatus: setStatus,
+  })
+
+  if (resourceType !== 'studio' && !resourceId) {
+    throw new Error('resourceId is required for media-library and canvas resources')
+  }
+
+  const handleFavoriteAction = useCallback(
+    (action: 'added' | 'removed', setFavoriteState: boolean) => {
+      if (!documentId || !documentType || !resourceType) return
+
+      try {
+        const message: Events.FavoriteMessage = {
+          type: 'dashboard/v1/events/favorite/mutate',
+          data: {
+            eventType: action,
+            documentId,
+            documentType,
+            resourceType,
+            // Resource Id should exist for media-library and canvas resources
+            resourceId: resourceId!,
+          },
+          response: {
+            success: true,
+          },
+        }
+
+        sendMessage(message.type, message.data)
+        setIsFavorited(setFavoriteState)
+      } catch (err) {
+        const error = err instanceof Error ? err : new Error('Failed to update favorite status')
+        // eslint-disable-next-line no-console
+        console.error(
+          `Failed to ${action === 'added' ? 'favorite' : 'unfavorite'} document:`,
+          error,
+        )
+        throw error
+      }
+    },
+    [documentId, documentType, resourceId, resourceType, sendMessage],
+  )
+
+  const favorite = useCallback(() => handleFavoriteAction('added', true), [handleFavoriteAction])
+
+  const unfavorite = useCallback(
+    () => handleFavoriteAction('removed', false),
+    [handleFavoriteAction],
+  )
+
+  return {
+    favorite,
+    unfavorite,
+    isFavorited,
+    isConnected: status === 'connected',
+  }
+}

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

@@ -0,0 +1,81 @@
+import {type Message, type Node, type Status} from '@sanity/comlink'
+import {getOrCreateNode} from '@sanity/sdk'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {act, renderHook} from '../../../test/test-utils'
+import {useRecordDocumentHistoryEvent} from './useRecordDocumentHistoryEvent'
+
+vi.mock(import('@sanity/sdk'), async (importOriginal) => {
+  const actual = await importOriginal()
+  return {
+    ...actual,
+    getOrCreateNode: vi.fn(),
+    releaseNode: vi.fn(),
+  }
+})
+
+describe('useRecordDocumentHistoryEvent', () => {
+  let node: Node<Message, Message>
+  let statusCallback: ((status: Status) => void) | null = null
+
+  const mockDocumentHandle = {
+    documentId: 'mock-id',
+    documentType: 'mock-type',
+    resourceType: 'studio' as const,
+    resourceId: 'mock-resource-id',
+  }
+
+  function createMockNode() {
+    return {
+      on: vi.fn(() => () => {}),
+      post: vi.fn(),
+      stop: vi.fn(),
+      onStatus: vi.fn((callback) => {
+        statusCallback = callback
+        return () => {}
+      }),
+    } as unknown as Node<Message, Message>
+  }
+
+  beforeEach(() => {
+    statusCallback = null
+    node = createMockNode()
+    vi.mocked(getOrCreateNode).mockReturnValue(node)
+  })
+
+  it('should initialize with correct connection status', () => {
+    const {result} = renderHook(() => useRecordDocumentHistoryEvent(mockDocumentHandle))
+
+    expect(result.current.isConnected).toBe(false)
+
+    act(() => {
+      statusCallback?.('connected')
+    })
+
+    expect(result.current.isConnected).toBe(true)
+  })
+
+  it('should send correct message when recording events', () => {
+    const {result} = renderHook(() => useRecordDocumentHistoryEvent(mockDocumentHandle))
+
+    result.current.recordEvent('viewed')
+
+    expect(node.post).toHaveBeenCalledWith('dashboard/v1/events/history', {
+      eventType: 'viewed',
+      documentId: 'mock-id',
+      documentType: 'mock-type',
+      resourceType: 'studio',
+      resourceId: 'mock-resource-id',
+    })
+  })
+
+  it('should handle errors when sending messages', () => {
+    vi.mocked(node.post).mockImplementation(() => {
+      throw new Error('Failed to send message')
+    })
+
+    const {result} = renderHook(() => useRecordDocumentHistoryEvent(mockDocumentHandle))
+
+    expect(() => result.current.recordEvent('viewed')).toThrow('Failed to send message')
+  })
+})

package/src/hooks/comlink/useRecordDocumentHistoryEvent.ts

@@ -0,0 +1,106 @@
+import {type Status} from '@sanity/comlink'
+import {
+  type CanvasResource,
+  type Events,
+  type MediaResource,
+  SDK_CHANNEL_NAME,
+  SDK_NODE_NAME,
+  type StudioResource,
+} from '@sanity/message-protocol'
+import {type FrameMessage} from '@sanity/sdk'
+import {useCallback, useState} from 'react'
+
+import {useWindowConnection} from './useWindowConnection'
+
+interface DocumentInteractionHistory {
+  recordEvent: (eventType: 'viewed' | 'edited' | 'created' | 'deleted') => void
+  isConnected: boolean
+}
+
+/**
+ * @public
+ */
+interface UseRecordDocumentHistoryEventProps {
+  documentId: string
+  documentType: string
+  resourceType: StudioResource['type'] | MediaResource['type'] | CanvasResource['type']
+  resourceId?: string
+}
+
+/**
+ * @public
+ * Hook for managing document interaction history in Sanity Studio.
+ * This hook provides functionality to record document interactions.
+ * @category History
+ * @param documentHandle - The document handle containing document ID and type, like `{_id: '123', _type: 'book'}`
+ * @returns An object containing:
+ * - `recordEvent` - Function to record document interactions
+ * - `isConnected` - Boolean indicating if connection to Studio is established
+ *
+ * @example
+ * ```tsx
+ * function MyDocumentAction(props: DocumentActionProps) {
+ *   const {documentId, documentType, resourceType, resourceId} = props
+ *   const {recordEvent, isConnected} = useRecordDocumentHistoryEvent({
+ *     documentId,
+ *     documentType,
+ *     resourceType,
+ *     resourceId,
+ *   })
+ *
+ *   return (
+ *     <Button
+ *       disabled={!isConnected}
+ *       onClick={() => recordEvent('viewed')}
+ *       text={'Viewed'}
+ *     />
+ *   )
+ * }
+ * ```
+ */
+export function useRecordDocumentHistoryEvent({
+  documentId,
+  documentType,
+  resourceType,
+  resourceId,
+}: UseRecordDocumentHistoryEventProps): DocumentInteractionHistory {
+  const [status, setStatus] = useState<Status>('idle')
+  const {sendMessage} = useWindowConnection<Events.HistoryMessage, FrameMessage>({
+    name: SDK_NODE_NAME,
+    connectTo: SDK_CHANNEL_NAME,
+    onStatus: setStatus,
+  })
+
+  if (resourceType !== 'studio' && !resourceId) {
+    throw new Error('resourceId is required for media-library and canvas resources')
+  }
+
+  const recordEvent = useCallback(
+    (eventType: 'viewed' | 'edited' | 'created' | 'deleted') => {
+      try {
+        const message: Events.HistoryMessage = {
+          type: 'dashboard/v1/events/history',
+          data: {
+            eventType,
+            documentId,
+            documentType,
+            resourceType,
+            resourceId: resourceId!,
+          },
+        }
+
+        sendMessage(message.type, message.data)
+      } catch (error) {
+        // eslint-disable-next-line no-console
+        console.error('Failed to record history event:', error)
+        throw error
+      }
+    },
+    [documentId, documentType, resourceId, resourceType, sendMessage],
+  )
+
+  return {
+    recordEvent,
+    isConnected: status === 'connected',
+  }
+}

package/src/hooks/comlink/useWindowConnection.test.ts

@@ -0,0 +1,135 @@
+import {type Message, type Node, type Status} from '@sanity/comlink'
+import {getOrCreateNode, releaseNode} from '@sanity/sdk'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {act, renderHook} from '../../../test/test-utils'
+import {useWindowConnection} from './useWindowConnection'
+
+vi.mock(import('@sanity/sdk'), async (importOriginal) => {
+  const actual = await importOriginal()
+  return {
+    ...actual,
+    getOrCreateNode: vi.fn(),
+    createNode: vi.fn(),
+    releaseNode: vi.fn(),
+  }
+})
+interface TestMessage {
+  type: 'TEST_MESSAGE'
+  data: {someData: string}
+}
+
+interface AnotherMessage {
+  type: 'ANOTHER_MESSAGE'
+  data: {otherData: number}
+}
+
+type TestMessages = TestMessage | AnotherMessage
+
+describe('useWindowConnection', () => {
+  let node: Node<Message, Message>
+  let statusCallback: ((status: Status) => void) | null = null
+
+  function createMockNode() {
+    return {
+      // return unsubscribe function
+      on: vi.fn(() => () => {}),
+      post: vi.fn(),
+      stop: vi.fn(),
+      onStatus: vi.fn((callback) => {
+        statusCallback = callback
+        return () => {}
+      }),
+    } as unknown as Node<Message, Message>
+  }
+
+  beforeEach(() => {
+    statusCallback = null
+    node = createMockNode()
+    vi.mocked(getOrCreateNode).mockReturnValue(node as unknown as Node<Message, Message>)
+  })
+
+  it('should call onStatus callback when status changes', () => {
+    const onStatusMock = vi.fn()
+    renderHook(() =>
+      useWindowConnection<TestMessages, TestMessages>({
+        name: 'test',
+        connectTo: 'window',
+        onStatus: onStatusMock,
+      }),
+    )
+
+    act(() => {
+      statusCallback?.('connected')
+    })
+    expect(onStatusMock).toHaveBeenCalledWith('connected')
+
+    act(() => {
+      statusCallback?.('disconnected')
+    })
+    expect(onStatusMock).toHaveBeenCalledWith('disconnected')
+  })
+
+  it('should not throw if onStatus is not provided', () => {
+    renderHook(() =>
+      useWindowConnection<TestMessages, TestMessages>({
+        name: 'test',
+        connectTo: 'window',
+      }),
+    )
+
+    expect(() => {
+      act(() => {
+        statusCallback?.('connected')
+      })
+    }).not.toThrow()
+  })
+
+  it('should register message handlers', () => {
+    const mockHandler = vi.fn()
+    const mockData = {someData: 'test'}
+
+    renderHook(() =>
+      useWindowConnection<TestMessages, TestMessages>({
+        name: 'test',
+        connectTo: 'window',
+        onMessage: {
+          TEST_MESSAGE: mockHandler,
+          ANOTHER_MESSAGE: vi.fn(),
+        },
+      }),
+    )
+
+    const onCallback = vi.mocked(node.on).mock.calls[0][1]
+    onCallback(mockData)
+
+    expect(mockHandler).toHaveBeenCalledWith(mockData)
+  })
+
+  it('should send messages through the node', () => {
+    const {result} = renderHook(() =>
+      useWindowConnection<TestMessages, TestMessages>({
+        name: 'test',
+        connectTo: 'window',
+      }),
+    )
+
+    result.current.sendMessage('TEST_MESSAGE', {someData: 'test'})
+    expect(node.post).toHaveBeenCalledWith('TEST_MESSAGE', {someData: 'test'})
+
+    result.current.sendMessage('ANOTHER_MESSAGE', {otherData: 123})
+    expect(node.post).toHaveBeenCalledWith('ANOTHER_MESSAGE', {otherData: 123})
+  })
+
+  it('should cleanup on unmount', () => {
+    const {unmount} = renderHook(() =>
+      useWindowConnection<TestMessages, TestMessages>({
+        name: 'test',
+        connectTo: 'window',
+      }),
+    )
+
+    unmount()
+    expect(releaseNode).toHaveBeenCalled()
+  })
+})

package/src/hooks/comlink/useWindowConnection.ts

@@ -0,0 +1,122 @@
+import {type MessageData, type Node, type Status} from '@sanity/comlink'
+import {type FrameMessage, getOrCreateNode, releaseNode, type WindowMessage} from '@sanity/sdk'
+import {useCallback, useEffect, useRef} from 'react'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+
+/**
+ * @internal
+ */
+export type WindowMessageHandler<TFrameMessage extends FrameMessage> = (
+  event: TFrameMessage['data'],
+) => TFrameMessage['response']
+
+/**
+ * @internal
+ */
+export interface UseWindowConnectionOptions<TMessage extends FrameMessage> {
+  name: string
+  connectTo: string
+  onMessage?: Record<TMessage['type'], WindowMessageHandler<TMessage>>
+  onStatus?: (status: Status) => void
+}
+
+/**
+ * @internal
+ */
+export interface WindowConnection<TMessage extends WindowMessage> {
+  sendMessage: <TType extends TMessage['type']>(
+    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,
+>({
+  name,
+  connectTo,
+  onMessage,
+  onStatus,
+}: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage> {
+  const nodeRef = useRef<Node<TWindowMessage, TFrameMessage> | null>(null)
+  const messageUnsubscribers = useRef<(() => void)[]>([])
+  const instance = useSanityInstance()
+
+  useEffect(() => {
+    // 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
+
+    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 () => {
+      statusUnsubscribe()
+      messageUnsubscribers.current.forEach((unsubscribe) => unsubscribe())
+      messageUnsubscribers.current = []
+      releaseNode(instance, name)
+      nodeRef.current = null
+    }
+  }, [instance, name, connectTo, onMessage, onStatus])
+
+  const sendMessage = useCallback(
+    (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)
+    },
+    [],
+  )
+
+  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

@@ -3,7 +3,7 @@ import {renderHook} from '@testing-library/react'
 import React from 'react'
 import {describe, expect, it, vi} from 'vitest'
 
-import {SanityProvider} from '../../components/context/SanityProvider'
+import {SanityProvider} from '../../context/SanityProvider'
 import {useSanityInstance} from './useSanityInstance'
 
 describe('useSanityInstance', () => {
@@ -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 {type SanityInstance} from '@sanity/sdk'
 import {useContext} from 'react'
 
-import {SanityInstanceContext} from '../../components/context/SanityProvider'
+import {SanityInstanceContext} from '../../context/SanityInstanceContext'
 
 /**
- * Hook that provides the current Sanity instance from the context.
+ * `useSanityInstance` returns the current Sanity instance from the application context.
  * This must be called from within a `SanityProvider` component.
- * @public
- * @returns the current Sanity instance
+ * @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
 }