feat: add support for requestTagPrefix

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/groq-store",
-  "version": "2.2.2",
+  "version": "2.2.3-0",
   "description": "Stream dataset to memory for in-memory querying",
   "keywords": [
     "sanity",

src/browser/getDocuments.ts

@@ -10,17 +10,22 @@ export const getDocuments: EnvImplementations['getDocuments'] = async function g
   token,
   documentLimit,
   includeTypes = [],
+  requestTagPrefix,
 }: {
   projectId: string
   dataset: string
   token?: string
   documentLimit?: number
   includeTypes?: string[]
+  requestTagPrefix?: string
 }): Promise<SanityDocument[]> {
-  const baseUrl = `https://${projectId}.api.sanity.io/v1/data/export/${dataset}`
-  const params =
-    includeTypes.length > 0 ? new URLSearchParams({types: includeTypes?.join(',')}) : ''
-  const url = `${baseUrl}?${params}`
+  const url = new URL(`https://${projectId}.api.sanity.io/v1/data/export/${dataset}`)
+  if (requestTagPrefix) {
+    url.searchParams.set('tag', requestTagPrefix)
+  }
+  if (includeTypes.length > 0) {
+    url.searchParams.set('types', includeTypes?.join(','))
+  }
   const headers = token ? {Authorization: `Bearer ${token}`} : undefined
   const response = await fetch(url, {credentials: 'include', headers})
 

src/listen.ts

@@ -43,21 +43,24 @@ const addEventSourceListener = (
 const encodeQueryString = ({
   query,
   params = {},
-  options = {effectFormat: 'mendoza'},
+  options = {},
 }: {
   query: string
   params?: Record<string, unknown>
   options?: Record<string, unknown>
 }) => {
   const searchParams = new URLSearchParams()
+  // We generally want tag at the start of the query string
+  const {tag, ...opts} = options
+  if (tag) searchParams.set('tag', tag as string)
   searchParams.set('query', query)
 
   // Iterate params, the keys are prefixed with `$` and their values JSON stringified
   for (const [key, value] of Object.entries(params)) {
     searchParams.set(`$${key}`, JSON.stringify(value))
   }
   // Options are passed as-is
-  for (const [key, value] of Object.entries(options)) {
+  for (const [key, value] of Object.entries(opts)) {
     // Skip falsy values
     if (value) searchParams.set(key, `${value}`)
   }
@@ -74,14 +77,21 @@ export function listen(
     next: (event: MutationEvent) => void
   }
 ): Subscription {
-  const {projectId, dataset, token, includeTypes} = config
+  const {projectId, dataset, token, includeTypes, requestTagPrefix} = config
   const headers = token ? {Authorization: `Bearer ${token}`} : undefined
 
   // Make sure we only listen to mutations on documents part of the `includeTypes` allowlist, if provided
+  const options = requestTagPrefix
+    ? {tag: requestTagPrefix, effectFormat: 'mendoza'}
+    : {effectFormat: 'mendoza'}
   const searchParams = encodeQueryString(
     Array.isArray(includeTypes) && includeTypes.length > 0
-      ? {query: `*[_type in $includeTypes]`, params: {includeTypes}}
-      : {query: '*'}
+      ? {
+          query: `*[_type in $includeTypes]`,
+          params: {includeTypes},
+          options,
+        }
+      : {query: '*', options}
   )
   const url = `https://${projectId}.api.sanity.io/v1/data/listen/${dataset}${searchParams}`
   const es = new EventSourceImpl(url, {withCredentials: true, headers})

src/node/getDocuments.ts

@@ -10,17 +10,23 @@ export const getDocuments: EnvImplementations['getDocuments'] = function getDocu
   token,
   documentLimit,
   includeTypes = [],
+  requestTagPrefix,
 }: {
   projectId: string
   dataset: string
   token?: string
   documentLimit?: number
   includeTypes?: string[]
+  requestTagPrefix?: string
 }): Promise<SanityDocument[]> {
-  const baseUrl = `https://${projectId}.api.sanity.io/v1/data/export/${dataset}`
-  const params =
-    includeTypes.length > 0 ? new URLSearchParams({types: includeTypes?.join(',')}) : ''
-  const url = `${baseUrl}?${params}`
+  const baseUrl = new URL(`https://${projectId}.api.sanity.io/v1/data/export/${dataset}`)
+  if (requestTagPrefix) {
+    baseUrl.searchParams.set('tag', requestTagPrefix)
+  }
+  if (includeTypes.length > 0) {
+    baseUrl.searchParams.set('types', includeTypes?.join(','))
+  }
+  const url = baseUrl.toString()
   const headers = token ? {Authorization: `Bearer ${token}`} : undefined
 
   return new Promise((resolve, reject) => {

src/syncingDataset.ts

@@ -24,6 +24,7 @@ export function getSyncingDataset(
     documentLimit,
     token,
     includeTypes,
+    requestTagPrefix,
   } = config
 
   // We don't want to flush updates while we're in the same transaction, so a normal
@@ -44,7 +45,14 @@ export function getSyncingDataset(
   }
 
   if (!useListener) {
-    const loaded = getDocuments({projectId, dataset, documentLimit, token, includeTypes})
+    const loaded = getDocuments({
+      projectId,
+      dataset,
+      documentLimit,
+      token,
+      includeTypes,
+      requestTagPrefix,
+    })
       .then(onUpdate)
       .then(noop)
     return {unsubscribe: noop, loaded}
@@ -67,7 +75,14 @@ export function getSyncingDataset(
   })
 
   const onOpen = async () => {
-    const initial = await getDocuments({projectId, dataset, documentLimit, token, includeTypes})
+    const initial = await getDocuments({
+      projectId,
+      dataset,
+      documentLimit,
+      token,
+      includeTypes,
+      requestTagPrefix,
+    })
     documents = applyBufferedMutations(initial, buffer)
     documents.forEach((doc) => indexedDocuments.set(doc._id, doc))
     onUpdate(documents)

src/types.ts

@@ -34,7 +34,10 @@ export interface GroqSubscription {
 export interface EnvImplementations {
   EventSource: typeof NodeEventSource | typeof BrowserEventSource | typeof window.EventSource
   getDocuments: (
-    options: Pick<Config, 'projectId' | 'dataset' | 'token' | 'documentLimit' | 'includeTypes'>
+    options: Pick<
+      Config,
+      'projectId' | 'dataset' | 'token' | 'documentLimit' | 'includeTypes' | 'requestTagPrefix'
+    >
   ) => Promise<SanityDocument[]>
 }
 
@@ -77,6 +80,7 @@ export interface Config {
    * @example ['page', 'product', 'sanity.imageAsset']
    */
   includeTypes?: string[]
+  requestTagPrefix?: string
 }
 
 /** @public */