@sanity/client 6.28.0 → 6.28.2

package/dist/stega.browser.d.cts

@@ -333,9 +333,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
   /**
@@ -664,7 +673,7 @@ export declare type CreateAction = {
  */
 export declare const createClient: (config: ClientConfig_2) => SanityClient
 
-/** @internal */
+/** @public */
 export declare interface CurrentSanityUser {
   id: string
   name: string
@@ -673,10 +682,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
@@ -724,7 +733,7 @@ export declare class DatasetsClient {
   list(): Promise<DatasetsResponse>
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
@@ -1124,7 +1133,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
@@ -3105,7 +3119,7 @@ export declare interface SanityImagePalette {
   title: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProject {
   id: string
   displayName: string
@@ -3133,7 +3147,7 @@ export declare interface SanityProject {
   }
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProjectMember {
   id: string
   role: string
@@ -3155,7 +3169,7 @@ export declare interface SanityReference {
  */
 export declare class SanityStegaClient extends SanityClient {}
 
-/** @internal */
+/** @public */
 export declare interface SanityUser {
   id: string
   projectId: string

package/dist/stega.browser.d.ts

@@ -333,9 +333,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
   /**
@@ -664,7 +673,7 @@ export declare type CreateAction = {
  */
 export declare const createClient: (config: ClientConfig_2) => SanityClient
 
-/** @internal */
+/** @public */
 export declare interface CurrentSanityUser {
   id: string
   name: string
@@ -673,10 +682,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
@@ -724,7 +733,7 @@ export declare class DatasetsClient {
   list(): Promise<DatasetsResponse>
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
@@ -1124,7 +1133,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
@@ -3105,7 +3119,7 @@ export declare interface SanityImagePalette {
   title: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProject {
   id: string
   displayName: string
@@ -3133,7 +3147,7 @@ export declare interface SanityProject {
   }
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProjectMember {
   id: string
   role: string
@@ -3155,7 +3169,7 @@ export declare interface SanityReference {
  */
 export declare class SanityStegaClient extends SanityClient {}
 
-/** @internal */
+/** @public */
 export declare interface SanityUser {
   id: string
   projectId: string

package/dist/stega.d.cts

@@ -333,9 +333,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
   /**
@@ -664,7 +673,7 @@ export declare type CreateAction = {
  */
 export declare const createClient: (config: ClientConfig_2) => SanityClient
 
-/** @internal */
+/** @public */
 export declare interface CurrentSanityUser {
   id: string
   name: string
@@ -673,10 +682,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
@@ -724,7 +733,7 @@ export declare class DatasetsClient {
   list(): Promise<DatasetsResponse>
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
@@ -1124,7 +1133,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
@@ -3105,7 +3119,7 @@ export declare interface SanityImagePalette {
   title: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProject {
   id: string
   displayName: string
@@ -3133,7 +3147,7 @@ export declare interface SanityProject {
   }
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProjectMember {
   id: string
   role: string
@@ -3155,7 +3169,7 @@ export declare interface SanityReference {
  */
 export declare class SanityStegaClient extends SanityClient {}
 
-/** @internal */
+/** @public */
 export declare interface SanityUser {
   id: string
   projectId: string

package/dist/stega.d.ts

@@ -333,9 +333,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
   /**
@@ -664,7 +673,7 @@ export declare type CreateAction = {
  */
 export declare const createClient: (config: ClientConfig_2) => SanityClient
 
-/** @internal */
+/** @public */
 export declare interface CurrentSanityUser {
   id: string
   name: string
@@ -673,10 +682,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
@@ -724,7 +733,7 @@ export declare class DatasetsClient {
   list(): Promise<DatasetsResponse>
 }
 
-/** @internal */
+/** @public */
 export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
@@ -1124,7 +1133,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
@@ -3105,7 +3119,7 @@ export declare interface SanityImagePalette {
   title: string
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProject {
   id: string
   displayName: string
@@ -3133,7 +3147,7 @@ export declare interface SanityProject {
   }
 }
 
-/** @internal */
+/** @public */
 export declare interface SanityProjectMember {
   id: string
   role: string
@@ -3155,7 +3169,7 @@ export declare interface SanityReference {
  */
 export declare class SanityStegaClient extends SanityClient {}
 
-/** @internal */
+/** @public */
 export declare interface SanityUser {
   id: string
   projectId: string

package/package.json

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

package/src/index.ts

@@ -9,7 +9,11 @@ const exp = defineCreateClientExports<SanityClient, ClientConfig>(envMiddleware,
 /** @public */
 export const requester = exp.requester
 
-/** @public */
+/**
+ * @remarks
+ * As of API version `v2025-02-19`, the default perspective used by the client has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog}
+ * @public
+ */
 export const createClient = exp.createClient
 
 /**

package/src/types.ts

@@ -60,9 +60,20 @@ export 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
 
@@ -364,12 +375,12 @@ export interface AuthProvider {
 /** @internal */
 export type AuthProviderResponse = {providers: AuthProvider[]}
 
-/** @internal */
+/** @public */
 export type DatasetAclMode = 'public' | 'private' | 'custom'
 
-/** @internal */
+/** @public */
 export type DatasetResponse = {datasetName: string; aclMode: DatasetAclMode}
-/** @internal */
+/** @public */
 export type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
@@ -381,7 +392,7 @@ export type DatasetsResponse = {
   tags: string[]
 }[]
 
-/** @internal */
+/** @public */
 export interface SanityProjectMember {
   id: string
   role: string
@@ -389,7 +400,7 @@ export interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
-/** @internal */
+/** @public */
 export interface SanityProject {
   id: string
   displayName: string
@@ -417,7 +428,7 @@ export interface SanityProject {
   }
 }
 
-/** @internal */
+/** @public */
 export interface SanityUser {
   id: string
   projectId: string
@@ -431,7 +442,7 @@ export interface SanityUser {
   isCurrentUser: boolean
 }
 
-/** @internal */
+/** @public */
 export interface CurrentSanityUser {
   id: string
   name: string
@@ -932,7 +943,12 @@ export 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