@sanity/client 6.21.2 → 6.21.3-bundle-perspective

package/dist/index.browser.d.cts

@@ -331,6 +331,7 @@ export declare interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  bundlePerspective?: string
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -2012,6 +2013,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
@@ -2114,6 +2117,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string
   lastLiveEventId?: string
 }
 
@@ -2145,6 +2149,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
@@ -2269,6 +2274,7 @@ export declare class SanityClient {
   getDocument<R extends Record<string, Any> = Record<string, Any>>(
     id: string,
     options?: {
+      signal?: AbortSignal
       tag?: string
     },
   ): Promise<SanityDocument<R> | undefined>
@@ -2284,6 +2290,7 @@ export declare class SanityClient {
   getDocuments<R extends Record<string, Any> = Record<string, Any>>(
     ids: string[],
     options?: {
+      signal?: AbortSignal
       tag?: string
     },
   ): Promise<(SanityDocument<R> | null)[]>
@@ -2699,7 +2706,7 @@ export declare type SanityDocument<T extends Record<string, Any> = Record<string
   _createdAt: string
   _updatedAt: string
   /**
-   * Present when `perspective` is set to `previewDrafts`
+   * Present when `perspective` is set to `previewDrafts` or `bundlePerspective` is specified
    */
   _originalId?: string
 }
@@ -2758,6 +2765,10 @@ export declare interface SanityImagePalette {
 export declare interface SanityProject {
   id: string
   displayName: string
+  /**
+   * @deprecated Use the `/user-applications` endpoint instead, which lists all deployed studios/applications
+   * @see https://www.sanity.io/help/studio-host-user-applications
+   */
   studioHost: string | null
   organizationId: string | null
   isBlocked: boolean
@@ -2770,6 +2781,10 @@ export declare interface SanityProject {
   metadata: {
     cliInitializedAt?: string
     color?: string
+    /**
+     * @deprecated Use the `/user-applications` endpoint instead, which lists all deployed studios/applications
+     * @see https://www.sanity.io/help/studio-host-user-applications
+     */
     externalStudioHost?: string
   }
 }

package/dist/index.browser.d.ts

@@ -331,6 +331,7 @@ export declare interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  bundlePerspective?: string
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -2012,6 +2013,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
@@ -2114,6 +2117,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string
   lastLiveEventId?: string
 }
 
@@ -2145,6 +2149,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
@@ -2269,6 +2274,7 @@ export declare class SanityClient {
   getDocument<R extends Record<string, Any> = Record<string, Any>>(
     id: string,
     options?: {
+      signal?: AbortSignal
       tag?: string
     },
   ): Promise<SanityDocument<R> | undefined>
@@ -2284,6 +2290,7 @@ export declare class SanityClient {
   getDocuments<R extends Record<string, Any> = Record<string, Any>>(
     ids: string[],
     options?: {
+      signal?: AbortSignal
       tag?: string
     },
   ): Promise<(SanityDocument<R> | null)[]>
@@ -2699,7 +2706,7 @@ export declare type SanityDocument<T extends Record<string, Any> = Record<string
   _createdAt: string
   _updatedAt: string
   /**
-   * Present when `perspective` is set to `previewDrafts`
+   * Present when `perspective` is set to `previewDrafts` or `bundlePerspective` is specified
    */
   _originalId?: string
 }
@@ -2758,6 +2765,10 @@ export declare interface SanityImagePalette {
 export declare interface SanityProject {
   id: string
   displayName: string
+  /**
+   * @deprecated Use the `/user-applications` endpoint instead, which lists all deployed studios/applications
+   * @see https://www.sanity.io/help/studio-host-user-applications
+   */
   studioHost: string | null
   organizationId: string | null
   isBlocked: boolean
@@ -2770,6 +2781,10 @@ export declare interface SanityProject {
   metadata: {
     cliInitializedAt?: string
     color?: string
+    /**
+     * @deprecated Use the `/user-applications` endpoint instead, which lists all deployed studios/applications
+     * @see https://www.sanity.io/help/studio-host-user-applications
+     */
     externalStudioHost?: string
   }
 }

package/dist/index.browser.js

@@ -87,8 +87,7 @@ function defineHttpRequest(envMiddleware2) {
   ]);
 }
 function shouldRetry(err, attempt, options) {
-  if (options.maxRetries === 0)
-    return !1;
+  if (options.maxRetries === 0) return !1;
   const isSafe = options.method === "GET" || options.method === "HEAD", isQuery = (options.uri || options.url).startsWith("/data/query"), isRetriableResponse = err.response && (err.response.statusCode === 429 || err.response.statusCode === 502 || err.response.statusCode === 503);
   return (isSafe || isQuery) && isRetriableResponse ? !0 : retry.shouldRetry(err, attempt, options);
 }
@@ -627,14 +626,24 @@ function _fetch(client, httpRequest, _stega, query, _params = {}, options = {})
   ) : $request.pipe(map(mapResponse));
 }
 function _getDocument(client, httpRequest, id, opts = {}) {
-  const options = { uri: _getDataUrl(client, "doc", id), json: !0, tag: opts.tag };
+  const options = {
+    uri: _getDataUrl(client, "doc", id),
+    json: !0,
+    tag: opts.tag,
+    signal: opts.signal
+  };
   return _requestObservable(client, httpRequest, options).pipe(
     filter(isResponse),
     map((event) => event.body.documents && event.body.documents[0])
   );
 }
 function _getDocuments(client, httpRequest, ids, opts = {}) {
-  const options = { uri: _getDataUrl(client, "doc", ids.join(",")), json: !0, tag: opts.tag };
+  const options = {
+    uri: _getDataUrl(client, "doc", ids.join(",")),
+    json: !0,
+    tag: opts.tag,
+    signal: opts.signal
+  };
   return _requestObservable(client, httpRequest, options).pipe(
     filter(isResponse),
     map((event) => {
@@ -687,6 +696,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,
@@ -724,8 +734,8 @@ function _requestObservable(client, httpRequest, options) {
   if (tag && options.tag !== null && (options.query = { tag: requestTag(tag), ...options.query }), ["GET", "HEAD", "POST"].indexOf(options.method || "GET") >= 0 && uri.indexOf("/data/query/") === 0) {
     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 });
+    const perspective = options.perspective || config.perspective, bundlePerspective = options.bundlePerspective || config.bundlePerspective;
+    typeof perspective == "string" && perspective !== "raw" && (validateApiPerspective(perspective), options.query = { perspective, ...options.query }, perspective === "previewDrafts" && useCdn && (useCdn = !1, printCdnPreviewDraftsWarning())), typeof bundlePerspective == "string" && (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,