@sanity/sdk-react 2.11.1 → 2.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/sdk-react",
-  "version": "2.11.1",
+  "version": "2.12.0",
   "private": false,
   "description": "Sanity SDK React toolkit for Content OS",
   "keywords": [
@@ -45,12 +45,12 @@
   "dependencies": {
     "@sanity/client": "^7.22.0",
     "@sanity/message-protocol": "^0.23.0",
-    "@sanity/types": "^5.24.0",
+    "@sanity/types": "^5.26.0",
     "groq": "3.88.1-typegen-experimental.0",
     "react-compiler-runtime": "19.1.0-rc.2",
     "react-error-boundary": "^6.1.1",
     "rxjs": "^7.8.2",
-    "@sanity/sdk": "2.11.1"
+    "@sanity/sdk": "2.12.0"
   },
   "devDependencies": {
     "@sanity/browserslist-config": "^1.0.5",
@@ -59,11 +59,11 @@
     "@sanity/prettier-config": "^1.0.6",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.2",
-    "@types/node": "^24.12.3",
-    "@types/react": "^19.2.14",
+    "@types/node": "^24.12.4",
+    "@types/react": "^19.2.15",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^4.7.0",
-    "@vitest/coverage-v8": "4.1.5",
+    "@vitest/coverage-v8": "4.1.6",
     "babel-plugin-react-compiler": "19.1.0-rc.1",
     "eslint": "^9.39.4",
     "groq-js": "^1.30.1",
@@ -74,12 +74,12 @@
     "rollup-plugin-visualizer": "^5.14.0",
     "typescript": "^5.9.3",
     "vite": "^7.3.3",
-    "vitest": "^4.1.5",
-    "@repo/package.bundle": "3.82.0",
+    "vitest": "^4.1.6",
+    "@repo/config-eslint": "0.0.0",
     "@repo/config-test": "0.0.1",
     "@repo/tsconfig": "0.0.1",
-    "@repo/config-eslint": "0.0.0",
-    "@repo/package.config": "0.0.1"
+    "@repo/package.config": "0.0.1",
+    "@repo/package.bundle": "3.82.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",

package/src/_exports/sdk-react.ts

@@ -91,6 +91,7 @@ export {useProject} from '../hooks/projects/useProject'
 export {type ProjectWithoutMembers, useProjects} from '../hooks/projects/useProjects'
 export {useQuery} from '../hooks/query/useQuery'
 export {useActiveReleases} from '../hooks/releases/useActiveReleases'
+export {useAllReleases} from '../hooks/releases/useAllReleases'
 export {usePerspective} from '../hooks/releases/usePerspective'
 export {type UserResult, useUser} from '../hooks/users/useUser'
 export {type UsersResult, useUsers} from '../hooks/users/useUsers'

package/src/hooks/releases/useActiveReleases.test.tsx

@@ -20,14 +20,14 @@ describe('useActiveReleases', () => {
     vi.clearAllMocks()
   })
 
-  it('should suspend when initial state is undefined', () => {
+  it('suspends until the releases state source emits, then resolves with the data', async () => {
     const mockSubject = new BehaviorSubject<ReleaseDocument[] | undefined>(undefined)
     const mockStateSource = {
       subscribe: vi.fn((callback) => {
         const subscription = mockSubject.subscribe(callback)
         return () => subscription.unsubscribe()
       }),
-      getCurrent: vi.fn(() => undefined),
+      getCurrent: vi.fn(() => mockSubject.getValue()),
       observable: mockSubject,
     }
 
@@ -50,15 +50,21 @@ describe('useActiveReleases', () => {
       },
     )
 
-    // Verify that the hook threw a promise (suspended)
     expect(result.current).toBeInstanceOf(Promise)
     expect(mockStateSource.getCurrent).toHaveBeenCalled()
+
+    const resolved: ReleaseDocument[] = [
+      {_id: 'release1', _type: 'release'} as unknown as ReleaseDocument,
+    ]
+    mockSubject.next(resolved)
+
+    await expect(result.current).resolves.toEqual(resolved)
   })
 
   it('should resolve with releases when data is available', () => {
     const mockReleases: ReleaseDocument[] = [
-      {_id: 'release1', _type: 'release'} as ReleaseDocument,
-      {_id: 'release2', _type: 'release'} as ReleaseDocument,
+      {_id: 'release1', _type: 'release'} as unknown as ReleaseDocument,
+      {_id: 'release2', _type: 'release'} as unknown as ReleaseDocument,
     ]
 
     const mockSubject = new BehaviorSubject<ReleaseDocument[]>(mockReleases)

package/src/hooks/releases/useActiveReleases.ts

@@ -14,21 +14,6 @@ import {
   type WithResourceNameSupport,
 } from '../helpers/useNormalizedResourceOptions'
 
-/**
- * @public
-
- * Returns the active releases for the current project,
- * represented as a list of release documents.
- *
- * @returns The active releases for the current project.
- * @category Projects
- * @example
- * ```tsx
- * import {useActiveReleases} from '@sanity/sdk-react'
- *
- * const activeReleases = useActiveReleases()
- * ```
- */
 type UseActiveReleasesValue = {
   (options?: {resource?: DocumentResource}): ReleaseDocument[]
 }
@@ -49,6 +34,18 @@ const useActiveReleasesValue: UseActiveReleasesValue = createStateSourceHook({
 /**
  * @public
  * @function
+ *
+ * Returns the active releases for the current project,
+ * represented as a list of release documents.
+ *
+ * @returns The active releases for the current project.
+ * @category Releases
+ * @example
+ * ```tsx
+ * import {useActiveReleases} from '@sanity/sdk-react'
+ *
+ * const activeReleases = useActiveReleases()
+ * ```
  */
 export function useActiveReleases(
   options?: WithResourceNameSupport<SanityConfig> | undefined,

package/src/hooks/releases/useAllReleases.test.tsx

@@ -0,0 +1,93 @@
+import {getAllReleasesState, type ReleaseDocument} from '@sanity/sdk'
+import {renderHook} from '@testing-library/react'
+import {BehaviorSubject} from 'rxjs'
+import {describe, expect, it, vi} from 'vitest'
+
+import {ResourceProvider} from '../../context/ResourceProvider'
+import {useAllReleases} from './useAllReleases'
+
+vi.mock('@sanity/sdk', async () => {
+  const actual = await vi.importActual('@sanity/sdk')
+  return {
+    ...actual,
+    getAllReleasesState: vi.fn(),
+  }
+})
+
+describe('useAllReleases', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('suspends until the releases state source emits, then resolves with the data', async () => {
+    const mockSubject = new BehaviorSubject<ReleaseDocument[] | undefined>(undefined)
+    const mockStateSource = {
+      subscribe: vi.fn((callback) => {
+        const subscription = mockSubject.subscribe(callback)
+        return () => subscription.unsubscribe()
+      }),
+      getCurrent: vi.fn(() => mockSubject.getValue()),
+      observable: mockSubject,
+    }
+
+    vi.mocked(getAllReleasesState).mockReturnValue(mockStateSource)
+
+    const {result} = renderHook(
+      () => {
+        try {
+          return useAllReleases()
+        } catch (e) {
+          return e
+        }
+      },
+      {
+        wrapper: ({children}) => (
+          <ResourceProvider projectId="p" dataset="d" fallback={<p>Loading...</p>}>
+            {children}
+          </ResourceProvider>
+        ),
+      },
+    )
+
+    expect(result.current).toBeInstanceOf(Promise)
+    expect(mockStateSource.getCurrent).toHaveBeenCalled()
+
+    const resolved: ReleaseDocument[] = [
+      {_id: 'r-active', _type: 'system.release', state: 'active'} as ReleaseDocument,
+    ]
+    mockSubject.next(resolved)
+
+    await expect(result.current).resolves.toEqual(resolved)
+  })
+
+  it('returns every release including archived and published once loaded', () => {
+    const mockReleases: ReleaseDocument[] = [
+      {_id: 'r-active', _type: 'system.release', state: 'active'} as ReleaseDocument,
+      {_id: 'r-archived', _type: 'system.release', state: 'archived'} as ReleaseDocument,
+      {_id: 'r-published', _type: 'system.release', state: 'published'} as ReleaseDocument,
+    ]
+
+    const mockSubject = new BehaviorSubject<ReleaseDocument[]>(mockReleases)
+    const mockStateSource = {
+      subscribe: vi.fn((callback) => {
+        const subscription = mockSubject.subscribe(callback)
+        return () => subscription.unsubscribe()
+      }),
+      getCurrent: vi.fn(() => mockReleases),
+      observable: mockSubject,
+    }
+
+    vi.mocked(getAllReleasesState).mockReturnValue(mockStateSource)
+
+    const {result} = renderHook(() => useAllReleases(), {
+      wrapper: ({children}) => (
+        <ResourceProvider projectId="p" dataset="d" fallback={<p>Loading...</p>}>
+          {children}
+        </ResourceProvider>
+      ),
+    })
+
+    expect(result.current).toEqual(mockReleases)
+    expect(mockStateSource.getCurrent).toHaveBeenCalled()
+  })
+})

package/src/hooks/releases/useAllReleases.ts

@@ -0,0 +1,62 @@
+import {
+  type DocumentResource,
+  getAllReleasesState,
+  type ReleaseDocument,
+  type SanityConfig,
+  type SanityInstance,
+  type StateSource,
+} from '@sanity/sdk'
+import {filter, firstValueFrom} from 'rxjs'
+
+import {createStateSourceHook} from '../helpers/createStateSourceHook'
+import {
+  useNormalizedResourceOptions,
+  type WithResourceNameSupport,
+} from '../helpers/useNormalizedResourceOptions'
+
+type UseAllReleasesValue = {
+  (options?: {resource?: DocumentResource}): ReleaseDocument[]
+}
+
+const useAllReleasesValue: UseAllReleasesValue = createStateSourceHook({
+  getState: getAllReleasesState as (
+    instance: SanityInstance,
+    options?: {resource?: DocumentResource},
+  ) => StateSource<ReleaseDocument[]>,
+  shouldSuspend: (instance: SanityInstance, options?: {resource?: DocumentResource}) =>
+    getAllReleasesState(instance, options ?? {}).getCurrent() === undefined,
+  suspender: (instance: SanityInstance, options?: {resource?: DocumentResource}) =>
+    firstValueFrom(getAllReleasesState(instance, options ?? {}).observable.pipe(filter(Boolean))),
+})
+
+/**
+ * @public
+ * @function
+ *
+ * Returns every release the dataset has — including `archived`, `published`,
+ * and mid-transition states (`archiving`, `unarchiving`, `publishing`,
+ * `scheduling`).
+ *
+ * Use this hook when you're building a release-management UI (listing
+ * releases, surfacing lifecycle controls, etc.) so a release stays visible
+ * across its full lifecycle — including after it's been published or
+ * archived. For perspective / content queries, prefer
+ * {@link useActiveReleases}, which filters to releases that still affect
+ * what's queryable.
+ *
+ * @returns Every release for the current project, sorted to match the order
+ * used by {@link useActiveReleases}.
+ * @category Releases
+ * @example
+ * ```tsx
+ * import {useAllReleases} from '@sanity/sdk-react'
+ *
+ * const releases = useAllReleases()
+ * ```
+ */
+export function useAllReleases(
+  options?: WithResourceNameSupport<SanityConfig> | undefined,
+): ReleaseDocument[] {
+  const normalizedOptions = useNormalizedResourceOptions(options ?? {})
+  return useAllReleasesValue(normalizedOptions)
+}

package/src/hooks/releases/usePerspective.test.tsx

@@ -47,7 +47,7 @@ describe('usePerspective', () => {
     // Mock the active releases observable for the suspender
     const mockReleaseDoc: ReleaseDocument = {
       _id: 'release1',
-      _type: 'release',
+      _type: 'system.release',
       _createdAt: '2021-01-01T00:00:00Z',
       _updatedAt: '2021-01-01T00:00:00Z',
       _rev: 'rev1',