@sanity/sdk 2.8.0 → 3.0.0-rc.0

package/src/document/actions.test.ts

@@ -2,7 +2,7 @@ import {at, patch, set, setIfMissing} from '@sanity/mutate'
 import {type PatchOperations} from '@sanity/types'
 import {describe, expect, it} from 'vitest'
 
-import {type DocumentHandle} from '../config/sanityConfig'
+import {type DocumentHandle, type DocumentResource} from '../config/sanityConfig'
 import {
   createDocument,
   deleteDocument,
@@ -15,9 +15,18 @@ import {
 const dummyPatch: PatchOperations = {
   diffMatchPatch: {'dummy.path': 'dummy patch'},
 }
+const dummyDocResource: DocumentResource = {projectId: 'test-project', dataset: 'test-dataset'}
 
-const dummyDocHandle: DocumentHandle = {documentId: 'drafts.abc123', documentType: 'testType'}
-const dummyDocString = {documentId: 'drafts.abc123', documentType: 'testType'}
+const dummyDocHandle: DocumentHandle = {
+  documentId: 'drafts.abc123',
+  documentType: 'testType',
+  resource: dummyDocResource,
+}
+const dummyDocString: DocumentHandle = {
+  documentId: 'drafts.abc123',
+  documentType: 'testType',
+  resource: dummyDocResource,
+}
 
 describe('document actions', () => {
   describe('createDocument', () => {
@@ -28,18 +37,24 @@ describe('document actions', () => {
         // getId returns the input if it does not end with a dot.
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
+        resource: dummyDocResource,
       })
     })
 
     it('creates a document action from a document type handle', () => {
       // A document type handle is similar to a document handle,
       // but _id is optional.
-      const typeHandle = {documentId: 'abc456', documentType: 'anotherType'}
+      const typeHandle = {
+        documentId: 'abc456',
+        documentType: 'anotherType',
+        resource: dummyDocResource,
+      }
       const action = createDocument(typeHandle)
       expect(action).toEqual({
         type: 'document.create',
         documentId: 'abc456',
         documentType: typeHandle.documentType,
+        resource: dummyDocResource,
       })
     })
 
@@ -55,6 +70,7 @@ describe('document actions', () => {
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
         initialValue,
+        resource: dummyDocResource,
       })
     })
 
@@ -64,6 +80,7 @@ describe('document actions', () => {
         type: 'document.create',
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
+        resource: dummyDocResource,
       })
     })
 
@@ -74,6 +91,7 @@ describe('document actions', () => {
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
         initialValue: {},
+        resource: dummyDocResource,
       })
     })
   })
@@ -86,6 +104,7 @@ describe('document actions', () => {
         type: 'document.delete',
         documentId: 'abc123',
         documentType: dummyDocString.documentType,
+        resource: dummyDocResource,
       })
     })
 
@@ -95,6 +114,7 @@ describe('document actions', () => {
         type: 'document.delete',
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
+        resource: dummyDocResource,
       })
     })
   })
@@ -107,6 +127,7 @@ describe('document actions', () => {
         documentId: 'abc123',
         documentType: dummyDocString.documentType,
         patches: [dummyPatch],
+        resource: dummyDocResource,
       })
     })
 
@@ -117,6 +138,7 @@ describe('document actions', () => {
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
         patches: [dummyPatch],
+        resource: dummyDocResource,
       })
     })
 
@@ -143,6 +165,7 @@ describe('document actions', () => {
           {ifRevisionID: 'txn0', set: {'address.city': 'Oslo'}},
         ],
         type: 'document.edit',
+        resource: dummyDocResource,
       })
     })
   })
@@ -154,6 +177,7 @@ describe('document actions', () => {
         type: 'document.publish',
         documentId: 'abc123',
         documentType: dummyDocString.documentType,
+        resource: dummyDocResource,
       })
     })
 
@@ -163,6 +187,7 @@ describe('document actions', () => {
         type: 'document.publish',
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
+        resource: dummyDocResource,
       })
     })
   })
