@sanity/client 7.11.1 → 7.11.2-audience-decide.0

package/dist/index.browser.d.cts

@@ -705,6 +705,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * Parameters to pass to Sanity Decide for personalisation
+   */
+  decideParameters?: DecideParameters
   apiHost?: string
   /**
      @remarks
@@ -1135,6 +1139,12 @@ export declare type DatasetsResponse = {
   tags: string[]
 }[]
 
+/** @public */
+export declare interface DecideParameters {
+  audience: string | string[]
+  [key: string]: unknown
+}
+
 /**
  * Deletes the published version of a document and optionally some (likely all known) draft versions.
  * If any draft version exists that is not specified for deletion this is an error.
@@ -1871,6 +1881,21 @@ export declare type ImageDescriptionOperation = {
     }
 )
 
+/** @public */
+export declare type ImportReleaseAction =
+  | {
+      actionType: 'sanity.action.release.import'
+      attributes: IdentifiedSanityDocumentStub
+      releaseId: string
+      ifExists: 'fail' | 'ignore' | 'replace'
+    }
+  | {
+      actionType: 'sanity.action.release.import'
+      document: IdentifiedSanityDocumentStub
+      releaseId: string
+      ifExists: 'fail' | 'ignore' | 'replace'
+    }
+
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
   apiHost: string
@@ -4126,6 +4151,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   cache?: 'next' extends keyof RequestInit ? never : any
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  decideParameters?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   filterResponse?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   headers?: never
@@ -4237,6 +4264,7 @@ export declare type ReleaseAction =
   | ScheduleReleaseAction
   | UnscheduleReleaseAction
   | DeleteReleaseAction
+  | ImportReleaseAction
 
 /** @public */
 export declare type ReleaseCardinality = 'many' | 'one' | undefined
@@ -4634,6 +4662,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  decideParameters?: DecideParameters
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -4666,6 +4695,7 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  decideParameters?: DecideParameters
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/dist/index.browser.d.ts

@@ -705,6 +705,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * Parameters to pass to Sanity Decide for personalisation
+   */
+  decideParameters?: DecideParameters
   apiHost?: string
   /**
      @remarks
@@ -1135,6 +1139,12 @@ export declare type DatasetsResponse = {
   tags: string[]
 }[]
 
+/** @public */
+export declare interface DecideParameters {
+  audience: string | string[]
+  [key: string]: unknown
+}
+
 /**
  * Deletes the published version of a document and optionally some (likely all known) draft versions.
  * If any draft version exists that is not specified for deletion this is an error.
@@ -1871,6 +1881,21 @@ export declare type ImageDescriptionOperation = {
     }
 )
 
+/** @public */
+export declare type ImportReleaseAction =
+  | {
+      actionType: 'sanity.action.release.import'
+      attributes: IdentifiedSanityDocumentStub
+      releaseId: string
+      ifExists: 'fail' | 'ignore' | 'replace'
+    }
+  | {
+      actionType: 'sanity.action.release.import'
+      document: IdentifiedSanityDocumentStub
+      releaseId: string
+      ifExists: 'fail' | 'ignore' | 'replace'
+    }
+
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
   apiHost: string
@@ -4126,6 +4151,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   cache?: 'next' extends keyof RequestInit ? never : any
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  decideParameters?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   filterResponse?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   headers?: never
@@ -4237,6 +4264,7 @@ export declare type ReleaseAction =
   | ScheduleReleaseAction
   | UnscheduleReleaseAction
   | DeleteReleaseAction
+  | ImportReleaseAction
 
 /** @public */
 export declare type ReleaseCardinality = 'many' | 'one' | undefined
@@ -4634,6 +4662,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  decideParameters?: DecideParameters
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -4666,6 +4695,7 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  decideParameters?: DecideParameters
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/dist/index.browser.js

@@ -839,6 +839,32 @@ function requestOptions(config, overrides = {}) {
     fetch: typeof overrides.fetch == "object" && typeof config.fetch == "object" ? { ...config.fetch, ...overrides.fetch } : overrides.fetch || config.fetch
   });
 }
