@sanity/sdk-react 0.0.0-alpha.8 → 0.0.0-alpha.9

package/dist/_chunks-es/useLogOut.js

@@ -34,6 +34,7 @@ function useLoginUrls() {
 }
 const useLogOut = createCallbackHook(logout);
 export {
+  createCallbackHook,
   createStateSourceHook,
   useAuthState,
   useHandleCallback,

package/dist/hooks.d.ts

@@ -1,13 +1,21 @@
+import {ActionsResult} from '@sanity/sdk'
+import {ApplyActionsOptions} from '@sanity/sdk'
 import {AuthProvider} from '@sanity/sdk'
 import {AuthState} from '@sanity/sdk'
 import {ClientOptions} from '@sanity/sdk'
 import {CurrentUser} from '@sanity/sdk'
+import {DocumentAction} from '@sanity/sdk'
+import {DocumentEvent} from '@sanity/sdk'
 import {DocumentHandle} from '@sanity/sdk'
 import {DocumentListOptions} from '@sanity/sdk'
 import {FrameMessage} from '@sanity/sdk'
+import {JsonMatch} from '@sanity/sdk'
+import {JsonMatchPath} from '@sanity/sdk'
 import {Observable} from 'rxjs'
 import {PreviewValue} from '@sanity/sdk'
 import {Requester} from 'get-it'
+import {SanityDocument as SanityDocument_2} from '@sanity/types'
+import {SanityDocumentLike} from '@sanity/types'
 import {SanityInstance} from '@sanity/sdk'
 import {WindowMessage} from '@sanity/sdk'
 
@@ -3096,6 +3104,12 @@ declare interface UploadClientConfig {
   }
 }
 
+/** @beta */
+export declare function useApplyActions(): <TDocument extends SanityDocument_2>(
+  action: DocumentAction<TDocument> | DocumentAction<TDocument>[],
+  options?: ApplyActionsOptions,
+) => Promise<ActionsResult<TDocument>>
+
 /**
  * @internal
  * A React hook that subscribes to authentication state changes.
@@ -3179,6 +3193,20 @@ export declare function useClient(options: ClientOptions): SanityClient
  */
 export declare const useCurrentUser: () => CurrentUser | null
 
+/** @beta */
+export declare function useDocument<
+  TDocument extends SanityDocument_2,
+  TPath extends JsonMatchPath<TDocument>,
+>(doc: string | DocumentHandle<TDocument>, path: TPath): JsonMatch<TDocument, TPath> | undefined
+
+/** @beta */
+export declare function useDocument<TDocument extends SanityDocument_2>(
+  doc: string | DocumentHandle<TDocument>,
+): TDocument | null
+
+/** @beta */
+export declare function useDocumentEvent(handler: (documentEvent: DocumentEvent) => void): void
+
 /**
  * @public
  *
@@ -3232,6 +3260,25 @@ export declare const useCurrentUser: () => CurrentUser | null
  */
 export declare function useDocuments(options?: DocumentListOptions): DocumentCollection
 
+/** @beta */
+export declare const useDocumentSyncStatus: (
+  doc: string | DocumentHandle<SanityDocumentLike>,
+) => boolean | undefined
+
+/** @beta */
+export declare function useEditDocument<
+  TDocument extends SanityDocument_2,
+  TPath extends JsonMatchPath<TDocument>,
+>(
+  doc: string | DocumentHandle<TDocument>,
+  path: TPath,
+): (nextValue: JsonMatch<TDocument, TPath>) => Promise<ActionsResult<TDocument>>
+
+/** @beta */
+export declare function useEditDocument<TDocument extends SanityDocument_2>(
+  doc: string | DocumentHandle<TDocument>,
+): (nextValue: Partial<TDocument>) => Promise<ActionsResult<TDocument>>
+
 /**
  * @internal
  */

package/dist/hooks.js

@@ -1,7 +1,7 @@
-import { createStateSourceHook, useSanityInstance } from "./_chunks-es/useLogOut.js";
+import { createStateSourceHook, useSanityInstance, createCallbackHook } from "./_chunks-es/useLogOut.js";
 import { useAuthState, useHandleCallback, useLogOut, useLoginUrls } from "./_chunks-es/useLogOut.js";
-import { getTokenState, getCurrentUserState, getSubscribableClient, getClient, getOrCreateController, getOrCreateChannel, releaseChannel, getOrCreateNode, releaseNode, createDocumentListStore, getPreviewState, resolvePreview } from "@sanity/sdk";
-import { useCallback, useSyncExternalStore, useMemo, useEffect, useState } from "react";
+import { getTokenState, getCurrentUserState, getSubscribableClient, getClient, getOrCreateController, getOrCreateChannel, releaseChannel, getOrCreateNode, releaseNode, applyActions, getDocumentState, resolveDocument, subscribeDocumentEvents, getDocumentSyncStatus, editDocument, createDocumentListStore, getPreviewState, resolvePreview } from "@sanity/sdk";
+import { useCallback, useSyncExternalStore, useMemo, useEffect, useRef, useInsertionEffect, useState } from "react";
 import { Observable, startWith, distinctUntilChanged, switchMap, EMPTY } from "rxjs";
 const useAuthToken = createStateSourceHook(getTokenState), useCurrentUser = createStateSourceHook(getCurrentUserState);
 function useClient(options) {
@@ -88,6 +88,52 @@ function useWindowConnection(options) {
     sendMessage
   };
 }
