@sanity/client 6.28.0 → 6.28.2

package/README.md

@@ -501,7 +501,9 @@ Perform a query using the given parameters (if any).
 
 ### Using perspectives
 
-The `perspective` option can be used to specify special filtering behavior for queries. The default value is `raw`, which means no special filtering is applied, while [`published`](#published) and [`previewDrafts`](#previewdrafts) can be used to optimize for specific use cases.
+Use the `perspective` option to filter queries from a specific viewpoint. The default value is [`published`](#published) if API version >= v2025-02-19, (if API version is < v2025-02-19, [`raw`](#raw) is the default). Using the [`published`](#published) perspective will exclude drafts, versions, and potential future document variants. Using the [`raw`](#raw) perspective returns all document variants, so it's recommended to apply additional client side filtering to limit the variants you want to process.
+
+Learn more about using perspectives with Content Releases in the [perspective documentation](https://www.sanity.io/docs/perspectives).
 
 #### `published`
 
@@ -537,13 +539,13 @@ import {createClient} from '@sanity/client'
 const client = createClient({
   ...config,
   useCdn: true, // set to `false` to bypass the edge cache
-  perspective: 'published',
+  perspective: 'published', // default starting from API version v2025-02-19
 })
 
 const authors = await client.fetch('*[_type == "author"]')
 ```
 
-Then `authors` will only contain documents that don't have a `drafts.` prefix in their `_id`, in this case just "George Martin":
+Then `authors` will only contain published documents, and not include documents with `drafts.`, `versions.` or other prefixes in their `_id`, in this case just "George Martin":
 
 ```json
 [

package/dist/index.browser.d.cts

@@ -339,9 +339,18 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @defaultValue 'raw' */
+  /**
+   * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
+   * @remarks
+   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+   * @defaultValue 'published'
+   */
   perspective?: ClientPerspective
   apiHost?: string
+  /**
+     @remarks
+     * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+     */
   apiVersion?: string
   proxy?: string
   /**
@@ -565,7 +574,7 @@ export declare type CreateAction = {
 /** @public */
 export declare const createClient: (config: ClientConfig) => SanityClient
 
-/** @internal */
+/** @public */
 export declare interface CurrentSanityUser {
   id: string
   name: string
@@ -574,10 +583,10 @@ export declare interface CurrentSanityUser {
   role: string
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetAclMode = 'public' | 'private' | 'custom'
 
-/** @internal */
+/** @public */
 export declare type DatasetResponse = {
   datasetName: string
   aclMode: DatasetAclMode
@@ -625,7 +634,7 @@ export declare class DatasetsClient {
   list(): Promise<DatasetsResponse>
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
@@ -954,7 +963,12 @@ export declare interface ListenOptions {
    */
   includePreviousRevision?: boolean
   /**
-   * @internal
+   * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
+   * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
+   * If you need events from drafts and versions, set this to `true`.
+   * Note: Keep in mind that additional document variants may be introduced in the future, so it's
+   * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
+   * explicitly checking whether the event is for a draft or a version.
    * @defaultValue `false`
    */
   includeAllVersions?: boolean
@@ -2916,7 +2930,7 @@ export declare interface SanityImagePalette {
   title: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProject {
   id: string
   displayName: string
@@ -2944,7 +2958,7 @@ export declare interface SanityProject {
   }
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProjectMember {
   id: string
   role: string
@@ -2960,7 +2974,7 @@ export declare interface SanityReference {
   _ref: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityUser {
   id: string
   projectId: string

package/dist/index.browser.d.ts

@@ -339,9 +339,18 @@ export declare interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @defaultValue 'raw' */
+  /**
+   * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
+   * @remarks
+   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+   * @defaultValue 'published'
+   */
   perspective?: ClientPerspective
   apiHost?: string
+  /**
+     @remarks
+     * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+     */
   apiVersion?: string
   proxy?: string
   /**
@@ -565,7 +574,7 @@ export declare type CreateAction = {
 /** @public */
 export declare const createClient: (config: ClientConfig) => SanityClient
 
-/** @internal */
+/** @public */
 export declare interface CurrentSanityUser {
   id: string
   name: string
@@ -574,10 +583,10 @@ export declare interface CurrentSanityUser {
   role: string
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetAclMode = 'public' | 'private' | 'custom'
 
-/** @internal */
+/** @public */
 export declare type DatasetResponse = {
   datasetName: string
   aclMode: DatasetAclMode
@@ -625,7 +634,7 @@ export declare class DatasetsClient {
   list(): Promise<DatasetsResponse>
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
@@ -954,7 +963,12 @@ export declare interface ListenOptions {
    */
   includePreviousRevision?: boolean
   /**
-   * @internal
+   * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
+   * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
+   * If you need events from drafts and versions, set this to `true`.
+   * Note: Keep in mind that additional document variants may be introduced in the future, so it's
+   * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
+   * explicitly checking whether the event is for a draft or a version.
    * @defaultValue `false`
    */
   includeAllVersions?: boolean
@@ -2916,7 +2930,7 @@ export declare interface SanityImagePalette {
   title: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProject {
   id: string
   displayName: string
@@ -2944,7 +2958,7 @@ export declare interface SanityProject {
   }
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProjectMember {
   id: string
   role: string
@@ -2960,7 +2974,7 @@ export declare interface SanityReference {
   _ref: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityUser {
   id: string
   projectId: string

package/dist/index.cjs

@@ -1525,7 +1525,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return config.printNoDefaultExport(), createClient2(config$1);
   };
 }
-var name = "@sanity/client", version = "6.28.0";
+var name = "@sanity/client", version = "6.28.2";
 const middleware = [
   middleware$1.debug({ verbose: !0, namespace: "sanity:client" }),
   middleware$1.headers({ "User-Agent": `${name} ${version}` }),