@sanity/client 6.20.0 → 6.20.2-beta.0

package/dist/index.browser.d.cts

@@ -336,6 +336,13 @@ 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
    */

package/dist/index.browser.d.ts

@@ -336,6 +336,13 @@ 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
    */

package/dist/index.browser.js

@@ -491,7 +491,10 @@ function once(fn) {
 const createWarningPrinter = (message) => (
   // eslint-disable-next-line no-console
   once((...args) => console.warn(message.join(" "), ...args))
-), printCdnWarning = createWarningPrinter([
+), printCdnAndWithCredentialsWarning = createWarningPrinter([
+  "Because you set `withCredentials` to true, we will override your `useCdn`",
+  "setting to be false since (cookie-based) credentials are never set on the CDN"
+]), printCdnWarning = createWarningPrinter([
   "Since you haven't set a value for `useCdn`, we will deliver content using our",
   "global, edge-cached API-CDN. If you wish to have content delivered faster, set",
   "`useCdn: false` to use the Live API. Note: You may incur higher costs using the live API."
@@ -569,7 +572,7 @@ const validateApiPerspective = function(perspective) {
       `stega.studioUrl must be a string or a function, received ${newConfig.stega.studioUrl}`
     );
   const isBrowser = typeof window < "u" && window.location && window.location.hostname, isLocalhost = isBrowser && isLocal(window.location.hostname);
-  isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== !0 ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn = newConfig.useCdn !== !1 && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
+  isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== !0 ? printBrowserTokenWarning() : typeof newConfig.useCdn > "u" && printCdnWarning(), projectBased && projectId(newConfig.projectId), newConfig.dataset && dataset(newConfig.dataset), "requestTagPrefix" in newConfig && (newConfig.requestTagPrefix = newConfig.requestTagPrefix ? requestTag(newConfig.requestTagPrefix).replace(/\.+$/, "") : void 0), newConfig.apiVersion = `${newConfig.apiVersion}`.replace(/^v/, ""), newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost, newConfig.useCdn === !0 && newConfig.withCredentials && printCdnAndWithCredentialsWarning(), newConfig.useCdn = newConfig.useCdn !== !1 && !newConfig.withCredentials, validateApiVersion(newConfig.apiVersion);
   const hostParts = newConfig.apiHost.split("://", 2), protocol = hostParts[0], host = hostParts[1], cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
   return newConfig.useProjectHostname ? (newConfig.url = `${protocol}://${newConfig.projectId}.${host}/v${newConfig.apiVersion}`, newConfig.cdnUrl = `${protocol}://${newConfig.projectId}.${cdnHost}/v${newConfig.apiVersion}`) : (newConfig.url = `${newConfig.apiHost}/v${newConfig.apiVersion}`, newConfig.cdnUrl = newConfig.url), newConfig;
 }, projectHeader = "X-Sanity-Project-ID";
@@ -852,6 +855,55 @@ function optionsFromFile(opts, file) {
     opts
   );
 }
+const UNSHARDED_URL_RE = /^https:\/\/([a-z0-9]+)\.api\.(sanity\..*)/, SHARDED_URL_RE = /^https:\/\/[a-z0-9]+\.api\.s(\d+)\.sanity\.(.*)/, domainSharder = getDomainSharder();
+function getDomainSharder(initialBuckets) {
+  const buckets = new Array(10).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.s${bucket}.${rest}`;
+  }
+  function getShardFromUrl(url) {
+    const [isMatch, shard] = url.match(SHARDED_URL_RE) || [];
+    return isMatch ? parseInt(shard, 10) : 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",
@@ -863,15 +915,16 @@ 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 } }), uri = `${url}${_getDataUrl(this, "listen", qs)}`;
-  if (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 } });
+  let uri = `${url}${_getDataUrl(this, "listen", qs)}`;
+  if (this.config().useDomainSharding && (uri = domainSharder.getShardedUrl(uri)), 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;
-    open();
+    domainSharder.incrementBucketForUrl(uri), open();
     function onError() {
       stopped || (emitReconnect(), !stopped && es.readyState === es.CLOSED && (unsubscribe(), clearTimeout(reconnectTimer), reconnectTimer = setTimeout(open, 100)));
     }
@@ -906,7 +959,7 @@ function _listen(query, params, opts = {}) {
       });
     }
     function stop() {
-      stopped = !0, unsubscribe(), unsubscribed = !0;
+      stopped = !0, unsubscribe(), unsubscribed = !0, domainSharder.decrementBucketForUrl(uri);
     }
     return stop;
   });
@@ -1517,6 +1570,7 @@ function defineCreateClientExports(envMiddleware2, ClassConstructor) {
       maxRedirects: 0,
       maxRetries: config.maxRetries,
       retryDelay: config.retryDelay,
+      useDomainSharding: config.useDomainSharding,
       ...options
     }),
     config
@@ -1527,7 +1581,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var envMiddleware = [];
+var envMiddleware = [domainSharder.middleware];
 const exp = defineCreateClientExports(envMiddleware, SanityClient), requester = exp.requester, createClient = exp.createClient, deprecatedCreateClient = defineDeprecatedCreateClient(createClient);
 export {
   BasePatch,