feat(core): full JSONMatch support w/ path helpers (#573)

Author: ricokahler

packages/core/package.json

@@ -60,6 +60,7 @@
     "@sanity/comlink": "^3.0.4",
     "@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/mutate": "^0.12.4",
     "@sanity/types": "^3.83.0",

packages/core/src/_exports/index.ts

@@ -100,7 +100,7 @@ export {
   type TransactionAcceptedEvent,
   type TransactionRevertedEvent,
 } from '../document/events'
-export {type JsonMatch, jsonMatch} from '../document/patchOperations'
+export {type JsonMatch} from '../document/patchOperations'
 export {type DocumentPermissionsResult, type PermissionDeniedReason} from '../document/permissions'
 export type {FavoriteStatusResponse} from '../favorites/favorites'
 export {getFavoritesState, resolveFavoritesState} from '../favorites/favorites'
@@ -137,4 +137,12 @@ export {getUsersState, loadMoreUsers, resolveUsers} from '../users/usersStore'
 export {type FetcherStore, type FetcherStoreState} from '../utils/createFetcherStore'
 export {createGroqSearchFilter} from '../utils/createGroqSearchFilter'
 export {CORE_SDK_VERSION} from '../version'
+export {
+  getIndexForKey,
+  getPathDepth,
+  joinPaths,
+  jsonMatch,
+  slicePath,
+  stringifyPath,
+} from '@sanity/json-match'
 export type {CurrentUser, Role, SanityDocument} from '@sanity/types'

packages/core/src/document/documentStore.ts

@@ -1,5 +1,6 @@
 import {type Action} from '@sanity/client'
 import {getPublishedId} from '@sanity/client/csm'
+import {jsonMatch} from '@sanity/json-match'
 import {type SanityDocument} from 'groq'
 import {type ExprNode} from 'groq-js'
 import {
@@ -36,7 +37,7 @@ import {type DocumentAction} from './actions'
 import {API_VERSION, INITIAL_OUTGOING_THROTTLE_TIME} from './documentConstants'
 import {type DocumentEvent, getDocumentEvents} from './events'
 import {listen, OutOfSyncError} from './listen'
-import {type JsonMatch, jsonMatch} from './patchOperations'
+import {type JsonMatch} from './patchOperations'
 import {calculatePermissions, createGrantsLookup, type DatasetAcl, type Grant} from './permissions'
 import {ActionError} from './processActions'
 import {
@@ -192,8 +193,11 @@ const _getDocumentState = bindActionByDataset(
       // wait for draft and published to be loaded before returning a value
       if (draft === undefined || published === undefined) return undefined
       const document = draft ?? published
-      if (path) return jsonMatch(document, path).at(0)?.value
-      return document
+      if (!path) return document
+      const result = jsonMatch(document, path).next()
+      if (result.done) return undefined
+      const {value} = result.value
+      return value
     },
     onSubscribe: (context, options: DocumentOptions<string | undefined>) =>
       manageSubscriberIds(context, options.documentId),