@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.
@@ -336,14 +336,14 @@ export declare interface ClientConfig {
336
336
  /**
337
337
  * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
338
338
  * @remarks
339
- * 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}
339
+ * 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}
340
340
  * @defaultValue 'published'
341
341
  */
342
342
  perspective?: ClientPerspective
343
343
  apiHost?: string
344
344
  /**
345
345
  @remarks
346
- * 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}
346
+ * 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}
347
347
  */
348
348
  apiVersion?: string
349
349
  proxy?: string
@@ -673,7 +673,7 @@ export declare type CreateAction = {
673
673
  */
674
674
  export declare const createClient: (config: ClientConfig_2) => SanityClient
675
675
 
676
- /** @internal */
676
+ /** @public */
677
677
  export declare interface CurrentSanityUser {
678
678
  id: string
679
679
  name: string
@@ -682,10 +682,10 @@ export declare interface CurrentSanityUser {
682
682
  role: string
683
683
  }
684
684
 
685
- /** @internal */
685
+ /** @public */
686
686
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
687
687
 
688
- /** @internal */
688
+ /** @public */
689
689
  export declare type DatasetResponse = {
690
690
  datasetName: string
691
691
  aclMode: DatasetAclMode
@@ -733,7 +733,7 @@ export declare class DatasetsClient {
733
733
  list(): Promise<DatasetsResponse>
734
734
  }
735
735
 
736
- /** @internal */
736
+ /** @public */
737
737
  export declare type DatasetsResponse = {
738
738
  name: string
739
739
  aclMode: DatasetAclMode
@@ -1134,7 +1134,7 @@ export declare interface ListenOptions {
1134
1134
  includePreviousRevision?: boolean
1135
1135
  /**
1136
1136
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
1137
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
1137
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
1138
1138
  * If you need events from drafts and versions, set this to `true`.
1139
1139
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
1140
1140
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -3119,7 +3119,7 @@ export declare interface SanityImagePalette {
3119
3119
  title: string
3120
3120
  }
3121
3121
 
3122
- /** @internal */
3122
+ /** @public */
3123
3123
  export declare interface SanityProject {
3124
3124
  id: string
3125
3125
  displayName: string
@@ -3147,7 +3147,7 @@ export declare interface SanityProject {
3147
3147
  }
3148
3148
  }
3149
3149
 
3150
- /** @internal */
3150
+ /** @public */
3151
3151
  export declare interface SanityProjectMember {
3152
3152
  id: string
3153
3153
  role: string
@@ -3169,7 +3169,7 @@ export declare interface SanityReference {
3169
3169
  */
3170
3170
  export declare class SanityStegaClient extends SanityClient {}
3171
3171
 
3172
- /** @internal */
3172
+ /** @public */
3173
3173
  export declare interface SanityUser {
3174
3174
  id: string
3175
3175
  projectId: string
@@ -336,14 +336,14 @@ export declare interface ClientConfig {
336
336
  /**
337
337
  * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
338
338
  * @remarks
339
- * 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}
339
+ * 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}
340
340
  * @defaultValue 'published'
341
341
  */
342
342
  perspective?: ClientPerspective
343
343
  apiHost?: string
344
344
  /**
345
345
  @remarks
346
- * 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}
346
+ * 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}
347
347
  */
348
348
  apiVersion?: string
349
349
  proxy?: string
@@ -673,7 +673,7 @@ export declare type CreateAction = {
673
673
  */
674
674
  export declare const createClient: (config: ClientConfig_2) => SanityClient
675
675
 
676
- /** @internal */
676
+ /** @public */
677
677
  export declare interface CurrentSanityUser {
678
678
  id: string
679
679
  name: string
@@ -682,10 +682,10 @@ export declare interface CurrentSanityUser {
682
682
  role: string
683
683
  }
684
684
 
685
- /** @internal */
685
+ /** @public */
686
686
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
687
687
 
688
- /** @internal */
688
+ /** @public */
689
689
  export declare type DatasetResponse = {
690
690
  datasetName: string
691
691
  aclMode: DatasetAclMode
@@ -733,7 +733,7 @@ export declare class DatasetsClient {
733
733
  list(): Promise<DatasetsResponse>
734
734
  }
735
735
 
736
- /** @internal */
736
+ /** @public */
737
737
  export declare type DatasetsResponse = {
738
738
  name: string
739
739
  aclMode: DatasetAclMode
@@ -1134,7 +1134,7 @@ export declare interface ListenOptions {
1134
1134
  includePreviousRevision?: boolean
1135
1135
  /**
1136
1136
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
1137
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
1137
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
1138
1138
  * If you need events from drafts and versions, set this to `true`.
1139
1139
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
1140
1140
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -3119,7 +3119,7 @@ export declare interface SanityImagePalette {
3119
3119
  title: string
3120
3120
  }
3121
3121
 
3122
- /** @internal */
3122
+ /** @public */
3123
3123
  export declare interface SanityProject {
3124
3124
  id: string
3125
3125
  displayName: string
@@ -3147,7 +3147,7 @@ export declare interface SanityProject {
3147
3147
  }
3148
3148
  }
3149
3149
 
3150
- /** @internal */
3150
+ /** @public */
3151
3151
  export declare interface SanityProjectMember {
3152
3152
  id: string
3153
3153
  role: string
@@ -3169,7 +3169,7 @@ export declare interface SanityReference {
3169
3169
  */
3170
3170
  export declare class SanityStegaClient extends SanityClient {}
3171
3171
 
3172
- /** @internal */
3172
+ /** @public */
3173
3173
  export declare interface SanityUser {
3174
3174
  id: string
3175
3175
  projectId: string
package/dist/stega.d.cts CHANGED
@@ -336,14 +336,14 @@ export declare interface ClientConfig {
336
336
  /**
337
337
  * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
338
338
  * @remarks
339
- * 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}
339
+ * 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}
340
340
  * @defaultValue 'published'
341
341
  */
342
342
  perspective?: ClientPerspective
343
343
  apiHost?: string
344
344
  /**
345
345
  @remarks
346
- * 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}
346
+ * 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}
347
347
  */
348
348
  apiVersion?: string
349
349
  proxy?: string
@@ -673,7 +673,7 @@ export declare type CreateAction = {
673
673
  */
674
674
  export declare const createClient: (config: ClientConfig_2) => SanityClient
675
675
 
676
- /** @internal */
676
+ /** @public */
677
677
  export declare interface CurrentSanityUser {
678
678
  id: string
679
679
  name: string
@@ -682,10 +682,10 @@ export declare interface CurrentSanityUser {
682
682
  role: string
683
683
  }
684
684
 
685
- /** @internal */
685
+ /** @public */
686
686
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
687
687
 
688
- /** @internal */
688
+ /** @public */
689
689
  export declare type DatasetResponse = {
690
690
  datasetName: string
691
691
  aclMode: DatasetAclMode
@@ -733,7 +733,7 @@ export declare class DatasetsClient {
733
733
  list(): Promise<DatasetsResponse>
734
734
  }
735
735
 
736
- /** @internal */
736
+ /** @public */
737
737
  export declare type DatasetsResponse = {
738
738
  name: string
739
739
  aclMode: DatasetAclMode
@@ -1134,7 +1134,7 @@ export declare interface ListenOptions {
1134
1134
  includePreviousRevision?: boolean
1135
1135
  /**
1136
1136
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
1137
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
1137
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
1138
1138
  * If you need events from drafts and versions, set this to `true`.
1139
1139
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
1140
1140
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -3119,7 +3119,7 @@ export declare interface SanityImagePalette {
3119
3119
  title: string
3120
3120
  }
3121
3121
 
3122
- /** @internal */
3122
+ /** @public */
3123
3123
  export declare interface SanityProject {
3124
3124
  id: string
3125
3125
  displayName: string
@@ -3147,7 +3147,7 @@ export declare interface SanityProject {
3147
3147
  }
3148
3148
  }
3149
3149
 
3150
- /** @internal */
3150
+ /** @public */
3151
3151
  export declare interface SanityProjectMember {
3152
3152
  id: string
3153
3153
  role: string
@@ -3169,7 +3169,7 @@ export declare interface SanityReference {
3169
3169
  */
3170
3170
  export declare class SanityStegaClient extends SanityClient {}
3171
3171
 
3172
- /** @internal */
3172
+ /** @public */
3173
3173
  export declare interface SanityUser {
3174
3174
  id: string
3175
3175
  projectId: string
package/dist/stega.d.ts CHANGED
@@ -336,14 +336,14 @@ export declare interface ClientConfig {
336
336
  /**
337
337
  * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
338
338
  * @remarks
339
- * 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}
339
+ * 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}
340
340
  * @defaultValue 'published'
341
341
  */
342
342
  perspective?: ClientPerspective
343
343
  apiHost?: string
344
344
  /**
345
345
  @remarks
346
- * 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}
346
+ * 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}
347
347
  */
348
348
  apiVersion?: string
349
349
  proxy?: string
@@ -673,7 +673,7 @@ export declare type CreateAction = {
673
673
  */
674
674
  export declare const createClient: (config: ClientConfig_2) => SanityClient
675
675
 
676
- /** @internal */
676
+ /** @public */
677
677
  export declare interface CurrentSanityUser {
678
678
  id: string
679
679
  name: string
@@ -682,10 +682,10 @@ export declare interface CurrentSanityUser {
682
682
  role: string
683
683
  }
684
684
 
685
- /** @internal */
685
+ /** @public */
686
686
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
687
687
 
688
- /** @internal */
688
+ /** @public */
689
689
  export declare type DatasetResponse = {
690
690
  datasetName: string
691
691
  aclMode: DatasetAclMode
@@ -733,7 +733,7 @@ export declare class DatasetsClient {
733
733
  list(): Promise<DatasetsResponse>
734
734
  }
735
735
 
736
- /** @internal */
736
+ /** @public */
737
737
  export declare type DatasetsResponse = {
738
738
  name: string
739
739
  aclMode: DatasetAclMode
@@ -1134,7 +1134,7 @@ export declare interface ListenOptions {
1134
1134
  includePreviousRevision?: boolean
1135
1135
  /**
1136
1136
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
1137
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
1137
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
1138
1138
  * If you need events from drafts and versions, set this to `true`.
1139
1139
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
1140
1140
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -3119,7 +3119,7 @@ export declare interface SanityImagePalette {
3119
3119
  title: string
3120
3120
  }
3121
3121
 
3122
- /** @internal */
3122
+ /** @public */
3123
3123
  export declare interface SanityProject {
3124
3124
  id: string
3125
3125
  displayName: string
@@ -3147,7 +3147,7 @@ export declare interface SanityProject {
3147
3147
  }
3148
3148
  }
3149
3149
 
3150
- /** @internal */
3150
+ /** @public */
3151
3151
  export declare interface SanityProjectMember {
3152
3152
  id: string
3153
3153
  role: string
@@ -3169,7 +3169,7 @@ export declare interface SanityReference {
3169
3169
  */
3170
3170
  export declare class SanityStegaClient extends SanityClient {}
3171
3171
 
3172
- /** @internal */
3172
+ /** @public */
3173
3173
  export declare interface SanityUser {
3174
3174
  id: string
3175
3175
  projectId: string
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sanity/client",
3
- "version": "6.28.1",
3
+ "version": "6.28.3",
4
4
  "description": "Client for retrieving, creating and patching data from Sanity.io",
5
5
  "keywords": [
6
6
  "sanity",
package/src/index.ts CHANGED
@@ -11,7 +11,7 @@ export const requester = exp.requester
11
11
 
12
12
  /**
13
13
  * @remarks
14
- * 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}
14
+ * 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/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog}
15
15
  * @public
16
16
  */
17
17
  export const createClient = exp.createClient
package/src/types.ts CHANGED
@@ -64,7 +64,7 @@ export interface ClientConfig {
64
64
  /**
65
65
  * What perspective to use for the client. See {@link https://www.sanity.io/docs/perspectives|perspective documentation}
66
66
  * @remarks
67
- * 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}
67
+ * 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}
68
68
  * @defaultValue 'published'
69
69
  */
70
70
  perspective?: ClientPerspective
@@ -72,7 +72,7 @@ export interface ClientConfig {
72
72
 
73
73
  /**
74
74
  @remarks
75
- * 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}
75
+ * 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}
76
76
  */
77
77
  apiVersion?: string
78
78
  proxy?: string
@@ -375,12 +375,12 @@ export interface AuthProvider {
375
375
  /** @internal */
376
376
  export type AuthProviderResponse = {providers: AuthProvider[]}
377
377
 
378
- /** @internal */
378
+ /** @public */
379
379
  export type DatasetAclMode = 'public' | 'private' | 'custom'
380
380
 
381
- /** @internal */
381
+ /** @public */
382
382
  export type DatasetResponse = {datasetName: string; aclMode: DatasetAclMode}
383
- /** @internal */
383
+ /** @public */
384
384
  export type DatasetsResponse = {
385
385
  name: string
386
386
  aclMode: DatasetAclMode
@@ -392,7 +392,7 @@ export type DatasetsResponse = {
392
392
  tags: string[]
393
393
  }[]
394
394
 
395
- /** @internal */
395
+ /** @public */
396
396
  export interface SanityProjectMember {
397
397
  id: string
398
398
  role: string
@@ -400,7 +400,7 @@ export interface SanityProjectMember {
400
400
  isCurrentUser: boolean
401
401
  }
402
402
 
403
- /** @internal */
403
+ /** @public */
404
404
  export interface SanityProject {
405
405
  id: string
406
406
  displayName: string
@@ -428,7 +428,7 @@ export interface SanityProject {
428
428
  }
429
429
  }
430
430
 
431
- /** @internal */
431
+ /** @public */
432
432
  export interface SanityUser {
433
433
  id: string
434
434
  projectId: string
@@ -442,7 +442,7 @@ export interface SanityUser {
442
442
  isCurrentUser: boolean
443
443
  }
444
444
 
445
- /** @internal */
445
+ /** @public */
446
446
  export interface CurrentSanityUser {
447
447
  id: string
448
448
  name: string
@@ -944,7 +944,7 @@ export interface ListenOptions {
944
944
 
945
945
  /**
946
946
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
947
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
947
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
948
948
  * If you need events from drafts and versions, set this to `true`.
949
949
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
950
950
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by