@sanity/sdk 2.4.0 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/sdk",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "private": false,
   "description": "Sanity SDK",
   "keywords": [
@@ -18,7 +18,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/sanity-io/sdk.git"
+    "url": "git+https://github.com/sanity-io/sdk.git",
+    "directory": "packages/core"
   },
   "license": "MIT",
   "author": "Sanity <developers@sanity.io>",
@@ -48,7 +49,7 @@
     "@sanity/diff-match-patch": "^3.2.0",
     "@sanity/diff-patch": "^6.0.0",
     "@sanity/json-match": "^1.0.5",
-    "@sanity/message-protocol": "^0.12.0",
+    "@sanity/message-protocol": "^0.18.0",
     "@sanity/mutate": "^0.12.4",
     "@sanity/types": "^3.83.0",
     "groq": "3.88.1-typegen-experimental.0",
@@ -60,7 +61,7 @@
   },
   "devDependencies": {
     "@sanity/browserslist-config": "^1.0.5",
-    "@sanity/pkg-utils": "^7.9.6",
+    "@sanity/pkg-utils": "^8.1.29",
     "@sanity/prettier-config": "^1.0.6",
     "@types/lodash-es": "^4.17.12",
     "@vitest/coverage-v8": "3.2.4",
@@ -70,14 +71,14 @@
     "typescript": "^5.8.3",
     "vite": "^6.3.4",
     "vitest": "^3.2.4",
+    "@repo/config-eslint": "0.0.0",
     "@repo/config-test": "0.0.1",
     "@repo/package.bundle": "3.82.0",
-    "@repo/config-eslint": "0.0.0",
-    "@repo/tsconfig": "0.0.1",
-    "@repo/package.config": "0.0.1"
+    "@repo/package.config": "0.0.1",
+    "@repo/tsconfig": "0.0.1"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=20.19"
   },
   "publishConfig": {
     "access": "public"

package/src/auth/authStore.test.ts

@@ -92,7 +92,7 @@ describe('authStore', () => {
         },
       })
 
-      const {options, dashboardContext} = authStore.getInitialState(instance)
+      const {options, dashboardContext} = authStore.getInitialState(instance, null)
 
       expect(options.apiHost).toBe(apiHost)
       expect(options.callbackUrl).toBe(callbackUrl)
@@ -114,7 +114,7 @@ describe('authStore', () => {
         auth: {initialLocationHref},
       })
 
-      const {dashboardContext, authState} = authStore.getInitialState(instance)
+      const {dashboardContext, authState} = authStore.getInitialState(instance, null)
       expect(dashboardContext).toEqual(context)
       expect(authState.type).toBe(AuthStateType.LOGGED_OUT)
     })
@@ -129,7 +129,7 @@ describe('authStore', () => {
         auth: {initialLocationHref},
       })
 
-      const {dashboardContext, authState} = authStore.getInitialState(instance)
+      const {dashboardContext, authState} = authStore.getInitialState(instance, null)
       expect(dashboardContext).toEqual(expectedContext)
       expect(authState.type).toBe(AuthStateType.LOGGED_OUT)
     })
@@ -143,7 +143,7 @@ describe('authStore', () => {
         auth: {initialLocationHref},
       })
 
-      const {dashboardContext, authState} = authStore.getInitialState(instance)
+      const {dashboardContext, authState} = authStore.getInitialState(instance, null)
       expect(dashboardContext).toStrictEqual({})
       expect(authState.type).toBe(AuthStateType.LOGGED_OUT)
       expect(errorSpy).toHaveBeenCalledWith(
@@ -166,7 +166,7 @@ describe('authStore', () => {
         },
       })
 
-      const {authState, dashboardContext} = authStore.getInitialState(instance)
+      const {authState, dashboardContext} = authStore.getInitialState(instance, null)
       expect(authState).toMatchObject({type: AuthStateType.LOGGED_IN, token})
       expect(dashboardContext).toEqual(context)
     })
@@ -182,7 +182,7 @@ describe('authStore', () => {
 
       vi.mocked(getAuthCode).mockReturnValue('auth-code')
 
-      const {authState, dashboardContext} = authStore.getInitialState(instance)
+      const {authState, dashboardContext} = authStore.getInitialState(instance, null)
       expect(authState).toMatchObject({type: AuthStateType.LOGGING_IN})
       expect(dashboardContext).toEqual(context)
     })
