@sanity/client 6.20.2-beta.2 → 6.21.0

package/dist/index.browser.d.cts

@@ -336,13 +336,6 @@ export declare interface ClientConfig {
   apiHost?: string
   apiVersion?: string
   proxy?: string
-  /**
-   * Spread the requests over a number of hostnames to work around HTTP/1.1 limitations.
-   * Only applicable in browsers, and for certain allowed projects.
-   *
-   * @alpha
-   */
-  useDomainSharding?: boolean
   /**
    * Optional request tag prefix for all request tags
    */
@@ -401,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
@@ -1307,10 +1306,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.
    *
@@ -1318,11 +1318,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.
    *
@@ -1330,11 +1334,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.
    *
@@ -1342,11 +1350,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.
    *
@@ -2191,10 +2203,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.
    *
@@ -2202,11 +2215,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.
    *
@@ -2214,11 +2231,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.
    *
@@ -2226,11 +2247,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.
    *
@@ -2753,6 +2778,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

@@ -336,13 +336,6 @@ export declare interface ClientConfig {
   apiHost?: string
   apiVersion?: string
   proxy?: string
-  /**
-   * Spread the requests over a number of hostnames to work around HTTP/1.1 limitations.
-   * Only applicable in browsers, and for certain allowed projects.
-   *
-   * @alpha
-   */
-  useDomainSharding?: boolean
   /**
    * Optional request tag prefix for all request tags
    */
@@ -401,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
@@ -1307,10 +1306,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.
    *
@@ -1318,11 +1318,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.
    *
@@ -1330,11 +1334,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.
    *
@@ -1342,11 +1350,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.
    *
@@ -2191,10 +2203,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.
    *
@@ -2202,11 +2215,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.
    *
@@ -2214,11 +2231,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.
    *
@@ -2226,11 +2247,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.
    *
@@ -2753,6 +2778,9 @@ export declare interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
+/** @public */
+export declare interface SanityQueries {}
+
 /** @internal */
 export declare interface SanityReference {
   _ref: string

package/dist/index.browser.js

@@ -586,7 +586,6 @@ function requestOptions(config, overrides = {}) {
     proxy: overrides.proxy || config.proxy,
     json: !0,
     withCredentials,
-    useDomainSharding: config.useDomainSharding,
     fetch: typeof overrides.fetch == "object" && typeof config.fetch == "object" ? { ...config.fetch, ...overrides.fetch } : overrides.fetch || config.fetch
   });
 }
@@ -856,55 +855,6 @@ function optionsFromFile(opts, file) {
     opts
   );
 }
-const UNSHARDED_URL_RE = /^https:\/\/([a-z0-9]+)\.api\.(sanity\..*)/, SHARDED_URL_RE = /^https:\/\/[a-z0-9]+\.api\.r(\d+)\.sanity\.(.*)/, domainSharder = getDomainSharder();
-function getDomainSharder(initialBuckets) {
-  const buckets = new Array(3).fill(0, 0);
-  function incrementBucketForUrl(url) {
-    const shard = getShardFromUrl(url);
-    shard !== null && buckets[shard]++;
-  }
-  function decrementBucketForUrl(url) {
-    const shard = getShardFromUrl(url);
-    shard !== null && buckets[shard]--;
-  }
-  function getShardedUrl(url) {
-    const [isMatch, projectId2, rest] = url.match(UNSHARDED_URL_RE) || [];
-    if (!isMatch)
-      return url;
-    const bucket = buckets.reduce(
-      (smallest, count, index) => count < buckets[smallest] ? index : smallest,
-      0
-    );
-    return `https://${projectId2}.api.r${bucket + 1}.${rest}`;
-  }
-  function getShardFromUrl(url) {
-    const [isMatch, shard] = url.match(SHARDED_URL_RE) || [];
-    return isMatch ? parseInt(shard, 10) - 1 : null;
-  }
-  return {
-    middleware: {
-      processOptions: (options) => {
-        if (!useDomainSharding(options))
-          return options;
-        const url = getShardedUrl(options.url);
-        return options.url = url, options;
-      },
-      onRequest(req) {
-        return useDomainSharding(req.options) && incrementBucketForUrl(req.options.url), req;
-      },
-      onResponse(res, context) {
-        return useDomainSharding(context.options) && decrementBucketForUrl(context.options.url), res;
-      }
-    },
-    incrementBucketForUrl,
-    decrementBucketForUrl,
-    getShardedUrl,
-    getBuckets: () => buckets
-  };
-}
-function useDomainSharding(options) {
-  return "useDomainSharding" in options && options.useDomainSharding === !0;
-}
 var defaults = (obj, defaults2) => Object.keys(defaults2).concat(Object.keys(obj)).reduce((target, prop) => (target[prop] = typeof obj[prop] > "u" ? defaults2[prop] : obj[prop], target), {});
 const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop] > "u" || (selection[prop] = obj[prop]), selection), {}), MAX_URL_LENGTH = 14800, possibleOptions = [
   "includePreviousRevision",
@@ -916,16 +866,15 @@ const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop]
   includeResult: !0
 };
 function _listen(query, params, opts = {}) {
-  const { url, token, withCredentials, requestTagPrefix } = this.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = { ...defaults(opts, defaultOptions), tag }, listenOpts = pick(options, possibleOptions), qs = encodeQueryString({ query, params, options: { tag, ...listenOpts } });
-  let uri = `${url}${_getDataUrl(this, "listen", qs)}`;
-  if (this.config().useDomainSharding && (uri = domainSharder.getShardedUrl(uri)), uri.length > MAX_URL_LENGTH)
+  const { url, token, withCredentials, requestTagPrefix } = this.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = { ...defaults(opts, defaultOptions), tag }, listenOpts = pick(options, possibleOptions), qs = encodeQueryString({ query, params, options: { tag, ...listenOpts } }), uri = `${url}${_getDataUrl(this, "listen", qs)}`;
+  if (uri.length > MAX_URL_LENGTH)
     return new Observable((observer) => observer.error(new Error("Query too large for listener")));
   const listenFor = options.events ? options.events : ["mutation"], shouldEmitReconnect = listenFor.indexOf("reconnect") !== -1, esOptions = {};
   return (token || withCredentials) && (esOptions.withCredentials = !0), token && (esOptions.headers = {
     Authorization: `Bearer ${token}`
   }), new Observable((observer) => {
     let es, reconnectTimer, stopped = !1, unsubscribed = !1;
-    domainSharder.incrementBucketForUrl(uri), open();
+    open();
     function onError() {
       stopped || (emitReconnect(), !stopped && es.readyState === es.CLOSED && (unsubscribe(), clearTimeout(reconnectTimer), reconnectTimer = setTimeout(open, 100)));
     }
@@ -960,7 +909,7 @@ function _listen(query, params, opts = {}) {
       });
     }
     function stop() {
-      stopped = !0, unsubscribe(), unsubscribed = !0, domainSharder.decrementBucketForUrl(uri);
+      stopped = !0, unsubscribe(), unsubscribed = !0;
     }
     return stop;
   });
@@ -1581,7 +1530,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var envMiddleware = [domainSharder.middleware];
+var envMiddleware = [];
 const exp = defineCreateClientExports(envMiddleware, SanityClient), requester = exp.requester, createClient = exp.createClient, deprecatedCreateClient = defineDeprecatedCreateClient(createClient);
 export {
   BasePatch,