refactor: flatten _singletons and increase usage of `sanity/_create…

…Context` (#7311)

* chore: add eslint rule to prevent react.createContext

* refactor: move and flatten contexts

* refactor: switch to sanity/_createContext

packages/sanity/.eslintrc.cjs

@@ -190,6 +190,11 @@ module.exports = {
                 name: 'sanity/router',
                 message: 'Use relative type imports instead',
               },
+              {
+                name: 'react',
+                importNames: ['createContext'],
+                message: "Use `createContext` from 'sanity/_createContext' instead",
+              },
             ],
           },
         ],

packages/sanity/src/_singletons/core/studio/activeWorkspaceMatcher/ActiveWorkspaceMatcherContext.ts → packages/sanity/src/_singletons/context/ActiveWorkspaceMatcherContext.ts

@@ -1,6 +1,6 @@
 import {createContext} from 'sanity/_createContext'
 
-import type {ActiveWorkspaceMatcherContextValue} from '../../../../core/studio/activeWorkspaceMatcher/ActiveWorkspaceMatcherContext'
+import type {ActiveWorkspaceMatcherContextValue} from '../../core/studio/activeWorkspaceMatcher/ActiveWorkspaceMatcherContext'
 
 /** @internal */
 export const ActiveWorkspaceMatcherContext =

packages/sanity/src/_singletons/context/AddonDatasetContext.ts

@@ -0,0 +1,12 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {AddonDatasetContextValue} from '../../core/studio/addonDataset/types'
+
+/**
+ * @beta
+ * @hidden
+ */
+export const AddonDatasetContext = createContext<AddonDatasetContextValue | null>(
+  'sanity/_singletons/context/addon-dataset',
+  null,
+)

packages/sanity/src/_singletons/context/CalendarContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CalendarContextValue} from '../../core/studio/components/navbar/search/components/filters/filter/inputs/date/datePicker/calendar/contexts/CalendarContext'
+
+/**
+ * @internal
+ */
+export const CalendarContext = createContext<CalendarContextValue | undefined>(
+  'sanity/_singletons/context/calendar',
+  undefined,
+)

packages/sanity/src/_singletons/context/ChangeIndicatorTrackerContexts.ts

@@ -0,0 +1,20 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {
+  ChangeIndicatorTrackerContextStoreType,
+  ChangeIndicatorTrackerGetSnapshotType,
+} from '../../core/changeIndicators/ChangeIndicatorTrackerContexts'
+
+/** @internal */
+export const ChangeIndicatorTrackerContextStore =
+  createContext<ChangeIndicatorTrackerContextStoreType>(
+    'sanity/_singletons/context/change-indicator-tracker-store',
+    null,
+  )
+
+/** @internal */
+export const ChangeIndicatorTrackerContextGetSnapshot =
+  createContext<ChangeIndicatorTrackerGetSnapshotType>(
+    'sanity/_singletons/context/change-indicator-tracker-get-snapshot',
+    null,
+  )

packages/sanity/src/_singletons/core/studio/ColorSchemeSetValueContext.ts → packages/sanity/src/_singletons/context/ColorSchemeSetValueContext.ts

@@ -1,6 +1,6 @@
-import {createContext} from 'react'
+import {createContext} from 'sanity/_createContext'
 
-import type {StudioThemeColorSchemeKey} from '../../../core/theme/types'
+import type {StudioThemeColorSchemeKey} from '../../core/theme/types'
 
 /**
  * The setter for ColorSchemeValueContext, in a separate context to avoid unnecessary re-renders
@@ -9,4 +9,4 @@ import type {StudioThemeColorSchemeKey} from '../../../core/theme/types'
  */
 export const ColorSchemeSetValueContext = createContext<
   ((nextScheme: StudioThemeColorSchemeKey) => void) | false | null
->(null)
+>('sanity/_singletons/context/color-scheme-set-value', null)

packages/sanity/src/_singletons/context/ColorSchemeValueContext.ts

@@ -0,0 +1,12 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {StudioThemeColorSchemeKey} from '../../core/theme/types'
+
+/**
+ * Used to keep track of the internal value, which can be "system" in addition to "light" and "dark"
+ * @internal
+ */
+export const ColorSchemeValueContext = createContext<StudioThemeColorSchemeKey | null>(
+  'sanity/_singletons/context/color-scheme-value',
+  null,
+)

packages/sanity/src/_singletons/context/CommentInputContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CommentInputContextValue} from '../../core/comments/components/pte/comment-input/CommentInputProvider'
+
+/**
+ * @internal
+ */
+export const CommentInputContext = createContext<CommentInputContextValue | null>(
+  'sanity/_singletons/context/comment-input',
+  null,
+)

packages/sanity/src/_singletons/context/CommentsAuthoringPathContext.ts

@@ -0,0 +1,12 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CommentsAuthoringPathContextValue} from '../../core/comments/context/authoring-path/types'
+
+/**
+ * @beta
+ * @hidden
+ */
+export const CommentsAuthoringPathContext = createContext<CommentsAuthoringPathContextValue | null>(
+  'sanity/_singletons/context/comments-authoring-path',
+  null,
+)

