@sanity/sdk 2.8.0 → 3.0.0-rc.0

package/src/releases/getPerspectiveState.test.ts

@@ -1,7 +1,7 @@
 import {filter, firstValueFrom, of, Subject, take} from 'rxjs'
 import {describe, expect, it, vi} from 'vitest'
 
-import {type PerspectiveHandle, type ReleasePerspective} from '../config/sanityConfig'
+import {type ReleasePerspective, type ResourceHandle} from '../config/sanityConfig'
 import {getQueryState} from '../query/queryStore'
 import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
 import {type StateSource} from '../store/createStateSourceAction'
@@ -39,9 +39,10 @@ describe('getPerspectiveState', () => {
 
   // the release store is reversed in getActiveReleases to match UI elsewhere
   const activeReleases = [release2, release1]
+  const resource: ResourceHandle['resource'] = {projectId: 'p', dataset: 'd'}
 
   beforeEach(() => {
-    instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    instance = createSanityInstance()
 
     mockReleasesQuerySubject = new Subject<ReleaseDocument[] | undefined>()
     vi.mocked(getQueryState).mockReturnValue({
@@ -57,7 +58,7 @@ describe('getPerspectiveState', () => {
   })
 
   it('should return default perspective if no options or instance perspective is provided', async () => {
-    const state = getPerspectiveState(instance)
+    const state = getPerspectiveState(instance, {resource})
     mockReleasesQuerySubject.next([])
     const perspective = await firstValueFrom(state.observable)
     expect(perspective).toBe('drafts')
@@ -65,14 +66,14 @@ describe('getPerspectiveState', () => {
 
   it('should return instance perspective if provided and no options perspective', async () => {
     instance.config.perspective = 'published'
-    const state = getPerspectiveState(instance)
+    const state = getPerspectiveState(instance, {resource})
     mockReleasesQuerySubject.next([])
     const perspective = await firstValueFrom(state.observable)
     expect(perspective).toBe('published')
   })
 
   it('should return options perspective if provided', async () => {
-    const options: PerspectiveHandle = {perspective: 'raw'}
+    const options = {perspective: 'raw' as const, resource}
     const state = getPerspectiveState(instance, options)
     mockReleasesQuerySubject.next([])
     const perspective = await firstValueFrom(state.observable)
@@ -80,7 +81,7 @@ describe('getPerspectiveState', () => {
   })
 
   it('should return undefined if release perspective is requested but no active releases', async () => {
-    const options: PerspectiveHandle = {perspective: {releaseName: 'release1'}}
+    const options = {perspective: {releaseName: 'release1'}, resource}
     const state = getPerspectiveState(instance, options)
     mockReleasesQuerySubject.next([])
     const perspective = await firstValueFrom(state.observable)
@@ -88,7 +89,7 @@ describe('getPerspectiveState', () => {
   })
 
   it('should calculate perspective based on active releases and releaseName', async () => {
-    const options: PerspectiveHandle = {perspective: {releaseName: 'release1'}}
+    const options = {perspective: {releaseName: 'release1'}, resource}
     const state = getPerspectiveState(instance, options)
     mockReleasesQuerySubject.next(activeReleases)
 
@@ -102,7 +103,7 @@ describe('getPerspectiveState', () => {
   })
 
   it('should calculate perspective including multiple releases up to the specified releaseName', async () => {
-    const options: PerspectiveHandle = {perspective: {releaseName: 'release2'}}
+    const options = {perspective: {releaseName: 'release2'}, resource}
     const state = getPerspectiveState(instance, options)
     mockReleasesQuerySubject.next(activeReleases)
     const perspective = await firstValueFrom(
@@ -119,7 +120,7 @@ describe('getPerspectiveState', () => {
       releaseName: 'release2',
       excludedPerspectives: ['release1', 'drafts'],
     }
-    const options: PerspectiveHandle = {perspective: perspectiveConfig}
+    const options = {perspective: perspectiveConfig, resource}
     const state = getPerspectiveState(instance, options)
     mockReleasesQuerySubject.next(activeReleases)
     const perspective = await firstValueFrom(
@@ -132,7 +133,7 @@ describe('getPerspectiveState', () => {
   })
 
   it('should throw if the specified releaseName is not found in active releases', async () => {
-    const options: PerspectiveHandle = {perspective: {releaseName: 'nonexistent'}}
+    const options = {perspective: {releaseName: 'nonexistent'}, resource}
     const state = getPerspectiveState(instance, options)
     mockReleasesQuerySubject.next(activeReleases)
 
@@ -147,8 +148,8 @@ describe('getPerspectiveState', () => {
   })
 
   it('should reuse the same options object for identical inputs (cache test)', async () => {
-    const options1: PerspectiveHandle = {perspective: {releaseName: 'release1'}}
-    const options2: PerspectiveHandle = {perspective: {releaseName: 'release1'}}
+    const options1 = {perspective: {releaseName: 'release1'}, resource}
+    const options2 = {perspective: {releaseName: 'release1'}, resource}
 
     const state1 = getPerspectiveState(instance, options1)
     mockReleasesQuerySubject.next(activeReleases)
@@ -166,7 +167,7 @@ describe('getPerspectiveState', () => {
   })
 
   it('should handle changes in activeReleases (cache test)', async () => {
-    const options: PerspectiveHandle = {perspective: {releaseName: 'release1'}}
+    const options = {perspective: {releaseName: 'release1'}, resource}
 
     const state1 = getPerspectiveState(instance, options)
     mockReleasesQuerySubject.next(activeReleases)

package/src/releases/getPerspectiveState.ts

@@ -1,7 +1,7 @@
 import {createSelector} from 'reselect'
 
-import {type PerspectiveHandle} from '../config/sanityConfig'
-import {bindActionByDataset, type BoundStoreAction} from '../store/createActionBinder'
+import {type DocumentResource, type PerspectiveHandle} from '../config/sanityConfig'
+import {bindActionByResource, type BoundStoreAction} from '../store/createActionBinder'
 import {createStateSourceAction, type SelectorContext} from '../store/createStateSourceAction'
 /*
  * Although this is an import dependency cycle, it is not a logical cycle:
@@ -26,7 +26,7 @@ const selectActiveReleases = (context: SelectorContext<ReleasesStoreState>) =>
   context.state.activeReleases
 const selectOptions = (
   _context: SelectorContext<ReleasesStoreState>,
-  options: PerspectiveHandle & {projectId?: string; dataset?: string},
+  options: PerspectiveHandle & {resource?: DocumentResource},
 ) => options
 
 const memoizedOptionsSelector = createSelector(
@@ -103,12 +103,12 @@ let _boundGetPerspectiveState: BoundGetPerspectiveState | undefined
  *
  * @public
  */
-export const getPerspectiveState: BoundGetPerspectiveState = (...args) => {
+export const getPerspectiveState: BoundGetPerspectiveState = (instance, ...rest) => {
   if (!_boundGetPerspectiveState) {
-    _boundGetPerspectiveState = bindActionByDataset(
+    _boundGetPerspectiveState = bindActionByResource(
       releasesStore,
       _getPerspectiveStateSelector,
     ) as BoundGetPerspectiveState
   }
-  return _boundGetPerspectiveState(...args)
+  return _boundGetPerspectiveState(instance, ...rest)
 }

package/src/releases/releasesStore.test.ts

@@ -15,7 +15,7 @@ describe('releasesStore', () => {
   beforeEach(() => {
     vi.clearAllMocks()
 
-    instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    instance = createSanityInstance()
 
     vi.mocked(getQueryState).mockReturnValue({
       subscribe: () => () => {},
@@ -30,6 +30,21 @@ describe('releasesStore', () => {
     instance.dispose()
   })
 
+  it('supports calls with explicit resource', () => {
+    const state = getActiveReleasesState(instance, {resource: {projectId: 'test', dataset: 'test'}})
+
+    expect(state.getCurrent()).toBeUndefined()
+    expect(getQueryState).toHaveBeenCalledWith(
+      instance,
+      expect.objectContaining({
+        query: 'releases::all()',
+        perspective: 'raw',
+        resource: {projectId: 'test', dataset: 'test'},
+        tag: 'releases',
+      }),
+    )
+  })
+
   it('should set active releases state when the releases query emits', async () => {
     const teardown = vi.fn()
     const subscriber = vi
@@ -58,7 +73,7 @@ describe('releasesStore', () => {
       } as ReleaseDocument,
     ]
 
-    const state = getActiveReleasesState(instance)
+    const state = getActiveReleasesState(instance, {resource: {projectId: 'test', dataset: 'test'}})
 
     const [observer] = subscriber.mock.lastCall!
 
@@ -77,7 +92,7 @@ describe('releasesStore', () => {
       observable: releasesSubject.asObservable(),
     } as StateSource<ReleaseDocument[] | undefined>)
 
-    const state = getActiveReleasesState(instance)
+    const state = getActiveReleasesState(instance, {resource: {projectId: 'test', dataset: 'test'}})
 
     // Initial state should be default
     expect(state.getCurrent()).toBeUndefined() // Default initial state
@@ -124,7 +139,7 @@ describe('releasesStore', () => {
       observable: of([]),
     } as StateSource<ReleaseDocument[] | undefined>)
 
-    const state = getActiveReleasesState(instance)
+    const state = getActiveReleasesState(instance, {resource: {projectId: 'test', dataset: 'test'}})
 
     await new Promise((resolve) => setTimeout(resolve, 0))
 
@@ -138,7 +153,7 @@ describe('releasesStore', () => {
       getCurrent: () => null as unknown as ReleaseDocument[] | undefined,
       observable: of(null as unknown as ReleaseDocument[] | undefined),
     } as StateSource<ReleaseDocument[] | undefined>)
-    const state = getActiveReleasesState(instance)
+    const state = getActiveReleasesState(instance, {resource: {projectId: 'test', dataset: 'test'}})
     await new Promise((resolve) => setTimeout(resolve, 0))
     expect(state.getCurrent()).toEqual([])
 
@@ -160,7 +175,7 @@ describe('releasesStore', () => {
       observable: subject.asObservable(),
     } as StateSource<ReleaseDocument[] | undefined>)
 
-    const state = getActiveReleasesState(instance)
+    const state = getActiveReleasesState(instance, {resource: {projectId: 'test', dataset: 'test'}})
 
     subject.error(new Error('Query failed'))
 

package/src/releases/releasesStore.ts

@@ -1,6 +1,7 @@
 import {type SanityDocument} from '@sanity/types'
 import {map} from 'rxjs'
 
+import {type DocumentResource} from '../config/sanityConfig'
 /*
  * Although this is an import dependency cycle, it is not a logical cycle:
  * 1. releasesStore uses queryStore as a data source
@@ -10,8 +11,9 @@ import {map} from 'rxjs'
  */
 // eslint-disable-next-line import/no-cycle
 import {getQueryState} from '../query/queryStore'
-import {bindActionByDataset, type BoundDatasetKey} from '../store/createActionBinder'
-import {createStateSourceAction} from '../store/createStateSourceAction'
+import {bindActionByResource, type BoundResourceKey} from '../store/createActionBinder'
+import {type SanityInstance} from '../store/createSanityInstance'
+import {createStateSourceAction, type StateSource} from '../store/createStateSourceAction'
 import {defineStore, type StoreContext} from '../store/defineStore'
 import {sortReleases} from './utils/sortReleases'
 
@@ -39,7 +41,7 @@ export interface ReleasesStoreState {
   error?: unknown
 }
 
-export const releasesStore = defineStore<ReleasesStoreState, BoundDatasetKey>({
+export const releasesStore = defineStore<ReleasesStoreState, BoundResourceKey>({
   name: 'Releases',
   getInitialState: (): ReleasesStoreState => ({
     activeReleases: undefined,
@@ -54,25 +56,33 @@ export const releasesStore = defineStore<ReleasesStoreState, BoundDatasetKey>({
  * Get the active releases from the store.
  * @internal
  */
-export const getActiveReleasesState = bindActionByDataset(
+const _getActiveReleasesState = bindActionByResource(
   releasesStore,
   createStateSourceAction({
     selector: ({state}, _?) => state.activeReleases,
   }),
 )
 
+/**
+ * Get the active releases from the store.
+ * @internal
+ */
+export const getActiveReleasesState = (
+  instance: SanityInstance,
+  options: {resource: DocumentResource},
+): StateSource<ReleaseDocument[] | undefined> => _getActiveReleasesState(instance, options)
+
 const RELEASES_QUERY = 'releases::all()'
 
 const subscribeToReleases = ({
   instance,
   state,
-  key: {projectId, dataset},
-}: StoreContext<ReleasesStoreState, BoundDatasetKey>) => {
+  key: {resource},
+}: StoreContext<ReleasesStoreState, BoundResourceKey>) => {
   const {observable: releases$} = getQueryState<ReleaseDocument[]>(instance, {
     query: RELEASES_QUERY,
     perspective: 'raw',
-    projectId,
-    dataset,
+    resource,
     tag: 'releases',
   })
   return releases$