@sanity/client - npm Package Compare versions

Comparing version 6.28.0 to 6.28.1

dist/index.js

@@ -1511,3 +1511,3 @@ import { getIt } from "get-it";
 }
-var name = "@sanity/client", version = "6.28.0";
+var name = "@sanity/client", version = "6.28.1";
 const middleware = [
@@ -1514,0 +1514,0 @@ debug({ verbose: !0, namespace: "sanity:client" }),

package.json

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

src/index.ts

@@ -12,3 +12,7 @@ import defineCreateClientExports, {type ClientConfig, SanityClient} from './defineCreateClient'
 
-/** @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
@@ -15,0 +19,0 @@

src/types.ts

@@ -63,5 +63,16 @@ // deno-lint-ignore-file no-empty-interface
   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
@@ -936,3 +947,8 @@ proxy?: string
   /**
-   * @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`
@@ -939,0 +955,0 @@ */

No alert changes

Improved metrics

Total package byte prevSize

2828212

increased by0.42%

Lines of code

33951

increased by0.23%

Number of maintainers

76

increased by1.33%

Number of lines in readme file

1960

increased by0.1%

Published versions last two months

27

increased by3.85%

Worsened metrics

Published versions last months

8

decreased by-33.33%

Published versions last year

122

decreased by-0.81%

No dependency changes