packages/sanity/src/_singletons/context/CommentsContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CommentsContextValue} from '../../core/comments/context/comments/types'
+
+/**
+ * @internal
+ */
+export const CommentsContext = createContext<CommentsContextValue | null>(
+  'sanity/_singletons/context/comments',
+  null,
+)

packages/sanity/src/_singletons/structure/comments/enabled/CommentsEnabledContext.ts → packages/sanity/src/_singletons/context/CommentsEnabledContext.ts

@@ -1,6 +1,6 @@
-import {createContext} from 'react'
+import {createContext} from 'sanity/_createContext'
 
-import type {CommentsEnabledContextValue} from '../../../../core/comments/context/enabled/types'
+import type {CommentsEnabledContextValue} from '../../core/comments/context/enabled/types'
 
 // NOTE: We initialize this context with a default value (`enabled: false`)
 // rather than `null` to handle cases where the comments feature's availability
@@ -11,7 +11,10 @@ import type {CommentsEnabledContextValue} from '../../../../core/comments/contex
 /**
  * @internal
  */
-export const CommentsEnabledContext = createContext<CommentsEnabledContextValue>({
-  enabled: false,
-  mode: null,
-})
+export const CommentsEnabledContext = createContext<CommentsEnabledContextValue>(
+  'sanity/_singletons/context/comments-enabled',
+  {
+    enabled: false,
+    mode: null,
+  },
+)

packages/sanity/src/_singletons/structure/comments/intent/CommentsIntentContext.ts → packages/sanity/src/_singletons/context/CommentsIntentContext.ts

@@ -1,6 +1,6 @@
 import {createContext} from 'sanity/_createContext'
 
-import type {CommentsIntentContextValue} from '../../../../core/comments/context/intent/types'
+import type {CommentsIntentContextValue} from '../../core/comments/context/intent/types'
 
 /**
  * @internal

packages/sanity/src/_singletons/context/CommentsOnboardingContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CommentsOnboardingContextValue} from '../../core/comments/context/onboarding/types'
+
+/**
+ * @internal
+ */
+export const CommentsOnboardingContext = createContext<CommentsOnboardingContextValue | null>(
+  'sanity/_singletons/context/comments-onboarding',
+  null,
+)

packages/sanity/src/_singletons/context/CommentsSelectedPathContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CommentsSelectedPathContextValue} from '../../core/comments/context/selected-path/types'
+
+/**
+ * @internal
+ */
+export const CommentsSelectedPathContext = createContext<CommentsSelectedPathContextValue | null>(
+  'sanity/_singletons/context/comments-selected-path',
+  null,
+)

packages/sanity/src/_singletons/context/CommentsUpsellContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CommentsUpsellContextValue} from '../../core/comments/context/upsell/types'
+
+/**
+ * @internal
+ */
+export const CommentsUpsellContext = createContext<CommentsUpsellContextValue | null>(
+  'sanity/_singletons/context/comments-upsell',
+  null,
+)

packages/sanity/src/_singletons/context/ConnectorContext.ts

@@ -0,0 +1,13 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {ConnectorContextValue} from '../../core/changeIndicators/ConnectorContext'
+
+/** @internal */
+export const ConnectorContext = createContext<ConnectorContextValue>(
+  'sanity/_singletons/context/connector',
+  {
+    isReviewChangesOpen: false,
+    onOpenReviewChanges: () => undefined,
+    onSetFocus: () => undefined,
+  } as ConnectorContextValue,
+)

packages/sanity/src/_singletons/context/CopyPasteContext.ts

@@ -0,0 +1,12 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {CopyPasteContextType} from '../../core/studio/copyPaste'
+
+/**
+ * @beta
+ * @hidden
+ */
+export const CopyPasteContext = createContext<CopyPasteContextType | null>(
+  'sanity/_singletons/context/copy-paste',
+  null,
+)

packages/sanity/src/_singletons/context/DiffContext.ts

@@ -0,0 +1,9 @@
+import type {Path} from '@sanity/types'
+import {createContext} from 'sanity/_createContext'
+
+/** @internal */
+export const DiffContext = createContext<{
+  path: Path
+}>('sanity/_singletons/context/diff', {
+  path: [],
+})

packages/sanity/src/_singletons/context/DocumentActionPropsContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {DocumentActionProps} from '../../core/config/document/actions'
+
+/**
+ * @internal
+ */
+export const DocumentActionPropsContext = createContext<DocumentActionProps | undefined>(
+  'sanity/_singletons/context/document-action-props',
+  undefined,
+)

packages/sanity/src/_singletons/context/DocumentChangeContext.ts

@@ -0,0 +1,9 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {DocumentChangeContextInstance} from '../../core/field/diff/contexts/DocumentChangeContext'
+
+/** @internal */
+export const DocumentChangeContext = createContext<DocumentChangeContextInstance | null>(
+  'sanity/_singletons/context/document-change',
+  null,
+)

