@sanity/client 8.2.0 → 8.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "8.2.0",
+  "version": "8.4.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "api",
@@ -51,7 +51,6 @@
   "dependencies": {
     "eventsource": "^5.1.0",
     "get-it": "^9.5.0",
-    "nanoid": "^6.0.1",
     "obug": "^2.1.4",
     "rxjs": "^7.8.2"
   },
@@ -114,6 +113,7 @@
     "format": "oxfmt",
     "format:check": "oxfmt --check",
     "knip": "knip",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "generate:context": "node scripts/prune-context-spec.mjs src/context/openapi.json .tmp/context-openapi.pruned.json && pnpm --package=typescript@5.9.3 --package=openapi-typescript@7.13.0 dlx openapi-typescript .tmp/context-openapi.pruned.json -o src/context/types.gen.ts && oxfmt src/context/openapi.json src/context/types.gen.ts"
   }
 }

package/src/SanityClient.ts

@@ -8,6 +8,7 @@ import {
   ObservableCollaborationCommentsClient,
 } from './collaboration/CollaborationCommentsClient'
 import {defaultConfig, initConfig} from './config'
+import {ContextClient, ObservableContextClient} from './context/ContextClient'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
 import {LiveClient} from './data/live'
@@ -94,6 +95,8 @@ export class ObservableSanityClient {
   }
   functions: ObservableFunctionsClient
   releases: ObservableReleasesClient
+  /** @beta */
+  context: ObservableContextClient
 
   /**
    * Private properties
@@ -127,6 +130,7 @@ export class ObservableSanityClient {
     }
     this.functions = new ObservableFunctionsClient(this, this.#httpRequest)
     this.releases = new ObservableReleasesClient(this, this.#httpRequest)
+    this.context = new ObservableContextClient(this, this.#httpRequest)
   }
 
   /**
@@ -1167,6 +1171,8 @@ export class SanityClient {
   }
   functions: FunctionsClient
   releases: ReleasesClient
+  /** @beta */
+  context: ContextClient
 
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
@@ -1205,6 +1211,7 @@ export class SanityClient {
     }
     this.functions = new FunctionsClient(this, this.#httpRequest)
     this.releases = new ReleasesClient(this, this.#httpRequest)
+    this.context = new ContextClient(this, this.#httpRequest)
 
     this.observable = new ObservableSanityClient(httpRequest, config)
   }

package/src/assets/AssetsClient.ts

@@ -303,6 +303,11 @@ function buildAssetUploadUrl(config: InitializedClientConfig, assetType: 'image'
       case 'canvas': {
         return `/canvases/${id}/assets/${assetTypeEndpoint}`
       }
+      case 'knowledge-base': {
+        throw new Error(
+          'Assets are not supported for knowledge-base resources. Use `client.context.imports` to add content instead.',
+        )
+      }
       case 'media-library': {
         return `/media-libraries/${id}/upload`
       }

package/src/collaboration/types.ts

@@ -161,6 +161,18 @@ export interface CollaborationCommentRange {
   end: {_key: string; offset: number}
 }
 
+/**
+ * Portable Text covering a comment `range`. Callers can send just the blocks
+ * from the `range` start `_key` through end `_key`, or the full field.
+ *
+ * @alpha
+ */
+export type CollaborationCommentFieldValue = Array<{
+  _type: string
+  _key: string
+  [key: string]: Any
+}>
+
 /**
  * Target for a top-level comment. Inline selections require both `path` and
  * `range`; field-level comments may set `path` alone.
@@ -169,6 +181,9 @@ export interface CollaborationCommentRange {
  * `target.path.field`, and `range` is resolved against the document into
  * `target.path.selection` and `contentSnapshot` rather than being stored.
  *
+ * An optional `fieldValue` is Portable Text covering the `range`. When set,
+ * the `range` is resolved from those blocks instead of from the live document.
+ *
  * @alpha
  */
 export type CollaborationCommentTarget = {
@@ -180,11 +195,17 @@ export type CollaborationCommentTarget = {
       /** Path to the field containing the inline comment selection */
       path: string
       range: CollaborationCommentRange
+      /**
+       * Portable Text covering the `range`. When set, the `range` is resolved
+       * from these blocks instead of from the live document.
+       */
+      fieldValue?: CollaborationCommentFieldValue
     }
   | {
       /** Path to the commented field */
       path?: string
       range?: never
+      fieldValue?: never
     }
 )
 
@@ -205,6 +226,19 @@ export type CollaborationCommentTarget = {
  * })
  * ```
  *
+ * #### Inline comment
+ * ```ts
+ * await client.collaboration.comments.create({
+ *   message,
+ *   target: {
+ *     documentId: 'doc-1',
+ *     documentType: 'article',
+ *     path: 'body',
+ *     range: {start: {_key: 'block-1', offset: 0}, end: {_key: 'block-1', offset: 5}},
+ *   },
+ * })
+ * ```
+ *
  * #### Reply
  * ```ts
  * await client.collaboration.comments.create({
@@ -236,17 +270,34 @@ export type CollaborationCommentCreate = {
 /**
  * Fields that can be updated on an existing comment.
  *
+ * A `range` re-anchors the comment within the field it already targets.
+ * Pass `null` to remove the selection and leave a field-level comment.
+ * An optional `fieldValue` is Portable Text covering that `range`; when set,
+ * the `range` is resolved from those blocks instead of from the live document.
+ * `fieldValue` cannot be sent alone or together with `range: null`.
+ *
  * @alpha
  */
-export interface CollaborationCommentUpdate {
+export type CollaborationCommentUpdate = {
   /** Replaces the current message */
   message?: CollaborationCommentMessage
   /** Cascades to the comment's replies */
   status?: CollaborationCommentStatus
-  /**
-   * Re-anchors the comment within the field and source document it already
-   * targets. Pass `null` to remove the selection and leave a field-level
-   * comment.
-   */
-  range?: CollaborationCommentRange | null
-}
+} & (
+  | {
+      range: CollaborationCommentRange
+      /**
+       * Portable Text covering the `range`. When set, the `range` is resolved
+       * from these blocks instead of from the live document.
+       */
+      fieldValue?: CollaborationCommentFieldValue
+    }
+  | {
+      range: null
+      fieldValue?: never
+    }
+  | {
+      range?: undefined
+      fieldValue?: never
+    }
+)

package/src/config.ts

@@ -62,6 +62,7 @@ export const initConfig = (
   const newConfig = {
     ...defaultConfig,
     ...specifiedConfig,
+    apiHost: specifiedConfig.apiHost ?? defaultConfig.apiHost,
   } as InitializedClientConfig
 
   // Normalize resource configuration - prefer `resource` over deprecated `~experimental_resource`