@sanity/client 5.4.2 → 5.4.3-dev.0

package/dist/index.browser.js

@@ -1,6 +1,6 @@
 import { getIt } from 'get-it';
 export { adapter as unstable__adapter, environment as unstable__environment } from 'get-it';
-import { jsonRequest, jsonResponse, progress, observable } from 'get-it/middleware';
+import { retry, jsonRequest, jsonResponse, progress, observable } from 'get-it/middleware';
 import { Observable, lastValueFrom } from 'rxjs';
 import { map, filter } from 'rxjs/operators';
 var envMiddleware = [];
@@ -89,8 +89,18 @@ const printWarnings = {
     return res;
   }
 };
-function defineHttpRequest(envMiddleware) {
-  const request = getIt([...envMiddleware, printWarnings, jsonRequest(), jsonResponse(), progress(), httpError, observable({
+function defineHttpRequest(envMiddleware, _ref) {
+  let {
+    maxRetries = 5,
+    retryDelay
+  } = _ref;
+  const request = getIt([maxRetries > 0 ? retry({
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    retryDelay,
+    // This option is typed incorrectly in get-it.
+    maxRetries,
+    shouldRetry
+  }) : {}, ...envMiddleware, printWarnings, jsonRequest(), jsonResponse(), progress(), httpError, observable({
     implementation: Observable
   })]);
   function httpRequest(options) {
@@ -103,6 +113,13 @@ function defineHttpRequest(envMiddleware) {
   httpRequest.defaultRequester = request;
   return httpRequest;
 }
+function shouldRetry(err, attempt, options) {
+  const isSafe = options.method === "GET" || options.method === "HEAD";
+  const isQuery = options.uri.startsWith("/data/query");
+  const isRetriableResponse = err.response && (err.response.statusCode === 429 || err.response.statusCode === 502 || err.response.statusCode === 503);
+  if ((isSafe || isQuery) && isRetriableResponse) return true;
+  return retry.shouldRetry(err, attempt, options);
+}
 const projectHeader = "X-Sanity-Project-ID";
 function requestOptions(config) {
   let overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -199,12 +216,12 @@ const requestTag = tag => {
   }
   return tag;
 };
-const encodeQueryString = _ref => {
+const encodeQueryString = _ref2 => {
   let {
     query,
     params = {},
     options = {}
-  } = _ref;
+  } = _ref2;
   const searchParams = new URLSearchParams();
   const {
     tag,
@@ -813,6 +830,12 @@ function _requestObservable(client, httpRequest, options) {
       ...options.query
     };
   }
+  if (config.resultSourceMap) {
+    options.query = {
+      resultSourceMap: true,
+      ...options.query
+    };
+  }
   const reqOptions = requestOptions(config, Object.assign({}, options, {
     url: _getUrl(client, uri, useCdn)
   }));
@@ -989,10 +1012,10 @@ once(function () {
   }
   return console.warn(message.join(" "), ...args);
 });
-const printCdnWarning = createWarningPrinter(["You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and", "cheaper. Think about it! For more info, see ".concat(generateHelpUrl("js-client-cdn-configuration"), " "), "To hide this warning, please set the `useCdn` option to either `true` or `false` when creating", "the client."]);
+const 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."]);
 const printBrowserTokenWarning = createWarningPrinter(["You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.", "See ".concat(generateHelpUrl("js-client-browser-token"), " for more information and how to hide this warning.")]);
 const printNoApiVersionSpecifiedWarning = createWarningPrinter(["Using the Sanity client without specifying an API version is deprecated.", "See ".concat(generateHelpUrl("js-client-api-version"))]);
-const printNoDefaultExport = createWarningPrinter(["The default export of @sanity/client has been deprecated. Use the named export `createClient` instead"]);
+const printNoDefaultExport = createWarningPrinter(["The default export of @sanity/client has been deprecated. Use the named export `createClient` instead."]);
 const defaultCdnHost = "apicdn.sanity.io";
 const defaultConfig = {
   apiHost: "https://api.sanity.io",
@@ -1043,7 +1066,7 @@ const initConfig = (config, prevConfig) => {
   }
   newConfig.apiVersion = "".concat(newConfig.apiVersion).replace(/^v/, "");
   newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost;
-  newConfig.useCdn = Boolean(newConfig.useCdn) && !newConfig.withCredentials;
+  newConfig.useCdn = newConfig.useCdn !== false && !newConfig.withCredentials;
   validateApiVersion(newConfig.apiVersion);
   const hostParts = newConfig.apiHost.split("://", 2);
   const protocol = hostParts[0];
@@ -1720,21 +1743,24 @@ const _SanityClient = class {
     return new Transaction(operations, this);
   }
   /**
-   * DEPRECATED: Perform an HTTP request against the Sanity API
+   * Perform a request against the Sanity API
+   * NOTE: Only use this for Sanity API endpoints, not for your own APIs!
    *
-   * @deprecated Use your own request library!
    * @param options - Request options
+   * @returns Promise resolving to the response body
    */
   request(options) {
     return lastValueFrom(_request(this, __privateGet(this, _httpRequest2), options));
   }
   /**
-   * DEPRECATED: Perform an HTTP request a `/data` sub-endpoint
+   * Perform an HTTP request a `/data` sub-endpoint
+   * NOTE: Considered internal, thus marked as deprecated. Use `request` instead.
    *
-   * @deprecated Use your own request library!
+   * @deprecated - Use `request()` or your own HTTP library instead
    * @param endpoint - Endpoint to hit (mutate, query etc)
    * @param body - Request body
    * @param options - Request options
+   * @internal
    */
   dataRequest(endpoint, body, options) {
     return lastValueFrom(_dataRequest(this, __privateGet(this, _httpRequest2), endpoint, body, options));
@@ -1761,9 +1787,12 @@ const _SanityClient = class {
 let SanityClient = _SanityClient;
 _clientConfig2 = new WeakMap();
 _httpRequest2 = new WeakMap();
-const httpRequest = defineHttpRequest(envMiddleware);
+const httpRequest = defineHttpRequest(envMiddleware, {});
 const requester = httpRequest.defaultRequester;
-const createClient = config => new SanityClient(httpRequest, config);
+const createClient = config => new SanityClient(defineHttpRequest(envMiddleware, {
+  maxRetries: config.maxRetries,
+  retryDelay: config.retryDelay
+}), config);
 function deprecatedCreateClient(config) {
   printNoDefaultExport();
   return new SanityClient(httpRequest, config);