@sanity/sdk 2.8.0 → 2.10.0

package/src/config/sanityConfig.ts

@@ -23,6 +23,12 @@ export interface TokenSource {
  * @public
  */
 export interface StudioConfig {
+  /**
+   * Whether the Studio has already determined the user is authenticated.
+   * When `true` and the token source emits `null`, the SDK infers
+   * cookie-based auth is in use rather than transitioning to logged-out.
+   */
+  authenticated?: boolean
   /** Reactive auth token source from the Studio's auth store. */
   auth?: {
     /**
@@ -67,9 +73,14 @@ export interface DatasetHandle<TDataset extends string = string, TProjectId exte
   dataset?: TDataset
   /**
    * @beta
-   * Explicit source object to use for this operation.
+   * Explicit resource object to use for this operation.
+   */
+  resource?: DocumentResource
+  /**
+   * @deprecated Use `resource` instead.
+   * @beta
    */
-  source?: DocumentSource
+  source?: DocumentResource
 }
 
 /**
@@ -139,51 +150,106 @@ export interface SanityConfig extends DatasetHandle, PerspectiveHandle {
 
   /**
    * @beta
-   * A list of named sources to use for this instance.
+   * A list of named resources to use for this instance.
    */
-  sources?: Record<string, DocumentSource>
+  resources?: Record<string, DocumentResource>
+  /**
+   * @deprecated Use `resources` instead.
+   * @beta
+   */
+  sources?: Record<string, DocumentResource>
 }
 
 /**
- * A document source can be used for querying.
+ * A document resource can be used for querying.
  * This will soon be the default way to identify where you are querying from.
  *
  * @beta
  */
-export type DocumentSource = DatasetSource | MediaLibrarySource | CanvasSource
+export type DocumentResource = DatasetResource | MediaLibraryResource | CanvasResource
+
+/**
+ * @beta
+ */
+export type DatasetResource = {projectId: string; dataset: string}
+
+/**
+ * @beta
+ */
+export type MediaLibraryResource = {mediaLibraryId: string}
+
+/**
+ * @beta
+ */
+export type CanvasResource = {canvasId: string}
+
+/**
+ * @beta
+ */
+export function isDatasetResource(resource: DocumentResource): resource is DatasetResource {
+  return 'projectId' in resource && 'dataset' in resource
+}
+
+/**
+ * @beta
+ */
+export function isMediaLibraryResource(
+  resource: DocumentResource,
+): resource is MediaLibraryResource {
+  return 'mediaLibraryId' in resource
+}
+
+/**
+ * @beta
+ */
+export function isCanvasResource(resource: DocumentResource): resource is CanvasResource {
+  return 'canvasId' in resource
+}
+
+/**
+ * @deprecated Use `DocumentResource` instead.
+ * @beta
+ */
+export type DocumentSource = DocumentResource
 
 /**
+ * @deprecated Use `DatasetResource` instead.
  * @beta
  */
-export type DatasetSource = {projectId: string; dataset: string}
+export type DatasetSource = DatasetResource
 
 /**
+ * @deprecated Use `MediaLibraryResource` instead.
  * @beta
  */
-export type MediaLibrarySource = {mediaLibraryId: string}
+export type MediaLibrarySource = MediaLibraryResource
 
 /**
+ * @deprecated Use `CanvasResource` instead.
  * @beta
  */
-export type CanvasSource = {canvasId: string}
+export type CanvasSource = CanvasResource
 
 /**
+ * @deprecated Use `isDatasetResource` instead.
  * @beta
  */
 export function isDatasetSource(source: DocumentSource): source is DatasetSource {
-  return 'projectId' in source && 'dataset' in source
+  return isDatasetResource(source)
 }
 
 /**
+ * @deprecated Use `isMediaLibraryResource` instead.
  * @beta
  */
 export function isMediaLibrarySource(source: DocumentSource): source is MediaLibrarySource {
-  return 'mediaLibraryId' in source
+  return isMediaLibraryResource(source)
 }
 
 /**
+ * @deprecated Use `isCanvasResource` instead.
  * @beta
  */
 export function isCanvasSource(source: DocumentSource): source is CanvasSource {
-  return 'canvasId' in source
+  return isCanvasResource(source)
 }

package/src/document/actions.ts

@@ -4,7 +4,7 @@ import {type PatchMutation, type PatchOperations} from '@sanity/types'
 import {type SanityDocument} from 'groq'
 
 import {type DocumentHandle, type DocumentTypeHandle} from '../config/sanityConfig'
-import {getPublishedId} from '../utils/ids'
+import {getEffectiveDocumentId} from './util'
 
 const isSanityMutatePatch = (value: unknown): value is SanityMutatePatchMutation => {
   if (typeof value !== 'object' || !value) return false
@@ -140,12 +140,15 @@ export function createDocument<
     >
   >,
 ): CreateDocumentAction<TDocumentType, TDataset, TProjectId> {
+  // users may pass in an explicit documentId -- make sure we format it correctly for the action
+  let effectiveDocumentId
+  if (typeof doc.documentId === 'string') {
+    effectiveDocumentId = getEffectiveDocumentId({...doc, documentId: doc.documentId})
+  }
   return {
     type: 'document.create',
     ...doc,
-    ...(doc.documentId && {
-      documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
-    }),
+    ...(effectiveDocumentId && {documentId: effectiveDocumentId}),
     ...(initialValue && {initialValue}),
   }
 }
@@ -163,10 +166,11 @@ export function deleteDocument<
 >(
   doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
 ): DeleteDocumentAction<TDocumentType, TDataset, TProjectId> {
+  const effectiveDocumentId = getEffectiveDocumentId(doc)
   return {
     type: 'document.delete',
     ...doc,
-    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
+    documentId: effectiveDocumentId,
   }
 }
 
@@ -230,14 +234,14 @@ export function editDocument<
   doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
   patches?: PatchOperations | PatchOperations[] | SanityMutatePatchMutation,
 ): EditDocumentAction<TDocumentType, TDataset, TProjectId> {
-  const documentId = doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId)
+  const effectiveDocumentId = getEffectiveDocumentId(doc)
 
   if (isSanityMutatePatch(patches)) {
     const converted = convertSanityMutatePatch(patches) ?? []
     return {
       ...doc,
       type: 'document.edit',
-      documentId,
+      documentId: effectiveDocumentId,
       patches: converted,
     }
   }