packages/sanity/src/_singletons/core/form/studio/DocumentFieldActionsContext.ts → packages/sanity/src/_singletons/context/DocumentFieldActionsContext.ts

@@ -1,6 +1,6 @@
-import {createContext} from 'react'
+import {createContext} from 'sanity/_createContext'
 
-import type {DocumentFieldAction} from '../../../../core/config/document/fieldActions/types'
+import type {DocumentFieldAction} from '../../core/config/document/fieldActions/types'
 
 /**
  * @internal
@@ -13,5 +13,6 @@ export interface DocumentFieldActionsContextValue {
  * @internal
  */
 export const DocumentFieldActionsContext = createContext<DocumentFieldActionsContextValue | null>(
+  'sanity/_singletons/context/document-field-actions',
   null,
 )

packages/sanity/src/_singletons/core/form/DocumentIdContext.ts → packages/sanity/src/_singletons/context/DocumentIdContext.ts

@@ -1,4 +1,4 @@
-import {createContext} from 'react'
+import {createContext} from 'sanity/_createContext'
 
 /**
  * @internal
@@ -10,4 +10,7 @@ export interface DocumentIdContextValue {
 /**
  * @internal
  */
-export const DocumentIdContext = createContext<DocumentIdContextValue | null>(null)
+export const DocumentIdContext = createContext<DocumentIdContextValue | null>(
+  'sanity/_singletons/context/document-id',
+  null,
+)

packages/sanity/src/_singletons/structure/panes/document/DocumentPaneContext.ts → packages/sanity/src/_singletons/context/DocumentPaneContext.ts

@@ -1,6 +1,6 @@
 import {createContext} from 'sanity/_createContext'
 
-import type {DocumentPaneContextValue} from '../../../../structure/panes/document/DocumentPaneContext'
+import type {DocumentPaneContextValue} from '../../structure/panes/document/DocumentPaneContext'
 
 /** @internal */
 export const DocumentPaneContext = createContext<DocumentPaneContextValue | null>(

packages/sanity/src/_singletons/context/DocumentSheetListContext.ts

@@ -0,0 +1,9 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {DocumentSheetListContextValue} from '../../structure/panes/documentList/sheetList/DocumentSheetListProvider'
+
+/** @internal */
+export const DocumentSheetListContext = createContext<DocumentSheetListContextValue | undefined>(
+  'sanity/_singletons/context/document-sheet-list',
+  undefined,
+)

packages/sanity/src/_singletons/context/FieldActionsContext.ts

@@ -0,0 +1,24 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {DocumentFieldActionNode} from '../../core/config/document/fieldActions/types'
+
+/** @internal */
+export interface FieldActionsContextValue {
+  actions: DocumentFieldActionNode[]
+  focused?: boolean
+  hovered: boolean
+  onMouseEnter: () => void
+  onMouseLeave: () => void
+}
+
+/** @internal */
+export const FieldActionsContext = createContext<FieldActionsContextValue>(
+  'sanity/_singletons/context/field-actions',
+  {
+    actions: [],
+    focused: false,
+    hovered: false,
+    onMouseEnter: () => undefined,
+    onMouseLeave: () => undefined,
+  },
+)

packages/sanity/src/_singletons/context/FormBuilderContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {FormBuilderContextValue} from '../../core/form/FormBuilderContext'
+
+/**
+ * @internal
+ */
+export const FormBuilderContext = createContext<FormBuilderContextValue | null>(
+  'sanity/_singletons/context/form-builder',
+  null,
+)

packages/sanity/src/_singletons/context/FormCallbacksContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {FormCallbacksValue} from '../../core/form/studio/contexts/FormCallbacks'
+
+/**
+ * @internal
+ */
+export const FormCallbacksContext = createContext<FormCallbacksValue | null>(
+  'sanity/_singletons/context/form-callbacks',
+  null,
+)

packages/sanity/src/_singletons/context/FormFieldPresenceContext.ts

@@ -0,0 +1,9 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {FormNodePresence} from '../../core/presence/types'
+
+/** @internal */
+export const FormFieldPresenceContext = createContext<FormNodePresence[]>(
+  'sanity/_singletons/context/form-field-presence',
+  [],
+)

packages/sanity/src/_singletons/core/form/FormValueContext.ts → packages/sanity/src/_singletons/context/FormValueContext.ts

@@ -1,6 +1,6 @@
 import {createContext} from 'sanity/_createContext'
 
-import type {FormValueContextValue} from '../../../core/form/contexts/FormValue'
+import type {FormValueContextValue} from '../../core/form/contexts/FormValue'
 
 /**
  * @internal

packages/sanity/src/_singletons/context/FreeTrialContext.ts

@@ -0,0 +1,11 @@
+import {createContext} from 'sanity/_createContext'
+
+import type {FreeTrialContextProps} from '../../core/studio/components/navbar/free-trial/FreeTrialContext'
+
+/**
+ * @internal
+ */
+export const FreeTrialContext = createContext<FreeTrialContextProps | undefined>(
+  'sanity/_singletons/context/free-trial',
+  undefined,
+)