@sanity/sdk 2.3.1 → 2.5.0

package/src/document/actions.ts

@@ -1,6 +1,7 @@
 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 DocumentHandle, type DocumentTypeHandle} from '../config/sanityConfig'
 import {getPublishedId} from '../utils/ids'
@@ -24,6 +25,17 @@ export interface CreateDocumentAction<
   TProjectId extends string = string,
 > extends DocumentTypeHandle<TDocumentType, TDataset, TProjectId> {
   type: 'document.create'
+  /**
+   * Optional initial field values for the document.
+   * These values will be set when the document is created.
+   * 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'
+    >
+  >
 }
 
 /**
@@ -111,6 +123,7 @@ export type DocumentAction<
 /**
  * Creates a `CreateDocumentAction` object.
  * @param doc - A handle identifying the document type, dataset, and project. An optional `documentId` can be provided.
+ * @param initialValue - Optional initial field values for the document. (System fields are omitted as they are set automatically.)
  * @returns A `CreateDocumentAction` object ready for dispatch.
  * @beta
  */
@@ -120,11 +133,20 @@ export function createDocument<
   TProjectId extends string = string,
 >(
   doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>,
+  initialValue?: Partial<
+    Omit<
+      SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
+      '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'
+    >
+  >,
 ): CreateDocumentAction<TDocumentType, TDataset, TProjectId> {
   return {
     type: 'document.create',
     ...doc,
-    ...(doc.documentId && {documentId: getPublishedId(doc.documentId)}),
+    ...(doc.documentId && {
+      documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
+    }),
+    ...(initialValue && {initialValue}),
   }
 }
 
@@ -144,7 +166,7 @@ export function deleteDocument<
   return {
     type: 'document.delete',
     ...doc,
-    documentId: getPublishedId(doc.documentId),
+    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
   }
 }
 
@@ -208,12 +230,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)
+
   if (isSanityMutatePatch(patches)) {
     const converted = convertSanityMutatePatch(patches) ?? []
     return {
       ...doc,
       type: 'document.edit',
-      documentId: getPublishedId(doc.documentId),
+      documentId,
       patches: converted,
     }
   }
@@ -221,7 +245,7 @@ export function editDocument<
   return {
     ...doc,
     type: 'document.edit',
-    documentId: getPublishedId(doc.documentId),
+    documentId,
     ...(patches && {patches: Array.isArray(patches) ? patches : [patches]}),
   }
 }
@@ -242,7 +266,7 @@ export function publishDocument<
   return {
     type: 'document.publish',
     ...doc,
-    documentId: getPublishedId(doc.documentId),
+    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
   }
 }
 
@@ -262,7 +286,7 @@ export function unpublishDocument<
   return {
     type: 'document.unpublish',
     ...doc,
-    documentId: getPublishedId(doc.documentId),
+    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
   }
 }
 
@@ -282,6 +306,6 @@ export function discardDocument<
   return {
     type: 'document.discard',
     ...doc,
-    documentId: getPublishedId(doc.documentId),
+    documentId: doc.liveEdit ? doc.documentId : getPublishedId(doc.documentId),
   }
 }

package/src/document/applyDocumentActions.test.ts

@@ -48,11 +48,11 @@ describe('applyDocumentActions', () => {
     }
     state = createStoreState(initialState)
     instance = createSanityInstance({projectId: 'p', dataset: 'd'})
+    const key = {name: 'p.d', projectId: 'p', dataset: 'd'}
 
     vi.mocked(bindActionByDataset).mockImplementation(
-      (_storeDef, action) =>
-        (instanceParam: SanityInstance, ...params: unknown[]) =>
-          action({instance: instanceParam, state}, ...params),
+      (_storeDef, action) => (instanceParam: SanityInstance, options) =>
+        action({instance: instanceParam, state, key}, options),
     )
     // Import dynamically to ensure mocks are set up before the module under test is loaded
     const module = await import('./applyDocumentActions')
@@ -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',
     })
 

package/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 = {