@sanity/client 7.23.2 → 7.24.0

package/dist/index.browser.d.cts

@@ -725,6 +725,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -888,6 +892,18 @@ export declare type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
+/**
+ * @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
  *
@@ -4356,6 +4372,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
@@ -4893,6 +4911,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -4938,6 +4960,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/index.browser.d.ts

@@ -725,6 +725,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -888,6 +892,18 @@ export declare type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
+/**
+ * @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
  *
@@ -4356,6 +4372,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
@@ -4893,6 +4911,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -4938,6 +4960,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/index.browser.js

@@ -1110,6 +1110,7 @@ function _dataRequest(client, httpRequest, endpoint, body, options = {}) {
     tag,
     returnQuery,
     perspective: options.perspective,
+    variant: options.variant,
     resultSourceMap: options.resultSourceMap,
     lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
     cacheMode,
@@ -1157,7 +1158,25 @@ function _requestObservable(client, httpRequest, options) {
       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 = !1, printCdnPreviewDraftsWarning())), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
+    perspectiveOption === "previewDrafts" || perspectiveOption === "drafts") && useCdn && (useCdn = !1, 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 === !1 && (options.query = { returnQuery: "false", ...options.query }), useCdn && options.cacheMode == "noStale" && (options.query = { cacheMode: "noStale", ...options.query });
   }
   const reqOptions = requestOptions(
     config,
@@ -1232,6 +1251,12 @@ const resourceDataBase = (config) => {
       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, {