fix(deps): update message-protocol to 0.7.0 (#379)

Author: binoy14

packages/react/package.json

@@ -56,7 +56,7 @@
   "prettier": "@sanity/prettier-config",
   "dependencies": {
     "@sanity/logos": "^2.1.13",
-    "@sanity/message-protocol": "^0.6.0",
+    "@sanity/message-protocol": "^0.7.0",
     "@sanity/sdk": "workspace:*",
     "@sanity/types": "^3.78.1",
     "@types/lodash-es": "^4.17.12",

packages/react/src/hooks/comlink/useManageFavorite.test.ts

@@ -57,11 +57,15 @@ describe('useManageFavorite', () => {
     })
 
     expect(node.post).toHaveBeenCalledWith('dashboard/v1/events/favorite/mutate', {
-      documentId: 'mock-id',
-      documentType: 'mock-type',
+      document: {
+        id: 'mock-id',
+        type: 'mock-type',
+        resource: {
+          id: 'test.test',
+          type: 'studio',
+        },
+      },
       eventType: 'added',
-      resourceType: 'studio',
-      resourceId: undefined,
     })
     expect(result.current.isFavorited).toBe(true)
   })
@@ -74,11 +78,15 @@ describe('useManageFavorite', () => {
     })
 
     expect(node.post).toHaveBeenCalledWith('dashboard/v1/events/favorite/mutate', {
-      documentId: 'mock-id',
-      documentType: 'mock-type',
+      document: {
+        id: 'mock-id',
+        type: 'mock-type',
+        resource: {
+          id: 'test.test',
+          type: 'studio',
+        },
+      },
       eventType: 'removed',
-      resourceType: 'studio',
-      resourceId: undefined,
     })
     expect(result.current.isFavorited).toBe(false)
   })

packages/react/src/hooks/comlink/useManageFavorite.ts

@@ -8,8 +8,9 @@ import {
   type StudioResource,
 } from '@sanity/message-protocol'
 import {type DocumentHandle, type FrameMessage} from '@sanity/sdk'
-import {useCallback, useState} from 'react'
+import {useCallback, useEffect, useState} from 'react'
 
+import {useSanityInstance} from '../context/useSanityInstance'
 import {useWindowConnection} from './useWindowConnection'
 
 // should we import this whole type from the message protocol?
@@ -62,21 +63,43 @@ interface UseManageFavoriteProps extends DocumentHandle {
 export function useManageFavorite({
   documentId,
   documentType,
-  resourceId,
+  projectId: paramProjectId,
+  dataset: paramDataset,
+  resourceId: paramResourceId,
   resourceType,
 }: UseManageFavoriteProps): ManageFavorite {
   const [isFavorited, setIsFavorited] = useState(false) // should load this from a comlink fetch
   const [status, setStatus] = useState<Status>('idle')
+  const [resourceId, setResourceId] = useState<string>(paramResourceId || '')
   const {sendMessage} = useWindowConnection<Events.FavoriteMessage, FrameMessage>({
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME,
     onStatus: setStatus,
   })
+  const instance = useSanityInstance()
+  const {config} = instance
+  const instanceProjectId = config?.projectId
+  const instanceDataset = config?.dataset
+  const projectId = paramProjectId ?? instanceProjectId
+  const dataset = paramDataset ?? instanceDataset
 
-  if (resourceType !== 'studio' && !resourceId) {
-    throw new Error('resourceId is required for media-library and canvas resources')
+  if (resourceType === 'studio' && (!projectId || !dataset)) {
+    throw new Error('projectId and dataset are required for studio resources')
   }
 
+  useEffect(() => {
+    // If resourceType is studio and the resourceId is not provided,
+    // use the projectId and dataset to generate a resourceId
+    if (resourceType === 'studio' && !paramResourceId) {
+      setResourceId(`${projectId}.${dataset}`)
+    } else if (paramResourceId) {
+      setResourceId(paramResourceId)
+    } else {
+      // For other resource types, resourceId is required
+      throw new Error('resourceId is required for media-library and canvas resources')
+    }
+  }, [resourceType, paramResourceId, projectId, dataset])
+
   const handleFavoriteAction = useCallback(
     (action: 'added' | 'removed', setFavoriteState: boolean) => {
       if (!documentId || !documentType || !resourceType) return
@@ -86,11 +109,14 @@ export function useManageFavorite({
           type: 'dashboard/v1/events/favorite/mutate',
           data: {
             eventType: action,
-            documentId,
-            documentType,
-            resourceType,
-            // Resource Id should exist for media-library and canvas resources
-            resourceId: resourceId!,
+            document: {
+              id: documentId,
+              type: documentType,
+              resource: {
+                id: resourceId,
+                type: resourceType,
+              },
+            },
           },
           response: {
             success: true,

packages/react/src/hooks/comlink/useRecordDocumentHistoryEvent.test.ts

@@ -62,10 +62,14 @@ describe('useRecordDocumentHistoryEvent', () => {
 
     expect(node.post).toHaveBeenCalledWith('dashboard/v1/events/history', {
       eventType: 'viewed',
-      documentId: 'mock-id',
-      documentType: 'mock-type',
-      resourceType: 'studio',
-      resourceId: 'mock-resource-id',
+      document: {
+        id: 'mock-id',
+        type: 'mock-type',
+        resource: {
+          id: 'mock-resource-id',
+          type: 'studio',
+        },
+      },
     })
   })
 

packages/react/src/hooks/comlink/useRecordDocumentHistoryEvent.ts

@@ -80,10 +80,14 @@ export function useRecordDocumentHistoryEvent({
           type: 'dashboard/v1/events/history',
           data: {
             eventType,
-            documentId,
-            documentType,
-            resourceType,
-            resourceId: resourceId!,
+            document: {
+              id: documentId,
+              type: documentType,
+              resource: {
+                id: resourceId!,
+                type: resourceType,
+              },
+            },
           },
         }