@@ -197,7 +197,7 @@ describe('authStore', () => {
       vi.mocked(getAuthCode).mockReturnValue(null)
       vi.mocked(getTokenFromStorage).mockReturnValue(storageToken)
 
-      const {authState, dashboardContext} = authStore.getInitialState(instance)
+      const {authState, dashboardContext} = authStore.getInitialState(instance, null)
       expect(authState).toMatchObject({type: AuthStateType.LOGGED_IN, token: storageToken})
       expect(dashboardContext).toStrictEqual({})
     })
@@ -215,7 +215,7 @@ describe('authStore', () => {
       vi.mocked(getAuthCode).mockReturnValue(null)
       vi.mocked(getTokenFromStorage).mockReturnValue(storageToken)
 
-      const {authState, dashboardContext} = authStore.getInitialState(instance)
+      const {authState, dashboardContext} = authStore.getInitialState(instance, null)
       expect(authState).toMatchObject({type: AuthStateType.LOGGED_OUT})
       expect(dashboardContext).toEqual(context)
     })
@@ -229,7 +229,7 @@ describe('authStore', () => {
       vi.mocked(getAuthCode).mockReturnValue(null)
       vi.mocked(getTokenFromStorage).mockReturnValue(null)
 
-      const {authState, dashboardContext} = authStore.getInitialState(instance)
+      const {authState, dashboardContext} = authStore.getInitialState(instance, null)
       expect(authState).toMatchObject({type: AuthStateType.LOGGED_OUT})
       expect(dashboardContext).toStrictEqual({})
     })
@@ -252,7 +252,7 @@ describe('authStore', () => {
         auth: {storageArea: mockStorage}, // Provide mock storage
       })
 
-      const {authState, options} = authStore.getInitialState(instance)
+      const {authState, options} = authStore.getInitialState(instance, null)
       expect(getStudioTokenFromLocalStorage).toHaveBeenCalledWith(mockStorage, studioStorageKey)
       expect(authState).toMatchObject({type: AuthStateType.LOGGED_IN, token: studioToken})
       expect(options.authMethod).toBe('localstorage')
@@ -277,7 +277,7 @@ describe('authStore', () => {
       })
 
       // Verify initial state without async cookie probe
-      const {authState: initialAuthState} = authStore.getInitialState(instance)
+      const {authState: initialAuthState} = authStore.getInitialState(instance, null)
       expect(initialAuthState.type).toBe(AuthStateType.LOGGED_OUT)
       expect(getStudioTokenFromLocalStorage).toHaveBeenCalledWith(mockStorage, studioStorageKey)
 
@@ -296,7 +296,7 @@ describe('authStore', () => {
         dataset: 'd',
       })
 
-      const {authState, options} = authStore.getInitialState(instance)
+      const {authState, options} = authStore.getInitialState(instance, null)
       expect(getStudioTokenFromLocalStorage).not.toHaveBeenCalled()
       expect(checkForCookieAuth).not.toHaveBeenCalled()
       expect(getTokenFromStorage).toHaveBeenCalled()
