chore(core): add todo-corel comments

sanity-io · Jan 27, 2025 · 209e7ae · 209e7ae
1 parent cb5ac7b
commit 209e7ae
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 7 deletions.
diff --git a/packages/sanity/src/core/preview/createPreviewObserver.ts b/packages/sanity/src/core/preview/createPreviewObserver.ts
@@ -42,6 +42,8 @@ export function createPreviewObserver(context: {
     value: Previewable,
     type: PreviewableType,
     options: {
+      // TODO: COREL - Is this missing somehow? Maybe it was implemented and we lost this
+      // Is perspective preview value working correctly?
       perspective?: string
       viewOptions?: PrepareViewOptions
       apiConfig?: ApiConfig

diff --git a/packages/sanity/src/core/preview/documentPreviewStore.ts b/packages/sanity/src/core/preview/documentPreviewStore.ts
@@ -140,6 +140,7 @@ export function createDocumentPreviewStore({
   }
 
   const observeDocumentIdSet = createDocumentIdSetObserver(
+    // TODO: COREL - Replace once releases API are stable.
     versionedClient.withConfig({apiVersion: 'X'}),
   )
 

diff --git a/packages/sanity/src/core/store/_legacy/document/document-pair/utils/actionsApiClient.ts b/packages/sanity/src/core/store/_legacy/document/document-pair/utils/actionsApiClient.ts
@@ -1,5 +1,6 @@
 import {type SanityClient} from '@sanity/client'
 
+// TODO: COREL - Replace once releases API are stable.
 const ACTIONS_API_MINIMUM_VERSION = 'vX'
 
 export function actionsApiClient(client: SanityClient): SanityClient {

diff --git a/packages/sanity/src/core/studioClient.ts b/packages/sanity/src/core/studioClient.ts
@@ -10,5 +10,6 @@ import {type SourceClientOptions} from './config'
  * @internal
  */
 export const DEFAULT_STUDIO_CLIENT_OPTIONS: SourceClientOptions = {
+  // TODO: COREL - Replace once releases API are stable.
   apiVersion: 'X',
 }
diff --git a/packages/sanity/src/presentation/constants.ts b/packages/sanity/src/presentation/constants.ts
@@ -10,6 +10,7 @@ export const EDIT_INTENT_MODE = 'presentation'
 export const MAX_TIME_TO_OVERLAYS_CONNECTION = 3_000 // ms
 
 // The API version to use when using `@sanity/client`
+// TODO: COREL - Replace once releases API are stable.
 export const API_VERSION = 'vX'
 
 // Heartbeats shouldn't fire on intervals that are so short it causes performance issues

diff --git a/packages/sanity/src/structure/panes/document/DocumentPaneProvider.tsx b/packages/sanity/src/structure/panes/document/DocumentPaneProvider.tsx
@@ -126,6 +126,7 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
   const perspective = usePerspective()
 
   const {isReleaseLocked, selectedReleaseId, selectedPerspectiveName} = useMemo(() => {
+    // * TODO: COREL - Remove this after updating sanity-assist to use <PerspectiveProvider>
     if (forcedVersion) {
       return forcedVersion
     }
@@ -794,8 +795,6 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
         views,
         formState,
         unstable_languageFilter: languageFilter,
-
-        // History specific
         revisionId,
         lastNonDeletedRevId,
       }) satisfies DocumentPaneContextValue,
@@ -836,26 +835,26 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
       openPath,
       index,
       inspectOpen,
-      isDeleted,
-      isDeleting,
-      isPermissionsLoading,
-      isInitialValueLoading,
-      languageFilter,
       validation,
       menuItemGroups,
       paneKey,
       previewUrl,
       ready,
       schemaType,
+      isPermissionsLoading,
+      isInitialValueLoading,
       permissions,
       setTimelineRange,
+      isDeleting,
+      isDeleted,
       timelineError,
       timelineStore,
       title,
       value,
       selectedReleaseId,
       views,
       formState,
+      languageFilter,
       revisionId,
       lastNonDeletedRevId,
     ],

diff --git a/packages/sanity/src/structure/panes/types.ts b/packages/sanity/src/structure/panes/types.ts
@@ -11,6 +11,7 @@ export interface BaseStructureToolPaneProps<T extends PaneNode['type']> {
   isActive?: boolean
   pane: Extract<PaneNode, {type: T}>
   /**
+   * TODO: COREL - Remove this after updating sanity-assist to use <PerspectiveProvider>
    * Allows to override the global version with a specific version or release.
    * @beta
    */
-Original file line number
+Diff line change
@@ Expand Up / @@ -140,6 +140,7 @@ export function createDocumentPreviewStore({ @@
       }
       const observeDocumentIdSet = createDocumentIdSetObserver(
+        // TODO: COREL - Replace once releases API are stable.
         versionedClient.withConfig({apiVersion: 'X'}),
       )
@@ Expand Down @@