@sanity/client 6.21.1 → 6.21.3-bundle-perspective

package/dist/index.browser.d.cts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-
 import type {ContentSourceMapDocuments as ContentSourceMapDocuments_2} from '@sanity/client/csm'
 import {ContentSourceMapParsedPath} from '@sanity/client/csm'
 import {ContentSourceMapParsedPathKeyedSegment} from '@sanity/client/csm'
@@ -333,6 +331,7 @@ export declare interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  bundlePerspective?: string
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -2014,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
@@ -2116,6 +2117,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string
   lastLiveEventId?: string
 }
 
@@ -2147,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
@@ -2271,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>
@@ -2286,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)[]>
@@ -2701,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
 }
@@ -2760,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
@@ -2772,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

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-
 import type {ContentSourceMapDocuments as ContentSourceMapDocuments_2} from '@sanity/client/csm'
 import {ContentSourceMapParsedPath} from '@sanity/client/csm'
 import {ContentSourceMapParsedPathKeyedSegment} from '@sanity/client/csm'
@@ -333,6 +331,7 @@ export declare interface ClientConfig {
   token?: string
   /** @defaultValue 'raw' */
   perspective?: ClientPerspective
+  bundlePerspective?: string
   apiHost?: string
   apiVersion?: string
   proxy?: string
@@ -2014,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
@@ -2116,6 +2117,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  bundlePerspective?: string
   lastLiveEventId?: string
 }
 
@@ -2147,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
@@ -2271,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>
@@ -2286,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)[]>
@@ -2701,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
 }
@@ -2760,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
@@ -2772,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
   }
 }