@sanity/sdk 2.8.0 → 2.10.0

package/src/document/processActions.ts

@@ -1,4 +1,5 @@
 import {diffValue} from '@sanity/diff-patch'
+import {DocumentId, getDraftId, getPublishedId, getVersionId} from '@sanity/id-utils'
 import {
   type Mutation,
   type PatchOperations,
@@ -6,9 +7,9 @@ import {
   type SanityDocument,
 } from '@sanity/types'
 import {evaluateSync, type ExprNode} from 'groq-js'
-import {isEqual} from 'lodash-es'
 
-import {getDraftId, getPublishedId} from '../utils/ids'
+import {isReleasePerspective} from '../releases/utils/isReleasePerspective'
+import {isDeepEqual} from '../utils/object'
 import {type DocumentAction} from './actions'
 import {type Grant} from './permissions'
 import {type DocumentSet, getId, processMutations} from './processMutations'
@@ -151,8 +152,12 @@ export function processActions({
             })
           }
 
-          const newDocBase = {_type: action.documentType, _id: documentId}
-          const newDocWorking = {_type: action.documentType, _id: documentId}
+          const newDocBase = {_type: action.documentType, _id: documentId, ...action.initialValue}
+          const newDocWorking = {
+            _type: action.documentType,
+            _id: documentId,
+            ...action.initialValue,
+          }
           const mutations: Mutation[] = [{create: newDocWorking}]
 
           base = processMutations({
@@ -176,38 +181,41 @@ export function processActions({
             })
           }
 
+          // liveEdit documents use the mutation endpoint directly -- we don't send actions
           outgoingMutations.push(...mutations)
-          outgoingActions.push({
-            actionType: 'sanity.action.document.create',
-            publishedId: documentId,
-            attributes: newDocWorking,
-          })
           continue
         }
 
-        // Standard draft/published logic
-        const draftId = getDraftId(documentId)
-        const publishedId = getPublishedId(documentId)
+        // Standard draft/published/version logic
+        const versionId = isReleasePerspective(action.perspective)
+          ? getVersionId(DocumentId(documentId), action.perspective.releaseName)
+          : undefined
+        const draftId = getDraftId(DocumentId(documentId))
+        const publishedId = getPublishedId(DocumentId(documentId))
+
+        const alreadyHasVersion = versionId ? working[versionId] : working[draftId]
 
