@sanity/client 6.27.0 → 6.27.2-canary.0

package/dist/stega.browser.d.cts

@@ -1163,13 +1163,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1177,9 +1176,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2360,7 +2366,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/dist/stega.browser.d.ts

@@ -1163,13 +1163,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1177,9 +1176,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2360,7 +2366,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/dist/stega.d.cts

@@ -1163,13 +1163,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1177,9 +1176,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2360,7 +2366,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/dist/stega.d.ts

@@ -1163,13 +1163,12 @@ export declare class LiveClient {
   #private
   constructor(client: SanityClient | ObservableSanityClient)
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts,
     tag: _tag,
   }?: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -1177,9 +1176,16 @@ export declare class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
+  }): Observable<LiveEvent>
 }
 
+/** @public */
+export declare type LiveEvent =
+  | LiveEventRestart
+  | LiveEventReconnect
+  | LiveEventMessage
+  | LiveEventWelcome
+
 /** @public */
 export declare interface LiveEventMessage {
   type: 'message'
@@ -2360,7 +2366,7 @@ export declare interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.27.0",
+  "version": "6.27.2-canary.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -94,7 +94,7 @@
     "build": "pkg build --strict && pkg --strict && npm run rollup && npm run minify",
     "clean": "npx rimraf dist coverage umd/*.js",
     "coverage": "vitest run --coverage",
-    "lint": "eslint . --ext .cjs,.js,.ts --max-warnings 0",
+    "lint": "eslint . --max-warnings 0",
     "minify": "terser -c -m -- umd/sanityClient.js > umd/sanityClient.min.js",
     "prepublishOnly": "npm run build",
     "rollup": "NODE_ENV=production rollup -c rollup.config.cjs",
@@ -125,35 +125,39 @@
   "devDependencies": {
     "@edge-runtime/types": "^4.0.0",
     "@edge-runtime/vm": "^5.0.0",
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.19.0",
     "@rollup/plugin-commonjs": "^28.0.2",
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@sanity/client-latest": "npm:@sanity/client@latest",
-    "@sanity/pkg-utils": "^7.0.2",
+    "@sanity/pkg-utils": "^7.0.3",
     "@types/json-diff": "^1.0.3",
     "@types/node": "^22.9.0",
-    "@typescript-eslint/eslint-plugin": "^8.21.0",
-    "@typescript-eslint/parser": "^8.21.0",
+    "@typescript-eslint/eslint-plugin": "^8.22.0",
+    "@typescript-eslint/parser": "^8.22.0",
     "@vercel/stega": "0.1.2",
-    "@vitest/coverage-v8": "3.0.2",
-    "eslint": "^8.57.1",
+    "@vitest/coverage-v8": "3.0.4",
+    "eslint": "^9.19.0",
     "eslint-config-prettier": "^10.0.1",
+    "eslint-formatter-compact": "^8.40.0",
     "eslint-plugin-prettier": "^5.2.3",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "faucet": "^0.0.4",
+    "globals": "^15.14.0",
     "happy-dom": "^12.10.3",
     "json-diff": "^1.0.6",
     "ls-engines": "^0.9.3",
     "msw": "^2.7.0",
-    "next": "^15.1.5",
+    "next": "^15.1.6",
     "nock": "^13.5.6",
     "prettier": "^3.4.2",
     "prettier-plugin-packagejson": "^2.5.8",
     "rimraf": "^5.0.7",
-    "rollup": "^4.31.0",
+    "rollup": "^4.32.0",
     "sse-channel": "^4.0.0",
     "terser": "^5.37.0",
     "typescript": "5.7.3",
-    "vitest": "3.0.2",
+    "vitest": "3.0.4",
     "vitest-github-actions-reporter": "0.11.1"
   },
   "packageManager": "npm@11.0.0",

package/src/csm/applySourceDocuments.ts

@@ -33,7 +33,7 @@ export function applySourceDocuments<Result = unknown>(
   if (!resultSourceMap) return result
 
   const resolveDocument = createSourceDocumentResolver(getCachedDocument, perspective)
-  const cachedDocuments = resultSourceMap.documents.map(resolveDocument)
+  const cachedDocuments = resultSourceMap.documents?.map?.(resolveDocument) || []
 
   return walkMap(JSON.parse(JSON.stringify(result)), (value, path) => {
     const resolveMappingResult = resolveMapping(path, resultSourceMap)

package/src/data/live.ts

@@ -4,6 +4,7 @@ import {map} from 'rxjs/operators'
 import {CorsOriginError} from '../http/errors'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {
+  LiveEvent,
   LiveEventMessage,
   LiveEventReconnect,
   LiveEventRestart,
@@ -15,7 +16,7 @@ import {connectEventSource} from './eventsource'
 import {eventSourcePolyfill} from './eventsourcePolyfill'
 import {reconnectOnConnectionFailure} from './reconnectOnConnectionFailure'
 
-const requiredApiVersion = '2021-03-26'
+const requiredApiVersion = '2021-03-25'
 
 /**
  * @public
@@ -27,13 +28,12 @@ export class LiveClient {
   }
 
   /**
-   * Requires `apiVersion` to be `2021-03-26` or later.
+   * Requires `apiVersion` to be `2021-03-25` or later.
    */
   events({
     includeDrafts = false,
     tag: _tag,
   }: {
-    /** @alpha this API is experimental and may change or even be removed */
     includeDrafts?: boolean
     /**
      * Optional request tag for the listener. Use to identify the request in logs.
@@ -41,7 +41,7 @@ export class LiveClient {
      * @defaultValue `undefined`
      */
     tag?: string
-  } = {}): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome> {
+  } = {}): Observable<LiveEvent> {
     const {
       projectId,
       apiVersion: _apiVersion,
@@ -62,11 +62,6 @@ export class LiveClient {
         `The live events API requires a token or withCredentials when 'includeDrafts: true'. Please update your client configuration. The token should have the lowest possible access role.`,
       )
     }
-    if (includeDrafts && apiVersion !== 'X') {
-      throw new Error(
-        `The live events API requires API version X when 'includeDrafts: true'. This API is experimental and may change or even be removed.`,
-      )
-    }
     const path = _getDataUrl(this.#client, 'live/events')
     const url = new URL(this.#client.getUrl(path, false))
     const tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join('.') : _tag

package/src/types.ts

@@ -1017,7 +1017,7 @@ export interface RawQueryResponse<R> {
   ms: number
   result: R
   resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-26` or later. */
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
   syncTags?: SyncTag[]
 }
 
@@ -1292,6 +1292,9 @@ export interface LiveEventWelcome {
   type: 'welcome'
 }
 
+/** @public */
+export type LiveEvent = LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome
+
 /** @public */
 export interface SanityQueries {}
 

package/umd/sanityClient.js

@@ -2869,14 +2869,14 @@ ${selectionOpts}`);
       )
     );
   }
-  const requiredApiVersion = "2021-03-26";
+  const requiredApiVersion = "2021-03-25";
   class LiveClient {
     #client;
     constructor(client) {
       this.#client = client;
     }
     /**
-     * Requires `apiVersion` to be `2021-03-26` or later.
+     * Requires `apiVersion` to be `2021-03-25` or later.
      */
     events({
       includeDrafts = false,
@@ -2897,10 +2897,6 @@ ${selectionOpts}`);
         throw new Error(
           "The live events API requires a token or withCredentials when 'includeDrafts: true'. Please update your client configuration. The token should have the lowest possible access role."
         );
-      if (includeDrafts && apiVersion !== "X")
-        throw new Error(
-          "The live events API requires API version X when 'includeDrafts: true'. This API is experimental and may change or even be removed."
-        );
       const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, false)), tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join(".") : _tag;
       tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true");
       const esOptions = {};