@@ -245,7 +249,7 @@ export function editDocument<
   return {
     ...doc,
     type: 'document.edit',
-    documentId,
+    documentId: effectiveDocumentId,
     ...(patches && {patches: Array.isArray(patches) ? patches : [patches]}),
   }
 }
@@ -263,10 +267,11 @@ export function publishDocument<
 >(
   doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
 ): PublishDocumentAction<TDocumentType, TDataset, TProjectId> {
+  const effectiveDocumentId = getEffectiveDocumentId(doc)
   return {
     type: 'document.publish',
     ...doc,
-    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
+    documentId: effectiveDocumentId,
   }
 }
 
@@ -283,10 +288,11 @@ export function unpublishDocument<
 >(
   doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
 ): UnpublishDocumentAction<TDocumentType, TDataset, TProjectId> {
+  const effectiveDocumentId = getEffectiveDocumentId(doc)
   return {
     type: 'document.unpublish',
     ...doc,
-    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
+    documentId: effectiveDocumentId,
   }
 }
 
@@ -303,9 +309,10 @@ export function discardDocument<
 >(
   doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
 ): DiscardDocumentAction<TDocumentType, TDataset, TProjectId> {
+  const effectiveDocumentId = getEffectiveDocumentId(doc)
   return {
     type: 'document.discard',
     ...doc,
-    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
+    documentId: effectiveDocumentId,
   }
 }

package/src/document/applyDocumentActions.test.ts

@@ -1,11 +1,9 @@
-// applyDocumentActions.test.ts
 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'
 import {type DocumentAction} from './actions'
 import {type DocumentStoreState} from './documentStore'
@@ -14,7 +12,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<
@@ -48,9 +46,9 @@ describe('applyDocumentActions', () => {
     }
     state = createStoreState(initialState)
     instance = createSanityInstance({projectId: 'p', dataset: 'd'})
-    const key = {name: 'p.d', projectId: 'p', dataset: 'd'}
+    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),
     )
@@ -75,6 +73,7 @@ describe('applyDocumentActions', () => {
     const applyPromise = applyDocumentActions(instance, {
       actions: [action],
       transactionId: 'txn-success',
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     const appliedTx: AppliedTransaction = {
@@ -132,6 +131,7 @@ describe('applyDocumentActions', () => {
     const applyPromise = applyDocumentActions(instance, {
       actions: [action],
       transactionId: 'txn-error',
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     const errorEvent: DocumentEvent = {
@@ -165,6 +165,7 @@ describe('applyDocumentActions', () => {
     const applyPromise = applyDocumentActions(childInstance, {
       actions: [action],
       transactionId: 'txn-child-match',
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     // Simulate an applied transaction on the parent's instance

package/src/document/applyDocumentActions.ts

@@ -1,12 +1,13 @@
-import {type SanityClient} from '@sanity/client'
 import {type SanityDocument} from 'groq'
 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'
 import {documentStore, type DocumentStoreState} from './documentStore'
+import {type DocumentTransactionSubmissionResult} from './events'
 import {type DocumentSet} from './processMutations'
 import {type AppliedTransaction, type QueuedTransaction, queueTransaction} from './reducers'
 
@@ -19,7 +20,7 @@ export interface ActionsResult<TDocument extends SanityDocument = SanityDocument
   appeared: string[]
   updated: string[]
   disappeared: string[]
-  submitted: () => ReturnType<SanityClient['action']>
+  submitted: () => Promise<DocumentTransactionSubmissionResult>
 }
 
 /** @beta */
@@ -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
    */
@@ -61,7 +67,7 @@ export function applyDocumentActions(
   return boundApplyDocumentActions(...args)
 }
 
-const boundApplyDocumentActions = bindActionByDataset(documentStore, _applyDocumentActions)
+const boundApplyDocumentActions = bindActionByResource(documentStore, _applyDocumentActions)
 
 /** @internal */
 async function _applyDocumentActions(