@sanity/client 7.23.2 → 7.24.0

package/dist/stega.browser.d.cts

@@ -719,6 +719,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -880,6 +884,18 @@ export declare type ClientReturn<
  */
 export declare interface ClientStegaConfig extends ClientConfig {}
 
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariant = ClientVariantConditions | string
+
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariantConditions = Record<string, string>
+
 /**
  * Sanity API specific EventSource handler shared between the listen and live APIs
  *
@@ -4526,6 +4542,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   perspective?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  variant?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   query?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
@@ -5066,6 +5084,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -5114,6 +5136,10 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/dist/stega.browser.d.ts

@@ -719,6 +719,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -880,6 +884,18 @@ export declare type ClientReturn<
  */
 export declare interface ClientStegaConfig extends ClientConfig {}
 
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariant = ClientVariantConditions | string
+
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariantConditions = Record<string, string>
+
 /**
  * Sanity API specific EventSource handler shared between the listen and live APIs
  *
@@ -4526,6 +4542,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   perspective?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  variant?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   query?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
@@ -5066,6 +5084,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -5114,6 +5136,10 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/dist/stega.d.cts

@@ -719,6 +719,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -880,6 +884,18 @@ export declare type ClientReturn<
  */
 export declare interface ClientStegaConfig extends ClientConfig {}
 
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariant = ClientVariantConditions | string
+
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariantConditions = Record<string, string>
+
 /**
  * Sanity API specific EventSource handler shared between the listen and live APIs
  *
@@ -4526,6 +4542,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   perspective?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  variant?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   query?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
@@ -5066,6 +5084,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -5114,6 +5136,10 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/dist/stega.d.ts

@@ -719,6 +719,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -880,6 +884,18 @@ export declare type ClientReturn<
  */
 export declare interface ClientStegaConfig extends ClientConfig {}
 
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariant = ClientVariantConditions | string
+
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariantConditions = Record<string, string>
+
 /**
  * Sanity API specific EventSource handler shared between the listen and live APIs
  *
@@ -4526,6 +4542,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   perspective?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  variant?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   query?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
@@ -5066,6 +5084,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -5114,6 +5136,10 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/package.json

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

package/src/data/dataMethods.ts

@@ -549,6 +549,7 @@ export function _dataRequest(
     tag,
     returnQuery,
     perspective: options.perspective,
+    variant: options.variant,
     resultSourceMap: options.resultSourceMap,
     lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
     cacheMode: cacheMode,
@@ -700,6 +701,36 @@ export function _requestObservable<R>(
       }
     }
 
+    const variantOption = options.variant || config.variant
+
+    if (typeof variantOption !== 'undefined') {
+      if (typeof variantOption === 'string') {
+        options.query = {
+          variant: variantOption,
+          ...options.query,
+        }
+      }
+
+      if (typeof variantOption === 'object') {
+        const variantConditions = Object.entries(variantOption)
+        const searchParams = variantConditionPairsToSearchParams(variantConditions).slice(0, 1)
+
+        if (variantConditions.length > 1) {
+          const formatter = new Intl.ListFormat('en')
+
+          // eslint-disable-next-line no-console -- will be removed in an upcoming version; it's better this behaviour is noisy and obvious
+          console.warn(
+            `The Sanity client's beta \`variant\` option currently only supports one condition. Dropped: ${formatter.format(variantConditions.slice(1).map(([subject]) => JSON.stringify(subject)))}.`,
+          )
+        }
+
+        options.query = {
+          ...Object.fromEntries(searchParams),
+          ...options.query,
+        }
+      }
+    }
+
     if (options.lastLiveEventId) {
       options.query = {...options.query, lastLiveEventId: options.lastLiveEventId}
     }
@@ -843,3 +874,12 @@ const resourceDataBase = (config: InitializedClientConfig): string => {
       throw new Error(`Unsupported resource type: ${type.toString()}`)
   }
 }
+
+function variantConditionPairsToSearchParams(
+  variantConditionPairs: string[][],
+): ['variantCondition', `${string}:${string}`][] {
+  return variantConditionPairs.map(([condition, value]) => [
+    'variantCondition',
+    `${condition}:${value}`,
+  ])
+}

package/src/types.ts

@@ -55,6 +55,18 @@ export type ClientPerspective =
   | 'raw'
   | StackablePerspective[]
 
+/**
+ * @public
+ * @beta
+ */
+export type ClientVariantConditions = Record<string, string>
+
+/**
+ * @public
+ * @beta
+ */
+export type ClientVariant = ClientVariantConditions | string
+
 type ClientConfigResource =
   | {
       type: 'canvas'
@@ -111,6 +123,10 @@ export interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
 
   /**
@@ -484,6 +500,10 @@ export interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -679,6 +699,8 @@ export interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   perspective?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  variant?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   query?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
@@ -1424,6 +1446,10 @@ export interface ResumableListenOptions extends Omit<ListenOptions, 'events' | '
 /** @public */
 export interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/umd/sanityClient.js

@@ -3096,6 +3096,7 @@ ${selectionOpts}`);
       tag,
       returnQuery,
       perspective: options.perspective,
+      variant: options.variant,
       resultSourceMap: options.resultSourceMap,
       lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
       cacheMode,
@@ -3143,7 +3144,25 @@ ${selectionOpts}`);
         perspective: Array.isArray(perspectiveOption) ? perspectiveOption.join(",") : perspectiveOption,
         ...options.query
       }, (Array.isArray(perspectiveOption) && perspectiveOption.length > 0 || // previewDrafts was renamed to drafts, but keep for backwards compat
-      perspectiveOption === "previewDrafts" || perspectiveOption === "drafts") && useCdn && (useCdn = false, printCdnPreviewDraftsWarning())), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === false && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
+      perspectiveOption === "previewDrafts" || perspectiveOption === "drafts") && useCdn && (useCdn = false, printCdnPreviewDraftsWarning()));
+      const variantOption = options.variant || config.variant;
+      if (typeof variantOption < "u" && (typeof variantOption == "string" && (options.query = {
+        variant: variantOption,
+        ...options.query
+      }), typeof variantOption == "object")) {
+        const variantConditions = Object.entries(variantOption), searchParams = variantConditionPairsToSearchParams(variantConditions).slice(0, 1);
+        if (variantConditions.length > 1) {
+          const formatter = new Intl.ListFormat("en");
+          console.warn(
+            `The Sanity client's beta \`variant\` option currently only supports one condition. Dropped: ${formatter.format(variantConditions.slice(1).map(([subject]) => JSON.stringify(subject)))}.`
+          );
+        }
+        options.query = {
+          ...Object.fromEntries(searchParams),
+          ...options.query
+        };
+      }
+      options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === false && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
     }
     const reqOptions = requestOptions(
       config,
@@ -3218,6 +3237,12 @@ ${selectionOpts}`);
         throw new Error(`Unsupported resource type: ${type.toString()}`);
     }
   };
+  function variantConditionPairsToSearchParams(variantConditionPairs) {
+    return variantConditionPairs.map(([condition, value]) => [
+      "variantCondition",
+      `${condition}:${value}`
+    ]);
+  }
   function _generate(client, httpRequest, request) {
     const dataset2 = hasDataset(client.config());
     return _request(client, httpRequest, {