@sanity/client 8.0.0 → 8.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "8.0.0",
+  "version": "8.2.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "api",
@@ -49,15 +49,15 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "eventsource": "^5.0.0",
-    "get-it": "^9.4.1",
+    "eventsource": "^5.1.0",
+    "get-it": "^9.5.0",
     "nanoid": "^6.0.1",
     "obug": "^2.1.4",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {
     "@changesets/cli": "^2.31.1",
-    "@cloudflare/vitest-pool-workers": "^0.20.1",
+    "@cloudflare/vitest-pool-workers": "^0.21.3",
     "@edge-runtime/types": "^4.0.0",
     "@edge-runtime/vm": "^5.0.0",
     "@sanity/pkg-utils": "^12.1.2",
@@ -65,17 +65,22 @@
     "@types/node": "^22.20.1",
     "@types/react": "^19.2.18",
     "@vercel/stega": "1.1.0",
+    "@vitest/browser": "^4.1.10",
+    "@vitest/browser-playwright": "^4.1.10",
     "@vitest/coverage-v8": "^4.1.10",
     "eventsource-encoder": "^1.0.2",
-    "happy-dom": "^20.11.1",
+    "happy-dom": "^20.11.2",
     "json-diff": "^1.0.6",
+    "knip": "^6.32.2",
     "ls-engines": "^0.10.1",
-    "next": "^16.3.0",
+    "next": "^16.3.1",
     "oxfmt": "^0.63.0",
     "oxlint": "^1.78.0",
     "oxlint-tsgolint": "^7.0.2001",
-    "pkg-pr-new": "^0.0.86",
+    "pkg-pr-new": "^0.0.88",
+    "playwright": "^1.62.1",
     "typescript": "7.0.2",
+    "undici": "^7.29.0",
     "vitest": "^4.1.10"
   },
   "browserslist": "extends @sanity/browserslist-config",
@@ -92,13 +97,23 @@
     "release": "changeset publish",
     "test": "vitest",
     "test:browser": "vitest run --config ./vitest.browser.config.ts",
-    "test:bun": "bun test runtimes/bun",
-    "test:deno": "npm pack --pack-destination runtimes/deno && cd runtimes/deno && npm install --no-save --no-package-lock ./sanity-client-*.tgz @types/node && deno test --allow-read --allow-net --allow-env --fail-fast --node-modules-dir=manual .",
+    "test:bun": "bun run vitest run",
+    "test:deno": "deno run -A --node-modules-dir=manual npm:vitest run --config ./vitest.deno.config.ts",
+    "test:happy-dom": "vitest run --config ./vitest.happy-dom.config.ts",
+    "test:integration": "vitest run --config ./vitest.integration.config.ts",
+    "test:integration:bun": "bun run vitest run --config ./vitest.integration.config.ts",
+    "test:integration:deno": "deno run -A --node-modules-dir=manual npm:vitest run --config ./vitest.integration.config.ts",
+    "test:integration:node": "vitest run --config ./vitest.integration.config.ts",
+    "test:integration:vercel-edge": "vitest run --config ./vitest.integration.vercel-edge.config.ts",
+    "test:integration:workerd": "vitest run --config ./vitest.integration.workerd.config.ts",
     "test:next": "vitest run --config ./vitest.next.config.ts",
-    "test:node-runtimes": "(cd runtimes/node && node --test)",
+    "test:packaging": "vitest run --config ./vitest.packaging.config.ts",
+    "test:react-server": "vitest run --config ./vitest.react-server.config.ts",
     "test:vercel-edge": "vitest run --config ./vitest.vercel-edge.config.ts",
     "test:workerd": "vitest run --config ./vitest.workerd.config.ts",
     "format": "oxfmt",
-    "format:check": "oxfmt --check"
+    "format:check": "oxfmt --check",
+    "knip": "knip",
+    "typecheck": "tsc --noEmit"
   }
 }

package/src/SanityClient.ts