@@ -314,7 +314,7 @@ describe('authStore', () => {
       vi.mocked(getAuthCode).mockReturnValue(null)
       vi.mocked(getTokenFromLocation).mockReturnValue('hash-token')
 
-      const {authState} = authStore.getInitialState(instance)
+      const {authState} = authStore.getInitialState(instance, null)
       expect(authState).toMatchObject({
         type: AuthStateType.LOGGING_IN,
         isExchangingToken: false,

package/src/auth/refreshStampedToken.test.ts

@@ -122,7 +122,7 @@ describe('refreshStampedToken', () => {
         dataset: 'd',
         auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
       })
-      const initialState = authStore.getInitialState(instance)
+      const initialState = authStore.getInitialState(instance, null)
       initialState.authState = {
         type: AuthStateType.LOGGED_IN,
         token: 'sk-initial-token-st123',
@@ -131,7 +131,7 @@ describe('refreshStampedToken', () => {
       initialState.dashboardContext = {mode: 'test'}
       const state = createStoreState(initialState)
 
-      const subscription = refreshStampedToken({state, instance})
+      const subscription = refreshStampedToken({state, instance, key: null})
       subscriptions.push(subscription)
 
       await vi.advanceTimersToNextTimerAsync()
@@ -168,7 +168,7 @@ describe('refreshStampedToken', () => {
         dataset: 'd',
         auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
       })
-      const initialState = authStore.getInitialState(instance)
+      const initialState = authStore.getInitialState(instance, null)
       initialState.authState = {
         type: AuthStateType.LOGGED_IN,
         token: 'sk-initial-token-st123',
@@ -177,7 +177,7 @@ describe('refreshStampedToken', () => {
       initialState.dashboardContext = {mode: 'test'}
       const state = createStoreState(initialState)
 
-      const subscription = refreshStampedToken({state, instance})
+      const subscription = refreshStampedToken({state, instance, key: null})
       subscriptions.push(subscription)
 
       await vi.advanceTimersToNextTimerAsync()
@@ -202,7 +202,7 @@ describe('refreshStampedToken', () => {
         dataset: 'd',
         auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
       })
-      const initialState = authStore.getInitialState(instance)
+      const initialState = authStore.getInitialState(instance, null)
       initialState.authState = {
         type: AuthStateType.LOGGED_IN,
         token: 'sk-initial-token-st123',
@@ -213,7 +213,7 @@ describe('refreshStampedToken', () => {
       let subscription: Subscription | undefined
       // We expect this NOT to throw, but accept we can't easily test the lock call or outcome
       expect(() => {
-        subscription = refreshStampedToken({state, instance})
+        subscription = refreshStampedToken({state, instance, key: null})
         subscriptions.push(subscription!)
       }).not.toThrow()
 
@@ -253,7 +253,7 @@ describe('refreshStampedToken', () => {
           dataset: 'd',
           auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
         })
-        const initialState = authStore.getInitialState(instance)
+        const initialState = authStore.getInitialState(instance, null)
         initialState.authState = {
           type: AuthStateType.LOGGED_IN,
           token: 'sk-initial-token-st123',
@@ -261,7 +261,7 @@ describe('refreshStampedToken', () => {
         }
         const state = createStoreState(initialState)
 
-        const subscription = refreshStampedToken({state, instance})
+        const subscription = refreshStampedToken({state, instance, key: null})
         subscriptions.push(subscription)
 
         // DO NOT advance timers or yield here - focus on immediate observable logic
@@ -303,7 +303,7 @@ describe('refreshStampedToken', () => {
           dataset: 'd',
           auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
         })
-        const initialState = authStore.getInitialState(instance)
+        const initialState = authStore.getInitialState(instance, null)
         initialState.authState = {
           type: AuthStateType.LOGGED_IN,
           token: 'sk-initial-token-st123',
@@ -311,7 +311,7 @@ describe('refreshStampedToken', () => {
         }
         const state = createStoreState(initialState)
 
-        const subscription = refreshStampedToken({state, instance})
+        const subscription = refreshStampedToken({state, instance, key: null})
         subscriptions.push(subscription)
 
         // Advance timers to allow the async `performRefresh` to execute
@@ -349,7 +349,7 @@ describe('refreshStampedToken', () => {
       dataset: 'd',
       auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
     })
-    const initialState = authStore.getInitialState(instance)
+    const initialState = authStore.getInitialState(instance, null)
     initialState.authState = {
       type: AuthStateType.LOGGED_IN,
       token: 'sk-initial-token-st123',
@@ -358,7 +358,7 @@ describe('refreshStampedToken', () => {
     initialState.dashboardContext = {mode: 'test'}
     const state = createStoreState(initialState)
 
-    const subscription = refreshStampedToken({state, instance})
+    const subscription = refreshStampedToken({state, instance, key: null})
     subscriptions.push(subscription)
 
     await vi.advanceTimersToNextTimerAsync()
@@ -378,14 +378,14 @@ describe('refreshStampedToken', () => {
       dataset: 'd',
       auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
     })
-    const initialState = authStore.getInitialState(instance)
+    const initialState = authStore.getInitialState(instance, null)
     initialState.authState = {
       type: AuthStateType.LOGGED_OUT,
       isDestroyingSession: false,
     } as AuthState
     const state = createStoreState(initialState)
 
-    const subscription = refreshStampedToken({state, instance})
+    const subscription = refreshStampedToken({state, instance, key: null})
     subscriptions.push(subscription)
 
     await vi.advanceTimersByTimeAsync(0)
@@ -404,7 +404,7 @@ describe('refreshStampedToken', () => {
       dataset: 'd',
       auth: {clientFactory: mockClientFactory, storageArea: mockStorage},
     })
-    const initialState = authStore.getInitialState(instance)
+    const initialState = authStore.getInitialState(instance, null)
     initialState.authState = {
       type: AuthStateType.LOGGED_IN,
       token: 'sk-nonstamped-token',
@@ -412,7 +412,7 @@ describe('refreshStampedToken', () => {
     }
     const state = createStoreState(initialState)
 
-    const subscription = refreshStampedToken({state, instance})
+    const subscription = refreshStampedToken({state, instance, key: null})
     subscriptions.push(subscription)
 
     await vi.advanceTimersByTimeAsync(0)

package/src/auth/subscribeToStateAndFetchCurrentUser.test.ts

@@ -20,8 +20,8 @@ describe('subscribeToStateAndFetchCurrentUser', () => {
     const clientFactory = vi.fn().mockReturnValue(mockClient)
     const instance = createSanityInstance({projectId: 'p', dataset: 'd', auth: {clientFactory}})
 
-    const state = createStoreState(authStore.getInitialState(instance))
-    const subscription = subscribeToStateAndFetchCurrentUser({state, instance})
+    const state = createStoreState(authStore.getInitialState(instance, null))
+    const subscription = subscribeToStateAndFetchCurrentUser({state, instance, key: null})
 
     expect(state.get()).toMatchObject({authState: {type: AuthStateType.LOGGED_OUT}})
 
@@ -52,8 +52,8 @@ describe('subscribeToStateAndFetchCurrentUser', () => {
     const clientFactory = vi.fn().mockReturnValue(mockClient)
     const instance = createSanityInstance({projectId: 'p', dataset: 'd', auth: {clientFactory}})
 
-    const state = createStoreState(authStore.getInitialState(instance))
-    const subscription = subscribeToStateAndFetchCurrentUser({state, instance})
+    const state = createStoreState(authStore.getInitialState(instance, null))
+    const subscription = subscribeToStateAndFetchCurrentUser({state, instance, key: null})
 
     expect(state.get()).toMatchObject({authState: {type: AuthStateType.LOGGED_OUT}})
 
@@ -88,8 +88,8 @@ describe('subscribeToStateAndFetchCurrentUser', () => {
     const clientFactory = vi.fn().mockReturnValue(mockClient)
     const instance = createSanityInstance({projectId: 'p', dataset: 'd', auth: {clientFactory}})
 
-    const state = createStoreState(authStore.getInitialState(instance))
-    const subscription = subscribeToStateAndFetchCurrentUser({state, instance})
+    const state = createStoreState(authStore.getInitialState(instance, null))
+    const subscription = subscribeToStateAndFetchCurrentUser({state, instance, key: null})
 
     expect(state.get()).toMatchObject({authState: {type: AuthStateType.LOGGED_OUT}})
 

package/src/auth/subscribeToStorageEventsAndSetToken.test.ts

@@ -34,9 +34,9 @@ describe('subscribeToStorageEventsAndSetToken', () => {
   })
 
   it('sets the state to logged in when a matching storage event returns a token', () => {
-    const state = createStoreState(authStore.getInitialState(instance))
+    const state = createStoreState(authStore.getInitialState(instance, null))
     const {storageKey} = state.get().options
-    const subscription = subscribeToStorageEventsAndSetToken({state, instance})
+    const subscription = subscribeToStorageEventsAndSetToken({state, instance, key: null})
 
     expect(state.get()).toMatchObject({
       authState: {type: AuthStateType.LOGGED_OUT, isDestroyingSession: false},
@@ -54,10 +54,10 @@ describe('subscribeToStorageEventsAndSetToken', () => {
 
   it('sets the state to logged in when a matching storage event returns null', () => {
     vi.mocked(getTokenFromStorage).mockReturnValue('existing-token')
-    const state = createStoreState(authStore.getInitialState(instance))
+    const state = createStoreState(authStore.getInitialState(instance, null))
     const {storageKey} = state.get().options
 
-    const subscription = subscribeToStorageEventsAndSetToken({state, instance})
+    const subscription = subscribeToStorageEventsAndSetToken({state, instance, key: null})
 
     expect(state.get()).toMatchObject({
       authState: {type: AuthStateType.LOGGED_IN, token: 'existing-token', currentUser: null},

package/src/comlink/controller/actions/destroyController.test.ts

@@ -39,7 +39,7 @@ describe('destroyController', () => {
     })
 
     // Execute action
-    destroyController({state, instance})
+    destroyController({state, instance, key: null})
 
     // Verify controller was destroyed and state was cleared
     expect(mockController.destroy).toHaveBeenCalled()
@@ -49,7 +49,7 @@ describe('destroyController', () => {
 
   it('should do nothing if no controller exists', () => {
     // State already has null controller, so just execute action
-    expect(() => destroyController({state, instance})).not.toThrow()
+    expect(() => destroyController({state, instance, key: null})).not.toThrow()
 
     // State should remain unchanged
     expect(state.get().controller).toBeNull()

package/src/comlink/controller/actions/getOrCreateChannel.test.ts

@@ -49,7 +49,7 @@ describe('getOrCreateChannel', () => {
   it('should create a new channel using the controller', () => {
     const createChannelSpy = vi.spyOn(mockController, 'createChannel')
 
-    const channel = getOrCreateChannel({state, instance}, channelConfig)
+    const channel = getOrCreateChannel({state, instance, key: null}, channelConfig)
 
     expect(createChannelSpy).toHaveBeenCalledWith(channelConfig)
     expect(channel.on).toBeDefined()
@@ -70,17 +70,17 @@ describe('getOrCreateChannel', () => {
       channels: new Map(),
     })
 
-    expect(() => getOrCreateChannel({state, instance}, channelConfig)).toThrow(
+    expect(() => getOrCreateChannel({state, instance, key: null}, channelConfig)).toThrow(
       'Controller must be initialized before using or creating channels',
     )
   })
 
   it('should retrieve channel directly from store once created', () => {
-    const createdChannel = getOrCreateChannel({state, instance}, channelConfig)
+    const createdChannel = getOrCreateChannel({state, instance, key: null}, channelConfig)
     vi.clearAllMocks() // Clear call counts
 
     // Retrieve channel again
-    const retrievedChannel = getOrCreateChannel({state, instance}, channelConfig)
+    const retrievedChannel = getOrCreateChannel({state, instance, key: null}, channelConfig)
     expect(retrievedChannel).toBeDefined()
     expect(retrievedChannel).toBe(createdChannel)
 
@@ -95,10 +95,10 @@ describe('getOrCreateChannel', () => {
   })
 
   it('should throw error when trying to create channel with different options', () => {
-    getOrCreateChannel({state, instance}, channelConfig)
+    getOrCreateChannel({state, instance, key: null}, channelConfig)
 
     expect(() =>
-      getOrCreateChannel({state, instance}, {...channelConfig, connectTo: 'window'}),
+      getOrCreateChannel({state, instance, key: null}, {...channelConfig, connectTo: 'window'}),
     ).toThrow('Channel "test" already exists with different options')
   })
 })

package/src/comlink/controller/actions/getOrCreateController.test.ts

@@ -43,7 +43,7 @@ describe('getOrCreateController', () => {
     const controllerSpy = vi.spyOn(comlink, 'createController')
     const targetOrigin = 'https://test.sanity.dev'
 
-    const controller = getOrCreateController({state, instance}, targetOrigin)
+    const controller = getOrCreateController({state, instance, key: null}, targetOrigin)
 
     expect(controllerSpy).toHaveBeenCalledWith({targetOrigin})
     expect(controller).toBeDefined()
@@ -56,8 +56,8 @@ describe('getOrCreateController', () => {
     const controllerSpy = vi.spyOn(comlink, 'createController')
     const targetOrigin = 'https://test.sanity.dev'
 
-    const firstController = getOrCreateController({state, instance}, targetOrigin)
-    const secondController = getOrCreateController({state, instance}, targetOrigin)
+    const firstController = getOrCreateController({state, instance, key: null}, targetOrigin)
+    const secondController = getOrCreateController({state, instance, key: null}, targetOrigin)
 
     expect(controllerSpy).toHaveBeenCalledTimes(1)
     expect(firstController).toBe(secondController)
@@ -68,9 +68,9 @@ describe('getOrCreateController', () => {
     const targetOrigin = 'https://test.sanity.dev'
     const targetOrigin2 = 'https://test2.sanity.dev'
 
-    const firstController = getOrCreateController({state, instance}, targetOrigin)
+    const firstController = getOrCreateController({state, instance, key: null}, targetOrigin)
     const destroySpy = vi.spyOn(firstController, 'destroy')
-    const secondController = getOrCreateController({state, instance}, targetOrigin2)
+    const secondController = getOrCreateController({state, instance, key: null}, targetOrigin2)
 
     expect(controllerSpy).toHaveBeenCalledTimes(2)
     expect(destroySpy).toHaveBeenCalled()

package/src/comlink/controller/actions/getOrCreateController.ts

@@ -21,7 +21,7 @@ export const getOrCreateController = (
   // if the target origin has changed, we'll create a new controller,
   // but need to clean up first
   if (controller) {
-    destroyController({state, instance})
+    destroyController({state, instance, key: undefined})
   }
 
   const newController = createController({targetOrigin})

package/src/comlink/controller/actions/releaseChannel.test.ts

@@ -19,6 +19,7 @@ const channelConfig = {
 describe('releaseChannel', () => {
   let instance: SanityInstance
   let store: StoreInstance<ComlinkControllerState>
+  const key = {name: 'global', projectId: 'test-project-id', dataset: 'test-dataset'}
 
   let getOrCreateChannel: (
     inst: SanityInstance,
@@ -29,14 +30,14 @@ describe('releaseChannel', () => {
 
   beforeEach(() => {
     instance = createSanityInstance({projectId: 'test-project-id', dataset: 'test-dataset'})
-    store = createStoreInstance(instance, comlinkControllerStore)
+    store = createStoreInstance(instance, key, comlinkControllerStore)
 
     const bind =
       <TParams extends unknown[], TReturn>(
         action: StoreAction<ComlinkControllerState, TParams, TReturn>,
       ) =>
       (inst: SanityInstance, ...params: TParams) =>
-        action({instance: inst, state: store.state}, ...params)
+        action({instance: inst, state: store.state, key}, ...params)
 
     getOrCreateChannel = bind(unboundGetOrCreateChannel)
     getOrCreateController = bind(unboundGetOrCreateController)

package/src/comlink/controller/comlinkControllerStore.test.ts

@@ -31,7 +31,7 @@ describe('comlinkControllerStore', () => {
 
     // Create store state directly
     const state = createStoreState<ComlinkControllerState>(
-      comlinkControllerStore.getInitialState(instance),
+      comlinkControllerStore.getInitialState(instance, null),
     )
 
     const initialState = state.get()
@@ -56,13 +56,13 @@ describe('comlinkControllerStore', () => {
     vi.mocked(bindActionGlobally).mockImplementation(
       (_storeDef, action) =>
         (inst: SanityInstance, ...params: unknown[]) =>
-          action({instance: inst, state}, ...params),
+          action({instance: inst, state, key: {name: 'global'}}, ...params),
     )
 
     const {comlinkControllerStore} = await import('./comlinkControllerStore')
 
     // Get the cleanup function from the store
-    const dispose = comlinkControllerStore.initialize?.({state, instance})
+    const dispose = comlinkControllerStore.initialize?.({state, instance, key: null})
 
     // Run cleanup
     dispose?.()
@@ -82,7 +82,7 @@ describe('comlinkControllerStore', () => {
     })
 
     // Get the cleanup function
-    const cleanup = comlinkControllerStore.initialize?.({state, instance})
+    const cleanup = comlinkControllerStore.initialize?.({state, instance, key: null})
 
     // Should not throw when no controller exists
     expect(() => cleanup?.()).not.toThrow()

package/src/comlink/node/actions/getOrCreateNode.test.ts

@@ -40,24 +40,24 @@ describe('getOrCreateNode', () => {
   })
 
   it('should create and start a node', () => {
-    const node = getOrCreateNode({state, instance}, nodeConfig)
+    const node = getOrCreateNode({state, instance, key: null}, nodeConfig)
 
     expect(comlink.createNode).toHaveBeenCalledWith(nodeConfig)
     expect(node.start).toHaveBeenCalled()
   })
 
   it('should store the node in nodeStore', () => {
-    const node = getOrCreateNode({state, instance}, nodeConfig)
+    const node = getOrCreateNode({state, instance, key: null}, nodeConfig)
 
-    expect(getOrCreateNode({state, instance}, nodeConfig)).toBe(node)
+    expect(getOrCreateNode({state, instance, key: null}, nodeConfig)).toBe(node)
   })
 
   it('should throw error when trying to create node with different options', () => {
-    getOrCreateNode({state, instance}, nodeConfig)
+    getOrCreateNode({state, instance, key: null}, nodeConfig)
 
     expect(() =>
       getOrCreateNode(
-        {state, instance},
+        {state, instance, key: null},
         {
           ...nodeConfig,
           connectTo: 'window',
@@ -74,7 +74,7 @@ describe('getOrCreateNode', () => {
       return statusUnsubMock
     })
 
-    getOrCreateNode({state, instance}, nodeConfig)
+    getOrCreateNode({state, instance, key: null}, nodeConfig)
 
     expect(mockNode.onStatus).toHaveBeenCalled()
     expect(state.get().nodes.get(nodeConfig.name)?.statusUnsub).toBe(statusUnsubMock)
@@ -92,7 +92,7 @@ describe('getOrCreateNode', () => {
       return statusUnsubMock
     })
 
-    getOrCreateNode({state, instance}, nodeConfig)
+    getOrCreateNode({state, instance, key: null}, nodeConfig)
 
     // Remove the node entry before triggering the status callback
     state.get().nodes.delete(nodeConfig.name)

package/src/comlink/node/actions/releaseNode.test.ts

@@ -47,7 +47,7 @@ describe('releaseNode', () => {
     expect(state.get().nodes.has('test-node')).toBe(true)
 
     // Release the node
-    releaseNode({state, instance}, 'test-node')
+    releaseNode({state, instance, key: null}, 'test-node')
 
     // Check node is removed
     expect(mockNode.stop).toHaveBeenCalled()
@@ -64,7 +64,7 @@ describe('releaseNode', () => {
     })
     state.set('setup', {nodes})
 
-    releaseNode({state, instance}, 'test-node')
+    releaseNode({state, instance, key: null}, 'test-node')
 
     expect(statusUnsub).toHaveBeenCalled()
   })

package/src/comlink/node/comlinkNodeStore.test.ts

@@ -14,7 +14,7 @@ describe('nodeStore', () => {
   })
 
   it('should have correct initial state', () => {
-    const initialState = comlinkNodeStore.getInitialState(instance)
+    const initialState = comlinkNodeStore.getInitialState(instance, null)
 
     expect(initialState.nodes).toBeInstanceOf(Map)
     expect(initialState.nodes.size).toBe(0)
@@ -25,16 +25,17 @@ describe('nodeStore', () => {
       stop: vi.fn(),
     } as unknown as Node<WindowMessage, FrameMessage>
 
-    const initialState = comlinkNodeStore.getInitialState(instance)
+    const initialState = comlinkNodeStore.getInitialState(instance, null)
     initialState.nodes.set('test-node', {
       options: {name: 'test-node', connectTo: 'parent'},
       node: mockNode,
-      refCount: 1,
+      status: 'idle',
     })
 
     const cleanup = comlinkNodeStore.initialize?.({
       instance,
       state: createStoreState(initialState),
+      key: null,
     })
 
     cleanup?.()

package/src/config/sanityConfig.ts

@@ -29,15 +29,14 @@ export interface PerspectiveHandle {
  * @public
  */
 export interface DatasetHandle<TDataset extends string = string, TProjectId extends string = string>
-  extends ProjectHandle<TProjectId>,
-    PerspectiveHandle {
+  extends ProjectHandle<TProjectId>, PerspectiveHandle {
   dataset?: TDataset
 }
 
 /**
  * Identifies a specific document type within a Sanity dataset and project.
  * Includes `projectId`, `dataset`, and `documentType`.
- * Optionally includes a `documentId`, useful for referencing a specific document type context, potentially without a specific document ID.
+ * Optionally includes a `documentId` and `liveEdit` flag.
  * @public
  */
 export interface DocumentTypeHandle<
@@ -47,6 +46,12 @@ export interface DocumentTypeHandle<
 > extends DatasetHandle<TDataset, TProjectId> {
   documentId?: string
   documentType: TDocumentType
+  /**
+   * Indicates whether this document uses liveEdit mode.
+   * When `true`, the document does not use the draft/published model and edits are applied directly to the document.
+   * @see https://www.sanity.io/docs/content-lake/drafts#ca0663a8f002
+   */
+  liveEdit?: boolean
 }
 
 /**