@sanity/client 6.20.2-beta.2 → 6.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.20.2-beta.2",
+  "version": "6.21.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -118,12 +118,12 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^5.0.2",
-    "get-it": "^8.6.1",
+    "get-it": "^8.6.3",
     "rxjs": "^7.0.0"
   },
   "devDependencies": {
-    "@edge-runtime/types": "^2.2.9",
-    "@edge-runtime/vm": "^3.2.0",
+    "@edge-runtime/types": "^3.0.0",
+    "@edge-runtime/vm": "^4.0.0",
     "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@sanity/pkg-utils": "^6.9.3",

package/src/SanityClient.ts

@@ -17,6 +17,7 @@ import type {
   BaseActionOptions,
   BaseMutationOptions,
   ClientConfig,
+  ClientReturn,
   FilteredResponseQueryOptions,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
@@ -142,10 +143,11 @@ export 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.
    *
@@ -153,11 +155,15 @@ export 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.
    *
@@ -165,11 +171,15 @@ export 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.
    *
@@ -177,13 +187,17 @@ export 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>>
-  fetch<R, Q>(
-    query: string,
+  ): Observable<RawQuerylessQueryResponse<ClientReturn<G, R>>>
+  fetch<R, Q, const G extends string>(
+    query: G,
     params?: Q,
     options?: QueryOptions,
   ): Observable<RawQueryResponse<R> | R> {
@@ -808,10 +822,11 @@ export 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.
    *
@@ -819,11 +834,15 @@ export 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.
    *
@@ -831,11 +850,15 @@ export 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.
    *
@@ -843,14 +866,22 @@ export 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>>
-  fetch<R, Q>(query: string, params?: Q, options?: QueryOptions): Promise<RawQueryResponse<R> | R> {
+  ): Promise<RawQuerylessQueryResponse<ClientReturn<G, R>>>
+  fetch<R, Q, const G extends string>(
+    query: G,
+    params?: Q,
+    options?: QueryOptions,
+  ): Promise<RawQueryResponse<ClientReturn<G, R>> | ClientReturn<G, R>> {
     return lastValueFrom(
-      dataMethods._fetch<R, Q>(
+      dataMethods._fetch<ClientReturn<G, R>, Q>(
         this,
         this.#httpRequest,
         this.#clientConfig.stega,

package/src/data/listen.ts

@@ -1,6 +1,5 @@
 import {Observable} from 'rxjs'
 
-import {domainSharder as sharder} from '../http/domainSharding'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {Any, ListenEvent, ListenOptions, ListenParams, MutationEvent} from '../types'
 import defaults from '../util/defaults'
@@ -65,11 +64,7 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
   const listenOpts = pick(options, possibleOptions)
   const qs = encodeQueryString({query, params, options: {tag, ...listenOpts}})
 
-  let uri = `${url}${_getDataUrl(this, 'listen', qs)}`
-  if (this.config().useDomainSharding) {
-    uri = sharder.getShardedUrl(uri)
-  }
-
+  const 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')))
   }
@@ -96,12 +91,6 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
     // Once it is`true`, it will never be `false` again.
     let unsubscribed = false
 
-    // We're about to connect, and will reuse the same shard/bucket for every reconnect henceforth.
-    // This may seem inoptimal, but once connected we should just consider this as a "permanent"
-    // connection, since we'll automatically retry on failures/disconnects. Once we explicitly
-    // unsubsccribe, we can decrement the bucket and free up the shard.
-    sharder.incrementBucketForUrl(uri)
-
     open()
 
     function onError() {
@@ -198,7 +187,6 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
       stopped = true
       unsubscribe()
       unsubscribed = true
-      sharder.decrementBucketForUrl(uri)
     }
 
     return stop

package/src/http/browserMiddleware.ts

@@ -1,3 +1 @@
-import {domainSharder} from './domainSharding'
-
-export default [domainSharder.middleware]
+export default []

package/src/http/nodeMiddleware.ts

@@ -1,11 +1,8 @@
 import {agent, debug, headers} from 'get-it/middleware'
 
 import {name, version} from '../../package.json'
-import {domainSharder} from './domainSharding'
 
 const middleware = [
-  domainSharder.middleware,
-
   debug({verbose: true, namespace: 'sanity:client'}),
   headers({'User-Agent': `${name} ${version}`}),
 

package/src/http/requestOptions.ts

@@ -29,7 +29,6 @@ export function requestOptions(config: Any, overrides: Any = {}): Omit<RequestOp
     proxy: overrides.proxy || config.proxy,
     json: true,
     withCredentials,
-    useDomainSharding: config.useDomainSharding,
     fetch:
       typeof overrides.fetch === 'object' && typeof config.fetch === 'object'
         ? {...config.fetch, ...overrides.fetch}

package/src/types.ts

@@ -46,14 +46,6 @@ export interface ClientConfig {
   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
    */
@@ -1244,6 +1236,15 @@ export interface LiveEventMessage {
   tags: SyncTag[]
 }
 
+/** @public */
+export interface SanityQueries {}
+
+/** @public */
+export type ClientReturn<
+  GroqString extends string,
+  Fallback = Any,
+> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
+
 export type {
   ContentSourceMapParsedPath,
   ContentSourceMapParsedPathKeyedSegment,

package/umd/sanityClient.js

@@ -2393,7 +2393,6 @@ ${selectionOpts}`);
       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
     });
   }
@@ -2663,55 +2662,6 @@ ${selectionOpts}`);
       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",
@@ -2723,16 +2673,15 @@ ${selectionOpts}`);
     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)));
       }
@@ -2767,7 +2716,7 @@ ${selectionOpts}`);
         });
       }
       function stop() {
-        stopped = !0, unsubscribe(), unsubscribed = !0, domainSharder.decrementBucketForUrl(uri);
+        stopped = !0, unsubscribe(), unsubscribed = !0;
       }
       return stop;
     });
@@ -3388,7 +3337,7 @@ ${selectionOpts}`);
       return printNoDefaultExport(), createClient2(config);
     };
   }
-  var envMiddleware = [domainSharder.middleware];
+  var envMiddleware = [];
   const exp = defineCreateClientExports(envMiddleware, SanityClient), requester = exp.requester, createClient = exp.createClient, deprecatedCreateClient = defineDeprecatedCreateClient(createClient);
 
   const reKeySegment = /_key\s*==\s*['"](.*)['"]/;