@sanity/client 6.13.2 → 6.14.0

package/src/data/dataMethods.ts

@@ -80,6 +80,7 @@ export function _fetch<R, Q>(
   const params = stega.enabled ? vercelStegaCleanAll(_params) : _params
   const mapResponse =
     options.filterResponse === false ? (res: Any) => res : (res: Any) => res.result
+
   const {cache, next, ...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.
@@ -87,6 +88,9 @@ export function _fetch<R, Q>(
     // Set `resultSourceMap' when stega is enabled, as it's required for encoding.
     resultSourceMap: stega.enabled ? 'withKeyArraySelector' : options.resultSourceMap,
     ...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
+    returnQuery: options.filterResponse === false && options.returnQuery !== false,
   }
   const reqOpts =
     typeof cache !== 'undefined' || typeof next !== 'undefined'
@@ -253,7 +257,7 @@ export function _dataRequest(
   const useGet = !isMutation && strQuery.length < getQuerySizeLimit
   const stringQuery = useGet ? strQuery : ''
   const returnFirst = options.returnFirst
-  const {timeout, token, tag, headers} = options
+  const {timeout, token, tag, headers, returnQuery} = options
 
   const uri = _getDataUrl(client, endpoint, stringQuery)
 
@@ -267,6 +271,7 @@ export function _dataRequest(
     headers,
     token,
     tag,
+    returnQuery,
     perspective: options.perspective,
     resultSourceMap: options.resultSourceMap,
     canUseCdn: isQuery,
@@ -369,6 +374,10 @@ export function _requestObservable<R>(
         printCdnPreviewDraftsWarning()
       }
     }
+
+    if (options.returnQuery === false) {
+      options.query = {returnQuery: 'false', ...options.query}
+    }
   }
 
   const reqOptions = requestOptions(

package/src/data/encodeQueryString.ts

@@ -11,7 +11,7 @@ export const encodeQueryString = ({
 }) => {
   const searchParams = new URLSearchParams()
   // We generally want tag at the start of the query string
-  const {tag, ...opts} = options
+  const {tag, returnQuery, ...opts} = options
   // We're using `append` instead of `set` to support React Native: https://github.com/facebook/react-native/blob/1982c4722fcc51aa87e34cf562672ee4aff540f1/packages/react-native/Libraries/Blob/URL.js#L86-L88
   if (tag) searchParams.append('tag', tag)
   searchParams.append('query', query)
@@ -26,5 +26,8 @@ export const encodeQueryString = ({
     if (value) searchParams.append(key, `${value}`)
   }
 
+  // `returnQuery` is default `true`, so needs an explicit `false` handling
+  if (returnQuery === false) searchParams.append('returnQuery', 'false')
+
   return `?${searchParams}`
 }

package/src/stega/stegaEncodeSourceMap.ts

@@ -84,7 +84,7 @@ export function stegaEncodeSourceMap<Result = unknown>(
           : config.studioUrl!,
       )
       if (!baseUrl) return value
-      const {_id: id, _type: type} = sourceDocument
+      const {_id: id, _type: type, _projectId: projectId, _dataset: dataset} = sourceDocument
 
       return vercelStegaCombine(
         value,
@@ -97,6 +97,7 @@ export function stegaEncodeSourceMap<Result = unknown>(
             id,
             type,
             path: sourcePath,
+            ...(!config.omitCrossDatasetReferenceData && {dataset, projectId}),
           }),
         },
         // We use custom logic to determine if we should skip encoding

package/src/stega/types.ts

@@ -50,6 +50,10 @@ export interface StegaConfig {
    * Specify a `console.log` compatible logger to see debug logs, which keys are encoded and which are not.
    */
   logger?: Logger
+  /**
+   * Set to `true` to omit cross dataset reference specific data from encoded strings
+   */
+  omitCrossDatasetReferenceData?: boolean
 }
 
 /** @public */

package/src/types.ts

@@ -300,6 +300,7 @@ export interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   canUseCdn?: boolean
   useCdn?: boolean
   tag?: string
+  returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
 }
@@ -452,6 +453,8 @@ export interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  returnQuery?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   signal?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   stega?: never
@@ -721,6 +724,7 @@ export interface ListenOptions {
 export interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
   resultSourceMap?: boolean | 'withKeyArraySelector'
+  returnQuery?: boolean
   useCdn?: boolean
   stega?: boolean | StegaConfig
   // The `cache` and `next` options are specific to the Next.js App Router integration
@@ -736,10 +740,31 @@ export interface FilteredResponseQueryOptions extends ResponseQueryOptions {
 /** @public */
 export interface UnfilteredResponseQueryOptions extends ResponseQueryOptions {
   filterResponse: false
+
+  /**
+   * When `filterResponse` is `false`, `returnQuery` also defaults to `true` for
+   * backwards compatibility (on the client side, not from the content lake API).
+   * Can also explicitly be set to `true`.
+   */
+  returnQuery?: true
+}
+
+/**
+ * When using `filterResponse: false`, but you do not wish to receive back the query from
+ * the content lake API.
+ *
+ * @public
+ */
+export interface UnfilteredResponseWithoutQuery extends ResponseQueryOptions {
+  filterResponse: false
+  returnQuery: false
 }
 
 /** @public */
-export type QueryOptions = FilteredResponseQueryOptions | UnfilteredResponseQueryOptions
+export type QueryOptions =
+  | FilteredResponseQueryOptions
+  | UnfilteredResponseQueryOptions
+  | UnfilteredResponseWithoutQuery
 
 /** @public */
 export interface RawQueryResponse<R> {
@@ -749,6 +774,9 @@ export interface RawQueryResponse<R> {
   resultSourceMap?: ContentSourceMap
 }
 
+/** @public */
+export type RawQuerylessQueryResponse<R> = Omit<RawQueryResponse<R>, 'query'>
+
 /** @internal */
 export type BaseMutationOptions = RequestOptions & {
   visibility?: 'sync' | 'async' | 'deferred'

package/umd/sanityClient.js

@@ -3409,7 +3409,7 @@
     options = {}
   }) => {
     const searchParams = new URLSearchParams();
-    const { tag, ...opts } = options;
+    const { tag, returnQuery, ...opts } = options;
     if (tag)
       searchParams.append("tag", tag);
     searchParams.append("query", query);
@@ -3420,6 +3420,8 @@
       if (value)
         searchParams.append(key, "".concat(value));
     }
+    if (returnQuery === false)
+      searchParams.append("returnQuery", "false");
     return "?".concat(searchParams);
   };
 
@@ -3457,14 +3459,17 @@
       useAbortSignal: typeof options.signal !== "undefined",
       // Set `resultSourceMap' when stega is enabled, as it's required for encoding.
       resultSourceMap: stega.enabled ? "withKeyArraySelector" : options.resultSourceMap,
-      ...options
+      ...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
+      returnQuery: options.filterResponse === false && options.returnQuery !== false
     };
     const reqOpts = typeof cache !== "undefined" || typeof next !== "undefined" ? { ...opts, fetch: { cache, next } } : opts;
     const $request = _dataRequest(client, httpRequest, "query", { query, params }, reqOpts);
     return stega.enabled ? $request.pipe(
       combineLatestWith(
         from(
-          Promise.resolve().then(function () { return stegaEncodeSourceMapBfR5oD3Z; }).then(function (n) { return n.stegaEncodeSourceMap$1; }).then(
+          Promise.resolve().then(function () { return stegaEncodeSourceMapB6IscnhR; }).then(function (n) { return n.stegaEncodeSourceMap$1; }).then(
             ({ stegaEncodeSourceMap }) => stegaEncodeSourceMap
           )
         )
@@ -3531,7 +3536,7 @@
     const useGet = !isMutation && strQuery.length < getQuerySizeLimit;
     const stringQuery = useGet ? strQuery : "";
     const returnFirst = options.returnFirst;
-    const { timeout, token, tag, headers } = options;
+    const { timeout, token, tag, headers, returnQuery } = options;
     const uri = _getDataUrl(client, endpoint, stringQuery);
     const reqOptions = {
       method: useGet ? "GET" : "POST",
@@ -3543,6 +3548,7 @@
       headers,
       token,
       tag,
+      returnQuery,
       perspective: options.perspective,
       resultSourceMap: options.resultSourceMap,
       canUseCdn: isQuery,
@@ -3601,6 +3607,9 @@
           printCdnPreviewDraftsWarning();
         }
       }
+      if (options.returnQuery === false) {
+        options.query = { returnQuery: "false", ...options.query };
+      }
     }
     const reqOptions = requestOptions(
       config,
@@ -4743,7 +4752,9 @@
       tool: _tool = "default",
       id: _id,
       type,
-      path
+      path,
+      projectId,
+      dataset
     } = options;
     if (!baseUrl) {
       throw new Error("baseUrl is required");
@@ -4773,6 +4784,12 @@
     if (tool) {
       searchParams.set("tool", tool);
     }
+    if (projectId) {
+      searchParams.set("projectId", projectId);
+    }
+    if (dataset) {
+      searchParams.set("dataset", dataset);
+    }
     const segments = [baseUrl === "/" ? "" : baseUrl];
     if (workspace) {
       segments.push(workspace);
@@ -4935,7 +4952,7 @@
         );
         if (!baseUrl)
           return value;
-        const { _id: id, _type: type } = sourceDocument;
+        const { _id: id, _type: type, _projectId: projectId, _dataset: dataset } = sourceDocument;
         return b(
           value,
           {
@@ -4946,7 +4963,8 @@
               tool,
               id,
               type,
-              path: sourcePath
+              path: sourcePath,
+              ...!config.omitCrossDatasetReferenceData && { dataset, projectId }
             })
           },
           // We use custom logic to determine if we should skip encoding
@@ -4990,7 +5008,7 @@
     stegaEncodeSourceMap: stegaEncodeSourceMap
   });
 
-  var stegaEncodeSourceMapBfR5oD3Z = /*#__PURE__*/Object.freeze({
+  var stegaEncodeSourceMapB6IscnhR = /*#__PURE__*/Object.freeze({
     __proto__: null,
     encodeIntoResult: encodeIntoResult,
     stegaEncodeSourceMap: stegaEncodeSourceMap,