@sanity/client 7.2.2 → 7.3.0

package/dist/stega.browser.d.cts

@@ -621,6 +621,12 @@ export declare interface ClientConfig {
    * Optional request tag prefix for all request tags
    */
   requestTagPrefix?: string
+  /**
+   * Optional default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
   withCredentials?: boolean
   allowReconfigure?: boolean
@@ -1753,6 +1759,12 @@ export declare interface InitializedClientConfig extends ClientConfig {
    * The fully initialized stega config, can be used to check if stega is enabled
    */
   stega: InitializedStegaConfig
+  /**
+   * Default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
 }
 
 /**

package/dist/stega.browser.d.ts

@@ -621,6 +621,12 @@ export declare interface ClientConfig {
    * Optional request tag prefix for all request tags
    */
   requestTagPrefix?: string
+  /**
+   * Optional default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
   withCredentials?: boolean
   allowReconfigure?: boolean
@@ -1753,6 +1759,12 @@ export declare interface InitializedClientConfig extends ClientConfig {
    * The fully initialized stega config, can be used to check if stega is enabled
    */
   stega: InitializedStegaConfig
+  /**
+   * Default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
 }
 
 /**

package/dist/stega.d.cts

@@ -621,6 +621,12 @@ export declare interface ClientConfig {
    * Optional request tag prefix for all request tags
    */
   requestTagPrefix?: string
+  /**
+   * Optional default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
   withCredentials?: boolean
   allowReconfigure?: boolean
@@ -1753,6 +1759,12 @@ export declare interface InitializedClientConfig extends ClientConfig {
    * The fully initialized stega config, can be used to check if stega is enabled
    */
   stega: InitializedStegaConfig
+  /**
+   * Default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
 }
 
 /**

package/dist/stega.d.ts

@@ -621,6 +621,12 @@ export declare interface ClientConfig {
    * Optional request tag prefix for all request tags
    */
   requestTagPrefix?: string
+  /**
+   * Optional default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
   withCredentials?: boolean
   allowReconfigure?: boolean
@@ -1753,6 +1759,12 @@ export declare interface InitializedClientConfig extends ClientConfig {
    * The fully initialized stega config, can be used to check if stega is enabled
    */
   stega: InitializedStegaConfig
+  /**
+   * Default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
 }
 
 /**

package/package.json

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

package/src/http/requestOptions.ts

@@ -7,6 +7,10 @@ const projectHeader = 'X-Sanity-Project-ID'
 export function requestOptions(config: Any, overrides: Any = {}): Omit<RequestOptions, 'url'> {
   const headers: Any = {}
 
+  if (config.headers) {
+    Object.assign(headers, config.headers)
+  }
+
   const token = overrides.token || config.token
   if (token) {
     headers.Authorization = `Bearer ${token}`

package/src/types.ts

@@ -102,6 +102,14 @@ export interface ClientConfig {
    * Optional request tag prefix for all request tags
    */
   requestTagPrefix?: string
+
+  /**
+   * Optional default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
+
   ignoreBrowserTokenWarning?: boolean
   withCredentials?: boolean
   allowReconfigure?: boolean
@@ -173,6 +181,12 @@ export interface InitializedClientConfig extends ClientConfig {
    * The fully initialized stega config, can be used to check if stega is enabled
    */
   stega: InitializedStegaConfig
+  /**
+   * Default headers to include with all requests
+   *
+   * @remarks request-specific headers will override any default headers with the same name.
+   */
+  headers?: Record<string, string>
 }
 
 /** @public */

package/umd/sanityClient.js

@@ -2695,7 +2695,9 @@ ${selectionOpts}`);
   }
   const projectHeader = "X-Sanity-Project-ID";
   function requestOptions(config, overrides = {}) {
-    const headers = {}, token = overrides.token || config.token;
+    const headers = {};
+    config.headers && Object.assign(headers, config.headers);
+    const token = overrides.token || config.token;
     token && (headers.Authorization = `Bearer ${token}`), !overrides.useGlobalApi && !config.useProjectHostname && config.projectId && (headers[projectHeader] = config.projectId);
     const withCredentials = !!(typeof overrides.withCredentials > "u" ? config.withCredentials : overrides.withCredentials), timeout = typeof overrides.timeout > "u" ? config.timeout : overrides.timeout;
     return Object.assign({}, overrides, {