@sanity/client 6.28.1 → 6.28.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -342,14 +342,14 @@ export declare interface ClientConfig {
342
342
  /**
343
343
  * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
344
344
  * @remarks
345
- * 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}
345
+ * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
346
346
  * @defaultValue 'published'
347
347
  */
348
348
  perspective?: ClientPerspective
349
349
  apiHost?: string
350
350
  /**
351
351
  @remarks
352
- * 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}
352
+ * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
353
353
  */
354
354
  apiVersion?: string
355
355
  proxy?: string
@@ -574,7 +574,7 @@ export declare type CreateAction = {
574
574
  /** @public */
575
575
  export declare const createClient: (config: ClientConfig) => SanityClient
576
576
 
577
- /** @internal */
577
+ /** @public */
578
578
  export declare interface CurrentSanityUser {
579
579
  id: string
580
580
  name: string
@@ -583,10 +583,10 @@ export declare interface CurrentSanityUser {
583
583
  role: string
584
584
  }
585
585
 
586
- /** @internal */
586
+ /** @public */
587
587
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
588
588
 
589
- /** @internal */
589
+ /** @public */
590
590
  export declare type DatasetResponse = {
591
591
  datasetName: string
592
592
  aclMode: DatasetAclMode
@@ -634,7 +634,7 @@ export declare class DatasetsClient {
634
634
  list(): Promise<DatasetsResponse>
635
635
  }
636
636
 
637
- /** @internal */
637
+ /** @public */
638
638
  export declare type DatasetsResponse = {
639
639
  name: string
640
640
  aclMode: DatasetAclMode
@@ -964,7 +964,7 @@ export declare interface ListenOptions {
964
964
  includePreviousRevision?: boolean
965
965
  /**
966
966
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
967
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
967
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
968
968
  * If you need events from drafts and versions, set this to `true`.
969
969
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
970
970
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -2930,7 +2930,7 @@ export declare interface SanityImagePalette {
2930
2930
  title: string
2931
2931
  }
2932
2932
 
2933
- /** @internal */
2933
+ /** @public */
2934
2934
  export declare interface SanityProject {
2935
2935
  id: string
2936
2936
  displayName: string
@@ -2958,7 +2958,7 @@ export declare interface SanityProject {
2958
2958
  }
2959
2959
  }
2960
2960
 
2961
- /** @internal */
2961
+ /** @public */
2962
2962
  export declare interface SanityProjectMember {
2963
2963
  id: string
2964
2964
  role: string
@@ -2974,7 +2974,7 @@ export declare interface SanityReference {
2974
2974
  _ref: string
2975
2975
  }
2976
2976
 
2977
- /** @internal */
2977
+ /** @public */
2978
2978
  export declare interface SanityUser {
2979
2979
  id: string
2980
2980
  projectId: string
@@ -342,14 +342,14 @@ export declare interface ClientConfig {
342
342
  /**
343
343
  * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
344
344
  * @remarks
345
- * 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}
345
+ * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
346
346
  * @defaultValue 'published'
347
347
  */
348
348
  perspective?: ClientPerspective
349
349
  apiHost?: string
350
350
  /**
351
351
  @remarks
352
- * 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}
352
+ * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
353
353
  */
354
354
  apiVersion?: string
355
355
  proxy?: string
@@ -574,7 +574,7 @@ export declare type CreateAction = {
574
574
  /** @public */
575
575
  export declare const createClient: (config: ClientConfig) => SanityClient
576
576
 
577
- /** @internal */
577
+ /** @public */
578
578
  export declare interface CurrentSanityUser {
579
579
  id: string
580
580
  name: string
@@ -583,10 +583,10 @@ export declare interface CurrentSanityUser {
583
583
  role: string
584
584
  }
585
585
 
586
- /** @internal */
586
+ /** @public */
587
587
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
588
588
 
589
- /** @internal */
589
+ /** @public */
590
590
  export declare type DatasetResponse = {
591
591
  datasetName: string
592
592
  aclMode: DatasetAclMode
@@ -634,7 +634,7 @@ export declare class DatasetsClient {
634
634
  list(): Promise<DatasetsResponse>
635
635
  }
636
636
 
637
- /** @internal */
637
+ /** @public */
638
638
  export declare type DatasetsResponse = {
639
639
  name: string
640
640
  aclMode: DatasetAclMode
@@ -964,7 +964,7 @@ export declare interface ListenOptions {
964
964
  includePreviousRevision?: boolean
965
965
  /**
966
966
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
967
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
967
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
968
968
  * If you need events from drafts and versions, set this to `true`.
969
969
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
970
970
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -2930,7 +2930,7 @@ export declare interface SanityImagePalette {
2930
2930
  title: string
2931
2931
  }
2932
2932
 
2933
- /** @internal */
2933
+ /** @public */
2934
2934
  export declare interface SanityProject {
2935
2935
  id: string
2936
2936
  displayName: string
@@ -2958,7 +2958,7 @@ export declare interface SanityProject {
2958
2958
  }
2959
2959
  }
2960
2960
 
2961
- /** @internal */
2961
+ /** @public */
2962
2962
  export declare interface SanityProjectMember {
2963
2963
  id: string
2964
2964
  role: string
@@ -2974,7 +2974,7 @@ export declare interface SanityReference {
2974
2974
  _ref: string
2975
2975
  }
2976
2976
 
2977
- /** @internal */
2977
+ /** @public */
2978
2978
  export declare interface SanityUser {
2979
2979
  id: string
2980
2980
  projectId: string
package/dist/index.cjs CHANGED
@@ -1525,7 +1525,7 @@ function defineDeprecatedCreateClient(createClient2) {
1525
1525
  return config.printNoDefaultExport(), createClient2(config$1);
1526
1526
  };
1527
1527
  }
1528
- var name = "@sanity/client", version = "6.28.1";
1528
+ var name = "@sanity/client", version = "6.28.3";
1529
1529
  const middleware = [
1530
1530
  middleware$1.debug({ verbose: !0, namespace: "sanity:client" }),
1531
1531
  middleware$1.headers({ "User-Agent": `${name} ${version}` }),