@@ -174,6 +199,7 @@ describe('document actions', () => {
         type: 'document.unpublish',
         documentId: 'abc123',
         documentType: dummyDocString.documentType,
+        resource: dummyDocResource,
       })
     })
 
@@ -183,6 +209,7 @@ describe('document actions', () => {
         type: 'document.unpublish',
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
+        resource: dummyDocResource,
       })
     })
   })
@@ -194,6 +221,7 @@ describe('document actions', () => {
         type: 'document.discard',
         documentId: 'abc123',
         documentType: dummyDocString.documentType,
+        resource: dummyDocResource,
       })
     })
 
@@ -203,6 +231,7 @@ describe('document actions', () => {
         type: 'document.discard',
         documentId: 'abc123',
         documentType: dummyDocHandle.documentType,
+        resource: dummyDocResource,
       })
     })
   })

package/src/document/actions.ts

@@ -1,7 +1,6 @@
 import {SanityEncoder} from '@sanity/mutate'
 import {type PatchMutation as SanityMutatePatchMutation} from '@sanity/mutate/_unstable_store'
-import {type PatchMutation, type PatchOperations} from '@sanity/types'
-import {type SanityDocument} from 'groq'
+import {type PatchMutation, type PatchOperations, type SanityDocument} from '@sanity/types'
 
 import {type DocumentHandle, type DocumentTypeHandle} from '../config/sanityConfig'
 import {getPublishedId} from '../utils/ids'
@@ -31,10 +30,7 @@ export interface CreateDocumentAction<
    * System fields (_id, _type, _rev, _createdAt, _updatedAt) are omitted as they are set automatically.
    */
   initialValue?: Partial<
-    Omit<
-      SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
-      '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'
-    >
+    Omit<SanityDocument, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>
   >
 }
 