@@ -3,6 +3,10 @@ import {Observable} from 'rxjs'
 
 import {AgentActionsClient, ObservableAgentsActionClient} from './agent/actions/AgentActionsClient'
 import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
+import {
+  CollaborationCommentsClient,
+  ObservableCollaborationCommentsClient,
+} from './collaboration/CollaborationCommentsClient'
 import {defaultConfig, initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
@@ -10,6 +14,7 @@ import {LiveClient} from './data/live'
 import {ObservablePatch, Patch} from './data/patch'
 import {ObservableTransaction, Transaction} from './data/transaction'
 import {DatasetsClient, ObservableDatasetsClient} from './datasets/DatasetsClient'
+import {FunctionsClient, ObservableFunctionsClient} from './functions/FunctionsClient'
 import {
   MediaLibraryVideoClient,
   ObservableMediaLibraryVideoClient,
@@ -56,10 +61,12 @@ import {deriveDocumentVersionId, getDocumentVersionId} from './util/createVersio
 export type {
   _listen,
   AssetsClient,
+  CollaborationCommentsClient,
   DatasetsClient,
   LiveClient,
   MediaLibraryVideoClient,
   ObservableAssetsClient,
+  ObservableCollaborationCommentsClient,
   ObservableDatasetsClient,
   ObservableMediaLibraryVideoClient,
   ObservableProjectsClient,
@@ -81,6 +88,11 @@ export class ObservableSanityClient {
   agent: {
     action: ObservableAgentsActionClient
   }
+  collaboration: {
+    /** @alpha */
+    comments: ObservableCollaborationCommentsClient
+  }
+  functions: ObservableFunctionsClient
   releases: ObservableReleasesClient
 
   /**
@@ -110,6 +122,10 @@ export class ObservableSanityClient {
     this.agent = {
       action: new ObservableAgentsActionClient(this, this.#httpRequest),
     }
+    this.collaboration = {
+      comments: new ObservableCollaborationCommentsClient(this, this.#httpRequest),
+    }
+    this.functions = new ObservableFunctionsClient(this, this.#httpRequest)
     this.releases = new ObservableReleasesClient(this, this.#httpRequest)
   }
 
@@ -707,15 +723,12 @@ export class ObservableSanityClient {
   delete(id: string, options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
   /**
    * Deletes a document with the given document ID.
-   * Returns an observable that resolves to the deleted document.
+   * Returns an observable that resolves to a mutation result object containing the deleted document ID.
    *
    * @param id - Document ID to delete
    * @param options - Options for the mutation
    */
-  delete<R extends Record<string, Any> = Record<string, Any>>(
-    id: string,
-    options?: BaseMutationOptions,
-  ): Observable<SanityDocument<R>>
+  delete(id: string, options?: BaseMutationOptions): Observable<MultipleMutationResult>
   /**
    * Deletes one or more documents matching the given query or document ID.
    * Returns an observable that resolves to first deleted document.
@@ -762,15 +775,15 @@ export class ObservableSanityClient {
   ): Observable<MultipleMutationResult>
   /**
    * Deletes one or more documents matching the given query or document ID.
-   * Returns an observable that resolves to first deleted document.
+   * Returns an observable that resolves to a mutation result object containing the document IDs that were deleted.
    *
    * @param selection - An object with either an `id` or `query` key defining what to delete
    * @param options - Options for the mutation
    */
-  delete<R extends Record<string, Any> = Record<string, Any>>(
+  delete(
     selection: MutationSelection,
     options?: BaseMutationOptions,
-  ): Observable<SanityDocument<R>>
+  ): Observable<MultipleMutationResult>
   delete<R extends Record<string, Any> = Record<string, Any>>(
     selection: string | MutationSelection,
     options?:
@@ -1020,7 +1033,7 @@ export class ObservableSanityClient {
   ): Observable<MultipleMutationResult>
   /**
    * Perform mutation operations against the configured dataset
-   * Returns an observable that resolves to the first mutated document.
+   * Returns an observable that resolves to a mutation result object containing the mutated document IDs.
    *
    * @param operations - Mutation operations to execute
    * @param options - Mutation options
@@ -1028,7 +1041,7 @@ export class ObservableSanityClient {
   mutate<R extends Record<string, Any> = Record<string, Any>>(
     operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
     options?: BaseMutationOptions,
-  ): Observable<SanityDocument<R>>
+  ): Observable<MultipleMutationResult>
   mutate<R extends Record<string, Any> = Record<string, Any>>(
     operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
     options?:
@@ -1148,6 +1161,11 @@ export class SanityClient {
   agent: {
     action: AgentActionsClient
   }
+  collaboration: {
+    /** @alpha */
+    comments: CollaborationCommentsClient
+  }
+  functions: FunctionsClient
   releases: ReleasesClient
 
   /**
@@ -1182,6 +1200,10 @@ export class SanityClient {
     this.agent = {
       action: new AgentActionsClient(this, this.#httpRequest),
     }
+    this.collaboration = {
+      comments: new CollaborationCommentsClient(this, this.#httpRequest),
+    }
+    this.functions = new FunctionsClient(this, this.#httpRequest)
     this.releases = new ReleasesClient(this, this.#httpRequest)
 
     this.observable = new ObservableSanityClient(httpRequest, config)
@@ -1773,15 +1795,12 @@ export class SanityClient {
   delete(id: string, options: AllDocumentIdsMutationOptions): Promise<MultipleMutationResult>
   /**
    * Deletes a document with the given document ID.
-   * Returns a promise that resolves to the deleted document.
+   * Returns a promise that resolves to a mutation result object containing the deleted document ID.
    *
    * @param id - Document ID to delete
    * @param options - Options for the mutation
    */
-  delete<R extends Record<string, Any> = Record<string, Any>>(
-    id: string,
-    options?: BaseMutationOptions,
-  ): Promise<SanityDocument<R>>
+  delete(id: string, options?: BaseMutationOptions): Promise<MultipleMutationResult>
   /**
    * Deletes one or more documents matching the given query or document ID.
    * Returns a promise that resolves to first deleted document.
@@ -1828,15 +1847,15 @@ export class SanityClient {
   ): Promise<MultipleMutationResult>
   /**
    * Deletes one or more documents matching the given query or document ID.
-   * Returns a promise that resolves to first deleted document.
+   * Returns a promise that resolves to a mutation result object containing the document IDs that were deleted.
    *
    * @param selection - An object with either an `id` or `query` key defining what to delete
    * @param options - Options for the mutation
    */
-  delete<R extends Record<string, Any> = Record<string, Any>>(
+  delete(
     selection: MutationSelection,
     options?: BaseMutationOptions,
-  ): Promise<SanityDocument<R>>
+  ): Promise<MultipleMutationResult>
   delete<R extends Record<string, Any> = Record<string, Any>>(
     selection: string | MutationSelection,
     options?:
@@ -2070,7 +2089,7 @@ export class SanityClient {
   ): Promise<MultipleMutationResult>
   /**
    * Perform mutation operations against the configured dataset
-   * Returns a promise that resolves to the first mutated document.
+   * Returns a promise that resolves to a mutation result object containing the mutated document IDs.
    *
    * @param operations - Mutation operations to execute
    * @param options - Mutation options
@@ -2078,7 +2097,7 @@ export class SanityClient {
   mutate<R extends Record<string, Any> = Record<string, Any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options?: BaseMutationOptions,
-  ): Promise<SanityDocument<R>>
+  ): Promise<MultipleMutationResult>
   mutate<R extends Record<string, Any> = Record<string, Any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options?:

package/src/assets/AssetsClient.ts

@@ -8,6 +8,7 @@ import type {
   Any,
   HttpRequest,
   InitializedClientConfig,
+  MediaLibraryAssetDocument,
   SanityAssetDocument,
   SanityImageAssetDocument,
   UploadBody,
@@ -67,7 +68,12 @@ export class ObservableAssetsClient {
     assetType: 'file' | 'image',
     body: UploadBody,
     options?: UploadClientConfig,
-  ): Observable<UploadEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
+  ): Observable<
+    UploadEvent<
+      | {document: SanityAssetDocument | SanityImageAssetDocument}
+      | {asset: MediaLibraryAssetDocument}
+    >
+  > {
     return _upload(this.#client, this.#httpRequest, assetType, body, options)
   }
 }
@@ -84,6 +90,16 @@ export class AssetsClient {
   /**
    * Uploads a file asset to the configured dataset
    *
+   * Note: when the client is configured against a Media Library
+   * (`resource: {type: 'media-library', id}`), this resolves to a
+   * {@link MediaLibraryAssetDocument} at runtime, not to a
+   * {@link SanityAssetDocument}. The declared type cannot express that: the
+   * shape depends on the client's configuration rather than on the arguments,
+   * so an overload cannot discriminate it, and widening the return type into a
+   * union would be a breaking change for every existing caller. Narrow the
+   * result yourself (for example, check for `currentVersion`) if you upload to
+   * a Media Library. Typing this honestly is deferred to the next major.
+   *
    * @param assetType - Asset type (file)
    * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
    * @param options - Options to use for the upload
@@ -96,6 +112,10 @@ export class AssetsClient {
   /**
    * Uploads an image asset to the configured dataset
    *
+   * Note: against a Media Library this resolves to a
+   * {@link MediaLibraryAssetDocument} at runtime. See the `'file'` overload
+   * above for why the declared type cannot say so.
+   *
    * @param assetType - Asset type (image)
    * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
    * @param options - Options to use for the upload
@@ -121,19 +141,48 @@ export class AssetsClient {
     assetType: 'file' | 'image',
     body: UploadBody,
     options?: UploadClientConfig,
-  ): Promise<SanityAssetDocument | SanityImageAssetDocument> {
-    type Doc = {document: SanityAssetDocument | SanityImageAssetDocument}
+  ): Promise<SanityAssetDocument | SanityImageAssetDocument | MediaLibraryAssetDocument> {
+    type Doc =
+      | {document: SanityAssetDocument | SanityImageAssetDocument}
+      | {asset: MediaLibraryAssetDocument}
     const observable = _upload<Doc>(this.#client, this.#httpRequest, assetType, body, options)
     return lastValueFrom(
       observable.pipe(
         filter((event): event is UploadResponseEvent<Doc> => event.type === 'response'),
-        map((event) => event.body.document),
+        map((event) => pluckUploadedAsset(event.body)),
       ),
     )
   }
 }
 
-function _upload<T = {document: SanityAssetDocument | SanityImageAssetDocument}>(
+/**
+ * Content Lake's upload endpoint responds with `{document: ...}`; the Media
+ * Library upload endpoint responds with `{asset: ...}` instead (a
+ * `sanity.asset` document, not a Content Lake asset document). Narrowing on
+ * the response body itself - rather than on the client's `resource` config -
+ * keeps this correct regardless of how the two are ever wired together.
+ */
+function isMediaLibraryUploadBody(
+  body:
+    | {document: SanityAssetDocument | SanityImageAssetDocument}
+    | {asset: MediaLibraryAssetDocument},
+): body is {asset: MediaLibraryAssetDocument} {
+  return 'asset' in body
+}
+
+function pluckUploadedAsset(
+  body:
+    | {document: SanityAssetDocument | SanityImageAssetDocument}
+    | {asset: MediaLibraryAssetDocument},
+): SanityAssetDocument | SanityImageAssetDocument | MediaLibraryAssetDocument {
+  return isMediaLibraryUploadBody(body) ? body.asset : body.document
+}
+
+function _upload<
+  T =
+    | {document: SanityAssetDocument | SanityImageAssetDocument}
+    | {asset: MediaLibraryAssetDocument},
+>(
   client: SanityClient | ObservableSanityClient,
   _httpRequest: HttpRequest,
   assetType: 'image' | 'file',