feat(views): implement dev mode

src/SanityClient.ts

@@ -318,7 +318,13 @@ export class ObservableSanityClient {
   ): Observable<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    return dataMethods._create<R>(this.#clientConfig, this.#httpRequest, document, 'create', options)
+    return dataMethods._create<R>(
+      this.#clientConfig,
+      this.#httpRequest,
+      document,
+      'create',
+      options,
+    )
   }
 
   /**
@@ -387,7 +393,12 @@ export class ObservableSanityClient {
   ): Observable<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    return dataMethods._createIfNotExists<R>(this.#clientConfig, this.#httpRequest, document, options)
+    return dataMethods._createIfNotExists<R>(
+      this.#clientConfig,
+      this.#httpRequest,
+      document,
+      options,
+    )
   }
 
   /**
@@ -726,7 +737,13 @@ export class ObservableSanityClient {
   ): Observable<SingleActionResult | MultipleActionResult> {
     const documentVersionId = getDocumentVersionId(publishedId, releaseId)
 
-    return dataMethods._discardVersion(this.config(), this.#httpRequest, documentVersionId, purge, options)
+    return dataMethods._discardVersion(
+      this.config(),
+      this.#httpRequest,
+      documentVersionId,
+      purge,
+      options,
+    )
   }
 
   /**
@@ -830,7 +847,12 @@ export class ObservableSanityClient {
 
     const documentVersion = {...document, _id: documentVersionId}
 
-    return dataMethods._replaceVersion<R>(this.config(), this.#httpRequest, documentVersion, options)
+    return dataMethods._replaceVersion<R>(
+      this.config(),
+      this.#httpRequest,
+      documentVersion,
+      options,
+    )
   }
 
   /**
@@ -860,7 +882,13 @@ export class ObservableSanityClient {
   ): Observable<SingleActionResult | MultipleActionResult> {
     const versionId = getVersionId(publishedId, releaseId)
 
-    return dataMethods._unpublishVersion(this.config(), this.#httpRequest, versionId, publishedId, options)
+    return dataMethods._unpublishVersion(
+      this.config(),
+      this.#httpRequest,
+      versionId,
+      publishedId,
+      options,
+    )
   }
 
   /**
@@ -1208,7 +1236,9 @@ export class SanityClient {
     id: string,
     options?: {signal?: AbortSignal; tag?: string; releaseId?: string},
   ): Promise<SanityDocument<R> | undefined> {
-    return lastValueFrom(dataMethods._getDocument<R>(this.#clientConfig, this.#httpRequest, id, options))
+    return lastValueFrom(
+      dataMethods._getDocument<R>(this.#clientConfig, this.#httpRequest, id, options),
+    )
   }
 
   /**
@@ -1224,7 +1254,9 @@ export class SanityClient {
     ids: string[],
     options?: {signal?: AbortSignal; tag?: string},
   ): Promise<(SanityDocument<R> | null)[]> {
-    return lastValueFrom(dataMethods._getDocuments<R>(this.#clientConfig, this.#httpRequest, ids, options))
+    return lastValueFrom(
+      dataMethods._getDocuments<R>(this.#clientConfig, this.#httpRequest, ids, options),
+    )
   }
 
   /**
@@ -1671,7 +1703,9 @@ export class SanityClient {
   ): Promise<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    return lastValueFrom(dataMethods._delete<R>(this.#clientConfig, this.#httpRequest, selection, options))
+    return lastValueFrom(
+      dataMethods._delete<R>(this.#clientConfig, this.#httpRequest, selection, options),
+    )
   }
 
   /**
@@ -1710,7 +1744,13 @@ export class SanityClient {
     const documentVersionId = getDocumentVersionId(publishedId, releaseId)
 
     return lastValueFrom(
-      dataMethods._discardVersion(this.config(), this.#httpRequest, documentVersionId, purge, options),
+      dataMethods._discardVersion(
+        this.config(),
+        this.#httpRequest,
+        documentVersionId,
+        purge,
+        options,
+      ),
     )
   }
 
@@ -1849,7 +1889,13 @@ export class SanityClient {
     const versionId = getVersionId(publishedId, releaseId)
 
     return lastValueFrom(
-      dataMethods._unpublishVersion(this.config(), this.#httpRequest, versionId, publishedId, options),
+      dataMethods._unpublishVersion(
+        this.config(),
+        this.#httpRequest,
+        versionId,
+        publishedId,
+        options,
+      ),
     )
   }
 
@@ -1919,7 +1965,9 @@ export class SanityClient {
   ): Promise<
     SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
   > {
-    return lastValueFrom(dataMethods._mutate<R>(this.#clientConfig, this.#httpRequest, operations, options))
+    return lastValueFrom(
+      dataMethods._mutate<R>(this.#clientConfig, this.#httpRequest, operations, options),
+    )
   }
 
   /**
@@ -1982,7 +2030,9 @@ export class SanityClient {
     operations: Action | Action[],
     options?: BaseActionOptions,
   ): Promise<SingleActionResult | MultipleActionResult> {
-    return lastValueFrom(dataMethods._action(this.#clientConfig, this.#httpRequest, operations, options))
+    return lastValueFrom(
+      dataMethods._action(this.#clientConfig, this.#httpRequest, operations, options),
+    )
   }
 
   /**
@@ -2007,7 +2057,9 @@ export class SanityClient {
    * @internal
    */
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<Any> {
-    return lastValueFrom(dataMethods._dataRequest(this.#clientConfig, this.#httpRequest, endpoint, body, options))
+    return lastValueFrom(
+      dataMethods._dataRequest(this.#clientConfig, this.#httpRequest, endpoint, body, options),
+    )
   }
 
   /**

src/config.ts

@@ -154,7 +154,9 @@ export const initConfig = (
   const protocol = hostParts[0]
   const host = hostParts[1]
 
-  const cdnURL = newConfig.isDefaultApi ? `https://${defaultCdnHost}` : newConfig.apiCdnHost || newConfig.apiHost
+  const cdnURL = newConfig.isDefaultApi
+    ? `https://${defaultCdnHost}`
+    : newConfig.apiCdnHost || newConfig.apiHost
   const cdnURLParts = cdnURL.split('://', 2)
   const cdnProtocol = cdnURLParts[0]
   const cdnHost = cdnURLParts[1]

src/data/dataMethods.ts

@@ -90,12 +90,19 @@ export function _fetch<R, Q>(
   const mapResponse =
     options.filterResponse === false ? (res: Any) => res : (res: Any) => res.result
 
-  const {cache, next, ...opts} = {
+  const {cache, next, useEmulate, connections, ...opts} = {
     // Opt out of setting a `signal` on an internal `fetch` if one isn't provided.
     // This is necessary in React Server Components to avoid opting out of Request Memoization.
     useAbortSignal: typeof options.signal !== 'undefined',
     // Set `resultSourceMap' when stega is enabled, as it's required for encoding.
     resultSourceMap: stega.enabled ? 'withKeyArraySelector' : options.resultSourceMap,
+
+    // Only use emulate if explicitly asked for
+    useEmulate: false,
+
+    // Having connections is a special case for views
+    connections: undefined,
+
     ...options,
     // Default to not returning the query, unless `filterResponse` is `false`,
     // or `returnQuery` is explicitly set. `true` is the default in Content Lake, so skip if truthy
@@ -106,7 +113,17 @@ export function _fetch<R, Q>(
       ? {...opts, fetch: {cache, next}}
       : opts
 
-  const $request = _dataRequest(config, httpRequest, 'query', {query, params}, reqOpts)
+  // Use 'emulate' endpoint for view emulation, otherwise use 'query'
+  const endpoint = useEmulate ? 'emulate' : 'query'
+  const requestBody = useEmulate
+    ? {
+        query,
+        params,
+        connections: connections,
+      }
+    : {query, params}
+
+  const $request = _dataRequest(config, httpRequest, endpoint, requestBody, reqOpts)
   return stega.enabled
     ? $request.pipe(
         combineLatestWith(
@@ -413,11 +430,13 @@ export function _dataRequest(
   const isMutation = endpoint === 'mutate'
   const isAction = endpoint === 'actions'
   const isQuery = endpoint === 'query'
+  const isEmulate = endpoint === 'emulate'
 
   // Check if the query string is within a configured threshold,
   // in which case we can use GET. Otherwise, use POST.
-  const strQuery = isMutation || isAction ? '' : encodeQueryString(body)
-  const useGet = !isMutation && !isAction && strQuery.length < getQuerySizeLimit
+  // Emulate endpoint always uses POST
+  const strQuery = isMutation || isAction || isEmulate ? '' : encodeQueryString(body)
+  const useGet = !isMutation && !isAction && !isEmulate && strQuery.length < getQuerySizeLimit
   const stringQuery = useGet ? strQuery : ''
   const returnFirst = options.returnFirst
   const {timeout, token, tag, headers, returnQuery, lastLiveEventId, cacheMode} = options
@@ -501,6 +520,9 @@ const isQuery = (config: InitializedClientConfig, uri: string) =>
 const isViewQuery = (config: InitializedClientConfig, uri: string) =>
   hasDataConfig(config) && uri.startsWith(_getDataUrl(config, 'views'))
 
+const isEmulate = (config: InitializedClientConfig, uri: string) =>
+  hasDataConfig(config) && uri.startsWith(_getDataUrl(config, 'emulate'))
+
 const isMutate = (config: InitializedClientConfig, uri: string) =>
   hasDataConfig(config) && uri.startsWith(_getDataUrl(config, 'mutate'))
 
@@ -520,7 +542,8 @@ const isData = (config: InitializedClientConfig, uri: string) =>
   isDoc(config, uri) ||
   isListener(config, uri) ||
   isHistory(config, uri) ||
-  isViewQuery(config, uri)
+  isViewQuery(config, uri) ||
+  isEmulate(config, uri)
 
 /**
  * @internal
@@ -549,8 +572,11 @@ export function _requestObservable<R>(
     options.query = {tag: validate.requestTag(tag), ...options.query}
   }
 
-  // GROQ query-only parameters
-  if (['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 && isQuery(config, uri)) {
+  // GROQ query-only parameters (applies to both query and emulate endpoints)
+  if (
+    ['GET', 'HEAD', 'POST'].indexOf(options.method || 'GET') >= 0 &&
+    (isQuery(config, uri) || isEmulate(config, uri))
+  ) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap
     if (resultSourceMap !== undefined && resultSourceMap !== false) {
       options.query = {resultSourceMap, ...options.query}
@@ -610,7 +636,11 @@ export function _requestObservable<R>(
 /**
  * @internal
  */
-export function _request<R>(config: InitializedClientConfig, httpRequest: HttpRequest, options: Any): Observable<R> {
+export function _request<R>(
+  config: InitializedClientConfig,
+  httpRequest: HttpRequest,
+  options: Any,
+): Observable<R> {
   const observable = _requestObservable<R>(config, httpRequest, options).pipe(
     filter((event: Any) => event.type === 'response'),
     map((event: Any) => event.body),
@@ -622,7 +652,11 @@ export function _request<R>(config: InitializedClientConfig, httpRequest: HttpRe
 /**
  * @internal
  */
-export function _getDataUrl(config: InitializedClientConfig, operation: string, path?: string): string {
+export function _getDataUrl(
+  config: InitializedClientConfig,
+  operation: string,
+  path?: string,
+): string {
   if (config['~experimental_resource']) {
     validators.resourceConfig(config)
     const resourceBase = resourceDataBase(config)
@@ -638,7 +672,7 @@ export function _getDataUrl(config: InitializedClientConfig, operation: string,
 /**
  * @internal
  */
-export function _getUrl(config: InitializedClientConfig, uri: string, canUseCdn = false, options: {forceApiUrl?: boolean} = {}): string {
+export function _getUrl(config: InitializedClientConfig, uri: string, canUseCdn = false): string {
   const {url, cdnUrl} = config
   const base = canUseCdn ? cdnUrl : url
   return `${base}/${uri.replace(/^\//, '')}`

src/datasets/DatasetsClient.ts

@@ -105,7 +105,10 @@ export class DatasetsClient {
   list(): Promise<DatasetsResponse> {
     validate.resourceGuard('dataset', this.#client.config())
     return lastValueFrom(
-      _request<DatasetsResponse>(this.#client.config(), this.#httpRequest, {uri: '/datasets', tag: null}),
+      _request<DatasetsResponse>(this.#client.config(), this.#httpRequest, {
+        uri: '/datasets',
+        tag: null,
+      }),
     )
   }
 }

src/projects/ProjectsClient.ts

@@ -37,7 +37,9 @@ export class ObservableProjectsClient {
    */
   getById(projectId: string): Observable<SanityProject> {
     validate.resourceGuard('projects', this.#client.config())
-    return _request<SanityProject>(this.#client.config(), this.#httpRequest, {uri: `/projects/${projectId}`})
+    return _request<SanityProject>(this.#client.config(), this.#httpRequest, {
+      uri: `/projects/${projectId}`,
+    })
   }
 }
 
@@ -72,7 +74,9 @@ export class ProjectsClient {
   getById(projectId: string): Promise<SanityProject> {
     validate.resourceGuard('projects', this.#client.config())
     return lastValueFrom(
-      _request<SanityProject>(this.#client.config(), this.#httpRequest, {uri: `/projects/${projectId}`}),
+      _request<SanityProject>(this.#client.config(), this.#httpRequest, {
+        uri: `/projects/${projectId}`,
+      }),
     )
   }
 }

src/releases/ReleasesClient.ts

@@ -582,7 +582,9 @@ export class ReleasesClient {
       releaseId,
     }
 
-    return lastValueFrom(_action(this.#client.config(), this.#httpRequest, unarchiveAction, options))
+    return lastValueFrom(
+      _action(this.#client.config(), this.#httpRequest, unarchiveAction, options),
+    )
   }
 
   /**
@@ -638,7 +640,9 @@ export class ReleasesClient {
       releaseId,
     }
 
-    return lastValueFrom(_action(this.#client.config(), this.#httpRequest, unscheduleAction, options))
+    return lastValueFrom(
+      _action(this.#client.config(), this.#httpRequest, unscheduleAction, options),
+    )
   }
 
   /**
@@ -682,6 +686,8 @@ export class ReleasesClient {
     {releaseId}: {releaseId: string},
     options?: BaseMutationOptions,
   ): Promise<RawQueryResponse<SanityDocument[]>> {
-    return lastValueFrom(_getReleaseDocuments(this.#client.config(), this.#httpRequest, releaseId, options))
+    return lastValueFrom(
+      _getReleaseDocuments(this.#client.config(), this.#httpRequest, releaseId, options),
+    )
   }
 }