@sanity/client 6.12.4 → 6.13.0

package/dist/index.d.ts

@@ -1169,6 +1169,18 @@ export declare class ObservableSanityClient {
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
   ): Observable<RawQueryResponse<R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+    query: string,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Observable<RawQuerylessQueryResponse<R>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -1756,7 +1768,10 @@ export declare class ProjectsClient {
 }
 
 /** @public */
-export declare type QueryOptions = FilteredResponseQueryOptions | UnfilteredResponseQueryOptions
+export declare type QueryOptions =
+  | FilteredResponseQueryOptions
+  | UnfilteredResponseQueryOptions
+  | UnfilteredResponseWithoutQuery
 
 /** @public */
 export declare interface QueryParams {
@@ -1780,6 +1795,8 @@ export declare 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
@@ -1799,6 +1816,9 @@ export declare interface QueryParams {
  */
 export declare type QueryWithoutParams = Record<string, never> | undefined
 
+/** @public */
+export declare type RawQuerylessQueryResponse<R> = Omit<RawQueryResponse<R>, 'query'>
+
 /** @public */
 export declare interface RawQueryResponse<R> {
   query: string
@@ -1884,6 +1904,7 @@ export declare interface ResponseEvent<T = unknown> {
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
   resultSourceMap?: boolean | 'withKeyArraySelector'
+  returnQuery?: boolean
   useCdn?: boolean
   stega?: boolean | StegaConfig
   cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
@@ -1970,6 +1991,18 @@ export declare class SanityClient {
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
   ): Promise<RawQueryResponse<R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+    query: string,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Promise<RawQuerylessQueryResponse<R>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -2657,6 +2690,23 @@ export declare type TransactionMutationOptions =
 /** @public */
 export declare 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 declare interface UnfilteredResponseWithoutQuery extends ResponseQueryOptions {
+  filterResponse: false
+  returnQuery: false
 }
 
 export {unstable__adapter}

package/dist/index.js

@@ -1,5 +1,5 @@
-import { printNoDefaultExport, defineCreateClientExports, SanityClient, middleware } from './_chunks/nodeMiddleware-scsxYdRh.js';
-export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableSanityClient, ObservableTransaction, Patch, ServerError, Transaction } from './_chunks/nodeMiddleware-scsxYdRh.js';
+import { printNoDefaultExport, defineCreateClientExports, SanityClient, middleware } from './_chunks/nodeMiddleware-BN5UYAym.js';
+export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableSanityClient, ObservableTransaction, Patch, ServerError, Transaction } from './_chunks/nodeMiddleware-BN5UYAym.js';
 export { adapter as unstable__adapter, environment as unstable__environment } from 'get-it';
 
 function defineDeprecatedCreateClient(createClient) {

package/dist/stega.browser.cjs

@@ -2,9 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var browserMiddleware = require('./_chunks/browserMiddleware-dqqEd6vl.cjs');
+var browserMiddleware = require('./_chunks/browserMiddleware-Dp4wx9CK.cjs');
 var getIt = require('get-it');
-var stegaEncodeSourceMap = require('./_chunks/stegaEncodeSourceMap-oPlkdofZ.cjs');
+var stegaEncodeSourceMap = require('./_chunks/stegaEncodeSourceMap-DGdRCWlF.cjs');
 
 class SanityStegaClient extends browserMiddleware.SanityClient {
 }

package/dist/stega.browser.js

@@ -1,7 +1,7 @@
-import { SanityClient, ObservableSanityClient, defineCreateClientExports, envMiddleware } from './_chunks/browserMiddleware-FL0Mlm8l.js';
-export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableTransaction, Patch, ServerError, Transaction, vercelStegaCleanAll } from './_chunks/browserMiddleware-FL0Mlm8l.js';
+import { SanityClient, ObservableSanityClient, defineCreateClientExports, envMiddleware } from './_chunks/browserMiddleware-Cfl3LrrI.js';
+export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableTransaction, Patch, ServerError, Transaction, vercelStegaCleanAll } from './_chunks/browserMiddleware-Cfl3LrrI.js';
 export { adapter as unstable__adapter, environment as unstable__environment } from 'get-it';
-export { encodeIntoResult, stegaEncodeSourceMap } from './_chunks/stegaEncodeSourceMap-LDHMEOVo.js';
+export { encodeIntoResult, stegaEncodeSourceMap } from './_chunks/stegaEncodeSourceMap-DO8ipgJw.js';
 
 class SanityStegaClient extends SanityClient {
 }

package/dist/stega.cjs

@@ -2,9 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var nodeMiddleware = require('./_chunks/nodeMiddleware-iUs-kdpz.cjs');
+var nodeMiddleware = require('./_chunks/nodeMiddleware-yTxugO4Q.cjs');
 var getIt = require('get-it');
-var stegaEncodeSourceMap = require('./_chunks/stegaEncodeSourceMap-hWSK_ZZK.cjs');
+var stegaEncodeSourceMap = require('./_chunks/stegaEncodeSourceMap-D6fHf69f.cjs');
 
 class SanityStegaClient extends nodeMiddleware.SanityClient {
 }

package/dist/stega.d.ts

@@ -1198,6 +1198,18 @@ export declare class ObservableSanityClient {
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
   ): Observable<RawQueryResponse<R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+    query: string,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Observable<RawQuerylessQueryResponse<R>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -1791,7 +1803,10 @@ export declare class ProjectsClient {
 }
 
 /** @public */
-export declare type QueryOptions = FilteredResponseQueryOptions | UnfilteredResponseQueryOptions
+export declare type QueryOptions =
+  | FilteredResponseQueryOptions
+  | UnfilteredResponseQueryOptions
+  | UnfilteredResponseWithoutQuery
 
 /** @public */
 export declare interface QueryParams {
@@ -1815,6 +1830,8 @@ export declare 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
@@ -1834,6 +1851,9 @@ export declare interface QueryParams {
  */
 export declare type QueryWithoutParams = Record<string, never> | undefined
 
+/** @public */
+export declare type RawQuerylessQueryResponse<R> = Omit<RawQueryResponse<R>, 'query'>
+
 /** @public */
 export declare interface RawQueryResponse<R> {
   query: string
@@ -1919,6 +1939,7 @@ export declare interface ResponseEvent<T = unknown> {
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
   resultSourceMap?: boolean | 'withKeyArraySelector'
+  returnQuery?: boolean
   useCdn?: boolean
   stega?: boolean | StegaConfig
   cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
@@ -2005,6 +2026,18 @@ export declare class SanityClient {
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
   ): Promise<RawQueryResponse<R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+    query: string,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Promise<RawQuerylessQueryResponse<R>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -2710,6 +2743,23 @@ export declare type TransactionMutationOptions =
 /** @public */
 export declare 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 declare interface UnfilteredResponseWithoutQuery extends ResponseQueryOptions {
+  filterResponse: false
+  returnQuery: false
 }
 
 export {unstable__adapter}

package/dist/stega.js

@@ -1,7 +1,7 @@
-import { SanityClient, ObservableSanityClient, defineCreateClientExports, middleware } from './_chunks/nodeMiddleware-scsxYdRh.js';
-export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableTransaction, Patch, ServerError, Transaction, vercelStegaCleanAll } from './_chunks/nodeMiddleware-scsxYdRh.js';
+import { SanityClient, ObservableSanityClient, defineCreateClientExports, middleware } from './_chunks/nodeMiddleware-BN5UYAym.js';
+export { BasePatch, BaseTransaction, ClientError, ObservablePatch, ObservableTransaction, Patch, ServerError, Transaction, vercelStegaCleanAll } from './_chunks/nodeMiddleware-BN5UYAym.js';
 export { adapter as unstable__adapter, environment as unstable__environment } from 'get-it';
-export { encodeIntoResult, stegaEncodeSourceMap } from './_chunks/stegaEncodeSourceMap-OHUCEAgw.js';
+export { encodeIntoResult, stegaEncodeSourceMap } from './_chunks/stegaEncodeSourceMap-MOb3TLiL.js';
 
 class SanityStegaClient extends SanityClient {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.12.4",
+  "version": "6.13.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -134,20 +134,20 @@
     "rxjs": "^7.0.0"
   },
   "devDependencies": {
-    "@edge-runtime/types": "^2.2.8",
-    "@edge-runtime/vm": "^3.1.8",
+    "@edge-runtime/types": "^2.2.9",
+    "@edge-runtime/vm": "^3.2.0",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@sanity/pkg-utils": "^4.1.4",
+    "@sanity/pkg-utils": "^4.2.0",
     "@types/json-diff": "^1.0.3",
     "@types/node": "^20.8.8",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.1",
+    "@typescript-eslint/parser": "^7.0.1",
     "@vitest/coverage-v8": "1.2.2",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
     "faucet": "^0.0.4",
     "happy-dom": "^12.10.3",
     "json-diff": "^1.0.6",
@@ -157,7 +157,7 @@
     "prettier": "^3.2.5",
     "prettier-plugin-packagejson": "^2.4.10",
     "rimraf": "^5.0.1",
-    "rollup": "^4.9.6",
+    "rollup": "^4.10.0",
     "sse-channel": "^4.0.0",
     "terser": "^5.27.0",
     "typescript": "^5.3.3",

package/src/SanityClient.ts

@@ -28,12 +28,14 @@ import type {
   QueryOptions,
   QueryParams,
   QueryWithoutParams,
+  RawQuerylessQueryResponse,
   RawQueryResponse,
   RawRequestOptions,
   SanityDocument,
   SanityDocumentStub,
   SingleMutationResult,
   UnfilteredResponseQueryOptions,
+  UnfilteredResponseWithoutQuery,
 } from './types'
 import {ObservableUsersClient, UsersClient} from './users/UsersClient'
 
@@ -160,6 +162,18 @@ export class ObservableSanityClient {
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
   ): Observable<RawQueryResponse<R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+    query: string,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Observable<RawQuerylessQueryResponse<R>>
   fetch<R, Q>(
     query: string,
     params?: Q,
@@ -799,6 +813,18 @@ export class SanityClient {
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
   ): Promise<RawQueryResponse<R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+    query: string,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Promise<RawQuerylessQueryResponse<R>>
   fetch<R, Q>(query: string, params?: Q, options?: QueryOptions): Promise<RawQueryResponse<R> | R> {
     return lastValueFrom(
       dataMethods._fetch<R, Q>(

package/src/data/dataMethods.ts

@@ -80,6 +80,11 @@ export function _fetch<R, Q>(
   const params = stega.enabled ? vercelStegaCleanAll(_params) : _params
   const mapResponse =
     options.filterResponse === false ? (res: Any) => res : (res: Any) => res.result
+
+  // 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
+  const returnQuery = options.filterResponse === false && options.returnQuery !== false
+
   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.
@@ -93,7 +98,13 @@ export function _fetch<R, Q>(
       ? {...opts, fetch: {cache, next}}
       : opts
 
-  const $request = _dataRequest(client, httpRequest, 'query', {query, params}, reqOpts)
+  const $request = _dataRequest(
+    client,
+    httpRequest,
+    'query',
+    {query, params, options: {returnQuery}},
+    reqOpts,
+  )
   return stega.enabled
     ? $request.pipe(
         combineLatestWith(

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/types.ts

@@ -452,6 +452,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 +723,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 +739,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 +773,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

@@ -3406,7 +3406,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);
@@ -3417,6 +3417,8 @@
       if (value)
         searchParams.append(key, "".concat(value));
     }
+    if (returnQuery === false)
+      searchParams.append("returnQuery", "false");
     return "?".concat(searchParams);
   };
 
@@ -3448,6 +3450,7 @@
     } : _stega;
     const params = stega.enabled ? vercelStegaCleanAll(_params) : _params;
     const mapResponse = options.filterResponse === false ? (res) => res : (res) => res.result;
+    const returnQuery = options.filterResponse === false && options.returnQuery !== false;
     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.
@@ -3457,11 +3460,17 @@
       ...options
     };
     const reqOpts = typeof cache !== "undefined" || typeof next !== "undefined" ? { ...opts, fetch: { cache, next } } : opts;
-    const $request = _dataRequest(client, httpRequest, "query", { query, params }, reqOpts);
+    const $request = _dataRequest(
+      client,
+      httpRequest,
+      "query",
+      { query, params, options: { returnQuery } },
+      reqOpts
+    );
     return stega.enabled ? $request.pipe(
       combineLatestWith(
         from(
-          Promise.resolve().then(function () { return stegaEncodeSourceMapLDHMEOVo; }).then(function (n) { return n.stegaEncodeSourceMap$1; }).then(
+          Promise.resolve().then(function () { return stegaEncodeSourceMapDO8ipgJw; }).then(function (n) { return n.stegaEncodeSourceMap$1; }).then(
             ({ stegaEncodeSourceMap }) => stegaEncodeSourceMap
           )
         )
@@ -4987,7 +4996,7 @@
     stegaEncodeSourceMap: stegaEncodeSourceMap
   });
 
-  var stegaEncodeSourceMapLDHMEOVo = /*#__PURE__*/Object.freeze({
+  var stegaEncodeSourceMapDO8ipgJw = /*#__PURE__*/Object.freeze({
     __proto__: null,
     encodeIntoResult: encodeIntoResult,
     stegaEncodeSourceMap: stegaEncodeSourceMap,