@portabletext/editor 1.47.14 → 1.47.15

package/lib/index.d.cts

@@ -63,6 +63,7 @@ import {
 } from 'xstate'
 import type {EventObject, Snapshot} from 'xstate'
 import {GuardArgs} from 'xstate/guards'
+import {Editor as Editor_2} from './create-editor'
 
 declare type AbstractBehaviorEvent =
   | {
@@ -6815,7 +6816,7 @@ declare type UnsetEvent = {
  * ```
  * @group Hooks
  */
-export declare function useEditor(): Editor
+export declare function useEditor(): Editor_2
 
 /**
  * @public

package/lib/index.d.ts

@@ -63,6 +63,7 @@ import {
 } from 'xstate'
 import type {EventObject, Snapshot} from 'xstate'
 import {GuardArgs} from 'xstate/guards'
+import {Editor as Editor_2} from './create-editor'
 
 declare type AbstractBehaviorEvent =
   | {
@@ -6815,7 +6816,7 @@ declare type UnsetEvent = {
  * ```
  * @group Hooks
  */
-export declare function useEditor(): Editor
+export declare function useEditor(): Editor_2
 
 /**
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.47.14",
+  "version": "1.47.15",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -79,8 +79,8 @@
     "slate-react": "0.112.1",
     "use-effect-event": "^1.0.2",
     "xstate": "^5.19.2",
-    "@portabletext/patches": "1.1.3",
-    "@portabletext/block-tools": "1.1.21"
+    "@portabletext/block-tools": "1.1.21",
+    "@portabletext/patches": "1.1.3"
   },
   "devDependencies": {
     "@portabletext/toolkit": "^2.0.17",

package/src/editor/editor-context.tsx

@@ -0,0 +1,7 @@
+import {createGloballyScopedContext} from '../internal-utils/globally-scoped-context'
+import type {Editor} from './create-editor'
+
+export const EditorContext = createGloballyScopedContext<Editor | null>(
+  '@portabletext/editor/context/editor',
+  null,
+)

package/src/editor/editor-provider.tsx

@@ -5,10 +5,10 @@ import {Synchronizer} from './components/Synchronizer'
 import {
   createInternalEditor,
   editorConfigToMachineInput,
-  type Editor,
   type EditorConfig,
 } from './create-editor'
 import {EditorActorContext} from './editor-actor-context'
+import {EditorContext} from './editor-context'
 import {editorMachine} from './editor-machine'
 import {PortableTextEditorContext} from './hooks/usePortableTextEditor'
 import {PortableTextEditorSelectionProvider} from './hooks/usePortableTextEditorSelection'
@@ -18,8 +18,6 @@ import {
   type PortableTextEditorProps,
 } from './PortableTextEditor'
 
-const EditorContext = React.createContext<Editor | undefined>(undefined)
-
 /**
  * @public
  */

package/src/internal-utils/global-scope.ts

@@ -0,0 +1,19 @@
+/**
+ * Gets the global scope instance in a given environment.
+ *
+ * The strategy is to return the most modern, and if not, the most common:
+ * - The `globalThis` variable is the modern approach to accessing the global scope
+ * - The `window` variable is the global scope in a web browser
+ * - The `self` variable is the global scope in workers and others
+ * - The `global` variable is the global scope in Node.js
+ */
+function getGlobalScope() {
+  if (typeof globalThis !== 'undefined') return globalThis
+  if (typeof window !== 'undefined') return window
+  if (typeof self !== 'undefined') return self
+  if (typeof global !== 'undefined') return global
+
+  throw new Error('@portabletext/editor: could not locate global scope')
+}
+
+export const globalScope = getGlobalScope() as any

package/src/internal-utils/globally-scoped-context.ts

@@ -0,0 +1,39 @@
+import {createContext, type Context} from 'react'
+import {globalScope} from './global-scope'
+
+/**
+ * As `@portabletext/editor` is declared as a dependency, and may be
+ * duplicated, sometimes across major versions it's critical that vital
+ * React Contexts are shared even when there is a duplicate.
+ *
+ * We have to support a Sanity Plugin being able to call hooks like
+ * `useEditor`, and then read the context setup by `sanity`, which calls
+ * `EditorProvider`, even if the provider and hook are different instances in
+ * memory.
+ *
+ * For this reason it's vital that all changes to globally scoped providers
+ * remain fully backwards compatible.
+ */
+export function createGloballyScopedContext<
+  ContextType,
+  const T extends ContextType = ContextType,
+>(
+  /**
+   * Enforce that all Symbol.for keys used for globally scoped contexts have a predictable prefix
+   */
+  key: `@portabletext/editor/context/${string}`,
+  defaultValue: T,
+): Context<ContextType> {
+  const symbol = Symbol.for(key)
+
+  /**
+   * Prevent errors about re-renders on React SSR on Next.js App Router
+   */
+  if (typeof document === 'undefined') {
+    return createContext<ContextType>(defaultValue)
+  }
+
+  globalScope[symbol] = globalScope[symbol] ?? createContext<T>(defaultValue)
+
+  return globalScope[symbol]
+}