@sanity/client 6.21.2 → 6.21.3-bundle-perspective

package/package.json

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

package/src/SanityClient.ts

@@ -900,7 +900,7 @@ export class SanityClient {
    */
   getDocument<R extends Record<string, Any> = Record<string, Any>>(
     id: string,
-    options?: {tag?: string},
+    options?: {signal?: AbortSignal; tag?: string},
   ): Promise<SanityDocument<R> | undefined> {
     return lastValueFrom(dataMethods._getDocument<R>(this, this.#httpRequest, id, options))
   }
@@ -916,7 +916,7 @@ export class SanityClient {
    */
   getDocuments<R extends Record<string, Any> = Record<string, Any>>(
     ids: string[],
-    options?: {tag?: string},
+    options?: {signal?: AbortSignal; tag?: string},
   ): Promise<(SanityDocument<R> | null)[]> {
     return lastValueFrom(dataMethods._getDocuments<R>(this, this.#httpRequest, ids, options))
   }

package/src/data/dataMethods.ts

@@ -129,9 +129,14 @@ export function _getDocument<R extends Record<string, Any>>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   id: string,
-  opts: {tag?: string} = {},
+  opts: {signal?: AbortSignal; tag?: string} = {},
 ): Observable<SanityDocument<R> | undefined> {
-  const options = {uri: _getDataUrl(client, 'doc', id), json: true, tag: opts.tag}
+  const options = {
+    uri: _getDataUrl(client, 'doc', id),
+    json: true,
+    tag: opts.tag,
+    signal: opts.signal,
+  }
   return _requestObservable<SanityDocument<R> | undefined>(client, httpRequest, options).pipe(
     filter(isResponse),
     map((event) => event.body.documents && event.body.documents[0]),
@@ -143,9 +148,14 @@ export function _getDocuments<R extends Record<string, Any>>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   ids: string[],
-  opts: {tag?: string} = {},
+  opts: {signal?: AbortSignal; tag?: string} = {},
 ): Observable<(SanityDocument<R> | null)[]> {
-  const options = {uri: _getDataUrl(client, 'doc', ids.join(',')), json: true, tag: opts.tag}
+  const options = {
+    uri: _getDataUrl(client, 'doc', ids.join(',')),
+    json: true,
+    tag: opts.tag,
+    signal: opts.signal,
+  }
   return _requestObservable<(SanityDocument<R> | null)[]>(client, httpRequest, options).pipe(
     filter(isResponse),
     map((event: Any) => {
@@ -302,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,
@@ -395,6 +406,7 @@ export function _requestObservable<R>(
       options.query = {resultSourceMap, ...options.query}
     }
     const perspective = options.perspective || config.perspective
+    const bundlePerspective = options.bundlePerspective || config.bundlePerspective
     if (typeof perspective === 'string' && perspective !== 'raw') {
       validateApiPerspective(perspective)
       options.query = {perspective, ...options.query}
@@ -405,6 +417,13 @@ export function _requestObservable<R>(
       }
     }
 
+    if (typeof bundlePerspective === 'string') {
+      if (perspective) {
+        // printWarning()
+      }
+      options.query = {perspective: undefined, bundlePerspective, ...options.query}
+    }
+
     if (options.lastLiveEventId) {
       options.query = {...options.query, lastLiveEventId: options.lastLiveEventId}
     }

package/src/types.ts

@@ -42,6 +42,7 @@ export interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  bundlePerspective?: string
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -221,7 +222,7 @@ export type SanityDocument<T extends Record<string, Any> = Record<string, Any>>
   _createdAt: string
   _updatedAt: string
   /**
-   * Present when `perspective` is set to `previewDrafts`
+   * Present when `perspective` is set to `previewDrafts` or `bundlePerspective` is specified
    */
   _originalId?: string
 }
@@ -306,6 +307,7 @@ export interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string
   lastLiveEventId?: string
 }
 
@@ -372,6 +374,10 @@ export interface SanityProjectMember {
 export 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
@@ -384,6 +390,10 @@ export 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
   }
 }
@@ -463,6 +473,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
@@ -928,6 +940,7 @@ export interface ListenOptions {
 /** @public */
 export interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  bundlePerspective?: string
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean

package/umd/sanityClient.js

@@ -125,8 +125,9 @@
   function __asyncGenerator(thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
     var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
-    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
     function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
     function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
     function fulfill(value) { resume("next", value); }
@@ -1044,8 +1045,7 @@
     let e = JSON.stringify(t);
     return `${u}${Array.from(e).map((r) => {
     let n = r.charCodeAt(0);
-    if (n > 255)
-      throw new Error(`Only ASCII edit info can be encoded. Error attempting to encode ${e} on character ${r} (${n})`);
+    if (n > 255) throw new Error(`Only ASCII edit info can be encoded. Error attempting to encode ${e} on character ${r} (${n})`);
     return Array.from(n.toString(4).padStart(4, "0")).map((o) => String.fromCodePoint(c[o])).join("");
   }).join("")}`;
   }
@@ -1160,8 +1160,7 @@
     ]);
   }
   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 : _$1.shouldRetry(err, attempt, options);
   }
@@ -1700,14 +1699,24 @@ ${selectionOpts}`);
     ) : $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) => {
@@ -1760,6 +1769,7 @@ ${selectionOpts}`);
       tag,
       returnQuery,
       perspective: options.perspective,
+      bundlePerspective: options.bundlePerspective,
       resultSourceMap: options.resultSourceMap,
       lastLiveEventId: Array.isArray(lastLiveEventId) ? lastLiveEventId[0] : lastLiveEventId,
       canUseCdn: isQuery,
@@ -1797,8 +1807,8 @@ ${selectionOpts}`);
     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,
@@ -2852,8 +2862,7 @@ ${selectionOpts}`);
         const { baseUrl, workspace, tool } = resolveStudioBaseRoute(
           typeof config.studioUrl == "function" ? config.studioUrl(sourceDocument) : config.studioUrl
         );
-        if (!baseUrl)
-          return value;
+        if (!baseUrl) return value;
         const { _id: id, _type: type, _projectId: projectId, _dataset: dataset } = sourceDocument;
         return C(
           value,