+function isDecideField(value) {
+  return value != null && typeof value == "object" && !Array.isArray(value) && "default" in value && "conditions" in value && Array.isArray(value.conditions);
+}
+function resolveDecideField(field, decideParameters) {
+  const audience = decideParameters.audience, matchingCondition = field.conditions.find((condition) => Array.isArray(audience) ? audience.includes(condition.audience) : condition.audience === audience);
+  return matchingCondition ? matchingCondition.value : field.default;
+}
+function processObjectRecursively(obj, decideParameters) {
+  return obj == null || typeof obj != "object" ? obj : Array.isArray(obj) ? obj.map((item) => processObjectRecursively(item, decideParameters)) : Object.entries(obj).reduce((processed, [key, value]) => {
+    try {
+      isDecideField(value) ? processed[key] = resolveDecideField(value, decideParameters) : processed[key] = processObjectRecursively(value, decideParameters);
+    } catch (error) {
+      console.warn(`Failed to process decide field '${key}':`, error), processed[key] = value;
+    }
+    return processed;
+  }, {});
+}
+function processDecideFields(data, decideParameters) {
+  if (!decideParameters || !decideParameters.audience)
+    return data;
+  try {
+    return processObjectRecursively(data, decideParameters);
+  } catch (error) {
+    return console.warn("Failed to process decide fields:", error), data;
+  }
+}
 const encodeQueryString = ({
   query,
   params = {},
@@ -863,7 +889,7 @@ function _fetch(client, httpRequest, _stega, query, _params = {}, options = {})
   const stega = "stega" in options ? {
     ..._stega || {},
     ...typeof options.stega == "boolean" ? { enabled: options.stega } : options.stega || {}
-  } : _stega, params = stega.enabled ? stegaClean(_params) : _params, mapResponse = options.filterResponse === !1 ? (res) => res : (res) => res.result, { cache, next, ...opts } = {
+  } : _stega, params = stega.enabled ? stegaClean(_params) : _params, mapResponse = options.filterResponse === !1 ? (res) => res : (res) => res.result, processDecideResponse = (response) => options.decideParameters && options.decideParameters.audience ? processDecideFields(response, options.decideParameters) : response, { cache, next, ...opts } = {
     // Opt out of setting a `signal` on an internal `fetch` if one isn't provided.
     // This is necessary in React Server Components to avoid opting out of Request Memoization.
     useAbortSignal: typeof options.signal < "u",
@@ -886,11 +912,11 @@ function _fetch(client, httpRequest, _stega, query, _params = {}, options = {})
     ),
     map(
       ([res, stegaEncodeSourceMap]) => {
-        const result = stegaEncodeSourceMap(res.result, res.resultSourceMap, stega);
-        return mapResponse({ ...res, result });
+        const result = stegaEncodeSourceMap(res.result, res.resultSourceMap, stega), mappedResponse = mapResponse({ ...res, result });
+        return processDecideResponse(mappedResponse);
       }
     )
-  ) : $request.pipe(map(mapResponse));
+  ) : $request.pipe(map(mapResponse), map(processDecideResponse));
 }
 function _getDocument(client, httpRequest, id, opts = {}) {
   const docId = (() => {
@@ -1043,6 +1069,7 @@ function _dataRequest(client, httpRequest, endpoint, body, options = {}) {
     tag,
     returnQuery,
     perspective: options.perspective,
+    decideParameters: options.decideParameters,
     resultSourceMap: options.resultSourceMap,
     lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
     cacheMode,
@@ -1087,7 +1114,15 @@ 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 decideParametersOption = options.decideParameters || config.decideParameters;
+    decideParametersOption && typeof decideParametersOption == "object" && (options.query = {
+      ...options.query,
+      ...Object.keys(decideParametersOption).reduce(
+        (acc, key) => (acc[`decide.${key}`] = decideParametersOption[key], acc),
+        {}
+      )
+    }), 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,