@sanity/client 6.21.1 → 6.21.3-bundle-perspective

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.21.1",
+  "version": "6.21.3-bundle-perspective",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -118,39 +118,39 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^5.0.2",
-    "get-it": "^8.6.3",
+    "get-it": "^8.6.4",
     "rxjs": "^7.0.0"
   },
   "devDependencies": {
-    "@edge-runtime/types": "^3.0.0",
-    "@edge-runtime/vm": "^4.0.0",
+    "@edge-runtime/types": "^3.0.1",
+    "@edge-runtime/vm": "^4.0.1",
     "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@sanity/pkg-utils": "^6.9.3",
+    "@sanity/pkg-utils": "^6.10.9",
     "@types/json-diff": "^1.0.3",
     "@types/node": "^20.8.8",
-    "@typescript-eslint/eslint-plugin": "^7.13.1",
-    "@typescript-eslint/parser": "^7.13.1",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "@vercel/stega": "0.1.2",
-    "@vitest/coverage-v8": "2.0.2",
+    "@vitest/coverage-v8": "2.0.5",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-simple-import-sort": "^12.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
     "faucet": "^0.0.4",
     "happy-dom": "^12.10.3",
     "json-diff": "^1.0.6",
-    "ls-engines": "^0.9.2",
-    "next": "^14.2.4",
+    "ls-engines": "^0.9.3",
+    "next": "^14.2.5",
     "nock": "^13.5.4",
-    "prettier": "^3.3.2",
-    "prettier-plugin-packagejson": "^2.5.0",
+    "prettier": "^3.3.3",
+    "prettier-plugin-packagejson": "^2.5.1",
     "rimraf": "^5.0.7",
-    "rollup": "^4.18.0",
+    "rollup": "^4.20.0",
     "sse-channel": "^4.0.0",
-    "terser": "^5.31.1",
-    "typescript": "5.4.5",
-    "vitest": "2.0.2",
+    "terser": "^5.31.5",
+    "typescript": "5.5.3",
+    "vitest": "2.0.5",
     "vitest-github-actions-reporter": "0.11.1"
   },
   "engines": {

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