@sanity/client 7.11.2 → 7.12.0

package/dist/stega.browser.d.cts

@@ -780,6 +780,10 @@ export declare interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+  /**
+   * Lineage token for recursion control
+   */
+  lineage?: string
 }
 
 declare type ClientConfigResource =

package/dist/stega.browser.d.ts

@@ -780,6 +780,10 @@ export declare interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+  /**
+   * Lineage token for recursion control
+   */
+  lineage?: string
 }
 
 declare type ClientConfigResource =

package/dist/stega.d.cts

@@ -780,6 +780,10 @@ export declare interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+  /**
+   * Lineage token for recursion control
+   */
+  lineage?: string
 }
 
 declare type ClientConfigResource =

package/dist/stega.d.ts

@@ -780,6 +780,10 @@ export declare interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+  /**
+   * Lineage token for recursion control
+   */
+  lineage?: string
 }
 
 declare type ClientConfigResource =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "7.11.2",
+  "version": "7.12.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/defineCreateClient.ts

@@ -56,6 +56,7 @@ export default function defineCreateClientExports<
           maxRedirects: 0,
           maxRetries: config.maxRetries,
           retryDelay: config.retryDelay,
+          lineage: config.lineage,
           ...options,
         } as Any),
       config,

package/src/http/nodeMiddleware.ts

@@ -1,11 +1,28 @@
+import type {Middleware, RequestOptions} from 'get-it'
 import {agent, debug, headers} from 'get-it/middleware'
 
 import {name, version} from '../../package.json'
 
-const middleware = [
+const middleware: Middleware[] = [
   debug({verbose: true, namespace: 'sanity:client'}),
   headers({'User-Agent': `${name} ${version}`}),
 
+  // Lineage is used for recursion control/tracing and can be passed either through
+  // client constructor or through environent variable.
+  // Not used in browser environments.
+  {
+    processOptions(opts: RequestOptions & {lineage?: string}) {
+      const lineage =
+        (typeof process !== 'undefined' && process.env.X_SANITY_LINEAGE) || opts.lineage
+
+      if (lineage) {
+        opts.headers = opts.headers || {}
+        opts.headers['x-sanity-lineage'] = lineage
+      }
+      return opts
+    },
+  },
+
   // Enable keep-alive, and in addition limit the number of sockets that can be opened.
   // This avoids opening too many connections to the server if someone tries to execute
   // a bunch of requests in parallel. It's recommended to have a concurrency limit

package/src/http/request.ts

@@ -58,10 +58,14 @@ function printWarnings(config: {ignoreWarnings?: string | RegExp | Array<string
   }
 }
 
+type HttpRequestConfig = {
+  ignoreWarnings?: string | RegExp | Array<string | RegExp>
+}
+
 /** @internal */
 export function defineHttpRequest(
   envMiddleware: Middlewares,
-  config: {ignoreWarnings?: string | RegExp | Array<string | RegExp>} = {},
+  config: HttpRequestConfig = {},
 ): Requester {
   return getIt([
     retry({shouldRetry}),

package/src/types.ts

@@ -179,6 +179,10 @@ export interface ClientConfig {
    * Options for how, if enabled, Content Source Maps are encoded into query results using steganography
    */
   stega?: StegaConfig | boolean
+  /**
+   * Lineage token for recursion control
+   */
+  lineage?: string
 }
 
 /** @public */

package/umd/sanityClient.js

@@ -4801,6 +4801,7 @@ ${selectionOpts}`);
           maxRedirects: 0,
           maxRetries: config.maxRetries,
           retryDelay: config.retryDelay,
+          lineage: config.lineage,
           ...options
         }),
         config