@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.
package/dist/index.d.cts CHANGED
@@ -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
@@ -573,12 +573,12 @@ export declare type CreateAction = {
573
573
 
574
574
  /**
575
575
  * @remarks
576
- * 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}
576
+ * 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}
577
577
  * @public
578
578
  */
579
579
  export declare const createClient: (config: ClientConfig) => SanityClient
580
580
 
581
- /** @internal */
581
+ /** @public */
582
582
  export declare interface CurrentSanityUser {
583
583
  id: string
584
584
  name: string
@@ -587,10 +587,10 @@ export declare interface CurrentSanityUser {
587
587
  role: string
588
588
  }
589
589
 
590
- /** @internal */
590
+ /** @public */
591
591
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
592
592
 
593
- /** @internal */
593
+ /** @public */
594
594
  export declare type DatasetResponse = {
595
595
  datasetName: string
596
596
  aclMode: DatasetAclMode
@@ -638,7 +638,7 @@ export declare class DatasetsClient {
638
638
  list(): Promise<DatasetsResponse>
639
639
  }
640
640
 
641
- /** @internal */
641
+ /** @public */
642
642
  export declare type DatasetsResponse = {
643
643
  name: string
644
644
  aclMode: DatasetAclMode
@@ -968,7 +968,7 @@ export declare interface ListenOptions {
968
968
  includePreviousRevision?: boolean
969
969
  /**
970
970
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
971
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
971
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
972
972
  * If you need events from drafts and versions, set this to `true`.
973
973
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
974
974
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -2934,7 +2934,7 @@ export declare interface SanityImagePalette {
2934
2934
  title: string
2935
2935
  }
2936
2936
 
2937
- /** @internal */
2937
+ /** @public */
2938
2938
  export declare interface SanityProject {
2939
2939
  id: string
2940
2940
  displayName: string
@@ -2962,7 +2962,7 @@ export declare interface SanityProject {
2962
2962
  }
2963
2963
  }
2964
2964
 
2965
- /** @internal */
2965
+ /** @public */
2966
2966
  export declare interface SanityProjectMember {
2967
2967
  id: string
2968
2968
  role: string
@@ -2978,7 +2978,7 @@ export declare interface SanityReference {
2978
2978
  _ref: string
2979
2979
  }
2980
2980
 
2981
- /** @internal */
2981
+ /** @public */
2982
2982
  export declare interface SanityUser {
2983
2983
  id: string
2984
2984
  projectId: string
package/dist/index.d.ts CHANGED
@@ -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
@@ -573,12 +573,12 @@ export declare type CreateAction = {
573
573
 
574
574
  /**
575
575
  * @remarks
576
- * 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}
576
+ * 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}
577
577
  * @public
578
578
  */
579
579
  export declare const createClient: (config: ClientConfig) => SanityClient
580
580
 
581
- /** @internal */
581
+ /** @public */
582
582
  export declare interface CurrentSanityUser {
583
583
  id: string
584
584
  name: string
@@ -587,10 +587,10 @@ export declare interface CurrentSanityUser {
587
587
  role: string
588
588
  }
589
589
 
590
- /** @internal */
590
+ /** @public */
591
591
  export declare type DatasetAclMode = 'public' | 'private' | 'custom'
592
592
 
593
- /** @internal */
593
+ /** @public */
594
594
  export declare type DatasetResponse = {
595
595
  datasetName: string
596
596
  aclMode: DatasetAclMode
@@ -638,7 +638,7 @@ export declare class DatasetsClient {
638
638
  list(): Promise<DatasetsResponse>
639
639
  }
640
640
 
641
- /** @internal */
641
+ /** @public */
642
642
  export declare type DatasetsResponse = {
643
643
  name: string
644
644
  aclMode: DatasetAclMode
@@ -968,7 +968,7 @@ export declare interface ListenOptions {
968
968
  includePreviousRevision?: boolean
969
969
  /**
970
970
  * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events
971
- * for published documents will be included by default (see {@link https://www.sanity.io/changelog/e93a2d5a-9cee-4801-829e-8d3394bfed85|Changelog})
971
+ * for published documents will be included by default (see {@link https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog})
972
972
  * If you need events from drafts and versions, set this to `true`.
973
973
  * Note: Keep in mind that additional document variants may be introduced in the future, so it's
974
974
  * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by
@@ -2934,7 +2934,7 @@ export declare interface SanityImagePalette {
2934
2934
  title: string
2935
2935
  }
2936
2936
 
2937
- /** @internal */
2937
+ /** @public */
2938
2938
  export declare interface SanityProject {
2939
2939
  id: string
2940
2940
  displayName: string
@@ -2962,7 +2962,7 @@ export declare interface SanityProject {
2962
2962
  }
2963
2963
  }
2964
2964
 
2965
- /** @internal */
2965
+ /** @public */
2966
2966
  export declare interface SanityProjectMember {
2967
2967
  id: string
2968
2968
  role: string
@@ -2978,7 +2978,7 @@ export declare interface SanityReference {
2978
2978
  _ref: string
2979
2979
  }
2980
2980
 
2981
- /** @internal */
2981
+ /** @public */
2982
2982
  export declare interface SanityUser {
2983
2983
  id: string
2984
2984
  projectId: string
package/dist/index.js CHANGED
@@ -1508,7 +1508,7 @@ function defineDeprecatedCreateClient(createClient2) {
1508
1508
  return printNoDefaultExport(), createClient2(config);
1509
1509
  };
1510
1510
  }
1511
- var name = "@sanity/client", version = "6.28.1";
1511
+ var name = "@sanity/client", version = "6.28.3";
1512
1512
  const middleware = [
1513
1513
  debug({ verbose: !0, namespace: "sanity:client" }),
1514
1514
  headers({ "User-Agent": `${name} ${version}` }),