@sanity/client 6.22.1 → 6.22.2-bundle-perspective-1

package/package.json

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

package/src/config.ts

@@ -41,6 +41,16 @@ export const validateApiPerspective = function validateApiPerspective(perspectiv
   }
 }
 
+export const validateApiBundlePerspective = function validateApiBundlePerspective(
+  perspective?: string,
+  bundlePerspective?: string[],
+) {
+  if (perspective !== 'raw' && bundlePerspective) {
+    throw new TypeError(
+      'Invalid, perspective and bundlePerspective parameters are mutually exclusive',
+    )
+  }
+}
 export const initConfig = (
   config: Partial<ClientConfig>,
   prevConfig: Partial<ClientConfig>,

package/src/data/dataMethods.ts

@@ -1,7 +1,7 @@
 import {from, type MonoTypeOperatorFunction, Observable} from 'rxjs'
 import {combineLatestWith, filter, map} from 'rxjs/operators'
 
-import {validateApiPerspective} from '../config'
+import {validateApiBundlePerspective, validateApiPerspective} from '../config'
 import {requestOptions} from '../http/requestOptions'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import {stegaClean} from '../stega/stegaClean'
@@ -312,6 +312,7 @@ export function _dataRequest(
     tag,
     returnQuery,
     perspective: options.perspective,
+    bundlePerspective: options.bundlePerspective,
     resultSourceMap: options.resultSourceMap,
     lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
     canUseCdn: isQuery,
@@ -415,6 +416,16 @@ export function _requestObservable<R>(
       }
     }
 
+    const bundlePerspective = options.bundlePerspective || config.bundlePerspective
+    if (Array.isArray(bundlePerspective) && bundlePerspective.length > 0) {
+      validateApiBundlePerspective(perspective, bundlePerspective)
+      options.query = {
+        perspective: undefined,
+        bundlePerspective: bundlePerspective.join(','),
+        ...options.query,
+      }
+    }
+
     if (options.lastLiveEventId) {
       options.query = {...options.query, lastLiveEventId: options.lastLiveEventId}
     }

package/src/data/live.ts

@@ -1,7 +1,13 @@
 import {Observable} from 'rxjs'
 
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
-import type {Any, LiveEventMessage, LiveEventRestart} from '../types'
+import type {
+  Any,
+  LiveEventMessage,
+  LiveEventReconnect,
+  LiveEventRestart,
+  LiveEventWelcome,
+} from '../types'
 import {_getDataUrl} from './dataMethods'
 
 const requiredApiVersion = '2021-03-26'
@@ -20,11 +26,23 @@ export class LiveClient {
    */
   events({
     includeDrafts = false,
+    tag: _tag,
   }: {
     /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
-  } = {}): Observable<LiveEventMessage | LiveEventRestart> {
-    const {apiVersion: _apiVersion, token} = this.#client.config()
+    /**
+     * Optional request tag for the listener. Use to identify the request in logs.
+     *
+     * @defaultValue `undefined`
+     */
+    tag?: string
+  } = {}): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome> {
+    const {
+      apiVersion: _apiVersion,
+      token,
+      withCredentials,
+      requestTagPrefix,
+    } = this.#client.config()
     const apiVersion = _apiVersion.replace(/^v/, '')
     if (apiVersion !== 'X' && apiVersion < requiredApiVersion) {
       throw new Error(
@@ -33,9 +51,9 @@ export class LiveClient {
           `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') {
@@ -45,17 +63,24 @@ export class LiveClient {
     }
     const path = _getDataUrl(this.#client, 'live/events')
     const url = new URL(this.#client.getUrl(path, false))
+    const tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join('.') : _tag
+    if (tag) {
+      url.searchParams.set('tag', tag)
+    }
     if (includeDrafts) {
       url.searchParams.set('includeDrafts', 'true')
     }
 
-    const listenFor = ['restart', 'message'] as const
+    const listenFor = ['restart', 'message', 'welcome', 'reconnect'] as const
     const esOptions: EventSourceInit & {headers?: Record<string, string>} = {}
     if (includeDrafts && token) {
       esOptions.headers = {
         Authorization: `Bearer ${token}`,
       }
     }
+    if (includeDrafts && withCredentials) {
+      esOptions.withCredentials = true
+    }
 
     return new Observable((observer) => {
       let es: InstanceType<typeof EventSource> | undefined
@@ -108,7 +133,7 @@ export class LiveClient {
 
       async function getEventSource() {
         const EventSourceImplementation: typeof EventSource =
-          typeof EventSource === 'undefined' || esOptions.headers
+          typeof EventSource === 'undefined' || esOptions.headers || esOptions.withCredentials
             ? ((await import('@sanity/eventsource')).default as unknown as typeof EventSource)
             : EventSource
 

package/src/types.ts

@@ -42,6 +42,8 @@ export interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  /** @defaultValue 'raw' */
+  bundlePerspective?: string[]
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -306,6 +308,7 @@ export interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string[]
   lastLiveEventId?: string
 }
 
@@ -471,6 +474,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 */
+  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
@@ -937,6 +942,7 @@ export interface ListenOptions {
 /** @public */
 export interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  bundlePerspective?: string[]
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean
@@ -1244,6 +1250,11 @@ export type SyncTag = `s1:${string}`
 /** @public */
 export interface LiveEventRestart {
   type: 'restart'
+  id: string
+}
+/** @public */
+export interface LiveEventReconnect {
+  type: 'reconnect'
 }
 /** @public */
 export interface LiveEventMessage {
@@ -1251,6 +1262,10 @@ export interface LiveEventMessage {
   id: string
   tags: SyncTag[]
 }
+/** @public */
+export interface LiveEventWelcome {
+  type: 'welcome'
+}
 
 /** @public */
 export interface SanityQueries {}

package/umd/sanityClient.js

@@ -1592,6 +1592,11 @@ ${selectionOpts}`);
           "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,
@@ -1770,6 +1775,7 @@ ${selectionOpts}`);
       tag,
       returnQuery,
       perspective: options.perspective,
+      bundlePerspective: options.bundlePerspective,
       resultSourceMap: options.resultSourceMap,
       lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
       canUseCdn: isQuery,
@@ -1808,7 +1814,13 @@ ${selectionOpts}`);
       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: bundlePerspective.join(","),
+        ...options.query
+      }), options.lastLiveEventId && (options.query = { ...options.query, lastLiveEventId: options.lastLiveEventId }), options.returnQuery === !1 && (options.query = { returnQuery: "false", ...options.query });
     }
     const reqOptions = requestOptions(
       config,
@@ -2000,27 +2012,33 @@ ${selectionOpts}`);
      * 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) {
@@ -2045,7 +2063,7 @@ ${selectionOpts}`);
           }
         }
         async function getEventSource() {
-          const EventSourceImplementation = typeof EventSource > "u" || esOptions.headers ? (await Promise.resolve().then(function () { return browser$2; })).default : EventSource;
+          const EventSourceImplementation = typeof EventSource > "u" || esOptions.headers || esOptions.withCredentials ? (await Promise.resolve().then(function () { return browser$2; })).default : EventSource;
           if (unsubscribed)
             return;
           const evs = new EventSourceImplementation(url.toString(), esOptions);