-        if (working[draftId]) {
+        if (alreadyHasVersion) {
+          const errorDocType = versionId ? 'release version' : 'draft'
           throw new ActionError({
             documentId,
             transactionId,
-            message: `A draft version of this document already exists. Please use or discard the existing draft before creating a new one.`,
+            message: `A ${errorDocType} of this document already exists. Please use or discard the existing ${errorDocType} before creating a new one.`,
           })
         }
 
-        // Spread the (possibly undefined) published version directly.
+        // Spread the (possibly undefined) draft or published version directly.
+        // (studio uses the draft version as a base if you are in a release perspective)
         const newDocBase = {
-          ...base[publishedId],
+          ...(base[draftId] ?? base[publishedId]),
           _type: action.documentType,
-          _id: draftId,
+          _id: versionId ?? draftId,
           ...action.initialValue,
         }
         const newDocWorking = {
-          ...working[publishedId],
+          ...(working[draftId] ?? working[publishedId]),
           _type: action.documentType,
-          _id: draftId,
+          _id: versionId ?? draftId,
           ...action.initialValue,
         }
         const mutations: Mutation[] = [{create: newDocWorking}]
@@ -225,7 +233,13 @@ export function processActions({
           timestamp,
         })
 
-        if (!checkGrant(grants.create, working[draftId] as SanityDocument)) {
+        if (versionId && !checkGrant(grants.create, working[versionId] as SanityDocument)) {
+          throw new PermissionActionError({
+            documentId,
+            transactionId,
+            message: `You do not have permission to create a release version for document "${documentId}".`,
+          })
+        } else if (!versionId && !checkGrant(grants.create, working[draftId] as SanityDocument)) {
           throw new PermissionActionError({
             documentId,
             transactionId,
@@ -245,8 +259,15 @@ export function processActions({
       case 'document.delete': {
         const documentId = action.documentId
 
+        if (isReleasePerspective(action.perspective)) {
+          throw new ActionError({
+            documentId,
+            transactionId,
+            message: `Cannot delete a version document. You may want to use the "unpublish" or "discard" actions instead.`,
+          })
+        }
+
         if (action.liveEdit) {
-          // For liveEdit documents, delete directly
           if (!working[documentId]) {
             throw new ActionError({
               documentId,
@@ -268,17 +289,16 @@ export function processActions({
           base = processMutations({documents: base, transactionId, mutations, timestamp})
           working = processMutations({documents: working, transactionId, mutations, timestamp})
 
+          // although liveEdit documents can use the actions API for deletion,
+          // having this be an action while other operations are mutations creates an inconsistency
+          // (and a possible race condition in document store where mutations might get skipped)
           outgoingMutations.push(...mutations)
-          outgoingActions.push({
-            actionType: 'sanity.action.document.delete',
-            publishedId: documentId,
-          })
           continue
         }
 
         // Standard draft/published logic
-        const draftId = getDraftId(documentId)
-        const publishedId = getPublishedId(documentId)
+        const draftId = getDraftId(DocumentId(documentId))
+        const publishedId = getPublishedId(DocumentId(documentId))
 
         if (!working[publishedId]) {
           throw new ActionError({
@@ -328,19 +348,21 @@ export function processActions({
           })
         }
 
-        // Standard draft/published logic
-        const draftId = getDraftId(documentId)
-        const mutations: Mutation[] = [{delete: {id: draftId}}]
+        // draft/published or version logic
+        const versionId = isReleasePerspective(action.perspective)
+          ? getVersionId(DocumentId(documentId), action.perspective.releaseName)
+          : getDraftId(DocumentId(documentId))
+        const mutations: Mutation[] = [{delete: {id: versionId}}]
 
-        if (!working[draftId]) {
+        if (!working[versionId]) {
           throw new ActionError({
             documentId,
             transactionId,
-            message: `There is no draft available to discard for document "${documentId}".`,
+            message: `There is no draft or version available to discard for document "${documentId}".`,
           })
         }
 
-        if (!checkGrant(grants.update, working[draftId])) {
+        if (!checkGrant(grants.update, working[versionId])) {
           throw new PermissionActionError({
             documentId,
             transactionId,
@@ -354,7 +376,7 @@ export function processActions({
         outgoingMutations.push(...mutations)
         outgoingActions.push({
           actionType: 'sanity.action.document.version.discard',
-          versionId: draftId,
+          versionId,
         })
         continue
       }
@@ -363,7 +385,7 @@ export function processActions({
         const documentId = getId(action.documentId)
 
         if (action.liveEdit) {
-          // For liveEdit documents, edit directly without draft logic
+          // Single-document mode (liveEdit or release perspective): edit directly without draft logic
           const userPatches = action.patches?.map((patch) => ({patch: {id: documentId, ...patch}}))
 
           // skip this action if there are no associated patches
@@ -408,31 +430,33 @@ export function processActions({
             timestamp,
           })
 
+          // liveEdit documents use the mutation endpoint directly -- we don't send actions
           outgoingMutations.push(...workingMutations)
-          outgoingActions.push(
-            ...patches.map(
-              (patch): HttpAction => ({
-                actionType: 'sanity.action.document.edit',
-                // Server requires draftId to have drafts. prefix for validation, even for liveEdit
-                draftId: getDraftId(documentId),
-                publishedId: documentId,
-                patch: patch as PatchOperations,
-              }),
-            ),
-          )
-
           continue
         }
 
-        // Standard draft/published logic
-        const draftId = getDraftId(documentId)
-        const publishedId = getPublishedId(documentId)
-        const userPatches = action.patches?.map((patch) => ({patch: {id: draftId, ...patch}}))
+        const versionId = isReleasePerspective(action.perspective)
+          ? getVersionId(DocumentId(documentId), action.perspective.releaseName)
+          : undefined
+        const draftId = getDraftId(DocumentId(documentId))
+        const publishedId = getPublishedId(DocumentId(documentId))
+        const patchDocumentId = isReleasePerspective(action.perspective) ? versionId! : draftId
+        const userPatches = action.patches?.map((patch) => ({
+          patch: {id: patchDocumentId, ...patch},
+        }))
 
         // skip this action if there are no associated patches
         if (!userPatches?.length) continue
 
-        if (
+        if (isReleasePerspective(action.perspective)) {
+          if (!working[versionId!] && !base[versionId!]) {
+            throw new ActionError({
+              documentId,
+              transactionId,
+              message: `This document does not exist in the release. Please create it or add it to the release first.`,
+            })
+          }
+        } else if (
           (!working[draftId] && !working[publishedId]) ||
           (!base[draftId] && !base[publishedId])
         ) {
@@ -444,12 +468,14 @@ export function processActions({
         }
 
         const baseMutations: Mutation[] = []
-        if (!base[draftId] && base[publishedId]) {
+        // don't create a draft from the published version in a release perspective
+        if (!isReleasePerspective(action.perspective) && !base[draftId] && base[publishedId]) {
+          // otherwise make a draft from the published version
           baseMutations.push({create: {...base[publishedId], _id: draftId}})
         }
 
-        // the first if statement should make this never be null or undefined
-        const baseBefore = (base[draftId] ?? base[publishedId]) as SanityDocument
+        // the above statement and guards should make this never be null or undefined
+        const baseBefore = base[patchDocumentId] ?? base[publishedId]
         if (userPatches) {
           baseMutations.push(...userPatches)
         }
@@ -462,11 +488,15 @@ export function processActions({
         })
         // this one will always be defined because a patch mutation will never
         // delete an input document
-        const baseAfter = base[draftId] as SanityDocument
+        const baseAfter = base[patchDocumentId] as SanityDocument
         const patches = diffValue(baseBefore, baseAfter)
 
         const workingMutations: Mutation[] = []
-        if (!working[draftId] && working[publishedId]) {
+        if (
+          !isReleasePerspective(action.perspective) &&
+          !working[draftId] &&
+          working[publishedId]
+        ) {
           const newDraftFromPublished = {...working[publishedId], _id: draftId}
 
           if (!checkGrant(grants.create, newDraftFromPublished)) {
@@ -481,15 +511,15 @@ export function processActions({
         }
 
         // the first if statement should make this never be null or undefined
-        const workingBefore = (working[draftId] ?? working[publishedId]) as SanityDocument
-        if (!checkGrant(grants.update, workingBefore)) {
+        const workingBefore = working[patchDocumentId] ?? working[publishedId]
+        if (!checkGrant(grants.update, workingBefore!)) {
           throw new PermissionActionError({
             documentId,
             transactionId,
             message: `You do not have permission to edit document "${documentId}".`,
           })
         }
-        workingMutations.push(...patches.map((patch) => ({patch: {id: draftId, ...patch}})))
+        workingMutations.push(...patches.map((patch) => ({patch: {id: patchDocumentId, ...patch}})))
 
         working = processMutations({
           documents: working,
@@ -500,14 +530,12 @@ export function processActions({
 
         outgoingMutations.push(...workingMutations)
         outgoingActions.push(
-          ...patches.map(
-            (patch): HttpAction => ({
-              actionType: 'sanity.action.document.edit',
-              draftId,
-              publishedId,
-              patch: patch as PatchOperations,
-            }),
-          ),
+          ...patches.map((patch) => ({
+            actionType: 'sanity.action.document.edit' as const,
+            draftId: patchDocumentId,
+            publishedId,
+            patch: patch as PatchOperations,
+          })),
         )
 
         continue
@@ -516,17 +544,17 @@ export function processActions({
       case 'document.publish': {
         const documentId = getId(action.documentId)
 
-        if (action.liveEdit) {
+        if (action.liveEdit || isReleasePerspective(action.perspective)) {
           throw new ActionError({
             documentId,
             transactionId,
-            message: `Cannot publish liveEdit document "${documentId}". LiveEdit documents do not support drafts or publishing.`,
+            message: `Cannot publish this document. Publishing is not supported for liveEdit or version (release) documents.`,
           })
         }
 
         // Standard draft/published logic
-        const draftId = getDraftId(documentId)
-        const publishedId = getPublishedId(documentId)
+        const draftId = getDraftId(DocumentId(documentId))
+        const publishedId = getPublishedId(DocumentId(documentId))
 
         const workingDraft = working[draftId]
         const baseDraft = base[draftId]
@@ -540,7 +568,7 @@ export function processActions({
 
         // Before proceeding, verify that the working draft is identical to the base draft.
         // TODO: is it enough just to check for the _rev or nah?
-        if (!isEqual(workingDraft, baseDraft)) {
+        if (!isDeepEqual(workingDraft, baseDraft)) {
           throw new ActionError({
             documentId,
             transactionId,
@@ -592,17 +620,17 @@ export function processActions({
       case 'document.unpublish': {
         const documentId = getId(action.documentId)
 
-        if (action.liveEdit) {
+        if (action.liveEdit || isReleasePerspective(action.perspective)) {
           throw new ActionError({
             documentId,
             transactionId,
-            message: `Cannot unpublish liveEdit document "${documentId}". LiveEdit documents do not support drafts or publishing.`,
+            message: `Cannot unpublish this document. Unpublishing is not supported for liveEdit or version (release) documents.`,
           })
         }
 
-        // Standard draft/published logic
-        const draftId = getDraftId(documentId)
-        const publishedId = getPublishedId(documentId)
+        // Standard draft/published or version logic
+        const draftId = getDraftId(DocumentId(documentId))
+        const publishedId = getPublishedId(DocumentId(documentId))
 
         if (!working[publishedId] && !base[publishedId]) {
           throw new ActionError({

package/src/document/reducers.test.ts

@@ -1,9 +1,9 @@
+import {DocumentId, getDraftId, getPublishedId} from '@sanity/id-utils'
 import {type SanityDocument} from '@sanity/types'
 import {parse} from 'groq-js'
 import {Subject} from 'rxjs'
 import {describe, expect, it} from 'vitest'
 
-import {getDraftId, getPublishedId} from '../utils/ids'
 import {type DocumentEvent} from './events'
 import {type RemoteDocument} from './listen'
 import {type DocumentSet} from './processMutations'
@@ -66,8 +66,8 @@ describe('queueTransaction', () => {
     expect(newState.queued[0]).toEqual(transaction)
 
     // Check that both the published and draft documentStates got a subscription id added.
-    const draftId = getDraftId('doc1')
-    const pubId = getPublishedId('doc1')
+    const draftId = getDraftId(DocumentId('doc1'))
+    const pubId = getPublishedId(DocumentId('doc1'))
     expect(newState.documentStates[draftId]).toBeDefined()
     expect(newState.documentStates[pubId]).toBeDefined()
     expect(newState.documentStates[draftId]?.subscriptions).toContain('txn1')
@@ -77,8 +77,8 @@ describe('queueTransaction', () => {
 
 describe('removeQueuedTransaction', () => {
   it('removes the transaction from queued and removes subscription ids from documents', () => {
-    const draftId = getDraftId('doc1')
-    const pubId = getPublishedId('doc1')
+    const draftId = getDraftId(DocumentId('doc1'))
+    const pubId = getPublishedId(DocumentId('doc1'))
 
     const initialState: SyncTransactionState = {
       queued: [
@@ -98,8 +98,8 @@ describe('removeQueuedTransaction', () => {
       outgoing: undefined,
       grants,
       documentStates: {
-        [draftId]: {id: draftId, subscriptions: ['txn1'], local: {}},
-        [pubId]: {id: pubId, subscriptions: ['txn1'], local: {}},
+        [draftId]: {id: draftId, subscriptions: ['txn1']},
+        [pubId]: {id: pubId, subscriptions: ['txn1']},
       } as SyncTransactionState['documentStates'],
     }
 
@@ -138,7 +138,7 @@ describe('applyFirstQueuedTransaction', () => {
 
   it('returns unchanged state if any required document is not yet loaded', () => {
     // If a document's local value is undefined, the reducer should do nothing.
-    const draftId = getDraftId('doc1')
+    const draftId = getDraftId(DocumentId('doc1'))
     const state: SyncTransactionState = {
       queued: [
         {
@@ -176,8 +176,8 @@ describe('applyFirstQueuedTransaction', () => {
 
   it('applies the first queued transaction (using a discard action)', () => {
     // For a discard action, processActions deletes the draft document.
-    const draftId = getDraftId('doc1')
-    const pubId = getPublishedId('doc1')
+    const draftId = getDraftId(DocumentId('doc1'))
+    const pubId = getPublishedId(DocumentId('doc1'))
     const initialDraft = {...exampleDoc, _id: draftId, foo: 'bar', _rev: 'rev1'}
     const initialPub = {...exampleDoc, _id: pubId, foo: 'bar', _rev: 'rev1'}
 
@@ -235,18 +235,26 @@ describe('batchAppliedTransactions', () => {
       disableBatching: false,
       outgoingActions: [],
       outgoingMutations: [],
-      base: {[getDraftId('doc1')]: {_id: getDraftId('doc1'), _rev: 'rev1'}} as DocumentSet,
+      base: {
+        [getDraftId(DocumentId('doc1'))]: {_id: getDraftId(DocumentId('doc1')), _rev: 'rev1'},
+      } as unknown as DocumentSet,
       working: {
-        [getDraftId('doc1')]: {
+        [getDraftId(DocumentId('doc1'))]: {
           ...exampleDoc,
-          _id: getDraftId('doc1'),
+          _id: getDraftId(DocumentId('doc1')),
           _rev: 'rev2',
           foo: 'a',
           bar: 'b',
         },
       },
-      previous: {[getDraftId('doc1')]: {...exampleDoc, _id: getDraftId('doc1'), _rev: 'rev1'}},
-      previousRevs: {[getDraftId('doc1')]: 'rev1'},
+      previous: {
+        [getDraftId(DocumentId('doc1'))]: {
+          ...exampleDoc,
+          _id: getDraftId(DocumentId('doc1')),
+          _rev: 'rev1',
+        },
+      },
+      previousRevs: {[getDraftId(DocumentId('doc1'))]: 'rev1'},
       timestamp: '2025-02-06T00:00:00.000Z',
     }
     const result = batchAppliedTransactions([appliedTx])
@@ -256,13 +264,14 @@ describe('batchAppliedTransactions', () => {
   })
 
   it('batches two edit transactions when possible', () => {
-    const draftId = getDraftId('doc1')
+    const documentId = DocumentId('doc1')
+    const draftId = getDraftId(documentId)
     const appliedTx1: AppliedTransaction = {
       transactionId: 'txn5',
       actions: [
         {
           type: 'document.edit',
-          documentId: 'doc1',
+          documentId,
           documentType: 'book',
           patches: [{set: {foo: 'a'}}],
         },
@@ -272,7 +281,7 @@ describe('batchAppliedTransactions', () => {
         {
           actionType: 'sanity.action.document.edit',
           draftId,
-          publishedId: getPublishedId('doc1'),
+          publishedId: getPublishedId(documentId),
           patch: {set: {foo: 'a'}},
         },
       ],
@@ -288,7 +297,7 @@ describe('batchAppliedTransactions', () => {
       actions: [
         {
           type: 'document.edit',
-          documentId: 'doc1',
+          documentId,
           documentType: 'book',
           patches: [{set: {bar: 'b'}}],
         },
@@ -298,7 +307,7 @@ describe('batchAppliedTransactions', () => {
         {
           actionType: 'sanity.action.document.edit',
           draftId,
-          publishedId: getPublishedId('doc1'),
+          publishedId: getPublishedId(documentId),
           patch: {set: {bar: 'b'}},
         },
       ],
@@ -322,7 +331,7 @@ describe('batchAppliedTransactions', () => {
   })
 
   it('returns a transaction with disableBatching true if a single edit action already has disableBatching set', () => {
-    const draftId = getDraftId('docA')
+    const draftId = getDraftId(DocumentId('docA'))
     const appliedTx: AppliedTransaction = {
       transactionId: 'txn-disable',
       actions: [
@@ -350,6 +359,85 @@ describe('batchAppliedTransactions', () => {
     // The actions array should be the same as the input's.
     expect(result?.actions).toEqual(appliedTx.actions)
   })
+
+  it('does not batch a liveEdit edit with a non-liveEdit edit', () => {
+    const nonLiveEditTx: AppliedTransaction = {
+      transactionId: 'txn-nonlive',
+      actions: [
+        {
+          type: 'document.edit',
+          documentId: 'doc1',
+          documentType: 'article',
+          patches: [{set: {foo: 'a'}}],
+        },
+      ],
+      disableBatching: false,
+      outgoingActions: [
+        {
+          actionType: 'sanity.action.document.edit',
+          draftId: getDraftId(DocumentId('doc1')),
+          publishedId: getPublishedId(DocumentId('doc1')),
+          patch: {set: {foo: 'a'}},
+        },
+      ],
+      outgoingMutations: [],
+      base: {
+        [getDraftId(DocumentId('doc1'))]: {
+          ...exampleDoc,
+          _id: getDraftId(DocumentId('doc1')),
+          _rev: 'rev1',
+        },
+      },
+      working: {
+        [getDraftId(DocumentId('doc1'))]: {
+          ...exampleDoc,
+          _id: getDraftId(DocumentId('doc1')),
+          _rev: 'rev2',
+        },
+      },
+      previous: {
+        [getDraftId(DocumentId('doc1'))]: {
+          ...exampleDoc,
+          _id: getDraftId(DocumentId('doc1')),
+          _rev: 'rev1',
+        },
+      },
+      previousRevs: {[getDraftId(DocumentId('doc1'))]: 'rev1'},
+      timestamp: '2025-02-06T00:00:00.000Z',
+    }
+    const liveEditTx: AppliedTransaction = {
+      transactionId: 'txn-live',
+      actions: [
+        {
+          type: 'document.edit',
+          documentId: 'doc2',
+          documentType: 'liveArticle',
+          liveEdit: true,
+          patches: [{set: {bar: 'b'}}],
+        },
+      ],
+      disableBatching: false,
+      outgoingActions: [],
+      outgoingMutations: [{patch: {id: 'doc2', set: {bar: 'b'}}}],
+      base: {doc2: {...exampleDoc, _id: 'doc2', _rev: 'rev1'}},
+      working: {doc2: {...exampleDoc, _id: 'doc2', _rev: 'rev2'}},
+      previous: {doc2: {...exampleDoc, _id: 'doc2', _rev: 'rev1'}},
+      previousRevs: {doc2: 'rev1'},
+      timestamp: '2025-02-06T00:01:00.000Z',
+    }
+
+    // liveEdit first: should return only the liveEdit transaction
+    const resultLiveFirst = batchAppliedTransactions([liveEditTx, nonLiveEditTx])
+    expect(resultLiveFirst?.batchedTransactionIds).toEqual(['txn-live'])
+    expect(resultLiveFirst?.outgoingMutations).toEqual(liveEditTx.outgoingMutations)
+    expect(resultLiveFirst?.outgoingActions).toHaveLength(0)
+
+    // non-liveEdit first: should return only the non-liveEdit transaction
+    const resultNonLiveFirst = batchAppliedTransactions([nonLiveEditTx, liveEditTx])
+    expect(resultNonLiveFirst?.batchedTransactionIds).toEqual(['txn-nonlive'])
+    expect(resultNonLiveFirst?.outgoingActions).toEqual(nonLiveEditTx.outgoingActions)
+    expect(resultNonLiveFirst?.outgoingMutations).toHaveLength(0)
+  })
 })
 
 describe('transitionAppliedTransactionsToOutgoing', () => {
@@ -366,7 +454,7 @@ describe('transitionAppliedTransactionsToOutgoing', () => {
   })
 
   it('transitions applied transactions to an outgoing transaction', () => {
-    const draftId = getDraftId('doc1')
+    const draftId = getDraftId(DocumentId('doc1'))
     const initialDoc = {...exampleDoc, _id: draftId, foo: 'old', _rev: 'rev1'}
     const state: SyncTransactionState = {
       queued: [],
@@ -426,8 +514,8 @@ describe('cleanupOutgoingTransaction', () => {
   })
 
   it('removes subscription ids for all documents associated with the outgoing transaction and then clears outgoing', () => {
-    const draftId = getDraftId('doc1')
-    const pubId = getPublishedId('doc1')
+    const draftId = getDraftId(DocumentId('doc1'))
+    const pubId = getPublishedId(DocumentId('doc1'))
     const state: SyncTransactionState = {
       queued: [],
       applied: [],
@@ -467,8 +555,8 @@ describe('cleanupOutgoingTransaction', () => {
 
 describe('revertOutgoingTransaction', () => {
   it('reverts the outgoing transaction and updates documentStates by removing unverified revisions', () => {
-    const draftId = getDraftId('doc1')
-    const pubId = getPublishedId('doc1')
+    const draftId = getDraftId(DocumentId('doc1'))
+    const pubId = getPublishedId(DocumentId('doc1'))
     // In this test we simulate a state with one applied transaction and an outgoing transaction.
     const state: SyncTransactionState = {
       queued: [],
@@ -565,7 +653,7 @@ describe('applyRemoteDocument', () => {
   })
 
   it('verifies an unverified revision when the revision matches and previousRev is as expected', () => {
-    const docId = getDraftId('doc1')
+    const docId = getDraftId(DocumentId('doc1'))
     const initialState: SyncTransactionState = {
       queued: [],
       applied: [],
@@ -607,7 +695,7 @@ describe('applyRemoteDocument', () => {
 
   it('rebases local changes when no matching unverified revision is found', () => {
     // In this branch we simply let processActions rebase so that the local becomes the remote.
-    const docId = getDraftId('doc1')
+    const docId = getDraftId(DocumentId('doc1'))
     const initialState: SyncTransactionState = {
       queued: [],
       applied: [],
@@ -642,7 +730,7 @@ describe('applyRemoteDocument', () => {
 
   // Test that a sync event removes outdated unverified revisions.
   it('removes outdated unverified revisions when a sync event is received', () => {
-    const docId = getDraftId('doc1')
+    const docId = getDraftId(DocumentId('doc1'))
     // An unverified revision created at an earlier time.
     const outdatedTimestamp = new Date('2025-02-06T00:09:00.000Z').toISOString()
     // The incoming sync event timestamp is later.