fix: use new @sanity/client/csm utils (#2540)

sanity-io · Jan 22, 2025 · e9ec432 · e9ec432
1 parent 513de90
commit e9ec432
Show file tree

Hide file tree

Showing 10 changed files with 149 additions and 145 deletions.
diff --git a/packages/visual-editing-csm/package.json b/packages/visual-editing-csm/package.json
@@ -53,14 +53,14 @@
   "devDependencies": {
     "@repo/eslint-config": "workspace:*",
     "@repo/package.config": "workspace:*",
-    "@sanity/client": "^6.25.0",
+    "@sanity/client": "^6.26.0",
     "@sanity/pkg-utils": "6.13.4",
     "eslint": "^8.57.1",
     "typescript": "5.7.3",
     "vitest": "^3.0.2"
   },
   "peerDependencies": {
-    "@sanity/client": "^6.25.0"
+    "@sanity/client": "^6.26.0"
   },
   "engines": {
     "node": ">=18"

diff --git a/packages/visual-editing-csm/src/encodeSanityNodeData.ts b/packages/visual-editing-csm/src/encodeSanityNodeData.ts
@@ -1,6 +1,5 @@
-import {getPublishedId, studioPath} from '@sanity/client/csm'
+import {getPublishedId, isDraftId, studioPath} from '@sanity/client/csm'
 import type {SanityNode} from '@sanity/visual-editing-types'
-import {DRAFTS_PREFIX} from './constants'
 import {isValidSanityNode} from './isValidSanityNode'
 import {pathToUrlString} from './pathToUrlString'
 
@@ -24,7 +23,7 @@ export function encodeSanityNodeData(node: SanityNode): string | undefined {
     ['base', encodeURIComponent(baseUrl)],
     ['workspace', workspace],
     ['tool', tool],
-    ['isDraft', _id.startsWith(DRAFTS_PREFIX)],
+    ['isDraft', isDraftId(_id)],
   ]
 
   return parts

diff --git a/packages/visual-editing/package.json b/packages/visual-editing/package.json
@@ -162,7 +162,7 @@
     "@remix-run/react": "^2.15.2",
     "@repo/eslint-config": "workspace:*",
     "@repo/package.config": "workspace:*",
-    "@sanity/client": "^6.25.0",
+    "@sanity/client": "^6.26.0",
     "@sanity/color": "^3.0.6",
     "@sanity/demo": "^2.0.0",
     "@sanity/insert-menu": "workspace:*",
@@ -201,7 +201,7 @@
   },
   "peerDependencies": {
     "@remix-run/react": ">= 2",
-    "@sanity/client": "^6.25.0",
+    "@sanity/client": "^6.26.0",
     "@sveltejs/kit": ">= 2",
     "next": ">= 13 || >=14.3.0-canary.0 <14.3.0 || >=15.0.0-rc",
     "react": "^18.3 || >=19.0.0-rc",

diff --git a/packages/visual-editing/src/react/useDocuments.ts b/packages/visual-editing/src/react/useDocuments.ts
@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import type {SanityDocument} from '@sanity/client'
+import {getDraftId, getPublishedId} from '@sanity/client/csm'
 import {createIfNotExists, patch} from '@sanity/mutate'
 import {isMaybePreviewIframe, isMaybePreviewWindow} from '@sanity/presentation-comlink'
 import {get as getAtPath} from '@sanity/util/paths'
@@ -12,7 +13,6 @@ import type {
   Path,
   PathValue,
 } from '../optimistic/types'
-import {getDraftId, getPublishedId} from '../util/documents'
 import {useOptimisticActor} from './useOptimisticActor'
 
 function debounce<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, timeout: number): F {

diff --git a/packages/visual-editing/src/react/useOptimistic.ts b/packages/visual-editing/src/react/useOptimistic.ts
@@ -1,9 +1,9 @@
+import {getPublishedId} from '@sanity/client/csm'
 import type {SanityDocument} from '@sanity/types'
 import {startTransition, useEffect, useState} from 'react'
 import {useEffectEvent} from 'use-effect-event'
 import {isEmptyActor} from '../optimistic/context'
 import type {OptimisticReducer, OptimisticReducerAction} from '../optimistic/types'
-import {getPublishedId} from '../util/documents'
 import {useOptimisticActor} from './useOptimisticActor'
 
 export function useOptimistic<T, U = SanityDocument>(

diff --git a/packages/visual-editing/src/ui/Overlays.tsx b/packages/visual-editing/src/ui/Overlays.tsx
@@ -1,4 +1,5 @@
 import type {ClientPerspective} from '@sanity/client'
+import {getDraftId, getPublishedId} from '@sanity/client/csm'
 import type {Status} from '@sanity/comlink'
 import {type VisualEditingControllerMsg} from '@sanity/presentation-comlink'
 import {
@@ -27,7 +28,6 @@ import type {
   OverlayMsg,
   VisualEditingNode,
 } from '../types'
-import {getDraftId, getPublishedId} from '../util/documents'
 import {sanityNodesExistInSameArray} from '../util/findSanityNodes'
 import {useDragEndEvents} from '../util/useDragEvents'
 import {ContextMenu} from './context-menu/ContextMenu'

diff --git a/packages/visual-editing/src/ui/useReportDocuments.ts b/packages/visual-editing/src/ui/useReportDocuments.ts
@@ -1,5 +1,5 @@
 import type {ClientPerspective, ContentSourceMapDocuments} from '@sanity/client'
-import {DRAFTS_PREFIX} from '@sanity/visual-editing-csm'
+import {getDraftId} from '@sanity/client/csm'
 import {useCallback, useEffect, useRef} from 'react'
 import type {ElementState, SanityNode, VisualEditingNode} from '../types'
 
@@ -47,7 +47,7 @@ export function useReportDocuments(
         if (!('id' in sanity)) return null
         return {
           ...sanity,
-          id: 'isDraft' in sanity ? `${DRAFTS_PREFIX}${sanity.id}` : sanity.id,
+          id: 'isDraft' in sanity ? getDraftId(sanity.id) : sanity.id,
         }
       })
       .filter((s) => !!s) as SanityNode[]

diff --git a/packages/visual-editing/src/util/documents.ts b/packages/visual-editing/src/util/documents.ts
diff --git a/packages/visual-editing/svelte/optimistic/useOptimistic.ts b/packages/visual-editing/svelte/optimistic/useOptimistic.ts
@@ -1,5 +1,5 @@
+import {getPublishedId} from '@sanity/client/csm'
 import type {SanityDocument} from '@sanity/types'
-import {DRAFTS_PREFIX} from '@sanity/visual-editing-csm'
 import {
   isEmptyActor,
   type OptimisticReducer,
@@ -9,10 +9,6 @@ import {onMount} from 'svelte'
 import {derived, get, writable, type Readable} from 'svelte/store'
 import {optimisticActor} from './optimisticActor'
 
-function getPublishedId(id: string): string {
-  return id.startsWith(DRAFTS_PREFIX) ? id.slice(DRAFTS_PREFIX.length) : id
-}
-
 export function useOptimistic<T, U = SanityDocument>(
   initial: T,
   reducer: OptimisticReducer<T, U> | Array<OptimisticReducer<T, U>>,