@sanity/sdk 2.9.0 → 2.11.0

package/src/config/sanityConfig.ts

@@ -73,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.
    */
-  source?: DocumentSource
+  resource?: DocumentResource
+  /**
+   * @deprecated Use `resource` instead.
+   * @beta
+   */
+  source?: DocumentResource
 }
 
 /**
@@ -120,7 +125,6 @@ export interface DocumentHandle<
 export interface SanityConfig extends DatasetHandle, PerspectiveHandle {
   /**
    * Authentication configuration for the instance
-   * @remarks Merged with parent configurations when using createChild
    */
   auth?: AuthConfig
   /**
@@ -145,51 +149,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.
+   */
+  resources?: Record<string, DocumentResource>
+  /**
+   * @deprecated Use `resources` instead.
+   * @beta
    */
-  sources?: Record<string, DocumentSource>
+  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/applyDocumentActions.test.ts

@@ -2,7 +2,7 @@ import {type SanityDocument} from '@sanity/types'
 import {Subject} from 'rxjs'
 import {describe, expect, it} from 'vitest'
 
-import {bindActionBySource} from '../store/createActionBinder'
+import {bindActionByResource} from '../store/createActionBinder'
 import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
 import {createStoreState, type StoreState} from '../store/createStoreState'
 import {type DocumentAction} from './actions'
@@ -12,7 +12,7 @@ import {type AppliedTransaction, type OutgoingTransaction} from './reducers'
 
 vi.mock('../store/createActionBinder', async (importOriginal) => ({
   ...(await importOriginal<typeof import('../store/createActionBinder')>()),
-  bindActionBySource: vi.fn(),
+  bindActionByResource: vi.fn(),
 }))
 
 type TestState = Pick<
@@ -46,9 +46,9 @@ describe('applyDocumentActions', () => {
     }
     state = createStoreState(initialState)
     instance = createSanityInstance({projectId: 'p', dataset: 'd'})
-    const key = {name: 'p.d', source: {projectId: 'p', dataset: 'd'}}
+    const key = {name: 'p.d', resource: {projectId: 'p', dataset: 'd'}}
 
-    vi.mocked(bindActionBySource).mockImplementation(
+    vi.mocked(bindActionByResource).mockImplementation(
       (_storeDef, action) => (instanceParam: SanityInstance, options) =>
         action({instance: instanceParam, state, key}, options),
     )
@@ -73,7 +73,7 @@ describe('applyDocumentActions', () => {
     const applyPromise = applyDocumentActions(instance, {
       actions: [action],
       transactionId: 'txn-success',
-      source: {projectId: 'p', dataset: 'd'},
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     const appliedTx: AppliedTransaction = {
@@ -131,7 +131,7 @@ describe('applyDocumentActions', () => {
     const applyPromise = applyDocumentActions(instance, {
       actions: [action],
       transactionId: 'txn-error',
-      source: {projectId: 'p', dataset: 'd'},
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     const errorEvent: DocumentEvent = {
@@ -165,7 +165,7 @@ describe('applyDocumentActions', () => {
     const applyPromise = applyDocumentActions(childInstance, {
       actions: [action],
       transactionId: 'txn-child-match',
-      source: {projectId: 'p', dataset: 'd'},
+      resource: {projectId: 'p', dataset: 'd'},
     })
 
     // Simulate an applied transaction on the parent's instance

package/src/document/applyDocumentActions.ts

@@ -1,8 +1,8 @@
 import {type SanityDocument} from 'groq'
 import {distinctUntilChanged, filter, first, firstValueFrom, map, race} from 'rxjs'
 
-import {type DocumentSource} from '../config/sanityConfig'
-import {bindActionBySource} 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'
@@ -31,9 +31,9 @@ export interface ApplyDocumentActionsOptions {
   actions: DocumentAction[]
 
   /**
-   * The source to which the documents being acted on belong.
+   * The resource to which the documents being acted on belong.
    */
-  source?: DocumentSource
+  resource?: DocumentResource
 
   /**
    * Optionally provide an ID to be used as this transaction ID
@@ -67,7 +67,7 @@ export function applyDocumentActions(
   return boundApplyDocumentActions(...args)
 }
 
-const boundApplyDocumentActions = bindActionBySource(documentStore, _applyDocumentActions)
+const boundApplyDocumentActions = bindActionByResource(documentStore, _applyDocumentActions)
 
 /** @internal */
 async function _applyDocumentActions(