@sanity/sdk 0.0.0-alpha.21 → 0.0.0-alpha.23

package/src/document/reducers.test.ts

@@ -50,7 +50,14 @@ describe('queueTransaction', () => {
 
     const transaction: QueuedTransaction = {
       transactionId: 'txn1',
-      actions: [{type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'bar'}}]}],
+      actions: [
+        {
+          type: 'document.edit',
+          documentId: 'doc1',
+          documentType: 'book',
+          patches: [{set: {foo: 'bar'}}],
+        },
+      ],
     }
 
     const newState = queueTransaction(initialState, transaction)
@@ -77,7 +84,14 @@ describe('removeQueuedTransaction', () => {
       queued: [
         {
           transactionId: 'txn1',
-          actions: [{type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'bar'}}]}],
+          actions: [
+            {
+              type: 'document.edit',
+              documentId: 'doc1',
+              documentType: 'book',
+              patches: [{set: {foo: 'bar'}}],
+            },
+          ],
         },
       ],
       applied: [],
@@ -123,13 +137,13 @@ describe('applyFirstQueuedTransaction', () => {
   })
 
   it('returns unchanged state if any required document is not yet loaded', () => {
-    // If a document’s local value is undefined, the reducer should do nothing.
+    // If a document's local value is undefined, the reducer should do nothing.
     const draftId = getDraftId('doc1')
     const state: SyncTransactionState = {
       queued: [
         {
           transactionId: 'txn2',
-          actions: [{type: 'document.discard', documentId: 'doc1'}],
+          actions: [{type: 'document.discard', documentId: 'doc1', documentType: 'book'}],
         },
       ],
       applied: [],
@@ -148,7 +162,7 @@ describe('applyFirstQueuedTransaction', () => {
       queued: [
         {
           transactionId: 'txn-missing-grants',
-          actions: [{type: 'document.discard', documentId: 'doc1'}],
+          actions: [{type: 'document.discard', documentId: 'doc1', documentType: 'book'}],
         },
       ],
       applied: [],
@@ -171,7 +185,7 @@ describe('applyFirstQueuedTransaction', () => {
       queued: [
         {
           transactionId: 'txn3',
-          actions: [{type: 'document.discard', documentId: 'doc1'}],
+          actions: [{type: 'document.discard', documentId: 'doc1', documentType: 'book'}],
         },
       ],
       applied: [],
@@ -188,7 +202,7 @@ describe('applyFirstQueuedTransaction', () => {
     expect(newState.queued).toHaveLength(0)
     // One applied transaction should have been added.
     expect(newState.applied).toHaveLength(1)
-    // For a discard action, the draft’s local value becomes null.
+    // For a discard action, the draft's local value becomes null.
     expect(newState.documentStates[draftId]?.local).toBeNull()
     // The published version remains unchanged.
     expect(newState.documentStates[pubId]?.local).toEqual(initialPub)
@@ -205,8 +219,18 @@ describe('batchAppliedTransactions', () => {
     const appliedTx: AppliedTransaction = {
       transactionId: 'txn4',
       actions: [
-        {type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'a'}}]},
-        {type: 'document.edit', documentId: 'doc1', patches: [{set: {bar: 'b'}}]},
+        {
+          type: 'document.edit',
+          documentId: 'doc1',
+          documentType: 'book',
+          patches: [{set: {foo: 'a'}}],
+        },
+        {
+          type: 'document.edit',
+          documentId: 'doc1',
+          documentType: 'book',
+          patches: [{set: {bar: 'b'}}],
+        },
       ],
       disableBatching: false,
       outgoingActions: [],
@@ -235,7 +259,14 @@ describe('batchAppliedTransactions', () => {
     const draftId = getDraftId('doc1')
     const appliedTx1: AppliedTransaction = {
       transactionId: 'txn5',
-      actions: [{type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'a'}}]}],
+      actions: [
+        {
+          type: 'document.edit',
+          documentId: 'doc1',
+          documentType: 'book',
+          patches: [{set: {foo: 'a'}}],
+        },
+      ],
       disableBatching: false,
       outgoingActions: [
         {
@@ -254,7 +285,14 @@ describe('batchAppliedTransactions', () => {
     }
     const appliedTx2: AppliedTransaction = {
       transactionId: 'txn6',
-      actions: [{type: 'document.edit', documentId: 'doc1', patches: [{set: {bar: 'b'}}]}],
+      actions: [
+        {
+          type: 'document.edit',
+          documentId: 'doc1',
+          documentType: 'book',
+          patches: [{set: {bar: 'b'}}],
+        },
+      ],
       disableBatching: false,
       outgoingActions: [
         {
@@ -287,7 +325,14 @@ describe('batchAppliedTransactions', () => {
     const draftId = getDraftId('docA')
     const appliedTx: AppliedTransaction = {
       transactionId: 'txn-disable',
-      actions: [{type: 'document.edit', documentId: 'docA', patches: [{set: {foo: 'a'}}]}],
+      actions: [
+        {
+          type: 'document.edit',
+          documentId: 'docA',
+          documentType: 'book',
+          patches: [{set: {foo: 'a'}}],
+        },
+      ],
       disableBatching: true, // already set to true
       outgoingActions: [],
       outgoingMutations: [],
@@ -328,7 +373,14 @@ describe('transitionAppliedTransactionsToOutgoing', () => {
       applied: [
         {
           transactionId: 'txn7',
-          actions: [{type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'new'}}]}],
+          actions: [
+            {
+              type: 'document.edit',
+              documentId: 'doc1',
+              documentType: 'book',
+              patches: [{set: {foo: 'new'}}],
+            },
+          ],
           disableBatching: false,
           outgoingActions: [],
           outgoingMutations: [],
@@ -381,7 +433,14 @@ describe('cleanupOutgoingTransaction', () => {
       applied: [],
       outgoing: {
         transactionId: 'txn8',
-        actions: [{type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'x'}}]}],
+        actions: [
+          {
+            type: 'document.edit',
+            documentId: 'doc1',
+            documentType: 'book',
+            patches: [{set: {foo: 'x'}}],
+          },
+        ],
         disableBatching: false,
         batchedTransactionIds: ['txn8'],
         outgoingActions: [],
@@ -417,7 +476,12 @@ describe('revertOutgoingTransaction', () => {
         {
           transactionId: 'txn9',
           actions: [
-            {type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'reverted'}}]},
+            {
+              type: 'document.edit',
+              documentId: 'doc1',
+              documentType: 'book',
+              patches: [{set: {foo: 'reverted'}}],
+            },
           ],
           disableBatching: false,
           outgoingActions: [],
@@ -431,7 +495,14 @@ describe('revertOutgoingTransaction', () => {
       ],
       outgoing: {
         transactionId: 'txnOut',
-        actions: [{type: 'document.edit', documentId: 'doc1', patches: [{set: {foo: 'changed'}}]}],
+        actions: [
+          {
+            type: 'document.edit',
+            documentId: 'doc1',
+            documentType: 'book',
+            patches: [{set: {foo: 'changed'}}],
+          },
+        ],
         disableBatching: false,
         batchedTransactionIds: ['txnOut'],
         outgoingActions: [],

package/src/document/reducers.ts

@@ -2,7 +2,7 @@ import {getPublishedId} from '@sanity/client/csm'
 import {type Mutation, type PatchOperations, type SanityDocumentLike} from '@sanity/types'
 import {omit} from 'lodash-es'
 
-import {type ResourceState} from '../resources/createResource'
+import {type StoreContext} from '../store/defineStore'
 import {getDraftId, insecureRandomId} from '../utils/ids'
 import {type DocumentAction} from './actions'
 import {DOCUMENT_STATE_CLEAR_DELAY} from './documentConstants'
@@ -548,7 +548,7 @@ export function removeSubscriptionIdFromDocument(
 }
 
 export function manageSubscriberIds(
-  state: ResourceState<SyncTransactionState>,
+  {state}: StoreContext<SyncTransactionState>,
   documentId: string | string[],
 ): () => void {
   const documentIds = Array.from(

package/src/document/sharedListener.test.ts

@@ -12,8 +12,8 @@ import {bufferTime, catchError, toArray} from 'rxjs/operators'
 import {afterEach, beforeEach, describe, expect, it, type Mock, vi} from 'vitest'
 
 import {getClientState} from '../client/clientStore'
-import {createSanityInstance} from '../instance/sanityInstance'
-import {type StateSource} from '../resources/createStateSourceAction'
+import {createSanityInstance} from '../store/createSanityInstance'
+import {type StateSource} from '../store/createStateSourceAction'
 import {createFetchDocument, createSharedListener} from './sharedListener'
 
 const instance = createSanityInstance({projectId: 'p', dataset: 'd'})
@@ -28,7 +28,7 @@ describe('createSharedListener', () => {
   beforeEach(() => {
     // Create a subject to simulate the events coming from client.listen.
     fakeListenSubject = new Subject()
-    // Create a fake client whose listen() method returns our subject’s observable.
+    // Create a fake client whose listen() method returns our subject's observable.
     fakeClient = {
       listen: vi.fn(() => fakeListenSubject.asObservable()),
     } as unknown as SanityClient
@@ -43,7 +43,7 @@ describe('createSharedListener', () => {
   })
 
   it('should call client.listen with the expected parameters', () => {
-    createSharedListener(instance).subscribe()
+    createSharedListener(instance).events.subscribe()
     expect(fakeClient.listen).toHaveBeenCalledTimes(1)
     expect(fakeClient.listen).toHaveBeenCalledWith(
       '*',
@@ -62,9 +62,9 @@ describe('createSharedListener', () => {
     const mutationEvent: MutationEvent = {type: 'mutation'} as MutationEvent
     const reconnectEvent: ReconnectEvent = {type: 'reconnect'} as ReconnectEvent
 
-    const shared$ = createSharedListener(instance)
+    const sharedListener = createSharedListener(instance)
     // Start collecting the emitted events.
-    const eventsPromise = lastValueFrom(shared$.pipe(toArray()))
+    const eventsPromise = lastValueFrom(sharedListener.events.pipe(toArray()))
 
     // Emit events in order.
     fakeListenSubject.next(welcomeEvent)
@@ -80,16 +80,16 @@ describe('createSharedListener', () => {
   it('should replay the welcome event for new subscribers', async () => {
     const welcomeEvent: WelcomeEvent = {type: 'welcome', listenerName: 'listener'}
 
-    const shared$ = createSharedListener(instance)
+    const sharedListener = createSharedListener(instance)
     // First subscription: emit welcome and complete.
-    const firstPromise = lastValueFrom(shared$.pipe(toArray()))
+    const firstPromise = lastValueFrom(sharedListener.events.pipe(toArray()))
     fakeListenSubject.next(welcomeEvent)
     fakeListenSubject.complete()
     const firstEvents = await firstPromise
     expect(firstEvents).toEqual([welcomeEvent])
 
     // New subscriber should immediately receive the replayed welcome event.
-    const secondEvents = await lastValueFrom(shared$.pipe(toArray()))
+    const secondEvents = await lastValueFrom(sharedListener.events.pipe(toArray()))
     expect(secondEvents).toEqual([welcomeEvent])
   })
 
@@ -97,8 +97,8 @@ describe('createSharedListener', () => {
     const mutationEvent = {type: 'mutation'} as MutationEvent
     const reconnectEvent = {type: 'reconnect'} as ReconnectEvent
 
-    const shared$ = createSharedListener(instance)
-    const eventsPromise = lastValueFrom(shared$.pipe(toArray()))
+    const sharedListener = createSharedListener(instance)
+    const eventsPromise = lastValueFrom(sharedListener.events.pipe(toArray()))
     fakeListenSubject.next(mutationEvent)
     fakeListenSubject.next(reconnectEvent)
     fakeListenSubject.complete()
@@ -110,11 +110,11 @@ describe('createSharedListener', () => {
     const welcomeEvent = {type: 'welcome'} as WelcomeEvent
     const mutationEvent = {type: 'mutation'} as MutationEvent
 
-    const shared$ = createSharedListener(instance)
+    const sharedListener = createSharedListener(instance)
 
     // Subscribe two observers concurrently.
-    const subscriber1 = shared$.pipe(bufferTime(0))
-    const subscriber2 = shared$.pipe(bufferTime(0))
+    const subscriber1 = sharedListener.events.pipe(bufferTime(0))
+    const subscriber2 = sharedListener.events.pipe(bufferTime(0))
     const combined = forkJoin([subscriber1, subscriber2])
 
     const result = lastValueFrom(combined)
@@ -133,9 +133,9 @@ describe('createSharedListener', () => {
 
   it('should propagate errors from the underlying client.listen observable', async () => {
     const errorMessage = 'Test error'
-    const shared$ = createSharedListener(instance)
+    const sharedListener = createSharedListener(instance)
 
-    const error$ = shared$.pipe(
+    const error$ = sharedListener.events.pipe(
       toArray(),
       catchError((err) => of(err)),
     )
@@ -145,6 +145,24 @@ describe('createSharedListener', () => {
     expect(result).toBeInstanceOf(Error)
     expect(result.message).toBe(errorMessage)
   })
+
+  it('should stop emitting events after calling dispose', async () => {
+    const welcomeEvent: WelcomeEvent = {type: 'welcome', listenerName: 'listener'}
+    const mutationEvent: MutationEvent = {type: 'mutation'} as MutationEvent
+    const sharedListener = createSharedListener(instance)
+
+    const events: ListenEvent<SanityDocument>[] = []
+    const subscription = sharedListener.events.subscribe((event) => {
+      events.push(event)
+    })
+
+    fakeListenSubject.next(welcomeEvent)
+    sharedListener.dispose()
+    fakeListenSubject.next(mutationEvent)
+    await new Promise((resolve) => setTimeout(resolve, 0))
+    expect(events).toEqual([welcomeEvent])
+    subscription.unsubscribe()
+  })
 })
 
 describe('createFetchDocument', () => {

package/src/document/sharedListener.ts

@@ -1,16 +1,33 @@
 import {type ListenEvent, type SanityDocument} from '@sanity/client'
 import {createDocumentLoaderFromClient} from '@sanity/mutate/_unstable_store'
-import {first, map, merge, Observable, partition, share, shareReplay, switchMap} from 'rxjs'
+import {
+  first,
+  map,
+  merge,
+  Observable,
+  partition,
+  share,
+  shareReplay,
+  Subject,
+  switchMap,
+  takeUntil,
+} from 'rxjs'
 
 import {getClientState} from '../client/clientStore'
-import {type SanityInstance} from '../instance/types'
+import {type SanityInstance} from '../store/createSanityInstance'
 
 const API_VERSION = 'vX'
 
-export function createSharedListener(
-  instance: SanityInstance,
-): Observable<ListenEvent<SanityDocument>> {
-  const events$ = getClientState(instance, {apiVersion: API_VERSION}).observable.pipe(
+export interface SharedListener {
+  events: Observable<ListenEvent<SanityDocument>>
+  dispose: () => void
+}
+
+export function createSharedListener(instance: SanityInstance): SharedListener {
+  const dispose$ = new Subject<void>()
+  const events$ = getClientState(instance, {
+    apiVersion: API_VERSION,
+  }).observable.pipe(
     switchMap((client) =>
       // TODO: it seems like the client.listen method is not emitting disconnected
       // events. this is important to ensure we have an up to date version of the
@@ -29,15 +46,20 @@ export function createSharedListener(
         },
       ),
     ),
+    takeUntil(dispose$),
     share(),
   )
 
   const [welcome$, mutation$] = partition(events$, (e) => e.type === 'welcome')
-  return merge(
-    // we replay the welcome event because that event kicks off fetching the document
-    welcome$.pipe(shareReplay(1)),
-    mutation$,
-  )
+
+  return {
+    events: merge(
+      // we replay the welcome event because that event kicks off fetching the document
+      welcome$.pipe(shareReplay(1)),
+      mutation$,
+    ),
+    dispose: () => dispose$.next(),
+  }
 }
 
 export function createFetchDocument(instance: SanityInstance) {

package/src/preview/getPreviewState.test.ts

@@ -1,14 +1,12 @@
-import {describe, it, type Mock} from 'vitest'
-
-import {createSanityInstance} from '../instance/sanityInstance'
-import {
-  createResourceState,
-  getOrCreateResource,
-  type ResourceState,
-} from '../resources/createResource'
+import {NEVER} from 'rxjs'
+import {describe, it} from 'vitest'
+
+import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
+import {type StoreState} from '../store/createStoreState'
 import {insecureRandomId} from '../utils/ids'
 import {getPreviewState} from './getPreviewState'
-import {previewStore, type PreviewStoreState} from './previewStore'
+import {type PreviewStoreState} from './previewStore'
+import {subscribeToStateAndFetchBatches} from './subscribeToStateAndFetchBatches'
 import {STABLE_EMPTY_PREVIEW} from './util'
 
 vi.mock('../utils/ids', async (importOriginal) => {
@@ -16,36 +14,36 @@ vi.mock('../utils/ids', async (importOriginal) => {
   return {...util, insecureRandomId: vi.fn(util.insecureRandomId)}
 })
 
-vi.mock('../resources/createResource', async (importOriginal) => {
-  const original = await importOriginal<typeof import('../resources/createResource')>()
-  return {...original, getOrCreateResource: vi.fn()}
-})
+vi.mock('./subscribeToStateAndFetchBatches.ts')
 
 describe('getPreviewState', () => {
-  const instance = createSanityInstance({projectId: 'exampleProject', dataset: 'exampleDataset'})
-  const document = {_id: 'exampleId', _type: 'exampleType'}
-  const initialState: PreviewStoreState = {
-    documentTypes: {},
-    lastLiveEventId: null,
-    subscriptions: {},
-    syncTags: {},
-    values: {},
-  }
-  let state: ResourceState<PreviewStoreState>
+  let instance: SanityInstance
+  const docHandle = {documentId: 'exampleId', documentType: 'exampleType'}
+  let state: StoreState<PreviewStoreState & {extra?: unknown}>
 
   beforeEach(() => {
-    state = createResourceState(initialState)
+    // capture state
+    vi.mocked(subscribeToStateAndFetchBatches).mockImplementation((context) => {
+      state = context.state
+      return NEVER.subscribe()
+    })
+
+    instance = createSanityInstance({projectId: 'exampleProject', dataset: 'exampleDataset'})
+  })
+
+  afterEach(() => {
+    instance.dispose()
   })
 
   it('returns a state source that emits when the preview value changes', () => {
-    const previewState = getPreviewState({state, instance}, {document})
+    const previewState = getPreviewState(instance, docHandle)
     expect(previewState.getCurrent()).toBe(STABLE_EMPTY_PREVIEW)
 
     const subscriber = vi.fn()
     previewState.subscribe(subscriber)
 
     // emit unrelated state changes
-    state.set('updateLastLiveEventId', {lastLiveEventId: 'newLastLiveEventId'})
+    state.set('updateLastLiveEventId', {extra: 'unrelated change'})
     expect(subscriber).toHaveBeenCalledTimes(0)
 
     state.set('relatedChange', (prev) => ({
@@ -68,7 +66,7 @@ describe('getPreviewState', () => {
   })
 
   it('adds a subscription ID and document type to the state on subscription', () => {
-    const previewState = getPreviewState({state, instance}, {document})
+    const previewState = getPreviewState(instance, docHandle)
 
     expect(state.get().subscriptions).toEqual({})
     vi.mocked(insecureRandomId)
@@ -92,28 +90,31 @@ describe('getPreviewState', () => {
   })
 
   it('resets to pending false on unsubscribe if the subscription is the last one', () => {
+    const previewState = getPreviewState(instance, docHandle)
+
     state.set('presetValueToPending', (prev) => ({
-      values: {...prev.values, [document._id]: {data: {title: 'Foo'}, isPending: true}},
+      values: {...prev.values, [docHandle.documentId]: {data: {title: 'Foo'}, isPending: true}},
     }))
 
-    const previewState = getPreviewState({state, instance}, {document})
-
     const unsubscribe1 = previewState.subscribe(vi.fn())
     const unsubscribe2 = previewState.subscribe(vi.fn())
 
-    expect(state.get().values[document._id]).toEqual({data: {title: 'Foo'}, isPending: true})
+    expect(state.get().values[docHandle.documentId]).toEqual({
+      data: {title: 'Foo'},
+      isPending: true,
+    })
 
     unsubscribe1()
-    expect(state.get().values[document._id]).toEqual({data: {title: 'Foo'}, isPending: true})
+    expect(state.get().values[docHandle.documentId]).toEqual({
+      data: {title: 'Foo'},
+      isPending: true,
+    })
 
     unsubscribe2()
     expect(state.get().subscriptions).toEqual({})
-    expect(state.get().values[document._id]).toEqual({data: {title: 'Foo'}, isPending: false})
-  })
-
-  it('calls getOrCreateResource if no state is provided', () => {
-    ;(getOrCreateResource as Mock).mockReturnValue({state})
-    getPreviewState(instance, {document})
-    expect(getOrCreateResource).toHaveBeenCalledWith(instance, previewStore)
+    expect(state.get().values[docHandle.documentId]).toEqual({
+      data: {title: 'Foo'},
+      isPending: false,
+    })
   })
 })