@@ -134,10 +130,7 @@ export function createDocument<
 >(
   doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>,
   initialValue?: Partial<
-    Omit<
-      SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
-      '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'
-    >
+    Omit<SanityDocument, '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'>
   >,
 ): CreateDocumentAction<TDocumentType, TDataset, TProjectId> {
   return {

package/src/document/applyDocumentActions.test.ts

@@ -3,7 +3,7 @@ import {type SanityDocument} from '@sanity/types'
 import {Subject} from 'rxjs'
 import {describe, expect, it} from 'vitest'
 
-import {bindActionByDataset} from '../store/createActionBinder'
+import {bindActionByResource} from '../store/createActionBinder'
 import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
 import {} from '../store/createStateSourceAction'
 import {createStoreState, type StoreState} from '../store/createStoreState'
@@ -14,7 +14,7 @@ import {type AppliedTransaction, type OutgoingTransaction} from './reducers'
 
 vi.mock('../store/createActionBinder', async (importOriginal) => ({
   ...(await importOriginal<typeof import('../store/createActionBinder')>()),
-  bindActionByDataset: vi.fn(),
+  bindActionByResource: vi.fn(),
 }))
 
 type TestState = Pick<
@@ -47,10 +47,10 @@ describe('applyDocumentActions', () => {
       events: eventsSubject,
     }
     state = createStoreState(initialState)
-    instance = createSanityInstance({projectId: 'p', dataset: 'd'})
-    const key = {name: 'p.d', projectId: 'p', dataset: 'd'}
+    instance = createSanityInstance()
+    const key = {name: 'p.d', resource: {projectId: 'p', dataset: 'd'}}
 
-    vi.mocked(bindActionByDataset).mockImplementation(
+    vi.mocked(bindActionByResource).mockImplementation(
       (_storeDef, action) => (instanceParam: SanityInstance, options) =>
         action({instance: instanceParam, state, key}, options),
     )
@@ -69,12 +69,14 @@ describe('applyDocumentActions', () => {
       documentId: 'doc1',
       documentType: 'example',
       patches: [{set: {foo: 'bar'}}],
+      resource: {projectId: 'p', dataset: 'd'},
     }
 
     // Call applyDocumentActions with a fixed transactionId for reproducibility.
     const applyPromise = applyDocumentActions(instance, {
       actions: [action],
       transactionId: 'txn-success',
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     const appliedTx: AppliedTransaction = {
@@ -126,12 +128,14 @@ describe('applyDocumentActions', () => {
       documentId: 'doc1',
       documentType: 'example',
       patches: [{set: {foo: 'error'}}],
+      resource: {projectId: 'p', dataset: 'd'},
     }
 
     // Call applyDocumentActions with a fixed transactionId.
     const applyPromise = applyDocumentActions(instance, {
       actions: [action],
       transactionId: 'txn-error',
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     const errorEvent: DocumentEvent = {
@@ -146,25 +150,21 @@ describe('applyDocumentActions', () => {
     await expect(applyPromise).rejects.toThrow('Simulated error')
   })
 
-  it('matches parent instance via child when action projectId and dataset do not match child config', async () => {
-    // Create a parent instance
-    const parentInstance = createSanityInstance({projectId: 'p', dataset: 'd'})
-    // Create a child instance with different config
-    const childInstance = parentInstance.createChild({projectId: 'child-p', dataset: 'child-d'})
-    // Use the child instance in context
-    // Create an action that refers to the parent's configuration
+  it('uses explicit resource even when instance default differs', async () => {
+    const otherInstance = createSanityInstance({
+      defaultResource: {projectId: 'child-p', dataset: 'child-d'},
+    })
     const action: DocumentAction = {
       type: 'document.edit',
       documentId: 'doc1',
       documentType: 'example',
       patches: [{set: {foo: 'childTest'}}],
-      projectId: 'p',
-      dataset: 'd',
+      resource: {projectId: 'p', dataset: 'd'},
     }
-    // Call applyDocumentActions with the context using childInstance, but with action requiring parent's config
-    const applyPromise = applyDocumentActions(childInstance, {
+    const applyPromise = applyDocumentActions(instance, {
       actions: [action],
       transactionId: 'txn-child-match',
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     // Simulate an applied transaction on the parent's instance
@@ -198,7 +198,6 @@ describe('applyDocumentActions', () => {
     const submittedResult = await result.submitted()
     expect(submittedResult).toEqual(acceptedResult)
 
-    childInstance.dispose()
-    parentInstance.dispose()
+    otherInstance.dispose()
   })
 })

package/src/document/applyDocumentActions.ts

@@ -1,8 +1,9 @@
 import {type SanityClient} from '@sanity/client'
-import {type SanityDocument} from 'groq'
+import {type SanityDocument} from '@sanity/types'
 import {distinctUntilChanged, filter, first, firstValueFrom, map, race} from 'rxjs'
 
-import {bindActionByDataset} from '../store/createActionBinder'
+import {type DocumentResource} from '../config/sanityConfig'
+import {bindActionByResource} from '../store/createActionBinder'
 import {type SanityInstance} from '../store/createSanityInstance'
 import {type StoreContext} from '../store/defineStore'
 import {type DocumentAction} from './actions'
@@ -29,6 +30,11 @@ export interface ApplyDocumentActionsOptions {
    */
   actions: DocumentAction[]
 
+  /**
+   * The resource to which the documents being acted on belong.
+   */
+  resource: DocumentResource
+
   /**
    * Optionally provide an ID to be used as this transaction ID
    */
@@ -39,15 +45,6 @@ export interface ApplyDocumentActionsOptions {
   disableBatching?: boolean
 }
 
-/** @beta */
-export function applyDocumentActions<
-  TDocumentType extends string = string,
-  TDataset extends string = string,
-  TProjectId extends string = string,
->(
-  instance: SanityInstance,
-  options: ApplyDocumentActionsOptions,
-): Promise<ActionsResult<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>>>
 /** @beta */
 export function applyDocumentActions(
   instance: SanityInstance,
@@ -61,7 +58,7 @@ export function applyDocumentActions(
   return boundApplyDocumentActions(...args)
 }
 
-const boundApplyDocumentActions = bindActionByDataset(documentStore, _applyDocumentActions)
+const boundApplyDocumentActions = bindActionByResource(documentStore, _applyDocumentActions)
 
 /** @internal */
 async function _applyDocumentActions(