@sanity/client 8.7.0 → 8.8.0

package/README.md

@@ -2684,7 +2684,7 @@ const reply = await client.collaboration.comments.create({
 })
 ```
 
-Field comments pass a `path`. Inline comments also pass a `range` (block `_key` + character offset). An optional `fieldValue` is Portable Text covering that `range` (a slice or the full field); when set with `range`, the `range` is resolved from those blocks instead of from the live document:
+Field comments pass a `path`. Inline comments also pass an `anchor` (`type: 'portable-text'` with block `_key` + character offset). An optional `fieldValue` on the anchor is Portable Text covering that selection (a slice or the full field); when set, the selection is resolved from those blocks instead of from the live document:
 
 ```js
 await client.collaboration.comments.create({
@@ -2693,7 +2693,8 @@ await client.collaboration.comments.create({
     documentId: 'doc-1',
     documentType: 'article',
     path: 'body',
-    range: {
+    anchor: {
+      type: 'portable-text',
       start: {_key: 'block-1', offset: 6},
       end: {_key: 'block-1', offset: 11},
     },
@@ -2701,20 +2702,28 @@ await client.collaboration.comments.create({
 })
 ```
 
-When querying, the field is stored as `target.path.field`, so filter with `target.path.field == "body"`, not `target.path == "body"`. The `range` itself is not stored: the API resolves it into a selection (and content snapshot) when the comment is written.
+Deprecated `range` + top-level `fieldValue` are still accepted and converted to a `portable-text` `anchor` before the request is sent.
+
+When querying, the field is stored as `target.path.field`, so filter with `target.path.field == "body"`, not `target.path == "body"`. The `anchor` itself is not stored: the API resolves it into a selection (and content snapshot) when the comment is written.
 
 #### Updating and deleting comments
 
-`update()` can change `message`, `status`, and/or `range`. Status changes cascade to replies. A `range` re-anchors an inline comment within the field it already targets; pass `null` to turn a text-level comment into a field-level one. An optional `fieldValue` may be passed with a non-null `range` for the same purpose as on create (not alone or with `range: null`):
+`update()` can change `message`, `status`, and/or `anchor`. Status changes cascade to replies. An `anchor` re-anchors an inline comment within the field it already targets; pass `null` to turn a text-level comment into a field-level one. An optional `fieldValue` may sit on a `portable-text` anchor for the same purpose as on create:
 
 ```js
 await client.collaboration.comments.update('comment-1', {status: 'resolved'})
 await client.collaboration.comments.update('comment-1', {
-  range: {start: {_key: 'block-1', offset: 0}, end: {_key: 'block-1', offset: 12}},
+  anchor: {
+    type: 'portable-text',
+    start: {_key: 'block-1', offset: 0},
+    end: {_key: 'block-1', offset: 12},
+  },
 })
-await client.collaboration.comments.update('comment-1', {range: null})
+await client.collaboration.comments.update('comment-1', {anchor: null})
 ```
 
+Deprecated `range` / `range: null` remain accepted and are converted the same way as on create.
+
 `delete()` also deletes replies. The returned `documentIds` covers the comment and every deleted reply:
 
 ```js
@@ -2766,6 +2775,15 @@ const draftComments = await client.collaboration.comments.fetch(
 )
 ```
 
+The same ref can be built without a client, from a resource and a document id. Use `getCommentTargetDocumentRef()` where the resource is at hand and no client should be created or looked up, such as in a state selector:
+
+```js
+import {getCommentTargetDocumentRef} from '@sanity/client/collaboration'
+
+getCommentTargetDocumentRef({type: 'dataset', id: 'your-project-id.production'}, 'drafts.doc-1')
+// 'dataset:your-project-id.production:doc-1'
+```
+
 Pass a type parameter when you know the result shape:
 
 ```ts

package/dist/collaboration.d.ts

@@ -0,0 +1,33 @@
+import { ni as CollaborationCommentDocument, v as ClientConfig } from "./types-Cov8gzNZ.js";
+/**
+ * The resource comments are stored against: one of the client's resource configurations.
+ *
+ * @internal
+ */
+type CommentResource = NonNullable<ClientConfig['resource']>;
+/**
+ * Build the global document reference a comment stores in `target.document._ref`,
+ * without a client.
+ *
+ * `client.collaboration.comments.getTargetDocumentRef` reads the resource off the
+ * client's configuration and calls this. Use this directly when the resource is
+ * already at hand and no client should be involved, for example inside a state
+ * selector that has to stay free of side effects.
+ *
+ * The reference always names the published document: a draft or version ID is
+ * reduced to its published form first.
+ *
+ * @example
+ * ```ts
+ * getCommentTargetDocumentRef({type: 'dataset', id: 'abc123.production'}, 'drafts.doc-1')
+ * // 'dataset:abc123.production:doc-1'
+ * ```
+ *
+ * @param resource - The resource the comments are stored against, as `ClientConfig['resource']` takes it
+ * @param documentId - Document ID, in published, draft or version form
+ * @returns Global document reference, of the form `resourceType:resourceId:documentId`
+ * @alpha
+ */
+declare function getCommentTargetDocumentRef(resource: CommentResource, documentId: string): CollaborationCommentDocument['target']['document']['_ref'];
+export { getCommentTargetDocumentRef };
+//# sourceMappingURL=collaboration.d.ts.map

package/dist/collaboration.js

@@ -0,0 +1,2 @@
+import { t as getCommentTargetDocumentRef } from "./getCommentTargetDocumentRef-B8NuiBjG.js";
+export { getCommentTargetDocumentRef };

package/dist/getCommentTargetDocumentRef-B8NuiBjG.js

@@ -0,0 +1,31 @@
+import { getPublishedId } from "@sanity/client/csm";
+/**
+* Build the global document reference a comment stores in `target.document._ref`,
+* without a client.
+*
+* `client.collaboration.comments.getTargetDocumentRef` reads the resource off the
+* client's configuration and calls this. Use this directly when the resource is
+* already at hand and no client should be involved, for example inside a state
+* selector that has to stay free of side effects.
+*
+* The reference always names the published document: a draft or version ID is
+* reduced to its published form first.
+*
+* @example
+* ```ts
+* getCommentTargetDocumentRef({type: 'dataset', id: 'abc123.production'}, 'drafts.doc-1')
+* // 'dataset:abc123.production:doc-1'
+* ```
+*
+* @param resource - The resource the comments are stored against, as `ClientConfig['resource']` takes it
+* @param documentId - Document ID, in published, draft or version form
+* @returns Global document reference, of the form `resourceType:resourceId:documentId`
+* @alpha
+*/
+function getCommentTargetDocumentRef(resource, documentId) {
+	if (!documentId) throw Error("Document ID must be provided");
+	return `${resource.type}:${resource.id}:${getPublishedId(documentId)}`;
+}
+export { getCommentTargetDocumentRef as t };
+
+//# sourceMappingURL=getCommentTargetDocumentRef-B8NuiBjG.js.map

package/dist/getCommentTargetDocumentRef-B8NuiBjG.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCommentTargetDocumentRef-B8NuiBjG.js","names":[],"sources":["../src/collaboration/getCommentTargetDocumentRef.ts"],"sourcesContent":["import {getPublishedId} from '@sanity/client/csm'\n\nimport type {ClientConfig} from '../types'\nimport type {CollaborationCommentDocument} from './types'\n\n/**\n * The resource comments are stored against: one of the client's resource configurations.\n *\n * @internal\n */\nexport type CommentResource = NonNullable<ClientConfig['resource']>\n\n/**\n * Build the global document reference a comment stores in `target.document._ref`,\n * without a client.\n *\n * `client.collaboration.comments.getTargetDocumentRef` reads the resource off the\n * client's configuration and calls this. Use this directly when the resource is\n * already at hand and no client should be involved, for example inside a state\n * selector that has to stay free of side effects.\n *\n * The reference always names the published document: a draft or version ID is\n * reduced to its published form first.\n *\n * @example\n * ```ts\n * getCommentTargetDocumentRef({type: 'dataset', id: 'abc123.production'}, 'drafts.doc-1')\n * // 'dataset:abc123.production:doc-1'\n * ```\n *\n * @param resource - The resource the comments are stored against, as `ClientConfig['resource']` takes it\n * @param documentId - Document ID, in published, draft or version form\n * @returns Global document reference, of the form `resourceType:resourceId:documentId`\n * @alpha\n */\nexport function getCommentTargetDocumentRef(\n  resource: CommentResource,\n  documentId: string,\n): CollaborationCommentDocument['target']['document']['_ref'] {\n  if (!documentId) {\n    throw new Error('Document ID must be provided')\n  }\n\n  return `${resource.type}:${resource.id}:${getPublishedId(documentId)}`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAmCA,SAAgB,4BACd,UACA,YAC4D;CAC5D,IAAI,CAAC,YACH,MAAU,MAAM,8BAA8B;CAGhD,OAAO,GAAG,SAAS,KAAK,GAAG,SAAS,GAAG,GAAG,eAAe,UAAU;AACrE"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { d as ResolveStudioUrl, f as StegaConfig, g as StudioUrl, h as StudioBaseUrl, i as ContentSourceMapParsedPathKeyedSegment, l as InitializedStegaConfig, m as StudioBaseRoute, p as StegaConfigRequiredKeys, r as ContentSourceMapParsedPath, s as FilterDefault, u as Logger } from "./types-CfGzbXrl.js";
-import { $ as DisconnectEvent, $n as UnpublishVersionAction, $r as ObservableCollaborationCommentsClient, $t as QueryWithoutParams, A as ContentSourceMapMappings, Ai as AgentActionParam, An as SanityQueries, Ar as SanityClient, At as MediaLibraryAssetVersion, B as CreateVersionAction, Bn as StoryboardTransformOptions, Br as DatasetsClient, Bt as MutationSelection, C as ContentSourceMap, Ci as TransformTarget, Cn as SanityDocument, Cr as WelcomeEvent, Ct as LiveEventGoAway, D as ContentSourceMapDocuments, Di as PatchDocument, Dn as SanityProject, Dr as GenerateTargetDocument, Dt as LiveEventWelcome, E as ContentSourceMapDocumentValueSource, Ei as PromptRequest, En as SanityImagePalette, Er as GenerateTarget, Et as LiveEventRestart, F as ContentSourceMapValueMapping, Fi as ConstantAgentActionParam, Fn as ScheduleReleaseAction, Fr as MediaLibraryVideoClient, Ft as Mutation, G as DatasetResponse, Gn as TransactionFirstDocumentIdMutationOptions, Gr as PatchBuilder, Gt as PatchOperations, H as DatasetAclMode, Hn as ThumbnailTransformOptions, Hr as BaseTransaction, Ht as OpenEvent, I as CreateAction, Ii as DocumentAgentActionParam, In as SingleActionResult, Ir as ObservableMediaLibraryVideoClient, It as MutationError, J as DeleteReleaseAction, Jn as UnarchiveReleaseAction, Jr as ObservablePatch, Jt as PublishReleaseAction, K as DatasetsResponse, Kn as TransactionFirstDocumentMutationOptions, Kr as Transaction, Kt as PatchSelection, L as CreateReleaseAction, Li as FieldAgentActionParam, Ln as SingleMutationResult, Lr as InvokeFunctionEvent, Lt as MutationErrorItem, M as ContentSourceMapRemoteDocument, Mi as AgentActionPath, Mn as SanityReference, Mr as UsersClient, Mt as MediaLibraryVideoPlaybackTransformations, N as ContentSourceMapSource, Ni as AgentActionPathSegment, Nn as SanitySchemasByResource, Nr as ObservableProjectsClient, Nt as MultipleActionResult, O as ContentSourceMapLiteralSource, Oi as PatchOperation, On as SanityProjectMember, Or as GenerateTargetInclude, Ot as MediaLibraryAssetDocument, P as ContentSourceMapUnknownSource, Pi as AgentActionTarget, Pn as SanityUser, Pr as ProjectsClient, Pt as MultipleMutationResult, Q as DiscardVersionAction, Qn as UnpublishVariantAction, Qr as CollaborationCommentsClient, Qt as QueryParseError, R as CreateVariantAction, Ri as GroqAgentActionParam, Rn as StackablePerspective, Rr as InvokeFunctionOptions, Rt as MutationEvent, S as ClientVariantConditions, Si as TransformOperation, Sn as SanityAssetDocument, Sr as WelcomeBackEvent, St as LiveEvent, T as ContentSourceMapDocumentBase, Ti as TransformTargetInclude, Tn as SanityImageAssetDocument, Tr as GenerateOperation, Tt as LiveEventReconnect, U as DatasetCreateOptions, Un as TransactionAllDocumentIdsMutationOptions, Ur as ObservablePatchBuilder, Ut as PartialExcept, V as CurrentSanityUser, Vn as SyncTag, Vr as ObservableDatasetsClient, Vt as MutationSelectionQueryParams, W as DatasetEditOptions, Wn as TransactionAllDocumentsMutationOptions, Wr as ObservableTransaction, Wt as PatchMutationOperation, X as DeleteVariantDefinitionAction, Xn as UnfilteredResponseWithoutQuery, Xr as LiveClient, Xt as QueryOptions, Y as DeleteVariantAction, Yn as UnfilteredResponseQueryOptions, Yr as Patch, Yt as PublishVariantAction, Z as DiscardAction, Zn as UnpublishAction, Zr as types_d_exports, Zt as QueryParams, _ as ChannelErrorEvent, _i as TranslateDocument, _n as Requester, _r as VideoRenditionInfoPublic, _t as InsertPatch, a as AllDocumentsMutationOptions, ai as CollaborationCommentRange, an as ReleaseCardinality, ar as UploadResponseEvent, at as EditableReleaseDocument, b as ClientReturn, bi as ImageDescriptionOperation, bn as ResumableListenEventNames, br as VideoSubtitleInfoPublic, bt as ListenOptions, c as Any, ci as CollaborationCommentStatus, cn as ReleaseState, cr as VersionAction, ct as ErrorProps, d as AssetMetadataType, di as CollaborationCommentsListenOptions, dn as ReplaceVersionAction, dr as VideoPlaybackInfoItemPublic, dt as FirstDocumentMutationOptions, ei as CollaborationCommentCreate, en as RawQueryResponse, er as UnscheduleReleaseAction, et as EXPERIMENTAL_API_WARNING, f as AttributeSet, fi as CollaborationCommentsRequestOptions, fn as RequestHandler, fr as VideoPlaybackInfoItemSigned, ft as FitMode, g as BaseMutationOptions, gi as ObservableAssetsClient, gn as RequestUrlOptions, gr as VideoRenditionInfo, gt as InitializedClientConfig, h as BaseActionOptions, hi as AssetsClient, hn as RequestOptions, hr as VideoPlaybackTokens, ht as ImportReleaseAction, i as AllDocumentIdsMutationOptions, ii as CollaborationCommentPortableTextBlock, in as ReleaseAction, ir as UploadProgressEvent, it as EditVariantDefinitionAction, j as ContentSourceMapPaths, ji as AgentActionParams, jn as SanityQueriesByResource, jr as ObservableUsersClient, jt as MediaLibraryPlaybackInfoOptions, k as ContentSourceMapMapping, ki as PatchTarget, kn as SanityProjectionsByResource, kr as ObservableSanityClient, kt as MediaLibraryAssetInstanceIdentifier, l as ApiError, li as CollaborationCommentTarget, ln as ReleaseType, lr as VideoPlaybackInfo, lt as FilteredResponseQueryOptions, m as AuthProviderResponse, mi as _listen, mn as RequestObservableOptions, mr as VideoPlaybackInfoSigned, mt as IdentifiedSanityDocumentStub, n as ActionError, ni as CollaborationCommentFieldValue, nn as RawRequestOptions, nr as UploadClientConfig, nt as EditReleaseAction, o as AnimatedImageFormat, oi as CollaborationCommentReactionShortName, on as ReleaseDocument, or as VariantAction, ot as EmbeddingsSettings, p as AuthProvider, pi as CollaborationCommentsWriteOptions, pn as RequestHandlerOptions, pr as VideoPlaybackInfoPublic, pt as HttpRequest, q as DeleteAction, qn as TransactionMutationOptions, qr as BasePatch, qt as PublishAction, r as ActionErrorItem, ri as CollaborationCommentMessage, rn as ReconnectEvent, rr as UploadEvent, rt as EditVariantAction, s as AnimatedTransformOptions, si as CollaborationCommentSelection, sn as ReleaseId, sr as VariantDefinitionAction, st as EmbeddingsSettingsBody, t as Action, ti as CollaborationCommentDocument, tn as RawQuerylessQueryResponse, tr as UploadBody, tt as EditAction, u as ArchiveReleaseAction, ui as CollaborationCommentUpdate, un as ReplaceDraftAction, ur as VideoPlaybackInfoItem, ut as FirstDocumentIdMutationOptions, v as ClientConfig, vi as TranslateTarget, vn as ResetEvent, vr as VideoRenditionInfoSigned, vt as ListenEvent, w as ContentSourceMapDocument, wi as TransformTargetDocument, wn as SanityDocumentStub, wr as GenerateInstruction, wt as LiveEventMessage, x as ClientVariant, xi as TransformDocument, xn as ResumableListenOptions, xr as VideoSubtitleInfoSigned, xt as ListenParams, y as ClientPerspective, yi as TranslateTargetInclude, yn as ResponseQueryOptions, yr as VideoSubtitleInfo, yt as ListenEventName, z as CreateVariantDefinitionAction, zn as StillImageFormat, zr as InvokeFunctionRequest, zt as MutationOperation } from "./types-Do7-A3K9.js";
+import { $ as DisconnectEvent, $n as UnpublishVersionAction, $r as ObservableCollaborationCommentsClient, $t as QueryWithoutParams, A as ContentSourceMapMappings, Ai as PatchTarget, An as SanityQueries, Ar as SanityClient, At as MediaLibraryAssetVersion, B as CreateVersionAction, Bn as StoryboardTransformOptions, Br as DatasetsClient, Bt as MutationSelection, C as ContentSourceMap, Ci as TransformOperation, Cn as SanityDocument, Cr as WelcomeEvent, Ct as LiveEventGoAway, D as ContentSourceMapDocuments, Di as PromptRequest, Dn as SanityProject, Dr as GenerateTargetDocument, Dt as LiveEventWelcome, E as ContentSourceMapDocumentValueSource, Ei as TransformTargetInclude, En as SanityImagePalette, Er as GenerateTarget, Et as LiveEventRestart, F as ContentSourceMapValueMapping, Fi as AgentActionTarget, Fn as ScheduleReleaseAction, Fr as MediaLibraryVideoClient, Ft as Mutation, G as DatasetResponse, Gn as TransactionFirstDocumentIdMutationOptions, Gr as PatchBuilder, Gt as PatchOperations, H as DatasetAclMode, Hn as ThumbnailTransformOptions, Hr as BaseTransaction, Ht as OpenEvent, I as CreateAction, Ii as ConstantAgentActionParam, In as SingleActionResult, Ir as ObservableMediaLibraryVideoClient, It as MutationError, J as DeleteReleaseAction, Jn as UnarchiveReleaseAction, Jr as ObservablePatch, Jt as PublishReleaseAction, K as DatasetsResponse, Kn as TransactionFirstDocumentMutationOptions, Kr as Transaction, Kt as PatchSelection, L as CreateReleaseAction, Li as DocumentAgentActionParam, Ln as SingleMutationResult, Lr as InvokeFunctionEvent, Lt as MutationErrorItem, M as ContentSourceMapRemoteDocument, Mi as AgentActionParams, Mn as SanityReference, Mr as UsersClient, Mt as MediaLibraryVideoPlaybackTransformations, N as ContentSourceMapSource, Ni as AgentActionPath, Nn as SanitySchemasByResource, Nr as ObservableProjectsClient, Nt as MultipleActionResult, O as ContentSourceMapLiteralSource, Oi as PatchDocument, On as SanityProjectMember, Or as GenerateTargetInclude, Ot as MediaLibraryAssetDocument, P as ContentSourceMapUnknownSource, Pi as AgentActionPathSegment, Pn as SanityUser, Pr as ProjectsClient, Pt as MultipleMutationResult, Q as DiscardVersionAction, Qn as UnpublishVariantAction, Qr as CollaborationCommentsClient, Qt as QueryParseError, R as CreateVariantAction, Ri as FieldAgentActionParam, Rn as StackablePerspective, Rr as InvokeFunctionOptions, Rt as MutationEvent, S as ClientVariantConditions, Si as TransformDocument, Sn as SanityAssetDocument, Sr as WelcomeBackEvent, St as LiveEvent, T as ContentSourceMapDocumentBase, Ti as TransformTargetDocument, Tn as SanityImageAssetDocument, Tr as GenerateOperation, Tt as LiveEventReconnect, U as DatasetCreateOptions, Un as TransactionAllDocumentIdsMutationOptions, Ur as ObservablePatchBuilder, Ut as PartialExcept, V as CurrentSanityUser, Vn as SyncTag, Vr as ObservableDatasetsClient, Vt as MutationSelectionQueryParams, W as DatasetEditOptions, Wn as TransactionAllDocumentsMutationOptions, Wr as ObservableTransaction, Wt as PatchMutationOperation, X as DeleteVariantDefinitionAction, Xn as UnfilteredResponseWithoutQuery, Xr as LiveClient, Xt as QueryOptions, Y as DeleteVariantAction, Yn as UnfilteredResponseQueryOptions, Yr as Patch, Yt as PublishVariantAction, Z as DiscardAction, Zn as UnpublishAction, Zr as types_d_exports, Zt as QueryParams, _ as ChannelErrorEvent, _i as ObservableAssetsClient, _n as Requester, _r as VideoRenditionInfoPublic, _t as InsertPatch, a as AllDocumentsMutationOptions, ai as CollaborationCommentPortableTextBlock, an as ReleaseCardinality, ar as UploadResponseEvent, at as EditableReleaseDocument, b as ClientReturn, bi as TranslateTargetInclude, bn as ResumableListenEventNames, br as VideoSubtitleInfoPublic, bt as ListenOptions, c as Any, ci as CollaborationCommentSelection, cn as ReleaseState, cr as VersionAction, ct as ErrorProps, d as AssetMetadataType, di as CollaborationCommentUpdate, dn as ReplaceVersionAction, dr as VideoPlaybackInfoItemPublic, dt as FirstDocumentMutationOptions, ei as CollaborationCommentAnchor, en as RawQueryResponse, er as UnscheduleReleaseAction, et as EXPERIMENTAL_API_WARNING, f as AttributeSet, fi as CollaborationCommentsListenOptions, fn as RequestHandler, fr as VideoPlaybackInfoItemSigned, ft as FitMode, g as BaseMutationOptions, gi as AssetsClient, gn as RequestUrlOptions, gr as VideoRenditionInfo, gt as InitializedClientConfig, h as BaseActionOptions, hi as _listen, hn as RequestOptions, hr as VideoPlaybackTokens, ht as ImportReleaseAction, i as AllDocumentIdsMutationOptions, ii as CollaborationCommentMessage, in as ReleaseAction, ir as UploadProgressEvent, it as EditVariantDefinitionAction, j as ContentSourceMapPaths, ji as AgentActionParam, jn as SanityQueriesByResource, jr as ObservableUsersClient, jt as MediaLibraryPlaybackInfoOptions, k as ContentSourceMapMapping, ki as PatchOperation, kn as SanityProjectionsByResource, kr as ObservableSanityClient, kt as MediaLibraryAssetInstanceIdentifier, l as ApiError, li as CollaborationCommentStatus, ln as ReleaseType, lr as VideoPlaybackInfo, lt as FilteredResponseQueryOptions, m as AuthProviderResponse, mi as CollaborationCommentsWriteOptions, mn as RequestObservableOptions, mr as VideoPlaybackInfoSigned, mt as IdentifiedSanityDocumentStub, n as ActionError, ni as CollaborationCommentDocument, nn as RawRequestOptions, nr as UploadClientConfig, nt as EditReleaseAction, o as AnimatedImageFormat, oi as CollaborationCommentRange, on as ReleaseDocument, or as VariantAction, ot as EmbeddingsSettings, p as AuthProvider, pi as CollaborationCommentsRequestOptions, pn as RequestHandlerOptions, pr as VideoPlaybackInfoPublic, pt as HttpRequest, q as DeleteAction, qn as TransactionMutationOptions, qr as BasePatch, qt as PublishAction, r as ActionErrorItem, ri as CollaborationCommentFieldValue, rn as ReconnectEvent, rr as UploadEvent, rt as EditVariantAction, s as AnimatedTransformOptions, si as CollaborationCommentReactionShortName, sn as ReleaseId, sr as VariantDefinitionAction, st as EmbeddingsSettingsBody, t as Action, ti as CollaborationCommentCreate, tn as RawQuerylessQueryResponse, tr as UploadBody, tt as EditAction, u as ArchiveReleaseAction, ui as CollaborationCommentTarget, un as ReplaceDraftAction, ur as VideoPlaybackInfoItem, ut as FirstDocumentIdMutationOptions, v as ClientConfig, vi as TranslateDocument, vn as ResetEvent, vr as VideoRenditionInfoSigned, vt as ListenEvent, w as ContentSourceMapDocument, wi as TransformTarget, wn as SanityDocumentStub, wr as GenerateInstruction, wt as LiveEventMessage, x as ClientVariant, xi as ImageDescriptionOperation, xn as ResumableListenOptions, xr as VideoSubtitleInfoSigned, xt as ListenParams, y as ClientPerspective, yi as TranslateTarget, yn as ResponseQueryOptions, yr as VideoSubtitleInfo, yt as ListenEventName, z as CreateVariantDefinitionAction, zi as GroqAgentActionParam, zn as StillImageFormat, zr as InvokeFunctionRequest, zt as MutationOperation } from "./types-Cov8gzNZ.js";
 import { FetchFunction, RequestOptions as RequestOptions$1, TimeoutErrorLike, isTimeoutError } from "get-it";
 import { Observable } from "rxjs";
 import { EventSourceConstructor } from "eventsource";
@@ -181,5 +181,5 @@ declare const createClient: (config: ClientConfig) => SanityClient;
  * @deprecated Use the named export `createClient` instead of the `default` export
  */
 declare const deprecatedCreateClient: (config: ClientConfig) => SanityClient;
-export { Action, ActionError, ActionErrorItem, type AgentActionParam, type AgentActionParams, type AgentActionPath, type AgentActionPathSegment, type AgentActionTarget, AllDocumentIdsMutationOptions, AllDocumentsMutationOptions, AnimatedImageFormat, AnimatedTransformOptions, Any, ApiError, ArchiveReleaseAction, AssetMetadataType, type AssetsClient, AttributeSet, AuthProvider, AuthProviderResponse, BaseActionOptions, BaseMutationOptions, BasePatch, BaseTransaction, ChannelError, ChannelErrorEvent, ClientConfig, ClientError, ClientPerspective, ClientReturn, ClientVariant, ClientVariantConditions, type CollaborationCommentCreate, type CollaborationCommentDocument, type CollaborationCommentFieldValue, type CollaborationCommentMessage, type CollaborationCommentPortableTextBlock, type CollaborationCommentRange, type CollaborationCommentReactionShortName, type CollaborationCommentSelection, type CollaborationCommentStatus, type CollaborationCommentTarget, type CollaborationCommentUpdate, type CollaborationCommentsClient, type CollaborationCommentsListenOptions, type CollaborationCommentsRequestOptions, type CollaborationCommentsWriteOptions, ConnectionFailedError, type ConstantAgentActionParam, ContentSourceMap, ContentSourceMapDocument, ContentSourceMapDocumentBase, ContentSourceMapDocumentValueSource, ContentSourceMapDocuments, ContentSourceMapLiteralSource, ContentSourceMapMapping, ContentSourceMapMappings, type ContentSourceMapParsedPath, type ContentSourceMapParsedPathKeyedSegment, ContentSourceMapPaths, ContentSourceMapRemoteDocument, ContentSourceMapSource, ContentSourceMapUnknownSource, ContentSourceMapValueMapping, types_d_exports as Context, CorsOriginError, CreateAction, CreateReleaseAction, CreateVariantAction, CreateVariantDefinitionAction, CreateVersionAction, CurrentSanityUser, DatasetAclMode, DatasetCreateOptions, DatasetEditOptions, DatasetResponse, type DatasetsClient, DatasetsResponse, DeleteAction, DeleteReleaseAction, DeleteVariantAction, DeleteVariantDefinitionAction, DiscardAction, DiscardVersionAction, DisconnectError, DisconnectEvent, type DocumentAgentActionParam, EXPERIMENTAL_API_WARNING, EditAction, EditReleaseAction, EditVariantAction, EditVariantDefinitionAction, EditableReleaseDocument, EmbeddingsSettings, EmbeddingsSettingsBody, ErrorProps, type EventSourceEvent, type EventSourceInstance, type FieldAgentActionParam, type FilterDefault, FilteredResponseQueryOptions, FirstDocumentIdMutationOptions, FirstDocumentMutationOptions, FitMode, type GenerateInstruction, type GenerateOperation, type GenerateTarget, type GenerateTargetDocument, type GenerateTargetInclude, type GroqAgentActionParam, type HttpError, HttpRequest, IdentifiedSanityDocumentStub, type ImageDescriptionOperation, ImportReleaseAction, InitializedClientConfig, type InitializedStegaConfig, InsertPatch, type InvokeFunctionEvent, type InvokeFunctionOptions, type InvokeFunctionRequest, ListenEvent, ListenEventName, ListenOptions, ListenParams, type LiveClient, LiveEvent, LiveEventGoAway, LiveEventMessage, LiveEventReconnect, LiveEventRestart, LiveEventWelcome, type Logger, MediaLibraryAssetDocument, MediaLibraryAssetInstanceIdentifier, MediaLibraryAssetVersion, MediaLibraryPlaybackInfoOptions, type MediaLibraryVideoClient, MediaLibraryVideoPlaybackTransformations, MessageError, MessageParseError, MultipleActionResult, MultipleMutationResult, Mutation, MutationError, MutationErrorItem, MutationEvent, MutationOperation, MutationSelection, MutationSelectionQueryParams, type ObservableAssetsClient, type ObservableCollaborationCommentsClient, type ObservableDatasetsClient, type ObservableMediaLibraryVideoClient, ObservablePatch, ObservablePatchBuilder, type ObservableProjectsClient, ObservableSanityClient, ObservableTransaction, type ObservableUsersClient, OpenEvent, PartialExcept, Patch, PatchBuilder, type PatchDocument, PatchMutationOperation, type PatchOperation, PatchOperations, PatchSelection, type PatchTarget, type ProjectsClient, type PromptRequest, PublishAction, PublishReleaseAction, PublishVariantAction, QueryOptions, QueryParams, QueryParseError, QueryWithoutParams, RawQueryResponse, RawQuerylessQueryResponse, RawRequestOptions, ReconnectEvent, ReleaseAction, ReleaseCardinality, ReleaseDocument, ReleaseId, ReleaseState, ReleaseType, ReplaceDraftAction, ReplaceVersionAction, RequestHandler, RequestHandlerOptions, RequestObservableOptions, RequestOptions, RequestUrlOptions, Requester, ResetEvent, type ResolveStudioUrl, ResponseQueryOptions, ResumableListenEventNames, ResumableListenOptions, SanityAssetDocument, SanityClient, SanityDocument, SanityDocumentStub, SanityImageAssetDocument, SanityImagePalette, SanityProject, SanityProjectMember, SanityProjectionsByResource, SanityQueries, SanityQueriesByResource, SanityReference, SanitySchemasByResource, SanityUser, ScheduleReleaseAction, ServerError, type ServerSentEvent, SingleActionResult, SingleMutationResult, StackablePerspective, type StegaConfig, type StegaConfigRequiredKeys, StillImageFormat, StoryboardTransformOptions, type StudioBaseRoute, type StudioBaseUrl, type StudioUrl, SyncTag, ThumbnailTransformOptions, type TimeoutErrorLike, Transaction, TransactionAllDocumentIdsMutationOptions, TransactionAllDocumentsMutationOptions, TransactionFirstDocumentIdMutationOptions, TransactionFirstDocumentMutationOptions, TransactionMutationOptions, type TransformDocument, type TransformOperation, type TransformTarget, type TransformTargetDocument, type TransformTargetInclude, type TranslateDocument, type TranslateTarget, type TranslateTargetInclude, UnarchiveReleaseAction, UnfilteredResponseQueryOptions, UnfilteredResponseWithoutQuery, UnpublishAction, UnpublishVariantAction, UnpublishVersionAction, UnscheduleReleaseAction, UploadBody, UploadClientConfig, UploadEvent, UploadProgressEvent, UploadResponseEvent, type UsersClient, VariantAction, VariantDefinitionAction, VersionAction, VideoPlaybackInfo, VideoPlaybackInfoItem, VideoPlaybackInfoItemPublic, VideoPlaybackInfoItemSigned, VideoPlaybackInfoPublic, VideoPlaybackInfoSigned, VideoPlaybackTokens, VideoRenditionInfo, VideoRenditionInfoPublic, VideoRenditionInfoSigned, VideoSubtitleInfo, VideoSubtitleInfoPublic, VideoSubtitleInfoSigned, WelcomeBackEvent, WelcomeEvent, type _listen, connectEventSource, createClient, deprecatedCreateClient as default, formatQueryParseError, isHttpError, isQueryParseError, isTimeoutError, requester, validateApiPerspective };
+export { Action, ActionError, ActionErrorItem, type AgentActionParam, type AgentActionParams, type AgentActionPath, type AgentActionPathSegment, type AgentActionTarget, AllDocumentIdsMutationOptions, AllDocumentsMutationOptions, AnimatedImageFormat, AnimatedTransformOptions, Any, ApiError, ArchiveReleaseAction, AssetMetadataType, type AssetsClient, AttributeSet, AuthProvider, AuthProviderResponse, BaseActionOptions, BaseMutationOptions, BasePatch, BaseTransaction, ChannelError, ChannelErrorEvent, ClientConfig, ClientError, ClientPerspective, ClientReturn, ClientVariant, ClientVariantConditions, type CollaborationCommentAnchor, type CollaborationCommentCreate, type CollaborationCommentDocument, type CollaborationCommentFieldValue, type CollaborationCommentMessage, type CollaborationCommentPortableTextBlock, type CollaborationCommentRange, type CollaborationCommentReactionShortName, type CollaborationCommentSelection, type CollaborationCommentStatus, type CollaborationCommentTarget, type CollaborationCommentUpdate, type CollaborationCommentsClient, type CollaborationCommentsListenOptions, type CollaborationCommentsRequestOptions, type CollaborationCommentsWriteOptions, ConnectionFailedError, type ConstantAgentActionParam, ContentSourceMap, ContentSourceMapDocument, ContentSourceMapDocumentBase, ContentSourceMapDocumentValueSource, ContentSourceMapDocuments, ContentSourceMapLiteralSource, ContentSourceMapMapping, ContentSourceMapMappings, type ContentSourceMapParsedPath, type ContentSourceMapParsedPathKeyedSegment, ContentSourceMapPaths, ContentSourceMapRemoteDocument, ContentSourceMapSource, ContentSourceMapUnknownSource, ContentSourceMapValueMapping, types_d_exports as Context, CorsOriginError, CreateAction, CreateReleaseAction, CreateVariantAction, CreateVariantDefinitionAction, CreateVersionAction, CurrentSanityUser, DatasetAclMode, DatasetCreateOptions, DatasetEditOptions, DatasetResponse, type DatasetsClient, DatasetsResponse, DeleteAction, DeleteReleaseAction, DeleteVariantAction, DeleteVariantDefinitionAction, DiscardAction, DiscardVersionAction, DisconnectError, DisconnectEvent, type DocumentAgentActionParam, EXPERIMENTAL_API_WARNING, EditAction, EditReleaseAction, EditVariantAction, EditVariantDefinitionAction, EditableReleaseDocument, EmbeddingsSettings, EmbeddingsSettingsBody, ErrorProps, type EventSourceEvent, type EventSourceInstance, type FieldAgentActionParam, type FilterDefault, FilteredResponseQueryOptions, FirstDocumentIdMutationOptions, FirstDocumentMutationOptions, FitMode, type GenerateInstruction, type GenerateOperation, type GenerateTarget, type GenerateTargetDocument, type GenerateTargetInclude, type GroqAgentActionParam, type HttpError, HttpRequest, IdentifiedSanityDocumentStub, type ImageDescriptionOperation, ImportReleaseAction, InitializedClientConfig, type InitializedStegaConfig, InsertPatch, type InvokeFunctionEvent, type InvokeFunctionOptions, type InvokeFunctionRequest, ListenEvent, ListenEventName, ListenOptions, ListenParams, type LiveClient, LiveEvent, LiveEventGoAway, LiveEventMessage, LiveEventReconnect, LiveEventRestart, LiveEventWelcome, type Logger, MediaLibraryAssetDocument, MediaLibraryAssetInstanceIdentifier, MediaLibraryAssetVersion, MediaLibraryPlaybackInfoOptions, type MediaLibraryVideoClient, MediaLibraryVideoPlaybackTransformations, MessageError, MessageParseError, MultipleActionResult, MultipleMutationResult, Mutation, MutationError, MutationErrorItem, MutationEvent, MutationOperation, MutationSelection, MutationSelectionQueryParams, type ObservableAssetsClient, type ObservableCollaborationCommentsClient, type ObservableDatasetsClient, type ObservableMediaLibraryVideoClient, ObservablePatch, ObservablePatchBuilder, type ObservableProjectsClient, ObservableSanityClient, ObservableTransaction, type ObservableUsersClient, OpenEvent, PartialExcept, Patch, PatchBuilder, type PatchDocument, PatchMutationOperation, type PatchOperation, PatchOperations, PatchSelection, type PatchTarget, type ProjectsClient, type PromptRequest, PublishAction, PublishReleaseAction, PublishVariantAction, QueryOptions, QueryParams, QueryParseError, QueryWithoutParams, RawQueryResponse, RawQuerylessQueryResponse, RawRequestOptions, ReconnectEvent, ReleaseAction, ReleaseCardinality, ReleaseDocument, ReleaseId, ReleaseState, ReleaseType, ReplaceDraftAction, ReplaceVersionAction, RequestHandler, RequestHandlerOptions, RequestObservableOptions, RequestOptions, RequestUrlOptions, Requester, ResetEvent, type ResolveStudioUrl, ResponseQueryOptions, ResumableListenEventNames, ResumableListenOptions, SanityAssetDocument, SanityClient, SanityDocument, SanityDocumentStub, SanityImageAssetDocument, SanityImagePalette, SanityProject, SanityProjectMember, SanityProjectionsByResource, SanityQueries, SanityQueriesByResource, SanityReference, SanitySchemasByResource, SanityUser, ScheduleReleaseAction, ServerError, type ServerSentEvent, SingleActionResult, SingleMutationResult, StackablePerspective, type StegaConfig, type StegaConfigRequiredKeys, StillImageFormat, StoryboardTransformOptions, type StudioBaseRoute, type StudioBaseUrl, type StudioUrl, SyncTag, ThumbnailTransformOptions, type TimeoutErrorLike, Transaction, TransactionAllDocumentIdsMutationOptions, TransactionAllDocumentsMutationOptions, TransactionFirstDocumentIdMutationOptions, TransactionFirstDocumentMutationOptions, TransactionMutationOptions, type TransformDocument, type TransformOperation, type TransformTarget, type TransformTargetDocument, type TransformTargetInclude, type TranslateDocument, type TranslateTarget, type TranslateTargetInclude, UnarchiveReleaseAction, UnfilteredResponseQueryOptions, UnfilteredResponseWithoutQuery, UnpublishAction, UnpublishVariantAction, UnpublishVersionAction, UnscheduleReleaseAction, UploadBody, UploadClientConfig, UploadEvent, UploadProgressEvent, UploadResponseEvent, type UsersClient, VariantAction, VariantDefinitionAction, VersionAction, VideoPlaybackInfo, VideoPlaybackInfoItem, VideoPlaybackInfoItemPublic, VideoPlaybackInfoItemSigned, VideoPlaybackInfoPublic, VideoPlaybackInfoSigned, VideoPlaybackTokens, VideoRenditionInfo, VideoRenditionInfoPublic, VideoRenditionInfoSigned, VideoSubtitleInfo, VideoSubtitleInfoPublic, VideoSubtitleInfoSigned, WelcomeBackEvent, WelcomeEvent, type _listen, connectEventSource, createClient, deprecatedCreateClient as default, formatQueryParseError, isHttpError, isQueryParseError, isTimeoutError, requester, validateApiPerspective };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -3,6 +3,7 @@ import { a as ServerError, c as isHttpError, i as CorsOriginError, l as isQueryP
 import { t as isRecord } from "./isRecord-Kfmt-nk-.js";
 import { _ as validateDocumentId, a as printCreateVersionWithBaseIdWarning, b as validateVersionIdMatch, c as printPreviewDraftsDeprecationWarning, d as requestTag, f as requireDocumentId, g as validateAssetType, h as resourceGuard, i as printCdnPreviewDraftsWarning, l as dataset, m as resourceConfig, n as initConfig, o as printDeprecatedUriOptionWarning, p as requireDocumentType, r as validateApiPerspective, s as printNoDefaultExport, t as defaultConfig, u as hasDataset, v as validateInsert, y as validateObject } from "./config-CgJ16jET.js";
 import { t as stegaClean } from "./stegaClean-YZRATV86.js";
+import { t as getCommentTargetDocumentRef } from "./getCommentTargetDocumentRef-B8NuiBjG.js";
 import { isTimeoutError } from "get-it";
 import { anySignal } from "get-it/any-signal";
 import { Observable, catchError, concat, defer, finalize, isObservable, lastValueFrom, map, merge, mergeMap, of, share, tap, throwError, timer } from "rxjs";
@@ -1408,7 +1409,7 @@ function optionsFromFile(opts, file) {
 		contentType: file.type
 	}, opts);
 }
-var defaults_default = (obj, defaults) => Object.keys(defaults).concat(Object.keys(obj)).reduce((target, prop) => (target[prop] = obj[prop] === void 0 ? defaults[prop] : obj[prop], target), {});
+var version = "8.8.0", defaults_default = (obj, defaults) => Object.keys(defaults).concat(Object.keys(obj)).reduce((target, prop) => (target[prop] = obj[prop] === void 0 ? defaults[prop] : obj[prop], target), {});
 const pick = (obj, props) => props.reduce((selection, prop) => (obj[prop] === void 0 || (selection[prop] = obj[prop]), selection), {}), RETRYABLE_STATUSES = /* @__PURE__ */ new Set([408, 429]);
 /**
 * Note: connection failure is not the same as network disconnect which may happen more frequent.
@@ -1544,8 +1545,7 @@ function resourceQuery(client) {
 /** @internal */
 function _getTargetDocumentRef(client, documentId) {
 	if (!documentId) throw Error("Document ID must be provided");
-	let resource = resolveCommentResource(client);
-	return `${resource.type}:${resource.id}:${getPublishedId(documentId)}`;
+	return getCommentTargetDocumentRef(resolveCommentResource(client), documentId);
 }
 function write(client, httpRequest, method, url, body, options = {}) {
 	return _requestObservable(client, httpRequest, {
@@ -1554,6 +1554,7 @@ function write(client, httpRequest, method, url, body, options = {}) {
 		body,
 		query: {
 			...resourceQuery(client),
+			clientVersion: version,
 			...options.transactionId ? { transactionId: options.transactionId } : {}
 		},
 		...pick(options, possibleRequestOptions)
@@ -1579,13 +1580,35 @@ function writeMutationResult(...args) {
 		results
 	})));
 }
+/**
+* Moves the deprecated `range` + `fieldValue` onto a `portable-text` `anchor`.
+* Anything else passes through unchanged, and invalid combinations are left
+* for the API to reject.
+*/
+function withAnchor(input) {
+	let { range, fieldValue, ...rest } = input;
+	return range === void 0 || input.anchor !== void 0 ? input : range === null ? fieldValue ? input : {
+		...rest,
+		anchor: null
+	} : {
+		...rest,
+		anchor: {
+			type: "portable-text",
+			...range,
+			...fieldValue && { fieldValue }
+		}
+	};
+}
 /** @internal */
 function _create(client, httpRequest, body, options) {
-	return writeDocument(body._id, client, httpRequest, "POST", "/collaboration/comments", body, options);
+	return writeDocument(body._id, client, httpRequest, "POST", "/collaboration/comments", body.target ? {
+		...body,
+		target: withAnchor(body.target)
+	} : body, options);
 }
 /** @internal */
 function _update(client, httpRequest, id, body, options) {
-	return writeDocument(id, client, httpRequest, "PATCH", commentUrl(id), body, options);
+	return writeDocument(id, client, httpRequest, "PATCH", commentUrl(id), withAnchor(body), options);
 }
 /** @internal */
 function _delete(client, httpRequest, id, options) {