@sanity/client 5.4.2 → 5.4.3-dev.1

package/dist/index.d.ts

@@ -280,6 +280,7 @@ export declare type ChannelErrorEvent = {
 export declare interface ClientConfig {
   projectId?: string
   dataset?: string
+  /** @defaultValue true */
   useCdn?: boolean
   token?: string
   apiHost?: string
@@ -290,6 +291,17 @@ export declare interface ClientConfig {
   withCredentials?: boolean
   allowReconfigure?: boolean
   timeout?: number
+  /** Number of retries for requests. Defaults to 5. */
+  maxRetries?: number
+  /**
+   * The amount of time, in milliseconds, to wait before retrying, given an attemptNumber (starting at 0).
+   *
+   * Defaults to exponential back-off, starting at 100ms, doubling for each attempt, together with random
+   * jitter between 0 and 100 milliseconds. More specifically the following algorithm is used:
+   *
+   *   Delay = 100 * 2^attemptNumber + randomNumberBetween0and100
+   */
+  retryDelay?: (attemptNumber: number) => number
   /**
    * @deprecated Don't use
    */
@@ -298,6 +310,7 @@ export declare interface ClientConfig {
    * @deprecated Don't use
    */
   requester?: Requester
+  resultSourceMap?: boolean
 }
 
 /** @public */
@@ -309,6 +322,67 @@ export declare class ClientError extends Error {
   constructor(res: Any)
 }
 
+/** @public */
+export declare type ContentSourceMap = {
+  mappings: ContentSourceMapMappings
+  documents: ContentSourceMapDocuments
+  paths: ContentSourceMapPaths
+}
+
+/** @public */
+export declare type ContentSourceMapDocuments = SanityDocument[]
+
+/**
+ * DocumentValueSource is a path to a value within a document
+ * @public
+ */
+export declare type ContentSourceMapDocumentValueSource = {
+  type: 'documentValue'
+  document: number
+  path: number
+}
+
+/**
+ * When a value is not from a source, its a literal
+ * @public
+ */
+export declare type ContentSourceMapLiteralSource = {
+  type: 'literal'
+}
+
+/** @public */
+export declare type ContentSourceMapMapping = ContentSourceMapValueMapping
+
+/** @public */
+export declare type ContentSourceMapMappings = Record<string, ContentSourceMapMapping>
+
+/** @public */
+export declare type ContentSourceMapPaths = string[]
+
+/** @public */
+export declare type ContentSourceMapSource =
+  | ContentSourceMapDocumentValueSource
+  | ContentSourceMapLiteralSource
+  | ContentSourceMapUnknownSource
+
+/**
+ * When a field source is unknown
+ * @public
+ */
+export declare type ContentSourceMapUnknownSource = {
+  type: 'unknown'
+}
+
+/**
+ * ValueMapping is a mapping when for value that is from a single source value
+ * It may refer to a field within a document or a literal value
+ * @public
+ */
+export declare type ContentSourceMapValueMapping = {
+  type: 'value'
+  source: ContentSourceMapSource
+}
+
 /** @public */
 export declare const createClient: (config: ClientConfig) => SanityClient
 
@@ -400,7 +474,7 @@ export declare interface ErrorProps {
   details: Any
 }
 
-/** @internal */
+/** @public */
 export declare type FilteredResponseQueryOptions = RequestOptions & {
   filterResponse?: true
 }
@@ -1404,11 +1478,12 @@ export declare type QueryParams = {
   [key: string]: Any
 }
 
-/** @internal */
+/** @public */
 export declare interface RawQueryResponse<R> {
   q: string
   ms: number
   result: R
+  resultSourceMap: ContentSourceMap
 }
 
 /** @internal */
@@ -1923,19 +1998,22 @@ export declare class SanityClient {
     operations?: Mutation<R>[]
   ): Transaction
   /**
-   * 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<R = Any>(options: RawRequestOptions): Promise<R>
   /**
-   * 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: string, body: unknown, options?: BaseMutationOptions): Promise<Any>
   /**
@@ -2170,7 +2248,7 @@ export declare type TransactionMutationOptions =
   | TransactionAllDocumentsMutationOptions
   | TransactionAllDocumentIdsMutationOptions
 
-/** @internal */
+/** @public */
 export declare type UnfilteredResponseQueryOptions = RequestOptions & {
   filterResponse: false
 }

package/dist/index.js

@@ -4,14 +4,12 @@ export { adapter as unstable__adapter, environment as unstable__environment } fr
 import { Observable, lastValueFrom } from 'rxjs';
 import { map, filter } from 'rxjs/operators';
 var name = "@sanity/client";
-var version = "5.4.2";
+var version = "5.4.3-dev.1";
 const middleware = [debug({
   verbose: true,
   namespace: "sanity:client"
 }), headers({
   "User-Agent": "".concat(name, " ").concat(version)
-}), retry({
-  maxRetries: 3
 })];
 const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
 class ClientError extends Error {
@@ -98,8 +96,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) {
@@ -112,6 +120,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] : {};
@@ -208,12 +223,12 @@ const requestTag = tag => {
   }
   return tag;
 };
-const encodeQueryString = _ref => {
+const encodeQueryString = _ref2 => {
   let {
     query,
     params = {},
     options = {}
-  } = _ref;
+  } = _ref2;
   const searchParams = new URLSearchParams();
   const {
     tag,
@@ -822,6 +837,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)
   }));
@@ -998,10 +1019,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",
@@ -1052,7 +1073,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];
@@ -1729,21 +1750,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));
@@ -1770,9 +1794,12 @@ const _SanityClient = class {
 let SanityClient = _SanityClient;
 _clientConfig2 = new WeakMap();
 _httpRequest2 = new WeakMap();
-const httpRequest = defineHttpRequest(middleware);
+const httpRequest = defineHttpRequest(middleware, {});
 const requester = httpRequest.defaultRequester;
-const createClient = config => new SanityClient(httpRequest, config);
+const createClient = config => new SanityClient(defineHttpRequest(middleware, {
+  maxRetries: config.maxRetries,
+  retryDelay: config.retryDelay
+}), config);
 function deprecatedCreateClient(config) {
   printNoDefaultExport();
   return new SanityClient(httpRequest, config);