@sanity/client 6.22.1 → 6.22.2-bundle-perspective

package/dist/index.d.cts

@@ -331,6 +331,8 @@ export declare interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  /** @defaultValue 'raw' */
+  bundlePerspective?: string[]
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -919,10 +921,17 @@ export declare class LiveClient {
    */
   events({
     includeDrafts,
+    tag: _tag,
   }?: {
     /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
-  }): Observable<LiveEventMessage | LiveEventRestart>
+    /**
+     * Optional request tag for the listener. Use to identify the request in logs.
+     *
+     * @defaultValue `undefined`
+     */
+    tag?: string
+  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
 }
 
 /** @public */
@@ -932,9 +941,20 @@ export declare interface LiveEventMessage {
   tags: SyncTag[]
 }
 
+/** @public */
+export declare interface LiveEventReconnect {
+  type: 'reconnect'
+}
+
 /** @public */
 export declare interface LiveEventRestart {
   type: 'restart'
+  id: string
+}
+
+/** @public */
+export declare interface LiveEventWelcome {
+  type: 'welcome'
 }
 
 /** @public */
@@ -2017,6 +2037,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 */
+  bundlePerspective?: 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
@@ -2119,6 +2141,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string[]
   lastLiveEventId?: string
 }
 
@@ -2150,6 +2173,7 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  bundlePerspective?: string[]
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/dist/index.d.ts

@@ -331,6 +331,8 @@ export declare interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  /** @defaultValue 'raw' */
+  bundlePerspective?: string[]
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -919,10 +921,17 @@ export declare class LiveClient {
    */
   events({
     includeDrafts,
+    tag: _tag,
   }?: {
     /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
-  }): Observable<LiveEventMessage | LiveEventRestart>
+    /**
+     * Optional request tag for the listener. Use to identify the request in logs.
+     *
+     * @defaultValue `undefined`
+     */
+    tag?: string
+  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
 }
 
 /** @public */
@@ -932,9 +941,20 @@ export declare interface LiveEventMessage {
   tags: SyncTag[]
 }
 
+/** @public */
+export declare interface LiveEventReconnect {
+  type: 'reconnect'
+}
+
 /** @public */
 export declare interface LiveEventRestart {
   type: 'restart'
+  id: string
+}
+
+/** @public */
+export declare interface LiveEventWelcome {
+  type: 'welcome'
 }
 
 /** @public */
@@ -2017,6 +2037,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 */
+  bundlePerspective?: 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
@@ -2119,6 +2141,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string[]
   lastLiveEventId?: string
 }
 
@@ -2150,6 +2173,7 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  bundlePerspective?: string[]
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/dist/index.js

@@ -519,6 +519,11 @@ const validateApiPerspective = function(perspective) {
         "Invalid API perspective string, expected `published`, `previewDrafts` or `raw`"
       );
   }
+}, validateApiBundlePerspective = function(perspective, bundlePerspective) {
+  if (perspective !== "raw" && bundlePerspective)
+    throw new TypeError(
+      "Invalid, perspective and bundlePerspective parameters are mutually exclusive"
+    );
 }, initConfig = (config, prevConfig) => {
   const specifiedConfig = {
     ...prevConfig,
@@ -697,6 +702,7 @@ function _dataRequest(client, httpRequest, endpoint, body, options = {}) {
     tag,
     returnQuery,
     perspective: options.perspective,
+    bundlePerspective: options.bundlePerspective,
     resultSourceMap: options.resultSourceMap,
     lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
     canUseCdn: isQuery,
@@ -735,7 +741,9 @@ function _requestObservable(client, httpRequest, options) {
     const resultSourceMap = options.resultSourceMap ?? config.resultSourceMap;
     resultSourceMap !== void 0 && resultSourceMap !== !1 && (options.query = { resultSourceMap, ...options.query });
     const perspective = options.perspective || config.perspective;
-    typeof perspective == "string" && perspective !== "raw" && (validateApiPerspective(perspective), options.query = { perspective, ...options.query }, perspective === "previewDrafts" && useCdn && (useCdn = !1, printCdnPreviewDraftsWarning())), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query });
+    typeof perspective == "string" && perspective !== "raw" && (validateApiPerspective(perspective), options.query = { perspective, ...options.query }, perspective === "previewDrafts" && useCdn && (useCdn = !1, printCdnPreviewDraftsWarning()));
+    const bundlePerspective = options.bundlePerspective || config.bundlePerspective;
+    Array.isArray(bundlePerspective) && bundlePerspective.length > 0 && (validateApiBundlePerspective(perspective, bundlePerspective), options.query = { perspective: void 0, bundlePerspective, ...options.query }), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query });
   }
   const reqOptions = requestOptions(
     config,
@@ -927,27 +935,33 @@ class LiveClient {
    * Requires `apiVersion` to be `2021-03-26` or later.
    */
   events({
-    includeDrafts = !1
+    includeDrafts = !1,
+    tag: _tag
   } = {}) {
-    const { apiVersion: _apiVersion, token } = this.#client.config(), apiVersion = _apiVersion.replace(/^v/, "");
+    const {
+      apiVersion: _apiVersion,
+      token,
+      withCredentials,
+      requestTagPrefix
+    } = this.#client.config(), apiVersion = _apiVersion.replace(/^v/, "");
     if (apiVersion !== "X" && apiVersion < requiredApiVersion)
       throw new Error(
         `The live events API requires API version ${requiredApiVersion} or later. The current API version is ${apiVersion}. Please update your API version to use this feature.`
       );
-    if (includeDrafts && !token)
+    if (includeDrafts && !token && !withCredentials)
       throw new Error(
-        "The live events API requires a token when 'includeDrafts: true'. Please update your client configuration. The token should have the lowest possible access role."
+        "The live events API requires a token or withCredentials when 'includeDrafts: true'. Please update your client configuration. The token should have the lowest possible access role."
       );
     if (includeDrafts && apiVersion !== "X")
       throw new Error(
         "The live events API requires API version X when 'includeDrafts: true'. This API is experimental and may change or even be removed."
       );
-    const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1));
-    includeDrafts && url.searchParams.set("includeDrafts", "true");
-    const listenFor = ["restart", "message"], esOptions = {};
+    const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1)), tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join(".") : _tag;
+    tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true");
+    const listenFor = ["restart", "message", "welcome", "reconnect"], esOptions = {};
     return includeDrafts && token && (esOptions.headers = {
       Authorization: `Bearer ${token}`
-    }), new Observable((observer) => {
+    }), includeDrafts && withCredentials && (esOptions.withCredentials = !0), new Observable((observer) => {
       let es, reconnectTimer, stopped = !1, unsubscribed = !1;
       open();
       function onError(evt) {
@@ -972,7 +986,7 @@ class LiveClient {
         }
       }
       async function getEventSource() {
-        const EventSourceImplementation = typeof EventSource > "u" || esOptions.headers ? (await import("@sanity/eventsource")).default : EventSource;
+        const EventSourceImplementation = typeof EventSource > "u" || esOptions.headers || esOptions.withCredentials ? (await import("@sanity/eventsource")).default : EventSource;
         if (unsubscribed)
           return;
         const evs = new EventSourceImplementation(url.toString(), esOptions);
@@ -1519,7 +1533,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "6.22.1";
+var name = "@sanity/client", version = "6.22.2-bundle-perspective";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),