+function useApplyActions() {
+  return _useApplyActions();
+}
+const _useApplyActions = createCallbackHook(applyActions);
+function useDocument(doc, path) {
+  const documentId = typeof doc == "string" ? doc : doc._id, instance = useSanityInstance();
+  if (!useCallback(
+    () => getDocumentState(instance, documentId).getCurrent() !== void 0,
+    [instance, documentId]
+  )()) throw resolveDocument(instance, documentId);
+  const { subscribe, getCurrent } = useMemo(
+    () => getDocumentState(instance, documentId, path),
+    [documentId, instance, path]
+  );
+  return useSyncExternalStore(subscribe, getCurrent);
+}
+function useDocumentEvent(handler) {
+  const ref = useRef(handler);
+  useInsertionEffect(() => {
+    ref.current = handler;
+  });
+  const stableHandler = useCallback((documentEvent) => ref.current(documentEvent), []), instance = useSanityInstance();
+  useEffect(() => subscribeDocumentEvents(instance, stableHandler), [instance, stableHandler]);
+}
+const useDocumentSyncStatus = createStateSourceHook(getDocumentSyncStatus), ignoredKeys = ["_id", "_type", "_createdAt", "_updatedAt", "_rev"];
+function useEditDocument(doc, path) {
+  const documentId = typeof doc == "string" ? doc : doc._id, instance = useSanityInstance(), apply = useApplyActions();
+  if (!useCallback(
+    () => getDocumentState(instance, documentId).getCurrent() !== void 0,
+    [instance, documentId]
+  )()) throw resolveDocument(instance, documentId);
+  return useCallback(
+    (next) => {
+      if (path)
+        return apply(editDocument(documentId, { set: { [path]: next } }));
+      const current = getDocumentState(instance, documentId).getCurrent();
+      if (typeof next != "object" || !next)
+        throw new Error(
+          "No path was provided to `useEditDocument` and the value provided was not a document object."
+        );
+      const editActions = Object.entries(next).filter(([key]) => !ignoredKeys.includes(key)).filter(([key, value]) => current?.[key] !== value).map(([key, value]) => editDocument(documentId, { set: { [key]: value } }));
+      return apply(editActions);
+    },
+    [apply, documentId, instance, path]
+  );
+}
 const STABLE_EMPTY = {
   results: [],
   isPending: !1,
@@ -151,11 +197,16 @@ function usePreview({ document: { _id, _type }, ref }) {
   return useSyncExternalStore(subscribe, getSnapshot);
 }
 export {
+  useApplyActions,
   useAuthState,
   useAuthToken,
   useClient,
   useCurrentUser,
+  useDocument,
+  useDocumentEvent,
+  useDocumentSyncStatus,
   useDocuments,
+  useEditDocument,
   useFrameConnection,
   useHandleCallback,
   useLogOut,

package/dist/hooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.js","sources":["../src/hooks/auth/useAuthToken.tsx","../src/hooks/auth/useCurrentUser.tsx","../src/hooks/client/useClient.ts","../src/hooks/comlink/useFrameConnection.ts","../src/hooks/comlink/useWindowConnection.ts","../src/hooks/documentCollection/useDocuments.ts","../src/hooks/preview/usePreview.tsx"],"sourcesContent":["import {getTokenState} from '@sanity/sdk'\n\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/**\n * Hook to get the currently logged in user\n * @internal\n * @returns The current user or null if not authenticated\n */\nexport const useAuthToken = createStateSourceHook(getTokenState)\n","import {type CurrentUser, getCurrentUserState} from '@sanity/sdk'\n\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/**\n * @TODO This should suspend! And possibly not return `null`?\n *\n * @public\n *\n * The `useCurrentUser` hook returns the currently authenticated user’s profile information (their name, email, roles, etc).\n * If no users are currently logged in, the hook returns null.\n *\n * @returns The current user data, or `null` if not authenticated\n *\n * @example Rendering a basic user profile\n * ```\n * const user = useCurrentUser()\n *\n * return (\n *   <figure>\n *     <img src={user?.profileImage} alt=`Profile image for ${user?.name}` />\n *     <h2>{user?.name}</h2>\n *   </figure>\n * )\n * ```\n */\nexport const useCurrentUser: () => CurrentUser | null = createStateSourceHook(getCurrentUserState)\n","import {type SanityClient} from '@sanity/client'\nimport {type ClientOptions, getClient, getSubscribableClient} from '@sanity/sdk'\nimport {useCallback, useSyncExternalStore} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * A React hook that provides a client that subscribes to changes in your application,\n * such as user authentication changes.\n *\n * @remarks\n * The hook uses `useSyncExternalStore` to safely subscribe to changes\n * and ensure consistency between server and client rendering.\n *\n * @returns A Sanity client\n *\n * @example\n * ```tsx\n * function MyComponent() {\n *   const client = useClient()\n *   const [document, setDocument] = useState(null)\n *   useEffect(async () => {\n *     const doc = client.fetch('*[_id == \"myDocumentId\"]')\n *     setDocument(doc)\n *   }, [])\n *  return <div>{JSON.stringify(document) ?? 'Loading...'}</div>\n * }\n * ```\n *\n * @public\n */\nexport function useClient(options: ClientOptions): SanityClient {\n  const instance = useSanityInstance()\n\n  const subscribe = useCallback(\n    (onStoreChange: () => void) => {\n      const client$ = getSubscribableClient(instance, options)\n      const subscription = client$.subscribe({\n        next: onStoreChange,\n        error: (error) => {\n          // @TODO: We should tackle error handling / error boundaries soon\n          // eslint-disable-next-line no-console\n          console.error('Error in useClient subscription:', error)\n        },\n      })\n      return () => subscription.unsubscribe()\n    },\n    [instance, options],\n  )\n\n  const getSnapshot = useCallback(() => {\n    return getClient(instance, options)\n  }, [instance, options])\n\n  return useSyncExternalStore(subscribe, getSnapshot)\n}\n","import {\n  type FrameMessage,\n  getOrCreateChannel,\n  getOrCreateController,\n  releaseChannel,\n  type WindowMessage,\n} from '@sanity/sdk'\nimport {useCallback, useEffect, useMemo} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @internal\n */\nexport type FrameMessageHandler<TWindowMessage extends WindowMessage> = (\n  event: TWindowMessage['data'],\n) => TWindowMessage['response'] | Promise<TWindowMessage['response']>\n\n/**\n * @internal\n */\nexport interface UseFrameConnectionOptions<TWindowMessage extends WindowMessage> {\n  name: string\n  connectTo: string\n  targetOrigin: string\n  onMessage?: Record<string, FrameMessageHandler<TWindowMessage>>\n}\n\n/**\n * @internal\n */\nexport interface FrameConnection<TFrameMessage extends FrameMessage> {\n  connect: (frameWindow: Window) => () => void // Return cleanup function\n  sendMessage: <T extends TFrameMessage['type']>(\n    ...params: Extract<TFrameMessage, {type: T}>['data'] extends undefined\n      ? [type: T]\n      : [type: T, data: Extract<TFrameMessage, {type: T}>['data']]\n  ) => void\n}\n\n/**\n * @internal\n */\nexport function useFrameConnection<\n  TFrameMessage extends FrameMessage,\n  TWindowMessage extends WindowMessage,\n>(options: UseFrameConnectionOptions<TWindowMessage>): FrameConnection<TFrameMessage> {\n  const {onMessage, targetOrigin, name, connectTo} = options\n  const instance = useSanityInstance()\n\n  const controller = useMemo(\n    () => getOrCreateController(instance, targetOrigin),\n    [instance, targetOrigin],\n  )\n\n  const channel = useMemo(\n    () =>\n      getOrCreateChannel(instance, {\n        name,\n        connectTo,\n      }),\n    [instance, name, connectTo],\n  )\n\n  useEffect(() => {\n    if (!channel || !onMessage) return\n\n    const unsubscribers: Array<() => void> = []\n\n    Object.entries(onMessage).forEach(([type, handler]) => {\n      const unsubscribe = channel.on(type, handler)\n      unsubscribers.push(unsubscribe)\n    })\n\n    return () => {\n      unsubscribers.forEach((unsub) => unsub())\n    }\n  }, [channel, onMessage])\n\n  const connect = useCallback(\n    (frameWindow: Window) => {\n      const removeTarget = controller?.addTarget(frameWindow)\n      return () => {\n        removeTarget?.()\n      }\n    },\n    [controller],\n  )\n\n  const sendMessage = useCallback(\n    <T extends TFrameMessage['type']>(\n      type: T,\n      data?: Extract<TFrameMessage, {type: T}>['data'],\n    ) => {\n      channel?.post(type, data)\n    },\n    [channel],\n  )\n\n  // cleanup channel on unmount\n  useEffect(() => {\n    return () => {\n      releaseChannel(instance, name)\n    }\n  }, [name, instance])\n\n  return {\n    connect,\n    sendMessage,\n  }\n}\n","import {type FrameMessage, getOrCreateNode, releaseNode, type WindowMessage} from '@sanity/sdk'\nimport {useCallback, useEffect, useMemo} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @internal\n */\nexport type WindowMessageHandler<TFrameMessage extends FrameMessage> = (\n  event: TFrameMessage['data'],\n) => TFrameMessage['response']\n\n/**\n * @internal\n */\nexport interface UseWindowConnectionOptions<TMessage extends FrameMessage> {\n  name: string\n  connectTo: string\n  onMessage?: Record<TMessage['type'], WindowMessageHandler<TMessage>>\n}\n\n/**\n * @internal\n */\nexport interface WindowConnection<TMessage extends WindowMessage> {\n  sendMessage: <TType extends TMessage['type']>(\n    type: TType,\n    data?: Extract<TMessage, {type: TType}>['data'],\n  ) => void\n}\n\n/**\n * @internal\n */\nexport function useWindowConnection<\n  TWindowMessage extends WindowMessage,\n  TFrameMessage extends FrameMessage,\n>(options: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage> {\n  const {name, onMessage, connectTo} = options\n  const instance = useSanityInstance()\n\n  const node = useMemo(\n    () => getOrCreateNode(instance, {name, connectTo}),\n    [instance, name, connectTo],\n  )\n\n  useEffect(() => {\n    if (!onMessage) return\n\n    const unsubscribers: Array<() => void> = []\n\n    Object.entries(onMessage).forEach(([type, handler]) => {\n      const unsubscribe = node.on(type, handler as WindowMessageHandler<TFrameMessage>)\n      unsubscribers.push(unsubscribe)\n    })\n\n    return () => {\n      unsubscribers.forEach((unsub) => unsub())\n    }\n  }, [node, onMessage])\n\n  const sendMessage = useCallback(\n    <TType extends WindowMessage['type']>(\n      type: TType,\n      data?: Extract<WindowMessage, {type: TType}>['data'],\n    ) => {\n      node?.post(type, data)\n    },\n    [node],\n  )\n\n  // cleanup node on unmount\n  useEffect(() => {\n    return () => {\n      releaseNode(instance, name)\n    }\n  }, [instance, name])\n\n  return {\n    sendMessage,\n  }\n}\n","import {createDocumentListStore, type DocumentHandle, type DocumentListOptions} from '@sanity/sdk'\nimport {useCallback, useEffect, useState, useSyncExternalStore} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @public\n */\nexport interface DocumentCollection {\n  /** Retrieve more documents matching the provided options */\n  loadMore: () => void\n  /** The retrieved document handles of the documents matching the provided options */\n  results: DocumentHandle[]\n  /** Whether a retrieval of documents is in flight */\n  isPending: boolean\n  /** Whether more documents exist that match the provided options than have been retrieved */\n  hasMore: boolean\n  /** The total number of documents in the collection */\n  count: number\n}\n\ntype DocumentListStore = ReturnType<typeof createDocumentListStore>\ntype DocumentListState = ReturnType<DocumentListStore['getState']>['getCurrent']\nconst STABLE_EMPTY = {\n  results: [],\n  isPending: false,\n  hasMore: false,\n  count: 0,\n}\n\n/**\n * @public\n *\n * The `useDocuments` hook retrieves and provides access to a live collection of documents, optionally filtered, sorted, and matched to a given Content Lake perspective.\n * Because the returned document collection is live, the results will update in real time until the component invoking the hook is unmounted.\n *\n * @param options - Options for narrowing and sorting the document collection\n * @returns The collection of documents matching the provided options (if any), as well as properties describing the collection and a function to load more.\n *\n * @example Retrieving all documents of type 'movie'\n * ```\n * const { results, isPending } = useDocuments({ filter: '_type == \"movie\"' })\n *\n * return (\n *   <div>\n *     <h1>Movies</h1>\n *     {results && (\n *       <ul>\n *         {results.map(movie => (<li key={movie._id}>…</li>))}\n *       </ul>\n *     )}\n *     {isPending && <div>Loading movies…</div>}\n *   </div>\n * )\n * ```\n *\n * @example Retrieving all movies released since 1980, sorted by director’s last name\n * ```\n * const { results } = useDocuments({\n *   filter: '_type == \"movie\" && releaseDate >= \"1980-01-01\"',\n *   sort: [\n *     {\n *       // Expand the `director` reference field with the dereferencing operator `->`\n *       field: 'director->lastName',\n *       sort: 'asc',\n *     },\n *   ],\n * })\n *\n * return (\n *   <div>\n *      <h1>Movies released since 1980</h1>\n *      {results && (\n *        <ol>\n *          {results.map(movie => (<li key={movie._id}>…</li>))}\n *        </ol>\n *     )}\n *   </div>\n * )\n * ```\n */\nexport function useDocuments(options: DocumentListOptions = {}): DocumentCollection {\n  const instance = useSanityInstance()\n\n  // NOTE: useState is used because it guaranteed to return a stable reference\n  // across renders\n  const [ref] = useState<{\n    storeInstance: DocumentListStore | null\n    getCurrent: DocumentListState\n    initialOptions: DocumentListOptions\n  }>(() => ({\n    storeInstance: null,\n    getCurrent: () => STABLE_EMPTY,\n    initialOptions: options,\n  }))\n\n  // serialize options to ensure it only calls `setOptions` when the values\n  // themselves changes (in cases where devs put config inline)\n  const serializedOptions = JSON.stringify(options)\n  useEffect(() => {\n    ref.storeInstance?.setOptions(JSON.parse(serializedOptions))\n  }, [ref, serializedOptions])\n\n  const subscribe = useCallback(\n    (onStoreChanged: () => void) => {\n      // to match the lifecycle of `useSyncExternalState`, we create the store\n      // instance after subscribe and mutate the ref to connect everything\n      ref.storeInstance = createDocumentListStore(instance)\n      ref.storeInstance.setOptions(ref.initialOptions)\n      const state = ref.storeInstance.getState()\n      ref.getCurrent = state.getCurrent\n      const unsubscribe = state.subscribe(onStoreChanged)\n\n      return () => {\n        // unsubscribe to clean up the state subscriptions\n        unsubscribe()\n        // dispose of the instance\n        ref.storeInstance?.dispose()\n      }\n    },\n    [instance, ref],\n  )\n\n  const getSnapshot = useCallback(() => {\n    return ref.getCurrent()\n  }, [ref])\n\n  const state = useSyncExternalStore(subscribe, getSnapshot)\n\n  const loadMore = useCallback(() => {\n    ref.storeInstance?.loadMore()\n  }, [ref])\n\n  return {loadMore, ...state}\n}\n","import {type DocumentHandle, getPreviewState, type PreviewValue, resolvePreview} from '@sanity/sdk'\nimport {useCallback, useMemo, useSyncExternalStore} from 'react'\nimport {distinctUntilChanged, EMPTY, Observable, startWith, switchMap} from 'rxjs'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @alpha\n */\nexport interface UsePreviewOptions {\n  document: DocumentHandle\n  ref?: React.RefObject<unknown>\n}\n\n/**\n * @alpha\n */\nexport interface UsePreviewResults {\n  /** The results of resolving the document’s preview values */\n  results: PreviewValue\n  /** True when preview values are being refreshed */\n  isPending: boolean\n}\n\n/**\n * @alpha\n *\n * The `usePreview` hook takes a document (via a `DocumentHandle`) and returns its resolved preview values,\n * including the document’s `title`, `subtitle`, `media`, and `status`. These values are live and will update in realtime.\n * To reduce unnecessary network requests for resolving the preview values, an optional `ref` can be passed to the hook so that preview\n * resolution will only occur if the `ref` is intersecting the current viewport.\n *\n * @param options - The document handle for the document you want to resolve preview values for, and an optional ref\n * @returns The preview values for the given document and a boolean to indicate whether the resolution is pending\n *\n * @example Combining with useDocuments to render a collection of document previews\n * ```\n * // PreviewComponent.jsx\n * export default function PreviewComponent({ document }) {\n *   const { results: { title, subtitle, media }, isPending } = usePreview({ document })\n *   return (\n *     <article style={{ opacity: isPending ? 0.5 : 1}}>\n *       {media?.type === 'image-asset' ? <img src={media.url} alt='' /> : ''}\n *       <h2>{title}</h2>\n *       <p>{subtitle}</p>\n *     </article>\n *   )\n * }\n *\n * // DocumentList.jsx\n * const { results, isPending } = useDocuments({ filter: '_type == \"movie\"' })\n * return (\n *   <div>\n *     <h1>Movies</h1>\n *     <ul>\n *       {isPending ? 'Loading…' : results.map(movie => (\n *         <li key={movie._id}>\n *           <Suspense fallback='Loading…'>\n *             <PreviewComponent document={movie} />\n *           </Suspense>\n *         </li>\n *       ))}\n *     </ul>\n *   </div>\n * )\n * ```\n */\nexport function usePreview({document: {_id, _type}, ref}: UsePreviewOptions): UsePreviewResults {\n  const instance = useSanityInstance()\n\n  const stateSource = useMemo(\n    () => getPreviewState(instance, {document: {_id, _type}}),\n    [instance, _id, _type],\n  )\n\n  // Create subscribe function for useSyncExternalStore\n  const subscribe = useCallback(\n    (onStoreChanged: () => void) => {\n      const subscription = new Observable<boolean>((observer) => {\n        // for environments that don't have an intersection observer\n        if (typeof IntersectionObserver === 'undefined' || typeof HTMLElement === 'undefined') {\n          return\n        }\n\n        const intersectionObserver = new IntersectionObserver(\n          ([entry]) => observer.next(entry.isIntersecting),\n          {rootMargin: '0px', threshold: 0},\n        )\n        if (ref?.current && ref.current instanceof HTMLElement) {\n          intersectionObserver.observe(ref.current)\n        }\n        return () => intersectionObserver.disconnect()\n      })\n        .pipe(\n          startWith(false),\n          distinctUntilChanged(),\n          switchMap((isVisible) =>\n            isVisible\n              ? new Observable<void>((obs) => {\n                  return stateSource.subscribe(() => obs.next())\n                })\n              : EMPTY,\n          ),\n        )\n        .subscribe({next: onStoreChanged})\n\n      return () => subscription.unsubscribe()\n    },\n    [stateSource, ref],\n  )\n\n  // Create getSnapshot function to return current state\n  const getSnapshot = useCallback(() => {\n    const currentState = stateSource.getCurrent()\n    if (currentState.results === null) throw resolvePreview(instance, {document: {_id, _type}})\n    return currentState as UsePreviewResults\n  }, [_id, _type, instance, stateSource])\n\n  return useSyncExternalStore(subscribe, getSnapshot)\n}\n"],"names":["state"],"mappings":";;;;;AASa,MAAA,eAAe,sBAAsB,aAAa,GCiBlD,iBAA2C,sBAAsB,mBAAmB;ACK1F,SAAS,UAAU,SAAsC;AACxD,QAAA,WAAW,qBAEX,YAAY;AAAA,IAChB,CAAC,kBAA8B;AAE7B,YAAM,eADU,sBAAsB,UAAU,OAAO,EAC1B,UAAU;AAAA,QACrC,MAAM;AAAA,QACN,OAAO,CAAC,UAAU;AAGR,kBAAA,MAAM,oCAAoC,KAAK;AAAA,QAAA;AAAA,MACzD,CACD;AACM,aAAA,MAAM,aAAa,YAAY;AAAA,IACxC;AAAA,IACA,CAAC,UAAU,OAAO;AAAA,EAAA,GAGd,cAAc,YAAY,MACvB,UAAU,UAAU,OAAO,GACjC,CAAC,UAAU,OAAO,CAAC;AAEf,SAAA,qBAAqB,WAAW,WAAW;AACpD;ACZO,SAAS,mBAGd,SAAoF;AAC9E,QAAA,EAAC,WAAW,cAAc,MAAM,UAAA,IAAa,SAC7C,WAAW,qBAEX,aAAa;AAAA,IACjB,MAAM,sBAAsB,UAAU,YAAY;AAAA,IAClD,CAAC,UAAU,YAAY;AAAA,KAGnB,UAAU;AAAA,IACd,MACE,mBAAmB,UAAU;AAAA,MAC3B;AAAA,MACA;AAAA,IAAA,CACD;AAAA,IACH,CAAC,UAAU,MAAM,SAAS;AAAA,EAC5B;AAEA,YAAU,MAAM;AACV,QAAA,CAAC,WAAW,CAAC,UAAW;AAE5B,UAAM,gBAAmC,CAAC;AAEnC,WAAA,OAAA,QAAQ,SAAS,EAAE,QAAQ,CAAC,CAAC,MAAM,OAAO,MAAM;AACrD,YAAM,cAAc,QAAQ,GAAG,MAAM,OAAO;AAC5C,oBAAc,KAAK,WAAW;AAAA,IAC/B,CAAA,GAEM,MAAM;AACX,oBAAc,QAAQ,CAAC,UAAU,MAAA,CAAO;AAAA,IAC1C;AAAA,EAAA,GACC,CAAC,SAAS,SAAS,CAAC;AAEvB,QAAM,UAAU;AAAA,IACd,CAAC,gBAAwB;AACjB,YAAA,eAAe,YAAY,UAAU,WAAW;AACtD,aAAO,MAAM;AACI,uBAAA;AAAA,MACjB;AAAA,IACF;AAAA,IACA,CAAC,UAAU;AAAA,KAGP,cAAc;AAAA,IAClB,CACE,MACA,SACG;AACM,eAAA,KAAK,MAAM,IAAI;AAAA,IAC1B;AAAA,IACA,CAAC,OAAO;AAAA,EACV;AAGA,SAAA,UAAU,MACD,MAAM;AACX,mBAAe,UAAU,IAAI;AAAA,EAAA,GAE9B,CAAC,MAAM,QAAQ,CAAC,GAEZ;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AC5EO,SAAS,oBAGd,SAAsF;AAChF,QAAA,EAAC,MAAM,WAAW,cAAa,SAC/B,WAAW,qBAEX,OAAO;AAAA,IACX,MAAM,gBAAgB,UAAU,EAAC,MAAM,WAAU;AAAA,IACjD,CAAC,UAAU,MAAM,SAAS;AAAA,EAC5B;AAEA,YAAU,MAAM;AACd,QAAI,CAAC,UAAW;AAEhB,UAAM,gBAAmC,CAAC;AAEnC,WAAA,OAAA,QAAQ,SAAS,EAAE,QAAQ,CAAC,CAAC,MAAM,OAAO,MAAM;AACrD,YAAM,cAAc,KAAK,GAAG,MAAM,OAA8C;AAChF,oBAAc,KAAK,WAAW;AAAA,IAC/B,CAAA,GAEM,MAAM;AACX,oBAAc,QAAQ,CAAC,UAAU,MAAA,CAAO;AAAA,IAC1C;AAAA,EAAA,GACC,CAAC,MAAM,SAAS,CAAC;AAEpB,QAAM,cAAc;AAAA,IAClB,CACE,MACA,SACG;AACG,YAAA,KAAK,MAAM,IAAI;AAAA,IACvB;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAGA,SAAA,UAAU,MACD,MAAM;AACX,gBAAY,UAAU,IAAI;AAAA,EAAA,GAE3B,CAAC,UAAU,IAAI,CAAC,GAEZ;AAAA,IACL;AAAA,EACF;AACF;AC1DA,MAAM,eAAe;AAAA,EACnB,SAAS,CAAC;AAAA,EACV,WAAW;AAAA,EACX,SAAS;AAAA,EACT,OAAO;AACT;AAqDgB,SAAA,aAAa,UAA+B,IAAwB;AAClF,QAAM,WAAW,kBAAkB,GAI7B,CAAC,GAAG,IAAI,SAIX,OAAO;AAAA,IACR,eAAe;AAAA,IACf,YAAY,MAAM;AAAA,IAClB,gBAAgB;AAAA,EAChB,EAAA,GAII,oBAAoB,KAAK,UAAU,OAAO;AAChD,YAAU,MAAM;AACd,QAAI,eAAe,WAAW,KAAK,MAAM,iBAAiB,CAAC;AAAA,EAAA,GAC1D,CAAC,KAAK,iBAAiB,CAAC;AAE3B,QAAM,YAAY;AAAA,IAChB,CAAC,mBAA+B;AAG1B,UAAA,gBAAgB,wBAAwB,QAAQ,GACpD,IAAI,cAAc,WAAW,IAAI,cAAc;AACzCA,YAAAA,SAAQ,IAAI,cAAc,SAAS;AACzC,UAAI,aAAaA,OAAM;AACjB,YAAA,cAAcA,OAAM,UAAU,cAAc;AAElD,aAAO,MAAM;AAEC,uBAEZ,IAAI,eAAe,QAAQ;AAAA,MAC7B;AAAA,IACF;AAAA,IACA,CAAC,UAAU,GAAG;AAAA,EAGV,GAAA,cAAc,YAAY,MACvB,IAAI,WAAW,GACrB,CAAC,GAAG,CAAC,GAEF,QAAQ,qBAAqB,WAAW,WAAW;AAMlD,SAAA,EAAC,UAJS,YAAY,MAAM;AACjC,QAAI,eAAe,SAAS;AAAA,KAC3B,CAAC,GAAG,CAAC,GAEU,GAAG,MAAK;AAC5B;ACnEgB,SAAA,WAAW,EAAC,UAAU,EAAC,KAAK,MAAK,GAAG,OAA4C;AACxF,QAAA,WAAW,qBAEX,cAAc;AAAA,IAClB,MAAM,gBAAgB,UAAU,EAAC,UAAU,EAAC,KAAK,MAAK,GAAE;AAAA,IACxD,CAAC,UAAU,KAAK,KAAK;AAAA,KAIjB,YAAY;AAAA,IAChB,CAAC,mBAA+B;AAC9B,YAAM,eAAe,IAAI,WAAoB,CAAC,aAAa;AAEzD,YAAI,OAAO,uBAAyB,OAAe,OAAO,cAAgB;AACxE;AAGF,cAAM,uBAAuB,IAAI;AAAA,UAC/B,CAAC,CAAC,KAAK,MAAM,SAAS,KAAK,MAAM,cAAc;AAAA,UAC/C,EAAC,YAAY,OAAO,WAAW,EAAC;AAAA,QAClC;AACA,eAAI,KAAK,WAAW,IAAI,mBAAmB,eACzC,qBAAqB,QAAQ,IAAI,OAAO,GAEnC,MAAM,qBAAqB,WAAW;AAAA,MAC9C,CAAA,EACE;AAAA,QACC,UAAU,EAAK;AAAA,QACf,qBAAqB;AAAA,QACrB;AAAA,UAAU,CAAC,cACT,YACI,IAAI,WAAiB,CAAC,QACb,YAAY,UAAU,MAAM,IAAI,KAAK,CAAC,CAC9C,IACD;AAAA,QAAA;AAAA,MAGP,EAAA,UAAU,EAAC,MAAM,gBAAe;AAE5B,aAAA,MAAM,aAAa,YAAY;AAAA,IACxC;AAAA,IACA,CAAC,aAAa,GAAG;AAAA,EAAA,GAIb,cAAc,YAAY,MAAM;AAC9B,UAAA,eAAe,YAAY,WAAW;AAC5C,QAAI,aAAa,YAAY,KAAM,OAAM,eAAe,UAAU,EAAC,UAAU,EAAC,KAAK,MAAK,EAAA,CAAE;AACnF,WAAA;AAAA,KACN,CAAC,KAAK,OAAO,UAAU,WAAW,CAAC;AAE/B,SAAA,qBAAqB,WAAW,WAAW;AACpD;"}
+{"version":3,"file":"hooks.js","sources":["../src/hooks/auth/useAuthToken.tsx","../src/hooks/auth/useCurrentUser.tsx","../src/hooks/client/useClient.ts","../src/hooks/comlink/useFrameConnection.ts","../src/hooks/comlink/useWindowConnection.ts","../src/hooks/document/useApplyActions.ts","../src/hooks/document/useDocument.ts","../src/hooks/document/useDocumentEvent.ts","../src/hooks/document/useDocumentSyncStatus.ts","../src/hooks/document/useEditDocument.ts","../src/hooks/documentCollection/useDocuments.ts","../src/hooks/preview/usePreview.tsx"],"sourcesContent":["import {getTokenState} from '@sanity/sdk'\n\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/**\n * Hook to get the currently logged in user\n * @internal\n * @returns The current user or null if not authenticated\n */\nexport const useAuthToken = createStateSourceHook(getTokenState)\n","import {type CurrentUser, getCurrentUserState} from '@sanity/sdk'\n\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/**\n * @TODO This should suspend! And possibly not return `null`?\n *\n * @public\n *\n * The `useCurrentUser` hook returns the currently authenticated user’s profile information (their name, email, roles, etc).\n * If no users are currently logged in, the hook returns null.\n *\n * @returns The current user data, or `null` if not authenticated\n *\n * @example Rendering a basic user profile\n * ```\n * const user = useCurrentUser()\n *\n * return (\n *   <figure>\n *     <img src={user?.profileImage} alt=`Profile image for ${user?.name}` />\n *     <h2>{user?.name}</h2>\n *   </figure>\n * )\n * ```\n */\nexport const useCurrentUser: () => CurrentUser | null = createStateSourceHook(getCurrentUserState)\n","import {type SanityClient} from '@sanity/client'\nimport {type ClientOptions, getClient, getSubscribableClient} from '@sanity/sdk'\nimport {useCallback, useSyncExternalStore} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * A React hook that provides a client that subscribes to changes in your application,\n * such as user authentication changes.\n *\n * @remarks\n * The hook uses `useSyncExternalStore` to safely subscribe to changes\n * and ensure consistency between server and client rendering.\n *\n * @returns A Sanity client\n *\n * @example\n * ```tsx\n * function MyComponent() {\n *   const client = useClient()\n *   const [document, setDocument] = useState(null)\n *   useEffect(async () => {\n *     const doc = client.fetch('*[_id == \"myDocumentId\"]')\n *     setDocument(doc)\n *   }, [])\n *  return <div>{JSON.stringify(document) ?? 'Loading...'}</div>\n * }\n * ```\n *\n * @public\n */\nexport function useClient(options: ClientOptions): SanityClient {\n  const instance = useSanityInstance()\n\n  const subscribe = useCallback(\n    (onStoreChange: () => void) => {\n      const client$ = getSubscribableClient(instance, options)\n      const subscription = client$.subscribe({\n        next: onStoreChange,\n        error: (error) => {\n          // @TODO: We should tackle error handling / error boundaries soon\n          // eslint-disable-next-line no-console\n          console.error('Error in useClient subscription:', error)\n        },\n      })\n      return () => subscription.unsubscribe()\n    },\n    [instance, options],\n  )\n\n  const getSnapshot = useCallback(() => {\n    return getClient(instance, options)\n  }, [instance, options])\n\n  return useSyncExternalStore(subscribe, getSnapshot)\n}\n","import {\n  type FrameMessage,\n  getOrCreateChannel,\n  getOrCreateController,\n  releaseChannel,\n  type WindowMessage,\n} from '@sanity/sdk'\nimport {useCallback, useEffect, useMemo} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @internal\n */\nexport type FrameMessageHandler<TWindowMessage extends WindowMessage> = (\n  event: TWindowMessage['data'],\n) => TWindowMessage['response'] | Promise<TWindowMessage['response']>\n\n/**\n * @internal\n */\nexport interface UseFrameConnectionOptions<TWindowMessage extends WindowMessage> {\n  name: string\n  connectTo: string\n  targetOrigin: string\n  onMessage?: Record<string, FrameMessageHandler<TWindowMessage>>\n}\n\n/**\n * @internal\n */\nexport interface FrameConnection<TFrameMessage extends FrameMessage> {\n  connect: (frameWindow: Window) => () => void // Return cleanup function\n  sendMessage: <T extends TFrameMessage['type']>(\n    ...params: Extract<TFrameMessage, {type: T}>['data'] extends undefined\n      ? [type: T]\n      : [type: T, data: Extract<TFrameMessage, {type: T}>['data']]\n  ) => void\n}\n\n/**\n * @internal\n */\nexport function useFrameConnection<\n  TFrameMessage extends FrameMessage,\n  TWindowMessage extends WindowMessage,\n>(options: UseFrameConnectionOptions<TWindowMessage>): FrameConnection<TFrameMessage> {\n  const {onMessage, targetOrigin, name, connectTo} = options\n  const instance = useSanityInstance()\n\n  const controller = useMemo(\n    () => getOrCreateController(instance, targetOrigin),\n    [instance, targetOrigin],\n  )\n\n  const channel = useMemo(\n    () =>\n      getOrCreateChannel(instance, {\n        name,\n        connectTo,\n      }),\n    [instance, name, connectTo],\n  )\n\n  useEffect(() => {\n    if (!channel || !onMessage) return\n\n    const unsubscribers: Array<() => void> = []\n\n    Object.entries(onMessage).forEach(([type, handler]) => {\n      const unsubscribe = channel.on(type, handler)\n      unsubscribers.push(unsubscribe)\n    })\n\n    return () => {\n      unsubscribers.forEach((unsub) => unsub())\n    }\n  }, [channel, onMessage])\n\n  const connect = useCallback(\n    (frameWindow: Window) => {\n      const removeTarget = controller?.addTarget(frameWindow)\n      return () => {\n        removeTarget?.()\n      }\n    },\n    [controller],\n  )\n\n  const sendMessage = useCallback(\n    <T extends TFrameMessage['type']>(\n      type: T,\n      data?: Extract<TFrameMessage, {type: T}>['data'],\n    ) => {\n      channel?.post(type, data)\n    },\n    [channel],\n  )\n\n  // cleanup channel on unmount\n  useEffect(() => {\n    return () => {\n      releaseChannel(instance, name)\n    }\n  }, [name, instance])\n\n  return {\n    connect,\n    sendMessage,\n  }\n}\n","import {type FrameMessage, getOrCreateNode, releaseNode, type WindowMessage} from '@sanity/sdk'\nimport {useCallback, useEffect, useMemo} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @internal\n */\nexport type WindowMessageHandler<TFrameMessage extends FrameMessage> = (\n  event: TFrameMessage['data'],\n) => TFrameMessage['response']\n\n/**\n * @internal\n */\nexport interface UseWindowConnectionOptions<TMessage extends FrameMessage> {\n  name: string\n  connectTo: string\n  onMessage?: Record<TMessage['type'], WindowMessageHandler<TMessage>>\n}\n\n/**\n * @internal\n */\nexport interface WindowConnection<TMessage extends WindowMessage> {\n  sendMessage: <TType extends TMessage['type']>(\n    type: TType,\n    data?: Extract<TMessage, {type: TType}>['data'],\n  ) => void\n}\n\n/**\n * @internal\n */\nexport function useWindowConnection<\n  TWindowMessage extends WindowMessage,\n  TFrameMessage extends FrameMessage,\n>(options: UseWindowConnectionOptions<TFrameMessage>): WindowConnection<TWindowMessage> {\n  const {name, onMessage, connectTo} = options\n  const instance = useSanityInstance()\n\n  const node = useMemo(\n    () => getOrCreateNode(instance, {name, connectTo}),\n    [instance, name, connectTo],\n  )\n\n  useEffect(() => {\n    if (!onMessage) return\n\n    const unsubscribers: Array<() => void> = []\n\n    Object.entries(onMessage).forEach(([type, handler]) => {\n      const unsubscribe = node.on(type, handler as WindowMessageHandler<TFrameMessage>)\n      unsubscribers.push(unsubscribe)\n    })\n\n    return () => {\n      unsubscribers.forEach((unsub) => unsub())\n    }\n  }, [node, onMessage])\n\n  const sendMessage = useCallback(\n    <TType extends WindowMessage['type']>(\n      type: TType,\n      data?: Extract<WindowMessage, {type: TType}>['data'],\n    ) => {\n      node?.post(type, data)\n    },\n    [node],\n  )\n\n  // cleanup node on unmount\n  useEffect(() => {\n    return () => {\n      releaseNode(instance, name)\n    }\n  }, [instance, name])\n\n  return {\n    sendMessage,\n  }\n}\n","import {\n  type ActionsResult,\n  applyActions,\n  type ApplyActionsOptions,\n  type DocumentAction,\n} from '@sanity/sdk'\nimport {type SanityDocument} from '@sanity/types'\n\nimport {createCallbackHook} from '../helpers/createCallbackHook'\n\n/** @beta */\nexport function useApplyActions(): <TDocument extends SanityDocument>(\n  action: DocumentAction<TDocument> | DocumentAction<TDocument>[],\n  options?: ApplyActionsOptions,\n) => Promise<ActionsResult<TDocument>>\n/** @beta */\nexport function useApplyActions(): (\n  action: DocumentAction | DocumentAction[],\n  options?: ApplyActionsOptions,\n) => Promise<ActionsResult> {\n  return _useApplyActions()\n}\n\nconst _useApplyActions = createCallbackHook(applyActions)\n","import {\n  type DocumentHandle,\n  getDocumentState,\n  type JsonMatch,\n  type JsonMatchPath,\n  resolveDocument,\n} from '@sanity/sdk'\nimport {type SanityDocument} from '@sanity/types'\nimport {useCallback, useMemo, useSyncExternalStore} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/** @beta */\nexport function useDocument<\n  TDocument extends SanityDocument,\n  TPath extends JsonMatchPath<TDocument>,\n>(doc: string | DocumentHandle<TDocument>, path: TPath): JsonMatch<TDocument, TPath> | undefined\n/** @beta */\nexport function useDocument<TDocument extends SanityDocument>(\n  doc: string | DocumentHandle<TDocument>,\n): TDocument | null\n/** @beta */\nexport function useDocument(doc: string | DocumentHandle, path?: string): unknown {\n  const documentId = typeof doc === 'string' ? doc : doc._id\n  const instance = useSanityInstance()\n  const isDocumentReady = useCallback(\n    () => getDocumentState(instance, documentId).getCurrent() !== undefined,\n    [instance, documentId],\n  )\n  if (!isDocumentReady()) throw resolveDocument(instance, documentId)\n\n  const {subscribe, getCurrent} = useMemo(\n    () => getDocumentState(instance, documentId, path),\n    [documentId, instance, path],\n  )\n\n  return useSyncExternalStore(subscribe, getCurrent)\n}\n","import {type DocumentEvent, subscribeDocumentEvents} from '@sanity/sdk'\nimport {useCallback, useEffect, useInsertionEffect, useRef} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/** @beta */\nexport function useDocumentEvent(handler: (documentEvent: DocumentEvent) => void): void {\n  const ref = useRef(handler)\n\n  useInsertionEffect(() => {\n    ref.current = handler\n  })\n\n  const stableHandler = useCallback((documentEvent: DocumentEvent) => {\n    return ref.current(documentEvent)\n  }, [])\n\n  const instance = useSanityInstance()\n  useEffect(() => {\n    return subscribeDocumentEvents(instance, stableHandler)\n  }, [instance, stableHandler])\n}\n","import {getDocumentSyncStatus} from '@sanity/sdk'\n\nimport {createStateSourceHook} from '../helpers/createStateSourceHook'\n\n/** @beta */\nexport const useDocumentSyncStatus = createStateSourceHook(getDocumentSyncStatus)\n","import {\n  type ActionsResult,\n  type DocumentHandle,\n  editDocument,\n  getDocumentState,\n  type JsonMatch,\n  type JsonMatchPath,\n  resolveDocument,\n} from '@sanity/sdk'\nimport {type SanityDocument} from '@sanity/types'\nimport {useCallback} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\nimport {useApplyActions} from './useApplyActions'\n\nconst ignoredKeys = ['_id', '_type', '_createdAt', '_updatedAt', '_rev']\n\n/** @beta */\nexport function useEditDocument<\n  TDocument extends SanityDocument,\n  TPath extends JsonMatchPath<TDocument>,\n>(\n  doc: string | DocumentHandle<TDocument>,\n  path: TPath,\n): (nextValue: JsonMatch<TDocument, TPath>) => Promise<ActionsResult<TDocument>>\n/** @beta */\nexport function useEditDocument<TDocument extends SanityDocument>(\n  doc: string | DocumentHandle<TDocument>,\n): (nextValue: Partial<TDocument>) => Promise<ActionsResult<TDocument>>\n/** @beta */\nexport function useEditDocument(\n  doc: string | DocumentHandle,\n  path?: string,\n): (nextValue: unknown) => Promise<ActionsResult> {\n  const documentId = typeof doc === 'string' ? doc : doc._id\n  const instance = useSanityInstance()\n  const apply = useApplyActions()\n  const isDocumentReady = useCallback(\n    () => getDocumentState(instance, documentId).getCurrent() !== undefined,\n    [instance, documentId],\n  )\n  if (!isDocumentReady()) throw resolveDocument(instance, documentId)\n\n  return useCallback(\n    (next: unknown) => {\n      if (path) {\n        return apply(editDocument(documentId, {set: {[path]: next}}))\n      }\n\n      const current = getDocumentState(instance, documentId).getCurrent()\n\n      if (typeof next !== 'object' || !next) {\n        throw new Error(\n          `No path was provided to \\`useEditDocument\\` and the value provided was not a document object.`,\n        )\n      }\n\n      const editActions = Object.entries(next)\n        .filter(([key]) => !ignoredKeys.includes(key))\n        .filter(([key, value]) => current?.[key] !== value)\n        .map(([key, value]) => editDocument(documentId, {set: {[key]: value}}))\n\n      return apply(editActions)\n    },\n    [apply, documentId, instance, path],\n  )\n}\n","import {createDocumentListStore, type DocumentHandle, type DocumentListOptions} from '@sanity/sdk'\nimport {useCallback, useEffect, useState, useSyncExternalStore} from 'react'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @public\n */\nexport interface DocumentCollection {\n  /** Retrieve more documents matching the provided options */\n  loadMore: () => void\n  /** The retrieved document handles of the documents matching the provided options */\n  results: DocumentHandle[]\n  /** Whether a retrieval of documents is in flight */\n  isPending: boolean\n  /** Whether more documents exist that match the provided options than have been retrieved */\n  hasMore: boolean\n  /** The total number of documents in the collection */\n  count: number\n}\n\ntype DocumentListStore = ReturnType<typeof createDocumentListStore>\ntype DocumentListState = ReturnType<DocumentListStore['getState']>['getCurrent']\nconst STABLE_EMPTY = {\n  results: [],\n  isPending: false,\n  hasMore: false,\n  count: 0,\n}\n\n/**\n * @public\n *\n * The `useDocuments` hook retrieves and provides access to a live collection of documents, optionally filtered, sorted, and matched to a given Content Lake perspective.\n * Because the returned document collection is live, the results will update in real time until the component invoking the hook is unmounted.\n *\n * @param options - Options for narrowing and sorting the document collection\n * @returns The collection of documents matching the provided options (if any), as well as properties describing the collection and a function to load more.\n *\n * @example Retrieving all documents of type 'movie'\n * ```\n * const { results, isPending } = useDocuments({ filter: '_type == \"movie\"' })\n *\n * return (\n *   <div>\n *     <h1>Movies</h1>\n *     {results && (\n *       <ul>\n *         {results.map(movie => (<li key={movie._id}>…</li>))}\n *       </ul>\n *     )}\n *     {isPending && <div>Loading movies…</div>}\n *   </div>\n * )\n * ```\n *\n * @example Retrieving all movies released since 1980, sorted by director’s last name\n * ```\n * const { results } = useDocuments({\n *   filter: '_type == \"movie\" && releaseDate >= \"1980-01-01\"',\n *   sort: [\n *     {\n *       // Expand the `director` reference field with the dereferencing operator `->`\n *       field: 'director->lastName',\n *       sort: 'asc',\n *     },\n *   ],\n * })\n *\n * return (\n *   <div>\n *      <h1>Movies released since 1980</h1>\n *      {results && (\n *        <ol>\n *          {results.map(movie => (<li key={movie._id}>…</li>))}\n *        </ol>\n *     )}\n *   </div>\n * )\n * ```\n */\nexport function useDocuments(options: DocumentListOptions = {}): DocumentCollection {\n  const instance = useSanityInstance()\n\n  // NOTE: useState is used because it guaranteed to return a stable reference\n  // across renders\n  const [ref] = useState<{\n    storeInstance: DocumentListStore | null\n    getCurrent: DocumentListState\n    initialOptions: DocumentListOptions\n  }>(() => ({\n    storeInstance: null,\n    getCurrent: () => STABLE_EMPTY,\n    initialOptions: options,\n  }))\n\n  // serialize options to ensure it only calls `setOptions` when the values\n  // themselves changes (in cases where devs put config inline)\n  const serializedOptions = JSON.stringify(options)\n  useEffect(() => {\n    ref.storeInstance?.setOptions(JSON.parse(serializedOptions))\n  }, [ref, serializedOptions])\n\n  const subscribe = useCallback(\n    (onStoreChanged: () => void) => {\n      // to match the lifecycle of `useSyncExternalState`, we create the store\n      // instance after subscribe and mutate the ref to connect everything\n      ref.storeInstance = createDocumentListStore(instance)\n      ref.storeInstance.setOptions(ref.initialOptions)\n      const state = ref.storeInstance.getState()\n      ref.getCurrent = state.getCurrent\n      const unsubscribe = state.subscribe(onStoreChanged)\n\n      return () => {\n        // unsubscribe to clean up the state subscriptions\n        unsubscribe()\n        // dispose of the instance\n        ref.storeInstance?.dispose()\n      }\n    },\n    [instance, ref],\n  )\n\n  const getSnapshot = useCallback(() => {\n    return ref.getCurrent()\n  }, [ref])\n\n  const state = useSyncExternalStore(subscribe, getSnapshot)\n\n  const loadMore = useCallback(() => {\n    ref.storeInstance?.loadMore()\n  }, [ref])\n\n  return {loadMore, ...state}\n}\n","import {type DocumentHandle, getPreviewState, type PreviewValue, resolvePreview} from '@sanity/sdk'\nimport {useCallback, useMemo, useSyncExternalStore} from 'react'\nimport {distinctUntilChanged, EMPTY, Observable, startWith, switchMap} from 'rxjs'\n\nimport {useSanityInstance} from '../context/useSanityInstance'\n\n/**\n * @alpha\n */\nexport interface UsePreviewOptions {\n  document: DocumentHandle\n  ref?: React.RefObject<unknown>\n}\n\n/**\n * @alpha\n */\nexport interface UsePreviewResults {\n  /** The results of resolving the document’s preview values */\n  results: PreviewValue\n  /** True when preview values are being refreshed */\n  isPending: boolean\n}\n\n/**\n * @alpha\n *\n * The `usePreview` hook takes a document (via a `DocumentHandle`) and returns its resolved preview values,\n * including the document’s `title`, `subtitle`, `media`, and `status`. These values are live and will update in realtime.\n * To reduce unnecessary network requests for resolving the preview values, an optional `ref` can be passed to the hook so that preview\n * resolution will only occur if the `ref` is intersecting the current viewport.\n *\n * @param options - The document handle for the document you want to resolve preview values for, and an optional ref\n * @returns The preview values for the given document and a boolean to indicate whether the resolution is pending\n *\n * @example Combining with useDocuments to render a collection of document previews\n * ```\n * // PreviewComponent.jsx\n * export default function PreviewComponent({ document }) {\n *   const { results: { title, subtitle, media }, isPending } = usePreview({ document })\n *   return (\n *     <article style={{ opacity: isPending ? 0.5 : 1}}>\n *       {media?.type === 'image-asset' ? <img src={media.url} alt='' /> : ''}\n *       <h2>{title}</h2>\n *       <p>{subtitle}</p>\n *     </article>\n *   )\n * }\n *\n * // DocumentList.jsx\n * const { results, isPending } = useDocuments({ filter: '_type == \"movie\"' })\n * return (\n *   <div>\n *     <h1>Movies</h1>\n *     <ul>\n *       {isPending ? 'Loading…' : results.map(movie => (\n *         <li key={movie._id}>\n *           <Suspense fallback='Loading…'>\n *             <PreviewComponent document={movie} />\n *           </Suspense>\n *         </li>\n *       ))}\n *     </ul>\n *   </div>\n * )\n * ```\n */\nexport function usePreview({document: {_id, _type}, ref}: UsePreviewOptions): UsePreviewResults {\n  const instance = useSanityInstance()\n\n  const stateSource = useMemo(\n    () => getPreviewState(instance, {document: {_id, _type}}),\n    [instance, _id, _type],\n  )\n\n  // Create subscribe function for useSyncExternalStore\n  const subscribe = useCallback(\n    (onStoreChanged: () => void) => {\n      const subscription = new Observable<boolean>((observer) => {\n        // for environments that don't have an intersection observer\n        if (typeof IntersectionObserver === 'undefined' || typeof HTMLElement === 'undefined') {\n          return\n        }\n\n        const intersectionObserver = new IntersectionObserver(\n          ([entry]) => observer.next(entry.isIntersecting),\n          {rootMargin: '0px', threshold: 0},\n        )\n        if (ref?.current && ref.current instanceof HTMLElement) {\n          intersectionObserver.observe(ref.current)\n        }\n        return () => intersectionObserver.disconnect()\n      })\n        .pipe(\n          startWith(false),\n          distinctUntilChanged(),\n          switchMap((isVisible) =>\n            isVisible\n              ? new Observable<void>((obs) => {\n                  return stateSource.subscribe(() => obs.next())\n                })\n              : EMPTY,\n          ),\n        )\n        .subscribe({next: onStoreChanged})\n\n      return () => subscription.unsubscribe()\n    },\n    [stateSource, ref],\n  )\n\n  // Create getSnapshot function to return current state\n  const getSnapshot = useCallback(() => {\n    const currentState = stateSource.getCurrent()\n    if (currentState.results === null) throw resolvePreview(instance, {document: {_id, _type}})\n    return currentState as UsePreviewResults\n  }, [_id, _type, instance, stateSource])\n\n  return useSyncExternalStore(subscribe, getSnapshot)\n}\n"],"names":["state"],"mappings":";;;;;AASa,MAAA,eAAe,sBAAsB,aAAa,GCiBlD,iBAA2C,sBAAsB,mBAAmB;ACK1F,SAAS,UAAU,SAAsC;AACxD,QAAA,WAAW,qBAEX,YAAY;AAAA,IAChB,CAAC,kBAA8B;AAE7B,YAAM,eADU,sBAAsB,UAAU,OAAO,EAC1B,UAAU;AAAA,QACrC,MAAM;AAAA,QACN,OAAO,CAAC,UAAU;AAGR,kBAAA,MAAM,oCAAoC,KAAK;AAAA,QAAA;AAAA,MACzD,CACD;AACM,aAAA,MAAM,aAAa,YAAY;AAAA,IACxC;AAAA,IACA,CAAC,UAAU,OAAO;AAAA,EAAA,GAGd,cAAc,YAAY,MACvB,UAAU,UAAU,OAAO,GACjC,CAAC,UAAU,OAAO,CAAC;AAEf,SAAA,qBAAqB,WAAW,WAAW;AACpD;ACZO,SAAS,mBAGd,SAAoF;AAC9E,QAAA,EAAC,WAAW,cAAc,MAAM,UAAA,IAAa,SAC7C,WAAW,qBAEX,aAAa;AAAA,IACjB,MAAM,sBAAsB,UAAU,YAAY;AAAA,IAClD,CAAC,UAAU,YAAY;AAAA,KAGnB,UAAU;AAAA,IACd,MACE,mBAAmB,UAAU;AAAA,MAC3B;AAAA,MACA;AAAA,IAAA,CACD;AAAA,IACH,CAAC,UAAU,MAAM,SAAS;AAAA,EAC5B;AAEA,YAAU,MAAM;AACV,QAAA,CAAC,WAAW,CAAC,UAAW;AAE5B,UAAM,gBAAmC,CAAC;AAEnC,WAAA,OAAA,QAAQ,SAAS,EAAE,QAAQ,CAAC,CAAC,MAAM,OAAO,MAAM;AACrD,YAAM,cAAc,QAAQ,GAAG,MAAM,OAAO;AAC5C,oBAAc,KAAK,WAAW;AAAA,IAC/B,CAAA,GAEM,MAAM;AACX,oBAAc,QAAQ,CAAC,UAAU,MAAA,CAAO;AAAA,IAC1C;AAAA,EAAA,GACC,CAAC,SAAS,SAAS,CAAC;AAEvB,QAAM,UAAU;AAAA,IACd,CAAC,gBAAwB;AACjB,YAAA,eAAe,YAAY,UAAU,WAAW;AACtD,aAAO,MAAM;AACI,uBAAA;AAAA,MACjB;AAAA,IACF;AAAA,IACA,CAAC,UAAU;AAAA,KAGP,cAAc;AAAA,IAClB,CACE,MACA,SACG;AACM,eAAA,KAAK,MAAM,IAAI;AAAA,IAC1B;AAAA,IACA,CAAC,OAAO;AAAA,EACV;AAGA,SAAA,UAAU,MACD,MAAM;AACX,mBAAe,UAAU,IAAI;AAAA,EAAA,GAE9B,CAAC,MAAM,QAAQ,CAAC,GAEZ;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AC5EO,SAAS,oBAGd,SAAsF;AAChF,QAAA,EAAC,MAAM,WAAW,cAAa,SAC/B,WAAW,qBAEX,OAAO;AAAA,IACX,MAAM,gBAAgB,UAAU,EAAC,MAAM,WAAU;AAAA,IACjD,CAAC,UAAU,MAAM,SAAS;AAAA,EAC5B;AAEA,YAAU,MAAM;AACd,QAAI,CAAC,UAAW;AAEhB,UAAM,gBAAmC,CAAC;AAEnC,WAAA,OAAA,QAAQ,SAAS,EAAE,QAAQ,CAAC,CAAC,MAAM,OAAO,MAAM;AACrD,YAAM,cAAc,KAAK,GAAG,MAAM,OAA8C;AAChF,oBAAc,KAAK,WAAW;AAAA,IAC/B,CAAA,GAEM,MAAM;AACX,oBAAc,QAAQ,CAAC,UAAU,MAAA,CAAO;AAAA,IAC1C;AAAA,EAAA,GACC,CAAC,MAAM,SAAS,CAAC;AAEpB,QAAM,cAAc;AAAA,IAClB,CACE,MACA,SACG;AACG,YAAA,KAAK,MAAM,IAAI;AAAA,IACvB;AAAA,IACA,CAAC,IAAI;AAAA,EACP;AAGA,SAAA,UAAU,MACD,MAAM;AACX,gBAAY,UAAU,IAAI;AAAA,EAAA,GAE3B,CAAC,UAAU,IAAI,CAAC,GAEZ;AAAA,IACL;AAAA,EACF;AACF;ACjEO,SAAS,kBAGY;AAC1B,SAAO,iBAAiB;AAC1B;AAEA,MAAM,mBAAmB,mBAAmB,YAAY;ACDxC,SAAA,YAAY,KAA8B,MAAwB;AAC1E,QAAA,aAAa,OAAO,OAAQ,WAAW,MAAM,IAAI,KACjD,WAAW,kBAAkB;AAKnC,MAAI,CAJoB;AAAA,IACtB,MAAM,iBAAiB,UAAU,UAAU,EAAE,WAAiB,MAAA;AAAA,IAC9D,CAAC,UAAU,UAAU;AAAA,EAEF,EAAA,EAAS,OAAA,gBAAgB,UAAU,UAAU;AAE5D,QAAA,EAAC,WAAW,WAAA,IAAc;AAAA,IAC9B,MAAM,iBAAiB,UAAU,YAAY,IAAI;AAAA,IACjD,CAAC,YAAY,UAAU,IAAI;AAAA,EAC7B;AAEO,SAAA,qBAAqB,WAAW,UAAU;AACnD;AC/BO,SAAS,iBAAiB,SAAuD;AAChF,QAAA,MAAM,OAAO,OAAO;AAE1B,qBAAmB,MAAM;AACvB,QAAI,UAAU;AAAA,EAAA,CACf;AAED,QAAM,gBAAgB,YAAY,CAAC,kBAC1B,IAAI,QAAQ,aAAa,GAC/B,CAAA,CAAE,GAEC,WAAW,kBAAkB;AACzB,YAAA,MACD,wBAAwB,UAAU,aAAa,GACrD,CAAC,UAAU,aAAa,CAAC;AAC9B;AChBa,MAAA,wBAAwB,sBAAsB,qBAAqB,GCU1E,cAAc,CAAC,OAAO,SAAS,cAAc,cAAc,MAAM;AAevD,SAAA,gBACd,KACA,MACgD;AAC1C,QAAA,aAAa,OAAO,OAAQ,WAAW,MAAM,IAAI,KACjD,WAAW,qBACX,QAAQ,gBAAgB;AAK9B,MAAI,CAJoB;AAAA,IACtB,MAAM,iBAAiB,UAAU,UAAU,EAAE,WAAiB,MAAA;AAAA,IAC9D,CAAC,UAAU,UAAU;AAAA,EAEF,EAAA,EAAS,OAAA,gBAAgB,UAAU,UAAU;AAE3D,SAAA;AAAA,IACL,CAAC,SAAkB;AACb,UAAA;AACF,eAAO,MAAM,aAAa,YAAY,EAAC,KAAK,EAAC,CAAC,IAAI,GAAG,KAAK,EAAA,CAAC,CAAC;AAG9D,YAAM,UAAU,iBAAiB,UAAU,UAAU,EAAE,WAAW;AAE9D,UAAA,OAAO,QAAS,YAAY,CAAC;AAC/B,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAGI,YAAA,cAAc,OAAO,QAAQ,IAAI,EACpC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,YAAY,SAAS,GAAG,CAAC,EAC5C,OAAO,CAAC,CAAC,KAAK,KAAK,MAAM,UAAU,GAAG,MAAM,KAAK,EACjD,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,aAAa,YAAY,EAAC,KAAK,EAAC,CAAC,GAAG,GAAG,MAAK,EAAA,CAAE,CAAC;AAExE,aAAO,MAAM,WAAW;AAAA,IAC1B;AAAA,IACA,CAAC,OAAO,YAAY,UAAU,IAAI;AAAA,EACpC;AACF;AC3CA,MAAM,eAAe;AAAA,EACnB,SAAS,CAAC;AAAA,EACV,WAAW;AAAA,EACX,SAAS;AAAA,EACT,OAAO;AACT;AAqDgB,SAAA,aAAa,UAA+B,IAAwB;AAClF,QAAM,WAAW,kBAAkB,GAI7B,CAAC,GAAG,IAAI,SAIX,OAAO;AAAA,IACR,eAAe;AAAA,IACf,YAAY,MAAM;AAAA,IAClB,gBAAgB;AAAA,EAChB,EAAA,GAII,oBAAoB,KAAK,UAAU,OAAO;AAChD,YAAU,MAAM;AACd,QAAI,eAAe,WAAW,KAAK,MAAM,iBAAiB,CAAC;AAAA,EAAA,GAC1D,CAAC,KAAK,iBAAiB,CAAC;AAE3B,QAAM,YAAY;AAAA,IAChB,CAAC,mBAA+B;AAG1B,UAAA,gBAAgB,wBAAwB,QAAQ,GACpD,IAAI,cAAc,WAAW,IAAI,cAAc;AACzCA,YAAAA,SAAQ,IAAI,cAAc,SAAS;AACzC,UAAI,aAAaA,OAAM;AACjB,YAAA,cAAcA,OAAM,UAAU,cAAc;AAElD,aAAO,MAAM;AAEC,uBAEZ,IAAI,eAAe,QAAQ;AAAA,MAC7B;AAAA,IACF;AAAA,IACA,CAAC,UAAU,GAAG;AAAA,EAGV,GAAA,cAAc,YAAY,MACvB,IAAI,WAAW,GACrB,CAAC,GAAG,CAAC,GAEF,QAAQ,qBAAqB,WAAW,WAAW;AAMlD,SAAA,EAAC,UAJS,YAAY,MAAM;AACjC,QAAI,eAAe,SAAS;AAAA,KAC3B,CAAC,GAAG,CAAC,GAEU,GAAG,MAAK;AAC5B;ACnEgB,SAAA,WAAW,EAAC,UAAU,EAAC,KAAK,MAAK,GAAG,OAA4C;AACxF,QAAA,WAAW,qBAEX,cAAc;AAAA,IAClB,MAAM,gBAAgB,UAAU,EAAC,UAAU,EAAC,KAAK,MAAK,GAAE;AAAA,IACxD,CAAC,UAAU,KAAK,KAAK;AAAA,KAIjB,YAAY;AAAA,IAChB,CAAC,mBAA+B;AAC9B,YAAM,eAAe,IAAI,WAAoB,CAAC,aAAa;AAEzD,YAAI,OAAO,uBAAyB,OAAe,OAAO,cAAgB;AACxE;AAGF,cAAM,uBAAuB,IAAI;AAAA,UAC/B,CAAC,CAAC,KAAK,MAAM,SAAS,KAAK,MAAM,cAAc;AAAA,UAC/C,EAAC,YAAY,OAAO,WAAW,EAAC;AAAA,QAClC;AACA,eAAI,KAAK,WAAW,IAAI,mBAAmB,eACzC,qBAAqB,QAAQ,IAAI,OAAO,GAEnC,MAAM,qBAAqB,WAAW;AAAA,MAC9C,CAAA,EACE;AAAA,QACC,UAAU,EAAK;AAAA,QACf,qBAAqB;AAAA,QACrB;AAAA,UAAU,CAAC,cACT,YACI,IAAI,WAAiB,CAAC,QACb,YAAY,UAAU,MAAM,IAAI,KAAK,CAAC,CAC9C,IACD;AAAA,QAAA;AAAA,MAGP,EAAA,UAAU,EAAC,MAAM,gBAAe;AAE5B,aAAA,MAAM,aAAa,YAAY;AAAA,IACxC;AAAA,IACA,CAAC,aAAa,GAAG;AAAA,EAAA,GAIb,cAAc,YAAY,MAAM;AAC9B,UAAA,eAAe,YAAY,WAAW;AAC5C,QAAI,aAAa,YAAY,KAAM,OAAM,eAAe,UAAU,EAAC,UAAU,EAAC,KAAK,MAAK,EAAA,CAAE;AACnF,WAAA;AAAA,KACN,CAAC,KAAK,OAAO,UAAU,WAAW,CAAC;AAE/B,SAAA,qBAAqB,WAAW,WAAW;AACpD;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/sdk-react",
-  "version": "0.0.0-alpha.8",
+  "version": "0.0.0-alpha.9",
   "private": false,
   "description": "Sanity SDK React toolkit for Content OS",
   "keywords": [
@@ -69,10 +69,11 @@
   "dependencies": {
     "@sanity/logos": "^2.1.13",
     "@sanity/os": "^0.2.0",
+    "@sanity/types": "^3.67.1",
     "@sanity/ui": "^2.8.19",
     "react-error-boundary": "^4.1.2",
     "rxjs": "^7.8.1",
-    "@sanity/sdk": "0.0.0-alpha.8"
+    "@sanity/sdk": "0.0.0-alpha.9"
   },
   "devDependencies": {
     "@sanity/client": "^6.27.2",

package/src/_exports/hooks.ts

@@ -18,6 +18,11 @@ export {
   type WindowMessageHandler,
 } from '../hooks/comlink/useWindowConnection'
 export {useSanityInstance} from '../hooks/context/useSanityInstance'
+export {useApplyActions} from '../hooks/document/useApplyActions'
+export {useDocument} from '../hooks/document/useDocument'
+export {useDocumentEvent} from '../hooks/document/useDocumentEvent'
+export {useDocumentSyncStatus} from '../hooks/document/useDocumentSyncStatus'
+export {useEditDocument} from '../hooks/document/useEditDocument'
 export {type DocumentCollection, useDocuments} from '../hooks/documentCollection/useDocuments'
 export {
   usePreview,

package/src/hooks/document/useApplyActions.test.ts

@@ -0,0 +1,24 @@
+import {applyActions, createDocument} from '@sanity/sdk'
+import {describe, it} from 'vitest'
+
+import {createCallbackHook} from '../helpers/createCallbackHook'
+
+vi.mock('../helpers/createCallbackHook', () => ({
+  createCallbackHook: vi.fn((cb) => () => cb),
+}))
+vi.mock('@sanity/sdk', async (importOriginal) => {
+  const original = await importOriginal<typeof import('@sanity/sdk')>()
+  return {...original, applyActions: vi.fn()}
+})
+
+describe('useApplyActions', () => {
+  it('calls `createCallbackHook` with `applyActions`', async () => {
+    const {useApplyActions} = await import('./useApplyActions')
+    expect(createCallbackHook).toHaveBeenCalledWith(applyActions)
+
+    expect(applyActions).not.toHaveBeenCalled()
+    const apply = useApplyActions()
+    apply(createDocument({_type: 'author'}))
+    expect(applyActions).toHaveBeenCalled()
+  })
+})

package/src/hooks/document/useApplyActions.ts

@@ -0,0 +1,24 @@
+import {
+  type ActionsResult,
+  applyActions,
+  type ApplyActionsOptions,
+  type DocumentAction,
+} from '@sanity/sdk'
+import {type SanityDocument} from '@sanity/types'
+
+import {createCallbackHook} from '../helpers/createCallbackHook'
+
+/** @beta */
+export function useApplyActions(): <TDocument extends SanityDocument>(
+  action: DocumentAction<TDocument> | DocumentAction<TDocument>[],
+  options?: ApplyActionsOptions,
+) => Promise<ActionsResult<TDocument>>
+/** @beta */
+export function useApplyActions(): (
+  action: DocumentAction | DocumentAction[],
+  options?: ApplyActionsOptions,
+) => Promise<ActionsResult> {
+  return _useApplyActions()
+}
+
+const _useApplyActions = createCallbackHook(applyActions)

package/src/hooks/document/useDocument.test.ts

@@ -0,0 +1,81 @@
+// tests/useDocument.test.ts
+import {
+  createSanityInstance,
+  getDocumentState,
+  resolveDocument,
+  type StateSource,
+} from '@sanity/sdk'
+import {type SanityDocument} from '@sanity/types'
+import {renderHook} from '@testing-library/react'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+import {useDocument} from './useDocument'
+
+vi.mock('@sanity/sdk', async (importOriginal) => {
+  const original = await importOriginal<typeof import('@sanity/sdk')>()
+  return {...original, getDocumentState: vi.fn(), resolveDocument: vi.fn()}
+})
+
+vi.mock('../context/useSanityInstance', () => ({
+  useSanityInstance: vi.fn(),
+}))
+
+// Create a fake instance to be returned by useSanityInstance.
+const instance = createSanityInstance({projectId: 'p', dataset: 'd'})
+const doc: SanityDocument = {
+  _id: 'doc1',
+  foo: 'bar',
+  _type: 'book',
+  _rev: 'tx0',
+  _createdAt: '2025-02-06T00:11:00.000Z',
+  _updatedAt: '2025-02-06T00:11:00.000Z',
+}
+
+describe('useDocument hook', () => {
+  beforeEach(() => {
+    vi.resetAllMocks()
+    vi.mocked(useSanityInstance).mockReturnValue(instance)
+  })
+
+  it('returns the current document when ready (without a path)', () => {
+    const getCurrent = vi.fn().mockReturnValue(doc)
+    const subscribe = vi.fn().mockReturnValue(vi.fn())
+    vi.mocked(getDocumentState).mockReturnValue({
+      getCurrent,
+      subscribe,
+    } as unknown as StateSource<unknown>)
+
+    const {result} = renderHook(() => useDocument('doc1'))
+
+    expect(result.current).toEqual(doc)
+    expect(getCurrent).toHaveBeenCalled()
+    expect(subscribe).toHaveBeenCalled()
+  })
+
+  it('throws a promise (suspends) when the document is not ready', () => {
+    const getCurrent = vi.fn().mockReturnValue(undefined)
+    const subscribe = vi.fn().mockReturnValue(vi.fn())
+    vi.mocked(getDocumentState).mockReturnValue({
+      getCurrent,
+      subscribe,
+    } as unknown as StateSource<unknown>)
+
+    const resolveDocPromise = Promise.resolve(doc)
+
+    // Also, simulate resolveDocument to return a known promise.
+    vi.mocked(resolveDocument).mockReturnValue(resolveDocPromise)
+
+    // Render the hook and capture the thrown promise.
+    const {result} = renderHook(() => {
+      try {
+        return useDocument('doc1')
+      } catch (e) {
+        return e
+      }
+    })
+
+    // When the document is not ready, the hook throws the promise from resolveDocument.
+    expect(result.current).toBe(resolveDocPromise)
+  })
+})

package/src/hooks/document/useDocument.ts

@@ -0,0 +1,38 @@
+import {
+  type DocumentHandle,
+  getDocumentState,
+  type JsonMatch,
+  type JsonMatchPath,
+  resolveDocument,
+} from '@sanity/sdk'
+import {type SanityDocument} from '@sanity/types'
+import {useCallback, useMemo, useSyncExternalStore} from 'react'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+
+/** @beta */
+export function useDocument<
+  TDocument extends SanityDocument,
+  TPath extends JsonMatchPath<TDocument>,
+>(doc: string | DocumentHandle<TDocument>, path: TPath): JsonMatch<TDocument, TPath> | undefined
+/** @beta */
+export function useDocument<TDocument extends SanityDocument>(
+  doc: string | DocumentHandle<TDocument>,
+): TDocument | null
+/** @beta */
+export function useDocument(doc: string | DocumentHandle, path?: string): unknown {
+  const documentId = typeof doc === 'string' ? doc : doc._id
+  const instance = useSanityInstance()
+  const isDocumentReady = useCallback(
+    () => getDocumentState(instance, documentId).getCurrent() !== undefined,
+    [instance, documentId],
+  )
+  if (!isDocumentReady()) throw resolveDocument(instance, documentId)
+
+  const {subscribe, getCurrent} = useMemo(
+    () => getDocumentState(instance, documentId, path),
+    [documentId, instance, path],
+  )
+
+  return useSyncExternalStore(subscribe, getCurrent)
+}

package/src/hooks/document/useDocumentEvent.test.ts

@@ -0,0 +1,53 @@
+// tests/useDocumentEvent.test.ts
+import {createSanityInstance, type DocumentEvent, subscribeDocumentEvents} from '@sanity/sdk'
+import {renderHook} from '@testing-library/react'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+import {useDocumentEvent} from './useDocumentEvent'
+
+vi.mock('@sanity/sdk', async (importOriginal) => {
+  const original = await importOriginal<typeof import('@sanity/sdk')>()
+  return {...original, subscribeDocumentEvents: vi.fn()}
+})
+
+vi.mock('../context/useSanityInstance', () => ({
+  useSanityInstance: vi.fn(),
+}))
+
+const instance = createSanityInstance({projectId: 'p', dataset: 'd'})
+
+describe('useDocumentEvent hook', () => {
+  beforeEach(() => {
+    vi.resetAllMocks()
+    vi.mocked(useSanityInstance).mockReturnValue(instance)
+  })
+
+  it('calls subscribeDocumentEvents with instance and a stable handler', () => {
+    const handler = vi.fn()
+    const unsubscribe = vi.fn()
+    vi.mocked(subscribeDocumentEvents).mockReturnValue(unsubscribe)
+
+    renderHook(() => useDocumentEvent(handler))
+
+    expect(vi.mocked(subscribeDocumentEvents)).toHaveBeenCalledTimes(1)
+    expect(vi.mocked(subscribeDocumentEvents).mock.calls[0][0]).toBe(instance)
+
+    const stableHandler = vi.mocked(subscribeDocumentEvents).mock.calls[0][1]
+    expect(typeof stableHandler).toBe('function')
+
+    const event = {type: 'edited', documentId: 'doc1', outgoing: {}} as DocumentEvent
+    stableHandler(event)
+    expect(handler).toHaveBeenCalledWith(event)
+  })
+
+  it('calls the unsubscribe function on unmount', () => {
+    const handler = vi.fn()
+    const unsubscribe = vi.fn()
+    vi.mocked(subscribeDocumentEvents).mockReturnValue(unsubscribe)
+
+    const {unmount} = renderHook(() => useDocumentEvent(handler))
+    unmount()
+    expect(unsubscribe).toHaveBeenCalledTimes(1)
+  })
+})

package/src/hooks/document/useDocumentEvent.ts

@@ -0,0 +1,22 @@
+import {type DocumentEvent, subscribeDocumentEvents} from '@sanity/sdk'
+import {useCallback, useEffect, useInsertionEffect, useRef} from 'react'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+
+/** @beta */
+export function useDocumentEvent(handler: (documentEvent: DocumentEvent) => void): void {
+  const ref = useRef(handler)
+
+  useInsertionEffect(() => {
+    ref.current = handler
+  })
+
+  const stableHandler = useCallback((documentEvent: DocumentEvent) => {
+    return ref.current(documentEvent)
+  }, [])
+
+  const instance = useSanityInstance()
+  useEffect(() => {
+    return subscribeDocumentEvents(instance, stableHandler)
+  }, [instance, stableHandler])
+}

package/src/hooks/document/useDocumentSyncStatus.test.ts

@@ -0,0 +1,16 @@
+import {getDocumentSyncStatus} from '@sanity/sdk'
+import {identity} from 'rxjs'
+import {describe, it} from 'vitest'
+
+import {createStateSourceHook} from '../helpers/createStateSourceHook'
+
+vi.mock('../helpers/createStateSourceHook', () => ({createStateSourceHook: vi.fn(identity)}))
+vi.mock('@sanity/sdk', () => ({getDocumentSyncStatus: vi.fn()}))
+
+describe('useAuthToken', () => {
+  it('calls `createStateSourceHook` with `getTokenState`', async () => {
+    const {useDocumentSyncStatus} = await import('./useDocumentSyncStatus')
+    expect(createStateSourceHook).toHaveBeenCalledWith(getDocumentSyncStatus)
+    expect(useDocumentSyncStatus).toBe(getDocumentSyncStatus)
+  })
+})

package/src/hooks/document/useDocumentSyncStatus.ts

@@ -0,0 +1,6 @@
+import {getDocumentSyncStatus} from '@sanity/sdk'
+
+import {createStateSourceHook} from '../helpers/createStateSourceHook'
+
+/** @beta */
+export const useDocumentSyncStatus = createStateSourceHook(getDocumentSyncStatus)

package/src/hooks/document/useEditDocument.test.ts

@@ -0,0 +1,134 @@
+// tests/useEditDocument.test.ts
+import {
+  createSanityInstance,
+  editDocument,
+  getDocumentState,
+  resolveDocument,
+  type StateSource,
+} from '@sanity/sdk'
+import {type SanityDocument} from '@sanity/types'
+import {renderHook} from '@testing-library/react'
+import {beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+import {useApplyActions} from './useApplyActions'
+import {useEditDocument} from './useEditDocument'
+
+vi.mock('@sanity/sdk', async (importOriginal) => {
+  const original = await importOriginal<typeof import('@sanity/sdk')>()
+  return {
+    ...original,
+    getDocumentState: vi.fn(),
+    resolveDocument: vi.fn(),
+    editDocument: vi.fn(original.editDocument),
+  }
+})
+
+vi.mock('../context/useSanityInstance', () => ({
+  useSanityInstance: vi.fn(),
+}))
+
+vi.mock('./useApplyActions', () => ({
+  useApplyActions: vi.fn(),
+}))
+
+// Create a fake instance to be returned by useSanityInstance.
+const instance = createSanityInstance({projectId: 'p', dataset: 'd'})
+
+const doc: SanityDocument = {
+  _id: 'doc1',
+  foo: 'bar',
+  _type: 'book',
+  _rev: 'tx0',
+  _createdAt: '2025-02-06T00:11:00.000Z',
+  _updatedAt: '2025-02-06T00:11:00.000Z',
+}
+
+describe('useEditDocument hook', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+    vi.mocked(useSanityInstance).mockReturnValue(instance)
+  })
+
+  it('applies a single edit action for the given path', async () => {
+    const getCurrent = vi.fn().mockReturnValue(doc)
+    const subscribe = vi.fn().mockReturnValue(vi.fn())
+    vi.mocked(getDocumentState).mockReturnValue({
+      getCurrent,
+      subscribe,
+    } as unknown as StateSource<SanityDocument>)
+
+    const apply = vi.fn().mockResolvedValue({transactionId: 'tx1'})
+    vi.mocked(useApplyActions).mockReturnValue(apply)
+
+    const {result} = renderHook(() => useEditDocument('doc1', 'foo'))
+    const promise = result.current('newValue')
+    expect(editDocument).toHaveBeenCalledWith('doc1', {set: {foo: 'newValue'}})
+    expect(apply).toHaveBeenCalledWith(editDocument('doc1', {set: {foo: 'newValue'}}))
+    const actionsResult = await promise
+    expect(actionsResult).toEqual({transactionId: 'tx1'})
+  })
+
+  it('applies edit actions for changed fields', async () => {
+    // Set up current document state.
+    const currentDoc = {...doc, foo: 'bar', extra: 'old'}
+    const getCurrent = vi.fn().mockReturnValue(currentDoc)
+    const subscribe = vi.fn().mockReturnValue(vi.fn())
+    vi.mocked(getDocumentState).mockReturnValue({
+      getCurrent,
+      subscribe,
+    } as unknown as StateSource<SanityDocument>)
+
+    const apply = vi.fn().mockResolvedValue({transactionId: 'tx2'})
+    vi.mocked(useApplyActions).mockReturnValue(apply)
+
+    const {result} = renderHook(() => useEditDocument('doc1'))
+    const promise = result.current({foo: 'baz', extra: 'old', _id: 'doc1'})
+    expect(apply).toHaveBeenCalledWith([editDocument('doc1', {set: {foo: 'baz'}})])
+    const actionsResult = await promise
+    expect(actionsResult).toEqual({transactionId: 'tx2'})
+  })
+
+  it('throws an error if next value is not an object', () => {
+    const getCurrent = vi.fn().mockReturnValue(doc)
+    const subscribe = vi.fn().mockReturnValue(vi.fn())
+    vi.mocked(getDocumentState).mockReturnValue({
+      getCurrent,
+      subscribe,
+    } as unknown as StateSource<SanityDocument>)
+
+    const fakeApply = vi.fn()
+    vi.mocked(useApplyActions).mockReturnValue(fakeApply)
+
+    const {result} = renderHook(() => useEditDocument('doc1'))
+    expect(() => result.current('notAnObject' as unknown as Partial<SanityDocument>)).toThrowError(
+      'No path was provided to `useEditDocument` and the value provided was not a document object.',
+    )
+  })
+
+  it('throws a promise (suspends) when the document is not ready', () => {
+    const getCurrent = vi.fn().mockReturnValue(undefined)
+    const subscribe = vi.fn().mockReturnValue(vi.fn())
+    vi.mocked(getDocumentState).mockReturnValue({
+      getCurrent,
+      subscribe,
+    } as unknown as StateSource<unknown>)
+
+    const resolveDocPromise = Promise.resolve(doc)
+
+    // Also, simulate resolveDocument to return a known promise.
+    vi.mocked(resolveDocument).mockReturnValue(resolveDocPromise)
+
+    // Render the hook and capture the thrown promise.
+    const {result} = renderHook(() => {
+      try {
+        return useEditDocument('doc1')
+      } catch (e) {
+        return e
+      }
+    })
+
+    // When the document is not ready, the hook throws the promise from resolveDocument.
+    expect(result.current).toBe(resolveDocPromise)
+  })
+})

package/src/hooks/document/useEditDocument.ts

@@ -0,0 +1,67 @@
+import {
+  type ActionsResult,
+  type DocumentHandle,
+  editDocument,
+  getDocumentState,
+  type JsonMatch,
+  type JsonMatchPath,
+  resolveDocument,
+} from '@sanity/sdk'
+import {type SanityDocument} from '@sanity/types'
+import {useCallback} from 'react'
+
+import {useSanityInstance} from '../context/useSanityInstance'
+import {useApplyActions} from './useApplyActions'
+
+const ignoredKeys = ['_id', '_type', '_createdAt', '_updatedAt', '_rev']
+
+/** @beta */
+export function useEditDocument<
+  TDocument extends SanityDocument,
+  TPath extends JsonMatchPath<TDocument>,
+>(
+  doc: string | DocumentHandle<TDocument>,
+  path: TPath,
+): (nextValue: JsonMatch<TDocument, TPath>) => Promise<ActionsResult<TDocument>>
+/** @beta */
+export function useEditDocument<TDocument extends SanityDocument>(
+  doc: string | DocumentHandle<TDocument>,
+): (nextValue: Partial<TDocument>) => Promise<ActionsResult<TDocument>>
+/** @beta */
+export function useEditDocument(
+  doc: string | DocumentHandle,
+  path?: string,
+): (nextValue: unknown) => Promise<ActionsResult> {
+  const documentId = typeof doc === 'string' ? doc : doc._id
+  const instance = useSanityInstance()
+  const apply = useApplyActions()
+  const isDocumentReady = useCallback(
+    () => getDocumentState(instance, documentId).getCurrent() !== undefined,
+    [instance, documentId],
+  )
+  if (!isDocumentReady()) throw resolveDocument(instance, documentId)
+
+  return useCallback(
+    (next: unknown) => {
+      if (path) {
+        return apply(editDocument(documentId, {set: {[path]: next}}))
+      }
+
+      const current = getDocumentState(instance, documentId).getCurrent()
+
+      if (typeof next !== 'object' || !next) {
+        throw new Error(
+          `No path was provided to \`useEditDocument\` and the value provided was not a document object.`,
+        )
+      }
+
+      const editActions = Object.entries(next)
+        .filter(([key]) => !ignoredKeys.includes(key))
+        .filter(([key, value]) => current?.[key] !== value)
+        .map(([key, value]) => editDocument(documentId, {set: {[key]: value}}))
+
+      return apply(editActions)
+    },
+    [apply, documentId, instance, path],
+  )
+}