@sanity/sdk-react 2.12.0 → 2.14.0

package/dist/index.d.ts

@@ -41,6 +41,7 @@ import {QueryOptions} from '@sanity/sdk'
 import {default as React_2} from 'react'
 import {ReactElement} from 'react'
 import {ReactNode} from 'react'
+import {ReleaseAction} from '@sanity/sdk'
 import {ReleaseDocument} from '@sanity/sdk'
 import {SanityClient} from '@sanity/client'
 import {SanityConfig} from '@sanity/sdk'
@@ -1594,6 +1595,82 @@ declare interface UseApplyDocumentActions {
  */
 export declare const useApplyDocumentActions: UseApplyDocumentActions
 
+/**
+ * @public
+ */
+declare interface UseApplyReleaseActions {
+  (): (action: ReleaseAction | ReleaseAction[], options?: ResourceHandle) => Promise<ActionsResult>
+}
+
+/**
+ * @public
+ *
+ * Provides a stable callback function for applying one or more release actions.
+ *
+ * This hook wraps the core `applyDocumentActions` functionality from `@sanity/sdk`,
+ * integrating it with the React component lifecycle and {@link SanityInstance}.
+ * It accepts release-lifecycle actions generated by {@link createRelease},
+ * {@link editRelease}, {@link publishRelease}, {@link scheduleRelease},
+ * {@link unscheduleRelease}, {@link archiveRelease}, {@link unarchiveRelease},
+ * and {@link deleteRelease}.
+ *
+ * Note that actions submitted via this hook will cascade to the documents in the release.
+ * For example, if you create a release and then publish it, the documents in the release will be published.
+ * If you delete a published release, the version documents will be deleted.
+ *
+ * Features:
+ * - Applies one or multiple `ReleaseAction` objects.
+ * - Supports optimistic updates for create/edit/delete: local release state
+ *   reflects changes immediately while in-flight.
+ * - Handles batching: multiple actions passed together are submitted as a
+ *   single atomic transaction.
+ *
+ * Release actions cannot be combined with `liveEdit` document actions in the
+ * same transaction. Submit them as separate transactions if you need both.
+ *
+ * @category Releases
+ * @returns A stable callback. When called with a single `ReleaseAction` or an
+ * array of `ReleaseAction`s, it returns a promise that resolves to an
+ * {@link ActionsResult}.
+ *
+ * @example Create and schedule a release
+ * ```tsx
+ * import {
+ *   createRelease,
+ *   scheduleRelease,
+ *   useApplyReleaseActions,
+ *   type ReleaseHandle,
+ * } from '@sanity/sdk-react'
+ *
+ * function ScheduleReleaseButton({release}: {release: ReleaseHandle}) {
+ *   const applyRelease = useApplyReleaseActions()
+ *
+ *   const handleSchedule = () =>
+ *     applyRelease([
+ *       createRelease(release, {title: 'Summer drop', releaseType: 'asap'}),
+ *       scheduleRelease(release, '2026-06-01T00:00:00Z'),
+ *     ])
+ *
+ *   return <button onClick={handleSchedule}>Schedule</button>
+ * }
+ * ```
+ *
+ * @example Publish a release
+ * ```tsx
+ * import {publishRelease, useApplyReleaseActions} from '@sanity/sdk-react'
+ *
+ * function PublishButton({releaseId}: {releaseId: string}) {
+ *   const applyRelease = useApplyReleaseActions()
+ *   return (
+ *     <button onClick={() => applyRelease(publishRelease({releaseId}))}>
+ *       Publish all documents in the release
+ *     </button>
+ *   )
+ * }
+ * ```
+ */
+export declare const useApplyReleaseActions: UseApplyReleaseActions
+
 /**
  * @internal
  * A React hook that subscribes to authentication state changes.

package/dist/index.js

@@ -53,7 +53,7 @@ function useWindowConnection(t0) {
     node
   } = useNodeState(t1);
   let t2;
-  $[3] === Symbol.for("react.memo_cache_sentinel") ? (t2 = [], $[3] = t2) : t2 = $[3];
+  $[3] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t2 = [], $[3] = t2) : t2 = $[3];
   const messageUnsubscribers = useRef(t2), instance = useSanityInstance();
   let t3;
   $[4] !== node || $[5] !== onMessage ? (t3 = () => (onMessage && Object.entries(onMessage).forEach((t42) => {
@@ -87,12 +87,12 @@ function DashboardTokenRefresh(t0) {
     children
   } = t0, instance = useSanityInstance(), isTokenRefreshInProgress = useRef(!1), timeoutRef = useRef(null), processed401ErrorRef = useRef(null), authState = useAuthState();
   let t1;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t1 = () => {
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t1 = () => {
     timeoutRef.current && (clearTimeout(timeoutRef.current), timeoutRef.current = null);
   }, $[0] = t1) : t1 = $[0];
   const clearRefreshTimeout = t1;
   let t2;
-  $[1] === Symbol.for("react.memo_cache_sentinel") ? (t2 = {
+  $[1] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t2 = {
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME
   }, $[1] = t2) : t2 = $[1];
@@ -118,7 +118,7 @@ function DashboardTokenRefresh(t0) {
   }, $[2] = instance, $[3] = windowConnection, $[4] = t3) : t3 = $[4];
   const requestNewToken = t3;
   let t4, t5;
-  $[5] === Symbol.for("react.memo_cache_sentinel") ? (t4 = () => () => {
+  $[5] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t4 = () => () => {
     clearRefreshTimeout();
   }, t5 = [clearRefreshTimeout], $[5] = t4, $[6] = t5) : (t4 = $[5], t5 = $[6]), useEffect(t4, t5);
   let t6;
@@ -256,15 +256,15 @@ function reload() {
 function ChunkLoadError(_props) {
   const $ = c(4);
   let t0;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = readChunkReloadFlag(), $[0] = t0) : t0 = $[0];
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t0 = readChunkReloadFlag(), $[0] = t0) : t0 = $[0];
   const alreadyAttempted = t0;
   let t1, t2;
-  if ($[1] === Symbol.for("react.memo_cache_sentinel") ? (t1 = () => {
+  if ($[1] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t1 = () => {
     alreadyAttempted || (setChunkReloadFlag(), reload());
   }, t2 = [alreadyAttempted], $[1] = t1, $[2] = t2) : (t1 = $[1], t2 = $[2]), useEffect(t1, t2), !alreadyAttempted)
     return null;
   let t3;
-  return $[3] === Symbol.for("react.memo_cache_sentinel") ? (t3 = /* @__PURE__ */ jsx(Error$1, { heading: "A new version is available", description: "The page tried to load an asset that no longer exists. Reload to continue with the latest version.", cta: {
+  return $[3] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t3 = /* @__PURE__ */ jsx(Error$1, { heading: "A new version is available", description: "The page tried to load an asset that no longer exists. Reload to continue with the latest version.", cta: {
     text: "Reload page",
     onClick: _temp$6
   } }), $[3] = t3) : t3 = $[3], t3;
@@ -342,7 +342,7 @@ function DashboardAccessRequest(t0) {
     projectId
   } = t0;
   let t1;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t1 = {
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t1 = {
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME
   }, $[0] = t1) : t1 = $[0];
@@ -557,7 +557,7 @@ const ResourcesContext = createContext({});
 function ResetChunkReloadFlagOnMount() {
   const $ = c(1);
   let t0;
-  return $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = [], $[0] = t0) : t0 = $[0], useEffect(_temp$4, t0), null;
+  return $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t0 = [], $[0] = t0) : t0 = $[0], useEffect(_temp$4, t0), null;
 }
 function _temp$4() {
   clearChunkReloadFlag();
@@ -599,7 +599,7 @@ function SDKProvider(t0) {
   }
   const resourcesValue = t3;
   let t4;
-  $[17] === Symbol.for("react.memo_cache_sentinel") ? (t4 = /* @__PURE__ */ jsx(ResetChunkReloadFlagOnMount, {}), $[17] = t4) : t4 = $[17];
+  $[17] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t4 = /* @__PURE__ */ jsx(ResetChunkReloadFlagOnMount, {}), $[17] = t4) : t4 = $[17];
   let t5;
   $[18] !== children || $[19] !== resourcesValue ? (t5 = /* @__PURE__ */ jsx(ResourcesContext.Provider, { value: resourcesValue, children }), $[18] = children, $[19] = resourcesValue, $[20] = t5) : t5 = $[20];
   let t6;
@@ -659,7 +659,7 @@ function SanityApp(t0) {
       break bb0;
     }
     let t22;
-    $[7] === Symbol.for("react.memo_cache_sentinel") ? (t22 = [], $[7] = t22) : t22 = $[7], t1 = t22;
+    $[7] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t22 = [], $[7] = t22) : t22 = $[7], t1 = t22;
   }
   const resolvedConfig = t1;
   let t2, t3;
