feat: make applyDocumentActions more similar to the rest

`applyDocumentActions` was the only function in the `core` package which
interpreted the `SanityInstance` as a tree, automatically traversing the
tree to find a matching instance. This is inconsistent with the other
stores (e.g. query store) which assumes that it's being called with the
right instance.

In addition, this changes `applyDocumentActions` to only accept actions
as an array (so we don't have to check if it's an array or not) and also
it places the `actions` as part of option. This is consistent with e.g.
`getQueryState` which has a required `query` field in its options.
This now means that all functions which are wrapped in
`bindActionByDataset` are now consistently getting passed an object as
their first argument. This is going to be key so that we later can
modify this function to consider the options (instead of the instance).

There should be no breaking changes in the React package.

Author: judofyr

packages/core/src/document/applyDocumentActions.test.ts

@@ -72,7 +72,8 @@ describe('applyDocumentActions', () => {
     }
 
     // Call applyDocumentActions with a fixed transactionId for reproducibility.
-    const applyPromise = applyDocumentActions(instance, action, {
+    const applyPromise = applyDocumentActions(instance, {
+      actions: [action],
       transactionId: 'txn-success',
     })
 
@@ -128,7 +129,8 @@ describe('applyDocumentActions', () => {
     }
 
     // Call applyDocumentActions with a fixed transactionId.
-    const applyPromise = applyDocumentActions(instance, action, {
+    const applyPromise = applyDocumentActions(instance, {
+      actions: [action],
       transactionId: 'txn-error',
     })
 
@@ -160,7 +162,8 @@ describe('applyDocumentActions', () => {
       dataset: 'd',
     }
     // Call applyDocumentActions with the context using childInstance, but with action requiring parent's config
-    const applyPromise = applyDocumentActions(childInstance, action, {
+    const applyPromise = applyDocumentActions(childInstance, {
+      actions: [action],
       transactionId: 'txn-child-match',
     })
 

packages/core/src/document/applyDocumentActions.ts

@@ -24,6 +24,11 @@ export interface ActionsResult<TDocument extends SanityDocument = SanityDocument
 
 /** @beta */
 export interface ApplyDocumentActionsOptions {
+  /**
+   * List of actions to apply.
+   */
+  actions: DocumentAction[]
+
   /**
    * Optionally provide an ID to be used as this transaction ID
    */
@@ -41,16 +46,12 @@ export function applyDocumentActions<
   TProjectId extends string = string,
 >(
   instance: SanityInstance,
-  action:
-    | DocumentAction<TDocumentType, TDataset, TProjectId>
-    | DocumentAction<TDocumentType, TDataset, TProjectId>[],
-  options?: ApplyDocumentActionsOptions,
+  options: ApplyDocumentActionsOptions,
 ): Promise<ActionsResult<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>>>
 /** @beta */
 export function applyDocumentActions(
   instance: SanityInstance,
-  action: DocumentAction | DocumentAction[],
-  options?: ApplyDocumentActionsOptions,
+  options: ApplyDocumentActionsOptions,
 ): Promise<ActionsResult>
 
 /** @beta */
@@ -64,50 +65,9 @@ const boundApplyDocumentActions = bindActionByDataset(documentStore, _applyDocum
 
 /** @internal */
 async function _applyDocumentActions(
-  {instance, state}: StoreContext<DocumentStoreState>,
-  actionOrActions: DocumentAction | DocumentAction[],
-  {transactionId = crypto.randomUUID(), disableBatching}: ApplyDocumentActionsOptions = {},
+  {state}: StoreContext<DocumentStoreState>,
+  {actions, transactionId = crypto.randomUUID(), disableBatching}: ApplyDocumentActionsOptions,
 ): Promise<ActionsResult> {
-  const actions = Array.isArray(actionOrActions) ? actionOrActions : [actionOrActions]
-
-  let projectId
-  let dataset
-  for (const action of actions) {
-    if (action.projectId) {
-      if (!projectId) projectId = action.projectId
-      if (action.projectId !== projectId) {
-        throw new Error(
-          `Mismatched project IDs found in actions. All actions must belong to the same project. Found "${action.projectId}" but expected "${projectId}".`,
-        )
-      }
-
-      if (action.dataset) {
-        if (!dataset) dataset = action.dataset
-        if (action.dataset !== dataset) {
-          throw new Error(
-            `Mismatched datasets found in actions. All actions must belong to the same dataset. Found "${action.dataset}" but expected "${dataset}".`,
-          )
-        }
-      }
-    }
-  }
-
-  if (
-    (projectId && projectId !== instance.config.projectId) ||
-    (dataset && dataset !== instance.config.dataset)
-  ) {
-    const matchedInstance = instance.match({projectId, dataset})
-    if (!matchedInstance) {
-      throw new Error(
-        `Could not find a matching instance for projectId: "${projectId}" and dataset: "${dataset}"`,
-      )
-    }
-    return boundApplyDocumentActions(matchedInstance, actionOrActions, {
-      disableBatching,
-      transactionId,
-    })
-  }
-
   const {events} = state.get()
 
   const transaction: QueuedTransaction = {