@sanity/client 6.20.2 → 6.21.1

package/dist/index.browser.d.cts

@@ -394,6 +394,12 @@ export declare class ClientError extends Error {
 /** @public */
 export declare type ClientPerspective = 'previewDrafts' | 'published' | 'raw'
 
+/** @public */
+export declare type ClientReturn<
+  GroqString extends string,
+  Fallback = Any,
+> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
+
 /** @public */
 export declare interface ContentSourceMap {
   mappings: ContentSourceMapMappings
@@ -853,6 +859,12 @@ export declare interface ListenOptions {
    * @defaultValue `true`
    */
   includeResult?: boolean
+  /**
+   * Whether or not to include the mutations that was performed.
+   * If you do not need the mutations, set this to `false` to reduce bandwidth usage.
+   * @defaultValue `true`
+   */
+  includeMutations?: boolean
   /**
    * Whether or not to include the document as it looked before the mutation event.
    * The previous revision will be available on the `.previous` property of the events,
@@ -1300,10 +1312,11 @@ export declare class ObservableSanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<R = Any, Q extends QueryWithoutParams = QueryWithoutParams>(
-    query: string,
-    params?: Q | QueryWithoutParams,
-  ): Observable<R>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams = QueryWithoutParams,
+    const G extends string = string,
+  >(query: G, params?: Q | QueryWithoutParams): Observable<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -1311,11 +1324,15 @@ export declare class ObservableSanityClient {
    * @param params - Optional query parameters
    * @param options - Optional request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options?: FilteredResponseQueryOptions,
-  ): Observable<R>
+  ): Observable<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -1323,11 +1340,15 @@ export declare class ObservableSanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
     query: string,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
-  ): Observable<RawQueryResponse<R>>
+  ): Observable<RawQueryResponse<ClientReturn<G, R>>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -1335,11 +1356,15 @@ export declare class ObservableSanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseWithoutQuery,
-  ): Observable<RawQuerylessQueryResponse<R>>
+  ): Observable<RawQuerylessQueryResponse<ClientReturn<G, R>>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -2184,10 +2209,11 @@ export declare class SanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<R = Any, Q extends QueryWithoutParams = QueryWithoutParams>(
-    query: string,
-    params?: Q | QueryWithoutParams,
-  ): Promise<R>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams = QueryWithoutParams,
+    const G extends string = string,
+  >(query: G, params?: Q | QueryWithoutParams): Promise<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -2195,11 +2221,15 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Optional request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options?: FilteredResponseQueryOptions,
-  ): Promise<R>
+  ): Promise<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -2207,11 +2237,15 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
-  ): Promise<RawQueryResponse<R>>
+  ): Promise<RawQueryResponse<ClientReturn<G, R>>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -2219,11 +2253,15 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseWithoutQuery,
-  ): Promise<RawQuerylessQueryResponse<R>>
+  ): Promise<RawQuerylessQueryResponse<ClientReturn<G, R>>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -2746,6 +2784,9 @@ export declare interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
+/** @public */
+export declare interface SanityQueries {}
+
 /** @internal */
 export declare interface SanityReference {
   _ref: string

package/dist/index.browser.d.ts

@@ -394,6 +394,12 @@ export declare class ClientError extends Error {
 /** @public */
 export declare type ClientPerspective = 'previewDrafts' | 'published' | 'raw'
 
+/** @public */
+export declare type ClientReturn<
+  GroqString extends string,
+  Fallback = Any,
+> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
+
 /** @public */
 export declare interface ContentSourceMap {
   mappings: ContentSourceMapMappings
@@ -853,6 +859,12 @@ export declare interface ListenOptions {
    * @defaultValue `true`
    */
   includeResult?: boolean
+  /**
+   * Whether or not to include the mutations that was performed.
+   * If you do not need the mutations, set this to `false` to reduce bandwidth usage.
+   * @defaultValue `true`
+   */
+  includeMutations?: boolean
   /**
    * Whether or not to include the document as it looked before the mutation event.
    * The previous revision will be available on the `.previous` property of the events,
@@ -1300,10 +1312,11 @@ export declare class ObservableSanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<R = Any, Q extends QueryWithoutParams = QueryWithoutParams>(
-    query: string,
-    params?: Q | QueryWithoutParams,
-  ): Observable<R>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams = QueryWithoutParams,
+    const G extends string = string,
+  >(query: G, params?: Q | QueryWithoutParams): Observable<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -1311,11 +1324,15 @@ export declare class ObservableSanityClient {
    * @param params - Optional query parameters
    * @param options - Optional request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options?: FilteredResponseQueryOptions,
-  ): Observable<R>
+  ): Observable<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -1323,11 +1340,15 @@ export declare class ObservableSanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
     query: string,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
-  ): Observable<RawQueryResponse<R>>
+  ): Observable<RawQueryResponse<ClientReturn<G, R>>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -1335,11 +1356,15 @@ export declare class ObservableSanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseWithoutQuery,
-  ): Observable<RawQuerylessQueryResponse<R>>
+  ): Observable<RawQuerylessQueryResponse<ClientReturn<G, R>>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -2184,10 +2209,11 @@ export declare class SanityClient {
    *
    * @param query - GROQ-query to perform
    */
-  fetch<R = Any, Q extends QueryWithoutParams = QueryWithoutParams>(
-    query: string,
-    params?: Q | QueryWithoutParams,
-  ): Promise<R>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams = QueryWithoutParams,
+    const G extends string = string,
+  >(query: G, params?: Q | QueryWithoutParams): Promise<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -2195,11 +2221,15 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Optional request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options?: FilteredResponseQueryOptions,
-  ): Promise<R>
+  ): Promise<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -2207,11 +2237,15 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
-  ): Promise<RawQueryResponse<R>>
+  ): Promise<RawQueryResponse<ClientReturn<G, R>>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -2219,11 +2253,15 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = Any, Q extends QueryWithoutParams | QueryParams = QueryParams>(
-    query: string,
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseWithoutQuery,
-  ): Promise<RawQuerylessQueryResponse<R>>
+  ): Promise<RawQuerylessQueryResponse<ClientReturn<G, R>>>
   /**
    * Fetch a single document with the given ID.
    *
@@ -2746,6 +2784,9 @@ export declare interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
+/** @public */
+export declare interface SanityQueries {}
+
 /** @internal */
 export declare interface SanityReference {
   _ref: string

package/dist/index.browser.js

@@ -594,13 +594,13 @@ const encodeQueryString = ({
   params = {},
   options = {}
 }) => {
-  const searchParams = new URLSearchParams(), { tag, returnQuery, ...opts } = options;
+  const searchParams = new URLSearchParams(), { tag, includeMutations, returnQuery, ...opts } = options;
   tag && searchParams.append("tag", tag), searchParams.append("query", query);
   for (const [key, value] of Object.entries(params))
     searchParams.append(`$${key}`, JSON.stringify(value));
   for (const [key, value] of Object.entries(opts))
     value && searchParams.append(key, `${value}`);
-  return returnQuery === !1 && searchParams.append("returnQuery", "false"), `?${searchParams}`;
+  return returnQuery === !1 && searchParams.append("returnQuery", "false"), includeMutations === !1 && searchParams.append("includeMutations", "false"), `?${searchParams}`;
 }, excludeFalsey = (param, defValue) => param === !1 ? void 0 : typeof param > "u" ? defValue : param, getMutationQuery = (options = {}) => ({
   dryRun: options.dryRun,
   returnIds: !0,
@@ -859,6 +859,7 @@ var defaults = (obj, defaults2) => Object.keys(defaults2).concat(Object.keys(obj
 const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop] > "u" || (selection[prop] = obj[prop]), selection), {}), MAX_URL_LENGTH = 14800, possibleOptions = [
   "includePreviousRevision",
   "includeResult",
+  "includeMutations",
   "visibility",
   "effectFormat",
   "tag"