@@ -804,7 +804,7 @@ function useAgentResourceContext(options) {
     documentId
   } = options;
   let t0;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = {
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t0 = {
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME
   }, $[0] = t0) : t0 = $[0];
@@ -889,7 +889,7 @@ function useFrameConnection(options) {
     };
   }, t1 = [targetOrigin, name, connectTo, heartbeat, onMessage, instance, onStatus], $[0] = connectTo, $[1] = heartbeat, $[2] = instance, $[3] = name, $[4] = onMessage, $[5] = onStatus, $[6] = targetOrigin, $[7] = t0, $[8] = t1) : (t0 = $[7], t1 = $[8]), useEffect(t0, t1);
   let t2;
-  $[9] === Symbol.for("react.memo_cache_sentinel") ? (t2 = (frameWindow) => {
+  $[9] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t2 = (frameWindow) => {
     const removeTarget = controllerRef.current?.addTarget(frameWindow);
     return () => {
       removeTarget?.();
@@ -897,12 +897,12 @@ function useFrameConnection(options) {
   }, $[9] = t2) : t2 = $[9];
   const connect = t2;
   let t3;
-  $[10] === Symbol.for("react.memo_cache_sentinel") ? (t3 = (type_0, data) => {
+  $[10] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t3 = (type_0, data) => {
     channelRef.current?.post(type_0, data);
   }, $[10] = t3) : t3 = $[10];
   const sendMessage = t3;
   let t4;
-  return $[11] === Symbol.for("react.memo_cache_sentinel") ? (t4 = {
+  return $[11] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t4 = {
     connect,
     sendMessage
   }, $[11] = t4) : t4 = $[11], t4;
@@ -1047,10 +1047,10 @@ function useManageFavorite({
 function useStudioWorkspacesByProjectIdDataset() {
   const $ = c(8);
   let t0;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = {}, $[0] = t0) : t0 = $[0];
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t0 = {}, $[0] = t0) : t0 = $[0];
   const [workspacesByProjectIdAndDataset, setWorkspacesByProjectIdAndDataset] = useState(t0), [error, setError] = useState(null);
   let t1;
-  $[1] === Symbol.for("react.memo_cache_sentinel") ? (t1 = {
+  $[1] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t1 = {
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME
   }, $[1] = t1) : t1 = $[1];
@@ -1100,7 +1100,7 @@ function useNavigateToStudioDocument(documentHandle, preferredStudioUrl) {
     workspacesByProjectIdAndDataset
   } = useStudioWorkspacesByProjectIdDataset();
   let t0;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = {
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t0 = {
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME
   }, $[0] = t0) : t0 = $[0];
@@ -1153,7 +1153,7 @@ function useRecordDocumentHistoryEvent(t0) {
     schemaName
   } = t0;
   let t1;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t1 = {
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t1 = {
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME
   }, $[0] = t1) : t1 = $[0];
@@ -1198,7 +1198,7 @@ function resolveAppTitle(resource) {
 function useWindowTitle(viewTitle) {
   const $ = c(8), [appTitle, setAppTitle] = useState(null);
   let t0;
-  $[0] === Symbol.for("react.memo_cache_sentinel") ? (t0 = {
+  $[0] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t0 = {
     name: SDK_NODE_NAME,
     connectTo: SDK_CHANNEL_NAME
   }, $[0] = t0) : t0 = $[0];
@@ -1244,15 +1244,18 @@ const useDatasets = createStateSourceHook({
   ),
   suspender: resolveDatasets,
   getConfig: identity
-}), useApplyDocumentActions = () => {
+});
+function useApplyActions() {
   const $ = c(4), instance = useSanityInstance(), resources = useContext(ResourcesContext), effectiveContextResource = useEffectiveContextResource();
   let t0;
   return $[0] !== effectiveContextResource || $[1] !== instance || $[2] !== resources ? (t0 = (actionOrActions, options) => {
     const actions = Array.isArray(actionOrActions) ? actionOrActions : [actionOrActions], optionsResource = options ? normalizeResourceOptions(options, resources, effectiveContextResource).resource : void 0, normalizedActions = actions.map((action) => normalizeResourceOptions(action, resources, effectiveContextResource));
     let resource;
-    for (const action_0 of normalizedActions)
-      if (!resource && action_0.resource && (resource = action_0.resource), !isDeepEqual(action_0.resource, resource))
-        throw new Error(`Mismatched resources found in actions. All actions must belong to the same resource. Found "${JSON.stringify(action_0.resource)}" but expected "${JSON.stringify(resource)}".`);
+    for (const action_0 of normalizedActions) {
+      const actionResource = action_0.resource;
+      if (!resource && actionResource && (resource = actionResource), !isDeepEqual(actionResource, resource))
+        throw new Error(`Mismatched resources found in actions. All actions must belong to the same resource. Found "${JSON.stringify(actionResource)}" but expected "${JSON.stringify(resource)}".`);
+    }
     if (optionsResource && resource && !isDeepEqual(optionsResource, resource))
       throw new Error(`Mismatched resources found in actions. Found top-level resource "${JSON.stringify(optionsResource)}" but expected resource from action handles "${JSON.stringify(resource)}".`);
     const effectiveResource = resource ?? optionsResource ?? effectiveContextResource;
@@ -1263,7 +1266,8 @@ const useDatasets = createStateSourceHook({
       resource: effectiveResource
     });
   }, $[0] = effectiveContextResource, $[1] = instance, $[2] = resources, $[3] = t0) : t0 = $[3], t0;
-};
+}
+const useApplyDocumentActions = () => useApplyActions();
 function useTrackHookUsage(hookName) {
   const instance = useSanityInstance(), tracked = useRef(null);
   tracked.current === null && (tracked.current = !0, trackHookMounted(instance, hookName));
@@ -1309,7 +1313,7 @@ function useDocumentEvent(options) {
     ref.current = onEvent;
   }, $[3] = onEvent, $[4] = t0) : t0 = $[4], useInsertionEffect(t0);
   let t1;
-  $[5] === Symbol.for("react.memo_cache_sentinel") ? (t1 = (documentEvent) => ref.current(documentEvent), $[5] = t1) : t1 = $[5];
+  $[5] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t1 = (documentEvent) => ref.current(documentEvent), $[5] = t1) : t1 = $[5];
   const stableHandler = t1, instance = useSanityInstance();
   let t2, t3;
   $[6] !== datasetHandle.resource || $[7] !== instance ? (t2 = () => subscribeDocumentEvents(instance, {
@@ -1580,10 +1584,10 @@ function usePaginatedDocuments(t0) {
     count
   } = t15, totalPages = Math.ceil(count / pageSize), currentPage = pageIndex + 1;
   let t16;
-  $[36] === Symbol.for("react.memo_cache_sentinel") ? (t16 = () => setPageIndex(0), $[36] = t16) : t16 = $[36];
+  $[36] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t16 = () => setPageIndex(0), $[36] = t16) : t16 = $[36];
   const firstPage = t16;
   let t17;
-  $[37] === Symbol.for("react.memo_cache_sentinel") ? (t17 = () => setPageIndex(_temp4), $[37] = t17) : t17 = $[37];
+  $[37] === /* @__PURE__ */ Symbol.for("react.memo_cache_sentinel") ? (t17 = () => setPageIndex(_temp4), $[37] = t17) : t17 = $[37];
   const previousPage = t17;
   let t18;
   $[38] !== totalPages ? (t18 = () => setPageIndex((prev_0) => Math.min(prev_0 + 1, totalPages - 1)), $[38] = totalPages, $[39] = t18) : t18 = $[39];
@@ -1681,7 +1685,7 @@ function useDocumentProjection({
         threshold: 0
       });
       return ref?.current && ref.current instanceof HTMLElement ? intersectionObserver.observe(ref.current) : observer.next(!0), () => intersectionObserver.disconnect();
-    }).pipe(startWith(!1), distinctUntilChanged(), switchMap((isVisible) => isVisible ? new Observable((obs) => stateSource.subscribe(() => obs.next())) : EMPTY)).subscribe({
+    }).pipe(startWith(!1), distinctUntilChanged(), switchMap((isVisible) => isVisible ? new Observable((obs) => (obs.next(), stateSource.subscribe(() => obs.next()))) : EMPTY)).subscribe({
       next: onStoreChanged
     });
     return () => subscription.unsubscribe();
@@ -1747,7 +1751,7 @@ function useAllReleases(options) {
   const normalizedOptions = useNormalizedResourceOptions(t0);
   return useAllReleasesValue(normalizedOptions);
 }
-const usePerspectiveValue = createStateSourceHook({
+const useApplyReleaseActions = () => useApplyActions(), usePerspectiveValue = createStateSourceHook({
   getState: getPerspectiveState,
   shouldSuspend: (instance, options) => getPerspectiveState(instance, options).getCurrent() === void 0,
   suspender: (instance, _options) => firstValueFrom(getPerspectiveState(instance, _options ?? {}).observable.pipe(filter(Boolean)))
@@ -1813,7 +1817,7 @@ function useUsers(options) {
     loadMore
   };
 }
-var version = "2.12.0";
+var version = "2.14.0";
 function getEnv(key) {
   if (typeof import.meta < "u" && import.meta.env)
     return import.meta.env[key];
@@ -1842,6 +1846,7 @@ export {
   useAgentTranslate,
   useAllReleases,
   useApplyDocumentActions,
+  useApplyReleaseActions,
   useAuthState,
   useAuthToken,
   useClient,