feat: upgrade groq-js with support for synchronous evaluation (#637)

Author: judofyr

packages/core/package.json

@@ -66,6 +66,7 @@
     "@sanity/mutate": "^0.12.4",
     "@sanity/types": "^3.83.0",
     "groq": "3.88.1-typegen-experimental.0",
+    "groq-js": "^1.19.0",
     "lodash-es": "^4.17.21",
     "reselect": "^5.1.1",
     "rxjs": "^7.8.2",
@@ -83,7 +84,6 @@
     "@types/lodash-es": "^4.17.12",
     "@vitest/coverage-v8": "3.1.2",
     "eslint": "^9.22.0",
-    "groq-js": "^1.16.1",
     "prettier": "^3.5.3",
     "rollup-plugin-visualizer": "^5.14.0",
     "typescript": "^5.8.3",

packages/core/src/document/_synchronous-groq-js.mjs

@@ -1,10 +1,9 @@
 import {type SanityDocument} from '@sanity/types'
-import {type ExprNode} from 'groq-js'
+import {evaluateSync, type ExprNode, parse} from 'groq-js'
 import {describe, expect, it} from 'vitest'
 
 import {createSanityInstance} from '../store/createSanityInstance'
 import {getDraftId, getPublishedId} from '../utils/ids'
-import {evaluateSync, parse} from './_synchronous-groq-js.mjs'
 import {type DocumentAction} from './actions'
 import {calculatePermissions, createGrantsLookup, type DatasetAcl, type Grant} from './permissions'
 import {type SyncTransactionState} from './reducers'
@@ -50,7 +49,7 @@ describe('createGrantsLookup', () => {
     ;(['read', 'update', 'create', 'history'] as Grant[]).forEach((key) => {
       expect(grants[key]).toBeDefined()
       // Evaluate the expression for the dummy document.
-      expect(evaluateSync(grants[key], {params: {document: dummyDoc}}).get()).toBe(true)
+      expect(evaluateSync(grants[key], {params: {document: dummyDoc}}).data).toBe(true)
     })
   })
 })

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

@@ -1,11 +1,10 @@
 import {type SanityDocument} from '@sanity/types'
-import {type ExprNode} from 'groq-js'
+import {evaluateSync, type ExprNode, parse} from 'groq-js'
 import {createSelector} from 'reselect'
 
 import {type SelectorContext} from '../store/createStateSourceAction'
 import {getDraftId, getPublishedId} from '../utils/ids'
 import {MultiKeyWeakMap} from '../utils/MultiKeyWeakMap'
-import {evaluateSync, parse} from './_synchronous-groq-js.mjs'
 import {type DocumentAction} from './actions'
 import {ActionError, PermissionActionError, processActions} from './processActions'
 import {type DocumentSet} from './processMutations'
@@ -127,7 +126,8 @@ const memoizedActionsSelector = createSelector(
 )
 
 function checkGrant(grantExpr: ExprNode, document: SanityDocument): boolean {
-  return evaluateSync(grantExpr, {params: {document}}).get()
+  const value = evaluateSync(grantExpr, {params: {document}})
+  return value.type === 'boolean' && value.data
 }
 
 /** @beta */

packages/core/src/document/permissions.ts

@@ -1,7 +1,7 @@
 import {type Reference, type SanityDocument} from '@sanity/types'
+import {parse} from 'groq-js'
 import {describe, expect, it} from 'vitest'
 
-import {parse} from './_synchronous-groq-js.mjs'
 import {type DocumentAction} from './actions'
 import {ActionError, processActions} from './processActions'
 import {type DocumentSet} from './processMutations'

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

@@ -5,18 +5,18 @@ import {
   type Reference,
   type SanityDocument,
 } from '@sanity/types'
-import {type ExprNode} from 'groq-js'
+import {evaluateSync, type ExprNode} from 'groq-js'
 import {isEqual} from 'lodash-es'
 
 import {getDraftId, getPublishedId} from '../utils/ids'
-import {evaluateSync} from './_synchronous-groq-js.mjs'
 import {type DocumentAction} from './actions'
 import {type Grant} from './permissions'
 import {type DocumentSet, getId, processMutations} from './processMutations'
 import {type HttpAction} from './reducers'
 
 function checkGrant(grantExpr: ExprNode, document: SanityDocument): boolean {
-  return evaluateSync(grantExpr, {params: {document}}).get()
+  const value = evaluateSync(grantExpr, {params: {document}})
+  return value.type === 'boolean' && value.data
 }
 
 interface ProcessActionsOptions {

packages/core/src/document/processActions.ts

@@ -85,6 +85,7 @@
     "@vitest/coverage-v8": "3.1.2",
     "babel-plugin-react-compiler": "19.1.0-rc.1",
     "eslint": "^9.22.0",
+    "groq-js": "^1.19.0",
     "jsdom": "^25.0.1",
     "prettier": "^3.5.3",
     "react": "^19.1.0",

packages/react/package.json

@@ -1,8 +1,8 @@
 import {type SanityInstance} from '@sanity/sdk'
 import {act, renderHook} from '@testing-library/react'
+import {evaluateSync, parse, toJS} from 'groq-js'
 import {describe, vi} from 'vitest'
 
-import {evaluateSync, parse} from '../_synchronous-groq-js.mjs'
 import {useSanityInstance} from '../context/useSanityInstance'
 import {useQuery} from '../query/useQuery'
 import {useDocuments} from './useDocuments'
@@ -69,7 +69,7 @@ describe('useDocuments', () => {
     ]
 
     vi.mocked(useQuery).mockImplementation(({query, ...options}) => {
-      const result = evaluateSync(parse(query), {dataset, params: options?.params}).get()
+      const result = toJS(evaluateSync(parse(query), {dataset, params: options?.params}))
       return {
         data: result,
         isPending: false,

packages/react/src/hooks/_synchronous-groq-js.mjs

@@ -1,8 +1,8 @@
 import {act, renderHook} from '@testing-library/react'
+import {evaluateSync, parse, toJS} from 'groq-js'
 import {describe, vi} from 'vitest'
 
 import {ResourceProvider} from '../../context/ResourceProvider'
-import {evaluateSync, parse} from '../_synchronous-groq-js.mjs'
 import {useQuery} from '../query/useQuery'
 import {usePaginatedDocuments} from './usePaginatedDocuments'
 
@@ -73,7 +73,7 @@ describe('usePaginatedDocuments', () => {
     ]
 
     vi.mocked(useQuery).mockImplementation(({query, ...options}) => {
-      const result = evaluateSync(parse(query), {dataset, params: options?.params}).get()
+      const result = toJS(evaluateSync(parse(query), {dataset, params: options?.params}))
       return {
         data: result,
         isPending: false,